libcfs/include/libcfs/crypto/llcrypt.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * llcrypt.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 /*
  14  * Linux commit 219d54332a09
  15  * tags/v5.4
  16  */
  17 #ifndef _LINUX_LLCRYPT_H
  18 #define _LINUX_LLCRYPT_H
  19
  20 #ifndef DCACHE_ENCRYPTED_NAME
  21 #define DCACHE_ENCRYPTED_NAME 0x02000000
  22 #endif
  23
  24 #include <linux/fs.h>
  25 #include <linux/mm.h>
  26 #include <linux/slab.h>
  27 #include <lustre_disk.h>
  28 #include <uapi/linux/llcrypt.h>
  29
  30 #define LL_CRYPTO_BLOCK_SIZE            16
  31
  32 struct llcrypt_ctx;
  33 struct llcrypt_info;
  34
  35 struct llcrypt_str {
  36         unsigned char *name;
  37         u32 len;
  38 };
  39
  40 struct llcrypt_name {
  41         const struct qstr *usr_fname;
  42         struct llcrypt_str disk_name;
  43         u32 hash;
  44         u32 minor_hash;
  45         struct llcrypt_str crypto_buf;
  46         bool is_ciphertext_name;
  47 };
  48
  49 #define LLTR_INIT(n, l)         { .name = n, .len = l }
  50 #define LLTR_TO_QSTR(f)         QSTR_INIT((f)->name, (f)->len)
  51 #define lname_name(p)           ((p)->disk_name.name)
  52 #define lname_len(p)            ((p)->disk_name.len)
  53
  54 /* Maximum value for the third parameter of llcrypt_operations.set_context(). */
  55 #define LLCRYPT_SET_CONTEXT_MAX_SIZE    40
  56
  57 #ifdef CONFIG_LL_ENCRYPTION
  58 /*
  59  * llcrypt superblock flags
  60  */
  61 #define LL_CFLG_OWN_PAGES (1U << 1)
  62
  63 /*
  64  * crypto operations for filesystems
  65  */
  66 struct llcrypt_operations {
  67         unsigned int flags;
  68         const char *key_prefix;
  69         int (*get_context)(struct inode *, void *, size_t);
  70         int (*set_context)(struct inode *, const void *, size_t, void *);
  71         bool (*dummy_context)(struct inode *);
  72         bool (*empty_dir)(struct inode *);
  73         unsigned int max_namelen;
  74 };
  75
  76 /* Decryption work */
  77 struct llcrypt_ctx {
  78         union {
  79                 struct {
  80                         struct bio *bio;
  81                         struct work_struct work;
  82                 };
  83                 struct list_head free_list;     /* Free list */
  84         };
  85         u8 flags;                               /* Flags */
  86 };
  87
  88 extern bool llcrypt_has_encryption_key(const struct inode *inode);
  89
  90 static inline bool llcrypt_dummy_context_enabled(struct inode *inode)
  91 {
  92         struct lustre_sb_info *lsi = s2lsi(inode->i_sb);
  93
  94         if (unlikely(!lsi))
  95                 return false;
  96
  97         return lsi->lsi_cop->dummy_context &&
  98                 lsi->lsi_cop->dummy_context(inode);
  99 }
 100
 101 /*
 102  * When d_splice_alias() moves a directory's encrypted alias to its decrypted
 103  * alias as a result of the encryption key being added, DCACHE_ENCRYPTED_NAME
 104  * must be cleared.  Note that we don't have to support arbitrary moves of this
 105  * flag because llcrypt doesn't allow encrypted aliases to be the source or
 106  * target of a rename().
 107  */
 108 static inline void llcrypt_handle_d_move(struct dentry *dentry)
 109 {
 110         dentry->d_flags &= ~DCACHE_ENCRYPTED_NAME;
 111 }
 112
 113 /* crypto.c */
 114 extern int __init llcrypt_init(void);
 115 extern void __exit llcrypt_exit(void);
 116 extern void llcrypt_enqueue_decrypt_work(struct work_struct *);
 117 extern struct llcrypt_ctx *llcrypt_get_ctx(gfp_t);
 118 extern void llcrypt_release_ctx(struct llcrypt_ctx *);
 119
 120 extern struct page *llcrypt_encrypt_pagecache_blocks(struct page *page,
 121                                                      unsigned int len,
 122                                                      unsigned int offs,
 123                                                      gfp_t gfp_flags);
 124 extern int llcrypt_encrypt_block_inplace(const struct inode *inode,
 125                                          struct page *page, unsigned int len,
 126                                          unsigned int offs, u64 lblk_num,
 127                                          gfp_t gfp_flags);
 128
 129 extern int llcrypt_decrypt_pagecache_blocks(struct page *page, unsigned int len,
 130                                             unsigned int offs);
 131 extern int llcrypt_decrypt_block_inplace(const struct inode *inode,
 132                                          struct page *page, unsigned int len,
 133                                          unsigned int offs, u64 lblk_num);
 134
 135 static inline bool llcrypt_is_bounce_page(struct page *page)
 136 {
 137         return page->mapping == NULL;
 138 }
 139
 140 static inline struct page *llcrypt_pagecache_page(struct page *bounce_page)
 141 {
 142         return (struct page *)page_private(bounce_page);
 143 }
 144
 145 extern void llcrypt_free_bounce_page(struct page *bounce_page);
 146
 147 /* policy.c */
 148 extern int llcrypt_ioctl_set_policy(struct file *, const void __user *);
 149 extern int llcrypt_ioctl_get_policy(struct file *, void __user *);
 150 extern int llcrypt_ioctl_get_policy_ex(struct file *, void __user *);
 151 extern int llcrypt_has_permitted_context(struct inode *, struct inode *);
 152 extern int llcrypt_inherit_context(struct inode *, struct inode *,
 153                                         void *, bool);
 154 extern bool llcrypt_policy_has_filename_enc(struct inode *inode);
 155 /* keyring.c */
 156 extern void llcrypt_sb_free(struct super_block *sb);
 157 extern int llcrypt_ioctl_add_key(struct file *filp, void __user *arg);
 158 extern int llcrypt_ioctl_remove_key(struct file *filp, void __user *arg);
 159 extern int llcrypt_ioctl_remove_key_all_users(struct file *filp,
 160                                               void __user *arg);
 161 extern int llcrypt_ioctl_get_key_status(struct file *filp, void __user *arg);
 162
 163 /* keysetup.c */
 164 extern int llcrypt_get_encryption_info(struct inode *);
 165 extern void llcrypt_put_encryption_info(struct inode *);
 166 extern void llcrypt_free_inode(struct inode *);
 167 extern int llcrypt_drop_inode(struct inode *inode);
 168
 169 /* fname.c */
 170 extern int llcrypt_setup_filename(struct inode *, const struct qstr *,
 171                                 int lookup, struct llcrypt_name *);
 172
 173 static inline void llcrypt_free_filename(struct llcrypt_name *fname)
 174 {
 175         kfree(fname->crypto_buf.name);
 176 }
 177
 178 extern int llcrypt_fname_alloc_buffer(const struct inode *, u32,
 179                                 struct llcrypt_str *);
 180 extern void llcrypt_fname_free_buffer(struct llcrypt_str *);
 181 extern int llcrypt_fname_disk_to_usr(struct inode *, u32, u32,
 182                         const struct llcrypt_str *, struct llcrypt_str *);
 183
 184 #define LLCRYPT_FNAME_MAX_UNDIGESTED_SIZE       32
 185
 186 /* Extracts the second-to-last ciphertext block; see explanation below */
 187 #define LLCRYPT_FNAME_DIGEST(name, len) \
 188         ((name) + round_down((len) - LL_CRYPTO_BLOCK_SIZE - 1, \
 189                              LL_CRYPTO_BLOCK_SIZE))
 190
 191 #define LLCRYPT_FNAME_DIGEST_SIZE       LL_CRYPTO_BLOCK_SIZE
 192
 193 /**
 194  * llcrypt_digested_name - alternate identifier for an on-disk filename
 195  *
 196  * When userspace lists an encrypted directory without access to the key,
 197  * filenames whose ciphertext is longer than LLCRYPT_FNAME_MAX_UNDIGESTED_SIZE
 198  * bytes are shown in this abbreviated form (base64-encoded) rather than as the
 199  * full ciphertext (base64-encoded).  This is necessary to allow supporting
 200  * filenames up to NAME_MAX bytes, since base64 encoding expands the length.
 201  *
 202  * To make it possible for filesystems to still find the correct directory entry
 203  * despite not knowing the full on-disk name, we encode any filesystem-specific
 204  * 'hash' and/or 'minor_hash' which the filesystem may need for its lookups,
 205  * followed by the second-to-last ciphertext block of the filename.  Due to the
 206  * use of the CBC-CTS encryption mode, the second-to-last ciphertext block
 207  * depends on the full plaintext.  (Note that ciphertext stealing causes the
 208  * last two blocks to appear "flipped".)  This makes accidental collisions very
 209  * unlikely: just a 1 in 2^128 chance for two filenames to collide even if they
 210  * share the same filesystem-specific hashes.
 211  *
 212  * However, this scheme isn't immune to intentional collisions, which can be
 213  * created by anyone able to create arbitrary plaintext filenames and view them
 214  * without the key.  Making the "digest" be a real cryptographic hash like
 215  * SHA-256 over the full ciphertext would prevent this, although it would be
 216  * less efficient and harder to implement, especially since the filesystem would
 217  * need to calculate it for each directory entry examined during a search.
 218  */
 219 struct llcrypt_digested_name {
 220         u32 hash;
 221         u32 minor_hash;
 222         u8 digest[LLCRYPT_FNAME_DIGEST_SIZE];
 223 };
 224
 225 /**
 226  * llcrypt_match_name() - test whether the given name matches a directory entry
 227  * @fname: the name being searched for
 228  * @de_name: the name from the directory entry
 229  * @de_name_len: the length of @de_name in bytes
 230  *
 231  * Normally @fname->disk_name will be set, and in that case we simply compare
 232  * that to the name stored in the directory entry.  The only exception is that
 233  * if we don't have the key for an encrypted directory and a filename in it is
 234  * very long, then we won't have the full disk_name and we'll instead need to
 235  * match against the llcrypt_digested_name.
 236  *
 237  * Return: %true if the name matches, otherwise %false.
 238  */
 239 static inline bool llcrypt_match_name(const struct llcrypt_name *fname,
 240                                       const u8 *de_name, u32 de_name_len)
 241 {
 242         if (unlikely(!fname->disk_name.name)) {
 243                 const struct llcrypt_digested_name *n =
 244                         (const void *)fname->crypto_buf.name;
 245                 if (WARN_ON_ONCE(fname->usr_fname->name[0] != '_'))
 246                         return false;
 247                 if (de_name_len <= LLCRYPT_FNAME_MAX_UNDIGESTED_SIZE)
 248                         return false;
 249                 return !memcmp(LLCRYPT_FNAME_DIGEST(de_name, de_name_len),
 250                                n->digest, LLCRYPT_FNAME_DIGEST_SIZE);
 251         }
 252
 253         if (de_name_len != fname->disk_name.len)
 254                 return false;
 255         return !memcmp(de_name, fname->disk_name.name, fname->disk_name.len);
 256 }
 257
 258 /* bio.c */
 259 extern void llcrypt_decrypt_bio(struct bio *);
 260 extern void llcrypt_enqueue_decrypt_bio(struct llcrypt_ctx *ctx,
 261                                         struct bio *bio);
 262 extern int llcrypt_zeroout_range(const struct inode *, pgoff_t, sector_t,
 263                                  unsigned int);
 264
 265 /* hooks.c */
 266 extern int llcrypt_file_open(struct inode *inode, struct file *filp);
 267 extern int __llcrypt_prepare_link(struct inode *inode, struct inode *dir,
 268                                   struct dentry *dentry);
 269 extern int __llcrypt_prepare_rename(struct inode *old_dir,
 270                                     struct dentry *old_dentry,
 271                                     struct inode *new_dir,
 272                                     struct dentry *new_dentry,
 273                                     unsigned int flags);
 274 extern int __llcrypt_prepare_lookup(struct inode *dir, struct dentry *dentry,
 275                                     struct llcrypt_name *fname);
 276 extern int __llcrypt_prepare_symlink(struct inode *dir, unsigned int len,
 277                                      unsigned int max_len,
 278                                      struct llcrypt_str *disk_link);
 279 extern int __llcrypt_encrypt_symlink(struct inode *inode, const char *target,
 280                                      unsigned int len,
 281                                      struct llcrypt_str *disk_link);
 282 extern const char *llcrypt_get_symlink(struct inode *inode, const void *caddr,
 283                                        unsigned int max_size,
 284                                        struct delayed_call *done);
 285 static inline void llcrypt_set_ops(struct super_block *sb,
 286                                    const struct llcrypt_operations *lsi_cop)
 287 {
 288         struct lustre_sb_info *lsi = s2lsi(sb);
 289
 290         if (lsi)
 291                 lsi->lsi_cop = lsi_cop;
 292 }
 293 #else  /* !CONFIG_LL_ENCRYPTION */
 294
 295 struct llcrypt_operations;
 296 #define llcrypt_init()         0
 297 #define llcrypt_exit()         {}
 298
 299 #undef IS_ENCRYPTED
 300 #define IS_ENCRYPTED(x)        0
 301
 302 static inline bool llcrypt_has_encryption_key(const struct inode *inode)
 303 {
 304         return false;
 305 }
 306
 307 static inline bool llcrypt_dummy_context_enabled(struct inode *inode)
 308 {
 309         return false;
 310 }
 311
 312 static inline void llcrypt_handle_d_move(struct dentry *dentry)
 313 {
 314 }
 315
 316 /* crypto.c */
 317 static inline void llcrypt_enqueue_decrypt_work(struct work_struct *work)
 318 {
 319 }
 320
 321 static inline struct llcrypt_ctx *llcrypt_get_ctx(gfp_t gfp_flags)
 322 {
 323         return ERR_PTR(-EOPNOTSUPP);
 324 }
 325
 326 static inline void llcrypt_release_ctx(struct llcrypt_ctx *ctx)
 327 {
 328         return;
 329 }
 330
 331 static inline struct page *llcrypt_encrypt_pagecache_blocks(struct page *page,
 332                                                             unsigned int len,
 333                                                             unsigned int offs,
 334                                                             gfp_t gfp_flags)
 335 {
 336         return ERR_PTR(-EOPNOTSUPP);
 337 }
 338
 339 static inline int llcrypt_encrypt_block_inplace(const struct inode *inode,
 340                                                 struct page *page,
 341                                                 unsigned int len,
 342                                                 unsigned int offs, u64 lblk_num,
 343                                                 gfp_t gfp_flags)
 344 {
 345         return -EOPNOTSUPP;
 346 }
 347
 348 static inline int llcrypt_decrypt_pagecache_blocks(struct page *page,
 349                                                    unsigned int len,
 350                                                    unsigned int offs)
 351 {
 352         return -EOPNOTSUPP;
 353 }
 354
 355 static inline int llcrypt_decrypt_block_inplace(const struct inode *inode,
 356                                                 struct page *page,
 357                                                 unsigned int len,
 358                                                 unsigned int offs, u64 lblk_num)
 359 {
 360         return -EOPNOTSUPP;
 361 }
 362
 363 static inline bool llcrypt_is_bounce_page(struct page *page)
 364 {
 365         return false;
 366 }
 367
 368 static inline struct page *llcrypt_pagecache_page(struct page *bounce_page)
 369 {
 370         WARN_ON_ONCE(1);
 371         return ERR_PTR(-EINVAL);
 372 }
 373
 374 static inline void llcrypt_free_bounce_page(struct page *bounce_page)
 375 {
 376 }
 377
 378 /* policy.c */
 379 static inline int llcrypt_ioctl_set_policy(struct file *filp,
 380                                            const void __user *arg)
 381 {
 382         return -EOPNOTSUPP;
 383 }
 384
 385 static inline int llcrypt_ioctl_get_policy(struct file *filp, void __user *arg)
 386 {
 387         return -EOPNOTSUPP;
 388 }
 389
 390 static inline int llcrypt_ioctl_get_policy_ex(struct file *filp,
 391                                               void __user *arg)
 392 {
 393         return -EOPNOTSUPP;
 394 }
 395
 396 static inline int llcrypt_has_permitted_context(struct inode *parent,
 397                                                 struct inode *child)
 398 {
 399         return 0;
 400 }
 401
 402 static inline int llcrypt_inherit_context(struct inode *parent,
 403                                           struct inode *child,
 404                                           void *fs_data, bool preload)
 405 {
 406         return -EOPNOTSUPP;
 407 }
 408 static inline bool llcrypt_policy_has_filename_enc(struct inode *inode)
 409 {
 410         return false;
 411 }
 412
 413 /* keyring.c */
 414 static inline void llcrypt_sb_free(struct super_block *sb)
 415 {
 416 }
 417
 418 static inline int llcrypt_ioctl_add_key(struct file *filp, void __user *arg)
 419 {
 420         return -EOPNOTSUPP;
 421 }
 422
 423 static inline int llcrypt_ioctl_remove_key(struct file *filp, void __user *arg)
 424 {
 425         return -EOPNOTSUPP;
 426 }
 427
 428 static inline int llcrypt_ioctl_remove_key_all_users(struct file *filp,
 429                                                      void __user *arg)
 430 {
 431         return -EOPNOTSUPP;
 432 }
 433
 434 static inline int llcrypt_ioctl_get_key_status(struct file *filp,
 435                                                void __user *arg)
 436 {
 437         return -EOPNOTSUPP;
 438 }
 439
 440 /* keysetup.c */
 441 static inline int llcrypt_get_encryption_info(struct inode *inode)
 442 {
 443         return -EOPNOTSUPP;
 444 }
 445
 446 static inline void llcrypt_put_encryption_info(struct inode *inode)
 447 {
 448         return;
 449 }
 450
 451 static inline void llcrypt_free_inode(struct inode *inode)
 452 {
 453 }
 454
 455 static inline int llcrypt_drop_inode(struct inode *inode)
 456 {
 457         return 0;
 458 }
 459
 460  /* fname.c */
 461 static inline int llcrypt_setup_filename(struct inode *dir,
 462                                          const struct qstr *iname,
 463                                          int lookup, struct llcrypt_name *fname)
 464 {
 465         if (IS_ENCRYPTED(dir))
 466                 return -EOPNOTSUPP;
 467
 468         memset(fname, 0, sizeof(*fname));
 469         fname->usr_fname = iname;
 470         fname->disk_name.name = (unsigned char *)iname->name;
 471         fname->disk_name.len = iname->len;
 472         return 0;
 473 }
 474
 475 static inline void llcrypt_free_filename(struct llcrypt_name *fname)
 476 {
 477         return;
 478 }
 479
 480 static inline int llcrypt_fname_alloc_buffer(const struct inode *inode,
 481                                              u32 max_encrypted_len,
 482                                              struct llcrypt_str *crypto_str)
 483 {
 484         return -EOPNOTSUPP;
 485 }
 486
 487 static inline void llcrypt_fname_free_buffer(struct llcrypt_str *crypto_str)
 488 {
 489         return;
 490 }
 491
 492 static inline int llcrypt_fname_disk_to_usr(struct inode *inode,
 493                                             u32 hash, u32 minor_hash,
 494                                             const struct llcrypt_str *iname,
 495                                             struct llcrypt_str *oname)
 496 {
 497         return -EOPNOTSUPP;
 498 }
 499
 500 static inline bool llcrypt_match_name(const struct llcrypt_name *fname,
 501                                       const u8 *de_name, u32 de_name_len)
 502 {
 503         /* Encryption support disabled; use standard comparison */
 504         if (de_name_len != fname->disk_name.len)
 505                 return false;
 506         return !memcmp(de_name, fname->disk_name.name, fname->disk_name.len);
 507 }
 508
 509 /* bio.c */
 510 static inline void llcrypt_decrypt_bio(struct bio *bio)
 511 {
 512 }
 513
 514 static inline void llcrypt_enqueue_decrypt_bio(struct llcrypt_ctx *ctx,
 515                                                struct bio *bio)
 516 {
 517 }
 518
 519 static inline int llcrypt_zeroout_range(const struct inode *inode, pgoff_t lblk,
 520                                         sector_t pblk, unsigned int len)
 521 {
 522         return -EOPNOTSUPP;
 523 }
 524
 525 /* hooks.c */
 526
 527 static inline int llcrypt_file_open(struct inode *inode, struct file *filp)
 528 {
 529         if (IS_ENCRYPTED(inode))
 530                 return -EOPNOTSUPP;
 531         return 0;
 532 }
 533
 534 static inline int __llcrypt_prepare_link(struct inode *inode, struct inode *dir,
 535                                          struct dentry *dentry)
 536 {
 537         return -EOPNOTSUPP;
 538 }
 539
 540 static inline int __llcrypt_prepare_rename(struct inode *old_dir,
 541                                            struct dentry *old_dentry,
 542                                            struct inode *new_dir,
 543                                            struct dentry *new_dentry,
 544                                            unsigned int flags)
 545 {
 546         return -EOPNOTSUPP;
 547 }
 548
 549 static inline int __llcrypt_prepare_lookup(struct inode *dir,
 550                                            struct dentry *dentry,
 551                                            struct llcrypt_name *fname)
 552 {
 553         return -EOPNOTSUPP;
 554 }
 555
 556 static inline int __llcrypt_prepare_symlink(struct inode *dir,
 557                                             unsigned int len,
 558                                             unsigned int max_len,
 559                                             struct llcrypt_str *disk_link)
 560 {
 561         return -EOPNOTSUPP;
 562 }
 563
 564
 565 static inline int __llcrypt_encrypt_symlink(struct inode *inode,
 566                                             const char *target,
 567                                             unsigned int len,
 568                                             struct llcrypt_str *disk_link)
 569 {
 570         return -EOPNOTSUPP;
 571 }
 572
 573 #define llcrypt_get_symlink(inode, caddr, max_size, done)   ERR_PTR(-EOPNOTSUPP)
 574
 575 static inline void llcrypt_set_ops(struct super_block *sb,
 576                                    const struct llcrypt_operations *lsi_cop)
 577 {
 578 }
 579
 580 #endif  /* !CONFIG_LL_ENCRYPTION */
 581
 582 /**
 583  * llcrypt_require_key - require an inode's encryption key
 584  * @inode: the inode we need the key for
 585  *
 586  * If the inode is encrypted, set up its encryption key if not already done.
 587  * Then require that the key be present and return -ENOKEY otherwise.
 588  *
 589  * No locks are needed, and the key will live as long as the struct inode --- so
 590  * it won't go away from under you.
 591  *
 592  * Return: 0 on success, -ENOKEY if the key is missing, or another -errno code
 593  * if a problem occurred while setting up the encryption key.
 594  */
 595 static inline int llcrypt_require_key(struct inode *inode)
 596 {
 597         if (IS_ENCRYPTED(inode)) {
 598                 int err = llcrypt_get_encryption_info(inode);
 599
 600                 if (err)
 601                         return err;
 602                 if (!llcrypt_has_encryption_key(inode))
 603                         return -ENOKEY;
 604         }
 605         return 0;
 606 }
 607
 608 /**
 609  * llcrypt_prepare_link - prepare to link an inode into a possibly-encrypted directory
 610  * @old_dentry: an existing dentry for the inode being linked
 611  * @dir: the target directory
 612  * @dentry: negative dentry for the target filename
 613  *
 614  * A new link can only be added to an encrypted directory if the directory's
 615  * encryption key is available --- since otherwise we'd have no way to encrypt
 616  * the filename.  Therefore, we first set up the directory's encryption key (if
 617  * not already done) and return an error if it's unavailable.
 618  *
 619  * We also verify that the link will not violate the constraint that all files
 620  * in an encrypted directory tree use the same encryption policy.
 621  *
 622  * Return: 0 on success, -ENOKEY if the directory's encryption key is missing,
 623  * -EXDEV if the link would result in an inconsistent encryption policy, or
 624  * another -errno code.
 625  */
 626 static inline int llcrypt_prepare_link(struct dentry *old_dentry,
 627                                        struct inode *dir,
 628                                        struct dentry *dentry)
 629 {
 630         if (IS_ENCRYPTED(dir))
 631                 return __llcrypt_prepare_link(d_inode(old_dentry), dir, dentry);
 632         return 0;
 633 }
 634
 635 /**
 636  * llcrypt_prepare_rename - prepare for a rename between possibly-encrypted directories
 637  * @old_dir: source directory
 638  * @old_dentry: dentry for source file
 639  * @new_dir: target directory
 640  * @new_dentry: dentry for target location (may be negative unless exchanging)
 641  * @flags: rename flags (we care at least about %RENAME_EXCHANGE)
 642  *
 643  * Prepare for ->rename() where the source and/or target directories may be
 644  * encrypted.  A new link can only be added to an encrypted directory if the
 645  * directory's encryption key is available --- since otherwise we'd have no way
 646  * to encrypt the filename.  A rename to an existing name, on the other hand,
 647  * *is* cryptographically possible without the key.  However, we take the more
 648  * conservative approach and just forbid all no-key renames.
 649  *
 650  * We also verify that the rename will not violate the constraint that all files
 651  * in an encrypted directory tree use the same encryption policy.
 652  *
 653  * Return: 0 on success, -ENOKEY if an encryption key is missing, -EXDEV if the
 654  * rename would cause inconsistent encryption policies, or another -errno code.
 655  */
 656 static inline int llcrypt_prepare_rename(struct inode *old_dir,
 657                                          struct dentry *old_dentry,
 658                                          struct inode *new_dir,
 659                                          struct dentry *new_dentry,
 660                                          unsigned int flags)
 661 {
 662         if (IS_ENCRYPTED(old_dir) || IS_ENCRYPTED(new_dir))
 663                 return __llcrypt_prepare_rename(old_dir, old_dentry,
 664                                                 new_dir, new_dentry, flags);
 665         return 0;
 666 }
 667
 668 /**
 669  * llcrypt_prepare_lookup - prepare to lookup a name in a possibly-encrypted directory
 670  * @dir: directory being searched
 671  * @dentry: filename being looked up
 672  * @fname: (output) the name to use to search the on-disk directory
 673  *
 674  * Prepare for ->lookup() in a directory which may be encrypted by determining
 675  * the name that will actually be used to search the directory on-disk.  Lookups
 676  * can be done with or without the directory's encryption key; without the key,
 677  * filenames are presented in encrypted form.  Therefore, we'll try to set up
 678  * the directory's encryption key, but even without it the lookup can continue.
 679  *
 680  * This also installs a custom ->d_revalidate() method which will invalidate the
 681  * dentry if it was created without the key and the key is later added.
 682  *
 683  * Return: 0 on success; -ENOENT if key is unavailable but the filename isn't a
 684  * correctly formed encoded ciphertext name, so a negative dentry should be
 685  * created; or another -errno code.
 686  */
 687 static inline int llcrypt_prepare_lookup(struct inode *dir,
 688                                          struct dentry *dentry,
 689                                          struct llcrypt_name *fname)
 690 {
 691         if (IS_ENCRYPTED(dir))
 692                 return __llcrypt_prepare_lookup(dir, dentry, fname);
 693
 694         memset(fname, 0, sizeof(*fname));
 695         fname->usr_fname = &dentry->d_name;
 696         fname->disk_name.name = (unsigned char *)dentry->d_name.name;
 697         fname->disk_name.len = dentry->d_name.len;
 698         return 0;
 699 }
 700
 701 /**
 702  * llcrypt_prepare_setattr - prepare to change a possibly-encrypted inode's attributes
 703  * @dentry: dentry through which the inode is being changed
 704  * @attr: attributes to change
 705  *
 706  * Prepare for ->setattr() on a possibly-encrypted inode.  On an encrypted file,
 707  * most attribute changes are allowed even without the encryption key.  However,
 708  * without the encryption key we do have to forbid truncates.  This is needed
 709  * because the size being truncated to may not be a multiple of the filesystem
 710  * block size, and in that case we'd have to decrypt the final block, zero the
 711  * portion past i_size, and re-encrypt it.  (We *could* allow truncating to a
 712  * filesystem block boundary, but it's simpler to just forbid all truncates ---
 713  * and we already forbid all other contents modifications without the key.)
 714  *
 715  * Return: 0 on success, -ENOKEY if the key is missing, or another -errno code
 716  * if a problem occurred while setting up the encryption key.
 717  */
 718 static inline int llcrypt_prepare_setattr(struct dentry *dentry,
 719                                           struct iattr *attr)
 720 {
 721         if (attr->ia_valid & ATTR_SIZE)
 722                 return llcrypt_require_key(d_inode(dentry));
 723         return 0;
 724 }
 725
 726 /**
 727  * llcrypt_prepare_symlink - prepare to create a possibly-encrypted symlink
 728  * @dir: directory in which the symlink is being created
 729  * @target: plaintext symlink target
 730  * @len: length of @target excluding null terminator
 731  * @max_len: space the filesystem has available to store the symlink target
 732  * @disk_link: (out) the on-disk symlink target being prepared
 733  *
 734  * This function computes the size the symlink target will require on-disk,
 735  * stores it in @disk_link->len, and validates it against @max_len.  An
 736  * encrypted symlink may be longer than the original.
 737  *
 738  * Additionally, @disk_link->name is set to @target if the symlink will be
 739  * unencrypted, but left NULL if the symlink will be encrypted.  For encrypted
 740  * symlinks, the filesystem must call llcrypt_encrypt_symlink() to create the
 741  * on-disk target later.  (The reason for the two-step process is that some
 742  * filesystems need to know the size of the symlink target before creating the
 743  * inode, e.g. to determine whether it will be a "fast" or "slow" symlink.)
 744  *
 745  * Return: 0 on success, -ENAMETOOLONG if the symlink target is too long,
 746  * -ENOKEY if the encryption key is missing, or another -errno code if a problem
 747  * occurred while setting up the encryption key.
 748  */
 749 static inline int llcrypt_prepare_symlink(struct inode *dir,
 750                                           const char *target,
 751                                           unsigned int len,
 752                                           unsigned int max_len,
 753                                           struct llcrypt_str *disk_link)
 754 {
 755         if ((IS_ENCRYPTED(dir) &&
 756              likely(llcrypt_policy_has_filename_enc(dir))) ||
 757             llcrypt_dummy_context_enabled(dir))
 758                 return __llcrypt_prepare_symlink(dir, len, max_len, disk_link);
 759
 760         disk_link->name = (unsigned char *)target;
 761         disk_link->len = len + 1;
 762         if (disk_link->len > max_len)
 763                 return -ENAMETOOLONG;
 764         return 0;
 765 }
 766
 767 /**
 768  * llcrypt_encrypt_symlink - encrypt the symlink target if needed
 769  * @inode: symlink inode
 770  * @target: plaintext symlink target
 771  * @len: length of @target excluding null terminator
 772  * @disk_link: (in/out) the on-disk symlink target being prepared
 773  *
 774  * If the symlink target needs to be encrypted, then this function encrypts it
 775  * into @disk_link->name.  llcrypt_prepare_symlink() must have been called
 776  * previously to compute @disk_link->len.  If the filesystem did not allocate a
 777  * buffer for @disk_link->name after calling llcrypt_prepare_link(), then one
 778  * will be kmalloc()'ed and the filesystem will be responsible for freeing it.
 779  *
 780  * Return: 0 on success, -errno on failure
 781  */
 782 static inline int llcrypt_encrypt_symlink(struct inode *inode,
 783                                           const char *target,
 784                                           unsigned int len,
 785                                           struct llcrypt_str *disk_link)
 786 {
 787         if (IS_ENCRYPTED(inode))
 788                 return __llcrypt_encrypt_symlink(inode, target, len, disk_link);
 789         return 0;
 790 }
 791
 792 /* If *pagep is a bounce page, free it and set *pagep to the pagecache page */
 793 static inline void llcrypt_finalize_bounce_page(struct page **pagep)
 794 {
 795         struct page *page = *pagep;
 796
 797         if (llcrypt_is_bounce_page(page)) {
 798                 *pagep = llcrypt_pagecache_page(page);
 799                 llcrypt_free_bounce_page(page);
 800         }
 801 }
 802
 803 #endif  /* _LINUX_LLCRYPT_H */