@gpzhang2001/sharpkit-proxy 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,27 @@
+# @gpzhang2001/sharpkit-proxy
+
+Caido 代理客户端 + 五工具（list_requests / view_request / repeat_request / list_sitemap / view_sitemap_entry）。
+
+## 工具
+
+- **list_requests**：HTTPQL 过滤（整数/文本/日期操作符、AND/OR、无 NOT）、游标分页、8 键排序（strix `_REQ_FIELD_MAP` → Caido 枚举映射）、scope 限定
+- **view_request**：request/response raw 二选一；`search_pattern` → ≤20 命中（±40 字符上下文）；否则行分页（`page`/`page_size`/`has_more`）
+- **repeat_request**：取 raw → 解析 → 补丁（url/params/headers/body/cookies）→ 重建 raw（Host/UA 默认、framing 头剔除、Content-Length 重算）→ 空 replay 会话 + startReplayTask → 轮询 entry 至出响应/错误（SDK 订阅等待的 HTTP-only 适配）；30s strix 超时语义与文案
+- **list_sitemap**：根（scope 过滤）/ 后代（DIRECT/ALL），字段集照抄 caido_api.py:555-592
+- **view_sitemap_entry**：entry 详情 + 最近 30 条请求
+
+## 形态
+
+- `client.ts`：global fetch + Bearer（endpoint 来自 sandbox 会话的 Caido bootstrap，**懒解析**——首次工具调用才付登录等待，strix 并发语义）
+- GraphQL 文档为 caido_sdk_client 生成文档的 trimmed 子集，**已对真实 Caido 0.56.0 schema 验证**
+- Caido ID 为 i32：非数字 ID 是 GraphQL 层错误（集成测试锁定该行为）
+- `replay.ts`：纯函数（parse/build raw、修改叠加、响应解析 8192 截断）100% 单测
+
+## Config
+
+`scanId`、`listPageSize`（50）、`replayTimeoutMs`（30s）、`caidoTimeoutMs`（60s，对齐原 @function_tool timeout）。
+
+## 测试
+
+- `tests/replay.test.ts` / `tests/proxy.test.ts`：纯函数 + fake HTTP 通道（精确操作名路由）
+- `tests/integration.test.ts`：真实容器内 Caido（docker 门控）——空表列出、sitemap、缺席 ID、GraphQL 层 ID 格式错误

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.

package/lib/index.d.ts

