| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 1 | /** | 
 | 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 Halcrow | dd2a3b7 | 2007-02-12 00:53:46 -0800 | [diff] [blame] | 7 |  * Copyright (C) 2004-2007 International Business Machines Corp. | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 8 |  *   Author(s): Michael A. Halcrow <mahalcro@us.ibm.com> | 
| Michael Halcrow | 88b4a07 | 2007-02-12 00:53:43 -0800 | [diff] [blame] | 9 |  *              Trevor S. Highland <trevor.highland@gmail.com> | 
 | 10 |  *              Tyler Hicks <tyhicks@ou.edu> | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 11 |  * | 
 | 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" Sipek | 0cc72dc | 2006-12-08 02:36:31 -0800 | [diff] [blame] | 33 | #include <linux/fs_stack.h> | 
| Josef "Jeff" Sipek | b65d34f | 2006-12-08 02:36:34 -0800 | [diff] [blame] | 34 | #include <linux/namei.h> | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 35 | #include <linux/scatterlist.h> | 
| Michael Halcrow | dddfa46 | 2007-02-12 00:53:44 -0800 | [diff] [blame] | 36 | #include <linux/hash.h> | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 37 |  | 
 | 38 | /* Version verification for shared data structures w/ userspace */ | 
 | 39 | #define ECRYPTFS_VERSION_MAJOR 0x00 | 
 | 40 | #define ECRYPTFS_VERSION_MINOR 0x04 | 
| Michael Halcrow | 88b4a07 | 2007-02-12 00:53:43 -0800 | [diff] [blame] | 41 | #define ECRYPTFS_SUPPORTED_FILE_VERSION 0x02 | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 42 | /* 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 Halcrow | 1739895 | 2007-02-12 00:53:45 -0800 | [diff] [blame] | 46 | #define ECRYPTFS_VERSIONING_PASSPHRASE            0x00000001 | 
 | 47 | #define ECRYPTFS_VERSIONING_PUBKEY                0x00000002 | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 48 | #define ECRYPTFS_VERSIONING_PLAINTEXT_PASSTHROUGH 0x00000004 | 
| Michael Halcrow | 1739895 | 2007-02-12 00:53:45 -0800 | [diff] [blame] | 49 | #define ECRYPTFS_VERSIONING_POLICY                0x00000008 | 
 | 50 | #define ECRYPTFS_VERSIONING_XATTR                 0x00000010 | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 51 | #define ECRYPTFS_VERSIONING_MASK (ECRYPTFS_VERSIONING_PASSPHRASE \ | 
| Michael Halcrow | 1739895 | 2007-02-12 00:53:45 -0800 | [diff] [blame] | 52 | 				  | ECRYPTFS_VERSIONING_PLAINTEXT_PASSTHROUGH \ | 
| Michael Halcrow | dd2a3b7 | 2007-02-12 00:53:46 -0800 | [diff] [blame] | 53 | 				  | ECRYPTFS_VERSIONING_PUBKEY \ | 
 | 54 | 				  | ECRYPTFS_VERSIONING_XATTR) | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 55 | #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 Halcrow | 88b4a07 | 2007-02-12 00:53:43 -0800 | [diff] [blame] | 68 | #define ECRYPTFS_FILE_VERSION 0x02 | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 69 | #define ECRYPTFS_DEFAULT_HEADER_EXTENT_SIZE 8192 | 
 | 70 | #define ECRYPTFS_DEFAULT_EXTENT_SIZE 4096 | 
 | 71 | #define ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE 8192 | 
