tmxcaliber 0.3.15__tar.gz

tmxcaliber-0.3.15/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

tmxcaliber-0.3.15/PKG-INFO

@@ -0,0 +1,396 @@
+Metadata-Version: 2.4
+Name: tmxcaliber
+Version: 0.3.15
+Summary: CLI utility to filter down one or more TrustOnCloud ThreatModels and get more refined information.
+Author-email: TrustOnCloud <dev@trustoncloud.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/trustoncloud/tmxcaliber
+Project-URL: Repository, https://github.com/trustoncloud/tmxcaliber
+Project-URL: Issues, https://github.com/trustoncloud/tmxcaliber/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: beautifulsoup4<5,>=4
+Requires-Dist: lxml<7,>=5
+Requires-Dist: colorama<1,>=0.4.6
+Requires-Dist: openpyxl<4,>=3
+Requires-Dist: tqdm<5,>=4
+Requires-Dist: networkx<4,>=3
+Requires-Dist: deepdiff<9,>=8
+Requires-Dist: jsonschema<5,>=4.25
+Provides-Extra: dev
+Requires-Dist: pytest<10,>=9; extra == "dev"
+Requires-Dist: pytest-mock<4,>=3.14; extra == "dev"
+Requires-Dist: coverage<8,>=7; extra == "dev"
+Requires-Dist: ruff<1,>=0.6; extra == "dev"
+Requires-Dist: mypy<2,>=1.11; extra == "dev"
+Requires-Dist: pre-commit<5,>=4; extra == "dev"
+Requires-Dist: types-beautifulsoup4; extra == "dev"
+Requires-Dist: lxml-stubs; extra == "dev"
+Requires-Dist: types-openpyxl; extra == "dev"
+Requires-Dist: types-tqdm; extra == "dev"
+Requires-Dist: types-jsonschema; extra == "dev"
+Requires-Dist: types-colorama; extra == "dev"
+Dynamic: license-file
+
+# tmxcaliber
+
+`tmxcaliber` is a command-line toolkit for refining, querying, and transforming TrustOnCloud ThreatModels. It helps engineers work with large model files more efficiently by filtering JSON, exporting threats and controls, mapping control objectives to frameworks, generating DFD artifacts, and comparing model versions without writing custom scripts for each task.
+
+## Highlights
+
+- Filter ThreatModel JSON files by IDs, severity, IAM permissions, and events.
+- List threats, controls, services, and feature classes from a single model or an entire directory.
+- Map control objectives to SCF-supported frameworks or your own custom framework.
+- Write mapping data back into a ThreatModel JSON.
+- Generate threat-focused and feature-class-focused DFD XML and PNG outputs.
+- Create structured change logs in JSON or Markdown.
+- Scan control descriptions with regex patterns or the built-in `guardduty_findings` alias.
+
+## Quickstart
+
+`tmxcaliber` supports Python `3.10+`.
+
+```sh
+pip install tmxcaliber
+tmxcaliber -h
+```
+
+Or run it without installing anything, using [uv](https://docs.astral.sh/uv/):
+
+```sh
+uvx tmxcaliber -h
+```
+
+First commands to try:
+
+```sh
+tmxcaliber list threats path/to/threatmodel.json
+tmxcaliber filter path/to/threatmodel.json --severity high --output filtered.json
+tmxcaliber map path/to/threatmodel.json --scf 2025.3.1 --framework-name "NIST CSF v2.0"
+```
+
+## Installation
+
+### Install from PyPI
+
+The recommended way to get the CLI:
+
+```sh
+pip install tmxcaliber
+```
+
+Or run it without installing anything, with [uv](https://docs.astral.sh/uv/):
+
+```sh
+uvx tmxcaliber -h
+```
+
+Pin a specific version the usual way:
+
+```sh
+pip install "tmxcaliber==<version>"
+```
+
+Every merge to `main` publishes a new version to PyPI automatically, so the
+latest released code is always there. The Git tags remain the release history
+and carry the same sdist and wheel as attachments.
+
+### Install from source
+
+For contributors, or to work against unreleased changes. This uses
+[uv](https://docs.astral.sh/uv/) to build the environment from the committed
+`uv.lock`:
+
+```sh
+git clone https://github.com/trustoncloud/tmxcaliber.git
+cd tmxcaliber
+uv sync
+uv run tmxcaliber -h
+```
+
+If you prefer a manual virtual environment with `pip`:
+
+```sh
+python -m venv .venv
+# PowerShell
+.venv\Scripts\Activate.ps1
+# bash / zsh
+source .venv/bin/activate
+
+pip install .
+tmxcaliber -h
+```
+
+### Docker
+
+The repository includes a Dockerfile for containerized use:
+
+```sh
+docker build -t tmxcaliber .
+docker run --rm -it tmxcaliber -h
+```
+
+### Requirement note for `generate`
+
+The `generate` command depends on `drawio`. If the binary is not automatically detected, provide it explicitly with `--bin`.
+
+## Command Overview
+
+| Command | Purpose | Typical output |
+| --- | --- | --- |
+| `filter` | Produce a refined ThreatModel JSON based on filters. | JSON |
+| `list threats` | Export threat rows from one model or a directory. | CSV |
+| `list controls` | Export control rows from one model or a directory. | CSV |
+| `list services` | List service names and their source files. | CSV or JSON |
+| `list feature-classes` | Inspect feature classes in a single ThreatModel. | CSV or JSON |
+| `map` | Generate a framework mapping from ThreatModel control objectives. | CSV or JSON |
+| `add-mapping` | Insert mapping data into the ThreatModel JSON. | JSON |
+| `scan` | Find controls whose descriptions match a pattern. | JSON |
+| `generate` | Generate XML and PNG DFD artifacts. | Files on disk |
+| `create-change-log` | Compare two ThreatModels and summarize differences. | JSON or Markdown |
+
+## Core Workflows
+
+### Filter a ThreatModel
+
+Use `filter` when you want a refined ThreatModel JSON as the output.
+
+```sh
+tmxcaliber filter path/to/threatmodel.json \
+  --severity high \
+  --output filtered.json
+```
+
+Create a filtered file and a companion file containing everything removed:
+
+```sh
+tmxcaliber filter path/to/threatmodel.json \
+  --permissions s3:GetObject \
+  --output filtered.json \
+  --output-removed
+```
+
+Use `--exclude` to invert an ID-based filter:
+
+```sh
+tmxcaliber filter path/to/threatmodel.json \
+  --ids S3.T12,S3.CO1 \
+  --exclude \
+  --output filtered.json
+```
+
+### List threats and controls
+
+List threats from a single model:
+
+```sh
+tmxcaliber list threats path/to/threatmodel.json
+```
+
+List only high and very-high severity threats from a directory:
+
+```sh
+tmxcaliber list threats path/to/threatmodels \
+  --severity high \
+  --output threats.csv
+```
+
+List controls from a directory:
+
+```sh
+tmxcaliber list controls path/to/threatmodels --output controls.csv
+```
+
+List only AWS data perimeter controls:
+
+```sh
+tmxcaliber list controls path/to/threatmodels \
+  --type AWS_DATA_PERIMETER \
+  --output perimeter_controls.csv
+```
+
+List services across a directory of models:
+
+```sh
+tmxcaliber list services path/to/threatmodels --format json
+```
+
+List feature classes from a single ThreatModel:
+
+```sh
+tmxcaliber list feature-classes path/to/threatmodel.json
+```
+
+### Map to a supported or custom framework
+
+Generate a mapping to an SCF-supported framework:
+
+```sh
+tmxcaliber map path/to/threatmodel.json \
+  --scf 2025.3.1 \
+  --framework-name "ISO 27001 v2013" \
+  --format csv
+```
+
+Use the exact framework name from the selected SCF version header when targeting a built-in framework.
+
+Generate a mapping to your own framework using the starter CSVs in [`template/`](template):
+
+```sh
+tmxcaliber map path/to/threatmodel.json \
+  --scf 2025.3.1 \
+  --framework-name "My Framework" \
+  --framework-map template/myframework.csv \
+  --framework-metadata template/mymetadata.csv \
+  --format json
+```
+
+### Add mapping data back into a ThreatModel
+
+If you want the mapping persisted directly into the ThreatModel output:
+
+```sh
+tmxcaliber add-mapping path/to/threatmodel.json \
+  --scf 2025.3.1 \
+  --framework-name "My Framework" \
+  --framework-map template/myframework.csv \
+  --framework-metadata template/mymetadata.csv \
+  --output enriched-threatmodel.json
+```
+
+### Generate DFD artifacts
+
+`generate` accepts either:
+
+- a ThreatModel JSON containing base64-encoded XML in `dfd.body`
+- a raw XML file from the main ThreatModel DFD
+
+Generate XML and PNG outputs from JSON:
+
+```sh
+tmxcaliber generate path/to/threatmodel.json \
+  --threat-dir out/threat-xml \
+  --fc-dir out/feature-class-xml \
+  --out-dir out/png
+```
+
+Generate from XML with an explicit `drawio` binary:
+
+```sh
+tmxcaliber generate path/to/provider_service_DFD.xml \
+  --bin "C:\Program Files\draw.io\draw.io.exe" \
+  --out-dir out/png
+```
+
+### Scan control descriptions
+
+Search control descriptions with a regex:
+
+```sh
+tmxcaliber scan path/to/threatmodel.json --pattern UnauthorizedAccess
+```
+
+Use the built-in GuardDuty findings alias:
+
+```sh
+tmxcaliber scan path/to/threatmodel.json --pattern guardduty_findings
+```
+
+### Create change logs
+
+Compare two ThreatModel versions and output JSON:
+
+```sh
+tmxcaliber create-change-log path/to/new_tm.json path/to/old_tm.json
+```
+
+Generate a Markdown report:
+
+```sh
+tmxcaliber create-change-log path/to/new_tm.json path/to/old_tm.json \
+  --format md \
+  --output changes.md
+```
+
+You can also scope the comparison to specific IDs and invert the selection with `--exclude`.
+
+## Common Examples
+
+```sh
+# List all threats across a directory
+tmxcaliber list threats path/to/threatmodels
+
+# Keep only specific controls and objectives in a filtered JSON
+tmxcaliber filter path/to/threatmodel.json --ids S3.C12,S3.CO5 --output filtered.json
+
+# Exclude known noisy threats from a threat export
+tmxcaliber list threats path/to/threatmodel.json --ids S3.T2,S3.T9 --exclude
+
+# Export services for inventory or reporting
+tmxcaliber list services path/to/threatmodels --output services.csv
+
+# Produce a custom-framework mapping
+tmxcaliber map path/to/threatmodel.json --scf 2025.3.1 --framework-name "My Framework" --framework-map template/myframework.csv
+
+# Create a Markdown change log between releases
+tmxcaliber create-change-log new.json old.json --format md --output changes.md
+```
+
+## Help Reference
+
+Use the built-in help to inspect the full CLI surface:
+
+```sh
+tmxcaliber -h
+tmxcaliber filter -h
+tmxcaliber map -h
+tmxcaliber add-mapping -h
+tmxcaliber scan -h
+tmxcaliber generate -h
+tmxcaliber list threats -h
+tmxcaliber list controls -h
+tmxcaliber list services -h
+tmxcaliber list feature-classes -h
+tmxcaliber create-change-log -h
+```
+
+## Development
+
+Set up a local development environment with dev dependencies (Ruff, mypy,
+pytest, coverage, pre-commit, and type stubs):
+
+```sh
+uv sync --extra dev
+uv run pre-commit install
+```
+
+Run the test suite:
+
+```sh
+uv run pytest -q test
+```
+
+Lint, format, and type-check:
+
+```sh
+uv run ruff format --check .
+uv run ruff check .
+uv run mypy
+```
+
+## Contributing
+
+Contributions are welcome. If you want to improve the CLI, add tests, or extend the documentation, open an issue or submit a pull request with a clear description of the change and its intended user impact.