seculens 0.3.1__tar.gz

seculens-0.3.1/.gitignore

@@ -0,0 +1,9 @@
+.venv/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.ruff_cache/
+dist/
+*.egg-info/
+reports/
+releases/

seculens-0.3.1/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+## 0.3.1
+
+- Move repository links and PyPI publisher configuration to the GitHub owner `masahiroid`.
+
+## 0.3.0
+
+- Start an interactive setup wizard when `seculens` is run without arguments.
+- Add English (default) and Japanese prompts; propagate the selected language to Word reports.
+- Collect assessment / SBOM generation settings, validate input paths, review settings and confirm before execution.
+- Add `seculens wizard --lang en|ja` for direct language selection; preserve existing CLI commands.
+- Cancel cleanly on EOF or declined execution; support Ctrl+C interruption.
+
+## 0.2.0
+
+- Add customer report mode: cover, severity summary, findings register, numbered details, component table and page numbers.
+- Add human-readable target and preparer options.
+- Add traceable advisory severity, validated CVSS 3.0/3.1 base scoring, package-specific score selection and conservative alias severity consolidation.
+- Preserve unknown / unsupported severity as Unrated; distinguish AST/license review from vulnerability severity.
+- Extend report JSON to schema 1.1 with severity provenance and optional source-analysis execution metadata.
+
+## 0.1.0
+
+Initial native implementation: SPDX / CycloneDX JSON import, OSV matching, license policies, source analysis and Word / JSON reports.

seculens-0.3.1/LICENSE

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

seculens-0.3.1/NOTICE

@@ -0,0 +1,7 @@
+SecuLens
+Copyright 2026 SecuLens contributors
+
+OSV advisory snapshots contain third-party data subject to their original licenses.
+
+Noto Sans JP font is bundled under the SIL Open Font License 1.1.
+See src/seculens/assets/OFL.txt for copyright and license terms.

seculens-0.3.1/PKG-INFO

