proto

package
v0.3.310 Latest Latest
Warning

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

 Go to latest Published: Nov 3, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	SBOMScanner_CreateSBOM_FullMethodName         = "/sbomscanner.v1.SBOMScanner/CreateSBOM"
	SBOMScanner_ScanHostFilesystem_FullMethodName = "/sbomscanner.v1.SBOMScanner/ScanHostFilesystem"
	SBOMScanner_Health_FullMethodName             = "/sbomscanner.v1.SBOMScanner/Health"
)

Variables

View Source 
var File_scanner_proto protoreflect.FileDescriptor
View Source 
var SBOMScanner_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "sbomscanner.v1.SBOMScanner",
	HandlerType: (*SBOMScannerServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateSBOM",
			Handler:    _SBOMScanner_CreateSBOM_Handler,
		},
		{
			MethodName: "ScanHostFilesystem",
			Handler:    _SBOMScanner_ScanHostFilesystem_Handler,
		},
		{
			MethodName: "Health",
			Handler:    _SBOMScanner_Health_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "scanner.proto",
}

SBOMScanner_ServiceDesc is the grpc.ServiceDesc for SBOMScanner service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterSBOMScannerServer 

func RegisterSBOMScannerServer(s grpc.ServiceRegistrar, srv SBOMScannerServer)

Types

type CreateSBOMRequest 

