nlid

package

v0.0.0-...-6cfc1b2 Latest Latest Go to latest Published: Nov 28, 2023 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/openclarity/apiclarity

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
type APIAnnotationNLID
- func NewAPIAnnotationNLID(path, method string) *APIAnnotationNLID
type AnnotationNLID
- func NewAnnotationNLID(path, method string, parameters []parameter) *AnnotationNLID
type NLID
- func NewNLID(historySize int) *NLID
- func (n *NLID) Analyze(path, method string, pathParams map[string]string, ...) (eventAnns []utils.TraceAnalyzerAnnotation, ...)
type Reason

Constants ¶

View Source

const (
	MinIDValueLength = 8
	MaxIDValueLength = 40 // This is at least a UUID. every string larger that than is considered low chance of being an ID
)

View Source

const (
	NLIDRingBufferSize = 1024
)

View Source

const (
	NLIDType = "NLID"
)

Variables ¶

View Source

var IDKeys = [...]string{"id", "ids", "identifier", "identifiers"}

Functions ¶

This section is empty.

Types ¶

type APIAnnotationNLID ¶

type APIAnnotationNLID struct {
	utils.BaseTraceAnalyzerAPIAnnotation
	ParamNames map[string]bool `json:"parameters"`
}

func NewAPIAnnotationNLID ¶

func NewAPIAnnotationNLID(path, method string) *APIAnnotationNLID

func (*APIAnnotationNLID) Aggregate ¶

func (a *APIAnnotationNLID) Aggregate(ann utils.TraceAnalyzerAnnotation) (updated bool)

func (*APIAnnotationNLID) Name ¶

func (a *APIAnnotationNLID) Name() string

func (APIAnnotationNLID) Redacted ¶

func (a APIAnnotationNLID) Redacted() utils.TraceAnalyzerAPIAnnotation

func (APIAnnotationNLID) Severity ¶

func (a APIAnnotationNLID) Severity() string

func (*APIAnnotationNLID) ToAPIFinding ¶

func (a *APIAnnotationNLID) ToAPIFinding() oapicommon.APIFinding

type AnnotationNLID ¶

type AnnotationNLID struct {
	Params []parameter `json:"parameters"`
}

func NewAnnotationNLID ¶

func NewAnnotationNLID(path, method string, parameters []parameter) *AnnotationNLID

func (*AnnotationNLID) Name ¶

func (a *AnnotationNLID) Name() string

func (AnnotationNLID) NewAPIAnnotation ¶

func (a AnnotationNLID) NewAPIAnnotation(path, method string) utils.TraceAnalyzerAPIAnnotation

func (AnnotationNLID) Redacted ¶

func (a AnnotationNLID) Redacted() utils.TraceAnalyzerAnnotation

func (*AnnotationNLID) Severity ¶

func (a *AnnotationNLID) Severity() string

func (*AnnotationNLID) ToFinding ¶

func (a *AnnotationNLID) ToFinding() utils.Finding

type NLID ¶

type NLID struct {
	// contains filtered or unexported fields
}

func NewNLID ¶

func NewNLID(historySize int) *NLID

func (*NLID) Analyze ¶

func (n *NLID) Analyze(path, method string, pathParams map[string]string, trace *pluginsmodels.Telemetry) (eventAnns []utils.TraceAnalyzerAnnotation, apiAnns []utils.TraceAnalyzerAPIAnnotation)

type Reason ¶

type Reason map[string]interface{}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL