synapse-sbom 0.1.0__tar.gz

synapse_sbom-0.1.0/.gitignore

@@ -0,0 +1,75 @@
+# Environment files (contain secrets)
+.env
+.env.local
+.env.*.local
+
+# Terraform
+*.tfstate
+*.tfstate.*
+*.tfplan
+.terraform/
+.terraform.lock.hcl
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+.venv/
+venv/
+.pytest_cache/
+
+# Node
+node_modules/
+.next/
+out/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# macOS
+.DS_Store
+.AppleDouble
+.LSOverride
+._*
+.Spotlight-V100
+.Trashes
+
+# Thumbnails
+Thumbs.db
+ehthumbs.db
+
+# Logs
+*.log
+logs/
+
+# Build artifacts
+dist/
+build/
+
+# Local development
+*.local
+*.old
+
+# Backups
+backups/
+
+# Scraper credentials and cached data
+external/*/data/
+**/linkedin_cookies.json
+**/telegram_session*
+
+# Ephemeral local artifacts (never commit)
+.playwright-mcp/
+.mcp.json
+/*.png
+scripts/prod-dump-*.sql
+**/*.xcuserstate
+# Local release/evidence artifacts (kept on disk, out of VCS)
+/synapse-commits-history.*
+/synapse-files-list.*
+/synapse-files-sha256.*
+/synapse-release-manifest.*
+/synapse-evidence.xlsx

synapse_sbom-0.1.0/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 2026 PeachStudio (https://peachstudio.be)
+
+   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.

synapse_sbom-0.1.0/PKG-INFO

@@ -0,0 +1,220 @@
+Metadata-Version: 2.4
+Name: synapse-sbom
+Version: 0.1.0
+Summary: SYNAPSE SBOM scanner for Python projects — generate a CycloneDX SBOM locally and submit it to SYNAPSE Software Component Analysis.
+Project-URL: Homepage, https://github.com/vitorallo/synapse/tree/main/tools/sbom-scanner-py#readme
+Project-URL: Repository, https://github.com/vitorallo/synapse
+Project-URL: Issues, https://github.com/vitorallo/synapse/issues
+Author-email: PeachStudio <me@vitorallo.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: cyclonedx,pypi,sbom,sca,supply-chain,synapse,vulnerability
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# synapse-sbom (Python)
+
+> Command: **`synapse-sbom`** · PyPI package: **`synapse-sbom`** · the
+> Python twin of the npm [`@peachstudio/synapse-sbom`](https://www.npmjs.com/package/@peachstudio/synapse-sbom)
+
+Generate a [CycloneDX 1.6](https://cyclonedx.org/) SBOM from your Python
+project **locally** and submit it to **SYNAPSE Software Component
+Analysis** (SCA). Vulnerable components are then **continuously
+re-evaluated** as new advisories land — *scan once, monitored forever*.
+
+- **Zero runtime dependencies** — Python ≥ 3.9, stdlib only.
+- The SBOM is built on your machine; only the SBOM JSON leaves it.
+- Same `/v1/sca/analyze` contract, **shared config & project identity**
+  with the npm scanner — a polyglot repo is the **same product**
+  whichever scanner runs.
+
+---
+
+## Quick start
+
+```bash
+# 1. Create an API key in the SYNAPSE webapp:
+#    Settings → Security → API Keys → name it → Create → copy the syn_… key
+
+# 2. Store it once (shared with the npm scanner: ~/.config/synapse-sbom/config.json, 0600):
+uvx synapse-sbom login --key syn_xxxxxxxxxxxx
+#   (or: pipx run synapse-sbom login --key syn_xxx)
+
+# 3. From your project root:
+uvx synapse-sbom scan
+```
+
+Install it instead of using `uvx`/`pipx run` if you prefer:
+
+```bash
+uv tool install synapse-sbom        # → `synapse-sbom` on PATH
+pipx install synapse-sbom           # same
+pip install synapse-sbom            # into the current environment
+```
+
+`uvx synapse-sbom` / `pipx run synapse-sbom` is the `npx` analog — no
+install needed.
+
+---
+
+## What it reads
+
+To build the component list (first match wins — closest to the npm
+tool's lockfile-first approach):
+
+1. **`poetry.lock`** or **`uv.lock`** (TOML; needs Python ≥ 3.11 for the
+   stdlib `tomllib`, otherwise skipped)
+2. **`requirements.txt`** (pinned `name==version` lines)
+3. else the **active environment** — every installed distribution via
+   `importlib.metadata` (zero-config, reliable; run it in your project's
+   venv)
+
+Product name/version come from `pyproject.toml` `[project]` (or
+`[tool.poetry]`), else the directory name. Components are emitted as
+`pkg:pypi/<normalized-name>@<version>`. Anything the resolver doesn't
+support server-side is reported `skipped`, never fatal.
+
+---
+
+## Authentication (API key)
+
+1. SYNAPSE webapp → **Settings → Security → API Keys** (Business or
+   Enterprise tier). Name it, **Create**, copy the `syn_…` key — it is
+   shown **once**.
+2. Give it to the scanner — precedence **flag → env → stored config**:
+
+| Method | How | Best for |
+|---|---|---|
+| Flag | `--key syn_…` | one-off / overrides |
+| Env | `SYNAPSE_API_KEY=syn_…` | CI (use a secret) |
+| Stored | `synapse-sbom login --key syn_…` → `~/.config/synapse-sbom/config.json` (`0600`) | local dev |
+
+The config file and the `.synapse-sbom.json` project marker are the
+**same** as the npm scanner's — `login` once, use either tool. The key
+is never written to the project, the SBOM, or `.synapse-sbom.json`.
+
+---
+
+## Command reference
+
+Copy-paste, no install needed (`uvx`; or `pipx run`, or drop the prefix
+if installed):
+
+```bash
+# Authenticate once (shared 0600 config)
+uvx synapse-sbom login --key syn_xxx --url https://api.synapse-intel.com
+uvx synapse-sbom login                       # interactive hidden prompt
+
+# Scan
+uvx synapse-sbom scan                        # current project, submit
+uvx synapse-sbom scan ./path/to/app          # a specific project
+uvx synapse-sbom scan --dry-run              # print SBOM only, no upload, no side effects
+uvx synapse-sbom scan --product my-svc       # override display name
+uvx synapse-sbom scan --project my-key       # explicit stable project key
+
+# Per-run auth/endpoint overrides (skip stored config)
+uvx synapse-sbom scan --url https://api.synapse-intel.com --key syn_xxx
+SYNAPSE_API_KEY=syn_xxx SYNAPSE_API_URL=https://api.synapse-intel.com \
+  uvx synapse-sbom scan
+
+# Local SYNAPSE instead of prod
+uvx synapse-sbom scan --url http://localhost:8085 --key syn_local
+
+# Inspect resolved URL / masked key / config path
+uvx synapse-sbom whoami
+
+# Help
+uvx synapse-sbom help
+```
+
+| Flag | Env | Default | Meaning |
+|---|---|---|---|
+| `--key` | `SYNAPSE_API_KEY` | stored config | Bearer API key |
+| `--url` | `SYNAPSE_API_URL` | `https://api.synapse-intel.com` | SCA API base URL |
+| `--project` | `SYNAPSE_PROJECT` | git remote → generated | Stable project identity (survives renames/CI) |
+| `--product` | — | `pyproject.toml` name | Display name only |
+| `--dry-run` | — | off | Build SBOM, print to stdout, **don't** upload or write `.synapse-sbom.json` |
+| — | `SYNAPSE_TIMEOUT_MS` | `1200000` (20 min) | Client request timeout |
+| — | `SYNAPSE_SBOM_CONFIG_DIR` | `~/.config/synapse-sbom` | Config directory (shared with npm tool) |
+
+**Resolution order** (key & URL): `flag` > `env` > stored config > default.
+
+---
+
+## Project identity (re-scans update the same product)
+
+Same rules and **same `.synapse-sbom.json` format** as the npm tool, so
+a project scanned by either resolves to one product:
+
+1. `--project` / `SYNAPSE_PROJECT`
+2. committed `.synapse-sbom.json` — `{ "projectId": "…" }`
+3. the git remote URL, normalized (`git:github.com/org/repo`)
+4. else a generated UUID written to `.synapse-sbom.json` — **commit it**.
+
+Server identity is `(your account, project key)`; the product name is a
+mutable label. `--dry-run` reports the key without writing the file.
+
+---
+
+## Use in CI
+
+```yaml
+# .github/workflows/sca.yml
+name: SBOM SCA
+on: [push]
+jobs:
+  scan:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with: { python-version: "3.12" }
+      - run: pip install -r requirements.txt   # so the env reflects deps
+      - run: uvx synapse-sbom scan
+        env:
+          SYNAPSE_API_KEY: ${{ secrets.SYNAPSE_API_KEY }}
+```
+
+Commit `.synapse-sbom.json` so every run reports as the same product.
+Exit `0` on success, `1` on any error (fail the build as you see fit).
+
+---
+
+## Security
+
+The SBOM is built locally; only it (+ a Bearer key over HTTPS) leaves
+your machine. The key is stored `0600`, never written to the project,
+the SBOM, or `.synapse-sbom.json`, and never printed (the CLI **warns**
+if you point `--url` at a plaintext `http://` non-local host;
+`http://localhost` and `https://` are silent). Zero third-party
+dependencies — no transitive supply-chain surface.
+
+---
+
+## Troubleshooting
+
+| Symptom | Cause / fix |
+|---|---|
+| `(N components, from environment)` but you expected lockfile | No `poetry.lock`/`uv.lock`/`requirements.txt` found, or Python < 3.11 for TOML locks. Run in the project venv, or add a pinned `requirements.txt`. |
+| `no API key …` | `login`, or pass `--key` / `SYNAPSE_API_KEY`. |
+| `API 401` | Key invalid/revoked, or wrong `--url`. Check `synapse-sbom whoami`. |
+| `API 403` | Your tier doesn't include SCA (Business/Enterprise), or API access not enabled in webapp settings. |
+| `API 413` | SBOM exceeds the server component cap. |
+| `timed out after …s` | Large project still resolving. Re-run later (results cache) or raise `SYNAPSE_TIMEOUT_MS`. |
+
+---
+
+## Family
+
+`synapse-sbom` ships for **npm** (`@peachstudio/synapse-sbom`, published)
+and **PyPI** (this package). A **Go** scanner will follow the same
+contract — generate a CycloneDX 1.6 SBOM locally, submit to
+`/v1/sca/analyze`. The SCA engine is ecosystem-agnostic, so a CycloneDX
+file from any tool works today.

synapse_sbom-0.1.0/README.md

@@ -0,0 +1,199 @@
+# synapse-sbom (Python)
+
+> Command: **`synapse-sbom`** · PyPI package: **`synapse-sbom`** · the
+> Python twin of the npm [`@peachstudio/synapse-sbom`](https://www.npmjs.com/package/@peachstudio/synapse-sbom)
+
+Generate a [CycloneDX 1.6](https://cyclonedx.org/) SBOM from your Python
+project **locally** and submit it to **SYNAPSE Software Component
+Analysis** (SCA). Vulnerable components are then **continuously
+re-evaluated** as new advisories land — *scan once, monitored forever*.
+
+- **Zero runtime dependencies** — Python ≥ 3.9, stdlib only.
+- The SBOM is built on your machine; only the SBOM JSON leaves it.
+- Same `/v1/sca/analyze` contract, **shared config & project identity**
+  with the npm scanner — a polyglot repo is the **same product**
+  whichever scanner runs.
+
+---
+
+## Quick start
+
+```bash
+# 1. Create an API key in the SYNAPSE webapp:
+#    Settings → Security → API Keys → name it → Create → copy the syn_… key
+
+# 2. Store it once (shared with the npm scanner: ~/.config/synapse-sbom/config.json, 0600):
+uvx synapse-sbom login --key syn_xxxxxxxxxxxx
+#   (or: pipx run synapse-sbom login --key syn_xxx)
+
+# 3. From your project root:
+uvx synapse-sbom scan
+```
+
+Install it instead of using `uvx`/`pipx run` if you prefer:
+
+```bash
+uv tool install synapse-sbom        # → `synapse-sbom` on PATH
+pipx install synapse-sbom           # same
+pip install synapse-sbom            # into the current environment
+```
+
+`uvx synapse-sbom` / `pipx run synapse-sbom` is the `npx` analog — no
+install needed.
+
+---
+
+## What it reads
+
+To build the component list (first match wins — closest to the npm
+tool's lockfile-first approach):
+
+1. **`poetry.lock`** or **`uv.lock`** (TOML; needs Python ≥ 3.11 for the
+   stdlib `tomllib`, otherwise skipped)
+2. **`requirements.txt`** (pinned `name==version` lines)
+3. else the **active environment** — every installed distribution via
+   `importlib.metadata` (zero-config, reliable; run it in your project's
+   venv)
+
+Product name/version come from `pyproject.toml` `[project]` (or
+`[tool.poetry]`), else the directory name. Components are emitted as
+`pkg:pypi/<normalized-name>@<version>`. Anything the resolver doesn't
+support server-side is reported `skipped`, never fatal.
+
+---
+
+## Authentication (API key)
+
+1. SYNAPSE webapp → **Settings → Security → API Keys** (Business or
+   Enterprise tier). Name it, **Create**, copy the `syn_…` key — it is
+   shown **once**.
+2. Give it to the scanner — precedence **flag → env → stored config**:
+
+| Method | How | Best for |
+|---|---|---|
+| Flag | `--key syn_…` | one-off / overrides |
+| Env | `SYNAPSE_API_KEY=syn_…` | CI (use a secret) |
+| Stored | `synapse-sbom login --key syn_…` → `~/.config/synapse-sbom/config.json` (`0600`) | local dev |
+
+The config file and the `.synapse-sbom.json` project marker are the
+**same** as the npm scanner's — `login` once, use either tool. The key
+is never written to the project, the SBOM, or `.synapse-sbom.json`.
+
+---
+
+## Command reference
+
+Copy-paste, no install needed (`uvx`; or `pipx run`, or drop the prefix
+if installed):
+
+```bash
+# Authenticate once (shared 0600 config)
+uvx synapse-sbom login --key syn_xxx --url https://api.synapse-intel.com
+uvx synapse-sbom login                       # interactive hidden prompt
+
+# Scan
+uvx synapse-sbom scan                        # current project, submit
+uvx synapse-sbom scan ./path/to/app          # a specific project
+uvx synapse-sbom scan --dry-run              # print SBOM only, no upload, no side effects
+uvx synapse-sbom scan --product my-svc       # override display name
+uvx synapse-sbom scan --project my-key       # explicit stable project key
+
+# Per-run auth/endpoint overrides (skip stored config)
+uvx synapse-sbom scan --url https://api.synapse-intel.com --key syn_xxx
+SYNAPSE_API_KEY=syn_xxx SYNAPSE_API_URL=https://api.synapse-intel.com \
+  uvx synapse-sbom scan
+
+# Local SYNAPSE instead of prod
+uvx synapse-sbom scan --url http://localhost:8085 --key syn_local
+
+# Inspect resolved URL / masked key / config path
+uvx synapse-sbom whoami
+
+# Help
+uvx synapse-sbom help
+```
+
+| Flag | Env | Default | Meaning |
+|---|---|---|---|
+| `--key` | `SYNAPSE_API_KEY` | stored config | Bearer API key |
+| `--url` | `SYNAPSE_API_URL` | `https://api.synapse-intel.com` | SCA API base URL |
+| `--project` | `SYNAPSE_PROJECT` | git remote → generated | Stable project identity (survives renames/CI) |
+| `--product` | — | `pyproject.toml` name | Display name only |
+| `--dry-run` | — | off | Build SBOM, print to stdout, **don't** upload or write `.synapse-sbom.json` |
+| — | `SYNAPSE_TIMEOUT_MS` | `1200000` (20 min) | Client request timeout |
+| — | `SYNAPSE_SBOM_CONFIG_DIR` | `~/.config/synapse-sbom` | Config directory (shared with npm tool) |
+
+**Resolution order** (key & URL): `flag` > `env` > stored config > default.
+
+---
+
+## Project identity (re-scans update the same product)
+
+Same rules and **same `.synapse-sbom.json` format** as the npm tool, so
+a project scanned by either resolves to one product:
+
+1. `--project` / `SYNAPSE_PROJECT`
+2. committed `.synapse-sbom.json` — `{ "projectId": "…" }`
+3. the git remote URL, normalized (`git:github.com/org/repo`)
+4. else a generated UUID written to `.synapse-sbom.json` — **commit it**.
+
+Server identity is `(your account, project key)`; the product name is a
+mutable label. `--dry-run` reports the key without writing the file.
+
+---
+
+## Use in CI
+
+```yaml
+# .github/workflows/sca.yml
+name: SBOM SCA
+on: [push]
+jobs:
+  scan:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with: { python-version: "3.12" }
+      - run: pip install -r requirements.txt   # so the env reflects deps
+      - run: uvx synapse-sbom scan
+        env:
+          SYNAPSE_API_KEY: ${{ secrets.SYNAPSE_API_KEY }}
+```
+
+Commit `.synapse-sbom.json` so every run reports as the same product.
+Exit `0` on success, `1` on any error (fail the build as you see fit).
+
+---
+
+## Security
+
+The SBOM is built locally; only it (+ a Bearer key over HTTPS) leaves
+your machine. The key is stored `0600`, never written to the project,
+the SBOM, or `.synapse-sbom.json`, and never printed (the CLI **warns**
+if you point `--url` at a plaintext `http://` non-local host;
+`http://localhost` and `https://` are silent). Zero third-party
+dependencies — no transitive supply-chain surface.
+
+---
+
+## Troubleshooting
+
+| Symptom | Cause / fix |
+|---|---|
+| `(N components, from environment)` but you expected lockfile | No `poetry.lock`/`uv.lock`/`requirements.txt` found, or Python < 3.11 for TOML locks. Run in the project venv, or add a pinned `requirements.txt`. |
+| `no API key …` | `login`, or pass `--key` / `SYNAPSE_API_KEY`. |
+| `API 401` | Key invalid/revoked, or wrong `--url`. Check `synapse-sbom whoami`. |
+| `API 403` | Your tier doesn't include SCA (Business/Enterprise), or API access not enabled in webapp settings. |
+| `API 413` | SBOM exceeds the server component cap. |
+| `timed out after …s` | Large project still resolving. Re-run later (results cache) or raise `SYNAPSE_TIMEOUT_MS`. |
+
+---
+
+## Family
+
+`synapse-sbom` ships for **npm** (`@peachstudio/synapse-sbom`, published)
+and **PyPI** (this package). A **Go** scanner will follow the same
+contract — generate a CycloneDX 1.6 SBOM locally, submit to
+`/v1/sca/analyze`. The SCA engine is ecosystem-agnostic, so a CycloneDX
+file from any tool works today.

synapse_sbom-0.1.0/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "synapse-sbom"
+version = "0.1.0"
+description = "SYNAPSE SBOM scanner for Python projects — generate a CycloneDX SBOM locally and submit it to SYNAPSE Software Component Analysis."
+readme = "README.md"
+requires-python = ">=3.9"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{ name = "PeachStudio", email = "me@vitorallo.com" }]
+keywords = ["sbom", "cyclonedx", "sca", "vulnerability", "supply-chain", "pypi", "synapse"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Environment :: Console",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: Apache Software License",
+  "Programming Language :: Python :: 3",
+  "Topic :: Security",
+  "Topic :: Software Development :: Quality Assurance",
+]
+# Zero runtime dependencies — stdlib only (urllib, json, argparse,
+# pathlib, subprocess, importlib.metadata, uuid). tomllib is used for
+# poetry.lock/uv.lock when available (Python >= 3.11); gracefully
+# skipped otherwise.
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/vitorallo/synapse/tree/main/tools/sbom-scanner-py#readme"
+Repository = "https://github.com/vitorallo/synapse"
+Issues = "https://github.com/vitorallo/synapse/issues"
+
+[project.scripts]
+synapse-sbom = "synapse_sbom.cli:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/synapse_sbom"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/synapse_sbom", "README.md", "LICENSE", "pyproject.toml"]

synapse_sbom-0.1.0/src/synapse_sbom/__init__.py

@@ -0,0 +1,8 @@
+"""synapse-sbom — Python/PyPI SBOM scanner for SYNAPSE SCA.
+
+Faithful twin of the npm @peachstudio/synapse-sbom CLI: same commands,
+same /v1/sca/analyze contract, same project identity, same shared
+config, same security posture. Zero runtime dependencies.
+"""
+
+__version__ = "0.1.0"

synapse_sbom-0.1.0/src/synapse_sbom/cli.py

@@ -0,0 +1,505 @@
+"""synapse-sbom (Python) — faithful twin of @peachstudio/synapse-sbom.
+
+Generates a CycloneDX 1.6 SBOM from a Python project locally and submits
+it to the SYNAPSE public SCA API (POST /v1/sca/analyze, Bearer API key).
+Zero runtime dependencies (stdlib only). Shares config + project-identity
+format with the npm scanner so a polyglot repo is the SAME product.
+"""
+
+from __future__ import annotations
+
+import json
+import os
+import re
+import socket
+import subprocess
+import sys
+import threading
+import time
+import urllib.error
+import urllib.request
+import uuid
+from importlib import metadata as importlib_metadata
+from pathlib import Path
+from urllib.parse import urlparse
+
+try:  # poetry.lock / uv.lock parsing; gracefully skipped on <3.11
+    import tomllib
+except ModuleNotFoundError:  # pragma: no cover
+    tomllib = None  # type: ignore[assignment]
+
+from . import __version__
+
+DEFAULT_API_URL = "https://api.synapse-intel.com"
+
+# SHARED with the npm scanner (one `login` works for both).
+CONFIG_DIR = Path(
+    os.environ.get("SYNAPSE_SBOM_CONFIG_DIR")
+    or (
+        Path(os.environ.get("XDG_CONFIG_HOME") or (Path.home() / ".config"))
+        / "synapse-sbom"
+    )
+)
+CONFIG_FILE = CONFIG_DIR / "config.json"
+PROJECT_FILE = ".synapse-sbom.json"
+
+USAGE = f"""synapse-sbom — generate & submit a Python SBOM to SYNAPSE
+
+Usage:
+  synapse-sbom login [--key <API_KEY>] [--url <API_URL>]
+  synapse-sbom scan  [path] [--dry-run] [--product <name>] [--project <key>] [--url <API_URL>]
+  synapse-sbom whoami
+
+Resolution order for API key / URL: CLI flag > env
+(SYNAPSE_API_KEY / SYNAPSE_API_URL) > stored config (~/.config/synapse-sbom).
+Default API URL: {DEFAULT_API_URL}
+
+Examples:
+  synapse-sbom login --key syn_xxx
+  synapse-sbom scan                 # scan ./ and submit
+  synapse-sbom scan ./my-app --dry-run
+  SYNAPSE_API_URL=http://localhost:8085 synapse-sbom scan"""
+
+
+# ── arg parsing (mirrors the npm tool's tiny parser) ───────────────────
+def parse_args(argv):
+    positional, flags = [], {}
+    i = 0
+    while i < len(argv):
+        a = argv[i]
+        if a.startswith("--"):
+            key = a[2:]
+            if key == "dry-run":
+                flags["dryRun"] = True
+            else:
+                i += 1
+                flags[key] = argv[i] if i < len(argv) else None
+        else:
+            positional.append(a)
+        i += 1
+    return positional, flags
+
+
+# ── config store (0600) ────────────────────────────────────────────────
+def read_config():
+    try:
+        return json.loads(CONFIG_FILE.read_text("utf-8"))
+    except Exception:
+        return {}
+
+
+def write_config(cfg):
+    CONFIG_DIR.mkdir(parents=True, exist_ok=True, mode=0o700)
+    # Create with 0600 directly (no world-readable window).
+    fd = os.open(str(CONFIG_FILE), os.O_WRONLY | os.O_CREAT | os.O_TRUNC, 0o600)
+    with os.fdopen(fd, "w") as fh:
+        json.dump(cfg, fh, indent=2)
+    try:
+        os.chmod(CONFIG_FILE, 0o600)
+    except OSError:
+        pass
+
+
+def resolve_auth(flags):
+    cfg = read_config()
+    api_key = (
+        flags.get("key") or os.environ.get("SYNAPSE_API_KEY") or cfg.get("apiKey") or ""
+    )
+    api_url = (
+        flags.get("url")
+        or os.environ.get("SYNAPSE_API_URL")
+        or cfg.get("apiUrl")
+        or DEFAULT_API_URL
+    ).rstrip("/")
+    return api_key, api_url
+
+
+# Warn if the API key would be sent over plaintext HTTP to a non-local
+# host (credential exposure). http://localhost is a legitimate local
+# deployment; a remote http:// URL leaks the Bearer token in cleartext.
+def warn_insecure_transport(api_url):
+    try:
+        u = urlparse(api_url)
+    except ValueError:
+        return
+    host = u.hostname or ""
+    is_local = (
+        host in ("localhost", "127.0.0.1", "::1") or host.endswith(".localhost")
+    )
+    if u.scheme == "http" and not is_local:
+        print(
+            f"⚠ WARNING: {api_url} is plaintext HTTP — your API key "
+            f"will be sent in cleartext to {host}. Use https:// unless this "
+            f"is a trusted private network you control.",
+            file=sys.stderr,
+        )
+
+
+# ── CycloneDX 1.6 generation ───────────────────────────────────────────
+def pypi_purl(name, version):
+    # PEP 503 normalized project name (OSV/PyPI ecosystem identity).
+    norm = re.sub(r"[-_.]+", "-", name).lower()
+    return f"pkg:pypi/{norm}@{version}"
+
+
+def _read_toml(path):
+    if tomllib is None:
+        return None
+    try:
+        with open(path, "rb") as fh:
+            return tomllib.load(fh)
+    except Exception:
+        return None
+
+
+def _project_meta(project_dir, override):
+    """Product name/version from pyproject.toml [project], else dir name."""
+    name, version = None, None
+    data = _read_toml(project_dir / "pyproject.toml")
+    if data:
+        proj = data.get("project") or {}
+        name = proj.get("name")
+        version = proj.get("version")
+        if not version and isinstance(data.get("tool", {}).get("poetry"), dict):
+            name = name or data["tool"]["poetry"].get("name")
+            version = data["tool"]["poetry"].get("version")
+    return (override or name or project_dir.resolve().name or "unnamed"), (
+        version or "0.0.0"
+    )
+
+
+def _components_from_lockfiles(project_dir):
+    """poetry.lock / uv.lock (TOML) or requirements.txt (pinned)."""
+    comps = []
+    poetry = _read_toml(project_dir / "poetry.lock")
+    if poetry and isinstance(poetry.get("package"), list):
+        for pkg in poetry["package"]:
+            n, v = pkg.get("name"), pkg.get("version")
+            if n and v:
+                dev = pkg.get("category") == "dev"
+                comps.append((n, str(v), dev))
+        if comps:
+            return comps, "poetry.lock"
+    uvlock = _read_toml(project_dir / "uv.lock")
+    if uvlock and isinstance(uvlock.get("package"), list):
+        for pkg in uvlock["package"]:
+            n, v = pkg.get("name"), pkg.get("version")
+            if n and v:
+                comps.append((n, str(v), False))
+        if comps:
+            return comps, "uv.lock"
+    req = project_dir / "requirements.txt"
+    if req.exists():
+        for line in req.read_text("utf-8", "ignore").splitlines():
+            line = line.split("#", 1)[0].strip()
+            m = re.match(r"^([A-Za-z0-9][A-Za-z0-9._-]*)\s*==\s*([^\s;]+)", line)
+            if m:
+                comps.append((m.group(1), m.group(2), False))
+        if comps:
+            return comps, "requirements.txt"
+    return [], None
+
+
+def _components_from_env():
+    """Resolved packages in the active environment (importlib.metadata)."""
+    comps = []
+    for dist in importlib_metadata.distributions():
+        try:
+            n = dist.metadata["Name"]
+            v = dist.version
+        except Exception:
+            continue
+        if n and v:
+            comps.append((n, str(v), False))
+    return comps
+
+
+def build_sbom(project_dir, product_name_override):
+    product_name, product_version = _project_meta(project_dir, product_name_override)
+
+    raw, source = _components_from_lockfiles(project_dir)
+    if not raw:
+        raw = _components_from_env()
+        source = "environment"
+
+    seen, components = set(), []
+    for name, version, dev in raw:
+        key = f"{name}@{version}"
+        if key in seen:
+            continue
+        seen.add(key)
+        purl = pypi_purl(name, version)
+        components.append(
+            {
+                "type": "library",
+                "bom-ref": purl,
+                "name": name,
+                "version": version,
+                "purl": purl,
+                "scope": "optional" if dev else "required",
+            }
+        )
+
+    return (
+        {
+            "bomFormat": "CycloneDX",
+            "specVersion": "1.6",
+            "serialNumber": f"urn:uuid:{uuid.uuid4()}",
+            "version": 1,
+            "metadata": {
+                "timestamp": time.strftime("%Y-%m-%dT%H:%M:%SZ", time.gmtime()),
+                "tools": [
+                    {"vendor": "SYNAPSE", "name": "synapse-sbom", "version": __version__}
+                ],
+                "component": {
+                    "type": "application",
+                    "bom-ref": pypi_purl(product_name, product_version),
+                    "name": product_name,
+                    "version": product_version,
+                    "purl": pypi_purl(product_name, product_version),
+                },
+            },
+            "components": components,
+        },
+        source or "environment",
+    )
+
+
+# ── stable project identity (shared format with the npm tool) ──────────
+def git_remote_key(dir_):
+    try:
+        url = (
+            subprocess.run(
+                ["git", "-C", str(dir_), "config", "--get", "remote.origin.url"],
+                stdout=subprocess.PIPE,
+                stderr=subprocess.DEVNULL,
+                stdin=subprocess.DEVNULL,
+                check=True,
+            )
+            .stdout.decode()
+            .strip()
+        )
+    except Exception:
+        return None
+    if not url:
+        return None
+    n = re.sub(r"^[a-z]+://", "", url, flags=re.I)
+    n = re.sub(r"^[^@/]+@", "", n)
+    n = n.replace(":", "/", 1)
+    n = re.sub(r"\.git$", "", n).lower().rstrip("/")
+    return f"git:{n}" if n else None
+
+
+def resolve_project_key(dir_, flags, write):
+    explicit = flags.get("project") or os.environ.get("SYNAPSE_PROJECT")
+    if explicit:
+        return explicit.strip(), "flag/env"
+
+    pf = dir_ / PROJECT_FILE
+    try:
+        j = json.loads(pf.read_text("utf-8"))
+        if j and j.get("projectId"):
+            return str(j["projectId"]), PROJECT_FILE
+    except Exception:
+        pass
+
+    gk = git_remote_key(dir_)
+    if gk:
+        return gk, "git remote"
+
+    generated = str(uuid.uuid4())
+    if write:
+        pf.write_text(json.dumps({"projectId": generated}, indent=2) + "\n")
+        print(
+            f"No git remote — generated a project id and wrote {PROJECT_FILE}. "
+            f"Commit this file so every clone/CI scans as the same product.",
+            file=sys.stderr,
+        )
+    return generated, "generated"
+
+
+# ── commands ───────────────────────────────────────────────────────────
+def cmd_login(flags):
+    cfg = read_config()
+    api_key = flags.get("key")
+    if not api_key:
+        import getpass
+
+        api_key = getpass.getpass("SYNAPSE API key: ").strip()
+    if not api_key:
+        raise RuntimeError("an API key is required")
+    api_url = (flags.get("url") or cfg.get("apiUrl") or DEFAULT_API_URL).rstrip("/")
+    warn_insecure_transport(api_url)
+    cfg.update({"apiKey": api_key, "apiUrl": api_url})
+    write_config(cfg)
+    print(f"Saved to {CONFIG_FILE} (mode 600)")
+    print(f"API URL: {api_url}")
+
+
+def cmd_whoami(flags):
+    api_key, api_url = resolve_auth(flags)
+    print(f"API URL : {api_url}")
+    masked = (
+        f"{api_key[:4]}…({len(api_key)} chars)" if api_key else "(none)"
+    )
+    print(f"API key : {masked}")
+    print(f"Config  : {CONFIG_FILE}")
+
+
+def _spinner(stop_evt, t0):
+    is_tty = sys.stderr.isatty()
+    frames = "⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏"
+    f = 0
+    while not stop_evt.wait(0.25 if is_tty else 30):
+        s = round(time.time() - t0)
+        if is_tty:
+            sys.stderr.write(f"\r{frames[f % len(frames)]} analyzing… {s}s")
+            sys.stderr.flush()
+            f += 1
+        else:
+            sys.stderr.write(f"… still analyzing ({s}s)\n")
+
+
+def cmd_scan(positional, flags):
+    project_dir = Path(positional[0] if positional else ".").resolve()
+    sbom, source = build_sbom(project_dir, flags.get("product"))
+    project_key, key_source = resolve_project_key(
+        project_dir, flags, not flags.get("dryRun")
+    )
+    print(f"Project identity: {project_key} ({key_source})", file=sys.stderr)
+    print(
+        f"Generated CycloneDX SBOM: {sbom['metadata']['component']['name']}@"
+        f"{sbom['metadata']['component']['version']} "
+        f"({len(sbom['components'])} components, from {source})",
+        file=sys.stderr,
+    )
+
+    if flags.get("dryRun"):
+        sys.stdout.write(json.dumps(sbom, indent=2) + "\n")
+        return
+
+    api_key, api_url = resolve_auth(flags)
+    if not api_key:
+        raise RuntimeError(
+            'no API key — run "synapse-sbom login" or set SYNAPSE_API_KEY'
+        )
+    warn_insecure_transport(api_url)
+
+    print(
+        f"Submitting {len(sbom['components'])} component(s) to {api_url} — "
+        f"resolving & enriching vulnerabilities server-side. Large projects "
+        f"can take a few minutes…",
+        file=sys.stderr,
+    )
+
+    env_timeout = os.environ.get("SYNAPSE_TIMEOUT_MS")
+    try:
+        timeout_ms = float(env_timeout) if env_timeout else 0
+    except ValueError:
+        timeout_ms = 0
+    timeout_s = (timeout_ms / 1000.0) if timeout_ms > 0 else 20 * 60
+
+    body = json.dumps(
+        {
+            "format": "cyclonedx",
+            "sbom": sbom,
+            "product": {"project_key": project_key},
+        }
+    ).encode()
+    req = urllib.request.Request(
+        f"{api_url}/v1/sca/analyze",
+        data=body,
+        method="POST",
+        headers={
+            "Content-Type": "application/json",
+            "Authorization": f"Bearer {api_key}",
+        },
+    )
+
+    t0 = time.time()
+    stop_evt = threading.Event()
+    ticker = threading.Thread(target=_spinner, args=(stop_evt, t0), daemon=True)
+    ticker.start()
+    try:
+        try:
+            resp = urllib.request.urlopen(req, timeout=timeout_s)
+            status, text = resp.status, resp.read().decode("utf-8", "replace")
+        except urllib.error.HTTPError as e:  # non-2xx still has a body
+            status = e.code
+            text = e.read().decode("utf-8", "replace")
+        except (urllib.error.URLError, socket.timeout, TimeoutError) as e:
+            reason = getattr(e, "reason", e)
+            if isinstance(reason, (socket.timeout, TimeoutError)) or isinstance(
+                e, (socket.timeout, TimeoutError)
+            ):
+                raise RuntimeError(
+                    f"timed out after {round(timeout_s)}s — the server is "
+                    f"still analyzing; re-run later (results cache) or raise "
+                    f"SYNAPSE_TIMEOUT_MS"
+                )
+            raise RuntimeError(f"could not reach {api_url}: {reason}")
+    finally:
+        stop_evt.set()
+        ticker.join(timeout=1)
+        if sys.stderr.isatty():
+            sys.stderr.write("\r\x1b[K")
+            sys.stderr.flush()
+
+    print(f"Done in {round(time.time() - t0)}s (HTTP {status})", file=sys.stderr)
+
+    try:
+        data = json.loads(text)
+    except ValueError:
+        data = {"detail": text}
+    if not (200 <= status < 300):
+        detail = data.get("detail") or data.get("message") or text or "request failed"
+        raise RuntimeError(f"API {status}: {detail}")
+
+    s = data.get("summary") or {}
+    print(f"Submitted to {api_url}")
+    product = data.get("product") or {}
+    print(f"  product   : {product.get('name')} ({data.get('product_id')})")
+    print(f"  components : {s.get('components_total', '?')}")
+    print(f"  vulnerable : {s.get('components_vulnerable', 0)}")
+    print(f"  new CVEs   : {len(data.get('new_cve_ids') or [])}")
+    skipped = data.get("skipped") or []
+    if skipped:
+        print(f"  skipped    : {len(skipped)} (unsupported ecosystem)")
+
+
+def main(argv=None):
+    argv = list(sys.argv[1:] if argv is None else argv)
+    try:
+        positional, flags = parse_args(argv)
+        cmd = positional.pop(0) if positional else None
+
+        if not cmd or flags.get("help") is not None or cmd == "help":
+            print(USAGE)
+            return 0
+        if cmd == "login":
+            cmd_login(flags)
+        elif cmd == "whoami":
+            cmd_whoami(flags)
+        elif cmd == "scan":
+            cmd_scan(positional, flags)
+        else:
+            print(f"unknown command: {cmd}\n", file=sys.stderr)
+            print(USAGE)
+            return 1
+        return 0
+    except BrokenPipeError:
+        # stdout closed early (e.g. piped to `head`) — exit cleanly.
+        try:
+            sys.stdout.close()
+        except Exception:
+            pass
+        return 0
+    except KeyboardInterrupt:
+        return 130
+    except Exception as err:  # noqa: BLE001 — single top-level reporter
+        print(f"synapse-sbom: {err}", file=sys.stderr)
+        return 1
+
+
+if __name__ == "__main__":
+    sys.exit(main())