123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201 |
- /**************************************************************************************
- * Copyright (c) 2016-2017, ARM Limited or its affiliates. All rights reserved *
- * *
- * This file and the related binary are licensed under the following license: *
- * *
- * ARM Object Code and Header Files License, v1.0 Redistribution. *
- * *
- * Redistribution and use of object code, header files, and documentation, without *
- * modification, are permitted provided that the following conditions are met: *
- * *
- * 1) Redistributions must reproduce the above copyright notice and the *
- * following disclaimer in the documentation and/or other materials *
- * provided with the distribution. *
- * *
- * 2) Unless to the extent explicitly permitted by law, no reverse *
- * engineering, decompilation, or disassembly of is permitted. *
- * *
- * 3) Redistribution and use is permitted solely for the purpose of *
- * developing or executing applications that are targeted for use *
- * on an ARM-based product. *
- * *
- * DISCLAIMER. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND *
- * CONTRIBUTORS "AS IS." ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT *
- * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT, *
- * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE *
- * COPYRIGHT HOLDERS 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 CRYS_EC_EDW_API_H
- #define CRYS_EC_EDW_API_H
- #include "ssi_pal_types.h"
- #include "crys_hash.h"
- #include "crys_rnd.h"
- #include "crys_pka_defs_hw.h"
- #ifdef __cplusplus
- extern "C" {
- #endif
- /*!
- @defgroup cryptocell_ec CryptoCell EC 25519 curve APIs
- @{
- @ingroup cryptocell_api
- @brief This group is the cryptocell EC 25519 curve root group
- @}
- @file
- @brief This file contains the CRYS APIs used for EC EDW (Edwards) ed25519 algorithms.
- @defgroup crys_ec_edw CryptoCell EC Edwards APIs
- @{
- @ingroup cryptocell_ec
- \note Algorithms of Montgomery and Edwards elliptic curves cryptography were developed by
- Daniel.J.Bernstein.
- */
- /*! EC Edwards ed25519 modulus and order sizes in bits, words and bytes. */
- /*! EC Edwards modulus size in bits. */
- #define CRYS_ECEDW_MOD_SIZE_IN_BITS 255U /*!<\internal MOD - EC Edw modulus size*/
- /*! EC Edwards order size in bits. */
- #define CRYS_ECEDW_ORD_SIZE_IN_BITS 255U /*!<\internal ORD - EC Edw generator order size*/
- /*! EC Edwards nodulus size in words. */
- #define CRYS_ECEDW_MOD_SIZE_IN_32BIT_WORDS ((CRYS_ECEDW_MOD_SIZE_IN_BITS + SASI_BITS_IN_32BIT_WORD - 1) / SASI_BITS_IN_32BIT_WORD)
- /*! EC Edwards modulus size in bytes. */
- #define CRYS_ECEDW_MOD_SIZE_IN_BYTES (CRYS_ECEDW_MOD_SIZE_IN_32BIT_WORDS * SASI_32BIT_WORD_SIZE)
- /*! EC Edwards order size in words. */
- #define CRYS_ECEDW_ORD_SIZE_IN_32BIT_WORDS ((CRYS_ECEDW_ORD_SIZE_IN_BITS + SASI_BITS_IN_32BIT_WORD - 1) / SASI_BITS_IN_32BIT_WORD)
- /*! EC Edwards order size in bytes. */
- #define CRYS_ECEDW_ORD_SIZE_IN_BYTES (CRYS_ECEDW_ORD_SIZE_IN_32BIT_WORDS * SASI_32BIT_WORD_SIZE)
- /*! Constant sizes of special EC_MONT buffers and arrays */
- /*! EC Edwards seed size in bytes. */
- #define CRYS_ECEDW_SEED_BYTES CRYS_ECEDW_MOD_SIZE_IN_BYTES
- /*! EC Edwards secret key size in bytes. */
- #define CRYS_ECEDW_SECRET_KEY_BYTES (2 * CRYS_ECEDW_MOD_SIZE_IN_BYTES)
- /*! EC Edwards signatue size in bytes. */
- #define CRYS_ECEDW_SIGNATURE_BYTES (2 * CRYS_ECEDW_ORD_SIZE_IN_BYTES)
- /*! EC Edwards scalar size in bytes. */
- #define CRYS_ECEDW_SCALAR_BYTES CRYS_ECEDW_ORD_SIZE_IN_BYTES
- /*! EC Edwards scalar multiplication size in bytes. */
- #define CRYS_ECEDW_SCALARMULT_BYTES CRYS_ECEDW_MOD_SIZE_IN_BYTES
- /*! EC_EDW temp buffer size definition. */
- #define CRYS_ECEDW_TEMP_BUFF_SIZE_IN_32BIT_WORD (10*CRYS_EC_MONT_EDW_MODULUS_MAX_SIZE_IN_WORDS + (sizeof(CRYS_HASHUserContext_t)+SASI_32BIT_WORD_SIZE-1)/SASI_32BIT_WORD_SIZE)
- /*! EC_EDW temp buffer type definition. */
- typedef struct {
- /*! Internal buffer. */
- uint32_t buff[CRYS_ECEDW_TEMP_BUFF_SIZE_IN_32BIT_WORD];
- } CRYS_ECEDW_TempBuff_t;
- /******************************************************************************/
- /*!
- @brief The function creates EC Edwards signature on the message.
- \note Used detached form of signature, separated from the message.
- Implemented algorithm of Bernstein D. etc. sign ed25519.
- @return CRYS_OK on success,
- @return A non-zero value on failure as defined crys_ec_mont_edw_error.h or crys_hash_error.h.
- */
- CIMPORT_C CRYSError_t CRYS_ECEDW_Sign (
- uint8_t *pSign, /*!< [out] Pointer to the detached signature. */
- size_t *pSignSize, /*!< [in/out] Pointer to the total size of the signature ;
- In - the buffer size, which (must be at least 2*EC order size);
- Out - the actual size of output data. */
- const uint8_t *pMsg, /*!< [in] Pointer to the message. */
- size_t msgSize, /*!< [in] Message size in bytes: must be less, than
- (CRYS_HASH_UPDATE_DATA_MAX_SIZE_IN_BYTES - 2*(EC_EDW modulus size)). */
- const uint8_t *pSignSecrKey, /*!< [in] Pointer to the signer secret key (seed || pulKey) */
- size_t secrKeySize, /*!< [in] Size of signer secret key in bytes: (must be 2*EC order size). */
- CRYS_ECEDW_TempBuff_t *pTempBuff /*!< [in] Pointer to the temp buffer. */);
- /******************************************************************************/
- /*!
- @brief The function verifies the EC Edwards ed25519 signature on the message.
- \note The input signature is in detached form, i.e. separated from the message.
- @return CRYS_OK on success,
- @return A non-zero value on failure as defined crys_ec_mont_edw_error.h or crys_hash_error.h.
- */
- CIMPORT_C CRYSError_t CRYS_ECEDW_Verify(
- const uint8_t *pSign, /*!< [in] Pointer to detached signature, i.e. the
- signature is separated from the message. */
- size_t signSize, /*!< [in] Size of the signature in bytes, it must be
- equal to two EC Order size in bytes. */
- const uint8_t *pSignPublKey, /*!< [in] Pointer to signer public key. */
- size_t publKeySize, /*!< [in] Size of the signer public key in bytes; must be
- equal to EC modulus size. */
- uint8_t *pMsg, /*!< [in] Pointer to the message. */
- size_t msgSize, /*!< [in] Pointer to the message size in bytes. Must be less than
- (CRYS_HASH_UPDATE_DATA_MAX_SIZE_IN_BYTES - 2*(EC_EDW modulus size)). */
- CRYS_ECEDW_TempBuff_t *pTempBuff /*!< [in] Pointer to the temp buffer, for internal use. */);
- /******************************************************************************/
- /*!
- @brief The function randomly generates Ec ed25519 private and public keys
- using given seed.
- The generation is performed using EC Edwards ed25519 algorithm.
- @return CRYS_OK on success,
- @return A non-zero value on failure as defined crys_ec_mont_edw_error.h or crys_hash_error.h.
- */
- CIMPORT_C CRYSError_t CRYS_ECEDW_SeedKeyPair (
- const uint8_t *pSeed, /*!< [in] Pointer to the given seed. */
- size_t seedSize, /*!< [in] Size of the seed in bytes, must be equal the EC order size
- in bytes. */
- uint8_t *pSecrKey, /*!< [out] Pointer to the secret key, including the seed, concatenated
- with the public key. */
- size_t *pSecrKeySize, /*!< [in/out] Pointer to the size of the secret key buffer in bytes
- (must be at least 2*EC order size). */
- uint8_t *pPublKey, /*!< [out] Pointer to the public key. */
- size_t *pPublKeySize, /*!< [in/out] Pointer to the size of the public key in bytes.
- In - the size of buffer must be at least EC modulus size;
- Out - the actual size. */
- CRYS_ECEDW_TempBuff_t *pTempBuff /*!< [in] Pointer to the temp buffer, for internal use. */);
- /*******************************************************************/
- /*!
- @brief The function randomly generates the EC Edwards ed25519 private and
- public keys.
- The generation is performed using EC Edwards ed25519 algorithm.
- @return CRYS_OK on success,
- @return A non-zero value on failure as defined crys_ec_mont_edw_error.h, crys_hash_error.h or crys_rnd_error.
- */
- CIMPORT_C CRYSError_t CRYS_ECEDW_KeyPair (
- uint8_t *pSecrKey, /*!< [out] Pointer to the secret key (including seed and public key). */
- size_t *pSecrKeySize, /*!< [in/out] Pointer to the size of the secret key in bytes,
- (must be at least 2*EC order size). */
- uint8_t *pPublKey, /*!< [out] Pointer to the public key. */
- size_t *pPublKeySize, /*!< [in/out] - Pointer to the size of the public key in bytes.
- In - the size of buffer must be at least EC modulus size;
- Out - the actual size. */
- void *pRndState, /*!< [in/out] Pointer to the RND state structure. */
- SaSiRndGenerateVectWorkFunc_t rndGenerateVectFunc, /*!< [in] Pointer to the random vector generation function. */
- CRYS_ECEDW_TempBuff_t *pTempBuff /*!< [in] Pointer to the temp buffer. */);
- #ifdef __cplusplus
- }
- #endif
- /**
- @}
- */
- #endif
|