2 * eCryptfs: Linux filesystem encryption layer
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. Thompsion <mcthomps@us.ibm.com>
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.
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.
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
26 #include <linux/file.h>
27 #include <linux/vmalloc.h>
28 #include <linux/pagemap.h>
29 #include <linux/dcache.h>
30 #include <linux/namei.h>
31 #include <linux/mount.h>
32 #include <linux/crypto.h>
33 #include <linux/fs_stack.h>
34 #include "ecryptfs_kernel.h"
36 static struct dentry
*lock_parent(struct dentry
*dentry
)
40 dir
= dget(dentry
->d_parent
);
41 mutex_lock_nested(&(dir
->d_inode
->i_mutex
), I_MUTEX_PARENT
);
45 static void unlock_parent(struct dentry
*dentry
)
47 mutex_unlock(&(dentry
->d_parent
->d_inode
->i_mutex
));
48 dput(dentry
->d_parent
);
51 static void unlock_dir(struct dentry
*dir
)
53 mutex_unlock(&dir
->d_inode
->i_mutex
);
58 * ecryptfs_create_underlying_file
59 * @lower_dir_inode: inode of the parent in the lower fs of the new file
60 * @lower_dentry: New file's dentry in the lower fs
61 * @ecryptfs_dentry: New file's dentry in ecryptfs
62 * @mode: The mode of the new file
63 * @nd: nameidata of ecryptfs' parent's dentry & vfsmount
65 * Creates the file in the lower file system.
67 * Returns zero on success; non-zero on error condition
70 ecryptfs_create_underlying_file(struct inode
*lower_dir_inode
,
71 struct dentry
*dentry
, int mode
,
74 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
75 struct vfsmount
*lower_mnt
= ecryptfs_dentry_to_lower_mnt(dentry
);
76 struct dentry
*dentry_save
;
77 struct vfsmount
*vfsmount_save
;
80 dentry_save
= nd
->dentry
;
81 vfsmount_save
= nd
->mnt
;
82 nd
->dentry
= lower_dentry
;
84 rc
= vfs_create(lower_dir_inode
, lower_dentry
, mode
, nd
);
85 nd
->dentry
= dentry_save
;
86 nd
->mnt
= vfsmount_save
;
92 * @directory_inode: inode of the new file's dentry's parent in ecryptfs
93 * @ecryptfs_dentry: New file's dentry in ecryptfs
94 * @mode: The mode of the new file
95 * @nd: nameidata of ecryptfs' parent's dentry & vfsmount
97 * Creates the underlying file and the eCryptfs inode which will link to
98 * it. It will also update the eCryptfs directory inode to mimic the
99 * stat of the lower directory inode.
101 * Returns zero on success; non-zero on error condition
104 ecryptfs_do_create(struct inode
*directory_inode
,
105 struct dentry
*ecryptfs_dentry
, int mode
,
106 struct nameidata
*nd
)
109 struct dentry
*lower_dentry
;
110 struct dentry
*lower_dir_dentry
;
112 lower_dentry
= ecryptfs_dentry_to_lower(ecryptfs_dentry
);
113 lower_dir_dentry
= lock_parent(lower_dentry
);
114 if (unlikely(IS_ERR(lower_dir_dentry
))) {
115 ecryptfs_printk(KERN_ERR
, "Error locking directory of "
117 rc
= PTR_ERR(lower_dir_dentry
);
120 rc
= ecryptfs_create_underlying_file(lower_dir_dentry
->d_inode
,
121 ecryptfs_dentry
, mode
, nd
);
123 ecryptfs_printk(KERN_ERR
,
124 "Failure to create underlying file\n");
127 rc
= ecryptfs_interpose(lower_dentry
, ecryptfs_dentry
,
128 directory_inode
->i_sb
, 0);
130 ecryptfs_printk(KERN_ERR
, "Failure in ecryptfs_interpose\n");
133 fsstack_copy_attr_times(directory_inode
, lower_dir_dentry
->d_inode
);
134 fsstack_copy_inode_size(directory_inode
, lower_dir_dentry
->d_inode
);
136 unlock_dir(lower_dir_dentry
);
143 * @ecryptfs_dentry: the ecryptfs dentry
144 * @lower_file: The lower file
145 * @inode: The ecryptfs inode
146 * @lower_inode: The lower inode
148 * This is the code which will grow the file to its correct size.
150 static int grow_file(struct dentry
*ecryptfs_dentry
, struct file
*lower_file
,
151 struct inode
*inode
, struct inode
*lower_inode
)
154 struct file fake_file
;
155 struct ecryptfs_file_info tmp_file_info
;
157 memset(&fake_file
, 0, sizeof(fake_file
));
158 fake_file
.f_path
.dentry
= ecryptfs_dentry
;
159 memset(&tmp_file_info
, 0, sizeof(tmp_file_info
));
160 ecryptfs_set_file_private(&fake_file
, &tmp_file_info
);
161 ecryptfs_set_file_lower(&fake_file
, lower_file
);
162 rc
= ecryptfs_fill_zeros(&fake_file
, 1);
164 ecryptfs_inode_to_private(inode
)->crypt_stat
.flags
|=
165 ECRYPTFS_SECURITY_WARNING
;
166 ecryptfs_printk(KERN_WARNING
, "Error attempting to fill zeros "
167 "in file; rc = [%d]\n", rc
);
170 i_size_write(inode
, 0);
171 rc
= ecryptfs_write_inode_size_to_metadata(lower_file
, lower_inode
,
172 inode
, ecryptfs_dentry
,
173 ECRYPTFS_LOWER_I_MUTEX_NOT_HELD
);
174 ecryptfs_inode_to_private(inode
)->crypt_stat
.flags
|= ECRYPTFS_NEW_FILE
;
180 * ecryptfs_initialize_file
182 * Cause the file to be changed from a basic empty file to an ecryptfs
183 * file with a header and first data page.
185 * Returns zero on success
187 static int ecryptfs_initialize_file(struct dentry
*ecryptfs_dentry
)
191 struct ecryptfs_crypt_stat
*crypt_stat
;
192 struct dentry
*lower_dentry
;
193 struct file
*lower_file
;
194 struct inode
*inode
, *lower_inode
;
195 struct vfsmount
*lower_mnt
;
197 lower_dentry
= ecryptfs_dentry_to_lower(ecryptfs_dentry
);
198 ecryptfs_printk(KERN_DEBUG
, "lower_dentry->d_name.name = [%s]\n",
199 lower_dentry
->d_name
.name
);
200 inode
= ecryptfs_dentry
->d_inode
;
201 crypt_stat
= &ecryptfs_inode_to_private(inode
)->crypt_stat
;
202 lower_flags
= ((O_CREAT
| O_TRUNC
) & O_ACCMODE
) | O_RDWR
;
203 lower_mnt
= ecryptfs_dentry_to_lower_mnt(ecryptfs_dentry
);
204 /* Corresponding fput() at end of this function */
205 if ((rc
= ecryptfs_open_lower_file(&lower_file
, lower_dentry
, lower_mnt
,
207 ecryptfs_printk(KERN_ERR
,
208 "Error opening dentry; rc = [%i]\n", rc
);
211 lower_inode
= lower_dentry
->d_inode
;
212 if (S_ISDIR(ecryptfs_dentry
->d_inode
->i_mode
)) {
213 ecryptfs_printk(KERN_DEBUG
, "This is a directory\n");
214 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
217 crypt_stat
->flags
|= ECRYPTFS_NEW_FILE
;
218 ecryptfs_printk(KERN_DEBUG
, "Initializing crypto context\n");
219 rc
= ecryptfs_new_file_context(ecryptfs_dentry
);
221 ecryptfs_printk(KERN_DEBUG
, "Error creating new file "
225 rc
= ecryptfs_write_metadata(ecryptfs_dentry
, lower_file
);
227 ecryptfs_printk(KERN_DEBUG
, "Error writing headers\n");
230 rc
= grow_file(ecryptfs_dentry
, lower_file
, inode
, lower_inode
);
232 if ((rc
= ecryptfs_close_lower_file(lower_file
)))
233 printk(KERN_ERR
"Error closing lower_file\n");
240 * @dir: The inode of the directory in which to create the file.
241 * @dentry: The eCryptfs dentry
242 * @mode: The mode of the new file.
245 * Creates a new file.
247 * Returns zero on success; non-zero on error condition
250 ecryptfs_create(struct inode
*directory_inode
, struct dentry
*ecryptfs_dentry
,
251 int mode
, struct nameidata
*nd
)
255 rc
= ecryptfs_do_create(directory_inode
, ecryptfs_dentry
, mode
, nd
);
257 ecryptfs_printk(KERN_WARNING
, "Failed to create file in"
258 "lower filesystem\n");
261 /* At this point, a file exists on "disk"; we need to make sure
262 * that this on disk file is prepared to be an ecryptfs file */
263 rc
= ecryptfs_initialize_file(ecryptfs_dentry
);
271 * @dentry: The dentry
272 * @nd: nameidata, may be NULL
274 * Find a file on disk. If the file does not exist, then we'll add it to the
275 * dentry cache and continue on to read it from the disk.
277 static struct dentry
*ecryptfs_lookup(struct inode
*dir
, struct dentry
*dentry
,
278 struct nameidata
*nd
)
281 struct dentry
*lower_dir_dentry
;
282 struct dentry
*lower_dentry
;
283 struct vfsmount
*lower_mnt
;
286 struct ecryptfs_crypt_stat
*crypt_stat
= NULL
;
287 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
288 char *page_virt
= NULL
;
289 struct inode
*lower_inode
;
292 lower_dir_dentry
= ecryptfs_dentry_to_lower(dentry
->d_parent
);
293 dentry
->d_op
= &ecryptfs_dops
;
294 if ((dentry
->d_name
.len
== 1 && !strcmp(dentry
->d_name
.name
, "."))
295 || (dentry
->d_name
.len
== 2
296 && !strcmp(dentry
->d_name
.name
, ".."))) {
300 encoded_namelen
= ecryptfs_encode_filename(crypt_stat
,
304 if (encoded_namelen
< 0) {
305 rc
= encoded_namelen
;
309 ecryptfs_printk(KERN_DEBUG
, "encoded_name = [%s]; encoded_namelen "
310 "= [%d]\n", encoded_name
, encoded_namelen
);
311 lower_dentry
= lookup_one_len(encoded_name
, lower_dir_dentry
,
312 encoded_namelen
- 1);
314 if (IS_ERR(lower_dentry
)) {
315 ecryptfs_printk(KERN_ERR
, "ERR from lower_dentry\n");
316 rc
= PTR_ERR(lower_dentry
);
320 lower_mnt
= mntget(ecryptfs_dentry_to_lower_mnt(dentry
->d_parent
));
321 ecryptfs_printk(KERN_DEBUG
, "lower_dentry = [%p]; lower_dentry->"
322 "d_name.name = [%s]\n", lower_dentry
,
323 lower_dentry
->d_name
.name
);
324 lower_inode
= lower_dentry
->d_inode
;
325 fsstack_copy_attr_atime(dir
, lower_dir_dentry
->d_inode
);
326 BUG_ON(!atomic_read(&lower_dentry
->d_count
));
327 ecryptfs_set_dentry_private(dentry
,
328 kmem_cache_alloc(ecryptfs_dentry_info_cache
,
330 if (!ecryptfs_dentry_to_private(dentry
)) {
332 ecryptfs_printk(KERN_ERR
, "Out of memory whilst attempting "
333 "to allocate ecryptfs_dentry_info struct\n");
336 ecryptfs_set_dentry_lower(dentry
, lower_dentry
);
337 ecryptfs_set_dentry_lower_mnt(dentry
, lower_mnt
);
338 if (!lower_dentry
->d_inode
) {
339 /* We want to add because we couldn't find in lower */
343 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
, 1);
345 ecryptfs_printk(KERN_ERR
, "Error interposing\n");
348 if (S_ISDIR(lower_inode
->i_mode
)) {
349 ecryptfs_printk(KERN_DEBUG
, "Is a directory; returning\n");
352 if (S_ISLNK(lower_inode
->i_mode
)) {
353 ecryptfs_printk(KERN_DEBUG
, "Is a symlink; returning\n");
356 if (special_file(lower_inode
->i_mode
)) {
357 ecryptfs_printk(KERN_DEBUG
, "Is a special file; returning\n");
361 ecryptfs_printk(KERN_DEBUG
, "We have a NULL nd, just leave"
362 "as we *think* we are about to unlink\n");
365 /* Released in this function */
366 page_virt
= kmem_cache_zalloc(ecryptfs_header_cache_2
,
370 ecryptfs_printk(KERN_ERR
,
371 "Cannot ecryptfs_kmalloc a page\n");
374 crypt_stat
= &ecryptfs_inode_to_private(dentry
->d_inode
)->crypt_stat
;
375 if (!(crypt_stat
->flags
& ECRYPTFS_POLICY_APPLIED
))
376 ecryptfs_set_default_sizes(crypt_stat
);
377 rc
= ecryptfs_read_and_validate_header_region(page_virt
, lower_dentry
,
380 rc
= ecryptfs_read_and_validate_xattr_region(page_virt
, dentry
);
382 printk(KERN_DEBUG
"Valid metadata not found in header "
383 "region or xattr region; treating file as "
386 kmem_cache_free(ecryptfs_header_cache_2
, page_virt
);
389 crypt_stat
->flags
|= ECRYPTFS_METADATA_IN_XATTR
;
391 mount_crypt_stat
= &ecryptfs_superblock_to_private(
392 dentry
->d_sb
)->mount_crypt_stat
;
393 if (mount_crypt_stat
->flags
& ECRYPTFS_ENCRYPTED_VIEW_ENABLED
) {
394 if (crypt_stat
->flags
& ECRYPTFS_METADATA_IN_XATTR
)
395 file_size
= (crypt_stat
->header_extent_size
396 + i_size_read(lower_dentry
->d_inode
));
398 file_size
= i_size_read(lower_dentry
->d_inode
);
400 memcpy(&file_size
, page_virt
, sizeof(file_size
));
401 file_size
= be64_to_cpu(file_size
);
403 i_size_write(dentry
->d_inode
, (loff_t
)file_size
);
404 kmem_cache_free(ecryptfs_header_cache_2
, page_virt
);
414 static int ecryptfs_link(struct dentry
*old_dentry
, struct inode
*dir
,
415 struct dentry
*new_dentry
)
417 struct dentry
*lower_old_dentry
;
418 struct dentry
*lower_new_dentry
;
419 struct dentry
*lower_dir_dentry
;
423 file_size_save
= i_size_read(old_dentry
->d_inode
);
424 lower_old_dentry
= ecryptfs_dentry_to_lower(old_dentry
);
425 lower_new_dentry
= ecryptfs_dentry_to_lower(new_dentry
);
426 dget(lower_old_dentry
);
427 dget(lower_new_dentry
);
428 lower_dir_dentry
= lock_parent(lower_new_dentry
);
429 rc
= vfs_link(lower_old_dentry
, lower_dir_dentry
->d_inode
,
431 if (rc
|| !lower_new_dentry
->d_inode
)
433 rc
= ecryptfs_interpose(lower_new_dentry
, new_dentry
, dir
->i_sb
, 0);
436 fsstack_copy_attr_times(dir
, lower_new_dentry
->d_inode
);
437 fsstack_copy_inode_size(dir
, lower_new_dentry
->d_inode
);
438 old_dentry
->d_inode
->i_nlink
=
439 ecryptfs_inode_to_lower(old_dentry
->d_inode
)->i_nlink
;
440 i_size_write(new_dentry
->d_inode
, file_size_save
);
442 unlock_dir(lower_dir_dentry
);
443 dput(lower_new_dentry
);
444 dput(lower_old_dentry
);
445 d_drop(lower_old_dentry
);
451 static int ecryptfs_unlink(struct inode
*dir
, struct dentry
*dentry
)
454 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
455 struct inode
*lower_dir_inode
= ecryptfs_inode_to_lower(dir
);
457 lock_parent(lower_dentry
);
458 rc
= vfs_unlink(lower_dir_inode
, lower_dentry
);
460 printk(KERN_ERR
"Error in vfs_unlink; rc = [%d]\n", rc
);
463 fsstack_copy_attr_times(dir
, lower_dir_inode
);
464 dentry
->d_inode
->i_nlink
=
465 ecryptfs_inode_to_lower(dentry
->d_inode
)->i_nlink
;
466 dentry
->d_inode
->i_ctime
= dir
->i_ctime
;
468 unlock_parent(lower_dentry
);
472 static int ecryptfs_symlink(struct inode
*dir
, struct dentry
*dentry
,
476 struct dentry
*lower_dentry
;
477 struct dentry
*lower_dir_dentry
;
479 char *encoded_symname
;
481 struct ecryptfs_crypt_stat
*crypt_stat
= NULL
;
483 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
485 lower_dir_dentry
= lock_parent(lower_dentry
);
487 encoded_symlen
= ecryptfs_encode_filename(crypt_stat
, symname
,
490 if (encoded_symlen
< 0) {
494 rc
= vfs_symlink(lower_dir_dentry
->d_inode
, lower_dentry
,
495 encoded_symname
, mode
);
496 kfree(encoded_symname
);
497 if (rc
|| !lower_dentry
->d_inode
)
499 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
, 0);
502 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
503 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
505 unlock_dir(lower_dir_dentry
);
507 if (!dentry
->d_inode
)
512 static int ecryptfs_mkdir(struct inode
*dir
, struct dentry
*dentry
, int mode
)
515 struct dentry
*lower_dentry
;
516 struct dentry
*lower_dir_dentry
;
518 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
519 lower_dir_dentry
= lock_parent(lower_dentry
);
520 rc
= vfs_mkdir(lower_dir_dentry
->d_inode
, lower_dentry
, mode
);
521 if (rc
|| !lower_dentry
->d_inode
)
523 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
, 0);
526 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
527 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
528 dir
->i_nlink
= lower_dir_dentry
->d_inode
->i_nlink
;
530 unlock_dir(lower_dir_dentry
);
531 if (!dentry
->d_inode
)
536 static int ecryptfs_rmdir(struct inode
*dir
, struct dentry
*dentry
)
538 struct dentry
*lower_dentry
;
539 struct dentry
*lower_dir_dentry
;
542 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
544 lower_dir_dentry
= lock_parent(lower_dentry
);
546 rc
= vfs_rmdir(lower_dir_dentry
->d_inode
, lower_dentry
);
549 d_delete(lower_dentry
);
550 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
551 dir
->i_nlink
= lower_dir_dentry
->d_inode
->i_nlink
;
552 unlock_dir(lower_dir_dentry
);
560 ecryptfs_mknod(struct inode
*dir
, struct dentry
*dentry
, int mode
, dev_t dev
)
563 struct dentry
*lower_dentry
;
564 struct dentry
*lower_dir_dentry
;
566 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
567 lower_dir_dentry
= lock_parent(lower_dentry
);
568 rc
= vfs_mknod(lower_dir_dentry
->d_inode
, lower_dentry
, mode
, dev
);
569 if (rc
|| !lower_dentry
->d_inode
)
571 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
, 0);
574 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
575 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
577 unlock_dir(lower_dir_dentry
);
578 if (!dentry
->d_inode
)
584 ecryptfs_rename(struct inode
*old_dir
, struct dentry
*old_dentry
,
585 struct inode
*new_dir
, struct dentry
*new_dentry
)
588 struct dentry
*lower_old_dentry
;
589 struct dentry
*lower_new_dentry
;
590 struct dentry
*lower_old_dir_dentry
;
591 struct dentry
*lower_new_dir_dentry
;
593 lower_old_dentry
= ecryptfs_dentry_to_lower(old_dentry
);
594 lower_new_dentry
= ecryptfs_dentry_to_lower(new_dentry
);
595 dget(lower_old_dentry
);
596 dget(lower_new_dentry
);
597 lower_old_dir_dentry
= dget_parent(lower_old_dentry
);
598 lower_new_dir_dentry
= dget_parent(lower_new_dentry
);
599 lock_rename(lower_old_dir_dentry
, lower_new_dir_dentry
);
600 rc
= vfs_rename(lower_old_dir_dentry
->d_inode
, lower_old_dentry
,
601 lower_new_dir_dentry
->d_inode
, lower_new_dentry
);
604 fsstack_copy_attr_all(new_dir
, lower_new_dir_dentry
->d_inode
, NULL
);
605 if (new_dir
!= old_dir
)
606 fsstack_copy_attr_all(old_dir
, lower_old_dir_dentry
->d_inode
, NULL
);
608 unlock_rename(lower_old_dir_dentry
, lower_new_dir_dentry
);
609 dput(lower_new_dentry
->d_parent
);
610 dput(lower_old_dentry
->d_parent
);
611 dput(lower_new_dentry
);
612 dput(lower_old_dentry
);
617 ecryptfs_readlink(struct dentry
*dentry
, char __user
* buf
, int bufsiz
)
620 struct dentry
*lower_dentry
;
624 struct ecryptfs_crypt_stat
*crypt_stat
;
626 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
627 if (!lower_dentry
->d_inode
->i_op
||
628 !lower_dentry
->d_inode
->i_op
->readlink
) {
632 /* Released in this function */
633 lower_buf
= kmalloc(bufsiz
, GFP_KERNEL
);
634 if (lower_buf
== NULL
) {
635 ecryptfs_printk(KERN_ERR
, "Out of memory\n");
641 ecryptfs_printk(KERN_DEBUG
, "Calling readlink w/ "
642 "lower_dentry->d_name.name = [%s]\n",
643 lower_dentry
->d_name
.name
);
644 rc
= lower_dentry
->d_inode
->i_op
->readlink(lower_dentry
,
645 (char __user
*)lower_buf
,
650 rc
= ecryptfs_decode_filename(crypt_stat
, lower_buf
, rc
,
653 goto out_free_lower_buf
;
655 ecryptfs_printk(KERN_DEBUG
, "Copying [%d] bytes "
656 "to userspace: [%*s]\n", rc
,
658 if (copy_to_user(buf
, decoded_name
, rc
))
662 fsstack_copy_attr_atime(dentry
->d_inode
,
663 lower_dentry
->d_inode
);
671 static void *ecryptfs_follow_link(struct dentry
*dentry
, struct nameidata
*nd
)
674 int len
= PAGE_SIZE
, rc
;
677 /* Released in ecryptfs_put_link(); only release here on error */
678 buf
= kmalloc(len
, GFP_KERNEL
);
685 ecryptfs_printk(KERN_DEBUG
, "Calling readlink w/ "
686 "dentry->d_name.name = [%s]\n", dentry
->d_name
.name
);
687 rc
= dentry
->d_inode
->i_op
->readlink(dentry
, (char __user
*)buf
, len
);
693 nd_set_link(nd
, buf
);
702 ecryptfs_put_link(struct dentry
*dentry
, struct nameidata
*nd
, void *ptr
)
705 kfree(nd_get_link(nd
));
709 * upper_size_to_lower_size
710 * @crypt_stat: Crypt_stat associated with file
711 * @upper_size: Size of the upper file
713 * Calculate the requried size of the lower file based on the
714 * specified size of the upper file. This calculation is based on the
715 * number of headers in the underlying file and the extent size.
717 * Returns Calculated size of the lower file.
720 upper_size_to_lower_size(struct ecryptfs_crypt_stat
*crypt_stat
,
725 lower_size
= ( crypt_stat
->header_extent_size
726 * crypt_stat
->num_header_extents_at_front
);
727 if (upper_size
!= 0) {
730 num_extents
= upper_size
>> crypt_stat
->extent_shift
;
731 if (upper_size
& ~crypt_stat
->extent_mask
)
733 lower_size
+= (num_extents
* crypt_stat
->extent_size
);
740 * @dentry: The ecryptfs layer dentry
741 * @new_length: The length to expand the file to
743 * Function to handle truncations modifying the size of the file. Note
744 * that the file sizes are interpolated. When expanding, we are simply
745 * writing strings of 0's out. When truncating, we need to modify the
746 * underlying file size according to the page index interpolations.
748 * Returns zero on success; non-zero otherwise
750 int ecryptfs_truncate(struct dentry
*dentry
, loff_t new_length
)
753 struct inode
*inode
= dentry
->d_inode
;
754 struct dentry
*lower_dentry
;
755 struct vfsmount
*lower_mnt
;
756 struct file fake_ecryptfs_file
, *lower_file
= NULL
;
757 struct ecryptfs_crypt_stat
*crypt_stat
;
758 loff_t i_size
= i_size_read(inode
);
759 loff_t lower_size_before_truncate
;
760 loff_t lower_size_after_truncate
;
762 if (unlikely((new_length
== i_size
)))
764 crypt_stat
= &ecryptfs_inode_to_private(dentry
->d_inode
)->crypt_stat
;
765 /* Set up a fake ecryptfs file, this is used to interface with
766 * the file in the underlying filesystem so that the
767 * truncation has an effect there as well. */
768 memset(&fake_ecryptfs_file
, 0, sizeof(fake_ecryptfs_file
));
769 fake_ecryptfs_file
.f_path
.dentry
= dentry
;
770 /* Released at out_free: label */
771 ecryptfs_set_file_private(&fake_ecryptfs_file
,
772 kmem_cache_alloc(ecryptfs_file_info_cache
,
774 if (unlikely(!ecryptfs_file_to_private(&fake_ecryptfs_file
))) {
778 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
779 /* This dget & mntget is released through fput at out_fput: */
780 lower_mnt
= ecryptfs_dentry_to_lower_mnt(dentry
);
781 if ((rc
= ecryptfs_open_lower_file(&lower_file
, lower_dentry
, lower_mnt
,
783 ecryptfs_printk(KERN_ERR
,
784 "Error opening dentry; rc = [%i]\n", rc
);
787 ecryptfs_set_file_lower(&fake_ecryptfs_file
, lower_file
);
788 /* Switch on growing or shrinking file */
789 if (new_length
> i_size
) {
790 rc
= ecryptfs_fill_zeros(&fake_ecryptfs_file
, new_length
);
792 ecryptfs_printk(KERN_ERR
,
793 "Problem with fill_zeros\n");
796 i_size_write(inode
, new_length
);
797 rc
= ecryptfs_write_inode_size_to_metadata(
798 lower_file
, lower_dentry
->d_inode
, inode
, dentry
,
799 ECRYPTFS_LOWER_I_MUTEX_NOT_HELD
);
801 printk(KERN_ERR
"Problem with "
802 "ecryptfs_write_inode_size_to_metadata; "
806 } else { /* new_length < i_size_read(inode) */
808 int end_pos_in_page
= -1;
810 if (new_length
!= 0) {
811 index
= ((new_length
- 1) >> PAGE_CACHE_SHIFT
);
812 end_pos_in_page
= ((new_length
- 1) & ~PAGE_CACHE_MASK
);
814 if (end_pos_in_page
!= (PAGE_CACHE_SIZE
- 1)) {
815 if ((rc
= ecryptfs_write_zeros(&fake_ecryptfs_file
,
817 (end_pos_in_page
+ 1),
818 ((PAGE_CACHE_SIZE
- 1)
819 - end_pos_in_page
)))) {
820 printk(KERN_ERR
"Error attempting to zero out "
821 "the remainder of the end page on "
822 "reducing truncate; rc = [%d]\n", rc
);
826 vmtruncate(inode
, new_length
);
827 rc
= ecryptfs_write_inode_size_to_metadata(
828 lower_file
, lower_dentry
->d_inode
, inode
, dentry
,
829 ECRYPTFS_LOWER_I_MUTEX_NOT_HELD
);
831 printk(KERN_ERR
"Problem with "
832 "ecryptfs_write_inode_size_to_metadata; "
836 /* We are reducing the size of the ecryptfs file, and need to
837 * know if we need to reduce the size of the lower file. */
838 lower_size_before_truncate
=
839 upper_size_to_lower_size(crypt_stat
, i_size
);
840 lower_size_after_truncate
=
841 upper_size_to_lower_size(crypt_stat
, new_length
);
842 if (lower_size_after_truncate
< lower_size_before_truncate
)
843 vmtruncate(lower_dentry
->d_inode
,
844 lower_size_after_truncate
);
846 /* Update the access times */
847 lower_dentry
->d_inode
->i_mtime
= lower_dentry
->d_inode
->i_ctime
849 mark_inode_dirty_sync(inode
);
851 if ((rc
= ecryptfs_close_lower_file(lower_file
)))
852 printk(KERN_ERR
"Error closing lower_file\n");
854 if (ecryptfs_file_to_private(&fake_ecryptfs_file
))
855 kmem_cache_free(ecryptfs_file_info_cache
,
856 ecryptfs_file_to_private(&fake_ecryptfs_file
));
862 ecryptfs_permission(struct inode
*inode
, int mask
, struct nameidata
*nd
)
867 struct vfsmount
*vfsmnt_save
= nd
->mnt
;
868 struct dentry
*dentry_save
= nd
->dentry
;
870 nd
->mnt
= ecryptfs_dentry_to_lower_mnt(nd
->dentry
);
871 nd
->dentry
= ecryptfs_dentry_to_lower(nd
->dentry
);
872 rc
= permission(ecryptfs_inode_to_lower(inode
), mask
, nd
);
873 nd
->mnt
= vfsmnt_save
;
874 nd
->dentry
= dentry_save
;
876 rc
= permission(ecryptfs_inode_to_lower(inode
), mask
, NULL
);
882 * @dentry: dentry handle to the inode to modify
883 * @ia: Structure with flags of what to change and values
885 * Updates the metadata of an inode. If the update is to the size
886 * i.e. truncation, then ecryptfs_truncate will handle the size modification
887 * of both the ecryptfs inode and the lower inode.
889 * All other metadata changes will be passed right to the lower filesystem,
890 * and we will just update our inode to look like the lower.
892 static int ecryptfs_setattr(struct dentry
*dentry
, struct iattr
*ia
)
895 struct dentry
*lower_dentry
;
897 struct inode
*lower_inode
;
898 struct ecryptfs_crypt_stat
*crypt_stat
;
900 crypt_stat
= &ecryptfs_inode_to_private(dentry
->d_inode
)->crypt_stat
;
901 if (!(crypt_stat
->flags
& ECRYPTFS_STRUCT_INITIALIZED
))
902 ecryptfs_init_crypt_stat(crypt_stat
);
903 inode
= dentry
->d_inode
;
904 lower_inode
= ecryptfs_inode_to_lower(inode
);
905 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
906 mutex_lock(&crypt_stat
->cs_mutex
);
907 if (S_ISDIR(dentry
->d_inode
->i_mode
))
908 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
909 else if (S_ISREG(dentry
->d_inode
->i_mode
)
910 && (!(crypt_stat
->flags
& ECRYPTFS_POLICY_APPLIED
)
911 || !(crypt_stat
->flags
& ECRYPTFS_KEY_VALID
))) {
912 struct vfsmount
*lower_mnt
;
913 struct file
*lower_file
= NULL
;
914 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
917 lower_mnt
= ecryptfs_dentry_to_lower_mnt(dentry
);
918 lower_flags
= O_RDONLY
;
919 if ((rc
= ecryptfs_open_lower_file(&lower_file
, lower_dentry
,
920 lower_mnt
, lower_flags
))) {
922 "Error opening lower file; rc = [%d]\n", rc
);
923 mutex_unlock(&crypt_stat
->cs_mutex
);
926 mount_crypt_stat
= &ecryptfs_superblock_to_private(
927 dentry
->d_sb
)->mount_crypt_stat
;
928 if ((rc
= ecryptfs_read_metadata(dentry
, lower_file
))) {
929 if (!(mount_crypt_stat
->flags
930 & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED
)) {
932 printk(KERN_WARNING
"Attempt to read file that "
933 "is not in a valid eCryptfs format, "
934 "and plaintext passthrough mode is not "
935 "enabled; returning -EIO\n");
937 mutex_unlock(&crypt_stat
->cs_mutex
);
942 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
943 mutex_unlock(&crypt_stat
->cs_mutex
);
949 mutex_unlock(&crypt_stat
->cs_mutex
);
950 if (ia
->ia_valid
& ATTR_SIZE
) {
951 ecryptfs_printk(KERN_DEBUG
,
952 "ia->ia_valid = [0x%x] ATTR_SIZE" " = [0x%x]\n",
953 ia
->ia_valid
, ATTR_SIZE
);
954 rc
= ecryptfs_truncate(dentry
, ia
->ia_size
);
955 /* ecryptfs_truncate handles resizing of the lower file */
956 ia
->ia_valid
&= ~ATTR_SIZE
;
957 ecryptfs_printk(KERN_DEBUG
, "ia->ia_valid = [%x]\n",
962 rc
= notify_change(lower_dentry
, ia
);
964 fsstack_copy_attr_all(inode
, lower_inode
, NULL
);
969 ecryptfs_setxattr(struct dentry
*dentry
, const char *name
, const void *value
,
970 size_t size
, int flags
)
973 struct dentry
*lower_dentry
;
975 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
976 if (!lower_dentry
->d_inode
->i_op
->setxattr
) {
980 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
981 rc
= lower_dentry
->d_inode
->i_op
->setxattr(lower_dentry
, name
, value
,
983 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
989 ecryptfs_getxattr(struct dentry
*dentry
, const char *name
, void *value
,
993 struct dentry
*lower_dentry
;
995 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
996 if (!lower_dentry
->d_inode
->i_op
->getxattr
) {
1000 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1001 rc
= lower_dentry
->d_inode
->i_op
->getxattr(lower_dentry
, name
, value
,
1003 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1009 ecryptfs_listxattr(struct dentry
*dentry
, char *list
, size_t size
)
1012 struct dentry
*lower_dentry
;
1014 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1015 if (!lower_dentry
->d_inode
->i_op
->listxattr
) {
1019 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1020 rc
= lower_dentry
->d_inode
->i_op
->listxattr(lower_dentry
, list
, size
);
1021 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1026 static int ecryptfs_removexattr(struct dentry
*dentry
, const char *name
)
1029 struct dentry
*lower_dentry
;
1031 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1032 if (!lower_dentry
->d_inode
->i_op
->removexattr
) {
1036 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1037 rc
= lower_dentry
->d_inode
->i_op
->removexattr(lower_dentry
, name
);
1038 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1043 int ecryptfs_inode_test(struct inode
*inode
, void *candidate_lower_inode
)
1045 if ((ecryptfs_inode_to_lower(inode
)
1046 == (struct inode
*)candidate_lower_inode
))
1052 int ecryptfs_inode_set(struct inode
*inode
, void *lower_inode
)
1054 ecryptfs_init_inode(inode
, (struct inode
*)lower_inode
);
1058 const struct inode_operations ecryptfs_symlink_iops
= {
1059 .readlink
= ecryptfs_readlink
,
1060 .follow_link
= ecryptfs_follow_link
,
1061 .put_link
= ecryptfs_put_link
,
1062 .permission
= ecryptfs_permission
,
1063 .setattr
= ecryptfs_setattr
,
1064 .setxattr
= ecryptfs_setxattr
,
1065 .getxattr
= ecryptfs_getxattr
,
1066 .listxattr
= ecryptfs_listxattr
,
1067 .removexattr
= ecryptfs_removexattr
1070 const struct inode_operations ecryptfs_dir_iops
= {
1071 .create
= ecryptfs_create
,
1072 .lookup
= ecryptfs_lookup
,
1073 .link
= ecryptfs_link
,
1074 .unlink
= ecryptfs_unlink
,
1075 .symlink
= ecryptfs_symlink
,
1076 .mkdir
= ecryptfs_mkdir
,
1077 .rmdir
= ecryptfs_rmdir
,
1078 .mknod
= ecryptfs_mknod
,
1079 .rename
= ecryptfs_rename
,
1080 .permission
= ecryptfs_permission
,
1081 .setattr
= ecryptfs_setattr
,
1082 .setxattr
= ecryptfs_setxattr
,
1083 .getxattr
= ecryptfs_getxattr
,
1084 .listxattr
= ecryptfs_listxattr
,
1085 .removexattr
= ecryptfs_removexattr
1088 const struct inode_operations ecryptfs_main_iops
= {
1089 .permission
= ecryptfs_permission
,
1090 .setattr
= ecryptfs_setattr
,
1091 .setxattr
= ecryptfs_setxattr
,
1092 .getxattr
= ecryptfs_getxattr
,
1093 .listxattr
= ecryptfs_listxattr
,
1094 .removexattr
= ecryptfs_removexattr