internal

package
v0.2.1 Latest Latest
Warning

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

 Go to latest Published: Oct 13, 2023 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	System_name = map[int32]string{
		0: "SYSTEM_UNSPECIFIED",
		1: "GO",
		3: "NPM",
		4: "CARGO",
		6: "MAVEN",
		7: "PYPI",
		8: "NUGET",
	}
	System_value = map[string]int32{
		"SYSTEM_UNSPECIFIED": 0,
		"GO":                 1,
		"NPM":                3,
		"CARGO":              4,
		"MAVEN":              6,
		"PYPI":               7,
		"NUGET":              8,
	}
)

Enum value maps for System.

View Source 
var (
	HashType_name = map[int32]string{
		0: "HASH_TYPE_UNSPECIFIED",
		1: "MD5",
		2: "SHA1",
		3: "SHA256",
		4: "SHA512",
	}
	HashType_value = map[string]int32{
		"HASH_TYPE_UNSPECIFIED": 0,
		"MD5":                   1,
		"SHA1":                  2,
		"SHA256":                3,
		"SHA512":                4,
	}
)

Enum value maps for HashType.

View Source 
var File_pkg_handler_collector_deps_dev_internal_api_proto protoreflect.FileDescriptor
View Source 
var Insights_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "deps_dev.v3alpha.Insights",
	HandlerType: (*InsightsServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetPackage",
			Handler:    _Insights_GetPackage_Handler,
		},
		{
			MethodName: "GetVersion",
			Handler:    _Insights_GetVersion_Handler,
		},
		{
			MethodName: "GetDependencies",
			Handler:    _Insights_GetDependencies_Handler,
		},
		{
			MethodName: "GetProject",
			Handler:    _Insights_GetProject_Handler,
		},
		{
			MethodName: "GetAdvisory",
			Handler:    _Insights_GetAdvisory_Handler,
		},
		{
			MethodName: "Query",
			Handler:    _Insights_Query_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "pkg/handler/collector/deps_dev/internal/api.proto",
}

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

Functions

func RegisterInsightsServer 

func RegisterInsightsServer(s grpc.ServiceRegistrar, srv InsightsServer)

Types

type Advisory 

type Advisory struct {

	// The identifier for the security advisory. Note that this may differ from
	// the identifier in the request, due to canonicalization.
	AdvisoryKey *AdvisoryKey `protobuf:"bytes,1,opt,name=advisory_key,json=advisoryKey,proto3" json:"advisory_key,omitempty"`
	// The URL of the security advisory.
	Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// A brief human-readable description.
	Title string `protobuf:"bytes,3,opt,name=title,proto3" json:"title,omitempty"`
	// Other identifiers used for the advisory, including CVEs.
	Aliases []string `protobuf:"bytes,4,rep,name=aliases,proto3" json:"aliases,omitempty"`
	// The severity of the advisory as a CVSS v3 score in the range [0,10].
	// A higher score represents greater severity.
	Cvss3Score float32 `protobuf:"fixed32,5,opt,name=cvss3_score,json=cvss3Score,proto3" json:"cvss3_score,omitempty"`
	// The severity of the advisory as a CVSS v3 vector string.
	Cvss3Vector string `protobuf:"bytes,6,opt,name=cvss3_vector,json=cvss3Vector,proto3" json:"cvss3_vector,omitempty"`
	// contains filtered or unexported fields
}

Advisory holds information about a security advisory hosted by OSV.

func (*Advisory) Descriptor deprecated 

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

Deprecated: Use Advisory.ProtoReflect.Descriptor instead.

func (*Advisory) GetAdvisoryKey 

func (x *Advisory) GetAdvisoryKey() *AdvisoryKey

func (*Advisory) GetAliases 

func (x *Advisory) GetAliases() []string

func (*Advisory) GetCvss3Score 

func (x *Advisory) GetCvss3Score() float32

func (*Advisory) GetCvss3Vector 

func (x *Advisory) GetCvss3Vector() string

func (*Advisory) GetTitle 

func (x *Advisory) GetTitle() string

func (*Advisory) GetUrl 

func (x *Advisory) GetUrl() string

func (*Advisory) ProtoMessage 

func (*Advisory) ProtoMessage()

func (*Advisory) ProtoReflect 

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

func (*Advisory) Reset 

func (x *Advisory) Reset()

func (*Advisory) String 

func (x *Advisory) String() string

type AdvisoryKey 

