dreampiler/kandev
1
0
Fork 0
Code Issues 43 Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
2bd2bae2ea7c25ba2beec6bf31a0509dbe96194c
kandev/docs/plans/plugins/task-02-store.md
T
João Salavisa e145d48f22 feat: add plugin system with grpc runtime and native ui plugins (#1742) 
* feat: add plugin system with grpc runtime and native ui plugins

- go plugin backends ship as release tarballs (per-platform binaries, checksums) that
  kandev installs from url/upload or filesystem sideload+sync, then spawns and
  supervises via hashicorp/go-plugin (unix socket / loopback tcp+automtls)
- strict typed grpc contract (kandev.plugin.v1): DeliverEvent/InvokeTool/HandleWebhook
  plus a capability-gated host service (state, secrets, emit); author sdk in
  pkg/pluginsdk; packaging cli in cmd/plugin-pack
- native frontend bundles: window.registerKandevPlugin + registry/host loader with
  dynamic routes, nav items, slots and ws handlers; plugins settings page with
  install dialog, sync button and enable/disable/uninstall
- gated behind the plugins feature flag (prod off, dev/e2e on); covered by unit and
  integration tests plus playwright e2e against a real packaged fixture plugin

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix(plugins): hydrate base app context on plugin routes

Plugin-owned SPA routes classify as RouteUnknown, so the boot payload shipped
only feature flags — no workspaces, workflows, or kanban context. Native plugin
UI (e.g. host.ui.TaskCreateDialog) then had an empty store. Hydrate the same
base context as the Home route for unknown SPA routes.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* feat(plugins): expose TaskCreateDialog on host.ui

Lets a native plugin open kandev's real create-task modal (prefilled via
initialValues) instead of POSTing directly.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix(plugins): harden filesystem/URL sinks against CodeQL findings

Add sink-level guards on the plugin trust boundary: securejoin containment on
archive extraction (zip-slip), plugin-id validation before every fs_store path,
http/https scheme validation on install-from-URL, and non-interpolated ws-handler
error logging.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix(plugins): address review findings (races, resource caps, lifecycle)

- serialize per-plugin startup to close a TOCTOU double-spawn race, and let a
  plugin restart after exhausting attempts
- bound plugin startup with an explicit 30s timeout
- reject backslash paths and cap decompressed bytes by actual size in pkgtar;
  only mark a package Signed when a verifier actually ran and passed
- delete plugin_state on uninstall; validate webhook keys against the manifest
  and cap webhook body size; restart an active plugin when a new version installs

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix(plugins): sanitize plugin-id path sinks for CodeQL

Pin the plugin id to a single path segment with filepath.Base at recordPath/
configPath and pkgtar.Remove — a barrier the taint analysis recognizes.
Behaviour-identical for valid ids (already validated by safePluginID); clears
the go/path-injection alerts.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix(plugins): inline plugin-id validation at path sinks for CodeQL

filepath.Base does not strip '..', so it is not a path-injection barrier. Call
the recognized safePluginID / id-pattern guard inline in Delete/GetConfig/
SetConfig and pkgtar.Remove — the same barrier that already cleared the Get sink.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix(plugins): address code-review findings (backend)

- add capability-gating tests for the Host RPC service (was untested)
- close a stop-during-start orphan race so Disable/Uninstall can't leave a
  supervised subprocess behind
- on failed upgrade, remove only the new version dir (not all versions + data);
  restart the prior version
- validate manifest version and reject ids ending in .config (record-file alias)
- make Deliverer.Refresh non-blocking and cancel in-flight delivery on worker stop
- clamp out-of-range webhook status, skip-and-warn corrupt records in List,
  write records atomically, semver-aware sideload version pick

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix(plugins): address code-review findings (frontend)

- wrap plugin routes + settings routes in a shared PluginErrorBoundary so a
  throwing plugin page shows a fallback instead of white-screening the SPA
- fix disable/re-enable in one session: keep the cached registration and
  re-run initialize instead of relying on a cached ES-module re-import
