Admin Guide

Synapse-HYAS Admin Guide

Configuration

Synapse-HYAS requires a HYAS API key. For information on how to sign up, please visit the HYAS API documentation.

Setting API key for global use

To set-up a global API key:

> hyas.setup.apikey myapikey
Setting HYAS API key for all users.

Using per-user API keys

A user may set-up their own API key:

> hyas.setup.apikey --self myapikey
Setting HYAS API key for the current user.

Dependencies

Synapse-HYAS does not have any dependencies.

Permissions

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

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

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

or:

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

Exported APIs

Synapse-HYAS does not currently export any APIs.

Workflows

Synapse-HYAS provides the following workflows in Optic:

Title: Configuration

Node Actions

Synapse-HYAS provides the following node actions in Optic:

Name : pdns
Desc : Get passive DNS information from HYAS
Forms: inet:ipv4, inet:fqdn

Name : dynamic dns
Desc : Get dynamic DNS information from HYAS
Forms: inet:ipv4, inet:fqdn, inet:email

Name : whois
Desc : Get WHOIS data from HYAS
Forms: inet:fqdn

Name : ssl certs
Desc : Ingest SSL certificates from HYAS
Forms: inet:fqdn, inet:ipv4, hash:sha1, file:bytes, crypto:x509:cert

Name : ssl certs
Desc : Ingest SSL certificates from HYAS
Forms: inet:fqdn, inet:ipv4, hash:sha1, file:bytes, crypto:x509:cert

Name : c2 attribution
Desc : $lib.null
Forms: inet:fqdn, inet:ipv4, inet:email, hash:sha256, file:bytes