v1

package
v0.0.8-alpha Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 14, 2025 License: Apache-2.0 Imports: 5 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	DataSource_TargetType_name = map[int32]string{
		0: "TARGET_TYPE_UNSPECIFIED",
		1: "TARGET_TYPE_REPOSITORY",
		2: "TARGET_TYPE_CONTAINER_IMAGE",
	}
	DataSource_TargetType_value = map[string]int32{
		"TARGET_TYPE_UNSPECIFIED":     0,
		"TARGET_TYPE_REPOSITORY":      1,
		"TARGET_TYPE_CONTAINER_IMAGE": 2,
	}
)

Enum value maps for DataSource_TargetType.

View Source
var (
	DataSource_URISchema_name = map[int32]string{
		0: "URI_SCHEMA_UNSPECIFIED",
		1: "URI_SCHEMA_FILE",
		2: "URI_SCHEMA_PURL",
	}
	DataSource_URISchema_value = map[string]int32{
		"URI_SCHEMA_UNSPECIFIED": 0,
		"URI_SCHEMA_FILE":        1,
		"URI_SCHEMA_PURL":        2,
	}
)

Enum value maps for DataSource_URISchema.

View Source
var (
	Enrichment_EnrichmentType_name = map[int32]string{
		0: "ENRICHMENT_TYPE_UNSPECIFIED",
		1: "ENRICHMENT_TYPE_CORRELATION",
		2: "ENRICHMENT_TYPE_DUPLICATION",
		3: "ENRICHMENT_INVESTIGATION",
	}
	Enrichment_EnrichmentType_value = map[string]int32{
		"ENRICHMENT_TYPE_UNSPECIFIED": 0,
		"ENRICHMENT_TYPE_CORRELATION": 1,
		"ENRICHMENT_TYPE_DUPLICATION": 2,
		"ENRICHMENT_INVESTIGATION":    3,
	}
)

Enum value maps for Enrichment_EnrichmentType.

View Source
var File_ocsf_ext_finding_info_v1_finding_info_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type DataSource

type DataSource struct {
	TargetType DataSource_TargetType `` /* 135-byte string literal not displayed */
	Uri        *DataSource_URI       `protobuf:"bytes,2,opt,name=uri,proto3" json:"uri,omitempty"`
	// location_data can be a different value based on target_type.
	//
	// Types that are assignable to LocationData:
	//
	//	*DataSource_FileFindingLocationData_
	//	*DataSource_PurlFindingLocationData_
	LocationData       isDataSource_LocationData      `protobuf_oneof:"location_data"`
	SourceCodeMetadata *DataSource_SourceCodeMetadata `protobuf:"bytes,5,opt,name=source_code_metadata,json=sourceCodeMetadata,proto3" json:"source_code_metadata,omitempty"`
	OciPackageMetadata *DataSource_OCIPackageMetadata `protobuf:"bytes,6,opt,name=oci_package_metadata,json=ociPackageMetadata,proto3" json:"oci_package_metadata,omitempty"`
	// contains filtered or unexported fields
}

DataSource is used to define Data Sources described on https://schema.ocsf.io/1.3.0/objects/finding_info.

func (*DataSource) Descriptor deprecated

func (*DataSource) Descriptor() ([]byte, []int)

Deprecated: Use DataSource.ProtoReflect.Descriptor instead.

func (*DataSource) GetFileFindingLocationData

func (x *DataSource) GetFileFindingLocationData() *DataSource_FileFindingLocationData

func (*DataSource) GetLocationData

func (m *DataSource) GetLocationData() isDataSource_LocationData

func (*DataSource) GetOciPackageMetadata

func (x *DataSource) GetOciPackageMetadata() *DataSource_OCIPackageMetadata

func (*DataSource) GetPurlFindingLocationData

func (x *DataSource) GetPurlFindingLocationData() *DataSource_PurlFindingLocationData

func (*DataSource) GetSourceCodeMetadata

