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>
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>
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
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_HMAC 0x00000080
55 #define ECRYPTFS_VERSIONING_FILENAME_ENCRYPTION 0x00000100
56 #define ECRYPTFS_VERSIONING_GCM 0x00000200
57 #define ECRYPTFS_VERSIONING_MASK (ECRYPTFS_VERSIONING_PASSPHRASE \
58 | ECRYPTFS_VERSIONING_PLAINTEXT_PASSTHROUGH \
59 | ECRYPTFS_VERSIONING_PUBKEY \
60 | ECRYPTFS_VERSIONING_XATTR \
61 | ECRYPTFS_VERSIONING_MULTKEY \
62 | ECRYPTFS_VERSIONING_DEVMISC \
63 | ECRYPTFS_VERSIONING_FILENAME_ENCRYPTION)
64 #define ECRYPTFS_MAX_PASSWORD_LENGTH 64
65 #define ECRYPTFS_MAX_PASSPHRASE_BYTES ECRYPTFS_MAX_PASSWORD_LENGTH
66 #define ECRYPTFS_SALT_SIZE 8
67 #define ECRYPTFS_SALT_SIZE_HEX (ECRYPTFS_SALT_SIZE*2)
68 /* The original signature size is only for what is stored on disk; all
69 * in-memory representations are expanded hex, so it better adapted to
70 * be passed around or referenced on the command line */
71 #define ECRYPTFS_SIG_SIZE 8
72 #define ECRYPTFS_SIG_SIZE_HEX (ECRYPTFS_SIG_SIZE*2)
73 #define ECRYPTFS_PASSWORD_SIG_SIZE ECRYPTFS_SIG_SIZE_HEX
74 #define ECRYPTFS_MAX_KEY_BYTES 64
75 #define ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES 512
76 #define ECRYPTFS_DEFAULT_IV_BYTES 16
77 #define ECRYPTFS_FILE_VERSION 0x03
78 #define ECRYPTFS_DEFAULT_EXTENT_SIZE 4096
79 #define ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE 8192
80 #define ECRYPTFS_DEFAULT_MSG_CTX_ELEMS 32
81 #define ECRYPTFS_DEFAULT_SEND_TIMEOUT HZ
82 #define ECRYPTFS_MAX_MSG_CTX_TTL (HZ*3)
83 #define ECRYPTFS_MAX_PKI_NAME_BYTES 16
84 #define ECRYPTFS_DEFAULT_NUM_USERS 4
85 #define ECRYPTFS_MAX_NUM_USERS 32768
86 #define ECRYPTFS_XATTR_NAME "user.ecryptfs"
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
97 #define RFC2440_CIPHER_RSA 0x01
100 * For convenience, we may need to pass around the encrypted session
101 * key between kernel and userspace because the authentication token
102 * may not be extractable. For example, the TPM may not release the
103 * private key, instead requiring the encrypted data and returning the
106 struct ecryptfs_session_key
{
107 #define ECRYPTFS_USERSPACE_SHOULD_TRY_TO_DECRYPT 0x00000001
108 #define ECRYPTFS_USERSPACE_SHOULD_TRY_TO_ENCRYPT 0x00000002
109 #define ECRYPTFS_CONTAINS_DECRYPTED_KEY 0x00000004
110 #define ECRYPTFS_CONTAINS_ENCRYPTED_KEY 0x00000008
112 u32 encrypted_key_size
;
113 u32 decrypted_key_size
;
114 u8 encrypted_key
[ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES
];
115 u8 decrypted_key
[ECRYPTFS_MAX_KEY_BYTES
];
118 struct ecryptfs_password
{
122 u32 session_key_encryption_key_bytes
;
123 #define ECRYPTFS_PERSISTENT_PASSWORD 0x01
124 #define ECRYPTFS_SESSION_KEY_ENCRYPTION_KEY_SET 0x02
126 /* Iterated-hash concatenation of salt and passphrase */
127 u8 session_key_encryption_key
[ECRYPTFS_MAX_KEY_BYTES
];
128 u8 signature
[ECRYPTFS_PASSWORD_SIG_SIZE
+ 1];
129 /* Always in expanded hex */
130 u8 salt
[ECRYPTFS_SALT_SIZE
];
133 enum ecryptfs_token_types
{ECRYPTFS_PASSWORD
, ECRYPTFS_PRIVATE_KEY
};
135 struct ecryptfs_private_key
{
138 u8 signature
[ECRYPTFS_PASSWORD_SIG_SIZE
+ 1];
139 char pki_type
[ECRYPTFS_MAX_PKI_NAME_BYTES
+ 1];
143 /* May be a password or a private key */
144 struct ecryptfs_auth_tok
{
145 u16 version
; /* 8-bit major and 8-bit minor */
147 #define ECRYPTFS_ENCRYPT_ONLY 0x00000001
149 struct ecryptfs_session_key session_key
;
152 struct ecryptfs_password password
;
153 struct ecryptfs_private_key private_key
;
155 } __attribute__ ((packed
));
157 void ecryptfs_dump_auth_tok(struct ecryptfs_auth_tok
*auth_tok
);
158 extern void ecryptfs_to_hex(char *dst
, char *src
, size_t src_size
);
159 extern void ecryptfs_from_hex(char *dst
, char *src
, int dst_size
);
161 struct ecryptfs_key_record
{
164 unsigned char sig
[ECRYPTFS_SIG_SIZE
];
165 unsigned char enc_key
[ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES
];
168 struct ecryptfs_auth_tok_list
{
169 struct ecryptfs_auth_tok
*auth_tok
;
170 struct list_head list
;
173 struct ecryptfs_crypt_stat
;
174 struct ecryptfs_mount_crypt_stat
;
176 struct ecryptfs_page_crypt_context
{
178 #define ECRYPTFS_PREPARE_COMMIT_MODE 0
179 #define ECRYPTFS_WRITEPAGE_MODE 1
182 struct file
*lower_file
;
183 struct writeback_control
*wbc
;
187 static inline struct ecryptfs_auth_tok
*
188 ecryptfs_get_key_payload_data(struct key
*key
)
190 return (struct ecryptfs_auth_tok
*)
191 (((struct user_key_payload
*)key
->payload
.data
)->data
);
194 #define ECRYPTFS_SUPER_MAGIC 0xf15f
195 #define ECRYPTFS_MAX_KEYSET_SIZE 1024
196 #define ECRYPTFS_MAX_CIPHER_NAME_SIZE 32
197 #define ECRYPTFS_MAX_NUM_ENC_KEYS 64
198 #define ECRYPTFS_MAX_IV_BYTES 16 /* 128 bits */
199 #define ECRYPTFS_SALT_BYTES 2
200 #define MAGIC_ECRYPTFS_MARKER 0x3c81b7f5
201 #define MAGIC_ECRYPTFS_MARKER_SIZE_BYTES 8 /* 4*2 */
202 #define ECRYPTFS_FILE_SIZE_BYTES (sizeof(u64))
203 #define ECRYPTFS_DEFAULT_CIPHER "aes"
204 #define ECRYPTFS_DEFAULT_KEY_BYTES 16
205 #define ECRYPTFS_DEFAULT_HASH "md5"
206 #define ECRYPTFS_TAG_70_DIGEST ECRYPTFS_DEFAULT_HASH
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 ECRYPTFS_TAG_70_PACKET_TYPE 0x46 /* FNEK-encrypted filename
216 #define ECRYPTFS_TAG_71_PACKET_TYPE 0x47 /* FNEK-encrypted filename in
218 #define ECRYPTFS_TAG_72_PACKET_TYPE 0x48 /* FEK-encrypted filename as
220 #define ECRYPTFS_TAG_73_PACKET_TYPE 0x49 /* FEK-encrypted filename as
222 /* Constraint: ECRYPTFS_FILENAME_MIN_RANDOM_PREPEND_BYTES >=
223 * ECRYPTFS_MAX_IV_BYTES */
224 #define ECRYPTFS_FILENAME_MIN_RANDOM_PREPEND_BYTES 16
225 #define ECRYPTFS_NON_NULL 0x42 /* A reasonable substitute for NULL */
226 #define MD5_DIGEST_SIZE 16
227 #define ECRYPTFS_TAG_70_DIGEST_SIZE MD5_DIGEST_SIZE
228 #define ECRYPTFS_FEK_ENCRYPTED_FILENAME_PREFIX "ECRYPTFS_FEK_ENCRYPTED."
229 #define ECRYPTFS_FEK_ENCRYPTED_FILENAME_PREFIX_SIZE 23
230 #define ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX "ECRYPTFS_FNEK_ENCRYPTED."
231 #define ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX_SIZE 24
232 #define ECRYPTFS_ENCRYPTED_DENTRY_NAME_LEN (18 + 1 + 4 + 1 + 32)
234 struct ecryptfs_key_sig
{
235 struct list_head crypt_stat_list
;
236 char keysig
[ECRYPTFS_SIG_SIZE_HEX
];
239 struct ecryptfs_filename
{
240 struct list_head crypt_stat_list
;
241 #define ECRYPTFS_FILENAME_CONTAINS_DECRYPTED 0x00000001
245 char *encrypted_filename
;
246 size_t filename_size
;
247 size_t encrypted_filename_size
;
248 char fnek_sig
[ECRYPTFS_SIG_SIZE_HEX
];
249 char dentry_name
[ECRYPTFS_ENCRYPTED_DENTRY_NAME_LEN
+ 1];
253 * This is the primary struct associated with each encrypted file.
255 * TODO: cache align/pack?
257 struct ecryptfs_crypt_stat
{
258 #define ECRYPTFS_STRUCT_INITIALIZED 0x00000001
259 #define ECRYPTFS_POLICY_APPLIED 0x00000002
260 #define ECRYPTFS_NEW_FILE 0x00000004
261 #define ECRYPTFS_ENCRYPTED 0x00000008
262 #define ECRYPTFS_SECURITY_WARNING 0x00000010
263 #define ECRYPTFS_ENABLE_HMAC 0x00000020
264 #define ECRYPTFS_ENCRYPT_IV_PAGES 0x00000040
265 #define ECRYPTFS_KEY_VALID 0x00000080
266 #define ECRYPTFS_METADATA_IN_XATTR 0x00000100
267 #define ECRYPTFS_VIEW_AS_ENCRYPTED 0x00000200
268 #define ECRYPTFS_KEY_SET 0x00000400
269 #define ECRYPTFS_ENCRYPT_FILENAMES 0x00000800
270 #define ECRYPTFS_ENCFN_USE_MOUNT_FNEK 0x00001000
271 #define ECRYPTFS_ENCFN_USE_FEK 0x00002000
272 #define ECRYPTFS_UNLINK_SIGS 0x00004000
274 unsigned int file_version
;
276 size_t metadata_size
;
277 size_t extent_size
; /* Data extent size; default is 4096 */
280 unsigned int extent_mask
;
281 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
282 struct crypto_blkcipher
*tfm
;
283 struct crypto_hash
*hash_tfm
; /* Crypto context for generating
284 * the initialization vectors */
285 unsigned char cipher
[ECRYPTFS_MAX_CIPHER_NAME_SIZE
];
286 unsigned char key
[ECRYPTFS_MAX_KEY_BYTES
];
287 unsigned char root_iv
[ECRYPTFS_MAX_IV_BYTES
];
288 struct list_head keysig_list
;
289 struct mutex keysig_list_mutex
;
290 struct mutex cs_tfm_mutex
;
291 struct mutex cs_hash_tfm_mutex
;
292 struct mutex cs_mutex
;
295 /* inode private data. */
296 struct ecryptfs_inode_info
{
297 struct inode vfs_inode
;
298 struct inode
*wii_inode
;
299 struct file
*lower_file
;
300 struct mutex lower_file_mutex
;
301 struct ecryptfs_crypt_stat crypt_stat
;
304 /* dentry private data. Each dentry must keep track of a lower
306 struct ecryptfs_dentry_info
{
307 struct path lower_path
;
308 struct ecryptfs_crypt_stat
*crypt_stat
;
312 * ecryptfs_global_auth_tok - A key used to encrypt all new files under the mountpoint
313 * @flags: Status flags
314 * @mount_crypt_stat_list: These auth_toks hang off the mount-wide
315 * cryptographic context. Every time a new
316 * inode comes into existence, eCryptfs copies
317 * the auth_toks on that list to the set of
318 * auth_toks on the inode's crypt_stat
319 * @global_auth_tok_key: The key from the user's keyring for the sig
320 * @global_auth_tok: The key contents
321 * @sig: The key identifier
323 * ecryptfs_global_auth_tok structs refer to authentication token keys
324 * in the user keyring that apply to newly created files. A list of
325 * these objects hangs off of the mount_crypt_stat struct for any
326 * given eCryptfs mount. This struct maintains a reference to both the
327 * key contents and the key itself so that the key can be put on
330 struct ecryptfs_global_auth_tok
{
331 #define ECRYPTFS_AUTH_TOK_INVALID 0x00000001
332 #define ECRYPTFS_AUTH_TOK_FNEK 0x00000002
334 struct list_head mount_crypt_stat_list
;
335 struct key
*global_auth_tok_key
;
336 struct ecryptfs_auth_tok
*global_auth_tok
;
337 unsigned char sig
[ECRYPTFS_SIG_SIZE_HEX
+ 1];
341 * ecryptfs_key_tfm - Persistent key tfm
342 * @key_tfm: crypto API handle to the key
343 * @key_size: Key size in bytes
344 * @key_tfm_mutex: Mutex to ensure only one operation in eCryptfs is
345 * using the persistent TFM at any point in time
346 * @key_tfm_list: Handle to hang this off the module-wide TFM list
347 * @cipher_name: String name for the cipher for this TFM
349 * Typically, eCryptfs will use the same ciphers repeatedly throughout
350 * the course of its operations. In order to avoid unnecessarily
351 * destroying and initializing the same cipher repeatedly, eCryptfs
352 * keeps a list of crypto API contexts around to use when needed.
354 struct ecryptfs_key_tfm
{
355 struct crypto_blkcipher
*key_tfm
;
357 struct mutex key_tfm_mutex
;
358 struct list_head key_tfm_list
;
359 unsigned char cipher_name
[ECRYPTFS_MAX_CIPHER_NAME_SIZE
+ 1];
362 extern struct mutex key_tfm_list_mutex
;
365 * This struct is to enable a mount-wide passphrase/salt combo. This
366 * is more or less a stopgap to provide similar functionality to other
367 * crypto filesystems like EncFS or CFS until full policy support is
368 * implemented in eCryptfs.
370 struct ecryptfs_mount_crypt_stat
{
371 /* Pointers to memory we do not own, do not free these */
372 #define ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED 0x00000001
373 #define ECRYPTFS_XATTR_METADATA_ENABLED 0x00000002
374 #define ECRYPTFS_ENCRYPTED_VIEW_ENABLED 0x00000004
375 #define ECRYPTFS_MOUNT_CRYPT_STAT_INITIALIZED 0x00000008
376 #define ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES 0x00000010
377 #define ECRYPTFS_GLOBAL_ENCFN_USE_MOUNT_FNEK 0x00000020
378 #define ECRYPTFS_GLOBAL_ENCFN_USE_FEK 0x00000040
380 struct list_head global_auth_tok_list
;
381 struct mutex global_auth_tok_list_mutex
;
382 size_t num_global_auth_toks
;
383 size_t global_default_cipher_key_size
;
384 size_t global_default_fn_cipher_key_bytes
;
385 unsigned char global_default_cipher_name
[ECRYPTFS_MAX_CIPHER_NAME_SIZE
387 unsigned char global_default_fn_cipher_name
[
388 ECRYPTFS_MAX_CIPHER_NAME_SIZE
+ 1];
389 char global_default_fnek_sig
[ECRYPTFS_SIG_SIZE_HEX
+ 1];
392 /* superblock private data. */
393 struct ecryptfs_sb_info
{
394 struct super_block
*wsi_sb
;
395 struct ecryptfs_mount_crypt_stat mount_crypt_stat
;
398 /* file private data. */
399 struct ecryptfs_file_info
{
400 struct file
*wfi_file
;
401 struct ecryptfs_crypt_stat
*crypt_stat
;
404 /* auth_tok <=> encrypted_session_key mappings */
405 struct ecryptfs_auth_tok_list_item
{
406 unsigned char encrypted_session_key
[ECRYPTFS_MAX_KEY_BYTES
];
407 struct list_head list
;
408 struct ecryptfs_auth_tok auth_tok
;
411 struct ecryptfs_message
{
412 /* Can never be greater than ecryptfs_message_buf_len */
413 /* Used to find the parent msg_ctx */
414 /* Inherits from msg_ctx->index */
420 struct ecryptfs_msg_ctx
{
421 #define ECRYPTFS_MSG_CTX_STATE_FREE 0x01
422 #define ECRYPTFS_MSG_CTX_STATE_PENDING 0x02
423 #define ECRYPTFS_MSG_CTX_STATE_DONE 0x03
424 #define ECRYPTFS_MSG_CTX_STATE_NO_REPLY 0x04
426 #define ECRYPTFS_MSG_HELO 100
427 #define ECRYPTFS_MSG_QUIT 101
428 #define ECRYPTFS_MSG_REQUEST 102
429 #define ECRYPTFS_MSG_RESPONSE 103
432 /* Counter converts to a sequence number. Each message sent
433 * out for which we expect a response has an associated
434 * sequence number. The response must have the same sequence
435 * number as the counter for the msg_stc for the message to be
439 struct ecryptfs_message
*msg
;
440 struct task_struct
*task
;
441 struct list_head node
;
442 struct list_head daemon_out_list
;
446 struct ecryptfs_daemon
;
448 struct ecryptfs_daemon
{
449 #define ECRYPTFS_DAEMON_IN_READ 0x00000001
450 #define ECRYPTFS_DAEMON_IN_POLL 0x00000002
451 #define ECRYPTFS_DAEMON_ZOMBIE 0x00000004
452 #define ECRYPTFS_DAEMON_MISCDEV_OPEN 0x00000008
454 u32 num_queued_msg_ctx
;
457 struct user_namespace
*user_ns
;
458 struct task_struct
*task
;
460 struct list_head msg_ctx_out_queue
;
461 wait_queue_head_t wait
;
462 struct hlist_node euid_chain
;
465 extern struct mutex ecryptfs_daemon_hash_mux
;
468 ecryptfs_lower_header_size(struct ecryptfs_crypt_stat
*crypt_stat
)
470 if (crypt_stat
->flags
& ECRYPTFS_METADATA_IN_XATTR
)
472 return crypt_stat
->metadata_size
;
475 static inline struct ecryptfs_file_info
*
476 ecryptfs_file_to_private(struct file
*file
)
478 return (struct ecryptfs_file_info
*)file
->private_data
;
482 ecryptfs_set_file_private(struct file
*file
,
483 struct ecryptfs_file_info
*file_info
)
485 file
->private_data
= file_info
;
488 static inline struct file
*ecryptfs_file_to_lower(struct file
*file
)
490 return ((struct ecryptfs_file_info
*)file
->private_data
)->wfi_file
;
494 ecryptfs_set_file_lower(struct file
*file
, struct file
*lower_file
)
496 ((struct ecryptfs_file_info
*)file
->private_data
)->wfi_file
=
500 static inline struct ecryptfs_inode_info
*
501 ecryptfs_inode_to_private(struct inode
*inode
)
503 return container_of(inode
, struct ecryptfs_inode_info
, vfs_inode
);
506 static inline struct inode
*ecryptfs_inode_to_lower(struct inode
*inode
)
508 return ecryptfs_inode_to_private(inode
)->wii_inode
;
512 ecryptfs_set_inode_lower(struct inode
*inode
, struct inode
*lower_inode
)
514 ecryptfs_inode_to_private(inode
)->wii_inode
= lower_inode
;
517 static inline struct ecryptfs_sb_info
*
518 ecryptfs_superblock_to_private(struct super_block
*sb
)
520 return (struct ecryptfs_sb_info
*)sb
->s_fs_info
;
524 ecryptfs_set_superblock_private(struct super_block
*sb
,
525 struct ecryptfs_sb_info
*sb_info
)
527 sb
->s_fs_info
= sb_info
;
530 static inline struct super_block
*
531 ecryptfs_superblock_to_lower(struct super_block
*sb
)
533 return ((struct ecryptfs_sb_info
*)sb
->s_fs_info
)->wsi_sb
;
537 ecryptfs_set_superblock_lower(struct super_block
*sb
,
538 struct super_block
*lower_sb
)
540 ((struct ecryptfs_sb_info
*)sb
->s_fs_info
)->wsi_sb
= lower_sb
;
543 static inline struct ecryptfs_dentry_info
*
544 ecryptfs_dentry_to_private(struct dentry
*dentry
)
546 return (struct ecryptfs_dentry_info
*)dentry
->d_fsdata
;
550 ecryptfs_set_dentry_private(struct dentry
*dentry
,
551 struct ecryptfs_dentry_info
*dentry_info
)
553 dentry
->d_fsdata
= dentry_info
;
556 static inline struct dentry
*
557 ecryptfs_dentry_to_lower(struct dentry
*dentry
)
559 return ((struct ecryptfs_dentry_info
*)dentry
->d_fsdata
)->lower_path
.dentry
;
563 ecryptfs_set_dentry_lower(struct dentry
*dentry
, struct dentry
*lower_dentry
)
565 ((struct ecryptfs_dentry_info
*)dentry
->d_fsdata
)->lower_path
.dentry
=
569 static inline struct vfsmount
*
570 ecryptfs_dentry_to_lower_mnt(struct dentry
*dentry
)
572 return ((struct ecryptfs_dentry_info
*)dentry
->d_fsdata
)->lower_path
.mnt
;
576 ecryptfs_set_dentry_lower_mnt(struct dentry
*dentry
, struct vfsmount
*lower_mnt
)
578 ((struct ecryptfs_dentry_info
*)dentry
->d_fsdata
)->lower_path
.mnt
=
582 #define ecryptfs_printk(type, fmt, arg...) \
583 __ecryptfs_printk(type "%s: " fmt, __func__, ## arg);
584 void __ecryptfs_printk(const char *fmt
, ...);
586 extern const struct file_operations ecryptfs_main_fops
;
587 extern const struct file_operations ecryptfs_dir_fops
;
588 extern const struct inode_operations ecryptfs_main_iops
;
589 extern const struct inode_operations ecryptfs_dir_iops
;
590 extern const struct inode_operations ecryptfs_symlink_iops
;
591 extern const struct super_operations ecryptfs_sops
;
592 extern const struct dentry_operations ecryptfs_dops
;
593 extern const struct address_space_operations ecryptfs_aops
;
594 extern int ecryptfs_verbosity
;
595 extern unsigned int ecryptfs_message_buf_len
;
596 extern signed long ecryptfs_message_wait_timeout
;
597 extern unsigned int ecryptfs_number_of_users
;
599 extern struct kmem_cache
*ecryptfs_auth_tok_list_item_cache
;
600 extern struct kmem_cache
*ecryptfs_file_info_cache
;
601 extern struct kmem_cache
*ecryptfs_dentry_info_cache
;
602 extern struct kmem_cache
*ecryptfs_inode_info_cache
;
603 extern struct kmem_cache
*ecryptfs_sb_info_cache
;
604 extern struct kmem_cache
*ecryptfs_header_cache_1
;
605 extern struct kmem_cache
*ecryptfs_header_cache_2
;
606 extern struct kmem_cache
*ecryptfs_xattr_cache
;
607 extern struct kmem_cache
*ecryptfs_key_record_cache
;
608 extern struct kmem_cache
*ecryptfs_key_sig_cache
;
609 extern struct kmem_cache
*ecryptfs_global_auth_tok_cache
;
610 extern struct kmem_cache
*ecryptfs_key_tfm_cache
;
611 extern struct kmem_cache
*ecryptfs_open_req_cache
;
613 struct ecryptfs_open_req
{
614 #define ECRYPTFS_REQ_PROCESSED 0x00000001
615 #define ECRYPTFS_REQ_DROPPED 0x00000002
616 #define ECRYPTFS_REQ_ZOMBIE 0x00000004
618 struct file
**lower_file
;
619 struct dentry
*lower_dentry
;
620 struct vfsmount
*lower_mnt
;
621 wait_queue_head_t wait
;
623 struct list_head kthread_ctl_list
;
626 #define ECRYPTFS_INTERPOSE_FLAG_D_ADD 0x00000001
627 int ecryptfs_interpose(struct dentry
*hidden_dentry
,
628 struct dentry
*this_dentry
, struct super_block
*sb
,
630 int ecryptfs_lookup_and_interpose_lower(struct dentry
*ecryptfs_dentry
,
631 struct dentry
*lower_dentry
,
632 struct inode
*ecryptfs_dir_inode
,
633 struct nameidata
*ecryptfs_nd
);
634 int ecryptfs_decode_and_decrypt_filename(char **decrypted_name
,
635 size_t *decrypted_name_size
,
636 struct dentry
*ecryptfs_dentry
,
637 const char *name
, size_t name_size
);
638 int ecryptfs_fill_zeros(struct file
*file
, loff_t new_length
);
639 int ecryptfs_encrypt_and_encode_filename(
641 size_t *encoded_name_size
,
642 struct ecryptfs_crypt_stat
*crypt_stat
,
643 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
,
644 const char *name
, size_t name_size
);
645 struct dentry
*ecryptfs_lower_dentry(struct dentry
*this_dentry
);
646 void ecryptfs_dump_hex(char *data
, int bytes
);
647 int virt_to_scatterlist(const void *addr
, int size
, struct scatterlist
*sg
,
649 int ecryptfs_compute_root_iv(struct ecryptfs_crypt_stat
*crypt_stat
);
650 void ecryptfs_rotate_iv(unsigned char *iv
);
651 void ecryptfs_init_crypt_stat(struct ecryptfs_crypt_stat
*crypt_stat
);
652 void ecryptfs_destroy_crypt_stat(struct ecryptfs_crypt_stat
*crypt_stat
);
653 void ecryptfs_destroy_mount_crypt_stat(
654 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
);
655 int ecryptfs_init_crypt_ctx(struct ecryptfs_crypt_stat
*crypt_stat
);
656 int ecryptfs_write_inode_size_to_metadata(struct inode
*ecryptfs_inode
);
657 int ecryptfs_encrypt_page(struct page
*page
);
658 int ecryptfs_decrypt_page(struct page
*page
);
659 int ecryptfs_write_metadata(struct dentry
*ecryptfs_dentry
);
660 int ecryptfs_read_metadata(struct dentry
*ecryptfs_dentry
);
661 int ecryptfs_new_file_context(struct dentry
*ecryptfs_dentry
);
662 int ecryptfs_read_and_validate_header_region(char *data
,
663 struct inode
*ecryptfs_inode
);
664 int ecryptfs_read_and_validate_xattr_region(char *page_virt
,
665 struct dentry
*ecryptfs_dentry
);
666 u8
ecryptfs_code_for_cipher_string(char *cipher_name
, size_t key_bytes
);
667 int ecryptfs_cipher_code_to_string(char *str
, u8 cipher_code
);
668 void ecryptfs_set_default_sizes(struct ecryptfs_crypt_stat
*crypt_stat
);
669 int ecryptfs_generate_key_packet_set(char *dest_base
,
670 struct ecryptfs_crypt_stat
*crypt_stat
,
671 struct dentry
*ecryptfs_dentry
,
672 size_t *len
, size_t max
);
674 ecryptfs_parse_packet_set(struct ecryptfs_crypt_stat
*crypt_stat
,
675 unsigned char *src
, struct dentry
*ecryptfs_dentry
);
676 int ecryptfs_truncate(struct dentry
*dentry
, loff_t new_length
);
677 int ecryptfs_inode_test(struct inode
*inode
, void *candidate_lower_inode
);
678 int ecryptfs_inode_set(struct inode
*inode
, void *lower_inode
);
679 void ecryptfs_init_inode(struct inode
*inode
, struct inode
*lower_inode
);
681 ecryptfs_getxattr_lower(struct dentry
*lower_dentry
, const char *name
,
682 void *value
, size_t size
);
684 ecryptfs_setxattr(struct dentry
*dentry
, const char *name
, const void *value
,
685 size_t size
, int flags
);
686 int ecryptfs_read_xattr_region(char *page_virt
, struct inode
*ecryptfs_inode
);
687 int ecryptfs_process_helo(uid_t euid
, struct user_namespace
*user_ns
,
689 int ecryptfs_process_quit(uid_t euid
, struct user_namespace
*user_ns
,
691 int ecryptfs_process_response(struct ecryptfs_message
*msg
, uid_t euid
,
692 struct user_namespace
*user_ns
, struct pid
*pid
,
694 int ecryptfs_send_message(char *data
, int data_len
,
695 struct ecryptfs_msg_ctx
**msg_ctx
);
696 int ecryptfs_wait_for_response(struct ecryptfs_msg_ctx
*msg_ctx
,
697 struct ecryptfs_message
**emsg
);
698 int ecryptfs_init_messaging(void);
699 void ecryptfs_release_messaging(void);
702 ecryptfs_write_header_metadata(char *virt
,
703 struct ecryptfs_crypt_stat
*crypt_stat
,
705 int ecryptfs_add_keysig(struct ecryptfs_crypt_stat
*crypt_stat
, char *sig
);
707 ecryptfs_add_global_auth_tok(struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
,
708 char *sig
, u32 global_auth_tok_flags
);
709 int ecryptfs_get_global_auth_tok_for_sig(
710 struct ecryptfs_global_auth_tok
**global_auth_tok
,
711 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
, char *sig
);
713 ecryptfs_add_new_key_tfm(struct ecryptfs_key_tfm
**key_tfm
, char *cipher_name
,
715 int ecryptfs_init_crypto(void);
716 int ecryptfs_destroy_crypto(void);
717 int ecryptfs_tfm_exists(char *cipher_name
, struct ecryptfs_key_tfm
**key_tfm
);
718 int ecryptfs_get_tfm_and_mutex_for_cipher_name(struct crypto_blkcipher
**tfm
,
719 struct mutex
**tfm_mutex
,
721 int ecryptfs_keyring_auth_tok_for_sig(struct key
**auth_tok_key
,
722 struct ecryptfs_auth_tok
**auth_tok
,
724 int ecryptfs_write_lower(struct inode
*ecryptfs_inode
, char *data
,
725 loff_t offset
, size_t size
);
726 int ecryptfs_write_lower_page_segment(struct inode
*ecryptfs_inode
,
727 struct page
*page_for_lower
,
728 size_t offset_in_page
, size_t size
);
729 int ecryptfs_write(struct file
*ecryptfs_file
, char *data
, loff_t offset
,
731 int ecryptfs_read_lower(char *data
, loff_t offset
, size_t size
,
732 struct inode
*ecryptfs_inode
);
733 int ecryptfs_read_lower_page_segment(struct page
*page_for_ecryptfs
,
735 size_t offset_in_page
, size_t size
,
736 struct inode
*ecryptfs_inode
);
737 struct page
*ecryptfs_get_locked_page(struct file
*file
, loff_t index
);
738 int ecryptfs_exorcise_daemon(struct ecryptfs_daemon
*daemon
);
739 int ecryptfs_find_daemon_by_euid(struct ecryptfs_daemon
**daemon
, uid_t euid
,
740 struct user_namespace
*user_ns
);
741 int ecryptfs_parse_packet_length(unsigned char *data
, size_t *size
,
742 size_t *length_size
);
743 int ecryptfs_write_packet_length(char *dest
, size_t size
,
744 size_t *packet_size_length
);
745 int ecryptfs_init_ecryptfs_miscdev(void);
746 void ecryptfs_destroy_ecryptfs_miscdev(void);
747 int ecryptfs_send_miscdev(char *data
, size_t data_size
,
748 struct ecryptfs_msg_ctx
*msg_ctx
, u8 msg_type
,
749 u16 msg_flags
, struct ecryptfs_daemon
*daemon
);
750 void ecryptfs_msg_ctx_alloc_to_free(struct ecryptfs_msg_ctx
*msg_ctx
);
752 ecryptfs_spawn_daemon(struct ecryptfs_daemon
**daemon
, uid_t euid
,
753 struct user_namespace
*user_ns
, struct pid
*pid
);
754 int ecryptfs_init_kthread(void);
755 void ecryptfs_destroy_kthread(void);
756 int ecryptfs_privileged_open(struct file
**lower_file
,
757 struct dentry
*lower_dentry
,
758 struct vfsmount
*lower_mnt
,
759 const struct cred
*cred
);
760 int ecryptfs_init_persistent_file(struct dentry
*ecryptfs_dentry
);
762 ecryptfs_write_tag_70_packet(char *dest
, size_t *remaining_bytes
,
764 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
,
765 char *filename
, size_t filename_size
);
767 ecryptfs_parse_tag_70_packet(char **filename
, size_t *filename_size
,
769 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
,
770 char *data
, size_t max_packet_size
);
771 int ecryptfs_derive_iv(char *iv
, struct ecryptfs_crypt_stat
*crypt_stat
,
774 #endif /* #ifndef ECRYPTFS_KERNEL_H */