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 <asm/unaligned.h>
35 #include "ecryptfs_kernel.h"
37 static struct dentry
*lock_parent(struct dentry
*dentry
)
41 dir
= dget_parent(dentry
);
42 mutex_lock_nested(&(dir
->d_inode
->i_mutex
), I_MUTEX_PARENT
);
46 static void unlock_dir(struct dentry
*dir
)
48 mutex_unlock(&dir
->d_inode
->i_mutex
);
53 * ecryptfs_create_underlying_file
54 * @lower_dir_inode: inode of the parent in the lower fs of the new file
55 * @dentry: New file's dentry
56 * @mode: The mode of the new file
57 * @nd: nameidata of ecryptfs' parent's dentry & vfsmount
59 * Creates the file in the lower file system.
61 * Returns zero on success; non-zero on error condition
64 ecryptfs_create_underlying_file(struct inode
*lower_dir_inode
,
65 struct dentry
*dentry
, int mode
,
68 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
69 struct vfsmount
*lower_mnt
= ecryptfs_dentry_to_lower_mnt(dentry
);
70 struct dentry
*dentry_save
;
71 struct vfsmount
*vfsmount_save
;
74 dentry_save
= nd
->path
.dentry
;
75 vfsmount_save
= nd
->path
.mnt
;
76 nd
->path
.dentry
= lower_dentry
;
77 nd
->path
.mnt
= lower_mnt
;
78 rc
= vfs_create(lower_dir_inode
, lower_dentry
, mode
, nd
);
79 nd
->path
.dentry
= dentry_save
;
80 nd
->path
.mnt
= vfsmount_save
;
86 * @directory_inode: inode of the new file's dentry's parent in ecryptfs
87 * @ecryptfs_dentry: New file's dentry in ecryptfs
88 * @mode: The mode of the new file
89 * @nd: nameidata of ecryptfs' parent's dentry & vfsmount
91 * Creates the underlying file and the eCryptfs inode which will link to
92 * it. It will also update the eCryptfs directory inode to mimic the
93 * stat of the lower directory inode.
95 * Returns zero on success; non-zero on error condition
98 ecryptfs_do_create(struct inode
*directory_inode
,
99 struct dentry
*ecryptfs_dentry
, int mode
,
100 struct nameidata
*nd
)
103 struct dentry
*lower_dentry
;
104 struct dentry
*lower_dir_dentry
;
106 lower_dentry
= ecryptfs_dentry_to_lower(ecryptfs_dentry
);
107 lower_dir_dentry
= lock_parent(lower_dentry
);
108 if (IS_ERR(lower_dir_dentry
)) {
109 ecryptfs_printk(KERN_ERR
, "Error locking directory of "
111 rc
= PTR_ERR(lower_dir_dentry
);
114 rc
= ecryptfs_create_underlying_file(lower_dir_dentry
->d_inode
,
115 ecryptfs_dentry
, mode
, nd
);
117 printk(KERN_ERR
"%s: Failure to create dentry in lower fs; "
118 "rc = [%d]\n", __func__
, rc
);
121 rc
= ecryptfs_interpose(lower_dentry
, ecryptfs_dentry
,
122 directory_inode
->i_sb
, 0);
124 ecryptfs_printk(KERN_ERR
, "Failure in ecryptfs_interpose\n");
127 fsstack_copy_attr_times(directory_inode
, lower_dir_dentry
->d_inode
);
128 fsstack_copy_inode_size(directory_inode
, lower_dir_dentry
->d_inode
);
130 unlock_dir(lower_dir_dentry
);
137 * @ecryptfs_dentry: the eCryptfs dentry
139 * This is the code which will grow the file to its correct size.
141 static int grow_file(struct dentry
*ecryptfs_dentry
)
143 struct inode
*ecryptfs_inode
= ecryptfs_dentry
->d_inode
;
144 struct file fake_file
;
145 struct ecryptfs_file_info tmp_file_info
;
146 char zero_virt
[] = { 0x00 };
149 memset(&fake_file
, 0, sizeof(fake_file
));
150 fake_file
.f_path
.dentry
= ecryptfs_dentry
;
151 memset(&tmp_file_info
, 0, sizeof(tmp_file_info
));
152 ecryptfs_set_file_private(&fake_file
, &tmp_file_info
);
153 ecryptfs_set_file_lower(
155 ecryptfs_inode_to_private(ecryptfs_inode
)->lower_file
);
156 rc
= ecryptfs_write(&fake_file
, zero_virt
, 0, 1);
157 i_size_write(ecryptfs_inode
, 0);
158 rc
= ecryptfs_write_inode_size_to_metadata(ecryptfs_inode
);
159 ecryptfs_inode_to_private(ecryptfs_inode
)->crypt_stat
.flags
|=
165 * ecryptfs_initialize_file
167 * Cause the file to be changed from a basic empty file to an ecryptfs
168 * file with a header and first data page.
170 * Returns zero on success
172 static int ecryptfs_initialize_file(struct dentry
*ecryptfs_dentry
)
174 struct ecryptfs_crypt_stat
*crypt_stat
=
175 &ecryptfs_inode_to_private(ecryptfs_dentry
->d_inode
)->crypt_stat
;
178 if (S_ISDIR(ecryptfs_dentry
->d_inode
->i_mode
)) {
179 ecryptfs_printk(KERN_DEBUG
, "This is a directory\n");
180 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
183 crypt_stat
->flags
|= ECRYPTFS_NEW_FILE
;
184 ecryptfs_printk(KERN_DEBUG
, "Initializing crypto context\n");
185 rc
= ecryptfs_new_file_context(ecryptfs_dentry
);
187 ecryptfs_printk(KERN_ERR
, "Error creating new file "
188 "context; rc = [%d]\n", rc
);
191 if (!ecryptfs_inode_to_private(ecryptfs_dentry
->d_inode
)->lower_file
) {
192 rc
= ecryptfs_init_persistent_file(ecryptfs_dentry
);
194 printk(KERN_ERR
"%s: Error attempting to initialize "
195 "the persistent file for the dentry with name "
196 "[%s]; rc = [%d]\n", __func__
,
197 ecryptfs_dentry
->d_name
.name
, rc
);
201 rc
= ecryptfs_write_metadata(ecryptfs_dentry
);
203 printk(KERN_ERR
"Error writing headers; rc = [%d]\n", rc
);
206 rc
= grow_file(ecryptfs_dentry
);
208 printk(KERN_ERR
"Error growing file; rc = [%d]\n", rc
);
215 * @dir: The inode of the directory in which to create the file.
216 * @dentry: The eCryptfs dentry
217 * @mode: The mode of the new file.
220 * Creates a new file.
222 * Returns zero on success; non-zero on error condition
225 ecryptfs_create(struct inode
*directory_inode
, struct dentry
*ecryptfs_dentry
,
226 int mode
, struct nameidata
*nd
)
230 /* ecryptfs_do_create() calls ecryptfs_interpose() */
231 rc
= ecryptfs_do_create(directory_inode
, ecryptfs_dentry
, mode
, nd
);
233 ecryptfs_printk(KERN_WARNING
, "Failed to create file in"
234 "lower filesystem\n");
237 /* At this point, a file exists on "disk"; we need to make sure
238 * that this on disk file is prepared to be an ecryptfs file */
239 rc
= ecryptfs_initialize_file(ecryptfs_dentry
);
245 * ecryptfs_lookup_and_interpose_lower - Perform a lookup
247 int ecryptfs_lookup_and_interpose_lower(struct dentry
*ecryptfs_dentry
,
248 struct dentry
*lower_dentry
,
249 struct ecryptfs_crypt_stat
*crypt_stat
,
250 struct inode
*ecryptfs_dir_inode
,
251 struct nameidata
*ecryptfs_nd
)
253 struct dentry
*lower_dir_dentry
;
254 struct vfsmount
*lower_mnt
;
255 struct inode
*lower_inode
;
256 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
257 char *page_virt
= NULL
;
261 lower_dir_dentry
= lower_dentry
->d_parent
;
262 lower_mnt
= mntget(ecryptfs_dentry_to_lower_mnt(
263 ecryptfs_dentry
->d_parent
));
264 lower_inode
= lower_dentry
->d_inode
;
265 fsstack_copy_attr_atime(ecryptfs_dir_inode
, lower_dir_dentry
->d_inode
);
266 BUG_ON(!atomic_read(&lower_dentry
->d_count
));
267 ecryptfs_set_dentry_private(ecryptfs_dentry
,
268 kmem_cache_alloc(ecryptfs_dentry_info_cache
,
270 if (!ecryptfs_dentry_to_private(ecryptfs_dentry
)) {
272 printk(KERN_ERR
"%s: Out of memory whilst attempting "
273 "to allocate ecryptfs_dentry_info struct\n",
277 ecryptfs_set_dentry_lower(ecryptfs_dentry
, lower_dentry
);
278 ecryptfs_set_dentry_lower_mnt(ecryptfs_dentry
, lower_mnt
);
279 if (!lower_dentry
->d_inode
) {
280 /* We want to add because we couldn't find in lower */
281 d_add(ecryptfs_dentry
, NULL
);
284 rc
= ecryptfs_interpose(lower_dentry
, ecryptfs_dentry
,
285 ecryptfs_dir_inode
->i_sb
, 1);
287 printk(KERN_ERR
"%s: Error interposing; rc = [%d]\n",
291 if (S_ISDIR(lower_inode
->i_mode
))
293 if (S_ISLNK(lower_inode
->i_mode
))
295 if (special_file(lower_inode
->i_mode
))
299 /* Released in this function */
300 page_virt
= kmem_cache_zalloc(ecryptfs_header_cache_2
, GFP_USER
);
302 printk(KERN_ERR
"%s: Cannot kmem_cache_zalloc() a page\n",
307 if (!ecryptfs_inode_to_private(ecryptfs_dentry
->d_inode
)->lower_file
) {
308 rc
= ecryptfs_init_persistent_file(ecryptfs_dentry
);
310 printk(KERN_ERR
"%s: Error attempting to initialize "
311 "the persistent file for the dentry with name "
312 "[%s]; rc = [%d]\n", __func__
,
313 ecryptfs_dentry
->d_name
.name
, rc
);
317 rc
= ecryptfs_read_and_validate_header_region(page_virt
,
318 ecryptfs_dentry
->d_inode
);
320 rc
= ecryptfs_read_and_validate_xattr_region(page_virt
,
326 crypt_stat
->flags
|= ECRYPTFS_METADATA_IN_XATTR
;
328 mount_crypt_stat
= &ecryptfs_superblock_to_private(
329 ecryptfs_dentry
->d_sb
)->mount_crypt_stat
;
330 if (mount_crypt_stat
->flags
& ECRYPTFS_ENCRYPTED_VIEW_ENABLED
) {
331 if (crypt_stat
->flags
& ECRYPTFS_METADATA_IN_XATTR
)
332 file_size
= (crypt_stat
->num_header_bytes_at_front
333 + i_size_read(lower_dentry
->d_inode
));
335 file_size
= i_size_read(lower_dentry
->d_inode
);
337 file_size
= get_unaligned_be64(page_virt
);
339 i_size_write(ecryptfs_dentry
->d_inode
, (loff_t
)file_size
);
341 kmem_cache_free(ecryptfs_header_cache_2
, page_virt
);
345 d_drop(ecryptfs_dentry
);
352 * @ecryptfs_dir_inode: The eCryptfs directory inode
353 * @ecryptfs_dentry: The eCryptfs dentry that we are looking up
354 * @ecryptfs_nd: nameidata; may be NULL
356 * Find a file on disk. If the file does not exist, then we'll add it to the
357 * dentry cache and continue on to read it from the disk.
359 static struct dentry
*ecryptfs_lookup(struct inode
*ecryptfs_dir_inode
,
360 struct dentry
*ecryptfs_dentry
,
361 struct nameidata
*ecryptfs_nd
)
363 char *encrypted_and_encoded_name
= NULL
;
364 size_t encrypted_and_encoded_name_size
;
365 struct ecryptfs_crypt_stat
*crypt_stat
= NULL
;
366 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
= NULL
;
367 struct ecryptfs_inode_info
*inode_info
;
368 struct dentry
*lower_dir_dentry
, *lower_dentry
;
371 ecryptfs_dentry
->d_op
= &ecryptfs_dops
;
372 if ((ecryptfs_dentry
->d_name
.len
== 1
373 && !strcmp(ecryptfs_dentry
->d_name
.name
, "."))
374 || (ecryptfs_dentry
->d_name
.len
== 2
375 && !strcmp(ecryptfs_dentry
->d_name
.name
, ".."))) {
378 lower_dir_dentry
= ecryptfs_dentry_to_lower(ecryptfs_dentry
->d_parent
);
379 lower_dentry
= lookup_one_len(ecryptfs_dentry
->d_name
.name
,
381 ecryptfs_dentry
->d_name
.len
);
382 if (IS_ERR(lower_dentry
)) {
383 rc
= PTR_ERR(lower_dentry
);
384 printk(KERN_ERR
"%s: lookup_one_len() returned [%d] on "
385 "lower_dentry = [%s]\n", __func__
, rc
,
386 ecryptfs_dentry
->d_name
.name
);
389 if (lower_dentry
->d_inode
)
390 goto lookup_and_interpose
;
391 inode_info
= ecryptfs_inode_to_private(ecryptfs_dentry
->d_inode
);
393 crypt_stat
= &inode_info
->crypt_stat
;
394 /* TODO: lock for crypt_stat comparison */
395 if (!(crypt_stat
->flags
& ECRYPTFS_POLICY_APPLIED
))
396 ecryptfs_set_default_sizes(crypt_stat
);
399 mount_crypt_stat
= crypt_stat
->mount_crypt_stat
;
401 mount_crypt_stat
= &ecryptfs_superblock_to_private(
402 ecryptfs_dentry
->d_sb
)->mount_crypt_stat
;
403 if (!(crypt_stat
&& (crypt_stat
->flags
& ECRYPTFS_ENCRYPT_FILENAMES
))
404 && !(mount_crypt_stat
&& (mount_crypt_stat
->flags
405 & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES
)))
406 goto lookup_and_interpose
;
408 rc
= ecryptfs_encrypt_and_encode_filename(
409 &encrypted_and_encoded_name
, &encrypted_and_encoded_name_size
,
410 crypt_stat
, mount_crypt_stat
, ecryptfs_dentry
->d_name
.name
,
411 ecryptfs_dentry
->d_name
.len
);
413 printk(KERN_ERR
"%s: Error attempting to encrypt and encode "
414 "filename; rc = [%d]\n", __func__
, rc
);
417 lower_dentry
= lookup_one_len(encrypted_and_encoded_name
,
419 encrypted_and_encoded_name_size
- 1);
420 if (IS_ERR(lower_dentry
)) {
421 rc
= PTR_ERR(lower_dentry
);
422 printk(KERN_ERR
"%s: lookup_one_len() returned [%d] on "
423 "lower_dentry = [%s]\n", __func__
, rc
,
424 encrypted_and_encoded_name
);
427 lookup_and_interpose
:
428 rc
= ecryptfs_lookup_and_interpose_lower(ecryptfs_dentry
, lower_dentry
,
429 crypt_stat
, ecryptfs_dir_inode
,
433 d_drop(ecryptfs_dentry
);
435 kfree(encrypted_and_encoded_name
);
439 static int ecryptfs_link(struct dentry
*old_dentry
, struct inode
*dir
,
440 struct dentry
*new_dentry
)
442 struct dentry
*lower_old_dentry
;
443 struct dentry
*lower_new_dentry
;
444 struct dentry
*lower_dir_dentry
;
448 file_size_save
= i_size_read(old_dentry
->d_inode
);
449 lower_old_dentry
= ecryptfs_dentry_to_lower(old_dentry
);
450 lower_new_dentry
= ecryptfs_dentry_to_lower(new_dentry
);
451 dget(lower_old_dentry
);
452 dget(lower_new_dentry
);
453 lower_dir_dentry
= lock_parent(lower_new_dentry
);
454 rc
= vfs_link(lower_old_dentry
, lower_dir_dentry
->d_inode
,
456 if (rc
|| !lower_new_dentry
->d_inode
)
458 rc
= ecryptfs_interpose(lower_new_dentry
, new_dentry
, dir
->i_sb
, 0);
461 fsstack_copy_attr_times(dir
, lower_new_dentry
->d_inode
);
462 fsstack_copy_inode_size(dir
, lower_new_dentry
->d_inode
);
463 old_dentry
->d_inode
->i_nlink
=
464 ecryptfs_inode_to_lower(old_dentry
->d_inode
)->i_nlink
;
465 i_size_write(new_dentry
->d_inode
, file_size_save
);
467 unlock_dir(lower_dir_dentry
);
468 dput(lower_new_dentry
);
469 dput(lower_old_dentry
);
470 d_drop(lower_old_dentry
);
476 static int ecryptfs_unlink(struct inode
*dir
, struct dentry
*dentry
)
479 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
480 struct inode
*lower_dir_inode
= ecryptfs_inode_to_lower(dir
);
481 struct dentry
*lower_dir_dentry
;
483 lower_dir_dentry
= lock_parent(lower_dentry
);
484 rc
= vfs_unlink(lower_dir_inode
, lower_dentry
);
486 printk(KERN_ERR
"Error in vfs_unlink; rc = [%d]\n", rc
);
489 fsstack_copy_attr_times(dir
, lower_dir_inode
);
490 dentry
->d_inode
->i_nlink
=
491 ecryptfs_inode_to_lower(dentry
->d_inode
)->i_nlink
;
492 dentry
->d_inode
->i_ctime
= dir
->i_ctime
;
495 unlock_dir(lower_dir_dentry
);
499 static int ecryptfs_symlink(struct inode
*dir
, struct dentry
*dentry
,
503 struct dentry
*lower_dentry
;
504 struct dentry
*lower_dir_dentry
;
505 char *encoded_symname
;
506 size_t encoded_symlen
;
507 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
= NULL
;
509 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
511 lower_dir_dentry
= lock_parent(lower_dentry
);
512 mount_crypt_stat
= &ecryptfs_superblock_to_private(
513 dir
->i_sb
)->mount_crypt_stat
;
514 rc
= ecryptfs_encrypt_and_encode_filename(&encoded_symname
,
517 mount_crypt_stat
, symname
,
521 rc
= vfs_symlink(lower_dir_dentry
->d_inode
, lower_dentry
,
523 kfree(encoded_symname
);
524 if (rc
|| !lower_dentry
->d_inode
)
526 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
, 0);
529 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
530 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
532 unlock_dir(lower_dir_dentry
);
534 if (!dentry
->d_inode
)
539 static int ecryptfs_mkdir(struct inode
*dir
, struct dentry
*dentry
, int mode
)
542 struct dentry
*lower_dentry
;
543 struct dentry
*lower_dir_dentry
;
545 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
546 lower_dir_dentry
= lock_parent(lower_dentry
);
547 rc
= vfs_mkdir(lower_dir_dentry
->d_inode
, lower_dentry
, mode
);
548 if (rc
|| !lower_dentry
->d_inode
)
550 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
, 0);
553 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
554 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
555 dir
->i_nlink
= lower_dir_dentry
->d_inode
->i_nlink
;
557 unlock_dir(lower_dir_dentry
);
558 if (!dentry
->d_inode
)
563 static int ecryptfs_rmdir(struct inode
*dir
, struct dentry
*dentry
)
565 struct dentry
*lower_dentry
;
566 struct dentry
*lower_dir_dentry
;
569 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
571 lower_dir_dentry
= lock_parent(lower_dentry
);
573 rc
= vfs_rmdir(lower_dir_dentry
->d_inode
, lower_dentry
);
576 d_delete(lower_dentry
);
577 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
578 dir
->i_nlink
= lower_dir_dentry
->d_inode
->i_nlink
;
579 unlock_dir(lower_dir_dentry
);
587 ecryptfs_mknod(struct inode
*dir
, struct dentry
*dentry
, int mode
, dev_t dev
)
590 struct dentry
*lower_dentry
;
591 struct dentry
*lower_dir_dentry
;
593 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
594 lower_dir_dentry
= lock_parent(lower_dentry
);
595 rc
= vfs_mknod(lower_dir_dentry
->d_inode
, lower_dentry
, mode
, dev
);
596 if (rc
|| !lower_dentry
->d_inode
)
598 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
, 0);
601 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
602 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
604 unlock_dir(lower_dir_dentry
);
605 if (!dentry
->d_inode
)
611 ecryptfs_rename(struct inode
*old_dir
, struct dentry
*old_dentry
,
612 struct inode
*new_dir
, struct dentry
*new_dentry
)
615 struct dentry
*lower_old_dentry
;
616 struct dentry
*lower_new_dentry
;
617 struct dentry
*lower_old_dir_dentry
;
618 struct dentry
*lower_new_dir_dentry
;
620 lower_old_dentry
= ecryptfs_dentry_to_lower(old_dentry
);
621 lower_new_dentry
= ecryptfs_dentry_to_lower(new_dentry
);
622 dget(lower_old_dentry
);
623 dget(lower_new_dentry
);
624 lower_old_dir_dentry
= dget_parent(lower_old_dentry
);
625 lower_new_dir_dentry
= dget_parent(lower_new_dentry
);
626 lock_rename(lower_old_dir_dentry
, lower_new_dir_dentry
);
627 rc
= vfs_rename(lower_old_dir_dentry
->d_inode
, lower_old_dentry
,
628 lower_new_dir_dentry
->d_inode
, lower_new_dentry
);
631 fsstack_copy_attr_all(new_dir
, lower_new_dir_dentry
->d_inode
, NULL
);
632 if (new_dir
!= old_dir
)
633 fsstack_copy_attr_all(old_dir
, lower_old_dir_dentry
->d_inode
, NULL
);
635 unlock_rename(lower_old_dir_dentry
, lower_new_dir_dentry
);
636 dput(lower_new_dentry
->d_parent
);
637 dput(lower_old_dentry
->d_parent
);
638 dput(lower_new_dentry
);
639 dput(lower_old_dentry
);
644 ecryptfs_readlink(struct dentry
*dentry
, char __user
*buf
, int bufsiz
)
647 struct dentry
*lower_dentry
;
648 struct ecryptfs_crypt_stat
*crypt_stat
;
649 char *plaintext_name
;
650 size_t plaintext_name_size
;
654 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
655 if (!lower_dentry
->d_inode
->i_op
->readlink
) {
659 crypt_stat
= &ecryptfs_inode_to_private(dentry
->d_inode
)->crypt_stat
;
660 /* Released in this function */
661 lower_buf
= kmalloc(bufsiz
, GFP_KERNEL
);
662 if (lower_buf
== NULL
) {
663 printk(KERN_ERR
"%s: Out of memory whilst attempting to "
664 "kmalloc [%d] bytes\n", __func__
, bufsiz
);
670 rc
= lower_dentry
->d_inode
->i_op
->readlink(lower_dentry
,
671 (char __user
*)lower_buf
,
675 rc
= ecryptfs_decode_and_decrypt_filename(&plaintext_name
,
676 &plaintext_name_size
,
680 printk(KERN_ERR
"%s: Error attempting to decode and "
681 "decrypt filename; rc = [%d]\n", __func__
,
683 goto out_free_lower_buf
;
685 rc
= copy_to_user(buf
, plaintext_name
, plaintext_name_size
);
689 rc
= plaintext_name_size
;
690 kfree(plaintext_name
);
691 fsstack_copy_attr_atime(dentry
->d_inode
, lower_dentry
->d_inode
);
699 static void *ecryptfs_follow_link(struct dentry
*dentry
, struct nameidata
*nd
)
702 int len
= PAGE_SIZE
, rc
;
705 /* Released in ecryptfs_put_link(); only release here on error */
706 buf
= kmalloc(len
, GFP_KERNEL
);
713 rc
= dentry
->d_inode
->i_op
->readlink(dentry
, (char __user
*)buf
, len
);
720 nd_set_link(nd
, buf
);
729 ecryptfs_put_link(struct dentry
*dentry
, struct nameidata
*nd
, void *ptr
)
732 kfree(nd_get_link(nd
));
736 * upper_size_to_lower_size
737 * @crypt_stat: Crypt_stat associated with file
738 * @upper_size: Size of the upper file
740 * Calculate the required size of the lower file based on the
741 * specified size of the upper file. This calculation is based on the
742 * number of headers in the underlying file and the extent size.
744 * Returns Calculated size of the lower file.
747 upper_size_to_lower_size(struct ecryptfs_crypt_stat
*crypt_stat
,
752 lower_size
= crypt_stat
->num_header_bytes_at_front
;
753 if (upper_size
!= 0) {
756 num_extents
= upper_size
>> crypt_stat
->extent_shift
;
757 if (upper_size
& ~crypt_stat
->extent_mask
)
759 lower_size
+= (num_extents
* crypt_stat
->extent_size
);
766 * @dentry: The ecryptfs layer dentry
767 * @new_length: The length to expand the file to
769 * Function to handle truncations modifying the size of the file. Note
770 * that the file sizes are interpolated. When expanding, we are simply
771 * writing strings of 0's out. When truncating, we need to modify the
772 * underlying file size according to the page index interpolations.
774 * Returns zero on success; non-zero otherwise
776 int ecryptfs_truncate(struct dentry
*dentry
, loff_t new_length
)
779 struct inode
*inode
= dentry
->d_inode
;
780 struct dentry
*lower_dentry
;
781 struct file fake_ecryptfs_file
;
782 struct ecryptfs_crypt_stat
*crypt_stat
;
783 loff_t i_size
= i_size_read(inode
);
784 loff_t lower_size_before_truncate
;
785 loff_t lower_size_after_truncate
;
787 if (unlikely((new_length
== i_size
)))
789 crypt_stat
= &ecryptfs_inode_to_private(dentry
->d_inode
)->crypt_stat
;
790 /* Set up a fake ecryptfs file, this is used to interface with
791 * the file in the underlying filesystem so that the
792 * truncation has an effect there as well. */
793 memset(&fake_ecryptfs_file
, 0, sizeof(fake_ecryptfs_file
));
794 fake_ecryptfs_file
.f_path
.dentry
= dentry
;
795 /* Released at out_free: label */
796 ecryptfs_set_file_private(&fake_ecryptfs_file
,
797 kmem_cache_alloc(ecryptfs_file_info_cache
,
799 if (unlikely(!ecryptfs_file_to_private(&fake_ecryptfs_file
))) {
803 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
804 ecryptfs_set_file_lower(
806 ecryptfs_inode_to_private(dentry
->d_inode
)->lower_file
);
807 /* Switch on growing or shrinking file */
808 if (new_length
> i_size
) {
809 char zero
[] = { 0x00 };
811 /* Write a single 0 at the last position of the file;
812 * this triggers code that will fill in 0's throughout
813 * the intermediate portion of the previous end of the
814 * file and the new and of the file */
815 rc
= ecryptfs_write(&fake_ecryptfs_file
, zero
,
816 (new_length
- 1), 1);
817 } else { /* new_length < i_size_read(inode) */
818 /* We're chopping off all the pages down do the page
819 * in which new_length is located. Fill in the end of
820 * that page from (new_length & ~PAGE_CACHE_MASK) to
821 * PAGE_CACHE_SIZE with zeros. */
822 size_t num_zeros
= (PAGE_CACHE_SIZE
823 - (new_length
& ~PAGE_CACHE_MASK
));
828 zeros_virt
= kzalloc(num_zeros
, GFP_KERNEL
);
833 rc
= ecryptfs_write(&fake_ecryptfs_file
, zeros_virt
,
834 new_length
, num_zeros
);
837 printk(KERN_ERR
"Error attempting to zero out "
838 "the remainder of the end page on "
839 "reducing truncate; rc = [%d]\n", rc
);
843 vmtruncate(inode
, new_length
);
844 rc
= ecryptfs_write_inode_size_to_metadata(inode
);
846 printk(KERN_ERR
"Problem with "
847 "ecryptfs_write_inode_size_to_metadata; "
851 /* We are reducing the size of the ecryptfs file, and need to
852 * know if we need to reduce the size of the lower file. */
853 lower_size_before_truncate
=
854 upper_size_to_lower_size(crypt_stat
, i_size
);
855 lower_size_after_truncate
=
856 upper_size_to_lower_size(crypt_stat
, new_length
);
857 if (lower_size_after_truncate
< lower_size_before_truncate
)
858 vmtruncate(lower_dentry
->d_inode
,
859 lower_size_after_truncate
);
862 if (ecryptfs_file_to_private(&fake_ecryptfs_file
))
863 kmem_cache_free(ecryptfs_file_info_cache
,
864 ecryptfs_file_to_private(&fake_ecryptfs_file
));
870 ecryptfs_permission(struct inode
*inode
, int mask
)
872 return inode_permission(ecryptfs_inode_to_lower(inode
), mask
);
877 * @dentry: dentry handle to the inode to modify
878 * @ia: Structure with flags of what to change and values
880 * Updates the metadata of an inode. If the update is to the size
881 * i.e. truncation, then ecryptfs_truncate will handle the size modification
882 * of both the ecryptfs inode and the lower inode.
884 * All other metadata changes will be passed right to the lower filesystem,
885 * and we will just update our inode to look like the lower.
887 static int ecryptfs_setattr(struct dentry
*dentry
, struct iattr
*ia
)
890 struct dentry
*lower_dentry
;
892 struct inode
*lower_inode
;
893 struct ecryptfs_crypt_stat
*crypt_stat
;
895 crypt_stat
= &ecryptfs_inode_to_private(dentry
->d_inode
)->crypt_stat
;
896 if (!(crypt_stat
->flags
& ECRYPTFS_STRUCT_INITIALIZED
))
897 ecryptfs_init_crypt_stat(crypt_stat
);
898 inode
= dentry
->d_inode
;
899 lower_inode
= ecryptfs_inode_to_lower(inode
);
900 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
901 mutex_lock(&crypt_stat
->cs_mutex
);
902 if (S_ISDIR(dentry
->d_inode
->i_mode
))
903 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
904 else if (S_ISREG(dentry
->d_inode
->i_mode
)
905 && (!(crypt_stat
->flags
& ECRYPTFS_POLICY_APPLIED
)
906 || !(crypt_stat
->flags
& ECRYPTFS_KEY_VALID
))) {
907 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
909 mount_crypt_stat
= &ecryptfs_superblock_to_private(
910 dentry
->d_sb
)->mount_crypt_stat
;
911 rc
= ecryptfs_read_metadata(dentry
);
913 if (!(mount_crypt_stat
->flags
914 & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED
)) {
916 printk(KERN_WARNING
"Either the lower file "
917 "is not in a valid eCryptfs format, "
918 "or the key could not be retrieved. "
919 "Plaintext passthrough mode is not "
920 "enabled; returning -EIO\n");
921 mutex_unlock(&crypt_stat
->cs_mutex
);
925 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
926 mutex_unlock(&crypt_stat
->cs_mutex
);
930 mutex_unlock(&crypt_stat
->cs_mutex
);
931 if (ia
->ia_valid
& ATTR_SIZE
) {
932 ecryptfs_printk(KERN_DEBUG
,
933 "ia->ia_valid = [0x%x] ATTR_SIZE" " = [0x%x]\n",
934 ia
->ia_valid
, ATTR_SIZE
);
935 rc
= ecryptfs_truncate(dentry
, ia
->ia_size
);
936 /* ecryptfs_truncate handles resizing of the lower file */
937 ia
->ia_valid
&= ~ATTR_SIZE
;
938 ecryptfs_printk(KERN_DEBUG
, "ia->ia_valid = [%x]\n",
945 * mode change is for clearing setuid/setgid bits. Allow lower fs
946 * to interpret this in its own way.
948 if (ia
->ia_valid
& (ATTR_KILL_SUID
| ATTR_KILL_SGID
))
949 ia
->ia_valid
&= ~ATTR_MODE
;
951 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
952 rc
= notify_change(lower_dentry
, ia
);
953 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
955 fsstack_copy_attr_all(inode
, lower_inode
, NULL
);
960 ecryptfs_setxattr(struct dentry
*dentry
, const char *name
, const void *value
,
961 size_t size
, int flags
)
964 struct dentry
*lower_dentry
;
966 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
967 if (!lower_dentry
->d_inode
->i_op
->setxattr
) {
971 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
972 rc
= lower_dentry
->d_inode
->i_op
->setxattr(lower_dentry
, name
, value
,
974 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
980 ecryptfs_getxattr_lower(struct dentry
*lower_dentry
, const char *name
,
981 void *value
, size_t size
)
985 if (!lower_dentry
->d_inode
->i_op
->getxattr
) {
989 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
990 rc
= lower_dentry
->d_inode
->i_op
->getxattr(lower_dentry
, name
, value
,
992 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
998 ecryptfs_getxattr(struct dentry
*dentry
, const char *name
, void *value
,
1001 return ecryptfs_getxattr_lower(ecryptfs_dentry_to_lower(dentry
), name
,
1006 ecryptfs_listxattr(struct dentry
*dentry
, char *list
, size_t size
)
1009 struct dentry
*lower_dentry
;
1011 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1012 if (!lower_dentry
->d_inode
->i_op
->listxattr
) {
1016 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1017 rc
= lower_dentry
->d_inode
->i_op
->listxattr(lower_dentry
, list
, size
);
1018 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1023 static int ecryptfs_removexattr(struct dentry
*dentry
, const char *name
)
1026 struct dentry
*lower_dentry
;
1028 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1029 if (!lower_dentry
->d_inode
->i_op
->removexattr
) {
1033 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1034 rc
= lower_dentry
->d_inode
->i_op
->removexattr(lower_dentry
, name
);
1035 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1040 int ecryptfs_inode_test(struct inode
*inode
, void *candidate_lower_inode
)
1042 if ((ecryptfs_inode_to_lower(inode
)
1043 == (struct inode
*)candidate_lower_inode
))
1049 int ecryptfs_inode_set(struct inode
*inode
, void *lower_inode
)
1051 ecryptfs_init_inode(inode
, (struct inode
*)lower_inode
);
1055 const struct inode_operations ecryptfs_symlink_iops
= {
1056 .readlink
= ecryptfs_readlink
,
1057 .follow_link
= ecryptfs_follow_link
,
1058 .put_link
= ecryptfs_put_link
,
1059 .permission
= ecryptfs_permission
,
1060 .setattr
= ecryptfs_setattr
,
1061 .setxattr
= ecryptfs_setxattr
,
1062 .getxattr
= ecryptfs_getxattr
,
1063 .listxattr
= ecryptfs_listxattr
,
1064 .removexattr
= ecryptfs_removexattr
1067 const struct inode_operations ecryptfs_dir_iops
= {
1068 .create
= ecryptfs_create
,
1069 .lookup
= ecryptfs_lookup
,
1070 .link
= ecryptfs_link
,
1071 .unlink
= ecryptfs_unlink
,
1072 .symlink
= ecryptfs_symlink
,
1073 .mkdir
= ecryptfs_mkdir
,
1074 .rmdir
= ecryptfs_rmdir
,
1075 .mknod
= ecryptfs_mknod
,
1076 .rename
= ecryptfs_rename
,
1077 .permission
= ecryptfs_permission
,
1078 .setattr
= ecryptfs_setattr
,
1079 .setxattr
= ecryptfs_setxattr
,
1080 .getxattr
= ecryptfs_getxattr
,
1081 .listxattr
= ecryptfs_listxattr
,
1082 .removexattr
= ecryptfs_removexattr
1085 const struct inode_operations ecryptfs_main_iops
= {
1086 .permission
= ecryptfs_permission
,
1087 .setattr
= ecryptfs_setattr
,
1088 .setxattr
= ecryptfs_setxattr
,
1089 .getxattr
= ecryptfs_getxattr
,
1090 .listxattr
= ecryptfs_listxattr
,
1091 .removexattr
= ecryptfs_removexattr