@gpzhang2001/sharpkit-sandbox 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,50 @@
+# @gpzhang2001/sharpkit-sandbox
+
+Docker 沙箱 capability：容器生命周期、exec（含 PTY）、文件传输、端口解析、Caido 引导。驱动方式为 `ctx.subprocess` + docker CLI。
+
+## 形态
+
+Service 插件，注册为 `ctx.pentestSandbox`（cordis `Service`，`inject: ['subprocess']`）。消费方声明 `inject: ['pentestSandbox']`。
+
+```ts
+const session = await ctx.pentestSandbox.createSession({
+  scanId: 'scan-ab12cd34',                                  // 同 id 复用会话（strix create_or_reuse）
+  sources: [{ workspaceSubdir: 'app', sourcePath: '/host/repo', protectMetadata: true }],
+  extraFiles: [{ containerPath: '/workspace/notes.md', content: '…' }],  // 只读，staged + bind mount
+})
+await session.ready()                       // Caido 就绪（guest 登录重试即就绪探测）
+const result = await session.exec('nmap --version', { cwd: '/workspace/app', timeoutMs: 60_000 })
+const repl = await session.execTty('python3')          // PTY；Ctrl-C 写 '\x03'
+await session.putFile(host, '/workspace/f.bin')        // docker cp（二进制安全）
+const bytes = await session.getFile('/workspace/f.bin')
+const { baseUrl, token, projectId } = await session.caidoEndpoint()
+await ctx.pentestSandbox.destroySession('scan-ab12cd34')  // 或交给 fiber dispose 的兜底清理
+```
+
+## 模块
+
+| 文件        | 职责                                                                 |
+| ----------- | -------------------------------------------------------------------- |
+| `spec.ts`   | 纯 spec→argv/env 构造（分支级单测覆盖）                              |
+| `mounts.ts` | bind mount / 元数据保护 / worktree gitdir / 额外文件校验（注入式 fs probe） |
+| `caido.ts`  | guest 登录重试（strix 退避语义）+ 建项目/选中 + 共享 bootstrap handle  |
+| `session.ts`| 会话：exec/PTY/文件/清理（strix cleanup 顺序，尽力而为）              |
+| `index.ts`  | Service：Config、scan-id 缓存、容器编排、staging、镜像缺失时拉取        |
+
+## 语义对照（strix runtime）
+
+- 容器：`tail -f /dev/null` 保活 + 镜像 entrypoint 原样；caps `NET_ADMIN,NET_RAW`；`--add-host host.docker.internal:host-gateway`；端口 `127.0.0.1` 临时发布（network 模式改走容器 IP）
+- env：`PYTHONUNBUFFERED/HOST_GATEWAY/` 三代理指向容器内 Caido（`:48080`）+ `NO_PROXY=localhost,127.0.0.1`；`SHARPKIT_HOST_UID/GID` 仅 Linux
+- Caido：容器内 curl guest 登录（10 次、退避 2,4,6,8,8…s、单次 15s）→ host 端 GraphQL `createProject(name=sandbox, temporary)` + `selectProject`；bootstrap 与扫描启动并发，懒 resolve
+- 清理顺序：staging 目录 → Caido 关闭 → `docker stop -t <grace>` + `rm`（失败升级 `rm -f`）；每步吞错并记日志
+- 额外文件：`/workspace/` 前缀、禁空/`.`/`..`/控制字符、祖先级碰撞检查、staging 编号子目录
+
+## Config（无硬编码 tunable）
+
+`image`（默认 ghcr 原版）、`containerGraceMs`、`workspaceRoot`、`network`、`memLimit/shmSize/cpus/pidsLimit`、`logMaxSize/logMaxFile`（`0/off/none/unlimited` 关闭轮转）、`runLabelId/runLabelType`、`caidoLoginAttempts/caidoLoginTimeoutMs`、`defaultExecTimeoutMs`、`execCollectMaxBytes`。
+
+## 测试
+
+- `tests/spec.test.ts` / `mounts.test.ts` / `caido.test.ts`：纯函数与注入通道（无 Docker）
+- `tests/integration.test.ts`：全流程冒烟（无 Docker daemon 自动 skip；`PENTEST_SANDBOX_IMAGE` 可换镜像）
+- 覆盖率：spec.ts 100% 分支（v8 coverage 实测）

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,321 @@
+import { Context, Service } from "@deepseek-ai/cordis";
+import z from "@deepseek-ai/schemastery";
+import "@deepseek-ai/dsh-subprocess";
+//#region src/mounts.d.ts
+var [SandboxSourceSpec] = [
+	9,
+	() => [],
+	[
+		"",
+		"",
+		""
+	]
+];
+//#endregion
+//#region src/caido.d.ts
+var [CaidoEndpoint] = [
+	31,
+	() => [],
+	[
+		"",
+		"",
+		""
+	]
+];
+var [CaidoBootstrap] = [
+	40,
+	() => [
+		AbortSignal,
+		CaidoEndpoint,
+		Promise,
+		CaidoEndpoint,
+		Promise,
+		CaidoEndpoint
+	],
+	[
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		""
+	]
+];
+//#endregion
+//#region ../../node_modules/.pnpm/@deepseek-ai+dsh-brand@0.1.2-rc.1_@deepseek-ai+cordis@4.0.2/node_modules/@deepseek-ai/dsh-brand/lib/types/index.d.ts
+var [BRAND] = [
+	64,
+	() => [],
+	[]
+];
+var [Branded] = [
+	65,
+	(B) => [B, BRAND],
+	[
+		"",
+		"",
+		""
+	]
+];
+//#endregion
+//#region src/brand.d.ts
+var [SandboxSessionId] = [
+	5,
+	() => [Branded],
+	[""]
+];
+var [SandboxProcessId] = [
+	6,
+	() => [Branded],
+	[""]
+];
+var [SandboxSessionId] = [
+	7,
+	() => [SandboxSessionId],
+	["", ""]
+];
+var [SandboxProcessId] = [
+	8,
+	() => [SandboxProcessId],
+	["", ""]
+];
+//#endregion
+//#region src/session.d.ts
+var [SandboxExecOptions] = [
+	22,
+	() => [AbortSignal],
+	[
+		"",
+		"",
+		"",
+		""
+	]
+];
+var [SandboxExecResult] = [
+	23,
+	() => [],
+	[
+		"",
+		"",
+		"",
+		"",
+		"",
+		""
+	]
+];
+var [SandboxTtyProcess] = [
+	24,
+	() => [
+		SandboxProcessId,
+		Promise,
+		SandboxExecResult,
+		Promise,
+		Promise
+	],
+	[
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		""
+	]
+];
+var [PentestSandboxSession] = [
+	25,
+	() => [
+		SandboxSessionId,
+		Promise,
+		SandboxExecOptions,
+		SandboxExecResult,
+		Promise,
+		SandboxExecProcess,
+		SandboxTtyProcess,
+		Promise,
+		SandboxProcessId,
+		Promise,
+		Promise,
+		Uint8Array,
+		Promise,
+		CaidoEndpoint,
+		Promise,
+		Promise
+	],
+	[
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		""
+	]
+];
+var [SandboxExecProcess] = [
+	27,
+	() => [
+		SandboxProcessId,
+		SandboxExecResult,
+		Promise
+	],
+	[
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		""
+	]
+];
+//#endregion
+//#region src/index.d.ts
+var [_0] = [
+	0,
+	() => [PentestSandboxService],
+	[
+		"",
+		"",
+		""
+	],
+	sideEffect(_0)
+];
+var [SandboxExtraFile] = [
+	1,
+	() => [Uint8Array],
+	[
+		"",
+		"",
+		""
+	]
+];
+var [SandboxSessionOptions] = [
+	2,
+	() => [SandboxSourceSpec, SandboxExtraFile],
+	[
+		"",
+		"",
+		"",
+		"",
+		""
+	]
+];
+var [Config] = [
+	3,
+	() => [],
+	[
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		""
+	]
+];
+var [PentestSandboxService] = [
+	4,
+	() => [
+		Config,
+		z,
+		Context,
+		Config,
+		SandboxSessionOptions,
+		PentestSandboxSession,
+		Promise,
+		Promise,
+		Service
+	],
+	[
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		"",
+		""
+	]
+];
+//#endregion
+export { CaidoBootstrap, CaidoEndpoint, Config, PentestSandboxService, PentestSandboxService as default, PentestSandboxSession, SandboxExecOptions, SandboxExecResult, SandboxExtraFile, SandboxProcessId, SandboxProcessId as SandboxProcessIdType, SandboxSessionId, SandboxSessionId as SandboxSessionIdType, SandboxSessionOptions, SandboxSourceSpec, SandboxTtyProcess };
+
+//# sourceMappingURL=index.ts.map