utils

Documentation

Index

• Constants
• func FindHeader(headers []*_models.Header, headerName string) (index int, found bool)
• func GetPathParams(specPath string, opPath string) map[string]string
• func Min(x, y int) int
• func ReadDictionaryFiles(filenames []string) ([]string, error)
• func SeverityToAlert(severity string) core.AlertSeverity
• func WalkFiles(root string) ([]string, error)
• type API
• type BaseTraceAnalyzerAPIAnnotation
  • func (a BaseTraceAnalyzerAPIAnnotation) Method() string
  • func (a BaseTraceAnalyzerAPIAnnotation) Path() string
  • func (a BaseTraceAnalyzerAPIAnnotation) Severity() string
  • func (a BaseTraceAnalyzerAPIAnnotation) SpecLocation() string
  • func (a BaseTraceAnalyzerAPIAnnotation) TTL() time.Duration
• type Finding
• type TraceAnalyzerAPIAnnotation
• type TraceAnalyzerAnnotation

Constants

const (
	ModuleName        = "traceanalyzer"
	ModuleDescription = "Inspects request and responses to detect insecure practices"
)

const (
	SeverityInfo     = "INFO"
	SeverityLow      = "LOW"
	SeverityMedium   = "MEDIUM"
	SeverityHigh     = "HIGH"
	SeverityCritical = "CRITICAL"
)

Functions

func FindHeader

func FindHeader(headers []*_models.Header, headerName string) (index int, found bool)

func GetPathParams

func GetPathParams(specPath string, opPath string) map[string]string

func Min

func Min(x, y int) int

func ReadDictionaryFiles

func ReadDictionaryFiles(filenames []string) ([]string, error)

func SeverityToAlert

func SeverityToAlert(severity string) core.AlertSeverity

func WalkFiles

func WalkFiles(root string) ([]string, error)

Types

type API

type API = string

type BaseTraceAnalyzerAPIAnnotation

type BaseTraceAnalyzerAPIAnnotation struct {
	SpecPath   string `json:"path"`
	SpecMethod string `json:"method"`
}

func (BaseTraceAnalyzerAPIAnnotation) Method

func (a BaseTraceAnalyzerAPIAnnotation) Method() string

func (BaseTraceAnalyzerAPIAnnotation) Path

func (a BaseTraceAnalyzerAPIAnnotation) Path() string

func (BaseTraceAnalyzerAPIAnnotation) Severity

func (a BaseTraceAnalyzerAPIAnnotation) Severity() string

func (BaseTraceAnalyzerAPIAnnotation) SpecLocation

func (a BaseTraceAnalyzerAPIAnnotation) SpecLocation() string

func (BaseTraceAnalyzerAPIAnnotation) TTL

func (a BaseTraceAnalyzerAPIAnnotation) TTL() time.Duration

type Finding

type Finding struct {
	ShortDesc    string
	DetailedDesc string
	Severity     string
	Alert        core.AlertSeverity
}

A finding is an interpreted annotation.

type TraceAnalyzerAPIAnnotation

type TraceAnalyzerAPIAnnotation interface {
	Name() string
	Path() string
	Method() string
	Aggregate(TraceAnalyzerAnnotation) (notify bool)
	Severity() string
	TTL() time.Duration
	Redacted() TraceAnalyzerAPIAnnotation
	ToAPIFinding() oapicommon.APIFinding
}

type TraceAnalyzerAnnotation

type TraceAnalyzerAnnotation interface {
	Name() string
	NewAPIAnnotation(path, method string) TraceAnalyzerAPIAnnotation
	Severity() string
	Redacted() TraceAnalyzerAnnotation
	ToFinding() Finding
}