| Michael Halcrow | 88b4a07 | 2007-02-12 00:53:43 -0800 | [diff] [blame] | 72 | #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 Halcrow | dd2a3b7 | 2007-02-12 00:53:46 -0800 | [diff] [blame] | 86 | #define ECRYPTFS_XATTR_NAME "user.ecryptfs" | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 87 |  | 
 | 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 Halcrow | 88b4a07 | 2007-02-12 00:53:43 -0800 | [diff] [blame] | 97 | #define RFC2440_CIPHER_RSA 0x01 | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 98 |  | 
 | 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 |  */ | 
 | 106 | struct 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 |  | 
 | 118 | struct 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 |  | 
 | 133 | enum ecryptfs_token_types {ECRYPTFS_PASSWORD, ECRYPTFS_PRIVATE_KEY}; | 
 | 134 |  | 
| Michael Halcrow | 88b4a07 | 2007-02-12 00:53:43 -0800 | [diff] [blame] | 135 | struct 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 Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 143 | /* May be a password or a private key */ | 
 | 144 | struct 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 Halcrow | 88b4a07 | 2007-02-12 00:53:43 -0800 | [diff] [blame] | 152 | 		struct ecryptfs_private_key private_key; | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 153 | 	} token; | 
 | 154 | } __attribute__ ((packed)); | 
 | 155 |  | 
 | 156 | void ecryptfs_dump_auth_tok(struct ecryptfs_auth_tok *auth_tok); | 
 | 157 | extern void ecryptfs_to_hex(char *dst, char *src, size_t src_size); | 
 | 158 | extern void ecryptfs_from_hex(char *dst, char *src, int dst_size); | 
 | 159 |  | 
 | 160 | struct 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 |  | 
 | 167 | struct ecryptfs_auth_tok_list { | 
 | 168 | 	struct ecryptfs_auth_tok *auth_tok; | 
 | 169 | 	struct list_head list; | 
 | 170 | }; | 
 | 171 |  | 
 | 172 | struct ecryptfs_crypt_stat; | 
 | 173 | struct ecryptfs_mount_crypt_stat; | 
 | 174 |  | 
 | 175 | struct 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 |  | 
 | 186 | static inline struct ecryptfs_auth_tok * | 
 | 187 | ecryptfs_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 Halcrow | 565d972 | 2006-10-30 22:07:17 -0800 | [diff] [blame] | 205 | #define ECRYPTFS_DEFAULT_HASH "md5" | 
| Michael Halcrow | 88b4a07 | 2007-02-12 00:53:43 -0800 | [diff] [blame] | 206 | #define ECRYPTFS_TAG_1_PACKET_TYPE 0x01 | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 207 | #define ECRYPTFS_TAG_3_PACKET_TYPE 0x8C | 
 | 208 | #define ECRYPTFS_TAG_11_PACKET_TYPE 0xED | 
| Michael Halcrow | 88b4a07 | 2007-02-12 00:53:43 -0800 | [diff] [blame] | 209 | #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 Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 213 | #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 |  */ | 
 | 220 | struct 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 Halcrow | 1739895 | 2007-02-12 00:53:45 -0800 | [diff] [blame] | 229 | #define ECRYPTFS_METADATA_IN_XATTR  0x00000100 | 
 | 230 | #define ECRYPTFS_VIEW_AS_ENCRYPTED  0x00000200 | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 231 | 	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 Halcrow | 8bba066 | 2006-10-30 22:07:18 -0800 | [diff] [blame] | 242 | 	struct crypto_blkcipher *tfm; | 
