module_type.json.sample

{
    "title": "AbuseIPDB IP Checker",
    "default_name": "AbuseIPDB",
    "short_description": "Check IP addresses against AbuseIPDB's abusive IP database.",
    "description": "AbuseIPDB is a project dedicated to helping combat the spread of hackers, spammers, and abusive activity on the Internet. It is a public database of reported attacks from sysadmins and webmasters across the globe. With this module, you can scan AbuseIPDB's database for reports of attacks for a given IP.",
    "tips": "When configuring the AbuseIPDB IP Checker integration, you must obtain the API key from your AbuseIPDB account and then add the AbuseIPDB IP Checker integration module in SecureX. \n\n1. Log in to your AbuseIPDB account and click **APIv2**.\n2. Click **Create Key** and enter a **Name**.\n3. Click **CREATE**.\n4. Copy the **Key** into a file or leave the tab open. \n5. In SecureX, complete the **Add New AbuseIPDB IP Checker Integration Module** form:\n    - **Integration Module Name** - Leave the default name or enter a name that is meaningful to you.\n    - **API Key** - Paste the copied API key from AbuseIPDB into this field.\n    - **Entities Limit** - Specify the maximum number of judgements and sightings in a single response, per requested observable (must be a positive value). We recommend that you enter a limit in the range of 50 to 1000. The default is 100 entities.\n\n6. Click **Save** to complete the AbuseIPDB integration module configuration. ",
    "external_references": [],
    "configuration_spec": [
        {
            "key": "custom_key",
            "type": "api_key",
            "label": "API Key",
            "tooltip": "The AbuseIPDB API Key",
            "required": true
        },
        {
            "key": "custom_CTR_ENTITIES_LIMIT",
            "type": "integer",
            "label": "Entities Limit",
            "tooltip": "Restricts the maximum number of `Judgement` and `Sightings`. Please note that the number over 100 might lead to data inconsistency",
            "required": false
        }
    ],
    "capabilities": [
        {
            "id": "health",
            "description": "Check the health of the AbuseIPDB API"
        },
        {
            "id": "deliberate",
            "description": "Query AbuseIPDB for IP and IPv6 return Verdict"
        },
        {
            "id": "observe",
            "description": "Query AbuseIPDB for IP and IPv6 return Verdict, Judgement, Sighting, and Indicator"
        }
    ],
    "properties": {
        "url": "https://ciscohosted.url",
        "supported-apis": [
            "health",
            "observe/observables",
            "deliberate/observables"
        ],
        "auth-type": "configuration-token",
        "configuration-token-alg": "RS256",
        "custom_jwks_host": "visibility.amp.cisco.com"
    },
    "logo": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+CjxzdmcKICAgeG1sbnM6ZGM9Imh0dHA6Ly9wdXJsLm9yZy9kYy9lbGVtZW50cy8xLjEvIgogICB4bWxuczpjYz0iaHR0cDovL2NyZWF0aXZlY29tbW9ucy5vcmcvbnMjIgogICB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiCiAgIHhtbG5zOnN2Zz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciCiAgIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIKICAgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiCiAgIHhtbG5zOnNvZGlwb2RpPSJodHRwOi8vc29kaXBvZGkuc291cmNlZm9yZ2UubmV0L0RURC9zb2RpcG9kaS0wLmR0ZCIKICAgeG1sbnM6aW5rc2NhcGU9Imh0dHA6Ly93d3cuaW5rc2NhcGUub3JnL25hbWVzcGFjZXMvaW5rc2NhcGUiCiAgIHdpZHRoPSI5Ni44OTUyNDEiCiAgIGhlaWdodD0iOTYuODk1MjQxIgogICB2ZXJzaW9uPSIxLjEiCiAgIHZpZXdCb3g9IjAgMCA5Ni44OTY3MDEgOTYuODk2NzAxIgogICBpZD0ic3ZnNDQiCiAgIHNvZGlwb2RpOmRvY25hbWU9ImFidXNlaXBkYi1sb2dvLnN2ZyIKICAgaW5rc2NhcGU6dmVyc2lvbj0iMC45Mi40ICh1bmtub3duKSI+CiAgPHNvZGlwb2RpOm5hbWVkdmlldwogICAgIHBhZ2Vjb2xvcj0iI2ZmZmZmZiIKICAgICBib3JkZXJjb2xvcj0iIzY2NjY2NiIKICAgICBib3JkZXJvcGFjaXR5PSIxIgogICAgIG9iamVjdHRvbGVyYW5jZT0iMTAiCiAgICAgZ3JpZHRvbGVyYW5jZT0iMTAiCiAgICAgZ3VpZGV0b2xlcmFuY2U9IjEwIgogICAgIGlua3NjYXBlOnBhZ2VvcGFjaXR5PSIwIgogICAgIGlua3NjYXBlOnBhZ2VzaGFkb3c9IjIiCiAgICAgaW5rc2NhcGU6d2luZG93LXdpZHRoPSI5NTYiCiAgICAgaW5rc2NhcGU6d2luZG93LWhlaWdodD0iMTAzMyIKICAgICBpZD0ibmFtZWR2aWV3NDYiCiAgICAgc2hvd2dyaWQ9ImZhbHNlIgogICAgIGlua3NjYXBlOnpvb209IjUuODIwNjkzMyIKICAgICBpbmtzY2FwZTpjeD0iNTcuOTc0OTc3IgogICAgIGlua3NjYXBlOmN5PSI0MC4wMTE3MTIiCiAgICAgaW5rc2NhcGU6d2luZG93LXg9Ijk2MCIKICAgICBpbmtzY2FwZTp3aW5kb3cteT0iMjIiCiAgICAgaW5rc2NhcGU6d2luZG93LW1heGltaXplZD0iMCIKICAgICBpbmtzY2FwZTpjdXJyZW50LWxheWVyPSJzdmc0NCIgLz4KICA8bWV0YWRhdGEKICAgICBpZD0ibWV0YWRhdGEyIj4KICAgIDxyZGY6UkRGPgogICAgICA8Y2M6V29yawogICAgICAgICByZGY6YWJvdXQ9IiI+CiAgICAgICAgPGRjOmZvcm1hdD5pbWFnZS9zdmcreG1sPC9kYzpmb3JtYXQ+CiAgICAgICAgPGRjOnR5cGUKICAgICAgICAgICByZGY6cmVzb3VyY2U9Imh0dHA6Ly9wdXJsLm9yZy9kYy9kY21pdHlwZS9TdGlsbEltYWdlIiAvPgogICAgICAgIDxkYzp0aXRsZSAvPgogICAgICA8L2NjOldvcms+CiAgICA8L3JkZjpSREY+CiAgPC9tZXRhZGF0YT4KICA8ZGVmcwogICAgIGlkPSJkZWZzMTYiPgogICAgPGxpbmVhckdyYWRpZW50CiAgICAgICBpZD0iZiIKICAgICAgIHgxPSI1NC43NTg5OTkiCiAgICAgICB4Mj0iNDkuMDUzMDAxIgogICAgICAgeTE9IjYwMC41NzAwMSIKICAgICAgIHkyPSI2MzEuNDA5OTciCiAgICAgICBncmFkaWVudFRyYW5zZm9ybT0ic2NhbGUoMS41NjA4LDAuNjQwNjkpIgogICAgICAgZ3JhZGllbnRVbml0cz0idXNlclNwYWNlT25Vc2UiCiAgICAgICB4bGluazpocmVmPSIjYSIgLz4KICAgIDxsaW5lYXJHcmFkaWVudAogICAgICAgaWQ9ImciCiAgICAgICB4MT0iMzIuMTAzMDAxIgogICAgICAgeDI9IjU2LjQwMiIKICAgICAgIHkxPSI4MDguNTM5OTgiCiAgICAgICB5Mj0iODA4LjUzOTk4IgogICAgICAgZ3JhZGllbnRUcmFuc2Zvcm09InNjYWxlKDIuMTk1LDAuNDU1NTgpIgogICAgICAgZ3JhZGllbnRVbml0cz0idXNlclNwYWNlT25Vc2UiCiAgICAgICB4bGluazpocmVmPSIjYSIgLz4KICAgIDxsaW5lYXJHcmFkaWVudAogICAgICAgaWQ9ImUiCiAgICAgICB4MT0iNDguNjkzMDAxIgogICAgICAgeDI9IjQ2LjQ1MiIKICAgICAgIHkxPSI2NzAuMzkwMDEiCiAgICAgICB5Mj0iNjczLjE1OTk3IgogICAgICAgZ3JhZGllbnRUcmFuc2Zvcm09InNjYWxlKDEuNzgxMiwwLjU2MTQyKSIKICAgICAgIGdyYWRpZW50VW5pdHM9InVzZXJTcGFjZU9uVXNlIj4KICAgICAgPHN0b3AKICAgICAgICAgc3RvcC1vcGFjaXR5PSIuNDA4IgogICAgICAgICBvZmZzZXQ9IjAiCiAgICAgICAgIGlkPSJzdG9wNiIgLz4KICAgICAgPHN0b3AKICAgICAgICAgc3RvcC1vcGFjaXR5PSIwIgogICAgICAgICBvZmZzZXQ9IjEiCiAgICAgICAgIGlkPSJzdG9wOCIgLz4KICAgIDwvbGluZWFyR3JhZGllbnQ+CiAgICA8bGluZWFyR3JhZGllbnQKICAgICAgIGlkPSJhIj4KICAgICAgPHN0b3AKICAgICAgICAgc3RvcC1jb2xvcj0iI2ZmZiIKICAgICAgICAgc3RvcC1vcGFjaXR5PSIuMTc1IgogICAgICAgICBvZmZzZXQ9IjAiCiAgICAgICAgIGlkPSJzdG9wMTEiIC8+CiAgICAgIDxzdG9wCiAgICAgICAgIHN0b3AtY29sb3I9IiNmZmYiCiAgICAgICAgIHN0b3Atb3BhY2l0eT0iLjM3NSIKICAgICAgICAgb2Zmc2V0PSIxIgogICAgICAgICBpZD0ic3RvcDEzIiAvPgogICAgPC9saW5lYXJHcmFkaWVudD4KICA8L2RlZnM+CiAgPGcKICAgICB0cmFuc2Zvcm09Im1hdHJpeCgwLjU5NzQ1NjU2LDAsMCwwLjU5NzQ1NjU2LC0xMC4xNDcyMDMsLTE5Ny43NTgxMykiCiAgICAgaWQ9ImczMiIKICAgICBzdHlsZT0iZmlsbC1ydWxlOmV2ZW5vZGQiPgogICAgPHBhdGgKICAgICAgIGQ9Im0gNDguMzg4LDM5Ni41MyBjIDAuOTU5OSwtNC4yNzM5IDEuOTE5OCwtMzMuNzE2IDEwLjU1OSwtMzMuMjQxIDMwLjcxNywwLjk0OTc0IDYyLjM5NCwtMzAuODY3IDg1LjQzMiwzOS44OSA3MS4wMzMsMzMuMjQxIDQuOTM5MSw1OS45NTMgLTUxLjI5NSw1Ny41NzkgLTU1LjU2NywtMi4zMjY0IC0xMDMuMDEsLTQyLjM4MyAtNDQuNjk2LC02NC4yMjcgeiIKICAgICAgIGlkPSJwYXRoMTgiCiAgICAgICBpbmtzY2FwZTpjb25uZWN0b3ItY3VydmF0dXJlPSIwIgogICAgICAgc3R5bGU9ImZpbGwtb3BhY2l0eTowLjk5MTk5OTk3IiAvPgogICAgPHBhdGgKICAgICAgIGQ9Im0gNDYuOTQ4LDQwNi4wMyBjIDM1LjUxNiwyMi4zMTkgOTQuMDcxLDguNTQ3OCA5Ni40NywtMi4zNzQ0IDMuMzU5NywzLjc5OSAwLDE0LjI0NiAwLDE0LjI0NiAtMTUuMzU4LDE5Ljk0NSAtODkuNzUxLDE1LjY3MSAtOTcuOTEsMS40MjQ2IC0wLjk1OTkxLC0zLjc5OSAwLjk1OTksLTExLjg3MiAxLjQzOTksLTEzLjI5NiB6IgogICAgICAgaWQ9InBhdGgyMCIKICAgICAgIGlua3NjYXBlOmNvbm5lY3Rvci1jdXJ2YXR1cmU9IjAiCiAgICAgICBzdHlsZT0iZmlsbDojZmZmZmZmIiAvPgogICAgPGcKICAgICAgIGlkPSJnMjgiCiAgICAgICBzdHlsZT0ic3Ryb2tlLXdpZHRoOjEuMjUiPgogICAgICA8cGF0aAogICAgICAgICBkPSJtIDYwLjM4NywzNzAuNDEgYyA5LjExOTEsLTguMDcyOSA0OC45NTUsMy4zMjQxIDU0LjIzNSw5LjQ5NzUgMS45MTk4LDEwLjQ0NyAtNDguOTU1LDIuMzc0NCAtNTQuMjM1LC05LjQ5NzUgeiIKICAgICAgICAgaWQ9InBhdGgyMiIKICAgICAgICAgaW5rc2NhcGU6Y29ubmVjdG9yLWN1cnZhdHVyZT0iMCIKICAgICAgICAgc3R5bGU9ImZpbGw6dXJsKCNlKSIgLz4KICAgICAgPHBhdGgKICAgICAgICAgZD0ibSA2MC4zODcsMzgyLjI5IGMgNC4zMTk2LDkuOTcyNCAyMS4xMTgsMzMuMjQxIDQ5LjQzNSwxMC45MjIgLTIzLjUxOCwwLjk0OTc3IC0zMy41OTcsLTEuODk5NSAtNDkuNDM1LC0xMC45MjIgeiIKICAgICAgICAgaWQ9InBhdGgyNCIKICAgICAgICAgaW5rc2NhcGU6Y29ubmVjdG9yLWN1cnZhdHVyZT0iMCIKICAgICAgICAgc3R5bGU9ImZpbGw6dXJsKCNmKSIgLz4KICAgICAgPHBhdGgKICAgICAgICAgZD0ibSA3MC40NjYsMzYyLjgyIGMgNi4yMzk0LDIuODQ5MiA0NS41OTYsMTMuNzcxIDQ5LjkxNSwxMC40NDcgNC43OTk1LC0xLjg5OTUgMy44Mzk2LC0yLjg0OTMgMS40Mzk5LC0zLjMyNDEgLTMuODM5NiwyLjM3NDQgLTEwLjU1OSwzLjc5OSAtNTEuMzU1LC03LjEyMzEgeiIKICAgICAgICAgaWQ9InBhdGgyNiIKICAgICAgICAgaW5rc2NhcGU6Y29ubmVjdG9yLWN1cnZhdHVyZT0iMCIKICAgICAgICAgc3R5bGU9ImZpbGw6dXJsKCNnKSIgLz4KICAgIDwvZz4KICAgIDxwYXRoCiAgICAgICBkPSJtIDUyLjcwMSw0MTEuMjQgYyA1Ljc2MiwyLjczMjQgMjMuNTI4LDYuMzc1NiAzMC4yNTEsNi44MzEgNC44MDE3LDMuMTg3OCAyLjQwMDgsOC4xOTcyIDAuNDgwMTksMTEuODQgLTEyLjk2NCwwIC0yNy44NSwtMy4xODc4IC0zMS42OTEsLTcuMjg2NCAtMi40MDA4LC00LjA5ODYgLTEuNDQwNSwtNy4yODY0IDAuOTYwMzQsLTExLjM4NSB6IgogICAgICAgaWQ9InBhdGgzMCIKICAgICAgIGlua3NjYXBlOmNvbm5lY3Rvci1jdXJ2YXR1cmU9IjAiCiAgICAgICBzdHlsZT0iZmlsbDojNGQ0ZDRkO2ZpbGwtb3BhY2l0eTowLjMxNzAwMDAzIiAvPgogIDwvZz4KICA8Y2lyY2xlCiAgICAgY3g9IjQ4LjQ0ODM1MyIKICAgICBjeT0iNDguNDQ4MzUzIgogICAgIHI9IjQ0Ljg2MzYxMyIKICAgICBpZD0iY2lyY2xlMzQiCiAgICAgc3R5bGU9ImZpbGw6bm9uZTtzdHJva2U6I2ZmMDAwMDtzdHJva2Utd2lkdGg6Ny4xNjk0Nzg0MiIgLz4KICA8cGF0aAogICAgIGQ9Ik0gMTYuMDA4MjUsMTUuMDc4MDEgNzkuMjcyOTI1LDgyLjQ2NTEzNSIKICAgICBpZD0icGF0aDM2IgogICAgIGlua3NjYXBlOmNvbm5lY3Rvci1jdXJ2YXR1cmU9IjAiCiAgICAgc3R5bGU9ImZpbGw6bm9uZTtzdHJva2U6I2ZmMDAwMDtzdHJva2Utd2lkdGg6Ny4xNjk0Nzg0MiIgLz4KICA8ZwogICAgIHRyYW5zZm9ybT0ibWF0cml4KDAuNTk3NDU2NTYsMCwwLDAuNTk3NDU2NTYsLTEwLjE0NzIwMywtMTk3Ljc1ODEzKSIKICAgICBpZD0iZzQyIj4KICAgIDxnCiAgICAgICB0cmFuc2Zvcm09Im1hdHJpeCgxLjAyMTUsMCwwLDAuOTkxODMsLTEuMDQwNiwzLjI0MTEpIgogICAgICAgaWQ9Imc0MCIKICAgICAgIHN0eWxlPSJmaWxsLXJ1bGU6ZXZlbm9kZCI+CiAgICAgIDxwYXRoCiAgICAgICAgIGQ9Ik0gNDguMzg4LDM5Ni41MyBDIDE3Ljg3Nyw0MzcuNTEyIDQ3LjI5MzUsNDI2LjgwNiA5My4wODQsNDYwLjc1OCAzNy41MTcsNDU4LjQzMTYgLTkuOTI2LDQxOC4zNzUgNDguMzg4LDM5Ni41MzEgWiIKICAgICAgICAgaWQ9InBhdGgzOCIKICAgICAgICAgaW5rc2NhcGU6Y29ubmVjdG9yLWN1cnZhdHVyZT0iMCIKICAgICAgICAgc3R5bGU9ImZpbGwtb3BhY2l0eTowLjk5MTk5OTk3IiAvPgogICAgPC9nPgogIDwvZz4KPC9zdmc+Cg=="
}