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