| Michael Halcrow | 565d972 | 2006-10-30 22:07:17 -0800 | [diff] [blame] | 243 | 	struct crypto_hash *hash_tfm; /* Crypto context for generating | 
 | 244 | 				       * the initialization vectors */ | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 245 | 	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 Halcrow | 565d972 | 2006-10-30 22:07:17 -0800 | [diff] [blame] | 250 | 	struct mutex cs_hash_tfm_mutex; | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 251 | 	struct mutex cs_mutex; | 
 | 252 | }; | 
 | 253 |  | 
 | 254 | /* inode private data. */ | 
 | 255 | struct 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. */ | 
 | 263 | struct ecryptfs_dentry_info { | 
| Josef "Jeff" Sipek | b65d34f | 2006-12-08 02:36:34 -0800 | [diff] [blame] | 264 | 	struct path lower_path; | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 265 | 	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 |  */ | 
 | 274 | struct ecryptfs_mount_crypt_stat { | 
 | 275 | 	/* Pointers to memory we do not own, do not free these */ | 
 | 276 | #define ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED 0x00000001 | 
| Michael Halcrow | 1739895 | 2007-02-12 00:53:45 -0800 | [diff] [blame] | 277 | #define ECRYPTFS_XATTR_METADATA_ENABLED        0x00000002 | 
 | 278 | #define ECRYPTFS_ENCRYPTED_VIEW_ENABLED        0x00000004 | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 279 | 	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 Halcrow | 8bba066 | 2006-10-30 22:07:18 -0800 | [diff] [blame] | 283 | 	struct crypto_blkcipher *global_key_tfm; | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 284 | 	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. */ | 
 | 291 | struct ecryptfs_sb_info { | 
 | 292 | 	struct super_block *wsi_sb; | 
 | 293 | 	struct ecryptfs_mount_crypt_stat mount_crypt_stat; | 
 | 294 | }; | 
 | 295 |  | 
 | 296 | /* file private data. */ | 
 | 297 | struct ecryptfs_file_info { | 
 | 298 | 	struct file *wfi_file; | 
 | 299 | 	struct ecryptfs_crypt_stat *crypt_stat; | 
 | 300 | }; | 
 | 301 |  | 
 | 302 | /* auth_tok <=> encrypted_session_key mappings */ | 
 | 303 | struct 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 Halcrow | 88b4a07 | 2007-02-12 00:53:43 -0800 | [diff] [blame] | 309 | struct ecryptfs_message { | 
 | 310 | 	u32 index; | 
 | 311 | 	u32 data_len; | 
 | 312 | 	u8 data[]; | 
 | 313 | }; | 
 | 314 |  | 
 | 315 | struct 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 Halcrow | 88b4a07 | 2007-02-12 00:53:43 -0800 | [diff] [blame] | 328 | extern unsigned int ecryptfs_transport; | 
 | 329 |  | 
 | 330 | struct ecryptfs_daemon_id { | 
 | 331 | 	pid_t pid; | 
 | 332 | 	uid_t uid; | 
 | 333 | 	struct hlist_node id_chain; | 
 | 334 | }; | 
 | 335 |  | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 336 | static inline struct ecryptfs_file_info * | 
 | 337 | ecryptfs_file_to_private(struct file *file) | 
 | 338 | { | 
 | 339 | 	return (struct ecryptfs_file_info *)file->private_data; | 
 | 340 | } | 
 | 341 |  | 
 | 342 | static inline void | 
 | 343 | ecryptfs_set_file_private(struct file *file, | 
 | 344 | 			  struct ecryptfs_file_info *file_info) | 
 | 345 | { | 
 | 346 | 	file->private_data = file_info; | 
 | 347 | } | 
 | 348 |  | 
 | 349 | static inline struct file *ecryptfs_file_to_lower(struct file *file) | 
 | 350 | { | 
 | 351 | 	return ((struct ecryptfs_file_info *)file->private_data)->wfi_file; | 
 | 352 | } | 
 | 353 |  | 
 | 354 | static inline void | 
 | 355 | ecryptfs_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 |  | 
 | 361 | static inline struct ecryptfs_inode_info * | 
 | 362 | ecryptfs_inode_to_private(struct inode *inode) | 
 | 363 | { | 
 | 364 | 	return container_of(inode, struct ecryptfs_inode_info, vfs_inode); | 
 | 365 | } | 
 | 366 |  | 
 | 367 | static inline struct inode *ecryptfs_inode_to_lower(struct inode *inode) | 
 | 368 | { | 
 | 369 | 	return ecryptfs_inode_to_private(inode)->wii_inode; | 
 | 370 | } | 
 | 371 |  | 
 | 372 | static inline void | 
 | 373 | ecryptfs_set_inode_lower(struct inode *inode, struct inode *lower_inode) | 
 | 374 | { | 
 | 375 | 	ecryptfs_inode_to_private(inode)->wii_inode = lower_inode; | 
 | 376 | } | 
 | 377 |  | 
 | 378 | static inline struct ecryptfs_sb_info * | 
 | 379 | ecryptfs_superblock_to_private(struct super_block *sb) | 
 | 380 | { | 
 | 381 | 	return (struct ecryptfs_sb_info *)sb->s_fs_info; | 
 | 382 | } | 
 | 383 |  | 
 | 384 | static inline void | 
 | 385 | ecryptfs_set_superblock_private(struct super_block *sb, | 
 | 386 | 				struct ecryptfs_sb_info *sb_info) | 
 | 387 | { | 
 | 388 | 	sb->s_fs_info = sb_info; | 
 | 389 | } | 
 | 390 |  | 
 | 391 | static inline struct super_block * | 
 | 392 | ecryptfs_superblock_to_lower(struct super_block *sb) | 
 | 393 | { | 
 | 394 | 	return ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb; | 
 | 395 | } | 
 | 396 |  | 
 | 397 | static inline void | 
 | 398 | ecryptfs_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 |  | 
 | 404 | static inline struct ecryptfs_dentry_info * | 
 | 405 | ecryptfs_dentry_to_private(struct dentry *dentry) | 
 | 406 | { | 
 | 407 | 	return (struct ecryptfs_dentry_info *)dentry->d_fsdata; | 
 | 408 | } | 
 | 409 |  | 
 | 410 | static inline void | 
 | 411 | ecryptfs_set_dentry_private(struct dentry *dentry, | 
 | 412 | 			    struct ecryptfs_dentry_info *dentry_info) | 
 | 413 | { | 
 | 414 | 	dentry->d_fsdata = dentry_info; | 
 | 415 | } | 
 | 416 |  | 
 | 417 | static inline struct dentry * | 
 | 418 | ecryptfs_dentry_to_lower(struct dentry *dentry) | 
 | 419 | { | 
| Josef "Jeff" Sipek | b65d34f | 2006-12-08 02:36:34 -0800 | [diff] [blame] | 420 | 	return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry; | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 421 | } | 
 | 422 |  | 
 | 423 | static inline void | 
 | 424 | ecryptfs_set_dentry_lower(struct dentry *dentry, struct dentry *lower_dentry) | 
 | 425 | { | 
| Josef "Jeff" Sipek | b65d34f | 2006-12-08 02:36:34 -0800 | [diff] [blame] | 426 | 	((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry = | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 427 | 		lower_dentry; | 
 | 428 | } | 
 | 429 |  | 
 | 430 | static inline struct vfsmount * | 
 | 431 | ecryptfs_dentry_to_lower_mnt(struct dentry *dentry) | 
 | 432 | { | 
| Josef "Jeff" Sipek | b65d34f | 2006-12-08 02:36:34 -0800 | [diff] [blame] | 433 | 	return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt; | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 434 | } | 
 | 435 |  | 
 | 436 | static inline void | 
 | 437 | ecryptfs_set_dentry_lower_mnt(struct dentry *dentry, struct vfsmount *lower_mnt) | 
 | 438 | { | 
| Josef "Jeff" Sipek | b65d34f | 2006-12-08 02:36:34 -0800 | [diff] [blame] | 439 | 	((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt = | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 440 | 		lower_mnt; | 
 | 441 | } | 
 | 442 |  | 
 | 443 | #define ecryptfs_printk(type, fmt, arg...) \ | 
 | 444 |         __ecryptfs_printk(type "%s: " fmt, __FUNCTION__, ## arg); | 
 | 445 | void __ecryptfs_printk(const char *fmt, ...); | 
 | 446 |  | 
 | 447 | extern const struct file_operations ecryptfs_main_fops; | 
 | 448 | extern const struct file_operations ecryptfs_dir_fops; | 
| Arjan van de Ven | 754661f | 2007-02-12 00:55:38 -0800 | [diff] [blame] | 449 | extern const struct inode_operations ecryptfs_main_iops; | 
 | 450 | extern const struct inode_operations ecryptfs_dir_iops; | 
 | 451 | extern const struct inode_operations ecryptfs_symlink_iops; | 
| Josef 'Jeff' Sipek | ee9b6d6 | 2007-02-12 00:55:41 -0800 | [diff] [blame] | 452 | extern const struct super_operations ecryptfs_sops; | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 453 | extern struct dentry_operations ecryptfs_dops; | 
 | 454 | extern struct address_space_operations ecryptfs_aops; | 
 | 455 | extern int ecryptfs_verbosity; | 
| Michael Halcrow | 88b4a07 | 2007-02-12 00:53:43 -0800 | [diff] [blame] | 456 | extern unsigned int ecryptfs_message_buf_len; | 
 | 457 | extern signed long ecryptfs_message_wait_timeout; | 
 | 458 | extern unsigned int ecryptfs_number_of_users; | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 459 |  | 
 | 460 | extern struct kmem_cache *ecryptfs_auth_tok_list_item_cache; | 
 | 461 | extern struct kmem_cache *ecryptfs_file_info_cache; | 
 | 462 | extern struct kmem_cache *ecryptfs_dentry_info_cache; | 
 | 463 | extern struct kmem_cache *ecryptfs_inode_info_cache; | 
 | 464 | extern struct kmem_cache *ecryptfs_sb_info_cache; | 
 | 465 | extern struct kmem_cache *ecryptfs_header_cache_0; | 
 | 466 | extern struct kmem_cache *ecryptfs_header_cache_1; | 
 | 467 | extern struct kmem_cache *ecryptfs_header_cache_2; | 
| Michael Halcrow | dd2a3b7 | 2007-02-12 00:53:46 -0800 | [diff] [blame] | 468 | extern struct kmem_cache *ecryptfs_xattr_cache; | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 469 | extern struct kmem_cache *ecryptfs_lower_page_cache; | 
| Michael Halcrow | eb95e7f | 2007-02-16 01:28:40 -0800 | [diff] [blame] | 470 | extern struct kmem_cache *ecryptfs_key_record_cache; | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 471 |  | 
 | 472 | int ecryptfs_interpose(struct dentry *hidden_dentry, | 
 | 473 | 		       struct dentry *this_dentry, struct super_block *sb, | 
 | 474 | 		       int flag); | 
 | 475 | int ecryptfs_fill_zeros(struct file *file, loff_t new_length); | 
 | 476 | int ecryptfs_decode_filename(struct ecryptfs_crypt_stat *crypt_stat, | 
 | 477 | 			     const char *name, int length, | 
 | 478 | 			     char **decrypted_name); | 
 | 479 | int ecryptfs_encode_filename(struct ecryptfs_crypt_stat *crypt_stat, | 
 | 480 | 			     const char *name, int length, | 
 | 481 | 			     char **encoded_name); | 
 | 482 | struct dentry *ecryptfs_lower_dentry(struct dentry *this_dentry); | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 483 | void ecryptfs_dump_hex(char *data, int bytes); | 
 | 484 | int virt_to_scatterlist(const void *addr, int size, struct scatterlist *sg, | 
 | 485 | 			int sg_size); | 
 | 486 | int ecryptfs_compute_root_iv(struct ecryptfs_crypt_stat *crypt_stat); | 
 | 487 | void ecryptfs_rotate_iv(unsigned char *iv); | 
 | 488 | void ecryptfs_init_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat); | 
 | 489 | void ecryptfs_destruct_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat); | 
 | 490 | void ecryptfs_destruct_mount_crypt_stat( | 
 | 491 | 	struct ecryptfs_mount_crypt_stat *mount_crypt_stat); | 
 | 492 | int ecryptfs_init_crypt_ctx(struct ecryptfs_crypt_stat *crypt_stat); | 
| Michael Halcrow | 8bba066 | 2006-10-30 22:07:18 -0800 | [diff] [blame] | 493 | int ecryptfs_crypto_api_algify_cipher_name(char **algified_name, | 
 | 494 | 					   char *cipher_name, | 
 | 495 | 					   char *chaining_modifier); | 
| Michael Halcrow | dd2a3b7 | 2007-02-12 00:53:46 -0800 | [diff] [blame] | 496 | #define ECRYPTFS_LOWER_I_MUTEX_NOT_HELD 0 | 
 | 497 | #define ECRYPTFS_LOWER_I_MUTEX_HELD 1 | 
 | 498 | int 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 Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 503 | int 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); | 
 | 507 | int | 
 | 508 | ecryptfs_commit_lower_page(struct page *lower_page, struct inode *lower_inode, | 
 | 509 | 			   struct file *lower_file, int byte_offset, | 
 | 510 | 			   int region_size); | 
 | 511 | int ecryptfs_copy_page_to_lower(struct page *page, struct inode *lower_inode, | 
 | 512 | 				struct file *lower_file); | 
 | 513 | int ecryptfs_do_readpage(struct file *file, struct page *page, | 
 | 514 | 			 pgoff_t lower_page_index); | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 515 | int ecryptfs_writepage_and_release_lower_page(struct page *lower_page, | 
 | 516 | 					      struct inode *lower_inode, | 
 | 517 | 					      struct writeback_control *wbc); | 
 | 518 | int ecryptfs_encrypt_page(struct ecryptfs_page_crypt_context *ctx); | 
 | 519 | int ecryptfs_decrypt_page(struct file *file, struct page *page); | 
| Michael Halcrow | dd2a3b7 | 2007-02-12 00:53:46 -0800 | [diff] [blame] | 520 | int ecryptfs_write_metadata(struct dentry *ecryptfs_dentry, | 
 | 521 | 			    struct file *lower_file); | 
 | 522 | int ecryptfs_read_metadata(struct dentry *ecryptfs_dentry, | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 523 | 			   struct file *lower_file); | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 524 | int ecryptfs_new_file_context(struct dentry *ecryptfs_dentry); | 
| Michael Halcrow | dd2a3b7 | 2007-02-12 00:53:46 -0800 | [diff] [blame] | 525 | int ecryptfs_read_and_validate_header_region(char *data, struct dentry *dentry, | 
 | 526 | 					     struct vfsmount *mnt); | 
 | 527 | int ecryptfs_read_and_validate_xattr_region(char *page_virt, | 
 | 528 | 					    struct dentry *ecryptfs_dentry); | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 529 | u16 ecryptfs_code_for_cipher_string(struct ecryptfs_crypt_stat *crypt_stat); | 
 | 530 | int ecryptfs_cipher_code_to_string(char *str, u16 cipher_code); | 
 | 531 | void ecryptfs_set_default_sizes(struct ecryptfs_crypt_stat *crypt_stat); | 
 | 532 | int 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); | 
 | 536 | int process_request_key_err(long err_code); | 
 | 537 | int | 
 | 538 | ecryptfs_parse_packet_set(struct ecryptfs_crypt_stat *crypt_stat, | 
 | 539 | 			  unsigned char *src, struct dentry *ecryptfs_dentry); | 
 | 540 | int ecryptfs_truncate(struct dentry *dentry, loff_t new_length); | 
 | 541 | int | 
| Michael Halcrow | 8bba066 | 2006-10-30 22:07:18 -0800 | [diff] [blame] | 542 | ecryptfs_process_cipher(struct crypto_blkcipher **key_tfm, char *cipher_name, | 
| Michael Halcrow | e5d9cbd | 2006-10-30 22:07:16 -0800 | [diff] [blame] | 543 | 			size_t *key_size); | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 544 | int ecryptfs_inode_test(struct inode *inode, void *candidate_lower_inode); | 
 | 545 | int ecryptfs_inode_set(struct inode *inode, void *lower_inode); | 
 | 546 | void ecryptfs_init_inode(struct inode *inode, struct inode *lower_inode); | 
| Michael Halcrow | 7ff1d74 | 2006-10-30 22:07:19 -0800 | [diff] [blame] | 547 | int ecryptfs_open_lower_file(struct file **lower_file, | 
 | 548 | 			     struct dentry *lower_dentry, | 
 | 549 | 			     struct vfsmount *lower_mnt, int flags); | 
 | 550 | int ecryptfs_close_lower_file(struct file *lower_file); | 
| Michael Halcrow | dd2a3b7 | 2007-02-12 00:53:46 -0800 | [diff] [blame] | 551 | ssize_t ecryptfs_getxattr(struct dentry *dentry, const char *name, void *value, | 
 | 552 | 			  size_t size); | 
 | 553 | int | 
 | 554 | ecryptfs_setxattr(struct dentry *dentry, const char *name, const void *value, | 
 | 555 | 		  size_t size, int flags); | 
| Michael Halcrow | e77a56d | 2007-02-12 00:53:47 -0800 | [diff] [blame] | 556 | int ecryptfs_read_xattr_region(char *page_virt, struct dentry *ecryptfs_dentry); | 
| Michael Halcrow | 88b4a07 | 2007-02-12 00:53:43 -0800 | [diff] [blame] | 557 | int ecryptfs_process_helo(unsigned int transport, uid_t uid, pid_t pid); | 
 | 558 | int ecryptfs_process_quit(uid_t uid, pid_t pid); | 
| Michael Halcrow | dddfa46 | 2007-02-12 00:53:44 -0800 | [diff] [blame] | 559 | int ecryptfs_process_response(struct ecryptfs_message *msg, uid_t uid, | 
 | 560 | 			      pid_t pid, u32 seq); | 
| Michael Halcrow | 88b4a07 | 2007-02-12 00:53:43 -0800 | [diff] [blame] | 561 | int ecryptfs_send_message(unsigned int transport, char *data, int data_len, | 
 | 562 | 			  struct ecryptfs_msg_ctx **msg_ctx); | 
 | 563 | int ecryptfs_wait_for_response(struct ecryptfs_msg_ctx *msg_ctx, | 
 | 564 | 			       struct ecryptfs_message **emsg); | 
 | 565 | int ecryptfs_init_messaging(unsigned int transport); | 
 | 566 | void ecryptfs_release_messaging(unsigned int transport); | 
 | 567 |  | 
 | 568 | int 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); | 
 | 571 | int ecryptfs_init_netlink(void); | 
 | 572 | void ecryptfs_release_netlink(void); | 
 | 573 |  | 
 | 574 | int 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); | 
 | 577 | int ecryptfs_init_connector(void); | 
 | 578 | void ecryptfs_release_connector(void); | 
| Michael Halcrow | e77a56d | 2007-02-12 00:53:47 -0800 | [diff] [blame] | 579 | void | 
 | 580 | ecryptfs_write_header_metadata(char *virt, | 
 | 581 | 			       struct ecryptfs_crypt_stat *crypt_stat, | 
 | 582 | 			       size_t *written); | 
| Michael Halcrow | 240e2df | 2007-06-27 14:09:44 -0700 | [diff] [blame] | 583 | int ecryptfs_write_zeros(struct file *file, pgoff_t index, int start, | 
 | 584 | 			 int num_zeros); | 
| Michael Halcrow | 88b4a07 | 2007-02-12 00:53:43 -0800 | [diff] [blame] | 585 |  | 
| Michael Halcrow | 237fead | 2006-10-04 02:16:22 -0700 | [diff] [blame] | 586 | #endif /* #ifndef ECRYPTFS_KERNEL_H */ |