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