inventoryv1

package
v0.0.0-...-1a28f28 Latest Latest
Warning

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

Go to latest
Published: Jan 22, 2026 License: MIT Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	CollectPhase_name = map[int32]string{
		0: "PHASE_UNSPECIFIED",
		1: "PHASE_RESOLVING_TARGET",
		2: "PHASE_EXTRACTING",
		3: "PHASE_ENRICHING",
		4: "PHASE_COMPLETED",
		5: "PHASE_FAILED",
	}
	CollectPhase_value = map[string]int32{
		"PHASE_UNSPECIFIED":      0,
		"PHASE_RESOLVING_TARGET": 1,
		"PHASE_EXTRACTING":       2,
		"PHASE_ENRICHING":        3,
		"PHASE_COMPLETED":        4,
		"PHASE_FAILED":           5,
	}
)

Enum value maps for CollectPhase.

View Source
var (
	ExtractorSource_name = map[int32]string{
		0: "EXTRACTOR_SOURCE_UNSPECIFIED",
		1: "EXTRACTOR_SOURCE_SCALIBR",
		2: "EXTRACTOR_SOURCE_DEPUTY",
		3: "EXTRACTOR_SOURCE_PLUGIN",
	}
	ExtractorSource_value = map[string]int32{
		"EXTRACTOR_SOURCE_UNSPECIFIED": 0,
		"EXTRACTOR_SOURCE_SCALIBR":     1,
		"EXTRACTOR_SOURCE_DEPUTY":      2,
		"EXTRACTOR_SOURCE_PLUGIN":      3,
	}
)

Enum value maps for ExtractorSource.

View Source
var File_deputy_inventory_v1_service_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type CollectInventoryOptions

type CollectInventoryOptions struct {

	// Ecosystems limits extraction to specific package ecosystems.
	// Empty means all supported ecosystems.
	// Values: go, npm, pypi, maven, rubygems, cargo, nuget, hex, pub, cocoapods, packagist, github-actions
	Ecosystems []string `protobuf:"bytes,1,rep,name=ecosystems,proto3" json:"ecosystems,omitempty"`
	// Ref is a Git reference for repository targets.
	// Examples: "HEAD", "main", "v1.0.0", "abc123"
	Ref string `protobuf:"bytes,2,opt,name=ref,proto3" json:"ref,omitempty"`
	// Platform specifies container image platform.
	// Example: "linux/amd64"
	Platform string `protobuf:"bytes,3,opt,name=platform,proto3" json:"platform,omitempty"`
	// IncludeLicenses enriches packages with license information.
	// This may require additional network requests to deps.dev.
	IncludeLicenses bool `protobuf:"varint,4,opt,name=include_licenses,json=includeLicenses,proto3" json:"include_licenses,omitempty"`
	// EnabledExtractors limits which extractors run.
	// Empty means all available extractors.
	EnabledExtractors []string `protobuf:"bytes,5,rep,name=enabled_extractors,json=enabledExtractors,proto3" json:"enabled_extractors,omitempty"`
	// contains filtered or unexported fields
}

CollectInventoryOptions configure how inventory is collected.

func (*CollectInventoryOptions) Descriptor deprecated

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

Deprecated: Use CollectInventoryOptions.ProtoReflect.Descriptor instead.

func (*CollectInventoryOptions) GetEcosystems

func (x *CollectInventoryOptions) GetEcosystems() []string

func (*CollectInventoryOptions) GetEnabledExtractors

func (x *CollectInventoryOptions) GetEnabledExtractors() []string

func (*CollectInventoryOptions) GetIncludeLicenses

func (x *CollectInventoryOptions) GetIncludeLicenses() bool

func (*CollectInventoryOptions) GetPlatform

func (x *CollectInventoryOptions) GetPlatform() string

func (*CollectInventoryOptions) GetRef

func (x *CollectInventoryOptions) GetRef() string

func (*CollectInventoryOptions) ProtoMessage

func (*CollectInventoryOptions) ProtoMessage()

func (*CollectInventoryOptions) ProtoReflect

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

func (*CollectInventoryOptions) Reset

func (x *CollectInventoryOptions) Reset()

func (*CollectInventoryOptions) String

func (x *CollectInventoryOptions) String() string

type CollectInventoryProgress

