Commit | Line | Data |
---|---|---|
237fead6 MH |
1 | /** |
2 | * eCryptfs: Linux filesystem encryption layer | |
3 | * | |
4 | * Copyright (C) 1997-2003 Erez Zadok | |
5 | * Copyright (C) 2001-2003 Stony Brook University | |
dd2a3b7a | 6 | * Copyright (C) 2004-2007 International Business Machines Corp. |
237fead6 MH |
7 | * Author(s): Michael A. Halcrow <mahalcro@us.ibm.com> |
8 | * Michael C. Thompson <mcthomps@us.ibm.com> | |
dddfa461 | 9 | * Tyler Hicks <tyhicks@ou.edu> |
237fead6 MH |
10 | * |
11 | * This program is free software; you can redistribute it and/or | |
12 | * modify it under the terms of the GNU General Public License as | |
13 | * published by the Free Software Foundation; either version 2 of the | |
14 | * License, or (at your option) any later version. | |
15 | * | |
16 | * This program is distributed in the hope that it will be useful, but | |
17 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
19 | * General Public License for more details. | |
20 | * | |
21 | * You should have received a copy of the GNU General Public License | |
22 | * along with this program; if not, write to the Free Software | |
23 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA | |
24 | * 02111-1307, USA. | |
25 | */ | |
26 | ||
27 | #include <linux/dcache.h> | |
28 | #include <linux/file.h> | |
29 | #include <linux/module.h> | |
30 | #include <linux/namei.h> | |
31 | #include <linux/skbuff.h> | |
237fead6 | 32 | #include <linux/mount.h> |
237fead6 MH |
33 | #include <linux/pagemap.h> |
34 | #include <linux/key.h> | |
35 | #include <linux/parser.h> | |
0cc72dc7 | 36 | #include <linux/fs_stack.h> |
5a0e3ad6 | 37 | #include <linux/slab.h> |
070baa51 | 38 | #include <linux/magic.h> |
237fead6 MH |
39 | #include "ecryptfs_kernel.h" |
40 | ||
41 | /** | |
42 | * Module parameter that defines the ecryptfs_verbosity level. | |
43 | */ | |
44 | int ecryptfs_verbosity = 0; | |
45 | ||
46 | module_param(ecryptfs_verbosity, int, 0); | |
47 | MODULE_PARM_DESC(ecryptfs_verbosity, | |
48 | "Initial verbosity level (0 or 1; defaults to " | |
49 | "0, which is Quiet)"); | |
50 | ||
dddfa461 | 51 | /** |
624ae528 | 52 | * Module parameter that defines the number of message buffer elements |
dddfa461 MH |
53 | */ |
54 | unsigned int ecryptfs_message_buf_len = ECRYPTFS_DEFAULT_MSG_CTX_ELEMS; | |
55 | ||
56 | module_param(ecryptfs_message_buf_len, uint, 0); | |
57 | MODULE_PARM_DESC(ecryptfs_message_buf_len, | |
58 | "Number of message buffer elements"); | |
59 | ||
60 | /** | |
61 | * Module parameter that defines the maximum guaranteed amount of time to wait | |
624ae528 | 62 | * for a response from ecryptfsd. The actual sleep time will be, more than |
dddfa461 | 63 | * likely, a small amount greater than this specified value, but only less if |
624ae528 | 64 | * the message successfully arrives. |
dddfa461 MH |
65 | */ |
66 | signed long ecryptfs_message_wait_timeout = ECRYPTFS_MAX_MSG_CTX_TTL / HZ; | |
67 | ||
68 | module_param(ecryptfs_message_wait_timeout, long, 0); | |
69 | MODULE_PARM_DESC(ecryptfs_message_wait_timeout, | |
70 | "Maximum number of seconds that an operation will " | |
71 | "sleep while waiting for a message response from " | |
72 | "userspace"); | |
73 | ||
74 | /** | |
75 | * Module parameter that is an estimate of the maximum number of users | |
76 | * that will be concurrently using eCryptfs. Set this to the right | |
77 | * value to balance performance and memory use. | |
78 | */ | |
79 | unsigned int ecryptfs_number_of_users = ECRYPTFS_DEFAULT_NUM_USERS; | |
80 | ||
81 | module_param(ecryptfs_number_of_users, uint, 0); | |
82 | MODULE_PARM_DESC(ecryptfs_number_of_users, "An estimate of the number of " | |
83 | "concurrent users of eCryptfs"); | |
84 | ||
237fead6 MH |
85 | void __ecryptfs_printk(const char *fmt, ...) |
86 | { | |
87 | va_list args; | |
88 | va_start(args, fmt); | |
89 | if (fmt[1] == '7') { /* KERN_DEBUG */ | |
90 | if (ecryptfs_verbosity >= 1) | |
91 | vprintk(fmt, args); | |
92 | } else | |
93 | vprintk(fmt, args); | |
94 | va_end(args); | |
95 | } | |
96 | ||
4981e081 | 97 | /** |
332ab16f | 98 | * ecryptfs_init_lower_file |
4981e081 MH |
99 | * @ecryptfs_dentry: Fully initialized eCryptfs dentry object, with |
100 | * the lower dentry and the lower mount set | |
101 | * | |
102 | * eCryptfs only ever keeps a single open file for every lower | |
103 | * inode. All I/O operations to the lower inode occur through that | |
104 | * file. When the first eCryptfs dentry that interposes with the first | |
105 | * lower dentry for that inode is created, this function creates the | |
332ab16f TH |
106 | * lower file struct and associates it with the eCryptfs |
107 | * inode. When all eCryptfs files associated with the inode are released, the | |
108 | * file is closed. | |
4981e081 | 109 | * |
332ab16f | 110 | * The lower file will be opened with read/write permissions, if |
4981e081 MH |
111 | * possible. Otherwise, it is opened read-only. |
112 | * | |
332ab16f | 113 | * This function does nothing if a lower file is already |
4981e081 MH |
114 | * associated with the eCryptfs inode. |
115 | * | |
116 | * Returns zero on success; non-zero otherwise | |
117 | */ | |
332ab16f TH |
118 | static int ecryptfs_init_lower_file(struct dentry *dentry, |
119 | struct file **lower_file) | |
4981e081 | 120 | { |
745ca247 | 121 | const struct cred *cred = current_cred(); |
cc18ec3c | 122 | struct path *path = ecryptfs_dentry_to_lower_path(dentry); |
332ab16f TH |
123 | int rc; |
124 | ||
cc18ec3c | 125 | rc = ecryptfs_privileged_open(lower_file, path->dentry, path->mnt, |
332ab16f TH |
126 | cred); |
127 | if (rc) { | |
128 | printk(KERN_ERR "Error opening lower file " | |
129 | "for lower_dentry [0x%p] and lower_mnt [0x%p]; " | |
cc18ec3c | 130 | "rc = [%d]\n", path->dentry, path->mnt, rc); |
332ab16f TH |
131 | (*lower_file) = NULL; |
132 | } | |
133 | return rc; | |
134 | } | |
135 | ||
3b06b3eb | 136 | int ecryptfs_get_lower_file(struct dentry *dentry, struct inode *inode) |
332ab16f | 137 | { |
3b06b3eb | 138 | struct ecryptfs_inode_info *inode_info; |
332ab16f | 139 | int count, rc = 0; |
4981e081 | 140 | |
3b06b3eb | 141 | inode_info = ecryptfs_inode_to_private(inode); |
332ab16f TH |
142 | mutex_lock(&inode_info->lower_file_mutex); |
143 | count = atomic_inc_return(&inode_info->lower_file_count); | |
144 | if (WARN_ON_ONCE(count < 1)) | |
145 | rc = -EINVAL; | |
146 | else if (count == 1) { | |
147 | rc = ecryptfs_init_lower_file(dentry, | |
148 | &inode_info->lower_file); | |
149 | if (rc) | |
150 | atomic_set(&inode_info->lower_file_count, 0); | |
4981e081 | 151 | } |
332ab16f | 152 | mutex_unlock(&inode_info->lower_file_mutex); |
4981e081 MH |
153 | return rc; |
154 | } | |
155 | ||
332ab16f TH |
156 | void ecryptfs_put_lower_file(struct inode *inode) |
157 | { | |
158 | struct ecryptfs_inode_info *inode_info; | |
159 | ||
160 | inode_info = ecryptfs_inode_to_private(inode); | |
161 | if (atomic_dec_and_mutex_lock(&inode_info->lower_file_count, | |
162 | &inode_info->lower_file_mutex)) { | |
7149f255 | 163 | filemap_write_and_wait(inode->i_mapping); |
332ab16f TH |
164 | fput(inode_info->lower_file); |
165 | inode_info->lower_file = NULL; | |
166 | mutex_unlock(&inode_info->lower_file_mutex); | |
167 | } | |
168 | } | |
169 | ||
2830bfd6 ES |
170 | enum { ecryptfs_opt_sig, ecryptfs_opt_ecryptfs_sig, |
171 | ecryptfs_opt_cipher, ecryptfs_opt_ecryptfs_cipher, | |
172 | ecryptfs_opt_ecryptfs_key_bytes, | |
17398957 | 173 | ecryptfs_opt_passthrough, ecryptfs_opt_xattr_metadata, |
87c94c4d MH |
174 | ecryptfs_opt_encrypted_view, ecryptfs_opt_fnek_sig, |
175 | ecryptfs_opt_fn_cipher, ecryptfs_opt_fn_cipher_key_bytes, | |
f16feb51 | 176 | ecryptfs_opt_unlink_sigs, ecryptfs_opt_mount_auth_tok_only, |
76435548 | 177 | ecryptfs_opt_check_dev_ruid, |
f16feb51 | 178 | ecryptfs_opt_err }; |
237fead6 | 179 | |
a447c093 | 180 | static const match_table_t tokens = { |
237fead6 MH |
181 | {ecryptfs_opt_sig, "sig=%s"}, |
182 | {ecryptfs_opt_ecryptfs_sig, "ecryptfs_sig=%s"}, | |
237fead6 MH |
183 | {ecryptfs_opt_cipher, "cipher=%s"}, |
184 | {ecryptfs_opt_ecryptfs_cipher, "ecryptfs_cipher=%s"}, | |
185 | {ecryptfs_opt_ecryptfs_key_bytes, "ecryptfs_key_bytes=%u"}, | |
186 | {ecryptfs_opt_passthrough, "ecryptfs_passthrough"}, | |
17398957 MH |
187 | {ecryptfs_opt_xattr_metadata, "ecryptfs_xattr_metadata"}, |
188 | {ecryptfs_opt_encrypted_view, "ecryptfs_encrypted_view"}, | |
87c94c4d MH |
189 | {ecryptfs_opt_fnek_sig, "ecryptfs_fnek_sig=%s"}, |
190 | {ecryptfs_opt_fn_cipher, "ecryptfs_fn_cipher=%s"}, | |
191 | {ecryptfs_opt_fn_cipher_key_bytes, "ecryptfs_fn_key_bytes=%u"}, | |
e77cc8d2 | 192 | {ecryptfs_opt_unlink_sigs, "ecryptfs_unlink_sigs"}, |
f16feb51 | 193 | {ecryptfs_opt_mount_auth_tok_only, "ecryptfs_mount_auth_tok_only"}, |
76435548 | 194 | {ecryptfs_opt_check_dev_ruid, "ecryptfs_check_dev_ruid"}, |
237fead6 MH |
195 | {ecryptfs_opt_err, NULL} |
196 | }; | |
197 | ||
f4aad16a MH |
198 | static int ecryptfs_init_global_auth_toks( |
199 | struct ecryptfs_mount_crypt_stat *mount_crypt_stat) | |
237fead6 | 200 | { |
f4aad16a | 201 | struct ecryptfs_global_auth_tok *global_auth_tok; |
0e1fc5ef | 202 | struct ecryptfs_auth_tok *auth_tok; |
237fead6 | 203 | int rc = 0; |
237fead6 | 204 | |
f4aad16a MH |
205 | list_for_each_entry(global_auth_tok, |
206 | &mount_crypt_stat->global_auth_tok_list, | |
207 | mount_crypt_stat_list) { | |
5dda6992 | 208 | rc = ecryptfs_keyring_auth_tok_for_sig( |
0e1fc5ef | 209 | &global_auth_tok->global_auth_tok_key, &auth_tok, |
5dda6992 MH |
210 | global_auth_tok->sig); |
211 | if (rc) { | |
f4aad16a MH |
212 | printk(KERN_ERR "Could not find valid key in user " |
213 | "session keyring for sig specified in mount " | |
214 | "option: [%s]\n", global_auth_tok->sig); | |
215 | global_auth_tok->flags |= ECRYPTFS_AUTH_TOK_INVALID; | |
982363c9 | 216 | goto out; |
b5695d04 | 217 | } else { |
f4aad16a | 218 | global_auth_tok->flags &= ~ECRYPTFS_AUTH_TOK_INVALID; |
b5695d04 RS |
219 | up_write(&(global_auth_tok->global_auth_tok_key)->sem); |
220 | } | |
237fead6 | 221 | } |
982363c9 | 222 | out: |
237fead6 MH |
223 | return rc; |
224 | } | |
225 | ||
f4aad16a MH |
226 | static void ecryptfs_init_mount_crypt_stat( |
227 | struct ecryptfs_mount_crypt_stat *mount_crypt_stat) | |
228 | { | |
229 | memset((void *)mount_crypt_stat, 0, | |
230 | sizeof(struct ecryptfs_mount_crypt_stat)); | |
231 | INIT_LIST_HEAD(&mount_crypt_stat->global_auth_tok_list); | |
232 | mutex_init(&mount_crypt_stat->global_auth_tok_list_mutex); | |
233 | mount_crypt_stat->flags |= ECRYPTFS_MOUNT_CRYPT_STAT_INITIALIZED; | |
234 | } | |
235 | ||
237fead6 MH |
236 | /** |
237 | * ecryptfs_parse_options | |
238 | * @sb: The ecryptfs super block | |
25985edc | 239 | * @options: The options passed to the kernel |
76435548 | 240 | * @check_ruid: set to 1 if device uid should be checked against the ruid |
237fead6 MH |
241 | * |
242 | * Parse mount options: | |
243 | * debug=N - ecryptfs_verbosity level for debug output | |
244 | * sig=XXX - description(signature) of the key to use | |
245 | * | |
246 | * Returns the dentry object of the lower-level (lower/interposed) | |
247 | * directory; We want to mount our stackable file system on top of | |
248 | * that lower directory. | |
249 | * | |
250 | * The signature of the key to use must be the description of a key | |
251 | * already in the keyring. Mounting will fail if the key can not be | |
252 | * found. | |
253 | * | |
254 | * Returns zero on success; non-zero on error | |
255 | */ | |
76435548 JJ |
256 | static int ecryptfs_parse_options(struct ecryptfs_sb_info *sbi, char *options, |
257 | uid_t *check_ruid) | |
237fead6 MH |
258 | { |
259 | char *p; | |
260 | int rc = 0; | |
261 | int sig_set = 0; | |
262 | int cipher_name_set = 0; | |
87c94c4d | 263 | int fn_cipher_name_set = 0; |
237fead6 MH |
264 | int cipher_key_bytes; |
265 | int cipher_key_bytes_set = 0; | |
87c94c4d MH |
266 | int fn_cipher_key_bytes; |
267 | int fn_cipher_key_bytes_set = 0; | |
237fead6 | 268 | struct ecryptfs_mount_crypt_stat *mount_crypt_stat = |
2ccde7c6 | 269 | &sbi->mount_crypt_stat; |
237fead6 MH |
270 | substring_t args[MAX_OPT_ARGS]; |
271 | int token; | |
272 | char *sig_src; | |
237fead6 MH |
273 | char *cipher_name_dst; |
274 | char *cipher_name_src; | |
87c94c4d MH |
275 | char *fn_cipher_name_dst; |
276 | char *fn_cipher_name_src; | |
277 | char *fnek_dst; | |
278 | char *fnek_src; | |
237fead6 | 279 | char *cipher_key_bytes_src; |
87c94c4d | 280 | char *fn_cipher_key_bytes_src; |
5f5b331d | 281 | u8 cipher_code; |
237fead6 | 282 | |
76435548 JJ |
283 | *check_ruid = 0; |
284 | ||
237fead6 MH |
285 | if (!options) { |
286 | rc = -EINVAL; | |
287 | goto out; | |
288 | } | |
956159c3 | 289 | ecryptfs_init_mount_crypt_stat(mount_crypt_stat); |
237fead6 MH |
290 | while ((p = strsep(&options, ",")) != NULL) { |
291 | if (!*p) | |
292 | continue; | |
293 | token = match_token(p, tokens, args); | |
294 | switch (token) { | |
295 | case ecryptfs_opt_sig: | |
296 | case ecryptfs_opt_ecryptfs_sig: | |
297 | sig_src = args[0].from; | |
f4aad16a | 298 | rc = ecryptfs_add_global_auth_tok(mount_crypt_stat, |
84814d64 | 299 | sig_src, 0); |
f4aad16a MH |
300 | if (rc) { |
301 | printk(KERN_ERR "Error attempting to register " | |
302 | "global sig; rc = [%d]\n", rc); | |
303 | goto out; | |
304 | } | |
237fead6 MH |
305 | sig_set = 1; |
306 | break; | |
237fead6 MH |
307 | case ecryptfs_opt_cipher: |
308 | case ecryptfs_opt_ecryptfs_cipher: | |
309 | cipher_name_src = args[0].from; | |
310 | cipher_name_dst = | |
311 | mount_crypt_stat-> | |
312 | global_default_cipher_name; | |
313 | strncpy(cipher_name_dst, cipher_name_src, | |
314 | ECRYPTFS_MAX_CIPHER_NAME_SIZE); | |
87c94c4d | 315 | cipher_name_dst[ECRYPTFS_MAX_CIPHER_NAME_SIZE] = '\0'; |
237fead6 MH |
316 | cipher_name_set = 1; |
317 | break; | |
318 | case ecryptfs_opt_ecryptfs_key_bytes: | |
319 | cipher_key_bytes_src = args[0].from; | |
320 | cipher_key_bytes = | |
321 | (int)simple_strtol(cipher_key_bytes_src, | |
322 | &cipher_key_bytes_src, 0); | |
323 | mount_crypt_stat->global_default_cipher_key_size = | |
324 | cipher_key_bytes; | |
237fead6 MH |
325 | cipher_key_bytes_set = 1; |
326 | break; | |
327 | case ecryptfs_opt_passthrough: | |
328 | mount_crypt_stat->flags |= | |
329 | ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED; | |
330 | break; | |
17398957 MH |
331 | case ecryptfs_opt_xattr_metadata: |
332 | mount_crypt_stat->flags |= | |
333 | ECRYPTFS_XATTR_METADATA_ENABLED; | |
334 | break; | |
335 | case ecryptfs_opt_encrypted_view: | |
336 | mount_crypt_stat->flags |= | |
337 | ECRYPTFS_XATTR_METADATA_ENABLED; | |
338 | mount_crypt_stat->flags |= | |
339 | ECRYPTFS_ENCRYPTED_VIEW_ENABLED; | |
340 | break; | |
87c94c4d MH |
341 | case ecryptfs_opt_fnek_sig: |
342 | fnek_src = args[0].from; | |
343 | fnek_dst = | |
344 | mount_crypt_stat->global_default_fnek_sig; | |
345 | strncpy(fnek_dst, fnek_src, ECRYPTFS_SIG_SIZE_HEX); | |
346 | mount_crypt_stat->global_default_fnek_sig[ | |
347 | ECRYPTFS_SIG_SIZE_HEX] = '\0'; | |
348 | rc = ecryptfs_add_global_auth_tok( | |
349 | mount_crypt_stat, | |
84814d64 TH |
350 | mount_crypt_stat->global_default_fnek_sig, |
351 | ECRYPTFS_AUTH_TOK_FNEK); | |
87c94c4d MH |
352 | if (rc) { |
353 | printk(KERN_ERR "Error attempting to register " | |
354 | "global fnek sig [%s]; rc = [%d]\n", | |
355 | mount_crypt_stat->global_default_fnek_sig, | |
356 | rc); | |
357 | goto out; | |
358 | } | |
359 | mount_crypt_stat->flags |= | |
360 | (ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES | |
361 | | ECRYPTFS_GLOBAL_ENCFN_USE_MOUNT_FNEK); | |
362 | break; | |
363 | case ecryptfs_opt_fn_cipher: | |
364 | fn_cipher_name_src = args[0].from; | |
365 | fn_cipher_name_dst = | |
366 | mount_crypt_stat->global_default_fn_cipher_name; | |
367 | strncpy(fn_cipher_name_dst, fn_cipher_name_src, | |
368 | ECRYPTFS_MAX_CIPHER_NAME_SIZE); | |
369 | mount_crypt_stat->global_default_fn_cipher_name[ | |
370 | ECRYPTFS_MAX_CIPHER_NAME_SIZE] = '\0'; | |
371 | fn_cipher_name_set = 1; | |
372 | break; | |
373 | case ecryptfs_opt_fn_cipher_key_bytes: | |
374 | fn_cipher_key_bytes_src = args[0].from; | |
375 | fn_cipher_key_bytes = | |
376 | (int)simple_strtol(fn_cipher_key_bytes_src, | |
377 | &fn_cipher_key_bytes_src, 0); | |
378 | mount_crypt_stat->global_default_fn_cipher_key_bytes = | |
379 | fn_cipher_key_bytes; | |
380 | fn_cipher_key_bytes_set = 1; | |
381 | break; | |
e77cc8d2 TH |
382 | case ecryptfs_opt_unlink_sigs: |
383 | mount_crypt_stat->flags |= ECRYPTFS_UNLINK_SIGS; | |
384 | break; | |
f16feb51 RS |
385 | case ecryptfs_opt_mount_auth_tok_only: |
386 | mount_crypt_stat->flags |= | |
387 | ECRYPTFS_GLOBAL_MOUNT_AUTH_TOK_ONLY; | |
388 | break; | |
76435548 JJ |
389 | case ecryptfs_opt_check_dev_ruid: |
390 | *check_ruid = 1; | |
391 | break; | |
237fead6 MH |
392 | case ecryptfs_opt_err: |
393 | default: | |
87c94c4d MH |
394 | printk(KERN_WARNING |
395 | "%s: eCryptfs: unrecognized option [%s]\n", | |
396 | __func__, p); | |
237fead6 MH |
397 | } |
398 | } | |
237fead6 MH |
399 | if (!sig_set) { |
400 | rc = -EINVAL; | |
956159c3 MH |
401 | ecryptfs_printk(KERN_ERR, "You must supply at least one valid " |
402 | "auth tok signature as a mount " | |
237fead6 MH |
403 | "parameter; see the eCryptfs README\n"); |
404 | goto out; | |
405 | } | |
406 | if (!cipher_name_set) { | |
8f236809 MS |
407 | int cipher_name_len = strlen(ECRYPTFS_DEFAULT_CIPHER); |
408 | ||
2a559a8b | 409 | BUG_ON(cipher_name_len > ECRYPTFS_MAX_CIPHER_NAME_SIZE); |
8f236809 MS |
410 | strcpy(mount_crypt_stat->global_default_cipher_name, |
411 | ECRYPTFS_DEFAULT_CIPHER); | |
237fead6 | 412 | } |
87c94c4d MH |
413 | if ((mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES) |
414 | && !fn_cipher_name_set) | |
415 | strcpy(mount_crypt_stat->global_default_fn_cipher_name, | |
416 | mount_crypt_stat->global_default_cipher_name); | |
417 | if (!cipher_key_bytes_set) | |
e5d9cbde | 418 | mount_crypt_stat->global_default_cipher_key_size = 0; |
87c94c4d MH |
419 | if ((mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES) |
420 | && !fn_cipher_key_bytes_set) | |
421 | mount_crypt_stat->global_default_fn_cipher_key_bytes = | |
422 | mount_crypt_stat->global_default_cipher_key_size; | |
5f5b331d TS |
423 | |
424 | cipher_code = ecryptfs_code_for_cipher_string( | |
425 | mount_crypt_stat->global_default_cipher_name, | |
426 | mount_crypt_stat->global_default_cipher_key_size); | |
427 | if (!cipher_code) { | |
428 | ecryptfs_printk(KERN_ERR, | |
429 | "eCryptfs doesn't support cipher: %s", | |
430 | mount_crypt_stat->global_default_cipher_name); | |
431 | rc = -EINVAL; | |
432 | goto out; | |
433 | } | |
434 | ||
af440f52 ES |
435 | mutex_lock(&key_tfm_list_mutex); |
436 | if (!ecryptfs_tfm_exists(mount_crypt_stat->global_default_cipher_name, | |
87c94c4d | 437 | NULL)) { |
af440f52 ES |
438 | rc = ecryptfs_add_new_key_tfm( |
439 | NULL, mount_crypt_stat->global_default_cipher_name, | |
440 | mount_crypt_stat->global_default_cipher_key_size); | |
87c94c4d MH |
441 | if (rc) { |
442 | printk(KERN_ERR "Error attempting to initialize " | |
443 | "cipher with name = [%s] and key size = [%td]; " | |
444 | "rc = [%d]\n", | |
445 | mount_crypt_stat->global_default_cipher_name, | |
446 | mount_crypt_stat->global_default_cipher_key_size, | |
447 | rc); | |
448 | rc = -EINVAL; | |
449 | mutex_unlock(&key_tfm_list_mutex); | |
450 | goto out; | |
451 | } | |
452 | } | |
453 | if ((mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES) | |
454 | && !ecryptfs_tfm_exists( | |
455 | mount_crypt_stat->global_default_fn_cipher_name, NULL)) { | |
456 | rc = ecryptfs_add_new_key_tfm( | |
457 | NULL, mount_crypt_stat->global_default_fn_cipher_name, | |
458 | mount_crypt_stat->global_default_fn_cipher_key_bytes); | |
459 | if (rc) { | |
460 | printk(KERN_ERR "Error attempting to initialize " | |
461 | "cipher with name = [%s] and key size = [%td]; " | |
462 | "rc = [%d]\n", | |
463 | mount_crypt_stat->global_default_fn_cipher_name, | |
464 | mount_crypt_stat->global_default_fn_cipher_key_bytes, | |
465 | rc); | |
466 | rc = -EINVAL; | |
467 | mutex_unlock(&key_tfm_list_mutex); | |
468 | goto out; | |
469 | } | |
237fead6 | 470 | } |
87c94c4d | 471 | mutex_unlock(&key_tfm_list_mutex); |
5dda6992 | 472 | rc = ecryptfs_init_global_auth_toks(mount_crypt_stat); |
87c94c4d | 473 | if (rc) |
f4aad16a MH |
474 | printk(KERN_WARNING "One or more global auth toks could not " |
475 | "properly register; rc = [%d]\n", rc); | |
237fead6 MH |
476 | out: |
477 | return rc; | |
478 | } | |
479 | ||
480 | struct kmem_cache *ecryptfs_sb_info_cache; | |
4403158b | 481 | static struct file_system_type ecryptfs_fs_type; |
237fead6 | 482 | |
237fead6 MH |
483 | /** |
484 | * ecryptfs_get_sb | |
485 | * @fs_type | |
486 | * @flags | |
487 | * @dev_name: The path to mount over | |
488 | * @raw_data: The options passed into the kernel | |
237fead6 | 489 | */ |
4d143beb AV |
490 | static struct dentry *ecryptfs_mount(struct file_system_type *fs_type, int flags, |
491 | const char *dev_name, void *raw_data) | |
237fead6 | 492 | { |
2ccde7c6 AV |
493 | struct super_block *s; |
494 | struct ecryptfs_sb_info *sbi; | |
332b122d | 495 | struct ecryptfs_mount_crypt_stat *mount_crypt_stat; |
2ccde7c6 AV |
496 | struct ecryptfs_dentry_info *root_info; |
497 | const char *err = "Getting sb failed"; | |
66cb7666 AV |
498 | struct inode *inode; |
499 | struct path path; | |
76435548 | 500 | uid_t check_ruid; |
237fead6 | 501 | int rc; |
237fead6 | 502 | |
2ccde7c6 AV |
503 | sbi = kmem_cache_zalloc(ecryptfs_sb_info_cache, GFP_KERNEL); |
504 | if (!sbi) { | |
505 | rc = -ENOMEM; | |
237fead6 MH |
506 | goto out; |
507 | } | |
2ccde7c6 | 508 | |
76435548 | 509 | rc = ecryptfs_parse_options(sbi, raw_data, &check_ruid); |
237fead6 | 510 | if (rc) { |
2ccde7c6 AV |
511 | err = "Error parsing options"; |
512 | goto out; | |
237fead6 | 513 | } |
332b122d | 514 | mount_crypt_stat = &sbi->mount_crypt_stat; |
2ccde7c6 | 515 | |
9249e17f | 516 | s = sget(fs_type, NULL, set_anon_super, flags, NULL); |
2ccde7c6 AV |
517 | if (IS_ERR(s)) { |
518 | rc = PTR_ERR(s); | |
519 | goto out; | |
520 | } | |
521 | ||
b4caecd4 | 522 | rc = bdi_setup_and_register(&sbi->bdi, "ecryptfs"); |
66cb7666 AV |
523 | if (rc) |
524 | goto out1; | |
2ccde7c6 AV |
525 | |
526 | ecryptfs_set_superblock_private(s, sbi); | |
527 | s->s_bdi = &sbi->bdi; | |
528 | ||
529 | /* ->kill_sb() will take care of sbi after that point */ | |
530 | sbi = NULL; | |
531 | s->s_op = &ecryptfs_sops; | |
66cb7666 | 532 | s->s_d_op = &ecryptfs_dops; |
2ccde7c6 | 533 | |
66cb7666 AV |
534 | err = "Reading sb failed"; |
535 | rc = kern_path(dev_name, LOOKUP_FOLLOW | LOOKUP_DIRECTORY, &path); | |
536 | if (rc) { | |
537 | ecryptfs_printk(KERN_WARNING, "kern_path() failed\n"); | |
538 | goto out1; | |
539 | } | |
540 | if (path.dentry->d_sb->s_type == &ecryptfs_fs_type) { | |
541 | rc = -EINVAL; | |
542 | printk(KERN_ERR "Mount on filesystem of type " | |
543 | "eCryptfs explicitly disallowed due to " | |
544 | "known incompatibilities\n"); | |
545 | goto out_free; | |
546 | } | |
76435548 | 547 | |
2b0143b5 | 548 | if (check_ruid && !uid_eq(d_inode(path.dentry)->i_uid, current_uid())) { |
76435548 JJ |
549 | rc = -EPERM; |
550 | printk(KERN_ERR "Mount of device (uid: %d) not owned by " | |
551 | "requested user (uid: %d)\n", | |
2b0143b5 | 552 | i_uid_read(d_inode(path.dentry)), |
cdf8c58a | 553 | from_kuid(&init_user_ns, current_uid())); |
76435548 JJ |
554 | goto out_free; |
555 | } | |
556 | ||
66cb7666 | 557 | ecryptfs_set_superblock_lower(s, path.dentry->d_sb); |
069ddcda TH |
558 | |
559 | /** | |
560 | * Set the POSIX ACL flag based on whether they're enabled in the lower | |
332b122d | 561 | * mount. |
069ddcda TH |
562 | */ |
563 | s->s_flags = flags & ~MS_POSIXACL; | |
332b122d TH |
564 | s->s_flags |= path.dentry->d_sb->s_flags & MS_POSIXACL; |
565 | ||
566 | /** | |
567 | * Force a read-only eCryptfs mount when: | |
568 | * 1) The lower mount is ro | |
569 | * 2) The ecryptfs_encrypted_view mount option is specified | |
570 | */ | |
571 | if (path.dentry->d_sb->s_flags & MS_RDONLY || | |
572 | mount_crypt_stat->flags & ECRYPTFS_ENCRYPTED_VIEW_ENABLED) | |
573 | s->s_flags |= MS_RDONLY; | |
069ddcda | 574 | |
66cb7666 AV |
575 | s->s_maxbytes = path.dentry->d_sb->s_maxbytes; |
576 | s->s_blocksize = path.dentry->d_sb->s_blocksize; | |
070baa51 | 577 | s->s_magic = ECRYPTFS_SUPER_MAGIC; |
69c433ed MS |
578 | s->s_stack_depth = path.dentry->d_sb->s_stack_depth + 1; |
579 | ||
580 | rc = -EINVAL; | |
581 | if (s->s_stack_depth > FILESYSTEM_MAX_STACK_DEPTH) { | |
582 | pr_err("eCryptfs: maximum fs stacking depth exceeded\n"); | |
583 | goto out_free; | |
584 | } | |
66cb7666 | 585 | |
2b0143b5 | 586 | inode = ecryptfs_get_inode(d_inode(path.dentry), s); |
66cb7666 AV |
587 | rc = PTR_ERR(inode); |
588 | if (IS_ERR(inode)) | |
589 | goto out_free; | |
590 | ||
48fde701 | 591 | s->s_root = d_make_root(inode); |
2ccde7c6 | 592 | if (!s->s_root) { |
66cb7666 AV |
593 | rc = -ENOMEM; |
594 | goto out_free; | |
2ccde7c6 | 595 | } |
2ccde7c6 | 596 | |
66cb7666 | 597 | rc = -ENOMEM; |
2ccde7c6 | 598 | root_info = kmem_cache_zalloc(ecryptfs_dentry_info_cache, GFP_KERNEL); |
66cb7666 AV |
599 | if (!root_info) |
600 | goto out_free; | |
601 | ||
2ccde7c6 AV |
602 | /* ->kill_sb() will take care of root_info */ |
603 | ecryptfs_set_dentry_private(s->s_root, root_info); | |
92dd1230 | 604 | root_info->lower_path = path; |
66cb7666 | 605 | |
2ccde7c6 | 606 | s->s_flags |= MS_ACTIVE; |
4d143beb | 607 | return dget(s->s_root); |
2ccde7c6 | 608 | |
66cb7666 AV |
609 | out_free: |
610 | path_put(&path); | |
611 | out1: | |
612 | deactivate_locked_super(s); | |
237fead6 | 613 | out: |
2ccde7c6 AV |
614 | if (sbi) { |
615 | ecryptfs_destroy_mount_crypt_stat(&sbi->mount_crypt_stat); | |
616 | kmem_cache_free(ecryptfs_sb_info_cache, sbi); | |
617 | } | |
618 | printk(KERN_ERR "%s; rc = [%d]\n", err, rc); | |
4d143beb | 619 | return ERR_PTR(rc); |
237fead6 MH |
620 | } |
621 | ||
622 | /** | |
623 | * ecryptfs_kill_block_super | |
624 | * @sb: The ecryptfs super block | |
625 | * | |
626 | * Used to bring the superblock down and free the private data. | |
237fead6 MH |
627 | */ |
628 | static void ecryptfs_kill_block_super(struct super_block *sb) | |
629 | { | |
decabd66 AV |
630 | struct ecryptfs_sb_info *sb_info = ecryptfs_superblock_to_private(sb); |
631 | kill_anon_super(sb); | |
632 | if (!sb_info) | |
633 | return; | |
634 | ecryptfs_destroy_mount_crypt_stat(&sb_info->mount_crypt_stat); | |
635 | bdi_destroy(&sb_info->bdi); | |
636 | kmem_cache_free(ecryptfs_sb_info_cache, sb_info); | |
237fead6 MH |
637 | } |
638 | ||
639 | static struct file_system_type ecryptfs_fs_type = { | |
640 | .owner = THIS_MODULE, | |
641 | .name = "ecryptfs", | |
4d143beb | 642 | .mount = ecryptfs_mount, |
237fead6 MH |
643 | .kill_sb = ecryptfs_kill_block_super, |
644 | .fs_flags = 0 | |
645 | }; | |
7f78e035 | 646 | MODULE_ALIAS_FS("ecryptfs"); |
237fead6 MH |
647 | |
648 | /** | |
649 | * inode_info_init_once | |
650 | * | |
651 | * Initializes the ecryptfs_inode_info_cache when it is created | |
652 | */ | |
653 | static void | |
51cc5068 | 654 | inode_info_init_once(void *vptr) |
237fead6 MH |
655 | { |
656 | struct ecryptfs_inode_info *ei = (struct ecryptfs_inode_info *)vptr; | |
657 | ||
a35afb83 | 658 | inode_init_once(&ei->vfs_inode); |
237fead6 MH |
659 | } |
660 | ||
661 | static struct ecryptfs_cache_info { | |
e18b890b | 662 | struct kmem_cache **cache; |
237fead6 MH |
663 | const char *name; |
664 | size_t size; | |
5d097056 | 665 | unsigned long flags; |
51cc5068 | 666 | void (*ctor)(void *obj); |
237fead6 MH |
667 | } ecryptfs_cache_infos[] = { |
668 | { | |
669 | .cache = &ecryptfs_auth_tok_list_item_cache, | |
670 | .name = "ecryptfs_auth_tok_list_item", | |
671 | .size = sizeof(struct ecryptfs_auth_tok_list_item), | |
672 | }, | |
673 | { | |
674 | .cache = &ecryptfs_file_info_cache, | |
675 | .name = "ecryptfs_file_cache", | |
676 | .size = sizeof(struct ecryptfs_file_info), | |
677 | }, | |
678 | { | |
679 | .cache = &ecryptfs_dentry_info_cache, | |
680 | .name = "ecryptfs_dentry_info_cache", | |
681 | .size = sizeof(struct ecryptfs_dentry_info), | |
682 | }, | |
683 | { | |
684 | .cache = &ecryptfs_inode_info_cache, | |
685 | .name = "ecryptfs_inode_cache", | |
686 | .size = sizeof(struct ecryptfs_inode_info), | |
5d097056 | 687 | .flags = SLAB_ACCOUNT, |
237fead6 MH |
688 | .ctor = inode_info_init_once, |
689 | }, | |
690 | { | |
691 | .cache = &ecryptfs_sb_info_cache, | |
692 | .name = "ecryptfs_sb_cache", | |
693 | .size = sizeof(struct ecryptfs_sb_info), | |
694 | }, | |
237fead6 | 695 | { |
30632870 TH |
696 | .cache = &ecryptfs_header_cache, |
697 | .name = "ecryptfs_headers", | |
09cbfeaf | 698 | .size = PAGE_SIZE, |
237fead6 | 699 | }, |
dd2a3b7a MH |
700 | { |
701 | .cache = &ecryptfs_xattr_cache, | |
702 | .name = "ecryptfs_xattr_cache", | |
09cbfeaf | 703 | .size = PAGE_SIZE, |
dd2a3b7a | 704 | }, |
eb95e7ff MH |
705 | { |
706 | .cache = &ecryptfs_key_record_cache, | |
707 | .name = "ecryptfs_key_record_cache", | |
708 | .size = sizeof(struct ecryptfs_key_record), | |
709 | }, | |
956159c3 MH |
710 | { |
711 | .cache = &ecryptfs_key_sig_cache, | |
712 | .name = "ecryptfs_key_sig_cache", | |
713 | .size = sizeof(struct ecryptfs_key_sig), | |
714 | }, | |
715 | { | |
716 | .cache = &ecryptfs_global_auth_tok_cache, | |
717 | .name = "ecryptfs_global_auth_tok_cache", | |
718 | .size = sizeof(struct ecryptfs_global_auth_tok), | |
719 | }, | |
720 | { | |
721 | .cache = &ecryptfs_key_tfm_cache, | |
722 | .name = "ecryptfs_key_tfm_cache", | |
723 | .size = sizeof(struct ecryptfs_key_tfm), | |
724 | }, | |
237fead6 MH |
725 | }; |
726 | ||
727 | static void ecryptfs_free_kmem_caches(void) | |
728 | { | |
729 | int i; | |
730 | ||
8c0a8537 KS |
731 | /* |
732 | * Make sure all delayed rcu free inodes are flushed before we | |
733 | * destroy cache. | |
734 | */ | |
735 | rcu_barrier(); | |
736 | ||
237fead6 MH |
737 | for (i = 0; i < ARRAY_SIZE(ecryptfs_cache_infos); i++) { |
738 | struct ecryptfs_cache_info *info; | |
739 | ||
740 | info = &ecryptfs_cache_infos[i]; | |
c39341cf | 741 | kmem_cache_destroy(*(info->cache)); |
237fead6 MH |
742 | } |
743 | } | |
744 | ||
745 | /** | |
746 | * ecryptfs_init_kmem_caches | |
747 | * | |
748 | * Returns zero on success; non-zero otherwise | |
749 | */ | |
750 | static int ecryptfs_init_kmem_caches(void) | |
751 | { | |
752 | int i; | |
753 | ||
754 | for (i = 0; i < ARRAY_SIZE(ecryptfs_cache_infos); i++) { | |
755 | struct ecryptfs_cache_info *info; | |
756 | ||
757 | info = &ecryptfs_cache_infos[i]; | |
5d097056 VD |
758 | *(info->cache) = kmem_cache_create(info->name, info->size, 0, |
759 | SLAB_HWCACHE_ALIGN | info->flags, info->ctor); | |
237fead6 MH |
760 | if (!*(info->cache)) { |
761 | ecryptfs_free_kmem_caches(); | |
762 | ecryptfs_printk(KERN_WARNING, "%s: " | |
763 | "kmem_cache_create failed\n", | |
764 | info->name); | |
765 | return -ENOMEM; | |
766 | } | |
767 | } | |
768 | return 0; | |
769 | } | |
770 | ||
6e90aa97 | 771 | static struct kobject *ecryptfs_kobj; |
237fead6 | 772 | |
386f275f KS |
773 | static ssize_t version_show(struct kobject *kobj, |
774 | struct kobj_attribute *attr, char *buff) | |
237fead6 MH |
775 | { |
776 | return snprintf(buff, PAGE_SIZE, "%d\n", ECRYPTFS_VERSIONING_MASK); | |
777 | } | |
778 | ||
386f275f | 779 | static struct kobj_attribute version_attr = __ATTR_RO(version); |
237fead6 | 780 | |
30a468b1 GKH |
781 | static struct attribute *attributes[] = { |
782 | &version_attr.attr, | |
30a468b1 GKH |
783 | NULL, |
784 | }; | |
785 | ||
786 | static struct attribute_group attr_group = { | |
787 | .attrs = attributes, | |
788 | }; | |
237fead6 MH |
789 | |
790 | static int do_sysfs_registration(void) | |
791 | { | |
792 | int rc; | |
793 | ||
6e90aa97 GKH |
794 | ecryptfs_kobj = kobject_create_and_add("ecryptfs", fs_kobj); |
795 | if (!ecryptfs_kobj) { | |
917e865d GKH |
796 | printk(KERN_ERR "Unable to create ecryptfs kset\n"); |
797 | rc = -ENOMEM; | |
237fead6 MH |
798 | goto out; |
799 | } | |
6e90aa97 | 800 | rc = sysfs_create_group(ecryptfs_kobj, &attr_group); |
237fead6 MH |
801 | if (rc) { |
802 | printk(KERN_ERR | |
30a468b1 | 803 | "Unable to create ecryptfs version attributes\n"); |
197b12d6 | 804 | kobject_put(ecryptfs_kobj); |
237fead6 MH |
805 | } |
806 | out: | |
807 | return rc; | |
808 | } | |
809 | ||
a75de1b3 RK |
810 | static void do_sysfs_unregistration(void) |
811 | { | |
6e90aa97 | 812 | sysfs_remove_group(ecryptfs_kobj, &attr_group); |
197b12d6 | 813 | kobject_put(ecryptfs_kobj); |
a75de1b3 RK |
814 | } |
815 | ||
237fead6 MH |
816 | static int __init ecryptfs_init(void) |
817 | { | |
818 | int rc; | |
819 | ||
09cbfeaf | 820 | if (ECRYPTFS_DEFAULT_EXTENT_SIZE > PAGE_SIZE) { |
237fead6 MH |
821 | rc = -EINVAL; |
822 | ecryptfs_printk(KERN_ERR, "The eCryptfs extent size is " | |
823 | "larger than the host's page size, and so " | |
824 | "eCryptfs cannot run on this system. The " | |
888d57bb JP |
825 | "default eCryptfs extent size is [%u] bytes; " |
826 | "the page size is [%lu] bytes.\n", | |
827 | ECRYPTFS_DEFAULT_EXTENT_SIZE, | |
09cbfeaf | 828 | (unsigned long)PAGE_SIZE); |
237fead6 MH |
829 | goto out; |
830 | } | |
831 | rc = ecryptfs_init_kmem_caches(); | |
832 | if (rc) { | |
833 | printk(KERN_ERR | |
834 | "Failed to allocate one or more kmem_cache objects\n"); | |
835 | goto out; | |
836 | } | |
237fead6 MH |
837 | rc = do_sysfs_registration(); |
838 | if (rc) { | |
839 | printk(KERN_ERR "sysfs registration failed\n"); | |
0794f569 | 840 | goto out_free_kmem_caches; |
237fead6 | 841 | } |
746f1e55 MH |
842 | rc = ecryptfs_init_kthread(); |
843 | if (rc) { | |
844 | printk(KERN_ERR "%s: kthread initialization failed; " | |
845 | "rc = [%d]\n", __func__, rc); | |
846 | goto out_do_sysfs_unregistration; | |
847 | } | |
624ae528 | 848 | rc = ecryptfs_init_messaging(); |
dddfa461 | 849 | if (rc) { |
25985edc | 850 | printk(KERN_ERR "Failure occurred while attempting to " |
624ae528 TH |
851 | "initialize the communications channel to " |
852 | "ecryptfsd\n"); | |
746f1e55 | 853 | goto out_destroy_kthread; |
956159c3 MH |
854 | } |
855 | rc = ecryptfs_init_crypto(); | |
856 | if (rc) { | |
857 | printk(KERN_ERR "Failure whilst attempting to init crypto; " | |
858 | "rc = [%d]\n", rc); | |
cf81f89d | 859 | goto out_release_messaging; |
dddfa461 | 860 | } |
0794f569 AV |
861 | rc = register_filesystem(&ecryptfs_fs_type); |
862 | if (rc) { | |
863 | printk(KERN_ERR "Failed to register filesystem\n"); | |
864 | goto out_destroy_crypto; | |
865 | } | |
2830bfd6 ES |
866 | if (ecryptfs_verbosity > 0) |
867 | printk(KERN_CRIT "eCryptfs verbosity set to %d. Secret values " | |
868 | "will be written to the syslog!\n", ecryptfs_verbosity); | |
869 | ||
cf81f89d | 870 | goto out; |
0794f569 AV |
871 | out_destroy_crypto: |
872 | ecryptfs_destroy_crypto(); | |
cf81f89d | 873 | out_release_messaging: |
624ae528 | 874 | ecryptfs_release_messaging(); |
746f1e55 MH |
875 | out_destroy_kthread: |
876 | ecryptfs_destroy_kthread(); | |
cf81f89d MH |
877 | out_do_sysfs_unregistration: |
878 | do_sysfs_unregistration(); | |
cf81f89d MH |
879 | out_free_kmem_caches: |
880 | ecryptfs_free_kmem_caches(); | |
237fead6 MH |
881 | out: |
882 | return rc; | |
883 | } | |
884 | ||
885 | static void __exit ecryptfs_exit(void) | |
886 | { | |
cf81f89d MH |
887 | int rc; |
888 | ||
889 | rc = ecryptfs_destroy_crypto(); | |
890 | if (rc) | |
891 | printk(KERN_ERR "Failure whilst attempting to destroy crypto; " | |
892 | "rc = [%d]\n", rc); | |
624ae528 | 893 | ecryptfs_release_messaging(); |
746f1e55 | 894 | ecryptfs_destroy_kthread(); |
cf81f89d | 895 | do_sysfs_unregistration(); |
237fead6 MH |
896 | unregister_filesystem(&ecryptfs_fs_type); |
897 | ecryptfs_free_kmem_caches(); | |
898 | } | |
899 | ||
900 | MODULE_AUTHOR("Michael A. Halcrow <mhalcrow@us.ibm.com>"); | |
901 | MODULE_DESCRIPTION("eCryptfs"); | |
902 | ||
903 | MODULE_LICENSE("GPL"); | |
904 | ||
905 | module_init(ecryptfs_init) | |
906 | module_exit(ecryptfs_exit) |