xref: /linux/fs/ecryptfs/ecryptfs_kernel.h (revision d6d5aeb661fc14655c417f3582ae7ec52985d2a8)
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 #include <linux/nsproxy.h>
38 
39 /* Version verification for shared data structures w/ userspace */
40 #define ECRYPTFS_VERSION_MAJOR 0x00
41 #define ECRYPTFS_VERSION_MINOR 0x04
42 #define ECRYPTFS_SUPPORTED_FILE_VERSION 0x03
43 /* These flags indicate which features are supported by the kernel
44  * module; userspace tools such as the mount helper read
45  * ECRYPTFS_VERSIONING_MASK from a sysfs handle in order to determine
46  * how to behave. */
47 #define ECRYPTFS_VERSIONING_PASSPHRASE            0x00000001
48 #define ECRYPTFS_VERSIONING_PUBKEY                0x00000002
49 #define ECRYPTFS_VERSIONING_PLAINTEXT_PASSTHROUGH 0x00000004
50 #define ECRYPTFS_VERSIONING_POLICY                0x00000008
51 #define ECRYPTFS_VERSIONING_XATTR                 0x00000010
52 #define ECRYPTFS_VERSIONING_MULTKEY               0x00000020
53 #define ECRYPTFS_VERSIONING_DEVMISC               0x00000040
54 #define ECRYPTFS_VERSIONING_MASK (ECRYPTFS_VERSIONING_PASSPHRASE \
55 				  | ECRYPTFS_VERSIONING_PLAINTEXT_PASSTHROUGH \
56 				  | ECRYPTFS_VERSIONING_PUBKEY \
57 				  | ECRYPTFS_VERSIONING_XATTR \
58 				  | ECRYPTFS_VERSIONING_MULTKEY \
59 				  | ECRYPTFS_VERSIONING_DEVMISC)
60 #define ECRYPTFS_MAX_PASSWORD_LENGTH 64
61 #define ECRYPTFS_MAX_PASSPHRASE_BYTES ECRYPTFS_MAX_PASSWORD_LENGTH
62 #define ECRYPTFS_SALT_SIZE 8
63 #define ECRYPTFS_SALT_SIZE_HEX (ECRYPTFS_SALT_SIZE*2)
64 /* The original signature size is only for what is stored on disk; all
65  * in-memory representations are expanded hex, so it better adapted to
66  * be passed around or referenced on the command line */
67 #define ECRYPTFS_SIG_SIZE 8
68 #define ECRYPTFS_SIG_SIZE_HEX (ECRYPTFS_SIG_SIZE*2)
69 #define ECRYPTFS_PASSWORD_SIG_SIZE ECRYPTFS_SIG_SIZE_HEX
70 #define ECRYPTFS_MAX_KEY_BYTES 64
71 #define ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES 512
72 #define ECRYPTFS_DEFAULT_IV_BYTES 16
73 #define ECRYPTFS_FILE_VERSION 0x03
74 #define ECRYPTFS_DEFAULT_EXTENT_SIZE 4096
75 #define ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE 8192
76 #define ECRYPTFS_DEFAULT_MSG_CTX_ELEMS 32
77 #define ECRYPTFS_DEFAULT_SEND_TIMEOUT HZ
78 #define ECRYPTFS_MAX_MSG_CTX_TTL (HZ*3)
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_TRANSPORT_MISCDEV 3
86 #define ECRYPTFS_DEFAULT_TRANSPORT ECRYPTFS_TRANSPORT_MISCDEV
87 #define ECRYPTFS_XATTR_NAME "user.ecryptfs"
88 
89 #define RFC2440_CIPHER_DES3_EDE 0x02
90 #define RFC2440_CIPHER_CAST_5 0x03
91 #define RFC2440_CIPHER_BLOWFISH 0x04
92 #define RFC2440_CIPHER_AES_128 0x07
93 #define RFC2440_CIPHER_AES_192 0x08
94 #define RFC2440_CIPHER_AES_256 0x09
95 #define RFC2440_CIPHER_TWOFISH 0x0a
96 #define RFC2440_CIPHER_CAST_6 0x0b
97 
98 #define RFC2440_CIPHER_RSA 0x01
99 
100 /**
101  * For convenience, we may need to pass around the encrypted session
102  * key between kernel and userspace because the authentication token
103  * may not be extractable.  For example, the TPM may not release the
104  * private key, instead requiring the encrypted data and returning the
105  * decrypted data.
106  */
107 struct ecryptfs_session_key {
108 #define ECRYPTFS_USERSPACE_SHOULD_TRY_TO_DECRYPT 0x00000001
109 #define ECRYPTFS_USERSPACE_SHOULD_TRY_TO_ENCRYPT 0x00000002
110 #define ECRYPTFS_CONTAINS_DECRYPTED_KEY 0x00000004
111 #define ECRYPTFS_CONTAINS_ENCRYPTED_KEY 0x00000008
112 	u32 flags;
113 	u32 encrypted_key_size;
114 	u32 decrypted_key_size;
115 	u8 encrypted_key[ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES];
116 	u8 decrypted_key[ECRYPTFS_MAX_KEY_BYTES];
117 };
118 
119 struct ecryptfs_password {
120 	u32 password_bytes;
121 	s32 hash_algo;
122 	u32 hash_iterations;
123 	u32 session_key_encryption_key_bytes;
124 #define ECRYPTFS_PERSISTENT_PASSWORD 0x01
125 #define ECRYPTFS_SESSION_KEY_ENCRYPTION_KEY_SET 0x02
126 	u32 flags;
127 	/* Iterated-hash concatenation of salt and passphrase */
128 	u8 session_key_encryption_key[ECRYPTFS_MAX_KEY_BYTES];
129 	u8 signature[ECRYPTFS_PASSWORD_SIG_SIZE + 1];
130 	/* Always in expanded hex */
131 	u8 salt[ECRYPTFS_SALT_SIZE];
132 };
133 
134 enum ecryptfs_token_types {ECRYPTFS_PASSWORD, ECRYPTFS_PRIVATE_KEY};
135 
136 struct ecryptfs_private_key {
137 	u32 key_size;
138 	u32 data_len;
139 	u8 signature[ECRYPTFS_PASSWORD_SIG_SIZE + 1];
140 	char pki_type[ECRYPTFS_MAX_PKI_NAME_BYTES + 1];
141 	u8 data[];
142 };
143 
144 /* May be a password or a private key */
145 struct ecryptfs_auth_tok {
146 	u16 version; /* 8-bit major and 8-bit minor */
147 	u16 token_type;
148 #define ECRYPTFS_ENCRYPT_ONLY 0x00000001
149 	u32 flags;
150 	struct ecryptfs_session_key session_key;
151 	u8 reserved[32];
152 	union {
153 		struct ecryptfs_password password;
154 		struct ecryptfs_private_key private_key;
155 	} token;
156 } __attribute__ ((packed));
157 
158 void ecryptfs_dump_auth_tok(struct ecryptfs_auth_tok *auth_tok);
159 extern void ecryptfs_to_hex(char *dst, char *src, size_t src_size);
160 extern void ecryptfs_from_hex(char *dst, char *src, int dst_size);
161 
162 struct ecryptfs_key_record {
163 	unsigned char type;
164 	size_t enc_key_size;
165 	unsigned char sig[ECRYPTFS_SIG_SIZE];
166 	unsigned char enc_key[ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES];
167 };
168 
169 struct ecryptfs_auth_tok_list {
170 	struct ecryptfs_auth_tok *auth_tok;
171 	struct list_head list;
172 };
173 
174 struct ecryptfs_crypt_stat;
175 struct ecryptfs_mount_crypt_stat;
176 
177 struct ecryptfs_page_crypt_context {
178 	struct page *page;
179 #define ECRYPTFS_PREPARE_COMMIT_MODE 0
180 #define ECRYPTFS_WRITEPAGE_MODE      1
181 	unsigned int mode;
182 	union {
183 		struct file *lower_file;
184 		struct writeback_control *wbc;
185 	} param;
186 };
187 
188 static inline struct ecryptfs_auth_tok *
189 ecryptfs_get_key_payload_data(struct key *key)
190 {
191 	return (struct ecryptfs_auth_tok *)
192 		(((struct user_key_payload*)key->payload.data)->data);
193 }
194 
195 #define ECRYPTFS_SUPER_MAGIC 0xf15f
196 #define ECRYPTFS_MAX_KEYSET_SIZE 1024
197 #define ECRYPTFS_MAX_CIPHER_NAME_SIZE 32
198 #define ECRYPTFS_MAX_NUM_ENC_KEYS 64
199 #define ECRYPTFS_MAX_IV_BYTES 16	/* 128 bits */
200 #define ECRYPTFS_SALT_BYTES 2
201 #define MAGIC_ECRYPTFS_MARKER 0x3c81b7f5
202 #define MAGIC_ECRYPTFS_MARKER_SIZE_BYTES 8	/* 4*2 */
203 #define ECRYPTFS_FILE_SIZE_BYTES (sizeof(u64))
204 #define ECRYPTFS_DEFAULT_CIPHER "aes"
205 #define ECRYPTFS_DEFAULT_KEY_BYTES 16
206 #define ECRYPTFS_DEFAULT_HASH "md5"
207 #define ECRYPTFS_TAG_1_PACKET_TYPE 0x01
208 #define ECRYPTFS_TAG_3_PACKET_TYPE 0x8C
209 #define ECRYPTFS_TAG_11_PACKET_TYPE 0xED
210 #define ECRYPTFS_TAG_64_PACKET_TYPE 0x40
211 #define ECRYPTFS_TAG_65_PACKET_TYPE 0x41
212 #define ECRYPTFS_TAG_66_PACKET_TYPE 0x42
213 #define ECRYPTFS_TAG_67_PACKET_TYPE 0x43
214 #define MD5_DIGEST_SIZE 16
215 
216 struct ecryptfs_key_sig {
217 	struct list_head crypt_stat_list;
218 	char keysig[ECRYPTFS_SIG_SIZE_HEX];
219 };
220 
221 /**
222  * This is the primary struct associated with each encrypted file.
223  *
224  * TODO: cache align/pack?
225  */
226 struct ecryptfs_crypt_stat {
227 #define ECRYPTFS_STRUCT_INITIALIZED 0x00000001
228 #define ECRYPTFS_POLICY_APPLIED     0x00000002
229 #define ECRYPTFS_NEW_FILE           0x00000004
230 #define ECRYPTFS_ENCRYPTED          0x00000008
231 #define ECRYPTFS_SECURITY_WARNING   0x00000010
232 #define ECRYPTFS_ENABLE_HMAC        0x00000020
233 #define ECRYPTFS_ENCRYPT_IV_PAGES   0x00000040
234 #define ECRYPTFS_KEY_VALID          0x00000080
235 #define ECRYPTFS_METADATA_IN_XATTR  0x00000100
236 #define ECRYPTFS_VIEW_AS_ENCRYPTED  0x00000200
237 #define ECRYPTFS_KEY_SET            0x00000400
238 	u32 flags;
239 	unsigned int file_version;
240 	size_t iv_bytes;
241 	size_t num_header_bytes_at_front;
242 	size_t extent_size; /* Data extent size; default is 4096 */
243 	size_t key_size;
244 	size_t extent_shift;
245 	unsigned int extent_mask;
246 	struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
247 	struct crypto_blkcipher *tfm;
248 	struct crypto_hash *hash_tfm; /* Crypto context for generating
249 				       * the initialization vectors */
250 	unsigned char cipher[ECRYPTFS_MAX_CIPHER_NAME_SIZE];
251 	unsigned char key[ECRYPTFS_MAX_KEY_BYTES];
252 	unsigned char root_iv[ECRYPTFS_MAX_IV_BYTES];
253 	struct list_head keysig_list;
254 	struct mutex keysig_list_mutex;
255 	struct mutex cs_tfm_mutex;
256 	struct mutex cs_hash_tfm_mutex;
257 	struct mutex cs_mutex;
258 };
259 
260 /* inode private data. */
261 struct ecryptfs_inode_info {
262 	struct inode vfs_inode;
263 	struct inode *wii_inode;
264 	struct file *lower_file;
265 	struct mutex lower_file_mutex;
266 	struct ecryptfs_crypt_stat crypt_stat;
267 };
268 
269 /* dentry private data. Each dentry must keep track of a lower
270  * vfsmount too. */
271 struct ecryptfs_dentry_info {
272 	struct path lower_path;
273 	struct ecryptfs_crypt_stat *crypt_stat;
274 };
275 
276 /**
277  * ecryptfs_global_auth_tok - A key used to encrypt all new files under the mountpoint
278  * @flags: Status flags
279  * @mount_crypt_stat_list: These auth_toks hang off the mount-wide
280  *                         cryptographic context. Every time a new
281  *                         inode comes into existence, eCryptfs copies
282  *                         the auth_toks on that list to the set of
283  *                         auth_toks on the inode's crypt_stat
284  * @global_auth_tok_key: The key from the user's keyring for the sig
285  * @global_auth_tok: The key contents
286  * @sig: The key identifier
287  *
288  * ecryptfs_global_auth_tok structs refer to authentication token keys
289  * in the user keyring that apply to newly created files. A list of
290  * these objects hangs off of the mount_crypt_stat struct for any
291  * given eCryptfs mount. This struct maintains a reference to both the
292  * key contents and the key itself so that the key can be put on
293  * unmount.
294  */
295 struct ecryptfs_global_auth_tok {
296 #define ECRYPTFS_AUTH_TOK_INVALID 0x00000001
297 	u32 flags;
298 	struct list_head mount_crypt_stat_list;
299 	struct key *global_auth_tok_key;
300 	struct ecryptfs_auth_tok *global_auth_tok;
301 	unsigned char sig[ECRYPTFS_SIG_SIZE_HEX + 1];
302 };
303 
304 /**
305  * ecryptfs_key_tfm - Persistent key tfm
306  * @key_tfm: crypto API handle to the key
307  * @key_size: Key size in bytes
308  * @key_tfm_mutex: Mutex to ensure only one operation in eCryptfs is
309  *                 using the persistent TFM at any point in time
310  * @key_tfm_list: Handle to hang this off the module-wide TFM list
311  * @cipher_name: String name for the cipher for this TFM
312  *
313  * Typically, eCryptfs will use the same ciphers repeatedly throughout
314  * the course of its operations. In order to avoid unnecessarily
315  * destroying and initializing the same cipher repeatedly, eCryptfs
316  * keeps a list of crypto API contexts around to use when needed.
317  */
318 struct ecryptfs_key_tfm {
319 	struct crypto_blkcipher *key_tfm;
320 	size_t key_size;
321 	struct mutex key_tfm_mutex;
322 	struct list_head key_tfm_list;
323 	unsigned char cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE + 1];
324 };
325 
326 extern struct mutex key_tfm_list_mutex;
327 
328 /**
329  * This struct is to enable a mount-wide passphrase/salt combo. This
330  * is more or less a stopgap to provide similar functionality to other
331  * crypto filesystems like EncFS or CFS until full policy support is
332  * implemented in eCryptfs.
333  */
334 struct ecryptfs_mount_crypt_stat {
335 	/* Pointers to memory we do not own, do not free these */
336 #define ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED 0x00000001
337 #define ECRYPTFS_XATTR_METADATA_ENABLED        0x00000002
338 #define ECRYPTFS_ENCRYPTED_VIEW_ENABLED        0x00000004
339 #define ECRYPTFS_MOUNT_CRYPT_STAT_INITIALIZED  0x00000008
340 	u32 flags;
341 	struct list_head global_auth_tok_list;
342 	struct mutex global_auth_tok_list_mutex;
343 	size_t num_global_auth_toks;
344 	size_t global_default_cipher_key_size;
345 	unsigned char global_default_cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE
346 						 + 1];
347 };
348 
349 /* superblock private data. */
350 struct ecryptfs_sb_info {
351 	struct super_block *wsi_sb;
352 	struct ecryptfs_mount_crypt_stat mount_crypt_stat;
353 };
354 
355 /* file private data. */
356 struct ecryptfs_file_info {
357 	struct file *wfi_file;
358 	struct ecryptfs_crypt_stat *crypt_stat;
359 };
360 
361 /* auth_tok <=> encrypted_session_key mappings */
362 struct ecryptfs_auth_tok_list_item {
363 	unsigned char encrypted_session_key[ECRYPTFS_MAX_KEY_BYTES];
364 	struct list_head list;
365 	struct ecryptfs_auth_tok auth_tok;
366 };
367 
368 struct ecryptfs_message {
369 	/* Can never be greater than ecryptfs_message_buf_len */
370 	/* Used to find the parent msg_ctx */
371 	/* Inherits from msg_ctx->index */
372 	u32 index;
373 	u32 data_len;
374 	u8 data[];
375 };
376 
377 struct ecryptfs_msg_ctx {
378 #define ECRYPTFS_MSG_CTX_STATE_FREE     0x01
379 #define ECRYPTFS_MSG_CTX_STATE_PENDING  0x02
380 #define ECRYPTFS_MSG_CTX_STATE_DONE     0x03
381 #define ECRYPTFS_MSG_CTX_STATE_NO_REPLY 0x04
382 	u8 state;
383 #define ECRYPTFS_MSG_HELO 100
384 #define ECRYPTFS_MSG_QUIT 101
385 #define ECRYPTFS_MSG_REQUEST 102
386 #define ECRYPTFS_MSG_RESPONSE 103
387 	u8 type;
388 	u32 index;
389 	/* Counter converts to a sequence number. Each message sent
390 	 * out for which we expect a response has an associated
391 	 * sequence number. The response must have the same sequence
392 	 * number as the counter for the msg_stc for the message to be
393 	 * valid. */
394 	u32 counter;
395 	size_t msg_size;
396 	struct ecryptfs_message *msg;
397 	struct task_struct *task;
398 	struct list_head node;
399 	struct list_head daemon_out_list;
400 	struct mutex mux;
401 };
402 
403 extern unsigned int ecryptfs_transport;
404 
405 struct ecryptfs_daemon;
406 
407 struct ecryptfs_daemon {
408 #define ECRYPTFS_DAEMON_IN_READ      0x00000001
409 #define ECRYPTFS_DAEMON_IN_POLL      0x00000002
410 #define ECRYPTFS_DAEMON_ZOMBIE       0x00000004
411 #define ECRYPTFS_DAEMON_MISCDEV_OPEN 0x00000008
412 	u32 flags;
413 	u32 num_queued_msg_ctx;
414 	struct pid *pid;
415 	uid_t euid;
416 	struct user_namespace *user_ns;
417 	struct task_struct *task;
418 	struct mutex mux;
419 	struct list_head msg_ctx_out_queue;
420 	wait_queue_head_t wait;
421 	struct hlist_node euid_chain;
422 };
423 
424 extern struct mutex ecryptfs_daemon_hash_mux;
425 
426 static inline struct ecryptfs_file_info *
427 ecryptfs_file_to_private(struct file *file)
428 {
429 	return (struct ecryptfs_file_info *)file->private_data;
430 }
431 
432 static inline void
433 ecryptfs_set_file_private(struct file *file,
434 			  struct ecryptfs_file_info *file_info)
435 {
436 	file->private_data = file_info;
437 }
438 
439 static inline struct file *ecryptfs_file_to_lower(struct file *file)
440 {
441 	return ((struct ecryptfs_file_info *)file->private_data)->wfi_file;
442 }
443 
444 static inline void
445 ecryptfs_set_file_lower(struct file *file, struct file *lower_file)
446 {
447 	((struct ecryptfs_file_info *)file->private_data)->wfi_file =
448 		lower_file;
449 }
450 
451 static inline struct ecryptfs_inode_info *
452 ecryptfs_inode_to_private(struct inode *inode)
453 {
454 	return container_of(inode, struct ecryptfs_inode_info, vfs_inode);
455 }
456 
457 static inline struct inode *ecryptfs_inode_to_lower(struct inode *inode)
458 {
459 	return ecryptfs_inode_to_private(inode)->wii_inode;
460 }
461 
462 static inline void
463 ecryptfs_set_inode_lower(struct inode *inode, struct inode *lower_inode)
464 {
465 	ecryptfs_inode_to_private(inode)->wii_inode = lower_inode;
466 }
467 
468 static inline struct ecryptfs_sb_info *
469 ecryptfs_superblock_to_private(struct super_block *sb)
470 {
471 	return (struct ecryptfs_sb_info *)sb->s_fs_info;
472 }
473 
474 static inline void
475 ecryptfs_set_superblock_private(struct super_block *sb,
476 				struct ecryptfs_sb_info *sb_info)
477 {
478 	sb->s_fs_info = sb_info;
479 }
480 
481 static inline struct super_block *
482 ecryptfs_superblock_to_lower(struct super_block *sb)
483 {
484 	return ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb;
485 }
486 
487 static inline void
488 ecryptfs_set_superblock_lower(struct super_block *sb,
489 			      struct super_block *lower_sb)
490 {
491 	((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb = lower_sb;
492 }
493 
494 static inline struct ecryptfs_dentry_info *
495 ecryptfs_dentry_to_private(struct dentry *dentry)
496 {
497 	return (struct ecryptfs_dentry_info *)dentry->d_fsdata;
498 }
499 
500 static inline void
501 ecryptfs_set_dentry_private(struct dentry *dentry,
502 			    struct ecryptfs_dentry_info *dentry_info)
503 {
504 	dentry->d_fsdata = dentry_info;
505 }
506 
507 static inline struct dentry *
508 ecryptfs_dentry_to_lower(struct dentry *dentry)
509 {
510 	return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry;
511 }
512 
513 static inline void
514 ecryptfs_set_dentry_lower(struct dentry *dentry, struct dentry *lower_dentry)
515 {
516 	((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry =
517 		lower_dentry;
518 }
519 
520 static inline struct vfsmount *
521 ecryptfs_dentry_to_lower_mnt(struct dentry *dentry)
522 {
523 	return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt;
524 }
525 
526 static inline void
527 ecryptfs_set_dentry_lower_mnt(struct dentry *dentry, struct vfsmount *lower_mnt)
528 {
529 	((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt =
530 		lower_mnt;
531 }
532 
533 #define ecryptfs_printk(type, fmt, arg...) \
534         __ecryptfs_printk(type "%s: " fmt, __func__, ## arg);
535 void __ecryptfs_printk(const char *fmt, ...);
536 
537 extern const struct file_operations ecryptfs_main_fops;
538 extern const struct file_operations ecryptfs_dir_fops;
539 extern const struct inode_operations ecryptfs_main_iops;
540 extern const struct inode_operations ecryptfs_dir_iops;
541 extern const struct inode_operations ecryptfs_symlink_iops;
542 extern const struct super_operations ecryptfs_sops;
543 extern struct dentry_operations ecryptfs_dops;
544 extern struct address_space_operations ecryptfs_aops;
545 extern int ecryptfs_verbosity;
546 extern unsigned int ecryptfs_message_buf_len;
547 extern signed long ecryptfs_message_wait_timeout;
548 extern unsigned int ecryptfs_number_of_users;
549 
550 extern struct kmem_cache *ecryptfs_auth_tok_list_item_cache;
551 extern struct kmem_cache *ecryptfs_file_info_cache;
552 extern struct kmem_cache *ecryptfs_dentry_info_cache;
553 extern struct kmem_cache *ecryptfs_inode_info_cache;
554 extern struct kmem_cache *ecryptfs_sb_info_cache;
555 extern struct kmem_cache *ecryptfs_header_cache_1;
556 extern struct kmem_cache *ecryptfs_header_cache_2;
557 extern struct kmem_cache *ecryptfs_xattr_cache;
558 extern struct kmem_cache *ecryptfs_key_record_cache;
559 extern struct kmem_cache *ecryptfs_key_sig_cache;
560 extern struct kmem_cache *ecryptfs_global_auth_tok_cache;
561 extern struct kmem_cache *ecryptfs_key_tfm_cache;
562 extern struct kmem_cache *ecryptfs_open_req_cache;
563 
564 struct ecryptfs_open_req {
565 #define ECRYPTFS_REQ_PROCESSED 0x00000001
566 #define ECRYPTFS_REQ_DROPPED   0x00000002
567 #define ECRYPTFS_REQ_ZOMBIE    0x00000004
568 	u32 flags;
569 	struct file **lower_file;
570 	struct dentry *lower_dentry;
571 	struct vfsmount *lower_mnt;
572 	wait_queue_head_t wait;
573 	struct mutex mux;
574 	struct list_head kthread_ctl_list;
575 };
576 
577 #define ECRYPTFS_INTERPOSE_FLAG_D_ADD                 0x00000001
578 int ecryptfs_interpose(struct dentry *hidden_dentry,
579 		       struct dentry *this_dentry, struct super_block *sb,
580 		       u32 flags);
581 int ecryptfs_fill_zeros(struct file *file, loff_t new_length);
582 int ecryptfs_decode_filename(struct ecryptfs_crypt_stat *crypt_stat,
583 			     const char *name, int length,
584 			     char **decrypted_name);
585 int ecryptfs_encode_filename(struct ecryptfs_crypt_stat *crypt_stat,
586 			     const char *name, int length,
587 			     char **encoded_name);
588 struct dentry *ecryptfs_lower_dentry(struct dentry *this_dentry);
589 void ecryptfs_dump_hex(char *data, int bytes);
590 int virt_to_scatterlist(const void *addr, int size, struct scatterlist *sg,
591 			int sg_size);
592 int ecryptfs_compute_root_iv(struct ecryptfs_crypt_stat *crypt_stat);
593 void ecryptfs_rotate_iv(unsigned char *iv);
594 void ecryptfs_init_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
595 void ecryptfs_destroy_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
596 void ecryptfs_destroy_mount_crypt_stat(
597 	struct ecryptfs_mount_crypt_stat *mount_crypt_stat);
598 int ecryptfs_init_crypt_ctx(struct ecryptfs_crypt_stat *crypt_stat);
599 int ecryptfs_write_inode_size_to_metadata(struct inode *ecryptfs_inode);
600 int ecryptfs_encrypt_page(struct page *page);
601 int ecryptfs_decrypt_page(struct page *page);
602 int ecryptfs_write_metadata(struct dentry *ecryptfs_dentry);
603 int ecryptfs_read_metadata(struct dentry *ecryptfs_dentry);
604 int ecryptfs_new_file_context(struct dentry *ecryptfs_dentry);
605 int ecryptfs_read_and_validate_header_region(char *data,
606 					     struct inode *ecryptfs_inode);
607 int ecryptfs_read_and_validate_xattr_region(char *page_virt,
608 					    struct dentry *ecryptfs_dentry);
609 u8 ecryptfs_code_for_cipher_string(struct ecryptfs_crypt_stat *crypt_stat);
610 int ecryptfs_cipher_code_to_string(char *str, u8 cipher_code);
611 void ecryptfs_set_default_sizes(struct ecryptfs_crypt_stat *crypt_stat);
612 int ecryptfs_generate_key_packet_set(char *dest_base,
613 				     struct ecryptfs_crypt_stat *crypt_stat,
614 				     struct dentry *ecryptfs_dentry,
615 				     size_t *len, size_t max);
616 int
617 ecryptfs_parse_packet_set(struct ecryptfs_crypt_stat *crypt_stat,
618 			  unsigned char *src, struct dentry *ecryptfs_dentry);
619 int ecryptfs_truncate(struct dentry *dentry, loff_t new_length);
620 int ecryptfs_inode_test(struct inode *inode, void *candidate_lower_inode);
621 int ecryptfs_inode_set(struct inode *inode, void *lower_inode);
622 void ecryptfs_init_inode(struct inode *inode, struct inode *lower_inode);
623 ssize_t
624 ecryptfs_getxattr_lower(struct dentry *lower_dentry, const char *name,
625 			void *value, size_t size);
626 int
627 ecryptfs_setxattr(struct dentry *dentry, const char *name, const void *value,
628 		  size_t size, int flags);
629 int ecryptfs_read_xattr_region(char *page_virt, struct inode *ecryptfs_inode);
630 int ecryptfs_process_helo(unsigned int transport, uid_t euid,
631 			  struct user_namespace *user_ns, struct pid *pid);
632 int ecryptfs_process_quit(uid_t euid, struct user_namespace *user_ns,
633 			  struct pid *pid);
634 int ecryptfs_process_response(struct ecryptfs_message *msg, uid_t euid,
635 			      struct user_namespace *user_ns, struct pid *pid,
636 			      u32 seq);
637 int ecryptfs_send_message(unsigned int transport, char *data, int data_len,
638 			  struct ecryptfs_msg_ctx **msg_ctx);
639 int ecryptfs_wait_for_response(struct ecryptfs_msg_ctx *msg_ctx,
640 			       struct ecryptfs_message **emsg);
641 int ecryptfs_init_messaging(unsigned int transport);
642 void ecryptfs_release_messaging(unsigned int transport);
643 
644 int ecryptfs_send_netlink(char *data, int data_len,
645 			  struct ecryptfs_msg_ctx *msg_ctx, u8 msg_type,
646 			  u16 msg_flags, struct pid *daemon_pid);
647 int ecryptfs_init_netlink(void);
648 void ecryptfs_release_netlink(void);
649 
650 int ecryptfs_send_connector(char *data, int data_len,
651 			    struct ecryptfs_msg_ctx *msg_ctx, u8 msg_type,
652 			    u16 msg_flags, struct pid *daemon_pid);
653 int ecryptfs_init_connector(void);
654 void ecryptfs_release_connector(void);
655 void
656 ecryptfs_write_header_metadata(char *virt,
657 			       struct ecryptfs_crypt_stat *crypt_stat,
658 			       size_t *written);
659 int ecryptfs_add_keysig(struct ecryptfs_crypt_stat *crypt_stat, char *sig);
660 int
661 ecryptfs_add_global_auth_tok(struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
662 			   char *sig);
663 int ecryptfs_get_global_auth_tok_for_sig(
664 	struct ecryptfs_global_auth_tok **global_auth_tok,
665 	struct ecryptfs_mount_crypt_stat *mount_crypt_stat, char *sig);
666 int
667 ecryptfs_add_new_key_tfm(struct ecryptfs_key_tfm **key_tfm, char *cipher_name,
668 			 size_t key_size);
669 int ecryptfs_init_crypto(void);
670 int ecryptfs_destroy_crypto(void);
671 int ecryptfs_tfm_exists(char *cipher_name, struct ecryptfs_key_tfm **key_tfm);
672 int ecryptfs_get_tfm_and_mutex_for_cipher_name(struct crypto_blkcipher **tfm,
673 					       struct mutex **tfm_mutex,
674 					       char *cipher_name);
675 int ecryptfs_keyring_auth_tok_for_sig(struct key **auth_tok_key,
676 				      struct ecryptfs_auth_tok **auth_tok,
677 				      char *sig);
678 int ecryptfs_write_lower(struct inode *ecryptfs_inode, char *data,
679 			 loff_t offset, size_t size);
680 int ecryptfs_write_lower_page_segment(struct inode *ecryptfs_inode,
681 				      struct page *page_for_lower,
682 				      size_t offset_in_page, size_t size);
683 int ecryptfs_write(struct file *ecryptfs_file, char *data, loff_t offset,
684 		   size_t size);
685 int ecryptfs_read_lower(char *data, loff_t offset, size_t size,
686 			struct inode *ecryptfs_inode);
687 int ecryptfs_read_lower_page_segment(struct page *page_for_ecryptfs,
688 				     pgoff_t page_index,
689 				     size_t offset_in_page, size_t size,
690 				     struct inode *ecryptfs_inode);
691 struct page *ecryptfs_get_locked_page(struct file *file, loff_t index);
692 int ecryptfs_exorcise_daemon(struct ecryptfs_daemon *daemon);
693 int ecryptfs_find_daemon_by_euid(struct ecryptfs_daemon **daemon, uid_t euid,
694 				 struct user_namespace *user_ns);
695 int ecryptfs_parse_packet_length(unsigned char *data, size_t *size,
696 				 size_t *length_size);
697 int ecryptfs_write_packet_length(char *dest, size_t size,
698 				 size_t *packet_size_length);
699 int ecryptfs_init_ecryptfs_miscdev(void);
700 void ecryptfs_destroy_ecryptfs_miscdev(void);
701 int ecryptfs_send_miscdev(char *data, size_t data_size,
702 			  struct ecryptfs_msg_ctx *msg_ctx, u8 msg_type,
703 			  u16 msg_flags, struct ecryptfs_daemon *daemon);
704 void ecryptfs_msg_ctx_alloc_to_free(struct ecryptfs_msg_ctx *msg_ctx);
705 int
706 ecryptfs_spawn_daemon(struct ecryptfs_daemon **daemon, uid_t euid,
707 		      struct user_namespace *user_ns, struct pid *pid);
708 int ecryptfs_init_kthread(void);
709 void ecryptfs_destroy_kthread(void);
710 int ecryptfs_privileged_open(struct file **lower_file,
711 			     struct dentry *lower_dentry,
712 			     struct vfsmount *lower_mnt);
713 int ecryptfs_init_persistent_file(struct dentry *ecryptfs_dentry);
714 
715 #endif /* #ifndef ECRYPTFS_KERNEL_H */
716