batchCreate(parent, body=None, x__xgafv=None)

Creates new occurrences in batch.

Args:
parent: string, Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrences are to be created. (required)
body: object, The request body.
The object takes the form of:

{ # Request to create occurrences in batch.
"occurrences": [ # Required. The occurrences to create. Max allowed length is 1000.
{ # An instance of an analysis type that has been found on a resource.
"attestation": { # 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 lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact.
"jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas.
{
"compactJwt": "A String", # The compact encoding of a JWS, which is always three base64 encoded strings joined by periods. For details, see: https://tools.ietf.org/html/rfc7515.html#section-3.1
},
],
"serializedPayload": "A String", # Required. The serialized payload that is verified by one or more `signatures`.
"signatures": [ # 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.
{ # 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).
"publicKeyId": "A String", # 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"
"signature": "A String", # 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.
},
],
},
"build": { # Details of a build occurrence. # Describes a verifiable build.
"inTotoSlsaProvenanceV1": { # In-Toto Slsa Provenance V1 represents a slsa provenance meeting the slsa spec, wrapped in an in-toto statement. This allows for direct jsonification of a to-spec in-toto slsa statement with a to-spec slsa provenance.
"_type": "A String", # InToto spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement
"predicate": { # Keep in sync with schema at https://github.com/slsa-framework/slsa/blob/main/docs/provenance/schema/v1/provenance.proto Builder renamed to ProvenanceBuilder because of Java conflicts.
"buildDefinition": {
"buildType": "A String",
"externalParameters": {
"a_key": "", # Properties of the object.
},
"internalParameters": {
"a_key": "", # Properties of the object.
},
"resolvedDependencies": [
{
"annotations": {
"a_key": "",
},
"content": "A String",
"digest": {
"a_key": "A String",
},
"downloadLocation": "A String",
"mediaType": "A String",
"name": "A String",
"uri": "A String",
},
],
},
"runDetails": {
"builder": {
"builderDependencies": [
{
"annotations": {
"a_key": "",
},
"content": "A String",
"digest": {
"a_key": "A String",
},
"downloadLocation": "A String",
"mediaType": "A String",
"name": "A String",
"uri": "A String",
},
],
"id": "A String",
"version": {
"a_key": "A String",
},
},
"byproducts": [
{
"annotations": {
"a_key": "",
},
"content": "A String",
"digest": {
"a_key": "A String",
},
"downloadLocation": "A String",
"mediaType": "A String",
"name": "A String",
"uri": "A String",
},
],
"metadata": {
"finishedOn": "A String",
"invocationId": "A String",
"startedOn": "A String",
},
},
},
"predicateType": "A String",
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"intotoProvenance": { # Deprecated. See InTotoStatement for the replacement. In-toto Provenance representation as defined in spec.
"builderConfig": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"intotoStatement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json". # In-toto Statement representation as defined in spec. The intoto_statement can contain any type of provenance. The serialized payload of the statement can be stored and signed in the Occurrence's envelope.
"_type": "A String", # Always `https://in-toto.io/Statement/v0.1`.
"predicateType": "A String", # `https://slsa.dev/provenance/v0.1` for SlsaProvenance.
"provenance": {
"builderConfig": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenance": {
"builder": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
{
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenanceZeroTwo": { # See full explanation of fields at slsa.dev/provenance/v0.2.
"buildConfig": {
"a_key": "", # Properties of the object.
},
"buildType": "A String",
"builder": { # Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance.
"id": "A String",
},
"invocation": { # Identifies the event that kicked off the build.
"configSource": { # Describes where the config file that kicked off the build came from. This is effectively a pointer to the source where buildConfig came from.
"digest": {
"a_key": "A String",
},
"entryPoint": "A String",
"uri": "A String",
},
"environment": {
"a_key": "", # Properties of the object.
},
"parameters": {
"a_key": "", # Properties of the object.
},
},
"materials": [
{ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on.
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String",
"buildInvocationId": "A String",
"buildStartedOn": "A String",
"completeness": { # Indicates that the builder claims certain fields in this message to be complete.
"environment": True or False,
"materials": True or False,
"parameters": True or False,
},
"reproducible": True or False,
},
},
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # The actual provenance for the build.
"buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.
"a_key": "A String",
},
"builderVersion": "A String", # Version string of the builder at the time this build was executed.
"builtArtifacts": [ # Output of the build.
{ # Artifact describes a build product.
"checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.
"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.
"names": [ # 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.
"A String",
],
},
],
"commands": [ # Commands requested by the build.
{ # Command describes a step performed as part of the build pipeline.
"args": [ # Command-line arguments used when executing this command.
"A String",
],
"dir": "A String", # Working directory (relative to project source root) used when running this command.
"env": [ # Environment variables set before running this command.
"A String",
],
"id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.
"name": "A String", # 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`.
"waitFor": [ # The ID(s) of the command(s) that this command depends on.
"A String",
],
},
],
"createTime": "A String", # Time at which the build was created.
"creator": "A String", # 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.
"endTime": "A String", # Time at which execution of the build was finished.
"id": "A String", # Required. Unique identifier of the build.
"logsUri": "A String", # URI where any logs for this provenance were written.
"projectId": "A String", # ID of the project.
"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.
"additionalContexts": [ # 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.
{ # 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.
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
"uid": "A String", # A server-assigned, globally unique identifier.
},
"revisionId": "A String", # A revision ID.
},
"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"gerritProject": "A String", # 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.
"hostUri": "A String", # The URI of a running Gerrit instance.
"revisionId": "A String", # A revision (commit) ID.
},
"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).
"revisionId": "A String", # Git commit hash.
"url": "A String", # Git repository URL.
},
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
},
],
"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.
"context": { # 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. # If provided, the source code used for the build came from this location.
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
"uid": "A String", # A server-assigned, globally unique identifier.
},
"revisionId": "A String", # A revision ID.
},
"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"gerritProject": "A String", # 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.
"hostUri": "A String", # The URI of a running Gerrit instance.
"revisionId": "A String", # A revision (commit) ID.
},
"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).
"revisionId": "A String", # Git commit hash.
"url": "A String", # Git repository URL.
},
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
},
"fileHashes": { # 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.
"a_key": { # Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build.
"fileHash": [ # Required. Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # Required. The type of hash that was performed, e.g. "SHA-256".
"value": "A String", # Required. The hash value.
},
],
},
},
},
"startTime": "A String", # Time at which execution of the build was started.
"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
},
"provenanceBytes": "A String", # 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.
},
"compliance": { # An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. # Describes a compliance violation on a linked resource.
"nonComplianceReason": "A String",
"nonCompliantFiles": [
{ # Details about files that caused a compliance check to fail. display_command is a single command that can be used to display a list of non compliant files. When there is no such command, we can also iterate a list of non compliant file using 'path'.
"displayCommand": "A String", # Command to display the non-compliant files.
"path": "A String", # Empty if `display_command` is set.
"reason": "A String", # Explains why a file is non compliant for a CIS check.
},
],
"version": { # Describes the CIS benchmark version that is applicable to a given OS and os version. # The OS and config version the benchmark was run on.
"benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
"cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
"version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
},
},
"createTime": "A String", # Output only. The time this occurrence was created.
"deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.
"address": "A String", # Address of the runtime element hosting this deployment.
"config": "A String", # Configuration used to create this deployment.
"deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
"platform": "A String", # Platform hosting this deployment.
"resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
"A String",
],
"undeployTime": "A String", # End of the lifetime of this deployment.
"userEmail": "A String", # Identity of the user that triggered this deployment.
},
"discovery": { # Provides information about the analysis status of a discovered resource. # Describes when a resource was discovered.
"analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource.
"analysisType": [
"A String",
],
},
"analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors.
{ # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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 field, or localized by the client.
},
],
"analysisStatus": "A String", # The status of discovery for the resource.
"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # 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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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 field, or localized by the client.
},
"archiveTime": "A String", # Output only. The time occurrences related to this discovery occurrence were archived.
"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
"cpe": "A String", # The CPE of the resource being scanned.
"lastScanTime": "A String", # The last time this resource was scanned.
"sbomStatus": { # The status of an SBOM generation. # The status of an SBOM generation.
"error": "A String", # If there was an error generating an SBOM, this will indicate what that error was.
"sbomState": "A String", # The progress of the SBOM generation.
},
},
"dsseAttestation": { # Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. # Describes an attestation of an artifact using dsse.
"envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # If doing something security critical, make sure to verify the signatures in this metadata.
"payload": "A String",
"payloadType": "A String",
"signatures": [
{
"keyid": "A String",
"sig": "A String",
},
],
},
"statement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json".
"_type": "A String", # Always `https://in-toto.io/Statement/v0.1`.
"predicateType": "A String", # `https://slsa.dev/provenance/v0.1` for SlsaProvenance.
"provenance": {
"builderConfig": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenance": {
"builder": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
{
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenanceZeroTwo": { # See full explanation of fields at slsa.dev/provenance/v0.2.
"buildConfig": {
"a_key": "", # Properties of the object.
},
"buildType": "A String",
"builder": { # Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance.
"id": "A String",
},
"invocation": { # Identifies the event that kicked off the build.
"configSource": { # Describes where the config file that kicked off the build came from. This is effectively a pointer to the source where buildConfig came from.
"digest": {
"a_key": "A String",
},
"entryPoint": "A String",
"uri": "A String",
},
"environment": {
"a_key": "", # Properties of the object.
},
"parameters": {
"a_key": "", # Properties of the object.
},
},
"materials": [
{ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on.
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String",
"buildInvocationId": "A String",
"buildStartedOn": "A String",
"completeness": { # Indicates that the builder claims certain fields in this message to be complete.
"environment": True or False,
"materials": True or False,
"parameters": True or False,
},
"reproducible": True or False,
},
},
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
},
"envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # https://github.com/secure-systems-lab/dsse
"payload": "A String",
"payloadType": "A String",
"signatures": [
{
"keyid": "A String",
"sig": "A String",
},
],
},
"image": { # Details of the derived image portion of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Describes how this resource derives from the basis in the associated note.
"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
"distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.
"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
"A String",
],
"v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
},
"layerInfo": [ # 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.
{ # Layer holds metadata specific to a layer of a Docker image.
"arguments": "A String", # The recovered arguments to the Dockerfile directive.
"directive": "A String", # Required. The recovered Dockerfile directive used to construct this layer. See https://docs.docker.com/engine/reference/builder/ for more information.
},
],
},
"kind": "A String", # Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests.
"name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
"noteName": "A String", # 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.
"package": { # Details on how a particular software package was installed on a system. # Describes the installation of a package on the linked resource.
"architecture": "A String", # Output only. The CPU architecture for which packages in this distribution channel were built. Architecture will be blank for language packages.
"cpeUri": "A String", # Output only. 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.
"license": { # License information. # Licenses that have been declared by the authors of the package.
"comments": "A String", # Comments
"expression": "A String", # 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".
},
"location": [ # All of the places within the filesystem versions of this package have been found.
{ # An occurrence of a particular package installation found within a system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.
"cpeUri": "A String", # Deprecated. The CPE URI in [CPE format](https://cpe.mitre.org/specification/)
"path": "A String", # The path from which we gathered that this package/version is installed.
"version": { # Version contains structured information about the version of a package. # Deprecated. The version installed at this location.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
],
"name": "A String", # Required. Output only. The name of the installed package.
"packageType": "A String", # Output only. The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"version": { # Version contains structured information about the version of a package. # Output only. The version of the package.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
"remediation": "A String", # A description of actions that can be taken to remedy the note.
"resourceUri": "A String", # Required. Immutable. A URI that represents the resource for which the occurrence applies. For example, `https://gcr.io/project/image@sha256:123abc` for a Docker image.
"sbomReference": { # The occurrence representing an SBOM reference as applied to a specific resource. The occurrence follows the DSSE specification. See https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for more details. # Describes a specific SBOM reference occurrences.
"payload": { # The actual payload that contains the SBOM Reference data. The payload follows the intoto statement specification. See https://github.com/in-toto/attestation/blob/main/spec/v1.0/statement.md for more details. # The actual payload that contains the SBOM reference data.
"_type": "A String", # Identifier for the schema of the Statement.
"predicate": { # A predicate which describes the SBOM being referenced. # Additional parameters of the Predicate. Includes the actual data about the SBOM.
"digest": { # A map of algorithm to digest of the contents of the SBOM.
"a_key": "A String",
},
"location": "A String", # The location of the SBOM.
"mimeType": "A String", # The mime type of the SBOM.
"referrerId": "A String", # The person or system referring this predicate to the consumer.
},
"predicateType": "A String", # URI identifying the type of the Predicate.
"subject": [ # Set of software artifacts that the attestation applies to. Each element represents a single software artifact.
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"payloadType": "A String", # The kind of payload that SbomReferenceIntotoPayload takes. Since it's in the intoto format, this value is expected to be 'application/vnd.in-toto+json'.
"signatures": [ # The signatures over the payload.
{
"keyid": "A String",
"sig": "A String",
},
],
},
"updateTime": "A String", # Output only. The time this occurrence was last updated.
"upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). For Windows, both distribution and windows_update contain information for the Windows update. # Describes an available package upgrade on the linked resource.
"distribution": { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities. # Metadata about the upgrade for available for the specific operating system for the resource_url. This allows efficient filtering, as well as making it easier to use the occurrence.
"classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. For Windows the classification is one of the category_ids listed at https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85)
"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
"cve": [ # The cve tied to this Upgrade.
"A String",
],
"severity": "A String", # The severity as specified by the upstream operating system.
},
"package": "A String", # Required for non-Windows OS. The package this Upgrade is for.
"parsedVersion": { # Version contains structured information about the version of a package. # Required for non-Windows OS. The version of the package in a machine + human readable form.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"windowsUpdate": { # Windows Update represents the metadata about the update for the Windows operating system. The fields in this message come from the Windows Update API documented at https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. # Required for Windows OS. Represents the metadata about the Windows update.
"categories": [ # The list of categories to which the update belongs.
{ # The category to which the update belongs.
"categoryId": "A String", # The identifier of the category.
"name": "A String", # The localized name of the category.
},
],
"description": "A String", # The localized description of the update.
"identity": { # The unique identifier of the update. # Required - The unique identifier for the update.
"revision": 42, # The revision number of the update.
"updateId": "A String", # The revision independent identifier of the update.
},
"kbArticleIds": [ # The Microsoft Knowledge Base article IDs that are associated with the update.
"A String",
],
"lastPublishedTimestamp": "A String", # The last published timestamp of the update.
"supportUrl": "A String", # The hyperlink to the support information for the update.
"title": "A String", # The localized title of the update.
},
},
"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability.
"cvssScore": 3.14, # 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.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity.
"cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. 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.
"extraDetails": "A String", # Occurrence-specific extra details about the vulnerability.
"fixAvailable": True or False, # Output only. Whether at least one of the affected packages has a fix available.
"longDescription": "A String", # Output only. A detailed description of this vulnerability.
"packageIssue": [ # Required. The set of affected locations and their fixes (if available) within the associated resource.
{ # A detail for a distro and package this vulnerability occurrence was found in and its associated fix (if one is available).
"affectedCpeUri": "A String", # Required. The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability was found in.
"affectedPackage": "A String", # Required. The package this vulnerability was found in.
"affectedVersion": { # Version contains structured information about the version of a package. # Required. The version of the package that is installed on the resource affected by this vulnerability.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"effectiveSeverity": "A String", # Output only. The distro or language system assigned severity for this vulnerability when that is available and note provider assigned severity when it is not available.
"fileLocation": [ # The location at which this package was found.
{ # Indicates the location at which a package was found.
"filePath": "A String", # For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.
},
],
"fixAvailable": True or False, # Output only. Whether a fix is available for this package.
"fixedCpeUri": "A String", # The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability was fixed in. It is possible for this to be different from the affected_cpe_uri.
"fixedPackage": "A String", # The package this vulnerability was fixed in. It is possible for this to be different from the affected_package.
"fixedVersion": { # Version contains structured information about the version of a package. # Required. The version of the package this vulnerability was fixed in. Setting this to VersionKind.MAXIMUM means no fix is yet available.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"packageType": "A String", # The type of package (e.g. OS, MAVEN, GO).
},
],
"relatedUrls": [ # Output only. URLs related to this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"severity": "A String", # Output only. The note provider assigned severity of this vulnerability.
"shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
"type": "A String", # The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"vexAssessment": { # VexAssessment provides all publisher provided Vex information that is related to this vulnerability.
"cve": "A String", # Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Deprecated: Use vulnerability_id instead to denote CVEs.
"impacts": [ # Contains information about the impact of this vulnerability, this will change with time.
"A String",
],
"justification": { # Justification provides the justification when the state of the assessment if NOT_AFFECTED. # Justification provides the justification when the state of the assessment if NOT_AFFECTED.
"details": "A String", # Additional details on why this justification was chosen.
"justificationType": "A String", # The justification type for this vulnerability.
},
"noteName": "A String", # The VulnerabilityAssessment note from which this VexAssessment was generated. This will be of the form: `projects/[PROJECT_ID]/notes/[NOTE_ID]`.
"relatedUris": [ # Holds a list of references associated with this vulnerability item and assessment.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"remediations": [ # Specifies details on how to handle (and presumably, fix) a vulnerability.
{ # Specifies details on how to handle (and presumably, fix) a vulnerability.
"details": "A String", # Contains a comprehensive human-readable discussion of the remediation.
"remediationType": "A String", # The type of remediation that can be applied.
"remediationUri": { # Metadata for any related URL information. # Contains the URL where to obtain the remediation.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
},
],
"state": "A String", # Provides the state of this Vulnerability assessment.
"vulnerabilityId": "A String", # The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.
},
},
},
],
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response for creating occurrences in batch.
"occurrences": [ # The occurrences that were created.
{ # An instance of an analysis type that has been found on a resource.
"attestation": { # 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 lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact.
"jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas.
{
"compactJwt": "A String", # The compact encoding of a JWS, which is always three base64 encoded strings joined by periods. For details, see: https://tools.ietf.org/html/rfc7515.html#section-3.1
},
],
"serializedPayload": "A String", # Required. The serialized payload that is verified by one or more `signatures`.
"signatures": [ # 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.
{ # 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).
"publicKeyId": "A String", # 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"
"signature": "A String", # 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.
},
],
},
"build": { # Details of a build occurrence. # Describes a verifiable build.
"inTotoSlsaProvenanceV1": { # In-Toto Slsa Provenance V1 represents a slsa provenance meeting the slsa spec, wrapped in an in-toto statement. This allows for direct jsonification of a to-spec in-toto slsa statement with a to-spec slsa provenance.
"_type": "A String", # InToto spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement
"predicate": { # Keep in sync with schema at https://github.com/slsa-framework/slsa/blob/main/docs/provenance/schema/v1/provenance.proto Builder renamed to ProvenanceBuilder because of Java conflicts.
"buildDefinition": {
"buildType": "A String",
"externalParameters": {
"a_key": "", # Properties of the object.
},
"internalParameters": {
"a_key": "", # Properties of the object.
},
"resolvedDependencies": [
{
"annotations": {
"a_key": "",
},
"content": "A String",
"digest": {
"a_key": "A String",
},
"downloadLocation": "A String",
"mediaType": "A String",
"name": "A String",
"uri": "A String",
},
],
},
"runDetails": {
"builder": {
"builderDependencies": [
{
"annotations": {
"a_key": "",
},
"content": "A String",
"digest": {
"a_key": "A String",
},
"downloadLocation": "A String",
"mediaType": "A String",
"name": "A String",
"uri": "A String",
},
],
"id": "A String",
"version": {
"a_key": "A String",
},
},
"byproducts": [
{
"annotations": {
"a_key": "",
},
"content": "A String",
"digest": {
"a_key": "A String",
},
"downloadLocation": "A String",
"mediaType": "A String",
"name": "A String",
"uri": "A String",
},
],
"metadata": {
"finishedOn": "A String",
"invocationId": "A String",
"startedOn": "A String",
},
},
},
"predicateType": "A String",
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"intotoProvenance": { # Deprecated. See InTotoStatement for the replacement. In-toto Provenance representation as defined in spec.
"builderConfig": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"intotoStatement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json". # In-toto Statement representation as defined in spec. The intoto_statement can contain any type of provenance. The serialized payload of the statement can be stored and signed in the Occurrence's envelope.
"_type": "A String", # Always `https://in-toto.io/Statement/v0.1`.
"predicateType": "A String", # `https://slsa.dev/provenance/v0.1` for SlsaProvenance.
"provenance": {
"builderConfig": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenance": {
"builder": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
{
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenanceZeroTwo": { # See full explanation of fields at slsa.dev/provenance/v0.2.
"buildConfig": {
"a_key": "", # Properties of the object.
},
"buildType": "A String",
"builder": { # Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance.
"id": "A String",
},
"invocation": { # Identifies the event that kicked off the build.
"configSource": { # Describes where the config file that kicked off the build came from. This is effectively a pointer to the source where buildConfig came from.
"digest": {
"a_key": "A String",
},
"entryPoint": "A String",
"uri": "A String",
},
"environment": {
"a_key": "", # Properties of the object.
},
"parameters": {
"a_key": "", # Properties of the object.
},
},
"materials": [
{ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on.
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String",
"buildInvocationId": "A String",
"buildStartedOn": "A String",
"completeness": { # Indicates that the builder claims certain fields in this message to be complete.
"environment": True or False,
"materials": True or False,
"parameters": True or False,
},
"reproducible": True or False,
},
},
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # The actual provenance for the build.
"buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.
"a_key": "A String",
},
"builderVersion": "A String", # Version string of the builder at the time this build was executed.
"builtArtifacts": [ # Output of the build.
{ # Artifact describes a build product.
"checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.
"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.
"names": [ # 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.
"A String",
],
},
],
"commands": [ # Commands requested by the build.
{ # Command describes a step performed as part of the build pipeline.
"args": [ # Command-line arguments used when executing this command.
"A String",
],
"dir": "A String", # Working directory (relative to project source root) used when running this command.
"env": [ # Environment variables set before running this command.
"A String",
],
"id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.
"name": "A String", # 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`.
"waitFor": [ # The ID(s) of the command(s) that this command depends on.
"A String",
],
},
],
"createTime": "A String", # Time at which the build was created.
"creator": "A String", # 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.
"endTime": "A String", # Time at which execution of the build was finished.
"id": "A String", # Required. Unique identifier of the build.
"logsUri": "A String", # URI where any logs for this provenance were written.
"projectId": "A String", # ID of the project.
"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.
"additionalContexts": [ # 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.
{ # 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.
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
"uid": "A String", # A server-assigned, globally unique identifier.
},
"revisionId": "A String", # A revision ID.
},
"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"gerritProject": "A String", # 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.
"hostUri": "A String", # The URI of a running Gerrit instance.
"revisionId": "A String", # A revision (commit) ID.
},
"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).
"revisionId": "A String", # Git commit hash.
"url": "A String", # Git repository URL.
},
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
},
],
"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.
"context": { # 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. # If provided, the source code used for the build came from this location.
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
"uid": "A String", # A server-assigned, globally unique identifier.
},
"revisionId": "A String", # A revision ID.
},
"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"gerritProject": "A String", # 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.
"hostUri": "A String", # The URI of a running Gerrit instance.
"revisionId": "A String", # A revision (commit) ID.
},
"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).
"revisionId": "A String", # Git commit hash.
"url": "A String", # Git repository URL.
},
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
},
"fileHashes": { # 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.
"a_key": { # Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build.
"fileHash": [ # Required. Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # Required. The type of hash that was performed, e.g. "SHA-256".
"value": "A String", # Required. The hash value.
},
],
},
},
},
"startTime": "A String", # Time at which execution of the build was started.
"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
},
"provenanceBytes": "A String", # 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.
},
"compliance": { # An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. # Describes a compliance violation on a linked resource.
"nonComplianceReason": "A String",
"nonCompliantFiles": [
{ # Details about files that caused a compliance check to fail. display_command is a single command that can be used to display a list of non compliant files. When there is no such command, we can also iterate a list of non compliant file using 'path'.
"displayCommand": "A String", # Command to display the non-compliant files.
"path": "A String", # Empty if `display_command` is set.
"reason": "A String", # Explains why a file is non compliant for a CIS check.
},
],
"version": { # Describes the CIS benchmark version that is applicable to a given OS and os version. # The OS and config version the benchmark was run on.
"benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
"cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
"version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
},
},
"createTime": "A String", # Output only. The time this occurrence was created.
"deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.
"address": "A String", # Address of the runtime element hosting this deployment.
"config": "A String", # Configuration used to create this deployment.
"deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
"platform": "A String", # Platform hosting this deployment.
"resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
"A String",
],
"undeployTime": "A String", # End of the lifetime of this deployment.
"userEmail": "A String", # Identity of the user that triggered this deployment.
},
"discovery": { # Provides information about the analysis status of a discovered resource. # Describes when a resource was discovered.
"analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource.
"analysisType": [
"A String",
],
},
"analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors.
{ # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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 field, or localized by the client.
},
],
"analysisStatus": "A String", # The status of discovery for the resource.
"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # 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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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 field, or localized by the client.
},
"archiveTime": "A String", # Output only. The time occurrences related to this discovery occurrence were archived.
"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
"cpe": "A String", # The CPE of the resource being scanned.
"lastScanTime": "A String", # The last time this resource was scanned.
"sbomStatus": { # The status of an SBOM generation. # The status of an SBOM generation.
"error": "A String", # If there was an error generating an SBOM, this will indicate what that error was.
"sbomState": "A String", # The progress of the SBOM generation.
},
},
"dsseAttestation": { # Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. # Describes an attestation of an artifact using dsse.
"envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # If doing something security critical, make sure to verify the signatures in this metadata.
"payload": "A String",
"payloadType": "A String",
"signatures": [
{
"keyid": "A String",
"sig": "A String",
},
],
},
"statement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json".
"_type": "A String", # Always `https://in-toto.io/Statement/v0.1`.
"predicateType": "A String", # `https://slsa.dev/provenance/v0.1` for SlsaProvenance.
"provenance": {
"builderConfig": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenance": {
"builder": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
{
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenanceZeroTwo": { # See full explanation of fields at slsa.dev/provenance/v0.2.
"buildConfig": {
"a_key": "", # Properties of the object.
},
"buildType": "A String",
"builder": { # Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance.
"id": "A String",
},
"invocation": { # Identifies the event that kicked off the build.
"configSource": { # Describes where the config file that kicked off the build came from. This is effectively a pointer to the source where buildConfig came from.
"digest": {
"a_key": "A String",
},
"entryPoint": "A String",
"uri": "A String",
},
"environment": {
"a_key": "", # Properties of the object.
},
"parameters": {
"a_key": "", # Properties of the object.
},
},
"materials": [
{ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on.
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String",
"buildInvocationId": "A String",
"buildStartedOn": "A String",
"completeness": { # Indicates that the builder claims certain fields in this message to be complete.
"environment": True or False,
"materials": True or False,
"parameters": True or False,
},
"reproducible": True or False,
},
},
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
},
"envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # https://github.com/secure-systems-lab/dsse
"payload": "A String",
"payloadType": "A String",
"signatures": [
{
"keyid": "A String",
"sig": "A String",
},
],
},
"image": { # Details of the derived image portion of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Describes how this resource derives from the basis in the associated note.
"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
"distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.
"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
"A String",
],
"v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
},
"layerInfo": [ # 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.
{ # Layer holds metadata specific to a layer of a Docker image.
"arguments": "A String", # The recovered arguments to the Dockerfile directive.
"directive": "A String", # Required. The recovered Dockerfile directive used to construct this layer. See https://docs.docker.com/engine/reference/builder/ for more information.
},
],
},
"kind": "A String", # Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests.
"name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
"noteName": "A String", # 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.
"package": { # Details on how a particular software package was installed on a system. # Describes the installation of a package on the linked resource.
"architecture": "A String", # Output only. The CPU architecture for which packages in this distribution channel were built. Architecture will be blank for language packages.
"cpeUri": "A String", # Output only. 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.
"license": { # License information. # Licenses that have been declared by the authors of the package.
"comments": "A String", # Comments
"expression": "A String", # 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".
},
"location": [ # All of the places within the filesystem versions of this package have been found.
{ # An occurrence of a particular package installation found within a system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.
"cpeUri": "A String", # Deprecated. The CPE URI in [CPE format](https://cpe.mitre.org/specification/)
"path": "A String", # The path from which we gathered that this package/version is installed.
"version": { # Version contains structured information about the version of a package. # Deprecated. The version installed at this location.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
],
"name": "A String", # Required. Output only. The name of the installed package.
"packageType": "A String", # Output only. The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"version": { # Version contains structured information about the version of a package. # Output only. The version of the package.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
"remediation": "A String", # A description of actions that can be taken to remedy the note.
"resourceUri": "A String", # Required. Immutable. A URI that represents the resource for which the occurrence applies. For example, `https://gcr.io/project/image@sha256:123abc` for a Docker image.
"sbomReference": { # The occurrence representing an SBOM reference as applied to a specific resource. The occurrence follows the DSSE specification. See https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for more details. # Describes a specific SBOM reference occurrences.
"payload": { # The actual payload that contains the SBOM Reference data. The payload follows the intoto statement specification. See https://github.com/in-toto/attestation/blob/main/spec/v1.0/statement.md for more details. # The actual payload that contains the SBOM reference data.
"_type": "A String", # Identifier for the schema of the Statement.
"predicate": { # A predicate which describes the SBOM being referenced. # Additional parameters of the Predicate. Includes the actual data about the SBOM.
"digest": { # A map of algorithm to digest of the contents of the SBOM.
"a_key": "A String",
},
"location": "A String", # The location of the SBOM.
"mimeType": "A String", # The mime type of the SBOM.
"referrerId": "A String", # The person or system referring this predicate to the consumer.
},
"predicateType": "A String", # URI identifying the type of the Predicate.
"subject": [ # Set of software artifacts that the attestation applies to. Each element represents a single software artifact.
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"payloadType": "A String", # The kind of payload that SbomReferenceIntotoPayload takes. Since it's in the intoto format, this value is expected to be 'application/vnd.in-toto+json'.
"signatures": [ # The signatures over the payload.
{
"keyid": "A String",
"sig": "A String",
},
],
},
"updateTime": "A String", # Output only. The time this occurrence was last updated.
"upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). For Windows, both distribution and windows_update contain information for the Windows update. # Describes an available package upgrade on the linked resource.
"distribution": { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities. # Metadata about the upgrade for available for the specific operating system for the resource_url. This allows efficient filtering, as well as making it easier to use the occurrence.
"classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. For Windows the classification is one of the category_ids listed at https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85)
"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
"cve": [ # The cve tied to this Upgrade.
"A String",
],
"severity": "A String", # The severity as specified by the upstream operating system.
},
"package": "A String", # Required for non-Windows OS. The package this Upgrade is for.
"parsedVersion": { # Version contains structured information about the version of a package. # Required for non-Windows OS. The version of the package in a machine + human readable form.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"windowsUpdate": { # Windows Update represents the metadata about the update for the Windows operating system. The fields in this message come from the Windows Update API documented at https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. # Required for Windows OS. Represents the metadata about the Windows update.
"categories": [ # The list of categories to which the update belongs.
{ # The category to which the update belongs.
"categoryId": "A String", # The identifier of the category.
"name": "A String", # The localized name of the category.
},
],
"description": "A String", # The localized description of the update.
"identity": { # The unique identifier of the update. # Required - The unique identifier for the update.
"revision": 42, # The revision number of the update.
"updateId": "A String", # The revision independent identifier of the update.
},
"kbArticleIds": [ # The Microsoft Knowledge Base article IDs that are associated with the update.
"A String",
],
"lastPublishedTimestamp": "A String", # The last published timestamp of the update.
"supportUrl": "A String", # The hyperlink to the support information for the update.
"title": "A String", # The localized title of the update.
},
},
"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability.
"cvssScore": 3.14, # 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.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity.
"cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. 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.
"extraDetails": "A String", # Occurrence-specific extra details about the vulnerability.
"fixAvailable": True or False, # Output only. Whether at least one of the affected packages has a fix available.
"longDescription": "A String", # Output only. A detailed description of this vulnerability.
"packageIssue": [ # Required. The set of affected locations and their fixes (if available) within the associated resource.
{ # A detail for a distro and package this vulnerability occurrence was found in and its associated fix (if one is available).
"affectedCpeUri": "A String", # Required. The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability was found in.
"affectedPackage": "A String", # Required. The package this vulnerability was found in.
"affectedVersion": { # Version contains structured information about the version of a package. # Required. The version of the package that is installed on the resource affected by this vulnerability.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"effectiveSeverity": "A String", # Output only. The distro or language system assigned severity for this vulnerability when that is available and note provider assigned severity when it is not available.
"fileLocation": [ # The location at which this package was found.
{ # Indicates the location at which a package was found.
"filePath": "A String", # For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.
},
],
"fixAvailable": True or False, # Output only. Whether a fix is available for this package.
"fixedCpeUri": "A String", # The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability was fixed in. It is possible for this to be different from the affected_cpe_uri.
"fixedPackage": "A String", # The package this vulnerability was fixed in. It is possible for this to be different from the affected_package.
"fixedVersion": { # Version contains structured information about the version of a package. # Required. The version of the package this vulnerability was fixed in. Setting this to VersionKind.MAXIMUM means no fix is yet available.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"packageType": "A String", # The type of package (e.g. OS, MAVEN, GO).
},
],
"relatedUrls": [ # Output only. URLs related to this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"severity": "A String", # Output only. The note provider assigned severity of this vulnerability.
"shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
"type": "A String", # The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"vexAssessment": { # VexAssessment provides all publisher provided Vex information that is related to this vulnerability.
"cve": "A String", # Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Deprecated: Use vulnerability_id instead to denote CVEs.
"impacts": [ # Contains information about the impact of this vulnerability, this will change with time.
"A String",
],
"justification": { # Justification provides the justification when the state of the assessment if NOT_AFFECTED. # Justification provides the justification when the state of the assessment if NOT_AFFECTED.
"details": "A String", # Additional details on why this justification was chosen.
"justificationType": "A String", # The justification type for this vulnerability.
},
"noteName": "A String", # The VulnerabilityAssessment note from which this VexAssessment was generated. This will be of the form: `projects/[PROJECT_ID]/notes/[NOTE_ID]`.
"relatedUris": [ # Holds a list of references associated with this vulnerability item and assessment.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"remediations": [ # Specifies details on how to handle (and presumably, fix) a vulnerability.
{ # Specifies details on how to handle (and presumably, fix) a vulnerability.
"details": "A String", # Contains a comprehensive human-readable discussion of the remediation.
"remediationType": "A String", # The type of remediation that can be applied.
"remediationUri": { # Metadata for any related URL information. # Contains the URL where to obtain the remediation.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
},
],
"state": "A String", # Provides the state of this Vulnerability assessment.
"vulnerabilityId": "A String", # The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.
},
},
},
],
}

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates a new occurrence.

Args:
parent: string, Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrence is to be created. (required)
body: object, The request body.
The object takes the form of:

{ # An instance of an analysis type that has been found on a resource.
"attestation": { # 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 lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact.
"jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas.
{
"compactJwt": "A String", # The compact encoding of a JWS, which is always three base64 encoded strings joined by periods. For details, see: https://tools.ietf.org/html/rfc7515.html#section-3.1
},
],
"serializedPayload": "A String", # Required. The serialized payload that is verified by one or more `signatures`.
"signatures": [ # 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.
{ # 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).
"publicKeyId": "A String", # 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"
"signature": "A String", # 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.
},
],
},
"build": { # Details of a build occurrence. # Describes a verifiable build.
"inTotoSlsaProvenanceV1": { # In-Toto Slsa Provenance V1 represents a slsa provenance meeting the slsa spec, wrapped in an in-toto statement. This allows for direct jsonification of a to-spec in-toto slsa statement with a to-spec slsa provenance.
"_type": "A String", # InToto spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement
"predicate": { # Keep in sync with schema at https://github.com/slsa-framework/slsa/blob/main/docs/provenance/schema/v1/provenance.proto Builder renamed to ProvenanceBuilder because of Java conflicts.
"buildDefinition": {
"buildType": "A String",
"externalParameters": {
"a_key": "", # Properties of the object.
},
"internalParameters": {
"a_key": "", # Properties of the object.
},
"resolvedDependencies": [
{
"annotations": {
"a_key": "",
},
"content": "A String",
"digest": {
"a_key": "A String",
},
"downloadLocation": "A String",
"mediaType": "A String",
"name": "A String",
"uri": "A String",
},
],
},
"runDetails": {
"builder": {
"builderDependencies": [
{
"annotations": {
"a_key": "",
},
"content": "A String",
"digest": {
"a_key": "A String",
},
"downloadLocation": "A String",
"mediaType": "A String",
"name": "A String",
"uri": "A String",
},
],
"id": "A String",
"version": {
"a_key": "A String",
},
},
"byproducts": [
{
"annotations": {
"a_key": "",
},
"content": "A String",
"digest": {
"a_key": "A String",
},
"downloadLocation": "A String",
"mediaType": "A String",
"name": "A String",
"uri": "A String",
},
],
"metadata": {
"finishedOn": "A String",
"invocationId": "A String",
"startedOn": "A String",
},
},
},
"predicateType": "A String",
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"intotoProvenance": { # Deprecated. See InTotoStatement for the replacement. In-toto Provenance representation as defined in spec.
"builderConfig": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"intotoStatement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json". # In-toto Statement representation as defined in spec. The intoto_statement can contain any type of provenance. The serialized payload of the statement can be stored and signed in the Occurrence's envelope.
"_type": "A String", # Always `https://in-toto.io/Statement/v0.1`.
"predicateType": "A String", # `https://slsa.dev/provenance/v0.1` for SlsaProvenance.
"provenance": {
"builderConfig": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenance": {
"builder": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
{
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenanceZeroTwo": { # See full explanation of fields at slsa.dev/provenance/v0.2.
"buildConfig": {
"a_key": "", # Properties of the object.
},
"buildType": "A String",
"builder": { # Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance.
"id": "A String",
},
"invocation": { # Identifies the event that kicked off the build.
"configSource": { # Describes where the config file that kicked off the build came from. This is effectively a pointer to the source where buildConfig came from.
"digest": {
"a_key": "A String",
},
"entryPoint": "A String",
"uri": "A String",
},
"environment": {
"a_key": "", # Properties of the object.
},
"parameters": {
"a_key": "", # Properties of the object.
},
},
"materials": [
{ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on.
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String",
"buildInvocationId": "A String",
"buildStartedOn": "A String",
"completeness": { # Indicates that the builder claims certain fields in this message to be complete.
"environment": True or False,
"materials": True or False,
"parameters": True or False,
},
"reproducible": True or False,
},
},
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # The actual provenance for the build.
"buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.
"a_key": "A String",
},
"builderVersion": "A String", # Version string of the builder at the time this build was executed.
"builtArtifacts": [ # Output of the build.
{ # Artifact describes a build product.
"checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.
"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.
"names": [ # 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.
"A String",
],
},
],
"commands": [ # Commands requested by the build.
{ # Command describes a step performed as part of the build pipeline.
"args": [ # Command-line arguments used when executing this command.
"A String",
],
"dir": "A String", # Working directory (relative to project source root) used when running this command.
"env": [ # Environment variables set before running this command.
"A String",
],
"id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.
"name": "A String", # 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`.
"waitFor": [ # The ID(s) of the command(s) that this command depends on.
"A String",
],
},
],
"createTime": "A String", # Time at which the build was created.
"creator": "A String", # 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.
"endTime": "A String", # Time at which execution of the build was finished.
"id": "A String", # Required. Unique identifier of the build.
"logsUri": "A String", # URI where any logs for this provenance were written.
"projectId": "A String", # ID of the project.
"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.
"additionalContexts": [ # 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.
{ # 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.
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
"uid": "A String", # A server-assigned, globally unique identifier.
},
"revisionId": "A String", # A revision ID.
},
"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"gerritProject": "A String", # 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.
"hostUri": "A String", # The URI of a running Gerrit instance.
"revisionId": "A String", # A revision (commit) ID.
},
"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).
"revisionId": "A String", # Git commit hash.
"url": "A String", # Git repository URL.
},
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
},
],
"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.
"context": { # 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. # If provided, the source code used for the build came from this location.
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
"uid": "A String", # A server-assigned, globally unique identifier.
},
"revisionId": "A String", # A revision ID.
},
"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"gerritProject": "A String", # 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.
"hostUri": "A String", # The URI of a running Gerrit instance.
"revisionId": "A String", # A revision (commit) ID.
},
"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).
"revisionId": "A String", # Git commit hash.
"url": "A String", # Git repository URL.
},
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
},
"fileHashes": { # 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.
"a_key": { # Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build.
"fileHash": [ # Required. Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # Required. The type of hash that was performed, e.g. "SHA-256".
"value": "A String", # Required. The hash value.
},
],
},
},
},
"startTime": "A String", # Time at which execution of the build was started.
"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
},
"provenanceBytes": "A String", # 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.
},
"compliance": { # An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. # Describes a compliance violation on a linked resource.
"nonComplianceReason": "A String",
"nonCompliantFiles": [
{ # Details about files that caused a compliance check to fail. display_command is a single command that can be used to display a list of non compliant files. When there is no such command, we can also iterate a list of non compliant file using 'path'.
"displayCommand": "A String", # Command to display the non-compliant files.
"path": "A String", # Empty if `display_command` is set.
"reason": "A String", # Explains why a file is non compliant for a CIS check.
},
],
"version": { # Describes the CIS benchmark version that is applicable to a given OS and os version. # The OS and config version the benchmark was run on.
"benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
"cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
"version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
},
},
"createTime": "A String", # Output only. The time this occurrence was created.
"deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.
"address": "A String", # Address of the runtime element hosting this deployment.
"config": "A String", # Configuration used to create this deployment.
"deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
"platform": "A String", # Platform hosting this deployment.
"resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
"A String",
],
"undeployTime": "A String", # End of the lifetime of this deployment.
"userEmail": "A String", # Identity of the user that triggered this deployment.
},
"discovery": { # Provides information about the analysis status of a discovered resource. # Describes when a resource was discovered.
"analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource.
"analysisType": [
"A String",
],
},
"analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors.
{ # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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 field, or localized by the client.
},
],
"analysisStatus": "A String", # The status of discovery for the resource.
"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # 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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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 field, or localized by the client.
},
"archiveTime": "A String", # Output only. The time occurrences related to this discovery occurrence were archived.
"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
"cpe": "A String", # The CPE of the resource being scanned.
"lastScanTime": "A String", # The last time this resource was scanned.
"sbomStatus": { # The status of an SBOM generation. # The status of an SBOM generation.
"error": "A String", # If there was an error generating an SBOM, this will indicate what that error was.
"sbomState": "A String", # The progress of the SBOM generation.
},
},
"dsseAttestation": { # Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. # Describes an attestation of an artifact using dsse.
"envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # If doing something security critical, make sure to verify the signatures in this metadata.
"payload": "A String",
"payloadType": "A String",
"signatures": [
{
"keyid": "A String",
"sig": "A String",
},
],
},
"statement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json".
"_type": "A String", # Always `https://in-toto.io/Statement/v0.1`.
"predicateType": "A String", # `https://slsa.dev/provenance/v0.1` for SlsaProvenance.
"provenance": {
"builderConfig": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenance": {
"builder": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
{
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenanceZeroTwo": { # See full explanation of fields at slsa.dev/provenance/v0.2.
"buildConfig": {
"a_key": "", # Properties of the object.
},
"buildType": "A String",
"builder": { # Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance.
"id": "A String",
},
"invocation": { # Identifies the event that kicked off the build.
"configSource": { # Describes where the config file that kicked off the build came from. This is effectively a pointer to the source where buildConfig came from.
"digest": {
"a_key": "A String",
},
"entryPoint": "A String",
"uri": "A String",
},
"environment": {
"a_key": "", # Properties of the object.
},
"parameters": {
"a_key": "", # Properties of the object.
},
},
"materials": [
{ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on.
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String",
"buildInvocationId": "A String",
"buildStartedOn": "A String",
"completeness": { # Indicates that the builder claims certain fields in this message to be complete.
"environment": True or False,
"materials": True or False,
"parameters": True or False,
},
"reproducible": True or False,
},
},
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
},
"envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # https://github.com/secure-systems-lab/dsse
"payload": "A String",
"payloadType": "A String",
"signatures": [
{
"keyid": "A String",
"sig": "A String",
},
],
},
"image": { # Details of the derived image portion of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Describes how this resource derives from the basis in the associated note.
"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
"distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.
"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
"A String",
],
"v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
},
"layerInfo": [ # 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.
{ # Layer holds metadata specific to a layer of a Docker image.
"arguments": "A String", # The recovered arguments to the Dockerfile directive.
"directive": "A String", # Required. The recovered Dockerfile directive used to construct this layer. See https://docs.docker.com/engine/reference/builder/ for more information.
},
],
},
"kind": "A String", # Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests.
"name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
"noteName": "A String", # 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.
"package": { # Details on how a particular software package was installed on a system. # Describes the installation of a package on the linked resource.
"architecture": "A String", # Output only. The CPU architecture for which packages in this distribution channel were built. Architecture will be blank for language packages.
"cpeUri": "A String", # Output only. 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.
"license": { # License information. # Licenses that have been declared by the authors of the package.
"comments": "A String", # Comments
"expression": "A String", # 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".
},
"location": [ # All of the places within the filesystem versions of this package have been found.
{ # An occurrence of a particular package installation found within a system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.
"cpeUri": "A String", # Deprecated. The CPE URI in [CPE format](https://cpe.mitre.org/specification/)
"path": "A String", # The path from which we gathered that this package/version is installed.
"version": { # Version contains structured information about the version of a package. # Deprecated. The version installed at this location.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
],
"name": "A String", # Required. Output only. The name of the installed package.
"packageType": "A String", # Output only. The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"version": { # Version contains structured information about the version of a package. # Output only. The version of the package.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
"remediation": "A String", # A description of actions that can be taken to remedy the note.
"resourceUri": "A String", # Required. Immutable. A URI that represents the resource for which the occurrence applies. For example, `https://gcr.io/project/image@sha256:123abc` for a Docker image.
"sbomReference": { # The occurrence representing an SBOM reference as applied to a specific resource. The occurrence follows the DSSE specification. See https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for more details. # Describes a specific SBOM reference occurrences.
"payload": { # The actual payload that contains the SBOM Reference data. The payload follows the intoto statement specification. See https://github.com/in-toto/attestation/blob/main/spec/v1.0/statement.md for more details. # The actual payload that contains the SBOM reference data.
"_type": "A String", # Identifier for the schema of the Statement.
"predicate": { # A predicate which describes the SBOM being referenced. # Additional parameters of the Predicate. Includes the actual data about the SBOM.
"digest": { # A map of algorithm to digest of the contents of the SBOM.
"a_key": "A String",
},
"location": "A String", # The location of the SBOM.
"mimeType": "A String", # The mime type of the SBOM.
"referrerId": "A String", # The person or system referring this predicate to the consumer.
},
"predicateType": "A String", # URI identifying the type of the Predicate.
"subject": [ # Set of software artifacts that the attestation applies to. Each element represents a single software artifact.
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"payloadType": "A String", # The kind of payload that SbomReferenceIntotoPayload takes. Since it's in the intoto format, this value is expected to be 'application/vnd.in-toto+json'.
"signatures": [ # The signatures over the payload.
{
"keyid": "A String",
"sig": "A String",
},
],
},
"updateTime": "A String", # Output only. The time this occurrence was last updated.
"upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). For Windows, both distribution and windows_update contain information for the Windows update. # Describes an available package upgrade on the linked resource.
"distribution": { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities. # Metadata about the upgrade for available for the specific operating system for the resource_url. This allows efficient filtering, as well as making it easier to use the occurrence.
"classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. For Windows the classification is one of the category_ids listed at https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85)
"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
"cve": [ # The cve tied to this Upgrade.
"A String",
],
"severity": "A String", # The severity as specified by the upstream operating system.
},
"package": "A String", # Required for non-Windows OS. The package this Upgrade is for.
"parsedVersion": { # Version contains structured information about the version of a package. # Required for non-Windows OS. The version of the package in a machine + human readable form.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"windowsUpdate": { # Windows Update represents the metadata about the update for the Windows operating system. The fields in this message come from the Windows Update API documented at https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. # Required for Windows OS. Represents the metadata about the Windows update.
"categories": [ # The list of categories to which the update belongs.
{ # The category to which the update belongs.
"categoryId": "A String", # The identifier of the category.
"name": "A String", # The localized name of the category.
},
],
"description": "A String", # The localized description of the update.
"identity": { # The unique identifier of the update. # Required - The unique identifier for the update.
"revision": 42, # The revision number of the update.
"updateId": "A String", # The revision independent identifier of the update.
},
"kbArticleIds": [ # The Microsoft Knowledge Base article IDs that are associated with the update.
"A String",
],
"lastPublishedTimestamp": "A String", # The last published timestamp of the update.
"supportUrl": "A String", # The hyperlink to the support information for the update.
"title": "A String", # The localized title of the update.
},
},
"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability.
"cvssScore": 3.14, # 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.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity.
"cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. 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.
"extraDetails": "A String", # Occurrence-specific extra details about the vulnerability.
"fixAvailable": True or False, # Output only. Whether at least one of the affected packages has a fix available.
"longDescription": "A String", # Output only. A detailed description of this vulnerability.
"packageIssue": [ # Required. The set of affected locations and their fixes (if available) within the associated resource.
{ # A detail for a distro and package this vulnerability occurrence was found in and its associated fix (if one is available).
"affectedCpeUri": "A String", # Required. The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability was found in.
"affectedPackage": "A String", # Required. The package this vulnerability was found in.
"affectedVersion": { # Version contains structured information about the version of a package. # Required. The version of the package that is installed on the resource affected by this vulnerability.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"effectiveSeverity": "A String", # Output only. The distro or language system assigned severity for this vulnerability when that is available and note provider assigned severity when it is not available.
"fileLocation": [ # The location at which this package was found.
{ # Indicates the location at which a package was found.
"filePath": "A String", # For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.
},
],
"fixAvailable": True or False, # Output only. Whether a fix is available for this package.
"fixedCpeUri": "A String", # The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability was fixed in. It is possible for this to be different from the affected_cpe_uri.
"fixedPackage": "A String", # The package this vulnerability was fixed in. It is possible for this to be different from the affected_package.
"fixedVersion": { # Version contains structured information about the version of a package. # Required. The version of the package this vulnerability was fixed in. Setting this to VersionKind.MAXIMUM means no fix is yet available.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"packageType": "A String", # The type of package (e.g. OS, MAVEN, GO).
},
],
"relatedUrls": [ # Output only. URLs related to this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"severity": "A String", # Output only. The note provider assigned severity of this vulnerability.
"shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
"type": "A String", # The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"vexAssessment": { # VexAssessment provides all publisher provided Vex information that is related to this vulnerability.
"cve": "A String", # Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Deprecated: Use vulnerability_id instead to denote CVEs.
"impacts": [ # Contains information about the impact of this vulnerability, this will change with time.
"A String",
],
"justification": { # Justification provides the justification when the state of the assessment if NOT_AFFECTED. # Justification provides the justification when the state of the assessment if NOT_AFFECTED.
"details": "A String", # Additional details on why this justification was chosen.
"justificationType": "A String", # The justification type for this vulnerability.
},
"noteName": "A String", # The VulnerabilityAssessment note from which this VexAssessment was generated. This will be of the form: `projects/[PROJECT_ID]/notes/[NOTE_ID]`.
"relatedUris": [ # Holds a list of references associated with this vulnerability item and assessment.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"remediations": [ # Specifies details on how to handle (and presumably, fix) a vulnerability.
{ # Specifies details on how to handle (and presumably, fix) a vulnerability.
"details": "A String", # Contains a comprehensive human-readable discussion of the remediation.
"remediationType": "A String", # The type of remediation that can be applied.
"remediationUri": { # Metadata for any related URL information. # Contains the URL where to obtain the remediation.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
},
],
"state": "A String", # Provides the state of this Vulnerability assessment.
"vulnerabilityId": "A String", # The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.
},
},
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # An instance of an analysis type that has been found on a resource.
"attestation": { # 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 lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact.
"jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas.
{
"compactJwt": "A String", # The compact encoding of a JWS, which is always three base64 encoded strings joined by periods. For details, see: https://tools.ietf.org/html/rfc7515.html#section-3.1
},
],
"serializedPayload": "A String", # Required. The serialized payload that is verified by one or more `signatures`.
"signatures": [ # 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.
{ # 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).
"publicKeyId": "A String", # 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"
"signature": "A String", # 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.
},
],
},
"build": { # Details of a build occurrence. # Describes a verifiable build.
"inTotoSlsaProvenanceV1": { # In-Toto Slsa Provenance V1 represents a slsa provenance meeting the slsa spec, wrapped in an in-toto statement. This allows for direct jsonification of a to-spec in-toto slsa statement with a to-spec slsa provenance.
"_type": "A String", # InToto spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement
"predicate": { # Keep in sync with schema at https://github.com/slsa-framework/slsa/blob/main/docs/provenance/schema/v1/provenance.proto Builder renamed to ProvenanceBuilder because of Java conflicts.
"buildDefinition": {
"buildType": "A String",
"externalParameters": {
"a_key": "", # Properties of the object.
},
"internalParameters": {
"a_key": "", # Properties of the object.
},
"resolvedDependencies": [
{
"annotations": {
"a_key": "",
},
"content": "A String",
"digest": {
"a_key": "A String",
},
"downloadLocation": "A String",
"mediaType": "A String",
"name": "A String",
"uri": "A String",
},
],
},
"runDetails": {
"builder": {
"builderDependencies": [
{
"annotations": {
"a_key": "",
},
"content": "A String",
"digest": {
"a_key": "A String",
},
"downloadLocation": "A String",
"mediaType": "A String",
"name": "A String",
"uri": "A String",
},
],
"id": "A String",
"version": {
"a_key": "A String",
},
},
"byproducts": [
{
"annotations": {
"a_key": "",
},
"content": "A String",
"digest": {
"a_key": "A String",
},
"downloadLocation": "A String",
"mediaType": "A String",
"name": "A String",
"uri": "A String",
},
],
"metadata": {
"finishedOn": "A String",
"invocationId": "A String",
"startedOn": "A String",
},
},
},
"predicateType": "A String",
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"intotoProvenance": { # Deprecated. See InTotoStatement for the replacement. In-toto Provenance representation as defined in spec.
"builderConfig": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"intotoStatement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json". # In-toto Statement representation as defined in spec. The intoto_statement can contain any type of provenance. The serialized payload of the statement can be stored and signed in the Occurrence's envelope.
"_type": "A String", # Always `https://in-toto.io/Statement/v0.1`.
"predicateType": "A String", # `https://slsa.dev/provenance/v0.1` for SlsaProvenance.
"provenance": {
"builderConfig": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenance": {
"builder": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
{
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenanceZeroTwo": { # See full explanation of fields at slsa.dev/provenance/v0.2.
"buildConfig": {
"a_key": "", # Properties of the object.
},
"buildType": "A String",
"builder": { # Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance.
"id": "A String",
},
"invocation": { # Identifies the event that kicked off the build.
"configSource": { # Describes where the config file that kicked off the build came from. This is effectively a pointer to the source where buildConfig came from.
"digest": {
"a_key": "A String",
},
"entryPoint": "A String",
"uri": "A String",
},
"environment": {
"a_key": "", # Properties of the object.
},
"parameters": {
"a_key": "", # Properties of the object.
},
},
"materials": [
{ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on.
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String",
"buildInvocationId": "A String",
"buildStartedOn": "A String",
"completeness": { # Indicates that the builder claims certain fields in this message to be complete.
"environment": True or False,
"materials": True or False,
"parameters": True or False,
},
"reproducible": True or False,
},
},
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # The actual provenance for the build.
"buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.
"a_key": "A String",
},
"builderVersion": "A String", # Version string of the builder at the time this build was executed.
"builtArtifacts": [ # Output of the build.
{ # Artifact describes a build product.
"checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.
"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.
"names": [ # 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.
"A String",
],
},
],
"commands": [ # Commands requested by the build.
{ # Command describes a step performed as part of the build pipeline.
"args": [ # Command-line arguments used when executing this command.
"A String",
],
"dir": "A String", # Working directory (relative to project source root) used when running this command.
"env": [ # Environment variables set before running this command.
"A String",
],
"id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.
"name": "A String", # 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`.
"waitFor": [ # The ID(s) of the command(s) that this command depends on.
"A String",
],
},
],
"createTime": "A String", # Time at which the build was created.
"creator": "A String", # 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.
"endTime": "A String", # Time at which execution of the build was finished.
"id": "A String", # Required. Unique identifier of the build.
"logsUri": "A String", # URI where any logs for this provenance were written.
"projectId": "A String", # ID of the project.
"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.
"additionalContexts": [ # 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.
{ # 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.
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
"uid": "A String", # A server-assigned, globally unique identifier.
},
"revisionId": "A String", # A revision ID.
},
"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"gerritProject": "A String", # 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.
"hostUri": "A String", # The URI of a running Gerrit instance.
"revisionId": "A String", # A revision (commit) ID.
},
"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).
"revisionId": "A String", # Git commit hash.
"url": "A String", # Git repository URL.
},
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
},
],
"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.
"context": { # 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. # If provided, the source code used for the build came from this location.
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
"uid": "A String", # A server-assigned, globally unique identifier.
},
"revisionId": "A String", # A revision ID.
},
"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"gerritProject": "A String", # 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.
"hostUri": "A String", # The URI of a running Gerrit instance.
"revisionId": "A String", # A revision (commit) ID.
},
"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).
"revisionId": "A String", # Git commit hash.
"url": "A String", # Git repository URL.
},
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
},
"fileHashes": { # 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.
"a_key": { # Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build.
"fileHash": [ # Required. Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # Required. The type of hash that was performed, e.g. "SHA-256".
"value": "A String", # Required. The hash value.
},
],
},
},
},
"startTime": "A String", # Time at which execution of the build was started.
"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
},
"provenanceBytes": "A String", # 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.
},
"compliance": { # An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. # Describes a compliance violation on a linked resource.
"nonComplianceReason": "A String",
"nonCompliantFiles": [
{ # Details about files that caused a compliance check to fail. display_command is a single command that can be used to display a list of non compliant files. When there is no such command, we can also iterate a list of non compliant file using 'path'.
"displayCommand": "A String", # Command to display the non-compliant files.
"path": "A String", # Empty if `display_command` is set.
"reason": "A String", # Explains why a file is non compliant for a CIS check.
},
],
"version": { # Describes the CIS benchmark version that is applicable to a given OS and os version. # The OS and config version the benchmark was run on.
"benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
"cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
"version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
},
},
"createTime": "A String", # Output only. The time this occurrence was created.
"deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.
"address": "A String", # Address of the runtime element hosting this deployment.
"config": "A String", # Configuration used to create this deployment.
"deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
"platform": "A String", # Platform hosting this deployment.
"resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
"A String",
],
"undeployTime": "A String", # End of the lifetime of this deployment.
"userEmail": "A String", # Identity of the user that triggered this deployment.
},
"discovery": { # Provides information about the analysis status of a discovered resource. # Describes when a resource was discovered.
"analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource.
"analysisType": [
"A String",
],
},
"analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors.
{ # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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 field, or localized by the client.
},
],
"analysisStatus": "A String", # The status of discovery for the resource.
"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # 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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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 field, or localized by the client.
},
"archiveTime": "A String", # Output only. The time occurrences related to this discovery occurrence were archived.
"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
"cpe": "A String", # The CPE of the resource being scanned.
"lastScanTime": "A String", # The last time this resource was scanned.
"sbomStatus": { # The status of an SBOM generation. # The status of an SBOM generation.
"error": "A String", # If there was an error generating an SBOM, this will indicate what that error was.
"sbomState": "A String", # The progress of the SBOM generation.
},
},
"dsseAttestation": { # Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. # Describes an attestation of an artifact using dsse.
"envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # If doing something security critical, make sure to verify the signatures in this metadata.
"payload": "A String",
"payloadType": "A String",
"signatures": [
{
"keyid": "A String",
"sig": "A String",
},
],
},
"statement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json".
"_type": "A String", # Always `https://in-toto.io/Statement/v0.1`.
"predicateType": "A String", # `https://slsa.dev/provenance/v0.1` for SlsaProvenance.
"provenance": {
"builderConfig": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenance": {
"builder": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
{
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenanceZeroTwo": { # See full explanation of fields at slsa.dev/provenance/v0.2.
"buildConfig": {
"a_key": "", # Properties of the object.
},
"buildType": "A String",
"builder": { # Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance.
"id": "A String",
},
"invocation": { # Identifies the event that kicked off the build.
"configSource": { # Describes where the config file that kicked off the build came from. This is effectively a pointer to the source where buildConfig came from.
"digest": {
"a_key": "A String",
},
"entryPoint": "A String",
"uri": "A String",
},
"environment": {
"a_key": "", # Properties of the object.
},
"parameters": {
"a_key": "", # Properties of the object.
},
},
"materials": [
{ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on.
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String",
"buildInvocationId": "A String",
"buildStartedOn": "A String",
"completeness": { # Indicates that the builder claims certain fields in this message to be complete.
"environment": True or False,
"materials": True or False,
"parameters": True or False,
},
"reproducible": True or False,
},
},
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
},
"envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # https://github.com/secure-systems-lab/dsse
"payload": "A String",
"payloadType": "A String",
"signatures": [
{
"keyid": "A String",
"sig": "A String",
},
],
},
"image": { # Details of the derived image portion of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Describes how this resource derives from the basis in the associated note.
"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
"distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.
"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
"A String",
],
"v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
},
"layerInfo": [ # 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.
{ # Layer holds metadata specific to a layer of a Docker image.
"arguments": "A String", # The recovered arguments to the Dockerfile directive.
"directive": "A String", # Required. The recovered Dockerfile directive used to construct this layer. See https://docs.docker.com/engine/reference/builder/ for more information.
},
],
},
"kind": "A String", # Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests.
"name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
"noteName": "A String", # 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.
"package": { # Details on how a particular software package was installed on a system. # Describes the installation of a package on the linked resource.
"architecture": "A String", # Output only. The CPU architecture for which packages in this distribution channel were built. Architecture will be blank for language packages.
"cpeUri": "A String", # Output only. 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.
"license": { # License information. # Licenses that have been declared by the authors of the package.
"comments": "A String", # Comments
"expression": "A String", # 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".
},
"location": [ # All of the places within the filesystem versions of this package have been found.
{ # An occurrence of a particular package installation found within a system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.
"cpeUri": "A String", # Deprecated. The CPE URI in [CPE format](https://cpe.mitre.org/specification/)
"path": "A String", # The path from which we gathered that this package/version is installed.
"version": { # Version contains structured information about the version of a package. # Deprecated. The version installed at this location.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
],
"name": "A String", # Required. Output only. The name of the installed package.
"packageType": "A String", # Output only. The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"version": { # Version contains structured information about the version of a package. # Output only. The version of the package.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
"remediation": "A String", # A description of actions that can be taken to remedy the note.
"resourceUri": "A String", # Required. Immutable. A URI that represents the resource for which the occurrence applies. For example, `https://gcr.io/project/image@sha256:123abc` for a Docker image.
"sbomReference": { # The occurrence representing an SBOM reference as applied to a specific resource. The occurrence follows the DSSE specification. See https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for more details. # Describes a specific SBOM reference occurrences.
"payload": { # The actual payload that contains the SBOM Reference data. The payload follows the intoto statement specification. See https://github.com/in-toto/attestation/blob/main/spec/v1.0/statement.md for more details. # The actual payload that contains the SBOM reference data.
"_type": "A String", # Identifier for the schema of the Statement.
"predicate": { # A predicate which describes the SBOM being referenced. # Additional parameters of the Predicate. Includes the actual data about the SBOM.
"digest": { # A map of algorithm to digest of the contents of the SBOM.
"a_key": "A String",
},
"location": "A String", # The location of the SBOM.
"mimeType": "A String", # The mime type of the SBOM.
"referrerId": "A String", # The person or system referring this predicate to the consumer.
},
"predicateType": "A String", # URI identifying the type of the Predicate.
"subject": [ # Set of software artifacts that the attestation applies to. Each element represents a single software artifact.
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"payloadType": "A String", # The kind of payload that SbomReferenceIntotoPayload takes. Since it's in the intoto format, this value is expected to be 'application/vnd.in-toto+json'.
"signatures": [ # The signatures over the payload.
{
"keyid": "A String",
"sig": "A String",
},
],
},
"updateTime": "A String", # Output only. The time this occurrence was last updated.
"upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). For Windows, both distribution and windows_update contain information for the Windows update. # Describes an available package upgrade on the linked resource.
"distribution": { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities. # Metadata about the upgrade for available for the specific operating system for the resource_url. This allows efficient filtering, as well as making it easier to use the occurrence.
"classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. For Windows the classification is one of the category_ids listed at https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85)
"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
"cve": [ # The cve tied to this Upgrade.
"A String",
],
"severity": "A String", # The severity as specified by the upstream operating system.
},
"package": "A String", # Required for non-Windows OS. The package this Upgrade is for.
"parsedVersion": { # Version contains structured information about the version of a package. # Required for non-Windows OS. The version of the package in a machine + human readable form.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"windowsUpdate": { # Windows Update represents the metadata about the update for the Windows operating system. The fields in this message come from the Windows Update API documented at https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. # Required for Windows OS. Represents the metadata about the Windows update.
"categories": [ # The list of categories to which the update belongs.
{ # The category to which the update belongs.
"categoryId": "A String", # The identifier of the category.
"name": "A String", # The localized name of the category.
},
],
"description": "A String", # The localized description of the update.
"identity": { # The unique identifier of the update. # Required - The unique identifier for the update.
"revision": 42, # The revision number of the update.
"updateId": "A String", # The revision independent identifier of the update.
},
"kbArticleIds": [ # The Microsoft Knowledge Base article IDs that are associated with the update.
"A String",
],
"lastPublishedTimestamp": "A String", # The last published timestamp of the update.
"supportUrl": "A String", # The hyperlink to the support information for the update.
"title": "A String", # The localized title of the update.
},
},
"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability.
"cvssScore": 3.14, # 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.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity.
"cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. 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.
"extraDetails": "A String", # Occurrence-specific extra details about the vulnerability.
"fixAvailable": True or False, # Output only. Whether at least one of the affected packages has a fix available.
"longDescription": "A String", # Output only. A detailed description of this vulnerability.
"packageIssue": [ # Required. The set of affected locations and their fixes (if available) within the associated resource.
{ # A detail for a distro and package this vulnerability occurrence was found in and its associated fix (if one is available).
"affectedCpeUri": "A String", # Required. The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability was found in.
"affectedPackage": "A String", # Required. The package this vulnerability was found in.
"affectedVersion": { # Version contains structured information about the version of a package. # Required. The version of the package that is installed on the resource affected by this vulnerability.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"effectiveSeverity": "A String", # Output only. The distro or language system assigned severity for this vulnerability when that is available and note provider assigned severity when it is not available.
"fileLocation": [ # The location at which this package was found.
{ # Indicates the location at which a package was found.
"filePath": "A String", # For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.
},
],
"fixAvailable": True or False, # Output only. Whether a fix is available for this package.
"fixedCpeUri": "A String", # The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability was fixed in. It is possible for this to be different from the affected_cpe_uri.
"fixedPackage": "A String", # The package this vulnerability was fixed in. It is possible for this to be different from the affected_package.
"fixedVersion": { # Version contains structured information about the version of a package. # Required. The version of the package this vulnerability was fixed in. Setting this to VersionKind.MAXIMUM means no fix is yet available.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"packageType": "A String", # The type of package (e.g. OS, MAVEN, GO).
},
],
"relatedUrls": [ # Output only. URLs related to this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"severity": "A String", # Output only. The note provider assigned severity of this vulnerability.
"shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
"type": "A String", # The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"vexAssessment": { # VexAssessment provides all publisher provided Vex information that is related to this vulnerability.
"cve": "A String", # Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Deprecated: Use vulnerability_id instead to denote CVEs.
"impacts": [ # Contains information about the impact of this vulnerability, this will change with time.
"A String",
],
"justification": { # Justification provides the justification when the state of the assessment if NOT_AFFECTED. # Justification provides the justification when the state of the assessment if NOT_AFFECTED.
"details": "A String", # Additional details on why this justification was chosen.
"justificationType": "A String", # The justification type for this vulnerability.
},
"noteName": "A String", # The VulnerabilityAssessment note from which this VexAssessment was generated. This will be of the form: `projects/[PROJECT_ID]/notes/[NOTE_ID]`.
"relatedUris": [ # Holds a list of references associated with this vulnerability item and assessment.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"remediations": [ # Specifies details on how to handle (and presumably, fix) a vulnerability.
{ # Specifies details on how to handle (and presumably, fix) a vulnerability.
"details": "A String", # Contains a comprehensive human-readable discussion of the remediation.
"remediationType": "A String", # The type of remediation that can be applied.
"remediationUri": { # Metadata for any related URL information. # Contains the URL where to obtain the remediation.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
},
],
"state": "A String", # Provides the state of this Vulnerability assessment.
"vulnerabilityId": "A String", # The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.
},
},
}

delete(name, x__xgafv=None)

Deletes the specified occurrence. For example, use this method to delete an occurrence when the occurrence is no longer applicable for the given resource.

Args:
  name: string, Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Gets the specified occurrence.

Args:
name: string, Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # An instance of an analysis type that has been found on a resource.
"attestation": { # 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 lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact.
"jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas.
{
"compactJwt": "A String", # The compact encoding of a JWS, which is always three base64 encoded strings joined by periods. For details, see: https://tools.ietf.org/html/rfc7515.html#section-3.1
},
],
"serializedPayload": "A String", # Required. The serialized payload that is verified by one or more `signatures`.
"signatures": [ # 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.
{ # 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).
"publicKeyId": "A String", # 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"
"signature": "A String", # 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.
},
],
},
"build": { # Details of a build occurrence. # Describes a verifiable build.
"inTotoSlsaProvenanceV1": { # In-Toto Slsa Provenance V1 represents a slsa provenance meeting the slsa spec, wrapped in an in-toto statement. This allows for direct jsonification of a to-spec in-toto slsa statement with a to-spec slsa provenance.
"_type": "A String", # InToto spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement
"predicate": { # Keep in sync with schema at https://github.com/slsa-framework/slsa/blob/main/docs/provenance/schema/v1/provenance.proto Builder renamed to ProvenanceBuilder because of Java conflicts.
"buildDefinition": {
"buildType": "A String",
"externalParameters": {
"a_key": "", # Properties of the object.
},
"internalParameters": {
"a_key": "", # Properties of the object.
},
"resolvedDependencies": [
{
"annotations": {
"a_key": "",
},
"content": "A String",
"digest": {
"a_key": "A String",
},
"downloadLocation": "A String",
"mediaType": "A String",
"name": "A String",
"uri": "A String",
},
],
},
"runDetails": {
"builder": {
"builderDependencies": [
{
"annotations": {
"a_key": "",
},
"content": "A String",
"digest": {
"a_key": "A String",
},
"downloadLocation": "A String",
"mediaType": "A String",
"name": "A String",
"uri": "A String",
},
],
"id": "A String",
"version": {
"a_key": "A String",
},
},
"byproducts": [
{
"annotations": {
"a_key": "",
},
"content": "A String",
"digest": {
"a_key": "A String",
},
"downloadLocation": "A String",
"mediaType": "A String",
"name": "A String",
"uri": "A String",
},
],
"metadata": {
"finishedOn": "A String",
"invocationId": "A String",
"startedOn": "A String",
},
},
},
"predicateType": "A String",
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"intotoProvenance": { # Deprecated. See InTotoStatement for the replacement. In-toto Provenance representation as defined in spec.
"builderConfig": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"intotoStatement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json". # In-toto Statement representation as defined in spec. The intoto_statement can contain any type of provenance. The serialized payload of the statement can be stored and signed in the Occurrence's envelope.
"_type": "A String", # Always `https://in-toto.io/Statement/v0.1`.
"predicateType": "A String", # `https://slsa.dev/provenance/v0.1` for SlsaProvenance.
"provenance": {
"builderConfig": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenance": {
"builder": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
{
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenanceZeroTwo": { # See full explanation of fields at slsa.dev/provenance/v0.2.
"buildConfig": {
"a_key": "", # Properties of the object.
},
"buildType": "A String",
"builder": { # Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance.
"id": "A String",
},
"invocation": { # Identifies the event that kicked off the build.
"configSource": { # Describes where the config file that kicked off the build came from. This is effectively a pointer to the source where buildConfig came from.
"digest": {
"a_key": "A String",
},
"entryPoint": "A String",
"uri": "A String",
},
"environment": {
"a_key": "", # Properties of the object.
},
"parameters": {
"a_key": "", # Properties of the object.
},
},
"materials": [
{ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on.
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String",
"buildInvocationId": "A String",
"buildStartedOn": "A String",
"completeness": { # Indicates that the builder claims certain fields in this message to be complete.
"environment": True or False,
"materials": True or False,
"parameters": True or False,
},
"reproducible": True or False,
},
},
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # The actual provenance for the build.
"buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.
"a_key": "A String",
},
"builderVersion": "A String", # Version string of the builder at the time this build was executed.
"builtArtifacts": [ # Output of the build.
{ # Artifact describes a build product.
"checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.
"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.
"names": [ # 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.
"A String",
],
},
],
"commands": [ # Commands requested by the build.
{ # Command describes a step performed as part of the build pipeline.
"args": [ # Command-line arguments used when executing this command.
"A String",
],
"dir": "A String", # Working directory (relative to project source root) used when running this command.
"env": [ # Environment variables set before running this command.
"A String",
],
"id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.
"name": "A String", # 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`.
"waitFor": [ # The ID(s) of the command(s) that this command depends on.
"A String",
],
},
],
"createTime": "A String", # Time at which the build was created.
"creator": "A String", # 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.
"endTime": "A String", # Time at which execution of the build was finished.
"id": "A String", # Required. Unique identifier of the build.
"logsUri": "A String", # URI where any logs for this provenance were written.
"projectId": "A String", # ID of the project.
"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.
"additionalContexts": [ # 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.
{ # 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.
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
"uid": "A String", # A server-assigned, globally unique identifier.
},
"revisionId": "A String", # A revision ID.
},
"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"gerritProject": "A String", # 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.
"hostUri": "A String", # The URI of a running Gerrit instance.
"revisionId": "A String", # A revision (commit) ID.
},
"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).
"revisionId": "A String", # Git commit hash.
"url": "A String", # Git repository URL.
},
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
},
],
"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.
"context": { # 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. # If provided, the source code used for the build came from this location.
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
"uid": "A String", # A server-assigned, globally unique identifier.
},
"revisionId": "A String", # A revision ID.
},
"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"gerritProject": "A String", # 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.
"hostUri": "A String", # The URI of a running Gerrit instance.
"revisionId": "A String", # A revision (commit) ID.
},
"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).
"revisionId": "A String", # Git commit hash.
"url": "A String", # Git repository URL.
},
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
},
"fileHashes": { # 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.
"a_key": { # Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build.
"fileHash": [ # Required. Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # Required. The type of hash that was performed, e.g. "SHA-256".
"value": "A String", # Required. The hash value.
},
],
},
},
},
"startTime": "A String", # Time at which execution of the build was started.
"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
},
"provenanceBytes": "A String", # 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.
},
"compliance": { # An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. # Describes a compliance violation on a linked resource.
"nonComplianceReason": "A String",
"nonCompliantFiles": [
{ # Details about files that caused a compliance check to fail. display_command is a single command that can be used to display a list of non compliant files. When there is no such command, we can also iterate a list of non compliant file using 'path'.
"displayCommand": "A String", # Command to display the non-compliant files.
"path": "A String", # Empty if `display_command` is set.
"reason": "A String", # Explains why a file is non compliant for a CIS check.
},
],
"version": { # Describes the CIS benchmark version that is applicable to a given OS and os version. # The OS and config version the benchmark was run on.
"benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
"cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
"version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
},
},
"createTime": "A String", # Output only. The time this occurrence was created.
"deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.
"address": "A String", # Address of the runtime element hosting this deployment.
"config": "A String", # Configuration used to create this deployment.
"deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
"platform": "A String", # Platform hosting this deployment.
"resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
"A String",
],
"undeployTime": "A String", # End of the lifetime of this deployment.
"userEmail": "A String", # Identity of the user that triggered this deployment.
},
"discovery": { # Provides information about the analysis status of a discovered resource. # Describes when a resource was discovered.
"analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource.
"analysisType": [
"A String",
],
},
"analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors.
{ # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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 field, or localized by the client.
},
],
"analysisStatus": "A String", # The status of discovery for the resource.
"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # 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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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 field, or localized by the client.
},
"archiveTime": "A String", # Output only. The time occurrences related to this discovery occurrence were archived.
"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
"cpe": "A String", # The CPE of the resource being scanned.
"lastScanTime": "A String", # The last time this resource was scanned.
"sbomStatus": { # The status of an SBOM generation. # The status of an SBOM generation.
"error": "A String", # If there was an error generating an SBOM, this will indicate what that error was.
"sbomState": "A String", # The progress of the SBOM generation.
},
},
"dsseAttestation": { # Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. # Describes an attestation of an artifact using dsse.
"envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # If doing something security critical, make sure to verify the signatures in this metadata.
"payload": "A String",
"payloadType": "A String",
"signatures": [
{
"keyid": "A String",
"sig": "A String",
},
],
},
"statement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json".
"_type": "A String", # Always `https://in-toto.io/Statement/v0.1`.
"predicateType": "A String", # `https://slsa.dev/provenance/v0.1` for SlsaProvenance.
"provenance": {
"builderConfig": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenance": {
"builder": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
{
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenanceZeroTwo": { # See full explanation of fields at slsa.dev/provenance/v0.2.
"buildConfig": {
"a_key": "", # Properties of the object.
},
"buildType": "A String",
"builder": { # Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance.
"id": "A String",
},
"invocation": { # Identifies the event that kicked off the build.
"configSource": { # Describes where the config file that kicked off the build came from. This is effectively a pointer to the source where buildConfig came from.
"digest": {
"a_key": "A String",
},
"entryPoint": "A String",
"uri": "A String",
},
"environment": {
"a_key": "", # Properties of the object.
},
"parameters": {
"a_key": "", # Properties of the object.
},
},
"materials": [
{ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on.
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String",
"buildInvocationId": "A String",
"buildStartedOn": "A String",
"completeness": { # Indicates that the builder claims certain fields in this message to be complete.
"environment": True or False,
"materials": True or False,
"parameters": True or False,
},
"reproducible": True or False,
},
},
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
},
"envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # https://github.com/secure-systems-lab/dsse
"payload": "A String",
"payloadType": "A String",
"signatures": [
{
"keyid": "A String",
"sig": "A String",
},
],
},
"image": { # Details of the derived image portion of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Describes how this resource derives from the basis in the associated note.
"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
"distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.
"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
"A String",
],
"v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
},
"layerInfo": [ # 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.
{ # Layer holds metadata specific to a layer of a Docker image.
"arguments": "A String", # The recovered arguments to the Dockerfile directive.
"directive": "A String", # Required. The recovered Dockerfile directive used to construct this layer. See https://docs.docker.com/engine/reference/builder/ for more information.
},
],
},
"kind": "A String", # Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests.
"name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
"noteName": "A String", # 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.
"package": { # Details on how a particular software package was installed on a system. # Describes the installation of a package on the linked resource.
"architecture": "A String", # Output only. The CPU architecture for which packages in this distribution channel were built. Architecture will be blank for language packages.
"cpeUri": "A String", # Output only. 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.
"license": { # License information. # Licenses that have been declared by the authors of the package.
"comments": "A String", # Comments
"expression": "A String", # 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".
},
"location": [ # All of the places within the filesystem versions of this package have been found.
{ # An occurrence of a particular package installation found within a system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.
"cpeUri": "A String", # Deprecated. The CPE URI in [CPE format](https://cpe.mitre.org/specification/)
"path": "A String", # The path from which we gathered that this package/version is installed.
"version": { # Version contains structured information about the version of a package. # Deprecated. The version installed at this location.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
],
"name": "A String", # Required. Output only. The name of the installed package.
"packageType": "A String", # Output only. The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"version": { # Version contains structured information about the version of a package. # Output only. The version of the package.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
"remediation": "A String", # A description of actions that can be taken to remedy the note.
"resourceUri": "A String", # Required. Immutable. A URI that represents the resource for which the occurrence applies. For example, `https://gcr.io/project/image@sha256:123abc` for a Docker image.
"sbomReference": { # The occurrence representing an SBOM reference as applied to a specific resource. The occurrence follows the DSSE specification. See https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for more details. # Describes a specific SBOM reference occurrences.
"payload": { # The actual payload that contains the SBOM Reference data. The payload follows the intoto statement specification. See https://github.com/in-toto/attestation/blob/main/spec/v1.0/statement.md for more details. # The actual payload that contains the SBOM reference data.
"_type": "A String", # Identifier for the schema of the Statement.
"predicate": { # A predicate which describes the SBOM being referenced. # Additional parameters of the Predicate. Includes the actual data about the SBOM.
"digest": { # A map of algorithm to digest of the contents of the SBOM.
"a_key": "A String",
},
"location": "A String", # The location of the SBOM.
"mimeType": "A String", # The mime type of the SBOM.
"referrerId": "A String", # The person or system referring this predicate to the consumer.
},
"predicateType": "A String", # URI identifying the type of the Predicate.
"subject": [ # Set of software artifacts that the attestation applies to. Each element represents a single software artifact.
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"payloadType": "A String", # The kind of payload that SbomReferenceIntotoPayload takes. Since it's in the intoto format, this value is expected to be 'application/vnd.in-toto+json'.
"signatures": [ # The signatures over the payload.
{
"keyid": "A String",
"sig": "A String",
},
],
},
"updateTime": "A String", # Output only. The time this occurrence was last updated.
"upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). For Windows, both distribution and windows_update contain information for the Windows update. # Describes an available package upgrade on the linked resource.
"distribution": { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities. # Metadata about the upgrade for available for the specific operating system for the resource_url. This allows efficient filtering, as well as making it easier to use the occurrence.
"classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. For Windows the classification is one of the category_ids listed at https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85)
"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
"cve": [ # The cve tied to this Upgrade.
"A String",
],
"severity": "A String", # The severity as specified by the upstream operating system.
},
"package": "A String", # Required for non-Windows OS. The package this Upgrade is for.
"parsedVersion": { # Version contains structured information about the version of a package. # Required for non-Windows OS. The version of the package in a machine + human readable form.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"windowsUpdate": { # Windows Update represents the metadata about the update for the Windows operating system. The fields in this message come from the Windows Update API documented at https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. # Required for Windows OS. Represents the metadata about the Windows update.
"categories": [ # The list of categories to which the update belongs.
{ # The category to which the update belongs.
"categoryId": "A String", # The identifier of the category.
"name": "A String", # The localized name of the category.
},
],
"description": "A String", # The localized description of the update.
"identity": { # The unique identifier of the update. # Required - The unique identifier for the update.
"revision": 42, # The revision number of the update.
"updateId": "A String", # The revision independent identifier of the update.
},
"kbArticleIds": [ # The Microsoft Knowledge Base article IDs that are associated with the update.
"A String",
],
"lastPublishedTimestamp": "A String", # The last published timestamp of the update.
"supportUrl": "A String", # The hyperlink to the support information for the update.
"title": "A String", # The localized title of the update.
},
},
"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability.
"cvssScore": 3.14, # 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.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity.
"cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. 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.
"extraDetails": "A String", # Occurrence-specific extra details about the vulnerability.
"fixAvailable": True or False, # Output only. Whether at least one of the affected packages has a fix available.
"longDescription": "A String", # Output only. A detailed description of this vulnerability.
"packageIssue": [ # Required. The set of affected locations and their fixes (if available) within the associated resource.
{ # A detail for a distro and package this vulnerability occurrence was found in and its associated fix (if one is available).
"affectedCpeUri": "A String", # Required. The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability was found in.
"affectedPackage": "A String", # Required. The package this vulnerability was found in.
"affectedVersion": { # Version contains structured information about the version of a package. # Required. The version of the package that is installed on the resource affected by this vulnerability.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"effectiveSeverity": "A String", # Output only. The distro or language system assigned severity for this vulnerability when that is available and note provider assigned severity when it is not available.
"fileLocation": [ # The location at which this package was found.
{ # Indicates the location at which a package was found.
"filePath": "A String", # For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.
},
],
"fixAvailable": True or False, # Output only. Whether a fix is available for this package.
"fixedCpeUri": "A String", # The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability was fixed in. It is possible for this to be different from the affected_cpe_uri.
"fixedPackage": "A String", # The package this vulnerability was fixed in. It is possible for this to be different from the affected_package.
"fixedVersion": { # Version contains structured information about the version of a package. # Required. The version of the package this vulnerability was fixed in. Setting this to VersionKind.MAXIMUM means no fix is yet available.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"packageType": "A String", # The type of package (e.g. OS, MAVEN, GO).
},
],
"relatedUrls": [ # Output only. URLs related to this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"severity": "A String", # Output only. The note provider assigned severity of this vulnerability.
"shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
"type": "A String", # The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"vexAssessment": { # VexAssessment provides all publisher provided Vex information that is related to this vulnerability.
"cve": "A String", # Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Deprecated: Use vulnerability_id instead to denote CVEs.
"impacts": [ # Contains information about the impact of this vulnerability, this will change with time.
"A String",
],
"justification": { # Justification provides the justification when the state of the assessment if NOT_AFFECTED. # Justification provides the justification when the state of the assessment if NOT_AFFECTED.
"details": "A String", # Additional details on why this justification was chosen.
"justificationType": "A String", # The justification type for this vulnerability.
},
"noteName": "A String", # The VulnerabilityAssessment note from which this VexAssessment was generated. This will be of the form: `projects/[PROJECT_ID]/notes/[NOTE_ID]`.
"relatedUris": [ # Holds a list of references associated with this vulnerability item and assessment.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"remediations": [ # Specifies details on how to handle (and presumably, fix) a vulnerability.
{ # Specifies details on how to handle (and presumably, fix) a vulnerability.
"details": "A String", # Contains a comprehensive human-readable discussion of the remediation.
"remediationType": "A String", # The type of remediation that can be applied.
"remediationUri": { # Metadata for any related URL information. # Contains the URL where to obtain the remediation.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
},
],
"state": "A String", # Provides the state of this Vulnerability assessment.
"vulnerabilityId": "A String", # The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.
},
},
}

getIamPolicy(resource, body=None, x__xgafv=None)

Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

Args:
  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for `GetIamPolicy` method.
  "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
    "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
    { # Associates `members`, or principals, with a `role`.
      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
      },
      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
        "A String",
      ],
      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
    },
  ],
  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}

getNotes(name, x__xgafv=None)

Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project.

Args:
  name: string, Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A type of analysis that can be done for a resource.
  "attestation": { # 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. # A note describing an attestation role.
    "hint": { # 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. # Hint hints at the purpose of the attestation authority.
      "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
    },
  },
  "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build.
    "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
  },
  "compliance": { # A note describing a compliance check.
    "cisBenchmark": { # A compliance check that is a CIS benchmark.
      "profileLevel": 42,
      "severity": "A String",
    },
    "description": "A String", # A description about this compliance check.
    "impact": "A String",
    "rationale": "A String", # A rationale for the existence of this compliance check.
    "remediation": "A String", # A description of remediation steps if the compliance check fails.
    "scanInstructions": "A String", # Serialized scan instructions with a predefined format.
    "title": "A String", # The title that identifies this compliance check.
    "version": [ # The OS and config versions the benchmark applies to.
      { # Describes the CIS benchmark version that is applicable to a given OS and os version.
        "benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
        "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
        "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
      },
    ],
  },
  "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
  "deployment": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
    "resourceUri": [ # Required. Resource URI for the artifact being deployed.
      "A String",
    ],
  },
  "discovery": { # 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. # A note describing the initial analysis of a resource.
    "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery.
  },
  "dsseAttestation": { # A note describing a dsse attestation note.
    "hint": { # 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. # DSSEHint hints at the purpose of the attestation authority.
      "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "cloudbuild-prod".
    },
  },
  "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
  "image": { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g., a tag of the resource_url. # A note describing a base image.
    "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
      "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
      "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
        "A String",
      ],
      "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
    },
    "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.
  },
  "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests.
  "longDescription": "A String", # A detailed description of this note.
  "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
  "package": { # PackageNote represents a particular package version. # A note describing a package hosted by various package managers.
    "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built. Architecture will be blank for language packages.
    "cpeUri": "A String", # 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.
    "description": "A String", # The description of this package.
    "digest": [ # Hash value, typically a file digest, that allows unique identification a specific package.
      { # Digest information.
        "algo": "A String", # `SHA1`, `SHA512` etc.
        "digestBytes": "A String", # Value of the digest.
      },
    ],
    "distribution": [ # Deprecated. The various channels by which a package is distributed.
      { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.
        "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built.
        "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
        "description": "A String", # The distribution channel-specific description of this package.
        "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
          "epoch": 42, # Used to correct mistakes in the version numbering scheme.
          "fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
          "inclusive": True or False, # 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.
          "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
          "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
          "revision": "A String", # The iteration of the package build from the above version.
        },
        "maintainer": "A String", # A freeform string denoting the maintainer of this package.
        "url": "A String", # The distribution channel-specific homepage for this package.
      },
    ],
    "license": { # License information. # Licenses that have been declared by the authors of the package.
      "comments": "A String", # Comments
      "expression": "A String", # 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".
    },
    "maintainer": "A String", # A freeform text denoting the maintainer of this package.
    "name": "A String", # Required. Immutable. The name of the package.
    "packageType": "A String", # The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
    "url": "A String", # The homepage for this package.
    "version": { # Version contains structured information about the version of a package. # The version of the package.
      "epoch": 42, # Used to correct mistakes in the version numbering scheme.
      "fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
      "inclusive": True or False, # 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.
      "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
      "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
      "revision": "A String", # The iteration of the package build from the above version.
    },
  },
  "relatedNoteNames": [ # Other notes related to this note.
    "A String",
  ],
  "relatedUrl": [ # URLs associated with this note.
    { # Metadata for any related URL information.
      "label": "A String", # Label to describe usage of the URL.
      "url": "A String", # Specific URL associated with the resource.
    },
  ],
  "sbomReference": { # The note representing an SBOM reference. # A note describing an SBOM reference.
    "format": "A String", # The format that SBOM takes. E.g. may be spdx, cyclonedx, etc...
    "version": "A String", # The version of the format that the SBOM takes. E.g. if the format is spdx, the version may be 2.3.
  },
  "shortDescription": "A String", # A one sentence description of this note.
  "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
  "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update field represents the information related to the update. # A note describing available package upgrades.
    "distributions": [ # Metadata about the upgrade for each specific operating system.
      { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities.
        "classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. For Windows the classification is one of the category_ids listed at https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85)
        "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
        "cve": [ # The cve tied to this Upgrade.
          "A String",
        ],
        "severity": "A String", # The severity as specified by the upstream operating system.
      },
    ],
    "package": "A String", # Required for non-Windows OS. The package this Upgrade is for.
    "version": { # Version contains structured information about the version of a package. # Required for non-Windows OS. The version of the package in machine + human readable form.
      "epoch": 42, # Used to correct mistakes in the version numbering scheme.
      "fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
      "inclusive": True or False, # 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.
      "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
      "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
      "revision": "A String", # The iteration of the package build from the above version.
    },
    "windowsUpdate": { # Windows Update represents the metadata about the update for the Windows operating system. The fields in this message come from the Windows Update API documented at https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. # Required for Windows OS. Represents the metadata about the Windows update.
      "categories": [ # The list of categories to which the update belongs.
        { # The category to which the update belongs.
          "categoryId": "A String", # The identifier of the category.
          "name": "A String", # The localized name of the category.
        },
      ],
      "description": "A String", # The localized description of the update.
      "identity": { # The unique identifier of the update. # Required - The unique identifier for the update.
        "revision": 42, # The revision number of the update.
        "updateId": "A String", # The revision independent identifier of the update.
      },
      "kbArticleIds": [ # The Microsoft Knowledge Base article IDs that are associated with the update.
        "A String",
      ],
      "lastPublishedTimestamp": "A String", # The last published timestamp of the update.
      "supportUrl": "A String", # The hyperlink to the support information for the update.
      "title": "A String", # The localized title of the update.
    },
  },
  "vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
    "cvssScore": 3.14, # 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.
    "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
      "attackComplexity": "A String",
      "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
      "authentication": "A String",
      "availabilityImpact": "A String",
      "baseScore": 3.14, # The base score is a function of the base metric scores.
      "confidentialityImpact": "A String",
      "exploitabilityScore": 3.14,
      "impactScore": 3.14,
      "integrityImpact": "A String",
      "privilegesRequired": "A String",
      "scope": "A String",
      "userInteraction": "A String",
    },
    "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability.
      "attackComplexity": "A String",
      "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
      "availabilityImpact": "A String",
      "baseScore": 3.14, # The base score is a function of the base metric scores.
      "confidentialityImpact": "A String",
      "exploitabilityScore": 3.14,
      "impactScore": 3.14,
      "integrityImpact": "A String",
      "privilegesRequired": "A String",
      "scope": "A String",
      "userInteraction": "A String",
    },
    "cvssVersion": "A String", # CVSS version used to populate cvss_score and severity.
    "details": [ # Details of all known distros and packages affected by this vulnerability.
      { # A detail for a distro and package affected by this vulnerability and its associated fix (if one is available).
        "affectedCpeUri": "A String", # Required. The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability affects.
        "affectedPackage": "A String", # Required. The package this vulnerability affects.
        "affectedVersionEnd": { # Version contains structured information about the version of a package. # The version number at the end of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail.
          "epoch": 42, # Used to correct mistakes in the version numbering scheme.
          "fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
          "inclusive": True or False, # 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.
          "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
          "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
          "revision": "A String", # The iteration of the package build from the above version.
        },
        "affectedVersionStart": { # Version contains structured information about the version of a package. # The version number at the start of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail.
          "epoch": 42, # Used to correct mistakes in the version numbering scheme.
          "fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
          "inclusive": True or False, # 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.
          "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
          "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
          "revision": "A String", # The iteration of the package build from the above version.
        },
        "description": "A String", # A vendor-specific description of this vulnerability.
        "fixedCpeUri": "A String", # The distro recommended [CPE URI](https://cpe.mitre.org/specification/) to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_cpe_uri.
        "fixedPackage": "A String", # The distro recommended package to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_package.
        "fixedVersion": { # Version contains structured information about the version of a package. # The distro recommended version to update to that contains a fix for this vulnerability. Setting this to VersionKind.MAXIMUM means no such version is yet available.
          "epoch": 42, # Used to correct mistakes in the version numbering scheme.
          "fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
          "inclusive": True or False, # 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.
          "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
          "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
          "revision": "A String", # The iteration of the package build from the above version.
        },
        "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
        "packageType": "A String", # The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
        "severityName": "A String", # The distro assigned severity of this vulnerability.
        "source": "A String", # The source from which the information in this Detail was obtained.
        "sourceUpdateTime": "A String", # 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.
        "vendor": "A String", # The name of the vendor of the product.
      },
    ],
    "severity": "A String", # The note provider assigned severity of this vulnerability.
    "sourceUpdateTime": "A String", # 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.
    "windowsDetails": [ # 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.
      {
        "cpeUri": "A String", # Required. The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability affects.
        "description": "A String", # The description of this vulnerability.
        "fixingKbs": [ # 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 KBs presence is considered a fix.
          {
            "name": "A String", # The KB name (generally of the form KB[0-9]+ (e.g., KB123456)).
            "url": "A String", # A link to the KB in the [Windows update catalog] (https://www.catalog.update.microsoft.com/).
          },
        ],
        "name": "A String", # Required. The name of this vulnerability.
      },
    ],
  },
  "vulnerabilityAssessment": { # A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. # A note describing a vulnerability assessment.
    "assessment": { # Assessment provides all information that is related to a single vulnerability for this product. # Represents a vulnerability assessment for the product.
      "cve": "A String", # Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Deprecated: Use vulnerability_id instead to denote CVEs.
      "impacts": [ # Contains information about the impact of this vulnerability, this will change with time.
        "A String",
      ],
      "justification": { # Justification provides the justification when the state of the assessment if NOT_AFFECTED. # Justification provides the justification when the state of the assessment if NOT_AFFECTED.
        "details": "A String", # Additional details on why this justification was chosen.
        "justificationType": "A String", # The justification type for this vulnerability.
      },
      "longDescription": "A String", # A detailed description of this Vex.
      "relatedUris": [ # 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.
        { # Metadata for any related URL information.
          "label": "A String", # Label to describe usage of the URL.
          "url": "A String", # Specific URL associated with the resource.
        },
      ],
      "remediations": [ # Specifies details on how to handle (and presumably, fix) a vulnerability.
        { # Specifies details on how to handle (and presumably, fix) a vulnerability.
          "details": "A String", # Contains a comprehensive human-readable discussion of the remediation.
          "remediationType": "A String", # The type of remediation that can be applied.
          "remediationUri": { # Metadata for any related URL information. # Contains the URL where to obtain the remediation.
            "label": "A String", # Label to describe usage of the URL.
            "url": "A String", # Specific URL associated with the resource.
          },
        },
      ],
      "shortDescription": "A String", # A one sentence description of this Vex.
      "state": "A String", # Provides the state of this Vulnerability assessment.
      "vulnerabilityId": "A String", # The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.
    },
    "languageCode": "A String", # Identifies the language used by this document, corresponding to IETF BCP 47 / RFC 5646.
    "longDescription": "A String", # A detailed description of this Vex.
    "product": { # Product contains information about a product and how to uniquely identify it. # The product affected by this vex.
      "genericUri": "A String", # Contains a URI which is vendor-specific. Example: The artifact repository URL of an image.
      "id": "A String", # 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.
      "name": "A String", # Name of the product.
    },
    "publisher": { # Publisher contains information about the publisher of this Note. # Publisher details of this Note.
      "issuingAuthority": "A String", # Provides information about the authority of the issuing party to release the document, in particular, the party's constituency and responsibilities or other obligations.
      "name": "A String", # Name of the publisher. Examples: 'Google', 'Google Cloud Platform'.
      "publisherNamespace": "A String", # The context or namespace. Contains a URL which is under control of the issuing party and can be used as a globally unique identifier for that issuing party. Example: https://csaf.io
    },
    "shortDescription": "A String", # A one sentence description of this Vex.
    "title": "A String", # The title of the note. E.g. `Vex-Debian-11.4`
  },
}

