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
  51         union {
  52                 /* Node in list of instances after registration. */
  53                 struct hlist_node list;
  54                 /* List of attached spawns before registration. */
  55                 struct crypto_spawn *spawns;
  56         };
  57
  58         void *__ctx[] CRYPTO_MINALIGN_ATTR;
  59 };
  60
  61 struct crypto_template {
  62         struct list_head list;
  63         struct hlist_head instances;
  64         struct module *module;
  65
  66         struct crypto_instance *(*alloc)(struct rtattr **tb);
  67         void (*free)(struct crypto_instance *inst);
  68         int (*create)(struct crypto_template *tmpl, struct rtattr **tb);
  69
  70         char name[CRYPTO_MAX_ALG_NAME];
  71 };
  72
  73 struct crypto_spawn {
  74         struct list_head list;
  75         struct crypto_alg *alg;
  76         union {
  77                 /* Back pointer to instance after registration.*/
  78                 struct crypto_instance *inst;
  79                 /* Spawn list pointer prior to registration. */
  80                 struct crypto_spawn *next;
  81         };
  82         const struct crypto_type *frontend;
  83         u32 mask;
  84         bool dead;
  85         bool registered;
  86 };
  87
  88 struct crypto_queue {
  89         struct list_head list;
  90         struct list_head *backlog;
  91
  92         unsigned int qlen;
  93         unsigned int max_qlen;
  94 };
  95
  96 struct scatter_walk {
  97         struct scatterlist *sg;
  98         unsigned int offset;
  99 };
 100
 101 void crypto_mod_put(struct crypto_alg *alg);
 102
 103 int crypto_register_template(struct crypto_template *tmpl);
 104 int crypto_register_templates(struct crypto_template *tmpls, int count);
 105 void crypto_unregister_template(struct crypto_template *tmpl);
 106 void crypto_unregister_templates(struct crypto_template *tmpls, int count);
 107 struct crypto_template *crypto_lookup_template(const char *name);
 108
 109 int crypto_register_instance(struct crypto_template *tmpl,
 110                              struct crypto_instance *inst);
 111 void crypto_unregister_instance(struct crypto_instance *inst);
 112
 113 int crypto_grab_spawn(struct crypto_spawn *spawn, struct crypto_instance *inst,
 114                       const char *name, u32 type, u32 mask);
 115 void crypto_drop_spawn(struct crypto_spawn *spawn);
 116 struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
 117                                     u32 mask);
 118 void *crypto_spawn_tfm2(struct crypto_spawn *spawn);
 119
 120 struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb);
 121 int crypto_check_attr_type(struct rtattr **tb, u32 type);
 122 const char *crypto_attr_alg_name(struct rtattr *rta);
 123 int crypto_attr_u32(struct rtattr *rta, u32 *num);
 124 int crypto_inst_setname(struct crypto_instance *inst, const char *name,
 125                         struct crypto_alg *alg);
 126
 127 void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
 128 int crypto_enqueue_request(struct crypto_queue *queue,
 129                            struct crypto_async_request *request);
 130 struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue);
 131 static inline unsigned int crypto_queue_len(struct crypto_queue *queue)
 132 {
 133         return queue->qlen;
 134 }
 135
 136 void crypto_inc(u8 *a, unsigned int size);
 137 void __crypto_xor(u8 *dst, const u8 *src1, const u8 *src2, unsigned int size);
 138
 139 static inline void crypto_xor(u8 *dst, const u8 *src, unsigned int size)
 140 {
 141         if (IS_ENABLED(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) &&
 142             __builtin_constant_p(size) &&
 143             (size % sizeof(unsigned long)) == 0) {
 144                 unsigned long *d = (unsigned long *)dst;
 145                 unsigned long *s = (unsigned long *)src;
 146
 147                 while (size > 0) {
 148                         *d++ ^= *s++;
 149                         size -= sizeof(unsigned long);
 150                 }
 151         } else {
 152                 __crypto_xor(dst, dst, src, size);
 153         }
 154 }
 155
 156 static inline void crypto_xor_cpy(u8 *dst, const u8 *src1, const u8 *src2,
 157                                   unsigned int size)
 158 {
 159         if (IS_ENABLED(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) &&
 160             __builtin_constant_p(size) &&
 161             (size % sizeof(unsigned long)) == 0) {
 162                 unsigned long *d = (unsigned long *)dst;
 163                 unsigned long *s1 = (unsigned long *)src1;
 164                 unsigned long *s2 = (unsigned long *)src2;
 165
 166                 while (size > 0) {
 167                         *d++ = *s1++ ^ *s2++;
 168                         size -= sizeof(unsigned long);
 169                 }
 170         } else {
 171                 __crypto_xor(dst, src1, src2, size);
 172         }
 173 }
 174
 175 static inline void *crypto_tfm_ctx_aligned(struct crypto_tfm *tfm)
 176 {
 177         return PTR_ALIGN(crypto_tfm_ctx(tfm),
 178                          crypto_tfm_alg_alignmask(tfm) + 1);
 179 }
 180
 181 static inline struct crypto_instance *crypto_tfm_alg_instance(
 182         struct crypto_tfm *tfm)
 183 {
 184         return container_of(tfm->__crt_alg, struct crypto_instance, alg);
 185 }
 186
 187 static inline void *crypto_instance_ctx(struct crypto_instance *inst)
 188 {
 189         return inst->__ctx;
 190 }
 191
 192 struct crypto_cipher_spawn {
 193         struct crypto_spawn base;
 194 };
 195
 196 static inline int crypto_grab_cipher(struct crypto_cipher_spawn *spawn,
 197                                      struct crypto_instance *inst,
 198                                      const char *name, u32 type, u32 mask)
 199 {
 200         type &= ~CRYPTO_ALG_TYPE_MASK;
 201         type |= CRYPTO_ALG_TYPE_CIPHER;
 202         mask |= CRYPTO_ALG_TYPE_MASK;
 203         return crypto_grab_spawn(&spawn->base, inst, name, type, mask);
 204 }
 205
 206 static inline void crypto_drop_cipher(struct crypto_cipher_spawn *spawn)
 207 {
 208         crypto_drop_spawn(&spawn->base);
 209 }
 210
 211 static inline struct crypto_alg *crypto_spawn_cipher_alg(
 212         struct crypto_cipher_spawn *spawn)
 213 {
 214         return spawn->base.alg;
 215 }
 216
 217 static inline struct crypto_cipher *crypto_spawn_cipher(
 218         struct crypto_cipher_spawn *spawn)
 219 {
 220         u32 type = CRYPTO_ALG_TYPE_CIPHER;
 221         u32 mask = CRYPTO_ALG_TYPE_MASK;
 222
 223         return __crypto_cipher_cast(crypto_spawn_tfm(&spawn->base, type, mask));
 224 }
 225
 226 static inline struct cipher_alg *crypto_cipher_alg(struct crypto_cipher *tfm)
 227 {
 228         return &crypto_cipher_tfm(tfm)->__crt_alg->cra_cipher;
 229 }
 230
 231 static inline struct crypto_async_request *crypto_get_backlog(
 232         struct crypto_queue *queue)
 233 {
 234         return queue->backlog == &queue->list ? NULL :
 235                container_of(queue->backlog, struct crypto_async_request, list);
 236 }
 237
 238 static inline int crypto_requires_off(u32 type, u32 mask, u32 off)
 239 {
 240         return (type ^ off) & mask & off;
 241 }
 242
 243 /*
 244  * Returns CRYPTO_ALG_ASYNC if type/mask requires the use of sync algorithms.
 245  * Otherwise returns zero.
 246  */
 247 static inline int crypto_requires_sync(u32 type, u32 mask)
 248 {
 249         return crypto_requires_off(type, mask, CRYPTO_ALG_ASYNC);
 250 }
 251
 252 noinline unsigned long __crypto_memneq(const void *a, const void *b, size_t size);
 253
 254 /**
 255  * crypto_memneq - Compare two areas of memory without leaking
 256  *                 timing information.
 257  *
 258  * @a: One area of memory
 259  * @b: Another area of memory
 260  * @size: The size of the area.
 261  *
 262  * Returns 0 when data is equal, 1 otherwise.
 263  */
 264 static inline int crypto_memneq(const void *a, const void *b, size_t size)
 265 {
 266         return __crypto_memneq(a, b, size) != 0UL ? 1 : 0;
 267 }
 268
 269 static inline void crypto_yield(u32 flags)
 270 {
 271         if (flags & CRYPTO_TFM_REQ_MAY_SLEEP)
 272                 cond_resched();
 273 }
 274
 275 int crypto_register_notifier(struct notifier_block *nb);
 276 int crypto_unregister_notifier(struct notifier_block *nb);
 277
 278 /* Crypto notification events. */
 279 enum {
 280         CRYPTO_MSG_ALG_REQUEST,
 281         CRYPTO_MSG_ALG_REGISTER,
 282         CRYPTO_MSG_ALG_LOADED,
 283 };
 284
 285 #endif  /* _CRYPTO_ALGAPI_H */