blob: d123fbaa28e000246cfab9829e444f60e49a6843 [file] [log] [blame]
Michael Halcrow237fead2006-10-04 02:16:22 -07001/**
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
Michael Halcrowf66e8832008-04-29 00:59:51 -07007 * Copyright (C) 2004-2008 International Business Machines Corp.
Michael Halcrow237fead2006-10-04 02:16:22 -07008 * Author(s): Michael A. Halcrow <mahalcro@us.ibm.com>
Michael Halcrow88b4a072007-02-12 00:53:43 -08009 * Trevor S. Highland <trevor.highland@gmail.com>
10 * Tyler Hicks <tyhicks@ou.edu>
Michael Halcrow237fead2006-10-04 02:16:22 -070011 *
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
Herbert Xu3095e8e2016-01-25 10:29:33 +080031#include <crypto/skcipher.h>
Michael Halcrow237fead2006-10-04 02:16:22 -070032#include <keys/user-type.h>
Roberto Sassu1252cc32011-06-27 13:45:45 +020033#include <keys/encrypted-type.h>
Michael Halcrow237fead2006-10-04 02:16:22 -070034#include <linux/fs.h>
Josef "Jeff" Sipek0cc72dc2006-12-08 02:36:31 -080035#include <linux/fs_stack.h>
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -080036#include <linux/namei.h>
Michael Halcrow237fead2006-10-04 02:16:22 -070037#include <linux/scatterlist.h>
Michael Halcrowdddfa462007-02-12 00:53:44 -080038#include <linux/hash.h>
Michael Halcrow6a3fd922008-04-29 00:59:52 -070039#include <linux/nsproxy.h>
Jens Axboe9df9c8b2010-04-22 12:22:04 +020040#include <linux/backing-dev.h>
Roberto Sassuf8f85272011-06-27 13:45:43 +020041#include <linux/ecryptfs.h>
Michael Halcrow237fead2006-10-04 02:16:22 -070042
Michael Halcrow237fead2006-10-04 02:16:22 -070043#define ECRYPTFS_DEFAULT_IV_BYTES 16
Michael Halcrow237fead2006-10-04 02:16:22 -070044#define ECRYPTFS_DEFAULT_EXTENT_SIZE 4096
45#define ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE 8192
Michael Halcrow88b4a072007-02-12 00:53:43 -080046#define ECRYPTFS_DEFAULT_MSG_CTX_ELEMS 32
47#define ECRYPTFS_DEFAULT_SEND_TIMEOUT HZ
48#define ECRYPTFS_MAX_MSG_CTX_TTL (HZ*3)
Michael Halcrow88b4a072007-02-12 00:53:43 -080049#define ECRYPTFS_DEFAULT_NUM_USERS 4
50#define ECRYPTFS_MAX_NUM_USERS 32768
Michael Halcrowdd2a3b72007-02-12 00:53:46 -080051#define ECRYPTFS_XATTR_NAME "user.ecryptfs"
Michael Halcrow237fead2006-10-04 02:16:22 -070052
Michael Halcrow237fead2006-10-04 02:16:22 -070053void 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
Roberto Sassu1252cc32011-06-27 13:45:45 +020083#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 *)
David Howells146aa8b2015-10-21 14:04:48 +010089 (&((struct encrypted_key_payload *)key->payload.data[0])->payload_data);
Roberto Sassu1252cc32011-06-27 13:45:45 +020090 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
Michael Halcrow237fead2006-10-04 02:16:22 -0700113static inline struct ecryptfs_auth_tok *
114ecryptfs_get_key_payload_data(struct key *key)
115{
Roberto Sassu1252cc32011-06-27 13:45:45 +0200116 struct ecryptfs_auth_tok *auth_tok;
117
118 auth_tok = ecryptfs_get_encrypted_key_payload_data(key);
119 if (!auth_tok)
David Howells146aa8b2015-10-21 14:04:48 +0100120 return (struct ecryptfs_auth_tok *)user_key_payload(key)->data;
Roberto Sassu1252cc32011-06-27 13:45:45 +0200121 else
122 return auth_tok;
Michael Halcrow237fead2006-10-04 02:16:22 -0700123}
124
Michael Halcrow237fead2006-10-04 02:16:22 -0700125#define ECRYPTFS_MAX_KEYSET_SIZE 1024
Colin Ian King2a559a82015-02-23 11:34:10 +0000126#define ECRYPTFS_MAX_CIPHER_NAME_SIZE 31
Michael Halcrow237fead2006-10-04 02:16:22 -0700127#define ECRYPTFS_MAX_NUM_ENC_KEYS 64
Michael Halcrow237fead2006-10-04 02:16:22 -0700128#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 */
Michael Halcrow45eaab72007-10-16 01:28:05 -0700132#define ECRYPTFS_FILE_SIZE_BYTES (sizeof(u64))
Tyler Hicks778aeb42011-05-24 04:56:23 -0500133#define ECRYPTFS_SIZE_AND_MARKER_BYTES (ECRYPTFS_FILE_SIZE_BYTES \
134 + MAGIC_ECRYPTFS_MARKER_SIZE_BYTES)
Michael Halcrow237fead2006-10-04 02:16:22 -0700135#define ECRYPTFS_DEFAULT_CIPHER "aes"
136#define ECRYPTFS_DEFAULT_KEY_BYTES 16
Michael Halcrow565d97242006-10-30 22:07:17 -0800137#define ECRYPTFS_DEFAULT_HASH "md5"
Michael Halcrow9c79f342009-01-06 14:41:57 -0800138#define ECRYPTFS_TAG_70_DIGEST ECRYPTFS_DEFAULT_HASH
Michael Halcrow88b4a072007-02-12 00:53:43 -0800139#define ECRYPTFS_TAG_1_PACKET_TYPE 0x01
Michael Halcrow237fead2006-10-04 02:16:22 -0700140#define ECRYPTFS_TAG_3_PACKET_TYPE 0x8C
141#define ECRYPTFS_TAG_11_PACKET_TYPE 0xED
Michael Halcrow88b4a072007-02-12 00:53:43 -0800142#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
Michael Halcrow9c79f342009-01-06 14:41:57 -0800146#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 */
Tyler Hicks48399c02012-01-14 16:46:46 +0100154#define ECRYPTFS_MIN_PKT_LEN_SIZE 1 /* Min size to specify packet length */
155#define ECRYPTFS_MAX_PKT_LEN_SIZE 2 /* Pass at least this many bytes to
156 * ecryptfs_parse_packet_length() and
157 * ecryptfs_write_packet_length()
158 */
Michael Halcrow9c79f342009-01-06 14:41:57 -0800159/* Constraint: ECRYPTFS_FILENAME_MIN_RANDOM_PREPEND_BYTES >=
160 * ECRYPTFS_MAX_IV_BYTES */
161#define ECRYPTFS_FILENAME_MIN_RANDOM_PREPEND_BYTES 16
162#define ECRYPTFS_NON_NULL 0x42 /* A reasonable substitute for NULL */
Michael Halcrow237fead2006-10-04 02:16:22 -0700163#define MD5_DIGEST_SIZE 16
Michael Halcrow9c79f342009-01-06 14:41:57 -0800164#define ECRYPTFS_TAG_70_DIGEST_SIZE MD5_DIGEST_SIZE
Tyler Hicks4a266202011-11-05 13:45:08 -0400165#define ECRYPTFS_TAG_70_MIN_METADATA_SIZE (1 + ECRYPTFS_MIN_PKT_LEN_SIZE \
166 + ECRYPTFS_SIG_SIZE + 1 + 1)
167#define ECRYPTFS_TAG_70_MAX_METADATA_SIZE (1 + ECRYPTFS_MAX_PKT_LEN_SIZE \
168 + ECRYPTFS_SIG_SIZE + 1 + 1)
Michael Halcrow9c79f342009-01-06 14:41:57 -0800169#define ECRYPTFS_FEK_ENCRYPTED_FILENAME_PREFIX "ECRYPTFS_FEK_ENCRYPTED."
170#define ECRYPTFS_FEK_ENCRYPTED_FILENAME_PREFIX_SIZE 23
171#define ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX "ECRYPTFS_FNEK_ENCRYPTED."
172#define ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX_SIZE 24
173#define ECRYPTFS_ENCRYPTED_DENTRY_NAME_LEN (18 + 1 + 4 + 1 + 32)
Michael Halcrow237fead2006-10-04 02:16:22 -0700174
Kees Cook290502b2013-02-28 00:39:37 -0800175#ifdef CONFIG_ECRYPT_FS_MESSAGING
176# define ECRYPTFS_VERSIONING_MASK_MESSAGING (ECRYPTFS_VERSIONING_DEVMISC \
177 | ECRYPTFS_VERSIONING_PUBKEY)
178#else
179# define ECRYPTFS_VERSIONING_MASK_MESSAGING 0
180#endif
181
182#define ECRYPTFS_VERSIONING_MASK (ECRYPTFS_VERSIONING_PASSPHRASE \
183 | ECRYPTFS_VERSIONING_PLAINTEXT_PASSTHROUGH \
184 | ECRYPTFS_VERSIONING_XATTR \
185 | ECRYPTFS_VERSIONING_MULTKEY \
186 | ECRYPTFS_VERSIONING_MASK_MESSAGING \
187 | ECRYPTFS_VERSIONING_FILENAME_ENCRYPTION)
Michael Halcrowf4aad162007-10-16 01:27:53 -0700188struct ecryptfs_key_sig {
189 struct list_head crypt_stat_list;
Roberto Sassu7762e232011-03-21 16:00:52 +0100190 char keysig[ECRYPTFS_SIG_SIZE_HEX + 1];
Michael Halcrowf4aad162007-10-16 01:27:53 -0700191};
192
Michael Halcrowa34f60f2009-01-06 14:41:58 -0800193struct ecryptfs_filename {
194 struct list_head crypt_stat_list;
195#define ECRYPTFS_FILENAME_CONTAINS_DECRYPTED 0x00000001
196 u32 flags;
197 u32 seq_no;
198 char *filename;
199 char *encrypted_filename;
200 size_t filename_size;
201 size_t encrypted_filename_size;
202 char fnek_sig[ECRYPTFS_SIG_SIZE_HEX];
203 char dentry_name[ECRYPTFS_ENCRYPTED_DENTRY_NAME_LEN + 1];
204};
205
Michael Halcrow237fead2006-10-04 02:16:22 -0700206/**
207 * This is the primary struct associated with each encrypted file.
208 *
209 * TODO: cache align/pack?
210 */
211struct ecryptfs_crypt_stat {
Michael Halcrowa34f60f2009-01-06 14:41:58 -0800212#define ECRYPTFS_STRUCT_INITIALIZED 0x00000001
213#define ECRYPTFS_POLICY_APPLIED 0x00000002
Tyler Hicksfed88592011-02-23 00:54:20 -0600214#define ECRYPTFS_ENCRYPTED 0x00000004
215#define ECRYPTFS_SECURITY_WARNING 0x00000008
216#define ECRYPTFS_ENABLE_HMAC 0x00000010
217#define ECRYPTFS_ENCRYPT_IV_PAGES 0x00000020
218#define ECRYPTFS_KEY_VALID 0x00000040
219#define ECRYPTFS_METADATA_IN_XATTR 0x00000080
220#define ECRYPTFS_VIEW_AS_ENCRYPTED 0x00000100
221#define ECRYPTFS_KEY_SET 0x00000200
222#define ECRYPTFS_ENCRYPT_FILENAMES 0x00000400
223#define ECRYPTFS_ENCFN_USE_MOUNT_FNEK 0x00000800
224#define ECRYPTFS_ENCFN_USE_FEK 0x00001000
225#define ECRYPTFS_UNLINK_SIGS 0x00002000
Tyler Hicks3aeb86e2011-03-15 14:54:00 -0500226#define ECRYPTFS_I_SIZE_INITIALIZED 0x00004000
Michael Halcrow237fead2006-10-04 02:16:22 -0700227 u32 flags;
228 unsigned int file_version;
229 size_t iv_bytes;
Tyler Hicksfa3ef1c2010-02-11 05:09:14 -0600230 size_t metadata_size;
Michael Halcrow237fead2006-10-04 02:16:22 -0700231 size_t extent_size; /* Data extent size; default is 4096 */
232 size_t key_size;
233 size_t extent_shift;
234 unsigned int extent_mask;
235 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
Herbert Xu3095e8e2016-01-25 10:29:33 +0800236 struct crypto_skcipher *tfm;
237 struct crypto_shash *hash_tfm; /* Crypto context for generating
238 * the initialization vectors */
Colin Ian King2a559a82015-02-23 11:34:10 +0000239 unsigned char cipher[ECRYPTFS_MAX_CIPHER_NAME_SIZE + 1];
Michael Halcrow237fead2006-10-04 02:16:22 -0700240 unsigned char key[ECRYPTFS_MAX_KEY_BYTES];
241 unsigned char root_iv[ECRYPTFS_MAX_IV_BYTES];
Michael Halcrowf4aad162007-10-16 01:27:53 -0700242 struct list_head keysig_list;
243 struct mutex keysig_list_mutex;
Michael Halcrow237fead2006-10-04 02:16:22 -0700244 struct mutex cs_tfm_mutex;
Michael Halcrow565d97242006-10-30 22:07:17 -0800245 struct mutex cs_hash_tfm_mutex;
Michael Halcrow237fead2006-10-04 02:16:22 -0700246 struct mutex cs_mutex;
247};
248
249/* inode private data. */
250struct ecryptfs_inode_info {
251 struct inode vfs_inode;
252 struct inode *wii_inode;
Tyler Hicks332ab162011-04-14 15:35:11 -0500253 struct mutex lower_file_mutex;
254 atomic_t lower_file_count;
Michael Halcrowda0102a2007-10-16 01:28:07 -0700255 struct file *lower_file;
Michael Halcrow237fead2006-10-04 02:16:22 -0700256 struct ecryptfs_crypt_stat crypt_stat;
257};
258
259/* dentry private data. Each dentry must keep track of a lower
260 * vfsmount too. */
261struct ecryptfs_dentry_info {
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -0800262 struct path lower_path;
Al Viro2edbfbf2013-09-15 20:45:11 -0400263 union {
264 struct ecryptfs_crypt_stat *crypt_stat;
265 struct rcu_head rcu;
266 };
Michael Halcrow237fead2006-10-04 02:16:22 -0700267};
268
Michael Halcrow6c6f57f2007-10-16 01:28:01 -0700269/**
Michael Halcrow45eaab72007-10-16 01:28:05 -0700270 * ecryptfs_global_auth_tok - A key used to encrypt all new files under the mountpoint
271 * @flags: Status flags
272 * @mount_crypt_stat_list: These auth_toks hang off the mount-wide
273 * cryptographic context. Every time a new
274 * inode comes into existence, eCryptfs copies
275 * the auth_toks on that list to the set of
276 * auth_toks on the inode's crypt_stat
277 * @global_auth_tok_key: The key from the user's keyring for the sig
278 * @global_auth_tok: The key contents
279 * @sig: The key identifier
280 *
Michael Halcrow6c6f57f2007-10-16 01:28:01 -0700281 * ecryptfs_global_auth_tok structs refer to authentication token keys
282 * in the user keyring that apply to newly created files. A list of
283 * these objects hangs off of the mount_crypt_stat struct for any
284 * given eCryptfs mount. This struct maintains a reference to both the
285 * key contents and the key itself so that the key can be put on
286 * unmount.
287 */
Michael Halcrowf4aad162007-10-16 01:27:53 -0700288struct ecryptfs_global_auth_tok {
289#define ECRYPTFS_AUTH_TOK_INVALID 0x00000001
Tyler Hicks84814d62009-03-13 13:51:59 -0700290#define ECRYPTFS_AUTH_TOK_FNEK 0x00000002
Michael Halcrowf4aad162007-10-16 01:27:53 -0700291 u32 flags;
Michael Halcrow45eaab72007-10-16 01:28:05 -0700292 struct list_head mount_crypt_stat_list;
293 struct key *global_auth_tok_key;
Michael Halcrow45eaab72007-10-16 01:28:05 -0700294 unsigned char sig[ECRYPTFS_SIG_SIZE_HEX + 1];
Michael Halcrowf4aad162007-10-16 01:27:53 -0700295};
296
Michael Halcrow6c6f57f2007-10-16 01:28:01 -0700297/**
Michael Halcrow45eaab72007-10-16 01:28:05 -0700298 * ecryptfs_key_tfm - Persistent key tfm
299 * @key_tfm: crypto API handle to the key
300 * @key_size: Key size in bytes
301 * @key_tfm_mutex: Mutex to ensure only one operation in eCryptfs is
302 * using the persistent TFM at any point in time
303 * @key_tfm_list: Handle to hang this off the module-wide TFM list
304 * @cipher_name: String name for the cipher for this TFM
305 *
Michael Halcrow6c6f57f2007-10-16 01:28:01 -0700306 * Typically, eCryptfs will use the same ciphers repeatedly throughout
307 * the course of its operations. In order to avoid unnecessarily
308 * destroying and initializing the same cipher repeatedly, eCryptfs
309 * keeps a list of crypto API contexts around to use when needed.
310 */
Michael Halcrowf4aad162007-10-16 01:27:53 -0700311struct ecryptfs_key_tfm {
Herbert Xu3095e8e2016-01-25 10:29:33 +0800312 struct crypto_skcipher *key_tfm;
Michael Halcrowf4aad162007-10-16 01:27:53 -0700313 size_t key_size;
314 struct mutex key_tfm_mutex;
Michael Halcrow45eaab72007-10-16 01:28:05 -0700315 struct list_head key_tfm_list;
Michael Halcrowf4aad162007-10-16 01:27:53 -0700316 unsigned char cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE + 1];
317};
318
Eric Sandeenaf440f52008-02-06 01:38:37 -0800319extern struct mutex key_tfm_list_mutex;
320
Michael Halcrow237fead2006-10-04 02:16:22 -0700321/**
322 * This struct is to enable a mount-wide passphrase/salt combo. This
323 * is more or less a stopgap to provide similar functionality to other
324 * crypto filesystems like EncFS or CFS until full policy support is
325 * implemented in eCryptfs.
326 */
327struct ecryptfs_mount_crypt_stat {
328 /* Pointers to memory we do not own, do not free these */
329#define ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED 0x00000001
Michael Halcrow17398952007-02-12 00:53:45 -0800330#define ECRYPTFS_XATTR_METADATA_ENABLED 0x00000002
331#define ECRYPTFS_ENCRYPTED_VIEW_ENABLED 0x00000004
Michael Halcrowf4aad162007-10-16 01:27:53 -0700332#define ECRYPTFS_MOUNT_CRYPT_STAT_INITIALIZED 0x00000008
Michael Halcrow9c79f342009-01-06 14:41:57 -0800333#define ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES 0x00000010
334#define ECRYPTFS_GLOBAL_ENCFN_USE_MOUNT_FNEK 0x00000020
335#define ECRYPTFS_GLOBAL_ENCFN_USE_FEK 0x00000040
Roberto Sassuf16feb52010-10-06 18:31:32 +0200336#define ECRYPTFS_GLOBAL_MOUNT_AUTH_TOK_ONLY 0x00000080
Michael Halcrow237fead2006-10-04 02:16:22 -0700337 u32 flags;
Michael Halcrowf4aad162007-10-16 01:27:53 -0700338 struct list_head global_auth_tok_list;
339 struct mutex global_auth_tok_list_mutex;
Michael Halcrow237fead2006-10-04 02:16:22 -0700340 size_t global_default_cipher_key_size;
Michael Halcrow9c79f342009-01-06 14:41:57 -0800341 size_t global_default_fn_cipher_key_bytes;
Michael Halcrow237fead2006-10-04 02:16:22 -0700342 unsigned char global_default_cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE
343 + 1];
Michael Halcrow9c79f342009-01-06 14:41:57 -0800344 unsigned char global_default_fn_cipher_name[
345 ECRYPTFS_MAX_CIPHER_NAME_SIZE + 1];
346 char global_default_fnek_sig[ECRYPTFS_SIG_SIZE_HEX + 1];
Michael Halcrow237fead2006-10-04 02:16:22 -0700347};
348
349/* superblock private data. */
350struct ecryptfs_sb_info {
351 struct super_block *wsi_sb;
352 struct ecryptfs_mount_crypt_stat mount_crypt_stat;
Jens Axboe9df9c8b2010-04-22 12:22:04 +0200353 struct backing_dev_info bdi;
Michael Halcrow237fead2006-10-04 02:16:22 -0700354};
355
356/* file private data. */
357struct ecryptfs_file_info {
358 struct file *wfi_file;
359 struct ecryptfs_crypt_stat *crypt_stat;
360};
361
362/* auth_tok <=> encrypted_session_key mappings */
363struct ecryptfs_auth_tok_list_item {
364 unsigned char encrypted_session_key[ECRYPTFS_MAX_KEY_BYTES];
365 struct list_head list;
366 struct ecryptfs_auth_tok auth_tok;
367};
368
Michael Halcrow88b4a072007-02-12 00:53:43 -0800369struct ecryptfs_message {
Michael Halcrowf66e8832008-04-29 00:59:51 -0700370 /* Can never be greater than ecryptfs_message_buf_len */
371 /* Used to find the parent msg_ctx */
372 /* Inherits from msg_ctx->index */
Michael Halcrow88b4a072007-02-12 00:53:43 -0800373 u32 index;
374 u32 data_len;
375 u8 data[];
376};
377
378struct ecryptfs_msg_ctx {
Michael Halcrowf66e8832008-04-29 00:59:51 -0700379#define ECRYPTFS_MSG_CTX_STATE_FREE 0x01
380#define ECRYPTFS_MSG_CTX_STATE_PENDING 0x02
381#define ECRYPTFS_MSG_CTX_STATE_DONE 0x03
382#define ECRYPTFS_MSG_CTX_STATE_NO_REPLY 0x04
383 u8 state;
384#define ECRYPTFS_MSG_HELO 100
385#define ECRYPTFS_MSG_QUIT 101
386#define ECRYPTFS_MSG_REQUEST 102
387#define ECRYPTFS_MSG_RESPONSE 103
388 u8 type;
389 u32 index;
390 /* Counter converts to a sequence number. Each message sent
391 * out for which we expect a response has an associated
392 * sequence number. The response must have the same sequence
393 * number as the counter for the msg_stc for the message to be
394 * valid. */
395 u32 counter;
396 size_t msg_size;
Michael Halcrow88b4a072007-02-12 00:53:43 -0800397 struct ecryptfs_message *msg;
398 struct task_struct *task;
399 struct list_head node;
Michael Halcrowf66e8832008-04-29 00:59:51 -0700400 struct list_head daemon_out_list;
Michael Halcrow88b4a072007-02-12 00:53:43 -0800401 struct mutex mux;
402};
403
Michael Halcrowf66e8832008-04-29 00:59:51 -0700404struct ecryptfs_daemon {
405#define ECRYPTFS_DAEMON_IN_READ 0x00000001
406#define ECRYPTFS_DAEMON_IN_POLL 0x00000002
407#define ECRYPTFS_DAEMON_ZOMBIE 0x00000004
408#define ECRYPTFS_DAEMON_MISCDEV_OPEN 0x00000008
409 u32 flags;
410 u32 num_queued_msg_ctx;
Tyler Hicks2ecaf552012-06-11 09:47:47 -0700411 struct file *file;
Michael Halcrowf66e8832008-04-29 00:59:51 -0700412 struct mutex mux;
413 struct list_head msg_ctx_out_queue;
414 wait_queue_head_t wait;
415 struct hlist_node euid_chain;
Michael Halcrow88b4a072007-02-12 00:53:43 -0800416};
417
Kees Cook290502b2013-02-28 00:39:37 -0800418#ifdef CONFIG_ECRYPT_FS_MESSAGING
Michael Halcrowf66e8832008-04-29 00:59:51 -0700419extern struct mutex ecryptfs_daemon_hash_mux;
Kees Cook290502b2013-02-28 00:39:37 -0800420#endif
Michael Halcrowf66e8832008-04-29 00:59:51 -0700421
Tyler Hicks157f1072010-02-11 07:10:38 -0600422static inline size_t
423ecryptfs_lower_header_size(struct ecryptfs_crypt_stat *crypt_stat)
424{
425 if (crypt_stat->flags & ECRYPTFS_METADATA_IN_XATTR)
426 return 0;
Tyler Hicksfa3ef1c2010-02-11 05:09:14 -0600427 return crypt_stat->metadata_size;
Tyler Hicks157f1072010-02-11 07:10:38 -0600428}
429
Michael Halcrow237fead2006-10-04 02:16:22 -0700430static inline struct ecryptfs_file_info *
431ecryptfs_file_to_private(struct file *file)
432{
Joe Perches0c6d7d52010-09-04 18:52:48 -0700433 return file->private_data;
Michael Halcrow237fead2006-10-04 02:16:22 -0700434}
435
436static inline void
437ecryptfs_set_file_private(struct file *file,
438 struct ecryptfs_file_info *file_info)
439{
440 file->private_data = file_info;
441}
442
443static inline struct file *ecryptfs_file_to_lower(struct file *file)
444{
445 return ((struct ecryptfs_file_info *)file->private_data)->wfi_file;
446}
447
448static inline void
449ecryptfs_set_file_lower(struct file *file, struct file *lower_file)
450{
451 ((struct ecryptfs_file_info *)file->private_data)->wfi_file =
452 lower_file;
453}
454
455static inline struct ecryptfs_inode_info *
456ecryptfs_inode_to_private(struct inode *inode)
457{
458 return container_of(inode, struct ecryptfs_inode_info, vfs_inode);
459}
460
461static inline struct inode *ecryptfs_inode_to_lower(struct inode *inode)
462{
463 return ecryptfs_inode_to_private(inode)->wii_inode;
464}
465
466static inline void
467ecryptfs_set_inode_lower(struct inode *inode, struct inode *lower_inode)
468{
469 ecryptfs_inode_to_private(inode)->wii_inode = lower_inode;
470}
471
472static inline struct ecryptfs_sb_info *
473ecryptfs_superblock_to_private(struct super_block *sb)
474{
475 return (struct ecryptfs_sb_info *)sb->s_fs_info;
476}
477
478static inline void
479ecryptfs_set_superblock_private(struct super_block *sb,
480 struct ecryptfs_sb_info *sb_info)
481{
482 sb->s_fs_info = sb_info;
483}
484
485static inline struct super_block *
486ecryptfs_superblock_to_lower(struct super_block *sb)
487{
488 return ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb;
489}
490
491static inline void
492ecryptfs_set_superblock_lower(struct super_block *sb,
493 struct super_block *lower_sb)
494{
495 ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb = lower_sb;
496}
497
498static inline struct ecryptfs_dentry_info *
499ecryptfs_dentry_to_private(struct dentry *dentry)
500{
501 return (struct ecryptfs_dentry_info *)dentry->d_fsdata;
502}
503
504static inline void
505ecryptfs_set_dentry_private(struct dentry *dentry,
506 struct ecryptfs_dentry_info *dentry_info)
507{
508 dentry->d_fsdata = dentry_info;
509}
510
511static inline struct dentry *
512ecryptfs_dentry_to_lower(struct dentry *dentry)
513{
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -0800514 return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry;
Michael Halcrow237fead2006-10-04 02:16:22 -0700515}
516
Michael Halcrow237fead2006-10-04 02:16:22 -0700517static inline struct vfsmount *
518ecryptfs_dentry_to_lower_mnt(struct dentry *dentry)
519{
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -0800520 return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt;
Michael Halcrow237fead2006-10-04 02:16:22 -0700521}
522
Al Viro3dadecc2013-01-24 02:18:08 -0500523static inline struct path *
524ecryptfs_dentry_to_lower_path(struct dentry *dentry)
525{
526 return &((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path;
527}
528
Michael Halcrow237fead2006-10-04 02:16:22 -0700529#define ecryptfs_printk(type, fmt, arg...) \
Harvey Harrison18d1dbf2008-04-29 00:59:48 -0700530 __ecryptfs_printk(type "%s: " fmt, __func__, ## arg);
Joe Perchesb9075fa2011-10-31 17:11:33 -0700531__printf(1, 2)
Michael Halcrow237fead2006-10-04 02:16:22 -0700532void __ecryptfs_printk(const char *fmt, ...);
533
534extern const struct file_operations ecryptfs_main_fops;
535extern const struct file_operations ecryptfs_dir_fops;
Arjan van de Ven754661f2007-02-12 00:55:38 -0800536extern const struct inode_operations ecryptfs_main_iops;
537extern const struct inode_operations ecryptfs_dir_iops;
538extern const struct inode_operations ecryptfs_symlink_iops;
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -0800539extern const struct super_operations ecryptfs_sops;
Al Viro5a3fd052009-02-20 05:57:52 +0000540extern const struct dentry_operations ecryptfs_dops;
Alexey Dobriyan7f094102009-09-21 17:01:10 -0700541extern const struct address_space_operations ecryptfs_aops;
Michael Halcrow237fead2006-10-04 02:16:22 -0700542extern int ecryptfs_verbosity;
Michael Halcrow88b4a072007-02-12 00:53:43 -0800543extern unsigned int ecryptfs_message_buf_len;
544extern signed long ecryptfs_message_wait_timeout;
545extern unsigned int ecryptfs_number_of_users;
Michael Halcrow237fead2006-10-04 02:16:22 -0700546
547extern struct kmem_cache *ecryptfs_auth_tok_list_item_cache;
548extern struct kmem_cache *ecryptfs_file_info_cache;
549extern struct kmem_cache *ecryptfs_dentry_info_cache;
550extern struct kmem_cache *ecryptfs_inode_info_cache;
551extern struct kmem_cache *ecryptfs_sb_info_cache;
Tyler Hicks30632872011-05-24 05:11:12 -0500552extern struct kmem_cache *ecryptfs_header_cache;
Michael Halcrowdd2a3b72007-02-12 00:53:46 -0800553extern struct kmem_cache *ecryptfs_xattr_cache;
Michael Halcroweb95e7f2007-02-16 01:28:40 -0800554extern struct kmem_cache *ecryptfs_key_record_cache;
Michael Halcrowf4aad162007-10-16 01:27:53 -0700555extern struct kmem_cache *ecryptfs_key_sig_cache;
556extern struct kmem_cache *ecryptfs_global_auth_tok_cache;
557extern struct kmem_cache *ecryptfs_key_tfm_cache;
Michael Halcrow237fead2006-10-04 02:16:22 -0700558
Tyler Hicksc4f79072011-05-23 21:18:20 -0500559struct inode *ecryptfs_get_inode(struct inode *lower_inode,
560 struct super_block *sb);
Tyler Hicks3aeb86e2011-03-15 14:54:00 -0500561void ecryptfs_i_size_init(const char *page_virt, struct inode *inode);
Tyler Hickse3ccaa92012-06-20 23:50:59 -0700562int ecryptfs_initialize_file(struct dentry *ecryptfs_dentry,
563 struct inode *ecryptfs_inode);
Michael Halcrowa34f60f2009-01-06 14:41:58 -0800564int ecryptfs_decode_and_decrypt_filename(char **decrypted_name,
565 size_t *decrypted_name_size,
Al Viro0747fdb2013-06-16 20:05:38 +0400566 struct super_block *sb,
Michael Halcrowa34f60f2009-01-06 14:41:58 -0800567 const char *name, size_t name_size);
Michael Halcrow237fead2006-10-04 02:16:22 -0700568int ecryptfs_fill_zeros(struct file *file, loff_t new_length);
Michael Halcrowa34f60f2009-01-06 14:41:58 -0800569int ecryptfs_encrypt_and_encode_filename(
570 char **encoded_name,
571 size_t *encoded_name_size,
Michael Halcrowa34f60f2009-01-06 14:41:58 -0800572 struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
573 const char *name, size_t name_size);
Michael Halcrow237fead2006-10-04 02:16:22 -0700574struct dentry *ecryptfs_lower_dentry(struct dentry *this_dentry);
Michael Halcrow237fead2006-10-04 02:16:22 -0700575void ecryptfs_dump_hex(char *data, int bytes);
576int virt_to_scatterlist(const void *addr, int size, struct scatterlist *sg,
577 int sg_size);
578int ecryptfs_compute_root_iv(struct ecryptfs_crypt_stat *crypt_stat);
579void ecryptfs_rotate_iv(unsigned char *iv);
580void ecryptfs_init_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
Michael Halcrowfcd12832007-10-16 01:28:01 -0700581void ecryptfs_destroy_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
582void ecryptfs_destroy_mount_crypt_stat(
Michael Halcrow237fead2006-10-04 02:16:22 -0700583 struct ecryptfs_mount_crypt_stat *mount_crypt_stat);
584int ecryptfs_init_crypt_ctx(struct ecryptfs_crypt_stat *crypt_stat);
Michael Halcrowb6c1d8f2007-10-16 01:28:13 -0700585int ecryptfs_write_inode_size_to_metadata(struct inode *ecryptfs_inode);
Michael Halcrow0216f7f2007-10-16 01:28:08 -0700586int ecryptfs_encrypt_page(struct page *page);
587int ecryptfs_decrypt_page(struct page *page);
Tyler Hicksb59db432011-11-21 17:31:02 -0600588int ecryptfs_write_metadata(struct dentry *ecryptfs_dentry,
589 struct inode *ecryptfs_inode);
Michael Halcrowd7cdc5f2007-10-16 01:28:10 -0700590int ecryptfs_read_metadata(struct dentry *ecryptfs_dentry);
Tyler Hicksb59db432011-11-21 17:31:02 -0600591int ecryptfs_new_file_context(struct inode *ecryptfs_inode);
Tyler Hicksf4e60e62010-02-11 00:02:32 -0600592void ecryptfs_write_crypt_stat_flags(char *page_virt,
593 struct ecryptfs_crypt_stat *crypt_stat,
594 size_t *written);
Tyler Hicks778aeb42011-05-24 04:56:23 -0500595int ecryptfs_read_and_validate_header_region(struct inode *inode);
596int ecryptfs_read_and_validate_xattr_region(struct dentry *dentry,
Tyler Hicks3b06b3e2011-05-24 03:49:02 -0500597 struct inode *inode);
Michael Halcrow9c79f342009-01-06 14:41:57 -0800598u8 ecryptfs_code_for_cipher_string(char *cipher_name, size_t key_bytes);
Trevor Highland19e66a62008-02-06 01:38:36 -0800599int ecryptfs_cipher_code_to_string(char *str, u8 cipher_code);
Michael Halcrow237fead2006-10-04 02:16:22 -0700600void ecryptfs_set_default_sizes(struct ecryptfs_crypt_stat *crypt_stat);
601int ecryptfs_generate_key_packet_set(char *dest_base,
602 struct ecryptfs_crypt_stat *crypt_stat,
603 struct dentry *ecryptfs_dentry,
604 size_t *len, size_t max);
Michael Halcrow237fead2006-10-04 02:16:22 -0700605int
606ecryptfs_parse_packet_set(struct ecryptfs_crypt_stat *crypt_stat,
607 unsigned char *src, struct dentry *ecryptfs_dentry);
608int ecryptfs_truncate(struct dentry *dentry, loff_t new_length);
Michael Halcrowd7cdc5f2007-10-16 01:28:10 -0700609ssize_t
610ecryptfs_getxattr_lower(struct dentry *lower_dentry, const char *name,
611 void *value, size_t size);
Michael Halcrowdd2a3b72007-02-12 00:53:46 -0800612int
613ecryptfs_setxattr(struct dentry *dentry, const char *name, const void *value,
614 size_t size, int flags);
Michael Halcrowd7cdc5f2007-10-16 01:28:10 -0700615int ecryptfs_read_xattr_region(char *page_virt, struct inode *ecryptfs_inode);
Kees Cook290502b2013-02-28 00:39:37 -0800616#ifdef CONFIG_ECRYPT_FS_MESSAGING
Tyler Hicks2ecaf552012-06-11 09:47:47 -0700617int ecryptfs_process_response(struct ecryptfs_daemon *daemon,
618 struct ecryptfs_message *msg, u32 seq);
Tyler Hicks624ae522008-10-15 22:02:51 -0700619int ecryptfs_send_message(char *data, int data_len,
Michael Halcrow88b4a072007-02-12 00:53:43 -0800620 struct ecryptfs_msg_ctx **msg_ctx);
621int ecryptfs_wait_for_response(struct ecryptfs_msg_ctx *msg_ctx,
622 struct ecryptfs_message **emsg);
Tyler Hicks624ae522008-10-15 22:02:51 -0700623int ecryptfs_init_messaging(void);
624void ecryptfs_release_messaging(void);
Kees Cook290502b2013-02-28 00:39:37 -0800625#else
626static inline int ecryptfs_init_messaging(void)
627{
628 return 0;
629}
630static inline void ecryptfs_release_messaging(void)
631{ }
632static inline int ecryptfs_send_message(char *data, int data_len,
633 struct ecryptfs_msg_ctx **msg_ctx)
634{
635 return -ENOTCONN;
636}
637static inline int ecryptfs_wait_for_response(struct ecryptfs_msg_ctx *msg_ctx,
638 struct ecryptfs_message **emsg)
639{
640 return -ENOMSG;
641}
642#endif
Michael Halcrow88b4a072007-02-12 00:53:43 -0800643
Michael Halcrowe77a56d2007-02-12 00:53:47 -0800644void
645ecryptfs_write_header_metadata(char *virt,
646 struct ecryptfs_crypt_stat *crypt_stat,
647 size_t *written);
Michael Halcrowf4aad162007-10-16 01:27:53 -0700648int ecryptfs_add_keysig(struct ecryptfs_crypt_stat *crypt_stat, char *sig);
649int
650ecryptfs_add_global_auth_tok(struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
Tyler Hicks84814d62009-03-13 13:51:59 -0700651 char *sig, u32 global_auth_tok_flags);
Michael Halcrowf4aad162007-10-16 01:27:53 -0700652int ecryptfs_get_global_auth_tok_for_sig(
653 struct ecryptfs_global_auth_tok **global_auth_tok,
654 struct ecryptfs_mount_crypt_stat *mount_crypt_stat, char *sig);
655int
656ecryptfs_add_new_key_tfm(struct ecryptfs_key_tfm **key_tfm, char *cipher_name,
657 size_t key_size);
658int ecryptfs_init_crypto(void);
Michael Halcrowfcd12832007-10-16 01:28:01 -0700659int ecryptfs_destroy_crypto(void);
Eric Sandeenaf440f52008-02-06 01:38:37 -0800660int ecryptfs_tfm_exists(char *cipher_name, struct ecryptfs_key_tfm **key_tfm);
Herbert Xu3095e8e2016-01-25 10:29:33 +0800661int ecryptfs_get_tfm_and_mutex_for_cipher_name(struct crypto_skcipher **tfm,
Michael Halcrowf4aad162007-10-16 01:27:53 -0700662 struct mutex **tfm_mutex,
663 char *cipher_name);
664int ecryptfs_keyring_auth_tok_for_sig(struct key **auth_tok_key,
665 struct ecryptfs_auth_tok **auth_tok,
666 char *sig);
Michael Halcrowda0102a2007-10-16 01:28:07 -0700667int ecryptfs_write_lower(struct inode *ecryptfs_inode, char *data,
668 loff_t offset, size_t size);
669int ecryptfs_write_lower_page_segment(struct inode *ecryptfs_inode,
670 struct page *page_for_lower,
671 size_t offset_in_page, size_t size);
Al Viro48c1e442010-05-21 11:09:58 -0400672int ecryptfs_write(struct inode *inode, char *data, loff_t offset, size_t size);
Michael Halcrowda0102a2007-10-16 01:28:07 -0700673int ecryptfs_read_lower(char *data, loff_t offset, size_t size,
674 struct inode *ecryptfs_inode);
675int ecryptfs_read_lower_page_segment(struct page *page_for_ecryptfs,
676 pgoff_t page_index,
677 size_t offset_in_page, size_t size,
678 struct inode *ecryptfs_inode);
Al Viro02bd9792010-05-21 11:02:14 -0400679struct page *ecryptfs_get_locked_page(struct inode *inode, loff_t index);
Michael Halcrowf66e8832008-04-29 00:59:51 -0700680int ecryptfs_parse_packet_length(unsigned char *data, size_t *size,
681 size_t *length_size);
682int ecryptfs_write_packet_length(char *dest, size_t size,
683 size_t *packet_size_length);
Kees Cook290502b2013-02-28 00:39:37 -0800684#ifdef CONFIG_ECRYPT_FS_MESSAGING
Michael Halcrowf66e8832008-04-29 00:59:51 -0700685int ecryptfs_init_ecryptfs_miscdev(void);
686void ecryptfs_destroy_ecryptfs_miscdev(void);
687int ecryptfs_send_miscdev(char *data, size_t data_size,
688 struct ecryptfs_msg_ctx *msg_ctx, u8 msg_type,
689 u16 msg_flags, struct ecryptfs_daemon *daemon);
690void ecryptfs_msg_ctx_alloc_to_free(struct ecryptfs_msg_ctx *msg_ctx);
691int
Tyler Hicks2ecaf552012-06-11 09:47:47 -0700692ecryptfs_spawn_daemon(struct ecryptfs_daemon **daemon, struct file *file);
Kees Cook290502b2013-02-28 00:39:37 -0800693int ecryptfs_exorcise_daemon(struct ecryptfs_daemon *daemon);
694int ecryptfs_find_daemon_by_euid(struct ecryptfs_daemon **daemon);
695#endif
Michael Halcrow746f1e52008-07-23 21:30:02 -0700696int ecryptfs_init_kthread(void);
697void ecryptfs_destroy_kthread(void);
698int ecryptfs_privileged_open(struct file **lower_file,
699 struct dentry *lower_dentry,
David Howells745ca242008-11-14 10:39:22 +1100700 struct vfsmount *lower_mnt,
701 const struct cred *cred);
Tyler Hicks3b06b3e2011-05-24 03:49:02 -0500702int ecryptfs_get_lower_file(struct dentry *dentry, struct inode *inode);
Tyler Hicks332ab162011-04-14 15:35:11 -0500703void ecryptfs_put_lower_file(struct inode *inode);
Michael Halcrow9c79f342009-01-06 14:41:57 -0800704int
705ecryptfs_write_tag_70_packet(char *dest, size_t *remaining_bytes,
706 size_t *packet_size,
707 struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
708 char *filename, size_t filename_size);
709int
710ecryptfs_parse_tag_70_packet(char **filename, size_t *filename_size,
711 size_t *packet_size,
712 struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
713 char *data, size_t max_packet_size);
Tyler Hicks4a266202011-11-05 13:45:08 -0400714int ecryptfs_set_f_namelen(long *namelen, long lower_namelen,
715 struct ecryptfs_mount_crypt_stat *mount_crypt_stat);
Michael Halcrowa34f60f2009-01-06 14:41:58 -0800716int ecryptfs_derive_iv(char *iv, struct ecryptfs_crypt_stat *crypt_stat,
717 loff_t offset);
Michael Halcrow88b4a072007-02-12 00:53:43 -0800718
Michael Halcrow237fead2006-10-04 02:16:22 -0700719#endif /* #ifndef ECRYPTFS_KERNEL_H */