1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /**
3 * eCryptfs: Linux filesystem encryption layer
4 * Kernel declarations.
5 *
6 * Copyright (C) 1997-2003 Erez Zadok
7 * Copyright (C) 2001-2003 Stony Brook University
8 * Copyright (C) 2004-2008 International Business Machines Corp.
9 * Author(s): Michael A. Halcrow <mahalcro@us.ibm.com>
10 * Trevor S. Highland <trevor.highland@gmail.com>
11 * Tyler Hicks <code@tyhicks.com>
12 */
13
14 #ifndef ECRYPTFS_KERNEL_H
15 #define ECRYPTFS_KERNEL_H
16
17 #include <crypto/skcipher.h>
18 #include <keys/user-type.h>
19 #include <keys/encrypted-type.h>
20 #include <linux/kernel.h>
21 #include <linux/fs.h>
22 #include <linux/fs_stack.h>
23 #include <linux/namei.h>
24 #include <linux/scatterlist.h>
25 #include <linux/hash.h>
26 #include <linux/nsproxy.h>
27 #include <linux/backing-dev.h>
28 #include <linux/ecryptfs.h>
29
30 #define ECRYPTFS_DEFAULT_IV_BYTES 16
31 #define ECRYPTFS_DEFAULT_EXTENT_SIZE 4096
32 #define ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE 8192
33 #define ECRYPTFS_DEFAULT_MSG_CTX_ELEMS 32
34 #define ECRYPTFS_DEFAULT_SEND_TIMEOUT HZ
35 #define ECRYPTFS_MAX_MSG_CTX_TTL (HZ*3)
36 #define ECRYPTFS_DEFAULT_NUM_USERS 4
37 #define ECRYPTFS_MAX_NUM_USERS 32768
38 #define ECRYPTFS_XATTR_NAME "user.ecryptfs"
39
40 void ecryptfs_dump_auth_tok(struct ecryptfs_auth_tok *auth_tok);
41 static inline void
ecryptfs_to_hex(char * dst,char * src,size_t src_size)42 ecryptfs_to_hex(char *dst, char *src, size_t src_size)
43 {
44 char *end = bin2hex(dst, src, src_size);
45 *end = '\0';
46 }
47
48 extern void ecryptfs_from_hex(char *dst, char *src, int dst_size);
49
50 struct ecryptfs_key_record {
51 unsigned char type;
52 size_t enc_key_size;
53 unsigned char sig[ECRYPTFS_SIG_SIZE];
54 unsigned char enc_key[ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES];
55 };
56
57 struct ecryptfs_auth_tok_list {
58 struct ecryptfs_auth_tok *auth_tok;
59 struct list_head list;
60 };
61
62 struct ecryptfs_crypt_stat;
63 struct ecryptfs_mount_crypt_stat;
64
65 struct ecryptfs_page_crypt_context {
66 struct page *page;
67 #define ECRYPTFS_PREPARE_COMMIT_MODE 0
68 #define ECRYPTFS_WRITEPAGE_MODE 1
69 unsigned int mode;
70 union {
71 struct file *lower_file;
72 struct writeback_control *wbc;
73 } param;
74 };
75
76 #if defined(CONFIG_ENCRYPTED_KEYS) || defined(CONFIG_ENCRYPTED_KEYS_MODULE)
77 static inline struct ecryptfs_auth_tok *
ecryptfs_get_encrypted_key_payload_data(struct key * key)78 ecryptfs_get_encrypted_key_payload_data(struct key *key)
79 {
80 struct encrypted_key_payload *payload;
81
82 if (key->type != &key_type_encrypted)
83 return NULL;
84
85 payload = key->payload.data[0];
86 if (!payload)
87 return ERR_PTR(-EKEYREVOKED);
88
89 return (struct ecryptfs_auth_tok *)payload->payload_data;
90 }
91
ecryptfs_get_encrypted_key(char * sig)92 static inline struct key *ecryptfs_get_encrypted_key(char *sig)
93 {
94 return request_key(&key_type_encrypted, sig, NULL);
95 }
96
97 #else
98 static inline struct ecryptfs_auth_tok *
ecryptfs_get_encrypted_key_payload_data(struct key * key)99 ecryptfs_get_encrypted_key_payload_data(struct key *key)
100 {
101 return NULL;
102 }
103
ecryptfs_get_encrypted_key(char * sig)104 static inline struct key *ecryptfs_get_encrypted_key(char *sig)
105 {
106 return ERR_PTR(-ENOKEY);
107 }
108
109 #endif /* CONFIG_ENCRYPTED_KEYS */
110
111 static inline struct ecryptfs_auth_tok *
ecryptfs_get_key_payload_data(struct key * key)112 ecryptfs_get_key_payload_data(struct key *key)
113 {
114 struct ecryptfs_auth_tok *auth_tok;
115 struct user_key_payload *ukp;
116
117 auth_tok = ecryptfs_get_encrypted_key_payload_data(key);
118 if (auth_tok)
119 return auth_tok;
120
121 ukp = user_key_payload_locked(key);
122 if (!ukp)
123 return ERR_PTR(-EKEYREVOKED);
124
125 return (struct ecryptfs_auth_tok *)ukp->data;
126 }
127
128 #define ECRYPTFS_MAX_KEYSET_SIZE 1024
129 #define ECRYPTFS_MAX_CIPHER_NAME_SIZE 31
130 #define ECRYPTFS_MAX_NUM_ENC_KEYS 64
131 #define ECRYPTFS_MAX_IV_BYTES 16 /* 128 bits */
132 #define ECRYPTFS_SALT_BYTES 2
133 #define MAGIC_ECRYPTFS_MARKER 0x3c81b7f5
134 #define MAGIC_ECRYPTFS_MARKER_SIZE_BYTES 8 /* 4*2 */
135 #define ECRYPTFS_FILE_SIZE_BYTES (sizeof(u64))
136 #define ECRYPTFS_SIZE_AND_MARKER_BYTES (ECRYPTFS_FILE_SIZE_BYTES \
137 + MAGIC_ECRYPTFS_MARKER_SIZE_BYTES)
138 #define ECRYPTFS_DEFAULT_CIPHER "aes"
139 #define ECRYPTFS_DEFAULT_KEY_BYTES 16
140 #define ECRYPTFS_DEFAULT_HASH "md5"
141 #define ECRYPTFS_TAG_70_DIGEST ECRYPTFS_DEFAULT_HASH
142 #define ECRYPTFS_TAG_1_PACKET_TYPE 0x01
143 #define ECRYPTFS_TAG_3_PACKET_TYPE 0x8C
144 #define ECRYPTFS_TAG_11_PACKET_TYPE 0xED
145 #define ECRYPTFS_TAG_64_PACKET_TYPE 0x40
146 #define ECRYPTFS_TAG_65_PACKET_TYPE 0x41
147 #define ECRYPTFS_TAG_66_PACKET_TYPE 0x42
148 #define ECRYPTFS_TAG_67_PACKET_TYPE 0x43
149 #define ECRYPTFS_TAG_70_PACKET_TYPE 0x46 /* FNEK-encrypted filename
150 * as dentry name */
151 #define ECRYPTFS_TAG_71_PACKET_TYPE 0x47 /* FNEK-encrypted filename in
152 * metadata */
153 #define ECRYPTFS_TAG_72_PACKET_TYPE 0x48 /* FEK-encrypted filename as
154 * dentry name */
155 #define ECRYPTFS_TAG_73_PACKET_TYPE 0x49 /* FEK-encrypted filename as
156 * metadata */
157 #define ECRYPTFS_MIN_PKT_LEN_SIZE 1 /* Min size to specify packet length */
158 #define ECRYPTFS_MAX_PKT_LEN_SIZE 2 /* Pass at least this many bytes to
159 * ecryptfs_parse_packet_length() and
160 * ecryptfs_write_packet_length()
161 */
162 /* Constraint: ECRYPTFS_FILENAME_MIN_RANDOM_PREPEND_BYTES >=
163 * ECRYPTFS_MAX_IV_BYTES */
164 #define ECRYPTFS_FILENAME_MIN_RANDOM_PREPEND_BYTES 16
165 #define ECRYPTFS_NON_NULL 0x42 /* A reasonable substitute for NULL */
166 #define MD5_DIGEST_SIZE 16
167 #define ECRYPTFS_TAG_70_DIGEST_SIZE MD5_DIGEST_SIZE
168 #define ECRYPTFS_TAG_70_MIN_METADATA_SIZE (1 + ECRYPTFS_MIN_PKT_LEN_SIZE \
169 + ECRYPTFS_SIG_SIZE + 1 + 1)
170 #define ECRYPTFS_TAG_70_MAX_METADATA_SIZE (1 + ECRYPTFS_MAX_PKT_LEN_SIZE \
171 + ECRYPTFS_SIG_SIZE + 1 + 1)
172 #define ECRYPTFS_FEK_ENCRYPTED_FILENAME_PREFIX "ECRYPTFS_FEK_ENCRYPTED."
173 #define ECRYPTFS_FEK_ENCRYPTED_FILENAME_PREFIX_SIZE 23
174 #define ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX "ECRYPTFS_FNEK_ENCRYPTED."
175 #define ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX_SIZE 24
176 #define ECRYPTFS_ENCRYPTED_DENTRY_NAME_LEN (18 + 1 + 4 + 1 + 32)
177
178 #ifdef CONFIG_ECRYPT_FS_MESSAGING
179 # define ECRYPTFS_VERSIONING_MASK_MESSAGING (ECRYPTFS_VERSIONING_DEVMISC \
180 | ECRYPTFS_VERSIONING_PUBKEY)
181 #else
182 # define ECRYPTFS_VERSIONING_MASK_MESSAGING 0
183 #endif
184
185 #define ECRYPTFS_VERSIONING_MASK (ECRYPTFS_VERSIONING_PASSPHRASE \
186 | ECRYPTFS_VERSIONING_PLAINTEXT_PASSTHROUGH \
187 | ECRYPTFS_VERSIONING_XATTR \
188 | ECRYPTFS_VERSIONING_MULTKEY \
189 | ECRYPTFS_VERSIONING_MASK_MESSAGING \
190 | ECRYPTFS_VERSIONING_FILENAME_ENCRYPTION)
191 struct ecryptfs_key_sig {
192 struct list_head crypt_stat_list;
193 char keysig[ECRYPTFS_SIG_SIZE_HEX + 1];
194 };
195
196 struct ecryptfs_filename {
197 struct list_head crypt_stat_list;
198 #define ECRYPTFS_FILENAME_CONTAINS_DECRYPTED 0x00000001
199 u32 flags;
200 u32 seq_no;
201 char *filename;
202 char *encrypted_filename;
203 size_t filename_size;
204 size_t encrypted_filename_size;
205 char fnek_sig[ECRYPTFS_SIG_SIZE_HEX];
206 char dentry_name[ECRYPTFS_ENCRYPTED_DENTRY_NAME_LEN + 1];
207 };
208
209 /**
210 * This is the primary struct associated with each encrypted file.
211 *
212 * TODO: cache align/pack?
213 */
214 struct ecryptfs_crypt_stat {
215 #define ECRYPTFS_STRUCT_INITIALIZED 0x00000001
216 #define ECRYPTFS_POLICY_APPLIED 0x00000002
217 #define ECRYPTFS_ENCRYPTED 0x00000004
218 #define ECRYPTFS_SECURITY_WARNING 0x00000008
219 #define ECRYPTFS_ENABLE_HMAC 0x00000010
220 #define ECRYPTFS_ENCRYPT_IV_PAGES 0x00000020
221 #define ECRYPTFS_KEY_VALID 0x00000040
222 #define ECRYPTFS_METADATA_IN_XATTR 0x00000080
223 #define ECRYPTFS_VIEW_AS_ENCRYPTED 0x00000100
224 #define ECRYPTFS_KEY_SET 0x00000200
225 #define ECRYPTFS_ENCRYPT_FILENAMES 0x00000400
226 #define ECRYPTFS_ENCFN_USE_MOUNT_FNEK 0x00000800
227 #define ECRYPTFS_ENCFN_USE_FEK 0x00001000
228 #define ECRYPTFS_UNLINK_SIGS 0x00002000
229 #define ECRYPTFS_I_SIZE_INITIALIZED 0x00004000
230 u32 flags;
231 unsigned int file_version;
232 size_t iv_bytes;
233 size_t metadata_size;
234 size_t extent_size; /* Data extent size; default is 4096 */
235 size_t key_size;
236 size_t extent_shift;
237 unsigned int extent_mask;
238 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
239 struct crypto_skcipher *tfm;
240 struct crypto_shash *hash_tfm; /* Crypto context for generating
241 * the initialization vectors */
242 unsigned char cipher[ECRYPTFS_MAX_CIPHER_NAME_SIZE + 1];
243 unsigned char key[ECRYPTFS_MAX_KEY_BYTES];
244 unsigned char root_iv[ECRYPTFS_MAX_IV_BYTES];
245 struct list_head keysig_list;
246 struct mutex keysig_list_mutex;
247 struct mutex cs_tfm_mutex;
248 struct mutex cs_mutex;
249 };
250
251 /* inode private data. */
252 struct ecryptfs_inode_info {
253 struct inode vfs_inode;
254 struct inode *wii_inode;
255 struct mutex lower_file_mutex;
256 atomic_t lower_file_count;
257 struct file *lower_file;
258 struct ecryptfs_crypt_stat crypt_stat;
259 };
260
261 /**
262 * ecryptfs_global_auth_tok - A key used to encrypt all new files under the mountpoint
263 * @flags: Status flags
264 * @mount_crypt_stat_list: These auth_toks hang off the mount-wide
265 * cryptographic context. Every time a new
266 * inode comes into existence, eCryptfs copies
267 * the auth_toks on that list to the set of
268 * auth_toks on the inode's crypt_stat
269 * @global_auth_tok_key: The key from the user's keyring for the sig
270 * @global_auth_tok: The key contents
271 * @sig: The key identifier
272 *
273 * ecryptfs_global_auth_tok structs refer to authentication token keys
274 * in the user keyring that apply to newly created files. A list of
275 * these objects hangs off of the mount_crypt_stat struct for any
276 * given eCryptfs mount. This struct maintains a reference to both the
277 * key contents and the key itself so that the key can be put on
278 * unmount.
279 */
280 struct ecryptfs_global_auth_tok {
281 #define ECRYPTFS_AUTH_TOK_INVALID 0x00000001
282 #define ECRYPTFS_AUTH_TOK_FNEK 0x00000002
283 u32 flags;
284 struct list_head mount_crypt_stat_list;
285 struct key *global_auth_tok_key;
286 unsigned char sig[ECRYPTFS_SIG_SIZE_HEX + 1];
287 };
288
289 /**
290 * ecryptfs_key_tfm - Persistent key tfm
291 * @key_tfm: crypto API handle to the key
292 * @key_size: Key size in bytes
293 * @key_tfm_mutex: Mutex to ensure only one operation in eCryptfs is
294 * using the persistent TFM at any point in time
295 * @key_tfm_list: Handle to hang this off the module-wide TFM list
296 * @cipher_name: String name for the cipher for this TFM
297 *
298 * Typically, eCryptfs will use the same ciphers repeatedly throughout
299 * the course of its operations. In order to avoid unnecessarily
300 * destroying and initializing the same cipher repeatedly, eCryptfs
301 * keeps a list of crypto API contexts around to use when needed.
302 */
303 struct ecryptfs_key_tfm {
304 struct crypto_skcipher *key_tfm;
305 size_t key_size;
306 struct mutex key_tfm_mutex;
307 struct list_head key_tfm_list;
308 unsigned char cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE + 1];
309 };
310
311 extern struct mutex key_tfm_list_mutex;
312
313 /**
314 * This struct is to enable a mount-wide passphrase/salt combo. This
315 * is more or less a stopgap to provide similar functionality to other
316 * crypto filesystems like EncFS or CFS until full policy support is
317 * implemented in eCryptfs.
318 */
319 struct ecryptfs_mount_crypt_stat {
320 /* Pointers to memory we do not own, do not free these */
321 #define ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED 0x00000001
322 #define ECRYPTFS_XATTR_METADATA_ENABLED 0x00000002
323 #define ECRYPTFS_ENCRYPTED_VIEW_ENABLED 0x00000004
324 #define ECRYPTFS_MOUNT_CRYPT_STAT_INITIALIZED 0x00000008
325 #define ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES 0x00000010
326 #define ECRYPTFS_GLOBAL_ENCFN_USE_MOUNT_FNEK 0x00000020
327 #define ECRYPTFS_GLOBAL_ENCFN_USE_FEK 0x00000040
328 #define ECRYPTFS_GLOBAL_MOUNT_AUTH_TOK_ONLY 0x00000080
329 u32 flags;
330 struct list_head global_auth_tok_list;
331 struct mutex global_auth_tok_list_mutex;
332 size_t global_default_cipher_key_size;
333 size_t global_default_fn_cipher_key_bytes;
334 unsigned char global_default_cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE
335 + 1];
336 unsigned char global_default_fn_cipher_name[
337 ECRYPTFS_MAX_CIPHER_NAME_SIZE + 1];
338 char global_default_fnek_sig[ECRYPTFS_SIG_SIZE_HEX + 1];
339 };
340
341 /* superblock private data. */
342 struct ecryptfs_sb_info {
343 struct super_block *wsi_sb;
344 struct vfsmount *lower_mnt;
345 struct ecryptfs_mount_crypt_stat mount_crypt_stat;
346 };
347
348 /* file private data. */
349 struct ecryptfs_file_info {
350 struct file *wfi_file;
351 struct ecryptfs_crypt_stat *crypt_stat;
352 };
353
354 /* auth_tok <=> encrypted_session_key mappings */
355 struct ecryptfs_auth_tok_list_item {
356 unsigned char encrypted_session_key[ECRYPTFS_MAX_KEY_BYTES];
357 struct list_head list;
358 struct ecryptfs_auth_tok auth_tok;
359 };
360
361 struct ecryptfs_message {
362 /* Can never be greater than ecryptfs_message_buf_len */
363 /* Used to find the parent msg_ctx */
364 /* Inherits from msg_ctx->index */
365 u32 index;
366 u32 data_len;
367 u8 data[];
368 };
369
370 struct ecryptfs_msg_ctx {
371 #define ECRYPTFS_MSG_CTX_STATE_FREE 0x01
372 #define ECRYPTFS_MSG_CTX_STATE_PENDING 0x02
373 #define ECRYPTFS_MSG_CTX_STATE_DONE 0x03
374 #define ECRYPTFS_MSG_CTX_STATE_NO_REPLY 0x04
375 u8 state;
376 #define ECRYPTFS_MSG_HELO 100
377 #define ECRYPTFS_MSG_QUIT 101
378 #define ECRYPTFS_MSG_REQUEST 102
379 #define ECRYPTFS_MSG_RESPONSE 103
380 u8 type;
381 u32 index;
382 /* Counter converts to a sequence number. Each message sent
383 * out for which we expect a response has an associated
384 * sequence number. The response must have the same sequence
385 * number as the counter for the msg_stc for the message to be
386 * valid. */
387 u32 counter;
388 size_t msg_size;
389 struct ecryptfs_message *msg;
390 struct task_struct *task;
391 struct list_head node;
392 struct list_head daemon_out_list;
393 struct mutex mux;
394 };
395
396 struct ecryptfs_daemon {
397 #define ECRYPTFS_DAEMON_IN_READ 0x00000001
398 #define ECRYPTFS_DAEMON_IN_POLL 0x00000002
399 #define ECRYPTFS_DAEMON_ZOMBIE 0x00000004
400 #define ECRYPTFS_DAEMON_MISCDEV_OPEN 0x00000008
401 u32 flags;
402 u32 num_queued_msg_ctx;
403 struct file *file;
404 struct mutex mux;
405 struct list_head msg_ctx_out_queue;
406 wait_queue_head_t wait;
407 struct hlist_node euid_chain;
408 };
409
410 #ifdef CONFIG_ECRYPT_FS_MESSAGING
411 extern struct mutex ecryptfs_daemon_hash_mux;
412 #endif
413
414 static inline size_t
ecryptfs_lower_header_size(struct ecryptfs_crypt_stat * crypt_stat)415 ecryptfs_lower_header_size(struct ecryptfs_crypt_stat *crypt_stat)
416 {
417 if (crypt_stat->flags & ECRYPTFS_METADATA_IN_XATTR)
418 return 0;
419 return crypt_stat->metadata_size;
420 }
421
422 static inline struct ecryptfs_file_info *
ecryptfs_file_to_private(struct file * file)423 ecryptfs_file_to_private(struct file *file)
424 {
425 return file->private_data;
426 }
427
428 static inline void
ecryptfs_set_file_private(struct file * file,struct ecryptfs_file_info * file_info)429 ecryptfs_set_file_private(struct file *file,
430 struct ecryptfs_file_info *file_info)
431 {
432 file->private_data = file_info;
433 }
434
ecryptfs_file_to_lower(struct file * file)435 static inline struct file *ecryptfs_file_to_lower(struct file *file)
436 {
437 return ((struct ecryptfs_file_info *)file->private_data)->wfi_file;
438 }
439
440 static inline void
ecryptfs_set_file_lower(struct file * file,struct file * lower_file)441 ecryptfs_set_file_lower(struct file *file, struct file *lower_file)
442 {
443 ((struct ecryptfs_file_info *)file->private_data)->wfi_file =
444 lower_file;
445 }
446
447 static inline struct ecryptfs_inode_info *
ecryptfs_inode_to_private(struct inode * inode)448 ecryptfs_inode_to_private(struct inode *inode)
449 {
450 return container_of(inode, struct ecryptfs_inode_info, vfs_inode);
451 }
452
ecryptfs_inode_to_lower(struct inode * inode)453 static inline struct inode *ecryptfs_inode_to_lower(struct inode *inode)
454 {
455 return ecryptfs_inode_to_private(inode)->wii_inode;
456 }
457
458 static inline void
ecryptfs_set_inode_lower(struct inode * inode,struct inode * lower_inode)459 ecryptfs_set_inode_lower(struct inode *inode, struct inode *lower_inode)
460 {
461 ecryptfs_inode_to_private(inode)->wii_inode = lower_inode;
462 }
463
464 static inline struct ecryptfs_sb_info *
ecryptfs_superblock_to_private(struct super_block * sb)465 ecryptfs_superblock_to_private(struct super_block *sb)
466 {
467 return (struct ecryptfs_sb_info *)sb->s_fs_info;
468 }
469
470 static inline void
ecryptfs_set_superblock_private(struct super_block * sb,struct ecryptfs_sb_info * sb_info)471 ecryptfs_set_superblock_private(struct super_block *sb,
472 struct ecryptfs_sb_info *sb_info)
473 {
474 sb->s_fs_info = sb_info;
475 }
476
477 static inline struct super_block *
ecryptfs_superblock_to_lower(struct super_block * sb)478 ecryptfs_superblock_to_lower(struct super_block *sb)
479 {
480 return ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb;
481 }
482
483 static inline void
ecryptfs_set_superblock_lower(struct super_block * sb,struct super_block * lower_sb)484 ecryptfs_set_superblock_lower(struct super_block *sb,
485 struct super_block *lower_sb)
486 {
487 ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb = lower_sb;
488 }
489
490 static inline void
ecryptfs_set_dentry_lower(struct dentry * dentry,struct dentry * lower_dentry)491 ecryptfs_set_dentry_lower(struct dentry *dentry,
492 struct dentry *lower_dentry)
493 {
494 dentry->d_fsdata = lower_dentry;
495 }
496
497 static inline struct dentry *
ecryptfs_dentry_to_lower(struct dentry * dentry)498 ecryptfs_dentry_to_lower(struct dentry *dentry)
499 {
500 return dentry->d_fsdata;
501 }
502
503 static inline struct path
ecryptfs_lower_path(struct dentry * dentry)504 ecryptfs_lower_path(struct dentry *dentry)
505 {
506 return (struct path){
507 .mnt = ecryptfs_superblock_to_private(dentry->d_sb)->lower_mnt,
508 .dentry = ecryptfs_dentry_to_lower(dentry)
509 };
510 }
511
512 #define ecryptfs_printk(type, fmt, arg...) \
513 __ecryptfs_printk(type "%s: " fmt, __func__, ## arg)
514 __printf(1, 2)
515 void __ecryptfs_printk(const char *fmt, ...);
516
517 extern const struct file_operations ecryptfs_main_fops;
518 extern const struct file_operations ecryptfs_dir_fops;
519 extern const struct inode_operations ecryptfs_main_iops;
520 extern const struct inode_operations ecryptfs_dir_iops;
521 extern const struct inode_operations ecryptfs_symlink_iops;
522 extern const struct super_operations ecryptfs_sops;
523 extern const struct dentry_operations ecryptfs_dops;
524 extern const struct address_space_operations ecryptfs_aops;
525 extern int ecryptfs_verbosity;
526 extern unsigned int ecryptfs_message_buf_len;
527 extern signed long ecryptfs_message_wait_timeout;
528 extern unsigned int ecryptfs_number_of_users;
529
530 extern struct kmem_cache *ecryptfs_auth_tok_list_item_cache;
531 extern struct kmem_cache *ecryptfs_file_info_cache;
532 extern struct kmem_cache *ecryptfs_inode_info_cache;
533 extern struct kmem_cache *ecryptfs_sb_info_cache;
534 extern struct kmem_cache *ecryptfs_header_cache;
535 extern struct kmem_cache *ecryptfs_xattr_cache;
536 extern struct kmem_cache *ecryptfs_key_record_cache;
537 extern struct kmem_cache *ecryptfs_key_sig_cache;
538 extern struct kmem_cache *ecryptfs_global_auth_tok_cache;
539 extern struct kmem_cache *ecryptfs_key_tfm_cache;
540
541 struct inode *ecryptfs_get_inode(struct inode *lower_inode,
542 struct super_block *sb);
543 void ecryptfs_i_size_init(const char *page_virt, struct inode *inode);
544 int ecryptfs_initialize_file(struct dentry *ecryptfs_dentry,
545 struct inode *ecryptfs_inode);
546 int ecryptfs_decode_and_decrypt_filename(char **decrypted_name,
547 size_t *decrypted_name_size,
548 struct super_block *sb,
549 const char *name, size_t name_size);
550 int ecryptfs_fill_zeros(struct file *file, loff_t new_length);
551 int ecryptfs_encrypt_and_encode_filename(
552 char **encoded_name,
553 size_t *encoded_name_size,
554 struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
555 const char *name, size_t name_size);
556 void ecryptfs_dump_hex(char *data, int bytes);
557 int virt_to_scatterlist(const void *addr, int size, struct scatterlist *sg,
558 int sg_size);
559 int ecryptfs_compute_root_iv(struct ecryptfs_crypt_stat *crypt_stat);
560 void ecryptfs_rotate_iv(unsigned char *iv);
561 int ecryptfs_init_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
562 void ecryptfs_destroy_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
563 void ecryptfs_destroy_mount_crypt_stat(
564 struct ecryptfs_mount_crypt_stat *mount_crypt_stat);
565 int ecryptfs_init_crypt_ctx(struct ecryptfs_crypt_stat *crypt_stat);
566 int ecryptfs_write_inode_size_to_metadata(struct inode *ecryptfs_inode);
567 int ecryptfs_encrypt_page(struct folio *folio);
568 int ecryptfs_decrypt_page(struct folio *folio);
569 int ecryptfs_write_metadata(struct dentry *ecryptfs_dentry,
570 struct inode *ecryptfs_inode);
571 int ecryptfs_read_metadata(struct dentry *ecryptfs_dentry);
572 int ecryptfs_new_file_context(struct inode *ecryptfs_inode);
573 void ecryptfs_write_crypt_stat_flags(char *page_virt,
574 struct ecryptfs_crypt_stat *crypt_stat,
575 size_t *written);
576 int ecryptfs_read_and_validate_header_region(struct inode *inode);
577 int ecryptfs_read_and_validate_xattr_region(struct dentry *dentry,
578 struct inode *inode);
579 u8 ecryptfs_code_for_cipher_string(char *cipher_name, size_t key_bytes);
580 int ecryptfs_cipher_code_to_string(char *str, u8 cipher_code);
581 void ecryptfs_set_default_sizes(struct ecryptfs_crypt_stat *crypt_stat);
582 int ecryptfs_generate_key_packet_set(char *dest_base,
583 struct ecryptfs_crypt_stat *crypt_stat,
584 struct dentry *ecryptfs_dentry,
585 size_t *len, size_t max);
586 int
587 ecryptfs_parse_packet_set(struct ecryptfs_crypt_stat *crypt_stat,
588 unsigned char *src, struct dentry *ecryptfs_dentry);
589 int ecryptfs_truncate(struct dentry *dentry, loff_t new_length);
590 ssize_t
591 ecryptfs_getxattr_lower(struct dentry *lower_dentry, struct inode *lower_inode,
592 const char *name, void *value, size_t size);
593 int
594 ecryptfs_setxattr(struct dentry *dentry, struct inode *inode, const char *name,
595 const void *value, size_t size, int flags);
596 int ecryptfs_read_xattr_region(char *page_virt, struct inode *ecryptfs_inode);
597 #ifdef CONFIG_ECRYPT_FS_MESSAGING
598 int ecryptfs_process_response(struct ecryptfs_daemon *daemon,
599 struct ecryptfs_message *msg, u32 seq);
600 int ecryptfs_send_message(char *data, int data_len,
601 struct ecryptfs_msg_ctx **msg_ctx);
602 int ecryptfs_wait_for_response(struct ecryptfs_msg_ctx *msg_ctx,
603 struct ecryptfs_message **emsg);
604 int ecryptfs_init_messaging(void);
605 void ecryptfs_release_messaging(void);
606 #else
ecryptfs_init_messaging(void)607 static inline int ecryptfs_init_messaging(void)
608 {
609 return 0;
610 }
ecryptfs_release_messaging(void)611 static inline void ecryptfs_release_messaging(void)
612 { }
ecryptfs_send_message(char * data,int data_len,struct ecryptfs_msg_ctx ** msg_ctx)613 static inline int ecryptfs_send_message(char *data, int data_len,
614 struct ecryptfs_msg_ctx **msg_ctx)
615 {
616 return -ENOTCONN;
617 }
ecryptfs_wait_for_response(struct ecryptfs_msg_ctx * msg_ctx,struct ecryptfs_message ** emsg)618 static inline int ecryptfs_wait_for_response(struct ecryptfs_msg_ctx *msg_ctx,
619 struct ecryptfs_message **emsg)
620 {
621 return -ENOMSG;
622 }
623 #endif
624
625 void
626 ecryptfs_write_header_metadata(char *virt,
627 struct ecryptfs_crypt_stat *crypt_stat,
628 size_t *written);
629 int ecryptfs_add_keysig(struct ecryptfs_crypt_stat *crypt_stat, char *sig);
630 int
631 ecryptfs_add_global_auth_tok(struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
632 char *sig, u32 global_auth_tok_flags);
633 int ecryptfs_get_global_auth_tok_for_sig(
634 struct ecryptfs_global_auth_tok **global_auth_tok,
635 struct ecryptfs_mount_crypt_stat *mount_crypt_stat, char *sig);
636 int
637 ecryptfs_add_new_key_tfm(struct ecryptfs_key_tfm **key_tfm, char *cipher_name,
638 size_t key_size);
639 int ecryptfs_init_crypto(void);
640 int ecryptfs_destroy_crypto(void);
641 int ecryptfs_tfm_exists(char *cipher_name, struct ecryptfs_key_tfm **key_tfm);
642 int ecryptfs_get_tfm_and_mutex_for_cipher_name(struct crypto_skcipher **tfm,
643 struct mutex **tfm_mutex,
644 char *cipher_name);
645 int ecryptfs_keyring_auth_tok_for_sig(struct key **auth_tok_key,
646 struct ecryptfs_auth_tok **auth_tok,
647 char *sig);
648 int ecryptfs_write_lower(struct inode *ecryptfs_inode, char *data,
649 loff_t offset, size_t size);
650 int ecryptfs_write_lower_page_segment(struct inode *ecryptfs_inode,
651 struct folio *folio_for_lower,
652 size_t offset_in_page, size_t size);
653 int ecryptfs_write(struct inode *inode, char *data, loff_t offset, size_t size);
654 int ecryptfs_read_lower(char *data, loff_t offset, size_t size,
655 struct inode *ecryptfs_inode);
656 int ecryptfs_read_lower_page_segment(struct folio *folio_for_ecryptfs,
657 pgoff_t page_index,
658 size_t offset_in_page, size_t size,
659 struct inode *ecryptfs_inode);
660 int ecryptfs_parse_packet_length(unsigned char *data, size_t *size,
661 size_t *length_size);
662 int ecryptfs_write_packet_length(char *dest, size_t size,
663 size_t *packet_size_length);
664 #ifdef CONFIG_ECRYPT_FS_MESSAGING
665 int ecryptfs_init_ecryptfs_miscdev(void);
666 void ecryptfs_destroy_ecryptfs_miscdev(void);
667 int ecryptfs_send_miscdev(char *data, size_t data_size,
668 struct ecryptfs_msg_ctx *msg_ctx, u8 msg_type,
669 u16 msg_flags, struct ecryptfs_daemon *daemon);
670 void ecryptfs_msg_ctx_alloc_to_free(struct ecryptfs_msg_ctx *msg_ctx);
671 int
672 ecryptfs_spawn_daemon(struct ecryptfs_daemon **daemon, struct file *file);
673 int ecryptfs_exorcise_daemon(struct ecryptfs_daemon *daemon);
674 int ecryptfs_find_daemon_by_euid(struct ecryptfs_daemon **daemon);
675 #endif
676 int ecryptfs_init_kthread(void);
677 void ecryptfs_destroy_kthread(void);
678 int ecryptfs_privileged_open(struct file **lower_file,
679 struct dentry *lower_dentry,
680 struct vfsmount *lower_mnt,
681 const struct cred *cred);
682 int ecryptfs_get_lower_file(struct dentry *dentry, struct inode *inode);
683 void ecryptfs_put_lower_file(struct inode *inode);
684 int
685 ecryptfs_write_tag_70_packet(char *dest, size_t *remaining_bytes,
686 size_t *packet_size,
687 struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
688 char *filename, size_t filename_size);
689 int
690 ecryptfs_parse_tag_70_packet(char **filename, size_t *filename_size,
691 size_t *packet_size,
692 struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
693 char *data, size_t max_packet_size);
694 int ecryptfs_set_f_namelen(long *namelen, long lower_namelen,
695 struct ecryptfs_mount_crypt_stat *mount_crypt_stat);
696 int ecryptfs_derive_iv(char *iv, struct ecryptfs_crypt_stat *crypt_stat,
697 loff_t offset);
698
699 extern const struct xattr_handler * const ecryptfs_xattr_handlers[];
700
701 #endif /* #ifndef ECRYPTFS_KERNEL_H */
702