1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * Copyright 2019 Google LLC 4 */ 5 6 #ifndef __LINUX_BLK_CRYPTO_INTERNAL_H 7 #define __LINUX_BLK_CRYPTO_INTERNAL_H 8 9 #include <linux/bio.h> 10 #include <linux/blk-mq.h> 11 12 /* Represents a crypto mode supported by blk-crypto */ 13 struct blk_crypto_mode { 14 const char *name; /* name of this mode, shown in sysfs */ 15 const char *cipher_str; /* crypto API name (for fallback case) */ 16 unsigned int keysize; /* key size in bytes */ 17 unsigned int security_strength; /* security strength in bytes */ 18 unsigned int ivsize; /* iv size in bytes */ 19 }; 20 21 extern const struct blk_crypto_mode blk_crypto_modes[]; 22 23 #ifdef CONFIG_BLK_INLINE_ENCRYPTION 24 25 int blk_crypto_sysfs_register(struct gendisk *disk); 26 27 void blk_crypto_sysfs_unregister(struct gendisk *disk); 28 29 void bio_crypt_dun_increment(u64 dun[BLK_CRYPTO_DUN_ARRAY_SIZE], 30 unsigned int inc); 31 32 bool bio_crypt_rq_ctx_compatible(struct request *rq, struct bio *bio); 33 34 bool bio_crypt_ctx_mergeable(struct bio_crypt_ctx *bc1, unsigned int bc1_bytes, 35 struct bio_crypt_ctx *bc2); 36 37 static inline bool bio_crypt_ctx_back_mergeable(struct request *req, 38 struct bio *bio) 39 { 40 return bio_crypt_ctx_mergeable(req->crypt_ctx, blk_rq_bytes(req), 41 bio->bi_crypt_context); 42 } 43 44 static inline bool bio_crypt_ctx_front_mergeable(struct request *req, 45 struct bio *bio) 46 { 47 return bio_crypt_ctx_mergeable(bio->bi_crypt_context, 48 bio->bi_iter.bi_size, req->crypt_ctx); 49 } 50 51 static inline bool bio_crypt_ctx_merge_rq(struct request *req, 52 struct request *next) 53 { 54 return bio_crypt_ctx_mergeable(req->crypt_ctx, blk_rq_bytes(req), 55 next->crypt_ctx); 56 } 57 58 static inline void blk_crypto_rq_set_defaults(struct request *rq) 59 { 60 rq->crypt_ctx = NULL; 61 rq->crypt_keyslot = NULL; 62 } 63 64 static inline bool blk_crypto_rq_is_encrypted(struct request *rq) 65 { 66 return rq->crypt_ctx; 67 } 68 69 static inline bool blk_crypto_rq_has_keyslot(struct request *rq) 70 { 71 return rq->crypt_keyslot; 72 } 73 74 blk_status_t blk_crypto_get_keyslot(struct blk_crypto_profile *profile, 75 const struct blk_crypto_key *key, 76 struct blk_crypto_keyslot **slot_ptr); 77 78 void blk_crypto_put_keyslot(struct blk_crypto_keyslot *slot); 79 80 int __blk_crypto_evict_key(struct blk_crypto_profile *profile, 81 const struct blk_crypto_key *key); 82 83 int blk_crypto_ioctl(struct block_device *bdev, unsigned int cmd, 84 void __user *argp); 85 86 static inline bool blk_crypto_supported(struct bio *bio) 87 { 88 return blk_crypto_config_supported_natively(bio->bi_bdev, 89 &bio->bi_crypt_context->bc_key->crypto_cfg); 90 } 91 92 #else /* CONFIG_BLK_INLINE_ENCRYPTION */ 93 94 static inline int blk_crypto_sysfs_register(struct gendisk *disk) 95 { 96 return 0; 97 } 98 99 static inline void blk_crypto_sysfs_unregister(struct gendisk *disk) 100 { 101 } 102 103 static inline bool bio_crypt_rq_ctx_compatible(struct request *rq, 104 struct bio *bio) 105 { 106 return true; 107 } 108 109 static inline bool bio_crypt_ctx_front_mergeable(struct request *req, 110 struct bio *bio) 111 { 112 return true; 113 } 114 115 static inline bool bio_crypt_ctx_back_mergeable(struct request *req, 116 struct bio *bio) 117 { 118 return true; 119 } 120 121 static inline bool bio_crypt_ctx_merge_rq(struct request *req, 122 struct request *next) 123 { 124 return true; 125 } 126 127 static inline void blk_crypto_rq_set_defaults(struct request *rq) { } 128 129 static inline bool blk_crypto_rq_is_encrypted(struct request *rq) 130 { 131 return false; 132 } 133 134 static inline bool blk_crypto_rq_has_keyslot(struct request *rq) 135 { 136 return false; 137 } 138 139 static inline int blk_crypto_ioctl(struct block_device *bdev, unsigned int cmd, 140 void __user *argp) 141 { 142 return -ENOTTY; 143 } 144 145 static inline bool blk_crypto_supported(struct bio *bio) 146 { 147 return false; 148 } 149 150 #endif /* CONFIG_BLK_INLINE_ENCRYPTION */ 151 152 void __bio_crypt_advance(struct bio *bio, unsigned int bytes); 153 static inline void bio_crypt_advance(struct bio *bio, unsigned int bytes) 154 { 155 if (bio_has_crypt_ctx(bio)) 156 __bio_crypt_advance(bio, bytes); 157 } 158 159 void __bio_crypt_free_ctx(struct bio *bio); 160 static inline void bio_crypt_free_ctx(struct bio *bio) 161 { 162 if (bio_has_crypt_ctx(bio)) 163 __bio_crypt_free_ctx(bio); 164 } 165 166 static inline void bio_crypt_do_front_merge(struct request *rq, 167 struct bio *bio) 168 { 169 #ifdef CONFIG_BLK_INLINE_ENCRYPTION 170 if (bio_has_crypt_ctx(bio)) 171 memcpy(rq->crypt_ctx->bc_dun, bio->bi_crypt_context->bc_dun, 172 sizeof(rq->crypt_ctx->bc_dun)); 173 #endif 174 } 175 176 blk_status_t __blk_crypto_rq_get_keyslot(struct request *rq); 177 static inline blk_status_t blk_crypto_rq_get_keyslot(struct request *rq) 178 { 179 if (blk_crypto_rq_is_encrypted(rq)) 180 return __blk_crypto_rq_get_keyslot(rq); 181 return BLK_STS_OK; 182 } 183 184 void __blk_crypto_rq_put_keyslot(struct request *rq); 185 static inline void blk_crypto_rq_put_keyslot(struct request *rq) 186 { 187 if (blk_crypto_rq_has_keyslot(rq)) 188 __blk_crypto_rq_put_keyslot(rq); 189 } 190 191 void __blk_crypto_free_request(struct request *rq); 192 static inline void blk_crypto_free_request(struct request *rq) 193 { 194 if (blk_crypto_rq_is_encrypted(rq)) 195 __blk_crypto_free_request(rq); 196 } 197 198 int __blk_crypto_rq_bio_prep(struct request *rq, struct bio *bio, 199 gfp_t gfp_mask); 200 /** 201 * blk_crypto_rq_bio_prep - Prepare a request's crypt_ctx when its first bio 202 * is inserted 203 * @rq: The request to prepare 204 * @bio: The first bio being inserted into the request 205 * @gfp_mask: Memory allocation flags 206 * 207 * Return: 0 on success, -ENOMEM if out of memory. -ENOMEM is only possible if 208 * @gfp_mask doesn't include %__GFP_DIRECT_RECLAIM. 209 */ 210 static inline int blk_crypto_rq_bio_prep(struct request *rq, struct bio *bio, 211 gfp_t gfp_mask) 212 { 213 if (bio_has_crypt_ctx(bio)) 214 return __blk_crypto_rq_bio_prep(rq, bio, gfp_mask); 215 return 0; 216 } 217 218 bool blk_crypto_fallback_bio_prep(struct bio *bio); 219 220 #ifdef CONFIG_BLK_INLINE_ENCRYPTION_FALLBACK 221 222 int blk_crypto_fallback_start_using_mode(enum blk_crypto_mode_num mode_num); 223 224 int blk_crypto_fallback_evict_key(const struct blk_crypto_key *key); 225 226 #else /* CONFIG_BLK_INLINE_ENCRYPTION_FALLBACK */ 227 228 static inline int 229 blk_crypto_fallback_start_using_mode(enum blk_crypto_mode_num mode_num) 230 { 231 pr_warn_once("crypto API fallback is disabled\n"); 232 return -ENOPKG; 233 } 234 235 static inline int 236 blk_crypto_fallback_evict_key(const struct blk_crypto_key *key) 237 { 238 return 0; 239 } 240 241 #endif /* CONFIG_BLK_INLINE_ENCRYPTION_FALLBACK */ 242 243 #endif /* __LINUX_BLK_CRYPTO_INTERNAL_H */ 244