Blame - docs/dyn/containeranalysis_v1beta1.projects.occurrences.html - platform/external/python/google-api-python-client

2020-05-01 07:42:23 -0700

[diff] [blame]

78

<code><a href="#batchCreate">batchCreate(parent, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

79

<p class="firstline">Creates new occurrences in batch.</p>

80

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

81

<code><a href="#close">close()</a></code></p>

82

<p class="firstline">Close httplib2 connections.</p>

83

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

84

<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

85

<p class="firstline">Creates a new occurrence.</p>

86

87

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

88

<p class="firstline">Deletes the specified occurrence. For example, use this method to delete an occurrence when the occurrence is no longer applicable for the given resource.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

89

90

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

91

<p class="firstline">Gets the specified occurrence.</p>

92

93

<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

94

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

95

96

<code><a href="#getNotes">getNotes(name, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

97

<p class="firstline">Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

98

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

99

<code><a href="#getVulnerabilitySummary">getVulnerabilitySummary(parent, filter=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

100

<p class="firstline">Gets a summary of the number and severity of occurrences.</p>

101

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

102

<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

103

<p class="firstline">Lists occurrences for the specified project.</p>

104

105

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

106

<p class="firstline">Retrieves the next page of results.</p>

107

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

108

<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

109

<p class="firstline">Updates the specified occurrence.</p>

110

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

111

<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

112

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

113

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

114

<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

115

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

116

<h3>Method Details</h3>

117

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

118

<code class="details" id="batchCreate">batchCreate(parent, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

119

<pre>Creates new occurrences in batch.

120

121

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

122

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

123

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

124

The object takes the form of:

125

126

{ # Request to create occurrences in batch.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

127

"occurrences": [ # Required. The occurrences to create. Max allowed length is 1000.

128

{ # An instance of an analysis type that has been found on a resource.

129

"attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.

130

"attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for look-up (how to find this attestation if you already know the authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). # Required. Attestation for the resource.

131

"genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.

132

"contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema).

133

"serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.

134

"signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.

135

{ # 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).

136

"publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"

137

"signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.

138

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

139

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

140

},

141

"pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file. # A PGP signed attestation.

142

"contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema).

143

"pgpKeyId": "A String", # The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexidecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.

144

"signature": "A String", # Required. The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

145

},

146

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

147

},

148

"build": { # Details of a build occurrence. # Describes a verifiable build.

149

"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # Required. The actual provenance for the build.

150

"buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.

151

"a_key": "A String",

152

},

153

"builderVersion": "A String", # Version string of the builder at the time this build was executed.

154

"builtArtifacts": [ # Output of the build.

155

{ # Artifact describes a build product.

156

"checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.

157

"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.

158

"names": [ # Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image.

159

"A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

160

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

161

},

162

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

163

"commands": [ # Commands requested by the build.

164

{ # Command describes a step performed as part of the build pipeline.

165

"args": [ # Command-line arguments used when executing this command.

166

"A String",

167

],

168

"dir": "A String", # Working directory (relative to project source root) used when running this command.

169

"env": [ # Environment variables set before running this command.

170

"A String",

171

],

172

"id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.

173

"name": "A String", # Required. Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`.

174

"waitFor": [ # The ID(s) of the command(s) that this command depends on.

175

"A String",

176

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

177

},

178

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

179

"createTime": "A String", # Time at which the build was created.

180

"creator": "A String", # E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time.

181

"endTime": "A String", # Time at which execution of the build was finished.

182

"id": "A String", # Required. Unique identifier of the build.

183

"logsUri": "A String", # URI where any logs for this provenance were written.

184

"projectId": "A String", # ID of the project.

185

"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.

186

"additionalContexts": [ # If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field.

187

{ # 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.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

188

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

189

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

190

"kind": "A String", # The alias kind.

191

"name": "A String", # The alias name.

192

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

193

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

194

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

195

"projectId": "A String", # The ID of the project.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

196

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

197

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

198

"uid": "A String", # A server-assigned, globally unique identifier.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

199

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

200

"revisionId": "A String", # A revision ID.

201

},

202

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

203

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

204

"kind": "A String", # The alias kind.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

205

"name": "A String", # The alias name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

206

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

207

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

208

"hostUri": "A String", # The URI of a running Gerrit instance.

209

"revisionId": "A String", # A revision (commit) ID.

210

},

211

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

212

"revisionId": "A String", # Git commit hash.

213

"url": "A String", # Git repository URL.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

214

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

215

"labels": { # Labels with user defined metadata.

216

"a_key": "A String",

217

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

218

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

219

],

220

"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.

221

"context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # If provided, the source code used for the build came from this location.

222

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

223

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

224

"kind": "A String", # The alias kind.

225

"name": "A String", # The alias name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

226

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

227

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

228

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

229

"projectId": "A String", # The ID of the project.

230

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

231

},

232

"uid": "A String", # A server-assigned, globally unique identifier.

233

},

234

"revisionId": "A String", # A revision ID.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

235

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

236

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

237

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

238

"kind": "A String", # The alias kind.

239

"name": "A String", # The alias name.

240

},

241

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

242

"hostUri": "A String", # The URI of a running Gerrit instance.

243

"revisionId": "A String", # A revision (commit) ID.

244

},

245

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

246

"revisionId": "A String", # Git commit hash.

247

"url": "A String", # Git repository URL.

248

},

249

"labels": { # Labels with user defined metadata.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

250

"a_key": "A String",

251

},

252

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

253

"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file.

254

"a_key": { # Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build.

255

"fileHash": [ # Required. Collection of file hashes.

256

{ # Container message for hash values.

257

"type": "A String", # Required. The type of hash that was performed.

258

"value": "A String", # Required. The hash value.

},

],

},

},

},

"startTime": "A String", # Time at which execution of the build was started.

265

"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.

266

},

267

"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes.

268

},

269

"createTime": "A String", # Output only. The time this occurrence was created.

270

"deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.

271

"deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.

272

"address": "A String", # Address of the runtime element hosting this deployment.

273

"config": "A String", # Configuration used to create this deployment.

274

"deployTime": "A String", # Required. Beginning of the lifetime of this deployment.

275

"platform": "A String", # Platform hosting this deployment.

276

"resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.

277

"A String",

278

],

279

"undeployTime": "A String", # End of the lifetime of this deployment.

280

"userEmail": "A String", # Identity of the user that triggered this deployment.

281

},

282

},

283

"derivedImage": { # Details of an image occurrence. # Describes how this resource derives from the basis in the associated note.

284

"derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Required. Immutable. The child image derived from the base image.

285

"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.

286

"distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.

287

"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.

288

"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.

289

"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

290

"A String",

291

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

292

"v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

293

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

294

"layerInfo": [ # This contains layer-specific metadata, if populated it has length "distance" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer.

295

{ # Layer holds metadata specific to a layer of a Docker image.

296

"arguments": "A String", # The recovered arguments to the Dockerfile directive.

297

"directive": "A String", # Required. The recovered Dockerfile directive used to construct this layer.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

298

},

299

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

300

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

301

},

302

"discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered.

303

"discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource.

304

"analysisStatus": "A String", # The status of discovery for the resource.

305

"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API.

306

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

307

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

308

{

309

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

310

},

311

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

312

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

313

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

314

"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.

315

"lastAnalysisTime": "A String", # The last time continuous analysis was done for this resource. Deprecated, do not use.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

316

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

317

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

318

"installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.

319

"installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.

320

"location": [ # Required. All of the places within the filesystem versions of this package have been found.

321

{ # An occurrence of a particular package installation found within a system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.

322

"cpeUri": "A String", # Required. The CPE URI in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.

323

"path": "A String", # The path from which we gathered that this package/version is installed.

324

"version": { # Version contains structured information about the version of a package. # The version installed at this location.

325

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

326

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

327

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

328

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

329

"revision": "A String", # The iteration of the package build from the above version.

},

},

],

"name": "A String", # Output only. The name of the installed package.

334

},

335

},

336

"intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.

337

"signatures": [

338

{ # A signature object consists of the KeyID used and the signature itself.

"keyid": "A String",

"sig": "A String",

},

],

"signed": { # This corresponds to an in-toto link.

344

"byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.

"customValues": {

"a_key": "A String",

},

},

"command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]

350

"A String",

351

],

352

"environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }

"customValues": {

"a_key": "A String",

},

},

"materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]

358

{

359

"hashes": { # Defines a hash object for use in Materials and Products.

360

"sha256": "A String",

361

},

362

"resourceUri": "A String",

363

},

364

],

365

"products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.

366

{

367

"hashes": { # Defines a hash object for use in Materials and Products.

368

"sha256": "A String",

369

},

370

"resourceUri": "A String",

},

],

},

},

"kind": "A String", # Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests.

376

"name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.

377

"noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.

378

"remediation": "A String", # A description of actions that can be taken to remedy the note.

379

"resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.

380

"contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.

381

"type": "A String", # Required. The type of hash that was performed.

382

"value": "A String", # Required. The hash value.

383

},

384

"name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".

385

"uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.

386

},

yoshi-code-bot

2021-08-03 00:20:27 -0700

[diff] [blame^]

387

"sbom": { # DocumentOccurrence represents an SPDX Document Creation Information section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # Describes a specific SPDX Document.

388

"createTime": "A String", # Identify when the SPDX file was originally created. The date is to be specified according to combined date and time in UTC format as specified in ISO 8601 standard

389

"creatorComment": "A String", # A field for creators of the SPDX file to provide general comments about the creation of the SPDX file or any other relevant comment not included in the other fields

390

"creators": [ # Identify who (or what, in the case of a tool) created the SPDX file. If the SPDX file was created by an individual, indicate the person's name

391

"A String",

392

],

393

"documentComment": "A String", # A field for creators of the SPDX file content to provide comments to the consumers of the SPDX document

394

"externalDocumentRefs": [ # Identify any external SPDX documents referenced within this SPDX document

395

"A String",

396

],

397

"id": "A String", # Identify the current SPDX document which may be referenced in relationships by other files, packages internally and documents externally

398

"licenseListVersion": "A String", # A field for creators of the SPDX file to provide the version of the SPDX License List used when the SPDX file was created

399

"namespace": "A String", # Provide an SPDX document specific namespace as a unique absolute Uniform Resource Identifier (URI) as specified in RFC-3986, with the exception of the ‘#’ delimiter

400

"title": "A String", # Identify name of this document as designated by creator

401

},

402

"spdxFile": { # FileOccurrence represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # Describes a specific SPDX File.

403

"attributions": [ # This field provides a place for the SPDX data creator to record, at the file level, acknowledgements that may be needed to be communicated in some contexts

404

"A String",

405

],

406

"comment": "A String", # This field provides a place for the SPDX file creator to record any general comments about the file

407

"contributors": [ # This field provides a place for the SPDX file creator to record file contributors

408

"A String",

409

],

410

"copyright": "A String", # Identify the copyright holder of the file, as well as any dates present

411

"filesLicenseInfo": [ # This field contains the license information actually found in the file, if any

412

"A String",

413

],

414

"id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements

415

"licenseComments": "A String", # This field provides a place for the SPDX file creator to record any relevant background references or analysis that went in to arriving at the Concluded License for a file

416

"licenseConcluded": "A String", # This field contains the license the SPDX file creator has concluded as governing the file or alternative values if the governing license cannot be determined

417

"notice": "A String", # This field provides a place for the SPDX file creator to record license notices or other such related notices found in the file

418

},

419

"spdxPackage": { # PackageOccurrence represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # Describes a specific SPDX Package.

420

"comment": "A String", # A place for the SPDX file creator to record any general comments about the package being described

421

"filename": "A String", # Provide the actual file name of the package, or path of the directory being treated as a package

422

"id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements

423

"licenseComments": "A String", # This field provides a place for the SPDX file creator to record any relevant background information or analysis that went in to arriving at the Concluded License for a package

424

"licenseConcluded": "A String", # package or alternative values, if the governing license cannot be determined

425

"sourceInfo": "A String", # Provide a place for the SPDX file creator to record any relevant background information or additional comments about the origin of the package

426

},

427

"spdxRelationship": { # RelationshipOccurrence represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # Describes a specific SPDX Relationship.

428

"comment": "A String", # A place for the SPDX file creator to record any general comments about the relationship

429

"source": "A String", # Also referred to as SPDXRef-A The source SPDX element (file, package, etc)

430

"target": "A String", # Also referred to as SPDXRef-B The target SPDC element (file, package, etc) In cases where there are "known unknowns", the use of the keyword NOASSERTION can be used The keywords NONE can be used to indicate that an SPDX element (package/file/snippet) has no other elements connected by some relationship to it

431

"type": "A String", # The type of relationship between the source and target SPDX elements

432

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

433

"updateTime": "A String", # Output only. The time this occurrence was last updated.

434

"vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability.

435

"cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity.

436

"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.

437

"longDescription": "A String", # Output only. A detailed description of this vulnerability.

438

"packageIssue": [ # Required. The set of affected locations and their fixes (if available) within the associated resource.

439

{ # This message wraps a location affected by a vulnerability and its associated fix (if one is available).

440

"affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.

441

"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.

442

"package": "A String", # Required. The package being described.

443

"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.

444

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

445

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

446

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

447

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

448

"revision": "A String", # The iteration of the package build from the above version.

449

},

450

},

451

"fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.

452

"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.

453

"package": "A String", # Required. The package being described.

454

"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.

455

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

456

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

457

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

458

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

459

"revision": "A String", # The iteration of the package build from the above version.

460

},

461

},

462

"severityName": "A String", # Deprecated, use Details.effective_severity instead The severity (e.g., distro assigned severity) for this vulnerability.

463

},

464

],

465

"relatedUrls": [ # Output only. URLs related to this vulnerability.

466

{ # Metadata for any related URL information.

467

"label": "A String", # Label to describe usage of the URL.

468

"url": "A String", # Specific URL associated with the resource.

469

},

470

],

471

"severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.

472

"shortDescription": "A String", # Output only. A one sentence description of this vulnerability.

473

"type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)

},

},

],

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

478

479

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

486

487

