blob: cd5ad43a457fc8563b030d814eea4cd284766d64 [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
Tim Zimmermann5c435c12021-03-18 09:19:56 +010041#ifdef CONFIG_WTL_ENCRYPTION_FILTER
42#include <linux/ctype.h>
43#endif
44
Michael Halcrow237fead2006-10-04 02:16:22 -070045/**
46 * Module parameter that defines the ecryptfs_verbosity level.
47 */
48int ecryptfs_verbosity = 0;
49
50module_param(ecryptfs_verbosity, int, 0);
51MODULE_PARM_DESC(ecryptfs_verbosity,
52 "Initial verbosity level (0 or 1; defaults to "
53 "0, which is Quiet)");
54
Michael Halcrowdddfa462007-02-12 00:53:44 -080055/**
Tyler Hicks624ae522008-10-15 22:02:51 -070056 * Module parameter that defines the number of message buffer elements
Michael Halcrowdddfa462007-02-12 00:53:44 -080057 */
58unsigned int ecryptfs_message_buf_len = ECRYPTFS_DEFAULT_MSG_CTX_ELEMS;
59
60module_param(ecryptfs_message_buf_len, uint, 0);
61MODULE_PARM_DESC(ecryptfs_message_buf_len,
62 "Number of message buffer elements");
63
64/**
65 * Module parameter that defines the maximum guaranteed amount of time to wait
Tyler Hicks624ae522008-10-15 22:02:51 -070066 * for a response from ecryptfsd. The actual sleep time will be, more than
Michael Halcrowdddfa462007-02-12 00:53:44 -080067 * likely, a small amount greater than this specified value, but only less if
Tyler Hicks624ae522008-10-15 22:02:51 -070068 * the message successfully arrives.
Michael Halcrowdddfa462007-02-12 00:53:44 -080069 */
70signed long ecryptfs_message_wait_timeout = ECRYPTFS_MAX_MSG_CTX_TTL / HZ;
71
72module_param(ecryptfs_message_wait_timeout, long, 0);
73MODULE_PARM_DESC(ecryptfs_message_wait_timeout,
74 "Maximum number of seconds that an operation will "
75 "sleep while waiting for a message response from "
76 "userspace");
77
78/**
79 * Module parameter that is an estimate of the maximum number of users
80 * that will be concurrently using eCryptfs. Set this to the right
81 * value to balance performance and memory use.
82 */
83unsigned int ecryptfs_number_of_users = ECRYPTFS_DEFAULT_NUM_USERS;
84
85module_param(ecryptfs_number_of_users, uint, 0);
86MODULE_PARM_DESC(ecryptfs_number_of_users, "An estimate of the number of "
87 "concurrent users of eCryptfs");
88
Michael Halcrow237fead2006-10-04 02:16:22 -070089void __ecryptfs_printk(const char *fmt, ...)
90{
91 va_list args;
92 va_start(args, fmt);
93 if (fmt[1] == '7') { /* KERN_DEBUG */
94 if (ecryptfs_verbosity >= 1)
95 vprintk(fmt, args);
96 } else
97 vprintk(fmt, args);
98 va_end(args);
99}
100
101/**
Tyler Hicks332ab162011-04-14 15:35:11 -0500102 * ecryptfs_init_lower_file
Michael Halcrow4981e082007-10-16 01:28:09 -0700103 * @ecryptfs_dentry: Fully initialized eCryptfs dentry object, with
104 * the lower dentry and the lower mount set
105 *
106 * eCryptfs only ever keeps a single open file for every lower
107 * inode. All I/O operations to the lower inode occur through that
108 * file. When the first eCryptfs dentry that interposes with the first
109 * lower dentry for that inode is created, this function creates the
Tyler Hicks332ab162011-04-14 15:35:11 -0500110 * lower file struct and associates it with the eCryptfs
111 * inode. When all eCryptfs files associated with the inode are released, the
112 * file is closed.
Michael Halcrow4981e082007-10-16 01:28:09 -0700113 *
Tyler Hicks332ab162011-04-14 15:35:11 -0500114 * The lower file will be opened with read/write permissions, if
Michael Halcrow4981e082007-10-16 01:28:09 -0700115 * possible. Otherwise, it is opened read-only.
116 *
Tyler Hicks332ab162011-04-14 15:35:11 -0500117 * This function does nothing if a lower file is already
Michael Halcrow4981e082007-10-16 01:28:09 -0700118 * associated with the eCryptfs inode.
119 *
120 * Returns zero on success; non-zero otherwise
121 */
Tyler Hicks332ab162011-04-14 15:35:11 -0500122static int ecryptfs_init_lower_file(struct dentry *dentry,
123 struct file **lower_file)
Michael Halcrow4981e082007-10-16 01:28:09 -0700124{
David Howells745ca242008-11-14 10:39:22 +1100125 const struct cred *cred = current_cred();
Matthew Wilcoxcc18ec32013-06-15 07:55:59 -0400126 struct path *path = ecryptfs_dentry_to_lower_path(dentry);
Tyler Hicks332ab162011-04-14 15:35:11 -0500127 int rc;
Michael Halcrow4981e082007-10-16 01:28:09 -0700128
Matthew Wilcoxcc18ec32013-06-15 07:55:59 -0400129 rc = ecryptfs_privileged_open(lower_file, path->dentry, path->mnt,
Tyler Hicks332ab162011-04-14 15:35:11 -0500130 cred);
131 if (rc) {
132 printk(KERN_ERR "Error opening lower file "
133 "for lower_dentry [0x%p] and lower_mnt [0x%p]; "
Matthew Wilcoxcc18ec32013-06-15 07:55:59 -0400134 "rc = [%d]\n", path->dentry, path->mnt, rc);
Tyler Hicks332ab162011-04-14 15:35:11 -0500135 (*lower_file) = NULL;
Michael Halcrow4981e082007-10-16 01:28:09 -0700136 }
Michael Halcrow4981e082007-10-16 01:28:09 -0700137 return rc;
138}
139
Tyler Hicks3b06b3e2011-05-24 03:49:02 -0500140int ecryptfs_get_lower_file(struct dentry *dentry, struct inode *inode)
Tyler Hicks332ab162011-04-14 15:35:11 -0500141{
Tyler Hicks3b06b3e2011-05-24 03:49:02 -0500142 struct ecryptfs_inode_info *inode_info;
Tyler Hicks332ab162011-04-14 15:35:11 -0500143 int count, rc = 0;
144
Tyler Hicks3b06b3e2011-05-24 03:49:02 -0500145 inode_info = ecryptfs_inode_to_private(inode);
Tyler Hicks332ab162011-04-14 15:35:11 -0500146 mutex_lock(&inode_info->lower_file_mutex);
147 count = atomic_inc_return(&inode_info->lower_file_count);
148 if (WARN_ON_ONCE(count < 1))
149 rc = -EINVAL;
150 else if (count == 1) {
151 rc = ecryptfs_init_lower_file(dentry,
152 &inode_info->lower_file);
153 if (rc)
154 atomic_set(&inode_info->lower_file_count, 0);
155 }
156 mutex_unlock(&inode_info->lower_file_mutex);
157 return rc;
158}
159
160void ecryptfs_put_lower_file(struct inode *inode)
161{
162 struct ecryptfs_inode_info *inode_info;
163
164 inode_info = ecryptfs_inode_to_private(inode);
165 if (atomic_dec_and_mutex_lock(&inode_info->lower_file_count,
166 &inode_info->lower_file_mutex)) {
Tyler Hicks7149f252012-09-12 18:02:46 -0700167 filemap_write_and_wait(inode->i_mapping);
Tyler Hicks332ab162011-04-14 15:35:11 -0500168 fput(inode_info->lower_file);
169 inode_info->lower_file = NULL;
170 mutex_unlock(&inode_info->lower_file_mutex);
171 }
172}
173
Eric Sandeen2830bfd2008-02-06 01:38:34 -0800174enum { ecryptfs_opt_sig, ecryptfs_opt_ecryptfs_sig,
175 ecryptfs_opt_cipher, ecryptfs_opt_ecryptfs_cipher,
176 ecryptfs_opt_ecryptfs_key_bytes,
Michael Halcrow17398952007-02-12 00:53:45 -0800177 ecryptfs_opt_passthrough, ecryptfs_opt_xattr_metadata,
Michael Halcrow87c94c42009-01-06 14:42:01 -0800178 ecryptfs_opt_encrypted_view, ecryptfs_opt_fnek_sig,
179 ecryptfs_opt_fn_cipher, ecryptfs_opt_fn_cipher_key_bytes,
Roberto Sassuf16feb52010-10-06 18:31:32 +0200180 ecryptfs_opt_unlink_sigs, ecryptfs_opt_mount_auth_tok_only,
John Johansen76435542011-07-22 08:14:15 -0700181 ecryptfs_opt_check_dev_ruid,
Tim Zimmermann5c435c12021-03-18 09:19:56 +0100182#ifdef CONFIG_WTL_ENCRYPTION_FILTER
183 ecryptfs_opt_enable_filtering,
184#endif
185#ifdef CONFIG_CRYPTO_FIPS
186 ecryptfs_opt_enable_cc,
187#endif
188 ecryptfs_opt_base, ecryptfs_opt_type, ecryptfs_opt_label,
Roberto Sassuf16feb52010-10-06 18:31:32 +0200189 ecryptfs_opt_err };
Michael Halcrow237fead2006-10-04 02:16:22 -0700190
Steven Whitehousea447c092008-10-13 10:46:57 +0100191static const match_table_t tokens = {
Michael Halcrow237fead2006-10-04 02:16:22 -0700192 {ecryptfs_opt_sig, "sig=%s"},
193 {ecryptfs_opt_ecryptfs_sig, "ecryptfs_sig=%s"},
Michael Halcrow237fead2006-10-04 02:16:22 -0700194 {ecryptfs_opt_cipher, "cipher=%s"},
195 {ecryptfs_opt_ecryptfs_cipher, "ecryptfs_cipher=%s"},
196 {ecryptfs_opt_ecryptfs_key_bytes, "ecryptfs_key_bytes=%u"},
197 {ecryptfs_opt_passthrough, "ecryptfs_passthrough"},
Michael Halcrow17398952007-02-12 00:53:45 -0800198 {ecryptfs_opt_xattr_metadata, "ecryptfs_xattr_metadata"},
199 {ecryptfs_opt_encrypted_view, "ecryptfs_encrypted_view"},
Michael Halcrow87c94c42009-01-06 14:42:01 -0800200 {ecryptfs_opt_fnek_sig, "ecryptfs_fnek_sig=%s"},
201 {ecryptfs_opt_fn_cipher, "ecryptfs_fn_cipher=%s"},
202 {ecryptfs_opt_fn_cipher_key_bytes, "ecryptfs_fn_key_bytes=%u"},
Tyler Hickse77cc8d2009-04-22 04:08:46 -0500203 {ecryptfs_opt_unlink_sigs, "ecryptfs_unlink_sigs"},
Roberto Sassuf16feb52010-10-06 18:31:32 +0200204 {ecryptfs_opt_mount_auth_tok_only, "ecryptfs_mount_auth_tok_only"},
John Johansen76435542011-07-22 08:14:15 -0700205 {ecryptfs_opt_check_dev_ruid, "ecryptfs_check_dev_ruid"},
Tim Zimmermann5c435c12021-03-18 09:19:56 +0100206#ifdef CONFIG_WTL_ENCRYPTION_FILTER
207 {ecryptfs_opt_enable_filtering, "ecryptfs_enable_filtering=%s"},
208#endif
209#ifdef CONFIG_CRYPTO_FIPS
210 {ecryptfs_opt_enable_cc, "ecryptfs_enable_cc"},
211#endif
212 {ecryptfs_opt_base, "base=%s"},
213 {ecryptfs_opt_type, "type=%s"},
214 {ecryptfs_opt_label, "label=%s"},
Michael Halcrow237fead2006-10-04 02:16:22 -0700215 {ecryptfs_opt_err, NULL}
216};
217
Michael Halcrowf4aad162007-10-16 01:27:53 -0700218static int ecryptfs_init_global_auth_toks(
219 struct ecryptfs_mount_crypt_stat *mount_crypt_stat)
Michael Halcrow237fead2006-10-04 02:16:22 -0700220{
Michael Halcrowf4aad162007-10-16 01:27:53 -0700221 struct ecryptfs_global_auth_tok *global_auth_tok;
Roberto Sassu0e1fc5e2011-03-21 16:00:53 +0100222 struct ecryptfs_auth_tok *auth_tok;
Michael Halcrow237fead2006-10-04 02:16:22 -0700223 int rc = 0;
Michael Halcrow237fead2006-10-04 02:16:22 -0700224
Michael Halcrowf4aad162007-10-16 01:27:53 -0700225 list_for_each_entry(global_auth_tok,
226 &mount_crypt_stat->global_auth_tok_list,
227 mount_crypt_stat_list) {
Michael Halcrow5dda6992007-10-16 01:28:06 -0700228 rc = ecryptfs_keyring_auth_tok_for_sig(
Roberto Sassu0e1fc5e2011-03-21 16:00:53 +0100229 &global_auth_tok->global_auth_tok_key, &auth_tok,
Michael Halcrow5dda6992007-10-16 01:28:06 -0700230 global_auth_tok->sig);
231 if (rc) {
Michael Halcrowf4aad162007-10-16 01:27:53 -0700232 printk(KERN_ERR "Could not find valid key in user "
233 "session keyring for sig specified in mount "
234 "option: [%s]\n", global_auth_tok->sig);
235 global_auth_tok->flags |= ECRYPTFS_AUTH_TOK_INVALID;
Eric Sandeen982363c2008-07-23 21:30:04 -0700236 goto out;
Roberto Sassub5695d02011-03-21 16:00:55 +0100237 } else {
Michael Halcrowf4aad162007-10-16 01:27:53 -0700238 global_auth_tok->flags &= ~ECRYPTFS_AUTH_TOK_INVALID;
Roberto Sassub5695d02011-03-21 16:00:55 +0100239 up_write(&(global_auth_tok->global_auth_tok_key)->sem);
240 }
Michael Halcrow237fead2006-10-04 02:16:22 -0700241 }
Eric Sandeen982363c2008-07-23 21:30:04 -0700242out:
Michael Halcrow237fead2006-10-04 02:16:22 -0700243 return rc;
244}
245
Michael Halcrowf4aad162007-10-16 01:27:53 -0700246static void ecryptfs_init_mount_crypt_stat(
247 struct ecryptfs_mount_crypt_stat *mount_crypt_stat)
248{
249 memset((void *)mount_crypt_stat, 0,
250 sizeof(struct ecryptfs_mount_crypt_stat));
251 INIT_LIST_HEAD(&mount_crypt_stat->global_auth_tok_list);
252 mutex_init(&mount_crypt_stat->global_auth_tok_list_mutex);
253 mount_crypt_stat->flags |= ECRYPTFS_MOUNT_CRYPT_STAT_INITIALIZED;
254}
255
Tim Zimmermann5c435c12021-03-18 09:19:56 +0100256#ifdef CONFIG_WTL_ENCRYPTION_FILTER
257static int parse_enc_file_filter_parms(
258 struct ecryptfs_mount_crypt_stat *mcs, char *str)
259{
260 char *token = NULL;
261 int count = 0;
262 mcs->max_name_filter_len = 0;
263 while ((token = strsep(&str, "|")) != NULL) {
264 if (count >= ENC_NAME_FILTER_MAX_INSTANCE)
265 return -1;
266 strncpy(mcs->enc_filter_name[count++],
267 token, ENC_NAME_FILTER_MAX_LEN);
268 if (mcs->max_name_filter_len < strlen(token))
269 mcs->max_name_filter_len = strlen(token);
270 }
271 return 0;
272}
273
274static int parse_enc_ext_filter_parms(
275 struct ecryptfs_mount_crypt_stat *mcs, char *str)
276{
277 char *token = NULL;
278 int count = 0;
279 while ((token = strsep(&str, "|")) != NULL) {
280 if (count >= ENC_EXT_FILTER_MAX_INSTANCE)
281 return -1;
282 strncpy(mcs->enc_filter_ext[count++],
283 token, ENC_EXT_FILTER_MAX_LEN);
284 }
285 return 0;
286}
287
288static int parse_enc_filter_parms(
289 struct ecryptfs_mount_crypt_stat *mcs, char *str)
290{
291 char *token = NULL;
292 if (!strcmp("*", str)) {
293 mcs->flags |= ECRYPTFS_ENABLE_NEW_PASSTHROUGH;
294 return 0;
295 }
296 token = strsep(&str, ":");
297 if (token != NULL)
298 parse_enc_file_filter_parms(mcs, token);
299 token = strsep(&str, ":");
300 if (token != NULL)
301 parse_enc_ext_filter_parms(mcs, token);
302 return 0;
303}
304#endif
305
Michael Halcrow237fead2006-10-04 02:16:22 -0700306/**
307 * ecryptfs_parse_options
308 * @sb: The ecryptfs super block
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300309 * @options: The options passed to the kernel
John Johansen76435542011-07-22 08:14:15 -0700310 * @check_ruid: set to 1 if device uid should be checked against the ruid
Michael Halcrow237fead2006-10-04 02:16:22 -0700311 *
312 * Parse mount options:
313 * debug=N - ecryptfs_verbosity level for debug output
314 * sig=XXX - description(signature) of the key to use
315 *
316 * Returns the dentry object of the lower-level (lower/interposed)
317 * directory; We want to mount our stackable file system on top of
318 * that lower directory.
319 *
320 * The signature of the key to use must be the description of a key
321 * already in the keyring. Mounting will fail if the key can not be
322 * found.
323 *
324 * Returns zero on success; non-zero on error
325 */
John Johansen76435542011-07-22 08:14:15 -0700326static int ecryptfs_parse_options(struct ecryptfs_sb_info *sbi, char *options,
327 uid_t *check_ruid)
Michael Halcrow237fead2006-10-04 02:16:22 -0700328{
329 char *p;
330 int rc = 0;
331 int sig_set = 0;
332 int cipher_name_set = 0;
Michael Halcrow87c94c42009-01-06 14:42:01 -0800333 int fn_cipher_name_set = 0;
Michael Halcrow237fead2006-10-04 02:16:22 -0700334 int cipher_key_bytes;
335 int cipher_key_bytes_set = 0;
Michael Halcrow87c94c42009-01-06 14:42:01 -0800336 int fn_cipher_key_bytes;
337 int fn_cipher_key_bytes_set = 0;
Michael Halcrow237fead2006-10-04 02:16:22 -0700338 struct ecryptfs_mount_crypt_stat *mount_crypt_stat =
Al Viro2ccde7c2010-03-21 12:24:29 -0400339 &sbi->mount_crypt_stat;
Michael Halcrow237fead2006-10-04 02:16:22 -0700340 substring_t args[MAX_OPT_ARGS];
341 int token;
342 char *sig_src;
Michael Halcrow237fead2006-10-04 02:16:22 -0700343 char *cipher_name_dst;
344 char *cipher_name_src;
Michael Halcrow87c94c42009-01-06 14:42:01 -0800345 char *fn_cipher_name_dst;
346 char *fn_cipher_name_src;
347 char *fnek_dst;
348 char *fnek_src;
Michael Halcrow237fead2006-10-04 02:16:22 -0700349 char *cipher_key_bytes_src;
Michael Halcrow87c94c42009-01-06 14:42:01 -0800350 char *fn_cipher_key_bytes_src;
Tim Sally5f5b3312012-07-12 19:10:24 -0400351 u8 cipher_code;
Tim Zimmermann5c435c12021-03-18 09:19:56 +0100352#ifdef CONFIG_CRYPTO_FIPS
353 char cipher_mode[ECRYPTFS_MAX_CIPHER_MODE_SIZE+1] = ECRYPTFS_AES_ECB_MODE;
354#endif
Michael Halcrow237fead2006-10-04 02:16:22 -0700355
John Johansen76435542011-07-22 08:14:15 -0700356 *check_ruid = 0;
357
Michael Halcrow237fead2006-10-04 02:16:22 -0700358 if (!options) {
359 rc = -EINVAL;
360 goto out;
361 }
Michael Halcrow956159c2007-10-16 01:27:55 -0700362 ecryptfs_init_mount_crypt_stat(mount_crypt_stat);
Michael Halcrow237fead2006-10-04 02:16:22 -0700363 while ((p = strsep(&options, ",")) != NULL) {
364 if (!*p)
365 continue;
366 token = match_token(p, tokens, args);
367 switch (token) {
368 case ecryptfs_opt_sig:
369 case ecryptfs_opt_ecryptfs_sig:
370 sig_src = args[0].from;
Michael Halcrowf4aad162007-10-16 01:27:53 -0700371 rc = ecryptfs_add_global_auth_tok(mount_crypt_stat,
Tyler Hicks84814d62009-03-13 13:51:59 -0700372 sig_src, 0);
Michael Halcrowf4aad162007-10-16 01:27:53 -0700373 if (rc) {
374 printk(KERN_ERR "Error attempting to register "
375 "global sig; rc = [%d]\n", rc);
376 goto out;
377 }
Michael Halcrow237fead2006-10-04 02:16:22 -0700378 sig_set = 1;
379 break;
Michael Halcrow237fead2006-10-04 02:16:22 -0700380 case ecryptfs_opt_cipher:
381 case ecryptfs_opt_ecryptfs_cipher:
382 cipher_name_src = args[0].from;
383 cipher_name_dst =
384 mount_crypt_stat->
385 global_default_cipher_name;
386 strncpy(cipher_name_dst, cipher_name_src,
387 ECRYPTFS_MAX_CIPHER_NAME_SIZE);
Michael Halcrow87c94c42009-01-06 14:42:01 -0800388 cipher_name_dst[ECRYPTFS_MAX_CIPHER_NAME_SIZE] = '\0';
Michael Halcrow237fead2006-10-04 02:16:22 -0700389 cipher_name_set = 1;
390 break;
391 case ecryptfs_opt_ecryptfs_key_bytes:
392 cipher_key_bytes_src = args[0].from;
393 cipher_key_bytes =
394 (int)simple_strtol(cipher_key_bytes_src,
395 &cipher_key_bytes_src, 0);
396 mount_crypt_stat->global_default_cipher_key_size =
397 cipher_key_bytes;
Michael Halcrow237fead2006-10-04 02:16:22 -0700398 cipher_key_bytes_set = 1;
399 break;
400 case ecryptfs_opt_passthrough:
401 mount_crypt_stat->flags |=
402 ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED;
403 break;
Michael Halcrow17398952007-02-12 00:53:45 -0800404 case ecryptfs_opt_xattr_metadata:
405 mount_crypt_stat->flags |=
406 ECRYPTFS_XATTR_METADATA_ENABLED;
407 break;
408 case ecryptfs_opt_encrypted_view:
409 mount_crypt_stat->flags |=
410 ECRYPTFS_XATTR_METADATA_ENABLED;
411 mount_crypt_stat->flags |=
412 ECRYPTFS_ENCRYPTED_VIEW_ENABLED;
413 break;
Michael Halcrow87c94c42009-01-06 14:42:01 -0800414 case ecryptfs_opt_fnek_sig:
415 fnek_src = args[0].from;
416 fnek_dst =
417 mount_crypt_stat->global_default_fnek_sig;
418 strncpy(fnek_dst, fnek_src, ECRYPTFS_SIG_SIZE_HEX);
419 mount_crypt_stat->global_default_fnek_sig[
420 ECRYPTFS_SIG_SIZE_HEX] = '\0';
421 rc = ecryptfs_add_global_auth_tok(
422 mount_crypt_stat,
Tyler Hicks84814d62009-03-13 13:51:59 -0700423 mount_crypt_stat->global_default_fnek_sig,
424 ECRYPTFS_AUTH_TOK_FNEK);
Michael Halcrow87c94c42009-01-06 14:42:01 -0800425 if (rc) {
426 printk(KERN_ERR "Error attempting to register "
427 "global fnek sig [%s]; rc = [%d]\n",
428 mount_crypt_stat->global_default_fnek_sig,
429 rc);
430 goto out;
431 }
432 mount_crypt_stat->flags |=
433 (ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES
434 | ECRYPTFS_GLOBAL_ENCFN_USE_MOUNT_FNEK);
435 break;
436 case ecryptfs_opt_fn_cipher:
437 fn_cipher_name_src = args[0].from;
438 fn_cipher_name_dst =
439 mount_crypt_stat->global_default_fn_cipher_name;
440 strncpy(fn_cipher_name_dst, fn_cipher_name_src,
441 ECRYPTFS_MAX_CIPHER_NAME_SIZE);
442 mount_crypt_stat->global_default_fn_cipher_name[
443 ECRYPTFS_MAX_CIPHER_NAME_SIZE] = '\0';
444 fn_cipher_name_set = 1;
445 break;
446 case ecryptfs_opt_fn_cipher_key_bytes:
447 fn_cipher_key_bytes_src = args[0].from;
448 fn_cipher_key_bytes =
449 (int)simple_strtol(fn_cipher_key_bytes_src,
450 &fn_cipher_key_bytes_src, 0);
451 mount_crypt_stat->global_default_fn_cipher_key_bytes =
452 fn_cipher_key_bytes;
453 fn_cipher_key_bytes_set = 1;
454 break;
Tyler Hickse77cc8d2009-04-22 04:08:46 -0500455 case ecryptfs_opt_unlink_sigs:
456 mount_crypt_stat->flags |= ECRYPTFS_UNLINK_SIGS;
457 break;
Roberto Sassuf16feb52010-10-06 18:31:32 +0200458 case ecryptfs_opt_mount_auth_tok_only:
459 mount_crypt_stat->flags |=
460 ECRYPTFS_GLOBAL_MOUNT_AUTH_TOK_ONLY;
461 break;
John Johansen76435542011-07-22 08:14:15 -0700462 case ecryptfs_opt_check_dev_ruid:
463 *check_ruid = 1;
464 break;
Tim Zimmermann5c435c12021-03-18 09:19:56 +0100465#ifdef CONFIG_WTL_ENCRYPTION_FILTER
466 case ecryptfs_opt_enable_filtering:
467 rc = parse_enc_filter_parms(mount_crypt_stat,
468 args[0].from);
469 if (rc) {
470 printk(KERN_ERR "Error attempting to parse encryption "
471 "filtering parameters.\n");
472 rc = -EINVAL;
473 goto out;
474 }
475 mount_crypt_stat->flags |= ECRYPTFS_ENABLE_FILTERING;
476 break;
477#endif
478#ifdef CONFIG_CRYPTO_FIPS
479 case ecryptfs_opt_enable_cc:
480 mount_crypt_stat->flags |= ECRYPTFS_ENABLE_CC;
481 strncpy(cipher_mode, ECRYPTFS_AES_CBC_MODE, ECRYPTFS_MAX_CIPHER_MODE_SIZE+1);
482 break;
483#endif
Michael Halcrow237fead2006-10-04 02:16:22 -0700484 case ecryptfs_opt_err:
485 default:
Michael Halcrow87c94c42009-01-06 14:42:01 -0800486 printk(KERN_WARNING
487 "%s: eCryptfs: unrecognized option [%s]\n",
488 __func__, p);
Michael Halcrow237fead2006-10-04 02:16:22 -0700489 }
490 }
Michael Halcrow237fead2006-10-04 02:16:22 -0700491 if (!sig_set) {
492 rc = -EINVAL;
Michael Halcrow956159c2007-10-16 01:27:55 -0700493 ecryptfs_printk(KERN_ERR, "You must supply at least one valid "
494 "auth tok signature as a mount "
Michael Halcrow237fead2006-10-04 02:16:22 -0700495 "parameter; see the eCryptfs README\n");
496 goto out;
497 }
498 if (!cipher_name_set) {
Miklos Szeredi8f236802008-07-23 21:30:05 -0700499 int cipher_name_len = strlen(ECRYPTFS_DEFAULT_CIPHER);
500
Colin Ian King2a559a82015-02-23 11:34:10 +0000501 BUG_ON(cipher_name_len > ECRYPTFS_MAX_CIPHER_NAME_SIZE);
Miklos Szeredi8f236802008-07-23 21:30:05 -0700502 strcpy(mount_crypt_stat->global_default_cipher_name,
503 ECRYPTFS_DEFAULT_CIPHER);
Michael Halcrow237fead2006-10-04 02:16:22 -0700504 }
Michael Halcrow87c94c42009-01-06 14:42:01 -0800505 if ((mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES)
506 && !fn_cipher_name_set)
507 strcpy(mount_crypt_stat->global_default_fn_cipher_name,
508 mount_crypt_stat->global_default_cipher_name);
509 if (!cipher_key_bytes_set)
Michael Halcrowe5d9cbd2006-10-30 22:07:16 -0800510 mount_crypt_stat->global_default_cipher_key_size = 0;
Michael Halcrow87c94c42009-01-06 14:42:01 -0800511 if ((mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES)
512 && !fn_cipher_key_bytes_set)
513 mount_crypt_stat->global_default_fn_cipher_key_bytes =
514 mount_crypt_stat->global_default_cipher_key_size;
Tim Sally5f5b3312012-07-12 19:10:24 -0400515
516 cipher_code = ecryptfs_code_for_cipher_string(
517 mount_crypt_stat->global_default_cipher_name,
518 mount_crypt_stat->global_default_cipher_key_size);
519 if (!cipher_code) {
520 ecryptfs_printk(KERN_ERR,
521 "eCryptfs doesn't support cipher: %s",
522 mount_crypt_stat->global_default_cipher_name);
523 rc = -EINVAL;
524 goto out;
525 }
526
Eric Sandeenaf440f52008-02-06 01:38:37 -0800527 mutex_lock(&key_tfm_list_mutex);
Tim Zimmermann5c435c12021-03-18 09:19:56 +0100528#ifdef CONFIG_CRYPTO_FIPS
529 if (!ecryptfs_tfm_exists(mount_crypt_stat->global_default_cipher_name, cipher_mode,
530 NULL)) {
531
532 rc = ecryptfs_add_new_key_tfm(
533 NULL, mount_crypt_stat->global_default_cipher_name,
534 mount_crypt_stat->global_default_cipher_key_size,
535 mount_crypt_stat->flags);
536 if (rc) {
537 printk(KERN_ERR "Error attempting to initialize "
538 "cipher with name = [%s] and key size = [%td]; "
539 "rc = [%d]\n",
540 mount_crypt_stat->global_default_cipher_name,
541 mount_crypt_stat->global_default_cipher_key_size,
542 rc);
543 rc = -EINVAL;
544 mutex_unlock(&key_tfm_list_mutex);
545 goto out;
546 }
547 }
548
549 if ((mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES)
550 && !ecryptfs_tfm_exists(
551 mount_crypt_stat->global_default_fn_cipher_name, cipher_mode, NULL)) {
552 rc = ecryptfs_add_new_key_tfm(
553 NULL, mount_crypt_stat->global_default_fn_cipher_name,
554 mount_crypt_stat->global_default_fn_cipher_key_bytes,
555 mount_crypt_stat->flags);
556
557 if (rc) {
558 printk(KERN_ERR "Error attempting to initialize "
559 "cipher with name = [%s] and key size = [%td]; "
560 "rc = [%d]\n",
561 mount_crypt_stat->global_default_fn_cipher_name,
562 mount_crypt_stat->global_default_fn_cipher_key_bytes,
563 rc);
564 rc = -EINVAL;
565 mutex_unlock(&key_tfm_list_mutex);
566 goto out;
567 }
568 }
569#else
Eric Sandeenaf440f52008-02-06 01:38:37 -0800570 if (!ecryptfs_tfm_exists(mount_crypt_stat->global_default_cipher_name,
Michael Halcrow87c94c42009-01-06 14:42:01 -0800571 NULL)) {
Eric Sandeenaf440f52008-02-06 01:38:37 -0800572 rc = ecryptfs_add_new_key_tfm(
573 NULL, mount_crypt_stat->global_default_cipher_name,
574 mount_crypt_stat->global_default_cipher_key_size);
Michael Halcrow87c94c42009-01-06 14:42:01 -0800575 if (rc) {
576 printk(KERN_ERR "Error attempting to initialize "
577 "cipher with name = [%s] and key size = [%td]; "
578 "rc = [%d]\n",
579 mount_crypt_stat->global_default_cipher_name,
580 mount_crypt_stat->global_default_cipher_key_size,
581 rc);
582 rc = -EINVAL;
583 mutex_unlock(&key_tfm_list_mutex);
584 goto out;
585 }
Michael Halcrow237fead2006-10-04 02:16:22 -0700586 }
Michael Halcrow87c94c42009-01-06 14:42:01 -0800587 if ((mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES)
588 && !ecryptfs_tfm_exists(
589 mount_crypt_stat->global_default_fn_cipher_name, NULL)) {
590 rc = ecryptfs_add_new_key_tfm(
591 NULL, mount_crypt_stat->global_default_fn_cipher_name,
592 mount_crypt_stat->global_default_fn_cipher_key_bytes);
593 if (rc) {
594 printk(KERN_ERR "Error attempting to initialize "
595 "cipher with name = [%s] and key size = [%td]; "
596 "rc = [%d]\n",
597 mount_crypt_stat->global_default_fn_cipher_name,
598 mount_crypt_stat->global_default_fn_cipher_key_bytes,
599 rc);
600 rc = -EINVAL;
601 mutex_unlock(&key_tfm_list_mutex);
602 goto out;
603 }
604 }
Tim Zimmermann5c435c12021-03-18 09:19:56 +0100605#endif
Michael Halcrow87c94c42009-01-06 14:42:01 -0800606 mutex_unlock(&key_tfm_list_mutex);
Michael Halcrow5dda6992007-10-16 01:28:06 -0700607 rc = ecryptfs_init_global_auth_toks(mount_crypt_stat);
Michael Halcrow87c94c42009-01-06 14:42:01 -0800608 if (rc)
Michael Halcrowf4aad162007-10-16 01:27:53 -0700609 printk(KERN_WARNING "One or more global auth toks could not "
610 "properly register; rc = [%d]\n", rc);
Michael Halcrow237fead2006-10-04 02:16:22 -0700611out:
612 return rc;
613}
614
615struct kmem_cache *ecryptfs_sb_info_cache;
Al Viro44031582010-05-17 00:59:46 -0400616static struct file_system_type ecryptfs_fs_type;
Michael Halcrow237fead2006-10-04 02:16:22 -0700617
618/**
Michael Halcrow237fead2006-10-04 02:16:22 -0700619 * ecryptfs_get_sb
620 * @fs_type
621 * @flags
622 * @dev_name: The path to mount over
623 * @raw_data: The options passed into the kernel
Michael Halcrow237fead2006-10-04 02:16:22 -0700624 */
Al Viro4d143be2010-07-26 13:33:36 +0400625static struct dentry *ecryptfs_mount(struct file_system_type *fs_type, int flags,
626 const char *dev_name, void *raw_data)
Michael Halcrow237fead2006-10-04 02:16:22 -0700627{
Tim Zimmermann5c435c12021-03-18 09:19:56 +0100628 struct super_block *s, *lower_sb;
Al Viro2ccde7c2010-03-21 12:24:29 -0400629 struct ecryptfs_sb_info *sbi;
Tyler Hicks332b1222014-10-07 15:51:55 -0500630 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
Al Viro2ccde7c2010-03-21 12:24:29 -0400631 struct ecryptfs_dentry_info *root_info;
632 const char *err = "Getting sb failed";
Al Viro66cb7662011-01-12 20:04:37 -0500633 struct inode *inode;
634 struct path path;
John Johansen76435542011-07-22 08:14:15 -0700635 uid_t check_ruid;
Michael Halcrow237fead2006-10-04 02:16:22 -0700636 int rc;
Michael Halcrow237fead2006-10-04 02:16:22 -0700637
Al Viro2ccde7c2010-03-21 12:24:29 -0400638 sbi = kmem_cache_zalloc(ecryptfs_sb_info_cache, GFP_KERNEL);
639 if (!sbi) {
640 rc = -ENOMEM;
Michael Halcrow237fead2006-10-04 02:16:22 -0700641 goto out;
642 }
Al Viro2ccde7c2010-03-21 12:24:29 -0400643
John Johansen76435542011-07-22 08:14:15 -0700644 rc = ecryptfs_parse_options(sbi, raw_data, &check_ruid);
Michael Halcrow237fead2006-10-04 02:16:22 -0700645 if (rc) {
Al Viro2ccde7c2010-03-21 12:24:29 -0400646 err = "Error parsing options";
647 goto out;
Michael Halcrow237fead2006-10-04 02:16:22 -0700648 }
Tyler Hicks332b1222014-10-07 15:51:55 -0500649 mount_crypt_stat = &sbi->mount_crypt_stat;
Al Viro2ccde7c2010-03-21 12:24:29 -0400650
David Howells9249e172012-06-25 12:55:37 +0100651 s = sget(fs_type, NULL, set_anon_super, flags, NULL);
Al Viro2ccde7c2010-03-21 12:24:29 -0400652 if (IS_ERR(s)) {
653 rc = PTR_ERR(s);
654 goto out;
655 }
656
Jan Karae8368182017-04-12 12:24:35 +0200657 rc = super_setup_bdi(s);
Al Viro66cb7662011-01-12 20:04:37 -0500658 if (rc)
659 goto out1;
Al Viro2ccde7c2010-03-21 12:24:29 -0400660
661 ecryptfs_set_superblock_private(s, sbi);
Al Viro2ccde7c2010-03-21 12:24:29 -0400662
663 /* ->kill_sb() will take care of sbi after that point */
664 sbi = NULL;
665 s->s_op = &ecryptfs_sops;
Andreas Gruenbacher4b899da2016-09-29 17:48:36 +0200666 s->s_xattr = ecryptfs_xattr_handlers;
Al Viro66cb7662011-01-12 20:04:37 -0500667 s->s_d_op = &ecryptfs_dops;
668
669 err = "Reading sb failed";
670 rc = kern_path(dev_name, LOOKUP_FOLLOW | LOOKUP_DIRECTORY, &path);
671 if (rc) {
672 ecryptfs_printk(KERN_WARNING, "kern_path() failed\n");
673 goto out1;
674 }
675 if (path.dentry->d_sb->s_type == &ecryptfs_fs_type) {
676 rc = -EINVAL;
677 printk(KERN_ERR "Mount on filesystem of type "
678 "eCryptfs explicitly disallowed due to "
679 "known incompatibilities\n");
680 goto out_free;
681 }
John Johansen76435542011-07-22 08:14:15 -0700682
David Howells2b0143b2015-03-17 22:25:59 +0000683 if (check_ruid && !uid_eq(d_inode(path.dentry)->i_uid, current_uid())) {
John Johansen76435542011-07-22 08:14:15 -0700684 rc = -EPERM;
685 printk(KERN_ERR "Mount of device (uid: %d) not owned by "
686 "requested user (uid: %d)\n",
David Howells2b0143b2015-03-17 22:25:59 +0000687 i_uid_read(d_inode(path.dentry)),
Eric W. Biedermancdf8c582012-02-07 16:24:33 -0800688 from_kuid(&init_user_ns, current_uid()));
John Johansen76435542011-07-22 08:14:15 -0700689 goto out_free;
690 }
691
Tim Zimmermann5c435c12021-03-18 09:19:56 +0100692 lower_sb = path.dentry->d_sb;
693 atomic_inc(&lower_sb->s_active);
Al Viro66cb7662011-01-12 20:04:37 -0500694 ecryptfs_set_superblock_lower(s, path.dentry->d_sb);
Tyler Hicks069ddcd2012-06-11 15:42:32 -0700695
696 /**
697 * Set the POSIX ACL flag based on whether they're enabled in the lower
Tyler Hicks332b1222014-10-07 15:51:55 -0500698 * mount.
Tyler Hicks069ddcd2012-06-11 15:42:32 -0700699 */
700 s->s_flags = flags & ~MS_POSIXACL;
Tyler Hicks332b1222014-10-07 15:51:55 -0500701 s->s_flags |= path.dentry->d_sb->s_flags & MS_POSIXACL;
702
703 /**
704 * Force a read-only eCryptfs mount when:
705 * 1) The lower mount is ro
706 * 2) The ecryptfs_encrypted_view mount option is specified
707 */
David Howellsbc98a422017-07-17 08:45:34 +0100708 if (sb_rdonly(path.dentry->d_sb) || mount_crypt_stat->flags & ECRYPTFS_ENCRYPTED_VIEW_ENABLED)
Tyler Hicks332b1222014-10-07 15:51:55 -0500709 s->s_flags |= MS_RDONLY;
Tyler Hicks069ddcd2012-06-11 15:42:32 -0700710
Al Viro66cb7662011-01-12 20:04:37 -0500711 s->s_maxbytes = path.dentry->d_sb->s_maxbytes;
712 s->s_blocksize = path.dentry->d_sb->s_blocksize;
Roberto Sassu070baa52010-11-03 11:11:22 +0100713 s->s_magic = ECRYPTFS_SUPER_MAGIC;
Miklos Szeredi69c433e2014-10-24 00:14:39 +0200714 s->s_stack_depth = path.dentry->d_sb->s_stack_depth + 1;
715
716 rc = -EINVAL;
717 if (s->s_stack_depth > FILESYSTEM_MAX_STACK_DEPTH) {
718 pr_err("eCryptfs: maximum fs stacking depth exceeded\n");
719 goto out_free;
720 }
Al Viro66cb7662011-01-12 20:04:37 -0500721
David Howells2b0143b2015-03-17 22:25:59 +0000722 inode = ecryptfs_get_inode(d_inode(path.dentry), s);
Al Viro66cb7662011-01-12 20:04:37 -0500723 rc = PTR_ERR(inode);
724 if (IS_ERR(inode))
Tim Zimmermann5c435c12021-03-18 09:19:56 +0100725 goto out_sput;
Al Viro66cb7662011-01-12 20:04:37 -0500726
Al Viro48fde702012-01-08 22:15:13 -0500727 s->s_root = d_make_root(inode);
Al Viro66cb7662011-01-12 20:04:37 -0500728 if (!s->s_root) {
Al Viro66cb7662011-01-12 20:04:37 -0500729 rc = -ENOMEM;
Tim Zimmermann5c435c12021-03-18 09:19:56 +0100730 goto out_sput;
Al Viro66cb7662011-01-12 20:04:37 -0500731 }
Al Viro2ccde7c2010-03-21 12:24:29 -0400732
733 rc = -ENOMEM;
Al Viro2ccde7c2010-03-21 12:24:29 -0400734 root_info = kmem_cache_zalloc(ecryptfs_dentry_info_cache, GFP_KERNEL);
Al Viro66cb7662011-01-12 20:04:37 -0500735 if (!root_info)
Tim Zimmermann5c435c12021-03-18 09:19:56 +0100736 goto out_sput;
Al Viro66cb7662011-01-12 20:04:37 -0500737
Al Viro2ccde7c2010-03-21 12:24:29 -0400738 /* ->kill_sb() will take care of root_info */
739 ecryptfs_set_dentry_private(s->s_root, root_info);
Al Viro92dd1232013-09-15 20:50:13 -0400740 root_info->lower_path = path;
Al Viro66cb7662011-01-12 20:04:37 -0500741
Al Viro2ccde7c2010-03-21 12:24:29 -0400742 s->s_flags |= MS_ACTIVE;
Al Viro4d143be2010-07-26 13:33:36 +0400743 return dget(s->s_root);
Al Viro2ccde7c2010-03-21 12:24:29 -0400744
Tim Zimmermann5c435c12021-03-18 09:19:56 +0100745out_sput:
746 atomic_dec(&lower_sb->s_active);
Al Viro66cb7662011-01-12 20:04:37 -0500747out_free:
748 path_put(&path);
749out1:
750 deactivate_locked_super(s);
Michael Halcrow237fead2006-10-04 02:16:22 -0700751out:
Al Viro2ccde7c2010-03-21 12:24:29 -0400752 if (sbi) {
753 ecryptfs_destroy_mount_crypt_stat(&sbi->mount_crypt_stat);
754 kmem_cache_free(ecryptfs_sb_info_cache, sbi);
755 }
756 printk(KERN_ERR "%s; rc = [%d]\n", err, rc);
Al Viro4d143be2010-07-26 13:33:36 +0400757 return ERR_PTR(rc);
Michael Halcrow237fead2006-10-04 02:16:22 -0700758}
759
760/**
761 * ecryptfs_kill_block_super
762 * @sb: The ecryptfs super block
763 *
764 * Used to bring the superblock down and free the private data.
Michael Halcrow237fead2006-10-04 02:16:22 -0700765 */
766static void ecryptfs_kill_block_super(struct super_block *sb)
767{
Al Virodecabd62010-03-20 22:32:26 -0400768 struct ecryptfs_sb_info *sb_info = ecryptfs_superblock_to_private(sb);
769 kill_anon_super(sb);
770 if (!sb_info)
771 return;
Tim Zimmermann5c435c12021-03-18 09:19:56 +0100772
773 if (sb_info->wsi_sb)
774 atomic_dec(&sb_info->wsi_sb->s_active);
775
Al Virodecabd62010-03-20 22:32:26 -0400776 ecryptfs_destroy_mount_crypt_stat(&sb_info->mount_crypt_stat);
Al Virodecabd62010-03-20 22:32:26 -0400777 kmem_cache_free(ecryptfs_sb_info_cache, sb_info);
Michael Halcrow237fead2006-10-04 02:16:22 -0700778}
779
780static struct file_system_type ecryptfs_fs_type = {
781 .owner = THIS_MODULE,
782 .name = "ecryptfs",
Al Viro4d143be2010-07-26 13:33:36 +0400783 .mount = ecryptfs_mount,
Michael Halcrow237fead2006-10-04 02:16:22 -0700784 .kill_sb = ecryptfs_kill_block_super,
785 .fs_flags = 0
786};
Eric W. Biederman7f78e032013-03-02 19:39:14 -0800787MODULE_ALIAS_FS("ecryptfs");
Michael Halcrow237fead2006-10-04 02:16:22 -0700788
789/**
790 * inode_info_init_once
791 *
792 * Initializes the ecryptfs_inode_info_cache when it is created
793 */
794static void
Alexey Dobriyan51cc5062008-07-25 19:45:34 -0700795inode_info_init_once(void *vptr)
Michael Halcrow237fead2006-10-04 02:16:22 -0700796{
797 struct ecryptfs_inode_info *ei = (struct ecryptfs_inode_info *)vptr;
798
Christoph Lametera35afb82007-05-16 22:10:57 -0700799 inode_init_once(&ei->vfs_inode);
Michael Halcrow237fead2006-10-04 02:16:22 -0700800}
801
802static struct ecryptfs_cache_info {
Christoph Lametere18b8902006-12-06 20:33:20 -0800803 struct kmem_cache **cache;
Michael Halcrow237fead2006-10-04 02:16:22 -0700804 const char *name;
805 size_t size;
Vladimir Davydov5d097052016-01-14 15:18:21 -0800806 unsigned long flags;
Alexey Dobriyan51cc5062008-07-25 19:45:34 -0700807 void (*ctor)(void *obj);
Michael Halcrow237fead2006-10-04 02:16:22 -0700808} ecryptfs_cache_infos[] = {
809 {
810 .cache = &ecryptfs_auth_tok_list_item_cache,
811 .name = "ecryptfs_auth_tok_list_item",
812 .size = sizeof(struct ecryptfs_auth_tok_list_item),
813 },
814 {
815 .cache = &ecryptfs_file_info_cache,
816 .name = "ecryptfs_file_cache",
817 .size = sizeof(struct ecryptfs_file_info),
818 },
819 {
820 .cache = &ecryptfs_dentry_info_cache,
821 .name = "ecryptfs_dentry_info_cache",
822 .size = sizeof(struct ecryptfs_dentry_info),
823 },
824 {
825 .cache = &ecryptfs_inode_info_cache,
826 .name = "ecryptfs_inode_cache",
827 .size = sizeof(struct ecryptfs_inode_info),
Vladimir Davydov5d097052016-01-14 15:18:21 -0800828 .flags = SLAB_ACCOUNT,
Michael Halcrow237fead2006-10-04 02:16:22 -0700829 .ctor = inode_info_init_once,
830 },
831 {
832 .cache = &ecryptfs_sb_info_cache,
833 .name = "ecryptfs_sb_cache",
834 .size = sizeof(struct ecryptfs_sb_info),
835 },
836 {
Tyler Hicks30632872011-05-24 05:11:12 -0500837 .cache = &ecryptfs_header_cache,
838 .name = "ecryptfs_headers",
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300839 .size = PAGE_SIZE,
Michael Halcrow237fead2006-10-04 02:16:22 -0700840 },
841 {
Michael Halcrowdd2a3b72007-02-12 00:53:46 -0800842 .cache = &ecryptfs_xattr_cache,
843 .name = "ecryptfs_xattr_cache",
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300844 .size = PAGE_SIZE,
Michael Halcrowdd2a3b72007-02-12 00:53:46 -0800845 },
846 {
Michael Halcroweb95e7f2007-02-16 01:28:40 -0800847 .cache = &ecryptfs_key_record_cache,
848 .name = "ecryptfs_key_record_cache",
849 .size = sizeof(struct ecryptfs_key_record),
850 },
Michael Halcrow956159c2007-10-16 01:27:55 -0700851 {
852 .cache = &ecryptfs_key_sig_cache,
853 .name = "ecryptfs_key_sig_cache",
854 .size = sizeof(struct ecryptfs_key_sig),
855 },
856 {
857 .cache = &ecryptfs_global_auth_tok_cache,
858 .name = "ecryptfs_global_auth_tok_cache",
859 .size = sizeof(struct ecryptfs_global_auth_tok),
860 },
861 {
862 .cache = &ecryptfs_key_tfm_cache,
863 .name = "ecryptfs_key_tfm_cache",
864 .size = sizeof(struct ecryptfs_key_tfm),
865 },
Michael Halcrow237fead2006-10-04 02:16:22 -0700866};
867
868static void ecryptfs_free_kmem_caches(void)
869{
870 int i;
871
Kirill A. Shutemov8c0a8532012-09-26 11:33:07 +1000872 /*
873 * Make sure all delayed rcu free inodes are flushed before we
874 * destroy cache.
875 */
876 rcu_barrier();
877
Michael Halcrow237fead2006-10-04 02:16:22 -0700878 for (i = 0; i < ARRAY_SIZE(ecryptfs_cache_infos); i++) {
879 struct ecryptfs_cache_info *info;
880
881 info = &ecryptfs_cache_infos[i];
Julia Lawallc39341c2015-09-13 14:15:21 +0200882 kmem_cache_destroy(*(info->cache));
Michael Halcrow237fead2006-10-04 02:16:22 -0700883 }
884}
885
886/**
887 * ecryptfs_init_kmem_caches
888 *
889 * Returns zero on success; non-zero otherwise
890 */
891static int ecryptfs_init_kmem_caches(void)
892{
893 int i;
894
895 for (i = 0; i < ARRAY_SIZE(ecryptfs_cache_infos); i++) {
896 struct ecryptfs_cache_info *info;
897
898 info = &ecryptfs_cache_infos[i];
Vladimir Davydov5d097052016-01-14 15:18:21 -0800899 *(info->cache) = kmem_cache_create(info->name, info->size, 0,
900 SLAB_HWCACHE_ALIGN | info->flags, info->ctor);
Michael Halcrow237fead2006-10-04 02:16:22 -0700901 if (!*(info->cache)) {
902 ecryptfs_free_kmem_caches();
903 ecryptfs_printk(KERN_WARNING, "%s: "
904 "kmem_cache_create failed\n",
905 info->name);
906 return -ENOMEM;
907 }
908 }
909 return 0;
910}
911
Greg Kroah-Hartman6e90aa92007-11-06 15:08:08 -0800912static struct kobject *ecryptfs_kobj;
Michael Halcrow237fead2006-10-04 02:16:22 -0700913
Kay Sievers386f2752007-11-02 13:47:53 +0100914static ssize_t version_show(struct kobject *kobj,
915 struct kobj_attribute *attr, char *buff)
Michael Halcrow237fead2006-10-04 02:16:22 -0700916{
917 return snprintf(buff, PAGE_SIZE, "%d\n", ECRYPTFS_VERSIONING_MASK);
918}
919
Kay Sievers386f2752007-11-02 13:47:53 +0100920static struct kobj_attribute version_attr = __ATTR_RO(version);
Michael Halcrow237fead2006-10-04 02:16:22 -0700921
Greg Kroah-Hartman30a468b2007-10-15 15:01:24 -0700922static struct attribute *attributes[] = {
923 &version_attr.attr,
Greg Kroah-Hartman30a468b2007-10-15 15:01:24 -0700924 NULL,
925};
926
927static struct attribute_group attr_group = {
928 .attrs = attributes,
929};
Michael Halcrow237fead2006-10-04 02:16:22 -0700930
931static int do_sysfs_registration(void)
932{
933 int rc;
934
Greg Kroah-Hartman6e90aa92007-11-06 15:08:08 -0800935 ecryptfs_kobj = kobject_create_and_add("ecryptfs", fs_kobj);
936 if (!ecryptfs_kobj) {
Greg Kroah-Hartman917e8652007-10-29 20:13:17 +0100937 printk(KERN_ERR "Unable to create ecryptfs kset\n");
938 rc = -ENOMEM;
Michael Halcrow237fead2006-10-04 02:16:22 -0700939 goto out;
940 }
Greg Kroah-Hartman6e90aa92007-11-06 15:08:08 -0800941 rc = sysfs_create_group(ecryptfs_kobj, &attr_group);
Michael Halcrow237fead2006-10-04 02:16:22 -0700942 if (rc) {
943 printk(KERN_ERR
Greg Kroah-Hartman30a468b2007-10-15 15:01:24 -0700944 "Unable to create ecryptfs version attributes\n");
Greg Kroah-Hartman197b12d2007-12-20 08:13:05 -0800945 kobject_put(ecryptfs_kobj);
Michael Halcrow237fead2006-10-04 02:16:22 -0700946 }
947out:
948 return rc;
949}
950
Ryusuke Konishia75de1b2007-08-10 13:00:56 -0700951static void do_sysfs_unregistration(void)
952{
Greg Kroah-Hartman6e90aa92007-11-06 15:08:08 -0800953 sysfs_remove_group(ecryptfs_kobj, &attr_group);
Greg Kroah-Hartman197b12d2007-12-20 08:13:05 -0800954 kobject_put(ecryptfs_kobj);
Ryusuke Konishia75de1b2007-08-10 13:00:56 -0700955}
956
Michael Halcrow237fead2006-10-04 02:16:22 -0700957static int __init ecryptfs_init(void)
958{
959 int rc;
960
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300961 if (ECRYPTFS_DEFAULT_EXTENT_SIZE > PAGE_SIZE) {
Michael Halcrow237fead2006-10-04 02:16:22 -0700962 rc = -EINVAL;
963 ecryptfs_printk(KERN_ERR, "The eCryptfs extent size is "
964 "larger than the host's page size, and so "
965 "eCryptfs cannot run on this system. The "
Joe Perches888d57b2010-11-10 15:46:16 -0800966 "default eCryptfs extent size is [%u] bytes; "
967 "the page size is [%lu] bytes.\n",
968 ECRYPTFS_DEFAULT_EXTENT_SIZE,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300969 (unsigned long)PAGE_SIZE);
Michael Halcrow237fead2006-10-04 02:16:22 -0700970 goto out;
971 }
972 rc = ecryptfs_init_kmem_caches();
973 if (rc) {
974 printk(KERN_ERR
975 "Failed to allocate one or more kmem_cache objects\n");
976 goto out;
977 }
Michael Halcrow237fead2006-10-04 02:16:22 -0700978 rc = do_sysfs_registration();
979 if (rc) {
980 printk(KERN_ERR "sysfs registration failed\n");
Al Viro0794f562012-03-17 21:29:13 -0400981 goto out_free_kmem_caches;
Michael Halcrow237fead2006-10-04 02:16:22 -0700982 }
Michael Halcrow746f1e52008-07-23 21:30:02 -0700983 rc = ecryptfs_init_kthread();
984 if (rc) {
985 printk(KERN_ERR "%s: kthread initialization failed; "
986 "rc = [%d]\n", __func__, rc);
987 goto out_do_sysfs_unregistration;
988 }
Tyler Hicks624ae522008-10-15 22:02:51 -0700989 rc = ecryptfs_init_messaging();
Michael Halcrowdddfa462007-02-12 00:53:44 -0800990 if (rc) {
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300991 printk(KERN_ERR "Failure occurred while attempting to "
Tyler Hicks624ae522008-10-15 22:02:51 -0700992 "initialize the communications channel to "
993 "ecryptfsd\n");
Michael Halcrow746f1e52008-07-23 21:30:02 -0700994 goto out_destroy_kthread;
Michael Halcrow956159c2007-10-16 01:27:55 -0700995 }
996 rc = ecryptfs_init_crypto();
997 if (rc) {
998 printk(KERN_ERR "Failure whilst attempting to init crypto; "
999 "rc = [%d]\n", rc);
Michael Halcrowcf81f892007-10-16 01:28:07 -07001000 goto out_release_messaging;
Michael Halcrowdddfa462007-02-12 00:53:44 -08001001 }
Al Viro0794f562012-03-17 21:29:13 -04001002 rc = register_filesystem(&ecryptfs_fs_type);
1003 if (rc) {
1004 printk(KERN_ERR "Failed to register filesystem\n");
1005 goto out_destroy_crypto;
1006 }
Eric Sandeen2830bfd2008-02-06 01:38:34 -08001007 if (ecryptfs_verbosity > 0)
1008 printk(KERN_CRIT "eCryptfs verbosity set to %d. Secret values "
1009 "will be written to the syslog!\n", ecryptfs_verbosity);
1010
Michael Halcrowcf81f892007-10-16 01:28:07 -07001011 goto out;
Al Viro0794f562012-03-17 21:29:13 -04001012out_destroy_crypto:
1013 ecryptfs_destroy_crypto();
Michael Halcrowcf81f892007-10-16 01:28:07 -07001014out_release_messaging:
Tyler Hicks624ae522008-10-15 22:02:51 -07001015 ecryptfs_release_messaging();
Michael Halcrow746f1e52008-07-23 21:30:02 -07001016out_destroy_kthread:
1017 ecryptfs_destroy_kthread();
Michael Halcrowcf81f892007-10-16 01:28:07 -07001018out_do_sysfs_unregistration:
1019 do_sysfs_unregistration();
Michael Halcrowcf81f892007-10-16 01:28:07 -07001020out_free_kmem_caches:
1021 ecryptfs_free_kmem_caches();
Michael Halcrow237fead2006-10-04 02:16:22 -07001022out:
1023 return rc;
1024}
1025
1026static void __exit ecryptfs_exit(void)
1027{
Michael Halcrowcf81f892007-10-16 01:28:07 -07001028 int rc;
1029
1030 rc = ecryptfs_destroy_crypto();
1031 if (rc)
1032 printk(KERN_ERR "Failure whilst attempting to destroy crypto; "
1033 "rc = [%d]\n", rc);
Tyler Hicks624ae522008-10-15 22:02:51 -07001034 ecryptfs_release_messaging();
Michael Halcrow746f1e52008-07-23 21:30:02 -07001035 ecryptfs_destroy_kthread();
Michael Halcrowcf81f892007-10-16 01:28:07 -07001036 do_sysfs_unregistration();
Michael Halcrow237fead2006-10-04 02:16:22 -07001037 unregister_filesystem(&ecryptfs_fs_type);
1038 ecryptfs_free_kmem_caches();
1039}
1040
1041MODULE_AUTHOR("Michael A. Halcrow <mhalcrow@us.ibm.com>");
1042MODULE_DESCRIPTION("eCryptfs");
1043
1044MODULE_LICENSE("GPL");
1045
1046module_init(ecryptfs_init)
1047module_exit(ecryptfs_exit)