project-honeypot
v0.0.0
Published
Friendly API for querying and consuming the Project Honeypot API
Downloads
2,175
Maintainers
Readme
Project Honeypot
This npm module will allow you to query and consume the Project Honeypot API. Query it with an IP, and a simple JSON object will be sent back with relevent metadata regarding that IP.
Installation
npm install project-honeypot
Usage
- Register for an account at Project Honeypot.
- Enable API access and receive an access key.
- Use this code:
var honeypot = require('project-honeypot')('YOUR-ACCESS-KEY');
honeypot.query(ip, callback);
Callback
Callback signature is (err, payload)
, and follows the following format:
- If the IP address not found,
payload.found
is booleanfalse
- Otherwise,
payload.found
is booleantrue
and shows follows this format:
{
"ip": "127.1.1.5",
"found": true,
"lastSeenDays": 1,
"threatScore": 1,
"searchEngineId": null,
"type": {
"searchEngine": false,
"suspicious": true,
"harvester": false,
"spammer": true
}
}
Note: Certain ip addresses in the 127.*.*.*
range are test addresses, 127.1.1.5
being one of them. It returns a result record corresponding to a IP address flagged as both "suspicious" and "comment spammer". View the full list here.