Admin Guide

Synapse-CertSpotter Admin Guide

Configuration

Synapse-CertSpotter can optionally use a CertSpotter API key. For information on how to signup, please visit the CertSpotter API documentation.

Setting API key for global use

To set-up a global API key:

> certspotter.setup.apikey myapikey
Setting Synapse-CertSpotter API key for all users.

Using per-user API keys

A user may set-up their own API key:

> certspotter.setup.apikey --self myapikey
Setting Synapse-CertSpotter API key for the current user.

Dependencies

Synapse-CertSpotter requires the following Power-Ups to be installed:

Name   : synapse-fileparser
Version: >=4.2.1,<5.0.0
Desc   : Synapse-FileParser is required for parsing certificates for the certspotter.certs command.

Synapse-CertSpotter will conflict with the following Power-Ups:

Name   : certspotter
Version: any
Desc   : Synapse-Certspotter conflicts with a deprecated Power-Up named "certspotter".

Permissions

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

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

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

or:

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

Exported APIs

Synapse-CertSpotter does not currently export any APIs.

Node Actions

Synapse-CertSpotter does not currently prvovide any Optic Node Actions.