* 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>
147 lines
3.5 KiB
Go
147 lines
3.5 KiB
Go
package docs
|
|
|
|
import (
|
|
"io/fs"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
"github.com/host-uk/core/internal/cmd/workspace"
|
|
"github.com/host-uk/core/pkg/cli"
|
|
"github.com/host-uk/core/pkg/i18n"
|
|
"github.com/host-uk/core/pkg/repos"
|
|
)
|
|
|
|
// RepoDocInfo holds documentation info for a repo
|
|
type RepoDocInfo struct {
|
|
Name string
|
|
Path string
|
|
HasDocs bool
|
|
Readme string
|
|
ClaudeMd string
|
|
Changelog string
|
|
DocsFiles []string // All files in docs/ directory (recursive)
|
|
}
|
|
|
|
func loadRegistry(registryPath string) (*repos.Registry, string, error) {
|
|
var reg *repos.Registry
|
|
var err error
|
|
var registryDir string
|
|
|
|
if registryPath != "" {
|
|
reg, err = repos.LoadRegistry(registryPath)
|
|
if err != nil {
|
|
return nil, "", cli.Wrap(err, i18n.T("i18n.fail.load", "registry"))
|
|
}
|
|
registryDir = filepath.Dir(registryPath)
|
|
} else {
|
|
registryPath, err = repos.FindRegistry()
|
|
if err == nil {
|
|
reg, err = repos.LoadRegistry(registryPath)
|
|
if err != nil {
|
|
return nil, "", cli.Wrap(err, i18n.T("i18n.fail.load", "registry"))
|
|
}
|
|
registryDir = filepath.Dir(registryPath)
|
|
} else {
|
|
cwd, _ := os.Getwd()
|
|
reg, err = repos.ScanDirectory(cwd)
|
|
if err != nil {
|
|
return nil, "", cli.Wrap(err, i18n.T("i18n.fail.scan", "directory"))
|
|
}
|
|
registryDir = cwd
|
|
}
|
|
}
|
|
|
|
// Load workspace config to respect packages_dir
|
|
wsConfig, err := workspace.LoadConfig(registryDir)
|
|
if err != nil {
|
|
return nil, "", cli.Wrap(err, i18n.T("i18n.fail.load", "workspace config"))
|
|
}
|
|
|
|
basePath := registryDir
|
|
|
|
if wsConfig != nil && wsConfig.PackagesDir != "" && wsConfig.PackagesDir != "./packages" {
|
|
pkgDir := wsConfig.PackagesDir
|
|
|
|
// Expand ~
|
|
if strings.HasPrefix(pkgDir, "~/") {
|
|
home, _ := os.UserHomeDir()
|
|
pkgDir = filepath.Join(home, pkgDir[2:])
|
|
}
|
|
|
|
if !filepath.IsAbs(pkgDir) {
|
|
pkgDir = filepath.Join(registryDir, pkgDir)
|
|
}
|
|
basePath = pkgDir
|
|
|
|
// Update repo paths if they were relative to registry
|
|
// This ensures consistency when packages_dir overrides the default
|
|
reg.BasePath = basePath
|
|
for _, repo := range reg.Repos {
|
|
repo.Path = filepath.Join(basePath, repo.Name)
|
|
}
|
|
}
|
|
|
|
return reg, basePath, nil
|
|
}
|
|
|
|
func scanRepoDocs(repo *repos.Repo) RepoDocInfo {
|
|
info := RepoDocInfo{
|
|
Name: repo.Name,
|
|
Path: repo.Path,
|
|
}
|
|
|
|
// Check for README.md
|
|
readme := filepath.Join(repo.Path, "README.md")
|
|
if _, err := os.Stat(readme); err == nil {
|
|
info.Readme = readme
|
|
info.HasDocs = true
|
|
}
|
|
|
|
// Check for CLAUDE.md
|
|
claudeMd := filepath.Join(repo.Path, "CLAUDE.md")
|
|
if _, err := os.Stat(claudeMd); err == nil {
|
|
info.ClaudeMd = claudeMd
|
|
info.HasDocs = true
|
|
}
|
|
|
|
// Check for CHANGELOG.md
|
|
changelog := filepath.Join(repo.Path, "CHANGELOG.md")
|
|
if _, err := os.Stat(changelog); err == nil {
|
|
info.Changelog = changelog
|
|
info.HasDocs = true
|
|
}
|
|
|
|
// Recursively scan docs/ directory for .md files
|
|
docsDir := filepath.Join(repo.Path, "docs")
|
|
if _, err := os.Stat(docsDir); err == nil {
|
|
filepath.WalkDir(docsDir, func(path string, d fs.DirEntry, err error) error {
|
|
if err != nil {
|
|
return nil
|
|
}
|
|
// Skip plans/ directory
|
|
if d.IsDir() && d.Name() == "plans" {
|
|
return filepath.SkipDir
|
|
}
|
|
// Skip non-markdown files
|
|
if d.IsDir() || !strings.HasSuffix(d.Name(), ".md") {
|
|
return nil
|
|
}
|
|
// Get relative path from docs/
|
|
relPath, _ := filepath.Rel(docsDir, path)
|
|
info.DocsFiles = append(info.DocsFiles, relPath)
|
|
info.HasDocs = true
|
|
return nil
|
|
})
|
|
}
|
|
|
|
return info
|
|
}
|
|
|
|
func copyFile(src, dst string) error {
|
|
data, err := os.ReadFile(src)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return os.WriteFile(dst, data, 0644)
|
|
}
|