2 * eCryptfs: Linux filesystem encryption layer
3 * This is where eCryptfs coordinates the symmetric encryption and
4 * decryption of the file data as it passes between the lower
5 * encrypted file and the upper decrypted file.
7 * Copyright (C) 1997-2003 Erez Zadok
8 * Copyright (C) 2001-2003 Stony Brook University
9 * Copyright (C) 2004-2007 International Business Machines Corp.
10 * Author(s): Michael A. Halcrow <mahalcro@us.ibm.com>
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License as
14 * published by the Free Software Foundation; either version 2 of the
15 * License, or (at your option) any later version.
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
28 #include <linux/pagemap.h>
29 #include <linux/writeback.h>
30 #include <linux/page-flags.h>
31 #include <linux/mount.h>
32 #include <linux/file.h>
33 #include <linux/crypto.h>
34 #include <linux/scatterlist.h>
35 #include "ecryptfs_kernel.h"
38 * ecryptfs_get_locked_page
40 * Get one page from cache or lower f/s, return error otherwise.
42 * Returns locked and up-to-date page (if ok), with increased
45 struct page
*ecryptfs_get_locked_page(struct file
*file
, loff_t index
)
47 struct dentry
*dentry
;
49 struct address_space
*mapping
;
52 dentry
= file
->f_path
.dentry
;
53 inode
= dentry
->d_inode
;
54 mapping
= inode
->i_mapping
;
55 page
= read_mapping_page(mapping
, index
, (void *)file
);
63 * @page: Page that is locked before this call is made
65 * Returns zero on success; non-zero otherwise
67 static int ecryptfs_writepage(struct page
*page
, struct writeback_control
*wbc
)
71 rc
= ecryptfs_encrypt_page(page
);
73 ecryptfs_printk(KERN_WARNING
, "Error encrypting "
74 "page (upper index [0x%.16x])\n", page
->index
);
75 ClearPageUptodate(page
);
78 SetPageUptodate(page
);
86 * Octets 0-7: Unencrypted file size (big-endian)
87 * Octets 8-15: eCryptfs special marker
89 * Octet 16: File format version number (between 0 and 255)
90 * Octets 17-18: Reserved
91 * Octet 19: Bit 1 (lsb): Reserved
94 * Octets 20-23: Header extent size (big-endian)
95 * Octets 24-25: Number of header extents at front of file
97 * Octet 26: Begin RFC 2440 authentication token packet set
99 static void set_header_info(char *page_virt
,
100 struct ecryptfs_crypt_stat
*crypt_stat
)
103 size_t save_num_header_bytes_at_front
=
104 crypt_stat
->num_header_bytes_at_front
;
106 crypt_stat
->num_header_bytes_at_front
=
107 ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE
;
108 ecryptfs_write_header_metadata(page_virt
+ 20, crypt_stat
, &written
);
109 crypt_stat
->num_header_bytes_at_front
=
110 save_num_header_bytes_at_front
;
114 * ecryptfs_copy_up_encrypted_with_header
115 * @page: Sort of a ``virtual'' representation of the encrypted lower
116 * file. The actual lower file does not have the metadata in
117 * the header. This is locked.
118 * @crypt_stat: The eCryptfs inode's cryptographic context
120 * The ``view'' is the version of the file that userspace winds up
121 * seeing, with the header information inserted.
124 ecryptfs_copy_up_encrypted_with_header(struct page
*page
,
125 struct ecryptfs_crypt_stat
*crypt_stat
)
127 loff_t extent_num_in_page
= 0;
128 loff_t num_extents_per_page
= (PAGE_CACHE_SIZE
129 / crypt_stat
->extent_size
);
132 while (extent_num_in_page
< num_extents_per_page
) {
133 loff_t view_extent_num
= ((((loff_t
)page
->index
)
134 * num_extents_per_page
)
135 + extent_num_in_page
);
136 size_t num_header_extents_at_front
=
137 (crypt_stat
->num_header_bytes_at_front
138 / crypt_stat
->extent_size
);
140 if (view_extent_num
< num_header_extents_at_front
) {
141 /* This is a header extent */
144 page_virt
= kmap_atomic(page
, KM_USER0
);
145 memset(page_virt
, 0, PAGE_CACHE_SIZE
);
146 /* TODO: Support more than one header extent */
147 if (view_extent_num
== 0) {
148 rc
= ecryptfs_read_xattr_region(
149 page_virt
, page
->mapping
->host
);
150 set_header_info(page_virt
, crypt_stat
);
152 kunmap_atomic(page_virt
, KM_USER0
);
153 flush_dcache_page(page
);
155 printk(KERN_ERR
"%s: Error reading xattr "
156 "region; rc = [%d]\n", __FUNCTION__
, rc
);
160 /* This is an encrypted data extent */
161 loff_t lower_offset
=
162 ((view_extent_num
* crypt_stat
->extent_size
)
163 - crypt_stat
->num_header_bytes_at_front
);
165 rc
= ecryptfs_read_lower_page_segment(
166 page
, (lower_offset
>> PAGE_CACHE_SHIFT
),
167 (lower_offset
& ~PAGE_CACHE_MASK
),
168 crypt_stat
->extent_size
, page
->mapping
->host
);
170 printk(KERN_ERR
"%s: Error attempting to read "
171 "extent at offset [%lld] in the lower "
172 "file; rc = [%d]\n", __FUNCTION__
,
177 extent_num_in_page
++;
185 * @file: An eCryptfs file
186 * @page: Page from eCryptfs inode mapping into which to stick the read data
188 * Read in a page, decrypting if necessary.
190 * Returns zero on success; non-zero on error.
192 static int ecryptfs_readpage(struct file
*file
, struct page
*page
)
194 struct ecryptfs_crypt_stat
*crypt_stat
=
195 &ecryptfs_inode_to_private(file
->f_path
.dentry
->d_inode
)->crypt_stat
;
199 || !(crypt_stat
->flags
& ECRYPTFS_ENCRYPTED
)
200 || (crypt_stat
->flags
& ECRYPTFS_NEW_FILE
)) {
201 ecryptfs_printk(KERN_DEBUG
,
202 "Passing through unencrypted page\n");
203 rc
= ecryptfs_read_lower_page_segment(page
, page
->index
, 0,
205 page
->mapping
->host
);
206 } else if (crypt_stat
->flags
& ECRYPTFS_VIEW_AS_ENCRYPTED
) {
207 if (crypt_stat
->flags
& ECRYPTFS_METADATA_IN_XATTR
) {
208 rc
= ecryptfs_copy_up_encrypted_with_header(page
,
211 printk(KERN_ERR
"%s: Error attempting to copy "
212 "the encrypted content from the lower "
213 "file whilst inserting the metadata "
214 "from the xattr into the header; rc = "
215 "[%d]\n", __FUNCTION__
, rc
);
220 rc
= ecryptfs_read_lower_page_segment(
221 page
, page
->index
, 0, PAGE_CACHE_SIZE
,
222 page
->mapping
->host
);
224 printk(KERN_ERR
"Error reading page; rc = "
230 rc
= ecryptfs_decrypt_page(page
);
232 ecryptfs_printk(KERN_ERR
, "Error decrypting page; "
239 ClearPageUptodate(page
);
241 SetPageUptodate(page
);
242 ecryptfs_printk(KERN_DEBUG
, "Unlocking page with index = [0x%.16x]\n",
249 * Called with lower inode mutex held.
251 static int fill_zeros_to_end_of_page(struct page
*page
, unsigned int to
)
253 struct inode
*inode
= page
->mapping
->host
;
254 int end_byte_in_page
;
256 if ((i_size_read(inode
) / PAGE_CACHE_SIZE
) != page
->index
)
258 end_byte_in_page
= i_size_read(inode
) % PAGE_CACHE_SIZE
;
259 if (to
> end_byte_in_page
)
260 end_byte_in_page
= to
;
261 zero_user_segment(page
, end_byte_in_page
, PAGE_CACHE_SIZE
);
266 /* This function must zero any hole we create */
267 static int ecryptfs_prepare_write(struct file
*file
, struct page
*page
,
268 unsigned from
, unsigned to
)
271 loff_t prev_page_end_size
;
273 if (!PageUptodate(page
)) {
274 rc
= ecryptfs_read_lower_page_segment(page
, page
->index
, 0,
276 page
->mapping
->host
);
278 printk(KERN_ERR
"%s: Error attemping to read lower "
279 "page segment; rc = [%d]\n", __FUNCTION__
, rc
);
280 ClearPageUptodate(page
);
283 SetPageUptodate(page
);
286 prev_page_end_size
= ((loff_t
)page
->index
<< PAGE_CACHE_SHIFT
);
289 * If creating a page or more of holes, zero them out via truncate.
290 * Note, this will increase i_size.
292 if (page
->index
!= 0) {
293 if (prev_page_end_size
> i_size_read(page
->mapping
->host
)) {
294 rc
= ecryptfs_truncate(file
->f_path
.dentry
,
297 printk(KERN_ERR
"Error on attempt to "
298 "truncate to (higher) offset [%lld];"
299 " rc = [%d]\n", prev_page_end_size
, rc
);
305 * Writing to a new page, and creating a small hole from start of page?
308 if ((i_size_read(page
->mapping
->host
) == prev_page_end_size
) &&
310 zero_user(page
, 0, PAGE_CACHE_SIZE
);
317 * ecryptfs_write_inode_size_to_header
319 * Writes the lower file size to the first 8 bytes of the header.
321 * Returns zero on success; non-zero on error.
323 static int ecryptfs_write_inode_size_to_header(struct inode
*ecryptfs_inode
)
326 char *file_size_virt
;
329 file_size_virt
= kmalloc(sizeof(u64
), GFP_KERNEL
);
330 if (!file_size_virt
) {
334 file_size
= (u64
)i_size_read(ecryptfs_inode
);
335 file_size
= cpu_to_be64(file_size
);
336 memcpy(file_size_virt
, &file_size
, sizeof(u64
));
337 rc
= ecryptfs_write_lower(ecryptfs_inode
, file_size_virt
, 0,
339 kfree(file_size_virt
);
341 printk(KERN_ERR
"%s: Error writing file size to header; "
342 "rc = [%d]\n", __FUNCTION__
, rc
);
347 struct kmem_cache
*ecryptfs_xattr_cache
;
349 static int ecryptfs_write_inode_size_to_xattr(struct inode
*ecryptfs_inode
)
353 struct dentry
*lower_dentry
=
354 ecryptfs_inode_to_private(ecryptfs_inode
)->lower_file
->f_dentry
;
355 struct inode
*lower_inode
= lower_dentry
->d_inode
;
359 if (!lower_inode
->i_op
->getxattr
|| !lower_inode
->i_op
->setxattr
) {
361 "No support for setting xattr in lower filesystem\n");
365 xattr_virt
= kmem_cache_alloc(ecryptfs_xattr_cache
, GFP_KERNEL
);
367 printk(KERN_ERR
"Out of memory whilst attempting to write "
368 "inode size to xattr\n");
372 mutex_lock(&lower_inode
->i_mutex
);
373 size
= lower_inode
->i_op
->getxattr(lower_dentry
, ECRYPTFS_XATTR_NAME
,
374 xattr_virt
, PAGE_CACHE_SIZE
);
377 file_size
= (u64
)i_size_read(ecryptfs_inode
);
378 file_size
= cpu_to_be64(file_size
);
379 memcpy(xattr_virt
, &file_size
, sizeof(u64
));
380 rc
= lower_inode
->i_op
->setxattr(lower_dentry
, ECRYPTFS_XATTR_NAME
,
381 xattr_virt
, size
, 0);
382 mutex_unlock(&lower_inode
->i_mutex
);
384 printk(KERN_ERR
"Error whilst attempting to write inode size "
385 "to lower file xattr; rc = [%d]\n", rc
);
386 kmem_cache_free(ecryptfs_xattr_cache
, xattr_virt
);
391 int ecryptfs_write_inode_size_to_metadata(struct inode
*ecryptfs_inode
)
393 struct ecryptfs_crypt_stat
*crypt_stat
;
395 crypt_stat
= &ecryptfs_inode_to_private(ecryptfs_inode
)->crypt_stat
;
396 if (crypt_stat
->flags
& ECRYPTFS_METADATA_IN_XATTR
)
397 return ecryptfs_write_inode_size_to_xattr(ecryptfs_inode
);
399 return ecryptfs_write_inode_size_to_header(ecryptfs_inode
);
403 * ecryptfs_commit_write
404 * @file: The eCryptfs file object
405 * @page: The eCryptfs page
406 * @from: Ignored (we rotate the page IV on each write)
409 * This is where we encrypt the data and pass the encrypted data to
410 * the lower filesystem. In OpenPGP-compatible mode, we operate on
411 * entire underlying packets.
413 static int ecryptfs_commit_write(struct file
*file
, struct page
*page
,
414 unsigned from
, unsigned to
)
417 struct inode
*ecryptfs_inode
= page
->mapping
->host
;
418 struct ecryptfs_crypt_stat
*crypt_stat
=
419 &ecryptfs_inode_to_private(file
->f_path
.dentry
->d_inode
)->crypt_stat
;
422 if (crypt_stat
->flags
& ECRYPTFS_NEW_FILE
) {
423 ecryptfs_printk(KERN_DEBUG
, "ECRYPTFS_NEW_FILE flag set in "
424 "crypt_stat at memory location [%p]\n", crypt_stat
);
425 crypt_stat
->flags
&= ~(ECRYPTFS_NEW_FILE
);
427 ecryptfs_printk(KERN_DEBUG
, "Not a new file\n");
428 ecryptfs_printk(KERN_DEBUG
, "Calling fill_zeros_to_end_of_page"
429 "(page w/ index = [0x%.16x], to = [%d])\n", page
->index
,
431 /* Fills in zeros if 'to' goes beyond inode size */
432 rc
= fill_zeros_to_end_of_page(page
, to
);
434 ecryptfs_printk(KERN_WARNING
, "Error attempting to fill "
435 "zeros in page with index = [0x%.16x]\n",
439 rc
= ecryptfs_encrypt_page(page
);
441 ecryptfs_printk(KERN_WARNING
, "Error encrypting page (upper "
442 "index [0x%.16x])\n", page
->index
);
445 pos
= (((loff_t
)page
->index
) << PAGE_CACHE_SHIFT
) + to
;
446 if (pos
> i_size_read(ecryptfs_inode
)) {
447 i_size_write(ecryptfs_inode
, pos
);
448 ecryptfs_printk(KERN_DEBUG
, "Expanded file size to "
449 "[0x%.16x]\n", i_size_read(ecryptfs_inode
));
451 rc
= ecryptfs_write_inode_size_to_metadata(ecryptfs_inode
);
453 printk(KERN_ERR
"Error writing inode size to metadata; "
459 static sector_t
ecryptfs_bmap(struct address_space
*mapping
, sector_t block
)
463 struct inode
*lower_inode
;
465 inode
= (struct inode
*)mapping
->host
;
466 lower_inode
= ecryptfs_inode_to_lower(inode
);
467 if (lower_inode
->i_mapping
->a_ops
->bmap
)
468 rc
= lower_inode
->i_mapping
->a_ops
->bmap(lower_inode
->i_mapping
,
473 struct address_space_operations ecryptfs_aops
= {
474 .writepage
= ecryptfs_writepage
,
475 .readpage
= ecryptfs_readpage
,
476 .prepare_write
= ecryptfs_prepare_write
,
477 .commit_write
= ecryptfs_commit_write
,
478 .bmap
= ecryptfs_bmap
,