a65f4865182ce9fb16010ef2f4eeb1c7bc27b6b5
[linux-2.6.git] / fs / ecryptfs / main.c
1 /**
2  * eCryptfs: Linux filesystem encryption layer
3  *
4  * Copyright (C) 1997-2003 Erez Zadok
5  * Copyright (C) 2001-2003 Stony Brook University
6  * Copyright (C) 2004-2006 International Business Machines Corp.
7  *   Author(s): Michael A. Halcrow <mahalcro@us.ibm.com>
8  *              Michael C. Thompson <mcthomps@us.ibm.com>
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License as
12  * published by the Free Software Foundation; either version 2 of the
13  * License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful, but
16  * WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
23  * 02111-1307, USA.
24  */
25
26 #include <linux/dcache.h>
27 #include <linux/file.h>
28 #include <linux/module.h>
29 #include <linux/namei.h>
30 #include <linux/skbuff.h>
31 #include <linux/crypto.h>
32 #include <linux/netlink.h>
33 #include <linux/mount.h>
34 #include <linux/dcache.h>
35 #include <linux/pagemap.h>
36 #include <linux/key.h>
37 #include <linux/parser.h>
38 #include "ecryptfs_kernel.h"
39
40 /**
41  * Module parameter that defines the ecryptfs_verbosity level.
42  */
43 int ecryptfs_verbosity = 0;
44
45 module_param(ecryptfs_verbosity, int, 0);
46 MODULE_PARM_DESC(ecryptfs_verbosity,
47                  "Initial verbosity level (0 or 1; defaults to "
48                  "0, which is Quiet)");
49
50 void __ecryptfs_printk(const char *fmt, ...)
51 {
52         va_list args;
53         va_start(args, fmt);
54         if (fmt[1] == '7') { /* KERN_DEBUG */
55                 if (ecryptfs_verbosity >= 1)
56                         vprintk(fmt, args);
57         } else
58                 vprintk(fmt, args);
59         va_end(args);
60 }
61
62 /**
63  * ecryptfs_interpose
64  * @lower_dentry: Existing dentry in the lower filesystem
65  * @dentry: ecryptfs' dentry
66  * @sb: ecryptfs's super_block
67  * @flag: If set to true, then d_add is called, else d_instantiate is called
68  *
69  * Interposes upper and lower dentries.
70  *
71  * Returns zero on success; non-zero otherwise
72  */
73 int ecryptfs_interpose(struct dentry *lower_dentry, struct dentry *dentry,
74                        struct super_block *sb, int flag)
75 {
76         struct inode *lower_inode;
77         struct inode *inode;
78         int rc = 0;
79
80         lower_inode = lower_dentry->d_inode;
81         if (lower_inode->i_sb != ecryptfs_superblock_to_lower(sb)) {
82                 rc = -EXDEV;
83                 goto out;
84         }
85         if (!igrab(lower_inode)) {
86                 rc = -ESTALE;
87                 goto out;
88         }
89         inode = iget5_locked(sb, (unsigned long)lower_inode,
90                              ecryptfs_inode_test, ecryptfs_inode_set,
91                              lower_inode);
92         if (!inode) {
93                 rc = -EACCES;
94                 iput(lower_inode);
95                 goto out;
96         }
97         if (inode->i_state & I_NEW)
98                 unlock_new_inode(inode);
99         else
100                 iput(lower_inode);
101         if (S_ISLNK(lower_inode->i_mode))
102                 inode->i_op = &ecryptfs_symlink_iops;
103         else if (S_ISDIR(lower_inode->i_mode))
104                 inode->i_op = &ecryptfs_dir_iops;
105         if (S_ISDIR(lower_inode->i_mode))
106                 inode->i_fop = &ecryptfs_dir_fops;
107         if (special_file(lower_inode->i_mode))
108                 init_special_inode(inode, lower_inode->i_mode,
109                                    lower_inode->i_rdev);
110         dentry->d_op = &ecryptfs_dops;
111         if (flag)
112                 d_add(dentry, inode);
113         else
114                 d_instantiate(dentry, inode);
115         ecryptfs_copy_attr_all(inode, lower_inode);
116         /* This size will be overwritten for real files w/ headers and
117          * other metadata */
118         ecryptfs_copy_inode_size(inode, lower_inode);
119 out:
120         return rc;
121 }
122
123 enum { ecryptfs_opt_sig, ecryptfs_opt_ecryptfs_sig, ecryptfs_opt_debug,
124        ecryptfs_opt_ecryptfs_debug, ecryptfs_opt_cipher,
125        ecryptfs_opt_ecryptfs_cipher, ecryptfs_opt_ecryptfs_key_bytes,
126        ecryptfs_opt_passthrough, ecryptfs_opt_err };
127
128 static match_table_t tokens = {
129         {ecryptfs_opt_sig, "sig=%s"},
130         {ecryptfs_opt_ecryptfs_sig, "ecryptfs_sig=%s"},
131         {ecryptfs_opt_debug, "debug=%u"},
132         {ecryptfs_opt_ecryptfs_debug, "ecryptfs_debug=%u"},
133         {ecryptfs_opt_cipher, "cipher=%s"},
134         {ecryptfs_opt_ecryptfs_cipher, "ecryptfs_cipher=%s"},
135         {ecryptfs_opt_ecryptfs_key_bytes, "ecryptfs_key_bytes=%u"},
136         {ecryptfs_opt_passthrough, "ecryptfs_passthrough"},
137         {ecryptfs_opt_err, NULL}
138 };
139
140 /**
141  * ecryptfs_verify_version
142  * @version: The version number to confirm
143  *
144  * Returns zero on good version; non-zero otherwise
145  */
146 static int ecryptfs_verify_version(u16 version)
147 {
148         int rc = 0;
149         unsigned char major;
150         unsigned char minor;
151
152         major = ((version >> 8) & 0xFF);
153         minor = (version & 0xFF);
154         if (major != ECRYPTFS_VERSION_MAJOR) {
155                 ecryptfs_printk(KERN_ERR, "Major version number mismatch. "
156                                 "Expected [%d]; got [%d]\n",
157                                 ECRYPTFS_VERSION_MAJOR, major);
158                 rc = -EINVAL;
159                 goto out;
160         }
161         if (minor != ECRYPTFS_VERSION_MINOR) {
162                 ecryptfs_printk(KERN_ERR, "Minor version number mismatch. "
163                                 "Expected [%d]; got [%d]\n",
164                                 ECRYPTFS_VERSION_MINOR, minor);
165                 rc = -EINVAL;
166                 goto out;
167         }
168 out:
169         return rc;
170 }
171
172 /**
173  * ecryptfs_parse_options
174  * @sb: The ecryptfs super block
175  * @options: The options pased to the kernel
176  *
177  * Parse mount options:
178  * debug=N         - ecryptfs_verbosity level for debug output
179  * sig=XXX         - description(signature) of the key to use
180  *
181  * Returns the dentry object of the lower-level (lower/interposed)
182  * directory; We want to mount our stackable file system on top of
183  * that lower directory.
184  *
185  * The signature of the key to use must be the description of a key
186  * already in the keyring. Mounting will fail if the key can not be
187  * found.
188  *
189  * Returns zero on success; non-zero on error
190  */
191 static int ecryptfs_parse_options(struct super_block *sb, char *options)
192 {
193         char *p;
194         int rc = 0;
195         int sig_set = 0;
196         int cipher_name_set = 0;
197         int cipher_key_bytes;
198         int cipher_key_bytes_set = 0;
199         struct key *auth_tok_key = NULL;
200         struct ecryptfs_auth_tok *auth_tok = NULL;
201         struct ecryptfs_mount_crypt_stat *mount_crypt_stat =
202                 &ecryptfs_superblock_to_private(sb)->mount_crypt_stat;
203         substring_t args[MAX_OPT_ARGS];
204         int token;
205         char *sig_src;
206         char *sig_dst;
207         char *debug_src;
208         char *cipher_name_dst;
209         char *cipher_name_src;
210         char *cipher_key_bytes_src;
211         int cipher_name_len;
212
213         if (!options) {
214                 rc = -EINVAL;
215                 goto out;
216         }
217         while ((p = strsep(&options, ",")) != NULL) {
218                 if (!*p)
219                         continue;
220                 token = match_token(p, tokens, args);
221                 switch (token) {
222                 case ecryptfs_opt_sig:
223                 case ecryptfs_opt_ecryptfs_sig:
224                         sig_src = args[0].from;
225                         sig_dst =
226                                 mount_crypt_stat->global_auth_tok_sig;
227                         memcpy(sig_dst, sig_src, ECRYPTFS_SIG_SIZE_HEX);
228                         sig_dst[ECRYPTFS_SIG_SIZE_HEX] = '\0';
229                         ecryptfs_printk(KERN_DEBUG,
230                                         "The mount_crypt_stat "
231                                         "global_auth_tok_sig set to: "
232                                         "[%s]\n", sig_dst);
233                         sig_set = 1;
234                         break;
235                 case ecryptfs_opt_debug:
236                 case ecryptfs_opt_ecryptfs_debug:
237                         debug_src = args[0].from;
238                         ecryptfs_verbosity =
239                                 (int)simple_strtol(debug_src, &debug_src,
240                                                    0);
241                         ecryptfs_printk(KERN_DEBUG,
242                                         "Verbosity set to [%d]" "\n",
243                                         ecryptfs_verbosity);
244                         break;
245                 case ecryptfs_opt_cipher:
246                 case ecryptfs_opt_ecryptfs_cipher:
247                         cipher_name_src = args[0].from;
248                         cipher_name_dst =
249                                 mount_crypt_stat->
250                                 global_default_cipher_name;
251                         strncpy(cipher_name_dst, cipher_name_src,
252                                 ECRYPTFS_MAX_CIPHER_NAME_SIZE);
253                         ecryptfs_printk(KERN_DEBUG,
254                                         "The mount_crypt_stat "
255                                         "global_default_cipher_name set to: "
256                                         "[%s]\n", cipher_name_dst);
257                         cipher_name_set = 1;
258                         break;
259                 case ecryptfs_opt_ecryptfs_key_bytes:
260                         cipher_key_bytes_src = args[0].from;
261                         cipher_key_bytes =
262                                 (int)simple_strtol(cipher_key_bytes_src,
263                                                    &cipher_key_bytes_src, 0);
264                         mount_crypt_stat->global_default_cipher_key_size =
265                                 cipher_key_bytes;
266                         ecryptfs_printk(KERN_DEBUG,
267                                         "The mount_crypt_stat "
268                                         "global_default_cipher_key_size "
269                                         "set to: [%d]\n", mount_crypt_stat->
270                                         global_default_cipher_key_size);
271                         cipher_key_bytes_set = 1;
272                         break;
273                 case ecryptfs_opt_passthrough:
274                         mount_crypt_stat->flags |=
275                                 ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED;
276                         break;
277                 case ecryptfs_opt_err:
278                 default:
279                         ecryptfs_printk(KERN_WARNING,
280                                         "eCryptfs: unrecognized option '%s'\n",
281                                         p);
282                 }
283         }
284         /* Do not support lack of mount-wide signature in 0.1
285          * release */
286         if (!sig_set) {
287                 rc = -EINVAL;
288                 ecryptfs_printk(KERN_ERR, "You must supply a valid "
289                                 "passphrase auth tok signature as a mount "
290                                 "parameter; see the eCryptfs README\n");
291                 goto out;
292         }
293         if (!cipher_name_set) {
294                 cipher_name_len = strlen(ECRYPTFS_DEFAULT_CIPHER);
295                 if (unlikely(cipher_name_len
296                              >= ECRYPTFS_MAX_CIPHER_NAME_SIZE)) {
297                         rc = -EINVAL;
298                         BUG();
299                         goto out;
300                 }
301                 memcpy(mount_crypt_stat->global_default_cipher_name,
302                        ECRYPTFS_DEFAULT_CIPHER, cipher_name_len);
303                 mount_crypt_stat->global_default_cipher_name[cipher_name_len]
304                     = '\0';
305         }
306         if (!cipher_key_bytes_set) {
307                 mount_crypt_stat->global_default_cipher_key_size = 0;
308         }
309         rc = ecryptfs_process_cipher(
310                 &mount_crypt_stat->global_key_tfm,
311                 mount_crypt_stat->global_default_cipher_name,
312                 &mount_crypt_stat->global_default_cipher_key_size);
313         if (rc) {
314                 printk(KERN_ERR "Error attempting to initialize cipher [%s] "
315                        "with key size [%Zd] bytes; rc = [%d]\n",
316                        mount_crypt_stat->global_default_cipher_name,
317                        mount_crypt_stat->global_default_cipher_key_size, rc);
318                 rc = -EINVAL;
319                 goto out;
320         }
321         mutex_init(&mount_crypt_stat->global_key_tfm_mutex);
322         ecryptfs_printk(KERN_DEBUG, "Requesting the key with description: "
323                         "[%s]\n", mount_crypt_stat->global_auth_tok_sig);
324         /* The reference to this key is held until umount is done The
325          * call to key_put is done in ecryptfs_put_super() */
326         auth_tok_key = request_key(&key_type_user,
327                                    mount_crypt_stat->global_auth_tok_sig,
328                                    NULL);
329         if (!auth_tok_key || IS_ERR(auth_tok_key)) {
330                 ecryptfs_printk(KERN_ERR, "Could not find key with "
331                                 "description: [%s]\n",
332                                 mount_crypt_stat->global_auth_tok_sig);
333                 process_request_key_err(PTR_ERR(auth_tok_key));
334                 rc = -EINVAL;
335                 goto out;
336         }
337         auth_tok = ecryptfs_get_key_payload_data(auth_tok_key);
338         if (ecryptfs_verify_version(auth_tok->version)) {
339                 ecryptfs_printk(KERN_ERR, "Data structure version mismatch. "
340                                 "Userspace tools must match eCryptfs kernel "
341                                 "module with major version [%d] and minor "
342                                 "version [%d]\n", ECRYPTFS_VERSION_MAJOR,
343                                 ECRYPTFS_VERSION_MINOR);
344                 rc = -EINVAL;
345                 goto out;
346         }
347         if (auth_tok->token_type != ECRYPTFS_PASSWORD) {
348                 ecryptfs_printk(KERN_ERR, "Invalid auth_tok structure "
349                                 "returned from key\n");
350                 rc = -EINVAL;
351                 goto out;
352         }
353         mount_crypt_stat->global_auth_tok_key = auth_tok_key;
354         mount_crypt_stat->global_auth_tok = auth_tok;
355 out:
356         return rc;
357 }
358
359 struct kmem_cache *ecryptfs_sb_info_cache;
360
361 /**
362  * ecryptfs_fill_super
363  * @sb: The ecryptfs super block
364  * @raw_data: The options passed to mount
365  * @silent: Not used but required by function prototype
366  *
367  * Sets up what we can of the sb, rest is done in ecryptfs_read_super
368  *
369  * Returns zero on success; non-zero otherwise
370  */
371 static int
372 ecryptfs_fill_super(struct super_block *sb, void *raw_data, int silent)
373 {
374         int rc = 0;
375
376         /* Released in ecryptfs_put_super() */
377         ecryptfs_set_superblock_private(sb,
378                                         kmem_cache_alloc(ecryptfs_sb_info_cache,
379                                                          SLAB_KERNEL));
380         if (!ecryptfs_superblock_to_private(sb)) {
381                 ecryptfs_printk(KERN_WARNING, "Out of memory\n");
382                 rc = -ENOMEM;
383                 goto out;
384         }
385         memset(ecryptfs_superblock_to_private(sb), 0,
386                sizeof(struct ecryptfs_sb_info));
387         sb->s_op = &ecryptfs_sops;
388         /* Released through deactivate_super(sb) from get_sb_nodev */
389         sb->s_root = d_alloc(NULL, &(const struct qstr) {
390                              .hash = 0,.name = "/",.len = 1});
391         if (!sb->s_root) {
392                 ecryptfs_printk(KERN_ERR, "d_alloc failed\n");
393                 rc = -ENOMEM;
394                 goto out;
395         }
396         sb->s_root->d_op = &ecryptfs_dops;
397         sb->s_root->d_sb = sb;
398         sb->s_root->d_parent = sb->s_root;
399         /* Released in d_release when dput(sb->s_root) is called */
400         /* through deactivate_super(sb) from get_sb_nodev() */
401         ecryptfs_set_dentry_private(sb->s_root,
402                                     kmem_cache_alloc(ecryptfs_dentry_info_cache,
403                                                      SLAB_KERNEL));
404         if (!ecryptfs_dentry_to_private(sb->s_root)) {
405                 ecryptfs_printk(KERN_ERR,
406                                 "dentry_info_cache alloc failed\n");
407                 rc = -ENOMEM;
408                 goto out;
409         }
410         memset(ecryptfs_dentry_to_private(sb->s_root), 0,
411                sizeof(struct ecryptfs_dentry_info));
412         rc = 0;
413 out:
414         /* Should be able to rely on deactivate_super called from
415          * get_sb_nodev */
416         return rc;
417 }
418
419 /**
420  * ecryptfs_read_super
421  * @sb: The ecryptfs super block
422  * @dev_name: The path to mount over
423  *
424  * Read the super block of the lower filesystem, and use
425  * ecryptfs_interpose to create our initial inode and super block
426  * struct.
427  */
428 static int ecryptfs_read_super(struct super_block *sb, const char *dev_name)
429 {
430         int rc;
431         struct nameidata nd;
432         struct dentry *lower_root;
433         struct vfsmount *lower_mnt;
434
435         memset(&nd, 0, sizeof(struct nameidata));
436         rc = path_lookup(dev_name, LOOKUP_FOLLOW, &nd);
437         if (rc) {
438                 ecryptfs_printk(KERN_WARNING, "path_lookup() failed\n");
439                 goto out_free;
440         }
441         lower_root = nd.dentry;
442         if (!lower_root->d_inode) {
443                 ecryptfs_printk(KERN_WARNING,
444                                 "No directory to interpose on\n");
445                 rc = -ENOENT;
446                 goto out_free;
447         }
448         lower_mnt = nd.mnt;
449         ecryptfs_set_superblock_lower(sb, lower_root->d_sb);
450         sb->s_maxbytes = lower_root->d_sb->s_maxbytes;
451         ecryptfs_set_dentry_lower(sb->s_root, lower_root);
452         ecryptfs_set_dentry_lower_mnt(sb->s_root, lower_mnt);
453         if ((rc = ecryptfs_interpose(lower_root, sb->s_root, sb, 0)))
454                 goto out_free;
455         rc = 0;
456         goto out;
457 out_free:
458         path_release(&nd);
459 out:
460         return rc;
461 }
462
463 /**
464  * ecryptfs_get_sb
465  * @fs_type
466  * @flags
467  * @dev_name: The path to mount over
468  * @raw_data: The options passed into the kernel
469  *
470  * The whole ecryptfs_get_sb process is broken into 4 functions:
471  * ecryptfs_parse_options(): handle options passed to ecryptfs, if any
472  * ecryptfs_fill_super(): used by get_sb_nodev, fills out the super_block
473  *                        with as much information as it can before needing
474  *                        the lower filesystem.
475  * ecryptfs_read_super(): this accesses the lower filesystem and uses
476  *                        ecryptfs_interpolate to perform most of the linking
477  * ecryptfs_interpolate(): links the lower filesystem into ecryptfs
478  */
479 static int ecryptfs_get_sb(struct file_system_type *fs_type, int flags,
480                         const char *dev_name, void *raw_data,
481                         struct vfsmount *mnt)
482 {
483         int rc;
484         struct super_block *sb;
485
486         rc = get_sb_nodev(fs_type, flags, raw_data, ecryptfs_fill_super, mnt);
487         if (rc < 0) {
488                 printk(KERN_ERR "Getting sb failed; rc = [%d]\n", rc);
489                 goto out;
490         }
491         sb = mnt->mnt_sb;
492         rc = ecryptfs_parse_options(sb, raw_data);
493         if (rc) {
494                 printk(KERN_ERR "Error parsing options; rc = [%d]\n", rc);
495                 goto out_abort;
496         }
497         rc = ecryptfs_read_super(sb, dev_name);
498         if (rc) {
499                 printk(KERN_ERR "Reading sb failed; rc = [%d]\n", rc);
500                 goto out_abort;
501         }
502         goto out;
503 out_abort:
504         dput(sb->s_root);
505         up_write(&sb->s_umount);
506         deactivate_super(sb);
507 out:
508         return rc;
509 }
510
511 /**
512  * ecryptfs_kill_block_super
513  * @sb: The ecryptfs super block
514  *
515  * Used to bring the superblock down and free the private data.
516  * Private data is free'd in ecryptfs_put_super()
517  */
518 static void ecryptfs_kill_block_super(struct super_block *sb)
519 {
520         generic_shutdown_super(sb);
521 }
522
523 static struct file_system_type ecryptfs_fs_type = {
524         .owner = THIS_MODULE,
525         .name = "ecryptfs",
526         .get_sb = ecryptfs_get_sb,
527         .kill_sb = ecryptfs_kill_block_super,
528         .fs_flags = 0
529 };
530
531 /**
532  * inode_info_init_once
533  *
534  * Initializes the ecryptfs_inode_info_cache when it is created
535  */
536 static void
537 inode_info_init_once(void *vptr, struct kmem_cache *cachep, unsigned long flags)
538 {
539         struct ecryptfs_inode_info *ei = (struct ecryptfs_inode_info *)vptr;
540
541         if ((flags & (SLAB_CTOR_VERIFY | SLAB_CTOR_CONSTRUCTOR)) ==
542             SLAB_CTOR_CONSTRUCTOR)
543                 inode_init_once(&ei->vfs_inode);
544 }
545
546 static struct ecryptfs_cache_info {
547         kmem_cache_t **cache;
548         const char *name;
549         size_t size;
550         void (*ctor)(void*, struct kmem_cache *, unsigned long);
551 } ecryptfs_cache_infos[] = {
552         {
553                 .cache = &ecryptfs_auth_tok_list_item_cache,
554                 .name = "ecryptfs_auth_tok_list_item",
555                 .size = sizeof(struct ecryptfs_auth_tok_list_item),
556         },
557         {
558                 .cache = &ecryptfs_file_info_cache,
559                 .name = "ecryptfs_file_cache",
560                 .size = sizeof(struct ecryptfs_file_info),
561         },
562         {
563                 .cache = &ecryptfs_dentry_info_cache,
564                 .name = "ecryptfs_dentry_info_cache",
565                 .size = sizeof(struct ecryptfs_dentry_info),
566         },
567         {
568                 .cache = &ecryptfs_inode_info_cache,
569                 .name = "ecryptfs_inode_cache",
570                 .size = sizeof(struct ecryptfs_inode_info),
571                 .ctor = inode_info_init_once,
572         },
573         {
574                 .cache = &ecryptfs_sb_info_cache,
575                 .name = "ecryptfs_sb_cache",
576                 .size = sizeof(struct ecryptfs_sb_info),
577         },
578         {
579                 .cache = &ecryptfs_header_cache_0,
580                 .name = "ecryptfs_headers_0",
581                 .size = PAGE_CACHE_SIZE,
582         },
583         {
584                 .cache = &ecryptfs_header_cache_1,
585                 .name = "ecryptfs_headers_1",
586                 .size = PAGE_CACHE_SIZE,
587         },
588         {
589                 .cache = &ecryptfs_header_cache_2,
590                 .name = "ecryptfs_headers_2",
591                 .size = PAGE_CACHE_SIZE,
592         },
593         {
594                 .cache = &ecryptfs_lower_page_cache,
595                 .name = "ecryptfs_lower_page_cache",
596                 .size = PAGE_CACHE_SIZE,
597         },
598 };
599
600 static void ecryptfs_free_kmem_caches(void)
601 {
602         int i;
603
604         for (i = 0; i < ARRAY_SIZE(ecryptfs_cache_infos); i++) {
605                 struct ecryptfs_cache_info *info;
606
607                 info = &ecryptfs_cache_infos[i];
608                 if (*(info->cache))
609                         kmem_cache_destroy(*(info->cache));
610         }
611 }
612
613 /**
614  * ecryptfs_init_kmem_caches
615  *
616  * Returns zero on success; non-zero otherwise
617  */
618 static int ecryptfs_init_kmem_caches(void)
619 {
620         int i;
621
622         for (i = 0; i < ARRAY_SIZE(ecryptfs_cache_infos); i++) {
623                 struct ecryptfs_cache_info *info;
624
625                 info = &ecryptfs_cache_infos[i];
626                 *(info->cache) = kmem_cache_create(info->name, info->size,
627                                 0, SLAB_HWCACHE_ALIGN, info->ctor, NULL);
628                 if (!*(info->cache)) {
629                         ecryptfs_free_kmem_caches();
630                         ecryptfs_printk(KERN_WARNING, "%s: "
631                                         "kmem_cache_create failed\n",
632                                         info->name);
633                         return -ENOMEM;
634                 }
635         }
636         return 0;
637 }
638
639 struct ecryptfs_obj {
640         char *name;
641         struct list_head slot_list;
642         struct kobject kobj;
643 };
644
645 struct ecryptfs_attribute {
646         struct attribute attr;
647         ssize_t(*show) (struct ecryptfs_obj *, char *);
648         ssize_t(*store) (struct ecryptfs_obj *, const char *, size_t);
649 };
650
651 static ssize_t
652 ecryptfs_attr_store(struct kobject *kobj,
653                     struct attribute *attr, const char *buf, size_t len)
654 {
655         struct ecryptfs_obj *obj = container_of(kobj, struct ecryptfs_obj,
656                                                 kobj);
657         struct ecryptfs_attribute *attribute =
658                 container_of(attr, struct ecryptfs_attribute, attr);
659
660         return (attribute->store ? attribute->store(obj, buf, len) : 0);
661 }
662
663 static ssize_t
664 ecryptfs_attr_show(struct kobject *kobj, struct attribute *attr, char *buf)
665 {
666         struct ecryptfs_obj *obj = container_of(kobj, struct ecryptfs_obj,
667                                                 kobj);
668         struct ecryptfs_attribute *attribute =
669                 container_of(attr, struct ecryptfs_attribute, attr);
670
671         return (attribute->show ? attribute->show(obj, buf) : 0);
672 }
673
674 static struct sysfs_ops ecryptfs_sysfs_ops = {
675         .show = ecryptfs_attr_show,
676         .store = ecryptfs_attr_store
677 };
678
679 static struct kobj_type ecryptfs_ktype = {
680         .sysfs_ops = &ecryptfs_sysfs_ops
681 };
682
683 static decl_subsys(ecryptfs, &ecryptfs_ktype, NULL);
684
685 static ssize_t version_show(struct ecryptfs_obj *obj, char *buff)
686 {
687         return snprintf(buff, PAGE_SIZE, "%d\n", ECRYPTFS_VERSIONING_MASK);
688 }
689
690 static struct ecryptfs_attribute sysfs_attr_version = __ATTR_RO(version);
691
692 struct ecryptfs_version_str_map_elem {
693         u32 flag;
694         char *str;
695 } ecryptfs_version_str_map[] = {
696         {ECRYPTFS_VERSIONING_PASSPHRASE, "passphrase"},
697         {ECRYPTFS_VERSIONING_PUBKEY, "pubkey"},
698         {ECRYPTFS_VERSIONING_PLAINTEXT_PASSTHROUGH, "plaintext passthrough"},
699         {ECRYPTFS_VERSIONING_POLICY, "policy"}
700 };
701
702 static ssize_t version_str_show(struct ecryptfs_obj *obj, char *buff)
703 {
704         int i;
705         int remaining = PAGE_SIZE;
706         int total_written = 0;
707
708         buff[0] = '\0';
709         for (i = 0; i < ARRAY_SIZE(ecryptfs_version_str_map); i++) {
710                 int entry_size;
711
712                 if (!(ECRYPTFS_VERSIONING_MASK
713                       & ecryptfs_version_str_map[i].flag))
714                         continue;
715                 entry_size = strlen(ecryptfs_version_str_map[i].str);
716                 if ((entry_size + 2) > remaining)
717                         goto out;
718                 memcpy(buff, ecryptfs_version_str_map[i].str, entry_size);
719                 buff[entry_size++] = '\n';
720                 buff[entry_size] = '\0';
721                 buff += entry_size;
722                 total_written += entry_size;
723                 remaining -= entry_size;
724         }
725 out:
726         return total_written;
727 }
728
729 static struct ecryptfs_attribute sysfs_attr_version_str = __ATTR_RO(version_str);
730
731 static int do_sysfs_registration(void)
732 {
733         int rc;
734
735         if ((rc = subsystem_register(&ecryptfs_subsys))) {
736                 printk(KERN_ERR
737                        "Unable to register ecryptfs sysfs subsystem\n");
738                 goto out;
739         }
740         rc = sysfs_create_file(&ecryptfs_subsys.kset.kobj,
741                                &sysfs_attr_version.attr);
742         if (rc) {
743                 printk(KERN_ERR
744                        "Unable to create ecryptfs version attribute\n");
745                 subsystem_unregister(&ecryptfs_subsys);
746                 goto out;
747         }
748         rc = sysfs_create_file(&ecryptfs_subsys.kset.kobj,
749                                &sysfs_attr_version_str.attr);
750         if (rc) {
751                 printk(KERN_ERR
752                        "Unable to create ecryptfs version_str attribute\n");
753                 sysfs_remove_file(&ecryptfs_subsys.kset.kobj,
754                                   &sysfs_attr_version.attr);
755                 subsystem_unregister(&ecryptfs_subsys);
756                 goto out;
757         }
758 out:
759         return rc;
760 }
761
762 static int __init ecryptfs_init(void)
763 {
764         int rc;
765
766         if (ECRYPTFS_DEFAULT_EXTENT_SIZE > PAGE_CACHE_SIZE) {
767                 rc = -EINVAL;
768                 ecryptfs_printk(KERN_ERR, "The eCryptfs extent size is "
769                                 "larger than the host's page size, and so "
770                                 "eCryptfs cannot run on this system. The "
771                                 "default eCryptfs extent size is [%d] bytes; "
772                                 "the page size is [%d] bytes.\n",
773                                 ECRYPTFS_DEFAULT_EXTENT_SIZE, PAGE_CACHE_SIZE);
774                 goto out;
775         }
776         rc = ecryptfs_init_kmem_caches();
777         if (rc) {
778                 printk(KERN_ERR
779                        "Failed to allocate one or more kmem_cache objects\n");
780                 goto out;
781         }
782         rc = register_filesystem(&ecryptfs_fs_type);
783         if (rc) {
784                 printk(KERN_ERR "Failed to register filesystem\n");
785                 ecryptfs_free_kmem_caches();
786                 goto out;
787         }
788         kset_set_kset_s(&ecryptfs_subsys, fs_subsys);
789         sysfs_attr_version.attr.owner = THIS_MODULE;
790         sysfs_attr_version_str.attr.owner = THIS_MODULE;
791         rc = do_sysfs_registration();
792         if (rc) {
793                 printk(KERN_ERR "sysfs registration failed\n");
794                 unregister_filesystem(&ecryptfs_fs_type);
795                 ecryptfs_free_kmem_caches();
796                 goto out;
797         }
798 out:
799         return rc;
800 }
801
802 static void __exit ecryptfs_exit(void)
803 {
804         sysfs_remove_file(&ecryptfs_subsys.kset.kobj,
805                           &sysfs_attr_version.attr);
806         sysfs_remove_file(&ecryptfs_subsys.kset.kobj,
807                           &sysfs_attr_version_str.attr);
808         subsystem_unregister(&ecryptfs_subsys);
809         unregister_filesystem(&ecryptfs_fs_type);
810         ecryptfs_free_kmem_caches();
811 }
812
813 MODULE_AUTHOR("Michael A. Halcrow <mhalcrow@us.ibm.com>");
814 MODULE_DESCRIPTION("eCryptfs");
815
816 MODULE_LICENSE("GPL");
817
818 module_init(ecryptfs_init)
819 module_exit(ecryptfs_exit)