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