conviso-flowcli 1.9.4rc1

No project description provided

Flowcli

This is a command line tool to interact with convisoappsec flow api. This aims to be very useful for integrations development.

Installation

To install flowcli some dependecies are required:

• python3 >= 3.4. See python3 download
• pip. See pip guide
• git. See git download
• Docker. See docker download

If you have system admin privileges just execute one of the following commands.

$ pip install conviso-flowcli

or

$ python3 -m pip install conviso-flowcli

If you haven't system admin privileges execute one of the following commands.

$ pip install --user conviso-flowcli

or

$ python3 -m pip install --user conviso-flowcli

Check if the install command was well succeeded.

$ flow --version

The command will print the current version and exit with success. Now we are ready to proceed.

Getting started

Overview

The primary goal of the flowcli aims to be a developer friendly tool. The tool will automate as many steps as possible to decrease spent time on an integration with appsec flow. Using this tool the integration with your CI/CD platform will be easy. At your CI/CD you be able to perform SAST and DAST analysis, send source code to be reviewed by our analysts and order features availables in your appsec flow account.

Shell Completion

This section will guide you to activate the flow shell completion. This is not required to use the tool so you can skip it if you want.

Bash

Open your .bashrc file at ~/.bashrc and place the following snippet in the end of file.

FLOW_COMPLETER="$(which flow_bash_completer.sh)"

[ -f "$FLOW_COMPLETER" ] && {
  source "$FLOW_COMPLETER"
}

Start a new bash shell session and the shell completion will be available.

Zsh

Open your .zshrc file at ~/.zshrc and place the following snippet in the end of file.

FLOW_COMPLETER="$(which flow_zsh_completer.sh)"

[ -f "$FLOW_COMPLETER" ] && {
  source "$FLOW_COMPLETER"
}

Start a new zsh shell session and the shell completion will be available.

Fish

Start a fish shell session and execute the following command.

$ mkdir -p ~/.config/fish/completions
$ cp (which flow_fish_completer.fish) ~/.config/fish/completions/flow.fish

Start a new fish shell session and the shell completion will be available.

Main command

The main command of flowcli is flow. To see the command help run the following command.

$ flow -h

or

$ flow --help

Authentication

To start with flowcli an appsec flow api key(See generating api key) will be necessary. After you got it you can export the key as system environment variable and use the flowcli.

$ export FLOW_API_KEY='you-api-key'

or the api key can be set as option argument

$ flow --api-key 'you-api-key' [SOME COMMAND]

Static program analysis(SAST)

With the flowcli is very simple to perform a SAST at your source code repository. Let's see some examples.

Reporting the SAST results to Flow AppSec API

To report the SAST result to flow api a project code will be required. The project is created at Flow AppSec Web View. See creating project.

Assuming that my_source_code_repository is a git repository, so:

$ export FLOW_API_KEY='your-api-key'
$ export FLOW_PROJECT_CODE='your-project-code'
$ cd my_source_code_repository
$ flow sast run

The following instructions has the same effect.

$ cd my_source_code_repository
$ flow --api-key 'your-api-key' sast run --project-code 'your-project-code'