sbom

package
v5.0.140 Latest Latest
Warning

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

 Go to latest Published: Jan 3, 2025 License: BSD-3-Clause Imports: 7 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	SBOMSourceType_name = map[int32]string{
		0: "UNSPECIFIED",
		1: "CONTAINER_IMAGE_LAYERS",
		2: "CONTAINER_FILE_SYSTEM",
		3: "HOST_FILE_SYSTEM",
		4: "CI_PIPELINE",
		5: "HOST_IMAGE",
	}
	SBOMSourceType_value = map[string]int32{
		"UNSPECIFIED":            0,
		"CONTAINER_IMAGE_LAYERS": 1,
		"CONTAINER_FILE_SYSTEM":  2,
		"HOST_FILE_SYSTEM":       3,
		"CI_PIPELINE":            4,
		"HOST_IMAGE":             5,
	}
)

Enum value maps for SBOMSourceType.

View Source 
var (
	SBOMStatus_name = map[int32]string{
		0: "SUCCESS",
		1: "FAILED",
		2: "PENDING",
	}
	SBOMStatus_value = map[string]int32{
		"SUCCESS": 0,
		"FAILED":  1,
		"PENDING": 2,
	}
)

Enum value maps for SBOMStatus.

View Source 
var File_proto_sbom_sbom_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type SBOMEntity 

type SBOMEntity struct {
	Type               SBOMSourceType         `protobuf:"varint,1,opt,name=type,proto3,enum=datadog.sbom.SBOMSourceType" json:"type,omitempty"`
	Id                 string                 `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`                                       // Unique identifier to be able to correlated and "deduplicate" SBOM
	GeneratedAt        *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=generatedAt,proto3,oneof" json:"generatedAt,omitempty"`               // the datetime of the SBOM generation
	RepoTags           []string               `protobuf:"bytes,4,rep,name=repo_tags,json=repoTags,proto3" json:"repo_tags,omitempty"`           // the tags of the container image
	InUse              bool                   `protobuf:"varint,5,opt,name=inUse,proto3" json:"inUse,omitempty"`                                // Whether the SBOM concerns a running entity (running container) or an inert entity (image not used by any container)
	GenerationDuration *durationpb.Duration   `protobuf:"bytes,6,opt,name=generationDuration,proto3,oneof" json:"generationDuration,omitempty"` // SBOM generation duration (how long it took to generate the SBOM report)
	DdTags             []string               `protobuf:"bytes,7,rep,name=dd_tags,json=ddTags,proto3" json:"dd_tags,omitempty"`                 // datadog tags that will be added by the agent depending of the SBOMSourceType
	Heartbeat          bool                   `protobuf:"varint,8,opt,name=heartbeat,proto3" json:"heartbeat,omitempty"`                        // Whether the SBOM is identical to the previously sent one
	Hash               string                 `protobuf:"bytes,9,opt,name=hash,proto3" json:"hash,omitempty"`                                   // Hash of the SBOM
	// Types that are assignable to Sbom:
	//
	//	*SBOMEntity_Cyclonedx
	//	*SBOMEntity_Error
	Sbom        isSBOMEntity_Sbom `protobuf_oneof:"sbom"`
	Status      SBOMStatus        `protobuf:"varint,11,opt,name=status,proto3,enum=datadog.sbom.SBOMStatus" json:"status,omitempty"`
	RepoDigests []string          `protobuf:"bytes,14,rep,name=repo_digests,json=repoDigests,proto3" json:"repo_digests,omitempty"` // The digests of the container image
	// contains filtered or unexported fields
}

func (*SBOMEntity) Descriptor deprecated 

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

Deprecated: Use SBOMEntity.ProtoReflect.Descriptor instead.

func (*SBOMEntity) GetCyclonedx 

func (x *SBOMEntity) GetCyclonedx() *cyclonedx_v1_4.Bom

func (*SBOMEntity) GetDdTags added in v5.0.75 

func (x *SBOMEntity) GetDdTags() []string

func (*SBOMEntity) GetError added in v5.0.97 

func (x *SBOMEntity) GetError() string

func (*SBOMEntity) GetGeneratedAt 

func (x *SBOMEntity) GetGeneratedAt() *timestamppb.Timestamp

func (*SBOMEntity) GetGenerationDuration added in v5.0.63 

func (x *SBOMEntity) GetGenerationDuration() *durationpb.Duration

func (*SBOMEntity) GetHash added in v5.0.97 

func (x *SBOMEntity) GetHash() string

func (*SBOMEntity) GetHeartbeat added in v5.0.97 

func (x *SBOMEntity) GetHeartbeat() bool

func (*SBOMEntity) GetId 

func (x *SBOMEntity) GetId() string

func (*SBOMEntity) GetInUse 

func (x *SBOMEntity) GetInUse() bool

func (*SBOMEntity) GetRepoDigests added in v5.0.103 

func (x *SBOMEntity) GetRepoDigests() []string

func (*SBOMEntity) GetRepoTags added in v5.0.75 

func (x *SBOMEntity) GetRepoTags() []string

func (*SBOMEntity) GetSbom 

func (m *SBOMEntity) GetSbom() isSBOMEntity_Sbom

func (*SBOMEntity) GetStatus added in v5.0.97 