{ # Response for creating occurrences in batch.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

488

"occurrences": [ # The occurrences that were created.

489

{ # An instance of an analysis type that has been found on a resource.

490

"attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.

491

"attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for look-up (how to find this attestation if you already know the authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). # Required. Attestation for the resource.

492

"genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.

493

"contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema).

494

"serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.

495

"signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.

496

{ # 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).

497

"publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"

498

"signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.

499

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

500

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

501

},

502

"pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file. # A PGP signed attestation.

503

"contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema).

504

"pgpKeyId": "A String", # The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexidecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.

505

"signature": "A String", # Required. The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

506

},

507

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

508

},

509

"build": { # Details of a build occurrence. # Describes a verifiable build.

510

"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # Required. The actual provenance for the build.

511

"buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.

512

"a_key": "A String",

513

},

514

"builderVersion": "A String", # Version string of the builder at the time this build was executed.

515

"builtArtifacts": [ # Output of the build.

516

{ # Artifact describes a build product.

517

"checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.

518

"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.

519

"names": [ # Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image.

520

"A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

521

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

522

},

523

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

524

"commands": [ # Commands requested by the build.

525

{ # Command describes a step performed as part of the build pipeline.

526

"args": [ # Command-line arguments used when executing this command.

527

"A String",

528

],

529

"dir": "A String", # Working directory (relative to project source root) used when running this command.

530

"env": [ # Environment variables set before running this command.

531

"A String",

532

],

533

"id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.

534

"name": "A String", # Required. Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`.

535

"waitFor": [ # The ID(s) of the command(s) that this command depends on.

536

"A String",

537

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

538

},

539

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

540

"createTime": "A String", # Time at which the build was created.

541

"creator": "A String", # E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time.

542

"endTime": "A String", # Time at which execution of the build was finished.

543

"id": "A String", # Required. Unique identifier of the build.

544

"logsUri": "A String", # URI where any logs for this provenance were written.

545

"projectId": "A String", # ID of the project.

546

"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.

547

"additionalContexts": [ # If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field.

548

{ # 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.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

549

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

550

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

551

"kind": "A String", # The alias kind.

552

"name": "A String", # The alias name.

553

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

554

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

555

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

556

"projectId": "A String", # The ID of the project.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

557

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

558

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

559

"uid": "A String", # A server-assigned, globally unique identifier.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

560

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

561

"revisionId": "A String", # A revision ID.

562

},

563

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

564

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

565

"kind": "A String", # The alias kind.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

566

"name": "A String", # The alias name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

567

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

568

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

569

"hostUri": "A String", # The URI of a running Gerrit instance.

570

"revisionId": "A String", # A revision (commit) ID.

571

},

572

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

573

"revisionId": "A String", # Git commit hash.

574

"url": "A String", # Git repository URL.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

575

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

576

"labels": { # Labels with user defined metadata.

577

"a_key": "A String",

578

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

579

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

580

],

581

"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.

582

"context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # If provided, the source code used for the build came from this location.

583

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

584

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

585

"kind": "A String", # The alias kind.

586

"name": "A String", # The alias name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

587

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

588

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

589

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

590

"projectId": "A String", # The ID of the project.

591

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

592

},

593

"uid": "A String", # A server-assigned, globally unique identifier.

594

},

595

"revisionId": "A String", # A revision ID.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

596

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

597

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

598

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

599

"kind": "A String", # The alias kind.

600

"name": "A String", # The alias name.

601

},

602

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

603

"hostUri": "A String", # The URI of a running Gerrit instance.

604

"revisionId": "A String", # A revision (commit) ID.

605

},

606

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

607

"revisionId": "A String", # Git commit hash.

608

"url": "A String", # Git repository URL.

609

},

610

"labels": { # Labels with user defined metadata.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

611

"a_key": "A String",

612

},

613

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

614

"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file.

615

"a_key": { # Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build.

616

"fileHash": [ # Required. Collection of file hashes.

617

{ # Container message for hash values.

618

"type": "A String", # Required. The type of hash that was performed.

619

"value": "A String", # Required. The hash value.

},

],

},

},

},

"startTime": "A String", # Time at which execution of the build was started.

626

"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.

627

},

628

"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes.

629

},

630

"createTime": "A String", # Output only. The time this occurrence was created.

631

"deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.

632

"deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.

633

"address": "A String", # Address of the runtime element hosting this deployment.

634

"config": "A String", # Configuration used to create this deployment.

635

"deployTime": "A String", # Required. Beginning of the lifetime of this deployment.

636

"platform": "A String", # Platform hosting this deployment.

637

"resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.

638

"A String",

639

],

640

"undeployTime": "A String", # End of the lifetime of this deployment.

641

"userEmail": "A String", # Identity of the user that triggered this deployment.

642

},

643

},

644

"derivedImage": { # Details of an image occurrence. # Describes how this resource derives from the basis in the associated note.

645

"derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Required. Immutable. The child image derived from the base image.

646

"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.

647

"distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.

648

"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.

649

"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.

650

"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

651

"A String",

652

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

653

"v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

654

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

655

"layerInfo": [ # This contains layer-specific metadata, if populated it has length "distance" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer.

656

{ # Layer holds metadata specific to a layer of a Docker image.

657

"arguments": "A String", # The recovered arguments to the Dockerfile directive.

658

"directive": "A String", # Required. The recovered Dockerfile directive used to construct this layer.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

659

},

660

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

661

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

662

},

663

"discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered.

664

"discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource.

665

"analysisStatus": "A String", # The status of discovery for the resource.

666

"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API.

667

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

668

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

669

{

670

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

671

},

672

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

673

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

674

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

675

"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.

676

"lastAnalysisTime": "A String", # The last time continuous analysis was done for this resource. Deprecated, do not use.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

677

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

678

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

679

"installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.

680

"installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.

681

"location": [ # Required. All of the places within the filesystem versions of this package have been found.

682

{ # An occurrence of a particular package installation found within a system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.

683

"cpeUri": "A String", # Required. The CPE URI in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.

684

"path": "A String", # The path from which we gathered that this package/version is installed.

685

"version": { # Version contains structured information about the version of a package. # The version installed at this location.

686

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

687

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

688

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

689

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

690

"revision": "A String", # The iteration of the package build from the above version.

},

},

],

"name": "A String", # Output only. The name of the installed package.

695

},

696

},

697

"intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.

698

"signatures": [

699

{ # A signature object consists of the KeyID used and the signature itself.

"keyid": "A String",

"sig": "A String",

},

],

"signed": { # This corresponds to an in-toto link.

705

"byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.

"customValues": {

"a_key": "A String",

},

},

"command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]

711

"A String",

712

],

713

"environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }

"customValues": {

"a_key": "A String",

},

},

"materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]

719

{

720

"hashes": { # Defines a hash object for use in Materials and Products.

721

"sha256": "A String",

722

},

723

"resourceUri": "A String",

724

},

725

],

726

"products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.

727

{

728

"hashes": { # Defines a hash object for use in Materials and Products.

729

"sha256": "A String",

730

},

731

"resourceUri": "A String",

},

],

},

},

"kind": "A String", # Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests.

737

"name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.

738

"noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.

739

"remediation": "A String", # A description of actions that can be taken to remedy the note.

740

"resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.

741

"contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.

742

"type": "A String", # Required. The type of hash that was performed.

743

"value": "A String", # Required. The hash value.

744

},

745

"name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".

746

"uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.

747

},

yoshi-code-bot

2021-08-03 00:20:27 -0700

[diff] [blame^]

748

"sbom": { # DocumentOccurrence represents an SPDX Document Creation Information section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # Describes a specific SPDX Document.

749

"createTime": "A String", # Identify when the SPDX file was originally created. The date is to be specified according to combined date and time in UTC format as specified in ISO 8601 standard

750

"creatorComment": "A String", # A field for creators of the SPDX file to provide general comments about the creation of the SPDX file or any other relevant comment not included in the other fields

751

"creators": [ # Identify who (or what, in the case of a tool) created the SPDX file. If the SPDX file was created by an individual, indicate the person's name

752

"A String",

753

],

754

"documentComment": "A String", # A field for creators of the SPDX file content to provide comments to the consumers of the SPDX document

755

"externalDocumentRefs": [ # Identify any external SPDX documents referenced within this SPDX document

756

"A String",

757

],

758

"id": "A String", # Identify the current SPDX document which may be referenced in relationships by other files, packages internally and documents externally

759

"licenseListVersion": "A String", # A field for creators of the SPDX file to provide the version of the SPDX License List used when the SPDX file was created

760

"namespace": "A String", # Provide an SPDX document specific namespace as a unique absolute Uniform Resource Identifier (URI) as specified in RFC-3986, with the exception of the ‘#’ delimiter

761

"title": "A String", # Identify name of this document as designated by creator

762

},

763

"spdxFile": { # FileOccurrence represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # Describes a specific SPDX File.

764

"attributions": [ # This field provides a place for the SPDX data creator to record, at the file level, acknowledgements that may be needed to be communicated in some contexts

765

"A String",

766

],

767

"comment": "A String", # This field provides a place for the SPDX file creator to record any general comments about the file

768

"contributors": [ # This field provides a place for the SPDX file creator to record file contributors

769

"A String",

770

],

771

"copyright": "A String", # Identify the copyright holder of the file, as well as any dates present

772

"filesLicenseInfo": [ # This field contains the license information actually found in the file, if any

773

"A String",

774

],

775

"id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements

776

"licenseComments": "A String", # This field provides a place for the SPDX file creator to record any relevant background references or analysis that went in to arriving at the Concluded License for a file

777

"licenseConcluded": "A String", # This field contains the license the SPDX file creator has concluded as governing the file or alternative values if the governing license cannot be determined

778

"notice": "A String", # This field provides a place for the SPDX file creator to record license notices or other such related notices found in the file

779

},

780

"spdxPackage": { # PackageOccurrence represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # Describes a specific SPDX Package.

781

"comment": "A String", # A place for the SPDX file creator to record any general comments about the package being described

782

"filename": "A String", # Provide the actual file name of the package, or path of the directory being treated as a package

783

"id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements

784

"licenseComments": "A String", # This field provides a place for the SPDX file creator to record any relevant background information or analysis that went in to arriving at the Concluded License for a package

785

"licenseConcluded": "A String", # package or alternative values, if the governing license cannot be determined

786

"sourceInfo": "A String", # Provide a place for the SPDX file creator to record any relevant background information or additional comments about the origin of the package

787

},

788

"spdxRelationship": { # RelationshipOccurrence represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # Describes a specific SPDX Relationship.

789

"comment": "A String", # A place for the SPDX file creator to record any general comments about the relationship

790

"source": "A String", # Also referred to as SPDXRef-A The source SPDX element (file, package, etc)

791

"target": "A String", # Also referred to as SPDXRef-B The target SPDC element (file, package, etc) In cases where there are "known unknowns", the use of the keyword NOASSERTION can be used The keywords NONE can be used to indicate that an SPDX element (package/file/snippet) has no other elements connected by some relationship to it

792

"type": "A String", # The type of relationship between the source and target SPDX elements

793

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

794

"updateTime": "A String", # Output only. The time this occurrence was last updated.

795

"vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability.

796

"cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity.

797

"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.

798

"longDescription": "A String", # Output only. A detailed description of this vulnerability.

799

"packageIssue": [ # Required. The set of affected locations and their fixes (if available) within the associated resource.

800

{ # This message wraps a location affected by a vulnerability and its associated fix (if one is available).

801

"affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.

802

"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.

803

"package": "A String", # Required. The package being described.

804

"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.

805

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

806

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

807

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

808

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

809

"revision": "A String", # The iteration of the package build from the above version.

810

},

811

},

812

"fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.

813

"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.

814

"package": "A String", # Required. The package being described.

815

"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.

816

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

817

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

818

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

819

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

820

"revision": "A String", # The iteration of the package build from the above version.

821

},

822

},

823

"severityName": "A String", # Deprecated, use Details.effective_severity instead The severity (e.g., distro assigned severity) for this vulnerability.

824

},

825

],

826

"relatedUrls": [ # Output only. URLs related to this vulnerability.

827

{ # Metadata for any related URL information.

828

"label": "A String", # Label to describe usage of the URL.

829

"url": "A String", # Specific URL associated with the resource.

830

},

831

],

832

"severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.

833

"shortDescription": "A String", # Output only. A one sentence description of this vulnerability.

834

"type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)

},

},

],

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

842

<code class="details" id="close">close()</code>

843

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

847

<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

848

<pre>Creates a new occurrence.

849

850

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

851

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

852

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

853

The object takes the form of:

854

855

{ # An instance of an analysis type that has been found on a resource.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

856

"attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.

857

"attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for look-up (how to find this attestation if you already know the authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). # Required. Attestation for the resource.

858

"genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

859

"contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

860

"serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.

861

"signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.

862

{ # 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).

863

"publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"

864

"signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.

865

},

866

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

867

},

868

"pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file. # A PGP signed attestation.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

869

"contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

870

"pgpKeyId": "A String", # The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexidecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.

871

"signature": "A String", # Required. The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

872

},

873

},

874

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

875

"build": { # Details of a build occurrence. # Describes a verifiable build.

876

"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # Required. The actual provenance for the build.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

877

"buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.

878

"a_key": "A String",

879

},

880

"builderVersion": "A String", # Version string of the builder at the time this build was executed.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

881

"builtArtifacts": [ # Output of the build.

882

{ # Artifact describes a build product.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

883

"checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

884

"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

885

"names": [ # Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image.

886

"A String",

887

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

888

},

889

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

890

"commands": [ # Commands requested by the build.

891

{ # Command describes a step performed as part of the build pipeline.

892

"args": [ # Command-line arguments used when executing this command.

893

"A String",

894

],

895

"dir": "A String", # Working directory (relative to project source root) used when running this command.

896

"env": [ # Environment variables set before running this command.

897

"A String",

898

],

899

"id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.

900

"name": "A String", # Required. Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`.

901

"waitFor": [ # The ID(s) of the command(s) that this command depends on.

"A String",

],

},

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

906

"createTime": "A String", # Time at which the build was created.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

907

"creator": "A String", # E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time.

908

"endTime": "A String", # Time at which execution of the build was finished.

909

"id": "A String", # Required. Unique identifier of the build.

910

"logsUri": "A String", # URI where any logs for this provenance were written.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

911

"projectId": "A String", # ID of the project.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

912

"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

913

"additionalContexts": [ # If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field.

914

{ # 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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

915

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

916

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

917

"kind": "A String", # The alias kind.

918

"name": "A String", # The alias name.

919

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

920

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

921

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

922

"projectId": "A String", # The ID of the project.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

923

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

924

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

925

"uid": "A String", # A server-assigned, globally unique identifier.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

926

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

927

"revisionId": "A String", # A revision ID.

928

},

929

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

930

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

931

"kind": "A String", # The alias kind.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

932

"name": "A String", # The alias name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

933

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

934

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

935

"hostUri": "A String", # The URI of a running Gerrit instance.

936

"revisionId": "A String", # A revision (commit) ID.

937

},

938

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

939

"revisionId": "A String", # Git commit hash.

940

"url": "A String", # Git repository URL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

941

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

942

"labels": { # Labels with user defined metadata.

943

"a_key": "A String",

944

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

945

},

946

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

947

"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

948

"context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # If provided, the source code used for the build came from this location.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

949

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

950

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

951

"kind": "A String", # The alias kind.

952

"name": "A String", # The alias name.

953

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

954

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

955

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

956

"projectId": "A String", # The ID of the project.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

957

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

958

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

959

"uid": "A String", # A server-assigned, globally unique identifier.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

960

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

961

"revisionId": "A String", # A revision ID.

962

},

963

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

964

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

965

"kind": "A String", # The alias kind.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

966

"name": "A String", # The alias name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

967

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

968

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

969

"hostUri": "A String", # The URI of a running Gerrit instance.

970

"revisionId": "A String", # A revision (commit) ID.

971

},

972

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

973

"revisionId": "A String", # Git commit hash.

974

"url": "A String", # Git repository URL.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

975

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

976

"labels": { # Labels with user defined metadata.

977

"a_key": "A String",

978

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

979

},

980

"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file.

981

"a_key": { # Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build.

982

"fileHash": [ # Required. Collection of file hashes.

983

{ # Container message for hash values.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

984

"type": "A String", # Required. The type of hash that was performed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

985

"value": "A String", # Required. The hash value.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

},

],

},

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

990

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

991

"startTime": "A String", # Time at which execution of the build was started.

992

"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.

993

},

