Files
Duy /zuey/andGitHub 4472c607b8 feat(workstation): Remote Workstation Runtime — SSH exec + security + audit (#4)
* feat(packages): add update flow for GitHub binaries (#900)

Closes #900. Proactive update-check + atomic swap for GitHub-installed
binaries on the Runtime & Packages page. Interfaces prepared for pip/npm/apk
extension in Phase 2.

- UpdateCache + UpdateRegistry + PackageLocker (ctx-aware keyed mutex)
- GitHubUpdateChecker: ETag-aware, distinct /latest vs /list ETag keys,
  semver-correct ordering via golang.org/x/mod/semver, non-semver fallback
  that refuses to downgrade, pre-release + stable candidate fusion for
  the v1.0.0-rc.1 -> v1.0.0 transition
- GitHubUpdateExecutor: two-phase .bak swap with hadBackup-aware rollback,
  manifest save retry (3x, 100ms/500ms/1s backoff), nil-safe meta access,
  explicit ScratchDir, 0755 set pre-rename
- HTTP: GET /v1/packages/updates (SWR), POST /v1/packages/updates/refresh,
  POST /v1/packages/update, POST /v1/packages/updates/apply-all
  (always 200, failed[] is error source). Master-scope gated.
- WS events package.update.{checked,started,succeeded,failed} forwarded to
  owner clients via event_filter.go
- Frontend: useUpdates hook + 3 components (summary bar, update-all modal,
  row button), master-scope-gated disabled state
- i18n: 8 backend keys + 17 frontend keys x en/vi/zh
- Config: packages.github_token (reserved), updates_check_ttl, scratch_dir
- 45+ new tests, race-clean, BenchmarkCheckAll10Packages ~1.1ms/op warm

* docs(packages): document update flow + Phase 1 completion

- packages-github.md: "Updating Installed Packages" section with UI + API
  contract, troubleshooting runbook (corrupt cache, rate-limit, scratch dir,
  mid-swap recovery)
- 17-changelog.md + CHANGELOG.md: Phase 1 entry
- 14-skills-runtime.md: cross-ref to update flow
- journal entry capturing CRIT fixes (double-write, lock-key mismatch,
  rollback false-alarm) + design wins (keyed locks, red-team pre-flight)

* feat(workstation): remote workstation runtime — SSH exec + security + audit

Adds generic Remote Workstation Runtime enabling agents to execute commands
on user-owned SSH workstations. Includes registry (DB + API + UI), SSH backend
with connection pool and circuit breaker, workstation.exec + claude_remote tools,
NFKC + binary-name allowlist security, and audit logging.

Standard edition only. Closes #941.

* fix(workstation): address 3 critical + 5 important code review findings

- C1: Add json:"-" to Metadata/DefaultEnv fields; use SanitizedView() in
  all API responses to prevent SSH private key leakage
- C2: Wire CheckEnv into PermCheckFn; LD_PRELOAD/PATH injection now blocked
- C3: SSH Setenv fallback — prepend `export K=V;` when server rejects Setenv
- I1: BackendCache sync.RWMutex → sync.Mutex (fix data race on lastUsed)
- I2: Validate metadata shape in handleUpdate before store write
- I3: Include command in exec-done event; activity sink uses actual cmd hash
- I4: Wrap pool release in sync.Once (idempotent double-call safety)
- I5: Verify workstation tenant ownership before adding permissions

* fix(packages): bypass HTTPS+IP validation in update executor tests

Test httptest servers bind to http://127.0.0.1 which fails both the
HTTPS scheme check and literal-IP SSRF guard. Add testSkipDownloadValidation
flag (same pattern as existing withTestDownloadHosts) to skip full URL
validation in test context.

* fix(workstation): address Claude review findings — tenant isolation + pool leak + dead code

- Activity list: add workstation ownership check before listing
  (prevents cross-tenant activity enumeration via known UUID)
- SSH pool: clean up p.sem + p.circuits maps in CloseWorkstation,
  prune, and Close to prevent unbounded map growth
- RPC handlers: return ErrInvalidRequest on JSON unmarshal failure
  instead of silently using zero-value params
- Remove unused containsControlChars function in normalize.go
- HTTP tests: add 10s context timeout to prevent CI package timeout

* fix(workstation): DefaultEnv JSON parse, backend cache leak, perm ownership check

- DefaultEnv: replace KEY=VALUE text parse with json.Unmarshal (stored as
  JSON by HTTP handler, was silently ignored)
- BackendCache: close losing backend on concurrent cache miss to prevent
  pruneLoop goroutine leak
- Backend interface: add Close() error method; SSHBackend delegates to
  pool.Close()
- handlePermList: add wsStore.GetByID ownership check (prevents cross-tenant
  UUID enumeration returning empty array vs 404)
- scanRows: log scan errors instead of silently skipping

* fix(workstation): wire activity sink shutdown + remove misleading comment

- WireActivitySink: capture cleanup func, register in gateway shutdown
  (was discarded → retention goroutine leaked + buffered rows lost)
- Add Stop() to WorkstationActivityStore interface (PG+SQLite already had it)
- wireWorkstationTools returns cleanup func; gateway.go defers it
- Remove misleading "re-validate env" comment in allowlist.go Check()

* ci: bump unit test timeout from 90s to 120s

hooks/handlers package (goja script tests) consumes ~85s on cold CI
runners, leaving insufficient headroom for HTTP retry tests with 1s
backoff. 120s provides adequate breathing room without masking real
deadlocks.

* fix: compile errors in integration tests + allowlist docstring

- packages_update_test: add missing lockKey arg to registry.Apply
- mcp_grant_revoke_test: remove unused fakeMCPClient struct
- allowlist.go: fix Check() docstring to match actual 3-step pipeline

* fix(test): relax mcp grant revoke assertion for pre-Phase02 state

Execute-time grant checking not yet wired — test correctly gets an
error but the message is "no active client" (nil clientPtr) rather
than "grant revoked". Accept any error as valid regression guard.

* chore: trigger CI on digitopvn/goclaw fork

* ci: retrigger workflows

* fix(permissions): classify workstation methods in RBAC policy
2026-05-11 14:58:19 +07:00

185 lines
5.6 KiB
Go

package skills
import (
"encoding/json"
"errors"
"fmt"
"os"
"path/filepath"
"sync"
"time"
)
// ErrUpdateCacheCorrupt signals that a cache file was present but unparseable.
// The loader still returns an empty cache so callers can proceed; this sentinel
// is exposed for tests and runbook tooling.
var ErrUpdateCacheCorrupt = errors.New("skills: update cache file corrupt")
// UpdateInfo describes a single available update detected by a checker.
//
// Meta holds source-specific fields without polluting the struct. For GitHub
// binaries it contains:
//
// repo string — "owner/repo"
// assetName string
// assetURL string — may be stale; re-verify host-allowlist before download
// assetSHA256 string — empty if publisher ships no checksum file
// assetSizeBytes int64
type UpdateInfo struct {
Source string `json:"source"` // "github" (Phase 1)
Name string `json:"name"` // matches GitHubPackageEntry.Name
CurrentVersion string `json:"currentVersion"` // manifest.Tag at check time
LatestVersion string `json:"latestVersion"` // candidate.tag_name
CheckedAt time.Time `json:"checkedAt"`
Meta map[string]any `json:"meta,omitempty"`
}
// UpdateCache is the on-disk aggregate of all known updates + ETag state.
// Access via LoadUpdateCache / SaveUpdateCache + the Setter/Getter methods
// which serialize through mu. Callers must NOT mutate Updates or GitHubETags
// directly under concurrent use.
type UpdateCache struct {
Updates []UpdateInfo `json:"updates"`
CheckedAt time.Time `json:"checkedAt"`
GitHubETags map[string]string `json:"githubETags"`
mu sync.Mutex `json:"-"`
}
// LoadUpdateCache reads the cache from disk. Missing file returns an empty
// cache and no error; parse failure returns an empty cache and ErrUpdateCacheCorrupt
// so the caller can decide whether to log and trigger a full refresh.
func LoadUpdateCache(path string) (*UpdateCache, error) {
c := &UpdateCache{GitHubETags: make(map[string]string)}
b, err := os.ReadFile(path)
if err != nil {
if os.IsNotExist(err) {
return c, nil
}
return c, err
}
if err := json.Unmarshal(b, c); err != nil {
return &UpdateCache{GitHubETags: make(map[string]string)}, fmt.Errorf("%w: %v", ErrUpdateCacheCorrupt, err)
}
if c.GitHubETags == nil {
c.GitHubETags = make(map[string]string)
}
return c, nil
}
// SaveUpdateCache atomically writes the cache to disk via tmp+fsync+rename.
// Pattern matches GitHubInstaller.saveManifest (file fsync for inode durability,
// rename for commit, best-effort dir fsync for ordering on ext4/XFS with
// journal-async). Callers should hold the cache mu during serialization.
func SaveUpdateCache(path string, c *UpdateCache) error {
dir := filepath.Dir(path)
if err := os.MkdirAll(dir, 0o755); err != nil {
return err
}
b, err := json.MarshalIndent(c, "", " ")
if err != nil {
return err
}
tmp := path + ".tmp"
f, err := os.OpenFile(tmp, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0o640)
if err != nil {
return err
}
if _, err := f.Write(b); err != nil {
f.Close()
os.Remove(tmp)
return err
}
if err := f.Sync(); err != nil {
f.Close()
os.Remove(tmp)
return err
}
if err := f.Close(); err != nil {
os.Remove(tmp)
return err
}
if err := os.Rename(tmp, path); err != nil {
os.Remove(tmp)
return err
}
if d, derr := os.Open(dir); derr == nil {
_ = d.Sync()
d.Close()
}
return nil
}
// SetETag stores the ETag for a cache key (typically "owner/repo" or
// "owner/repo:list"). Safe for concurrent use.
func (c *UpdateCache) SetETag(key, etag string) {
c.mu.Lock()
defer c.mu.Unlock()
if c.GitHubETags == nil {
c.GitHubETags = make(map[string]string)
}
c.GitHubETags[key] = etag
}
// GetETag returns the stored ETag for a cache key, or empty if absent.
// Safe for concurrent use.
func (c *UpdateCache) GetETag(key string) string {
c.mu.Lock()
defer c.mu.Unlock()
return c.GitHubETags[key]
}
// MergeETags applies a batch of (key, etag) pairs atomically. Used by the
// registry to merge a checker's local ETag map back into the shared cache
// after parallel checkers return (red-team fix C2 — avoids concurrent map
// writes across checker goroutines).
func (c *UpdateCache) MergeETags(batch map[string]string) {
if len(batch) == 0 {
return
}
c.mu.Lock()
defer c.mu.Unlock()
if c.GitHubETags == nil {
c.GitHubETags = make(map[string]string)
}
for k, v := range batch {
c.GitHubETags[k] = v
}
}
// ReplaceUpdates atomically swaps the Updates slice and sets CheckedAt.
// Used by the registry after all checkers return; the passed slice is
// adopted (no copy) so callers must not retain a reference.
func (c *UpdateCache) ReplaceUpdates(updates []UpdateInfo, checkedAt time.Time) {
c.mu.Lock()
defer c.mu.Unlock()
c.Updates = updates
c.CheckedAt = checkedAt
}
// Snapshot returns a shallow copy of Updates + CheckedAt. Suitable for
// read-only consumers (HTTP handler serialization).
func (c *UpdateCache) Snapshot() (updates []UpdateInfo, checkedAt time.Time) {
c.mu.Lock()
defer c.mu.Unlock()
out := make([]UpdateInfo, len(c.Updates))
copy(out, c.Updates)
return out, c.CheckedAt
}
// RemoveUpdate drops the (source, name) pair from Updates. No-op if absent.
// Called after a successful single-package update so the UI immediately
// reflects the applied state without waiting for the next refresh.
func (c *UpdateCache) RemoveUpdate(source, name string) {
c.mu.Lock()
defer c.mu.Unlock()
out := c.Updates[:0]
for _, u := range c.Updates {
if u.Source == source && u.Name == name {
continue
}
out = append(out, u)
}
c.Updates = out
}