type CollectInventoryProgress struct {

	// Phase indicates the current collection phase.
	Phase CollectPhase `protobuf:"varint,1,opt,name=phase,proto3,enum=deputy.inventory.v1.CollectPhase" json:"phase,omitempty"`
	// Message provides human-readable status.
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// PackagesFound is the count of packages discovered so far.
	PackagesFound int32 `protobuf:"varint,3,opt,name=packages_found,json=packagesFound,proto3" json:"packages_found,omitempty"`
	// ExtractorName identifies the active extractor.
	ExtractorName string `protobuf:"bytes,4,opt,name=extractor_name,json=extractorName,proto3" json:"extractor_name,omitempty"`
	// Result is populated when phase is PHASE_COMPLETED.
	Result *CollectInventoryResponse `protobuf:"bytes,5,opt,name=result,proto3" json:"result,omitempty"`
	// Error is populated when phase is PHASE_FAILED.
	Error string `protobuf:"bytes,6,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

CollectInventoryProgress provides streaming updates during collection.

func (*CollectInventoryProgress) Descriptor deprecated

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

Deprecated: Use CollectInventoryProgress.ProtoReflect.Descriptor instead.

func (*CollectInventoryProgress) GetError

func (x *CollectInventoryProgress) GetError() string

func (*CollectInventoryProgress) GetExtractorName

func (x *CollectInventoryProgress) GetExtractorName() string

func (*CollectInventoryProgress) GetMessage

func (x *CollectInventoryProgress) GetMessage() string

func (*CollectInventoryProgress) GetPackagesFound

func (x *CollectInventoryProgress) GetPackagesFound() int32

func (*CollectInventoryProgress) GetPhase

func (x *CollectInventoryProgress) GetPhase() CollectPhase

func (*CollectInventoryProgress) GetResult

func (*CollectInventoryProgress) ProtoMessage

func (*CollectInventoryProgress) ProtoMessage()

func (*CollectInventoryProgress) ProtoReflect

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

func (*CollectInventoryProgress) Reset

func (x *CollectInventoryProgress) Reset()

func (*CollectInventoryProgress) String

func (x *CollectInventoryProgress) String() string

type CollectInventoryRequest

type CollectInventoryRequest struct {

	// Target is the path, URL, or reference to scan.
	// Examples:
	//   - "." (current directory)
	//   - "/path/to/project"
	//   - "https://github.com/owner/repo"
	//   - "docker://nginx:1.25"
	//   - "ghcr.io/owner/app:v1"
	Target string `protobuf:"bytes,1,opt,name=target,proto3" json:"target,omitempty"`
	// Options configure collection behavior.
	Options *CollectInventoryOptions `protobuf:"bytes,2,opt,name=options,proto3" json:"options,omitempty"`
	// contains filtered or unexported fields
}

CollectInventoryRequest specifies the target and options for inventory collection.

func (*CollectInventoryRequest) Descriptor deprecated

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

Deprecated: Use CollectInventoryRequest.ProtoReflect.Descriptor instead.

func (*CollectInventoryRequest) GetOptions

func (*CollectInventoryRequest) GetTarget

func (x *CollectInventoryRequest) GetTarget() string

func (*CollectInventoryRequest) ProtoMessage

func (*CollectInventoryRequest) ProtoMessage()

func (*CollectInventoryRequest) ProtoReflect

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

func (*CollectInventoryRequest) Reset

func (x *CollectInventoryRequest) Reset()

func (*CollectInventoryRequest) String

func (x *CollectInventoryRequest) String() string

type CollectInventoryResponse

type CollectInventoryResponse struct {

	// Target describes what was scanned.
	Target *v1.Target `protobuf:"bytes,1,opt,name=target,proto3" json:"target,omitempty"`
	// GeneratedAt is when the inventory was collected.
	GeneratedAt *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=generated_at,json=generatedAt,proto3" json:"generated_at,omitempty"`
	// Packages lists all discovered dependencies.
	Packages []*v11.Package `protobuf:"bytes,3,rep,name=packages,proto3" json:"packages,omitempty"`
	// Stats summarizes the collection.
	Stats *InventoryStats `protobuf:"bytes,4,opt,name=stats,proto3" json:"stats,omitempty"`
	// ImageInfo contains container image metadata when applicable.
	ImageInfo *v12.ImageInfo `protobuf:"bytes,5,opt,name=image_info,json=imageInfo,proto3" json:"image_info,omitempty"`
	// Dockerfile contains parsed Dockerfile data when applicable.
	DockerfileInfo *DockerfileInfo `protobuf:"bytes,6,opt,name=dockerfile_info,json=dockerfileInfo,proto3" json:"dockerfile_info,omitempty"`
	// ExtractorsUsed lists which extractors produced results.
	ExtractorsUsed []string `protobuf:"bytes,7,rep,name=extractors_used,json=extractorsUsed,proto3" json:"extractors_used,omitempty"`
	// contains filtered or unexported fields
}

CollectInventoryResponse contains the extracted inventory.

func (*CollectInventoryResponse) Descriptor deprecated

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

Deprecated: Use CollectInventoryResponse.ProtoReflect.Descriptor instead.

func (*CollectInventoryResponse) GetDockerfileInfo

func (x *CollectInventoryResponse) GetDockerfileInfo() *DockerfileInfo

func (*CollectInventoryResponse) GetExtractorsUsed

func (x *CollectInventoryResponse) GetExtractorsUsed() []string

