EDDSALPF3HSM.h

Go to the documentation of this file.

/*
 * Copyright (c) 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_EDDSALPF3HSM__include
#define ti_drivers_eddsa_EDDSALPF3HSM__include

#include <ti/drivers/EDDSA.h>

#ifdef __cplusplus
extern "C" {
#endif

/* Defines */
/* The largest signature will be for NIST521 which will produce 72B per component (S and R) */
#define EDDSA_COMPONENT_VECTOR_LENGTH_BYTES 72
#define EDDSA_CURVE_LENGTH_25519            255

#define EDDSALPF3HSM_STATUS_RESOURCE_UNAVAILABLE (ECDSA_STATUS_RESERVED - 0)

#define EDDSALPF3HSM_STATUS_HARDWARE_ERROR (ECDSA_STATUS_RESERVED - 1)

#define EDDSALPF3HSM_STATUS_INVALID_MESSAGE_LENGTH (ECDSA_STATUS_RESERVED - 2)

#define EDDSALPF3HSM_STATUS_INVALID_KEY_ENCODING (ECDSA_STATUS_RESERVED - 3)

typedef struct
{
    uint16_t reserved1;
} EDDSALPF3HSM_HWAttrs;

typedef struct
{
    CryptoKey *privateKey;
    CryptoKey *publicKey;
    bool isOpen;
    bool driverCreatedPrivateKeyAsset;
    bool driverCreatedPublicKeyAsset;
    int_fast16_t returnStatus;
    EDDSA_Operation *operation;
    EDDSA_OperationType operationType;
    EDDSA_CallbackFxn callbackFxn;
    EDDSA_ReturnBehavior returnBehavior;
    uint32_t semaphoreTimeout;
    int_fast16_t hsmStatus;
    uint32_t privateKeyAssetID;
    uint32_t publicKeyAssetID;
    uint32_t paramAssetID;
    uint32_t tempAssetID;
    uint32_t stateAssetID;
    const uint8_t *curveParam;
    uint32_t curveParamSize;
    uint8_t *input;
    size_t inputLength;
    size_t inputLengthRemaining;
    uint8_t signature[EDDSA_COMPONENT_VECTOR_LENGTH_BYTES];
} EDDSALPF3HSM_Object;

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_eddsa_EDDSALPF3HSM__include */