Received: from list by lists.gnu.org with archive (Exim 4.90_1) id 1ndnm5-0005uk-8B for mharc-grub-devel@gnu.org; Mon, 11 Apr 2022 02:43:46 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:40472) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ndnm1-0005te-9t for grub-devel@gnu.org; Mon, 11 Apr 2022 02:43:41 -0400 Received: from mail-qk1-x735.google.com ([2607:f8b0:4864:20::735]:44889) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ndnlz-0004jR-Ps for grub-devel@gnu.org; Mon, 11 Apr 2022 02:43:41 -0400 Received: by mail-qk1-x735.google.com with SMTP id b189so9890881qkf.11 for ; Sun, 10 Apr 2022 23:43:39 -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=JHsrqW797G1ClE66mHh8FMK0d2IxxKMc9UnTb3yZf8s=; b=Un0gHU5SCGEDGRHnpVcfovPJxC05Dd+yna7qfRrnAl9K8/9ZMkjOgGXNulT0Dhy0T0 xCMxZvTmPhY+od+t8tPkjqF2LoSflAhSKaRZAHJv0qSWYCQWbJOI8jzKNJcRdhVGx/Vd q6/RNgV29eeJF+u4jFmRmVB4zu/gNguHNc373CRvWcci7amQpqMMeya7Psmx/ssmYZry +VvPyIBIaHIW/y3Zsu640HVfBh49xy/wAMBpVN2aQkWKNJHKa5PhQIgLnu9TrY+MgT0T M5EqUVbJkC+lLWPNB3CCa1TWH849W/88auNJw+2FNMsTjU/NRWwjW308GLmAXDdyrhRN n2aw== 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=JHsrqW797G1ClE66mHh8FMK0d2IxxKMc9UnTb3yZf8s=; b=ZpSiRC5rXle1LaCbIzM/xpSdnawc4F+m6heM+ME4Oa9BvE3eNObTo4Y/Yd849xwFNK HacIW6Bye3W/jyr2LE2CX+K9MUss39L1VV4+6rVYX5iAX85YwqZvisjH+TB58lknures m/9Ybjd++SstucR/HclF49EoiOGaRwHGFK3KP78U8PwvAgKfP0RBuN+Gc2BQVLQMNi78 q/T4uKXXaZ4ky7tPVppmDsPh4ElBFsCYpkM0P6baBAQsoiEQv0Z3XC6L9KKqygtWF1uS gZW4VZ2ULd6oXbHQg3f6gtuERDJvcPWWdQ/o3jGWi1ZEbBgf1Ez3j2bb4ZnrQHjchIA/ RuGQ== X-Gm-Message-State: AOAM532bjvc0JiQcyjax1l+LOKblZ+BQgFNfmX4XTw2tIW9nxCz+xT3i yRN21ckkVveueqQG/4VxrMx8FxBZHTrdCQ== X-Google-Smtp-Source: ABdhPJwc7mCIm8XQqXNHz/BBv+W6VNgAv6jMsWjvrm2wF41cJj1Ecy1uE1Zpti11EHqw67rp7whZzA== X-Received: by 2002:a05:620a:28cc:b0:67d:b5f0:8d49 with SMTP id l12-20020a05620a28cc00b0067db5f08d49mr20472718qkp.100.1649659418940; Sun, 10 Apr 2022 23:43:38 -0700 (PDT) Received: from localhost.localdomain (yal.riseup.net. [199.58.83.9]) by smtp.gmail.com with ESMTPSA id i19-20020a05620a27d300b0069c1c7986eesm1662307qkp.89.2022.04.10.23.43.37 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 10 Apr 2022 23:43:38 -0700 (PDT) From: Glenn Washburn To: grub-devel@gnu.org, Daniel Kiper Cc: Denis 'GNUtoo' Carikli , Patrick Steinhardt , John Lane , Glenn Washburn Subject: [PATCH v9 7/7] docs: Add documentation on keyfile and detached header options to cryptomount Date: Mon, 11 Apr 2022 06:40:28 +0000 Message-Id: <53ba137d3bc2ac15b9f570c793d2ca09b3fb520e.1649658484.git.development@efficientek.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Received-SPF: pass client-ip=2607:f8b0:4864:20::735; envelope-from=development@efficientek.com; helo=mail-qk1-x735.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, 11 Apr 2022 06:43:41 -0000 Signed-off-by: Glenn Washburn --- docs/grub.texi | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/grub.texi b/docs/grub.texi index 9835c878af..c1bf532636 100644 --- a/docs/grub.texi +++ b/docs/grub.texi @@ -4347,11 +4347,17 @@ Alias for @code{hashsum --hash crc32 arg @dots{}}. See command @command{hashsum} @node cryptomount @subsection cryptomount -@deffn Command cryptomount [@option{-p} password] device|@option{-u} uuid|@option{-a}|@option{-b} -Setup access to encrypted device. If @option{-p} is not given, a passphrase -is requested interactively. Otherwise, the given @var{password} will be used and -no passphrase will be requested interactively. -Option @var{device} configures specific grub device +@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. 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. -- 2.25.1