aftra-cli

README

aftra-cli

Public API go binary for integrating with Aftra

Env Variables:

• AFTRA_API_TOKEN: Token for communicating with the AFTRA api

• AFTRA_COMPANY: Company ID associated with the token (Retrieved using aftra-cli get token company)

• AFTRA_HOST: Location of the host. Used during testing of the CLI client.

Local setup

Make sure go/bin is in your PATH and then run make init, followed by make build.

Now you should be able to run the program with go run . <command>.

To authenticate correctly see Getting started.

Rebuilding the openapi-based structs

• go generate ./...

To add additional items to the subset of openapi schema being used, edit PATHS in subset_maker.py

Example usage

Command	Description
aftra-cli create opportunity	Create an internal opportunity in Aftra
aftra-cli submit <scan-type> <scan-name> --message <msg>	Submit a raw scan event to the specified scanner
aftra-cli submit <scan-type> <scan-name> --filename <filename>	Submit a file of raw scan events to the specified scanner
aftra-cli get token	Get current token information in json format
aftra-cli get company	Get current token company information only
aftra-cli get config <scan-type>	Get all scan configs
aftra-cli get config <scan-type> <scan-name>	Get a scan config
aftra-cli get opportunities --limit=<limit> --updated-since=<datetime>	Filter all opportunities
aftra-cli update resolution <uid> <status> --comment <comment>	Update the resolution status of an opportunity
aftra-cli log <scan-type> <scan-name> <msg>	Log the contents of msg to Aftra. It will be viewable viat the API
your_command.sh | aftra-cli log <scan-type> <scan-name>	Log from stdout to Aftra. It will be viewable viat the API

Create opportunity

• uid: This should uniquely identify the opportunity. Creating with the same uid will result in an update to the existing one.
• details: Additional information in the form of key,value pairs. These are presented to the user in Aftra.
• name: The display name for the opportunity.
• score: Risk score (critical, high, medium, low, info, none, unknown)

Fetching opportunities

aftra-cli get opportunities --limit=10 --updated-since=2020-01-01T00:00:00Z

Getting started

1. Export your token as AFTRA_API_TOKEN

   $ export AFTRA_API_TOKEN=<token>

2. Export company id as AFTRA_COMPANY

   $ export AFTRA_COMPANY=$(aftra-cli get company)

3. (Optional) Get any config required, and put somewhere that your script uses. The name is that defined on the config via the web UI.

   $ aftra-cli get config syndis myscanner > config.ini

4. Create an opportunity (optional)

   $ aftra-cli create opportunity --uid=<uid> --name=<name> --score=<score> --details=<details>

5. Submit results directly, to be converted into opportunities (optional)

   $ aftra-cli submit syndis myscanner -f <json-filename>

6. Log out messages from stdin

   $ ./my_opportunity_finder.sh | aftra-cli log syndis myscanner

Documentation

Overview

Copyright © 2023 Syndis ehf. <syndis@syndis.is>