| Theodore Ts'o | 1e734e7 | 2015-03-30 02:11:53 -0400 | [diff] [blame] | 1 | .TH E4CRYPT 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" |
| Ildar Muslukhov | bfa4b35 | 2015-02-06 16:30:11 -0800 | [diff] [blame] | 2 | .SH NAME |
| 3 | e4crypt \- ext4 filesystem encryption utility |
| 4 | .SH SYNOPSIS |
| Theodore Ts'o | 41f2210 | 2015-03-28 20:15:02 -0400 | [diff] [blame] | 5 | .B e4crypt \-a \-S |
| Ildar Muslukhov | bfa4b35 | 2015-02-06 16:30:11 -0800 | [diff] [blame] | 6 | .I salt |
| 7 | [ |
| 8 | .B \-k |
| 9 | .I keyring |
| 10 | ] |
| 11 | [ |
| 12 | .I path\fR ... |
| 13 | ] |
| 14 | .br |
| 15 | .B e4crypt \-s |
| 16 | .I policy |
| 17 | .I path\fR ... |
| 18 | .SH DESCRIPTION |
| 19 | .B e4crypt |
| 20 | performs encryption management for ext4 file systems. |
| Theodore Ts'o | 1e734e7 | 2015-03-30 02:11:53 -0400 | [diff] [blame] | 21 | .SH COMMANDS |
| Ildar Muslukhov | bfa4b35 | 2015-02-06 16:30:11 -0800 | [diff] [blame] | 22 | .TP |
| Theodore Ts'o | 1e734e7 | 2015-03-30 02:11:53 -0400 | [diff] [blame] | 23 | .B e4crypt add_key -S \fR[\fB -k \fIkeyring\fR ] [\fB-v\fR] [\fB-q\fR] [ \fI path\fR ... ] |
| 24 | Prompts the user for a passphrase and inserts it into the specified |
| 25 | keyring. If no keyring is specified, e4crypt will use the session |
| 26 | keyring if it exists or the user session keyring if it does not. |
| 27 | .IP |
| 28 | If one or more directory paths are specified, e4crypt will try to |
| 29 | set the policy of those directories to use the key just entered by |
| 30 | the user. |
| Ildar Muslukhov | bfa4b35 | 2015-02-06 16:30:11 -0800 | [diff] [blame] | 31 | .TP |
| Theodore Ts'o | 1e734e7 | 2015-03-30 02:11:53 -0400 | [diff] [blame] | 32 | .B e4crypt new_session |
| 33 | Give the invoking process (typically a shell) a new session keyring, |
| 34 | discarding its old session keyring. |
| Ildar Muslukhov | bfa4b35 | 2015-02-06 16:30:11 -0800 | [diff] [blame] | 35 | .TP |
| Theodore Ts'o | 1e734e7 | 2015-03-30 02:11:53 -0400 | [diff] [blame] | 36 | .B set_policy -s \fIpolicy path\fR ... |
| 37 | Sets the policy for the directories specified on the command line. |
| Ildar Muslukhov | bfa4b35 | 2015-02-06 16:30:11 -0800 | [diff] [blame] | 38 | All directories must be empty to set the policy; if the directory |
| Theodore Ts'o | 1e734e7 | 2015-03-30 02:11:53 -0400 | [diff] [blame] | 39 | already has a policy established, e4crypt will validate that it the |
| 40 | policy matches what was specified. A policy is an encryption key |
| 41 | identifier consisting of 16 hexadecimal characters. |
| Ildar Muslukhov | bfa4b35 | 2015-02-06 16:30:11 -0800 | [diff] [blame] | 42 | .SH AUTHOR |
| Theodore Ts'o | 1e734e7 | 2015-03-30 02:11:53 -0400 | [diff] [blame] | 43 | Written by Michael Halcrow <mhalcrow@google.com>, Ildar Muslukhov |
| 44 | <muslukhovi@gmail.com>, and Theodore Ts'o <tytso@mit.edu> |
| Ildar Muslukhov | bfa4b35 | 2015-02-06 16:30:11 -0800 | [diff] [blame] | 45 | .SH SEE ALSO |
| Theodore Ts'o | 1e734e7 | 2015-03-30 02:11:53 -0400 | [diff] [blame] | 46 | .BR keyctl (1), |
| Ildar Muslukhov | bfa4b35 | 2015-02-06 16:30:11 -0800 | [diff] [blame] | 47 | .BR mke2fs (8), |
| 48 | .BR mount (8). |