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

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

[diff] [blame]

78

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

79

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

80

Bu Sun Kim

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

[diff] [blame]

81

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

Dmitry Frenkel

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

[diff] [blame]

82

<p class="firstline">Lists occurrences referencing the specified note. Provider projects can use this method to get all occurrences across consumer projects referencing the specified note.</p>

Bu Sun Kim

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

[diff] [blame]

83

84

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

85

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

86

<h3>Method Details</h3>

87

Dmitry Frenkel

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

[diff] [blame]

88

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

89

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

93

<code class="details" id="list">list(name, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code>

Dmitry Frenkel

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

[diff] [blame]

94

<pre>Lists occurrences referencing the specified note. Provider projects can use this method to get all occurrences across consumer projects referencing the specified note.

Bu Sun Kim

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

[diff] [blame]

95

96

Args:

Dmitry Frenkel

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

[diff] [blame]

97

name: string, Required. The name of the note to list occurrences for in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. (required)

Dmitry Frenkel

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

[diff] [blame]

98

pageToken: string, Token to provide to skip to a particular spot in the list.

99

pageSize: integer, Number of occurrences to return in the list.

Bu Sun Kim

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

[diff] [blame]

100

filter: string, The filter expression.

Bu Sun Kim

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

[diff] [blame]

101

x__xgafv: string, V1 error format.

102

Allowed values

103

1 - v1 error format

104

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

105

106

Returns:

107

An object of the form:

108

109

{ # Response for listing occurrences for a note.

Bu Sun Kim

6502091

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

[diff] [blame]

110

"occurrences": [ # The occurrences attached to the specified note.

Bu Sun Kim

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

[diff] [blame]

111

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

Bu Sun Kim

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

[diff] [blame]

112

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

Bu Sun Kim

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

[diff] [blame]

113

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

114

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

Dmitry Frenkel

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

[diff] [blame]

115

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

116

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

Bu Sun Kim

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

[diff] [blame]

117

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

118

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

119

"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.

120

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

121

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

122

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

123

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

124

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

125

},

126

},

Dmitry Frenkel

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

[diff] [blame]

127

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

128

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

Bu Sun Kim

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

[diff] [blame]

129

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

Dmitry Frenkel

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

[diff] [blame]

130

"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.

131

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

132

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

Dmitry Frenkel

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

[diff] [blame]

133

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

Dmitry Frenkel

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

[diff] [blame]

134

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

Bu Sun Kim

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

[diff] [blame]

135

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

Dmitry Frenkel

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

[diff] [blame]

136

},

Dmitry Frenkel

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

[diff] [blame]

137

},

138

},

139

],

Bu Sun Kim

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

[diff] [blame]

140

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

Dmitry Frenkel

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

[diff] [blame]

141

"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.

Bu Sun Kim

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

[diff] [blame]

142

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

143

{ # Metadata for any related URL information.

Bu Sun Kim

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

[diff] [blame]

144

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

Bu Sun Kim

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

[diff] [blame]

145

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

Bu Sun Kim

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

[diff] [blame]

146

},

147

],

Bu Sun Kim

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

[diff] [blame]

148

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

149

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

150

"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.

Bu Sun Kim

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

[diff] [blame]

151

},

Bu Sun Kim

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

[diff] [blame]

152

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

153

"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.

Bu Sun Kim

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

[diff] [blame]

154

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

Bu Sun Kim

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

[diff] [blame]

155

"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.

Dmitry Frenkel

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

[diff] [blame]

156

"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.

Bu Sun Kim

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

[diff] [blame]

157

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

Dmitry Frenkel

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

[diff] [blame]

158

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

Bu Sun Kim

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

[diff] [blame]

159

"builtArtifacts": [ # Output of the build.

160

{ # Artifact describes a build product.

161

"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.

162

"A String",

163

],

164

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

165

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

166

},

167

],

Dmitry Frenkel

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

[diff] [blame]

168

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

Bu Sun Kim

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

[diff] [blame]

169

"a_key": "A String",

170

},

Bu Sun Kim

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

[diff] [blame]

171

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

Bu Sun Kim

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

[diff] [blame]

172

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

173

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

Dmitry Frenkel

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

[diff] [blame]

174

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

Bu Sun Kim

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

[diff] [blame]

175

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

176

"A String",

177

],

Bu Sun Kim

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

[diff] [blame]

178

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

Bu Sun Kim

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

[diff] [blame]

179

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

180

"A String",

181

],

Bu Sun Kim

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

