OneSSH Security Mechanisms
This document summarizes OneSSH security design and key mitigations. For complete architecture and runtime execution flow, see Architecture.
1. Data At Rest Encryption
- KDF: Argon2id
- Cipher: AES-256-GCM
- Storage model: sharded YAML docs with encrypted sensitive fields (
ENC[...]) - Main files:
meta.yaml(KDF params + password verifier)users/*.yaml(username/auth)hosts/*.yaml(host/user_ref/port/proxy_jump/env/hooks)
KDF hardening
KDF parameters loaded from meta.yaml are validated before key derivation:
time: 1..10memory: 8 MiB..1 GiB (KiB in metadata)threads: 1..64key_len: must be 32- salt length: 16..64 bytes
This blocks malicious metadata from forcing extreme resource usage.
2. Master Password Caching
- Cache backend: memory-only agent (no file cache compatibility).
- Cache storage: in-memory map with TTL per config path.
- Access control: Unix socket peer UID must match agent process UID.
- Optional hardening: capability token can be required on every IPC request.
- Default behavior: when not explicitly configured, socket path and capability are auto-derived from parent shell PID for convenience and namespace separation, not as a strong same-UID security boundary.
Flow
3. SSH Password Auth Transport
OneSSH avoids putting SSH password in env vars.
- Preferred:
sshpass -d 3with password through inherited FD pipe. - Fallback:
SSH_ASKPASShelper + onessh agent IPC token (weaker thansshpass -dbecause a local same-UID process may still race to observe the helper context).
Preferred path (sshpass -d)
Fallback path (SSH_ASKPASS + agent IPC token)
Token controls:
- random token generated from CSPRNG
- short TTL (10 seconds by default)
- bounded max uses (single-use by default)
- explicit cleanup after command exit
4. Reset Safety (init --force)
SaveWithReset path is validated before recursive deletion:
- rejects dangerous targets (
/, empty,.) - requires directory type
- for non-empty directories, requires OneSSH store shape (
meta.yaml,users,hosts) - rejects unexpected extra entries
This reduces accidental destructive deletions caused by wrong config path.
5. Current Threat Model Notes
Mitigated:
- disk leakage of cached master password (no file cache backend)
- cross-UID socket access to memory agent
- env-var leakage of SSH password in normal paths
- accidental plain dump leakage (default redaction)
- KDF parameter abuse from tampered metadata
Still in scope / limitations:
- same-UID local malware is still powerful
- default parent-PID-derived socket/capability values are not intended to provide strong isolation from other same-UID processes
- SSH password auth inherently has higher exposure risk than key auth
SSH_ASKPASSfallback is a weaker compatibility path thansshpass -d- Windows equivalent of peer-credential checks needs dedicated implementation