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
11 #include <linux/atomic.h>
12 #include <linux/crypto.h>
15 * struct akcipher_request - public key request
17 * @base: Common attributes for async crypto requests
19 * For verify op this is signature + digest, in that case
20 * total size of @src is @src_len + @dst_len.
21 * @dst: Destination data (Should be NULL for verify op)
22 * @src_len: Size of the input buffer
23 * For verify op it's size of signature part of @src, this part
24 * is supposed to be operated by cipher.
25 * @dst_len: Size of @dst buffer (for all ops except verify).
26 * It needs to be at least as big as the expected result
27 * depending on the operation.
28 * After operation it will be updated with the actual size of the
30 * In case of error where the dst sgl size was insufficient,
31 * it will be updated to the size required for the operation.
32 * For verify op this is size of digest part in @src.
33 * @__ctx: Start of private context data
35 struct akcipher_request
{
36 struct crypto_async_request base
;
37 struct scatterlist
*src
;
38 struct scatterlist
*dst
;
41 void *__ctx
[] CRYPTO_MINALIGN_ATTR
;
45 * struct crypto_akcipher - user-instantiated objects which encapsulate
46 * algorithms and core processing logic
48 * @reqsize: Request context size required by algorithm implementation
49 * @base: Common crypto API algorithm data structure
51 struct crypto_akcipher
{
54 struct crypto_tfm base
;
58 * struct akcipher_alg - generic public key algorithm
60 * @sign: Function performs a sign operation as defined by public key
61 * algorithm. In case of error, where the dst_len was insufficient,
62 * the req->dst_len will be updated to the size required for the
64 * @verify: Function performs a complete verify operation as defined by
65 * public key algorithm, returning verification status. Requires
66 * digest value as input parameter.
67 * @encrypt: Function performs an encrypt operation as defined by public key
68 * algorithm. In case of error, where the dst_len was insufficient,
69 * the req->dst_len will be updated to the size required for the
71 * @decrypt: Function performs a decrypt operation as defined by public key
72 * algorithm. In case of error, where the dst_len was insufficient,
73 * the req->dst_len will be updated to the size required for the
75 * @set_pub_key: Function invokes the algorithm specific set public key
76 * function, which knows how to decode and interpret
77 * the BER encoded public key and parameters
78 * @set_priv_key: Function invokes the algorithm specific set private key
79 * function, which knows how to decode and interpret
80 * the BER encoded private key and parameters
81 * @max_size: Function returns dest buffer size required for a given key.
82 * @init: Initialize the cryptographic transformation object.
83 * This function is used to initialize the cryptographic
84 * transformation object. This function is called only once at
85 * the instantiation time, right after the transformation context
86 * was allocated. In case the cryptographic hardware has some
87 * special requirements which need to be handled by software, this
88 * function shall check for the precise requirement of the
89 * transformation and put any software fallbacks in place.
90 * @exit: Deinitialize the cryptographic transformation object. This is a
91 * counterpart to @init, used to remove various changes set in
94 * @base: Common crypto API algorithm data structure
97 int (*sign
)(struct akcipher_request
*req
);
98 int (*verify
)(struct akcipher_request
*req
);
99 int (*encrypt
)(struct akcipher_request
*req
);
100 int (*decrypt
)(struct akcipher_request
*req
);
101 int (*set_pub_key
)(struct crypto_akcipher
*tfm
, const void *key
,
102 unsigned int keylen
);
103 int (*set_priv_key
)(struct crypto_akcipher
*tfm
, const void *key
,
104 unsigned int keylen
);
105 unsigned int (*max_size
)(struct crypto_akcipher
*tfm
);
106 int (*init
)(struct crypto_akcipher
*tfm
);
107 void (*exit
)(struct crypto_akcipher
*tfm
);
109 struct crypto_alg base
;
113 * DOC: Generic Public Key API
115 * The Public Key API is used with the algorithms of type
116 * CRYPTO_ALG_TYPE_AKCIPHER (listed as type "akcipher" in /proc/crypto)
120 * crypto_alloc_akcipher() - allocate AKCIPHER tfm handle
121 * @alg_name: is the cra_name / name or cra_driver_name / driver name of the
122 * public key algorithm e.g. "rsa"
123 * @type: specifies the type of the algorithm
124 * @mask: specifies the mask for the algorithm
126 * Allocate a handle for public key algorithm. The returned struct
127 * crypto_akcipher is the handle that is required for any subsequent
128 * API invocation for the public key operations.
130 * Return: allocated handle in case of success; IS_ERR() is true in case
131 * of an error, PTR_ERR() returns the error code.
133 struct crypto_akcipher
*crypto_alloc_akcipher(const char *alg_name
, u32 type
,
136 static inline struct crypto_tfm
*crypto_akcipher_tfm(
137 struct crypto_akcipher
*tfm
)
142 static inline struct akcipher_alg
*__crypto_akcipher_alg(struct crypto_alg
*alg
)
144 return container_of(alg
, struct akcipher_alg
, base
);
147 static inline struct crypto_akcipher
*__crypto_akcipher_tfm(
148 struct crypto_tfm
*tfm
)
150 return container_of(tfm
, struct crypto_akcipher
, base
);
153 static inline struct akcipher_alg
*crypto_akcipher_alg(
154 struct crypto_akcipher
*tfm
)
156 return __crypto_akcipher_alg(crypto_akcipher_tfm(tfm
)->__crt_alg
);
159 static inline unsigned int crypto_akcipher_reqsize(struct crypto_akcipher
*tfm
)
164 static inline void akcipher_request_set_tfm(struct akcipher_request
*req
,
165 struct crypto_akcipher
*tfm
)
167 req
->base
.tfm
= crypto_akcipher_tfm(tfm
);
170 static inline struct crypto_akcipher
*crypto_akcipher_reqtfm(
171 struct akcipher_request
*req
)
173 return __crypto_akcipher_tfm(req
->base
.tfm
);
177 * crypto_free_akcipher() - free AKCIPHER tfm handle
179 * @tfm: AKCIPHER tfm handle allocated with crypto_alloc_akcipher()
181 * If @tfm is a NULL or error pointer, this function does nothing.
183 static inline void crypto_free_akcipher(struct crypto_akcipher
*tfm
)
185 crypto_destroy_tfm(tfm
, crypto_akcipher_tfm(tfm
));
189 * akcipher_request_alloc() - allocates public key request
191 * @tfm: AKCIPHER tfm handle allocated with crypto_alloc_akcipher()
192 * @gfp: allocation flags
194 * Return: allocated handle in case of success or NULL in case of an error.
196 static inline struct akcipher_request
*akcipher_request_alloc(
197 struct crypto_akcipher
*tfm
, gfp_t gfp
)
199 struct akcipher_request
*req
;
201 req
= kmalloc(sizeof(*req
) + crypto_akcipher_reqsize(tfm
), gfp
);
203 akcipher_request_set_tfm(req
, tfm
);
209 * akcipher_request_free() - zeroize and free public key request
211 * @req: request to free
213 static inline void akcipher_request_free(struct akcipher_request
*req
)
215 kfree_sensitive(req
);
219 * akcipher_request_set_callback() - Sets an asynchronous callback.
221 * Callback will be called when an asynchronous operation on a given
222 * request is finished.
224 * @req: request that the callback will be set for
225 * @flgs: specify for instance if the operation may backlog
226 * @cmpl: callback which will be called
227 * @data: private data used by the caller
229 static inline void akcipher_request_set_callback(struct akcipher_request
*req
,
231 crypto_completion_t cmpl
,
234 req
->base
.complete
= cmpl
;
235 req
->base
.data
= data
;
236 req
->base
.flags
= flgs
;
240 * akcipher_request_set_crypt() - Sets request parameters
242 * Sets parameters required by crypto operation
244 * @req: public key request
245 * @src: ptr to input scatter list
246 * @dst: ptr to output scatter list or NULL for verify op
247 * @src_len: size of the src input scatter list to be processed
248 * @dst_len: size of the dst output scatter list or size of signature
249 * portion in @src for verify op
251 static inline void akcipher_request_set_crypt(struct akcipher_request
*req
,
252 struct scatterlist
*src
,
253 struct scatterlist
*dst
,
254 unsigned int src_len
,
255 unsigned int dst_len
)
259 req
->src_len
= src_len
;
260 req
->dst_len
= dst_len
;
264 * crypto_akcipher_maxsize() - Get len for output buffer
266 * Function returns the dest buffer size required for a given key.
267 * Function assumes that the key is already set in the transformation. If this
268 * function is called without a setkey or with a failed setkey, you will end up
269 * in a NULL dereference.
271 * @tfm: AKCIPHER tfm handle allocated with crypto_alloc_akcipher()
273 static inline unsigned int crypto_akcipher_maxsize(struct crypto_akcipher
*tfm
)
275 struct akcipher_alg
*alg
= crypto_akcipher_alg(tfm
);
277 return alg
->max_size(tfm
);
281 * crypto_akcipher_encrypt() - Invoke public key encrypt operation
283 * Function invokes the specific public key encrypt operation for a given
284 * public key algorithm
286 * @req: asymmetric key request
288 * Return: zero on success; error code in case of error
290 static inline int crypto_akcipher_encrypt(struct akcipher_request
*req
)
292 struct crypto_akcipher
*tfm
= crypto_akcipher_reqtfm(req
);
294 return crypto_akcipher_alg(tfm
)->encrypt(req
);
298 * crypto_akcipher_decrypt() - Invoke public key decrypt operation
300 * Function invokes the specific public key decrypt operation for a given
301 * public key algorithm
303 * @req: asymmetric key request
305 * Return: zero on success; error code in case of error
307 static inline int crypto_akcipher_decrypt(struct akcipher_request
*req
)
309 struct crypto_akcipher
*tfm
= crypto_akcipher_reqtfm(req
);
311 return crypto_akcipher_alg(tfm
)->decrypt(req
);
315 * crypto_akcipher_sync_encrypt() - Invoke public key encrypt operation
317 * Function invokes the specific public key encrypt operation for a given
318 * public key algorithm
320 * @tfm: AKCIPHER tfm handle allocated with crypto_alloc_akcipher()
321 * @src: source buffer
322 * @slen: source length
323 * @dst: destination obuffer
324 * @dlen: destination length
326 * Return: zero on success; error code in case of error
328 int crypto_akcipher_sync_encrypt(struct crypto_akcipher
*tfm
,
329 const void *src
, unsigned int slen
,
330 void *dst
, unsigned int dlen
);
333 * crypto_akcipher_sync_decrypt() - Invoke public key decrypt operation
335 * Function invokes the specific public key decrypt operation for a given
336 * public key algorithm
338 * @tfm: AKCIPHER tfm handle allocated with crypto_alloc_akcipher()
339 * @src: source buffer
340 * @slen: source length
341 * @dst: destination obuffer
342 * @dlen: destination length
344 * Return: Output length on success; error code in case of error
346 int crypto_akcipher_sync_decrypt(struct crypto_akcipher
*tfm
,
347 const void *src
, unsigned int slen
,
348 void *dst
, unsigned int dlen
);
351 * crypto_akcipher_sign() - Invoke public key sign operation
353 * Function invokes the specific public key sign operation for a given
354 * public key algorithm
356 * @req: asymmetric key request
358 * Return: zero on success; error code in case of error
360 static inline int crypto_akcipher_sign(struct akcipher_request
*req
)
362 struct crypto_akcipher
*tfm
= crypto_akcipher_reqtfm(req
);
364 return crypto_akcipher_alg(tfm
)->sign(req
);
368 * crypto_akcipher_verify() - Invoke public key signature verification
370 * Function invokes the specific public key signature verification operation
371 * for a given public key algorithm.
373 * @req: asymmetric key request
375 * Note: req->dst should be NULL, req->src should point to SG of size
376 * (req->src_size + req->dst_size), containing signature (of req->src_size
377 * length) with appended digest (of req->dst_size length).
379 * Return: zero on verification success; error code in case of error.
381 static inline int crypto_akcipher_verify(struct akcipher_request
*req
)
383 struct crypto_akcipher
*tfm
= crypto_akcipher_reqtfm(req
);
385 return crypto_akcipher_alg(tfm
)->verify(req
);
389 * crypto_akcipher_set_pub_key() - Invoke set public key operation
391 * Function invokes the algorithm specific set key function, which knows
392 * how to decode and interpret the encoded key and parameters
395 * @key: BER encoded public key, algo OID, paramlen, BER encoded
397 * @keylen: length of the key (not including other data)
399 * Return: zero on success; error code in case of error
401 static inline int crypto_akcipher_set_pub_key(struct crypto_akcipher
*tfm
,
405 struct akcipher_alg
*alg
= crypto_akcipher_alg(tfm
);
407 return alg
->set_pub_key(tfm
, key
, keylen
);
411 * crypto_akcipher_set_priv_key() - Invoke set private key operation
413 * Function invokes the algorithm specific set key function, which knows
414 * how to decode and interpret the encoded key and parameters
417 * @key: BER encoded private key, algo OID, paramlen, BER encoded
419 * @keylen: length of the key (not including other data)
421 * Return: zero on success; error code in case of error
423 static inline int crypto_akcipher_set_priv_key(struct crypto_akcipher
*tfm
,
427 struct akcipher_alg
*alg
= crypto_akcipher_alg(tfm
);
429 return alg
->set_priv_key(tfm
, key
, keylen
);