primefld.h

Go to the documentation of this file.

/*
 * primefld.h
 *
 * Prime Field Header
 *
 * Copyright 2019-2024 DigiCert, Inc. All Rights Reserved.
 * Proprietary and Confidential Material.
 *
 */

/*------------------------------------------------------------------*/

#ifndef __PRIMEFLD_HEADER__
#define __PRIMEFLD_HEADER__

#include "../crypto/cryptodecl.h"

#ifdef __cplusplus
extern "C" {
#endif

#if (defined(__ENABLE_MOCANA_ECC__))

#ifdef __ENABLE_MOCANA_64_BIT__
#define MOC_EC_ONE 0x01ULL
#define MOC_EC_TWO 0x02ULL
#else
#define MOC_EC_ONE 0x01
#define MOC_EC_TWO 0x02
#endif

#ifdef MOC_EXTERN_PRIMEFLD_H
#undef MOC_EXTERN_PRIMEFLD_H
#endif /* MOC_EXTERN_PRIMEFLD_H */

#ifdef __RTOS_WIN32__

#ifdef WIN_EXPORT_PRIMEFLD_H
#define MOC_EXTERN_PRIMEFLD_H __declspec(dllexport)
#else
#define MOC_EXTERN_PRIMEFLD_H __declspec(dllimport) extern 
#endif /* WIN_EXPORT_PRIMEFLD_H */

#ifdef WIN_STATIC
#undef MOC_EXTERN_PRIMEFLD_H
#define MOC_EXTERN_PRIMEFLD_H extern
#endif /* WIN_STATIC */

#else

#define MOC_EXTERN_PRIMEFLD_H MOC_EXTERN

#endif /* RTOS_WIN32 */

#ifdef MOC_EXTERN_P
#undef MOC_EXTERN_P
#endif /* MOC_EXTERN_P */

#define MOC_EXTERN_P MOC_EXTERN_PRIMEFLD_H

/* NIST curves */
#ifdef __ENABLE_MOCANA_ECC_P192__
MOC_EXTERN_PRIMEFLD_H const PrimeFieldPtr PF_p192;
#endif

#ifndef __DISABLE_MOCANA_ECC_P224__
MOC_EXTERN_PRIMEFLD_H const PrimeFieldPtr PF_p224;
#endif

#ifndef __DISABLE_MOCANA_ECC_P256__
MOC_EXTERN_PRIMEFLD_H const PrimeFieldPtr PF_p256;
#endif

#ifndef __DISABLE_MOCANA_ECC_P384__
MOC_EXTERN_PRIMEFLD_H const PrimeFieldPtr PF_p384;
#endif

#if defined(__ENABLE_MOCANA_ECC_EDDSA_448__) || defined(__ENABLE_MOCANA_ECC_EDDH_448__) || defined(__ENABLE_MOCANA_FIPS_MODULE__)
MOC_EXTERN_PRIMEFLD_H const PrimeFieldPtr PF_p448;
#endif

#ifndef __DISABLE_MOCANA_ECC_P521__
MOC_EXTERN_PRIMEFLD_H const PrimeFieldPtr PF_p521;
#endif

MOC_EXTERN MSTATUS PRIMEFIELD_newElement( PrimeFieldPtr pField, PFEPtr* ppNewElem);

MOC_EXTERN MSTATUS PRIMEFIELD_copyElement( PrimeFieldPtr pField, PFEPtr pDestElem, ConstPFEPtr pSrcElem);

MOC_EXTERN intBoolean PRIMEFIELD_comparePrimeFields(PrimeFieldPtr pField1, PrimeFieldPtr pField2);

MOC_EXTERN MSTATUS PRIMEFIELD_deleteElement( PrimeFieldPtr pField, PFEPtr* ppDeleteElem);

MOC_EXTERN MSTATUS PRIMEFIELD_add( PrimeFieldPtr pField, PFEPtr pSumAndValue, ConstPFEPtr pAddend);

MOC_EXTERN MSTATUS PRIMEFIELD_subtract( PrimeFieldPtr pField, PFEPtr pResultAndValue, ConstPFEPtr pSubtract);

MOC_EXTERN MSTATUS PRIMEFIELD_xor(PrimeFieldPtr pField, PFEPtr pResultAndValue, ConstPFEPtr pXor);

MOC_EXTERN MSTATUS PRIMEFIELD_multiply( PrimeFieldPtr pField, PFEPtr pProduct, ConstPFEPtr pA, ConstPFEPtr pB);

MOC_EXTERN MSTATUS PRIMEFIELD_shiftR( PrimeFieldPtr pField, PFEPtr pA);

MOC_EXTERN MSTATUS PRIMEFIELD_getBit( PrimeFieldPtr pField, ConstPFEPtr pA, ubyte4 bitNum, ubyte* bit);

MOC_EXTERN MSTATUS PRIMEFIELD_inverse( PrimeFieldPtr pField, PFEPtr pInverse, ConstPFEPtr pA);

MOC_EXTERN MSTATUS PRIMEFIELD_divide( PrimeFieldPtr pField, PFEPtr pResult, ConstPFEPtr pA, ConstPFEPtr pDivisor);

MOC_EXTERN MSTATUS PRIMEFIELD_squareRoot(PrimeFieldPtr pField, PFEPtr pResult, ConstPFEPtr pA);

MOC_EXTERN sbyte4 PRIMEFIELD_cmpToUnsigned(PrimeFieldPtr pField, ConstPFEPtr pA, ubyte4 val);

MOC_EXTERN MSTATUS PRIMEFIELD_setToUnsigned(PrimeFieldPtr pField, PFEPtr pA, ubyte4 val);

MOC_EXTERN MSTATUS PRIMEFIELD_setToByteString( PrimeFieldPtr pField, PFEPtr pA, const ubyte* b, sbyte4 len);

MOC_EXTERN MSTATUS PRIMEFIELD_getAsByteString( PrimeFieldPtr pField, ConstPFEPtr pA, ubyte** b, sbyte4* len);

MOC_EXTERN MSTATUS PRIMEFIELD_getAsByteString2( PrimeFieldPtr pField, ConstPFEPtr pA, ConstPFEPtr pB, ubyte** b, sbyte4* len);

MOC_EXTERN MSTATUS PRIMEFIELD_writeByteString( PrimeFieldPtr pField, ConstPFEPtr pA, ubyte* b, sbyte4 len);

MOC_EXTERN MSTATUS PRIMEFIELD_getElementByteStringLen(PrimeFieldPtr pField, sbyte4* len);

MOC_EXTERN sbyte4 PRIMEFIELD_cmp(PrimeFieldPtr pField, ConstPFEPtr pA, ConstPFEPtr pB);

MOC_EXTERN intBoolean PRIMEFIELD_match(PrimeFieldPtr pField, ConstPFEPtr pA, ConstPFEPtr pB);

MOC_EXTERN MSTATUS PRIMEFIELD_barrettMultiply( PrimeFieldPtr pField, PFEPtr pProduct, ConstPFEPtr pA,
                                          ConstPFEPtr pB, ConstPFEPtr pModulo, ConstPFEPtr pMu);

MOC_EXTERN MSTATUS PRIMEFIELD_addAux( PrimeFieldPtr pField, PFEPtr pSumAndValue, ConstPFEPtr pAddend,
                                    ConstPFEPtr pModulus);

MOC_EXTERN MSTATUS PRIMEFIELD_inverseAux( sbyte4 k, PFEPtr pInverse, ConstPFEPtr pA, ConstPFEPtr pModulus);

MOC_EXTERN MSTATUS PRIMEFIELD_add2( PrimeFieldPtr pField, PFEPtr pSum, ConstPFEPtr pAddend, ConstPFEPtr pAddend2);

MOC_EXTERN MSTATUS PRIMEFIELD_subtract2( PrimeFieldPtr pField, PFEPtr pResult, ConstPFEPtr pMinuend, ConstPFEPtr pSubtrahend);

MOC_EXTERN MSTATUS PRIMEFIELD_additiveInvert(PrimeFieldPtr pField, PFEPtr pA);

MOC_EXTERN MSTATUS PRIMEFIELD_specialExp448( PFEPtr pResult, ConstPFEPtr pA, byteBoolean isInverse);

#if (defined(__ENABLE_MOCANA_VLONG_ECC_CONVERSION__))

MOC_EXTERN MSTATUS PRIMEFIELD_newElementFromVlong( PrimeFieldPtr pField, const vlong* pV,
                                              PFEPtr* ppNewElem);

MOC_EXTERN MSTATUS PRIMEFIELD_newVlongFromElement( PrimeFieldPtr pField, ConstPFEPtr pElem,
                                              vlong** ppNewElem, vlong** ppQueue);

MOC_EXTERN MSTATUS PRIMEFIELD_getPrime( PrimeFieldPtr pField, vlong** ppPrime);

MOC_EXTERN MSTATUS PRIMEFIELD_newMpintFromElement(PrimeFieldPtr pField, ConstPFEPtr pElem, ubyte** ppNewMpint, sbyte4 *pRetMpintLength, vlong** ppVlongQueue);

MOC_EXTERN MSTATUS PRIMEFIELD_newElementFromMpint(const ubyte* pBuffer, ubyte4 bufSize, ubyte4 *pBufIndex, PrimeFieldPtr pField, PFEPtr* ppNewElem);
#endif

#endif /* __ENABLE_MOCANA_ECC__  */

#ifdef __cplusplus
}
#endif

#endif /* __PRIMEFLD_HEADER__ */