dotkc-openclaw 0.1.0

package/LICENSE

@@ -0,0 +1,153 @@
+                                 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.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor.
+
+   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.
+
+   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, shall any Contributor be liable
+      for 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.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,59 @@
+# dotkc OpenClaw plugin (L2)
+
+This plugin exposes **typed OpenClaw tools** for dotkc so agents can interact with dotkc via a constrained interface.
+
+Docs: https://openclaw-dotkc.hczhang.com/
+
+dotkc manual: https://dotkc.hczhang.com/
+
+## Tools
+
+- `dotkc_status` (required)
+- `dotkc_doctor` (optional)
+- `dotkc_inspect` (optional, redacted by default)
+
+## Install (dev / local path)
+
+```bash
+# from the OpenClaw host
+openclaw plugins install -l /path/to/dotkc-openclaw
+openclaw gateway restart
+```
+
+## Configure (~/.openclaw/openclaw.json)
+
+```json5
+{
+  plugins: {
+    entries: {
+      "dotkc-openclaw-plugin": {
+        enabled: true,
+        config: {
+          dotkcBin: "dotkc",
+          specFile: "./dotkc.spec",
+          // vaultPath: "/path/to/dotkc.vault",
+          // keyPath: "~/.dotkc/key",
+          allowUnsafe: false
+        }
+      }
+    }
+  },
+
+  // Allow optional plugin tools (choose a profile and then opt-in)
+  tools: {
+    // profile: "coding",
+    allow: ["dotkc"]
+  }
+}
+```
+
+## Security stance
+
+- This plugin is designed to **avoid secrets entering model context**.
+- `dotkc_inspect` uses `dotkc run --openclaw` and is expected to be **redacted**.
+- Do not enable `allowUnsafe` unless you fully understand the leakage risk.
+
+## Notes
+
+- Plugins run in-process with the OpenClaw Gateway. Treat this as trusted code.
+- This repo is an MVP skeleton; we should add tests + stricter output filtering.

package/ROADMAP.md

@@ -0,0 +1,70 @@
+# openclaw-plugin-dotkc roadmap (L2)
+
+This roadmap focuses on the **OpenClaw plugin** (typed tools + policy + safe responses).
+
+## Principles
+
+- Tools are **typed** (schema-driven), predictable, and minimal.
+- Plugin is **fail-closed** on suspected leakage.
+- Default stance: **never return secrets to the model**.
+
+## P0 — Safety guardrails
+
+### 1) Leak detection + fail-closed (in addition to redaction)
+**Goal:** even if dotkc (or an integration) accidentally emits plaintext, do not return it to the LLM.
+
+Add a detector pass on tool output before returning:
+- Block `KEY=VALUE` patterns
+- Block common token prefixes (`sk-`, `ghp_`, etc.) (configurable)
+- Block high-entropy long strings (heuristic)
+
+On match:
+- Return an error like `LEAK_BLOCKED`
+- Provide a short hint (inspect on host manually)
+
+### 2) Path restrictions
+- Ensure `specFile` is within workspace (no `~`, no `/etc/...`)
+- Reject traversal (`..`) unless explicitly allowed
+
+### 3) Config hardening
+- `allowUnsafe` should require explicit opt-in + loud warning
+- Consider a second "break glass" flag (two keys) for unsafe values
+
+## P1 — Real integration value
+
+### 4) Add `dotkc_run` tool (safe execution)
+**Goal:** replace `exec "dotkc run ..."` patterns with a constrained tool.
+
+Inputs:
+- `specFile`
+- `command[]` (argv)
+- optional `cwd`
+
+Policies:
+- Require `specFile` (no ad-hoc specs)
+- Enforce command allowlist (exact or regex)
+- Return only:
+  - `exitCode`
+  - `durationMs`
+  - `stderrTail` (capped)
+  - optionally `stdoutTail` (capped)
+
+### 5) Approvals integration
+- First time a command is run, require approval (optional mode)
+
+## P2 — Quality
+
+### 6) Tests
+- Golden tests for JSON parse
+- Failure modes for missing dotkc / bad spec file
+- Leak detector tests
+
+### 7) Better UX
+- Structured tool errors (code + hint + suggested commands)
+- Better docs examples by scenario
+
+## P3 — Distribution
+
+### 8) Publish to npm
+- `openclaw plugins install @hcz/openclaw-plugin-dotkc`
+- Versioning + release notes

package/index.ts

