abuseipdb

command
v0.0.0-...-c496913 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 11, 2024 License: AGPL-3.0 Imports: 14 Imported by: 0

README

AbuseIPDB plugin

AbuseIPDB connector sends IP address in a GET request to the abuseipdb.com API and expects a list of reports back. More info: https://docs.abuseipdb.com/#check-endpoint

Simple request to the API:

curl -G https://api.abuseipdb.com/api/v2/check \
  --data-urlencode "ipAddress=8.8.8.8" \
  -d maxAgeInDays=90 \
  -d verbose \
  -H "Key: YOUR_OWN_API_KEY" \
  -H "Accept: application/json"

where YOUR_OWN_API_KEY is your personal/unique API key.

curl to test plugin:

curl 'https://localhost:443/api?uuid=auth-key&sql=FROM+abuseipdb+WHERE+ip=%278.8.8.8%27'

Compile with:

go build -buildmode=plugin -ldflags="-w" -o abuseipdb.so ./*.go

Limitations

Does not support complex SQL queries and datetime range selection.

Access details

Source YAML definition's access fields:

  • url: HTTPS access point, https://api.abuseipdb.com/api/v2/check at the moment
  • maxAgeInDays: how far back in time we go to fetch reports, max 365
  • key: unique API key

Definition file example

Replace API key with your own:

name: abuseipdb
label: AbuseIPDB
icon: clipboard list

plugin: abuseipdb
inGlobal: true
includeDatetime: false
supportsSQL: false

access:
    url: https://api.abuseipdb.com/api/v2/check
    maxAgeInDays: 180
    key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

queryFields:
    - ip

replaceFields:
    ip: ipAddress


relations:
  -
    from:
        id: domain
        group: domain
        search: domain

    to:
        id: ipAddress
        group: ip
        search: ip
        attributes: [ "countryCode", "countryName", "hostnames", "isPublic", "isWhitelisted", "isp", "usageType", "totalReports", "lastReportedAt" ]

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL