diff options
author | Glenn Washburn <development@efficientek.com> | 2022-06-08 10:34:04 -0500 |
---|---|---|
committer | Daniel Kiper <daniel.kiper@oracle.com> | 2022-07-04 14:43:25 +0200 |
commit | 97ac1863051ab8773b34fa41aab923c60d8870ec (patch) | |
tree | 8c517b19ab28c88b7bdb03628dde1132c4cf49dc | |
parent | 1deb521452b288fe8256dcc7bc14228aa42b568e (diff) | |
download | grub-97ac1863051ab8773b34fa41aab923c60d8870ec.tar.gz |
docs: Add documentation on detached header option to cryptomount
Signed-off-by: Glenn Washburn <development@efficientek.com>
Reviewed-by: Patrick Steinhardt <ps@pks.im>
Reviewed-by: Daniel Kiper <daniel.kiper@oracle.com>
-rw-r--r-- | docs/grub.texi | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/docs/grub.texi b/docs/grub.texi index 8c2fa32c7..af119dea3 100644 --- a/docs/grub.texi +++ b/docs/grub.texi @@ -4525,19 +4525,26 @@ Alias for @code{hashsum --hash crc32 arg @dots{}}. See command @command{hashsum} @node cryptomount @subsection cryptomount -@deffn Command cryptomount [ [@option{-p} password] | [@option{-k} keyfile [@option{-O} keyoffset] [@option{-S} keysize] ] ] device|@option{-u} uuid|@option{-a}|@option{-b} +@deffn Command cryptomount [ [@option{-p} password] | [@option{-k} keyfile [@option{-O} keyoffset] [@option{-S} keysize] ] ] [@option{-H} file] device|@option{-u} uuid|@option{-a}|@option{-b} Setup access to encrypted device. A passphrase will be requested interactively, if neither the @option{-p} nor @option{-k} options are given. The option @option{-p} can be used to supply a passphrase (useful for scripts). Alternatively the @option{-k} option can be used to supply a keyfile with options @option{-O} and @option{-S} optionally supplying the offset and size, -respectively, of the key data in the given key file. - +respectively, of the key data in the given key file. The @option{-H} options can +be used to supply cryptomount backends with an alternative header file (aka +detached header). Not all backends have headers nor support alternative header +files (currently only LUKS1 and LUKS2 support them). Argument @var{device} configures specific grub device (@pxref{Naming convention}); option @option{-u} @var{uuid} configures device with specified @var{uuid}; option @option{-a} configures all detected encrypted devices; option @option{-b} configures all geli containers that have boot flag set. +Devices are not allowed to be given as key files nor as detached header files. +However, this limitation can be worked around by using blocklist syntax. So +for instance, @code{(hd1,gpt2)} can not be used, but @code{(hd1,gpt2)0+} will +achieve the desired result. + GRUB suports devices encrypted using LUKS, LUKS2 and geli. Note that necessary modules (@var{luks}, @var{luks2} and @var{geli}) have to be loaded manually before this command can be used. For LUKS2 only the PBKDF2 key derivation |