@google-cloud/containeranalysis 6.2.0 → 6.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +69 -92
- package/build/protos/grafeas/v1/common.proto +31 -0
- package/build/protos/grafeas/v1/grafeas.proto +5 -0
- package/build/protos/grafeas/v1/secret.proto +90 -0
- package/build/protos/protos.d.ts +718 -33
- package/build/protos/protos.js +2626 -290
- package/build/protos/protos.json +210 -19
- package/build/src/v1/container_analysis_client.d.ts +10 -10
- package/build/src/v1/container_analysis_client.js +78 -83
- package/build/src/v1/container_analysis_proto_list.json +1 -0
- package/build/src/v1/grafeas_proto_list.json +1 -0
- package/build/src/v1beta1/container_analysis_v1_beta1_client.d.ts +3 -3
- package/build/src/v1beta1/container_analysis_v1_beta1_client.js +70 -74
- package/build/src/v1beta1/grafeas_v1_beta1_client.d.ts +78 -78
- package/build/src/v1beta1/grafeas_v1_beta1_client.js +174 -198
- package/package.json +4 -4
- package/CHANGELOG.md +0 -568
package/README.md
CHANGED
|
@@ -1,24 +1,25 @@
|
|
|
1
1
|
[//]: # "This README.md file is auto-generated, all changes to this file will be lost."
|
|
2
|
-
[//]: # "
|
|
2
|
+
[//]: # "The comments you see below are used to generate those parts of the template in later states."
|
|
3
3
|
<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
|
|
4
4
|
|
|
5
|
-
# [
|
|
6
|
-
|
|
7
|
-
[](https://cloud.google.com/terms/launch-stages)
|
|
8
|
-
[](https://www.npmjs.org/package/@google-cloud/containeranalysis)
|
|
9
|
-
|
|
5
|
+
# [Container Analysis API: Nodejs Client][homepage]
|
|
10
6
|
|
|
7
|
+
This library is considered to be **stable**. The code surface will not change in backwards-incompatible ways
|
|
8
|
+
unless absolutely necessary (e.g. because of critical security issues) or with
|
|
9
|
+
an extensive deprecation period. Issues and requests against **stable** libraries
|
|
10
|
+
are addressed with the highest priority
|
|
11
11
|
|
|
12
|
+
[](https://www.npmjs.org/package/@google-cloud/containeranalysis)
|
|
12
13
|
|
|
13
|
-
|
|
14
|
+
Container Analysis API client for Node.js
|
|
14
15
|
|
|
16
|
+
[//]: # "partials.introduction"
|
|
15
17
|
|
|
16
18
|
A comprehensive list of changes in each version may be found in
|
|
17
|
-
[the CHANGELOG]
|
|
19
|
+
[the CHANGELOG][homepage_changelog].
|
|
20
|
+
|
|
21
|
+
* [Container Analysis API Nodejs Client API Reference](https://cloud.google.com/nodejs/docs/reference/containeranalysis/latest)
|
|
18
22
|
|
|
19
|
-
* [Google Container Analysis Node.js Client API Reference][client-docs]
|
|
20
|
-
* [Google Container Analysis Documentation][product-docs]
|
|
21
|
-
* [github.com/googleapis/google-cloud-node/packages/google-devtools-containeranalysis](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-devtools-containeranalysis)
|
|
22
23
|
|
|
23
24
|
Read more about the client libraries for Cloud APIs, including the older
|
|
24
25
|
Google APIs Client Libraries, in [Client Libraries Explained][explained].
|
|
@@ -27,89 +28,78 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
|
|
|
27
28
|
|
|
28
29
|
**Table of contents:**
|
|
29
30
|
|
|
30
|
-
|
|
31
31
|
* [Quickstart](#quickstart)
|
|
32
32
|
* [Before you begin](#before-you-begin)
|
|
33
33
|
* [Installing the client library](#installing-the-client-library)
|
|
34
34
|
|
|
35
|
-
* [Samples](#samples)
|
|
36
35
|
* [Versioning](#versioning)
|
|
37
36
|
* [Contributing](#contributing)
|
|
38
37
|
* [License](#license)
|
|
39
38
|
|
|
40
39
|
## Quickstart
|
|
41
|
-
|
|
42
40
|
### Before you begin
|
|
43
41
|
|
|
44
42
|
1. [Select or create a Cloud Platform project][projects].
|
|
45
43
|
1. [Enable billing for your project][billing].
|
|
46
|
-
1. [Enable the
|
|
47
|
-
1. [Set up authentication
|
|
44
|
+
1. [Enable the Container Analysis API API][enable_api].
|
|
45
|
+
1. [Set up authentication][auth] so you can access the
|
|
48
46
|
API from your local workstation.
|
|
49
|
-
|
|
50
47
|
### Installing the client library
|
|
51
48
|
|
|
52
49
|
```bash
|
|
53
50
|
npm install @google-cloud/containeranalysis
|
|
54
51
|
```
|
|
55
52
|
|
|
56
|
-
|
|
57
|
-
|
|
53
|
+
[//]: # "partials.body"
|
|
58
54
|
|
|
59
55
|
## Samples
|
|
60
56
|
|
|
61
|
-
Samples are in the [`samples/`]
|
|
62
|
-
|
|
63
|
-
| Sample | Source Code |
|
|
64
|
-
| --------------------------- | --------------------------------- |
|
|
65
|
-
|
|
|
66
|
-
|
|
|
67
|
-
|
|
|
68
|
-
|
|
|
69
|
-
|
|
|
70
|
-
|
|
|
71
|
-
|
|
|
72
|
-
|
|
|
73
|
-
|
|
|
74
|
-
|
|
|
75
|
-
|
|
|
76
|
-
|
|
|
77
|
-
|
|
|
78
|
-
|
|
|
79
|
-
|
|
|
80
|
-
|
|
|
81
|
-
|
|
|
82
|
-
|
|
|
83
|
-
|
|
|
84
|
-
|
|
|
85
|
-
|
|
|
86
|
-
|
|
|
87
|
-
|
|
|
88
|
-
|
|
|
89
|
-
|
|
|
90
|
-
|
|
|
91
|
-
|
|
|
92
|
-
|
|
|
93
|
-
|
|
|
94
|
-
|
|
|
95
|
-
|
|
|
96
|
-
|
|
|
97
|
-
|
|
|
98
|
-
|
|
|
99
|
-
|
|
|
100
|
-
|
|
|
101
|
-
|
|
|
102
|
-
|
|
|
103
|
-
|
|
|
104
|
-
|
|
|
105
|
-
|
|
|
106
|
-
|
|
107
|
-
| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-devtools-containeranalysis/samples/quickstart.js,packages/google-devtools-containeranalysis/samples/README.md) |
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
The [Google Container Analysis Node.js Client API Reference][client-docs] documentation
|
|
112
|
-
also contains samples.
|
|
57
|
+
Samples are in the [`samples/`][homepage_samples] directory. Each sample's `README.md` has instructions for running its sample.
|
|
58
|
+
|
|
59
|
+
| Sample | Source Code |
|
|
60
|
+
| --------------------------- | --------------------------------- |
|
|
61
|
+
| export s b o m | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/container_analysis.export_s_b_o_m.js) |
|
|
62
|
+
| get iam policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/container_analysis.get_iam_policy.js) |
|
|
63
|
+
| get vulnerability occurrences summary | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/container_analysis.get_vulnerability_occurrences_summary.js) |
|
|
64
|
+
| set iam policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/container_analysis.set_iam_policy.js) |
|
|
65
|
+
| test iam permissions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/container_analysis.test_iam_permissions.js) |
|
|
66
|
+
| batch create notes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.batch_create_notes.js) |
|
|
67
|
+
| batch create occurrences | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.batch_create_occurrences.js) |
|
|
68
|
+
| create note | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.create_note.js) |
|
|
69
|
+
| create occurrence | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.create_occurrence.js) |
|
|
70
|
+
| delete note | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.delete_note.js) |
|
|
71
|
+
| delete occurrence | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.delete_occurrence.js) |
|
|
72
|
+
| get note | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.get_note.js) |
|
|
73
|
+
| get occurrence | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.get_occurrence.js) |
|
|
74
|
+
| get occurrence note | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.get_occurrence_note.js) |
|
|
75
|
+
| list note occurrences | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.list_note_occurrences.js) |
|
|
76
|
+
| list notes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.list_notes.js) |
|
|
77
|
+
| list occurrences | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.list_occurrences.js) |
|
|
78
|
+
| update note | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.update_note.js) |
|
|
79
|
+
| update occurrence | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.update_occurrence.js) |
|
|
80
|
+
| devtools | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/snippet_metadata_google.devtools.containeranalysis.v1.json) |
|
|
81
|
+
| export s b o m | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/container_analysis_v1_beta1.export_s_b_o_m.js) |
|
|
82
|
+
| generate packages summary | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/container_analysis_v1_beta1.generate_packages_summary.js) |
|
|
83
|
+
| get iam policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/container_analysis_v1_beta1.get_iam_policy.js) |
|
|
84
|
+
| set iam policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/container_analysis_v1_beta1.set_iam_policy.js) |
|
|
85
|
+
| test iam permissions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/container_analysis_v1_beta1.test_iam_permissions.js) |
|
|
86
|
+
| batch create notes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.batch_create_notes.js) |
|
|
87
|
+
| batch create occurrences | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.batch_create_occurrences.js) |
|
|
88
|
+
| create note | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.create_note.js) |
|
|
89
|
+
| create occurrence | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.create_occurrence.js) |
|
|
90
|
+
| delete note | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.delete_note.js) |
|
|
91
|
+
| delete occurrence | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.delete_occurrence.js) |
|
|
92
|
+
| get note | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.get_note.js) |
|
|
93
|
+
| get occurrence | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.get_occurrence.js) |
|
|
94
|
+
| get occurrence note | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.get_occurrence_note.js) |
|
|
95
|
+
| get vulnerability occurrences summary | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.get_vulnerability_occurrences_summary.js) |
|
|
96
|
+
| list note occurrences | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.list_note_occurrences.js) |
|
|
97
|
+
| list notes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.list_notes.js) |
|
|
98
|
+
| list occurrences | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.list_occurrences.js) |
|
|
99
|
+
| update note | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.update_note.js) |
|
|
100
|
+
| update occurrence | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.update_occurrence.js) |
|
|
101
|
+
| devtools | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/snippet_metadata_google.devtools.containeranalysis.v1beta1.json) |
|
|
102
|
+
|
|
113
103
|
|
|
114
104
|
## Supported Node.js Versions
|
|
115
105
|
|
|
@@ -136,42 +126,29 @@ for versions compatible with Node.js 8.
|
|
|
136
126
|
|
|
137
127
|
This library follows [Semantic Versioning](http://semver.org/).
|
|
138
128
|
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
This library is considered to be **stable**. The code surface will not change in backwards-incompatible ways
|
|
142
|
-
unless absolutely necessary (e.g. because of critical security issues) or with
|
|
143
|
-
an extensive deprecation period. Issues and requests against **stable** libraries
|
|
144
|
-
are addressed with the highest priority.
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
129
|
More Information: [Google Cloud Platform Launch Stages][launch_stages]
|
|
152
130
|
|
|
153
131
|
[launch_stages]: https://cloud.google.com/terms/launch-stages
|
|
154
132
|
|
|
155
133
|
## Contributing
|
|
156
134
|
|
|
157
|
-
Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/CONTRIBUTING.md).
|
|
135
|
+
Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/CONTRIBUTING.md).
|
|
158
136
|
|
|
159
|
-
Please note that this `README.md
|
|
137
|
+
Please note that this `README.md`
|
|
160
138
|
and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)
|
|
161
|
-
are generated from a central template.
|
|
162
|
-
to its templates in
|
|
163
|
-
[directory](https://github.com/googleapis/synthtool).
|
|
139
|
+
are generated from a central template.
|
|
164
140
|
|
|
165
141
|
## License
|
|
166
142
|
|
|
167
143
|
Apache Version 2.0
|
|
168
144
|
|
|
169
|
-
See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
|
|
145
|
+
See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/LICENSE)
|
|
170
146
|
|
|
171
|
-
[client-docs]: https://cloud.google.com/nodejs/docs/reference/containeranalysis/latest
|
|
172
|
-
[product-docs]: https://cloud.google.com/container-registry/docs/container-analysis
|
|
173
147
|
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
|
|
174
148
|
[projects]: https://console.cloud.google.com/project
|
|
175
149
|
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
|
|
176
150
|
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=containeranalysis.googleapis.com
|
|
177
|
-
[auth]: https://cloud.google.com/docs/authentication/
|
|
151
|
+
[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local
|
|
152
|
+
[homepage_samples]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples
|
|
153
|
+
[homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/CHANGELOG.md
|
|
154
|
+
[homepage]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis
|
|
@@ -49,6 +49,8 @@ enum NoteKind {
|
|
|
49
49
|
VULNERABILITY_ASSESSMENT = 11;
|
|
50
50
|
// This represents an SBOM Reference.
|
|
51
51
|
SBOM_REFERENCE = 12;
|
|
52
|
+
// This represents a secret.
|
|
53
|
+
SECRET = 13;
|
|
52
54
|
}
|
|
53
55
|
|
|
54
56
|
// Metadata for any related URL information.
|
|
@@ -129,6 +131,35 @@ message FileLocation {
|
|
|
129
131
|
// For jars that are contained inside .war files, this filepath
|
|
130
132
|
// can indicate the path to war file combined with the path to jar file.
|
|
131
133
|
string file_path = 1;
|
|
134
|
+
// Each package found in a file should have its own layer metadata (that is,
|
|
135
|
+
// information from the origin layer of the package).
|
|
136
|
+
LayerDetails layer_details = 2;
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
// BaseImage describes a base image of a container image.
|
|
140
|
+
message BaseImage {
|
|
141
|
+
// The name of the base image.
|
|
142
|
+
string name = 1;
|
|
143
|
+
// The repository name in which the base image is from.
|
|
144
|
+
string repository = 2;
|
|
145
|
+
// The number of layers that the base image is composed of.
|
|
146
|
+
int32 layer_count = 3;
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
// Details about the layer a package was found in.
|
|
150
|
+
message LayerDetails {
|
|
151
|
+
// The index of the layer in the container image.
|
|
152
|
+
int32 index = 1;
|
|
153
|
+
// The diff ID (typically a sha256 hash) of the layer in the container image.
|
|
154
|
+
string diff_id = 2;
|
|
155
|
+
// The layer chain ID (sha256 hash) of the layer in the container image.
|
|
156
|
+
// https://github.com/opencontainers/image-spec/blob/main/config.md#layer-chainid
|
|
157
|
+
string chain_id = 5;
|
|
158
|
+
// The layer build command that was used to build the layer. This may not be
|
|
159
|
+
// found in all layers depending on how the container image is built.
|
|
160
|
+
string command = 3;
|
|
161
|
+
// The base images the layer is found within.
|
|
162
|
+
repeated BaseImage base_images = 4;
|
|
132
163
|
}
|
|
133
164
|
|
|
134
165
|
// License information.
|
|
@@ -33,6 +33,7 @@ import "grafeas/v1/dsse_attestation.proto";
|
|
|
33
33
|
import "grafeas/v1/image.proto";
|
|
34
34
|
import "grafeas/v1/package.proto";
|
|
35
35
|
import "grafeas/v1/sbom.proto";
|
|
36
|
+
import "grafeas/v1/secret.proto";
|
|
36
37
|
import "grafeas/v1/upgrade.proto";
|
|
37
38
|
import "grafeas/v1/vex.proto";
|
|
38
39
|
import "grafeas/v1/vulnerability.proto";
|
|
@@ -296,6 +297,8 @@ message Occurrence {
|
|
|
296
297
|
grafeas.v1.DSSEAttestationOccurrence dsse_attestation = 17;
|
|
297
298
|
// Describes a specific SBOM reference occurrences.
|
|
298
299
|
grafeas.v1.SBOMReferenceOccurrence sbom_reference = 19;
|
|
300
|
+
// Describes a secret.
|
|
301
|
+
grafeas.v1.SecretOccurrence secret = 20;
|
|
299
302
|
}
|
|
300
303
|
|
|
301
304
|
// https://github.com/secure-systems-lab/dsse
|
|
@@ -366,6 +369,8 @@ message Note {
|
|
|
366
369
|
grafeas.v1.VulnerabilityAssessmentNote vulnerability_assessment = 20;
|
|
367
370
|
// A note describing an SBOM reference.
|
|
368
371
|
grafeas.v1.SBOMReferenceNote sbom_reference = 21;
|
|
372
|
+
// A note describing a secret.
|
|
373
|
+
grafeas.v1.SecretNote secret = 22;
|
|
369
374
|
}
|
|
370
375
|
}
|
|
371
376
|
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
// Copyright 2025 The Grafeas Authors. All rights reserved.
|
|
2
|
+
//
|
|
3
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
// you may not use this file except in compliance with the License.
|
|
5
|
+
// You may obtain a copy of the License at
|
|
6
|
+
//
|
|
7
|
+
// http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
//
|
|
9
|
+
// Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
// See the License for the specific language governing permissions and
|
|
13
|
+
// limitations under the License.
|
|
14
|
+
|
|
15
|
+
syntax = "proto3";
|
|
16
|
+
|
|
17
|
+
package grafeas.v1;
|
|
18
|
+
|
|
19
|
+
import "google/api/field_behavior.proto";
|
|
20
|
+
import "google/protobuf/timestamp.proto";
|
|
21
|
+
import "grafeas/v1/common.proto";
|
|
22
|
+
|
|
23
|
+
option go_package = "google.golang.org/genproto/googleapis/grafeas/v1;grafeas";
|
|
24
|
+
option java_multiple_files = true;
|
|
25
|
+
option java_package = "io.grafeas.v1";
|
|
26
|
+
option objc_class_prefix = "GRA";
|
|
27
|
+
|
|
28
|
+
// The note representing a secret.
|
|
29
|
+
message SecretNote {}
|
|
30
|
+
|
|
31
|
+
// The occurrence provides details of a secret.
|
|
32
|
+
message SecretOccurrence {
|
|
33
|
+
// Type of secret.
|
|
34
|
+
SecretKind kind = 1 [(google.api.field_behavior) = REQUIRED];
|
|
35
|
+
|
|
36
|
+
// Locations where the secret is detected.
|
|
37
|
+
repeated SecretLocation locations = 2
|
|
38
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
39
|
+
|
|
40
|
+
// Status of the secret.
|
|
41
|
+
repeated SecretStatus statuses = 3 [(google.api.field_behavior) = OPTIONAL];
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
// The location of the secret.
|
|
45
|
+
message SecretLocation {
|
|
46
|
+
// The detailed location of the secret.
|
|
47
|
+
oneof location {
|
|
48
|
+
// The secret is found from a file.
|
|
49
|
+
FileLocation file_location = 1;
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
// The status of the secret with a timestamp.
|
|
54
|
+
message SecretStatus {
|
|
55
|
+
// The status of the secret.
|
|
56
|
+
enum Status {
|
|
57
|
+
// Unspecified
|
|
58
|
+
STATUS_UNSPECIFIED = 0;
|
|
59
|
+
|
|
60
|
+
// The status of the secret is unknown.
|
|
61
|
+
UNKNOWN = 1;
|
|
62
|
+
|
|
63
|
+
// The secret is valid.
|
|
64
|
+
VALID = 2;
|
|
65
|
+
|
|
66
|
+
// The secret is invalid.
|
|
67
|
+
INVALID = 3;
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
// The status of the secret.
|
|
71
|
+
Status status = 1 [(google.api.field_behavior) = OPTIONAL];
|
|
72
|
+
|
|
73
|
+
// The time the secret status was last updated.
|
|
74
|
+
google.protobuf.Timestamp update_time = 2
|
|
75
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
76
|
+
|
|
77
|
+
// Optional message about the status code.
|
|
78
|
+
string message = 3 [(google.api.field_behavior) = OPTIONAL];
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
// Kind of secret.
|
|
82
|
+
enum SecretKind {
|
|
83
|
+
// Unspecified
|
|
84
|
+
SECRET_KIND_UNSPECIFIED = 0;
|
|
85
|
+
// The secret kind is unknown.
|
|
86
|
+
SECRET_KIND_UNKNOWN = 1;
|
|
87
|
+
// A GCP service account key per:
|
|
88
|
+
// https://cloud.google.com/iam/docs/creating-managing-service-account-keys
|
|
89
|
+
SECRET_KIND_GCP_SERVICE_ACCOUNT_KEY = 2;
|
|
90
|
+
}
|