blob: bd969adf70d72bd8cc5335e3f8a47e06c220be52 [file] [log] [blame]
Michael Halcrow237fead2006-10-04 02:16:22 -07001/**
2 * eCryptfs: Linux filesystem encryption layer
3 *
4 * Copyright (C) 1997-2004 Erez Zadok
5 * Copyright (C) 2001-2004 Stony Brook University
Michael Halcrowdd2a3b72007-02-12 00:53:46 -08006 * Copyright (C) 2004-2007 International Business Machines Corp.
Michael Halcrow237fead2006-10-04 02:16:22 -07007 * Author(s): Michael A. Halcrow <mhalcrow@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/file.h>
27#include <linux/poll.h>
28#include <linux/mount.h>
29#include <linux/pagemap.h>
30#include <linux/security.h>
31#include <linux/smp_lock.h>
32#include <linux/compat.h>
Josef "Jeff" Sipek0cc72dc2006-12-08 02:36:31 -080033#include <linux/fs_stack.h>
Michael Halcrow237fead2006-10-04 02:16:22 -070034#include "ecryptfs_kernel.h"
35
36/**
37 * ecryptfs_llseek
38 * @file: File we are seeking in
39 * @offset: The offset to seek to
40 * @origin: 2 - offset from i_size; 1 - offset from f_pos
41 *
42 * Returns the position we have seeked to, or negative on error
43 */
44static loff_t ecryptfs_llseek(struct file *file, loff_t offset, int origin)
45{
46 loff_t rv;
47 loff_t new_end_pos;
48 int rc;
49 int expanding_file = 0;
50 struct inode *inode = file->f_mapping->host;
51
52 /* If our offset is past the end of our file, we're going to
53 * need to grow it so we have a valid length of 0's */
54 new_end_pos = offset;
55 switch (origin) {
56 case 2:
57 new_end_pos += i_size_read(inode);
58 expanding_file = 1;
59 break;
60 case 1:
61 new_end_pos += file->f_pos;
62 if (new_end_pos > i_size_read(inode)) {
63 ecryptfs_printk(KERN_DEBUG, "new_end_pos(=[0x%.16x]) "
64 "> i_size_read(inode)(=[0x%.16x])\n",
65 new_end_pos, i_size_read(inode));
66 expanding_file = 1;
67 }
68 break;
69 default:
70 if (new_end_pos > i_size_read(inode)) {
71 ecryptfs_printk(KERN_DEBUG, "new_end_pos(=[0x%.16x]) "
72 "> i_size_read(inode)(=[0x%.16x])\n",
73 new_end_pos, i_size_read(inode));
74 expanding_file = 1;
75 }
76 }
77 ecryptfs_printk(KERN_DEBUG, "new_end_pos = [0x%.16x]\n", new_end_pos);
78 if (expanding_file) {
Josef "Jeff" Sipekbd243a42006-12-08 02:36:48 -080079 rc = ecryptfs_truncate(file->f_path.dentry, new_end_pos);
Michael Halcrow237fead2006-10-04 02:16:22 -070080 if (rc) {
81 rv = rc;
82 ecryptfs_printk(KERN_ERR, "Error on attempt to "
83 "truncate to (higher) offset [0x%.16x];"
84 " rc = [%d]\n", new_end_pos, rc);
85 goto out;
86 }
87 }
88 rv = generic_file_llseek(file, offset, origin);
89out:
90 return rv;
91}
92
93/**
94 * ecryptfs_read_update_atime
95 *
96 * generic_file_read updates the atime of upper layer inode. But, it
97 * doesn't give us a chance to update the atime of the lower layer
98 * inode. This function is a wrapper to generic_file_read. It
99 * updates the atime of the lower level inode if generic_file_read
100 * returns without any errors. This is to be used only for file reads.
101 * The function to be used for directory reads is ecryptfs_read.
102 */
103static ssize_t ecryptfs_read_update_atime(struct kiocb *iocb,
104 const struct iovec *iov,
105 unsigned long nr_segs, loff_t pos)
106{
107 int rc;
108 struct dentry *lower_dentry;
109 struct vfsmount *lower_vfsmount;
110 struct file *file = iocb->ki_filp;
111
112 rc = generic_file_aio_read(iocb, iov, nr_segs, pos);
113 /*
114 * Even though this is a async interface, we need to wait
115 * for IO to finish to update atime
116 */
117 if (-EIOCBQUEUED == rc)
118 rc = wait_on_sync_kiocb(iocb);
119 if (rc >= 0) {
Josef "Jeff" Sipekbd243a42006-12-08 02:36:48 -0800120 lower_dentry = ecryptfs_dentry_to_lower(file->f_path.dentry);
121 lower_vfsmount = ecryptfs_dentry_to_lower_mnt(file->f_path.dentry);
Michael Halcrow237fead2006-10-04 02:16:22 -0700122 touch_atime(lower_vfsmount, lower_dentry);
123 }
124 return rc;
125}
126
127struct ecryptfs_getdents_callback {
128 void *dirent;
129 struct dentry *dentry;
130 filldir_t filldir;
131 int err;
132 int filldir_called;
133 int entries_written;
134};
135
136/* Inspired by generic filldir in fs/readir.c */
137static int
138ecryptfs_filldir(void *dirent, const char *name, int namelen, loff_t offset,
139 u64 ino, unsigned int d_type)
140{
141 struct ecryptfs_crypt_stat *crypt_stat;
142 struct ecryptfs_getdents_callback *buf =
143 (struct ecryptfs_getdents_callback *)dirent;
144 int rc;
145 int decoded_length;
146 char *decoded_name;
147
148 crypt_stat = ecryptfs_dentry_to_private(buf->dentry)->crypt_stat;
149 buf->filldir_called++;
150 decoded_length = ecryptfs_decode_filename(crypt_stat, name, namelen,
151 &decoded_name);
152 if (decoded_length < 0) {
153 rc = decoded_length;
154 goto out;
155 }
156 rc = buf->filldir(buf->dirent, decoded_name, decoded_length, offset,
157 ino, d_type);
158 kfree(decoded_name);
159 if (rc >= 0)
160 buf->entries_written++;
161out:
162 return rc;
163}
164
165/**
166 * ecryptfs_readdir
167 * @file: The ecryptfs file struct
168 * @dirent: Directory entry
169 * @filldir: The filldir callback function
170 */
171static int ecryptfs_readdir(struct file *file, void *dirent, filldir_t filldir)
172{
173 int rc;
174 struct file *lower_file;
175 struct inode *inode;
176 struct ecryptfs_getdents_callback buf;
177
178 lower_file = ecryptfs_file_to_lower(file);
179 lower_file->f_pos = file->f_pos;
Josef "Jeff" Sipekbd243a42006-12-08 02:36:48 -0800180 inode = file->f_path.dentry->d_inode;
Michael Halcrow237fead2006-10-04 02:16:22 -0700181 memset(&buf, 0, sizeof(buf));
182 buf.dirent = dirent;
Josef "Jeff" Sipekbd243a42006-12-08 02:36:48 -0800183 buf.dentry = file->f_path.dentry;
Michael Halcrow237fead2006-10-04 02:16:22 -0700184 buf.filldir = filldir;
185retry:
186 buf.filldir_called = 0;
187 buf.entries_written = 0;
188 buf.err = 0;
189 rc = vfs_readdir(lower_file, ecryptfs_filldir, (void *)&buf);
190 if (buf.err)
191 rc = buf.err;
192 if (buf.filldir_called && !buf.entries_written)
193 goto retry;
194 file->f_pos = lower_file->f_pos;
195 if (rc >= 0)
Josef "Jeff" Sipekbd243a42006-12-08 02:36:48 -0800196 fsstack_copy_attr_atime(inode, lower_file->f_path.dentry->d_inode);
Michael Halcrow237fead2006-10-04 02:16:22 -0700197 return rc;
198}
199
200struct kmem_cache *ecryptfs_file_info_cache;
201
Michael Halcrow7ff1d742006-10-30 22:07:19 -0800202int ecryptfs_open_lower_file(struct file **lower_file,
203 struct dentry *lower_dentry,
204 struct vfsmount *lower_mnt, int flags)
205{
206 int rc = 0;
207
208 dget(lower_dentry);
209 mntget(lower_mnt);
210 *lower_file = dentry_open(lower_dentry, lower_mnt, flags);
211 if (IS_ERR(*lower_file)) {
212 printk(KERN_ERR "Error opening lower file for lower_dentry "
213 "[0x%p], lower_mnt [0x%p], and flags [0x%x]\n",
214 lower_dentry, lower_mnt, flags);
215 rc = PTR_ERR(*lower_file);
216 *lower_file = NULL;
217 goto out;
218 }
219out:
220 return rc;
221}
222
223int ecryptfs_close_lower_file(struct file *lower_file)
224{
225 fput(lower_file);
226 return 0;
227}
228
Michael Halcrow237fead2006-10-04 02:16:22 -0700229/**
230 * ecryptfs_open
231 * @inode: inode speciying file to open
232 * @file: Structure to return filled in
233 *
234 * Opens the file specified by inode.
235 *
236 * Returns zero on success; non-zero otherwise
237 */
238static int ecryptfs_open(struct inode *inode, struct file *file)
239{
240 int rc = 0;
241 struct ecryptfs_crypt_stat *crypt_stat = NULL;
242 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
Josef "Jeff" Sipekbd243a42006-12-08 02:36:48 -0800243 struct dentry *ecryptfs_dentry = file->f_path.dentry;
Michael Halcrow237fead2006-10-04 02:16:22 -0700244 /* Private value of ecryptfs_dentry allocated in
245 * ecryptfs_lookup() */
246 struct dentry *lower_dentry = ecryptfs_dentry_to_lower(ecryptfs_dentry);
247 struct inode *lower_inode = NULL;
248 struct file *lower_file = NULL;
249 struct vfsmount *lower_mnt;
250 struct ecryptfs_file_info *file_info;
251 int lower_flags;
252
Michael Halcrowe77a56d2007-02-12 00:53:47 -0800253 mount_crypt_stat = &ecryptfs_superblock_to_private(
254 ecryptfs_dentry->d_sb)->mount_crypt_stat;
255 if ((mount_crypt_stat->flags & ECRYPTFS_ENCRYPTED_VIEW_ENABLED)
256 && ((file->f_flags & O_WRONLY) || (file->f_flags & O_RDWR)
257 || (file->f_flags & O_CREAT) || (file->f_flags & O_TRUNC)
258 || (file->f_flags & O_APPEND))) {
259 printk(KERN_WARNING "Mount has encrypted view enabled; "
260 "files may only be read\n");
261 rc = -EPERM;
262 goto out;
263 }
Michael Halcrow237fead2006-10-04 02:16:22 -0700264 /* Released in ecryptfs_release or end of function if failure */
Robert P. J. Dayc3762222007-02-10 01:45:03 -0800265 file_info = kmem_cache_zalloc(ecryptfs_file_info_cache, GFP_KERNEL);
Michael Halcrow237fead2006-10-04 02:16:22 -0700266 ecryptfs_set_file_private(file, file_info);
267 if (!file_info) {
268 ecryptfs_printk(KERN_ERR,
269 "Error attempting to allocate memory\n");
270 rc = -ENOMEM;
271 goto out;
272 }
Michael Halcrow237fead2006-10-04 02:16:22 -0700273 lower_dentry = ecryptfs_dentry_to_lower(ecryptfs_dentry);
274 crypt_stat = &ecryptfs_inode_to_private(inode)->crypt_stat;
Michael Halcrow237fead2006-10-04 02:16:22 -0700275 mutex_lock(&crypt_stat->cs_mutex);
Michael Halcrowe2bd99e2007-02-12 00:53:49 -0800276 if (!(crypt_stat->flags & ECRYPTFS_POLICY_APPLIED)) {
Michael Halcrow237fead2006-10-04 02:16:22 -0700277 ecryptfs_printk(KERN_DEBUG, "Setting flags for stat...\n");
278 /* Policy code enabled in future release */
Michael Halcrowe2bd99e2007-02-12 00:53:49 -0800279 crypt_stat->flags |= ECRYPTFS_POLICY_APPLIED;
280 crypt_stat->flags |= ECRYPTFS_ENCRYPTED;
Michael Halcrow237fead2006-10-04 02:16:22 -0700281 }
282 mutex_unlock(&crypt_stat->cs_mutex);
Michael Halcrow237fead2006-10-04 02:16:22 -0700283 lower_flags = file->f_flags;
284 if ((lower_flags & O_ACCMODE) == O_WRONLY)
285 lower_flags = (lower_flags & O_ACCMODE) | O_RDWR;
286 if (file->f_flags & O_APPEND)
287 lower_flags &= ~O_APPEND;
288 lower_mnt = ecryptfs_dentry_to_lower_mnt(ecryptfs_dentry);
Michael Halcrow237fead2006-10-04 02:16:22 -0700289 /* Corresponding fput() in ecryptfs_release() */
Michael Halcrow7ff1d742006-10-30 22:07:19 -0800290 if ((rc = ecryptfs_open_lower_file(&lower_file, lower_dentry, lower_mnt,
291 lower_flags))) {
Michael Halcrow237fead2006-10-04 02:16:22 -0700292 ecryptfs_printk(KERN_ERR, "Error opening lower file\n");
293 goto out_puts;
294 }
295 ecryptfs_set_file_lower(file, lower_file);
296 /* Isn't this check the same as the one in lookup? */
297 lower_inode = lower_dentry->d_inode;
298 if (S_ISDIR(ecryptfs_dentry->d_inode->i_mode)) {
299 ecryptfs_printk(KERN_DEBUG, "This is a directory\n");
Michael Halcrowe2bd99e2007-02-12 00:53:49 -0800300 crypt_stat->flags &= ~(ECRYPTFS_ENCRYPTED);
Michael Halcrow237fead2006-10-04 02:16:22 -0700301 rc = 0;
302 goto out;
303 }
304 mutex_lock(&crypt_stat->cs_mutex);
Michael Halcrowe2bd99e2007-02-12 00:53:49 -0800305 if (!(crypt_stat->flags & ECRYPTFS_POLICY_APPLIED)
306 || !(crypt_stat->flags & ECRYPTFS_KEY_VALID)) {
Michael Halcrowdd2a3b72007-02-12 00:53:46 -0800307 rc = ecryptfs_read_metadata(ecryptfs_dentry, lower_file);
Michael Halcrow237fead2006-10-04 02:16:22 -0700308 if (rc) {
309 ecryptfs_printk(KERN_DEBUG,
310 "Valid headers not found\n");
311 if (!(mount_crypt_stat->flags
312 & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED)) {
313 rc = -EIO;
314 printk(KERN_WARNING "Attempt to read file that "
315 "is not in a valid eCryptfs format, "
316 "and plaintext passthrough mode is not "
317 "enabled; returning -EIO\n");
318 mutex_unlock(&crypt_stat->cs_mutex);
319 goto out_puts;
320 }
Michael Halcrow237fead2006-10-04 02:16:22 -0700321 rc = 0;
Michael Halcrowe2bd99e2007-02-12 00:53:49 -0800322 crypt_stat->flags &= ~(ECRYPTFS_ENCRYPTED);
Michael Halcrow237fead2006-10-04 02:16:22 -0700323 mutex_unlock(&crypt_stat->cs_mutex);
324 goto out;
325 }
326 }
327 mutex_unlock(&crypt_stat->cs_mutex);
328 ecryptfs_printk(KERN_DEBUG, "inode w/ addr = [0x%p], i_ino = [0x%.16x] "
329 "size: [0x%.16x]\n", inode, inode->i_ino,
330 i_size_read(inode));
331 ecryptfs_set_file_lower(file, lower_file);
332 goto out;
333out_puts:
334 mntput(lower_mnt);
335 dput(lower_dentry);
336 kmem_cache_free(ecryptfs_file_info_cache,
337 ecryptfs_file_to_private(file));
338out:
339 return rc;
340}
341
342static int ecryptfs_flush(struct file *file, fl_owner_t td)
343{
344 int rc = 0;
345 struct file *lower_file = NULL;
346
347 lower_file = ecryptfs_file_to_lower(file);
348 if (lower_file->f_op && lower_file->f_op->flush)
349 rc = lower_file->f_op->flush(lower_file, td);
350 return rc;
351}
352
353static int ecryptfs_release(struct inode *inode, struct file *file)
354{
355 struct file *lower_file = ecryptfs_file_to_lower(file);
356 struct ecryptfs_file_info *file_info = ecryptfs_file_to_private(file);
357 struct inode *lower_inode = ecryptfs_inode_to_lower(inode);
Michael Halcrow7ff1d742006-10-30 22:07:19 -0800358 int rc;
Michael Halcrow237fead2006-10-04 02:16:22 -0700359
Michael Halcrow7ff1d742006-10-30 22:07:19 -0800360 if ((rc = ecryptfs_close_lower_file(lower_file))) {
361 printk(KERN_ERR "Error closing lower_file\n");
362 goto out;
363 }
Michael Halcrow237fead2006-10-04 02:16:22 -0700364 inode->i_blocks = lower_inode->i_blocks;
365 kmem_cache_free(ecryptfs_file_info_cache, file_info);
Michael Halcrow7ff1d742006-10-30 22:07:19 -0800366out:
367 return rc;
Michael Halcrow237fead2006-10-04 02:16:22 -0700368}
369
370static int
371ecryptfs_fsync(struct file *file, struct dentry *dentry, int datasync)
372{
373 struct file *lower_file = ecryptfs_file_to_lower(file);
374 struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
375 struct inode *lower_inode = lower_dentry->d_inode;
376 int rc = -EINVAL;
377
378 if (lower_inode->i_fop->fsync) {
379 mutex_lock(&lower_inode->i_mutex);
380 rc = lower_inode->i_fop->fsync(lower_file, lower_dentry,
381 datasync);
382 mutex_unlock(&lower_inode->i_mutex);
383 }
384 return rc;
385}
386
387static int ecryptfs_fasync(int fd, struct file *file, int flag)
388{
389 int rc = 0;
390 struct file *lower_file = NULL;
391
392 lower_file = ecryptfs_file_to_lower(file);
393 if (lower_file->f_op && lower_file->f_op->fasync)
394 rc = lower_file->f_op->fasync(fd, lower_file, flag);
395 return rc;
396}
397
398static ssize_t ecryptfs_sendfile(struct file *file, loff_t * ppos,
399 size_t count, read_actor_t actor, void *target)
400{
401 struct file *lower_file = NULL;
402 int rc = -EINVAL;
403
404 lower_file = ecryptfs_file_to_lower(file);
405 if (lower_file->f_op && lower_file->f_op->sendfile)
406 rc = lower_file->f_op->sendfile(lower_file, ppos, count,
407 actor, target);
408
409 return rc;
410}
411
412static int ecryptfs_ioctl(struct inode *inode, struct file *file,
413 unsigned int cmd, unsigned long arg);
414
415const struct file_operations ecryptfs_dir_fops = {
416 .readdir = ecryptfs_readdir,
417 .ioctl = ecryptfs_ioctl,
418 .mmap = generic_file_mmap,
419 .open = ecryptfs_open,
420 .flush = ecryptfs_flush,
421 .release = ecryptfs_release,
422 .fsync = ecryptfs_fsync,
423 .fasync = ecryptfs_fasync,
424 .sendfile = ecryptfs_sendfile,
425};
426
427const struct file_operations ecryptfs_main_fops = {
428 .llseek = ecryptfs_llseek,
429 .read = do_sync_read,
430 .aio_read = ecryptfs_read_update_atime,
431 .write = do_sync_write,
432 .aio_write = generic_file_aio_write,
433 .readdir = ecryptfs_readdir,
434 .ioctl = ecryptfs_ioctl,
435 .mmap = generic_file_mmap,
436 .open = ecryptfs_open,
437 .flush = ecryptfs_flush,
438 .release = ecryptfs_release,
439 .fsync = ecryptfs_fsync,
440 .fasync = ecryptfs_fasync,
441 .sendfile = ecryptfs_sendfile,
442};
443
444static int
445ecryptfs_ioctl(struct inode *inode, struct file *file, unsigned int cmd,
446 unsigned long arg)
447{
448 int rc = 0;
449 struct file *lower_file = NULL;
450
451 if (ecryptfs_file_to_private(file))
452 lower_file = ecryptfs_file_to_lower(file);
453 if (lower_file && lower_file->f_op && lower_file->f_op->ioctl)
454 rc = lower_file->f_op->ioctl(ecryptfs_inode_to_lower(inode),
455 lower_file, cmd, arg);
456 else
457 rc = -ENOTTY;
458 return rc;
459}