From owner-freebsd-bugs@freebsd.org Sat Jan 11 02:54:43 2020 Return-Path: Delivered-To: freebsd-bugs@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id BAE941FB676 for ; Sat, 11 Jan 2020 02:54:43 +0000 (UTC) (envelope-from bugzilla-noreply@freebsd.org) Received: from mailman.nyi.freebsd.org (unknown [127.0.1.3]) by mx1.freebsd.org (Postfix) with ESMTP id 47vkwM4Fndz4ScJ for ; Sat, 11 Jan 2020 02:54:43 +0000 (UTC) (envelope-from bugzilla-noreply@freebsd.org) Received: by mailman.nyi.freebsd.org (Postfix) id 91F2F1FB675; Sat, 11 Jan 2020 02:54:43 +0000 (UTC) Delivered-To: bugs@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id 91B5B1FB674 for ; Sat, 11 Jan 2020 02:54:43 +0000 (UTC) (envelope-from bugzilla-noreply@freebsd.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) server-signature RSA-PSS (4096 bits) client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 47vkwM1T8rz4ScH for ; Sat, 11 Jan 2020 02:54:43 +0000 (UTC) (envelope-from bugzilla-noreply@freebsd.org) Received: from kenobi.freebsd.org (kenobi.freebsd.org [IPv6:2610:1c1:1:606c::50:1d]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 2D95524073 for ; Sat, 11 Jan 2020 02:54:43 +0000 (UTC) (envelope-from bugzilla-noreply@freebsd.org) Received: from kenobi.freebsd.org ([127.0.1.5]) by kenobi.freebsd.org (8.15.2/8.15.2) with ESMTP id 00B2shkJ098363 for ; Sat, 11 Jan 2020 02:54:43 GMT (envelope-from bugzilla-noreply@freebsd.org) Received: (from www@localhost) by kenobi.freebsd.org (8.15.2/8.15.2/Submit) id 00B2shHr098362 for bugs@FreeBSD.org; Sat, 11 Jan 2020 02:54:43 GMT (envelope-from bugzilla-noreply@freebsd.org) X-Authentication-Warning: kenobi.freebsd.org: www set sender to bugzilla-noreply@freebsd.org using -f From: bugzilla-noreply@freebsd.org To: bugs@FreeBSD.org Subject: [Bug 243261] geli manpage needs to add detail about the loader variables Date: Sat, 11 Jan 2020 02:54:42 +0000 X-Bugzilla-Reason: AssignedTo X-Bugzilla-Type: new X-Bugzilla-Watch-Reason: None X-Bugzilla-Product: Documentation X-Bugzilla-Component: Manual Pages X-Bugzilla-Version: Latest X-Bugzilla-Keywords: X-Bugzilla-Severity: Affects Only Me X-Bugzilla-Who: johannes@jo-t.de X-Bugzilla-Status: New X-Bugzilla-Resolution: X-Bugzilla-Priority: --- X-Bugzilla-Assigned-To: bugs@FreeBSD.org X-Bugzilla-Flags: X-Bugzilla-Changed-Fields: bug_id short_desc product version rep_platform op_sys bug_status bug_severity priority component assigned_to reporter cc Message-ID: Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable X-Bugzilla-URL: https://bugs.freebsd.org/bugzilla/ Auto-Submitted: auto-generated MIME-Version: 1.0 X-BeenThere: freebsd-bugs@freebsd.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Bug reports List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 11 Jan 2020 02:54:43 -0000 https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=3D243261 Bug ID: 243261 Summary: geli manpage needs to add detail about the loader variables Product: Documentation Version: Latest Hardware: Any OS: Any Status: New Severity: Affects Only Me Priority: --- Component: Manual Pages Assignee: bugs@FreeBSD.org Reporter: johannes@jo-t.de CC: doc@FreeBSD.org The geli manpage has an example for preloading keyfiles during boot. There is no detail though on how the lookup of these variables actually wor= ks. There seems to be some magic "geli_$device_..." pattern. I've checked the source to find out how it works because i've wasted quite a bit of time trying to make sense and come up with the correct magic of the geli/device/keyfile combination. Turns out none of that matters. I propose to add something like (sorry I know nothing about manpage syntax): diff --git a/lib/geom/eli/geli.8 b/lib/geom/eli/geli.8 index 43ca9a2928c..ee994d544cf 100644 --- a/lib/geom/eli/geli.8 +++ b/lib/geom/eli/geli.8 @@ -1013,6 +1013,12 @@ geli_da1s3a_keyfile_type=3D"da1s3a:geli_keyfile" geli_da1s3a_keyfile_name=3D"/boot/keys/da1s3a.key" .Ed .Pp +By convention, these loader variables are called geli_$device_load. Howeve= r, the +actual name prefix before _load/_type/_name does not matter. At boot time,= the +geli module will search through all $something_type that have a value of +"$device:geli_keyfile", leading to $something_name with has the path to the keyfile. +In the example above, $something is "geli_da1s3a_keyfile". +.Pp Not only configure encryption, but also data integrity verification using .Nm HMAC/SHA256 . .Bd -literal -offset indent --=20 You are receiving this mail because: You are the assignee for the bug.=