include/u-boot/rsa-mod-exp.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * Copyright 2014 Freescale Semiconductor, Inc.
   4  */
   5
   6 #ifndef _RSA_MOD_EXP_H
   7 #define _RSA_MOD_EXP_H
   8
   9 #include <errno.h>
  10 #include <image.h>
  11
  12 /**
  13  * struct key_prop - holder for a public key properties
  14  *
  15  * The struct has pointers to modulus (Typically called N),
  16  * The inverse, R^2, exponent. These can be typecasted and
  17  * used as byte arrays or converted to the required format
  18  * as per requirement of RSA implementation.
  19  */
  20 struct key_prop {
  21         const void *rr;         /* R^2 can be treated as byte array */
  22         const void *modulus;    /* modulus as byte array */
  23         const void *public_exponent; /* public exponent as byte array */
  24         uint32_t n0inv;         /* -1 / modulus[0] mod 2^32 */
  25         int num_bits;           /* Key length in bits */
  26         uint32_t exp_len;       /* Exponent length in number of uint8_t */
  27 };
  28
  29 /**
  30  * rsa_mod_exp_sw() - Perform RSA Modular Exponentiation in sw
  31  *
  32  * Operation: out[] = sig ^ exponent % modulus
  33  *
  34  * @sig:        RSA PKCS1.5 signature
  35  * @sig_len:    Length of signature in number of bytes
  36  * @node:       Node with RSA key elements like modulus, exponent, R^2, n0inv
  37  * @out:        Result in form of byte array of len equal to sig_len
  38  */
  39 int rsa_mod_exp_sw(const uint8_t *sig, uint32_t sig_len,
  40                 struct key_prop *node, uint8_t *out);
  41
  42 int rsa_mod_exp(struct udevice *dev, const uint8_t *sig, uint32_t sig_len,
  43                 struct key_prop *node, uint8_t *out);
  44
  45 /**
  46  * struct struct mod_exp_ops - Driver model for RSA Modular Exponentiation
  47  *                              operations
  48  *
  49  * The uclass interface is implemented by all crypto devices which use
  50  * driver model.
  51  */
  52 struct mod_exp_ops {
  53         /**
  54          * Perform Modular Exponentiation
  55          *
  56          * Operation: out[] = sig ^ exponent % modulus
  57          *
  58          * @dev:        RSA Device
  59          * @sig:        RSA PKCS1.5 signature
  60          * @sig_len:    Length of signature in number of bytes
  61          * @node:       Node with RSA key elements like modulus, exponent,
  62          *              R^2, n0inv
  63          * @out:        Result in form of byte array of len equal to sig_len
  64          *
  65          * This function computes exponentiation over the signature.
  66          * Returns: 0 if exponentiation is successful, or a negative value
  67          * if it wasn't.
  68          */
  69         int (*mod_exp)(struct udevice *dev, const uint8_t *sig,
  70                            uint32_t sig_len, struct key_prop *node,
  71                            uint8_t *outp);
  72 };
  73
  74 #endif