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
  19 struct module;
  20 struct rtattr;
  21 struct seq_file;
  22
  23 struct crypto_type {
  24         unsigned int (*ctxsize)(struct crypto_alg *alg, u32 type, u32 mask);
  25         unsigned int (*extsize)(struct crypto_alg *alg,
  26                                 const struct crypto_type *frontend);
  27         int (*init)(struct crypto_tfm *tfm, u32 type, u32 mask);
  28         int (*init_tfm)(struct crypto_tfm *tfm,
  29                         const struct crypto_type *frontend);
  30         void (*show)(struct seq_file *m, 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         u32 mask;
  65 };
  66
  67 struct crypto_queue {
  68         struct list_head list;
  69         struct list_head *backlog;
  70
  71         unsigned int qlen;
  72         unsigned int max_qlen;
  73 };
  74
  75 struct scatter_walk {
  76         struct scatterlist *sg;
  77         unsigned int offset;
  78 };
  79
  80 struct blkcipher_walk {
  81         union {
  82                 struct {
  83                         struct page *page;
  84                         unsigned long offset;
  85                 } phys;
  86
  87                 struct {
  88                         u8 *page;
  89                         u8 *addr;
  90                 } virt;
  91         } src, dst;
  92
  93         struct scatter_walk in;
  94         unsigned int nbytes;
  95
  96         struct scatter_walk out;
  97         unsigned int total;
  98
  99         void *page;
 100         u8 *buffer;
 101         u8 *iv;
 102
 103         int flags;
 104         unsigned int blocksize;
 105 };
 106
 107 extern const struct crypto_type crypto_ablkcipher_type;
 108 extern const struct crypto_type crypto_aead_type;
 109 extern const struct crypto_type crypto_blkcipher_type;
 110 extern const struct crypto_type crypto_hash_type;
 111
 112 void crypto_mod_put(struct crypto_alg *alg);
 113
 114 int crypto_register_template(struct crypto_template *tmpl);
 115 void crypto_unregister_template(struct crypto_template *tmpl);
 116 struct crypto_template *crypto_lookup_template(const char *name);
 117
 118 int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
 119                       struct crypto_instance *inst, u32 mask);
 120 void crypto_drop_spawn(struct crypto_spawn *spawn);
 121 struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
 122                                     u32 mask);
 123
 124 static inline void crypto_set_spawn(struct crypto_spawn *spawn,
 125                                     struct crypto_instance *inst)
 126 {
 127         spawn->inst = inst;
 128 }
 129
 130 struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb);
 131 int crypto_check_attr_type(struct rtattr **tb, u32 type);
 132 const char *crypto_attr_alg_name(struct rtattr *rta);
 133 struct crypto_alg *crypto_attr_alg(struct rtattr *rta, u32 type, u32 mask);
 134 int crypto_attr_u32(struct rtattr *rta, u32 *num);
 135 void *crypto_alloc_instance2(const char *name, struct crypto_alg *alg,
 136                              unsigned int head);
 137 struct crypto_instance *crypto_alloc_instance(const char *name,
 138                                               struct crypto_alg *alg);
 139
 140 void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
 141 int crypto_enqueue_request(struct crypto_queue *queue,
 142                            struct crypto_async_request *request);
 143 struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue);
 144 int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm);
 145
 146 /* These functions require the input/output to be aligned as u32. */
 147 void crypto_inc(u8 *a, unsigned int size);
 148 void crypto_xor(u8 *dst, const u8 *src, unsigned int size);
 149
 150 int blkcipher_walk_done(struct blkcipher_desc *desc,
 151                         struct blkcipher_walk *walk, int err);
 152 int blkcipher_walk_virt(struct blkcipher_desc *desc,
 153                         struct blkcipher_walk *walk);
 154 int blkcipher_walk_phys(struct blkcipher_desc *desc,
 155                         struct blkcipher_walk *walk);
 156 int blkcipher_walk_virt_block(struct blkcipher_desc *desc,
 157                               struct blkcipher_walk *walk,
 158                               unsigned int blocksize);
 159
 160 static inline void *crypto_tfm_ctx_aligned(struct crypto_tfm *tfm)
 161 {
 162         unsigned long addr = (unsigned long)crypto_tfm_ctx(tfm);
 163         unsigned long align = crypto_tfm_alg_alignmask(tfm);
 164
 165         if (align <= crypto_tfm_ctx_alignment())
 166                 align = 1;
 167         return (void *)ALIGN(addr, align);
 168 }
 169
 170 static inline struct crypto_instance *crypto_tfm_alg_instance(
 171         struct crypto_tfm *tfm)
 172 {
 173         return container_of(tfm->__crt_alg, struct crypto_instance, alg);
 174 }
 175
 176 static inline void *crypto_instance_ctx(struct crypto_instance *inst)
 177 {
 178         return inst->__ctx;
 179 }
 180
 181 static inline struct ablkcipher_alg *crypto_ablkcipher_alg(
 182         struct crypto_ablkcipher *tfm)
 183 {
 184         return &crypto_ablkcipher_tfm(tfm)->__crt_alg->cra_ablkcipher;
 185 }
 186
 187 static inline void *crypto_ablkcipher_ctx(struct crypto_ablkcipher *tfm)
 188 {
 189         return crypto_tfm_ctx(&tfm->base);
 190 }
 191
 192 static inline void *crypto_ablkcipher_ctx_aligned(struct crypto_ablkcipher *tfm)
 193 {
 194         return crypto_tfm_ctx_aligned(&tfm->base);
 195 }
 196
 197 static inline struct aead_alg *crypto_aead_alg(struct crypto_aead *tfm)
 198 {
 199         return &crypto_aead_tfm(tfm)->__crt_alg->cra_aead;
 200 }
 201
 202 static inline void *crypto_aead_ctx(struct crypto_aead *tfm)
 203 {
 204         return crypto_tfm_ctx(&tfm->base);
 205 }
 206
 207 static inline struct crypto_instance *crypto_aead_alg_instance(
 208         struct crypto_aead *aead)
 209 {
 210         return crypto_tfm_alg_instance(&aead->base);
 211 }
 212
 213 static inline struct crypto_blkcipher *crypto_spawn_blkcipher(
 214         struct crypto_spawn *spawn)
 215 {
 216         u32 type = CRYPTO_ALG_TYPE_BLKCIPHER;
 217         u32 mask = CRYPTO_ALG_TYPE_MASK;
 218
 219         return __crypto_blkcipher_cast(crypto_spawn_tfm(spawn, type, mask));
 220 }
 221
 222 static inline void *crypto_blkcipher_ctx(struct crypto_blkcipher *tfm)
 223 {
 224         return crypto_tfm_ctx(&tfm->base);
 225 }
 226
 227 static inline void *crypto_blkcipher_ctx_aligned(struct crypto_blkcipher *tfm)
 228 {
 229         return crypto_tfm_ctx_aligned(&tfm->base);
 230 }
 231
 232 static inline struct crypto_cipher *crypto_spawn_cipher(
 233         struct crypto_spawn *spawn)
 234 {
 235         u32 type = CRYPTO_ALG_TYPE_CIPHER;
 236         u32 mask = CRYPTO_ALG_TYPE_MASK;
 237
 238         return __crypto_cipher_cast(crypto_spawn_tfm(spawn, type, mask));
 239 }
 240
 241 static inline struct cipher_alg *crypto_cipher_alg(struct crypto_cipher *tfm)
 242 {
 243         return &crypto_cipher_tfm(tfm)->__crt_alg->cra_cipher;
 244 }
 245
 246 static inline struct crypto_hash *crypto_spawn_hash(struct crypto_spawn *spawn)
 247 {
 248         u32 type = CRYPTO_ALG_TYPE_HASH;
 249         u32 mask = CRYPTO_ALG_TYPE_HASH_MASK;
 250
 251         return __crypto_hash_cast(crypto_spawn_tfm(spawn, type, mask));
 252 }
 253
 254 static inline void *crypto_hash_ctx(struct crypto_hash *tfm)
 255 {
 256         return crypto_tfm_ctx(&tfm->base);
 257 }
 258
 259 static inline void *crypto_hash_ctx_aligned(struct crypto_hash *tfm)
 260 {
 261         return crypto_tfm_ctx_aligned(&tfm->base);
 262 }
 263
 264 static inline void blkcipher_walk_init(struct blkcipher_walk *walk,
 265                                        struct scatterlist *dst,
 266                                        struct scatterlist *src,
 267                                        unsigned int nbytes)
 268 {
 269         walk->in.sg = src;
 270         walk->out.sg = dst;
 271         walk->total = nbytes;
 272 }
 273
 274 static inline struct crypto_async_request *crypto_get_backlog(
 275         struct crypto_queue *queue)
 276 {
 277         return queue->backlog == &queue->list ? NULL :
 278                container_of(queue->backlog, struct crypto_async_request, list);
 279 }
 280
 281 static inline int ablkcipher_enqueue_request(struct crypto_queue *queue,
 282                                              struct ablkcipher_request *request)
 283 {
 284         return crypto_enqueue_request(queue, &request->base);
 285 }
 286
 287 static inline struct ablkcipher_request *ablkcipher_dequeue_request(
 288         struct crypto_queue *queue)
 289 {
 290         return ablkcipher_request_cast(crypto_dequeue_request(queue));
 291 }
 292
 293 static inline void *ablkcipher_request_ctx(struct ablkcipher_request *req)
 294 {
 295         return req->__ctx;
 296 }
 297
 298 static inline int ablkcipher_tfm_in_queue(struct crypto_queue *queue,
 299                                           struct crypto_ablkcipher *tfm)
 300 {
 301         return crypto_tfm_in_queue(queue, crypto_ablkcipher_tfm(tfm));
 302 }
 303
 304 static inline void *aead_request_ctx(struct aead_request *req)
 305 {
 306         return req->__ctx;
 307 }
 308
 309 static inline void aead_request_complete(struct aead_request *req, int err)
 310 {
 311         req->base.complete(&req->base, err);
 312 }
 313
 314 static inline u32 aead_request_flags(struct aead_request *req)
 315 {
 316         return req->base.flags;
 317 }
 318
 319 static inline struct crypto_alg *crypto_get_attr_alg(struct rtattr **tb,
 320                                                      u32 type, u32 mask)
 321 {
 322         return crypto_attr_alg(tb[1], type, mask);
 323 }
 324
 325 /*
 326  * Returns CRYPTO_ALG_ASYNC if type/mask requires the use of sync algorithms.
 327  * Otherwise returns zero.
 328  */
 329 static inline int crypto_requires_sync(u32 type, u32 mask)
 330 {
 331         return (type ^ CRYPTO_ALG_ASYNC) & mask & CRYPTO_ALG_ASYNC;
 332 }
 333
 334 #endif  /* _CRYPTO_ALGAPI_H */
 335