2 * Public Key Encryption
4 * Copyright (c) 2015, Intel Corporation
5 * Authors: Tadeusz Struk <tadeusz.struk@intel.com>
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the Free
9 * Software Foundation; either version 2 of the License, or (at your option)
13 #ifndef _CRYPTO_AKCIPHER_H
14 #define _CRYPTO_AKCIPHER_H
15 #include <linux/crypto.h>
18 * struct akcipher_request - public key request
20 * @base: Common attributes for async crypto requests
22 * For verify op this is signature + digest, in that case
23 * total size of @src is @src_len + @dst_len.
24 * @dst: Destination data (Should be NULL for verify op)
25 * @src_len: Size of the input buffer
26 * For verify op it's size of signature part of @src, this part
27 * is supposed to be operated by cipher.
28 * @dst_len: Size of @dst buffer (for all ops except verify).
29 * It needs to be at least as big as the expected result
30 * depending on the operation.
31 * After operation it will be updated with the actual size of the
33 * In case of error where the dst sgl size was insufficient,
34 * it will be updated to the size required for the operation.
35 * For verify op this is size of digest part in @src.
36 * @__ctx: Start of private context data
38 struct akcipher_request
{
39 struct crypto_async_request base
;
40 struct scatterlist
*src
;
41 struct scatterlist
*dst
;
44 void *__ctx
[] CRYPTO_MINALIGN_ATTR
;
48 * struct crypto_akcipher - user-instantiated objects which encapsulate
49 * algorithms and core processing logic
51 * @base: Common crypto API algorithm data structure
53 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 * @reqsize: Request context size required by algorithm implementation
95 * @base: Common crypto API algorithm data structure
98 int (*sign
)(struct akcipher_request
*req
);
99 int (*verify
)(struct akcipher_request
*req
);
100 int (*encrypt
)(struct akcipher_request
*req
);
101 int (*decrypt
)(struct akcipher_request
*req
);
102 int (*set_pub_key
)(struct crypto_akcipher
*tfm
, const void *key
,
103 unsigned int keylen
);
104 int (*set_priv_key
)(struct crypto_akcipher
*tfm
, const void *key
,
105 unsigned int keylen
);
106 unsigned int (*max_size
)(struct crypto_akcipher
*tfm
);
107 int (*init
)(struct crypto_akcipher
*tfm
);
108 void (*exit
)(struct crypto_akcipher
*tfm
);
110 unsigned int reqsize
;
111 struct crypto_alg base
;
115 * DOC: Generic Public Key API
117 * The Public Key API is used with the algorithms of type
118 * CRYPTO_ALG_TYPE_AKCIPHER (listed as type "akcipher" in /proc/crypto)
122 * crypto_alloc_akcipher() - allocate AKCIPHER tfm handle
123 * @alg_name: is the cra_name / name or cra_driver_name / driver name of the
124 * public key algorithm e.g. "rsa"
125 * @type: specifies the type of the algorithm
126 * @mask: specifies the mask for the algorithm
128 * Allocate a handle for public key algorithm. The returned struct
129 * crypto_akcipher is the handle that is required for any subsequent
130 * API invocation for the public key operations.
132 * Return: allocated handle in case of success; IS_ERR() is true in case
133 * of an error, PTR_ERR() returns the error code.
135 struct crypto_akcipher
*crypto_alloc_akcipher(const char *alg_name
, u32 type
,
138 static inline struct crypto_tfm
*crypto_akcipher_tfm(
139 struct crypto_akcipher
*tfm
)
144 static inline struct akcipher_alg
*__crypto_akcipher_alg(struct crypto_alg
*alg
)
146 return container_of(alg
, struct akcipher_alg
, base
);
149 static inline struct crypto_akcipher
*__crypto_akcipher_tfm(
150 struct crypto_tfm
*tfm
)
152 return container_of(tfm
, struct crypto_akcipher
, base
);
155 static inline struct akcipher_alg
*crypto_akcipher_alg(
156 struct crypto_akcipher
*tfm
)
158 return __crypto_akcipher_alg(crypto_akcipher_tfm(tfm
)->__crt_alg
);
161 static inline unsigned int crypto_akcipher_reqsize(struct crypto_akcipher
*tfm
)
163 return crypto_akcipher_alg(tfm
)->reqsize
;
166 static inline void akcipher_request_set_tfm(struct akcipher_request
*req
,
167 struct crypto_akcipher
*tfm
)
169 req
->base
.tfm
= crypto_akcipher_tfm(tfm
);
172 static inline struct crypto_akcipher
*crypto_akcipher_reqtfm(
173 struct akcipher_request
*req
)
175 return __crypto_akcipher_tfm(req
->base
.tfm
);
179 * crypto_free_akcipher() - free AKCIPHER tfm handle
181 * @tfm: AKCIPHER tfm handle allocated with crypto_alloc_akcipher()
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
)
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
);
293 struct akcipher_alg
*alg
= crypto_akcipher_alg(tfm
);
294 struct crypto_alg
*calg
= tfm
->base
.__crt_alg
;
295 unsigned int src_len
= req
->src_len
;
298 crypto_stats_get(calg
);
299 ret
= alg
->encrypt(req
);
300 crypto_stats_akcipher_encrypt(src_len
, ret
, calg
);
305 * crypto_akcipher_decrypt() - Invoke public key decrypt operation
307 * Function invokes the specific public key decrypt operation for a given
308 * public key algorithm
310 * @req: asymmetric key request
312 * Return: zero on success; error code in case of error
314 static inline int crypto_akcipher_decrypt(struct akcipher_request
*req
)
316 struct crypto_akcipher
*tfm
= crypto_akcipher_reqtfm(req
);
317 struct akcipher_alg
*alg
= crypto_akcipher_alg(tfm
);
318 struct crypto_alg
*calg
= tfm
->base
.__crt_alg
;
319 unsigned int src_len
= req
->src_len
;
322 crypto_stats_get(calg
);
323 ret
= alg
->decrypt(req
);
324 crypto_stats_akcipher_decrypt(src_len
, ret
, calg
);
329 * crypto_akcipher_sign() - Invoke public key sign operation
331 * Function invokes the specific public key sign operation for a given
332 * public key algorithm
334 * @req: asymmetric key request
336 * Return: zero on success; error code in case of error
338 static inline int crypto_akcipher_sign(struct akcipher_request
*req
)
340 struct crypto_akcipher
*tfm
= crypto_akcipher_reqtfm(req
);
341 struct akcipher_alg
*alg
= crypto_akcipher_alg(tfm
);
342 struct crypto_alg
*calg
= tfm
->base
.__crt_alg
;
345 crypto_stats_get(calg
);
346 ret
= alg
->sign(req
);
347 crypto_stats_akcipher_sign(ret
, calg
);
352 * crypto_akcipher_verify() - Invoke public key signature verification
354 * Function invokes the specific public key signature verification operation
355 * for a given public key algorithm.
357 * @req: asymmetric key request
359 * Note: req->dst should be NULL, req->src should point to SG of size
360 * (req->src_size + req->dst_size), containing signature (of req->src_size
361 * length) with appended digest (of req->dst_size length).
363 * Return: zero on verification success; error code in case of error.
365 static inline int crypto_akcipher_verify(struct akcipher_request
*req
)
367 struct crypto_akcipher
*tfm
= crypto_akcipher_reqtfm(req
);
368 struct akcipher_alg
*alg
= crypto_akcipher_alg(tfm
);
369 struct crypto_alg
*calg
= tfm
->base
.__crt_alg
;
372 crypto_stats_get(calg
);
373 ret
= alg
->verify(req
);
374 crypto_stats_akcipher_verify(ret
, calg
);
379 * crypto_akcipher_set_pub_key() - Invoke set public key operation
381 * Function invokes the algorithm specific set key function, which knows
382 * how to decode and interpret the encoded key and parameters
385 * @key: BER encoded public key, algo OID, paramlen, BER encoded
387 * @keylen: length of the key (not including other data)
389 * Return: zero on success; error code in case of error
391 static inline int crypto_akcipher_set_pub_key(struct crypto_akcipher
*tfm
,
395 struct akcipher_alg
*alg
= crypto_akcipher_alg(tfm
);
397 return alg
->set_pub_key(tfm
, key
, keylen
);
401 * crypto_akcipher_set_priv_key() - Invoke set private key operation
403 * Function invokes the algorithm specific set key function, which knows
404 * how to decode and interpret the encoded key and parameters
407 * @key: BER encoded private key, algo OID, paramlen, BER encoded
409 * @keylen: length of the key (not including other data)
411 * Return: zero on success; error code in case of error
413 static inline int crypto_akcipher_set_priv_key(struct crypto_akcipher
*tfm
,
417 struct akcipher_alg
*alg
= crypto_akcipher_alg(tfm
);
419 return alg
->set_priv_key(tfm
, key
, keylen
);