@@ -0,0 +1,110 @@
+import z from "@deepseek-ai/schemastery";
+import { Context } from "@deepseek-ai/cordis";
+//#region src/index.d.ts
+var [Config] = [
+	0,
+	() => [],
+	[
+		"",
+		"",
+		"",
+		"",
+		"",
+		""
+	]
+];
+var [name] = [
+	1,
+	() => [],
+	[]
+];
+var [inject] = [
+	2,
+	() => [],
+	[]
+];
+var [Config] = [
+	3,
+	() => [Config, z],
+	["", ""]
+];
+var [targetHostAllowed] = [
+	4,
+	() => [],
+	["", ""]
+];
+var [resolveRepeatTargetHost] = [
+	5,
+	() => [Record, Readonly],
+	[
+		"",
+		"",
+		"",
+		""
+	]
+];
+var [SITEMAP_PAGE_SIZE] = [
+	6,
+	() => [],
+	[]
+];
+var [pageSitemapPayload] = [
+	7,
+	() => [Record, Record],
+	[
+		"",
+		"",
+		"",
+		""
+	]
+];
+var [SearchHit] = [
+	8,
+	() => [],
+	[
+		"",
+		"",
+		"",
+		""
+	]
+];
+var [formatSearchHits] = [
+	9,
+	() => [SearchHit],
+	[
+		"",
+		"",
+		"",
+		"",
+		"",
+		""
+	]
+];
+var [formatTextPage] = [
+	10,
+	() => [],
+	[
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		""
+	]
+];
+var [apply] = [
+	11,
+	() => [Context, Config],
+	[
+		"",
+		"",
+		"",
+		""
+	]
+];
+//#endregion
+export { Config, SITEMAP_PAGE_SIZE, apply, formatSearchHits, formatTextPage, inject, name, pageSitemapPayload, resolveRepeatTargetHost, targetHostAllowed };
+
+//# sourceMappingURL=index.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.ts","names":["Schema"],"sources":["../src/index.d.ts"],"sourcesContent":["/**\n * Caido proxy tools — TS port of strix tools/proxy/tools.py (schemas and\n * output shaping verbatim; the client half lives in client.ts, replay pure\n * helpers in replay.ts). Five tools: list_requests / view_request /\n * repeat_request / list_sitemap / view_sitemap_entry. The client resolves\n * lazily from the sandbox session's Caido bootstrap (concurrent with scan\n * start; the first tool call pays the login wait — strix lazy parity).\n * @module @gpzhang2001/sharpkit-proxy\n */\nimport type { Context } from '@deepseek-ai/cordis';\nimport type Schema from '@deepseek-ai/schemastery';\n/** Deployment-tunable configuration. */\nexport interface Config {\n    /** Sandbox session cache key shared with the other tool packages. */\n    readonly scanId?: string;\n    /** list_requests page size default (strix first=50). */\n    readonly listPageSize?: number;\n    /** Replay dispatch deadline (strix 30s). */\n    readonly replayTimeoutMs?: number;\n    /** Client-level per-call timeout (strix @function_tool timeout=60/120). */\n    readonly caidoTimeoutMs?: number;\n    /** Ask-approval gate on repeat_request (fail-closed without an approval service). */\n    readonly requireApproval?: boolean;\n    /** Authorized target hosts/values; repeat_request refuses hosts outside this list (exact or dot-suffix subdomain). */\n    readonly authorizedTargets?: string[];\n}\nexport declare const name = \"pentest-tool-proxy\";\nexport declare const inject: string[];\nexport declare const Config: Schema<Config>;\n/**\n * Whether a repeat target host is inside the authorized list. Entries may be\n * bare hosts (`example.com`), wildcard subdomains (`*.example.com`), or full\n * URLs (hostname taken); a candidate matches on exact host or a dot-suffix\n * subdomain. An empty list allows everything (fail-open; warned once).\n * @param host - the replay target hostname.\n * @param authorized - the configured target entries.\n */\nexport declare function targetHostAllowed(host: string, authorized: readonly string[]): boolean;\n/**\n * Resolve the replay target hostname: an explicit url modification wins;\n * otherwise the stored request's host.\n */\nexport declare function resolveRepeatTargetHost(storedHost: string, modifications: Readonly<Record<string, unknown>> | undefined): string;\n/** Sitemap page size (strix parity: 30 entries per page). */\nexport declare const SITEMAP_PAGE_SIZE = 30;\n/**\n * Slice one sitemap connection payload to a 1-indexed page of edges (the\n * total count is preserved). Payloads without a recognized connection pass\n * through untouched.\n */\nexport declare function pageSitemapPayload(payload: Record<string, unknown>, page: number): Record<string, unknown>;\n/** strix view_request search hits: ≤20 matches with ±40 chars of context. */\ninterface SearchHit {\n    readonly match: string;\n    readonly position: number;\n    readonly before: string;\n    readonly after: string;\n}\n/**\n * Compact regex hits over raw content (strix `_format_search_hits`).\n * @param content - the raw text.\n * @param pattern - the model-supplied regex.\n * @returns the hits payload, or an error entry when the regex is invalid.\n */\nexport declare function formatSearchHits(content: string, pattern: string): {\n    readonly hits: SearchHit[];\n    readonly totalHits: number;\n    readonly error?: string;\n};\n/**\n * Line-paginated raw content page (strix `_format_text_page`).\n * @param content - the raw text.\n * @param page - 1-indexed page number.\n * @param pageSize - lines per page.\n */\nexport declare function formatTextPage(content: string, page: number, pageSize: number): {\n    readonly content: string;\n    readonly page: number;\n    readonly pageSize: number;\n    readonly totalLines: number;\n    readonly hasMore: boolean;\n};\nexport declare function apply(ctx: Context, config?: Config): void;\nexport {};\n"],"mappings":";;;AAEA,IAAW,CAAC,UAAU;CAAC;OAAS,CAAC;CAAG;EAAC;EAAI;EAAI;EAAI;EAAI;EAAI;CAAE;AAAC;AAC5D,IAAW,CAAC,QAAQ;CAAC;OAAS,CAAC;CAAG,CAAC;AAAC;AACpC,IAAW,CAAC,UAAU;CAAC;OAAS,CAAC;CAAG,CAAC;AAAC;AACtC,IAAW,CAAC,UAAU;CAAC;OAAS,CAAC,QAAQA,CAAM;CAAG,CAAC,IAAI,EAAE;AAAC;AAC1D,IAAW,CAAC,qBAAqB;CAAC;OAAS,CAAC;CAAG,CAAC,IAAI,EAAE;AAAC;AACvD,IAAW,CAAC,2BAA2B;CAAC;OAAS,CAAC,QAAQ,QAAQ;CAAG;EAAC;EAAI;EAAI;EAAI;CAAE;AAAC;AACrF,IAAW,CAAC,qBAAqB;CAAC;OAAS,CAAC;CAAG,CAAC;AAAC;AACjD,IAAW,CAAC,sBAAsB;CAAC;OAAS,CAAC,QAAQ,MAAM;CAAG;EAAC;EAAI;EAAI;EAAI;CAAE;AAAC;AAC9E,IAAI,CAAC,aAAa;CAAC;OAAS,CAAC;CAAG;EAAC;EAAI;EAAI;EAAI;CAAE;AAAC;AAChD,IAAW,CAAC,oBAAoB;CAAC;OAAS,CAAC,SAAS;CAAG;EAAC;EAAI;EAAI;EAAI;EAAI;EAAI;CAAE;AAAC;AAC/E,IAAW,CAAC,kBAAkB;CAAC;OAAU,CAAC;CAAG;EAAC;EAAI;EAAI;EAAI;EAAI;EAAI;EAAI;EAAI;CAAE;AAAC;AAC7E,IAAW,CAAC,SAAS;CAAC;OAAU,CAAC,SAAS,MAAM;CAAG;EAAC;EAAI;EAAI;EAAI;CAAE;AAAC"}