include/linux/fscrypt.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * fscrypt.h: declarations for per-file encryption
   4  *
   5  * Filesystems that implement per-file encryption must include this header
   6  * file.
   7  *
   8  * Copyright (C) 2015, Google, Inc.
   9  *
  10  * Written by Michael Halcrow, 2015.
  11  * Modified by Jaegeuk Kim, 2015.
  12  */
  13 #ifndef _LINUX_FSCRYPT_H
  14 #define _LINUX_FSCRYPT_H
  15
  16 #include <linux/fs.h>
  17 #include <linux/mm.h>
  18 #include <linux/slab.h>
  19 #include <uapi/linux/fscrypt.h>
  20
  21 /*
  22  * The lengths of all file contents blocks must be divisible by this value.
  23  * This is needed to ensure that all contents encryption modes will work, as
  24  * some of the supported modes don't support arbitrarily byte-aligned messages.
  25  *
  26  * Since the needed alignment is 16 bytes, most filesystems will meet this
  27  * requirement naturally, as typical block sizes are powers of 2.  However, if a
  28  * filesystem can generate arbitrarily byte-aligned block lengths (e.g., via
  29  * compression), then it will need to pad to this alignment before encryption.
  30  */
  31 #define FSCRYPT_CONTENTS_ALIGNMENT 16
  32
  33 union fscrypt_policy;
  34 struct fscrypt_info;
  35 struct fs_parameter;
  36 struct seq_file;
  37
  38 struct fscrypt_str {
  39         unsigned char *name;
  40         u32 len;
  41 };
  42
  43 struct fscrypt_name {
  44         const struct qstr *usr_fname;
  45         struct fscrypt_str disk_name;
  46         u32 hash;
  47         u32 minor_hash;
  48         struct fscrypt_str crypto_buf;
  49         bool is_nokey_name;
  50 };
  51
  52 #define FSTR_INIT(n, l)         { .name = n, .len = l }
  53 #define FSTR_TO_QSTR(f)         QSTR_INIT((f)->name, (f)->len)
  54 #define fname_name(p)           ((p)->disk_name.name)
  55 #define fname_len(p)            ((p)->disk_name.len)
  56
  57 /* Maximum value for the third parameter of fscrypt_operations.set_context(). */
  58 #define FSCRYPT_SET_CONTEXT_MAX_SIZE    40
  59
  60 #ifdef CONFIG_FS_ENCRYPTION
  61
  62 /*
  63  * If set, the fscrypt bounce page pool won't be allocated (unless another
  64  * filesystem needs it).  Set this if the filesystem always uses its own bounce
  65  * pages for writes and therefore won't need the fscrypt bounce page pool.
  66  */
  67 #define FS_CFLG_OWN_PAGES (1U << 1)
  68
  69 /* Crypto operations for filesystems */
  70 struct fscrypt_operations {
  71
  72         /* Set of optional flags; see above for allowed flags */
  73         unsigned int flags;
  74
  75         /*
  76          * If set, this is a filesystem-specific key description prefix that
  77          * will be accepted for "logon" keys for v1 fscrypt policies, in
  78          * addition to the generic prefix "fscrypt:".  This functionality is
  79          * deprecated, so new filesystems shouldn't set this field.
  80          */
  81         const char *key_prefix;
  82
  83         /*
  84          * Get the fscrypt context of the given inode.
  85          *
  86          * @inode: the inode whose context to get
  87          * @ctx: the buffer into which to get the context
  88          * @len: length of the @ctx buffer in bytes
  89          *
  90          * Return: On success, returns the length of the context in bytes; this
  91          *         may be less than @len.  On failure, returns -ENODATA if the
  92          *         inode doesn't have a context, -ERANGE if the context is
  93          *         longer than @len, or another -errno code.
  94          */
  95         int (*get_context)(struct inode *inode, void *ctx, size_t len);
  96
  97         /*
  98          * Set an fscrypt context on the given inode.
  99          *
 100          * @inode: the inode whose context to set.  The inode won't already have
 101          *         an fscrypt context.
 102          * @ctx: the context to set
 103          * @len: length of @ctx in bytes (at most FSCRYPT_SET_CONTEXT_MAX_SIZE)
 104          * @fs_data: If called from fscrypt_set_context(), this will be the
 105          *           value the filesystem passed to fscrypt_set_context().
 106          *           Otherwise (i.e. when called from
 107          *           FS_IOC_SET_ENCRYPTION_POLICY) this will be NULL.
 108          *
 109          * i_rwsem will be held for write.
 110          *
 111          * Return: 0 on success, -errno on failure.
 112          */
 113         int (*set_context)(struct inode *inode, const void *ctx, size_t len,
 114                            void *fs_data);
 115
 116         /*
 117          * Get the dummy fscrypt policy in use on the filesystem (if any).
 118          *
 119          * Filesystems only need to implement this function if they support the
 120          * test_dummy_encryption mount option.
 121          *
 122          * Return: A pointer to the dummy fscrypt policy, if the filesystem is
 123          *         mounted with test_dummy_encryption; otherwise NULL.
 124          */
 125         const union fscrypt_policy *(*get_dummy_policy)(struct super_block *sb);
 126
 127         /*
 128          * Check whether a directory is empty.  i_rwsem will be held for write.
 129          */
 130         bool (*empty_dir)(struct inode *inode);
 131
 132         /*
 133          * Check whether the filesystem's inode numbers and UUID are stable,
 134          * meaning that they will never be changed even by offline operations
 135          * such as filesystem shrinking and therefore can be used in the
 136          * encryption without the possibility of files becoming unreadable.
 137          *
 138          * Filesystems only need to implement this function if they want to
 139          * support the FSCRYPT_POLICY_FLAG_IV_INO_LBLK_{32,64} flags.  These
 140          * flags are designed to work around the limitations of UFS and eMMC
 141          * inline crypto hardware, and they shouldn't be used in scenarios where
 142          * such hardware isn't being used.
 143          *
 144          * Leaving this NULL is equivalent to always returning false.
 145          */
 146         bool (*has_stable_inodes)(struct super_block *sb);
 147
 148         /*
 149          * Get the number of bits that the filesystem uses to represent inode
 150          * numbers and file logical block numbers.
 151          *
 152          * By default, both of these are assumed to be 64-bit.  This function
 153          * can be implemented to declare that either or both of these numbers is
 154          * shorter, which may allow the use of the
 155          * FSCRYPT_POLICY_FLAG_IV_INO_LBLK_{32,64} flags and/or the use of
 156          * inline crypto hardware whose maximum DUN length is less than 64 bits
 157          * (e.g., eMMC v5.2 spec compliant hardware).  This function only needs
 158          * to be implemented if support for one of these features is needed.
 159          */
 160         void (*get_ino_and_lblk_bits)(struct super_block *sb,
 161                                       int *ino_bits_ret, int *lblk_bits_ret);
 162
 163         /*
 164          * Return the number of block devices to which the filesystem may write
 165          * encrypted file contents.
 166          *
 167          * If the filesystem can use multiple block devices (other than block
 168          * devices that aren't used for encrypted file contents, such as
 169          * external journal devices), and wants to support inline encryption,
 170          * then it must implement this function.  Otherwise it's not needed.
 171          */
 172         int (*get_num_devices)(struct super_block *sb);
 173
 174         /*
 175          * If ->get_num_devices() returns a value greater than 1, then this
 176          * function is called to get the array of request_queues that the
 177          * filesystem is using -- one per block device.  (There may be duplicate
 178          * entries in this array, as block devices can share a request_queue.)
 179          */
 180         void (*get_devices)(struct super_block *sb,
 181                             struct request_queue **devs);
 182 };
 183
 184 static inline struct fscrypt_info *fscrypt_get_info(const struct inode *inode)
 185 {
 186         /*
 187          * Pairs with the cmpxchg_release() in fscrypt_setup_encryption_info().
 188          * I.e., another task may publish ->i_crypt_info concurrently, executing
 189          * a RELEASE barrier.  We need to use smp_load_acquire() here to safely
 190          * ACQUIRE the memory the other task published.
 191          */
 192         return smp_load_acquire(&inode->i_crypt_info);
 193 }
 194
 195 /**
 196  * fscrypt_needs_contents_encryption() - check whether an inode needs
 197  *                                       contents encryption
 198  * @inode: the inode to check
 199  *
 200  * Return: %true iff the inode is an encrypted regular file and the kernel was
 201  * built with fscrypt support.
 202  *
 203  * If you need to know whether the encrypt bit is set even when the kernel was
 204  * built without fscrypt support, you must use IS_ENCRYPTED() directly instead.
 205  */
 206 static inline bool fscrypt_needs_contents_encryption(const struct inode *inode)
 207 {
 208         return IS_ENCRYPTED(inode) && S_ISREG(inode->i_mode);
 209 }
 210
 211 /*
 212  * When d_splice_alias() moves a directory's no-key alias to its plaintext alias
 213  * as a result of the encryption key being added, DCACHE_NOKEY_NAME must be
 214  * cleared.  Note that we don't have to support arbitrary moves of this flag
 215  * because fscrypt doesn't allow no-key names to be the source or target of a
 216  * rename().
 217  */
 218 static inline void fscrypt_handle_d_move(struct dentry *dentry)
 219 {
 220         dentry->d_flags &= ~DCACHE_NOKEY_NAME;
 221 }
 222
 223 /**
 224  * fscrypt_is_nokey_name() - test whether a dentry is a no-key name
 225  * @dentry: the dentry to check
 226  *
 227  * This returns true if the dentry is a no-key dentry.  A no-key dentry is a
 228  * dentry that was created in an encrypted directory that hasn't had its
 229  * encryption key added yet.  Such dentries may be either positive or negative.
 230  *
 231  * When a filesystem is asked to create a new filename in an encrypted directory
 232  * and the new filename's dentry is a no-key dentry, it must fail the operation
 233  * with ENOKEY.  This includes ->create(), ->mkdir(), ->mknod(), ->symlink(),
 234  * ->rename(), and ->link().  (However, ->rename() and ->link() are already
 235  * handled by fscrypt_prepare_rename() and fscrypt_prepare_link().)
 236  *
 237  * This is necessary because creating a filename requires the directory's
 238  * encryption key, but just checking for the key on the directory inode during
 239  * the final filesystem operation doesn't guarantee that the key was available
 240  * during the preceding dentry lookup.  And the key must have already been
 241  * available during the dentry lookup in order for it to have been checked
 242  * whether the filename already exists in the directory and for the new file's
 243  * dentry not to be invalidated due to it incorrectly having the no-key flag.
 244  *
 245  * Return: %true if the dentry is a no-key name
 246  */
 247 static inline bool fscrypt_is_nokey_name(const struct dentry *dentry)
 248 {
 249         return dentry->d_flags & DCACHE_NOKEY_NAME;
 250 }
 251
 252 /* crypto.c */
 253 void fscrypt_enqueue_decrypt_work(struct work_struct *);
 254
 255 struct page *fscrypt_encrypt_pagecache_blocks(struct page *page,
 256                                               unsigned int len,
 257                                               unsigned int offs,
 258                                               gfp_t gfp_flags);
 259 int fscrypt_encrypt_block_inplace(const struct inode *inode, struct page *page,
 260                                   unsigned int len, unsigned int offs,
 261                                   u64 lblk_num, gfp_t gfp_flags);
 262
 263 int fscrypt_decrypt_pagecache_blocks(struct page *page, unsigned int len,
 264                                      unsigned int offs);
 265 int fscrypt_decrypt_block_inplace(const struct inode *inode, struct page *page,
 266                                   unsigned int len, unsigned int offs,
 267                                   u64 lblk_num);
 268
 269 static inline bool fscrypt_is_bounce_page(struct page *page)
 270 {
 271         return page->mapping == NULL;
 272 }
 273
 274 static inline struct page *fscrypt_pagecache_page(struct page *bounce_page)
 275 {
 276         return (struct page *)page_private(bounce_page);
 277 }
 278
 279 void fscrypt_free_bounce_page(struct page *bounce_page);
 280
 281 /* policy.c */
 282 int fscrypt_ioctl_set_policy(struct file *filp, const void __user *arg);
 283 int fscrypt_ioctl_get_policy(struct file *filp, void __user *arg);
 284 int fscrypt_ioctl_get_policy_ex(struct file *filp, void __user *arg);
 285 int fscrypt_ioctl_get_nonce(struct file *filp, void __user *arg);
 286 int fscrypt_has_permitted_context(struct inode *parent, struct inode *child);
 287 int fscrypt_context_for_new_inode(void *ctx, struct inode *inode);
 288 int fscrypt_set_context(struct inode *inode, void *fs_data);
 289
 290 struct fscrypt_dummy_policy {
 291         const union fscrypt_policy *policy;
 292 };
 293
 294 int fscrypt_parse_test_dummy_encryption(const struct fs_parameter *param,
 295                                     struct fscrypt_dummy_policy *dummy_policy);
 296 bool fscrypt_dummy_policies_equal(const struct fscrypt_dummy_policy *p1,
 297                                   const struct fscrypt_dummy_policy *p2);
 298 int fscrypt_set_test_dummy_encryption(struct super_block *sb, const char *arg,
 299                                 struct fscrypt_dummy_policy *dummy_policy);
 300 void fscrypt_show_test_dummy_encryption(struct seq_file *seq, char sep,
 301                                         struct super_block *sb);
 302 static inline bool
 303 fscrypt_is_dummy_policy_set(const struct fscrypt_dummy_policy *dummy_policy)
 304 {
 305         return dummy_policy->policy != NULL;
 306 }
 307 static inline void
 308 fscrypt_free_dummy_policy(struct fscrypt_dummy_policy *dummy_policy)
 309 {
 310         kfree(dummy_policy->policy);
 311         dummy_policy->policy = NULL;
 312 }
 313
 314 /* keyring.c */
 315 void fscrypt_sb_free(struct super_block *sb);
 316 int fscrypt_ioctl_add_key(struct file *filp, void __user *arg);
 317 int fscrypt_add_test_dummy_key(struct super_block *sb,
 318                                const struct fscrypt_dummy_policy *dummy_policy);
 319 int fscrypt_ioctl_remove_key(struct file *filp, void __user *arg);
 320 int fscrypt_ioctl_remove_key_all_users(struct file *filp, void __user *arg);
 321 int fscrypt_ioctl_get_key_status(struct file *filp, void __user *arg);
 322
 323 /* keysetup.c */
 324 int fscrypt_prepare_new_inode(struct inode *dir, struct inode *inode,
 325                               bool *encrypt_ret);
 326 void fscrypt_put_encryption_info(struct inode *inode);
 327 void fscrypt_free_inode(struct inode *inode);
 328 int fscrypt_drop_inode(struct inode *inode);
 329
 330 /* fname.c */
 331 int fscrypt_fname_encrypt(const struct inode *inode, const struct qstr *iname,
 332                           u8 *out, unsigned int olen);
 333 bool fscrypt_fname_encrypted_size(const struct inode *inode, u32 orig_len,
 334                                   u32 max_len, u32 *encrypted_len_ret);
 335 int fscrypt_setup_filename(struct inode *inode, const struct qstr *iname,
 336                            int lookup, struct fscrypt_name *fname);
 337
 338 static inline void fscrypt_free_filename(struct fscrypt_name *fname)
 339 {
 340         kfree(fname->crypto_buf.name);
 341 }
 342
 343 int fscrypt_fname_alloc_buffer(u32 max_encrypted_len,
 344                                struct fscrypt_str *crypto_str);
 345 void fscrypt_fname_free_buffer(struct fscrypt_str *crypto_str);
 346 int fscrypt_fname_disk_to_usr(const struct inode *inode,
 347                               u32 hash, u32 minor_hash,
 348                               const struct fscrypt_str *iname,
 349                               struct fscrypt_str *oname);
 350 bool fscrypt_match_name(const struct fscrypt_name *fname,
 351                         const u8 *de_name, u32 de_name_len);
 352 u64 fscrypt_fname_siphash(const struct inode *dir, const struct qstr *name);
 353 int fscrypt_d_revalidate(struct dentry *dentry, unsigned int flags);
 354
 355 /* bio.c */
 356 void fscrypt_decrypt_bio(struct bio *bio);
 357 int fscrypt_zeroout_range(const struct inode *inode, pgoff_t lblk,
 358                           sector_t pblk, unsigned int len);
 359
 360 /* hooks.c */
 361 int fscrypt_file_open(struct inode *inode, struct file *filp);
 362 int __fscrypt_prepare_link(struct inode *inode, struct inode *dir,
 363                            struct dentry *dentry);
 364 int __fscrypt_prepare_rename(struct inode *old_dir, struct dentry *old_dentry,
 365                              struct inode *new_dir, struct dentry *new_dentry,
 366                              unsigned int flags);
 367 int __fscrypt_prepare_lookup(struct inode *dir, struct dentry *dentry,
 368                              struct fscrypt_name *fname);
 369 int __fscrypt_prepare_readdir(struct inode *dir);
 370 int __fscrypt_prepare_setattr(struct dentry *dentry, struct iattr *attr);
 371 int fscrypt_prepare_setflags(struct inode *inode,
 372                              unsigned int oldflags, unsigned int flags);
 373 int fscrypt_prepare_symlink(struct inode *dir, const char *target,
 374                             unsigned int len, unsigned int max_len,
 375                             struct fscrypt_str *disk_link);
 376 int __fscrypt_encrypt_symlink(struct inode *inode, const char *target,
 377                               unsigned int len, struct fscrypt_str *disk_link);
 378 const char *fscrypt_get_symlink(struct inode *inode, const void *caddr,
 379                                 unsigned int max_size,
 380                                 struct delayed_call *done);
 381 int fscrypt_symlink_getattr(const struct path *path, struct kstat *stat);
 382 static inline void fscrypt_set_ops(struct super_block *sb,
 383                                    const struct fscrypt_operations *s_cop)
 384 {
 385         sb->s_cop = s_cop;
 386 }
 387 #else  /* !CONFIG_FS_ENCRYPTION */
 388
 389 static inline struct fscrypt_info *fscrypt_get_info(const struct inode *inode)
 390 {
 391         return NULL;
 392 }
 393
 394 static inline bool fscrypt_needs_contents_encryption(const struct inode *inode)
 395 {
 396         return false;
 397 }
 398
 399 static inline void fscrypt_handle_d_move(struct dentry *dentry)
 400 {
 401 }
 402
 403 static inline bool fscrypt_is_nokey_name(const struct dentry *dentry)
 404 {
 405         return false;
 406 }
 407
 408 /* crypto.c */
 409 static inline void fscrypt_enqueue_decrypt_work(struct work_struct *work)
 410 {
 411 }
 412
 413 static inline struct page *fscrypt_encrypt_pagecache_blocks(struct page *page,
 414                                                             unsigned int len,
 415                                                             unsigned int offs,
 416                                                             gfp_t gfp_flags)
 417 {
 418         return ERR_PTR(-EOPNOTSUPP);
 419 }
 420
 421 static inline int fscrypt_encrypt_block_inplace(const struct inode *inode,
 422                                                 struct page *page,
 423                                                 unsigned int len,
 424                                                 unsigned int offs, u64 lblk_num,
 425                                                 gfp_t gfp_flags)
 426 {
 427         return -EOPNOTSUPP;
 428 }
 429
 430 static inline int fscrypt_decrypt_pagecache_blocks(struct page *page,
 431                                                    unsigned int len,
 432                                                    unsigned int offs)
 433 {
 434         return -EOPNOTSUPP;
 435 }
 436
 437 static inline int fscrypt_decrypt_block_inplace(const struct inode *inode,
 438                                                 struct page *page,
 439                                                 unsigned int len,
 440                                                 unsigned int offs, u64 lblk_num)
 441 {
 442         return -EOPNOTSUPP;
 443 }
 444
 445 static inline bool fscrypt_is_bounce_page(struct page *page)
 446 {
 447         return false;
 448 }
 449
 450 static inline struct page *fscrypt_pagecache_page(struct page *bounce_page)
 451 {
 452         WARN_ON_ONCE(1);
 453         return ERR_PTR(-EINVAL);
 454 }
 455
 456 static inline void fscrypt_free_bounce_page(struct page *bounce_page)
 457 {
 458 }
 459
 460 /* policy.c */
 461 static inline int fscrypt_ioctl_set_policy(struct file *filp,
 462                                            const void __user *arg)
 463 {
 464         return -EOPNOTSUPP;
 465 }
 466
 467 static inline int fscrypt_ioctl_get_policy(struct file *filp, void __user *arg)
 468 {
 469         return -EOPNOTSUPP;
 470 }
 471
 472 static inline int fscrypt_ioctl_get_policy_ex(struct file *filp,
 473                                               void __user *arg)
 474 {
 475         return -EOPNOTSUPP;
 476 }
 477
 478 static inline int fscrypt_ioctl_get_nonce(struct file *filp, void __user *arg)
 479 {
 480         return -EOPNOTSUPP;
 481 }
 482
 483 static inline int fscrypt_has_permitted_context(struct inode *parent,
 484                                                 struct inode *child)
 485 {
 486         return 0;
 487 }
 488
 489 static inline int fscrypt_set_context(struct inode *inode, void *fs_data)
 490 {
 491         return -EOPNOTSUPP;
 492 }
 493
 494 struct fscrypt_dummy_policy {
 495 };
 496
 497 static inline int
 498 fscrypt_parse_test_dummy_encryption(const struct fs_parameter *param,
 499                                     struct fscrypt_dummy_policy *dummy_policy)
 500 {
 501         return -EINVAL;
 502 }
 503
 504 static inline bool
 505 fscrypt_dummy_policies_equal(const struct fscrypt_dummy_policy *p1,
 506                              const struct fscrypt_dummy_policy *p2)
 507 {
 508         return true;
 509 }
 510
 511 static inline void fscrypt_show_test_dummy_encryption(struct seq_file *seq,
 512                                                       char sep,
 513                                                       struct super_block *sb)
 514 {
 515 }
 516
 517 static inline bool
 518 fscrypt_is_dummy_policy_set(const struct fscrypt_dummy_policy *dummy_policy)
 519 {
 520         return false;
 521 }
 522
 523 static inline void
 524 fscrypt_free_dummy_policy(struct fscrypt_dummy_policy *dummy_policy)
 525 {
 526 }
 527
 528 /* keyring.c */
 529 static inline void fscrypt_sb_free(struct super_block *sb)
 530 {
 531 }
 532
 533 static inline int fscrypt_ioctl_add_key(struct file *filp, void __user *arg)
 534 {
 535         return -EOPNOTSUPP;
 536 }
 537
 538 static inline int
 539 fscrypt_add_test_dummy_key(struct super_block *sb,
 540                            const struct fscrypt_dummy_policy *dummy_policy)
 541 {
 542         return 0;
 543 }
 544
 545 static inline int fscrypt_ioctl_remove_key(struct file *filp, void __user *arg)
 546 {
 547         return -EOPNOTSUPP;
 548 }
 549
 550 static inline int fscrypt_ioctl_remove_key_all_users(struct file *filp,
 551                                                      void __user *arg)
 552 {
 553         return -EOPNOTSUPP;
 554 }
 555
 556 static inline int fscrypt_ioctl_get_key_status(struct file *filp,
 557                                                void __user *arg)
 558 {
 559         return -EOPNOTSUPP;
 560 }
 561
 562 /* keysetup.c */
 563
 564 static inline int fscrypt_prepare_new_inode(struct inode *dir,
 565                                             struct inode *inode,
 566                                             bool *encrypt_ret)
 567 {
 568         if (IS_ENCRYPTED(dir))
 569                 return -EOPNOTSUPP;
 570         return 0;
 571 }
 572
 573 static inline void fscrypt_put_encryption_info(struct inode *inode)
 574 {
 575         return;
 576 }
 577
 578 static inline void fscrypt_free_inode(struct inode *inode)
 579 {
 580 }
 581
 582 static inline int fscrypt_drop_inode(struct inode *inode)
 583 {
 584         return 0;
 585 }
 586
 587  /* fname.c */
 588 static inline int fscrypt_setup_filename(struct inode *dir,
 589                                          const struct qstr *iname,
 590                                          int lookup, struct fscrypt_name *fname)
 591 {
 592         if (IS_ENCRYPTED(dir))
 593                 return -EOPNOTSUPP;
 594
 595         memset(fname, 0, sizeof(*fname));
 596         fname->usr_fname = iname;
 597         fname->disk_name.name = (unsigned char *)iname->name;
 598         fname->disk_name.len = iname->len;
 599         return 0;
 600 }
 601
 602 static inline void fscrypt_free_filename(struct fscrypt_name *fname)
 603 {
 604         return;
 605 }
 606
 607 static inline int fscrypt_fname_alloc_buffer(u32 max_encrypted_len,
 608                                              struct fscrypt_str *crypto_str)
 609 {
 610         return -EOPNOTSUPP;
 611 }
 612
 613 static inline void fscrypt_fname_free_buffer(struct fscrypt_str *crypto_str)
 614 {
 615         return;
 616 }
 617
 618 static inline int fscrypt_fname_disk_to_usr(const struct inode *inode,
 619                                             u32 hash, u32 minor_hash,
 620                                             const struct fscrypt_str *iname,
 621                                             struct fscrypt_str *oname)
 622 {
 623         return -EOPNOTSUPP;
 624 }
 625
 626 static inline bool fscrypt_match_name(const struct fscrypt_name *fname,
 627                                       const u8 *de_name, u32 de_name_len)
 628 {
 629         /* Encryption support disabled; use standard comparison */
 630         if (de_name_len != fname->disk_name.len)
 631                 return false;
 632         return !memcmp(de_name, fname->disk_name.name, fname->disk_name.len);
 633 }
 634
 635 static inline u64 fscrypt_fname_siphash(const struct inode *dir,
 636                                         const struct qstr *name)
 637 {
 638         WARN_ON_ONCE(1);
 639         return 0;
 640 }
 641
 642 static inline int fscrypt_d_revalidate(struct dentry *dentry,
 643                                        unsigned int flags)
 644 {
 645         return 1;
 646 }
 647
 648 /* bio.c */
 649 static inline void fscrypt_decrypt_bio(struct bio *bio)
 650 {
 651 }
 652
 653 static inline int fscrypt_zeroout_range(const struct inode *inode, pgoff_t lblk,
 654                                         sector_t pblk, unsigned int len)
 655 {
 656         return -EOPNOTSUPP;
 657 }
 658
 659 /* hooks.c */
 660
 661 static inline int fscrypt_file_open(struct inode *inode, struct file *filp)
 662 {
 663         if (IS_ENCRYPTED(inode))
 664                 return -EOPNOTSUPP;
 665         return 0;
 666 }
 667
 668 static inline int __fscrypt_prepare_link(struct inode *inode, struct inode *dir,
 669                                          struct dentry *dentry)
 670 {
 671         return -EOPNOTSUPP;
 672 }
 673
 674 static inline int __fscrypt_prepare_rename(struct inode *old_dir,
 675                                            struct dentry *old_dentry,
 676                                            struct inode *new_dir,
 677                                            struct dentry *new_dentry,
 678                                            unsigned int flags)
 679 {
 680         return -EOPNOTSUPP;
 681 }
 682
 683 static inline int __fscrypt_prepare_lookup(struct inode *dir,
 684                                            struct dentry *dentry,
 685                                            struct fscrypt_name *fname)
 686 {
 687         return -EOPNOTSUPP;
 688 }
 689
 690 static inline int __fscrypt_prepare_readdir(struct inode *dir)
 691 {
 692         return -EOPNOTSUPP;
 693 }
 694
 695 static inline int __fscrypt_prepare_setattr(struct dentry *dentry,
 696                                             struct iattr *attr)
 697 {
 698         return -EOPNOTSUPP;
 699 }
 700
 701 static inline int fscrypt_prepare_setflags(struct inode *inode,
 702                                            unsigned int oldflags,
 703                                            unsigned int flags)
 704 {
 705         return 0;
 706 }
 707
 708 static inline int fscrypt_prepare_symlink(struct inode *dir,
 709                                           const char *target,
 710                                           unsigned int len,
 711                                           unsigned int max_len,
 712                                           struct fscrypt_str *disk_link)
 713 {
 714         if (IS_ENCRYPTED(dir))
 715                 return -EOPNOTSUPP;
 716         disk_link->name = (unsigned char *)target;
 717         disk_link->len = len + 1;
 718         if (disk_link->len > max_len)
 719                 return -ENAMETOOLONG;
 720         return 0;
 721 }
 722
 723 static inline int __fscrypt_encrypt_symlink(struct inode *inode,
 724                                             const char *target,
 725                                             unsigned int len,
 726                                             struct fscrypt_str *disk_link)
 727 {
 728         return -EOPNOTSUPP;
 729 }
 730
 731 static inline const char *fscrypt_get_symlink(struct inode *inode,
 732                                               const void *caddr,
 733                                               unsigned int max_size,
 734                                               struct delayed_call *done)
 735 {
 736         return ERR_PTR(-EOPNOTSUPP);
 737 }
 738
 739 static inline int fscrypt_symlink_getattr(const struct path *path,
 740                                           struct kstat *stat)
 741 {
 742         return -EOPNOTSUPP;
 743 }
 744
 745 static inline void fscrypt_set_ops(struct super_block *sb,
 746                                    const struct fscrypt_operations *s_cop)
 747 {
 748 }
 749
 750 #endif  /* !CONFIG_FS_ENCRYPTION */
 751
 752 /* inline_crypt.c */
 753 #ifdef CONFIG_FS_ENCRYPTION_INLINE_CRYPT
 754
 755 bool __fscrypt_inode_uses_inline_crypto(const struct inode *inode);
 756
 757 void fscrypt_set_bio_crypt_ctx(struct bio *bio,
 758                                const struct inode *inode, u64 first_lblk,
 759                                gfp_t gfp_mask);
 760
 761 void fscrypt_set_bio_crypt_ctx_bh(struct bio *bio,
 762                                   const struct buffer_head *first_bh,
 763                                   gfp_t gfp_mask);
 764
 765 bool fscrypt_mergeable_bio(struct bio *bio, const struct inode *inode,
 766                            u64 next_lblk);
 767
 768 bool fscrypt_mergeable_bio_bh(struct bio *bio,
 769                               const struct buffer_head *next_bh);
 770
 771 bool fscrypt_dio_supported(struct kiocb *iocb, struct iov_iter *iter);
 772
 773 u64 fscrypt_limit_io_blocks(const struct inode *inode, u64 lblk, u64 nr_blocks);
 774
 775 #else /* CONFIG_FS_ENCRYPTION_INLINE_CRYPT */
 776
 777 static inline bool __fscrypt_inode_uses_inline_crypto(const struct inode *inode)
 778 {
 779         return false;
 780 }
 781
 782 static inline void fscrypt_set_bio_crypt_ctx(struct bio *bio,
 783                                              const struct inode *inode,
 784                                              u64 first_lblk, gfp_t gfp_mask) { }
 785
 786 static inline void fscrypt_set_bio_crypt_ctx_bh(
 787                                          struct bio *bio,
 788                                          const struct buffer_head *first_bh,
 789                                          gfp_t gfp_mask) { }
 790
 791 static inline bool fscrypt_mergeable_bio(struct bio *bio,
 792                                          const struct inode *inode,
 793                                          u64 next_lblk)
 794 {
 795         return true;
 796 }
 797
 798 static inline bool fscrypt_mergeable_bio_bh(struct bio *bio,
 799                                             const struct buffer_head *next_bh)
 800 {
 801         return true;
 802 }
 803
 804 static inline bool fscrypt_dio_supported(struct kiocb *iocb,
 805                                          struct iov_iter *iter)
 806 {
 807         const struct inode *inode = file_inode(iocb->ki_filp);
 808
 809         return !fscrypt_needs_contents_encryption(inode);
 810 }
 811
 812 static inline u64 fscrypt_limit_io_blocks(const struct inode *inode, u64 lblk,
 813                                           u64 nr_blocks)
 814 {
 815         return nr_blocks;
 816 }
 817 #endif /* !CONFIG_FS_ENCRYPTION_INLINE_CRYPT */
 818
 819 /**
 820  * fscrypt_inode_uses_inline_crypto() - test whether an inode uses inline
 821  *                                      encryption
 822  * @inode: an inode. If encrypted, its key must be set up.
 823  *
 824  * Return: true if the inode requires file contents encryption and if the
 825  *         encryption should be done in the block layer via blk-crypto rather
 826  *         than in the filesystem layer.
 827  */
 828 static inline bool fscrypt_inode_uses_inline_crypto(const struct inode *inode)
 829 {
 830         return fscrypt_needs_contents_encryption(inode) &&
 831                __fscrypt_inode_uses_inline_crypto(inode);
 832 }
 833
 834 /**
 835  * fscrypt_inode_uses_fs_layer_crypto() - test whether an inode uses fs-layer
 836  *                                        encryption
 837  * @inode: an inode. If encrypted, its key must be set up.
 838  *
 839  * Return: true if the inode requires file contents encryption and if the
 840  *         encryption should be done in the filesystem layer rather than in the
 841  *         block layer via blk-crypto.
 842  */
 843 static inline bool fscrypt_inode_uses_fs_layer_crypto(const struct inode *inode)
 844 {
 845         return fscrypt_needs_contents_encryption(inode) &&
 846                !__fscrypt_inode_uses_inline_crypto(inode);
 847 }
 848
 849 /**
 850  * fscrypt_has_encryption_key() - check whether an inode has had its key set up
 851  * @inode: the inode to check
 852  *
 853  * Return: %true if the inode has had its encryption key set up, else %false.
 854  *
 855  * Usually this should be preceded by fscrypt_get_encryption_info() to try to
 856  * set up the key first.
 857  */
 858 static inline bool fscrypt_has_encryption_key(const struct inode *inode)
 859 {
 860         return fscrypt_get_info(inode) != NULL;
 861 }
 862
 863 /**
 864  * fscrypt_prepare_link() - prepare to link an inode into a possibly-encrypted
 865  *                          directory
 866  * @old_dentry: an existing dentry for the inode being linked
 867  * @dir: the target directory
 868  * @dentry: negative dentry for the target filename
 869  *
 870  * A new link can only be added to an encrypted directory if the directory's
 871  * encryption key is available --- since otherwise we'd have no way to encrypt
 872  * the filename.
 873  *
 874  * We also verify that the link will not violate the constraint that all files
 875  * in an encrypted directory tree use the same encryption policy.
 876  *
 877  * Return: 0 on success, -ENOKEY if the directory's encryption key is missing,
 878  * -EXDEV if the link would result in an inconsistent encryption policy, or
 879  * another -errno code.
 880  */
 881 static inline int fscrypt_prepare_link(struct dentry *old_dentry,
 882                                        struct inode *dir,
 883                                        struct dentry *dentry)
 884 {
 885         if (IS_ENCRYPTED(dir))
 886                 return __fscrypt_prepare_link(d_inode(old_dentry), dir, dentry);
 887         return 0;
 888 }
 889
 890 /**
 891  * fscrypt_prepare_rename() - prepare for a rename between possibly-encrypted
 892  *                            directories
 893  * @old_dir: source directory
 894  * @old_dentry: dentry for source file
 895  * @new_dir: target directory
 896  * @new_dentry: dentry for target location (may be negative unless exchanging)
 897  * @flags: rename flags (we care at least about %RENAME_EXCHANGE)
 898  *
 899  * Prepare for ->rename() where the source and/or target directories may be
 900  * encrypted.  A new link can only be added to an encrypted directory if the
 901  * directory's encryption key is available --- since otherwise we'd have no way
 902  * to encrypt the filename.  A rename to an existing name, on the other hand,
 903  * *is* cryptographically possible without the key.  However, we take the more
 904  * conservative approach and just forbid all no-key renames.
 905  *
 906  * We also verify that the rename will not violate the constraint that all files
 907  * in an encrypted directory tree use the same encryption policy.
 908  *
 909  * Return: 0 on success, -ENOKEY if an encryption key is missing, -EXDEV if the
 910  * rename would cause inconsistent encryption policies, or another -errno code.
 911  */
 912 static inline int fscrypt_prepare_rename(struct inode *old_dir,
 913                                          struct dentry *old_dentry,
 914                                          struct inode *new_dir,
 915                                          struct dentry *new_dentry,
 916                                          unsigned int flags)
 917 {
 918         if (IS_ENCRYPTED(old_dir) || IS_ENCRYPTED(new_dir))
 919                 return __fscrypt_prepare_rename(old_dir, old_dentry,
 920                                                 new_dir, new_dentry, flags);
 921         return 0;
 922 }
 923
 924 /**
 925  * fscrypt_prepare_lookup() - prepare to lookup a name in a possibly-encrypted
 926  *                            directory
 927  * @dir: directory being searched
 928  * @dentry: filename being looked up
 929  * @fname: (output) the name to use to search the on-disk directory
 930  *
 931  * Prepare for ->lookup() in a directory which may be encrypted by determining
 932  * the name that will actually be used to search the directory on-disk.  If the
 933  * directory's encryption policy is supported by this kernel and its encryption
 934  * key is available, then the lookup is assumed to be by plaintext name;
 935  * otherwise, it is assumed to be by no-key name.
 936  *
 937  * This will set DCACHE_NOKEY_NAME on the dentry if the lookup is by no-key
 938  * name.  In this case the filesystem must assign the dentry a dentry_operations
 939  * which contains fscrypt_d_revalidate (or contains a d_revalidate method that
 940  * calls fscrypt_d_revalidate), so that the dentry will be invalidated if the
 941  * directory's encryption key is later added.
 942  *
 943  * Return: 0 on success; -ENOENT if the directory's key is unavailable but the
 944  * filename isn't a valid no-key name, so a negative dentry should be created;
 945  * or another -errno code.
 946  */
 947 static inline int fscrypt_prepare_lookup(struct inode *dir,
 948                                          struct dentry *dentry,
 949                                          struct fscrypt_name *fname)
 950 {
 951         if (IS_ENCRYPTED(dir))
 952                 return __fscrypt_prepare_lookup(dir, dentry, fname);
 953
 954         memset(fname, 0, sizeof(*fname));
 955         fname->usr_fname = &dentry->d_name;
 956         fname->disk_name.name = (unsigned char *)dentry->d_name.name;
 957         fname->disk_name.len = dentry->d_name.len;
 958         return 0;
 959 }
 960
 961 /**
 962  * fscrypt_prepare_readdir() - prepare to read a possibly-encrypted directory
 963  * @dir: the directory inode
 964  *
 965  * If the directory is encrypted and it doesn't already have its encryption key
 966  * set up, try to set it up so that the filenames will be listed in plaintext
 967  * form rather than in no-key form.
 968  *
 969  * Return: 0 on success; -errno on error.  Note that the encryption key being
 970  *         unavailable is not considered an error.  It is also not an error if
 971  *         the encryption policy is unsupported by this kernel; that is treated
 972  *         like the key being unavailable, so that files can still be deleted.
 973  */
 974 static inline int fscrypt_prepare_readdir(struct inode *dir)
 975 {
 976         if (IS_ENCRYPTED(dir))
 977                 return __fscrypt_prepare_readdir(dir);
 978         return 0;
 979 }
 980
 981 /**
 982  * fscrypt_prepare_setattr() - prepare to change a possibly-encrypted inode's
 983  *                             attributes
 984  * @dentry: dentry through which the inode is being changed
 985  * @attr: attributes to change
 986  *
 987  * Prepare for ->setattr() on a possibly-encrypted inode.  On an encrypted file,
 988  * most attribute changes are allowed even without the encryption key.  However,
 989  * without the encryption key we do have to forbid truncates.  This is needed
 990  * because the size being truncated to may not be a multiple of the filesystem
 991  * block size, and in that case we'd have to decrypt the final block, zero the
 992  * portion past i_size, and re-encrypt it.  (We *could* allow truncating to a
 993  * filesystem block boundary, but it's simpler to just forbid all truncates ---
 994  * and we already forbid all other contents modifications without the key.)
 995  *
 996  * Return: 0 on success, -ENOKEY if the key is missing, or another -errno code
 997  * if a problem occurred while setting up the encryption key.
 998  */
 999 static inline int fscrypt_prepare_setattr(struct dentry *dentry,
1000                                           struct iattr *attr)
1001 {
1002         if (IS_ENCRYPTED(d_inode(dentry)))
1003                 return __fscrypt_prepare_setattr(dentry, attr);
1004         return 0;
1005 }
1006
1007 /**
1008  * fscrypt_encrypt_symlink() - encrypt the symlink target if needed
1009  * @inode: symlink inode
1010  * @target: plaintext symlink target
1011  * @len: length of @target excluding null terminator
1012  * @disk_link: (in/out) the on-disk symlink target being prepared
1013  *
1014  * If the symlink target needs to be encrypted, then this function encrypts it
1015  * into @disk_link->name.  fscrypt_prepare_symlink() must have been called
1016  * previously to compute @disk_link->len.  If the filesystem did not allocate a
1017  * buffer for @disk_link->name after calling fscrypt_prepare_link(), then one
1018  * will be kmalloc()'ed and the filesystem will be responsible for freeing it.
1019  *
1020  * Return: 0 on success, -errno on failure
1021  */
1022 static inline int fscrypt_encrypt_symlink(struct inode *inode,
1023                                           const char *target,
1024                                           unsigned int len,
1025                                           struct fscrypt_str *disk_link)
1026 {
1027         if (IS_ENCRYPTED(inode))
1028                 return __fscrypt_encrypt_symlink(inode, target, len, disk_link);
1029         return 0;
1030 }
1031
1032 /* If *pagep is a bounce page, free it and set *pagep to the pagecache page */
1033 static inline void fscrypt_finalize_bounce_page(struct page **pagep)
1034 {
1035         struct page *page = *pagep;
1036
1037         if (fscrypt_is_bounce_page(page)) {
1038                 *pagep = fscrypt_pagecache_page(page);
1039                 fscrypt_free_bounce_page(page);
1040         }
1041 }
1042
1043 #endif  /* _LINUX_FSCRYPT_H */