turbot / flowpipe-mod-virustotal

VirusTotal pipeline library for the Flowpipe cloud scripting engine. Automation and workflows to connect VirusTotal to the people, systems and data that matters.

VirusTotal Mod for Flowpipe

VirusTotal pipeline library for Flowpipe, enabling seamless integration of VirusTotal services into your workflows.

Documentation

• Pipelines →

Getting Started

Installation

Download and install Flowpipe (https://flowpipe.io/downloads). Or use Brew:

brew tap turbot/tap
brew install flowpipe

Credentials

By default, the following environment variables will be used for authentication:

• VTCLI_APIKEY

You can also create credential resources in configuration files:

vi ~/.flowpipe/config/virustotal.fpc

credential "virustotal" "my_virustotal" {
  api_key = "AG.U7..."
}

For more information on credentials in Flowpipe, please see Managing Credentials.

Usage

Initialize a mod:

mkdir my_mod
cd my_mod
flowpipe mod init

Install the VirusTotal mod as a dependency:

flowpipe mod install github.com/turbot/flowpipe-mod-virustotal

Use the dependency in a pipeline step:

vi my_pipeline.fp

pipeline "my_pipeline" {

  step "pipeline" "get_ip_address_report" {
    pipeline = virustotal.get_ip_address_report
    args = {
      ip_address = "76.76.21.21"
    }
  }
}

Run the pipeline

flowpipe pipeline run my_pipeline

Developing

Clone:

git clone https://github.com/turbot/flowpipe-mod-virustotal.git
cd flowpipe-mod-virustotal

List pipelines:

flowpipe pipeline list

Run a pipeline:

flowpipe pipeline run get_ip_address_report --arg ip_address='76.76.21.21'

To use a specific credential, specify the cred pipeline argument:

flowpipe pipeline run get_ip_address_report --arg cred=my_virustotal

Open Source & Contributing

This repository is published under the Apache 2.0 license. Please see our code of conduct. We look forward to collaborating with you!

Flowpipe is a product produced from this open source software, exclusively by Turbot HQ, Inc. It is distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our Open Source FAQ.

Get Involved

Join #flowpipe on Slack →

Want to help but not sure where to start? Pick up one of the help wanted issues:

• Flowpipe
• VirusTotal Mod