xref: /linux/crypto/internal.h (revision 98066f2f8901ccf72f3c5d6c391c8fff1cabd49d)
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 	void (*destroy)(struct crypto_alg *alg);
44 
45 	unsigned int type;
46 	unsigned int maskclear;
47 	unsigned int maskset;
48 	unsigned int tfmsize;
49 	unsigned int algsize;
50 };
51 
52 enum {
53 	CRYPTOA_UNSPEC,
54 	CRYPTOA_ALG,
55 	CRYPTOA_TYPE,
56 	__CRYPTOA_MAX,
57 };
58 
59 #define CRYPTOA_MAX (__CRYPTOA_MAX - 1)
60 
61 /* Maximum number of (rtattr) parameters for each template. */
62 #define CRYPTO_MAX_ATTRS 32
63 
64 extern struct list_head crypto_alg_list;
65 extern struct rw_semaphore crypto_alg_sem;
66 extern struct blocking_notifier_head crypto_chain;
67 
68 int alg_test(const char *driver, const char *alg, u32 type, u32 mask);
69 
70 #if !IS_BUILTIN(CONFIG_CRYPTO_ALGAPI) || \
71     IS_ENABLED(CONFIG_CRYPTO_MANAGER_DISABLE_TESTS)
72 static inline bool crypto_boot_test_finished(void)
73 {
74 	return true;
75 }
76 static inline void set_crypto_boot_test_finished(void)
77 {
78 }
79 #else
80 DECLARE_STATIC_KEY_FALSE(__crypto_boot_test_finished);
81 static inline bool crypto_boot_test_finished(void)
82 {
83 	return static_branch_likely(&__crypto_boot_test_finished);
84 }
85 static inline void set_crypto_boot_test_finished(void)
86 {
87 	static_branch_enable(&__crypto_boot_test_finished);
88 }
89 #endif /* !IS_BUILTIN(CONFIG_CRYPTO_ALGAPI) ||
90 	* IS_ENABLED(CONFIG_CRYPTO_MANAGER_DISABLE_TESTS)
91 	*/
92 
93 #ifdef CONFIG_PROC_FS
94 void __init crypto_init_proc(void);
95 void __exit crypto_exit_proc(void);
96 #else
97 static inline void crypto_init_proc(void)
98 { }
99 static inline void crypto_exit_proc(void)
100 { }
101 #endif
102 
103 static inline unsigned int crypto_cipher_ctxsize(struct crypto_alg *alg)
104 {
105 	return alg->cra_ctxsize;
106 }
107 
108 static inline unsigned int crypto_compress_ctxsize(struct crypto_alg *alg)
109 {
110 	return alg->cra_ctxsize;
111 }
112 
113 struct crypto_alg *crypto_mod_get(struct crypto_alg *alg);
114 struct crypto_alg *crypto_alg_mod_lookup(const char *name, u32 type, u32 mask);
115 
116 struct crypto_larval *crypto_larval_alloc(const char *name, u32 type, u32 mask);
117 void crypto_schedule_test(struct crypto_larval *larval);
118 void crypto_alg_tested(const char *name, int err);
119 
120 void crypto_remove_spawns(struct crypto_alg *alg, struct list_head *list,
121 			  struct crypto_alg *nalg);
122 void crypto_remove_final(struct list_head *list);
123 void crypto_shoot_alg(struct crypto_alg *alg);
124 struct crypto_tfm *__crypto_alloc_tfmgfp(struct crypto_alg *alg, u32 type,
125 					 u32 mask, gfp_t gfp);
126 struct crypto_tfm *__crypto_alloc_tfm(struct crypto_alg *alg, u32 type,
127 				      u32 mask);
128 void *crypto_create_tfm_node(struct crypto_alg *alg,
129 			const struct crypto_type *frontend, int node);
130 void *crypto_clone_tfm(const struct crypto_type *frontend,
131 		       struct crypto_tfm *otfm);
132 
133 static inline void *crypto_create_tfm(struct crypto_alg *alg,
134 			const struct crypto_type *frontend)
135 {
136 	return crypto_create_tfm_node(alg, frontend, NUMA_NO_NODE);
137 }
138 
139 struct crypto_alg *crypto_find_alg(const char *alg_name,
140 				   const struct crypto_type *frontend,
141 				   u32 type, u32 mask);
142 
143 void *crypto_alloc_tfm_node(const char *alg_name,
144 		       const struct crypto_type *frontend, u32 type, u32 mask,
145 		       int node);
146 
147 static inline void *crypto_alloc_tfm(const char *alg_name,
148 		       const struct crypto_type *frontend, u32 type, u32 mask)
149 {
150 	return crypto_alloc_tfm_node(alg_name, frontend, type, mask, NUMA_NO_NODE);
151 }
152 
153 int crypto_probing_notify(unsigned long val, void *v);
154 
155 unsigned int crypto_alg_extsize(struct crypto_alg *alg);
156 
157 int crypto_type_has_alg(const char *name, const struct crypto_type *frontend,
158 			u32 type, u32 mask);
159 
160 static inline struct crypto_alg *crypto_alg_get(struct crypto_alg *alg)
161 {
162 	refcount_inc(&alg->cra_refcnt);
163 	return alg;
164 }
165 
166 void crypto_destroy_alg(struct crypto_alg *alg);
167 
168 static inline void crypto_alg_put(struct crypto_alg *alg)
169 {
170 	if (refcount_dec_and_test(&alg->cra_refcnt))
171 		crypto_destroy_alg(alg);
172 }
173 
174 static inline int crypto_tmpl_get(struct crypto_template *tmpl)
175 {
176 	return try_module_get(tmpl->module);
177 }
178 
179 static inline void crypto_tmpl_put(struct crypto_template *tmpl)
180 {
181 	module_put(tmpl->module);
182 }
183 
184 static inline int crypto_is_larval(struct crypto_alg *alg)
185 {
186 	return alg->cra_flags & CRYPTO_ALG_LARVAL;
187 }
188 
189 static inline int crypto_is_dead(struct crypto_alg *alg)
190 {
191 	return alg->cra_flags & CRYPTO_ALG_DEAD;
192 }
193 
194 static inline int crypto_is_moribund(struct crypto_alg *alg)
195 {
196 	return alg->cra_flags & (CRYPTO_ALG_DEAD | CRYPTO_ALG_DYING);
197 }
198 
199 static inline void crypto_notify(unsigned long val, void *v)
200 {
201 	blocking_notifier_call_chain(&crypto_chain, val, v);
202 }
203 
204 static inline void crypto_yield(u32 flags)
205 {
206 	if (flags & CRYPTO_TFM_REQ_MAY_SLEEP)
207 		cond_resched();
208 }
209 
210 static inline int crypto_is_test_larval(struct crypto_larval *larval)
211 {
212 	return larval->alg.cra_driver_name[0];
213 }
214 
215 static inline struct crypto_tfm *crypto_tfm_get(struct crypto_tfm *tfm)
216 {
217 	return refcount_inc_not_zero(&tfm->refcnt) ? tfm : ERR_PTR(-EOVERFLOW);
218 }
219 
220 #endif	/* _CRYPTO_INTERNAL_H */
221 
222