| 1 |
.TH E4CRYPT 8 "March 2025" "E2fsprogs version 1.47.4" |
| 2 |
.SH NAME |
| 3 |
e4crypt \- ext4 file system encryption utility |
| 4 |
.SH SYNOPSIS |
| 5 |
.B e4crypt add_key -S \fR[\fB -k \fIkeyring\fR ] [\fB-v\fR] [\fB-q\fR] \fR[\fB -p \fIpad\fR ] [ \fIpath\fR ... ] |
| 6 |
.br |
| 7 |
.B e4crypt new_session |
| 8 |
.br |
| 9 |
.B e4crypt get_policy \fIpath\fR ... |
| 10 |
.br |
| 11 |
.B e4crypt set_policy \fR[\fB -p \fIpad\fR ] \fIpolicy path\fR ... |
| 12 |
.SH DESCRIPTION |
| 13 |
.B e4crypt |
| 14 |
performs encryption management for ext4 file systems. |
| 15 |
.SH COMMANDS |
| 16 |
.TP |
| 17 |
.B e4crypt add_key \fR[\fB-vq\fR] [\fB-S\fI salt\fR ] [\fB-k \fIkeyring\fR ] [\fB -p \fIpad\fR ] [ \fIpath\fR ... ] |
| 18 |
Prompts the user for a passphrase and inserts it into the specified |
| 19 |
keyring. If no keyring is specified, e4crypt will use the session |
| 20 |
keyring if it exists or the user session keyring if it does not. |
| 21 |
.IP |
| 22 |
A salt is used to convert the passphrase into an encryption key, and |
| 23 |
ensures that if the user uses the same passphrase in different contexts, |
| 24 |
different salt values will result in different encryption keys. By |
| 25 |
default, |
| 26 |
.B e4crypt |
| 27 |
will examine all mounted ext4 file systems, and insert an encryption |
| 28 |
key salted with each file system with encryption enabled with its |
| 29 |
default salt value. |
| 30 |
.IP |
| 31 |
Alternatively, if the user specifies an explicit salt, that salt value |
| 32 |
will be used to calculate the encryption key from the passphrase. |
| 33 |
If the first two characters of |
| 34 |
.I salt |
| 35 |
are "s:", then the rest |
| 36 |
of the argument will be used as a text string and used as the salt |
| 37 |
value. If the first two characters are "0x", then the rest of the |
| 38 |
argument will be parsed as a hex string and the hex value will be used |
| 39 |
as the salt. If the |
| 40 |
first characters are "f:" then the rest of the argument will be |
| 41 |
interpreted as a filename from which the salt value will be read. If |
| 42 |
the string begins with a '/' character, it will similarly be treated as |
| 43 |
filename. Finally, if the |
| 44 |
.I salt |
| 45 |
argument can be parsed as a valid UUID, then the UUID value will be used |
| 46 |
as a salt value. |
| 47 |
.IP |
| 48 |
The |
| 49 |
.I keyring |
| 50 |
argument specifies the keyring to which the key should be added. |
| 51 |
.IP |
| 52 |
The |
| 53 |
.I pad |
| 54 |
value specifies the number of bytes of padding will be added to |
| 55 |
directory names for obfuscation purposes. Valid |
| 56 |
.I pad |
| 57 |
values are 4, 8, 16, and 32. |
| 58 |
.IP |
| 59 |
If one or more directory paths are specified, e4crypt will try to |
| 60 |
set the policy of those directories to use the key just added by the |
| 61 |
.B add_key |
| 62 |
command. If a salt was explicitly specified, then it will be used |
| 63 |
to derive the encryption key of those directories. Otherwise a |
| 64 |
directory-specific default salt will be used. |
| 65 |
.TP |
| 66 |
.B e4crypt get_policy \fIpath\fR ... |
| 67 |
Print the policy for the directories specified on the command line. |
| 68 |
.TP |
| 69 |
.B e4crypt new_session |
| 70 |
Give the invoking process (typically a shell) a new session keyring, |
| 71 |
discarding its old session keyring. |
| 72 |
.TP |
| 73 |
.B e4crypt set_policy \fR[\fB -p \fIpad\fR ] \fIpolicy path\fR ... |
| 74 |
Sets the policy for the directories specified on the command line. |
| 75 |
All directories must be empty to set the policy; if the directory |
| 76 |
already has a policy established, e4crypt will validate that the |
| 77 |
policy matches what was specified. A policy is an encryption key |
| 78 |
identifier consisting of 16 hexadecimal characters. |
| 79 |
.SH AUTHOR |
| 80 |
Written by Michael Halcrow <[email protected]>, Ildar Muslukhov |
| 81 |
<[email protected]>, and Theodore Ts'o <[email protected]> |
| 82 |
.SH SEE ALSO |
| 83 |
.BR keyctl (1), |
| 84 |
.BR mke2fs (8), |
| 85 |
.BR mount (8). |