eCryptfs: make needlessly global symbols static
[safe/jmp/linux-2.6] / fs / ecryptfs / ecryptfs_kernel.h
1 /**
2  * eCryptfs: Linux filesystem encryption layer
3  * Kernel declarations.
4  *
5  * Copyright (C) 1997-2003 Erez Zadok
6  * Copyright (C) 2001-2003 Stony Brook University
7  * Copyright (C) 2004-2007 International Business Machines Corp.
8  *   Author(s): Michael A. Halcrow <mahalcro@us.ibm.com>
9  *              Trevor S. Highland <trevor.highland@gmail.com>
10  *              Tyler Hicks <tyhicks@ou.edu>
11  *
12  * This program is free software; you can redistribute it and/or
13  * modify it under the terms of the GNU General Public License as
14  * published by the Free Software Foundation; either version 2 of the
15  * License, or (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful, but
18  * WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20  * General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
25  * 02111-1307, USA.
26  */
27
28 #ifndef ECRYPTFS_KERNEL_H
29 #define ECRYPTFS_KERNEL_H
30
31 #include <keys/user-type.h>
32 #include <linux/fs.h>
33 #include <linux/fs_stack.h>
34 #include <linux/namei.h>
35 #include <linux/scatterlist.h>
36 #include <linux/hash.h>
37
38 /* Version verification for shared data structures w/ userspace */
39 #define ECRYPTFS_VERSION_MAJOR 0x00
40 #define ECRYPTFS_VERSION_MINOR 0x04
41 #define ECRYPTFS_SUPPORTED_FILE_VERSION 0x02
42 /* These flags indicate which features are supported by the kernel
43  * module; userspace tools such as the mount helper read
44  * ECRYPTFS_VERSIONING_MASK from a sysfs handle in order to determine
45  * how to behave. */
46 #define ECRYPTFS_VERSIONING_PASSPHRASE            0x00000001
47 #define ECRYPTFS_VERSIONING_PUBKEY                0x00000002
48 #define ECRYPTFS_VERSIONING_PLAINTEXT_PASSTHROUGH 0x00000004
49 #define ECRYPTFS_VERSIONING_POLICY                0x00000008
50 #define ECRYPTFS_VERSIONING_XATTR                 0x00000010
51 #define ECRYPTFS_VERSIONING_MULTKEY               0x00000020
52 #define ECRYPTFS_VERSIONING_MASK (ECRYPTFS_VERSIONING_PASSPHRASE \
53                                   | ECRYPTFS_VERSIONING_PLAINTEXT_PASSTHROUGH \
54                                   | ECRYPTFS_VERSIONING_PUBKEY \
55                                   | ECRYPTFS_VERSIONING_XATTR \
56                                   | ECRYPTFS_VERSIONING_MULTKEY)
57 #define ECRYPTFS_MAX_PASSWORD_LENGTH 64
58 #define ECRYPTFS_MAX_PASSPHRASE_BYTES ECRYPTFS_MAX_PASSWORD_LENGTH
59 #define ECRYPTFS_SALT_SIZE 8
60 #define ECRYPTFS_SALT_SIZE_HEX (ECRYPTFS_SALT_SIZE*2)
61 /* The original signature size is only for what is stored on disk; all
62  * in-memory representations are expanded hex, so it better adapted to
63  * be passed around or referenced on the command line */
64 #define ECRYPTFS_SIG_SIZE 8
65 #define ECRYPTFS_SIG_SIZE_HEX (ECRYPTFS_SIG_SIZE*2)
66 #define ECRYPTFS_PASSWORD_SIG_SIZE ECRYPTFS_SIG_SIZE_HEX
67 #define ECRYPTFS_MAX_KEY_BYTES 64
68 #define ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES 512
69 #define ECRYPTFS_DEFAULT_IV_BYTES 16
70 #define ECRYPTFS_FILE_VERSION 0x02
71 #define ECRYPTFS_DEFAULT_HEADER_EXTENT_SIZE 8192
72 #define ECRYPTFS_DEFAULT_EXTENT_SIZE 4096
73 #define ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE 8192
74 #define ECRYPTFS_DEFAULT_MSG_CTX_ELEMS 32
75 #define ECRYPTFS_DEFAULT_SEND_TIMEOUT HZ
76 #define ECRYPTFS_MAX_MSG_CTX_TTL (HZ*3)
77 #define ECRYPTFS_NLMSG_HELO 100
78 #define ECRYPTFS_NLMSG_QUIT 101
79 #define ECRYPTFS_NLMSG_REQUEST 102
80 #define ECRYPTFS_NLMSG_RESPONSE 103
81 #define ECRYPTFS_MAX_PKI_NAME_BYTES 16
82 #define ECRYPTFS_DEFAULT_NUM_USERS 4
83 #define ECRYPTFS_MAX_NUM_USERS 32768
84 #define ECRYPTFS_TRANSPORT_NETLINK 0
85 #define ECRYPTFS_TRANSPORT_CONNECTOR 1
86 #define ECRYPTFS_TRANSPORT_RELAYFS 2
87 #define ECRYPTFS_DEFAULT_TRANSPORT ECRYPTFS_TRANSPORT_NETLINK
88 #define ECRYPTFS_XATTR_NAME "user.ecryptfs"
89
90 #define RFC2440_CIPHER_DES3_EDE 0x02
91 #define RFC2440_CIPHER_CAST_5 0x03
92 #define RFC2440_CIPHER_BLOWFISH 0x04
93 #define RFC2440_CIPHER_AES_128 0x07
94 #define RFC2440_CIPHER_AES_192 0x08
95 #define RFC2440_CIPHER_AES_256 0x09
96 #define RFC2440_CIPHER_TWOFISH 0x0a
97 #define RFC2440_CIPHER_CAST_6 0x0b
98
99 #define RFC2440_CIPHER_RSA 0x01
100
101 /**
102  * For convenience, we may need to pass around the encrypted session
103  * key between kernel and userspace because the authentication token
104  * may not be extractable.  For example, the TPM may not release the
105  * private key, instead requiring the encrypted data and returning the
106  * decrypted data.
107  */
108 struct ecryptfs_session_key {
109 #define ECRYPTFS_USERSPACE_SHOULD_TRY_TO_DECRYPT 0x00000001
110 #define ECRYPTFS_USERSPACE_SHOULD_TRY_TO_ENCRYPT 0x00000002
111 #define ECRYPTFS_CONTAINS_DECRYPTED_KEY 0x00000004
112 #define ECRYPTFS_CONTAINS_ENCRYPTED_KEY 0x00000008
113         u32 flags;
114         u32 encrypted_key_size;
115         u32 decrypted_key_size;
116         u8 encrypted_key[ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES];
117         u8 decrypted_key[ECRYPTFS_MAX_KEY_BYTES];
118 };
119
120 struct ecryptfs_password {
121         u32 password_bytes;
122         s32 hash_algo;
123         u32 hash_iterations;
124         u32 session_key_encryption_key_bytes;
125 #define ECRYPTFS_PERSISTENT_PASSWORD 0x01
126 #define ECRYPTFS_SESSION_KEY_ENCRYPTION_KEY_SET 0x02
127         u32 flags;
128         /* Iterated-hash concatenation of salt and passphrase */
129         u8 session_key_encryption_key[ECRYPTFS_MAX_KEY_BYTES];
130         u8 signature[ECRYPTFS_PASSWORD_SIG_SIZE + 1];
131         /* Always in expanded hex */
132         u8 salt[ECRYPTFS_SALT_SIZE];
133 };
134
135 enum ecryptfs_token_types {ECRYPTFS_PASSWORD, ECRYPTFS_PRIVATE_KEY};
136
137 struct ecryptfs_private_key {
138         u32 key_size;
139         u32 data_len;
140         u8 signature[ECRYPTFS_PASSWORD_SIG_SIZE + 1];
141         char pki_type[ECRYPTFS_MAX_PKI_NAME_BYTES + 1];
142         u8 data[];
143 };
144
145 /* May be a password or a private key */
146 struct ecryptfs_auth_tok {
147         u16 version; /* 8-bit major and 8-bit minor */
148         u16 token_type;
149 #define ECRYPTFS_ENCRYPT_ONLY 0x00000001
150         u32 flags;
151         struct ecryptfs_session_key session_key;
152         u8 reserved[32];
153         union {
154                 struct ecryptfs_password password;
155                 struct ecryptfs_private_key private_key;
156         } token;
157 } __attribute__ ((packed));
158
159 void ecryptfs_dump_auth_tok(struct ecryptfs_auth_tok *auth_tok);
160 extern void ecryptfs_to_hex(char *dst, char *src, size_t src_size);
161 extern void ecryptfs_from_hex(char *dst, char *src, int dst_size);
162
163 struct ecryptfs_key_record {
164         unsigned char type;
165         size_t enc_key_size;
166         unsigned char sig[ECRYPTFS_SIG_SIZE];
167         unsigned char enc_key[ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES];
168 };
169
170 struct ecryptfs_auth_tok_list {
171         struct ecryptfs_auth_tok *auth_tok;
172         struct list_head list;
173 };
174
175 struct ecryptfs_crypt_stat;
176 struct ecryptfs_mount_crypt_stat;
177
178 struct ecryptfs_page_crypt_context {
179         struct page *page;
180 #define ECRYPTFS_PREPARE_COMMIT_MODE 0
181 #define ECRYPTFS_WRITEPAGE_MODE      1
182         unsigned int mode;
183         union {
184                 struct file *lower_file;
185                 struct writeback_control *wbc;
186         } param;
187 };
188
189 static inline struct ecryptfs_auth_tok *
190 ecryptfs_get_key_payload_data(struct key *key)
191 {
192         return (struct ecryptfs_auth_tok *)
193                 (((struct user_key_payload*)key->payload.data)->data);
194 }
195
196 #define ECRYPTFS_SUPER_MAGIC 0xf15f
197 #define ECRYPTFS_MAX_KEYSET_SIZE 1024
198 #define ECRYPTFS_MAX_CIPHER_NAME_SIZE 32
199 #define ECRYPTFS_MAX_NUM_ENC_KEYS 64
200 #define ECRYPTFS_MAX_IV_BYTES 16        /* 128 bits */
201 #define ECRYPTFS_SALT_BYTES 2
202 #define MAGIC_ECRYPTFS_MARKER 0x3c81b7f5
203 #define MAGIC_ECRYPTFS_MARKER_SIZE_BYTES 8      /* 4*2 */
204 #define ECRYPTFS_FILE_SIZE_BYTES 8
205 #define ECRYPTFS_DEFAULT_CIPHER "aes"
206 #define ECRYPTFS_DEFAULT_KEY_BYTES 16
207 #define ECRYPTFS_DEFAULT_HASH "md5"
208 #define ECRYPTFS_TAG_1_PACKET_TYPE 0x01
209 #define ECRYPTFS_TAG_3_PACKET_TYPE 0x8C
210 #define ECRYPTFS_TAG_11_PACKET_TYPE 0xED
211 #define ECRYPTFS_TAG_64_PACKET_TYPE 0x40
212 #define ECRYPTFS_TAG_65_PACKET_TYPE 0x41
213 #define ECRYPTFS_TAG_66_PACKET_TYPE 0x42
214 #define ECRYPTFS_TAG_67_PACKET_TYPE 0x43
215 #define MD5_DIGEST_SIZE 16
216
217 struct ecryptfs_key_sig {
218         struct list_head crypt_stat_list;
219         char keysig[ECRYPTFS_SIG_SIZE_HEX];
220 };
221
222 /**
223  * This is the primary struct associated with each encrypted file.
224  *
225  * TODO: cache align/pack?
226  */
227 struct ecryptfs_crypt_stat {
228 #define ECRYPTFS_STRUCT_INITIALIZED 0x00000001
229 #define ECRYPTFS_POLICY_APPLIED     0x00000002
230 #define ECRYPTFS_NEW_FILE           0x00000004
231 #define ECRYPTFS_ENCRYPTED          0x00000008
232 #define ECRYPTFS_SECURITY_WARNING   0x00000010
233 #define ECRYPTFS_ENABLE_HMAC        0x00000020
234 #define ECRYPTFS_ENCRYPT_IV_PAGES   0x00000040
235 #define ECRYPTFS_KEY_VALID          0x00000080
236 #define ECRYPTFS_METADATA_IN_XATTR  0x00000100
237 #define ECRYPTFS_VIEW_AS_ENCRYPTED  0x00000200
238         u32 flags;
239         unsigned int file_version;
240         size_t iv_bytes;
241         size_t header_extent_size;
242         size_t num_header_extents_at_front;
243         size_t extent_size; /* Data extent size; default is 4096 */
244         size_t key_size;
245         size_t extent_shift;
246         unsigned int extent_mask;
247         struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
248         struct crypto_blkcipher *tfm;
249         struct crypto_hash *hash_tfm; /* Crypto context for generating
250                                        * the initialization vectors */
251         unsigned char cipher[ECRYPTFS_MAX_CIPHER_NAME_SIZE];
252         unsigned char key[ECRYPTFS_MAX_KEY_BYTES];
253         unsigned char root_iv[ECRYPTFS_MAX_IV_BYTES];
254         struct list_head keysig_list;
255         struct mutex keysig_list_mutex;
256         struct mutex cs_tfm_mutex;
257         struct mutex cs_hash_tfm_mutex;
258         struct mutex cs_mutex;
259 };
260
261 /* inode private data. */
262 struct ecryptfs_inode_info {
263         struct inode vfs_inode;
264         struct inode *wii_inode;
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 structs refer to authentication token keys
277  * in the user keyring that apply to newly created files. A list of
278  * these objects hangs off of the mount_crypt_stat struct for any
279  * given eCryptfs mount. This struct maintains a reference to both the
280  * key contents and the key itself so that the key can be put on
281  * unmount.
282  */
283 struct ecryptfs_global_auth_tok {
284 #define ECRYPTFS_AUTH_TOK_INVALID 0x00000001
285         u32 flags;
286         struct list_head mount_crypt_stat_list; /* Default auth_tok list for
287                                                  * the mount_crypt_stat */
288         struct key *global_auth_tok_key; /* The key from the user's keyring for
289                                           * the sig */
290         struct ecryptfs_auth_tok *global_auth_tok; /* The key contents */
291         unsigned char sig[ECRYPTFS_SIG_SIZE_HEX + 1]; /* The key identifier */
292 };
293
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; /* The module's tfm list */
305         unsigned char cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE + 1];
306 };
307
308 extern struct list_head key_tfm_list;
309 extern struct mutex key_tfm_list_mutex;
310
311 /**
312  * This struct is to enable a mount-wide passphrase/salt combo. This
313  * is more or less a stopgap to provide similar functionality to other
314  * crypto filesystems like EncFS or CFS until full policy support is
315  * implemented in eCryptfs.
316  */
317 struct ecryptfs_mount_crypt_stat {
318         /* Pointers to memory we do not own, do not free these */
319 #define ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED 0x00000001
320 #define ECRYPTFS_XATTR_METADATA_ENABLED        0x00000002
321 #define ECRYPTFS_ENCRYPTED_VIEW_ENABLED        0x00000004
322 #define ECRYPTFS_MOUNT_CRYPT_STAT_INITIALIZED  0x00000008
323         u32 flags;
324         struct list_head global_auth_tok_list;
325         struct mutex global_auth_tok_list_mutex;
326         size_t num_global_auth_toks;
327         size_t global_default_cipher_key_size;
328         unsigned char global_default_cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE
329                                                  + 1];
330 };
331
332 /* superblock private data. */
333 struct ecryptfs_sb_info {
334         struct super_block *wsi_sb;
335         struct ecryptfs_mount_crypt_stat mount_crypt_stat;
336 };
337
338 /* file private data. */
339 struct ecryptfs_file_info {
340         struct file *wfi_file;
341         struct ecryptfs_crypt_stat *crypt_stat;
342 };
343
344 /* auth_tok <=> encrypted_session_key mappings */
345 struct ecryptfs_auth_tok_list_item {
346         unsigned char encrypted_session_key[ECRYPTFS_MAX_KEY_BYTES];
347         struct list_head list;
348         struct ecryptfs_auth_tok auth_tok;
349 };
350
351 struct ecryptfs_message {
352         u32 index;
353         u32 data_len;
354         u8 data[];
355 };
356
357 struct ecryptfs_msg_ctx {
358 #define ECRYPTFS_MSG_CTX_STATE_FREE      0x0001
359 #define ECRYPTFS_MSG_CTX_STATE_PENDING   0x0002
360 #define ECRYPTFS_MSG_CTX_STATE_DONE      0x0003
361         u32 state;
362         unsigned int index;
363         unsigned int counter;
364         struct ecryptfs_message *msg;
365         struct task_struct *task;
366         struct list_head node;
367         struct mutex mux;
368 };
369
370 extern unsigned int ecryptfs_transport;
371
372 struct ecryptfs_daemon_id {
373         pid_t pid;
374         uid_t uid;
375         struct hlist_node id_chain;
376 };
377
378 static inline struct ecryptfs_file_info *
379 ecryptfs_file_to_private(struct file *file)
380 {
381         return (struct ecryptfs_file_info *)file->private_data;
382 }
383
384 static inline void
385 ecryptfs_set_file_private(struct file *file,
386                           struct ecryptfs_file_info *file_info)
387 {
388         file->private_data = file_info;
389 }
390
391 static inline struct file *ecryptfs_file_to_lower(struct file *file)
392 {
393         return ((struct ecryptfs_file_info *)file->private_data)->wfi_file;
394 }
395
396 static inline void
397 ecryptfs_set_file_lower(struct file *file, struct file *lower_file)
398 {
399         ((struct ecryptfs_file_info *)file->private_data)->wfi_file =
400                 lower_file;
401 }
402
403 static inline struct ecryptfs_inode_info *
404 ecryptfs_inode_to_private(struct inode *inode)
405 {
406         return container_of(inode, struct ecryptfs_inode_info, vfs_inode);
407 }
408
409 static inline struct inode *ecryptfs_inode_to_lower(struct inode *inode)
410 {
411         return ecryptfs_inode_to_private(inode)->wii_inode;
412 }
413
414 static inline void
415 ecryptfs_set_inode_lower(struct inode *inode, struct inode *lower_inode)
416 {
417         ecryptfs_inode_to_private(inode)->wii_inode = lower_inode;
418 }
419
420 static inline struct ecryptfs_sb_info *
421 ecryptfs_superblock_to_private(struct super_block *sb)
422 {
423         return (struct ecryptfs_sb_info *)sb->s_fs_info;
424 }
425
426 static inline void
427 ecryptfs_set_superblock_private(struct super_block *sb,
428                                 struct ecryptfs_sb_info *sb_info)
429 {
430         sb->s_fs_info = sb_info;
431 }
432
433 static inline struct super_block *
434 ecryptfs_superblock_to_lower(struct super_block *sb)
435 {
436         return ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb;
437 }
438
439 static inline void
440 ecryptfs_set_superblock_lower(struct super_block *sb,
441                               struct super_block *lower_sb)
442 {
443         ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb = lower_sb;
444 }
445
446 static inline struct ecryptfs_dentry_info *
447 ecryptfs_dentry_to_private(struct dentry *dentry)
448 {
449         return (struct ecryptfs_dentry_info *)dentry->d_fsdata;
450 }
451
452 static inline void
453 ecryptfs_set_dentry_private(struct dentry *dentry,
454                             struct ecryptfs_dentry_info *dentry_info)
455 {
456         dentry->d_fsdata = dentry_info;
457 }
458
459 static inline struct dentry *
460 ecryptfs_dentry_to_lower(struct dentry *dentry)
461 {
462         return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry;
463 }
464
465 static inline void
466 ecryptfs_set_dentry_lower(struct dentry *dentry, struct dentry *lower_dentry)
467 {
468         ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry =
469                 lower_dentry;
470 }
471
472 static inline struct vfsmount *
473 ecryptfs_dentry_to_lower_mnt(struct dentry *dentry)
474 {
475         return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt;
476 }
477
478 static inline void
479 ecryptfs_set_dentry_lower_mnt(struct dentry *dentry, struct vfsmount *lower_mnt)
480 {
481         ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt =
482                 lower_mnt;
483 }
484
485 #define ecryptfs_printk(type, fmt, arg...) \
486         __ecryptfs_printk(type "%s: " fmt, __FUNCTION__, ## arg);
487 void __ecryptfs_printk(const char *fmt, ...);
488
489 extern const struct file_operations ecryptfs_main_fops;
490 extern const struct file_operations ecryptfs_dir_fops;
491 extern const struct inode_operations ecryptfs_main_iops;
492 extern const struct inode_operations ecryptfs_dir_iops;
493 extern const struct inode_operations ecryptfs_symlink_iops;
494 extern const struct super_operations ecryptfs_sops;
495 extern struct dentry_operations ecryptfs_dops;
496 extern struct address_space_operations ecryptfs_aops;
497 extern int ecryptfs_verbosity;
498 extern unsigned int ecryptfs_message_buf_len;
499 extern signed long ecryptfs_message_wait_timeout;
500 extern unsigned int ecryptfs_number_of_users;
501
502 extern struct kmem_cache *ecryptfs_auth_tok_list_item_cache;
503 extern struct kmem_cache *ecryptfs_file_info_cache;
504 extern struct kmem_cache *ecryptfs_dentry_info_cache;
505 extern struct kmem_cache *ecryptfs_inode_info_cache;
506 extern struct kmem_cache *ecryptfs_sb_info_cache;
507 extern struct kmem_cache *ecryptfs_header_cache_0;
508 extern struct kmem_cache *ecryptfs_header_cache_1;
509 extern struct kmem_cache *ecryptfs_header_cache_2;
510 extern struct kmem_cache *ecryptfs_xattr_cache;
511 extern struct kmem_cache *ecryptfs_lower_page_cache;
512 extern struct kmem_cache *ecryptfs_key_record_cache;
513 extern struct kmem_cache *ecryptfs_key_sig_cache;
514 extern struct kmem_cache *ecryptfs_global_auth_tok_cache;
515 extern struct kmem_cache *ecryptfs_key_tfm_cache;
516
517 int ecryptfs_interpose(struct dentry *hidden_dentry,
518                        struct dentry *this_dentry, struct super_block *sb,
519                        int flag);
520 int ecryptfs_fill_zeros(struct file *file, loff_t new_length);
521 int ecryptfs_decode_filename(struct ecryptfs_crypt_stat *crypt_stat,
522                              const char *name, int length,
523                              char **decrypted_name);
524 int ecryptfs_encode_filename(struct ecryptfs_crypt_stat *crypt_stat,
525                              const char *name, int length,
526                              char **encoded_name);
527 struct dentry *ecryptfs_lower_dentry(struct dentry *this_dentry);
528 void ecryptfs_dump_hex(char *data, int bytes);
529 int virt_to_scatterlist(const void *addr, int size, struct scatterlist *sg,
530                         int sg_size);
531 int ecryptfs_compute_root_iv(struct ecryptfs_crypt_stat *crypt_stat);
532 void ecryptfs_rotate_iv(unsigned char *iv);
533 void ecryptfs_init_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
534 void ecryptfs_destroy_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
535 void ecryptfs_destroy_mount_crypt_stat(
536         struct ecryptfs_mount_crypt_stat *mount_crypt_stat);
537 int ecryptfs_init_crypt_ctx(struct ecryptfs_crypt_stat *crypt_stat);
538 #define ECRYPTFS_LOWER_I_MUTEX_NOT_HELD 0
539 #define ECRYPTFS_LOWER_I_MUTEX_HELD 1
540 int ecryptfs_write_inode_size_to_metadata(struct file *lower_file,
541                                           struct inode *lower_inode,
542                                           struct inode *inode,
543                                           struct dentry *ecryptfs_dentry,
544                                           int lower_i_mutex_held);
545 int ecryptfs_get_lower_page(struct page **lower_page, struct inode *lower_inode,
546                             struct file *lower_file,
547                             unsigned long lower_page_index, int byte_offset,
548                             int region_bytes);
549 int
550 ecryptfs_commit_lower_page(struct page *lower_page, struct inode *lower_inode,
551                            struct file *lower_file, int byte_offset,
552                            int region_size);
553 int ecryptfs_copy_page_to_lower(struct page *page, struct inode *lower_inode,
554                                 struct file *lower_file);
555 int ecryptfs_do_readpage(struct file *file, struct page *page,
556                          pgoff_t lower_page_index);
557 int ecryptfs_writepage_and_release_lower_page(struct page *lower_page,
558                                               struct inode *lower_inode,
559                                               struct writeback_control *wbc);
560 int ecryptfs_encrypt_page(struct ecryptfs_page_crypt_context *ctx);
561 int ecryptfs_decrypt_page(struct file *file, struct page *page);
562 int ecryptfs_write_metadata(struct dentry *ecryptfs_dentry,
563                             struct file *lower_file);
564 int ecryptfs_read_metadata(struct dentry *ecryptfs_dentry,
565                            struct file *lower_file);
566 int ecryptfs_new_file_context(struct dentry *ecryptfs_dentry);
567 int ecryptfs_read_and_validate_header_region(char *data, struct dentry *dentry,
568                                              struct vfsmount *mnt);
569 int ecryptfs_read_and_validate_xattr_region(char *page_virt,
570                                             struct dentry *ecryptfs_dentry);
571 u16 ecryptfs_code_for_cipher_string(struct ecryptfs_crypt_stat *crypt_stat);
572 int ecryptfs_cipher_code_to_string(char *str, u16 cipher_code);
573 void ecryptfs_set_default_sizes(struct ecryptfs_crypt_stat *crypt_stat);
574 int ecryptfs_generate_key_packet_set(char *dest_base,
575                                      struct ecryptfs_crypt_stat *crypt_stat,
576                                      struct dentry *ecryptfs_dentry,
577                                      size_t *len, size_t max);
578 int
579 ecryptfs_parse_packet_set(struct ecryptfs_crypt_stat *crypt_stat,
580                           unsigned char *src, struct dentry *ecryptfs_dentry);
581 int ecryptfs_truncate(struct dentry *dentry, loff_t new_length);
582 int ecryptfs_inode_test(struct inode *inode, void *candidate_lower_inode);
583 int ecryptfs_inode_set(struct inode *inode, void *lower_inode);
584 void ecryptfs_init_inode(struct inode *inode, struct inode *lower_inode);
585 int ecryptfs_open_lower_file(struct file **lower_file,
586                              struct dentry *lower_dentry,
587                              struct vfsmount *lower_mnt, int flags);
588 int ecryptfs_close_lower_file(struct file *lower_file);
589 ssize_t ecryptfs_getxattr(struct dentry *dentry, const char *name, void *value,
590                           size_t size);
591 int
592 ecryptfs_setxattr(struct dentry *dentry, const char *name, const void *value,
593                   size_t size, int flags);
594 int ecryptfs_read_xattr_region(char *page_virt, struct dentry *ecryptfs_dentry);
595 int ecryptfs_process_helo(unsigned int transport, uid_t uid, pid_t pid);
596 int ecryptfs_process_quit(uid_t uid, pid_t pid);
597 int ecryptfs_process_response(struct ecryptfs_message *msg, uid_t uid,
598                               pid_t pid, u32 seq);
599 int ecryptfs_send_message(unsigned int transport, char *data, int data_len,
600                           struct ecryptfs_msg_ctx **msg_ctx);
601 int ecryptfs_wait_for_response(struct ecryptfs_msg_ctx *msg_ctx,
602                                struct ecryptfs_message **emsg);
603 int ecryptfs_init_messaging(unsigned int transport);
604 void ecryptfs_release_messaging(unsigned int transport);
605
606 int ecryptfs_send_netlink(char *data, int data_len,
607                           struct ecryptfs_msg_ctx *msg_ctx, u16 msg_type,
608                           u16 msg_flags, pid_t daemon_pid);
609 int ecryptfs_init_netlink(void);
610 void ecryptfs_release_netlink(void);
611
612 int ecryptfs_send_connector(char *data, int data_len,
613                             struct ecryptfs_msg_ctx *msg_ctx, u16 msg_type,
614                             u16 msg_flags, pid_t daemon_pid);
615 int ecryptfs_init_connector(void);
616 void ecryptfs_release_connector(void);
617 void
618 ecryptfs_write_header_metadata(char *virt,
619                                struct ecryptfs_crypt_stat *crypt_stat,
620                                size_t *written);
621 int ecryptfs_add_keysig(struct ecryptfs_crypt_stat *crypt_stat, char *sig);
622 int
623 ecryptfs_add_global_auth_tok(struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
624                            char *sig);
625 int ecryptfs_get_global_auth_tok_for_sig(
626         struct ecryptfs_global_auth_tok **global_auth_tok,
627         struct ecryptfs_mount_crypt_stat *mount_crypt_stat, char *sig);
628 int
629 ecryptfs_add_new_key_tfm(struct ecryptfs_key_tfm **key_tfm, char *cipher_name,
630                          size_t key_size);
631 int ecryptfs_init_crypto(void);
632 int ecryptfs_destroy_crypto(void);
633 int ecryptfs_get_tfm_and_mutex_for_cipher_name(struct crypto_blkcipher **tfm,
634                                                struct mutex **tfm_mutex,
635                                                char *cipher_name);
636 int ecryptfs_keyring_auth_tok_for_sig(struct key **auth_tok_key,
637                                       struct ecryptfs_auth_tok **auth_tok,
638                                       char *sig);
639 int ecryptfs_write_zeros(struct file *file, pgoff_t index, int start,
640                          int num_zeros);
641
642 #endif /* #ifndef ECRYPTFS_KERNEL_H */