1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * Public Key Encryption
5 * Copyright (c) 2015, Intel Corporation
6 * Authors: Tadeusz Struk <tadeusz.struk@intel.com>
8 #ifndef _CRYPTO_AKCIPHER_H
9 #define _CRYPTO_AKCIPHER_H
10 #include <linux/crypto.h>
13 * struct akcipher_request - public key request
15 * @base: Common attributes for async crypto requests
17 * For verify op this is signature + digest, in that case
18 * total size of @src is @src_len + @dst_len.
19 * @dst: Destination data (Should be NULL for verify op)
20 * @src_len: Size of the input buffer
21 * For verify op it's size of signature part of @src, this part
22 * is supposed to be operated by cipher.
23 * @dst_len: Size of @dst buffer (for all ops except verify).
24 * It needs to be at least as big as the expected result
25 * depending on the operation.
26 * After operation it will be updated with the actual size of the
28 * In case of error where the dst sgl size was insufficient,
29 * it will be updated to the size required for the operation.
30 * For verify op this is size of digest part in @src.
31 * @__ctx: Start of private context data
33 struct akcipher_request {
34 struct crypto_async_request base;
35 struct scatterlist *src;
36 struct scatterlist *dst;
39 void *__ctx[] CRYPTO_MINALIGN_ATTR;
43 * struct crypto_akcipher - user-instantiated objects which encapsulate
44 * algorithms and core processing logic
46 * @base: Common crypto API algorithm data structure
48 struct crypto_akcipher {
49 struct crypto_tfm base;
53 * struct akcipher_alg - generic public key algorithm
55 * @sign: Function performs a sign operation as defined by public key
56 * algorithm. In case of error, where the dst_len was insufficient,
57 * the req->dst_len will be updated to the size required for the
59 * @verify: Function performs a complete verify operation as defined by
60 * public key algorithm, returning verification status. Requires
61 * digest value as input parameter.
62 * @encrypt: Function performs an encrypt operation as defined by public key
63 * algorithm. In case of error, where the dst_len was insufficient,
64 * the req->dst_len will be updated to the size required for the
66 * @decrypt: Function performs a decrypt operation as defined by public key
67 * algorithm. In case of error, where the dst_len was insufficient,
68 * the req->dst_len will be updated to the size required for the
70 * @set_pub_key: Function invokes the algorithm specific set public key
71 * function, which knows how to decode and interpret
72 * the BER encoded public key and parameters
73 * @set_priv_key: Function invokes the algorithm specific set private key
74 * function, which knows how to decode and interpret
75 * the BER encoded private key and parameters
76 * @max_size: Function returns dest buffer size required for a given key.
77 * @init: Initialize the cryptographic transformation object.
78 * This function is used to initialize the cryptographic
79 * transformation object. This function is called only once at
80 * the instantiation time, right after the transformation context
81 * was allocated. In case the cryptographic hardware has some
82 * special requirements which need to be handled by software, this
83 * function shall check for the precise requirement of the
84 * transformation and put any software fallbacks in place.
85 * @exit: Deinitialize the cryptographic transformation object. This is a
86 * counterpart to @init, used to remove various changes set in
89 * @reqsize: Request context size required by algorithm implementation
90 * @base: Common crypto API algorithm data structure
93 int (*sign)(struct akcipher_request *req);
94 int (*verify)(struct akcipher_request *req);
95 int (*encrypt)(struct akcipher_request *req);
96 int (*decrypt)(struct akcipher_request *req);
97 int (*set_pub_key)(struct crypto_akcipher *tfm, const void *key,
99 int (*set_priv_key)(struct crypto_akcipher *tfm, const void *key,
100 unsigned int keylen);
101 unsigned int (*max_size)(struct crypto_akcipher *tfm);
102 int (*init)(struct crypto_akcipher *tfm);
103 void (*exit)(struct crypto_akcipher *tfm);
105 unsigned int reqsize;
106 struct crypto_alg base;
110 * DOC: Generic Public Key API
112 * The Public Key API is used with the algorithms of type
113 * CRYPTO_ALG_TYPE_AKCIPHER (listed as type "akcipher" in /proc/crypto)
117 * crypto_alloc_akcipher() - allocate AKCIPHER tfm handle
118 * @alg_name: is the cra_name / name or cra_driver_name / driver name of the
119 * public key algorithm e.g. "rsa"
120 * @type: specifies the type of the algorithm
121 * @mask: specifies the mask for the algorithm
123 * Allocate a handle for public key algorithm. The returned struct
124 * crypto_akcipher is the handle that is required for any subsequent
125 * API invocation for the public key operations.
127 * Return: allocated handle in case of success; IS_ERR() is true in case
128 * of an error, PTR_ERR() returns the error code.
130 struct crypto_akcipher *crypto_alloc_akcipher(const char *alg_name, u32 type,
133 static inline struct crypto_tfm *crypto_akcipher_tfm(
134 struct crypto_akcipher *tfm)
139 static inline struct akcipher_alg *__crypto_akcipher_alg(struct crypto_alg *alg)
141 return container_of(alg, struct akcipher_alg, base);
144 static inline struct crypto_akcipher *__crypto_akcipher_tfm(
145 struct crypto_tfm *tfm)
147 return container_of(tfm, struct crypto_akcipher, base);
150 static inline struct akcipher_alg *crypto_akcipher_alg(
151 struct crypto_akcipher *tfm)
153 return __crypto_akcipher_alg(crypto_akcipher_tfm(tfm)->__crt_alg);
156 static inline unsigned int crypto_akcipher_reqsize(struct crypto_akcipher *tfm)
158 return crypto_akcipher_alg(tfm)->reqsize;
161 static inline void akcipher_request_set_tfm(struct akcipher_request *req,
162 struct crypto_akcipher *tfm)
164 req->base.tfm = crypto_akcipher_tfm(tfm);
167 static inline struct crypto_akcipher *crypto_akcipher_reqtfm(
168 struct akcipher_request *req)
170 return __crypto_akcipher_tfm(req->base.tfm);
174 * crypto_free_akcipher() - free AKCIPHER tfm handle
176 * @tfm: AKCIPHER tfm handle allocated with crypto_alloc_akcipher()
178 * If @tfm is a NULL or error pointer, this function does nothing.
180 static inline void crypto_free_akcipher(struct crypto_akcipher *tfm)
182 crypto_destroy_tfm(tfm, crypto_akcipher_tfm(tfm));
186 * akcipher_request_alloc() - allocates public key request
188 * @tfm: AKCIPHER tfm handle allocated with crypto_alloc_akcipher()
189 * @gfp: allocation flags
191 * Return: allocated handle in case of success or NULL in case of an error.
193 static inline struct akcipher_request *akcipher_request_alloc(
194 struct crypto_akcipher *tfm, gfp_t gfp)
196 struct akcipher_request *req;
198 req = kmalloc(sizeof(*req) + crypto_akcipher_reqsize(tfm), gfp);
200 akcipher_request_set_tfm(req, tfm);
206 * akcipher_request_free() - zeroize and free public key request
208 * @req: request to free
210 static inline void akcipher_request_free(struct akcipher_request *req)
212 kfree_sensitive(req);
216 * akcipher_request_set_callback() - Sets an asynchronous callback.
218 * Callback will be called when an asynchronous operation on a given
219 * request is finished.
221 * @req: request that the callback will be set for
222 * @flgs: specify for instance if the operation may backlog
223 * @cmpl: callback which will be called
224 * @data: private data used by the caller
226 static inline void akcipher_request_set_callback(struct akcipher_request *req,
228 crypto_completion_t cmpl,
231 req->base.complete = cmpl;
232 req->base.data = data;
233 req->base.flags = flgs;
237 * akcipher_request_set_crypt() - Sets request parameters
239 * Sets parameters required by crypto operation
241 * @req: public key request
242 * @src: ptr to input scatter list
243 * @dst: ptr to output scatter list or NULL for verify op
244 * @src_len: size of the src input scatter list to be processed
245 * @dst_len: size of the dst output scatter list or size of signature
246 * portion in @src for verify op
248 static inline void akcipher_request_set_crypt(struct akcipher_request *req,
249 struct scatterlist *src,
250 struct scatterlist *dst,
251 unsigned int src_len,
252 unsigned int dst_len)
256 req->src_len = src_len;
257 req->dst_len = dst_len;
261 * crypto_akcipher_maxsize() - Get len for output buffer
263 * Function returns the dest buffer size required for a given key.
264 * Function assumes that the key is already set in the transformation. If this
265 * function is called without a setkey or with a failed setkey, you will end up
266 * in a NULL dereference.
268 * @tfm: AKCIPHER tfm handle allocated with crypto_alloc_akcipher()
270 static inline unsigned int crypto_akcipher_maxsize(struct crypto_akcipher *tfm)
272 struct akcipher_alg *alg = crypto_akcipher_alg(tfm);
274 return alg->max_size(tfm);
278 * crypto_akcipher_encrypt() - Invoke public key encrypt operation
280 * Function invokes the specific public key encrypt operation for a given
281 * public key algorithm
283 * @req: asymmetric key request
285 * Return: zero on success; error code in case of error
287 static inline int crypto_akcipher_encrypt(struct akcipher_request *req)
289 struct crypto_akcipher *tfm = crypto_akcipher_reqtfm(req);
290 struct akcipher_alg *alg = crypto_akcipher_alg(tfm);
291 struct crypto_alg *calg = tfm->base.__crt_alg;
292 unsigned int src_len = req->src_len;
295 crypto_stats_get(calg);
296 ret = alg->encrypt(req);
297 crypto_stats_akcipher_encrypt(src_len, ret, calg);
302 * crypto_akcipher_decrypt() - Invoke public key decrypt operation
304 * Function invokes the specific public key decrypt operation for a given
305 * public key algorithm
307 * @req: asymmetric key request
309 * Return: zero on success; error code in case of error
311 static inline int crypto_akcipher_decrypt(struct akcipher_request *req)
313 struct crypto_akcipher *tfm = crypto_akcipher_reqtfm(req);
314 struct akcipher_alg *alg = crypto_akcipher_alg(tfm);
315 struct crypto_alg *calg = tfm->base.__crt_alg;
316 unsigned int src_len = req->src_len;
319 crypto_stats_get(calg);
320 ret = alg->decrypt(req);
321 crypto_stats_akcipher_decrypt(src_len, ret, calg);
326 * crypto_akcipher_sign() - Invoke public key sign operation
328 * Function invokes the specific public key sign operation for a given
329 * public key algorithm
331 * @req: asymmetric key request
333 * Return: zero on success; error code in case of error
335 static inline int crypto_akcipher_sign(struct akcipher_request *req)
337 struct crypto_akcipher *tfm = crypto_akcipher_reqtfm(req);
338 struct akcipher_alg *alg = crypto_akcipher_alg(tfm);
339 struct crypto_alg *calg = tfm->base.__crt_alg;
342 crypto_stats_get(calg);
343 ret = alg->sign(req);
344 crypto_stats_akcipher_sign(ret, calg);
349 * crypto_akcipher_verify() - Invoke public key signature verification
351 * Function invokes the specific public key signature verification operation
352 * for a given public key algorithm.
354 * @req: asymmetric key request
356 * Note: req->dst should be NULL, req->src should point to SG of size
357 * (req->src_size + req->dst_size), containing signature (of req->src_size
358 * length) with appended digest (of req->dst_size length).
360 * Return: zero on verification success; error code in case of error.
362 static inline int crypto_akcipher_verify(struct akcipher_request *req)
364 struct crypto_akcipher *tfm = crypto_akcipher_reqtfm(req);
365 struct akcipher_alg *alg = crypto_akcipher_alg(tfm);
366 struct crypto_alg *calg = tfm->base.__crt_alg;
369 crypto_stats_get(calg);
370 ret = alg->verify(req);
371 crypto_stats_akcipher_verify(ret, calg);
376 * crypto_akcipher_set_pub_key() - Invoke set public key operation
378 * Function invokes the algorithm specific set key function, which knows
379 * how to decode and interpret the encoded key and parameters
382 * @key: BER encoded public key, algo OID, paramlen, BER encoded
384 * @keylen: length of the key (not including other data)
386 * Return: zero on success; error code in case of error
388 static inline int crypto_akcipher_set_pub_key(struct crypto_akcipher *tfm,
392 struct akcipher_alg *alg = crypto_akcipher_alg(tfm);
394 return alg->set_pub_key(tfm, key, keylen);
398 * crypto_akcipher_set_priv_key() - Invoke set private key operation
400 * Function invokes the algorithm specific set key function, which knows
401 * how to decode and interpret the encoded key and parameters
404 * @key: BER encoded private key, algo OID, paramlen, BER encoded
406 * @keylen: length of the key (not including other data)
408 * Return: zero on success; error code in case of error
410 static inline int crypto_akcipher_set_priv_key(struct crypto_akcipher *tfm,
414 struct akcipher_alg *alg = crypto_akcipher_alg(tfm);
416 return alg->set_priv_key(tfm, key, keylen);