ECDSA.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2024, 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_ECDSA__include
#define ti_drivers_ECDSA__include

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

#include <ti/drivers/cryptoutils/cryptokey/CryptoKey.h>
#include <ti/drivers/cryptoutils/ecc/ECCParams.h>

#ifdef __cplusplus
extern "C" {
#endif

#define ECDSA_STATUS_RESERVED (-32)

#define ECDSA_STATUS_SUCCESS (0)

#define ECDSA_STATUS_ERROR (-1)

#define ECDSA_STATUS_RESOURCE_UNAVAILABLE (-2)

#define ECDSA_STATUS_R_LARGER_THAN_ORDER (-3)

#define ECDSA_STATUS_S_LARGER_THAN_ORDER (-4)

#define ECDSA_STATUS_PUBLIC_KEY_NOT_ON_CURVE (-5)

#define ECDSA_STATUS_PUBLIC_KEY_LARGER_THAN_PRIME (-6)

#define ECDSA_STATUS_POINT_AT_INFINITY (-7)

#define ECDSA_STATUS_CANCELED (-8)

#define ECDSA_STATUS_INVALID_KEY_SIZE (-10)

#define ECDSA_STATUS_KEYSTORE_ERROR (-11)

typedef struct
{
    void *object;

    void const *hwAttrs;
} ECDSA_Config;

typedef ECDSA_Config *ECDSA_Handle;

typedef enum
{
    ECDSA_RETURN_BEHAVIOR_CALLBACK = 1, 
    ECDSA_RETURN_BEHAVIOR_BLOCKING = 2, 
    ECDSA_RETURN_BEHAVIOR_POLLING  = 4, 
} ECDSA_ReturnBehavior;

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

typedef enum
{
    ECDSA_TYPE_SEC_P_224_R1 = 1,
    ECDSA_TYPE_SEC_P_256_R1 = 2,
    ECDSA_TYPE_SEC_P_384_R1 = 3,
    ECDSA_TYPE_SEC_P_521_R1 = 4,
    ECDSA_TYPE_BRP_P_256_R1 = 5,
    ECDSA_TYPE_BRP_P_384_R1 = 6,
    ECDSA_TYPE_BRP_P_512_R1 = 7,
} ECDSA_CurveType;

typedef enum
{
    ECDSA_CURVE_LENGTH_192 = 192,
    ECDSA_CURVE_LENGTH_224 = 224,
    ECDSA_CURVE_LENGTH_256 = 256,
    ECDSA_CURVE_LENGTH_384 = 384,
    ECDSA_CURVE_LENGTH_512 = 512,
    ECDSA_CURVE_LENGTH_521 = 521,
} ECDSA_CurveLength;

typedef enum
{
    ECDSA_DIGEST_LENGTH_224 = 224,
    ECDSA_DIGEST_LENGTH_256 = 256,
    ECDSA_DIGEST_LENGTH_384 = 384,
    ECDSA_DIGEST_LENGTH_512 = 512,
} ECDSA_DigestLength;
#endif

typedef struct
{
#if ((DeviceFamily_PARENT == DeviceFamily_PARENT_CC27XX) || (DeviceFamily_PARENT == DeviceFamily_PARENT_CC35XX))
    ECDSA_CurveType curveType; 
#endif
    const ECCParams_CurveParams *curve; 
    const CryptoKey *myPrivateKey;      
    const uint8_t *hash;                
    uint8_t *r;                         
    uint8_t *s;                         
} ECDSA_OperationSign;

typedef struct
{
#if ((DeviceFamily_PARENT == DeviceFamily_PARENT_CC27XX) || (DeviceFamily_PARENT == DeviceFamily_PARENT_CC35XX))
    ECDSA_CurveType curveType;
#else
    const ECCParams_CurveParams *curve; 
#endif
    const CryptoKey *theirPublicKey; 
    const uint8_t *hash;             
    const uint8_t *r;                
    const uint8_t *s;                
} ECDSA_OperationVerify;

typedef union
{
    ECDSA_OperationSign *sign;     
    ECDSA_OperationVerify *verify; 
} ECDSA_Operation;

typedef enum
{
    ECDSA_OPERATION_TYPE_SIGN   = 1,
    ECDSA_OPERATION_TYPE_VERIFY = 2,
} ECDSA_OperationType;

typedef void (*ECDSA_CallbackFxn)(ECDSA_Handle handle,
                                  int_fast16_t returnStatus,
                                  ECDSA_Operation operation,
                                  ECDSA_OperationType operationType);

typedef struct
{
    ECDSA_ReturnBehavior returnBehavior; 
    ECDSA_CallbackFxn callbackFxn;       
    uint32_t timeout;                    
    void *custom;                        
} ECDSA_Params;

extern const ECDSA_Params ECDSA_defaultParams;

void ECDSA_init(void);

void ECDSA_close(ECDSA_Handle handle);

ECDSA_Handle ECDSA_open(uint_least8_t index, const ECDSA_Params *params);

void ECDSA_Params_init(ECDSA_Params *params);

void ECDSA_OperationSign_init(ECDSA_OperationSign *operation);

void ECDSA_OperationVerify_init(ECDSA_OperationVerify *operation);

int_fast16_t ECDSA_sign(ECDSA_Handle handle, ECDSA_OperationSign *operation);

int_fast16_t ECDSA_verify(ECDSA_Handle handle, ECDSA_OperationVerify *operation);

int_fast16_t ECDSA_cancelOperation(ECDSA_Handle handle);

ECDSA_Handle ECDSA_construct(ECDSA_Config *config, const ECDSA_Params *params);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_ECDSA__include */