search

oddlama / agenix-rekey

An agenix extension adding secret generation and automatic rekeying using a YubiKey or master-identity
MIT License
186 stars 16 forks source link

Errors: Perhaps it would be worth adding help text for when users repeatedly encounter the prompt to rekey? #20

Open plaidfinch opened 3 months ago

plaidfinch commented 3 months ago

When I was first getting set up using this library, I got stuck in a loop of being prompted to rekey. It turns out, I skipped the warning in step 4 of the README, mea culpa. But it would have been quicker to realize my error if there was help text in the "you need to rekey" message which indicated that if this error shows up repeatedly, you likely need to configure the extra-sandbox-paths per the README.

Hopefully this user experience note is helpful! I figure that I only get one chance to be a first-time user of a piece of software, so I'm trying to document the gotchas I encounter to smooth the way for others in the future. :)

oddlama commented 3 months ago

Thanks for the info! I'll have to think about how to make this specific error better to understand. Maybe the loop can be detected somehow and then an appropriate message can be shown..

plaidfinch commented 3 months ago

No idea if this would work, but maybe upon failure a file could be put in a well-known temp location, and upon success, deleted? Then, upon second failure, if the file is already there, we know we've gone around the loop before. I've no idea how to do this while skirting the purity requirements Nix imposes, but you've already navigated those deftly in this package, so perhaps you can see a way.