994

"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes.

995

},

996

"createTime": "A String", # Output only. The time this occurrence was created.

997

"deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.

998

"deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.

999

"address": "A String", # Address of the runtime element hosting this deployment.

1000

"config": "A String", # Configuration used to create this deployment.

1001

"deployTime": "A String", # Required. Beginning of the lifetime of this deployment.

1002

"platform": "A String", # Platform hosting this deployment.

1003

"resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.

1004

"A String",

1005

],

1006

"undeployTime": "A String", # End of the lifetime of this deployment.

1007

"userEmail": "A String", # Identity of the user that triggered this deployment.

1008

},

1009

},

1010

"derivedImage": { # Details of an image occurrence. # Describes how this resource derives from the basis in the associated note.

1011

"derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Required. Immutable. The child image derived from the base image.

1012

"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.

1013

"distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.

1014

"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.

1015

"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.

1016

"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.

1017

"A String",

1018

],

1019

"v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.

1020

},

1021

"layerInfo": [ # This contains layer-specific metadata, if populated it has length "distance" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer.

1022

{ # Layer holds metadata specific to a layer of a Docker image.

1023

"arguments": "A String", # The recovered arguments to the Dockerfile directive.

1024

"directive": "A String", # Required. The recovered Dockerfile directive used to construct this layer.

},

],

},

},

"discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered.

1030

"discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource.

1031

"analysisStatus": "A String", # The status of discovery for the resource.

1032

"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API.

1033

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1034

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

1035

{

1036

"a_key": "", # Properties of the object. Contains field @type with type URL.

1037

},

1038

],

1039

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

1040

},

1041

"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.

1042

"lastAnalysisTime": "A String", # The last time continuous analysis was done for this resource. Deprecated, do not use.

1043

},

1044

},

1045

"installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.

1046

"installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.

1047

"location": [ # Required. All of the places within the filesystem versions of this package have been found.

1048

{ # An occurrence of a particular package installation found within a system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.

1049

"cpeUri": "A String", # Required. The CPE URI in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.

1050

"path": "A String", # The path from which we gathered that this package/version is installed.

1051

"version": { # Version contains structured information about the version of a package. # The version installed at this location.

1052

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1053

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1054

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

1055

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

1056

"revision": "A String", # The iteration of the package build from the above version.

},

},

],

"name": "A String", # Output only. The name of the installed package.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1061

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1062

},

1063

"intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1064

"signatures": [

1065

{ # A signature object consists of the KeyID used and the signature itself.

"keyid": "A String",

"sig": "A String",

},

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1070

"signed": { # This corresponds to an in-toto link.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1071

"byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

"customValues": {

"a_key": "A String",

},

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1076

"command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]

1077

"A String",

1078

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1079

"environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

"customValues": {

"a_key": "A String",

},

},

"materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]

1085

{

1086

"hashes": { # Defines a hash object for use in Materials and Products.

1087

"sha256": "A String",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1088

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1089

"resourceUri": "A String",

1090

},

1091

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1092

"products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.

1093

{

1094

"hashes": { # Defines a hash object for use in Materials and Products.

1095

"sha256": "A String",

1096

},

1097

"resourceUri": "A String",

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1098

},

1099

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1100

},

1101

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1102

"kind": "A String", # Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1103

"name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1104

"noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1105

"remediation": "A String", # A description of actions that can be taken to remedy the note.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1106

"resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.

1107

"contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1108

"type": "A String", # Required. The type of hash that was performed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1109

"value": "A String", # Required. The hash value.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1110

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1111

"name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1112

"uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.

1113

},

yoshi-code-bot

2021-08-03 00:20:27 -0700

[diff] [blame^]

1114

"sbom": { # DocumentOccurrence represents an SPDX Document Creation Information section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # Describes a specific SPDX Document.

1115

"createTime": "A String", # Identify when the SPDX file was originally created. The date is to be specified according to combined date and time in UTC format as specified in ISO 8601 standard

1116

"creatorComment": "A String", # A field for creators of the SPDX file to provide general comments about the creation of the SPDX file or any other relevant comment not included in the other fields

1117

"creators": [ # Identify who (or what, in the case of a tool) created the SPDX file. If the SPDX file was created by an individual, indicate the person's name

1118

"A String",

1119

],

1120

"documentComment": "A String", # A field for creators of the SPDX file content to provide comments to the consumers of the SPDX document

1121

"externalDocumentRefs": [ # Identify any external SPDX documents referenced within this SPDX document

1122

"A String",

1123

],

1124

"id": "A String", # Identify the current SPDX document which may be referenced in relationships by other files, packages internally and documents externally

1125

"licenseListVersion": "A String", # A field for creators of the SPDX file to provide the version of the SPDX License List used when the SPDX file was created

1126

"namespace": "A String", # Provide an SPDX document specific namespace as a unique absolute Uniform Resource Identifier (URI) as specified in RFC-3986, with the exception of the ‘#’ delimiter

1127

"title": "A String", # Identify name of this document as designated by creator

1128

},

1129

"spdxFile": { # FileOccurrence represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # Describes a specific SPDX File.

1130

"attributions": [ # This field provides a place for the SPDX data creator to record, at the file level, acknowledgements that may be needed to be communicated in some contexts

1131

"A String",

1132

],

1133

"comment": "A String", # This field provides a place for the SPDX file creator to record any general comments about the file

1134

"contributors": [ # This field provides a place for the SPDX file creator to record file contributors

1135

"A String",

1136

],

1137

"copyright": "A String", # Identify the copyright holder of the file, as well as any dates present

1138

"filesLicenseInfo": [ # This field contains the license information actually found in the file, if any

1139

"A String",

1140

],

1141

"id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements

1142

"licenseComments": "A String", # This field provides a place for the SPDX file creator to record any relevant background references or analysis that went in to arriving at the Concluded License for a file

1143

"licenseConcluded": "A String", # This field contains the license the SPDX file creator has concluded as governing the file or alternative values if the governing license cannot be determined

1144

"notice": "A String", # This field provides a place for the SPDX file creator to record license notices or other such related notices found in the file

1145

},

1146

"spdxPackage": { # PackageOccurrence represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # Describes a specific SPDX Package.

1147

"comment": "A String", # A place for the SPDX file creator to record any general comments about the package being described

1148

"filename": "A String", # Provide the actual file name of the package, or path of the directory being treated as a package

1149

"id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements

1150

"licenseComments": "A String", # This field provides a place for the SPDX file creator to record any relevant background information or analysis that went in to arriving at the Concluded License for a package

1151

"licenseConcluded": "A String", # package or alternative values, if the governing license cannot be determined

1152

"sourceInfo": "A String", # Provide a place for the SPDX file creator to record any relevant background information or additional comments about the origin of the package

1153

},

1154

"spdxRelationship": { # RelationshipOccurrence represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # Describes a specific SPDX Relationship.

1155

"comment": "A String", # A place for the SPDX file creator to record any general comments about the relationship

1156

"source": "A String", # Also referred to as SPDXRef-A The source SPDX element (file, package, etc)

1157

"target": "A String", # Also referred to as SPDXRef-B The target SPDC element (file, package, etc) In cases where there are "known unknowns", the use of the keyword NOASSERTION can be used The keywords NONE can be used to indicate that an SPDX element (package/file/snippet) has no other elements connected by some relationship to it

1158

"type": "A String", # The type of relationship between the source and target SPDX elements

1159

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1160

"updateTime": "A String", # Output only. The time this occurrence was last updated.

1161

"vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability.

1162

"cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity.

1163

"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.

1164

"longDescription": "A String", # Output only. A detailed description of this vulnerability.

1165

"packageIssue": [ # Required. The set of affected locations and their fixes (if available) within the associated resource.

1166

{ # This message wraps a location affected by a vulnerability and its associated fix (if one is available).

1167

"affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.

1168

"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.

1169

"package": "A String", # Required. The package being described.

1170

"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.

1171

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1172

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1173

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

1174

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

1175

"revision": "A String", # The iteration of the package build from the above version.

1176

},

1177

},

1178

"fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.

1179

"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.

1180

"package": "A String", # Required. The package being described.

1181

"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.

1182

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1183

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1184

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

1185

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

1186

"revision": "A String", # The iteration of the package build from the above version.

1187

},

1188

},

1189

"severityName": "A String", # Deprecated, use Details.effective_severity instead The severity (e.g., distro assigned severity) for this vulnerability.

1190

},

1191

],

1192

"relatedUrls": [ # Output only. URLs related to this vulnerability.

1193

{ # Metadata for any related URL information.

1194

"label": "A String", # Label to describe usage of the URL.

1195

"url": "A String", # Specific URL associated with the resource.

1196

},

1197

],

1198

"severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.

1199

"shortDescription": "A String", # Output only. A one sentence description of this vulnerability.

1200

"type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1201

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1202

}

1203

1204

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1211

1212

{ # An instance of an analysis type that has been found on a resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1213

"attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.

1214

"attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for look-up (how to find this attestation if you already know the authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). # Required. Attestation for the resource.

1215

"genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.

1216

"contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema).

1217

"serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.

1218

"signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.

1219

{ # 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).

1220

"publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"

1221

"signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.

1222

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1223

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1224

},

1225

"pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file. # A PGP signed attestation.

1226

"contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema).

1227

"pgpKeyId": "A String", # The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexidecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.

1228

"signature": "A String", # Required. The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1229

},

1230

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1231

},

1232

"build": { # Details of a build occurrence. # Describes a verifiable build.

1233

"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # Required. The actual provenance for the build.

1234

"buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.

1235

"a_key": "A String",

1236

},

1237

"builderVersion": "A String", # Version string of the builder at the time this build was executed.

1238

"builtArtifacts": [ # Output of the build.

1239

{ # Artifact describes a build product.

1240

"checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.

1241

"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.

1242

"names": [ # Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image.

1243

"A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1244

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1245

},

1246

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1247

"commands": [ # Commands requested by the build.

1248

{ # Command describes a step performed as part of the build pipeline.

1249

"args": [ # Command-line arguments used when executing this command.

1250

"A String",

1251

],

1252

"dir": "A String", # Working directory (relative to project source root) used when running this command.

1253

"env": [ # Environment variables set before running this command.

1254

"A String",

1255

],

1256

"id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.

1257

"name": "A String", # Required. Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`.

1258

"waitFor": [ # The ID(s) of the command(s) that this command depends on.

1259

"A String",

1260

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1261

},

1262

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1263

"createTime": "A String", # Time at which the build was created.

1264

"creator": "A String", # E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time.

1265

"endTime": "A String", # Time at which execution of the build was finished.

1266

"id": "A String", # Required. Unique identifier of the build.

1267

"logsUri": "A String", # URI where any logs for this provenance were written.

1268

"projectId": "A String", # ID of the project.

1269

"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.

1270

"additionalContexts": [ # If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field.

1271

{ # 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.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1272

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1273

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

1274

"kind": "A String", # The alias kind.

1275

"name": "A String", # The alias name.

1276

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1277

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1278

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1279

"projectId": "A String", # The ID of the project.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1280

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1281

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1282

"uid": "A String", # A server-assigned, globally unique identifier.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1283

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1284

"revisionId": "A String", # A revision ID.

1285

},

1286

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1287

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1288

"kind": "A String", # The alias kind.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1289

"name": "A String", # The alias name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1290

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1291

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

1292

"hostUri": "A String", # The URI of a running Gerrit instance.

1293

"revisionId": "A String", # A revision (commit) ID.

1294

},

1295

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

1296

"revisionId": "A String", # Git commit hash.

1297

"url": "A String", # Git repository URL.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1298

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1299

"labels": { # Labels with user defined metadata.

1300

"a_key": "A String",

1301

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1302

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1303

],

1304

"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.

1305

"context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # If provided, the source code used for the build came from this location.

1306

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

1307

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

1308

"kind": "A String", # The alias kind.

1309

"name": "A String", # The alias name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1310

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1311

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

1312

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

1313

"projectId": "A String", # The ID of the project.

1314

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

1315

},

1316

"uid": "A String", # A server-assigned, globally unique identifier.

1317

},

1318

"revisionId": "A String", # A revision ID.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1319

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1320

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

1321

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

1322

"kind": "A String", # The alias kind.

1323

"name": "A String", # The alias name.

1324

},

1325

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

1326

"hostUri": "A String", # The URI of a running Gerrit instance.

1327

"revisionId": "A String", # A revision (commit) ID.

1328

},

1329

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

1330

"revisionId": "A String", # Git commit hash.

1331

"url": "A String", # Git repository URL.

1332

},

1333

"labels": { # Labels with user defined metadata.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1334

"a_key": "A String",

1335

},

1336

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1337

"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file.

1338

"a_key": { # Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build.

1339

"fileHash": [ # Required. Collection of file hashes.

1340

{ # Container message for hash values.

1341

"type": "A String", # Required. The type of hash that was performed.

1342

"value": "A String", # Required. The hash value.

},

],

},

},

},

"startTime": "A String", # Time at which execution of the build was started.

1349

"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.

1350

},

1351

"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes.

1352

},

1353

"createTime": "A String", # Output only. The time this occurrence was created.

1354

"deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.

1355

"deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.

1356

