1 /* 2 * Cryptographic API for algorithms (i.e., low-level API). 3 * 4 * Copyright (c) 2006 Herbert Xu <herbert@gondor.apana.org.au> 5 * 6 * This program is free software; you can redistribute it and/or modify it 7 * under the terms of the GNU General Public License as published by the Free 8 * Software Foundation; either version 2 of the License, or (at your option) 9 * any later version. 10 * 11 */ 12 #ifndef _CRYPTO_ALGAPI_H 13 #define _CRYPTO_ALGAPI_H 14 15 #include <linux/crypto.h> 16 #include <linux/list.h> 17 #include <linux/kernel.h> 18 #include <linux/skbuff.h> 19 20 struct module; 21 struct rtattr; 22 struct seq_file; 23 24 struct crypto_type { 25 unsigned int (*ctxsize)(struct crypto_alg *alg, u32 type, u32 mask); 26 unsigned int (*extsize)(struct crypto_alg *alg); 27 int (*init)(struct crypto_tfm *tfm, u32 type, u32 mask); 28 int (*init_tfm)(struct crypto_tfm *tfm); 29 void (*show)(struct seq_file *m, struct crypto_alg *alg); 30 int (*report)(struct sk_buff *skb, struct crypto_alg *alg); 31 struct crypto_alg *(*lookup)(const char *name, u32 type, u32 mask); 32 33 unsigned int type; 34 unsigned int maskclear; 35 unsigned int maskset; 36 unsigned int tfmsize; 37 }; 38 39 struct crypto_instance { 40 struct crypto_alg alg; 41 42 struct crypto_template *tmpl; 43 struct hlist_node list; 44 45 void *__ctx[] CRYPTO_MINALIGN_ATTR; 46 }; 47 48 struct crypto_template { 49 struct list_head list; 50 struct hlist_head instances; 51 struct module *module; 52 53 struct crypto_instance *(*alloc)(struct rtattr **tb); 54 void (*free)(struct crypto_instance *inst); 55 int (*create)(struct crypto_template *tmpl, struct rtattr **tb); 56 57 char name[CRYPTO_MAX_ALG_NAME]; 58 }; 59 60 struct crypto_spawn { 61 struct list_head list; 62 struct crypto_alg *alg; 63 struct crypto_instance *inst; 64 const struct crypto_type *frontend; 65 u32 mask; 66 }; 67 68 struct crypto_queue { 69 struct list_head list; 70 struct list_head *backlog; 71 72 unsigned int qlen; 73 unsigned int max_qlen; 74 }; 75 76 struct scatter_walk { 77 struct scatterlist *sg; 78 unsigned int offset; 79 }; 80 81 struct blkcipher_walk { 82 union { 83 struct { 84 struct page *page; 85 unsigned long offset; 86 } phys; 87 88 struct { 89 u8 *page; 90 u8 *addr; 91 } virt; 92 } src, dst; 93 94 struct scatter_walk in; 95 unsigned int nbytes; 96 97 struct scatter_walk out; 98 unsigned int total; 99 100 void *page; 101 u8 *buffer; 102 u8 *iv; 103 104 int flags; 105 unsigned int blocksize; 106 }; 107 108 struct ablkcipher_walk { 109 struct { 110 struct page *page; 111 unsigned int offset; 112 } src, dst; 113 114 struct scatter_walk in; 115 unsigned int nbytes; 116 struct scatter_walk out; 117 unsigned int total; 118 struct list_head buffers; 119 u8 *iv_buffer; 120 u8 *iv; 121 int flags; 122 unsigned int blocksize; 123 }; 124 125 extern const struct crypto_type crypto_ablkcipher_type; 126 extern const struct crypto_type crypto_aead_type; 127 extern const struct crypto_type crypto_blkcipher_type; 128 129 void crypto_mod_put(struct crypto_alg *alg); 130 131 int crypto_register_template(struct crypto_template *tmpl); 132 void crypto_unregister_template(struct crypto_template *tmpl); 133 struct crypto_template *crypto_lookup_template(const char *name); 134 135 int crypto_register_instance(struct crypto_template *tmpl, 136 struct crypto_instance *inst); 137 138 int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg, 139 struct crypto_instance *inst, u32 mask); 140 int crypto_init_spawn2(struct crypto_spawn *spawn, struct crypto_alg *alg, 141 struct crypto_instance *inst, 142 const struct crypto_type *frontend); 143 144 void crypto_drop_spawn(struct crypto_spawn *spawn); 145 struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type, 146 u32 mask); 147 void *crypto_spawn_tfm2(struct crypto_spawn *spawn); 148 149 static inline void crypto_set_spawn(struct crypto_spawn *spawn, 150 struct crypto_instance *inst) 151 { 152 spawn->inst = inst; 153 } 154 155 struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb); 156 int crypto_check_attr_type(struct rtattr **tb, u32 type); 157 const char *crypto_attr_alg_name(struct rtattr *rta); 158 struct crypto_alg *crypto_attr_alg2(struct rtattr *rta, 159 const struct crypto_type *frontend, 160 u32 type, u32 mask); 161 162 static inline struct crypto_alg *crypto_attr_alg(struct rtattr *rta, 163 u32 type, u32 mask) 164 { 165 return crypto_attr_alg2(rta, NULL, type, mask); 166 } 167 168 int crypto_attr_u32(struct rtattr *rta, u32 *num); 169 void *crypto_alloc_instance2(const char *name, struct crypto_alg *alg, 170 unsigned int head); 171 struct crypto_instance *crypto_alloc_instance(const char *name, 172 struct crypto_alg *alg); 173 174 void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen); 175 int crypto_enqueue_request(struct crypto_queue *queue, 176 struct crypto_async_request *request); 177 void *__crypto_dequeue_request(struct crypto_queue *queue, unsigned int offset); 178 struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue); 179 int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm); 180 181 /* These functions require the input/output to be aligned as u32. */ 182 void crypto_inc(u8 *a, unsigned int size); 183 void crypto_xor(u8 *dst, const u8 *src, unsigned int size); 184 185 int blkcipher_walk_done(struct blkcipher_desc *desc, 186 struct blkcipher_walk *walk, int err); 187 int blkcipher_walk_virt(struct blkcipher_desc *desc, 188 struct blkcipher_walk *walk); 189 int blkcipher_walk_phys(struct blkcipher_desc *desc, 190 struct blkcipher_walk *walk); 191 int blkcipher_walk_virt_block(struct blkcipher_desc *desc, 192 struct blkcipher_walk *walk, 193 unsigned int blocksize); 194 195 int ablkcipher_walk_done(struct ablkcipher_request *req, 196 struct ablkcipher_walk *walk, int err); 197 int ablkcipher_walk_phys(struct ablkcipher_request *req, 198 struct ablkcipher_walk *walk); 199 void __ablkcipher_walk_complete(struct ablkcipher_walk *walk); 200 201 static inline void *crypto_tfm_ctx_aligned(struct crypto_tfm *tfm) 202 { 203 return PTR_ALIGN(crypto_tfm_ctx(tfm), 204 crypto_tfm_alg_alignmask(tfm) + 1); 205 } 206 207 static inline struct crypto_instance *crypto_tfm_alg_instance( 208 struct crypto_tfm *tfm) 209 { 210 return container_of(tfm->__crt_alg, struct crypto_instance, alg); 211 } 212 213 static inline void *crypto_instance_ctx(struct crypto_instance *inst) 214 { 215 return inst->__ctx; 216 } 217 218 static inline struct ablkcipher_alg *crypto_ablkcipher_alg( 219 struct crypto_ablkcipher *tfm) 220 { 221 return &crypto_ablkcipher_tfm(tfm)->__crt_alg->cra_ablkcipher; 222 } 223 224 static inline void *crypto_ablkcipher_ctx(struct crypto_ablkcipher *tfm) 225 { 226 return crypto_tfm_ctx(&tfm->base); 227 } 228 229 static inline void *crypto_ablkcipher_ctx_aligned(struct crypto_ablkcipher *tfm) 230 { 231 return crypto_tfm_ctx_aligned(&tfm->base); 232 } 233 234 static inline struct aead_alg *crypto_aead_alg(struct crypto_aead *tfm) 235 { 236 return &crypto_aead_tfm(tfm)->__crt_alg->cra_aead; 237 } 238 239 static inline void *crypto_aead_ctx(struct crypto_aead *tfm) 240 { 241 return crypto_tfm_ctx(&tfm->base); 242 } 243 244 static inline struct crypto_instance *crypto_aead_alg_instance( 245 struct crypto_aead *aead) 246 { 247 return crypto_tfm_alg_instance(&aead->base); 248 } 249 250 static inline struct crypto_blkcipher *crypto_spawn_blkcipher( 251 struct crypto_spawn *spawn) 252 { 253 u32 type = CRYPTO_ALG_TYPE_BLKCIPHER; 254 u32 mask = CRYPTO_ALG_TYPE_MASK; 255 256 return __crypto_blkcipher_cast(crypto_spawn_tfm(spawn, type, mask)); 257 } 258 259 static inline void *crypto_blkcipher_ctx(struct crypto_blkcipher *tfm) 260 { 261 return crypto_tfm_ctx(&tfm->base); 262 } 263 264 static inline void *crypto_blkcipher_ctx_aligned(struct crypto_blkcipher *tfm) 265 { 266 return crypto_tfm_ctx_aligned(&tfm->base); 267 } 268 269 static inline struct crypto_cipher *crypto_spawn_cipher( 270 struct crypto_spawn *spawn) 271 { 272 u32 type = CRYPTO_ALG_TYPE_CIPHER; 273 u32 mask = CRYPTO_ALG_TYPE_MASK; 274 275 return __crypto_cipher_cast(crypto_spawn_tfm(spawn, type, mask)); 276 } 277 278 static inline struct cipher_alg *crypto_cipher_alg(struct crypto_cipher *tfm) 279 { 280 return &crypto_cipher_tfm(tfm)->__crt_alg->cra_cipher; 281 } 282 283 static inline struct crypto_hash *crypto_spawn_hash(struct crypto_spawn *spawn) 284 { 285 u32 type = CRYPTO_ALG_TYPE_HASH; 286 u32 mask = CRYPTO_ALG_TYPE_HASH_MASK; 287 288 return __crypto_hash_cast(crypto_spawn_tfm(spawn, type, mask)); 289 } 290 291 static inline void *crypto_hash_ctx(struct crypto_hash *tfm) 292 { 293 return crypto_tfm_ctx(&tfm->base); 294 } 295 296 static inline void *crypto_hash_ctx_aligned(struct crypto_hash *tfm) 297 { 298 return crypto_tfm_ctx_aligned(&tfm->base); 299 } 300 301 static inline void blkcipher_walk_init(struct blkcipher_walk *walk, 302 struct scatterlist *dst, 303 struct scatterlist *src, 304 unsigned int nbytes) 305 { 306 walk->in.sg = src; 307 walk->out.sg = dst; 308 walk->total = nbytes; 309 } 310 311 static inline void ablkcipher_walk_init(struct ablkcipher_walk *walk, 312 struct scatterlist *dst, 313 struct scatterlist *src, 314 unsigned int nbytes) 315 { 316 walk->in.sg = src; 317 walk->out.sg = dst; 318 walk->total = nbytes; 319 INIT_LIST_HEAD(&walk->buffers); 320 } 321 322 static inline void ablkcipher_walk_complete(struct ablkcipher_walk *walk) 323 { 324 if (unlikely(!list_empty(&walk->buffers))) 325 __ablkcipher_walk_complete(walk); 326 } 327 328 static inline struct crypto_async_request *crypto_get_backlog( 329 struct crypto_queue *queue) 330 { 331 return queue->backlog == &queue->list ? NULL : 332 container_of(queue->backlog, struct crypto_async_request, list); 333 } 334 335 static inline int ablkcipher_enqueue_request(struct crypto_queue *queue, 336 struct ablkcipher_request *request) 337 { 338 return crypto_enqueue_request(queue, &request->base); 339 } 340 341 static inline struct ablkcipher_request *ablkcipher_dequeue_request( 342 struct crypto_queue *queue) 343 { 344 return ablkcipher_request_cast(crypto_dequeue_request(queue)); 345 } 346 347 static inline void *ablkcipher_request_ctx(struct ablkcipher_request *req) 348 { 349 return req->__ctx; 350 } 351 352 static inline int ablkcipher_tfm_in_queue(struct crypto_queue *queue, 353 struct crypto_ablkcipher *tfm) 354 { 355 return crypto_tfm_in_queue(queue, crypto_ablkcipher_tfm(tfm)); 356 } 357 358 static inline void *aead_request_ctx(struct aead_request *req) 359 { 360 return req->__ctx; 361 } 362 363 static inline void aead_request_complete(struct aead_request *req, int err) 364 { 365 req->base.complete(&req->base, err); 366 } 367 368 static inline u32 aead_request_flags(struct aead_request *req) 369 { 370 return req->base.flags; 371 } 372 373 static inline struct crypto_alg *crypto_get_attr_alg(struct rtattr **tb, 374 u32 type, u32 mask) 375 { 376 return crypto_attr_alg(tb[1], type, mask); 377 } 378 379 /* 380 * Returns CRYPTO_ALG_ASYNC if type/mask requires the use of sync algorithms. 381 * Otherwise returns zero. 382 */ 383 static inline int crypto_requires_sync(u32 type, u32 mask) 384 { 385 return (type ^ CRYPTO_ALG_ASYNC) & mask & CRYPTO_ALG_ASYNC; 386 } 387 388 #endif /* _CRYPTO_ALGAPI_H */ 389 390