Received: from list by lists.gnu.org with archive (Exim 4.90_1) id 1nyxho-0004rX-5b for mharc-grub-devel@gnu.org; Wed, 08 Jun 2022 11:34:48 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:45752) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nyxhl-0004mM-UC for grub-devel@gnu.org; Wed, 08 Jun 2022 11:34:45 -0400 Received: from mail-vs1-xe32.google.com ([2607:f8b0:4864:20::e32]:38696) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nyxhk-0004go-BZ for grub-devel@gnu.org; Wed, 08 Jun 2022 11:34:45 -0400 Received: by mail-vs1-xe32.google.com with SMTP id f1so7536552vsv.5 for ; Wed, 08 Jun 2022 08:34:43 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=efficientek-com.20210112.gappssmtp.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=c+0Tvl0mZt+oz/Rm6QNvn/nZ1NE5e+zzWfU/+ZcDyhI=; b=ZQM1ykc9d3DvxuNfQ8ndEw9F8y2UzNvNrbHwzkiG+b1BKzkBo2OAa9npLFgSHEiUNl JTb4o3CoVS1bx2DFD0vZ180m7oXD8I8s6s26jpPj4zKECHDn3hZ0vAw6LvhfiaRgcmNz 32fyhowIhjVFHHqdyL4BlGthTkJvAF+pqWvNTNTlju4/pyr3/3Uzp9IHW/m+hfs0p9zG ZzN/hsw8LjqAb6vG1jxyHfAYulSovlpRiZ2S6A9b9Vxy108RlHWp5T9Oxd9D74iDGC0w DUpYbpy0UAZpq7bC1hXe1n2PR6nbkI7Ztyss/UyRZlzAZfFhu3R8ubba7LkN5Pg2YQ9c H/1Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=c+0Tvl0mZt+oz/Rm6QNvn/nZ1NE5e+zzWfU/+ZcDyhI=; b=vEBx1KyemiEQ0iJcN/lwnEa3iaCjKBUL9dIR7bjb4fg0VhwFW+YSgSZ6mJobsrDqJQ jZvgoNtdN0U6anPLCRT+ohuTeW6/3WpY9kF7nFmAW3PpnD4lzvZ7Kxq+HVeb3ccO0vQh iu1wdLdqONqJbB8gYxPSni++duNMH4/Ed709rhkEZm8yJNZkJIdXOyQKwNvj913uTlkF 2CRb1vQw2BFcu5v/mbmvj74gv6nJ3OsE41m8DGwePb+W7oTiadxa+ptfbCs4YpWnsJOG MWf88+bLr4pU3m9KRN0bMxOHVA30a6Cll3L0NjP62Dn5fna2Aa7/lzzZaKdKPjMU4Ssg Ag+Q== X-Gm-Message-State: AOAM53265ezjJQmGxDQCogTwzIUCnFSbuVDrG8smFhE7LBB7C3tomMZr QoA0a/LnJ38TpPaW4+BTLauJ5soGNkIxEQ== X-Google-Smtp-Source: ABdhPJzgkh6c/fpjCmWfEv/miaxONFhW3C/jmi9clR6VCwarfOcMtB7/J7soircrS9EAhuzjR1qfqA== X-Received: by 2002:a67:26c3:0:b0:348:2498:54bf with SMTP id m186-20020a6726c3000000b00348249854bfmr14653536vsm.21.1654702483287; Wed, 08 Jun 2022 08:34:43 -0700 (PDT) Received: from localhost.localdomain ([37.218.244.249]) by smtp.gmail.com with ESMTPSA id s13-20020ac5cb4d000000b00357c1bab9b0sm3373342vkl.36.2022.06.08.08.34.41 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 08 Jun 2022 08:34:42 -0700 (PDT) From: Glenn Washburn To: grub-devel@gnu.org, Daniel Kiper Cc: Denis 'GNUtoo' Carikli , Patrick Steinhardt , John Lane , Glenn Washburn Subject: [PATCH v3 3/3] docs: Add documentation on detached header option to cryptomount Date: Wed, 8 Jun 2022 10:34:04 -0500 Message-Id: <2deb90d3319002df3736441afd64805d6ec5959f.1654702130.git.development@efficientek.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Received-SPF: pass client-ip=2607:f8b0:4864:20::e32; envelope-from=development@efficientek.com; helo=mail-vs1-xe32.google.com X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: grub-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: The development of GNU GRUB List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 08 Jun 2022 15:34:46 -0000 Signed-off-by: Glenn Washburn Reviewed-by: Patrick Steinhardt --- docs/grub.texi | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/grub.texi b/docs/grub.texi index 1a7cd8e93..3c7217f0e 100644 --- a/docs/grub.texi +++ b/docs/grub.texi @@ -4526,19 +4526,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 -- 2.34.1