"address": "A String", # Address of the runtime element hosting this deployment.

1357

"config": "A String", # Configuration used to create this deployment.

1358

"deployTime": "A String", # Required. Beginning of the lifetime of this deployment.

1359

"platform": "A String", # Platform hosting this deployment.

1360

"resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.

1361

"A String",

1362

],

1363

"undeployTime": "A String", # End of the lifetime of this deployment.

1364

"userEmail": "A String", # Identity of the user that triggered this deployment.

1365

},

1366

},

1367

"derivedImage": { # Details of an image occurrence. # Describes how this resource derives from the basis in the associated note.

1368

"derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Required. Immutable. The child image derived from the base image.

1369

"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.

1370

"distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.

1371

"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.

1372

"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.

1373

"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1374

"A String",

1375

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1376

"v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1377

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1378

"layerInfo": [ # This contains layer-specific metadata, if populated it has length "distance" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer.

1379

{ # Layer holds metadata specific to a layer of a Docker image.

1380

"arguments": "A String", # The recovered arguments to the Dockerfile directive.

1381

"directive": "A String", # Required. The recovered Dockerfile directive used to construct this layer.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1382

},

1383

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1384

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1385

},

1386

"discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered.

1387

"discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource.

1388

"analysisStatus": "A String", # The status of discovery for the resource.

1389

"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API.

1390

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1391

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

1392

{

1393

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1394

},

1395

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1396

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

1397

},

1398

"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.

1399

"lastAnalysisTime": "A String", # The last time continuous analysis was done for this resource. Deprecated, do not use.

1400

},

1401

},

1402

"installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.

1403

"installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.

1404

"location": [ # Required. All of the places within the filesystem versions of this package have been found.

1405

{ # An occurrence of a particular package installation found within a system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.

1406

"cpeUri": "A String", # Required. The CPE URI in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.

1407

"path": "A String", # The path from which we gathered that this package/version is installed.

1408

"version": { # Version contains structured information about the version of a package. # The version installed at this location.

1409

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1410

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1411

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

1412

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

1413

"revision": "A String", # The iteration of the package build from the above version.

},

},

],

"name": "A String", # Output only. The name of the installed package.

1418

},

1419

},

1420

"intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.

1421

"signatures": [

1422

{ # A signature object consists of the KeyID used and the signature itself.

"keyid": "A String",

"sig": "A String",

},

],

"signed": { # This corresponds to an in-toto link.

1428

"byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.

1429

"customValues": {

1430

"a_key": "A String",

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1431

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1432

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1433

"command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]

1434

"A String",

1435

],

1436

"environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }

1437

"customValues": {

1438

"a_key": "A String",

1439

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1440

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1441

"materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]

1442

{

1443

"hashes": { # Defines a hash object for use in Materials and Products.

1444

"sha256": "A String",

1445

},

1446

"resourceUri": "A String",

1447

},

1448

],

1449

"products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.

1450

{

1451

"hashes": { # Defines a hash object for use in Materials and Products.

1452

"sha256": "A String",

1453

},

1454

"resourceUri": "A String",

1455

},

1456

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1457

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1458

},

1459

"kind": "A String", # Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests.

1460

"name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.

1461

"noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.

1462

"remediation": "A String", # A description of actions that can be taken to remedy the note.

1463

"resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.

1464

"contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.

1465

"type": "A String", # Required. The type of hash that was performed.

1466

"value": "A String", # Required. The hash value.

1467

},

1468

"name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".

1469

"uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.

1470

},

yoshi-code-bot

2021-08-03 00:20:27 -0700

[diff] [blame^]

1471

"sbom": { # DocumentOccurrence represents an SPDX Document Creation Information section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # Describes a specific SPDX Document.

1472

"createTime": "A String", # Identify when the SPDX file was originally created. The date is to be specified according to combined date and time in UTC format as specified in ISO 8601 standard

1473

"creatorComment": "A String", # A field for creators of the SPDX file to provide general comments about the creation of the SPDX file or any other relevant comment not included in the other fields

1474

"creators": [ # Identify who (or what, in the case of a tool) created the SPDX file. If the SPDX file was created by an individual, indicate the person's name

1475

"A String",

1476

],

1477

"documentComment": "A String", # A field for creators of the SPDX file content to provide comments to the consumers of the SPDX document

1478

"externalDocumentRefs": [ # Identify any external SPDX documents referenced within this SPDX document

1479

"A String",

1480

],

1481

"id": "A String", # Identify the current SPDX document which may be referenced in relationships by other files, packages internally and documents externally

1482

"licenseListVersion": "A String", # A field for creators of the SPDX file to provide the version of the SPDX License List used when the SPDX file was created

1483

"namespace": "A String", # Provide an SPDX document specific namespace as a unique absolute Uniform Resource Identifier (URI) as specified in RFC-3986, with the exception of the ‘#’ delimiter

1484

"title": "A String", # Identify name of this document as designated by creator

1485

},

1486

"spdxFile": { # FileOccurrence represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # Describes a specific SPDX File.

1487

"attributions": [ # This field provides a place for the SPDX data creator to record, at the file level, acknowledgements that may be needed to be communicated in some contexts

1488

"A String",

1489

],

1490

"comment": "A String", # This field provides a place for the SPDX file creator to record any general comments about the file

1491

"contributors": [ # This field provides a place for the SPDX file creator to record file contributors

1492

"A String",

1493

],

1494

"copyright": "A String", # Identify the copyright holder of the file, as well as any dates present

1495

"filesLicenseInfo": [ # This field contains the license information actually found in the file, if any

1496

"A String",

1497

],

1498

"id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements

1499

"licenseComments": "A String", # This field provides a place for the SPDX file creator to record any relevant background references or analysis that went in to arriving at the Concluded License for a file

1500

"licenseConcluded": "A String", # This field contains the license the SPDX file creator has concluded as governing the file or alternative values if the governing license cannot be determined

1501

"notice": "A String", # This field provides a place for the SPDX file creator to record license notices or other such related notices found in the file

1502

},

1503

"spdxPackage": { # PackageOccurrence represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # Describes a specific SPDX Package.

1504

"comment": "A String", # A place for the SPDX file creator to record any general comments about the package being described

1505

"filename": "A String", # Provide the actual file name of the package, or path of the directory being treated as a package

1506

"id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements

1507

"licenseComments": "A String", # This field provides a place for the SPDX file creator to record any relevant background information or analysis that went in to arriving at the Concluded License for a package

1508

"licenseConcluded": "A String", # package or alternative values, if the governing license cannot be determined

1509

"sourceInfo": "A String", # Provide a place for the SPDX file creator to record any relevant background information or additional comments about the origin of the package

1510

},

1511

"spdxRelationship": { # RelationshipOccurrence represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # Describes a specific SPDX Relationship.

1512

"comment": "A String", # A place for the SPDX file creator to record any general comments about the relationship

1513

"source": "A String", # Also referred to as SPDXRef-A The source SPDX element (file, package, etc)

1514

"target": "A String", # Also referred to as SPDXRef-B The target SPDC element (file, package, etc) In cases where there are "known unknowns", the use of the keyword NOASSERTION can be used The keywords NONE can be used to indicate that an SPDX element (package/file/snippet) has no other elements connected by some relationship to it

1515

"type": "A String", # The type of relationship between the source and target SPDX elements

1516

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1517

"updateTime": "A String", # Output only. The time this occurrence was last updated.

1518

"vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability.

1519

"cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity.

1520

"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.

1521

"longDescription": "A String", # Output only. A detailed description of this vulnerability.

1522

"packageIssue": [ # Required. The set of affected locations and their fixes (if available) within the associated resource.

1523

{ # This message wraps a location affected by a vulnerability and its associated fix (if one is available).

1524

"affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.

1525

"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.

1526

"package": "A String", # Required. The package being described.

1527

"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.

1528

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1529

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1530

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

1531

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

1532

"revision": "A String", # The iteration of the package build from the above version.

1533

},

1534

},

1535

"fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.

1536

"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.

1537

"package": "A String", # Required. The package being described.

1538

"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.

1539

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1540

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1541

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

1542

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

1543

"revision": "A String", # The iteration of the package build from the above version.

1544

},

1545

},

1546

"severityName": "A String", # Deprecated, use Details.effective_severity instead The severity (e.g., distro assigned severity) for this vulnerability.

1547

},

1548

],

1549

"relatedUrls": [ # Output only. URLs related to this vulnerability.

1550

{ # Metadata for any related URL information.

1551

"label": "A String", # Label to describe usage of the URL.

1552

"url": "A String", # Specific URL associated with the resource.

1553

},

1554

],

1555

"severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.

1556

"shortDescription": "A String", # Output only. A one sentence description of this vulnerability.

1557

"type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)

1558

},

1559

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1564

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1565

1566

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1567

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1568

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1575

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1576

{ # 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); } The JSON representation for `Empty` is empty JSON object `{}`.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1577

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

1582

<pre>Gets the specified occurrence.

1583

1584

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1585

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1586

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1593

1594

{ # An instance of an analysis type that has been found on a resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1595

"attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.

1596

"attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for look-up (how to find this attestation if you already know the authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). # Required. Attestation for the resource.

1597

"genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.

1598

"contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema).

1599

"serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.

1600

"signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.

1601

{ # 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).

1602

"publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"

1603

"signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.

1604

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1605

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1606

},

1607

"pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file. # A PGP signed attestation.

1608

"contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema).

1609

"pgpKeyId": "A String", # The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexidecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.

1610

"signature": "A String", # Required. The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1611

},

1612

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1613

},

1614

"build": { # Details of a build occurrence. # Describes a verifiable build.

1615

"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # Required. The actual provenance for the build.

1616

"buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.

1617

"a_key": "A String",

1618

},

1619

"builderVersion": "A String", # Version string of the builder at the time this build was executed.

1620

"builtArtifacts": [ # Output of the build.

1621

{ # Artifact describes a build product.

1622

"checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.

1623

"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.

1624

"names": [ # Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image.

1625

"A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1626

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1627

},

1628

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1629

"commands": [ # Commands requested by the build.

1630

{ # Command describes a step performed as part of the build pipeline.

1631

"args": [ # Command-line arguments used when executing this command.

1632

"A String",

1633

],

1634

"dir": "A String", # Working directory (relative to project source root) used when running this command.

1635

"env": [ # Environment variables set before running this command.

1636

"A String",

1637

],

1638

"id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.

1639

"name": "A String", # Required. Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`.

1640

"waitFor": [ # The ID(s) of the command(s) that this command depends on.

1641

"A String",

1642

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1643

},

1644

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1645

"createTime": "A String", # Time at which the build was created.

1646

"creator": "A String", # E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time.

1647

"endTime": "A String", # Time at which execution of the build was finished.

1648

"id": "A String", # Required. Unique identifier of the build.

1649

"logsUri": "A String", # URI where any logs for this provenance were written.

1650

"projectId": "A String", # ID of the project.

1651

"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.

1652

"additionalContexts": [ # If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field.

1653

{ # 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.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1654

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1655

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

1656

"kind": "A String", # The alias kind.

1657

"name": "A String", # The alias name.

1658

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1659

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1660

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1661

"projectId": "A String", # The ID of the project.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1662

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1663

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1664

"uid": "A String", # A server-assigned, globally unique identifier.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1665

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1666

"revisionId": "A String", # A revision ID.

1667

},

1668

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1669

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1670

"kind": "A String", # The alias kind.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1671

"name": "A String", # The alias name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1672

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1673

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

1674

"hostUri": "A String", # The URI of a running Gerrit instance.

1675

"revisionId": "A String", # A revision (commit) ID.

1676

},

1677

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

1678

"revisionId": "A String", # Git commit hash.

1679

"url": "A String", # Git repository URL.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1680

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1681

"labels": { # Labels with user defined metadata.

1682

"a_key": "A String",

1683

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1684

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1685

],

1686

"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.

1687

"context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # If provided, the source code used for the build came from this location.

1688

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

1689

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

1690

"kind": "A String", # The alias kind.

1691

"name": "A String", # The alias name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1692

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1693

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

1694

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

1695

"projectId": "A String", # The ID of the project.

1696

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

1697

},

1698

"uid": "A String", # A server-assigned, globally unique identifier.

1699

},

1700

"revisionId": "A String", # A revision ID.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1701

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1702

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

1703

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

1704

"kind": "A String", # The alias kind.

1705

"name": "A String", # The alias name.

1706

},

1707

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

1708

"hostUri": "A String", # The URI of a running Gerrit instance.

1709

"revisionId": "A String", # A revision (commit) ID.

1710

},

1711

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

1712

"revisionId": "A String", # Git commit hash.

1713

"url": "A String", # Git repository URL.

1714

},

1715

"labels": { # Labels with user defined metadata.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1716

"a_key": "A String",

1717

},

1718

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1719

"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file.

1720

"a_key": { # Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build.

1721

"fileHash": [ # Required. Collection of file hashes.

1722

{ # Container message for hash values.

1723

"type": "A String", # Required. The type of hash that was performed.

1724

"value": "A String", # Required. The hash value.

},

],

},

},

},

"startTime": "A String", # Time at which execution of the build was started.

1731

"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.

1732

},

1733

"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes.

1734

},

1735

"createTime": "A String", # Output only. The time this occurrence was created.

1736

"deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.

1737

"deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.

1738

"address": "A String", # Address of the runtime element hosting this deployment.

1739

"config": "A String", # Configuration used to create this deployment.

1740

"deployTime": "A String", # Required. Beginning of the lifetime of this deployment.

1741

"platform": "A String", # Platform hosting this deployment.

1742

"resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.

1743

"A String",

1744

],

1745

"undeployTime": "A String", # End of the lifetime of this deployment.

1746

"userEmail": "A String", # Identity of the user that triggered this deployment.

1747

},

1748

},

1749

"derivedImage": { # Details of an image occurrence. # Describes how this resource derives from the basis in the associated note.

1750

"derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Required. Immutable. The child image derived from the base image.

1751

"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.

1752

"distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.

1753

"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.

1754

"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.

1755

"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1756

"A String",

1757

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1758

"v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1759

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1760

"layerInfo": [ # This contains layer-specific metadata, if populated it has length "distance" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer.

1761

{ # Layer holds metadata specific to a layer of a Docker image.

1762

"arguments": "A String", # The recovered arguments to the Dockerfile directive.

1763

"directive": "A String", # Required. The recovered Dockerfile directive used to construct this layer.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1764

},

1765

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1766

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1767

},

1768

"discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered.

1769

"discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource.

1770

"analysisStatus": "A String", # The status of discovery for the resource.

1771

"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API.

1772

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1773

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

1774

{

1775

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1776

},

1777

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1778

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

1779

},

