15fee3609SSatya Tangirala // SPDX-License-Identifier: GPL-2.0 25fee3609SSatya Tangirala /* 35fee3609SSatya Tangirala * Inline encryption support for fscrypt 45fee3609SSatya Tangirala * 55fee3609SSatya Tangirala * Copyright 2019 Google LLC 65fee3609SSatya Tangirala */ 75fee3609SSatya Tangirala 85fee3609SSatya Tangirala /* 95fee3609SSatya Tangirala * With "inline encryption", the block layer handles the decryption/encryption 105fee3609SSatya Tangirala * as part of the bio, instead of the filesystem doing the crypto itself via 115fee3609SSatya Tangirala * crypto API. See Documentation/block/inline-encryption.rst. fscrypt still 125fee3609SSatya Tangirala * provides the key and IV to use. 135fee3609SSatya Tangirala */ 145fee3609SSatya Tangirala 15a7a5bc5fSEric Biggers #include <linux/blk-crypto-profile.h> 165fee3609SSatya Tangirala #include <linux/blkdev.h> 175fee3609SSatya Tangirala #include <linux/buffer_head.h> 185fee3609SSatya Tangirala #include <linux/sched/mm.h> 19453431a5SWaiman Long #include <linux/slab.h> 20c6c89783SEric Biggers #include <linux/uio.h> 215fee3609SSatya Tangirala 225fee3609SSatya Tangirala #include "fscrypt_private.h" 235fee3609SSatya Tangirala 245fee3609SSatya Tangirala struct fscrypt_blk_crypto_key { 255fee3609SSatya Tangirala struct blk_crypto_key base; 265fee3609SSatya Tangirala int num_devs; 275fee3609SSatya Tangirala struct request_queue *devs[]; 285fee3609SSatya Tangirala }; 295fee3609SSatya Tangirala 305fee3609SSatya Tangirala static int fscrypt_get_num_devices(struct super_block *sb) 315fee3609SSatya Tangirala { 325fee3609SSatya Tangirala if (sb->s_cop->get_num_devices) 335fee3609SSatya Tangirala return sb->s_cop->get_num_devices(sb); 345fee3609SSatya Tangirala return 1; 355fee3609SSatya Tangirala } 365fee3609SSatya Tangirala 375fee3609SSatya Tangirala static void fscrypt_get_devices(struct super_block *sb, int num_devs, 385fee3609SSatya Tangirala struct request_queue **devs) 395fee3609SSatya Tangirala { 405fee3609SSatya Tangirala if (num_devs == 1) 415fee3609SSatya Tangirala devs[0] = bdev_get_queue(sb->s_bdev); 425fee3609SSatya Tangirala else 435fee3609SSatya Tangirala sb->s_cop->get_devices(sb, devs); 445fee3609SSatya Tangirala } 455fee3609SSatya Tangirala 465fee3609SSatya Tangirala static unsigned int fscrypt_get_dun_bytes(const struct fscrypt_info *ci) 475fee3609SSatya Tangirala { 485fee3609SSatya Tangirala struct super_block *sb = ci->ci_inode->i_sb; 495fee3609SSatya Tangirala unsigned int flags = fscrypt_policy_flags(&ci->ci_policy); 505fee3609SSatya Tangirala int ino_bits = 64, lblk_bits = 64; 515fee3609SSatya Tangirala 525fee3609SSatya Tangirala if (flags & FSCRYPT_POLICY_FLAG_DIRECT_KEY) 535fee3609SSatya Tangirala return offsetofend(union fscrypt_iv, nonce); 545fee3609SSatya Tangirala 555fee3609SSatya Tangirala if (flags & FSCRYPT_POLICY_FLAG_IV_INO_LBLK_64) 565fee3609SSatya Tangirala return sizeof(__le64); 575fee3609SSatya Tangirala 585fee3609SSatya Tangirala if (flags & FSCRYPT_POLICY_FLAG_IV_INO_LBLK_32) 595fee3609SSatya Tangirala return sizeof(__le32); 605fee3609SSatya Tangirala 615fee3609SSatya Tangirala /* Default case: IVs are just the file logical block number */ 625fee3609SSatya Tangirala if (sb->s_cop->get_ino_and_lblk_bits) 635fee3609SSatya Tangirala sb->s_cop->get_ino_and_lblk_bits(sb, &ino_bits, &lblk_bits); 645fee3609SSatya Tangirala return DIV_ROUND_UP(lblk_bits, 8); 655fee3609SSatya Tangirala } 665fee3609SSatya Tangirala 67a7a5bc5fSEric Biggers /* 68a7a5bc5fSEric Biggers * Log a message when starting to use blk-crypto (native) or blk-crypto-fallback 69a7a5bc5fSEric Biggers * for an encryption mode for the first time. This is the blk-crypto 70a7a5bc5fSEric Biggers * counterpart to the message logged when starting to use the crypto API for the 71a7a5bc5fSEric Biggers * first time. A limitation is that these messages don't convey which specific 72a7a5bc5fSEric Biggers * filesystems or files are using each implementation. However, *usually* 73a7a5bc5fSEric Biggers * systems use just one implementation per mode, which makes these messages 74a7a5bc5fSEric Biggers * helpful for debugging problems where the "wrong" implementation is used. 75a7a5bc5fSEric Biggers */ 76a7a5bc5fSEric Biggers static void fscrypt_log_blk_crypto_impl(struct fscrypt_mode *mode, 77a7a5bc5fSEric Biggers struct request_queue **devs, 78a7a5bc5fSEric Biggers int num_devs, 79a7a5bc5fSEric Biggers const struct blk_crypto_config *cfg) 80a7a5bc5fSEric Biggers { 81a7a5bc5fSEric Biggers int i; 82a7a5bc5fSEric Biggers 83a7a5bc5fSEric Biggers for (i = 0; i < num_devs; i++) { 84a7a5bc5fSEric Biggers if (!IS_ENABLED(CONFIG_BLK_INLINE_ENCRYPTION_FALLBACK) || 85a7a5bc5fSEric Biggers __blk_crypto_cfg_supported(devs[i]->crypto_profile, cfg)) { 86a7a5bc5fSEric Biggers if (!xchg(&mode->logged_blk_crypto_native, 1)) 87a7a5bc5fSEric Biggers pr_info("fscrypt: %s using blk-crypto (native)\n", 88a7a5bc5fSEric Biggers mode->friendly_name); 89a7a5bc5fSEric Biggers } else if (!xchg(&mode->logged_blk_crypto_fallback, 1)) { 90a7a5bc5fSEric Biggers pr_info("fscrypt: %s using blk-crypto-fallback\n", 91a7a5bc5fSEric Biggers mode->friendly_name); 92a7a5bc5fSEric Biggers } 93a7a5bc5fSEric Biggers } 94a7a5bc5fSEric Biggers } 95a7a5bc5fSEric Biggers 965fee3609SSatya Tangirala /* Enable inline encryption for this file if supported. */ 975fee3609SSatya Tangirala int fscrypt_select_encryption_impl(struct fscrypt_info *ci) 985fee3609SSatya Tangirala { 995fee3609SSatya Tangirala const struct inode *inode = ci->ci_inode; 1005fee3609SSatya Tangirala struct super_block *sb = inode->i_sb; 1015fee3609SSatya Tangirala struct blk_crypto_config crypto_cfg; 1025fee3609SSatya Tangirala int num_devs; 1035fee3609SSatya Tangirala struct request_queue **devs; 1045fee3609SSatya Tangirala int i; 1055fee3609SSatya Tangirala 1065fee3609SSatya Tangirala /* The file must need contents encryption, not filenames encryption */ 107d19d8d34SEric Biggers if (!S_ISREG(inode->i_mode)) 1085fee3609SSatya Tangirala return 0; 1095fee3609SSatya Tangirala 1105fee3609SSatya Tangirala /* The crypto mode must have a blk-crypto counterpart */ 1115fee3609SSatya Tangirala if (ci->ci_mode->blk_crypto_mode == BLK_ENCRYPTION_MODE_INVALID) 1125fee3609SSatya Tangirala return 0; 1135fee3609SSatya Tangirala 1145fee3609SSatya Tangirala /* The filesystem must be mounted with -o inlinecrypt */ 1155fee3609SSatya Tangirala if (!(sb->s_flags & SB_INLINECRYPT)) 1165fee3609SSatya Tangirala return 0; 1175fee3609SSatya Tangirala 1185fee3609SSatya Tangirala /* 1195fee3609SSatya Tangirala * When a page contains multiple logically contiguous filesystem blocks, 1205fee3609SSatya Tangirala * some filesystem code only calls fscrypt_mergeable_bio() for the first 1215fee3609SSatya Tangirala * block in the page. This is fine for most of fscrypt's IV generation 1225fee3609SSatya Tangirala * strategies, where contiguous blocks imply contiguous IVs. But it 1235fee3609SSatya Tangirala * doesn't work with IV_INO_LBLK_32. For now, simply exclude 1245fee3609SSatya Tangirala * IV_INO_LBLK_32 with blocksize != PAGE_SIZE from inline encryption. 1255fee3609SSatya Tangirala */ 1265fee3609SSatya Tangirala if ((fscrypt_policy_flags(&ci->ci_policy) & 1275fee3609SSatya Tangirala FSCRYPT_POLICY_FLAG_IV_INO_LBLK_32) && 1285fee3609SSatya Tangirala sb->s_blocksize != PAGE_SIZE) 1295fee3609SSatya Tangirala return 0; 1305fee3609SSatya Tangirala 1315fee3609SSatya Tangirala /* 1325fee3609SSatya Tangirala * On all the filesystem's devices, blk-crypto must support the crypto 1335fee3609SSatya Tangirala * configuration that the file would use. 1345fee3609SSatya Tangirala */ 1355fee3609SSatya Tangirala crypto_cfg.crypto_mode = ci->ci_mode->blk_crypto_mode; 1365fee3609SSatya Tangirala crypto_cfg.data_unit_size = sb->s_blocksize; 1375fee3609SSatya Tangirala crypto_cfg.dun_bytes = fscrypt_get_dun_bytes(ci); 1385fee3609SSatya Tangirala num_devs = fscrypt_get_num_devices(sb); 1399dad5febSEric Biggers devs = kmalloc_array(num_devs, sizeof(*devs), GFP_KERNEL); 1405fee3609SSatya Tangirala if (!devs) 1415fee3609SSatya Tangirala return -ENOMEM; 1425fee3609SSatya Tangirala fscrypt_get_devices(sb, num_devs, devs); 1435fee3609SSatya Tangirala 1445fee3609SSatya Tangirala for (i = 0; i < num_devs; i++) { 1455fee3609SSatya Tangirala if (!blk_crypto_config_supported(devs[i], &crypto_cfg)) 1465fee3609SSatya Tangirala goto out_free_devs; 1475fee3609SSatya Tangirala } 1485fee3609SSatya Tangirala 149a7a5bc5fSEric Biggers fscrypt_log_blk_crypto_impl(ci->ci_mode, devs, num_devs, &crypto_cfg); 150a7a5bc5fSEric Biggers 1515fee3609SSatya Tangirala ci->ci_inlinecrypt = true; 1525fee3609SSatya Tangirala out_free_devs: 1535fee3609SSatya Tangirala kfree(devs); 1545fee3609SSatya Tangirala 1555fee3609SSatya Tangirala return 0; 1565fee3609SSatya Tangirala } 1575fee3609SSatya Tangirala 1585fee3609SSatya Tangirala int fscrypt_prepare_inline_crypt_key(struct fscrypt_prepared_key *prep_key, 1595fee3609SSatya Tangirala const u8 *raw_key, 1605fee3609SSatya Tangirala const struct fscrypt_info *ci) 1615fee3609SSatya Tangirala { 1625fee3609SSatya Tangirala const struct inode *inode = ci->ci_inode; 1635fee3609SSatya Tangirala struct super_block *sb = inode->i_sb; 1645fee3609SSatya Tangirala enum blk_crypto_mode_num crypto_mode = ci->ci_mode->blk_crypto_mode; 1655fee3609SSatya Tangirala int num_devs = fscrypt_get_num_devices(sb); 1665fee3609SSatya Tangirala int queue_refs = 0; 1675fee3609SSatya Tangirala struct fscrypt_blk_crypto_key *blk_key; 1685fee3609SSatya Tangirala int err; 1695fee3609SSatya Tangirala int i; 1705fee3609SSatya Tangirala 1719dad5febSEric Biggers blk_key = kzalloc(struct_size(blk_key, devs, num_devs), GFP_KERNEL); 1725fee3609SSatya Tangirala if (!blk_key) 1735fee3609SSatya Tangirala return -ENOMEM; 1745fee3609SSatya Tangirala 1755fee3609SSatya Tangirala blk_key->num_devs = num_devs; 1765fee3609SSatya Tangirala fscrypt_get_devices(sb, num_devs, blk_key->devs); 1775fee3609SSatya Tangirala 1785fee3609SSatya Tangirala err = blk_crypto_init_key(&blk_key->base, raw_key, crypto_mode, 1795fee3609SSatya Tangirala fscrypt_get_dun_bytes(ci), sb->s_blocksize); 1805fee3609SSatya Tangirala if (err) { 1815fee3609SSatya Tangirala fscrypt_err(inode, "error %d initializing blk-crypto key", err); 1825fee3609SSatya Tangirala goto fail; 1835fee3609SSatya Tangirala } 1845fee3609SSatya Tangirala 1855fee3609SSatya Tangirala /* 1865fee3609SSatya Tangirala * We have to start using blk-crypto on all the filesystem's devices. 1875fee3609SSatya Tangirala * We also have to save all the request_queue's for later so that the 1885fee3609SSatya Tangirala * key can be evicted from them. This is needed because some keys 1895fee3609SSatya Tangirala * aren't destroyed until after the filesystem was already unmounted 1905fee3609SSatya Tangirala * (namely, the per-mode keys in struct fscrypt_master_key). 1915fee3609SSatya Tangirala */ 1925fee3609SSatya Tangirala for (i = 0; i < num_devs; i++) { 1935fee3609SSatya Tangirala if (!blk_get_queue(blk_key->devs[i])) { 1945fee3609SSatya Tangirala fscrypt_err(inode, "couldn't get request_queue"); 1955fee3609SSatya Tangirala err = -EAGAIN; 1965fee3609SSatya Tangirala goto fail; 1975fee3609SSatya Tangirala } 1985fee3609SSatya Tangirala queue_refs++; 1995fee3609SSatya Tangirala 2005fee3609SSatya Tangirala err = blk_crypto_start_using_key(&blk_key->base, 2015fee3609SSatya Tangirala blk_key->devs[i]); 2025fee3609SSatya Tangirala if (err) { 2035fee3609SSatya Tangirala fscrypt_err(inode, 2045fee3609SSatya Tangirala "error %d starting to use blk-crypto", err); 2055fee3609SSatya Tangirala goto fail; 2065fee3609SSatya Tangirala } 2075fee3609SSatya Tangirala } 2085fee3609SSatya Tangirala /* 20997c6327fSEric Biggers * Pairs with the smp_load_acquire() in fscrypt_is_key_prepared(). 21097c6327fSEric Biggers * I.e., here we publish ->blk_key with a RELEASE barrier so that 21197c6327fSEric Biggers * concurrent tasks can ACQUIRE it. Note that this concurrency is only 21297c6327fSEric Biggers * possible for per-mode keys, not for per-file keys. 2135fee3609SSatya Tangirala */ 2145fee3609SSatya Tangirala smp_store_release(&prep_key->blk_key, blk_key); 2155fee3609SSatya Tangirala return 0; 2165fee3609SSatya Tangirala 2175fee3609SSatya Tangirala fail: 2185fee3609SSatya Tangirala for (i = 0; i < queue_refs; i++) 2195fee3609SSatya Tangirala blk_put_queue(blk_key->devs[i]); 220453431a5SWaiman Long kfree_sensitive(blk_key); 2215fee3609SSatya Tangirala return err; 2225fee3609SSatya Tangirala } 2235fee3609SSatya Tangirala 2245fee3609SSatya Tangirala void fscrypt_destroy_inline_crypt_key(struct fscrypt_prepared_key *prep_key) 2255fee3609SSatya Tangirala { 2265fee3609SSatya Tangirala struct fscrypt_blk_crypto_key *blk_key = prep_key->blk_key; 2275fee3609SSatya Tangirala int i; 2285fee3609SSatya Tangirala 2295fee3609SSatya Tangirala if (blk_key) { 2305fee3609SSatya Tangirala for (i = 0; i < blk_key->num_devs; i++) { 2315fee3609SSatya Tangirala blk_crypto_evict_key(blk_key->devs[i], &blk_key->base); 2325fee3609SSatya Tangirala blk_put_queue(blk_key->devs[i]); 2335fee3609SSatya Tangirala } 234453431a5SWaiman Long kfree_sensitive(blk_key); 2355fee3609SSatya Tangirala } 2365fee3609SSatya Tangirala } 2375fee3609SSatya Tangirala 2385fee3609SSatya Tangirala bool __fscrypt_inode_uses_inline_crypto(const struct inode *inode) 2395fee3609SSatya Tangirala { 2405fee3609SSatya Tangirala return inode->i_crypt_info->ci_inlinecrypt; 2415fee3609SSatya Tangirala } 2425fee3609SSatya Tangirala EXPORT_SYMBOL_GPL(__fscrypt_inode_uses_inline_crypto); 2435fee3609SSatya Tangirala 2445fee3609SSatya Tangirala static void fscrypt_generate_dun(const struct fscrypt_info *ci, u64 lblk_num, 2455fee3609SSatya Tangirala u64 dun[BLK_CRYPTO_DUN_ARRAY_SIZE]) 2465fee3609SSatya Tangirala { 2475fee3609SSatya Tangirala union fscrypt_iv iv; 2485fee3609SSatya Tangirala int i; 2495fee3609SSatya Tangirala 2505fee3609SSatya Tangirala fscrypt_generate_iv(&iv, lblk_num, ci); 2515fee3609SSatya Tangirala 2525fee3609SSatya Tangirala BUILD_BUG_ON(FSCRYPT_MAX_IV_SIZE > BLK_CRYPTO_MAX_IV_SIZE); 2535fee3609SSatya Tangirala memset(dun, 0, BLK_CRYPTO_MAX_IV_SIZE); 2545fee3609SSatya Tangirala for (i = 0; i < ci->ci_mode->ivsize/sizeof(dun[0]); i++) 2555fee3609SSatya Tangirala dun[i] = le64_to_cpu(iv.dun[i]); 2565fee3609SSatya Tangirala } 2575fee3609SSatya Tangirala 2585fee3609SSatya Tangirala /** 2595fee3609SSatya Tangirala * fscrypt_set_bio_crypt_ctx() - prepare a file contents bio for inline crypto 2605fee3609SSatya Tangirala * @bio: a bio which will eventually be submitted to the file 2615fee3609SSatya Tangirala * @inode: the file's inode 2625fee3609SSatya Tangirala * @first_lblk: the first file logical block number in the I/O 2635fee3609SSatya Tangirala * @gfp_mask: memory allocation flags - these must be a waiting mask so that 2645fee3609SSatya Tangirala * bio_crypt_set_ctx can't fail. 2655fee3609SSatya Tangirala * 2665fee3609SSatya Tangirala * If the contents of the file should be encrypted (or decrypted) with inline 2675fee3609SSatya Tangirala * encryption, then assign the appropriate encryption context to the bio. 2685fee3609SSatya Tangirala * 2695fee3609SSatya Tangirala * Normally the bio should be newly allocated (i.e. no pages added yet), as 2705fee3609SSatya Tangirala * otherwise fscrypt_mergeable_bio() won't work as intended. 2715fee3609SSatya Tangirala * 2725fee3609SSatya Tangirala * The encryption context will be freed automatically when the bio is freed. 2735fee3609SSatya Tangirala */ 2745fee3609SSatya Tangirala void fscrypt_set_bio_crypt_ctx(struct bio *bio, const struct inode *inode, 2755fee3609SSatya Tangirala u64 first_lblk, gfp_t gfp_mask) 2765fee3609SSatya Tangirala { 27755e32c54SEric Biggers const struct fscrypt_info *ci; 2785fee3609SSatya Tangirala u64 dun[BLK_CRYPTO_DUN_ARRAY_SIZE]; 2795fee3609SSatya Tangirala 2805fee3609SSatya Tangirala if (!fscrypt_inode_uses_inline_crypto(inode)) 2815fee3609SSatya Tangirala return; 28255e32c54SEric Biggers ci = inode->i_crypt_info; 2835fee3609SSatya Tangirala 2845fee3609SSatya Tangirala fscrypt_generate_dun(ci, first_lblk, dun); 2855fee3609SSatya Tangirala bio_crypt_set_ctx(bio, &ci->ci_enc_key.blk_key->base, dun, gfp_mask); 2865fee3609SSatya Tangirala } 2875fee3609SSatya Tangirala EXPORT_SYMBOL_GPL(fscrypt_set_bio_crypt_ctx); 2885fee3609SSatya Tangirala 2895fee3609SSatya Tangirala /* Extract the inode and logical block number from a buffer_head. */ 2905fee3609SSatya Tangirala static bool bh_get_inode_and_lblk_num(const struct buffer_head *bh, 2915fee3609SSatya Tangirala const struct inode **inode_ret, 2925fee3609SSatya Tangirala u64 *lblk_num_ret) 2935fee3609SSatya Tangirala { 2945fee3609SSatya Tangirala struct page *page = bh->b_page; 2955fee3609SSatya Tangirala const struct address_space *mapping; 2965fee3609SSatya Tangirala const struct inode *inode; 2975fee3609SSatya Tangirala 2985fee3609SSatya Tangirala /* 2995fee3609SSatya Tangirala * The ext4 journal (jbd2) can submit a buffer_head it directly created 3005fee3609SSatya Tangirala * for a non-pagecache page. fscrypt doesn't care about these. 3015fee3609SSatya Tangirala */ 3025fee3609SSatya Tangirala mapping = page_mapping(page); 3035fee3609SSatya Tangirala if (!mapping) 3045fee3609SSatya Tangirala return false; 3055fee3609SSatya Tangirala inode = mapping->host; 3065fee3609SSatya Tangirala 3075fee3609SSatya Tangirala *inode_ret = inode; 3085fee3609SSatya Tangirala *lblk_num_ret = ((u64)page->index << (PAGE_SHIFT - inode->i_blkbits)) + 3095fee3609SSatya Tangirala (bh_offset(bh) >> inode->i_blkbits); 3105fee3609SSatya Tangirala return true; 3115fee3609SSatya Tangirala } 3125fee3609SSatya Tangirala 3135fee3609SSatya Tangirala /** 3145fee3609SSatya Tangirala * fscrypt_set_bio_crypt_ctx_bh() - prepare a file contents bio for inline 3155fee3609SSatya Tangirala * crypto 3165fee3609SSatya Tangirala * @bio: a bio which will eventually be submitted to the file 3175fee3609SSatya Tangirala * @first_bh: the first buffer_head for which I/O will be submitted 3185fee3609SSatya Tangirala * @gfp_mask: memory allocation flags 3195fee3609SSatya Tangirala * 3205fee3609SSatya Tangirala * Same as fscrypt_set_bio_crypt_ctx(), except this takes a buffer_head instead 3215fee3609SSatya Tangirala * of an inode and block number directly. 3225fee3609SSatya Tangirala */ 3235fee3609SSatya Tangirala void fscrypt_set_bio_crypt_ctx_bh(struct bio *bio, 3245fee3609SSatya Tangirala const struct buffer_head *first_bh, 3255fee3609SSatya Tangirala gfp_t gfp_mask) 3265fee3609SSatya Tangirala { 3275fee3609SSatya Tangirala const struct inode *inode; 3285fee3609SSatya Tangirala u64 first_lblk; 3295fee3609SSatya Tangirala 3305fee3609SSatya Tangirala if (bh_get_inode_and_lblk_num(first_bh, &inode, &first_lblk)) 3315fee3609SSatya Tangirala fscrypt_set_bio_crypt_ctx(bio, inode, first_lblk, gfp_mask); 3325fee3609SSatya Tangirala } 3335fee3609SSatya Tangirala EXPORT_SYMBOL_GPL(fscrypt_set_bio_crypt_ctx_bh); 3345fee3609SSatya Tangirala 3355fee3609SSatya Tangirala /** 3365fee3609SSatya Tangirala * fscrypt_mergeable_bio() - test whether data can be added to a bio 3375fee3609SSatya Tangirala * @bio: the bio being built up 3385fee3609SSatya Tangirala * @inode: the inode for the next part of the I/O 3395fee3609SSatya Tangirala * @next_lblk: the next file logical block number in the I/O 3405fee3609SSatya Tangirala * 3415fee3609SSatya Tangirala * When building a bio which may contain data which should undergo inline 3425fee3609SSatya Tangirala * encryption (or decryption) via fscrypt, filesystems should call this function 3435fee3609SSatya Tangirala * to ensure that the resulting bio contains only contiguous data unit numbers. 3445fee3609SSatya Tangirala * This will return false if the next part of the I/O cannot be merged with the 3455fee3609SSatya Tangirala * bio because either the encryption key would be different or the encryption 3465fee3609SSatya Tangirala * data unit numbers would be discontiguous. 3475fee3609SSatya Tangirala * 3485fee3609SSatya Tangirala * fscrypt_set_bio_crypt_ctx() must have already been called on the bio. 3495fee3609SSatya Tangirala * 350c6c89783SEric Biggers * This function isn't required in cases where crypto-mergeability is ensured in 351c6c89783SEric Biggers * another way, such as I/O targeting only a single file (and thus a single key) 352c6c89783SEric Biggers * combined with fscrypt_limit_io_blocks() to ensure DUN contiguity. 353c6c89783SEric Biggers * 3545fee3609SSatya Tangirala * Return: true iff the I/O is mergeable 3555fee3609SSatya Tangirala */ 3565fee3609SSatya Tangirala bool fscrypt_mergeable_bio(struct bio *bio, const struct inode *inode, 3575fee3609SSatya Tangirala u64 next_lblk) 3585fee3609SSatya Tangirala { 3595fee3609SSatya Tangirala const struct bio_crypt_ctx *bc = bio->bi_crypt_context; 3605fee3609SSatya Tangirala u64 next_dun[BLK_CRYPTO_DUN_ARRAY_SIZE]; 3615fee3609SSatya Tangirala 3625fee3609SSatya Tangirala if (!!bc != fscrypt_inode_uses_inline_crypto(inode)) 3635fee3609SSatya Tangirala return false; 3645fee3609SSatya Tangirala if (!bc) 3655fee3609SSatya Tangirala return true; 3665fee3609SSatya Tangirala 3675fee3609SSatya Tangirala /* 3685fee3609SSatya Tangirala * Comparing the key pointers is good enough, as all I/O for each key 3695fee3609SSatya Tangirala * uses the same pointer. I.e., there's currently no need to support 3705fee3609SSatya Tangirala * merging requests where the keys are the same but the pointers differ. 3715fee3609SSatya Tangirala */ 3725fee3609SSatya Tangirala if (bc->bc_key != &inode->i_crypt_info->ci_enc_key.blk_key->base) 3735fee3609SSatya Tangirala return false; 3745fee3609SSatya Tangirala 3755fee3609SSatya Tangirala fscrypt_generate_dun(inode->i_crypt_info, next_lblk, next_dun); 3765fee3609SSatya Tangirala return bio_crypt_dun_is_contiguous(bc, bio->bi_iter.bi_size, next_dun); 3775fee3609SSatya Tangirala } 3785fee3609SSatya Tangirala EXPORT_SYMBOL_GPL(fscrypt_mergeable_bio); 3795fee3609SSatya Tangirala 3805fee3609SSatya Tangirala /** 3815fee3609SSatya Tangirala * fscrypt_mergeable_bio_bh() - test whether data can be added to a bio 3825fee3609SSatya Tangirala * @bio: the bio being built up 3835fee3609SSatya Tangirala * @next_bh: the next buffer_head for which I/O will be submitted 3845fee3609SSatya Tangirala * 3855fee3609SSatya Tangirala * Same as fscrypt_mergeable_bio(), except this takes a buffer_head instead of 3865fee3609SSatya Tangirala * an inode and block number directly. 3875fee3609SSatya Tangirala * 3885fee3609SSatya Tangirala * Return: true iff the I/O is mergeable 3895fee3609SSatya Tangirala */ 3905fee3609SSatya Tangirala bool fscrypt_mergeable_bio_bh(struct bio *bio, 3915fee3609SSatya Tangirala const struct buffer_head *next_bh) 3925fee3609SSatya Tangirala { 3935fee3609SSatya Tangirala const struct inode *inode; 3945fee3609SSatya Tangirala u64 next_lblk; 3955fee3609SSatya Tangirala 3965fee3609SSatya Tangirala if (!bh_get_inode_and_lblk_num(next_bh, &inode, &next_lblk)) 3975fee3609SSatya Tangirala return !bio->bi_crypt_context; 3985fee3609SSatya Tangirala 3995fee3609SSatya Tangirala return fscrypt_mergeable_bio(bio, inode, next_lblk); 4005fee3609SSatya Tangirala } 4015fee3609SSatya Tangirala EXPORT_SYMBOL_GPL(fscrypt_mergeable_bio_bh); 402c6c89783SEric Biggers 403c6c89783SEric Biggers /** 404*53dd3f80SEric Biggers * fscrypt_dio_supported() - check whether DIO (direct I/O) is supported on an 405*53dd3f80SEric Biggers * inode, as far as encryption is concerned 406*53dd3f80SEric Biggers * @inode: the inode in question 407c6c89783SEric Biggers * 408c6c89783SEric Biggers * Return: %true if there are no encryption constraints that prevent DIO from 409c6c89783SEric Biggers * being supported; %false if DIO is unsupported. (Note that in the 410c6c89783SEric Biggers * %true case, the filesystem might have other, non-encryption-related 411*53dd3f80SEric Biggers * constraints that prevent DIO from actually being supported. Also, on 412*53dd3f80SEric Biggers * encrypted files the filesystem is still responsible for only allowing 413*53dd3f80SEric Biggers * DIO when requests are filesystem-block-aligned.) 414c6c89783SEric Biggers */ 415*53dd3f80SEric Biggers bool fscrypt_dio_supported(struct inode *inode) 416c6c89783SEric Biggers { 417*53dd3f80SEric Biggers int err; 418c6c89783SEric Biggers 419c6c89783SEric Biggers /* If the file is unencrypted, no veto from us. */ 420c6c89783SEric Biggers if (!fscrypt_needs_contents_encryption(inode)) 421c6c89783SEric Biggers return true; 422c6c89783SEric Biggers 423c6c89783SEric Biggers /* 424*53dd3f80SEric Biggers * We only support DIO with inline crypto, not fs-layer crypto. 425c6c89783SEric Biggers * 426*53dd3f80SEric Biggers * To determine whether the inode is using inline crypto, we have to set 427*53dd3f80SEric Biggers * up the key if it wasn't already done. This is because in the current 428*53dd3f80SEric Biggers * design of fscrypt, the decision of whether to use inline crypto or 429*53dd3f80SEric Biggers * not isn't made until the inode's encryption key is being set up. In 430*53dd3f80SEric Biggers * the DIO read/write case, the key will always be set up already, since 431*53dd3f80SEric Biggers * the file will be open. But in the case of statx(), the key might not 432*53dd3f80SEric Biggers * be set up yet, as the file might not have been opened yet. 433c6c89783SEric Biggers */ 434*53dd3f80SEric Biggers err = fscrypt_require_key(inode); 435*53dd3f80SEric Biggers if (err) { 436*53dd3f80SEric Biggers /* 437*53dd3f80SEric Biggers * Key unavailable or couldn't be set up. This edge case isn't 438*53dd3f80SEric Biggers * worth worrying about; just report that DIO is unsupported. 439*53dd3f80SEric Biggers */ 440c6c89783SEric Biggers return false; 441*53dd3f80SEric Biggers } 442*53dd3f80SEric Biggers return fscrypt_inode_uses_inline_crypto(inode); 443c6c89783SEric Biggers } 444c6c89783SEric Biggers EXPORT_SYMBOL_GPL(fscrypt_dio_supported); 445c6c89783SEric Biggers 446c6c89783SEric Biggers /** 447c6c89783SEric Biggers * fscrypt_limit_io_blocks() - limit I/O blocks to avoid discontiguous DUNs 448c6c89783SEric Biggers * @inode: the file on which I/O is being done 449c6c89783SEric Biggers * @lblk: the block at which the I/O is being started from 450c6c89783SEric Biggers * @nr_blocks: the number of blocks we want to submit starting at @lblk 451c6c89783SEric Biggers * 452c6c89783SEric Biggers * Determine the limit to the number of blocks that can be submitted in a bio 453c6c89783SEric Biggers * targeting @lblk without causing a data unit number (DUN) discontiguity. 454c6c89783SEric Biggers * 455c6c89783SEric Biggers * This is normally just @nr_blocks, as normally the DUNs just increment along 456c6c89783SEric Biggers * with the logical blocks. (Or the file is not encrypted.) 457c6c89783SEric Biggers * 458c6c89783SEric Biggers * In rare cases, fscrypt can be using an IV generation method that allows the 459c6c89783SEric Biggers * DUN to wrap around within logically contiguous blocks, and that wraparound 460c6c89783SEric Biggers * will occur. If this happens, a value less than @nr_blocks will be returned 461c6c89783SEric Biggers * so that the wraparound doesn't occur in the middle of a bio, which would 462c6c89783SEric Biggers * cause encryption/decryption to produce wrong results. 463c6c89783SEric Biggers * 464c6c89783SEric Biggers * Return: the actual number of blocks that can be submitted 465c6c89783SEric Biggers */ 466c6c89783SEric Biggers u64 fscrypt_limit_io_blocks(const struct inode *inode, u64 lblk, u64 nr_blocks) 467c6c89783SEric Biggers { 468c6c89783SEric Biggers const struct fscrypt_info *ci; 469c6c89783SEric Biggers u32 dun; 470c6c89783SEric Biggers 471c6c89783SEric Biggers if (!fscrypt_inode_uses_inline_crypto(inode)) 472c6c89783SEric Biggers return nr_blocks; 473c6c89783SEric Biggers 474c6c89783SEric Biggers if (nr_blocks <= 1) 475c6c89783SEric Biggers return nr_blocks; 476c6c89783SEric Biggers 477c6c89783SEric Biggers ci = inode->i_crypt_info; 478c6c89783SEric Biggers if (!(fscrypt_policy_flags(&ci->ci_policy) & 479c6c89783SEric Biggers FSCRYPT_POLICY_FLAG_IV_INO_LBLK_32)) 480c6c89783SEric Biggers return nr_blocks; 481c6c89783SEric Biggers 482c6c89783SEric Biggers /* With IV_INO_LBLK_32, the DUN can wrap around from U32_MAX to 0. */ 483c6c89783SEric Biggers 484c6c89783SEric Biggers dun = ci->ci_hashed_ino + lblk; 485c6c89783SEric Biggers 486c6c89783SEric Biggers return min_t(u64, nr_blocks, (u64)U32_MAX + 1 - dun); 487c6c89783SEric Biggers } 488c6c89783SEric Biggers EXPORT_SYMBOL_GPL(fscrypt_limit_io_blocks); 489