include/crypto/algapi.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  * Cryptographic API for algorithms (i.e., low-level API).
   4  *
   5  * Copyright (c) 2006 Herbert Xu <herbert@gondor.apana.org.au>
   6  */
   7 #ifndef _CRYPTO_ALGAPI_H
   8 #define _CRYPTO_ALGAPI_H
   9
  10 #include <linux/crypto.h>
  11 #include <linux/list.h>
  12 #include <linux/kernel.h>
  13 #include <linux/skbuff.h>
  14
  15 /*
  16  * Maximum values for blocksize and alignmask, used to allocate
  17  * static buffers that are big enough for any combination of
  18  * algs and architectures. Ciphers have a lower maximum size.
  19  */
  20 #define MAX_ALGAPI_BLOCKSIZE            160
  21 #define MAX_ALGAPI_ALIGNMASK            63
  22 #define MAX_CIPHER_BLOCKSIZE            16
  23 #define MAX_CIPHER_ALIGNMASK            15
  24
  25 struct crypto_aead;
  26 struct crypto_instance;
  27 struct module;
  28 struct rtattr;
  29 struct seq_file;
  30
  31 struct crypto_type {
  32         unsigned int (*ctxsize)(struct crypto_alg *alg, u32 type, u32 mask);
  33         unsigned int (*extsize)(struct crypto_alg *alg);
  34         int (*init)(struct crypto_tfm *tfm, u32 type, u32 mask);
  35         int (*init_tfm)(struct crypto_tfm *tfm);
  36         void (*show)(struct seq_file *m, struct crypto_alg *alg);
  37         int (*report)(struct sk_buff *skb, struct crypto_alg *alg);
  38         void (*free)(struct crypto_instance *inst);
  39
  40         unsigned int type;
  41         unsigned int maskclear;
  42         unsigned int maskset;
  43         unsigned int tfmsize;
  44 };
  45
  46 struct crypto_instance {
  47         struct crypto_alg alg;
  48
  49         struct crypto_template *tmpl;
  50         struct hlist_node list;
  51
  52         void *__ctx[] CRYPTO_MINALIGN_ATTR;
  53 };
  54
  55 struct crypto_template {
  56         struct list_head list;
  57         struct hlist_head instances;
  58         struct module *module;
  59
  60         struct crypto_instance *(*alloc)(struct rtattr **tb);
  61         void (*free)(struct crypto_instance *inst);
  62         int (*create)(struct crypto_template *tmpl, struct rtattr **tb);
  63
  64         char name[CRYPTO_MAX_ALG_NAME];
  65 };
  66
  67 struct crypto_spawn {
  68         struct list_head list;
  69         struct crypto_alg *alg;
  70         struct crypto_instance *inst;
  71         const struct crypto_type *frontend;
  72         u32 mask;
  73 };
  74
  75 struct crypto_queue {
  76         struct list_head list;
  77         struct list_head *backlog;
  78
  79         unsigned int qlen;
  80         unsigned int max_qlen;
  81 };
  82
  83 struct scatter_walk {
  84         struct scatterlist *sg;
  85         unsigned int offset;
  86 };
  87
  88 void crypto_mod_put(struct crypto_alg *alg);
  89
  90 int crypto_register_template(struct crypto_template *tmpl);
  91 int crypto_register_templates(struct crypto_template *tmpls, int count);
  92 void crypto_unregister_template(struct crypto_template *tmpl);
  93 void crypto_unregister_templates(struct crypto_template *tmpls, int count);
  94 struct crypto_template *crypto_lookup_template(const char *name);
  95
  96 int crypto_register_instance(struct crypto_template *tmpl,
  97                              struct crypto_instance *inst);
  98 int crypto_unregister_instance(struct crypto_instance *inst);
  99
 100 int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
 101                       struct crypto_instance *inst, u32 mask);
 102 int crypto_init_spawn2(struct crypto_spawn *spawn, struct crypto_alg *alg,
 103                        struct crypto_instance *inst,
 104                        const struct crypto_type *frontend);
 105 int crypto_grab_spawn(struct crypto_spawn *spawn, const char *name,
 106                       u32 type, u32 mask);
 107
 108 void crypto_drop_spawn(struct crypto_spawn *spawn);
 109 struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
 110                                     u32 mask);
 111 void *crypto_spawn_tfm2(struct crypto_spawn *spawn);
 112
 113 static inline void crypto_set_spawn(struct crypto_spawn *spawn,
 114                                     struct crypto_instance *inst)
 115 {
 116         spawn->inst = inst;
 117 }
 118
 119 struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb);
 120 int crypto_check_attr_type(struct rtattr **tb, u32 type);
 121 const char *crypto_attr_alg_name(struct rtattr *rta);
 122 struct crypto_alg *crypto_attr_alg2(struct rtattr *rta,
 123                                     const struct crypto_type *frontend,
 124                                     u32 type, u32 mask);
 125
 126 static inline struct crypto_alg *crypto_attr_alg(struct rtattr *rta,
 127                                                  u32 type, u32 mask)
 128 {
 129         return crypto_attr_alg2(rta, NULL, type, mask);
 130 }
 131
 132 int crypto_attr_u32(struct rtattr *rta, u32 *num);
 133 int crypto_inst_setname(struct crypto_instance *inst, const char *name,
 134                         struct crypto_alg *alg);
 135 void *crypto_alloc_instance(const char *name, struct crypto_alg *alg,
 136                             unsigned int head);
 137
 138 void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
 139 int crypto_enqueue_request(struct crypto_queue *queue,
 140                            struct crypto_async_request *request);
 141 struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue);
 142 static inline unsigned int crypto_queue_len(struct crypto_queue *queue)
 143 {
 144         return queue->qlen;
 145 }
 146
 147 void crypto_inc(u8 *a, unsigned int size);
 148 void __crypto_xor(u8 *dst, const u8 *src1, const u8 *src2, unsigned int size);
 149
 150 static inline void crypto_xor(u8 *dst, const u8 *src, unsigned int size)
 151 {
 152         if (IS_ENABLED(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) &&
 153             __builtin_constant_p(size) &&
 154             (size % sizeof(unsigned long)) == 0) {
 155                 unsigned long *d = (unsigned long *)dst;
 156                 unsigned long *s = (unsigned long *)src;
 157
 158                 while (size > 0) {
 159                         *d++ ^= *s++;
 160                         size -= sizeof(unsigned long);
 161                 }
 162         } else {
 163                 __crypto_xor(dst, dst, src, size);
 164         }
 165 }
 166
 167 static inline void crypto_xor_cpy(u8 *dst, const u8 *src1, const u8 *src2,
 168                                   unsigned int size)
 169 {
 170         if (IS_ENABLED(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) &&
 171             __builtin_constant_p(size) &&
 172             (size % sizeof(unsigned long)) == 0) {
 173                 unsigned long *d = (unsigned long *)dst;
 174                 unsigned long *s1 = (unsigned long *)src1;
 175                 unsigned long *s2 = (unsigned long *)src2;
 176
 177                 while (size > 0) {
 178                         *d++ = *s1++ ^ *s2++;
 179                         size -= sizeof(unsigned long);
 180                 }
 181         } else {
 182                 __crypto_xor(dst, src1, src2, size);
 183         }
 184 }
 185
 186 static inline void *crypto_tfm_ctx_aligned(struct crypto_tfm *tfm)
 187 {
 188         return PTR_ALIGN(crypto_tfm_ctx(tfm),
 189                          crypto_tfm_alg_alignmask(tfm) + 1);
 190 }
 191
 192 static inline struct crypto_instance *crypto_tfm_alg_instance(
 193         struct crypto_tfm *tfm)
 194 {
 195         return container_of(tfm->__crt_alg, struct crypto_instance, alg);
 196 }
 197
 198 static inline void *crypto_instance_ctx(struct crypto_instance *inst)
 199 {
 200         return inst->__ctx;
 201 }
 202
 203 static inline struct crypto_cipher *crypto_spawn_cipher(
 204         struct crypto_spawn *spawn)
 205 {
 206         u32 type = CRYPTO_ALG_TYPE_CIPHER;
 207         u32 mask = CRYPTO_ALG_TYPE_MASK;
 208
 209         return __crypto_cipher_cast(crypto_spawn_tfm(spawn, type, mask));
 210 }
 211
 212 static inline struct cipher_alg *crypto_cipher_alg(struct crypto_cipher *tfm)
 213 {
 214         return &crypto_cipher_tfm(tfm)->__crt_alg->cra_cipher;
 215 }
 216
 217 static inline struct crypto_async_request *crypto_get_backlog(
 218         struct crypto_queue *queue)
 219 {
 220         return queue->backlog == &queue->list ? NULL :
 221                container_of(queue->backlog, struct crypto_async_request, list);
 222 }
 223
 224 static inline struct crypto_alg *crypto_get_attr_alg(struct rtattr **tb,
 225                                                      u32 type, u32 mask)
 226 {
 227         return crypto_attr_alg(tb[1], type, mask);
 228 }
 229
 230 static inline int crypto_requires_off(u32 type, u32 mask, u32 off)
 231 {
 232         return (type ^ off) & mask & off;
 233 }
 234
 235 /*
 236  * Returns CRYPTO_ALG_ASYNC if type/mask requires the use of sync algorithms.
 237  * Otherwise returns zero.
 238  */
 239 static inline int crypto_requires_sync(u32 type, u32 mask)
 240 {
 241         return crypto_requires_off(type, mask, CRYPTO_ALG_ASYNC);
 242 }
 243
 244 noinline unsigned long __crypto_memneq(const void *a, const void *b, size_t size);
 245
 246 /**
 247  * crypto_memneq - Compare two areas of memory without leaking
 248  *                 timing information.
 249  *
 250  * @a: One area of memory
 251  * @b: Another area of memory
 252  * @size: The size of the area.
 253  *
 254  * Returns 0 when data is equal, 1 otherwise.
 255  */
 256 static inline int crypto_memneq(const void *a, const void *b, size_t size)
 257 {
 258         return __crypto_memneq(a, b, size) != 0UL ? 1 : 0;
 259 }
 260
 261 static inline void crypto_yield(u32 flags)
 262 {
 263         if (flags & CRYPTO_TFM_REQ_MAY_SLEEP)
 264                 cond_resched();
 265 }
 266
 267 int crypto_register_notifier(struct notifier_block *nb);
 268 int crypto_unregister_notifier(struct notifier_block *nb);
 269
 270 /* Crypto notification events. */
 271 enum {
 272         CRYPTO_MSG_ALG_REQUEST,
 273         CRYPTO_MSG_ALG_REGISTER,
 274         CRYPTO_MSG_ALG_LOADED,
 275 };
 276
 277 #endif  /* _CRYPTO_ALGAPI_H */