ECDH.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2018, 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_ECDH__include
#define ti_drivers_ECDH__include

#ifdef __cplusplus
extern "C" {
#endif

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

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

#define ECDH_CMD_RESERVED           (32)

#define ECDH_STATUS_RESERVED        (-32)

#define ECDH_STATUS_SUCCESS         (0)

#define ECDH_STATUS_ERROR           (-1)

#define ECDH_STATUS_UNDEFINEDCMD    (-2)

#define ECDH_STATUS_RESOURCE_UNAVAILABLE (-3)

#define ECDH_STATUS_POINT_AT_INFINITY (-4)

#define ECDH_STATUS_PRIVATE_KEY_LARGER_EQUAL_ORDER (-5)

#define ECDH_STATUS_PRIVATE_KEY_ZERO (-6)


#define ECDH_STATUS_PUBLIC_KEY_NOT_ON_CURVE (-7)

#define ECDH_STATUS_PUBLIC_KEY_LARGER_THAN_PRIME (-8)

/* Add ECDH_CMD_<commands> here */

typedef struct ECDH_Config_    *ECDH_Handle;

typedef enum ECDH_ReturnBehavior_ {
    ECDH_RETURN_BEHAVIOR_CALLBACK = 1,      
    ECDH_RETURN_BEHAVIOR_BLOCKING = 2,      
    ECDH_RETURN_BEHAVIOR_POLLING  = 4,      
} ECDH_ReturnBehavior;


typedef struct ECDH_Config_ {
    void               *object;

    void         const *hwAttrs;
} ECDH_Config;

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

typedef struct ECDH_OperationComputeSharedSecret_ {
    const ECCParams_CurveParams     *curve;             
    const CryptoKey                 *myPrivateKey;      
    const CryptoKey                 *theirPublicKey;    
    CryptoKey                       *sharedSecret;      
} ECDH_OperationComputeSharedSecret;

typedef union ECDH_Operation_ {
    ECDH_OperationGeneratePublicKey      *generatePublicKey;    
    ECDH_OperationComputeSharedSecret    *computeSharedSecret;  
} ECDH_Operation;

typedef enum ECDH_OperationType_ {
    ECDH_OPERATION_TYPE_GENERATE_PUBLIC_KEY = 1,
    ECDH_OPERATION_TYPE_COMPUTE_SHARED_SECRET = 2,
} ECDH_OperationType;

typedef void (*ECDH_CallbackFxn) (ECDH_Handle handle,
                                  int_fast16_t returnStatus,
                                  ECDH_Operation operation,
                                  ECDH_OperationType operationType);

typedef struct ECDH_Params_ {
    ECDH_ReturnBehavior     returnBehavior;             
    ECDH_CallbackFxn        callbackFxn;                
    uint32_t                timeout;                    
    void                   *custom;                     
} ECDH_Params;

extern const ECDH_Params ECDH_defaultParams;

void ECDH_init(void);

void ECDH_Params_init(ECDH_Params *params);

ECDH_Handle ECDH_open(uint_least8_t index, ECDH_Params *params);

void ECDH_close(ECDH_Handle handle);

int_fast16_t ECDH_control(ECDH_Handle handle, uint32_t cmd, void *args);

void ECDH_OperationGeneratePublicKey_init(ECDH_OperationGeneratePublicKey *operation);

void ECDH_OperationComputeSharedSecret_init(ECDH_OperationComputeSharedSecret *operation);

int_fast16_t ECDH_generatePublicKey(ECDH_Handle handle, ECDH_OperationGeneratePublicKey *operation);

int_fast16_t ECDH_computeSharedSecret(ECDH_Handle handle, ECDH_OperationComputeSharedSecret *operation);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_ECDH__include */