diff options
Diffstat (limited to 'Documentation/device-mapper/dm-crypt.txt')
-rw-r--r-- | Documentation/device-mapper/dm-crypt.txt | 21 |
1 files changed, 20 insertions, 1 deletions
diff --git a/Documentation/device-mapper/dm-crypt.txt b/Documentation/device-mapper/dm-crypt.txt index 6b5c42dbbe84..2c656ae43ba7 100644 --- a/Documentation/device-mapper/dm-crypt.txt +++ b/Documentation/device-mapper/dm-crypt.txt | |||
@@ -4,7 +4,8 @@ dm-crypt | |||
4 | Device-Mapper's "crypt" target provides transparent encryption of block devices | 4 | Device-Mapper's "crypt" target provides transparent encryption of block devices |
5 | using the kernel crypto API. | 5 | using the kernel crypto API. |
6 | 6 | ||
7 | Parameters: <cipher> <key> <iv_offset> <device path> <offset> | 7 | Parameters: <cipher> <key> <iv_offset> <device path> \ |
8 | <offset> [<#opt_params> <opt_params>] | ||
8 | 9 | ||
9 | <cipher> | 10 | <cipher> |
10 | Encryption cipher and an optional IV generation mode. | 11 | Encryption cipher and an optional IV generation mode. |
@@ -37,6 +38,24 @@ Parameters: <cipher> <key> <iv_offset> <device path> <offset> | |||
37 | <offset> | 38 | <offset> |
38 | Starting sector within the device where the encrypted data begins. | 39 | Starting sector within the device where the encrypted data begins. |
39 | 40 | ||
41 | <#opt_params> | ||
42 | Number of optional parameters. If there are no optional parameters, | ||
43 | the optional paramaters section can be skipped or #opt_params can be zero. | ||
44 | Otherwise #opt_params is the number of following arguments. | ||
45 | |||
46 | Example of optional parameters section: | ||
47 | 1 allow_discards | ||
48 | |||
49 | allow_discards | ||
50 | Block discard requests (a.k.a. TRIM) are passed through the crypt device. | ||
51 | The default is to ignore discard requests. | ||
52 | |||
53 | WARNING: Assess the specific security risks carefully before enabling this | ||
54 | option. For example, allowing discards on encrypted devices may lead to | ||
55 | the leak of information about the ciphertext device (filesystem type, | ||
56 | used space etc.) if the discarded blocks can be located easily on the | ||
57 | device later. | ||
58 | |||
40 | Example scripts | 59 | Example scripts |
41 | =============== | 60 | =============== |
42 | LUKS (Linux Unified Key Setup) is now the preferred way to set up disk | 61 | LUKS (Linux Unified Key Setup) is now the preferred way to set up disk |