- prefix root-relative bundle/style URLs with apiBaseUrl (split-origin/Tauri)
- surface partial-install warnings via toast.warning instead of a bare success
- dedupe/remove injected style links on unload; gate PluginNavItems on the flag

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix(plugins): serialize per-plugin lifecycle + guard config writes

- add a per-plugin keyed lock in Service so concurrent Enable/Disable/Install/
  Uninstall/UpdateConfig for one id are serialized (no status-machine race)
- take s.mu in SetConfig/GetConfig and write config atomically
- bound each plugin initialize() with a timeout so one hung bundle can't stall
  the rest of the boot load

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* test(plugins): split service_test.go to satisfy file-length lint

Move the install/URL test group into service_install_test.go; no logic change.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* ci: build and ship the e2e fixture plugin package to E2E shards

The plugin E2E specs' global-setup requires apps/backend/.build/kandev-plugin-e2e-1.0.0.tar.gz.
Build it in the E2E build job, upload it as an artifact, and download it in both
the regular and container shard jobs.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

---------

Co-authored-by: Kandev Agent <agent@kandev.dev>
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-07-17 12:00:26 +01:00

2.9 KiB
Raw Blame History

id, title, status, wave, depends_on, plan
id title status wave depends_on plan
task-02 Filesystem registration store + credentials done 1
task-01
docs/plans/plugins/plan.md

Filesystem registration store + credentials

Title

Persist plugin registrations to ~/.kandev/plugins/{id}.yml with a bcrypt-hashed api_key and an encrypted (recoverable) webhook secret, plus operator config at {id}.config.yml.

Inputs

  • Spec docs/specs/plugins/spec.md → "Plugin registration (filesystem-backed)" and "Persistence guarantees".
  • Credential storage refinement (resolves a spec inconsistency — capture in the task-15 spec update):
    • api_key: kandev only ever verifies inbound requests → store as bcrypt hash only. Cleartext returned once at registration.
    • webhook_secret: kandev must HMAC-sign outbound event deliveries → bcrypt (one-way) is impossible. Store the secret in the encrypted secrets store (internal/secrets via internal/integrations/secretadapter.Adapter, which is reversible via Reveal). The {id}.yml keeps only a secret reference id, not the value. Cleartext returned once at registration.
  • Uses Manifest from task-01 (import internal/plugins/manifest).
  • bcrypt: golang.org/x/crypto/bcrypt. Secret adapter interface: inject a small interface SecretVault { Set(ctx,id,name,value) error; Reveal(ctx,id) (string,error); Delete(ctx,id) error } so the store is testable with a fake (the real one is secretadapter.Adapter).

Acceptance

  1. Record struct = manifest + runtime fields (status, api_key_hash, webhook_secret_ref, registered_at, last_health_check).
  2. store.Store interface: List, Get(id), Save(*Record), Delete(id), GetConfig(id), SetConfig(id, map).
  3. NewFSStore(dir string, vault SecretVault); Register(ctx, manifest) (*Record, Credentials, error) generates random api_key+webhook_secret (crypto/rand), bcrypt-hashes the api_key, stores the webhook_secret in the vault under ref plugin-webhook-secret:{id}, writes {id}.yml, returns cleartext Credentials{APIKey, WebhookSecret} once.
  4. VerifyAPIKey(id, key) (bool, error) (bcrypt compare); RevealWebhookSecret(ctx, id) (string, error) (vault Reveal).
  5. Duplicate id on Register → typed ErrAlreadyExists. Delete also deletes the vault secret.

Files

  • apps/backend/internal/plugins/store/store.go
  • apps/backend/internal/plugins/store/fs_store.go
  • apps/backend/internal/plugins/store/fs_store_test.go (t.TempDir() + fake vault)

Verification

  • go test ./internal/plugins/store/... from apps/backend
  • make -C apps/backend lint

Output contract

Report: file format, the api_key(bcrypt)/webhook_secret(encrypted-ref) split, the SecretVault interface shape (so task-05/06 can reveal the secret for signing). Do not edit internal/plugins/manifest/ (import only). Stay within internal/plugins/store/.

Dependencies

task-01 (imports manifest types).

Reference in New Issue View Git Blame Copy Permalink