@huaqiu/dsh-log 0.0.0-stage → 1.1.2

package/dsh-log.yml

@@ -0,0 +1,71 @@
+# dsh-log.yml — configuration reference (spec §8)
+#
+# NOTE (real DSH deployment): this file documents the plugin configuration in
+# the spec's standalone form. The DeepSeek Harness profile loader does NOT read
+# this file directly — it composes the tree from the profile's cordis.patch.yml
+# patch entries. Register the plugin there with the SAME values under `config`:
+#
+#   - insert:
+#       - id: dsh-log
+#         name: ./dsh-log/index.ts
+#         config:
+#           apiAllowHosts: [api.example.com]
+#           scriptAllowDir: /opt/dsh/scripts/
+#           defaultTimeoutMs: 30000
+#           maxTimeoutMs: 120000
+#           maxReqLogBytes: 2048
+#           maxRespLogBytes: 2048
+#           maxOutputLogBytes: 512
+#
+# Field names map 1:1 to the spec's keys (api_allow_hosts → apiAllowHosts,
+# script_allow_dir → scriptAllowDir, default_timeout → defaultTimeoutMs,
+# maxReqLogSize → maxReqLogBytes, ...). See README.md.
+#
+# RENAMED (2026-11-05): plugin formerly known as api-script-log-skill.
+# Host log files written before the rename keep the old
+# `api-script-log-skill-*.jsonl` prefix and are no longer auto-discovered by
+# tools/audit-log.mjs (pass --file to read them).
+
+name: dsh-log
+description: 提供API调用、外部脚本执行能力，输出结构化审计日志 (provides external API calls + whitelisted script execution with structured audit logging)
+version: 1.1.2
+author: custom
+# 审计记录字段 (v1.0.1 起每条记录都带 phase: start|finished|error 与 seq: 1|2，
+# 便于判断一次调用的记录是否完整；旧记录无这两个字段，读取端按字段推断)
+config:
+  # API域名白名单 (API host whitelist — SSRF protection, exact host match, http/https only)
+  # 注意：只做精确字符串匹配，插件无法察觉某个条目本身就是元数据服务或内网主机。
+  # v1.1.2 因此在启动时静态分类每个条目：私有/链路本地/元数据地址与私有后缀域名会
+  # 记一条 WARN 事件 allowlist-risk（回环地址仅记 INFO，不告警），并在启动记录的
+  # allowlist 字段里列出全部发现；每次调用还会在 request.addressClass 上标记地址类别。
+  # 仅告警、不拒绝——访问内网 API 可能是合法的部署需求。
+  api_allow_hosts:
+    - api.example.com
+  # 脚本白名单目录 (script whitelist directory — bare file names only, path traversal refused;
+  # also the default working directory of the child process)
+  script_allow_dir: /opt/dsh/scripts/
+  # 脚本工作目录，留空则用 script_allow_dir (script working dir; empty → script_allow_dir)
+  script_working_dir: ""
+  # 默认超时毫秒 (timeout budget in ms; both tools, overridable per call via the `timeoutMs` arg)
+  default_timeout: 30000
+  # 单次调用超时上限 (ceiling for a per-call timeoutMs override; must be >= default_timeout)
+  max_timeout: 120000
+  # 日志单段最大字节，防止日志膨胀 (max bytes per log segment; overflow → [TRUNCATED])
+  maxReqLogSize: 2048
+  maxRespLogSize: 2048
+  maxOutputLogSize: 512
+  # 请求体上限字节：超出则零 I/O 直接拒绝 (max request BODY bytes; an oversized request is
+  # refused before any I/O — the symmetric counterpart of the response-body cap)
+  max_request_bytes: 1048576
+  # 响应体上限字节：超出则中止请求 (max response BODY bytes buffered; the live request is
+  # aborted beyond it — memory protection against a hostile endpoint)
+  max_response_bytes: 10485760
+  # 审计日志保留天数 / 单文件轮转上限 (retention days / per-file rotation budget)
+  log_retention_days: 14
+  max_log_file_size_bytes: 20971520
+  # 远端日志开关 v1.0先关闭，v1.2迭代 (remote log push — NOT implemented in v1.0;
+  # the host-log JSON lines emitted by this plugin are the v1.2 hook point)
+  enable_otel: false
+tools:
+  - call_external_api
+  - run_external_script