xref: /rk3399_rockchip-uboot/include/u-boot/rsa-mod-exp.h (revision 057c2200557e187a47f2c10af6c0b2db9bf88df3)
1fc2f4246SRuchika Gupta /*
2*057c2200SRuchika Gupta  * Copyright 2014 Freescale Semiconductor, Inc.
3fc2f4246SRuchika Gupta  *
4fc2f4246SRuchika Gupta  * SPDX-License-Identifier:    GPL-2.0+
5fc2f4246SRuchika Gupta */
6fc2f4246SRuchika Gupta 
7fc2f4246SRuchika Gupta #ifndef _RSA_MOD_EXP_H
8fc2f4246SRuchika Gupta #define _RSA_MOD_EXP_H
9fc2f4246SRuchika Gupta 
10fc2f4246SRuchika Gupta #include <errno.h>
11fc2f4246SRuchika Gupta #include <image.h>
12fc2f4246SRuchika Gupta 
13fc2f4246SRuchika Gupta /**
14fc2f4246SRuchika Gupta  * struct key_prop - holder for a public key properties
15fc2f4246SRuchika Gupta  *
16fc2f4246SRuchika Gupta  * The struct has pointers to modulus (Typically called N),
17fc2f4246SRuchika Gupta  * The inverse, R^2, exponent. These can be typecasted and
18fc2f4246SRuchika Gupta  * used as byte arrays or converted to the required format
19fc2f4246SRuchika Gupta  * as per requirement of RSA implementation.
20fc2f4246SRuchika Gupta  */
21fc2f4246SRuchika Gupta struct key_prop {
22fc2f4246SRuchika Gupta 	const void *rr;		/* R^2 can be treated as byte array */
23fc2f4246SRuchika Gupta 	const void *modulus;	/* modulus as byte array */
24fc2f4246SRuchika Gupta 	const void *public_exponent; /* public exponent as byte array */
25fc2f4246SRuchika Gupta 	uint32_t n0inv;		/* -1 / modulus[0] mod 2^32 */
26fc2f4246SRuchika Gupta 	int num_bits;		/* Key length in bits */
27fc2f4246SRuchika Gupta 	uint32_t exp_len;	/* Exponent length in number of uint8_t */
28fc2f4246SRuchika Gupta };
29fc2f4246SRuchika Gupta 
30fc2f4246SRuchika Gupta /**
31fc2f4246SRuchika Gupta  * rsa_mod_exp_sw() - Perform RSA Modular Exponentiation in sw
32fc2f4246SRuchika Gupta  *
33fc2f4246SRuchika Gupta  * Operation: out[] = sig ^ exponent % modulus
34fc2f4246SRuchika Gupta  *
35fc2f4246SRuchika Gupta  * @sig:	RSA PKCS1.5 signature
36fc2f4246SRuchika Gupta  * @sig_len:	Length of signature in number of bytes
37fc2f4246SRuchika Gupta  * @node:	Node with RSA key elements like modulus, exponent, R^2, n0inv
3831d2b4fdSRuchika Gupta  * @out:	Result in form of byte array of len equal to sig_len
39fc2f4246SRuchika Gupta  */
40fc2f4246SRuchika Gupta int rsa_mod_exp_sw(const uint8_t *sig, uint32_t sig_len,
41fc2f4246SRuchika Gupta 		struct key_prop *node, uint8_t *out);
42fc2f4246SRuchika Gupta 
4331d2b4fdSRuchika Gupta int rsa_mod_exp(struct udevice *dev, const uint8_t *sig, uint32_t sig_len,
4431d2b4fdSRuchika Gupta 		struct key_prop *node, uint8_t *out);
4531d2b4fdSRuchika Gupta 
4631d2b4fdSRuchika Gupta /**
4731d2b4fdSRuchika Gupta  * struct struct mod_exp_ops - Driver model for RSA Modular Exponentiation
4831d2b4fdSRuchika Gupta  *				operations
4931d2b4fdSRuchika Gupta  *
5031d2b4fdSRuchika Gupta  * The uclass interface is implemented by all crypto devices which use
5131d2b4fdSRuchika Gupta  * driver model.
5231d2b4fdSRuchika Gupta  */
5331d2b4fdSRuchika Gupta struct mod_exp_ops {
5431d2b4fdSRuchika Gupta 	/**
5531d2b4fdSRuchika Gupta 	 * Perform Modular Exponentiation
5631d2b4fdSRuchika Gupta 	 *
5731d2b4fdSRuchika Gupta 	 * Operation: out[] = sig ^ exponent % modulus
5831d2b4fdSRuchika Gupta 	 *
5931d2b4fdSRuchika Gupta 	 * @dev:	RSA Device
6031d2b4fdSRuchika Gupta 	 * @sig:	RSA PKCS1.5 signature
6131d2b4fdSRuchika Gupta 	 * @sig_len:	Length of signature in number of bytes
6231d2b4fdSRuchika Gupta 	 * @node:	Node with RSA key elements like modulus, exponent,
6331d2b4fdSRuchika Gupta 	 *		R^2, n0inv
6431d2b4fdSRuchika Gupta 	 * @out:	Result in form of byte array of len equal to sig_len
6531d2b4fdSRuchika Gupta 	 *
6631d2b4fdSRuchika Gupta 	 * This function computes exponentiation over the signature.
6731d2b4fdSRuchika Gupta 	 * Returns: 0 if exponentiation is successful, or a negative value
6831d2b4fdSRuchika Gupta 	 * if it wasn't.
6931d2b4fdSRuchika Gupta 	 */
7031d2b4fdSRuchika Gupta 	int (*mod_exp)(struct udevice *dev, const uint8_t *sig,
7131d2b4fdSRuchika Gupta 			   uint32_t sig_len, struct key_prop *node,
7231d2b4fdSRuchika Gupta 			   uint8_t *outp);
7331d2b4fdSRuchika Gupta };
7431d2b4fdSRuchika Gupta 
75fc2f4246SRuchika Gupta #endif
76