algapi.h 10.0 KB

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