Admin Guide

Synapse-URLScan Admin Guide

Configuration

Synapse-URLScan requires an API key. To create one, please visit the URLScan signup page.

Setting an API key for global use

To set-up a global API key:

> urlscan.setup.apikey myapikey
Setting URLScan API key for all users.

Using per-user API keys

A user may set-up their own API key:

> urlscan.setup.apikey --self myapikey
Setting URLScan API key for the current user.

Permissions

Package (synapse-urlscan) defines the following permissions:
power-ups.urlscan.user           : Allows a user to issue queries to the URLScan API. ( default: false )

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

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

or:

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

Exported APIs

Synapse-URLScan does not currently export any APIs.

Node Actions

Synapse-URLScan provides the following node actions in Optic:

Name : enrich
Desc : Search URLScan by domain or URL.
Forms: inet:fqdn, inet:url

Name : scan
Desc : Submit a URL to be scanned to URLScan.
Forms: inet:url

Name : search.hostnames
Desc : Search URLScan for hostnames on this domain.
Forms: inet:fqdn

Name : search.certificates
Desc : Search URLScan for certificates related to this domain.
Forms: inet:fqdn

Name : search.incidents
Desc : Search URLScan for incidents related to this node.
Forms: inet:fqdn, inet:ipv4, inet:ipv6, inet:url