func (*CollectInventoryResponse) GetGeneratedAt

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

func (*CollectInventoryResponse) GetImageInfo

func (x *CollectInventoryResponse) GetImageInfo() *v12.ImageInfo

func (*CollectInventoryResponse) GetPackages

func (x *CollectInventoryResponse) GetPackages() []*v11.Package

func (*CollectInventoryResponse) GetStats

func (*CollectInventoryResponse) GetTarget

func (x *CollectInventoryResponse) GetTarget() *v1.Target

func (*CollectInventoryResponse) ProtoMessage

func (*CollectInventoryResponse) ProtoMessage()

func (*CollectInventoryResponse) ProtoReflect

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

func (*CollectInventoryResponse) Reset

func (x *CollectInventoryResponse) Reset()

func (*CollectInventoryResponse) String

func (x *CollectInventoryResponse) String() string

type CollectPhase

type CollectPhase int32

CollectPhase describes the current phase of inventory collection.

const (
	CollectPhase_PHASE_UNSPECIFIED      CollectPhase = 0
	CollectPhase_PHASE_RESOLVING_TARGET CollectPhase = 1
	CollectPhase_PHASE_EXTRACTING       CollectPhase = 2
	CollectPhase_PHASE_ENRICHING        CollectPhase = 3
	CollectPhase_PHASE_COMPLETED        CollectPhase = 4
	CollectPhase_PHASE_FAILED           CollectPhase = 5
)

func (CollectPhase) Descriptor

func (CollectPhase) Enum

func (x CollectPhase) Enum() *CollectPhase

func (CollectPhase) EnumDescriptor deprecated

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

Deprecated: Use CollectPhase.Descriptor instead.

func (CollectPhase) Number

func (CollectPhase) String

func (x CollectPhase) String() string

func (CollectPhase) Type

type DockerfileAnalysis

type DockerfileAnalysis struct {
	StageCount          int32    `protobuf:"varint,1,opt,name=stage_count,json=stageCount,proto3" json:"stage_count,omitempty"`
	HasMultiStage       bool     `protobuf:"varint,2,opt,name=has_multi_stage,json=hasMultiStage,proto3" json:"has_multi_stage,omitempty"`
	BuilderStageCount   int32    `protobuf:"varint,3,opt,name=builder_stage_count,json=builderStageCount,proto3" json:"builder_stage_count,omitempty"`
	FinalStageIsRoot    bool     `protobuf:"varint,4,opt,name=final_stage_is_root,json=finalStageIsRoot,proto3" json:"final_stage_is_root,omitempty"`
	FinalStageIsScratch bool     `protobuf:"varint,5,opt,name=final_stage_is_scratch,json=finalStageIsScratch,proto3" json:"final_stage_is_scratch,omitempty"`
	SensitiveEnvVars    []string `protobuf:"bytes,6,rep,name=sensitive_env_vars,json=sensitiveEnvVars,proto3" json:"sensitive_env_vars,omitempty"`
	HasAddUrl           bool     `protobuf:"varint,7,opt,name=has_add_url,json=hasAddUrl,proto3" json:"has_add_url,omitempty"`
	// contains filtered or unexported fields
}

DockerfileAnalysis contains static analysis results.

func (*DockerfileAnalysis) Descriptor deprecated

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

Deprecated: Use DockerfileAnalysis.ProtoReflect.Descriptor instead.

func (*DockerfileAnalysis) GetBuilderStageCount

func (x *DockerfileAnalysis) GetBuilderStageCount() int32

func (*DockerfileAnalysis) GetFinalStageIsRoot

func (x *DockerfileAnalysis) GetFinalStageIsRoot() bool

func (*DockerfileAnalysis) GetFinalStageIsScratch

func (x *DockerfileAnalysis) GetFinalStageIsScratch() bool

func (*DockerfileAnalysis) GetHasAddUrl

func (x *DockerfileAnalysis) GetHasAddUrl() bool

func (*DockerfileAnalysis) GetHasMultiStage

func (x *DockerfileAnalysis) GetHasMultiStage() bool

func (*DockerfileAnalysis) GetSensitiveEnvVars

func (x *DockerfileAnalysis) GetSensitiveEnvVars() []string

func (*DockerfileAnalysis) GetStageCount

func (x *DockerfileAnalysis) GetStageCount() int32

func (*DockerfileAnalysis) ProtoMessage

func (*DockerfileAnalysis) ProtoMessage()

func (*DockerfileAnalysis) ProtoReflect

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

func (*DockerfileAnalysis) Reset

func (x *DockerfileAnalysis) Reset()

func (*DockerfileAnalysis) String

func (x *DockerfileAnalysis) String() string

type DockerfileInfo

