legacy-libs/google-proto-files/google/cloud/securitycenter/v1/finding.proto

   1 // Copyright 2019 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 //
  15
  16 syntax = "proto3";
  17
  18 package google.cloud.securitycenter.v1;
  19
  20 import "google/api/annotations.proto";
  21 import "google/cloud/securitycenter/v1/security_marks.proto";
  22 import "google/protobuf/struct.proto";
  23 import "google/protobuf/timestamp.proto";
  24
  25 option csharp_namespace = "Google.Cloud.SecurityCenter.V1";
  26 option go_package = "google.golang.org/genproto/googleapis/cloud/securitycenter/v1;securitycenter";
  27 option java_multiple_files = true;
  28 option java_package = "com.google.cloud.securitycenter.v1";
  29
  30 // Cloud Security Command Center (Cloud SCC) finding.
  31 //
  32 // A finding is a record of assessment data (security, risk, health or privacy)
  33 // ingested into Cloud SCC for presentation, notification, analysis,
  34 // policy testing, and enforcement. For example, an XSS vulnerability in an
  35 // App Engine application is a finding.
  36 message Finding {
  37   // The state of the finding.
  38   enum State {
  39     // Unspecified state.
  40     STATE_UNSPECIFIED = 0;
  41
  42     // The finding requires attention and has not been addressed yet.
  43     ACTIVE = 1;
  44
  45     // The finding has been fixed, triaged as a non-issue or otherwise addressed
  46     // and is no longer active.
  47     INACTIVE = 2;
  48   }
  49
  50   // The relative resource name of this finding. See:
  51   // https://cloud.google.com/apis/design/resource_names#relative_resource_name
  52   // Example:
  53   // "organizations/123/sources/456/findings/789"
  54   string name = 1;
  55
  56   // The relative resource name of the source the finding belongs to. See:
  57   // https://cloud.google.com/apis/design/resource_names#relative_resource_name
  58   // This field is immutable after creation time.
  59   // For example:
  60   // "organizations/123/sources/456"
  61   string parent = 2;
  62
  63   // The full resource name of the Google Cloud Platform (GCP) resource this
  64   // finding is for. See:
  65   // https://cloud.google.com/apis/design/resource_names#full_resource_name
  66   // This field is immutable after creation time.
  67   string resource_name = 3;
  68
  69   // The state of the finding.
  70   State state = 4;
  71
  72   // The additional taxonomy group within findings from a given source.
  73   // This field is immutable after creation time.
  74   // Example: "XSS_FLASH_INJECTION"
  75   string category = 5;
  76
  77   // The URI that, if available, points to a web page outside of Cloud SCC
  78   // where additional information about the finding can be found. This field is
  79   // guaranteed to be either empty or a well formed URL.
  80   string external_uri = 6;
  81
  82   // Source specific properties. These properties are managed by the source
  83   // that writes the finding. The key names in the source_properties map must be
  84   // between 1 and 255 characters, and must start with a letter and contain
  85   // alphanumeric characters or underscores only.
  86   map<string, google.protobuf.Value> source_properties = 7;
  87
  88   // Output only. User specified security marks. These marks are entirely
  89   // managed by the user and come from the SecurityMarks resource that belongs
  90   // to the finding.
  91   SecurityMarks security_marks = 8;
  92
  93   // The time at which the event took place. For example, if the finding
  94   // represents an open firewall it would capture the time the open firewall was
  95   // detected.
  96   google.protobuf.Timestamp event_time = 9;
  97
  98   // The time at which the finding was created in Cloud SCC.
  99   google.protobuf.Timestamp create_time = 10;
 100 }