cli/internal/cmd/updater/docs/configuration.md
Snider 3365bfd5ba
feat(mcp): add workspace root validation to prevent path traversal (#100)
* feat(mcp): add workspace root validation to prevent path traversal

- Add workspaceRoot field to Service for restricting file operations
- Add WithWorkspaceRoot() option for configuring the workspace directory
- Add validatePath() helper to check paths are within workspace
- Apply validation to all file operation handlers
- Default to current working directory for security
- Add comprehensive tests for path validation

Closes #82

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor: move CLI commands from pkg/ to internal/cmd/

- Move 18 CLI command packages to internal/cmd/ (not externally importable)
- Keep 16 library packages in pkg/ (externally importable)
- Update all import paths throughout codebase
- Cleaner separation between CLI logic and reusable libraries

CLI commands moved: ai, ci, dev, docs, doctor, gitcmd, go, monitor,
php, pkgcmd, qa, sdk, security, setup, test, updater, vm, workspace

Libraries remaining: agentic, build, cache, cli, container, devops,
errors, framework, git, i18n, io, log, mcp, process, release, repos

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor(mcp): use pkg/io Medium for sandboxed file operations

Replace manual path validation with pkg/io.Medium for all file operations.
This delegates security (path traversal, symlink bypass) to the sandboxed
local.Medium implementation.

Changes:
- Add io.NewSandboxed() for creating sandboxed Medium instances
- Refactor MCP Service to use io.Medium instead of direct os.* calls
- Remove validatePath and resolvePathWithSymlinks functions
- Update tests to verify Medium-based behaviour

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: correct import path and workflow references

- Fix pkg/io/io.go import from core-gui to core
- Update CI workflows to use internal/cmd/updater path

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(security): address CodeRabbit review issues for path validation

- pkg/io/local: add symlink resolution and boundary-aware containment
  - Reject absolute paths in sandboxed Medium
  - Use filepath.EvalSymlinks to prevent symlink bypass attacks
  - Fix prefix check to prevent /tmp/root matching /tmp/root2

- pkg/mcp: fix resolvePath to validate and return errors
  - Changed resolvePath from (string) to (string, error)
  - Update deleteFile, renameFile, listDirectory, fileExists to handle errors
  - Changed New() to return (*Service, error) instead of *Service
  - Properly propagate option errors instead of silently discarding

- pkg/io: wrap errors with E() helper for consistent context
  - Copy() and MockMedium.Read() now use coreerr.E()

- tests: rename to use _Good/_Bad/_Ugly suffixes per coding guidelines
  - Fix hardcoded /tmp in TestPath to use t.TempDir()
  - Add TestResolvePath_Bad_SymlinkTraversal test

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* style: fix gofmt formatting

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* style: fix gofmt formatting across all files

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-01 21:59:34 +00:00

1.9 KiB

Configuration

The updater library is highly configurable via the UpdateServiceConfig struct.

UpdateServiceConfig

When creating a new UpdateService, you pass a UpdateServiceConfig struct. Here are the available fields:

Field Type Description
RepoURL string The URL to the repository for updates. Can be a GitHub repository URL (e.g., https://github.com/owner/repo) or a base URL for a generic HTTP update server.
Channel string Specifies the release channel to track (e.g., "stable", "prerelease"). This is only used for GitHub-based updates.
CheckOnStartup StartupCheckMode Determines the behavior when the service starts. See Startup Modes below.
ForceSemVerPrefix bool Toggles whether to enforce a 'v' prefix on version tags for display and comparison. If true, a 'v' prefix is added if missing.
ReleaseURLFormat string A template for constructing the download URL for a release asset. The placeholder {tag} will be replaced with the release tag.

Startup Modes

The CheckOnStartup field can take one of the following values:

  • updater.NoCheck: Disables any checks on startup.
  • updater.CheckOnStartup: Checks for updates on startup but does not apply them.
  • updater.CheckAndUpdateOnStartup: Checks for and applies updates on startup.

CLI Flags

If you are using the example CLI provided in cmd/updater, the following flags are available:

  • --check-update: Check for new updates without applying them.
  • --do-update: Perform an update if available.
  • --channel: Set the update channel (e.g., stable, beta, alpha). If not set, it's determined from the current version tag.
  • --force-semver-prefix: Force 'v' prefix on semver tags (default true).
  • --release-url-format: A URL format for release assets.
  • --pull-request: Update to a specific pull request (integer ID).