type DockerfileInfo struct {

	// Path is the Dockerfile path.
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// Stages lists all build stages.
	Stages []*DockerfileStage `protobuf:"bytes,2,rep,name=stages,proto3" json:"stages,omitempty"`
	// FinalStage is the last (output) stage.
	FinalStage *DockerfileStage `protobuf:"bytes,3,opt,name=final_stage,json=finalStage,proto3" json:"final_stage,omitempty"`
	// Args are ARG instructions with defaults.
	Args map[string]string `` /* 135-byte string literal not displayed */
	// Analysis contains static analysis results.
	Analysis *DockerfileAnalysis `protobuf:"bytes,5,opt,name=analysis,proto3" json:"analysis,omitempty"`
	// contains filtered or unexported fields
}

DockerfileInfo contains parsed Dockerfile data.

func (*DockerfileInfo) Descriptor deprecated

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

Deprecated: Use DockerfileInfo.ProtoReflect.Descriptor instead.

func (*DockerfileInfo) GetAnalysis

func (x *DockerfileInfo) GetAnalysis() *DockerfileAnalysis

func (*DockerfileInfo) GetArgs

func (x *DockerfileInfo) GetArgs() map[string]string

func (*DockerfileInfo) GetFinalStage

func (x *DockerfileInfo) GetFinalStage() *DockerfileStage

func (*DockerfileInfo) GetPath

func (x *DockerfileInfo) GetPath() string

func (*DockerfileInfo) GetStages

func (x *DockerfileInfo) GetStages() []*DockerfileStage

func (*DockerfileInfo) ProtoMessage

func (*DockerfileInfo) ProtoMessage()

func (*DockerfileInfo) ProtoReflect

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

func (*DockerfileInfo) Reset

func (x *DockerfileInfo) Reset()

func (*DockerfileInfo) String

func (x *DockerfileInfo) String() string

type DockerfileStage

type DockerfileStage struct {

	// Index is the 0-based stage position.
	Index int32 `protobuf:"varint,1,opt,name=index,proto3" json:"index,omitempty"`
	// Name is the AS alias (empty if unnamed).
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// BaseImage is the FROM image reference.
	BaseImage string `protobuf:"bytes,3,opt,name=base_image,json=baseImage,proto3" json:"base_image,omitempty"`
	// BaseImageResolved is the parsed image reference.
	BaseImageResolved *ImageReference `protobuf:"bytes,4,opt,name=base_image_resolved,json=baseImageResolved,proto3" json:"base_image_resolved,omitempty"`
	// Platform is the --platform flag value.
	Platform string `protobuf:"bytes,5,opt,name=platform,proto3" json:"platform,omitempty"`
	// IsScratch is true if FROM scratch.
	IsScratch bool `protobuf:"varint,6,opt,name=is_scratch,json=isScratch,proto3" json:"is_scratch,omitempty"`
	// IsBuilderStage is true if only used as COPY source.
	IsBuilderStage bool `protobuf:"varint,7,opt,name=is_builder_stage,json=isBuilderStage,proto3" json:"is_builder_stage,omitempty"`
	// User is the final USER directive value.
	User string `protobuf:"bytes,8,opt,name=user,proto3" json:"user,omitempty"`
	// IsRoot is true if running as root.
	IsRoot bool `protobuf:"varint,9,opt,name=is_root,json=isRoot,proto3" json:"is_root,omitempty"`
	// Workdir is the WORKDIR value.
	Workdir string `protobuf:"bytes,10,opt,name=workdir,proto3" json:"workdir,omitempty"`
	// EnvVars are ENV declarations.
	EnvVars map[string]string `` /* 157-byte string literal not displayed */
	// SensitiveEnv lists env vars matching secret patterns.
	SensitiveEnv []string `protobuf:"bytes,12,rep,name=sensitive_env,json=sensitiveEnv,proto3" json:"sensitive_env,omitempty"`
	// ExposedPorts are EXPOSE ports.
	ExposedPorts []string `protobuf:"bytes,13,rep,name=exposed_ports,json=exposedPorts,proto3" json:"exposed_ports,omitempty"`
	// Labels are LABEL key-value pairs.
	Labels map[string]string `` /* 140-byte string literal not displayed */
	// contains filtered or unexported fields
}

DockerfileStage represents a single build stage.

func (*DockerfileStage) Descriptor deprecated

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

Deprecated: Use DockerfileStage.ProtoReflect.Descriptor instead.

func (*DockerfileStage) GetBaseImage

func (x *DockerfileStage) GetBaseImage() string

func (*DockerfileStage) GetBaseImageResolved

func (x *DockerfileStage) GetBaseImageResolved() *ImageReference

func (*DockerfileStage) GetEnvVars

func (x *DockerfileStage) GetEnvVars() map[string]string

func (*DockerfileStage) GetExposedPorts

func (x *DockerfileStage) GetExposedPorts() []string

func (*DockerfileStage) GetIndex

func (x *DockerfileStage) GetIndex() int32

func (*DockerfileStage) GetIsBuilderStage

