ECCParams.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2025, Texas Instruments Incorporated
 * All rights reserved.
 *
 * 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 ti_drivers_cryptoutils_ecc_ECCParams__include
#define ti_drivers_cryptoutils_ecc_ECCParams__include

#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>

#include <ti/drivers/cryptoutils/cryptokey/CryptoKey.h>
#include <ti/devices/DeviceFamily.h>

#if (DeviceFamily_PARENT == DeviceFamily_PARENT_CC27XX) || (DeviceFamily_PARENT == DeviceFamily_PARENT_CC35XX)
    #include <ti/drivers/cryptoutils/ecc/ECCParamsXXF3HSM.h>
#endif

#ifdef __cplusplus
extern "C" {
#endif

/* Error status codes for the utility functions */

#define ECCParams_STATUS_SUCCESS (0)

#define ECCParams_STATUS_ERROR (-1)

typedef uint32_t ECCParams_CurveType;

#define ECCParams_CURVE_TYPE_NONE                  0U
#define ECCParams_CURVE_TYPE_SHORT_WEIERSTRASS_AN3 1U
#define ECCParams_CURVE_TYPE_SHORT_WEIERSTRASS_GEN 2U
#define ECCParams_CURVE_TYPE_MONTGOMERY            3U
#define ECCParams_CURVE_TYPE_EDWARDS               4U

typedef enum
{
    /*
     * WARNING: Do not alter the order or contents of this enum without updating
     * the corresponding curveParamTable array in ECCParam<Device_Family>_s.c
     */
    ECCParams_SecureCurve_NISTP224 = 0,
    ECCParams_SecureCurve_NISTP256,
    ECCParams_SecureCurve_NISTP384,
    ECCParams_SecureCurve_NISTP521,
    ECCParams_SecureCurve_BrainpoolP256R1,
    ECCParams_SecureCurve_BrainpoolP384R1,
    ECCParams_SecureCurve_BrainpoolP512R1,
    ECCParams_SecureCurve_Curve25519,
    ECCParams_SecureCurve_Ed25519,
#if (DeviceFamily_PARENT == DeviceFamily_PARENT_CC13X4_CC26X3_CC26X4)
    ECCParams_SecureCurve_Wei25519,
#endif
    ECCParams_SecureCurve_COUNT /* This element denotes the max enum value and is not a valid curve */
} ECCParams_SecureCurve;

/*
 * ECCParams_CurveParams have different struct members depending on the context
 * of the build (Secure-only, Non-secure, or Secure)
 */
#if (TFM_ENABLED == 0) || defined(TFM_BUILD) /* TFM_BUILD indicates this is a TF-M build */

typedef struct ECCParams_CurveParams
{
    const ECCParams_CurveType curveType;
    const uint8_t *prime;
    const uint8_t *a;
    const uint8_t *b;
    const uint8_t *order;
    const uint8_t cofactor;
    const size_t length;
    const uint8_t *generatorX;
    const uint8_t *generatorY;
} ECCParams_CurveParams;

#else

typedef struct ECCParams_CurveParams
{
    ECCParams_SecureCurve secureCurve;
} ECCParams_CurveParams;

#endif /* (TFM_ENABLED == 0) || defined(TFM_BUILD) */

#if defined(TFM_BUILD) /* TFM_BUILD indicates this is a TF-M build */

/* This must match the ECCParams_CurveParams struct definition directly above */
typedef struct ECCParams_ns_CurveParams
{
    ECCParams_SecureCurve secureCurve;
} ECCParams_ns_CurveParams;

#endif /* defined(TFM_BUILD) */

/* Short Weierstrass curves */

extern const ECCParams_CurveParams ECCParams_NISTP192;

extern const ECCParams_CurveParams ECCParams_NISTP224;

extern const ECCParams_CurveParams ECCParams_NISTP256;

extern const ECCParams_CurveParams ECCParams_NISTP384;

extern const ECCParams_CurveParams ECCParams_NISTP521;

extern const ECCParams_CurveParams ECCParams_BrainpoolP256R1;

extern const ECCParams_CurveParams ECCParams_BrainpoolP384R1;

extern const ECCParams_CurveParams ECCParams_BrainpoolP512R1;

extern const ECCParams_CurveParams ECCParams_Wei25519;

/* Montgomery curves */

extern const ECCParams_CurveParams ECCParams_Curve25519;

/* Edwards curves */

extern const ECCParams_CurveParams ECCParams_Ed25519;

#define ECC_LENGTH_PREFIX_BYTES 4

#if (DeviceFamily_PARENT == DeviceFamily_PARENT_CC23X0) || (DeviceFamily_PARENT == DeviceFamily_PARENT_CC27XX) || \
    (DeviceFamily_PARENT == DeviceFamily_PARENT_CC35XX)

    #define ECCParams_NISTP256_LENGTH 32

    #define ECC_NISTP256_PARAM_LENGTH_WITH_PREFIX_BYTES (ECCParams_NISTP256_LENGTH + ECC_LENGTH_PREFIX_BYTES)

typedef union
{
    uint8_t byte[ECC_NISTP256_PARAM_LENGTH_WITH_PREFIX_BYTES];
    uint32_t word[ECC_NISTP256_PARAM_LENGTH_WITH_PREFIX_BYTES / sizeof(uint32_t)];
} ECC_NISTP256_Param;

extern const ECC_NISTP256_Param ECC_NISTP256_generatorX;

extern const ECC_NISTP256_Param ECC_NISTP256_generatorY;

extern const ECC_NISTP256_Param ECC_NISTP256_prime;

extern const ECC_NISTP256_Param ECC_NISTP256_a;

extern const ECC_NISTP256_Param ECC_NISTP256_b;

extern const ECC_NISTP256_Param ECC_NISTP256_order;

extern const ECC_NISTP256_Param ECC_NISTP256_k_mont;

extern const ECC_NISTP256_Param ECC_NISTP256_a_mont;

extern const ECC_NISTP256_Param ECC_NISTP256_b_mont;
 /* end of nistp256_params */

    #define ECCParams_NISTP224_LENGTH 28

    #define ECC_NISTP224_PARAM_LENGTH_WITH_PREFIX_BYTES (ECCParams_NISTP224_LENGTH + ECC_LENGTH_PREFIX_BYTES)

typedef union
{
    uint8_t byte[ECC_NISTP224_PARAM_LENGTH_WITH_PREFIX_BYTES];
    uint32_t word[ECC_NISTP224_PARAM_LENGTH_WITH_PREFIX_BYTES / sizeof(uint32_t)];
} ECC_NISTP224_Param;

extern const ECC_NISTP224_Param ECC_NISTP224_generatorX;

extern const ECC_NISTP224_Param ECC_NISTP224_generatorY;

extern const ECC_NISTP224_Param ECC_NISTP224_prime;

extern const ECC_NISTP224_Param ECC_NISTP224_a;

extern const ECC_NISTP224_Param ECC_NISTP224_b;

extern const ECC_NISTP224_Param ECC_NISTP224_order;

extern const ECC_NISTP224_Param ECC_NISTP224_k_mont;

extern const ECC_NISTP224_Param ECC_NISTP224_a_mont;

extern const ECC_NISTP224_Param ECC_NISTP224_b_mont;
 /* end of nistp224_params */

    /* Octet string format requires an extra byte at the start of the public key */
    #define OCTET_STRING_OFFSET 1

    /* Octet string format requires this value in the first byte of the public key */
    #define OCTET_STRING_PREFIX 0x04

    /* Length of offset in bytes */
    #define ECC_LENGTH_OFFSET_BYTES 4

    /* Param length needs to be equal to the length of the largest curve supported plus length offset bytes */
    #define ECC_PARAM_LENGTH_WITH_OFFSET_BYTES (ECCParams_NISTP256_LENGTH + ECC_LENGTH_OFFSET_BYTES)

typedef union
{
    uint32_t word[ECC_PARAM_LENGTH_WITH_OFFSET_BYTES / sizeof(uint32_t)];
    uint8_t byte[ECC_PARAM_LENGTH_WITH_OFFSET_BYTES];
} ECC_Param;

#endif /* (DeviceFamily_PARENT == DeviceFamily_PARENT_CC23X0) || (DeviceFamily_PARENT == DeviceFamily_PARENT_CC27XX) \
          || (DeviceFamily_PARENT == DeviceFamily_PARENT_CC35XX) */

#define ECCParams_CURVE25519_LENGTH 32

#define ECC_CURVE25519_LENGTH_WITH_PREFIX_BYTES (ECCParams_CURVE25519_LENGTH + ECC_LENGTH_PREFIX_BYTES)

typedef union
{
    uint8_t byte[ECC_CURVE25519_LENGTH_WITH_PREFIX_BYTES];
    uint32_t word[ECC_CURVE25519_LENGTH_WITH_PREFIX_BYTES / sizeof(uint32_t)];
} ECC_Curve25519_Param;

extern const ECC_Curve25519_Param ECC_Curve25519_generatorX;

extern const ECC_Curve25519_Param ECC_Curve25519_generatorY;

extern const ECC_Curve25519_Param ECC_Curve25519_prime;

extern const ECC_Curve25519_Param ECC_Curve25519_a;

extern const ECC_Curve25519_Param ECC_Curve25519_b;

extern const ECC_Curve25519_Param ECC_Curve25519_order;
 /* end of curve25519_params */

/* Utility functions */

/* #define used for backwards compatibility */
#define ECCParams_FormatCurve25519PrivateKey ECCParams_formatCurve25519PrivateKey

int_fast16_t ECCParams_formatCurve25519PrivateKey(CryptoKey *myPrivateKey);

int_fast16_t ECCParams_getUncompressedGeneratorPoint(const ECCParams_CurveParams *curveParams,
                                                     uint8_t *buffer,
                                                     size_t length);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_cryptoutils_ecc_ECCParams__include */