blob: f44f71b7605aa790572617cb42d044dc237686b3 [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 Halcrow45eaab72007-10-16 01:28:05 -070041#define ECRYPTFS_SUPPORTED_FILE_VERSION 0x03
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 Halcrow45eaab72007-10-16 01:28:05 -070070#define ECRYPTFS_FILE_VERSION 0x03
Michael Halcrow237fead2006-10-04 02:16:22 -070071#define ECRYPTFS_DEFAULT_EXTENT_SIZE 4096
72#define ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE 8192
Michael Halcrow88b4a072007-02-12 00:53:43 -080073#define ECRYPTFS_DEFAULT_MSG_CTX_ELEMS 32
74#define ECRYPTFS_DEFAULT_SEND_TIMEOUT HZ
75#define ECRYPTFS_MAX_MSG_CTX_TTL (HZ*3)
76#define ECRYPTFS_NLMSG_HELO 100
77#define ECRYPTFS_NLMSG_QUIT 101
78#define ECRYPTFS_NLMSG_REQUEST 102
79#define ECRYPTFS_NLMSG_RESPONSE 103
80#define ECRYPTFS_MAX_PKI_NAME_BYTES 16
81#define ECRYPTFS_DEFAULT_NUM_USERS 4
82#define ECRYPTFS_MAX_NUM_USERS 32768
83#define ECRYPTFS_TRANSPORT_NETLINK 0
84#define ECRYPTFS_TRANSPORT_CONNECTOR 1
85#define ECRYPTFS_TRANSPORT_RELAYFS 2
86#define ECRYPTFS_DEFAULT_TRANSPORT ECRYPTFS_TRANSPORT_NETLINK
Michael Halcrowdd2a3b72007-02-12 00:53:46 -080087#define ECRYPTFS_XATTR_NAME "user.ecryptfs"
Michael Halcrow237fead2006-10-04 02:16:22 -070088
89#define RFC2440_CIPHER_DES3_EDE 0x02
90#define RFC2440_CIPHER_CAST_5 0x03
91#define RFC2440_CIPHER_BLOWFISH 0x04
92#define RFC2440_CIPHER_AES_128 0x07
93#define RFC2440_CIPHER_AES_192 0x08
94#define RFC2440_CIPHER_AES_256 0x09
95#define RFC2440_CIPHER_TWOFISH 0x0a
96#define RFC2440_CIPHER_CAST_6 0x0b
97
Michael Halcrow88b4a072007-02-12 00:53:43 -080098#define RFC2440_CIPHER_RSA 0x01
Michael Halcrow237fead2006-10-04 02:16:22 -070099
100/**
101 * For convenience, we may need to pass around the encrypted session
102 * key between kernel and userspace because the authentication token
103 * may not be extractable. For example, the TPM may not release the
104 * private key, instead requiring the encrypted data and returning the
105 * decrypted data.
106 */
107struct ecryptfs_session_key {
108#define ECRYPTFS_USERSPACE_SHOULD_TRY_TO_DECRYPT 0x00000001
109#define ECRYPTFS_USERSPACE_SHOULD_TRY_TO_ENCRYPT 0x00000002
110#define ECRYPTFS_CONTAINS_DECRYPTED_KEY 0x00000004
111#define ECRYPTFS_CONTAINS_ENCRYPTED_KEY 0x00000008
112 u32 flags;
113 u32 encrypted_key_size;
114 u32 decrypted_key_size;
115 u8 encrypted_key[ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES];
116 u8 decrypted_key[ECRYPTFS_MAX_KEY_BYTES];
117};
118
119struct ecryptfs_password {
120 u32 password_bytes;
121 s32 hash_algo;
122 u32 hash_iterations;
123 u32 session_key_encryption_key_bytes;
124#define ECRYPTFS_PERSISTENT_PASSWORD 0x01
125#define ECRYPTFS_SESSION_KEY_ENCRYPTION_KEY_SET 0x02
126 u32 flags;
127 /* Iterated-hash concatenation of salt and passphrase */
128 u8 session_key_encryption_key[ECRYPTFS_MAX_KEY_BYTES];
129 u8 signature[ECRYPTFS_PASSWORD_SIG_SIZE + 1];
130 /* Always in expanded hex */
131 u8 salt[ECRYPTFS_SALT_SIZE];
132};
133
134enum ecryptfs_token_types {ECRYPTFS_PASSWORD, ECRYPTFS_PRIVATE_KEY};
135
Michael Halcrow88b4a072007-02-12 00:53:43 -0800136struct ecryptfs_private_key {
137 u32 key_size;
138 u32 data_len;
139 u8 signature[ECRYPTFS_PASSWORD_SIG_SIZE + 1];
140 char pki_type[ECRYPTFS_MAX_PKI_NAME_BYTES + 1];
141 u8 data[];
142};
143
Michael Halcrow237fead2006-10-04 02:16:22 -0700144/* May be a password or a private key */
145struct ecryptfs_auth_tok {
146 u16 version; /* 8-bit major and 8-bit minor */
147 u16 token_type;
Michael Halcrowf4aad162007-10-16 01:27:53 -0700148#define ECRYPTFS_ENCRYPT_ONLY 0x00000001
Michael Halcrow237fead2006-10-04 02:16:22 -0700149 u32 flags;
150 struct ecryptfs_session_key session_key;
151 u8 reserved[32];
152 union {
153 struct ecryptfs_password password;
Michael Halcrow88b4a072007-02-12 00:53:43 -0800154 struct ecryptfs_private_key private_key;
Michael Halcrow237fead2006-10-04 02:16:22 -0700155 } token;
156} __attribute__ ((packed));
157
158void ecryptfs_dump_auth_tok(struct ecryptfs_auth_tok *auth_tok);
159extern void ecryptfs_to_hex(char *dst, char *src, size_t src_size);
160extern void ecryptfs_from_hex(char *dst, char *src, int dst_size);
161
162struct ecryptfs_key_record {
163 unsigned char type;
164 size_t enc_key_size;
165 unsigned char sig[ECRYPTFS_SIG_SIZE];
166 unsigned char enc_key[ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES];
167};
168
169struct ecryptfs_auth_tok_list {
170 struct ecryptfs_auth_tok *auth_tok;
171 struct list_head list;
172};
173
174struct ecryptfs_crypt_stat;
175struct ecryptfs_mount_crypt_stat;
176
177struct ecryptfs_page_crypt_context {
178 struct page *page;
179#define ECRYPTFS_PREPARE_COMMIT_MODE 0
180#define ECRYPTFS_WRITEPAGE_MODE 1
181 unsigned int mode;
182 union {
183 struct file *lower_file;
184 struct writeback_control *wbc;
185 } param;
186};
187
188static inline struct ecryptfs_auth_tok *
189ecryptfs_get_key_payload_data(struct key *key)
190{
191 return (struct ecryptfs_auth_tok *)
192 (((struct user_key_payload*)key->payload.data)->data);
193}
194
195#define ECRYPTFS_SUPER_MAGIC 0xf15f
196#define ECRYPTFS_MAX_KEYSET_SIZE 1024
197#define ECRYPTFS_MAX_CIPHER_NAME_SIZE 32
198#define ECRYPTFS_MAX_NUM_ENC_KEYS 64
Michael Halcrow237fead2006-10-04 02:16:22 -0700199#define ECRYPTFS_MAX_IV_BYTES 16 /* 128 bits */
200#define ECRYPTFS_SALT_BYTES 2
201#define MAGIC_ECRYPTFS_MARKER 0x3c81b7f5
202#define MAGIC_ECRYPTFS_MARKER_SIZE_BYTES 8 /* 4*2 */
Michael Halcrow45eaab72007-10-16 01:28:05 -0700203#define ECRYPTFS_FILE_SIZE_BYTES (sizeof(u64))
Michael Halcrow237fead2006-10-04 02:16:22 -0700204#define ECRYPTFS_DEFAULT_CIPHER "aes"
205#define ECRYPTFS_DEFAULT_KEY_BYTES 16
Michael Halcrow565d97242006-10-30 22:07:17 -0800206#define ECRYPTFS_DEFAULT_HASH "md5"
Michael Halcrow88b4a072007-02-12 00:53:43 -0800207#define ECRYPTFS_TAG_1_PACKET_TYPE 0x01
Michael Halcrow237fead2006-10-04 02:16:22 -0700208#define ECRYPTFS_TAG_3_PACKET_TYPE 0x8C
209#define ECRYPTFS_TAG_11_PACKET_TYPE 0xED
Michael Halcrow88b4a072007-02-12 00:53:43 -0800210#define ECRYPTFS_TAG_64_PACKET_TYPE 0x40
211#define ECRYPTFS_TAG_65_PACKET_TYPE 0x41
212#define ECRYPTFS_TAG_66_PACKET_TYPE 0x42
213#define ECRYPTFS_TAG_67_PACKET_TYPE 0x43
Michael Halcrow237fead2006-10-04 02:16:22 -0700214#define MD5_DIGEST_SIZE 16
215
Michael Halcrowf4aad162007-10-16 01:27:53 -0700216struct ecryptfs_key_sig {
217 struct list_head crypt_stat_list;
218 char keysig[ECRYPTFS_SIG_SIZE_HEX];
219};
220
Michael Halcrow237fead2006-10-04 02:16:22 -0700221/**
222 * This is the primary struct associated with each encrypted file.
223 *
224 * TODO: cache align/pack?
225 */
226struct ecryptfs_crypt_stat {
227#define ECRYPTFS_STRUCT_INITIALIZED 0x00000001
228#define ECRYPTFS_POLICY_APPLIED 0x00000002
229#define ECRYPTFS_NEW_FILE 0x00000004
230#define ECRYPTFS_ENCRYPTED 0x00000008
231#define ECRYPTFS_SECURITY_WARNING 0x00000010
232#define ECRYPTFS_ENABLE_HMAC 0x00000020
233#define ECRYPTFS_ENCRYPT_IV_PAGES 0x00000040
234#define ECRYPTFS_KEY_VALID 0x00000080
Michael Halcrow17398952007-02-12 00:53:45 -0800235#define ECRYPTFS_METADATA_IN_XATTR 0x00000100
236#define ECRYPTFS_VIEW_AS_ENCRYPTED 0x00000200
Trevor Highland8e3a6f12008-02-06 01:38:33 -0800237#define ECRYPTFS_KEY_SET 0x00000400
Michael Halcrow237fead2006-10-04 02:16:22 -0700238 u32 flags;
239 unsigned int file_version;
240 size_t iv_bytes;
Michael Halcrowcc11bef2008-02-06 01:38:32 -0800241 size_t num_header_bytes_at_front;
Michael Halcrow237fead2006-10-04 02:16:22 -0700242 size_t extent_size; /* Data extent size; default is 4096 */
243 size_t key_size;
244 size_t extent_shift;
245 unsigned int extent_mask;
246 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
Michael Halcrow8bba0662006-10-30 22:07:18 -0800247 struct crypto_blkcipher *tfm;
Michael Halcrow565d97242006-10-30 22:07:17 -0800248 struct crypto_hash *hash_tfm; /* Crypto context for generating
249 * the initialization vectors */
Michael Halcrow237fead2006-10-04 02:16:22 -0700250 unsigned char cipher[ECRYPTFS_MAX_CIPHER_NAME_SIZE];
251 unsigned char key[ECRYPTFS_MAX_KEY_BYTES];
252 unsigned char root_iv[ECRYPTFS_MAX_IV_BYTES];
Michael Halcrowf4aad162007-10-16 01:27:53 -0700253 struct list_head keysig_list;
254 struct mutex keysig_list_mutex;
Michael Halcrow237fead2006-10-04 02:16:22 -0700255 struct mutex cs_tfm_mutex;
Michael Halcrow565d97242006-10-30 22:07:17 -0800256 struct mutex cs_hash_tfm_mutex;
Michael Halcrow237fead2006-10-04 02:16:22 -0700257 struct mutex cs_mutex;
258};
259
260/* inode private data. */
261struct ecryptfs_inode_info {
262 struct inode vfs_inode;
263 struct inode *wii_inode;
Michael Halcrowda0102a2007-10-16 01:28:07 -0700264 struct file *lower_file;
265 struct mutex lower_file_mutex;
Michael Halcrow237fead2006-10-04 02:16:22 -0700266 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 Halcrow6c6f57f2007-10-16 01:28:01 -0700276/**
Michael Halcrow45eaab72007-10-16 01:28:05 -0700277 * ecryptfs_global_auth_tok - A key used to encrypt all new files under the mountpoint
278 * @flags: Status flags
279 * @mount_crypt_stat_list: These auth_toks hang off the mount-wide
280 * cryptographic context. Every time a new
281 * inode comes into existence, eCryptfs copies
282 * the auth_toks on that list to the set of
283 * auth_toks on the inode's crypt_stat
284 * @global_auth_tok_key: The key from the user's keyring for the sig
285 * @global_auth_tok: The key contents
286 * @sig: The key identifier
287 *
Michael Halcrow6c6f57f2007-10-16 01:28:01 -0700288 * ecryptfs_global_auth_tok structs refer to authentication token keys
289 * in the user keyring that apply to newly created files. A list of
290 * these objects hangs off of the mount_crypt_stat struct for any
291 * given eCryptfs mount. This struct maintains a reference to both the
292 * key contents and the key itself so that the key can be put on
293 * unmount.
294 */
Michael Halcrowf4aad162007-10-16 01:27:53 -0700295struct ecryptfs_global_auth_tok {
296#define ECRYPTFS_AUTH_TOK_INVALID 0x00000001
297 u32 flags;
Michael Halcrow45eaab72007-10-16 01:28:05 -0700298 struct list_head mount_crypt_stat_list;
299 struct key *global_auth_tok_key;
300 struct ecryptfs_auth_tok *global_auth_tok;
301 unsigned char sig[ECRYPTFS_SIG_SIZE_HEX + 1];
Michael Halcrowf4aad162007-10-16 01:27:53 -0700302};
303
Michael Halcrow6c6f57f2007-10-16 01:28:01 -0700304/**
Michael Halcrow45eaab72007-10-16 01:28:05 -0700305 * ecryptfs_key_tfm - Persistent key tfm
306 * @key_tfm: crypto API handle to the key
307 * @key_size: Key size in bytes
308 * @key_tfm_mutex: Mutex to ensure only one operation in eCryptfs is
309 * using the persistent TFM at any point in time
310 * @key_tfm_list: Handle to hang this off the module-wide TFM list
311 * @cipher_name: String name for the cipher for this TFM
312 *
Michael Halcrow6c6f57f2007-10-16 01:28:01 -0700313 * Typically, eCryptfs will use the same ciphers repeatedly throughout
314 * the course of its operations. In order to avoid unnecessarily
315 * destroying and initializing the same cipher repeatedly, eCryptfs
316 * keeps a list of crypto API contexts around to use when needed.
317 */
Michael Halcrowf4aad162007-10-16 01:27:53 -0700318struct ecryptfs_key_tfm {
319 struct crypto_blkcipher *key_tfm;
320 size_t key_size;
321 struct mutex key_tfm_mutex;
Michael Halcrow45eaab72007-10-16 01:28:05 -0700322 struct list_head key_tfm_list;
Michael Halcrowf4aad162007-10-16 01:27:53 -0700323 unsigned char cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE + 1];
324};
325
Michael Halcrow237fead2006-10-04 02:16:22 -0700326/**
327 * This struct is to enable a mount-wide passphrase/salt combo. This
328 * is more or less a stopgap to provide similar functionality to other
329 * crypto filesystems like EncFS or CFS until full policy support is
330 * implemented in eCryptfs.
331 */
332struct ecryptfs_mount_crypt_stat {
333 /* Pointers to memory we do not own, do not free these */
334#define ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED 0x00000001
Michael Halcrow17398952007-02-12 00:53:45 -0800335#define ECRYPTFS_XATTR_METADATA_ENABLED 0x00000002
336#define ECRYPTFS_ENCRYPTED_VIEW_ENABLED 0x00000004
Michael Halcrowf4aad162007-10-16 01:27:53 -0700337#define ECRYPTFS_MOUNT_CRYPT_STAT_INITIALIZED 0x00000008
Michael Halcrow237fead2006-10-04 02:16:22 -0700338 u32 flags;
Michael Halcrowf4aad162007-10-16 01:27:53 -0700339 struct list_head global_auth_tok_list;
340 struct mutex global_auth_tok_list_mutex;
341 size_t num_global_auth_toks;
Michael Halcrow237fead2006-10-04 02:16:22 -0700342 size_t global_default_cipher_key_size;
Michael Halcrow237fead2006-10-04 02:16:22 -0700343 unsigned char global_default_cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE
344 + 1];
Michael Halcrow237fead2006-10-04 02:16:22 -0700345};
346
347/* superblock private data. */
348struct ecryptfs_sb_info {
349 struct super_block *wsi_sb;
350 struct ecryptfs_mount_crypt_stat mount_crypt_stat;
351};
352
353/* file private data. */
354struct ecryptfs_file_info {
355 struct file *wfi_file;
356 struct ecryptfs_crypt_stat *crypt_stat;
357};
358
359/* auth_tok <=> encrypted_session_key mappings */
360struct ecryptfs_auth_tok_list_item {
361 unsigned char encrypted_session_key[ECRYPTFS_MAX_KEY_BYTES];
362 struct list_head list;
363 struct ecryptfs_auth_tok auth_tok;
364};
365
Michael Halcrow88b4a072007-02-12 00:53:43 -0800366struct ecryptfs_message {
367 u32 index;
368 u32 data_len;
369 u8 data[];
370};
371
372struct ecryptfs_msg_ctx {
373#define ECRYPTFS_MSG_CTX_STATE_FREE 0x0001
374#define ECRYPTFS_MSG_CTX_STATE_PENDING 0x0002
375#define ECRYPTFS_MSG_CTX_STATE_DONE 0x0003
376 u32 state;
377 unsigned int index;
378 unsigned int counter;
379 struct ecryptfs_message *msg;
380 struct task_struct *task;
381 struct list_head node;
382 struct mutex mux;
383};
384
Michael Halcrow88b4a072007-02-12 00:53:43 -0800385extern unsigned int ecryptfs_transport;
386
387struct ecryptfs_daemon_id {
388 pid_t pid;
389 uid_t uid;
390 struct hlist_node id_chain;
391};
392
Michael Halcrow237fead2006-10-04 02:16:22 -0700393static inline struct ecryptfs_file_info *
394ecryptfs_file_to_private(struct file *file)
395{
396 return (struct ecryptfs_file_info *)file->private_data;
397}
398
399static inline void
400ecryptfs_set_file_private(struct file *file,
401 struct ecryptfs_file_info *file_info)
402{
403 file->private_data = file_info;
404}
405
406static inline struct file *ecryptfs_file_to_lower(struct file *file)
407{
408 return ((struct ecryptfs_file_info *)file->private_data)->wfi_file;
409}
410
411static inline void
412ecryptfs_set_file_lower(struct file *file, struct file *lower_file)
413{
414 ((struct ecryptfs_file_info *)file->private_data)->wfi_file =
415 lower_file;
416}
417
418static inline struct ecryptfs_inode_info *
419ecryptfs_inode_to_private(struct inode *inode)
420{
421 return container_of(inode, struct ecryptfs_inode_info, vfs_inode);
422}
423
424static inline struct inode *ecryptfs_inode_to_lower(struct inode *inode)
425{
426 return ecryptfs_inode_to_private(inode)->wii_inode;
427}
428
429static inline void
430ecryptfs_set_inode_lower(struct inode *inode, struct inode *lower_inode)
431{
432 ecryptfs_inode_to_private(inode)->wii_inode = lower_inode;
433}
434
435static inline struct ecryptfs_sb_info *
436ecryptfs_superblock_to_private(struct super_block *sb)
437{
438 return (struct ecryptfs_sb_info *)sb->s_fs_info;
439}
440
441static inline void
442ecryptfs_set_superblock_private(struct super_block *sb,
443 struct ecryptfs_sb_info *sb_info)
444{
445 sb->s_fs_info = sb_info;
446}
447
448static inline struct super_block *
449ecryptfs_superblock_to_lower(struct super_block *sb)
450{
451 return ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb;
452}
453
454static inline void
455ecryptfs_set_superblock_lower(struct super_block *sb,
456 struct super_block *lower_sb)
457{
458 ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb = lower_sb;
459}
460
461static inline struct ecryptfs_dentry_info *
462ecryptfs_dentry_to_private(struct dentry *dentry)
463{
464 return (struct ecryptfs_dentry_info *)dentry->d_fsdata;
465}
466
467static inline void
468ecryptfs_set_dentry_private(struct dentry *dentry,
469 struct ecryptfs_dentry_info *dentry_info)
470{
471 dentry->d_fsdata = dentry_info;
472}
473
474static inline struct dentry *
475ecryptfs_dentry_to_lower(struct dentry *dentry)
476{
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -0800477 return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry;
Michael Halcrow237fead2006-10-04 02:16:22 -0700478}
479
480static inline void
481ecryptfs_set_dentry_lower(struct dentry *dentry, struct dentry *lower_dentry)
482{
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -0800483 ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry =
Michael Halcrow237fead2006-10-04 02:16:22 -0700484 lower_dentry;
485}
486
487static inline struct vfsmount *
488ecryptfs_dentry_to_lower_mnt(struct dentry *dentry)
489{
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -0800490 return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt;
Michael Halcrow237fead2006-10-04 02:16:22 -0700491}
492
493static inline void
494ecryptfs_set_dentry_lower_mnt(struct dentry *dentry, struct vfsmount *lower_mnt)
495{
Josef "Jeff" Sipekb65d34f2006-12-08 02:36:34 -0800496 ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt =
Michael Halcrow237fead2006-10-04 02:16:22 -0700497 lower_mnt;
498}
499
500#define ecryptfs_printk(type, fmt, arg...) \
501 __ecryptfs_printk(type "%s: " fmt, __FUNCTION__, ## arg);
502void __ecryptfs_printk(const char *fmt, ...);
503
504extern const struct file_operations ecryptfs_main_fops;
505extern const struct file_operations ecryptfs_dir_fops;
Arjan van de Ven754661f2007-02-12 00:55:38 -0800506extern const struct inode_operations ecryptfs_main_iops;
507extern const struct inode_operations ecryptfs_dir_iops;
508extern const struct inode_operations ecryptfs_symlink_iops;
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -0800509extern const struct super_operations ecryptfs_sops;
Michael Halcrow237fead2006-10-04 02:16:22 -0700510extern struct dentry_operations ecryptfs_dops;
511extern struct address_space_operations ecryptfs_aops;
512extern int ecryptfs_verbosity;
Michael Halcrow88b4a072007-02-12 00:53:43 -0800513extern unsigned int ecryptfs_message_buf_len;
514extern signed long ecryptfs_message_wait_timeout;
515extern unsigned int ecryptfs_number_of_users;
Michael Halcrow237fead2006-10-04 02:16:22 -0700516
517extern struct kmem_cache *ecryptfs_auth_tok_list_item_cache;
518extern struct kmem_cache *ecryptfs_file_info_cache;
519extern struct kmem_cache *ecryptfs_dentry_info_cache;
520extern struct kmem_cache *ecryptfs_inode_info_cache;
521extern struct kmem_cache *ecryptfs_sb_info_cache;
Michael Halcrow237fead2006-10-04 02:16:22 -0700522extern struct kmem_cache *ecryptfs_header_cache_1;
523extern struct kmem_cache *ecryptfs_header_cache_2;
Michael Halcrowdd2a3b72007-02-12 00:53:46 -0800524extern struct kmem_cache *ecryptfs_xattr_cache;
Michael Halcroweb95e7f2007-02-16 01:28:40 -0800525extern struct kmem_cache *ecryptfs_key_record_cache;
Michael Halcrowf4aad162007-10-16 01:27:53 -0700526extern struct kmem_cache *ecryptfs_key_sig_cache;
527extern struct kmem_cache *ecryptfs_global_auth_tok_cache;
528extern struct kmem_cache *ecryptfs_key_tfm_cache;
Michael Halcrow237fead2006-10-04 02:16:22 -0700529
530int ecryptfs_interpose(struct dentry *hidden_dentry,
531 struct dentry *this_dentry, struct super_block *sb,
532 int flag);
533int ecryptfs_fill_zeros(struct file *file, loff_t new_length);
534int ecryptfs_decode_filename(struct ecryptfs_crypt_stat *crypt_stat,
535 const char *name, int length,
536 char **decrypted_name);
537int ecryptfs_encode_filename(struct ecryptfs_crypt_stat *crypt_stat,
538 const char *name, int length,
539 char **encoded_name);
540struct dentry *ecryptfs_lower_dentry(struct dentry *this_dentry);
Michael Halcrow237fead2006-10-04 02:16:22 -0700541void ecryptfs_dump_hex(char *data, int bytes);
542int virt_to_scatterlist(const void *addr, int size, struct scatterlist *sg,
543 int sg_size);
544int ecryptfs_compute_root_iv(struct ecryptfs_crypt_stat *crypt_stat);
545void ecryptfs_rotate_iv(unsigned char *iv);
546void ecryptfs_init_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
Michael Halcrowfcd12832007-10-16 01:28:01 -0700547void ecryptfs_destroy_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
548void ecryptfs_destroy_mount_crypt_stat(
Michael Halcrow237fead2006-10-04 02:16:22 -0700549 struct ecryptfs_mount_crypt_stat *mount_crypt_stat);
550int ecryptfs_init_crypt_ctx(struct ecryptfs_crypt_stat *crypt_stat);
Michael Halcrowb6c1d8f2007-10-16 01:28:13 -0700551int ecryptfs_write_inode_size_to_metadata(struct inode *ecryptfs_inode);
Michael Halcrow0216f7f2007-10-16 01:28:08 -0700552int ecryptfs_encrypt_page(struct page *page);
553int ecryptfs_decrypt_page(struct page *page);
Michael Halcrowd7cdc5f2007-10-16 01:28:10 -0700554int ecryptfs_write_metadata(struct dentry *ecryptfs_dentry);
555int ecryptfs_read_metadata(struct dentry *ecryptfs_dentry);
Michael Halcrow237fead2006-10-04 02:16:22 -0700556int ecryptfs_new_file_context(struct dentry *ecryptfs_dentry);
Michael Halcrowd7cdc5f2007-10-16 01:28:10 -0700557int ecryptfs_read_and_validate_header_region(char *data,
558 struct inode *ecryptfs_inode);
Michael Halcrowdd2a3b72007-02-12 00:53:46 -0800559int ecryptfs_read_and_validate_xattr_region(char *page_virt,
560 struct dentry *ecryptfs_dentry);
Trevor Highland19e66a62008-02-06 01:38:36 -0800561u8 ecryptfs_code_for_cipher_string(struct ecryptfs_crypt_stat *crypt_stat);
562int ecryptfs_cipher_code_to_string(char *str, u8 cipher_code);
Michael Halcrow237fead2006-10-04 02:16:22 -0700563void ecryptfs_set_default_sizes(struct ecryptfs_crypt_stat *crypt_stat);
564int ecryptfs_generate_key_packet_set(char *dest_base,
565 struct ecryptfs_crypt_stat *crypt_stat,
566 struct dentry *ecryptfs_dentry,
567 size_t *len, size_t max);
Michael Halcrow237fead2006-10-04 02:16:22 -0700568int
569ecryptfs_parse_packet_set(struct ecryptfs_crypt_stat *crypt_stat,
570 unsigned char *src, struct dentry *ecryptfs_dentry);
571int ecryptfs_truncate(struct dentry *dentry, loff_t new_length);
Michael Halcrow237fead2006-10-04 02:16:22 -0700572int ecryptfs_inode_test(struct inode *inode, void *candidate_lower_inode);
573int ecryptfs_inode_set(struct inode *inode, void *lower_inode);
574void ecryptfs_init_inode(struct inode *inode, struct inode *lower_inode);
Michael Halcrowd7cdc5f2007-10-16 01:28:10 -0700575ssize_t
576ecryptfs_getxattr_lower(struct dentry *lower_dentry, const char *name,
577 void *value, size_t size);
Michael Halcrowdd2a3b72007-02-12 00:53:46 -0800578int
579ecryptfs_setxattr(struct dentry *dentry, const char *name, const void *value,
580 size_t size, int flags);
Michael Halcrowd7cdc5f2007-10-16 01:28:10 -0700581int ecryptfs_read_xattr_region(char *page_virt, struct inode *ecryptfs_inode);
Michael Halcrow88b4a072007-02-12 00:53:43 -0800582int ecryptfs_process_helo(unsigned int transport, uid_t uid, pid_t pid);
583int ecryptfs_process_quit(uid_t uid, pid_t pid);
Michael Halcrowdddfa462007-02-12 00:53:44 -0800584int ecryptfs_process_response(struct ecryptfs_message *msg, uid_t uid,
585 pid_t pid, u32 seq);
Michael Halcrow88b4a072007-02-12 00:53:43 -0800586int ecryptfs_send_message(unsigned int transport, char *data, int data_len,
587 struct ecryptfs_msg_ctx **msg_ctx);
588int ecryptfs_wait_for_response(struct ecryptfs_msg_ctx *msg_ctx,
589 struct ecryptfs_message **emsg);
590int ecryptfs_init_messaging(unsigned int transport);
591void ecryptfs_release_messaging(unsigned int transport);
592
593int ecryptfs_send_netlink(char *data, int data_len,
594 struct ecryptfs_msg_ctx *msg_ctx, u16 msg_type,
595 u16 msg_flags, pid_t daemon_pid);
596int ecryptfs_init_netlink(void);
597void ecryptfs_release_netlink(void);
598
599int ecryptfs_send_connector(char *data, int data_len,
600 struct ecryptfs_msg_ctx *msg_ctx, u16 msg_type,
601 u16 msg_flags, pid_t daemon_pid);
602int ecryptfs_init_connector(void);
603void ecryptfs_release_connector(void);
Michael Halcrowe77a56d2007-02-12 00:53:47 -0800604void
605ecryptfs_write_header_metadata(char *virt,
606 struct ecryptfs_crypt_stat *crypt_stat,
607 size_t *written);
Michael Halcrowf4aad162007-10-16 01:27:53 -0700608int ecryptfs_add_keysig(struct ecryptfs_crypt_stat *crypt_stat, char *sig);
609int
610ecryptfs_add_global_auth_tok(struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
611 char *sig);
612int ecryptfs_get_global_auth_tok_for_sig(
613 struct ecryptfs_global_auth_tok **global_auth_tok,
614 struct ecryptfs_mount_crypt_stat *mount_crypt_stat, char *sig);
615int
616ecryptfs_add_new_key_tfm(struct ecryptfs_key_tfm **key_tfm, char *cipher_name,
617 size_t key_size);
618int ecryptfs_init_crypto(void);
Michael Halcrowfcd12832007-10-16 01:28:01 -0700619int ecryptfs_destroy_crypto(void);
Michael Halcrowf4aad162007-10-16 01:27:53 -0700620int ecryptfs_get_tfm_and_mutex_for_cipher_name(struct crypto_blkcipher **tfm,
621 struct mutex **tfm_mutex,
622 char *cipher_name);
623int ecryptfs_keyring_auth_tok_for_sig(struct key **auth_tok_key,
624 struct ecryptfs_auth_tok **auth_tok,
625 char *sig);
Michael Halcrow240e2df2007-06-27 14:09:44 -0700626int ecryptfs_write_zeros(struct file *file, pgoff_t index, int start,
627 int num_zeros);
Michael Halcrowda0102a2007-10-16 01:28:07 -0700628int ecryptfs_write_lower(struct inode *ecryptfs_inode, char *data,
629 loff_t offset, size_t size);
630int ecryptfs_write_lower_page_segment(struct inode *ecryptfs_inode,
631 struct page *page_for_lower,
632 size_t offset_in_page, size_t size);
633int ecryptfs_write(struct file *ecryptfs_file, char *data, loff_t offset,
634 size_t size);
635int ecryptfs_read_lower(char *data, loff_t offset, size_t size,
636 struct inode *ecryptfs_inode);
637int ecryptfs_read_lower_page_segment(struct page *page_for_ecryptfs,
638 pgoff_t page_index,
639 size_t offset_in_page, size_t size,
640 struct inode *ecryptfs_inode);
Michael Halcrow16a72c42007-10-16 01:28:14 -0700641struct page *ecryptfs_get_locked_page(struct file *file, loff_t index);
Michael Halcrow88b4a072007-02-12 00:53:43 -0800642
Michael Halcrow237fead2006-10-04 02:16:22 -0700643#endif /* #ifndef ECRYPTFS_KERNEL_H */