Skip to main content

Find where to report a domain for abuse

Project description

abuse_whois

PyPI version Python CI Coverage Status

Yet another way to find where to report an abuse.

img

This tool is highly inspired from the following libraries:

Requirements

  • Python 3.7+
  • whois

Installation

pip install abuse_whois

# or if you want to use built-in REST API
pip install abuse_whois[api]

Usage

As a library

from abuse_whois import get_abuse_contacts

get_abuse_contacts("1.1.1.1")
get_abuse_contacts("github.com")
get_abuse_contacts("https://github.com")
get_abuse_contacts("foo@example.com")

As a CLI tool

$ abuse_whois 1.1.1.1 | jq .

As a REST API

$ uvicorn abuse_whois.api.app:app
INFO:     Started server process [2283]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

$ http localhost:8000/api/whois/ address=https://github.com

With Docker

git clone https://github.com/ninoseki/abuse_whois
cd abuse_whois
docker build . -t abuse-whois
docker run -i -d -p 8000:8000 abuse-whois

Settings

All settings can be done via environment variables or .env file.

Name Type Default Desc.
WHOIS_LOOKUP_TIMEOUT int 10 Timeout value for whois lookup (seconds)
WHOIS_LOOKUP_CACHE_SIZE int 1024 Cache size for whois lookup
WHOIS_LOOKUP_CACHE_TTL int 3600 Cache TTL value for whois lookup (seconds)
IP_ADDRESS_LOOKUP_TIMEOUT int 10 Timeout value for IP address lookup (seconds)
IP_ADDRESS_LOOKUP_CACHE_SIZE int 1024 Cache size for IP address lookup
IP_ADDRESS_LOOKUP_CACHE_TTL int 3600 Cache TTL value for IP address lookup (seconds)

Contributions

abuse_whois works based on a combination of static rules and a parsing result of whois response.

Please submit a PR (or submit a feature request) if you find something missing.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

abuse_whois-0.4.1.tar.gz (16.3 kB view hashes)

Uploaded Source

Built Distribution

abuse_whois-0.4.1-py3-none-any.whl (29.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page