sds: add sds_result protobuf definition and bazel target

Author: aimenebelfodil

pkg/proto/datadog/sds/BUILD.bazel

@@ -0,0 +1,5 @@
+# Compiled with prost-build (cargo) by the datasecurity Rust check; not built or
+# consumed by Bazel. Disable proto generation inherited from ../BUILD.bazel.
+# gazelle:proto disable
+
+exports_files(["sds_result.proto"])

pkg/proto/datadog/sds/sds_result.proto

@@ -0,0 +1,195 @@
+syntax = "proto3";
+
+package datadog.sds;
+
+import "google/protobuf/timestamp.proto";
+
+option go_package = "pkg/proto/pbgo/sds"; // golang
+
+message ScanStats {
+  int64 scan_duration_ms = 1;
+  int64 total_files_found = 2;
+  int64 files_scanned = 3;
+  int64 files_skipped_unsupported_type = 4;
+  int64 files_partially_scanned_size_limit = 5;
+  int64 total_data_scanned_bytes = 6;
+  map<string, int64> skipped_files_by_type = 7; // file_extension -> count
+}
+
+message ScannerMetadata {
+  optional string version = 1;
+  optional string region = 2;
+}
+
+message ScanningSource {
+  message Agentless {
+    string version = 1;
+    string region = 2;
+  }
+
+  message DatadogCrawler {
+    string service_name = 1;
+  }
+
+  message Agent {
+    string hostname = 1;
+    string version = 2;
+  }
+
+  oneof source {
+    Agentless agentless = 1;
+    DatadogCrawler datadog_crawler = 2;
+    Agent agent = 3;
+  }
+}
+
+message SdsResultPayload {
+  enum ScanSource {
+    option deprecated = true;
+    UNKNOWN = 0;
+    AGENTLESS = 1;
+  }
+  message Resource {
+    string type = 1;
+    string name = 2;
+  }
+
+  message ScanLocation {
+    // Beginning deprecated fields
+    // Use ScanLocation instead
+    oneof ScanLocationType {
+      string path = 1 [deprecated = true];
+      string database = 2 [deprecated = true];
+    }
+    int64 size_in_bytes = 3 [deprecated = true];
+    int64 last_modified_timestamp = 4 [deprecated = true];
+    string table = 5 [deprecated = true];
+    // End deprecated fields
+
+    oneof ScanLocation {
+      S3File s3File = 6;
+      RdsTable rdsTable = 7;
+      SnowflakeTable snowflakeTable = 8;
+      PostgresTable postgresTable = 9;
+    }
+  }
+
+  message RdsTable {
+    string instance_arn = 1;
+    string snapshot_arn = 2;
+    int64 snapshot_timestamp = 3;
+    string database_name = 4;
+    string table_name = 5;
+    optional int64 table_row_count = 6;
+    optional int64 scanned_row_count = 7;
+
+  }
+
+  message SnowflakeTable {
+    string account_name = 1;
+    string database_name = 2;
+    string schema_name = 3;
+    string table_name = 4;
+    int64 last_modified_timestamp = 5;
+    int64 table_row_count = 6;
+    int64 scanned_row_count = 7;
+    repeated ScannedColumn scanned_columns = 8;
+
+    message ScannedColumn {
+      string name = 1;
+      string data_type = 2;
+    }
+  }
+
+  message PostgresTable {
+    string database_cluster_name = 1;
+    string database_instance_name = 2;
+    string database_host_name = 3;
+    string database_name = 4;
+    string schema_name = 5;
+    string table_name = 6;
+    int64 table_row_count = 7;
+    int64 scanned_row_count = 8;
+    repeated ScannedColumn scanned_columns = 9;
+
+    message ScannedColumn {
+      string name = 1;
+      string data_type = 2;
+    }
+  }
+
+  message S3File {
+    string path = 1;
+    int64 last_modified_timestamp = 2;
+    int64 compressed_size_in_bytes = 3;
+    int64 uncompressed_size_in_bytes = 4;
+  }
+
+  message RuleInfo {
+    string id = 1;
+    string name = 2;
+    string priority = 3;
+    repeated string tags = 4;
+    repeated string labels = 5;
+  }
+
+  message ScanMatch {
+    string rule_id = 1;
+    int64 start_index = 2;
+    int64 end_index = 3;
+    string sample = 4;
+    optional string path = 5;
+    optional int64 line = 6;
+    optional int64 column = 7;
+    optional int64 start_line = 8;
+    optional int64 end_line = 9;
+    optional int64 row = 10;
+    optional int64 start_index_in_line = 11;
+    optional int64 end_index_in_line = 12;
+    optional string match_status = 13;
+  }
+
+  message TableMatch {
+    string rule_id = 1;
+    string column_name = 2;
+    int64 count_matched_rows = 3;
+    int64 count_total_rows = 4 [deprecated = true]; //  rely on ScanLocation.RdsTable.table_row_count
+  }
+
+  message ScanMetadata {
+    ScanTaskMetadata scan_task_metadata = 1;
+
+    message ScanTaskMetadata {
+      enum Status {
+        STATUS_UNKNOWN = 0;
+        SUCCESS = 1;
+        ERROR = 2;
+      }
+
+      string task_id = 1;
+      string sub_task_id = 2;
+      google.protobuf.Timestamp started_at = 3;
+      google.protobuf.Timestamp ended_at = 4;
+      Status status = 5;
+      optional string failure_reason = 6; // set only when status is ERROR
+    }
+  }
+
+  message ScanResult {
+    repeated ScanMatch matches = 1;
+    ScanLocation location = 2;
+    int64 duration = 3;
+    repeated TableMatch table_matches = 4;
+    optional ScanMetadata scan_metadata = 5;
+  }
+
+  ScanSource scan_source = 1 [deprecated = true];
+  int64 timestamp = 2;
+  Resource resource = 3;
+  repeated ScanResult scan_results = 4;
+  optional ScanStats scan_stats = 5;
+  optional ScannerMetadata scanner_metadata = 6;
+  map<string, RuleInfo> rules = 7 [deprecated = true]; // rely on ruleIds instead
+  ScanningSource scanning_source = 8;
+  repeated string rule_ids = 9;
+}