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