func (x *DataSource) GetSourceCodeMetadata() *DataSource_SourceCodeMetadata

func (*DataSource) GetTargetType

func (x *DataSource) GetTargetType() DataSource_TargetType

func (*DataSource) GetUri

func (x *DataSource) GetUri() *DataSource_URI

func (*DataSource) ProtoMessage

func (*DataSource) ProtoMessage()

func (*DataSource) ProtoReflect

func (x *DataSource) ProtoReflect() protoreflect.Message

func (*DataSource) Reset

func (x *DataSource) Reset()

func (*DataSource) String

func (x *DataSource) String() string

type DataSource_FileFindingLocationData

type DataSource_FileFindingLocationData struct {
	StartLine   uint32 `protobuf:"varint,3,opt,name=start_line,json=startLine,proto3" json:"start_line,omitempty"`
	EndLine     uint32 `protobuf:"varint,4,opt,name=end_line,json=endLine,proto3" json:"end_line,omitempty"`
	StartColumn uint32 `protobuf:"varint,5,opt,name=start_column,json=startColumn,proto3" json:"start_column,omitempty"`
	EndColumn   uint32 `protobuf:"varint,6,opt,name=end_column,json=endColumn,proto3" json:"end_column,omitempty"`
	// contains filtered or unexported fields
}

FileFindingLocationData specifies data associated with the physical location of a finding in a file.

func (*DataSource_FileFindingLocationData) Descriptor deprecated

func (*DataSource_FileFindingLocationData) Descriptor() ([]byte, []int)

Deprecated: Use DataSource_FileFindingLocationData.ProtoReflect.Descriptor instead.

func (*DataSource_FileFindingLocationData) GetEndColumn

func (x *DataSource_FileFindingLocationData) GetEndColumn() uint32

func (*DataSource_FileFindingLocationData) GetEndLine

func (*DataSource_FileFindingLocationData) GetStartColumn

func (x *DataSource_FileFindingLocationData) GetStartColumn() uint32

func (*DataSource_FileFindingLocationData) GetStartLine

func (x *DataSource_FileFindingLocationData) GetStartLine() uint32

func (*DataSource_FileFindingLocationData) ProtoMessage

func (*DataSource_FileFindingLocationData) ProtoMessage()

func (*DataSource_FileFindingLocationData) ProtoReflect

func (*DataSource_FileFindingLocationData) Reset

func (*DataSource_FileFindingLocationData) String

type DataSource_FileFindingLocationData_

type DataSource_FileFindingLocationData_ struct {
	FileFindingLocationData *DataSource_FileFindingLocationData `protobuf:"bytes,3,opt,name=file_finding_location_data,json=fileFindingLocationData,proto3,oneof"`
}

type DataSource_OCIPackageMetadata

type DataSource_OCIPackageMetadata struct {
	PackageUrl string `protobuf:"bytes,1,opt,name=package_url,json=packageUrl,proto3" json:"package_url,omitempty"`
	Tag        string `protobuf:"bytes,2,opt,name=tag,proto3" json:"tag,omitempty"`
	// contains filtered or unexported fields
}

OCIPackageMetadata records the metadata of the package that was scanned. There is a possibility that we can correlate an OCI package to a source code repository from where it was generated. The fact that these fields exist doesn't mean that the SourceCodeMetadata won't be present.

func (*DataSource_OCIPackageMetadata) Descriptor deprecated

func (*DataSource_OCIPackageMetadata) Descriptor() ([]byte, []int)

Deprecated: Use DataSource_OCIPackageMetadata.ProtoReflect.Descriptor instead.

func (*DataSource_OCIPackageMetadata) GetPackageUrl

func (x *DataSource_OCIPackageMetadata) GetPackageUrl() string

func (*DataSource_OCIPackageMetadata) GetTag

func (*DataSource_OCIPackageMetadata) ProtoMessage

func (*DataSource_OCIPackageMetadata) ProtoMessage()

