Admin Guide

Synapse-DomainTools Admin Guide

Configuration

Synapse-DomainTools requires a DomainTools API key. For PDNS data, the Farsight DNSDB requires an additional separate API key. For information on how to sign up, please visit the DomainTools API documentation.

Setting API credentials for global use

To set-up a global API key:

> domaintools.setup.apikey myapiuser myapikey
Setting DomainTools API credentials for all users.

Using per-user API credentials

A user may set-up their own API key:

> domaintools.setup.apikey --self myapiuser myapikey
Setting DomainTools API credentials for the current user.

Setting a Farsight DNSDB API key

The Farsight DNSDB requires a separate API key which can be configured with:

> domaintools.farsight.setup.apikey myapikey
Setting DomainTools Farsight API key for all users.

Dependencies

Synapse-DomainTools does not have any dependencies.

Permissions

Package (synapse-domaintools) defines the following permissions:
power-ups.domaintools.user       : Controls user access to Synapse-DomainTools. ( default: false )

You may add rules to users/roles directly from storm:

> auth.user.addrule visi power-ups.domaintools.user
Added rule power-ups.domaintools.user to user visi.

or:

> auth.role.addrule ninjas power-ups.domaintools.user
Added rule power-ups.domaintools.user to role ninjas.

Exported APIs

Synapse-DomainTools does not currently export any APIs.

Workflows

Synapse-DomainTools provides the following workflows in Optic:

Title: Configuration

Node Actions

Synapse-DomainTools provides the following node actions in Optic:

Name : iris.enrich
Desc : Enrich nodes using Synapse-DomainTools
Forms: inet:fqdn

Name : whois.history
Desc : Enrich nodes with Whois history data using Synapse-DomainTools
Forms: inet:fqdn

Name : hosting.history
Desc : Enrich nodes with hosting history data using Synapse-DomainTools
Forms: inet:fqdn

Name : pdns
Desc : Enrich nodes with PDNS data using Synapse-DomainTools
Forms: inet:fqdn, inet:ipv4, inet:ipv6, inet:cidr4, inet:cidr6

Name : pdns (include subdomains)
Desc : Include subdomains when searching for PDNS data using Synapse-DomainTools
Forms: inet:fqdn

Onload Events

Synapse-DomainTools uses an onload event to add extended model properties for DomainTools data.