Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 1.47 KB

README.md

File metadata and controls

56 lines (40 loc) · 1.47 KB
Raw

SPam Ip Tester

A CLI Tool for checking malicious IP addresses using the Scamalytics API.

Installation

Note 📓

You will need to request a free API key here if you wish to use the API: https://scamalytics.com/ip/api/enquiry?monthly_api_calls=5000

This limits you to 5000 requests per month, if you need more you can pay for further usage of the API.

Currently this project uses velociraptor to handle installation and scripting via the scripts.yaml file. To install velociraptor you will need to run the following command (Documentation for velociraptor located here)

deno install -qA -n vr https://deno.land/x/[email protected]/cli.ts

You can then install with the following command

vc install

Alternatively, you can install this with deno directly using the following command

deno install --allow-net --allow-read --allow-env https://raw.githubusercontent.com/jordangarrison/spit/main/spit.ts

Usage

To run a check against a given IP address simply execute the following:

# Single IP
spit check 1.2.3.4

# Multiple IPs
spit check 1.2.3.4 4.3.2.1

# Workaround for file of ip addresses
spit check <(filename.txt)

Todo:

  • Installation documentation
  • Usage Documentation
  • Build and compilation documentation
  • CONTRIBUTING.md
  • Extractor for high frequency IP addresses in logs
  • Location checker for IP addresses