Metadata-Version: 2.1
Name: abuse_whois
Version: 0.7.3
Summary: Find where to report a domain for abuse
Home-page: https://github.com/ninoseki/abuse_whois
License: MIT
Author: Manabu Niseki
Author-email: manabu.niseki@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Provides-Extra: api
Requires-Dist: PyYAML (>=6.0,<7.0)
Requires-Dist: asyncache (>=0.3,<1.0)
Requires-Dist: asyncer (>=0.0.2,<1.0)
Requires-Dist: asyncwhois (>=1.0,<2.0)
Requires-Dist: azuma (>=0.3,<0.4)
Requires-Dist: cachetools (>=5.3,<6.0)
Requires-Dist: fastapi (>=0.100,<1.0)
Requires-Dist: gunicorn (>=21.2,<22.0) ; extra == "api"
Requires-Dist: loguru (>=0.7,<1.0)
Requires-Dist: pydantic (>=2.0,<3.0)
Requires-Dist: pyhumps (>=3.8,<4.0)
Requires-Dist: stamina (>=23.1,<24.0)
Requires-Dist: tldextract (>=3.4,<4.0)
Requires-Dist: typer (>=0.9,<1.0)
Requires-Dist: uvicorn[standard] (>=0.23,<0.24) ; extra == "api"
Requires-Dist: validators (>=0.21,<1.0)
Requires-Dist: whois-parser (>=0.3.1,<1.0)
Project-URL: Repository, https://github.com/ninoseki/abuse_whois
Description-Content-Type: text/markdown

# abuse_whois

[![PyPI version](https://badge.fury.io/py/abuse-whois.svg)](https://badge.fury.io/py/abuse-whois)
[![Python CI](https://github.com/ninoseki/abuse_whois/actions/workflows/test.yml/badge.svg)](https://github.com/ninoseki/abuse_whois/actions/workflows/test.yml)
[![Coverage Status](https://coveralls.io/repos/github/ninoseki/abuse_whois/badge.svg?branch=main)](https://coveralls.io/github/ninoseki/abuse_whois?branch=main)

Yet another way to find where to report an abuse.

![img](./images/overview.jpg)

This tool is highly inspired from the following libraries:

- https://github.com/bradleyjkemp/abwhose
- https://github.com/certsocietegenerale/abuse_finder

## Requirements

- Python 3.10+

## Installation

```bash
pip install abuse_whois

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

## Usage

### As a library

```python
from abuse_whois import get_abuse_contacts

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

### As a CLI tool

```bash
$ abuse_whois 1.1.1.1 | jq .
```

### As a REST API

```bash
$ uvicorn abuse_whois.api.main: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

```bash
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)               |
| WHOIS_LOOKUP_MAX_RETRIES                   | int                   | 3        | Max retries on timeout error                             |
| 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)          |
| RULE_EXTENSIONS                            | CommaSeparatedStrings | yaml,yml | Rule file extensions                                     |
| ADDITIONAL_WHOIS_RULE_DIRECTORIES          | CommaSeparatedStrings |          | Additional directories contain whois rule files          |
| ADDITIONAL_SHARED_HOSTING_RULE_DIRECTORIES | CommaSeparatedStrings |          | Additional directories contain shared hosting rule files |

## Contributions

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

- Rules:
  - [Registrar and hosting provider](https://github.com/ninoseki/abuse_whois/wiki/Registrar-and-Hosting-Provider)
  - [Shared hosting provider](https://github.com/ninoseki/abuse_whois/wiki/Shared-Hosting)

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

