xref: /openbmc/linux/fs/ecryptfs/ecryptfs_kernel.h (revision dd2a3b7ad98f8482cae481cad89dfed5eee48365)
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_MASK (ECRYPTFS_VERSIONING_PASSPHRASE \
52 				  | ECRYPTFS_VERSIONING_PLAINTEXT_PASSTHROUGH \
53 				  | ECRYPTFS_VERSIONING_PUBKEY \
54 				  | ECRYPTFS_VERSIONING_XATTR)
55 #define ECRYPTFS_MAX_PASSWORD_LENGTH 64
56 #define ECRYPTFS_MAX_PASSPHRASE_BYTES ECRYPTFS_MAX_PASSWORD_LENGTH
57 #define ECRYPTFS_SALT_SIZE 8
58 #define ECRYPTFS_SALT_SIZE_HEX (ECRYPTFS_SALT_SIZE*2)
59 /* The original signature size is only for what is stored on disk; all
60  * in-memory representations are expanded hex, so it better adapted to
61  * be passed around or referenced on the command line */
62 #define ECRYPTFS_SIG_SIZE 8
63 #define ECRYPTFS_SIG_SIZE_HEX (ECRYPTFS_SIG_SIZE*2)
64 #define ECRYPTFS_PASSWORD_SIG_SIZE ECRYPTFS_SIG_SIZE_HEX
65 #define ECRYPTFS_MAX_KEY_BYTES 64
66 #define ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES 512
67 #define ECRYPTFS_DEFAULT_IV_BYTES 16
68 #define ECRYPTFS_FILE_VERSION 0x02
69 #define ECRYPTFS_DEFAULT_HEADER_EXTENT_SIZE 8192
70 #define ECRYPTFS_DEFAULT_EXTENT_SIZE 4096
71 #define ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE 8192
72 #define ECRYPTFS_DEFAULT_MSG_CTX_ELEMS 32
73 #define ECRYPTFS_DEFAULT_SEND_TIMEOUT HZ
74 #define ECRYPTFS_MAX_MSG_CTX_TTL (HZ*3)
75 #define ECRYPTFS_NLMSG_HELO 100
76 #define ECRYPTFS_NLMSG_QUIT 101
77 #define ECRYPTFS_NLMSG_REQUEST 102
78 #define ECRYPTFS_NLMSG_RESPONSE 103
79 #define ECRYPTFS_MAX_PKI_NAME_BYTES 16
80 #define ECRYPTFS_DEFAULT_NUM_USERS 4
81 #define ECRYPTFS_MAX_NUM_USERS 32768
82 #define ECRYPTFS_TRANSPORT_NETLINK 0
83 #define ECRYPTFS_TRANSPORT_CONNECTOR 1
84 #define ECRYPTFS_TRANSPORT_RELAYFS 2
85 #define ECRYPTFS_DEFAULT_TRANSPORT ECRYPTFS_TRANSPORT_NETLINK
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 ECRYPTFS_SET_FLAG(flag_bit_vector, flag) (flag_bit_vector |= (flag))
98 #define ECRYPTFS_CLEAR_FLAG(flag_bit_vector, flag) (flag_bit_vector &= ~(flag))
99 #define ECRYPTFS_CHECK_FLAG(flag_bit_vector, flag) (flag_bit_vector & (flag))
100 #define RFC2440_CIPHER_RSA 0x01
101 
102 /**
103  * For convenience, we may need to pass around the encrypted session
104  * key between kernel and userspace because the authentication token
105  * may not be extractable.  For example, the TPM may not release the
106  * private key, instead requiring the encrypted data and returning the
107  * decrypted data.
108  */
109 struct ecryptfs_session_key {
110 #define ECRYPTFS_USERSPACE_SHOULD_TRY_TO_DECRYPT 0x00000001
111 #define ECRYPTFS_USERSPACE_SHOULD_TRY_TO_ENCRYPT 0x00000002
112 #define ECRYPTFS_CONTAINS_DECRYPTED_KEY 0x00000004
113 #define ECRYPTFS_CONTAINS_ENCRYPTED_KEY 0x00000008
114 	u32 flags;
115 	u32 encrypted_key_size;
116 	u32 decrypted_key_size;
117 	u8 encrypted_key[ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES];
118 	u8 decrypted_key[ECRYPTFS_MAX_KEY_BYTES];
119 };
120 
121 struct ecryptfs_password {
122 	u32 password_bytes;
123 	s32 hash_algo;
124 	u32 hash_iterations;
125 	u32 session_key_encryption_key_bytes;
126 #define ECRYPTFS_PERSISTENT_PASSWORD 0x01
127 #define ECRYPTFS_SESSION_KEY_ENCRYPTION_KEY_SET 0x02
128 	u32 flags;
129 	/* Iterated-hash concatenation of salt and passphrase */
130 	u8 session_key_encryption_key[ECRYPTFS_MAX_KEY_BYTES];
131 	u8 signature[ECRYPTFS_PASSWORD_SIG_SIZE + 1];
132 	/* Always in expanded hex */
133 	u8 salt[ECRYPTFS_SALT_SIZE];
134 };
135 
136 enum ecryptfs_token_types {ECRYPTFS_PASSWORD, ECRYPTFS_PRIVATE_KEY};
137 
138 struct ecryptfs_private_key {
139 	u32 key_size;
140 	u32 data_len;
141 	u8 signature[ECRYPTFS_PASSWORD_SIG_SIZE + 1];
142 	char pki_type[ECRYPTFS_MAX_PKI_NAME_BYTES + 1];
143 	u8 data[];
144 };
145 
146 /* May be a password or a private key */
147 struct ecryptfs_auth_tok {
148 	u16 version; /* 8-bit major and 8-bit minor */
149 	u16 token_type;
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_NUM_KEYSIGS 2 /* TODO: Make this a linked list */
201 #define ECRYPTFS_MAX_IV_BYTES 16	/* 128 bits */
202 #define ECRYPTFS_SALT_BYTES 2
203 #define MAGIC_ECRYPTFS_MARKER 0x3c81b7f5
204 #define MAGIC_ECRYPTFS_MARKER_SIZE_BYTES 8	/* 4*2 */
205 #define ECRYPTFS_FILE_SIZE_BYTES 8
206 #define ECRYPTFS_DEFAULT_CIPHER "aes"
207 #define ECRYPTFS_DEFAULT_KEY_BYTES 16
208 #define ECRYPTFS_DEFAULT_HASH "md5"
209 #define ECRYPTFS_TAG_1_PACKET_TYPE 0x01
210 #define ECRYPTFS_TAG_3_PACKET_TYPE 0x8C
211 #define ECRYPTFS_TAG_11_PACKET_TYPE 0xED
212 #define ECRYPTFS_TAG_64_PACKET_TYPE 0x40
213 #define ECRYPTFS_TAG_65_PACKET_TYPE 0x41
214 #define ECRYPTFS_TAG_66_PACKET_TYPE 0x42
215 #define ECRYPTFS_TAG_67_PACKET_TYPE 0x43
216 #define MD5_DIGEST_SIZE 16
217 
218 /**
219  * This is the primary struct associated with each encrypted file.
220  *
221  * TODO: cache align/pack?
222  */
223 struct ecryptfs_crypt_stat {
224 #define ECRYPTFS_STRUCT_INITIALIZED 0x00000001
225 #define ECRYPTFS_POLICY_APPLIED     0x00000002
226 #define ECRYPTFS_NEW_FILE           0x00000004
227 #define ECRYPTFS_ENCRYPTED          0x00000008
228 #define ECRYPTFS_SECURITY_WARNING   0x00000010
229 #define ECRYPTFS_ENABLE_HMAC        0x00000020
230 #define ECRYPTFS_ENCRYPT_IV_PAGES   0x00000040
231 #define ECRYPTFS_KEY_VALID          0x00000080
232 #define ECRYPTFS_METADATA_IN_XATTR  0x00000100
233 #define ECRYPTFS_VIEW_AS_ENCRYPTED  0x00000200
234 	u32 flags;
235 	unsigned int file_version;
236 	size_t iv_bytes;
237 	size_t num_keysigs;
238 	size_t header_extent_size;
239 	size_t num_header_extents_at_front;
240 	size_t extent_size; /* Data extent size; default is 4096 */
241 	size_t key_size;
242 	size_t extent_shift;
243 	unsigned int extent_mask;
244 	struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
245 	struct crypto_blkcipher *tfm;
246 	struct crypto_hash *hash_tfm; /* Crypto context for generating
247 				       * the initialization vectors */
248 	unsigned char cipher[ECRYPTFS_MAX_CIPHER_NAME_SIZE];
249 	unsigned char key[ECRYPTFS_MAX_KEY_BYTES];
250 	unsigned char root_iv[ECRYPTFS_MAX_IV_BYTES];
251 	unsigned char keysigs[ECRYPTFS_MAX_NUM_KEYSIGS][ECRYPTFS_SIG_SIZE_HEX];
252 	struct mutex cs_tfm_mutex;
253 	struct mutex cs_hash_tfm_mutex;
254 	struct mutex cs_mutex;
255 };
256 
257 /* inode private data. */
258 struct ecryptfs_inode_info {
259 	struct inode vfs_inode;
260 	struct inode *wii_inode;
261 	struct ecryptfs_crypt_stat crypt_stat;
262 };
263 
264 /* dentry private data. Each dentry must keep track of a lower
265  * vfsmount too. */
266 struct ecryptfs_dentry_info {
267 	struct path lower_path;
268 	struct ecryptfs_crypt_stat *crypt_stat;
269 };
270 
271 /**
272  * This struct is to enable a mount-wide passphrase/salt combo. This
273  * is more or less a stopgap to provide similar functionality to other
274  * crypto filesystems like EncFS or CFS until full policy support is
275  * implemented in eCryptfs.
276  */
277 struct ecryptfs_mount_crypt_stat {
278 	/* Pointers to memory we do not own, do not free these */
279 #define ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED 0x00000001
280 #define ECRYPTFS_XATTR_METADATA_ENABLED        0x00000002
281 #define ECRYPTFS_ENCRYPTED_VIEW_ENABLED        0x00000004
282 	u32 flags;
283 	struct ecryptfs_auth_tok *global_auth_tok;
284 	struct key *global_auth_tok_key;
285 	size_t global_default_cipher_key_size;
286 	struct crypto_blkcipher *global_key_tfm;
287 	struct mutex global_key_tfm_mutex;
288 	unsigned char global_default_cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE
289 						 + 1];
290 	unsigned char global_auth_tok_sig[ECRYPTFS_SIG_SIZE_HEX + 1];
291 };
292 
293 /* superblock private data. */
294 struct ecryptfs_sb_info {
295 	struct super_block *wsi_sb;
296 	struct ecryptfs_mount_crypt_stat mount_crypt_stat;
297 };
298 
299 /* file private data. */
300 struct ecryptfs_file_info {
301 	struct file *wfi_file;
302 	struct ecryptfs_crypt_stat *crypt_stat;
303 };
304 
305 /* auth_tok <=> encrypted_session_key mappings */
306 struct ecryptfs_auth_tok_list_item {
307 	unsigned char encrypted_session_key[ECRYPTFS_MAX_KEY_BYTES];
308 	struct list_head list;
309 	struct ecryptfs_auth_tok auth_tok;
310 };
311 
312 struct ecryptfs_message {
313 	u32 index;
314 	u32 data_len;
315 	u8 data[];
316 };
317 
318 struct ecryptfs_msg_ctx {
319 #define ECRYPTFS_MSG_CTX_STATE_FREE      0x0001
320 #define ECRYPTFS_MSG_CTX_STATE_PENDING   0x0002
321 #define ECRYPTFS_MSG_CTX_STATE_DONE      0x0003
322 	u32 state;
323 	unsigned int index;
324 	unsigned int counter;
325 	struct ecryptfs_message *msg;
326 	struct task_struct *task;
327 	struct list_head node;
328 	struct mutex mux;
329 };
330 
331 extern unsigned int ecryptfs_transport;
332 
333 struct ecryptfs_daemon_id {
334 	pid_t pid;
335 	uid_t uid;
336 	struct hlist_node id_chain;
337 };
338 
339 static inline struct ecryptfs_file_info *
340 ecryptfs_file_to_private(struct file *file)
341 {
342 	return (struct ecryptfs_file_info *)file->private_data;
343 }
344 
345 static inline void
346 ecryptfs_set_file_private(struct file *file,
347 			  struct ecryptfs_file_info *file_info)
348 {
349 	file->private_data = file_info;
350 }
351 
352 static inline struct file *ecryptfs_file_to_lower(struct file *file)
353 {
354 	return ((struct ecryptfs_file_info *)file->private_data)->wfi_file;
355 }
356 
357 static inline void
358 ecryptfs_set_file_lower(struct file *file, struct file *lower_file)
359 {
360 	((struct ecryptfs_file_info *)file->private_data)->wfi_file =
361 		lower_file;
362 }
363 
364 static inline struct ecryptfs_inode_info *
365 ecryptfs_inode_to_private(struct inode *inode)
366 {
367 	return container_of(inode, struct ecryptfs_inode_info, vfs_inode);
368 }
369 
370 static inline struct inode *ecryptfs_inode_to_lower(struct inode *inode)
371 {
372 	return ecryptfs_inode_to_private(inode)->wii_inode;
373 }
374 
375 static inline void
376 ecryptfs_set_inode_lower(struct inode *inode, struct inode *lower_inode)
377 {
378 	ecryptfs_inode_to_private(inode)->wii_inode = lower_inode;
379 }
380 
381 static inline struct ecryptfs_sb_info *
382 ecryptfs_superblock_to_private(struct super_block *sb)
383 {
384 	return (struct ecryptfs_sb_info *)sb->s_fs_info;
385 }
386 
387 static inline void
388 ecryptfs_set_superblock_private(struct super_block *sb,
389 				struct ecryptfs_sb_info *sb_info)
390 {
391 	sb->s_fs_info = sb_info;
392 }
393 
394 static inline struct super_block *
395 ecryptfs_superblock_to_lower(struct super_block *sb)
396 {
397 	return ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb;
398 }
399 
400 static inline void
401 ecryptfs_set_superblock_lower(struct super_block *sb,
402 			      struct super_block *lower_sb)
403 {
404 	((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb = lower_sb;
405 }
406 
407 static inline struct ecryptfs_dentry_info *
408 ecryptfs_dentry_to_private(struct dentry *dentry)
409 {
410 	return (struct ecryptfs_dentry_info *)dentry->d_fsdata;
411 }
412 
413 static inline void
414 ecryptfs_set_dentry_private(struct dentry *dentry,
415 			    struct ecryptfs_dentry_info *dentry_info)
416 {
417 	dentry->d_fsdata = dentry_info;
418 }
419 
420 static inline struct dentry *
421 ecryptfs_dentry_to_lower(struct dentry *dentry)
422 {
423 	return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry;
424 }
425 
426 static inline void
427 ecryptfs_set_dentry_lower(struct dentry *dentry, struct dentry *lower_dentry)
428 {
429 	((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry =
430 		lower_dentry;
431 }
432 
433 static inline struct vfsmount *
434 ecryptfs_dentry_to_lower_mnt(struct dentry *dentry)
435 {
436 	return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt;
437 }
438 
439 static inline void
440 ecryptfs_set_dentry_lower_mnt(struct dentry *dentry, struct vfsmount *lower_mnt)
441 {
442 	((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt =
443 		lower_mnt;
444 }
445 
446 #define ecryptfs_printk(type, fmt, arg...) \
447         __ecryptfs_printk(type "%s: " fmt, __FUNCTION__, ## arg);
448 void __ecryptfs_printk(const char *fmt, ...);
449 
450 extern const struct file_operations ecryptfs_main_fops;
451 extern const struct file_operations ecryptfs_dir_fops;
452 extern struct inode_operations ecryptfs_main_iops;
453 extern struct inode_operations ecryptfs_dir_iops;
454 extern struct inode_operations ecryptfs_symlink_iops;
455 extern struct super_operations ecryptfs_sops;
456 extern struct dentry_operations ecryptfs_dops;
457 extern struct address_space_operations ecryptfs_aops;
458 extern int ecryptfs_verbosity;
459 extern unsigned int ecryptfs_message_buf_len;
460 extern signed long ecryptfs_message_wait_timeout;
461 extern unsigned int ecryptfs_number_of_users;
462 
463 extern struct kmem_cache *ecryptfs_auth_tok_list_item_cache;
464 extern struct kmem_cache *ecryptfs_file_info_cache;
465 extern struct kmem_cache *ecryptfs_dentry_info_cache;
466 extern struct kmem_cache *ecryptfs_inode_info_cache;
467 extern struct kmem_cache *ecryptfs_sb_info_cache;
468 extern struct kmem_cache *ecryptfs_header_cache_0;
469 extern struct kmem_cache *ecryptfs_header_cache_1;
470 extern struct kmem_cache *ecryptfs_header_cache_2;
471 extern struct kmem_cache *ecryptfs_xattr_cache;
472 extern struct kmem_cache *ecryptfs_lower_page_cache;
473 
474 int ecryptfs_interpose(struct dentry *hidden_dentry,
475 		       struct dentry *this_dentry, struct super_block *sb,
476 		       int flag);
477 int ecryptfs_fill_zeros(struct file *file, loff_t new_length);
478 int ecryptfs_decode_filename(struct ecryptfs_crypt_stat *crypt_stat,
479 			     const char *name, int length,
480 			     char **decrypted_name);
481 int ecryptfs_encode_filename(struct ecryptfs_crypt_stat *crypt_stat,
482 			     const char *name, int length,
483 			     char **encoded_name);
484 struct dentry *ecryptfs_lower_dentry(struct dentry *this_dentry);
485 void ecryptfs_dump_hex(char *data, int bytes);
486 int virt_to_scatterlist(const void *addr, int size, struct scatterlist *sg,
487 			int sg_size);
488 int ecryptfs_compute_root_iv(struct ecryptfs_crypt_stat *crypt_stat);
489 void ecryptfs_rotate_iv(unsigned char *iv);
490 void ecryptfs_init_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
491 void ecryptfs_destruct_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
492 void ecryptfs_destruct_mount_crypt_stat(
493 	struct ecryptfs_mount_crypt_stat *mount_crypt_stat);
494 int ecryptfs_init_crypt_ctx(struct ecryptfs_crypt_stat *crypt_stat);
495 int ecryptfs_crypto_api_algify_cipher_name(char **algified_name,
496 					   char *cipher_name,
497 					   char *chaining_modifier);
498 #define ECRYPTFS_LOWER_I_MUTEX_NOT_HELD 0
499 #define ECRYPTFS_LOWER_I_MUTEX_HELD 1
500 int ecryptfs_write_inode_size_to_metadata(struct file *lower_file,
501 					  struct inode *lower_inode,
502 					  struct inode *inode,
503 					  struct dentry *ecryptfs_dentry,
504 					  int lower_i_mutex_held);
505 int ecryptfs_get_lower_page(struct page **lower_page, struct inode *lower_inode,
506 			    struct file *lower_file,
507 			    unsigned long lower_page_index, int byte_offset,
508 			    int region_bytes);
509 int
510 ecryptfs_commit_lower_page(struct page *lower_page, struct inode *lower_inode,
511 			   struct file *lower_file, int byte_offset,
512 			   int region_size);
513 int ecryptfs_copy_page_to_lower(struct page *page, struct inode *lower_inode,
514 				struct file *lower_file);
515 int ecryptfs_do_readpage(struct file *file, struct page *page,
516 			 pgoff_t lower_page_index);
517 int ecryptfs_grab_and_map_lower_page(struct page **lower_page,
518 				     char **lower_virt,
519 				     struct inode *lower_inode,
520 				     unsigned long lower_page_index);
521 int ecryptfs_writepage_and_release_lower_page(struct page *lower_page,
522 					      struct inode *lower_inode,
523 					      struct writeback_control *wbc);
524 int ecryptfs_encrypt_page(struct ecryptfs_page_crypt_context *ctx);
525 int ecryptfs_decrypt_page(struct file *file, struct page *page);
526 int ecryptfs_write_metadata(struct dentry *ecryptfs_dentry,
527 			    struct file *lower_file);
528 int ecryptfs_read_metadata(struct dentry *ecryptfs_dentry,
529 			   struct file *lower_file);
530 int ecryptfs_new_file_context(struct dentry *ecryptfs_dentry);
531 int ecryptfs_read_and_validate_header_region(char *data, struct dentry *dentry,
532 					     struct vfsmount *mnt);
533 int ecryptfs_read_and_validate_xattr_region(char *page_virt,
534 					    struct dentry *ecryptfs_dentry);
535 u16 ecryptfs_code_for_cipher_string(struct ecryptfs_crypt_stat *crypt_stat);
536 int ecryptfs_cipher_code_to_string(char *str, u16 cipher_code);
537 void ecryptfs_set_default_sizes(struct ecryptfs_crypt_stat *crypt_stat);
538 int ecryptfs_generate_key_packet_set(char *dest_base,
539 				     struct ecryptfs_crypt_stat *crypt_stat,
540 				     struct dentry *ecryptfs_dentry,
541 				     size_t *len, size_t max);
542 int process_request_key_err(long err_code);
543 int
544 ecryptfs_parse_packet_set(struct ecryptfs_crypt_stat *crypt_stat,
545 			  unsigned char *src, struct dentry *ecryptfs_dentry);
546 int ecryptfs_truncate(struct dentry *dentry, loff_t new_length);
547 int
548 ecryptfs_process_cipher(struct crypto_blkcipher **key_tfm, char *cipher_name,
549 			size_t *key_size);
550 int ecryptfs_inode_test(struct inode *inode, void *candidate_lower_inode);
551 int ecryptfs_inode_set(struct inode *inode, void *lower_inode);
552 void ecryptfs_init_inode(struct inode *inode, struct inode *lower_inode);
553 int ecryptfs_open_lower_file(struct file **lower_file,
554 			     struct dentry *lower_dentry,
555 			     struct vfsmount *lower_mnt, int flags);
556 int ecryptfs_close_lower_file(struct file *lower_file);
557 ssize_t ecryptfs_getxattr(struct dentry *dentry, const char *name, void *value,
558 			  size_t size);
559 int
560 ecryptfs_setxattr(struct dentry *dentry, const char *name, const void *value,
561 		  size_t size, int flags);
562 
563 int ecryptfs_process_helo(unsigned int transport, uid_t uid, pid_t pid);
564 int ecryptfs_process_quit(uid_t uid, pid_t pid);
565 int ecryptfs_process_response(struct ecryptfs_message *msg, uid_t uid,
566 			      pid_t pid, u32 seq);
567 int ecryptfs_send_message(unsigned int transport, char *data, int data_len,
568 			  struct ecryptfs_msg_ctx **msg_ctx);
569 int ecryptfs_wait_for_response(struct ecryptfs_msg_ctx *msg_ctx,
570 			       struct ecryptfs_message **emsg);
571 int ecryptfs_init_messaging(unsigned int transport);
572 void ecryptfs_release_messaging(unsigned int transport);
573 
574 int ecryptfs_send_netlink(char *data, int data_len,
575 			  struct ecryptfs_msg_ctx *msg_ctx, u16 msg_type,
576 			  u16 msg_flags, pid_t daemon_pid);
577 int ecryptfs_init_netlink(void);
578 void ecryptfs_release_netlink(void);
579 
580 int ecryptfs_send_connector(char *data, int data_len,
581 			    struct ecryptfs_msg_ctx *msg_ctx, u16 msg_type,
582 			    u16 msg_flags, pid_t daemon_pid);
583 int ecryptfs_init_connector(void);
584 void ecryptfs_release_connector(void);
585 
586 
587 #endif /* #ifndef ECRYPTFS_KERNEL_H */
588