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/blkdev.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 request_queue *q);
26
27 void blk_crypto_sysfs_unregister(struct request_queue *q);
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
bio_crypt_ctx_back_mergeable(struct request * req,struct bio * bio)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
bio_crypt_ctx_front_mergeable(struct request * req,struct bio * bio)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
bio_crypt_ctx_merge_rq(struct request * req,struct request * next)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
blk_crypto_rq_set_defaults(struct request * rq)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
blk_crypto_rq_is_encrypted(struct request * rq)64 static inline bool blk_crypto_rq_is_encrypted(struct request *rq)
65 {
66 return rq->crypt_ctx;
67 }
68
blk_crypto_rq_has_keyslot(struct request * rq)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 bool __blk_crypto_cfg_supported(struct blk_crypto_profile *profile,
84 const struct blk_crypto_config *cfg);
85
86 #else /* CONFIG_BLK_INLINE_ENCRYPTION */
87
blk_crypto_sysfs_register(struct request_queue * q)88 static inline int blk_crypto_sysfs_register(struct request_queue *q)
89 {
90 return 0;
91 }
92
blk_crypto_sysfs_unregister(struct request_queue * q)93 static inline void blk_crypto_sysfs_unregister(struct request_queue *q) { }
94
bio_crypt_rq_ctx_compatible(struct request * rq,struct bio * bio)95 static inline bool bio_crypt_rq_ctx_compatible(struct request *rq,
96 struct bio *bio)
97 {
98 return true;
99 }
100
bio_crypt_ctx_front_mergeable(struct request * req,struct bio * bio)101 static inline bool bio_crypt_ctx_front_mergeable(struct request *req,
102 struct bio *bio)
103 {
104 return true;
105 }
106
bio_crypt_ctx_back_mergeable(struct request * req,struct bio * bio)107 static inline bool bio_crypt_ctx_back_mergeable(struct request *req,
108 struct bio *bio)
109 {
110 return true;
111 }
112
bio_crypt_ctx_merge_rq(struct request * req,struct request * next)113 static inline bool bio_crypt_ctx_merge_rq(struct request *req,
114 struct request *next)
115 {
116 return true;
117 }
118
blk_crypto_rq_set_defaults(struct request * rq)119 static inline void blk_crypto_rq_set_defaults(struct request *rq) { }
120
blk_crypto_rq_is_encrypted(struct request * rq)121 static inline bool blk_crypto_rq_is_encrypted(struct request *rq)
122 {
123 return false;
124 }
125
blk_crypto_rq_has_keyslot(struct request * rq)126 static inline bool blk_crypto_rq_has_keyslot(struct request *rq)
127 {
128 return false;
129 }
130
131 #endif /* CONFIG_BLK_INLINE_ENCRYPTION */
132
133 void __bio_crypt_advance(struct bio *bio, unsigned int bytes);
bio_crypt_advance(struct bio * bio,unsigned int bytes)134 static inline void bio_crypt_advance(struct bio *bio, unsigned int bytes)
135 {
136 if (bio_has_crypt_ctx(bio))
137 __bio_crypt_advance(bio, bytes);
138 }
139
140 void __bio_crypt_free_ctx(struct bio *bio);
bio_crypt_free_ctx(struct bio * bio)141 static inline void bio_crypt_free_ctx(struct bio *bio)
142 {
143 if (bio_has_crypt_ctx(bio))
144 __bio_crypt_free_ctx(bio);
145 }
146
bio_crypt_do_front_merge(struct request * rq,struct bio * bio)147 static inline void bio_crypt_do_front_merge(struct request *rq,
148 struct bio *bio)
149 {
150 #ifdef CONFIG_BLK_INLINE_ENCRYPTION
151 if (bio_has_crypt_ctx(bio))
152 memcpy(rq->crypt_ctx->bc_dun, bio->bi_crypt_context->bc_dun,
153 sizeof(rq->crypt_ctx->bc_dun));
154 #endif
155 }
156
157 bool __blk_crypto_bio_prep(struct bio **bio_ptr);
blk_crypto_bio_prep(struct bio ** bio_ptr)158 static inline bool blk_crypto_bio_prep(struct bio **bio_ptr)
159 {
160 if (bio_has_crypt_ctx(*bio_ptr))
161 return __blk_crypto_bio_prep(bio_ptr);
162 return true;
163 }
164
165 blk_status_t __blk_crypto_rq_get_keyslot(struct request *rq);
blk_crypto_rq_get_keyslot(struct request * rq)166 static inline blk_status_t blk_crypto_rq_get_keyslot(struct request *rq)
167 {
168 if (blk_crypto_rq_is_encrypted(rq))
169 return __blk_crypto_rq_get_keyslot(rq);
170 return BLK_STS_OK;
171 }
172
173 void __blk_crypto_rq_put_keyslot(struct request *rq);
blk_crypto_rq_put_keyslot(struct request * rq)174 static inline void blk_crypto_rq_put_keyslot(struct request *rq)
175 {
176 if (blk_crypto_rq_has_keyslot(rq))
177 __blk_crypto_rq_put_keyslot(rq);
178 }
179
180 void __blk_crypto_free_request(struct request *rq);
blk_crypto_free_request(struct request * rq)181 static inline void blk_crypto_free_request(struct request *rq)
182 {
183 if (blk_crypto_rq_is_encrypted(rq))
184 __blk_crypto_free_request(rq);
185 }
186
187 int __blk_crypto_rq_bio_prep(struct request *rq, struct bio *bio,
188 gfp_t gfp_mask);
189 /**
190 * blk_crypto_rq_bio_prep - Prepare a request's crypt_ctx when its first bio
191 * is inserted
192 * @rq: The request to prepare
193 * @bio: The first bio being inserted into the request
194 * @gfp_mask: Memory allocation flags
195 *
196 * Return: 0 on success, -ENOMEM if out of memory. -ENOMEM is only possible if
197 * @gfp_mask doesn't include %__GFP_DIRECT_RECLAIM.
198 */
blk_crypto_rq_bio_prep(struct request * rq,struct bio * bio,gfp_t gfp_mask)199 static inline int blk_crypto_rq_bio_prep(struct request *rq, struct bio *bio,
200 gfp_t gfp_mask)
201 {
202 if (bio_has_crypt_ctx(bio))
203 return __blk_crypto_rq_bio_prep(rq, bio, gfp_mask);
204 return 0;
205 }
206
207 /**
208 * blk_crypto_insert_cloned_request - Prepare a cloned request to be inserted
209 * into a request queue.
210 * @rq: the request being queued
211 *
212 * Return: BLK_STS_OK on success, nonzero on error.
213 */
blk_crypto_insert_cloned_request(struct request * rq)214 static inline blk_status_t blk_crypto_insert_cloned_request(struct request *rq)
215 {
216
217 if (blk_crypto_rq_is_encrypted(rq))
218 return blk_crypto_rq_get_keyslot(rq);
219 return BLK_STS_OK;
220 }
221
222 #ifdef CONFIG_BLK_INLINE_ENCRYPTION_FALLBACK
223
224 int blk_crypto_fallback_start_using_mode(enum blk_crypto_mode_num mode_num);
225
226 bool blk_crypto_fallback_bio_prep(struct bio **bio_ptr);
227
228 int blk_crypto_fallback_evict_key(const struct blk_crypto_key *key);
229
230 #else /* CONFIG_BLK_INLINE_ENCRYPTION_FALLBACK */
231
232 static inline int
blk_crypto_fallback_start_using_mode(enum blk_crypto_mode_num mode_num)233 blk_crypto_fallback_start_using_mode(enum blk_crypto_mode_num mode_num)
234 {
235 pr_warn_once("crypto API fallback is disabled\n");
236 return -ENOPKG;
237 }
238
blk_crypto_fallback_bio_prep(struct bio ** bio_ptr)239 static inline bool blk_crypto_fallback_bio_prep(struct bio **bio_ptr)
240 {
241 pr_warn_once("crypto API fallback disabled; failing request.\n");
242 (*bio_ptr)->bi_status = BLK_STS_NOTSUPP;
243 return false;
244 }
245
246 static inline int
blk_crypto_fallback_evict_key(const struct blk_crypto_key * key)247 blk_crypto_fallback_evict_key(const struct blk_crypto_key *key)
248 {
249 return 0;
250 }
251
252 #endif /* CONFIG_BLK_INLINE_ENCRYPTION_FALLBACK */
253
254 #endif /* __LINUX_BLK_CRYPTO_INTERNAL_H */
255