xref: /linux/crypto/internal.h (revision fc4bd01d9ff592f620c499686245c093440db0e8)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * Cryptographic API.
4  *
5  * Copyright (c) 2002 James Morris <jmorris@intercode.com.au>
6  * Copyright (c) 2005 Herbert Xu <herbert@gondor.apana.org.au>
7  */
8 #ifndef _CRYPTO_INTERNAL_H
9 #define _CRYPTO_INTERNAL_H
10 
11 #include <crypto/algapi.h>
12 #include <linux/completion.h>
13 #include <linux/err.h>
14 #include <linux/jump_label.h>
15 #include <linux/list.h>
16 #include <linux/module.h>
17 #include <linux/notifier.h>
18 #include <linux/numa.h>
19 #include <linux/refcount.h>
20 #include <linux/rwsem.h>
21 #include <linux/scatterlist.h>
22 #include <linux/sched.h>
23 #include <linux/types.h>
24 
25 struct crypto_instance;
26 struct crypto_template;
27 
28 struct crypto_larval {
29 	struct crypto_alg alg;
30 	struct crypto_alg *adult;
31 	struct completion completion;
32 	u32 mask;
33 	bool test_started;
34 };
35 
36 struct crypto_type {
37 	unsigned int (*ctxsize)(struct crypto_alg *alg, u32 type, u32 mask);
38 	unsigned int (*extsize)(struct crypto_alg *alg);
39 	int (*init_tfm)(struct crypto_tfm *tfm);
40 	void (*show)(struct seq_file *m, struct crypto_alg *alg);
41 	int (*report)(struct sk_buff *skb, struct crypto_alg *alg);
42 	void (*free)(struct crypto_instance *inst);
43 
44 	unsigned int type;
45 	unsigned int maskclear;
46 	unsigned int maskset;
47 	unsigned int tfmsize;
48 };
49 
50 enum {
51 	CRYPTOA_UNSPEC,
52 	CRYPTOA_ALG,
53 	CRYPTOA_TYPE,
54 	__CRYPTOA_MAX,
55 };
56 
57 #define CRYPTOA_MAX (__CRYPTOA_MAX - 1)
58 
59 /* Maximum number of (rtattr) parameters for each template. */
60 #define CRYPTO_MAX_ATTRS 32
61 
62 extern struct list_head crypto_alg_list;
63 extern struct rw_semaphore crypto_alg_sem;
64 extern struct blocking_notifier_head crypto_chain;
65 
66 int alg_test(const char *driver, const char *alg, u32 type, u32 mask);
67 
68 #if !IS_BUILTIN(CONFIG_CRYPTO_ALGAPI) || \
69     IS_ENABLED(CONFIG_CRYPTO_MANAGER_DISABLE_TESTS)
70 static inline bool crypto_boot_test_finished(void)
71 {
72 	return true;
73 }
74 static inline void set_crypto_boot_test_finished(void)
75 {
76 }
77 #else
78 DECLARE_STATIC_KEY_FALSE(__crypto_boot_test_finished);
79 static inline bool crypto_boot_test_finished(void)
80 {
81 	return static_branch_likely(&__crypto_boot_test_finished);
82 }
83 static inline void set_crypto_boot_test_finished(void)
84 {
85 	static_branch_enable(&__crypto_boot_test_finished);
86 }
87 #endif /* !IS_BUILTIN(CONFIG_CRYPTO_ALGAPI) ||
88 	* IS_ENABLED(CONFIG_CRYPTO_MANAGER_DISABLE_TESTS)
89 	*/
90 
91 #ifdef CONFIG_PROC_FS
92 void __init crypto_init_proc(void);
93 void __exit crypto_exit_proc(void);
94 #else
95 static inline void crypto_init_proc(void)
96 { }
97 static inline void crypto_exit_proc(void)
98 { }
99 #endif
100 
101 static inline unsigned int crypto_cipher_ctxsize(struct crypto_alg *alg)
102 {
103 	return alg->cra_ctxsize;
104 }
105 
106 static inline unsigned int crypto_compress_ctxsize(struct crypto_alg *alg)
107 {
108 	return alg->cra_ctxsize;
109 }
110 
111 struct crypto_alg *crypto_mod_get(struct crypto_alg *alg);
112 struct crypto_alg *crypto_alg_mod_lookup(const char *name, u32 type, u32 mask);
113 
114 struct crypto_larval *crypto_larval_alloc(const char *name, u32 type, u32 mask);
115 void crypto_schedule_test(struct crypto_larval *larval);
116 void crypto_alg_tested(const char *name, int err);
117 
118 void crypto_remove_spawns(struct crypto_alg *alg, struct list_head *list,
119 			  struct crypto_alg *nalg);
120 void crypto_remove_final(struct list_head *list);
121 void crypto_shoot_alg(struct crypto_alg *alg);
122 struct crypto_tfm *__crypto_alloc_tfmgfp(struct crypto_alg *alg, u32 type,
123 					 u32 mask, gfp_t gfp);
124 struct crypto_tfm *__crypto_alloc_tfm(struct crypto_alg *alg, u32 type,
125 				      u32 mask);
126 void *crypto_create_tfm_node(struct crypto_alg *alg,
127 			const struct crypto_type *frontend, int node);
128 void *crypto_clone_tfm(const struct crypto_type *frontend,
129 		       struct crypto_tfm *otfm);
130 
131 static inline void *crypto_create_tfm(struct crypto_alg *alg,
132 			const struct crypto_type *frontend)
133 {
134 	return crypto_create_tfm_node(alg, frontend, NUMA_NO_NODE);
135 }
136 
137 struct crypto_alg *crypto_find_alg(const char *alg_name,
138 				   const struct crypto_type *frontend,
139 				   u32 type, u32 mask);
140 
141 void *crypto_alloc_tfm_node(const char *alg_name,
142 		       const struct crypto_type *frontend, u32 type, u32 mask,
143 		       int node);
144 
145 static inline void *crypto_alloc_tfm(const char *alg_name,
146 		       const struct crypto_type *frontend, u32 type, u32 mask)
147 {
148 	return crypto_alloc_tfm_node(alg_name, frontend, type, mask, NUMA_NO_NODE);
149 }
150 
151 int crypto_probing_notify(unsigned long val, void *v);
152 
153 unsigned int crypto_alg_extsize(struct crypto_alg *alg);
154 
155 int crypto_type_has_alg(const char *name, const struct crypto_type *frontend,
156 			u32 type, u32 mask);
157 
158 static inline struct crypto_alg *crypto_alg_get(struct crypto_alg *alg)
159 {
160 	refcount_inc(&alg->cra_refcnt);
161 	return alg;
162 }
163 
164 static inline void crypto_alg_put(struct crypto_alg *alg)
165 {
166 	if (refcount_dec_and_test(&alg->cra_refcnt) && alg->cra_destroy)
167 		alg->cra_destroy(alg);
168 }
169 
170 static inline int crypto_tmpl_get(struct crypto_template *tmpl)
171 {
172 	return try_module_get(tmpl->module);
173 }
174 
175 static inline void crypto_tmpl_put(struct crypto_template *tmpl)
176 {
177 	module_put(tmpl->module);
178 }
179 
180 static inline int crypto_is_larval(struct crypto_alg *alg)
181 {
182 	return alg->cra_flags & CRYPTO_ALG_LARVAL;
183 }
184 
185 static inline int crypto_is_dead(struct crypto_alg *alg)
186 {
187 	return alg->cra_flags & CRYPTO_ALG_DEAD;
188 }
189 
190 static inline int crypto_is_moribund(struct crypto_alg *alg)
191 {
192 	return alg->cra_flags & (CRYPTO_ALG_DEAD | CRYPTO_ALG_DYING);
193 }
194 
195 static inline void crypto_notify(unsigned long val, void *v)
196 {
197 	blocking_notifier_call_chain(&crypto_chain, val, v);
198 }
199 
200 static inline void crypto_yield(u32 flags)
201 {
202 	if (flags & CRYPTO_TFM_REQ_MAY_SLEEP)
203 		cond_resched();
204 }
205 
206 static inline int crypto_is_test_larval(struct crypto_larval *larval)
207 {
208 	return larval->alg.cra_driver_name[0];
209 }
210 
211 static inline struct crypto_tfm *crypto_tfm_get(struct crypto_tfm *tfm)
212 {
213 	return refcount_inc_not_zero(&tfm->refcnt) ? tfm : ERR_PTR(-EOVERFLOW);
214 }
215 
216 #endif	/* _CRYPTO_INTERNAL_H */
217 
218