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 <linux/slab.h>
35 #include <linux/xattr.h>
36 #include <asm/unaligned.h>
37 #include "ecryptfs_kernel.h"
39 static struct dentry
*lock_parent(struct dentry
*dentry
)
43 dir
= dget_parent(dentry
);
44 mutex_lock_nested(&(dir
->d_inode
->i_mutex
), I_MUTEX_PARENT
);
48 static void unlock_dir(struct dentry
*dir
)
50 mutex_unlock(&dir
->d_inode
->i_mutex
);
55 * ecryptfs_create_underlying_file
56 * @lower_dir_inode: inode of the parent in the lower fs of the new file
57 * @dentry: New file's dentry
58 * @mode: The mode of the new file
59 * @nd: nameidata of ecryptfs' parent's dentry & vfsmount
61 * Creates the file in the lower file system.
63 * Returns zero on success; non-zero on error condition
66 ecryptfs_create_underlying_file(struct inode
*lower_dir_inode
,
67 struct dentry
*dentry
, int mode
,
70 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
71 struct vfsmount
*lower_mnt
= ecryptfs_dentry_to_lower_mnt(dentry
);
72 struct dentry
*dentry_save
;
73 struct vfsmount
*vfsmount_save
;
74 unsigned int flags_save
;
78 dentry_save
= nd
->path
.dentry
;
79 vfsmount_save
= nd
->path
.mnt
;
80 flags_save
= nd
->flags
;
81 nd
->path
.dentry
= lower_dentry
;
82 nd
->path
.mnt
= lower_mnt
;
83 nd
->flags
&= ~LOOKUP_OPEN
;
85 rc
= vfs_create(lower_dir_inode
, lower_dentry
, mode
, nd
);
87 nd
->path
.dentry
= dentry_save
;
88 nd
->path
.mnt
= vfsmount_save
;
89 nd
->flags
= flags_save
;
96 * @directory_inode: inode of the new file's dentry's parent in ecryptfs
97 * @ecryptfs_dentry: New file's dentry in ecryptfs
98 * @mode: The mode of the new file
99 * @nd: nameidata of ecryptfs' parent's dentry & vfsmount
101 * Creates the underlying file and the eCryptfs inode which will link to
102 * it. It will also update the eCryptfs directory inode to mimic the
103 * stat of the lower directory inode.
105 * Returns zero on success; non-zero on error condition
108 ecryptfs_do_create(struct inode
*directory_inode
,
109 struct dentry
*ecryptfs_dentry
, int mode
,
110 struct nameidata
*nd
)
113 struct dentry
*lower_dentry
;
114 struct dentry
*lower_dir_dentry
;
116 lower_dentry
= ecryptfs_dentry_to_lower(ecryptfs_dentry
);
117 lower_dir_dentry
= lock_parent(lower_dentry
);
118 if (IS_ERR(lower_dir_dentry
)) {
119 ecryptfs_printk(KERN_ERR
, "Error locking directory of "
121 rc
= PTR_ERR(lower_dir_dentry
);
124 rc
= ecryptfs_create_underlying_file(lower_dir_dentry
->d_inode
,
125 ecryptfs_dentry
, mode
, nd
);
127 printk(KERN_ERR
"%s: Failure to create dentry in lower fs; "
128 "rc = [%d]\n", __func__
, rc
);
131 rc
= ecryptfs_interpose(lower_dentry
, ecryptfs_dentry
,
132 directory_inode
->i_sb
, 0);
134 ecryptfs_printk(KERN_ERR
, "Failure in ecryptfs_interpose\n");
137 fsstack_copy_attr_times(directory_inode
, lower_dir_dentry
->d_inode
);
138 fsstack_copy_inode_size(directory_inode
, lower_dir_dentry
->d_inode
);
140 unlock_dir(lower_dir_dentry
);
146 * ecryptfs_initialize_file
148 * Cause the file to be changed from a basic empty file to an ecryptfs
149 * file with a header and first data page.
151 * Returns zero on success
153 static int ecryptfs_initialize_file(struct dentry
*ecryptfs_dentry
)
155 struct ecryptfs_crypt_stat
*crypt_stat
=
156 &ecryptfs_inode_to_private(ecryptfs_dentry
->d_inode
)->crypt_stat
;
159 if (S_ISDIR(ecryptfs_dentry
->d_inode
->i_mode
)) {
160 ecryptfs_printk(KERN_DEBUG
, "This is a directory\n");
161 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
164 crypt_stat
->flags
|= ECRYPTFS_NEW_FILE
;
165 ecryptfs_printk(KERN_DEBUG
, "Initializing crypto context\n");
166 rc
= ecryptfs_new_file_context(ecryptfs_dentry
);
168 ecryptfs_printk(KERN_ERR
, "Error creating new file "
169 "context; rc = [%d]\n", rc
);
172 rc
= ecryptfs_init_persistent_file(ecryptfs_dentry
);
174 printk(KERN_ERR
"%s: Error attempting to initialize "
175 "the persistent file for the dentry with name "
176 "[%s]; rc = [%d]\n", __func__
,
177 ecryptfs_dentry
->d_name
.name
, rc
);
180 rc
= ecryptfs_write_metadata(ecryptfs_dentry
);
182 printk(KERN_ERR
"Error writing headers; rc = [%d]\n", rc
);
191 * @dir: The inode of the directory in which to create the file.
192 * @dentry: The eCryptfs dentry
193 * @mode: The mode of the new file.
196 * Creates a new file.
198 * Returns zero on success; non-zero on error condition
201 ecryptfs_create(struct inode
*directory_inode
, struct dentry
*ecryptfs_dentry
,
202 int mode
, struct nameidata
*nd
)
206 /* ecryptfs_do_create() calls ecryptfs_interpose() */
207 rc
= ecryptfs_do_create(directory_inode
, ecryptfs_dentry
, mode
, nd
);
209 ecryptfs_printk(KERN_WARNING
, "Failed to create file in"
210 "lower filesystem\n");
213 /* At this point, a file exists on "disk"; we need to make sure
214 * that this on disk file is prepared to be an ecryptfs file */
215 rc
= ecryptfs_initialize_file(ecryptfs_dentry
);
221 * ecryptfs_lookup_and_interpose_lower - Perform a lookup
223 int ecryptfs_lookup_and_interpose_lower(struct dentry
*ecryptfs_dentry
,
224 struct dentry
*lower_dentry
,
225 struct inode
*ecryptfs_dir_inode
)
227 struct dentry
*lower_dir_dentry
;
228 struct vfsmount
*lower_mnt
;
229 struct inode
*lower_inode
;
230 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
231 struct ecryptfs_crypt_stat
*crypt_stat
;
232 char *page_virt
= NULL
;
236 lower_dir_dentry
= lower_dentry
->d_parent
;
237 lower_mnt
= mntget(ecryptfs_dentry_to_lower_mnt(
238 ecryptfs_dentry
->d_parent
));
239 lower_inode
= lower_dentry
->d_inode
;
240 fsstack_copy_attr_atime(ecryptfs_dir_inode
, lower_dir_dentry
->d_inode
);
241 BUG_ON(!lower_dentry
->d_count
);
242 ecryptfs_set_dentry_private(ecryptfs_dentry
,
243 kmem_cache_alloc(ecryptfs_dentry_info_cache
,
245 if (!ecryptfs_dentry_to_private(ecryptfs_dentry
)) {
247 printk(KERN_ERR
"%s: Out of memory whilst attempting "
248 "to allocate ecryptfs_dentry_info struct\n",
252 ecryptfs_set_dentry_lower(ecryptfs_dentry
, lower_dentry
);
253 ecryptfs_set_dentry_lower_mnt(ecryptfs_dentry
, lower_mnt
);
254 if (!lower_dentry
->d_inode
) {
255 /* We want to add because we couldn't find in lower */
256 d_add(ecryptfs_dentry
, NULL
);
259 rc
= ecryptfs_interpose(lower_dentry
, ecryptfs_dentry
,
260 ecryptfs_dir_inode
->i_sb
,
261 ECRYPTFS_INTERPOSE_FLAG_D_ADD
);
263 printk(KERN_ERR
"%s: Error interposing; rc = [%d]\n",
267 if (S_ISDIR(lower_inode
->i_mode
))
269 if (S_ISLNK(lower_inode
->i_mode
))
271 if (special_file(lower_inode
->i_mode
))
273 /* Released in this function */
274 page_virt
= kmem_cache_zalloc(ecryptfs_header_cache_2
, GFP_USER
);
276 printk(KERN_ERR
"%s: Cannot kmem_cache_zalloc() a page\n",
281 rc
= ecryptfs_init_persistent_file(ecryptfs_dentry
);
283 printk(KERN_ERR
"%s: Error attempting to initialize "
284 "the persistent file for the dentry with name "
285 "[%s]; rc = [%d]\n", __func__
,
286 ecryptfs_dentry
->d_name
.name
, rc
);
289 crypt_stat
= &ecryptfs_inode_to_private(
290 ecryptfs_dentry
->d_inode
)->crypt_stat
;
291 /* TODO: lock for crypt_stat comparison */
292 if (!(crypt_stat
->flags
& ECRYPTFS_POLICY_APPLIED
))
293 ecryptfs_set_default_sizes(crypt_stat
);
294 rc
= ecryptfs_read_and_validate_header_region(page_virt
,
295 ecryptfs_dentry
->d_inode
);
297 memset(page_virt
, 0, PAGE_CACHE_SIZE
);
298 rc
= ecryptfs_read_and_validate_xattr_region(page_virt
,
304 crypt_stat
->flags
|= ECRYPTFS_METADATA_IN_XATTR
;
306 mount_crypt_stat
= &ecryptfs_superblock_to_private(
307 ecryptfs_dentry
->d_sb
)->mount_crypt_stat
;
308 if (mount_crypt_stat
->flags
& ECRYPTFS_ENCRYPTED_VIEW_ENABLED
) {
309 if (crypt_stat
->flags
& ECRYPTFS_METADATA_IN_XATTR
)
310 file_size
= (crypt_stat
->metadata_size
311 + i_size_read(lower_dentry
->d_inode
));
313 file_size
= i_size_read(lower_dentry
->d_inode
);
315 file_size
= get_unaligned_be64(page_virt
);
317 i_size_write(ecryptfs_dentry
->d_inode
, (loff_t
)file_size
);
319 kmem_cache_free(ecryptfs_header_cache_2
, page_virt
);
324 d_drop(ecryptfs_dentry
);
331 * @ecryptfs_dir_inode: The eCryptfs directory inode
332 * @ecryptfs_dentry: The eCryptfs dentry that we are looking up
333 * @ecryptfs_nd: nameidata; may be NULL
335 * Find a file on disk. If the file does not exist, then we'll add it to the
336 * dentry cache and continue on to read it from the disk.
338 static struct dentry
*ecryptfs_lookup(struct inode
*ecryptfs_dir_inode
,
339 struct dentry
*ecryptfs_dentry
,
340 struct nameidata
*ecryptfs_nd
)
342 char *encrypted_and_encoded_name
= NULL
;
343 size_t encrypted_and_encoded_name_size
;
344 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
= NULL
;
345 struct dentry
*lower_dir_dentry
, *lower_dentry
;
348 if ((ecryptfs_dentry
->d_name
.len
== 1
349 && !strcmp(ecryptfs_dentry
->d_name
.name
, "."))
350 || (ecryptfs_dentry
->d_name
.len
== 2
351 && !strcmp(ecryptfs_dentry
->d_name
.name
, ".."))) {
354 lower_dir_dentry
= ecryptfs_dentry_to_lower(ecryptfs_dentry
->d_parent
);
355 mutex_lock(&lower_dir_dentry
->d_inode
->i_mutex
);
356 lower_dentry
= lookup_one_len(ecryptfs_dentry
->d_name
.name
,
358 ecryptfs_dentry
->d_name
.len
);
359 mutex_unlock(&lower_dir_dentry
->d_inode
->i_mutex
);
360 if (IS_ERR(lower_dentry
)) {
361 rc
= PTR_ERR(lower_dentry
);
362 ecryptfs_printk(KERN_DEBUG
, "%s: lookup_one_len() returned "
363 "[%d] on lower_dentry = [%s]\n", __func__
, rc
,
364 encrypted_and_encoded_name
);
367 if (lower_dentry
->d_inode
)
368 goto lookup_and_interpose
;
369 mount_crypt_stat
= &ecryptfs_superblock_to_private(
370 ecryptfs_dentry
->d_sb
)->mount_crypt_stat
;
371 if (!(mount_crypt_stat
372 && (mount_crypt_stat
->flags
& ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES
)))
373 goto lookup_and_interpose
;
375 rc
= ecryptfs_encrypt_and_encode_filename(
376 &encrypted_and_encoded_name
, &encrypted_and_encoded_name_size
,
377 NULL
, mount_crypt_stat
, ecryptfs_dentry
->d_name
.name
,
378 ecryptfs_dentry
->d_name
.len
);
380 printk(KERN_ERR
"%s: Error attempting to encrypt and encode "
381 "filename; rc = [%d]\n", __func__
, rc
);
384 mutex_lock(&lower_dir_dentry
->d_inode
->i_mutex
);
385 lower_dentry
= lookup_one_len(encrypted_and_encoded_name
,
387 encrypted_and_encoded_name_size
);
388 mutex_unlock(&lower_dir_dentry
->d_inode
->i_mutex
);
389 if (IS_ERR(lower_dentry
)) {
390 rc
= PTR_ERR(lower_dentry
);
391 ecryptfs_printk(KERN_DEBUG
, "%s: lookup_one_len() returned "
392 "[%d] on lower_dentry = [%s]\n", __func__
, rc
,
393 encrypted_and_encoded_name
);
396 lookup_and_interpose
:
397 rc
= ecryptfs_lookup_and_interpose_lower(ecryptfs_dentry
, lower_dentry
,
401 d_drop(ecryptfs_dentry
);
403 kfree(encrypted_and_encoded_name
);
407 static int ecryptfs_link(struct dentry
*old_dentry
, struct inode
*dir
,
408 struct dentry
*new_dentry
)
410 struct dentry
*lower_old_dentry
;
411 struct dentry
*lower_new_dentry
;
412 struct dentry
*lower_dir_dentry
;
416 file_size_save
= i_size_read(old_dentry
->d_inode
);
417 lower_old_dentry
= ecryptfs_dentry_to_lower(old_dentry
);
418 lower_new_dentry
= ecryptfs_dentry_to_lower(new_dentry
);
419 dget(lower_old_dentry
);
420 dget(lower_new_dentry
);
421 lower_dir_dentry
= lock_parent(lower_new_dentry
);
422 rc
= vfs_link(lower_old_dentry
, lower_dir_dentry
->d_inode
,
424 if (rc
|| !lower_new_dentry
->d_inode
)
426 rc
= ecryptfs_interpose(lower_new_dentry
, new_dentry
, dir
->i_sb
, 0);
429 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
430 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
431 old_dentry
->d_inode
->i_nlink
=
432 ecryptfs_inode_to_lower(old_dentry
->d_inode
)->i_nlink
;
433 i_size_write(new_dentry
->d_inode
, file_size_save
);
435 unlock_dir(lower_dir_dentry
);
436 dput(lower_new_dentry
);
437 dput(lower_old_dentry
);
441 static int ecryptfs_unlink(struct inode
*dir
, struct dentry
*dentry
)
444 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
445 struct inode
*lower_dir_inode
= ecryptfs_inode_to_lower(dir
);
446 struct dentry
*lower_dir_dentry
;
449 lower_dir_dentry
= lock_parent(lower_dentry
);
450 rc
= vfs_unlink(lower_dir_inode
, lower_dentry
);
452 printk(KERN_ERR
"Error in vfs_unlink; rc = [%d]\n", rc
);
455 fsstack_copy_attr_times(dir
, lower_dir_inode
);
456 dentry
->d_inode
->i_nlink
=
457 ecryptfs_inode_to_lower(dentry
->d_inode
)->i_nlink
;
458 dentry
->d_inode
->i_ctime
= dir
->i_ctime
;
461 unlock_dir(lower_dir_dentry
);
466 static int ecryptfs_symlink(struct inode
*dir
, struct dentry
*dentry
,
470 struct dentry
*lower_dentry
;
471 struct dentry
*lower_dir_dentry
;
472 char *encoded_symname
;
473 size_t encoded_symlen
;
474 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
= NULL
;
476 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
478 lower_dir_dentry
= lock_parent(lower_dentry
);
479 mount_crypt_stat
= &ecryptfs_superblock_to_private(
480 dir
->i_sb
)->mount_crypt_stat
;
481 rc
= ecryptfs_encrypt_and_encode_filename(&encoded_symname
,
484 mount_crypt_stat
, symname
,
488 rc
= vfs_symlink(lower_dir_dentry
->d_inode
, lower_dentry
,
490 kfree(encoded_symname
);
491 if (rc
|| !lower_dentry
->d_inode
)
493 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
, 0);
496 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
497 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
499 unlock_dir(lower_dir_dentry
);
501 if (!dentry
->d_inode
)
506 static int ecryptfs_mkdir(struct inode
*dir
, struct dentry
*dentry
, int mode
)
509 struct dentry
*lower_dentry
;
510 struct dentry
*lower_dir_dentry
;
512 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
513 lower_dir_dentry
= lock_parent(lower_dentry
);
514 rc
= vfs_mkdir(lower_dir_dentry
->d_inode
, lower_dentry
, mode
);
515 if (rc
|| !lower_dentry
->d_inode
)
517 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
, 0);
520 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
521 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
522 dir
->i_nlink
= lower_dir_dentry
->d_inode
->i_nlink
;
524 unlock_dir(lower_dir_dentry
);
525 if (!dentry
->d_inode
)
530 static int ecryptfs_rmdir(struct inode
*dir
, struct dentry
*dentry
)
532 struct dentry
*lower_dentry
;
533 struct dentry
*lower_dir_dentry
;
536 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
538 lower_dir_dentry
= lock_parent(lower_dentry
);
540 rc
= vfs_rmdir(lower_dir_dentry
->d_inode
, lower_dentry
);
543 d_delete(lower_dentry
);
544 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
545 dir
->i_nlink
= lower_dir_dentry
->d_inode
->i_nlink
;
546 unlock_dir(lower_dir_dentry
);
554 ecryptfs_mknod(struct inode
*dir
, struct dentry
*dentry
, int mode
, dev_t dev
)
557 struct dentry
*lower_dentry
;
558 struct dentry
*lower_dir_dentry
;
560 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
561 lower_dir_dentry
= lock_parent(lower_dentry
);
562 rc
= vfs_mknod(lower_dir_dentry
->d_inode
, lower_dentry
, mode
, dev
);
563 if (rc
|| !lower_dentry
->d_inode
)
565 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
, 0);
568 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
569 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
571 unlock_dir(lower_dir_dentry
);
572 if (!dentry
->d_inode
)
578 ecryptfs_rename(struct inode
*old_dir
, struct dentry
*old_dentry
,
579 struct inode
*new_dir
, struct dentry
*new_dentry
)
582 struct dentry
*lower_old_dentry
;
583 struct dentry
*lower_new_dentry
;
584 struct dentry
*lower_old_dir_dentry
;
585 struct dentry
*lower_new_dir_dentry
;
586 struct dentry
*trap
= NULL
;
588 lower_old_dentry
= ecryptfs_dentry_to_lower(old_dentry
);
589 lower_new_dentry
= ecryptfs_dentry_to_lower(new_dentry
);
590 dget(lower_old_dentry
);
591 dget(lower_new_dentry
);
592 lower_old_dir_dentry
= dget_parent(lower_old_dentry
);
593 lower_new_dir_dentry
= dget_parent(lower_new_dentry
);
594 trap
= lock_rename(lower_old_dir_dentry
, lower_new_dir_dentry
);
595 /* source should not be ancestor of target */
596 if (trap
== lower_old_dentry
) {
600 /* target should not be ancestor of source */
601 if (trap
== lower_new_dentry
) {
605 rc
= vfs_rename(lower_old_dir_dentry
->d_inode
, lower_old_dentry
,
606 lower_new_dir_dentry
->d_inode
, lower_new_dentry
);
609 fsstack_copy_attr_all(new_dir
, lower_new_dir_dentry
->d_inode
);
610 if (new_dir
!= old_dir
)
611 fsstack_copy_attr_all(old_dir
, lower_old_dir_dentry
->d_inode
);
613 unlock_rename(lower_old_dir_dentry
, lower_new_dir_dentry
);
614 dput(lower_new_dentry
->d_parent
);
615 dput(lower_old_dentry
->d_parent
);
616 dput(lower_new_dentry
);
617 dput(lower_old_dentry
);
621 static int ecryptfs_readlink_lower(struct dentry
*dentry
, char **buf
,
624 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
626 size_t lower_bufsiz
= PATH_MAX
;
630 lower_buf
= kmalloc(lower_bufsiz
, GFP_KERNEL
);
637 rc
= lower_dentry
->d_inode
->i_op
->readlink(lower_dentry
,
638 (char __user
*)lower_buf
,
644 rc
= ecryptfs_decode_and_decrypt_filename(buf
, bufsiz
, dentry
,
645 lower_buf
, lower_bufsiz
);
652 ecryptfs_readlink(struct dentry
*dentry
, char __user
*buf
, int bufsiz
)
655 size_t kbufsiz
, copied
;
658 rc
= ecryptfs_readlink_lower(dentry
, &kbuf
, &kbufsiz
);
661 copied
= min_t(size_t, bufsiz
, kbufsiz
);
662 rc
= copy_to_user(buf
, kbuf
, copied
) ? -EFAULT
: copied
;
664 fsstack_copy_attr_atime(dentry
->d_inode
,
665 ecryptfs_dentry_to_lower(dentry
)->d_inode
);
670 static void *ecryptfs_follow_link(struct dentry
*dentry
, struct nameidata
*nd
)
673 int len
= PAGE_SIZE
, rc
;
676 /* Released in ecryptfs_put_link(); only release here on error */
677 buf
= kmalloc(len
, GFP_KERNEL
);
679 buf
= ERR_PTR(-ENOMEM
);
684 rc
= dentry
->d_inode
->i_op
->readlink(dentry
, (char __user
*)buf
, len
);
692 nd_set_link(nd
, buf
);
697 ecryptfs_put_link(struct dentry
*dentry
, struct nameidata
*nd
, void *ptr
)
699 char *buf
= nd_get_link(nd
);
707 * upper_size_to_lower_size
708 * @crypt_stat: Crypt_stat associated with file
709 * @upper_size: Size of the upper file
711 * Calculate the required size of the lower file based on the
712 * specified size of the upper file. This calculation is based on the
713 * number of headers in the underlying file and the extent size.
715 * Returns Calculated size of the lower file.
718 upper_size_to_lower_size(struct ecryptfs_crypt_stat
*crypt_stat
,
723 lower_size
= ecryptfs_lower_header_size(crypt_stat
);
724 if (upper_size
!= 0) {
727 num_extents
= upper_size
>> crypt_stat
->extent_shift
;
728 if (upper_size
& ~crypt_stat
->extent_mask
)
730 lower_size
+= (num_extents
* crypt_stat
->extent_size
);
737 * @dentry: The ecryptfs layer dentry
738 * @ia: Address of the ecryptfs inode's attributes
739 * @lower_ia: Address of the lower inode's attributes
741 * Function to handle truncations modifying the size of the file. Note
742 * that the file sizes are interpolated. When expanding, we are simply
743 * writing strings of 0's out. When truncating, we truncate the upper
744 * inode and update the lower_ia according to the page index
745 * interpolations. If ATTR_SIZE is set in lower_ia->ia_valid upon return,
746 * the caller must use lower_ia in a call to notify_change() to perform
747 * the truncation of the lower inode.
749 * Returns zero on success; non-zero otherwise
751 static int truncate_upper(struct dentry
*dentry
, struct iattr
*ia
,
752 struct iattr
*lower_ia
)
755 struct inode
*inode
= dentry
->d_inode
;
756 struct ecryptfs_crypt_stat
*crypt_stat
;
757 loff_t i_size
= i_size_read(inode
);
758 loff_t lower_size_before_truncate
;
759 loff_t lower_size_after_truncate
;
761 if (unlikely((ia
->ia_size
== i_size
))) {
762 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
765 crypt_stat
= &ecryptfs_inode_to_private(dentry
->d_inode
)->crypt_stat
;
766 /* Switch on growing or shrinking file */
767 if (ia
->ia_size
> i_size
) {
768 char zero
[] = { 0x00 };
770 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
771 /* Write a single 0 at the last position of the file;
772 * this triggers code that will fill in 0's throughout
773 * the intermediate portion of the previous end of the
774 * file and the new and of the file */
775 rc
= ecryptfs_write(inode
, zero
,
776 (ia
->ia_size
- 1), 1);
777 } else { /* ia->ia_size < i_size_read(inode) */
778 /* We're chopping off all the pages down to the page
779 * in which ia->ia_size is located. Fill in the end of
780 * that page from (ia->ia_size & ~PAGE_CACHE_MASK) to
781 * PAGE_CACHE_SIZE with zeros. */
782 size_t num_zeros
= (PAGE_CACHE_SIZE
783 - (ia
->ia_size
& ~PAGE_CACHE_MASK
));
787 * XXX(truncate) this should really happen at the begginning
788 * of ->setattr. But the code is too messy to that as part
789 * of a larger patch. ecryptfs is also totally missing out
790 * on the inode_change_ok check at the beginning of
791 * ->setattr while would include this.
793 rc
= inode_newsize_ok(inode
, ia
->ia_size
);
797 if (!(crypt_stat
->flags
& ECRYPTFS_ENCRYPTED
)) {
798 truncate_setsize(inode
, ia
->ia_size
);
799 lower_ia
->ia_size
= ia
->ia_size
;
800 lower_ia
->ia_valid
|= ATTR_SIZE
;
806 zeros_virt
= kzalloc(num_zeros
, GFP_KERNEL
);
811 rc
= ecryptfs_write(inode
, zeros_virt
,
812 ia
->ia_size
, num_zeros
);
815 printk(KERN_ERR
"Error attempting to zero out "
816 "the remainder of the end page on "
817 "reducing truncate; rc = [%d]\n", rc
);
821 truncate_setsize(inode
, ia
->ia_size
);
822 rc
= ecryptfs_write_inode_size_to_metadata(inode
);
824 printk(KERN_ERR
"Problem with "
825 "ecryptfs_write_inode_size_to_metadata; "
829 /* We are reducing the size of the ecryptfs file, and need to
830 * know if we need to reduce the size of the lower file. */
831 lower_size_before_truncate
=
832 upper_size_to_lower_size(crypt_stat
, i_size
);
833 lower_size_after_truncate
=
834 upper_size_to_lower_size(crypt_stat
, ia
->ia_size
);
835 if (lower_size_after_truncate
< lower_size_before_truncate
) {
836 lower_ia
->ia_size
= lower_size_after_truncate
;
837 lower_ia
->ia_valid
|= ATTR_SIZE
;
839 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
847 * @dentry: The ecryptfs layer dentry
848 * @new_length: The length to expand the file to
850 * Simple function that handles the truncation of an eCryptfs inode and
851 * its corresponding lower inode.
853 * Returns zero on success; non-zero otherwise
855 int ecryptfs_truncate(struct dentry
*dentry
, loff_t new_length
)
857 struct iattr ia
= { .ia_valid
= ATTR_SIZE
, .ia_size
= new_length
};
858 struct iattr lower_ia
= { .ia_valid
= 0 };
861 rc
= truncate_upper(dentry
, &ia
, &lower_ia
);
862 if (!rc
&& lower_ia
.ia_valid
& ATTR_SIZE
) {
863 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
865 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
866 rc
= notify_change(lower_dentry
, &lower_ia
);
867 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
873 ecryptfs_permission(struct inode
*inode
, int mask
, unsigned int flags
)
875 if (flags
& IPERM_FLAG_RCU
)
877 return inode_permission(ecryptfs_inode_to_lower(inode
), mask
);
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
;
896 struct iattr lower_ia
;
898 struct inode
*lower_inode
;
899 struct ecryptfs_crypt_stat
*crypt_stat
;
901 crypt_stat
= &ecryptfs_inode_to_private(dentry
->d_inode
)->crypt_stat
;
902 if (!(crypt_stat
->flags
& ECRYPTFS_STRUCT_INITIALIZED
))
903 ecryptfs_init_crypt_stat(crypt_stat
);
904 inode
= dentry
->d_inode
;
905 lower_inode
= ecryptfs_inode_to_lower(inode
);
906 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
907 mutex_lock(&crypt_stat
->cs_mutex
);
908 if (S_ISDIR(dentry
->d_inode
->i_mode
))
909 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
910 else if (S_ISREG(dentry
->d_inode
->i_mode
)
911 && (!(crypt_stat
->flags
& ECRYPTFS_POLICY_APPLIED
)
912 || !(crypt_stat
->flags
& ECRYPTFS_KEY_VALID
))) {
913 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
915 mount_crypt_stat
= &ecryptfs_superblock_to_private(
916 dentry
->d_sb
)->mount_crypt_stat
;
917 rc
= ecryptfs_read_metadata(dentry
);
919 if (!(mount_crypt_stat
->flags
920 & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED
)) {
922 printk(KERN_WARNING
"Either the lower file "
923 "is not in a valid eCryptfs format, "
924 "or the key could not be retrieved. "
925 "Plaintext passthrough mode is not "
926 "enabled; returning -EIO\n");
927 mutex_unlock(&crypt_stat
->cs_mutex
);
931 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
934 mutex_unlock(&crypt_stat
->cs_mutex
);
935 memcpy(&lower_ia
, ia
, sizeof(lower_ia
));
936 if (ia
->ia_valid
& ATTR_FILE
)
937 lower_ia
.ia_file
= ecryptfs_file_to_lower(ia
->ia_file
);
938 if (ia
->ia_valid
& ATTR_SIZE
) {
939 rc
= truncate_upper(dentry
, ia
, &lower_ia
);
945 * mode change is for clearing setuid/setgid bits. Allow lower fs
946 * to interpret this in its own way.
948 if (lower_ia
.ia_valid
& (ATTR_KILL_SUID
| ATTR_KILL_SGID
))
949 lower_ia
.ia_valid
&= ~ATTR_MODE
;
951 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
952 rc
= notify_change(lower_dentry
, &lower_ia
);
953 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
955 fsstack_copy_attr_all(inode
, lower_inode
);
959 int ecryptfs_getattr_link(struct vfsmount
*mnt
, struct dentry
*dentry
,
962 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
965 mount_crypt_stat
= &ecryptfs_superblock_to_private(
966 dentry
->d_sb
)->mount_crypt_stat
;
967 generic_fillattr(dentry
->d_inode
, stat
);
968 if (mount_crypt_stat
->flags
& ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES
) {
972 rc
= ecryptfs_readlink_lower(dentry
, &target
, &targetsiz
);
975 stat
->size
= targetsiz
;
981 int ecryptfs_getattr(struct vfsmount
*mnt
, struct dentry
*dentry
,
984 struct kstat lower_stat
;
987 rc
= vfs_getattr(ecryptfs_dentry_to_lower_mnt(dentry
),
988 ecryptfs_dentry_to_lower(dentry
), &lower_stat
);
990 fsstack_copy_attr_all(dentry
->d_inode
,
991 ecryptfs_inode_to_lower(dentry
->d_inode
));
992 generic_fillattr(dentry
->d_inode
, stat
);
993 stat
->blocks
= lower_stat
.blocks
;
999 ecryptfs_setxattr(struct dentry
*dentry
, const char *name
, const void *value
,
1000 size_t size
, int flags
)
1003 struct dentry
*lower_dentry
;
1005 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1006 if (!lower_dentry
->d_inode
->i_op
->setxattr
) {
1011 rc
= vfs_setxattr(lower_dentry
, name
, value
, size
, flags
);
1017 ecryptfs_getxattr_lower(struct dentry
*lower_dentry
, const char *name
,
1018 void *value
, size_t size
)
1022 if (!lower_dentry
->d_inode
->i_op
->getxattr
) {
1026 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1027 rc
= lower_dentry
->d_inode
->i_op
->getxattr(lower_dentry
, name
, value
,
1029 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1035 ecryptfs_getxattr(struct dentry
*dentry
, const char *name
, void *value
,
1038 return ecryptfs_getxattr_lower(ecryptfs_dentry_to_lower(dentry
), name
,
1043 ecryptfs_listxattr(struct dentry
*dentry
, char *list
, size_t size
)
1046 struct dentry
*lower_dentry
;
1048 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1049 if (!lower_dentry
->d_inode
->i_op
->listxattr
) {
1053 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1054 rc
= lower_dentry
->d_inode
->i_op
->listxattr(lower_dentry
, list
, size
);
1055 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1060 static int ecryptfs_removexattr(struct dentry
*dentry
, const char *name
)
1063 struct dentry
*lower_dentry
;
1065 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1066 if (!lower_dentry
->d_inode
->i_op
->removexattr
) {
1070 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1071 rc
= lower_dentry
->d_inode
->i_op
->removexattr(lower_dentry
, name
);
1072 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1077 int ecryptfs_inode_test(struct inode
*inode
, void *candidate_lower_inode
)
1079 if ((ecryptfs_inode_to_lower(inode
)
1080 == (struct inode
*)candidate_lower_inode
))
1086 int ecryptfs_inode_set(struct inode
*inode
, void *lower_inode
)
1088 ecryptfs_init_inode(inode
, (struct inode
*)lower_inode
);
1092 const struct inode_operations ecryptfs_symlink_iops
= {
1093 .readlink
= ecryptfs_readlink
,
1094 .follow_link
= ecryptfs_follow_link
,
1095 .put_link
= ecryptfs_put_link
,
1096 .permission
= ecryptfs_permission
,
1097 .setattr
= ecryptfs_setattr
,
1098 .getattr
= ecryptfs_getattr_link
,
1099 .setxattr
= ecryptfs_setxattr
,
1100 .getxattr
= ecryptfs_getxattr
,
1101 .listxattr
= ecryptfs_listxattr
,
1102 .removexattr
= ecryptfs_removexattr
1105 const struct inode_operations ecryptfs_dir_iops
= {
1106 .create
= ecryptfs_create
,
1107 .lookup
= ecryptfs_lookup
,
1108 .link
= ecryptfs_link
,
1109 .unlink
= ecryptfs_unlink
,
1110 .symlink
= ecryptfs_symlink
,
1111 .mkdir
= ecryptfs_mkdir
,
1112 .rmdir
= ecryptfs_rmdir
,
1113 .mknod
= ecryptfs_mknod
,
1114 .rename
= ecryptfs_rename
,
1115 .permission
= ecryptfs_permission
,
1116 .setattr
= ecryptfs_setattr
,
1117 .setxattr
= ecryptfs_setxattr
,
1118 .getxattr
= ecryptfs_getxattr
,
1119 .listxattr
= ecryptfs_listxattr
,
1120 .removexattr
= ecryptfs_removexattr
1123 const struct inode_operations ecryptfs_main_iops
= {
1124 .permission
= ecryptfs_permission
,
1125 .setattr
= ecryptfs_setattr
,
1126 .getattr
= ecryptfs_getattr
,
1127 .setxattr
= ecryptfs_setxattr
,
1128 .getxattr
= ecryptfs_getxattr
,
1129 .listxattr
= ecryptfs_listxattr
,
1130 .removexattr
= ecryptfs_removexattr