1 .\" Copyright (c) 2005-2011 Pawel Jakub Dawidek <pawel@dawidek.net>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .Nd "control utility for the cryptographic GEOM class"
34 To compile GEOM_ELI into your kernel, add the following lines to your kernel
36 .Bd -ragged -offset indent
38 .Cd "options GEOM_ELI"
41 Alternatively, to load the GEOM_ELI module at boot time, add the following line
44 .Bd -literal -offset indent
56 .Op Fl B Ar backupfile
58 .Op Fl i Ar iterations
59 .Op Fl J Ar newpassfile
60 .Op Fl K Ar newkeyfile
62 .Op Fl s Ar sectorsize
66 .Cm label - an alias for
79 .Cm stop - an alias for
87 .Op Fl s Ar sectorsize
96 .Op Fl i Ar iterations
98 .Op Fl J Ar newpassfile
100 .Op Fl K Ar newkeyfile
159 utility is used to configure encryption on GEOM providers.
161 The following is a list of the most important features:
163 .Bl -bullet -offset indent -compact
167 framework, so when there is crypto hardware available,
169 will make use of it automatically.
171 Supports many cryptographic algorithms (currently
179 Can optionally perform data authentication (integrity verification) utilizing
180 one of the following algorithms:
189 Can create a User Key from up to two, piecewise components: a passphrase
190 entered via prompt or read from one or more passfiles; a keyfile read from
193 Allows encryption of the root partition.
194 The user will be asked for the
195 passphrase before the root file system is mounted.
197 Strengthens the passphrase component of the User Key with:
200 .%T "PKCS #5: Password-Based Cryptography Specification, Version 2.0."
205 Allows the use of two independent User Keys (e.g., a
208 .Qq "company key" ) .
212 performs simple sector-to-sector encryption.
214 Allows the encrypted Master Key to be backed up and restored,
215 so that if a user has to quickly destroy key material,
216 it is possible to get the data back by restoring keys from
219 Providers can be configured to automatically detach on last close
220 (so users do not have to remember to detach providers after unmounting
223 Allows attaching a provider with a random, one-time Master Key -
224 useful for swap partitions and temporary file systems.
226 Allows verification of data integrity (data authentication).
228 Allows suspending and resuming encrypted devices.
231 The first argument to
233 indicates an action to be performed:
234 .Bl -tag -width ".Cm configure"
236 Initialize the provider which needs to be encrypted.
237 Here you can set up the cryptographic algorithm to use, Data Key length,
239 The last sector of the provider is used to store metadata.
242 subcommand also automatically writes metadata backups to
243 .Pa /var/backups/<prov>.eli
245 The metadata can be recovered with the
247 subcommand described below.
249 Additional options include:
250 .Bl -tag -width ".Fl J Ar newpassfile"
252 Enable data integrity verification (authentication) using the given algorithm.
253 This will reduce the size of storage available and also reduce speed.
254 For example, when using 4096 bytes sector and
256 algorithm, 89% of the original provider storage will be available for use.
257 Currently supported algorithms are:
265 If the option is not given, there will be no authentication, only encryption.
266 The recommended algorithm is
269 Try to decrypt this partition during boot, before the root partition is mounted.
270 This makes it possible to use an encrypted root partition.
271 One will still need bootable unencrypted storage with a
273 directory, which can be a CD-ROM disc or USB pen-drive, that can be removed
275 .It Fl B Ar backupfile
276 File name to use for metadata backup instead of the default
277 .Pa /var/backups/<prov>.eli .
278 To inhibit backups, you can use
283 When entering the passphrase to boot from this encrypted root filesystem, echo
286 This makes the length of the passphrase visible.
288 Encryption algorithm to use.
289 Currently supported algorithms are:
297 The default and recommended algorithm is
302 Enable booting from this encrypted root filesystem.
303 The boot loader prompts for the passphrase and loads
305 from the encrypted partition.
306 .It Fl i Ar iterations
307 Number of iterations to use with PKCS#5v2 when processing User Key
308 passphrase component.
309 If this option is not specified,
311 will find the number of iterations which is equal to 2 seconds of crypto work.
312 If 0 is given, PKCS#5v2 will not be used.
313 PKCS#5v2 processing is performed once, after all parts of the passphrase
314 component have been read.
315 .It Fl J Ar newpassfile
316 Specifies a file which contains the passphrase component of the User Key
320 is given as -, standard input will be used.
321 Only the first line (excluding new-line character) is taken from the given file.
322 This argument can be specified multiple times, which has the effect of
323 reassembling a single passphrase split across multiple files.
324 Cannot be combined with the
327 .It Fl K Ar newkeyfile
328 Specifies a file which contains the keyfile component of the User Key
332 is given as -, standard input will be used.
333 This argument can be specified multiple times, which has the effect of
334 reassembling a single keyfile split across multiple keyfile parts.
336 Data Key length to use with the given cryptographic algorithm.
337 If the length is not specified, the selected algorithm uses its
340 .Bl -ohang -offset indent
344 .It Nm AES-CBC , Nm Camellia-CBC
350 + n * 32, for n=[0..10]
355 Do not use a passphrase as a component of the User Key.
356 Cannot be combined with the
359 .It Fl s Ar sectorsize
360 Change decrypted provider's sector size.
361 Increasing the sector size allows increased performance,
362 because encryption/decryption which requires an initialization vector
363 is done per sector; fewer sectors means less computational work.
367 calls (i.e., TRIM/UNMAP).
368 This can prevent an attacker from knowing how much space you're actually
369 using and which sectors contain live data, but will also prevent the
370 backing store (SSD, etc) from reclaiming space you're not using, which
371 may degrade its performance and lifespan.
372 The underlying provider may or may not actually obliterate the deleted
373 sectors when TRIM is enabled, so it should not be considered to add any
376 Metadata version to use.
377 This option is helpful when creating a provider that may be used by older
382 section to find which metadata version is supported by which FreeBSD version.
383 Note that using an older version of metadata may limit the number of
387 Attach the given provider.
388 The encrypted Master Key will be loaded from the metadata and decrypted
389 using the given passphrase/keyfile and a new GEOM provider will be created
390 using the given provider's name with an
394 Additional options include:
395 .Bl -tag -width ".Fl j Ar passfile"
397 If specified, a decrypted provider will be detached automatically on last close.
398 This can help with scarce memory so the user does not have to remember to detach the
399 provider after unmounting the file system.
400 It only works when the provider was opened for writing, so it will not work if
401 the file system on the provider is mounted read-only.
402 Probably a better choice is the
408 Specifies a file which contains the passphrase component of the User Key
410 For more information see the description of the
416 Specifies a file which contains the keyfile component of the User Key
418 For more information see the description of the
424 Do a dry-run decryption.
425 This is useful to verify passphrase and keyfile without decrypting the device.
427 Do not use a passphrase as a component of the User Key.
428 Cannot be combined with the
432 Attach read-only provider.
433 It will not be opened for writing.
436 Detach the given providers, which means remove the devfs entry
437 and clear the Master Key and Data Keys from memory.
439 Additional options include:
440 .Bl -tag -width ".Fl f"
442 Force detach - detach even if the provider is open.
444 Mark provider to detach on last close.
445 If this option is specified, the provider will not be detached
446 while it is open, but will be automatically detached when it is closed for the
447 last time even if it was only opened for reading.
450 Attach the given providers with a random, one-time (ephemeral) Master Key.
451 The command can be used to encrypt swap partitions or temporary file systems.
453 Additional options include:
454 .Bl -tag -width ".Fl a Ar sectorsize"
456 Enable data integrity verification (authentication).
457 For more information, see the description of the
461 Encryption algorithm to use.
462 For more information, see the description of the
466 Detach on last close.
467 Note: this option is not usable for temporary file systems as the provider will
468 be detached after creating the file system on it.
469 It still can (and should be) used for swap partitions.
470 For more information, see the description of the
474 Data Key length to use with the given cryptographic algorithm.
475 For more information, see the description of the
478 .It Fl s Ar sectorsize
479 Change decrypted provider's sector size.
480 For more information, see the description of the
484 Disable TRIM/UNMAP passthru.
485 For more information, see the description of the
490 Change configuration of the given providers.
492 Additional options include:
493 .Bl -tag -width ".Fl b"
495 Set the BOOT flag on the given providers.
496 For more information, see the description of the
500 Remove the BOOT flag from the given providers.
502 When entering the passphrase to boot from this encrypted root filesystem, echo
505 This makes the length of the passphrase visible.
507 Disable echoing of any characters when a passphrase is entered to boot from this
508 encrypted root filesystem.
509 This hides the passphrase length.
511 Enable booting from this encrypted root filesystem.
512 The boot loader prompts for the passphrase and loads
514 from the encrypted partition.
516 Deactivate booting from this encrypted root partition.
518 Enable TRIM/UNMAP passthru.
519 For more information, see the description of the
523 Disable TRIM/UNMAP passthru.
526 Install a copy of the Master Key into the selected slot, encrypted with
528 If the selected slot is populated, replace the existing copy.
529 A provider has one Master Key, which can be stored in one or both slots,
530 each encrypted with an independent User Key.
533 subcommand, only key number 0 is initialized.
534 The User Key can be changed at any time: for an attached provider,
535 for a detached provider, or on the backup file.
536 When a provider is attached, the user does not have to provide
537 an existing passphrase/keyfile.
539 Additional options include:
540 .Bl -tag -width ".Fl J Ar newpassfile"
541 .It Fl i Ar iterations
542 Number of iterations to use with PKCS#5v2.
543 If 0 is given, PKCS#5v2 will not be used.
544 To be able to use this option with the
546 subcommand, only one key has to be defined and this key must be changed.
548 Specifies a file which contains the passphrase component of a current User Key
550 .It Fl J Ar newpassfile
551 Specifies a file which contains the passphrase component of the new User Key
554 Specifies a file which contains the keyfile component of a current User Key
556 .It Fl K Ar newkeyfile
557 Specifies a file which contains the keyfile component of the new User Key
560 Specifies the index number of the Master Key copy to change (could be 0 or 1).
561 If the provider is attached and no key number is given, the key
562 used for attaching the provider will be changed.
563 If the provider is detached (or we are operating on a backup file)
564 and no key number is given, the first Master Key copy to be successfully
565 decrypted with the provided User Key passphrase/keyfile will be changed.
567 Do not use a passphrase as a component of the current User Key.
568 Cannot be combined with the
572 Do not use a passphrase as a component of the new User Key.
573 Cannot be combined with the
578 Destroy (overwrite with random data) the selected Master Key copy.
579 If one is destroying keys for an attached provider, the provider
580 will not be detached even if all copies of the Master Key are destroyed.
581 It can even be rescued with the
583 subcommand because the Master Key is still in memory.
585 Additional options include:
586 .Bl -tag -width ".Fl a Ar keyno"
588 Destroy all copies of the Master Key (does not need
592 Force key destruction.
593 This option is needed to destroy the last copy of the Master Key.
595 Specifies the index number of the Master Key copy.
596 If the provider is attached and no key number is given, the key
597 used for attaching the provider will be destroyed.
598 If provider is detached (or we are operating on a backup file) the key number
602 This command should be used only in emergency situations.
603 It will destroy all copies of the Master Key on a given provider and will
604 detach it forcibly (if it is attached).
605 This is absolutely a one-way command - if you do not have a metadata
606 backup, your data is gone for good.
607 In case the provider was attached with the
609 flag, the keys will not be destroyed, only the provider will be detached.
611 Additional options include:
612 .Bl -tag -width ".Fl a"
614 If specified, all currently attached providers will be killed.
617 Backup metadata from the given provider to the given file.
619 Restore metadata from the given file to the given provider.
621 Additional options include:
622 .Bl -tag -width ".Fl f"
624 Metadata contains the size of the provider to ensure that the correct
625 partition or slice is attached.
626 If an attempt is made to restore metadata to a provider that has a different
629 will refuse to restore the data unless the
632 If the partition or slice has been grown, the
634 subcommand should be used rather than attempting to relocate the metadata
641 Suspend device by waiting for all inflight requests to finish, clearing all
642 sensitive information (like the Master Key and Data Keys) from kernel memory,
643 and blocking all further I/O requests until the
645 subcommand is executed.
646 This functionality is useful for laptops: when one wants to suspend a
647 laptop, one does not want to leave an encrypted device attached.
648 Instead of closing all files and directories opened from a file system located
649 on an encrypted device, unmounting the file system, and detaching the device,
652 subcommand can be used.
653 Any access to the encrypted device will be blocked until the Master Key is
657 Thus there is no need to close nor unmount anything.
660 subcommand does not work with devices created with the
663 Please note that sensitive data might still be present in memory after
664 suspending an encrypted device due to the file system cache, etc.
666 Additional options include:
667 .Bl -tag -width ".Fl a"
674 Resume previously suspended device.
675 The caller must ensure that executing this subcommand does not access the
676 suspended device, leading to a deadlock.
677 For example suspending a device which contains the file system where the
679 utility is stored is bad idea.
681 Additional options include:
682 .Bl -tag -width ".Fl j Ar passfile"
684 Specifies a file which contains the passphrase component of the User Key
686 For more information see the description of the
692 Specifies a file which contains the keyfile component of the User Key
694 For more information see the description of the
700 Do not use a passphrase as a component of the User Key.
701 Cannot be combined with the
708 that the provider has been resized.
709 The old metadata block is relocated to the correct position at the end of the
710 provider and the provider size is updated.
712 Additional options include:
713 .Bl -tag -width ".Fl s Ar oldsize"
715 The size of the provider before it was resized.
718 If no arguments are given, the
720 subcommand will print the version of
722 userland utility as well as the version of the
726 If GEOM providers are specified, the
728 subcommand will print metadata version used by each of them.
730 Clear metadata from the given providers.
732 This will erase with zeros the encrypted Master Key copies stored in the
735 Dump metadata stored on the given providers.
750 Additional options include:
751 .Bl -tag -width ".Fl v"
761 utility generates a random Master Key for the provider.
762 The Master Key never changes during the lifetime of the provider.
763 Each copy of the provider metadata, active or backed up to a file, can store
764 up to two, independently-encrypted copies of the Master Key.
766 Each stored copy of the Master Key is encrypted with a User Key, which
769 utility from a passphrase and/or a keyfile.
772 utility first reads all parts of the keyfile in the order specified on the
773 command line, then reads all parts of the stored passphrase in the order
774 specified on the command line.
775 If no passphrase parts are specified, the system prompts the user to enter
777 The passphrase is optionally strengthened by PKCS#5v2.
778 The User Key is a digest computed over the concatenated keyfile and passphrase.
780 During operation, one or more Data Keys are deterministically derived by
781 the kernel from the Master Key and cached in memory.
782 The number of Data Keys used by a given provider, and the way they are
783 derived, depend on the GELI version and whether the provider is configured to
784 use data authentication.
788 variables can be used to control the behavior of the
791 The default value is shown next to each variable.
792 Some variables can also be set in
793 .Pa /boot/loader.conf .
794 .Bl -tag -width indent
795 .It Va kern.geom.eli.version
796 Version number of the
799 .It Va kern.geom.eli.debug : No 0
803 This can be set to a number between 0 and 3 inclusive.
804 If set to 0, minimal debug information is printed.
806 maximum amount of debug information is printed.
807 .It Va kern.geom.eli.tries : No 3
808 Number of times a user is asked for the passphrase.
809 This is only used for providers which are attached on boot
810 (before the root file system is mounted).
811 If set to 0, attaching providers on boot will be disabled.
812 This variable should be set in
813 .Pa /boot/loader.conf .
814 .It Va kern.geom.eli.overwrites : No 5
815 Specifies how many times the Master Key will be overwritten
816 with random values when it is destroyed.
817 After this operation it is filled with zeros.
818 .It Va kern.geom.eli.visible_passphrase : No 0
819 If set to 1, the passphrase entered on boot (before the root
820 file system is mounted) will be visible.
821 This alternative should be used with caution as the entered
822 passphrase can be logged and exposed via
824 This variable should be set in
825 .Pa /boot/loader.conf .
826 .It Va kern.geom.eli.threads : No 0
827 Specifies how many kernel threads should be used for doing software
829 Its purpose is to increase performance on SMP systems.
830 If set to 0, a CPU-pinned thread will be started for every active CPU.
831 .It Va kern.geom.eli.batch : No 0
832 When set to 1, can speed-up crypto operations by using batching.
833 Batching reduces the number of interrupts by responding to a group of
834 crypto requests with one interrupt.
835 The crypto card and the driver has to support this feature.
836 .It Va kern.geom.eli.key_cache_limit : No 8192
837 Specifies how many Data Keys to cache.
839 (8192 keys) will allow caching of all keys for a 4TB provider with 512 byte
840 sectors and will take around 1MB of memory.
841 .It Va kern.geom.eli.key_cache_hits
842 Reports how many times we were looking up a Data Key and it was already in
844 This sysctl is not updated for providers that need fewer Data Keys than
845 the limit specified in
846 .Va kern.geom.eli.key_cache_limit .
847 .It Va kern.geom.eli.key_cache_misses
848 Reports how many times we were looking up a Data Key and it was not in cache.
849 This sysctl is not updated for providers that need fewer Data Keys than the limit
851 .Va kern.geom.eli.key_cache_limit .
854 Exit status is 0 on success, and 1 if the command fails.
856 Initialize a provider which is going to be encrypted with a
857 passphrase and random data from a file on the user's pen drive.
859 Attach the provider, create a file system, and mount it.
861 Unmount the provider and detach it:
862 .Bd -literal -offset indent
863 # dd if=/dev/random of=/mnt/pendrive/da2.key bs=64 count=1
864 # geli init -s 4096 -K /mnt/pendrive/da2.key /dev/da2
865 Enter new passphrase:
866 Reenter new passphrase:
867 # geli attach -k /mnt/pendrive/da2.key /dev/da2
869 # dd if=/dev/random of=/dev/da2.eli bs=1m
871 # mount /dev/da2.eli /mnt/secret
874 # geli detach da2.eli
877 Create an encrypted provider, but use two User Keys:
878 one for your employee and one for you as the company's security officer
879 (so it is not a tragedy if the employee
881 forgets his passphrase):
882 .Bd -literal -offset indent
884 Enter new passphrase: (enter security officer's passphrase)
885 Reenter new passphrase:
886 # geli setkey -n 1 /dev/da2
887 Enter passphrase: (enter security officer's passphrase)
888 Enter new passphrase: (let your employee enter his passphrase ...)
889 Reenter new passphrase: (... twice)
892 You are the security officer in your company.
893 Create an encrypted provider for use by the user, but remember that users
894 forget their passphrases, so backup the Master Key with your own random key:
895 .Bd -literal -offset indent
896 # dd if=/dev/random of=/mnt/pendrive/keys/`hostname` bs=64 count=1
897 # geli init -P -K /mnt/pendrive/keys/`hostname` /dev/ada0s1e
898 # geli backup /dev/ada0s1e /mnt/pendrive/backups/`hostname`
899 (use key number 0, so the encrypted Master Key will be re-encrypted by this)
900 # geli setkey -n 0 -k /mnt/pendrive/keys/`hostname` /dev/ada0s1e
901 (allow the user to enter his passphrase)
902 Enter new passphrase:
903 Reenter new passphrase:
906 Encrypted swap partition setup:
907 .Bd -literal -offset indent
908 # dd if=/dev/random of=/dev/ada0s1b bs=1m
909 # geli onetime -d -e 3des ada0s1b
910 # swapon /dev/ada0s1b.eli
913 The example below shows how to configure two providers which will be attached
914 on boot (before the root file system is mounted).
915 One of them is using passphrase and three keyfile parts and the other is
916 using only a keyfile in one part:
917 .Bd -literal -offset indent
918 # dd if=/dev/random of=/dev/da0 bs=1m
919 # dd if=/dev/random of=/boot/keys/da0.key0 bs=32k count=1
920 # dd if=/dev/random of=/boot/keys/da0.key1 bs=32k count=1
921 # dd if=/dev/random of=/boot/keys/da0.key2 bs=32k count=1
922 # geli init -b -K /boot/keys/da0.key0 -K /boot/keys/da0.key1 -K /boot/keys/da0.key2 da0
923 Enter new passphrase:
924 Reenter new passphrase:
925 # dd if=/dev/random of=/dev/da1s3a bs=1m
926 # dd if=/dev/random of=/boot/keys/da1s3a.key bs=128k count=1
927 # geli init -b -P -K /boot/keys/da1s3a.key da1s3a
930 The providers are initialized, now we have to add these lines to
931 .Pa /boot/loader.conf :
932 .Bd -literal -offset indent
933 geli_da0_keyfile0_load="YES"
934 geli_da0_keyfile0_type="da0:geli_keyfile0"
935 geli_da0_keyfile0_name="/boot/keys/da0.key0"
936 geli_da0_keyfile1_load="YES"
937 geli_da0_keyfile1_type="da0:geli_keyfile1"
938 geli_da0_keyfile1_name="/boot/keys/da0.key1"
939 geli_da0_keyfile2_load="YES"
940 geli_da0_keyfile2_type="da0:geli_keyfile2"
941 geli_da0_keyfile2_name="/boot/keys/da0.key2"
943 geli_da1s3a_keyfile0_load="YES"
944 geli_da1s3a_keyfile0_type="da1s3a:geli_keyfile0"
945 geli_da1s3a_keyfile0_name="/boot/keys/da1s3a.key"
948 If there is only one keyfile, the index might be omitted:
949 .Bd -literal -offset indent
950 geli_da1s3a_keyfile_load="YES"
951 geli_da1s3a_keyfile_type="da1s3a:geli_keyfile"
952 geli_da1s3a_keyfile_name="/boot/keys/da1s3a.key"
955 Not only configure encryption, but also data integrity verification using
957 .Bd -literal -offset indent
958 # geli init -a hmac/sha256 -s 4096 /dev/da0
959 Enter new passphrase:
960 Reenter new passphrase:
961 # geli attach /dev/da0
963 # dd if=/dev/random of=/dev/da0.eli bs=1m
965 # mount /dev/da0.eli /mnt/secret
969 writes the metadata backup by default to the
970 .Pa /var/backups/<prov>.eli
972 If the metadata is lost in any way (e.g., by accidental overwrite), it can be restored.
973 Consider the following situation:
974 .Bd -literal -offset indent
976 Enter new passphrase:
977 Reenter new passphrase:
979 Metadata backup can be found in /var/backups/da0.eli and
980 can be restored with the following command:
982 # geli restore /var/backups/da0.eli /dev/da0
984 # geli clear /dev/da0
985 # geli attach /dev/da0
986 geli: Cannot read metadata from /dev/da0: Invalid argument.
987 # geli restore /var/backups/da0.eli /dev/da0
988 # geli attach /dev/da0
992 If an encrypted file system is extended, it is necessary to relocate and
994 .Bd -literal -offset indent
995 # gpart create -s GPT ada0
996 # gpart add -s 1g -t freebsd-ufs -i 1 ada0
997 # geli init -K keyfile -P ada0p1
998 # gpart resize -s 2g -i 1 ada0
999 # geli resize -s 1g ada0p1
1000 # geli attach -k keyfile -p ada0p1
1003 Initialize provider with the passphrase split into two files.
1004 The provider can be attached using those two files or by entering
1006 as the passphrase at the
1009 .Bd -literal -offset indent
1010 # echo foo > da0.pass0
1011 # echo bar > da0.pass1
1012 # geli init -J da0.pass0 -J da0.pass1 da0
1013 # geli attach -j da0.pass0 -j da0.pass1 da0
1016 Enter passphrase: foobar
1021 devices on a laptop, suspend the laptop, then resume devices one by one after
1022 resuming the laptop:
1023 .Bd -literal -offset indent
1026 <resume your laptop>
1027 # geli resume -p -k keyfile gpt/secret
1028 # geli resume gpt/private
1031 .Sh ENCRYPTION MODES
1033 supports two encryption modes:
1035 which was standardized as
1039 with unpredictable IV.
1044 is very similar to the mode
1046 .Sh DATA AUTHENTICATION
1048 can verify data integrity when an authentication algorithm is specified.
1049 When data corruption/modification is detected,
1051 will not return any data, but instead will return an error
1053 The offset and size of the corrupted data will be printed on the console.
1054 It is important to know against which attacks
1056 provides protection for your data.
1057 If data is modified in-place or copied from one place on the disk
1058 to another even without modification,
1060 should be able to detect such a change.
1061 If an attacker can remember the encrypted data, he can overwrite any future
1062 changes with the data he owns without it being noticed.
1065 will not protect your data against replay attacks.
1067 It is recommended to write to the whole provider before first use,
1068 in order to make sure that all sectors and their corresponding
1069 checksums are properly initialized into a consistent state.
1070 One can safely ignore data authentication errors that occur immediately
1071 after the first time a provider is attached and before it is
1072 initialized in this way.
1088 block cipher is implemented by Yoshisato Yanagisawa in
1093 metadata version supported by the given FreeBSD version:
1094 .Bl -column -offset indent ".Sy FreeBSD" ".Sy version"
1095 .It Sy FreeBSD Ta Sy GELI
1096 .It Sy version Ta Sy version
1119 .An Pawel Jakub Dawidek Aq Mt pjd@FreeBSD.org
projects / FreeBSD / FreeBSD.git / blob