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

Creating a configuration for role-based use

Add an unscoped configuration:

> urlscan.config.add myunscoped myapikey --scope unscoped
Synapse-URLScan config "myunscoped" added

Grant another user admin permissions to the new configuration:

> urlscan.config.update myunscoped --perm user visi admin
Updated Synapse-URLScan config "myunscoped"

Grant a role read permissions to the new configuration:

> urlscan.config.update myunscoped --perm role ninjas read
Updated Synapse-URLScan config "myunscoped"

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

Setting the tag prefix

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

> urlscan.config.migrate --tag-prefix my.tagpref
Updated Synapse-URLScan config "synapse-urlscan:myunscoped"

Overriding the proxy configuration

In order to override the default proxy configuration in the Cortex the user must have the power-ups.urlscan.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.

Permissions

Package (synapse-urlscan) defines the following permissions:
power-ups.urlscan.user           : Allows a user to issue queries to the URLScan API. ( default: false )
power-ups.urlscan.admin          : Controls access to Synapse-URLScan admin options. ( 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.

Workflows

Synapse-URLScan provides the following workflows in Optic:

Title: Configuration

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

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