eCryptfs: integrate eCryptfs device handle into the module.
[linux-2.6.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 <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_DEVMISC               0x00000040
53 #define ECRYPTFS_VERSIONING_MASK (ECRYPTFS_VERSIONING_PASSPHRASE \
54                                   | ECRYPTFS_VERSIONING_PLAINTEXT_PASSTHROUGH \
55                                   | ECRYPTFS_VERSIONING_PUBKEY \
56                                   | ECRYPTFS_VERSIONING_XATTR \
57                                   | ECRYPTFS_VERSIONING_MULTKEY \
58                                   | ECRYPTFS_VERSIONING_DEVMISC)
59 #define ECRYPTFS_MAX_PASSWORD_LENGTH 64
60 #define ECRYPTFS_MAX_PASSPHRASE_BYTES ECRYPTFS_MAX_PASSWORD_LENGTH
61 #define ECRYPTFS_SALT_SIZE 8
62 #define ECRYPTFS_SALT_SIZE_HEX (ECRYPTFS_SALT_SIZE*2)
63 /* The original signature size is only for what is stored on disk; all
64  * in-memory representations are expanded hex, so it better adapted to
65  * be passed around or referenced on the command line */
66 #define ECRYPTFS_SIG_SIZE 8
67 #define ECRYPTFS_SIG_SIZE_HEX (ECRYPTFS_SIG_SIZE*2)
68 #define ECRYPTFS_PASSWORD_SIG_SIZE ECRYPTFS_SIG_SIZE_HEX
69 #define ECRYPTFS_MAX_KEY_BYTES 64
70 #define ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES 512
71 #define ECRYPTFS_DEFAULT_IV_BYTES 16
72 #define ECRYPTFS_FILE_VERSION 0x03
73 #define ECRYPTFS_DEFAULT_EXTENT_SIZE 4096
74 #define ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE 8192
75 #define ECRYPTFS_DEFAULT_MSG_CTX_ELEMS 32
76 #define ECRYPTFS_DEFAULT_SEND_TIMEOUT HZ
77 #define ECRYPTFS_MAX_MSG_CTX_TTL (HZ*3)
78 #define ECRYPTFS_MAX_PKI_NAME_BYTES 16
79 #define ECRYPTFS_DEFAULT_NUM_USERS 4
80 #define ECRYPTFS_MAX_NUM_USERS 32768
81 #define ECRYPTFS_TRANSPORT_NETLINK 0
82 #define ECRYPTFS_TRANSPORT_CONNECTOR 1
83 #define ECRYPTFS_TRANSPORT_RELAYFS 2
84 #define ECRYPTFS_TRANSPORT_MISCDEV 3
85 #define ECRYPTFS_DEFAULT_TRANSPORT ECRYPTFS_TRANSPORT_MISCDEV
86 #define ECRYPTFS_XATTR_NAME "user.ecryptfs"
87
88 #define RFC2440_CIPHER_DES3_EDE 0x02
89 #define RFC2440_CIPHER_CAST_5 0x03
90 #define RFC2440_CIPHER_BLOWFISH 0x04
91 #define RFC2440_CIPHER_AES_128 0x07
92 #define RFC2440_CIPHER_AES_192 0x08
93 #define RFC2440_CIPHER_AES_256 0x09
94 #define RFC2440_CIPHER_TWOFISH 0x0a
95 #define RFC2440_CIPHER_CAST_6 0x0b
96
97 #define RFC2440_CIPHER_RSA 0x01
98
99 /**
100  * For convenience, we may need to pass around the encrypted session
101  * key between kernel and userspace because the authentication token
102  * may not be extractable.  For example, the TPM may not release the
103  * private key, instead requiring the encrypted data and returning the
104  * decrypted data.
105  */
106 struct ecryptfs_session_key {
107 #define ECRYPTFS_USERSPACE_SHOULD_TRY_TO_DECRYPT 0x00000001
108 #define ECRYPTFS_USERSPACE_SHOULD_TRY_TO_ENCRYPT 0x00000002
109 #define ECRYPTFS_CONTAINS_DECRYPTED_KEY 0x00000004
110 #define ECRYPTFS_CONTAINS_ENCRYPTED_KEY 0x00000008
111         u32 flags;
112         u32 encrypted_key_size;
113         u32 decrypted_key_size;
114         u8 encrypted_key[ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES];
115         u8 decrypted_key[ECRYPTFS_MAX_KEY_BYTES];
116 };
117
118 struct ecryptfs_password {
119         u32 password_bytes;
120         s32 hash_algo;
121         u32 hash_iterations;
122         u32 session_key_encryption_key_bytes;
123 #define ECRYPTFS_PERSISTENT_PASSWORD 0x01
124 #define ECRYPTFS_SESSION_KEY_ENCRYPTION_KEY_SET 0x02
125         u32 flags;
126         /* Iterated-hash concatenation of salt and passphrase */
127         u8 session_key_encryption_key[ECRYPTFS_MAX_KEY_BYTES];
128         u8 signature[ECRYPTFS_PASSWORD_SIG_SIZE + 1];
129         /* Always in expanded hex */
130         u8 salt[ECRYPTFS_SALT_SIZE];
131 };
132
133 enum ecryptfs_token_types {ECRYPTFS_PASSWORD, ECRYPTFS_PRIVATE_KEY};
134
135 struct ecryptfs_private_key {
136         u32 key_size;
137         u32 data_len;
138         u8 signature[ECRYPTFS_PASSWORD_SIG_SIZE + 1];
139         char pki_type[ECRYPTFS_MAX_PKI_NAME_BYTES + 1];
140         u8 data[];
141 };
142
143 /* May be a password or a private key */
144 struct ecryptfs_auth_tok {
145         u16 version; /* 8-bit major and 8-bit minor */
146         u16 token_type;
147 #define ECRYPTFS_ENCRYPT_ONLY 0x00000001
148         u32 flags;
149         struct ecryptfs_session_key session_key;
150         u8 reserved[32];
151         union {
152                 struct ecryptfs_password password;
153                 struct ecryptfs_private_key private_key;
154         } token;
155 } __attribute__ ((packed));
156
157 void ecryptfs_dump_auth_tok(struct ecryptfs_auth_tok *auth_tok);
158 extern void ecryptfs_to_hex(char *dst, char *src, size_t src_size);
159 extern void ecryptfs_from_hex(char *dst, char *src, int dst_size);
160
161 struct ecryptfs_key_record {
162         unsigned char type;
163         size_t enc_key_size;
164         unsigned char sig[ECRYPTFS_SIG_SIZE];
165         unsigned char enc_key[ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES];
166 };
167
168 struct ecryptfs_auth_tok_list {
169         struct ecryptfs_auth_tok *auth_tok;
170         struct list_head list;
171 };
172
173 struct ecryptfs_crypt_stat;
174 struct ecryptfs_mount_crypt_stat;
175
176 struct ecryptfs_page_crypt_context {
177         struct page *page;
178 #define ECRYPTFS_PREPARE_COMMIT_MODE 0
179 #define ECRYPTFS_WRITEPAGE_MODE      1
180         unsigned int mode;
181         union {
182                 struct file *lower_file;
183                 struct writeback_control *wbc;
184         } param;
185 };
186
187 static inline struct ecryptfs_auth_tok *
188 ecryptfs_get_key_payload_data(struct key *key)
189 {
190         return (struct ecryptfs_auth_tok *)
191                 (((struct user_key_payload*)key->payload.data)->data);
192 }
193
194 #define ECRYPTFS_SUPER_MAGIC 0xf15f
195 #define ECRYPTFS_MAX_KEYSET_SIZE 1024
196 #define ECRYPTFS_MAX_CIPHER_NAME_SIZE 32
197 #define ECRYPTFS_MAX_NUM_ENC_KEYS 64
198 #define ECRYPTFS_MAX_IV_BYTES 16        /* 128 bits */
199 #define ECRYPTFS_SALT_BYTES 2
200 #define MAGIC_ECRYPTFS_MARKER 0x3c81b7f5
201 #define MAGIC_ECRYPTFS_MARKER_SIZE_BYTES 8      /* 4*2 */
202 #define ECRYPTFS_FILE_SIZE_BYTES (sizeof(u64))
203 #define ECRYPTFS_DEFAULT_CIPHER "aes"
204 #define ECRYPTFS_DEFAULT_KEY_BYTES 16
205 #define ECRYPTFS_DEFAULT_HASH "md5"
206 #define ECRYPTFS_TAG_1_PACKET_TYPE 0x01
207 #define ECRYPTFS_TAG_3_PACKET_TYPE 0x8C
208 #define ECRYPTFS_TAG_11_PACKET_TYPE 0xED
209 #define ECRYPTFS_TAG_64_PACKET_TYPE 0x40
210 #define ECRYPTFS_TAG_65_PACKET_TYPE 0x41
211 #define ECRYPTFS_TAG_66_PACKET_TYPE 0x42
212 #define ECRYPTFS_TAG_67_PACKET_TYPE 0x43
213 #define MD5_DIGEST_SIZE 16
214
215 struct ecryptfs_key_sig {
216         struct list_head crypt_stat_list;
217         char keysig[ECRYPTFS_SIG_SIZE_HEX];
218 };
219
220 /**
221  * This is the primary struct associated with each encrypted file.
222  *
223  * TODO: cache align/pack?
224  */
225 struct ecryptfs_crypt_stat {
226 #define ECRYPTFS_STRUCT_INITIALIZED 0x00000001
227 #define ECRYPTFS_POLICY_APPLIED     0x00000002
228 #define ECRYPTFS_NEW_FILE           0x00000004
229 #define ECRYPTFS_ENCRYPTED          0x00000008
230 #define ECRYPTFS_SECURITY_WARNING   0x00000010
231 #define ECRYPTFS_ENABLE_HMAC        0x00000020
232 #define ECRYPTFS_ENCRYPT_IV_PAGES   0x00000040
233 #define ECRYPTFS_KEY_VALID          0x00000080
234 #define ECRYPTFS_METADATA_IN_XATTR  0x00000100
235 #define ECRYPTFS_VIEW_AS_ENCRYPTED  0x00000200
236 #define ECRYPTFS_KEY_SET            0x00000400
237         u32 flags;
238         unsigned int file_version;
239         size_t iv_bytes;
240         size_t num_header_bytes_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 mutex key_tfm_list_mutex;
326
327 /**
328  * This struct is to enable a mount-wide passphrase/salt combo. This
329  * is more or less a stopgap to provide similar functionality to other
330  * crypto filesystems like EncFS or CFS until full policy support is
331  * implemented in eCryptfs.
332  */
333 struct ecryptfs_mount_crypt_stat {
334         /* Pointers to memory we do not own, do not free these */
335 #define ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED 0x00000001
336 #define ECRYPTFS_XATTR_METADATA_ENABLED        0x00000002
337 #define ECRYPTFS_ENCRYPTED_VIEW_ENABLED        0x00000004
338 #define ECRYPTFS_MOUNT_CRYPT_STAT_INITIALIZED  0x00000008
339         u32 flags;
340         struct list_head global_auth_tok_list;
341         struct mutex global_auth_tok_list_mutex;
342         size_t num_global_auth_toks;
343         size_t global_default_cipher_key_size;
344         unsigned char global_default_cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE
345                                                  + 1];
346 };
347
348 /* superblock private data. */
349 struct ecryptfs_sb_info {
350         struct super_block *wsi_sb;
351         struct ecryptfs_mount_crypt_stat mount_crypt_stat;
352 };
353
354 /* file private data. */
355 struct ecryptfs_file_info {
356         struct file *wfi_file;
357         struct ecryptfs_crypt_stat *crypt_stat;
358 };
359
360 /* auth_tok <=> encrypted_session_key mappings */
361 struct ecryptfs_auth_tok_list_item {
362         unsigned char encrypted_session_key[ECRYPTFS_MAX_KEY_BYTES];
363         struct list_head list;
364         struct ecryptfs_auth_tok auth_tok;
365 };
366
367 struct ecryptfs_message {
368         /* Can never be greater than ecryptfs_message_buf_len */
369         /* Used to find the parent msg_ctx */
370         /* Inherits from msg_ctx->index */
371         u32 index;
372         u32 data_len;
373         u8 data[];
374 };
375
376 struct ecryptfs_msg_ctx {
377 #define ECRYPTFS_MSG_CTX_STATE_FREE     0x01
378 #define ECRYPTFS_MSG_CTX_STATE_PENDING  0x02
379 #define ECRYPTFS_MSG_CTX_STATE_DONE     0x03
380 #define ECRYPTFS_MSG_CTX_STATE_NO_REPLY 0x04
381         u8 state;
382 #define ECRYPTFS_MSG_HELO 100
383 #define ECRYPTFS_MSG_QUIT 101
384 #define ECRYPTFS_MSG_REQUEST 102
385 #define ECRYPTFS_MSG_RESPONSE 103
386         u8 type;
387         u32 index;
388         /* Counter converts to a sequence number. Each message sent
389          * out for which we expect a response has an associated
390          * sequence number. The response must have the same sequence
391          * number as the counter for the msg_stc for the message to be
392          * valid. */
393         u32 counter;
394         size_t msg_size;
395         struct ecryptfs_message *msg;
396         struct task_struct *task;
397         struct list_head node;
398         struct list_head daemon_out_list;
399         struct mutex mux;
400 };
401
402 extern unsigned int ecryptfs_transport;
403
404 struct ecryptfs_daemon;
405
406 struct ecryptfs_daemon {
407 #define ECRYPTFS_DAEMON_IN_READ      0x00000001
408 #define ECRYPTFS_DAEMON_IN_POLL      0x00000002
409 #define ECRYPTFS_DAEMON_ZOMBIE       0x00000004
410 #define ECRYPTFS_DAEMON_MISCDEV_OPEN 0x00000008
411         u32 flags;
412         u32 num_queued_msg_ctx;
413         pid_t pid;
414         uid_t euid;
415         struct task_struct *task;
416         struct mutex mux;
417         struct list_head msg_ctx_out_queue;
418         wait_queue_head_t wait;
419         struct hlist_node euid_chain;
420 };
421
422 extern struct mutex ecryptfs_daemon_hash_mux;
423
424 static inline struct ecryptfs_file_info *
425 ecryptfs_file_to_private(struct file *file)
426 {
427         return (struct ecryptfs_file_info *)file->private_data;
428 }
429
430 static inline void
431 ecryptfs_set_file_private(struct file *file,
432                           struct ecryptfs_file_info *file_info)
433 {
434         file->private_data = file_info;
435 }
436
437 static inline struct file *ecryptfs_file_to_lower(struct file *file)
438 {
439         return ((struct ecryptfs_file_info *)file->private_data)->wfi_file;
440 }
441
442 static inline void
443 ecryptfs_set_file_lower(struct file *file, struct file *lower_file)
444 {
445         ((struct ecryptfs_file_info *)file->private_data)->wfi_file =
446                 lower_file;
447 }
448
449 static inline struct ecryptfs_inode_info *
450 ecryptfs_inode_to_private(struct inode *inode)
451 {
452         return container_of(inode, struct ecryptfs_inode_info, vfs_inode);
453 }
454
455 static inline struct inode *ecryptfs_inode_to_lower(struct inode *inode)
456 {
457         return ecryptfs_inode_to_private(inode)->wii_inode;
458 }
459
460 static inline void
461 ecryptfs_set_inode_lower(struct inode *inode, struct inode *lower_inode)
462 {
463         ecryptfs_inode_to_private(inode)->wii_inode = lower_inode;
464 }
465
466 static inline struct ecryptfs_sb_info *
467 ecryptfs_superblock_to_private(struct super_block *sb)
468 {
469         return (struct ecryptfs_sb_info *)sb->s_fs_info;
470 }
471
472 static inline void
473 ecryptfs_set_superblock_private(struct super_block *sb,
474                                 struct ecryptfs_sb_info *sb_info)
475 {
476         sb->s_fs_info = sb_info;
477 }
478
479 static inline struct super_block *
480 ecryptfs_superblock_to_lower(struct super_block *sb)
481 {
482         return ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb;
483 }
484
485 static inline void
486 ecryptfs_set_superblock_lower(struct super_block *sb,
487                               struct super_block *lower_sb)
488 {
489         ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb = lower_sb;
490 }
491
492 static inline struct ecryptfs_dentry_info *
493 ecryptfs_dentry_to_private(struct dentry *dentry)
494 {
495         return (struct ecryptfs_dentry_info *)dentry->d_fsdata;
496 }
497
498 static inline void
499 ecryptfs_set_dentry_private(struct dentry *dentry,
500                             struct ecryptfs_dentry_info *dentry_info)
501 {
502         dentry->d_fsdata = dentry_info;
503 }
504
505 static inline struct dentry *
506 ecryptfs_dentry_to_lower(struct dentry *dentry)
507 {
508         return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry;
509 }
510
511 static inline void
512 ecryptfs_set_dentry_lower(struct dentry *dentry, struct dentry *lower_dentry)
513 {
514         ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry =
515                 lower_dentry;
516 }
517
518 static inline struct vfsmount *
519 ecryptfs_dentry_to_lower_mnt(struct dentry *dentry)
520 {
521         return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt;
522 }
523
524 static inline void
525 ecryptfs_set_dentry_lower_mnt(struct dentry *dentry, struct vfsmount *lower_mnt)
526 {
527         ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt =
528                 lower_mnt;
529 }
530
531 #define ecryptfs_printk(type, fmt, arg...) \
532         __ecryptfs_printk(type "%s: " fmt, __func__, ## arg);
533 void __ecryptfs_printk(const char *fmt, ...);
534
535 extern const struct file_operations ecryptfs_main_fops;
536 extern const struct file_operations ecryptfs_dir_fops;
537 extern const struct inode_operations ecryptfs_main_iops;
538 extern const struct inode_operations ecryptfs_dir_iops;
539 extern const struct inode_operations ecryptfs_symlink_iops;
540 extern const struct super_operations ecryptfs_sops;
541 extern struct dentry_operations ecryptfs_dops;
542 extern struct address_space_operations ecryptfs_aops;
543 extern int ecryptfs_verbosity;
544 extern unsigned int ecryptfs_message_buf_len;
545 extern signed long ecryptfs_message_wait_timeout;
546 extern unsigned int ecryptfs_number_of_users;
547
548 extern struct kmem_cache *ecryptfs_auth_tok_list_item_cache;
549 extern struct kmem_cache *ecryptfs_file_info_cache;
550 extern struct kmem_cache *ecryptfs_dentry_info_cache;
551 extern struct kmem_cache *ecryptfs_inode_info_cache;
552 extern struct kmem_cache *ecryptfs_sb_info_cache;
553 extern struct kmem_cache *ecryptfs_header_cache_1;
554 extern struct kmem_cache *ecryptfs_header_cache_2;
555 extern struct kmem_cache *ecryptfs_xattr_cache;
556 extern struct kmem_cache *ecryptfs_key_record_cache;
557 extern struct kmem_cache *ecryptfs_key_sig_cache;
558 extern struct kmem_cache *ecryptfs_global_auth_tok_cache;
559 extern struct kmem_cache *ecryptfs_key_tfm_cache;
560
561 int ecryptfs_interpose(struct dentry *hidden_dentry,
562                        struct dentry *this_dentry, struct super_block *sb,
563                        int flag);
564 int ecryptfs_fill_zeros(struct file *file, loff_t new_length);
565 int ecryptfs_decode_filename(struct ecryptfs_crypt_stat *crypt_stat,
566                              const char *name, int length,
567                              char **decrypted_name);
568 int ecryptfs_encode_filename(struct ecryptfs_crypt_stat *crypt_stat,
569                              const char *name, int length,
570                              char **encoded_name);
571 struct dentry *ecryptfs_lower_dentry(struct dentry *this_dentry);
572 void ecryptfs_dump_hex(char *data, int bytes);
573 int virt_to_scatterlist(const void *addr, int size, struct scatterlist *sg,
574                         int sg_size);
575 int ecryptfs_compute_root_iv(struct ecryptfs_crypt_stat *crypt_stat);
576 void ecryptfs_rotate_iv(unsigned char *iv);
577 void ecryptfs_init_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
578 void ecryptfs_destroy_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
579 void ecryptfs_destroy_mount_crypt_stat(
580         struct ecryptfs_mount_crypt_stat *mount_crypt_stat);
581 int ecryptfs_init_crypt_ctx(struct ecryptfs_crypt_stat *crypt_stat);
582 int ecryptfs_write_inode_size_to_metadata(struct inode *ecryptfs_inode);
583 int ecryptfs_encrypt_page(struct page *page);
584 int ecryptfs_decrypt_page(struct page *page);
585 int ecryptfs_write_metadata(struct dentry *ecryptfs_dentry);
586 int ecryptfs_read_metadata(struct dentry *ecryptfs_dentry);
587 int ecryptfs_new_file_context(struct dentry *ecryptfs_dentry);
588 int ecryptfs_read_and_validate_header_region(char *data,
589                                              struct inode *ecryptfs_inode);
590 int ecryptfs_read_and_validate_xattr_region(char *page_virt,
591                                             struct dentry *ecryptfs_dentry);
592 u8 ecryptfs_code_for_cipher_string(struct ecryptfs_crypt_stat *crypt_stat);
593 int ecryptfs_cipher_code_to_string(char *str, u8 cipher_code);
594 void ecryptfs_set_default_sizes(struct ecryptfs_crypt_stat *crypt_stat);
595 int ecryptfs_generate_key_packet_set(char *dest_base,
596                                      struct ecryptfs_crypt_stat *crypt_stat,
597                                      struct dentry *ecryptfs_dentry,
598                                      size_t *len, size_t max);
599 int
600 ecryptfs_parse_packet_set(struct ecryptfs_crypt_stat *crypt_stat,
601                           unsigned char *src, struct dentry *ecryptfs_dentry);
602 int ecryptfs_truncate(struct dentry *dentry, loff_t new_length);
603 int ecryptfs_inode_test(struct inode *inode, void *candidate_lower_inode);
604 int ecryptfs_inode_set(struct inode *inode, void *lower_inode);
605 void ecryptfs_init_inode(struct inode *inode, struct inode *lower_inode);
606 ssize_t
607 ecryptfs_getxattr_lower(struct dentry *lower_dentry, const char *name,
608                         void *value, size_t size);
609 int
610 ecryptfs_setxattr(struct dentry *dentry, const char *name, const void *value,
611                   size_t size, int flags);
612 int ecryptfs_read_xattr_region(char *page_virt, struct inode *ecryptfs_inode);
613 int ecryptfs_process_helo(unsigned int transport, uid_t uid, pid_t pid);
614 int ecryptfs_process_quit(uid_t uid, pid_t pid);
615 int ecryptfs_process_response(struct ecryptfs_message *msg, uid_t uid,
616                               pid_t pid, u32 seq);
617 int ecryptfs_send_message(unsigned int transport, char *data, int data_len,
618                           struct ecryptfs_msg_ctx **msg_ctx);
619 int ecryptfs_wait_for_response(struct ecryptfs_msg_ctx *msg_ctx,
620                                struct ecryptfs_message **emsg);
621 int ecryptfs_init_messaging(unsigned int transport);
622 void ecryptfs_release_messaging(unsigned int transport);
623
624 int ecryptfs_send_netlink(char *data, int data_len,
625                           struct ecryptfs_msg_ctx *msg_ctx, u8 msg_type,
626                           u16 msg_flags, pid_t daemon_pid);
627 int ecryptfs_init_netlink(void);
628 void ecryptfs_release_netlink(void);
629
630 int ecryptfs_send_connector(char *data, int data_len,
631                             struct ecryptfs_msg_ctx *msg_ctx, u8 msg_type,
632                             u16 msg_flags, pid_t daemon_pid);
633 int ecryptfs_init_connector(void);
634 void ecryptfs_release_connector(void);
635 void
636 ecryptfs_write_header_metadata(char *virt,
637                                struct ecryptfs_crypt_stat *crypt_stat,
638                                size_t *written);
639 int ecryptfs_add_keysig(struct ecryptfs_crypt_stat *crypt_stat, char *sig);
640 int
641 ecryptfs_add_global_auth_tok(struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
642                            char *sig);
643 int ecryptfs_get_global_auth_tok_for_sig(
644         struct ecryptfs_global_auth_tok **global_auth_tok,
645         struct ecryptfs_mount_crypt_stat *mount_crypt_stat, char *sig);
646 int
647 ecryptfs_add_new_key_tfm(struct ecryptfs_key_tfm **key_tfm, char *cipher_name,
648                          size_t key_size);
649 int ecryptfs_init_crypto(void);
650 int ecryptfs_destroy_crypto(void);
651 int ecryptfs_tfm_exists(char *cipher_name, struct ecryptfs_key_tfm **key_tfm);
652 int ecryptfs_get_tfm_and_mutex_for_cipher_name(struct crypto_blkcipher **tfm,
653                                                struct mutex **tfm_mutex,
654                                                char *cipher_name);
655 int ecryptfs_keyring_auth_tok_for_sig(struct key **auth_tok_key,
656                                       struct ecryptfs_auth_tok **auth_tok,
657                                       char *sig);
658 int ecryptfs_write_zeros(struct file *file, pgoff_t index, int start,
659                          int num_zeros);
660 int ecryptfs_write_lower(struct inode *ecryptfs_inode, char *data,
661                          loff_t offset, size_t size);
662 int ecryptfs_write_lower_page_segment(struct inode *ecryptfs_inode,
663                                       struct page *page_for_lower,
664                                       size_t offset_in_page, size_t size);
665 int ecryptfs_write(struct file *ecryptfs_file, char *data, loff_t offset,
666                    size_t size);
667 int ecryptfs_read_lower(char *data, loff_t offset, size_t size,
668                         struct inode *ecryptfs_inode);
669 int ecryptfs_read_lower_page_segment(struct page *page_for_ecryptfs,
670                                      pgoff_t page_index,
671                                      size_t offset_in_page, size_t size,
672                                      struct inode *ecryptfs_inode);
673 struct page *ecryptfs_get_locked_page(struct file *file, loff_t index);
674 int ecryptfs_exorcise_daemon(struct ecryptfs_daemon *daemon);
675 int ecryptfs_find_daemon_by_euid(struct ecryptfs_daemon **daemon, uid_t euid);
676 int ecryptfs_parse_packet_length(unsigned char *data, size_t *size,
677                                  size_t *length_size);
678 int ecryptfs_write_packet_length(char *dest, size_t size,
679                                  size_t *packet_size_length);
680 int ecryptfs_init_ecryptfs_miscdev(void);
681 void ecryptfs_destroy_ecryptfs_miscdev(void);
682 int ecryptfs_send_miscdev(char *data, size_t data_size,
683                           struct ecryptfs_msg_ctx *msg_ctx, u8 msg_type,
684                           u16 msg_flags, struct ecryptfs_daemon *daemon);
685 void ecryptfs_msg_ctx_alloc_to_free(struct ecryptfs_msg_ctx *msg_ctx);
686 int
687 ecryptfs_spawn_daemon(struct ecryptfs_daemon **daemon, uid_t euid, pid_t pid);
688
689 #endif /* #ifndef ECRYPTFS_KERNEL_H */