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