TrustCore SDK Crypto Interface API reference  version 2.0
crypto_interface_sha256.h File Reference

Cryptographic Interface header file for declaring SHA256 functions. More...

Go to the source code of this file.

Functions

MOC_EXTERN MSTATUS CRYPTO_INTERFACE_SHA224_cloneCtx (MOC_HASH(hwAccelDescr hwAccelCtx) SHA224_CTX *pDest, SHA224_CTX *pSrc)
 Makes a clone of a previously allocated SHA224_CTX. More...
 
MOC_EXTERN MSTATUS CRYPTO_INTERFACE_SHA224_completeDigest (MOC_HASH(hwAccelDescr hwAccelCtx) const ubyte *pData, ubyte4 dataLen, ubyte *pShaOutput)
 Perform a SHA224 digest in one step. More...
 
MOC_EXTERN MSTATUS CRYPTO_INTERFACE_SHA224_finalDigest (MOC_HASH(hwAccelDescr hwAccelCtx) SHA224_CTX *pContext, ubyte *pOutput)
 Finalize a digest operation and recieve the result. More...
 
MOC_EXTERN MSTATUS CRYPTO_INTERFACE_SHA224_initDigest (MOC_HASH(hwAccelDescr hwAccelCtx) SHA224_CTX *pContext)
 Initialize a SHA224 context for a new digest operation. More...
 
MOC_EXTERN MSTATUS CRYPTO_INTERFACE_SHA256_allocDigest (MOC_HASH(hwAccelDescr hwAccelCtx) BulkCtx *pp_context)
 Allocate a new SHA context. More...
 
MOC_EXTERN MSTATUS CRYPTO_INTERFACE_SHA256_cloneCtx (MOC_HASH(hwAccelDescr hwAccelCtx) SHA256_CTX *pDest, SHA256_CTX *pSrc)
 Makes a clone of a previously allocated SHA256_CTX. More...
 
MOC_EXTERN MSTATUS CRYPTO_INTERFACE_SHA256_completeDigest (MOC_HASH(hwAccelDescr hwAccelCtx) const ubyte *pData, ubyte4 dataLen, ubyte *pShaOutput)
 Perform a SHA256 digest in one step. More...
 
MOC_EXTERN MSTATUS CRYPTO_INTERFACE_SHA256_finalDigest (MOC_HASH(hwAccelDescr hwAccelCtx) SHA256_CTX *pContext, ubyte *pOutput)
 Finalize a digest operation and recieve the result. More...
 
MOC_EXTERN MSTATUS CRYPTO_INTERFACE_SHA256_freeDigest (MOC_HASH(hwAccelDescr hwAccelCtx) BulkCtx *pp_context)
 Free a SHA224 or SHA256 context previously allocated with CRYPTO_INTERFACE_SHA1_allocDigest. More...
 
MOC_EXTERN MSTATUS CRYPTO_INTERFACE_SHA256_initDigest (MOC_HASH(hwAccelDescr hwAccelCtx) SHA256_CTX *pContext)
 Initialize a SHA256 context for a new digest operation. More...
 
MOC_EXTERN MSTATUS CRYPTO_INTERFACE_SHA256_updateDigest (MOC_HASH(hwAccelDescr hwAccelCtx) SHA256_CTX *pContext, const ubyte *pData, ubyte4 dataLen)
 Update a digest operation. More...
 

Detailed Description

Add details here.

crypto_interface_sha256.h

Function Documentation

◆ CRYPTO_INTERFACE_SHA224_cloneCtx()

MOC_EXTERN MSTATUS CRYPTO_INTERFACE_SHA224_cloneCtx ( MOC_HASH(hwAccelDescr hwAccelCtx) SHA224_CTX *  pDest,
SHA224_CTX *  pSrc 
)
Parameters
pDestPointer to an already allocated destination context.
pSrcPointer to the context to be copied.
Returns
OK (0) if successful, otherwise a negative number error code from merrors.h.

◆ CRYPTO_INTERFACE_SHA224_completeDigest()

MOC_EXTERN MSTATUS CRYPTO_INTERFACE_SHA224_completeDigest ( MOC_HASH(hwAccelDescr hwAccelCtx) const ubyte *  pData,
ubyte4  dataLen,
ubyte *  pShaOutput 
)
Parameters
pDataData to digest.
dataLenLength in bytes of the data to digest.
pShaOutputBuffer of size SHA224_RESULT_SIZE that will recieve the digest.
Returns
OK (0) if successful, otherwise a negative number error code from merrors.h.

