producers

README

Producers

A producer is a program that parses the output of a tool and converts it into Dracon compatible file that can be used by the enricher and consumers.

Writing Producers

Producers can be written in any language that supports protobufs, we have examples in Golang and Python. They are all structured the same way:

1. Parse program arguments:
   1. in: the raw tool results file location
   2. out: where to place the Dracon compatible output file location
2. Parse the in file into Protobufs (LaunchToolResponse)
3. Add metadata to Protobufs (e.g. git/source-code information)
4. Write the protobuf bytes to the out file

Producer API

For convenience, there are helper functions in the ./producers pkg/module for Golang/Python.

The WriteDraconOut/write_dracon_out method expects a list of issues to write as the LaunchToolResponse protobuf. Your producer should parse the output of a tool results into Issue protobufs which are then passed into this method.

Documentation

Overview

Package producers provides helper functions for writing Dracon compatible producers that parse tool outputs. Subdirectories in this package have more complete example usages of this package.

Index

• Constants
• Variables
• func ParseFlags() error
• func ParseJSON(in []byte, structure interface{}) error
• func ReadInFile() ([]byte, error)
• func ReadLines() ([][]byte, error)
• func WriteDraconOut(toolName string, issues []*v1.Issue) error

Examples

• ParseFlags
• WriteDraconOut

Constants

const (

	// EnvDraconStartTime Start Time of Dracon Scan in RFC3339
	EnvDraconStartTime = "DRACON_SCAN_TIME"
	// EnvDraconScanID the ID of the dracon scan
	EnvDraconScanID = "DRACON_SCAN_ID"
)

Variables

var (
	// InResults represents incoming tool output
	InResults string
	// OutFile points to the protobuf file where dracon results will be written
	OutFile string
	// Append flag will append to the outfile instead of overwriting, useful when there's multiple inresults
	Append bool
)

Functions

func ParseFlags

func ParseFlags() error

ParseFlags will parse the input flags for the producer and perform simple validation

Example

if err := ParseFlags(); err != nil {
	log.Fatal(err)
}

func ParseJSON

func ParseJSON(in []byte, structure interface{}) error

ParseJSON provides a generic method to parse JSON input (e.g. the results provided by a tool) into a given struct.

func ReadInFile

func ReadInFile() ([]byte, error)

ReadInFile returns the contents of the file given by InResults.

func ReadLines

func ReadLines() ([][]byte, error)

ReadLines returns the lines of the contents of the file given by InResults

func WriteDraconOut

func WriteDraconOut(
	toolName string,
	issues []*v1.Issue,
) error

WriteDraconOut provides a generic method to write the resulting protobuf to the output file

Example

issues := []*v1.Issue{}
if err := WriteDraconOut(
	"gosec",
	issues,
); err != nil {
	log.Fatal(err)
}