diff --git a/integrations/armis/manifest.yaml b/integrations/armis/manifest.yaml new file mode 100644 index 0000000..b123884 --- /dev/null +++ b/integrations/armis/manifest.yaml @@ -0,0 +1,70 @@ +id: armis +name: Armis +version: 1.0.0 +description: "Armis (API v1) — device and asset visibility: search devices and alerts with AQL, read a device, and update an alert's status. Secret-key (token exchange) authentication; stdlib-only, no extra Python dependencies." +changelog: "1.0.0 — Initial release: search devices/alerts, get device, update alert status." +category: asset_management + +# Per-instance configuration. The secret key is exchanged for a short-lived +# access token (sent as the 'Authorization' header). +config_schema: + properties: + base_url: + type: string + description: "Armis instance URL (e.g. https://yourtenant.armis.com)" + secret_key: + type: string + description: "Armis secret key" + x-soar-sensitive: true + required: + - base_url + - secret_key + +commands: + - id: search_devices + name: armis-search-devices + description: "Search devices with an AQL expression." + risk: read + inputs_schema: + properties: + aql: { type: string, description: "AQL filter appended to 'in:devices' (e.g. riskLevel:High)" } + length: { type: number, description: "Max results (default 50)" } + required: [] + outputs_schema: { properties: {} } + - id: get_device + name: armis-get-device + description: "Get a single device by ID." + risk: read + inputs_schema: + properties: + device_id: { type: string, description: "Device ID" } + required: [device_id] + outputs_schema: { properties: {} } + - id: search_alerts + name: armis-search-alerts + description: "Search alerts with an AQL expression." + risk: read + inputs_schema: + properties: + aql: { type: string, description: "AQL filter appended to 'in:alerts' (e.g. status:Unhandled)" } + length: { type: number, description: "Max results (default 50)" } + required: [] + outputs_schema: { properties: {} } + - id: update_alert + name: armis-update-alert + description: "Update an alert's status." + inputs_schema: + properties: + alert_id: { type: string, description: "Alert ID" } + status: { type: string, description: "New status (UNHANDLED, SUPPRESSED, or RESOLVED)" } + required: [alert_id, status] + outputs_schema: { properties: {} } + + - id: test_connection + name: armis-test-connection + description: "Verify the secret key via the token exchange (used by the Test button)." + risk: read + inputs_schema: + properties: {} + required: [] + outputs_schema: { properties: {} } diff --git a/integrations/armis/scripts/get_device.py b/integrations/armis/scripts/get_device.py new file mode 100644 index 0000000..923ad91 --- /dev/null +++ b/integrations/armis/scripts/get_device.py @@ -0,0 +1,69 @@ +import json, os, sys, urllib.parse, urllib.request, urllib.error + + +def _cfg(): + return json.loads(os.environ.get("INTEGRATION_SECRETS", "{}")) + + +def _inputs(): + return json.loads(os.environ.get("INTEGRATION_INPUTS", "{}")) + + +def _base(cfg): + return str(cfg.get("base_url", "")).rstrip("/") + "/api/v1" + + +def _token(cfg): + form = urllib.parse.urlencode({"secret_key": str(cfg.get("secret_key", ""))}).encode("utf-8") + req = urllib.request.Request(_base(cfg) + "/access_token/", data=form, + headers={"Content-Type": "application/x-www-form-urlencoded", + "Accept": "application/json"}, method="POST") + with urllib.request.urlopen(req, timeout=60) as r: + tok = json.loads(r.read()) + at = (tok.get("data") or {}).get("access_token") + if not at: + raise Exception("Token request failed: " + json.dumps(tok)) + return at + + +def request(method, path, cfg, token, body=None, params=None): + url = _base(cfg) + path + if params: + clean = {k: v for k, v in params.items() if v not in (None, "")} + if clean: + url += "?" + urllib.parse.urlencode(clean) + data = json.dumps(body).encode("utf-8") if body is not None else None + headers = {"Authorization": token, "Accept": "application/json"} + if data is not None: + headers["Content-Type"] = "application/json" + req = urllib.request.Request(url, data=data, headers=headers, method=method) + with urllib.request.urlopen(req, timeout=90) as r: + raw = r.read() + return json.loads(raw) if raw else {} + + +def _run(fn): + try: + cfg = _cfg() + inputs = _inputs() + token = _token(cfg) + print(json.dumps(fn(cfg, token, inputs))) + except urllib.error.HTTPError as e: + print(json.dumps({"error": "HTTP " + str(e.code), "detail": e.read().decode("utf-8", "replace")})) + sys.exit(1) + except Exception as e: + print(json.dumps({"error": str(e)})) + sys.exit(1) + + +q = lambda v: urllib.parse.quote(str(v), safe="") + + +def main(cfg, token, inputs): + device_id = inputs.get("device_id") + if not device_id: + raise Exception("device_id is required") + return request("GET", "/devices/" + q(device_id) + "/", cfg, token) + + +_run(main) diff --git a/integrations/armis/scripts/search_alerts.py b/integrations/armis/scripts/search_alerts.py new file mode 100644 index 0000000..d96bf97 --- /dev/null +++ b/integrations/armis/scripts/search_alerts.py @@ -0,0 +1,66 @@ +import json, os, sys, urllib.parse, urllib.request, urllib.error + + +def _cfg(): + return json.loads(os.environ.get("INTEGRATION_SECRETS", "{}")) + + +def _inputs(): + return json.loads(os.environ.get("INTEGRATION_INPUTS", "{}")) + + +def _base(cfg): + return str(cfg.get("base_url", "")).rstrip("/") + "/api/v1" + + +def _token(cfg): + form = urllib.parse.urlencode({"secret_key": str(cfg.get("secret_key", ""))}).encode("utf-8") + req = urllib.request.Request(_base(cfg) + "/access_token/", data=form, + headers={"Content-Type": "application/x-www-form-urlencoded", + "Accept": "application/json"}, method="POST") + with urllib.request.urlopen(req, timeout=60) as r: + tok = json.loads(r.read()) + at = (tok.get("data") or {}).get("access_token") + if not at: + raise Exception("Token request failed: " + json.dumps(tok)) + return at + + +def request(method, path, cfg, token, body=None, params=None): + url = _base(cfg) + path + if params: + clean = {k: v for k, v in params.items() if v not in (None, "")} + if clean: + url += "?" + urllib.parse.urlencode(clean) + data = json.dumps(body).encode("utf-8") if body is not None else None + headers = {"Authorization": token, "Accept": "application/json"} + if data is not None: + headers["Content-Type"] = "application/json" + req = urllib.request.Request(url, data=data, headers=headers, method=method) + with urllib.request.urlopen(req, timeout=90) as r: + raw = r.read() + return json.loads(raw) if raw else {} + + +def _run(fn): + try: + cfg = _cfg() + inputs = _inputs() + token = _token(cfg) + print(json.dumps(fn(cfg, token, inputs))) + except urllib.error.HTTPError as e: + print(json.dumps({"error": "HTTP " + str(e.code), "detail": e.read().decode("utf-8", "replace")})) + sys.exit(1) + except Exception as e: + print(json.dumps({"error": str(e)})) + sys.exit(1) + + +def main(cfg, token, inputs): + aql = inputs.get("aql") + length = inputs.get("length") + aql_str = "in:alerts" + ((" " + aql) if aql else "") + return request("GET", "/search/", cfg, token, params={"aql": aql_str, "length": int(length or 50)}) + + +_run(main) diff --git a/integrations/armis/scripts/search_devices.py b/integrations/armis/scripts/search_devices.py new file mode 100644 index 0000000..500becb --- /dev/null +++ b/integrations/armis/scripts/search_devices.py @@ -0,0 +1,66 @@ +import json, os, sys, urllib.parse, urllib.request, urllib.error + + +def _cfg(): + return json.loads(os.environ.get("INTEGRATION_SECRETS", "{}")) + + +def _inputs(): + return json.loads(os.environ.get("INTEGRATION_INPUTS", "{}")) + + +def _base(cfg): + return str(cfg.get("base_url", "")).rstrip("/") + "/api/v1" + + +def _token(cfg): + form = urllib.parse.urlencode({"secret_key": str(cfg.get("secret_key", ""))}).encode("utf-8") + req = urllib.request.Request(_base(cfg) + "/access_token/", data=form, + headers={"Content-Type": "application/x-www-form-urlencoded", + "Accept": "application/json"}, method="POST") + with urllib.request.urlopen(req, timeout=60) as r: + tok = json.loads(r.read()) + at = (tok.get("data") or {}).get("access_token") + if not at: + raise Exception("Token request failed: " + json.dumps(tok)) + return at + + +def request(method, path, cfg, token, body=None, params=None): + url = _base(cfg) + path + if params: + clean = {k: v for k, v in params.items() if v not in (None, "")} + if clean: + url += "?" + urllib.parse.urlencode(clean) + data = json.dumps(body).encode("utf-8") if body is not None else None + headers = {"Authorization": token, "Accept": "application/json"} + if data is not None: + headers["Content-Type"] = "application/json" + req = urllib.request.Request(url, data=data, headers=headers, method=method) + with urllib.request.urlopen(req, timeout=90) as r: + raw = r.read() + return json.loads(raw) if raw else {} + + +def _run(fn): + try: + cfg = _cfg() + inputs = _inputs() + token = _token(cfg) + print(json.dumps(fn(cfg, token, inputs))) + except urllib.error.HTTPError as e: + print(json.dumps({"error": "HTTP " + str(e.code), "detail": e.read().decode("utf-8", "replace")})) + sys.exit(1) + except Exception as e: + print(json.dumps({"error": str(e)})) + sys.exit(1) + + +def main(cfg, token, inputs): + aql = inputs.get("aql") + length = inputs.get("length") + aql_str = "in:devices" + ((" " + aql) if aql else "") + return request("GET", "/search/", cfg, token, params={"aql": aql_str, "length": int(length or 50)}) + + +_run(main) diff --git a/integrations/armis/scripts/test_connection.py b/integrations/armis/scripts/test_connection.py new file mode 100644 index 0000000..441a76a --- /dev/null +++ b/integrations/armis/scripts/test_connection.py @@ -0,0 +1,64 @@ +import json, os, sys, urllib.parse, urllib.request, urllib.error + + +def _cfg(): + return json.loads(os.environ.get("INTEGRATION_SECRETS", "{}")) + + +def _inputs(): + return json.loads(os.environ.get("INTEGRATION_INPUTS", "{}")) + + +def _base(cfg): + return str(cfg.get("base_url", "")).rstrip("/") + "/api/v1" + + +def _token(cfg): + form = urllib.parse.urlencode({"secret_key": str(cfg.get("secret_key", ""))}).encode("utf-8") + req = urllib.request.Request(_base(cfg) + "/access_token/", data=form, + headers={"Content-Type": "application/x-www-form-urlencoded", + "Accept": "application/json"}, method="POST") + with urllib.request.urlopen(req, timeout=60) as r: + tok = json.loads(r.read()) + at = (tok.get("data") or {}).get("access_token") + if not at: + raise Exception("Token request failed: " + json.dumps(tok)) + return at + + +def request(method, path, cfg, token, body=None, params=None): + url = _base(cfg) + path + if params: + clean = {k: v for k, v in params.items() if v not in (None, "")} + if clean: + url += "?" + urllib.parse.urlencode(clean) + data = json.dumps(body).encode("utf-8") if body is not None else None + headers = {"Authorization": token, "Accept": "application/json"} + if data is not None: + headers["Content-Type"] = "application/json" + req = urllib.request.Request(url, data=data, headers=headers, method=method) + with urllib.request.urlopen(req, timeout=90) as r: + raw = r.read() + return json.loads(raw) if raw else {} + + +def _run(fn): + try: + cfg = _cfg() + inputs = _inputs() + token = _token(cfg) + print(json.dumps(fn(cfg, token, inputs))) + except urllib.error.HTTPError as e: + print(json.dumps({"error": "HTTP " + str(e.code), "detail": e.read().decode("utf-8", "replace")})) + sys.exit(1) + except Exception as e: + print(json.dumps({"error": str(e)})) + sys.exit(1) + + +def main(cfg, token, inputs): + request("GET", "/search/", cfg, token, params={"aql": "in:devices", "length": 1}) + return {"ok": True} + + +_run(main) diff --git a/integrations/armis/scripts/update_alert.py b/integrations/armis/scripts/update_alert.py new file mode 100644 index 0000000..5a84cd1 --- /dev/null +++ b/integrations/armis/scripts/update_alert.py @@ -0,0 +1,75 @@ +import json, os, sys, urllib.parse, urllib.request, urllib.error + + +def _cfg(): + return json.loads(os.environ.get("INTEGRATION_SECRETS", "{}")) + + +def _inputs(): + return json.loads(os.environ.get("INTEGRATION_INPUTS", "{}")) + + +def _base(cfg): + return str(cfg.get("base_url", "")).rstrip("/") + "/api/v1" + + +def _token(cfg): + form = urllib.parse.urlencode({"secret_key": str(cfg.get("secret_key", ""))}).encode("utf-8") + req = urllib.request.Request(_base(cfg) + "/access_token/", data=form, + headers={"Content-Type": "application/x-www-form-urlencoded", + "Accept": "application/json"}, method="POST") + with urllib.request.urlopen(req, timeout=60) as r: + tok = json.loads(r.read()) + at = (tok.get("data") or {}).get("access_token") + if not at: + raise Exception("Token request failed: " + json.dumps(tok)) + return at + + +def request(method, path, cfg, token, body=None, params=None): + url = _base(cfg) + path + if params: + clean = {k: v for k, v in params.items() if v not in (None, "")} + if clean: + url += "?" + urllib.parse.urlencode(clean) + data = json.dumps(body).encode("utf-8") if body is not None else None + headers = {"Authorization": token, "Accept": "application/json"} + if data is not None: + headers["Content-Type"] = "application/json" + req = urllib.request.Request(url, data=data, headers=headers, method=method) + with urllib.request.urlopen(req, timeout=90) as r: + raw = r.read() + return json.loads(raw) if raw else {} + + +def _run(fn): + try: + cfg = _cfg() + inputs = _inputs() + token = _token(cfg) + print(json.dumps(fn(cfg, token, inputs))) + except urllib.error.HTTPError as e: + print(json.dumps({"error": "HTTP " + str(e.code), "detail": e.read().decode("utf-8", "replace")})) + sys.exit(1) + except Exception as e: + print(json.dumps({"error": str(e)})) + sys.exit(1) + + +q = lambda v: urllib.parse.quote(str(v), safe="") + + +def main(cfg, token, inputs): + alert_id = inputs.get("alert_id") + status = inputs.get("status") + if not alert_id: + raise Exception("alert_id is required") + if not status: + raise Exception("status is required") + resp = request("PATCH", "/alerts/" + q(alert_id) + "/", cfg, token, body={"status": status}) + if not resp: + return {"ok": True, "alert_id": alert_id} + return resp + + +_run(main)