func (x *SBOMEntity) GetStatus() SBOMStatus

func (*SBOMEntity) GetType 

func (x *SBOMEntity) GetType() SBOMSourceType

func (*SBOMEntity) ProtoMessage 

func (*SBOMEntity) ProtoMessage()

func (*SBOMEntity) ProtoReflect 

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

func (*SBOMEntity) Reset 

func (x *SBOMEntity) Reset()

func (*SBOMEntity) String 

func (x *SBOMEntity) String() string

type SBOMEntity_Cyclonedx 

type SBOMEntity_Cyclonedx struct {
	Cyclonedx *cyclonedx_v1_4.Bom `protobuf:"bytes,10,opt,name=cyclonedx,proto3,oneof"` // only cyclonedx will be supported initially but putting it optional will allow us to move to another format later
}

type SBOMEntity_Error added in v5.0.97 

type SBOMEntity_Error struct {
	// spdx.SBOM      spdx      = 13; // SPDX can be added later as any other format.
	Error string `protobuf:"bytes,12,opt,name=error,proto3,oneof"`
}

type SBOMPayload 

type SBOMPayload struct {
	Version  int32         `protobuf:"varint,1,opt,name=version,proto3" json:"version,omitempty"`
	Host     string        `protobuf:"bytes,2,opt,name=host,proto3" json:"host,omitempty"`
	Source   *string       `protobuf:"bytes,3,opt,name=source,proto3,oneof" json:"source,omitempty"` // use to know the source of the message: agent, other
	Entities []*SBOMEntity `protobuf:"bytes,4,rep,name=entities,proto3" json:"entities,omitempty"`
	DdEnv    *string       `protobuf:"bytes,5,opt,name=dd_env,json=ddEnv,proto3,oneof" json:"dd_env,omitempty"`
	// contains filtered or unexported fields
}

SBOMPayload represents the main SBOM payload

func (*SBOMPayload) Descriptor deprecated 

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

Deprecated: Use SBOMPayload.ProtoReflect.Descriptor instead.

func (*SBOMPayload) GetDdEnv added in v5.0.78 

func (x *SBOMPayload) GetDdEnv() string

func (*SBOMPayload) GetEntities 

func (x *SBOMPayload) GetEntities() []*SBOMEntity

func (*SBOMPayload) GetHost 

func (x *SBOMPayload) GetHost() string

func (*SBOMPayload) GetSource 

func (x *SBOMPayload) GetSource() string

func (*SBOMPayload) GetVersion 

func (x *SBOMPayload) GetVersion() int32

func (*SBOMPayload) ProtoMessage 

func (*SBOMPayload) ProtoMessage()

func (*SBOMPayload) ProtoReflect 

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

func (*SBOMPayload) Reset 

func (x *SBOMPayload) Reset()

func (*SBOMPayload) String 

func (x *SBOMPayload) String() string

type SBOMSourceType 

type SBOMSourceType int32
const (
	SBOMSourceType_UNSPECIFIED            SBOMSourceType = 0
	SBOMSourceType_CONTAINER_IMAGE_LAYERS SBOMSourceType = 1
	SBOMSourceType_CONTAINER_FILE_SYSTEM  SBOMSourceType = 2
	SBOMSourceType_HOST_FILE_SYSTEM       SBOMSourceType = 3
	SBOMSourceType_CI_PIPELINE            SBOMSourceType = 4
	SBOMSourceType_HOST_IMAGE             SBOMSourceType = 5 // SBOM sourced from an Host OS image (ie AWS AMIs, GCP OS images etc.)
)

func (SBOMSourceType) Descriptor 

func (SBOMSourceType) Descriptor() protoreflect.EnumDescriptor

func (SBOMSourceType) Enum 

func (x SBOMSourceType) Enum() *SBOMSourceType

func (SBOMSourceType) EnumDescriptor deprecated 

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

Deprecated: Use SBOMSourceType.Descriptor instead.

func (SBOMSourceType) Number 

func (x SBOMSourceType) Number() protoreflect.EnumNumber

func (SBOMSourceType) String 

func (x SBOMSourceType) String() string

func (SBOMSourceType) Type 

func (SBOMSourceType) Type() protoreflect.EnumType

type SBOMStatus added in v5.0.97 

type SBOMStatus int32
const (
	SBOMStatus_SUCCESS SBOMStatus = 0
	SBOMStatus_FAILED  SBOMStatus = 1
	SBOMStatus_PENDING SBOMStatus = 2
)

func (SBOMStatus) Descriptor added in v5.0.97 

func (SBOMStatus) Descriptor() protoreflect.EnumDescriptor

func (SBOMStatus) Enum added in v5.0.97 

func (x SBOMStatus) Enum() *SBOMStatus

func (SBOMStatus) EnumDescriptor deprecated added in v5.0.97 

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

Deprecated: Use SBOMStatus.Descriptor instead.

func (SBOMStatus) Number added in v5.0.97 

func (x SBOMStatus) Number() protoreflect.EnumNumber

func (SBOMStatus) String added in v5.0.97 

func (x SBOMStatus) String() string

func (SBOMStatus) Type added in v5.0.97 

func (SBOMStatus) Type() protoreflect.EnumType

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.