@lansweeper/scanningconfig-grpc 0.3.7 → 0.4.1

package/java.json

@@ -0,0 +1,6 @@
+{
+  "version": "0.4.0",
+  "package": "lansweeper.scanningconfig.v1",
+  "name": "scanningconfig",
+  "service": true
+}

package/model/pom.xml

@@ -0,0 +1,72 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>lansweeper.scanningconfig.v1</groupId>
+        <artifactId>parent</artifactId>
+        <version>0.4.0</version>
+    </parent>
+
+    <artifactId>scanningconfig-model</artifactId>
+
+    <properties>
+        <maven.compiler.source>17</maven.compiler.source>
+        <maven.compiler.target>17</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+
+    <build>
+        <resources>
+            <resource>
+                <directory>${project.basedir}/src/main/proto</directory>
+            </resource>
+        </resources>
+        <extensions>
+            <extension>
+                <groupId>kr.motd.maven</groupId>
+                <artifactId>os-maven-plugin</artifactId>
+                <version>1.7.1</version>
+            </extension>
+        </extensions>
+        <plugins>
+            <plugin>
+                <groupId>org.xolstice.maven.plugins</groupId>
+                <artifactId>protobuf-maven-plugin</artifactId>
+                <version>0.6.1</version>
+                <configuration>
+                    <protocArtifact>com.google.protobuf:protoc:${protoc.version}:exe:${os.detected.classifier}</protocArtifact>
+                </configuration>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>compile</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-source-plugin</artifactId>
+                <version>3.2.1</version>
+                <executions>
+                    <execution>
+                        <id>attach-sources</id>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.google.protobuf</groupId>
+            <artifactId>protobuf-java</artifactId>
+        </dependency>
+    </dependencies>
+
+</project>

package/model/src/main/proto/scanningconfig.proto