◆ CRYPTO_INTERFACE_SHA224_finalDigest()

MOC_EXTERN MSTATUS CRYPTO_INTERFACE_SHA224_finalDigest ( MOC_HASH(hwAccelDescr hwAccelCtx) SHA224_CTX *  pContext,
ubyte *  pOutput 
)
Parameters
pContextThe digest context used to update the data.
pOutputBuffer of size SHA224_RESULT_SIZE that will recieve the digest.
Returns
OK (0) if successful, otherwise a negative number error code from merrors.h.

◆ CRYPTO_INTERFACE_SHA224_initDigest()

MOC_EXTERN MSTATUS CRYPTO_INTERFACE_SHA224_initDigest ( MOC_HASH(hwAccelDescr hwAccelCtx) SHA224_CTX *  pContext)
Parameters
pContextThe SHA224 context to initialize.
Returns
OK (0) if successful, otherwise a negative number error code from merrors.h.

◆ CRYPTO_INTERFACE_SHA256_allocDigest()

MOC_EXTERN MSTATUS CRYPTO_INTERFACE_SHA256_allocDigest ( MOC_HASH(hwAccelDescr hwAccelCtx) BulkCtx *  pp_context)

Note that SHA224 and SHA256 share this function. It is the callers responsibility to free this object after use by calling CRYPTO_INTERFACE_SHA256_freeDigest.

Parameters
pp_contextOn return, pointer to the address of the allocated context.
Returns
OK (0) if successful, otherwise a negative number error code from merrors.h.

◆ CRYPTO_INTERFACE_SHA256_cloneCtx()

MOC_EXTERN MSTATUS CRYPTO_INTERFACE_SHA256_cloneCtx ( MOC_HASH(hwAccelDescr hwAccelCtx) SHA256_CTX *  pDest,
SHA256_CTX *  pSrc 
)
Parameters
pDestPointer to an already allocated destination context.
pSrcPointer to the context to be copied.
Returns
OK (0) if successful, otherwise a negative number error code from merrors.h.

◆ CRYPTO_INTERFACE_SHA256_completeDigest()

MOC_EXTERN MSTATUS CRYPTO_INTERFACE_SHA256_completeDigest ( MOC_HASH(hwAccelDescr hwAccelCtx) const ubyte *  pData,
ubyte4  dataLen,
ubyte *  pShaOutput 
)
Parameters
pDataData to digest.
dataLenLength in bytes of the data to digest.
pShaOutputBuffer of size SHA256_RESULT_SIZE that will recieve the digest.
Returns
OK (0) if successful, otherwise a negative number error code from merrors.h.

◆ CRYPTO_INTERFACE_SHA256_finalDigest()

MOC_EXTERN MSTATUS CRYPTO_INTERFACE_SHA256_finalDigest ( MOC_HASH(hwAccelDescr hwAccelCtx) SHA256_CTX *  pContext,
ubyte *  pOutput 
)
Parameters
pContextThe digest context used to update the data.
pOutputBuffer of size SHA256_RESULT_SIZE that will recieve the digest.
Returns
OK (0) if successful, otherwise a negative number error code from merrors.h.

◆ CRYPTO_INTERFACE_SHA256_freeDigest()

MOC_EXTERN MSTATUS CRYPTO_INTERFACE_SHA256_freeDigest ( MOC_HASH(hwAccelDescr hwAccelCtx) BulkCtx *  pp_context)
Parameters
pp_contextContext to be freed.
Returns
OK (0) if successful, otherwise a negative number error code from merrors.h.

◆ CRYPTO_INTERFACE_SHA256_initDigest()

MOC_EXTERN MSTATUS CRYPTO_INTERFACE_SHA256_initDigest ( MOC_HASH(hwAccelDescr hwAccelCtx) SHA256_CTX *  pContext)
Parameters
pContextThe SHA256 context to initialize.
Returns
OK (0) if successful, otherwise a negative number error code from merrors.h.

◆ CRYPTO_INTERFACE_SHA256_updateDigest()

MOC_EXTERN MSTATUS CRYPTO_INTERFACE_SHA256_updateDigest ( MOC_HASH(hwAccelDescr hwAccelCtx) SHA256_CTX *  pContext,
const ubyte *  pData,
ubyte4  dataLen 
)

Note that SHA224 and SHA256 share this function.

Parameters
pContextThe digest context to be updated.
pDataThe data to update the context with.
dataLenLength in bytes of the update data.
Returns
OK (0) if successful, otherwise a negative number error code from merrors.h.