Skip to content

v0.7.1 — --key names its passphrase source

Choose a tag to compare

@corderro-artz corderro-artz released this 08 Sep 07:20
· 639 commits to main since this release

--key-env is gone. --key names its source:

Source Reads
env:NAME An environment variable. The usual answer for CI.
file:PATH The first line of a file. A trailing newline is dropped; spaces are kept.
stdin One line from standard input. Leaves nothing anywhere.
prompt Asks at the terminal, echoing nothing. The default when --key is omitted.
nfty export ./collection --out ./dist --preset sealedcritique --key file:./key.txt
printf '%s' "$PASS" | nfty export ./collection --out ./dist --preset sealedcritique --key stdin
nfty inspect ./ChestDemo.tin --key env:NFTY_KEY

Why more than one

An environment variable is what most tools stop at, and it is not the safest thing available: it is inherited by every child process, readable from /proc/<pid>/environ by the same user on Linux, and dumped by anything that dumps the environment on a crash. A key file can be mode 600. A pipe leaves no trace at all. They are not interchangeable, so you pick one rather than having one picked for you.

An unprefixed value is refused, not guessed

That is the rule nfty already applies to every colour you type — a missing or unknown prefix is an error. It matters more here: --key hunter2 looks like it works, and accepting it would put your passphrase in the process list, which is the exact thing there is no --passphrase for.

file: and the trailing newline

Every editor and every echo writes one. A passphrase that silently gained a \n would seal a file its own author could not open — with "either the passphrase is wrong, or the file was changed" as the only symptom, which is the one message that cannot say which. The line ending is dropped and nothing else is; leading and interior spaces are kept, because a space is a legitimate passphrase character.

Also

Naming the source made the passphrase path testable. It was one environment variable and an interactive prompt, and a prompt cannot be tested at all; three of the four sources are ordinary functions now. CLI tests went 133 → 152.

BACKLOG.md records what is deliberately deferred, with reasons: a manual reshoot against the Chest Demo, and splitting UniqueSpace's cap into an enumeration budget and a reporting ceiling.

Downloads

framework-dependent smallest; needs the .NET 10 runtime
single-file-net10 one .exe; needs the .NET 10 runtime
single-file one .exe, nothing to install
portable unzip and run, nothing to install

Manual: https://www.vaporsoft.dev/nfty