ECJPAKECC26X2.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_ECJPAKECC26X2__include
#define ti_drivers_ecjpake_ECJPAKECC26X2__include

#ifdef __cplusplus
extern "C" {
#endif

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

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

#include <ti/drivers/dpl/HwiP.h>
#include <ti/drivers/dpl/SwiP.h>
#include <ti/drivers/dpl/SemaphoreP.h>

/* Exit the SWI and wait until an HWI call posts the SWI again */
#define ECJPAKECC26X2_STATUS_FSM_RUN_PKA_OP       ECJPAKE_STATUS_RESERVED - 0
/* Execute the next FSM state immediately without waiting for the next HWI */
#define ECJPAKECC26X2_STATUS_FSM_RUN_FSM          ECJPAKE_STATUS_RESERVED - 1

typedef enum ECJPAKECC26X2_FsmState_ {
    ECJPAKECC26X2_FSM_ERROR = 0,

    ECJPAKECC26X2_FSM_ROUND_ONE_VALIDATE_MYPRIVATEKEY1,
    ECJPAKECC26X2_FSM_ROUND_ONE_VALIDATE_MYPRIVATEKEY2,
    ECJPAKECC26X2_FSM_ROUND_ONE_VALIDATE_MYPRIVATEV1,
    ECJPAKECC26X2_FSM_ROUND_ONE_VALIDATE_MYPRIVATEV2,
    ECJPAKECC26X2_FSM_ROUND_ONE_GENERATE_MYPUBLICKEY1,
    ECJPAKECC26X2_FSM_ROUND_ONE_GENERATE_MYPUBLICKEY1_RESULT,
    ECJPAKECC26X2_FSM_ROUND_ONE_GENERATE_MYPUBLICKEY2,
    ECJPAKECC26X2_FSM_ROUND_ONE_GENERATE_MYPUBLICKEY2_RESULT,
    ECJPAKECC26X2_FSM_ROUND_ONE_GENERATE_MYPUBLICV1,
    ECJPAKECC26X2_FSM_ROUND_ONE_GENERATE_MYPUBLICV1_RESULT,
    ECJPAKECC26X2_FSM_ROUND_ONE_GENERATE_MYPUBLICV2,
    ECJPAKECC26X2_FSM_ROUND_ONE_GENERATE_MYPUBLICV2_RESULT,
    ECJPAKECC26X2_FSM_ROUND_ONE_GENERATE_RETURN,

    ECJPAKECC26X2_FSM_GENERATE_ZKP_PRIVATEKEY_X_HASH,
    ECJPAKECC26X2_FSM_GENERATE_ZKP_PRIVATEKEY_X_HASH_RESULT,
    ECJPAKECC26X2_FSM_GENERATE_ZKP_PRIVATEKEY_X_HASH_MOD_N,
    ECJPAKECC26X2_FSM_GENERATE_ZKP_PRIVATEKEY_X_HASH_MOD_N_RESULT,
    ECJPAKECC26X2_FSM_GENERATE_ZKP_ADD_V_TO_N,
    ECJPAKECC26X2_FSM_GENERATE_ZKP_ADD_V_TO_N_RESULT,
    ECJPAKECC26X2_FSM_GENERATE_ZKP_SUBTRACT_RESULTS,
    ECJPAKECC26X2_FSM_GENERATE_ZKP_SUBTRACT_RESULTS_RESULT,
    ECJPAKECC26X2_FSM_GENERATE_ZKP_SUBTRACT_RESULT_MOD_N,
    ECJPAKECC26X2_FSM_GENERATE_ZKP_SUBTRACT_RESULT_MOD_N_RESULT,
    ECJPAKECC26X2_FSM_ZKP_GENERATE_RETURN,

    ECJPAKECC26X2_FSM_VERIFY_ZKP_VALIDATE_PUBLIC_KEY,
    ECJPAKECC26X2_FSM_VERIFY_ZKP_HASH_MOD_N,
    ECJPAKECC26X2_FSM_VERIFY_ZKP_HASH_MOD_N_RESULT,
    ECJPAKECC26X2_FSM_VERIFY_ZKP_MULT_G_BY_R,
    ECJPAKECC26X2_FSM_VERIFY_ZKP_MULT_G_BY_R_RESULT,
    ECJPAKECC26X2_FSM_VERIFY_ZKP_MULT_X_BY_HASH,
    ECJPAKECC26X2_FSM_VERIFY_ZKP_MULT_X_BY_HASH_RESULT,
    ECJPAKECC26X2_FSM_VERIFY_ZKP_ADD_RESULTS,
    ECJPAKECC26X2_FSM_VERIFY_ZKP_ADD_RESULTS_RESULT,
    ECJPAKECC26X2_FSM_VERIFY_ZKP_COMPARE_AGAINST_V,

    ECJPAKECC26X2_FSM_ROUND_TWO_MULT_MYPRIVATEKEY2_BY_PRESHAREDSECRET,
    ECJPAKECC26X2_FSM_ROUND_TWO_MULT_MYPRIVATEKEY2_BY_PRESHAREDSECRET_RESULT,
    ECJPAKECC26X2_FSM_ROUND_TWO_MYCOMBINEDPRIVATEKEY_MOD_N,
    ECJPAKECC26X2_FSM_ROUND_TWO_MYCOMBINEDPRIVATEKEY_MOD_N_RESULT,
    ECJPAKECC26X2_FSM_ROUND_TWO_ADD_MYPUBLICKEY1_TO_THEIRPUBLICKEY1,
    ECJPAKECC26X2_FSM_ROUND_TWO_ADD_MYPUBLICKEY1_TO_THEIRPUBLICKEY1_RESULT,
    ECJPAKECC26X2_FSM_ROUND_TWO_ADD_THEIRPUBLICKEY2,
    ECJPAKECC26X2_FSM_ROUND_TWO_ADD_THEIRPUBLICKEY2_RESULT,
    ECJPAKECC26X2_FSM_ROUND_TWO_ADD_MYPUBLICKEY2,
    ECJPAKECC26X2_FSM_ROUND_TWO_ADD_MYPUBLICKEY2_RESULT,
    ECJPAKECC26X2_FSM_ROUND_TWO_MULT_MYCOMBINEDPRIVATEKEY_BY_MYNEWGENERATOR,
    ECJPAKECC26X2_FSM_ROUND_TWO_MULT_MYCOMBINEDPRIVATEKEY_BY_MYNEWGENERATOR_RESULT,
    ECJPAKECC26X2_FSM_ROUND_TWO_VALIDATE_MYPRIVATEV,
    ECJPAKECC26X2_FSM_ROUND_TWO_GENERATE_MYPUBLICV,
    ECJPAKECC26X2_FSM_ROUND_TWO_GENERATE_MYPUBLICV_RESULT,
    ECJPAKECC26X2_FSM_ROUND_TWO_GENERATE_RETURN,

    ECJPAKECC26X2_FSM_GENERATE_SHARED_SECRET_MULT_THEIRPUBLICKEY2_BY_MYCOMBINEDPRIVATEKEY,
    ECJPAKECC26X2_FSM_GENERATE_SHARED_SECRET_MULT_THEIRPUBLICKEY2_BY_MYCOMBINEDPRIVATEKEY_RESULT,
    ECJPAKECC26X2_FSM_GENERATE_SHARED_SECRET_SUB_YCOORDINATE_FROM_PRIME,
    ECJPAKECC26X2_FSM_GENERATE_SHARED_SECRET_SUB_YCOORDINATE_FROM_PRIME_RESULT,
    ECJPAKECC26X2_FSM_GENERATE_SHARED_SECRET_ADD_THEIRCOMBINEDPUBLICKEY,
    ECJPAKECC26X2_FSM_GENERATE_SHARED_SECRET_ADD_THEIRCOMBINEDPUBLICKEY_RESULT,
    ECJPAKECC26X2_FSM_GENERATE_SHARED_SECRET_MULT_BY_MYPRIVATEKEY2,
    ECJPAKECC26X2_FSM_GENERATE_SHARED_SECRET_MULT_BY_MYPRIVATEKEY2_RESULT,
    ECJPAKECC26X2_FSM_GENERATE_SHARED_SECRET_RETURN,

} ECJPAKECC26X2_FsmState;

typedef struct ECJPAKECC26X2_HWAttrs_ {
    uint8_t    intPriority;
} ECJPAKECC26X2_HWAttrs;

typedef struct ECJPAKECC26X2_Object_ {
    bool                                isOpen;
    bool                                operationInProgress;
    bool                                operationCanceled;
    int_fast16_t                        operationStatus;
    ECJPAKE_CallbackFxn                 callbackFxn;
    ECJPAKE_ReturnBehavior              returnBehavior;
    ECJPAKECC26X2_FsmState              fsmState;
    ECJPAKE_Operation                   operation;
    ECJPAKE_OperationType               operationType;
    uint32_t                            semaphoreTimeout;
    uint32_t                            resultAddress;
} ECJPAKECC26X2_Object;

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_ecjpake_ECJPAKECC26X2__include */