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