korg/e2fsprogs
0
0
Fork 0
mirror of https://git.kernel.org/pub/scm/fs/ext2/e2fsprogs.git synced 2024-11-30 21:43:40 +08:00
Code Issues Packages Projects Releases Wiki Activity
942b00cb9d
e2fsprogs/misc/e4crypt.8.in

75 lines
2.8 KiB
Groff
Raw Normal View History

e4crypt: change the UI to use a subcommand style Also add a new subcommand "new_session", which works much like keyctl new_session does. Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2015-03-30 14:11:53 +08:00
.TH E4CRYPT 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@"
misc: add e4crypt tool This patch adds new e4crypt tool for encryption management in the ext4 filesystem. Signed-off-by: Ildar Muslukhov <muslukhovi@gmail.com> Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2015-02-07 08:30:11 +08:00
.SH NAME
e4crypt \- ext4 filesystem encryption utility
.SH SYNOPSIS
Add missing information to various man pages and usage texts badblocks.c: Add -B and -X to usage text. chattr.1.in: Add P to list of settable attributes. e2image.8.in, e2image.c: Remove superfluous mention of -r option. e2undo.8.in, e2undo.c: Add description for -z to man page and add -o and -z to synopsis and usage text. e4crypt.8.in: Add -p pad option to relevant command descriptions. lsattr.1.in: Fix typo. mke2fs.8.in: Add -C to synopsis. Add MKE2FS_DEVICE_PHYS_SECTSIZE description and update MKE2FS_DEVICE_SECTSIZE description. mke2fs.conf.5.in: Add devices stanza summary. Remove base_features and default_features descriptions from defaults section, as they are already described in fs_types section. Move enable_periodic_fsck and force_undo to fs_types section, as they can be set per filesystem type. Add missing lazy_journal_init and hugefiles_dir descriptions. tune2fs.8.in: Remove unsupported -p option and deprecated -s option. Add 64bit, ea_inode, large_dir, and metadata_csum_seed descriptions. tune2fs.c: Remove unsupported -p option from usage text. Add mmp_update_interval to extended option usage text. resize/main.c: Add -S option to usage text. Signed-off-by: Tyson Nottingham <tgnottingham@gmail.com> Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2017-12-14 15:13:12 +08:00
.B e4crypt add_key -S \fR[\fB -k \fIkeyring\fR ] [\fB-v\fR] [\fB-q\fR] \fR[\fB -p \fIpad\fR ] [ \fIpath\fR ... ]
Fix various man pages and usage message Thanks to pete@lyptonyx for doing a close pass editing of e2fsprogs's man pages. Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2016-05-09 10:12:41 +08:00
.br
.B e4crypt new_session
misc: add e4crypt tool This patch adds new e4crypt tool for encryption management in the ext4 filesystem. Signed-off-by: Ildar Muslukhov <muslukhovi@gmail.com> Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2015-02-07 08:30:11 +08:00
.br
Fix various man pages and usage message Thanks to pete@lyptonyx for doing a close pass editing of e2fsprogs's man pages. Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2016-05-09 10:12:41 +08:00
.B e4crypt get_policy \fIpath\fR ...
.br
Add missing information to various man pages and usage texts badblocks.c: Add -B and -X to usage text. chattr.1.in: Add P to list of settable attributes. e2image.8.in, e2image.c: Remove superfluous mention of -r option. e2undo.8.in, e2undo.c: Add description for -z to man page and add -o and -z to synopsis and usage text. e4crypt.8.in: Add -p pad option to relevant command descriptions. lsattr.1.in: Fix typo. mke2fs.8.in: Add -C to synopsis. Add MKE2FS_DEVICE_PHYS_SECTSIZE description and update MKE2FS_DEVICE_SECTSIZE description. mke2fs.conf.5.in: Add devices stanza summary. Remove base_features and default_features descriptions from defaults section, as they are already described in fs_types section. Move enable_periodic_fsck and force_undo to fs_types section, as they can be set per filesystem type. Add missing lazy_journal_init and hugefiles_dir descriptions. tune2fs.8.in: Remove unsupported -p option and deprecated -s option. Add 64bit, ea_inode, large_dir, and metadata_csum_seed descriptions. tune2fs.c: Remove unsupported -p option from usage text. Add mmp_update_interval to extended option usage text. resize/main.c: Add -S option to usage text. Signed-off-by: Tyson Nottingham <tgnottingham@gmail.com> Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2017-12-14 15:13:12 +08:00
.B e4crypt set_policy \fR[\fB -p \fIpad\fR ] \fIpolicy path\fR ...
misc: add e4crypt tool This patch adds new e4crypt tool for encryption management in the ext4 filesystem. Signed-off-by: Ildar Muslukhov <muslukhovi@gmail.com> Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2015-02-07 08:30:11 +08:00
.SH DESCRIPTION
.B e4crypt
performs encryption management for ext4 file systems.
e4crypt: change the UI to use a subcommand style Also add a new subcommand "new_session", which works much like keyctl new_session does. Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2015-03-30 14:11:53 +08:00
.SH COMMANDS
misc: add e4crypt tool This patch adds new e4crypt tool for encryption management in the ext4 filesystem. Signed-off-by: Ildar Muslukhov <muslukhovi@gmail.com> Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2015-02-07 08:30:11 +08:00
.TP
Add documentation for e4crypt's add_key command in the man page Correctly document that the -S option takes an argument, and describe what arguments to the -S, -k, and -p options. Addresses-Debian-Bug: #880483 Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2018-01-02 05:29:56 +08:00
.B e4crypt add_key \fR[\fB-vq\fR] [\fB-S\fI salt\fR ] [\fB-k \fIkeyring\fR ] [\fB -p \fIpad\fR ] [ \fIpath\fR ... ]
e4crypt: change the UI to use a subcommand style Also add a new subcommand "new_session", which works much like keyctl new_session does. Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2015-03-30 14:11:53 +08:00
Prompts the user for a passphrase and inserts it into the specified
keyring. If no keyring is specified, e4crypt will use the session
keyring if it exists or the user session keyring if it does not.
.IP
Add documentation for e4crypt's add_key command in the man page Correctly document that the -S option takes an argument, and describe what arguments to the -S, -k, and -p options. Addresses-Debian-Bug: #880483 Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2018-01-02 05:29:56 +08:00
The
.I salt
argument is interpreted in a number of different ways, depending on how
its prefix value. If the first two characters are "s:", then the rest
of the argument will be used as an text string and used as the salt
value. If the first two characters are "0x", then the rest of the
argument will be parsed as a hex string as used as the salt. If the
first characters are "f:" then the rest of the argument will be
interpreted as a filename from which the salt value will be read. If
the string begins with a '/' character, it will similarly be treated as
filename. Finally, if the
.I salt
argument can be parsed as a valid UUID, then the UUID value will be used
as a salt value.
.IP
The
.I keyring
argument specifies the keyring to which the key should be added.
.IP
The
.I pad
value specifies the number of bytes of padding will be added to
directory names for obfuscation purposes. Valid
.I pad
values are 4, 8, 16, and 32.
.IP
e4crypt: change the UI to use a subcommand style Also add a new subcommand "new_session", which works much like keyctl new_session does. Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2015-03-30 14:11:53 +08:00
If one or more directory paths are specified, e4crypt will try to
Add documentation for e4crypt's add_key command in the man page Correctly document that the -S option takes an argument, and describe what arguments to the -S, -k, and -p options. Addresses-Debian-Bug: #880483 Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2018-01-02 05:29:56 +08:00
set the policy of those directories to use the key just added by the
.B add_key
e4crypt: if salt is explicitly provided to add_key, then use it Providing -S and a path to 'add_key' previously exhibited an unintuitive behavior: instead of using the salt explicitly provided by the user, e4crypt would use the salt obtained via EXT4_IOC_GET_ENCRYPTION_PWSALT on the path. This was because set_policy() was still called with NULL as salt. With this change we now remember the explicitly provided salt (if any) and use it as argument for set_policy(). Eventually e4crypt add_key -S s:my-spicy-salt /foo will now actually use 'my-spicy-salt' and not something else as salt for the policy set on /foo. Signed-off-by: Florian Schmaus <flo@geekplace.eu> Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2020-07-07 16:27:30 +08:00
command. If a salt was explicitly specified, then it will be used
to derive the encryption key of those directories. Otherwise a
directory-specific default salt will be used.
misc: add e4crypt tool This patch adds new e4crypt tool for encryption management in the ext4 filesystem. Signed-off-by: Ildar Muslukhov <muslukhovi@gmail.com> Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2015-02-07 08:30:11 +08:00
.TP
Fix various man pages and usage message Thanks to pete@lyptonyx for doing a close pass editing of e2fsprogs's man pages. Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2016-05-09 10:12:41 +08:00
.B e4crypt get_policy \fIpath\fR ...
Print the policy for the directories specified on the command line.
.TP
e4crypt: change the UI to use a subcommand style Also add a new subcommand "new_session", which works much like keyctl new_session does. Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2015-03-30 14:11:53 +08:00
.B e4crypt new_session
Give the invoking process (typically a shell) a new session keyring,
discarding its old session keyring.
misc: add e4crypt tool This patch adds new e4crypt tool for encryption management in the ext4 filesystem. Signed-off-by: Ildar Muslukhov <muslukhovi@gmail.com> Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2015-02-07 08:30:11 +08:00
.TP
Add missing information to various man pages and usage texts badblocks.c: Add -B and -X to usage text. chattr.1.in: Add P to list of settable attributes. e2image.8.in, e2image.c: Remove superfluous mention of -r option. e2undo.8.in, e2undo.c: Add description for -z to man page and add -o and -z to synopsis and usage text. e4crypt.8.in: Add -p pad option to relevant command descriptions. lsattr.1.in: Fix typo. mke2fs.8.in: Add -C to synopsis. Add MKE2FS_DEVICE_PHYS_SECTSIZE description and update MKE2FS_DEVICE_SECTSIZE description. mke2fs.conf.5.in: Add devices stanza summary. Remove base_features and default_features descriptions from defaults section, as they are already described in fs_types section. Move enable_periodic_fsck and force_undo to fs_types section, as they can be set per filesystem type. Add missing lazy_journal_init and hugefiles_dir descriptions. tune2fs.8.in: Remove unsupported -p option and deprecated -s option. Add 64bit, ea_inode, large_dir, and metadata_csum_seed descriptions. tune2fs.c: Remove unsupported -p option from usage text. Add mmp_update_interval to extended option usage text. resize/main.c: Add -S option to usage text. Signed-off-by: Tyson Nottingham <tgnottingham@gmail.com> Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2017-12-14 15:13:12 +08:00
.B e4crypt set_policy \fR[\fB -p \fIpad\fR ] \fIpolicy path\fR ...
e4crypt: change the UI to use a subcommand style Also add a new subcommand "new_session", which works much like keyctl new_session does. Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2015-03-30 14:11:53 +08:00
Sets the policy for the directories specified on the command line.
misc: add e4crypt tool This patch adds new e4crypt tool for encryption management in the ext4 filesystem. Signed-off-by: Ildar Muslukhov <muslukhovi@gmail.com> Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2015-02-07 08:30:11 +08:00
All directories must be empty to set the policy; if the directory
Fix various man pages and usage message Thanks to pete@lyptonyx for doing a close pass editing of e2fsprogs's man pages. Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2016-05-09 10:12:41 +08:00
already has a policy established, e4crypt will validate that the
e4crypt: change the UI to use a subcommand style Also add a new subcommand "new_session", which works much like keyctl new_session does. Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2015-03-30 14:11:53 +08:00
policy matches what was specified. A policy is an encryption key
identifier consisting of 16 hexadecimal characters.
misc: add e4crypt tool This patch adds new e4crypt tool for encryption management in the ext4 filesystem. Signed-off-by: Ildar Muslukhov <muslukhovi@gmail.com> Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2015-02-07 08:30:11 +08:00
.SH AUTHOR
e4crypt: change the UI to use a subcommand style Also add a new subcommand "new_session", which works much like keyctl new_session does. Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2015-03-30 14:11:53 +08:00
Written by Michael Halcrow <mhalcrow@google.com>, Ildar Muslukhov
<muslukhovi@gmail.com>, and Theodore Ts'o <tytso@mit.edu>
misc: add e4crypt tool This patch adds new e4crypt tool for encryption management in the ext4 filesystem. Signed-off-by: Ildar Muslukhov <muslukhovi@gmail.com> Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2015-02-07 08:30:11 +08:00
.SH SEE ALSO
e4crypt: change the UI to use a subcommand style Also add a new subcommand "new_session", which works much like keyctl new_session does. Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2015-03-30 14:11:53 +08:00
.BR keyctl (1),
misc: add e4crypt tool This patch adds new e4crypt tool for encryption management in the ext4 filesystem. Signed-off-by: Ildar Muslukhov <muslukhovi@gmail.com> Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2015-02-07 08:30:11 +08:00
.BR mke2fs (8),
.BR mount (8).
Reference in New Issue Copy Permalink