fs/ecryptfs/ecryptfs_kernel.h

   1 /**
   2  * eCryptfs: Linux filesystem encryption layer
   3  * Kernel declarations.
   4  *
   5  * Copyright (C) 1997-2003 Erez Zadok
   6  * Copyright (C) 2001-2003 Stony Brook University
   7  * Copyright (C) 2004-2008 International Business Machines Corp.
   8  *   Author(s): Michael A. Halcrow <mahalcro@us.ibm.com>
   9  *              Trevor S. Highland <trevor.highland@gmail.com>
  10  *              Tyler Hicks <tyhicks@ou.edu>
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License as
  14  * published by the Free Software Foundation; either version 2 of the
  15  * License, or (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful, but
  18  * WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  25  * 02111-1307, USA.
  26  */
  27
  28 #ifndef ECRYPTFS_KERNEL_H
  29 #define ECRYPTFS_KERNEL_H
  30
  31 #include <keys/user-type.h>
  32 #include <keys/encrypted-type.h>
  33 #include <linux/fs.h>
  34 #include <linux/fs_stack.h>
  35 #include <linux/namei.h>
  36 #include <linux/scatterlist.h>
  37 #include <linux/hash.h>
  38 #include <linux/nsproxy.h>
  39 #include <linux/backing-dev.h>
  40 #include <linux/ecryptfs.h>
  41 #include <linux/crypto.h>
  42
  43 #define ECRYPTFS_DEFAULT_IV_BYTES 16
  44 #define ECRYPTFS_DEFAULT_EXTENT_SIZE 4096
  45 #define ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE 8192
  46 #define ECRYPTFS_DEFAULT_MSG_CTX_ELEMS 32
  47 #define ECRYPTFS_DEFAULT_SEND_TIMEOUT HZ
  48 #define ECRYPTFS_MAX_MSG_CTX_TTL (HZ*3)
  49 #define ECRYPTFS_DEFAULT_NUM_USERS 4
  50 #define ECRYPTFS_MAX_NUM_USERS 32768
  51 #define ECRYPTFS_XATTR_NAME "user.ecryptfs"
  52
  53 void ecryptfs_dump_auth_tok(struct ecryptfs_auth_tok *auth_tok);
  54 extern void ecryptfs_to_hex(char *dst, char *src, size_t src_size);
  55 extern void ecryptfs_from_hex(char *dst, char *src, int dst_size);
  56
  57 struct ecryptfs_key_record {
  58         unsigned char type;
  59         size_t enc_key_size;
  60         unsigned char sig[ECRYPTFS_SIG_SIZE];
  61         unsigned char enc_key[ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES];
  62 };
  63
  64 struct ecryptfs_auth_tok_list {
  65         struct ecryptfs_auth_tok *auth_tok;
  66         struct list_head list;
  67 };
  68
  69 struct ecryptfs_crypt_stat;
  70 struct ecryptfs_mount_crypt_stat;
  71
  72 struct ecryptfs_page_crypt_context {
  73         struct page *page;
  74 #define ECRYPTFS_PREPARE_COMMIT_MODE 0
  75 #define ECRYPTFS_WRITEPAGE_MODE      1
  76         unsigned int mode;
  77         union {
  78                 struct file *lower_file;
  79                 struct writeback_control *wbc;
  80         } param;
  81 };
  82
  83 #if defined(CONFIG_ENCRYPTED_KEYS) || defined(CONFIG_ENCRYPTED_KEYS_MODULE)
  84 static inline struct ecryptfs_auth_tok *
  85 ecryptfs_get_encrypted_key_payload_data(struct key *key)
  86 {
  87         struct encrypted_key_payload *payload;
  88
  89         if (key->type != &key_type_encrypted)
  90                 return NULL;
  91
  92         payload = key->payload.data[0];
  93         if (!payload)
  94                 return ERR_PTR(-EKEYREVOKED);
  95
  96         return (struct ecryptfs_auth_tok *)payload->payload_data;
  97 }
  98
  99 static inline struct key *ecryptfs_get_encrypted_key(char *sig)
 100 {
 101         return request_key(&key_type_encrypted, sig, NULL);
 102 }
 103
 104 #else
 105 static inline struct ecryptfs_auth_tok *
 106 ecryptfs_get_encrypted_key_payload_data(struct key *key)
 107 {
 108         return NULL;
 109 }
 110
 111 static inline struct key *ecryptfs_get_encrypted_key(char *sig)
 112 {
 113         return ERR_PTR(-ENOKEY);
 114 }
 115
 116 #endif /* CONFIG_ENCRYPTED_KEYS */
 117
 118 static inline struct ecryptfs_auth_tok *
 119 ecryptfs_get_key_payload_data(struct key *key)
 120 {
 121         struct ecryptfs_auth_tok *auth_tok;
 122         const struct user_key_payload *ukp;
 123
 124         auth_tok = ecryptfs_get_encrypted_key_payload_data(key);
 125         if (auth_tok)
 126                 return auth_tok;
 127
 128         ukp = user_key_payload(key);
 129         if (!ukp)
 130                 return ERR_PTR(-EKEYREVOKED);
 131
 132         return (struct ecryptfs_auth_tok *)ukp->data;
 133 }
 134
 135 #define ECRYPTFS_MAX_KEYSET_SIZE 1024
 136 #define ECRYPTFS_MAX_CIPHER_NAME_SIZE 31
 137 #define ECRYPTFS_MAX_NUM_ENC_KEYS 64
 138 #define ECRYPTFS_MAX_IV_BYTES 16        /* 128 bits */
 139 #define ECRYPTFS_SALT_BYTES 2
 140 #define MAGIC_ECRYPTFS_MARKER 0x3c81b7f5
 141 #define MAGIC_ECRYPTFS_MARKER_SIZE_BYTES 8      /* 4*2 */
 142 #define ECRYPTFS_FILE_SIZE_BYTES (sizeof(u64))
 143 #define ECRYPTFS_SIZE_AND_MARKER_BYTES (ECRYPTFS_FILE_SIZE_BYTES \
 144                                         + MAGIC_ECRYPTFS_MARKER_SIZE_BYTES)
 145 #define ECRYPTFS_DEFAULT_CIPHER "aes"
 146 #define ECRYPTFS_DEFAULT_KEY_BYTES 16
 147 #define ECRYPTFS_DEFAULT_HASH "md5"
 148 #define ECRYPTFS_TAG_70_DIGEST ECRYPTFS_DEFAULT_HASH
 149 #define ECRYPTFS_TAG_1_PACKET_TYPE 0x01
 150 #define ECRYPTFS_TAG_3_PACKET_TYPE 0x8C
 151 #define ECRYPTFS_TAG_11_PACKET_TYPE 0xED
 152 #define ECRYPTFS_TAG_64_PACKET_TYPE 0x40
 153 #define ECRYPTFS_TAG_65_PACKET_TYPE 0x41
 154 #define ECRYPTFS_TAG_66_PACKET_TYPE 0x42
 155 #define ECRYPTFS_TAG_67_PACKET_TYPE 0x43
 156 #define ECRYPTFS_TAG_70_PACKET_TYPE 0x46 /* FNEK-encrypted filename
 157                                           * as dentry name */
 158 #define ECRYPTFS_TAG_71_PACKET_TYPE 0x47 /* FNEK-encrypted filename in
 159                                           * metadata */
 160 #define ECRYPTFS_TAG_72_PACKET_TYPE 0x48 /* FEK-encrypted filename as
 161                                           * dentry name */
 162 #define ECRYPTFS_TAG_73_PACKET_TYPE 0x49 /* FEK-encrypted filename as
 163                                           * metadata */
 164 #define ECRYPTFS_MIN_PKT_LEN_SIZE 1 /* Min size to specify packet length */
 165 #define ECRYPTFS_MAX_PKT_LEN_SIZE 2 /* Pass at least this many bytes to
 166                                      * ecryptfs_parse_packet_length() and
 167                                      * ecryptfs_write_packet_length()
 168                                      */
 169 /* Constraint: ECRYPTFS_FILENAME_MIN_RANDOM_PREPEND_BYTES >=
 170  * ECRYPTFS_MAX_IV_BYTES */
 171 #define ECRYPTFS_FILENAME_MIN_RANDOM_PREPEND_BYTES 16
 172 #define ECRYPTFS_NON_NULL 0x42 /* A reasonable substitute for NULL */
 173 #define MD5_DIGEST_SIZE 16
 174 #define ECRYPTFS_TAG_70_DIGEST_SIZE MD5_DIGEST_SIZE
 175 #define ECRYPTFS_TAG_70_MIN_METADATA_SIZE (1 + ECRYPTFS_MIN_PKT_LEN_SIZE \
 176                                            + ECRYPTFS_SIG_SIZE + 1 + 1)
 177 #define ECRYPTFS_TAG_70_MAX_METADATA_SIZE (1 + ECRYPTFS_MAX_PKT_LEN_SIZE \
 178                                            + ECRYPTFS_SIG_SIZE + 1 + 1)
 179 #define ECRYPTFS_FEK_ENCRYPTED_FILENAME_PREFIX "ECRYPTFS_FEK_ENCRYPTED."
 180 #define ECRYPTFS_FEK_ENCRYPTED_FILENAME_PREFIX_SIZE 23
 181 #define ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX "ECRYPTFS_FNEK_ENCRYPTED."
 182 #define ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX_SIZE 24
 183 #define ECRYPTFS_ENCRYPTED_DENTRY_NAME_LEN (18 + 1 + 4 + 1 + 32)
 184
 185 #ifdef CONFIG_ECRYPT_FS_MESSAGING
 186 # define ECRYPTFS_VERSIONING_MASK_MESSAGING (ECRYPTFS_VERSIONING_DEVMISC \
 187                                              | ECRYPTFS_VERSIONING_PUBKEY)
 188 #else
 189 # define ECRYPTFS_VERSIONING_MASK_MESSAGING 0
 190 #endif
 191
 192 #define ECRYPTFS_VERSIONING_MASK (ECRYPTFS_VERSIONING_PASSPHRASE \
 193                                   | ECRYPTFS_VERSIONING_PLAINTEXT_PASSTHROUGH \
 194                                   | ECRYPTFS_VERSIONING_XATTR \
 195                                   | ECRYPTFS_VERSIONING_MULTKEY \
 196                                   | ECRYPTFS_VERSIONING_MASK_MESSAGING \
 197                                   | ECRYPTFS_VERSIONING_FILENAME_ENCRYPTION)
 198 struct ecryptfs_key_sig {
 199         struct list_head crypt_stat_list;
 200         char keysig[ECRYPTFS_SIG_SIZE_HEX + 1];
 201 };
 202
 203 struct ecryptfs_filename {
 204         struct list_head crypt_stat_list;
 205 #define ECRYPTFS_FILENAME_CONTAINS_DECRYPTED 0x00000001
 206         u32 flags;
 207         u32 seq_no;
 208         char *filename;
 209         char *encrypted_filename;
 210         size_t filename_size;
 211         size_t encrypted_filename_size;
 212         char fnek_sig[ECRYPTFS_SIG_SIZE_HEX];
 213         char dentry_name[ECRYPTFS_ENCRYPTED_DENTRY_NAME_LEN + 1];
 214 };
 215
 216 /**
 217  * This is the primary struct associated with each encrypted file.
 218  *
 219  * TODO: cache align/pack?
 220  */
 221 struct ecryptfs_crypt_stat {
 222 #define ECRYPTFS_STRUCT_INITIALIZED   0x00000001
 223 #define ECRYPTFS_POLICY_APPLIED       0x00000002
 224 #define ECRYPTFS_ENCRYPTED            0x00000004
 225 #define ECRYPTFS_SECURITY_WARNING     0x00000008
 226 #define ECRYPTFS_ENABLE_HMAC          0x00000010
 227 #define ECRYPTFS_ENCRYPT_IV_PAGES     0x00000020
 228 #define ECRYPTFS_KEY_VALID            0x00000040
 229 #define ECRYPTFS_METADATA_IN_XATTR    0x00000080
 230 #define ECRYPTFS_VIEW_AS_ENCRYPTED    0x00000100
 231 #define ECRYPTFS_KEY_SET              0x00000200
 232 #define ECRYPTFS_ENCRYPT_FILENAMES    0x00000400
 233 #define ECRYPTFS_ENCFN_USE_MOUNT_FNEK 0x00000800
 234 #define ECRYPTFS_ENCFN_USE_FEK        0x00001000
 235 #define ECRYPTFS_UNLINK_SIGS          0x00002000
 236 #define ECRYPTFS_I_SIZE_INITIALIZED   0x00004000
 237         u32 flags;
 238         unsigned int file_version;
 239         size_t iv_bytes;
 240         size_t metadata_size;
 241         size_t extent_size; /* Data extent size; default is 4096 */
 242         size_t key_size;
 243         size_t extent_shift;
 244         unsigned int extent_mask;
 245         struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
 246         struct crypto_ablkcipher *tfm;
 247         struct crypto_hash *hash_tfm; /* Crypto context for generating
 248                                        * the initialization vectors */
 249         unsigned char cipher[ECRYPTFS_MAX_CIPHER_NAME_SIZE + 1];
 250         unsigned char key[ECRYPTFS_MAX_KEY_BYTES];
 251         unsigned char root_iv[ECRYPTFS_MAX_IV_BYTES];
 252         struct list_head keysig_list;
 253         struct mutex keysig_list_mutex;
 254         struct mutex cs_tfm_mutex;
 255         struct mutex cs_hash_tfm_mutex;
 256         struct mutex cs_mutex;
 257 };
 258
 259 /* inode private data. */
 260 struct ecryptfs_inode_info {
 261         struct inode vfs_inode;
 262         struct inode *wii_inode;
 263         struct mutex lower_file_mutex;
 264         atomic_t lower_file_count;
 265         struct file *lower_file;
 266         struct ecryptfs_crypt_stat crypt_stat;
 267 };
 268
 269 /* dentry private data. Each dentry must keep track of a lower
 270  * vfsmount too. */
 271 struct ecryptfs_dentry_info {
 272         struct path lower_path;
 273         union {
 274                 struct ecryptfs_crypt_stat *crypt_stat;
 275                 struct rcu_head rcu;
 276         };
 277 };
 278
 279 /**
 280  * ecryptfs_global_auth_tok - A key used to encrypt all new files under the mountpoint
 281  * @flags: Status flags
 282  * @mount_crypt_stat_list: These auth_toks hang off the mount-wide
 283  *                         cryptographic context. Every time a new
 284  *                         inode comes into existence, eCryptfs copies
 285  *                         the auth_toks on that list to the set of
 286  *                         auth_toks on the inode's crypt_stat
 287  * @global_auth_tok_key: The key from the user's keyring for the sig
 288  * @global_auth_tok: The key contents
 289  * @sig: The key identifier
 290  *
 291  * ecryptfs_global_auth_tok structs refer to authentication token keys
 292  * in the user keyring that apply to newly created files. A list of
 293  * these objects hangs off of the mount_crypt_stat struct for any
 294  * given eCryptfs mount. This struct maintains a reference to both the
 295  * key contents and the key itself so that the key can be put on
 296  * unmount.
 297  */
 298 struct ecryptfs_global_auth_tok {
 299 #define ECRYPTFS_AUTH_TOK_INVALID 0x00000001
 300 #define ECRYPTFS_AUTH_TOK_FNEK    0x00000002
 301         u32 flags;
 302         struct list_head mount_crypt_stat_list;
 303         struct key *global_auth_tok_key;
 304         unsigned char sig[ECRYPTFS_SIG_SIZE_HEX + 1];
 305 };
 306
 307 /**
 308  * ecryptfs_key_tfm - Persistent key tfm
 309  * @key_tfm: crypto API handle to the key
 310  * @key_size: Key size in bytes
 311  * @key_tfm_mutex: Mutex to ensure only one operation in eCryptfs is
 312  *                 using the persistent TFM at any point in time
 313  * @key_tfm_list: Handle to hang this off the module-wide TFM list
 314  * @cipher_name: String name for the cipher for this TFM
 315  *
 316  * Typically, eCryptfs will use the same ciphers repeatedly throughout
 317  * the course of its operations. In order to avoid unnecessarily
 318  * destroying and initializing the same cipher repeatedly, eCryptfs
 319  * keeps a list of crypto API contexts around to use when needed.
 320  */
 321 struct ecryptfs_key_tfm {
 322         struct crypto_blkcipher *key_tfm;
 323         size_t key_size;
 324         struct mutex key_tfm_mutex;
 325         struct list_head key_tfm_list;
 326         unsigned char cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE + 1];
 327 };
 328
 329 extern struct mutex key_tfm_list_mutex;
 330
 331 /**
 332  * This struct is to enable a mount-wide passphrase/salt combo. This
 333  * is more or less a stopgap to provide similar functionality to other
 334  * crypto filesystems like EncFS or CFS until full policy support is
 335  * implemented in eCryptfs.
 336  */
 337 struct ecryptfs_mount_crypt_stat {
 338         /* Pointers to memory we do not own, do not free these */
 339 #define ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED 0x00000001
 340 #define ECRYPTFS_XATTR_METADATA_ENABLED        0x00000002
 341 #define ECRYPTFS_ENCRYPTED_VIEW_ENABLED        0x00000004
 342 #define ECRYPTFS_MOUNT_CRYPT_STAT_INITIALIZED  0x00000008
 343 #define ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES      0x00000010
 344 #define ECRYPTFS_GLOBAL_ENCFN_USE_MOUNT_FNEK   0x00000020
 345 #define ECRYPTFS_GLOBAL_ENCFN_USE_FEK          0x00000040
 346 #define ECRYPTFS_GLOBAL_MOUNT_AUTH_TOK_ONLY    0x00000080
 347         u32 flags;
 348         struct list_head global_auth_tok_list;
 349         struct mutex global_auth_tok_list_mutex;
 350         size_t global_default_cipher_key_size;
 351         size_t global_default_fn_cipher_key_bytes;
 352         unsigned char global_default_cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE
 353                                                  + 1];
 354         unsigned char global_default_fn_cipher_name[
 355                 ECRYPTFS_MAX_CIPHER_NAME_SIZE + 1];
 356         char global_default_fnek_sig[ECRYPTFS_SIG_SIZE_HEX + 1];
 357 };
 358
 359 /* superblock private data. */
 360 struct ecryptfs_sb_info {
 361         struct super_block *wsi_sb;
 362         struct ecryptfs_mount_crypt_stat mount_crypt_stat;
 363         struct backing_dev_info bdi;
 364 };
 365
 366 /* file private data. */
 367 struct ecryptfs_file_info {
 368         struct file *wfi_file;
 369         struct ecryptfs_crypt_stat *crypt_stat;
 370 };
 371
 372 /* auth_tok <=> encrypted_session_key mappings */
 373 struct ecryptfs_auth_tok_list_item {
 374         unsigned char encrypted_session_key[ECRYPTFS_MAX_KEY_BYTES];
 375         struct list_head list;
 376         struct ecryptfs_auth_tok auth_tok;
 377 };
 378
 379 struct ecryptfs_message {
 380         /* Can never be greater than ecryptfs_message_buf_len */
 381         /* Used to find the parent msg_ctx */
 382         /* Inherits from msg_ctx->index */
 383         u32 index;
 384         u32 data_len;
 385         u8 data[];
 386 };
 387
 388 struct ecryptfs_msg_ctx {
 389 #define ECRYPTFS_MSG_CTX_STATE_FREE     0x01
 390 #define ECRYPTFS_MSG_CTX_STATE_PENDING  0x02
 391 #define ECRYPTFS_MSG_CTX_STATE_DONE     0x03
 392 #define ECRYPTFS_MSG_CTX_STATE_NO_REPLY 0x04
 393         u8 state;
 394 #define ECRYPTFS_MSG_HELO 100
 395 #define ECRYPTFS_MSG_QUIT 101
 396 #define ECRYPTFS_MSG_REQUEST 102
 397 #define ECRYPTFS_MSG_RESPONSE 103
 398         u8 type;
 399         u32 index;
 400         /* Counter converts to a sequence number. Each message sent
 401          * out for which we expect a response has an associated
 402          * sequence number. The response must have the same sequence
 403          * number as the counter for the msg_stc for the message to be
 404          * valid. */
 405         u32 counter;
 406         size_t msg_size;
 407         struct ecryptfs_message *msg;
 408         struct task_struct *task;
 409         struct list_head node;
 410         struct list_head daemon_out_list;
 411         struct mutex mux;
 412 };
 413
 414 struct ecryptfs_daemon {
 415 #define ECRYPTFS_DAEMON_IN_READ      0x00000001
 416 #define ECRYPTFS_DAEMON_IN_POLL      0x00000002
 417 #define ECRYPTFS_DAEMON_ZOMBIE       0x00000004
 418 #define ECRYPTFS_DAEMON_MISCDEV_OPEN 0x00000008
 419         u32 flags;
 420         u32 num_queued_msg_ctx;
 421         struct file *file;
 422         struct mutex mux;
 423         struct list_head msg_ctx_out_queue;
 424         wait_queue_head_t wait;
 425         struct hlist_node euid_chain;
 426 };
 427
 428 #ifdef CONFIG_ECRYPT_FS_MESSAGING
 429 extern struct mutex ecryptfs_daemon_hash_mux;
 430 #endif
 431
 432 static inline size_t
 433 ecryptfs_lower_header_size(struct ecryptfs_crypt_stat *crypt_stat)
 434 {
 435         if (crypt_stat->flags & ECRYPTFS_METADATA_IN_XATTR)
 436                 return 0;
 437         return crypt_stat->metadata_size;
 438 }
 439
 440 static inline struct ecryptfs_file_info *
 441 ecryptfs_file_to_private(struct file *file)
 442 {
 443         return file->private_data;
 444 }
 445
 446 static inline void
 447 ecryptfs_set_file_private(struct file *file,
 448                           struct ecryptfs_file_info *file_info)
 449 {
 450         file->private_data = file_info;
 451 }
 452
 453 static inline struct file *ecryptfs_file_to_lower(struct file *file)
 454 {
 455         return ((struct ecryptfs_file_info *)file->private_data)->wfi_file;
 456 }
 457
 458 static inline void
 459 ecryptfs_set_file_lower(struct file *file, struct file *lower_file)
 460 {
 461         ((struct ecryptfs_file_info *)file->private_data)->wfi_file =
 462                 lower_file;
 463 }
 464
 465 static inline struct ecryptfs_inode_info *
 466 ecryptfs_inode_to_private(struct inode *inode)
 467 {
 468         return container_of(inode, struct ecryptfs_inode_info, vfs_inode);
 469 }
 470
 471 static inline struct inode *ecryptfs_inode_to_lower(struct inode *inode)
 472 {
 473         return ecryptfs_inode_to_private(inode)->wii_inode;
 474 }
 475
 476 static inline void
 477 ecryptfs_set_inode_lower(struct inode *inode, struct inode *lower_inode)
 478 {
 479         ecryptfs_inode_to_private(inode)->wii_inode = lower_inode;
 480 }
 481
 482 static inline struct ecryptfs_sb_info *
 483 ecryptfs_superblock_to_private(struct super_block *sb)
 484 {
 485         return (struct ecryptfs_sb_info *)sb->s_fs_info;
 486 }
 487
 488 static inline void
 489 ecryptfs_set_superblock_private(struct super_block *sb,
 490                                 struct ecryptfs_sb_info *sb_info)
 491 {
 492         sb->s_fs_info = sb_info;
 493 }
 494
 495 static inline struct super_block *
 496 ecryptfs_superblock_to_lower(struct super_block *sb)
 497 {
 498         return ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb;
 499 }
 500
 501 static inline void
 502 ecryptfs_set_superblock_lower(struct super_block *sb,
 503                               struct super_block *lower_sb)
 504 {
 505         ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb = lower_sb;
 506 }
 507
 508 static inline struct ecryptfs_dentry_info *
 509 ecryptfs_dentry_to_private(struct dentry *dentry)
 510 {
 511         return (struct ecryptfs_dentry_info *)dentry->d_fsdata;
 512 }
 513
 514 static inline void
 515 ecryptfs_set_dentry_private(struct dentry *dentry,
 516                             struct ecryptfs_dentry_info *dentry_info)
 517 {
 518         dentry->d_fsdata = dentry_info;
 519 }
 520
 521 static inline struct dentry *
 522 ecryptfs_dentry_to_lower(struct dentry *dentry)
 523 {
 524         return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry;
 525 }
 526
 527 static inline struct vfsmount *
 528 ecryptfs_dentry_to_lower_mnt(struct dentry *dentry)
 529 {
 530         return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt;
 531 }
 532
 533 static inline struct path *
 534 ecryptfs_dentry_to_lower_path(struct dentry *dentry)
 535 {
 536         return &((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path;
 537 }
 538
 539 #define ecryptfs_printk(type, fmt, arg...) \
 540         __ecryptfs_printk(type "%s: " fmt, __func__, ## arg);
 541 __printf(1, 2)
 542 void __ecryptfs_printk(const char *fmt, ...);
 543
 544 extern const struct file_operations ecryptfs_main_fops;
 545 extern const struct file_operations ecryptfs_dir_fops;
 546 extern const struct inode_operations ecryptfs_main_iops;
 547 extern const struct inode_operations ecryptfs_dir_iops;
 548 extern const struct inode_operations ecryptfs_symlink_iops;
 549 extern const struct super_operations ecryptfs_sops;
 550 extern const struct dentry_operations ecryptfs_dops;
 551 extern const struct address_space_operations ecryptfs_aops;
 552 extern int ecryptfs_verbosity;
 553 extern unsigned int ecryptfs_message_buf_len;
 554 extern signed long ecryptfs_message_wait_timeout;
 555 extern unsigned int ecryptfs_number_of_users;
 556
 557 extern struct kmem_cache *ecryptfs_auth_tok_list_item_cache;
 558 extern struct kmem_cache *ecryptfs_file_info_cache;
 559 extern struct kmem_cache *ecryptfs_dentry_info_cache;
 560 extern struct kmem_cache *ecryptfs_inode_info_cache;
 561 extern struct kmem_cache *ecryptfs_sb_info_cache;
 562 extern struct kmem_cache *ecryptfs_header_cache;
 563 extern struct kmem_cache *ecryptfs_xattr_cache;
 564 extern struct kmem_cache *ecryptfs_key_record_cache;
 565 extern struct kmem_cache *ecryptfs_key_sig_cache;
 566 extern struct kmem_cache *ecryptfs_global_auth_tok_cache;
 567 extern struct kmem_cache *ecryptfs_key_tfm_cache;
 568
 569 struct inode *ecryptfs_get_inode(struct inode *lower_inode,
 570                                  struct super_block *sb);
 571 void ecryptfs_i_size_init(const char *page_virt, struct inode *inode);
 572 int ecryptfs_initialize_file(struct dentry *ecryptfs_dentry,
 573                              struct inode *ecryptfs_inode);
 574 int ecryptfs_decode_and_decrypt_filename(char **decrypted_name,
 575                                          size_t *decrypted_name_size,
 576                                          struct super_block *sb,
 577                                          const char *name, size_t name_size);
 578 int ecryptfs_fill_zeros(struct file *file, loff_t new_length);
 579 int ecryptfs_encrypt_and_encode_filename(
 580         char **encoded_name,
 581         size_t *encoded_name_size,
 582         struct ecryptfs_crypt_stat *crypt_stat,
 583         struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
 584         const char *name, size_t name_size);
 585 struct dentry *ecryptfs_lower_dentry(struct dentry *this_dentry);
 586 void ecryptfs_dump_hex(char *data, int bytes);
 587 int virt_to_scatterlist(const void *addr, int size, struct scatterlist *sg,
 588                         int sg_size);
 589 int ecryptfs_compute_root_iv(struct ecryptfs_crypt_stat *crypt_stat);
 590 void ecryptfs_rotate_iv(unsigned char *iv);
 591 void ecryptfs_init_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
 592 void ecryptfs_destroy_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
 593 void ecryptfs_destroy_mount_crypt_stat(
 594         struct ecryptfs_mount_crypt_stat *mount_crypt_stat);
 595 int ecryptfs_init_crypt_ctx(struct ecryptfs_crypt_stat *crypt_stat);
 596 int ecryptfs_write_inode_size_to_metadata(struct inode *ecryptfs_inode);
 597 int ecryptfs_encrypt_page(struct page *page);
 598 int ecryptfs_decrypt_page(struct page *page);
 599 int ecryptfs_write_metadata(struct dentry *ecryptfs_dentry,
 600                             struct inode *ecryptfs_inode);
 601 int ecryptfs_read_metadata(struct dentry *ecryptfs_dentry);
 602 int ecryptfs_new_file_context(struct inode *ecryptfs_inode);
 603 void ecryptfs_write_crypt_stat_flags(char *page_virt,
 604                                      struct ecryptfs_crypt_stat *crypt_stat,
 605                                      size_t *written);
 606 int ecryptfs_read_and_validate_header_region(struct inode *inode);
 607 int ecryptfs_read_and_validate_xattr_region(struct dentry *dentry,
 608                                             struct inode *inode);
 609 u8 ecryptfs_code_for_cipher_string(char *cipher_name, size_t key_bytes);
 610 int ecryptfs_cipher_code_to_string(char *str, u8 cipher_code);
 611 void ecryptfs_set_default_sizes(struct ecryptfs_crypt_stat *crypt_stat);
 612 int ecryptfs_generate_key_packet_set(char *dest_base,
 613                                      struct ecryptfs_crypt_stat *crypt_stat,
 614                                      struct dentry *ecryptfs_dentry,
 615                                      size_t *len, size_t max);
 616 int
 617 ecryptfs_parse_packet_set(struct ecryptfs_crypt_stat *crypt_stat,
 618                           unsigned char *src, struct dentry *ecryptfs_dentry);
 619 int ecryptfs_truncate(struct dentry *dentry, loff_t new_length);
 620 ssize_t
 621 ecryptfs_getxattr_lower(struct dentry *lower_dentry, const char *name,
 622                         void *value, size_t size);
 623 int
 624 ecryptfs_setxattr(struct dentry *dentry, const char *name, const void *value,
 625                   size_t size, int flags);
 626 int ecryptfs_read_xattr_region(char *page_virt, struct inode *ecryptfs_inode);
 627 #ifdef CONFIG_ECRYPT_FS_MESSAGING
 628 int ecryptfs_process_response(struct ecryptfs_daemon *daemon,
 629                               struct ecryptfs_message *msg, u32 seq);
 630 int ecryptfs_send_message(char *data, int data_len,
 631                           struct ecryptfs_msg_ctx **msg_ctx);
 632 int ecryptfs_wait_for_response(struct ecryptfs_msg_ctx *msg_ctx,
 633                                struct ecryptfs_message **emsg);
 634 int ecryptfs_init_messaging(void);
 635 void ecryptfs_release_messaging(void);
 636 #else
 637 static inline int ecryptfs_init_messaging(void)
 638 {
 639         return 0;
 640 }
 641 static inline void ecryptfs_release_messaging(void)
 642 { }
 643 static inline int ecryptfs_send_message(char *data, int data_len,
 644                                         struct ecryptfs_msg_ctx **msg_ctx)
 645 {
 646         return -ENOTCONN;
 647 }
 648 static inline int ecryptfs_wait_for_response(struct ecryptfs_msg_ctx *msg_ctx,
 649                                              struct ecryptfs_message **emsg)
 650 {
 651         return -ENOMSG;
 652 }
 653 #endif
 654
 655 void
 656 ecryptfs_write_header_metadata(char *virt,
 657                                struct ecryptfs_crypt_stat *crypt_stat,
 658                                size_t *written);
 659 int ecryptfs_add_keysig(struct ecryptfs_crypt_stat *crypt_stat, char *sig);
 660 int
 661 ecryptfs_add_global_auth_tok(struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
 662                            char *sig, u32 global_auth_tok_flags);
 663 int ecryptfs_get_global_auth_tok_for_sig(
 664         struct ecryptfs_global_auth_tok **global_auth_tok,
 665         struct ecryptfs_mount_crypt_stat *mount_crypt_stat, char *sig);
 666 int
 667 ecryptfs_add_new_key_tfm(struct ecryptfs_key_tfm **key_tfm, char *cipher_name,
 668                          size_t key_size);
 669 int ecryptfs_init_crypto(void);
 670 int ecryptfs_destroy_crypto(void);
 671 int ecryptfs_tfm_exists(char *cipher_name, struct ecryptfs_key_tfm **key_tfm);
 672 int ecryptfs_get_tfm_and_mutex_for_cipher_name(struct crypto_blkcipher **tfm,
 673                                                struct mutex **tfm_mutex,
 674                                                char *cipher_name);
 675 int ecryptfs_keyring_auth_tok_for_sig(struct key **auth_tok_key,
 676                                       struct ecryptfs_auth_tok **auth_tok,
 677                                       char *sig);
 678 int ecryptfs_write_lower(struct inode *ecryptfs_inode, char *data,
 679                          loff_t offset, size_t size);
 680 int ecryptfs_write_lower_page_segment(struct inode *ecryptfs_inode,
 681                                       struct page *page_for_lower,
 682                                       size_t offset_in_page, size_t size);
 683 int ecryptfs_write(struct inode *inode, char *data, loff_t offset, size_t size);
 684 int ecryptfs_read_lower(char *data, loff_t offset, size_t size,
 685                         struct inode *ecryptfs_inode);
 686 int ecryptfs_read_lower_page_segment(struct page *page_for_ecryptfs,
 687                                      pgoff_t page_index,
 688                                      size_t offset_in_page, size_t size,
 689                                      struct inode *ecryptfs_inode);
 690 struct page *ecryptfs_get_locked_page(struct inode *inode, loff_t index);
 691 int ecryptfs_parse_packet_length(unsigned char *data, size_t *size,
 692                                  size_t *length_size);
 693 int ecryptfs_write_packet_length(char *dest, size_t size,
 694                                  size_t *packet_size_length);
 695 #ifdef CONFIG_ECRYPT_FS_MESSAGING
 696 int ecryptfs_init_ecryptfs_miscdev(void);
 697 void ecryptfs_destroy_ecryptfs_miscdev(void);
 698 int ecryptfs_send_miscdev(char *data, size_t data_size,
 699                           struct ecryptfs_msg_ctx *msg_ctx, u8 msg_type,
 700                           u16 msg_flags, struct ecryptfs_daemon *daemon);
 701 void ecryptfs_msg_ctx_alloc_to_free(struct ecryptfs_msg_ctx *msg_ctx);
 702 int
 703 ecryptfs_spawn_daemon(struct ecryptfs_daemon **daemon, struct file *file);
 704 int ecryptfs_exorcise_daemon(struct ecryptfs_daemon *daemon);
 705 int ecryptfs_find_daemon_by_euid(struct ecryptfs_daemon **daemon);
 706 #endif
 707 int ecryptfs_init_kthread(void);
 708 void ecryptfs_destroy_kthread(void);
 709 int ecryptfs_privileged_open(struct file **lower_file,
 710                              struct dentry *lower_dentry,
 711                              struct vfsmount *lower_mnt,
 712                              const struct cred *cred);
 713 int ecryptfs_get_lower_file(struct dentry *dentry, struct inode *inode);
 714 void ecryptfs_put_lower_file(struct inode *inode);
 715 int
 716 ecryptfs_write_tag_70_packet(char *dest, size_t *remaining_bytes,
 717                              size_t *packet_size,
 718                              struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
 719                              char *filename, size_t filename_size);
 720 int
 721 ecryptfs_parse_tag_70_packet(char **filename, size_t *filename_size,
 722                              size_t *packet_size,
 723                              struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
 724                              char *data, size_t max_packet_size);
 725 int ecryptfs_set_f_namelen(long *namelen, long lower_namelen,
 726                            struct ecryptfs_mount_crypt_stat *mount_crypt_stat);
 727 int ecryptfs_derive_iv(char *iv, struct ecryptfs_crypt_stat *crypt_stat,
 728                        loff_t offset);
 729
 730 #endif /* #ifndef ECRYPTFS_KERNEL_H */