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