blob: 54481a3b2c7960e6ba205696c9d69ec44b331194 [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
31#include <keys/user-type.h>
Roberto Sassu1252cc32011-06-27 13:45:45 +020032#include <keys/encrypted-type.h>
Michael Halcrow237fead2006-10-04 02:16:22 -070033#include <linux/fs.h>
Josef "Jeff" Sipek0cc72dc2006-12-08 02:36:31 -080034#include <linux/fs_stack.h>
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -080035#include <linux/namei.h>
Michael Halcrow237fead2006-10-04 02:16:22 -070036#include <linux/scatterlist.h>
Michael Halcrowdddfa462007-02-12 00:53:44 -080037#include <linux/hash.h>
Michael Halcrow6a3fd922008-04-29 00:59:52 -070038#include <linux/nsproxy.h>
Jens Axboe9df9c8b2010-04-22 12:22:04 +020039#include <linux/backing-dev.h>
Roberto Sassuf8f85272011-06-27 13:45:43 +020040#include <linux/ecryptfs.h>
Michael Halcrow237fead2006-10-04 02:16:22 -070041
Michael Halcrow237fead2006-10-04 02:16:22 -070042#define ECRYPTFS_DEFAULT_IV_BYTES 16
Michael Halcrow237fead2006-10-04 02:16:22 -070043#define ECRYPTFS_DEFAULT_EXTENT_SIZE 4096
44#define ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE 8192
Michael Halcrow88b4a072007-02-12 00:53:43 -080045#define ECRYPTFS_DEFAULT_MSG_CTX_ELEMS 32
46#define ECRYPTFS_DEFAULT_SEND_TIMEOUT HZ
47#define ECRYPTFS_MAX_MSG_CTX_TTL (HZ*3)
Michael Halcrow88b4a072007-02-12 00:53:43 -080048#define ECRYPTFS_DEFAULT_NUM_USERS 4
49#define ECRYPTFS_MAX_NUM_USERS 32768
Michael Halcrowdd2a3b72007-02-12 00:53:46 -080050#define ECRYPTFS_XATTR_NAME "user.ecryptfs"
Michael Halcrow237fead2006-10-04 02:16:22 -070051
Michael Halcrow237fead2006-10-04 02:16:22 -070052void 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
Roberto Sassu1252cc32011-06-27 13:45:45 +020082#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
Michael Halcrow237fead2006-10-04 02:16:22 -0700112static inline struct ecryptfs_auth_tok *
113ecryptfs_get_key_payload_data(struct key *key)
114{
Roberto Sassu1252cc32011-06-27 13:45:45 +0200115 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;
Michael Halcrow237fead2006-10-04 02:16:22 -0700123}
124
Michael Halcrow237fead2006-10-04 02:16:22 -0700125#define ECRYPTFS_MAX_KEYSET_SIZE 1024
126#define ECRYPTFS_MAX_CIPHER_NAME_SIZE 32
127#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 */
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 */
Michael Halcrow237fead2006-10-04 02:16:22 -0700158#define MD5_DIGEST_SIZE 16
Michael Halcrow9c79f342009-01-06 14:41:57 -0800159#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)
Michael Halcrow237fead2006-10-04 02:16:22 -0700165
Michael Halcrowf4aad162007-10-16 01:27:53 -0700166struct ecryptfs_key_sig {
167 struct list_head crypt_stat_list;
Roberto Sassu7762e232011-03-21 16:00:52 +0100168 char keysig[ECRYPTFS_SIG_SIZE_HEX + 1];
Michael Halcrowf4aad162007-10-16 01:27:53 -0700169};
170
Michael Halcrowa34f60f2009-01-06 14:41:58 -0800171struct 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
Michael Halcrow237fead2006-10-04 02:16:22 -0700184/**
185 * This is the primary struct associated with each encrypted file.
186 *
187 * TODO: cache align/pack?
188 */
189struct ecryptfs_crypt_stat {
Michael Halcrowa34f60f2009-01-06 14:41:58 -0800190#define ECRYPTFS_STRUCT_INITIALIZED 0x00000001
191#define ECRYPTFS_POLICY_APPLIED 0x00000002
Tyler Hicksfed88592011-02-23 00:54:20 -0600192#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
Tyler Hicks3aeb86e2011-03-15 14:54:00 -0500204#define ECRYPTFS_I_SIZE_INITIALIZED 0x00004000
Michael Halcrow237fead2006-10-04 02:16:22 -0700205 u32 flags;
206 unsigned int file_version;
207 size_t iv_bytes;
Tyler Hicksfa3ef1c2010-02-11 05:09:14 -0600208 size_t metadata_size;
Michael Halcrow237fead2006-10-04 02:16:22 -0700209 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;
Michael Halcrow8bba0662006-10-30 22:07:18 -0800214 struct crypto_blkcipher *tfm;
Michael Halcrow565d97242006-10-30 22:07:17 -0800215 struct crypto_hash *hash_tfm; /* Crypto context for generating
216 * the initialization vectors */
Michael Halcrow237fead2006-10-04 02:16:22 -0700217 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];
Michael Halcrowf4aad162007-10-16 01:27:53 -0700220 struct list_head keysig_list;
221 struct mutex keysig_list_mutex;
Michael Halcrow237fead2006-10-04 02:16:22 -0700222 struct mutex cs_tfm_mutex;
Michael Halcrow565d97242006-10-30 22:07:17 -0800223 struct mutex cs_hash_tfm_mutex;
Michael Halcrow237fead2006-10-04 02:16:22 -0700224 struct mutex cs_mutex;
225};
226
227/* inode private data. */
228struct ecryptfs_inode_info {
229 struct inode vfs_inode;
230 struct inode *wii_inode;
Tyler Hicks332ab162011-04-14 15:35:11 -0500231 struct mutex lower_file_mutex;
232 atomic_t lower_file_count;
Michael Halcrowda0102a2007-10-16 01:28:07 -0700233 struct file *lower_file;
Michael Halcrow237fead2006-10-04 02:16:22 -0700234 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 {
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -0800240 struct path lower_path;
Michael Halcrow237fead2006-10-04 02:16:22 -0700241 struct ecryptfs_crypt_stat *crypt_stat;
242};
243
Michael Halcrow6c6f57f2007-10-16 01:28:01 -0700244/**
Michael Halcrow45eaab72007-10-16 01:28:05 -0700245 * 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 *
Michael Halcrow6c6f57f2007-10-16 01:28:01 -0700256 * 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 */
Michael Halcrowf4aad162007-10-16 01:27:53 -0700263struct ecryptfs_global_auth_tok {
264#define ECRYPTFS_AUTH_TOK_INVALID 0x00000001
Tyler Hicks84814d62009-03-13 13:51:59 -0700265#define ECRYPTFS_AUTH_TOK_FNEK 0x00000002
Michael Halcrowf4aad162007-10-16 01:27:53 -0700266 u32 flags;
Michael Halcrow45eaab72007-10-16 01:28:05 -0700267 struct list_head mount_crypt_stat_list;
268 struct key *global_auth_tok_key;
Michael Halcrow45eaab72007-10-16 01:28:05 -0700269 unsigned char sig[ECRYPTFS_SIG_SIZE_HEX + 1];
Michael Halcrowf4aad162007-10-16 01:27:53 -0700270};
271
Michael Halcrow6c6f57f2007-10-16 01:28:01 -0700272/**
Michael Halcrow45eaab72007-10-16 01:28:05 -0700273 * 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 *
Michael Halcrow6c6f57f2007-10-16 01:28:01 -0700281 * 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 */
Michael Halcrowf4aad162007-10-16 01:27:53 -0700286struct ecryptfs_key_tfm {
287 struct crypto_blkcipher *key_tfm;
288 size_t key_size;
289 struct mutex key_tfm_mutex;
Michael Halcrow45eaab72007-10-16 01:28:05 -0700290 struct list_head key_tfm_list;
Michael Halcrowf4aad162007-10-16 01:27:53 -0700291 unsigned char cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE + 1];
292};
293
Eric Sandeenaf440f52008-02-06 01:38:37 -0800294extern struct mutex key_tfm_list_mutex;
295
Michael Halcrow237fead2006-10-04 02:16:22 -0700296/**
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
Michael Halcrow17398952007-02-12 00:53:45 -0800305#define ECRYPTFS_XATTR_METADATA_ENABLED 0x00000002
306#define ECRYPTFS_ENCRYPTED_VIEW_ENABLED 0x00000004
Michael Halcrowf4aad162007-10-16 01:27:53 -0700307#define ECRYPTFS_MOUNT_CRYPT_STAT_INITIALIZED 0x00000008
Michael Halcrow9c79f342009-01-06 14:41:57 -0800308#define ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES 0x00000010
309#define ECRYPTFS_GLOBAL_ENCFN_USE_MOUNT_FNEK 0x00000020
310#define ECRYPTFS_GLOBAL_ENCFN_USE_FEK 0x00000040
Roberto Sassuf16feb52010-10-06 18:31:32 +0200311#define ECRYPTFS_GLOBAL_MOUNT_AUTH_TOK_ONLY 0x00000080
Michael Halcrow237fead2006-10-04 02:16:22 -0700312 u32 flags;
Michael Halcrowf4aad162007-10-16 01:27:53 -0700313 struct list_head global_auth_tok_list;
314 struct mutex global_auth_tok_list_mutex;
Michael Halcrow237fead2006-10-04 02:16:22 -0700315 size_t global_default_cipher_key_size;
Michael Halcrow9c79f342009-01-06 14:41:57 -0800316 size_t global_default_fn_cipher_key_bytes;
Michael Halcrow237fead2006-10-04 02:16:22 -0700317 unsigned char global_default_cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE
318 + 1];
Michael Halcrow9c79f342009-01-06 14:41:57 -0800319 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];
Michael Halcrow237fead2006-10-04 02:16:22 -0700322};
323
324/* superblock private data. */
325struct ecryptfs_sb_info {
326 struct super_block *wsi_sb;
327 struct ecryptfs_mount_crypt_stat mount_crypt_stat;
Jens Axboe9df9c8b2010-04-22 12:22:04 +0200328 struct backing_dev_info bdi;
Michael Halcrow237fead2006-10-04 02:16:22 -0700329};
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
Michael Halcrow88b4a072007-02-12 00:53:43 -0800344struct ecryptfs_message {
Michael Halcrowf66e8832008-04-29 00:59:51 -0700345 /* Can never be greater than ecryptfs_message_buf_len */
346 /* Used to find the parent msg_ctx */
347 /* Inherits from msg_ctx->index */
Michael Halcrow88b4a072007-02-12 00:53:43 -0800348 u32 index;
349 u32 data_len;
350 u8 data[];
351};
352
353struct ecryptfs_msg_ctx {
Michael Halcrowf66e8832008-04-29 00:59:51 -0700354#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;
Michael Halcrow88b4a072007-02-12 00:53:43 -0800372 struct ecryptfs_message *msg;
373 struct task_struct *task;
374 struct list_head node;
Michael Halcrowf66e8832008-04-29 00:59:51 -0700375 struct list_head daemon_out_list;
Michael Halcrow88b4a072007-02-12 00:53:43 -0800376 struct mutex mux;
377};
378
Michael Halcrowf66e8832008-04-29 00:59:51 -0700379struct 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;
Michael Halcrow6a3fd922008-04-29 00:59:52 -0700388 struct pid *pid;
Michael Halcrowf66e8832008-04-29 00:59:51 -0700389 uid_t euid;
Michael Halcrow6a3fd922008-04-29 00:59:52 -0700390 struct user_namespace *user_ns;
Michael Halcrowf66e8832008-04-29 00:59:51 -0700391 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;
Michael Halcrow88b4a072007-02-12 00:53:43 -0800396};
397
Michael Halcrowf66e8832008-04-29 00:59:51 -0700398extern struct mutex ecryptfs_daemon_hash_mux;
399
Tyler Hicks157f1072010-02-11 07:10:38 -0600400static 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;
Tyler Hicksfa3ef1c2010-02-11 05:09:14 -0600405 return crypt_stat->metadata_size;
Tyler Hicks157f1072010-02-11 07:10:38 -0600406}
407
Michael Halcrow237fead2006-10-04 02:16:22 -0700408static inline struct ecryptfs_file_info *
409ecryptfs_file_to_private(struct file *file)
410{
Joe Perches0c6d7d52010-09-04 18:52:48 -0700411 return file->private_data;
Michael Halcrow237fead2006-10-04 02:16:22 -0700412}
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{
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -0800492 return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry;
Michael Halcrow237fead2006-10-04 02:16:22 -0700493}
494
495static inline void
496ecryptfs_set_dentry_lower(struct dentry *dentry, struct dentry *lower_dentry)
497{
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -0800498 ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry =
Michael Halcrow237fead2006-10-04 02:16:22 -0700499 lower_dentry;
500}
501
502static inline struct vfsmount *
503ecryptfs_dentry_to_lower_mnt(struct dentry *dentry)
504{
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -0800505 return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt;
Michael Halcrow237fead2006-10-04 02:16:22 -0700506}
507
508static inline void
509ecryptfs_set_dentry_lower_mnt(struct dentry *dentry, struct vfsmount *lower_mnt)
510{
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -0800511 ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt =
Michael Halcrow237fead2006-10-04 02:16:22 -0700512 lower_mnt;
513}
514
515#define ecryptfs_printk(type, fmt, arg...) \
Harvey Harrison18d1dbf2008-04-29 00:59:48 -0700516 __ecryptfs_printk(type "%s: " fmt, __func__, ## arg);
Joe Perchesb9075fa2011-10-31 17:11:33 -0700517__printf(1, 2)
Michael Halcrow237fead2006-10-04 02:16:22 -0700518void __ecryptfs_printk(const char *fmt, ...);
519
520extern const struct file_operations ecryptfs_main_fops;
521extern const struct file_operations ecryptfs_dir_fops;
Arjan van de Ven754661f2007-02-12 00:55:38 -0800522extern const struct inode_operations ecryptfs_main_iops;
523extern const struct inode_operations ecryptfs_dir_iops;
524extern const struct inode_operations ecryptfs_symlink_iops;
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -0800525extern const struct super_operations ecryptfs_sops;
Al Viro5a3fd052009-02-20 05:57:52 +0000526extern const struct dentry_operations ecryptfs_dops;
Alexey Dobriyan7f094102009-09-21 17:01:10 -0700527extern const struct address_space_operations ecryptfs_aops;
Michael Halcrow237fead2006-10-04 02:16:22 -0700528extern int ecryptfs_verbosity;
Michael Halcrow88b4a072007-02-12 00:53:43 -0800529extern unsigned int ecryptfs_message_buf_len;
530extern signed long ecryptfs_message_wait_timeout;
531extern unsigned int ecryptfs_number_of_users;
Michael Halcrow237fead2006-10-04 02:16:22 -0700532
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;
Tyler Hicks30632872011-05-24 05:11:12 -0500538extern struct kmem_cache *ecryptfs_header_cache;
Michael Halcrowdd2a3b72007-02-12 00:53:46 -0800539extern struct kmem_cache *ecryptfs_xattr_cache;
Michael Halcroweb95e7f2007-02-16 01:28:40 -0800540extern struct kmem_cache *ecryptfs_key_record_cache;
Michael Halcrowf4aad162007-10-16 01:27:53 -0700541extern struct kmem_cache *ecryptfs_key_sig_cache;
542extern struct kmem_cache *ecryptfs_global_auth_tok_cache;
543extern struct kmem_cache *ecryptfs_key_tfm_cache;
Michael Halcrow746f1e52008-07-23 21:30:02 -0700544extern 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};
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);
Michael Halcrowa34f60f2009-01-06 14:41:58 -0800562int 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);
Michael Halcrow237fead2006-10-04 02:16:22 -0700566int ecryptfs_fill_zeros(struct file *file, loff_t new_length);
Michael Halcrowa34f60f2009-01-06 14:41:58 -0800567int 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);
Michael Halcrow237fead2006-10-04 02:16:22 -0700573struct dentry *ecryptfs_lower_dentry(struct dentry *this_dentry);
Michael Halcrow237fead2006-10-04 02:16:22 -0700574void 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);
Michael Halcrowfcd12832007-10-16 01:28:01 -0700580void ecryptfs_destroy_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
581void ecryptfs_destroy_mount_crypt_stat(
Michael Halcrow237fead2006-10-04 02:16:22 -0700582 struct ecryptfs_mount_crypt_stat *mount_crypt_stat);
583int ecryptfs_init_crypt_ctx(struct ecryptfs_crypt_stat *crypt_stat);
Michael Halcrowb6c1d8f2007-10-16 01:28:13 -0700584int ecryptfs_write_inode_size_to_metadata(struct inode *ecryptfs_inode);
Michael Halcrow0216f7f2007-10-16 01:28:08 -0700585int ecryptfs_encrypt_page(struct page *page);
586int ecryptfs_decrypt_page(struct page *page);
Michael Halcrowd7cdc5f2007-10-16 01:28:10 -0700587int ecryptfs_write_metadata(struct dentry *ecryptfs_dentry);
588int ecryptfs_read_metadata(struct dentry *ecryptfs_dentry);
Michael Halcrow237fead2006-10-04 02:16:22 -0700589int ecryptfs_new_file_context(struct dentry *ecryptfs_dentry);
Tyler Hicksf4e60e62010-02-11 00:02:32 -0600590void ecryptfs_write_crypt_stat_flags(char *page_virt,
591 struct ecryptfs_crypt_stat *crypt_stat,
592 size_t *written);
Tyler Hicks778aeb42011-05-24 04:56:23 -0500593int ecryptfs_read_and_validate_header_region(struct inode *inode);
594int ecryptfs_read_and_validate_xattr_region(struct dentry *dentry,
Tyler Hicks3b06b3e2011-05-24 03:49:02 -0500595 struct inode *inode);
Michael Halcrow9c79f342009-01-06 14:41:57 -0800596u8 ecryptfs_code_for_cipher_string(char *cipher_name, size_t key_bytes);
Trevor Highland19e66a62008-02-06 01:38:36 -0800597int ecryptfs_cipher_code_to_string(char *str, u8 cipher_code);
Michael Halcrow237fead2006-10-04 02:16:22 -0700598void 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);
Michael Halcrow237fead2006-10-04 02:16:22 -0700603int
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);
Michael Halcrowd7cdc5f2007-10-16 01:28:10 -0700607ssize_t
608ecryptfs_getxattr_lower(struct dentry *lower_dentry, const char *name,
609 void *value, size_t size);
Michael Halcrowdd2a3b72007-02-12 00:53:46 -0800610int
611ecryptfs_setxattr(struct dentry *dentry, const char *name, const void *value,
612 size_t size, int flags);
Michael Halcrowd7cdc5f2007-10-16 01:28:10 -0700613int ecryptfs_read_xattr_region(char *page_virt, struct inode *ecryptfs_inode);
Tyler Hicks624ae522008-10-15 22:02:51 -0700614int ecryptfs_process_helo(uid_t euid, struct user_namespace *user_ns,
615 struct pid *pid);
Michael Halcrow6a3fd922008-04-29 00:59:52 -0700616int 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);
Tyler Hicks624ae522008-10-15 22:02:51 -0700621int ecryptfs_send_message(char *data, int data_len,
Michael Halcrow88b4a072007-02-12 00:53:43 -0800622 struct ecryptfs_msg_ctx **msg_ctx);
623int ecryptfs_wait_for_response(struct ecryptfs_msg_ctx *msg_ctx,
624 struct ecryptfs_message **emsg);
Tyler Hicks624ae522008-10-15 22:02:51 -0700625int ecryptfs_init_messaging(void);
626void ecryptfs_release_messaging(void);
Michael Halcrow88b4a072007-02-12 00:53:43 -0800627
Michael Halcrowe77a56d2007-02-12 00:53:47 -0800628void
629ecryptfs_write_header_metadata(char *virt,
630 struct ecryptfs_crypt_stat *crypt_stat,
631 size_t *written);
Michael Halcrowf4aad162007-10-16 01:27:53 -0700632int 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,
Tyler Hicks84814d62009-03-13 13:51:59 -0700635 char *sig, u32 global_auth_tok_flags);
Michael Halcrowf4aad162007-10-16 01:27:53 -0700636int 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);
Michael Halcrowfcd12832007-10-16 01:28:01 -0700643int ecryptfs_destroy_crypto(void);
Eric Sandeenaf440f52008-02-06 01:38:37 -0800644int ecryptfs_tfm_exists(char *cipher_name, struct ecryptfs_key_tfm **key_tfm);
Michael Halcrowf4aad162007-10-16 01:27:53 -0700645int 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);
Michael Halcrowda0102a2007-10-16 01:28:07 -0700651int 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);
Al Viro48c1e442010-05-21 11:09:58 -0400656int ecryptfs_write(struct inode *inode, char *data, loff_t offset, size_t size);
Michael Halcrowda0102a2007-10-16 01:28:07 -0700657int 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);
Al Viro02bd9792010-05-21 11:02:14 -0400663struct page *ecryptfs_get_locked_page(struct inode *inode, loff_t index);
Michael Halcrowf66e8832008-04-29 00:59:51 -0700664int ecryptfs_exorcise_daemon(struct ecryptfs_daemon *daemon);
Michael Halcrow6a3fd922008-04-29 00:59:52 -0700665int ecryptfs_find_daemon_by_euid(struct ecryptfs_daemon **daemon, uid_t euid,
666 struct user_namespace *user_ns);
Michael Halcrowf66e8832008-04-29 00:59:51 -0700667int 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
Michael Halcrow6a3fd922008-04-29 00:59:52 -0700678ecryptfs_spawn_daemon(struct ecryptfs_daemon **daemon, uid_t euid,
679 struct user_namespace *user_ns, struct pid *pid);
Michael Halcrow746f1e52008-07-23 21:30:02 -0700680int ecryptfs_init_kthread(void);
681void ecryptfs_destroy_kthread(void);
682int ecryptfs_privileged_open(struct file **lower_file,
683 struct dentry *lower_dentry,
David Howells745ca242008-11-14 10:39:22 +1100684 struct vfsmount *lower_mnt,
685 const struct cred *cred);
Tyler Hicks3b06b3e2011-05-24 03:49:02 -0500686int ecryptfs_get_lower_file(struct dentry *dentry, struct inode *inode);
Tyler Hicks332ab162011-04-14 15:35:11 -0500687void ecryptfs_put_lower_file(struct inode *inode);
Michael Halcrow9c79f342009-01-06 14:41:57 -0800688int
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);
Michael Halcrowa34f60f2009-01-06 14:41:58 -0800698int ecryptfs_derive_iv(char *iv, struct ecryptfs_crypt_stat *crypt_stat,
699 loff_t offset);
Michael Halcrow88b4a072007-02-12 00:53:43 -0800700
Michael Halcrow237fead2006-10-04 02:16:22 -0700701#endif /* #ifndef ECRYPTFS_KERNEL_H */