@@ -0,0 +1,169 @@
+import { Type } from '@sinclair/typebox';
+import { spawn } from 'node:child_process';
+
+// Prefer a stable plugin id (over package-derived ids).
+export const id = 'dotkc';
+
+function runDotkc({ dotkcBin, args, stdinText }: { dotkcBin: string; args: string[]; stdinText?: string }) {
+  return new Promise<{ code: number; out: string; err: string }>((resolve) => {
+    const p = spawn(dotkcBin, args, {
+      stdio: ['pipe', 'pipe', 'pipe'],
+      env: process.env,
+    });
+
+    let out = '';
+    let err = '';
+
+    p.stdout.on('data', (b) => (out += b.toString('utf8')));
+    p.stderr.on('data', (b) => (err += b.toString('utf8')));
+    p.on('close', (code) => resolve({ code: code ?? 1, out, err }));
+
+    if (stdinText != null) p.stdin.write(stdinText);
+    p.stdin.end();
+  });
+}
+
+function buildVaultArgs(cfg: any) {
+  const a: string[] = [];
+  if (cfg?.vaultPath) a.push('--vault', cfg.vaultPath);
+  if (cfg?.keyPath) a.push('--key', cfg.keyPath);
+  return a;
+}
+
+function tryParseOpenClawJson(text: string) {
+  // dotkc --openclaw returns a single JSON object to stdout.
+  // Be tolerant if there is trailing whitespace.
+  const t = String(text ?? '').trim();
+  if (!t) return null;
+  try {
+    return JSON.parse(t);
+  } catch {
+    return null;
+  }
+}
+
+/**
+ * Defensive redaction: keep structure, but never allow obvious value-bearing fields
+ * to pass through unless explicitly allowed.
+ *
+ * This is a best-effort guardrail. The primary guarantee should still come from:
+ * - dotkc default redaction
+ * - never enabling unsafe value output in agent workflows
+ */
+function deepRedact(value: any, { allowUnsafe }: { allowUnsafe: boolean }) {
+  if (value == null) return value;
+
+  if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') return value;
+
+  if (Array.isArray(value)) return value.map((v) => deepRedact(v, { allowUnsafe }));
+
+  const out: any = {};
+  for (const [k, v] of Object.entries(value)) {
+    const key = String(k);
+
+    const isEnvMap = key === 'env' || key === 'dotenv' || key === 'values';
+    const looksSensitiveKey = /(^|_)(value|secret|token|apikey|api_key|password)(_|$)/i.test(key);
+
+    if (!allowUnsafe && looksSensitiveKey && typeof v === 'string') {
+      out[key] = '[REDACTED_BY_PLUGIN]';
+      continue;
+    }
+
+    if (!allowUnsafe && isEnvMap && v && typeof v === 'object' && !Array.isArray(v)) {
+      const m: any = {};
+      for (const [ek, ev] of Object.entries(v as any)) {
+        m[String(ek)] = typeof ev === 'string' ? '[REDACTED_BY_PLUGIN]' : deepRedact(ev, { allowUnsafe });
+      }
+      out[key] = m;
+      continue;
+    }
+
+    out[key] = deepRedact(v, { allowUnsafe });
+  }
+  return out;
+}
+
+function toolErrorPayload({ code, error, stderr }: { code: number; error: string; stderr: string }) {
+  return {
+    ok: false,
+    code,
+    error,
+    stderr: (stderr ?? '').slice(0, 2000),
+  };
+}
+
+export default function dotkcPlugin(api: any) {
+  const cfg =
+    api?.config?.plugins?.entries?.['dotkc-openclaw-plugin']?.config ??
+    api?.config?.plugins?.entries?.dotkc?.config ??
+    api?.config?.plugins?.entries?.['dotkc']?.config;
+
+  const dotkcBin = cfg?.dotkcBin || 'dotkc';
+
+  api.registerTool({
+    name: 'dotkc_status',
+    description: 'dotkc status as OpenClaw JSON (paths + canDecrypt).',
+    parameters: Type.Object({}),
+    async execute(_id: string, _params: any) {
+      const args = ['status', '--openclaw', ...buildVaultArgs(cfg)];
+      const res = await runDotkc({ dotkcBin, args });
+      const parsed = tryParseOpenClawJson(res.out);
+      if (!parsed || parsed.format !== 'openclaw') {
+        return { content: [{ type: 'text', text: JSON.stringify(toolErrorPayload({ code: res.code, error: 'dotkc_status: failed to parse dotkc --openclaw JSON', stderr: res.err }), null, 2) }] };
+      }
+      const safe = deepRedact(parsed, { allowUnsafe: false });
+      return { content: [{ type: 'text', text: JSON.stringify(safe, null, 2) }] };
+    },
+  });
+
+  api.registerTool(
+    {
+      name: 'dotkc_doctor',
+      description: 'dotkc doctor as OpenClaw JSON diagnostics.',
+      parameters: Type.Object({}),
+      async execute(_id: string, _params: any) {
+        const args = ['doctor', '--openclaw', ...buildVaultArgs(cfg)];
+        const res = await runDotkc({ dotkcBin, args });
+        const parsed = tryParseOpenClawJson(res.out);
+        if (!parsed || parsed.format !== 'openclaw') {
+          return { content: [{ type: 'text', text: JSON.stringify(toolErrorPayload({ code: res.code, error: 'dotkc_doctor: failed to parse dotkc --openclaw JSON', stderr: res.err }), null, 2) }] };
+        }
+        const safe = deepRedact(parsed, { allowUnsafe: false });
+        return { content: [{ type: 'text', text: JSON.stringify(safe, null, 2) }] };
+      },
+    },
+    { optional: true },
+  );
+
+  api.registerTool(
+    {
+      name: 'dotkc_inspect',
+      description: 'Resolve allowlisted specs and return a redacted env preview (OpenClaw JSON).',
+      parameters: Type.Object({
+        specFile: Type.Optional(Type.String({ description: 'Path to spec allowlist file (defaults to plugin config specFile).' })),
+      }),
+      async execute(_id: string, params: any) {
+        const specFile = params?.specFile || cfg?.specFile || './dotkc.spec';
+
+        // Security posture: never allow unsafe values through this tool by default.
+        const allowUnsafe = Boolean(cfg?.allowUnsafe);
+
+        const args = ['run', '--spec-file', specFile, '--openclaw', ...buildVaultArgs(cfg)];
+        if (allowUnsafe) args.splice(1, 0, '--unsafe-values');
+
+        const res = await runDotkc({ dotkcBin, args });
+        const parsed = tryParseOpenClawJson(res.out);
+        if (!parsed || parsed.format !== 'openclaw') {
+          return { content: [{ type: 'text', text: JSON.stringify(toolErrorPayload({ code: res.code, error: 'dotkc_inspect: failed to parse dotkc --openclaw JSON', stderr: res.err }), null, 2) }] };
+        }
+
+        // Defensive redaction: even if dotkc (or a wrapper) accidentally includes cleartext values,
+        // never return suspicious value-like fields to the model unless allowUnsafe is explicitly enabled.
+        const safe = deepRedact(parsed, { allowUnsafe });
+
+        return { content: [{ type: 'text', text: JSON.stringify(safe, null, 2) }] };
+      },
+    },
+    { optional: true },
+  );
+}

