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         struct crypto_tfm *tmp_tfm;
 212         int cipher_name_len;
 213
 214         if (!options) {
 215                 rc = -EINVAL;
 216                 goto out;
 217         }
 218         while ((p = strsep(&options, ",")) != NULL) {
 219                 if (!*p)
 220                         continue;
 221                 token = match_token(p, tokens, args);
 222                 switch (token) {
 223                 case ecryptfs_opt_sig:
 224                 case ecryptfs_opt_ecryptfs_sig:
 225                         sig_src = args[0].from;
 226                         sig_dst =
 227                                 mount_crypt_stat->global_auth_tok_sig;
 228                         memcpy(sig_dst, sig_src, ECRYPTFS_SIG_SIZE_HEX);
 229                         sig_dst[ECRYPTFS_SIG_SIZE_HEX] = '\0';
 230                         ecryptfs_printk(KERN_DEBUG,
 231                                         "The mount_crypt_stat "
 232                                         "global_auth_tok_sig set to: "
 233                                         "[%s]\n", sig_dst);
 234                         sig_set = 1;
 235                         break;
 236                 case ecryptfs_opt_debug:
 237                 case ecryptfs_opt_ecryptfs_debug:
 238                         debug_src = args[0].from;
 239                         ecryptfs_verbosity =
 240                                 (int)simple_strtol(debug_src, &debug_src,
 241                                                    0);
 242                         ecryptfs_printk(KERN_DEBUG,
 243                                         "Verbosity set to [%d]" "\n",
 244                                         ecryptfs_verbosity);
 245                         break;
 246                 case ecryptfs_opt_cipher:
 247                 case ecryptfs_opt_ecryptfs_cipher:
 248                         cipher_name_src = args[0].from;
 249                         cipher_name_dst =
 250                                 mount_crypt_stat->
 251                                 global_default_cipher_name;
 252                         strncpy(cipher_name_dst, cipher_name_src,
 253                                 ECRYPTFS_MAX_CIPHER_NAME_SIZE);
 254                         ecryptfs_printk(KERN_DEBUG,
 255                                         "The mount_crypt_stat "
 256                                         "global_default_cipher_name set to: "
 257                                         "[%s]\n", cipher_name_dst);
 258                         cipher_name_set = 1;
 259                         break;
 260                 case ecryptfs_opt_ecryptfs_key_bytes:
 261                         cipher_key_bytes_src = args[0].from;
 262                         cipher_key_bytes =
 263                                 (int)simple_strtol(cipher_key_bytes_src,
 264                                                    &cipher_key_bytes_src, 0);
 265                         mount_crypt_stat->global_default_cipher_key_size =
 266                                 cipher_key_bytes;
 267                         ecryptfs_printk(KERN_DEBUG,
 268                                         "The mount_crypt_stat "
 269                                         "global_default_cipher_key_size "
 270                                         "set to: [%d]\n", mount_crypt_stat->
 271                                         global_default_cipher_key_size);
 272                         cipher_key_bytes_set = 1;
 273                         break;
 274                 case ecryptfs_opt_passthrough:
 275                         mount_crypt_stat->flags |=
 276                                 ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED;
 277                         break;
 278                 case ecryptfs_opt_err:
 279                 default:
 280                         ecryptfs_printk(KERN_WARNING,
 281                                         "eCryptfs: unrecognized option '%s'\n",
 282                                         p);
 283                 }
 284         }
 285         /* Do not support lack of mount-wide signature in 0.1
 286          * release */
 287         if (!sig_set) {
 288                 rc = -EINVAL;
 289                 ecryptfs_printk(KERN_ERR, "You must supply a valid "
 290                                 "passphrase auth tok signature as a mount "
 291                                 "parameter; see the eCryptfs README\n");
 292                 goto out;
 293         }
 294         if (!cipher_name_set) {
 295                 cipher_name_len = strlen(ECRYPTFS_DEFAULT_CIPHER);
 296                 if (unlikely(cipher_name_len
 297                              >= ECRYPTFS_MAX_CIPHER_NAME_SIZE)) {
 298                         rc = -EINVAL;
 299                         BUG();
 300                         goto out;
 301                 }
 302                 memcpy(mount_crypt_stat->global_default_cipher_name,
 303                        ECRYPTFS_DEFAULT_CIPHER, cipher_name_len);
 304                 mount_crypt_stat->global_default_cipher_name[cipher_name_len]
 305                     = '\0';
 306         }
 307         if (!cipher_key_bytes_set) {
 308                 mount_crypt_stat->global_default_cipher_key_size =
 309                         ECRYPTFS_DEFAULT_KEY_BYTES;
 310                 ecryptfs_printk(KERN_DEBUG, "Cipher key size was not "
 311                                 "specified.  Defaulting to [%d]\n",
 312                                 mount_crypt_stat->
 313                                 global_default_cipher_key_size);
 314         }
 315         rc = ecryptfs_process_cipher(
 316                 &tmp_tfm,
 317                 &mount_crypt_stat->global_key_tfm,
 318                 mount_crypt_stat->global_default_cipher_name,
 319                 mount_crypt_stat->global_default_cipher_key_size);
 320         if (tmp_tfm)
 321                 crypto_free_tfm(tmp_tfm);
 322         if (rc) {
 323                 printk(KERN_ERR "Error attempting to initialize cipher [%s] "
 324                        "with key size [%Zd] bytes; rc = [%d]\n",
 325                        mount_crypt_stat->global_default_cipher_name,
 326                        mount_crypt_stat->global_default_cipher_key_size, rc);
 327                 rc = -EINVAL;
 328                 goto out;
 329         }
 330         mutex_init(&mount_crypt_stat->global_key_tfm_mutex);
 331         ecryptfs_printk(KERN_DEBUG, "Requesting the key with description: "
 332                         "[%s]\n", mount_crypt_stat->global_auth_tok_sig);
 333         /* The reference to this key is held until umount is done The
 334          * call to key_put is done in ecryptfs_put_super() */
 335         auth_tok_key = request_key(&key_type_user,
 336                                    mount_crypt_stat->global_auth_tok_sig,
 337                                    NULL);
 338         if (!auth_tok_key || IS_ERR(auth_tok_key)) {
 339                 ecryptfs_printk(KERN_ERR, "Could not find key with "
 340                                 "description: [%s]\n",
 341                                 mount_crypt_stat->global_auth_tok_sig);
 342                 process_request_key_err(PTR_ERR(auth_tok_key));
 343                 rc = -EINVAL;
 344                 goto out;
 345         }
 346         auth_tok = ecryptfs_get_key_payload_data(auth_tok_key);
 347         if (ecryptfs_verify_version(auth_tok->version)) {
 348                 ecryptfs_printk(KERN_ERR, "Data structure version mismatch. "
 349                                 "Userspace tools must match eCryptfs kernel "
 350                                 "module with major version [%d] and minor "
 351                                 "version [%d]\n", ECRYPTFS_VERSION_MAJOR,
 352                                 ECRYPTFS_VERSION_MINOR);
 353                 rc = -EINVAL;
 354                 goto out;
 355         }
 356         if (auth_tok->token_type != ECRYPTFS_PASSWORD) {
 357                 ecryptfs_printk(KERN_ERR, "Invalid auth_tok structure "
 358                                 "returned from key\n");
 359                 rc = -EINVAL;
 360                 goto out;
 361         }
 362         mount_crypt_stat->global_auth_tok_key = auth_tok_key;
 363         mount_crypt_stat->global_auth_tok = auth_tok;
 364 out:
 365         return rc;
 366 }
 367
 368 struct kmem_cache *ecryptfs_sb_info_cache;
 369
 370 /**
 371  * ecryptfs_fill_super
 372  * @sb: The ecryptfs super block
 373  * @raw_data: The options passed to mount
 374  * @silent: Not used but required by function prototype
 375  *
 376  * Sets up what we can of the sb, rest is done in ecryptfs_read_super
 377  *
 378  * Returns zero on success; non-zero otherwise
 379  */
 380 static int
 381 ecryptfs_fill_super(struct super_block *sb, void *raw_data, int silent)
 382 {
 383         int rc = 0;
 384
 385         /* Released in ecryptfs_put_super() */
 386         ecryptfs_set_superblock_private(sb,
 387                                         kmem_cache_alloc(ecryptfs_sb_info_cache,
 388                                                          SLAB_KERNEL));
 389         if (!ecryptfs_superblock_to_private(sb)) {
 390                 ecryptfs_printk(KERN_WARNING, "Out of memory\n");
 391                 rc = -ENOMEM;
 392                 goto out;
 393         }
 394         memset(ecryptfs_superblock_to_private(sb), 0,
 395                sizeof(struct ecryptfs_sb_info));
 396         sb->s_op = &ecryptfs_sops;
 397         /* Released through deactivate_super(sb) from get_sb_nodev */
 398         sb->s_root = d_alloc(NULL, &(const struct qstr) {
 399                              .hash = 0,.name = "/",.len = 1});
 400         if (!sb->s_root) {
 401                 ecryptfs_printk(KERN_ERR, "d_alloc failed\n");
 402                 rc = -ENOMEM;
 403                 goto out;
 404         }
 405         sb->s_root->d_op = &ecryptfs_dops;
 406         sb->s_root->d_sb = sb;
 407         sb->s_root->d_parent = sb->s_root;
 408         /* Released in d_release when dput(sb->s_root) is called */
 409         /* through deactivate_super(sb) from get_sb_nodev() */
 410         ecryptfs_set_dentry_private(sb->s_root,
 411                                     kmem_cache_alloc(ecryptfs_dentry_info_cache,
 412                                                      SLAB_KERNEL));
 413         if (!ecryptfs_dentry_to_private(sb->s_root)) {
 414                 ecryptfs_printk(KERN_ERR,
 415                                 "dentry_info_cache alloc failed\n");
 416                 rc = -ENOMEM;
 417                 goto out;
 418         }
 419         memset(ecryptfs_dentry_to_private(sb->s_root), 0,
 420                sizeof(struct ecryptfs_dentry_info));
 421         rc = 0;
 422 out:
 423         /* Should be able to rely on deactivate_super called from
 424          * get_sb_nodev */
 425         return rc;
 426 }
 427
 428 /**
 429  * ecryptfs_read_super
 430  * @sb: The ecryptfs super block
 431  * @dev_name: The path to mount over
 432  *
 433  * Read the super block of the lower filesystem, and use
 434  * ecryptfs_interpose to create our initial inode and super block
 435  * struct.
 436  */
 437 static int ecryptfs_read_super(struct super_block *sb, const char *dev_name)
 438 {
 439         int rc;
 440         struct nameidata nd;
 441         struct dentry *lower_root;
 442         struct vfsmount *lower_mnt;
 443
 444         memset(&nd, 0, sizeof(struct nameidata));
 445         rc = path_lookup(dev_name, LOOKUP_FOLLOW, &nd);
 446         if (rc) {
 447                 ecryptfs_printk(KERN_WARNING, "path_lookup() failed\n");
 448                 goto out_free;
 449         }
 450         lower_root = nd.dentry;
 451         if (!lower_root->d_inode) {
 452                 ecryptfs_printk(KERN_WARNING,
 453                                 "No directory to interpose on\n");
 454                 rc = -ENOENT;
 455                 goto out_free;
 456         }
 457         lower_mnt = nd.mnt;
 458         ecryptfs_set_superblock_lower(sb, lower_root->d_sb);
 459         sb->s_maxbytes = lower_root->d_sb->s_maxbytes;
 460         ecryptfs_set_dentry_lower(sb->s_root, lower_root);
 461         ecryptfs_set_dentry_lower_mnt(sb->s_root, lower_mnt);
 462         if ((rc = ecryptfs_interpose(lower_root, sb->s_root, sb, 0)))
 463                 goto out_free;
 464         rc = 0;
 465         goto out;
 466 out_free:
 467         path_release(&nd);
 468 out:
 469         return rc;
 470 }
 471
 472 /**
 473  * ecryptfs_get_sb
 474  * @fs_type
 475  * @flags
 476  * @dev_name: The path to mount over
 477  * @raw_data: The options passed into the kernel
 478  *
 479  * The whole ecryptfs_get_sb process is broken into 4 functions:
 480  * ecryptfs_parse_options(): handle options passed to ecryptfs, if any
 481  * ecryptfs_fill_super(): used by get_sb_nodev, fills out the super_block
 482  *                        with as much information as it can before needing
 483  *                        the lower filesystem.
 484  * ecryptfs_read_super(): this accesses the lower filesystem and uses
 485  *                        ecryptfs_interpolate to perform most of the linking
 486  * ecryptfs_interpolate(): links the lower filesystem into ecryptfs
 487  */
 488 static int ecryptfs_get_sb(struct file_system_type *fs_type, int flags,
 489                         const char *dev_name, void *raw_data,
 490                         struct vfsmount *mnt)
 491 {
 492         int rc;
 493         struct super_block *sb;
 494
 495         rc = get_sb_nodev(fs_type, flags, raw_data, ecryptfs_fill_super, mnt);
 496         if (rc < 0) {
 497                 printk(KERN_ERR "Getting sb failed; rc = [%d]\n", rc);
 498                 goto out;
 499         }
 500         sb = mnt->mnt_sb;
 501         rc = ecryptfs_parse_options(sb, raw_data);
 502         if (rc) {
 503                 printk(KERN_ERR "Error parsing options; rc = [%d]\n", rc);
 504                 goto out_abort;
 505         }
 506         rc = ecryptfs_read_super(sb, dev_name);
 507         if (rc) {
 508                 printk(KERN_ERR "Reading sb failed; rc = [%d]\n", rc);
 509                 goto out_abort;
 510         }
 511         goto out;
 512 out_abort:
 513         dput(sb->s_root);
 514         up_write(&sb->s_umount);
 515         deactivate_super(sb);
 516 out:
 517         return rc;
 518 }
 519
 520 /**
 521  * ecryptfs_kill_block_super
 522  * @sb: The ecryptfs super block
 523  *
 524  * Used to bring the superblock down and free the private data.
 525  * Private data is free'd in ecryptfs_put_super()
 526  */
 527 static void ecryptfs_kill_block_super(struct super_block *sb)
 528 {
 529         generic_shutdown_super(sb);
 530 }
 531
 532 static struct file_system_type ecryptfs_fs_type = {
 533         .owner = THIS_MODULE,
 534         .name = "ecryptfs",
 535         .get_sb = ecryptfs_get_sb,
 536         .kill_sb = ecryptfs_kill_block_super,
 537         .fs_flags = 0
 538 };
 539
 540 /**
 541  * inode_info_init_once
 542  *
 543  * Initializes the ecryptfs_inode_info_cache when it is created
 544  */
 545 static void
 546 inode_info_init_once(void *vptr, struct kmem_cache *cachep, unsigned long flags)
 547 {
 548         struct ecryptfs_inode_info *ei = (struct ecryptfs_inode_info *)vptr;
 549
 550         if ((flags & (SLAB_CTOR_VERIFY | SLAB_CTOR_CONSTRUCTOR)) ==
 551             SLAB_CTOR_CONSTRUCTOR)
 552                 inode_init_once(&ei->vfs_inode);
 553 }
 554
 555 static struct ecryptfs_cache_info {
 556         kmem_cache_t **cache;
 557         const char *name;
 558         size_t size;
 559         void (*ctor)(void*, struct kmem_cache *, unsigned long);
 560 } ecryptfs_cache_infos[] = {
 561         {
 562                 .cache = &ecryptfs_auth_tok_list_item_cache,
 563                 .name = "ecryptfs_auth_tok_list_item",
 564                 .size = sizeof(struct ecryptfs_auth_tok_list_item),
 565         },
 566         {
 567                 .cache = &ecryptfs_file_info_cache,
 568                 .name = "ecryptfs_file_cache",
 569                 .size = sizeof(struct ecryptfs_file_info),
 570         },
 571         {
 572                 .cache = &ecryptfs_dentry_info_cache,
 573                 .name = "ecryptfs_dentry_info_cache",
 574                 .size = sizeof(struct ecryptfs_dentry_info),
 575         },
 576         {
 577                 .cache = &ecryptfs_inode_info_cache,
 578                 .name = "ecryptfs_inode_cache",
 579                 .size = sizeof(struct ecryptfs_inode_info),
 580                 .ctor = inode_info_init_once,
 581         },
 582         {
 583                 .cache = &ecryptfs_sb_info_cache,
 584                 .name = "ecryptfs_sb_cache",
 585                 .size = sizeof(struct ecryptfs_sb_info),
 586         },
 587         {
 588                 .cache = &ecryptfs_header_cache_0,
 589                 .name = "ecryptfs_headers_0",
 590                 .size = PAGE_CACHE_SIZE,
 591         },
 592         {
 593                 .cache = &ecryptfs_header_cache_1,
 594                 .name = "ecryptfs_headers_1",
 595                 .size = PAGE_CACHE_SIZE,
 596         },
 597         {
 598                 .cache = &ecryptfs_header_cache_2,
 599                 .name = "ecryptfs_headers_2",
 600                 .size = PAGE_CACHE_SIZE,
 601         },
 602         {
 603                 .cache = &ecryptfs_lower_page_cache,
 604                 .name = "ecryptfs_lower_page_cache",
 605                 .size = PAGE_CACHE_SIZE,
 606         },
 607 };
 608
 609 static void ecryptfs_free_kmem_caches(void)
 610 {
 611         int i;
 612
 613         for (i = 0; i < ARRAY_SIZE(ecryptfs_cache_infos); i++) {
 614                 struct ecryptfs_cache_info *info;
 615
 616                 info = &ecryptfs_cache_infos[i];
 617                 if (*(info->cache))
 618                         kmem_cache_destroy(*(info->cache));
 619         }
 620 }
 621
 622 /**
 623  * ecryptfs_init_kmem_caches
 624  *
 625  * Returns zero on success; non-zero otherwise
 626  */
 627 static int ecryptfs_init_kmem_caches(void)
 628 {
 629         int i;
 630
 631         for (i = 0; i < ARRAY_SIZE(ecryptfs_cache_infos); i++) {
 632                 struct ecryptfs_cache_info *info;
 633
 634                 info = &ecryptfs_cache_infos[i];
 635                 *(info->cache) = kmem_cache_create(info->name, info->size,
 636                                 0, SLAB_HWCACHE_ALIGN, info->ctor, NULL);
 637                 if (!*(info->cache)) {
 638                         ecryptfs_free_kmem_caches();
 639                         ecryptfs_printk(KERN_WARNING, "%s: "
 640                                         "kmem_cache_create failed\n",
 641                                         info->name);
 642                         return -ENOMEM;
 643                 }
 644         }
 645         return 0;
 646 }
 647
 648 struct ecryptfs_obj {
 649         char *name;
 650         struct list_head slot_list;
 651         struct kobject kobj;
 652 };
 653
 654 struct ecryptfs_attribute {
 655         struct attribute attr;
 656         ssize_t(*show) (struct ecryptfs_obj *, char *);
 657         ssize_t(*store) (struct ecryptfs_obj *, const char *, size_t);
 658 };
 659
 660 static ssize_t
 661 ecryptfs_attr_store(struct kobject *kobj,
 662                     struct attribute *attr, const char *buf, size_t len)
 663 {
 664         struct ecryptfs_obj *obj = container_of(kobj, struct ecryptfs_obj,
 665                                                 kobj);
 666         struct ecryptfs_attribute *attribute =
 667                 container_of(attr, struct ecryptfs_attribute, attr);
 668
 669         return (attribute->store ? attribute->store(obj, buf, len) : 0);
 670 }
 671
 672 static ssize_t
 673 ecryptfs_attr_show(struct kobject *kobj, struct attribute *attr, char *buf)
 674 {
 675         struct ecryptfs_obj *obj = container_of(kobj, struct ecryptfs_obj,
 676                                                 kobj);
 677         struct ecryptfs_attribute *attribute =
 678                 container_of(attr, struct ecryptfs_attribute, attr);
 679
 680         return (attribute->show ? attribute->show(obj, buf) : 0);
 681 }
 682
 683 static struct sysfs_ops ecryptfs_sysfs_ops = {
 684         .show = ecryptfs_attr_show,
 685         .store = ecryptfs_attr_store
 686 };
 687
 688 static struct kobj_type ecryptfs_ktype = {
 689         .sysfs_ops = &ecryptfs_sysfs_ops
 690 };
 691
 692 static decl_subsys(ecryptfs, &ecryptfs_ktype, NULL);
 693
 694 static ssize_t version_show(struct ecryptfs_obj *obj, char *buff)
 695 {
 696         return snprintf(buff, PAGE_SIZE, "%d\n", ECRYPTFS_VERSIONING_MASK);
 697 }
 698
 699 static struct ecryptfs_attribute sysfs_attr_version = __ATTR_RO(version);
 700
 701 struct ecryptfs_version_str_map_elem {
 702         u32 flag;
 703         char *str;
 704 } ecryptfs_version_str_map[] = {
 705         {ECRYPTFS_VERSIONING_PASSPHRASE, "passphrase"},
 706         {ECRYPTFS_VERSIONING_PUBKEY, "pubkey"},
 707         {ECRYPTFS_VERSIONING_PLAINTEXT_PASSTHROUGH, "plaintext passthrough"},
 708         {ECRYPTFS_VERSIONING_POLICY, "policy"}
 709 };
 710
 711 static ssize_t version_str_show(struct ecryptfs_obj *obj, char *buff)
 712 {
 713         int i;
 714         int remaining = PAGE_SIZE;
 715         int total_written = 0;
 716
 717         buff[0] = '\0';
 718         for (i = 0; i < ARRAY_SIZE(ecryptfs_version_str_map); i++) {
 719                 int entry_size;
 720
 721                 if (!(ECRYPTFS_VERSIONING_MASK
 722                       & ecryptfs_version_str_map[i].flag))
 723                         continue;
 724                 entry_size = strlen(ecryptfs_version_str_map[i].str);
 725                 if ((entry_size + 2) > remaining)
 726                         goto out;
 727                 memcpy(buff, ecryptfs_version_str_map[i].str, entry_size);
 728                 buff[entry_size++] = '\n';
 729                 buff[entry_size] = '\0';
 730                 buff += entry_size;
 731                 total_written += entry_size;
 732                 remaining -= entry_size;
 733         }
 734 out:
 735         return total_written;
 736 }
 737
 738 static struct ecryptfs_attribute sysfs_attr_version_str = __ATTR_RO(version_str);
 739
 740 static int do_sysfs_registration(void)
 741 {
 742         int rc;
 743
 744         if ((rc = subsystem_register(&ecryptfs_subsys))) {
 745                 printk(KERN_ERR
 746                        "Unable to register ecryptfs sysfs subsystem\n");
 747                 goto out;
 748         }
 749         rc = sysfs_create_file(&ecryptfs_subsys.kset.kobj,
 750                                &sysfs_attr_version.attr);
 751         if (rc) {
 752                 printk(KERN_ERR
 753                        "Unable to create ecryptfs version attribute\n");
 754                 subsystem_unregister(&ecryptfs_subsys);
 755                 goto out;
 756         }
 757         rc = sysfs_create_file(&ecryptfs_subsys.kset.kobj,
 758                                &sysfs_attr_version_str.attr);
 759         if (rc) {
 760                 printk(KERN_ERR
 761                        "Unable to create ecryptfs version_str attribute\n");
 762                 sysfs_remove_file(&ecryptfs_subsys.kset.kobj,
 763                                   &sysfs_attr_version.attr);
 764                 subsystem_unregister(&ecryptfs_subsys);
 765                 goto out;
 766         }
 767 out:
 768         return rc;
 769 }
 770
 771 static int __init ecryptfs_init(void)
 772 {
 773         int rc;
 774
 775         if (ECRYPTFS_DEFAULT_EXTENT_SIZE > PAGE_CACHE_SIZE) {
 776                 rc = -EINVAL;
 777                 ecryptfs_printk(KERN_ERR, "The eCryptfs extent size is "
 778                                 "larger than the host's page size, and so "
 779                                 "eCryptfs cannot run on this system. The "
 780                                 "default eCryptfs extent size is [%d] bytes; "
 781                                 "the page size is [%d] bytes.\n",
 782                                 ECRYPTFS_DEFAULT_EXTENT_SIZE, PAGE_CACHE_SIZE);
 783                 goto out;
 784         }
 785         rc = ecryptfs_init_kmem_caches();
 786         if (rc) {
 787                 printk(KERN_ERR
 788                        "Failed to allocate one or more kmem_cache objects\n");
 789                 goto out;
 790         }
 791         rc = register_filesystem(&ecryptfs_fs_type);
 792         if (rc) {
 793                 printk(KERN_ERR "Failed to register filesystem\n");
 794                 ecryptfs_free_kmem_caches();
 795                 goto out;
 796         }
 797         kset_set_kset_s(&ecryptfs_subsys, fs_subsys);
 798         sysfs_attr_version.attr.owner = THIS_MODULE;
 799         sysfs_attr_version_str.attr.owner = THIS_MODULE;
 800         rc = do_sysfs_registration();
 801         if (rc) {
 802                 printk(KERN_ERR "sysfs registration failed\n");
 803                 unregister_filesystem(&ecryptfs_fs_type);
 804                 ecryptfs_free_kmem_caches();
 805                 goto out;
 806         }
 807 out:
 808         return rc;
 809 }
 810
 811 static void __exit ecryptfs_exit(void)
 812 {
 813         sysfs_remove_file(&ecryptfs_subsys.kset.kobj,
 814                           &sysfs_attr_version.attr);
 815         sysfs_remove_file(&ecryptfs_subsys.kset.kobj,
 816                           &sysfs_attr_version_str.attr);
 817         subsystem_unregister(&ecryptfs_subsys);
 818         unregister_filesystem(&ecryptfs_fs_type);
 819         ecryptfs_free_kmem_caches();
 820 }
 821
 822 MODULE_AUTHOR("Michael A. Halcrow <mhalcrow@us.ibm.com>");
 823 MODULE_DESCRIPTION("eCryptfs");
 824
 825 MODULE_LICENSE("GPL");
 826
 827 module_init(ecryptfs_init)
 828 module_exit(ecryptfs_exit)