blob: 6ddab6c856ace59cfcb6713e081d2133d7d52e67 [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 Halcrowdd2a3b72007-02-12 00:53:46 -08007 * Copyright (C) 2004-2007 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>
32#include <linux/fs.h>
Josef "Jeff" Sipek0cc72dc2006-12-08 02:36:31 -080033#include <linux/fs_stack.h>
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -080034#include <linux/namei.h>
Michael Halcrow237fead2006-10-04 02:16:22 -070035#include <linux/scatterlist.h>
Michael Halcrowdddfa462007-02-12 00:53:44 -080036#include <linux/hash.h>
Michael Halcrow237fead2006-10-04 02:16:22 -070037
38/* Version verification for shared data structures w/ userspace */
39#define ECRYPTFS_VERSION_MAJOR 0x00
40#define ECRYPTFS_VERSION_MINOR 0x04
Michael Halcrow88b4a072007-02-12 00:53:43 -080041#define ECRYPTFS_SUPPORTED_FILE_VERSION 0x02
Michael Halcrow237fead2006-10-04 02:16:22 -070042/* These flags indicate which features are supported by the kernel
43 * module; userspace tools such as the mount helper read
44 * ECRYPTFS_VERSIONING_MASK from a sysfs handle in order to determine
45 * how to behave. */
Michael Halcrow17398952007-02-12 00:53:45 -080046#define ECRYPTFS_VERSIONING_PASSPHRASE 0x00000001
47#define ECRYPTFS_VERSIONING_PUBKEY 0x00000002
Michael Halcrow237fead2006-10-04 02:16:22 -070048#define ECRYPTFS_VERSIONING_PLAINTEXT_PASSTHROUGH 0x00000004
Michael Halcrow17398952007-02-12 00:53:45 -080049#define ECRYPTFS_VERSIONING_POLICY 0x00000008
50#define ECRYPTFS_VERSIONING_XATTR 0x00000010
Michael Halcrowf4aad162007-10-16 01:27:53 -070051#define ECRYPTFS_VERSIONING_MULTKEY 0x00000020
Michael Halcrow237fead2006-10-04 02:16:22 -070052#define ECRYPTFS_VERSIONING_MASK (ECRYPTFS_VERSIONING_PASSPHRASE \
Michael Halcrow17398952007-02-12 00:53:45 -080053 | ECRYPTFS_VERSIONING_PLAINTEXT_PASSTHROUGH \
Michael Halcrowdd2a3b72007-02-12 00:53:46 -080054 | ECRYPTFS_VERSIONING_PUBKEY \
Michael Halcrowf4aad162007-10-16 01:27:53 -070055 | ECRYPTFS_VERSIONING_XATTR \
56 | ECRYPTFS_VERSIONING_MULTKEY)
Michael Halcrow237fead2006-10-04 02:16:22 -070057#define ECRYPTFS_MAX_PASSWORD_LENGTH 64
58#define ECRYPTFS_MAX_PASSPHRASE_BYTES ECRYPTFS_MAX_PASSWORD_LENGTH
59#define ECRYPTFS_SALT_SIZE 8
60#define ECRYPTFS_SALT_SIZE_HEX (ECRYPTFS_SALT_SIZE*2)
61/* The original signature size is only for what is stored on disk; all
62 * in-memory representations are expanded hex, so it better adapted to
63 * be passed around or referenced on the command line */
64#define ECRYPTFS_SIG_SIZE 8
65#define ECRYPTFS_SIG_SIZE_HEX (ECRYPTFS_SIG_SIZE*2)
66#define ECRYPTFS_PASSWORD_SIG_SIZE ECRYPTFS_SIG_SIZE_HEX
67#define ECRYPTFS_MAX_KEY_BYTES 64
68#define ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES 512
69#define ECRYPTFS_DEFAULT_IV_BYTES 16
Michael Halcrow88b4a072007-02-12 00:53:43 -080070#define ECRYPTFS_FILE_VERSION 0x02
Michael Halcrow237fead2006-10-04 02:16:22 -070071#define ECRYPTFS_DEFAULT_HEADER_EXTENT_SIZE 8192
72#define ECRYPTFS_DEFAULT_EXTENT_SIZE 4096
73#define ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE 8192
Michael Halcrow88b4a072007-02-12 00:53:43 -080074#define ECRYPTFS_DEFAULT_MSG_CTX_ELEMS 32
75#define ECRYPTFS_DEFAULT_SEND_TIMEOUT HZ
76#define ECRYPTFS_MAX_MSG_CTX_TTL (HZ*3)
77#define ECRYPTFS_NLMSG_HELO 100
78#define ECRYPTFS_NLMSG_QUIT 101
79#define ECRYPTFS_NLMSG_REQUEST 102
80#define ECRYPTFS_NLMSG_RESPONSE 103
81#define ECRYPTFS_MAX_PKI_NAME_BYTES 16
82#define ECRYPTFS_DEFAULT_NUM_USERS 4
83#define ECRYPTFS_MAX_NUM_USERS 32768
84#define ECRYPTFS_TRANSPORT_NETLINK 0
85#define ECRYPTFS_TRANSPORT_CONNECTOR 1
86#define ECRYPTFS_TRANSPORT_RELAYFS 2
87#define ECRYPTFS_DEFAULT_TRANSPORT ECRYPTFS_TRANSPORT_NETLINK
Michael Halcrowdd2a3b72007-02-12 00:53:46 -080088#define ECRYPTFS_XATTR_NAME "user.ecryptfs"
Michael Halcrow237fead2006-10-04 02:16:22 -070089
90#define RFC2440_CIPHER_DES3_EDE 0x02
91#define RFC2440_CIPHER_CAST_5 0x03
92#define RFC2440_CIPHER_BLOWFISH 0x04
93#define RFC2440_CIPHER_AES_128 0x07
94#define RFC2440_CIPHER_AES_192 0x08
95#define RFC2440_CIPHER_AES_256 0x09
96#define RFC2440_CIPHER_TWOFISH 0x0a
97#define RFC2440_CIPHER_CAST_6 0x0b
98
Michael Halcrow88b4a072007-02-12 00:53:43 -080099#define RFC2440_CIPHER_RSA 0x01
Michael Halcrow237fead2006-10-04 02:16:22 -0700100
101/**
102 * For convenience, we may need to pass around the encrypted session
103 * key between kernel and userspace because the authentication token
104 * may not be extractable. For example, the TPM may not release the
105 * private key, instead requiring the encrypted data and returning the
106 * decrypted data.
107 */
108struct ecryptfs_session_key {
109#define ECRYPTFS_USERSPACE_SHOULD_TRY_TO_DECRYPT 0x00000001
110#define ECRYPTFS_USERSPACE_SHOULD_TRY_TO_ENCRYPT 0x00000002
111#define ECRYPTFS_CONTAINS_DECRYPTED_KEY 0x00000004
112#define ECRYPTFS_CONTAINS_ENCRYPTED_KEY 0x00000008
113 u32 flags;
114 u32 encrypted_key_size;
115 u32 decrypted_key_size;
116 u8 encrypted_key[ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES];
117 u8 decrypted_key[ECRYPTFS_MAX_KEY_BYTES];
118};
119
120struct ecryptfs_password {
121 u32 password_bytes;
122 s32 hash_algo;
123 u32 hash_iterations;
124 u32 session_key_encryption_key_bytes;
125#define ECRYPTFS_PERSISTENT_PASSWORD 0x01
126#define ECRYPTFS_SESSION_KEY_ENCRYPTION_KEY_SET 0x02
127 u32 flags;
128 /* Iterated-hash concatenation of salt and passphrase */
129 u8 session_key_encryption_key[ECRYPTFS_MAX_KEY_BYTES];
130 u8 signature[ECRYPTFS_PASSWORD_SIG_SIZE + 1];
131 /* Always in expanded hex */
132 u8 salt[ECRYPTFS_SALT_SIZE];
133};
134
135enum ecryptfs_token_types {ECRYPTFS_PASSWORD, ECRYPTFS_PRIVATE_KEY};
136
Michael Halcrow88b4a072007-02-12 00:53:43 -0800137struct ecryptfs_private_key {
138 u32 key_size;
139 u32 data_len;
140 u8 signature[ECRYPTFS_PASSWORD_SIG_SIZE + 1];
141 char pki_type[ECRYPTFS_MAX_PKI_NAME_BYTES + 1];
142 u8 data[];
143};
144
Michael Halcrow237fead2006-10-04 02:16:22 -0700145/* May be a password or a private key */
146struct ecryptfs_auth_tok {
147 u16 version; /* 8-bit major and 8-bit minor */
148 u16 token_type;
Michael Halcrowf4aad162007-10-16 01:27:53 -0700149#define ECRYPTFS_ENCRYPT_ONLY 0x00000001
Michael Halcrow237fead2006-10-04 02:16:22 -0700150 u32 flags;
151 struct ecryptfs_session_key session_key;
152 u8 reserved[32];
153 union {
154 struct ecryptfs_password password;
Michael Halcrow88b4a072007-02-12 00:53:43 -0800155 struct ecryptfs_private_key private_key;
Michael Halcrow237fead2006-10-04 02:16:22 -0700156 } token;
157} __attribute__ ((packed));
158
Michael Halcrowf4aad162007-10-16 01:27:53 -0700159int ecryptfs_get_auth_tok_sig(char **sig, struct ecryptfs_auth_tok *auth_tok);
Michael Halcrow237fead2006-10-04 02:16:22 -0700160void ecryptfs_dump_auth_tok(struct ecryptfs_auth_tok *auth_tok);
161extern void ecryptfs_to_hex(char *dst, char *src, size_t src_size);
162extern void ecryptfs_from_hex(char *dst, char *src, int dst_size);
163
164struct ecryptfs_key_record {
165 unsigned char type;
166 size_t enc_key_size;
167 unsigned char sig[ECRYPTFS_SIG_SIZE];
168 unsigned char enc_key[ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES];
169};
170
171struct ecryptfs_auth_tok_list {
172 struct ecryptfs_auth_tok *auth_tok;
173 struct list_head list;
174};
175
176struct ecryptfs_crypt_stat;
177struct ecryptfs_mount_crypt_stat;
178
179struct ecryptfs_page_crypt_context {
180 struct page *page;
181#define ECRYPTFS_PREPARE_COMMIT_MODE 0
182#define ECRYPTFS_WRITEPAGE_MODE 1
183 unsigned int mode;
184 union {
185 struct file *lower_file;
186 struct writeback_control *wbc;
187 } param;
188};
189
190static inline struct ecryptfs_auth_tok *
191ecryptfs_get_key_payload_data(struct key *key)
192{
193 return (struct ecryptfs_auth_tok *)
194 (((struct user_key_payload*)key->payload.data)->data);
195}
196
197#define ECRYPTFS_SUPER_MAGIC 0xf15f
198#define ECRYPTFS_MAX_KEYSET_SIZE 1024
199#define ECRYPTFS_MAX_CIPHER_NAME_SIZE 32
200#define ECRYPTFS_MAX_NUM_ENC_KEYS 64
Michael Halcrow237fead2006-10-04 02:16:22 -0700201#define ECRYPTFS_MAX_IV_BYTES 16 /* 128 bits */
202#define ECRYPTFS_SALT_BYTES 2
203#define MAGIC_ECRYPTFS_MARKER 0x3c81b7f5
204#define MAGIC_ECRYPTFS_MARKER_SIZE_BYTES 8 /* 4*2 */
205#define ECRYPTFS_FILE_SIZE_BYTES 8
206#define ECRYPTFS_DEFAULT_CIPHER "aes"
207#define ECRYPTFS_DEFAULT_KEY_BYTES 16
Michael Halcrow565d9722006-10-30 22:07:17 -0800208#define ECRYPTFS_DEFAULT_HASH "md5"
Michael Halcrow88b4a072007-02-12 00:53:43 -0800209#define ECRYPTFS_TAG_1_PACKET_TYPE 0x01
Michael Halcrow237fead2006-10-04 02:16:22 -0700210#define ECRYPTFS_TAG_3_PACKET_TYPE 0x8C
211#define ECRYPTFS_TAG_11_PACKET_TYPE 0xED
Michael Halcrow88b4a072007-02-12 00:53:43 -0800212#define ECRYPTFS_TAG_64_PACKET_TYPE 0x40
213#define ECRYPTFS_TAG_65_PACKET_TYPE 0x41
214#define ECRYPTFS_TAG_66_PACKET_TYPE 0x42
215#define ECRYPTFS_TAG_67_PACKET_TYPE 0x43
Michael Halcrow237fead2006-10-04 02:16:22 -0700216#define MD5_DIGEST_SIZE 16
217
Michael Halcrowf4aad162007-10-16 01:27:53 -0700218struct ecryptfs_key_sig {
219 struct list_head crypt_stat_list;
220 char keysig[ECRYPTFS_SIG_SIZE_HEX];
221};
222
Michael Halcrow237fead2006-10-04 02:16:22 -0700223/**
224 * This is the primary struct associated with each encrypted file.
225 *
226 * TODO: cache align/pack?
227 */
228struct ecryptfs_crypt_stat {
229#define ECRYPTFS_STRUCT_INITIALIZED 0x00000001
230#define ECRYPTFS_POLICY_APPLIED 0x00000002
231#define ECRYPTFS_NEW_FILE 0x00000004
232#define ECRYPTFS_ENCRYPTED 0x00000008
233#define ECRYPTFS_SECURITY_WARNING 0x00000010
234#define ECRYPTFS_ENABLE_HMAC 0x00000020
235#define ECRYPTFS_ENCRYPT_IV_PAGES 0x00000040
236#define ECRYPTFS_KEY_VALID 0x00000080
Michael Halcrow17398952007-02-12 00:53:45 -0800237#define ECRYPTFS_METADATA_IN_XATTR 0x00000100
238#define ECRYPTFS_VIEW_AS_ENCRYPTED 0x00000200
Michael Halcrow237fead2006-10-04 02:16:22 -0700239 u32 flags;
240 unsigned int file_version;
241 size_t iv_bytes;
Michael Halcrow237fead2006-10-04 02:16:22 -0700242 size_t header_extent_size;
243 size_t num_header_extents_at_front;
244 size_t extent_size; /* Data extent size; default is 4096 */
245 size_t key_size;
246 size_t extent_shift;
247 unsigned int extent_mask;
248 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
Michael Halcrow8bba0662006-10-30 22:07:18 -0800249 struct crypto_blkcipher *tfm;
Michael Halcrow565d9722006-10-30 22:07:17 -0800250 struct crypto_hash *hash_tfm; /* Crypto context for generating
251 * the initialization vectors */
Michael Halcrow237fead2006-10-04 02:16:22 -0700252 unsigned char cipher[ECRYPTFS_MAX_CIPHER_NAME_SIZE];
253 unsigned char key[ECRYPTFS_MAX_KEY_BYTES];
254 unsigned char root_iv[ECRYPTFS_MAX_IV_BYTES];
Michael Halcrowf4aad162007-10-16 01:27:53 -0700255 struct list_head keysig_list;
256 struct mutex keysig_list_mutex;
Michael Halcrow237fead2006-10-04 02:16:22 -0700257 struct mutex cs_tfm_mutex;
Michael Halcrow565d9722006-10-30 22:07:17 -0800258 struct mutex cs_hash_tfm_mutex;
Michael Halcrow237fead2006-10-04 02:16:22 -0700259 struct mutex cs_mutex;
260};
261
262/* inode private data. */
263struct ecryptfs_inode_info {
264 struct inode vfs_inode;
265 struct inode *wii_inode;
266 struct ecryptfs_crypt_stat crypt_stat;
267};
268
269/* dentry private data. Each dentry must keep track of a lower
270 * vfsmount too. */
271struct ecryptfs_dentry_info {
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -0800272 struct path lower_path;
Michael Halcrow237fead2006-10-04 02:16:22 -0700273 struct ecryptfs_crypt_stat *crypt_stat;
274};
275
Michael Halcrowf4aad162007-10-16 01:27:53 -0700276struct ecryptfs_global_auth_tok {
277#define ECRYPTFS_AUTH_TOK_INVALID 0x00000001
278 u32 flags;
279 struct list_head mount_crypt_stat_list;
280 struct key *global_auth_tok_key;
281 struct ecryptfs_auth_tok *global_auth_tok;
282 unsigned char sig[ECRYPTFS_SIG_SIZE_HEX + 1];
283};
284
285struct ecryptfs_key_tfm {
286 struct crypto_blkcipher *key_tfm;
287 size_t key_size;
288 struct mutex key_tfm_mutex;
289 struct list_head key_tfm_list;
290 unsigned char cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE + 1];
291};
292
293extern struct list_head key_tfm_list;
294extern 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 Halcrow237fead2006-10-04 02:16:22 -0700308 u32 flags;
Michael Halcrowf4aad162007-10-16 01:27:53 -0700309 struct list_head global_auth_tok_list;
310 struct mutex global_auth_tok_list_mutex;
311 size_t num_global_auth_toks;
Michael Halcrow237fead2006-10-04 02:16:22 -0700312 size_t global_default_cipher_key_size;
Michael Halcrow237fead2006-10-04 02:16:22 -0700313 unsigned char global_default_cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE
314 + 1];
Michael Halcrow237fead2006-10-04 02:16:22 -0700315};
316
317/* superblock private data. */
318struct ecryptfs_sb_info {
319 struct super_block *wsi_sb;
320 struct ecryptfs_mount_crypt_stat mount_crypt_stat;
321};
322
323/* file private data. */
324struct ecryptfs_file_info {
325 struct file *wfi_file;
326 struct ecryptfs_crypt_stat *crypt_stat;
327};
328
329/* auth_tok <=> encrypted_session_key mappings */
330struct ecryptfs_auth_tok_list_item {
331 unsigned char encrypted_session_key[ECRYPTFS_MAX_KEY_BYTES];
332 struct list_head list;
333 struct ecryptfs_auth_tok auth_tok;
334};
335
Michael Halcrow88b4a072007-02-12 00:53:43 -0800336struct ecryptfs_message {
337 u32 index;
338 u32 data_len;
339 u8 data[];
340};
341
342struct ecryptfs_msg_ctx {
343#define ECRYPTFS_MSG_CTX_STATE_FREE 0x0001
344#define ECRYPTFS_MSG_CTX_STATE_PENDING 0x0002
345#define ECRYPTFS_MSG_CTX_STATE_DONE 0x0003
346 u32 state;
347 unsigned int index;
348 unsigned int counter;
349 struct ecryptfs_message *msg;
350 struct task_struct *task;
351 struct list_head node;
352 struct mutex mux;
353};
354
Michael Halcrow88b4a072007-02-12 00:53:43 -0800355extern unsigned int ecryptfs_transport;
356
357struct ecryptfs_daemon_id {
358 pid_t pid;
359 uid_t uid;
360 struct hlist_node id_chain;
361};
362
Michael Halcrow237fead2006-10-04 02:16:22 -0700363static inline struct ecryptfs_file_info *
364ecryptfs_file_to_private(struct file *file)
365{
366 return (struct ecryptfs_file_info *)file->private_data;
367}
368
369static inline void
370ecryptfs_set_file_private(struct file *file,
371 struct ecryptfs_file_info *file_info)
372{
373 file->private_data = file_info;
374}
375
376static inline struct file *ecryptfs_file_to_lower(struct file *file)
377{
378 return ((struct ecryptfs_file_info *)file->private_data)->wfi_file;
379}
380
381static inline void
382ecryptfs_set_file_lower(struct file *file, struct file *lower_file)
383{
384 ((struct ecryptfs_file_info *)file->private_data)->wfi_file =
385 lower_file;
386}
387
388static inline struct ecryptfs_inode_info *
389ecryptfs_inode_to_private(struct inode *inode)
390{
391 return container_of(inode, struct ecryptfs_inode_info, vfs_inode);
392}
393
394static inline struct inode *ecryptfs_inode_to_lower(struct inode *inode)
395{
396 return ecryptfs_inode_to_private(inode)->wii_inode;
397}
398
399static inline void
400ecryptfs_set_inode_lower(struct inode *inode, struct inode *lower_inode)
401{
402 ecryptfs_inode_to_private(inode)->wii_inode = lower_inode;
403}
404
405static inline struct ecryptfs_sb_info *
406ecryptfs_superblock_to_private(struct super_block *sb)
407{
408 return (struct ecryptfs_sb_info *)sb->s_fs_info;
409}
410
411static inline void
412ecryptfs_set_superblock_private(struct super_block *sb,
413 struct ecryptfs_sb_info *sb_info)
414{
415 sb->s_fs_info = sb_info;
416}
417
418static inline struct super_block *
419ecryptfs_superblock_to_lower(struct super_block *sb)
420{
421 return ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb;
422}
423
424static inline void
425ecryptfs_set_superblock_lower(struct super_block *sb,
426 struct super_block *lower_sb)
427{
428 ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb = lower_sb;
429}
430
431static inline struct ecryptfs_dentry_info *
432ecryptfs_dentry_to_private(struct dentry *dentry)
433{
434 return (struct ecryptfs_dentry_info *)dentry->d_fsdata;
435}
436
437static inline void
438ecryptfs_set_dentry_private(struct dentry *dentry,
439 struct ecryptfs_dentry_info *dentry_info)
440{
441 dentry->d_fsdata = dentry_info;
442}
443
444static inline struct dentry *
445ecryptfs_dentry_to_lower(struct dentry *dentry)
446{
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -0800447 return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry;
Michael Halcrow237fead2006-10-04 02:16:22 -0700448}
449
450static inline void
451ecryptfs_set_dentry_lower(struct dentry *dentry, struct dentry *lower_dentry)
452{
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -0800453 ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry =
Michael Halcrow237fead2006-10-04 02:16:22 -0700454 lower_dentry;
455}
456
457static inline struct vfsmount *
458ecryptfs_dentry_to_lower_mnt(struct dentry *dentry)
459{
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -0800460 return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt;
Michael Halcrow237fead2006-10-04 02:16:22 -0700461}
462
463static inline void
464ecryptfs_set_dentry_lower_mnt(struct dentry *dentry, struct vfsmount *lower_mnt)
465{
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -0800466 ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt =
Michael Halcrow237fead2006-10-04 02:16:22 -0700467 lower_mnt;
468}
469
470#define ecryptfs_printk(type, fmt, arg...) \
471 __ecryptfs_printk(type "%s: " fmt, __FUNCTION__, ## arg);
472void __ecryptfs_printk(const char *fmt, ...);
473
474extern const struct file_operations ecryptfs_main_fops;
475extern const struct file_operations ecryptfs_dir_fops;
Arjan van de Ven754661f2007-02-12 00:55:38 -0800476extern const struct inode_operations ecryptfs_main_iops;
477extern const struct inode_operations ecryptfs_dir_iops;
478extern const struct inode_operations ecryptfs_symlink_iops;
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -0800479extern const struct super_operations ecryptfs_sops;
Michael Halcrow237fead2006-10-04 02:16:22 -0700480extern struct dentry_operations ecryptfs_dops;
481extern struct address_space_operations ecryptfs_aops;
482extern int ecryptfs_verbosity;
Michael Halcrow88b4a072007-02-12 00:53:43 -0800483extern unsigned int ecryptfs_message_buf_len;
484extern signed long ecryptfs_message_wait_timeout;
485extern unsigned int ecryptfs_number_of_users;
Michael Halcrow237fead2006-10-04 02:16:22 -0700486
487extern struct kmem_cache *ecryptfs_auth_tok_list_item_cache;
488extern struct kmem_cache *ecryptfs_file_info_cache;
489extern struct kmem_cache *ecryptfs_dentry_info_cache;
490extern struct kmem_cache *ecryptfs_inode_info_cache;
491extern struct kmem_cache *ecryptfs_sb_info_cache;
492extern struct kmem_cache *ecryptfs_header_cache_0;
493extern struct kmem_cache *ecryptfs_header_cache_1;
494extern struct kmem_cache *ecryptfs_header_cache_2;
Michael Halcrowdd2a3b72007-02-12 00:53:46 -0800495extern struct kmem_cache *ecryptfs_xattr_cache;
Michael Halcrow237fead2006-10-04 02:16:22 -0700496extern struct kmem_cache *ecryptfs_lower_page_cache;
Michael Halcroweb95e7f2007-02-16 01:28:40 -0800497extern struct kmem_cache *ecryptfs_key_record_cache;
Michael Halcrowf4aad162007-10-16 01:27:53 -0700498extern struct kmem_cache *ecryptfs_key_sig_cache;
499extern struct kmem_cache *ecryptfs_global_auth_tok_cache;
500extern struct kmem_cache *ecryptfs_key_tfm_cache;
Michael Halcrow237fead2006-10-04 02:16:22 -0700501
502int ecryptfs_interpose(struct dentry *hidden_dentry,
503 struct dentry *this_dentry, struct super_block *sb,
504 int flag);
505int ecryptfs_fill_zeros(struct file *file, loff_t new_length);
506int ecryptfs_decode_filename(struct ecryptfs_crypt_stat *crypt_stat,
507 const char *name, int length,
508 char **decrypted_name);
509int ecryptfs_encode_filename(struct ecryptfs_crypt_stat *crypt_stat,
510 const char *name, int length,
511 char **encoded_name);
512struct dentry *ecryptfs_lower_dentry(struct dentry *this_dentry);
Michael Halcrow237fead2006-10-04 02:16:22 -0700513void ecryptfs_dump_hex(char *data, int bytes);
514int virt_to_scatterlist(const void *addr, int size, struct scatterlist *sg,
515 int sg_size);
516int ecryptfs_compute_root_iv(struct ecryptfs_crypt_stat *crypt_stat);
517void ecryptfs_rotate_iv(unsigned char *iv);
518void ecryptfs_init_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
519void ecryptfs_destruct_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
520void ecryptfs_destruct_mount_crypt_stat(
521 struct ecryptfs_mount_crypt_stat *mount_crypt_stat);
522int ecryptfs_init_crypt_ctx(struct ecryptfs_crypt_stat *crypt_stat);
Michael Halcrow8bba0662006-10-30 22:07:18 -0800523int ecryptfs_crypto_api_algify_cipher_name(char **algified_name,
524 char *cipher_name,
525 char *chaining_modifier);
Michael Halcrowdd2a3b72007-02-12 00:53:46 -0800526#define ECRYPTFS_LOWER_I_MUTEX_NOT_HELD 0
527#define ECRYPTFS_LOWER_I_MUTEX_HELD 1
528int ecryptfs_write_inode_size_to_metadata(struct file *lower_file,
529 struct inode *lower_inode,
530 struct inode *inode,
531 struct dentry *ecryptfs_dentry,
532 int lower_i_mutex_held);
Michael Halcrow237fead2006-10-04 02:16:22 -0700533int ecryptfs_get_lower_page(struct page **lower_page, struct inode *lower_inode,
534 struct file *lower_file,
535 unsigned long lower_page_index, int byte_offset,
536 int region_bytes);
537int
538ecryptfs_commit_lower_page(struct page *lower_page, struct inode *lower_inode,
539 struct file *lower_file, int byte_offset,
540 int region_size);
541int ecryptfs_copy_page_to_lower(struct page *page, struct inode *lower_inode,
542 struct file *lower_file);
543int ecryptfs_do_readpage(struct file *file, struct page *page,
544 pgoff_t lower_page_index);
Michael Halcrow237fead2006-10-04 02:16:22 -0700545int ecryptfs_writepage_and_release_lower_page(struct page *lower_page,
546 struct inode *lower_inode,
547 struct writeback_control *wbc);
548int ecryptfs_encrypt_page(struct ecryptfs_page_crypt_context *ctx);
549int ecryptfs_decrypt_page(struct file *file, struct page *page);
Michael Halcrowdd2a3b72007-02-12 00:53:46 -0800550int ecryptfs_write_metadata(struct dentry *ecryptfs_dentry,
551 struct file *lower_file);
552int ecryptfs_read_metadata(struct dentry *ecryptfs_dentry,
Michael Halcrow237fead2006-10-04 02:16:22 -0700553 struct file *lower_file);
Michael Halcrow237fead2006-10-04 02:16:22 -0700554int ecryptfs_new_file_context(struct dentry *ecryptfs_dentry);
Michael Halcrowdd2a3b72007-02-12 00:53:46 -0800555int ecryptfs_read_and_validate_header_region(char *data, struct dentry *dentry,
556 struct vfsmount *mnt);
557int ecryptfs_read_and_validate_xattr_region(char *page_virt,
558 struct dentry *ecryptfs_dentry);
Michael Halcrow237fead2006-10-04 02:16:22 -0700559u16 ecryptfs_code_for_cipher_string(struct ecryptfs_crypt_stat *crypt_stat);
560int ecryptfs_cipher_code_to_string(char *str, u16 cipher_code);
561void ecryptfs_set_default_sizes(struct ecryptfs_crypt_stat *crypt_stat);
562int ecryptfs_generate_key_packet_set(char *dest_base,
563 struct ecryptfs_crypt_stat *crypt_stat,
564 struct dentry *ecryptfs_dentry,
565 size_t *len, size_t max);
566int process_request_key_err(long err_code);
567int
568ecryptfs_parse_packet_set(struct ecryptfs_crypt_stat *crypt_stat,
569 unsigned char *src, struct dentry *ecryptfs_dentry);
570int ecryptfs_truncate(struct dentry *dentry, loff_t new_length);
Michael Halcrowf4aad162007-10-16 01:27:53 -0700571int ecryptfs_process_key_cipher(struct crypto_blkcipher **key_tfm,
572 char *cipher_name, size_t *key_size);
Michael Halcrow237fead2006-10-04 02:16:22 -0700573int ecryptfs_inode_test(struct inode *inode, void *candidate_lower_inode);
574int ecryptfs_inode_set(struct inode *inode, void *lower_inode);
575void ecryptfs_init_inode(struct inode *inode, struct inode *lower_inode);
Michael Halcrow7ff1d742006-10-30 22:07:19 -0800576int ecryptfs_open_lower_file(struct file **lower_file,
577 struct dentry *lower_dentry,
578 struct vfsmount *lower_mnt, int flags);
579int ecryptfs_close_lower_file(struct file *lower_file);
Michael Halcrowdd2a3b72007-02-12 00:53:46 -0800580ssize_t ecryptfs_getxattr(struct dentry *dentry, const char *name, void *value,
581 size_t size);
582int
583ecryptfs_setxattr(struct dentry *dentry, const char *name, const void *value,
584 size_t size, int flags);
Michael Halcrowe77a56d2007-02-12 00:53:47 -0800585int ecryptfs_read_xattr_region(char *page_virt, struct dentry *ecryptfs_dentry);
Michael Halcrow88b4a072007-02-12 00:53:43 -0800586int ecryptfs_process_helo(unsigned int transport, uid_t uid, pid_t pid);
587int ecryptfs_process_quit(uid_t uid, pid_t pid);
Michael Halcrowdddfa462007-02-12 00:53:44 -0800588int ecryptfs_process_response(struct ecryptfs_message *msg, uid_t uid,
589 pid_t pid, u32 seq);
Michael Halcrow88b4a072007-02-12 00:53:43 -0800590int ecryptfs_send_message(unsigned int transport, char *data, int data_len,
591 struct ecryptfs_msg_ctx **msg_ctx);
592int ecryptfs_wait_for_response(struct ecryptfs_msg_ctx *msg_ctx,
593 struct ecryptfs_message **emsg);
594int ecryptfs_init_messaging(unsigned int transport);
595void ecryptfs_release_messaging(unsigned int transport);
596
597int ecryptfs_send_netlink(char *data, int data_len,
598 struct ecryptfs_msg_ctx *msg_ctx, u16 msg_type,
599 u16 msg_flags, pid_t daemon_pid);
600int ecryptfs_init_netlink(void);
601void ecryptfs_release_netlink(void);
602
603int ecryptfs_send_connector(char *data, int data_len,
604 struct ecryptfs_msg_ctx *msg_ctx, u16 msg_type,
605 u16 msg_flags, pid_t daemon_pid);
606int ecryptfs_init_connector(void);
607void ecryptfs_release_connector(void);
Michael Halcrowe77a56d2007-02-12 00:53:47 -0800608void
609ecryptfs_write_header_metadata(char *virt,
610 struct ecryptfs_crypt_stat *crypt_stat,
611 size_t *written);
Michael Halcrowf4aad162007-10-16 01:27:53 -0700612int ecryptfs_add_keysig(struct ecryptfs_crypt_stat *crypt_stat, char *sig);
613int
614ecryptfs_add_global_auth_tok(struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
615 char *sig);
616int ecryptfs_get_global_auth_tok_for_sig(
617 struct ecryptfs_global_auth_tok **global_auth_tok,
618 struct ecryptfs_mount_crypt_stat *mount_crypt_stat, char *sig);
619int
620ecryptfs_add_new_key_tfm(struct ecryptfs_key_tfm **key_tfm, char *cipher_name,
621 size_t key_size);
622int ecryptfs_init_crypto(void);
623int ecryptfs_destruct_crypto(void);
624int ecryptfs_get_tfm_and_mutex_for_cipher_name(struct crypto_blkcipher **tfm,
625 struct mutex **tfm_mutex,
626 char *cipher_name);
627int ecryptfs_keyring_auth_tok_for_sig(struct key **auth_tok_key,
628 struct ecryptfs_auth_tok **auth_tok,
629 char *sig);
Michael Halcrow240e2df2007-06-27 14:09:44 -0700630int ecryptfs_write_zeros(struct file *file, pgoff_t index, int start,
631 int num_zeros);
Michael Halcrow88b4a072007-02-12 00:53:43 -0800632
Michael Halcrow237fead2006-10-04 02:16:22 -0700633#endif /* #ifndef ECRYPTFS_KERNEL_H */