linuxboot / heads-wiki

Documentation for the Heads firmware project
84 stars 44 forks source link

Clarify and reuse proper LUKS keys terminology consistenty in doc #75

Open tlaurion opened 3 years ago

tlaurion commented 3 years ago

The keys page (https://osresearch.net/Keys/) lists 4 keys related to disks but the docs include 10 different terms.

officially listed related to drive/disk

terms used in docs

TPM disk encryption key:

Disk recovery Key:

LUKS disk encryption key:

Disk encryption key without explicit LUKS/TPM:

Disk encryption recovery key:

Disk Key:

TPM disk unlock key:

Disk unlock key passphrase:

Disk unlock key:

TPM sealed drive keys:

JT changes

After I worked on the docs it is mostly the same but a few changed

TPM disk encryption key: SAME

Disk recovery Key:

LUKS disk encryption key: SAME

Disk encryption key without explicit LUKS/TPM:

Disk encryption recovery key: NONE

Disk Key:

TPM disk unlock key: SAME

Disk unlock key passphrase:

Disk unlock key:

TPM sealed drive keys: SAME

@tlaurion Which of the listed keys in keys.md should be mentioned in the paragraph in upgrading.md? If the keys that should be mentioned are not listed in keys.md I will add as part of this change.

_Originally posted by @jtmoree-github-com in https://github.com/osresearch/heads-wiki/pull/71#discussion_r661464726_

tlaurion commented 3 years ago

Context and precisions: https://github.com/osresearch/heads-wiki/pull/71#discussion_r675856865