Skip to content

Solution for long term memory for agent coding CLIs and to facilitate handoff between different agent vendors

Rust

fix(setup): read only REG_SZ, parse --data-dir after the executable, normalize UNC

Gabriel Scharb3b0605ae93b5
diff --git a/crates/ai-memory-cli/src/commands/user_service.rs b/crates/ai-memory-cli/src/commands/user_service.rs
index a9758330..ac7aeeee 100644
--- a/crates/ai-memory-cli/src/commands/user_service.rs
+++ b/crates/ai-memory-cli/src/commands/user_service.rs
@@ -402,22 +402,32 @@ pub(crate) fn is_setup_run_entry(data: &str) -> bool {
}
/// The `--data-dir` a `setup` logon entry names, unquoted the way
-/// [`windows_arg`] quoted it; `None` when the entry names none.
+/// [`windows_arg`] quoted it; `None` when the entry names none. Only the
+/// first argument after the quoted executable is read, as `render_windows`
+/// writes it, so a `--data-dir` inside the executable's own path never
+/// counts.
fn run_entry_data_dir(data: &str) -> Option<String> {
- let rest = data.split_once(" --data-dir ")?.1.trim_start();
- let quoted = rest.strip_prefix('"')?;
+ let (_program, args) = data.strip_prefix('"')?.split_once('"')?;
+ let quoted = args
+ .trim_start()
+ .strip_prefix("--data-dir")?
+ .trim_start()
+ .strip_prefix('"')?;
let (dir, _) = quoted.split_once('"')?;
// `windows_arg` doubled the backslashes that end the path.
let trailing = dir.len() - dir.trim_end_matches('\\').len();
Some(dir[..dir.len() - trailing / 2].to_owned())
}
-/// Whether two Windows paths name the same directory: the `\\?\` prefix,
-/// trailing separators and letter case do not count.
+/// Whether two Windows paths name the same directory: the verbatim prefix
+/// (`\\?\C:\…`, `\\?\UNC\server\share\…`), trailing separators and letter
+/// case do not count.
fn same_windows_dir(left: &str, right: &str) -> bool {
let plain = |path: &str| {
- let path = path.strip_prefix(r"\\?\").unwrap_or(path);
- path.trim_end_matches(['\\', '/']).replace('/', "\\")
+ let path = path.replace('/', "\\");
+ super::path_util::strip_windows_verbatim_prefix(&path)
+ .trim_end_matches('\\')
+ .to_owned()
};
plain(left).eq_ignore_ascii_case(&plain(right))
}
@@ -516,11 +526,15 @@ const RUN_SUBKEY: &str = r"Software\Microsoft\Windows\CurrentVersion\Run";
mod user_registry {
use anyhow::{Context as _, Result};
+ /// A `REG_SZ` value. `get_string` also reads `REG_EXPAND_SZ`, which
+ /// `setup` never writes: such a value under the same name is someone
+ /// else's, as it was when `reg query` output was parsed for `REG_SZ`.
pub(super) fn get(subkey: &str, name: &str) -> Option<String> {
- windows_registry::CURRENT_USER
- .open(subkey)
- .and_then(|key| key.get_string(name))
- .ok()
+ let key = windows_registry::CURRENT_USER.open(subkey).ok()?;
+ match key.get_type(name).ok()? {
+ windows_registry::Type::String => key.get_string(name).ok(),
+ _ => None,
+ }
}
pub(super) fn set(subkey: &str, name: &str, data: &str) -> Result<()> {
@@ -1473,6 +1487,34 @@ mod windows_entry_tests {
));
assert!(!same_windows_dir(r"C:\a\ai-memory", r"C:\b\ai-memory"));
assert!(!same_windows_dir(r"C:\ai-memory", r"C:\ai-memory-test"));
+ // A verbatim UNC path names the same share as its plain spelling.
+ assert!(same_windows_dir(
+ r"\\?\UNC\server\share\ai-memory",
+ r"\\server\share\ai-memory\"
+ ));
+ assert!(!same_windows_dir(
+ r"\\?\UNC\server\share\ai-memory",
+ r"\\server\other\ai-memory"
+ ));
+ }
+
+ /// A `--data-dir` inside the executable's path is not the option.
+ #[test]
+ fn the_data_dir_is_read_after_the_executable() {
+ let entry = format!(
+ "{} --data-dir {} --config {} {SERVICE_HOST}",
+ windows_arg("binary", r"C:\tools --data-dir bin\ai-memory.exe").unwrap(),
+ windows_arg("data dir", r"C:\Users\me\AppData\Local\ai-memory").unwrap(),
+ windows_arg("config", r"C:\c.toml").unwrap(),
+ );
+ assert_eq!(
+ run_entry_data_dir(&entry).as_deref(),
+ Some(r"C:\Users\me\AppData\Local\ai-memory")
+ );
+ assert!(is_setup_run_entry_for(
+ &entry,
+ Path::new(r"C:\Users\me\AppData\Local\ai-memory")
+ ));
}
/// The test that found this: an `uninstall` run against a temporary data
@@ -1583,4 +1625,46 @@ mod user_registry_tests {
assert_eq!(user_registry::get(&subkey, "ai-memory"), None);
windows_registry::CURRENT_USER.remove_tree(&subkey).unwrap();
}
+
+ /// `setup` writes `REG_SZ`; an expandable string under the same name was
+ /// put there by someone else and must not read as `setup`'s entry, or
+ /// `uninstall` would delete it.
+ #[test]
+ fn only_a_plain_string_value_is_read() {
+ let subkey = format!(r"Software\ai-memory-tests\{}", uuid::Uuid::new_v4());
+ let data =
+ r#""C:\bin\ai-memory.exe" --data-dir "C:\d" --config "C:\d\config.toml" service-host"#;
+ let key = windows_registry::CURRENT_USER.create(&subkey).unwrap();
+
+ key.set_expand_string("ai-memory", data).unwrap();
+ assert_eq!(user_registry::get(&subkey, "ai-memory"), None);
+
+ // Control: the same data as REG_SZ is read.
+ key.set_string("ai-memory", data).unwrap();
+ assert_eq!(
+ user_registry::get(&subkey, "ai-memory").as_deref(),
+ Some(data)
+ );
+ windows_registry::CURRENT_USER.remove_tree(&subkey).unwrap();
+ }
+
+ /// The entry `render` writes for an install is recognised as that
+ /// install's, even when the executable's own path holds ` --data-dir `.
+ #[test]
+ fn a_rendered_entry_belongs_to_its_own_data_dir() {
+ let data_dir = std::path::PathBuf::from(r"C:\Users\me\AppData\Local\ai-memory");
+ let spec = super::ServiceSpec {
+ exe: r"C:\tools --data-dir bin\ai-memory.exe".into(),
+ data_dir: data_dir.clone(),
+ config_path: data_dir.join("config.toml"),
+ home: r"C:\Users\me".into(),
+ xdg_config_home: None,
+ };
+ let unit = super::render(super::ServiceManager::WindowsRun, &spec).unwrap();
+ assert!(super::is_setup_run_entry_for(&unit.contents, &data_dir));
+ assert!(!super::is_setup_run_entry_for(
+ &unit.contents,
+ std::path::Path::new(r"C:\tools")
+ ));
+ }
}
diff --git a/docs/security-boundaries.md b/docs/security-boundaries.md
index cd3770f1..b6d948a5 100644
--- a/docs/security-boundaries.md
+++ b/docs/security-boundaries.md
@@ -110,7 +110,7 @@ means the boundary is not built yet.
| 15 | Agent-archive restore path confinement, resource bounds, and consistency | `ai-memory-cli/src/commands/restore_agents.rs` stages only bounded regular UTF-8 entries; requires a one-to-one manifest/body/checksum/target mapping; allowlists destinations by scope; rejects symlinked descendants; writes each file atomically and rolls back earlier writes after a later failure. `backup_agents.rs` skips direct and directory-root source symlinks, bounds individual assets, and atomically replaces a private archive only after gzip completion | `backup_agents.rs` `restore_agents_rejects_path_traversal`, `restore_agents_rejects_unauthorized_destination_path`, `restore_agents_verifies_sha256_integrity`, `restore_agents_requires_a_complete_one_to_one_manifest`, `restore_agents_rejects_oversized_entries_from_the_header`, `restore_agents_rejects_a_symlinked_destination_parent`, `backup_agents_does_not_follow_config_or_asset_root_symlinks`, and `failed_backup_leaves_the_previous_archive_intact`; `backup_and_restore_agents_round_trip` is the valid-path control; `restore_agents::tests::rollback_removes_new_files_and_restores_overwrites` covers recovery | STRONG |
| 16 | Relay queue identity, migration, and private filesystem state | `companions/ai-memory-relay/src/queue.rs` `Queue::open_inner` performs read-only identity preflight, rechecks under `IMMEDIATE`, commits schema and metadata together; `configure` checks the presence of user objects and rechecks `identity`/`schema_version` metadata on the same connection before every bounded BUSY/LOCKED retry; `fsguard.rs` checks existing paths and creates owner-only files before SQLite opens them | `tests/relay.rs` `a_foreign_database_is_refused_byte_for_byte`, `unknown_schemas_refuse_without_mutation`, `a_foreign_database_with_a_writer_is_refused_before_write_coordination`, `a_foreign_identity_after_preflight_is_refused_without_mutation`, `a_foreign_identity_during_journal_retry_is_refused_without_mutation`, `journal_retry_refuses_a_changed_version_or_empty_database_without_mutation`; controls: `journal_transition_retries_sqlite_lock_without_losing_v1_values`, `fresh_queue_init_and_v1_reopens_work_across_processes`; recovery: `interrupted_and_failed_migrations_roll_back_and_recover`, `journal_reclassification_busy_preserves_committed_migration_and_retries_same_queue`; diagnostics: `classification_read_failures_display_the_sqlite_cause_once_and_preserve_foreign_bytes`; Unix privacy: `the_queue_database_and_its_sidecars_are_owner_only` and the contended migration control | Guard-removal proof covers preflight, locked recheck, and journal retry identity/version checks; full table structure is outside this classification. Windows path rejection is preserved; Windows ACL hardening remains operator-owned |
| 17 | `ai-memory setup --web` local wizard: only the page this process printed can read the plan or apply a setup | `ai-memory-cli/src/commands/setup_web.rs` `guard` (binds `127.0.0.1` on an OS-picked port; every request needs a `Host` of exactly `127.0.0.1:<port>` or `localhost:<port>` and the one-time 256-bit path secret, compared with `subtle`; a POST also needs this page's `Origin` and the CSRF token the page reads from its own JSON; no CORS grant; `no-store`, `no-referrer`, `DENY` framing, and a CSP with a per-run nonce and no outside sources on the page) and `apply` (agent names must be `--agent` values, de-duplicated, at least one; the child is always `ai-memory setup --yes --agent ...` with the wizard's own flags, never a caller-chosen argument) | `setup_web.rs` `the_page_is_served_only_to_our_host_and_secret` (a rebinding `Host`, a bare `127.0.0.1`, another port, a wrong secret and a missing one refused; controls: `127.0.0.1` and `localhost` with the secret), `apply_refuses_cross_site_and_unknown_input_and_starts_nothing` (no `Origin`, a foreign `Origin`, no CSRF token and a wrong one each refused; `--force`, a shell-like name and an empty choice refused; no child starts), `apply_runs_setup_with_the_picked_agents_and_streams_its_output` (legitimate control: exact argument list); `tests/suite/setup_e2e.rs` `setup_web_serves_the_plan_and_applies_the_picked_agent` (the same through the binary); bite-checked by removing the `Host` check, the `Origin` check, the CSRF check and the agent allowlist one at a time | STRONG |
-| 18 | `uninstall` removes only a service `setup` wrote, including the Windows logon entry | `ai-memory-cli/src/commands/user_service.rs` `planned_removal` / `is_rendered_by_setup` (a unit file whose identity digest still matches) and `planned_removal_for` / `is_setup_run_entry_for` (a `HKCU\...\Run\ai-memory` value that is a quoted `ai-memory.exe` ending in `service-host`, with no `&` or `|` chaining, whose `--data-dir` is the data dir being uninstalled) before `remove` stops anything or deletes it | `user_service.rs` `uninstall_removes_only_setups_logon_entry` (another install's entry, naming a different `--data-dir`, is left with only the query run; another program's value under the same name is left; absent value is nothing to do; control: this data dir's entry is deleted), `only_the_entry_for_this_data_dir_is_ours` (a temporary data dir does not claim the operator's entry, #1280), `only_setups_entry_shape_counts_as_ours` (unquoted, other program, `serve`, `&`/`|` chaining all refused), and the unit-file identity tests in the same module | STRONG |
+| 18 | `uninstall` removes only a service `setup` wrote, including the Windows logon entry | `ai-memory-cli/src/commands/user_service.rs` `planned_removal` / `is_rendered_by_setup` (a unit file whose identity digest still matches) and `planned_removal_for` / `is_setup_run_entry_for` (a `REG_SZ` `HKCU\...\Run\ai-memory` value that is a quoted `ai-memory.exe` ending in `service-host`, with no `&` or `|` chaining, whose `--data-dir`, the first argument after the quoted executable, is the data dir being uninstalled, compared without the verbatim `\\?\` / `\\?\UNC\` prefix, case or trailing separators) before `remove` stops anything or deletes it | `user_service.rs` `uninstall_removes_only_setups_logon_entry` (another install's entry, naming a different `--data-dir`, is left with only the query run; another program's value under the same name is left; absent value is nothing to do; control: this data dir's entry is deleted), `only_the_entry_for_this_data_dir_is_ours` (a temporary data dir does not claim the operator's entry, #1280), `the_data_dir_is_read_after_the_executable` and, on Windows, `a_rendered_entry_belongs_to_its_own_data_dir` (a ` --data-dir ` inside the executable's path neither hides nor fakes the option), `data_dirs_compare_without_prefix_case_or_trailing_separator` (verbatim UNC matches its plain spelling; another share does not), Windows-only `only_a_plain_string_value_is_read` (a `REG_EXPAND_SZ` value under the name is not read as setup's; control: the same data as `REG_SZ` is), `only_setups_entry_shape_counts_as_ours` (unquoted, other program, `serve`, `&`/`|` chaining all refused), and the unit-file identity tests in the same module | STRONG |
## Keeping this current (the standing protocol)