[diff] [blame]

182

"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`.

Bu Sun Kim

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

[diff] [blame]

183

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

184

"A String",

185

],

Dmitry Frenkel

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

[diff] [blame]

186

},

187

],

Bu Sun Kim

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

[diff] [blame]

188

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

Bu Sun Kim

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

[diff] [blame]

189

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

Dmitry Frenkel

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

[diff] [blame]

190

"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.

191

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

192

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

Dmitry Frenkel

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

[diff] [blame]

193

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

194

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

195

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

196

},

197

"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.

198

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

Bu Sun Kim

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

[diff] [blame]

199

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

200

},

201

"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).

202

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

203

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

Dmitry Frenkel

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

[diff] [blame]

204

},

205

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

206

"a_key": "A String",

207

},

208

"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.

Dmitry Frenkel

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

[diff] [blame]

209

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

210

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

211

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

212

},

213

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

Bu Sun Kim

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

[diff] [blame]

214

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

Dmitry Frenkel

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

[diff] [blame]

215

"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.

216

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

217

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

218

},

Dmitry Frenkel

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

[diff] [blame]

219

},

Bu Sun Kim

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

[diff] [blame]

220

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

Dmitry Frenkel

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

[diff] [blame]

},

},

],

"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.

225

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

Bu Sun Kim

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

[diff] [blame]

226

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

227

{ # Container message for hash values.

228

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

229

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

},

],

},

},

Bu Sun Kim

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

[diff] [blame]

234

"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.

235

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

236

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

237

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

238

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

239

},

240

"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.

241

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

242

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

Dmitry Frenkel

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

[diff] [blame]

243

},

Bu Sun Kim

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

[diff] [blame]

244

"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).

245

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

246

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

247

},

248

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

249

"a_key": "A String",

250

},

251

"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.

252

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

253

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

254

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

255

},

256

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

257

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

258

"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.

259

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

260

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

261

},

262

},

263

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

264

},

265

},

266

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

267

},

268

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

269

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

270

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

271

"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.

272

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

273

},

274

},

275

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

276

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

277

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

278

"A String",

279

],

280

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

281

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

282

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

283

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

284

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

285

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

286

},

287

},

288

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

289

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

290

"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.

291

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

292

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

293

"A String",

294

],

295

"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.

296

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

297

},

298

"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.

299

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

300

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

301

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

Bu Sun Kim

6502091

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

[diff] [blame]

302

},

303

],

Bu Sun Kim

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

[diff] [blame]

304

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

305

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

306

},

307

},

308

"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.

309

"signatures": [

310

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

"sig": "A String",

"keyid": "A String",

},

],

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

316

"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"]

322

"A String",

323

],

324

"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",

},

},

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

330

{

331

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

332

"sha256": "A String",

333

},

334

"resourceUri": "A String",

335

},

336

],

337

"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...", : } } ]

338

{

339

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

340

"sha256": "A String",

341

},

342

"resourceUri": "A String",

},

],

},

},

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

348

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

349

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

350

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

351

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

352

"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.

353

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

354

{

355

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

356

},

357

],

358

"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.

359

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

360

},

Dmitry Frenkel

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

[diff] [blame]

361

},

362

},

363

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

364

"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.

365

"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.

Bu Sun Kim

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

[diff] [blame]

366

"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`.

Dmitry Frenkel

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

[diff] [blame]

367

"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.

368

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

Dmitry Frenkel

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

[diff] [blame]

369

"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.

Bu Sun Kim

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

[diff] [blame]

370

"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"

Dmitry Frenkel

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

[diff] [blame]

371

},

Bu Sun Kim

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

[diff] [blame]

372

],

Dmitry Frenkel

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

[diff] [blame]

373

"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).

Dmitry Frenkel

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

[diff] [blame]

374

},

375

"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.

Dmitry Frenkel

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

[diff] [blame]

376

"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`.

Bu Sun Kim

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

[diff] [blame]

377

"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.

378

"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).

Bu Sun Kim

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

[diff] [blame]

379

},

Bu Sun Kim

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

[diff] [blame]

380

},

381

},

Bu Sun Kim

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

[diff] [blame]

382

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

383

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

384

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

385

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

386

},

387

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

388

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

389

},

390

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

391

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

392

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

393

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

394

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

395

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

396

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

397

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

398

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

399

},

400

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

401

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

402

},

403

],

404

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

405

},

406

},

407

"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.

Dmitry Frenkel

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

[diff] [blame]

408

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

Bu Sun Kim