pka.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2022 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef PKA_H_
#define PKA_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <security_common/drivers/crypto/pka/eip29t2_firmware.h>
#include <security_common/drivers/crypto/pka/hw_include/cslr_cp_ace.h>
#include <kernel/dpl/SystemP.h>
#include <security_common/drivers/crypto/crypto_util.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
typedef enum PKA_Return_e
{
    PKA_RETURN_SUCCESS                  = 0xCEF6A572U, 
    PKA_RETURN_FAILURE                  = 0xD20341DDU, 
}PKA_Return_t;
 
typedef void *PKA_Handle;
 
#define PKA_BIGINT_MAX                          (130U)
 
#define PKA_EC_BIGINT_MAX                       (18U)
 
#define PKA_EC_PARAM_MAXLEN                     (68U)
 
#define PKA_BIGINT_LEN(bytelen)                 (((bytelen) / 4U) + 1U)
 
#define PKA_RSA_KEY_E_MAXLEN                    (8U)
 
#define PKA_RSA_KEY_N_MAXLEN                    (520U)
 
#define PKA_RSA_KEY_PQ_MAXLEN                   ((PKA_RSA_KEY_N_MAXLEN / 2U) + 4U)
 
#define PKA_RSA_SIG_MAXLEN                      PKA_RSA_KEY_N_MAXLEN
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
struct PKA_RSAPubkey {
    uint32_t    n[PKA_BIGINT_LEN(PKA_RSA_KEY_N_MAXLEN)];
    uint32_t    e[PKA_BIGINT_LEN(PKA_RSA_KEY_E_MAXLEN)];
};
 
struct PKA_RSAPrivkey {
    uint32_t    n[PKA_BIGINT_LEN(PKA_RSA_KEY_N_MAXLEN)];
    uint32_t    e[PKA_BIGINT_LEN(PKA_RSA_KEY_E_MAXLEN)];
    uint32_t    d[PKA_BIGINT_LEN(PKA_RSA_KEY_N_MAXLEN)];
    uint32_t    p[PKA_BIGINT_LEN(PKA_RSA_KEY_PQ_MAXLEN)];
    uint32_t    q[PKA_BIGINT_LEN(PKA_RSA_KEY_PQ_MAXLEN)];
    uint32_t    dp[PKA_BIGINT_LEN(PKA_RSA_KEY_PQ_MAXLEN)];
    uint32_t    dq[PKA_BIGINT_LEN(PKA_RSA_KEY_PQ_MAXLEN)];
    uint32_t    coefficient[PKA_BIGINT_LEN(PKA_RSA_KEY_PQ_MAXLEN)];
};
 
struct PKA_ECPoint {
    uint32_t    x[PKA_BIGINT_LEN(PKA_EC_PARAM_MAXLEN)];
    uint32_t    y[PKA_BIGINT_LEN(PKA_EC_PARAM_MAXLEN)];
};
 
struct PKA_ECPrimeCurveP {
    uint32_t        prime[PKA_BIGINT_LEN(PKA_EC_PARAM_MAXLEN)];
    uint32_t        order[PKA_BIGINT_LEN(PKA_EC_PARAM_MAXLEN)];
    uint32_t        a[PKA_BIGINT_LEN(PKA_EC_PARAM_MAXLEN)];
    uint32_t        b[PKA_BIGINT_LEN(PKA_EC_PARAM_MAXLEN)];
    struct PKA_ECPoint g;
};
 
struct PKA_ECDSASig {
    uint32_t    r[PKA_BIGINT_LEN(PKA_EC_PARAM_MAXLEN)];
    uint32_t    s[PKA_BIGINT_LEN(PKA_EC_PARAM_MAXLEN)];
};
 
typedef struct
{
    /*
     * SOC configuration
     */
    uint32_t                caBaseAddr;
    uint32_t                pkaBaseAddr;
    uint32_t                isOpen;
} PKA_Attrs;
 
typedef struct
{
    PKA_Attrs             *attrs;
} PKA_Config;
 
/* ========================================================================== */
/*                            Global Variables                                */
/* ========================================================================== */
 
extern PKA_Config            gPkaConfig[];
extern uint32_t             gPkaConfigNum;
 
/* ========================================================================== */
/*                              Function Definitions                          */
/* ========================================================================== */
 
PKA_Handle PKA_open(uint32_t index);
 
PKA_Return_t PKA_close(PKA_Handle handle);
 
PKA_Return_t PKA_RSAPrivate(PKA_Handle handle, const uint32_t m[PKA_BIGINT_MAX], const struct PKA_RSAPrivkey *k, uint32_t result[PKA_BIGINT_MAX]);
 
PKA_Return_t PKA_RSAPublic(PKA_Handle handle, const uint32_t m[PKA_BIGINT_MAX], const struct PKA_RSAPubkey *k, uint32_t result[PKA_BIGINT_MAX]);
 
PKA_Return_t PKA_ECDSASign(PKA_Handle handle, 
                    const struct PKA_ECPrimeCurveP *cp, 
                    const uint32_t priv[PKA_EC_BIGINT_MAX], 
                    const uint32_t k[PKA_EC_BIGINT_MAX], 
                    const uint32_t h[PKA_EC_BIGINT_MAX], 
                    struct PKA_ECDSASig *sig);
 
PKA_Return_t PKA_ECDSAVerify(PKA_Handle handle,
                        const struct PKA_ECPrimeCurveP *cp, 
                        const struct PKA_ECPoint *pub, 
                        const struct PKA_ECDSASig *sig, 
                        const uint32_t h[PKA_EC_BIGINT_MAX]);
 
#ifdef __cplusplus
}
#endif
 
#endif /* PKA_H_ */