Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/**
3 * eCryptfs: Linux filesystem encryption layer
4 *
5 * Copyright (C) 1997-2004 Erez Zadok
6 * Copyright (C) 2001-2004 Stony Brook University
7 * Copyright (C) 2004-2007 International Business Machines Corp.
8 * Author(s): Michael A. Halcrow <mahalcro@us.ibm.com>
9 * Michael C. Thompsion <mcthomps@us.ibm.com>
10 */
11
12#include <linux/file.h>
13#include <linux/vmalloc.h>
14#include <linux/pagemap.h>
15#include <linux/dcache.h>
16#include <linux/namei.h>
17#include <linux/mount.h>
18#include <linux/fs_stack.h>
19#include <linux/slab.h>
20#include <linux/xattr.h>
21#include <asm/unaligned.h>
22#include "ecryptfs_kernel.h"
23
24static struct dentry *lock_parent(struct dentry *dentry)
25{
26 struct dentry *dir;
27
28 dir = dget_parent(dentry);
29 inode_lock_nested(d_inode(dir), I_MUTEX_PARENT);
30 return dir;
31}
32
33static void unlock_dir(struct dentry *dir)
34{
35 inode_unlock(d_inode(dir));
36 dput(dir);
37}
38
39static int ecryptfs_inode_test(struct inode *inode, void *lower_inode)
40{
41 return ecryptfs_inode_to_lower(inode) == lower_inode;
42}
43
44static int ecryptfs_inode_set(struct inode *inode, void *opaque)
45{
46 struct inode *lower_inode = opaque;
47
48 ecryptfs_set_inode_lower(inode, lower_inode);
49 fsstack_copy_attr_all(inode, lower_inode);
50 /* i_size will be overwritten for encrypted regular files */
51 fsstack_copy_inode_size(inode, lower_inode);
52 inode->i_ino = lower_inode->i_ino;
53 inode->i_mapping->a_ops = &ecryptfs_aops;
54
55 if (S_ISLNK(inode->i_mode))
56 inode->i_op = &ecryptfs_symlink_iops;
57 else if (S_ISDIR(inode->i_mode))
58 inode->i_op = &ecryptfs_dir_iops;
59 else
60 inode->i_op = &ecryptfs_main_iops;
61
62 if (S_ISDIR(inode->i_mode))
63 inode->i_fop = &ecryptfs_dir_fops;
64 else if (special_file(inode->i_mode))
65 init_special_inode(inode, inode->i_mode, inode->i_rdev);
66 else
67 inode->i_fop = &ecryptfs_main_fops;
68
69 return 0;
70}
71
72static struct inode *__ecryptfs_get_inode(struct inode *lower_inode,
73 struct super_block *sb)
74{
75 struct inode *inode;
76
77 if (lower_inode->i_sb != ecryptfs_superblock_to_lower(sb))
78 return ERR_PTR(-EXDEV);
79 if (!igrab(lower_inode))
80 return ERR_PTR(-ESTALE);
81 inode = iget5_locked(sb, (unsigned long)lower_inode,
82 ecryptfs_inode_test, ecryptfs_inode_set,
83 lower_inode);
84 if (!inode) {
85 iput(lower_inode);
86 return ERR_PTR(-EACCES);
87 }
88 if (!(inode->i_state & I_NEW))
89 iput(lower_inode);
90
91 return inode;
92}
93
94struct inode *ecryptfs_get_inode(struct inode *lower_inode,
95 struct super_block *sb)
96{
97 struct inode *inode = __ecryptfs_get_inode(lower_inode, sb);
98
99 if (!IS_ERR(inode) && (inode->i_state & I_NEW))
100 unlock_new_inode(inode);
101
102 return inode;
103}
104
105/**
106 * ecryptfs_interpose
107 * @lower_dentry: Existing dentry in the lower filesystem
108 * @dentry: ecryptfs' dentry
109 * @sb: ecryptfs's super_block
110 *
111 * Interposes upper and lower dentries.
112 *
113 * Returns zero on success; non-zero otherwise
114 */
115static int ecryptfs_interpose(struct dentry *lower_dentry,
116 struct dentry *dentry, struct super_block *sb)
117{
118 struct inode *inode = ecryptfs_get_inode(d_inode(lower_dentry), sb);
119
120 if (IS_ERR(inode))
121 return PTR_ERR(inode);
122 d_instantiate(dentry, inode);
123
124 return 0;
125}
126
127static int ecryptfs_do_unlink(struct inode *dir, struct dentry *dentry,
128 struct inode *inode)
129{
130 struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
131 struct dentry *lower_dir_dentry;
132 struct inode *lower_dir_inode;
133 int rc;
134
135 lower_dir_dentry = ecryptfs_dentry_to_lower(dentry->d_parent);
136 lower_dir_inode = d_inode(lower_dir_dentry);
137 inode_lock_nested(lower_dir_inode, I_MUTEX_PARENT);
138 dget(lower_dentry); // don't even try to make the lower negative
139 if (lower_dentry->d_parent != lower_dir_dentry)
140 rc = -EINVAL;
141 else if (d_unhashed(lower_dentry))
142 rc = -EINVAL;
143 else
144 rc = vfs_unlink(lower_dir_inode, lower_dentry, NULL);
145 if (rc) {
146 printk(KERN_ERR "Error in vfs_unlink; rc = [%d]\n", rc);
147 goto out_unlock;
148 }
149 fsstack_copy_attr_times(dir, lower_dir_inode);
150 set_nlink(inode, ecryptfs_inode_to_lower(inode)->i_nlink);
151 inode->i_ctime = dir->i_ctime;
152out_unlock:
153 dput(lower_dentry);
154 inode_unlock(lower_dir_inode);
155 if (!rc)
156 d_drop(dentry);
157 return rc;
158}
159
160/**
161 * ecryptfs_do_create
162 * @directory_inode: inode of the new file's dentry's parent in ecryptfs
163 * @ecryptfs_dentry: New file's dentry in ecryptfs
164 * @mode: The mode of the new file
165 *
166 * Creates the underlying file and the eCryptfs inode which will link to
167 * it. It will also update the eCryptfs directory inode to mimic the
168 * stat of the lower directory inode.
169 *
170 * Returns the new eCryptfs inode on success; an ERR_PTR on error condition
171 */
172static struct inode *
173ecryptfs_do_create(struct inode *directory_inode,
174 struct dentry *ecryptfs_dentry, umode_t mode)
175{
176 int rc;
177 struct dentry *lower_dentry;
178 struct dentry *lower_dir_dentry;
179 struct inode *inode;
180
181 lower_dentry = ecryptfs_dentry_to_lower(ecryptfs_dentry);
182 lower_dir_dentry = lock_parent(lower_dentry);
183 rc = vfs_create(d_inode(lower_dir_dentry), lower_dentry, mode, true);
184 if (rc) {
185 printk(KERN_ERR "%s: Failure to create dentry in lower fs; "
186 "rc = [%d]\n", __func__, rc);
187 inode = ERR_PTR(rc);
188 goto out_lock;
189 }
190 inode = __ecryptfs_get_inode(d_inode(lower_dentry),
191 directory_inode->i_sb);
192 if (IS_ERR(inode)) {
193 vfs_unlink(d_inode(lower_dir_dentry), lower_dentry, NULL);
194 goto out_lock;
195 }
196 fsstack_copy_attr_times(directory_inode, d_inode(lower_dir_dentry));
197 fsstack_copy_inode_size(directory_inode, d_inode(lower_dir_dentry));
198out_lock:
199 unlock_dir(lower_dir_dentry);
200 return inode;
201}
202
203/**
204 * ecryptfs_initialize_file
205 *
206 * Cause the file to be changed from a basic empty file to an ecryptfs
207 * file with a header and first data page.
208 *
209 * Returns zero on success
210 */
211int ecryptfs_initialize_file(struct dentry *ecryptfs_dentry,
212 struct inode *ecryptfs_inode)
213{
214 struct ecryptfs_crypt_stat *crypt_stat =
215 &ecryptfs_inode_to_private(ecryptfs_inode)->crypt_stat;
216 int rc = 0;
217
218 if (S_ISDIR(ecryptfs_inode->i_mode)) {
219 ecryptfs_printk(KERN_DEBUG, "This is a directory\n");
220 crypt_stat->flags &= ~(ECRYPTFS_ENCRYPTED);
221 goto out;
222 }
223 ecryptfs_printk(KERN_DEBUG, "Initializing crypto context\n");
224 rc = ecryptfs_new_file_context(ecryptfs_inode);
225 if (rc) {
226 ecryptfs_printk(KERN_ERR, "Error creating new file "
227 "context; rc = [%d]\n", rc);
228 goto out;
229 }
230 rc = ecryptfs_get_lower_file(ecryptfs_dentry, ecryptfs_inode);
231 if (rc) {
232 printk(KERN_ERR "%s: Error attempting to initialize "
233 "the lower file for the dentry with name "
234 "[%pd]; rc = [%d]\n", __func__,
235 ecryptfs_dentry, rc);
236 goto out;
237 }
238 rc = ecryptfs_write_metadata(ecryptfs_dentry, ecryptfs_inode);
239 if (rc)
240 printk(KERN_ERR "Error writing headers; rc = [%d]\n", rc);
241 ecryptfs_put_lower_file(ecryptfs_inode);
242out:
243 return rc;
244}
245
246/**
247 * ecryptfs_create
248 * @dir: The inode of the directory in which to create the file.
249 * @dentry: The eCryptfs dentry
250 * @mode: The mode of the new file.
251 *
252 * Creates a new file.
253 *
254 * Returns zero on success; non-zero on error condition
255 */
256static int
257ecryptfs_create(struct inode *directory_inode, struct dentry *ecryptfs_dentry,
258 umode_t mode, bool excl)
259{
260 struct inode *ecryptfs_inode;
261 int rc;
262
263 ecryptfs_inode = ecryptfs_do_create(directory_inode, ecryptfs_dentry,
264 mode);
265 if (IS_ERR(ecryptfs_inode)) {
266 ecryptfs_printk(KERN_WARNING, "Failed to create file in"
267 "lower filesystem\n");
268 rc = PTR_ERR(ecryptfs_inode);
269 goto out;
270 }
271 /* At this point, a file exists on "disk"; we need to make sure
272 * that this on disk file is prepared to be an ecryptfs file */
273 rc = ecryptfs_initialize_file(ecryptfs_dentry, ecryptfs_inode);
274 if (rc) {
275 ecryptfs_do_unlink(directory_inode, ecryptfs_dentry,
276 ecryptfs_inode);
277 iget_failed(ecryptfs_inode);
278 goto out;
279 }
280 d_instantiate_new(ecryptfs_dentry, ecryptfs_inode);
281out:
282 return rc;
283}
284
285static int ecryptfs_i_size_read(struct dentry *dentry, struct inode *inode)
286{
287 struct ecryptfs_crypt_stat *crypt_stat;
288 int rc;
289
290 rc = ecryptfs_get_lower_file(dentry, inode);
291 if (rc) {
292 printk(KERN_ERR "%s: Error attempting to initialize "
293 "the lower file for the dentry with name "
294 "[%pd]; rc = [%d]\n", __func__,
295 dentry, rc);
296 return rc;
297 }
298
299 crypt_stat = &ecryptfs_inode_to_private(inode)->crypt_stat;
300 /* TODO: lock for crypt_stat comparison */
301 if (!(crypt_stat->flags & ECRYPTFS_POLICY_APPLIED))
302 ecryptfs_set_default_sizes(crypt_stat);
303
304 rc = ecryptfs_read_and_validate_header_region(inode);
305 ecryptfs_put_lower_file(inode);
306 if (rc) {
307 rc = ecryptfs_read_and_validate_xattr_region(dentry, inode);
308 if (!rc)
309 crypt_stat->flags |= ECRYPTFS_METADATA_IN_XATTR;
310 }
311
312 /* Must return 0 to allow non-eCryptfs files to be looked up, too */
313 return 0;
314}
315
316/**
317 * ecryptfs_lookup_interpose - Dentry interposition for a lookup
318 */
319static struct dentry *ecryptfs_lookup_interpose(struct dentry *dentry,
320 struct dentry *lower_dentry)
321{
322 struct path *path = ecryptfs_dentry_to_lower_path(dentry->d_parent);
323 struct inode *inode, *lower_inode;
324 struct ecryptfs_dentry_info *dentry_info;
325 int rc = 0;
326
327 dentry_info = kmem_cache_alloc(ecryptfs_dentry_info_cache, GFP_KERNEL);
328 if (!dentry_info) {
329 dput(lower_dentry);
330 return ERR_PTR(-ENOMEM);
331 }
332
333 fsstack_copy_attr_atime(d_inode(dentry->d_parent),
334 d_inode(path->dentry));
335 BUG_ON(!d_count(lower_dentry));
336
337 ecryptfs_set_dentry_private(dentry, dentry_info);
338 dentry_info->lower_path.mnt = mntget(path->mnt);
339 dentry_info->lower_path.dentry = lower_dentry;
340
341 /*
342 * negative dentry can go positive under us here - its parent is not
343 * locked. That's OK and that could happen just as we return from
344 * ecryptfs_lookup() anyway. Just need to be careful and fetch
345 * ->d_inode only once - it's not stable here.
346 */
347 lower_inode = READ_ONCE(lower_dentry->d_inode);
348
349 if (!lower_inode) {
350 /* We want to add because we couldn't find in lower */
351 d_add(dentry, NULL);
352 return NULL;
353 }
354 inode = __ecryptfs_get_inode(lower_inode, dentry->d_sb);
355 if (IS_ERR(inode)) {
356 printk(KERN_ERR "%s: Error interposing; rc = [%ld]\n",
357 __func__, PTR_ERR(inode));
358 return ERR_CAST(inode);
359 }
360 if (S_ISREG(inode->i_mode)) {
361 rc = ecryptfs_i_size_read(dentry, inode);
362 if (rc) {
363 make_bad_inode(inode);
364 return ERR_PTR(rc);
365 }
366 }
367
368 if (inode->i_state & I_NEW)
369 unlock_new_inode(inode);
370 return d_splice_alias(inode, dentry);
371}
372
373/**
374 * ecryptfs_lookup
375 * @ecryptfs_dir_inode: The eCryptfs directory inode
376 * @ecryptfs_dentry: The eCryptfs dentry that we are looking up
377 * @flags: lookup flags
378 *
379 * Find a file on disk. If the file does not exist, then we'll add it to the
380 * dentry cache and continue on to read it from the disk.
381 */
382static struct dentry *ecryptfs_lookup(struct inode *ecryptfs_dir_inode,
383 struct dentry *ecryptfs_dentry,
384 unsigned int flags)
385{
386 char *encrypted_and_encoded_name = NULL;
387 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
388 struct dentry *lower_dir_dentry, *lower_dentry;
389 const char *name = ecryptfs_dentry->d_name.name;
390 size_t len = ecryptfs_dentry->d_name.len;
391 struct dentry *res;
392 int rc = 0;
393
394 lower_dir_dentry = ecryptfs_dentry_to_lower(ecryptfs_dentry->d_parent);
395
396 mount_crypt_stat = &ecryptfs_superblock_to_private(
397 ecryptfs_dentry->d_sb)->mount_crypt_stat;
398 if (mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES) {
399 rc = ecryptfs_encrypt_and_encode_filename(
400 &encrypted_and_encoded_name, &len,
401 mount_crypt_stat, name, len);
402 if (rc) {
403 printk(KERN_ERR "%s: Error attempting to encrypt and encode "
404 "filename; rc = [%d]\n", __func__, rc);
405 return ERR_PTR(rc);
406 }
407 name = encrypted_and_encoded_name;
408 }
409
410 lower_dentry = lookup_one_len_unlocked(name, lower_dir_dentry, len);
411 if (IS_ERR(lower_dentry)) {
412 ecryptfs_printk(KERN_DEBUG, "%s: lookup_one_len() returned "
413 "[%ld] on lower_dentry = [%s]\n", __func__,
414 PTR_ERR(lower_dentry),
415 name);
416 res = ERR_CAST(lower_dentry);
417 } else {
418 res = ecryptfs_lookup_interpose(ecryptfs_dentry, lower_dentry);
419 }
420 kfree(encrypted_and_encoded_name);
421 return res;
422}
423
424static int ecryptfs_link(struct dentry *old_dentry, struct inode *dir,
425 struct dentry *new_dentry)
426{
427 struct dentry *lower_old_dentry;
428 struct dentry *lower_new_dentry;
429 struct dentry *lower_dir_dentry;
430 u64 file_size_save;
431 int rc;
432
433 file_size_save = i_size_read(d_inode(old_dentry));
434 lower_old_dentry = ecryptfs_dentry_to_lower(old_dentry);
435 lower_new_dentry = ecryptfs_dentry_to_lower(new_dentry);
436 dget(lower_old_dentry);
437 dget(lower_new_dentry);
438 lower_dir_dentry = lock_parent(lower_new_dentry);
439 rc = vfs_link(lower_old_dentry, d_inode(lower_dir_dentry),
440 lower_new_dentry, NULL);
441 if (rc || d_really_is_negative(lower_new_dentry))
442 goto out_lock;
443 rc = ecryptfs_interpose(lower_new_dentry, new_dentry, dir->i_sb);
444 if (rc)
445 goto out_lock;
446 fsstack_copy_attr_times(dir, d_inode(lower_dir_dentry));
447 fsstack_copy_inode_size(dir, d_inode(lower_dir_dentry));
448 set_nlink(d_inode(old_dentry),
449 ecryptfs_inode_to_lower(d_inode(old_dentry))->i_nlink);
450 i_size_write(d_inode(new_dentry), file_size_save);
451out_lock:
452 unlock_dir(lower_dir_dentry);
453 dput(lower_new_dentry);
454 dput(lower_old_dentry);
455 return rc;
456}
457
458static int ecryptfs_unlink(struct inode *dir, struct dentry *dentry)
459{
460 return ecryptfs_do_unlink(dir, dentry, d_inode(dentry));
461}
462
463static int ecryptfs_symlink(struct inode *dir, struct dentry *dentry,
464 const char *symname)
465{
466 int rc;
467 struct dentry *lower_dentry;
468 struct dentry *lower_dir_dentry;
469 char *encoded_symname;
470 size_t encoded_symlen;
471 struct ecryptfs_mount_crypt_stat *mount_crypt_stat = NULL;
472
473 lower_dentry = ecryptfs_dentry_to_lower(dentry);
474 dget(lower_dentry);
475 lower_dir_dentry = lock_parent(lower_dentry);
476 mount_crypt_stat = &ecryptfs_superblock_to_private(
477 dir->i_sb)->mount_crypt_stat;
478 rc = ecryptfs_encrypt_and_encode_filename(&encoded_symname,
479 &encoded_symlen,
480 mount_crypt_stat, symname,
481 strlen(symname));
482 if (rc)
483 goto out_lock;
484 rc = vfs_symlink(d_inode(lower_dir_dentry), lower_dentry,
485 encoded_symname);
486 kfree(encoded_symname);
487 if (rc || d_really_is_negative(lower_dentry))
488 goto out_lock;
489 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb);
490 if (rc)
491 goto out_lock;
492 fsstack_copy_attr_times(dir, d_inode(lower_dir_dentry));
493 fsstack_copy_inode_size(dir, d_inode(lower_dir_dentry));
494out_lock:
495 unlock_dir(lower_dir_dentry);
496 dput(lower_dentry);
497 if (d_really_is_negative(dentry))
498 d_drop(dentry);
499 return rc;
500}
501
502static int ecryptfs_mkdir(struct inode *dir, struct dentry *dentry, umode_t mode)
503{
504 int rc;
505 struct dentry *lower_dentry;
506 struct dentry *lower_dir_dentry;
507
508 lower_dentry = ecryptfs_dentry_to_lower(dentry);
509 lower_dir_dentry = lock_parent(lower_dentry);
510 rc = vfs_mkdir(d_inode(lower_dir_dentry), lower_dentry, mode);
511 if (rc || d_really_is_negative(lower_dentry))
512 goto out;
513 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb);
514 if (rc)
515 goto out;
516 fsstack_copy_attr_times(dir, d_inode(lower_dir_dentry));
517 fsstack_copy_inode_size(dir, d_inode(lower_dir_dentry));
518 set_nlink(dir, d_inode(lower_dir_dentry)->i_nlink);
519out:
520 unlock_dir(lower_dir_dentry);
521 if (d_really_is_negative(dentry))
522 d_drop(dentry);
523 return rc;
524}
525
526static int ecryptfs_rmdir(struct inode *dir, struct dentry *dentry)
527{
528 struct dentry *lower_dentry;
529 struct dentry *lower_dir_dentry;
530 struct inode *lower_dir_inode;
531 int rc;
532
533 lower_dentry = ecryptfs_dentry_to_lower(dentry);
534 lower_dir_dentry = ecryptfs_dentry_to_lower(dentry->d_parent);
535 lower_dir_inode = d_inode(lower_dir_dentry);
536
537 inode_lock_nested(lower_dir_inode, I_MUTEX_PARENT);
538 dget(lower_dentry); // don't even try to make the lower negative
539 if (lower_dentry->d_parent != lower_dir_dentry)
540 rc = -EINVAL;
541 else if (d_unhashed(lower_dentry))
542 rc = -EINVAL;
543 else
544 rc = vfs_rmdir(lower_dir_inode, lower_dentry);
545 if (!rc) {
546 clear_nlink(d_inode(dentry));
547 fsstack_copy_attr_times(dir, lower_dir_inode);
548 set_nlink(dir, lower_dir_inode->i_nlink);
549 }
550 dput(lower_dentry);
551 inode_unlock(lower_dir_inode);
552 if (!rc)
553 d_drop(dentry);
554 return rc;
555}
556
557static int
558ecryptfs_mknod(struct inode *dir, struct dentry *dentry, umode_t mode, dev_t dev)
559{
560 int rc;
561 struct dentry *lower_dentry;
562 struct dentry *lower_dir_dentry;
563
564 lower_dentry = ecryptfs_dentry_to_lower(dentry);
565 lower_dir_dentry = lock_parent(lower_dentry);
566 rc = vfs_mknod(d_inode(lower_dir_dentry), lower_dentry, mode, dev);
567 if (rc || d_really_is_negative(lower_dentry))
568 goto out;
569 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb);
570 if (rc)
571 goto out;
572 fsstack_copy_attr_times(dir, d_inode(lower_dir_dentry));
573 fsstack_copy_inode_size(dir, d_inode(lower_dir_dentry));
574out:
575 unlock_dir(lower_dir_dentry);
576 if (d_really_is_negative(dentry))
577 d_drop(dentry);
578 return rc;
579}
580
581static int
582ecryptfs_rename(struct inode *old_dir, struct dentry *old_dentry,
583 struct inode *new_dir, struct dentry *new_dentry,
584 unsigned int flags)
585{
586 int rc;
587 struct dentry *lower_old_dentry;
588 struct dentry *lower_new_dentry;
589 struct dentry *lower_old_dir_dentry;
590 struct dentry *lower_new_dir_dentry;
591 struct dentry *trap;
592 struct inode *target_inode;
593
594 if (flags)
595 return -EINVAL;
596
597 lower_old_dir_dentry = ecryptfs_dentry_to_lower(old_dentry->d_parent);
598 lower_new_dir_dentry = ecryptfs_dentry_to_lower(new_dentry->d_parent);
599
600 lower_old_dentry = ecryptfs_dentry_to_lower(old_dentry);
601 lower_new_dentry = ecryptfs_dentry_to_lower(new_dentry);
602
603 target_inode = d_inode(new_dentry);
604
605 trap = lock_rename(lower_old_dir_dentry, lower_new_dir_dentry);
606 dget(lower_new_dentry);
607 rc = -EINVAL;
608 if (lower_old_dentry->d_parent != lower_old_dir_dentry)
609 goto out_lock;
610 if (lower_new_dentry->d_parent != lower_new_dir_dentry)
611 goto out_lock;
612 if (d_unhashed(lower_old_dentry) || d_unhashed(lower_new_dentry))
613 goto out_lock;
614 /* source should not be ancestor of target */
615 if (trap == lower_old_dentry)
616 goto out_lock;
617 /* target should not be ancestor of source */
618 if (trap == lower_new_dentry) {
619 rc = -ENOTEMPTY;
620 goto out_lock;
621 }
622 rc = vfs_rename(d_inode(lower_old_dir_dentry), lower_old_dentry,
623 d_inode(lower_new_dir_dentry), lower_new_dentry,
624 NULL, 0);
625 if (rc)
626 goto out_lock;
627 if (target_inode)
628 fsstack_copy_attr_all(target_inode,
629 ecryptfs_inode_to_lower(target_inode));
630 fsstack_copy_attr_all(new_dir, d_inode(lower_new_dir_dentry));
631 if (new_dir != old_dir)
632 fsstack_copy_attr_all(old_dir, d_inode(lower_old_dir_dentry));
633out_lock:
634 dput(lower_new_dentry);
635 unlock_rename(lower_old_dir_dentry, lower_new_dir_dentry);
636 return rc;
637}
638
639static char *ecryptfs_readlink_lower(struct dentry *dentry, size_t *bufsiz)
640{
641 DEFINE_DELAYED_CALL(done);
642 struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
643 const char *link;
644 char *buf;
645 int rc;
646
647 link = vfs_get_link(lower_dentry, &done);
648 if (IS_ERR(link))
649 return ERR_CAST(link);
650
651 rc = ecryptfs_decode_and_decrypt_filename(&buf, bufsiz, dentry->d_sb,
652 link, strlen(link));
653 do_delayed_call(&done);
654 if (rc)
655 return ERR_PTR(rc);
656
657 return buf;
658}
659
660static const char *ecryptfs_get_link(struct dentry *dentry,
661 struct inode *inode,
662 struct delayed_call *done)
663{
664 size_t len;
665 char *buf;
666
667 if (!dentry)
668 return ERR_PTR(-ECHILD);
669
670 buf = ecryptfs_readlink_lower(dentry, &len);
671 if (IS_ERR(buf))
672 return buf;
673 fsstack_copy_attr_atime(d_inode(dentry),
674 d_inode(ecryptfs_dentry_to_lower(dentry)));
675 buf[len] = '\0';
676 set_delayed_call(done, kfree_link, buf);
677 return buf;
678}
679
680/**
681 * upper_size_to_lower_size
682 * @crypt_stat: Crypt_stat associated with file
683 * @upper_size: Size of the upper file
684 *
685 * Calculate the required size of the lower file based on the
686 * specified size of the upper file. This calculation is based on the
687 * number of headers in the underlying file and the extent size.
688 *
689 * Returns Calculated size of the lower file.
690 */
691static loff_t
692upper_size_to_lower_size(struct ecryptfs_crypt_stat *crypt_stat,
693 loff_t upper_size)
694{
695 loff_t lower_size;
696
697 lower_size = ecryptfs_lower_header_size(crypt_stat);
698 if (upper_size != 0) {
699 loff_t num_extents;
700
701 num_extents = upper_size >> crypt_stat->extent_shift;
702 if (upper_size & ~crypt_stat->extent_mask)
703 num_extents++;
704 lower_size += (num_extents * crypt_stat->extent_size);
705 }
706 return lower_size;
707}
708
709/**
710 * truncate_upper
711 * @dentry: The ecryptfs layer dentry
712 * @ia: Address of the ecryptfs inode's attributes
713 * @lower_ia: Address of the lower inode's attributes
714 *
715 * Function to handle truncations modifying the size of the file. Note
716 * that the file sizes are interpolated. When expanding, we are simply
717 * writing strings of 0's out. When truncating, we truncate the upper
718 * inode and update the lower_ia according to the page index
719 * interpolations. If ATTR_SIZE is set in lower_ia->ia_valid upon return,
720 * the caller must use lower_ia in a call to notify_change() to perform
721 * the truncation of the lower inode.
722 *
723 * Returns zero on success; non-zero otherwise
724 */
725static int truncate_upper(struct dentry *dentry, struct iattr *ia,
726 struct iattr *lower_ia)
727{
728 int rc = 0;
729 struct inode *inode = d_inode(dentry);
730 struct ecryptfs_crypt_stat *crypt_stat;
731 loff_t i_size = i_size_read(inode);
732 loff_t lower_size_before_truncate;
733 loff_t lower_size_after_truncate;
734
735 if (unlikely((ia->ia_size == i_size))) {
736 lower_ia->ia_valid &= ~ATTR_SIZE;
737 return 0;
738 }
739 rc = ecryptfs_get_lower_file(dentry, inode);
740 if (rc)
741 return rc;
742 crypt_stat = &ecryptfs_inode_to_private(d_inode(dentry))->crypt_stat;
743 /* Switch on growing or shrinking file */
744 if (ia->ia_size > i_size) {
745 char zero[] = { 0x00 };
746
747 lower_ia->ia_valid &= ~ATTR_SIZE;
748 /* Write a single 0 at the last position of the file;
749 * this triggers code that will fill in 0's throughout
750 * the intermediate portion of the previous end of the
751 * file and the new and of the file */
752 rc = ecryptfs_write(inode, zero,
753 (ia->ia_size - 1), 1);
754 } else { /* ia->ia_size < i_size_read(inode) */
755 /* We're chopping off all the pages down to the page
756 * in which ia->ia_size is located. Fill in the end of
757 * that page from (ia->ia_size & ~PAGE_MASK) to
758 * PAGE_SIZE with zeros. */
759 size_t num_zeros = (PAGE_SIZE
760 - (ia->ia_size & ~PAGE_MASK));
761
762 if (!(crypt_stat->flags & ECRYPTFS_ENCRYPTED)) {
763 truncate_setsize(inode, ia->ia_size);
764 lower_ia->ia_size = ia->ia_size;
765 lower_ia->ia_valid |= ATTR_SIZE;
766 goto out;
767 }
768 if (num_zeros) {
769 char *zeros_virt;
770
771 zeros_virt = kzalloc(num_zeros, GFP_KERNEL);
772 if (!zeros_virt) {
773 rc = -ENOMEM;
774 goto out;
775 }
776 rc = ecryptfs_write(inode, zeros_virt,
777 ia->ia_size, num_zeros);
778 kfree(zeros_virt);
779 if (rc) {
780 printk(KERN_ERR "Error attempting to zero out "
781 "the remainder of the end page on "
782 "reducing truncate; rc = [%d]\n", rc);
783 goto out;
784 }
785 }
786 truncate_setsize(inode, ia->ia_size);
787 rc = ecryptfs_write_inode_size_to_metadata(inode);
788 if (rc) {
789 printk(KERN_ERR "Problem with "
790 "ecryptfs_write_inode_size_to_metadata; "
791 "rc = [%d]\n", rc);
792 goto out;
793 }
794 /* We are reducing the size of the ecryptfs file, and need to
795 * know if we need to reduce the size of the lower file. */
796 lower_size_before_truncate =
797 upper_size_to_lower_size(crypt_stat, i_size);
798 lower_size_after_truncate =
799 upper_size_to_lower_size(crypt_stat, ia->ia_size);
800 if (lower_size_after_truncate < lower_size_before_truncate) {
801 lower_ia->ia_size = lower_size_after_truncate;
802 lower_ia->ia_valid |= ATTR_SIZE;
803 } else
804 lower_ia->ia_valid &= ~ATTR_SIZE;
805 }
806out:
807 ecryptfs_put_lower_file(inode);
808 return rc;
809}
810
811static int ecryptfs_inode_newsize_ok(struct inode *inode, loff_t offset)
812{
813 struct ecryptfs_crypt_stat *crypt_stat;
814 loff_t lower_oldsize, lower_newsize;
815
816 crypt_stat = &ecryptfs_inode_to_private(inode)->crypt_stat;
817 lower_oldsize = upper_size_to_lower_size(crypt_stat,
818 i_size_read(inode));
819 lower_newsize = upper_size_to_lower_size(crypt_stat, offset);
820 if (lower_newsize > lower_oldsize) {
821 /*
822 * The eCryptfs inode and the new *lower* size are mixed here
823 * because we may not have the lower i_mutex held and/or it may
824 * not be appropriate to call inode_newsize_ok() with inodes
825 * from other filesystems.
826 */
827 return inode_newsize_ok(inode, lower_newsize);
828 }
829
830 return 0;
831}
832
833/**
834 * ecryptfs_truncate
835 * @dentry: The ecryptfs layer dentry
836 * @new_length: The length to expand the file to
837 *
838 * Simple function that handles the truncation of an eCryptfs inode and
839 * its corresponding lower inode.
840 *
841 * Returns zero on success; non-zero otherwise
842 */
843int ecryptfs_truncate(struct dentry *dentry, loff_t new_length)
844{
845 struct iattr ia = { .ia_valid = ATTR_SIZE, .ia_size = new_length };
846 struct iattr lower_ia = { .ia_valid = 0 };
847 int rc;
848
849 rc = ecryptfs_inode_newsize_ok(d_inode(dentry), new_length);
850 if (rc)
851 return rc;
852
853 rc = truncate_upper(dentry, &ia, &lower_ia);
854 if (!rc && lower_ia.ia_valid & ATTR_SIZE) {
855 struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
856
857 inode_lock(d_inode(lower_dentry));
858 rc = notify_change(lower_dentry, &lower_ia, NULL);
859 inode_unlock(d_inode(lower_dentry));
860 }
861 return rc;
862}
863
864static int
865ecryptfs_permission(struct inode *inode, int mask)
866{
867 return inode_permission(ecryptfs_inode_to_lower(inode), mask);
868}
869
870/**
871 * ecryptfs_setattr
872 * @dentry: dentry handle to the inode to modify
873 * @ia: Structure with flags of what to change and values
874 *
875 * Updates the metadata of an inode. If the update is to the size
876 * i.e. truncation, then ecryptfs_truncate will handle the size modification
877 * of both the ecryptfs inode and the lower inode.
878 *
879 * All other metadata changes will be passed right to the lower filesystem,
880 * and we will just update our inode to look like the lower.
881 */
882static int ecryptfs_setattr(struct dentry *dentry, struct iattr *ia)
883{
884 int rc = 0;
885 struct dentry *lower_dentry;
886 struct iattr lower_ia;
887 struct inode *inode;
888 struct inode *lower_inode;
889 struct ecryptfs_crypt_stat *crypt_stat;
890
891 crypt_stat = &ecryptfs_inode_to_private(d_inode(dentry))->crypt_stat;
892 if (!(crypt_stat->flags & ECRYPTFS_STRUCT_INITIALIZED)) {
893 rc = ecryptfs_init_crypt_stat(crypt_stat);
894 if (rc)
895 return rc;
896 }
897 inode = d_inode(dentry);
898 lower_inode = ecryptfs_inode_to_lower(inode);
899 lower_dentry = ecryptfs_dentry_to_lower(dentry);
900 mutex_lock(&crypt_stat->cs_mutex);
901 if (d_is_dir(dentry))
902 crypt_stat->flags &= ~(ECRYPTFS_ENCRYPTED);
903 else if (d_is_reg(dentry)
904 && (!(crypt_stat->flags & ECRYPTFS_POLICY_APPLIED)
905 || !(crypt_stat->flags & ECRYPTFS_KEY_VALID))) {
906 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
907
908 mount_crypt_stat = &ecryptfs_superblock_to_private(
909 dentry->d_sb)->mount_crypt_stat;
910 rc = ecryptfs_get_lower_file(dentry, inode);
911 if (rc) {
912 mutex_unlock(&crypt_stat->cs_mutex);
913 goto out;
914 }
915 rc = ecryptfs_read_metadata(dentry);
916 ecryptfs_put_lower_file(inode);
917 if (rc) {
918 if (!(mount_crypt_stat->flags
919 & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED)) {
920 rc = -EIO;
921 printk(KERN_WARNING "Either the lower file "
922 "is not in a valid eCryptfs format, "
923 "or the key could not be retrieved. "
924 "Plaintext passthrough mode is not "
925 "enabled; returning -EIO\n");
926 mutex_unlock(&crypt_stat->cs_mutex);
927 goto out;
928 }
929 rc = 0;
930 crypt_stat->flags &= ~(ECRYPTFS_I_SIZE_INITIALIZED
931 | ECRYPTFS_ENCRYPTED);
932 }
933 }
934 mutex_unlock(&crypt_stat->cs_mutex);
935
936 rc = setattr_prepare(dentry, ia);
937 if (rc)
938 goto out;
939 if (ia->ia_valid & ATTR_SIZE) {
940 rc = ecryptfs_inode_newsize_ok(inode, ia->ia_size);
941 if (rc)
942 goto out;
943 }
944
945 memcpy(&lower_ia, ia, sizeof(lower_ia));
946 if (ia->ia_valid & ATTR_FILE)
947 lower_ia.ia_file = ecryptfs_file_to_lower(ia->ia_file);
948 if (ia->ia_valid & ATTR_SIZE) {
949 rc = truncate_upper(dentry, ia, &lower_ia);
950 if (rc < 0)
951 goto out;
952 }
953
954 /*
955 * mode change is for clearing setuid/setgid bits. Allow lower fs
956 * to interpret this in its own way.
957 */
958 if (lower_ia.ia_valid & (ATTR_KILL_SUID | ATTR_KILL_SGID))
959 lower_ia.ia_valid &= ~ATTR_MODE;
960
961 inode_lock(d_inode(lower_dentry));
962 rc = notify_change(lower_dentry, &lower_ia, NULL);
963 inode_unlock(d_inode(lower_dentry));
964out:
965 fsstack_copy_attr_all(inode, lower_inode);
966 return rc;
967}
968
969static int ecryptfs_getattr_link(const struct path *path, struct kstat *stat,
970 u32 request_mask, unsigned int flags)
971{
972 struct dentry *dentry = path->dentry;
973 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
974 int rc = 0;
975
976 mount_crypt_stat = &ecryptfs_superblock_to_private(
977 dentry->d_sb)->mount_crypt_stat;
978 generic_fillattr(d_inode(dentry), stat);
979 if (mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES) {
980 char *target;
981 size_t targetsiz;
982
983 target = ecryptfs_readlink_lower(dentry, &targetsiz);
984 if (!IS_ERR(target)) {
985 kfree(target);
986 stat->size = targetsiz;
987 } else {
988 rc = PTR_ERR(target);
989 }
990 }
991 return rc;
992}
993
994static int ecryptfs_getattr(const struct path *path, struct kstat *stat,
995 u32 request_mask, unsigned int flags)
996{
997 struct dentry *dentry = path->dentry;
998 struct kstat lower_stat;
999 int rc;
1000
1001 rc = vfs_getattr(ecryptfs_dentry_to_lower_path(dentry), &lower_stat,
1002 request_mask, flags);
1003 if (!rc) {
1004 fsstack_copy_attr_all(d_inode(dentry),
1005 ecryptfs_inode_to_lower(d_inode(dentry)));
1006 generic_fillattr(d_inode(dentry), stat);
1007 stat->blocks = lower_stat.blocks;
1008 }
1009 return rc;
1010}
1011
1012int
1013ecryptfs_setxattr(struct dentry *dentry, struct inode *inode,
1014 const char *name, const void *value,
1015 size_t size, int flags)
1016{
1017 int rc;
1018 struct dentry *lower_dentry;
1019
1020 lower_dentry = ecryptfs_dentry_to_lower(dentry);
1021 if (!(d_inode(lower_dentry)->i_opflags & IOP_XATTR)) {
1022 rc = -EOPNOTSUPP;
1023 goto out;
1024 }
1025 rc = vfs_setxattr(lower_dentry, name, value, size, flags);
1026 if (!rc && inode)
1027 fsstack_copy_attr_all(inode, d_inode(lower_dentry));
1028out:
1029 return rc;
1030}
1031
1032ssize_t
1033ecryptfs_getxattr_lower(struct dentry *lower_dentry, struct inode *lower_inode,
1034 const char *name, void *value, size_t size)
1035{
1036 int rc;
1037
1038 if (!(lower_inode->i_opflags & IOP_XATTR)) {
1039 rc = -EOPNOTSUPP;
1040 goto out;
1041 }
1042 inode_lock(lower_inode);
1043 rc = __vfs_getxattr(lower_dentry, lower_inode, name, value, size);
1044 inode_unlock(lower_inode);
1045out:
1046 return rc;
1047}
1048
1049static ssize_t
1050ecryptfs_getxattr(struct dentry *dentry, struct inode *inode,
1051 const char *name, void *value, size_t size)
1052{
1053 return ecryptfs_getxattr_lower(ecryptfs_dentry_to_lower(dentry),
1054 ecryptfs_inode_to_lower(inode),
1055 name, value, size);
1056}
1057
1058static ssize_t
1059ecryptfs_listxattr(struct dentry *dentry, char *list, size_t size)
1060{
1061 int rc = 0;
1062 struct dentry *lower_dentry;
1063
1064 lower_dentry = ecryptfs_dentry_to_lower(dentry);
1065 if (!d_inode(lower_dentry)->i_op->listxattr) {
1066 rc = -EOPNOTSUPP;
1067 goto out;
1068 }
1069 inode_lock(d_inode(lower_dentry));
1070 rc = d_inode(lower_dentry)->i_op->listxattr(lower_dentry, list, size);
1071 inode_unlock(d_inode(lower_dentry));
1072out:
1073 return rc;
1074}
1075
1076static int ecryptfs_removexattr(struct dentry *dentry, struct inode *inode,
1077 const char *name)
1078{
1079 int rc;
1080 struct dentry *lower_dentry;
1081 struct inode *lower_inode;
1082
1083 lower_dentry = ecryptfs_dentry_to_lower(dentry);
1084 lower_inode = ecryptfs_inode_to_lower(inode);
1085 if (!(lower_inode->i_opflags & IOP_XATTR)) {
1086 rc = -EOPNOTSUPP;
1087 goto out;
1088 }
1089 inode_lock(lower_inode);
1090 rc = __vfs_removexattr(lower_dentry, name);
1091 inode_unlock(lower_inode);
1092out:
1093 return rc;
1094}
1095
1096const struct inode_operations ecryptfs_symlink_iops = {
1097 .get_link = ecryptfs_get_link,
1098 .permission = ecryptfs_permission,
1099 .setattr = ecryptfs_setattr,
1100 .getattr = ecryptfs_getattr_link,
1101 .listxattr = ecryptfs_listxattr,
1102};
1103
1104const struct inode_operations ecryptfs_dir_iops = {
1105 .create = ecryptfs_create,
1106 .lookup = ecryptfs_lookup,
1107 .link = ecryptfs_link,
1108 .unlink = ecryptfs_unlink,
1109 .symlink = ecryptfs_symlink,
1110 .mkdir = ecryptfs_mkdir,
1111 .rmdir = ecryptfs_rmdir,
1112 .mknod = ecryptfs_mknod,
1113 .rename = ecryptfs_rename,
1114 .permission = ecryptfs_permission,
1115 .setattr = ecryptfs_setattr,
1116 .listxattr = ecryptfs_listxattr,
1117};
1118
1119const struct inode_operations ecryptfs_main_iops = {
1120 .permission = ecryptfs_permission,
1121 .setattr = ecryptfs_setattr,
1122 .getattr = ecryptfs_getattr,
1123 .listxattr = ecryptfs_listxattr,
1124};
1125
1126static int ecryptfs_xattr_get(const struct xattr_handler *handler,
1127 struct dentry *dentry, struct inode *inode,
1128 const char *name, void *buffer, size_t size)
1129{
1130 return ecryptfs_getxattr(dentry, inode, name, buffer, size);
1131}
1132
1133static int ecryptfs_xattr_set(const struct xattr_handler *handler,
1134 struct dentry *dentry, struct inode *inode,
1135 const char *name, const void *value, size_t size,
1136 int flags)
1137{
1138 if (value)
1139 return ecryptfs_setxattr(dentry, inode, name, value, size, flags);
1140 else {
1141 BUG_ON(flags != XATTR_REPLACE);
1142 return ecryptfs_removexattr(dentry, inode, name);
1143 }
1144}
1145
1146static const struct xattr_handler ecryptfs_xattr_handler = {
1147 .prefix = "", /* match anything */
1148 .get = ecryptfs_xattr_get,
1149 .set = ecryptfs_xattr_set,
1150};
1151
1152const struct xattr_handler *ecryptfs_xattr_handlers[] = {
1153 &ecryptfs_xattr_handler,
1154 NULL
1155};
1/**
2 * eCryptfs: Linux filesystem encryption layer
3 *
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>
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/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"
38
39static struct dentry *lock_parent(struct dentry *dentry)
40{
41 struct dentry *dir;
42
43 dir = dget_parent(dentry);
44 mutex_lock_nested(&(dir->d_inode->i_mutex), I_MUTEX_PARENT);
45 return dir;
46}
47
48static void unlock_dir(struct dentry *dir)
49{
50 mutex_unlock(&dir->d_inode->i_mutex);
51 dput(dir);
52}
53
54static int ecryptfs_inode_test(struct inode *inode, void *lower_inode)
55{
56 if (ecryptfs_inode_to_lower(inode) == (struct inode *)lower_inode)
57 return 1;
58 return 0;
59}
60
61static int ecryptfs_inode_set(struct inode *inode, void *opaque)
62{
63 struct inode *lower_inode = opaque;
64
65 ecryptfs_set_inode_lower(inode, lower_inode);
66 fsstack_copy_attr_all(inode, lower_inode);
67 /* i_size will be overwritten for encrypted regular files */
68 fsstack_copy_inode_size(inode, lower_inode);
69 inode->i_ino = lower_inode->i_ino;
70 inode->i_version++;
71 inode->i_mapping->a_ops = &ecryptfs_aops;
72 inode->i_mapping->backing_dev_info = inode->i_sb->s_bdi;
73
74 if (S_ISLNK(inode->i_mode))
75 inode->i_op = &ecryptfs_symlink_iops;
76 else if (S_ISDIR(inode->i_mode))
77 inode->i_op = &ecryptfs_dir_iops;
78 else
79 inode->i_op = &ecryptfs_main_iops;
80
81 if (S_ISDIR(inode->i_mode))
82 inode->i_fop = &ecryptfs_dir_fops;
83 else if (special_file(inode->i_mode))
84 init_special_inode(inode, inode->i_mode, inode->i_rdev);
85 else
86 inode->i_fop = &ecryptfs_main_fops;
87
88 return 0;
89}
90
91static struct inode *__ecryptfs_get_inode(struct inode *lower_inode,
92 struct super_block *sb)
93{
94 struct inode *inode;
95
96 if (lower_inode->i_sb != ecryptfs_superblock_to_lower(sb))
97 return ERR_PTR(-EXDEV);
98 if (!igrab(lower_inode))
99 return ERR_PTR(-ESTALE);
100 inode = iget5_locked(sb, (unsigned long)lower_inode,
101 ecryptfs_inode_test, ecryptfs_inode_set,
102 lower_inode);
103 if (!inode) {
104 iput(lower_inode);
105 return ERR_PTR(-EACCES);
106 }
107 if (!(inode->i_state & I_NEW))
108 iput(lower_inode);
109
110 return inode;
111}
112
113struct inode *ecryptfs_get_inode(struct inode *lower_inode,
114 struct super_block *sb)
115{
116 struct inode *inode = __ecryptfs_get_inode(lower_inode, sb);
117
118 if (!IS_ERR(inode) && (inode->i_state & I_NEW))
119 unlock_new_inode(inode);
120
121 return inode;
122}
123
124/**
125 * ecryptfs_interpose
126 * @lower_dentry: Existing dentry in the lower filesystem
127 * @dentry: ecryptfs' dentry
128 * @sb: ecryptfs's super_block
129 *
130 * Interposes upper and lower dentries.
131 *
132 * Returns zero on success; non-zero otherwise
133 */
134static int ecryptfs_interpose(struct dentry *lower_dentry,
135 struct dentry *dentry, struct super_block *sb)
136{
137 struct inode *inode = ecryptfs_get_inode(lower_dentry->d_inode, sb);
138
139 if (IS_ERR(inode))
140 return PTR_ERR(inode);
141 d_instantiate(dentry, inode);
142
143 return 0;
144}
145
146static int ecryptfs_do_unlink(struct inode *dir, struct dentry *dentry,
147 struct inode *inode)
148{
149 struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
150 struct inode *lower_dir_inode = ecryptfs_inode_to_lower(dir);
151 struct dentry *lower_dir_dentry;
152 int rc;
153
154 dget(lower_dentry);
155 lower_dir_dentry = lock_parent(lower_dentry);
156 rc = vfs_unlink(lower_dir_inode, lower_dentry, NULL);
157 if (rc) {
158 printk(KERN_ERR "Error in vfs_unlink; rc = [%d]\n", rc);
159 goto out_unlock;
160 }
161 fsstack_copy_attr_times(dir, lower_dir_inode);
162 set_nlink(inode, ecryptfs_inode_to_lower(inode)->i_nlink);
163 inode->i_ctime = dir->i_ctime;
164 d_drop(dentry);
165out_unlock:
166 unlock_dir(lower_dir_dentry);
167 dput(lower_dentry);
168 return rc;
169}
170
171/**
172 * ecryptfs_do_create
173 * @directory_inode: inode of the new file's dentry's parent in ecryptfs
174 * @ecryptfs_dentry: New file's dentry in ecryptfs
175 * @mode: The mode of the new file
176 * @nd: nameidata of ecryptfs' parent's dentry & vfsmount
177 *
178 * Creates the underlying file and the eCryptfs inode which will link to
179 * it. It will also update the eCryptfs directory inode to mimic the
180 * stat of the lower directory inode.
181 *
182 * Returns the new eCryptfs inode on success; an ERR_PTR on error condition
183 */
184static struct inode *
185ecryptfs_do_create(struct inode *directory_inode,
186 struct dentry *ecryptfs_dentry, umode_t mode)
187{
188 int rc;
189 struct dentry *lower_dentry;
190 struct dentry *lower_dir_dentry;
191 struct inode *inode;
192
193 lower_dentry = ecryptfs_dentry_to_lower(ecryptfs_dentry);
194 lower_dir_dentry = lock_parent(lower_dentry);
195 if (IS_ERR(lower_dir_dentry)) {
196 ecryptfs_printk(KERN_ERR, "Error locking directory of "
197 "dentry\n");
198 inode = ERR_CAST(lower_dir_dentry);
199 goto out;
200 }
201 rc = vfs_create(lower_dir_dentry->d_inode, lower_dentry, mode, true);
202 if (rc) {
203 printk(KERN_ERR "%s: Failure to create dentry in lower fs; "
204 "rc = [%d]\n", __func__, rc);
205 inode = ERR_PTR(rc);
206 goto out_lock;
207 }
208 inode = __ecryptfs_get_inode(lower_dentry->d_inode,
209 directory_inode->i_sb);
210 if (IS_ERR(inode)) {
211 vfs_unlink(lower_dir_dentry->d_inode, lower_dentry, NULL);
212 goto out_lock;
213 }
214 fsstack_copy_attr_times(directory_inode, lower_dir_dentry->d_inode);
215 fsstack_copy_inode_size(directory_inode, lower_dir_dentry->d_inode);
216out_lock:
217 unlock_dir(lower_dir_dentry);
218out:
219 return inode;
220}
221
222/**
223 * ecryptfs_initialize_file
224 *
225 * Cause the file to be changed from a basic empty file to an ecryptfs
226 * file with a header and first data page.
227 *
228 * Returns zero on success
229 */
230int ecryptfs_initialize_file(struct dentry *ecryptfs_dentry,
231 struct inode *ecryptfs_inode)
232{
233 struct ecryptfs_crypt_stat *crypt_stat =
234 &ecryptfs_inode_to_private(ecryptfs_inode)->crypt_stat;
235 int rc = 0;
236
237 if (S_ISDIR(ecryptfs_inode->i_mode)) {
238 ecryptfs_printk(KERN_DEBUG, "This is a directory\n");
239 crypt_stat->flags &= ~(ECRYPTFS_ENCRYPTED);
240 goto out;
241 }
242 ecryptfs_printk(KERN_DEBUG, "Initializing crypto context\n");
243 rc = ecryptfs_new_file_context(ecryptfs_inode);
244 if (rc) {
245 ecryptfs_printk(KERN_ERR, "Error creating new file "
246 "context; rc = [%d]\n", rc);
247 goto out;
248 }
249 rc = ecryptfs_get_lower_file(ecryptfs_dentry, ecryptfs_inode);
250 if (rc) {
251 printk(KERN_ERR "%s: Error attempting to initialize "
252 "the lower file for the dentry with name "
253 "[%s]; rc = [%d]\n", __func__,
254 ecryptfs_dentry->d_name.name, rc);
255 goto out;
256 }
257 rc = ecryptfs_write_metadata(ecryptfs_dentry, ecryptfs_inode);
258 if (rc)
259 printk(KERN_ERR "Error writing headers; rc = [%d]\n", rc);
260 ecryptfs_put_lower_file(ecryptfs_inode);
261out:
262 return rc;
263}
264
265/**
266 * ecryptfs_create
267 * @dir: The inode of the directory in which to create the file.
268 * @dentry: The eCryptfs dentry
269 * @mode: The mode of the new file.
270 *
271 * Creates a new file.
272 *
273 * Returns zero on success; non-zero on error condition
274 */
275static int
276ecryptfs_create(struct inode *directory_inode, struct dentry *ecryptfs_dentry,
277 umode_t mode, bool excl)
278{
279 struct inode *ecryptfs_inode;
280 int rc;
281
282 ecryptfs_inode = ecryptfs_do_create(directory_inode, ecryptfs_dentry,
283 mode);
284 if (unlikely(IS_ERR(ecryptfs_inode))) {
285 ecryptfs_printk(KERN_WARNING, "Failed to create file in"
286 "lower filesystem\n");
287 rc = PTR_ERR(ecryptfs_inode);
288 goto out;
289 }
290 /* At this point, a file exists on "disk"; we need to make sure
291 * that this on disk file is prepared to be an ecryptfs file */
292 rc = ecryptfs_initialize_file(ecryptfs_dentry, ecryptfs_inode);
293 if (rc) {
294 ecryptfs_do_unlink(directory_inode, ecryptfs_dentry,
295 ecryptfs_inode);
296 make_bad_inode(ecryptfs_inode);
297 unlock_new_inode(ecryptfs_inode);
298 iput(ecryptfs_inode);
299 goto out;
300 }
301 unlock_new_inode(ecryptfs_inode);
302 d_instantiate(ecryptfs_dentry, ecryptfs_inode);
303out:
304 return rc;
305}
306
307static int ecryptfs_i_size_read(struct dentry *dentry, struct inode *inode)
308{
309 struct ecryptfs_crypt_stat *crypt_stat;
310 int rc;
311
312 rc = ecryptfs_get_lower_file(dentry, inode);
313 if (rc) {
314 printk(KERN_ERR "%s: Error attempting to initialize "
315 "the lower file for the dentry with name "
316 "[%s]; rc = [%d]\n", __func__,
317 dentry->d_name.name, rc);
318 return rc;
319 }
320
321 crypt_stat = &ecryptfs_inode_to_private(inode)->crypt_stat;
322 /* TODO: lock for crypt_stat comparison */
323 if (!(crypt_stat->flags & ECRYPTFS_POLICY_APPLIED))
324 ecryptfs_set_default_sizes(crypt_stat);
325
326 rc = ecryptfs_read_and_validate_header_region(inode);
327 ecryptfs_put_lower_file(inode);
328 if (rc) {
329 rc = ecryptfs_read_and_validate_xattr_region(dentry, inode);
330 if (!rc)
331 crypt_stat->flags |= ECRYPTFS_METADATA_IN_XATTR;
332 }
333
334 /* Must return 0 to allow non-eCryptfs files to be looked up, too */
335 return 0;
336}
337
338/**
339 * ecryptfs_lookup_interpose - Dentry interposition for a lookup
340 */
341static int ecryptfs_lookup_interpose(struct dentry *dentry,
342 struct dentry *lower_dentry,
343 struct inode *dir_inode)
344{
345 struct inode *inode, *lower_inode = lower_dentry->d_inode;
346 struct ecryptfs_dentry_info *dentry_info;
347 struct vfsmount *lower_mnt;
348 int rc = 0;
349
350 dentry_info = kmem_cache_alloc(ecryptfs_dentry_info_cache, GFP_KERNEL);
351 if (!dentry_info) {
352 printk(KERN_ERR "%s: Out of memory whilst attempting "
353 "to allocate ecryptfs_dentry_info struct\n",
354 __func__);
355 dput(lower_dentry);
356 return -ENOMEM;
357 }
358
359 lower_mnt = mntget(ecryptfs_dentry_to_lower_mnt(dentry->d_parent));
360 fsstack_copy_attr_atime(dir_inode, lower_dentry->d_parent->d_inode);
361 BUG_ON(!d_count(lower_dentry));
362
363 ecryptfs_set_dentry_private(dentry, dentry_info);
364 dentry_info->lower_path.mnt = lower_mnt;
365 dentry_info->lower_path.dentry = lower_dentry;
366
367 if (!lower_dentry->d_inode) {
368 /* We want to add because we couldn't find in lower */
369 d_add(dentry, NULL);
370 return 0;
371 }
372 inode = __ecryptfs_get_inode(lower_inode, dir_inode->i_sb);
373 if (IS_ERR(inode)) {
374 printk(KERN_ERR "%s: Error interposing; rc = [%ld]\n",
375 __func__, PTR_ERR(inode));
376 return PTR_ERR(inode);
377 }
378 if (S_ISREG(inode->i_mode)) {
379 rc = ecryptfs_i_size_read(dentry, inode);
380 if (rc) {
381 make_bad_inode(inode);
382 return rc;
383 }
384 }
385
386 if (inode->i_state & I_NEW)
387 unlock_new_inode(inode);
388 d_add(dentry, inode);
389
390 return rc;
391}
392
393/**
394 * ecryptfs_lookup
395 * @ecryptfs_dir_inode: The eCryptfs directory inode
396 * @ecryptfs_dentry: The eCryptfs dentry that we are looking up
397 * @ecryptfs_nd: nameidata; may be NULL
398 *
399 * Find a file on disk. If the file does not exist, then we'll add it to the
400 * dentry cache and continue on to read it from the disk.
401 */
402static struct dentry *ecryptfs_lookup(struct inode *ecryptfs_dir_inode,
403 struct dentry *ecryptfs_dentry,
404 unsigned int flags)
405{
406 char *encrypted_and_encoded_name = NULL;
407 size_t encrypted_and_encoded_name_size;
408 struct ecryptfs_mount_crypt_stat *mount_crypt_stat = NULL;
409 struct dentry *lower_dir_dentry, *lower_dentry;
410 int rc = 0;
411
412 lower_dir_dentry = ecryptfs_dentry_to_lower(ecryptfs_dentry->d_parent);
413 mutex_lock(&lower_dir_dentry->d_inode->i_mutex);
414 lower_dentry = lookup_one_len(ecryptfs_dentry->d_name.name,
415 lower_dir_dentry,
416 ecryptfs_dentry->d_name.len);
417 mutex_unlock(&lower_dir_dentry->d_inode->i_mutex);
418 if (IS_ERR(lower_dentry)) {
419 rc = PTR_ERR(lower_dentry);
420 ecryptfs_printk(KERN_DEBUG, "%s: lookup_one_len() returned "
421 "[%d] on lower_dentry = [%s]\n", __func__, rc,
422 ecryptfs_dentry->d_name.name);
423 goto out;
424 }
425 if (lower_dentry->d_inode)
426 goto interpose;
427 mount_crypt_stat = &ecryptfs_superblock_to_private(
428 ecryptfs_dentry->d_sb)->mount_crypt_stat;
429 if (!(mount_crypt_stat
430 && (mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES)))
431 goto interpose;
432 dput(lower_dentry);
433 rc = ecryptfs_encrypt_and_encode_filename(
434 &encrypted_and_encoded_name, &encrypted_and_encoded_name_size,
435 NULL, mount_crypt_stat, ecryptfs_dentry->d_name.name,
436 ecryptfs_dentry->d_name.len);
437 if (rc) {
438 printk(KERN_ERR "%s: Error attempting to encrypt and encode "
439 "filename; rc = [%d]\n", __func__, rc);
440 goto out;
441 }
442 mutex_lock(&lower_dir_dentry->d_inode->i_mutex);
443 lower_dentry = lookup_one_len(encrypted_and_encoded_name,
444 lower_dir_dentry,
445 encrypted_and_encoded_name_size);
446 mutex_unlock(&lower_dir_dentry->d_inode->i_mutex);
447 if (IS_ERR(lower_dentry)) {
448 rc = PTR_ERR(lower_dentry);
449 ecryptfs_printk(KERN_DEBUG, "%s: lookup_one_len() returned "
450 "[%d] on lower_dentry = [%s]\n", __func__, rc,
451 encrypted_and_encoded_name);
452 goto out;
453 }
454interpose:
455 rc = ecryptfs_lookup_interpose(ecryptfs_dentry, lower_dentry,
456 ecryptfs_dir_inode);
457out:
458 kfree(encrypted_and_encoded_name);
459 return ERR_PTR(rc);
460}
461
462static int ecryptfs_link(struct dentry *old_dentry, struct inode *dir,
463 struct dentry *new_dentry)
464{
465 struct dentry *lower_old_dentry;
466 struct dentry *lower_new_dentry;
467 struct dentry *lower_dir_dentry;
468 u64 file_size_save;
469 int rc;
470
471 file_size_save = i_size_read(old_dentry->d_inode);
472 lower_old_dentry = ecryptfs_dentry_to_lower(old_dentry);
473 lower_new_dentry = ecryptfs_dentry_to_lower(new_dentry);
474 dget(lower_old_dentry);
475 dget(lower_new_dentry);
476 lower_dir_dentry = lock_parent(lower_new_dentry);
477 rc = vfs_link(lower_old_dentry, lower_dir_dentry->d_inode,
478 lower_new_dentry, NULL);
479 if (rc || !lower_new_dentry->d_inode)
480 goto out_lock;
481 rc = ecryptfs_interpose(lower_new_dentry, new_dentry, dir->i_sb);
482 if (rc)
483 goto out_lock;
484 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
485 fsstack_copy_inode_size(dir, lower_dir_dentry->d_inode);
486 set_nlink(old_dentry->d_inode,
487 ecryptfs_inode_to_lower(old_dentry->d_inode)->i_nlink);
488 i_size_write(new_dentry->d_inode, file_size_save);
489out_lock:
490 unlock_dir(lower_dir_dentry);
491 dput(lower_new_dentry);
492 dput(lower_old_dentry);
493 return rc;
494}
495
496static int ecryptfs_unlink(struct inode *dir, struct dentry *dentry)
497{
498 return ecryptfs_do_unlink(dir, dentry, dentry->d_inode);
499}
500
501static int ecryptfs_symlink(struct inode *dir, struct dentry *dentry,
502 const char *symname)
503{
504 int rc;
505 struct dentry *lower_dentry;
506 struct dentry *lower_dir_dentry;
507 char *encoded_symname;
508 size_t encoded_symlen;
509 struct ecryptfs_mount_crypt_stat *mount_crypt_stat = NULL;
510
511 lower_dentry = ecryptfs_dentry_to_lower(dentry);
512 dget(lower_dentry);
513 lower_dir_dentry = lock_parent(lower_dentry);
514 mount_crypt_stat = &ecryptfs_superblock_to_private(
515 dir->i_sb)->mount_crypt_stat;
516 rc = ecryptfs_encrypt_and_encode_filename(&encoded_symname,
517 &encoded_symlen,
518 NULL,
519 mount_crypt_stat, symname,
520 strlen(symname));
521 if (rc)
522 goto out_lock;
523 rc = vfs_symlink(lower_dir_dentry->d_inode, lower_dentry,
524 encoded_symname);
525 kfree(encoded_symname);
526 if (rc || !lower_dentry->d_inode)
527 goto out_lock;
528 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb);
529 if (rc)
530 goto out_lock;
531 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
532 fsstack_copy_inode_size(dir, lower_dir_dentry->d_inode);
533out_lock:
534 unlock_dir(lower_dir_dentry);
535 dput(lower_dentry);
536 if (!dentry->d_inode)
537 d_drop(dentry);
538 return rc;
539}
540
541static int ecryptfs_mkdir(struct inode *dir, struct dentry *dentry, umode_t mode)
542{
543 int rc;
544 struct dentry *lower_dentry;
545 struct dentry *lower_dir_dentry;
546
547 lower_dentry = ecryptfs_dentry_to_lower(dentry);
548 lower_dir_dentry = lock_parent(lower_dentry);
549 rc = vfs_mkdir(lower_dir_dentry->d_inode, lower_dentry, mode);
550 if (rc || !lower_dentry->d_inode)
551 goto out;
552 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb);
553 if (rc)
554 goto out;
555 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
556 fsstack_copy_inode_size(dir, lower_dir_dentry->d_inode);
557 set_nlink(dir, lower_dir_dentry->d_inode->i_nlink);
558out:
559 unlock_dir(lower_dir_dentry);
560 if (!dentry->d_inode)
561 d_drop(dentry);
562 return rc;
563}
564
565static int ecryptfs_rmdir(struct inode *dir, struct dentry *dentry)
566{
567 struct dentry *lower_dentry;
568 struct dentry *lower_dir_dentry;
569 int rc;
570
571 lower_dentry = ecryptfs_dentry_to_lower(dentry);
572 dget(dentry);
573 lower_dir_dentry = lock_parent(lower_dentry);
574 dget(lower_dentry);
575 rc = vfs_rmdir(lower_dir_dentry->d_inode, lower_dentry);
576 dput(lower_dentry);
577 if (!rc && dentry->d_inode)
578 clear_nlink(dentry->d_inode);
579 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
580 set_nlink(dir, lower_dir_dentry->d_inode->i_nlink);
581 unlock_dir(lower_dir_dentry);
582 if (!rc)
583 d_drop(dentry);
584 dput(dentry);
585 return rc;
586}
587
588static int
589ecryptfs_mknod(struct inode *dir, struct dentry *dentry, umode_t mode, dev_t dev)
590{
591 int rc;
592 struct dentry *lower_dentry;
593 struct dentry *lower_dir_dentry;
594
595 lower_dentry = ecryptfs_dentry_to_lower(dentry);
596 lower_dir_dentry = lock_parent(lower_dentry);
597 rc = vfs_mknod(lower_dir_dentry->d_inode, lower_dentry, mode, dev);
598 if (rc || !lower_dentry->d_inode)
599 goto out;
600 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb);
601 if (rc)
602 goto out;
603 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
604 fsstack_copy_inode_size(dir, lower_dir_dentry->d_inode);
605out:
606 unlock_dir(lower_dir_dentry);
607 if (!dentry->d_inode)
608 d_drop(dentry);
609 return rc;
610}
611
612static int
613ecryptfs_rename(struct inode *old_dir, struct dentry *old_dentry,
614 struct inode *new_dir, struct dentry *new_dentry)
615{
616 int rc;
617 struct dentry *lower_old_dentry;
618 struct dentry *lower_new_dentry;
619 struct dentry *lower_old_dir_dentry;
620 struct dentry *lower_new_dir_dentry;
621 struct dentry *trap = NULL;
622 struct inode *target_inode;
623
624 lower_old_dentry = ecryptfs_dentry_to_lower(old_dentry);
625 lower_new_dentry = ecryptfs_dentry_to_lower(new_dentry);
626 dget(lower_old_dentry);
627 dget(lower_new_dentry);
628 lower_old_dir_dentry = dget_parent(lower_old_dentry);
629 lower_new_dir_dentry = dget_parent(lower_new_dentry);
630 target_inode = new_dentry->d_inode;
631 trap = lock_rename(lower_old_dir_dentry, lower_new_dir_dentry);
632 /* source should not be ancestor of target */
633 if (trap == lower_old_dentry) {
634 rc = -EINVAL;
635 goto out_lock;
636 }
637 /* target should not be ancestor of source */
638 if (trap == lower_new_dentry) {
639 rc = -ENOTEMPTY;
640 goto out_lock;
641 }
642 rc = vfs_rename(lower_old_dir_dentry->d_inode, lower_old_dentry,
643 lower_new_dir_dentry->d_inode, lower_new_dentry,
644 NULL, 0);
645 if (rc)
646 goto out_lock;
647 if (target_inode)
648 fsstack_copy_attr_all(target_inode,
649 ecryptfs_inode_to_lower(target_inode));
650 fsstack_copy_attr_all(new_dir, lower_new_dir_dentry->d_inode);
651 if (new_dir != old_dir)
652 fsstack_copy_attr_all(old_dir, lower_old_dir_dentry->d_inode);
653out_lock:
654 unlock_rename(lower_old_dir_dentry, lower_new_dir_dentry);
655 dput(lower_new_dir_dentry);
656 dput(lower_old_dir_dentry);
657 dput(lower_new_dentry);
658 dput(lower_old_dentry);
659 return rc;
660}
661
662static char *ecryptfs_readlink_lower(struct dentry *dentry, size_t *bufsiz)
663{
664 struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
665 char *lower_buf;
666 char *buf;
667 mm_segment_t old_fs;
668 int rc;
669
670 lower_buf = kmalloc(PATH_MAX, GFP_KERNEL);
671 if (!lower_buf)
672 return ERR_PTR(-ENOMEM);
673 old_fs = get_fs();
674 set_fs(get_ds());
675 rc = lower_dentry->d_inode->i_op->readlink(lower_dentry,
676 (char __user *)lower_buf,
677 PATH_MAX);
678 set_fs(old_fs);
679 if (rc < 0)
680 goto out;
681 rc = ecryptfs_decode_and_decrypt_filename(&buf, bufsiz, dentry->d_sb,
682 lower_buf, rc);
683out:
684 kfree(lower_buf);
685 return rc ? ERR_PTR(rc) : buf;
686}
687
688static void *ecryptfs_follow_link(struct dentry *dentry, struct nameidata *nd)
689{
690 size_t len;
691 char *buf = ecryptfs_readlink_lower(dentry, &len);
692 if (IS_ERR(buf))
693 goto out;
694 fsstack_copy_attr_atime(dentry->d_inode,
695 ecryptfs_dentry_to_lower(dentry)->d_inode);
696 buf[len] = '\0';
697out:
698 nd_set_link(nd, buf);
699 return NULL;
700}
701
702/**
703 * upper_size_to_lower_size
704 * @crypt_stat: Crypt_stat associated with file
705 * @upper_size: Size of the upper file
706 *
707 * Calculate the required size of the lower file based on the
708 * specified size of the upper file. This calculation is based on the
709 * number of headers in the underlying file and the extent size.
710 *
711 * Returns Calculated size of the lower file.
712 */
713static loff_t
714upper_size_to_lower_size(struct ecryptfs_crypt_stat *crypt_stat,
715 loff_t upper_size)
716{
717 loff_t lower_size;
718
719 lower_size = ecryptfs_lower_header_size(crypt_stat);
720 if (upper_size != 0) {
721 loff_t num_extents;
722
723 num_extents = upper_size >> crypt_stat->extent_shift;
724 if (upper_size & ~crypt_stat->extent_mask)
725 num_extents++;
726 lower_size += (num_extents * crypt_stat->extent_size);
727 }
728 return lower_size;
729}
730
731/**
732 * truncate_upper
733 * @dentry: The ecryptfs layer dentry
734 * @ia: Address of the ecryptfs inode's attributes
735 * @lower_ia: Address of the lower inode's attributes
736 *
737 * Function to handle truncations modifying the size of the file. Note
738 * that the file sizes are interpolated. When expanding, we are simply
739 * writing strings of 0's out. When truncating, we truncate the upper
740 * inode and update the lower_ia according to the page index
741 * interpolations. If ATTR_SIZE is set in lower_ia->ia_valid upon return,
742 * the caller must use lower_ia in a call to notify_change() to perform
743 * the truncation of the lower inode.
744 *
745 * Returns zero on success; non-zero otherwise
746 */
747static int truncate_upper(struct dentry *dentry, struct iattr *ia,
748 struct iattr *lower_ia)
749{
750 int rc = 0;
751 struct inode *inode = dentry->d_inode;
752 struct ecryptfs_crypt_stat *crypt_stat;
753 loff_t i_size = i_size_read(inode);
754 loff_t lower_size_before_truncate;
755 loff_t lower_size_after_truncate;
756
757 if (unlikely((ia->ia_size == i_size))) {
758 lower_ia->ia_valid &= ~ATTR_SIZE;
759 return 0;
760 }
761 rc = ecryptfs_get_lower_file(dentry, inode);
762 if (rc)
763 return rc;
764 crypt_stat = &ecryptfs_inode_to_private(dentry->d_inode)->crypt_stat;
765 /* Switch on growing or shrinking file */
766 if (ia->ia_size > i_size) {
767 char zero[] = { 0x00 };
768
769 lower_ia->ia_valid &= ~ATTR_SIZE;
770 /* Write a single 0 at the last position of the file;
771 * this triggers code that will fill in 0's throughout
772 * the intermediate portion of the previous end of the
773 * file and the new and of the file */
774 rc = ecryptfs_write(inode, zero,
775 (ia->ia_size - 1), 1);
776 } else { /* ia->ia_size < i_size_read(inode) */
777 /* We're chopping off all the pages down to the page
778 * in which ia->ia_size is located. Fill in the end of
779 * that page from (ia->ia_size & ~PAGE_CACHE_MASK) to
780 * PAGE_CACHE_SIZE with zeros. */
781 size_t num_zeros = (PAGE_CACHE_SIZE
782 - (ia->ia_size & ~PAGE_CACHE_MASK));
783
784 if (!(crypt_stat->flags & ECRYPTFS_ENCRYPTED)) {
785 truncate_setsize(inode, ia->ia_size);
786 lower_ia->ia_size = ia->ia_size;
787 lower_ia->ia_valid |= ATTR_SIZE;
788 goto out;
789 }
790 if (num_zeros) {
791 char *zeros_virt;
792
793 zeros_virt = kzalloc(num_zeros, GFP_KERNEL);
794 if (!zeros_virt) {
795 rc = -ENOMEM;
796 goto out;
797 }
798 rc = ecryptfs_write(inode, zeros_virt,
799 ia->ia_size, num_zeros);
800 kfree(zeros_virt);
801 if (rc) {
802 printk(KERN_ERR "Error attempting to zero out "
803 "the remainder of the end page on "
804 "reducing truncate; rc = [%d]\n", rc);
805 goto out;
806 }
807 }
808 truncate_setsize(inode, ia->ia_size);
809 rc = ecryptfs_write_inode_size_to_metadata(inode);
810 if (rc) {
811 printk(KERN_ERR "Problem with "
812 "ecryptfs_write_inode_size_to_metadata; "
813 "rc = [%d]\n", rc);
814 goto out;
815 }
816 /* We are reducing the size of the ecryptfs file, and need to
817 * know if we need to reduce the size of the lower file. */
818 lower_size_before_truncate =
819 upper_size_to_lower_size(crypt_stat, i_size);
820 lower_size_after_truncate =
821 upper_size_to_lower_size(crypt_stat, ia->ia_size);
822 if (lower_size_after_truncate < lower_size_before_truncate) {
823 lower_ia->ia_size = lower_size_after_truncate;
824 lower_ia->ia_valid |= ATTR_SIZE;
825 } else
826 lower_ia->ia_valid &= ~ATTR_SIZE;
827 }
828out:
829 ecryptfs_put_lower_file(inode);
830 return rc;
831}
832
833static int ecryptfs_inode_newsize_ok(struct inode *inode, loff_t offset)
834{
835 struct ecryptfs_crypt_stat *crypt_stat;
836 loff_t lower_oldsize, lower_newsize;
837
838 crypt_stat = &ecryptfs_inode_to_private(inode)->crypt_stat;
839 lower_oldsize = upper_size_to_lower_size(crypt_stat,
840 i_size_read(inode));
841 lower_newsize = upper_size_to_lower_size(crypt_stat, offset);
842 if (lower_newsize > lower_oldsize) {
843 /*
844 * The eCryptfs inode and the new *lower* size are mixed here
845 * because we may not have the lower i_mutex held and/or it may
846 * not be appropriate to call inode_newsize_ok() with inodes
847 * from other filesystems.
848 */
849 return inode_newsize_ok(inode, lower_newsize);
850 }
851
852 return 0;
853}
854
855/**
856 * ecryptfs_truncate
857 * @dentry: The ecryptfs layer dentry
858 * @new_length: The length to expand the file to
859 *
860 * Simple function that handles the truncation of an eCryptfs inode and
861 * its corresponding lower inode.
862 *
863 * Returns zero on success; non-zero otherwise
864 */
865int ecryptfs_truncate(struct dentry *dentry, loff_t new_length)
866{
867 struct iattr ia = { .ia_valid = ATTR_SIZE, .ia_size = new_length };
868 struct iattr lower_ia = { .ia_valid = 0 };
869 int rc;
870
871 rc = ecryptfs_inode_newsize_ok(dentry->d_inode, new_length);
872 if (rc)
873 return rc;
874
875 rc = truncate_upper(dentry, &ia, &lower_ia);
876 if (!rc && lower_ia.ia_valid & ATTR_SIZE) {
877 struct dentry *lower_dentry = ecryptfs_dentry_to_lower(dentry);
878
879 mutex_lock(&lower_dentry->d_inode->i_mutex);
880 rc = notify_change(lower_dentry, &lower_ia, NULL);
881 mutex_unlock(&lower_dentry->d_inode->i_mutex);
882 }
883 return rc;
884}
885
886static int
887ecryptfs_permission(struct inode *inode, int mask)
888{
889 return inode_permission(ecryptfs_inode_to_lower(inode), mask);
890}
891
892/**
893 * ecryptfs_setattr
894 * @dentry: dentry handle to the inode to modify
895 * @ia: Structure with flags of what to change and values
896 *
897 * Updates the metadata of an inode. If the update is to the size
898 * i.e. truncation, then ecryptfs_truncate will handle the size modification
899 * of both the ecryptfs inode and the lower inode.
900 *
901 * All other metadata changes will be passed right to the lower filesystem,
902 * and we will just update our inode to look like the lower.
903 */
904static int ecryptfs_setattr(struct dentry *dentry, struct iattr *ia)
905{
906 int rc = 0;
907 struct dentry *lower_dentry;
908 struct iattr lower_ia;
909 struct inode *inode;
910 struct inode *lower_inode;
911 struct ecryptfs_crypt_stat *crypt_stat;
912
913 crypt_stat = &ecryptfs_inode_to_private(dentry->d_inode)->crypt_stat;
914 if (!(crypt_stat->flags & ECRYPTFS_STRUCT_INITIALIZED))
915 ecryptfs_init_crypt_stat(crypt_stat);
916 inode = dentry->d_inode;
917 lower_inode = ecryptfs_inode_to_lower(inode);
918 lower_dentry = ecryptfs_dentry_to_lower(dentry);
919 mutex_lock(&crypt_stat->cs_mutex);
920 if (S_ISDIR(dentry->d_inode->i_mode))
921 crypt_stat->flags &= ~(ECRYPTFS_ENCRYPTED);
922 else if (S_ISREG(dentry->d_inode->i_mode)
923 && (!(crypt_stat->flags & ECRYPTFS_POLICY_APPLIED)
924 || !(crypt_stat->flags & ECRYPTFS_KEY_VALID))) {
925 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
926
927 mount_crypt_stat = &ecryptfs_superblock_to_private(
928 dentry->d_sb)->mount_crypt_stat;
929 rc = ecryptfs_get_lower_file(dentry, inode);
930 if (rc) {
931 mutex_unlock(&crypt_stat->cs_mutex);
932 goto out;
933 }
934 rc = ecryptfs_read_metadata(dentry);
935 ecryptfs_put_lower_file(inode);
936 if (rc) {
937 if (!(mount_crypt_stat->flags
938 & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED)) {
939 rc = -EIO;
940 printk(KERN_WARNING "Either the lower file "
941 "is not in a valid eCryptfs format, "
942 "or the key could not be retrieved. "
943 "Plaintext passthrough mode is not "
944 "enabled; returning -EIO\n");
945 mutex_unlock(&crypt_stat->cs_mutex);
946 goto out;
947 }
948 rc = 0;
949 crypt_stat->flags &= ~(ECRYPTFS_I_SIZE_INITIALIZED
950 | ECRYPTFS_ENCRYPTED);
951 }
952 }
953 mutex_unlock(&crypt_stat->cs_mutex);
954
955 rc = inode_change_ok(inode, ia);
956 if (rc)
957 goto out;
958 if (ia->ia_valid & ATTR_SIZE) {
959 rc = ecryptfs_inode_newsize_ok(inode, ia->ia_size);
960 if (rc)
961 goto out;
962 }
963
964 memcpy(&lower_ia, ia, sizeof(lower_ia));
965 if (ia->ia_valid & ATTR_FILE)
966 lower_ia.ia_file = ecryptfs_file_to_lower(ia->ia_file);
967 if (ia->ia_valid & ATTR_SIZE) {
968 rc = truncate_upper(dentry, ia, &lower_ia);
969 if (rc < 0)
970 goto out;
971 }
972
973 /*
974 * mode change is for clearing setuid/setgid bits. Allow lower fs
975 * to interpret this in its own way.
976 */
977 if (lower_ia.ia_valid & (ATTR_KILL_SUID | ATTR_KILL_SGID))
978 lower_ia.ia_valid &= ~ATTR_MODE;
979
980 mutex_lock(&lower_dentry->d_inode->i_mutex);
981 rc = notify_change(lower_dentry, &lower_ia, NULL);
982 mutex_unlock(&lower_dentry->d_inode->i_mutex);
983out:
984 fsstack_copy_attr_all(inode, lower_inode);
985 return rc;
986}
987
988static int ecryptfs_getattr_link(struct vfsmount *mnt, struct dentry *dentry,
989 struct kstat *stat)
990{
991 struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
992 int rc = 0;
993
994 mount_crypt_stat = &ecryptfs_superblock_to_private(
995 dentry->d_sb)->mount_crypt_stat;
996 generic_fillattr(dentry->d_inode, stat);
997 if (mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES) {
998 char *target;
999 size_t targetsiz;
1000
1001 target = ecryptfs_readlink_lower(dentry, &targetsiz);
1002 if (!IS_ERR(target)) {
1003 kfree(target);
1004 stat->size = targetsiz;
1005 } else {
1006 rc = PTR_ERR(target);
1007 }
1008 }
1009 return rc;
1010}
1011
1012static int ecryptfs_getattr(struct vfsmount *mnt, struct dentry *dentry,
1013 struct kstat *stat)
1014{
1015 struct kstat lower_stat;
1016 int rc;
1017
1018 rc = vfs_getattr(ecryptfs_dentry_to_lower_path(dentry), &lower_stat);
1019 if (!rc) {
1020 fsstack_copy_attr_all(dentry->d_inode,
1021 ecryptfs_inode_to_lower(dentry->d_inode));
1022 generic_fillattr(dentry->d_inode, stat);
1023 stat->blocks = lower_stat.blocks;
1024 }
1025 return rc;
1026}
1027
1028int
1029ecryptfs_setxattr(struct dentry *dentry, const char *name, const void *value,
1030 size_t size, int flags)
1031{
1032 int rc = 0;
1033 struct dentry *lower_dentry;
1034
1035 lower_dentry = ecryptfs_dentry_to_lower(dentry);
1036 if (!lower_dentry->d_inode->i_op->setxattr) {
1037 rc = -EOPNOTSUPP;
1038 goto out;
1039 }
1040
1041 rc = vfs_setxattr(lower_dentry, name, value, size, flags);
1042 if (!rc)
1043 fsstack_copy_attr_all(dentry->d_inode, lower_dentry->d_inode);
1044out:
1045 return rc;
1046}
1047
1048ssize_t
1049ecryptfs_getxattr_lower(struct dentry *lower_dentry, const char *name,
1050 void *value, size_t size)
1051{
1052 int rc = 0;
1053
1054 if (!lower_dentry->d_inode->i_op->getxattr) {
1055 rc = -EOPNOTSUPP;
1056 goto out;
1057 }
1058 mutex_lock(&lower_dentry->d_inode->i_mutex);
1059 rc = lower_dentry->d_inode->i_op->getxattr(lower_dentry, name, value,
1060 size);
1061 mutex_unlock(&lower_dentry->d_inode->i_mutex);
1062out:
1063 return rc;
1064}
1065
1066static ssize_t
1067ecryptfs_getxattr(struct dentry *dentry, const char *name, void *value,
1068 size_t size)
1069{
1070 return ecryptfs_getxattr_lower(ecryptfs_dentry_to_lower(dentry), name,
1071 value, size);
1072}
1073
1074static ssize_t
1075ecryptfs_listxattr(struct dentry *dentry, char *list, size_t size)
1076{
1077 int rc = 0;
1078 struct dentry *lower_dentry;
1079
1080 lower_dentry = ecryptfs_dentry_to_lower(dentry);
1081 if (!lower_dentry->d_inode->i_op->listxattr) {
1082 rc = -EOPNOTSUPP;
1083 goto out;
1084 }
1085 mutex_lock(&lower_dentry->d_inode->i_mutex);
1086 rc = lower_dentry->d_inode->i_op->listxattr(lower_dentry, list, size);
1087 mutex_unlock(&lower_dentry->d_inode->i_mutex);
1088out:
1089 return rc;
1090}
1091
1092static int ecryptfs_removexattr(struct dentry *dentry, const char *name)
1093{
1094 int rc = 0;
1095 struct dentry *lower_dentry;
1096
1097 lower_dentry = ecryptfs_dentry_to_lower(dentry);
1098 if (!lower_dentry->d_inode->i_op->removexattr) {
1099 rc = -EOPNOTSUPP;
1100 goto out;
1101 }
1102 mutex_lock(&lower_dentry->d_inode->i_mutex);
1103 rc = lower_dentry->d_inode->i_op->removexattr(lower_dentry, name);
1104 mutex_unlock(&lower_dentry->d_inode->i_mutex);
1105out:
1106 return rc;
1107}
1108
1109const struct inode_operations ecryptfs_symlink_iops = {
1110 .readlink = generic_readlink,
1111 .follow_link = ecryptfs_follow_link,
1112 .put_link = kfree_put_link,
1113 .permission = ecryptfs_permission,
1114 .setattr = ecryptfs_setattr,
1115 .getattr = ecryptfs_getattr_link,
1116 .setxattr = ecryptfs_setxattr,
1117 .getxattr = ecryptfs_getxattr,
1118 .listxattr = ecryptfs_listxattr,
1119 .removexattr = ecryptfs_removexattr
1120};
1121
1122const struct inode_operations ecryptfs_dir_iops = {
1123 .create = ecryptfs_create,
1124 .lookup = ecryptfs_lookup,
1125 .link = ecryptfs_link,
1126 .unlink = ecryptfs_unlink,
1127 .symlink = ecryptfs_symlink,
1128 .mkdir = ecryptfs_mkdir,
1129 .rmdir = ecryptfs_rmdir,
1130 .mknod = ecryptfs_mknod,
1131 .rename = ecryptfs_rename,
1132 .permission = ecryptfs_permission,
1133 .setattr = ecryptfs_setattr,
1134 .setxattr = ecryptfs_setxattr,
1135 .getxattr = ecryptfs_getxattr,
1136 .listxattr = ecryptfs_listxattr,
1137 .removexattr = ecryptfs_removexattr
1138};
1139
1140const struct inode_operations ecryptfs_main_iops = {
1141 .permission = ecryptfs_permission,
1142 .setattr = ecryptfs_setattr,
1143 .getattr = ecryptfs_getattr,
1144 .setxattr = ecryptfs_setxattr,
1145 .getxattr = ecryptfs_getxattr,
1146 .listxattr = ecryptfs_listxattr,
1147 .removexattr = ecryptfs_removexattr
1148};