func (x *DockerfileStage) GetIsBuilderStage() bool

func (*DockerfileStage) GetIsRoot

func (x *DockerfileStage) GetIsRoot() bool

func (*DockerfileStage) GetIsScratch

func (x *DockerfileStage) GetIsScratch() bool

func (*DockerfileStage) GetLabels

func (x *DockerfileStage) GetLabels() map[string]string

func (*DockerfileStage) GetName

func (x *DockerfileStage) GetName() string

func (*DockerfileStage) GetPlatform

func (x *DockerfileStage) GetPlatform() string

func (*DockerfileStage) GetSensitiveEnv

func (x *DockerfileStage) GetSensitiveEnv() []string

func (*DockerfileStage) GetUser

func (x *DockerfileStage) GetUser() string

func (*DockerfileStage) GetWorkdir

func (x *DockerfileStage) GetWorkdir() string

func (*DockerfileStage) ProtoMessage

func (*DockerfileStage) ProtoMessage()

func (*DockerfileStage) ProtoReflect

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

func (*DockerfileStage) Reset

func (x *DockerfileStage) Reset()

func (*DockerfileStage) String

func (x *DockerfileStage) String() string

type ExtractRequest

type ExtractRequest struct {

	// Path is the file path relative to scan root.
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// Contents is the file's raw bytes.
	Contents []byte `protobuf:"bytes,2,opt,name=contents,proto3" json:"contents,omitempty"`
	// Root is the scan root path (for resolving relative paths).
	Root string `protobuf:"bytes,3,opt,name=root,proto3" json:"root,omitempty"`
	// contains filtered or unexported fields
}

ExtractRequest provides file contents for extraction.

func (*ExtractRequest) Descriptor deprecated

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

Deprecated: Use ExtractRequest.ProtoReflect.Descriptor instead.

func (*ExtractRequest) GetContents

func (x *ExtractRequest) GetContents() []byte

func (*ExtractRequest) GetPath

func (x *ExtractRequest) GetPath() string

func (*ExtractRequest) GetRoot

func (x *ExtractRequest) GetRoot() string

func (*ExtractRequest) ProtoMessage

func (*ExtractRequest) ProtoMessage()

func (*ExtractRequest) ProtoReflect

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

func (*ExtractRequest) Reset

func (x *ExtractRequest) Reset()

func (*ExtractRequest) String

func (x *ExtractRequest) String() string

type ExtractResponse

type ExtractResponse struct {

	// Packages are the dependencies discovered in this file.
	Packages []*v11.Package `protobuf:"bytes,1,rep,name=packages,proto3" json:"packages,omitempty"`
	// contains filtered or unexported fields
}

ExtractResponse contains packages discovered in a file.

func (*ExtractResponse) Descriptor deprecated

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

Deprecated: Use ExtractResponse.ProtoReflect.Descriptor instead.

func (*ExtractResponse) GetPackages

func (x *ExtractResponse) GetPackages() []*v11.Package

func (*ExtractResponse) ProtoMessage

func (*ExtractResponse) ProtoMessage()

func (*ExtractResponse) ProtoReflect

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

func (*ExtractResponse) Reset

func (x *ExtractResponse) Reset()

func (*ExtractResponse) String

func (x *ExtractResponse) String() string

type ExtractorInfo

type ExtractorInfo struct {

	// Name is the extractor identifier (e.g., "go/gomod", "javascript/packagejson").
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// DisplayName is a human-readable name.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Ecosystem is the package ecosystem this extractor supports.
	Ecosystem string `protobuf:"bytes,3,opt,name=ecosystem,proto3" json:"ecosystem,omitempty"`
	// Version is the extractor version.
	Version int32 `protobuf:"varint,4,opt,name=version,proto3" json:"version,omitempty"`
	// Description provides context about the extractor.
	Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
	// FilePatterns lists recognized file patterns.
	FilePatterns []string `protobuf:"bytes,6,rep,name=file_patterns,json=filePatterns,proto3" json:"file_patterns,omitempty"`
	// Source indicates where the extractor comes from.
	Source ExtractorSource `protobuf:"varint,7,opt,name=source,proto3,enum=deputy.inventory.v1.ExtractorSource" json:"source,omitempty"`
	// contains filtered or unexported fields
}

ExtractorInfo describes an inventory extractor.

func (*ExtractorInfo) Descriptor deprecated

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

Deprecated: Use ExtractorInfo.ProtoReflect.Descriptor instead.

func (*ExtractorInfo) GetDescription

func (x *ExtractorInfo) GetDescription() string

func (*ExtractorInfo) GetDisplayName

func (x *ExtractorInfo) GetDisplayName() string

func (*ExtractorInfo) GetEcosystem

func (x *ExtractorInfo) GetEcosystem() string

func (*ExtractorInfo) GetFilePatterns

func (x *ExtractorInfo) GetFilePatterns() []string