1780

"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.

1781

"lastAnalysisTime": "A String", # The last time continuous analysis was done for this resource. Deprecated, do not use.

1782

},

1783

},

1784

"installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.

1785

"installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.

1786

"location": [ # Required. All of the places within the filesystem versions of this package have been found.

1787

{ # An occurrence of a particular package installation found within a system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.

1788

"cpeUri": "A String", # Required. The CPE URI in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.

1789

"path": "A String", # The path from which we gathered that this package/version is installed.

1790

"version": { # Version contains structured information about the version of a package. # The version installed at this location.

1791

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1792

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1793

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

1794

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

1795

"revision": "A String", # The iteration of the package build from the above version.

},

},

],

"name": "A String", # Output only. The name of the installed package.

1800

},

1801

},

1802

"intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.

1803

"signatures": [

1804

{ # A signature object consists of the KeyID used and the signature itself.

"keyid": "A String",

"sig": "A String",

},

],

"signed": { # This corresponds to an in-toto link.

1810

"byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.

1811

"customValues": {

1812

"a_key": "A String",

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1813

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1814

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1815

"command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]

1816

"A String",

1817

],

1818

"environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }

1819

"customValues": {

1820

"a_key": "A String",

1821

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1822

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1823

"materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]

1824

{

1825

"hashes": { # Defines a hash object for use in Materials and Products.

1826

"sha256": "A String",

1827

},

1828

"resourceUri": "A String",

1829

},

1830

],

1831

"products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.

1832

{

1833

"hashes": { # Defines a hash object for use in Materials and Products.

1834

"sha256": "A String",

1835

},

1836

"resourceUri": "A String",

1837

},

1838

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1839

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1840

},

1841

"kind": "A String", # Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests.

1842

"name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.

1843

"noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.

1844

"remediation": "A String", # A description of actions that can be taken to remedy the note.

1845

"resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.

1846

"contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.

1847

"type": "A String", # Required. The type of hash that was performed.

1848

"value": "A String", # Required. The hash value.

1849

},

1850

"name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".

1851

"uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.

1852

},

yoshi-code-bot

2021-08-03 00:20:27 -0700

[diff] [blame^]

1853

"sbom": { # DocumentOccurrence represents an SPDX Document Creation Information section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # Describes a specific SPDX Document.

1854

"createTime": "A String", # Identify when the SPDX file was originally created. The date is to be specified according to combined date and time in UTC format as specified in ISO 8601 standard

1855

"creatorComment": "A String", # A field for creators of the SPDX file to provide general comments about the creation of the SPDX file or any other relevant comment not included in the other fields

1856

"creators": [ # Identify who (or what, in the case of a tool) created the SPDX file. If the SPDX file was created by an individual, indicate the person's name

1857

"A String",

1858

],

1859

"documentComment": "A String", # A field for creators of the SPDX file content to provide comments to the consumers of the SPDX document

1860

"externalDocumentRefs": [ # Identify any external SPDX documents referenced within this SPDX document

1861

"A String",

1862

],

1863

"id": "A String", # Identify the current SPDX document which may be referenced in relationships by other files, packages internally and documents externally

1864

"licenseListVersion": "A String", # A field for creators of the SPDX file to provide the version of the SPDX License List used when the SPDX file was created

1865

"namespace": "A String", # Provide an SPDX document specific namespace as a unique absolute Uniform Resource Identifier (URI) as specified in RFC-3986, with the exception of the ‘#’ delimiter

1866

"title": "A String", # Identify name of this document as designated by creator

1867

},

1868

"spdxFile": { # FileOccurrence represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # Describes a specific SPDX File.

1869

"attributions": [ # This field provides a place for the SPDX data creator to record, at the file level, acknowledgements that may be needed to be communicated in some contexts

1870

"A String",

1871

],

1872

"comment": "A String", # This field provides a place for the SPDX file creator to record any general comments about the file

1873

"contributors": [ # This field provides a place for the SPDX file creator to record file contributors

1874

"A String",

1875

],

1876

"copyright": "A String", # Identify the copyright holder of the file, as well as any dates present

1877

"filesLicenseInfo": [ # This field contains the license information actually found in the file, if any

1878

"A String",

1879

],

1880

"id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements

1881

"licenseComments": "A String", # This field provides a place for the SPDX file creator to record any relevant background references or analysis that went in to arriving at the Concluded License for a file

1882

"licenseConcluded": "A String", # This field contains the license the SPDX file creator has concluded as governing the file or alternative values if the governing license cannot be determined

1883

"notice": "A String", # This field provides a place for the SPDX file creator to record license notices or other such related notices found in the file

1884

},

1885

"spdxPackage": { # PackageOccurrence represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # Describes a specific SPDX Package.

1886

"comment": "A String", # A place for the SPDX file creator to record any general comments about the package being described

1887

"filename": "A String", # Provide the actual file name of the package, or path of the directory being treated as a package

1888

"id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements

1889

"licenseComments": "A String", # This field provides a place for the SPDX file creator to record any relevant background information or analysis that went in to arriving at the Concluded License for a package

1890

"licenseConcluded": "A String", # package or alternative values, if the governing license cannot be determined

1891

"sourceInfo": "A String", # Provide a place for the SPDX file creator to record any relevant background information or additional comments about the origin of the package

1892

},

1893

"spdxRelationship": { # RelationshipOccurrence represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # Describes a specific SPDX Relationship.

1894

"comment": "A String", # A place for the SPDX file creator to record any general comments about the relationship

1895

"source": "A String", # Also referred to as SPDXRef-A The source SPDX element (file, package, etc)

1896

"target": "A String", # Also referred to as SPDXRef-B The target SPDC element (file, package, etc) In cases where there are "known unknowns", the use of the keyword NOASSERTION can be used The keywords NONE can be used to indicate that an SPDX element (package/file/snippet) has no other elements connected by some relationship to it

1897

"type": "A String", # The type of relationship between the source and target SPDX elements

1898

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1899

"updateTime": "A String", # Output only. The time this occurrence was last updated.

1900

"vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability.

1901

"cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity.

1902

"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.

1903

"longDescription": "A String", # Output only. A detailed description of this vulnerability.

1904

"packageIssue": [ # Required. The set of affected locations and their fixes (if available) within the associated resource.

1905

{ # This message wraps a location affected by a vulnerability and its associated fix (if one is available).

1906

"affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.

1907

"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.

1908

"package": "A String", # Required. The package being described.

1909

"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.

1910

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1911

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1912

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

1913

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

1914

"revision": "A String", # The iteration of the package build from the above version.

1915

},

1916

},

1917

"fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.

1918

"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.

1919

"package": "A String", # Required. The package being described.

1920

"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.

1921

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1922

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1923

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

1924

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

1925

"revision": "A String", # The iteration of the package build from the above version.

1926

},

1927

},

1928

"severityName": "A String", # Deprecated, use Details.effective_severity instead The severity (e.g., distro assigned severity) for this vulnerability.

1929

},

1930

],

1931

"relatedUrls": [ # Output only. URLs related to this vulnerability.

1932

{ # Metadata for any related URL information.

1933

"label": "A String", # Label to describe usage of the URL.

1934

"url": "A String", # Specific URL associated with the resource.

1935

},

1936

],

1937

"severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.

1938

"shortDescription": "A String", # Output only. A one sentence description of this vulnerability.

1939

"type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)

1940

},

1941

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1946

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1947

1948

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1949

resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1950

body: object, The request body.

1951

The object takes the form of:

1952

1953

{ # Request message for `GetIamPolicy` method.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1954

"options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.

1955

"requestedPolicyVersion": 42, # Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1956

},

1957

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1958

1959

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1966

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1967

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1968

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

1969

{ # Associates `members` with a `role`.

1970

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1971

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

1972

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1973

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

1974

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1975

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1976

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

1977

"A String",

1978

],

1979

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

1980

},

1981

],

1982

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

1983

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1984

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="getNotes">getNotes(name, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1989

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1990

1991

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1992

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1993

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2000

2001

{ # A type of analysis that can be done for a resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2002

"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.

2003

"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.

2004

"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".

2005

},

2006

},

2007

"baseImage": { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.

2008

"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.

2009

"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.

2010

"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.

2011

"A String",

2012

],

2013

"v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.

2014

},

2015

"resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.

2016

},

2017

"build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build.

2018

"builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.

2019

"signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details.

2020

"keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).

2021

"keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`.

2022

"publicKey": "A String", # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`

2023

"signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded.

2024

},

2025

},

2026

"createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.

2027

"deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.

2028

"resourceUri": [ # Required. Resource URI for the artifact being deployed.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2029

"A String",

2030

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2031

},

2032

"discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource.

2033

"analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery.

2034

},

2035

"expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.

2036

"intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link.

2037

"expectedCommand": [ # This field contains the expected command used to perform the step.

2038

"A String",

2039

],

2040

"expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step.

2041

{ # Defines an object to declare an in-toto artifact rule

2042

"artifactRule": [

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2043

"A String",

2044

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2045

},

2046

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2047

"expectedProducts": [

2048

{ # Defines an object to declare an in-toto artifact rule

"artifactRule": [

"A String",

],

},

],

"signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata.

2055

{ # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification.

2056

"keyId": "A String", # key_id is an identifier for the signing key.

2057

"keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256".

2058

"keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa".

2059

"publicKeyValue": "A String", # This field contains the actual public key.

2060

},

2061

],

2062

"stepName": "A String", # This field identifies the name of the step in the supply chain.

2063

"threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link.

2064

},

2065

"kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests.

2066

"longDescription": "A String", # A detailed description of this note.

2067

"name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.

2068

"package": { # This represents a particular package that is distributed over various channels. E.g., glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.

2069

"distribution": [ # The various channels by which a package is distributed.

2070

{ # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.

2071

"architecture": "A String", # The CPU architecture for which packages in this distribution channel were built.

2072

"cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.

2073

"description": "A String", # The distribution channel-specific description of this package.

2074

"latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.

2075

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2076

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2077

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

2078

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

2079

"revision": "A String", # The iteration of the package build from the above version.

2080

},

2081

"maintainer": "A String", # A freeform string denoting the maintainer of this package.

2082

"url": "A String", # The distribution channel-specific homepage for this package.

2083

},

2084

],

2085

"name": "A String", # Required. Immutable. The name of the package.

2086

},

2087

"relatedNoteNames": [ # Other notes related to this note.

2088

"A String",

2089

],

2090

"relatedUrl": [ # URLs associated with this note.

2091

{ # Metadata for any related URL information.

2092

"label": "A String", # Label to describe usage of the URL.

2093

"url": "A String", # Specific URL associated with the resource.

2094

},

2095

],

yoshi-code-bot

2021-08-03 00:20:27 -0700

[diff] [blame^]

2096

"sbom": { # DocumentNote represents an SPDX Document Creation Infromation section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # A note describing SPDX Document which represents SBOM.

2097

"dataLicence": "A String", # Compliance with the SPDX specification includes populating the SPDX fields therein with data related to such fields ("SPDX-Metadata")

2098

"spdxVersion": "A String", # Provide a reference number that can be used to understand how to parse and interpret the rest of the file

2099

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2100

"shortDescription": "A String", # A one sentence description of this note.

yoshi-code-bot

2021-08-03 00:20:27 -0700

[diff] [blame^]

2101

"spdxFile": { # FileNote represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # A note describing SPDX File.

2102

"checksum": [ # Provide a unique identifier to match analysis information on each specific file in a package

2103

"A String",

2104

],

2105

"fileType": "A String", # This field provides information about the type of file identified

2106

"title": "A String", # Identify the full path and filename that corresponds to the file information in this section

2107

},

2108

"spdxPackage": { # PackageNote represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # A note describing SPDX Package.

2109

"analyzed": True or False, # Indicates whether the file content of this package has been available for or subjected to analysis when creating the SPDX document

2110

"attribution": "A String", # A place for the SPDX data creator to record, at the package level, acknowledgements that may be needed to be communicated in some contexts

2111

"checksum": "A String", # Provide an independently reproducible mechanism that permits unique identification of a specific package that correlates to the data in this SPDX file

2112

"copyright": "A String", # Identify the copyright holders of the package, as well as any dates present

2113

"detailedDescription": "A String", # A more detailed description of the package

2114

"downloadLocation": "A String", # This section identifies the download Universal Resource Locator (URL), or a specific location within a version control system (VCS) for the package at the time that the SPDX file was created

2115

"externalRefs": [ # ExternalRef

2116

{ # An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package

2117

"category": "A String", # An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package

2118

"comment": "A String", # Human-readable information about the purpose and target of the reference

2119

"locator": "A String", # The unique string with no spaces necessary to access the package-specific information, metadata, or content within the target location

2120

"type": "A String", # Type of category (e.g. 'npm' for the PACKAGE_MANAGER category)

2121

},

2122

],

2123

"filesLicenseInfo": [ # Contain the license the SPDX file creator has concluded as governing the This field is to contain a list of all licenses found in the package. The relationship between licenses (i.e., conjunctive, disjunctive) is not specified in this field – it is simply a listing of all licenses found

2124

"A String",

2125

],

2126

"homePage": "A String", # Provide a place for the SPDX file creator to record a web site that serves as the package's home page

2127

"licenseDeclared": "A String", # List the licenses that have been declared by the authors of the package

2128

"originator": "A String", # If the package identified in the SPDX file originated from a different person or organization than identified as Package Supplier, this field identifies from where or whom the package originally came

2129

"summaryDescription": "A String", # A short description of the package

2130

"supplier": "A String", # Identify the actual distribution source for the package/directory identified in the SPDX file

2131

"title": "A String", # Identify the full name of the package as given by the Package Originator

2132

"verificationCode": "A String", # This field provides an independently reproducible mechanism identifying specific contents of a package based on the actual files (except the SPDX file itself, if it is included in the package) that make up each package and that correlates to the data in this SPDX file

2133

"version": "A String", # Identify the version of the package

2134

},

2135

"spdxRelationship": { # RelationshipNote represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # A note describing SPDX Relationship.

2136

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2137

"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.

2138

"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.

2139

"cvssScore": 3.14, # The CVSS score for this vulnerability.

2140

"cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3.

2141

"attackComplexity": "A String",

2142

"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.

2143

"availabilityImpact": "A String",

2144

"baseScore": 3.14, # The base score is a function of the base metric scores.

2145

"confidentialityImpact": "A String",

2146

"exploitabilityScore": 3.14,

2147

"impactScore": 3.14,

2148

"integrityImpact": "A String",

2149

"privilegesRequired": "A String",

2150

"scope": "A String",

2151

"userInteraction": "A String",

2152

},

2153

"details": [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.

2154

{ # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2

2155

"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.

2156

"description": "A String", # A vendor-specific description of this note.

2157

"fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.

2158

"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.

2159

"package": "A String", # Required. The package being described.

2160

"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2161

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2162

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2163

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2164

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

2165

"revision": "A String", # The iteration of the package build from the above version.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2166

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2167

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2168

"isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.

2169

"maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.

2170

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2171

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2172

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

2173

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

2174

"revision": "A String", # The iteration of the package build from the above version.

2175

},

2176

"minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.

2177

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2178

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2179

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

2180

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

2181

"revision": "A String", # The iteration of the package build from the above version.

2182

},

2183

"package": "A String", # Required. The name of the package where the vulnerability was found.

2184

"packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc).

2185

"severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2186

"source": "A String", # The source from which the information in this Detail was obtained.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2187

"sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.

yoshi-code-bot

3dd1527

2021-04-21 15:07:48 -0700

[diff] [blame]

2188

"vendor": "A String", # The name of the vendor of the product.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2189

},

2190

],

2191

"severity": "A String", # Note provider assigned impact of the vulnerability.

2192

"sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.

2193

"windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version.

2194

{

2195

"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.

2196

"description": "A String", # The description of the vulnerability.

2197

"fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix.

2198

{

2199

"name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).

2200

"url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/

2201

},

2202

],

2203

"name": "A String", # Required. The name of the vulnerability.

},

],

},

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2211

<code class="details" id="getVulnerabilitySummary">getVulnerabilitySummary(parent, filter=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2212

<pre>Gets a summary of the number and severity of occurrences.

2213

2214

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2215

parent: string, Required. The name of the project to get a vulnerability summary for in the form of `projects/[PROJECT_ID]`. (required)

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2216

filter: string, The filter expression.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2217

x__xgafv: string, V1 error format.

2218

Allowed values

2219

1 - v1 error format

2220

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2221

2222

Returns:

2223

An object of the form:

2224

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2225

{ # A summary of how many vulnerability occurrences there are per resource and severity type.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2226

"counts": [ # A listing by resource of the number of fixable and total vulnerabilities.

2227

{ # Per resource and severity counts of fixable and total vulnerabilities.

2228

"fixableCount": "A String", # The number of fixable vulnerabilities associated with this resource.

2229

"resource": { # An entity that can have metadata. For example, a Docker image. # The affected resource.

2230

"contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.

2231

"type": "A String", # Required. The type of hash that was performed.

2232

"value": "A String", # Required. The hash value.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2233

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2234

"name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".

2235

"uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2236

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2237

"severity": "A String", # The severity for this count. SEVERITY_UNSPECIFIED indicates total across all severities.

2238

"totalCount": "A String", # The total number of vulnerabilities associated with this resource.

2239

},

2240

],

2241

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2245

<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2246

<pre>Lists occurrences for the specified project.

2247

2248

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2249

parent: string, Required. The name of the project to list occurrences for in the form of `projects/[PROJECT_ID]`. (required)

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2250

filter: string, The filter expression.

2251

pageSize: integer, Number of occurrences to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2252

pageToken: string, Token to provide to skip to a particular spot in the list.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2253

x__xgafv: string, V1 error format.

2254

Allowed values

2255

1 - v1 error format

2256

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2257

2258

Returns:

2259

An object of the form:

2260

2261

{ # Response for listing occurrences.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2262

"nextPageToken": "A String", # The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results.

2263

"occurrences": [ # The occurrences requested.

2264

{ # An instance of an analysis type that has been found on a resource.

2265

"attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.

2266

"attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for look-up (how to find this attestation if you already know the authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). # Required. Attestation for the resource.

2267

"genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.

2268

"contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema).

2269

"serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.

2270

"signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.

2271

{ # 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).

2272

"publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"

2273

"signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.

2274

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2275

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2276

},

2277

"pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file. # A PGP signed attestation.

2278

"contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema).

2279

"pgpKeyId": "A String", # The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexidecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.

2280

"signature": "A String", # Required. The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2281

},

2282

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2283

},

2284

"build": { # Details of a build occurrence. # Describes a verifiable build.

2285

"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # Required. The actual provenance for the build.

2286

"buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.

2287

"a_key": "A String",

2288

},

2289

"builderVersion": "A String", # Version string of the builder at the time this build was executed.

2290

"builtArtifacts": [ # Output of the build.

2291

{ # Artifact describes a build product.

2292

"checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.

2293

"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.

2294

"names": [ # Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image.

2295

"A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2296

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2297

},

2298

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2299

"commands": [ # Commands requested by the build.

2300

{ # Command describes a step performed as part of the build pipeline.

2301

"args": [ # Command-line arguments used when executing this command.

2302

"A String",

2303

],

2304

"dir": "A String", # Working directory (relative to project source root) used when running this command.

2305

"env": [ # Environment variables set before running this command.

2306

"A String",

2307

],

2308

"id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.

2309

"name": "A String", # Required. Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`.

2310

"waitFor": [ # The ID(s) of the command(s) that this command depends on.

2311

"A String",

2312

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2313

},

2314

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2315

"createTime": "A String", # Time at which the build was created.

2316

"creator": "A String", # E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time.

2317

"endTime": "A String", # Time at which execution of the build was finished.

2318

"id": "A String", # Required. Unique identifier of the build.

2319

"logsUri": "A String", # URI where any logs for this provenance were written.

2320

"projectId": "A String", # ID of the project.

2321

"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.

2322

"additionalContexts": [ # If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field.

2323

{ # 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.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2324

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2325

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

2326

"kind": "A String", # The alias kind.

2327

"name": "A String", # The alias name.

2328

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2329

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2330

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2331

"projectId": "A String", # The ID of the project.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2332

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2333

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2334

"uid": "A String", # A server-assigned, globally unique identifier.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2335

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2336

"revisionId": "A String", # A revision ID.

2337

},

2338

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2339

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2340

"kind": "A String", # The alias kind.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2341

"name": "A String", # The alias name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2342

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2343

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

2344

"hostUri": "A String", # The URI of a running Gerrit instance.

2345

"revisionId": "A String", # A revision (commit) ID.

2346

},

2347

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

2348

"revisionId": "A String", # Git commit hash.

2349

"url": "A String", # Git repository URL.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2350

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2351

"labels": { # Labels with user defined metadata.

2352

"a_key": "A String",

2353

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2354

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2355

],

2356

"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.

2357

"context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # If provided, the source code used for the build came from this location.

2358

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

2359

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

2360

"kind": "A String", # The alias kind.

2361

"name": "A String", # The alias name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2362

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2363

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

2364

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

2365

"projectId": "A String", # The ID of the project.

2366

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

2367

},

2368

"uid": "A String", # A server-assigned, globally unique identifier.

2369

},

2370

"revisionId": "A String", # A revision ID.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2371

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2372

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

2373

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

2374

"kind": "A String", # The alias kind.

2375

"name": "A String", # The alias name.

2376

},

2377

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

2378

"hostUri": "A String", # The URI of a running Gerrit instance.

2379

"revisionId": "A String", # A revision (commit) ID.

2380

},

2381

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

2382

"revisionId": "A String", # Git commit hash.

2383

"url": "A String", # Git repository URL.

2384

},

2385

"labels": { # Labels with user defined metadata.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2386

"a_key": "A String",

2387

},

2388

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2389

"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file.

2390

"a_key": { # Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build.

2391

"fileHash": [ # Required. Collection of file hashes.

2392

{ # Container message for hash values.

2393

"type": "A String", # Required. The type of hash that was performed.

2394

"value": "A String", # Required. The hash value.

},

],

},

},

},

"startTime": "A String", # Time at which execution of the build was started.

2401

"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.

2402

},

2403

"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes.

2404

},

2405

"createTime": "A String", # Output only. The time this occurrence was created.

2406

"deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.

2407

"deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.

2408

"address": "A String", # Address of the runtime element hosting this deployment.

2409

"config": "A String", # Configuration used to create this deployment.

2410

"deployTime": "A String", # Required. Beginning of the lifetime of this deployment.

2411

"platform": "A String", # Platform hosting this deployment.

2412

"resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.

2413

"A String",

2414

],

2415

"undeployTime": "A String", # End of the lifetime of this deployment.

2416

"userEmail": "A String", # Identity of the user that triggered this deployment.

2417

},

2418

},

2419

"derivedImage": { # Details of an image occurrence. # Describes how this resource derives from the basis in the associated note.

2420

"derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Required. Immutable. The child image derived from the base image.

2421

"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.

2422

"distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.

2423

"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.

2424

"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.

2425

"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2426

"A String",

2427

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2428

"v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2429

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2430

"layerInfo": [ # This contains layer-specific metadata, if populated it has length "distance" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer.

2431

{ # Layer holds metadata specific to a layer of a Docker image.

2432

"arguments": "A String", # The recovered arguments to the Dockerfile directive.

2433

"directive": "A String", # Required. The recovered Dockerfile directive used to construct this layer.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2434

},

2435

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2436

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2437

},

2438

"discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered.

2439

"discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource.

2440

"analysisStatus": "A String", # The status of discovery for the resource.

2441

"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API.

2442

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2443

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2444

{

2445

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2446

},

2447

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2448

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2449

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2450

"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.

2451

"lastAnalysisTime": "A String", # The last time continuous analysis was done for this resource. Deprecated, do not use.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2452

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2453

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2454

"installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.

2455

"installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.

2456

"location": [ # Required. All of the places within the filesystem versions of this package have been found.

2457

{ # An occurrence of a particular package installation found within a system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.

2458

"cpeUri": "A String", # Required. The CPE URI in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.

2459

"path": "A String", # The path from which we gathered that this package/version is installed.

2460

"version": { # Version contains structured information about the version of a package. # The version installed at this location.

2461

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2462

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2463

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

2464

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

2465

"revision": "A String", # The iteration of the package build from the above version.

},

},

],

"name": "A String", # Output only. The name of the installed package.

2470

},

2471

},

2472

"intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.

2473

"signatures": [

2474

{ # A signature object consists of the KeyID used and the signature itself.

"keyid": "A String",

"sig": "A String",

},

],

"signed": { # This corresponds to an in-toto link.

2480

"byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.

"customValues": {

"a_key": "A String",

},

},

"command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]

2486

"A String",

2487

],

2488

"environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }

"customValues": {

"a_key": "A String",

},

},

"materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]

2494

{

2495

"hashes": { # Defines a hash object for use in Materials and Products.

2496

"sha256": "A String",

2497

},

2498

"resourceUri": "A String",

2499

},

2500

],

2501

"products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.

2502

{

2503

"hashes": { # Defines a hash object for use in Materials and Products.

2504

"sha256": "A String",

2505

},

2506

"resourceUri": "A String",

},

],

},

},

"kind": "A String", # Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests.

2512

"name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.

2513

"noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.

2514

"remediation": "A String", # A description of actions that can be taken to remedy the note.

2515

"resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.

2516

"contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.

2517

"type": "A String", # Required. The type of hash that was performed.

2518

"value": "A String", # Required. The hash value.

2519

},

2520

"name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".

2521

"uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.

2522

},

yoshi-code-bot

2021-08-03 00:20:27 -0700

[diff] [blame^]

2523

"sbom": { # DocumentOccurrence represents an SPDX Document Creation Information section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # Describes a specific SPDX Document.

2524

"createTime": "A String", # Identify when the SPDX file was originally created. The date is to be specified according to combined date and time in UTC format as specified in ISO 8601 standard

2525

"creatorComment": "A String", # A field for creators of the SPDX file to provide general comments about the creation of the SPDX file or any other relevant comment not included in the other fields

2526

"creators": [ # Identify who (or what, in the case of a tool) created the SPDX file. If the SPDX file was created by an individual, indicate the person's name

2527

"A String",

2528

],

2529

"documentComment": "A String", # A field for creators of the SPDX file content to provide comments to the consumers of the SPDX document

2530

"externalDocumentRefs": [ # Identify any external SPDX documents referenced within this SPDX document

2531

"A String",

2532

],

2533

"id": "A String", # Identify the current SPDX document which may be referenced in relationships by other files, packages internally and documents externally

2534

"licenseListVersion": "A String", # A field for creators of the SPDX file to provide the version of the SPDX License List used when the SPDX file was created

2535

"namespace": "A String", # Provide an SPDX document specific namespace as a unique absolute Uniform Resource Identifier (URI) as specified in RFC-3986, with the exception of the ‘#’ delimiter

2536

"title": "A String", # Identify name of this document as designated by creator

2537

},

2538

"spdxFile": { # FileOccurrence represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # Describes a specific SPDX File.

2539

"attributions": [ # This field provides a place for the SPDX data creator to record, at the file level, acknowledgements that may be needed to be communicated in some contexts

2540

"A String",

2541

],

2542

"comment": "A String", # This field provides a place for the SPDX file creator to record any general comments about the file

2543

"contributors": [ # This field provides a place for the SPDX file creator to record file contributors

2544

"A String",

2545

],

2546

"copyright": "A String", # Identify the copyright holder of the file, as well as any dates present

2547

"filesLicenseInfo": [ # This field contains the license information actually found in the file, if any

2548

"A String",

2549

],

2550

"id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements

2551

"licenseComments": "A String", # This field provides a place for the SPDX file creator to record any relevant background references or analysis that went in to arriving at the Concluded License for a file

2552

"licenseConcluded": "A String", # This field contains the license the SPDX file creator has concluded as governing the file or alternative values if the governing license cannot be determined

2553

"notice": "A String", # This field provides a place for the SPDX file creator to record license notices or other such related notices found in the file

2554

},

2555

"spdxPackage": { # PackageOccurrence represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # Describes a specific SPDX Package.

2556

"comment": "A String", # A place for the SPDX file creator to record any general comments about the package being described

2557

"filename": "A String", # Provide the actual file name of the package, or path of the directory being treated as a package

2558

"id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements

2559

"licenseComments": "A String", # This field provides a place for the SPDX file creator to record any relevant background information or analysis that went in to arriving at the Concluded License for a package

2560

"licenseConcluded": "A String", # package or alternative values, if the governing license cannot be determined

2561

"sourceInfo": "A String", # Provide a place for the SPDX file creator to record any relevant background information or additional comments about the origin of the package

2562

},

2563

