blob: b2a34a192f4f50f23c6ea8658926afbbb8d2fcb8 [file] [log] [blame]
Michael Halcrowda0102a2007-10-16 01:28:07 -07001/**
2 * eCryptfs: Linux filesystem encryption layer
3 *
4 * Copyright (C) 2007 International Business Machines Corp.
5 * Author(s): Michael A. Halcrow <mahalcro@us.ibm.com>
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License as
9 * published by the Free Software Foundation; either version 2 of the
10 * License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
20 * 02111-1307, USA.
21 */
22
23#include <linux/fs.h>
24#include <linux/pagemap.h>
25#include "ecryptfs_kernel.h"
26
27/**
28 * ecryptfs_write_lower
29 * @ecryptfs_inode: The eCryptfs inode
30 * @data: Data to write
31 * @offset: Byte offset in the lower file to which to write the data
32 * @size: Number of bytes from @data to write at @offset in the lower
33 * file
34 *
35 * Write data to the lower file.
36 *
Tyler Hicks96a7b9c2009-09-16 19:04:20 -050037 * Returns bytes written on success; less than zero on error
Michael Halcrowda0102a2007-10-16 01:28:07 -070038 */
39int ecryptfs_write_lower(struct inode *ecryptfs_inode, char *data,
40 loff_t offset, size_t size)
41{
Tyler Hicksf61500e2011-08-04 22:58:51 -050042 struct file *lower_file;
Michael Halcrowda0102a2007-10-16 01:28:07 -070043 mm_segment_t fs_save;
Tyler Hicks96a7b9c2009-09-16 19:04:20 -050044 ssize_t rc;
Michael Halcrowda0102a2007-10-16 01:28:07 -070045
Tyler Hicksf61500e2011-08-04 22:58:51 -050046 lower_file = ecryptfs_inode_to_private(ecryptfs_inode)->lower_file;
47 if (!lower_file)
48 return -EIO;
Michael Halcrowda0102a2007-10-16 01:28:07 -070049 fs_save = get_fs();
50 set_fs(get_ds());
Tyler Hicksf61500e2011-08-04 22:58:51 -050051 rc = vfs_write(lower_file, data, size, &offset);
Michael Halcrowda0102a2007-10-16 01:28:07 -070052 set_fs(fs_save);
Michael Halcrowda0102a2007-10-16 01:28:07 -070053 mark_inode_dirty_sync(ecryptfs_inode);
54 return rc;
55}
56
57/**
58 * ecryptfs_write_lower_page_segment
59 * @ecryptfs_inode: The eCryptfs inode
60 * @page_for_lower: The page containing the data to be written to the
61 * lower file
62 * @offset_in_page: The offset in the @page_for_lower from which to
63 * start writing the data
64 * @size: The amount of data from @page_for_lower to write to the
65 * lower file
66 *
67 * Determines the byte offset in the file for the given page and
68 * offset within the page, maps the page, and makes the call to write
69 * the contents of @page_for_lower to the lower inode.
70 *
71 * Returns zero on success; non-zero otherwise
72 */
73int ecryptfs_write_lower_page_segment(struct inode *ecryptfs_inode,
74 struct page *page_for_lower,
75 size_t offset_in_page, size_t size)
76{
77 char *virt;
78 loff_t offset;
79 int rc;
80
Michael Halcrow8a146a22007-11-14 16:58:27 -080081 offset = ((((loff_t)page_for_lower->index) << PAGE_CACHE_SHIFT)
Michael Halcrowd6a13c12007-10-16 01:28:12 -070082 + offset_in_page);
Michael Halcrowda0102a2007-10-16 01:28:07 -070083 virt = kmap(page_for_lower);
84 rc = ecryptfs_write_lower(ecryptfs_inode, virt, offset, size);
Tyler Hicks96a7b9c2009-09-16 19:04:20 -050085 if (rc > 0)
86 rc = 0;
Michael Halcrowda0102a2007-10-16 01:28:07 -070087 kunmap(page_for_lower);
88 return rc;
89}
90
91/**
92 * ecryptfs_write
Al Viro48c1e442010-05-21 11:09:58 -040093 * @ecryptfs_inode: The eCryptfs file into which to write
Michael Halcrowda0102a2007-10-16 01:28:07 -070094 * @data: Virtual address where data to write is located
95 * @offset: Offset in the eCryptfs file at which to begin writing the
96 * data from @data
97 * @size: The number of bytes to write from @data
98 *
99 * Write an arbitrary amount of data to an arbitrary location in the
100 * eCryptfs inode page cache. This is done on a page-by-page, and then
101 * by an extent-by-extent, basis; individual extents are encrypted and
102 * written to the lower page cache (via VFS writes). This function
103 * takes care of all the address translation to locations in the lower
104 * filesystem; it also handles truncate events, writing out zeros
105 * where necessary.
106 *
107 * Returns zero on success; non-zero otherwise
108 */
Al Viro48c1e442010-05-21 11:09:58 -0400109int ecryptfs_write(struct inode *ecryptfs_inode, char *data, loff_t offset,
Michael Halcrowda0102a2007-10-16 01:28:07 -0700110 size_t size)
111{
112 struct page *ecryptfs_page;
Tyler Hicks13a791b2009-04-13 15:29:27 -0500113 struct ecryptfs_crypt_stat *crypt_stat;
Michael Halcrowda0102a2007-10-16 01:28:07 -0700114 char *ecryptfs_page_virt;
Tyler Hicks13a791b2009-04-13 15:29:27 -0500115 loff_t ecryptfs_file_size = i_size_read(ecryptfs_inode);
Michael Halcrowda0102a2007-10-16 01:28:07 -0700116 loff_t data_offset = 0;
117 loff_t pos;
118 int rc = 0;
119
Tyler Hicks13a791b2009-04-13 15:29:27 -0500120 crypt_stat = &ecryptfs_inode_to_private(ecryptfs_inode)->crypt_stat;
Eric Sandeen7a3f5952007-12-17 16:20:10 -0800121 /*
122 * if we are writing beyond current size, then start pos
123 * at the current size - we'll fill in zeros from there.
124 */
Michael Halcrowda0102a2007-10-16 01:28:07 -0700125 if (offset > ecryptfs_file_size)
126 pos = ecryptfs_file_size;
127 else
128 pos = offset;
129 while (pos < (offset + size)) {
130 pgoff_t ecryptfs_page_idx = (pos >> PAGE_CACHE_SHIFT);
131 size_t start_offset_in_page = (pos & ~PAGE_CACHE_MASK);
132 size_t num_bytes = (PAGE_CACHE_SIZE - start_offset_in_page);
Li Wang684a3ff2012-01-19 09:44:36 +0800133 loff_t total_remaining_bytes = ((offset + size) - pos);
Michael Halcrowda0102a2007-10-16 01:28:07 -0700134
Tyler Hicks5e6f0d72012-01-18 18:30:04 -0600135 if (fatal_signal_pending(current)) {
136 rc = -EINTR;
137 break;
138 }
139
Michael Halcrowda0102a2007-10-16 01:28:07 -0700140 if (num_bytes > total_remaining_bytes)
141 num_bytes = total_remaining_bytes;
142 if (pos < offset) {
Eric Sandeen7a3f5952007-12-17 16:20:10 -0800143 /* remaining zeros to write, up to destination offset */
Li Wang684a3ff2012-01-19 09:44:36 +0800144 loff_t total_remaining_zeros = (offset - pos);
Michael Halcrowda0102a2007-10-16 01:28:07 -0700145
146 if (num_bytes > total_remaining_zeros)
147 num_bytes = total_remaining_zeros;
148 }
Al Viro02bd9792010-05-21 11:02:14 -0400149 ecryptfs_page = ecryptfs_get_locked_page(ecryptfs_inode,
Michael Halcrow16a72c42007-10-16 01:28:14 -0700150 ecryptfs_page_idx);
Michael Halcrowda0102a2007-10-16 01:28:07 -0700151 if (IS_ERR(ecryptfs_page)) {
152 rc = PTR_ERR(ecryptfs_page);
153 printk(KERN_ERR "%s: Error getting page at "
154 "index [%ld] from eCryptfs inode "
Harvey Harrison18d1dbf2008-04-29 00:59:48 -0700155 "mapping; rc = [%d]\n", __func__,
Michael Halcrowda0102a2007-10-16 01:28:07 -0700156 ecryptfs_page_idx, rc);
157 goto out;
158 }
Cong Wang465c9342012-02-10 13:39:50 +0800159 ecryptfs_page_virt = kmap_atomic(ecryptfs_page);
Eric Sandeen7a3f5952007-12-17 16:20:10 -0800160
161 /*
162 * pos: where we're now writing, offset: where the request was
163 * If current pos is before request, we are filling zeros
164 * If we are at or beyond request, we are writing the *data*
165 * If we're in a fresh page beyond eof, zero it in either case
166 */
167 if (pos < offset || !start_offset_in_page) {
168 /* We are extending past the previous end of the file.
169 * Fill in zero values to the end of the page */
170 memset(((char *)ecryptfs_page_virt
171 + start_offset_in_page), 0,
172 PAGE_CACHE_SIZE - start_offset_in_page);
173 }
174
175 /* pos >= offset, we are now writing the data request */
Michael Halcrowda0102a2007-10-16 01:28:07 -0700176 if (pos >= offset) {
177 memcpy(((char *)ecryptfs_page_virt
178 + start_offset_in_page),
179 (data + data_offset), num_bytes);
180 data_offset += num_bytes;
Michael Halcrowda0102a2007-10-16 01:28:07 -0700181 }
Cong Wang465c9342012-02-10 13:39:50 +0800182 kunmap_atomic(ecryptfs_page_virt);
Michael Halcrowda0102a2007-10-16 01:28:07 -0700183 flush_dcache_page(ecryptfs_page);
Michael Halcrow16a72c42007-10-16 01:28:14 -0700184 SetPageUptodate(ecryptfs_page);
185 unlock_page(ecryptfs_page);
Tyler Hicks13a791b2009-04-13 15:29:27 -0500186 if (crypt_stat->flags & ECRYPTFS_ENCRYPTED)
187 rc = ecryptfs_encrypt_page(ecryptfs_page);
188 else
189 rc = ecryptfs_write_lower_page_segment(ecryptfs_inode,
190 ecryptfs_page,
191 start_offset_in_page,
192 data_offset);
Michael Halcrow16a72c42007-10-16 01:28:14 -0700193 page_cache_release(ecryptfs_page);
Michael Halcrowda0102a2007-10-16 01:28:07 -0700194 if (rc) {
195 printk(KERN_ERR "%s: Error encrypting "
Harvey Harrison18d1dbf2008-04-29 00:59:48 -0700196 "page; rc = [%d]\n", __func__, rc);
Michael Halcrowda0102a2007-10-16 01:28:07 -0700197 goto out;
198 }
Michael Halcrowda0102a2007-10-16 01:28:07 -0700199 pos += num_bytes;
200 }
Tyler Hicks5e6f0d72012-01-18 18:30:04 -0600201 if (pos > ecryptfs_file_size) {
202 i_size_write(ecryptfs_inode, pos);
Tyler Hicks13a791b2009-04-13 15:29:27 -0500203 if (crypt_stat->flags & ECRYPTFS_ENCRYPTED) {
Tyler Hicks5e6f0d72012-01-18 18:30:04 -0600204 int rc2;
205
206 rc2 = ecryptfs_write_inode_size_to_metadata(
Tyler Hicks13a791b2009-04-13 15:29:27 -0500207 ecryptfs_inode);
Tyler Hicks5e6f0d72012-01-18 18:30:04 -0600208 if (rc2) {
Tyler Hicks13a791b2009-04-13 15:29:27 -0500209 printk(KERN_ERR "Problem with "
210 "ecryptfs_write_inode_size_to_metadata; "
Tyler Hicks5e6f0d72012-01-18 18:30:04 -0600211 "rc = [%d]\n", rc2);
212 if (!rc)
213 rc = rc2;
Tyler Hicks13a791b2009-04-13 15:29:27 -0500214 goto out;
215 }
Michael Halcrowda0102a2007-10-16 01:28:07 -0700216 }
217 }
218out:
219 return rc;
220}
221
222/**
223 * ecryptfs_read_lower
224 * @data: The read data is stored here by this function
225 * @offset: Byte offset in the lower file from which to read the data
226 * @size: Number of bytes to read from @offset of the lower file and
227 * store into @data
228 * @ecryptfs_inode: The eCryptfs inode
229 *
230 * Read @size bytes of data at byte offset @offset from the lower
231 * inode into memory location @data.
232 *
Tyler Hicks96a7b9c2009-09-16 19:04:20 -0500233 * Returns bytes read on success; 0 on EOF; less than zero on error
Michael Halcrowda0102a2007-10-16 01:28:07 -0700234 */
235int ecryptfs_read_lower(char *data, loff_t offset, size_t size,
236 struct inode *ecryptfs_inode)
237{
Tyler Hicksf61500e2011-08-04 22:58:51 -0500238 struct file *lower_file;
Michael Halcrowda0102a2007-10-16 01:28:07 -0700239 mm_segment_t fs_save;
Tyler Hicks96a7b9c2009-09-16 19:04:20 -0500240 ssize_t rc;
Michael Halcrowda0102a2007-10-16 01:28:07 -0700241
Tyler Hicksf61500e2011-08-04 22:58:51 -0500242 lower_file = ecryptfs_inode_to_private(ecryptfs_inode)->lower_file;
243 if (!lower_file)
244 return -EIO;
Michael Halcrowda0102a2007-10-16 01:28:07 -0700245 fs_save = get_fs();
246 set_fs(get_ds());
Tyler Hicksf61500e2011-08-04 22:58:51 -0500247 rc = vfs_read(lower_file, data, size, &offset);
Michael Halcrowda0102a2007-10-16 01:28:07 -0700248 set_fs(fs_save);
Michael Halcrowda0102a2007-10-16 01:28:07 -0700249 return rc;
250}
251
252/**
253 * ecryptfs_read_lower_page_segment
254 * @page_for_ecryptfs: The page into which data for eCryptfs will be
255 * written
256 * @offset_in_page: Offset in @page_for_ecryptfs from which to start
257 * writing
258 * @size: The number of bytes to write into @page_for_ecryptfs
259 * @ecryptfs_inode: The eCryptfs inode
260 *
261 * Determines the byte offset in the file for the given page and
262 * offset within the page, maps the page, and makes the call to read
263 * the contents of @page_for_ecryptfs from the lower inode.
264 *
265 * Returns zero on success; non-zero otherwise
266 */
267int ecryptfs_read_lower_page_segment(struct page *page_for_ecryptfs,
268 pgoff_t page_index,
269 size_t offset_in_page, size_t size,
270 struct inode *ecryptfs_inode)
271{
272 char *virt;
273 loff_t offset;
274 int rc;
275
Michael Halcrowd6a13c12007-10-16 01:28:12 -0700276 offset = ((((loff_t)page_index) << PAGE_CACHE_SHIFT) + offset_in_page);
Michael Halcrowda0102a2007-10-16 01:28:07 -0700277 virt = kmap(page_for_ecryptfs);
278 rc = ecryptfs_read_lower(virt, offset, size, ecryptfs_inode);
Tyler Hicks96a7b9c2009-09-16 19:04:20 -0500279 if (rc > 0)
280 rc = 0;
Michael Halcrowda0102a2007-10-16 01:28:07 -0700281 kunmap(page_for_ecryptfs);
Michael Halcrow16a72c42007-10-16 01:28:14 -0700282 flush_dcache_page(page_for_ecryptfs);
Michael Halcrowda0102a2007-10-16 01:28:07 -0700283 return rc;
284}