func (*ExtractorInfo) GetName

func (x *ExtractorInfo) GetName() string

func (*ExtractorInfo) GetSource

func (x *ExtractorInfo) GetSource() ExtractorSource

func (*ExtractorInfo) GetVersion

func (x *ExtractorInfo) GetVersion() int32

func (*ExtractorInfo) ProtoMessage

func (*ExtractorInfo) ProtoMessage()

func (*ExtractorInfo) ProtoReflect

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

func (*ExtractorInfo) Reset

func (x *ExtractorInfo) Reset()

func (*ExtractorInfo) String

func (x *ExtractorInfo) String() string

type ExtractorSource

type ExtractorSource int32

ExtractorSource indicates the origin of an extractor.

const (
	ExtractorSource_EXTRACTOR_SOURCE_UNSPECIFIED ExtractorSource = 0
	// Built-in OSV-SCALIBR extractor.
	ExtractorSource_EXTRACTOR_SOURCE_SCALIBR ExtractorSource = 1
	// Deputy custom extractor (e.g., github-actions, dockerfile).
	ExtractorSource_EXTRACTOR_SOURCE_DEPUTY ExtractorSource = 2
	// User-registered plugin via pluginrpc.
	ExtractorSource_EXTRACTOR_SOURCE_PLUGIN ExtractorSource = 3
)

func (ExtractorSource) Descriptor

func (ExtractorSource) Enum

func (x ExtractorSource) Enum() *ExtractorSource

func (ExtractorSource) EnumDescriptor deprecated

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

Deprecated: Use ExtractorSource.Descriptor instead.

func (ExtractorSource) Number

func (ExtractorSource) String

func (x ExtractorSource) String() string

func (ExtractorSource) Type

type FileRequiredRequest

type FileRequiredRequest struct {

	// Path is the file path relative to scan root.
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// IsDir indicates if the path is a directory.
	IsDir bool `protobuf:"varint,2,opt,name=is_dir,json=isDir,proto3" json:"is_dir,omitempty"`
	// Mode is the file permission mode (Unix-style).
	Mode uint32 `protobuf:"varint,3,opt,name=mode,proto3" json:"mode,omitempty"`
	// Size is the file size in bytes.
	Size int64 `protobuf:"varint,4,opt,name=size,proto3" json:"size,omitempty"`
	// contains filtered or unexported fields
}

FileRequiredRequest provides file metadata for filtering.

func (*FileRequiredRequest) Descriptor deprecated

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

Deprecated: Use FileRequiredRequest.ProtoReflect.Descriptor instead.

func (*FileRequiredRequest) GetIsDir

func (x *FileRequiredRequest) GetIsDir() bool

func (*FileRequiredRequest) GetMode

func (x *FileRequiredRequest) GetMode() uint32

func (*FileRequiredRequest) GetPath

func (x *FileRequiredRequest) GetPath() string

func (*FileRequiredRequest) GetSize

func (x *FileRequiredRequest) GetSize() int64

func (*FileRequiredRequest) ProtoMessage

func (*FileRequiredRequest) ProtoMessage()

func (*FileRequiredRequest) ProtoReflect

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

func (*FileRequiredRequest) Reset

func (x *FileRequiredRequest) Reset()

func (*FileRequiredRequest) String

func (x *FileRequiredRequest) String() string

type FileRequiredResponse

type FileRequiredResponse struct {

	// Required is true if Extract should be called for this file.
	Required bool `protobuf:"varint,1,opt,name=required,proto3" json:"required,omitempty"`
	// contains filtered or unexported fields
}

FileRequiredResponse indicates if the extractor wants to process the file.

func (*FileRequiredResponse) Descriptor deprecated

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

Deprecated: Use FileRequiredResponse.ProtoReflect.Descriptor instead.

func (*FileRequiredResponse) GetRequired

func (x *FileRequiredResponse) GetRequired() bool

func (*FileRequiredResponse) ProtoMessage

func (*FileRequiredResponse) ProtoMessage()

func (*FileRequiredResponse) ProtoReflect

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

func (*FileRequiredResponse) Reset

func (x *FileRequiredResponse) Reset()

func (*FileRequiredResponse) String

func (x *FileRequiredResponse) String() string

type ImageReference

type ImageReference struct {
	Registry   string `protobuf:"bytes,1,opt,name=registry,proto3" json:"registry,omitempty"`
	Repository string `protobuf:"bytes,2,opt,name=repository,proto3" json:"repository,omitempty"`
	Tag        string `protobuf:"bytes,3,opt,name=tag,proto3" json:"tag,omitempty"`
	Digest     string `protobuf:"bytes,4,opt,name=digest,proto3" json:"digest,omitempty"`
	// contains filtered or unexported fields
}

ImageReference is a parsed container image reference.

func (*ImageReference) Descriptor deprecated

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

Deprecated: Use ImageReference.ProtoReflect.Descriptor instead.