@@ -0,0 +1,364 @@
+syntax = "proto3";
+
+package lansweeper.scanningconfig.v1;
+option go_package = "./generated-go";
+option java_multiple_files = true;
+
+import "google/protobuf/wrappers.proto";
+
+service ScanningConfigService {
+  rpc GetConfigurationsBySource(GetConfigurationsBySourceRequest) returns (GetConfigurationsBySourceResponse) {}
+  rpc DeleteAction(DeleteActionRequest) returns (DeleteActionResponse) {}
+  rpc GetExclusionsBySource(GetExclusionsBySourceRequest) returns (GetExclusionsBySourceResponse) {}
+}
+
+message DeleteActionRequest {
+  string site_id = 1;
+  string action_id = 2;
+}
+
+message DeleteActionResponse {
+  bool success = 1;
+  string message = 2 [deprecated = true];
+}
+  
+message GetConfigurationsBySourceRequest{
+  string source_id = 1;
+  string site_id = 2;
+}
+  
+message GetConfigurationsBySourceResponse{
+  repeated Component configs = 1;
+}
+
+message GetExclusionsBySourceRequest{
+  string source_id = 1;
+  string site_id = 2;
+}
+
+message GetExclusionsBySourceResponse {
+  repeated Exclusion exclusions = 1;
+}
+
+message Exclusion {
+  string id = 1;
+  string reason = 2;
+  repeated string sensor_ids = 3;
+  repeated Target targets = 4;
+}
+
+message Target {
+  enum ExclusionType {
+    UNSPECIFIED = 0;
+    IP_ADDR_RANGE = 1;
+    MAC_ADDR = 2;
+    ASSET_TYPE = 3;
+    FQDN = 4;
+    DOMAIN = 5;
+  }
+  ExclusionType type = 1;
+  repeated string values = 2;
+}
+
+message Component {
+  enum ComponentType {
+    UNSPECIFIED = 0;
+    AGENT = 1;
+    IT_SENSOR = 2;
+    IT_HUB = 3;
+    OT_SENSOR = 4;
+    TRAFFIC_SENSOR = 5;
+  }
+
+  string id = 1;
+  ComponentType type = 2;
+  repeated Action actions = 3;
+  optional OperationalConfig op_config = 4 [deprecated = true];
+  bool enabled = 5; 
+  optional ApplicationConfig app_config = 6;
+}
+
+message AssetRadar{
+  option deprecated = true;
+  bool enabled = 1;
+  repeated string excluded_interfaces = 2;
+}
+
+message NetworkVisibility{
+  option deprecated = true;
+  bool enabled = 1;
+  repeated string excluded_interfaces = 2;
+}
+
+message AutoUpdate{
+  option deprecated = true;
+  bool enabled = 1;
+  string schedule = 2;
+}
+
+message OperationalConfig{
+  optional AssetRadar asset_radar_config = 1 [deprecated = true];
+  optional AutoUpdate auto_update_config = 2;
+  optional NetworkVisibility network_visibility_config = 3;
+}
+
+message Trigger{
+  string cron_expr =1;
+  string name = 2;
+}
+
+message Action{
+  enum ActionType {
+    UNSPECIFIED = 0;
+    AGENT = 1;
+    AGENTLESS = 2;
+  }
+
+  repeated Trigger triggers = 1;
+  ActionType action_type = 2;
+  repeated Credential credentials = 3;
+  oneof definition { 
+    Agent agent = 4 [deprecated = true];  
+    Agentless agentless = 5 [deprecated = true];
+  }
+  ActionDefinition action_definition = 6;
+  string id = 7;
+  string name = 8;
+}
+
+message Agentless{
+  repeated string targets = 1;
+}
+
+message ActionDefinition
+{
+  enum ScanFocus {
+    ALL = 0;
+    USERS = 1;
+    INVENTORY = 2;
+  }
+
+  optional ScanFocus scan_focus = 1;
+  repeated string targets = 2 [deprecated=true];
+  repeated string exclusions = 3;
+  repeated TargetData targets_data = 4;
+}
+
+enum IPScanType {
+  UNKNOWN_IP_SCAN_TYPE = 0;
+  RANGE = 1;
+  HOST = 2;
+}
+
+message TargetData {
+  enum TargetType {
+    UNKNOWN_TARGET_TYPE = 0;
+    IP_SCAN = 1;
+    SCCM = 2;
+    AD = 3;
+  }
+  TargetType type = 1;
+  oneof info {
+    IPScanData ip_scan_data = 2;
+    ADData ad_data = 3;
+    string target = 4 [deprecated=true];
+    SCCMData sccm_data = 5;
+  }
+}
+
+message SCCMData{
+  string target = 1;
+}
+
+message IPScanData {
+  IPScanType type = 1;
+  string target = 2;
+  optional IPScanPing ping = 3;
+}
+
+message IPScanPing {
+  bool use_ping = 1;
+  int32 ping_timeout = 2;
+  bool keep_no_answer_scan = 3;
+}
+
+message ADData {
+  enum LDAPType {
+    UNKNOWN_LDAP_TYPE = 0;
+    LDAP = 1;
+    LDAPS = 2;
+  }
+  string name = 1;
+  string adsi_filter = 2;
+  string domain = 3;
+  bool computer_scan = 4;
+  bool user_group_scan = 5;
+  LDAPType ldap_type = 6;
+  int32 port = 7;
+  string adsi_path = 8;
+}
+
+message Agent{
+  enum ScanFocus {
+    ALL = 0;
+    USERS = 1;
+    INVENTORY = 2;
+  }
+
+  ScanFocus scan_focus = 1;
+}
+
+message Credential{
+  enum CredentialType
+  {
+    UNSPECIFIED = 0;
+  }
+
+  CredentialType type = 1 [deprecated=true];
+  string id = 2;
+  int32 order = 3;
+}
+
+message ApplicationConfig {
+  optional LogSettings logging = 1;
+  optional HubSettings hub = 2;
+  optional UpdateSettings update = 3;
+  optional ItSensorSettings it_sensor = 4;
+  optional OtSensorSettings ot_sensor = 5;
+}
+
+message HubSettings {
+  optional NetworkConfigurationSettings network_configuration = 1;
+  optional MaintenanceSettings maintenance = 2;
+  optional NotificationSettings notifications = 3;
+  optional FeatureFlagSettings feature_flags = 4;
+  optional ScanConfigurationSettings scan_configuration = 5;
+  optional ImportSettings import = 6;  
+}
+
+message MaintenanceSettings {
+  google.protobuf.StringValue maintenance_window = 1; // cron expression
+  optional RetentionPolicySettings retention_policy = 2;
+}
+
+message RetentionPolicySettings {
+  google.protobuf.Int32Value synced_data_retention_days = 1; // default 30 days
+  google.protobuf.Int32Value unsynced_data_retention_days = 2; // default 365 days
+}
+
+message NotificationSettings {
+  google.protobuf.BoolValue smart_polling_enabled = 1;
+  google.protobuf.Int32Value default_polling_interval_seconds = 2; // will only be used if smart polling is disabled, default 60 seconds.
+
+  map<int32, int32> smart_polling_intervals = 3; // key is the polling zero based frequency, value is the polling interval in seconds. Will only be used if smart polling is enabled. I.e: [(0, 15), (1, 60), (2, 120)] = 15 seconds for the high frequency polling, 60 seconds for the normal frequency polling, 120 seconds for the low frequency polling
+}
+
+message FeatureFlagSettings {
+  google.protobuf.Int32Value polling_interval_minutes = 1; // default 15 minutes
+}
+
+message ScanConfigurationSettings {
+  google.protobuf.Int32Value polling_interval_minutes = 1; // default 240 minutes (4 hours)
+}
+
+message ImportSettings {
+  google.protobuf.BoolValue enabled = 1;
+  google.protobuf.Int32Value polling_interval_seconds = 2;
+  google.protobuf.StringValue folder = 3;
+}
+
+message NetworkConfigurationSettings {
+  optional ParallelismSettings parallelism = 1;
+  optional NetworkVisibilitySettings network_visibility = 2;
+  optional PingBehaviorSettings ping_behavior = 3;
+  optional ProtocolConfigurationSettings protocol_configuration = 4;
+  optional ExclusionSettings exclusions = 5;
+}
+
+message ParallelismSettings {
+  google.protobuf.Int32Value max_parallelism = 1;  // default 100
+}
+
+message ExclusionSettings {
+  repeated string excluded_targets = 1; // Ip addresses (including ranges and CIDR notations) or hostnames.
+  repeated string excluded_interfaces = 2; // Network interface names.
+}
+
+message NetworkVisibilitySettings {
+  google.protobuf.BoolValue enabled = 1;
+  google.protobuf.BoolValue active_cdr_enabled = 2; 
+}
+
+message PingBehaviorSettings {
+  // leaving it empty on purpose for now, because we have another task to rework the entire ping behavior. Would be a shame if next sprint, we have to deprecate all these settings already
+}
+
+message ProtocolConfigurationSettings {
+  google.protobuf.BoolValue all_enabled = 1;
+  map<string, ProtocolDetailSettings> protocols = 2;
+}
+
+message ProtocolDetailSettings {
+  google.protobuf.BoolValue enabled = 1;
+  google.protobuf.Int32Value port = 2;
+  map<string, string> additional_data = 3; // additional data for a specific for the protocol
+}
+
+message ItSensorSettings {
+  optional NetworkConfigurationSettings network_configuration = 1;
+}
+
+message OtSensorSettings {
+  optional NetworkConfigurationSettings network_configuration = 1;
+  optional TrafficLogSettings traffic_logging = 2; // used to enable raw traffic packets logging for the OT sensor.
+}
+
+message TrafficLogSettings {
+  google.protobuf.BoolValue enabled = 1;
+  google.protobuf.StringValue path = 2;
+}
+
+message UpdateSettings {
+  google.protobuf.BoolValue update_on_availability = 1; // default false
+  optional UpdateWindowSettings update_window = 2;
+  optional DownloadSettings download = 3;  
+  optional BackupSettings backup = 4;
+  optional PrerequisiteSettings prerequisites = 5;
+}
+
+message UpdateWindowSettings {
+  google.protobuf.BoolValue enabled = 1;
+  google.protobuf.StringValue update_window = 2; // cron expression   
+}
+
+message BackupSettings {
+  google.protobuf.StringValue backup_folder = 1;
+}
+
+message DownloadSettings {  
+  google.protobuf.BoolValue download_on_availability = 1; // default true
+  google.protobuf.StringValue download_window = 2; // cron expression
+  google.protobuf.StringValue download_folder = 3;
+  google.protobuf.Int32Value download_timeout_seconds = 4;
+  google.protobuf.Int32Value throttle_rate_kb_per_second = 5;
+}
+
+message PrerequisiteSettings {
+  google.protobuf.Int64Value required_free_disk_space_bytes = 1;
+  google.protobuf.Int32Value required_free_disk_space_percentage = 2;
+}
+
+message LogSettings {
+  enum LogLevel {
+    VERBOSE = 0;
+    DEBUG = 1;
+    INFORMATION = 2;
+    WARNING = 3;
+    ERROR = 4;
+    FATAL = 5;
+  }
+  optional LogLevel level = 1; // default INFORMATION
+  google.protobuf.Int64Value file_size_limit_bytes = 2; // default 52428800 bytes (50MB)
+  google.protobuf.Int32Value retained_file_count_limit = 3; // default 5
+  map<string,string> overrides = 4;
+}