Skip to content

Commit 09f5412

Browse files
keesJonathan Corbet
authored andcommitted
doc: ReSTify keys-ecryptfs.txt
Adjusts for ReST markup and moves under keys security devel index. Cc: David Howells <dhowells@redhat.com> Cc: Tyler Hicks <tyhicks@canonical.com> Signed-off-by: Kees Cook <keescook@chromium.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
1 parent b68101a commit 09f5412

File tree

3 files changed

+13
-9
lines changed

3 files changed

+13
-9
lines changed

Documentation/security/00-INDEX

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
00-INDEX
22
- this file.
3-
keys-ecryptfs.txt
4-
- description of the encryption keys for the ecryptfs filesystem.
53
keys-request-key.txt
64
- description of the kernel key request service.
75
keys-trusted-encrypted.txt

Documentation/security/keys-ecryptfs.txt renamed to Documentation/security/keys/ecryptfs.rst

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
Encrypted keys for the eCryptfs filesystem
1+
==========================================
2+
Encrypted keys for the eCryptfs filesystem
3+
==========================================
24

35
ECryptfs is a stacked filesystem which transparently encrypts and decrypts each
46
file using a randomly generated File Encryption Key (FEK).
@@ -35,20 +37,23 @@ controlled environment. Another advantage is that the key is not exposed to
3537
threats of malicious software, because it is available in clear form only at
3638
kernel level.
3739

38-
Usage:
40+
Usage::
41+
3942
keyctl add encrypted name "new ecryptfs key-type:master-key-name keylen" ring
4043
keyctl add encrypted name "load hex_blob" ring
4144
keyctl update keyid "update key-type:master-key-name"
4245

43-
name:= '<16 hexadecimal characters>'
44-
key-type:= 'trusted' | 'user'
45-
keylen:= 64
46+
Where::
47+
48+
name:= '<16 hexadecimal characters>'
49+
key-type:= 'trusted' | 'user'
50+
keylen:= 64
4651

4752

4853
Example of encrypted key usage with the eCryptfs filesystem:
4954

5055
Create an encrypted key "1000100010001000" of length 64 bytes with format
51-
'ecryptfs' and save it using a previously loaded user key "test":
56+
'ecryptfs' and save it using a previously loaded user key "test"::
5257

5358
$ keyctl add encrypted 1000100010001000 "new ecryptfs user:test 64" @u
5459
19184530
@@ -62,7 +67,7 @@ Create an encrypted key "1000100010001000" of length 64 bytes with format
6267
$ keyctl pipe 19184530 > ecryptfs.blob
6368

6469
Mount an eCryptfs filesystem using the created encrypted key "1000100010001000"
65-
into the '/secret' directory:
70+
into the '/secret' directory::
6671

6772
$ mount -i -t ecryptfs -oecryptfs_sig=1000100010001000,\
6873
ecryptfs_cipher=aes,ecryptfs_key_bytes=32 /secret /secret

Documentation/security/keys/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ Kernel Keys
66
:maxdepth: 1
77

88
core
9+
ecryptfs

0 commit comments

Comments
 (0)