Tue Jun 23 13:23:56 2020 UTC ()
cgdconfig.8: remove references to using cgd for swap

this is potentially misleading now that the kernel does swap encryption


(nia)
diff -r1.45 -r1.46 src/sbin/cgdconfig/cgdconfig.8
cvs diff -r1.45 -r1.46 src/sbin/cgdconfig/cgdconfig.8 (expand / switch to unified diff)

--- src/sbin/cgdconfig/cgdconfig.8 2020/06/23 13:20:14 1.45
+++ src/sbin/cgdconfig/cgdconfig.8 2020/06/23 13:23:56 1.46
@@ -1,14 +1,14 @@ @@ -1,14 +1,14 @@
1.\" $NetBSD: cgdconfig.8,v 1.45 2020/06/23 13:20:14 nia Exp $ 1.\" $NetBSD: cgdconfig.8,v 1.46 2020/06/23 13:23:56 nia Exp $
2.\" 2.\"
3.\" Copyright (c) 2002, The NetBSD Foundation, Inc. 3.\" Copyright (c) 2002, The NetBSD Foundation, Inc.
4.\" All rights reserved. 4.\" All rights reserved.
5.\" 5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation 6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Roland C. Dowdeswell. 7.\" by Roland C. Dowdeswell.
8.\" 8.\"
9.\" Redistribution and use in source and binary forms, with or without 9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions 10.\" modification, are permitted provided that the following conditions
11.\" are met: 11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright 12.\" 1. Redistributions of source code must retain the above copyright
13.\" notice, this list of conditions and the following disclaimer. 13.\" notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" 2. Redistributions in binary form must reproduce the above copyright
@@ -168,38 +168,37 @@ It is retained for backwards compatibili @@ -168,38 +168,37 @@ It is retained for backwards compatibili
168files, and will be removed. 168files, and will be removed.
169Existing parameters files should be 169Existing parameters files should be
170converted to use the correct method using the 170converted to use the correct method using the
171.Fl G 171.Fl G
172option, and a new passphrase. 172option, and a new passphrase.
173.It storedkey 173.It storedkey
174This method stores its key in the parameters file. 174This method stores its key in the parameters file.
175.It randomkey 175.It randomkey
176The method simply reads 176The method simply reads
177.Pa /dev/random 177.Pa /dev/random
178and uses the resulting bits as the key. 178and uses the resulting bits as the key.
179It does not require a passphrase to be entered. 179It does not require a passphrase to be entered.
180This method is typically used to present disk devices that do not 180This method is typically used to present disk devices that do not
181need to survive a reboot, such as the swap partition. 181need to survive a reboot.
182It is also handy to facilitate overwriting the contents of 182It is also handy to facilitate overwriting the contents of
183a disk volume with meaningless data prior to use. 183a disk volume with meaningless data prior to use.
184.It urandomkey 184.It urandomkey
185The method simply reads 185The method simply reads
186.Pa /dev/urandom 186.Pa /dev/urandom
187and uses the resulting bits as the key. 187and uses the resulting bits as the key.
188This is similar to the 188This is similar to the
189.Pa randomkey 189.Pa randomkey
190method, but it guarantees that cgdconfig will not stall waiting for 256 190method, but it guarantees that cgdconfig will not stall waiting for 256
191bits of entropy from a hardware RNG or seed (useful when configuring a 191bits of entropy from a hardware RNG or seed.
192cgd for swap at boot time). 
193.It shell_cmd 192.It shell_cmd
194This method executes a shell command via 193This method executes a shell command via
195.Xr popen 3 194.Xr popen 3
196and reads the key from stdout. 195and reads the key from stdout.
197.El 196.El
198.Ss Verification Method 197.Ss Verification Method
199The verification method is how 198The verification method is how
200.Nm 199.Nm
201determines if the generated key is correct. 200determines if the generated key is correct.
202If the newly configured disk fails to verify, then 201If the newly configured disk fails to verify, then
203.Nm 202.Nm
204will regenerate the key and re-configure the device. 203will regenerate the key and re-configure the device.
205It only makes sense to specify a verification method if at least one of the 204It only makes sense to specify a verification method if at least one of the