ventra 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. ventra-0.1.0/LICENSE +202 -0
  2. ventra-0.1.0/PKG-INFO +178 -0
  3. ventra-0.1.0/README.md +141 -0
  4. ventra-0.1.0/collector/__init__.py +11 -0
  5. ventra-0.1.0/collector/__main__.py +8 -0
  6. ventra-0.1.0/collector/aws/__init__.py +5 -0
  7. ventra-0.1.0/collector/aws/client_factory.py +183 -0
  8. ventra-0.1.0/collector/aws/control_plane/cloudtrail.py +331 -0
  9. ventra-0.1.0/collector/aws/control_plane/cloudtrail_s3.py +312 -0
  10. ventra-0.1.0/collector/aws/control_plane/config.py +96 -0
  11. ventra-0.1.0/collector/aws/detections/detective.py +102 -0
  12. ventra-0.1.0/collector/aws/detections/guardduty.py +116 -0
  13. ventra-0.1.0/collector/aws/detections/macie.py +103 -0
  14. ventra-0.1.0/collector/aws/detections/securityhub.py +101 -0
  15. ventra-0.1.0/collector/aws/identity/account.py +71 -0
  16. ventra-0.1.0/collector/aws/identity/iam.py +386 -0
  17. ventra-0.1.0/collector/aws/identity/kms.py +74 -0
  18. ventra-0.1.0/collector/aws/identity/secrets.py +56 -0
  19. ventra-0.1.0/collector/aws/identity/sts.py +74 -0
  20. ventra-0.1.0/collector/aws/network/vpc_flow.py +176 -0
  21. ventra-0.1.0/collector/aws/network/waf.py +144 -0
  22. ventra-0.1.0/collector/aws/registry.py +60 -0
  23. ventra-0.1.0/collector/aws/runner/runner.py +224 -0
  24. ventra-0.1.0/collector/aws/workloads/ec2.py +217 -0
  25. ventra-0.1.0/collector/aws/workloads/lambda_.py +75 -0
  26. ventra-0.1.0/collector/aws/workloads/s3.py +112 -0
  27. ventra-0.1.0/collector/azure/__init__.py +17 -0
  28. ventra-0.1.0/collector/cli.py +388 -0
  29. ventra-0.1.0/collector/devgui.py +350 -0
  30. ventra-0.1.0/collector/gcp/__init__.py +17 -0
  31. ventra-0.1.0/collector/lib/__init__.py +1 -0
  32. ventra-0.1.0/collector/lib/base.py +167 -0
  33. ventra-0.1.0/collector/lib/chain_of_custody/__init__.py +6 -0
  34. ventra-0.1.0/collector/lib/chain_of_custody/hashing.py +21 -0
  35. ventra-0.1.0/collector/lib/chain_of_custody/signing.py +67 -0
  36. ventra-0.1.0/collector/lib/models.py +232 -0
  37. ventra-0.1.0/collector/lib/packaging/__init__.py +5 -0
  38. ventra-0.1.0/collector/lib/packaging/packager.py +77 -0
  39. ventra-0.1.0/collector/lib/transport/__init__.py +5 -0
  40. ventra-0.1.0/collector/lib/transport/base.py +90 -0
  41. ventra-0.1.0/collector/tools/__init__.py +1 -0
  42. ventra-0.1.0/collector/tools/verify_readonly.py +66 -0
  43. ventra-0.1.0/pyproject.toml +65 -0
  44. ventra-0.1.0/setup.cfg +4 -0
  45. ventra-0.1.0/ventra.egg-info/PKG-INFO +178 -0
  46. ventra-0.1.0/ventra.egg-info/SOURCES.txt +48 -0
  47. ventra-0.1.0/ventra.egg-info/dependency_links.txt +1 -0
  48. ventra-0.1.0/ventra.egg-info/entry_points.txt +3 -0
  49. ventra-0.1.0/ventra.egg-info/requires.txt +28 -0
  50. ventra-0.1.0/ventra.egg-info/top_level.txt +1 -0
