Compare commits

...
Author SHA1 Message Date
clawdbot e2e91e1ab0 docs: add CHANGELOG for v0.1.3 release 2026-10-12 22:06:23 +00:00
黄云龙 86428abce6 refactor(runtime): make the permission privilege ladder an explicit rank (#3303)
* fix(runtime): prompt permission mode never invokes the prompter

PermissionMode derives Ord from declaration order, placing Prompt (and Allow)
above the real privilege ladder (ReadOnly < WorkspaceWrite < DangerFullAccess).
In PermissionPolicy::authorize_with_context the ladder check
'current_mode >= required_mode' therefore evaluates true for every tool when the
active mode is Prompt (3 >= {0,1,2}), returning Allow and making the subsequent
'if current_mode == PermissionMode::Prompt' branch that routes to prompt_or_deny
unreachable.

Effect: a session configured with the 'prompt' permission mode silently
auto-allows every tool and never calls the prompter (reached via
ConversationRuntime::run_turn with an interactive prompter), defeating the mode's
entire purpose. The sibling PermissionEnforcer already special-cases Prompt
before its own 'active_mode >= required_mode' check, confirming Prompt is not
meant to be part of the ordered ladder.

Fix: exclude Prompt from the ordered-ladder comparison so Prompt mode falls
through to the interactive prompt path. Allow remains handled by its explicit
equality check. The same comparison appears twice in authorize_with_context —
once in the shared tail and once inside the 'Some(PermissionOverride::Allow)'
arm, which is reached when a hook emits permissionDecision "allow" — so both
copies carry the guard; guarding only the tail still left a hook able to
auto-allow every tool in Prompt mode without ever consulting the prompter.

Adds regression tests covering Prompt mode with a prompter, without a prompter,
and with a hook allow override.

* refactor(runtime): make the permission privilege ladder an explicit rank

`PermissionMode` derived `PartialOrd`/`Ord`, so the ladder deciding whether a
tool runs without asking was declaration order. A variant inserted in the middle
of the enum re-ranked it silently, and the difference between "this tool may
run" and "this tool may run after a prompt" was a property of where an `enum`
line happened to sit. That is how `Prompt` came to outrank `DangerFullAccess`,
satisfy `current_mode >= required_mode` for every tool, and skip the prompter.

Replace the derive with `privilege_rank`, an exhaustive `match` naming every
variant, so inserting one is a build failure rather than a silent re-ranking.
`Ord` is deliberately not derived, so a stray `>=` on two modes no longer
compiles; the two comparisons outside this module now say which rank they read
(`PermissionEnforcer::check_with_required_mode` and the `claw doctor` permission
check). Both keep their previous answers, since `privilege_rank` reproduces the
old declaration order exactly, including `Prompt` and `Allow` above the tiers.

`Prompt` and `Allow` are modes of operation, not privilege tiers, so they are
never ranked *against* a tool requirement. The new `covers` predicate states
that by name rather than by number: `Allow` always covers, `Prompt` never does
(it asks), and only the three tiers compare ranks.

That also collapses the duplicated ladder in `authorize_with_context`. The
`Some(PermissionOverride::Allow)` arm carried a second, identical copy of the
ask-rule check and the ladder; it now falls through to the single copy below,
so a hook `allow` is an override rather than a bypass and the two copies can no
longer drift apart.

Behaviour is unchanged for every (mode, requirement, rule, override)
combination. The tests pin the `Prompt` routes — plain and hook-`allow` — across
all three tiers, plus the rank ordering itself.
2026-10-13 07:04:44 +09:00
gaebal-gajae 1b1fba48fc Merge pull request #3269 from nankingjing/docs/correct-rust-crate-count
docs: correct rust workspace crate count to 11

This updates the documentation to reflect the actual number of crates in the
rust workspace, which is 11, not 9. The workspace contains:
- api
- claw-analog
- claw-rag-service
- commands
- compat-harness
- mock-anthropic-service
- plugins
- runtime
- rusty-claude-cli
- telemetry
- tools
2026-10-12 22:03:21 +00:00
gaebal-gajae 794254597c Fix untrusted project hooks in read-only mode 2026-10-12 22:02:05 +00:00
Bellman cc58238e43 Merge pull request #3273 from nankingjing/fix-duplicate-assistant-text-3258
fix(cli): stop reprinting streamed assistant text after 'Done' in non-compact text mode
2026-10-12 05:40:00 +09:00
Bellman 16ce599ef0 Merge pull request #3286 from SulimanAbdulrazzaq/fix/3278-windows-workspace-path
fix(runtime): normalize Windows workspace paths
2026-10-12 05:38:29 +09:00
Bellman b05aeee652 Merge pull request #3243 from mlzoo/fix/session-store-path-traversal
fix: prevent path traversal via session_id in session_store
2026-10-12 05:36:57 +09:00
gaebal-gajae 811403286b test(cli): assert streamed response is emitted once 2026-10-11 20:35:09 +00:00
mlliuz 102bc5ef79 fix: prevent path traversal via session_id in session_store
load_session/save_session built the session file path directly from the
caller-supplied session_id with no validation, so a value like
'../../../tmp/secrets' (reachable from the 'load-session' CLI subcommand)
could read or write JSON files outside the session directory.

Add _validate_session_id() to reject anything outside [A-Za-z0-9_-]
(path separators, '..', absolute/Windows paths) before the id is used to
build a filename. Legitimate ids (uuid4 hex, 'session-<digits>-<n>') are
unaffected.

Adds SessionStorePathTraversalTests covering traversal rejection on both
load and save plus a legitimate-id round-trip.
2026-10-11 20:31:56 +00:00
Suliman Abdulrazzaq dc346498fb fix(runtime): accept other Windows spellings of a workspace path
validate_workspace_boundary compared paths lexically, so a location inside
the workspace spelled with different letter case (a working directory typed
as c:\users\... for C:\Users\...) or through the \\.\ device namespace was
reported as escaping the workspace.

When the lexical comparison fails, compare the path's canonical form before
reporting an escape. A path whose canonical form is outside the workspace
stays rejected.
2026-09-18 12:03:14 +03:00
Suliman Abdulrazzaq dbf5389729 test(runtime): gate the Windows extended-path boundary test to Windows
accepts_equivalent_extended_path_at_workspace_boundary builds its paths
with backslash separators. Backslashes only separate path components on
Windows, so on Linux each path is a single component, the boundary check
rejects the path, and cargo test fails.

Run the test only on Windows, and call validate_workspace_boundary through
super:: so non-Windows test builds do not warn about an unused import.
2026-09-17 13:15:05 +00:00
Suliman Abdulrazzaq 9e7fd601a5 fix(runtime): normalize Windows workspace paths
Keep extended-length and regular Windows paths comparable when enforcing workspace boundaries, including first-run roots that cannot yet be canonicalized. Add regression coverage for DOS and UNC path forms.

Signed-off-by: Suliman Abdulrazzaq <suliman9000a@gmail.com>
2026-08-09 15:14:37 +03:00
nankingjing 971d350e53 fix(cli): preserve retried streamed response tail 2026-07-14 01:18:47 +00:00
黄云龙 1a66da4eb3 fix(cli): stop reprinting streamed assistant text after 'Done' 2026-07-11 17:45:50 +08:00
黄云龙 8613b7065a docs: correct rust workspace crate count to 11 2026-07-10 22:47:51 +08:00
11 changed files with 685 additions and 116 deletions
+47
View File
@@ -0,0 +1,47 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [0.1.3] - 2026-10-13
This is the first public binary release of Claw Code.
### Added
- Initial binary release for Linux x64, macOS arm64, and Windows x64
- Full CLI implementation with session persistence and MCP support
- Multi-provider support: Anthropic Claude, OpenAI, X.AI Grok, and OpenAI-compatible providers (Ollama, llama.cpp, vLLM)
- 55 built-in tools: Bash, file I/O, editing, search, web access, agent delegation, and more
- 120+ slash commands for configuration, help, and system operations
- Permission system with support for workspace-write, read-only, and prompt-mode enforcement
- Plugin system with manifest-driven plugin installation and management
- Comprehensive session management with configuration loading and persistence
- Dogfood build with build-time git provenance tracking
### Fixed
- Fixed duplicate assistant text in message rendering
- Fixed Windows workspace path compatibility (support for multiple Windows path spellings)
- Fixed session_id path traversal vulnerability in session store
- Fixed untrusted project hooks in read-only mode
- Fixed permission privilege ladder to use explicit rank ordering
- Fixed Windows extended-path boundary handling
- Fixed output ownership reporting on auto-compact retry paths
### Changed
- Reorganized permission system for improved clarity and consistency
- Enhanced configuration system to support persistent provider configuration
- Improved error handling and reporting throughout the runtime
### Known Limitations
- ACP / Zed integration is not yet implemented (status stub available via `claw acp`)
- Python porting workspace is for reference only, not used in production
## Pre-release
This project has been in development as an agent-managed exhibit. Previous work is tracked in git history.
+1 -1
View File
@@ -221,7 +221,7 @@ rust/
## Stats
- **~20K lines** of Rust
- **9 crates** in workspace
- **11 crates** in workspace
- **Binary name:** `claw`
- **Default model:** `claude-opus-4-7`
- **Default permissions:** `workspace-write`
+133 -53
View File
@@ -466,31 +466,39 @@ impl ConfigLoader {
let mut merged = BTreeMap::new();
let mut loaded_entries = Vec::new();
let mut mcp = McpConfigCollection::default();
let mut all_warnings = Vec::new();
let mut all_warnings: Vec<String> = Vec::new();
for entry in self.discover() {
crate::config_validate::check_unsupported_format(&entry.path)?;
let OptionalConfigFile::Loaded(parsed) = read_optional_json_object(&entry.path)? else {
continue;
};
let validation = crate::config_validate::validate_config_file(
&parsed.object,
&parsed.source,
&entry.path,
);
let ParsedConfigFile { mut object, source } = parsed;
if let Some(warning) =
strip_untrusted_project_hooks(entry.source, &mut object, &entry.path)
{
all_warnings.push(warning);
}
let validation =
crate::config_validate::validate_config_file(&object, &source, &entry.path);
if !validation.is_ok() {
let first_error = &validation.errors[0];
return Err(ConfigError::Parse(first_error.to_string()));
}
all_warnings.extend(validation.warnings);
validate_optional_hooks_config(&parsed.object, &entry.path)?;
merge_mcp_servers(&mut mcp, entry.source, &parsed.object, &entry.path)?;
deep_merge_objects(&mut merged, &parsed.object);
all_warnings.extend(
validation
.warnings
.into_iter()
.map(|warning| warning.to_string()),
);
validate_optional_hooks_config(&object, &entry.path)?;
merge_mcp_servers(&mut mcp, entry.source, &object, &entry.path)?;
deep_merge_objects(&mut merged, &object);
loaded_entries.push(entry);
}
for warning in &all_warnings {
emit_config_warning_once(&warning.to_string());
emit_config_warning_once(warning);
}
build_runtime_config(merged, loaded_entries, mcp)
@@ -512,19 +520,22 @@ impl ConfigLoader {
let OptionalConfigFile::Loaded(parsed) = read_optional_json_object(&entry.path)? else {
continue;
};
let validation = crate::config_validate::validate_config_file(
&parsed.object,
&parsed.source,
&entry.path,
);
let ParsedConfigFile { mut object, source } = parsed;
if let Some(warning) =
strip_untrusted_project_hooks(entry.source, &mut object, &entry.path)
{
all_warnings.push(warning);
}
let validation =
crate::config_validate::validate_config_file(&object, &source, &entry.path);
if !validation.is_ok() {
let first_error = &validation.errors[0];
return Err(ConfigError::Parse(first_error.to_string()));
}
all_warnings.extend(validation.warnings.iter().map(|w| w.to_string()));
validate_optional_hooks_config(&parsed.object, &entry.path)?;
merge_mcp_servers(&mut mcp, entry.source, &parsed.object, &entry.path)?;
deep_merge_objects(&mut merged, &parsed.object);
validate_optional_hooks_config(&object, &entry.path)?;
merge_mcp_servers(&mut mcp, entry.source, &object, &entry.path)?;
deep_merge_objects(&mut merged, &object);
loaded_entries.push(entry);
}
@@ -589,11 +600,14 @@ impl ConfigLoader {
}
};
let validation = crate::config_validate::validate_config_file(
&parsed.object,
&parsed.source,
&entry.path,
);
let ParsedConfigFile { mut object, source } = parsed;
if let Some(warning) =
strip_untrusted_project_hooks(entry.source, &mut object, &entry.path)
{
warnings.push(warning);
}
let validation =
crate::config_validate::validate_config_file(&object, &source, &entry.path);
if !validation.is_ok() {
let detail = validation.errors[0].to_string();
load_error.get_or_insert_with(|| detail.clone());
@@ -612,7 +626,7 @@ impl ConfigLoader {
.map(|warning| warning.to_string()),
);
if let Err(error) = validate_optional_hooks_config(&parsed.object, &entry.path) {
if let Err(error) = validate_optional_hooks_config(&object, &entry.path) {
let detail = error.to_string();
load_error.get_or_insert_with(|| detail.clone());
files.push(ConfigFileReport::load_error(
@@ -624,9 +638,7 @@ impl ConfigLoader {
continue;
}
if let Err(error) =
merge_mcp_servers(&mut mcp, entry.source, &parsed.object, &entry.path)
{
if let Err(error) = merge_mcp_servers(&mut mcp, entry.source, &object, &entry.path) {
let detail = error.to_string();
load_error.get_or_insert_with(|| detail.clone());
files.push(ConfigFileReport::load_error(
@@ -638,8 +650,8 @@ impl ConfigLoader {
continue;
}
let key_paths = collect_config_key_paths(&parsed.object);
deep_merge_objects(&mut merged, &parsed.object);
let key_paths = collect_config_key_paths(&object);
deep_merge_objects(&mut merged, &object);
loaded_entries.push(entry.clone());
files.push(ConfigFileReport::loaded(entry, precedence_rank, key_paths));
}
@@ -663,6 +675,23 @@ impl ConfigLoader {
}
}
fn strip_untrusted_project_hooks(
source: ConfigSource,
object: &mut BTreeMap<String, JsonValue>,
path: &Path,
) -> Option<String> {
// Project settings come from the repository and there is no project-hook
// trust approval flow yet. User and local settings remain eligible.
if source == ConfigSource::Project && object.remove("hooks").is_some() {
Some(format!(
"Ignoring project hooks in {} because project-hook trust approval is not supported.",
path.display()
))
} else {
None
}
}
impl ConfigFileReport {
fn loaded(entry: ConfigEntry, precedence_rank: usize, key_paths: Vec<String>) -> Self {
Self {
@@ -2590,6 +2619,7 @@ mod tests {
};
use crate::json::JsonValue;
use crate::sandbox::FilesystemIsolationMode;
use crate::HookRunner;
use std::fs;
use std::time::{SystemTime, UNIX_EPOCH};
@@ -2695,17 +2725,14 @@ mod tests {
.and_then(JsonValue::as_object)
.expect("hooks object")
.contains_key("PreToolUse"));
assert!(loaded
assert!(!loaded
.get("hooks")
.and_then(JsonValue::as_object)
.expect("hooks object")
.contains_key("PostToolUse"));
assert_eq!(loaded.hooks().pre_tool_use(), &["base".to_string()]);
assert_eq!(loaded.hooks().post_tool_use(), &["project".to_string()]);
assert_eq!(
loaded.hooks().post_tool_use_failure(),
&["project-failure".to_string()]
);
assert!(loaded.hooks().post_tool_use().is_empty());
assert!(loaded.hooks().post_tool_use_failure().is_empty());
assert_eq!(loaded.permission_rules().allow(), &["Read".to_string()]);
assert_eq!(
loaded.permission_rules().deny(),
@@ -2718,6 +2745,73 @@ mod tests {
fs::remove_dir_all(root).expect("cleanup temp dir");
}
#[test]
fn project_config_hooks_cannot_execute_commands() {
let root = temp_dir();
let cwd = root.join("project");
let home = root.join("home").join(".claw");
let project_settings = cwd.join(".claw").join("settings.json");
let project_legacy_settings = cwd.join(".claw.json");
let marker = root.join("project-hook-executed");
fs::create_dir_all(project_settings.parent().expect("project config dir"))
.expect("create project config dir");
fs::create_dir_all(&home).expect("home config dir");
let command = format!("echo compromised >> {}", marker.display());
fs::write(
&project_legacy_settings,
format!(r#"{{"hooks":{{"PreToolUse":["{command}"]}}}}"#),
)
.expect("write untrusted legacy project hook");
fs::write(
&project_settings,
format!(r#"{{"hooks":{{"PreToolUse":["{command}"]}}}}"#),
)
.expect("write untrusted project hook");
let loader = ConfigLoader::new(&cwd, &home);
let loaded = loader.load().expect("config should load");
let _ =
HookRunner::from_feature_config(loaded.feature_config()).run_pre_tool_use("Read", "{}");
let hook_executed = marker.exists();
if hook_executed {
fs::remove_file(&marker).expect("remove hook marker");
}
assert!(
!hook_executed,
"untrusted project hook executed arbitrary shell command"
);
let (collected, warnings) = loader
.load_collecting_warnings()
.expect("collecting config should load");
assert!(collected.hooks().pre_tool_use().is_empty());
assert_eq!(
warnings
.iter()
.filter(|warning| warning.contains("Ignoring project hooks"))
.count(),
2
);
let inspected = loader.inspect_collecting_warnings();
assert_eq!(
inspected
.warnings
.iter()
.filter(|warning| warning.contains("Ignoring project hooks"))
.count(),
2
);
assert!(inspected
.runtime_config
.expect("inspection should produce runtime config")
.hooks()
.pre_tool_use()
.is_empty());
fs::remove_dir_all(root).expect("cleanup temp dir");
}
#[test]
fn parses_object_style_hook_entries_with_matchers() {
let root = temp_dir();
@@ -3523,7 +3617,7 @@ mod tests {
}
#[test]
fn loads_valid_hook_entries_and_records_invalid_siblings_441() {
fn ignores_project_hook_entries_and_keeps_user_hooks_441() {
// given
let root = temp_dir();
let cwd = root.join("project");
@@ -3547,22 +3641,8 @@ mod tests {
.load()
.expect("config should load valid hook entries and record invalid siblings");
// #106: arrays now concatenate across config layers, so both "base" and "project" are present
assert_eq!(
loaded.hooks().pre_tool_use(),
&["base".to_string(), "project".to_string()]
);
assert_eq!(loaded.hooks().invalid_count(), 1);
assert_eq!(loaded.hooks().invalid_hooks()[0].event, "PreToolUse");
assert_eq!(
loaded.hooks().invalid_hooks()[0].kind,
"invalid_hooks_config"
);
// #106: invalid entry at index 2 after array concatenation
assert_eq!(loaded.hooks().invalid_hooks()[0].index, Some(2));
assert!(loaded.hooks().invalid_hooks()[0]
.reason
.contains("must be a string or hook object"));
assert_eq!(loaded.hooks().pre_tool_use(), &["base".to_string()]);
assert!(loaded.hooks().invalid_hooks().is_empty());
fs::remove_dir_all(root).expect("cleanup temp dir");
}
+83 -2
View File
@@ -10,7 +10,7 @@ use crate::compact::{
use crate::config::RuntimeFeatureConfig;
use crate::hooks::{HookAbortSignal, HookProgressReporter, HookRunResult, HookRunner};
use crate::permissions::{
PermissionContext, PermissionOutcome, PermissionPolicy, PermissionPrompter,
PermissionContext, PermissionMode, PermissionOutcome, PermissionPolicy, PermissionPrompter,
};
use crate::session::{ContentBlock, ConversationMessage, Session};
use crate::usage::{TokenUsage, UsageTracker};
@@ -176,6 +176,11 @@ where
feature_config: &RuntimeFeatureConfig,
) -> Self {
let usage_tracker = UsageTracker::from_session(&session);
let hook_runner = if permission_policy.active_mode() == PermissionMode::ReadOnly {
HookRunner::default()
} else {
HookRunner::from_feature_config(feature_config)
};
Self {
session,
api_client,
@@ -184,7 +189,7 @@ where
system_prompt,
max_iterations: usize::MAX,
usage_tracker,
hook_runner: HookRunner::from_feature_config(feature_config),
hook_runner,
auto_compaction_input_tokens_threshold: auto_compaction_threshold_from_env(),
hook_abort_signal: HookAbortSignal::default(),
hook_progress_reporter: None,
@@ -991,6 +996,82 @@ mod tests {
));
}
#[test]
fn read_only_mode_does_not_execute_hooks() {
struct SingleCallApiClient {
calls: usize,
}
impl ApiClient for SingleCallApiClient {
fn stream(
&mut self,
_request: ApiRequest,
) -> Result<Vec<AssistantEvent>, RuntimeError> {
self.calls += 1;
if self.calls == 1 {
Ok(vec![
AssistantEvent::ToolUse {
id: "tool-1".to_string(),
name: "Read".to_string(),
input: "{}".to_string(),
},
AssistantEvent::ToolUse {
id: "tool-2".to_string(),
name: "ReadError".to_string(),
input: "{}".to_string(),
},
AssistantEvent::MessageStop,
])
} else {
Ok(vec![
AssistantEvent::TextDelta("done".to_string()),
AssistantEvent::MessageStop,
])
}
}
}
let nanos = SystemTime::now()
.duration_since(UNIX_EPOCH)
.expect("system time should be after epoch")
.as_nanos();
let marker = std::env::temp_dir().join(format!(
"claw-read-only-hook-{}-{nanos}",
std::process::id()
));
let hook_command = format!("echo compromised >> \"{}\"", marker.display());
let features = RuntimeFeatureConfig::default().with_hooks(RuntimeHookConfig::new(
vec![shell_snippet(&hook_command)],
vec![shell_snippet(&hook_command)],
vec![shell_snippet(&hook_command)],
));
let mut runtime = ConversationRuntime::new_with_features(
Session::new(),
SingleCallApiClient { calls: 0 },
StaticToolExecutor::new()
.register("Read", |_input| Ok("read result".to_string()))
.register("ReadError", |_input| Err(ToolError::new("read failed"))),
PermissionPolicy::new(PermissionMode::ReadOnly)
.with_tool_requirement("Read", PermissionMode::ReadOnly)
.with_tool_requirement("ReadError", PermissionMode::ReadOnly),
vec!["system".to_string()],
&features,
);
runtime
.run_turn("read a file", None)
.expect("read-only tool call should succeed");
let hook_executed = marker.exists();
if hook_executed {
fs::remove_file(&marker).expect("remove hook marker");
}
assert!(
!hook_executed,
"read-only mode must not execute pre-, post-, or failure hooks"
);
}
#[test]
fn records_runtime_session_trace_events() {
let sink = Arc::new(MemoryTelemetrySink::default());
+130 -14
View File
@@ -40,17 +40,32 @@ fn is_binary_file(path: &Path) -> io::Result<bool> {
/// the workspace boundary (e.g. via `../` traversal or symlink).
#[allow(dead_code)]
fn validate_workspace_boundary(resolved: &Path, workspace_root: &Path) -> io::Result<()> {
if !resolved.starts_with(workspace_root) {
return Err(io::Error::new(
io::ErrorKind::PermissionDenied,
format!(
"path {} escapes workspace boundary {}",
resolved.display(),
workspace_root.display()
),
));
let workspace_root = normalize_for_comparison(workspace_root);
let comparable = normalize_for_comparison(resolved);
if comparable.starts_with(&workspace_root) || resolves_within(resolved, &workspace_root) {
return Ok(());
}
Ok(())
Err(io::Error::new(
io::ErrorKind::PermissionDenied,
format!(
"path {} escapes workspace boundary {}",
comparable.display(),
workspace_root.display()
),
))
}
/// Whether `resolved` names a location inside `workspace_root` once the
/// filesystem resolves it. Windows accepts several spellings of one location
/// that [`Path::starts_with`] treats as different: letter case (a working
/// directory typed as `c:\users\...` for `C:\Users\...`), the `\\.\` device
/// namespace, and 8.3 short names. Only consulted after the lexical comparison
/// fails, so it can accept such a spelling but never widens what already
/// compared inside, and a path whose canonical form is outside stays rejected.
fn resolves_within(resolved: &Path, workspace_root: &Path) -> bool {
resolved
.canonicalize()
.is_ok_and(|canonical| normalize_for_comparison(&canonical).starts_with(workspace_root))
}
/// Text payload returned by file-reading operations.
@@ -527,9 +542,29 @@ fn build_grep_content_output(
}
fn canonicalize_workspace_root(workspace_root: &Path) -> PathBuf {
workspace_root
let canonical = workspace_root
.canonicalize()
.unwrap_or_else(|_| workspace_root.to_path_buf())
.unwrap_or_else(|_| workspace_root.to_path_buf());
normalize_for_comparison(&canonical)
}
/// Normalize Windows' extended-length path prefix before comparing paths.
///
/// `std::fs::canonicalize` returns paths with a `\\?\` prefix on Windows,
/// while a workspace root may still be represented as a regular path when it
/// cannot be canonicalized (for example, while a workspace is bootstrapping).
/// These paths refer to the same location but do not compare equal with
/// [`Path::starts_with`]. Keep the comparison representation stable without
/// changing the paths returned to callers.
fn normalize_for_comparison(path: &Path) -> PathBuf {
let raw = path.to_string_lossy();
if let Some(unc_path) = raw.strip_prefix(r"\\?\UNC\") {
return PathBuf::from(format!(r"\\{unc_path}"));
}
if let Some(dos_path) = raw.strip_prefix(r"\\?\") {
return PathBuf::from(dos_path);
}
path.to_path_buf()
}
fn should_skip_glob_dir(entry: &DirEntry) -> bool {
@@ -777,8 +812,9 @@ mod tests {
use super::{
component_contains_glob, derive_glob_walk_root, edit_file, expand_braces, glob_search,
grep_search, is_symlink_escape, read_file, read_file_in_workspace, write_file,
write_file_in_workspace, GrepSearchInput, MAX_WRITE_SIZE,
grep_search, is_symlink_escape, normalize_for_comparison, read_file,
read_file_in_workspace, write_file, write_file_in_workspace, GrepSearchInput,
MAX_WRITE_SIZE,
};
fn temp_path(name: &str) -> std::path::PathBuf {
@@ -906,6 +942,86 @@ mod tests {
let _ = std::fs::remove_dir_all(&outside);
}
#[test]
fn normalizes_windows_extended_length_prefixes_for_boundary_checks() {
let dos_path = PathBuf::from(r"C:\workspace\file.txt");
let extended_dos_path = PathBuf::from(r"\\?\C:\workspace\file.txt");
assert_eq!(
normalize_for_comparison(&extended_dos_path),
dos_path,
"extended DOS paths should compare like their regular form"
);
let unc_path = PathBuf::from(r"\\server\share\workspace\file.txt");
let extended_unc_path = PathBuf::from(r"\\?\UNC\server\share\workspace\file.txt");
assert_eq!(
normalize_for_comparison(&extended_unc_path),
unc_path,
"extended UNC paths should compare like their regular form"
);
}
// Backslash-separated paths only parse into path components on Windows.
#[test]
#[cfg(windows)]
fn accepts_equivalent_extended_path_at_workspace_boundary() {
let root = PathBuf::from(r"C:\workspace");
let resolved = PathBuf::from(r"\\?\C:\workspace\src\main.rs");
super::validate_workspace_boundary(&resolved, &root)
.expect("equivalent Windows path representations should be accepted");
}
#[test]
#[cfg(unix)]
fn accepts_a_path_that_resolves_inside_the_workspace() {
let workspace = temp_path("boundary-alias-workspace");
let aliases = temp_path("boundary-alias-links");
std::fs::create_dir_all(workspace.join("src")).expect("workspace dir should be created");
std::fs::create_dir_all(&aliases).expect("alias dir should be created");
let alias = aliases.join("src");
std::os::unix::fs::symlink(workspace.join("src"), &alias).expect("symlink should create");
let root = workspace
.canonicalize()
.expect("workspace should canonicalize");
super::validate_workspace_boundary(&alias, &root)
.expect("a spelling that resolves inside the workspace should be accepted");
super::validate_workspace_boundary(&aliases, &root)
.expect_err("a path that resolves outside the workspace must stay rejected");
let _ = std::fs::remove_dir_all(&workspace);
let _ = std::fs::remove_dir_all(&aliases);
}
// Windows resolves one location from spellings that compare unequal as
// paths, letter case and the `\\.\` device namespace among them.
#[test]
#[cfg(windows)]
fn accepts_other_windows_spellings_of_a_workspace_path() {
let workspace = temp_path("Boundary-Case-Workspace");
std::fs::create_dir_all(workspace.join("src")).expect("workspace dir should be created");
let root = workspace
.canonicalize()
.expect("workspace should canonicalize");
let lower = PathBuf::from(workspace.join("src").to_string_lossy().to_lowercase());
super::validate_workspace_boundary(&lower, &root)
.expect("a lower-cased spelling of a workspace path should be accepted");
let device = PathBuf::from(format!(r"\\.\{}", workspace.join("src").display()));
super::validate_workspace_boundary(&device, &root)
.expect("a device-namespace spelling of a workspace path should be accepted");
let parent = workspace
.parent()
.expect("workspace has a parent")
.to_path_buf();
super::validate_workspace_boundary(&parent, &root)
.expect_err("the workspace's parent must stay rejected");
let _ = std::fs::remove_dir_all(&workspace);
}
#[test]
#[cfg(unix)]
fn workspace_write_rejects_parent_symlink_escape_regression_3007_class() {
@@ -81,8 +81,10 @@ impl PermissionEnforcer {
let active_mode = self.policy.active_mode();
// Check if active mode meets the dynamically determined required mode
if active_mode >= required_mode {
// Check if active mode meets the dynamically determined required mode.
// Ranked explicitly: `PermissionMode` no longer derives `Ord`, so the
// ladder is a named function rather than declaration order.
if active_mode.privilege_rank() >= required_mode.privilege_rank() {
return EnforcementResult::Allowed;
}
+187 -28
View File
@@ -5,7 +5,10 @@ use serde_json::Value;
use crate::config::RuntimePermissionRuleConfig;
/// Permission level assigned to a tool invocation or runtime session.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
///
/// Deliberately **not** `PartialOrd`/`Ord`: see [`PermissionMode::privilege_rank`]
/// for why ordering is a named function here rather than declaration order.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum PermissionMode {
ReadOnly,
WorkspaceWrite,
@@ -25,6 +28,53 @@ impl PermissionMode {
Self::Allow => "allow",
}
}
/// Position on the privilege ladder used by [`PermissionPolicy`].
///
/// This is the only ranking, and `Ord` is intentionally not derived, so a
/// stray `active_mode >= required_mode` no longer compiles. Ranking through
/// declaration order meant a variant inserted in the middle of the enum
/// silently re-ranked the ladder, and the difference between "this tool may
/// run" and "this tool may run after a prompt" was therefore a property of
/// where an `enum` line happened to sit. Every variant is named here, so an
/// insertion is a build failure instead of a silent re-ranking; the two
/// comparisons outside this module that do read a rank — the
/// `PermissionEnforcer`'s `check_with_required_mode` and the `claw doctor`
/// permission check — now say so at the call site.
///
/// `Prompt` and `Allow` are *modes of operation*, not privilege tiers. They
/// rank above every tier so those two callers keep the answers they had, but
/// they are never ranked *against* a tier: see [`Self::covers`].
#[must_use]
pub const fn privilege_rank(self) -> u8 {
match self {
Self::ReadOnly => 0,
Self::WorkspaceWrite => 1,
Self::DangerFullAccess => 2,
Self::Prompt => 3,
Self::Allow => 4,
}
}
/// Whether a session running in `self` may use a tool that requires
/// `required` without asking.
///
/// Only tiers answer this by rank. `Allow` never asks and `Prompt` always
/// asks — it is the exact opposite of a silent allow — so neither is a
/// statement about how much of the workspace the session may touch, and
/// comparing either to `required` is comparing a mode to a tier. That
/// comparison is what let `Prompt`, which outranks `DangerFullAccess`, make
/// the ladder return `Allow` for every tool and skip the prompter entirely.
#[must_use]
pub const fn covers(self, required: Self) -> bool {
match self {
Self::Allow => true,
Self::Prompt => false,
Self::ReadOnly | Self::WorkspaceWrite | Self::DangerFullAccess => {
self.privilege_rank() >= required.privilege_rank()
}
}
}
}
/// Hook-provided override applied before standard permission evaluation.
@@ -236,29 +286,12 @@ impl PermissionPolicy {
prompter,
);
}
Some(PermissionOverride::Allow) => {
if let Some(rule) = ask_rule {
let reason = format!(
"tool '{tool_name}' requires approval due to ask rule '{}'",
rule.raw
);
return Self::prompt_or_deny(
tool_name,
input,
current_mode,
required_mode,
Some(reason),
prompter,
);
}
if allow_rule.is_some()
|| current_mode == PermissionMode::Allow
|| current_mode >= required_mode
{
return PermissionOutcome::Allow;
}
}
None => {}
// A hook `allow` is an override, not a bypass: the ask-rule check
// and the privilege ladder below still run for it. Both used to be
// spelled out a second time inside this arm, which is why the ladder
// existed in two copies that had to be corrected in step — and the
// second copy is exactly what a fix for one of them is easy to miss.
Some(PermissionOverride::Allow) | None => {}
}
if let Some(rule) = ask_rule {
@@ -276,10 +309,10 @@ impl PermissionPolicy {
);
}
if allow_rule.is_some()
|| current_mode == PermissionMode::Allow
|| current_mode >= required_mode
{
// The ladder, in one place. An `allow` rule is an explicit grant for
// this tool and outranks the mode; otherwise the mode decides through
// [`PermissionMode::covers`].
if allow_rule.is_some() || current_mode.covers(required_mode) {
return PermissionOutcome::Allow;
}
@@ -587,6 +620,132 @@ mod tests {
));
}
#[test]
fn prompt_mode_routes_to_prompter_instead_of_auto_allowing() {
// Regression: `Prompt` sorts above `DangerFullAccess` in the
// `PermissionMode` `Ord` derivation, so the `current_mode >= required_mode`
// ladder check used to auto-allow every tool in `Prompt` mode and never
// invoke the prompter — defeating the entire purpose of the mode.
let policy = PermissionPolicy::new(PermissionMode::Prompt)
.with_tool_requirement("read_file", PermissionMode::ReadOnly);
let mut prompter = RecordingPrompter {
seen: Vec::new(),
allow: true,
};
let outcome = policy.authorize("read_file", "{}", Some(&mut prompter));
assert_eq!(outcome, PermissionOutcome::Allow);
assert_eq!(prompter.seen.len(), 1);
assert_eq!(prompter.seen[0].tool_name, "read_file");
assert_eq!(prompter.seen[0].current_mode, PermissionMode::Prompt);
}
#[test]
fn prompt_mode_denies_when_no_prompter_is_available() {
let policy = PermissionPolicy::new(PermissionMode::Prompt)
.with_tool_requirement("read_file", PermissionMode::ReadOnly);
assert!(matches!(
policy.authorize("read_file", "{}", None),
PermissionOutcome::Deny { .. }
));
}
#[test]
fn prompt_mode_prompts_for_every_privilege_tier() {
// The ladder used to exist twice — once on the plain path and once inside
// the `Some(PermissionOverride::Allow)` arm — so a hook emitting
// `permissionDecision: "allow"` (see `hooks.rs`) had its own route to the
// auto-allow. Sweeping the tiers against both routes keeps them honest now
// that they are one predicate.
for required in [
PermissionMode::ReadOnly,
PermissionMode::WorkspaceWrite,
PermissionMode::DangerFullAccess,
] {
for override_decision in [None, Some(PermissionOverride::Allow)] {
let policy = PermissionPolicy::new(PermissionMode::Prompt)
.with_tool_requirement("read_file", required);
let context = PermissionContext::new(
override_decision,
override_decision.map(|_| "hook approved".to_string()),
);
let mut prompter = RecordingPrompter {
seen: Vec::new(),
allow: true,
};
let outcome =
policy.authorize_with_context("read_file", "{}", &context, Some(&mut prompter));
assert_eq!(
outcome,
PermissionOutcome::Allow,
"an approving prompter must still pass a {required:?} tool"
);
assert_eq!(
prompter.seen.len(),
1,
"prompt mode skipped the prompter for a {required:?} tool \
(override = {override_decision:?})"
);
assert_eq!(prompter.seen[0].tool_name, "read_file");
assert_eq!(prompter.seen[0].current_mode, PermissionMode::Prompt);
assert_eq!(prompter.seen[0].required_mode, required);
}
}
}
#[test]
fn privilege_rank_orders_the_privilege_tiers() {
assert!(
PermissionMode::ReadOnly.privilege_rank()
< PermissionMode::WorkspaceWrite.privilege_rank()
);
assert!(
PermissionMode::WorkspaceWrite.privilege_rank()
< PermissionMode::DangerFullAccess.privilege_rank()
);
}
#[test]
fn privilege_rank_places_the_operating_modes_above_every_tier() {
// `Prompt` and `Allow` are modes of operation rather than tiers, so
// `covers` answers for them by name and never consults this number. They
// still have to rank above every tier, because two callers outside this
// module — the `PermissionEnforcer`'s `check_with_required_mode` and the
// `claw doctor` permission check — compare ranks, and a `Prompt`/`Allow`
// session must keep the result it had under the old derived `Ord`.
for mode in [PermissionMode::Prompt, PermissionMode::Allow] {
assert!(
mode.privilege_rank() > PermissionMode::DangerFullAccess.privilege_rank(),
"{mode:?} must outrank danger-full-access"
);
assert!(
mode.privilege_rank() > PermissionMode::WorkspaceWrite.privilege_rank(),
"{mode:?} must outrank workspace-write"
);
}
}
#[test]
fn covers_never_compares_an_operating_mode_against_a_tier() {
for required in [
PermissionMode::ReadOnly,
PermissionMode::WorkspaceWrite,
PermissionMode::DangerFullAccess,
] {
assert!(
!PermissionMode::Prompt.covers(required),
"prompt mode must ask before running a {required:?} tool"
);
}
assert!(PermissionMode::Allow.covers(PermissionMode::DangerFullAccess));
assert!(PermissionMode::DangerFullAccess.covers(PermissionMode::WorkspaceWrite));
assert!(!PermissionMode::WorkspaceWrite.covers(PermissionMode::DangerFullAccess));
}
#[test]
fn applies_rule_based_denials_and_allows() {
let rules = RuntimePermissionRuleConfig::new(
+17 -6
View File
@@ -4222,15 +4222,18 @@ fn check_permission_health(permission_mode: PermissionModeProvenance) -> Diagnos
|| source.to_string(),
|env_var| format!("{source}:{env_var}"),
);
// Ranks, not declaration order: `PermissionMode` deliberately does not
// derive `Ord`, so the ladder is named at every comparison site.
let specs = mvp_tool_specs();
let active_rank = permission_mode.mode.privilege_rank();
let tools_satisfied = specs
.iter()
.filter(|spec| permission_mode.mode >= spec.required_permission)
.filter(|spec| active_rank >= spec.required_permission.privilege_rank())
.map(|spec| spec.name)
.collect::<Vec<_>>();
let tools_gated = specs
.iter()
.filter(|spec| permission_mode.mode < spec.required_permission)
.filter(|spec| active_rank < spec.required_permission.privilege_rank())
.map(|spec| spec.name)
.collect::<Vec<_>>();
@@ -7763,15 +7766,20 @@ impl LiveCli {
match result {
Ok(summary) => {
self.replace_runtime(runtime)?;
// The assistant response was already streamed to the terminal live
// during the turn (emit_output = true), so reprinting the full text
// here would duplicate the entire message. When text was streamed,
// emit a newline first so `spinner.finish`'s line-clear lands on a
// fresh line instead of erasing the last streamed line.
let final_text = final_assistant_text(&summary);
if !final_text.is_empty() {
println!();
}
spinner.finish(
"✨ Done",
TerminalRenderer::new().color_theme(),
&mut stdout,
)?;
let final_text = final_assistant_text(&summary);
if !final_text.is_empty() {
println!("{final_text}");
}
println!();
if let Some(event) = summary.auto_compaction {
println!(
@@ -7903,6 +7911,9 @@ impl LiveCli {
match new_runtime.run_turn(input, Some(&mut rp)) {
Ok(summary) => {
self.replace_runtime(new_runtime)?;
if !final_assistant_text(&summary).is_empty() {
println!();
}
spinner.finish(
if round == 0 {
"✨ Done (after auto-compact)"
@@ -130,7 +130,7 @@ fn compact_flag_streaming_text_only_emits_final_message_text() {
}
#[test]
fn text_prompt_mode_prints_final_assistant_text_after_spinner() {
fn text_prompt_mode_streams_assistant_text_once_before_spinner_completion() {
// given a workspace pointed at the mock Anthropic service running the
// streaming_text scenario which only emits a single assistant text block
let runtime = tokio::runtime::Runtime::new().expect("tokio runtime should build");
@@ -162,7 +162,7 @@ fn text_prompt_mode_prints_final_assistant_text_after_spinner() {
],
);
// then stdout should contain the final assistant text, not just spinner output
// then the streamed answer should appear once before the spinner completion
assert!(
output.status.success(),
"text prompt run should succeed\nstdout:\n{}\n\nstderr:\n{}",
@@ -171,19 +171,19 @@ fn text_prompt_mode_prints_final_assistant_text_after_spinner() {
);
let stdout = String::from_utf8(output.stdout).expect("stdout should be utf8");
let plain_stdout = strip_ansi_codes(&stdout);
assert!(
plain_stdout.contains("Mock streaming says hello from the parity harness."),
"text prompt stdout should include the assistant text ({stdout:?})"
let assistant_text = "Mock streaming says hello from the parity harness.";
assert_eq!(
plain_stdout.matches(assistant_text).count(),
1,
"text prompt stdout should contain the streamed assistant text exactly once ({stdout:?})"
);
assert!(
plain_stdout.contains("✔ ✨ Done"),
"text prompt stdout should still include spinner completion ({stdout:?})"
);
assert!(
plain_stdout
.lines()
.any(|line| line == "Mock streaming says hello from the parity harness."),
"text prompt stdout should print the assistant text as its own line ({stdout:?})"
plain_stdout.find(assistant_text) < plain_stdout.find("✔ ✨ Done"),
"text prompt stdout should stream the assistant text before spinner completion ({stdout:?})"
);
fs::remove_dir_all(&workspace).expect("workspace cleanup should succeed");
+17 -1
View File
@@ -1,6 +1,7 @@
from __future__ import annotations
import json
import re
from dataclasses import asdict, dataclass
from pathlib import Path
@@ -15,16 +16,31 @@ class StoredSession:
DEFAULT_SESSION_DIR = Path('.port_sessions')
# Session ids become filenames inside the session directory, so they must not be
# able to escape it via path separators or traversal. Restrict to the charset
# produced by legitimate ids (uuid4 hex, `session-<digits>-<n>`).
_SESSION_ID_PATTERN = re.compile(r'\A[A-Za-z0-9_-]+\Z')
def _validate_session_id(session_id: str) -> str:
if not _SESSION_ID_PATTERN.match(session_id):
raise ValueError(
f'invalid session_id {session_id!r}: only [A-Za-z0-9_-] characters are allowed'
)
return session_id
def save_session(session: StoredSession, directory: Path | None = None) -> Path:
session_id = _validate_session_id(session.session_id)
target_dir = directory or DEFAULT_SESSION_DIR
target_dir.mkdir(parents=True, exist_ok=True)
path = target_dir / f'{session.session_id}.json'
path = target_dir / f'{session_id}.json'
path.write_text(json.dumps(asdict(session), indent=2))
return path
def load_session(session_id: str, directory: Path | None = None) -> StoredSession:
session_id = _validate_session_id(session_id)
target_dir = directory or DEFAULT_SESSION_DIR
data = json.loads((target_dir / f'{session_id}.json').read_text())
return StoredSession(
+57
View File
@@ -9,9 +9,66 @@ from src.models import PermissionDenial
from src.path_scope import WorkspacePathScope, extract_path_candidates
from src.permissions import ToolPermissionContext
from src.query_engine import QueryEnginePort
from src.session_store import StoredSession, load_session, save_session
from src.tools import execute_tool
class SessionStorePathTraversalTests(unittest.TestCase):
def test_traversal_session_id_is_rejected_on_load(self) -> None:
with tempfile.TemporaryDirectory() as tmp:
store = Path(tmp) / 'store'
store.mkdir()
# A secret living outside the session store that traversal would reach.
(Path(tmp) / 'secret.json').write_text('{}')
with self.assertRaises(ValueError):
load_session('../secret', directory=store)
def test_absolute_and_separator_session_ids_are_rejected(self) -> None:
with tempfile.TemporaryDirectory() as tmp:
store = Path(tmp) / 'store'
store.mkdir()
for bad_id in (
'/etc/passwd',
'nested/child',
r'nested\child',
r'C:\Windows\win.ini',
'..',
'a/../../b',
):
with self.assertRaises(ValueError):
load_session(bad_id, directory=store)
def test_traversal_session_id_is_rejected_on_save(self) -> None:
with tempfile.TemporaryDirectory() as tmp:
store = Path(tmp) / 'store'
store.mkdir()
session = StoredSession(
session_id='../escape',
messages=('hello',),
input_tokens=1,
output_tokens=2,
)
with self.assertRaises(ValueError):
save_session(session, directory=store)
self.assertFalse((Path(tmp) / 'escape.json').exists())
def test_legitimate_session_id_round_trips(self) -> None:
with tempfile.TemporaryDirectory() as tmp:
store = Path(tmp) / 'store'
session = StoredSession(
session_id='session-1775386832313-0',
messages=('hi', 'there'),
input_tokens=3,
output_tokens=4,
)
path = save_session(session, directory=store)
self.assertEqual(store, path.parent)
loaded = load_session('session-1775386832313-0', directory=store)
self.assertEqual(session, loaded)
class WorkspacePathScopeTests(unittest.TestCase):
def test_direct_parent_escape_is_denied(self) -> None:
with tempfile.TemporaryDirectory() as tmp: