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