EDDSA.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020-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_EDDSA__include
#define ti_drivers_EDDSA__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 EDDSA_STATUS_RESERVED (-32)

#define EDDSA_STATUS_SUCCESS (0)

#define EDDSA_STATUS_ERROR (-1)

#define EDDSA_STATUS_CANCELED (-2)

#define EDDSA_STATUS_HASH_UNAVAILABLE (-3)

#define EDDSA_STATUS_PKA_UNAVAILABLE (-4)

#define EDDSA_STATUS_POINT_AT_INFINITY (-5)

#define EDDSA_STATUS_INVALID_PRIVATE_KEY_SIZE (-6)

#define EDDSA_STATUS_INVALID_PUBLIC_KEY_SIZE (-7)

#define EDDSA_STATUS_PUBLIC_KEY_NOT_ON_CURVE (-8)

#define EDDSA_STATUS_INVALID_R_SIZE (-9)

#define EDDSA_STATUS_INVALID_S_SIZE (-10)

#define EDDSA_STATUS_S_LARGER_THAN_ORDER (-11)

#define EDDSA_STATUS_KEY_ID_PARAM_MISMATCH (-12)

#define EDDSA_STATUS_KEYSTORE_INVALID_ID (-13)

#define EDDSA_STATUS_KEYSTORE_GENERIC_FAILURE (-14)

#define EDDSA_STATUS_SHA2_HASH_FAILURE (-15)

#define EDDSA_STATUS_KEYSTORE_ERROR (-16)

#define EDDSA_STATUS_FEATURE_NOT_SUPPORTED (-17)

typedef struct
{
    void *object;

    void const *hwAttrs;
} EDDSA_Config;

typedef EDDSA_Config *EDDSA_Handle;

typedef enum
{
    EDDSA_RETURN_BEHAVIOR_CALLBACK = 1,
    EDDSA_RETURN_BEHAVIOR_BLOCKING = 2,
    EDDSA_RETURN_BEHAVIOR_POLLING = 4,
} EDDSA_ReturnBehavior;

typedef struct
{
    const ECCParams_CurveParams *curve;
    const CryptoKey *myPrivateKey;
    CryptoKey *myPublicKey;
} EDDSA_OperationGeneratePublicKey;

typedef struct
{
    const ECCParams_CurveParams *curve;
    const CryptoKey *myPrivateKey;
    const CryptoKey *myPublicKey;
    const uint8_t *preHashedMessage;
    size_t preHashedMessageLength;
    uint8_t *R;
    uint8_t *S;
} EDDSA_OperationSign;

typedef struct
{
    const ECCParams_CurveParams *curve;
    const CryptoKey *theirPublicKey;
    const uint8_t *preHashedMessage;
    size_t preHashedMessageLength;
    const uint8_t *R;
    const uint8_t *S;
} EDDSA_OperationVerify;

typedef union
{
    EDDSA_OperationGeneratePublicKey *generatePublicKey;
    EDDSA_OperationSign *sign;
    EDDSA_OperationVerify *verify;
} EDDSA_Operation;

typedef enum
{
    EDDSA_OPERATION_TYPE_GENERATE_PUBLIC_KEY = 1,
    EDDSA_OPERATION_TYPE_SIGN                = 2,
    EDDSA_OPERATION_TYPE_VERIFY              = 3,
} EDDSA_OperationType;

typedef void (*EDDSA_CallbackFxn)(EDDSA_Handle handle,
                                  int_fast16_t returnStatus,
                                  EDDSA_Operation operation,
                                  EDDSA_OperationType operationType);

typedef struct
{
    EDDSA_ReturnBehavior returnBehavior;
    EDDSA_CallbackFxn callbackFxn;
    uint32_t timeout;
    void *custom;
} EDDSA_Params;

extern const EDDSA_Params EDDSA_defaultParams;

void EDDSA_init(void);

void EDDSA_close(EDDSA_Handle handle);

EDDSA_Handle EDDSA_open(uint_least8_t index, const EDDSA_Params *params);

void EDDSA_Params_init(EDDSA_Params *params);

void EDDSA_OperationGeneratePublicKey_init(EDDSA_OperationGeneratePublicKey *operation);

void EDDSA_OperationSign_init(EDDSA_OperationSign *operation);

void EDDSA_OperationVerify_init(EDDSA_OperationVerify *operation);

int_fast16_t EDDSA_generatePublicKey(EDDSA_Handle handle, EDDSA_OperationGeneratePublicKey *operation);

int_fast16_t EDDSA_sign(EDDSA_Handle handle, EDDSA_OperationSign *operation);

int_fast16_t EDDSA_verify(EDDSA_Handle handle, EDDSA_OperationVerify *operation);

int_fast16_t EDDSA_cancelOperation(EDDSA_Handle handle);

EDDSA_Handle EDDSA_construct(EDDSA_Config *config, const EDDSA_Params *params);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_EDDSA__include */