Loading...
1/**
2 * eCryptfs: Linux filesystem encryption layer
3 *
4 * Copyright (C) 1997-2004 Erez Zadok
5 * Copyright (C) 2001-2004 Stony Brook University
6 * Copyright (C) 2004-2007 International Business Machines Corp.
7 * Author(s): Michael A. Halcrow <mahalcro@us.ibm.com>
8 * Michael C. Thompson <mcthomps@us.ibm.com>
9 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License as
12 * published by the Free Software Foundation; either version 2 of the
13 * License, or (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
23 * 02111-1307, USA.
24 */
25
26#include <linux/fs.h>
27#include <linux/mount.h>
28#include <linux/pagemap.h>
29#include <linux/random.h>
30#include <linux/compiler.h>
31#include <linux/key.h>
32#include <linux/namei.h>
33#include <linux/crypto.h>
34#include <linux/file.h>
35#include <linux/scatterlist.h>
36#include <linux/slab.h>
37#include <asm/unaligned.h>
38#include "ecryptfs_kernel.h"
39
40static int
41ecryptfs_decrypt_page_offset(struct ecryptfs_crypt_stat *crypt_stat,
42 struct page *dst_page, int dst_offset,
43 struct page *src_page, int src_offset, int size,
44 unsigned char *iv);
45static int
46ecryptfs_encrypt_page_offset(struct ecryptfs_crypt_stat *crypt_stat,
47 struct page *dst_page, int dst_offset,
48 struct page *src_page, int src_offset, int size,
49 unsigned char *iv);
50
51/**
52 * ecryptfs_to_hex
53 * @dst: Buffer to take hex character representation of contents of
54 * src; must be at least of size (src_size * 2)
55 * @src: Buffer to be converted to a hex string respresentation
56 * @src_size: number of bytes to convert
57 */
58void ecryptfs_to_hex(char *dst, char *src, size_t src_size)
59{
60 int x;
61
62 for (x = 0; x < src_size; x++)
63 sprintf(&dst[x * 2], "%.2x", (unsigned char)src[x]);
64}
65
66/**
67 * ecryptfs_from_hex
68 * @dst: Buffer to take the bytes from src hex; must be at least of
69 * size (src_size / 2)
70 * @src: Buffer to be converted from a hex string respresentation to raw value
71 * @dst_size: size of dst buffer, or number of hex characters pairs to convert
72 */
73void ecryptfs_from_hex(char *dst, char *src, int dst_size)
74{
75 int x;
76 char tmp[3] = { 0, };
77
78 for (x = 0; x < dst_size; x++) {
79 tmp[0] = src[x * 2];
80 tmp[1] = src[x * 2 + 1];
81 dst[x] = (unsigned char)simple_strtol(tmp, NULL, 16);
82 }
83}
84
85/**
86 * ecryptfs_calculate_md5 - calculates the md5 of @src
87 * @dst: Pointer to 16 bytes of allocated memory
88 * @crypt_stat: Pointer to crypt_stat struct for the current inode
89 * @src: Data to be md5'd
90 * @len: Length of @src
91 *
92 * Uses the allocated crypto context that crypt_stat references to
93 * generate the MD5 sum of the contents of src.
94 */
95static int ecryptfs_calculate_md5(char *dst,
96 struct ecryptfs_crypt_stat *crypt_stat,
97 char *src, int len)
98{
99 struct scatterlist sg;
100 struct hash_desc desc = {
101 .tfm = crypt_stat->hash_tfm,
102 .flags = CRYPTO_TFM_REQ_MAY_SLEEP
103 };
104 int rc = 0;
105
106 mutex_lock(&crypt_stat->cs_hash_tfm_mutex);
107 sg_init_one(&sg, (u8 *)src, len);
108 if (!desc.tfm) {
109 desc.tfm = crypto_alloc_hash(ECRYPTFS_DEFAULT_HASH, 0,
110 CRYPTO_ALG_ASYNC);
111 if (IS_ERR(desc.tfm)) {
112 rc = PTR_ERR(desc.tfm);
113 ecryptfs_printk(KERN_ERR, "Error attempting to "
114 "allocate crypto context; rc = [%d]\n",
115 rc);
116 goto out;
117 }
118 crypt_stat->hash_tfm = desc.tfm;
119 }
120 rc = crypto_hash_init(&desc);
121 if (rc) {
122 printk(KERN_ERR
123 "%s: Error initializing crypto hash; rc = [%d]\n",
124 __func__, rc);
125 goto out;
126 }
127 rc = crypto_hash_update(&desc, &sg, len);
128 if (rc) {
129 printk(KERN_ERR
130 "%s: Error updating crypto hash; rc = [%d]\n",
131 __func__, rc);
132 goto out;
133 }
134 rc = crypto_hash_final(&desc, dst);
135 if (rc) {
136 printk(KERN_ERR
137 "%s: Error finalizing crypto hash; rc = [%d]\n",
138 __func__, rc);
139 goto out;
140 }
141out:
142 mutex_unlock(&crypt_stat->cs_hash_tfm_mutex);
143 return rc;
144}
145
146static int ecryptfs_crypto_api_algify_cipher_name(char **algified_name,
147 char *cipher_name,
148 char *chaining_modifier)
149{
150 int cipher_name_len = strlen(cipher_name);
151 int chaining_modifier_len = strlen(chaining_modifier);
152 int algified_name_len;
153 int rc;
154
155 algified_name_len = (chaining_modifier_len + cipher_name_len + 3);
156 (*algified_name) = kmalloc(algified_name_len, GFP_KERNEL);
157 if (!(*algified_name)) {
158 rc = -ENOMEM;
159 goto out;
160 }
161 snprintf((*algified_name), algified_name_len, "%s(%s)",
162 chaining_modifier, cipher_name);
163 rc = 0;
164out:
165 return rc;
166}
167
168/**
169 * ecryptfs_derive_iv
170 * @iv: destination for the derived iv vale
171 * @crypt_stat: Pointer to crypt_stat struct for the current inode
172 * @offset: Offset of the extent whose IV we are to derive
173 *
174 * Generate the initialization vector from the given root IV and page
175 * offset.
176 *
177 * Returns zero on success; non-zero on error.
178 */
179int ecryptfs_derive_iv(char *iv, struct ecryptfs_crypt_stat *crypt_stat,
180 loff_t offset)
181{
182 int rc = 0;
183 char dst[MD5_DIGEST_SIZE];
184 char src[ECRYPTFS_MAX_IV_BYTES + 16];
185
186 if (unlikely(ecryptfs_verbosity > 0)) {
187 ecryptfs_printk(KERN_DEBUG, "root iv:\n");
188 ecryptfs_dump_hex(crypt_stat->root_iv, crypt_stat->iv_bytes);
189 }
190 /* TODO: It is probably secure to just cast the least
191 * significant bits of the root IV into an unsigned long and
192 * add the offset to that rather than go through all this
193 * hashing business. -Halcrow */
194 memcpy(src, crypt_stat->root_iv, crypt_stat->iv_bytes);
195 memset((src + crypt_stat->iv_bytes), 0, 16);
196 snprintf((src + crypt_stat->iv_bytes), 16, "%lld", offset);
197 if (unlikely(ecryptfs_verbosity > 0)) {
198 ecryptfs_printk(KERN_DEBUG, "source:\n");
199 ecryptfs_dump_hex(src, (crypt_stat->iv_bytes + 16));
200 }
201 rc = ecryptfs_calculate_md5(dst, crypt_stat, src,
202 (crypt_stat->iv_bytes + 16));
203 if (rc) {
204 ecryptfs_printk(KERN_WARNING, "Error attempting to compute "
205 "MD5 while generating IV for a page\n");
206 goto out;
207 }
208 memcpy(iv, dst, crypt_stat->iv_bytes);
209 if (unlikely(ecryptfs_verbosity > 0)) {
210 ecryptfs_printk(KERN_DEBUG, "derived iv:\n");
211 ecryptfs_dump_hex(iv, crypt_stat->iv_bytes);
212 }
213out:
214 return rc;
215}
216
217/**
218 * ecryptfs_init_crypt_stat
219 * @crypt_stat: Pointer to the crypt_stat struct to initialize.
220 *
221 * Initialize the crypt_stat structure.
222 */
223void
224ecryptfs_init_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat)
225{
226 memset((void *)crypt_stat, 0, sizeof(struct ecryptfs_crypt_stat));
227 INIT_LIST_HEAD(&crypt_stat->keysig_list);
228 mutex_init(&crypt_stat->keysig_list_mutex);
229 mutex_init(&crypt_stat->cs_mutex);
230 mutex_init(&crypt_stat->cs_tfm_mutex);
231 mutex_init(&crypt_stat->cs_hash_tfm_mutex);
232 crypt_stat->flags |= ECRYPTFS_STRUCT_INITIALIZED;
233}
234
235/**
236 * ecryptfs_destroy_crypt_stat
237 * @crypt_stat: Pointer to the crypt_stat struct to initialize.
238 *
239 * Releases all memory associated with a crypt_stat struct.
240 */
241void ecryptfs_destroy_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat)
242{
243 struct ecryptfs_key_sig *key_sig, *key_sig_tmp;
244
245 if (crypt_stat->tfm)
246 crypto_free_blkcipher(crypt_stat->tfm);
247 if (crypt_stat->hash_tfm)
248 crypto_free_hash(crypt_stat->hash_tfm);
249 list_for_each_entry_safe(key_sig, key_sig_tmp,
250 &crypt_stat->keysig_list, crypt_stat_list) {
251 list_del(&key_sig->crypt_stat_list);
252 kmem_cache_free(ecryptfs_key_sig_cache, key_sig);
253 }
254 memset(crypt_stat, 0, sizeof(struct ecryptfs_crypt_stat));
255}
256
257void ecryptfs_destroy_mount_crypt_stat(
258 struct ecryptfs_mount_crypt_stat *mount_crypt_stat)
259{
260 struct ecryptfs_global_auth_tok *auth_tok, *auth_tok_tmp;
261
262 if (!(mount_crypt_stat->flags & ECRYPTFS_MOUNT_CRYPT_STAT_INITIALIZED))
263 return;
264 mutex_lock(&mount_crypt_stat->global_auth_tok_list_mutex);
265 list_for_each_entry_safe(auth_tok, auth_tok_tmp,
266 &mount_crypt_stat->global_auth_tok_list,
267 mount_crypt_stat_list) {
268 list_del(&auth_tok->mount_crypt_stat_list);
269 if (auth_tok->global_auth_tok_key
270 && !(auth_tok->flags & ECRYPTFS_AUTH_TOK_INVALID))
271 key_put(auth_tok->global_auth_tok_key);
272 kmem_cache_free(ecryptfs_global_auth_tok_cache, auth_tok);
273 }
274 mutex_unlock(&mount_crypt_stat->global_auth_tok_list_mutex);
275 memset(mount_crypt_stat, 0, sizeof(struct ecryptfs_mount_crypt_stat));
276}
277
278/**
279 * virt_to_scatterlist
280 * @addr: Virtual address
281 * @size: Size of data; should be an even multiple of the block size
282 * @sg: Pointer to scatterlist array; set to NULL to obtain only
283 * the number of scatterlist structs required in array
284 * @sg_size: Max array size
285 *
286 * Fills in a scatterlist array with page references for a passed
287 * virtual address.
288 *
289 * Returns the number of scatterlist structs in array used
290 */
291int virt_to_scatterlist(const void *addr, int size, struct scatterlist *sg,
292 int sg_size)
293{
294 int i = 0;
295 struct page *pg;
296 int offset;
297 int remainder_of_page;
298
299 sg_init_table(sg, sg_size);
300
301 while (size > 0 && i < sg_size) {
302 pg = virt_to_page(addr);
303 offset = offset_in_page(addr);
304 if (sg)
305 sg_set_page(&sg[i], pg, 0, offset);
306 remainder_of_page = PAGE_CACHE_SIZE - offset;
307 if (size >= remainder_of_page) {
308 if (sg)
309 sg[i].length = remainder_of_page;
310 addr += remainder_of_page;
311 size -= remainder_of_page;
312 } else {
313 if (sg)
314 sg[i].length = size;
315 addr += size;
316 size = 0;
317 }
318 i++;
319 }
320 if (size > 0)
321 return -ENOMEM;
322 return i;
323}
324
325/**
326 * encrypt_scatterlist
327 * @crypt_stat: Pointer to the crypt_stat struct to initialize.
328 * @dest_sg: Destination of encrypted data
329 * @src_sg: Data to be encrypted
330 * @size: Length of data to be encrypted
331 * @iv: iv to use during encryption
332 *
333 * Returns the number of bytes encrypted; negative value on error
334 */
335static int encrypt_scatterlist(struct ecryptfs_crypt_stat *crypt_stat,
336 struct scatterlist *dest_sg,
337 struct scatterlist *src_sg, int size,
338 unsigned char *iv)
339{
340 struct blkcipher_desc desc = {
341 .tfm = crypt_stat->tfm,
342 .info = iv,
343 .flags = CRYPTO_TFM_REQ_MAY_SLEEP
344 };
345 int rc = 0;
346
347 BUG_ON(!crypt_stat || !crypt_stat->tfm
348 || !(crypt_stat->flags & ECRYPTFS_STRUCT_INITIALIZED));
349 if (unlikely(ecryptfs_verbosity > 0)) {
350 ecryptfs_printk(KERN_DEBUG, "Key size [%zd]; key:\n",
351 crypt_stat->key_size);
352 ecryptfs_dump_hex(crypt_stat->key,
353 crypt_stat->key_size);
354 }
355 /* Consider doing this once, when the file is opened */
356 mutex_lock(&crypt_stat->cs_tfm_mutex);
357 if (!(crypt_stat->flags & ECRYPTFS_KEY_SET)) {
358 rc = crypto_blkcipher_setkey(crypt_stat->tfm, crypt_stat->key,
359 crypt_stat->key_size);
360 crypt_stat->flags |= ECRYPTFS_KEY_SET;
361 }
362 if (rc) {
363 ecryptfs_printk(KERN_ERR, "Error setting key; rc = [%d]\n",
364 rc);
365 mutex_unlock(&crypt_stat->cs_tfm_mutex);
366 rc = -EINVAL;
367 goto out;
368 }
369 ecryptfs_printk(KERN_DEBUG, "Encrypting [%d] bytes.\n", size);
370 crypto_blkcipher_encrypt_iv(&desc, dest_sg, src_sg, size);
371 mutex_unlock(&crypt_stat->cs_tfm_mutex);
372out:
373 return rc;
374}
375
376/**
377 * ecryptfs_lower_offset_for_extent
378 *
379 * Convert an eCryptfs page index into a lower byte offset
380 */
381static void ecryptfs_lower_offset_for_extent(loff_t *offset, loff_t extent_num,
382 struct ecryptfs_crypt_stat *crypt_stat)
383{
384 (*offset) = ecryptfs_lower_header_size(crypt_stat)
385 + (crypt_stat->extent_size * extent_num);
386}
387
388/**
389 * ecryptfs_encrypt_extent
390 * @enc_extent_page: Allocated page into which to encrypt the data in
391 * @page
392 * @crypt_stat: crypt_stat containing cryptographic context for the
393 * encryption operation
394 * @page: Page containing plaintext data extent to encrypt
395 * @extent_offset: Page extent offset for use in generating IV
396 *
397 * Encrypts one extent of data.
398 *
399 * Return zero on success; non-zero otherwise
400 */
401static int ecryptfs_encrypt_extent(struct page *enc_extent_page,
402 struct ecryptfs_crypt_stat *crypt_stat,
403 struct page *page,
404 unsigned long extent_offset)
405{
406 loff_t extent_base;
407 char extent_iv[ECRYPTFS_MAX_IV_BYTES];
408 int rc;
409
410 extent_base = (((loff_t)page->index)
411 * (PAGE_CACHE_SIZE / crypt_stat->extent_size));
412 rc = ecryptfs_derive_iv(extent_iv, crypt_stat,
413 (extent_base + extent_offset));
414 if (rc) {
415 ecryptfs_printk(KERN_ERR, "Error attempting to derive IV for "
416 "extent [0x%.16llx]; rc = [%d]\n",
417 (unsigned long long)(extent_base + extent_offset), rc);
418 goto out;
419 }
420 if (unlikely(ecryptfs_verbosity > 0)) {
421 ecryptfs_printk(KERN_DEBUG, "Encrypting extent "
422 "with iv:\n");
423 ecryptfs_dump_hex(extent_iv, crypt_stat->iv_bytes);
424 ecryptfs_printk(KERN_DEBUG, "First 8 bytes before "
425 "encryption:\n");
426 ecryptfs_dump_hex((char *)
427 (page_address(page)
428 + (extent_offset * crypt_stat->extent_size)),
429 8);
430 }
431 rc = ecryptfs_encrypt_page_offset(crypt_stat, enc_extent_page, 0,
432 page, (extent_offset
433 * crypt_stat->extent_size),
434 crypt_stat->extent_size, extent_iv);
435 if (rc < 0) {
436 printk(KERN_ERR "%s: Error attempting to encrypt page with "
437 "page->index = [%ld], extent_offset = [%ld]; "
438 "rc = [%d]\n", __func__, page->index, extent_offset,
439 rc);
440 goto out;
441 }
442 rc = 0;
443 if (unlikely(ecryptfs_verbosity > 0)) {
444 ecryptfs_printk(KERN_DEBUG, "Encrypt extent [0x%.16llx]; "
445 "rc = [%d]\n",
446 (unsigned long long)(extent_base + extent_offset), rc);
447 ecryptfs_printk(KERN_DEBUG, "First 8 bytes after "
448 "encryption:\n");
449 ecryptfs_dump_hex((char *)(page_address(enc_extent_page)), 8);
450 }
451out:
452 return rc;
453}
454
455/**
456 * ecryptfs_encrypt_page
457 * @page: Page mapped from the eCryptfs inode for the file; contains
458 * decrypted content that needs to be encrypted (to a temporary
459 * page; not in place) and written out to the lower file
460 *
461 * Encrypt an eCryptfs page. This is done on a per-extent basis. Note
462 * that eCryptfs pages may straddle the lower pages -- for instance,
463 * if the file was created on a machine with an 8K page size
464 * (resulting in an 8K header), and then the file is copied onto a
465 * host with a 32K page size, then when reading page 0 of the eCryptfs
466 * file, 24K of page 0 of the lower file will be read and decrypted,
467 * and then 8K of page 1 of the lower file will be read and decrypted.
468 *
469 * Returns zero on success; negative on error
470 */
471int ecryptfs_encrypt_page(struct page *page)
472{
473 struct inode *ecryptfs_inode;
474 struct ecryptfs_crypt_stat *crypt_stat;
475 char *enc_extent_virt;
476 struct page *enc_extent_page = NULL;
477 loff_t extent_offset;
478 int rc = 0;
479
480 ecryptfs_inode = page->mapping->host;
481 crypt_stat =
482 &(ecryptfs_inode_to_private(ecryptfs_inode)->crypt_stat);
483 BUG_ON(!(crypt_stat->flags & ECRYPTFS_ENCRYPTED));
484 enc_extent_page = alloc_page(GFP_USER);
485 if (!enc_extent_page) {
486 rc = -ENOMEM;
487 ecryptfs_printk(KERN_ERR, "Error allocating memory for "
488 "encrypted extent\n");
489 goto out;
490 }
491 enc_extent_virt = kmap(enc_extent_page);
492 for (extent_offset = 0;
493 extent_offset < (PAGE_CACHE_SIZE / crypt_stat->extent_size);
494 extent_offset++) {
495 loff_t offset;
496
497 rc = ecryptfs_encrypt_extent(enc_extent_page, crypt_stat, page,
498 extent_offset);
499 if (rc) {
500 printk(KERN_ERR "%s: Error encrypting extent; "
501 "rc = [%d]\n", __func__, rc);
502 goto out;
503 }
504 ecryptfs_lower_offset_for_extent(
505 &offset, ((((loff_t)page->index)
506 * (PAGE_CACHE_SIZE
507 / crypt_stat->extent_size))
508 + extent_offset), crypt_stat);
509 rc = ecryptfs_write_lower(ecryptfs_inode, enc_extent_virt,
510 offset, crypt_stat->extent_size);
511 if (rc < 0) {
512 ecryptfs_printk(KERN_ERR, "Error attempting "
513 "to write lower page; rc = [%d]"
514 "\n", rc);
515 goto out;
516 }
517 }
518 rc = 0;
519out:
520 if (enc_extent_page) {
521 kunmap(enc_extent_page);
522 __free_page(enc_extent_page);
523 }
524 return rc;
525}
526
527static int ecryptfs_decrypt_extent(struct page *page,
528 struct ecryptfs_crypt_stat *crypt_stat,
529 struct page *enc_extent_page,
530 unsigned long extent_offset)
531{
532 loff_t extent_base;
533 char extent_iv[ECRYPTFS_MAX_IV_BYTES];
534 int rc;
535
536 extent_base = (((loff_t)page->index)
537 * (PAGE_CACHE_SIZE / crypt_stat->extent_size));
538 rc = ecryptfs_derive_iv(extent_iv, crypt_stat,
539 (extent_base + extent_offset));
540 if (rc) {
541 ecryptfs_printk(KERN_ERR, "Error attempting to derive IV for "
542 "extent [0x%.16llx]; rc = [%d]\n",
543 (unsigned long long)(extent_base + extent_offset), rc);
544 goto out;
545 }
546 if (unlikely(ecryptfs_verbosity > 0)) {
547 ecryptfs_printk(KERN_DEBUG, "Decrypting extent "
548 "with iv:\n");
549 ecryptfs_dump_hex(extent_iv, crypt_stat->iv_bytes);
550 ecryptfs_printk(KERN_DEBUG, "First 8 bytes before "
551 "decryption:\n");
552 ecryptfs_dump_hex((char *)
553 (page_address(enc_extent_page)
554 + (extent_offset * crypt_stat->extent_size)),
555 8);
556 }
557 rc = ecryptfs_decrypt_page_offset(crypt_stat, page,
558 (extent_offset
559 * crypt_stat->extent_size),
560 enc_extent_page, 0,
561 crypt_stat->extent_size, extent_iv);
562 if (rc < 0) {
563 printk(KERN_ERR "%s: Error attempting to decrypt to page with "
564 "page->index = [%ld], extent_offset = [%ld]; "
565 "rc = [%d]\n", __func__, page->index, extent_offset,
566 rc);
567 goto out;
568 }
569 rc = 0;
570 if (unlikely(ecryptfs_verbosity > 0)) {
571 ecryptfs_printk(KERN_DEBUG, "Decrypt extent [0x%.16llx]; "
572 "rc = [%d]\n",
573 (unsigned long long)(extent_base + extent_offset), rc);
574 ecryptfs_printk(KERN_DEBUG, "First 8 bytes after "
575 "decryption:\n");
576 ecryptfs_dump_hex((char *)(page_address(page)
577 + (extent_offset
578 * crypt_stat->extent_size)), 8);
579 }
580out:
581 return rc;
582}
583
584/**
585 * ecryptfs_decrypt_page
586 * @page: Page mapped from the eCryptfs inode for the file; data read
587 * and decrypted from the lower file will be written into this
588 * page
589 *
590 * Decrypt an eCryptfs page. This is done on a per-extent basis. Note
591 * that eCryptfs pages may straddle the lower pages -- for instance,
592 * if the file was created on a machine with an 8K page size
593 * (resulting in an 8K header), and then the file is copied onto a
594 * host with a 32K page size, then when reading page 0 of the eCryptfs
595 * file, 24K of page 0 of the lower file will be read and decrypted,
596 * and then 8K of page 1 of the lower file will be read and decrypted.
597 *
598 * Returns zero on success; negative on error
599 */
600int ecryptfs_decrypt_page(struct page *page)
601{
602 struct inode *ecryptfs_inode;
603 struct ecryptfs_crypt_stat *crypt_stat;
604 char *enc_extent_virt;
605 struct page *enc_extent_page = NULL;
606 unsigned long extent_offset;
607 int rc = 0;
608
609 ecryptfs_inode = page->mapping->host;
610 crypt_stat =
611 &(ecryptfs_inode_to_private(ecryptfs_inode)->crypt_stat);
612 BUG_ON(!(crypt_stat->flags & ECRYPTFS_ENCRYPTED));
613 enc_extent_page = alloc_page(GFP_USER);
614 if (!enc_extent_page) {
615 rc = -ENOMEM;
616 ecryptfs_printk(KERN_ERR, "Error allocating memory for "
617 "encrypted extent\n");
618 goto out;
619 }
620 enc_extent_virt = kmap(enc_extent_page);
621 for (extent_offset = 0;
622 extent_offset < (PAGE_CACHE_SIZE / crypt_stat->extent_size);
623 extent_offset++) {
624 loff_t offset;
625
626 ecryptfs_lower_offset_for_extent(
627 &offset, ((page->index * (PAGE_CACHE_SIZE
628 / crypt_stat->extent_size))
629 + extent_offset), crypt_stat);
630 rc = ecryptfs_read_lower(enc_extent_virt, offset,
631 crypt_stat->extent_size,
632 ecryptfs_inode);
633 if (rc < 0) {
634 ecryptfs_printk(KERN_ERR, "Error attempting "
635 "to read lower page; rc = [%d]"
636 "\n", rc);
637 goto out;
638 }
639 rc = ecryptfs_decrypt_extent(page, crypt_stat, enc_extent_page,
640 extent_offset);
641 if (rc) {
642 printk(KERN_ERR "%s: Error encrypting extent; "
643 "rc = [%d]\n", __func__, rc);
644 goto out;
645 }
646 }
647out:
648 if (enc_extent_page) {
649 kunmap(enc_extent_page);
650 __free_page(enc_extent_page);
651 }
652 return rc;
653}
654
655/**
656 * decrypt_scatterlist
657 * @crypt_stat: Cryptographic context
658 * @dest_sg: The destination scatterlist to decrypt into
659 * @src_sg: The source scatterlist to decrypt from
660 * @size: The number of bytes to decrypt
661 * @iv: The initialization vector to use for the decryption
662 *
663 * Returns the number of bytes decrypted; negative value on error
664 */
665static int decrypt_scatterlist(struct ecryptfs_crypt_stat *crypt_stat,
666 struct scatterlist *dest_sg,
667 struct scatterlist *src_sg, int size,
668 unsigned char *iv)
669{
670 struct blkcipher_desc desc = {
671 .tfm = crypt_stat->tfm,
672 .info = iv,
673 .flags = CRYPTO_TFM_REQ_MAY_SLEEP
674 };
675 int rc = 0;
676
677 /* Consider doing this once, when the file is opened */
678 mutex_lock(&crypt_stat->cs_tfm_mutex);
679 rc = crypto_blkcipher_setkey(crypt_stat->tfm, crypt_stat->key,
680 crypt_stat->key_size);
681 if (rc) {
682 ecryptfs_printk(KERN_ERR, "Error setting key; rc = [%d]\n",
683 rc);
684 mutex_unlock(&crypt_stat->cs_tfm_mutex);
685 rc = -EINVAL;
686 goto out;
687 }
688 ecryptfs_printk(KERN_DEBUG, "Decrypting [%d] bytes.\n", size);
689 rc = crypto_blkcipher_decrypt_iv(&desc, dest_sg, src_sg, size);
690 mutex_unlock(&crypt_stat->cs_tfm_mutex);
691 if (rc) {
692 ecryptfs_printk(KERN_ERR, "Error decrypting; rc = [%d]\n",
693 rc);
694 goto out;
695 }
696 rc = size;
697out:
698 return rc;
699}
700
701/**
702 * ecryptfs_encrypt_page_offset
703 * @crypt_stat: The cryptographic context
704 * @dst_page: The page to encrypt into
705 * @dst_offset: The offset in the page to encrypt into
706 * @src_page: The page to encrypt from
707 * @src_offset: The offset in the page to encrypt from
708 * @size: The number of bytes to encrypt
709 * @iv: The initialization vector to use for the encryption
710 *
711 * Returns the number of bytes encrypted
712 */
713static int
714ecryptfs_encrypt_page_offset(struct ecryptfs_crypt_stat *crypt_stat,
715 struct page *dst_page, int dst_offset,
716 struct page *src_page, int src_offset, int size,
717 unsigned char *iv)
718{
719 struct scatterlist src_sg, dst_sg;
720
721 sg_init_table(&src_sg, 1);
722 sg_init_table(&dst_sg, 1);
723
724 sg_set_page(&src_sg, src_page, size, src_offset);
725 sg_set_page(&dst_sg, dst_page, size, dst_offset);
726 return encrypt_scatterlist(crypt_stat, &dst_sg, &src_sg, size, iv);
727}
728
729/**
730 * ecryptfs_decrypt_page_offset
731 * @crypt_stat: The cryptographic context
732 * @dst_page: The page to decrypt into
733 * @dst_offset: The offset in the page to decrypt into
734 * @src_page: The page to decrypt from
735 * @src_offset: The offset in the page to decrypt from
736 * @size: The number of bytes to decrypt
737 * @iv: The initialization vector to use for the decryption
738 *
739 * Returns the number of bytes decrypted
740 */
741static int
742ecryptfs_decrypt_page_offset(struct ecryptfs_crypt_stat *crypt_stat,
743 struct page *dst_page, int dst_offset,
744 struct page *src_page, int src_offset, int size,
745 unsigned char *iv)
746{
747 struct scatterlist src_sg, dst_sg;
748
749 sg_init_table(&src_sg, 1);
750 sg_set_page(&src_sg, src_page, size, src_offset);
751
752 sg_init_table(&dst_sg, 1);
753 sg_set_page(&dst_sg, dst_page, size, dst_offset);
754
755 return decrypt_scatterlist(crypt_stat, &dst_sg, &src_sg, size, iv);
756}
757
758#define ECRYPTFS_MAX_SCATTERLIST_LEN 4
759
760/**
761 * ecryptfs_init_crypt_ctx
762 * @crypt_stat: Uninitialized crypt stats structure
763 *
764 * Initialize the crypto context.
765 *
766 * TODO: Performance: Keep a cache of initialized cipher contexts;
767 * only init if needed
768 */
769int ecryptfs_init_crypt_ctx(struct ecryptfs_crypt_stat *crypt_stat)
770{
771 char *full_alg_name;
772 int rc = -EINVAL;
773
774 if (!crypt_stat->cipher) {
775 ecryptfs_printk(KERN_ERR, "No cipher specified\n");
776 goto out;
777 }
778 ecryptfs_printk(KERN_DEBUG,
779 "Initializing cipher [%s]; strlen = [%d]; "
780 "key_size_bits = [%zd]\n",
781 crypt_stat->cipher, (int)strlen(crypt_stat->cipher),
782 crypt_stat->key_size << 3);
783 if (crypt_stat->tfm) {
784 rc = 0;
785 goto out;
786 }
787 mutex_lock(&crypt_stat->cs_tfm_mutex);
788 rc = ecryptfs_crypto_api_algify_cipher_name(&full_alg_name,
789 crypt_stat->cipher, "cbc");
790 if (rc)
791 goto out_unlock;
792 crypt_stat->tfm = crypto_alloc_blkcipher(full_alg_name, 0,
793 CRYPTO_ALG_ASYNC);
794 kfree(full_alg_name);
795 if (IS_ERR(crypt_stat->tfm)) {
796 rc = PTR_ERR(crypt_stat->tfm);
797 crypt_stat->tfm = NULL;
798 ecryptfs_printk(KERN_ERR, "cryptfs: init_crypt_ctx(): "
799 "Error initializing cipher [%s]\n",
800 crypt_stat->cipher);
801 goto out_unlock;
802 }
803 crypto_blkcipher_set_flags(crypt_stat->tfm, CRYPTO_TFM_REQ_WEAK_KEY);
804 rc = 0;
805out_unlock:
806 mutex_unlock(&crypt_stat->cs_tfm_mutex);
807out:
808 return rc;
809}
810
811static void set_extent_mask_and_shift(struct ecryptfs_crypt_stat *crypt_stat)
812{
813 int extent_size_tmp;
814
815 crypt_stat->extent_mask = 0xFFFFFFFF;
816 crypt_stat->extent_shift = 0;
817 if (crypt_stat->extent_size == 0)
818 return;
819 extent_size_tmp = crypt_stat->extent_size;
820 while ((extent_size_tmp & 0x01) == 0) {
821 extent_size_tmp >>= 1;
822 crypt_stat->extent_mask <<= 1;
823 crypt_stat->extent_shift++;
824 }
825}
826
827void ecryptfs_set_default_sizes(struct ecryptfs_crypt_stat *crypt_stat)
828{
829 /* Default values; may be overwritten as we are parsing the
830 * packets. */
831 crypt_stat->extent_size = ECRYPTFS_DEFAULT_EXTENT_SIZE;
832 set_extent_mask_and_shift(crypt_stat);
833 crypt_stat->iv_bytes = ECRYPTFS_DEFAULT_IV_BYTES;
834 if (crypt_stat->flags & ECRYPTFS_METADATA_IN_XATTR)
835 crypt_stat->metadata_size = ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE;
836 else {
837 if (PAGE_CACHE_SIZE <= ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE)
838 crypt_stat->metadata_size =
839 ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE;
840 else
841 crypt_stat->metadata_size = PAGE_CACHE_SIZE;
842 }
843}
844
845/**
846 * ecryptfs_compute_root_iv
847 * @crypt_stats
848 *
849 * On error, sets the root IV to all 0's.
850 */
851int ecryptfs_compute_root_iv(struct ecryptfs_crypt_stat *crypt_stat)
852{
853 int rc = 0;
854 char dst[MD5_DIGEST_SIZE];
855
856 BUG_ON(crypt_stat->iv_bytes > MD5_DIGEST_SIZE);
857 BUG_ON(crypt_stat->iv_bytes <= 0);
858 if (!(crypt_stat->flags & ECRYPTFS_KEY_VALID)) {
859 rc = -EINVAL;
860 ecryptfs_printk(KERN_WARNING, "Session key not valid; "
861 "cannot generate root IV\n");
862 goto out;
863 }
864 rc = ecryptfs_calculate_md5(dst, crypt_stat, crypt_stat->key,
865 crypt_stat->key_size);
866 if (rc) {
867 ecryptfs_printk(KERN_WARNING, "Error attempting to compute "
868 "MD5 while generating root IV\n");
869 goto out;
870 }
871 memcpy(crypt_stat->root_iv, dst, crypt_stat->iv_bytes);
872out:
873 if (rc) {
874 memset(crypt_stat->root_iv, 0, crypt_stat->iv_bytes);
875 crypt_stat->flags |= ECRYPTFS_SECURITY_WARNING;
876 }
877 return rc;
878}
879
880static void ecryptfs_generate_new_key(struct ecryptfs_crypt_stat *crypt_stat)
881{
882 get_random_bytes(crypt_stat->key, crypt_stat->key_size);
883 crypt_stat->flags |= ECRYPTFS_KEY_VALID;
884 ecryptfs_compute_root_iv(crypt_stat);
885 if (unlikely(ecryptfs_verbosity > 0)) {
886 ecryptfs_printk(KERN_DEBUG, "Generated new session key:\n");
887 ecryptfs_dump_hex(crypt_stat->key,
888 crypt_stat->key_size);
889 }
890}
891
892/**
893 * ecryptfs_copy_mount_wide_flags_to_inode_flags
894 * @crypt_stat: The inode's cryptographic context
895 * @mount_crypt_stat: The mount point's cryptographic context
896 *
897 * This function propagates the mount-wide flags to individual inode
898 * flags.
899 */
900static void ecryptfs_copy_mount_wide_flags_to_inode_flags(
901 struct ecryptfs_crypt_stat *crypt_stat,
902 struct ecryptfs_mount_crypt_stat *mount_crypt_stat)
903{
904 if (mount_crypt_stat->flags & ECRYPTFS_XATTR_METADATA_ENABLED)
905 crypt_stat->flags |= ECRYPTFS_METADATA_IN_XATTR;
906 if (mount_crypt_stat->flags & ECRYPTFS_ENCRYPTED_VIEW_ENABLED)
907 crypt_stat->flags |= ECRYPTFS_VIEW_AS_ENCRYPTED;
908 if (mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES) {
909 crypt_stat->flags |= ECRYPTFS_ENCRYPT_FILENAMES;
910 if (mount_crypt_stat->flags
911 & ECRYPTFS_GLOBAL_ENCFN_USE_MOUNT_FNEK)
912 crypt_stat->flags |= ECRYPTFS_ENCFN_USE_MOUNT_FNEK;
913 else if (mount_crypt_stat->flags
914 & ECRYPTFS_GLOBAL_ENCFN_USE_FEK)
915 crypt_stat->flags |= ECRYPTFS_ENCFN_USE_FEK;
916 }
917}
918
919static int ecryptfs_copy_mount_wide_sigs_to_inode_sigs(
920 struct ecryptfs_crypt_stat *crypt_stat,
921 struct ecryptfs_mount_crypt_stat *mount_crypt_stat)
922{
923 struct ecryptfs_global_auth_tok *global_auth_tok;
924 int rc = 0;
925
926 mutex_lock(&crypt_stat->keysig_list_mutex);
927 mutex_lock(&mount_crypt_stat->global_auth_tok_list_mutex);
928
929 list_for_each_entry(global_auth_tok,
930 &mount_crypt_stat->global_auth_tok_list,
931 mount_crypt_stat_list) {
932 if (global_auth_tok->flags & ECRYPTFS_AUTH_TOK_FNEK)
933 continue;
934 rc = ecryptfs_add_keysig(crypt_stat, global_auth_tok->sig);
935 if (rc) {
936 printk(KERN_ERR "Error adding keysig; rc = [%d]\n", rc);
937 goto out;
938 }
939 }
940
941out:
942 mutex_unlock(&mount_crypt_stat->global_auth_tok_list_mutex);
943 mutex_unlock(&crypt_stat->keysig_list_mutex);
944 return rc;
945}
946
947/**
948 * ecryptfs_set_default_crypt_stat_vals
949 * @crypt_stat: The inode's cryptographic context
950 * @mount_crypt_stat: The mount point's cryptographic context
951 *
952 * Default values in the event that policy does not override them.
953 */
954static void ecryptfs_set_default_crypt_stat_vals(
955 struct ecryptfs_crypt_stat *crypt_stat,
956 struct ecryptfs_mount_crypt_stat *mount_crypt_stat)
957{
958 ecryptfs_copy_mount_wide_flags_to_inode_flags(crypt_stat,
959 mount_crypt_stat);
960 ecryptfs_set_default_sizes(crypt_stat);
961 strcpy(crypt_stat->cipher, ECRYPTFS_DEFAULT_CIPHER);
962 crypt_stat->key_size = ECRYPTFS_DEFAULT_KEY_BYTES;
963 crypt_stat->flags &= ~(ECRYPTFS_KEY_VALID);
964 crypt_stat->file_version = ECRYPTFS_FILE_VERSION;
965 crypt_stat->mount_crypt_stat = mount_crypt_stat;
966}
967
968/**
969 * ecryptfs_new_file_context
970 * @ecryptfs_dentry: The eCryptfs dentry
971 *
972 * If the crypto context for the file has not yet been established,
973 * this is where we do that. Establishing a new crypto context
974 * involves the following decisions:
975 * - What cipher to use?
976 * - What set of authentication tokens to use?
977 * Here we just worry about getting enough information into the
978 * authentication tokens so that we know that they are available.
979 * We associate the available authentication tokens with the new file
980 * via the set of signatures in the crypt_stat struct. Later, when
981 * the headers are actually written out, we may again defer to
982 * userspace to perform the encryption of the session key; for the
983 * foreseeable future, this will be the case with public key packets.
984 *
985 * Returns zero on success; non-zero otherwise
986 */
987int ecryptfs_new_file_context(struct dentry *ecryptfs_dentry)
988{
989 struct ecryptfs_crypt_stat *crypt_stat =
990 &ecryptfs_inode_to_private(ecryptfs_dentry->d_inode)->crypt_stat;
991 struct ecryptfs_mount_crypt_stat *mount_crypt_stat =
992 &ecryptfs_superblock_to_private(
993 ecryptfs_dentry->d_sb)->mount_crypt_stat;
994 int cipher_name_len;
995 int rc = 0;
996
997 ecryptfs_set_default_crypt_stat_vals(crypt_stat, mount_crypt_stat);
998 crypt_stat->flags |= (ECRYPTFS_ENCRYPTED | ECRYPTFS_KEY_VALID);
999 ecryptfs_copy_mount_wide_flags_to_inode_flags(crypt_stat,
1000 mount_crypt_stat);
1001 rc = ecryptfs_copy_mount_wide_sigs_to_inode_sigs(crypt_stat,
1002 mount_crypt_stat);
1003 if (rc) {
1004 printk(KERN_ERR "Error attempting to copy mount-wide key sigs "
1005 "to the inode key sigs; rc = [%d]\n", rc);
1006 goto out;
1007 }
1008 cipher_name_len =
1009 strlen(mount_crypt_stat->global_default_cipher_name);
1010 memcpy(crypt_stat->cipher,
1011 mount_crypt_stat->global_default_cipher_name,
1012 cipher_name_len);
1013 crypt_stat->cipher[cipher_name_len] = '\0';
1014 crypt_stat->key_size =
1015 mount_crypt_stat->global_default_cipher_key_size;
1016 ecryptfs_generate_new_key(crypt_stat);
1017 rc = ecryptfs_init_crypt_ctx(crypt_stat);
1018 if (rc)
1019 ecryptfs_printk(KERN_ERR, "Error initializing cryptographic "
1020 "context for cipher [%s]: rc = [%d]\n",
1021 crypt_stat->cipher, rc);
1022out:
1023 return rc;
1024}
1025
1026/**
1027 * ecryptfs_validate_marker - check for the ecryptfs marker
1028 * @data: The data block in which to check
1029 *
1030 * Returns zero if marker found; -EINVAL if not found
1031 */
1032static int ecryptfs_validate_marker(char *data)
1033{
1034 u32 m_1, m_2;
1035
1036 m_1 = get_unaligned_be32(data);
1037 m_2 = get_unaligned_be32(data + 4);
1038 if ((m_1 ^ MAGIC_ECRYPTFS_MARKER) == m_2)
1039 return 0;
1040 ecryptfs_printk(KERN_DEBUG, "m_1 = [0x%.8x]; m_2 = [0x%.8x]; "
1041 "MAGIC_ECRYPTFS_MARKER = [0x%.8x]\n", m_1, m_2,
1042 MAGIC_ECRYPTFS_MARKER);
1043 ecryptfs_printk(KERN_DEBUG, "(m_1 ^ MAGIC_ECRYPTFS_MARKER) = "
1044 "[0x%.8x]\n", (m_1 ^ MAGIC_ECRYPTFS_MARKER));
1045 return -EINVAL;
1046}
1047
1048struct ecryptfs_flag_map_elem {
1049 u32 file_flag;
1050 u32 local_flag;
1051};
1052
1053/* Add support for additional flags by adding elements here. */
1054static struct ecryptfs_flag_map_elem ecryptfs_flag_map[] = {
1055 {0x00000001, ECRYPTFS_ENABLE_HMAC},
1056 {0x00000002, ECRYPTFS_ENCRYPTED},
1057 {0x00000004, ECRYPTFS_METADATA_IN_XATTR},
1058 {0x00000008, ECRYPTFS_ENCRYPT_FILENAMES}
1059};
1060
1061/**
1062 * ecryptfs_process_flags
1063 * @crypt_stat: The cryptographic context
1064 * @page_virt: Source data to be parsed
1065 * @bytes_read: Updated with the number of bytes read
1066 *
1067 * Returns zero on success; non-zero if the flag set is invalid
1068 */
1069static int ecryptfs_process_flags(struct ecryptfs_crypt_stat *crypt_stat,
1070 char *page_virt, int *bytes_read)
1071{
1072 int rc = 0;
1073 int i;
1074 u32 flags;
1075
1076 flags = get_unaligned_be32(page_virt);
1077 for (i = 0; i < ((sizeof(ecryptfs_flag_map)
1078 / sizeof(struct ecryptfs_flag_map_elem))); i++)
1079 if (flags & ecryptfs_flag_map[i].file_flag) {
1080 crypt_stat->flags |= ecryptfs_flag_map[i].local_flag;
1081 } else
1082 crypt_stat->flags &= ~(ecryptfs_flag_map[i].local_flag);
1083 /* Version is in top 8 bits of the 32-bit flag vector */
1084 crypt_stat->file_version = ((flags >> 24) & 0xFF);
1085 (*bytes_read) = 4;
1086 return rc;
1087}
1088
1089/**
1090 * write_ecryptfs_marker
1091 * @page_virt: The pointer to in a page to begin writing the marker
1092 * @written: Number of bytes written
1093 *
1094 * Marker = 0x3c81b7f5
1095 */
1096static void write_ecryptfs_marker(char *page_virt, size_t *written)
1097{
1098 u32 m_1, m_2;
1099
1100 get_random_bytes(&m_1, (MAGIC_ECRYPTFS_MARKER_SIZE_BYTES / 2));
1101 m_2 = (m_1 ^ MAGIC_ECRYPTFS_MARKER);
1102 put_unaligned_be32(m_1, page_virt);
1103 page_virt += (MAGIC_ECRYPTFS_MARKER_SIZE_BYTES / 2);
1104 put_unaligned_be32(m_2, page_virt);
1105 (*written) = MAGIC_ECRYPTFS_MARKER_SIZE_BYTES;
1106}
1107
1108void ecryptfs_write_crypt_stat_flags(char *page_virt,
1109 struct ecryptfs_crypt_stat *crypt_stat,
1110 size_t *written)
1111{
1112 u32 flags = 0;
1113 int i;
1114
1115 for (i = 0; i < ((sizeof(ecryptfs_flag_map)
1116 / sizeof(struct ecryptfs_flag_map_elem))); i++)
1117 if (crypt_stat->flags & ecryptfs_flag_map[i].local_flag)
1118 flags |= ecryptfs_flag_map[i].file_flag;
1119 /* Version is in top 8 bits of the 32-bit flag vector */
1120 flags |= ((((u8)crypt_stat->file_version) << 24) & 0xFF000000);
1121 put_unaligned_be32(flags, page_virt);
1122 (*written) = 4;
1123}
1124
1125struct ecryptfs_cipher_code_str_map_elem {
1126 char cipher_str[16];
1127 u8 cipher_code;
1128};
1129
1130/* Add support for additional ciphers by adding elements here. The
1131 * cipher_code is whatever OpenPGP applicatoins use to identify the
1132 * ciphers. List in order of probability. */
1133static struct ecryptfs_cipher_code_str_map_elem
1134ecryptfs_cipher_code_str_map[] = {
1135 {"aes",RFC2440_CIPHER_AES_128 },
1136 {"blowfish", RFC2440_CIPHER_BLOWFISH},
1137 {"des3_ede", RFC2440_CIPHER_DES3_EDE},
1138 {"cast5", RFC2440_CIPHER_CAST_5},
1139 {"twofish", RFC2440_CIPHER_TWOFISH},
1140 {"cast6", RFC2440_CIPHER_CAST_6},
1141 {"aes", RFC2440_CIPHER_AES_192},
1142 {"aes", RFC2440_CIPHER_AES_256}
1143};
1144
1145/**
1146 * ecryptfs_code_for_cipher_string
1147 * @cipher_name: The string alias for the cipher
1148 * @key_bytes: Length of key in bytes; used for AES code selection
1149 *
1150 * Returns zero on no match, or the cipher code on match
1151 */
1152u8 ecryptfs_code_for_cipher_string(char *cipher_name, size_t key_bytes)
1153{
1154 int i;
1155 u8 code = 0;
1156 struct ecryptfs_cipher_code_str_map_elem *map =
1157 ecryptfs_cipher_code_str_map;
1158
1159 if (strcmp(cipher_name, "aes") == 0) {
1160 switch (key_bytes) {
1161 case 16:
1162 code = RFC2440_CIPHER_AES_128;
1163 break;
1164 case 24:
1165 code = RFC2440_CIPHER_AES_192;
1166 break;
1167 case 32:
1168 code = RFC2440_CIPHER_AES_256;
1169 }
1170 } else {
1171 for (i = 0; i < ARRAY_SIZE(ecryptfs_cipher_code_str_map); i++)
1172 if (strcmp(cipher_name, map[i].cipher_str) == 0) {
1173 code = map[i].cipher_code;
1174 break;
1175 }
1176 }
1177 return code;
1178}
1179
1180/**
1181 * ecryptfs_cipher_code_to_string
1182 * @str: Destination to write out the cipher name
1183 * @cipher_code: The code to convert to cipher name string
1184 *
1185 * Returns zero on success
1186 */
1187int ecryptfs_cipher_code_to_string(char *str, u8 cipher_code)
1188{
1189 int rc = 0;
1190 int i;
1191
1192 str[0] = '\0';
1193 for (i = 0; i < ARRAY_SIZE(ecryptfs_cipher_code_str_map); i++)
1194 if (cipher_code == ecryptfs_cipher_code_str_map[i].cipher_code)
1195 strcpy(str, ecryptfs_cipher_code_str_map[i].cipher_str);
1196 if (str[0] == '\0') {
1197 ecryptfs_printk(KERN_WARNING, "Cipher code not recognized: "
1198 "[%d]\n", cipher_code);
1199 rc = -EINVAL;
1200 }
1201 return rc;
1202}
1203
1204int ecryptfs_read_and_validate_header_region(struct inode *inode)
1205{
1206 u8 file_size[ECRYPTFS_SIZE_AND_MARKER_BYTES];
1207 u8 *marker = file_size + ECRYPTFS_FILE_SIZE_BYTES;
1208 int rc;
1209
1210 rc = ecryptfs_read_lower(file_size, 0, ECRYPTFS_SIZE_AND_MARKER_BYTES,
1211 inode);
1212 if (rc < ECRYPTFS_SIZE_AND_MARKER_BYTES)
1213 return rc >= 0 ? -EINVAL : rc;
1214 rc = ecryptfs_validate_marker(marker);
1215 if (!rc)
1216 ecryptfs_i_size_init(file_size, inode);
1217 return rc;
1218}
1219
1220void
1221ecryptfs_write_header_metadata(char *virt,
1222 struct ecryptfs_crypt_stat *crypt_stat,
1223 size_t *written)
1224{
1225 u32 header_extent_size;
1226 u16 num_header_extents_at_front;
1227
1228 header_extent_size = (u32)crypt_stat->extent_size;
1229 num_header_extents_at_front =
1230 (u16)(crypt_stat->metadata_size / crypt_stat->extent_size);
1231 put_unaligned_be32(header_extent_size, virt);
1232 virt += 4;
1233 put_unaligned_be16(num_header_extents_at_front, virt);
1234 (*written) = 6;
1235}
1236
1237struct kmem_cache *ecryptfs_header_cache;
1238
1239/**
1240 * ecryptfs_write_headers_virt
1241 * @page_virt: The virtual address to write the headers to
1242 * @max: The size of memory allocated at page_virt
1243 * @size: Set to the number of bytes written by this function
1244 * @crypt_stat: The cryptographic context
1245 * @ecryptfs_dentry: The eCryptfs dentry
1246 *
1247 * Format version: 1
1248 *
1249 * Header Extent:
1250 * Octets 0-7: Unencrypted file size (big-endian)
1251 * Octets 8-15: eCryptfs special marker
1252 * Octets 16-19: Flags
1253 * Octet 16: File format version number (between 0 and 255)
1254 * Octets 17-18: Reserved
1255 * Octet 19: Bit 1 (lsb): Reserved
1256 * Bit 2: Encrypted?
1257 * Bits 3-8: Reserved
1258 * Octets 20-23: Header extent size (big-endian)
1259 * Octets 24-25: Number of header extents at front of file
1260 * (big-endian)
1261 * Octet 26: Begin RFC 2440 authentication token packet set
1262 * Data Extent 0:
1263 * Lower data (CBC encrypted)
1264 * Data Extent 1:
1265 * Lower data (CBC encrypted)
1266 * ...
1267 *
1268 * Returns zero on success
1269 */
1270static int ecryptfs_write_headers_virt(char *page_virt, size_t max,
1271 size_t *size,
1272 struct ecryptfs_crypt_stat *crypt_stat,
1273 struct dentry *ecryptfs_dentry)
1274{
1275 int rc;
1276 size_t written;
1277 size_t offset;
1278
1279 offset = ECRYPTFS_FILE_SIZE_BYTES;
1280 write_ecryptfs_marker((page_virt + offset), &written);
1281 offset += written;
1282 ecryptfs_write_crypt_stat_flags((page_virt + offset), crypt_stat,
1283 &written);
1284 offset += written;
1285 ecryptfs_write_header_metadata((page_virt + offset), crypt_stat,
1286 &written);
1287 offset += written;
1288 rc = ecryptfs_generate_key_packet_set((page_virt + offset), crypt_stat,
1289 ecryptfs_dentry, &written,
1290 max - offset);
1291 if (rc)
1292 ecryptfs_printk(KERN_WARNING, "Error generating key packet "
1293 "set; rc = [%d]\n", rc);
1294 if (size) {
1295 offset += written;
1296 *size = offset;
1297 }
1298 return rc;
1299}
1300
1301static int
1302ecryptfs_write_metadata_to_contents(struct dentry *ecryptfs_dentry,
1303 char *virt, size_t virt_len)
1304{
1305 int rc;
1306
1307 rc = ecryptfs_write_lower(ecryptfs_dentry->d_inode, virt,
1308 0, virt_len);
1309 if (rc < 0)
1310 printk(KERN_ERR "%s: Error attempting to write header "
1311 "information to lower file; rc = [%d]\n", __func__, rc);
1312 else
1313 rc = 0;
1314 return rc;
1315}
1316
1317static int
1318ecryptfs_write_metadata_to_xattr(struct dentry *ecryptfs_dentry,
1319 char *page_virt, size_t size)
1320{
1321 int rc;
1322
1323 rc = ecryptfs_setxattr(ecryptfs_dentry, ECRYPTFS_XATTR_NAME, page_virt,
1324 size, 0);
1325 return rc;
1326}
1327
1328static unsigned long ecryptfs_get_zeroed_pages(gfp_t gfp_mask,
1329 unsigned int order)
1330{
1331 struct page *page;
1332
1333 page = alloc_pages(gfp_mask | __GFP_ZERO, order);
1334 if (page)
1335 return (unsigned long) page_address(page);
1336 return 0;
1337}
1338
1339/**
1340 * ecryptfs_write_metadata
1341 * @ecryptfs_dentry: The eCryptfs dentry
1342 *
1343 * Write the file headers out. This will likely involve a userspace
1344 * callout, in which the session key is encrypted with one or more
1345 * public keys and/or the passphrase necessary to do the encryption is
1346 * retrieved via a prompt. Exactly what happens at this point should
1347 * be policy-dependent.
1348 *
1349 * Returns zero on success; non-zero on error
1350 */
1351int ecryptfs_write_metadata(struct dentry *ecryptfs_dentry)
1352{
1353 struct ecryptfs_crypt_stat *crypt_stat =
1354 &ecryptfs_inode_to_private(ecryptfs_dentry->d_inode)->crypt_stat;
1355 unsigned int order;
1356 char *virt;
1357 size_t virt_len;
1358 size_t size = 0;
1359 int rc = 0;
1360
1361 if (likely(crypt_stat->flags & ECRYPTFS_ENCRYPTED)) {
1362 if (!(crypt_stat->flags & ECRYPTFS_KEY_VALID)) {
1363 printk(KERN_ERR "Key is invalid; bailing out\n");
1364 rc = -EINVAL;
1365 goto out;
1366 }
1367 } else {
1368 printk(KERN_WARNING "%s: Encrypted flag not set\n",
1369 __func__);
1370 rc = -EINVAL;
1371 goto out;
1372 }
1373 virt_len = crypt_stat->metadata_size;
1374 order = get_order(virt_len);
1375 /* Released in this function */
1376 virt = (char *)ecryptfs_get_zeroed_pages(GFP_KERNEL, order);
1377 if (!virt) {
1378 printk(KERN_ERR "%s: Out of memory\n", __func__);
1379 rc = -ENOMEM;
1380 goto out;
1381 }
1382 /* Zeroed page ensures the in-header unencrypted i_size is set to 0 */
1383 rc = ecryptfs_write_headers_virt(virt, virt_len, &size, crypt_stat,
1384 ecryptfs_dentry);
1385 if (unlikely(rc)) {
1386 printk(KERN_ERR "%s: Error whilst writing headers; rc = [%d]\n",
1387 __func__, rc);
1388 goto out_free;
1389 }
1390 if (crypt_stat->flags & ECRYPTFS_METADATA_IN_XATTR)
1391 rc = ecryptfs_write_metadata_to_xattr(ecryptfs_dentry, virt,
1392 size);
1393 else
1394 rc = ecryptfs_write_metadata_to_contents(ecryptfs_dentry, virt,
1395 virt_len);
1396 if (rc) {
1397 printk(KERN_ERR "%s: Error writing metadata out to lower file; "
1398 "rc = [%d]\n", __func__, rc);
1399 goto out_free;
1400 }
1401out_free:
1402 free_pages((unsigned long)virt, order);
1403out:
1404 return rc;
1405}
1406
1407#define ECRYPTFS_DONT_VALIDATE_HEADER_SIZE 0
1408#define ECRYPTFS_VALIDATE_HEADER_SIZE 1
1409static int parse_header_metadata(struct ecryptfs_crypt_stat *crypt_stat,
1410 char *virt, int *bytes_read,
1411 int validate_header_size)
1412{
1413 int rc = 0;
1414 u32 header_extent_size;
1415 u16 num_header_extents_at_front;
1416
1417 header_extent_size = get_unaligned_be32(virt);
1418 virt += sizeof(__be32);
1419 num_header_extents_at_front = get_unaligned_be16(virt);
1420 crypt_stat->metadata_size = (((size_t)num_header_extents_at_front
1421 * (size_t)header_extent_size));
1422 (*bytes_read) = (sizeof(__be32) + sizeof(__be16));
1423 if ((validate_header_size == ECRYPTFS_VALIDATE_HEADER_SIZE)
1424 && (crypt_stat->metadata_size
1425 < ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE)) {
1426 rc = -EINVAL;
1427 printk(KERN_WARNING "Invalid header size: [%zd]\n",
1428 crypt_stat->metadata_size);
1429 }
1430 return rc;
1431}
1432
1433/**
1434 * set_default_header_data
1435 * @crypt_stat: The cryptographic context
1436 *
1437 * For version 0 file format; this function is only for backwards
1438 * compatibility for files created with the prior versions of
1439 * eCryptfs.
1440 */
1441static void set_default_header_data(struct ecryptfs_crypt_stat *crypt_stat)
1442{
1443 crypt_stat->metadata_size = ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE;
1444}
1445
1446void ecryptfs_i_size_init(const char *page_virt, struct inode *inode)
1447{
1448 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
1449 struct ecryptfs_crypt_stat *crypt_stat;
1450 u64 file_size;
1451
1452 crypt_stat = &ecryptfs_inode_to_private(inode)->crypt_stat;
1453 mount_crypt_stat =
1454 &ecryptfs_superblock_to_private(inode->i_sb)->mount_crypt_stat;
1455 if (mount_crypt_stat->flags & ECRYPTFS_ENCRYPTED_VIEW_ENABLED) {
1456 file_size = i_size_read(ecryptfs_inode_to_lower(inode));
1457 if (crypt_stat->flags & ECRYPTFS_METADATA_IN_XATTR)
1458 file_size += crypt_stat->metadata_size;
1459 } else
1460 file_size = get_unaligned_be64(page_virt);
1461 i_size_write(inode, (loff_t)file_size);
1462 crypt_stat->flags |= ECRYPTFS_I_SIZE_INITIALIZED;
1463}
1464
1465/**
1466 * ecryptfs_read_headers_virt
1467 * @page_virt: The virtual address into which to read the headers
1468 * @crypt_stat: The cryptographic context
1469 * @ecryptfs_dentry: The eCryptfs dentry
1470 * @validate_header_size: Whether to validate the header size while reading
1471 *
1472 * Read/parse the header data. The header format is detailed in the
1473 * comment block for the ecryptfs_write_headers_virt() function.
1474 *
1475 * Returns zero on success
1476 */
1477static int ecryptfs_read_headers_virt(char *page_virt,
1478 struct ecryptfs_crypt_stat *crypt_stat,
1479 struct dentry *ecryptfs_dentry,
1480 int validate_header_size)
1481{
1482 int rc = 0;
1483 int offset;
1484 int bytes_read;
1485
1486 ecryptfs_set_default_sizes(crypt_stat);
1487 crypt_stat->mount_crypt_stat = &ecryptfs_superblock_to_private(
1488 ecryptfs_dentry->d_sb)->mount_crypt_stat;
1489 offset = ECRYPTFS_FILE_SIZE_BYTES;
1490 rc = ecryptfs_validate_marker(page_virt + offset);
1491 if (rc)
1492 goto out;
1493 if (!(crypt_stat->flags & ECRYPTFS_I_SIZE_INITIALIZED))
1494 ecryptfs_i_size_init(page_virt, ecryptfs_dentry->d_inode);
1495 offset += MAGIC_ECRYPTFS_MARKER_SIZE_BYTES;
1496 rc = ecryptfs_process_flags(crypt_stat, (page_virt + offset),
1497 &bytes_read);
1498 if (rc) {
1499 ecryptfs_printk(KERN_WARNING, "Error processing flags\n");
1500 goto out;
1501 }
1502 if (crypt_stat->file_version > ECRYPTFS_SUPPORTED_FILE_VERSION) {
1503 ecryptfs_printk(KERN_WARNING, "File version is [%d]; only "
1504 "file version [%d] is supported by this "
1505 "version of eCryptfs\n",
1506 crypt_stat->file_version,
1507 ECRYPTFS_SUPPORTED_FILE_VERSION);
1508 rc = -EINVAL;
1509 goto out;
1510 }
1511 offset += bytes_read;
1512 if (crypt_stat->file_version >= 1) {
1513 rc = parse_header_metadata(crypt_stat, (page_virt + offset),
1514 &bytes_read, validate_header_size);
1515 if (rc) {
1516 ecryptfs_printk(KERN_WARNING, "Error reading header "
1517 "metadata; rc = [%d]\n", rc);
1518 }
1519 offset += bytes_read;
1520 } else
1521 set_default_header_data(crypt_stat);
1522 rc = ecryptfs_parse_packet_set(crypt_stat, (page_virt + offset),
1523 ecryptfs_dentry);
1524out:
1525 return rc;
1526}
1527
1528/**
1529 * ecryptfs_read_xattr_region
1530 * @page_virt: The vitual address into which to read the xattr data
1531 * @ecryptfs_inode: The eCryptfs inode
1532 *
1533 * Attempts to read the crypto metadata from the extended attribute
1534 * region of the lower file.
1535 *
1536 * Returns zero on success; non-zero on error
1537 */
1538int ecryptfs_read_xattr_region(char *page_virt, struct inode *ecryptfs_inode)
1539{
1540 struct dentry *lower_dentry =
1541 ecryptfs_inode_to_private(ecryptfs_inode)->lower_file->f_dentry;
1542 ssize_t size;
1543 int rc = 0;
1544
1545 size = ecryptfs_getxattr_lower(lower_dentry, ECRYPTFS_XATTR_NAME,
1546 page_virt, ECRYPTFS_DEFAULT_EXTENT_SIZE);
1547 if (size < 0) {
1548 if (unlikely(ecryptfs_verbosity > 0))
1549 printk(KERN_INFO "Error attempting to read the [%s] "
1550 "xattr from the lower file; return value = "
1551 "[%zd]\n", ECRYPTFS_XATTR_NAME, size);
1552 rc = -EINVAL;
1553 goto out;
1554 }
1555out:
1556 return rc;
1557}
1558
1559int ecryptfs_read_and_validate_xattr_region(struct dentry *dentry,
1560 struct inode *inode)
1561{
1562 u8 file_size[ECRYPTFS_SIZE_AND_MARKER_BYTES];
1563 u8 *marker = file_size + ECRYPTFS_FILE_SIZE_BYTES;
1564 int rc;
1565
1566 rc = ecryptfs_getxattr_lower(ecryptfs_dentry_to_lower(dentry),
1567 ECRYPTFS_XATTR_NAME, file_size,
1568 ECRYPTFS_SIZE_AND_MARKER_BYTES);
1569 if (rc < ECRYPTFS_SIZE_AND_MARKER_BYTES)
1570 return rc >= 0 ? -EINVAL : rc;
1571 rc = ecryptfs_validate_marker(marker);
1572 if (!rc)
1573 ecryptfs_i_size_init(file_size, inode);
1574 return rc;
1575}
1576
1577/**
1578 * ecryptfs_read_metadata
1579 *
1580 * Common entry point for reading file metadata. From here, we could
1581 * retrieve the header information from the header region of the file,
1582 * the xattr region of the file, or some other repostory that is
1583 * stored separately from the file itself. The current implementation
1584 * supports retrieving the metadata information from the file contents
1585 * and from the xattr region.
1586 *
1587 * Returns zero if valid headers found and parsed; non-zero otherwise
1588 */
1589int ecryptfs_read_metadata(struct dentry *ecryptfs_dentry)
1590{
1591 int rc = 0;
1592 char *page_virt = NULL;
1593 struct inode *ecryptfs_inode = ecryptfs_dentry->d_inode;
1594 struct ecryptfs_crypt_stat *crypt_stat =
1595 &ecryptfs_inode_to_private(ecryptfs_inode)->crypt_stat;
1596 struct ecryptfs_mount_crypt_stat *mount_crypt_stat =
1597 &ecryptfs_superblock_to_private(
1598 ecryptfs_dentry->d_sb)->mount_crypt_stat;
1599
1600 ecryptfs_copy_mount_wide_flags_to_inode_flags(crypt_stat,
1601 mount_crypt_stat);
1602 /* Read the first page from the underlying file */
1603 page_virt = kmem_cache_alloc(ecryptfs_header_cache, GFP_USER);
1604 if (!page_virt) {
1605 rc = -ENOMEM;
1606 printk(KERN_ERR "%s: Unable to allocate page_virt\n",
1607 __func__);
1608 goto out;
1609 }
1610 rc = ecryptfs_read_lower(page_virt, 0, crypt_stat->extent_size,
1611 ecryptfs_inode);
1612 if (rc >= 0)
1613 rc = ecryptfs_read_headers_virt(page_virt, crypt_stat,
1614 ecryptfs_dentry,
1615 ECRYPTFS_VALIDATE_HEADER_SIZE);
1616 if (rc) {
1617 memset(page_virt, 0, PAGE_CACHE_SIZE);
1618 rc = ecryptfs_read_xattr_region(page_virt, ecryptfs_inode);
1619 if (rc) {
1620 printk(KERN_DEBUG "Valid eCryptfs headers not found in "
1621 "file header region or xattr region\n");
1622 rc = -EINVAL;
1623 goto out;
1624 }
1625 rc = ecryptfs_read_headers_virt(page_virt, crypt_stat,
1626 ecryptfs_dentry,
1627 ECRYPTFS_DONT_VALIDATE_HEADER_SIZE);
1628 if (rc) {
1629 printk(KERN_DEBUG "Valid eCryptfs headers not found in "
1630 "file xattr region either\n");
1631 rc = -EINVAL;
1632 }
1633 if (crypt_stat->mount_crypt_stat->flags
1634 & ECRYPTFS_XATTR_METADATA_ENABLED) {
1635 crypt_stat->flags |= ECRYPTFS_METADATA_IN_XATTR;
1636 } else {
1637 printk(KERN_WARNING "Attempt to access file with "
1638 "crypto metadata only in the extended attribute "
1639 "region, but eCryptfs was mounted without "
1640 "xattr support enabled. eCryptfs will not treat "
1641 "this like an encrypted file.\n");
1642 rc = -EINVAL;
1643 }
1644 }
1645out:
1646 if (page_virt) {
1647 memset(page_virt, 0, PAGE_CACHE_SIZE);
1648 kmem_cache_free(ecryptfs_header_cache, page_virt);
1649 }
1650 return rc;
1651}
1652
1653/**
1654 * ecryptfs_encrypt_filename - encrypt filename
1655 *
1656 * CBC-encrypts the filename. We do not want to encrypt the same
1657 * filename with the same key and IV, which may happen with hard
1658 * links, so we prepend random bits to each filename.
1659 *
1660 * Returns zero on success; non-zero otherwise
1661 */
1662static int
1663ecryptfs_encrypt_filename(struct ecryptfs_filename *filename,
1664 struct ecryptfs_crypt_stat *crypt_stat,
1665 struct ecryptfs_mount_crypt_stat *mount_crypt_stat)
1666{
1667 int rc = 0;
1668
1669 filename->encrypted_filename = NULL;
1670 filename->encrypted_filename_size = 0;
1671 if ((crypt_stat && (crypt_stat->flags & ECRYPTFS_ENCFN_USE_MOUNT_FNEK))
1672 || (mount_crypt_stat && (mount_crypt_stat->flags
1673 & ECRYPTFS_GLOBAL_ENCFN_USE_MOUNT_FNEK))) {
1674 size_t packet_size;
1675 size_t remaining_bytes;
1676
1677 rc = ecryptfs_write_tag_70_packet(
1678 NULL, NULL,
1679 &filename->encrypted_filename_size,
1680 mount_crypt_stat, NULL,
1681 filename->filename_size);
1682 if (rc) {
1683 printk(KERN_ERR "%s: Error attempting to get packet "
1684 "size for tag 72; rc = [%d]\n", __func__,
1685 rc);
1686 filename->encrypted_filename_size = 0;
1687 goto out;
1688 }
1689 filename->encrypted_filename =
1690 kmalloc(filename->encrypted_filename_size, GFP_KERNEL);
1691 if (!filename->encrypted_filename) {
1692 printk(KERN_ERR "%s: Out of memory whilst attempting "
1693 "to kmalloc [%zd] bytes\n", __func__,
1694 filename->encrypted_filename_size);
1695 rc = -ENOMEM;
1696 goto out;
1697 }
1698 remaining_bytes = filename->encrypted_filename_size;
1699 rc = ecryptfs_write_tag_70_packet(filename->encrypted_filename,
1700 &remaining_bytes,
1701 &packet_size,
1702 mount_crypt_stat,
1703 filename->filename,
1704 filename->filename_size);
1705 if (rc) {
1706 printk(KERN_ERR "%s: Error attempting to generate "
1707 "tag 70 packet; rc = [%d]\n", __func__,
1708 rc);
1709 kfree(filename->encrypted_filename);
1710 filename->encrypted_filename = NULL;
1711 filename->encrypted_filename_size = 0;
1712 goto out;
1713 }
1714 filename->encrypted_filename_size = packet_size;
1715 } else {
1716 printk(KERN_ERR "%s: No support for requested filename "
1717 "encryption method in this release\n", __func__);
1718 rc = -EOPNOTSUPP;
1719 goto out;
1720 }
1721out:
1722 return rc;
1723}
1724
1725static int ecryptfs_copy_filename(char **copied_name, size_t *copied_name_size,
1726 const char *name, size_t name_size)
1727{
1728 int rc = 0;
1729
1730 (*copied_name) = kmalloc((name_size + 1), GFP_KERNEL);
1731 if (!(*copied_name)) {
1732 rc = -ENOMEM;
1733 goto out;
1734 }
1735 memcpy((void *)(*copied_name), (void *)name, name_size);
1736 (*copied_name)[(name_size)] = '\0'; /* Only for convenience
1737 * in printing out the
1738 * string in debug
1739 * messages */
1740 (*copied_name_size) = name_size;
1741out:
1742 return rc;
1743}
1744
1745/**
1746 * ecryptfs_process_key_cipher - Perform key cipher initialization.
1747 * @key_tfm: Crypto context for key material, set by this function
1748 * @cipher_name: Name of the cipher
1749 * @key_size: Size of the key in bytes
1750 *
1751 * Returns zero on success. Any crypto_tfm structs allocated here
1752 * should be released by other functions, such as on a superblock put
1753 * event, regardless of whether this function succeeds for fails.
1754 */
1755static int
1756ecryptfs_process_key_cipher(struct crypto_blkcipher **key_tfm,
1757 char *cipher_name, size_t *key_size)
1758{
1759 char dummy_key[ECRYPTFS_MAX_KEY_BYTES];
1760 char *full_alg_name = NULL;
1761 int rc;
1762
1763 *key_tfm = NULL;
1764 if (*key_size > ECRYPTFS_MAX_KEY_BYTES) {
1765 rc = -EINVAL;
1766 printk(KERN_ERR "Requested key size is [%zd] bytes; maximum "
1767 "allowable is [%d]\n", *key_size, ECRYPTFS_MAX_KEY_BYTES);
1768 goto out;
1769 }
1770 rc = ecryptfs_crypto_api_algify_cipher_name(&full_alg_name, cipher_name,
1771 "ecb");
1772 if (rc)
1773 goto out;
1774 *key_tfm = crypto_alloc_blkcipher(full_alg_name, 0, CRYPTO_ALG_ASYNC);
1775 if (IS_ERR(*key_tfm)) {
1776 rc = PTR_ERR(*key_tfm);
1777 printk(KERN_ERR "Unable to allocate crypto cipher with name "
1778 "[%s]; rc = [%d]\n", full_alg_name, rc);
1779 goto out;
1780 }
1781 crypto_blkcipher_set_flags(*key_tfm, CRYPTO_TFM_REQ_WEAK_KEY);
1782 if (*key_size == 0) {
1783 struct blkcipher_alg *alg = crypto_blkcipher_alg(*key_tfm);
1784
1785 *key_size = alg->max_keysize;
1786 }
1787 get_random_bytes(dummy_key, *key_size);
1788 rc = crypto_blkcipher_setkey(*key_tfm, dummy_key, *key_size);
1789 if (rc) {
1790 printk(KERN_ERR "Error attempting to set key of size [%zd] for "
1791 "cipher [%s]; rc = [%d]\n", *key_size, full_alg_name,
1792 rc);
1793 rc = -EINVAL;
1794 goto out;
1795 }
1796out:
1797 kfree(full_alg_name);
1798 return rc;
1799}
1800
1801struct kmem_cache *ecryptfs_key_tfm_cache;
1802static struct list_head key_tfm_list;
1803struct mutex key_tfm_list_mutex;
1804
1805int __init ecryptfs_init_crypto(void)
1806{
1807 mutex_init(&key_tfm_list_mutex);
1808 INIT_LIST_HEAD(&key_tfm_list);
1809 return 0;
1810}
1811
1812/**
1813 * ecryptfs_destroy_crypto - free all cached key_tfms on key_tfm_list
1814 *
1815 * Called only at module unload time
1816 */
1817int ecryptfs_destroy_crypto(void)
1818{
1819 struct ecryptfs_key_tfm *key_tfm, *key_tfm_tmp;
1820
1821 mutex_lock(&key_tfm_list_mutex);
1822 list_for_each_entry_safe(key_tfm, key_tfm_tmp, &key_tfm_list,
1823 key_tfm_list) {
1824 list_del(&key_tfm->key_tfm_list);
1825 if (key_tfm->key_tfm)
1826 crypto_free_blkcipher(key_tfm->key_tfm);
1827 kmem_cache_free(ecryptfs_key_tfm_cache, key_tfm);
1828 }
1829 mutex_unlock(&key_tfm_list_mutex);
1830 return 0;
1831}
1832
1833int
1834ecryptfs_add_new_key_tfm(struct ecryptfs_key_tfm **key_tfm, char *cipher_name,
1835 size_t key_size)
1836{
1837 struct ecryptfs_key_tfm *tmp_tfm;
1838 int rc = 0;
1839
1840 BUG_ON(!mutex_is_locked(&key_tfm_list_mutex));
1841
1842 tmp_tfm = kmem_cache_alloc(ecryptfs_key_tfm_cache, GFP_KERNEL);
1843 if (key_tfm != NULL)
1844 (*key_tfm) = tmp_tfm;
1845 if (!tmp_tfm) {
1846 rc = -ENOMEM;
1847 printk(KERN_ERR "Error attempting to allocate from "
1848 "ecryptfs_key_tfm_cache\n");
1849 goto out;
1850 }
1851 mutex_init(&tmp_tfm->key_tfm_mutex);
1852 strncpy(tmp_tfm->cipher_name, cipher_name,
1853 ECRYPTFS_MAX_CIPHER_NAME_SIZE);
1854 tmp_tfm->cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE] = '\0';
1855 tmp_tfm->key_size = key_size;
1856 rc = ecryptfs_process_key_cipher(&tmp_tfm->key_tfm,
1857 tmp_tfm->cipher_name,
1858 &tmp_tfm->key_size);
1859 if (rc) {
1860 printk(KERN_ERR "Error attempting to initialize key TFM "
1861 "cipher with name = [%s]; rc = [%d]\n",
1862 tmp_tfm->cipher_name, rc);
1863 kmem_cache_free(ecryptfs_key_tfm_cache, tmp_tfm);
1864 if (key_tfm != NULL)
1865 (*key_tfm) = NULL;
1866 goto out;
1867 }
1868 list_add(&tmp_tfm->key_tfm_list, &key_tfm_list);
1869out:
1870 return rc;
1871}
1872
1873/**
1874 * ecryptfs_tfm_exists - Search for existing tfm for cipher_name.
1875 * @cipher_name: the name of the cipher to search for
1876 * @key_tfm: set to corresponding tfm if found
1877 *
1878 * Searches for cached key_tfm matching @cipher_name
1879 * Must be called with &key_tfm_list_mutex held
1880 * Returns 1 if found, with @key_tfm set
1881 * Returns 0 if not found, with @key_tfm set to NULL
1882 */
1883int ecryptfs_tfm_exists(char *cipher_name, struct ecryptfs_key_tfm **key_tfm)
1884{
1885 struct ecryptfs_key_tfm *tmp_key_tfm;
1886
1887 BUG_ON(!mutex_is_locked(&key_tfm_list_mutex));
1888
1889 list_for_each_entry(tmp_key_tfm, &key_tfm_list, key_tfm_list) {
1890 if (strcmp(tmp_key_tfm->cipher_name, cipher_name) == 0) {
1891 if (key_tfm)
1892 (*key_tfm) = tmp_key_tfm;
1893 return 1;
1894 }
1895 }
1896 if (key_tfm)
1897 (*key_tfm) = NULL;
1898 return 0;
1899}
1900
1901/**
1902 * ecryptfs_get_tfm_and_mutex_for_cipher_name
1903 *
1904 * @tfm: set to cached tfm found, or new tfm created
1905 * @tfm_mutex: set to mutex for cached tfm found, or new tfm created
1906 * @cipher_name: the name of the cipher to search for and/or add
1907 *
1908 * Sets pointers to @tfm & @tfm_mutex matching @cipher_name.
1909 * Searches for cached item first, and creates new if not found.
1910 * Returns 0 on success, non-zero if adding new cipher failed
1911 */
1912int ecryptfs_get_tfm_and_mutex_for_cipher_name(struct crypto_blkcipher **tfm,
1913 struct mutex **tfm_mutex,
1914 char *cipher_name)
1915{
1916 struct ecryptfs_key_tfm *key_tfm;
1917 int rc = 0;
1918
1919 (*tfm) = NULL;
1920 (*tfm_mutex) = NULL;
1921
1922 mutex_lock(&key_tfm_list_mutex);
1923 if (!ecryptfs_tfm_exists(cipher_name, &key_tfm)) {
1924 rc = ecryptfs_add_new_key_tfm(&key_tfm, cipher_name, 0);
1925 if (rc) {
1926 printk(KERN_ERR "Error adding new key_tfm to list; "
1927 "rc = [%d]\n", rc);
1928 goto out;
1929 }
1930 }
1931 (*tfm) = key_tfm->key_tfm;
1932 (*tfm_mutex) = &key_tfm->key_tfm_mutex;
1933out:
1934 mutex_unlock(&key_tfm_list_mutex);
1935 return rc;
1936}
1937
1938/* 64 characters forming a 6-bit target field */
1939static unsigned char *portable_filename_chars = ("-.0123456789ABCD"
1940 "EFGHIJKLMNOPQRST"
1941 "UVWXYZabcdefghij"
1942 "klmnopqrstuvwxyz");
1943
1944/* We could either offset on every reverse map or just pad some 0x00's
1945 * at the front here */
1946static const unsigned char filename_rev_map[] = {
1947 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 7 */
1948 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 15 */
1949 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 23 */
1950 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 31 */
1951 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 39 */
1952 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, /* 47 */
1953 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, /* 55 */
1954 0x0A, 0x0B, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 63 */
1955 0x00, 0x0C, 0x0D, 0x0E, 0x0F, 0x10, 0x11, 0x12, /* 71 */
1956 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1A, /* 79 */
1957 0x1B, 0x1C, 0x1D, 0x1E, 0x1F, 0x20, 0x21, 0x22, /* 87 */
1958 0x23, 0x24, 0x25, 0x00, 0x00, 0x00, 0x00, 0x00, /* 95 */
1959 0x00, 0x26, 0x27, 0x28, 0x29, 0x2A, 0x2B, 0x2C, /* 103 */
1960 0x2D, 0x2E, 0x2F, 0x30, 0x31, 0x32, 0x33, 0x34, /* 111 */
1961 0x35, 0x36, 0x37, 0x38, 0x39, 0x3A, 0x3B, 0x3C, /* 119 */
1962 0x3D, 0x3E, 0x3F
1963};
1964
1965/**
1966 * ecryptfs_encode_for_filename
1967 * @dst: Destination location for encoded filename
1968 * @dst_size: Size of the encoded filename in bytes
1969 * @src: Source location for the filename to encode
1970 * @src_size: Size of the source in bytes
1971 */
1972void ecryptfs_encode_for_filename(unsigned char *dst, size_t *dst_size,
1973 unsigned char *src, size_t src_size)
1974{
1975 size_t num_blocks;
1976 size_t block_num = 0;
1977 size_t dst_offset = 0;
1978 unsigned char last_block[3];
1979
1980 if (src_size == 0) {
1981 (*dst_size) = 0;
1982 goto out;
1983 }
1984 num_blocks = (src_size / 3);
1985 if ((src_size % 3) == 0) {
1986 memcpy(last_block, (&src[src_size - 3]), 3);
1987 } else {
1988 num_blocks++;
1989 last_block[2] = 0x00;
1990 switch (src_size % 3) {
1991 case 1:
1992 last_block[0] = src[src_size - 1];
1993 last_block[1] = 0x00;
1994 break;
1995 case 2:
1996 last_block[0] = src[src_size - 2];
1997 last_block[1] = src[src_size - 1];
1998 }
1999 }
2000 (*dst_size) = (num_blocks * 4);
2001 if (!dst)
2002 goto out;
2003 while (block_num < num_blocks) {
2004 unsigned char *src_block;
2005 unsigned char dst_block[4];
2006
2007 if (block_num == (num_blocks - 1))
2008 src_block = last_block;
2009 else
2010 src_block = &src[block_num * 3];
2011 dst_block[0] = ((src_block[0] >> 2) & 0x3F);
2012 dst_block[1] = (((src_block[0] << 4) & 0x30)
2013 | ((src_block[1] >> 4) & 0x0F));
2014 dst_block[2] = (((src_block[1] << 2) & 0x3C)
2015 | ((src_block[2] >> 6) & 0x03));
2016 dst_block[3] = (src_block[2] & 0x3F);
2017 dst[dst_offset++] = portable_filename_chars[dst_block[0]];
2018 dst[dst_offset++] = portable_filename_chars[dst_block[1]];
2019 dst[dst_offset++] = portable_filename_chars[dst_block[2]];
2020 dst[dst_offset++] = portable_filename_chars[dst_block[3]];
2021 block_num++;
2022 }
2023out:
2024 return;
2025}
2026
2027/**
2028 * ecryptfs_decode_from_filename
2029 * @dst: If NULL, this function only sets @dst_size and returns. If
2030 * non-NULL, this function decodes the encoded octets in @src
2031 * into the memory that @dst points to.
2032 * @dst_size: Set to the size of the decoded string.
2033 * @src: The encoded set of octets to decode.
2034 * @src_size: The size of the encoded set of octets to decode.
2035 */
2036static void
2037ecryptfs_decode_from_filename(unsigned char *dst, size_t *dst_size,
2038 const unsigned char *src, size_t src_size)
2039{
2040 u8 current_bit_offset = 0;
2041 size_t src_byte_offset = 0;
2042 size_t dst_byte_offset = 0;
2043
2044 if (dst == NULL) {
2045 /* Not exact; conservatively long. Every block of 4
2046 * encoded characters decodes into a block of 3
2047 * decoded characters. This segment of code provides
2048 * the caller with the maximum amount of allocated
2049 * space that @dst will need to point to in a
2050 * subsequent call. */
2051 (*dst_size) = (((src_size + 1) * 3) / 4);
2052 goto out;
2053 }
2054 while (src_byte_offset < src_size) {
2055 unsigned char src_byte =
2056 filename_rev_map[(int)src[src_byte_offset]];
2057
2058 switch (current_bit_offset) {
2059 case 0:
2060 dst[dst_byte_offset] = (src_byte << 2);
2061 current_bit_offset = 6;
2062 break;
2063 case 6:
2064 dst[dst_byte_offset++] |= (src_byte >> 4);
2065 dst[dst_byte_offset] = ((src_byte & 0xF)
2066 << 4);
2067 current_bit_offset = 4;
2068 break;
2069 case 4:
2070 dst[dst_byte_offset++] |= (src_byte >> 2);
2071 dst[dst_byte_offset] = (src_byte << 6);
2072 current_bit_offset = 2;
2073 break;
2074 case 2:
2075 dst[dst_byte_offset++] |= (src_byte);
2076 dst[dst_byte_offset] = 0;
2077 current_bit_offset = 0;
2078 break;
2079 }
2080 src_byte_offset++;
2081 }
2082 (*dst_size) = dst_byte_offset;
2083out:
2084 return;
2085}
2086
2087/**
2088 * ecryptfs_encrypt_and_encode_filename - converts a plaintext file name to cipher text
2089 * @crypt_stat: The crypt_stat struct associated with the file anem to encode
2090 * @name: The plaintext name
2091 * @length: The length of the plaintext
2092 * @encoded_name: The encypted name
2093 *
2094 * Encrypts and encodes a filename into something that constitutes a
2095 * valid filename for a filesystem, with printable characters.
2096 *
2097 * We assume that we have a properly initialized crypto context,
2098 * pointed to by crypt_stat->tfm.
2099 *
2100 * Returns zero on success; non-zero on otherwise
2101 */
2102int ecryptfs_encrypt_and_encode_filename(
2103 char **encoded_name,
2104 size_t *encoded_name_size,
2105 struct ecryptfs_crypt_stat *crypt_stat,
2106 struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
2107 const char *name, size_t name_size)
2108{
2109 size_t encoded_name_no_prefix_size;
2110 int rc = 0;
2111
2112 (*encoded_name) = NULL;
2113 (*encoded_name_size) = 0;
2114 if ((crypt_stat && (crypt_stat->flags & ECRYPTFS_ENCRYPT_FILENAMES))
2115 || (mount_crypt_stat && (mount_crypt_stat->flags
2116 & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES))) {
2117 struct ecryptfs_filename *filename;
2118
2119 filename = kzalloc(sizeof(*filename), GFP_KERNEL);
2120 if (!filename) {
2121 printk(KERN_ERR "%s: Out of memory whilst attempting "
2122 "to kzalloc [%zd] bytes\n", __func__,
2123 sizeof(*filename));
2124 rc = -ENOMEM;
2125 goto out;
2126 }
2127 filename->filename = (char *)name;
2128 filename->filename_size = name_size;
2129 rc = ecryptfs_encrypt_filename(filename, crypt_stat,
2130 mount_crypt_stat);
2131 if (rc) {
2132 printk(KERN_ERR "%s: Error attempting to encrypt "
2133 "filename; rc = [%d]\n", __func__, rc);
2134 kfree(filename);
2135 goto out;
2136 }
2137 ecryptfs_encode_for_filename(
2138 NULL, &encoded_name_no_prefix_size,
2139 filename->encrypted_filename,
2140 filename->encrypted_filename_size);
2141 if ((crypt_stat && (crypt_stat->flags
2142 & ECRYPTFS_ENCFN_USE_MOUNT_FNEK))
2143 || (mount_crypt_stat
2144 && (mount_crypt_stat->flags
2145 & ECRYPTFS_GLOBAL_ENCFN_USE_MOUNT_FNEK)))
2146 (*encoded_name_size) =
2147 (ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX_SIZE
2148 + encoded_name_no_prefix_size);
2149 else
2150 (*encoded_name_size) =
2151 (ECRYPTFS_FEK_ENCRYPTED_FILENAME_PREFIX_SIZE
2152 + encoded_name_no_prefix_size);
2153 (*encoded_name) = kmalloc((*encoded_name_size) + 1, GFP_KERNEL);
2154 if (!(*encoded_name)) {
2155 printk(KERN_ERR "%s: Out of memory whilst attempting "
2156 "to kzalloc [%zd] bytes\n", __func__,
2157 (*encoded_name_size));
2158 rc = -ENOMEM;
2159 kfree(filename->encrypted_filename);
2160 kfree(filename);
2161 goto out;
2162 }
2163 if ((crypt_stat && (crypt_stat->flags
2164 & ECRYPTFS_ENCFN_USE_MOUNT_FNEK))
2165 || (mount_crypt_stat
2166 && (mount_crypt_stat->flags
2167 & ECRYPTFS_GLOBAL_ENCFN_USE_MOUNT_FNEK))) {
2168 memcpy((*encoded_name),
2169 ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX,
2170 ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX_SIZE);
2171 ecryptfs_encode_for_filename(
2172 ((*encoded_name)
2173 + ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX_SIZE),
2174 &encoded_name_no_prefix_size,
2175 filename->encrypted_filename,
2176 filename->encrypted_filename_size);
2177 (*encoded_name_size) =
2178 (ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX_SIZE
2179 + encoded_name_no_prefix_size);
2180 (*encoded_name)[(*encoded_name_size)] = '\0';
2181 } else {
2182 rc = -EOPNOTSUPP;
2183 }
2184 if (rc) {
2185 printk(KERN_ERR "%s: Error attempting to encode "
2186 "encrypted filename; rc = [%d]\n", __func__,
2187 rc);
2188 kfree((*encoded_name));
2189 (*encoded_name) = NULL;
2190 (*encoded_name_size) = 0;
2191 }
2192 kfree(filename->encrypted_filename);
2193 kfree(filename);
2194 } else {
2195 rc = ecryptfs_copy_filename(encoded_name,
2196 encoded_name_size,
2197 name, name_size);
2198 }
2199out:
2200 return rc;
2201}
2202
2203/**
2204 * ecryptfs_decode_and_decrypt_filename - converts the encoded cipher text name to decoded plaintext
2205 * @plaintext_name: The plaintext name
2206 * @plaintext_name_size: The plaintext name size
2207 * @ecryptfs_dir_dentry: eCryptfs directory dentry
2208 * @name: The filename in cipher text
2209 * @name_size: The cipher text name size
2210 *
2211 * Decrypts and decodes the filename.
2212 *
2213 * Returns zero on error; non-zero otherwise
2214 */
2215int ecryptfs_decode_and_decrypt_filename(char **plaintext_name,
2216 size_t *plaintext_name_size,
2217 struct dentry *ecryptfs_dir_dentry,
2218 const char *name, size_t name_size)
2219{
2220 struct ecryptfs_mount_crypt_stat *mount_crypt_stat =
2221 &ecryptfs_superblock_to_private(
2222 ecryptfs_dir_dentry->d_sb)->mount_crypt_stat;
2223 char *decoded_name;
2224 size_t decoded_name_size;
2225 size_t packet_size;
2226 int rc = 0;
2227
2228 if ((mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES)
2229 && !(mount_crypt_stat->flags & ECRYPTFS_ENCRYPTED_VIEW_ENABLED)
2230 && (name_size > ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX_SIZE)
2231 && (strncmp(name, ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX,
2232 ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX_SIZE) == 0)) {
2233 const char *orig_name = name;
2234 size_t orig_name_size = name_size;
2235
2236 name += ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX_SIZE;
2237 name_size -= ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX_SIZE;
2238 ecryptfs_decode_from_filename(NULL, &decoded_name_size,
2239 name, name_size);
2240 decoded_name = kmalloc(decoded_name_size, GFP_KERNEL);
2241 if (!decoded_name) {
2242 printk(KERN_ERR "%s: Out of memory whilst attempting "
2243 "to kmalloc [%zd] bytes\n", __func__,
2244 decoded_name_size);
2245 rc = -ENOMEM;
2246 goto out;
2247 }
2248 ecryptfs_decode_from_filename(decoded_name, &decoded_name_size,
2249 name, name_size);
2250 rc = ecryptfs_parse_tag_70_packet(plaintext_name,
2251 plaintext_name_size,
2252 &packet_size,
2253 mount_crypt_stat,
2254 decoded_name,
2255 decoded_name_size);
2256 if (rc) {
2257 printk(KERN_INFO "%s: Could not parse tag 70 packet "
2258 "from filename; copying through filename "
2259 "as-is\n", __func__);
2260 rc = ecryptfs_copy_filename(plaintext_name,
2261 plaintext_name_size,
2262 orig_name, orig_name_size);
2263 goto out_free;
2264 }
2265 } else {
2266 rc = ecryptfs_copy_filename(plaintext_name,
2267 plaintext_name_size,
2268 name, name_size);
2269 goto out;
2270 }
2271out_free:
2272 kfree(decoded_name);
2273out:
2274 return rc;
2275}
1/**
2 * eCryptfs: Linux filesystem encryption layer
3 *
4 * Copyright (C) 1997-2004 Erez Zadok
5 * Copyright (C) 2001-2004 Stony Brook University
6 * Copyright (C) 2004-2007 International Business Machines Corp.
7 * Author(s): Michael A. Halcrow <mahalcro@us.ibm.com>
8 * Michael C. Thompson <mcthomps@us.ibm.com>
9 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License as
12 * published by the Free Software Foundation; either version 2 of the
13 * License, or (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
23 * 02111-1307, USA.
24 */
25
26#include <crypto/hash.h>
27#include <crypto/skcipher.h>
28#include <linux/fs.h>
29#include <linux/mount.h>
30#include <linux/pagemap.h>
31#include <linux/random.h>
32#include <linux/compiler.h>
33#include <linux/key.h>
34#include <linux/namei.h>
35#include <linux/file.h>
36#include <linux/scatterlist.h>
37#include <linux/slab.h>
38#include <asm/unaligned.h>
39#include <linux/kernel.h>
40#include "ecryptfs_kernel.h"
41
42#define DECRYPT 0
43#define ENCRYPT 1
44
45/**
46 * ecryptfs_from_hex
47 * @dst: Buffer to take the bytes from src hex; must be at least of
48 * size (src_size / 2)
49 * @src: Buffer to be converted from a hex string representation to raw value
50 * @dst_size: size of dst buffer, or number of hex characters pairs to convert
51 */
52void ecryptfs_from_hex(char *dst, char *src, int dst_size)
53{
54 int x;
55 char tmp[3] = { 0, };
56
57 for (x = 0; x < dst_size; x++) {
58 tmp[0] = src[x * 2];
59 tmp[1] = src[x * 2 + 1];
60 dst[x] = (unsigned char)simple_strtol(tmp, NULL, 16);
61 }
62}
63
64static int ecryptfs_hash_digest(struct crypto_shash *tfm,
65 char *src, int len, char *dst)
66{
67 SHASH_DESC_ON_STACK(desc, tfm);
68 int err;
69
70 desc->tfm = tfm;
71 desc->flags = CRYPTO_TFM_REQ_MAY_SLEEP;
72 err = crypto_shash_digest(desc, src, len, dst);
73 shash_desc_zero(desc);
74 return err;
75}
76
77/**
78 * ecryptfs_calculate_md5 - calculates the md5 of @src
79 * @dst: Pointer to 16 bytes of allocated memory
80 * @crypt_stat: Pointer to crypt_stat struct for the current inode
81 * @src: Data to be md5'd
82 * @len: Length of @src
83 *
84 * Uses the allocated crypto context that crypt_stat references to
85 * generate the MD5 sum of the contents of src.
86 */
87static int ecryptfs_calculate_md5(char *dst,
88 struct ecryptfs_crypt_stat *crypt_stat,
89 char *src, int len)
90{
91 struct crypto_shash *tfm;
92 int rc = 0;
93
94 tfm = crypt_stat->hash_tfm;
95 rc = ecryptfs_hash_digest(tfm, src, len, dst);
96 if (rc) {
97 printk(KERN_ERR
98 "%s: Error computing crypto hash; rc = [%d]\n",
99 __func__, rc);
100 goto out;
101 }
102out:
103 return rc;
104}
105
106static int ecryptfs_crypto_api_algify_cipher_name(char **algified_name,
107 char *cipher_name,
108 char *chaining_modifier)
109{
110 int cipher_name_len = strlen(cipher_name);
111 int chaining_modifier_len = strlen(chaining_modifier);
112 int algified_name_len;
113 int rc;
114
115 algified_name_len = (chaining_modifier_len + cipher_name_len + 3);
116 (*algified_name) = kmalloc(algified_name_len, GFP_KERNEL);
117 if (!(*algified_name)) {
118 rc = -ENOMEM;
119 goto out;
120 }
121 snprintf((*algified_name), algified_name_len, "%s(%s)",
122 chaining_modifier, cipher_name);
123 rc = 0;
124out:
125 return rc;
126}
127
128/**
129 * ecryptfs_derive_iv
130 * @iv: destination for the derived iv vale
131 * @crypt_stat: Pointer to crypt_stat struct for the current inode
132 * @offset: Offset of the extent whose IV we are to derive
133 *
134 * Generate the initialization vector from the given root IV and page
135 * offset.
136 *
137 * Returns zero on success; non-zero on error.
138 */
139int ecryptfs_derive_iv(char *iv, struct ecryptfs_crypt_stat *crypt_stat,
140 loff_t offset)
141{
142 int rc = 0;
143 char dst[MD5_DIGEST_SIZE];
144 char src[ECRYPTFS_MAX_IV_BYTES + 16];
145
146 if (unlikely(ecryptfs_verbosity > 0)) {
147 ecryptfs_printk(KERN_DEBUG, "root iv:\n");
148 ecryptfs_dump_hex(crypt_stat->root_iv, crypt_stat->iv_bytes);
149 }
150 /* TODO: It is probably secure to just cast the least
151 * significant bits of the root IV into an unsigned long and
152 * add the offset to that rather than go through all this
153 * hashing business. -Halcrow */
154 memcpy(src, crypt_stat->root_iv, crypt_stat->iv_bytes);
155 memset((src + crypt_stat->iv_bytes), 0, 16);
156 snprintf((src + crypt_stat->iv_bytes), 16, "%lld", offset);
157 if (unlikely(ecryptfs_verbosity > 0)) {
158 ecryptfs_printk(KERN_DEBUG, "source:\n");
159 ecryptfs_dump_hex(src, (crypt_stat->iv_bytes + 16));
160 }
161 rc = ecryptfs_calculate_md5(dst, crypt_stat, src,
162 (crypt_stat->iv_bytes + 16));
163 if (rc) {
164 ecryptfs_printk(KERN_WARNING, "Error attempting to compute "
165 "MD5 while generating IV for a page\n");
166 goto out;
167 }
168 memcpy(iv, dst, crypt_stat->iv_bytes);
169 if (unlikely(ecryptfs_verbosity > 0)) {
170 ecryptfs_printk(KERN_DEBUG, "derived iv:\n");
171 ecryptfs_dump_hex(iv, crypt_stat->iv_bytes);
172 }
173out:
174 return rc;
175}
176
177/**
178 * ecryptfs_init_crypt_stat
179 * @crypt_stat: Pointer to the crypt_stat struct to initialize.
180 *
181 * Initialize the crypt_stat structure.
182 */
183int ecryptfs_init_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat)
184{
185 struct crypto_shash *tfm;
186 int rc;
187
188 tfm = crypto_alloc_shash(ECRYPTFS_DEFAULT_HASH, 0, 0);
189 if (IS_ERR(tfm)) {
190 rc = PTR_ERR(tfm);
191 ecryptfs_printk(KERN_ERR, "Error attempting to "
192 "allocate crypto context; rc = [%d]\n",
193 rc);
194 return rc;
195 }
196
197 memset((void *)crypt_stat, 0, sizeof(struct ecryptfs_crypt_stat));
198 INIT_LIST_HEAD(&crypt_stat->keysig_list);
199 mutex_init(&crypt_stat->keysig_list_mutex);
200 mutex_init(&crypt_stat->cs_mutex);
201 mutex_init(&crypt_stat->cs_tfm_mutex);
202 crypt_stat->hash_tfm = tfm;
203 crypt_stat->flags |= ECRYPTFS_STRUCT_INITIALIZED;
204
205 return 0;
206}
207
208/**
209 * ecryptfs_destroy_crypt_stat
210 * @crypt_stat: Pointer to the crypt_stat struct to initialize.
211 *
212 * Releases all memory associated with a crypt_stat struct.
213 */
214void ecryptfs_destroy_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat)
215{
216 struct ecryptfs_key_sig *key_sig, *key_sig_tmp;
217
218 crypto_free_skcipher(crypt_stat->tfm);
219 crypto_free_shash(crypt_stat->hash_tfm);
220 list_for_each_entry_safe(key_sig, key_sig_tmp,
221 &crypt_stat->keysig_list, crypt_stat_list) {
222 list_del(&key_sig->crypt_stat_list);
223 kmem_cache_free(ecryptfs_key_sig_cache, key_sig);
224 }
225 memset(crypt_stat, 0, sizeof(struct ecryptfs_crypt_stat));
226}
227
228void ecryptfs_destroy_mount_crypt_stat(
229 struct ecryptfs_mount_crypt_stat *mount_crypt_stat)
230{
231 struct ecryptfs_global_auth_tok *auth_tok, *auth_tok_tmp;
232
233 if (!(mount_crypt_stat->flags & ECRYPTFS_MOUNT_CRYPT_STAT_INITIALIZED))
234 return;
235 mutex_lock(&mount_crypt_stat->global_auth_tok_list_mutex);
236 list_for_each_entry_safe(auth_tok, auth_tok_tmp,
237 &mount_crypt_stat->global_auth_tok_list,
238 mount_crypt_stat_list) {
239 list_del(&auth_tok->mount_crypt_stat_list);
240 if (!(auth_tok->flags & ECRYPTFS_AUTH_TOK_INVALID))
241 key_put(auth_tok->global_auth_tok_key);
242 kmem_cache_free(ecryptfs_global_auth_tok_cache, auth_tok);
243 }
244 mutex_unlock(&mount_crypt_stat->global_auth_tok_list_mutex);
245 memset(mount_crypt_stat, 0, sizeof(struct ecryptfs_mount_crypt_stat));
246}
247
248/**
249 * virt_to_scatterlist
250 * @addr: Virtual address
251 * @size: Size of data; should be an even multiple of the block size
252 * @sg: Pointer to scatterlist array; set to NULL to obtain only
253 * the number of scatterlist structs required in array
254 * @sg_size: Max array size
255 *
256 * Fills in a scatterlist array with page references for a passed
257 * virtual address.
258 *
259 * Returns the number of scatterlist structs in array used
260 */
261int virt_to_scatterlist(const void *addr, int size, struct scatterlist *sg,
262 int sg_size)
263{
264 int i = 0;
265 struct page *pg;
266 int offset;
267 int remainder_of_page;
268
269 sg_init_table(sg, sg_size);
270
271 while (size > 0 && i < sg_size) {
272 pg = virt_to_page(addr);
273 offset = offset_in_page(addr);
274 sg_set_page(&sg[i], pg, 0, offset);
275 remainder_of_page = PAGE_SIZE - offset;
276 if (size >= remainder_of_page) {
277 sg[i].length = remainder_of_page;
278 addr += remainder_of_page;
279 size -= remainder_of_page;
280 } else {
281 sg[i].length = size;
282 addr += size;
283 size = 0;
284 }
285 i++;
286 }
287 if (size > 0)
288 return -ENOMEM;
289 return i;
290}
291
292struct extent_crypt_result {
293 struct completion completion;
294 int rc;
295};
296
297static void extent_crypt_complete(struct crypto_async_request *req, int rc)
298{
299 struct extent_crypt_result *ecr = req->data;
300
301 if (rc == -EINPROGRESS)
302 return;
303
304 ecr->rc = rc;
305 complete(&ecr->completion);
306}
307
308/**
309 * crypt_scatterlist
310 * @crypt_stat: Pointer to the crypt_stat struct to initialize.
311 * @dst_sg: Destination of the data after performing the crypto operation
312 * @src_sg: Data to be encrypted or decrypted
313 * @size: Length of data
314 * @iv: IV to use
315 * @op: ENCRYPT or DECRYPT to indicate the desired operation
316 *
317 * Returns the number of bytes encrypted or decrypted; negative value on error
318 */
319static int crypt_scatterlist(struct ecryptfs_crypt_stat *crypt_stat,
320 struct scatterlist *dst_sg,
321 struct scatterlist *src_sg, int size,
322 unsigned char *iv, int op)
323{
324 struct skcipher_request *req = NULL;
325 struct extent_crypt_result ecr;
326 int rc = 0;
327
328 BUG_ON(!crypt_stat || !crypt_stat->tfm
329 || !(crypt_stat->flags & ECRYPTFS_STRUCT_INITIALIZED));
330 if (unlikely(ecryptfs_verbosity > 0)) {
331 ecryptfs_printk(KERN_DEBUG, "Key size [%zd]; key:\n",
332 crypt_stat->key_size);
333 ecryptfs_dump_hex(crypt_stat->key,
334 crypt_stat->key_size);
335 }
336
337 init_completion(&ecr.completion);
338
339 mutex_lock(&crypt_stat->cs_tfm_mutex);
340 req = skcipher_request_alloc(crypt_stat->tfm, GFP_NOFS);
341 if (!req) {
342 mutex_unlock(&crypt_stat->cs_tfm_mutex);
343 rc = -ENOMEM;
344 goto out;
345 }
346
347 skcipher_request_set_callback(req,
348 CRYPTO_TFM_REQ_MAY_BACKLOG | CRYPTO_TFM_REQ_MAY_SLEEP,
349 extent_crypt_complete, &ecr);
350 /* Consider doing this once, when the file is opened */
351 if (!(crypt_stat->flags & ECRYPTFS_KEY_SET)) {
352 rc = crypto_skcipher_setkey(crypt_stat->tfm, crypt_stat->key,
353 crypt_stat->key_size);
354 if (rc) {
355 ecryptfs_printk(KERN_ERR,
356 "Error setting key; rc = [%d]\n",
357 rc);
358 mutex_unlock(&crypt_stat->cs_tfm_mutex);
359 rc = -EINVAL;
360 goto out;
361 }
362 crypt_stat->flags |= ECRYPTFS_KEY_SET;
363 }
364 mutex_unlock(&crypt_stat->cs_tfm_mutex);
365 skcipher_request_set_crypt(req, src_sg, dst_sg, size, iv);
366 rc = op == ENCRYPT ? crypto_skcipher_encrypt(req) :
367 crypto_skcipher_decrypt(req);
368 if (rc == -EINPROGRESS || rc == -EBUSY) {
369 struct extent_crypt_result *ecr = req->base.data;
370
371 wait_for_completion(&ecr->completion);
372 rc = ecr->rc;
373 reinit_completion(&ecr->completion);
374 }
375out:
376 skcipher_request_free(req);
377 return rc;
378}
379
380/**
381 * lower_offset_for_page
382 *
383 * Convert an eCryptfs page index into a lower byte offset
384 */
385static loff_t lower_offset_for_page(struct ecryptfs_crypt_stat *crypt_stat,
386 struct page *page)
387{
388 return ecryptfs_lower_header_size(crypt_stat) +
389 ((loff_t)page->index << PAGE_SHIFT);
390}
391
392/**
393 * crypt_extent
394 * @crypt_stat: crypt_stat containing cryptographic context for the
395 * encryption operation
396 * @dst_page: The page to write the result into
397 * @src_page: The page to read from
398 * @extent_offset: Page extent offset for use in generating IV
399 * @op: ENCRYPT or DECRYPT to indicate the desired operation
400 *
401 * Encrypts or decrypts one extent of data.
402 *
403 * Return zero on success; non-zero otherwise
404 */
405static int crypt_extent(struct ecryptfs_crypt_stat *crypt_stat,
406 struct page *dst_page,
407 struct page *src_page,
408 unsigned long extent_offset, int op)
409{
410 pgoff_t page_index = op == ENCRYPT ? src_page->index : dst_page->index;
411 loff_t extent_base;
412 char extent_iv[ECRYPTFS_MAX_IV_BYTES];
413 struct scatterlist src_sg, dst_sg;
414 size_t extent_size = crypt_stat->extent_size;
415 int rc;
416
417 extent_base = (((loff_t)page_index) * (PAGE_SIZE / extent_size));
418 rc = ecryptfs_derive_iv(extent_iv, crypt_stat,
419 (extent_base + extent_offset));
420 if (rc) {
421 ecryptfs_printk(KERN_ERR, "Error attempting to derive IV for "
422 "extent [0x%.16llx]; rc = [%d]\n",
423 (unsigned long long)(extent_base + extent_offset), rc);
424 goto out;
425 }
426
427 sg_init_table(&src_sg, 1);
428 sg_init_table(&dst_sg, 1);
429
430 sg_set_page(&src_sg, src_page, extent_size,
431 extent_offset * extent_size);
432 sg_set_page(&dst_sg, dst_page, extent_size,
433 extent_offset * extent_size);
434
435 rc = crypt_scatterlist(crypt_stat, &dst_sg, &src_sg, extent_size,
436 extent_iv, op);
437 if (rc < 0) {
438 printk(KERN_ERR "%s: Error attempting to crypt page with "
439 "page_index = [%ld], extent_offset = [%ld]; "
440 "rc = [%d]\n", __func__, page_index, extent_offset, rc);
441 goto out;
442 }
443 rc = 0;
444out:
445 return rc;
446}
447
448/**
449 * ecryptfs_encrypt_page
450 * @page: Page mapped from the eCryptfs inode for the file; contains
451 * decrypted content that needs to be encrypted (to a temporary
452 * page; not in place) and written out to the lower file
453 *
454 * Encrypt an eCryptfs page. This is done on a per-extent basis. Note
455 * that eCryptfs pages may straddle the lower pages -- for instance,
456 * if the file was created on a machine with an 8K page size
457 * (resulting in an 8K header), and then the file is copied onto a
458 * host with a 32K page size, then when reading page 0 of the eCryptfs
459 * file, 24K of page 0 of the lower file will be read and decrypted,
460 * and then 8K of page 1 of the lower file will be read and decrypted.
461 *
462 * Returns zero on success; negative on error
463 */
464int ecryptfs_encrypt_page(struct page *page)
465{
466 struct inode *ecryptfs_inode;
467 struct ecryptfs_crypt_stat *crypt_stat;
468 char *enc_extent_virt;
469 struct page *enc_extent_page = NULL;
470 loff_t extent_offset;
471 loff_t lower_offset;
472 int rc = 0;
473
474 ecryptfs_inode = page->mapping->host;
475 crypt_stat =
476 &(ecryptfs_inode_to_private(ecryptfs_inode)->crypt_stat);
477 BUG_ON(!(crypt_stat->flags & ECRYPTFS_ENCRYPTED));
478 enc_extent_page = alloc_page(GFP_USER);
479 if (!enc_extent_page) {
480 rc = -ENOMEM;
481 ecryptfs_printk(KERN_ERR, "Error allocating memory for "
482 "encrypted extent\n");
483 goto out;
484 }
485
486 for (extent_offset = 0;
487 extent_offset < (PAGE_SIZE / crypt_stat->extent_size);
488 extent_offset++) {
489 rc = crypt_extent(crypt_stat, enc_extent_page, page,
490 extent_offset, ENCRYPT);
491 if (rc) {
492 printk(KERN_ERR "%s: Error encrypting extent; "
493 "rc = [%d]\n", __func__, rc);
494 goto out;
495 }
496 }
497
498 lower_offset = lower_offset_for_page(crypt_stat, page);
499 enc_extent_virt = kmap(enc_extent_page);
500 rc = ecryptfs_write_lower(ecryptfs_inode, enc_extent_virt, lower_offset,
501 PAGE_SIZE);
502 kunmap(enc_extent_page);
503 if (rc < 0) {
504 ecryptfs_printk(KERN_ERR,
505 "Error attempting to write lower page; rc = [%d]\n",
506 rc);
507 goto out;
508 }
509 rc = 0;
510out:
511 if (enc_extent_page) {
512 __free_page(enc_extent_page);
513 }
514 return rc;
515}
516
517/**
518 * ecryptfs_decrypt_page
519 * @page: Page mapped from the eCryptfs inode for the file; data read
520 * and decrypted from the lower file will be written into this
521 * page
522 *
523 * Decrypt an eCryptfs page. This is done on a per-extent basis. Note
524 * that eCryptfs pages may straddle the lower pages -- for instance,
525 * if the file was created on a machine with an 8K page size
526 * (resulting in an 8K header), and then the file is copied onto a
527 * host with a 32K page size, then when reading page 0 of the eCryptfs
528 * file, 24K of page 0 of the lower file will be read and decrypted,
529 * and then 8K of page 1 of the lower file will be read and decrypted.
530 *
531 * Returns zero on success; negative on error
532 */
533int ecryptfs_decrypt_page(struct page *page)
534{
535 struct inode *ecryptfs_inode;
536 struct ecryptfs_crypt_stat *crypt_stat;
537 char *page_virt;
538 unsigned long extent_offset;
539 loff_t lower_offset;
540 int rc = 0;
541
542 ecryptfs_inode = page->mapping->host;
543 crypt_stat =
544 &(ecryptfs_inode_to_private(ecryptfs_inode)->crypt_stat);
545 BUG_ON(!(crypt_stat->flags & ECRYPTFS_ENCRYPTED));
546
547 lower_offset = lower_offset_for_page(crypt_stat, page);
548 page_virt = kmap(page);
549 rc = ecryptfs_read_lower(page_virt, lower_offset, PAGE_SIZE,
550 ecryptfs_inode);
551 kunmap(page);
552 if (rc < 0) {
553 ecryptfs_printk(KERN_ERR,
554 "Error attempting to read lower page; rc = [%d]\n",
555 rc);
556 goto out;
557 }
558
559 for (extent_offset = 0;
560 extent_offset < (PAGE_SIZE / crypt_stat->extent_size);
561 extent_offset++) {
562 rc = crypt_extent(crypt_stat, page, page,
563 extent_offset, DECRYPT);
564 if (rc) {
565 printk(KERN_ERR "%s: Error encrypting extent; "
566 "rc = [%d]\n", __func__, rc);
567 goto out;
568 }
569 }
570out:
571 return rc;
572}
573
574#define ECRYPTFS_MAX_SCATTERLIST_LEN 4
575
576/**
577 * ecryptfs_init_crypt_ctx
578 * @crypt_stat: Uninitialized crypt stats structure
579 *
580 * Initialize the crypto context.
581 *
582 * TODO: Performance: Keep a cache of initialized cipher contexts;
583 * only init if needed
584 */
585int ecryptfs_init_crypt_ctx(struct ecryptfs_crypt_stat *crypt_stat)
586{
587 char *full_alg_name;
588 int rc = -EINVAL;
589
590 ecryptfs_printk(KERN_DEBUG,
591 "Initializing cipher [%s]; strlen = [%d]; "
592 "key_size_bits = [%zd]\n",
593 crypt_stat->cipher, (int)strlen(crypt_stat->cipher),
594 crypt_stat->key_size << 3);
595 mutex_lock(&crypt_stat->cs_tfm_mutex);
596 if (crypt_stat->tfm) {
597 rc = 0;
598 goto out_unlock;
599 }
600 rc = ecryptfs_crypto_api_algify_cipher_name(&full_alg_name,
601 crypt_stat->cipher, "cbc");
602 if (rc)
603 goto out_unlock;
604 crypt_stat->tfm = crypto_alloc_skcipher(full_alg_name, 0, 0);
605 if (IS_ERR(crypt_stat->tfm)) {
606 rc = PTR_ERR(crypt_stat->tfm);
607 crypt_stat->tfm = NULL;
608 ecryptfs_printk(KERN_ERR, "cryptfs: init_crypt_ctx(): "
609 "Error initializing cipher [%s]\n",
610 full_alg_name);
611 goto out_free;
612 }
613 crypto_skcipher_set_flags(crypt_stat->tfm, CRYPTO_TFM_REQ_WEAK_KEY);
614 rc = 0;
615out_free:
616 kfree(full_alg_name);
617out_unlock:
618 mutex_unlock(&crypt_stat->cs_tfm_mutex);
619 return rc;
620}
621
622static void set_extent_mask_and_shift(struct ecryptfs_crypt_stat *crypt_stat)
623{
624 int extent_size_tmp;
625
626 crypt_stat->extent_mask = 0xFFFFFFFF;
627 crypt_stat->extent_shift = 0;
628 if (crypt_stat->extent_size == 0)
629 return;
630 extent_size_tmp = crypt_stat->extent_size;
631 while ((extent_size_tmp & 0x01) == 0) {
632 extent_size_tmp >>= 1;
633 crypt_stat->extent_mask <<= 1;
634 crypt_stat->extent_shift++;
635 }
636}
637
638void ecryptfs_set_default_sizes(struct ecryptfs_crypt_stat *crypt_stat)
639{
640 /* Default values; may be overwritten as we are parsing the
641 * packets. */
642 crypt_stat->extent_size = ECRYPTFS_DEFAULT_EXTENT_SIZE;
643 set_extent_mask_and_shift(crypt_stat);
644 crypt_stat->iv_bytes = ECRYPTFS_DEFAULT_IV_BYTES;
645 if (crypt_stat->flags & ECRYPTFS_METADATA_IN_XATTR)
646 crypt_stat->metadata_size = ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE;
647 else {
648 if (PAGE_SIZE <= ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE)
649 crypt_stat->metadata_size =
650 ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE;
651 else
652 crypt_stat->metadata_size = PAGE_SIZE;
653 }
654}
655
656/**
657 * ecryptfs_compute_root_iv
658 * @crypt_stats
659 *
660 * On error, sets the root IV to all 0's.
661 */
662int ecryptfs_compute_root_iv(struct ecryptfs_crypt_stat *crypt_stat)
663{
664 int rc = 0;
665 char dst[MD5_DIGEST_SIZE];
666
667 BUG_ON(crypt_stat->iv_bytes > MD5_DIGEST_SIZE);
668 BUG_ON(crypt_stat->iv_bytes <= 0);
669 if (!(crypt_stat->flags & ECRYPTFS_KEY_VALID)) {
670 rc = -EINVAL;
671 ecryptfs_printk(KERN_WARNING, "Session key not valid; "
672 "cannot generate root IV\n");
673 goto out;
674 }
675 rc = ecryptfs_calculate_md5(dst, crypt_stat, crypt_stat->key,
676 crypt_stat->key_size);
677 if (rc) {
678 ecryptfs_printk(KERN_WARNING, "Error attempting to compute "
679 "MD5 while generating root IV\n");
680 goto out;
681 }
682 memcpy(crypt_stat->root_iv, dst, crypt_stat->iv_bytes);
683out:
684 if (rc) {
685 memset(crypt_stat->root_iv, 0, crypt_stat->iv_bytes);
686 crypt_stat->flags |= ECRYPTFS_SECURITY_WARNING;
687 }
688 return rc;
689}
690
691static void ecryptfs_generate_new_key(struct ecryptfs_crypt_stat *crypt_stat)
692{
693 get_random_bytes(crypt_stat->key, crypt_stat->key_size);
694 crypt_stat->flags |= ECRYPTFS_KEY_VALID;
695 ecryptfs_compute_root_iv(crypt_stat);
696 if (unlikely(ecryptfs_verbosity > 0)) {
697 ecryptfs_printk(KERN_DEBUG, "Generated new session key:\n");
698 ecryptfs_dump_hex(crypt_stat->key,
699 crypt_stat->key_size);
700 }
701}
702
703/**
704 * ecryptfs_copy_mount_wide_flags_to_inode_flags
705 * @crypt_stat: The inode's cryptographic context
706 * @mount_crypt_stat: The mount point's cryptographic context
707 *
708 * This function propagates the mount-wide flags to individual inode
709 * flags.
710 */
711static void ecryptfs_copy_mount_wide_flags_to_inode_flags(
712 struct ecryptfs_crypt_stat *crypt_stat,
713 struct ecryptfs_mount_crypt_stat *mount_crypt_stat)
714{
715 if (mount_crypt_stat->flags & ECRYPTFS_XATTR_METADATA_ENABLED)
716 crypt_stat->flags |= ECRYPTFS_METADATA_IN_XATTR;
717 if (mount_crypt_stat->flags & ECRYPTFS_ENCRYPTED_VIEW_ENABLED)
718 crypt_stat->flags |= ECRYPTFS_VIEW_AS_ENCRYPTED;
719 if (mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES) {
720 crypt_stat->flags |= ECRYPTFS_ENCRYPT_FILENAMES;
721 if (mount_crypt_stat->flags
722 & ECRYPTFS_GLOBAL_ENCFN_USE_MOUNT_FNEK)
723 crypt_stat->flags |= ECRYPTFS_ENCFN_USE_MOUNT_FNEK;
724 else if (mount_crypt_stat->flags
725 & ECRYPTFS_GLOBAL_ENCFN_USE_FEK)
726 crypt_stat->flags |= ECRYPTFS_ENCFN_USE_FEK;
727 }
728}
729
730static int ecryptfs_copy_mount_wide_sigs_to_inode_sigs(
731 struct ecryptfs_crypt_stat *crypt_stat,
732 struct ecryptfs_mount_crypt_stat *mount_crypt_stat)
733{
734 struct ecryptfs_global_auth_tok *global_auth_tok;
735 int rc = 0;
736
737 mutex_lock(&crypt_stat->keysig_list_mutex);
738 mutex_lock(&mount_crypt_stat->global_auth_tok_list_mutex);
739
740 list_for_each_entry(global_auth_tok,
741 &mount_crypt_stat->global_auth_tok_list,
742 mount_crypt_stat_list) {
743 if (global_auth_tok->flags & ECRYPTFS_AUTH_TOK_FNEK)
744 continue;
745 rc = ecryptfs_add_keysig(crypt_stat, global_auth_tok->sig);
746 if (rc) {
747 printk(KERN_ERR "Error adding keysig; rc = [%d]\n", rc);
748 goto out;
749 }
750 }
751
752out:
753 mutex_unlock(&mount_crypt_stat->global_auth_tok_list_mutex);
754 mutex_unlock(&crypt_stat->keysig_list_mutex);
755 return rc;
756}
757
758/**
759 * ecryptfs_set_default_crypt_stat_vals
760 * @crypt_stat: The inode's cryptographic context
761 * @mount_crypt_stat: The mount point's cryptographic context
762 *
763 * Default values in the event that policy does not override them.
764 */
765static void ecryptfs_set_default_crypt_stat_vals(
766 struct ecryptfs_crypt_stat *crypt_stat,
767 struct ecryptfs_mount_crypt_stat *mount_crypt_stat)
768{
769 ecryptfs_copy_mount_wide_flags_to_inode_flags(crypt_stat,
770 mount_crypt_stat);
771 ecryptfs_set_default_sizes(crypt_stat);
772 strcpy(crypt_stat->cipher, ECRYPTFS_DEFAULT_CIPHER);
773 crypt_stat->key_size = ECRYPTFS_DEFAULT_KEY_BYTES;
774 crypt_stat->flags &= ~(ECRYPTFS_KEY_VALID);
775 crypt_stat->file_version = ECRYPTFS_FILE_VERSION;
776 crypt_stat->mount_crypt_stat = mount_crypt_stat;
777}
778
779/**
780 * ecryptfs_new_file_context
781 * @ecryptfs_inode: The eCryptfs inode
782 *
783 * If the crypto context for the file has not yet been established,
784 * this is where we do that. Establishing a new crypto context
785 * involves the following decisions:
786 * - What cipher to use?
787 * - What set of authentication tokens to use?
788 * Here we just worry about getting enough information into the
789 * authentication tokens so that we know that they are available.
790 * We associate the available authentication tokens with the new file
791 * via the set of signatures in the crypt_stat struct. Later, when
792 * the headers are actually written out, we may again defer to
793 * userspace to perform the encryption of the session key; for the
794 * foreseeable future, this will be the case with public key packets.
795 *
796 * Returns zero on success; non-zero otherwise
797 */
798int ecryptfs_new_file_context(struct inode *ecryptfs_inode)
799{
800 struct ecryptfs_crypt_stat *crypt_stat =
801 &ecryptfs_inode_to_private(ecryptfs_inode)->crypt_stat;
802 struct ecryptfs_mount_crypt_stat *mount_crypt_stat =
803 &ecryptfs_superblock_to_private(
804 ecryptfs_inode->i_sb)->mount_crypt_stat;
805 int cipher_name_len;
806 int rc = 0;
807
808 ecryptfs_set_default_crypt_stat_vals(crypt_stat, mount_crypt_stat);
809 crypt_stat->flags |= (ECRYPTFS_ENCRYPTED | ECRYPTFS_KEY_VALID);
810 ecryptfs_copy_mount_wide_flags_to_inode_flags(crypt_stat,
811 mount_crypt_stat);
812 rc = ecryptfs_copy_mount_wide_sigs_to_inode_sigs(crypt_stat,
813 mount_crypt_stat);
814 if (rc) {
815 printk(KERN_ERR "Error attempting to copy mount-wide key sigs "
816 "to the inode key sigs; rc = [%d]\n", rc);
817 goto out;
818 }
819 cipher_name_len =
820 strlen(mount_crypt_stat->global_default_cipher_name);
821 memcpy(crypt_stat->cipher,
822 mount_crypt_stat->global_default_cipher_name,
823 cipher_name_len);
824 crypt_stat->cipher[cipher_name_len] = '\0';
825 crypt_stat->key_size =
826 mount_crypt_stat->global_default_cipher_key_size;
827 ecryptfs_generate_new_key(crypt_stat);
828 rc = ecryptfs_init_crypt_ctx(crypt_stat);
829 if (rc)
830 ecryptfs_printk(KERN_ERR, "Error initializing cryptographic "
831 "context for cipher [%s]: rc = [%d]\n",
832 crypt_stat->cipher, rc);
833out:
834 return rc;
835}
836
837/**
838 * ecryptfs_validate_marker - check for the ecryptfs marker
839 * @data: The data block in which to check
840 *
841 * Returns zero if marker found; -EINVAL if not found
842 */
843static int ecryptfs_validate_marker(char *data)
844{
845 u32 m_1, m_2;
846
847 m_1 = get_unaligned_be32(data);
848 m_2 = get_unaligned_be32(data + 4);
849 if ((m_1 ^ MAGIC_ECRYPTFS_MARKER) == m_2)
850 return 0;
851 ecryptfs_printk(KERN_DEBUG, "m_1 = [0x%.8x]; m_2 = [0x%.8x]; "
852 "MAGIC_ECRYPTFS_MARKER = [0x%.8x]\n", m_1, m_2,
853 MAGIC_ECRYPTFS_MARKER);
854 ecryptfs_printk(KERN_DEBUG, "(m_1 ^ MAGIC_ECRYPTFS_MARKER) = "
855 "[0x%.8x]\n", (m_1 ^ MAGIC_ECRYPTFS_MARKER));
856 return -EINVAL;
857}
858
859struct ecryptfs_flag_map_elem {
860 u32 file_flag;
861 u32 local_flag;
862};
863
864/* Add support for additional flags by adding elements here. */
865static struct ecryptfs_flag_map_elem ecryptfs_flag_map[] = {
866 {0x00000001, ECRYPTFS_ENABLE_HMAC},
867 {0x00000002, ECRYPTFS_ENCRYPTED},
868 {0x00000004, ECRYPTFS_METADATA_IN_XATTR},
869 {0x00000008, ECRYPTFS_ENCRYPT_FILENAMES}
870};
871
872/**
873 * ecryptfs_process_flags
874 * @crypt_stat: The cryptographic context
875 * @page_virt: Source data to be parsed
876 * @bytes_read: Updated with the number of bytes read
877 *
878 * Returns zero on success; non-zero if the flag set is invalid
879 */
880static int ecryptfs_process_flags(struct ecryptfs_crypt_stat *crypt_stat,
881 char *page_virt, int *bytes_read)
882{
883 int rc = 0;
884 int i;
885 u32 flags;
886
887 flags = get_unaligned_be32(page_virt);
888 for (i = 0; i < ARRAY_SIZE(ecryptfs_flag_map); i++)
889 if (flags & ecryptfs_flag_map[i].file_flag) {
890 crypt_stat->flags |= ecryptfs_flag_map[i].local_flag;
891 } else
892 crypt_stat->flags &= ~(ecryptfs_flag_map[i].local_flag);
893 /* Version is in top 8 bits of the 32-bit flag vector */
894 crypt_stat->file_version = ((flags >> 24) & 0xFF);
895 (*bytes_read) = 4;
896 return rc;
897}
898
899/**
900 * write_ecryptfs_marker
901 * @page_virt: The pointer to in a page to begin writing the marker
902 * @written: Number of bytes written
903 *
904 * Marker = 0x3c81b7f5
905 */
906static void write_ecryptfs_marker(char *page_virt, size_t *written)
907{
908 u32 m_1, m_2;
909
910 get_random_bytes(&m_1, (MAGIC_ECRYPTFS_MARKER_SIZE_BYTES / 2));
911 m_2 = (m_1 ^ MAGIC_ECRYPTFS_MARKER);
912 put_unaligned_be32(m_1, page_virt);
913 page_virt += (MAGIC_ECRYPTFS_MARKER_SIZE_BYTES / 2);
914 put_unaligned_be32(m_2, page_virt);
915 (*written) = MAGIC_ECRYPTFS_MARKER_SIZE_BYTES;
916}
917
918void ecryptfs_write_crypt_stat_flags(char *page_virt,
919 struct ecryptfs_crypt_stat *crypt_stat,
920 size_t *written)
921{
922 u32 flags = 0;
923 int i;
924
925 for (i = 0; i < ARRAY_SIZE(ecryptfs_flag_map); i++)
926 if (crypt_stat->flags & ecryptfs_flag_map[i].local_flag)
927 flags |= ecryptfs_flag_map[i].file_flag;
928 /* Version is in top 8 bits of the 32-bit flag vector */
929 flags |= ((((u8)crypt_stat->file_version) << 24) & 0xFF000000);
930 put_unaligned_be32(flags, page_virt);
931 (*written) = 4;
932}
933
934struct ecryptfs_cipher_code_str_map_elem {
935 char cipher_str[16];
936 u8 cipher_code;
937};
938
939/* Add support for additional ciphers by adding elements here. The
940 * cipher_code is whatever OpenPGP applications use to identify the
941 * ciphers. List in order of probability. */
942static struct ecryptfs_cipher_code_str_map_elem
943ecryptfs_cipher_code_str_map[] = {
944 {"aes",RFC2440_CIPHER_AES_128 },
945 {"blowfish", RFC2440_CIPHER_BLOWFISH},
946 {"des3_ede", RFC2440_CIPHER_DES3_EDE},
947 {"cast5", RFC2440_CIPHER_CAST_5},
948 {"twofish", RFC2440_CIPHER_TWOFISH},
949 {"cast6", RFC2440_CIPHER_CAST_6},
950 {"aes", RFC2440_CIPHER_AES_192},
951 {"aes", RFC2440_CIPHER_AES_256}
952};
953
954/**
955 * ecryptfs_code_for_cipher_string
956 * @cipher_name: The string alias for the cipher
957 * @key_bytes: Length of key in bytes; used for AES code selection
958 *
959 * Returns zero on no match, or the cipher code on match
960 */
961u8 ecryptfs_code_for_cipher_string(char *cipher_name, size_t key_bytes)
962{
963 int i;
964 u8 code = 0;
965 struct ecryptfs_cipher_code_str_map_elem *map =
966 ecryptfs_cipher_code_str_map;
967
968 if (strcmp(cipher_name, "aes") == 0) {
969 switch (key_bytes) {
970 case 16:
971 code = RFC2440_CIPHER_AES_128;
972 break;
973 case 24:
974 code = RFC2440_CIPHER_AES_192;
975 break;
976 case 32:
977 code = RFC2440_CIPHER_AES_256;
978 }
979 } else {
980 for (i = 0; i < ARRAY_SIZE(ecryptfs_cipher_code_str_map); i++)
981 if (strcmp(cipher_name, map[i].cipher_str) == 0) {
982 code = map[i].cipher_code;
983 break;
984 }
985 }
986 return code;
987}
988
989/**
990 * ecryptfs_cipher_code_to_string
991 * @str: Destination to write out the cipher name
992 * @cipher_code: The code to convert to cipher name string
993 *
994 * Returns zero on success
995 */
996int ecryptfs_cipher_code_to_string(char *str, u8 cipher_code)
997{
998 int rc = 0;
999 int i;
1000
1001 str[0] = '\0';
1002 for (i = 0; i < ARRAY_SIZE(ecryptfs_cipher_code_str_map); i++)
1003 if (cipher_code == ecryptfs_cipher_code_str_map[i].cipher_code)
1004 strcpy(str, ecryptfs_cipher_code_str_map[i].cipher_str);
1005 if (str[0] == '\0') {
1006 ecryptfs_printk(KERN_WARNING, "Cipher code not recognized: "
1007 "[%d]\n", cipher_code);
1008 rc = -EINVAL;
1009 }
1010 return rc;
1011}
1012
1013int ecryptfs_read_and_validate_header_region(struct inode *inode)
1014{
1015 u8 file_size[ECRYPTFS_SIZE_AND_MARKER_BYTES];
1016 u8 *marker = file_size + ECRYPTFS_FILE_SIZE_BYTES;
1017 int rc;
1018
1019 rc = ecryptfs_read_lower(file_size, 0, ECRYPTFS_SIZE_AND_MARKER_BYTES,
1020 inode);
1021 if (rc < ECRYPTFS_SIZE_AND_MARKER_BYTES)
1022 return rc >= 0 ? -EINVAL : rc;
1023 rc = ecryptfs_validate_marker(marker);
1024 if (!rc)
1025 ecryptfs_i_size_init(file_size, inode);
1026 return rc;
1027}
1028
1029void
1030ecryptfs_write_header_metadata(char *virt,
1031 struct ecryptfs_crypt_stat *crypt_stat,
1032 size_t *written)
1033{
1034 u32 header_extent_size;
1035 u16 num_header_extents_at_front;
1036
1037 header_extent_size = (u32)crypt_stat->extent_size;
1038 num_header_extents_at_front =
1039 (u16)(crypt_stat->metadata_size / crypt_stat->extent_size);
1040 put_unaligned_be32(header_extent_size, virt);
1041 virt += 4;
1042 put_unaligned_be16(num_header_extents_at_front, virt);
1043 (*written) = 6;
1044}
1045
1046struct kmem_cache *ecryptfs_header_cache;
1047
1048/**
1049 * ecryptfs_write_headers_virt
1050 * @page_virt: The virtual address to write the headers to
1051 * @max: The size of memory allocated at page_virt
1052 * @size: Set to the number of bytes written by this function
1053 * @crypt_stat: The cryptographic context
1054 * @ecryptfs_dentry: The eCryptfs dentry
1055 *
1056 * Format version: 1
1057 *
1058 * Header Extent:
1059 * Octets 0-7: Unencrypted file size (big-endian)
1060 * Octets 8-15: eCryptfs special marker
1061 * Octets 16-19: Flags
1062 * Octet 16: File format version number (between 0 and 255)
1063 * Octets 17-18: Reserved
1064 * Octet 19: Bit 1 (lsb): Reserved
1065 * Bit 2: Encrypted?
1066 * Bits 3-8: Reserved
1067 * Octets 20-23: Header extent size (big-endian)
1068 * Octets 24-25: Number of header extents at front of file
1069 * (big-endian)
1070 * Octet 26: Begin RFC 2440 authentication token packet set
1071 * Data Extent 0:
1072 * Lower data (CBC encrypted)
1073 * Data Extent 1:
1074 * Lower data (CBC encrypted)
1075 * ...
1076 *
1077 * Returns zero on success
1078 */
1079static int ecryptfs_write_headers_virt(char *page_virt, size_t max,
1080 size_t *size,
1081 struct ecryptfs_crypt_stat *crypt_stat,
1082 struct dentry *ecryptfs_dentry)
1083{
1084 int rc;
1085 size_t written;
1086 size_t offset;
1087
1088 offset = ECRYPTFS_FILE_SIZE_BYTES;
1089 write_ecryptfs_marker((page_virt + offset), &written);
1090 offset += written;
1091 ecryptfs_write_crypt_stat_flags((page_virt + offset), crypt_stat,
1092 &written);
1093 offset += written;
1094 ecryptfs_write_header_metadata((page_virt + offset), crypt_stat,
1095 &written);
1096 offset += written;
1097 rc = ecryptfs_generate_key_packet_set((page_virt + offset), crypt_stat,
1098 ecryptfs_dentry, &written,
1099 max - offset);
1100 if (rc)
1101 ecryptfs_printk(KERN_WARNING, "Error generating key packet "
1102 "set; rc = [%d]\n", rc);
1103 if (size) {
1104 offset += written;
1105 *size = offset;
1106 }
1107 return rc;
1108}
1109
1110static int
1111ecryptfs_write_metadata_to_contents(struct inode *ecryptfs_inode,
1112 char *virt, size_t virt_len)
1113{
1114 int rc;
1115
1116 rc = ecryptfs_write_lower(ecryptfs_inode, virt,
1117 0, virt_len);
1118 if (rc < 0)
1119 printk(KERN_ERR "%s: Error attempting to write header "
1120 "information to lower file; rc = [%d]\n", __func__, rc);
1121 else
1122 rc = 0;
1123 return rc;
1124}
1125
1126static int
1127ecryptfs_write_metadata_to_xattr(struct dentry *ecryptfs_dentry,
1128 struct inode *ecryptfs_inode,
1129 char *page_virt, size_t size)
1130{
1131 int rc;
1132
1133 rc = ecryptfs_setxattr(ecryptfs_dentry, ecryptfs_inode,
1134 ECRYPTFS_XATTR_NAME, page_virt, size, 0);
1135 return rc;
1136}
1137
1138static unsigned long ecryptfs_get_zeroed_pages(gfp_t gfp_mask,
1139 unsigned int order)
1140{
1141 struct page *page;
1142
1143 page = alloc_pages(gfp_mask | __GFP_ZERO, order);
1144 if (page)
1145 return (unsigned long) page_address(page);
1146 return 0;
1147}
1148
1149/**
1150 * ecryptfs_write_metadata
1151 * @ecryptfs_dentry: The eCryptfs dentry, which should be negative
1152 * @ecryptfs_inode: The newly created eCryptfs inode
1153 *
1154 * Write the file headers out. This will likely involve a userspace
1155 * callout, in which the session key is encrypted with one or more
1156 * public keys and/or the passphrase necessary to do the encryption is
1157 * retrieved via a prompt. Exactly what happens at this point should
1158 * be policy-dependent.
1159 *
1160 * Returns zero on success; non-zero on error
1161 */
1162int ecryptfs_write_metadata(struct dentry *ecryptfs_dentry,
1163 struct inode *ecryptfs_inode)
1164{
1165 struct ecryptfs_crypt_stat *crypt_stat =
1166 &ecryptfs_inode_to_private(ecryptfs_inode)->crypt_stat;
1167 unsigned int order;
1168 char *virt;
1169 size_t virt_len;
1170 size_t size = 0;
1171 int rc = 0;
1172
1173 if (likely(crypt_stat->flags & ECRYPTFS_ENCRYPTED)) {
1174 if (!(crypt_stat->flags & ECRYPTFS_KEY_VALID)) {
1175 printk(KERN_ERR "Key is invalid; bailing out\n");
1176 rc = -EINVAL;
1177 goto out;
1178 }
1179 } else {
1180 printk(KERN_WARNING "%s: Encrypted flag not set\n",
1181 __func__);
1182 rc = -EINVAL;
1183 goto out;
1184 }
1185 virt_len = crypt_stat->metadata_size;
1186 order = get_order(virt_len);
1187 /* Released in this function */
1188 virt = (char *)ecryptfs_get_zeroed_pages(GFP_KERNEL, order);
1189 if (!virt) {
1190 printk(KERN_ERR "%s: Out of memory\n", __func__);
1191 rc = -ENOMEM;
1192 goto out;
1193 }
1194 /* Zeroed page ensures the in-header unencrypted i_size is set to 0 */
1195 rc = ecryptfs_write_headers_virt(virt, virt_len, &size, crypt_stat,
1196 ecryptfs_dentry);
1197 if (unlikely(rc)) {
1198 printk(KERN_ERR "%s: Error whilst writing headers; rc = [%d]\n",
1199 __func__, rc);
1200 goto out_free;
1201 }
1202 if (crypt_stat->flags & ECRYPTFS_METADATA_IN_XATTR)
1203 rc = ecryptfs_write_metadata_to_xattr(ecryptfs_dentry, ecryptfs_inode,
1204 virt, size);
1205 else
1206 rc = ecryptfs_write_metadata_to_contents(ecryptfs_inode, virt,
1207 virt_len);
1208 if (rc) {
1209 printk(KERN_ERR "%s: Error writing metadata out to lower file; "
1210 "rc = [%d]\n", __func__, rc);
1211 goto out_free;
1212 }
1213out_free:
1214 free_pages((unsigned long)virt, order);
1215out:
1216 return rc;
1217}
1218
1219#define ECRYPTFS_DONT_VALIDATE_HEADER_SIZE 0
1220#define ECRYPTFS_VALIDATE_HEADER_SIZE 1
1221static int parse_header_metadata(struct ecryptfs_crypt_stat *crypt_stat,
1222 char *virt, int *bytes_read,
1223 int validate_header_size)
1224{
1225 int rc = 0;
1226 u32 header_extent_size;
1227 u16 num_header_extents_at_front;
1228
1229 header_extent_size = get_unaligned_be32(virt);
1230 virt += sizeof(__be32);
1231 num_header_extents_at_front = get_unaligned_be16(virt);
1232 crypt_stat->metadata_size = (((size_t)num_header_extents_at_front
1233 * (size_t)header_extent_size));
1234 (*bytes_read) = (sizeof(__be32) + sizeof(__be16));
1235 if ((validate_header_size == ECRYPTFS_VALIDATE_HEADER_SIZE)
1236 && (crypt_stat->metadata_size
1237 < ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE)) {
1238 rc = -EINVAL;
1239 printk(KERN_WARNING "Invalid header size: [%zd]\n",
1240 crypt_stat->metadata_size);
1241 }
1242 return rc;
1243}
1244
1245/**
1246 * set_default_header_data
1247 * @crypt_stat: The cryptographic context
1248 *
1249 * For version 0 file format; this function is only for backwards
1250 * compatibility for files created with the prior versions of
1251 * eCryptfs.
1252 */
1253static void set_default_header_data(struct ecryptfs_crypt_stat *crypt_stat)
1254{
1255 crypt_stat->metadata_size = ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE;
1256}
1257
1258void ecryptfs_i_size_init(const char *page_virt, struct inode *inode)
1259{
1260 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
1261 struct ecryptfs_crypt_stat *crypt_stat;
1262 u64 file_size;
1263
1264 crypt_stat = &ecryptfs_inode_to_private(inode)->crypt_stat;
1265 mount_crypt_stat =
1266 &ecryptfs_superblock_to_private(inode->i_sb)->mount_crypt_stat;
1267 if (mount_crypt_stat->flags & ECRYPTFS_ENCRYPTED_VIEW_ENABLED) {
1268 file_size = i_size_read(ecryptfs_inode_to_lower(inode));
1269 if (crypt_stat->flags & ECRYPTFS_METADATA_IN_XATTR)
1270 file_size += crypt_stat->metadata_size;
1271 } else
1272 file_size = get_unaligned_be64(page_virt);
1273 i_size_write(inode, (loff_t)file_size);
1274 crypt_stat->flags |= ECRYPTFS_I_SIZE_INITIALIZED;
1275}
1276
1277/**
1278 * ecryptfs_read_headers_virt
1279 * @page_virt: The virtual address into which to read the headers
1280 * @crypt_stat: The cryptographic context
1281 * @ecryptfs_dentry: The eCryptfs dentry
1282 * @validate_header_size: Whether to validate the header size while reading
1283 *
1284 * Read/parse the header data. The header format is detailed in the
1285 * comment block for the ecryptfs_write_headers_virt() function.
1286 *
1287 * Returns zero on success
1288 */
1289static int ecryptfs_read_headers_virt(char *page_virt,
1290 struct ecryptfs_crypt_stat *crypt_stat,
1291 struct dentry *ecryptfs_dentry,
1292 int validate_header_size)
1293{
1294 int rc = 0;
1295 int offset;
1296 int bytes_read;
1297
1298 ecryptfs_set_default_sizes(crypt_stat);
1299 crypt_stat->mount_crypt_stat = &ecryptfs_superblock_to_private(
1300 ecryptfs_dentry->d_sb)->mount_crypt_stat;
1301 offset = ECRYPTFS_FILE_SIZE_BYTES;
1302 rc = ecryptfs_validate_marker(page_virt + offset);
1303 if (rc)
1304 goto out;
1305 if (!(crypt_stat->flags & ECRYPTFS_I_SIZE_INITIALIZED))
1306 ecryptfs_i_size_init(page_virt, d_inode(ecryptfs_dentry));
1307 offset += MAGIC_ECRYPTFS_MARKER_SIZE_BYTES;
1308 rc = ecryptfs_process_flags(crypt_stat, (page_virt + offset),
1309 &bytes_read);
1310 if (rc) {
1311 ecryptfs_printk(KERN_WARNING, "Error processing flags\n");
1312 goto out;
1313 }
1314 if (crypt_stat->file_version > ECRYPTFS_SUPPORTED_FILE_VERSION) {
1315 ecryptfs_printk(KERN_WARNING, "File version is [%d]; only "
1316 "file version [%d] is supported by this "
1317 "version of eCryptfs\n",
1318 crypt_stat->file_version,
1319 ECRYPTFS_SUPPORTED_FILE_VERSION);
1320 rc = -EINVAL;
1321 goto out;
1322 }
1323 offset += bytes_read;
1324 if (crypt_stat->file_version >= 1) {
1325 rc = parse_header_metadata(crypt_stat, (page_virt + offset),
1326 &bytes_read, validate_header_size);
1327 if (rc) {
1328 ecryptfs_printk(KERN_WARNING, "Error reading header "
1329 "metadata; rc = [%d]\n", rc);
1330 }
1331 offset += bytes_read;
1332 } else
1333 set_default_header_data(crypt_stat);
1334 rc = ecryptfs_parse_packet_set(crypt_stat, (page_virt + offset),
1335 ecryptfs_dentry);
1336out:
1337 return rc;
1338}
1339
1340/**
1341 * ecryptfs_read_xattr_region
1342 * @page_virt: The vitual address into which to read the xattr data
1343 * @ecryptfs_inode: The eCryptfs inode
1344 *
1345 * Attempts to read the crypto metadata from the extended attribute
1346 * region of the lower file.
1347 *
1348 * Returns zero on success; non-zero on error
1349 */
1350int ecryptfs_read_xattr_region(char *page_virt, struct inode *ecryptfs_inode)
1351{
1352 struct dentry *lower_dentry =
1353 ecryptfs_inode_to_private(ecryptfs_inode)->lower_file->f_path.dentry;
1354 ssize_t size;
1355 int rc = 0;
1356
1357 size = ecryptfs_getxattr_lower(lower_dentry,
1358 ecryptfs_inode_to_lower(ecryptfs_inode),
1359 ECRYPTFS_XATTR_NAME,
1360 page_virt, ECRYPTFS_DEFAULT_EXTENT_SIZE);
1361 if (size < 0) {
1362 if (unlikely(ecryptfs_verbosity > 0))
1363 printk(KERN_INFO "Error attempting to read the [%s] "
1364 "xattr from the lower file; return value = "
1365 "[%zd]\n", ECRYPTFS_XATTR_NAME, size);
1366 rc = -EINVAL;
1367 goto out;
1368 }
1369out:
1370 return rc;
1371}
1372
1373int ecryptfs_read_and_validate_xattr_region(struct dentry *dentry,
1374 struct inode *inode)
1375{
1376 u8 file_size[ECRYPTFS_SIZE_AND_MARKER_BYTES];
1377 u8 *marker = file_size + ECRYPTFS_FILE_SIZE_BYTES;
1378 int rc;
1379
1380 rc = ecryptfs_getxattr_lower(ecryptfs_dentry_to_lower(dentry),
1381 ecryptfs_inode_to_lower(inode),
1382 ECRYPTFS_XATTR_NAME, file_size,
1383 ECRYPTFS_SIZE_AND_MARKER_BYTES);
1384 if (rc < ECRYPTFS_SIZE_AND_MARKER_BYTES)
1385 return rc >= 0 ? -EINVAL : rc;
1386 rc = ecryptfs_validate_marker(marker);
1387 if (!rc)
1388 ecryptfs_i_size_init(file_size, inode);
1389 return rc;
1390}
1391
1392/**
1393 * ecryptfs_read_metadata
1394 *
1395 * Common entry point for reading file metadata. From here, we could
1396 * retrieve the header information from the header region of the file,
1397 * the xattr region of the file, or some other repository that is
1398 * stored separately from the file itself. The current implementation
1399 * supports retrieving the metadata information from the file contents
1400 * and from the xattr region.
1401 *
1402 * Returns zero if valid headers found and parsed; non-zero otherwise
1403 */
1404int ecryptfs_read_metadata(struct dentry *ecryptfs_dentry)
1405{
1406 int rc;
1407 char *page_virt;
1408 struct inode *ecryptfs_inode = d_inode(ecryptfs_dentry);
1409 struct ecryptfs_crypt_stat *crypt_stat =
1410 &ecryptfs_inode_to_private(ecryptfs_inode)->crypt_stat;
1411 struct ecryptfs_mount_crypt_stat *mount_crypt_stat =
1412 &ecryptfs_superblock_to_private(
1413 ecryptfs_dentry->d_sb)->mount_crypt_stat;
1414
1415 ecryptfs_copy_mount_wide_flags_to_inode_flags(crypt_stat,
1416 mount_crypt_stat);
1417 /* Read the first page from the underlying file */
1418 page_virt = kmem_cache_alloc(ecryptfs_header_cache, GFP_USER);
1419 if (!page_virt) {
1420 rc = -ENOMEM;
1421 goto out;
1422 }
1423 rc = ecryptfs_read_lower(page_virt, 0, crypt_stat->extent_size,
1424 ecryptfs_inode);
1425 if (rc >= 0)
1426 rc = ecryptfs_read_headers_virt(page_virt, crypt_stat,
1427 ecryptfs_dentry,
1428 ECRYPTFS_VALIDATE_HEADER_SIZE);
1429 if (rc) {
1430 /* metadata is not in the file header, so try xattrs */
1431 memset(page_virt, 0, PAGE_SIZE);
1432 rc = ecryptfs_read_xattr_region(page_virt, ecryptfs_inode);
1433 if (rc) {
1434 printk(KERN_DEBUG "Valid eCryptfs headers not found in "
1435 "file header region or xattr region, inode %lu\n",
1436 ecryptfs_inode->i_ino);
1437 rc = -EINVAL;
1438 goto out;
1439 }
1440 rc = ecryptfs_read_headers_virt(page_virt, crypt_stat,
1441 ecryptfs_dentry,
1442 ECRYPTFS_DONT_VALIDATE_HEADER_SIZE);
1443 if (rc) {
1444 printk(KERN_DEBUG "Valid eCryptfs headers not found in "
1445 "file xattr region either, inode %lu\n",
1446 ecryptfs_inode->i_ino);
1447 rc = -EINVAL;
1448 }
1449 if (crypt_stat->mount_crypt_stat->flags
1450 & ECRYPTFS_XATTR_METADATA_ENABLED) {
1451 crypt_stat->flags |= ECRYPTFS_METADATA_IN_XATTR;
1452 } else {
1453 printk(KERN_WARNING "Attempt to access file with "
1454 "crypto metadata only in the extended attribute "
1455 "region, but eCryptfs was mounted without "
1456 "xattr support enabled. eCryptfs will not treat "
1457 "this like an encrypted file, inode %lu\n",
1458 ecryptfs_inode->i_ino);
1459 rc = -EINVAL;
1460 }
1461 }
1462out:
1463 if (page_virt) {
1464 memset(page_virt, 0, PAGE_SIZE);
1465 kmem_cache_free(ecryptfs_header_cache, page_virt);
1466 }
1467 return rc;
1468}
1469
1470/**
1471 * ecryptfs_encrypt_filename - encrypt filename
1472 *
1473 * CBC-encrypts the filename. We do not want to encrypt the same
1474 * filename with the same key and IV, which may happen with hard
1475 * links, so we prepend random bits to each filename.
1476 *
1477 * Returns zero on success; non-zero otherwise
1478 */
1479static int
1480ecryptfs_encrypt_filename(struct ecryptfs_filename *filename,
1481 struct ecryptfs_mount_crypt_stat *mount_crypt_stat)
1482{
1483 int rc = 0;
1484
1485 filename->encrypted_filename = NULL;
1486 filename->encrypted_filename_size = 0;
1487 if (mount_crypt_stat && (mount_crypt_stat->flags
1488 & ECRYPTFS_GLOBAL_ENCFN_USE_MOUNT_FNEK)) {
1489 size_t packet_size;
1490 size_t remaining_bytes;
1491
1492 rc = ecryptfs_write_tag_70_packet(
1493 NULL, NULL,
1494 &filename->encrypted_filename_size,
1495 mount_crypt_stat, NULL,
1496 filename->filename_size);
1497 if (rc) {
1498 printk(KERN_ERR "%s: Error attempting to get packet "
1499 "size for tag 72; rc = [%d]\n", __func__,
1500 rc);
1501 filename->encrypted_filename_size = 0;
1502 goto out;
1503 }
1504 filename->encrypted_filename =
1505 kmalloc(filename->encrypted_filename_size, GFP_KERNEL);
1506 if (!filename->encrypted_filename) {
1507 rc = -ENOMEM;
1508 goto out;
1509 }
1510 remaining_bytes = filename->encrypted_filename_size;
1511 rc = ecryptfs_write_tag_70_packet(filename->encrypted_filename,
1512 &remaining_bytes,
1513 &packet_size,
1514 mount_crypt_stat,
1515 filename->filename,
1516 filename->filename_size);
1517 if (rc) {
1518 printk(KERN_ERR "%s: Error attempting to generate "
1519 "tag 70 packet; rc = [%d]\n", __func__,
1520 rc);
1521 kfree(filename->encrypted_filename);
1522 filename->encrypted_filename = NULL;
1523 filename->encrypted_filename_size = 0;
1524 goto out;
1525 }
1526 filename->encrypted_filename_size = packet_size;
1527 } else {
1528 printk(KERN_ERR "%s: No support for requested filename "
1529 "encryption method in this release\n", __func__);
1530 rc = -EOPNOTSUPP;
1531 goto out;
1532 }
1533out:
1534 return rc;
1535}
1536
1537static int ecryptfs_copy_filename(char **copied_name, size_t *copied_name_size,
1538 const char *name, size_t name_size)
1539{
1540 int rc = 0;
1541
1542 (*copied_name) = kmalloc((name_size + 1), GFP_KERNEL);
1543 if (!(*copied_name)) {
1544 rc = -ENOMEM;
1545 goto out;
1546 }
1547 memcpy((void *)(*copied_name), (void *)name, name_size);
1548 (*copied_name)[(name_size)] = '\0'; /* Only for convenience
1549 * in printing out the
1550 * string in debug
1551 * messages */
1552 (*copied_name_size) = name_size;
1553out:
1554 return rc;
1555}
1556
1557/**
1558 * ecryptfs_process_key_cipher - Perform key cipher initialization.
1559 * @key_tfm: Crypto context for key material, set by this function
1560 * @cipher_name: Name of the cipher
1561 * @key_size: Size of the key in bytes
1562 *
1563 * Returns zero on success. Any crypto_tfm structs allocated here
1564 * should be released by other functions, such as on a superblock put
1565 * event, regardless of whether this function succeeds for fails.
1566 */
1567static int
1568ecryptfs_process_key_cipher(struct crypto_skcipher **key_tfm,
1569 char *cipher_name, size_t *key_size)
1570{
1571 char dummy_key[ECRYPTFS_MAX_KEY_BYTES];
1572 char *full_alg_name = NULL;
1573 int rc;
1574
1575 *key_tfm = NULL;
1576 if (*key_size > ECRYPTFS_MAX_KEY_BYTES) {
1577 rc = -EINVAL;
1578 printk(KERN_ERR "Requested key size is [%zd] bytes; maximum "
1579 "allowable is [%d]\n", *key_size, ECRYPTFS_MAX_KEY_BYTES);
1580 goto out;
1581 }
1582 rc = ecryptfs_crypto_api_algify_cipher_name(&full_alg_name, cipher_name,
1583 "ecb");
1584 if (rc)
1585 goto out;
1586 *key_tfm = crypto_alloc_skcipher(full_alg_name, 0, CRYPTO_ALG_ASYNC);
1587 if (IS_ERR(*key_tfm)) {
1588 rc = PTR_ERR(*key_tfm);
1589 printk(KERN_ERR "Unable to allocate crypto cipher with name "
1590 "[%s]; rc = [%d]\n", full_alg_name, rc);
1591 goto out;
1592 }
1593 crypto_skcipher_set_flags(*key_tfm, CRYPTO_TFM_REQ_WEAK_KEY);
1594 if (*key_size == 0)
1595 *key_size = crypto_skcipher_default_keysize(*key_tfm);
1596 get_random_bytes(dummy_key, *key_size);
1597 rc = crypto_skcipher_setkey(*key_tfm, dummy_key, *key_size);
1598 if (rc) {
1599 printk(KERN_ERR "Error attempting to set key of size [%zd] for "
1600 "cipher [%s]; rc = [%d]\n", *key_size, full_alg_name,
1601 rc);
1602 rc = -EINVAL;
1603 goto out;
1604 }
1605out:
1606 kfree(full_alg_name);
1607 return rc;
1608}
1609
1610struct kmem_cache *ecryptfs_key_tfm_cache;
1611static struct list_head key_tfm_list;
1612struct mutex key_tfm_list_mutex;
1613
1614int __init ecryptfs_init_crypto(void)
1615{
1616 mutex_init(&key_tfm_list_mutex);
1617 INIT_LIST_HEAD(&key_tfm_list);
1618 return 0;
1619}
1620
1621/**
1622 * ecryptfs_destroy_crypto - free all cached key_tfms on key_tfm_list
1623 *
1624 * Called only at module unload time
1625 */
1626int ecryptfs_destroy_crypto(void)
1627{
1628 struct ecryptfs_key_tfm *key_tfm, *key_tfm_tmp;
1629
1630 mutex_lock(&key_tfm_list_mutex);
1631 list_for_each_entry_safe(key_tfm, key_tfm_tmp, &key_tfm_list,
1632 key_tfm_list) {
1633 list_del(&key_tfm->key_tfm_list);
1634 crypto_free_skcipher(key_tfm->key_tfm);
1635 kmem_cache_free(ecryptfs_key_tfm_cache, key_tfm);
1636 }
1637 mutex_unlock(&key_tfm_list_mutex);
1638 return 0;
1639}
1640
1641int
1642ecryptfs_add_new_key_tfm(struct ecryptfs_key_tfm **key_tfm, char *cipher_name,
1643 size_t key_size)
1644{
1645 struct ecryptfs_key_tfm *tmp_tfm;
1646 int rc = 0;
1647
1648 BUG_ON(!mutex_is_locked(&key_tfm_list_mutex));
1649
1650 tmp_tfm = kmem_cache_alloc(ecryptfs_key_tfm_cache, GFP_KERNEL);
1651 if (key_tfm)
1652 (*key_tfm) = tmp_tfm;
1653 if (!tmp_tfm) {
1654 rc = -ENOMEM;
1655 goto out;
1656 }
1657 mutex_init(&tmp_tfm->key_tfm_mutex);
1658 strncpy(tmp_tfm->cipher_name, cipher_name,
1659 ECRYPTFS_MAX_CIPHER_NAME_SIZE);
1660 tmp_tfm->cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE] = '\0';
1661 tmp_tfm->key_size = key_size;
1662 rc = ecryptfs_process_key_cipher(&tmp_tfm->key_tfm,
1663 tmp_tfm->cipher_name,
1664 &tmp_tfm->key_size);
1665 if (rc) {
1666 printk(KERN_ERR "Error attempting to initialize key TFM "
1667 "cipher with name = [%s]; rc = [%d]\n",
1668 tmp_tfm->cipher_name, rc);
1669 kmem_cache_free(ecryptfs_key_tfm_cache, tmp_tfm);
1670 if (key_tfm)
1671 (*key_tfm) = NULL;
1672 goto out;
1673 }
1674 list_add(&tmp_tfm->key_tfm_list, &key_tfm_list);
1675out:
1676 return rc;
1677}
1678
1679/**
1680 * ecryptfs_tfm_exists - Search for existing tfm for cipher_name.
1681 * @cipher_name: the name of the cipher to search for
1682 * @key_tfm: set to corresponding tfm if found
1683 *
1684 * Searches for cached key_tfm matching @cipher_name
1685 * Must be called with &key_tfm_list_mutex held
1686 * Returns 1 if found, with @key_tfm set
1687 * Returns 0 if not found, with @key_tfm set to NULL
1688 */
1689int ecryptfs_tfm_exists(char *cipher_name, struct ecryptfs_key_tfm **key_tfm)
1690{
1691 struct ecryptfs_key_tfm *tmp_key_tfm;
1692
1693 BUG_ON(!mutex_is_locked(&key_tfm_list_mutex));
1694
1695 list_for_each_entry(tmp_key_tfm, &key_tfm_list, key_tfm_list) {
1696 if (strcmp(tmp_key_tfm->cipher_name, cipher_name) == 0) {
1697 if (key_tfm)
1698 (*key_tfm) = tmp_key_tfm;
1699 return 1;
1700 }
1701 }
1702 if (key_tfm)
1703 (*key_tfm) = NULL;
1704 return 0;
1705}
1706
1707/**
1708 * ecryptfs_get_tfm_and_mutex_for_cipher_name
1709 *
1710 * @tfm: set to cached tfm found, or new tfm created
1711 * @tfm_mutex: set to mutex for cached tfm found, or new tfm created
1712 * @cipher_name: the name of the cipher to search for and/or add
1713 *
1714 * Sets pointers to @tfm & @tfm_mutex matching @cipher_name.
1715 * Searches for cached item first, and creates new if not found.
1716 * Returns 0 on success, non-zero if adding new cipher failed
1717 */
1718int ecryptfs_get_tfm_and_mutex_for_cipher_name(struct crypto_skcipher **tfm,
1719 struct mutex **tfm_mutex,
1720 char *cipher_name)
1721{
1722 struct ecryptfs_key_tfm *key_tfm;
1723 int rc = 0;
1724
1725 (*tfm) = NULL;
1726 (*tfm_mutex) = NULL;
1727
1728 mutex_lock(&key_tfm_list_mutex);
1729 if (!ecryptfs_tfm_exists(cipher_name, &key_tfm)) {
1730 rc = ecryptfs_add_new_key_tfm(&key_tfm, cipher_name, 0);
1731 if (rc) {
1732 printk(KERN_ERR "Error adding new key_tfm to list; "
1733 "rc = [%d]\n", rc);
1734 goto out;
1735 }
1736 }
1737 (*tfm) = key_tfm->key_tfm;
1738 (*tfm_mutex) = &key_tfm->key_tfm_mutex;
1739out:
1740 mutex_unlock(&key_tfm_list_mutex);
1741 return rc;
1742}
1743
1744/* 64 characters forming a 6-bit target field */
1745static unsigned char *portable_filename_chars = ("-.0123456789ABCD"
1746 "EFGHIJKLMNOPQRST"
1747 "UVWXYZabcdefghij"
1748 "klmnopqrstuvwxyz");
1749
1750/* We could either offset on every reverse map or just pad some 0x00's
1751 * at the front here */
1752static const unsigned char filename_rev_map[256] = {
1753 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 7 */
1754 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 15 */
1755 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 23 */
1756 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 31 */
1757 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 39 */
1758 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, /* 47 */
1759 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, /* 55 */
1760 0x0A, 0x0B, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 63 */
1761 0x00, 0x0C, 0x0D, 0x0E, 0x0F, 0x10, 0x11, 0x12, /* 71 */
1762 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1A, /* 79 */
1763 0x1B, 0x1C, 0x1D, 0x1E, 0x1F, 0x20, 0x21, 0x22, /* 87 */
1764 0x23, 0x24, 0x25, 0x00, 0x00, 0x00, 0x00, 0x00, /* 95 */
1765 0x00, 0x26, 0x27, 0x28, 0x29, 0x2A, 0x2B, 0x2C, /* 103 */
1766 0x2D, 0x2E, 0x2F, 0x30, 0x31, 0x32, 0x33, 0x34, /* 111 */
1767 0x35, 0x36, 0x37, 0x38, 0x39, 0x3A, 0x3B, 0x3C, /* 119 */
1768 0x3D, 0x3E, 0x3F /* 123 - 255 initialized to 0x00 */
1769};
1770
1771/**
1772 * ecryptfs_encode_for_filename
1773 * @dst: Destination location for encoded filename
1774 * @dst_size: Size of the encoded filename in bytes
1775 * @src: Source location for the filename to encode
1776 * @src_size: Size of the source in bytes
1777 */
1778static void ecryptfs_encode_for_filename(unsigned char *dst, size_t *dst_size,
1779 unsigned char *src, size_t src_size)
1780{
1781 size_t num_blocks;
1782 size_t block_num = 0;
1783 size_t dst_offset = 0;
1784 unsigned char last_block[3];
1785
1786 if (src_size == 0) {
1787 (*dst_size) = 0;
1788 goto out;
1789 }
1790 num_blocks = (src_size / 3);
1791 if ((src_size % 3) == 0) {
1792 memcpy(last_block, (&src[src_size - 3]), 3);
1793 } else {
1794 num_blocks++;
1795 last_block[2] = 0x00;
1796 switch (src_size % 3) {
1797 case 1:
1798 last_block[0] = src[src_size - 1];
1799 last_block[1] = 0x00;
1800 break;
1801 case 2:
1802 last_block[0] = src[src_size - 2];
1803 last_block[1] = src[src_size - 1];
1804 }
1805 }
1806 (*dst_size) = (num_blocks * 4);
1807 if (!dst)
1808 goto out;
1809 while (block_num < num_blocks) {
1810 unsigned char *src_block;
1811 unsigned char dst_block[4];
1812
1813 if (block_num == (num_blocks - 1))
1814 src_block = last_block;
1815 else
1816 src_block = &src[block_num * 3];
1817 dst_block[0] = ((src_block[0] >> 2) & 0x3F);
1818 dst_block[1] = (((src_block[0] << 4) & 0x30)
1819 | ((src_block[1] >> 4) & 0x0F));
1820 dst_block[2] = (((src_block[1] << 2) & 0x3C)
1821 | ((src_block[2] >> 6) & 0x03));
1822 dst_block[3] = (src_block[2] & 0x3F);
1823 dst[dst_offset++] = portable_filename_chars[dst_block[0]];
1824 dst[dst_offset++] = portable_filename_chars[dst_block[1]];
1825 dst[dst_offset++] = portable_filename_chars[dst_block[2]];
1826 dst[dst_offset++] = portable_filename_chars[dst_block[3]];
1827 block_num++;
1828 }
1829out:
1830 return;
1831}
1832
1833static size_t ecryptfs_max_decoded_size(size_t encoded_size)
1834{
1835 /* Not exact; conservatively long. Every block of 4
1836 * encoded characters decodes into a block of 3
1837 * decoded characters. This segment of code provides
1838 * the caller with the maximum amount of allocated
1839 * space that @dst will need to point to in a
1840 * subsequent call. */
1841 return ((encoded_size + 1) * 3) / 4;
1842}
1843
1844/**
1845 * ecryptfs_decode_from_filename
1846 * @dst: If NULL, this function only sets @dst_size and returns. If
1847 * non-NULL, this function decodes the encoded octets in @src
1848 * into the memory that @dst points to.
1849 * @dst_size: Set to the size of the decoded string.
1850 * @src: The encoded set of octets to decode.
1851 * @src_size: The size of the encoded set of octets to decode.
1852 */
1853static void
1854ecryptfs_decode_from_filename(unsigned char *dst, size_t *dst_size,
1855 const unsigned char *src, size_t src_size)
1856{
1857 u8 current_bit_offset = 0;
1858 size_t src_byte_offset = 0;
1859 size_t dst_byte_offset = 0;
1860
1861 if (!dst) {
1862 (*dst_size) = ecryptfs_max_decoded_size(src_size);
1863 goto out;
1864 }
1865 while (src_byte_offset < src_size) {
1866 unsigned char src_byte =
1867 filename_rev_map[(int)src[src_byte_offset]];
1868
1869 switch (current_bit_offset) {
1870 case 0:
1871 dst[dst_byte_offset] = (src_byte << 2);
1872 current_bit_offset = 6;
1873 break;
1874 case 6:
1875 dst[dst_byte_offset++] |= (src_byte >> 4);
1876 dst[dst_byte_offset] = ((src_byte & 0xF)
1877 << 4);
1878 current_bit_offset = 4;
1879 break;
1880 case 4:
1881 dst[dst_byte_offset++] |= (src_byte >> 2);
1882 dst[dst_byte_offset] = (src_byte << 6);
1883 current_bit_offset = 2;
1884 break;
1885 case 2:
1886 dst[dst_byte_offset++] |= (src_byte);
1887 current_bit_offset = 0;
1888 break;
1889 }
1890 src_byte_offset++;
1891 }
1892 (*dst_size) = dst_byte_offset;
1893out:
1894 return;
1895}
1896
1897/**
1898 * ecryptfs_encrypt_and_encode_filename - converts a plaintext file name to cipher text
1899 * @crypt_stat: The crypt_stat struct associated with the file anem to encode
1900 * @name: The plaintext name
1901 * @length: The length of the plaintext
1902 * @encoded_name: The encypted name
1903 *
1904 * Encrypts and encodes a filename into something that constitutes a
1905 * valid filename for a filesystem, with printable characters.
1906 *
1907 * We assume that we have a properly initialized crypto context,
1908 * pointed to by crypt_stat->tfm.
1909 *
1910 * Returns zero on success; non-zero on otherwise
1911 */
1912int ecryptfs_encrypt_and_encode_filename(
1913 char **encoded_name,
1914 size_t *encoded_name_size,
1915 struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
1916 const char *name, size_t name_size)
1917{
1918 size_t encoded_name_no_prefix_size;
1919 int rc = 0;
1920
1921 (*encoded_name) = NULL;
1922 (*encoded_name_size) = 0;
1923 if (mount_crypt_stat && (mount_crypt_stat->flags
1924 & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES)) {
1925 struct ecryptfs_filename *filename;
1926
1927 filename = kzalloc(sizeof(*filename), GFP_KERNEL);
1928 if (!filename) {
1929 rc = -ENOMEM;
1930 goto out;
1931 }
1932 filename->filename = (char *)name;
1933 filename->filename_size = name_size;
1934 rc = ecryptfs_encrypt_filename(filename, mount_crypt_stat);
1935 if (rc) {
1936 printk(KERN_ERR "%s: Error attempting to encrypt "
1937 "filename; rc = [%d]\n", __func__, rc);
1938 kfree(filename);
1939 goto out;
1940 }
1941 ecryptfs_encode_for_filename(
1942 NULL, &encoded_name_no_prefix_size,
1943 filename->encrypted_filename,
1944 filename->encrypted_filename_size);
1945 if (mount_crypt_stat
1946 && (mount_crypt_stat->flags
1947 & ECRYPTFS_GLOBAL_ENCFN_USE_MOUNT_FNEK))
1948 (*encoded_name_size) =
1949 (ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX_SIZE
1950 + encoded_name_no_prefix_size);
1951 else
1952 (*encoded_name_size) =
1953 (ECRYPTFS_FEK_ENCRYPTED_FILENAME_PREFIX_SIZE
1954 + encoded_name_no_prefix_size);
1955 (*encoded_name) = kmalloc((*encoded_name_size) + 1, GFP_KERNEL);
1956 if (!(*encoded_name)) {
1957 rc = -ENOMEM;
1958 kfree(filename->encrypted_filename);
1959 kfree(filename);
1960 goto out;
1961 }
1962 if (mount_crypt_stat
1963 && (mount_crypt_stat->flags
1964 & ECRYPTFS_GLOBAL_ENCFN_USE_MOUNT_FNEK)) {
1965 memcpy((*encoded_name),
1966 ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX,
1967 ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX_SIZE);
1968 ecryptfs_encode_for_filename(
1969 ((*encoded_name)
1970 + ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX_SIZE),
1971 &encoded_name_no_prefix_size,
1972 filename->encrypted_filename,
1973 filename->encrypted_filename_size);
1974 (*encoded_name_size) =
1975 (ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX_SIZE
1976 + encoded_name_no_prefix_size);
1977 (*encoded_name)[(*encoded_name_size)] = '\0';
1978 } else {
1979 rc = -EOPNOTSUPP;
1980 }
1981 if (rc) {
1982 printk(KERN_ERR "%s: Error attempting to encode "
1983 "encrypted filename; rc = [%d]\n", __func__,
1984 rc);
1985 kfree((*encoded_name));
1986 (*encoded_name) = NULL;
1987 (*encoded_name_size) = 0;
1988 }
1989 kfree(filename->encrypted_filename);
1990 kfree(filename);
1991 } else {
1992 rc = ecryptfs_copy_filename(encoded_name,
1993 encoded_name_size,
1994 name, name_size);
1995 }
1996out:
1997 return rc;
1998}
1999
2000static bool is_dot_dotdot(const char *name, size_t name_size)
2001{
2002 if (name_size == 1 && name[0] == '.')
2003 return true;
2004 else if (name_size == 2 && name[0] == '.' && name[1] == '.')
2005 return true;
2006
2007 return false;
2008}
2009
2010/**
2011 * ecryptfs_decode_and_decrypt_filename - converts the encoded cipher text name to decoded plaintext
2012 * @plaintext_name: The plaintext name
2013 * @plaintext_name_size: The plaintext name size
2014 * @ecryptfs_dir_dentry: eCryptfs directory dentry
2015 * @name: The filename in cipher text
2016 * @name_size: The cipher text name size
2017 *
2018 * Decrypts and decodes the filename.
2019 *
2020 * Returns zero on error; non-zero otherwise
2021 */
2022int ecryptfs_decode_and_decrypt_filename(char **plaintext_name,
2023 size_t *plaintext_name_size,
2024 struct super_block *sb,
2025 const char *name, size_t name_size)
2026{
2027 struct ecryptfs_mount_crypt_stat *mount_crypt_stat =
2028 &ecryptfs_superblock_to_private(sb)->mount_crypt_stat;
2029 char *decoded_name;
2030 size_t decoded_name_size;
2031 size_t packet_size;
2032 int rc = 0;
2033
2034 if ((mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES) &&
2035 !(mount_crypt_stat->flags & ECRYPTFS_ENCRYPTED_VIEW_ENABLED)) {
2036 if (is_dot_dotdot(name, name_size)) {
2037 rc = ecryptfs_copy_filename(plaintext_name,
2038 plaintext_name_size,
2039 name, name_size);
2040 goto out;
2041 }
2042
2043 if (name_size <= ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX_SIZE ||
2044 strncmp(name, ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX,
2045 ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX_SIZE)) {
2046 rc = -EINVAL;
2047 goto out;
2048 }
2049
2050 name += ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX_SIZE;
2051 name_size -= ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX_SIZE;
2052 ecryptfs_decode_from_filename(NULL, &decoded_name_size,
2053 name, name_size);
2054 decoded_name = kmalloc(decoded_name_size, GFP_KERNEL);
2055 if (!decoded_name) {
2056 rc = -ENOMEM;
2057 goto out;
2058 }
2059 ecryptfs_decode_from_filename(decoded_name, &decoded_name_size,
2060 name, name_size);
2061 rc = ecryptfs_parse_tag_70_packet(plaintext_name,
2062 plaintext_name_size,
2063 &packet_size,
2064 mount_crypt_stat,
2065 decoded_name,
2066 decoded_name_size);
2067 if (rc) {
2068 ecryptfs_printk(KERN_DEBUG,
2069 "%s: Could not parse tag 70 packet from filename\n",
2070 __func__);
2071 goto out_free;
2072 }
2073 } else {
2074 rc = ecryptfs_copy_filename(plaintext_name,
2075 plaintext_name_size,
2076 name, name_size);
2077 goto out;
2078 }
2079out_free:
2080 kfree(decoded_name);
2081out:
2082 return rc;
2083}
2084
2085#define ENC_NAME_MAX_BLOCKLEN_8_OR_16 143
2086
2087int ecryptfs_set_f_namelen(long *namelen, long lower_namelen,
2088 struct ecryptfs_mount_crypt_stat *mount_crypt_stat)
2089{
2090 struct crypto_skcipher *tfm;
2091 struct mutex *tfm_mutex;
2092 size_t cipher_blocksize;
2093 int rc;
2094
2095 if (!(mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES)) {
2096 (*namelen) = lower_namelen;
2097 return 0;
2098 }
2099
2100 rc = ecryptfs_get_tfm_and_mutex_for_cipher_name(&tfm, &tfm_mutex,
2101 mount_crypt_stat->global_default_fn_cipher_name);
2102 if (unlikely(rc)) {
2103 (*namelen) = 0;
2104 return rc;
2105 }
2106
2107 mutex_lock(tfm_mutex);
2108 cipher_blocksize = crypto_skcipher_blocksize(tfm);
2109 mutex_unlock(tfm_mutex);
2110
2111 /* Return an exact amount for the common cases */
2112 if (lower_namelen == NAME_MAX
2113 && (cipher_blocksize == 8 || cipher_blocksize == 16)) {
2114 (*namelen) = ENC_NAME_MAX_BLOCKLEN_8_OR_16;
2115 return 0;
2116 }
2117
2118 /* Return a safe estimate for the uncommon cases */
2119 (*namelen) = lower_namelen;
2120 (*namelen) -= ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX_SIZE;
2121 /* Since this is the max decoded size, subtract 1 "decoded block" len */
2122 (*namelen) = ecryptfs_max_decoded_size(*namelen) - 3;
2123 (*namelen) -= ECRYPTFS_TAG_70_MAX_METADATA_SIZE;
2124 (*namelen) -= ECRYPTFS_FILENAME_MIN_RANDOM_PREPEND_BYTES;
2125 /* Worst case is that the filename is padded nearly a full block size */
2126 (*namelen) -= cipher_blocksize - 1;
2127
2128 if ((*namelen) < 0)
2129 (*namelen) = 0;
2130
2131 return 0;
2132}