2 * eCryptfs: Linux filesystem encryption layer
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>
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.
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.
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
28 #ifndef ECRYPTFS_KERNEL_H
29 #define ECRYPTFS_KERNEL_H
31 #include <keys/user-type.h>
32 #include <keys/encrypted-type.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>
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"
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
);
56 struct ecryptfs_key_record
{
59 unsigned char sig
[ECRYPTFS_SIG_SIZE
];
60 unsigned char enc_key
[ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES
];
63 struct ecryptfs_auth_tok_list
{
64 struct ecryptfs_auth_tok
*auth_tok
;
65 struct list_head list
;
68 struct ecryptfs_crypt_stat
;
69 struct ecryptfs_mount_crypt_stat
;
71 struct ecryptfs_page_crypt_context
{
73 #define ECRYPTFS_PREPARE_COMMIT_MODE 0
74 #define ECRYPTFS_WRITEPAGE_MODE 1
77 struct file
*lower_file
;
78 struct writeback_control
*wbc
;
82 #if defined(CONFIG_ENCRYPTED_KEYS) || defined(CONFIG_ENCRYPTED_KEYS_MODULE)
83 static inline struct ecryptfs_auth_tok
*
84 ecryptfs_get_encrypted_key_payload_data(struct key
*key
)
86 if (key
->type
== &key_type_encrypted
)
87 return (struct ecryptfs_auth_tok
*)
88 (&((struct encrypted_key_payload
*)key
->payload
.data
)->payload_data
);
93 static inline struct key
*ecryptfs_get_encrypted_key(char *sig
)
95 return request_key(&key_type_encrypted
, sig
, NULL
);
99 static inline struct ecryptfs_auth_tok
*
100 ecryptfs_get_encrypted_key_payload_data(struct key
*key
)
105 static inline struct key
*ecryptfs_get_encrypted_key(char *sig
)
107 return ERR_PTR(-ENOKEY
);
110 #endif /* CONFIG_ENCRYPTED_KEYS */
112 static inline struct ecryptfs_auth_tok
*
113 ecryptfs_get_key_payload_data(struct key
*key
)
115 struct ecryptfs_auth_tok
*auth_tok
;
117 auth_tok
= ecryptfs_get_encrypted_key_payload_data(key
);
119 return (struct ecryptfs_auth_tok
*)
120 (((struct user_key_payload
*)key
->payload
.data
)->data
);
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
148 #define ECRYPTFS_TAG_71_PACKET_TYPE 0x47 /* FNEK-encrypted filename in
150 #define ECRYPTFS_TAG_72_PACKET_TYPE 0x48 /* FEK-encrypted filename as
152 #define ECRYPTFS_TAG_73_PACKET_TYPE 0x49 /* FEK-encrypted filename as
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()
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)
175 #ifdef CONFIG_ECRYPT_FS_MESSAGING
176 # define ECRYPTFS_VERSIONING_MASK_MESSAGING (ECRYPTFS_VERSIONING_DEVMISC \
177 | ECRYPTFS_VERSIONING_PUBKEY)
179 # define ECRYPTFS_VERSIONING_MASK_MESSAGING 0
182 #define ECRYPTFS_VERSIONING_MASK (ECRYPTFS_VERSIONING_PASSPHRASE \
183 | ECRYPTFS_VERSIONING_PLAINTEXT_PASSTHROUGH \
184 | ECRYPTFS_VERSIONING_XATTR \
185 | ECRYPTFS_VERSIONING_MULTKEY \
186 | ECRYPTFS_VERSIONING_MASK_MESSAGING \
187 | ECRYPTFS_VERSIONING_FILENAME_ENCRYPTION)
188 struct ecryptfs_key_sig
{
189 struct list_head crypt_stat_list
;
190 char keysig
[ECRYPTFS_SIG_SIZE_HEX
+ 1];
193 struct ecryptfs_filename
{
194 struct list_head crypt_stat_list
;
195 #define ECRYPTFS_FILENAME_CONTAINS_DECRYPTED 0x00000001
199 char *encrypted_filename
;
200 size_t filename_size
;
201 size_t encrypted_filename_size
;
202 char fnek_sig
[ECRYPTFS_SIG_SIZE_HEX
];
203 char dentry_name
[ECRYPTFS_ENCRYPTED_DENTRY_NAME_LEN
+ 1];
207 * This is the primary struct associated with each encrypted file.
209 * TODO: cache align/pack?
211 struct ecryptfs_crypt_stat
{
212 #define ECRYPTFS_STRUCT_INITIALIZED 0x00000001
213 #define ECRYPTFS_POLICY_APPLIED 0x00000002
214 #define ECRYPTFS_ENCRYPTED 0x00000004
215 #define ECRYPTFS_SECURITY_WARNING 0x00000008
216 #define ECRYPTFS_ENABLE_HMAC 0x00000010
217 #define ECRYPTFS_ENCRYPT_IV_PAGES 0x00000020
218 #define ECRYPTFS_KEY_VALID 0x00000040
219 #define ECRYPTFS_METADATA_IN_XATTR 0x00000080
220 #define ECRYPTFS_VIEW_AS_ENCRYPTED 0x00000100
221 #define ECRYPTFS_KEY_SET 0x00000200
222 #define ECRYPTFS_ENCRYPT_FILENAMES 0x00000400
223 #define ECRYPTFS_ENCFN_USE_MOUNT_FNEK 0x00000800
224 #define ECRYPTFS_ENCFN_USE_FEK 0x00001000
225 #define ECRYPTFS_UNLINK_SIGS 0x00002000
226 #define ECRYPTFS_I_SIZE_INITIALIZED 0x00004000
228 unsigned int file_version
;
230 size_t metadata_size
;
231 size_t extent_size
; /* Data extent size; default is 4096 */
234 unsigned int extent_mask
;
235 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
236 struct crypto_blkcipher
*tfm
;
237 struct crypto_hash
*hash_tfm
; /* Crypto context for generating
238 * the initialization vectors */
239 unsigned char cipher
[ECRYPTFS_MAX_CIPHER_NAME_SIZE
];
240 unsigned char key
[ECRYPTFS_MAX_KEY_BYTES
];
241 unsigned char root_iv
[ECRYPTFS_MAX_IV_BYTES
];
242 struct list_head keysig_list
;
243 struct mutex keysig_list_mutex
;
244 struct mutex cs_tfm_mutex
;
245 struct mutex cs_hash_tfm_mutex
;
246 struct mutex cs_mutex
;
249 /* inode private data. */
250 struct ecryptfs_inode_info
{
251 struct inode vfs_inode
;
252 struct inode
*wii_inode
;
253 struct mutex lower_file_mutex
;
254 atomic_t lower_file_count
;
255 struct file
*lower_file
;
256 struct ecryptfs_crypt_stat crypt_stat
;
259 /* dentry private data. Each dentry must keep track of a lower
261 struct ecryptfs_dentry_info
{
262 struct path lower_path
;
263 struct ecryptfs_crypt_stat
*crypt_stat
;
267 * ecryptfs_global_auth_tok - A key used to encrypt all new files under the mountpoint
268 * @flags: Status flags
269 * @mount_crypt_stat_list: These auth_toks hang off the mount-wide
270 * cryptographic context. Every time a new
271 * inode comes into existence, eCryptfs copies
272 * the auth_toks on that list to the set of
273 * auth_toks on the inode's crypt_stat
274 * @global_auth_tok_key: The key from the user's keyring for the sig
275 * @global_auth_tok: The key contents
276 * @sig: The key identifier
278 * ecryptfs_global_auth_tok structs refer to authentication token keys
279 * in the user keyring that apply to newly created files. A list of
280 * these objects hangs off of the mount_crypt_stat struct for any
281 * given eCryptfs mount. This struct maintains a reference to both the
282 * key contents and the key itself so that the key can be put on
285 struct ecryptfs_global_auth_tok
{
286 #define ECRYPTFS_AUTH_TOK_INVALID 0x00000001
287 #define ECRYPTFS_AUTH_TOK_FNEK 0x00000002
289 struct list_head mount_crypt_stat_list
;
290 struct key
*global_auth_tok_key
;
291 unsigned char sig
[ECRYPTFS_SIG_SIZE_HEX
+ 1];
295 * ecryptfs_key_tfm - Persistent key tfm
296 * @key_tfm: crypto API handle to the key
297 * @key_size: Key size in bytes
298 * @key_tfm_mutex: Mutex to ensure only one operation in eCryptfs is
299 * using the persistent TFM at any point in time
300 * @key_tfm_list: Handle to hang this off the module-wide TFM list
301 * @cipher_name: String name for the cipher for this TFM
303 * Typically, eCryptfs will use the same ciphers repeatedly throughout
304 * the course of its operations. In order to avoid unnecessarily
305 * destroying and initializing the same cipher repeatedly, eCryptfs
306 * keeps a list of crypto API contexts around to use when needed.
308 struct ecryptfs_key_tfm
{
309 struct crypto_blkcipher
*key_tfm
;
311 struct mutex key_tfm_mutex
;
312 struct list_head key_tfm_list
;
313 unsigned char cipher_name
[ECRYPTFS_MAX_CIPHER_NAME_SIZE
+ 1];
316 extern struct mutex key_tfm_list_mutex
;
319 * This struct is to enable a mount-wide passphrase/salt combo. This
320 * is more or less a stopgap to provide similar functionality to other
321 * crypto filesystems like EncFS or CFS until full policy support is
322 * implemented in eCryptfs.
324 struct ecryptfs_mount_crypt_stat
{
325 /* Pointers to memory we do not own, do not free these */
326 #define ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED 0x00000001
327 #define ECRYPTFS_XATTR_METADATA_ENABLED 0x00000002
328 #define ECRYPTFS_ENCRYPTED_VIEW_ENABLED 0x00000004
329 #define ECRYPTFS_MOUNT_CRYPT_STAT_INITIALIZED 0x00000008
330 #define ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES 0x00000010
331 #define ECRYPTFS_GLOBAL_ENCFN_USE_MOUNT_FNEK 0x00000020
332 #define ECRYPTFS_GLOBAL_ENCFN_USE_FEK 0x00000040
333 #define ECRYPTFS_GLOBAL_MOUNT_AUTH_TOK_ONLY 0x00000080
335 struct list_head global_auth_tok_list
;
336 struct mutex global_auth_tok_list_mutex
;
337 size_t global_default_cipher_key_size
;
338 size_t global_default_fn_cipher_key_bytes
;
339 unsigned char global_default_cipher_name
[ECRYPTFS_MAX_CIPHER_NAME_SIZE
341 unsigned char global_default_fn_cipher_name
[
342 ECRYPTFS_MAX_CIPHER_NAME_SIZE
+ 1];
343 char global_default_fnek_sig
[ECRYPTFS_SIG_SIZE_HEX
+ 1];
346 /* superblock private data. */
347 struct ecryptfs_sb_info
{
348 struct super_block
*wsi_sb
;
349 struct ecryptfs_mount_crypt_stat mount_crypt_stat
;
350 struct backing_dev_info bdi
;
353 /* file private data. */
354 struct ecryptfs_file_info
{
355 struct file
*wfi_file
;
356 struct ecryptfs_crypt_stat
*crypt_stat
;
359 /* auth_tok <=> encrypted_session_key mappings */
360 struct ecryptfs_auth_tok_list_item
{
361 unsigned char encrypted_session_key
[ECRYPTFS_MAX_KEY_BYTES
];
362 struct list_head list
;
363 struct ecryptfs_auth_tok auth_tok
;
366 struct ecryptfs_message
{
367 /* Can never be greater than ecryptfs_message_buf_len */
368 /* Used to find the parent msg_ctx */
369 /* Inherits from msg_ctx->index */
375 struct ecryptfs_msg_ctx
{
376 #define ECRYPTFS_MSG_CTX_STATE_FREE 0x01
377 #define ECRYPTFS_MSG_CTX_STATE_PENDING 0x02
378 #define ECRYPTFS_MSG_CTX_STATE_DONE 0x03
379 #define ECRYPTFS_MSG_CTX_STATE_NO_REPLY 0x04
381 #define ECRYPTFS_MSG_HELO 100
382 #define ECRYPTFS_MSG_QUIT 101
383 #define ECRYPTFS_MSG_REQUEST 102
384 #define ECRYPTFS_MSG_RESPONSE 103
387 /* Counter converts to a sequence number. Each message sent
388 * out for which we expect a response has an associated
389 * sequence number. The response must have the same sequence
390 * number as the counter for the msg_stc for the message to be
394 struct ecryptfs_message
*msg
;
395 struct task_struct
*task
;
396 struct list_head node
;
397 struct list_head daemon_out_list
;
401 struct ecryptfs_daemon
{
402 #define ECRYPTFS_DAEMON_IN_READ 0x00000001
403 #define ECRYPTFS_DAEMON_IN_POLL 0x00000002
404 #define ECRYPTFS_DAEMON_ZOMBIE 0x00000004
405 #define ECRYPTFS_DAEMON_MISCDEV_OPEN 0x00000008
407 u32 num_queued_msg_ctx
;
410 struct list_head msg_ctx_out_queue
;
411 wait_queue_head_t wait
;
412 struct hlist_node euid_chain
;
415 #ifdef CONFIG_ECRYPT_FS_MESSAGING
416 extern struct mutex ecryptfs_daemon_hash_mux
;
420 ecryptfs_lower_header_size(struct ecryptfs_crypt_stat
*crypt_stat
)
422 if (crypt_stat
->flags
& ECRYPTFS_METADATA_IN_XATTR
)
424 return crypt_stat
->metadata_size
;
427 static inline struct ecryptfs_file_info
*
428 ecryptfs_file_to_private(struct file
*file
)
430 return file
->private_data
;
434 ecryptfs_set_file_private(struct file
*file
,
435 struct ecryptfs_file_info
*file_info
)
437 file
->private_data
= file_info
;
440 static inline struct file
*ecryptfs_file_to_lower(struct file
*file
)
442 return ((struct ecryptfs_file_info
*)file
->private_data
)->wfi_file
;
446 ecryptfs_set_file_lower(struct file
*file
, struct file
*lower_file
)
448 ((struct ecryptfs_file_info
*)file
->private_data
)->wfi_file
=
452 static inline struct ecryptfs_inode_info
*
453 ecryptfs_inode_to_private(struct inode
*inode
)
455 return container_of(inode
, struct ecryptfs_inode_info
, vfs_inode
);
458 static inline struct inode
*ecryptfs_inode_to_lower(struct inode
*inode
)
460 return ecryptfs_inode_to_private(inode
)->wii_inode
;
464 ecryptfs_set_inode_lower(struct inode
*inode
, struct inode
*lower_inode
)
466 ecryptfs_inode_to_private(inode
)->wii_inode
= lower_inode
;
469 static inline struct ecryptfs_sb_info
*
470 ecryptfs_superblock_to_private(struct super_block
*sb
)
472 return (struct ecryptfs_sb_info
*)sb
->s_fs_info
;
476 ecryptfs_set_superblock_private(struct super_block
*sb
,
477 struct ecryptfs_sb_info
*sb_info
)
479 sb
->s_fs_info
= sb_info
;
482 static inline struct super_block
*
483 ecryptfs_superblock_to_lower(struct super_block
*sb
)
485 return ((struct ecryptfs_sb_info
*)sb
->s_fs_info
)->wsi_sb
;
489 ecryptfs_set_superblock_lower(struct super_block
*sb
,
490 struct super_block
*lower_sb
)
492 ((struct ecryptfs_sb_info
*)sb
->s_fs_info
)->wsi_sb
= lower_sb
;
495 static inline struct ecryptfs_dentry_info
*
496 ecryptfs_dentry_to_private(struct dentry
*dentry
)
498 return (struct ecryptfs_dentry_info
*)dentry
->d_fsdata
;
502 ecryptfs_set_dentry_private(struct dentry
*dentry
,
503 struct ecryptfs_dentry_info
*dentry_info
)
505 dentry
->d_fsdata
= dentry_info
;
508 static inline struct dentry
*
509 ecryptfs_dentry_to_lower(struct dentry
*dentry
)
511 return ((struct ecryptfs_dentry_info
*)dentry
->d_fsdata
)->lower_path
.dentry
;
515 ecryptfs_set_dentry_lower(struct dentry
*dentry
, struct dentry
*lower_dentry
)
517 ((struct ecryptfs_dentry_info
*)dentry
->d_fsdata
)->lower_path
.dentry
=
521 static inline struct vfsmount
*
522 ecryptfs_dentry_to_lower_mnt(struct dentry
*dentry
)
524 return ((struct ecryptfs_dentry_info
*)dentry
->d_fsdata
)->lower_path
.mnt
;
527 static inline struct path
*
528 ecryptfs_dentry_to_lower_path(struct dentry
*dentry
)
530 return &((struct ecryptfs_dentry_info
*)dentry
->d_fsdata
)->lower_path
;
534 ecryptfs_set_dentry_lower_mnt(struct dentry
*dentry
, struct vfsmount
*lower_mnt
)
536 ((struct ecryptfs_dentry_info
*)dentry
->d_fsdata
)->lower_path
.mnt
=
540 #define ecryptfs_printk(type, fmt, arg...) \
541 __ecryptfs_printk(type "%s: " fmt, __func__, ## arg);
543 void __ecryptfs_printk(const char *fmt
, ...);
545 extern const struct file_operations ecryptfs_main_fops
;
546 extern const struct file_operations ecryptfs_dir_fops
;
547 extern const struct inode_operations ecryptfs_main_iops
;
548 extern const struct inode_operations ecryptfs_dir_iops
;
549 extern const struct inode_operations ecryptfs_symlink_iops
;
550 extern const struct super_operations ecryptfs_sops
;
551 extern const struct dentry_operations ecryptfs_dops
;
552 extern const struct address_space_operations ecryptfs_aops
;
553 extern int ecryptfs_verbosity
;
554 extern unsigned int ecryptfs_message_buf_len
;
555 extern signed long ecryptfs_message_wait_timeout
;
556 extern unsigned int ecryptfs_number_of_users
;
558 extern struct kmem_cache
*ecryptfs_auth_tok_list_item_cache
;
559 extern struct kmem_cache
*ecryptfs_file_info_cache
;
560 extern struct kmem_cache
*ecryptfs_dentry_info_cache
;
561 extern struct kmem_cache
*ecryptfs_inode_info_cache
;
562 extern struct kmem_cache
*ecryptfs_sb_info_cache
;
563 extern struct kmem_cache
*ecryptfs_header_cache
;
564 extern struct kmem_cache
*ecryptfs_xattr_cache
;
565 extern struct kmem_cache
*ecryptfs_key_record_cache
;
566 extern struct kmem_cache
*ecryptfs_key_sig_cache
;
567 extern struct kmem_cache
*ecryptfs_global_auth_tok_cache
;
568 extern struct kmem_cache
*ecryptfs_key_tfm_cache
;
570 struct inode
*ecryptfs_get_inode(struct inode
*lower_inode
,
571 struct super_block
*sb
);
572 void ecryptfs_i_size_init(const char *page_virt
, struct inode
*inode
);
573 int ecryptfs_initialize_file(struct dentry
*ecryptfs_dentry
,
574 struct inode
*ecryptfs_inode
);
575 int ecryptfs_decode_and_decrypt_filename(char **decrypted_name
,
576 size_t *decrypted_name_size
,
577 struct dentry
*ecryptfs_dentry
,
578 const char *name
, size_t name_size
);
579 int ecryptfs_fill_zeros(struct file
*file
, loff_t new_length
);
580 int ecryptfs_encrypt_and_encode_filename(
582 size_t *encoded_name_size
,
583 struct ecryptfs_crypt_stat
*crypt_stat
,
584 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
,
585 const char *name
, size_t name_size
);
586 struct dentry
*ecryptfs_lower_dentry(struct dentry
*this_dentry
);
587 void ecryptfs_dump_hex(char *data
, int bytes
);
588 int virt_to_scatterlist(const void *addr
, int size
, struct scatterlist
*sg
,
590 int ecryptfs_compute_root_iv(struct ecryptfs_crypt_stat
*crypt_stat
);
591 void ecryptfs_rotate_iv(unsigned char *iv
);
592 void ecryptfs_init_crypt_stat(struct ecryptfs_crypt_stat
*crypt_stat
);
593 void ecryptfs_destroy_crypt_stat(struct ecryptfs_crypt_stat
*crypt_stat
);
594 void ecryptfs_destroy_mount_crypt_stat(
595 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
);
596 int ecryptfs_init_crypt_ctx(struct ecryptfs_crypt_stat
*crypt_stat
);
597 int ecryptfs_write_inode_size_to_metadata(struct inode
*ecryptfs_inode
);
598 int ecryptfs_encrypt_page(struct page
*page
);
599 int ecryptfs_decrypt_page(struct page
*page
);
600 int ecryptfs_write_metadata(struct dentry
*ecryptfs_dentry
,
601 struct inode
*ecryptfs_inode
);
602 int ecryptfs_read_metadata(struct dentry
*ecryptfs_dentry
);
603 int ecryptfs_new_file_context(struct inode
*ecryptfs_inode
);
604 void ecryptfs_write_crypt_stat_flags(char *page_virt
,
605 struct ecryptfs_crypt_stat
*crypt_stat
,
607 int ecryptfs_read_and_validate_header_region(struct inode
*inode
);
608 int ecryptfs_read_and_validate_xattr_region(struct dentry
*dentry
,
609 struct inode
*inode
);
610 u8
ecryptfs_code_for_cipher_string(char *cipher_name
, size_t key_bytes
);
611 int ecryptfs_cipher_code_to_string(char *str
, u8 cipher_code
);
612 void ecryptfs_set_default_sizes(struct ecryptfs_crypt_stat
*crypt_stat
);
613 int ecryptfs_generate_key_packet_set(char *dest_base
,
614 struct ecryptfs_crypt_stat
*crypt_stat
,
615 struct dentry
*ecryptfs_dentry
,
616 size_t *len
, size_t max
);
618 ecryptfs_parse_packet_set(struct ecryptfs_crypt_stat
*crypt_stat
,
619 unsigned char *src
, struct dentry
*ecryptfs_dentry
);
620 int ecryptfs_truncate(struct dentry
*dentry
, loff_t new_length
);
622 ecryptfs_getxattr_lower(struct dentry
*lower_dentry
, const char *name
,
623 void *value
, size_t size
);
625 ecryptfs_setxattr(struct dentry
*dentry
, const char *name
, const void *value
,
626 size_t size
, int flags
);
627 int ecryptfs_read_xattr_region(char *page_virt
, struct inode
*ecryptfs_inode
);
628 #ifdef CONFIG_ECRYPT_FS_MESSAGING
629 int ecryptfs_process_response(struct ecryptfs_daemon
*daemon
,
630 struct ecryptfs_message
*msg
, u32 seq
);
631 int ecryptfs_send_message(char *data
, int data_len
,
632 struct ecryptfs_msg_ctx
**msg_ctx
);
633 int ecryptfs_wait_for_response(struct ecryptfs_msg_ctx
*msg_ctx
,
634 struct ecryptfs_message
**emsg
);
635 int ecryptfs_init_messaging(void);
636 void ecryptfs_release_messaging(void);
638 static inline int ecryptfs_init_messaging(void)
642 static inline void ecryptfs_release_messaging(void)
644 static inline int ecryptfs_send_message(char *data
, int data_len
,
645 struct ecryptfs_msg_ctx
**msg_ctx
)
649 static inline int ecryptfs_wait_for_response(struct ecryptfs_msg_ctx
*msg_ctx
,
650 struct ecryptfs_message
**emsg
)
657 ecryptfs_write_header_metadata(char *virt
,
658 struct ecryptfs_crypt_stat
*crypt_stat
,
660 int ecryptfs_add_keysig(struct ecryptfs_crypt_stat
*crypt_stat
, char *sig
);
662 ecryptfs_add_global_auth_tok(struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
,
663 char *sig
, u32 global_auth_tok_flags
);
664 int ecryptfs_get_global_auth_tok_for_sig(
665 struct ecryptfs_global_auth_tok
**global_auth_tok
,
666 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
, char *sig
);
668 ecryptfs_add_new_key_tfm(struct ecryptfs_key_tfm
**key_tfm
, char *cipher_name
,
670 int ecryptfs_init_crypto(void);
671 int ecryptfs_destroy_crypto(void);
672 int ecryptfs_tfm_exists(char *cipher_name
, struct ecryptfs_key_tfm
**key_tfm
);
673 int ecryptfs_get_tfm_and_mutex_for_cipher_name(struct crypto_blkcipher
**tfm
,
674 struct mutex
**tfm_mutex
,
676 int ecryptfs_keyring_auth_tok_for_sig(struct key
**auth_tok_key
,
677 struct ecryptfs_auth_tok
**auth_tok
,
679 int ecryptfs_write_lower(struct inode
*ecryptfs_inode
, char *data
,
680 loff_t offset
, size_t size
);
681 int ecryptfs_write_lower_page_segment(struct inode
*ecryptfs_inode
,
682 struct page
*page_for_lower
,
683 size_t offset_in_page
, size_t size
);
684 int ecryptfs_write(struct inode
*inode
, char *data
, loff_t offset
, 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
,
689 size_t offset_in_page
, size_t size
,
690 struct inode
*ecryptfs_inode
);
691 struct page
*ecryptfs_get_locked_page(struct inode
*inode
, loff_t index
);
692 int ecryptfs_parse_packet_length(unsigned char *data
, size_t *size
,
693 size_t *length_size
);
694 int ecryptfs_write_packet_length(char *dest
, size_t size
,
695 size_t *packet_size_length
);
696 #ifdef CONFIG_ECRYPT_FS_MESSAGING
697 int ecryptfs_init_ecryptfs_miscdev(void);
698 void ecryptfs_destroy_ecryptfs_miscdev(void);
699 int ecryptfs_send_miscdev(char *data
, size_t data_size
,
700 struct ecryptfs_msg_ctx
*msg_ctx
, u8 msg_type
,
701 u16 msg_flags
, struct ecryptfs_daemon
*daemon
);
702 void ecryptfs_msg_ctx_alloc_to_free(struct ecryptfs_msg_ctx
*msg_ctx
);
704 ecryptfs_spawn_daemon(struct ecryptfs_daemon
**daemon
, struct file
*file
);
705 int ecryptfs_exorcise_daemon(struct ecryptfs_daemon
*daemon
);
706 int ecryptfs_find_daemon_by_euid(struct ecryptfs_daemon
**daemon
);
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 const struct cred
*cred
);
714 int ecryptfs_get_lower_file(struct dentry
*dentry
, struct inode
*inode
);
715 void ecryptfs_put_lower_file(struct inode
*inode
);
717 ecryptfs_write_tag_70_packet(char *dest
, size_t *remaining_bytes
,
719 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
,
720 char *filename
, size_t filename_size
);
722 ecryptfs_parse_tag_70_packet(char **filename
, size_t *filename_size
,
724 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
,
725 char *data
, size_t max_packet_size
);
726 int ecryptfs_set_f_namelen(long *namelen
, long lower_namelen
,
727 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
);
728 int ecryptfs_derive_iv(char *iv
, struct ecryptfs_crypt_stat
*crypt_stat
,
731 #endif /* #ifndef ECRYPTFS_KERNEL_H */