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.config.add default myapikey
Synapse-HYAS config "default" added

Creating a configuration for role-based use

Add an unscoped configuration:

> hyas.config.add myunscoped myapikey --scope unscoped
Synapse-HYAS config "myunscoped" added

Grant another user admin permissions to the new configuration:

> hyas.config.update myunscoped --perm user visi admin
Updated Synapse-HYAS config "myunscoped"

Grant a role read permissions to the new configuration:

> hyas.config.update myunscoped --perm role ninjas read
Updated Synapse-HYAS config "myunscoped"

Users may select a configuration other than their default by passing --config <name> to the Synapse-HYAS commands.

Setting the tag prefix

The tag prefix used when recording data from HYAS defaults to rep.hyas. It may be set per configuration using the --tag-prefix option to hyas.config.add or hyas.config.update, or for all configurations using hyas.config.migrate:

> hyas.config.migrate --tag-prefix my.tagpref
Updated Synapse-HYAS config "synapse-hyas:myunscoped"

Overriding the proxy configuration

In order to override the default proxy configuration in the Cortex the user must have the power-ups.hyas.admin or storm.lib.inet.http.proxy permission.

When the proxy configuration is set to (false) or a URL the permission will be checked when a configuration is created/updated, and when it is used to make an HTTP request.

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 )
power-ups.hyas.admin             : Controls access to Synapse-HYAS admin options. ( 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

The Configuration workflow may be used to manage Synapse-HYAS configurations from Optic.

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