[shadowtrackr] Add connector_config_schema.json

internal-enrichment/shadowtrackr/__metadata__/CONNECTOR_CONFIG_DOC.md

@@ -0,0 +1,20 @@
+# Connector Configurations
+
+Below is an exhaustive enumeration of all configurable parameters available, each accompanied by detailed explanations of their purposes, default behaviors, and usage guidelines to help you understand and utilize them effectively.
+
+### Type: `object`
+
+| Property | Type | Required | Possible values | Default | Description |
+| -------- | ---- | -------- | --------------- | ------- | ----------- |
+| OPENCTI_URL | `string` | ✅ | Format: [`uri`](https://json-schema.org/understanding-json-schema/reference/string#built-in-formats) |  | The base URL of the OpenCTI instance. |
+| OPENCTI_TOKEN | `string` | ✅ | string |  | The API token to connect to OpenCTI. |
+| CONNECTOR_SCOPE | `array` | ✅ | string |  | The scope of the connector, e.g. 'flashpoint'. |
+| SHADOWTRACKR_API_KEY | `string` | ✅ | string |  | API key for authentication. |
+| CONNECTOR_NAME | `string` |  | string | `"ShadowTrackrConnector"` | The name of the connector. |
+| CONNECTOR_LOG_LEVEL | `string` |  | `debug` `info` `warn` `warning` `error` | `"error"` | The minimum level of logs to display. |
+| CONNECTOR_TYPE | `const` |  | `INTERNAL_ENRICHMENT` | `"INTERNAL_ENRICHMENT"` |  |
+| CONNECTOR_AUTO | `boolean` |  | boolean | `false` | Whether the connector should run automatically when an entity is created or updated. |
+| SHADOWTRACKR_BASE_URL | `string` |  | Format: [`uri`](https://json-schema.org/understanding-json-schema/reference/string#built-in-formats) | `"https://shadowtrackr.com/api/v3"` | Base URL of the ShadowTrackr API. |
+| SHADOWTRACKR_MAX_TLP | `string` |  | `TLP:WHITE` `TLP:CLEAR` `TLP:GREEN` `TLP:AMBER` `TLP:AMBER+STRICT` `TLP:RED` | `"TLP:AMBER"` | Max TLP level of the entities to enrich. |
+| SHADOWTRACKR_REPLACE_WITH_LOWER_SCORE | `boolean` |  | boolean | `false` | Replace the score with a lower score based on the ShadowTrackr false positive estimate. |
+| SHADOWTRACKR_REPLACE_VALID_TO_DATE | `boolean` |  | boolean | `false` | Set the valid to date to tomorrow for CDNs, Clouds and VPNs. |

internal-enrichment/shadowtrackr/__metadata__/connector_config_schema.json

@@ -0,0 +1,94 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://www.filigran.io/connectors/shadowtrackr_config.schema.json",
+  "type": "object",
+  "properties": {
+    "OPENCTI_URL": {
+      "description": "The base URL of the OpenCTI instance.",
+      "format": "uri",
+      "maxLength": 2083,
+      "minLength": 1,
+      "type": "string"
+    },
+    "OPENCTI_TOKEN": {
+      "description": "The API token to connect to OpenCTI.",
+      "type": "string"
+    },
+    "CONNECTOR_NAME": {
+      "default": "ShadowTrackrConnector",
+      "description": "The name of the connector.",
+      "type": "string"
+    },
+    "CONNECTOR_SCOPE": {
+      "description": "The scope of the connector, e.g. 'flashpoint'.",
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "CONNECTOR_LOG_LEVEL": {
+      "default": "error",
+      "description": "The minimum level of logs to display.",
+      "enum": [
+        "debug",
+        "info",
+        "warn",
+        "warning",
+        "error"
+      ],
+      "type": "string"
+    },
+    "CONNECTOR_TYPE": {
+      "const": "INTERNAL_ENRICHMENT",
+      "default": "INTERNAL_ENRICHMENT",
+      "type": "string"
+    },
+    "CONNECTOR_AUTO": {
+      "default": false,
+      "description": "Whether the connector should run automatically when an entity is created or updated.",
+      "type": "boolean"
+    },
+    "SHADOWTRACKR_BASE_URL": {
+      "default": "https://shadowtrackr.com/api/v3",
+      "description": "Base URL of the ShadowTrackr API.",
+      "format": "uri",
+      "maxLength": 2083,
+      "minLength": 1,
+      "type": "string"
+    },
+    "SHADOWTRACKR_API_KEY": {
+      "description": "API key for authentication.",
+      "type": "string"
+    },
+    "SHADOWTRACKR_MAX_TLP": {
+      "default": "TLP:AMBER",
+      "description": "Max TLP level of the entities to enrich.",
+      "enum": [
+        "TLP:WHITE",
+        "TLP:CLEAR",
+        "TLP:GREEN",
+        "TLP:AMBER",
+        "TLP:AMBER+STRICT",
+        "TLP:RED"
+      ],
+      "type": "string"
+    },
+    "SHADOWTRACKR_REPLACE_WITH_LOWER_SCORE": {
+      "default": false,
+      "description": "Replace the score with a lower score based on the ShadowTrackr false positive estimate.",
+      "type": "boolean"
+    },
+    "SHADOWTRACKR_REPLACE_VALID_TO_DATE": {
+      "default": false,
+      "description": "Set the valid to date to tomorrow for CDNs, Clouds and VPNs.",
+      "type": "boolean"
+    }
+  },
+  "required": [
+    "OPENCTI_URL",
+    "OPENCTI_TOKEN",
+    "CONNECTOR_SCOPE",
+    "SHADOWTRACKR_API_KEY"
+  ],
+  "additionalProperties": true
+}