Skip to content

Commit 1bf4334

Browse files
throuxelthrouxel
committed
chore(reversinglabs-malware-presence): generate config schema and doc
1 parent ffeea86 commit 1bf4334

2 files changed

Lines changed: 123 additions & 0 deletions

File tree

‎internal-enrichment/reversinglabs-malware-presence/__metadata__/CONNECTOR_CONFIG_DOC.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Connector Configurations
2+
3+
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.
4+
5+
### Type: `object`
6+
7+
| Property | Type | Required | Possible values | Default | Description |
8+
| -------- | ---- | -------- | --------------- | ------- | ----------- |
9+
| OPENCTI_URL | `string` | ✅ | Format: [`uri`](https://json-schema.org/understanding-json-schema/reference/string#built-in-formats) | | The base URL of the OpenCTI instance. |
10+
| OPENCTI_TOKEN | `string` | ✅ | string | | The API token to connect to OpenCTI. |
11+
| REVERSINGLABS_TITANIUMCLOUD_USERNAME | `string` | ✅ | string | | The username for the ReversingLabs TitaniumCloud API. |
12+
| REVERSINGLABS_TITANIUMCLOUD_PASSWORD | `string` | ✅ | Format: [`password`](https://json-schema.org/understanding-json-schema/reference/string#built-in-formats) | | The password for the ReversingLabs TitaniumCloud API. |
13+
| CONNECTOR_NAME | `string` | | string | `"ReversingLabs Malware Presence"` | The name of the connector. |
14+
| CONNECTOR_SCOPE | `array` | | string | `["StixFile", "File", "File-sha1", "File-sha256", "Artifact", "IPv4-Addr", "IPv6-Addr", "Url", "Domain-Name"]` | The scope of the connector. |
15+
| CONNECTOR_LOG_LEVEL | `string` | | `debug` `info` `warn` `warning` `error` | `"error"` | The minimum level of logs to display. |
16+
| CONNECTOR_TYPE | `const` | | `INTERNAL_ENRICHMENT` | `"INTERNAL_ENRICHMENT"` | |
17+
| CONNECTOR_AUTO | `boolean` | | boolean | `false` | Whether the connector should run automatically when an entity is created or updated. |
18+
| REVERSINGLABS_TITANIUMCLOUD_URL | `string` | | string | `"data.reversinglabs.com"` | The hostname of the ReversingLabs TitaniumCloud API. |
19+
| REVERSINGLABS_MAX_TLP | `string` | | `TLP:CLEAR` `TLP:WHITE` `TLP:GREEN` `TLP:AMBER` `TLP:AMBER+STRICT` `TLP:RED` | `"TLP:AMBER"` | The maximal TLP of the observable being enriched. |
20+
| REVERSINGLABS_CREATE_INDICATORS | `boolean` | | boolean | `true` | Whether to create indicators from enrichment results. |

‎internal-enrichment/reversinglabs-malware-presence/__metadata__/connector_config_schema.json‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
{
2+
"$schema": "https://json-schema.org/draft/2020-12/schema",
3+
"$id": "https://www.filigran.io/connectors/reversinglabs-malware-presence_config.schema.json",
4+
"type": "object",
5+
"properties": {
6+
"OPENCTI_URL": {
7+
"description": "The base URL of the OpenCTI instance.",
8+
"format": "uri",
9+
"maxLength": 2083,
10+
"minLength": 1,
11+
"type": "string"
12+
},
13+
"OPENCTI_TOKEN": {
14+
"description": "The API token to connect to OpenCTI.",
15+
"type": "string"
16+
},
17+
"CONNECTOR_NAME": {
18+
"default": "ReversingLabs Malware Presence",
19+
"description": "The name of the connector.",
20+
"type": "string"
21+
},
22+
"CONNECTOR_SCOPE": {
23+
"default": [
24+
"StixFile",
25+
"File",
26+
"File-sha1",
27+
"File-sha256",
28+
"Artifact",
29+
"IPv4-Addr",
30+
"IPv6-Addr",
31+
"Url",
32+
"Domain-Name"
33+
],
34+
"description": "The scope of the connector.",
35+
"items": {
36+
"type": "string"
37+
},
38+
"type": "array"
39+
},
40+
"CONNECTOR_LOG_LEVEL": {
41+
"default": "error",
42+
"description": "The minimum level of logs to display.",
43+
"enum": [
44+
"debug",
45+
"info",
46+
"warn",
47+
"warning",
48+
"error"
49+
],
50+
"type": "string"
51+
},
52+
"CONNECTOR_TYPE": {
53+
"const": "INTERNAL_ENRICHMENT",
54+
"default": "INTERNAL_ENRICHMENT",
55+
"type": "string"
56+
},
57+
"CONNECTOR_AUTO": {
58+
"default": false,
59+
"description": "Whether the connector should run automatically when an entity is created or updated.",
60+
"type": "boolean"
61+
},
62+
"REVERSINGLABS_TITANIUMCLOUD_URL": {
63+
"default": "data.reversinglabs.com",
64+
"description": "The hostname of the ReversingLabs TitaniumCloud API.",
65+
"type": "string"
66+
},
67+
"REVERSINGLABS_TITANIUMCLOUD_USERNAME": {
68+
"description": "The username for the ReversingLabs TitaniumCloud API.",
69+
"type": "string"
70+
},
71+
"REVERSINGLABS_TITANIUMCLOUD_PASSWORD": {
72+
"description": "The password for the ReversingLabs TitaniumCloud API.",
73+
"format": "password",
74+
"type": "string",
75+
"writeOnly": true
76+
},
77+
"REVERSINGLABS_MAX_TLP": {
78+
"default": "TLP:AMBER",
79+
"description": "The maximal TLP of the observable being enriched.",
80+
"enum": [
81+
"TLP:CLEAR",
82+
"TLP:WHITE",
83+
"TLP:GREEN",
84+
"TLP:AMBER",
85+
"TLP:AMBER+STRICT",
86+
"TLP:RED"
87+
],
88+
"type": "string"
89+
},
90+
"REVERSINGLABS_CREATE_INDICATORS": {
91+
"default": true,
92+
"description": "Whether to create indicators from enrichment results.",
93+
"type": "boolean"
94+
}
95+
},
96+
"required": [
97+
"OPENCTI_URL",
98+
"OPENCTI_TOKEN",
99+
"REVERSINGLABS_TITANIUMCLOUD_USERNAME",
100+
"REVERSINGLABS_TITANIUMCLOUD_PASSWORD"
101+
],
102+
"additionalProperties": true
103+
}

0 commit comments

Comments
 (0)