ECJPAKE.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_ECJPAKE__include
#define ti_drivers_ECJPAKE__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 ECJPAKE_STATUS_RESERVED        (-32)

#define ECJPAKE_STATUS_SUCCESS         (0)

#define ECJPAKE_STATUS_ERROR           (-1)

#define ECJPAKE_STATUS_RESOURCE_UNAVAILABLE (-2)

#define ECJPAKE_STATUS_INVALID_PUBLIC_KEY (-3)

#define ECJPAKE_STATUS_PUBLIC_KEY_NOT_ON_CURVE (-4)

#define ECJPAKE_STATUS_PUBLIC_KEY_LARGER_THAN_PRIME (-5)

#define ECJPAKE_STATUS_POINT_AT_INFINITY (-6)

#define ECJPAKE_STATUS_INVALID_PRIVATE_KEY (-7)

#define ECJPAKE_STATUS_INVALID_PRIVATE_V (-8)

#define ECJPAKE_STATUS_CANCELED (-9)

typedef struct ECJPAKE_Config_    *ECJPAKE_Handle;

typedef enum ECJPAKE_ReturnBehavior_ {
    ECJPAKE_RETURN_BEHAVIOR_CALLBACK = 1,   
    ECJPAKE_RETURN_BEHAVIOR_BLOCKING = 2,   
    ECJPAKE_RETURN_BEHAVIOR_POLLING  = 4,   
} ECJPAKE_ReturnBehavior;

typedef struct ECJPAKE_Config_ {
    void               *object;

    void         const *hwAttrs;
} ECJPAKE_Config;

typedef struct ECJPAKE_OperationRoundOneGenerateKeys_ {
    const ECCParams_CurveParams     *curve;                     
    CryptoKey                       *myPrivateKey1;             
    CryptoKey                       *myPrivateKey2;             
    CryptoKey                       *myPublicKey1;              
    CryptoKey                       *myPublicKey2;              
    CryptoKey                       *myPrivateV1;               
    CryptoKey                       *myPrivateV2;                
    CryptoKey                       *myPublicV1;                
    CryptoKey                       *myPublicV2;                
} ECJPAKE_OperationRoundOneGenerateKeys;

typedef struct ECJPAKE_OperationGenerateZKP_ {
    const ECCParams_CurveParams     *curve;                     
    const CryptoKey                 *myPrivateKey;              
    const CryptoKey                 *myPrivateV;                
    const uint8_t                   *hash;                      
    uint8_t                         *r;                         
} ECJPAKE_OperationGenerateZKP;

typedef struct ECJPAKE_OperationVerifyZKP_ {
    const ECCParams_CurveParams     *curve;                     
    const CryptoKey                 *theirGenerator;            
    const CryptoKey                 *theirPublicKey;            
    const CryptoKey                 *theirPublicV;              
    const uint8_t                   *hash;                      
    const uint8_t                   *r;                         
} ECJPAKE_OperationVerifyZKP;

typedef struct ECJPAKE_OperationRoundTwoGenerateKeys_ {
    const ECCParams_CurveParams     *curve;                     
    const CryptoKey                 *myPrivateKey2;             
    const CryptoKey                 *myPublicKey1;              
    const CryptoKey                 *myPublicKey2;              
    const CryptoKey                 *theirPublicKey1;           
    const CryptoKey                 *theirPublicKey2;           
    const CryptoKey                 *preSharedSecret;           
    CryptoKey                       *theirNewGenerator;         
    CryptoKey                       *myNewGenerator;            
    CryptoKey                       *myCombinedPrivateKey;      
    CryptoKey                       *myCombinedPublicKey;       
    CryptoKey                       *myPrivateV;                
    CryptoKey                       *myPublicV;                 
} ECJPAKE_OperationRoundTwoGenerateKeys;

typedef struct ECJPAKE_OperationComputeSharedSecret_ {
    const ECCParams_CurveParams     *curve;                     
    const CryptoKey                 *myCombinedPrivateKey;      
    const CryptoKey                 *theirCombinedPublicKey;    
    const CryptoKey                 *theirPublicKey2;           
    const CryptoKey                 *myPrivateKey2;             
    CryptoKey                       *sharedSecret;              
} ECJPAKE_OperationComputeSharedSecret;


typedef union ECJPAKE_Operation_ {
    ECJPAKE_OperationRoundOneGenerateKeys   *generateRoundOneKeys;  
    ECJPAKE_OperationGenerateZKP            *generateZKP;           
    ECJPAKE_OperationVerifyZKP              *verifyZKP;             
    ECJPAKE_OperationRoundTwoGenerateKeys   *generateRoundTwoKeys;  
    ECJPAKE_OperationComputeSharedSecret    *computeSharedSecret;   
} ECJPAKE_Operation;

typedef enum ECJPAKE_OperationType_ {
    ECJPAKE_OPERATION_TYPE_ROUND_ONE_GENERATE_KEYS = 1,
    ECJPAKE_OPERATION_TYPE_GENERATE_ZKP = 2,
    ECJPAKE_OPERATION_TYPE_VERIFY_ZKP = 3,
    ECJPAKE_OPERATION_TYPE_ROUND_TWO_GENERATE_KEYS = 4,
    ECJPAKE_OPERATION_TYPE_COMPUTE_SHARED_SECRET = 5,
} ECJPAKE_OperationType;

typedef void (*ECJPAKE_CallbackFxn) (ECJPAKE_Handle handle,
                                     int_fast16_t returnStatus,
                                     ECJPAKE_Operation operation,
                                     ECJPAKE_OperationType operationType);

typedef struct ECJPAKE_Params_ {
    ECJPAKE_ReturnBehavior  returnBehavior;                     
    ECJPAKE_CallbackFxn     callbackFxn;                        
    uint32_t                timeout;                            
    void                   *custom;                             
} ECJPAKE_Params;

void ECJPAKE_init(void);

void ECJPAKE_OperationRoundOneGenerateKeys_init(ECJPAKE_OperationRoundOneGenerateKeys *operation);

void ECJPAKE_OperationGenerateZKP_init(ECJPAKE_OperationGenerateZKP *operation);

void ECJPAKE_OperationVerifyZKP_init(ECJPAKE_OperationVerifyZKP *operation);

void ECJPAKE_OperationRoundTwoGenerateKeys_init(ECJPAKE_OperationRoundTwoGenerateKeys *operation);


void ECJPAKE_OperationComputeSharedSecret_init(ECJPAKE_OperationComputeSharedSecret *operation);

void ECJPAKE_close(ECJPAKE_Handle handle);

ECJPAKE_Handle ECJPAKE_open(uint_least8_t index, ECJPAKE_Params *params);

void ECJPAKE_Params_init(ECJPAKE_Params *params);

int_fast16_t ECJPAKE_roundOneGenerateKeys(ECJPAKE_Handle handle, ECJPAKE_OperationRoundOneGenerateKeys *operation);

int_fast16_t ECJPAKE_generateZKP(ECJPAKE_Handle handle, ECJPAKE_OperationGenerateZKP *operation);

int_fast16_t ECJPAKE_verifyZKP(ECJPAKE_Handle handle, ECJPAKE_OperationVerifyZKP *operation);

int_fast16_t ECJPAKE_roundTwoGenerateKeys(ECJPAKE_Handle handle, ECJPAKE_OperationRoundTwoGenerateKeys *operation);

int_fast16_t ECJPAKE_computeSharedSecret(ECJPAKE_Handle handle, ECJPAKE_OperationComputeSharedSecret *operation);

int_fast16_t ECJPAKE_cancelOperation(ECJPAKE_Handle handle);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_ECJPAKE__include */