@gpzhang2001/sharpkit-reporting 0.2.1

package/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 gpzhang2001
+
+   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.

package/README.md

@@ -0,0 +1,32 @@
+# @gpzhang2001/sharpkit-reporting
+
+漏洞/依赖报告五工具 + `sharpkit_runs/` 产物体系（run.json、SARIF 2.1.0、逐漏洞 Markdown）。
+
+## 工具
+
+- **create_vulnerability_report**：23 参数全量移植；severity/CVSS 由 8 指标 `cvss_breakdown` 计算（v3.1 公式与 Python `cvss` 包对拍：6.42×ISC / Scope C 7.52 公式 + 1.08 总分乘数、Roundup1）；code_locations 规范化 + fix_verification/上下文依赖校验；broad CWE 拒绝
+- **create_dependency_report**：CVE×package 一报告；advisory/contextual 双评分（contextual 缺一即弃，strix 语义）；manifest_path/reachability 证据运行时强制
+- **update_vulnerability_report**：白名单 + 依赖字段丢弃（confidence→rationale 等 4 对）+ update_history（含 previous_* 捕获）+ 跨类字段拒绝 + 依赖重评级需 contextual reasoning
+- **list_reports**：过滤器 AND 组合、severity rank 排序、compact 摘要（280 字符预览）/全量两种
+- **get_report**：`vuln-NNNN` 精确查找
+
+## 产物体系
+
+每次增改触发全量落盘（state.py `_save_artifacts` 顺序）：`vulnerabilities/*.md`（增量渲染）→ `vulnerabilities.csv`（\r\n、大写 severity、公式注入防护、rank+时间排序）→ `vulnerabilities.json` → `findings.sarif`（**空结果也写**，覆盖陈旧文件）→ `run.json`（最后写）。全部原子写（同目录临时文件 + rename，无 fsync，strix 语义）。
+
+SARIF 2.1.0：CWE→CVE→id→slug 规则 ID、GitHub security-severity、STRIDE 标签（CWE 映射全量移植）、物理+SECURITY.md 合成位置、PR 建议 fixes、确定性 sha256 partialFingerprints、strix 命名空间属性（**PoC 脚本体永不出境**，只带 description + script_available 标志）。
+
+## 去重
+
+依赖发现走确定性快路径（CVE×package×ecosystem、不同 manifest=两个发现、legacy 词边界匹配）；动态发现的 LLM judge 为 Config 注入回调，judge 失败/缺席一律判非重复。
+
+## Golden 测试
+
+`tests/golden/` 存放**原版 strix 代码**（uv run）对同一输入生成的产物；`golden.test.ts` 断言 TS 输出**逐字节一致**——md×2/csv/json/sarif/run.json 共 6 项。过程捕获并修正了两处偏差：code location 段的 2 空格缩进 + Suggested Fix 空行、元数据行序（dependency 块在 CVE/CWE 之前、Advisory CVSS ≠ CVSS 才显示）。
+
+## 测试
+
+`tests/reporting.test.ts`：CVSS 数学（与 Python cvss 包 5 向量对拍：9.8/6.5/4.4/0.0/10.0）、state（字段序/依赖丢弃/history/hydrate）、normalizers、dedupe 快路径。
+
+## 备注
+

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,48 @@
+# Third-Party Notices
+
+This project builds on and derives assets from the following upstream
+projects. Their licenses and attribution requirements are acknowledged here
+as required by Apache-2.0 §4.
+
+## strix — https://github.com/usestrix/strix
+
+Copyright 2025 OmniSecure Inc. Licensed under the Apache License, Version 2.0.
+
+sharpkit is an independent TypeScript reimplementation of strix's pentest
+domain assets on the DeepSeek Harness plugin architecture (no strix code is
+executed; no Python runtime is required). The following files are carried
+**verbatim or near-verbatim** from strix and remain subject to the above
+notice:
+
+| sharpkit path | Origin | Changes |
+| --- | --- | --- |
+| `packages/preset/src/system_prompt.jinja` | `strix/agents/prompts/system_prompt.jinja` | none (byte-identical template) |
+| `packages/skills/skills/**` (75 knowledge packs, 11 categories) | `strix/strix/skills/**` | none (migrated verbatim) |
+| `sandbox-image/caido_api.py` | `strix/strix/tools/proxy/caido_api.py` | none (byte-identical) |
+| `sandbox-image/docker-entrypoint.sh` | `strix/containers/docker-entrypoint.sh` | none (byte-identical) |
+| `sandbox-image/Dockerfile` | `strix/containers/Dockerfile` | COPY source paths adapted to the standalone context; added overridable `GOPROXY`/`KALI_MIRROR` build args |
+| `packages/preset/src/skills.ts` | `strix/strix/skills/__init__.py` | reimplemented in TypeScript (selection/validation semantics) |
+
+The following subsystems are **semantic ports** (behavior-preserving
+reimplementation, no verbatim text): the SARIF writer and vulnerability
+artifact writers (`packages/tool-reporting/src/{sarif,writers,state}.ts` ←
+`strix/report/*`), the reporting/analysis tool schemas
+(`packages/tool-reporting`, `packages/tool-analysis` ← `strix/tools/*`), the
+Caido client (`packages/tool-proxy/src/client.ts` ← the client half of
+`strix/tools/proxy/caido_api.py`), the sandbox session manager
+(`packages/sandbox` ← `strix/runtime/*`), and the scan-mode preset semantics
+(`packages/preset` ← `strix/agents/factory.py` + `core/inputs.py`).
+
+## DeepSeek Harness (dsh) — https://github.com/deepseek-ai/deepseek-harness
+
+MIT License. Copyright (c) DeepSeek.
+
+dsh is a runtime dependency only (`@deepseek-ai/dsh-*` npm packages); no dsh
+source is embedded or modified in this repository.
+
+## Sandbox image components
+
+The built `sharpkit-sandbox` image bundles Kali Linux and third-party security
+tools (nmap, sqlmap, nuclei, Caido, agent-browser, chromium, and others), each
+under its own license inside the image. Distributing a built image is the
+operator's responsibility; this repository ships only the build recipe.