Date: Sat, 11 Jan 2020 02:54:42 +0000 From: bugzilla-noreply@freebsd.org To: bugs@FreeBSD.org Subject: [Bug 243261] geli manpage needs to add detail about the loader variables Message-ID: <bug-243261-227@https.bugs.freebsd.org/bugzilla/>
next in thread | raw e-mail | index | archive | help
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.=
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?bug-243261-227>