Documentation ¶
Index ¶
- Variables
- func CacheExpires(r *http.Response) time.Time
- type APIClient
- type APIKey
- type APIResponse
- type AliasContextKind
- type AssessmentJustification
- type AssessmentRemediation
- type AssessmentState
- type AttestationAttestation
- type AttestationAuthority
- type AttestationGenericSignedAttestation
- type AttestationGenericSignedAttestationContentType
- type AttestationPgpSignedAttestation
- type AttestationPgpSignedAttestationContentType
- type AuthorityHint
- type BasicAuth
- type Body
- type Body1
- type BuildBuild
- type BuildBuildSignature
- type BuildSignatureKeyType
- type Configuration
- type CvssAttackComplexity
- type CvssAttackVector
- type CvssAuthentication
- type CvssImpact
- type CvssPrivilegesRequired
- type CvssScope
- type CvssUserInteraction
- type DeploymentDeployable
- type DeploymentDeployment
- type DeploymentPlatform
- type DetailsVexAssessment
- type DiscoveredAnalysisCompleted
- type DiscoveredAnalysisStatus
- type DiscoveredContinuousAnalysis
- type DiscoveryDiscovered
- type DiscoveryDiscovery
- type ExternalRefCategory
- type FileNoteFileType
- type GenericSwaggerError
- type GrafeasV1Beta1ApiGrafeasV1Beta1GetVulnerabilityOccurrencesSummaryOpts
- type GrafeasV1Beta1ApiGrafeasV1Beta1ListNoteOccurrencesOpts
- type GrafeasV1Beta1ApiGrafeasV1Beta1ListNotesOpts
- type GrafeasV1Beta1ApiGrafeasV1Beta1ListOccurrencesOpts
- type GrafeasV1Beta1ApiGrafeasV1Beta1UpdateNoteOpts
- type GrafeasV1Beta1ApiGrafeasV1Beta1UpdateOccurrenceOpts
- type GrafeasV1Beta1ApiService
- func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1BatchCreateNotes(ctx context.Context, parent string, body Body) (V1beta1BatchCreateNotesResponse, *http.Response, error)
- func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1BatchCreateOccurrences(ctx context.Context, parent string, body Body1) (V1beta1BatchCreateOccurrencesResponse, *http.Response, error)
- func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1CreateNote(ctx context.Context, parent string, body V1beta1Note, noteId string) (V1beta1Note, *http.Response, error)
- func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1CreateOccurrence(ctx context.Context, parent string, body V1beta1Occurrence) (V1beta1Occurrence, *http.Response, error)
- func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1DeleteNote(ctx context.Context, name1 string) (interface{}, *http.Response, error)
- func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1DeleteOccurrence(ctx context.Context, name string) (interface{}, *http.Response, error)
- func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1GetNote(ctx context.Context, name1 string) (V1beta1Note, *http.Response, error)
- func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1GetOccurrence(ctx context.Context, name string) (V1beta1Occurrence, *http.Response, error)
- func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1GetOccurrenceNote(ctx context.Context, name string) (V1beta1Note, *http.Response, error)
- func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1GetVulnerabilityOccurrencesSummary(ctx context.Context, parent string, ...) (V1beta1VulnerabilityOccurrencesSummary, *http.Response, error)
- func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1ListNoteOccurrences(ctx context.Context, name string, ...) (V1beta1ListNoteOccurrencesResponse, *http.Response, error)
- func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1ListNotes(ctx context.Context, parent string, ...) (V1beta1ListNotesResponse, *http.Response, error)
- func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1ListOccurrences(ctx context.Context, parent string, ...) (V1beta1ListOccurrencesResponse, *http.Response, error)
- func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1UpdateNote(ctx context.Context, name1 string, body V1beta1Note, ...) (V1beta1Note, *http.Response, error)
- func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1UpdateOccurrence(ctx context.Context, name string, body V1beta1Occurrence, ...) (V1beta1Occurrence, *http.Response, error)
- type Grafeasv1beta1Signature
- type HashHashType
- type ImageBasis
- type ImageDerived
- type ImageFingerprint
- type ImageLayer
- type InTotoArtifactRule
- type IntotoInToto
- type IntotoLink
- type IntotoLinkArtifact
- type IntotoSigningKey
- type JustificationJustificationType
- type LayerDirective
- type LinkArtifactHashes
- type LinkByProducts
- type LinkEnvironment
- type PackageArchitecture
- type PackageDistribution
- type PackageInfoNoteExternalRef
- type PackageInstallation
- type PackagePackage
- type PackageVersion
- type ProtobufAny
- type ProvenanceBuildProvenance
- type ProvenanceCommand
- type ProvenanceFileHashes
- type ProvenanceHash
- type ProvenanceSource
- type RemediationRemediationType
- type RpcStatus
- type SourceAliasContext
- type SourceCloudRepoSourceContext
- type SourceGerritSourceContext
- type SourceGitSourceContext
- type SourceProjectRepoId
- type SourceRepoId
- type SourceSourceContext
- type SpdxDocumentNote
- type SpdxDocumentOccurrence
- type SpdxFileNote
- type SpdxFileOccurrence
- type SpdxPackageInfoNote
- type SpdxPackageInfoOccurrence
- type SpdxRelationshipNote
- type SpdxRelationshipOccurrence
- type SpdxRelationshipType
- type V1beta1BatchCreateNotesResponse
- type V1beta1BatchCreateOccurrencesResponse
- type V1beta1Digest
- type V1beta1Envelope
- type V1beta1EnvelopeSignature
- type V1beta1License
- type V1beta1ListNoteOccurrencesResponse
- type V1beta1ListNotesResponse
- type V1beta1ListOccurrencesResponse
- type V1beta1Note
- type V1beta1NoteKind
- type V1beta1Occurrence
- type V1beta1RelatedUrl
- type V1beta1Resource
- type V1beta1VulnerabilityOccurrencesSummary
- type V1beta1attestationDetails
- type V1beta1buildDetails
- type V1beta1deploymentDetails
- type V1beta1discoveryDetails
- type V1beta1imageDetails
- type V1beta1intotoDetails
- type V1beta1intotoSignature
- type V1beta1packageDetails
- type V1beta1packageLocation
- type V1beta1provenanceArtifact
- type V1beta1vulnerabilityDetails
- type VersionVersionKind
- type VexVulnerabilityAssessmentNote
- type VulnerabilityAssessmentNoteAssessment
- type VulnerabilityAssessmentNoteProduct
- type VulnerabilityAssessmentNotePublisher
- type VulnerabilityCvss
- type VulnerabilityCvssVersion
- type VulnerabilityDetail
- type VulnerabilityOccurrencesSummaryFixableTotalByDigest
- type VulnerabilityPackageIssue
- type VulnerabilitySeverity
- type VulnerabilityVulnerability
- type VulnerabilityVulnerabilityLocation
- type VulnerabilityWindowsDetail
- type WindowsDetailKnowledgeBase
Constants ¶
This section is empty.
Variables ¶
var ( // ContextOAuth2 takes a oauth2.TokenSource as authentication for the request. ContextOAuth2 = contextKey("token") // ContextBasicAuth takes BasicAuth as authentication for the request. ContextBasicAuth = contextKey("basic") // ContextAccessToken takes a string oauth2 access token as authentication for the request. ContextAccessToken = contextKey("accesstoken") // ContextAPIKey takes an APIKey as authentication for the request ContextAPIKey = contextKey("apikey") )
Functions ¶
Types ¶
type APIClient ¶
type APIClient struct { GrafeasV1Beta1Api *GrafeasV1Beta1ApiService // contains filtered or unexported fields }
APIClient manages communication with the grafeas.proto API vversion not set In most cases there should be only one, shared, APIClient.
func NewAPIClient ¶
func NewAPIClient(cfg *Configuration) *APIClient
NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.
func (*APIClient) ChangeBasePath ¶
Change base path to allow switching to mocks
type APIKey ¶
APIKey provides API key based authentication to a request passed via context using ContextAPIKey
type APIResponse ¶
type APIResponse struct { *http.Response `json:"-"` Message string `json:"message,omitempty"` // Operation is the name of the swagger operation. Operation string `json:"operation,omitempty"` // RequestURL is the request URL. This value is always available, even if the // embedded *http.Response is nil. RequestURL string `json:"url,omitempty"` // Method is the HTTP method used for the request. This value is always // available, even if the embedded *http.Response is nil. Method string `json:"method,omitempty"` // Payload holds the contents of the response body (which may be nil or empty). // This is provided here as the raw response.Body() reader will have already // been drained. Payload []byte `json:"-"` }
func NewAPIResponse ¶
func NewAPIResponse(r *http.Response) *APIResponse
func NewAPIResponseWithError ¶
func NewAPIResponseWithError(errorMessage string) *APIResponse
type AliasContextKind ¶
type AliasContextKind string
AliasContextKind : The type of an alias. - KIND_UNSPECIFIED: Unknown. - FIXED: Git tag. - MOVABLE: Git branch. - OTHER: Used to specify non-standard aliases. For example, if a Git repo has a ref named \"refs/foo/bar\".
const ( KIND_UNSPECIFIED_AliasContextKind AliasContextKind = "KIND_UNSPECIFIED" FIXED_AliasContextKind AliasContextKind = "FIXED" MOVABLE_AliasContextKind AliasContextKind = "MOVABLE" OTHER_AliasContextKind AliasContextKind = "OTHER" )
List of AliasContextKind
type AssessmentJustification ¶
type AssessmentJustification struct { // The justification type for this vulnerability. JustificationType *JustificationJustificationType `json:"justificationType,omitempty"` // Additional details on why this justification was chosen. Details string `json:"details,omitempty"` }
Justification provides the justification when the state of the assessment if NOT_AFFECTED.
type AssessmentRemediation ¶
type AssessmentRemediation struct { // The type of remediation that can be applied. RemediationType *RemediationRemediationType `json:"remediationType,omitempty"` // Contains the date from which the remediation is available. RemediationTime time.Time `json:"remediationTime,omitempty"` // Contains a comprehensive human-readable discussion of the remediation. Details string `json:"details,omitempty"` // Contains the URL where to obtain the remediation. RemediationUri *V1beta1RelatedUrl `json:"remediationUri,omitempty"` }
Specifies details on how to handle (and presumably, fix) a vulnerability.
type AssessmentState ¶
type AssessmentState string
AssessmentState : Provides the state of this Vulnerability assessment. - STATE_UNSPECIFIED: No state is specified. - AFFECTED: This product is known to be affected by this vulnerability. - NOT_AFFECTED: This product is known to be not affected by this vulnerability. - FIXED: This product contains a fix for this vulnerability. - UNDER_INVESTIGATION: It is not known yet whether these versions are or are not affected by the vulnerability. However, it is still under investigation.
const ( STATE_UNSPECIFIED_AssessmentState AssessmentState = "STATE_UNSPECIFIED" AFFECTED_AssessmentState AssessmentState = "AFFECTED" NOT_AFFECTED_AssessmentState AssessmentState = "NOT_AFFECTED" FIXED_AssessmentState AssessmentState = "FIXED" UNDER_INVESTIGATION_AssessmentState AssessmentState = "UNDER_INVESTIGATION" )
List of AssessmentState
type AttestationAttestation ¶
type AttestationAttestation struct { // A PGP signed attestation. PgpSignedAttestation *AttestationPgpSignedAttestation `json:"pgpSignedAttestation,omitempty"` // An attestation that supports multiple `Signature`s over the same attestation payload. The signatures (defined in common.proto) support a superset of public key types and IDs compared to PgpSignedAttestation. GenericSignedAttestation *AttestationGenericSignedAttestation `json:"genericSignedAttestation,omitempty"` }
Occurrence that represents a single \"attestation\". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for look-up (how to find this attestation if you already know the authority and artifact to be verified) and intent (which authority was this attestation intended to sign for).
type AttestationAuthority ¶
type AttestationAuthority struct { // Hint hints at the purpose of the attestation authority. Hint *AuthorityHint `json:"hint,omitempty"` }
Note kind that represents a logical attestation \"role\" or \"authority\". For example, an organization might have one `Authority` for \"QA\" and one for \"build\". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project.
type AttestationGenericSignedAttestation ¶
type AttestationGenericSignedAttestation struct { // Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema). ContentType *AttestationGenericSignedAttestationContentType `json:"contentType,omitempty"` // The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`. SerializedPayload string `json:"serializedPayload,omitempty"` // One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification. Signatures []Grafeasv1beta1Signature `json:"signatures,omitempty"` }
An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.
type AttestationGenericSignedAttestationContentType ¶
type AttestationGenericSignedAttestationContentType string
AttestationGenericSignedAttestationContentType : Type of the attestation plaintext that was signed. - CONTENT_TYPE_UNSPECIFIED: `ContentType` is not set. - SIMPLE_SIGNING_JSON: Atomic format attestation signature. See https://github.com/containers/image/blob/8a5d2f82a6e3263290c8e0276c3e0f64e77723e7/docs/atomic-signature.md The payload extracted in `plaintext` is a JSON blob conforming to the linked schema.
const ( CONTENT_TYPE_UNSPECIFIED_AttestationGenericSignedAttestationContentType AttestationGenericSignedAttestationContentType = "CONTENT_TYPE_UNSPECIFIED" SIMPLE_SIGNING_JSON_AttestationGenericSignedAttestationContentType AttestationGenericSignedAttestationContentType = "SIMPLE_SIGNING_JSON" )
List of attestationGenericSignedAttestationContentType
type AttestationPgpSignedAttestation ¶
type AttestationPgpSignedAttestation struct { // Required. The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload. Signature string `json:"signature,omitempty"` // Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema). ContentType *AttestationPgpSignedAttestationContentType `json:"contentType,omitempty"` // The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexadecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge \"LONG\", \"SHORT\", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: “` gpg --with-colons --with-fingerprint --force-v4-certs \\ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...<SNIP>... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: “` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`. PgpKeyId string `json:"pgpKeyId,omitempty"` }
An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file.
type AttestationPgpSignedAttestationContentType ¶
type AttestationPgpSignedAttestationContentType string
AttestationPgpSignedAttestationContentType : Type (for example schema) of the attestation payload that was signed. - CONTENT_TYPE_UNSPECIFIED: `ContentType` is not set. - SIMPLE_SIGNING_JSON: Atomic format attestation signature. See https://github.com/containers/image/blob/8a5d2f82a6e3263290c8e0276c3e0f64e77723e7/docs/atomic-signature.md The payload extracted from `signature` is a JSON blob conforming to the linked schema.
const ( CONTENT_TYPE_UNSPECIFIED_AttestationPgpSignedAttestationContentType AttestationPgpSignedAttestationContentType = "CONTENT_TYPE_UNSPECIFIED" SIMPLE_SIGNING_JSON_AttestationPgpSignedAttestationContentType AttestationPgpSignedAttestationContentType = "SIMPLE_SIGNING_JSON" )
List of attestationPgpSignedAttestationContentType
type AuthorityHint ¶
type AuthorityHint struct { // Required. The human readable name of this attestation authority, for example \"qa\". HumanReadableName string `json:"humanReadableName,omitempty"` }
This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from \"readable\" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify.
type BasicAuth ¶
type BasicAuth struct { UserName string `json:"userName,omitempty"` Password string `json:"password,omitempty"` }
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
type Body ¶
type Body struct { // The notes to create, the key is expected to be the note ID. Max allowed length is 1000. Notes map[string]V1beta1Note `json:"notes"` }
Request to create notes in batch.
type Body1 ¶
type Body1 struct { // The occurrences to create. Max allowed length is 1000. Occurrences []V1beta1Occurrence `json:"occurrences"` }
Request to create occurrences in batch.
type BuildBuild ¶
type BuildBuild struct { // Required. Immutable. Version of the builder which produced this build. BuilderVersion string `json:"builderVersion,omitempty"` // Signature of the build in occurrences pointing to this build note containing build details. Signature *BuildBuildSignature `json:"signature,omitempty"` }
Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence.
type BuildBuildSignature ¶
type BuildBuildSignature struct { // Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin` PublicKey string `json:"publicKey,omitempty"` // Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded. Signature string `json:"signature,omitempty"` // An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service). KeyId string `json:"keyId,omitempty"` // The type of the key, either stored in `public_key` or referenced in `key_id`. KeyType *BuildSignatureKeyType `json:"keyType,omitempty"` }
Message encapsulating the signature of the verified build.
type BuildSignatureKeyType ¶
type BuildSignatureKeyType string
BuildSignatureKeyType : Public key formats. - KEY_TYPE_UNSPECIFIED: `KeyType` is not set. - PGP_ASCII_ARMORED: `PGP ASCII Armored` public key. - PKIX_PEM: `PKIX PEM` public key.
const ( KEY_TYPE_UNSPECIFIED_BuildSignatureKeyType BuildSignatureKeyType = "KEY_TYPE_UNSPECIFIED" PGP_ASCII_ARMORED_BuildSignatureKeyType BuildSignatureKeyType = "PGP_ASCII_ARMORED" PKIX_PEM_BuildSignatureKeyType BuildSignatureKeyType = "PKIX_PEM" )
List of BuildSignatureKeyType
type Configuration ¶
type Configuration struct { BasePath string `json:"basePath,omitempty"` Host string `json:"host,omitempty"` Scheme string `json:"scheme,omitempty"` DefaultHeader map[string]string `json:"defaultHeader,omitempty"` UserAgent string `json:"userAgent,omitempty"` HTTPClient *http.Client }
func NewConfiguration ¶
func NewConfiguration() *Configuration
func (*Configuration) AddDefaultHeader ¶
func (c *Configuration) AddDefaultHeader(key string, value string)
type CvssAttackComplexity ¶
type CvssAttackComplexity string
const ( UNSPECIFIED_CvssAttackComplexity CvssAttackComplexity = "ATTACK_COMPLEXITY_UNSPECIFIED" LOW_CvssAttackComplexity CvssAttackComplexity = "ATTACK_COMPLEXITY_LOW" HIGH_CvssAttackComplexity CvssAttackComplexity = "ATTACK_COMPLEXITY_HIGH" MEDIUM_CvssAttackComplexity CvssAttackComplexity = "ATTACK_COMPLEXITY_MEDIUM" )
List of CVSSAttackComplexity
type CvssAttackVector ¶
type CvssAttackVector string
const ( UNSPECIFIED_CvssAttackVector CvssAttackVector = "ATTACK_VECTOR_UNSPECIFIED" NETWORK_CvssAttackVector CvssAttackVector = "ATTACK_VECTOR_NETWORK" ADJACENT_CvssAttackVector CvssAttackVector = "ATTACK_VECTOR_ADJACENT" LOCAL_CvssAttackVector CvssAttackVector = "ATTACK_VECTOR_LOCAL" PHYSICAL_CvssAttackVector CvssAttackVector = "ATTACK_VECTOR_PHYSICAL" )
List of CVSSAttackVector
type CvssAuthentication ¶
type CvssAuthentication string
const ( UNSPECIFIED_CvssAuthentication CvssAuthentication = "AUTHENTICATION_UNSPECIFIED" MULTIPLE_CvssAuthentication CvssAuthentication = "AUTHENTICATION_MULTIPLE" SINGLE_CvssAuthentication CvssAuthentication = "AUTHENTICATION_SINGLE" NONE_CvssAuthentication CvssAuthentication = "AUTHENTICATION_NONE" )
List of CVSSAuthentication
type CvssImpact ¶
type CvssImpact string
const ( UNSPECIFIED_CvssImpact CvssImpact = "IMPACT_UNSPECIFIED" HIGH_CvssImpact CvssImpact = "IMPACT_HIGH" LOW_CvssImpact CvssImpact = "IMPACT_LOW" NONE_CvssImpact CvssImpact = "IMPACT_NONE" PARTIAL_CvssImpact CvssImpact = "IMPACT_PARTIAL" COMPLETE_CvssImpact CvssImpact = "IMPACT_COMPLETE" )
List of CVSSImpact
type CvssPrivilegesRequired ¶
type CvssPrivilegesRequired string
const ( UNSPECIFIED_CvssPrivilegesRequired CvssPrivilegesRequired = "PRIVILEGES_REQUIRED_UNSPECIFIED" NONE_CvssPrivilegesRequired CvssPrivilegesRequired = "PRIVILEGES_REQUIRED_NONE" LOW_CvssPrivilegesRequired CvssPrivilegesRequired = "PRIVILEGES_REQUIRED_LOW" HIGH_CvssPrivilegesRequired CvssPrivilegesRequired = "PRIVILEGES_REQUIRED_HIGH" )
List of CVSSPrivilegesRequired
type CvssUserInteraction ¶
type CvssUserInteraction string
const ( UNSPECIFIED_CvssUserInteraction CvssUserInteraction = "USER_INTERACTION_UNSPECIFIED" NONE_CvssUserInteraction CvssUserInteraction = "USER_INTERACTION_NONE" REQUIRED_CvssUserInteraction CvssUserInteraction = "USER_INTERACTION_REQUIRED" )
List of CVSSUserInteraction
type DeploymentDeployable ¶
type DeploymentDeployable struct { // Required. Resource URI for the artifact being deployed. ResourceUri []string `json:"resourceUri,omitempty"` }
An artifact that can be deployed in some runtime.
type DeploymentDeployment ¶
type DeploymentDeployment struct { // Identity of the user that triggered this deployment. UserEmail string `json:"userEmail,omitempty"` // Required. Beginning of the lifetime of this deployment. DeployTime time.Time `json:"deployTime,omitempty"` // End of the lifetime of this deployment. UndeployTime time.Time `json:"undeployTime,omitempty"` // Configuration used to create this deployment. Config string `json:"config,omitempty"` // Address of the runtime element hosting this deployment. Address string `json:"address,omitempty"` // Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name. ResourceUri []string `json:"resourceUri,omitempty"` // Platform hosting this deployment. Platform *DeploymentPlatform `json:"platform,omitempty"` }
The period during which some deployable was active in a runtime.
type DeploymentPlatform ¶
type DeploymentPlatform string
DeploymentPlatform : Types of platforms. - PLATFORM_UNSPECIFIED: Unknown. - GKE: Google Container Engine. - FLEX: Google App Engine: Flexible Environment. - CUSTOM: Custom user-defined platform.
const ( PLATFORM_UNSPECIFIED_DeploymentPlatform DeploymentPlatform = "PLATFORM_UNSPECIFIED" GKE_DeploymentPlatform DeploymentPlatform = "GKE" FLEX_DeploymentPlatform DeploymentPlatform = "FLEX" CUSTOM_DeploymentPlatform DeploymentPlatform = "CUSTOM" )
List of DeploymentPlatform
type DetailsVexAssessment ¶
type DetailsVexAssessment struct { // Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Cve string `json:"cve,omitempty"` // Holds a list of references associated with this vulnerability item and assessment. RelatedUris []V1beta1RelatedUrl `json:"relatedUris,omitempty"` NoteName string `json:"noteName,omitempty"` // Provides the state of this Vulnerability assessment. State *AssessmentState `json:"state,omitempty"` // Contains information about the impact of this vulnerability, this will change with time. Impacts []string `json:"impacts,omitempty"` // Specifies details on how to handle (and presumably, fix) a vulnerability. Remediations []AssessmentRemediation `json:"remediations,omitempty"` // Justification provides the justification when the state of the assessment if NOT_AFFECTED. Justification *AssessmentJustification `json:"justification,omitempty"` }
VexAssessment provides all publisher provided Vex information that is related to this vulnerability.
type DiscoveredAnalysisCompleted ¶
type DiscoveredAnalysisCompleted struct {
AnalysisType []string `json:"analysisType,omitempty"`
}
Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource.
type DiscoveredAnalysisStatus ¶
type DiscoveredAnalysisStatus string
DiscoveredAnalysisStatus : Analysis status for a resource. Currently for initial analysis only (not updated in continuous analysis). - ANALYSIS_STATUS_UNSPECIFIED: Unknown. - PENDING: Resource is known but no action has been taken yet. - SCANNING: Resource is being analyzed. - FINISHED_SUCCESS: Analysis has finished successfully. - COMPLETE: Analysis has completed. - FINISHED_FAILED: Analysis has finished unsuccessfully, the analysis itself is in a bad state. - FINISHED_UNSUPPORTED: The resource is known not to be supported
const ( ANALYSIS_STATUS_UNSPECIFIED_DiscoveredAnalysisStatus DiscoveredAnalysisStatus = "ANALYSIS_STATUS_UNSPECIFIED" PENDING_DiscoveredAnalysisStatus DiscoveredAnalysisStatus = "PENDING" SCANNING_DiscoveredAnalysisStatus DiscoveredAnalysisStatus = "SCANNING" FINISHED_SUCCESS_DiscoveredAnalysisStatus DiscoveredAnalysisStatus = "FINISHED_SUCCESS" COMPLETE_DiscoveredAnalysisStatus DiscoveredAnalysisStatus = "COMPLETE" FINISHED_FAILED_DiscoveredAnalysisStatus DiscoveredAnalysisStatus = "FINISHED_FAILED" FINISHED_UNSUPPORTED_DiscoveredAnalysisStatus DiscoveredAnalysisStatus = "FINISHED_UNSUPPORTED" )
List of DiscoveredAnalysisStatus
type DiscoveredContinuousAnalysis ¶
type DiscoveredContinuousAnalysis string
DiscoveredContinuousAnalysis : Whether the resource is continuously analyzed. - CONTINUOUS_ANALYSIS_UNSPECIFIED: Unknown. - ACTIVE: The resource is continuously analyzed. - INACTIVE: The resource is ignored for continuous analysis.
const ( CONTINUOUS_ANALYSIS_UNSPECIFIED_DiscoveredContinuousAnalysis DiscoveredContinuousAnalysis = "CONTINUOUS_ANALYSIS_UNSPECIFIED" ACTIVE_DiscoveredContinuousAnalysis DiscoveredContinuousAnalysis = "ACTIVE" INACTIVE_DiscoveredContinuousAnalysis DiscoveredContinuousAnalysis = "INACTIVE" )
List of DiscoveredContinuousAnalysis
type DiscoveryDiscovered ¶
type DiscoveryDiscovered struct { // Whether the resource is continuously analyzed. ContinuousAnalysis *DiscoveredContinuousAnalysis `json:"continuousAnalysis,omitempty"` // The last time continuous analysis was done for this resource. Deprecated, do not use. LastAnalysisTime time.Time `json:"lastAnalysisTime,omitempty"` // The status of discovery for the resource. AnalysisStatus *DiscoveredAnalysisStatus `json:"analysisStatus,omitempty"` AnalysisCompleted *DiscoveredAnalysisCompleted `json:"analysisCompleted,omitempty"` // Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors. AnalysisError []RpcStatus `json:"analysisError,omitempty"` // When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API. AnalysisStatusError *RpcStatus `json:"analysisStatusError,omitempty"` }
Provides information about the analysis status of a discovered resource.
type DiscoveryDiscovery ¶
type DiscoveryDiscovery struct { // Required. Immutable. The kind of analysis that is handled by this discovery. AnalysisKind *V1beta1NoteKind `json:"analysisKind,omitempty"` }
A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis.
type ExternalRefCategory ¶
type ExternalRefCategory string
ExternalRefCategory : - CATEGORY_UNSPECIFIED: Unspecified - SECURITY: Security (e.g. cpe22Type, cpe23Type) - PACKAGE_MANAGER: Package Manager (e.g. maven-central, npm, nuget, bower, purl) - PERSISTENT_ID: Persistent-Id (e.g. swh) - OTHER: Other
const ( CATEGORY_UNSPECIFIED_ExternalRefCategory ExternalRefCategory = "CATEGORY_UNSPECIFIED" SECURITY_ExternalRefCategory ExternalRefCategory = "SECURITY" PACKAGE_MANAGER_ExternalRefCategory ExternalRefCategory = "PACKAGE_MANAGER" PERSISTENT_ID_ExternalRefCategory ExternalRefCategory = "PERSISTENT_ID" OTHER_ExternalRefCategory ExternalRefCategory = "OTHER" )
List of ExternalRefCategory
type FileNoteFileType ¶
type FileNoteFileType string
FileNoteFileType : - FILE_TYPE_UNSPECIFIED: Unspecified - SOURCE: The file is human readable source code (.c, .html, etc.) - BINARY: The file is a compiled object, target image or binary executable (.o, .a, etc.) - ARCHIVE: The file represents an archive (.tar, .jar, etc.) - APPLICATION: The file is associated with a specific application type (MIME type of application/_*) - AUDIO: The file is associated with an audio file (MIME type of audio/_* , e.g. .mp3) - IMAGE: The file is associated with an picture image file (MIME type of image/_*, e.g., .jpg, .gif) - TEXT: The file is human readable text file (MIME type of text/_*) - VIDEO: The file is associated with a video file type (MIME type of video/_*) - DOCUMENTATION: The file serves as documentation - SPDX: The file is an SPDX document - OTHER: The file doesn't fit into the above categories (generated artifacts, data files, etc.)
const ( FILE_TYPE_UNSPECIFIED_FileNoteFileType FileNoteFileType = "FILE_TYPE_UNSPECIFIED" SOURCE_FileNoteFileType FileNoteFileType = "SOURCE" BINARY_FileNoteFileType FileNoteFileType = "BINARY" ARCHIVE_FileNoteFileType FileNoteFileType = "ARCHIVE" APPLICATION_FileNoteFileType FileNoteFileType = "APPLICATION" AUDIO_FileNoteFileType FileNoteFileType = "AUDIO" IMAGE_FileNoteFileType FileNoteFileType = "IMAGE" TEXT_FileNoteFileType FileNoteFileType = "TEXT" VIDEO_FileNoteFileType FileNoteFileType = "VIDEO" DOCUMENTATION_FileNoteFileType FileNoteFileType = "DOCUMENTATION" SPDX_FileNoteFileType FileNoteFileType = "SPDX" OTHER_FileNoteFileType FileNoteFileType = "OTHER" )
List of FileNoteFileType
type GenericSwaggerError ¶
type GenericSwaggerError struct {
// contains filtered or unexported fields
}
GenericSwaggerError Provides access to the body, error and model on returned errors.
func (GenericSwaggerError) Body ¶
func (e GenericSwaggerError) Body() []byte
Body returns the raw bytes of the response
func (GenericSwaggerError) Error ¶
func (e GenericSwaggerError) Error() string
Error returns non-empty string if there was an error.
func (GenericSwaggerError) Model ¶
func (e GenericSwaggerError) Model() interface{}
Model returns the unpacked model of the error
type GrafeasV1Beta1ApiService ¶
type GrafeasV1Beta1ApiService service
func (*GrafeasV1Beta1ApiService) GrafeasV1Beta1BatchCreateNotes ¶
func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1BatchCreateNotes(ctx context.Context, parent string, body Body) (V1beta1BatchCreateNotesResponse, *http.Response, error)
GrafeasV1Beta1ApiService Creates new notes in batch.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param parent The name of the project in the form of `projects/[PROJECT_ID]`, under which the notes are to be created.
- @param body
@return V1beta1BatchCreateNotesResponse
func (*GrafeasV1Beta1ApiService) GrafeasV1Beta1BatchCreateOccurrences ¶
func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1BatchCreateOccurrences(ctx context.Context, parent string, body Body1) (V1beta1BatchCreateOccurrencesResponse, *http.Response, error)
GrafeasV1Beta1ApiService Creates new occurrences in batch.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param parent The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrences are to be created.
- @param body
@return V1beta1BatchCreateOccurrencesResponse
func (*GrafeasV1Beta1ApiService) GrafeasV1Beta1CreateNote ¶
func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1CreateNote(ctx context.Context, parent string, body V1beta1Note, noteId string) (V1beta1Note, *http.Response, error)
GrafeasV1Beta1ApiService Creates a new note.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param parent The name of the project in the form of `projects/[PROJECT_ID]`, under which the note is to be created.
- @param body The note to create.
- @param noteId The ID to use for this note.
@return V1beta1Note
func (*GrafeasV1Beta1ApiService) GrafeasV1Beta1CreateOccurrence ¶
func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1CreateOccurrence(ctx context.Context, parent string, body V1beta1Occurrence) (V1beta1Occurrence, *http.Response, error)
GrafeasV1Beta1ApiService Creates a new occurrence.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param parent The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrence is to be created.
- @param body The occurrence to create.
@return V1beta1Occurrence
func (*GrafeasV1Beta1ApiService) GrafeasV1Beta1DeleteNote ¶
func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1DeleteNote(ctx context.Context, name1 string) (interface{}, *http.Response, error)
GrafeasV1Beta1ApiService Deletes the specified note.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name1 The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
@return interface{}
func (*GrafeasV1Beta1ApiService) GrafeasV1Beta1DeleteOccurrence ¶
func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1DeleteOccurrence(ctx context.Context, name string) (interface{}, *http.Response, error)
GrafeasV1Beta1ApiService Deletes the specified occurrence. For example, use this method to delete an occurrence when the occurrence is no longer applicable for the given resource.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
@return interface{}
func (*GrafeasV1Beta1ApiService) GrafeasV1Beta1GetNote ¶
func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1GetNote(ctx context.Context, name1 string) (V1beta1Note, *http.Response, error)
GrafeasV1Beta1ApiService Gets the specified note.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name1 The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
@return V1beta1Note
func (*GrafeasV1Beta1ApiService) GrafeasV1Beta1GetOccurrence ¶
func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1GetOccurrence(ctx context.Context, name string) (V1beta1Occurrence, *http.Response, error)
GrafeasV1Beta1ApiService Gets the specified occurrence.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
@return V1beta1Occurrence
func (*GrafeasV1Beta1ApiService) GrafeasV1Beta1GetOccurrenceNote ¶
func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1GetOccurrenceNote(ctx context.Context, name string) (V1beta1Note, *http.Response, error)
GrafeasV1Beta1ApiService Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
@return V1beta1Note
func (*GrafeasV1Beta1ApiService) GrafeasV1Beta1GetVulnerabilityOccurrencesSummary ¶
func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1GetVulnerabilityOccurrencesSummary(ctx context.Context, parent string, localVarOptionals *GrafeasV1Beta1ApiGrafeasV1Beta1GetVulnerabilityOccurrencesSummaryOpts) (V1beta1VulnerabilityOccurrencesSummary, *http.Response, error)
func (*GrafeasV1Beta1ApiService) GrafeasV1Beta1ListNoteOccurrences ¶
func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1ListNoteOccurrences(ctx context.Context, name string, localVarOptionals *GrafeasV1Beta1ApiGrafeasV1Beta1ListNoteOccurrencesOpts) (V1beta1ListNoteOccurrencesResponse, *http.Response, error)
func (*GrafeasV1Beta1ApiService) GrafeasV1Beta1ListNotes ¶
func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1ListNotes(ctx context.Context, parent string, localVarOptionals *GrafeasV1Beta1ApiGrafeasV1Beta1ListNotesOpts) (V1beta1ListNotesResponse, *http.Response, error)
func (*GrafeasV1Beta1ApiService) GrafeasV1Beta1ListOccurrences ¶
func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1ListOccurrences(ctx context.Context, parent string, localVarOptionals *GrafeasV1Beta1ApiGrafeasV1Beta1ListOccurrencesOpts) (V1beta1ListOccurrencesResponse, *http.Response, error)
func (*GrafeasV1Beta1ApiService) GrafeasV1Beta1UpdateNote ¶
func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1UpdateNote(ctx context.Context, name1 string, body V1beta1Note, localVarOptionals *GrafeasV1Beta1ApiGrafeasV1Beta1UpdateNoteOpts) (V1beta1Note, *http.Response, error)
func (*GrafeasV1Beta1ApiService) GrafeasV1Beta1UpdateOccurrence ¶
func (a *GrafeasV1Beta1ApiService) GrafeasV1Beta1UpdateOccurrence(ctx context.Context, name string, body V1beta1Occurrence, localVarOptionals *GrafeasV1Beta1ApiGrafeasV1Beta1UpdateOccurrenceOpts) (V1beta1Occurrence, *http.Response, error)
type Grafeasv1beta1Signature ¶
type Grafeasv1beta1Signature struct { // The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload. Signature string `json:"signature,omitempty"` // The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * \"openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA\" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * \"ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU\" * \"nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5\" PublicKeyId string `json:"publicKeyId,omitempty"` }
Verifiers (e.g. Kritis implementations) MUST verify signatures with respect to the trust anchors defined in policy (e.g. a Kritis policy). Typically this means that the verifier has been configured with a map from `public_key_id` to public key material (and any required parameters, e.g. signing algorithm). In particular, verification implementations MUST NOT treat the signature `public_key_id` as anything more than a key lookup hint. The `public_key_id` DOES NOT validate or authenticate a public key; it only provides a mechanism for quickly selecting a public key ALREADY CONFIGURED on the verifier through a trusted channel. Verification implementations MUST reject signatures in any of the following circumstances: * The `public_key_id` is not recognized by the verifier. * The public key that `public_key_id` refers to does not verify the signature with respect to the payload. The `signature` contents SHOULD NOT be \"attached\" (where the payload is included with the serialized `signature` bytes). Verifiers MUST ignore any \"attached\" payload and only verify signatures with respect to explicitly provided payload (e.g. a `payload` field on the proto message that holds this Signature, or the canonical serialization of the proto message that holds this signature).
type HashHashType ¶
type HashHashType string
HashHashType : Specifies the hash algorithm. - HASH_TYPE_UNSPECIFIED: Unknown. - SHA256: A SHA-256 hash.
const ( HASH_TYPE_UNSPECIFIED_HashHashType HashHashType = "HASH_TYPE_UNSPECIFIED" SHA256_HashHashType HashHashType = "SHA256" )
List of HashHashType
type ImageBasis ¶
type ImageBasis struct { // Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images. ResourceUrl string `json:"resourceUrl,omitempty"` // Required. Immutable. The fingerprint of the base image. Fingerprint *ImageFingerprint `json:"fingerprint,omitempty"` }
Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM <Basis.resource_url> Or an equivalent reference, e.g. a tag of the resource_url.
type ImageDerived ¶
type ImageDerived struct { // Required. The fingerprint of the derived image. Fingerprint *ImageFingerprint `json:"fingerprint,omitempty"` // Output only. The number of layers by which this image differs from the associated image basis. Distance int32 `json:"distance,omitempty"` // This contains layer-specific metadata, if populated it has length \"distance\" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer. LayerInfo []ImageLayer `json:"layerInfo,omitempty"` // Output only. This contains the base image URL for the derived image occurrence. BaseResourceUrl string `json:"baseResourceUrl,omitempty"` }
Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM <DockerImage.Basis in attached Note>.
type ImageFingerprint ¶
type ImageFingerprint struct { // Required. The layer ID of the final layer in the Docker image's v1 representation. V1Name string `json:"v1Name,omitempty"` // Required. The ordered list of v2 blobs that represent a given image. V2Blob []string `json:"v2Blob,omitempty"` // Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blob[bottom] [N] := sha256(v2_blob[N] + \" \" + v2_name[N+1]) Only the name of the final blob is kept. V2Name string `json:"v2Name,omitempty"` }
A set of properties that uniquely identify a given Docker image.
type ImageLayer ¶
type ImageLayer struct { // Required. The recovered Dockerfile directive used to construct this layer. Directive *LayerDirective `json:"directive,omitempty"` // The recovered arguments to the Dockerfile directive. Arguments string `json:"arguments,omitempty"` }
Layer holds metadata specific to a layer of a Docker image.
type InTotoArtifactRule ¶
type InTotoArtifactRule struct {
ArtifactRule []string `json:"artifactRule,omitempty"`
}
type IntotoInToto ¶
type IntotoInToto struct { // This field identifies the name of the step in the supply chain. StepName string `json:"stepName,omitempty"` // This field contains the public keys that can be used to verify the signatures on the step metadata. SigningKeys []IntotoSigningKey `json:"signingKeys,omitempty"` // The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step. ExpectedMaterials []InTotoArtifactRule `json:"expectedMaterials,omitempty"` ExpectedProducts []InTotoArtifactRule `json:"expectedProducts,omitempty"` // This field contains the expected command used to perform the step. ExpectedCommand []string `json:"expectedCommand,omitempty"` // This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link. Threshold string `json:"threshold,omitempty"` }
This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note.
type IntotoLink ¶
type IntotoLink struct { Command []string `json:"command,omitempty"` Materials []IntotoLinkArtifact `json:"materials,omitempty"` // Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials. Products []IntotoLinkArtifact `json:"products,omitempty"` // ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step. Byproducts *LinkByProducts `json:"byproducts,omitempty"` Environment *LinkEnvironment `json:"environment,omitempty"` }
This corresponds to an in-toto link.
type IntotoLinkArtifact ¶
type IntotoLinkArtifact struct { ResourceUri string `json:"resourceUri,omitempty"` Hashes *LinkArtifactHashes `json:"hashes,omitempty"` }
type IntotoSigningKey ¶
type IntotoSigningKey struct { // key_id is an identifier for the signing key. KeyId string `json:"keyId,omitempty"` // This field identifies the specific signing method. Eg: \"rsa\", \"ed25519\", and \"ecdsa\". KeyType string `json:"keyType,omitempty"` // This field contains the actual public key. PublicKeyValue string `json:"publicKeyValue,omitempty"` // This field contains the corresponding signature scheme. Eg: \"rsassa-pss-sha256\". KeyScheme string `json:"keyScheme,omitempty"` }
This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { \"key_id\": \"776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...\", \"key_type\": \"rsa\", \"public_key_value\": \"-----BEGIN PUBLIC KEY-----\\nMIIBojANBgkqhkiG9w0B...\", \"key_scheme\": \"rsassa-pss-sha256\" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification.
type JustificationJustificationType ¶
type JustificationJustificationType string
JustificationJustificationType : Provides the type of justification. - JUSTIFICATION_TYPE_UNSPECIFIED: JUSTIFICATION_TYPE_UNSPECIFIED. - COMPONENT_NOT_PRESENT: The vulnerable component is not present in the product. - VULNERABLE_CODE_NOT_PRESENT: The vulnerable code is not present. Typically this case occurs when source code is configured or built in a way that excludes the vulnerable code. - VULNERABLE_CODE_NOT_IN_EXECUTE_PATH: The vulnerable code can not be executed. Typically this case occurs when the product includes the vulnerable code but does not call or use the vulnerable code. - VULNERABLE_CODE_CANNOT_BE_CONTROLLED_BY_ADVERSARY: The vulnerable code cannot be controlled by an attacker to exploit the vulnerability. - INLINE_MITIGATIONS_ALREADY_EXIST: The product includes built-in protections or features that prevent exploitation of the vulnerability. These built-in protections cannot be subverted by the attacker and cannot be configured or disabled by the user. These mitigations completely prevent exploitation based on known attack vectors.
const ( JUSTIFICATION_TYPE_UNSPECIFIED_JustificationJustificationType JustificationJustificationType = "JUSTIFICATION_TYPE_UNSPECIFIED" COMPONENT_NOT_PRESENT_JustificationJustificationType JustificationJustificationType = "COMPONENT_NOT_PRESENT" VULNERABLE_CODE_NOT_PRESENT_JustificationJustificationType JustificationJustificationType = "VULNERABLE_CODE_NOT_PRESENT" VULNERABLE_CODE_NOT_IN_EXECUTE_PATH_JustificationJustificationType JustificationJustificationType = "VULNERABLE_CODE_NOT_IN_EXECUTE_PATH" VULNERABLE_CODE_CANNOT_BE_CONTROLLED_BY_ADVERSARY_JustificationJustificationType JustificationJustificationType = "VULNERABLE_CODE_CANNOT_BE_CONTROLLED_BY_ADVERSARY" INLINE_MITIGATIONS_ALREADY_EXIST_JustificationJustificationType JustificationJustificationType = "INLINE_MITIGATIONS_ALREADY_EXIST" )
List of JustificationJustificationType
type LayerDirective ¶
type LayerDirective string
LayerDirective : Instructions from Dockerfile. - DIRECTIVE_UNSPECIFIED: Default value for unsupported/missing directive. - MAINTAINER: https://docs.docker.com/engine/reference/builder/ - RUN: https://docs.docker.com/engine/reference/builder/ - CMD: https://docs.docker.com/engine/reference/builder/ - LABEL: https://docs.docker.com/engine/reference/builder/ - EXPOSE: https://docs.docker.com/engine/reference/builder/ - ENV: https://docs.docker.com/engine/reference/builder/ - ADD: https://docs.docker.com/engine/reference/builder/ - COPY: https://docs.docker.com/engine/reference/builder/ - ENTRYPOINT: https://docs.docker.com/engine/reference/builder/ - VOLUME: https://docs.docker.com/engine/reference/builder/ - USER: https://docs.docker.com/engine/reference/builder/ - WORKDIR: https://docs.docker.com/engine/reference/builder/ - ARG: https://docs.docker.com/engine/reference/builder/ - ONBUILD: https://docs.docker.com/engine/reference/builder/ - STOPSIGNAL: https://docs.docker.com/engine/reference/builder/ - HEALTHCHECK: https://docs.docker.com/engine/reference/builder/ - SHELL: https://docs.docker.com/engine/reference/builder/
const ( DIRECTIVE_UNSPECIFIED_LayerDirective LayerDirective = "DIRECTIVE_UNSPECIFIED" MAINTAINER_LayerDirective LayerDirective = "MAINTAINER" RUN_LayerDirective LayerDirective = "RUN" CMD_LayerDirective LayerDirective = "CMD" LABEL_LayerDirective LayerDirective = "LABEL" EXPOSE_LayerDirective LayerDirective = "EXPOSE" ENV_LayerDirective LayerDirective = "ENV" ADD_LayerDirective LayerDirective = "ADD" COPY_LayerDirective LayerDirective = "COPY" ENTRYPOINT_LayerDirective LayerDirective = "ENTRYPOINT" VOLUME_LayerDirective LayerDirective = "VOLUME" USER_LayerDirective LayerDirective = "USER" WORKDIR_LayerDirective LayerDirective = "WORKDIR" ARG_LayerDirective LayerDirective = "ARG" ONBUILD_LayerDirective LayerDirective = "ONBUILD" STOPSIGNAL_LayerDirective LayerDirective = "STOPSIGNAL" HEALTHCHECK_LayerDirective LayerDirective = "HEALTHCHECK" SHELL_LayerDirective LayerDirective = "SHELL" )
List of LayerDirective
type LinkArtifactHashes ¶
type LinkArtifactHashes struct {
Sha256 string `json:"sha256,omitempty"`
}
Defines a hash object for use in Materials and Products.
type LinkByProducts ¶
Defines an object for the byproducts field in in-toto links. The suggested fields are \"stderr\", \"stdout\", and \"return-value\".
type LinkEnvironment ¶
Defines an object for the environment field in in-toto links. The suggested fields are \"variables\", \"filesystem\", and \"workdir\".
type PackageArchitecture ¶
type PackageArchitecture string
PackageArchitecture : Instruction set architectures supported by various package managers. - ARCHITECTURE_UNSPECIFIED: Unknown architecture. - X86: X86 architecture. - X64: X64 architecture.
const ( ARCHITECTURE_UNSPECIFIED_PackageArchitecture PackageArchitecture = "ARCHITECTURE_UNSPECIFIED" X86_PackageArchitecture PackageArchitecture = "X86" X64_PackageArchitecture PackageArchitecture = "X64" )
List of packageArchitecture
type PackageDistribution ¶
type PackageDistribution struct { // The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. CpeUri string `json:"cpeUri"` // The CPU architecture for which packages in this distribution channel were built. Architecture *PackageArchitecture `json:"architecture,omitempty"` // The latest available version of this package in this distribution channel. LatestVersion *PackageVersion `json:"latestVersion,omitempty"` // A freeform string denoting the maintainer of this package. Maintainer string `json:"maintainer,omitempty"` // The distribution channel-specific homepage for this package. Url string `json:"url,omitempty"` // The distribution channel-specific description of this package. Description string `json:"description,omitempty"` }
This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.
type PackageInfoNoteExternalRef ¶
type PackageInfoNoteExternalRef struct { Category *ExternalRefCategory `json:"category,omitempty"` Type_ string `json:"type,omitempty"` Locator string `json:"locator,omitempty"` Comment string `json:"comment,omitempty"` }
type PackageInstallation ¶
type PackageInstallation struct { // The name of the installed package. Name string `json:"name"` // All of the places within the filesystem versions of this package have been found. Location []V1beta1packageLocation `json:"location,omitempty"` // The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.). PackageType string `json:"packageType,omitempty"` // The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. The cpe_uri will be blank for language packages. CpeUri string `json:"cpeUri,omitempty"` // The CPU architecture for which packages in this distribution channel were built. Architecture will be blank for language packages. Architecture *PackageArchitecture `json:"architecture,omitempty"` // Licenses that have been declared by the authors of the package. License *V1beta1License `json:"license,omitempty"` // The version of the package. Version *PackageVersion `json:"version,omitempty"` }
This represents how a particular software package may be installed on a system.
type PackagePackage ¶
type PackagePackage struct { // The name of the package. Name string `json:"name"` // The various channels by which a package is distributed. Distribution []PackageDistribution `json:"distribution,omitempty"` // The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.). PackageType string `json:"packageType,omitempty"` // The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. The cpe_uri will be blank for language packages. CpeUri string `json:"cpeUri,omitempty"` // The CPU architecture for which packages in this distribution channel were built. Architecture will be blank for language packages. Architecture *PackageArchitecture `json:"architecture,omitempty"` // The version of the package. Version *PackageVersion `json:"version,omitempty"` // A freeform text denoting the maintainer of this package. Maintainer string `json:"maintainer,omitempty"` // The homepage for this package. Url string `json:"url,omitempty"` // The description of this package. Description string `json:"description,omitempty"` // Licenses that have been declared by the authors of the package. License *V1beta1License `json:"license,omitempty"` // Hash value, typically a file digest, that allows unique identification a specific package. Digest []V1beta1Digest `json:"digest,omitempty"` }
Package represents a particular package version.
type PackageVersion ¶
type PackageVersion struct { // Used to correct mistakes in the version numbering scheme. Epoch int32 `json:"epoch,omitempty"` // Required only when version kind is NORMAL. The main part of the version name. Name string `json:"name,omitempty"` // The iteration of the package build from the above version. Revision string `json:"revision,omitempty"` // Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range. Inclusive bool `json:"inclusive,omitempty"` // Required. Distinguishes between sentinel MIN/MAX versions and normal versions. Kind *VersionVersionKind `json:"kind,omitempty"` }
Version contains structured information about the version of a package.
type ProtobufAny ¶
type ProtobufAny struct { // A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics. Type_ string `json:"@type,omitempty"` }
`Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := ptypes.MarshalAny(foo) ... foo := &pb.Foo{} if err := ptypes.UnmarshalAny(any, foo); err != nil { ... } The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example \"foo.bar.com/x/y.z\" will yield type name \"y.z\". JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { \"@type\": \"type.googleapis.com/google.profile.Person\", \"firstName\": <string>, \"lastName\": <string> } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]): { \"@type\": \"type.googleapis.com/google.protobuf.Duration\", \"value\": \"1.212s\" }
type ProvenanceBuildProvenance ¶
type ProvenanceBuildProvenance struct { // Required. Unique identifier of the build. Id string `json:"id,omitempty"` // ID of the project. ProjectId string `json:"projectId,omitempty"` // Commands requested by the build. Commands []ProvenanceCommand `json:"commands,omitempty"` // Output of the build. BuiltArtifacts []V1beta1provenanceArtifact `json:"builtArtifacts,omitempty"` // Time at which the build was created. CreateTime time.Time `json:"createTime,omitempty"` // Time at which execution of the build was started. StartTime time.Time `json:"startTime,omitempty"` // Time at which execution of the build was finished. EndTime time.Time `json:"endTime,omitempty"` // E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time. Creator string `json:"creator,omitempty"` // URI where any logs for this provenance were written. LogsUri string `json:"logsUri,omitempty"` // Details of the Source input to the build. SourceProvenance *ProvenanceSource `json:"sourceProvenance,omitempty"` // Trigger identifier if the build was triggered automatically; empty if not. TriggerId string `json:"triggerId,omitempty"` // Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details. BuildOptions map[string]string `json:"buildOptions,omitempty"` // Version string of the builder at the time this build was executed. BuilderVersion string `json:"builderVersion,omitempty"` }
Provenance of a build. Contains all information needed to verify the full details about the build from source to completion.
type ProvenanceCommand ¶
type ProvenanceCommand struct { // Required. Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`. Name string `json:"name,omitempty"` // Environment variables set before running this command. Env []string `json:"env,omitempty"` // Command-line arguments used when executing this command. Args []string `json:"args,omitempty"` // Working directory (relative to project source root) used when running this command. Dir string `json:"dir,omitempty"` // Optional unique identifier for this command, used in wait_for to reference this command as a dependency. Id string `json:"id,omitempty"` // The ID(s) of the command(s) that this command depends on. WaitFor []string `json:"waitFor,omitempty"` }
Command describes a step performed as part of the build pipeline.
type ProvenanceFileHashes ¶
type ProvenanceFileHashes struct { // Required. Collection of file hashes. FileHash []ProvenanceHash `json:"fileHash,omitempty"` }
Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build.
type ProvenanceHash ¶
type ProvenanceHash struct { // Required. The type of hash that was performed. Type_ *HashHashType `json:"type,omitempty"` // Required. The hash value. Value string `json:"value,omitempty"` }
Container message for hash values.
type ProvenanceSource ¶
type ProvenanceSource struct { // If provided, the input binary artifacts for the build came from this location. ArtifactStorageSourceUri string `json:"artifactStorageSourceUri,omitempty"` // Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file. FileHashes map[string]ProvenanceFileHashes `json:"fileHashes,omitempty"` // If provided, the source code used for the build came from this location. Context *SourceSourceContext `json:"context,omitempty"` // If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field. AdditionalContexts []SourceSourceContext `json:"additionalContexts,omitempty"` }
Source describes the location of the source used for the build.
type RemediationRemediationType ¶
type RemediationRemediationType string
RemediationRemediationType : The type of remediation that can be applied. - REMEDIATION_TYPE_UNSPECIFIED: No remediation type specified. - MITIGATION: A MITIGATION is available. - NO_FIX_PLANNED: No fix is planned. - NONE_AVAILABLE: Not available. - VENDOR_FIX: A vendor fix is available. - WORKAROUND: A workaround is available.
const ( REMEDIATION_TYPE_UNSPECIFIED_RemediationRemediationType RemediationRemediationType = "REMEDIATION_TYPE_UNSPECIFIED" MITIGATION_RemediationRemediationType RemediationRemediationType = "MITIGATION" NO_FIX_PLANNED_RemediationRemediationType RemediationRemediationType = "NO_FIX_PLANNED" NONE_AVAILABLE_RemediationRemediationType RemediationRemediationType = "NONE_AVAILABLE" VENDOR_FIX_RemediationRemediationType RemediationRemediationType = "VENDOR_FIX" WORKAROUND_RemediationRemediationType RemediationRemediationType = "WORKAROUND" )
List of RemediationRemediationType
type RpcStatus ¶
type RpcStatus struct { // The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. Code int32 `json:"code,omitempty"` // A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. Message string `json:"message,omitempty"` // A list of messages that carry the error details. There is a common set of message types for APIs to use. Details []ProtobufAny `json:"details,omitempty"` }
- Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][google.rpc.Code], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.
type SourceAliasContext ¶
type SourceAliasContext struct { // The alias kind. Kind *AliasContextKind `json:"kind,omitempty"` // The alias name. Name string `json:"name,omitempty"` }
An alias to a repo revision.
type SourceCloudRepoSourceContext ¶
type SourceCloudRepoSourceContext struct { // The ID of the repo. RepoId *SourceRepoId `json:"repoId,omitempty"` // A revision ID. RevisionId string `json:"revisionId,omitempty"` // An alias, which may be a branch or tag. AliasContext *SourceAliasContext `json:"aliasContext,omitempty"` }
A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo.
type SourceGerritSourceContext ¶
type SourceGerritSourceContext struct { // The URI of a running Gerrit instance. HostUri string `json:"hostUri,omitempty"` // The full project name within the host. Projects may be nested, so \"project/subproject\" is a valid project name. The \"repo name\" is the hostURI/project. GerritProject string `json:"gerritProject,omitempty"` // A revision (commit) ID. RevisionId string `json:"revisionId,omitempty"` // An alias, which may be a branch or tag. AliasContext *SourceAliasContext `json:"aliasContext,omitempty"` }
A SourceContext referring to a Gerrit project.
type SourceGitSourceContext ¶
type SourceGitSourceContext struct { // Git repository URL. Url string `json:"url,omitempty"` // Git commit hash. RevisionId string `json:"revisionId,omitempty"` }
A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub).
type SourceProjectRepoId ¶
type SourceProjectRepoId struct { // The ID of the project. ProjectId string `json:"projectId,omitempty"` // The name of the repo. Leave empty for the default repo. RepoName string `json:"repoName,omitempty"` }
Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project.
type SourceRepoId ¶
type SourceRepoId struct { // A combination of a project ID and a repo name. ProjectRepoId *SourceProjectRepoId `json:"projectRepoId,omitempty"` // A server-assigned, globally unique identifier. Uid string `json:"uid,omitempty"` }
A unique identifier for a Cloud Repo.
type SourceSourceContext ¶
type SourceSourceContext struct { // A SourceContext referring to a revision in a Google Cloud Source Repo. CloudRepo *SourceCloudRepoSourceContext `json:"cloudRepo,omitempty"` // A SourceContext referring to a Gerrit project. Gerrit *SourceGerritSourceContext `json:"gerrit,omitempty"` // A SourceContext referring to any third party Git repo (e.g., GitHub). Git *SourceGitSourceContext `json:"git,omitempty"` // Labels with user defined metadata. Labels map[string]string `json:"labels,omitempty"` }
A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory.
type SpdxDocumentNote ¶
type SpdxDocumentOccurrence ¶
type SpdxDocumentOccurrence struct { Id string `json:"id,omitempty"` Title string `json:"title,omitempty"` Namespace string `json:"namespace,omitempty"` ExternalDocumentRefs []string `json:"externalDocumentRefs,omitempty"` LicenseListVersion string `json:"licenseListVersion,omitempty"` Creators []string `json:"creators,omitempty"` CreateTime time.Time `json:"createTime,omitempty"` CreatorComment string `json:"creatorComment,omitempty"` DocumentComment string `json:"documentComment,omitempty"` }
type SpdxFileNote ¶
type SpdxFileNote struct { Title string `json:"title,omitempty"` FileType *FileNoteFileType `json:"fileType,omitempty"` Checksum []string `json:"checksum,omitempty"` }
type SpdxFileOccurrence ¶
type SpdxFileOccurrence struct { Id string `json:"id,omitempty"` LicenseConcluded *V1beta1License `json:"licenseConcluded,omitempty"` FilesLicenseInfo []string `json:"filesLicenseInfo,omitempty"` Copyright string `json:"copyright,omitempty"` Comment string `json:"comment,omitempty"` Notice string `json:"notice,omitempty"` Contributors []string `json:"contributors,omitempty"` Attributions []string `json:"attributions,omitempty"` }
type SpdxPackageInfoNote ¶
type SpdxPackageInfoNote struct { Title string `json:"title,omitempty"` Version string `json:"version,omitempty"` Supplier string `json:"supplier,omitempty"` Originator string `json:"originator,omitempty"` DownloadLocation string `json:"downloadLocation,omitempty"` Analyzed bool `json:"analyzed,omitempty"` VerificationCode string `json:"verificationCode,omitempty"` Checksum string `json:"checksum,omitempty"` HomePage string `json:"homePage,omitempty"` FilesLicenseInfo []string `json:"filesLicenseInfo,omitempty"` LicenseDeclared *V1beta1License `json:"licenseDeclared,omitempty"` Copyright string `json:"copyright,omitempty"` SummaryDescription string `json:"summaryDescription,omitempty"` DetailedDescription string `json:"detailedDescription,omitempty"` ExternalRefs []PackageInfoNoteExternalRef `json:"externalRefs,omitempty"` Attribution string `json:"attribution,omitempty"` // The type of package: OS, MAVEN, GO, GO_STDLIB, etc. PackageType string `json:"packageType,omitempty"` }
type SpdxPackageInfoOccurrence ¶
type SpdxPackageInfoOccurrence struct { Id string `json:"id,omitempty"` Filename string `json:"filename,omitempty"` SourceInfo string `json:"sourceInfo,omitempty"` LicenseConcluded *V1beta1License `json:"licenseConcluded,omitempty"` Comment string `json:"comment,omitempty"` // The type of package: OS, MAVEN, GO, GO_STDLIB, etc. PackageType string `json:"packageType,omitempty"` Title string `json:"title,omitempty"` Version string `json:"version,omitempty"` HomePage string `json:"homePage,omitempty"` SummaryDescription string `json:"summaryDescription,omitempty"` }
type SpdxRelationshipNote ¶
type SpdxRelationshipNote struct {
Type_ *SpdxRelationshipType `json:"type,omitempty"`
}
type SpdxRelationshipOccurrence ¶
type SpdxRelationshipOccurrence struct { Source string `json:"source,omitempty"` Target string `json:"target,omitempty"` Type_ *SpdxRelationshipType `json:"type,omitempty"` Comment string `json:"comment,omitempty"` }
type SpdxRelationshipType ¶
type SpdxRelationshipType string
SpdxRelationshipType : - RELATIONSHIP_TYPE_UNSPECIFIED: Unspecified - DESCRIBES: Is to be used when SPDXRef-DOCUMENT describes SPDXRef-A - DESCRIBED_BY: Is to be used when SPDXRef-A is described by SPDXREF-Document - CONTAINS: Is to be used when SPDXRef-A contains SPDXRef-B - CONTAINED_BY: Is to be used when SPDXRef-A is contained by SPDXRef-B - DEPENDS_ON: Is to be used when SPDXRef-A depends on SPDXRef-B - DEPENDENCY_OF: Is to be used when SPDXRef-A is dependency of SPDXRef-B - DEPENDENCY_MANIFEST_OF: Is to be used when SPDXRef-A is a manifest file that lists a set of dependencies for SPDXRef-B - BUILD_DEPENDENCY_OF: Is to be used when SPDXRef-A is a build dependency of SPDXRef-B - DEV_DEPENDENCY_OF: Is to be used when SPDXRef-A is a development dependency of SPDXRef-B - OPTIONAL_DEPENDENCY_OF: Is to be used when SPDXRef-A is an optional dependency of SPDXRef-B - PROVIDED_DEPENDENCY_OF: Is to be used when SPDXRef-A is a to be provided dependency of SPDXRef-B - TEST_DEPENDENCY_OF: Is to be used when SPDXRef-A is a test dependency of SPDXRef-B - RUNTIME_DEPENDENCY_OF: Is to be used when SPDXRef-A is a dependency required for the execution of SPDXRef-B - EXAMPLE_OF: Is to be used when SPDXRef-A is an example of SPDXRef-B - GENERATES: Is to be used when SPDXRef-A generates SPDXRef-B - GENERATED_FROM: Is to be used when SPDXRef-A was generated from SPDXRef-B - ANCESTOR_OF: Is to be used when SPDXRef-A is an ancestor (same lineage but pre-dates) SPDXRef-B - DESCENDANT_OF: Is to be used when SPDXRef-A is a descendant of (same lineage but postdates) SPDXRef-B - VARIANT_OF: Is to be used when SPDXRef-A is a variant of (same lineage but not clear which came first) SPDXRef-B - DISTRIBUTION_ARTIFACT: Is to be used when distributing SPDXRef-A requires that SPDXRef-B also be distributed - PATCH_FOR: Is to be used when SPDXRef-A is a patch file for (to be applied to) SPDXRef-B - PATCH_APPLIED: Is to be used when SPDXRef-A is a patch file that has been applied to SPDXRef-B - COPY_OF: Is to be used when SPDXRef-A is an exact copy of SPDXRef-B - FILE_ADDED: Is to be used when SPDXRef-A is a file that was added to SPDXRef-B - FILE_DELETED: Is to be used when SPDXRef-A is a file that was deleted from SPDXRef-B - FILE_MODIFIED: Is to be used when SPDXRef-A is a file that was modified from SPDXRef-B - EXPANDED_FROM_ARCHIVE: Is to be used when SPDXRef-A is expanded from the archive SPDXRef-B - DYNAMIC_LINK: Is to be used when SPDXRef-A dynamically links to SPDXRef-B - STATIC_LINK: Is to be used when SPDXRef-A statically links to SPDXRef-B - DATA_FILE_OF: Is to be used when SPDXRef-A is a data file used in SPDXRef-B - TEST_CASE_OF: Is to be used when SPDXRef-A is a test case used in testing SPDXRef-B - BUILD_TOOL_OF: Is to be used when SPDXRef-A is used to build SPDXRef-B - DEV_TOOL_OF: Is to be used when SPDXRef-A is used as a development tool for SPDXRef-B - TEST_OF: Is to be used when SPDXRef-A is used for testing SPDXRef-B - TEST_TOOL_OF: Is to be used when SPDXRef-A is used as a test tool for SPDXRef-B - DOCUMENTATION_OF: Is to be used when SPDXRef-A provides documentation of SPDXRef-B - OPTIONAL_COMPONENT_OF: Is to be used when SPDXRef-A is an optional component of SPDXRef-B - METAFILE_OF: Is to be used when SPDXRef-A is a metafile of SPDXRef-B - PACKAGE_OF: Is to be used when SPDXRef-A is used as a package as part of SPDXRef-B - AMENDS: Is to be used when (current) SPDXRef-DOCUMENT amends the SPDX information in SPDXRef-B - PREREQUISITE_FOR: Is to be used when SPDXRef-A is a prerequisite for SPDXRef-B - HAS_PREREQUISITE: Is to be used when SPDXRef-A has as a prerequisite SPDXRef-B - OTHER: Is to be used for a relationship which has not been defined in the formal SPDX specification. A description of the relationship should be included in the Relationship comments field
const ( RELATIONSHIP_TYPE_UNSPECIFIED_SpdxRelationshipType SpdxRelationshipType = "RELATIONSHIP_TYPE_UNSPECIFIED" DESCRIBES_SpdxRelationshipType SpdxRelationshipType = "DESCRIBES" DESCRIBED_BY_SpdxRelationshipType SpdxRelationshipType = "DESCRIBED_BY" CONTAINS_SpdxRelationshipType SpdxRelationshipType = "CONTAINS" CONTAINED_BY_SpdxRelationshipType SpdxRelationshipType = "CONTAINED_BY" DEPENDS_ON_SpdxRelationshipType SpdxRelationshipType = "DEPENDS_ON" DEPENDENCY_OF_SpdxRelationshipType SpdxRelationshipType = "DEPENDENCY_OF" DEPENDENCY_MANIFEST_OF_SpdxRelationshipType SpdxRelationshipType = "DEPENDENCY_MANIFEST_OF" BUILD_DEPENDENCY_OF_SpdxRelationshipType SpdxRelationshipType = "BUILD_DEPENDENCY_OF" DEV_DEPENDENCY_OF_SpdxRelationshipType SpdxRelationshipType = "DEV_DEPENDENCY_OF" OPTIONAL_DEPENDENCY_OF_SpdxRelationshipType SpdxRelationshipType = "OPTIONAL_DEPENDENCY_OF" PROVIDED_DEPENDENCY_OF_SpdxRelationshipType SpdxRelationshipType = "PROVIDED_DEPENDENCY_OF" TEST_DEPENDENCY_OF_SpdxRelationshipType SpdxRelationshipType = "TEST_DEPENDENCY_OF" RUNTIME_DEPENDENCY_OF_SpdxRelationshipType SpdxRelationshipType = "RUNTIME_DEPENDENCY_OF" EXAMPLE_OF_SpdxRelationshipType SpdxRelationshipType = "EXAMPLE_OF" GENERATES_SpdxRelationshipType SpdxRelationshipType = "GENERATES" GENERATED_FROM_SpdxRelationshipType SpdxRelationshipType = "GENERATED_FROM" ANCESTOR_OF_SpdxRelationshipType SpdxRelationshipType = "ANCESTOR_OF" DESCENDANT_OF_SpdxRelationshipType SpdxRelationshipType = "DESCENDANT_OF" VARIANT_OF_SpdxRelationshipType SpdxRelationshipType = "VARIANT_OF" DISTRIBUTION_ARTIFACT_SpdxRelationshipType SpdxRelationshipType = "DISTRIBUTION_ARTIFACT" PATCH_FOR_SpdxRelationshipType SpdxRelationshipType = "PATCH_FOR" PATCH_APPLIED_SpdxRelationshipType SpdxRelationshipType = "PATCH_APPLIED" COPY_OF_SpdxRelationshipType SpdxRelationshipType = "COPY_OF" FILE_ADDED_SpdxRelationshipType SpdxRelationshipType = "FILE_ADDED" FILE_DELETED_SpdxRelationshipType SpdxRelationshipType = "FILE_DELETED" FILE_MODIFIED_SpdxRelationshipType SpdxRelationshipType = "FILE_MODIFIED" EXPANDED_FROM_ARCHIVE_SpdxRelationshipType SpdxRelationshipType = "EXPANDED_FROM_ARCHIVE" DYNAMIC_LINK_SpdxRelationshipType SpdxRelationshipType = "DYNAMIC_LINK" STATIC_LINK_SpdxRelationshipType SpdxRelationshipType = "STATIC_LINK" DATA_FILE_OF_SpdxRelationshipType SpdxRelationshipType = "DATA_FILE_OF" TEST_CASE_OF_SpdxRelationshipType SpdxRelationshipType = "TEST_CASE_OF" BUILD_TOOL_OF_SpdxRelationshipType SpdxRelationshipType = "BUILD_TOOL_OF" DEV_TOOL_OF_SpdxRelationshipType SpdxRelationshipType = "DEV_TOOL_OF" TEST_OF_SpdxRelationshipType SpdxRelationshipType = "TEST_OF" TEST_TOOL_OF_SpdxRelationshipType SpdxRelationshipType = "TEST_TOOL_OF" DOCUMENTATION_OF_SpdxRelationshipType SpdxRelationshipType = "DOCUMENTATION_OF" OPTIONAL_COMPONENT_OF_SpdxRelationshipType SpdxRelationshipType = "OPTIONAL_COMPONENT_OF" METAFILE_OF_SpdxRelationshipType SpdxRelationshipType = "METAFILE_OF" PACKAGE_OF_SpdxRelationshipType SpdxRelationshipType = "PACKAGE_OF" AMENDS_SpdxRelationshipType SpdxRelationshipType = "AMENDS" PREREQUISITE_FOR_SpdxRelationshipType SpdxRelationshipType = "PREREQUISITE_FOR" HAS_PREREQUISITE_SpdxRelationshipType SpdxRelationshipType = "HAS_PREREQUISITE" OTHER_SpdxRelationshipType SpdxRelationshipType = "OTHER" )
List of spdxRelationshipType
type V1beta1BatchCreateNotesResponse ¶
type V1beta1BatchCreateNotesResponse struct { // The notes that were created. Notes []V1beta1Note `json:"notes,omitempty"` }
Response for creating notes in batch.
type V1beta1BatchCreateOccurrencesResponse ¶
type V1beta1BatchCreateOccurrencesResponse struct { // The occurrences that were created. Occurrences []V1beta1Occurrence `json:"occurrences,omitempty"` }
Response for creating occurrences in batch.
type V1beta1Digest ¶
type V1beta1Digest struct { // `SHA1`, `SHA512` etc. Algo string `json:"algo,omitempty"` // Value of the digest. DigestBytes string `json:"digestBytes,omitempty"` }
Digest information.
type V1beta1Envelope ¶
type V1beta1Envelope struct { Payload string `json:"payload,omitempty"` PayloadType string `json:"payloadType,omitempty"` Signatures []V1beta1EnvelopeSignature `json:"signatures,omitempty"` }
MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type.
type V1beta1License ¶
type V1beta1License struct { // Often a single license can be used to represent the licensing terms. Sometimes it is necessary to include a choice of one or more licenses or some combination of license identifiers. Examples: \"LGPL-2.1-only OR MIT\", \"LGPL-2.1-only AND MIT\", \"GPL-2.0-or-later WITH Bison-exception-2.2\". Expression string `json:"expression,omitempty"` Comments string `json:"comments,omitempty"` }
License information.
type V1beta1ListNoteOccurrencesResponse ¶
type V1beta1ListNoteOccurrencesResponse struct { // The occurrences attached to the specified note. Occurrences []V1beta1Occurrence `json:"occurrences,omitempty"` // Token to provide to skip to a particular spot in the list. NextPageToken string `json:"nextPageToken,omitempty"` }
Response for listing occurrences for a note.
type V1beta1ListNotesResponse ¶
type V1beta1ListNotesResponse struct { // The notes requested. Notes []V1beta1Note `json:"notes,omitempty"` // The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results. NextPageToken string `json:"nextPageToken,omitempty"` }
Response for listing notes.
type V1beta1ListOccurrencesResponse ¶
type V1beta1ListOccurrencesResponse struct { // The occurrences requested. Occurrences []V1beta1Occurrence `json:"occurrences,omitempty"` // The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results. NextPageToken string `json:"nextPageToken,omitempty"` }
Response for listing occurrences.
type V1beta1Note ¶
type V1beta1Note struct { // Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. Name string `json:"name,omitempty"` // A one sentence description of this note. ShortDescription string `json:"shortDescription,omitempty"` // A detailed description of this note. LongDescription string `json:"longDescription,omitempty"` // Output only. The type of analysis. This field can be used as a filter in list requests. Kind *V1beta1NoteKind `json:"kind,omitempty"` // URLs associated with this note. RelatedUrl []V1beta1RelatedUrl `json:"relatedUrl,omitempty"` // Time of expiration for this note. Empty if note does not expire. ExpirationTime time.Time `json:"expirationTime,omitempty"` // Output only. The time this note was created. This field can be used as a filter in list requests. CreateTime time.Time `json:"createTime,omitempty"` // Output only. The time this note was last updated. This field can be used as a filter in list requests. UpdateTime time.Time `json:"updateTime,omitempty"` // Other notes related to this note. RelatedNoteNames []string `json:"relatedNoteNames,omitempty"` // A note describing a package vulnerability. Vulnerability *VulnerabilityVulnerability `json:"vulnerability,omitempty"` // A note describing build provenance for a verifiable build. Build *BuildBuild `json:"build,omitempty"` // A note describing a base image. BaseImage *ImageBasis `json:"baseImage,omitempty"` // A note describing a package hosted by various package managers. Package_ *PackagePackage `json:"package,omitempty"` // A note describing something that can be deployed. Deployable *DeploymentDeployable `json:"deployable,omitempty"` // A note describing the initial analysis of a resource. Discovery *DiscoveryDiscovery `json:"discovery,omitempty"` // A note describing an attestation role. AttestationAuthority *AttestationAuthority `json:"attestationAuthority,omitempty"` // A note describing an in-toto link. Intoto *IntotoInToto `json:"intoto,omitempty"` // A note describing a software bill of materials. Sbom *SpdxDocumentNote `json:"sbom,omitempty"` // A note describing an SPDX Package. SpdxPackage *SpdxPackageInfoNote `json:"spdxPackage,omitempty"` // A note describing an SPDX File. SpdxFile *SpdxFileNote `json:"spdxFile,omitempty"` // A note describing an SPDX File. SpdxRelationship *SpdxRelationshipNote `json:"spdxRelationship,omitempty"` // A note describing a vulnerability assessment. VulnerabilityAssessment *VexVulnerabilityAssessmentNote `json:"vulnerabilityAssessment,omitempty"` }
A type of analysis that can be done for a resource.
type V1beta1NoteKind ¶
type V1beta1NoteKind string
V1beta1NoteKind : Kind represents the kinds of notes supported. - NOTE_KIND_UNSPECIFIED: Default value. This value is unused. - VULNERABILITY: The note and occurrence represent a package vulnerability. - BUILD: The note and occurrence assert build provenance. - IMAGE: This represents an image basis relationship. - PACKAGE: This represents a package installed via a package manager. - DEPLOYMENT: The note and occurrence track deployment events. - DISCOVERY: The note and occurrence track the initial discovery status of a resource. - ATTESTATION: This represents a logical \"role\" that can attest to artifacts. - INTOTO: This represents an in-toto link. - SBOM: This represents a software bill of materials. - SPDX_PACKAGE: This represents an SPDX Package. - SPDX_FILE: This represents an SPDX File. - SPDX_RELATIONSHIP: This represents an SPDX Relationship. - VULNERABILITY_ASSESSMENT: This represents a Vulnerability Assessment.
const ( NOTE_KIND_UNSPECIFIED_V1beta1NoteKind V1beta1NoteKind = "NOTE_KIND_UNSPECIFIED" VULNERABILITY_V1beta1NoteKind V1beta1NoteKind = "VULNERABILITY" BUILD_V1beta1NoteKind V1beta1NoteKind = "BUILD" IMAGE_V1beta1NoteKind V1beta1NoteKind = "IMAGE" PACKAGE__V1beta1NoteKind V1beta1NoteKind = "PACKAGE" DEPLOYMENT_V1beta1NoteKind V1beta1NoteKind = "DEPLOYMENT" DISCOVERY_V1beta1NoteKind V1beta1NoteKind = "DISCOVERY" ATTESTATION_V1beta1NoteKind V1beta1NoteKind = "ATTESTATION" INTOTO_V1beta1NoteKind V1beta1NoteKind = "INTOTO" SBOM_V1beta1NoteKind V1beta1NoteKind = "SBOM" SPDX_PACKAGE_V1beta1NoteKind V1beta1NoteKind = "SPDX_PACKAGE" SPDX_FILE_V1beta1NoteKind V1beta1NoteKind = "SPDX_FILE" SPDX_RELATIONSHIP_V1beta1NoteKind V1beta1NoteKind = "SPDX_RELATIONSHIP" VULNERABILITY_ASSESSMENT_V1beta1NoteKind V1beta1NoteKind = "VULNERABILITY_ASSESSMENT" )
List of v1beta1NoteKind
type V1beta1Occurrence ¶
type V1beta1Occurrence struct { // Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. Name string `json:"name,omitempty"` // Required. Immutable. The resource for which the occurrence applies. Resource *V1beta1Resource `json:"resource,omitempty"` // Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests. NoteName string `json:"noteName,omitempty"` // Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests. Kind *V1beta1NoteKind `json:"kind,omitempty"` // A description of actions that can be taken to remedy the note. Remediation string `json:"remediation,omitempty"` // Output only. The time this occurrence was created. CreateTime time.Time `json:"createTime,omitempty"` // Output only. The time this occurrence was last updated. UpdateTime time.Time `json:"updateTime,omitempty"` // Describes a security vulnerability. Vulnerability *V1beta1vulnerabilityDetails `json:"vulnerability,omitempty"` // Describes a verifiable build. Build *V1beta1buildDetails `json:"build,omitempty"` // Describes how this resource derives from the basis in the associated note. DerivedImage *V1beta1imageDetails `json:"derivedImage,omitempty"` // Describes the installation of a package on the linked resource. Installation *V1beta1packageDetails `json:"installation,omitempty"` // Describes the deployment of an artifact on a runtime. Deployment *V1beta1deploymentDetails `json:"deployment,omitempty"` // Describes when a resource was discovered. Discovered *V1beta1discoveryDetails `json:"discovered,omitempty"` // Describes an attestation of an artifact. Attestation *V1beta1attestationDetails `json:"attestation,omitempty"` // Describes a specific in-toto link. Intoto *V1beta1intotoDetails `json:"intoto,omitempty"` // Describes a specific software bill of materials document. Sbom *SpdxDocumentOccurrence `json:"sbom,omitempty"` // Describes a specific SPDX Package. SpdxPackage *SpdxPackageInfoOccurrence `json:"spdxPackage,omitempty"` // Describes a specific SPDX File. SpdxFile *SpdxFileOccurrence `json:"spdxFile,omitempty"` // Describes a specific SPDX Relationship. SpdxRelationship *SpdxRelationshipOccurrence `json:"spdxRelationship,omitempty"` Envelope *V1beta1Envelope `json:"envelope,omitempty"` }
An instance of an analysis type that has been found on a resource.
type V1beta1RelatedUrl ¶
type V1beta1RelatedUrl struct { // Specific URL associated with the resource. Url string `json:"url,omitempty"` // Label to describe usage of the URL. Label string `json:"label,omitempty"` }
Metadata for any related URL information.
type V1beta1Resource ¶
type V1beta1Resource struct { // Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - \"Debian\". Name string `json:"name,omitempty"` // Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image. Uri string `json:"uri,omitempty"` // Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest. ContentHash *ProvenanceHash `json:"contentHash,omitempty"` }
An entity that can have metadata. For example, a Docker image.
type V1beta1VulnerabilityOccurrencesSummary ¶
type V1beta1VulnerabilityOccurrencesSummary struct { // A listing by resource of the number of fixable and total vulnerabilities. Counts []VulnerabilityOccurrencesSummaryFixableTotalByDigest `json:"counts,omitempty"` }
A summary of how many vulnerability occurrences there are per resource and severity type.
type V1beta1attestationDetails ¶
type V1beta1attestationDetails struct { // Required. Attestation for the resource. Attestation *AttestationAttestation `json:"attestation,omitempty"` }
Details of an attestation occurrence.
type V1beta1buildDetails ¶
type V1beta1buildDetails struct { // Required. The actual provenance for the build. Provenance *ProvenanceBuildProvenance `json:"provenance,omitempty"` // Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes. ProvenanceBytes string `json:"provenanceBytes,omitempty"` }
Details of a build occurrence.
type V1beta1deploymentDetails ¶
type V1beta1deploymentDetails struct { // Required. Deployment history for the resource. Deployment *DeploymentDeployment `json:"deployment,omitempty"` }
Details of a deployment occurrence.
type V1beta1discoveryDetails ¶
type V1beta1discoveryDetails struct { // Required. Analysis status for the discovered resource. Discovered *DiscoveryDiscovered `json:"discovered,omitempty"` }
Details of a discovery occurrence.
type V1beta1imageDetails ¶
type V1beta1imageDetails struct { // Required. Immutable. The child image derived from the base image. DerivedImage *ImageDerived `json:"derivedImage,omitempty"` }
Details of an image occurrence.
type V1beta1intotoDetails ¶
type V1beta1intotoDetails struct { Signatures []V1beta1intotoSignature `json:"signatures,omitempty"` Signed *IntotoLink `json:"signed,omitempty"` }
This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note.
type V1beta1intotoSignature ¶
type V1beta1intotoSignature struct { Keyid string `json:"keyid,omitempty"` Sig string `json:"sig,omitempty"` }
A signature object consists of the KeyID used and the signature itself.
type V1beta1packageDetails ¶
type V1beta1packageDetails struct { // Required. Where the package was installed. Installation *PackageInstallation `json:"installation,omitempty"` }
Details of a package occurrence.
type V1beta1packageLocation ¶
type V1beta1packageLocation struct { // Deprecated. The CPE URI in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. CpeUri string `json:"cpeUri,omitempty"` // Deprecated. The version installed at this location. Version *PackageVersion `json:"version,omitempty"` // The path from which we gathered that this package/version is installed. Path string `json:"path,omitempty"` }
An occurrence of a particular package installation found within a system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.
type V1beta1provenanceArtifact ¶
type V1beta1provenanceArtifact struct { // Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container. Checksum string `json:"checksum,omitempty"` // Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`. Id string `json:"id,omitempty"` // Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image. Names []string `json:"names,omitempty"` }
Artifact describes a build product.
type V1beta1vulnerabilityDetails ¶
type V1beta1vulnerabilityDetails struct { Type_ string `json:"type,omitempty"` // Output only. The note provider assigned Severity of the vulnerability. Severity *VulnerabilitySeverity `json:"severity,omitempty"` // Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. CvssScore float32 `json:"cvssScore,omitempty"` // Required. The set of affected locations and their fixes (if available) within the associated resource. PackageIssue []VulnerabilityPackageIssue `json:"packageIssue,omitempty"` // Output only. A one sentence description of this vulnerability. ShortDescription string `json:"shortDescription,omitempty"` // Output only. A detailed description of this vulnerability. LongDescription string `json:"longDescription,omitempty"` // Output only. URLs related to this vulnerability. RelatedUrls []V1beta1RelatedUrl `json:"relatedUrls,omitempty"` // The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. EffectiveSeverity *VulnerabilitySeverity `json:"effectiveSeverity,omitempty"` // Output only. CVSS version used to populate cvss_score and severity. CvssVersion *VulnerabilityCvssVersion `json:"cvssVersion,omitempty"` VexAssessment *DetailsVexAssessment `json:"vexAssessment,omitempty"` // The cvss v2 score for the vulnerability. CvssV2 *VulnerabilityCvss `json:"cvssV2,omitempty"` // The cvss v3 score for the vulnerability. CvssV3 *VulnerabilityCvss `json:"cvssV3,omitempty"` }
Details of a vulnerability Occurrence.
type VersionVersionKind ¶
type VersionVersionKind string
VersionVersionKind : Whether this is an ordinary package version or a sentinel MIN/MAX version. - VERSION_KIND_UNSPECIFIED: Unknown. - NORMAL: A standard package version. - MINIMUM: A special version representing negative infinity. - MAXIMUM: A special version representing positive infinity.
const ( VERSION_KIND_UNSPECIFIED_VersionVersionKind VersionVersionKind = "VERSION_KIND_UNSPECIFIED" NORMAL_VersionVersionKind VersionVersionKind = "NORMAL" MINIMUM_VersionVersionKind VersionVersionKind = "MINIMUM" MAXIMUM_VersionVersionKind VersionVersionKind = "MAXIMUM" )
List of VersionVersionKind
type VexVulnerabilityAssessmentNote ¶
type VexVulnerabilityAssessmentNote struct { Title string `json:"title,omitempty"` // A one sentence description of this Vex. ShortDescription string `json:"shortDescription,omitempty"` // A detailed description of this Vex. LongDescription string `json:"longDescription,omitempty"` // Identifies the language used by this document, corresponding to IETF BCP 47 / RFC 5646. LanguageCode string `json:"languageCode,omitempty"` // Publisher details of this Note. Publisher *VulnerabilityAssessmentNotePublisher `json:"publisher,omitempty"` // The product affected by this vex. Product *VulnerabilityAssessmentNoteProduct `json:"product,omitempty"` // Represents a vulnerability assessment for the product. Assessment *VulnerabilityAssessmentNoteAssessment `json:"assessment,omitempty"` }
A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE.
type VulnerabilityAssessmentNoteAssessment ¶
type VulnerabilityAssessmentNoteAssessment struct { // Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Cve string `json:"cve,omitempty"` // A one sentence description of this Vex. ShortDescription string `json:"shortDescription,omitempty"` // A detailed description of this Vex. LongDescription string `json:"longDescription,omitempty"` // Holds a list of references associated with this vulnerability item and assessment. These uris have additional information about the vulnerability and the assessment itself. E.g. Link to a document which details how this assessment concluded the state of this vulnerability. RelatedUris []V1beta1RelatedUrl `json:"relatedUris,omitempty"` // Provides the state of this Vulnerability assessment. State *AssessmentState `json:"state,omitempty"` // Contains information about the impact of this vulnerability, this will change with time. Impacts []string `json:"impacts,omitempty"` // Justification provides the justification when the state of the assessment if NOT_AFFECTED. Justification *AssessmentJustification `json:"justification,omitempty"` // Specifies details on how to handle (and presumably, fix) a vulnerability. Remediations []AssessmentRemediation `json:"remediations,omitempty"` }
Assessment provides all information that is related to a single vulnerability for this product.
type VulnerabilityAssessmentNoteProduct ¶
type VulnerabilityAssessmentNoteProduct struct { // Name of the product. Name string `json:"name,omitempty"` // Token that identifies a product so that it can be referred to from other parts in the document. There is no predefined format as long as it uniquely identifies a group in the context of the current document. Id string `json:"id,omitempty"` // Contains a URI which is vendor-specific. Example: The artifact repository URL of an image. GenericUri string `json:"genericUri,omitempty"` }
type VulnerabilityAssessmentNotePublisher ¶
type VulnerabilityAssessmentNotePublisher struct { // Name of the publisher. Examples: 'Google', 'Google Cloud Platform'. Name string `json:"name,omitempty"` // Provides information about the authority of the issuing party to release the document, in particular, the party's constituency and responsibilities or other obligations. IssuingAuthority string `json:"issuingAuthority,omitempty"` Context string `json:"context,omitempty"` }
type VulnerabilityCvss ¶
type VulnerabilityCvss struct { // The base score is a function of the base metric scores. BaseScore float32 `json:"baseScore,omitempty"` ExploitabilityScore float32 `json:"exploitabilityScore,omitempty"` ImpactScore float32 `json:"impactScore,omitempty"` // Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. AttackVector *CvssAttackVector `json:"attackVector,omitempty"` AttackComplexity *CvssAttackComplexity `json:"attackComplexity,omitempty"` Authentication *CvssAuthentication `json:"authentication,omitempty"` PrivilegesRequired *CvssPrivilegesRequired `json:"privilegesRequired,omitempty"` UserInteraction *CvssUserInteraction `json:"userInteraction,omitempty"` Scope *CvssScope `json:"scope,omitempty"` ConfidentialityImpact *CvssImpact `json:"confidentialityImpact,omitempty"` IntegrityImpact *CvssImpact `json:"integrityImpact,omitempty"` AvailabilityImpact *CvssImpact `json:"availabilityImpact,omitempty"` }
type VulnerabilityCvssVersion ¶
type VulnerabilityCvssVersion string
VulnerabilityCvssVersion : CVSS Version.
const (
UNSPECIFIED_VulnerabilityCvssVersion VulnerabilityCvssVersion = "CVSS_VERSION_UNSPECIFIED"
)
List of vulnerabilityCVSSVersion
type VulnerabilityDetail ¶
type VulnerabilityDetail struct { // Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. CpeUri string `json:"cpeUri,omitempty"` // Required. The name of the package where the vulnerability was found. Package_ string `json:"package,omitempty"` // The min version of the package in which the vulnerability exists. MinAffectedVersion *PackageVersion `json:"minAffectedVersion,omitempty"` // The max version of the package in which the vulnerability exists. MaxAffectedVersion *PackageVersion `json:"maxAffectedVersion,omitempty"` // The severity (eg: distro assigned severity) for this vulnerability. SeverityName string `json:"severityName,omitempty"` // A vendor-specific description of this note. Description string `json:"description,omitempty"` // The fix for this specific package version. FixedLocation *VulnerabilityVulnerabilityLocation `json:"fixedLocation,omitempty"` // The type of package; whether native or non native(ruby gems, node.js packages etc). PackageType string `json:"packageType,omitempty"` // Whether this detail is obsolete. Occurrences are expected not to point to obsolete details. IsObsolete bool `json:"isObsolete,omitempty"` // The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. SourceUpdateTime time.Time `json:"sourceUpdateTime,omitempty"` // The source from which the information in this Detail was obtained. Source string `json:"source,omitempty"` // The name of the vendor of the product. Vendor string `json:"vendor,omitempty"` }
type VulnerabilityOccurrencesSummaryFixableTotalByDigest ¶
type VulnerabilityOccurrencesSummaryFixableTotalByDigest struct { // The affected resource. Resource *V1beta1Resource `json:"resource,omitempty"` // The severity for this count. SEVERITY_UNSPECIFIED indicates total across all severities. Severity *VulnerabilitySeverity `json:"severity,omitempty"` // The number of fixable vulnerabilities associated with this resource. FixableCount string `json:"fixableCount,omitempty"` // The total number of vulnerabilities associated with this resource. TotalCount string `json:"totalCount,omitempty"` }
Per resource and severity counts of fixable and total vulnerabilities.
type VulnerabilityPackageIssue ¶
type VulnerabilityPackageIssue struct { // Required. The location of the vulnerability. AffectedLocation *VulnerabilityVulnerabilityLocation `json:"affectedLocation,omitempty"` // The location of the available fix for vulnerability. FixedLocation *VulnerabilityVulnerabilityLocation `json:"fixedLocation,omitempty"` // Deprecated, use Details.effective_severity instead The severity (e.g., distro assigned severity) for this vulnerability. SeverityName string `json:"severityName,omitempty"` // The type of package (e.g. OS, MAVEN, GO). PackageType string `json:"packageType,omitempty"` // The distro or language system assigned severity for this vulnerability when that is available and note provider assigned severity when it is not available. EffectiveSeverity *VulnerabilitySeverity `json:"effectiveSeverity,omitempty"` }
This message wraps a location affected by a vulnerability and its associated fix (if one is available).
type VulnerabilitySeverity ¶
type VulnerabilitySeverity string
VulnerabilitySeverity : Note provider-assigned severity/impact ranking. - SEVERITY_UNSPECIFIED: Unknown. - MINIMAL: Minimal severity. - LOW: Low severity. - MEDIUM: Medium severity. - HIGH: High severity. - CRITICAL: Critical severity.
const ( SEVERITY_UNSPECIFIED_VulnerabilitySeverity VulnerabilitySeverity = "SEVERITY_UNSPECIFIED" MINIMAL_VulnerabilitySeverity VulnerabilitySeverity = "MINIMAL" LOW_VulnerabilitySeverity VulnerabilitySeverity = "LOW" MEDIUM_VulnerabilitySeverity VulnerabilitySeverity = "MEDIUM" HIGH_VulnerabilitySeverity VulnerabilitySeverity = "HIGH" CRITICAL_VulnerabilitySeverity VulnerabilitySeverity = "CRITICAL" )
List of vulnerabilitySeverity
type VulnerabilityVulnerability ¶
type VulnerabilityVulnerability struct { // The CVSS score for this vulnerability. CvssScore float32 `json:"cvssScore,omitempty"` // Note provider assigned impact of the vulnerability. Severity *VulnerabilitySeverity `json:"severity,omitempty"` // All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in. Details []VulnerabilityDetail `json:"details,omitempty"` // The full description of the CVSS for version 3. CvssV3 *VulnerabilityCvss `json:"cvssV3,omitempty"` // Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version. WindowsDetails []VulnerabilityWindowsDetail `json:"windowsDetails,omitempty"` // The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. SourceUpdateTime time.Time `json:"sourceUpdateTime,omitempty"` // The full description of the CVSS for version 2. CvssV2 *VulnerabilityCvss `json:"cvssV2,omitempty"` Cwe []string `json:"cwe,omitempty"` // CVSS version used to populate cvss_score and severity. CvssVersion *VulnerabilityCvssVersion `json:"cvssVersion,omitempty"` }
Vulnerability provides metadata about a security vulnerability in a Note.
type VulnerabilityVulnerabilityLocation ¶
type VulnerabilityVulnerabilityLocation struct { // Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. CpeUri string `json:"cpeUri,omitempty"` // Required. The package being described. Package_ string `json:"package,omitempty"` // Required. The version of the package being described. Version *PackageVersion `json:"version,omitempty"` }
The location of the vulnerability.
type VulnerabilityWindowsDetail ¶
type VulnerabilityWindowsDetail struct { // Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. CpeUri string `json:"cpeUri,omitempty"` // Required. The name of the vulnerability. Name string `json:"name,omitempty"` // The description of the vulnerability. Description string `json:"description,omitempty"` // Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix. FixingKbs []WindowsDetailKnowledgeBase `json:"fixingKbs,omitempty"` }
Source Files ¶
- api_grafeas_v1_beta1.go
- client.go
- configuration.go
- model_alias_context_kind.go
- model_assessment_justification.go
- model_assessment_remediation.go
- model_assessment_state.go
- model_attestation_attestation.go
- model_attestation_authority.go
- model_attestation_generic_signed_attestation.go
- model_attestation_generic_signed_attestation_content_type.go
- model_attestation_pgp_signed_attestation.go
- model_attestation_pgp_signed_attestation_content_type.go
- model_authority_hint.go
- model_body.go
- model_body_1.go
- model_build_build.go
- model_build_build_signature.go
- model_build_signature_key_type.go
- model_cvss_attack_complexity.go
- model_cvss_attack_vector.go
- model_cvss_authentication.go
- model_cvss_impact.go
- model_cvss_privileges_required.go
- model_cvss_scope.go
- model_cvss_user_interaction.go
- model_deployment_deployable.go
- model_deployment_deployment.go
- model_deployment_platform.go
- model_details_vex_assessment.go
- model_discovered_analysis_completed.go
- model_discovered_analysis_status.go
- model_discovered_continuous_analysis.go
- model_discovery_discovered.go
- model_discovery_discovery.go
- model_external_ref_category.go
- model_file_note_file_type.go
- model_grafeasv1beta1_signature.go
- model_hash_hash_type.go
- model_image_basis.go
- model_image_derived.go
- model_image_fingerprint.go
- model_image_layer.go
- model_in_toto_artifact_rule.go
- model_intoto_in_toto.go
- model_intoto_link.go
- model_intoto_link_artifact.go
- model_intoto_signing_key.go
- model_justification_justification_type.go
- model_layer_directive.go
- model_link_artifact_hashes.go
- model_link_by_products.go
- model_link_environment.go
- model_package_architecture.go
- model_package_distribution.go
- model_package_info_note_external_ref.go
- model_package_installation.go
- model_package_package.go
- model_package_version.go
- model_protobuf_any.go
- model_provenance_build_provenance.go
- model_provenance_command.go
- model_provenance_file_hashes.go
- model_provenance_hash.go
- model_provenance_source.go
- model_remediation_remediation_type.go
- model_rpc_status.go
- model_source_alias_context.go
- model_source_cloud_repo_source_context.go
- model_source_gerrit_source_context.go
- model_source_git_source_context.go
- model_source_project_repo_id.go
- model_source_repo_id.go
- model_source_source_context.go
- model_spdx_document_note.go
- model_spdx_document_occurrence.go
- model_spdx_file_note.go
- model_spdx_file_occurrence.go
- model_spdx_package_info_note.go
- model_spdx_package_info_occurrence.go
- model_spdx_relationship_note.go
- model_spdx_relationship_occurrence.go
- model_spdx_relationship_type.go
- model_v1beta1_batch_create_notes_response.go
- model_v1beta1_batch_create_occurrences_response.go
- model_v1beta1_digest.go
- model_v1beta1_envelope.go
- model_v1beta1_envelope_signature.go
- model_v1beta1_license.go
- model_v1beta1_list_note_occurrences_response.go
- model_v1beta1_list_notes_response.go
- model_v1beta1_list_occurrences_response.go
- model_v1beta1_note.go
- model_v1beta1_note_kind.go
- model_v1beta1_occurrence.go
- model_v1beta1_related_url.go
- model_v1beta1_resource.go
- model_v1beta1_vulnerability_occurrences_summary.go
- model_v1beta1attestation_details.go
- model_v1beta1build_details.go
- model_v1beta1deployment_details.go
- model_v1beta1discovery_details.go
- model_v1beta1image_details.go
- model_v1beta1intoto_details.go
- model_v1beta1intoto_signature.go
- model_v1beta1package_details.go
- model_v1beta1package_location.go
- model_v1beta1provenance_artifact.go
- model_v1beta1vulnerability_details.go
- model_version_version_kind.go
- model_vex_vulnerability_assessment_note.go
- model_vulnerability_assessment_note_assessment.go
- model_vulnerability_assessment_note_product.go
- model_vulnerability_assessment_note_publisher.go
- model_vulnerability_cvss.go
- model_vulnerability_cvss_version.go
- model_vulnerability_detail.go
- model_vulnerability_occurrences_summary_fixable_total_by_digest.go
- model_vulnerability_package_issue.go
- model_vulnerability_severity.go
- model_vulnerability_vulnerability.go
- model_vulnerability_vulnerability_location.go
- model_vulnerability_windows_detail.go
- model_windows_detail_knowledge_base.go
- response.go