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 0x03
  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 0x03
  71 #define ECRYPTFS_DEFAULT_EXTENT_SIZE 4096
  72 #define ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE 8192
  73 #define ECRYPTFS_DEFAULT_MSG_CTX_ELEMS 32
  74 #define ECRYPTFS_DEFAULT_SEND_TIMEOUT HZ
  75 #define ECRYPTFS_MAX_MSG_CTX_TTL (HZ*3)
  76 #define ECRYPTFS_NLMSG_HELO 100
  77 #define ECRYPTFS_NLMSG_QUIT 101
  78 #define ECRYPTFS_NLMSG_REQUEST 102
  79 #define ECRYPTFS_NLMSG_RESPONSE 103
  80 #define ECRYPTFS_MAX_PKI_NAME_BYTES 16
  81 #define ECRYPTFS_DEFAULT_NUM_USERS 4
  82 #define ECRYPTFS_MAX_NUM_USERS 32768
  83 #define ECRYPTFS_TRANSPORT_NETLINK 0
  84 #define ECRYPTFS_TRANSPORT_CONNECTOR 1
  85 #define ECRYPTFS_TRANSPORT_RELAYFS 2
  86 #define ECRYPTFS_DEFAULT_TRANSPORT ECRYPTFS_TRANSPORT_NETLINK
  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_SUPER_MAGIC 0xf15f
 196 #define ECRYPTFS_MAX_KEYSET_SIZE 1024
 197 #define ECRYPTFS_MAX_CIPHER_NAME_SIZE 32
 198 #define ECRYPTFS_MAX_NUM_ENC_KEYS 64
 199 #define ECRYPTFS_MAX_IV_BYTES 16        /* 128 bits */
 200 #define ECRYPTFS_SALT_BYTES 2
 201 #define MAGIC_ECRYPTFS_MARKER 0x3c81b7f5
 202 #define MAGIC_ECRYPTFS_MARKER_SIZE_BYTES 8      /* 4*2 */
 203 #define ECRYPTFS_FILE_SIZE_BYTES (sizeof(u64))
 204 #define ECRYPTFS_DEFAULT_CIPHER "aes"
 205 #define ECRYPTFS_DEFAULT_KEY_BYTES 16
 206 #define ECRYPTFS_DEFAULT_HASH "md5"
 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 MD5_DIGEST_SIZE 16
 215
 216 struct ecryptfs_key_sig {
 217         struct list_head crypt_stat_list;
 218         char keysig[ECRYPTFS_SIG_SIZE_HEX];
 219 };
 220
 221 /**
 222  * This is the primary struct associated with each encrypted file.
 223  *
 224  * TODO: cache align/pack?
 225  */
 226 struct ecryptfs_crypt_stat {
 227 #define ECRYPTFS_STRUCT_INITIALIZED 0x00000001
 228 #define ECRYPTFS_POLICY_APPLIED     0x00000002
 229 #define ECRYPTFS_NEW_FILE           0x00000004
 230 #define ECRYPTFS_ENCRYPTED          0x00000008
 231 #define ECRYPTFS_SECURITY_WARNING   0x00000010
 232 #define ECRYPTFS_ENABLE_HMAC        0x00000020
 233 #define ECRYPTFS_ENCRYPT_IV_PAGES   0x00000040
 234 #define ECRYPTFS_KEY_VALID          0x00000080
 235 #define ECRYPTFS_METADATA_IN_XATTR  0x00000100
 236 #define ECRYPTFS_VIEW_AS_ENCRYPTED  0x00000200
 237         u32 flags;
 238         unsigned int file_version;
 239         size_t iv_bytes;
 240         size_t num_header_extents_at_front;
 241         size_t extent_size; /* Data extent size; default is 4096 */
 242         size_t key_size;
 243         size_t extent_shift;
 244         unsigned int extent_mask;
 245         struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
 246         struct crypto_blkcipher *tfm;
 247         struct crypto_hash *hash_tfm; /* Crypto context for generating
 248                                        * the initialization vectors */
 249         unsigned char cipher[ECRYPTFS_MAX_CIPHER_NAME_SIZE];
 250         unsigned char key[ECRYPTFS_MAX_KEY_BYTES];
 251         unsigned char root_iv[ECRYPTFS_MAX_IV_BYTES];
 252         struct list_head keysig_list;
 253         struct mutex keysig_list_mutex;
 254         struct mutex cs_tfm_mutex;
 255         struct mutex cs_hash_tfm_mutex;
 256         struct mutex cs_mutex;
 257 };
 258
 259 /* inode private data. */
 260 struct ecryptfs_inode_info {
 261         struct inode vfs_inode;
 262         struct inode *wii_inode;
 263         struct file *lower_file;
 264         struct mutex lower_file_mutex;
 265         struct ecryptfs_crypt_stat crypt_stat;
 266 };
 267
 268 /* dentry private data. Each dentry must keep track of a lower
 269  * vfsmount too. */
 270 struct ecryptfs_dentry_info {
 271         struct path lower_path;
 272         struct ecryptfs_crypt_stat *crypt_stat;
 273 };
 274
 275 /**
 276  * ecryptfs_global_auth_tok - A key used to encrypt all new files under the mountpoint
 277  * @flags: Status flags
 278  * @mount_crypt_stat_list: These auth_toks hang off the mount-wide
 279  *                         cryptographic context. Every time a new
 280  *                         inode comes into existence, eCryptfs copies
 281  *                         the auth_toks on that list to the set of
 282  *                         auth_toks on the inode's crypt_stat
 283  * @global_auth_tok_key: The key from the user's keyring for the sig
 284  * @global_auth_tok: The key contents
 285  * @sig: The key identifier
 286  *
 287  * ecryptfs_global_auth_tok structs refer to authentication token keys
 288  * in the user keyring that apply to newly created files. A list of
 289  * these objects hangs off of the mount_crypt_stat struct for any
 290  * given eCryptfs mount. This struct maintains a reference to both the
 291  * key contents and the key itself so that the key can be put on
 292  * unmount.
 293  */
 294 struct ecryptfs_global_auth_tok {
 295 #define ECRYPTFS_AUTH_TOK_INVALID 0x00000001
 296         u32 flags;
 297         struct list_head mount_crypt_stat_list;
 298         struct key *global_auth_tok_key;
 299         struct ecryptfs_auth_tok *global_auth_tok;
 300         unsigned char sig[ECRYPTFS_SIG_SIZE_HEX + 1];
 301 };
 302
 303 /**
 304  * ecryptfs_key_tfm - Persistent key tfm
 305  * @key_tfm: crypto API handle to the key
 306  * @key_size: Key size in bytes
 307  * @key_tfm_mutex: Mutex to ensure only one operation in eCryptfs is
 308  *                 using the persistent TFM at any point in time
 309  * @key_tfm_list: Handle to hang this off the module-wide TFM list
 310  * @cipher_name: String name for the cipher for this TFM
 311  *
 312  * Typically, eCryptfs will use the same ciphers repeatedly throughout
 313  * the course of its operations. In order to avoid unnecessarily
 314  * destroying and initializing the same cipher repeatedly, eCryptfs
 315  * keeps a list of crypto API contexts around to use when needed.
 316  */
 317 struct ecryptfs_key_tfm {
 318         struct crypto_blkcipher *key_tfm;
 319         size_t key_size;
 320         struct mutex key_tfm_mutex;
 321         struct list_head key_tfm_list;
 322         unsigned char cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE + 1];
 323 };
 324
 325 extern struct list_head key_tfm_list;
 326 extern struct mutex key_tfm_list_mutex;
 327
 328 /**
 329  * This struct is to enable a mount-wide passphrase/salt combo. This
 330  * is more or less a stopgap to provide similar functionality to other
 331  * crypto filesystems like EncFS or CFS until full policy support is
 332  * implemented in eCryptfs.
 333  */
 334 struct ecryptfs_mount_crypt_stat {
 335         /* Pointers to memory we do not own, do not free these */
 336 #define ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED 0x00000001
 337 #define ECRYPTFS_XATTR_METADATA_ENABLED        0x00000002
 338 #define ECRYPTFS_ENCRYPTED_VIEW_ENABLED        0x00000004
 339 #define ECRYPTFS_MOUNT_CRYPT_STAT_INITIALIZED  0x00000008
 340         u32 flags;
 341         struct list_head global_auth_tok_list;
 342         struct mutex global_auth_tok_list_mutex;
 343         size_t num_global_auth_toks;
 344         size_t global_default_cipher_key_size;
 345         unsigned char global_default_cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE
 346                                                  + 1];
 347 };
 348
 349 /* superblock private data. */
 350 struct ecryptfs_sb_info {
 351         struct super_block *wsi_sb;
 352         struct ecryptfs_mount_crypt_stat mount_crypt_stat;
 353 };
 354
 355 /* file private data. */
 356 struct ecryptfs_file_info {
 357         struct file *wfi_file;
 358         struct ecryptfs_crypt_stat *crypt_stat;
 359 };
 360
 361 /* auth_tok <=> encrypted_session_key mappings */
 362 struct ecryptfs_auth_tok_list_item {
 363         unsigned char encrypted_session_key[ECRYPTFS_MAX_KEY_BYTES];
 364         struct list_head list;
 365         struct ecryptfs_auth_tok auth_tok;
 366 };
 367
 368 struct ecryptfs_message {
 369         u32 index;
 370         u32 data_len;
 371         u8 data[];
 372 };
 373
 374 struct ecryptfs_msg_ctx {
 375 #define ECRYPTFS_MSG_CTX_STATE_FREE      0x0001
 376 #define ECRYPTFS_MSG_CTX_STATE_PENDING   0x0002
 377 #define ECRYPTFS_MSG_CTX_STATE_DONE      0x0003
 378         u32 state;
 379         unsigned int index;
 380         unsigned int counter;
 381         struct ecryptfs_message *msg;
 382         struct task_struct *task;
 383         struct list_head node;
 384         struct mutex mux;
 385 };
 386
 387 extern unsigned int ecryptfs_transport;
 388
 389 struct ecryptfs_daemon_id {
 390         pid_t pid;
 391         uid_t uid;
 392         struct hlist_node id_chain;
 393 };
 394
 395 static inline struct ecryptfs_file_info *
 396 ecryptfs_file_to_private(struct file *file)
 397 {
 398         return (struct ecryptfs_file_info *)file->private_data;
 399 }
 400
 401 static inline void
 402 ecryptfs_set_file_private(struct file *file,
 403                           struct ecryptfs_file_info *file_info)
 404 {
 405         file->private_data = file_info;
 406 }
 407
 408 static inline struct file *ecryptfs_file_to_lower(struct file *file)
 409 {
 410         return ((struct ecryptfs_file_info *)file->private_data)->wfi_file;
 411 }
 412
 413 static inline void
 414 ecryptfs_set_file_lower(struct file *file, struct file *lower_file)
 415 {
 416         ((struct ecryptfs_file_info *)file->private_data)->wfi_file =
 417                 lower_file;
 418 }
 419
 420 static inline struct ecryptfs_inode_info *
 421 ecryptfs_inode_to_private(struct inode *inode)
 422 {
 423         return container_of(inode, struct ecryptfs_inode_info, vfs_inode);
 424 }
 425
 426 static inline struct inode *ecryptfs_inode_to_lower(struct inode *inode)
 427 {
 428         return ecryptfs_inode_to_private(inode)->wii_inode;
 429 }
 430
 431 static inline void
 432 ecryptfs_set_inode_lower(struct inode *inode, struct inode *lower_inode)
 433 {
 434         ecryptfs_inode_to_private(inode)->wii_inode = lower_inode;
 435 }
 436
 437 static inline struct ecryptfs_sb_info *
 438 ecryptfs_superblock_to_private(struct super_block *sb)
 439 {
 440         return (struct ecryptfs_sb_info *)sb->s_fs_info;
 441 }
 442
 443 static inline void
 444 ecryptfs_set_superblock_private(struct super_block *sb,
 445                                 struct ecryptfs_sb_info *sb_info)
 446 {
 447         sb->s_fs_info = sb_info;
 448 }
 449
 450 static inline struct super_block *
 451 ecryptfs_superblock_to_lower(struct super_block *sb)
 452 {
 453         return ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb;
 454 }
 455
 456 static inline void
 457 ecryptfs_set_superblock_lower(struct super_block *sb,
 458                               struct super_block *lower_sb)
 459 {
 460         ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb = lower_sb;
 461 }
 462
 463 static inline struct ecryptfs_dentry_info *
 464 ecryptfs_dentry_to_private(struct dentry *dentry)
 465 {
 466         return (struct ecryptfs_dentry_info *)dentry->d_fsdata;
 467 }
 468
 469 static inline void
 470 ecryptfs_set_dentry_private(struct dentry *dentry,
 471                             struct ecryptfs_dentry_info *dentry_info)
 472 {
 473         dentry->d_fsdata = dentry_info;
 474 }
 475
 476 static inline struct dentry *
 477 ecryptfs_dentry_to_lower(struct dentry *dentry)
 478 {
 479         return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry;
 480 }
 481
 482 static inline void
 483 ecryptfs_set_dentry_lower(struct dentry *dentry, struct dentry *lower_dentry)
 484 {
 485         ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry =
 486                 lower_dentry;
 487 }
 488
 489 static inline struct vfsmount *
 490 ecryptfs_dentry_to_lower_mnt(struct dentry *dentry)
 491 {
 492         return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt;
 493 }
 494
 495 static inline void
 496 ecryptfs_set_dentry_lower_mnt(struct dentry *dentry, struct vfsmount *lower_mnt)
 497 {
 498         ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt =
 499                 lower_mnt;
 500 }
 501
 502 #define ecryptfs_printk(type, fmt, arg...) \
 503         __ecryptfs_printk(type "%s: " fmt, __FUNCTION__, ## arg);
 504 void __ecryptfs_printk(const char *fmt, ...);
 505
 506 extern const struct file_operations ecryptfs_main_fops;
 507 extern const struct file_operations ecryptfs_dir_fops;
 508 extern const struct inode_operations ecryptfs_main_iops;
 509 extern const struct inode_operations ecryptfs_dir_iops;
 510 extern const struct inode_operations ecryptfs_symlink_iops;
 511 extern const struct super_operations ecryptfs_sops;
 512 extern struct dentry_operations ecryptfs_dops;
 513 extern struct address_space_operations ecryptfs_aops;
 514 extern int ecryptfs_verbosity;
 515 extern unsigned int ecryptfs_message_buf_len;
 516 extern signed long ecryptfs_message_wait_timeout;
 517 extern unsigned int ecryptfs_number_of_users;
 518
 519 extern struct kmem_cache *ecryptfs_auth_tok_list_item_cache;
 520 extern struct kmem_cache *ecryptfs_file_info_cache;
 521 extern struct kmem_cache *ecryptfs_dentry_info_cache;
 522 extern struct kmem_cache *ecryptfs_inode_info_cache;
 523 extern struct kmem_cache *ecryptfs_sb_info_cache;
 524 extern struct kmem_cache *ecryptfs_header_cache_0;
 525 extern struct kmem_cache *ecryptfs_header_cache_1;
 526 extern struct kmem_cache *ecryptfs_header_cache_2;
 527 extern struct kmem_cache *ecryptfs_xattr_cache;
 528 extern struct kmem_cache *ecryptfs_lower_page_cache;
 529 extern struct kmem_cache *ecryptfs_key_record_cache;
 530 extern struct kmem_cache *ecryptfs_key_sig_cache;
 531 extern struct kmem_cache *ecryptfs_global_auth_tok_cache;
 532 extern struct kmem_cache *ecryptfs_key_tfm_cache;
 533
 534 int ecryptfs_interpose(struct dentry *hidden_dentry,
 535                        struct dentry *this_dentry, struct super_block *sb,
 536                        int flag);
 537 int ecryptfs_fill_zeros(struct file *file, loff_t new_length);
 538 int ecryptfs_decode_filename(struct ecryptfs_crypt_stat *crypt_stat,
 539                              const char *name, int length,
 540                              char **decrypted_name);
 541 int ecryptfs_encode_filename(struct ecryptfs_crypt_stat *crypt_stat,
 542                              const char *name, int length,
 543                              char **encoded_name);
 544 struct dentry *ecryptfs_lower_dentry(struct dentry *this_dentry);
 545 void ecryptfs_dump_hex(char *data, int bytes);
 546 int virt_to_scatterlist(const void *addr, int size, struct scatterlist *sg,
 547                         int sg_size);
 548 int ecryptfs_compute_root_iv(struct ecryptfs_crypt_stat *crypt_stat);
 549 void ecryptfs_rotate_iv(unsigned char *iv);
 550 void ecryptfs_init_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
 551 void ecryptfs_destroy_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
 552 void ecryptfs_destroy_mount_crypt_stat(
 553         struct ecryptfs_mount_crypt_stat *mount_crypt_stat);
 554 int ecryptfs_init_crypt_ctx(struct ecryptfs_crypt_stat *crypt_stat);
 555 int ecryptfs_write_inode_size_to_metadata(struct inode *ecryptefs_inode);
 556 int ecryptfs_get_lower_page(struct page **lower_page, struct inode *lower_inode,
 557                             struct file *lower_file,
 558                             unsigned long lower_page_index, int byte_offset,
 559                             int region_bytes);
 560 int
 561 ecryptfs_commit_lower_page(struct page *lower_page, struct inode *lower_inode,
 562                            struct file *lower_file, int byte_offset,
 563                            int region_size);
 564 int ecryptfs_copy_page_to_lower(struct page *page, struct inode *lower_inode,
 565                                 struct file *lower_file);
 566 int ecryptfs_do_readpage(struct file *file, struct page *page,
 567                          pgoff_t lower_page_index);
 568 int ecryptfs_writepage_and_release_lower_page(struct page *lower_page,
 569                                               struct inode *lower_inode,
 570                                               struct writeback_control *wbc);
 571 int ecryptfs_encrypt_page(struct page *page);
 572 int ecryptfs_decrypt_page(struct page *page);
 573 int ecryptfs_write_metadata(struct dentry *ecryptfs_dentry,
 574                             struct file *lower_file);
 575 int ecryptfs_read_metadata(struct dentry *ecryptfs_dentry,
 576                            struct file *lower_file);
 577 int ecryptfs_new_file_context(struct dentry *ecryptfs_dentry);
 578 int ecryptfs_read_and_validate_header_region(char *data, struct dentry *dentry,
 579                                              struct vfsmount *mnt);
 580 int ecryptfs_read_and_validate_xattr_region(char *page_virt,
 581                                             struct dentry *ecryptfs_dentry);
 582 u16 ecryptfs_code_for_cipher_string(struct ecryptfs_crypt_stat *crypt_stat);
 583 int ecryptfs_cipher_code_to_string(char *str, u16 cipher_code);
 584 void ecryptfs_set_default_sizes(struct ecryptfs_crypt_stat *crypt_stat);
 585 int ecryptfs_generate_key_packet_set(char *dest_base,
 586                                      struct ecryptfs_crypt_stat *crypt_stat,
 587                                      struct dentry *ecryptfs_dentry,
 588                                      size_t *len, size_t max);
 589 int
 590 ecryptfs_parse_packet_set(struct ecryptfs_crypt_stat *crypt_stat,
 591                           unsigned char *src, struct dentry *ecryptfs_dentry);
 592 int ecryptfs_truncate(struct dentry *dentry, loff_t new_length);
 593 int ecryptfs_inode_test(struct inode *inode, void *candidate_lower_inode);
 594 int ecryptfs_inode_set(struct inode *inode, void *lower_inode);
 595 void ecryptfs_init_inode(struct inode *inode, struct inode *lower_inode);
 596 int ecryptfs_open_lower_file(struct file **lower_file,
 597                              struct dentry *lower_dentry,
 598                              struct vfsmount *lower_mnt, int flags);
 599 int ecryptfs_close_lower_file(struct file *lower_file);
 600 ssize_t ecryptfs_getxattr(struct dentry *dentry, const char *name, void *value,
 601                           size_t size);
 602 int
 603 ecryptfs_setxattr(struct dentry *dentry, const char *name, const void *value,
 604                   size_t size, int flags);
 605 int ecryptfs_read_xattr_region(char *page_virt, struct dentry *ecryptfs_dentry);
 606 int ecryptfs_process_helo(unsigned int transport, uid_t uid, pid_t pid);
 607 int ecryptfs_process_quit(uid_t uid, pid_t pid);
 608 int ecryptfs_process_response(struct ecryptfs_message *msg, uid_t uid,
 609                               pid_t pid, u32 seq);
 610 int ecryptfs_send_message(unsigned int transport, char *data, int data_len,
 611                           struct ecryptfs_msg_ctx **msg_ctx);
 612 int ecryptfs_wait_for_response(struct ecryptfs_msg_ctx *msg_ctx,
 613                                struct ecryptfs_message **emsg);
 614 int ecryptfs_init_messaging(unsigned int transport);
 615 void ecryptfs_release_messaging(unsigned int transport);
 616
 617 int ecryptfs_send_netlink(char *data, int data_len,
 618                           struct ecryptfs_msg_ctx *msg_ctx, u16 msg_type,
 619                           u16 msg_flags, pid_t daemon_pid);
 620 int ecryptfs_init_netlink(void);
 621 void ecryptfs_release_netlink(void);
 622
 623 int ecryptfs_send_connector(char *data, int data_len,
 624                             struct ecryptfs_msg_ctx *msg_ctx, u16 msg_type,
 625                             u16 msg_flags, pid_t daemon_pid);
 626 int ecryptfs_init_connector(void);
 627 void ecryptfs_release_connector(void);
 628 void
 629 ecryptfs_write_header_metadata(char *virt,
 630                                struct ecryptfs_crypt_stat *crypt_stat,
 631                                size_t *written);
 632 int ecryptfs_add_keysig(struct ecryptfs_crypt_stat *crypt_stat, char *sig);
 633 int
 634 ecryptfs_add_global_auth_tok(struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
 635                            char *sig);
 636 int ecryptfs_get_global_auth_tok_for_sig(
 637         struct ecryptfs_global_auth_tok **global_auth_tok,
 638         struct ecryptfs_mount_crypt_stat *mount_crypt_stat, char *sig);
 639 int
 640 ecryptfs_add_new_key_tfm(struct ecryptfs_key_tfm **key_tfm, char *cipher_name,
 641                          size_t key_size);
 642 int ecryptfs_init_crypto(void);
 643 int ecryptfs_destroy_crypto(void);
 644 int ecryptfs_get_tfm_and_mutex_for_cipher_name(struct crypto_blkcipher **tfm,
 645                                                struct mutex **tfm_mutex,
 646                                                char *cipher_name);
 647 int ecryptfs_keyring_auth_tok_for_sig(struct key **auth_tok_key,
 648                                       struct ecryptfs_auth_tok **auth_tok,
 649                                       char *sig);
 650 int ecryptfs_write_zeros(struct file *file, pgoff_t index, int start,
 651                          int num_zeros);
 652 void ecryptfs_lower_offset_for_extent(loff_t *offset, loff_t extent_num,
 653                                       struct ecryptfs_crypt_stat *crypt_stat);
 654 int ecryptfs_write_lower(struct inode *ecryptfs_inode, char *data,
 655                          loff_t offset, size_t size);
 656 int ecryptfs_write_lower_page_segment(struct inode *ecryptfs_inode,
 657                                       struct page *page_for_lower,
 658                                       size_t offset_in_page, size_t size);
 659 int ecryptfs_write(struct file *ecryptfs_file, char *data, loff_t offset,
 660                    size_t size);
 661 int ecryptfs_read_lower(char *data, loff_t offset, size_t size,
 662                         struct inode *ecryptfs_inode);
 663 int ecryptfs_read_lower_page_segment(struct page *page_for_ecryptfs,
 664                                      pgoff_t page_index,
 665                                      size_t offset_in_page, size_t size,
 666                                      struct inode *ecryptfs_inode);
 667 int ecryptfs_read(char *data, loff_t offset, size_t size,
 668                   struct file *ecryptfs_file);
 669 struct page *ecryptfs_get1page(struct file *file, loff_t index);
 670
 671 #endif /* #ifndef ECRYPTFS_KERNEL_H */