api

Documentation

Index

• func Categories(version string, rules []scan.Rule) http.HandlerFunc
• func GITScan(cfg cfgreader.EarlybirdConfig) http.HandlerFunc
• func Labels(version string, scanLabels map[int]scan.LabelConfigs) http.HandlerFunc
• func LabelsPerCategory(version string, scanLabels map[int]scan.LabelConfigs) http.HandlerFunc
• func Scan(cfg cfgreader.EarlybirdConfig) http.HandlerFunc
• type CategoriesResponse
• type CategoryLabelsResponse
• type LabelsResponse

Functions

func Categories

func Categories(version string, rules []scan.Rule) http.HandlerFunc

Categories returns all the available Earlybird categories in "CategoriesReponse" format

func GITScan

func GITScan(cfg cfgreader.EarlybirdConfig) http.HandlerFunc

GITScan searches for secrets in git repositories based off the Earlybird config, supports authentication via env variables "gituser" and "gitpassword"

func Labels

func Labels(version string, scanLabels map[int]scan.LabelConfigs) http.HandlerFunc

Labels returns all the available Earlybird labels in "LabelsReponse" format

func LabelsPerCategory

func LabelsPerCategory(version string, scanLabels map[int]scan.LabelConfigs) http.HandlerFunc

LabelsPerCategory returns all the available Earlybird labels per categories in "CategoryLabelsResponse" format

func Scan

func Scan(cfg cfgreader.EarlybirdConfig) http.HandlerFunc

Scan uses the Earlybird config to search uploaded multipart files for secrets

Types

type CategoriesResponse

type CategoriesResponse struct {
	Version    string   `json:"version"`
	Categories []string `json:"categories"`
}

CategoriesResponse is the format of API results from categories end point

type CategoryLabelsResponse

type CategoryLabelsResponse struct {
	Version        string              `json:"version"`
	CategoryLabels map[string][]string `json:"categorylabels"`
}

CategoryLabelsResponse is the format of API results from label per category end point

type LabelsResponse

type LabelsResponse struct {
	Version string   `json:"version"`
	Labels  []string `json:"labels"`
}

LabelsResponse is the format of API results from label end point