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