ip-reputation-js-client v6.0.4

iprepd (IP Reputation Service) node.js client library

Client library to send object reputations to the iprepd service.

Overview

iprepd is a service that supports storing and retrieving reputations associated with various object types, the most common being IP addresses but including others such as account names and email addresses. This library can be used by Node applications to integrate directly with this API.

Usage

Functions

Create a client:

const IPReputationClient = require('ip-reputation-service-client-js')

const client = new IPReputationClient({
    serviceUrl: 'http://<iprepd service host without trailing slash>',
    id: '<a hawk ID>',
    key: '<a hawk key>',
    timeout: <number in ms>
})

Get the reputation for an IP:

client.getTyped('ip', '127.0.0.1').then(function (response) {
    if (response && response.statusCode === 404) {
        console.log('No reputation found for 127.0.0.1');
    } else {
        console.log('127.0.0.1 has reputation: ', response.body.reputation);
    }
});

Set the reputation for an IP:

client.updateTyped('ip', '127.0.0.1', 79).then(function (response) {
    console.log('Set reputation for 127.0.0.1 to 79.');
});

Remove an IP:

client.removeTyped('ip', '127.0.0.1').then(function (response) {
    console.log('Removed reputation for 127.0.0.1.');
});

Send a violation for an IP:

client.sendViolationTyped('ip', '127.0.0.1', 'exceeded-password-reset-failure-rate-limit').then(function (response) {
    console.log('Applied violation to 127.0.0.1.');
});

Legacy functions

Previous versions of iprepd only supported IP addresses; these functions remain as a compatibility layer for applications that still make use of them, and are essentially wrappers around the typed function calls.

Get the reputation for an IP:

client.get('127.0.0.1').then(function (response) {
    if (response && response.statusCode === 404) {
        console.log('No reputation found for 127.0.0.1');
    } else {
        console.log('127.0.0.1 has reputation: ', response.body.reputation);
    }
});

Set the reputation for an IP:

client.update('127.0.0.1', 79).then(function (response) {
    console.log('Set reputation for 127.0.0.1 to 79.');
});

Remove an IP:

client.remove('127.0.0.1').then(function (response) {
    console.log('Removed reputation for 127.0.0.1.');
});

Send a violation for an IP:

client.sendViolation('127.0.0.1', 'exceeded-password-reset-failure-rate-limit').then(function (response) {
    console.log('Applied violation to 127.0.0.1.');
});

Development

Tests run against the iprepd service with docker-compose from the ip-reputation-js-client repo root:

1. Install docker and docker-compose
2. Run docker-compose build.
3. Run docker-compose run --rm test npm install to collect package dependencies.
4. Run docker-compose run --rm test to test.
5. Open coverage/lcov-report/index.html to see the coverage report
6. Run docker-compose down when you are finished running tests to remove cache and web containers.