diff --git a/README.md b/README.md index 1f6b3509..2deeefdf 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,7 @@ For more information: [Extending MISP with Python modules](https://www.misp-proj * [HYAS Insight](misp_modules/modules/expansion/hyasinsight.py) - a hover and expansion module to get information from [HYAS Insight](https://www.hyas.com/hyas-insight). * [intel471](misp_modules/modules/expansion/intel471.py) - an expansion module to get info from [Intel471](https://intel471.com). * [IPASN](misp_modules/modules/expansion/ipasn.py) - a hover and expansion to get the BGP ASN of an IP address. +* [ipinfo.io](misp_modules/modules/expansion/ipinfo.py) - an expansion module to get additional information on an IP address using the ipinfo.io API * [iprep](misp_modules/modules/expansion/iprep.py) - an expansion module to get IP reputation from packetmail.net. * [Joe Sandbox submit](misp_modules/modules/expansion/joesandbox_submit.py) - Submit files and URLs to Joe Sandbox. * [Joe Sandbox query](misp_modules/modules/expansion/joesandbox_query.py) - Query Joe Sandbox with the link of an analysis and get the parsed data. diff --git a/documentation/README.md b/documentation/README.md index 524e1a27..859034c0 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -776,6 +776,31 @@ Module to query an IP ASN history service (https://github.com/D4-project/IPASN-H ----- +#### [ipinfo](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/expansion/ipinfo.py) + + + +An expansion module to query ipinfo.io to gather more information on a given IP address. +- **features**: +>The module takes an IP address attribute as input and queries the ipinfo.io API. +>The geolocation information on the IP address is always returned. +> +>Depending on the subscription plan, the API returns different pieces of information then: +>- With a basic plan (free) you get the AS number and the AS organisation name concatenated in the `org` field. +>- With a paid subscription, the AS information is returned in the `asn` field with additional AS information, and depending on which plan the user has, you can also get information on the privacy method used to protect the IP address, the related domains, or the point of contact related to the IP address in case of an abuse. +> +>More information on the responses content is available in the [documentation](https://ipinfo.io/developers). +- **input**: +>IP address attribute. +- **output**: +>Additional information on the IP address, like its geolocation, the autonomous system it is included in, and the related domain(s). +- **references**: +>https://ipinfo.io/developers +- **requirements**: +>An ipinfo.io token + +----- + #### [ipqs_fraud_and_risk_scoring](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/expansion/ipqs_fraud_and_risk_scoring.py) diff --git a/documentation/logos/ipinfo.png b/documentation/logos/ipinfo.png new file mode 100644 index 00000000..9dedd955 Binary files /dev/null and b/documentation/logos/ipinfo.png differ diff --git a/documentation/mkdocs/expansion.md b/documentation/mkdocs/expansion.md index c85cb129..c8cf99a6 100644 --- a/documentation/mkdocs/expansion.md +++ b/documentation/mkdocs/expansion.md @@ -773,6 +773,31 @@ Module to query an IP ASN history service (https://github.com/D4-project/IPASN-H ----- +#### [ipinfo](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/expansion/ipinfo.py) + + + +An expansion module to query ipinfo.io to gather more information on a given IP address. +- **features**: +>The module takes an IP address attribute as input and queries the ipinfo.io API. +>The geolocation information on the IP address is always returned. +> +>Depending on the subscription plan, the API returns different pieces of information then: +>- With a basic plan (free) you get the AS number and the AS organisation name concatenated in the `org` field. +>- With a paid subscription, the AS information is returned in the `asn` field with additional AS information, and depending on which plan the user has, you can also get information on the privacy method used to protect the IP address, the related domains, or the point of contact related to the IP address in case of an abuse. +> +>More information on the responses content is available in the [documentation](https://ipinfo.io/developers). +- **input**: +>IP address attribute. +- **output**: +>Additional information on the IP address, like its geolocation, the autonomous system it is included in, and the related domain(s). +- **references**: +>https://ipinfo.io/developers +- **requirements**: +>An ipinfo.io token + +----- + #### [ipqs_fraud_and_risk_scoring](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/expansion/ipqs_fraud_and_risk_scoring.py) diff --git a/documentation/website/expansion/ipinfo.json b/documentation/website/expansion/ipinfo.json new file mode 100644 index 00000000..070b7a8d --- /dev/null +++ b/documentation/website/expansion/ipinfo.json @@ -0,0 +1,13 @@ +{ + "description": "An expansion module to query ipinfo.io to gather more information on a given IP address.", + "logo": "ipinfo.png", + "requirements": [ + "An ipinfo.io token" + ], + "input": "IP address attribute.", + "output": "Additional information on the IP address, like its geolocation, the autonomous system it is included in, and the related domain(s).", + "references": [ + "https://ipinfo.io/developers" + ], + "features": "The module takes an IP address attribute as input and queries the ipinfo.io API. \nThe geolocation information on the IP address is always returned.\n\nDepending on the subscription plan, the API returns different pieces of information then:\n- With a basic plan (free) you get the AS number and the AS organisation name concatenated in the `org` field.\n- With a paid subscription, the AS information is returned in the `asn` field with additional AS information, and depending on which plan the user has, you can also get information on the privacy method used to protect the IP address, the related domains, or the point of contact related to the IP address in case of an abuse.\n\nMore information on the responses content is available in the [documentation](https://ipinfo.io/developers)." +}