func (*ImageReference) GetDigest

func (x *ImageReference) GetDigest() string

func (*ImageReference) GetRegistry

func (x *ImageReference) GetRegistry() string

func (*ImageReference) GetRepository

func (x *ImageReference) GetRepository() string

func (*ImageReference) GetTag

func (x *ImageReference) GetTag() string

func (*ImageReference) ProtoMessage

func (*ImageReference) ProtoMessage()

func (*ImageReference) ProtoReflect

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

func (*ImageReference) Reset

func (x *ImageReference) Reset()

func (*ImageReference) String

func (x *ImageReference) String() string

type InfoRequest

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

InfoRequest is empty - plugins return metadata unconditionally.

func (*InfoRequest) Descriptor deprecated

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

Deprecated: Use InfoRequest.ProtoReflect.Descriptor instead.

func (*InfoRequest) ProtoMessage

func (*InfoRequest) ProtoMessage()

func (*InfoRequest) ProtoReflect

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

func (*InfoRequest) Reset

func (x *InfoRequest) Reset()

func (*InfoRequest) String

func (x *InfoRequest) String() string

type InfoResponse

type InfoResponse struct {

	// Info describes the extractor.
	Info *ExtractorInfo `protobuf:"bytes,1,opt,name=info,proto3" json:"info,omitempty"`
	// contains filtered or unexported fields
}

InfoResponse contains extractor metadata.

func (*InfoResponse) Descriptor deprecated

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

Deprecated: Use InfoResponse.ProtoReflect.Descriptor instead.

func (*InfoResponse) GetInfo

func (x *InfoResponse) GetInfo() *ExtractorInfo

func (*InfoResponse) ProtoMessage

func (*InfoResponse) ProtoMessage()

func (*InfoResponse) ProtoReflect

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

func (*InfoResponse) Reset

func (x *InfoResponse) Reset()

func (*InfoResponse) String

func (x *InfoResponse) String() string

type InventoryStats

type InventoryStats struct {

	// TotalPackages is the total count of packages.
	TotalPackages int32 `protobuf:"varint,1,opt,name=total_packages,json=totalPackages,proto3" json:"total_packages,omitempty"`
	// DirectPackages is the count of direct dependencies.
	DirectPackages int32 `protobuf:"varint,2,opt,name=direct_packages,json=directPackages,proto3" json:"direct_packages,omitempty"`
	// TransitivePackages is the count of transitive dependencies.
	TransitivePackages int32 `protobuf:"varint,3,opt,name=transitive_packages,json=transitivePackages,proto3" json:"transitive_packages,omitempty"`
	// ByEcosystem maps ecosystem names to package counts.
	ByEcosystem map[string]int32 `` /* 169-byte string literal not displayed */
	// DurationMs is the collection time in milliseconds.
	DurationMs int64 `protobuf:"varint,5,opt,name=duration_ms,json=durationMs,proto3" json:"duration_ms,omitempty"`
	// contains filtered or unexported fields
}

InventoryStats provides statistics about the collection.

func (*InventoryStats) Descriptor deprecated

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

Deprecated: Use InventoryStats.ProtoReflect.Descriptor instead.

func (*InventoryStats) GetByEcosystem

func (x *InventoryStats) GetByEcosystem() map[string]int32

func (*InventoryStats) GetDirectPackages

func (x *InventoryStats) GetDirectPackages() int32

func (*InventoryStats) GetDurationMs

func (x *InventoryStats) GetDurationMs() int64

func (*InventoryStats) GetTotalPackages

func (x *InventoryStats) GetTotalPackages() int32

func (*InventoryStats) GetTransitivePackages

func (x *InventoryStats) GetTransitivePackages() int32

func (*InventoryStats) ProtoMessage

func (*InventoryStats) ProtoMessage()

func (*InventoryStats) ProtoReflect

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

func (*InventoryStats) Reset

func (x *InventoryStats) Reset()

func (*InventoryStats) String

func (x *InventoryStats) String() string

type ListExtractorsRequest

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

ListExtractorsRequest is empty as no parameters are needed.

func (*ListExtractorsRequest) Descriptor deprecated

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

Deprecated: Use ListExtractorsRequest.ProtoReflect.Descriptor instead.

func (*ListExtractorsRequest) ProtoMessage

func (*ListExtractorsRequest) ProtoMessage()

func (*ListExtractorsRequest) ProtoReflect

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

func (*ListExtractorsRequest) Reset

func (x *ListExtractorsRequest) Reset()

func (*ListExtractorsRequest) String

func (x *ListExtractorsRequest) String() string

type ListExtractorsResponse

type ListExtractorsResponse struct {

	// Extractors lists all available inventory extractors.
	Extractors []*ExtractorInfo `protobuf:"bytes,1,rep,name=extractors,proto3" json:"extractors,omitempty"`
	// contains filtered or unexported fields
}

