Received: from list by lists.gnu.org with archive (Exim 4.90_1) id 1nqibw-0001rI-OS for mharc-grub-devel@gnu.org; Mon, 16 May 2022 17:50:40 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:41296) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nqibf-0001b8-Lt for grub-devel@gnu.org; Mon, 16 May 2022 17:50:23 -0400 Received: from mail-vs1-xe30.google.com ([2607:f8b0:4864:20::e30]:34588) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nqibe-000878-2V for grub-devel@gnu.org; Mon, 16 May 2022 17:50:23 -0400 Received: by mail-vs1-xe30.google.com with SMTP id b7so12594604vsq.1 for ; Mon, 16 May 2022 14:50:20 -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=4pS26tWrKdLbqYKTpPRZG4t4AG50mAkPWTp/dylg5SM=; b=IyNz7k7/+Ot+Z+jH3fNJ0aiprrtQwvXr6KIu+cD4XPdHbawcAqazS5RKcz80L13WCg nZZmfidlcp/xjCeuroBvc/t8FSvKEeb6fVwgvSmhq5qcyvqc9D2WQ6y4P8T7oW7cY9NA TmSast3qJ2ycf1HKEy6Dk6Sr7Z684u3bkfebi3ObUr1kYOKH8S6akxsFN2nJdujMxAgM hAPexdH49uxzDgIe9e7GwVyWF66WPaVTw4t4hMAttOObA3GmdLzmxmvdd2SNbbN22J1a 2x0Jgb12EeJ1svFx+lT91Tm+cI/RW0k8kzWqJeDRGJo6iT/bIcOhDgBPrzKbCU9Kt1AX VgPg== 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=4pS26tWrKdLbqYKTpPRZG4t4AG50mAkPWTp/dylg5SM=; b=BR7HOM60tsQceePCI+z5Jh5NXc+huuTHxINaYuPgxwKYmvLHbbDZpEIkKuM269SSaG lysZzWrdtuXj2GBDUtQwfghRWHB5vzzmRa0HJFX1f0zIIP0NGdt/c19dy3Xv+dl7ZNXF myQDR55gBA4vU+7MAUyyfeknpd3amLZbW2glf3/0CWe1ywzc7mdqrpjFgE8r76ZArztM mU0U2ycPd37eR+AABRmsCoBJ/EVzk3uNjYT0vws79mDHqxH4rc8B3c0ciT2mB2qecRF6 n0/1OqzjlBkgNHNKblMEHczhwEliUH96QwS95X5L0GYSlKcHva77/p6Whi3FnJ6ki4j4 kwIg== X-Gm-Message-State: AOAM532qVryOCHfyc8+D+VN6lksDbX8QRKfp62VDR7A37SXrysxY7t36 nqltLV5x4+Xt6dso4S8gk9+9/ie4g52546CI X-Google-Smtp-Source: ABdhPJwT9zJ1AEDCF1+NTTDnDffvT2l3PEHxzrg045Avg1Q5fVafOBsmd7Z5y0moEMxYE4BVdso0Vg== X-Received: by 2002:a67:d083:0:b0:32c:dae3:bf5d with SMTP id s3-20020a67d083000000b0032cdae3bf5dmr7140088vsi.65.1652737819525; Mon, 16 May 2022 14:50:19 -0700 (PDT) Received: from localhost.localdomain ([37.218.244.249]) by smtp.gmail.com with ESMTPSA id z7-20020a673307000000b0032d275e691esm1018581vsz.30.2022.05.16.14.50.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 16 May 2022 14:50:19 -0700 (PDT) From: Glenn Washburn To: grub-devel@gnu.org, Daniel Kiper Cc: Denis 'GNUtoo' Carikli , Patrick Steinhardt , John Lane , Glenn Washburn Subject: [PATCH v2 3/3] docs: Add documentation on detached header option to cryptomount Date: Mon, 16 May 2022 16:49:48 -0500 Message-Id: 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::e30; envelope-from=development@efficientek.com; helo=mail-vs1-xe30.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: Mon, 16 May 2022 21:50:24 -0000 Signed-off-by: Glenn Washburn --- docs/grub.texi | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/grub.texi b/docs/grub.texi index 0a8057482..a741034dd 100644 --- a/docs/grub.texi +++ b/docs/grub.texi @@ -4490,19 +4490,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