blob: 151872dcc1f402ef47273b6da96a5d15a3f251ba [file] [log] [blame]
Michael Halcrow237fead2006-10-04 02:16:22 -07001/**
2 * eCryptfs: Linux filesystem encryption layer
3 *
4 * Copyright (C) 1997-2003 Erez Zadok
5 * Copyright (C) 2001-2003 Stony Brook University
Michael Halcrowdd2a3b72007-02-12 00:53:46 -08006 * Copyright (C) 2004-2007 International Business Machines Corp.
Michael Halcrow237fead2006-10-04 02:16:22 -07007 * Author(s): Michael A. Halcrow <mahalcro@us.ibm.com>
8 * Michael C. Thompson <mcthomps@us.ibm.com>
Michael Halcrowdddfa462007-02-12 00:53:44 -08009 * Tyler Hicks <tyhicks@ou.edu>
Michael Halcrow237fead2006-10-04 02:16:22 -070010 *
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>
Michael Halcrow237fead2006-10-04 02:16:22 -070032#include <linux/mount.h>
Michael Halcrow237fead2006-10-04 02:16:22 -070033#include <linux/pagemap.h>
34#include <linux/key.h>
35#include <linux/parser.h>
Josef "Jeff" Sipek0cc72dc2006-12-08 02:36:31 -080036#include <linux/fs_stack.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090037#include <linux/slab.h>
Roberto Sassu070baa52010-11-03 11:11:22 +010038#include <linux/magic.h>
Michael Halcrow237fead2006-10-04 02:16:22 -070039#include "ecryptfs_kernel.h"
40
41/**
42 * Module parameter that defines the ecryptfs_verbosity level.
43 */
44int ecryptfs_verbosity = 0;
45
46module_param(ecryptfs_verbosity, int, 0);
47MODULE_PARM_DESC(ecryptfs_verbosity,
48 "Initial verbosity level (0 or 1; defaults to "
49 "0, which is Quiet)");
50
Michael Halcrowdddfa462007-02-12 00:53:44 -080051/**
Tyler Hicks624ae522008-10-15 22:02:51 -070052 * Module parameter that defines the number of message buffer elements
Michael Halcrowdddfa462007-02-12 00:53:44 -080053 */
54unsigned int ecryptfs_message_buf_len = ECRYPTFS_DEFAULT_MSG_CTX_ELEMS;
55
56module_param(ecryptfs_message_buf_len, uint, 0);
57MODULE_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
Tyler Hicks624ae522008-10-15 22:02:51 -070062 * for a response from ecryptfsd. The actual sleep time will be, more than
Michael Halcrowdddfa462007-02-12 00:53:44 -080063 * likely, a small amount greater than this specified value, but only less if
Tyler Hicks624ae522008-10-15 22:02:51 -070064 * the message successfully arrives.
Michael Halcrowdddfa462007-02-12 00:53:44 -080065 */
66signed long ecryptfs_message_wait_timeout = ECRYPTFS_MAX_MSG_CTX_TTL / HZ;
67
68module_param(ecryptfs_message_wait_timeout, long, 0);
69MODULE_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 */
79unsigned int ecryptfs_number_of_users = ECRYPTFS_DEFAULT_NUM_USERS;
80
81module_param(ecryptfs_number_of_users, uint, 0);
82MODULE_PARM_DESC(ecryptfs_number_of_users, "An estimate of the number of "
83 "concurrent users of eCryptfs");
84
Michael Halcrow237fead2006-10-04 02:16:22 -070085void __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
97/**
Tyler Hicks332ab162011-04-14 15:35:11 -050098 * ecryptfs_init_lower_file
Michael Halcrow4981e082007-10-16 01:28:09 -070099 * @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
Tyler Hicks332ab162011-04-14 15:35:11 -0500106 * 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.
Michael Halcrow4981e082007-10-16 01:28:09 -0700109 *
Tyler Hicks332ab162011-04-14 15:35:11 -0500110 * The lower file will be opened with read/write permissions, if
Michael Halcrow4981e082007-10-16 01:28:09 -0700111 * possible. Otherwise, it is opened read-only.
112 *
Tyler Hicks332ab162011-04-14 15:35:11 -0500113 * This function does nothing if a lower file is already
Michael Halcrow4981e082007-10-16 01:28:09 -0700114 * associated with the eCryptfs inode.
115 *
116 * Returns zero on success; non-zero otherwise
117 */
Tyler Hicks332ab162011-04-14 15:35:11 -0500118static int ecryptfs_init_lower_file(struct dentry *dentry,
119 struct file **lower_file)
Michael Halcrow4981e082007-10-16 01:28:09 -0700120{
David Howells745ca242008-11-14 10:39:22 +1100121 const struct cred *cred = current_cred();
Matthew Wilcoxcc18ec32013-06-15 07:55:59 -0400122 struct path *path = ecryptfs_dentry_to_lower_path(dentry);
Tyler Hicks332ab162011-04-14 15:35:11 -0500123 int rc;
Michael Halcrow4981e082007-10-16 01:28:09 -0700124
Matthew Wilcoxcc18ec32013-06-15 07:55:59 -0400125 rc = ecryptfs_privileged_open(lower_file, path->dentry, path->mnt,
Tyler Hicks332ab162011-04-14 15:35:11 -0500126 cred);
127 if (rc) {
128 printk(KERN_ERR "Error opening lower file "
129 "for lower_dentry [0x%p] and lower_mnt [0x%p]; "
Matthew Wilcoxcc18ec32013-06-15 07:55:59 -0400130 "rc = [%d]\n", path->dentry, path->mnt, rc);
Tyler Hicks332ab162011-04-14 15:35:11 -0500131 (*lower_file) = NULL;
Michael Halcrow4981e082007-10-16 01:28:09 -0700132 }
Michael Halcrow4981e082007-10-16 01:28:09 -0700133 return rc;
134}
135
Tyler Hicks3b06b3e2011-05-24 03:49:02 -0500136int ecryptfs_get_lower_file(struct dentry *dentry, struct inode *inode)
Tyler Hicks332ab162011-04-14 15:35:11 -0500137{
Tyler Hicks3b06b3e2011-05-24 03:49:02 -0500138 struct ecryptfs_inode_info *inode_info;
Tyler Hicks332ab162011-04-14 15:35:11 -0500139 int count, rc = 0;
140
Tyler Hicks3b06b3e2011-05-24 03:49:02 -0500141 inode_info = ecryptfs_inode_to_private(inode);
Tyler Hicks332ab162011-04-14 15:35:11 -0500142 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);
151 }
152 mutex_unlock(&inode_info->lower_file_mutex);
153 return rc;
154}
155
156void 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)) {
Tyler Hicks7149f252012-09-12 18:02:46 -0700163 filemap_write_and_wait(inode->i_mapping);
Tyler Hicks332ab162011-04-14 15:35:11 -0500164 fput(inode_info->lower_file);
165 inode_info->lower_file = NULL;
166 mutex_unlock(&inode_info->lower_file_mutex);
167 }
168}
169
Eric Sandeen2830bfd2008-02-06 01:38:34 -0800170enum { ecryptfs_opt_sig, ecryptfs_opt_ecryptfs_sig,
171 ecryptfs_opt_cipher, ecryptfs_opt_ecryptfs_cipher,
172 ecryptfs_opt_ecryptfs_key_bytes,
Michael Halcrow17398952007-02-12 00:53:45 -0800173 ecryptfs_opt_passthrough, ecryptfs_opt_xattr_metadata,
Michael Halcrow87c94c42009-01-06 14:42:01 -0800174 ecryptfs_opt_encrypted_view, ecryptfs_opt_fnek_sig,
175 ecryptfs_opt_fn_cipher, ecryptfs_opt_fn_cipher_key_bytes,
Roberto Sassuf16feb52010-10-06 18:31:32 +0200176 ecryptfs_opt_unlink_sigs, ecryptfs_opt_mount_auth_tok_only,
John Johansen76435542011-07-22 08:14:15 -0700177 ecryptfs_opt_check_dev_ruid,
Roberto Sassuf16feb52010-10-06 18:31:32 +0200178 ecryptfs_opt_err };
Michael Halcrow237fead2006-10-04 02:16:22 -0700179
Steven Whitehousea447c092008-10-13 10:46:57 +0100180static const match_table_t tokens = {
Michael Halcrow237fead2006-10-04 02:16:22 -0700181 {ecryptfs_opt_sig, "sig=%s"},
182 {ecryptfs_opt_ecryptfs_sig, "ecryptfs_sig=%s"},
Michael Halcrow237fead2006-10-04 02:16:22 -0700183 {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"},
Michael Halcrow17398952007-02-12 00:53:45 -0800187 {ecryptfs_opt_xattr_metadata, "ecryptfs_xattr_metadata"},
188 {ecryptfs_opt_encrypted_view, "ecryptfs_encrypted_view"},
Michael Halcrow87c94c42009-01-06 14:42:01 -0800189 {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"},
Tyler Hickse77cc8d2009-04-22 04:08:46 -0500192 {ecryptfs_opt_unlink_sigs, "ecryptfs_unlink_sigs"},
Roberto Sassuf16feb52010-10-06 18:31:32 +0200193 {ecryptfs_opt_mount_auth_tok_only, "ecryptfs_mount_auth_tok_only"},
John Johansen76435542011-07-22 08:14:15 -0700194 {ecryptfs_opt_check_dev_ruid, "ecryptfs_check_dev_ruid"},
Michael Halcrow237fead2006-10-04 02:16:22 -0700195 {ecryptfs_opt_err, NULL}
196};
197
Michael Halcrowf4aad162007-10-16 01:27:53 -0700198static int ecryptfs_init_global_auth_toks(
199 struct ecryptfs_mount_crypt_stat *mount_crypt_stat)
Michael Halcrow237fead2006-10-04 02:16:22 -0700200{
Michael Halcrowf4aad162007-10-16 01:27:53 -0700201 struct ecryptfs_global_auth_tok *global_auth_tok;
Roberto Sassu0e1fc5e2011-03-21 16:00:53 +0100202 struct ecryptfs_auth_tok *auth_tok;
Michael Halcrow237fead2006-10-04 02:16:22 -0700203 int rc = 0;
Michael Halcrow237fead2006-10-04 02:16:22 -0700204
Michael Halcrowf4aad162007-10-16 01:27:53 -0700205 list_for_each_entry(global_auth_tok,
206 &mount_crypt_stat->global_auth_tok_list,
207 mount_crypt_stat_list) {
Michael Halcrow5dda6992007-10-16 01:28:06 -0700208 rc = ecryptfs_keyring_auth_tok_for_sig(
Roberto Sassu0e1fc5e2011-03-21 16:00:53 +0100209 &global_auth_tok->global_auth_tok_key, &auth_tok,
Michael Halcrow5dda6992007-10-16 01:28:06 -0700210 global_auth_tok->sig);
211 if (rc) {
Michael Halcrowf4aad162007-10-16 01:27:53 -0700212 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;
Eric Sandeen982363c2008-07-23 21:30:04 -0700216 goto out;
Roberto Sassub5695d02011-03-21 16:00:55 +0100217 } else {
Michael Halcrowf4aad162007-10-16 01:27:53 -0700218 global_auth_tok->flags &= ~ECRYPTFS_AUTH_TOK_INVALID;
Roberto Sassub5695d02011-03-21 16:00:55 +0100219 up_write(&(global_auth_tok->global_auth_tok_key)->sem);
220 }
Michael Halcrow237fead2006-10-04 02:16:22 -0700221 }
Eric Sandeen982363c2008-07-23 21:30:04 -0700222out:
Michael Halcrow237fead2006-10-04 02:16:22 -0700223 return rc;
224}
225
Michael Halcrowf4aad162007-10-16 01:27:53 -0700226static 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
Michael Halcrow237fead2006-10-04 02:16:22 -0700236/**
237 * ecryptfs_parse_options
238 * @sb: The ecryptfs super block
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300239 * @options: The options passed to the kernel
John Johansen76435542011-07-22 08:14:15 -0700240 * @check_ruid: set to 1 if device uid should be checked against the ruid
Michael Halcrow237fead2006-10-04 02:16:22 -0700241 *
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 */
John Johansen76435542011-07-22 08:14:15 -0700256static int ecryptfs_parse_options(struct ecryptfs_sb_info *sbi, char *options,
257 uid_t *check_ruid)
Michael Halcrow237fead2006-10-04 02:16:22 -0700258{
259 char *p;
260 int rc = 0;
261 int sig_set = 0;
262 int cipher_name_set = 0;
Michael Halcrow87c94c42009-01-06 14:42:01 -0800263 int fn_cipher_name_set = 0;
Michael Halcrow237fead2006-10-04 02:16:22 -0700264 int cipher_key_bytes;
265 int cipher_key_bytes_set = 0;
Michael Halcrow87c94c42009-01-06 14:42:01 -0800266 int fn_cipher_key_bytes;
267 int fn_cipher_key_bytes_set = 0;
Michael Halcrow237fead2006-10-04 02:16:22 -0700268 struct ecryptfs_mount_crypt_stat *mount_crypt_stat =
Al Viro2ccde7c2010-03-21 12:24:29 -0400269 &sbi->mount_crypt_stat;
Michael Halcrow237fead2006-10-04 02:16:22 -0700270 substring_t args[MAX_OPT_ARGS];
271 int token;
272 char *sig_src;
Michael Halcrow237fead2006-10-04 02:16:22 -0700273 char *cipher_name_dst;
274 char *cipher_name_src;
Michael Halcrow87c94c42009-01-06 14:42:01 -0800275 char *fn_cipher_name_dst;
276 char *fn_cipher_name_src;
277 char *fnek_dst;
278 char *fnek_src;
Michael Halcrow237fead2006-10-04 02:16:22 -0700279 char *cipher_key_bytes_src;
Michael Halcrow87c94c42009-01-06 14:42:01 -0800280 char *fn_cipher_key_bytes_src;
Tim Sally5f5b3312012-07-12 19:10:24 -0400281 u8 cipher_code;
Michael Halcrow237fead2006-10-04 02:16:22 -0700282
John Johansen76435542011-07-22 08:14:15 -0700283 *check_ruid = 0;
284
Michael Halcrow237fead2006-10-04 02:16:22 -0700285 if (!options) {
286 rc = -EINVAL;
287 goto out;
288 }
Michael Halcrow956159c2007-10-16 01:27:55 -0700289 ecryptfs_init_mount_crypt_stat(mount_crypt_stat);
Michael Halcrow237fead2006-10-04 02:16:22 -0700290 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;
Michael Halcrowf4aad162007-10-16 01:27:53 -0700298 rc = ecryptfs_add_global_auth_tok(mount_crypt_stat,
Tyler Hicks84814d62009-03-13 13:51:59 -0700299 sig_src, 0);
Michael Halcrowf4aad162007-10-16 01:27:53 -0700300 if (rc) {
301 printk(KERN_ERR "Error attempting to register "
302 "global sig; rc = [%d]\n", rc);
303 goto out;
304 }
Michael Halcrow237fead2006-10-04 02:16:22 -0700305 sig_set = 1;
306 break;
Michael Halcrow237fead2006-10-04 02:16:22 -0700307 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);
Michael Halcrow87c94c42009-01-06 14:42:01 -0800315 cipher_name_dst[ECRYPTFS_MAX_CIPHER_NAME_SIZE] = '\0';
Michael Halcrow237fead2006-10-04 02:16:22 -0700316 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;
Michael Halcrow237fead2006-10-04 02:16:22 -0700325 cipher_key_bytes_set = 1;
326 break;
327 case ecryptfs_opt_passthrough:
328 mount_crypt_stat->flags |=
329 ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED;
330 break;
Michael Halcrow17398952007-02-12 00:53:45 -0800331 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;
Michael Halcrow87c94c42009-01-06 14:42:01 -0800341 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,
Tyler Hicks84814d62009-03-13 13:51:59 -0700350 mount_crypt_stat->global_default_fnek_sig,
351 ECRYPTFS_AUTH_TOK_FNEK);
Michael Halcrow87c94c42009-01-06 14:42:01 -0800352 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;
Tyler Hickse77cc8d2009-04-22 04:08:46 -0500382 case ecryptfs_opt_unlink_sigs:
383 mount_crypt_stat->flags |= ECRYPTFS_UNLINK_SIGS;
384 break;
Roberto Sassuf16feb52010-10-06 18:31:32 +0200385 case ecryptfs_opt_mount_auth_tok_only:
386 mount_crypt_stat->flags |=
387 ECRYPTFS_GLOBAL_MOUNT_AUTH_TOK_ONLY;
388 break;
John Johansen76435542011-07-22 08:14:15 -0700389 case ecryptfs_opt_check_dev_ruid:
390 *check_ruid = 1;
391 break;
Michael Halcrow237fead2006-10-04 02:16:22 -0700392 case ecryptfs_opt_err:
393 default:
Michael Halcrow87c94c42009-01-06 14:42:01 -0800394 printk(KERN_WARNING
395 "%s: eCryptfs: unrecognized option [%s]\n",
396 __func__, p);
Michael Halcrow237fead2006-10-04 02:16:22 -0700397 }
398 }
Michael Halcrow237fead2006-10-04 02:16:22 -0700399 if (!sig_set) {
400 rc = -EINVAL;
Michael Halcrow956159c2007-10-16 01:27:55 -0700401 ecryptfs_printk(KERN_ERR, "You must supply at least one valid "
402 "auth tok signature as a mount "
Michael Halcrow237fead2006-10-04 02:16:22 -0700403 "parameter; see the eCryptfs README\n");
404 goto out;
405 }
406 if (!cipher_name_set) {
Miklos Szeredi8f236802008-07-23 21:30:05 -0700407 int cipher_name_len = strlen(ECRYPTFS_DEFAULT_CIPHER);
408
Colin Ian King2a559a82015-02-23 11:34:10 +0000409 BUG_ON(cipher_name_len > ECRYPTFS_MAX_CIPHER_NAME_SIZE);
Miklos Szeredi8f236802008-07-23 21:30:05 -0700410 strcpy(mount_crypt_stat->global_default_cipher_name,
411 ECRYPTFS_DEFAULT_CIPHER);
Michael Halcrow237fead2006-10-04 02:16:22 -0700412 }
Michael Halcrow87c94c42009-01-06 14:42:01 -0800413 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)
Michael Halcrowe5d9cbd2006-10-30 22:07:16 -0800418 mount_crypt_stat->global_default_cipher_key_size = 0;
Michael Halcrow87c94c42009-01-06 14:42:01 -0800419 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;
Tim Sally5f5b3312012-07-12 19:10:24 -0400423
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
Eric Sandeenaf440f52008-02-06 01:38:37 -0800435 mutex_lock(&key_tfm_list_mutex);
436 if (!ecryptfs_tfm_exists(mount_crypt_stat->global_default_cipher_name,
Michael Halcrow87c94c42009-01-06 14:42:01 -0800437 NULL)) {
Eric Sandeenaf440f52008-02-06 01:38:37 -0800438 rc = ecryptfs_add_new_key_tfm(
439 NULL, mount_crypt_stat->global_default_cipher_name,
440 mount_crypt_stat->global_default_cipher_key_size);
Michael Halcrow87c94c42009-01-06 14:42:01 -0800441 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 }
Michael Halcrow237fead2006-10-04 02:16:22 -0700452 }
Michael Halcrow87c94c42009-01-06 14:42:01 -0800453 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 }
470 }
471 mutex_unlock(&key_tfm_list_mutex);
Michael Halcrow5dda6992007-10-16 01:28:06 -0700472 rc = ecryptfs_init_global_auth_toks(mount_crypt_stat);
Michael Halcrow87c94c42009-01-06 14:42:01 -0800473 if (rc)
Michael Halcrowf4aad162007-10-16 01:27:53 -0700474 printk(KERN_WARNING "One or more global auth toks could not "
475 "properly register; rc = [%d]\n", rc);
Michael Halcrow237fead2006-10-04 02:16:22 -0700476out:
477 return rc;
478}
479
480struct kmem_cache *ecryptfs_sb_info_cache;
Al Viro44031582010-05-17 00:59:46 -0400481static struct file_system_type ecryptfs_fs_type;
Michael Halcrow237fead2006-10-04 02:16:22 -0700482
483/**
Michael Halcrow237fead2006-10-04 02:16:22 -0700484 * 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
Michael Halcrow237fead2006-10-04 02:16:22 -0700489 */
Al Viro4d143be2010-07-26 13:33:36 +0400490static struct dentry *ecryptfs_mount(struct file_system_type *fs_type, int flags,
491 const char *dev_name, void *raw_data)
Michael Halcrow237fead2006-10-04 02:16:22 -0700492{
Al Viro2ccde7c2010-03-21 12:24:29 -0400493 struct super_block *s;
494 struct ecryptfs_sb_info *sbi;
Tyler Hicks332b1222014-10-07 15:51:55 -0500495 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
Al Viro2ccde7c2010-03-21 12:24:29 -0400496 struct ecryptfs_dentry_info *root_info;
497 const char *err = "Getting sb failed";
Al Viro66cb7662011-01-12 20:04:37 -0500498 struct inode *inode;
499 struct path path;
John Johansen76435542011-07-22 08:14:15 -0700500 uid_t check_ruid;
Michael Halcrow237fead2006-10-04 02:16:22 -0700501 int rc;
Michael Halcrow237fead2006-10-04 02:16:22 -0700502
Al Viro2ccde7c2010-03-21 12:24:29 -0400503 sbi = kmem_cache_zalloc(ecryptfs_sb_info_cache, GFP_KERNEL);
504 if (!sbi) {
505 rc = -ENOMEM;
Michael Halcrow237fead2006-10-04 02:16:22 -0700506 goto out;
507 }
Al Viro2ccde7c2010-03-21 12:24:29 -0400508
John Johansen76435542011-07-22 08:14:15 -0700509 rc = ecryptfs_parse_options(sbi, raw_data, &check_ruid);
Michael Halcrow237fead2006-10-04 02:16:22 -0700510 if (rc) {
Al Viro2ccde7c2010-03-21 12:24:29 -0400511 err = "Error parsing options";
512 goto out;
Michael Halcrow237fead2006-10-04 02:16:22 -0700513 }
Tyler Hicks332b1222014-10-07 15:51:55 -0500514 mount_crypt_stat = &sbi->mount_crypt_stat;
Al Viro2ccde7c2010-03-21 12:24:29 -0400515
David Howells9249e172012-06-25 12:55:37 +0100516 s = sget(fs_type, NULL, set_anon_super, flags, NULL);
Al Viro2ccde7c2010-03-21 12:24:29 -0400517 if (IS_ERR(s)) {
518 rc = PTR_ERR(s);
519 goto out;
520 }
521
Christoph Hellwigb4caecd2015-01-14 10:42:32 +0100522 rc = bdi_setup_and_register(&sbi->bdi, "ecryptfs");
Al Viro66cb7662011-01-12 20:04:37 -0500523 if (rc)
524 goto out1;
Al Viro2ccde7c2010-03-21 12:24:29 -0400525
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;
Andreas Gruenbacher4b899da2016-09-29 17:48:36 +0200532 s->s_xattr = ecryptfs_xattr_handlers;
Al Viro66cb7662011-01-12 20:04:37 -0500533 s->s_d_op = &ecryptfs_dops;
534
535 err = "Reading sb failed";
536 rc = kern_path(dev_name, LOOKUP_FOLLOW | LOOKUP_DIRECTORY, &path);
537 if (rc) {
538 ecryptfs_printk(KERN_WARNING, "kern_path() failed\n");
539 goto out1;
540 }
541 if (path.dentry->d_sb->s_type == &ecryptfs_fs_type) {
542 rc = -EINVAL;
543 printk(KERN_ERR "Mount on filesystem of type "
544 "eCryptfs explicitly disallowed due to "
545 "known incompatibilities\n");
546 goto out_free;
547 }
John Johansen76435542011-07-22 08:14:15 -0700548
David Howells2b0143b2015-03-17 22:25:59 +0000549 if (check_ruid && !uid_eq(d_inode(path.dentry)->i_uid, current_uid())) {
John Johansen76435542011-07-22 08:14:15 -0700550 rc = -EPERM;
551 printk(KERN_ERR "Mount of device (uid: %d) not owned by "
552 "requested user (uid: %d)\n",
David Howells2b0143b2015-03-17 22:25:59 +0000553 i_uid_read(d_inode(path.dentry)),
Eric W. Biedermancdf8c582012-02-07 16:24:33 -0800554 from_kuid(&init_user_ns, current_uid()));
John Johansen76435542011-07-22 08:14:15 -0700555 goto out_free;
556 }
557
Al Viro66cb7662011-01-12 20:04:37 -0500558 ecryptfs_set_superblock_lower(s, path.dentry->d_sb);
Tyler Hicks069ddcd2012-06-11 15:42:32 -0700559
560 /**
561 * Set the POSIX ACL flag based on whether they're enabled in the lower
Tyler Hicks332b1222014-10-07 15:51:55 -0500562 * mount.
Tyler Hicks069ddcd2012-06-11 15:42:32 -0700563 */
564 s->s_flags = flags & ~MS_POSIXACL;
Tyler Hicks332b1222014-10-07 15:51:55 -0500565 s->s_flags |= path.dentry->d_sb->s_flags & MS_POSIXACL;
566
567 /**
568 * Force a read-only eCryptfs mount when:
569 * 1) The lower mount is ro
570 * 2) The ecryptfs_encrypted_view mount option is specified
571 */
572 if (path.dentry->d_sb->s_flags & MS_RDONLY ||
573 mount_crypt_stat->flags & ECRYPTFS_ENCRYPTED_VIEW_ENABLED)
574 s->s_flags |= MS_RDONLY;
Tyler Hicks069ddcd2012-06-11 15:42:32 -0700575
Al Viro66cb7662011-01-12 20:04:37 -0500576 s->s_maxbytes = path.dentry->d_sb->s_maxbytes;
577 s->s_blocksize = path.dentry->d_sb->s_blocksize;
Roberto Sassu070baa52010-11-03 11:11:22 +0100578 s->s_magic = ECRYPTFS_SUPER_MAGIC;
Miklos Szeredi69c433e2014-10-24 00:14:39 +0200579 s->s_stack_depth = path.dentry->d_sb->s_stack_depth + 1;
580
581 rc = -EINVAL;
582 if (s->s_stack_depth > FILESYSTEM_MAX_STACK_DEPTH) {
583 pr_err("eCryptfs: maximum fs stacking depth exceeded\n");
584 goto out_free;
585 }
Al Viro66cb7662011-01-12 20:04:37 -0500586
David Howells2b0143b2015-03-17 22:25:59 +0000587 inode = ecryptfs_get_inode(d_inode(path.dentry), s);
Al Viro66cb7662011-01-12 20:04:37 -0500588 rc = PTR_ERR(inode);
589 if (IS_ERR(inode))
590 goto out_free;
591
Al Viro48fde702012-01-08 22:15:13 -0500592 s->s_root = d_make_root(inode);
Al Viro66cb7662011-01-12 20:04:37 -0500593 if (!s->s_root) {
Al Viro66cb7662011-01-12 20:04:37 -0500594 rc = -ENOMEM;
595 goto out_free;
596 }
Al Viro2ccde7c2010-03-21 12:24:29 -0400597
598 rc = -ENOMEM;
Al Viro2ccde7c2010-03-21 12:24:29 -0400599 root_info = kmem_cache_zalloc(ecryptfs_dentry_info_cache, GFP_KERNEL);
Al Viro66cb7662011-01-12 20:04:37 -0500600 if (!root_info)
601 goto out_free;
602
Al Viro2ccde7c2010-03-21 12:24:29 -0400603 /* ->kill_sb() will take care of root_info */
604 ecryptfs_set_dentry_private(s->s_root, root_info);
Al Viro92dd1232013-09-15 20:50:13 -0400605 root_info->lower_path = path;
Al Viro66cb7662011-01-12 20:04:37 -0500606
Al Viro2ccde7c2010-03-21 12:24:29 -0400607 s->s_flags |= MS_ACTIVE;
Al Viro4d143be2010-07-26 13:33:36 +0400608 return dget(s->s_root);
Al Viro2ccde7c2010-03-21 12:24:29 -0400609
Al Viro66cb7662011-01-12 20:04:37 -0500610out_free:
611 path_put(&path);
612out1:
613 deactivate_locked_super(s);
Michael Halcrow237fead2006-10-04 02:16:22 -0700614out:
Al Viro2ccde7c2010-03-21 12:24:29 -0400615 if (sbi) {
616 ecryptfs_destroy_mount_crypt_stat(&sbi->mount_crypt_stat);
617 kmem_cache_free(ecryptfs_sb_info_cache, sbi);
618 }
619 printk(KERN_ERR "%s; rc = [%d]\n", err, rc);
Al Viro4d143be2010-07-26 13:33:36 +0400620 return ERR_PTR(rc);
Michael Halcrow237fead2006-10-04 02:16:22 -0700621}
622
623/**
624 * ecryptfs_kill_block_super
625 * @sb: The ecryptfs super block
626 *
627 * Used to bring the superblock down and free the private data.
Michael Halcrow237fead2006-10-04 02:16:22 -0700628 */
629static void ecryptfs_kill_block_super(struct super_block *sb)
630{
Al Virodecabd62010-03-20 22:32:26 -0400631 struct ecryptfs_sb_info *sb_info = ecryptfs_superblock_to_private(sb);
632 kill_anon_super(sb);
633 if (!sb_info)
634 return;
635 ecryptfs_destroy_mount_crypt_stat(&sb_info->mount_crypt_stat);
636 bdi_destroy(&sb_info->bdi);
637 kmem_cache_free(ecryptfs_sb_info_cache, sb_info);
Michael Halcrow237fead2006-10-04 02:16:22 -0700638}
639
640static struct file_system_type ecryptfs_fs_type = {
641 .owner = THIS_MODULE,
642 .name = "ecryptfs",
Al Viro4d143be2010-07-26 13:33:36 +0400643 .mount = ecryptfs_mount,
Michael Halcrow237fead2006-10-04 02:16:22 -0700644 .kill_sb = ecryptfs_kill_block_super,
645 .fs_flags = 0
646};
Eric W. Biederman7f78e032013-03-02 19:39:14 -0800647MODULE_ALIAS_FS("ecryptfs");
Michael Halcrow237fead2006-10-04 02:16:22 -0700648
649/**
650 * inode_info_init_once
651 *
652 * Initializes the ecryptfs_inode_info_cache when it is created
653 */
654static void
Alexey Dobriyan51cc5062008-07-25 19:45:34 -0700655inode_info_init_once(void *vptr)
Michael Halcrow237fead2006-10-04 02:16:22 -0700656{
657 struct ecryptfs_inode_info *ei = (struct ecryptfs_inode_info *)vptr;
658
Christoph Lametera35afb82007-05-16 22:10:57 -0700659 inode_init_once(&ei->vfs_inode);
Michael Halcrow237fead2006-10-04 02:16:22 -0700660}
661
662static struct ecryptfs_cache_info {
Christoph Lametere18b8902006-12-06 20:33:20 -0800663 struct kmem_cache **cache;
Michael Halcrow237fead2006-10-04 02:16:22 -0700664 const char *name;
665 size_t size;
Vladimir Davydov5d097052016-01-14 15:18:21 -0800666 unsigned long flags;
Alexey Dobriyan51cc5062008-07-25 19:45:34 -0700667 void (*ctor)(void *obj);
Michael Halcrow237fead2006-10-04 02:16:22 -0700668} ecryptfs_cache_infos[] = {
669 {
670 .cache = &ecryptfs_auth_tok_list_item_cache,
671 .name = "ecryptfs_auth_tok_list_item",
672 .size = sizeof(struct ecryptfs_auth_tok_list_item),
673 },
674 {
675 .cache = &ecryptfs_file_info_cache,
676 .name = "ecryptfs_file_cache",
677 .size = sizeof(struct ecryptfs_file_info),
678 },
679 {
680 .cache = &ecryptfs_dentry_info_cache,
681 .name = "ecryptfs_dentry_info_cache",
682 .size = sizeof(struct ecryptfs_dentry_info),
683 },
684 {
685 .cache = &ecryptfs_inode_info_cache,
686 .name = "ecryptfs_inode_cache",
687 .size = sizeof(struct ecryptfs_inode_info),
Vladimir Davydov5d097052016-01-14 15:18:21 -0800688 .flags = SLAB_ACCOUNT,
Michael Halcrow237fead2006-10-04 02:16:22 -0700689 .ctor = inode_info_init_once,
690 },
691 {
692 .cache = &ecryptfs_sb_info_cache,
693 .name = "ecryptfs_sb_cache",
694 .size = sizeof(struct ecryptfs_sb_info),
695 },
696 {
Tyler Hicks30632872011-05-24 05:11:12 -0500697 .cache = &ecryptfs_header_cache,
698 .name = "ecryptfs_headers",
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300699 .size = PAGE_SIZE,
Michael Halcrow237fead2006-10-04 02:16:22 -0700700 },
701 {
Michael Halcrowdd2a3b72007-02-12 00:53:46 -0800702 .cache = &ecryptfs_xattr_cache,
703 .name = "ecryptfs_xattr_cache",
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300704 .size = PAGE_SIZE,
Michael Halcrowdd2a3b72007-02-12 00:53:46 -0800705 },
706 {
Michael Halcroweb95e7f2007-02-16 01:28:40 -0800707 .cache = &ecryptfs_key_record_cache,
708 .name = "ecryptfs_key_record_cache",
709 .size = sizeof(struct ecryptfs_key_record),
710 },
Michael Halcrow956159c2007-10-16 01:27:55 -0700711 {
712 .cache = &ecryptfs_key_sig_cache,
713 .name = "ecryptfs_key_sig_cache",
714 .size = sizeof(struct ecryptfs_key_sig),
715 },
716 {
717 .cache = &ecryptfs_global_auth_tok_cache,
718 .name = "ecryptfs_global_auth_tok_cache",
719 .size = sizeof(struct ecryptfs_global_auth_tok),
720 },
721 {
722 .cache = &ecryptfs_key_tfm_cache,
723 .name = "ecryptfs_key_tfm_cache",
724 .size = sizeof(struct ecryptfs_key_tfm),
725 },
Michael Halcrow237fead2006-10-04 02:16:22 -0700726};
727
728static void ecryptfs_free_kmem_caches(void)
729{
730 int i;
731
Kirill A. Shutemov8c0a8532012-09-26 11:33:07 +1000732 /*
733 * Make sure all delayed rcu free inodes are flushed before we
734 * destroy cache.
735 */
736 rcu_barrier();
737
Michael Halcrow237fead2006-10-04 02:16:22 -0700738 for (i = 0; i < ARRAY_SIZE(ecryptfs_cache_infos); i++) {
739 struct ecryptfs_cache_info *info;
740
741 info = &ecryptfs_cache_infos[i];
Julia Lawallc39341c2015-09-13 14:15:21 +0200742 kmem_cache_destroy(*(info->cache));
Michael Halcrow237fead2006-10-04 02:16:22 -0700743 }
744}
745
746/**
747 * ecryptfs_init_kmem_caches
748 *
749 * Returns zero on success; non-zero otherwise
750 */
751static int ecryptfs_init_kmem_caches(void)
752{
753 int i;
754
755 for (i = 0; i < ARRAY_SIZE(ecryptfs_cache_infos); i++) {
756 struct ecryptfs_cache_info *info;
757
758 info = &ecryptfs_cache_infos[i];
Vladimir Davydov5d097052016-01-14 15:18:21 -0800759 *(info->cache) = kmem_cache_create(info->name, info->size, 0,
760 SLAB_HWCACHE_ALIGN | info->flags, info->ctor);
Michael Halcrow237fead2006-10-04 02:16:22 -0700761 if (!*(info->cache)) {
762 ecryptfs_free_kmem_caches();
763 ecryptfs_printk(KERN_WARNING, "%s: "
764 "kmem_cache_create failed\n",
765 info->name);
766 return -ENOMEM;
767 }
768 }
769 return 0;
770}
771
Greg Kroah-Hartman6e90aa92007-11-06 15:08:08 -0800772static struct kobject *ecryptfs_kobj;
Michael Halcrow237fead2006-10-04 02:16:22 -0700773
Kay Sievers386f2752007-11-02 13:47:53 +0100774static ssize_t version_show(struct kobject *kobj,
775 struct kobj_attribute *attr, char *buff)
Michael Halcrow237fead2006-10-04 02:16:22 -0700776{
777 return snprintf(buff, PAGE_SIZE, "%d\n", ECRYPTFS_VERSIONING_MASK);
778}
779
Kay Sievers386f2752007-11-02 13:47:53 +0100780static struct kobj_attribute version_attr = __ATTR_RO(version);
Michael Halcrow237fead2006-10-04 02:16:22 -0700781
Greg Kroah-Hartman30a468b2007-10-15 15:01:24 -0700782static struct attribute *attributes[] = {
783 &version_attr.attr,
Greg Kroah-Hartman30a468b2007-10-15 15:01:24 -0700784 NULL,
785};
786
787static struct attribute_group attr_group = {
788 .attrs = attributes,
789};
Michael Halcrow237fead2006-10-04 02:16:22 -0700790
791static int do_sysfs_registration(void)
792{
793 int rc;
794
Greg Kroah-Hartman6e90aa92007-11-06 15:08:08 -0800795 ecryptfs_kobj = kobject_create_and_add("ecryptfs", fs_kobj);
796 if (!ecryptfs_kobj) {
Greg Kroah-Hartman917e8652007-10-29 20:13:17 +0100797 printk(KERN_ERR "Unable to create ecryptfs kset\n");
798 rc = -ENOMEM;
Michael Halcrow237fead2006-10-04 02:16:22 -0700799 goto out;
800 }
Greg Kroah-Hartman6e90aa92007-11-06 15:08:08 -0800801 rc = sysfs_create_group(ecryptfs_kobj, &attr_group);
Michael Halcrow237fead2006-10-04 02:16:22 -0700802 if (rc) {
803 printk(KERN_ERR
Greg Kroah-Hartman30a468b2007-10-15 15:01:24 -0700804 "Unable to create ecryptfs version attributes\n");
Greg Kroah-Hartman197b12d2007-12-20 08:13:05 -0800805 kobject_put(ecryptfs_kobj);
Michael Halcrow237fead2006-10-04 02:16:22 -0700806 }
807out:
808 return rc;
809}
810
Ryusuke Konishia75de1b2007-08-10 13:00:56 -0700811static void do_sysfs_unregistration(void)
812{
Greg Kroah-Hartman6e90aa92007-11-06 15:08:08 -0800813 sysfs_remove_group(ecryptfs_kobj, &attr_group);
Greg Kroah-Hartman197b12d2007-12-20 08:13:05 -0800814 kobject_put(ecryptfs_kobj);
Ryusuke Konishia75de1b2007-08-10 13:00:56 -0700815}
816
Michael Halcrow237fead2006-10-04 02:16:22 -0700817static int __init ecryptfs_init(void)
818{
819 int rc;
820
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300821 if (ECRYPTFS_DEFAULT_EXTENT_SIZE > PAGE_SIZE) {
Michael Halcrow237fead2006-10-04 02:16:22 -0700822 rc = -EINVAL;
823 ecryptfs_printk(KERN_ERR, "The eCryptfs extent size is "
824 "larger than the host's page size, and so "
825 "eCryptfs cannot run on this system. The "
Joe Perches888d57b2010-11-10 15:46:16 -0800826 "default eCryptfs extent size is [%u] bytes; "
827 "the page size is [%lu] bytes.\n",
828 ECRYPTFS_DEFAULT_EXTENT_SIZE,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300829 (unsigned long)PAGE_SIZE);
Michael Halcrow237fead2006-10-04 02:16:22 -0700830 goto out;
831 }
832 rc = ecryptfs_init_kmem_caches();
833 if (rc) {
834 printk(KERN_ERR
835 "Failed to allocate one or more kmem_cache objects\n");
836 goto out;
837 }
Michael Halcrow237fead2006-10-04 02:16:22 -0700838 rc = do_sysfs_registration();
839 if (rc) {
840 printk(KERN_ERR "sysfs registration failed\n");
Al Viro0794f562012-03-17 21:29:13 -0400841 goto out_free_kmem_caches;
Michael Halcrow237fead2006-10-04 02:16:22 -0700842 }
Michael Halcrow746f1e52008-07-23 21:30:02 -0700843 rc = ecryptfs_init_kthread();
844 if (rc) {
845 printk(KERN_ERR "%s: kthread initialization failed; "
846 "rc = [%d]\n", __func__, rc);
847 goto out_do_sysfs_unregistration;
848 }
Tyler Hicks624ae522008-10-15 22:02:51 -0700849 rc = ecryptfs_init_messaging();
Michael Halcrowdddfa462007-02-12 00:53:44 -0800850 if (rc) {
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300851 printk(KERN_ERR "Failure occurred while attempting to "
Tyler Hicks624ae522008-10-15 22:02:51 -0700852 "initialize the communications channel to "
853 "ecryptfsd\n");
Michael Halcrow746f1e52008-07-23 21:30:02 -0700854 goto out_destroy_kthread;
Michael Halcrow956159c2007-10-16 01:27:55 -0700855 }
856 rc = ecryptfs_init_crypto();
857 if (rc) {
858 printk(KERN_ERR "Failure whilst attempting to init crypto; "
859 "rc = [%d]\n", rc);
Michael Halcrowcf81f892007-10-16 01:28:07 -0700860 goto out_release_messaging;
Michael Halcrowdddfa462007-02-12 00:53:44 -0800861 }
Al Viro0794f562012-03-17 21:29:13 -0400862 rc = register_filesystem(&ecryptfs_fs_type);
863 if (rc) {
864 printk(KERN_ERR "Failed to register filesystem\n");
865 goto out_destroy_crypto;
866 }
Eric Sandeen2830bfd2008-02-06 01:38:34 -0800867 if (ecryptfs_verbosity > 0)
868 printk(KERN_CRIT "eCryptfs verbosity set to %d. Secret values "
869 "will be written to the syslog!\n", ecryptfs_verbosity);
870
Michael Halcrowcf81f892007-10-16 01:28:07 -0700871 goto out;
Al Viro0794f562012-03-17 21:29:13 -0400872out_destroy_crypto:
873 ecryptfs_destroy_crypto();
Michael Halcrowcf81f892007-10-16 01:28:07 -0700874out_release_messaging:
Tyler Hicks624ae522008-10-15 22:02:51 -0700875 ecryptfs_release_messaging();
Michael Halcrow746f1e52008-07-23 21:30:02 -0700876out_destroy_kthread:
877 ecryptfs_destroy_kthread();
Michael Halcrowcf81f892007-10-16 01:28:07 -0700878out_do_sysfs_unregistration:
879 do_sysfs_unregistration();
Michael Halcrowcf81f892007-10-16 01:28:07 -0700880out_free_kmem_caches:
881 ecryptfs_free_kmem_caches();
Michael Halcrow237fead2006-10-04 02:16:22 -0700882out:
883 return rc;
884}
885
886static void __exit ecryptfs_exit(void)
887{
Michael Halcrowcf81f892007-10-16 01:28:07 -0700888 int rc;
889
890 rc = ecryptfs_destroy_crypto();
891 if (rc)
892 printk(KERN_ERR "Failure whilst attempting to destroy crypto; "
893 "rc = [%d]\n", rc);
Tyler Hicks624ae522008-10-15 22:02:51 -0700894 ecryptfs_release_messaging();
Michael Halcrow746f1e52008-07-23 21:30:02 -0700895 ecryptfs_destroy_kthread();
Michael Halcrowcf81f892007-10-16 01:28:07 -0700896 do_sysfs_unregistration();
Michael Halcrow237fead2006-10-04 02:16:22 -0700897 unregister_filesystem(&ecryptfs_fs_type);
898 ecryptfs_free_kmem_caches();
899}
900
901MODULE_AUTHOR("Michael A. Halcrow <mhalcrow@us.ibm.com>");
902MODULE_DESCRIPTION("eCryptfs");
903
904MODULE_LICENSE("GPL");
905
906module_init(ecryptfs_init)
907module_exit(ecryptfs_exit)