ListExtractorsResponse contains available extractors.

func (*ListExtractorsResponse) Descriptor deprecated

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

Deprecated: Use ListExtractorsResponse.ProtoReflect.Descriptor instead.

func (*ListExtractorsResponse) GetExtractors

func (x *ListExtractorsResponse) GetExtractors() []*ExtractorInfo

func (*ListExtractorsResponse) ProtoMessage

func (*ListExtractorsResponse) ProtoMessage()

func (*ListExtractorsResponse) ProtoReflect

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

func (*ListExtractorsResponse) Reset

func (x *ListExtractorsResponse) Reset()

func (*ListExtractorsResponse) String

func (x *ListExtractorsResponse) String() string

type RegisterExtractorRequest

type RegisterExtractorRequest struct {

	// Info describes the extractor being registered.
	Info *ExtractorInfo `protobuf:"bytes,1,opt,name=info,proto3" json:"info,omitempty"`
	// PluginAddress is the pluginrpc address for the extractor.
	// Example: "unix:///tmp/my-extractor.sock"
	PluginAddress string `protobuf:"bytes,2,opt,name=plugin_address,json=pluginAddress,proto3" json:"plugin_address,omitempty"`
	// contains filtered or unexported fields
}

RegisterExtractorRequest registers a custom extractor plugin.

func (*RegisterExtractorRequest) Descriptor deprecated

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

Deprecated: Use RegisterExtractorRequest.ProtoReflect.Descriptor instead.

func (*RegisterExtractorRequest) GetInfo

func (*RegisterExtractorRequest) GetPluginAddress

func (x *RegisterExtractorRequest) GetPluginAddress() string

func (*RegisterExtractorRequest) ProtoMessage

func (*RegisterExtractorRequest) ProtoMessage()

func (*RegisterExtractorRequest) ProtoReflect

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

func (*RegisterExtractorRequest) Reset

func (x *RegisterExtractorRequest) Reset()

func (*RegisterExtractorRequest) String

func (x *RegisterExtractorRequest) String() string

type RegisterExtractorResponse

type RegisterExtractorResponse struct {

	// Registered is true if registration succeeded.
	Registered bool `protobuf:"varint,1,opt,name=registered,proto3" json:"registered,omitempty"`
	// contains filtered or unexported fields
}

RegisterExtractorResponse confirms registration.

func (*RegisterExtractorResponse) Descriptor deprecated

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

Deprecated: Use RegisterExtractorResponse.ProtoReflect.Descriptor instead.

func (*RegisterExtractorResponse) GetRegistered

func (x *RegisterExtractorResponse) GetRegistered() bool

func (*RegisterExtractorResponse) ProtoMessage

func (*RegisterExtractorResponse) ProtoMessage()

func (*RegisterExtractorResponse) ProtoReflect

func (*RegisterExtractorResponse) Reset

func (x *RegisterExtractorResponse) Reset()

func (*RegisterExtractorResponse) String

func (x *RegisterExtractorResponse) String() string

type UnregisterExtractorRequest

type UnregisterExtractorRequest struct {

	// Name is the extractor identifier to unregister.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

UnregisterExtractorRequest identifies the plugin to remove.

func (*UnregisterExtractorRequest) Descriptor deprecated

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

Deprecated: Use UnregisterExtractorRequest.ProtoReflect.Descriptor instead.

func (*UnregisterExtractorRequest) GetName

func (x *UnregisterExtractorRequest) GetName() string

func (*UnregisterExtractorRequest) ProtoMessage

func (*UnregisterExtractorRequest) ProtoMessage()

func (*UnregisterExtractorRequest) ProtoReflect

func (*UnregisterExtractorRequest) Reset

func (x *UnregisterExtractorRequest) Reset()

func (*UnregisterExtractorRequest) String

func (x *UnregisterExtractorRequest) String() string

type UnregisterExtractorResponse

type UnregisterExtractorResponse struct {

	// Unregistered is true if the plugin was found and removed.
	Unregistered bool `protobuf:"varint,1,opt,name=unregistered,proto3" json:"unregistered,omitempty"`
	// contains filtered or unexported fields
}

UnregisterExtractorResponse confirms removal.

func (*UnregisterExtractorResponse) Descriptor deprecated

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

Deprecated: Use UnregisterExtractorResponse.ProtoReflect.Descriptor instead.

func (*UnregisterExtractorResponse) GetUnregistered

func (x *UnregisterExtractorResponse) GetUnregistered() bool

func (*UnregisterExtractorResponse) ProtoMessage

func (*UnregisterExtractorResponse) ProtoMessage()

func (*UnregisterExtractorResponse) ProtoReflect

func (*UnregisterExtractorResponse) Reset

func (x *UnregisterExtractorResponse) Reset()

func (*UnregisterExtractorResponse) String

func (x *UnregisterExtractorResponse) String() string

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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