eCryptfs: Return error when lower file pointer is NULL
[linux-3.10.git] / 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 <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 /* Constraint: ECRYPTFS_FILENAME_MIN_RANDOM_PREPEND_BYTES >=
155  * ECRYPTFS_MAX_IV_BYTES */
156 #define ECRYPTFS_FILENAME_MIN_RANDOM_PREPEND_BYTES 16
157 #define ECRYPTFS_NON_NULL 0x42 /* A reasonable substitute for NULL */
158 #define MD5_DIGEST_SIZE 16
159 #define ECRYPTFS_TAG_70_DIGEST_SIZE MD5_DIGEST_SIZE
160 #define ECRYPTFS_FEK_ENCRYPTED_FILENAME_PREFIX "ECRYPTFS_FEK_ENCRYPTED."
161 #define ECRYPTFS_FEK_ENCRYPTED_FILENAME_PREFIX_SIZE 23
162 #define ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX "ECRYPTFS_FNEK_ENCRYPTED."
163 #define ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX_SIZE 24
164 #define ECRYPTFS_ENCRYPTED_DENTRY_NAME_LEN (18 + 1 + 4 + 1 + 32)
165
166 struct ecryptfs_key_sig {
167         struct list_head crypt_stat_list;
168         char keysig[ECRYPTFS_SIG_SIZE_HEX + 1];
169 };
170
171 struct ecryptfs_filename {
172         struct list_head crypt_stat_list;
173 #define ECRYPTFS_FILENAME_CONTAINS_DECRYPTED 0x00000001
174         u32 flags;
175         u32 seq_no;
176         char *filename;
177         char *encrypted_filename;
178         size_t filename_size;
179         size_t encrypted_filename_size;
180         char fnek_sig[ECRYPTFS_SIG_SIZE_HEX];
181         char dentry_name[ECRYPTFS_ENCRYPTED_DENTRY_NAME_LEN + 1];
182 };
183
184 /**
185  * This is the primary struct associated with each encrypted file.
186  *
187  * TODO: cache align/pack?
188  */
189 struct ecryptfs_crypt_stat {
190 #define ECRYPTFS_STRUCT_INITIALIZED   0x00000001
191 #define ECRYPTFS_POLICY_APPLIED       0x00000002
192 #define ECRYPTFS_ENCRYPTED            0x00000004
193 #define ECRYPTFS_SECURITY_WARNING     0x00000008
194 #define ECRYPTFS_ENABLE_HMAC          0x00000010
195 #define ECRYPTFS_ENCRYPT_IV_PAGES     0x00000020
196 #define ECRYPTFS_KEY_VALID            0x00000040
197 #define ECRYPTFS_METADATA_IN_XATTR    0x00000080
198 #define ECRYPTFS_VIEW_AS_ENCRYPTED    0x00000100
199 #define ECRYPTFS_KEY_SET              0x00000200
200 #define ECRYPTFS_ENCRYPT_FILENAMES    0x00000400
201 #define ECRYPTFS_ENCFN_USE_MOUNT_FNEK 0x00000800
202 #define ECRYPTFS_ENCFN_USE_FEK        0x00001000
203 #define ECRYPTFS_UNLINK_SIGS          0x00002000
204 #define ECRYPTFS_I_SIZE_INITIALIZED   0x00004000
205         u32 flags;
206         unsigned int file_version;
207         size_t iv_bytes;
208         size_t metadata_size;
209         size_t extent_size; /* Data extent size; default is 4096 */
210         size_t key_size;
211         size_t extent_shift;
212         unsigned int extent_mask;
213         struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
214         struct crypto_blkcipher *tfm;
215         struct crypto_hash *hash_tfm; /* Crypto context for generating
216                                        * the initialization vectors */
217         unsigned char cipher[ECRYPTFS_MAX_CIPHER_NAME_SIZE];
218         unsigned char key[ECRYPTFS_MAX_KEY_BYTES];
219         unsigned char root_iv[ECRYPTFS_MAX_IV_BYTES];
220         struct list_head keysig_list;
221         struct mutex keysig_list_mutex;
222         struct mutex cs_tfm_mutex;
223         struct mutex cs_hash_tfm_mutex;
224         struct mutex cs_mutex;
225 };
226
227 /* inode private data. */
228 struct ecryptfs_inode_info {
229         struct inode vfs_inode;
230         struct inode *wii_inode;
231         struct mutex lower_file_mutex;
232         atomic_t lower_file_count;
233         struct file *lower_file;
234         struct ecryptfs_crypt_stat crypt_stat;
235 };
236
237 /* dentry private data. Each dentry must keep track of a lower
238  * vfsmount too. */
239 struct ecryptfs_dentry_info {
240         struct path lower_path;
241         struct ecryptfs_crypt_stat *crypt_stat;
242 };
243
244 /**
245  * ecryptfs_global_auth_tok - A key used to encrypt all new files under the mountpoint
246  * @flags: Status flags
247  * @mount_crypt_stat_list: These auth_toks hang off the mount-wide
248  *                         cryptographic context. Every time a new
249  *                         inode comes into existence, eCryptfs copies
250  *                         the auth_toks on that list to the set of
251  *                         auth_toks on the inode's crypt_stat
252  * @global_auth_tok_key: The key from the user's keyring for the sig
253  * @global_auth_tok: The key contents
254  * @sig: The key identifier
255  *
256  * ecryptfs_global_auth_tok structs refer to authentication token keys
257  * in the user keyring that apply to newly created files. A list of
258  * these objects hangs off of the mount_crypt_stat struct for any
259  * given eCryptfs mount. This struct maintains a reference to both the
260  * key contents and the key itself so that the key can be put on
261  * unmount.
262  */
263 struct ecryptfs_global_auth_tok {
264 #define ECRYPTFS_AUTH_TOK_INVALID 0x00000001
265 #define ECRYPTFS_AUTH_TOK_FNEK    0x00000002
266         u32 flags;
267         struct list_head mount_crypt_stat_list;
268         struct key *global_auth_tok_key;
269         unsigned char sig[ECRYPTFS_SIG_SIZE_HEX + 1];
270 };
271
272 /**
273  * ecryptfs_key_tfm - Persistent key tfm
274  * @key_tfm: crypto API handle to the key
275  * @key_size: Key size in bytes
276  * @key_tfm_mutex: Mutex to ensure only one operation in eCryptfs is
277  *                 using the persistent TFM at any point in time
278  * @key_tfm_list: Handle to hang this off the module-wide TFM list
279  * @cipher_name: String name for the cipher for this TFM
280  *
281  * Typically, eCryptfs will use the same ciphers repeatedly throughout
282  * the course of its operations. In order to avoid unnecessarily
283  * destroying and initializing the same cipher repeatedly, eCryptfs
284  * keeps a list of crypto API contexts around to use when needed.
285  */
286 struct ecryptfs_key_tfm {
287         struct crypto_blkcipher *key_tfm;
288         size_t key_size;
289         struct mutex key_tfm_mutex;
290         struct list_head key_tfm_list;
291         unsigned char cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE + 1];
292 };
293
294 extern struct mutex key_tfm_list_mutex;
295
296 /**
297  * This struct is to enable a mount-wide passphrase/salt combo. This
298  * is more or less a stopgap to provide similar functionality to other
299  * crypto filesystems like EncFS or CFS until full policy support is
300  * implemented in eCryptfs.
301  */
302 struct ecryptfs_mount_crypt_stat {
303         /* Pointers to memory we do not own, do not free these */
304 #define ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED 0x00000001
305 #define ECRYPTFS_XATTR_METADATA_ENABLED        0x00000002
306 #define ECRYPTFS_ENCRYPTED_VIEW_ENABLED        0x00000004
307 #define ECRYPTFS_MOUNT_CRYPT_STAT_INITIALIZED  0x00000008
308 #define ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES      0x00000010
309 #define ECRYPTFS_GLOBAL_ENCFN_USE_MOUNT_FNEK   0x00000020
310 #define ECRYPTFS_GLOBAL_ENCFN_USE_FEK          0x00000040
311 #define ECRYPTFS_GLOBAL_MOUNT_AUTH_TOK_ONLY    0x00000080
312         u32 flags;
313         struct list_head global_auth_tok_list;
314         struct mutex global_auth_tok_list_mutex;
315         size_t global_default_cipher_key_size;
316         size_t global_default_fn_cipher_key_bytes;
317         unsigned char global_default_cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE
318                                                  + 1];
319         unsigned char global_default_fn_cipher_name[
320                 ECRYPTFS_MAX_CIPHER_NAME_SIZE + 1];
321         char global_default_fnek_sig[ECRYPTFS_SIG_SIZE_HEX + 1];
322 };
323
324 /* superblock private data. */
325 struct ecryptfs_sb_info {
326         struct super_block *wsi_sb;
327         struct ecryptfs_mount_crypt_stat mount_crypt_stat;
328         struct backing_dev_info bdi;
329 };
330
331 /* file private data. */
332 struct ecryptfs_file_info {
333         struct file *wfi_file;
334         struct ecryptfs_crypt_stat *crypt_stat;
335 };
336
337 /* auth_tok <=> encrypted_session_key mappings */
338 struct ecryptfs_auth_tok_list_item {
339         unsigned char encrypted_session_key[ECRYPTFS_MAX_KEY_BYTES];
340         struct list_head list;
341         struct ecryptfs_auth_tok auth_tok;
342 };
343
344 struct ecryptfs_message {
345         /* Can never be greater than ecryptfs_message_buf_len */
346         /* Used to find the parent msg_ctx */
347         /* Inherits from msg_ctx->index */
348         u32 index;
349         u32 data_len;
350         u8 data[];
351 };
352
353 struct ecryptfs_msg_ctx {
354 #define ECRYPTFS_MSG_CTX_STATE_FREE     0x01
355 #define ECRYPTFS_MSG_CTX_STATE_PENDING  0x02
356 #define ECRYPTFS_MSG_CTX_STATE_DONE     0x03
357 #define ECRYPTFS_MSG_CTX_STATE_NO_REPLY 0x04
358         u8 state;
359 #define ECRYPTFS_MSG_HELO 100
360 #define ECRYPTFS_MSG_QUIT 101
361 #define ECRYPTFS_MSG_REQUEST 102
362 #define ECRYPTFS_MSG_RESPONSE 103
363         u8 type;
364         u32 index;
365         /* Counter converts to a sequence number. Each message sent
366          * out for which we expect a response has an associated
367          * sequence number. The response must have the same sequence
368          * number as the counter for the msg_stc for the message to be
369          * valid. */
370         u32 counter;
371         size_t msg_size;
372         struct ecryptfs_message *msg;
373         struct task_struct *task;
374         struct list_head node;
375         struct list_head daemon_out_list;
376         struct mutex mux;
377 };
378
379 struct ecryptfs_daemon;
380
381 struct ecryptfs_daemon {
382 #define ECRYPTFS_DAEMON_IN_READ      0x00000001
383 #define ECRYPTFS_DAEMON_IN_POLL      0x00000002
384 #define ECRYPTFS_DAEMON_ZOMBIE       0x00000004
385 #define ECRYPTFS_DAEMON_MISCDEV_OPEN 0x00000008
386         u32 flags;
387         u32 num_queued_msg_ctx;
388         struct pid *pid;
389         uid_t euid;
390         struct user_namespace *user_ns;
391         struct task_struct *task;
392         struct mutex mux;
393         struct list_head msg_ctx_out_queue;
394         wait_queue_head_t wait;
395         struct hlist_node euid_chain;
396 };
397
398 extern struct mutex ecryptfs_daemon_hash_mux;
399
400 static inline size_t
401 ecryptfs_lower_header_size(struct ecryptfs_crypt_stat *crypt_stat)
402 {
403         if (crypt_stat->flags & ECRYPTFS_METADATA_IN_XATTR)
404                 return 0;
405         return crypt_stat->metadata_size;
406 }
407
408 static inline struct ecryptfs_file_info *
409 ecryptfs_file_to_private(struct file *file)
410 {
411         return file->private_data;
412 }
413
414 static inline void
415 ecryptfs_set_file_private(struct file *file,
416                           struct ecryptfs_file_info *file_info)
417 {
418         file->private_data = file_info;
419 }
420
421 static inline struct file *ecryptfs_file_to_lower(struct file *file)
422 {
423         return ((struct ecryptfs_file_info *)file->private_data)->wfi_file;
424 }
425
426 static inline void
427 ecryptfs_set_file_lower(struct file *file, struct file *lower_file)
428 {
429         ((struct ecryptfs_file_info *)file->private_data)->wfi_file =
430                 lower_file;
431 }
432
433 static inline struct ecryptfs_inode_info *
434 ecryptfs_inode_to_private(struct inode *inode)
435 {
436         return container_of(inode, struct ecryptfs_inode_info, vfs_inode);
437 }
438
439 static inline struct inode *ecryptfs_inode_to_lower(struct inode *inode)
440 {
441         return ecryptfs_inode_to_private(inode)->wii_inode;
442 }
443
444 static inline void
445 ecryptfs_set_inode_lower(struct inode *inode, struct inode *lower_inode)
446 {
447         ecryptfs_inode_to_private(inode)->wii_inode = lower_inode;
448 }
449
450 static inline struct ecryptfs_sb_info *
451 ecryptfs_superblock_to_private(struct super_block *sb)
452 {
453         return (struct ecryptfs_sb_info *)sb->s_fs_info;
454 }
455
456 static inline void
457 ecryptfs_set_superblock_private(struct super_block *sb,
458                                 struct ecryptfs_sb_info *sb_info)
459 {
460         sb->s_fs_info = sb_info;
461 }
462
463 static inline struct super_block *
464 ecryptfs_superblock_to_lower(struct super_block *sb)
465 {
466         return ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb;
467 }
468
469 static inline void
470 ecryptfs_set_superblock_lower(struct super_block *sb,
471                               struct super_block *lower_sb)
472 {
473         ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb = lower_sb;
474 }
475
476 static inline struct ecryptfs_dentry_info *
477 ecryptfs_dentry_to_private(struct dentry *dentry)
478 {
479         return (struct ecryptfs_dentry_info *)dentry->d_fsdata;
480 }
481
482 static inline void
483 ecryptfs_set_dentry_private(struct dentry *dentry,
484                             struct ecryptfs_dentry_info *dentry_info)
485 {
486         dentry->d_fsdata = dentry_info;
487 }
488
489 static inline struct dentry *
490 ecryptfs_dentry_to_lower(struct dentry *dentry)
491 {
492         return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry;
493 }
494
495 static inline void
496 ecryptfs_set_dentry_lower(struct dentry *dentry, struct dentry *lower_dentry)
497 {
498         ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry =
499                 lower_dentry;
500 }
501
502 static inline struct vfsmount *
503 ecryptfs_dentry_to_lower_mnt(struct dentry *dentry)
504 {
505         return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt;
506 }
507
508 static inline void
509 ecryptfs_set_dentry_lower_mnt(struct dentry *dentry, struct vfsmount *lower_mnt)
510 {
511         ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt =
512                 lower_mnt;
513 }
514
515 #define ecryptfs_printk(type, fmt, arg...) \
516         __ecryptfs_printk(type "%s: " fmt, __func__, ## arg);
517 __attribute__ ((format(printf, 1, 2)))
518 void __ecryptfs_printk(const char *fmt, ...);
519
520 extern const struct file_operations ecryptfs_main_fops;
521 extern const struct file_operations ecryptfs_dir_fops;
522 extern const struct inode_operations ecryptfs_main_iops;
523 extern const struct inode_operations ecryptfs_dir_iops;
524 extern const struct inode_operations ecryptfs_symlink_iops;
525 extern const struct super_operations ecryptfs_sops;
526 extern const struct dentry_operations ecryptfs_dops;
527 extern const struct address_space_operations ecryptfs_aops;
528 extern int ecryptfs_verbosity;
529 extern unsigned int ecryptfs_message_buf_len;
530 extern signed long ecryptfs_message_wait_timeout;
531 extern unsigned int ecryptfs_number_of_users;
532
533 extern struct kmem_cache *ecryptfs_auth_tok_list_item_cache;
534 extern struct kmem_cache *ecryptfs_file_info_cache;
535 extern struct kmem_cache *ecryptfs_dentry_info_cache;
536 extern struct kmem_cache *ecryptfs_inode_info_cache;
537 extern struct kmem_cache *ecryptfs_sb_info_cache;
538 extern struct kmem_cache *ecryptfs_header_cache;
539 extern struct kmem_cache *ecryptfs_xattr_cache;
540 extern struct kmem_cache *ecryptfs_key_record_cache;
541 extern struct kmem_cache *ecryptfs_key_sig_cache;
542 extern struct kmem_cache *ecryptfs_global_auth_tok_cache;
543 extern struct kmem_cache *ecryptfs_key_tfm_cache;
544 extern struct kmem_cache *ecryptfs_open_req_cache;
545
546 struct ecryptfs_open_req {
547 #define ECRYPTFS_REQ_PROCESSED 0x00000001
548 #define ECRYPTFS_REQ_DROPPED   0x00000002
549 #define ECRYPTFS_REQ_ZOMBIE    0x00000004
550         u32 flags;
551         struct file **lower_file;
552         struct dentry *lower_dentry;
553         struct vfsmount *lower_mnt;
554         wait_queue_head_t wait;
555         struct mutex mux;
556         struct list_head kthread_ctl_list;
557 };
558
559 struct inode *ecryptfs_get_inode(struct inode *lower_inode,
560                                  struct super_block *sb);
561 void ecryptfs_i_size_init(const char *page_virt, struct inode *inode);
562 int ecryptfs_decode_and_decrypt_filename(char **decrypted_name,
563                                          size_t *decrypted_name_size,
564                                          struct dentry *ecryptfs_dentry,
565                                          const char *name, size_t name_size);
566 int ecryptfs_fill_zeros(struct file *file, loff_t new_length);
567 int ecryptfs_encrypt_and_encode_filename(
568         char **encoded_name,
569         size_t *encoded_name_size,
570         struct ecryptfs_crypt_stat *crypt_stat,
571         struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
572         const char *name, size_t name_size);
573 struct dentry *ecryptfs_lower_dentry(struct dentry *this_dentry);
574 void ecryptfs_dump_hex(char *data, int bytes);
575 int virt_to_scatterlist(const void *addr, int size, struct scatterlist *sg,
576                         int sg_size);
577 int ecryptfs_compute_root_iv(struct ecryptfs_crypt_stat *crypt_stat);
578 void ecryptfs_rotate_iv(unsigned char *iv);
579 void ecryptfs_init_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
580 void ecryptfs_destroy_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
581 void ecryptfs_destroy_mount_crypt_stat(
582         struct ecryptfs_mount_crypt_stat *mount_crypt_stat);
583 int ecryptfs_init_crypt_ctx(struct ecryptfs_crypt_stat *crypt_stat);
584 int ecryptfs_write_inode_size_to_metadata(struct inode *ecryptfs_inode);
585 int ecryptfs_encrypt_page(struct page *page);
586 int ecryptfs_decrypt_page(struct page *page);
587 int ecryptfs_write_metadata(struct dentry *ecryptfs_dentry);
588 int ecryptfs_read_metadata(struct dentry *ecryptfs_dentry);
589 int ecryptfs_new_file_context(struct dentry *ecryptfs_dentry);
590 void ecryptfs_write_crypt_stat_flags(char *page_virt,
591                                      struct ecryptfs_crypt_stat *crypt_stat,
592                                      size_t *written);
593 int ecryptfs_read_and_validate_header_region(struct inode *inode);
594 int ecryptfs_read_and_validate_xattr_region(struct dentry *dentry,
595                                             struct inode *inode);
596 u8 ecryptfs_code_for_cipher_string(char *cipher_name, size_t key_bytes);
597 int ecryptfs_cipher_code_to_string(char *str, u8 cipher_code);
598 void ecryptfs_set_default_sizes(struct ecryptfs_crypt_stat *crypt_stat);
599 int ecryptfs_generate_key_packet_set(char *dest_base,
600                                      struct ecryptfs_crypt_stat *crypt_stat,
601                                      struct dentry *ecryptfs_dentry,
602                                      size_t *len, size_t max);
603 int
604 ecryptfs_parse_packet_set(struct ecryptfs_crypt_stat *crypt_stat,
605                           unsigned char *src, struct dentry *ecryptfs_dentry);
606 int ecryptfs_truncate(struct dentry *dentry, loff_t new_length);
607 ssize_t
608 ecryptfs_getxattr_lower(struct dentry *lower_dentry, const char *name,
609                         void *value, size_t size);
610 int
611 ecryptfs_setxattr(struct dentry *dentry, const char *name, const void *value,
612                   size_t size, int flags);
613 int ecryptfs_read_xattr_region(char *page_virt, struct inode *ecryptfs_inode);
614 int ecryptfs_process_helo(uid_t euid, struct user_namespace *user_ns,
615                           struct pid *pid);
616 int ecryptfs_process_quit(uid_t euid, struct user_namespace *user_ns,
617                           struct pid *pid);
618 int ecryptfs_process_response(struct ecryptfs_message *msg, uid_t euid,
619                               struct user_namespace *user_ns, struct pid *pid,
620                               u32 seq);
621 int ecryptfs_send_message(char *data, int data_len,
622                           struct ecryptfs_msg_ctx **msg_ctx);
623 int ecryptfs_wait_for_response(struct ecryptfs_msg_ctx *msg_ctx,
624                                struct ecryptfs_message **emsg);
625 int ecryptfs_init_messaging(void);
626 void ecryptfs_release_messaging(void);
627
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, u32 global_auth_tok_flags);
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_tfm_exists(char *cipher_name, struct ecryptfs_key_tfm **key_tfm);
645 int ecryptfs_get_tfm_and_mutex_for_cipher_name(struct crypto_blkcipher **tfm,
646                                                struct mutex **tfm_mutex,
647                                                char *cipher_name);
648 int ecryptfs_keyring_auth_tok_for_sig(struct key **auth_tok_key,
649                                       struct ecryptfs_auth_tok **auth_tok,
650                                       char *sig);
651 int ecryptfs_write_lower(struct inode *ecryptfs_inode, char *data,
652                          loff_t offset, size_t size);
653 int ecryptfs_write_lower_page_segment(struct inode *ecryptfs_inode,
654                                       struct page *page_for_lower,
655                                       size_t offset_in_page, size_t size);
656 int ecryptfs_write(struct inode *inode, char *data, loff_t offset, size_t size);
657 int ecryptfs_read_lower(char *data, loff_t offset, size_t size,
658                         struct inode *ecryptfs_inode);
659 int ecryptfs_read_lower_page_segment(struct page *page_for_ecryptfs,
660                                      pgoff_t page_index,
661                                      size_t offset_in_page, size_t size,
662                                      struct inode *ecryptfs_inode);
663 struct page *ecryptfs_get_locked_page(struct inode *inode, loff_t index);
664 int ecryptfs_exorcise_daemon(struct ecryptfs_daemon *daemon);
665 int ecryptfs_find_daemon_by_euid(struct ecryptfs_daemon **daemon, uid_t euid,
666                                  struct user_namespace *user_ns);
667 int ecryptfs_parse_packet_length(unsigned char *data, size_t *size,
668                                  size_t *length_size);
669 int ecryptfs_write_packet_length(char *dest, size_t size,
670                                  size_t *packet_size_length);
671 int ecryptfs_init_ecryptfs_miscdev(void);
672 void ecryptfs_destroy_ecryptfs_miscdev(void);
673 int ecryptfs_send_miscdev(char *data, size_t data_size,
674                           struct ecryptfs_msg_ctx *msg_ctx, u8 msg_type,
675                           u16 msg_flags, struct ecryptfs_daemon *daemon);
676 void ecryptfs_msg_ctx_alloc_to_free(struct ecryptfs_msg_ctx *msg_ctx);
677 int
678 ecryptfs_spawn_daemon(struct ecryptfs_daemon **daemon, uid_t euid,
679                       struct user_namespace *user_ns, struct pid *pid);
680 int ecryptfs_init_kthread(void);
681 void ecryptfs_destroy_kthread(void);
682 int ecryptfs_privileged_open(struct file **lower_file,
683                              struct dentry *lower_dentry,
684                              struct vfsmount *lower_mnt,
685                              const struct cred *cred);
686 int ecryptfs_get_lower_file(struct dentry *dentry, struct inode *inode);
687 void ecryptfs_put_lower_file(struct inode *inode);
688 int
689 ecryptfs_write_tag_70_packet(char *dest, size_t *remaining_bytes,
690                              size_t *packet_size,
691                              struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
692                              char *filename, size_t filename_size);
693 int
694 ecryptfs_parse_tag_70_packet(char **filename, size_t *filename_size,
695                              size_t *packet_size,
696                              struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
697                              char *data, size_t max_packet_size);
698 int ecryptfs_derive_iv(char *iv, struct ecryptfs_crypt_stat *crypt_stat,
699                        loff_t offset);
700
701 #endif /* #ifndef ECRYPTFS_KERNEL_H */