type AdvisoryKey struct {

	// The OSV identifier for the security advisory.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

AdvisoryKey identifies a security advisory.

func (*AdvisoryKey) Descriptor deprecated 

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

Deprecated: Use AdvisoryKey.ProtoReflect.Descriptor instead.

func (*AdvisoryKey) GetId 

func (x *AdvisoryKey) GetId() string

func (*AdvisoryKey) ProtoMessage 

func (*AdvisoryKey) ProtoMessage()

func (*AdvisoryKey) ProtoReflect 

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

func (*AdvisoryKey) Reset 

func (x *AdvisoryKey) Reset()

func (*AdvisoryKey) String 

func (x *AdvisoryKey) String() string

type Dependencies 

type Dependencies struct {

	// The nodes of the dependency graph. The first node is the root of the graph.
	Nodes []*Dependencies_Node `protobuf:"bytes,1,rep,name=nodes,proto3" json:"nodes,omitempty"`
	// The edges of the dependency graph.
	Edges []*Dependencies_Edge `protobuf:"bytes,2,rep,name=edges,proto3" json:"edges,omitempty"`
	// Any error associated with the dependency graph that is not specific to a
	// node. An error here may imply the graph as a whole is incorrect.
	// This error message has no defined format and is intended for human
	// consumption.
	Error string `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

Dependencies holds a resolved dependency graph for a package version.

The dependency graph should be similar to one produced by installing the package version on a generic 64-bit Linux system, with no other dependencies present. The precise meaning of this varies from system to system.

func (*Dependencies) Descriptor deprecated 

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

Deprecated: Use Dependencies.ProtoReflect.Descriptor instead.

func (*Dependencies) GetEdges 

func (x *Dependencies) GetEdges() []*Dependencies_Edge

func (*Dependencies) GetError 

func (x *Dependencies) GetError() string

func (*Dependencies) GetNodes 

func (x *Dependencies) GetNodes() []*Dependencies_Node

func (*Dependencies) ProtoMessage 

func (*Dependencies) ProtoMessage()

func (*Dependencies) ProtoReflect 

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

func (*Dependencies) Reset 

func (x *Dependencies) Reset()

func (*Dependencies) String 

func (x *Dependencies) String() string

type Dependencies_Edge 

type Dependencies_Edge struct {

	// The node declaring the dependency, specified as an index into the list of
	// nodes.
	FromNode uint32 `protobuf:"varint,1,opt,name=from_node,json=fromNode,proto3" json:"from_node,omitempty"`
	// The node resolving the dependency, specified as an index into the list of
	// nodes.
	ToNode uint32 `protobuf:"varint,2,opt,name=to_node,json=toNode,proto3" json:"to_node,omitempty"`
	// The requirement resolved by this edge, as declared by the "from" node.
	// The meaning of this field is system-specific. As an example, in npm, the
	// requirement "^1.0.0" may be resolved by the version "1.2.3".
	Requirement string `protobuf:"bytes,3,opt,name=requirement,proto3" json:"requirement,omitempty"`
	// contains filtered or unexported fields
}

Edge represents a directed edge in a resolved dependency graph: a dependency relation between two nodes.

func (*Dependencies_Edge) Descriptor deprecated 

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

Deprecated: Use Dependencies_Edge.ProtoReflect.Descriptor instead.

func (*Dependencies_Edge) GetFromNode 

func (x *Dependencies_Edge) GetFromNode() uint32

func (*Dependencies_Edge) GetRequirement 

func (x *Dependencies_Edge) GetRequirement() string

func (*Dependencies_Edge) GetToNode 

func (x *Dependencies_Edge) GetToNode() uint32

func (*Dependencies_Edge) ProtoMessage 

func (*Dependencies_Edge) ProtoMessage()

func (*Dependencies_Edge) ProtoReflect 

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

func (*Dependencies_Edge) Reset 

func (x *Dependencies_Edge) Reset()

func (*Dependencies_Edge) String 

func (x *Dependencies_Edge) String() string

type Dependencies_Node 

type Dependencies_Node struct {

	// The package version represented by this node. Note that the package and
	// version name may differ from the names in the request, if provided, due
	// to canonicalization.
	//
	// For some systems, a graph may contain multiple nodes for the same
	// package version.
	VersionKey *VersionKey `protobuf:"bytes,1,opt,name=version_key,json=versionKey,proto3" json:"version_key,omitempty"`
	// If true, this is a bundled dependency. For bundled dependencies, the
	// package name in the version key encodes how the dependency is bundled.
	//
	// As an example, a bundled dependency with a name like "a>1.2.3>b>c" is
	// part of the dependency graph of package "a" at version "1.2.3", and has
	// the local name "c". It may or may not be the same as a package with the
	// global name "c".
	Bundled bool `protobuf:"varint,2,opt,name=bundled,proto3" json:"bundled,omitempty"`
	// Errors associated with this node of the graph, such as an unresolved
	// dependency requirement. An error on a node may imply the graph as a
	// whole is incorrect. These error messages have no defined format and are
	// intended for human consumption.
	Errors []string `protobuf:"bytes,3,rep,name=errors,proto3" json:"errors,omitempty"`
	// contains filtered or unexported fields
}

Node represents a node in a resolved dependency graph.

func (*Dependencies_Node) Descriptor deprecated 

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

Deprecated: Use Dependencies_Node.ProtoReflect.Descriptor instead.

func (*Dependencies_Node) GetBundled 

func (x *Dependencies_Node) GetBundled() bool

func (*Dependencies_Node) GetErrors 

func (x *Dependencies_Node) GetErrors() []string

func (*Dependencies_Node) GetVersionKey 

func (x *Dependencies_Node) GetVersionKey() *VersionKey

func (*Dependencies_Node) ProtoMessage 

func (*Dependencies_Node) ProtoMessage()

func (*Dependencies_Node) ProtoReflect 

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

func (*Dependencies_Node) Reset 

func (x *Dependencies_Node) Reset()

func (*Dependencies_Node) String 

func (x *Dependencies_Node) String() string

type GetAdvisoryRequest 

type GetAdvisoryRequest struct {
	AdvisoryKey *AdvisoryKey `protobuf:"bytes,1,opt,name=advisory_key,json=advisoryKey,proto3" json:"advisory_key,omitempty"`
	// contains filtered or unexported fields
}

GetAdvisoryRequest identifies a security advisory for which to return information.

func (*GetAdvisoryRequest) Descriptor deprecated 

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

Deprecated: Use GetAdvisoryRequest.ProtoReflect.Descriptor instead.

func (*GetAdvisoryRequest) GetAdvisoryKey 

func (x *GetAdvisoryRequest) GetAdvisoryKey() *AdvisoryKey

func (*GetAdvisoryRequest) ProtoMessage 

func (*GetAdvisoryRequest) ProtoMessage()

func (*GetAdvisoryRequest) ProtoReflect 

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

func (*GetAdvisoryRequest) Reset 

func (x *GetAdvisoryRequest) Reset()

func (*GetAdvisoryRequest) String 

func (x *GetAdvisoryRequest) String() string

type GetDependenciesRequest 

type GetDependenciesRequest struct {
	VersionKey *VersionKey `protobuf:"bytes,1,opt,name=version_key,json=versionKey,proto3" json:"version_key,omitempty"`
	// contains filtered or unexported fields
}

GetDependenciesRequest identifies a package version for which to return dependencies.

func (*GetDependenciesRequest) Descriptor deprecated 

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

Deprecated: Use GetDependenciesRequest.ProtoReflect.Descriptor instead.

func (*GetDependenciesRequest) GetVersionKey 

func (x *GetDependenciesRequest) GetVersionKey() *VersionKey

func (*GetDependenciesRequest) ProtoMessage 

func (*GetDependenciesRequest) ProtoMessage()

func (*GetDependenciesRequest) ProtoReflect 

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

func (*GetDependenciesRequest) Reset 

func (x *GetDependenciesRequest) Reset()

func (*GetDependenciesRequest) String 

func (x *GetDependenciesRequest) String() string

type GetPackageRequest 

type GetPackageRequest struct {
	PackageKey *PackageKey `protobuf:"bytes,1,opt,name=package_key,json=packageKey,proto3" json:"package_key,omitempty"`
	// contains filtered or unexported fields
}

GetPackageRequest identifies a package for which to return information.

func (*GetPackageRequest) Descriptor deprecated 

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

Deprecated: Use GetPackageRequest.ProtoReflect.Descriptor instead.

func (*GetPackageRequest) GetPackageKey 

func (x *GetPackageRequest) GetPackageKey() *PackageKey

func (*GetPackageRequest) ProtoMessage 

func (*GetPackageRequest) ProtoMessage()

func (*GetPackageRequest) ProtoReflect 

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

func (*GetPackageRequest) Reset 

func (x *GetPackageRequest) Reset()

func (*GetPackageRequest) String 

func (x *GetPackageRequest) String() string

type GetProjectRequest 

type GetProjectRequest struct {
	ProjectKey *ProjectKey `protobuf:"bytes,1,opt,name=project_key,json=projectKey,proto3" json:"project_key,omitempty"`
	// contains filtered or unexported fields
}

GetProjectRequest identifies a project for which to return information.

func (*GetProjectRequest) Descriptor deprecated 

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

Deprecated: Use GetProjectRequest.ProtoReflect.Descriptor instead.

func (*GetProjectRequest) GetProjectKey 

func (x *GetProjectRequest) GetProjectKey() *ProjectKey

func (*GetProjectRequest) ProtoMessage 

func (*GetProjectRequest) ProtoMessage()

func (*GetProjectRequest) ProtoReflect 

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

func (*GetProjectRequest) Reset 

func (x *GetProjectRequest) Reset()

func (*GetProjectRequest) String 

func (x *GetProjectRequest) String() string

type GetVersionRequest 

type GetVersionRequest struct {
	VersionKey *VersionKey `protobuf:"bytes,1,opt,name=version_key,json=versionKey,proto3" json:"version_key,omitempty"`
	// contains filtered or unexported fields
}

GetVersionRequest identifies a package version for which to return information.

func (*GetVersionRequest) Descriptor deprecated 

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

Deprecated: Use GetVersionRequest.ProtoReflect.Descriptor instead.

func (*GetVersionRequest) GetVersionKey 

func (x *GetVersionRequest) GetVersionKey() *VersionKey

func (*GetVersionRequest) ProtoMessage 

func (*GetVersionRequest) ProtoMessage()

func (*GetVersionRequest) ProtoReflect 

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

func (*GetVersionRequest) Reset 

func (x *GetVersionRequest) Reset()

func (*GetVersionRequest) String 

func (x *GetVersionRequest) String() string

type Hash 

type Hash struct {

	// The function used to produce this hash.
	Type HashType `protobuf:"varint,1,opt,name=type,proto3,enum=deps_dev.v3alpha.HashType" json:"type,omitempty"`
	// A hash value.
	Value []byte `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Hash represents the output of a hash function. These messages are used to identify package version artifacts by content hash.

func (*Hash) Descriptor deprecated 

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

Deprecated: Use Hash.ProtoReflect.Descriptor instead.

func (*Hash) GetType 

func (x *Hash) GetType() HashType

func (*Hash) GetValue 

func (x *Hash) GetValue() []byte

func (*Hash) ProtoMessage 

func (*Hash) ProtoMessage()

func (*Hash) ProtoReflect 

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

func (*Hash) Reset 

func (x *Hash) Reset()

func (*Hash) String 

func (x *Hash) String() string

type HashType 

type HashType int32

HashType identifies a function used to produce a hash. 

const (
	HashType_HASH_TYPE_UNSPECIFIED HashType = 0
	HashType_MD5                   HashType = 1
	HashType_SHA1                  HashType = 2
	HashType_SHA256                HashType = 3
	HashType_SHA512                HashType = 4
)

func (HashType) Descriptor 

func (HashType) Descriptor() protoreflect.EnumDescriptor

func (HashType) Enum 

func (x HashType) Enum() *HashType

func (HashType) EnumDescriptor deprecated 

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

Deprecated: Use HashType.Descriptor instead.

func (HashType) Number 

func (x HashType) Number() protoreflect.EnumNumber

func (HashType) String 

func (x HashType) String() string

func (HashType) Type 

func (HashType) Type() protoreflect.EnumType

type InsightsClient 

type InsightsClient interface {
	// GetPackage returns information about a package, including a list of its
	// available versions, with the default version marked if known.
	GetPackage(ctx context.Context, in *GetPackageRequest, opts ...grpc.CallOption) (*Package, error)
	// GetVersion returns information about a specific package version, including
	// its licenses and any security advisories known to affect it.
	GetVersion(ctx context.Context, in *GetVersionRequest, opts ...grpc.CallOption) (*Version, error)
	// GetDependencies returns a resolved dependency graph for the given package
	// version.
	//
	// The dependency graph should be similar to one produced by installing the
	// package version on a generic 64-bit Linux system, with no other
	// dependencies present. The precise meaning of this varies from system to
	// system.
	GetDependencies(ctx context.Context, in *GetDependenciesRequest, opts ...grpc.CallOption) (*Dependencies, error)
	// GetProject returns information about projects hosted by GitHub, GitLab, or
	// BitBucket, when known to us.
	GetProject(ctx context.Context, in *GetProjectRequest, opts ...grpc.CallOption) (*Project, error)
	// GetAdvisory returns information about security advisories hosted by OSV.
	GetAdvisory(ctx context.Context, in *GetAdvisoryRequest, opts ...grpc.CallOption) (*Advisory, error)
	// Query returns information about multiple package versions, which can be
	// specified by name, content hash, or both.
	//
	// It is typical for hash queries to return many results; hashes are matched
	// against multiple artifacts that comprise package versions, and any given
	// artifact may appear in many package versions.
	Query(ctx context.Context, in *QueryRequest, opts ...grpc.CallOption) (*QueryResult, error)
}

InsightsClient is the client API for Insights 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 NewInsightsClient 

func NewInsightsClient(cc grpc.ClientConnInterface) InsightsClient

type InsightsServer 

type InsightsServer interface {
	// GetPackage returns information about a package, including a list of its
	// available versions, with the default version marked if known.
	GetPackage(context.Context, *GetPackageRequest) (*Package, error)
	// GetVersion returns information about a specific package version, including
	// its licenses and any security advisories known to affect it.
	GetVersion(context.Context, *GetVersionRequest) (*Version, error)
	// GetDependencies returns a resolved dependency graph for the given package
	// version.
	//
	// The dependency graph should be similar to one produced by installing the
	// package version on a generic 64-bit Linux system, with no other
	// dependencies present. The precise meaning of this varies from system to
	// system.
	GetDependencies(context.Context, *GetDependenciesRequest) (*Dependencies, error)
	// GetProject returns information about projects hosted by GitHub, GitLab, or
	// BitBucket, when known to us.
	GetProject(context.Context, *GetProjectRequest) (*Project, error)
	// GetAdvisory returns information about security advisories hosted by OSV.
	GetAdvisory(context.Context, *GetAdvisoryRequest) (*Advisory, error)
	// Query returns information about multiple package versions, which can be
	// specified by name, content hash, or both.
	//
	// It is typical for hash queries to return many results; hashes are matched
	// against multiple artifacts that comprise package versions, and any given
	// artifact may appear in many package versions.
	Query(context.Context, *QueryRequest) (*QueryResult, error)
	// contains filtered or unexported methods
}

InsightsServer is the server API for Insights service. All implementations must embed UnimplementedInsightsServer for forward compatibility 

type Link struct {

	// A label describing the resource that the link points to.
	Label string `protobuf:"bytes,1,opt,name=label,proto3" json:"label,omitempty"`
	// The URL of the link.
	Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// contains filtered or unexported fields
}

Link represents a link declared by or derived from package version metadata, to an external web resource such as a homepage or source code repository.

func (*Link) Descriptor deprecated 

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

Deprecated: Use Link.ProtoReflect.Descriptor instead.

func (*Link) GetLabel 

func (x *Link) GetLabel() string

func (*Link) GetUrl 

func (x *Link) GetUrl() string

func (*Link) ProtoMessage 

func (*Link) ProtoMessage()

func (*Link) ProtoReflect 

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

func (*Link) Reset 

func (x *Link) Reset()

func (*Link) String 

func (x *Link) String() string

type Package 

type Package struct {

	// The name of the package. Note that it may differ from the name in the
	// request, due to canonicalization.
	PackageKey *PackageKey `protobuf:"bytes,1,opt,name=package_key,json=packageKey,proto3" json:"package_key,omitempty"`
	// The available versions of the package.
	Versions []*Package_Version `protobuf:"bytes,2,rep,name=versions,proto3" json:"versions,omitempty"`
	// contains filtered or unexported fields
}

Package holds information about a package, including a list of its available versions, with the default version marked if known.

func (*Package) Descriptor deprecated 

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

Deprecated: Use Package.ProtoReflect.Descriptor instead.

func (*Package) GetPackageKey 

func (x *Package) GetPackageKey() *PackageKey

func (*Package) GetVersions 

func (x *Package) GetVersions() []*Package_Version

func (*Package) ProtoMessage 

func (*Package) ProtoMessage()

func (*Package) ProtoReflect 

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

func (*Package) Reset 

func (x *Package) Reset()

func (*Package) String 

func (x *Package) String() string

type PackageKey 

type PackageKey struct {

	// The package management system containing the package.
	System System `protobuf:"varint,1,opt,name=system,proto3,enum=deps_dev.v3alpha.System" json:"system,omitempty"`
	// The name of the package.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

PackageKey identifies a package by name.

func (*PackageKey) Descriptor deprecated 

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

Deprecated: Use PackageKey.ProtoReflect.Descriptor instead.

func (*PackageKey) GetName 

func (x *PackageKey) GetName() string

func (*PackageKey) GetSystem 

func (x *PackageKey) GetSystem() System

func (*PackageKey) ProtoMessage 

func (*PackageKey) ProtoMessage()

func (*PackageKey) ProtoReflect 

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

func (*PackageKey) Reset 

func (x *PackageKey) Reset()

func (*PackageKey) String 

func (x *PackageKey) String() string

type Package_Version 

type Package_Version struct {

	// The name of the version. Note that the package name may differ from the
	// name in the request, due to canonicalization.
	VersionKey *VersionKey `protobuf:"bytes,1,opt,name=version_key,json=versionKey,proto3" json:"version_key,omitempty"`
	// If true, this is the default version of the package: the version that is
	// installed when no version is specified. The precise meaning of this is
	// system-specific, but it is commonly the version with the greatest
	// version number, ignoring pre-release versions.
	IsDefault bool `protobuf:"varint,2,opt,name=is_default,json=isDefault,proto3" json:"is_default,omitempty"`
	// contains filtered or unexported fields
}

func (*Package_Version) Descriptor deprecated 

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

Deprecated: Use Package_Version.ProtoReflect.Descriptor instead.

func (*Package_Version) GetIsDefault 

func (x *Package_Version) GetIsDefault() bool

func (*Package_Version) GetVersionKey 

func (x *Package_Version) GetVersionKey() *VersionKey

func (*Package_Version) ProtoMessage 

func (*Package_Version) ProtoMessage()

func (*Package_Version) ProtoReflect 

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

func (*Package_Version) Reset 

func (x *Package_Version) Reset()

func (*Package_Version) String 

func (x *Package_Version) String() string

type Project 

type Project struct {

	// The identifier for the project. Note that this may differ from the
	// identifier in the request, due to canonicalization.
	ProjectKey *ProjectKey `protobuf:"bytes,1,opt,name=project_key,json=projectKey,proto3" json:"project_key,omitempty"`
	// The number of stars reported by the project host.
	// Only available for GitHub and GitLab.
	OpenIssuesCount int64 `protobuf:"varint,2,opt,name=open_issues_count,json=openIssuesCount,proto3" json:"open_issues_count,omitempty"`
	// The number of stars reported by the project host.
	// Only available for GitHub and GitLab.
	StarsCount int64 `protobuf:"varint,3,opt,name=stars_count,json=starsCount,proto3" json:"stars_count,omitempty"`
	// The number of forks reported by the project host.
	// Only available for GitHub and GitLab.
	ForksCount int64 `protobuf:"varint,4,opt,name=forks_count,json=forksCount,proto3" json:"forks_count,omitempty"`
	// The license reported by the project host.
	License string `protobuf:"bytes,5,opt,name=license,proto3" json:"license,omitempty"`
	// The description reported by the project host.
	Description string `protobuf:"bytes,6,opt,name=description,proto3" json:"description,omitempty"`
	// The homepage reported by the project host.
	Homepage string `protobuf:"bytes,7,opt,name=homepage,proto3" json:"homepage,omitempty"`
	// An [OpenSSF Scorecard](https://github.com/ossf/scorecard) for the project,
	// if one is available.
	Scorecard *Project_Scorecard `protobuf:"bytes,8,opt,name=scorecard,proto3" json:"scorecard,omitempty"`
	// contains filtered or unexported fields
}

Project holds information about a project hosted by GitHub, GitLab, or Bitbucket.

func (*Project) Descriptor deprecated 

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

Deprecated: Use Project.ProtoReflect.Descriptor instead.

func (*Project) GetDescription 

func (x *Project) GetDescription() string

func (*Project) GetForksCount 

func (x *Project) GetForksCount() int64

func (*Project) GetHomepage 

func (x *Project) GetHomepage() string

func (*Project) GetLicense 

func (x *Project) GetLicense() string

func (*Project) GetOpenIssuesCount 

func (x *Project) GetOpenIssuesCount() int64

func (*Project) GetProjectKey 

func (x *Project) GetProjectKey() *ProjectKey

func (*Project) GetScorecard 

func (x *Project) GetScorecard() *Project_Scorecard

func (*Project) GetStarsCount 

func (x *Project) GetStarsCount() int64

func (*Project) ProtoMessage 

func (*Project) ProtoMessage()

func (*Project) ProtoReflect 

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

func (*Project) Reset 

func (x *Project) Reset()

func (*Project) String 

func (x *Project) String() string

type ProjectKey 

type ProjectKey struct {

	// A project identifier of the form `github.com/user/repo`,
	// `gitlab.com/user/repo`, or `bitbucket.org/user/repo`.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

ProjectKey identifies a project.

func (*ProjectKey) Descriptor deprecated 

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

Deprecated: Use ProjectKey.ProtoReflect.Descriptor instead.

func (*ProjectKey) GetId 

func (x *ProjectKey) GetId() string

func (*ProjectKey) ProtoMessage 

func (*ProjectKey) ProtoMessage()

func (*ProjectKey) ProtoReflect 

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

func (*ProjectKey) Reset 

func (x *ProjectKey) Reset()

func (*ProjectKey) String 

func (x *ProjectKey) String() string

type Project_Scorecard 

type Project_Scorecard struct {

	// The date at which the scorecard was produced.
	Date *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=date,proto3" json:"date,omitempty"`
	// The source code repository and commit the scorecard was produced from.
	Repository *Project_Scorecard_Repository `protobuf:"bytes,2,opt,name=repository,proto3" json:"repository,omitempty"`
	// The version and commit of the Scorecard program used to produce the
	// scorecard.
	Scorecard *Project_Scorecard_ScorecardDetails `protobuf:"bytes,3,opt,name=scorecard,proto3" json:"scorecard,omitempty"`
	// The results of the
	// [Scorecard Checks](https://github.com/ossf/scorecard#scorecard-checks)
	// performed on the project.
	Checks []*Project_Scorecard_Check `protobuf:"bytes,4,rep,name=checks,proto3" json:"checks,omitempty"`
	// A weighted average score in the range [0,10]. A higher score is better.
	OverallScore float32 `protobuf:"fixed32,5,opt,name=overall_score,json=overallScore,proto3" json:"overall_score,omitempty"`
	// Additional metadata associated with the scorecard.
	Metadata []string `protobuf:"bytes,6,rep,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*Project_Scorecard) Descriptor deprecated 

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

Deprecated: Use Project_Scorecard.ProtoReflect.Descriptor instead.

func (*Project_Scorecard) GetChecks 

func (x *Project_Scorecard) GetChecks() []*Project_Scorecard_Check

func (*Project_Scorecard) GetDate 

func (x *Project_Scorecard) GetDate() *timestamppb.Timestamp

func (*Project_Scorecard) GetMetadata 

func (x *Project_Scorecard) GetMetadata() []string

func (*Project_Scorecard) GetOverallScore 

func (x *Project_Scorecard) GetOverallScore() float32

func (*Project_Scorecard) GetRepository 

func (x *Project_Scorecard) GetRepository() *Project_Scorecard_Repository

func (*Project_Scorecard) GetScorecard 

func (x *Project_Scorecard) GetScorecard() *Project_Scorecard_ScorecardDetails

func (*Project_Scorecard) ProtoMessage 

func (*Project_Scorecard) ProtoMessage()

func (*Project_Scorecard) ProtoReflect 

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

func (*Project_Scorecard) Reset 

func (x *Project_Scorecard) Reset()

func (*Project_Scorecard) String 

func (x *Project_Scorecard) String() string

type Project_Scorecard_Check 

type Project_Scorecard_Check struct {

	// The name of the check.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Human-readable documentation for the check.
	Documentation *Project_Scorecard_Check_Documentation `protobuf:"bytes,2,opt,name=documentation,proto3" json:"documentation,omitempty"`
	// A score in the range [0,10]. A higher score is better.
	// A negative score indicates that the check did not run successfully.
	Score int64 `protobuf:"varint,3,opt,name=score,proto3" json:"score,omitempty"`
	// The reason for the score.
	Reason string `protobuf:"bytes,4,opt,name=reason,proto3" json:"reason,omitempty"`
	// Further details regarding the check.
	Details []string `protobuf:"bytes,5,rep,name=details,proto3" json:"details,omitempty"`
	// contains filtered or unexported fields
}

func (*Project_Scorecard_Check) Descriptor deprecated 

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

Deprecated: Use Project_Scorecard_Check.ProtoReflect.Descriptor instead.

func (*Project_Scorecard_Check) GetDetails 

func (x *Project_Scorecard_Check) GetDetails() []string

func (*Project_Scorecard_Check) GetDocumentation 

func (x *Project_Scorecard_Check) GetDocumentation() *Project_Scorecard_Check_Documentation

func (*Project_Scorecard_Check) GetName 

func (x *Project_Scorecard_Check) GetName() string

func (*Project_Scorecard_Check) GetReason 

func (x *Project_Scorecard_Check) GetReason() string

func (*Project_Scorecard_Check) GetScore 

func (x *Project_Scorecard_Check) GetScore() int64

func (*Project_Scorecard_Check) ProtoMessage 

func (*Project_Scorecard_Check) ProtoMessage()

func (*Project_Scorecard_Check) ProtoReflect 

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

func (*Project_Scorecard_Check) Reset 

func (x *Project_Scorecard_Check) Reset()

func (*Project_Scorecard_Check) String 

func (x *Project_Scorecard_Check) String() string

type Project_Scorecard_Check_Documentation 

type Project_Scorecard_Check_Documentation struct {

	// A short description of the check.
	ShortDescription string `protobuf:"bytes,1,opt,name=short_description,json=shortDescription,proto3" json:"short_description,omitempty"`
	// A link to more details about the check.
	Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// contains filtered or unexported fields
}

func (*Project_Scorecard_Check_Documentation) Descriptor deprecated 

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

Deprecated: Use Project_Scorecard_Check_Documentation.ProtoReflect.Descriptor instead.

func (*Project_Scorecard_Check_Documentation) GetShortDescription 

func (x *Project_Scorecard_Check_Documentation) GetShortDescription() string

func (*Project_Scorecard_Check_Documentation) GetUrl 

func (x *Project_Scorecard_Check_Documentation) GetUrl() string

func (*Project_Scorecard_Check_Documentation) ProtoMessage 

func (*Project_Scorecard_Check_Documentation) ProtoMessage()

func (*Project_Scorecard_Check_Documentation) ProtoReflect 

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

func (*Project_Scorecard_Check_Documentation) Reset 

func (x *Project_Scorecard_Check_Documentation) Reset()

func (*Project_Scorecard_Check_Documentation) String 

func (x *Project_Scorecard_Check_Documentation) String() string

type Project_Scorecard_Repository 

type Project_Scorecard_Repository struct {

	// The source code repository the scorecard was produced from.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The source code commit the scorecard was produced from.
	Commit string `protobuf:"bytes,2,opt,name=commit,proto3" json:"commit,omitempty"`
	// contains filtered or unexported fields
}

func (*Project_Scorecard_Repository) Descriptor deprecated 

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

Deprecated: Use Project_Scorecard_Repository.ProtoReflect.Descriptor instead.

func (*Project_Scorecard_Repository) GetCommit 

func (x *Project_Scorecard_Repository) GetCommit() string

func (*Project_Scorecard_Repository) GetName 

func (x *Project_Scorecard_Repository) GetName() string

func (*Project_Scorecard_Repository) ProtoMessage 

func (*Project_Scorecard_Repository) ProtoMessage()

func (*Project_Scorecard_Repository) ProtoReflect 

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

func (*Project_Scorecard_Repository) Reset 

func (x *Project_Scorecard_Repository) Reset()

func (*Project_Scorecard_Repository) String 

func (x *Project_Scorecard_Repository) String() string

type Project_Scorecard_ScorecardDetails 

type Project_Scorecard_ScorecardDetails struct {

	// The version of the Scorecard program used to produce the scorecard.
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// The commit of the Scorecard program used to produce the scorecard.
	Commit string `protobuf:"bytes,2,opt,name=commit,proto3" json:"commit,omitempty"`
	// contains filtered or unexported fields
}

func (*Project_Scorecard_ScorecardDetails) Descriptor deprecated 

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

Deprecated: Use Project_Scorecard_ScorecardDetails.ProtoReflect.Descriptor instead.

func (*Project_Scorecard_ScorecardDetails) GetCommit 

func (x *Project_Scorecard_ScorecardDetails) GetCommit() string

func (*Project_Scorecard_ScorecardDetails) GetVersion 

func (x *Project_Scorecard_ScorecardDetails) GetVersion() string

func (*Project_Scorecard_ScorecardDetails) ProtoMessage 

func (*Project_Scorecard_ScorecardDetails) ProtoMessage()

func (*Project_Scorecard_ScorecardDetails) ProtoReflect 

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

func (*Project_Scorecard_ScorecardDetails) Reset 

func (x *Project_Scorecard_ScorecardDetails) Reset()

func (*Project_Scorecard_ScorecardDetails) String 

func (x *Project_Scorecard_ScorecardDetails) String() string

type QueryRequest 

type QueryRequest struct {

	// A content hash for an artifact associated with a package version, such as a
	// JAR file. Currently supported for npm, Cargo, Maven, and NuGet. Note that
	// hashes and package versions have a many-to-many relationship.
	Hash *Hash `protobuf:"bytes,1,opt,name=hash,proto3" json:"hash,omitempty"`
	// The name of the package version.
	VersionKey *VersionKey `protobuf:"bytes,2,opt,name=version_key,json=versionKey,proto3" json:"version_key,omitempty"`
	// contains filtered or unexported fields
}

QueryRequest identifies package versions for which to return information. At least one of its fields must be set, and both fields may be set to narrow the results.

func (*QueryRequest) Descriptor deprecated 

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

Deprecated: Use QueryRequest.ProtoReflect.Descriptor instead.

func (*QueryRequest) GetHash 

func (x *QueryRequest) GetHash() *Hash

func (*QueryRequest) GetVersionKey 

func (x *QueryRequest) GetVersionKey() *VersionKey

func (*QueryRequest) ProtoMessage 

func (*QueryRequest) ProtoMessage()

func (*QueryRequest) ProtoReflect 

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

func (*QueryRequest) Reset 

func (x *QueryRequest) Reset()

func (*QueryRequest) String 

func (x *QueryRequest) String() string

type QueryResult 

type QueryResult struct {

	// Package versions matching the query. At most 1000 versions are returned.
	Versions []*Version `protobuf:"bytes,1,rep,name=versions,proto3" json:"versions,omitempty"`
	// contains filtered or unexported fields
}

QueryResult holds information about package versions matching the query.

func (*QueryResult) Descriptor deprecated 

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

Deprecated: Use QueryResult.ProtoReflect.Descriptor instead.

func (*QueryResult) GetVersions 

func (x *QueryResult) GetVersions() []*Version

func (*QueryResult) ProtoMessage 

func (*QueryResult) ProtoMessage()

func (*QueryResult) ProtoReflect 

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

func (*QueryResult) Reset 

func (x *QueryResult) Reset()

func (*QueryResult) String 

func (x *QueryResult) String() string

type System 

type System int32

System identifies a package management system. 

const (
	System_SYSTEM_UNSPECIFIED System = 0
	System_GO                 System = 1
	System_NPM                System = 3
	System_CARGO              System = 4
	System_MAVEN              System = 6
	System_PYPI               System = 7
	System_NUGET              System = 8
)

func (System) Descriptor 

func (System) Descriptor() protoreflect.EnumDescriptor

func (System) Enum 

func (x System) Enum() *System

func (System) EnumDescriptor deprecated 

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

Deprecated: Use System.Descriptor instead.

func (System) Number 

func (x System) Number() protoreflect.EnumNumber

func (System) String 

func (x System) String() string

func (System) Type 

func (System) Type() protoreflect.EnumType

type UnimplementedInsightsServer 

type UnimplementedInsightsServer struct {
}

UnimplementedInsightsServer must be embedded to have forward compatible implementations.

func (UnimplementedInsightsServer) GetAdvisory 

func (UnimplementedInsightsServer) GetAdvisory(context.Context, *GetAdvisoryRequest) (*Advisory, error)

func (UnimplementedInsightsServer) GetDependencies 

func (UnimplementedInsightsServer) GetDependencies(context.Context, *GetDependenciesRequest) (*Dependencies, error)

func (UnimplementedInsightsServer) GetPackage 

func (UnimplementedInsightsServer) GetPackage(context.Context, *GetPackageRequest) (*Package, error)

func (UnimplementedInsightsServer) GetProject 

func (UnimplementedInsightsServer) GetProject(context.Context, *GetProjectRequest) (*Project, error)

func (UnimplementedInsightsServer) GetVersion 

func (UnimplementedInsightsServer) GetVersion(context.Context, *GetVersionRequest) (*Version, error)

func (UnimplementedInsightsServer) Query 

func (UnimplementedInsightsServer) Query(context.Context, *QueryRequest) (*QueryResult, error)

type UnsafeInsightsServer 

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

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

type Version 

type Version struct {

	// The name of the package version. Note that the package and version name
	// may differ from names specified in requests, if applicable, due to
	// canonicalization.
	VersionKey *VersionKey `protobuf:"bytes,1,opt,name=version_key,json=versionKey,proto3" json:"version_key,omitempty"`
	// If true, this is the default version of the package: the version that is
	// installed when no version is specified. The precise meaning of this is
	// system-specific, but it is commonly the version with the greatest version
	// number, ignoring pre-release versions.
	IsDefault bool `protobuf:"varint,2,opt,name=is_default,json=isDefault,proto3" json:"is_default,omitempty"`
	// The licenses governing the use of this package version.
	//
	// We identify licenses as
	// [SPDX 2.1](https://spdx.dev/spdx-specification-21-web-version/)
	// expressions. When there is no associated SPDX identifier, we identify a
	// license as "non-standard". When we are unable to obtain license
	// information, this field is empty. When more than one license is listed,
	// their relationship is unspecified.
	//
	// For Cargo, Maven, npm, and PyPI, license information is read from the
	// package metadata. For Go, license information is determined using the
	// [licensecheck](https://github.com/google/licensecheck) package.
	//
	// License information is not intended to be legal advice, and you should
	// independently verify the license or terms of any software for your own
	// needs.
	Licenses []string `protobuf:"bytes,3,rep,name=licenses,proto3" json:"licenses,omitempty"`
	// Security advisories known to affect this package version.
	// Further information can be requested using the Advisory method.
	AdvisoryKeys []*AdvisoryKey `protobuf:"bytes,4,rep,name=advisory_keys,json=advisoryKeys,proto3" json:"advisory_keys,omitempty"`
	// Links declared by or derived from package version metadata, to external
	// web resources such as a homepage or source code repository. Note that
	// these links are not verified for correctness.
	Links []*Link `protobuf:"bytes,5,rep,name=links,proto3" json:"links,omitempty"`
	// contains filtered or unexported fields
}

Version holds information about a package version.

func (*Version) Descriptor deprecated 

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

Deprecated: Use Version.ProtoReflect.Descriptor instead.

func (*Version) GetAdvisoryKeys 

func (x *Version) GetAdvisoryKeys() []*AdvisoryKey

func (*Version) GetIsDefault 

func (x *Version) GetIsDefault() bool

func (*Version) GetLicenses 

func (x *Version) GetLicenses() []string
func (x *Version) GetLinks() []*Link

func (*Version) GetVersionKey 

func (x *Version) GetVersionKey() *VersionKey

func (*Version) ProtoMessage 

func (*Version) ProtoMessage()

func (*Version) ProtoReflect 

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

func (*Version) Reset 

func (x *Version) Reset()

func (*Version) String 

func (x *Version) String() string

type VersionKey 

type VersionKey struct {

	// The package management system containing the package.
	System System `protobuf:"varint,1,opt,name=system,proto3,enum=deps_dev.v3alpha.System" json:"system,omitempty"`
	// The name of the package.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// The version of the package.
	Version string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

VersionKey identifies a package version by name.

func (*VersionKey) Descriptor deprecated 

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

Deprecated: Use VersionKey.ProtoReflect.Descriptor instead.

func (*VersionKey) GetName 

func (x *VersionKey) GetName() string

func (*VersionKey) GetSystem 

func (x *VersionKey) GetSystem() System

func (*VersionKey) GetVersion 

func (x *VersionKey) GetVersion() string

func (*VersionKey) ProtoMessage 

func (*VersionKey) ProtoMessage()

func (*VersionKey) ProtoReflect 

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

func (*VersionKey) Reset 

func (x *VersionKey) Reset()

func (*VersionKey) String 

func (x *VersionKey) String() string

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.