{ "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "ownerName": "Google", "mtlsRootUrl": "https://ondemandscanning.mtls.googleapis.com/", "version": "v1beta1", "title": "On-Demand Scanning API", "servicePath": "", "id": "ondemandscanning:v1beta1", "kind": "discovery#restDescription", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "discoveryVersion": "v1", "rootUrl": "https://ondemandscanning.googleapis.com/", "baseUrl": "https://ondemandscanning.googleapis.com/", "basePath": "", "canonicalName": "On-Demand Scanning", "parameters": { "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "alt": { "type": "string", "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" } }, "name": "ondemandscanning", "fullyEncodeReservedExpansion": true, "schemas": { "ListOperationsResponse": { "id": "ListOperationsResponse", "description": "The response message for Operations.ListOperations.", "type": "object", "properties": { "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Operation" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "unreachable": { "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array", "items": { "type": "string" } } } }, "Operation": { "id": "Operation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "metadata": { "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "response": { "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "Status": { "id": "Status", "description": "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).", "type": "object", "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" }, "message": { "description": "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.", "type": "string" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } } }, "Empty": { "id": "Empty", "description": "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); }", "type": "object", "properties": {} }, "AnalyzePackagesRequest": { "id": "AnalyzePackagesRequest", "description": "AnalyzePackagesRequest is the request to analyze a list of packages and create Vulnerability Occurrences for it.", "type": "object", "properties": { "resourceUri": { "description": "Required. The resource URI of the container image being scanned.", "type": "string" }, "packages": { "description": "The packages to analyze.", "type": "array", "items": { "$ref": "PackageData" } } } }, "PackageData": { "id": "PackageData", "type": "object", "properties": { "package": { "description": "The package being analysed for vulnerabilities", "type": "string" }, "version": { "description": "The version of the package being analysed", "type": "string" }, "os": { "description": "The OS affected by a vulnerability Used to generate the cpe_uri for OS packages", "type": "string" }, "osVersion": { "description": "The version of the OS Used to generate the cpe_uri for OS packages", "type": "string" }, "cpeUri": { "description": "The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in which the vulnerability may manifest. Examples include distro or storage location for vulnerable jar.", "type": "string" }, "unused": { "type": "string" }, "packageType": { "description": "The type of package: os, maven, go, etc.", "type": "string", "enumDescriptions": [ "", "Operating System", "Java packages from Maven.", "Go third-party packages.", "Go toolchain + standard library packages.", "Python packages.", "NPM packages.", "Nuget (C#/.NET) packages.", "Ruby packges (from RubyGems package manager).", "Rust packages from Cargo (GitHub ecosystem is `RUST`).", "PHP packages from Composer package manager.", "Swift packages from Swift Package Manager (SwiftPM)." ], "enum": [ "PACKAGE_TYPE_UNSPECIFIED", "OS", "MAVEN", "GO", "GO_STDLIB", "PYPI", "NPM", "NUGET", "RUBYGEMS", "RUST", "COMPOSER", "SWIFT" ] }, "hashDigest": { "description": "HashDigest stores the SHA512 hash digest of the jar file if the package is of type Maven. This field will be unset for non Maven packages.", "type": "string" }, "fileLocation": { "description": "The path to the jar file / go binary file.", "type": "array", "items": { "$ref": "FileLocation" } }, "patchedCve": { "description": "CVEs that this package is no longer vulnerable to", "type": "array", "items": { "type": "string" } }, "dependencyChain": { "description": "The dependency chain between this package and the user's artifact. List in order from the customer's package under review first, to the current package last. Inclusive of the original package and the current package.", "type": "array", "items": { "$ref": "LanguagePackageDependency" } }, "maintainer": { "description": "The maintainer of the package.", "$ref": "Maintainer" }, "architecture": { "description": "The architecture of the package.", "type": "string" }, "binaryVersion": { "description": "DEPRECATED", "$ref": "PackageVersion" }, "sourceVersion": { "description": "DEPRECATED", "$ref": "PackageVersion" }, "binarySourceInfo": { "description": "A bundle containing the binary and source information.", "type": "array", "items": { "$ref": "BinarySourceInfo" } }, "licenses": { "description": "The list of licenses found that are related to a given package. Note that licenses may also be stored on the BinarySourceInfo. If there is no BinarySourceInfo (because there's no concept of source vs binary), then it will be stored here, while if there are BinarySourceInfos, it will be stored there, as one source can have multiple binaries with different licenses.", "type": "array", "items": { "type": "string" } }, "layerDetails": { "$ref": "LayerDetails" } } }, "FileLocation": { "id": "FileLocation", "description": "Indicates the location at which a package was found.", "type": "object", "properties": { "filePath": { "description": "For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.", "type": "string" }, "layerDetails": { "$ref": "LayerDetails" }, "lineNumber": { "description": "Line number in the file where the package is found. Applies only to source repository scanning. Note: this field is marked as `optional` in other corresponding protos, but in edition 2023, the \"optional\" keyword is redundant.", "type": "integer", "format": "int32" } } }, "LayerDetails": { "id": "LayerDetails", "description": "Details about the layer a package was found in.", "type": "object", "properties": { "index": { "description": "The index of the layer in the container image.", "type": "integer", "format": "int32" }, "diffId": { "description": "The diff ID (sha256 hash) of the layer in the container image.", "type": "string" }, "chainId": { "description": "The layer chain ID (sha256 hash) of the layer in the container image. https://github.com/opencontainers/image-spec/blob/main/config.md#layer-chainid", "type": "string" }, "command": { "description": "The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built.", "type": "string" }, "baseImages": { "description": "The base images the layer is found within.", "type": "array", "items": { "$ref": "BaseImage" } } } }, "BaseImage": { "id": "BaseImage", "description": "BaseImage describes a base image of a container image.", "type": "object", "properties": { "name": { "description": "The name of the base image.", "type": "string" }, "repository": { "description": "The repository name in which the base image is from.", "type": "string" }, "layerCount": { "description": "The number of layers that the base image is composed of.", "type": "integer", "format": "int32" }, "registry": { "description": "The registry in which the base image is from.", "type": "string" } } }, "LanguagePackageDependency": { "id": "LanguagePackageDependency", "description": "Indicates a language package available between this package and the customer's resource artifact.", "type": "object", "properties": { "package": { "type": "string" }, "version": { "type": "string" } } }, "Maintainer": { "id": "Maintainer", "type": "object", "properties": { "name": { "type": "string" }, "kind": { "type": "string" }, "email": { "type": "string" }, "url": { "type": "string" } } }, "PackageVersion": { "id": "PackageVersion", "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "string" }, "licenses": { "description": "The licenses associated with this package. Note that this has to go on the PackageVersion level, because we can have cases with images with the same source having different licences. E.g. in Alpine, musl and musl-utils both have the same origin musl, but have different sets of licenses.", "type": "array", "items": { "type": "string" } } } }, "BinarySourceInfo": { "id": "BinarySourceInfo", "type": "object", "properties": { "binaryVersion": { "description": "The binary package. This is significant when the source is different than the binary itself. Historically if they've differed, we've stored the name of the source and its version in the package/version fields, but we should also store the binary package info, as that's what's actually installed.", "$ref": "PackageVersion" }, "sourceVersion": { "description": "The source package. Similar to the above, this is significant when the source is different than the binary itself. Since the top-level package/version fields are based on an if/else, we need a separate field for both binary and source if we want to know definitively where the data is coming from.", "$ref": "PackageVersion" } } }, "ListVulnerabilitiesResponse": { "id": "ListVulnerabilitiesResponse", "description": "ListVulnerabilitiesResponse contains a single page of vulnerabilities resulting from a scan.", "type": "object", "properties": { "occurrences": { "description": "The list of Vulnerability Occurrences resulting from a scan.", "type": "array", "items": { "$ref": "Occurrence" } }, "nextPageToken": { "description": "A page token that can be used in a subsequent call to ListVulnerabilities to continue retrieving results.", "type": "string" } } }, "Occurrence": { "id": "Occurrence", "description": "An instance of an analysis type that has been found on a resource.", "type": "object", "properties": { "name": { "description": "Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.", "type": "string" }, "resourceUri": { "description": "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.", "type": "string" }, "noteName": { "description": "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.", "type": "string" }, "kind": { "description": "Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests.", "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "The note and occurrence represent a package vulnerability.", "The note and occurrence assert build provenance.", "This represents an image basis relationship.", "This represents a package installed via a package manager.", "The note and occurrence track deployment events.", "The note and occurrence track the initial discovery status of a resource.", "This represents a logical \"role\" that can attest to artifacts.", "This represents an available package upgrade.", "This represents a Compliance Note", "This represents a DSSE attestation Note", "This represents a Vulnerability Assessment.", "This represents an SBOM Reference.", "This represents a secret.", "This represents an AI skill analysis." ], "enum": [ "NOTE_KIND_UNSPECIFIED", "VULNERABILITY", "BUILD", "IMAGE", "PACKAGE", "DEPLOYMENT", "DISCOVERY", "ATTESTATION", "UPGRADE", "COMPLIANCE", "DSSE_ATTESTATION", "VULNERABILITY_ASSESSMENT", "SBOM_REFERENCE", "SECRET", "AI_SKILL_ANALYSIS" ] }, "remediation": { "description": "A description of actions that can be taken to remedy the note.", "type": "string" }, "createTime": { "description": "Output only. The time this occurrence was created.", "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. The time this occurrence was last updated.", "type": "string", "format": "google-datetime" }, "vulnerability": { "description": "Describes a security vulnerability.", "$ref": "VulnerabilityOccurrence" }, "build": { "description": "Describes a verifiable build.", "$ref": "BuildOccurrence" }, "image": { "description": "Describes how this resource derives from the basis in the associated note.", "$ref": "ImageOccurrence" }, "package": { "description": "Describes the installation of a package on the linked resource.", "$ref": "PackageOccurrence" }, "deployment": { "description": "Describes the deployment of an artifact on a runtime.", "$ref": "DeploymentOccurrence" }, "discovery": { "description": "Describes when a resource was discovered.", "$ref": "DiscoveryOccurrence" }, "attestation": { "description": "Describes an attestation of an artifact.", "$ref": "AttestationOccurrence" }, "upgrade": { "description": "Describes an available package upgrade on the linked resource.", "$ref": "UpgradeOccurrence" }, "compliance": { "description": "Describes a compliance violation on a linked resource.", "$ref": "ComplianceOccurrence" }, "dsseAttestation": { "description": "Describes an attestation of an artifact using dsse.", "$ref": "DSSEAttestationOccurrence" }, "sbomReference": { "description": "Describes a specific SBOM reference occurrences.", "$ref": "SBOMReferenceOccurrence" }, "secret": { "description": "Describes a secret.", "$ref": "SecretOccurrence" }, "aiSkillAnalysis": { "description": "Describes an AI skill analysis.", "$ref": "AISkillAnalysisOccurrence" }, "envelope": { "description": "https://github.com/secure-systems-lab/dsse", "$ref": "Envelope" }, "advisoryPublishTime": { "description": "The time this advisory was published by the source.", "type": "string", "format": "google-datetime" } } }, "VulnerabilityOccurrence": { "id": "VulnerabilityOccurrence", "description": "An occurrence of a severity vulnerability on a resource.", "type": "object", "properties": { "type": { "description": "The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).", "type": "string" }, "severity": { "description": "Output only. The note provider assigned severity of this vulnerability.", "type": "string", "enumDescriptions": [ "Unknown.", "Minimal severity.", "Low severity.", "Medium severity.", "High severity.", "Critical severity." ], "enum": [ "SEVERITY_UNSPECIFIED", "MINIMAL", "LOW", "MEDIUM", "HIGH", "CRITICAL" ] }, "cvssScore": { "description": "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.", "type": "number", "format": "float" }, "cvssv3": { "description": "The cvss v3 score for the vulnerability.", "$ref": "CVSS" }, "packageIssue": { "description": "Required. The set of affected locations and their fixes (if available) within the associated resource.", "type": "array", "items": { "$ref": "PackageIssue" } }, "shortDescription": { "description": "Output only. A one sentence description of this vulnerability.", "type": "string" }, "longDescription": { "description": "Output only. A detailed description of this vulnerability.", "type": "string" }, "relatedUrls": { "description": "Output only. URLs related to this vulnerability.", "type": "array", "items": { "$ref": "RelatedUrl" } }, "effectiveSeverity": { "description": "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.", "type": "string", "enumDescriptions": [ "Unknown.", "Minimal severity.", "Low severity.", "Medium severity.", "High severity.", "Critical severity." ], "enum": [ "SEVERITY_UNSPECIFIED", "MINIMAL", "LOW", "MEDIUM", "HIGH", "CRITICAL" ] }, "fixAvailable": { "description": "Output only. Whether at least one of the affected packages has a fix available.", "type": "boolean" }, "cvssVersion": { "description": "Output only. CVSS version used to populate cvss_score and severity.", "type": "string", "enumDescriptions": [ "Unspecified.", "CVSS v2.", "CVSS v3.", "CVSS v4." ], "enum": [ "CVSS_VERSION_UNSPECIFIED", "CVSS_VERSION_2", "CVSS_VERSION_3", "CVSS_VERSION_4" ] }, "cvssV2": { "description": "The cvss v2 score for the vulnerability.", "$ref": "CVSS" }, "vexAssessment": { "$ref": "VexAssessment" }, "extraDetails": { "description": "Occurrence-specific extra details about the vulnerability.", "type": "string" }, "risk": { "description": "Risk information about the vulnerability, such as CISA, EPSS, etc.", "$ref": "Risk" } } }, "CVSS": { "id": "CVSS", "description": "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.", "type": "object", "properties": { "baseScore": { "description": "The base score is a function of the base metric scores.", "type": "number", "format": "float" }, "exploitabilityScore": { "type": "number", "format": "float" }, "impactScore": { "type": "number", "format": "float" }, "attackVector": { "description": "Attack Vector (AV). Defined in CVSS v2, v3, v4.", "type": "string", "enumDescriptions": [ "Unspecified.", "Attack Vector: Network (AV:N). Defined in CVSS v2, v3, v4.", "Attack Vector: Adjacent (AV:A). Defined in CVSS v2, v3, v4.", "Attack Vector: Local (AV:L). Defined in CVSS v2, v3, v4.", "Attack Vector: Physical (AV:P). Defined in CVSS v3, v4." ], "enum": [ "ATTACK_VECTOR_UNSPECIFIED", "ATTACK_VECTOR_NETWORK", "ATTACK_VECTOR_ADJACENT", "ATTACK_VECTOR_LOCAL", "ATTACK_VECTOR_PHYSICAL" ] }, "attackComplexity": { "description": "Attack Complexity (AC). Defined in CVSS v2, v3, v4.", "type": "string", "enumDescriptions": [ "Unspecified.", "Low attack complexity (AC:L). Defined in CVSS v2, v3, v4.", "High attack complexity (AC:H). Defined in CVSS v2, v3, v4.", "Medium attack complexity (AC:M). Defined in CVSS v2." ], "enum": [ "ATTACK_COMPLEXITY_UNSPECIFIED", "ATTACK_COMPLEXITY_LOW", "ATTACK_COMPLEXITY_HIGH", "ATTACK_COMPLEXITY_MEDIUM" ] }, "authentication": { "description": "Authentication (Au). Defined in CVSS v2.", "type": "string", "enumDescriptions": [ "Unspecified.", "Multiple authentication required (Au:M). Defined in CVSS v2.", "Single authentication required (Au:S). Defined in CVSS v2.", "No authentication required (Au:N). Defined in CVSS v2." ], "enum": [ "AUTHENTICATION_UNSPECIFIED", "AUTHENTICATION_MULTIPLE", "AUTHENTICATION_SINGLE", "AUTHENTICATION_NONE" ] }, "privilegesRequired": { "description": "Privileges Required (PR). Defined in CVSS v3, v4.", "type": "string", "enumDescriptions": [ "Unspecified.", "No privileges required (PR:N). Defined in CVSS v3, v4.", "Low privileges required (PR:L). Defined in CVSS v3, v4.", "High privileges required (PR:H). Defined in CVSS v3, v4." ], "enum": [ "PRIVILEGES_REQUIRED_UNSPECIFIED", "PRIVILEGES_REQUIRED_NONE", "PRIVILEGES_REQUIRED_LOW", "PRIVILEGES_REQUIRED_HIGH" ] }, "userInteraction": { "description": "User Interaction (UI). Defined in CVSS v3, v4.", "type": "string", "enumDescriptions": [ "Unspecified.", "No user interaction required (UI:N). Defined in CVSS v3, v4.", "User interaction required (UI:R). Defined in CVSS v3.", "Passive user interaction required (UI:P). Defined in CVSS v4.", "Active user interaction required (UI:A). Defined in CVSS v4." ], "enum": [ "USER_INTERACTION_UNSPECIFIED", "USER_INTERACTION_NONE", "USER_INTERACTION_REQUIRED", "USER_INTERACTION_PASSIVE", "USER_INTERACTION_ACTIVE" ] }, "scope": { "description": "Scope (S). Defined in CVSS v3.", "type": "string", "enumDescriptions": [ "Unspecified.", "Scope: Unchanged (S:U). Defined in CVSS v3.", "Scope: Changed (S:C). Defined in CVSS v3." ], "enum": [ "SCOPE_UNSPECIFIED", "SCOPE_UNCHANGED", "SCOPE_CHANGED" ] }, "confidentialityImpact": { "description": "Confidentiality Impact (C). Defined in CVSS v2, v3.", "type": "string", "enumDescriptions": [ "Unspecified.", "High impact (H). Defined in CVSS v3, v4.", "Low impact (L). Defined in CVSS v3, v4.", "No impact (N). Defined in CVSS v2, v3, v4.", "Partial impact (P). Defined in CVSS v2.", "Complete impact (C). Defined in CVSS v2." ], "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", "IMPACT_LOW", "IMPACT_NONE", "IMPACT_PARTIAL", "IMPACT_COMPLETE" ] }, "integrityImpact": { "description": "Integrity Impact (I). Defined in CVSS v2, v3.", "type": "string", "enumDescriptions": [ "Unspecified.", "High impact (H). Defined in CVSS v3, v4.", "Low impact (L). Defined in CVSS v3, v4.", "No impact (N). Defined in CVSS v2, v3, v4.", "Partial impact (P). Defined in CVSS v2.", "Complete impact (C). Defined in CVSS v2." ], "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", "IMPACT_LOW", "IMPACT_NONE", "IMPACT_PARTIAL", "IMPACT_COMPLETE" ] }, "availabilityImpact": { "description": "Availability Impact (A). Defined in CVSS v2, v3.", "type": "string", "enumDescriptions": [ "Unspecified.", "High impact (H). Defined in CVSS v3, v4.", "Low impact (L). Defined in CVSS v3, v4.", "No impact (N). Defined in CVSS v2, v3, v4.", "Partial impact (P). Defined in CVSS v2.", "Complete impact (C). Defined in CVSS v2." ], "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", "IMPACT_LOW", "IMPACT_NONE", "IMPACT_PARTIAL", "IMPACT_COMPLETE" ] }, "attackRequirements": { "description": "Attack Requirements (AT). Defined in CVSS v4.", "type": "string", "enumDescriptions": [ "Unspecified.", "No attack requirements (AT:N). Defined in CVSS v4.", "Attack requirements: Present (AT:P). Defined in CVSS v4." ], "enum": [ "ATTACK_REQUIREMENTS_UNSPECIFIED", "ATTACK_REQUIREMENTS_NONE", "ATTACK_REQUIREMENTS_PRESENT" ] }, "vulnerableSystemConfidentialityImpact": { "description": "Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4.", "type": "string", "enumDescriptions": [ "Unspecified.", "High impact (H). Defined in CVSS v3, v4.", "Low impact (L). Defined in CVSS v3, v4.", "No impact (N). Defined in CVSS v2, v3, v4.", "Partial impact (P). Defined in CVSS v2.", "Complete impact (C). Defined in CVSS v2." ], "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", "IMPACT_LOW", "IMPACT_NONE", "IMPACT_PARTIAL", "IMPACT_COMPLETE" ] }, "vulnerableSystemIntegrityImpact": { "description": "Vulnerable System Integrity Impact (VI). Defined in CVSS v4.", "type": "string", "enumDescriptions": [ "Unspecified.", "High impact (H). Defined in CVSS v3, v4.", "Low impact (L). Defined in CVSS v3, v4.", "No impact (N). Defined in CVSS v2, v3, v4.", "Partial impact (P). Defined in CVSS v2.", "Complete impact (C). Defined in CVSS v2." ], "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", "IMPACT_LOW", "IMPACT_NONE", "IMPACT_PARTIAL", "IMPACT_COMPLETE" ] }, "vulnerableSystemAvailabilityImpact": { "description": "Vulnerable System Availability Impact (VA). Defined in CVSS v4.", "type": "string", "enumDescriptions": [ "Unspecified.", "High impact (H). Defined in CVSS v3, v4.", "Low impact (L). Defined in CVSS v3, v4.", "No impact (N). Defined in CVSS v2, v3, v4.", "Partial impact (P). Defined in CVSS v2.", "Complete impact (C). Defined in CVSS v2." ], "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", "IMPACT_LOW", "IMPACT_NONE", "IMPACT_PARTIAL", "IMPACT_COMPLETE" ] }, "subsequentSystemConfidentialityImpact": { "description": "Subsequent System Confidentiality Impact (SC). Defined in CVSS v4.", "type": "string", "enumDescriptions": [ "Unspecified.", "High impact (H). Defined in CVSS v3, v4.", "Low impact (L). Defined in CVSS v3, v4.", "No impact (N). Defined in CVSS v2, v3, v4.", "Partial impact (P). Defined in CVSS v2.", "Complete impact (C). Defined in CVSS v2." ], "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", "IMPACT_LOW", "IMPACT_NONE", "IMPACT_PARTIAL", "IMPACT_COMPLETE" ] }, "subsequentSystemIntegrityImpact": { "description": "Subsequent System Integrity Impact (SI). Defined in CVSS v4.", "type": "string", "enumDescriptions": [ "Unspecified.", "High impact (H). Defined in CVSS v3, v4.", "Low impact (L). Defined in CVSS v3, v4.", "No impact (N). Defined in CVSS v2, v3, v4.", "Partial impact (P). Defined in CVSS v2.", "Complete impact (C). Defined in CVSS v2." ], "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", "IMPACT_LOW", "IMPACT_NONE", "IMPACT_PARTIAL", "IMPACT_COMPLETE" ] }, "subsequentSystemAvailabilityImpact": { "description": "Subsequent System Availability Impact (SA). Defined in CVSS v4.", "type": "string", "enumDescriptions": [ "Unspecified.", "High impact (H). Defined in CVSS v3, v4.", "Low impact (L). Defined in CVSS v3, v4.", "No impact (N). Defined in CVSS v2, v3, v4.", "Partial impact (P). Defined in CVSS v2.", "Complete impact (C). Defined in CVSS v2." ], "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", "IMPACT_LOW", "IMPACT_NONE", "IMPACT_PARTIAL", "IMPACT_COMPLETE" ] } } }, "PackageIssue": { "id": "PackageIssue", "description": "A detail for a distro and package this vulnerability occurrence was found in and its associated fix (if one is available).", "type": "object", "properties": { "affectedCpeUri": { "description": "Required. The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability was found in.", "type": "string" }, "affectedPackage": { "description": "Required. The package this vulnerability was found in.", "type": "string" }, "affectedVersion": { "description": "Required. The version of the package that is installed on the resource affected by this vulnerability.", "$ref": "Version" }, "fixedCpeUri": { "description": "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.", "type": "string" }, "fixedPackage": { "description": "The package this vulnerability was fixed in. It is possible for this to be different from the affected_package.", "type": "string" }, "fixedVersion": { "description": "Required. The version of the package this vulnerability was fixed in. Setting this to VersionKind.MAXIMUM means no fix is yet available.", "$ref": "Version" }, "fixAvailable": { "description": "Output only. Whether a fix is available for this package.", "type": "boolean" }, "packageType": { "description": "The type of package (e.g. OS, MAVEN, GO).", "type": "string" }, "effectiveSeverity": { "description": "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.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unknown.", "Minimal severity.", "Low severity.", "Medium severity.", "High severity.", "Critical severity." ], "enum": [ "SEVERITY_UNSPECIFIED", "MINIMAL", "LOW", "MEDIUM", "HIGH", "CRITICAL" ] }, "fileLocation": { "description": "The location at which this package was found.", "type": "array", "items": { "$ref": "GrafeasV1FileLocation" } } } }, "Version": { "id": "Version", "description": "Version contains structured information about the version of a package.", "type": "object", "properties": { "epoch": { "description": "Used to correct mistakes in the version numbering scheme.", "type": "integer", "format": "int32" }, "name": { "description": "Required only when version kind is NORMAL. The main part of the version name.", "type": "string" }, "revision": { "description": "The iteration of the package build from the above version.", "type": "string" }, "inclusive": { "description": "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.", "type": "boolean" }, "kind": { "description": "Required. Distinguishes between sentinel MIN/MAX versions and normal versions.", "type": "string", "enumDescriptions": [ "Unknown.", "A standard package version.", "A special version representing negative infinity.", "A special version representing positive infinity." ], "enum": [ "VERSION_KIND_UNSPECIFIED", "NORMAL", "MINIMUM", "MAXIMUM" ] }, "fullName": { "description": "Human readable version string. This string is of the form :- and is only set when kind is NORMAL.", "type": "string" } } }, "GrafeasV1FileLocation": { "id": "GrafeasV1FileLocation", "description": "Indicates the location at which a package was found.", "type": "object", "properties": { "filePath": { "description": "For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.", "type": "string" }, "layerDetails": { "description": "Each package found in a file should have its own layer metadata (that is, information from the origin layer of the package).", "$ref": "GrafeasV1LayerDetails" }, "lineNumber": { "description": "Line number in the file where the package was found. Optional field that only applies to source repository scanning.", "type": "integer", "format": "int32" } } }, "GrafeasV1LayerDetails": { "id": "GrafeasV1LayerDetails", "description": "Details about the layer a package was found in.", "type": "object", "properties": { "index": { "description": "The index of the layer in the container image.", "type": "integer", "format": "int32" }, "diffId": { "description": "The diff ID (typically a sha256 hash) of the layer in the container image.", "type": "string" }, "chainId": { "description": "The layer chain ID (sha256 hash) of the layer in the container image. https://github.com/opencontainers/image-spec/blob/main/config.md#layer-chainid", "type": "string" }, "command": { "description": "The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built.", "type": "string" }, "baseImages": { "description": "The base images the layer is found within.", "type": "array", "items": { "$ref": "GrafeasV1BaseImage" } } } }, "GrafeasV1BaseImage": { "id": "GrafeasV1BaseImage", "description": "BaseImage describes a base image of a container image.", "type": "object", "properties": { "name": { "description": "The name of the base image.", "type": "string" }, "repository": { "description": "The repository name in which the base image is from.", "type": "string" }, "layerCount": { "description": "The number of layers that the base image is composed of.", "type": "integer", "format": "int32" }, "registry": { "description": "The registry in which the base image is from.", "type": "string" } } }, "RelatedUrl": { "id": "RelatedUrl", "description": "Metadata for any related URL information.", "type": "object", "properties": { "url": { "description": "Specific URL associated with the resource.", "type": "string" }, "label": { "description": "Label to describe usage of the URL.", "type": "string" } } }, "VexAssessment": { "id": "VexAssessment", "description": "VexAssessment provides all publisher provided Vex information that is related to this vulnerability.", "type": "object", "properties": { "cve": { "description": "Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Deprecated: Use vulnerability_id instead to denote CVEs.", "deprecated": true, "type": "string" }, "vulnerabilityId": { "description": "The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.", "type": "string" }, "relatedUris": { "description": "Holds a list of references associated with this vulnerability item and assessment.", "type": "array", "items": { "$ref": "RelatedUrl" } }, "noteName": { "description": "The VulnerabilityAssessment note from which this VexAssessment was generated. This will be of the form: `projects/[PROJECT_ID]/notes/[NOTE_ID]`.", "type": "string" }, "state": { "description": "Provides the state of this Vulnerability assessment.", "type": "string", "enumDescriptions": [ "No state is specified.", "This product is known to be affected by this vulnerability.", "This product is known to be not affected by this vulnerability.", "This product contains a fix for this vulnerability.", "It is not known yet whether these versions are or are not affected by the vulnerability. However, it is still under investigation." ], "enum": [ "STATE_UNSPECIFIED", "AFFECTED", "NOT_AFFECTED", "FIXED", "UNDER_INVESTIGATION" ] }, "impacts": { "description": "Contains information about the impact of this vulnerability, this will change with time.", "type": "array", "items": { "type": "string" } }, "remediations": { "description": "Specifies details on how to handle (and presumably, fix) a vulnerability.", "type": "array", "items": { "$ref": "Remediation" } }, "justification": { "description": "Justification provides the justification when the state of the assessment if NOT_AFFECTED.", "$ref": "Justification" } } }, "Remediation": { "id": "Remediation", "description": "Specifies details on how to handle (and presumably, fix) a vulnerability.", "type": "object", "properties": { "remediationType": { "description": "The type of remediation that can be applied.", "type": "string", "enumDescriptions": [ "No remediation type specified.", "A MITIGATION is available.", "No fix is planned.", "Not available.", "A vendor fix is available.", "A workaround is available." ], "enum": [ "REMEDIATION_TYPE_UNSPECIFIED", "MITIGATION", "NO_FIX_PLANNED", "NONE_AVAILABLE", "VENDOR_FIX", "WORKAROUND" ] }, "details": { "description": "Contains a comprehensive human-readable discussion of the remediation.", "type": "string" }, "remediationUri": { "description": "Contains the URL where to obtain the remediation.", "$ref": "RelatedUrl" } } }, "Justification": { "id": "Justification", "description": "Justification provides the justification when the state of the assessment if NOT_AFFECTED.", "type": "object", "properties": { "justificationType": { "description": "The justification type for this vulnerability.", "type": "string", "enumDescriptions": [ "JUSTIFICATION_TYPE_UNSPECIFIED.", "The vulnerable component is not present in the product.", "The vulnerable code is not present. Typically this case occurs when source code is configured or built in a way that excludes the vulnerable code.", "The vulnerable code can not be executed. Typically this case occurs when the product includes the vulnerable code but does not call or use the vulnerable code.", "The vulnerable code cannot be controlled by an attacker to exploit the vulnerability.", "The product includes built-in protections or features that prevent exploitation of the vulnerability. These built-in protections cannot be subverted by the attacker and cannot be configured or disabled by the user. These mitigations completely prevent exploitation based on known attack vectors." ], "enum": [ "JUSTIFICATION_TYPE_UNSPECIFIED", "COMPONENT_NOT_PRESENT", "VULNERABLE_CODE_NOT_PRESENT", "VULNERABLE_CODE_NOT_IN_EXECUTE_PATH", "VULNERABLE_CODE_CANNOT_BE_CONTROLLED_BY_ADVERSARY", "INLINE_MITIGATIONS_ALREADY_EXIST" ] }, "details": { "description": "Additional details on why this justification was chosen.", "type": "string" } } }, "Risk": { "id": "Risk", "type": "object", "properties": { "cisaKev": { "description": "CISA maintains the authoritative source of vulnerabilities that have been exploited in the wild.", "$ref": "CISAKnownExploitedVulnerabilities" }, "epss": { "description": "The Exploit Prediction Scoring System (EPSS) estimates the likelihood (probability) that a software vulnerability will be exploited in the wild.", "$ref": "ExploitPredictionScoringSystem" } } }, "CISAKnownExploitedVulnerabilities": { "id": "CISAKnownExploitedVulnerabilities", "type": "object", "properties": { "knownRansomwareCampaignUse": { "description": "Whether the vulnerability is known to have been leveraged as part of a ransomware campaign.", "type": "string" } } }, "ExploitPredictionScoringSystem": { "id": "ExploitPredictionScoringSystem", "type": "object", "properties": { "percentile": { "description": "The percentile of the current score, the proportion of all scored vulnerabilities with the same or a lower EPSS score", "type": "number", "format": "double" }, "score": { "description": "The EPSS score representing the probability [0-1] of exploitation in the wild in the next 30 days", "type": "number", "format": "double" } } }, "BuildOccurrence": { "id": "BuildOccurrence", "description": "Details of a build occurrence.", "type": "object", "properties": { "provenance": { "description": "The actual provenance for the build.", "$ref": "BuildProvenance" }, "provenanceBytes": { "description": "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.", "type": "string" }, "intotoProvenance": { "description": "Deprecated. See InTotoStatement for the replacement. In-toto Provenance representation as defined in spec.", "$ref": "InTotoProvenance" }, "intotoStatement": { "description": "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.", "$ref": "InTotoStatement" }, "inTotoSlsaProvenanceV1": { "description": "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.", "$ref": "InTotoSlsaProvenanceV1" } } }, "BuildProvenance": { "id": "BuildProvenance", "description": "Provenance of a build. Contains all information needed to verify the full details about the build from source to completion.", "type": "object", "properties": { "id": { "description": "Required. Unique identifier of the build.", "type": "string" }, "projectId": { "description": "ID of the project.", "type": "string" }, "commands": { "description": "Commands requested by the build.", "type": "array", "items": { "$ref": "Command" } }, "builtArtifacts": { "description": "Output of the build.", "type": "array", "items": { "$ref": "Artifact" } }, "createTime": { "description": "Time at which the build was created.", "type": "string", "format": "google-datetime" }, "startTime": { "description": "Time at which execution of the build was started.", "type": "string", "format": "google-datetime" }, "endTime": { "description": "Time at which execution of the build was finished.", "type": "string", "format": "google-datetime" }, "creator": { "description": "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.", "type": "string" }, "logsUri": { "description": "URI where any logs for this provenance were written.", "type": "string" }, "sourceProvenance": { "description": "Details of the Source input to the build.", "$ref": "Source" }, "triggerId": { "description": "Trigger identifier if the build was triggered automatically; empty if not.", "type": "string" }, "buildOptions": { "description": "Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.", "type": "object", "additionalProperties": { "type": "string" } }, "builderVersion": { "description": "Version string of the builder at the time this build was executed.", "type": "string" } } }, "Command": { "id": "Command", "description": "Command describes a step performed as part of the build pipeline.", "type": "object", "properties": { "name": { "description": "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`.", "type": "string" }, "env": { "description": "Environment variables set before running this command.", "type": "array", "items": { "type": "string" } }, "args": { "description": "Command-line arguments used when executing this command.", "type": "array", "items": { "type": "string" } }, "dir": { "description": "Working directory (relative to project source root) used when running this command.", "type": "string" }, "id": { "description": "Optional unique identifier for this command, used in wait_for to reference this command as a dependency.", "type": "string" }, "waitFor": { "description": "The ID(s) of the command(s) that this command depends on.", "type": "array", "items": { "type": "string" } } } }, "Artifact": { "id": "Artifact", "description": "Artifact describes a build product.", "type": "object", "properties": { "checksum": { "description": "Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.", "type": "string" }, "id": { "description": "Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.", "type": "string" }, "names": { "description": "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.", "type": "array", "items": { "type": "string" } } } }, "Source": { "id": "Source", "description": "Source describes the location of the source used for the build.", "type": "object", "properties": { "artifactStorageSourceUri": { "description": "If provided, the input binary artifacts for the build came from this location.", "type": "string" }, "fileHashes": { "description": "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.", "type": "object", "additionalProperties": { "$ref": "FileHashes" } }, "context": { "description": "If provided, the source code used for the build came from this location.", "$ref": "SourceContext" }, "additionalContexts": { "description": "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.", "type": "array", "items": { "$ref": "SourceContext" } } } }, "FileHashes": { "id": "FileHashes", "description": "Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build.", "type": "object", "properties": { "fileHash": { "description": "Required. Collection of file hashes.", "type": "array", "items": { "$ref": "Hash" } } } }, "Hash": { "id": "Hash", "description": "Container message for hash values.", "type": "object", "properties": { "type": { "description": "Required. The type of hash that was performed, e.g. \"SHA-256\".", "type": "string" }, "value": { "description": "Required. The hash value.", "type": "string", "format": "byte" } } }, "SourceContext": { "id": "SourceContext", "description": "A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory.", "type": "object", "properties": { "cloudRepo": { "description": "A SourceContext referring to a revision in a Google Cloud Source Repo.", "$ref": "CloudRepoSourceContext" }, "gerrit": { "description": "A SourceContext referring to a Gerrit project.", "$ref": "GerritSourceContext" }, "git": { "description": "A SourceContext referring to any third party Git repo (e.g., GitHub).", "$ref": "GitSourceContext" }, "labels": { "description": "Labels with user defined metadata.", "type": "object", "additionalProperties": { "type": "string" } } } }, "CloudRepoSourceContext": { "id": "CloudRepoSourceContext", "description": "A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo.", "type": "object", "properties": { "repoId": { "description": "The ID of the repo.", "$ref": "RepoId" }, "revisionId": { "description": "A revision ID.", "type": "string" }, "aliasContext": { "description": "An alias, which may be a branch or tag.", "$ref": "AliasContext" } } }, "RepoId": { "id": "RepoId", "description": "A unique identifier for a Cloud Repo.", "type": "object", "properties": { "projectRepoId": { "description": "A combination of a project ID and a repo name.", "$ref": "ProjectRepoId" }, "uid": { "description": "A server-assigned, globally unique identifier.", "type": "string" } } }, "ProjectRepoId": { "id": "ProjectRepoId", "description": "Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project.", "type": "object", "properties": { "projectId": { "description": "The ID of the project.", "type": "string" }, "repoName": { "description": "The name of the repo. Leave empty for the default repo.", "type": "string" } } }, "AliasContext": { "id": "AliasContext", "description": "An alias to a repo revision.", "type": "object", "properties": { "kind": { "description": "The alias kind.", "type": "string", "enumDescriptions": [ "Unknown.", "Git tag.", "Git branch.", "Used to specify non-standard aliases. For example, if a Git repo has a ref named \"refs/foo/bar\"." ], "enum": [ "KIND_UNSPECIFIED", "FIXED", "MOVABLE", "OTHER" ] }, "name": { "description": "The alias name.", "type": "string" } } }, "GerritSourceContext": { "id": "GerritSourceContext", "description": "A SourceContext referring to a Gerrit project.", "type": "object", "properties": { "hostUri": { "description": "The URI of a running Gerrit instance.", "type": "string" }, "gerritProject": { "description": "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.", "type": "string" }, "revisionId": { "description": "A revision (commit) ID.", "type": "string" }, "aliasContext": { "description": "An alias, which may be a branch or tag.", "$ref": "AliasContext" } } }, "GitSourceContext": { "id": "GitSourceContext", "description": "A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub).", "type": "object", "properties": { "url": { "description": "Git repository URL.", "type": "string" }, "revisionId": { "description": "Git commit hash.", "type": "string" } } }, "InTotoProvenance": { "id": "InTotoProvenance", "type": "object", "properties": { "builderConfig": { "description": "required", "$ref": "BuilderConfig" }, "recipe": { "description": "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", "$ref": "Recipe" }, "metadata": { "$ref": "Metadata" }, "materials": { "description": "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.", "type": "array", "items": { "type": "string" } } } }, "BuilderConfig": { "id": "BuilderConfig", "type": "object", "properties": { "id": { "type": "string" } } }, "Recipe": { "id": "Recipe", "description": "Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe.", "type": "object", "properties": { "type": { "description": "URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.", "type": "string" }, "definedInMaterial": { "description": "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.", "type": "string", "format": "int64" }, "entryPoint": { "description": "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.", "type": "string" }, "arguments": { "description": "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\".", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "environment": { "description": "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\".", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } } }, "Metadata": { "id": "Metadata", "description": "Other properties of the build.", "type": "object", "properties": { "buildInvocationId": { "description": "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.", "type": "string" }, "buildStartedOn": { "description": "The timestamp of when the build started.", "type": "string", "format": "google-datetime" }, "buildFinishedOn": { "description": "The timestamp of when the build completed.", "type": "string", "format": "google-datetime" }, "completeness": { "description": "Indicates that the builder claims certain fields in this message to be complete.", "$ref": "Completeness" }, "reproducible": { "description": "If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.", "type": "boolean" } } }, "Completeness": { "id": "Completeness", "description": "Indicates that the builder claims certain fields in this message to be complete.", "type": "object", "properties": { "arguments": { "description": "If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.", "type": "boolean" }, "environment": { "description": "If true, the builder claims that recipe.environment is claimed to be complete.", "type": "boolean" }, "materials": { "description": "If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called \"hermetic\".", "type": "boolean" } } }, "InTotoStatement": { "id": "InTotoStatement", "description": "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": "object", "properties": { "_type": { "description": "Always `https://in-toto.io/Statement/v0.1`.", "type": "string" }, "subject": { "type": "array", "items": { "$ref": "Subject" } }, "predicateType": { "description": "`https://slsa.dev/provenance/v0.1` for SlsaProvenance.", "type": "string" }, "provenance": { "$ref": "InTotoProvenance" }, "slsaProvenance": { "$ref": "SlsaProvenance" }, "slsaProvenanceZeroTwo": { "$ref": "SlsaProvenanceZeroTwo" } } }, "Subject": { "id": "Subject", "type": "object", "properties": { "name": { "type": "string" }, "digest": { "description": "`\"\": \"\"` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet", "type": "object", "additionalProperties": { "type": "string" } } } }, "SlsaProvenance": { "id": "SlsaProvenance", "type": "object", "properties": { "builder": { "description": "required", "$ref": "SlsaBuilder" }, "recipe": { "description": "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", "$ref": "SlsaRecipe" }, "metadata": { "$ref": "SlsaMetadata" }, "materials": { "description": "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.", "type": "array", "items": { "$ref": "Material" } } } }, "SlsaBuilder": { "id": "SlsaBuilder", "type": "object", "properties": { "id": { "type": "string" } } }, "SlsaRecipe": { "id": "SlsaRecipe", "description": "Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe.", "type": "object", "properties": { "type": { "description": "URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.", "type": "string" }, "definedInMaterial": { "description": "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.", "type": "string", "format": "int64" }, "entryPoint": { "description": "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.", "type": "string" }, "arguments": { "description": "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.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "environment": { "description": "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.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "SlsaMetadata": { "id": "SlsaMetadata", "description": "Other properties of the build.", "type": "object", "properties": { "buildInvocationId": { "description": "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.", "type": "string" }, "buildStartedOn": { "description": "The timestamp of when the build started.", "type": "string", "format": "google-datetime" }, "buildFinishedOn": { "description": "The timestamp of when the build completed.", "type": "string", "format": "google-datetime" }, "completeness": { "description": "Indicates that the builder claims certain fields in this message to be complete.", "$ref": "SlsaCompleteness" }, "reproducible": { "description": "If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.", "type": "boolean" } } }, "SlsaCompleteness": { "id": "SlsaCompleteness", "description": "Indicates that the builder claims certain fields in this message to be complete.", "type": "object", "properties": { "arguments": { "description": "If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.", "type": "boolean" }, "environment": { "description": "If true, the builder claims that recipe.environment is claimed to be complete.", "type": "boolean" }, "materials": { "description": "If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called \"hermetic\".", "type": "boolean" } } }, "Material": { "id": "Material", "type": "object", "properties": { "uri": { "type": "string" }, "digest": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SlsaProvenanceZeroTwo": { "id": "SlsaProvenanceZeroTwo", "description": "See full explanation of fields at slsa.dev/provenance/v0.2.", "type": "object", "properties": { "builder": { "$ref": "GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder" }, "buildType": { "type": "string" }, "invocation": { "$ref": "GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation" }, "buildConfig": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "metadata": { "$ref": "GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata" }, "materials": { "type": "array", "items": { "$ref": "GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial" } } } }, "GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder": { "id": "GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder", "description": "Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance.", "type": "object", "properties": { "id": { "type": "string" } } }, "GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation": { "id": "GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation", "description": "Identifies the event that kicked off the build.", "type": "object", "properties": { "configSource": { "$ref": "GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource" }, "parameters": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "environment": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource": { "id": "GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource", "description": "Describes where the config file that kicked off the build came from. This is effectively a pointer to the source where buildConfig came from.", "type": "object", "properties": { "uri": { "type": "string" }, "digest": { "type": "object", "additionalProperties": { "type": "string" } }, "entryPoint": { "type": "string" } } }, "GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata": { "id": "GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata", "description": "Other properties of the build.", "type": "object", "properties": { "buildInvocationId": { "type": "string" }, "buildStartedOn": { "type": "string", "format": "google-datetime" }, "buildFinishedOn": { "type": "string", "format": "google-datetime" }, "completeness": { "$ref": "GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness" }, "reproducible": { "type": "boolean" } } }, "GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness": { "id": "GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness", "description": "Indicates that the builder claims certain fields in this message to be complete.", "type": "object", "properties": { "parameters": { "type": "boolean" }, "environment": { "type": "boolean" }, "materials": { "type": "boolean" } } }, "GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial": { "id": "GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial", "description": "The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on.", "type": "object", "properties": { "uri": { "type": "string" }, "digest": { "type": "object", "additionalProperties": { "type": "string" } } } }, "InTotoSlsaProvenanceV1": { "id": "InTotoSlsaProvenanceV1", "type": "object", "properties": { "_type": { "description": "InToto spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement", "type": "string" }, "subject": { "type": "array", "items": { "$ref": "Subject" } }, "predicateType": { "type": "string" }, "predicate": { "$ref": "SlsaProvenanceV1" } } }, "SlsaProvenanceV1": { "id": "SlsaProvenanceV1", "description": "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.", "type": "object", "properties": { "buildDefinition": { "$ref": "BuildDefinition" }, "runDetails": { "$ref": "RunDetails" } } }, "BuildDefinition": { "id": "BuildDefinition", "type": "object", "properties": { "buildType": { "type": "string" }, "externalParameters": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "internalParameters": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "resolvedDependencies": { "type": "array", "items": { "$ref": "ResourceDescriptor" } } } }, "ResourceDescriptor": { "id": "ResourceDescriptor", "type": "object", "properties": { "name": { "type": "string" }, "uri": { "type": "string" }, "digest": { "type": "object", "additionalProperties": { "type": "string" } }, "content": { "type": "string", "format": "byte" }, "downloadLocation": { "type": "string" }, "mediaType": { "type": "string" }, "annotations": { "type": "object", "additionalProperties": { "type": "any" } } } }, "RunDetails": { "id": "RunDetails", "type": "object", "properties": { "builder": { "$ref": "ProvenanceBuilder" }, "metadata": { "$ref": "BuildMetadata" }, "byproducts": { "type": "array", "items": { "$ref": "ResourceDescriptor" } } } }, "ProvenanceBuilder": { "id": "ProvenanceBuilder", "type": "object", "properties": { "id": { "type": "string" }, "version": { "type": "object", "additionalProperties": { "type": "string" } }, "builderDependencies": { "type": "array", "items": { "$ref": "ResourceDescriptor" } } } }, "BuildMetadata": { "id": "BuildMetadata", "type": "object", "properties": { "invocationId": { "type": "string" }, "startedOn": { "type": "string", "format": "google-datetime" }, "finishedOn": { "type": "string", "format": "google-datetime" } } }, "ImageOccurrence": { "id": "ImageOccurrence", "description": "Details of the derived image portion of the DockerImage relationship. This image would be produced from a Dockerfile with FROM .", "type": "object", "properties": { "fingerprint": { "description": "Required. The fingerprint of the derived image.", "$ref": "Fingerprint" }, "distance": { "description": "Output only. The number of layers by which this image differs from the associated image basis.", "type": "integer", "format": "int32" }, "layerInfo": { "description": "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.", "type": "array", "items": { "$ref": "Layer" } }, "baseResourceUrl": { "description": "Output only. This contains the base image URL for the derived image occurrence.", "type": "string" } } }, "Fingerprint": { "id": "Fingerprint", "description": "A set of properties that uniquely identify a given Docker image.", "type": "object", "properties": { "v1Name": { "description": "Required. The layer ID of the final layer in the Docker image's v1 representation.", "type": "string" }, "v2Blob": { "description": "Required. The ordered list of v2 blobs that represent a given image.", "type": "array", "items": { "type": "string" } }, "v2Name": { "description": "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.", "type": "string" } } }, "Layer": { "id": "Layer", "description": "Layer holds metadata specific to a layer of a Docker image.", "type": "object", "properties": { "directive": { "description": "Required. The recovered Dockerfile directive used to construct this layer. See https://docs.docker.com/engine/reference/builder/ for more information.", "type": "string" }, "arguments": { "description": "The recovered arguments to the Dockerfile directive.", "type": "string" } } }, "PackageOccurrence": { "id": "PackageOccurrence", "description": "Details on how a particular software package was installed on a system.", "type": "object", "properties": { "name": { "description": "Required. Output only. The name of the installed package.", "readOnly": true, "type": "string" }, "location": { "description": "All of the places within the filesystem versions of this package have been found.", "type": "array", "items": { "$ref": "Location" } }, "packageType": { "description": "Output only. The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).", "readOnly": true, "type": "string" }, "cpeUri": { "description": "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.", "readOnly": true, "type": "string" }, "architecture": { "description": "Output only. The CPU architecture for which packages in this distribution channel were built. Architecture will be blank for language packages.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unknown architecture.", "X86 architecture.", "X64 architecture." ], "enum": [ "ARCHITECTURE_UNSPECIFIED", "X86", "X64" ] }, "license": { "description": "Licenses that have been declared by the authors of the package.", "$ref": "License" }, "version": { "description": "Output only. The version of the package.", "readOnly": true, "$ref": "Version" } } }, "Location": { "id": "Location", "description": "An occurrence of a particular package installation found within a system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.", "type": "object", "properties": { "cpeUri": { "description": "Deprecated. The CPE URI in [CPE format](https://cpe.mitre.org/specification/)", "type": "string" }, "version": { "description": "Deprecated. The version installed at this location.", "$ref": "Version" }, "path": { "description": "The path from which we gathered that this package/version is installed.", "type": "string" } } }, "License": { "id": "License", "description": "License information.", "type": "object", "properties": { "expression": { "description": "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\".", "type": "string" }, "comments": { "description": "Comments", "type": "string" } } }, "DeploymentOccurrence": { "id": "DeploymentOccurrence", "description": "The period during which some deployable was active in a runtime.", "type": "object", "properties": { "userEmail": { "description": "Identity of the user that triggered this deployment.", "type": "string" }, "deployTime": { "description": "Required. Beginning of the lifetime of this deployment.", "type": "string", "format": "google-datetime" }, "undeployTime": { "description": "End of the lifetime of this deployment.", "type": "string", "format": "google-datetime" }, "config": { "description": "Configuration used to create this deployment.", "type": "string" }, "address": { "description": "Address of the runtime element hosting this deployment.", "type": "string" }, "resourceUri": { "description": "Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.", "type": "array", "items": { "type": "string" } }, "platform": { "description": "Platform hosting this deployment.", "type": "string", "enumDescriptions": [ "Unknown.", "Google Container Engine.", "Google App Engine: Flexible Environment.", "Custom user-defined platform." ], "enum": [ "PLATFORM_UNSPECIFIED", "GKE", "FLEX", "CUSTOM" ] } } }, "DiscoveryOccurrence": { "id": "DiscoveryOccurrence", "description": "Provides information about the analysis status of a discovered resource.", "type": "object", "properties": { "continuousAnalysis": { "description": "Whether the resource is continuously analyzed.", "type": "string", "enumDescriptions": [ "Unknown.", "The resource is continuously analyzed.", "The resource is ignored for continuous analysis." ], "enum": [ "CONTINUOUS_ANALYSIS_UNSPECIFIED", "ACTIVE", "INACTIVE" ] }, "analysisStatus": { "description": "The status of discovery for the resource.", "type": "string", "enumDescriptions": [ "Unknown.", "Resource is known but no action has been taken yet.", "Resource is being analyzed.", "Analysis has finished successfully.", "Analysis has completed.", "Analysis has finished unsuccessfully, the analysis itself is in a bad state.", "The resource is known not to be supported." ], "enum": [ "ANALYSIS_STATUS_UNSPECIFIED", "PENDING", "SCANNING", "FINISHED_SUCCESS", "COMPLETE", "FINISHED_FAILED", "FINISHED_UNSUPPORTED" ] }, "analysisCompleted": { "$ref": "AnalysisCompleted" }, "analysisError": { "description": "Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors.", "type": "array", "items": { "$ref": "Status" } }, "analysisStatusError": { "description": "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.", "$ref": "Status" }, "cpe": { "description": "The CPE of the resource being scanned.", "type": "string" }, "lastScanTime": { "description": "The last time this resource was scanned.", "type": "string", "format": "google-datetime" }, "archiveTime": { "description": "Output only. The time occurrences related to this discovery occurrence were archived.", "readOnly": true, "type": "string", "format": "google-datetime" }, "sbomStatus": { "description": "The status of an SBOM generation.", "$ref": "SBOMStatus" }, "files": { "description": "Files that make up the resource described by the occurrence.", "type": "array", "items": { "$ref": "File" } }, "lastVulnerabilityUpdateTime": { "description": "The last time vulnerability scan results changed.", "type": "string", "format": "google-datetime" } } }, "AnalysisCompleted": { "id": "AnalysisCompleted", "description": "Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource.", "type": "object", "properties": { "analysisType": { "type": "array", "items": { "type": "string" } } } }, "SBOMStatus": { "id": "SBOMStatus", "description": "The status of an SBOM generation.", "type": "object", "properties": { "sbomState": { "description": "The progress of the SBOM generation.", "type": "string", "enumDescriptions": [ "Default unknown state.", "SBOM scanning is pending.", "SBOM scanning has completed." ], "enum": [ "SBOM_STATE_UNSPECIFIED", "PENDING", "COMPLETE" ] }, "error": { "description": "If there was an error generating an SBOM, this will indicate what that error was.", "type": "string" } } }, "File": { "id": "File", "type": "object", "properties": { "name": { "type": "string" }, "digest": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AttestationOccurrence": { "id": "AttestationOccurrence", "description": "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.", "type": "object", "properties": { "serializedPayload": { "description": "Required. The serialized payload that is verified by one or more `signatures`.", "type": "string", "format": "byte" }, "signatures": { "description": "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.", "type": "array", "items": { "$ref": "Signature" } }, "jwts": { "description": "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.", "type": "array", "items": { "$ref": "Jwt" } } } }, "Signature": { "id": "Signature", "description": "Verifiers (e.g. Kritis implementations) MUST verify signatures with respect to the trust anchors defined in policy (e.g. a Kritis policy). Typically this means that the verifier has been configured with a map from `public_key_id` to public key material (and any required parameters, e.g. signing algorithm). In particular, verification implementations MUST NOT treat the signature `public_key_id` as anything more than a key lookup hint. The `public_key_id` DOES NOT validate or authenticate a public key; it only provides a mechanism for quickly selecting a public key ALREADY CONFIGURED on the verifier through a trusted channel. Verification implementations MUST reject signatures in any of the following circumstances: * The `public_key_id` is not recognized by the verifier. * The public key that `public_key_id` refers to does not verify the signature with respect to the payload. The `signature` contents SHOULD NOT be \"attached\" (where the payload is included with the serialized `signature` bytes). Verifiers MUST ignore any \"attached\" payload and only verify signatures with respect to explicitly provided payload (e.g. a `payload` field on the proto message that holds this Signature, or the canonical serialization of the proto message that holds this signature).", "type": "object", "properties": { "signature": { "description": "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.", "type": "string", "format": "byte" }, "publicKeyId": { "description": "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\"", "type": "string" } } }, "Jwt": { "id": "Jwt", "type": "object", "properties": { "compactJwt": { "description": "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", "type": "string" } } }, "UpgradeOccurrence": { "id": "UpgradeOccurrence", "description": "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.", "type": "object", "properties": { "package": { "description": "Required for non-Windows OS. The package this Upgrade is for.", "type": "string" }, "parsedVersion": { "description": "Required for non-Windows OS. The version of the package in a machine + human readable form.", "$ref": "Version" }, "distribution": { "description": "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.", "$ref": "UpgradeDistribution" }, "windowsUpdate": { "description": "Required for Windows OS. Represents the metadata about the Windows update.", "$ref": "WindowsUpdate" } } }, "UpgradeDistribution": { "id": "UpgradeDistribution", "description": "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.", "type": "object", "properties": { "cpeUri": { "description": "Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.", "type": "string" }, "classification": { "description": "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)", "type": "string" }, "severity": { "description": "The severity as specified by the upstream operating system.", "type": "string" }, "cve": { "description": "The cve tied to this Upgrade.", "type": "array", "items": { "type": "string" } } } }, "WindowsUpdate": { "id": "WindowsUpdate", "description": "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.", "type": "object", "properties": { "identity": { "description": "Required - The unique identifier for the update.", "$ref": "Identity" }, "title": { "description": "The localized title of the update.", "type": "string" }, "description": { "description": "The localized description of the update.", "type": "string" }, "categories": { "description": "The list of categories to which the update belongs.", "type": "array", "items": { "$ref": "Category" } }, "kbArticleIds": { "description": "The Microsoft Knowledge Base article IDs that are associated with the update.", "type": "array", "items": { "type": "string" } }, "supportUrl": { "description": "The hyperlink to the support information for the update.", "type": "string" }, "lastPublishedTimestamp": { "description": "The last published timestamp of the update.", "type": "string", "format": "google-datetime" } } }, "Identity": { "id": "Identity", "description": "The unique identifier of the update.", "type": "object", "properties": { "updateId": { "description": "The revision independent identifier of the update.", "type": "string" }, "revision": { "description": "The revision number of the update.", "type": "integer", "format": "int32" } } }, "Category": { "id": "Category", "description": "The category to which the update belongs.", "type": "object", "properties": { "categoryId": { "description": "The identifier of the category.", "type": "string" }, "name": { "description": "The localized name of the category.", "type": "string" } } }, "ComplianceOccurrence": { "id": "ComplianceOccurrence", "description": "An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason.", "type": "object", "properties": { "nonCompliantFiles": { "type": "array", "items": { "$ref": "NonCompliantFile" } }, "nonComplianceReason": { "type": "string" }, "version": { "description": "The OS and config version the benchmark was run on.", "$ref": "ComplianceVersion" } } }, "NonCompliantFile": { "id": "NonCompliantFile", "description": "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'.", "type": "object", "properties": { "path": { "description": "Empty if `display_command` is set.", "type": "string" }, "displayCommand": { "description": "Command to display the non-compliant files.", "type": "string" }, "reason": { "description": "Explains why a file is non compliant for a CIS check.", "type": "string" } } }, "ComplianceVersion": { "id": "ComplianceVersion", "description": "Describes the CIS benchmark version that is applicable to a given OS and os version.", "type": "object", "properties": { "cpeUri": { "description": "The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.", "type": "string" }, "benchmarkDocument": { "description": "The name of the document that defines this benchmark, e.g. \"CIS Container-Optimized OS\".", "type": "string" }, "version": { "description": "The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.", "type": "string" } } }, "DSSEAttestationOccurrence": { "id": "DSSEAttestationOccurrence", "description": "Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence.", "type": "object", "properties": { "envelope": { "description": "If doing something security critical, make sure to verify the signatures in this metadata.", "$ref": "Envelope" }, "statement": { "$ref": "InTotoStatement" } } }, "Envelope": { "id": "Envelope", "description": "MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type.", "type": "object", "properties": { "payload": { "type": "string", "format": "byte" }, "payloadType": { "type": "string" }, "signatures": { "type": "array", "items": { "$ref": "EnvelopeSignature" } } } }, "EnvelopeSignature": { "id": "EnvelopeSignature", "type": "object", "properties": { "sig": { "type": "string", "format": "byte" }, "keyid": { "type": "string" } } }, "SBOMReferenceOccurrence": { "id": "SBOMReferenceOccurrence", "description": "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.", "type": "object", "properties": { "payload": { "description": "The actual payload that contains the SBOM reference data.", "$ref": "SbomReferenceIntotoPayload" }, "payloadType": { "description": "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'.", "type": "string" }, "signatures": { "description": "The signatures over the payload.", "type": "array", "items": { "$ref": "EnvelopeSignature" } } } }, "SbomReferenceIntotoPayload": { "id": "SbomReferenceIntotoPayload", "description": "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.", "type": "object", "properties": { "_type": { "description": "Identifier for the schema of the Statement.", "type": "string" }, "predicateType": { "description": "URI identifying the type of the Predicate.", "type": "string" }, "subject": { "description": "Set of software artifacts that the attestation applies to. Each element represents a single software artifact.", "type": "array", "items": { "$ref": "Subject" } }, "predicate": { "description": "Additional parameters of the Predicate. Includes the actual data about the SBOM.", "$ref": "SbomReferenceIntotoPredicate" } } }, "SbomReferenceIntotoPredicate": { "id": "SbomReferenceIntotoPredicate", "description": "A predicate which describes the SBOM being referenced.", "type": "object", "properties": { "referrerId": { "description": "The person or system referring this predicate to the consumer.", "type": "string" }, "location": { "description": "The location of the SBOM.", "type": "string" }, "mimeType": { "description": "The mime type of the SBOM.", "type": "string" }, "digest": { "description": "A map of algorithm to digest of the contents of the SBOM.", "type": "object", "additionalProperties": { "type": "string" } } } }, "SecretOccurrence": { "id": "SecretOccurrence", "description": "The occurrence provides details of a secret.", "type": "object", "properties": { "kind": { "description": "Required. Type of secret.", "type": "string", "enumDescriptions": [ "Unspecified", "The secret kind is unknown.", "A Google Cloud service account key per: https://cloud.google.com/iam/docs/creating-managing-service-account-keys", "A Google Cloud API key per: https://cloud.google.com/docs/authentication/api-keys", "A Google Cloud OAuth2 client credentials per: https://developers.google.com/identity/protocols/oauth2", "A Google Cloud OAuth2 access token per: https://cloud.google.com/docs/authentication/token-types#access", "An Anthropic Admin API key.", "An Anthropic API key.", "An Azure access token.", "An Azure Identity Platform ID token.", "A Docker Hub personal access token.", "A GitHub App refresh token.", "A GitHub App server-to-server token.", "A GitHub App user-to-server token.", "A GitHub personal access token (classic).", "A GitHub fine-grained personal access token.", "A GitHub OAuth token.", "A Hugging Face API key.", "An OpenAI API key.", "A Perplexity API key.", "A Stripe secret key.", "A Stripe restricted key.", "A Stripe webhook secret." ], "enum": [ "SECRET_KIND_UNSPECIFIED", "SECRET_KIND_UNKNOWN", "SECRET_KIND_GCP_SERVICE_ACCOUNT_KEY", "SECRET_KIND_GCP_API_KEY", "SECRET_KIND_GCP_OAUTH2_CLIENT_CREDENTIALS", "SECRET_KIND_GCP_OAUTH2_ACCESS_TOKEN", "SECRET_KIND_ANTHROPIC_ADMIN_API_KEY", "SECRET_KIND_ANTHROPIC_API_KEY", "SECRET_KIND_AZURE_ACCESS_TOKEN", "SECRET_KIND_AZURE_IDENTITY_TOKEN", "SECRET_KIND_DOCKER_HUB_PERSONAL_ACCESS_TOKEN", "SECRET_KIND_GITHUB_APP_REFRESH_TOKEN", "SECRET_KIND_GITHUB_APP_SERVER_TO_SERVER_TOKEN", "SECRET_KIND_GITHUB_APP_USER_TO_SERVER_TOKEN", "SECRET_KIND_GITHUB_CLASSIC_PERSONAL_ACCESS_TOKEN", "SECRET_KIND_GITHUB_FINE_GRAINED_PERSONAL_ACCESS_TOKEN", "SECRET_KIND_GITHUB_OAUTH_TOKEN", "SECRET_KIND_HUGGINGFACE_API_KEY", "SECRET_KIND_OPENAI_API_KEY", "SECRET_KIND_PERPLEXITY_API_KEY", "SECRET_KIND_STRIPE_SECRET_KEY", "SECRET_KIND_STRIPE_RESTRICTED_KEY", "SECRET_KIND_STRIPE_WEBHOOK_SECRET" ] }, "locations": { "description": "Optional. Locations where the secret is detected.", "type": "array", "items": { "$ref": "SecretLocation" } }, "statuses": { "description": "Optional. Status of the secret.", "type": "array", "items": { "$ref": "SecretStatus" } } } }, "SecretLocation": { "id": "SecretLocation", "description": "The location of the secret.", "type": "object", "properties": { "fileLocation": { "description": "The secret is found from a file.", "$ref": "GrafeasV1FileLocation" } } }, "SecretStatus": { "id": "SecretStatus", "description": "The status of the secret with a timestamp.", "type": "object", "properties": { "status": { "description": "Optional. The status of the secret.", "type": "string", "enumDescriptions": [ "Unspecified", "The status of the secret is unknown.", "The secret is valid.", "The secret is invalid." ], "enum": [ "STATUS_UNSPECIFIED", "UNKNOWN", "VALID", "INVALID" ] }, "updateTime": { "description": "Optional. The time the secret status was last updated.", "type": "string", "format": "google-datetime" }, "message": { "description": "Optional. Optional message about the status code.", "type": "string" } } }, "AISkillAnalysisOccurrence": { "id": "AISkillAnalysisOccurrence", "description": "AISkillAnalysisOccurrence provides the results of an AI-based skill analysis.", "type": "object", "properties": { "skillName": { "description": "Name of the skill that produced this analysis.", "type": "string" }, "findings": { "description": "Findings produced by the analysis.", "type": "array", "items": { "$ref": "Finding" } }, "maxSeverity": { "description": "Maximum severity found among findings.", "type": "string" } } }, "Finding": { "id": "Finding", "description": "Finding provides details for a single finding within an AISkillAnalysisOccurrence.", "type": "object", "properties": { "category": { "description": "Category of the finding.", "type": "string" }, "severity": { "description": "Severity of the finding.", "type": "string" }, "location": { "description": "Location (path and line) where the finding was detected.", "$ref": "FindingLocation" }, "scanner": { "description": "Scanner determines which engine (e.g. static, llm) emitted the finding.", "type": "string" } } }, "FindingLocation": { "id": "FindingLocation", "description": "Location details with file path and line number.", "type": "object", "properties": { "filePath": { "description": "Relative path of the file containing the finding.", "type": "string" }, "lineNumber": { "description": "Line number (1-based), or 0 if whole File / unknown.", "type": "string", "format": "int64" } } }, "AnalyzePackagesMetadataV1": { "id": "AnalyzePackagesMetadataV1", "description": "AnalyzePackagesMetadata contains metadata for an active scan of a container image.", "type": "object", "properties": { "resourceUri": { "description": "The resource URI of the container image being scanned.", "type": "string" }, "createTime": { "description": "When the scan was created.", "type": "string", "format": "google-datetime" } } }, "AnalyzePackagesResponseV1": { "id": "AnalyzePackagesResponseV1", "description": "AnalyzePackagesResponse contains the information necessary to find results for the given scan.", "type": "object", "properties": { "scan": { "description": "The name of the scan resource created by this successful scan.", "type": "string" } } }, "AnalyzePackagesMetadata": { "id": "AnalyzePackagesMetadata", "description": "AnalyzePackagesMetadata contains metadata for an active scan of a container image.", "type": "object", "properties": { "resourceUri": { "description": "The resource URI of the container image being scanned.", "type": "string" }, "createTime": { "description": "When the scan was created.", "type": "string", "format": "google-datetime" } } }, "AnalyzePackagesResponse": { "id": "AnalyzePackagesResponse", "description": "AnalyzePackagesResponse contains the information necessary to find results for the given scan.", "type": "object", "properties": { "scan": { "description": "The name of the scan resource created by this successful scan.", "type": "string" } } } }, "ownerDomain": "google.com", "batchPath": "batch", "documentationLink": "https://cloud.google.com/container-analysis/docs/on-demand-scanning/", "description": "A service to scan container images for vulnerabilities.", "version_module": true, "revision": "20260511", "resources": { "projects": { "resources": { "locations": { "resources": { "operations": { "methods": { "list": { "id": "ondemandscanning.projects.locations.operations.list", "path": "v1beta1/{+name}/operations", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "ondemandscanning.projects.locations.operations.get", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "delete": { "id": "ondemandscanning.projects.locations.operations.delete", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." }, "cancel": { "id": "ondemandscanning.projects.locations.operations.cancel", "path": "v1beta1/{+name}:cancel", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." }, "wait": { "id": "ondemandscanning.projects.locations.operations.wait", "path": "v1beta1/{+name}:wait", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait", "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to wait on.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" }, "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "type": "string", "format": "google-duration" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done." } } }, "scans": { "methods": { "analyzePackages": { "id": "ondemandscanning.projects.locations.scans.analyzePackages", "path": "v1beta1/{+parent}/scans:analyzePackages", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/scans:analyzePackages", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent of the resource for which analysis is requested. Format: projects/[project_name]/locations/[location]", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "AnalyzePackagesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Initiates an analysis of the provided packages." } }, "resources": { "vulnerabilities": { "methods": { "list": { "id": "ondemandscanning.projects.locations.scans.vulnerabilities.list", "path": "v1beta1/{+parent}/vulnerabilities", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/scans/{scansId}/vulnerabilities", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent of the collection of Vulnerabilities being requested. Format: projects/[project_name]/locations/[location]/scans/[scan_id]", "pattern": "^projects/[^/]+/locations/[^/]+/scans/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "The number of vulnerabilities to retrieve.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The page token, resulting from a previous call to ListVulnerabilities.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListVulnerabilitiesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists vulnerabilities resulting from a successfully completed scan." } } } } } } } } } }, "protocol": "rest" }