"spdxRelationship": { # RelationshipOccurrence represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # Describes a specific SPDX Relationship.

2564

"comment": "A String", # A place for the SPDX file creator to record any general comments about the relationship

2565

"source": "A String", # Also referred to as SPDXRef-A The source SPDX element (file, package, etc)

2566

"target": "A String", # Also referred to as SPDXRef-B The target SPDC element (file, package, etc) In cases where there are "known unknowns", the use of the keyword NOASSERTION can be used The keywords NONE can be used to indicate that an SPDX element (package/file/snippet) has no other elements connected by some relationship to it

2567

"type": "A String", # The type of relationship between the source and target SPDX elements

2568

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2569

"updateTime": "A String", # Output only. The time this occurrence was last updated.

2570

"vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability.

2571

"cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity.

2572

"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.

2573

"longDescription": "A String", # Output only. A detailed description of this vulnerability.

2574

"packageIssue": [ # Required. The set of affected locations and their fixes (if available) within the associated resource.

2575

{ # This message wraps a location affected by a vulnerability and its associated fix (if one is available).

2576

"affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.

2577

"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.

2578

"package": "A String", # Required. The package being described.

2579

"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.

2580

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2581

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2582

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

2583

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

2584

"revision": "A String", # The iteration of the package build from the above version.

2585

},

2586

},

2587

"fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.

2588

"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.

2589

"package": "A String", # Required. The package being described.

2590

"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.

2591

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2592

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2593

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

2594

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

2595

"revision": "A String", # The iteration of the package build from the above version.

2596

},

2597

},

2598

"severityName": "A String", # Deprecated, use Details.effective_severity instead The severity (e.g., distro assigned severity) for this vulnerability.

2599

},

2600

],

2601

"relatedUrls": [ # Output only. URLs related to this vulnerability.

2602

{ # Metadata for any related URL information.

2603

"label": "A String", # Label to describe usage of the URL.

2604

"url": "A String", # Specific URL associated with the resource.

2605

},

2606

],

2607

"severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.

2608

"shortDescription": "A String", # Output only. A one sentence description of this vulnerability.

2609

"type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)

},

},

],

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

2618

<pre>Retrieves the next page of results.

2619

2620

Args:

2621

previous_request: The request for the previous page. (required)

2622

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

2623

2624

Returns:

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

2625

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2626

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2631

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2632

<pre>Updates the specified occurrence.

2633

2634

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2635

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2636

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2637

The object takes the form of:

2638

2639

{ # An instance of an analysis type that has been found on a resource.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2640

"attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.

2641

"attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for look-up (how to find this attestation if you already know the authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). # Required. Attestation for the resource.

2642

"genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2643

"contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2644

"serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.

2645

"signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.

2646

{ # 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).

2647

"publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"

2648

"signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.

2649

},

2650

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2651

},

2652

"pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file. # A PGP signed attestation.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2653

"contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2654

"pgpKeyId": "A String", # The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexidecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.

2655

"signature": "A String", # Required. The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2656

},

2657

},

2658

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2659

"build": { # Details of a build occurrence. # Describes a verifiable build.

2660

"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # Required. The actual provenance for the build.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2661

"buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.

2662

"a_key": "A String",

2663

},

2664

"builderVersion": "A String", # Version string of the builder at the time this build was executed.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2665

"builtArtifacts": [ # Output of the build.

2666

{ # Artifact describes a build product.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2667

"checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2668

"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2669

"names": [ # Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image.

2670

"A String",

2671

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2672

},

2673

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2674

"commands": [ # Commands requested by the build.

2675

{ # Command describes a step performed as part of the build pipeline.

2676

"args": [ # Command-line arguments used when executing this command.

2677

"A String",

2678

],

2679

"dir": "A String", # Working directory (relative to project source root) used when running this command.

2680

"env": [ # Environment variables set before running this command.

2681

"A String",

2682

],

2683

"id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.

2684

"name": "A String", # Required. Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`.

2685

"waitFor": [ # The ID(s) of the command(s) that this command depends on.

"A String",

],

},

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2690

"createTime": "A String", # Time at which the build was created.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2691

"creator": "A String", # E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time.

2692

"endTime": "A String", # Time at which execution of the build was finished.

2693

"id": "A String", # Required. Unique identifier of the build.

2694

"logsUri": "A String", # URI where any logs for this provenance were written.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2695

"projectId": "A String", # ID of the project.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

2696

"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2697

"additionalContexts": [ # If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field.

2698

{ # 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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2699

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2700

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

2701

"kind": "A String", # The alias kind.

2702

"name": "A String", # The alias name.

2703

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2704

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2705

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2706

"projectId": "A String", # The ID of the project.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2707

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2708

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2709

"uid": "A String", # A server-assigned, globally unique identifier.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2710

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2711

"revisionId": "A String", # A revision ID.

2712

},

2713

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2714

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2715

"kind": "A String", # The alias kind.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2716

"name": "A String", # The alias name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2717

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2718

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

2719

"hostUri": "A String", # The URI of a running Gerrit instance.

2720

"revisionId": "A String", # A revision (commit) ID.

2721

},

2722

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

2723

"revisionId": "A String", # Git commit hash.

2724

"url": "A String", # Git repository URL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2725

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2726

"labels": { # Labels with user defined metadata.

2727

"a_key": "A String",

2728

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2729

},

2730

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2731

"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2732

"context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # If provided, the source code used for the build came from this location.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2733

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2734

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

2735

"kind": "A String", # The alias kind.

2736

"name": "A String", # The alias name.

2737

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2738

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2739

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2740

"projectId": "A String", # The ID of the project.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2741

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2742

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2743

"uid": "A String", # A server-assigned, globally unique identifier.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2744

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2745

"revisionId": "A String", # A revision ID.

2746

},

2747

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2748

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2749

"kind": "A String", # The alias kind.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2750

"name": "A String", # The alias name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2751

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2752

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

2753

"hostUri": "A String", # The URI of a running Gerrit instance.

2754

"revisionId": "A String", # A revision (commit) ID.

2755

},

2756

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

2757

"revisionId": "A String", # Git commit hash.

2758

"url": "A String", # Git repository URL.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2759

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2760

"labels": { # Labels with user defined metadata.

2761

"a_key": "A String",

2762

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2763

},

2764

"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file.

2765

"a_key": { # Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build.

2766

"fileHash": [ # Required. Collection of file hashes.

2767

{ # Container message for hash values.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2768

"type": "A String", # Required. The type of hash that was performed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2769

"value": "A String", # Required. The hash value.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

},

],

},

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

2774

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2775

"startTime": "A String", # Time at which execution of the build was started.

2776

"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.

2777

},

2778

"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes.

2779

},

2780

"createTime": "A String", # Output only. The time this occurrence was created.

2781

"deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.

2782

"deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.

2783

"address": "A String", # Address of the runtime element hosting this deployment.

2784

"config": "A String", # Configuration used to create this deployment.

2785

"deployTime": "A String", # Required. Beginning of the lifetime of this deployment.

2786

"platform": "A String", # Platform hosting this deployment.

2787

"resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.

2788

"A String",

2789

],

2790

"undeployTime": "A String", # End of the lifetime of this deployment.

2791

"userEmail": "A String", # Identity of the user that triggered this deployment.

2792

},

2793

},

2794

"derivedImage": { # Details of an image occurrence. # Describes how this resource derives from the basis in the associated note.

2795

"derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Required. Immutable. The child image derived from the base image.

2796

"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.

2797

"distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.

2798

"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.

2799

"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.

2800

"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.

2801

"A String",

2802

],

2803

"v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.

2804

},

2805

"layerInfo": [ # This contains layer-specific metadata, if populated it has length "distance" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer.

2806

{ # Layer holds metadata specific to a layer of a Docker image.

2807

"arguments": "A String", # The recovered arguments to the Dockerfile directive.

2808

"directive": "A String", # Required. The recovered Dockerfile directive used to construct this layer.

},

],

},

},

"discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered.

2814

"discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource.

2815

"analysisStatus": "A String", # The status of discovery for the resource.

2816

"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API.

2817

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2818

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2819

{

2820

"a_key": "", # Properties of the object. Contains field @type with type URL.

2821

},

2822

],

2823

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

2824

},

2825

"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.

2826

"lastAnalysisTime": "A String", # The last time continuous analysis was done for this resource. Deprecated, do not use.

2827

},

2828

},

2829

"installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.

2830

"installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.

2831

"location": [ # Required. All of the places within the filesystem versions of this package have been found.

2832

{ # An occurrence of a particular package installation found within a system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.

2833

"cpeUri": "A String", # Required. The CPE URI in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.

2834

"path": "A String", # The path from which we gathered that this package/version is installed.

2835

"version": { # Version contains structured information about the version of a package. # The version installed at this location.

2836

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2837

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2838

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

2839

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

2840

"revision": "A String", # The iteration of the package build from the above version.

},

},

],

"name": "A String", # Output only. The name of the installed package.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2845

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2846

},

2847

"intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2848

"signatures": [

2849

{ # A signature object consists of the KeyID used and the signature itself.

"keyid": "A String",

"sig": "A String",

},

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2854

"signed": { # This corresponds to an in-toto link.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2855

"byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

"customValues": {

"a_key": "A String",

},

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2860

"command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]

2861

"A String",

2862

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2863

"environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

"customValues": {

"a_key": "A String",

},

},

"materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]

2869

{

2870

"hashes": { # Defines a hash object for use in Materials and Products.

2871

"sha256": "A String",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2872

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2873

"resourceUri": "A String",

2874

},

2875

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2876

"products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.

2877

{

2878

"hashes": { # Defines a hash object for use in Materials and Products.

2879

"sha256": "A String",

2880

},

2881

"resourceUri": "A String",

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2882

},

2883

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2884

},

2885

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2886

"kind": "A String", # Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2887

"name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2888

"noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2889

"remediation": "A String", # A description of actions that can be taken to remedy the note.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2890

"resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.

2891

"contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2892

"type": "A String", # Required. The type of hash that was performed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2893

"value": "A String", # Required. The hash value.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2894

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2895

"name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2896

"uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.

2897

},

yoshi-code-bot

2021-08-03 00:20:27 -0700

[diff] [blame^]

2898

"sbom": { # DocumentOccurrence represents an SPDX Document Creation Information section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # Describes a specific SPDX Document.

2899

"createTime": "A String", # Identify when the SPDX file was originally created. The date is to be specified according to combined date and time in UTC format as specified in ISO 8601 standard

2900

"creatorComment": "A String", # A field for creators of the SPDX file to provide general comments about the creation of the SPDX file or any other relevant comment not included in the other fields

2901

"creators": [ # Identify who (or what, in the case of a tool) created the SPDX file. If the SPDX file was created by an individual, indicate the person's name

2902

"A String",

2903

],

2904

"documentComment": "A String", # A field for creators of the SPDX file content to provide comments to the consumers of the SPDX document

2905

"externalDocumentRefs": [ # Identify any external SPDX documents referenced within this SPDX document

2906

"A String",

2907

],

2908

"id": "A String", # Identify the current SPDX document which may be referenced in relationships by other files, packages internally and documents externally

2909

"licenseListVersion": "A String", # A field for creators of the SPDX file to provide the version of the SPDX License List used when the SPDX file was created

2910

"namespace": "A String", # Provide an SPDX document specific namespace as a unique absolute Uniform Resource Identifier (URI) as specified in RFC-3986, with the exception of the ‘#’ delimiter

2911

"title": "A String", # Identify name of this document as designated by creator

2912

},

2913

"spdxFile": { # FileOccurrence represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # Describes a specific SPDX File.

2914

"attributions": [ # This field provides a place for the SPDX data creator to record, at the file level, acknowledgements that may be needed to be communicated in some contexts

2915

"A String",

2916

],

2917

"comment": "A String", # This field provides a place for the SPDX file creator to record any general comments about the file

2918

"contributors": [ # This field provides a place for the SPDX file creator to record file contributors

2919

"A String",

2920

],

2921

"copyright": "A String", # Identify the copyright holder of the file, as well as any dates present

2922

"filesLicenseInfo": [ # This field contains the license information actually found in the file, if any

2923

"A String",

2924

],

2925

"id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements

2926

"licenseComments": "A String", # This field provides a place for the SPDX file creator to record any relevant background references or analysis that went in to arriving at the Concluded License for a file

2927

"licenseConcluded": "A String", # This field contains the license the SPDX file creator has concluded as governing the file or alternative values if the governing license cannot be determined

2928

"notice": "A String", # This field provides a place for the SPDX file creator to record license notices or other such related notices found in the file

2929

},

2930

"spdxPackage": { # PackageOccurrence represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # Describes a specific SPDX Package.

2931

"comment": "A String", # A place for the SPDX file creator to record any general comments about the package being described

2932

"filename": "A String", # Provide the actual file name of the package, or path of the directory being treated as a package

2933

"id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements

2934

"licenseComments": "A String", # This field provides a place for the SPDX file creator to record any relevant background information or analysis that went in to arriving at the Concluded License for a package

2935

"licenseConcluded": "A String", # package or alternative values, if the governing license cannot be determined

2936

"sourceInfo": "A String", # Provide a place for the SPDX file creator to record any relevant background information or additional comments about the origin of the package

2937

},

2938

"spdxRelationship": { # RelationshipOccurrence represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # Describes a specific SPDX Relationship.

2939

"comment": "A String", # A place for the SPDX file creator to record any general comments about the relationship

2940

"source": "A String", # Also referred to as SPDXRef-A The source SPDX element (file, package, etc)

2941

"target": "A String", # Also referred to as SPDXRef-B The target SPDC element (file, package, etc) In cases where there are "known unknowns", the use of the keyword NOASSERTION can be used The keywords NONE can be used to indicate that an SPDX element (package/file/snippet) has no other elements connected by some relationship to it

2942

"type": "A String", # The type of relationship between the source and target SPDX elements

2943

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2944

"updateTime": "A String", # Output only. The time this occurrence was last updated.

2945

"vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability.

2946

"cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity.

2947

"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.

2948

"longDescription": "A String", # Output only. A detailed description of this vulnerability.

2949

"packageIssue": [ # Required. The set of affected locations and their fixes (if available) within the associated resource.

2950

{ # This message wraps a location affected by a vulnerability and its associated fix (if one is available).

2951

"affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.

2952

"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.

2953

"package": "A String", # Required. The package being described.

2954

"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.

2955

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2956

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2957

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

2958

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

2959

"revision": "A String", # The iteration of the package build from the above version.

2960

},

2961

},

2962

"fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.

2963

"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.

2964

"package": "A String", # Required. The package being described.

2965

"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.

2966

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2967

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2968

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

2969

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

2970

"revision": "A String", # The iteration of the package build from the above version.

2971

},

2972

},

2973

