include/crypto/algapi.h

   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         unsigned int ivsize;
 104
 105         int flags;
 106         unsigned int walk_blocksize;
 107         unsigned int cipher_blocksize;
 108         unsigned int alignmask;
 109 };
 110
 111 struct ablkcipher_walk {
 112         struct {
 113                 struct page *page;
 114                 unsigned int offset;
 115         } src, dst;
 116
 117         struct scatter_walk     in;
 118         unsigned int            nbytes;
 119         struct scatter_walk     out;
 120         unsigned int            total;
 121         struct list_head        buffers;
 122         u8                      *iv_buffer;
 123         u8                      *iv;
 124         int                     flags;
 125         unsigned int            blocksize;
 126 };
 127
 128 extern const struct crypto_type crypto_ablkcipher_type;
 129 extern const struct crypto_type crypto_aead_type;
 130 extern const struct crypto_type crypto_blkcipher_type;
 131
 132 void crypto_mod_put(struct crypto_alg *alg);
 133
 134 int crypto_register_template(struct crypto_template *tmpl);
 135 void crypto_unregister_template(struct crypto_template *tmpl);
 136 struct crypto_template *crypto_lookup_template(const char *name);
 137
 138 int crypto_register_instance(struct crypto_template *tmpl,
 139                              struct crypto_instance *inst);
 140 int crypto_unregister_instance(struct crypto_alg *alg);
 141
 142 int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
 143                       struct crypto_instance *inst, u32 mask);
 144 int crypto_init_spawn2(struct crypto_spawn *spawn, struct crypto_alg *alg,
 145                        struct crypto_instance *inst,
 146                        const struct crypto_type *frontend);
 147
 148 void crypto_drop_spawn(struct crypto_spawn *spawn);
 149 struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
 150                                     u32 mask);
 151 void *crypto_spawn_tfm2(struct crypto_spawn *spawn);
 152
 153 static inline void crypto_set_spawn(struct crypto_spawn *spawn,
 154                                     struct crypto_instance *inst)
 155 {
 156         spawn->inst = inst;
 157 }
 158
 159 struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb);
 160 int crypto_check_attr_type(struct rtattr **tb, u32 type);
 161 const char *crypto_attr_alg_name(struct rtattr *rta);
 162 struct crypto_alg *crypto_attr_alg2(struct rtattr *rta,
 163                                     const struct crypto_type *frontend,
 164                                     u32 type, u32 mask);
 165
 166 static inline struct crypto_alg *crypto_attr_alg(struct rtattr *rta,
 167                                                  u32 type, u32 mask)
 168 {
 169         return crypto_attr_alg2(rta, NULL, type, mask);
 170 }
 171
 172 int crypto_attr_u32(struct rtattr *rta, u32 *num);
 173 void *crypto_alloc_instance2(const char *name, struct crypto_alg *alg,
 174                              unsigned int head);
 175 struct crypto_instance *crypto_alloc_instance(const char *name,
 176                                               struct crypto_alg *alg);
 177
 178 void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
 179 int crypto_enqueue_request(struct crypto_queue *queue,
 180                            struct crypto_async_request *request);
 181 void *__crypto_dequeue_request(struct crypto_queue *queue, unsigned int offset);
 182 struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue);
 183 int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm);
 184
 185 /* These functions require the input/output to be aligned as u32. */
 186 void crypto_inc(u8 *a, unsigned int size);
 187 void crypto_xor(u8 *dst, const u8 *src, unsigned int size);
 188
 189 int blkcipher_walk_done(struct blkcipher_desc *desc,
 190                         struct blkcipher_walk *walk, int err);
 191 int blkcipher_walk_virt(struct blkcipher_desc *desc,
 192                         struct blkcipher_walk *walk);
 193 int blkcipher_walk_phys(struct blkcipher_desc *desc,
 194                         struct blkcipher_walk *walk);
 195 int blkcipher_walk_virt_block(struct blkcipher_desc *desc,
 196                               struct blkcipher_walk *walk,
 197                               unsigned int blocksize);
 198
 199 int ablkcipher_walk_done(struct ablkcipher_request *req,
 200                          struct ablkcipher_walk *walk, int err);
 201 int ablkcipher_walk_phys(struct ablkcipher_request *req,
 202                          struct ablkcipher_walk *walk);
 203 void __ablkcipher_walk_complete(struct ablkcipher_walk *walk);
 204
 205 static inline void *crypto_tfm_ctx_aligned(struct crypto_tfm *tfm)
 206 {
 207         return PTR_ALIGN(crypto_tfm_ctx(tfm),
 208                          crypto_tfm_alg_alignmask(tfm) + 1);
 209 }
 210
 211 static inline struct crypto_instance *crypto_tfm_alg_instance(
 212         struct crypto_tfm *tfm)
 213 {
 214         return container_of(tfm->__crt_alg, struct crypto_instance, alg);
 215 }
 216
 217 static inline void *crypto_instance_ctx(struct crypto_instance *inst)
 218 {
 219         return inst->__ctx;
 220 }
 221
 222 static inline struct ablkcipher_alg *crypto_ablkcipher_alg(
 223         struct crypto_ablkcipher *tfm)
 224 {
 225         return &crypto_ablkcipher_tfm(tfm)->__crt_alg->cra_ablkcipher;
 226 }
 227
 228 static inline void *crypto_ablkcipher_ctx(struct crypto_ablkcipher *tfm)
 229 {
 230         return crypto_tfm_ctx(&tfm->base);
 231 }
 232
 233 static inline void *crypto_ablkcipher_ctx_aligned(struct crypto_ablkcipher *tfm)
 234 {
 235         return crypto_tfm_ctx_aligned(&tfm->base);
 236 }
 237
 238 static inline struct aead_alg *crypto_aead_alg(struct crypto_aead *tfm)
 239 {
 240         return &crypto_aead_tfm(tfm)->__crt_alg->cra_aead;
 241 }
 242
 243 static inline void *crypto_aead_ctx(struct crypto_aead *tfm)
 244 {
 245         return crypto_tfm_ctx(&tfm->base);
 246 }
 247
 248 static inline struct crypto_instance *crypto_aead_alg_instance(
 249         struct crypto_aead *aead)
 250 {
 251         return crypto_tfm_alg_instance(&aead->base);
 252 }
 253
 254 static inline struct crypto_blkcipher *crypto_spawn_blkcipher(
 255         struct crypto_spawn *spawn)
 256 {
 257         u32 type = CRYPTO_ALG_TYPE_BLKCIPHER;
 258         u32 mask = CRYPTO_ALG_TYPE_MASK;
 259
 260         return __crypto_blkcipher_cast(crypto_spawn_tfm(spawn, type, mask));
 261 }
 262
 263 static inline void *crypto_blkcipher_ctx(struct crypto_blkcipher *tfm)
 264 {
 265         return crypto_tfm_ctx(&tfm->base);
 266 }
 267
 268 static inline void *crypto_blkcipher_ctx_aligned(struct crypto_blkcipher *tfm)
 269 {
 270         return crypto_tfm_ctx_aligned(&tfm->base);
 271 }
 272
 273 static inline struct crypto_cipher *crypto_spawn_cipher(
 274         struct crypto_spawn *spawn)
 275 {
 276         u32 type = CRYPTO_ALG_TYPE_CIPHER;
 277         u32 mask = CRYPTO_ALG_TYPE_MASK;
 278
 279         return __crypto_cipher_cast(crypto_spawn_tfm(spawn, type, mask));
 280 }
 281
 282 static inline struct cipher_alg *crypto_cipher_alg(struct crypto_cipher *tfm)
 283 {
 284         return &crypto_cipher_tfm(tfm)->__crt_alg->cra_cipher;
 285 }
 286
 287 static inline struct crypto_hash *crypto_spawn_hash(struct crypto_spawn *spawn)
 288 {
 289         u32 type = CRYPTO_ALG_TYPE_HASH;
 290         u32 mask = CRYPTO_ALG_TYPE_HASH_MASK;
 291
 292         return __crypto_hash_cast(crypto_spawn_tfm(spawn, type, mask));
 293 }
 294
 295 static inline void *crypto_hash_ctx(struct crypto_hash *tfm)
 296 {
 297         return crypto_tfm_ctx(&tfm->base);
 298 }
 299
 300 static inline void *crypto_hash_ctx_aligned(struct crypto_hash *tfm)
 301 {
 302         return crypto_tfm_ctx_aligned(&tfm->base);
 303 }
 304
 305 static inline void blkcipher_walk_init(struct blkcipher_walk *walk,
 306                                        struct scatterlist *dst,
 307                                        struct scatterlist *src,
 308                                        unsigned int nbytes)
 309 {
 310         walk->in.sg = src;
 311         walk->out.sg = dst;
 312         walk->total = nbytes;
 313 }
 314
 315 static inline void ablkcipher_walk_init(struct ablkcipher_walk *walk,
 316                                         struct scatterlist *dst,
 317                                         struct scatterlist *src,
 318                                         unsigned int nbytes)
 319 {
 320         walk->in.sg = src;
 321         walk->out.sg = dst;
 322         walk->total = nbytes;
 323         INIT_LIST_HEAD(&walk->buffers);
 324 }
 325
 326 static inline void ablkcipher_walk_complete(struct ablkcipher_walk *walk)
 327 {
 328         if (unlikely(!list_empty(&walk->buffers)))
 329                 __ablkcipher_walk_complete(walk);
 330 }
 331
 332 static inline struct crypto_async_request *crypto_get_backlog(
 333         struct crypto_queue *queue)
 334 {
 335         return queue->backlog == &queue->list ? NULL :
 336                container_of(queue->backlog, struct crypto_async_request, list);
 337 }
 338
 339 static inline int ablkcipher_enqueue_request(struct crypto_queue *queue,
 340                                              struct ablkcipher_request *request)
 341 {
 342         return crypto_enqueue_request(queue, &request->base);
 343 }
 344
 345 static inline struct ablkcipher_request *ablkcipher_dequeue_request(
 346         struct crypto_queue *queue)
 347 {
 348         return ablkcipher_request_cast(crypto_dequeue_request(queue));
 349 }
 350
 351 static inline void *ablkcipher_request_ctx(struct ablkcipher_request *req)
 352 {
 353         return req->__ctx;
 354 }
 355
 356 static inline int ablkcipher_tfm_in_queue(struct crypto_queue *queue,
 357                                           struct crypto_ablkcipher *tfm)
 358 {
 359         return crypto_tfm_in_queue(queue, crypto_ablkcipher_tfm(tfm));
 360 }
 361
 362 static inline void *aead_request_ctx(struct aead_request *req)
 363 {
 364         return req->__ctx;
 365 }
 366
 367 static inline void aead_request_complete(struct aead_request *req, int err)
 368 {
 369         req->base.complete(&req->base, err);
 370 }
 371
 372 static inline u32 aead_request_flags(struct aead_request *req)
 373 {
 374         return req->base.flags;
 375 }
 376
 377 static inline struct crypto_alg *crypto_get_attr_alg(struct rtattr **tb,
 378                                                      u32 type, u32 mask)
 379 {
 380         return crypto_attr_alg(tb[1], type, mask);
 381 }
 382
 383 /*
 384  * Returns CRYPTO_ALG_ASYNC if type/mask requires the use of sync algorithms.
 385  * Otherwise returns zero.
 386  */
 387 static inline int crypto_requires_sync(u32 type, u32 mask)
 388 {
 389         return (type ^ CRYPTO_ALG_ASYNC) & mask & CRYPTO_ALG_ASYNC;
 390 }
 391
 392 #endif  /* _CRYPTO_ALGAPI_H */
 393