xref: /aosp_15_r20/external/googleapis/google/cloud/securitycenter/v2/source.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2023 Google LLC
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
15syntax = "proto3";
16
17package google.cloud.securitycenter.v2;
18
19import "google/api/resource.proto";
20
21option csharp_namespace = "Google.Cloud.SecurityCenter.V2";
22option go_package = "cloud.google.com/go/securitycenter/apiv2/securitycenterpb;securitycenterpb";
23option java_multiple_files = true;
24option java_outer_classname = "SourceProto";
25option java_package = "com.google.cloud.securitycenter.v2";
26option php_namespace = "Google\\Cloud\\SecurityCenter\\V2";
27option ruby_package = "Google::Cloud::SecurityCenter::V2";
28
29// Security Command Center finding source. A finding source
30// is an entity or a mechanism that can produce a finding. A source is like a
31// container of findings that come from the same scanner, logger, monitor, and
32// other tools.
33message Source {
34  option (google.api.resource) = {
35    type: "securitycenter.googleapis.com/Source"
36    pattern: "organizations/{organization}/sources/{source}"
37    pattern: "folders/{folder}/sources/{source}"
38    pattern: "projects/{project}/sources/{source}"
39  };
40
41  // The relative resource name of this source. See:
42  // https://cloud.google.com/apis/design/resource_names#relative_resource_name
43  // Example:
44  // "organizations/{organization_id}/sources/{source_id}"
45  string name = 1;
46
47  // The source's display name.
48  // A source's display name must be unique amongst its siblings, for example,
49  // two sources with the same parent can't share the same display name.
50  // The display name must have a length between 1 and 64 characters
51  // (inclusive).
52  string display_name = 2;
53
54  // The description of the source (max of 1024 characters).
55  // Example:
56  // "Web Security Scanner is a web security scanner for common
57  // vulnerabilities in App Engine applications. It can automatically
58  // scan and detect four common vulnerabilities, including cross-site-scripting
59  // (XSS), Flash injection, mixed content (HTTP in HTTPS), and
60  // outdated or insecure libraries."
61  string description = 3;
62
63  // The canonical name of the finding source. It's either
64  // "organizations/{organization_id}/sources/{source_id}",
65  // "folders/{folder_id}/sources/{source_id}", or
66  // "projects/{project_number}/sources/{source_id}",
67  // depending on the closest CRM ancestor of the resource associated with the
68  // finding.
69  string canonical_name = 4;
70}
71