"severityName": "A String", # Deprecated, use Details.effective_severity instead The severity (e.g., distro assigned severity) for this vulnerability.

2974

},

2975

],

2976

"relatedUrls": [ # Output only. URLs related to this vulnerability.

2977

{ # Metadata for any related URL information.

2978

"label": "A String", # Label to describe usage of the URL.

2979

"url": "A String", # Specific URL associated with the resource.

2980

},

2981

],

2982

"severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.

2983

"shortDescription": "A String", # Output only. A one sentence description of this vulnerability.

2984

"type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2985

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2986

}

2987

2988

updateMask: string, The fields to update.

2989

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2996

2997

{ # An instance of an analysis type that has been found on a resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2998

"attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.

2999

"attestation": { # Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for look-up (how to find this attestation if you already know the authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). # Required. Attestation for the resource.

3000

"genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.

3001

"contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema).

3002

"serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.

3003

"signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.

3004

{ # 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).

3005

"publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"

3006

"signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.

3007

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3008

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3009

},

3010

"pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file. # A PGP signed attestation.

3011

"contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema).

3012

"pgpKeyId": "A String", # The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexidecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.

3013

"signature": "A String", # Required. The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3014

},

3015

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3016

},

3017

"build": { # Details of a build occurrence. # Describes a verifiable build.

3018

"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # Required. The actual provenance for the build.

3019

"buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.

3020

"a_key": "A String",

3021

},

3022

"builderVersion": "A String", # Version string of the builder at the time this build was executed.

3023

"builtArtifacts": [ # Output of the build.

3024

{ # Artifact describes a build product.

3025

"checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.

3026

"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.

3027

"names": [ # Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image.

3028

"A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3029

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3030

},

3031

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3032

"commands": [ # Commands requested by the build.

3033

{ # Command describes a step performed as part of the build pipeline.

3034

"args": [ # Command-line arguments used when executing this command.

3035

"A String",

3036

],

3037

"dir": "A String", # Working directory (relative to project source root) used when running this command.

3038

"env": [ # Environment variables set before running this command.

3039

"A String",

3040

],

3041

"id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.

3042

"name": "A String", # Required. Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`.

3043

"waitFor": [ # The ID(s) of the command(s) that this command depends on.

3044

"A String",

3045

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3046

},

3047

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3048

"createTime": "A String", # Time at which the build was created.

3049

"creator": "A String", # E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time.

3050

"endTime": "A String", # Time at which execution of the build was finished.

3051

"id": "A String", # Required. Unique identifier of the build.

3052

"logsUri": "A String", # URI where any logs for this provenance were written.

3053

"projectId": "A String", # ID of the project.

3054

"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.

3055

"additionalContexts": [ # If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field.

3056

{ # 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.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3057

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3058

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

3059

"kind": "A String", # The alias kind.

3060

"name": "A String", # The alias name.

3061

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3062

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3063

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3064

"projectId": "A String", # The ID of the project.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3065

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3066

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3067

"uid": "A String", # A server-assigned, globally unique identifier.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3068

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3069

"revisionId": "A String", # A revision ID.

3070

},

3071

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3072

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3073

"kind": "A String", # The alias kind.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3074

"name": "A String", # The alias name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3075

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3076

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

3077

"hostUri": "A String", # The URI of a running Gerrit instance.

3078

"revisionId": "A String", # A revision (commit) ID.

3079

},

3080

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

3081

"revisionId": "A String", # Git commit hash.

3082

"url": "A String", # Git repository URL.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3083

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3084

"labels": { # Labels with user defined metadata.

3085

"a_key": "A String",

3086

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3087

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3088

],

3089

"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.

3090

"context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # If provided, the source code used for the build came from this location.

3091

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

3092

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

3093

"kind": "A String", # The alias kind.

3094

"name": "A String", # The alias name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3095

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3096

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

3097

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

3098

"projectId": "A String", # The ID of the project.

3099

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

3100

},

3101

"uid": "A String", # A server-assigned, globally unique identifier.

3102

},

3103

"revisionId": "A String", # A revision ID.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3104

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3105

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

3106

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

3107

"kind": "A String", # The alias kind.

3108

"name": "A String", # The alias name.

3109

},

3110

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

3111

"hostUri": "A String", # The URI of a running Gerrit instance.

3112

"revisionId": "A String", # A revision (commit) ID.

3113

},

3114

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

3115

"revisionId": "A String", # Git commit hash.

3116

"url": "A String", # Git repository URL.

3117

},

3118

"labels": { # Labels with user defined metadata.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3119

"a_key": "A String",

3120

},

3121

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3122

"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file.

3123

"a_key": { # Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build.

3124

"fileHash": [ # Required. Collection of file hashes.

3125

{ # Container message for hash values.

3126

"type": "A String", # Required. The type of hash that was performed.

3127

"value": "A String", # Required. The hash value.

},

],

},

},

},

"startTime": "A String", # Time at which execution of the build was started.

3134

"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.

3135

},

3136

"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes.

3137

},

3138

"createTime": "A String", # Output only. The time this occurrence was created.

3139

"deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.

3140

"deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.

3141

"address": "A String", # Address of the runtime element hosting this deployment.

3142

"config": "A String", # Configuration used to create this deployment.

3143

"deployTime": "A String", # Required. Beginning of the lifetime of this deployment.

3144

"platform": "A String", # Platform hosting this deployment.

3145

"resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.

3146

"A String",

3147

],

3148

"undeployTime": "A String", # End of the lifetime of this deployment.

3149

"userEmail": "A String", # Identity of the user that triggered this deployment.

3150

},

3151

},

3152

"derivedImage": { # Details of an image occurrence. # Describes how this resource derives from the basis in the associated note.

3153

"derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Required. Immutable. The child image derived from the base image.

3154

"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.

3155

"distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.

3156

"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.

3157

"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.

3158

"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3159

"A String",

3160

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3161

"v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

3162

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3163

"layerInfo": [ # This contains layer-specific metadata, if populated it has length "distance" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer.

3164

{ # Layer holds metadata specific to a layer of a Docker image.

3165

"arguments": "A String", # The recovered arguments to the Dockerfile directive.

3166

"directive": "A String", # Required. The recovered Dockerfile directive used to construct this layer.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3167

},

3168

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

3169

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3170

},

3171

"discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered.

3172

"discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource.

3173

"analysisStatus": "A String", # The status of discovery for the resource.

3174

"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API.

3175

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

3176

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

3177

{

3178

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3179

},

3180

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3181

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

3182

},

3183

"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.

3184

"lastAnalysisTime": "A String", # The last time continuous analysis was done for this resource. Deprecated, do not use.

3185

},

3186

},

3187

"installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.

3188

"installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.

3189

"location": [ # Required. All of the places within the filesystem versions of this package have been found.

3190

{ # An occurrence of a particular package installation found within a system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.

3191

"cpeUri": "A String", # Required. The CPE URI in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.

3192

"path": "A String", # The path from which we gathered that this package/version is installed.

3193

"version": { # Version contains structured information about the version of a package. # The version installed at this location.

3194

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3195

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3196

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

3197

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

3198

"revision": "A String", # The iteration of the package build from the above version.

},

},

],

"name": "A String", # Output only. The name of the installed package.

3203

},

3204

},

3205

"intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.

3206

"signatures": [

3207

{ # A signature object consists of the KeyID used and the signature itself.

"keyid": "A String",

"sig": "A String",

},

],

"signed": { # This corresponds to an in-toto link.

3213

"byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.

3214

"customValues": {

3215

"a_key": "A String",

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3216

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3217

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3218

"command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]

3219

"A String",

3220

],

3221

"environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }

3222

"customValues": {

3223

"a_key": "A String",

3224

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3225

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3226

"materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]

3227

{

3228

"hashes": { # Defines a hash object for use in Materials and Products.

3229

"sha256": "A String",

3230

},

3231

"resourceUri": "A String",

3232

},

3233

],

3234

"products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.

3235

{

3236

"hashes": { # Defines a hash object for use in Materials and Products.

3237

"sha256": "A String",

3238

},

3239

"resourceUri": "A String",

3240

},

3241

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3242

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3243

},

3244

"kind": "A String", # Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests.

3245

"name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.

3246

"noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.

3247

"remediation": "A String", # A description of actions that can be taken to remedy the note.

3248

"resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.

3249

"contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.

3250

"type": "A String", # Required. The type of hash that was performed.

3251

"value": "A String", # Required. The hash value.

3252

},

3253

"name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".

3254

"uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.

3255

},

yoshi-code-bot

2021-08-03 00:20:27 -0700

[diff] [blame^]

3256

"sbom": { # DocumentOccurrence represents an SPDX Document Creation Information section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # Describes a specific SPDX Document.

3257

"createTime": "A String", # Identify when the SPDX file was originally created. The date is to be specified according to combined date and time in UTC format as specified in ISO 8601 standard

3258

"creatorComment": "A String", # A field for creators of the SPDX file to provide general comments about the creation of the SPDX file or any other relevant comment not included in the other fields

3259

"creators": [ # Identify who (or what, in the case of a tool) created the SPDX file. If the SPDX file was created by an individual, indicate the person's name

3260

"A String",

3261

],

3262

"documentComment": "A String", # A field for creators of the SPDX file content to provide comments to the consumers of the SPDX document

3263

"externalDocumentRefs": [ # Identify any external SPDX documents referenced within this SPDX document

3264

"A String",

3265

],

3266

"id": "A String", # Identify the current SPDX document which may be referenced in relationships by other files, packages internally and documents externally

3267

"licenseListVersion": "A String", # A field for creators of the SPDX file to provide the version of the SPDX License List used when the SPDX file was created

3268

"namespace": "A String", # Provide an SPDX document specific namespace as a unique absolute Uniform Resource Identifier (URI) as specified in RFC-3986, with the exception of the ‘#’ delimiter

3269

"title": "A String", # Identify name of this document as designated by creator

3270

},

3271

"spdxFile": { # FileOccurrence represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # Describes a specific SPDX File.

3272

"attributions": [ # This field provides a place for the SPDX data creator to record, at the file level, acknowledgements that may be needed to be communicated in some contexts

3273

"A String",

3274

],

3275

"comment": "A String", # This field provides a place for the SPDX file creator to record any general comments about the file

3276

"contributors": [ # This field provides a place for the SPDX file creator to record file contributors

3277

"A String",

3278

],

3279

"copyright": "A String", # Identify the copyright holder of the file, as well as any dates present

3280

"filesLicenseInfo": [ # This field contains the license information actually found in the file, if any

3281

"A String",

3282

],

3283

"id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements

3284

"licenseComments": "A String", # This field provides a place for the SPDX file creator to record any relevant background references or analysis that went in to arriving at the Concluded License for a file

3285

"licenseConcluded": "A String", # This field contains the license the SPDX file creator has concluded as governing the file or alternative values if the governing license cannot be determined

3286

"notice": "A String", # This field provides a place for the SPDX file creator to record license notices or other such related notices found in the file

3287

},

3288

"spdxPackage": { # PackageOccurrence represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # Describes a specific SPDX Package.

3289

"comment": "A String", # A place for the SPDX file creator to record any general comments about the package being described

3290

"filename": "A String", # Provide the actual file name of the package, or path of the directory being treated as a package

3291

"id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements

3292

"licenseComments": "A String", # This field provides a place for the SPDX file creator to record any relevant background information or analysis that went in to arriving at the Concluded License for a package

3293

"licenseConcluded": "A String", # package or alternative values, if the governing license cannot be determined

3294

"sourceInfo": "A String", # Provide a place for the SPDX file creator to record any relevant background information or additional comments about the origin of the package

3295

},

3296

"spdxRelationship": { # RelationshipOccurrence represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # Describes a specific SPDX Relationship.

3297

"comment": "A String", # A place for the SPDX file creator to record any general comments about the relationship

3298

"source": "A String", # Also referred to as SPDXRef-A The source SPDX element (file, package, etc)

3299

"target": "A String", # Also referred to as SPDXRef-B The target SPDC element (file, package, etc) In cases where there are "known unknowns", the use of the keyword NOASSERTION can be used The keywords NONE can be used to indicate that an SPDX element (package/file/snippet) has no other elements connected by some relationship to it

3300

"type": "A String", # The type of relationship between the source and target SPDX elements

3301

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3302

"updateTime": "A String", # Output only. The time this occurrence was last updated.

3303

"vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability.

3304

"cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity.

3305

"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.

3306

"longDescription": "A String", # Output only. A detailed description of this vulnerability.

3307

"packageIssue": [ # Required. The set of affected locations and their fixes (if available) within the associated resource.

3308

{ # This message wraps a location affected by a vulnerability and its associated fix (if one is available).

3309

"affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.

3310

"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.

3311

"package": "A String", # Required. The package being described.

3312

"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.

3313

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3314

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3315

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

3316

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

3317

"revision": "A String", # The iteration of the package build from the above version.

3318

},

3319

},

3320

"fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.

3321

"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.

3322

"package": "A String", # Required. The package being described.

3323

"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.

3324

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3325

"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3326

"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.

3327

"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.

3328

"revision": "A String", # The iteration of the package build from the above version.

3329

},

3330

},

3331

"severityName": "A String", # Deprecated, use Details.effective_severity instead The severity (e.g., distro assigned severity) for this vulnerability.

3332

},

3333

],

3334

"relatedUrls": [ # Output only. URLs related to this vulnerability.

3335

{ # Metadata for any related URL information.

3336

"label": "A String", # Label to describe usage of the URL.

3337

"url": "A String", # Specific URL associated with the resource.

3338

},

3339

],

3340

"severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.

3341

"shortDescription": "A String", # Output only. A one sentence description of this vulnerability.

3342

"type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)

3343

},

3344

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3348

<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3349

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3350

3351

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3352

resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3353

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3354

The object takes the form of:

3355

3356

{ # Request message for `SetIamPolicy` method.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3357

"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

3358

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

3359

{ # Associates `members` with a `role`.

3360

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

3361

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

3362

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

3363

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

3364

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3365

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3366

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

3367

"A String",

3368

],

3369

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

3370

},

3371

],

3372

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

3373

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

3374

},

3375

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3376

3377

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3384

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3385

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3386

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

3387

{ # Associates `members` with a `role`.

3388

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

3389

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

3390

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

3391

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

3392

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3393

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3394

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

3395

"A String",

3396

],

3397

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

3398

},

3399

],

3400

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

3401

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

3402

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3406

<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3407

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3408

3409

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3410

resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3411

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3412

The object takes the form of:

3413

3414

{ # Request message for `TestIamPermissions` method.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3415

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

3416

"A String",

3417

],

3418

}

Bu Sun Kim