func (*DataSource_OCIPackageMetadata) ProtoReflect

func (*DataSource_OCIPackageMetadata) Reset

func (x *DataSource_OCIPackageMetadata) Reset()

func (*DataSource_OCIPackageMetadata) String

type DataSource_PurlFindingLocationData

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

PurlFindingLocationData specifies data associated with the logical location of a finding in a purl.

func (*DataSource_PurlFindingLocationData) Descriptor deprecated

func (*DataSource_PurlFindingLocationData) Descriptor() ([]byte, []int)

Deprecated: Use DataSource_PurlFindingLocationData.ProtoReflect.Descriptor instead.

func (*DataSource_PurlFindingLocationData) ProtoMessage

func (*DataSource_PurlFindingLocationData) ProtoMessage()

func (*DataSource_PurlFindingLocationData) ProtoReflect

func (*DataSource_PurlFindingLocationData) Reset

func (*DataSource_PurlFindingLocationData) String

type DataSource_PurlFindingLocationData_

type DataSource_PurlFindingLocationData_ struct {
	PurlFindingLocationData *DataSource_PurlFindingLocationData `protobuf:"bytes,4,opt,name=purl_finding_location_data,json=purlFindingLocationData,proto3,oneof"`
}

type DataSource_SourceCodeMetadata

type DataSource_SourceCodeMetadata struct {
	RepositoryUrl string `protobuf:"bytes,1,opt,name=repository_url,json=repositoryUrl,proto3" json:"repository_url,omitempty"`
	Reference     string `protobuf:"bytes,2,opt,name=reference,proto3" json:"reference,omitempty"`
	// contains filtered or unexported fields
}

SourceCodeMetadata records the metadata of the repository holding the code of either

func (*DataSource_SourceCodeMetadata) Descriptor deprecated

func (*DataSource_SourceCodeMetadata) Descriptor() ([]byte, []int)

Deprecated: Use DataSource_SourceCodeMetadata.ProtoReflect.Descriptor instead.

func (*DataSource_SourceCodeMetadata) GetReference

func (x *DataSource_SourceCodeMetadata) GetReference() string

func (*DataSource_SourceCodeMetadata) GetRepositoryUrl

func (x *DataSource_SourceCodeMetadata) GetRepositoryUrl() string

func (*DataSource_SourceCodeMetadata) ProtoMessage

func (*DataSource_SourceCodeMetadata) ProtoMessage()

func (*DataSource_SourceCodeMetadata) ProtoReflect

func (*DataSource_SourceCodeMetadata) Reset

func (x *DataSource_SourceCodeMetadata) Reset()

func (*DataSource_SourceCodeMetadata) String

type DataSource_TargetType

type DataSource_TargetType int32

TargetType specifies the target type.

const (
	DataSource_TARGET_TYPE_UNSPECIFIED     DataSource_TargetType = 0
	DataSource_TARGET_TYPE_REPOSITORY      DataSource_TargetType = 1
	DataSource_TARGET_TYPE_CONTAINER_IMAGE DataSource_TargetType = 2
)

func (DataSource_TargetType) Descriptor

func (DataSource_TargetType) Enum

func (DataSource_TargetType) EnumDescriptor deprecated

func (DataSource_TargetType) EnumDescriptor() ([]byte, []int)

Deprecated: Use DataSource_TargetType.Descriptor instead.

func (DataSource_TargetType) Number

func (DataSource_TargetType) String

func (x DataSource_TargetType) String() string

func (DataSource_TargetType) Type

type DataSource_URI

