authy AGENTS.md

AGENTS.md — AI Agent Project Guide

Project Overview

Authy is a CLI secrets store & dispatch tool for AI agents. Built in Rust. Single binary, no server, no accounts. It stores encrypted secrets locally and dispatches them to agents with policy-based scoping, short-lived session tokens, and audit logging.

Tech Stack: Rust 2021 edition, clap (CLI), age (encryption), MessagePack (serialization), HMAC-SHA256 (session tokens).

Build & Test Commands

cargo build                    # dev build
cargo build --release          # release build (binary at target/release/authy)
cargo test                     # run all tests (unit + integration)
cargo test --test integration  # run integration tests only
cargo test <test_name>         # run a single test
cargo clippy -- -D warnings    # lint (must pass clean)

Project Structure

src/
  main.rs               Entry point — parse CLI args, dispatch to handlers
  error.rs              AuthyError enum (thiserror), Result type alias
  types.rs              Common re-exports (serde, chrono, BTreeMap, PathBuf)

  cli/                  clap command definitions (one file per command)
    mod.rs              CLI struct with Subcommand enum
    init.rs             authy init — create vault, generate keyfile or passphrase
    store.rs            authy store — decrypt vault, insert secret, re-encrypt
    get.rs              authy get — decrypt vault, policy check, output to stdout
    list.rs             authy list — list secret names with optional scope filter
    remove.rs           authy remove — delete secret from vault
    rotate.rs           authy rotate — update secret value, bump version
    policy.rs           authy policy * — CRUD for scope policies
    session.rs          authy session * — create/list/revoke tokens
    run.rs              authy run — subprocess injection with scoped secrets
    audit.rs            authy audit * — show/verify/export audit log
    config.rs           authy config — show configuration

  vault/                Encrypted vault storage
    mod.rs              Vault struct, VaultKey enum, load_vault(), save_vault()
    crypto.rs           age encrypt/decrypt (passphrase + keyfile), HKDF derivation
    secret.rs           SecretEntry, SecretMetadata (with Zeroize)

  auth/                 Authentication dispatcher
    mod.rs              resolve_auth() — resolve credentials to VaultKey + AuthContext
    context.rs          AuthContext — carries resolved identity and permission level

  policy/               Access control
    mod.rs              Policy struct, can_read() with globset matching

  session/              Session token management
    mod.rs              SessionRecord, generate_token(), validate_token()

  audit/                Audit logging
    mod.rs              AuditEntry, append_entry(), verify_chain()

  subprocess/           Child process spawning
    mod.rs              Spawn child process with env var injection

  config/               Configuration parsing
    mod.rs              authy.toml parsing

tests/integration/      Integration tests using assert_cmd + tempfile