@@ -0,0 +1,164 @@
+Metadata-Version: 2.5
+Name: seculens
+Version: 0.3.1
+Summary: Independent Python SBOM vulnerability matching, license policies, static analysis and Word reports
+Project-URL: Homepage, https://github.com/masahiroid/seculens-python
+Project-URL: Repository, https://github.com/masahiroid/seculens-python
+Project-URL: Issues, https://github.com/masahiroid/seculens-python/issues
+Author: SecuLens contributors
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+License-File: src/seculens/assets/OFL.txt
+Keywords: cyclonedx,docx,sbom,security,spdx,static-analysis,vulnerability
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+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: Programming Language :: Python :: 3.14
+Classifier: Topic :: Security
+Requires-Python: >=3.10
+Requires-Dist: license-expression<31,>=30.4
+Requires-Dist: packageurl-python<1,>=0.17
+Requires-Dist: packaging<27,>=24
+Requires-Dist: python-docx<2,>=1.2
+Requires-Dist: requests<3,>=2.34.2
+Requires-Dist: semantic-version<3,>=2.10
+Provides-Extra: dev
+Requires-Dist: build<2,>=1.2; extra == 'dev'
+Requires-Dist: pip-audit<3,>=2.9; extra == 'dev'
+Requires-Dist: pytest<10,>=8; extra == 'dev'
+Requires-Dist: ruff<1,>=0.12; extra == 'dev'
+Requires-Dist: twine<8,>=6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# SecuLens for Python
+
+Independent Python implementation of SecuLens: assess SPDX / CycloneDX JSON SBOMs against OSV records, apply SPDX license-expression policies, review Python ASTs, and produce customer-facing Word and JSON reports. Python 3.10+; no Node.js or Trivy runtime required.
+
+This is an early release, not a complete SAST or legal compliance determination. A vulnerability match is evidence from the supplied advisory snapshot; a security AST finding is a review candidate.
+
+## Interactive wizard / 対話ウィザード
+
+Run `seculens` with no arguments to start interactive setup. English is the default: press Enter at the language prompt, or type `ja` for Japanese. Use `seculens wizard --lang ja` to open Japanese setup directly.
+
+```sh
+seculens
+# or
+seculens wizard --lang ja
+```
+
+Choose an existing SBOM assessment or SBOM generation, then supply the requested paths and options. Assessment asks for a local OSV snapshot or explicit OSV fetching, an optional license policy and source directory, customer / target / preparer, report style, output directory and findings exit policy. Customer report layout is the wizard default. Review the settings and confirm to start. EOF or choosing `n` at the final prompt cancels; Ctrl+C interrupts. OSV fetching sends package names and ecosystems; the wizard displays this before execution.
+
+`seculens` だけで起動すると設定ウィザードが始まります。言語選択でEnterを押すと英語、`ja` を入力すると日本語です。入力した言語をWordレポートにも使います。最後に設定を確認して開始できます。パスは現在の作業フォルダーを基準に入力してください。従来の `scan` / `sbom` コマンドとオプション指定も利用できます。
+
+## Install
+
+Until PyPI publication, install the wheel from [GitHub releases](https://github.com/masahiroid/seculens-python/releases). For development:
+
+```sh
+python -m venv .venv
+# Activate your virtual environment, then:
+pip install -e '.[dev]'
+seculens --version
+```
+
+## Quick start (offline)
+
+```sh
+seculens scan examples/cyclonedx.json --db examples/database.json \
+  --policy examples/policy.json --source examples \
+  --customer "Sample Customer" --lang ja --output reports/sample
+```
+
+`examples/database.json` is synthetic demonstration data, not a production vulnerability database. Outputs are `report.docx`, `report.json`, `sbom.json`, and `database.json`. Japanese Word reports embed the bundled Noto Sans JP font under the SIL Open Font License.
+
+Download current OSV candidates explicitly:
+
+```sh
+seculens scan bom.json --fetch-osv --policy examples/policy.json --output reports/live
+```
+
+Only package names and ecosystems are sent to `api.osv.dev`; matching is performed locally. Use `--db` for offline assessment. Pagination, withdrawn records, version ranges, advisory aliases, unsupported identities and incomplete ranges are accounted for. `no-match` never means vulnerability-free. Evidence hashes identify the exact SBOM and database text used.
+
+## Generate SBOMs
+
+Install [Syft](https://github.com/anchore/syft) separately, then:
+
+```sh
+seculens sbom ./project --format cyclonedx --output bom.cdx.json
+seculens sbom ./project --format spdx --output bom.spdx.json
+```
+
+`--syft /path/to/syft` selects an executable. SecuLens validates its output. Existing CycloneDX 1.4–1.7 JSON or SPDX 2.2/2.3 JSON can also be imported directly. Package URLs identify npm, PyPI and Packagist dependencies regardless of which language implementation runs the assessment. SPDX 3 and XML are not supported yet.
+
+## License policy
+
+```json
+{"allow": ["MIT", "Apache-2.0", "BSD-3-Clause"], "deny": ["GPL-3.0-only"]}
+```
+
+SPDX `AND` requires all branches to be allowed; `OR` accepts an allowed option. `WITH` exceptions require an exact policy entry. Unrecognized or missing expressions require review. This evaluates the configured policy, not every legal obligation or regulatory framework.
+
+## Python analysis
+
+`--source` parses `.py` files without importing or executing them. Rules review `eval` / `exec`, OS shell calls, `subprocess` with literal `shell=True`, pickle deserialization and YAML loading without an explicit safe loader. Complexity review triggers above cyclomatic 10 or nesting 4. Imports and aliases are recognized syntactically; shadowing, dynamic aliases, data flow and exploitability are not resolved. Syntax errors become coverage findings. Virtual environments, dependency/build directories and symlinks are skipped. JS/TS source analysis belongs to the [TypeScript implementation](https://github.com/masahiroid/seculens); PHP implementation is planned.
+
+## Exit status and API
+
+- `0`: assessment completed (findings may exist).
+- `1`: `--fail-on-findings` and a vulnerability, denied license or security review candidate exists.
+- `2`: incomplete coverage or an operational error; status 1 takes precedence when requested.
+
+```python
+from seculens import scan_sbom, write_word_report
+
+report = scan_sbom(sbom_text, records, policy={"allow": ["MIT"]}, customer="Customer")
+write_word_report(report, "report.docx", language="ja")
+```
+
+Schema `1.1` is shared with the TypeScript implementation. Advisory matching supports PyPI PEP 440, npm SemVer and stable numeric Composer versions / SemVer prereleases; Composer branches and Git commit ranges can remain unassessed. Customer-specific risk prioritization, reachability, container/OS scanning and full SAST are future work. Reports do not claim those checks were performed.
+
+## Validation
+
+```sh
+pytest
+ruff check .
+ruff format --check .
+pip-audit
+python -m build
+python -m twine check dist/*
+```
+
+See [security policy](SECURITY.md). Apache-2.0 code; bundled Japanese font is SIL OFL. [NOTICE](NOTICE) identifies third-party assets.
+
+## Customer report mode
+
+Add `--report-style customer` to generate a formal Word report with a dedicated cover, executive summary, severity colors, a prioritized findings register, numbered details, component coverage tables, evidence hashes and page numbers. Existing standard layout remains available with `--report-style standard` (the default).
+
+```sh
+seculens scan bom.json --db database.json --policy policy.json \
+  --customer "Customer Company" --target "Customer Web Service" \
+  --issuer "Security Assessment Team" --lang ja \
+  --report-style customer --output reports/customer
+```
+
+`--target` supplies a human-readable system name; it defaults to the SBOM filename. `--issuer` supplies the cover's preparer and document author. Both are optional. The report ID incorporates the SBOM hash, DB hash and assessment timestamp. Finding numbers link the register to details; code/license review statuses are separate from vulnerability severity.
+
+Severity colors: Critical / High red, Medium amber, Low blue, None green, Unrated gray. Labels accompany colors for accessibility. Vulnerability counts consolidate aliases per component; category counts include review candidates. CVSS zero / None is a severity band, not proof of absence of vulnerabilities.
+
+Severity comes from validated CVSS 3.0/3.1 base vectors or recognized `database_specific.severity` labels. Package-specific OSV `affected.severity` overrides global vectors for that affected entry. Alias consolidation preserves all provenance and displays the highest supported severity; when sources disagree, the underlying labels/vectors and scores remain available in JSON. CVSS 2/4 vectors and malformed vectors are not calculated. Without other usable metadata these stay Unrated. No severity is inferred from advisory wording, AST review candidates or licenses.
+
+Report JSON schema 1.1 adds optional vulnerability `severity` (level, optional base score, and source record IDs / field paths / raw values) and optional CLI `sourceAnalysis` execution metadata. Presentation sorting does not alter the assessment JSON. Word contains concise severity attribution; full original metadata and references stay in JSON. This mode changes presentation and adds severity evidence, not the vulnerability matching criteria.
+
+Scoring reference: https://www.first.org/cvss/v3.1/specification-document
+OSV field reference: https://ossf.github.io/osv-schema/
+
+```python
+write_word_report(
+    report, "customer.docx", language="ja", style="customer", issuer="Assessment Team"
+)
+```

seculens-0.3.1/README.md

@@ -0,0 +1,127 @@
+# SecuLens for Python
+
+Independent Python implementation of SecuLens: assess SPDX / CycloneDX JSON SBOMs against OSV records, apply SPDX license-expression policies, review Python ASTs, and produce customer-facing Word and JSON reports. Python 3.10+; no Node.js or Trivy runtime required.
+
+This is an early release, not a complete SAST or legal compliance determination. A vulnerability match is evidence from the supplied advisory snapshot; a security AST finding is a review candidate.
+
+## Interactive wizard / 対話ウィザード
+
+Run `seculens` with no arguments to start interactive setup. English is the default: press Enter at the language prompt, or type `ja` for Japanese. Use `seculens wizard --lang ja` to open Japanese setup directly.
+
+```sh
+seculens
+# or
+seculens wizard --lang ja
+```
+
+Choose an existing SBOM assessment or SBOM generation, then supply the requested paths and options. Assessment asks for a local OSV snapshot or explicit OSV fetching, an optional license policy and source directory, customer / target / preparer, report style, output directory and findings exit policy. Customer report layout is the wizard default. Review the settings and confirm to start. EOF or choosing `n` at the final prompt cancels; Ctrl+C interrupts. OSV fetching sends package names and ecosystems; the wizard displays this before execution.
+
+`seculens` だけで起動すると設定ウィザードが始まります。言語選択でEnterを押すと英語、`ja` を入力すると日本語です。入力した言語をWordレポートにも使います。最後に設定を確認して開始できます。パスは現在の作業フォルダーを基準に入力してください。従来の `scan` / `sbom` コマンドとオプション指定も利用できます。
+
+## Install
+
+Until PyPI publication, install the wheel from [GitHub releases](https://github.com/masahiroid/seculens-python/releases). For development:
+
+```sh
+python -m venv .venv
+# Activate your virtual environment, then:
+pip install -e '.[dev]'
+seculens --version
+```
+
+## Quick start (offline)
+
+```sh
+seculens scan examples/cyclonedx.json --db examples/database.json \
+  --policy examples/policy.json --source examples \
+  --customer "Sample Customer" --lang ja --output reports/sample
+```
+
+`examples/database.json` is synthetic demonstration data, not a production vulnerability database. Outputs are `report.docx`, `report.json`, `sbom.json`, and `database.json`. Japanese Word reports embed the bundled Noto Sans JP font under the SIL Open Font License.
+
+Download current OSV candidates explicitly:
+
+```sh
+seculens scan bom.json --fetch-osv --policy examples/policy.json --output reports/live
+```
+
+Only package names and ecosystems are sent to `api.osv.dev`; matching is performed locally. Use `--db` for offline assessment. Pagination, withdrawn records, version ranges, advisory aliases, unsupported identities and incomplete ranges are accounted for. `no-match` never means vulnerability-free. Evidence hashes identify the exact SBOM and database text used.
+
+## Generate SBOMs
+
+Install [Syft](https://github.com/anchore/syft) separately, then:
+
+```sh
+seculens sbom ./project --format cyclonedx --output bom.cdx.json
+seculens sbom ./project --format spdx --output bom.spdx.json
+```
+
+`--syft /path/to/syft` selects an executable. SecuLens validates its output. Existing CycloneDX 1.4–1.7 JSON or SPDX 2.2/2.3 JSON can also be imported directly. Package URLs identify npm, PyPI and Packagist dependencies regardless of which language implementation runs the assessment. SPDX 3 and XML are not supported yet.
+
+## License policy
+
+```json
+{"allow": ["MIT", "Apache-2.0", "BSD-3-Clause"], "deny": ["GPL-3.0-only"]}
+```
+
+SPDX `AND` requires all branches to be allowed; `OR` accepts an allowed option. `WITH` exceptions require an exact policy entry. Unrecognized or missing expressions require review. This evaluates the configured policy, not every legal obligation or regulatory framework.
+
+## Python analysis
+
+`--source` parses `.py` files without importing or executing them. Rules review `eval` / `exec`, OS shell calls, `subprocess` with literal `shell=True`, pickle deserialization and YAML loading without an explicit safe loader. Complexity review triggers above cyclomatic 10 or nesting 4. Imports and aliases are recognized syntactically; shadowing, dynamic aliases, data flow and exploitability are not resolved. Syntax errors become coverage findings. Virtual environments, dependency/build directories and symlinks are skipped. JS/TS source analysis belongs to the [TypeScript implementation](https://github.com/masahiroid/seculens); PHP implementation is planned.
+
+## Exit status and API
+
+- `0`: assessment completed (findings may exist).
+- `1`: `--fail-on-findings` and a vulnerability, denied license or security review candidate exists.
+- `2`: incomplete coverage or an operational error; status 1 takes precedence when requested.
+
+```python
+from seculens import scan_sbom, write_word_report
+
+report = scan_sbom(sbom_text, records, policy={"allow": ["MIT"]}, customer="Customer")
+write_word_report(report, "report.docx", language="ja")
+```
+
+Schema `1.1` is shared with the TypeScript implementation. Advisory matching supports PyPI PEP 440, npm SemVer and stable numeric Composer versions / SemVer prereleases; Composer branches and Git commit ranges can remain unassessed. Customer-specific risk prioritization, reachability, container/OS scanning and full SAST are future work. Reports do not claim those checks were performed.
+
+## Validation
+
+```sh
+pytest
+ruff check .
+ruff format --check .
+pip-audit
+python -m build
+python -m twine check dist/*
+```
+
+See [security policy](SECURITY.md). Apache-2.0 code; bundled Japanese font is SIL OFL. [NOTICE](NOTICE) identifies third-party assets.
+
+## Customer report mode
+
+Add `--report-style customer` to generate a formal Word report with a dedicated cover, executive summary, severity colors, a prioritized findings register, numbered details, component coverage tables, evidence hashes and page numbers. Existing standard layout remains available with `--report-style standard` (the default).
+
+```sh
+seculens scan bom.json --db database.json --policy policy.json \
+  --customer "Customer Company" --target "Customer Web Service" \
+  --issuer "Security Assessment Team" --lang ja \
+  --report-style customer --output reports/customer
+```
+
+`--target` supplies a human-readable system name; it defaults to the SBOM filename. `--issuer` supplies the cover's preparer and document author. Both are optional. The report ID incorporates the SBOM hash, DB hash and assessment timestamp. Finding numbers link the register to details; code/license review statuses are separate from vulnerability severity.
+
+Severity colors: Critical / High red, Medium amber, Low blue, None green, Unrated gray. Labels accompany colors for accessibility. Vulnerability counts consolidate aliases per component; category counts include review candidates. CVSS zero / None is a severity band, not proof of absence of vulnerabilities.
+
+Severity comes from validated CVSS 3.0/3.1 base vectors or recognized `database_specific.severity` labels. Package-specific OSV `affected.severity` overrides global vectors for that affected entry. Alias consolidation preserves all provenance and displays the highest supported severity; when sources disagree, the underlying labels/vectors and scores remain available in JSON. CVSS 2/4 vectors and malformed vectors are not calculated. Without other usable metadata these stay Unrated. No severity is inferred from advisory wording, AST review candidates or licenses.
+
+Report JSON schema 1.1 adds optional vulnerability `severity` (level, optional base score, and source record IDs / field paths / raw values) and optional CLI `sourceAnalysis` execution metadata. Presentation sorting does not alter the assessment JSON. Word contains concise severity attribution; full original metadata and references stay in JSON. This mode changes presentation and adds severity evidence, not the vulnerability matching criteria.
+
+Scoring reference: https://www.first.org/cvss/v3.1/specification-document
+OSV field reference: https://ossf.github.io/osv-schema/
+
+```python
+write_word_report(
+    report, "customer.docx", language="ja", style="customer", issuer="Assessment Team"
+)
+```

seculens-0.3.1/SECURITY.md

@@ -0,0 +1,7 @@
+# Security policy
+
+This is an early release. Do not treat a clean result as proof of safety or compliance.
+
+Report a suspected vulnerability privately through GitHub's private vulnerability reporting for this repository. Avoid posting secrets or private source code in public issues.
+
+OSV download is opt-in. Offline scanning does not transmit package inventories. SBOM generation runs your selected Syft executable. Python analysis parses source without running it.

seculens-0.3.1/docs/architecture.md

@@ -0,0 +1,11 @@
+# Assessment contract
+
+The Python implementation owns SBOM normalization, ecosystem version comparisons, OSV candidate downloads and local matching, SPDX license policy evaluation, Python AST rules, and Word generation. It does not invoke TypeScript or Trivy. Syft is optional and used only for SBOM generation.
+
+`report.json` uses SecuLens schema 1.1: tool/version, creation time, customer, target, SBOM and database hashes, normalized components/dependencies/warnings, per-component checks, findings and limitations. Fixed input text, advisory records and `created_at` produce deterministic assessment JSON. Word font embedding uses a generated GUID, so DOCX bytes are not deterministic.
+
+Advisory IDs and aliases are merged transitively per component. No CVSS severity is inferred from match count. Unknown package identities, unsupported version syntax and unevaluable candidate ranges are reported as incomplete coverage. Syntax errors are also coverage findings. Static review candidates do not establish exploitability.
+
+Offline mode saves the exact supplied SBOM and database text. OSV mode saves the fetched candidate records and performs version comparison locally, rather than trusting version-filtered remote matches. SPDX license obligations beyond the configured allow/deny policy are not determined.
+
+See the README customer report mode section for severity evidence and layout options.

seculens-0.3.1/docs/publishing.md

@@ -0,0 +1,13 @@
+# PyPI trusted publishing
+
+Package name availability is provisional until registration. Configure a pending trusted publisher in the PyPI account that should own SecuLens:
+
+- PyPI project name: `seculens`
+- GitHub owner: `masahiroid`
+- GitHub repository: `seculens-python`
+- Workflow filename: `publish.yml`
+- Environment: `pypi`
+
+Use https://pypi.org/manage/account/publishing/ and follow https://docs.pypi.org/trusted-publishers/creating-a-project-through-oidc/ . No API token needs to be shared in chat. After configuration, run the Publish to PyPI workflow or publish a non-prerelease GitHub release. The workflow tests and audits the project, builds distribution files, validates them, and publishes through OIDC.
+
+Verification: `pip index versions seculens`, install the published version into a fresh environment, check `seculens --version`, then scan the demonstration SBOM. The demonstration snapshot is not production vulnerability data.

seculens-0.3.1/examples/cyclonedx.json

@@ -0,0 +1,50 @@
+{
+  "bomFormat": "CycloneDX",
+  "specVersion": "1.6",
+  "version": 1,
+  "components": [
+    {
+      "bom-ref": "lodash",
+      "type": "library",
+      "name": "lodash",
+      "version": "4.17.20",
+      "purl": "pkg:npm/lodash@4.17.20",
+      "licenses": [
+        {
+          "license": {
+            "id": "MIT"
+          }
+        }
+      ]
+    },
+    {
+      "bom-ref": "requests",
+      "type": "library",
+      "name": "requests",
+      "version": "2.31.0",
+      "purl": "pkg:pypi/requests@2.31.0",
+      "licenses": [
+        {
+          "license": {
+            "id": "Apache-2.0"
+          }
+        }
+      ]
+    },
+    {
+      "bom-ref": "symfony",
+      "type": "library",
+      "group": "symfony",
+      "name": "http-foundation",
+      "version": "5.4.0",
+      "purl": "pkg:composer/symfony/http-foundation@5.4.0",
+      "licenses": [
+        {
+          "license": {
+            "id": "MIT"
+          }
+        }
+      ]
+    }
+  ]
+}