type DataSource_URI struct {
	UriSchema DataSource_URISchema `` /* 131-byte string literal not displayed */
	Path      string               `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

URI specifies uri content.

func (*DataSource_URI) Descriptor deprecated

func (*DataSource_URI) Descriptor() ([]byte, []int)

Deprecated: Use DataSource_URI.ProtoReflect.Descriptor instead.

func (*DataSource_URI) GetPath

func (x *DataSource_URI) GetPath() string

func (*DataSource_URI) GetUriSchema

func (x *DataSource_URI) GetUriSchema() DataSource_URISchema

func (*DataSource_URI) ProtoMessage

func (*DataSource_URI) ProtoMessage()

func (*DataSource_URI) ProtoReflect

func (x *DataSource_URI) ProtoReflect() protoreflect.Message

func (*DataSource_URI) Reset

func (x *DataSource_URI) Reset()

func (*DataSource_URI) String

func (x *DataSource_URI) String() string

type DataSource_URISchema

type DataSource_URISchema int32

URISchema specifies the URI schema. For example: - purl: pkg:npm/angular/animation@12.3.1" -> "pkg" - file: file://main.go -> "file"

const (
	DataSource_URI_SCHEMA_UNSPECIFIED DataSource_URISchema = 0
	DataSource_URI_SCHEMA_FILE        DataSource_URISchema = 1
	DataSource_URI_SCHEMA_PURL        DataSource_URISchema = 2
)

func (DataSource_URISchema) Descriptor

func (DataSource_URISchema) Enum

func (DataSource_URISchema) EnumDescriptor deprecated

func (DataSource_URISchema) EnumDescriptor() ([]byte, []int)

Deprecated: Use DataSource_URISchema.Descriptor instead.

func (DataSource_URISchema) Number

func (DataSource_URISchema) String

func (x DataSource_URISchema) String() string

func (DataSource_URISchema) Type

type Enrichment

type Enrichment struct {
	EnrichmentType Enrichment_EnrichmentType `` /* 151-byte string literal not displayed */
	// Types that are assignable to Enrichment:
	//
	//	*Enrichment_Duplicate
	//	*Enrichment_Correlations
	//	*Enrichment_Investigations
	Enrichment isEnrichment_Enrichment `protobuf_oneof:"enrichment"`
	// contains filtered or unexported fields
}

annotations created by the DataEnricher

func (*Enrichment) Descriptor deprecated

func (*Enrichment) Descriptor() ([]byte, []int)

Deprecated: Use Enrichment.ProtoReflect.Descriptor instead.

func (*Enrichment) GetCorrelations

func (x *Enrichment) GetCorrelations() *Enrichment_CorrelationEnrichment

func (*Enrichment) GetDuplicate

func (x *Enrichment) GetDuplicate() *Enrichment_DuplicateEnrichment

func (*Enrichment) GetEnrichment

func (m *Enrichment) GetEnrichment() isEnrichment_Enrichment

func (*Enrichment) GetEnrichmentType

func (x *Enrichment) GetEnrichmentType() Enrichment_EnrichmentType

func (*Enrichment) GetInvestigations

func (x *Enrichment) GetInvestigations() *Enrichment_InvestigationEnrichment

func (*Enrichment) ProtoMessage

func (*Enrichment) ProtoMessage()

func (*Enrichment) ProtoReflect

func (x *Enrichment) ProtoReflect() protoreflect.Message

func (*Enrichment) Reset

func (x *Enrichment) Reset()

func (*Enrichment) String

func (x *Enrichment) String() string

type Enrichment_CorrelationEnrichment

type Enrichment_CorrelationEnrichment struct {
	Findings []uint64 `protobuf:"varint,1,rep,packed,name=findings,proto3" json:"findings,omitempty"`
	// contains filtered or unexported fields
}

a list of finding ids, of the other findings it has been correlated to

func (*Enrichment_CorrelationEnrichment) Descriptor deprecated

func (*Enrichment_CorrelationEnrichment) Descriptor() ([]byte, []int)

Deprecated: Use Enrichment_CorrelationEnrichment.ProtoReflect.Descriptor instead.

func (*Enrichment_CorrelationEnrichment) GetFindings

func (x *Enrichment_CorrelationEnrichment) GetFindings() []uint64

func (*Enrichment_CorrelationEnrichment) ProtoMessage

func (*Enrichment_CorrelationEnrichment) ProtoMessage()

func (*Enrichment_CorrelationEnrichment) ProtoReflect

func (*Enrichment_CorrelationEnrichment) Reset

func (*Enrichment_CorrelationEnrichment) String

type Enrichment_Correlations

type Enrichment_Correlations struct {
	Correlations *Enrichment_CorrelationEnrichment `protobuf:"bytes,3,opt,name=correlations,proto3,oneof"`
}

type Enrichment_Duplicate

type Enrichment_Duplicate struct {
	Duplicate *Enrichment_DuplicateEnrichment `protobuf:"bytes,2,opt,name=duplicate,proto3,oneof"`
}

type Enrichment_DuplicateEnrichment

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

if it has this enrichment at all, the finding is a duplicate

func (*Enrichment_DuplicateEnrichment) Descriptor deprecated

func (*Enrichment_DuplicateEnrichment) Descriptor() ([]byte, []int)

Deprecated: Use Enrichment_DuplicateEnrichment.ProtoReflect.Descriptor instead.

func (*Enrichment_DuplicateEnrichment) ProtoMessage

func (*Enrichment_DuplicateEnrichment) ProtoMessage()

func (*Enrichment_DuplicateEnrichment) ProtoReflect

func (*Enrichment_DuplicateEnrichment) Reset

func (x *Enrichment_DuplicateEnrichment) Reset()

func (*Enrichment_DuplicateEnrichment) String

type Enrichment_EnrichmentType

type Enrichment_EnrichmentType int32
const (
	Enrichment_ENRICHMENT_TYPE_UNSPECIFIED Enrichment_EnrichmentType = 0
	Enrichment_ENRICHMENT_TYPE_CORRELATION Enrichment_EnrichmentType = 1
	Enrichment_ENRICHMENT_TYPE_DUPLICATION Enrichment_EnrichmentType = 2
	Enrichment_ENRICHMENT_INVESTIGATION    Enrichment_EnrichmentType = 3
)

func (Enrichment_EnrichmentType) Descriptor

func (Enrichment_EnrichmentType) Enum

func (Enrichment_EnrichmentType) EnumDescriptor deprecated

func (Enrichment_EnrichmentType) EnumDescriptor() ([]byte, []int)

Deprecated: Use Enrichment_EnrichmentType.Descriptor instead.

func (Enrichment_EnrichmentType) Number

func (Enrichment_EnrichmentType) String

func (x Enrichment_EnrichmentType) String() string

func (Enrichment_EnrichmentType) Type

type Enrichment_InvestigationEnrichment

type Enrichment_InvestigationEnrichment struct {
	Status v1.IncidentFinding_VerdictId `protobuf:"varint,1,opt,name=status,proto3,enum=ocsf_schema.v1.IncidentFinding_VerdictId" json:"status,omitempty"`
	// contains filtered or unexported fields
}

status of the finding after a user investigation

func (*Enrichment_InvestigationEnrichment) Descriptor deprecated

func (*Enrichment_InvestigationEnrichment) Descriptor() ([]byte, []int)

Deprecated: Use Enrichment_InvestigationEnrichment.ProtoReflect.Descriptor instead.

func (*Enrichment_InvestigationEnrichment) GetStatus

func (*Enrichment_InvestigationEnrichment) ProtoMessage

func (*Enrichment_InvestigationEnrichment) ProtoMessage()

func (*Enrichment_InvestigationEnrichment) ProtoReflect

func (*Enrichment_InvestigationEnrichment) Reset

func (*Enrichment_InvestigationEnrichment) String

type Enrichment_Investigations

type Enrichment_Investigations struct {
	Investigations *Enrichment_InvestigationEnrichment `protobuf:"bytes,4,opt,name=investigations,proto3,oneof"`
}

Jump to

Keyboard shortcuts

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