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