ventra-0.1.0/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
ventra-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,178 @@
1
+ Metadata-Version: 2.4
2
+ Name: ventra
3
+ Version: 0.1.0
4
+ Summary: Cloud forensic triage — read-only collector, ingester, and analyst console.
5
+ Author: Ventra contributors
6
+ License: Apache-2.0
7
+ Keywords: dfir,incident-response,aws,forensics,cloud
8
+ Requires-Python: >=3.11
9
+ Description-Content-Type: text/markdown
10
+ License-File: LICENSE
11
+ Requires-Dist: boto3>=1.34
12
+ Requires-Dist: botocore>=1.34
13
+ Requires-Dist: rich>=13.7
14
+ Provides-Extra: zstd
15
+ Requires-Dist: zstandard>=0.22; extra == "zstd"
16
+ Provides-Extra: console
17
+ Requires-Dist: fastapi>=0.110; extra == "console"
18
+ Requires-Dist: uvicorn[standard]>=0.29; extra == "console"
19
+ Requires-Dist: duckdb>=0.10; extra == "console"
20
+ Requires-Dist: pyarrow>=15.0; extra == "console"
21
+ Requires-Dist: PyYAML>=6.0; extra == "console"
22
+ Requires-Dist: pydantic>=2.6; extra == "console"
23
+ Requires-Dist: python-multipart>=0.0.9; extra == "console"
24
+ Provides-Extra: dev
25
+ Requires-Dist: pytest>=8.0; extra == "dev"
26
+ Requires-Dist: moto>=5.0; extra == "dev"
27
+ Requires-Dist: ruff>=0.4; extra == "dev"
28
+ Requires-Dist: mypy>=1.10; extra == "dev"
29
+ Requires-Dist: fastapi>=0.110; extra == "dev"
30
+ Requires-Dist: uvicorn[standard]>=0.29; extra == "dev"
31
+ Requires-Dist: duckdb>=0.10; extra == "dev"
32
+ Requires-Dist: pyarrow>=15.0; extra == "dev"
33
+ Requires-Dist: PyYAML>=6.0; extra == "dev"
34
+ Requires-Dist: pydantic>=2.6; extra == "dev"
35
+ Requires-Dist: python-multipart>=0.0.9; extra == "dev"
36
+ Dynamic: license-file
37
+
38
+ <div align="center">
39
+
40
+ # Ventra
41
+
42
+ **Cloud-native incident response triage — collect, normalize, investigate.**
43
+
44
+ Ventra is an open-source toolkit for cloud forensic triage. A responder runs a single
45
+ read-only command in the client's cloud shell; Ventra pulls exactly the logs and
46
+ artifacts incident responders need into a sealed, hash-verified evidence package. The
47
+ package is handed to the IR team, normalized, and investigated in a clean, modern
48
+ analyst console — without ever touching the client environment again.
49
+
50
+ [Documentation](docs/) · [Evidence Package Format](docs/evidence-package-format.md) · [Operator Runbook](docs/runbooks/operator.md) · [Analyst Runbook](docs/runbooks/analyst.md)
51
+
52
+ </div>
53
+
54
+ ---
55
+
56
+ ## What Ventra is
57
+
58
+ Ventra has three loosely-coupled tiers connected by one contract — the
59
+ **Evidence Package Format (EPF)**:
60
+
61
+ | Tier | Runs where | Job |
62
+ |------|------------|-----|
63
+ | **Collector** | Client's cloud shell (AWS first) | Read-only acquisition → sealed evidence package |
64
+ | **Ingester** | IR workstation | Verify → parse → normalize → load |
65
+ | **Console** | IR workstation / forensic VPC | Case-scoped investigation GUI |
66
+
67
+ ```
68
+ ┌────────────────┐ sealed .tar.zst ┌────────────────┐ ┌────────────────┐
69
+ │ COLLECTOR │ ────────────────► │ INGESTER │ ────► │ CONSOLE │
70
+ │ cloud shell │ manifest + sigs │ parse/normalize│ query │ analyst GUI │
71
+ │ read-only IAM │ │ hash-verify │ │ RBAC, offline │
72
+ └────────────────┘ └────────────────┘ └────────────────┘
73
+ ```
74
+
75
+ ## What Ventra is **not**
76
+
77
+ - **Not a SIEM.** Cases are bounded, time-scoped investigations — not always-on pipelines.
78
+ - **Not an EDR or memory-forensics tool.** EC2 OS internals, memory, and full-disk imaging
79
+ stay with Velociraptor / disk-image workflows. Ventra deliberately does not overlap them.
80
+ - **Not a containment tool.** The collector is **strictly read-only**. It never modifies,
81
+ isolates, or terminates resources.
82
+ - **Not a long-term evidence vault.** Ventra defines the evidence format; storage and
83
+ retention are the IR firm's responsibility.
84
+
85
+ ## Forensic principles
86
+
87
+ Ventra is built around the guidance in AWS's
88
+ [Forensic investigation environment strategies](https://aws.amazon.com/blogs/security/forensic-investigation-environment-strategies-in-the-aws-cloud/)
89
+ and standard DFIR practice:
90
+
91
+ 1. **Read-only at the source** — the collector's IAM policy contains zero mutating actions.
92
+ 2. **Hash on acquisition** — SHA-256 every artifact before it leaves the source account.
93
+ 3. **Immutable evidence** — packages are sealed and signed; the ingester works on copies.
94
+ 4. **Chain of custody is first-class** — operator, timestamps, account, tool version, and
95
+ invocation are captured in every manifest.
96
+ 5. **Separation of duties** — Responder, Investigator, Data Custodian, Analyst map to the
97
+ console's RBAC model.
98
+ 6. **Isolated analysis** — the console makes **no outbound calls** and ships no telemetry.
99
+ 7. **Document the gaps** — a disabled or empty log source is itself evidence.
100
+
101
+ ## Quick start
102
+
103
+ ### Collector (in AWS CloudShell)
104
+
105
+ ```bash
106
+ # Review the read-only IAM policy first: docs/iam-policies/aws-collector-readonly.json
107
+ # AWS CloudShell — one-time install (skips if already set up):
108
+ curl -fsSL https://raw.githubusercontent.com/Haggag-22/Ventra/main/bin/install-cloudshell.sh | bash
109
+ ventra collect aws --case CASE-2026-0042 --out ~/ventra-evidence
110
+ ```
111
+
112
+ ### Ingester + Console (on the IR workstation)
113
+
114
+ From a clone — one command, no prior setup:
115
+
116
+ ```bash
117
+ cd Ventra
118
+ python3 -m collector dev # first run installs .venv + deps + npm, opens browser
119
+ # or, after any pip install of ventra:
120
+ ventra dev # same thing
121
+ ventra gui # production — Docker Compose (or ventra gui --local)
122
+ ```
123
+
124
+ `ventra dev` creates `.venv`, installs Python and npm dependencies if needed, then starts
125
+ the console with hot reload. Edit code, save, refresh the browser.
126
+
127
+ ```bash
128
+ # then drag the evidence package into the Cases panel, or:
129
+ ventra-ingest ./case-CASE-2026-0042-*.tar.zst --case-store ./cases
130
+ ```
131
+
132
+ See the [Operator Runbook](docs/runbooks/operator.md) and
133
+ [Analyst Runbook](docs/runbooks/analyst.md) for full walkthroughs.
134
+
135
+ ## Repository layout
136
+
137
+ ```
138
+ bin/ CloudShell scripts (install-cloudshell.sh, aws_cloudshell.sh, verify_signature.sh)
139
+ collector/ Acquisition tool (Python, boto3) — runs in the client cloud shell
140
+ ingester/ Verify → parse → normalize → load (Python, DuckDB/Parquet)
141
+ console/ Analyst GUI — FastAPI backend + Next.js frontend
142
+ schemas/ JSON Schemas: manifest, package, unified event
143
+ docs/ EPF spec, IAM policies, runbooks, threat coverage
144
+ deploy/ Docker, Compose, Terraform reference forensics environment
145
+ tests/ Fixtures + unit/integration/e2e
146
+ pyproject.toml ventra package (pip install from repo root)
147
+ ```
148
+
149
+ ### Collector layout
150
+
151
+ ```
152
+ collector/
153
+ cli.py entry point (`ventra collect`) — runs every registered collector
154
+ lib/ models, base, chain_of_custody, packaging, transport
155
+ aws/ registry, runner, client_factory + collector modules
156
+ identity/ iam, sts, account, kms, secrets
157
+ control_plane/ cloudtrail, config
158
+ network/ vpc_flow, waf
159
+ detections/ guardduty, securityhub, macie, detective
160
+ workloads/ ec2, s3, lambda
161
+ azure/ scaffolded for later phases
162
+ gcp/ scaffolded for later phases
163
+ tools/ verify_readonly static guard
164
+ ```
165
+
166
+ Design rules: **read-only** (zero mutating API calls), **hash on acquisition**, pure collectors
167
+ that return `SourceResult`, and **gaps are evidence** (disabled sources recorded in the manifest).
168
+ The `readonly-guard` CI check and IAM policies in `docs/iam-policies/` enforce the first rule.
169
+
170
+ ## Status
171
+
172
+ Ventra is in active development. AWS is the first supported cloud; Azure and GCP are
173
+ scaffolded for later phases that reuse the same EPF and console unchanged. See the
174
+ [roadmap](ROADMAP.md).
175
+
176
+ ## License
177
+
178
+ [Apache-2.0](LICENSE). No telemetry, ever. Releases are signed — see [SECURITY.md](SECURITY.md).
ventra-0.1.0/README.md ADDED
@@ -0,0 +1,141 @@
1
+ <div align="center">
2
+
3
+ # Ventra
4
+
5
+ **Cloud-native incident response triage — collect, normalize, investigate.**
6
+
7
+ Ventra is an open-source toolkit for cloud forensic triage. A responder runs a single
8
+ read-only command in the client's cloud shell; Ventra pulls exactly the logs and
9
+ artifacts incident responders need into a sealed, hash-verified evidence package. The
10
+ package is handed to the IR team, normalized, and investigated in a clean, modern
11
+ analyst console — without ever touching the client environment again.
12
+
13
+ [Documentation](docs/) · [Evidence Package Format](docs/evidence-package-format.md) · [Operator Runbook](docs/runbooks/operator.md) · [Analyst Runbook](docs/runbooks/analyst.md)
14
+
15
+ </div>
16
+
17
+ ---
18
+
19
+ ## What Ventra is
20
+
21
+ Ventra has three loosely-coupled tiers connected by one contract — the
22
+ **Evidence Package Format (EPF)**:
23
+
24
+ | Tier | Runs where | Job |
25
+ |------|------------|-----|
26
+ | **Collector** | Client's cloud shell (AWS first) | Read-only acquisition → sealed evidence package |
27
+ | **Ingester** | IR workstation | Verify → parse → normalize → load |
28
+ | **Console** | IR workstation / forensic VPC | Case-scoped investigation GUI |
29
+
30
+ ```
31
+ ┌────────────────┐ sealed .tar.zst ┌────────────────┐ ┌────────────────┐
32
+ │ COLLECTOR │ ────────────────► │ INGESTER │ ────► │ CONSOLE │
33
+ │ cloud shell │ manifest + sigs │ parse/normalize│ query │ analyst GUI │
34
+ │ read-only IAM │ │ hash-verify │ │ RBAC, offline │
35
+ └────────────────┘ └────────────────┘ └────────────────┘
36
+ ```
37
+
38
+ ## What Ventra is **not**
39
+
40
+ - **Not a SIEM.** Cases are bounded, time-scoped investigations — not always-on pipelines.
41
+ - **Not an EDR or memory-forensics tool.** EC2 OS internals, memory, and full-disk imaging
42
+ stay with Velociraptor / disk-image workflows. Ventra deliberately does not overlap them.
43
+ - **Not a containment tool.** The collector is **strictly read-only**. It never modifies,
44
+ isolates, or terminates resources.
45
+ - **Not a long-term evidence vault.** Ventra defines the evidence format; storage and
46
+ retention are the IR firm's responsibility.
47
+
48
+ ## Forensic principles
49
+
50
+ Ventra is built around the guidance in AWS's
51
+ [Forensic investigation environment strategies](https://aws.amazon.com/blogs/security/forensic-investigation-environment-strategies-in-the-aws-cloud/)
52
+ and standard DFIR practice:
53
+
54
+ 1. **Read-only at the source** — the collector's IAM policy contains zero mutating actions.
55
+ 2. **Hash on acquisition** — SHA-256 every artifact before it leaves the source account.
56
+ 3. **Immutable evidence** — packages are sealed and signed; the ingester works on copies.
57
+ 4. **Chain of custody is first-class** — operator, timestamps, account, tool version, and
58
+ invocation are captured in every manifest.
59
+ 5. **Separation of duties** — Responder, Investigator, Data Custodian, Analyst map to the
60
+ console's RBAC model.
61
+ 6. **Isolated analysis** — the console makes **no outbound calls** and ships no telemetry.
62
+ 7. **Document the gaps** — a disabled or empty log source is itself evidence.
63
+
64
+ ## Quick start
65
+
66
+ ### Collector (in AWS CloudShell)
67
+
68
+ ```bash
69
+ # Review the read-only IAM policy first: docs/iam-policies/aws-collector-readonly.json
70
+ # AWS CloudShell — one-time install (skips if already set up):
71
+ curl -fsSL https://raw.githubusercontent.com/Haggag-22/Ventra/main/bin/install-cloudshell.sh | bash
72
+ ventra collect aws --case CASE-2026-0042 --out ~/ventra-evidence
73
+ ```
74
+
75
+ ### Ingester + Console (on the IR workstation)
76
+
77
+ From a clone — one command, no prior setup:
78
+
79
+ ```bash
80
+ cd Ventra
81
+ python3 -m collector dev # first run installs .venv + deps + npm, opens browser
82
+ # or, after any pip install of ventra:
83
+ ventra dev # same thing
84
+ ventra gui # production — Docker Compose (or ventra gui --local)
85
+ ```
86
+
87
+ `ventra dev` creates `.venv`, installs Python and npm dependencies if needed, then starts
88
+ the console with hot reload. Edit code, save, refresh the browser.
89
+
90
+ ```bash
91
+ # then drag the evidence package into the Cases panel, or:
92
+ ventra-ingest ./case-CASE-2026-0042-*.tar.zst --case-store ./cases
93
+ ```
94
+
95
+ See the [Operator Runbook](docs/runbooks/operator.md) and
96
+ [Analyst Runbook](docs/runbooks/analyst.md) for full walkthroughs.
97
+
98
+ ## Repository layout
99
+
100
+ ```
101
+ bin/ CloudShell scripts (install-cloudshell.sh, aws_cloudshell.sh, verify_signature.sh)
102
+ collector/ Acquisition tool (Python, boto3) — runs in the client cloud shell
103
+ ingester/ Verify → parse → normalize → load (Python, DuckDB/Parquet)
104
+ console/ Analyst GUI — FastAPI backend + Next.js frontend
105
+ schemas/ JSON Schemas: manifest, package, unified event
106
+ docs/ EPF spec, IAM policies, runbooks, threat coverage
107
+ deploy/ Docker, Compose, Terraform reference forensics environment
108
+ tests/ Fixtures + unit/integration/e2e
109
+ pyproject.toml ventra package (pip install from repo root)
110
+ ```
111
+
112
+ ### Collector layout
113
+
114
+ ```
115
+ collector/
116
+ cli.py entry point (`ventra collect`) — runs every registered collector
117
+ lib/ models, base, chain_of_custody, packaging, transport
118
+ aws/ registry, runner, client_factory + collector modules
119
+ identity/ iam, sts, account, kms, secrets
120
+ control_plane/ cloudtrail, config
121
+ network/ vpc_flow, waf
122
+ detections/ guardduty, securityhub, macie, detective
123
+ workloads/ ec2, s3, lambda
124
+ azure/ scaffolded for later phases
125
+ gcp/ scaffolded for later phases
126
+ tools/ verify_readonly static guard
127
+ ```
128
+
129
+ Design rules: **read-only** (zero mutating API calls), **hash on acquisition**, pure collectors
130
+ that return `SourceResult`, and **gaps are evidence** (disabled sources recorded in the manifest).
131
+ The `readonly-guard` CI check and IAM policies in `docs/iam-policies/` enforce the first rule.
132
+
133
+ ## Status
134
+
135
+ Ventra is in active development. AWS is the first supported cloud; Azure and GCP are
136
+ scaffolded for later phases that reuse the same EPF and console unchanged. See the
137
+ [roadmap](ROADMAP.md).
138
+
139
+ ## License
140
+
141
+ [Apache-2.0](LICENSE). No telemetry, ever. Releases are signed — see [SECURITY.md](SECURITY.md).
@@ -0,0 +1,11 @@
1
+ """Ventra collector — read-only cloud forensic triage acquisition.
2
+
3
+ The collector runs in the client's cloud shell, gathers exactly the logs and artifacts
4
+ incident responders need, and seals them into a signed evidence package described by the
5
+ Ventra Evidence Package Format (EPF).
6
+
7
+ Forensic invariant: nothing in this package may call a mutating cloud API. See
8
+ ``collector.tools.verify_readonly`` and the ``readonly-guard`` CI check.
9
+ """
10
+
11
+ __version__ = "0.1.0"
@@ -0,0 +1,8 @@
1
+ """Allow ``python -m collector dev`` from a fresh clone before ``pip install``."""
2
+
3
+ from __future__ import annotations
4
+
5
+ from .cli import main
6
+
7
+ if __name__ == "__main__":
8
+ raise SystemExit(main())
@@ -0,0 +1,5 @@
1
+ """AWS orchestration — registry, runner, and boto3 client factory.
2
+
3
+ Collector modules (identity, control_plane, network, …) live in this package.
4
+ Import ``collector.aws.registry`` to populate and access the registry.
5
+ """