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         int (*init)(struct crypto_tfm *tfm, u32 type, u32 mask);
  26         void (*exit)(struct crypto_tfm *tfm);
  27         void (*show)(struct seq_file *m, struct crypto_alg *alg);
  28 };
  29
  30 struct crypto_instance {
  31         struct crypto_alg alg;
  32
  33         struct crypto_template *tmpl;
  34         struct hlist_node list;
  35
  36         void *__ctx[] CRYPTO_MINALIGN_ATTR;
  37 };
  38
  39 struct crypto_template {
  40         struct list_head list;
  41         struct hlist_head instances;
  42         struct module *module;
  43
  44         struct crypto_instance *(*alloc)(struct rtattr **tb);
  45         void (*free)(struct crypto_instance *inst);
  46
  47         char name[CRYPTO_MAX_ALG_NAME];
  48 };
  49
  50 struct crypto_spawn {
  51         struct list_head list;
  52         struct crypto_alg *alg;
  53         struct crypto_instance *inst;
  54         u32 mask;
  55 };
  56
  57 struct crypto_queue {
  58         struct list_head list;
  59         struct list_head *backlog;
  60
  61         unsigned int qlen;
  62         unsigned int max_qlen;
  63 };
  64
  65 struct scatter_walk {
  66         struct scatterlist *sg;
  67         unsigned int offset;
  68 };
  69
  70 struct blkcipher_walk {
  71         union {
  72                 struct {
  73                         struct page *page;
  74                         unsigned long offset;
  75                 } phys;
  76
  77                 struct {
  78                         u8 *page;
  79                         u8 *addr;
  80                 } virt;
  81         } src, dst;
  82
  83         struct scatter_walk in;
  84         unsigned int nbytes;
  85
  86         struct scatter_walk out;
  87         unsigned int total;
  88
  89         void *page;
  90         u8 *buffer;
  91         u8 *iv;
  92
  93         int flags;
  94 };
  95
  96 extern const struct crypto_type crypto_ablkcipher_type;
  97 extern const struct crypto_type crypto_aead_type;
  98 extern const struct crypto_type crypto_blkcipher_type;
  99 extern const struct crypto_type crypto_hash_type;
 100
 101 void crypto_mod_put(struct crypto_alg *alg);
 102
 103 int crypto_register_template(struct crypto_template *tmpl);
 104 void crypto_unregister_template(struct crypto_template *tmpl);
 105 struct crypto_template *crypto_lookup_template(const char *name);
 106
 107 int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
 108                       struct crypto_instance *inst, u32 mask);
 109 void crypto_drop_spawn(struct crypto_spawn *spawn);
 110 struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
 111                                     u32 mask);
 112
 113 struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb);
 114 int crypto_check_attr_type(struct rtattr **tb, u32 type);
 115 struct crypto_alg *crypto_get_attr_alg(struct rtattr **tb, u32 type, u32 mask);
 116 struct crypto_instance *crypto_alloc_instance(const char *name,
 117                                               struct crypto_alg *alg);
 118
 119 void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
 120 int crypto_enqueue_request(struct crypto_queue *queue,
 121                            struct crypto_async_request *request);
 122 struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue);
 123 int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm);
 124
 125 int blkcipher_walk_done(struct blkcipher_desc *desc,
 126                         struct blkcipher_walk *walk, int err);
 127 int blkcipher_walk_virt(struct blkcipher_desc *desc,
 128                         struct blkcipher_walk *walk);
 129 int blkcipher_walk_phys(struct blkcipher_desc *desc,
 130                         struct blkcipher_walk *walk);
 131
 132 static inline void *crypto_tfm_ctx_aligned(struct crypto_tfm *tfm)
 133 {
 134         unsigned long addr = (unsigned long)crypto_tfm_ctx(tfm);
 135         unsigned long align = crypto_tfm_alg_alignmask(tfm);
 136
 137         if (align <= crypto_tfm_ctx_alignment())
 138                 align = 1;
 139         return (void *)ALIGN(addr, align);
 140 }
 141
 142 static inline struct crypto_instance *crypto_tfm_alg_instance(
 143         struct crypto_tfm *tfm)
 144 {
 145         return container_of(tfm->__crt_alg, struct crypto_instance, alg);
 146 }
 147
 148 static inline void *crypto_instance_ctx(struct crypto_instance *inst)
 149 {
 150         return inst->__ctx;
 151 }
 152
 153 static inline struct ablkcipher_alg *crypto_ablkcipher_alg(
 154         struct crypto_ablkcipher *tfm)
 155 {
 156         return &crypto_ablkcipher_tfm(tfm)->__crt_alg->cra_ablkcipher;
 157 }
 158
 159 static inline void *crypto_ablkcipher_ctx(struct crypto_ablkcipher *tfm)
 160 {
 161         return crypto_tfm_ctx(&tfm->base);
 162 }
 163
 164 static inline void *crypto_ablkcipher_ctx_aligned(struct crypto_ablkcipher *tfm)
 165 {
 166         return crypto_tfm_ctx_aligned(&tfm->base);
 167 }
 168
 169 static inline struct aead_alg *crypto_aead_alg(struct crypto_aead *tfm)
 170 {
 171         return &crypto_aead_tfm(tfm)->__crt_alg->cra_aead;
 172 }
 173
 174 static inline struct crypto_blkcipher *crypto_spawn_blkcipher(
 175         struct crypto_spawn *spawn)
 176 {
 177         u32 type = CRYPTO_ALG_TYPE_BLKCIPHER;
 178         u32 mask = CRYPTO_ALG_TYPE_MASK | CRYPTO_ALG_ASYNC;
 179
 180         return __crypto_blkcipher_cast(crypto_spawn_tfm(spawn, type, mask));
 181 }
 182
 183 static inline void *crypto_blkcipher_ctx(struct crypto_blkcipher *tfm)
 184 {
 185         return crypto_tfm_ctx(&tfm->base);
 186 }
 187
 188 static inline void *crypto_blkcipher_ctx_aligned(struct crypto_blkcipher *tfm)
 189 {
 190         return crypto_tfm_ctx_aligned(&tfm->base);
 191 }
 192
 193 static inline struct crypto_cipher *crypto_spawn_cipher(
 194         struct crypto_spawn *spawn)
 195 {
 196         u32 type = CRYPTO_ALG_TYPE_CIPHER;
 197         u32 mask = CRYPTO_ALG_TYPE_MASK;
 198
 199         return __crypto_cipher_cast(crypto_spawn_tfm(spawn, type, mask));
 200 }
 201
 202 static inline struct cipher_alg *crypto_cipher_alg(struct crypto_cipher *tfm)
 203 {
 204         return &crypto_cipher_tfm(tfm)->__crt_alg->cra_cipher;
 205 }
 206
 207 static inline struct crypto_hash *crypto_spawn_hash(struct crypto_spawn *spawn)
 208 {
 209         u32 type = CRYPTO_ALG_TYPE_HASH;
 210         u32 mask = CRYPTO_ALG_TYPE_HASH_MASK;
 211
 212         return __crypto_hash_cast(crypto_spawn_tfm(spawn, type, mask));
 213 }
 214
 215 static inline void *crypto_hash_ctx_aligned(struct crypto_hash *tfm)
 216 {
 217         return crypto_tfm_ctx_aligned(&tfm->base);
 218 }
 219
 220 static inline void blkcipher_walk_init(struct blkcipher_walk *walk,
 221                                        struct scatterlist *dst,
 222                                        struct scatterlist *src,
 223                                        unsigned int nbytes)
 224 {
 225         walk->in.sg = src;
 226         walk->out.sg = dst;
 227         walk->total = nbytes;
 228 }
 229
 230 static inline struct crypto_async_request *crypto_get_backlog(
 231         struct crypto_queue *queue)
 232 {
 233         return queue->backlog == &queue->list ? NULL :
 234                container_of(queue->backlog, struct crypto_async_request, list);
 235 }
 236
 237 static inline int ablkcipher_enqueue_request(struct ablkcipher_alg *alg,
 238                                              struct ablkcipher_request *request)
 239 {
 240         return crypto_enqueue_request(alg->queue, &request->base);
 241 }
 242
 243 static inline struct ablkcipher_request *ablkcipher_dequeue_request(
 244         struct ablkcipher_alg *alg)
 245 {
 246         return ablkcipher_request_cast(crypto_dequeue_request(alg->queue));
 247 }
 248
 249 static inline void *ablkcipher_request_ctx(struct ablkcipher_request *req)
 250 {
 251         return req->__ctx;
 252 }
 253
 254 static inline int ablkcipher_tfm_in_queue(struct crypto_ablkcipher *tfm)
 255 {
 256         return crypto_tfm_in_queue(crypto_ablkcipher_alg(tfm)->queue,
 257                                    crypto_ablkcipher_tfm(tfm));
 258 }
 259
 260 #endif  /* _CRYPTO_ALGAPI_H */
 261