blob: 1b9dd9a96f190b08279cb118a2cad75ecf0b67cd [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 Halcrow237fead2006-10-04 02:16:22 -070051#define ECRYPTFS_VERSIONING_MASK (ECRYPTFS_VERSIONING_PASSPHRASE \
Michael Halcrow17398952007-02-12 00:53:45 -080052 | ECRYPTFS_VERSIONING_PLAINTEXT_PASSTHROUGH \
Michael Halcrowdd2a3b72007-02-12 00:53:46 -080053 | ECRYPTFS_VERSIONING_PUBKEY \
54 | ECRYPTFS_VERSIONING_XATTR)
Michael Halcrow237fead2006-10-04 02:16:22 -070055#define ECRYPTFS_MAX_PASSWORD_LENGTH 64
56#define ECRYPTFS_MAX_PASSPHRASE_BYTES ECRYPTFS_MAX_PASSWORD_LENGTH
57#define ECRYPTFS_SALT_SIZE 8
58#define ECRYPTFS_SALT_SIZE_HEX (ECRYPTFS_SALT_SIZE*2)
59/* The original signature size is only for what is stored on disk; all
60 * in-memory representations are expanded hex, so it better adapted to
61 * be passed around or referenced on the command line */
62#define ECRYPTFS_SIG_SIZE 8
63#define ECRYPTFS_SIG_SIZE_HEX (ECRYPTFS_SIG_SIZE*2)
64#define ECRYPTFS_PASSWORD_SIG_SIZE ECRYPTFS_SIG_SIZE_HEX
65#define ECRYPTFS_MAX_KEY_BYTES 64
66#define ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES 512
67#define ECRYPTFS_DEFAULT_IV_BYTES 16
Michael Halcrow88b4a072007-02-12 00:53:43 -080068#define ECRYPTFS_FILE_VERSION 0x02
Michael Halcrow237fead2006-10-04 02:16:22 -070069#define ECRYPTFS_DEFAULT_HEADER_EXTENT_SIZE 8192
70#define ECRYPTFS_DEFAULT_EXTENT_SIZE 4096
71#define ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE 8192
Michael Halcrow88b4a072007-02-12 00:53:43 -080072#define ECRYPTFS_DEFAULT_MSG_CTX_ELEMS 32
73#define ECRYPTFS_DEFAULT_SEND_TIMEOUT HZ
74#define ECRYPTFS_MAX_MSG_CTX_TTL (HZ*3)
75#define ECRYPTFS_NLMSG_HELO 100
76#define ECRYPTFS_NLMSG_QUIT 101
77#define ECRYPTFS_NLMSG_REQUEST 102
78#define ECRYPTFS_NLMSG_RESPONSE 103
79#define ECRYPTFS_MAX_PKI_NAME_BYTES 16
80#define ECRYPTFS_DEFAULT_NUM_USERS 4
81#define ECRYPTFS_MAX_NUM_USERS 32768
82#define ECRYPTFS_TRANSPORT_NETLINK 0
83#define ECRYPTFS_TRANSPORT_CONNECTOR 1
84#define ECRYPTFS_TRANSPORT_RELAYFS 2
85#define ECRYPTFS_DEFAULT_TRANSPORT ECRYPTFS_TRANSPORT_NETLINK
Michael Halcrowdd2a3b72007-02-12 00:53:46 -080086#define ECRYPTFS_XATTR_NAME "user.ecryptfs"
Michael Halcrow237fead2006-10-04 02:16:22 -070087
88#define RFC2440_CIPHER_DES3_EDE 0x02
89#define RFC2440_CIPHER_CAST_5 0x03
90#define RFC2440_CIPHER_BLOWFISH 0x04
91#define RFC2440_CIPHER_AES_128 0x07
92#define RFC2440_CIPHER_AES_192 0x08
93#define RFC2440_CIPHER_AES_256 0x09
94#define RFC2440_CIPHER_TWOFISH 0x0a
95#define RFC2440_CIPHER_CAST_6 0x0b
96
Michael Halcrow88b4a072007-02-12 00:53:43 -080097#define RFC2440_CIPHER_RSA 0x01
Michael Halcrow237fead2006-10-04 02:16:22 -070098
99/**
100 * For convenience, we may need to pass around the encrypted session
101 * key between kernel and userspace because the authentication token
102 * may not be extractable. For example, the TPM may not release the
103 * private key, instead requiring the encrypted data and returning the
104 * decrypted data.
105 */
106struct ecryptfs_session_key {
107#define ECRYPTFS_USERSPACE_SHOULD_TRY_TO_DECRYPT 0x00000001
108#define ECRYPTFS_USERSPACE_SHOULD_TRY_TO_ENCRYPT 0x00000002
109#define ECRYPTFS_CONTAINS_DECRYPTED_KEY 0x00000004
110#define ECRYPTFS_CONTAINS_ENCRYPTED_KEY 0x00000008
111 u32 flags;
112 u32 encrypted_key_size;
113 u32 decrypted_key_size;
114 u8 encrypted_key[ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES];
115 u8 decrypted_key[ECRYPTFS_MAX_KEY_BYTES];
116};
117
118struct ecryptfs_password {
119 u32 password_bytes;
120 s32 hash_algo;
121 u32 hash_iterations;
122 u32 session_key_encryption_key_bytes;
123#define ECRYPTFS_PERSISTENT_PASSWORD 0x01
124#define ECRYPTFS_SESSION_KEY_ENCRYPTION_KEY_SET 0x02
125 u32 flags;
126 /* Iterated-hash concatenation of salt and passphrase */
127 u8 session_key_encryption_key[ECRYPTFS_MAX_KEY_BYTES];
128 u8 signature[ECRYPTFS_PASSWORD_SIG_SIZE + 1];
129 /* Always in expanded hex */
130 u8 salt[ECRYPTFS_SALT_SIZE];
131};
132
133enum ecryptfs_token_types {ECRYPTFS_PASSWORD, ECRYPTFS_PRIVATE_KEY};
134
Michael Halcrow88b4a072007-02-12 00:53:43 -0800135struct ecryptfs_private_key {
136 u32 key_size;
137 u32 data_len;
138 u8 signature[ECRYPTFS_PASSWORD_SIG_SIZE + 1];
139 char pki_type[ECRYPTFS_MAX_PKI_NAME_BYTES + 1];
140 u8 data[];
141};
142
Michael Halcrow237fead2006-10-04 02:16:22 -0700143/* May be a password or a private key */
144struct ecryptfs_auth_tok {
145 u16 version; /* 8-bit major and 8-bit minor */
146 u16 token_type;
147 u32 flags;
148 struct ecryptfs_session_key session_key;
149 u8 reserved[32];
150 union {
151 struct ecryptfs_password password;
Michael Halcrow88b4a072007-02-12 00:53:43 -0800152 struct ecryptfs_private_key private_key;
Michael Halcrow237fead2006-10-04 02:16:22 -0700153 } token;
154} __attribute__ ((packed));
155
156void ecryptfs_dump_auth_tok(struct ecryptfs_auth_tok *auth_tok);
157extern void ecryptfs_to_hex(char *dst, char *src, size_t src_size);
158extern void ecryptfs_from_hex(char *dst, char *src, int dst_size);
159
160struct ecryptfs_key_record {
161 unsigned char type;
162 size_t enc_key_size;
163 unsigned char sig[ECRYPTFS_SIG_SIZE];
164 unsigned char enc_key[ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES];
165};
166
167struct ecryptfs_auth_tok_list {
168 struct ecryptfs_auth_tok *auth_tok;
169 struct list_head list;
170};
171
172struct ecryptfs_crypt_stat;
173struct ecryptfs_mount_crypt_stat;
174
175struct ecryptfs_page_crypt_context {
176 struct page *page;
177#define ECRYPTFS_PREPARE_COMMIT_MODE 0
178#define ECRYPTFS_WRITEPAGE_MODE 1
179 unsigned int mode;
180 union {
181 struct file *lower_file;
182 struct writeback_control *wbc;
183 } param;
184};
185
186static inline struct ecryptfs_auth_tok *
187ecryptfs_get_key_payload_data(struct key *key)
188{
189 return (struct ecryptfs_auth_tok *)
190 (((struct user_key_payload*)key->payload.data)->data);
191}
192
193#define ECRYPTFS_SUPER_MAGIC 0xf15f
194#define ECRYPTFS_MAX_KEYSET_SIZE 1024
195#define ECRYPTFS_MAX_CIPHER_NAME_SIZE 32
196#define ECRYPTFS_MAX_NUM_ENC_KEYS 64
197#define ECRYPTFS_MAX_NUM_KEYSIGS 2 /* TODO: Make this a linked list */
198#define ECRYPTFS_MAX_IV_BYTES 16 /* 128 bits */
199#define ECRYPTFS_SALT_BYTES 2
200#define MAGIC_ECRYPTFS_MARKER 0x3c81b7f5
201#define MAGIC_ECRYPTFS_MARKER_SIZE_BYTES 8 /* 4*2 */
202#define ECRYPTFS_FILE_SIZE_BYTES 8
203#define ECRYPTFS_DEFAULT_CIPHER "aes"
204#define ECRYPTFS_DEFAULT_KEY_BYTES 16
Michael Halcrow565d97242006-10-30 22:07:17 -0800205#define ECRYPTFS_DEFAULT_HASH "md5"
Michael Halcrow88b4a072007-02-12 00:53:43 -0800206#define ECRYPTFS_TAG_1_PACKET_TYPE 0x01
Michael Halcrow237fead2006-10-04 02:16:22 -0700207#define ECRYPTFS_TAG_3_PACKET_TYPE 0x8C
208#define ECRYPTFS_TAG_11_PACKET_TYPE 0xED
Michael Halcrow88b4a072007-02-12 00:53:43 -0800209#define ECRYPTFS_TAG_64_PACKET_TYPE 0x40
210#define ECRYPTFS_TAG_65_PACKET_TYPE 0x41
211#define ECRYPTFS_TAG_66_PACKET_TYPE 0x42
212#define ECRYPTFS_TAG_67_PACKET_TYPE 0x43
Michael Halcrow237fead2006-10-04 02:16:22 -0700213#define MD5_DIGEST_SIZE 16
214
215/**
216 * This is the primary struct associated with each encrypted file.
217 *
218 * TODO: cache align/pack?
219 */
220struct ecryptfs_crypt_stat {
221#define ECRYPTFS_STRUCT_INITIALIZED 0x00000001
222#define ECRYPTFS_POLICY_APPLIED 0x00000002
223#define ECRYPTFS_NEW_FILE 0x00000004
224#define ECRYPTFS_ENCRYPTED 0x00000008
225#define ECRYPTFS_SECURITY_WARNING 0x00000010
226#define ECRYPTFS_ENABLE_HMAC 0x00000020
227#define ECRYPTFS_ENCRYPT_IV_PAGES 0x00000040
228#define ECRYPTFS_KEY_VALID 0x00000080
Michael Halcrow17398952007-02-12 00:53:45 -0800229#define ECRYPTFS_METADATA_IN_XATTR 0x00000100
230#define ECRYPTFS_VIEW_AS_ENCRYPTED 0x00000200
Michael Halcrow237fead2006-10-04 02:16:22 -0700231 u32 flags;
232 unsigned int file_version;
233 size_t iv_bytes;
234 size_t num_keysigs;
235 size_t header_extent_size;
236 size_t num_header_extents_at_front;
237 size_t extent_size; /* Data extent size; default is 4096 */
238 size_t key_size;
239 size_t extent_shift;
240 unsigned int extent_mask;
241 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
Michael Halcrow8bba0662006-10-30 22:07:18 -0800242 struct crypto_blkcipher *tfm;
Michael Halcrow565d97242006-10-30 22:07:17 -0800243 struct crypto_hash *hash_tfm; /* Crypto context for generating
244 * the initialization vectors */
Michael Halcrow237fead2006-10-04 02:16:22 -0700245 unsigned char cipher[ECRYPTFS_MAX_CIPHER_NAME_SIZE];
246 unsigned char key[ECRYPTFS_MAX_KEY_BYTES];
247 unsigned char root_iv[ECRYPTFS_MAX_IV_BYTES];
248 unsigned char keysigs[ECRYPTFS_MAX_NUM_KEYSIGS][ECRYPTFS_SIG_SIZE_HEX];
249 struct mutex cs_tfm_mutex;
Michael Halcrow565d97242006-10-30 22:07:17 -0800250 struct mutex cs_hash_tfm_mutex;
Michael Halcrow237fead2006-10-04 02:16:22 -0700251 struct mutex cs_mutex;
252};
253
254/* inode private data. */
255struct ecryptfs_inode_info {
256 struct inode vfs_inode;
257 struct inode *wii_inode;
258 struct ecryptfs_crypt_stat crypt_stat;
259};
260
261/* dentry private data. Each dentry must keep track of a lower
262 * vfsmount too. */
263struct ecryptfs_dentry_info {
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -0800264 struct path lower_path;
Michael Halcrow237fead2006-10-04 02:16:22 -0700265 struct ecryptfs_crypt_stat *crypt_stat;
266};
267
268/**
269 * This struct is to enable a mount-wide passphrase/salt combo. This
270 * is more or less a stopgap to provide similar functionality to other
271 * crypto filesystems like EncFS or CFS until full policy support is
272 * implemented in eCryptfs.
273 */
274struct ecryptfs_mount_crypt_stat {
275 /* Pointers to memory we do not own, do not free these */
276#define ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED 0x00000001
Michael Halcrow17398952007-02-12 00:53:45 -0800277#define ECRYPTFS_XATTR_METADATA_ENABLED 0x00000002
278#define ECRYPTFS_ENCRYPTED_VIEW_ENABLED 0x00000004
Michael Halcrow237fead2006-10-04 02:16:22 -0700279 u32 flags;
280 struct ecryptfs_auth_tok *global_auth_tok;
281 struct key *global_auth_tok_key;
282 size_t global_default_cipher_key_size;
Michael Halcrow8bba0662006-10-30 22:07:18 -0800283 struct crypto_blkcipher *global_key_tfm;
Michael Halcrow237fead2006-10-04 02:16:22 -0700284 struct mutex global_key_tfm_mutex;
285 unsigned char global_default_cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE
286 + 1];
287 unsigned char global_auth_tok_sig[ECRYPTFS_SIG_SIZE_HEX + 1];
288};
289
290/* superblock private data. */
291struct ecryptfs_sb_info {
292 struct super_block *wsi_sb;
293 struct ecryptfs_mount_crypt_stat mount_crypt_stat;
294};
295
296/* file private data. */
297struct ecryptfs_file_info {
298 struct file *wfi_file;
299 struct ecryptfs_crypt_stat *crypt_stat;
300};
301
302/* auth_tok <=> encrypted_session_key mappings */
303struct ecryptfs_auth_tok_list_item {
304 unsigned char encrypted_session_key[ECRYPTFS_MAX_KEY_BYTES];
305 struct list_head list;
306 struct ecryptfs_auth_tok auth_tok;
307};
308
Michael Halcrow88b4a072007-02-12 00:53:43 -0800309struct ecryptfs_message {
310 u32 index;
311 u32 data_len;
312 u8 data[];
313};
314
315struct ecryptfs_msg_ctx {
316#define ECRYPTFS_MSG_CTX_STATE_FREE 0x0001
317#define ECRYPTFS_MSG_CTX_STATE_PENDING 0x0002
318#define ECRYPTFS_MSG_CTX_STATE_DONE 0x0003
319 u32 state;
320 unsigned int index;
321 unsigned int counter;
322 struct ecryptfs_message *msg;
323 struct task_struct *task;
324 struct list_head node;
325 struct mutex mux;
326};
327
Michael Halcrow88b4a072007-02-12 00:53:43 -0800328extern unsigned int ecryptfs_transport;
329
330struct ecryptfs_daemon_id {
331 pid_t pid;
332 uid_t uid;
333 struct hlist_node id_chain;
334};
335
Michael Halcrow237fead2006-10-04 02:16:22 -0700336static inline struct ecryptfs_file_info *
337ecryptfs_file_to_private(struct file *file)
338{
339 return (struct ecryptfs_file_info *)file->private_data;
340}
341
342static inline void
343ecryptfs_set_file_private(struct file *file,
344 struct ecryptfs_file_info *file_info)
345{
346 file->private_data = file_info;
347}
348
349static inline struct file *ecryptfs_file_to_lower(struct file *file)
350{
351 return ((struct ecryptfs_file_info *)file->private_data)->wfi_file;
352}
353
354static inline void
355ecryptfs_set_file_lower(struct file *file, struct file *lower_file)
356{
357 ((struct ecryptfs_file_info *)file->private_data)->wfi_file =
358 lower_file;
359}
360
361static inline struct ecryptfs_inode_info *
362ecryptfs_inode_to_private(struct inode *inode)
363{
364 return container_of(inode, struct ecryptfs_inode_info, vfs_inode);
365}
366
367static inline struct inode *ecryptfs_inode_to_lower(struct inode *inode)
368{
369 return ecryptfs_inode_to_private(inode)->wii_inode;
370}
371
372static inline void
373ecryptfs_set_inode_lower(struct inode *inode, struct inode *lower_inode)
374{
375 ecryptfs_inode_to_private(inode)->wii_inode = lower_inode;
376}
377
378static inline struct ecryptfs_sb_info *
379ecryptfs_superblock_to_private(struct super_block *sb)
380{
381 return (struct ecryptfs_sb_info *)sb->s_fs_info;
382}
383
384static inline void
385ecryptfs_set_superblock_private(struct super_block *sb,
386 struct ecryptfs_sb_info *sb_info)
387{
388 sb->s_fs_info = sb_info;
389}
390
391static inline struct super_block *
392ecryptfs_superblock_to_lower(struct super_block *sb)
393{
394 return ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb;
395}
396
397static inline void
398ecryptfs_set_superblock_lower(struct super_block *sb,
399 struct super_block *lower_sb)
400{
401 ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb = lower_sb;
402}
403
404static inline struct ecryptfs_dentry_info *
405ecryptfs_dentry_to_private(struct dentry *dentry)
406{
407 return (struct ecryptfs_dentry_info *)dentry->d_fsdata;
408}
409
410static inline void
411ecryptfs_set_dentry_private(struct dentry *dentry,
412 struct ecryptfs_dentry_info *dentry_info)
413{
414 dentry->d_fsdata = dentry_info;
415}
416
417static inline struct dentry *
418ecryptfs_dentry_to_lower(struct dentry *dentry)
419{
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -0800420 return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry;
Michael Halcrow237fead2006-10-04 02:16:22 -0700421}
422
423static inline void
424ecryptfs_set_dentry_lower(struct dentry *dentry, struct dentry *lower_dentry)
425{
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -0800426 ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry =
Michael Halcrow237fead2006-10-04 02:16:22 -0700427 lower_dentry;
428}
429
430static inline struct vfsmount *
431ecryptfs_dentry_to_lower_mnt(struct dentry *dentry)
432{
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -0800433 return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt;
Michael Halcrow237fead2006-10-04 02:16:22 -0700434}
435
436static inline void
437ecryptfs_set_dentry_lower_mnt(struct dentry *dentry, struct vfsmount *lower_mnt)
438{
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -0800439 ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt =
Michael Halcrow237fead2006-10-04 02:16:22 -0700440 lower_mnt;
441}
442
443#define ecryptfs_printk(type, fmt, arg...) \
444 __ecryptfs_printk(type "%s: " fmt, __FUNCTION__, ## arg);
445void __ecryptfs_printk(const char *fmt, ...);
446
447extern const struct file_operations ecryptfs_main_fops;
448extern const struct file_operations ecryptfs_dir_fops;
Arjan van de Ven754661f2007-02-12 00:55:38 -0800449extern const struct inode_operations ecryptfs_main_iops;
450extern const struct inode_operations ecryptfs_dir_iops;
451extern const struct inode_operations ecryptfs_symlink_iops;
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -0800452extern const struct super_operations ecryptfs_sops;
Michael Halcrow237fead2006-10-04 02:16:22 -0700453extern struct dentry_operations ecryptfs_dops;
454extern struct address_space_operations ecryptfs_aops;
455extern int ecryptfs_verbosity;
Michael Halcrow88b4a072007-02-12 00:53:43 -0800456extern unsigned int ecryptfs_message_buf_len;
457extern signed long ecryptfs_message_wait_timeout;
458extern unsigned int ecryptfs_number_of_users;
Michael Halcrow237fead2006-10-04 02:16:22 -0700459
460extern struct kmem_cache *ecryptfs_auth_tok_list_item_cache;
461extern struct kmem_cache *ecryptfs_file_info_cache;
462extern struct kmem_cache *ecryptfs_dentry_info_cache;
463extern struct kmem_cache *ecryptfs_inode_info_cache;
464extern struct kmem_cache *ecryptfs_sb_info_cache;
465extern struct kmem_cache *ecryptfs_header_cache_0;
466extern struct kmem_cache *ecryptfs_header_cache_1;
467extern struct kmem_cache *ecryptfs_header_cache_2;
Michael Halcrowdd2a3b72007-02-12 00:53:46 -0800468extern struct kmem_cache *ecryptfs_xattr_cache;
Michael Halcrow237fead2006-10-04 02:16:22 -0700469extern struct kmem_cache *ecryptfs_lower_page_cache;
Michael Halcroweb95e7f2007-02-16 01:28:40 -0800470extern struct kmem_cache *ecryptfs_key_record_cache;
Michael Halcrow237fead2006-10-04 02:16:22 -0700471
472int ecryptfs_interpose(struct dentry *hidden_dentry,
473 struct dentry *this_dentry, struct super_block *sb,
474 int flag);
475int ecryptfs_fill_zeros(struct file *file, loff_t new_length);
476int ecryptfs_decode_filename(struct ecryptfs_crypt_stat *crypt_stat,
477 const char *name, int length,
478 char **decrypted_name);
479int ecryptfs_encode_filename(struct ecryptfs_crypt_stat *crypt_stat,
480 const char *name, int length,
481 char **encoded_name);
482struct dentry *ecryptfs_lower_dentry(struct dentry *this_dentry);
Michael Halcrow237fead2006-10-04 02:16:22 -0700483void ecryptfs_dump_hex(char *data, int bytes);
484int virt_to_scatterlist(const void *addr, int size, struct scatterlist *sg,
485 int sg_size);
486int ecryptfs_compute_root_iv(struct ecryptfs_crypt_stat *crypt_stat);
487void ecryptfs_rotate_iv(unsigned char *iv);
488void ecryptfs_init_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
489void ecryptfs_destruct_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
490void ecryptfs_destruct_mount_crypt_stat(
491 struct ecryptfs_mount_crypt_stat *mount_crypt_stat);
492int ecryptfs_init_crypt_ctx(struct ecryptfs_crypt_stat *crypt_stat);
Michael Halcrow8bba0662006-10-30 22:07:18 -0800493int ecryptfs_crypto_api_algify_cipher_name(char **algified_name,
494 char *cipher_name,
495 char *chaining_modifier);
Michael Halcrowdd2a3b72007-02-12 00:53:46 -0800496#define ECRYPTFS_LOWER_I_MUTEX_NOT_HELD 0
497#define ECRYPTFS_LOWER_I_MUTEX_HELD 1
498int ecryptfs_write_inode_size_to_metadata(struct file *lower_file,
499 struct inode *lower_inode,
500 struct inode *inode,
501 struct dentry *ecryptfs_dentry,
502 int lower_i_mutex_held);
Michael Halcrow237fead2006-10-04 02:16:22 -0700503int ecryptfs_get_lower_page(struct page **lower_page, struct inode *lower_inode,
504 struct file *lower_file,
505 unsigned long lower_page_index, int byte_offset,
506 int region_bytes);
507int
508ecryptfs_commit_lower_page(struct page *lower_page, struct inode *lower_inode,
509 struct file *lower_file, int byte_offset,
510 int region_size);
511int ecryptfs_copy_page_to_lower(struct page *page, struct inode *lower_inode,
512 struct file *lower_file);
513int ecryptfs_do_readpage(struct file *file, struct page *page,
514 pgoff_t lower_page_index);
Michael Halcrow237fead2006-10-04 02:16:22 -0700515int ecryptfs_writepage_and_release_lower_page(struct page *lower_page,
516 struct inode *lower_inode,
517 struct writeback_control *wbc);
518int ecryptfs_encrypt_page(struct ecryptfs_page_crypt_context *ctx);
519int ecryptfs_decrypt_page(struct file *file, struct page *page);
Michael Halcrowdd2a3b72007-02-12 00:53:46 -0800520int ecryptfs_write_metadata(struct dentry *ecryptfs_dentry,
521 struct file *lower_file);
522int ecryptfs_read_metadata(struct dentry *ecryptfs_dentry,
Michael Halcrow237fead2006-10-04 02:16:22 -0700523 struct file *lower_file);
Michael Halcrow237fead2006-10-04 02:16:22 -0700524int ecryptfs_new_file_context(struct dentry *ecryptfs_dentry);
Michael Halcrowdd2a3b72007-02-12 00:53:46 -0800525int ecryptfs_read_and_validate_header_region(char *data, struct dentry *dentry,
526 struct vfsmount *mnt);
527int ecryptfs_read_and_validate_xattr_region(char *page_virt,
528 struct dentry *ecryptfs_dentry);
Michael Halcrow237fead2006-10-04 02:16:22 -0700529u16 ecryptfs_code_for_cipher_string(struct ecryptfs_crypt_stat *crypt_stat);
530int ecryptfs_cipher_code_to_string(char *str, u16 cipher_code);
531void ecryptfs_set_default_sizes(struct ecryptfs_crypt_stat *crypt_stat);
532int ecryptfs_generate_key_packet_set(char *dest_base,
533 struct ecryptfs_crypt_stat *crypt_stat,
534 struct dentry *ecryptfs_dentry,
535 size_t *len, size_t max);
536int process_request_key_err(long err_code);
537int
538ecryptfs_parse_packet_set(struct ecryptfs_crypt_stat *crypt_stat,
539 unsigned char *src, struct dentry *ecryptfs_dentry);
540int ecryptfs_truncate(struct dentry *dentry, loff_t new_length);
541int
Michael Halcrow8bba0662006-10-30 22:07:18 -0800542ecryptfs_process_cipher(struct crypto_blkcipher **key_tfm, char *cipher_name,
Michael Halcrowe5d9cbd2006-10-30 22:07:16 -0800543 size_t *key_size);
Michael Halcrow237fead2006-10-04 02:16:22 -0700544int ecryptfs_inode_test(struct inode *inode, void *candidate_lower_inode);
545int ecryptfs_inode_set(struct inode *inode, void *lower_inode);
546void ecryptfs_init_inode(struct inode *inode, struct inode *lower_inode);
Michael Halcrow7ff1d742006-10-30 22:07:19 -0800547int ecryptfs_open_lower_file(struct file **lower_file,
548 struct dentry *lower_dentry,
549 struct vfsmount *lower_mnt, int flags);
550int ecryptfs_close_lower_file(struct file *lower_file);
Michael Halcrowdd2a3b72007-02-12 00:53:46 -0800551ssize_t ecryptfs_getxattr(struct dentry *dentry, const char *name, void *value,
552 size_t size);
553int
554ecryptfs_setxattr(struct dentry *dentry, const char *name, const void *value,
555 size_t size, int flags);
Michael Halcrowe77a56d2007-02-12 00:53:47 -0800556int ecryptfs_read_xattr_region(char *page_virt, struct dentry *ecryptfs_dentry);
Michael Halcrow88b4a072007-02-12 00:53:43 -0800557int ecryptfs_process_helo(unsigned int transport, uid_t uid, pid_t pid);
558int ecryptfs_process_quit(uid_t uid, pid_t pid);
Michael Halcrowdddfa462007-02-12 00:53:44 -0800559int ecryptfs_process_response(struct ecryptfs_message *msg, uid_t uid,
560 pid_t pid, u32 seq);
Michael Halcrow88b4a072007-02-12 00:53:43 -0800561int ecryptfs_send_message(unsigned int transport, char *data, int data_len,
562 struct ecryptfs_msg_ctx **msg_ctx);
563int ecryptfs_wait_for_response(struct ecryptfs_msg_ctx *msg_ctx,
564 struct ecryptfs_message **emsg);
565int ecryptfs_init_messaging(unsigned int transport);
566void ecryptfs_release_messaging(unsigned int transport);
567
568int ecryptfs_send_netlink(char *data, int data_len,
569 struct ecryptfs_msg_ctx *msg_ctx, u16 msg_type,
570 u16 msg_flags, pid_t daemon_pid);
571int ecryptfs_init_netlink(void);
572void ecryptfs_release_netlink(void);
573
574int ecryptfs_send_connector(char *data, int data_len,
575 struct ecryptfs_msg_ctx *msg_ctx, u16 msg_type,
576 u16 msg_flags, pid_t daemon_pid);
577int ecryptfs_init_connector(void);
578void ecryptfs_release_connector(void);
Michael Halcrowe77a56d2007-02-12 00:53:47 -0800579void
580ecryptfs_write_header_metadata(char *virt,
581 struct ecryptfs_crypt_stat *crypt_stat,
582 size_t *written);
Michael Halcrow240e2df2007-06-27 14:09:44 -0700583int ecryptfs_write_zeros(struct file *file, pgoff_t index, int start,
584 int num_zeros);
Michael Halcrow88b4a072007-02-12 00:53:43 -0800585
Michael Halcrow237fead2006-10-04 02:16:22 -0700586#endif /* #ifndef ECRYPTFS_KERNEL_H */