getVulnerabilitySummary(parent, filter=None, x__xgafv=None)

Gets a summary of the number and severity of occurrences.

Args:
  parent: string, Required. The name of the project to get a vulnerability summary for in the form of `projects/[PROJECT_ID]`. (required)
  filter: string, The filter expression.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A summary of how many vulnerability occurrences there are per resource and severity type.
  "counts": [ # A listing by resource of the number of fixable and total vulnerabilities.
    { # Per resource and severity counts of fixable and total vulnerabilities.
      "fixableCount": "A String", # The number of fixable vulnerabilities associated with this resource.
      "resourceUri": "A String", # The affected resource.
      "severity": "A String", # The severity for this count. SEVERITY_UNSPECIFIED indicates total across all severities.
      "totalCount": "A String", # The total number of vulnerabilities associated with this resource.
    },
  ],
}

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists occurrences for the specified project.

Args:
parent: string, Required. The name of the project to list occurrences for in the form of `projects/[PROJECT_ID]`. (required)
filter: string, The filter expression.
pageSize: integer, Number of occurrences to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.
pageToken: string, Token to provide to skip to a particular spot in the list.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response for listing occurrences.
"nextPageToken": "A String", # 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.
"occurrences": [ # The occurrences requested.
{ # An instance of an analysis type that has been found on a resource.
"attestation": { # 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 lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact.
"jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas.
{
"compactJwt": "A String", # The compact encoding of a JWS, which is always three base64 encoded strings joined by periods. For details, see: https://tools.ietf.org/html/rfc7515.html#section-3.1
},
],
"serializedPayload": "A String", # Required. The serialized payload that is verified by one or more `signatures`.
"signatures": [ # 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.
{ # 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).
"publicKeyId": "A String", # 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"
"signature": "A String", # 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.
},
],
},
"build": { # Details of a build occurrence. # Describes a verifiable build.
"inTotoSlsaProvenanceV1": { # In-Toto Slsa Provenance V1 represents a slsa provenance meeting the slsa spec, wrapped in an in-toto statement. This allows for direct jsonification of a to-spec in-toto slsa statement with a to-spec slsa provenance.
"_type": "A String", # InToto spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement
"predicate": { # Keep in sync with schema at https://github.com/slsa-framework/slsa/blob/main/docs/provenance/schema/v1/provenance.proto Builder renamed to ProvenanceBuilder because of Java conflicts.
"buildDefinition": {
"buildType": "A String",
"externalParameters": {
"a_key": "", # Properties of the object.
},
"internalParameters": {
"a_key": "", # Properties of the object.
},
"resolvedDependencies": [
{
"annotations": {
"a_key": "",
},
"content": "A String",
"digest": {
"a_key": "A String",
},
"downloadLocation": "A String",
"mediaType": "A String",
"name": "A String",
"uri": "A String",
},
],
},
"runDetails": {
"builder": {
"builderDependencies": [
{
"annotations": {
"a_key": "",
},
"content": "A String",
"digest": {
"a_key": "A String",
},
"downloadLocation": "A String",
"mediaType": "A String",
"name": "A String",
"uri": "A String",
},
],
"id": "A String",
"version": {
"a_key": "A String",
},
},
"byproducts": [
{
"annotations": {
"a_key": "",
},
"content": "A String",
"digest": {
"a_key": "A String",
},
"downloadLocation": "A String",
"mediaType": "A String",
"name": "A String",
"uri": "A String",
},
],
"metadata": {
"finishedOn": "A String",
"invocationId": "A String",
"startedOn": "A String",
},
},
},
"predicateType": "A String",
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"intotoProvenance": { # Deprecated. See InTotoStatement for the replacement. In-toto Provenance representation as defined in spec.
"builderConfig": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"intotoStatement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json". # In-toto Statement representation as defined in spec. The intoto_statement can contain any type of provenance. The serialized payload of the statement can be stored and signed in the Occurrence's envelope.
"_type": "A String", # Always `https://in-toto.io/Statement/v0.1`.
"predicateType": "A String", # `https://slsa.dev/provenance/v0.1` for SlsaProvenance.
"provenance": {
"builderConfig": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenance": {
"builder": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
{
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenanceZeroTwo": { # See full explanation of fields at slsa.dev/provenance/v0.2.
"buildConfig": {
"a_key": "", # Properties of the object.
},
"buildType": "A String",
"builder": { # Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance.
"id": "A String",
},
"invocation": { # Identifies the event that kicked off the build.
"configSource": { # Describes where the config file that kicked off the build came from. This is effectively a pointer to the source where buildConfig came from.
"digest": {
"a_key": "A String",
},
"entryPoint": "A String",
"uri": "A String",
},
"environment": {
"a_key": "", # Properties of the object.
},
"parameters": {
"a_key": "", # Properties of the object.
},
},
"materials": [
{ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on.
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String",
"buildInvocationId": "A String",
"buildStartedOn": "A String",
"completeness": { # Indicates that the builder claims certain fields in this message to be complete.
"environment": True or False,
"materials": True or False,
"parameters": True or False,
},
"reproducible": True or False,
},
},
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # The actual provenance for the build.
"buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.
"a_key": "A String",
},
"builderVersion": "A String", # Version string of the builder at the time this build was executed.
"builtArtifacts": [ # Output of the build.
{ # Artifact describes a build product.
"checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.
"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.
"names": [ # 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.
"A String",
],
},
],
"commands": [ # Commands requested by the build.
{ # Command describes a step performed as part of the build pipeline.
"args": [ # Command-line arguments used when executing this command.
"A String",
],
"dir": "A String", # Working directory (relative to project source root) used when running this command.
"env": [ # Environment variables set before running this command.
"A String",
],
"id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.
"name": "A String", # 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`.
"waitFor": [ # The ID(s) of the command(s) that this command depends on.
"A String",
],
},
],
"createTime": "A String", # Time at which the build was created.
"creator": "A String", # 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.
"endTime": "A String", # Time at which execution of the build was finished.
"id": "A String", # Required. Unique identifier of the build.
"logsUri": "A String", # URI where any logs for this provenance were written.
"projectId": "A String", # ID of the project.
"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.
"additionalContexts": [ # 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.
{ # 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.
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
"uid": "A String", # A server-assigned, globally unique identifier.
},
"revisionId": "A String", # A revision ID.
},
"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"gerritProject": "A String", # 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.
"hostUri": "A String", # The URI of a running Gerrit instance.
"revisionId": "A String", # A revision (commit) ID.
},
"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).
"revisionId": "A String", # Git commit hash.
"url": "A String", # Git repository URL.
},
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
},
],
"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.
"context": { # 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. # If provided, the source code used for the build came from this location.
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
"uid": "A String", # A server-assigned, globally unique identifier.
},
"revisionId": "A String", # A revision ID.
},
"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"gerritProject": "A String", # 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.
"hostUri": "A String", # The URI of a running Gerrit instance.
"revisionId": "A String", # A revision (commit) ID.
},
"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).
"revisionId": "A String", # Git commit hash.
"url": "A String", # Git repository URL.
},
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
},
"fileHashes": { # 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.
"a_key": { # Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build.
"fileHash": [ # Required. Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # Required. The type of hash that was performed, e.g. "SHA-256".
"value": "A String", # Required. The hash value.
},
],
},
},
},
"startTime": "A String", # Time at which execution of the build was started.
"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
},
"provenanceBytes": "A String", # 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.
},
"compliance": { # An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. # Describes a compliance violation on a linked resource.
"nonComplianceReason": "A String",
"nonCompliantFiles": [
{ # Details about files that caused a compliance check to fail. display_command is a single command that can be used to display a list of non compliant files. When there is no such command, we can also iterate a list of non compliant file using 'path'.
"displayCommand": "A String", # Command to display the non-compliant files.
"path": "A String", # Empty if `display_command` is set.
"reason": "A String", # Explains why a file is non compliant for a CIS check.
},
],
"version": { # Describes the CIS benchmark version that is applicable to a given OS and os version. # The OS and config version the benchmark was run on.
"benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
"cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
"version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
},
},
"createTime": "A String", # Output only. The time this occurrence was created.
"deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.
"address": "A String", # Address of the runtime element hosting this deployment.
"config": "A String", # Configuration used to create this deployment.
"deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
"platform": "A String", # Platform hosting this deployment.
"resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
"A String",
],
"undeployTime": "A String", # End of the lifetime of this deployment.
"userEmail": "A String", # Identity of the user that triggered this deployment.
},
"discovery": { # Provides information about the analysis status of a discovered resource. # Describes when a resource was discovered.
"analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource.
"analysisType": [
"A String",
],
},
"analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors.
{ # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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 field, or localized by the client.
},
],
"analysisStatus": "A String", # The status of discovery for the resource.
"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # 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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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 field, or localized by the client.
},
"archiveTime": "A String", # Output only. The time occurrences related to this discovery occurrence were archived.
"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
"cpe": "A String", # The CPE of the resource being scanned.
"lastScanTime": "A String", # The last time this resource was scanned.
"sbomStatus": { # The status of an SBOM generation. # The status of an SBOM generation.
"error": "A String", # If there was an error generating an SBOM, this will indicate what that error was.
"sbomState": "A String", # The progress of the SBOM generation.
},
},
"dsseAttestation": { # Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. # Describes an attestation of an artifact using dsse.
"envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # If doing something security critical, make sure to verify the signatures in this metadata.
"payload": "A String",
"payloadType": "A String",
"signatures": [
{
"keyid": "A String",
"sig": "A String",
},
],
},
"statement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json".
"_type": "A String", # Always `https://in-toto.io/Statement/v0.1`.
"predicateType": "A String", # `https://slsa.dev/provenance/v0.1` for SlsaProvenance.
"provenance": {
"builderConfig": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenance": {
"builder": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
{
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenanceZeroTwo": { # See full explanation of fields at slsa.dev/provenance/v0.2.
"buildConfig": {
"a_key": "", # Properties of the object.
},
"buildType": "A String",
"builder": { # Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance.
"id": "A String",
},
"invocation": { # Identifies the event that kicked off the build.
"configSource": { # Describes where the config file that kicked off the build came from. This is effectively a pointer to the source where buildConfig came from.
"digest": {
"a_key": "A String",
},
"entryPoint": "A String",
"uri": "A String",
},
"environment": {
"a_key": "", # Properties of the object.
},
"parameters": {
"a_key": "", # Properties of the object.
},
},
"materials": [
{ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on.
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String",
"buildInvocationId": "A String",
"buildStartedOn": "A String",
"completeness": { # Indicates that the builder claims certain fields in this message to be complete.
"environment": True or False,
"materials": True or False,
"parameters": True or False,
},
"reproducible": True or False,
},
},
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
},
"envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # https://github.com/secure-systems-lab/dsse
"payload": "A String",
"payloadType": "A String",
"signatures": [
{
"keyid": "A String",
"sig": "A String",
},
],
},
"image": { # Details of the derived image portion of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Describes how this resource derives from the basis in the associated note.
"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
"distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.
"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
"A String",
],
"v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
},
"layerInfo": [ # 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.
{ # Layer holds metadata specific to a layer of a Docker image.
"arguments": "A String", # The recovered arguments to the Dockerfile directive.
"directive": "A String", # Required. The recovered Dockerfile directive used to construct this layer. See https://docs.docker.com/engine/reference/builder/ for more information.
},
],
},
"kind": "A String", # Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests.
"name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
"noteName": "A String", # 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.
"package": { # Details on how a particular software package was installed on a system. # Describes the installation of a package on the linked resource.
"architecture": "A String", # Output only. The CPU architecture for which packages in this distribution channel were built. Architecture will be blank for language packages.
"cpeUri": "A String", # Output only. 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.
"license": { # License information. # Licenses that have been declared by the authors of the package.
"comments": "A String", # Comments
"expression": "A String", # 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".
},
"location": [ # All of the places within the filesystem versions of this package have been found.
{ # An occurrence of a particular package installation found within a system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.
"cpeUri": "A String", # Deprecated. The CPE URI in [CPE format](https://cpe.mitre.org/specification/)
"path": "A String", # The path from which we gathered that this package/version is installed.
"version": { # Version contains structured information about the version of a package. # Deprecated. The version installed at this location.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
],
"name": "A String", # Required. Output only. The name of the installed package.
"packageType": "A String", # Output only. The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"version": { # Version contains structured information about the version of a package. # Output only. The version of the package.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
"remediation": "A String", # A description of actions that can be taken to remedy the note.
"resourceUri": "A String", # Required. Immutable. A URI that represents the resource for which the occurrence applies. For example, `https://gcr.io/project/image@sha256:123abc` for a Docker image.
"sbomReference": { # The occurrence representing an SBOM reference as applied to a specific resource. The occurrence follows the DSSE specification. See https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for more details. # Describes a specific SBOM reference occurrences.
"payload": { # The actual payload that contains the SBOM Reference data. The payload follows the intoto statement specification. See https://github.com/in-toto/attestation/blob/main/spec/v1.0/statement.md for more details. # The actual payload that contains the SBOM reference data.
"_type": "A String", # Identifier for the schema of the Statement.
"predicate": { # A predicate which describes the SBOM being referenced. # Additional parameters of the Predicate. Includes the actual data about the SBOM.
"digest": { # A map of algorithm to digest of the contents of the SBOM.
"a_key": "A String",
},
"location": "A String", # The location of the SBOM.
"mimeType": "A String", # The mime type of the SBOM.
"referrerId": "A String", # The person or system referring this predicate to the consumer.
},
"predicateType": "A String", # URI identifying the type of the Predicate.
"subject": [ # Set of software artifacts that the attestation applies to. Each element represents a single software artifact.
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"payloadType": "A String", # The kind of payload that SbomReferenceIntotoPayload takes. Since it's in the intoto format, this value is expected to be 'application/vnd.in-toto+json'.
"signatures": [ # The signatures over the payload.
{
"keyid": "A String",
"sig": "A String",
},
],
},
"updateTime": "A String", # Output only. The time this occurrence was last updated.
"upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). For Windows, both distribution and windows_update contain information for the Windows update. # Describes an available package upgrade on the linked resource.
"distribution": { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities. # Metadata about the upgrade for available for the specific operating system for the resource_url. This allows efficient filtering, as well as making it easier to use the occurrence.
"classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. For Windows the classification is one of the category_ids listed at https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85)
"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
"cve": [ # The cve tied to this Upgrade.
"A String",
],
"severity": "A String", # The severity as specified by the upstream operating system.
},
"package": "A String", # Required for non-Windows OS. The package this Upgrade is for.
"parsedVersion": { # Version contains structured information about the version of a package. # Required for non-Windows OS. The version of the package in a machine + human readable form.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"windowsUpdate": { # Windows Update represents the metadata about the update for the Windows operating system. The fields in this message come from the Windows Update API documented at https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. # Required for Windows OS. Represents the metadata about the Windows update.
"categories": [ # The list of categories to which the update belongs.
{ # The category to which the update belongs.
"categoryId": "A String", # The identifier of the category.
"name": "A String", # The localized name of the category.
},
],
"description": "A String", # The localized description of the update.
"identity": { # The unique identifier of the update. # Required - The unique identifier for the update.
"revision": 42, # The revision number of the update.
"updateId": "A String", # The revision independent identifier of the update.
},
"kbArticleIds": [ # The Microsoft Knowledge Base article IDs that are associated with the update.
"A String",
],
"lastPublishedTimestamp": "A String", # The last published timestamp of the update.
"supportUrl": "A String", # The hyperlink to the support information for the update.
"title": "A String", # The localized title of the update.
},
},
"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability.
"cvssScore": 3.14, # 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.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity.
"cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. 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.
"extraDetails": "A String", # Occurrence-specific extra details about the vulnerability.
"fixAvailable": True or False, # Output only. Whether at least one of the affected packages has a fix available.
"longDescription": "A String", # Output only. A detailed description of this vulnerability.
"packageIssue": [ # Required. The set of affected locations and their fixes (if available) within the associated resource.
{ # A detail for a distro and package this vulnerability occurrence was found in and its associated fix (if one is available).
"affectedCpeUri": "A String", # Required. The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability was found in.
"affectedPackage": "A String", # Required. The package this vulnerability was found in.
"affectedVersion": { # Version contains structured information about the version of a package. # Required. The version of the package that is installed on the resource affected by this vulnerability.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"effectiveSeverity": "A String", # Output only. The distro or language system assigned severity for this vulnerability when that is available and note provider assigned severity when it is not available.
"fileLocation": [ # The location at which this package was found.
{ # Indicates the location at which a package was found.
"filePath": "A String", # For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.
},
],
"fixAvailable": True or False, # Output only. Whether a fix is available for this package.
"fixedCpeUri": "A String", # The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability was fixed in. It is possible for this to be different from the affected_cpe_uri.
"fixedPackage": "A String", # The package this vulnerability was fixed in. It is possible for this to be different from the affected_package.
"fixedVersion": { # Version contains structured information about the version of a package. # Required. The version of the package this vulnerability was fixed in. Setting this to VersionKind.MAXIMUM means no fix is yet available.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"packageType": "A String", # The type of package (e.g. OS, MAVEN, GO).
},
],
"relatedUrls": [ # Output only. URLs related to this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"severity": "A String", # Output only. The note provider assigned severity of this vulnerability.
"shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
"type": "A String", # The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"vexAssessment": { # VexAssessment provides all publisher provided Vex information that is related to this vulnerability.
"cve": "A String", # Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Deprecated: Use vulnerability_id instead to denote CVEs.
"impacts": [ # Contains information about the impact of this vulnerability, this will change with time.
"A String",
],
"justification": { # Justification provides the justification when the state of the assessment if NOT_AFFECTED. # Justification provides the justification when the state of the assessment if NOT_AFFECTED.
"details": "A String", # Additional details on why this justification was chosen.
"justificationType": "A String", # The justification type for this vulnerability.
},
"noteName": "A String", # The VulnerabilityAssessment note from which this VexAssessment was generated. This will be of the form: `projects/[PROJECT_ID]/notes/[NOTE_ID]`.
"relatedUris": [ # Holds a list of references associated with this vulnerability item and assessment.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"remediations": [ # Specifies details on how to handle (and presumably, fix) a vulnerability.
{ # Specifies details on how to handle (and presumably, fix) a vulnerability.
"details": "A String", # Contains a comprehensive human-readable discussion of the remediation.
"remediationType": "A String", # The type of remediation that can be applied.
"remediationUri": { # Metadata for any related URL information. # Contains the URL where to obtain the remediation.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
},
],
"state": "A String", # Provides the state of this Vulnerability assessment.
"vulnerabilityId": "A String", # The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.
},
},
},
],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates the specified occurrence.

Args:
name: string, Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. (required)
body: object, The request body.
The object takes the form of:

{ # An instance of an analysis type that has been found on a resource.
"attestation": { # 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 lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact.
"jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas.
{
"compactJwt": "A String", # The compact encoding of a JWS, which is always three base64 encoded strings joined by periods. For details, see: https://tools.ietf.org/html/rfc7515.html#section-3.1
},
],
"serializedPayload": "A String", # Required. The serialized payload that is verified by one or more `signatures`.
"signatures": [ # 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.
{ # 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).
"publicKeyId": "A String", # 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"
"signature": "A String", # 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.
},
],
},
"build": { # Details of a build occurrence. # Describes a verifiable build.
"inTotoSlsaProvenanceV1": { # In-Toto Slsa Provenance V1 represents a slsa provenance meeting the slsa spec, wrapped in an in-toto statement. This allows for direct jsonification of a to-spec in-toto slsa statement with a to-spec slsa provenance.
"_type": "A String", # InToto spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement
"predicate": { # Keep in sync with schema at https://github.com/slsa-framework/slsa/blob/main/docs/provenance/schema/v1/provenance.proto Builder renamed to ProvenanceBuilder because of Java conflicts.
"buildDefinition": {
"buildType": "A String",
"externalParameters": {
"a_key": "", # Properties of the object.
},
"internalParameters": {
"a_key": "", # Properties of the object.
},
"resolvedDependencies": [
{
"annotations": {
"a_key": "",
},
"content": "A String",
"digest": {
"a_key": "A String",
},
"downloadLocation": "A String",
"mediaType": "A String",
"name": "A String",
"uri": "A String",
},
],
},
"runDetails": {
"builder": {
"builderDependencies": [
{
"annotations": {
"a_key": "",
},
"content": "A String",
"digest": {
"a_key": "A String",
},
"downloadLocation": "A String",
"mediaType": "A String",
"name": "A String",
"uri": "A String",
},
],
"id": "A String",
"version": {
"a_key": "A String",
},
},
"byproducts": [
{
"annotations": {
"a_key": "",
},
"content": "A String",
"digest": {
"a_key": "A String",
},
"downloadLocation": "A String",
"mediaType": "A String",
"name": "A String",
"uri": "A String",
},
],
"metadata": {
"finishedOn": "A String",
"invocationId": "A String",
"startedOn": "A String",
},
},
},
"predicateType": "A String",
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"intotoProvenance": { # Deprecated. See InTotoStatement for the replacement. In-toto Provenance representation as defined in spec.
"builderConfig": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"intotoStatement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json". # In-toto Statement representation as defined in spec. The intoto_statement can contain any type of provenance. The serialized payload of the statement can be stored and signed in the Occurrence's envelope.
"_type": "A String", # Always `https://in-toto.io/Statement/v0.1`.
"predicateType": "A String", # `https://slsa.dev/provenance/v0.1` for SlsaProvenance.
"provenance": {
"builderConfig": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenance": {
"builder": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
{
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenanceZeroTwo": { # See full explanation of fields at slsa.dev/provenance/v0.2.
"buildConfig": {
"a_key": "", # Properties of the object.
},
"buildType": "A String",
"builder": { # Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance.
"id": "A String",
},
"invocation": { # Identifies the event that kicked off the build.
"configSource": { # Describes where the config file that kicked off the build came from. This is effectively a pointer to the source where buildConfig came from.
"digest": {
"a_key": "A String",
},
"entryPoint": "A String",
"uri": "A String",
},
"environment": {
"a_key": "", # Properties of the object.
},
"parameters": {
"a_key": "", # Properties of the object.
},
},
"materials": [
{ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on.
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String",
"buildInvocationId": "A String",
"buildStartedOn": "A String",
"completeness": { # Indicates that the builder claims certain fields in this message to be complete.
"environment": True or False,
"materials": True or False,
"parameters": True or False,
},
"reproducible": True or False,
},
},
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # The actual provenance for the build.
"buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.
"a_key": "A String",
},
"builderVersion": "A String", # Version string of the builder at the time this build was executed.
"builtArtifacts": [ # Output of the build.
{ # Artifact describes a build product.
"checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.
"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.
"names": [ # 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.
"A String",
],
},
],
"commands": [ # Commands requested by the build.
{ # Command describes a step performed as part of the build pipeline.
"args": [ # Command-line arguments used when executing this command.
"A String",
],
"dir": "A String", # Working directory (relative to project source root) used when running this command.
"env": [ # Environment variables set before running this command.
"A String",
],
"id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.
"name": "A String", # 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`.
"waitFor": [ # The ID(s) of the command(s) that this command depends on.
"A String",
],
},
],
"createTime": "A String", # Time at which the build was created.
"creator": "A String", # 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.
"endTime": "A String", # Time at which execution of the build was finished.
"id": "A String", # Required. Unique identifier of the build.
"logsUri": "A String", # URI where any logs for this provenance were written.
"projectId": "A String", # ID of the project.
"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.
"additionalContexts": [ # 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.
{ # 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.
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
"uid": "A String", # A server-assigned, globally unique identifier.
},
"revisionId": "A String", # A revision ID.
},
"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"gerritProject": "A String", # 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.
"hostUri": "A String", # The URI of a running Gerrit instance.
"revisionId": "A String", # A revision (commit) ID.
},
"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).
"revisionId": "A String", # Git commit hash.
"url": "A String", # Git repository URL.
},
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
},
],
"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.
"context": { # 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. # If provided, the source code used for the build came from this location.
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
"uid": "A String", # A server-assigned, globally unique identifier.
},
"revisionId": "A String", # A revision ID.
},
"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"gerritProject": "A String", # 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.
"hostUri": "A String", # The URI of a running Gerrit instance.
"revisionId": "A String", # A revision (commit) ID.
},
"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).
"revisionId": "A String", # Git commit hash.
"url": "A String", # Git repository URL.
},
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
},
"fileHashes": { # 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.
"a_key": { # Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build.
"fileHash": [ # Required. Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # Required. The type of hash that was performed, e.g. "SHA-256".
"value": "A String", # Required. The hash value.
},
],
},
},
},
"startTime": "A String", # Time at which execution of the build was started.
"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
},
"provenanceBytes": "A String", # 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.
},
"compliance": { # An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. # Describes a compliance violation on a linked resource.
"nonComplianceReason": "A String",
"nonCompliantFiles": [
{ # Details about files that caused a compliance check to fail. display_command is a single command that can be used to display a list of non compliant files. When there is no such command, we can also iterate a list of non compliant file using 'path'.
"displayCommand": "A String", # Command to display the non-compliant files.
"path": "A String", # Empty if `display_command` is set.
"reason": "A String", # Explains why a file is non compliant for a CIS check.
},
],
"version": { # Describes the CIS benchmark version that is applicable to a given OS and os version. # The OS and config version the benchmark was run on.
"benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
"cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
"version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
},
},
"createTime": "A String", # Output only. The time this occurrence was created.
"deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.
"address": "A String", # Address of the runtime element hosting this deployment.
"config": "A String", # Configuration used to create this deployment.
"deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
"platform": "A String", # Platform hosting this deployment.
"resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
"A String",
],
"undeployTime": "A String", # End of the lifetime of this deployment.
"userEmail": "A String", # Identity of the user that triggered this deployment.
},
"discovery": { # Provides information about the analysis status of a discovered resource. # Describes when a resource was discovered.
"analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource.
"analysisType": [
"A String",
],
},
"analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors.
{ # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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 field, or localized by the client.
},
],
"analysisStatus": "A String", # The status of discovery for the resource.
"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # 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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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 field, or localized by the client.
},
"archiveTime": "A String", # Output only. The time occurrences related to this discovery occurrence were archived.
"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
"cpe": "A String", # The CPE of the resource being scanned.
"lastScanTime": "A String", # The last time this resource was scanned.
"sbomStatus": { # The status of an SBOM generation. # The status of an SBOM generation.
"error": "A String", # If there was an error generating an SBOM, this will indicate what that error was.
"sbomState": "A String", # The progress of the SBOM generation.
},
},
"dsseAttestation": { # Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. # Describes an attestation of an artifact using dsse.
"envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # If doing something security critical, make sure to verify the signatures in this metadata.
"payload": "A String",
"payloadType": "A String",
"signatures": [
{
"keyid": "A String",
"sig": "A String",
},
],
},
"statement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json".
"_type": "A String", # Always `https://in-toto.io/Statement/v0.1`.
"predicateType": "A String", # `https://slsa.dev/provenance/v0.1` for SlsaProvenance.
"provenance": {
"builderConfig": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenance": {
"builder": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
{
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenanceZeroTwo": { # See full explanation of fields at slsa.dev/provenance/v0.2.
"buildConfig": {
"a_key": "", # Properties of the object.
},
"buildType": "A String",
"builder": { # Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance.
"id": "A String",
},
"invocation": { # Identifies the event that kicked off the build.
"configSource": { # Describes where the config file that kicked off the build came from. This is effectively a pointer to the source where buildConfig came from.
"digest": {
"a_key": "A String",
},
"entryPoint": "A String",
"uri": "A String",
},
"environment": {
"a_key": "", # Properties of the object.
},
"parameters": {
"a_key": "", # Properties of the object.
},
},
"materials": [
{ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on.
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String",
"buildInvocationId": "A String",
"buildStartedOn": "A String",
"completeness": { # Indicates that the builder claims certain fields in this message to be complete.
"environment": True or False,
"materials": True or False,
"parameters": True or False,
},
"reproducible": True or False,
},
},
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
},
"envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # https://github.com/secure-systems-lab/dsse
"payload": "A String",
"payloadType": "A String",
"signatures": [
{
"keyid": "A String",
"sig": "A String",
},
],
},
"image": { # Details of the derived image portion of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Describes how this resource derives from the basis in the associated note.
"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
"distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.
"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
"A String",
],
"v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
},
"layerInfo": [ # 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.
{ # Layer holds metadata specific to a layer of a Docker image.
"arguments": "A String", # The recovered arguments to the Dockerfile directive.
"directive": "A String", # Required. The recovered Dockerfile directive used to construct this layer. See https://docs.docker.com/engine/reference/builder/ for more information.
},
],
},
"kind": "A String", # Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests.
"name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
"noteName": "A String", # 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.
"package": { # Details on how a particular software package was installed on a system. # Describes the installation of a package on the linked resource.
"architecture": "A String", # Output only. The CPU architecture for which packages in this distribution channel were built. Architecture will be blank for language packages.
"cpeUri": "A String", # Output only. 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.
"license": { # License information. # Licenses that have been declared by the authors of the package.
"comments": "A String", # Comments
"expression": "A String", # 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".
},
"location": [ # All of the places within the filesystem versions of this package have been found.
{ # An occurrence of a particular package installation found within a system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.
"cpeUri": "A String", # Deprecated. The CPE URI in [CPE format](https://cpe.mitre.org/specification/)
"path": "A String", # The path from which we gathered that this package/version is installed.
"version": { # Version contains structured information about the version of a package. # Deprecated. The version installed at this location.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
],
"name": "A String", # Required. Output only. The name of the installed package.
"packageType": "A String", # Output only. The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"version": { # Version contains structured information about the version of a package. # Output only. The version of the package.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
"remediation": "A String", # A description of actions that can be taken to remedy the note.
"resourceUri": "A String", # Required. Immutable. A URI that represents the resource for which the occurrence applies. For example, `https://gcr.io/project/image@sha256:123abc` for a Docker image.
"sbomReference": { # The occurrence representing an SBOM reference as applied to a specific resource. The occurrence follows the DSSE specification. See https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for more details. # Describes a specific SBOM reference occurrences.
"payload": { # The actual payload that contains the SBOM Reference data. The payload follows the intoto statement specification. See https://github.com/in-toto/attestation/blob/main/spec/v1.0/statement.md for more details. # The actual payload that contains the SBOM reference data.
"_type": "A String", # Identifier for the schema of the Statement.
"predicate": { # A predicate which describes the SBOM being referenced. # Additional parameters of the Predicate. Includes the actual data about the SBOM.
"digest": { # A map of algorithm to digest of the contents of the SBOM.
"a_key": "A String",
},
"location": "A String", # The location of the SBOM.
"mimeType": "A String", # The mime type of the SBOM.
"referrerId": "A String", # The person or system referring this predicate to the consumer.
},
"predicateType": "A String", # URI identifying the type of the Predicate.
"subject": [ # Set of software artifacts that the attestation applies to. Each element represents a single software artifact.
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"payloadType": "A String", # The kind of payload that SbomReferenceIntotoPayload takes. Since it's in the intoto format, this value is expected to be 'application/vnd.in-toto+json'.
"signatures": [ # The signatures over the payload.
{
"keyid": "A String",
"sig": "A String",
},
],
},
"updateTime": "A String", # Output only. The time this occurrence was last updated.
"upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). For Windows, both distribution and windows_update contain information for the Windows update. # Describes an available package upgrade on the linked resource.
"distribution": { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities. # Metadata about the upgrade for available for the specific operating system for the resource_url. This allows efficient filtering, as well as making it easier to use the occurrence.
"classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. For Windows the classification is one of the category_ids listed at https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85)
"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
"cve": [ # The cve tied to this Upgrade.
"A String",
],
"severity": "A String", # The severity as specified by the upstream operating system.
},
"package": "A String", # Required for non-Windows OS. The package this Upgrade is for.
"parsedVersion": { # Version contains structured information about the version of a package. # Required for non-Windows OS. The version of the package in a machine + human readable form.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"windowsUpdate": { # Windows Update represents the metadata about the update for the Windows operating system. The fields in this message come from the Windows Update API documented at https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. # Required for Windows OS. Represents the metadata about the Windows update.
"categories": [ # The list of categories to which the update belongs.
{ # The category to which the update belongs.
"categoryId": "A String", # The identifier of the category.
"name": "A String", # The localized name of the category.
},
],
"description": "A String", # The localized description of the update.
"identity": { # The unique identifier of the update. # Required - The unique identifier for the update.
"revision": 42, # The revision number of the update.
"updateId": "A String", # The revision independent identifier of the update.
},
"kbArticleIds": [ # The Microsoft Knowledge Base article IDs that are associated with the update.
"A String",
],
"lastPublishedTimestamp": "A String", # The last published timestamp of the update.
"supportUrl": "A String", # The hyperlink to the support information for the update.
"title": "A String", # The localized title of the update.
},
},
"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability.
"cvssScore": 3.14, # 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.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity.
"cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. 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.
"extraDetails": "A String", # Occurrence-specific extra details about the vulnerability.
"fixAvailable": True or False, # Output only. Whether at least one of the affected packages has a fix available.
"longDescription": "A String", # Output only. A detailed description of this vulnerability.
"packageIssue": [ # Required. The set of affected locations and their fixes (if available) within the associated resource.
{ # A detail for a distro and package this vulnerability occurrence was found in and its associated fix (if one is available).
"affectedCpeUri": "A String", # Required. The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability was found in.
"affectedPackage": "A String", # Required. The package this vulnerability was found in.
"affectedVersion": { # Version contains structured information about the version of a package. # Required. The version of the package that is installed on the resource affected by this vulnerability.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"effectiveSeverity": "A String", # Output only. The distro or language system assigned severity for this vulnerability when that is available and note provider assigned severity when it is not available.
"fileLocation": [ # The location at which this package was found.
{ # Indicates the location at which a package was found.
"filePath": "A String", # For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.
},
],
"fixAvailable": True or False, # Output only. Whether a fix is available for this package.
"fixedCpeUri": "A String", # The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability was fixed in. It is possible for this to be different from the affected_cpe_uri.
"fixedPackage": "A String", # The package this vulnerability was fixed in. It is possible for this to be different from the affected_package.
"fixedVersion": { # Version contains structured information about the version of a package. # Required. The version of the package this vulnerability was fixed in. Setting this to VersionKind.MAXIMUM means no fix is yet available.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"packageType": "A String", # The type of package (e.g. OS, MAVEN, GO).
},
],
"relatedUrls": [ # Output only. URLs related to this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"severity": "A String", # Output only. The note provider assigned severity of this vulnerability.
"shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
"type": "A String", # The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"vexAssessment": { # VexAssessment provides all publisher provided Vex information that is related to this vulnerability.
"cve": "A String", # Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Deprecated: Use vulnerability_id instead to denote CVEs.
"impacts": [ # Contains information about the impact of this vulnerability, this will change with time.
"A String",
],
"justification": { # Justification provides the justification when the state of the assessment if NOT_AFFECTED. # Justification provides the justification when the state of the assessment if NOT_AFFECTED.
"details": "A String", # Additional details on why this justification was chosen.
"justificationType": "A String", # The justification type for this vulnerability.
},
"noteName": "A String", # The VulnerabilityAssessment note from which this VexAssessment was generated. This will be of the form: `projects/[PROJECT_ID]/notes/[NOTE_ID]`.
"relatedUris": [ # Holds a list of references associated with this vulnerability item and assessment.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"remediations": [ # Specifies details on how to handle (and presumably, fix) a vulnerability.
{ # Specifies details on how to handle (and presumably, fix) a vulnerability.
"details": "A String", # Contains a comprehensive human-readable discussion of the remediation.
"remediationType": "A String", # The type of remediation that can be applied.
"remediationUri": { # Metadata for any related URL information. # Contains the URL where to obtain the remediation.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
},
],
"state": "A String", # Provides the state of this Vulnerability assessment.
"vulnerabilityId": "A String", # The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.
},
},
}

updateMask: string, The fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # An instance of an analysis type that has been found on a resource.
"attestation": { # 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 lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact.
"jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas.
{
"compactJwt": "A String", # The compact encoding of a JWS, which is always three base64 encoded strings joined by periods. For details, see: https://tools.ietf.org/html/rfc7515.html#section-3.1
},
],
"serializedPayload": "A String", # Required. The serialized payload that is verified by one or more `signatures`.
"signatures": [ # 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.
{ # 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).
"publicKeyId": "A String", # 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"
"signature": "A String", # 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.
},
],
},
"build": { # Details of a build occurrence. # Describes a verifiable build.
"inTotoSlsaProvenanceV1": { # In-Toto Slsa Provenance V1 represents a slsa provenance meeting the slsa spec, wrapped in an in-toto statement. This allows for direct jsonification of a to-spec in-toto slsa statement with a to-spec slsa provenance.
"_type": "A String", # InToto spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement
"predicate": { # Keep in sync with schema at https://github.com/slsa-framework/slsa/blob/main/docs/provenance/schema/v1/provenance.proto Builder renamed to ProvenanceBuilder because of Java conflicts.
"buildDefinition": {
"buildType": "A String",
"externalParameters": {
"a_key": "", # Properties of the object.
},
"internalParameters": {
"a_key": "", # Properties of the object.
},
"resolvedDependencies": [
{
"annotations": {
"a_key": "",
},
"content": "A String",
"digest": {
"a_key": "A String",
},
"downloadLocation": "A String",
"mediaType": "A String",
"name": "A String",
"uri": "A String",
},
],
},
"runDetails": {
"builder": {
"builderDependencies": [
{
"annotations": {
"a_key": "",
},
"content": "A String",
"digest": {
"a_key": "A String",
},
"downloadLocation": "A String",
"mediaType": "A String",
"name": "A String",
"uri": "A String",
},
],
"id": "A String",
"version": {
"a_key": "A String",
},
},
"byproducts": [
{
"annotations": {
"a_key": "",
},
"content": "A String",
"digest": {
"a_key": "A String",
},
"downloadLocation": "A String",
"mediaType": "A String",
"name": "A String",
"uri": "A String",
},
],
"metadata": {
"finishedOn": "A String",
"invocationId": "A String",
"startedOn": "A String",
},
},
},
"predicateType": "A String",
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"intotoProvenance": { # Deprecated. See InTotoStatement for the replacement. In-toto Provenance representation as defined in spec.
"builderConfig": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"intotoStatement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json". # In-toto Statement representation as defined in spec. The intoto_statement can contain any type of provenance. The serialized payload of the statement can be stored and signed in the Occurrence's envelope.
"_type": "A String", # Always `https://in-toto.io/Statement/v0.1`.
"predicateType": "A String", # `https://slsa.dev/provenance/v0.1` for SlsaProvenance.
"provenance": {
"builderConfig": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenance": {
"builder": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
{
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenanceZeroTwo": { # See full explanation of fields at slsa.dev/provenance/v0.2.
"buildConfig": {
"a_key": "", # Properties of the object.
},
"buildType": "A String",
"builder": { # Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance.
"id": "A String",
},
"invocation": { # Identifies the event that kicked off the build.
"configSource": { # Describes where the config file that kicked off the build came from. This is effectively a pointer to the source where buildConfig came from.
"digest": {
"a_key": "A String",
},
"entryPoint": "A String",
"uri": "A String",
},
"environment": {
"a_key": "", # Properties of the object.
},
"parameters": {
"a_key": "", # Properties of the object.
},
},
"materials": [
{ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on.
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String",
"buildInvocationId": "A String",
"buildStartedOn": "A String",
"completeness": { # Indicates that the builder claims certain fields in this message to be complete.
"environment": True or False,
"materials": True or False,
"parameters": True or False,
},
"reproducible": True or False,
},
},
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # The actual provenance for the build.
"buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.
"a_key": "A String",
},
"builderVersion": "A String", # Version string of the builder at the time this build was executed.
"builtArtifacts": [ # Output of the build.
{ # Artifact describes a build product.
"checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.
"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.
"names": [ # 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.
"A String",
],
},
],
"commands": [ # Commands requested by the build.
{ # Command describes a step performed as part of the build pipeline.
"args": [ # Command-line arguments used when executing this command.
"A String",
],
"dir": "A String", # Working directory (relative to project source root) used when running this command.
"env": [ # Environment variables set before running this command.
"A String",
],
"id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.
"name": "A String", # 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`.
"waitFor": [ # The ID(s) of the command(s) that this command depends on.
"A String",
],
},
],
"createTime": "A String", # Time at which the build was created.
"creator": "A String", # 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.
"endTime": "A String", # Time at which execution of the build was finished.
"id": "A String", # Required. Unique identifier of the build.
"logsUri": "A String", # URI where any logs for this provenance were written.
"projectId": "A String", # ID of the project.
"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.
"additionalContexts": [ # 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.
{ # 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.
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
"uid": "A String", # A server-assigned, globally unique identifier.
},
"revisionId": "A String", # A revision ID.
},
"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"gerritProject": "A String", # 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.
"hostUri": "A String", # The URI of a running Gerrit instance.
"revisionId": "A String", # A revision (commit) ID.
},
"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).
"revisionId": "A String", # Git commit hash.
"url": "A String", # Git repository URL.
},
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
},
],
"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.
"context": { # 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. # If provided, the source code used for the build came from this location.
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
"uid": "A String", # A server-assigned, globally unique identifier.
},
"revisionId": "A String", # A revision ID.
},
"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"gerritProject": "A String", # 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.
"hostUri": "A String", # The URI of a running Gerrit instance.
"revisionId": "A String", # A revision (commit) ID.
},
"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).
"revisionId": "A String", # Git commit hash.
"url": "A String", # Git repository URL.
},
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
},
"fileHashes": { # 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.
"a_key": { # Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build.
"fileHash": [ # Required. Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # Required. The type of hash that was performed, e.g. "SHA-256".
"value": "A String", # Required. The hash value.
},
],
},
},
},
"startTime": "A String", # Time at which execution of the build was started.
"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
},
"provenanceBytes": "A String", # 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.
},
"compliance": { # An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. # Describes a compliance violation on a linked resource.
"nonComplianceReason": "A String",
"nonCompliantFiles": [
{ # Details about files that caused a compliance check to fail. display_command is a single command that can be used to display a list of non compliant files. When there is no such command, we can also iterate a list of non compliant file using 'path'.
"displayCommand": "A String", # Command to display the non-compliant files.
"path": "A String", # Empty if `display_command` is set.
"reason": "A String", # Explains why a file is non compliant for a CIS check.
},
],
"version": { # Describes the CIS benchmark version that is applicable to a given OS and os version. # The OS and config version the benchmark was run on.
"benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
"cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
"version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
},
},
"createTime": "A String", # Output only. The time this occurrence was created.
"deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.
"address": "A String", # Address of the runtime element hosting this deployment.
"config": "A String", # Configuration used to create this deployment.
"deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
"platform": "A String", # Platform hosting this deployment.
"resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
"A String",
],
"undeployTime": "A String", # End of the lifetime of this deployment.
"userEmail": "A String", # Identity of the user that triggered this deployment.
},
"discovery": { # Provides information about the analysis status of a discovered resource. # Describes when a resource was discovered.
"analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource.
"analysisType": [
"A String",
],
},
"analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors.
{ # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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 field, or localized by the client.
},
],
"analysisStatus": "A String", # The status of discovery for the resource.
"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # 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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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 field, or localized by the client.
},
"archiveTime": "A String", # Output only. The time occurrences related to this discovery occurrence were archived.
"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
"cpe": "A String", # The CPE of the resource being scanned.
"lastScanTime": "A String", # The last time this resource was scanned.
"sbomStatus": { # The status of an SBOM generation. # The status of an SBOM generation.
"error": "A String", # If there was an error generating an SBOM, this will indicate what that error was.
"sbomState": "A String", # The progress of the SBOM generation.
},
},
"dsseAttestation": { # Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. # Describes an attestation of an artifact using dsse.
"envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # If doing something security critical, make sure to verify the signatures in this metadata.
"payload": "A String",
"payloadType": "A String",
"signatures": [
{
"keyid": "A String",
"sig": "A String",
},
],
},
"statement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json".
"_type": "A String", # Always `https://in-toto.io/Statement/v0.1`.
"predicateType": "A String", # `https://slsa.dev/provenance/v0.1` for SlsaProvenance.
"provenance": {
"builderConfig": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenance": {
"builder": { # required
"id": "A String",
},
"materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
{
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
"buildStartedOn": "A String", # The timestamp of when the build started.
"completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete.
"arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required
"arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
"entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
"environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenanceZeroTwo": { # See full explanation of fields at slsa.dev/provenance/v0.2.
"buildConfig": {
"a_key": "", # Properties of the object.
},
"buildType": "A String",
"builder": { # Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance.
"id": "A String",
},
"invocation": { # Identifies the event that kicked off the build.
"configSource": { # Describes where the config file that kicked off the build came from. This is effectively a pointer to the source where buildConfig came from.
"digest": {
"a_key": "A String",
},
"entryPoint": "A String",
"uri": "A String",
},
"environment": {
"a_key": "", # Properties of the object.
},
"parameters": {
"a_key": "", # Properties of the object.
},
},
"materials": [
{ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on.
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String",
"buildInvocationId": "A String",
"buildStartedOn": "A String",
"completeness": { # Indicates that the builder claims certain fields in this message to be complete.
"environment": True or False,
"materials": True or False,
"parameters": True or False,
},
"reproducible": True or False,
},
},
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
},
"envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # https://github.com/secure-systems-lab/dsse
"payload": "A String",
"payloadType": "A String",
"signatures": [
{
"keyid": "A String",
"sig": "A String",
},
],
},
"image": { # Details of the derived image portion of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Describes how this resource derives from the basis in the associated note.
"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
"distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.
"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
"A String",
],
"v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
},
"layerInfo": [ # 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.
{ # Layer holds metadata specific to a layer of a Docker image.
"arguments": "A String", # The recovered arguments to the Dockerfile directive.
"directive": "A String", # Required. The recovered Dockerfile directive used to construct this layer. See https://docs.docker.com/engine/reference/builder/ for more information.
},
],
},
"kind": "A String", # Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests.
"name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
"noteName": "A String", # 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.
"package": { # Details on how a particular software package was installed on a system. # Describes the installation of a package on the linked resource.
"architecture": "A String", # Output only. The CPU architecture for which packages in this distribution channel were built. Architecture will be blank for language packages.
"cpeUri": "A String", # Output only. 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.
"license": { # License information. # Licenses that have been declared by the authors of the package.
"comments": "A String", # Comments
"expression": "A String", # 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".
},
"location": [ # All of the places within the filesystem versions of this package have been found.
{ # An occurrence of a particular package installation found within a system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.
"cpeUri": "A String", # Deprecated. The CPE URI in [CPE format](https://cpe.mitre.org/specification/)
"path": "A String", # The path from which we gathered that this package/version is installed.
"version": { # Version contains structured information about the version of a package. # Deprecated. The version installed at this location.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
],
"name": "A String", # Required. Output only. The name of the installed package.
"packageType": "A String", # Output only. The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"version": { # Version contains structured information about the version of a package. # Output only. The version of the package.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
"remediation": "A String", # A description of actions that can be taken to remedy the note.
"resourceUri": "A String", # Required. Immutable. A URI that represents the resource for which the occurrence applies. For example, `https://gcr.io/project/image@sha256:123abc` for a Docker image.
"sbomReference": { # The occurrence representing an SBOM reference as applied to a specific resource. The occurrence follows the DSSE specification. See https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for more details. # Describes a specific SBOM reference occurrences.
"payload": { # The actual payload that contains the SBOM Reference data. The payload follows the intoto statement specification. See https://github.com/in-toto/attestation/blob/main/spec/v1.0/statement.md for more details. # The actual payload that contains the SBOM reference data.
"_type": "A String", # Identifier for the schema of the Statement.
"predicate": { # A predicate which describes the SBOM being referenced. # Additional parameters of the Predicate. Includes the actual data about the SBOM.
"digest": { # A map of algorithm to digest of the contents of the SBOM.
"a_key": "A String",
},
"location": "A String", # The location of the SBOM.
"mimeType": "A String", # The mime type of the SBOM.
"referrerId": "A String", # The person or system referring this predicate to the consumer.
},
"predicateType": "A String", # URI identifying the type of the Predicate.
"subject": [ # Set of software artifacts that the attestation applies to. Each element represents a single software artifact.
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"payloadType": "A String", # The kind of payload that SbomReferenceIntotoPayload takes. Since it's in the intoto format, this value is expected to be 'application/vnd.in-toto+json'.
"signatures": [ # The signatures over the payload.
{
"keyid": "A String",
"sig": "A String",
},
],
},
"updateTime": "A String", # Output only. The time this occurrence was last updated.
"upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). For Windows, both distribution and windows_update contain information for the Windows update. # Describes an available package upgrade on the linked resource.
"distribution": { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities. # Metadata about the upgrade for available for the specific operating system for the resource_url. This allows efficient filtering, as well as making it easier to use the occurrence.
"classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. For Windows the classification is one of the category_ids listed at https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85)
"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
"cve": [ # The cve tied to this Upgrade.
"A String",
],
"severity": "A String", # The severity as specified by the upstream operating system.
},
"package": "A String", # Required for non-Windows OS. The package this Upgrade is for.
"parsedVersion": { # Version contains structured information about the version of a package. # Required for non-Windows OS. The version of the package in a machine + human readable form.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"windowsUpdate": { # Windows Update represents the metadata about the update for the Windows operating system. The fields in this message come from the Windows Update API documented at https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. # Required for Windows OS. Represents the metadata about the Windows update.
"categories": [ # The list of categories to which the update belongs.
{ # The category to which the update belongs.
"categoryId": "A String", # The identifier of the category.
"name": "A String", # The localized name of the category.
},
],
"description": "A String", # The localized description of the update.
"identity": { # The unique identifier of the update. # Required - The unique identifier for the update.
"revision": 42, # The revision number of the update.
"updateId": "A String", # The revision independent identifier of the update.
},
"kbArticleIds": [ # The Microsoft Knowledge Base article IDs that are associated with the update.
"A String",
],
"lastPublishedTimestamp": "A String", # The last published timestamp of the update.
"supportUrl": "A String", # The hyperlink to the support information for the update.
"title": "A String", # The localized title of the update.
},
},
"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability.
"cvssScore": 3.14, # 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.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity.
"cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. 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.
"extraDetails": "A String", # Occurrence-specific extra details about the vulnerability.
"fixAvailable": True or False, # Output only. Whether at least one of the affected packages has a fix available.
"longDescription": "A String", # Output only. A detailed description of this vulnerability.
"packageIssue": [ # Required. The set of affected locations and their fixes (if available) within the associated resource.
{ # A detail for a distro and package this vulnerability occurrence was found in and its associated fix (if one is available).
"affectedCpeUri": "A String", # Required. The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability was found in.
"affectedPackage": "A String", # Required. The package this vulnerability was found in.
"affectedVersion": { # Version contains structured information about the version of a package. # Required. The version of the package that is installed on the resource affected by this vulnerability.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"effectiveSeverity": "A String", # Output only. The distro or language system assigned severity for this vulnerability when that is available and note provider assigned severity when it is not available.
"fileLocation": [ # The location at which this package was found.
{ # Indicates the location at which a package was found.
"filePath": "A String", # For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.
},
],
"fixAvailable": True or False, # Output only. Whether a fix is available for this package.
"fixedCpeUri": "A String", # The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability was fixed in. It is possible for this to be different from the affected_cpe_uri.
"fixedPackage": "A String", # The package this vulnerability was fixed in. It is possible for this to be different from the affected_package.
"fixedVersion": { # Version contains structured information about the version of a package. # Required. The version of the package this vulnerability was fixed in. Setting this to VersionKind.MAXIMUM means no fix is yet available.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # 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.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"packageType": "A String", # The type of package (e.g. OS, MAVEN, GO).
},
],
"relatedUrls": [ # Output only. URLs related to this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"severity": "A String", # Output only. The note provider assigned severity of this vulnerability.
"shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
"type": "A String", # The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"vexAssessment": { # VexAssessment provides all publisher provided Vex information that is related to this vulnerability.
"cve": "A String", # Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Deprecated: Use vulnerability_id instead to denote CVEs.
"impacts": [ # Contains information about the impact of this vulnerability, this will change with time.
"A String",
],
"justification": { # Justification provides the justification when the state of the assessment if NOT_AFFECTED. # Justification provides the justification when the state of the assessment if NOT_AFFECTED.
"details": "A String", # Additional details on why this justification was chosen.
"justificationType": "A String", # The justification type for this vulnerability.
},
"noteName": "A String", # The VulnerabilityAssessment note from which this VexAssessment was generated. This will be of the form: `projects/[PROJECT_ID]/notes/[NOTE_ID]`.
"relatedUris": [ # Holds a list of references associated with this vulnerability item and assessment.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"remediations": [ # Specifies details on how to handle (and presumably, fix) a vulnerability.
{ # Specifies details on how to handle (and presumably, fix) a vulnerability.
"details": "A String", # Contains a comprehensive human-readable discussion of the remediation.
"remediationType": "A String", # The type of remediation that can be applied.
"remediationUri": { # Metadata for any related URL information. # Contains the URL where to obtain the remediation.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
},
],
"state": "A String", # Provides the state of this Vulnerability assessment.
"vulnerabilityId": "A String", # The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.
},
},
}

setIamPolicy(resource, body=None, x__xgafv=None)

Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

Args:
  resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for `SetIamPolicy` method.
  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
      { # Associates `members`, or principals, with a `role`.
        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
        },
        "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
          "A String",
        ],
        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
      },
    ],
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
    "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
    { # Associates `members`, or principals, with a `role`.
      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
      },
      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
        "A String",
      ],
      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
    },
  ],
  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}

testIamPermissions(resource, body=None, x__xgafv=None)

Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

Args:
  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for `TestIamPermissions` method.
  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
    "A String",
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for `TestIamPermissions` method.
  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
    "A String",
  ],
}

Container Analysis API . projects . occurrences

Instance Methods

Method Details