trackslash
VAULT-63 P2

Decide whether the PDF backup's Password Hint should start empty

0
All issues

Description

Found while testing VAULT-15.

Today: the "Password Hint" field on the PDF backup page starts filled with this default:

"This is my description, which is visible in plain text on the vault backup. You can use the Vault app to import this data if you lose access to your device."

It comes from BackupCreatePDFViewModel.defaultUserHint, which dates from #257. Unless someone clears it, it's printed in plain text on every PDF backup.

Questions:

  • Is this meant as a sample for the user to replace? It reads like one ("This is my description"). If so, it should be a placeholder in the field, not its value, so it's never printed unless the user writes something.
  • Or is it meant as a default note explaining the PDF to whoever finds it? If so, it should be worded as that, not as "my description".

MANIFESTO.md C10 applies: the hint is readable without the password, so what it says by default matters.

Sub-issues

0

Linked issues

0

GitHub

0

No branches or pull requests linked.

Comments

1
Bradley

Fixed in https://github.com/badbundle/vault-app/pull/659 (merged as d9d27bcb).

Decision: the hint now starts empty. The question settled itself on these grounds:

  • The field is labelled "Password Hint", and its footer called it "an optional hint … to help you remember its password". The old default wasn't a hint at all.
  • The PDF already has a "Vault Export" title and says to open the Vault app and scan every code to import it, so the default text added nothing.
  • Under C10, starting empty means a PDF prints nothing in plain text unless the user writes something.

Also changed:

  • Making a PDF saves the hint, so any vault that made one without editing it had the old sample saved as its hint. That exact text is now treated as no hint.
  • The footer now says the hint is printed in plain text, so anyone who sees the document can read it.
  • Tests: new view-model tests, and the create-PDF snapshot is re-recorded.