veltro-sdk 0.15.7__tar.gz

veltro_sdk-0.15.7/.gitignore

@@ -0,0 +1,46 @@
+# Deployment secrets — never commit. versions.env IS committed (pins only, no secrets).
+.env
+*.env.local
+/.seed-demo.env
+# Demo sandbox handoff: per-run dataset ids, rule/alert ids and case keys that
+# `veltro demo seed` writes for the parameterised e2e (mode 0600, no secrets,
+# but run-local state that must never be committed).
+/.demo-datasets.json
+# Materialised suite-identity secret files (mode 0600 bind sources): the
+# materialiser writes them under compose/secrets/ (the include-relative bind
+# path), and the pre-#635 cwd-relative secrets/ legacy location must stay
+# uncommittable too. A materialised keyring must never reach a runner commit.
+/secrets/
+/compose/secrets/
+# Agent enrollment token drop (mode-0600 bind source, VF_ENROLLMENT_TOKEN_DIR).
+# The seeder mints a real environment-scoped credential into this directory.
+/.suite/
+# Operator-supplied monitoring credentials. Keep directory placeholders only.
+/observability/*/secrets/*
+!/observability/*/secrets/.gitkeep
+
+
+# Editor / OS noise
+.DS_Store
+.vscode/
+
+# E2E harness (Node/Playwright)
+node_modules/
+.next/
+*.tsbuildinfo
+/test-results/
+/playwright-report/
+/blob-report/
+/.playwright/
+# Repository agent instructions are intentionally versioned.
+!CLAUDE.md
+!AGENTS.md
+
+# suite manifest build artifacts
+dist/
+__pycache__/
+# Static Storybook build of packages/ui (design-system.yml).
+packages/*/storybook-static/
+
+# Helm dependency build output; rebuild from chart sources in CI.
+/charts/*/charts/*.tgz

veltro_sdk-0.15.7/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

veltro_sdk-0.15.7/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: veltro-sdk
+Version: 0.15.7
+Summary: Python client for the Veltro security operations suite (VectorFlow, CHAD, Warden).
+Project-URL: Repository, https://github.com/veltrosecurity/veltro
+Project-URL: Documentation, https://veltrosecurity.github.io/veltro/operate/sdks/
+Author: Veltro Security
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: sdk,security,siem,soar,veltro
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Security
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# veltro-sdk
+
+Python client for the [Veltro](https://github.com/veltrosecurity/veltro) security
+operations suite: **VectorFlow** (telemetry pipelines), **CHAD** (detection) and
+**Warden** (SOAR / cases).
+
+- No runtime dependencies — stdlib `urllib` only.
+- Generated from the products' own OpenAPI documents, with a CI gate that fails
+  when a product's API moves and the bindings do not
+  (`scripts/generate_sdk.py check`).
+- Apache-2.0, so it can be embedded in your own tooling regardless of the
+  AGPL-3.0 servers it talks to.
+
+Install:
+
+```bash
+pip install veltro-sdk
+```
+
+## Suite deployment
+
+One origin, one identity session, three products. The gateway serves CHAD at
+`/chad`, Warden at `/warden` and VectorFlow at `/vectorflow`, and exchanges the
+identity session cookie for a short-lived request assertion toward each
+product — so one login reaches all three.
+
+```python
+from veltro_sdk import VeltroClient
+
+suite = VeltroClient.login(
+    "https://soc.example.com",
+    "analyst@example.com",
+    password,
+    vectorflow_key="vf_live_…",   # VectorFlow REST v1 takes a service-account key
+)
+
+for source in suite.chad.data_sources.list():
+    print(source["name"])
+
+cases = suite.warden.cases.list(params={"limit": 25, "status": "open"})
+pipelines = suite.vectorflow.pipelines.list()
+```
+
+VectorFlow's REST v1 accepts **only** an environment-scoped service-account key
+(`Authorization: Bearer vf_live_…`); a browser session authenticates the UI and
+tRPC, not `/api/v1`. A client built without one refuses at the call site with
+`MissingCredential` rather than sending a credential VectorFlow will reject.
+
+## One product with a personal access token
+
+Create a personal access token (`vmcp_…`) in the suite and send it as a bearer
+to the product's gateway prefix. Identity turns it into the request assertion
+the product checks, so the same token works for CHAD and Warden:
+
+```python
+from veltro_sdk import ChadClient, WardenClient, BearerToken
+
+chad = ChadClient("https://soc.example.com/chad", auth=BearerToken(pat))
+chad.rules.list()
+
+warden = WardenClient("https://soc.example.com/warden", auth=BearerToken(pat))
+warden.runbooks.list()
+```
+
+VectorFlow's `/api/v1` still wants its service-account key, so pass
+`BearerToken("vf_live_…")` to `VectorFlowClient`.
+
+## Calling convention
+
+Every operation is a method on a resource namespace. Path parameters are
+positional and percent-encoded; everything else is a keyword option passed to
+the transport:
+
+```python
+client.data_sources.get("ds-123")                       # path parameter
+client.alerts.list(params={"status": "open", "limit": 50})
+client.rules.create(json={"title": "…", "sigma_yaml": "…"})
+client.export.download(raw=True)                        # bytes, not JSON
+```
+
+| Option | Meaning |
+| --- | --- |
+| `params` | query parameters (`None` values dropped, lists repeat the key) |
+| `json` | JSON request body |
+| `data` | raw request body |
+| `headers` | extra headers, applied after the credential |
+| `timeout` | per-request timeout override (seconds) |
+| `raw` | return `bytes` instead of parsed JSON |
+
+Responses are the products' JSON, decoded — the SDK does not reshape them. The
+field-level reference is each product's OpenAPI document (`/openapi.json` on
+CHAD and Warden, `/api/v1/openapi.json` on VectorFlow).
+
+## Errors
+
+| Exception | Raised when |
+| --- | --- |
+| `VeltroAPIError` | any non-2xx; carries `.status`, `.code` (the product's own refusal name), `.message`, `.body` |
+| `VeltroTransportError` | the request never produced a response (DNS, TLS, connect, timeout) |
+| `VeltroResponseTooLarge` | the response exceeded `max_response_bytes` (32 MiB default), enforced while streaming |
+| `MissingCredential` | a product namespace was used without a credential it accepts |
+
+`429`, `502`, `503` and `504` are retried twice with exponential backoff,
+honouring `Retry-After`. Nothing else is retried: a `409` or `422` is the
+product's answer, not a transient fault.
+
+Credentials are never logged: every credential object masks its material in
+`repr`, and the transport keeps request headers out of exception messages.
+
+A suite session is scoped to the origin that minted it. Pointing a product
+client at a different origin while passing `auth=session` sends no cookie
+there rather than the suite session — the cookie runs through
+`http.cookiejar`, so `Domain`, `Path` and `Secure` are all honoured.
+
+## Coverage
+
+| Product | Resources | Operations | Generated from |
+| --- | --- | --- | --- |
+| CHAD | 52 | 365 | CHAD 0.43.2 OpenAPI |
+| Warden | 27 | 123 | Warden 0.11.7 OpenAPI |
+| VectorFlow | 9 | 41 | VectorFlow REST API 2.0.0 |
+
+Machine planes are deliberately not bound — product-peer and external
+writeback seams (workload-exchange authorised), SCIM, ingest, agent enrollment,
+inbound webhook receivers, the unauthenticated case portal, and VectorFlow's
+tRPC transport. Each exclusion and its reason is recorded in
+`sdk/specs/<product>-operations.json`.
+
+`client.resource_names` lists the namespaces a client exposes.

veltro_sdk-0.15.7/README.md

@@ -0,0 +1,129 @@
+# veltro-sdk
+
+Python client for the [Veltro](https://github.com/veltrosecurity/veltro) security
+operations suite: **VectorFlow** (telemetry pipelines), **CHAD** (detection) and
+**Warden** (SOAR / cases).
+
+- No runtime dependencies — stdlib `urllib` only.
+- Generated from the products' own OpenAPI documents, with a CI gate that fails
+  when a product's API moves and the bindings do not
+  (`scripts/generate_sdk.py check`).
+- Apache-2.0, so it can be embedded in your own tooling regardless of the
+  AGPL-3.0 servers it talks to.
+
+Install:
+
+```bash
+pip install veltro-sdk
+```
+
+## Suite deployment
+
+One origin, one identity session, three products. The gateway serves CHAD at
+`/chad`, Warden at `/warden` and VectorFlow at `/vectorflow`, and exchanges the
+identity session cookie for a short-lived request assertion toward each
+product — so one login reaches all three.
+
+```python
+from veltro_sdk import VeltroClient
+
+suite = VeltroClient.login(
+    "https://soc.example.com",
+    "analyst@example.com",
+    password,
+    vectorflow_key="vf_live_…",   # VectorFlow REST v1 takes a service-account key
+)
+
+for source in suite.chad.data_sources.list():
+    print(source["name"])
+
+cases = suite.warden.cases.list(params={"limit": 25, "status": "open"})
+pipelines = suite.vectorflow.pipelines.list()
+```
+
+VectorFlow's REST v1 accepts **only** an environment-scoped service-account key
+(`Authorization: Bearer vf_live_…`); a browser session authenticates the UI and
+tRPC, not `/api/v1`. A client built without one refuses at the call site with
+`MissingCredential` rather than sending a credential VectorFlow will reject.
+
+## One product with a personal access token
+
+Create a personal access token (`vmcp_…`) in the suite and send it as a bearer
+to the product's gateway prefix. Identity turns it into the request assertion
+the product checks, so the same token works for CHAD and Warden:
+
+```python
+from veltro_sdk import ChadClient, WardenClient, BearerToken
+
+chad = ChadClient("https://soc.example.com/chad", auth=BearerToken(pat))
+chad.rules.list()
+
+warden = WardenClient("https://soc.example.com/warden", auth=BearerToken(pat))
+warden.runbooks.list()
+```
+
+VectorFlow's `/api/v1` still wants its service-account key, so pass
+`BearerToken("vf_live_…")` to `VectorFlowClient`.
+
+## Calling convention
+
+Every operation is a method on a resource namespace. Path parameters are
+positional and percent-encoded; everything else is a keyword option passed to
+the transport:
+
+```python
+client.data_sources.get("ds-123")                       # path parameter
+client.alerts.list(params={"status": "open", "limit": 50})
+client.rules.create(json={"title": "…", "sigma_yaml": "…"})
+client.export.download(raw=True)                        # bytes, not JSON
+```
+
+| Option | Meaning |
+| --- | --- |
+| `params` | query parameters (`None` values dropped, lists repeat the key) |
+| `json` | JSON request body |
+| `data` | raw request body |
+| `headers` | extra headers, applied after the credential |
+| `timeout` | per-request timeout override (seconds) |
+| `raw` | return `bytes` instead of parsed JSON |
+
+Responses are the products' JSON, decoded — the SDK does not reshape them. The
+field-level reference is each product's OpenAPI document (`/openapi.json` on
+CHAD and Warden, `/api/v1/openapi.json` on VectorFlow).
+
+## Errors
+
+| Exception | Raised when |
+| --- | --- |
+| `VeltroAPIError` | any non-2xx; carries `.status`, `.code` (the product's own refusal name), `.message`, `.body` |
+| `VeltroTransportError` | the request never produced a response (DNS, TLS, connect, timeout) |
+| `VeltroResponseTooLarge` | the response exceeded `max_response_bytes` (32 MiB default), enforced while streaming |
+| `MissingCredential` | a product namespace was used without a credential it accepts |
+
+`429`, `502`, `503` and `504` are retried twice with exponential backoff,
+honouring `Retry-After`. Nothing else is retried: a `409` or `422` is the
+product's answer, not a transient fault.
+
+Credentials are never logged: every credential object masks its material in
+`repr`, and the transport keeps request headers out of exception messages.
+
+A suite session is scoped to the origin that minted it. Pointing a product
+client at a different origin while passing `auth=session` sends no cookie
+there rather than the suite session — the cookie runs through
+`http.cookiejar`, so `Domain`, `Path` and `Secure` are all honoured.
+
+## Coverage
+
+| Product | Resources | Operations | Generated from |
+| --- | --- | --- | --- |
+| CHAD | 52 | 365 | CHAD 0.43.2 OpenAPI |
+| Warden | 27 | 123 | Warden 0.11.7 OpenAPI |
+| VectorFlow | 9 | 41 | VectorFlow REST API 2.0.0 |
+
+Machine planes are deliberately not bound — product-peer and external
+writeback seams (workload-exchange authorised), SCIM, ingest, agent enrollment,
+inbound webhook receivers, the unauthenticated case portal, and VectorFlow's
+tRPC transport. Each exclusion and its reason is recorded in
+`sdk/specs/<product>-operations.json`.
+
+`client.resource_names` lists the namespaces a client exposes.

veltro_sdk-0.15.7/pyproject.toml

@@ -0,0 +1,36 @@
+[build-system]
+requires = ["hatchling==1.27.0"]
+build-backend = "hatchling.build"
+
+[project]
+name = "veltro-sdk"
+version = "0.15.7"
+description = "Python client for the Veltro security operations suite (VectorFlow, CHAD, Warden)."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{ name = "Veltro Security" }]
+# No runtime dependencies, deliberately: the SDK must drop into a hardened
+# jump host without a dependency resolver.
+dependencies = []
+keywords = ["veltro", "security", "siem", "soar", "sdk"]
+classifiers = [
+  "License :: OSI Approved :: Apache Software License",
+  "Programming Language :: Python :: 3 :: Only",
+  "Topic :: Security",
+  "Typing :: Typed",
+]
+
+[project.urls]
+Repository = "https://github.com/veltrosecurity/veltro"
+Documentation = "https://veltrosecurity.github.io/veltro/operate/sdks/"
+
+[tool.hatch.build.targets.wheel]
+packages = ["veltro_sdk"]
+
+[tool.hatch.build.targets.sdist]
+include = ["veltro_sdk", "tests", "README.md", "LICENSE", "pyproject.toml"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

veltro_sdk-0.15.7/tests/__init__.py

@@ -0,0 +1 @@
+# SPDX-License-Identifier: Apache-2.0