sbom

Documentation

Index

• Variables
• type SBOMEntity
  • func (*SBOMEntity) Descriptor() ([]byte, []int)
  • func (x *SBOMEntity) GetCyclonedx() *cyclonedx_v1_4.Bom
  • func (x *SBOMEntity) GetGeneratedAt() *timestamp.Timestamp
  • func (x *SBOMEntity) GetGenerationDuration() *duration.Duration
  • func (x *SBOMEntity) GetId() string
  • func (x *SBOMEntity) GetInUse() bool
  • func (m *SBOMEntity) GetSbom() isSBOMEntity_Sbom
  • func (x *SBOMEntity) GetTags() []string
  • func (x *SBOMEntity) GetType() SBOMSourceType
  • func (*SBOMEntity) ProtoMessage()
  • func (x *SBOMEntity) ProtoReflect() protoreflect.Message
  • func (x *SBOMEntity) Reset()
  • func (x *SBOMEntity) String() string
• type SBOMEntity_Cyclonedx
• type SBOMPayload
  • func (*SBOMPayload) Descriptor() ([]byte, []int)
  • func (x *SBOMPayload) GetEntities() []*SBOMEntity
  • func (x *SBOMPayload) GetHost() string
  • func (x *SBOMPayload) GetSource() string
  • func (x *SBOMPayload) GetVersion() int32
  • func (*SBOMPayload) ProtoMessage()
  • func (x *SBOMPayload) ProtoReflect() protoreflect.Message
  • func (x *SBOMPayload) Reset()
  • func (x *SBOMPayload) String() string
• type SBOMSourceType
  • func (SBOMSourceType) Descriptor() protoreflect.EnumDescriptor
  • func (x SBOMSourceType) Enum() *SBOMSourceType
  • func (SBOMSourceType) EnumDescriptor() ([]byte, []int)
  • func (x SBOMSourceType) Number() protoreflect.EnumNumber
  • func (x SBOMSourceType) String() string
  • func (SBOMSourceType) Type() protoreflect.EnumType

Variables

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

Enum value maps for SBOMSourceType.

var File_proto_sbom_sbom_proto protoreflect.FileDescriptor

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        *timestamp.Timestamp `protobuf:"bytes,3,opt,name=generatedAt,proto3,oneof" json:"generatedAt,omitempty"`               // the datetime of the SBOM generation
	Tags               []string             `protobuf:"bytes,4,rep,name=tags,proto3" json:"tags,omitempty"`                                   // datadog tags that will be added by the agent depending of the SBOMSourceType
	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 *duration.Duration   `protobuf:"bytes,6,opt,name=generationDuration,proto3,oneof" json:"generationDuration,omitempty"` // SBOM generation duration (how long it took to generate the SBOM report)
	// Types that are assignable to Sbom:
	//	*SBOMEntity_Cyclonedx
	Sbom isSBOMEntity_Sbom `protobuf_oneof:"sbom"`
	// contains filtered or unexported fields
}

func (*SBOMEntity) Descriptor

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

Deprecated: Use SBOMEntity.ProtoReflect.Descriptor instead.

func (*SBOMEntity) GetCyclonedx

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

func (*SBOMEntity) GetGeneratedAt

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

func (*SBOMEntity) GetGenerationDuration

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

func (*SBOMEntity) GetId

func (x *SBOMEntity) GetId() string

func (*SBOMEntity) GetInUse

func (x *SBOMEntity) GetInUse() bool

func (*SBOMEntity) GetSbom

func (m *SBOMEntity) GetSbom() isSBOMEntity_Sbom

func (*SBOMEntity) GetTags

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

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 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"`
	// contains filtered or unexported fields
}

SBOMPayload represents the main SBOM payload

func (*SBOMPayload) Descriptor

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

Deprecated: Use SBOMPayload.ProtoReflect.Descriptor instead.

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
)

func (SBOMSourceType) Descriptor

func (SBOMSourceType) Descriptor() protoreflect.EnumDescriptor

func (SBOMSourceType) Enum

func (x SBOMSourceType) Enum() *SBOMSourceType

func (SBOMSourceType) EnumDescriptor

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