checkip

A simple cli wrapper for a variety of security API tools. Primarily used to detect relations of ip addresses. Will attempt to resolve their known level of hostility per community standards.

Configuration

OTX and VirusTotal api keys must be used for this program to run. Obtain these from their offical sites for personal use.

NOTE: Please be mindful and respectful of their TOS.

The keys can be provided through the configuration engine in one of the following ways: (Order of priority)

1. Environ keys: VIRUS_TOTAL_KEY and OTX_KEY respectively
2. ~/.checkip/config.ini
3. ./config.ini where ./ is the active directory for the program

If the config.ini setup is used, the following headers and keys are required:

[VIRUS_TOTAL]
key=abc123

[OTX]
key=321cba

Flags and Usage

-ip {ipv4address} -- the flag to use when scanning a single ipv4address. Required if -if is not used.

-if {filepath} --input-file -- the flag to use when scanning multiple ipv4addresses. Required if -ip is not used

-u {url} --host -- any valid url to resolve as an ip address

-f --force -- ensures all given ips are scanned, even when a record exists

-s --silent -- runs without sending anything to standardIO

-v --verbose -- runs with extra output

-h --help -- displays a list of all flags and basic usage

Troubleshooting

Macos

Checkout the macos tag for help