package/openclaw.plugin.json

@@ -0,0 +1,41 @@
+{
+  "id": "dotkc",
+  "label": "dotkc",
+  "description": "dotkc integration: safe secrets inspection + env-injection workflows for OpenClaw",
+  "kind": "tools",
+  "configSchema": {
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "dotkcBin": { "type": "string", "default": "dotkc" },
+      "vaultPath": { "type": "string" },
+      "keyPath": { "type": "string" },
+      "specFile": { "type": "string", "default": "./dotkc.spec" },
+      "allowUnsafe": { "type": "boolean", "default": false }
+    }
+  },
+  "uiHints": {
+    "dotkcBin": { "label": "dotkc binary", "placeholder": "dotkc" },
+    "vaultPath": { "label": "Vault path (optional)", "placeholder": "/path/to/dotkc.vault" },
+    "keyPath": { "label": "Key path (optional)", "placeholder": "~/.dotkc/key", "sensitive": true },
+    "specFile": { "label": "Spec allowlist file", "placeholder": "./dotkc.spec" },
+    "allowUnsafe": { "label": "Allow unsafe values", "help": "If enabled, dotkc_inspect may return raw values. Strongly discouraged." }
+  },
+  "tools": [
+    {
+      "name": "dotkc_status",
+      "description": "dotkc status as OpenClaw JSON (paths + canDecrypt).",
+      "optional": false
+    },
+    {
+      "name": "dotkc_doctor",
+      "description": "dotkc doctor as OpenClaw JSON diagnostics.",
+      "optional": true
+    },
+    {
+      "name": "dotkc_inspect",
+      "description": "Resolve allowlisted specs and return redacted env preview (never prints values by default).",
+      "optional": true
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "dotkc-openclaw",
+  "version": "0.1.0",
+  "description": "OpenClaw plugin: dotkc integration (typed tools + safe secrets inspection)",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/steven-zhc/dotkc-openclaw.git"
+  },
+  "homepage": "https://openclaw-dotkc.hczhang.com/",
+  "type": "module",
+  "main": "index.ts",
+  "files": [
+    "index.ts",
+    "openclaw.plugin.json",
+    "README.md",
+    "LICENSE",
+    "ROADMAP.md"
+  ],
+  "openclaw": {
+    "extensions": ["./index.ts"]
+  },
+  "dependencies": {
+    "@sinclair/typebox": "^0.34.41"
+  }
+}