type CreateSBOMRequest struct {
	ImageId             string   `protobuf:"bytes,1,opt,name=image_id,json=imageId,proto3" json:"image_id,omitempty"`
	ImageTag            string   `protobuf:"bytes,2,opt,name=image_tag,json=imageTag,proto3" json:"image_tag,omitempty"`
	LayerPaths          []string `protobuf:"bytes,3,rep,name=layer_paths,json=layerPaths,proto3" json:"layer_paths,omitempty"`
	ImageStatus         []byte   `protobuf:"bytes,4,opt,name=image_status,json=imageStatus,proto3" json:"image_status,omitempty"`
	MaxImageSize        int64    `protobuf:"varint,5,opt,name=max_image_size,json=maxImageSize,proto3" json:"max_image_size,omitempty"`
	MaxSbomSize         int32    `protobuf:"varint,6,opt,name=max_sbom_size,json=maxSbomSize,proto3" json:"max_sbom_size,omitempty"`
	EnableEmbeddedSboms bool     `protobuf:"varint,7,opt,name=enable_embedded_sboms,json=enableEmbeddedSboms,proto3" json:"enable_embedded_sboms,omitempty"`
	TimeoutSeconds      int64    `protobuf:"varint,8,opt,name=timeout_seconds,json=timeoutSeconds,proto3" json:"timeout_seconds,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateSBOMRequest) Descriptor deprecated 

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

Deprecated: Use CreateSBOMRequest.ProtoReflect.Descriptor instead.

func (*CreateSBOMRequest) GetEnableEmbeddedSboms 

func (x *CreateSBOMRequest) GetEnableEmbeddedSboms() bool

func (*CreateSBOMRequest) GetImageId 

func (x *CreateSBOMRequest) GetImageId() string

func (*CreateSBOMRequest) GetImageStatus 

func (x *CreateSBOMRequest) GetImageStatus() []byte

func (*CreateSBOMRequest) GetImageTag 

func (x *CreateSBOMRequest) GetImageTag() string

func (*CreateSBOMRequest) GetLayerPaths 

func (x *CreateSBOMRequest) GetLayerPaths() []string

func (*CreateSBOMRequest) GetMaxImageSize 

func (x *CreateSBOMRequest) GetMaxImageSize() int64

func (*CreateSBOMRequest) GetMaxSbomSize 

func (x *CreateSBOMRequest) GetMaxSbomSize() int32

func (*CreateSBOMRequest) GetTimeoutSeconds 

func (x *CreateSBOMRequest) GetTimeoutSeconds() int64

func (*CreateSBOMRequest) ProtoMessage 

func (*CreateSBOMRequest) ProtoMessage()

func (*CreateSBOMRequest) ProtoReflect 

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

func (*CreateSBOMRequest) Reset 

func (x *CreateSBOMRequest) Reset()

func (*CreateSBOMRequest) String 

func (x *CreateSBOMRequest) String() string

type CreateSBOMResponse 

type CreateSBOMResponse struct {
	SbomDocument []byte `protobuf:"bytes,1,opt,name=sbom_document,json=sbomDocument,proto3" json:"sbom_document,omitempty"`
	SbomSize     int64  `protobuf:"varint,2,opt,name=sbom_size,json=sbomSize,proto3" json:"sbom_size,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateSBOMResponse) Descriptor deprecated 

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

Deprecated: Use CreateSBOMResponse.ProtoReflect.Descriptor instead.

func (*CreateSBOMResponse) GetSbomDocument 

func (x *CreateSBOMResponse) GetSbomDocument() []byte

func (*CreateSBOMResponse) GetSbomSize 

func (x *CreateSBOMResponse) GetSbomSize() int64

func (*CreateSBOMResponse) ProtoMessage 

func (*CreateSBOMResponse) ProtoMessage()

func (*CreateSBOMResponse) ProtoReflect 

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

func (*CreateSBOMResponse) Reset 

func (x *CreateSBOMResponse) Reset()

func (*CreateSBOMResponse) String 

func (x *CreateSBOMResponse) String() string

type HealthRequest 

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

func (*HealthRequest) Descriptor deprecated 

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

Deprecated: Use HealthRequest.ProtoReflect.Descriptor instead.

func (*HealthRequest) ProtoMessage 

func (*HealthRequest) ProtoMessage()

func (*HealthRequest) ProtoReflect 

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

func (*HealthRequest) Reset 

func (x *HealthRequest) Reset()

func (*HealthRequest) String 

func (x *HealthRequest) String() string

type HealthResponse 

type HealthResponse struct {
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	Ready   bool   `protobuf:"varint,2,opt,name=ready,proto3" json:"ready,omitempty"`
	// contains filtered or unexported fields
}

func (*HealthResponse) Descriptor deprecated 

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

Deprecated: Use HealthResponse.ProtoReflect.Descriptor instead.

func (*HealthResponse) GetReady 

func (x *HealthResponse) GetReady() bool

func (*HealthResponse) GetVersion 

func (x *HealthResponse) GetVersion() string

func (*HealthResponse) ProtoMessage 

func (*HealthResponse) ProtoMessage()

func (*HealthResponse) ProtoReflect 

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

func (*HealthResponse) Reset 

func (x *HealthResponse) Reset()

func (*HealthResponse) String 

func (x *HealthResponse) String() string

type SBOMScannerClient 

type SBOMScannerClient interface {
	CreateSBOM(ctx context.Context, in *CreateSBOMRequest, opts ...grpc.CallOption) (*CreateSBOMResponse, error)
	ScanHostFilesystem(ctx context.Context, in *ScanHostFilesystemRequest, opts ...grpc.CallOption) (*ScanHostFilesystemResponse, error)
	Health(ctx context.Context, in *HealthRequest, opts ...grpc.CallOption) (*HealthResponse, error)
}

SBOMScannerClient is the client API for SBOMScanner service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewSBOMScannerClient 

func NewSBOMScannerClient(cc grpc.ClientConnInterface) SBOMScannerClient

type SBOMScannerServer 

type SBOMScannerServer interface {
	CreateSBOM(context.Context, *CreateSBOMRequest) (*CreateSBOMResponse, error)
	ScanHostFilesystem(context.Context, *ScanHostFilesystemRequest) (*ScanHostFilesystemResponse, error)
	Health(context.Context, *HealthRequest) (*HealthResponse, error)
	// contains filtered or unexported methods
}

SBOMScannerServer is the server API for SBOMScanner service. All implementations must embed UnimplementedSBOMScannerServer for forward compatibility.

type ScanHostFilesystemRequest added in v0.3.241 

type ScanHostFilesystemRequest struct {

	// source_name is the Syft source alias name. It is not derivable inside the
	// sidecar: it is the host SBOM's CR name, derived from the host identity that
	// only node-agent resolves, and it feeds source.Alias, which Syft uses to
	// derive the artifact's stable ID.
	SourceName          string `protobuf:"bytes,1,opt,name=source_name,json=sourceName,proto3" json:"source_name,omitempty"`
	EnableEmbeddedSboms bool   `protobuf:"varint,2,opt,name=enable_embedded_sboms,json=enableEmbeddedSboms,proto3" json:"enable_embedded_sboms,omitempty"`
	TimeoutSeconds      int64  `protobuf:"varint,3,opt,name=timeout_seconds,json=timeoutSeconds,proto3" json:"timeout_seconds,omitempty"`
	// contains filtered or unexported fields
}

ScanHostFilesystemRequest is deliberately minimal.

There is no root_path: the sidecar resolves (and validates) its own HOST_ROOT rather than trusting a path supplied by a peer container that resolved a different env var. There are no exclude_globs: the host exclusion set is compiled in (syftutil.HostExclusionPatterns) and shared by both processes. There is no max_sbom_size: the size gate stays entirely client-side, so the host SBOM state machine behaves identically regardless of which path produced the document.

func (*ScanHostFilesystemRequest) Descriptor deprecated added in v0.3.241 

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

Deprecated: Use ScanHostFilesystemRequest.ProtoReflect.Descriptor instead.

func (*ScanHostFilesystemRequest) GetEnableEmbeddedSboms added in v0.3.241 

func (x *ScanHostFilesystemRequest) GetEnableEmbeddedSboms() bool

func (*ScanHostFilesystemRequest) GetSourceName added in v0.3.241 

func (x *ScanHostFilesystemRequest) GetSourceName() string

func (*ScanHostFilesystemRequest) GetTimeoutSeconds added in v0.3.241 

func (x *ScanHostFilesystemRequest) GetTimeoutSeconds() int64

func (*ScanHostFilesystemRequest) ProtoMessage added in v0.3.241 

func (*ScanHostFilesystemRequest) ProtoMessage()

func (*ScanHostFilesystemRequest) ProtoReflect added in v0.3.241 

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

func (*ScanHostFilesystemRequest) Reset added in v0.3.241 

func (x *ScanHostFilesystemRequest) Reset()

func (*ScanHostFilesystemRequest) String added in v0.3.241 

func (x *ScanHostFilesystemRequest) String() string

type ScanHostFilesystemResponse added in v0.3.241 

type ScanHostFilesystemResponse struct {
	SbomDocument []byte `protobuf:"bytes,1,opt,name=sbom_document,json=sbomDocument,proto3" json:"sbom_document,omitempty"`
	SbomSize     int64  `protobuf:"varint,2,opt,name=sbom_size,json=sbomSize,proto3" json:"sbom_size,omitempty"`
	// contains filtered or unexported fields
}

ScanHostFilesystemResponse carries no tool_version: node-agent's and the sidecar's Syft version are the same expression resolved from the same go.mod, so Spec.Metadata.Tool.Version is stamped from node-agent's own version unconditionally on both paths.

func (*ScanHostFilesystemResponse) Descriptor deprecated added in v0.3.241 

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

Deprecated: Use ScanHostFilesystemResponse.ProtoReflect.Descriptor instead.

func (*ScanHostFilesystemResponse) GetSbomDocument added in v0.3.241 

func (x *ScanHostFilesystemResponse) GetSbomDocument() []byte

func (*ScanHostFilesystemResponse) GetSbomSize added in v0.3.241 

func (x *ScanHostFilesystemResponse) GetSbomSize() int64

func (*ScanHostFilesystemResponse) ProtoMessage added in v0.3.241 

func (*ScanHostFilesystemResponse) ProtoMessage()

func (*ScanHostFilesystemResponse) ProtoReflect added in v0.3.241 

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

func (*ScanHostFilesystemResponse) Reset added in v0.3.241 

func (x *ScanHostFilesystemResponse) Reset()

func (*ScanHostFilesystemResponse) String added in v0.3.241 

func (x *ScanHostFilesystemResponse) String() string

type UnimplementedSBOMScannerServer 

type UnimplementedSBOMScannerServer struct{}

UnimplementedSBOMScannerServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedSBOMScannerServer) CreateSBOM 

func (UnimplementedSBOMScannerServer) CreateSBOM(context.Context, *CreateSBOMRequest) (*CreateSBOMResponse, error)

func (UnimplementedSBOMScannerServer) Health 

func (UnimplementedSBOMScannerServer) Health(context.Context, *HealthRequest) (*HealthResponse, error)

func (UnimplementedSBOMScannerServer) ScanHostFilesystem added in v0.3.241 

func (UnimplementedSBOMScannerServer) ScanHostFilesystem(context.Context, *ScanHostFilesystemRequest) (*ScanHostFilesystemResponse, error)

type UnsafeSBOMScannerServer 

type UnsafeSBOMScannerServer interface {
	// contains filtered or unexported methods
}

UnsafeSBOMScannerServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SBOMScannerServer will result in compilation errors.

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.