Skip to main content

Crate hyprforge_secret

Crate hyprforge_secret 

Source
Expand description

One implementation of “never render this”.

A keysym name is the character it names, and the same is true of a typed password and a Wi-Fi passphrase: the moment a Debug impl, a tracing::debug!(?x), or a panic message prints the value, it is on disk in a barely-encoded form, and anything that captures a program’s output — a CI log, a terminal recording, a coding assistant’s transcript — keeps a copy of it. That rule got written by hand three separate times in this workspace — the lock screen’s typed password, the Wi-Fi passphrase, and the clipboard’s remembered content — and each of those was a fresh chance to get it wrong: to forget a field, to #[derive(Debug)] over it later, to print the value “just this once” for a bug report.

Secret<T> is the one implementation for the two of those that are a genuine “hide this, entirely” case — a password and a passphrase, where the value itself is the whole risk and nothing about it is worth describing. Its Debug renders a character count and nothing else, and Secret::expose is the single accessor: grep expose in any crate that depends on this one finds every place a secret leaves the wrapper.

The clipboard is a different shape of the same problem and is deliberately not built on Secret<T> — see hyprforge-clipboard’s types.rs for why, and chars/bytes for the smaller piece of this crate it does share: the formatting of “a redacted count”, used by a Debug impl that describes rather than hides.

Structs§

RedactedCount
A count with a unit, rendered as <N unit> — <28 chars>, <2048 bytes>.
Secret
A value that must never reach a log, a panic message, or a debug dump — only its length may be rendered.

Traits§

SecretLen
How to count a secret’s length without looking at what it is made of.

Functions§

bytes
A byte count, for anything not meaningfully measured in characters (image bytes, for instance): <N bytes>.
chars
A character count, for text: <N chars>.