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 <linux/fs.h>
  33 #include <linux/fs_stack.h>
  34 #include <linux/namei.h>
  35 #include <linux/scatterlist.h>
  36 #include <linux/hash.h>
  37 #include <linux/nsproxy.h>
  38
  39 /* Version verification for shared data structures w/ userspace */
  40 #define ECRYPTFS_VERSION_MAJOR 0x00
  41 #define ECRYPTFS_VERSION_MINOR 0x04
  42 #define ECRYPTFS_SUPPORTED_FILE_VERSION 0x03
  43 /* These flags indicate which features are supported by the kernel
  44  * module; userspace tools such as the mount helper read
  45  * ECRYPTFS_VERSIONING_MASK from a sysfs handle in order to determine
  46  * how to behave. */
  47 #define ECRYPTFS_VERSIONING_PASSPHRASE            0x00000001
  48 #define ECRYPTFS_VERSIONING_PUBKEY                0x00000002
  49 #define ECRYPTFS_VERSIONING_PLAINTEXT_PASSTHROUGH 0x00000004
  50 #define ECRYPTFS_VERSIONING_POLICY                0x00000008
  51 #define ECRYPTFS_VERSIONING_XATTR                 0x00000010
  52 #define ECRYPTFS_VERSIONING_MULTKEY               0x00000020
  53 #define ECRYPTFS_VERSIONING_DEVMISC               0x00000040
  54 #define ECRYPTFS_VERSIONING_MASK (ECRYPTFS_VERSIONING_PASSPHRASE \
  55                                   | ECRYPTFS_VERSIONING_PLAINTEXT_PASSTHROUGH \
  56                                   | ECRYPTFS_VERSIONING_PUBKEY \
  57                                   | ECRYPTFS_VERSIONING_XATTR \
  58                                   | ECRYPTFS_VERSIONING_MULTKEY \
  59                                   | ECRYPTFS_VERSIONING_DEVMISC)
  60 #define ECRYPTFS_MAX_PASSWORD_LENGTH 64
  61 #define ECRYPTFS_MAX_PASSPHRASE_BYTES ECRYPTFS_MAX_PASSWORD_LENGTH
  62 #define ECRYPTFS_SALT_SIZE 8
  63 #define ECRYPTFS_SALT_SIZE_HEX (ECRYPTFS_SALT_SIZE*2)
  64 /* The original signature size is only for what is stored on disk; all
  65  * in-memory representations are expanded hex, so it better adapted to
  66  * be passed around or referenced on the command line */
  67 #define ECRYPTFS_SIG_SIZE 8
  68 #define ECRYPTFS_SIG_SIZE_HEX (ECRYPTFS_SIG_SIZE*2)
  69 #define ECRYPTFS_PASSWORD_SIG_SIZE ECRYPTFS_SIG_SIZE_HEX
  70 #define ECRYPTFS_MAX_KEY_BYTES 64
  71 #define ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES 512
  72 #define ECRYPTFS_DEFAULT_IV_BYTES 16
  73 #define ECRYPTFS_FILE_VERSION 0x03
  74 #define ECRYPTFS_DEFAULT_EXTENT_SIZE 4096
  75 #define ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE 8192
  76 #define ECRYPTFS_DEFAULT_MSG_CTX_ELEMS 32
  77 #define ECRYPTFS_DEFAULT_SEND_TIMEOUT HZ
  78 #define ECRYPTFS_MAX_MSG_CTX_TTL (HZ*3)
  79 #define ECRYPTFS_MAX_PKI_NAME_BYTES 16
  80 #define ECRYPTFS_DEFAULT_NUM_USERS 4
  81 #define ECRYPTFS_MAX_NUM_USERS 32768
  82 #define ECRYPTFS_XATTR_NAME "user.ecryptfs"
  83
  84 #define RFC2440_CIPHER_DES3_EDE 0x02
  85 #define RFC2440_CIPHER_CAST_5 0x03
  86 #define RFC2440_CIPHER_BLOWFISH 0x04
  87 #define RFC2440_CIPHER_AES_128 0x07
  88 #define RFC2440_CIPHER_AES_192 0x08
  89 #define RFC2440_CIPHER_AES_256 0x09
  90 #define RFC2440_CIPHER_TWOFISH 0x0a
  91 #define RFC2440_CIPHER_CAST_6 0x0b
  92
  93 #define RFC2440_CIPHER_RSA 0x01
  94
  95 /**
  96  * For convenience, we may need to pass around the encrypted session
  97  * key between kernel and userspace because the authentication token
  98  * may not be extractable.  For example, the TPM may not release the
  99  * private key, instead requiring the encrypted data and returning the
 100  * decrypted data.
 101  */
 102 struct ecryptfs_session_key {
 103 #define ECRYPTFS_USERSPACE_SHOULD_TRY_TO_DECRYPT 0x00000001
 104 #define ECRYPTFS_USERSPACE_SHOULD_TRY_TO_ENCRYPT 0x00000002
 105 #define ECRYPTFS_CONTAINS_DECRYPTED_KEY 0x00000004
 106 #define ECRYPTFS_CONTAINS_ENCRYPTED_KEY 0x00000008
 107         u32 flags;
 108         u32 encrypted_key_size;
 109         u32 decrypted_key_size;
 110         u8 encrypted_key[ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES];
 111         u8 decrypted_key[ECRYPTFS_MAX_KEY_BYTES];
 112 };
 113
 114 struct ecryptfs_password {
 115         u32 password_bytes;
 116         s32 hash_algo;
 117         u32 hash_iterations;
 118         u32 session_key_encryption_key_bytes;
 119 #define ECRYPTFS_PERSISTENT_PASSWORD 0x01
 120 #define ECRYPTFS_SESSION_KEY_ENCRYPTION_KEY_SET 0x02
 121         u32 flags;
 122         /* Iterated-hash concatenation of salt and passphrase */
 123         u8 session_key_encryption_key[ECRYPTFS_MAX_KEY_BYTES];
 124         u8 signature[ECRYPTFS_PASSWORD_SIG_SIZE + 1];
 125         /* Always in expanded hex */
 126         u8 salt[ECRYPTFS_SALT_SIZE];
 127 };
 128
 129 enum ecryptfs_token_types {ECRYPTFS_PASSWORD, ECRYPTFS_PRIVATE_KEY};
 130
 131 struct ecryptfs_private_key {
 132         u32 key_size;
 133         u32 data_len;
 134         u8 signature[ECRYPTFS_PASSWORD_SIG_SIZE + 1];
 135         char pki_type[ECRYPTFS_MAX_PKI_NAME_BYTES + 1];
 136         u8 data[];
 137 };
 138
 139 /* May be a password or a private key */
 140 struct ecryptfs_auth_tok {
 141         u16 version; /* 8-bit major and 8-bit minor */
 142         u16 token_type;
 143 #define ECRYPTFS_ENCRYPT_ONLY 0x00000001
 144         u32 flags;
 145         struct ecryptfs_session_key session_key;
 146         u8 reserved[32];
 147         union {
 148                 struct ecryptfs_password password;
 149                 struct ecryptfs_private_key private_key;
 150         } token;
 151 } __attribute__ ((packed));
 152
 153 void ecryptfs_dump_auth_tok(struct ecryptfs_auth_tok *auth_tok);
 154 extern void ecryptfs_to_hex(char *dst, char *src, size_t src_size);
 155 extern void ecryptfs_from_hex(char *dst, char *src, int dst_size);
 156
 157 struct ecryptfs_key_record {
 158         unsigned char type;
 159         size_t enc_key_size;
 160         unsigned char sig[ECRYPTFS_SIG_SIZE];
 161         unsigned char enc_key[ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES];
 162 };
 163
 164 struct ecryptfs_auth_tok_list {
 165         struct ecryptfs_auth_tok *auth_tok;
 166         struct list_head list;
 167 };
 168
 169 struct ecryptfs_crypt_stat;
 170 struct ecryptfs_mount_crypt_stat;
 171
 172 struct ecryptfs_page_crypt_context {
 173         struct page *page;
 174 #define ECRYPTFS_PREPARE_COMMIT_MODE 0
 175 #define ECRYPTFS_WRITEPAGE_MODE      1
 176         unsigned int mode;
 177         union {
 178                 struct file *lower_file;
 179                 struct writeback_control *wbc;
 180         } param;
 181 };
 182
 183 static inline struct ecryptfs_auth_tok *
 184 ecryptfs_get_key_payload_data(struct key *key)
 185 {
 186         return (struct ecryptfs_auth_tok *)
 187                 (((struct user_key_payload*)key->payload.data)->data);
 188 }
 189
 190 #define ECRYPTFS_SUPER_MAGIC 0xf15f
 191 #define ECRYPTFS_MAX_KEYSET_SIZE 1024
 192 #define ECRYPTFS_MAX_CIPHER_NAME_SIZE 32
 193 #define ECRYPTFS_MAX_NUM_ENC_KEYS 64
 194 #define ECRYPTFS_MAX_IV_BYTES 16        /* 128 bits */
 195 #define ECRYPTFS_SALT_BYTES 2
 196 #define MAGIC_ECRYPTFS_MARKER 0x3c81b7f5
 197 #define MAGIC_ECRYPTFS_MARKER_SIZE_BYTES 8      /* 4*2 */
 198 #define ECRYPTFS_FILE_SIZE_BYTES (sizeof(u64))
 199 #define ECRYPTFS_DEFAULT_CIPHER "aes"
 200 #define ECRYPTFS_DEFAULT_KEY_BYTES 16
 201 #define ECRYPTFS_DEFAULT_HASH "md5"
 202 #define ECRYPTFS_TAG_1_PACKET_TYPE 0x01
 203 #define ECRYPTFS_TAG_3_PACKET_TYPE 0x8C
 204 #define ECRYPTFS_TAG_11_PACKET_TYPE 0xED
 205 #define ECRYPTFS_TAG_64_PACKET_TYPE 0x40
 206 #define ECRYPTFS_TAG_65_PACKET_TYPE 0x41
 207 #define ECRYPTFS_TAG_66_PACKET_TYPE 0x42
 208 #define ECRYPTFS_TAG_67_PACKET_TYPE 0x43
 209 #define MD5_DIGEST_SIZE 16
 210
 211 struct ecryptfs_key_sig {
 212         struct list_head crypt_stat_list;
 213         char keysig[ECRYPTFS_SIG_SIZE_HEX];
 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_NEW_FILE           0x00000004
 225 #define ECRYPTFS_ENCRYPTED          0x00000008
 226 #define ECRYPTFS_SECURITY_WARNING   0x00000010
 227 #define ECRYPTFS_ENABLE_HMAC        0x00000020
 228 #define ECRYPTFS_ENCRYPT_IV_PAGES   0x00000040
 229 #define ECRYPTFS_KEY_VALID          0x00000080
 230 #define ECRYPTFS_METADATA_IN_XATTR  0x00000100
 231 #define ECRYPTFS_VIEW_AS_ENCRYPTED  0x00000200
 232 #define ECRYPTFS_KEY_SET            0x00000400
 233         u32 flags;
 234         unsigned int file_version;
 235         size_t iv_bytes;
 236         size_t num_header_bytes_at_front;
 237         size_t extent_size; /* Data extent size; default is 4096 */
 238         size_t key_size;
 239         size_t extent_shift;
 240         unsigned int extent_mask;
 241         struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
 242         struct crypto_blkcipher *tfm;
 243         struct crypto_hash *hash_tfm; /* Crypto context for generating
 244                                        * the initialization vectors */
 245         unsigned char cipher[ECRYPTFS_MAX_CIPHER_NAME_SIZE];
 246         unsigned char key[ECRYPTFS_MAX_KEY_BYTES];
 247         unsigned char root_iv[ECRYPTFS_MAX_IV_BYTES];
 248         struct list_head keysig_list;
 249         struct mutex keysig_list_mutex;
 250         struct mutex cs_tfm_mutex;
 251         struct mutex cs_hash_tfm_mutex;
 252         struct mutex cs_mutex;
 253 };
 254
 255 /* inode private data. */
 256 struct ecryptfs_inode_info {
 257         struct inode vfs_inode;
 258         struct inode *wii_inode;
 259         struct file *lower_file;
 260         struct mutex lower_file_mutex;
 261         struct ecryptfs_crypt_stat crypt_stat;
 262 };
 263
 264 /* dentry private data. Each dentry must keep track of a lower
 265  * vfsmount too. */
 266 struct ecryptfs_dentry_info {
 267         struct path lower_path;
 268         struct ecryptfs_crypt_stat *crypt_stat;
 269 };
 270
 271 /**
 272  * ecryptfs_global_auth_tok - A key used to encrypt all new files under the mountpoint
 273  * @flags: Status flags
 274  * @mount_crypt_stat_list: These auth_toks hang off the mount-wide
 275  *                         cryptographic context. Every time a new
 276  *                         inode comes into existence, eCryptfs copies
 277  *                         the auth_toks on that list to the set of
 278  *                         auth_toks on the inode's crypt_stat
 279  * @global_auth_tok_key: The key from the user's keyring for the sig
 280  * @global_auth_tok: The key contents
 281  * @sig: The key identifier
 282  *
 283  * ecryptfs_global_auth_tok structs refer to authentication token keys
 284  * in the user keyring that apply to newly created files. A list of
 285  * these objects hangs off of the mount_crypt_stat struct for any
 286  * given eCryptfs mount. This struct maintains a reference to both the
 287  * key contents and the key itself so that the key can be put on
 288  * unmount.
 289  */
 290 struct ecryptfs_global_auth_tok {
 291 #define ECRYPTFS_AUTH_TOK_INVALID 0x00000001
 292         u32 flags;
 293         struct list_head mount_crypt_stat_list;
 294         struct key *global_auth_tok_key;
 295         struct ecryptfs_auth_tok *global_auth_tok;
 296         unsigned char sig[ECRYPTFS_SIG_SIZE_HEX + 1];
 297 };
 298
 299 /**
 300  * ecryptfs_key_tfm - Persistent key tfm
 301  * @key_tfm: crypto API handle to the key
 302  * @key_size: Key size in bytes
 303  * @key_tfm_mutex: Mutex to ensure only one operation in eCryptfs is
 304  *                 using the persistent TFM at any point in time
 305  * @key_tfm_list: Handle to hang this off the module-wide TFM list
 306  * @cipher_name: String name for the cipher for this TFM
 307  *
 308  * Typically, eCryptfs will use the same ciphers repeatedly throughout
 309  * the course of its operations. In order to avoid unnecessarily
 310  * destroying and initializing the same cipher repeatedly, eCryptfs
 311  * keeps a list of crypto API contexts around to use when needed.
 312  */
 313 struct ecryptfs_key_tfm {
 314         struct crypto_blkcipher *key_tfm;
 315         size_t key_size;
 316         struct mutex key_tfm_mutex;
 317         struct list_head key_tfm_list;
 318         unsigned char cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE + 1];
 319 };
 320
 321 extern struct mutex key_tfm_list_mutex;
 322
 323 /**
 324  * This struct is to enable a mount-wide passphrase/salt combo. This
 325  * is more or less a stopgap to provide similar functionality to other
 326  * crypto filesystems like EncFS or CFS until full policy support is
 327  * implemented in eCryptfs.
 328  */
 329 struct ecryptfs_mount_crypt_stat {
 330         /* Pointers to memory we do not own, do not free these */
 331 #define ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED 0x00000001
 332 #define ECRYPTFS_XATTR_METADATA_ENABLED        0x00000002
 333 #define ECRYPTFS_ENCRYPTED_VIEW_ENABLED        0x00000004
 334 #define ECRYPTFS_MOUNT_CRYPT_STAT_INITIALIZED  0x00000008
 335         u32 flags;
 336         struct list_head global_auth_tok_list;
 337         struct mutex global_auth_tok_list_mutex;
 338         size_t num_global_auth_toks;
 339         size_t global_default_cipher_key_size;
 340         unsigned char global_default_cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE
 341                                                  + 1];
 342 };
 343
 344 /* superblock private data. */
 345 struct ecryptfs_sb_info {
 346         struct super_block *wsi_sb;
 347         struct ecryptfs_mount_crypt_stat mount_crypt_stat;
 348 };
 349
 350 /* file private data. */
 351 struct ecryptfs_file_info {
 352         struct file *wfi_file;
 353         struct ecryptfs_crypt_stat *crypt_stat;
 354 };
 355
 356 /* auth_tok <=> encrypted_session_key mappings */
 357 struct ecryptfs_auth_tok_list_item {
 358         unsigned char encrypted_session_key[ECRYPTFS_MAX_KEY_BYTES];
 359         struct list_head list;
 360         struct ecryptfs_auth_tok auth_tok;
 361 };
 362
 363 struct ecryptfs_message {
 364         /* Can never be greater than ecryptfs_message_buf_len */
 365         /* Used to find the parent msg_ctx */
 366         /* Inherits from msg_ctx->index */
 367         u32 index;
 368         u32 data_len;
 369         u8 data[];
 370 };
 371
 372 struct ecryptfs_msg_ctx {
 373 #define ECRYPTFS_MSG_CTX_STATE_FREE     0x01
 374 #define ECRYPTFS_MSG_CTX_STATE_PENDING  0x02
 375 #define ECRYPTFS_MSG_CTX_STATE_DONE     0x03
 376 #define ECRYPTFS_MSG_CTX_STATE_NO_REPLY 0x04
 377         u8 state;
 378 #define ECRYPTFS_MSG_HELO 100
 379 #define ECRYPTFS_MSG_QUIT 101
 380 #define ECRYPTFS_MSG_REQUEST 102
 381 #define ECRYPTFS_MSG_RESPONSE 103
 382         u8 type;
 383         u32 index;
 384         /* Counter converts to a sequence number. Each message sent
 385          * out for which we expect a response has an associated
 386          * sequence number. The response must have the same sequence
 387          * number as the counter for the msg_stc for the message to be
 388          * valid. */
 389         u32 counter;
 390         size_t msg_size;
 391         struct ecryptfs_message *msg;
 392         struct task_struct *task;
 393         struct list_head node;
 394         struct list_head daemon_out_list;
 395         struct mutex mux;
 396 };
 397
 398 struct ecryptfs_daemon;
 399
 400 struct ecryptfs_daemon {
 401 #define ECRYPTFS_DAEMON_IN_READ      0x00000001
 402 #define ECRYPTFS_DAEMON_IN_POLL      0x00000002
 403 #define ECRYPTFS_DAEMON_ZOMBIE       0x00000004
 404 #define ECRYPTFS_DAEMON_MISCDEV_OPEN 0x00000008
 405         u32 flags;
 406         u32 num_queued_msg_ctx;
 407         struct pid *pid;
 408         uid_t euid;
 409         struct user_namespace *user_ns;
 410         struct task_struct *task;
 411         struct mutex mux;
 412         struct list_head msg_ctx_out_queue;
 413         wait_queue_head_t wait;
 414         struct hlist_node euid_chain;
 415 };
 416
 417 extern struct mutex ecryptfs_daemon_hash_mux;
 418
 419 static inline struct ecryptfs_file_info *
 420 ecryptfs_file_to_private(struct file *file)
 421 {
 422         return (struct ecryptfs_file_info *)file->private_data;
 423 }
 424
 425 static inline void
 426 ecryptfs_set_file_private(struct file *file,
 427                           struct ecryptfs_file_info *file_info)
 428 {
 429         file->private_data = file_info;
 430 }
 431
 432 static inline struct file *ecryptfs_file_to_lower(struct file *file)
 433 {
 434         return ((struct ecryptfs_file_info *)file->private_data)->wfi_file;
 435 }
 436
 437 static inline void
 438 ecryptfs_set_file_lower(struct file *file, struct file *lower_file)
 439 {
 440         ((struct ecryptfs_file_info *)file->private_data)->wfi_file =
 441                 lower_file;
 442 }
 443
 444 static inline struct ecryptfs_inode_info *
 445 ecryptfs_inode_to_private(struct inode *inode)
 446 {
 447         return container_of(inode, struct ecryptfs_inode_info, vfs_inode);
 448 }
 449
 450 static inline struct inode *ecryptfs_inode_to_lower(struct inode *inode)
 451 {
 452         return ecryptfs_inode_to_private(inode)->wii_inode;
 453 }
 454
 455 static inline void
 456 ecryptfs_set_inode_lower(struct inode *inode, struct inode *lower_inode)
 457 {
 458         ecryptfs_inode_to_private(inode)->wii_inode = lower_inode;
 459 }
 460
 461 static inline struct ecryptfs_sb_info *
 462 ecryptfs_superblock_to_private(struct super_block *sb)
 463 {
 464         return (struct ecryptfs_sb_info *)sb->s_fs_info;
 465 }
 466
 467 static inline void
 468 ecryptfs_set_superblock_private(struct super_block *sb,
 469                                 struct ecryptfs_sb_info *sb_info)
 470 {
 471         sb->s_fs_info = sb_info;
 472 }
 473
 474 static inline struct super_block *
 475 ecryptfs_superblock_to_lower(struct super_block *sb)
 476 {
 477         return ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb;
 478 }
 479
 480 static inline void
 481 ecryptfs_set_superblock_lower(struct super_block *sb,
 482                               struct super_block *lower_sb)
 483 {
 484         ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb = lower_sb;
 485 }
 486
 487 static inline struct ecryptfs_dentry_info *
 488 ecryptfs_dentry_to_private(struct dentry *dentry)
 489 {
 490         return (struct ecryptfs_dentry_info *)dentry->d_fsdata;
 491 }
 492
 493 static inline void
 494 ecryptfs_set_dentry_private(struct dentry *dentry,
 495                             struct ecryptfs_dentry_info *dentry_info)
 496 {
 497         dentry->d_fsdata = dentry_info;
 498 }
 499
 500 static inline struct dentry *
 501 ecryptfs_dentry_to_lower(struct dentry *dentry)
 502 {
 503         return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry;
 504 }
 505
 506 static inline void
 507 ecryptfs_set_dentry_lower(struct dentry *dentry, struct dentry *lower_dentry)
 508 {
 509         ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry =
 510                 lower_dentry;
 511 }
 512
 513 static inline struct vfsmount *
 514 ecryptfs_dentry_to_lower_mnt(struct dentry *dentry)
 515 {
 516         return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt;
 517 }
 518
 519 static inline void
 520 ecryptfs_set_dentry_lower_mnt(struct dentry *dentry, struct vfsmount *lower_mnt)
 521 {
 522         ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt =
 523                 lower_mnt;
 524 }
 525
 526 #define ecryptfs_printk(type, fmt, arg...) \
 527         __ecryptfs_printk(type "%s: " fmt, __func__, ## arg);
 528 void __ecryptfs_printk(const char *fmt, ...);
 529
 530 extern const struct file_operations ecryptfs_main_fops;
 531 extern const struct file_operations ecryptfs_dir_fops;
 532 extern const struct inode_operations ecryptfs_main_iops;
 533 extern const struct inode_operations ecryptfs_dir_iops;
 534 extern const struct inode_operations ecryptfs_symlink_iops;
 535 extern const struct super_operations ecryptfs_sops;
 536 extern struct dentry_operations ecryptfs_dops;
 537 extern struct address_space_operations ecryptfs_aops;
 538 extern int ecryptfs_verbosity;
 539 extern unsigned int ecryptfs_message_buf_len;
 540 extern signed long ecryptfs_message_wait_timeout;
 541 extern unsigned int ecryptfs_number_of_users;
 542
 543 extern struct kmem_cache *ecryptfs_auth_tok_list_item_cache;
 544 extern struct kmem_cache *ecryptfs_file_info_cache;
 545 extern struct kmem_cache *ecryptfs_dentry_info_cache;
 546 extern struct kmem_cache *ecryptfs_inode_info_cache;
 547 extern struct kmem_cache *ecryptfs_sb_info_cache;
 548 extern struct kmem_cache *ecryptfs_header_cache_1;
 549 extern struct kmem_cache *ecryptfs_header_cache_2;
 550 extern struct kmem_cache *ecryptfs_xattr_cache;
 551 extern struct kmem_cache *ecryptfs_key_record_cache;
 552 extern struct kmem_cache *ecryptfs_key_sig_cache;
 553 extern struct kmem_cache *ecryptfs_global_auth_tok_cache;
 554 extern struct kmem_cache *ecryptfs_key_tfm_cache;
 555 extern struct kmem_cache *ecryptfs_open_req_cache;
 556
 557 struct ecryptfs_open_req {
 558 #define ECRYPTFS_REQ_PROCESSED 0x00000001
 559 #define ECRYPTFS_REQ_DROPPED   0x00000002
 560 #define ECRYPTFS_REQ_ZOMBIE    0x00000004
 561         u32 flags;
 562         struct file **lower_file;
 563         struct dentry *lower_dentry;
 564         struct vfsmount *lower_mnt;
 565         wait_queue_head_t wait;
 566         struct mutex mux;
 567         struct list_head kthread_ctl_list;
 568 };
 569
 570 #define ECRYPTFS_INTERPOSE_FLAG_D_ADD                 0x00000001
 571 int ecryptfs_interpose(struct dentry *hidden_dentry,
 572                        struct dentry *this_dentry, struct super_block *sb,
 573                        u32 flags);
 574 int ecryptfs_fill_zeros(struct file *file, loff_t new_length);
 575 int ecryptfs_decode_filename(struct ecryptfs_crypt_stat *crypt_stat,
 576                              const char *name, int length,
 577                              char **decrypted_name);
 578 int ecryptfs_encode_filename(struct ecryptfs_crypt_stat *crypt_stat,
 579                              const char *name, int length,
 580                              char **encoded_name);
 581 struct dentry *ecryptfs_lower_dentry(struct dentry *this_dentry);
 582 void ecryptfs_dump_hex(char *data, int bytes);
 583 int virt_to_scatterlist(const void *addr, int size, struct scatterlist *sg,
 584                         int sg_size);
 585 int ecryptfs_compute_root_iv(struct ecryptfs_crypt_stat *crypt_stat);
 586 void ecryptfs_rotate_iv(unsigned char *iv);
 587 void ecryptfs_init_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
 588 void ecryptfs_destroy_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
 589 void ecryptfs_destroy_mount_crypt_stat(
 590         struct ecryptfs_mount_crypt_stat *mount_crypt_stat);
 591 int ecryptfs_init_crypt_ctx(struct ecryptfs_crypt_stat *crypt_stat);
 592 int ecryptfs_write_inode_size_to_metadata(struct inode *ecryptfs_inode);
 593 int ecryptfs_encrypt_page(struct page *page);
 594 int ecryptfs_decrypt_page(struct page *page);
 595 int ecryptfs_write_metadata(struct dentry *ecryptfs_dentry);
 596 int ecryptfs_read_metadata(struct dentry *ecryptfs_dentry);
 597 int ecryptfs_new_file_context(struct dentry *ecryptfs_dentry);
 598 int ecryptfs_read_and_validate_header_region(char *data,
 599                                              struct inode *ecryptfs_inode);
 600 int ecryptfs_read_and_validate_xattr_region(char *page_virt,
 601                                             struct dentry *ecryptfs_dentry);
 602 u8 ecryptfs_code_for_cipher_string(struct ecryptfs_crypt_stat *crypt_stat);
 603 int ecryptfs_cipher_code_to_string(char *str, u8 cipher_code);
 604 void ecryptfs_set_default_sizes(struct ecryptfs_crypt_stat *crypt_stat);
 605 int ecryptfs_generate_key_packet_set(char *dest_base,
 606                                      struct ecryptfs_crypt_stat *crypt_stat,
 607                                      struct dentry *ecryptfs_dentry,
 608                                      size_t *len, size_t max);
 609 int
 610 ecryptfs_parse_packet_set(struct ecryptfs_crypt_stat *crypt_stat,
 611                           unsigned char *src, struct dentry *ecryptfs_dentry);
 612 int ecryptfs_truncate(struct dentry *dentry, loff_t new_length);
 613 int ecryptfs_inode_test(struct inode *inode, void *candidate_lower_inode);
 614 int ecryptfs_inode_set(struct inode *inode, void *lower_inode);
 615 void ecryptfs_init_inode(struct inode *inode, struct inode *lower_inode);
 616 ssize_t
 617 ecryptfs_getxattr_lower(struct dentry *lower_dentry, const char *name,
 618                         void *value, size_t size);
 619 int
 620 ecryptfs_setxattr(struct dentry *dentry, const char *name, const void *value,
 621                   size_t size, int flags);
 622 int ecryptfs_read_xattr_region(char *page_virt, struct inode *ecryptfs_inode);
 623 int ecryptfs_process_helo(uid_t euid, struct user_namespace *user_ns,
 624                           struct pid *pid);
 625 int ecryptfs_process_quit(uid_t euid, struct user_namespace *user_ns,
 626                           struct pid *pid);
 627 int ecryptfs_process_response(struct ecryptfs_message *msg, uid_t euid,
 628                               struct user_namespace *user_ns, struct pid *pid,
 629                               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
 637 void
 638 ecryptfs_write_header_metadata(char *virt,
 639                                struct ecryptfs_crypt_stat *crypt_stat,
 640                                size_t *written);
 641 int ecryptfs_add_keysig(struct ecryptfs_crypt_stat *crypt_stat, char *sig);
 642 int
 643 ecryptfs_add_global_auth_tok(struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
 644                            char *sig);
 645 int ecryptfs_get_global_auth_tok_for_sig(
 646         struct ecryptfs_global_auth_tok **global_auth_tok,
 647         struct ecryptfs_mount_crypt_stat *mount_crypt_stat, char *sig);
 648 int
 649 ecryptfs_add_new_key_tfm(struct ecryptfs_key_tfm **key_tfm, char *cipher_name,
 650                          size_t key_size);
 651 int ecryptfs_init_crypto(void);
 652 int ecryptfs_destroy_crypto(void);
 653 int ecryptfs_tfm_exists(char *cipher_name, struct ecryptfs_key_tfm **key_tfm);
 654 int ecryptfs_get_tfm_and_mutex_for_cipher_name(struct crypto_blkcipher **tfm,
 655                                                struct mutex **tfm_mutex,
 656                                                char *cipher_name);
 657 int ecryptfs_keyring_auth_tok_for_sig(struct key **auth_tok_key,
 658                                       struct ecryptfs_auth_tok **auth_tok,
 659                                       char *sig);
 660 int ecryptfs_write_lower(struct inode *ecryptfs_inode, char *data,
 661                          loff_t offset, size_t size);
 662 int ecryptfs_write_lower_page_segment(struct inode *ecryptfs_inode,
 663                                       struct page *page_for_lower,
 664                                       size_t offset_in_page, size_t size);
 665 int ecryptfs_write(struct file *ecryptfs_file, char *data, loff_t offset,
 666                    size_t size);
 667 int ecryptfs_read_lower(char *data, loff_t offset, size_t size,
 668                         struct inode *ecryptfs_inode);
 669 int ecryptfs_read_lower_page_segment(struct page *page_for_ecryptfs,
 670                                      pgoff_t page_index,
 671                                      size_t offset_in_page, size_t size,
 672                                      struct inode *ecryptfs_inode);
 673 struct page *ecryptfs_get_locked_page(struct file *file, loff_t index);
 674 int ecryptfs_exorcise_daemon(struct ecryptfs_daemon *daemon);
 675 int ecryptfs_find_daemon_by_euid(struct ecryptfs_daemon **daemon, uid_t euid,
 676                                  struct user_namespace *user_ns);
 677 int ecryptfs_parse_packet_length(unsigned char *data, size_t *size,
 678                                  size_t *length_size);
 679 int ecryptfs_write_packet_length(char *dest, size_t size,
 680                                  size_t *packet_size_length);
 681 int ecryptfs_init_ecryptfs_miscdev(void);
 682 void ecryptfs_destroy_ecryptfs_miscdev(void);
 683 int ecryptfs_send_miscdev(char *data, size_t data_size,
 684                           struct ecryptfs_msg_ctx *msg_ctx, u8 msg_type,
 685                           u16 msg_flags, struct ecryptfs_daemon *daemon);
 686 void ecryptfs_msg_ctx_alloc_to_free(struct ecryptfs_msg_ctx *msg_ctx);
 687 int
 688 ecryptfs_spawn_daemon(struct ecryptfs_daemon **daemon, uid_t euid,
 689                       struct user_namespace *user_ns, struct pid *pid);
 690 int ecryptfs_init_kthread(void);
 691 void ecryptfs_destroy_kthread(void);
 692 int ecryptfs_privileged_open(struct file **lower_file,
 693                              struct dentry *lower_dentry,
 694                              struct vfsmount *lower_mnt);
 695 int ecryptfs_init_persistent_file(struct dentry *ecryptfs_dentry);
 696
 697 #endif /* #ifndef ECRYPTFS_KERNEL_H */