wolfSSL/wolfssl
1
0
Fork 1
mirror of https://github.com/wolfSSL/wolfssl.git synced 2025-07-30 10:47:28 +02:00
Code Issues Packages Projects Releases Wiki Activity

Minor documentation cleanup

Browse Source 
Fixes two things across all the Doxygen:

1. Remove WOLFSSL_API from each definition
2. Add missing parameter names from functions
This commit is contained in:
Andrew Hutchings
2022-04-06 16:17:36 +01:00
parent 4f5aa81031
commit 5ea9d11295
52 changed files with 1040 additions and 1027 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
doc/dox_comments/header_files/aes.h
View File

@ -29,7 +29,7 @@
\sa wc_AesSetKeyDirect \sa wc_AesSetKeyDirect
\sa wc_AesSetIV \sa wc_AesSetIV
*/ */
WOLFSSL_API int wc_AesSetKey(Aes* aes, const byte* key, word32 len, int wc_AesSetKey(Aes* aes, const byte* key, word32 len,
const byte* iv, int dir); const byte* iv, int dir);
/*! /*!
@ -59,7 +59,7 @@ WOLFSSL_API int wc_AesSetKey(Aes* aes, const byte* key, word32 len,
\sa wc_AesSetKeyDirect \sa wc_AesSetKeyDirect
\sa wc_AesSetKey \sa wc_AesSetKey
*/ */
WOLFSSL_API int wc_AesSetIV(Aes* aes, const byte* iv); int wc_AesSetIV(Aes* aes, const byte* iv);
/*! /*!
\ingroup AES \ingroup AES
@ -107,7 +107,7 @@ WOLFSSL_API int wc_AesSetIV(Aes* aes, const byte* iv);
\sa wc_AesSetIV \sa wc_AesSetIV
\sa wc_AesCbcDecrypt \sa wc_AesCbcDecrypt
*/ */
WOLFSSL_API int wc_AesCbcEncrypt(Aes* aes, byte* out, int wc_AesCbcEncrypt(Aes* aes, byte* out,
const byte* in, word32 sz); const byte* in, word32 sz);
/*! /*!
@ -156,7 +156,7 @@ WOLFSSL_API int wc_AesCbcEncrypt(Aes* aes, byte* out,
\sa wc_AesSetKey \sa wc_AesSetKey
\sa wc_AesCbcEncrypt \sa wc_AesCbcEncrypt
*/ */
WOLFSSL_API int wc_AesCbcDecrypt(Aes* aes, byte* out, int wc_AesCbcDecrypt(Aes* aes, byte* out,
const byte* in, word32 sz); const byte* in, word32 sz);
/*! /*!
@ -201,7 +201,7 @@ WOLFSSL_API int wc_AesCbcDecrypt(Aes* aes, byte* out,
\sa wc_AesSetKey \sa wc_AesSetKey
*/ */
WOLFSSL_API int wc_AesCtrEncrypt(Aes* aes, byte* out, int wc_AesCtrEncrypt(Aes* aes, byte* out,
const byte* in, word32 sz); const byte* in, word32 sz);
/*! /*!
@ -235,7 +235,7 @@ WOLFSSL_API int wc_AesCtrEncrypt(Aes* aes, byte* out,
\sa wc_AesDecryptDirect \sa wc_AesDecryptDirect
\sa wc_AesSetKeyDirect \sa wc_AesSetKeyDirect
*/ */
WOLFSSL_API int wc_AesEncryptDirect(Aes* aes, byte* out, const byte* in); int wc_AesEncryptDirect(Aes* aes, byte* out, const byte* in);
/*! /*!
\ingroup AES \ingroup AES
@ -269,7 +269,7 @@ WOLFSSL_API int wc_AesEncryptDirect(Aes* aes, byte* out, const byte* in);
\sa wc_AesEncryptDirect \sa wc_AesEncryptDirect
\sa wc_AesSetKeyDirect \sa wc_AesSetKeyDirect
*/ */
WOLFSSL_API int wc_AesDecryptDirect(Aes* aes, byte* out, const byte* in); int wc_AesDecryptDirect(Aes* aes, byte* out, const byte* in);
/*! /*!
\ingroup AES \ingroup AES
@ -309,7 +309,7 @@ WOLFSSL_API int wc_AesDecryptDirect(Aes* aes, byte* out, const byte* in);
\sa wc_AesDecryptDirect \sa wc_AesDecryptDirect
\sa wc_AesSetKey \sa wc_AesSetKey
*/ */
WOLFSSL_API int wc_AesSetKeyDirect(Aes* aes, const byte* key, word32 len, int wc_AesSetKeyDirect(Aes* aes, const byte* key, word32 len,
const byte* iv, int dir); const byte* iv, int dir);
/*! /*!
@ -339,7 +339,7 @@ WOLFSSL_API int wc_AesSetKeyDirect(Aes* aes, const byte* key, word32 len,
\sa wc_AesGcmEncrypt \sa wc_AesGcmEncrypt
\sa wc_AesGcmDecrypt \sa wc_AesGcmDecrypt
*/ */
WOLFSSL_API int wc_AesGcmSetKey(Aes* aes, const byte* key, word32 len); int wc_AesGcmSetKey(Aes* aes, const byte* key, word32 len);
/*! /*!
\ingroup AES \ingroup AES
@ -384,7 +384,7 @@ WOLFSSL_API int wc_AesGcmSetKey(Aes* aes, const byte* key, word32 len);
\sa wc_AesGcmSetKey \sa wc_AesGcmSetKey
\sa wc_AesGcmDecrypt \sa wc_AesGcmDecrypt
*/ */
WOLFSSL_API int wc_AesGcmEncrypt(Aes* aes, byte* out, int wc_AesGcmEncrypt(Aes* aes, byte* out,
const byte* in, word32 sz, const byte* in, word32 sz,
const byte* iv, word32 ivSz, const byte* iv, word32 ivSz,
byte* authTag, word32 authTagSz, byte* authTag, word32 authTagSz,
@ -433,7 +433,7 @@ WOLFSSL_API int wc_AesGcmEncrypt(Aes* aes, byte* out,
\sa wc_AesGcmSetKey \sa wc_AesGcmSetKey
\sa wc_AesGcmEncrypt \sa wc_AesGcmEncrypt
*/ */
WOLFSSL_API int wc_AesGcmDecrypt(Aes* aes, byte* out, int wc_AesGcmDecrypt(Aes* aes, byte* out,
const byte* in, word32 sz, const byte* in, word32 sz,
const byte* iv, word32 ivSz, const byte* iv, word32 ivSz,
const byte* authTag, word32 authTagSz, const byte* authTag, word32 authTagSz,
@ -460,7 +460,7 @@ WOLFSSL_API int wc_AesGcmDecrypt(Aes* aes, byte* out,
\sa wc_GmacUpdate \sa wc_GmacUpdate
*/ */
WOLFSSL_API int wc_GmacSetKey(Gmac* gmac, const byte* key, word32 len); int wc_GmacSetKey(Gmac* gmac, const byte* key, word32 len);
/*! /*!
\ingroup AES \ingroup AES
@ -496,7 +496,7 @@ WOLFSSL_API int wc_GmacSetKey(Gmac* gmac, const byte* key, word32 len);
\sa wc_GmacSetKey \sa wc_GmacSetKey
*/ */
WOLFSSL_API int wc_GmacUpdate(Gmac* gmac, const byte* iv, word32 ivSz, int wc_GmacUpdate(Gmac* gmac, const byte* iv, word32 ivSz,
const byte* authIn, word32 authInSz, const byte* authIn, word32 authInSz,
byte* authTag, word32 authTagSz); byte* authTag, word32 authTagSz);
@ -523,7 +523,7 @@ WOLFSSL_API int wc_GmacUpdate(Gmac* gmac, const byte* iv, word32 ivSz,
\sa wc_AesCcmEncrypt \sa wc_AesCcmEncrypt
\sa wc_AesCcmDecrypt \sa wc_AesCcmDecrypt
*/ */
WOLFSSL_API int wc_AesCcmSetKey(Aes* aes, const byte* key, word32 keySz); int wc_AesCcmSetKey(Aes* aes, const byte* key, word32 keySz);
/*! /*!
\ingroup AES \ingroup AES
@ -568,7 +568,7 @@ WOLFSSL_API int wc_AesCcmSetKey(Aes* aes, const byte* key, word32 keySz);
\sa wc_AesCcmSetKey \sa wc_AesCcmSetKey
\sa wc_AesCcmDecrypt \sa wc_AesCcmDecrypt
*/ */
WOLFSSL_API int wc_AesCcmEncrypt(Aes* aes, byte* out, int wc_AesCcmEncrypt(Aes* aes, byte* out,
const byte* in, word32 inSz, const byte* in, word32 inSz,
const byte* nonce, word32 nonceSz, const byte* nonce, word32 nonceSz,
byte* authTag, word32 authTagSz, byte* authTag, word32 authTagSz,
@ -623,7 +623,7 @@ WOLFSSL_API int wc_AesCcmEncrypt(Aes* aes, byte* out,
\sa wc_AesCcmSetKey \sa wc_AesCcmSetKey
\sa wc_AesCcmEncrypt \sa wc_AesCcmEncrypt
*/ */
WOLFSSL_API int wc_AesCcmDecrypt(Aes* aes, byte* out, int wc_AesCcmDecrypt(Aes* aes, byte* out,
const byte* in, word32 inSz, const byte* in, word32 inSz,
const byte* nonce, word32 nonceSz, const byte* nonce, word32 nonceSz,
const byte* authTag, word32 authTagSz, const byte* authTag, word32 authTagSz,
@ -661,7 +661,7 @@ WOLFSSL_API int wc_AesCcmDecrypt(Aes* aes, byte* out,
\sa wc_AesXtsDecrypt \sa wc_AesXtsDecrypt
\sa wc_AesXtsFree \sa wc_AesXtsFree
*/ */
WOLFSSL_API int wc_AesXtsSetKey(XtsAes* aes, const byte* key, int wc_AesXtsSetKey(XtsAes* aes, const byte* key,
word32 len, int dir, void* heap, int devId); word32 len, int dir, void* heap, int devId);
/*! /*!
@ -700,7 +700,7 @@ WOLFSSL_API int wc_AesXtsSetKey(XtsAes* aes, const byte* key,
\sa wc_AesXtsSetKey \sa wc_AesXtsSetKey
\sa wc_AesXtsFree \sa wc_AesXtsFree
*/ */
WOLFSSL_API int wc_AesXtsEncryptSector(XtsAes* aes, byte* out, int wc_AesXtsEncryptSector(XtsAes* aes, byte* out,
const byte* in, word32 sz, word64 sector); const byte* in, word32 sz, word64 sector);
/*! /*!
@ -739,7 +739,7 @@ WOLFSSL_API int wc_AesXtsEncryptSector(XtsAes* aes, byte* out,
\sa wc_AesXtsSetKey \sa wc_AesXtsSetKey
\sa wc_AesXtsFree \sa wc_AesXtsFree
*/ */
WOLFSSL_API int wc_AesXtsDecryptSector(XtsAes* aes, byte* out, int wc_AesXtsDecryptSector(XtsAes* aes, byte* out,
const byte* in, word32 sz, word64 sector); const byte* in, word32 sz, word64 sector);
/*! /*!
@ -779,7 +779,7 @@ WOLFSSL_API int wc_AesXtsDecryptSector(XtsAes* aes, byte* out,
\sa wc_AesXtsSetKey \sa wc_AesXtsSetKey
\sa wc_AesXtsFree \sa wc_AesXtsFree
*/ */
WOLFSSL_API int wc_AesXtsEncrypt(XtsAes* aes, byte* out, int wc_AesXtsEncrypt(XtsAes* aes, byte* out,
const byte* in, word32 sz, const byte* i, word32 iSz); const byte* in, word32 sz, const byte* i, word32 iSz);
/*! /*!
@ -818,7 +818,7 @@ WOLFSSL_API int wc_AesXtsEncrypt(XtsAes* aes, byte* out,
\sa wc_AesXtsSetKey \sa wc_AesXtsSetKey
\sa wc_AesXtsFree \sa wc_AesXtsFree
*/ */
WOLFSSL_API int wc_AesXtsDecrypt(XtsAes* aes, byte* out, int wc_AesXtsDecrypt(XtsAes* aes, byte* out,
const byte* in, word32 sz, const byte* i, word32 iSz); const byte* in, word32 sz, const byte* i, word32 iSz);
/*! /*!
@ -845,7 +845,7 @@ WOLFSSL_API int wc_AesXtsDecrypt(XtsAes* aes, byte* out,
\sa wc_AesXtsDecrypt \sa wc_AesXtsDecrypt
\sa wc_AesXtsSetKey \sa wc_AesXtsSetKey
*/ */
WOLFSSL_API int wc_AesXtsFree(XtsAes* aes); int wc_AesXtsFree(XtsAes* aes);
/*! /*!
@ -872,7 +872,7 @@ WOLFSSL_API int wc_AesXtsFree(XtsAes* aes);
\sa wc_AesSetKey \sa wc_AesSetKey
\sa wc_AesSetIV \sa wc_AesSetIV
*/ */
WOLFSSL_API int wc_AesInit(Aes*, void*, int); int wc_AesInit(Aes* aes, void* heap, int devId);
/*! /*!
\ingroup AES \ingroup AES
@ -904,7 +904,7 @@ WOLFSSL_API int wc_AesInit(Aes*, void*, int);
\sa wc_AesCfbDecrypt \sa wc_AesCfbDecrypt
\sa wc_AesSetKey \sa wc_AesSetKey
*/ */
WOLFSSL_API int wc_AesCfbEncrypt(Aes* aes, byte* out, const byte* in, word32 sz); int wc_AesCfbEncrypt(Aes* aes, byte* out, const byte* in, word32 sz);
/*! /*!
\ingroup AES \ingroup AES
@ -936,7 +936,7 @@ WOLFSSL_API int wc_AesCfbEncrypt(Aes* aes, byte* out, const byte* in, word32 sz)
\sa wc_AesCfbEncrypt \sa wc_AesCfbEncrypt
\sa wc_AesSetKey \sa wc_AesSetKey
*/ */
WOLFSSL_API int wc_AesCfbDecrypt(Aes* aes, byte* out, const byte* in, word32 sz); int wc_AesCfbDecrypt(Aes* aes, byte* out, const byte* in, word32 sz);
/*! /*!
\ingroup AES \ingroup AES
@ -980,7 +980,7 @@ WOLFSSL_API int wc_AesCfbDecrypt(Aes* aes, byte* out, const byte* in, word32 sz)
\sa wc_AesSivDecrypt \sa wc_AesSivDecrypt
*/ */
WOLFSSL_API
int wc_AesSivEncrypt(const byte* key, word32 keySz, const byte* assoc, int wc_AesSivEncrypt(const byte* key, word32 keySz, const byte* assoc,
word32 assocSz, const byte* nonce, word32 nonceSz, word32 assocSz, const byte* nonce, word32 nonceSz,
const byte* in, word32 inSz, byte* siv, byte* out); const byte* in, word32 inSz, byte* siv, byte* out);
@ -1027,7 +1027,7 @@ int wc_AesSivEncrypt(const byte* key, word32 keySz, const byte* assoc,
\sa wc_AesSivEncrypt \sa wc_AesSivEncrypt
*/ */
WOLFSSL_API
int wc_AesSivDecrypt(const byte* key, word32 keySz, const byte* assoc, int wc_AesSivDecrypt(const byte* key, word32 keySz, const byte* assoc,
word32 assocSz, const byte* nonce, word32 nonceSz, word32 assocSz, const byte* nonce, word32 nonceSz,
const byte* in, word32 inSz, byte* siv, byte* out); const byte* in, word32 inSz, byte* siv, byte* out);

4
doc/dox_comments/header_files/arc4.h
View File

@ -32,7 +32,7 @@
\sa wc_Arc4SetKey \sa wc_Arc4SetKey
*/ */
WOLFSSL_API int wc_Arc4Process(Arc4*, byte*, const byte*, word32); int wc_Arc4Process(Arc4* arc4, byte* out, const byte* in, word32 length);
/*! /*!
\ingroup ARC4 \ingroup ARC4
@ -56,4 +56,4 @@ WOLFSSL_API int wc_Arc4Process(Arc4*, byte*, const byte*, word32);
\sa wc_Arc4Process \sa wc_Arc4Process
*/ */
WOLFSSL_API int wc_Arc4SetKey(Arc4*, const byte*, word32); int wc_Arc4SetKey(Arc4* arc4, const byte* key, word32 length);

114
doc/dox_comments/header_files/asn_public.h
View File

@ -19,7 +19,7 @@
\sa wc_MakeCert \sa wc_MakeCert
\sa wc_MakeCertReq \sa wc_MakeCertReq
*/ */
WOLFSSL_API int wc_InitCert(Cert*); int wc_InitCert(Cert*);
/*! /*!
\ingroup ASN \ingroup ASN
@ -64,8 +64,8 @@ WOLFSSL_API int wc_InitCert(Cert*);
\sa wc_InitCert \sa wc_InitCert
\sa wc_MakeCertReq \sa wc_MakeCertReq
*/ */
WOLFSSL_API int wc_MakeCert(Cert*, byte* derBuffer, word32 derSz, RsaKey*, int wc_MakeCert(Cert* cert, byte* derBuffer, word32 derSz, RsaKey* rsaKey,
ecc_key*, WC_RNG*); ecc_key* eccKey, WC_RNG* rng);
/*! /*!
\ingroup ASN \ingroup ASN
@ -111,8 +111,8 @@ WOLFSSL_API int wc_MakeCert(Cert*, byte* derBuffer, word32 derSz, RsaKey*,
\sa wc_InitCert \sa wc_InitCert
\sa wc_MakeCert \sa wc_MakeCert
*/ */
WOLFSSL_API int wc_MakeCertReq(Cert*, byte* derBuffer, word32 derSz, int wc_MakeCertReq(Cert* cert, byte* derBuffer, word32 derSz,
RsaKey*, ecc_key*); RsaKey* rsaKey, ecc_key* eccKey);
/*! /*!
\ingroup ASN \ingroup ASN
@ -164,8 +164,8 @@ WOLFSSL_API int wc_MakeCertReq(Cert*, byte* derBuffer, word32 derSz,
\sa wc_InitCert \sa wc_InitCert
\sa wc_MakeCert \sa wc_MakeCert
*/ */
WOLFSSL_API int wc_SignCert(int requestSz, int sigType, byte* derBuffer, int wc_SignCert(int requestSz, int sigType, byte* derBuffer,
word32 derSz, RsaKey*, ecc_key*, WC_RNG*); word32 derSz, RsaKey* rsaKey, ecc_key* eccKey, WC_RNG* rng);
/*! /*!
\ingroup ASN \ingroup ASN
@ -210,8 +210,8 @@ WOLFSSL_API int wc_SignCert(int requestSz, int sigType, byte* derBuffer,
\sa wc_MakeCert \sa wc_MakeCert
\sa wc_SignCert \sa wc_SignCert
*/ */
WOLFSSL_API int wc_MakeSelfCert(Cert*, byte* derBuffer, word32 derSz, RsaKey*, int wc_MakeSelfCert(Cert* cert, byte* derBuffer, word32 derSz, RsaKey* key,
WC_RNG*); WC_RNG* rng);
/*! /*!
\ingroup ASN \ingroup ASN
@ -272,7 +272,7 @@ WOLFSSL_API int wc_MakeSelfCert(Cert*, byte* derBuffer, word32 derSz, RsaKey*,
\sa wc_SetSubject \sa wc_SetSubject
\sa wc_SetIssuerBuffer \sa wc_SetIssuerBuffer
*/ */
WOLFSSL_API int wc_SetIssuer(Cert*, const char*); int wc_SetIssuer(Cert* cert, const char* issuerFile);
/*! /*!
\ingroup ASN \ingroup ASN
@ -329,7 +329,7 @@ WOLFSSL_API int wc_SetIssuer(Cert*, const char*);
\sa wc_InitCert \sa wc_InitCert
\sa wc_SetIssuer \sa wc_SetIssuer
*/ */
WOLFSSL_API int wc_SetSubject(Cert*, const char*); int wc_SetSubject(Cert* cert, const char* subjectFile);
/*! /*!
@ -394,7 +394,7 @@ WOLFSSL_API int wc_SetSubject(Cert*, const char*);
\sa wc_InitCert \sa wc_InitCert
\sa wc_SetSubject \sa wc_SetSubject
*/ */
WOLFSSL_API int wc_SetSubjectRaw(Cert* cert, const byte* der, int derSz); int wc_SetSubjectRaw(Cert* cert, const byte* der, int derSz);
/*! /*!
\ingroup ASN \ingroup ASN
@ -422,7 +422,7 @@ WOLFSSL_API int wc_SetSubjectRaw(Cert* cert, const byte* der, int derSz);
\sa wc_InitCert \sa wc_InitCert
\sa wc_SetSubjectRaw \sa wc_SetSubjectRaw
*/ */
WOLFSSL_API int wc_GetSubjectRaw(byte **subjectRaw, Cert *cert); int wc_GetSubjectRaw(byte **subjectRaw, Cert *cert);
/*! /*!
\ingroup ASN \ingroup ASN
@ -481,7 +481,7 @@ WOLFSSL_API int wc_GetSubjectRaw(byte **subjectRaw, Cert *cert);
\sa wc_InitCert \sa wc_InitCert
\sa wc_SetIssuer \sa wc_SetIssuer
*/ */
WOLFSSL_API int wc_SetAltNames(Cert*, const char*); int wc_SetAltNames(Cert* cert, const char* file);
/*! /*!
\ingroup ASN \ingroup ASN
@ -545,7 +545,7 @@ WOLFSSL_API int wc_SetAltNames(Cert*, const char*);
\sa wc_InitCert \sa wc_InitCert
\sa wc_SetIssuer \sa wc_SetIssuer
*/ */
WOLFSSL_API int wc_SetIssuerBuffer(Cert*, const byte*, int); int wc_SetIssuerBuffer(Cert* cert, const byte* der, int derSz);
/*! /*!
\ingroup ASN \ingroup ASN
@ -609,7 +609,7 @@ WOLFSSL_API int wc_SetIssuerBuffer(Cert*, const byte*, int);
\sa wc_InitCert \sa wc_InitCert
\sa wc_SetIssuer \sa wc_SetIssuer
*/ */
WOLFSSL_API int wc_SetIssuerRaw(Cert* cert, const byte* der, int derSz); int wc_SetIssuerRaw(Cert* cert, const byte* der, int derSz);
/*! /*!
\ingroup ASN \ingroup ASN
@ -672,7 +672,7 @@ WOLFSSL_API int wc_SetIssuerRaw(Cert* cert, const byte* der, int derSz);
\sa wc_InitCert \sa wc_InitCert
\sa wc_SetSubject \sa wc_SetSubject
*/ */
WOLFSSL_API int wc_SetSubjectBuffer(Cert*, const byte*, int); int wc_SetSubjectBuffer(Cert* cert, const byte* der, int derSz);
/*! /*!
\ingroup ASN \ingroup ASN
@ -738,7 +738,7 @@ WOLFSSL_API int wc_SetSubjectBuffer(Cert*, const byte*, int);
\sa wc_InitCert \sa wc_InitCert
\sa wc_SetAltNames \sa wc_SetAltNames
*/ */
WOLFSSL_API int wc_SetAltNamesBuffer(Cert*, const byte*, int); int wc_SetAltNamesBuffer(Cert* cert, const byte* der, int derSz);
/*! /*!
\ingroup ASN \ingroup ASN
@ -801,7 +801,7 @@ WOLFSSL_API int wc_SetAltNamesBuffer(Cert*, const byte*, int);
\sa wc_InitCert \sa wc_InitCert
*/ */
WOLFSSL_API int wc_SetDatesBuffer(Cert*, const byte*, int); int wc_SetDatesBuffer(Cert* cert, const byte* der, int derSz);
/*! /*!
\ingroup ASN \ingroup ASN
@ -835,7 +835,7 @@ WOLFSSL_API int wc_SetDatesBuffer(Cert*, const byte*, int);
\sa wc_SetAuthKeyId \sa wc_SetAuthKeyId
\sa wc_SetAuthKeyIdFromCert \sa wc_SetAuthKeyIdFromCert
*/ */
WOLFSSL_API int wc_SetAuthKeyIdFromPublicKey(Cert *cert, RsaKey *rsakey, int wc_SetAuthKeyIdFromPublicKey(Cert *cert, RsaKey *rsakey,
ecc_key *eckey); ecc_key *eckey);
/*! /*!
@ -866,7 +866,7 @@ WOLFSSL_API int wc_SetAuthKeyIdFromPublicKey(Cert *cert, RsaKey *rsakey,
\sa wc_SetAuthKeyIdFromPublicKey \sa wc_SetAuthKeyIdFromPublicKey
\sa wc_SetAuthKeyId \sa wc_SetAuthKeyId
*/ */
WOLFSSL_API int wc_SetAuthKeyIdFromCert(Cert *cert, const byte *der, int derSz); int wc_SetAuthKeyIdFromCert(Cert *cert, const byte *der, int derSz);
/*! /*!
\ingroup ASN \ingroup ASN
@ -895,7 +895,7 @@ WOLFSSL_API int wc_SetAuthKeyIdFromCert(Cert *cert, const byte *der, int derSz);
\sa wc_SetAuthKeyIdFromPublicKey \sa wc_SetAuthKeyIdFromPublicKey
\sa wc_SetAuthKeyIdFromCert \sa wc_SetAuthKeyIdFromCert
*/ */
WOLFSSL_API int wc_SetAuthKeyId(Cert *cert, const char* file); int wc_SetAuthKeyId(Cert *cert, const char* file);
/*! /*!
\ingroup ASN \ingroup ASN
@ -926,7 +926,7 @@ WOLFSSL_API int wc_SetAuthKeyId(Cert *cert, const char* file);
\sa wc_SetSubjectKeyId \sa wc_SetSubjectKeyId
*/ */
WOLFSSL_API int wc_SetSubjectKeyIdFromPublicKey(Cert *cert, RsaKey *rsakey, int wc_SetSubjectKeyIdFromPublicKey(Cert *cert, RsaKey *rsakey,
ecc_key *eckey); ecc_key *eckey);
/*! /*!
@ -957,7 +957,7 @@ WOLFSSL_API int wc_SetSubjectKeyIdFromPublicKey(Cert *cert, RsaKey *rsakey,
\sa wc_SetSubjectKeyIdFromPublicKey \sa wc_SetSubjectKeyIdFromPublicKey
*/ */
WOLFSSL_API int wc_SetSubjectKeyId(Cert *cert, const char* file); int wc_SetSubjectKeyId(Cert *cert, const char* file);
/*! /*!
\ingroup RSA \ingroup RSA
@ -991,7 +991,7 @@ WOLFSSL_API int wc_SetSubjectKeyId(Cert *cert, const char* file);
\sa wc_InitCert \sa wc_InitCert
\sa wc_MakeRsaKey \sa wc_MakeRsaKey
*/ */
WOLFSSL_API int wc_SetKeyUsage(Cert *cert, const char *value); int wc_SetKeyUsage(Cert *cert, const char *value);
/*! /*!
\ingroup ASN \ingroup ASN
@ -1021,7 +1021,7 @@ WOLFSSL_API int wc_SetKeyUsage(Cert *cert, const char *value);
\sa wc_PubKeyPemToDer \sa wc_PubKeyPemToDer
*/ */
WOLFSSL_API int wc_PemPubKeyToDer(const char* fileName, int wc_PemPubKeyToDer(const char* fileName,
unsigned char* derBuf, int derSz); unsigned char* derBuf, int derSz);
/*! /*!
@ -1053,8 +1053,8 @@ WOLFSSL_API int wc_PemPubKeyToDer(const char* fileName,
\sa wc_PemPubKeyToDer \sa wc_PemPubKeyToDer
*/ */
WOLFSSL_API int wc_PubKeyPemToDer(const unsigned char*, int, int wc_PubKeyPemToDer(const unsigned char* pem, int pemSz,
unsigned char*, int); unsigned char* buff, int buffSz);
/*! /*!
\ingroup ASN \ingroup ASN
@ -1088,7 +1088,7 @@ WOLFSSL_API int wc_PubKeyPemToDer(const unsigned char*, int,
\sa none \sa none
*/ */
WOLFSSL_API
int wc_PemCertToDer(const char* fileName, unsigned char* derBuf, int derSz); int wc_PemCertToDer(const char* fileName, unsigned char* derBuf, int derSz);
/*! /*!
@ -1131,7 +1131,7 @@ int wc_PemCertToDer(const char* fileName, unsigned char* derBuf, int derSz);
\sa wc_PemCertToDer \sa wc_PemCertToDer
*/ */
WOLFSSL_API int wc_DerToPem(const byte* der, word32 derSz, byte* output, int wc_DerToPem(const byte* der, word32 derSz, byte* output,
word32 outputSz, int type); word32 outputSz, int type);
/*! /*!
@ -1176,7 +1176,7 @@ WOLFSSL_API int wc_DerToPem(const byte* der, word32 derSz, byte* output,
\sa wc_PemCertToDer \sa wc_PemCertToDer
*/ */
WOLFSSL_API int wc_DerToPemEx(const byte* der, word32 derSz, byte* output, int wc_DerToPemEx(const byte* der, word32 derSz, byte* output,
word32 outputSz, byte *cipherIno, int type); word32 outputSz, byte *cipherIno, int type);
/*! /*!
@ -1214,8 +1214,8 @@ WOLFSSL_API int wc_DerToPemEx(const byte* der, word32 derSz, byte* output,
\sa wc_PemToDer \sa wc_PemToDer
*/ */
WOLFSSL_API int wc_KeyPemToDer(const unsigned char*, int, int wc_KeyPemToDer(const unsigned char* pem, int pemSz,
unsigned char*, int, const char*); unsigned char* buff, int buffSz, const char* pass);
/*! /*!
\ingroup CertsKeys \ingroup CertsKeys
@ -1246,8 +1246,8 @@ WOLFSSL_API int wc_KeyPemToDer(const unsigned char*, int,
\sa wc_PemToDer \sa wc_PemToDer
*/ */
WOLFSSL_API int wc_CertPemToDer(const unsigned char*, int, int wc_CertPemToDer(const unsigned char* pem, int pemSz,
unsigned char*, int, int); unsigned char* buff, int buffSz, int type);
/*! /*!
\ingroup CertsKeys \ingroup CertsKeys
@ -1269,7 +1269,7 @@ WOLFSSL_API int wc_CertPemToDer(const unsigned char*, int,
\sa wc_GetPubKeyDerFromCert \sa wc_GetPubKeyDerFromCert
*/ */
WOLFSSL_API int wc_GetPubKeyDerFromCert(struct DecodedCert* cert, int wc_GetPubKeyDerFromCert(struct DecodedCert* cert,
byte* derKey, word32* derKeySz); byte* derKey, word32* derKeySz);
/*! /*!
@ -1329,8 +1329,8 @@ WOLFSSL_API int wc_GetPubKeyDerFromCert(struct DecodedCert* cert,
\sa wc_RSA_PrivateKeyDecode \sa wc_RSA_PrivateKeyDecode
*/ */
WOLFSSL_API int wc_EccPrivateKeyDecode(const byte*, word32*, int wc_EccPrivateKeyDecode(const byte* input, word32* inOutIdx,
ecc_key*, word32); ecc_key* key, word32 inSz);
/*! /*!
\ingroup ASN \ingroup ASN
@ -1374,7 +1374,7 @@ WOLFSSL_API int wc_EccPrivateKeyDecode(const byte*, word32*,
\sa wc_RsaKeyToDer \sa wc_RsaKeyToDer
*/ */
WOLFSSL_API int wc_EccKeyToDer(ecc_key*, byte* output, word32 inLen); int wc_EccKeyToDer(ecc_key* key, byte* output, word32 inLen);
/*! /*!
\ingroup ASN \ingroup ASN
@ -1408,8 +1408,8 @@ WOLFSSL_API int wc_EccKeyToDer(ecc_key*, byte* output, word32 inLen);
\sa wc_ecc_import_x963 \sa wc_ecc_import_x963
*/ */
WOLFSSL_API int wc_EccPublicKeyDecode(const byte*, word32*, int wc_EccPublicKeyDecode(const byte* input, word32* inOutIdx,
ecc_key*, word32); ecc_key* key, word32 inSz);
/*! /*!
\ingroup ASN \ingroup ASN
@ -1449,7 +1449,7 @@ WOLFSSL_API int wc_EccPublicKeyDecode(const byte*, word32*,
\sa wc_EccKeyToDer \sa wc_EccKeyToDer
\sa wc_EccPrivateKeyDecode \sa wc_EccPrivateKeyDecode
*/ */
WOLFSSL_API int wc_EccPublicKeyToDer(ecc_key*, byte* output, int wc_EccPublicKeyToDer(ecc_key* key, byte* output,
word32 inLen, int with_AlgCurve); word32 inLen, int with_AlgCurve);
/*! /*!
@ -1485,7 +1485,7 @@ WOLFSSL_API int wc_EccPublicKeyToDer(ecc_key*, byte* output,
\sa none \sa none
*/ */
WOLFSSL_API word32 wc_EncodeSignature(byte* out, const byte* digest, word32 wc_EncodeSignature(byte* out, const byte* digest,
word32 digSz, int hashOID); word32 digSz, int hashOID);
/*! /*!
@ -1515,7 +1515,7 @@ WOLFSSL_API word32 wc_EncodeSignature(byte* out, const byte* digest,
\sa none \sa none
*/ */
WOLFSSL_API int wc_GetCTC_HashOID(int type); int wc_GetCTC_HashOID(int type);
/*! /*!
\ingroup ASN \ingroup ASN
@ -1546,7 +1546,7 @@ WOLFSSL_API int wc_GetCTC_HashOID(int type);
\sa wc_SetAltNamesBuffer \sa wc_SetAltNamesBuffer
\sa wc_SetDatesBuffer \sa wc_SetDatesBuffer
*/ */
WOLFSSL_API void wc_SetCert_Free(Cert* cert); void wc_SetCert_Free(Cert* cert);
/*! /*!
\ingroup ASN \ingroup ASN
@ -1578,7 +1578,7 @@ WOLFSSL_API void wc_SetCert_Free(Cert* cert);
\sa wc_DecryptPKCS8Key \sa wc_DecryptPKCS8Key
\sa wc_CreateEncryptedPKCS8Key \sa wc_CreateEncryptedPKCS8Key
*/ */
WOLFSSL_API int wc_GetPkcs8TraditionalOffset(byte* input, int wc_GetPkcs8TraditionalOffset(byte* input,
word32* inOutIdx, word32 sz); word32* inOutIdx, word32 sz);
/*! /*!
@ -1629,7 +1629,7 @@ WOLFSSL_API int wc_GetPkcs8TraditionalOffset(byte* input,
\sa wc_DecryptPKCS8Key \sa wc_DecryptPKCS8Key
\sa wc_CreateEncryptedPKCS8Key \sa wc_CreateEncryptedPKCS8Key
*/ */
WOLFSSL_API int wc_CreatePKCS8Key(byte* out, word32* outSz, int wc_CreatePKCS8Key(byte* out, word32* outSz,
byte* key, word32 keySz, int algoID, const byte* curveOID, byte* key, word32 keySz, int algoID, const byte* curveOID,
word32 oidSz); word32 oidSz);
@ -1690,7 +1690,7 @@ WOLFSSL_API int wc_CreatePKCS8Key(byte* out, word32* outSz,
\sa wc_DecryptPKCS8Key \sa wc_DecryptPKCS8Key
\sa wc_CreateEncryptedPKCS8Key \sa wc_CreateEncryptedPKCS8Key
*/ */
WOLFSSL_API int wc_EncryptPKCS8Key(byte* key, word32 keySz, byte* out, int wc_EncryptPKCS8Key(byte* key, word32 keySz, byte* out,
word32* outSz, const char* password, int passwordSz, int vPKCS, word32* outSz, const char* password, int passwordSz, int vPKCS,
int pbeOid, int encAlgId, byte* salt, word32 saltSz, int itt, int pbeOid, int encAlgId, byte* salt, word32 saltSz, int itt,
WC_RNG* rng, void* heap); WC_RNG* rng, void* heap);
@ -1727,7 +1727,7 @@ WOLFSSL_API int wc_EncryptPKCS8Key(byte* key, word32 keySz, byte* out,
\sa wc_EncryptPKCS8Key \sa wc_EncryptPKCS8Key
\sa wc_CreateEncryptedPKCS8Key \sa wc_CreateEncryptedPKCS8Key
*/ */
WOLFSSL_API int wc_DecryptPKCS8Key(byte* input, word32 sz, const char* password, int wc_DecryptPKCS8Key(byte* input, word32 sz, const char* password,
int passwordSz); int passwordSz);
/*! /*!
@ -1786,7 +1786,7 @@ WOLFSSL_API int wc_DecryptPKCS8Key(byte* input, word32 sz, const char* password,
\sa wc_EncryptPKCS8Key \sa wc_EncryptPKCS8Key
\sa wc_DecryptPKCS8Key \sa wc_DecryptPKCS8Key
*/ */
WOLFSSL_API int wc_CreateEncryptedPKCS8Key(byte* key, word32 keySz, byte* out, int wc_CreateEncryptedPKCS8Key(byte* key, word32 keySz, byte* out,
word32* outSz, const char* password, int passwordSz, int vPKCS, word32* outSz, const char* password, int passwordSz, int vPKCS,
int pbeOid, int encAlgId, byte* salt, word32 saltSz, int itt, int pbeOid, int encAlgId, byte* salt, word32 saltSz, int itt,
WC_RNG* rng, void* heap); WC_RNG* rng, void* heap);
@ -1816,7 +1816,7 @@ WOLFSSL_API int wc_CreateEncryptedPKCS8Key(byte* key, word32 keySz, byte* out,
\sa wc_ParseCert \sa wc_ParseCert
\sa wc_FreeDecodedCert \sa wc_FreeDecodedCert
*/ */
WOLFSSL_API void wc_InitDecodedCert(struct DecodedCert* cert, void wc_InitDecodedCert(struct DecodedCert* cert,
const byte* source, word32 inSz, void* heap); const byte* source, word32 inSz, void* heap);
/*! /*!
@ -1855,7 +1855,7 @@ WOLFSSL_API void wc_InitDecodedCert(struct DecodedCert* cert,
\sa wc_InitDecodedCert \sa wc_InitDecodedCert
\sa wc_FreeDecodedCert \sa wc_FreeDecodedCert
*/ */
WOLFSSL_API int wc_ParseCert(DecodedCert* cert, int type, int verify, void* cm); int wc_ParseCert(DecodedCert* cert, int type, int verify, void* cm);
/*! /*!
\ingroup ASN \ingroup ASN
@ -1883,7 +1883,7 @@ WOLFSSL_API int wc_ParseCert(DecodedCert* cert, int type, int verify, void* cm);
\sa wc_InitDecodedCert \sa wc_InitDecodedCert
\sa wc_ParseCert \sa wc_ParseCert
*/ */
WOLFSSL_API void wc_FreeDecodedCert(struct DecodedCert* cert); void wc_FreeDecodedCert(struct DecodedCert* cert);
/*! /*!
\ingroup ASN \ingroup ASN
@ -1914,7 +1914,7 @@ WOLFSSL_API void wc_FreeDecodedCert(struct DecodedCert* cert);
\sa wc_Time \sa wc_Time
*/ */
WOLFSSL_API int wc_SetTimeCb(wc_time_cb f); int wc_SetTimeCb(wc_time_cb f);
/*! /*!
\ingroup ASN \ingroup ASN
@ -1936,7 +1936,7 @@ WOLFSSL_API int wc_SetTimeCb(wc_time_cb f);
\sa wc_SetTimeCb \sa wc_SetTimeCb
*/ */
WOLFSSL_API time_t wc_Time(time_t* t); time_t wc_Time(time_t* t);
/*! /*!
\ingroup ASN \ingroup ASN
@ -1981,7 +1981,7 @@ WOLFSSL_API time_t wc_Time(time_t* t);
\sa wc_InitCert \sa wc_InitCert
\sa wc_SetUnknownExtCallback \sa wc_SetUnknownExtCallback
*/ */
WOLFSSL_API int wc_SetCustomExtension(Cert *cert, int critical, const char *oid, int wc_SetCustomExtension(Cert *cert, int critical, const char *oid,
const byte *der, word32 derSz); const byte *der, word32 derSz);
/*! /*!
@ -2055,7 +2055,7 @@ WOLFSSL_ASN_API int wc_SetUnknownExtCallback(DecodedCert* cert,
\param pubKeyOID OID identifying the algorithm of the public key. \param pubKeyOID OID identifying the algorithm of the public key.
(ie: ECDSAk, DSAk or RSAk) (ie: ECDSAk, DSAk or RSAk)
WOLFSSL_API int wc_CheckCertSigPubKey(const byte* cert, word32 certSz, int wc_CheckCertSigPubKey(const byte* cert, word32 certSz,
void* heap, const byte* pubKey, void* heap, const byte* pubKey,
word32 pubKeySz, int pubKeyOID); word32 pubKeySz, int pubKeyOID);
*/ */

6
doc/dox_comments/header_files/blake2.h
View File

@ -19,7 +19,7 @@
\sa wc_Blake2bUpdate \sa wc_Blake2bUpdate
*/ */
WOLFSSL_API int wc_InitBlake2b(Blake2b*, word32); int wc_InitBlake2b(Blake2b* b2b, word32 digestSz);
/*! /*!
\ingroup BLAKE2 \ingroup BLAKE2
@ -54,7 +54,7 @@ WOLFSSL_API int wc_InitBlake2b(Blake2b*, word32);
\sa wc_InitBlake2b \sa wc_InitBlake2b
\sa wc_Blake2bFinal \sa wc_Blake2bFinal
*/ */
WOLFSSL_API int wc_Blake2bUpdate(Blake2b*, const byte*, word32); int wc_Blake2bUpdate(Blake2b* b2b, const byte* data, word32 sz);
/*! /*!
\ingroup BLAKE2 \ingroup BLAKE2
@ -92,4 +92,4 @@ WOLFSSL_API int wc_Blake2bUpdate(Blake2b*, const byte*, word32);
\sa wc_InitBlake2b \sa wc_InitBlake2b
\sa wc_Blake2bUpdate \sa wc_Blake2bUpdate
*/ */
WOLFSSL_API int wc_Blake2bFinal(Blake2b*, byte*, word32); int wc_Blake2bFinal(Blake2b* b2b, byte* final, word32 requestSz);

2
doc/dox_comments/header_files/bn.h
View File

@ -24,5 +24,5 @@
\sa wolfSSL_BN_new \sa wolfSSL_BN_new
\sa wolfSSL_BN_free \sa wolfSSL_BN_free
*/ */
WOLFSSL_API int wolfSSL_BN_mod_exp(WOLFSSL_BIGNUM *r, const WOLFSSL_BIGNUM *a, int wolfSSL_BN_mod_exp(WOLFSSL_BIGNUM *r, const WOLFSSL_BIGNUM *a,
const WOLFSSL_BIGNUM *p, const WOLFSSL_BIGNUM *m, WOLFSSL_BN_CTX *ctx); const WOLFSSL_BIGNUM *p, const WOLFSSL_BIGNUM *m, WOLFSSL_BN_CTX *ctx);

12
doc/dox_comments/header_files/camellia.h
View File

@ -35,7 +35,7 @@
\sa wc_CamelliaCbcEncrypt \sa wc_CamelliaCbcEncrypt
\sa wc_CamelliaCbcDecrypt \sa wc_CamelliaCbcDecrypt
*/ */
WOLFSSL_API int wc_CamelliaSetKey(Camellia* cam, int wc_CamelliaSetKey(Camellia* cam,
const byte* key, word32 len, const byte* iv); const byte* key, word32 len, const byte* iv);
/*! /*!
@ -64,7 +64,7 @@ WOLFSSL_API int wc_CamelliaSetKey(Camellia* cam,
\sa wc_CamelliaSetKey \sa wc_CamelliaSetKey
*/ */
WOLFSSL_API int wc_CamelliaSetIV(Camellia* cam, const byte* iv); int wc_CamelliaSetIV(Camellia* cam, const byte* iv);
/*! /*!
\ingroup Camellia \ingroup Camellia
@ -92,7 +92,7 @@ WOLFSSL_API int wc_CamelliaSetIV(Camellia* cam, const byte* iv);
\sa wc_CamelliaDecryptDirect \sa wc_CamelliaDecryptDirect
*/ */
WOLFSSL_API int wc_CamelliaEncryptDirect(Camellia* cam, byte* out, int wc_CamelliaEncryptDirect(Camellia* cam, byte* out,
const byte* in); const byte* in);
/*! /*!
@ -122,7 +122,7 @@ WOLFSSL_API int wc_CamelliaEncryptDirect(Camellia* cam, byte* out,
\sa wc_CamelliaEncryptDirect \sa wc_CamelliaEncryptDirect
*/ */
WOLFSSL_API int wc_CamelliaDecryptDirect(Camellia* cam, byte* out, int wc_CamelliaDecryptDirect(Camellia* cam, byte* out,
const byte* in); const byte* in);
/*! /*!
@ -151,7 +151,7 @@ WOLFSSL_API int wc_CamelliaDecryptDirect(Camellia* cam, byte* out,
\sa wc_CamelliaCbcDecrypt \sa wc_CamelliaCbcDecrypt
*/ */
WOLFSSL_API int wc_CamelliaCbcEncrypt(Camellia* cam, int wc_CamelliaCbcEncrypt(Camellia* cam,
byte* out, const byte* in, word32 sz); byte* out, const byte* in, word32 sz);
/*! /*!
@ -180,5 +180,5 @@ WOLFSSL_API int wc_CamelliaCbcEncrypt(Camellia* cam,
\sa wc_CamelliaCbcEncrypt \sa wc_CamelliaCbcEncrypt
*/ */
WOLFSSL_API int wc_CamelliaCbcDecrypt(Camellia* cam, int wc_CamelliaCbcDecrypt(Camellia* cam,
byte* out, const byte* in, word32 sz); byte* out, const byte* in, word32 sz);

6
doc/dox_comments/header_files/chacha.h
View File

@ -30,7 +30,7 @@
\sa wc_Chacha_SetKey \sa wc_Chacha_SetKey
\sa wc_Chacha_Process \sa wc_Chacha_Process
*/ */
WOLFSSL_API int wc_Chacha_SetIV(ChaCha* ctx, const byte* inIv, word32 counter); int wc_Chacha_SetIV(ChaCha* ctx, const byte* inIv, word32 counter);
/*! /*!
\ingroup ChaCha \ingroup ChaCha
@ -64,7 +64,7 @@ WOLFSSL_API int wc_Chacha_SetIV(ChaCha* ctx, const byte* inIv, word32 counter);
\sa wc_Chacha_SetKey \sa wc_Chacha_SetKey
\sa wc_Chacha_Process \sa wc_Chacha_Process
*/ */
WOLFSSL_API int wc_Chacha_Process(ChaCha* ctx, byte* cipher, const byte* plain, int wc_Chacha_Process(ChaCha* ctx, byte* cipher, const byte* plain,
word32 msglen); word32 msglen);
/*! /*!
@ -96,4 +96,4 @@ WOLFSSL_API int wc_Chacha_Process(ChaCha* ctx, byte* cipher, const byte* plain,
\sa wc_Chacha_SetIV \sa wc_Chacha_SetIV
\sa wc_Chacha_Process \sa wc_Chacha_Process
*/ */
WOLFSSL_API int wc_Chacha_SetKey(ChaCha* ctx, const byte* key, word32 keySz); int wc_Chacha_SetKey(ChaCha* ctx, const byte* key, word32 keySz);

4
doc/dox_comments/header_files/chacha20_poly1305.h
View File

@ -46,7 +46,7 @@
\sa wc_ChaCha_* \sa wc_ChaCha_*
\sa wc_Poly1305* \sa wc_Poly1305*
*/ */
WOLFSSL_API
int wc_ChaCha20Poly1305_Encrypt( int wc_ChaCha20Poly1305_Encrypt(
const byte inKey[CHACHA20_POLY1305_AEAD_KEYSIZE], const byte inKey[CHACHA20_POLY1305_AEAD_KEYSIZE],
const byte inIV[CHACHA20_POLY1305_AEAD_IV_SIZE], const byte inIV[CHACHA20_POLY1305_AEAD_IV_SIZE],
@ -110,7 +110,7 @@ int wc_ChaCha20Poly1305_Encrypt(
\sa wc_ChaCha_* \sa wc_ChaCha_*
\sa wc_Poly1305* \sa wc_Poly1305*
*/ */
WOLFSSL_API
int wc_ChaCha20Poly1305_Decrypt( int wc_ChaCha20Poly1305_Decrypt(
const byte inKey[CHACHA20_POLY1305_AEAD_KEYSIZE], const byte inKey[CHACHA20_POLY1305_AEAD_KEYSIZE],
const byte inIV[CHACHA20_POLY1305_AEAD_IV_SIZE], const byte inIV[CHACHA20_POLY1305_AEAD_IV_SIZE],

10
doc/dox_comments/header_files/coding.h
View File

@ -35,7 +35,7 @@
\sa Base64_Encode \sa Base64_Encode
\sa Base16_Decode \sa Base16_Decode
*/ */
WOLFSSL_API int Base64_Decode(const byte* in, word32 inLen, byte* out, int Base64_Decode(const byte* in, word32 inLen, byte* out,
word32* outLen); word32* outLen);
/*! /*!
@ -75,7 +75,7 @@ WOLFSSL_API int Base64_Decode(const byte* in, word32 inLen, byte* out,
\sa Base64_EncodeEsc \sa Base64_EncodeEsc
\sa Base64_Decode \sa Base64_Decode
*/ */
WOLFSSL_API
int Base64_Encode(const byte* in, word32 inLen, byte* out, int Base64_Encode(const byte* in, word32 inLen, byte* out,
word32* outLen); word32* outLen);
@ -157,7 +157,7 @@ int Base64_EncodeEsc(const byte* in, word32 inLen, byte* out,
\sa Base64_Encode \sa Base64_Encode
\sa Base64_Decode \sa Base64_Decode
*/ */
WOLFSSL_API
int Base64_Encode_NoNl(const byte* in, word32 inLen, byte* out, int Base64_Encode_NoNl(const byte* in, word32 inLen, byte* out,
word32* outLen); word32* outLen);
@ -196,7 +196,7 @@ int Base64_Encode_NoNl(const byte* in, word32 inLen, byte* out,
\sa Base64_Decode \sa Base64_Decode
\sa Base16_Encode \sa Base16_Encode
*/ */
WOLFSSL_API
int Base16_Decode(const byte* in, word32 inLen, byte* out, word32* outLen); int Base16_Decode(const byte* in, word32 inLen, byte* out, word32* outLen);
/*! /*!
@ -229,5 +229,5 @@ int Base16_Decode(const byte* in, word32 inLen, byte* out, word32* outLen);
\sa Base64_Decode \sa Base64_Decode
\sa Base16_Decode \sa Base16_Decode
*/ */
WOLFSSL_API
int Base16_Encode(const byte* in, word32 inLen, byte* out, word32* outLen); int Base16_Encode(const byte* in, word32 inLen, byte* out, word32* outLen);

4
doc/dox_comments/header_files/compress.h
View File

@ -36,7 +36,7 @@
\sa wc_DeCompress \sa wc_DeCompress
*/ */
WOLFSSL_API int wc_Compress(byte*, word32, const byte*, word32, word32); int wc_Compress(byte* out, word32 outSz, const byte* in, word32 inSz, word32 flags);
/*! /*!
\ingroup Compression \ingroup Compression
@ -69,4 +69,4 @@ WOLFSSL_API int wc_Compress(byte*, word32, const byte*, word32, word32);
\sa wc_Compress \sa wc_Compress
*/ */
WOLFSSL_API int wc_DeCompress(byte*, word32, const byte*, word32); int wc_DeCompress(byte* out, word32 outSz, const byte* in, word32 inSz);

4
doc/dox_comments/header_files/cryptocb.h
View File

@ -85,7 +85,7 @@
\sa wolfSSL_SetDevId \sa wolfSSL_SetDevId
\sa wolfSSL_CTX_SetDevId \sa wolfSSL_CTX_SetDevId
*/ */
WOLFSSL_API int wc_CryptoCb_RegisterDevice(int devId, CryptoDevCallbackFunc cb, void* ctx); int wc_CryptoCb_RegisterDevice(int devId, CryptoDevCallbackFunc cb, void* ctx);
/*! /*!
\ingroup CryptoCb \ingroup CryptoCb
@ -108,4 +108,4 @@ WOLFSSL_API int wc_CryptoCb_RegisterDevice(int devId, CryptoDevCallbackFunc cb,
\sa wolfSSL_SetDevId \sa wolfSSL_SetDevId
\sa wolfSSL_CTX_SetDevId \sa wolfSSL_CTX_SetDevId
*/ */
WOLFSSL_API void wc_CryptoCb_UnRegisterDevice(int devId); void wc_CryptoCb_UnRegisterDevice(int devId);

38
doc/dox_comments/header_files/curve25519.h
View File

@ -38,7 +38,7 @@
\sa wc_curve25519_init \sa wc_curve25519_init
*/ */
WOLFSSL_API
int wc_curve25519_make_key(WC_RNG* rng, int keysize, curve25519_key* key); int wc_curve25519_make_key(WC_RNG* rng, int keysize, curve25519_key* key);
/*! /*!
@ -83,7 +83,7 @@ int wc_curve25519_make_key(WC_RNG* rng, int keysize, curve25519_key* key);
\sa wc_curve25519_make_key \sa wc_curve25519_make_key
\sa wc_curve25519_shared_secret_ex \sa wc_curve25519_shared_secret_ex
*/ */
WOLFSSL_API
int wc_curve25519_shared_secret(curve25519_key* private_key, int wc_curve25519_shared_secret(curve25519_key* private_key,
curve25519_key* public_key, curve25519_key* public_key,
byte* out, word32* outlen); byte* out, word32* outlen);
@ -134,7 +134,7 @@ int wc_curve25519_shared_secret(curve25519_key* private_key,
\sa wc_curve25519_make_key \sa wc_curve25519_make_key
\sa wc_curve25519_shared_secret \sa wc_curve25519_shared_secret
*/ */
WOLFSSL_API
int wc_curve25519_shared_secret_ex(curve25519_key* private_key, int wc_curve25519_shared_secret_ex(curve25519_key* private_key,
curve25519_key* public_key, curve25519_key* public_key,
byte* out, word32* outlen, int endian); byte* out, word32* outlen, int endian);
@ -160,7 +160,7 @@ int wc_curve25519_shared_secret_ex(curve25519_key* private_key,
\sa wc_curve25519_make_key \sa wc_curve25519_make_key
*/ */
WOLFSSL_API
int wc_curve25519_init(curve25519_key* key); int wc_curve25519_init(curve25519_key* key);
/*! /*!
@ -180,7 +180,7 @@ int wc_curve25519_init(curve25519_key* key);
\sa wc_curve25519_init \sa wc_curve25519_init
\sa wc_curve25519_make_key \sa wc_curve25519_make_key
*/ */
WOLFSSL_API
void wc_curve25519_free(curve25519_key* key); void wc_curve25519_free(curve25519_key* key);
/*! /*!
@ -214,7 +214,7 @@ void wc_curve25519_free(curve25519_key* key);
\sa wc_curve25519_import_private_ex \sa wc_curve25519_import_private_ex
\sa wc_curve25519_size \sa wc_curve25519_size
*/ */
WOLFSSL_API
int wc_curve25519_import_private(const byte* priv, word32 privSz, int wc_curve25519_import_private(const byte* priv, word32 privSz,
curve25519_key* key); curve25519_key* key);
@ -253,7 +253,7 @@ int wc_curve25519_import_private(const byte* priv, word32 privSz,
\sa wc_curve25519_import_private \sa wc_curve25519_import_private
\sa wc_curve25519_size \sa wc_curve25519_size
*/ */
WOLFSSL_API
int wc_curve25519_import_private_ex(const byte* priv, word32 privSz, int wc_curve25519_import_private_ex(const byte* priv, word32 privSz,
curve25519_key* key, int endian); curve25519_key* key, int endian);
@ -299,7 +299,7 @@ int wc_curve25519_import_private_ex(const byte* priv, word32 privSz,
\sa wc_curve25519_import_public \sa wc_curve25519_import_public
\sa wc_curve25519_export_private_raw \sa wc_curve25519_export_private_raw
*/ */
WOLFSSL_API
int wc_curve25519_import_private_raw(const byte* priv, word32 privSz, int wc_curve25519_import_private_raw(const byte* priv, word32 privSz,
const byte* pub, word32 pubSz, curve25519_key* key); const byte* pub, word32 pubSz, curve25519_key* key);
@ -346,7 +346,7 @@ int wc_curve25519_import_private_raw(const byte* priv, word32 privSz,
\sa wc_curve25519_export_private_raw \sa wc_curve25519_export_private_raw
\sa wc_curve25519_import_private_raw \sa wc_curve25519_import_private_raw
*/ */
WOLFSSL_API
int wc_curve25519_import_private_raw_ex(const byte* priv, word32 privSz, int wc_curve25519_import_private_raw_ex(const byte* priv, word32 privSz,
const byte* pub, word32 pubSz, const byte* pub, word32 pubSz,
curve25519_key* key, int endian); curve25519_key* key, int endian);
@ -388,7 +388,7 @@ int wc_curve25519_import_private_raw_ex(const byte* priv, word32 privSz,
\sa wc_curve25519_import_private_raw \sa wc_curve25519_import_private_raw
\sa wc_curve25519_export_private_raw_ex \sa wc_curve25519_export_private_raw_ex
*/ */
WOLFSSL_API
int wc_curve25519_export_private_raw(curve25519_key* key, byte* out, int wc_curve25519_export_private_raw(curve25519_key* key, byte* out,
word32* outLen); word32* outLen);
@ -432,7 +432,7 @@ int wc_curve25519_export_private_raw(curve25519_key* key, byte* out,
\sa wc_curve25519_export_private_raw \sa wc_curve25519_export_private_raw
\sa wc_curve25519_size \sa wc_curve25519_size
*/ */
WOLFSSL_API
int wc_curve25519_export_private_raw_ex(curve25519_key* key, byte* out, int wc_curve25519_export_private_raw_ex(curve25519_key* key, byte* out,
word32* outLen, int endian); word32* outLen, int endian);
@ -476,7 +476,7 @@ int wc_curve25519_export_private_raw_ex(curve25519_key* key, byte* out,
\sa wc_curve25519_check_public \sa wc_curve25519_check_public
\sa wc_curve25519_size \sa wc_curve25519_size
*/ */
WOLFSSL_API
int wc_curve25519_import_public(const byte* in, word32 inLen, int wc_curve25519_import_public(const byte* in, word32 inLen,
curve25519_key* key); curve25519_key* key);
@ -522,7 +522,7 @@ int wc_curve25519_import_public(const byte* in, word32 inLen,
\sa wc_curve25519_check_public \sa wc_curve25519_check_public
\sa wc_curve25519_size \sa wc_curve25519_size
*/ */
WOLFSSL_API
int wc_curve25519_import_public_ex(const byte* in, word32 inLen, int wc_curve25519_import_public_ex(const byte* in, word32 inLen,
curve25519_key* key, int endian); curve25519_key* key, int endian);
@ -558,7 +558,7 @@ int wc_curve25519_import_public_ex(const byte* in, word32 inLen,
\sa wc_curve25519_import_public_ex \sa wc_curve25519_import_public_ex
\sa wc_curve25519_size \sa wc_curve25519_size
*/ */
WOLFSSL_API
int wc_curve25519_check_public(const byte* pub, word32 pubSz, int endian); int wc_curve25519_check_public(const byte* pub, word32 pubSz, int endian);
/*! /*!
@ -598,7 +598,7 @@ int wc_curve25519_check_public(const byte* pub, word32 pubSz, int endian);
\sa wc_curve25519_export_private_raw \sa wc_curve25519_export_private_raw
\sa wc_curve25519_import_public \sa wc_curve25519_import_public
*/ */
WOLFSSL_API
int wc_curve25519_export_public(curve25519_key* key, byte* out, word32* outLen); int wc_curve25519_export_public(curve25519_key* key, byte* out, word32* outLen);
/*! /*!
@ -641,7 +641,7 @@ int wc_curve25519_export_public(curve25519_key* key, byte* out, word32* outLen);
\sa wc_curve25519_export_private_raw \sa wc_curve25519_export_private_raw
\sa wc_curve25519_import_public \sa wc_curve25519_import_public
*/ */
WOLFSSL_API
int wc_curve25519_export_public_ex(curve25519_key* key, byte* out, int wc_curve25519_export_public_ex(curve25519_key* key, byte* out,
word32* outLen, int endian); word32* outLen, int endian);
@ -686,7 +686,7 @@ int wc_curve25519_export_public_ex(curve25519_key* key, byte* out,
\sa wc_curve25519_export_key_raw_ex \sa wc_curve25519_export_key_raw_ex
\sa wc_curve25519_export_private_raw \sa wc_curve25519_export_private_raw
*/ */
WOLFSSL_API
int wc_curve25519_export_key_raw(curve25519_key* key, int wc_curve25519_export_key_raw(curve25519_key* key,
byte* priv, word32 *privSz, byte* priv, word32 *privSz,
byte* pub, word32 *pubSz); byte* pub, word32 *pubSz);
@ -736,7 +736,7 @@ int wc_curve25519_export_key_raw(curve25519_key* key,
\sa wc_curve25519_export_private_raw_ex \sa wc_curve25519_export_private_raw_ex
\sa wc_curve25519_export_public_ex \sa wc_curve25519_export_public_ex
*/ */
WOLFSSL_API
int wc_curve25519_export_key_raw_ex(curve25519_key* key, int wc_curve25519_export_key_raw_ex(curve25519_key* key,
byte* priv, word32 *privSz, byte* priv, word32 *privSz,
byte* pub, word32 *pubSz, byte* pub, word32 *pubSz,
@ -767,5 +767,5 @@ int wc_curve25519_export_key_raw_ex(curve25519_key* key,
\sa wc_curve25519_init \sa wc_curve25519_init
\sa wc_curve25519_make_key \sa wc_curve25519_make_key
*/ */
WOLFSSL_API
int wc_curve25519_size(curve25519_key* key); int wc_curve25519_size(curve25519_key* key);

38
doc/dox_comments/header_files/curve448.h
View File

@ -38,7 +38,7 @@
\sa wc_curve448_init \sa wc_curve448_init
*/ */
WOLFSSL_API
int wc_curve448_make_key(WC_RNG* rng, int keysize, curve448_key* key); int wc_curve448_make_key(WC_RNG* rng, int keysize, curve448_key* key);
/*! /*!
@ -81,7 +81,7 @@ int wc_curve448_make_key(WC_RNG* rng, int keysize, curve448_key* key);
\sa wc_curve448_make_key \sa wc_curve448_make_key
\sa wc_curve448_shared_secret_ex \sa wc_curve448_shared_secret_ex
*/ */
WOLFSSL_API
int wc_curve448_shared_secret(curve448_key* private_key, int wc_curve448_shared_secret(curve448_key* private_key,
curve448_key* public_key, curve448_key* public_key,
byte* out, word32* outlen); byte* out, word32* outlen);
@ -130,7 +130,7 @@ int wc_curve448_shared_secret(curve448_key* private_key,
\sa wc_curve448_make_key \sa wc_curve448_make_key
\sa wc_curve448_shared_secret \sa wc_curve448_shared_secret
*/ */
WOLFSSL_API
int wc_curve448_shared_secret_ex(curve448_key* private_key, int wc_curve448_shared_secret_ex(curve448_key* private_key,
curve448_key* public_key, curve448_key* public_key,
byte* out, word32* outlen, int endian); byte* out, word32* outlen, int endian);
@ -155,7 +155,7 @@ int wc_curve448_shared_secret_ex(curve448_key* private_key,
\sa wc_curve448_make_key \sa wc_curve448_make_key
*/ */
WOLFSSL_API
int wc_curve448_init(curve448_key* key); int wc_curve448_init(curve448_key* key);
/*! /*!
@ -175,7 +175,7 @@ int wc_curve448_init(curve448_key* key);
\sa wc_curve448_init \sa wc_curve448_init
\sa wc_curve448_make_key \sa wc_curve448_make_key
*/ */
WOLFSSL_API
void wc_curve448_free(curve448_key* key); void wc_curve448_free(curve448_key* key);
/*! /*!
@ -209,7 +209,7 @@ void wc_curve448_free(curve448_key* key);
\sa wc_curve448_import_private_ex \sa wc_curve448_import_private_ex
\sa wc_curve448_size \sa wc_curve448_size
*/ */
WOLFSSL_API
int wc_curve448_import_private(const byte* priv, word32 privSz, int wc_curve448_import_private(const byte* priv, word32 privSz,
curve448_key* key); curve448_key* key);
@ -248,7 +248,7 @@ int wc_curve448_import_private(const byte* priv, word32 privSz,
\sa wc_curve448_import_private \sa wc_curve448_import_private
\sa wc_curve448_size \sa wc_curve448_size
*/ */
WOLFSSL_API
int wc_curve448_import_private_ex(const byte* priv, word32 privSz, int wc_curve448_import_private_ex(const byte* priv, word32 privSz,
curve448_key* key, int endian); curve448_key* key, int endian);
@ -294,7 +294,7 @@ int wc_curve448_import_private_ex(const byte* priv, word32 privSz,
\sa wc_curve448_import_public \sa wc_curve448_import_public
\sa wc_curve448_export_private_raw \sa wc_curve448_export_private_raw
*/ */
WOLFSSL_API
int wc_curve448_import_private_raw(const byte* priv, word32 privSz, int wc_curve448_import_private_raw(const byte* priv, word32 privSz,
const byte* pub, word32 pubSz, curve448_key* key); const byte* pub, word32 pubSz, curve448_key* key);
@ -342,7 +342,7 @@ int wc_curve448_import_private_raw(const byte* priv, word32 privSz,
\sa wc_curve448_export_private_raw \sa wc_curve448_export_private_raw
\sa wc_curve448_import_private_raw \sa wc_curve448_import_private_raw
*/ */
WOLFSSL_API
int wc_curve448_import_private_raw_ex(const byte* priv, word32 privSz, int wc_curve448_import_private_raw_ex(const byte* priv, word32 privSz,
const byte* pub, word32 pubSz, const byte* pub, word32 pubSz,
curve448_key* key, int endian); curve448_key* key, int endian);
@ -384,7 +384,7 @@ int wc_curve448_import_private_raw_ex(const byte* priv, word32 privSz,
\sa wc_curve448_import_private_raw \sa wc_curve448_import_private_raw
\sa wc_curve448_export_private_raw_ex \sa wc_curve448_export_private_raw_ex
*/ */
WOLFSSL_API
int wc_curve448_export_private_raw(curve448_key* key, byte* out, int wc_curve448_export_private_raw(curve448_key* key, byte* out,
word32* outLen); word32* outLen);
@ -428,7 +428,7 @@ int wc_curve448_export_private_raw(curve448_key* key, byte* out,
\sa wc_curve448_export_private_raw \sa wc_curve448_export_private_raw
\sa wc_curve448_size \sa wc_curve448_size
*/ */
WOLFSSL_API
int wc_curve448_export_private_raw_ex(curve448_key* key, byte* out, int wc_curve448_export_private_raw_ex(curve448_key* key, byte* out,
word32* outLen, int endian); word32* outLen, int endian);
@ -472,7 +472,7 @@ int wc_curve448_export_private_raw_ex(curve448_key* key, byte* out,
\sa wc_curve448_check_public \sa wc_curve448_check_public
\sa wc_curve448_size \sa wc_curve448_size
*/ */
WOLFSSL_API
int wc_curve448_import_public(const byte* in, word32 inLen, int wc_curve448_import_public(const byte* in, word32 inLen,
curve448_key* key); curve448_key* key);
@ -518,7 +518,7 @@ int wc_curve448_import_public(const byte* in, word32 inLen,
\sa wc_curve448_check_public \sa wc_curve448_check_public
\sa wc_curve448_size \sa wc_curve448_size
*/ */
WOLFSSL_API
int wc_curve448_import_public_ex(const byte* in, word32 inLen, int wc_curve448_import_public_ex(const byte* in, word32 inLen,
curve448_key* key, int endian); curve448_key* key, int endian);
@ -554,7 +554,7 @@ int wc_curve448_import_public_ex(const byte* in, word32 inLen,
\sa wc_curve448_import_public_ex \sa wc_curve448_import_public_ex
\sa wc_curve448_size \sa wc_curve448_size
*/ */
WOLFSSL_API
int wc_curve448_check_public(const byte* pub, word32 pubSz, int endian); int wc_curve448_check_public(const byte* pub, word32 pubSz, int endian);
/*! /*!
@ -594,7 +594,7 @@ int wc_curve448_check_public(const byte* pub, word32 pubSz, int endian);
\sa wc_curve448_export_private_raw \sa wc_curve448_export_private_raw
\sa wc_curve448_import_public \sa wc_curve448_import_public
*/ */
WOLFSSL_API
int wc_curve448_export_public(curve448_key* key, byte* out, word32* outLen); int wc_curve448_export_public(curve448_key* key, byte* out, word32* outLen);
/*! /*!
@ -636,7 +636,7 @@ int wc_curve448_export_public(curve448_key* key, byte* out, word32* outLen);
\sa wc_curve448_export_private_raw \sa wc_curve448_export_private_raw
\sa wc_curve448_import_public \sa wc_curve448_import_public
*/ */
WOLFSSL_API
int wc_curve448_export_public_ex(curve448_key* key, byte* out, int wc_curve448_export_public_ex(curve448_key* key, byte* out,
word32* outLen, int endian); word32* outLen, int endian);
@ -682,7 +682,7 @@ int wc_curve448_export_public_ex(curve448_key* key, byte* out,
\sa wc_curve448_export_key_raw_ex \sa wc_curve448_export_key_raw_ex
\sa wc_curve448_export_private_raw \sa wc_curve448_export_private_raw
*/ */
WOLFSSL_API
int wc_curve448_export_key_raw(curve448_key* key, int wc_curve448_export_key_raw(curve448_key* key,
byte* priv, word32 *privSz, byte* priv, word32 *privSz,
byte* pub, word32 *pubSz); byte* pub, word32 *pubSz);
@ -733,7 +733,7 @@ int wc_curve448_export_key_raw(curve448_key* key,
\sa wc_curve448_export_private_raw_ex \sa wc_curve448_export_private_raw_ex
\sa wc_curve448_export_public_ex \sa wc_curve448_export_public_ex
*/ */
WOLFSSL_API
int wc_curve448_export_key_raw_ex(curve448_key* key, int wc_curve448_export_key_raw_ex(curve448_key* key,
byte* priv, word32 *privSz, byte* priv, word32 *privSz,
byte* pub, word32 *pubSz, byte* pub, word32 *pubSz,
@ -764,5 +764,5 @@ int wc_curve448_export_key_raw_ex(curve448_key* key,
\sa wc_curve448_init \sa wc_curve448_init
\sa wc_curve448_make_key \sa wc_curve448_make_key
*/ */
WOLFSSL_API
int wc_curve448_size(curve448_key* key); int wc_curve448_size(curve448_key* key);

20
doc/dox_comments/header_files/des3.h
View File

@ -34,7 +34,7 @@
\sa wc_Des_SetIV \sa wc_Des_SetIV
\sa wc_Des3_SetKey \sa wc_Des3_SetKey
*/ */
WOLFSSL_API int wc_Des_SetKey(Des* des, const byte* key, int wc_Des_SetKey(Des* des, const byte* key,
const byte* iv, int dir); const byte* iv, int dir);
/*! /*!
@ -61,7 +61,7 @@ WOLFSSL_API int wc_Des_SetKey(Des* des, const byte* key,
\sa wc_Des_SetKey \sa wc_Des_SetKey
*/ */
WOLFSSL_API void wc_Des_SetIV(Des* des, const byte* iv); void wc_Des_SetIV(Des* des, const byte* iv);
/*! /*!
\ingroup 3DES \ingroup 3DES
@ -93,7 +93,7 @@ WOLFSSL_API void wc_Des_SetIV(Des* des, const byte* iv);
\sa wc_Des_SetKey \sa wc_Des_SetKey
\sa wc_Des_CbcDecrypt \sa wc_Des_CbcDecrypt
*/ */
WOLFSSL_API int wc_Des_CbcEncrypt(Des* des, byte* out, int wc_Des_CbcEncrypt(Des* des, byte* out,
const byte* in, word32 sz); const byte* in, word32 sz);
/*! /*!
@ -126,7 +126,7 @@ WOLFSSL_API int wc_Des_CbcEncrypt(Des* des, byte* out,
\sa wc_Des_SetKey \sa wc_Des_SetKey
\sa wc_Des_CbcEncrypt \sa wc_Des_CbcEncrypt
*/ */
WOLFSSL_API int wc_Des_CbcDecrypt(Des* des, byte* out, int wc_Des_CbcDecrypt(Des* des, byte* out,
const byte* in, word32 sz); const byte* in, word32 sz);
/*! /*!
@ -158,7 +158,7 @@ WOLFSSL_API int wc_Des_CbcDecrypt(Des* des, byte* out,
\sa wc_Des_SetKe \sa wc_Des_SetKe
*/ */
WOLFSSL_API int wc_Des_EcbEncrypt(Des* des, byte* out, int wc_Des_EcbEncrypt(Des* des, byte* out,
const byte* in, word32 sz); const byte* in, word32 sz);
/*! /*!
@ -192,7 +192,7 @@ WOLFSSL_API int wc_Des_EcbEncrypt(Des* des, byte* out,
\sa wc_Des3_SetKey \sa wc_Des3_SetKey
*/ */
WOLFSSL_API int wc_Des3_EcbEncrypt(Des3* des, byte* out, int wc_Des3_EcbEncrypt(Des3* des, byte* out,
const byte* in, word32 sz); const byte* in, word32 sz);
/*! /*!
@ -233,7 +233,7 @@ WOLFSSL_API int wc_Des3_EcbEncrypt(Des3* des, byte* out,
\sa wc_Des3_CbcEncrypt \sa wc_Des3_CbcEncrypt
\sa wc_Des3_CbcDecrypt \sa wc_Des3_CbcDecrypt
*/ */
WOLFSSL_API int wc_Des3_SetKey(Des3* des, const byte* key, int wc_Des3_SetKey(Des3* des, const byte* key,
const byte* iv,int dir); const byte* iv,int dir);
/*! /*!
@ -263,7 +263,7 @@ WOLFSSL_API int wc_Des3_SetKey(Des3* des, const byte* key,
\sa wc_Des3_SetKey \sa wc_Des3_SetKey
*/ */
WOLFSSL_API int wc_Des3_SetIV(Des3* des, const byte* iv); int wc_Des3_SetIV(Des3* des, const byte* iv);
/*! /*!
\ingroup 3DES \ingroup 3DES
@ -295,7 +295,7 @@ WOLFSSL_API int wc_Des3_SetIV(Des3* des, const byte* iv);
\sa wc_Des3_SetKey \sa wc_Des3_SetKey
\sa wc_Des3_CbcDecrypt \sa wc_Des3_CbcDecrypt
*/ */
WOLFSSL_API int wc_Des3_CbcEncrypt(Des3* des, byte* out, int wc_Des3_CbcEncrypt(Des3* des, byte* out,
const byte* in,word32 sz); const byte* in,word32 sz);
/*! /*!
@ -328,5 +328,5 @@ WOLFSSL_API int wc_Des3_CbcEncrypt(Des3* des, byte* out,
\sa wc_Des3_SetKey \sa wc_Des3_SetKey
\sa wc_Des3_CbcEncrypt \sa wc_Des3_CbcEncrypt
*/ */
WOLFSSL_API int wc_Des3_CbcDecrypt(Des3* des, byte* out, int wc_Des3_CbcDecrypt(Des3* des, byte* out,
const byte* in,word32 sz); const byte* in,word32 sz);

44
doc/dox_comments/header_files/dh.h
View File

@ -18,7 +18,7 @@
\sa wc_FreeDhKey \sa wc_FreeDhKey
\sa wc_DhGenerateKeyPair \sa wc_DhGenerateKeyPair
*/ */
WOLFSSL_API int wc_InitDhKey(DhKey* key); int wc_InitDhKey(DhKey* key);
/*! /*!
\ingroup Diffie-Hellman \ingroup Diffie-Hellman
@ -40,7 +40,7 @@ WOLFSSL_API int wc_InitDhKey(DhKey* key);
\sa wc_InitDhKey \sa wc_InitDhKey
*/ */
WOLFSSL_API void wc_FreeDhKey(DhKey* key); void wc_FreeDhKey(DhKey* key);
/*! /*!
\ingroup Diffie-Hellman \ingroup Diffie-Hellman
@ -91,7 +91,7 @@ WOLFSSL_API void wc_FreeDhKey(DhKey* key);
\sa wc_DhSetKey \sa wc_DhSetKey
\sa wc_DhKeyDecode \sa wc_DhKeyDecode
*/ */
WOLFSSL_API int wc_DhGenerateKeyPair(DhKey* key, WC_RNG* rng, byte* priv, int wc_DhGenerateKeyPair(DhKey* key, WC_RNG* rng, byte* priv,
word32* privSz, byte* pub, word32* pubSz); word32* privSz, byte* pub, word32* pubSz);
/*! /*!
@ -142,7 +142,7 @@ WOLFSSL_API int wc_DhGenerateKeyPair(DhKey* key, WC_RNG* rng, byte* priv,
\sa wc_DhGenerateKeyPair \sa wc_DhGenerateKeyPair
*/ */
WOLFSSL_API int wc_DhAgree(DhKey* key, byte* agree, word32* agreeSz, int wc_DhAgree(DhKey* key, byte* agree, word32* agreeSz,
const byte* priv, word32 privSz, const byte* otherPub, const byte* priv, word32 privSz, const byte* otherPub,
word32 pubSz); word32 pubSz);
@ -184,7 +184,7 @@ WOLFSSL_API int wc_DhAgree(DhKey* key, byte* agree, word32* agreeSz,
\sa wc_DhSetKey \sa wc_DhSetKey
*/ */
WOLFSSL_API int wc_DhKeyDecode(const byte* input, word32* inOutIdx, DhKey* key, int wc_DhKeyDecode(const byte* input, word32* inOutIdx, DhKey* key,
word32); word32);
/*! /*!
@ -225,7 +225,7 @@ WOLFSSL_API int wc_DhKeyDecode(const byte* input, word32* inOutIdx, DhKey* key,
\sa wc_DhKeyDecode \sa wc_DhKeyDecode
*/ */
WOLFSSL_API int wc_DhSetKey(DhKey* key, const byte* p, word32 pSz, const byte* g, int wc_DhSetKey(DhKey* key, const byte* p, word32 pSz, const byte* g,
word32 gSz); word32 gSz);
/*! /*!
@ -269,7 +269,7 @@ WOLFSSL_API int wc_DhSetKey(DhKey* key, const byte* p, word32 pSz, const byte* g
\sa wc_DhSetKey \sa wc_DhSetKey
\sa wc_DhKeyDecode \sa wc_DhKeyDecode
*/ */
WOLFSSL_API int wc_DhParamsLoad(const byte* input, word32 inSz, byte* p, int wc_DhParamsLoad(const byte* input, word32 inSz, byte* p,
word32* pInOutSz, byte* g, word32* gInOutSz); word32* pInOutSz, byte* g, word32* gInOutSz);
/*! /*!
@ -283,7 +283,7 @@ WOLFSSL_API int wc_DhParamsLoad(const byte* input, word32 inSz, byte* p,
\sa wc_Dh_ffdhe6144_Get \sa wc_Dh_ffdhe6144_Get
\sa wc_Dh_ffdhe8192_Get \sa wc_Dh_ffdhe8192_Get
*/ */
WOLFSSL_API const DhParams* wc_Dh_ffdhe2048_Get(void); const DhParams* wc_Dh_ffdhe2048_Get(void);
/*! /*!
\ingroup Diffie-Hellman \ingroup Diffie-Hellman
@ -296,7 +296,7 @@ WOLFSSL_API const DhParams* wc_Dh_ffdhe2048_Get(void);
\sa wc_Dh_ffdhe6144_Get \sa wc_Dh_ffdhe6144_Get
\sa wc_Dh_ffdhe8192_Get \sa wc_Dh_ffdhe8192_Get
*/ */
WOLFSSL_API const DhParams* wc_Dh_ffdhe3072_Get(void); const DhParams* wc_Dh_ffdhe3072_Get(void);
/*! /*!
\ingroup Diffie-Hellman \ingroup Diffie-Hellman
@ -309,7 +309,7 @@ WOLFSSL_API const DhParams* wc_Dh_ffdhe3072_Get(void);
\sa wc_Dh_ffdhe6144_Get \sa wc_Dh_ffdhe6144_Get
\sa wc_Dh_ffdhe8192_Get \sa wc_Dh_ffdhe8192_Get
*/ */
WOLFSSL_API const DhParams* wc_Dh_ffdhe4096_Get(void); const DhParams* wc_Dh_ffdhe4096_Get(void);
/*! /*!
\ingroup Diffie-Hellman \ingroup Diffie-Hellman
@ -322,7 +322,7 @@ WOLFSSL_API const DhParams* wc_Dh_ffdhe4096_Get(void);
\sa wc_Dh_ffdhe4096_Get \sa wc_Dh_ffdhe4096_Get
\sa wc_Dh_ffdhe8192_Get \sa wc_Dh_ffdhe8192_Get
*/ */
WOLFSSL_API const DhParams* wc_Dh_ffdhe6144_Get(void); const DhParams* wc_Dh_ffdhe6144_Get(void);
/*! /*!
\ingroup Diffie-Hellman \ingroup Diffie-Hellman
@ -335,7 +335,7 @@ WOLFSSL_API const DhParams* wc_Dh_ffdhe6144_Get(void);
\sa wc_Dh_ffdhe4096_Get \sa wc_Dh_ffdhe4096_Get
\sa wc_Dh_ffdhe6144_Get \sa wc_Dh_ffdhe6144_Get
*/ */
WOLFSSL_API const DhParams* wc_Dh_ffdhe8192_Get(void); const DhParams* wc_Dh_ffdhe8192_Get(void);
/*! /*!
\ingroup Diffie-Hellman \ingroup Diffie-Hellman
@ -343,7 +343,7 @@ WOLFSSL_API const DhParams* wc_Dh_ffdhe8192_Get(void);
\brief Checks DH keys for pair-wise consistency per process in SP 800-56Ar3, \brief Checks DH keys for pair-wise consistency per process in SP 800-56Ar3,
section 5.6.2.1.4, method (b) for FFC. section 5.6.2.1.4, method (b) for FFC.
*/ */
WOLFSSL_API int wc_DhCheckKeyPair(DhKey* key, const byte* pub, word32 pubSz, int wc_DhCheckKeyPair(DhKey* key, const byte* pub, word32 pubSz,
const byte* priv, word32 privSz); const byte* priv, word32 privSz);
/*! /*!
@ -351,50 +351,50 @@ WOLFSSL_API int wc_DhCheckKeyPair(DhKey* key, const byte* pub, word32 pubSz,
\brief Check DH private key for invalid numbers \brief Check DH private key for invalid numbers
*/ */
WOLFSSL_API int wc_DhCheckPrivKey(DhKey* key, const byte* priv, word32 pubSz); int wc_DhCheckPrivKey(DhKey* key, const byte* priv, word32 pubSz);
/*! /*!
\ingroup Diffie-Hellman \ingroup Diffie-Hellman
*/ */
WOLFSSL_API int wc_DhCheckPrivKey_ex(DhKey* key, const byte* priv, word32 pubSz, int wc_DhCheckPrivKey_ex(DhKey* key, const byte* priv, word32 pubSz,
const byte* prime, word32 primeSz); const byte* prime, word32 primeSz);
/*! /*!
\ingroup Diffie-Hellman \ingroup Diffie-Hellman
*/ */
WOLFSSL_API int wc_DhCheckPubKey(DhKey* key, const byte* pub, word32 pubSz); int wc_DhCheckPubKey(DhKey* key, const byte* pub, word32 pubSz);
/*! /*!
\ingroup Diffie-Hellman \ingroup Diffie-Hellman
*/ */
WOLFSSL_API int wc_DhCheckPubKey_ex(DhKey* key, const byte* pub, word32 pubSz, int wc_DhCheckPubKey_ex(DhKey* key, const byte* pub, word32 pubSz,
const byte* prime, word32 primeSz); const byte* prime, word32 primeSz);
/*! /*!
\ingroup Diffie-Hellman \ingroup Diffie-Hellman
*/ */
WOLFSSL_API int wc_DhExportParamsRaw(DhKey* dh, byte* p, word32* pSz, int wc_DhExportParamsRaw(DhKey* dh, byte* p, word32* pSz,
byte* q, word32* qSz, byte* g, word32* gSz); byte* q, word32* qSz, byte* g, word32* gSz);
/*! /*!
\ingroup Diffie-Hellman \ingroup Diffie-Hellman
*/ */
WOLFSSL_API int wc_DhGenerateParams(WC_RNG *rng, int modSz, DhKey *dh); int wc_DhGenerateParams(WC_RNG *rng, int modSz, DhKey *dh);
/*! /*!
\ingroup Diffie-Hellman \ingroup Diffie-Hellman
*/ */
WOLFSSL_API int wc_DhSetCheckKey(DhKey* key, const byte* p, word32 pSz, int wc_DhSetCheckKey(DhKey* key, const byte* p, word32 pSz,
const byte* g, word32 gSz, const byte* q, word32 qSz, const byte* g, word32 gSz, const byte* q, word32 qSz,
int trusted, WC_RNG* rng); int trusted, WC_RNG* rng);
/*! /*!
\ingroup Diffie-Hellman \ingroup Diffie-Hellman
*/ */
WOLFSSL_API int wc_DhSetKey_ex(DhKey* key, const byte* p, word32 pSz, int wc_DhSetKey_ex(DhKey* key, const byte* p, word32 pSz,
const byte* g, word32 gSz, const byte* q, word32 qSz); const byte* g, word32 gSz, const byte* q, word32 qSz);
/*! /*!
\ingroup Diffie-Hellman \ingroup Diffie-Hellman
*/ */
WOLFSSL_API int wc_FreeDhKey(DhKey* key); int wc_FreeDhKey(DhKey* key);

22
doc/dox_comments/header_files/dsa.h
View File

@ -18,7 +18,7 @@
\sa wc_FreeDsaKey \sa wc_FreeDsaKey
*/ */
WOLFSSL_API int wc_InitDsaKey(DsaKey* key); int wc_InitDsaKey(DsaKey* key);
/*! /*!
\ingroup DSA \ingroup DSA
@ -39,7 +39,7 @@ WOLFSSL_API int wc_InitDsaKey(DsaKey* key);
\sa wc_FreeDsaKey \sa wc_FreeDsaKey
*/ */
WOLFSSL_API void wc_FreeDsaKey(DsaKey* key); void wc_FreeDsaKey(DsaKey* key);
/*! /*!
\ingroup DSA \ingroup DSA
@ -96,7 +96,7 @@ WOLFSSL_API void wc_FreeDsaKey(DsaKey* key);
\sa wc_DsaVerify \sa wc_DsaVerify
*/ */
WOLFSSL_API int wc_DsaSign(const byte* digest, byte* out, int wc_DsaSign(const byte* digest, byte* out,
DsaKey* key, WC_RNG* rng); DsaKey* key, WC_RNG* rng);
/*! /*!
@ -159,7 +159,7 @@ WOLFSSL_API int wc_DsaSign(const byte* digest, byte* out,
\sa wc_DsaSign \sa wc_DsaSign
*/ */
WOLFSSL_API int wc_DsaVerify(const byte* digest, const byte* sig, int wc_DsaVerify(const byte* digest, const byte* sig,
DsaKey* key, int* answer); DsaKey* key, int* answer);
/*! /*!
@ -199,8 +199,8 @@ WOLFSSL_API int wc_DsaVerify(const byte* digest, const byte* sig,
\sa wc_InitDsaKey \sa wc_InitDsaKey
\sa wc_DsaPrivateKeyDecode \sa wc_DsaPrivateKeyDecode
*/ */
WOLFSSL_API int wc_DsaPublicKeyDecode(const byte* input, word32* inOutIdx, int wc_DsaPublicKeyDecode(const byte* input, word32* inOutIdx,
DsaKey*, word32); DsaKey* key, word32 inSz);
/*! /*!
\ingroup DSA \ingroup DSA
@ -240,8 +240,8 @@ WOLFSSL_API int wc_DsaPublicKeyDecode(const byte* input, word32* inOutIdx,
\sa wc_InitDsaKey \sa wc_InitDsaKey
\sa wc_DsaPublicKeyDecode \sa wc_DsaPublicKeyDecode
*/ */
WOLFSSL_API int wc_DsaPrivateKeyDecode(const byte* input, word32* inOutIdx, int wc_DsaPrivateKeyDecode(const byte* input, word32* inOutIdx,
DsaKey*, word32); DsaKey* key, word32 inSz);
/*! /*!
\ingroup DSA \ingroup DSA
@ -276,7 +276,7 @@ WOLFSSL_API int wc_DsaPrivateKeyDecode(const byte* input, word32* inOutIdx,
\sa wc_FreeDsaKey \sa wc_FreeDsaKey
\sa wc_MakeDsaKey \sa wc_MakeDsaKey
*/ */
WOLFSSL_API int wc_DsaKeyToDer(DsaKey* key, byte* output, word32 inLen); int wc_DsaKeyToDer(DsaKey* key, byte* output, word32 inLen);
/*! /*!
\ingroup DSA \ingroup DSA
@ -307,7 +307,7 @@ WOLFSSL_API int wc_DsaKeyToDer(DsaKey* key, byte* output, word32 inLen);
\sa wc_FreeDsaKey \sa wc_FreeDsaKey
\sa wc_DsaSign \sa wc_DsaSign
*/ */
WOLFSSL_API int wc_MakeDsaKey(WC_RNG *rng, DsaKey *dsa); int wc_MakeDsaKey(WC_RNG *rng, DsaKey *dsa);
/*! /*!
\ingroup DSA \ingroup DSA
@ -339,4 +339,4 @@ WOLFSSL_API int wc_MakeDsaKey(WC_RNG *rng, DsaKey *dsa);
\sa wc_DsaKeyToDer \sa wc_DsaKeyToDer
\sa wc_InitDsaKey \sa wc_InitDsaKey
*/ */
WOLFSSL_API int wc_MakeDsaParameters(WC_RNG *rng, int modulus_size, DsaKey *dsa); int wc_MakeDsaParameters(WC_RNG *rng, int modulus_size, DsaKey *dsa);

100
doc/dox_comments/header_files/ecc.h
View File

@ -49,7 +49,7 @@
\sa wc_ecc_init \sa wc_ecc_init
\sa wc_ecc_shared_secret \sa wc_ecc_shared_secret
*/ */
WOLFSSL_API
int wc_ecc_make_key(WC_RNG* rng, int keysize, ecc_key* key); int wc_ecc_make_key(WC_RNG* rng, int keysize, ecc_key* key);
/*! /*!
@ -110,7 +110,7 @@ int wc_ecc_make_key(WC_RNG* rng, int keysize, ecc_key* key);
\sa wc_ecc_make_key \sa wc_ecc_make_key
\sa wc_ecc_get_curve_size_from_id \sa wc_ecc_get_curve_size_from_id
*/ */
WOLFSSL_API
int wc_ecc_make_key_ex(WC_RNG* rng, int keysize, ecc_key* key, int curve_id); int wc_ecc_make_key_ex(WC_RNG* rng, int keysize, ecc_key* key, int curve_id);
/*! /*!
@ -146,7 +146,7 @@ int wc_ecc_make_key_ex(WC_RNG* rng, int keysize, ecc_key* key, int curve_id);
\sa wc_ecc_point_is_at_infinity \sa wc_ecc_point_is_at_infinity
*/ */
WOLFSSL_API
int wc_ecc_check_key(ecc_key* key); int wc_ecc_check_key(ecc_key* key);
/*! /*!
@ -167,7 +167,7 @@ int wc_ecc_check_key(ecc_key* key);
\sa wc_ecc_key_new \sa wc_ecc_key_new
\sa wc_ecc_init_ex \sa wc_ecc_init_ex
*/ */
WOLFSSL_API
void wc_ecc_key_free(ecc_key* key); void wc_ecc_key_free(ecc_key* key);
/*! /*!
@ -242,7 +242,7 @@ void wc_ecc_key_free(ecc_key* key);
\sa wc_ecc_init \sa wc_ecc_init
\sa wc_ecc_make_key \sa wc_ecc_make_key
*/ */
WOLFSSL_API
int wc_ecc_shared_secret(ecc_key* private_key, ecc_key* public_key, byte* out, int wc_ecc_shared_secret(ecc_key* private_key, ecc_key* public_key, byte* out,
word32* outlen); word32* outlen);
@ -288,7 +288,7 @@ int wc_ecc_shared_secret(ecc_key* private_key, ecc_key* public_key, byte* out,
\sa wc_ecc_verify_hash_ex \sa wc_ecc_verify_hash_ex
*/ */
WOLFSSL_API
int wc_ecc_shared_secret_ex(ecc_key* private_key, ecc_point* point, int wc_ecc_shared_secret_ex(ecc_key* private_key, ecc_point* point,
byte* out, word32 *outlen); byte* out, word32 *outlen);
@ -357,7 +357,7 @@ int wc_ecc_shared_secret_ex(ecc_key* private_key, ecc_point* point,
\sa wc_ecc_verify_hash \sa wc_ecc_verify_hash
*/ */
WOLFSSL_API
int wc_ecc_sign_hash(const byte* in, word32 inlen, byte* out, word32 *outlen, int wc_ecc_sign_hash(const byte* in, word32 inlen, byte* out, word32 *outlen,
WC_RNG* rng, ecc_key* key); WC_RNG* rng, ecc_key* key);
@ -428,7 +428,7 @@ int wc_ecc_sign_hash(const byte* in, word32 inlen, byte* out, word32 *outlen,
\sa wc_ecc_verify_hash_ex \sa wc_ecc_verify_hash_ex
*/ */
WOLFSSL_API
int wc_ecc_sign_hash_ex(const byte* in, word32 inlen, WC_RNG* rng, int wc_ecc_sign_hash_ex(const byte* in, word32 inlen, WC_RNG* rng,
ecc_key* key, mp_int *r, mp_int *s); ecc_key* key, mp_int *r, mp_int *s);
@ -496,7 +496,7 @@ int wc_ecc_sign_hash_ex(const byte* in, word32 inlen, WC_RNG* rng,
\sa wc_ecc_sign_hash \sa wc_ecc_sign_hash
\sa wc_ecc_verify_hash_ex \sa wc_ecc_verify_hash_ex
*/ */
WOLFSSL_API
int wc_ecc_verify_hash(const byte* sig, word32 siglen, const byte* hash, int wc_ecc_verify_hash(const byte* sig, word32 siglen, const byte* hash,
word32 hashlen, int* stat, ecc_key* key); word32 hashlen, int* stat, ecc_key* key);
@ -535,7 +535,7 @@ int wc_ecc_verify_hash(const byte* sig, word32 siglen, const byte* hash,
\sa wc_ecc_verify_hash \sa wc_ecc_verify_hash
*/ */
WOLFSSL_API
int wc_ecc_verify_hash_ex(mp_int *r, mp_int *s, const byte* hash, int wc_ecc_verify_hash_ex(mp_int *r, mp_int *s, const byte* hash,
word32 hashlen, int* stat, ecc_key* key); word32 hashlen, int* stat, ecc_key* key);
@ -559,7 +559,7 @@ int wc_ecc_verify_hash_ex(mp_int *r, mp_int *s, const byte* hash,
\sa wc_ecc_make_key \sa wc_ecc_make_key
\sa wc_ecc_free \sa wc_ecc_free
*/ */
WOLFSSL_API
int wc_ecc_init(ecc_key* key); int wc_ecc_init(ecc_key* key);
/*! /*!
@ -585,7 +585,7 @@ int wc_ecc_init(ecc_key* key);
\sa wc_ecc_free \sa wc_ecc_free
\sa wc_ecc_init \sa wc_ecc_init
*/ */
WOLFSSL_API
int wc_ecc_init_ex(ecc_key* key, void* heap, int devId); int wc_ecc_init_ex(ecc_key* key, void* heap, int devId);
/*! /*!
@ -607,7 +607,7 @@ int wc_ecc_init_ex(ecc_key* key, void* heap, int devId);
\sa wc_ecc_key_free \sa wc_ecc_key_free
\sa wc_ecc_init \sa wc_ecc_init
*/ */
WOLFSSL_API
ecc_key* wc_ecc_key_new(void* heap); ecc_key* wc_ecc_key_new(void* heap);
/*! /*!
@ -628,7 +628,7 @@ ecc_key* wc_ecc_key_new(void* heap);
\sa wc_ecc_init \sa wc_ecc_init
*/ */
WOLFSSL_API
int wc_ecc_free(ecc_key* key); int wc_ecc_free(ecc_key* key);
/*! /*!
@ -653,7 +653,7 @@ int wc_ecc_free(ecc_key* key);
\sa wc_ecc_free \sa wc_ecc_free
*/ */
WOLFSSL_API
void wc_ecc_fp_free(void); void wc_ecc_fp_free(void);
/*! /*!
@ -687,7 +687,7 @@ void wc_ecc_fp_free(void);
\sa none \sa none
*/ */
WOLFSSL_API
int wc_ecc_is_valid_idx(int n); int wc_ecc_is_valid_idx(int n);
/*! /*!
@ -715,7 +715,7 @@ int wc_ecc_is_valid_idx(int n);
\sa wc_ecc_cmp_point \sa wc_ecc_cmp_point
\sa wc_ecc_copy_point \sa wc_ecc_copy_point
*/ */
WOLFSSL_API
ecc_point* wc_ecc_new_point(void); ecc_point* wc_ecc_new_point(void);
/*! /*!
@ -743,7 +743,7 @@ ecc_point* wc_ecc_new_point(void);
\sa wc_ecc_cmp_point \sa wc_ecc_cmp_point
\sa wc_ecc_copy_point \sa wc_ecc_copy_point
*/ */
WOLFSSL_API
void wc_ecc_del_point(ecc_point* p); void wc_ecc_del_point(ecc_point* p);
/*! /*!
@ -776,7 +776,7 @@ void wc_ecc_del_point(ecc_point* p);
\sa wc_ecc_cmp_point \sa wc_ecc_cmp_point
\sa wc_ecc_del_point \sa wc_ecc_del_point
*/ */
WOLFSSL_API
int wc_ecc_copy_point(ecc_point* p, ecc_point *r); int wc_ecc_copy_point(ecc_point* p, ecc_point *r);
/*! /*!
@ -819,7 +819,7 @@ int wc_ecc_copy_point(ecc_point* p, ecc_point *r);
\sa wc_ecc_del_point \sa wc_ecc_del_point
\sa wc_ecc_copy_point \sa wc_ecc_copy_point
*/ */
WOLFSSL_API
int wc_ecc_cmp_point(ecc_point* a, ecc_point *b); int wc_ecc_cmp_point(ecc_point* a, ecc_point *b);
/*! /*!
@ -860,7 +860,7 @@ int wc_ecc_cmp_point(ecc_point* a, ecc_point *b);
\sa wc_ecc_cmp_point \sa wc_ecc_cmp_point
\sa wc_ecc_copy_point \sa wc_ecc_copy_point
*/ */
WOLFSSL_API
int wc_ecc_point_is_at_infinity(ecc_point *p); int wc_ecc_point_is_at_infinity(ecc_point *p);
/*! /*!
@ -894,7 +894,7 @@ int wc_ecc_point_is_at_infinity(ecc_point *p);
\sa none \sa none
*/ */
WOLFSSL_API
int wc_ecc_mulmod(mp_int* k, ecc_point *G, ecc_point *R, int wc_ecc_mulmod(mp_int* k, ecc_point *G, ecc_point *R,
mp_int* a, mp_int* modulus, int map); mp_int* a, mp_int* modulus, int map);
@ -960,8 +960,8 @@ int wc_ecc_mulmod(mp_int* k, ecc_point *G, ecc_point *R,
\sa wc_ecc_export_x963_ex \sa wc_ecc_export_x963_ex
\sa wc_ecc_import_x963 \sa wc_ecc_import_x963
*/ */
WOLFSSL_API
int wc_ecc_export_x963(ecc_key*, byte* out, word32* outLen); int wc_ecc_export_x963(ecc_key* key, byte* out, word32* outLen);
/*! /*!
\ingroup ECC \ingroup ECC
@ -1031,8 +1031,8 @@ int wc_ecc_export_x963(ecc_key*, byte* out, word32* outLen);
\sa wc_ecc_export_x963 \sa wc_ecc_export_x963
\sa wc_ecc_import_x963 \sa wc_ecc_import_x963
*/ */
WOLFSSL_API
int wc_ecc_export_x963_ex(ecc_key*, byte* out, word32* outLen, int compressed); int wc_ecc_export_x963_ex(ecc_key* key, byte* out, word32* outLen, int compressed);
/*! /*!
\ingroup ECC \ingroup ECC
@ -1094,7 +1094,7 @@ int wc_ecc_export_x963_ex(ecc_key*, byte* out, word32* outLen, int compressed);
\sa wc_ecc_export_x963 \sa wc_ecc_export_x963
\sa wc_ecc_import_private_key \sa wc_ecc_import_private_key
*/ */
WOLFSSL_API
int wc_ecc_import_x963(const byte* in, word32 inLen, ecc_key* key); int wc_ecc_import_x963(const byte* in, word32 inLen, ecc_key* key);
/*! /*!
@ -1163,7 +1163,7 @@ int wc_ecc_import_x963(const byte* in, word32 inLen, ecc_key* key);
\sa wc_ecc_export_x963 \sa wc_ecc_export_x963
\sa wc_ecc_import_private_key \sa wc_ecc_import_private_key
*/ */
WOLFSSL_API
int wc_ecc_import_private_key(const byte* priv, word32 privSz, const byte* pub, int wc_ecc_import_private_key(const byte* priv, word32 privSz, const byte* pub,
word32 pubSz, ecc_key* key); word32 pubSz, ecc_key* key);
@ -1229,7 +1229,7 @@ int wc_ecc_import_private_key(const byte* priv, word32 privSz, const byte* pub,
\sa wc_ecc_sign_hash \sa wc_ecc_sign_hash
\sa wc_ecc_sig_size \sa wc_ecc_sig_size
*/ */
WOLFSSL_API
int wc_ecc_rs_to_sig(const char* r, const char* s, byte* out, word32* outlen); int wc_ecc_rs_to_sig(const char* r, const char* s, byte* out, word32* outlen);
/*! /*!
@ -1294,7 +1294,7 @@ int wc_ecc_rs_to_sig(const char* r, const char* s, byte* out, word32* outlen);
\sa wc_ecc_import_private_key \sa wc_ecc_import_private_key
*/ */
WOLFSSL_API
int wc_ecc_import_raw(ecc_key* key, const char* qx, const char* qy, int wc_ecc_import_raw(ecc_key* key, const char* qx, const char* qy,
const char* d, const char* curveName); const char* d, const char* curveName);
@ -1357,7 +1357,7 @@ int wc_ecc_import_raw(ecc_key* key, const char* qx, const char* qy,
\sa wc_ecc_import_private_key \sa wc_ecc_import_private_key
*/ */
WOLFSSL_API
int wc_ecc_export_private_only(ecc_key* key, byte* out, word32* outLen); int wc_ecc_export_private_only(ecc_key* key, byte* out, word32* outLen);
/*! /*!
@ -1389,7 +1389,7 @@ int wc_ecc_export_private_only(ecc_key* key, byte* out, word32* outLen);
\sa wc_ecc_import_point_der \sa wc_ecc_import_point_der
*/ */
WOLFSSL_API
int wc_ecc_export_point_der(const int curve_idx, ecc_point* point, int wc_ecc_export_point_der(const int curve_idx, ecc_point* point,
byte* out, word32* outLen); byte* out, word32* outLen);
@ -1421,7 +1421,7 @@ int wc_ecc_export_point_der(const int curve_idx, ecc_point* point,
\sa wc_ecc_export_point_der \sa wc_ecc_export_point_der
*/ */
WOLFSSL_API
int wc_ecc_import_point_der(byte* in, word32 inLen, const int curve_idx, int wc_ecc_import_point_der(byte* in, word32 inLen, const int curve_idx,
ecc_point* point); ecc_point* point);
@ -1449,7 +1449,7 @@ int wc_ecc_import_point_der(byte* in, word32 inLen, const int curve_idx,
\sa wc_ecc_make_key \sa wc_ecc_make_key
*/ */
WOLFSSL_API
int wc_ecc_size(ecc_key* key); int wc_ecc_size(ecc_key* key);
/*! /*!
@ -1475,7 +1475,7 @@ int wc_ecc_size(ecc_key* key);
\sa wc_ecc_sign_hash \sa wc_ecc_sign_hash
\sa wc_ecc_sig_size \sa wc_ecc_sig_size
*/ */
WOLFSSL_API
int wc_ecc_sig_size_calc(int sz); int wc_ecc_sig_size_calc(int sz);
@ -1508,7 +1508,7 @@ int wc_ecc_sig_size_calc(int sz);
\sa wc_ecc_sign_hash \sa wc_ecc_sign_hash
\sa wc_ecc_sig_size_calc \sa wc_ecc_sig_size_calc
*/ */
WOLFSSL_API
int wc_ecc_sig_size(ecc_key* key); int wc_ecc_sig_size(ecc_key* key);
@ -1542,7 +1542,7 @@ int wc_ecc_sig_size(ecc_key* key);
\sa wc_ecc_encrypt_ex \sa wc_ecc_encrypt_ex
\sa wc_ecc_decrypt \sa wc_ecc_decrypt
*/ */
WOLFSSL_API
ecEncCtx* wc_ecc_ctx_new(int flags, WC_RNG* rng); ecEncCtx* wc_ecc_ctx_new(int flags, WC_RNG* rng);
/*! /*!
@ -1568,7 +1568,7 @@ ecEncCtx* wc_ecc_ctx_new(int flags, WC_RNG* rng);
\sa wc_ecc_ctx_new \sa wc_ecc_ctx_new
*/ */
WOLFSSL_API
void wc_ecc_ctx_free(ecEncCtx*); void wc_ecc_ctx_free(ecEncCtx*);
/*! /*!
@ -1599,8 +1599,8 @@ void wc_ecc_ctx_free(ecEncCtx*);
\sa wc_ecc_ctx_new \sa wc_ecc_ctx_new
*/ */
WOLFSSL_API
int wc_ecc_ctx_reset(ecEncCtx*, WC_RNG*); /* reset for use again w/o alloc/free */ int wc_ecc_ctx_reset(ecEncCtx* ctx, WC_RNG* rng); /* reset for use again w/o alloc/free */
/*! /*!
\ingroup ECC \ingroup ECC
@ -1630,7 +1630,7 @@ int wc_ecc_ctx_reset(ecEncCtx*, WC_RNG*); /* reset for use again w/o alloc/free
\sa wc_ecc_ctx_new \sa wc_ecc_ctx_new
*/ */
WOLFSSL_API
int wc_ecc_ctx_set_algo(ecEncCtx* ctx, byte encAlgo, byte kdfAlgo, int wc_ecc_ctx_set_algo(ecEncCtx* ctx, byte encAlgo, byte kdfAlgo,
byte macAlgo); byte macAlgo);
@ -1665,7 +1665,7 @@ int wc_ecc_ctx_set_algo(ecEncCtx* ctx, byte encAlgo, byte kdfAlgo,
\sa wc_ecc_ctx_new \sa wc_ecc_ctx_new
\sa wc_ecc_ctx_set_peer_salt \sa wc_ecc_ctx_set_peer_salt
*/ */
WOLFSSL_API
const byte* wc_ecc_ctx_get_own_salt(ecEncCtx*); const byte* wc_ecc_ctx_get_own_salt(ecEncCtx*);
/*! /*!
@ -1703,8 +1703,8 @@ const byte* wc_ecc_ctx_get_own_salt(ecEncCtx*);
\sa wc_ecc_ctx_get_own_salt \sa wc_ecc_ctx_get_own_salt
*/ */
WOLFSSL_API
int wc_ecc_ctx_set_peer_salt(ecEncCtx*, const byte* salt); int wc_ecc_ctx_set_peer_salt(ecEncCtx* ctx, const byte* salt);
/*! /*!
\ingroup ECC \ingroup ECC
@ -1734,8 +1734,8 @@ int wc_ecc_ctx_set_peer_salt(ecEncCtx*, const byte* salt);
\sa wc_ecc_ctx_new \sa wc_ecc_ctx_new
*/ */
WOLFSSL_API
int wc_ecc_ctx_set_info(ecEncCtx*, const byte* info, int sz); int wc_ecc_ctx_set_info(ecEncCtx* ctx, const byte* info, int sz);
/*! /*!
\ingroup ECC \ingroup ECC
@ -1795,7 +1795,7 @@ int wc_ecc_ctx_set_info(ecEncCtx*, const byte* info, int sz);
\sa wc_ecc_encrypt_ex \sa wc_ecc_encrypt_ex
\sa wc_ecc_decrypt \sa wc_ecc_decrypt
*/ */
WOLFSSL_API
int wc_ecc_encrypt(ecc_key* privKey, ecc_key* pubKey, const byte* msg, int wc_ecc_encrypt(ecc_key* privKey, ecc_key* pubKey, const byte* msg,
word32 msgSz, byte* out, word32* outSz, ecEncCtx* ctx); word32 msgSz, byte* out, word32* outSz, ecEncCtx* ctx);
@ -1859,7 +1859,7 @@ int wc_ecc_encrypt(ecc_key* privKey, ecc_key* pubKey, const byte* msg,
\sa wc_ecc_encrypt \sa wc_ecc_encrypt
\sa wc_ecc_decrypt \sa wc_ecc_decrypt
*/ */
WOLFSSL_API
int wc_ecc_encrypt_ex(ecc_key* privKey, ecc_key* pubKey, const byte* msg, int wc_ecc_encrypt_ex(ecc_key* privKey, ecc_key* pubKey, const byte* msg,
word32 msgSz, byte* out, word32* outSz, ecEncCtx* ctx, int compressed); word32 msgSz, byte* out, word32* outSz, ecEncCtx* ctx, int compressed);
@ -1922,7 +1922,7 @@ int wc_ecc_encrypt_ex(ecc_key* privKey, ecc_key* pubKey, const byte* msg,
\sa wc_ecc_encrypt \sa wc_ecc_encrypt
\sa wc_ecc_encrypt_ex \sa wc_ecc_encrypt_ex
*/ */
WOLFSSL_API
int wc_ecc_decrypt(ecc_key* privKey, ecc_key* pubKey, const byte* msg, int wc_ecc_decrypt(ecc_key* privKey, ecc_key* pubKey, const byte* msg,
word32 msgSz, byte* out, word32* outSz, ecEncCtx* ctx); word32 msgSz, byte* out, word32* outSz, ecEncCtx* ctx);
@ -1967,4 +1967,4 @@ int wc_ecc_decrypt(ecc_key* privKey, ecc_key* pubKey, const byte* msg,
} }
\endcode \endcode
*/ */
WOLFSSL_API int wc_ecc_set_nonblock(ecc_key *key, ecc_nb_ctx_t* ctx); int wc_ecc_set_nonblock(ecc_key *key, ecc_nb_ctx_t* ctx);

50
doc/dox_comments/header_files/eccsi.h
View File

@ -2,130 +2,130 @@
/*! /*!
\ingroup ECCSI_Setup \ingroup ECCSI_Setup
*/ */
WOLFSSL_API int wc_InitEccsiKey(EccsiKey* key, void* heap, int devId); int wc_InitEccsiKey(EccsiKey* key, void* heap, int devId);
/*! /*!
\ingroup ECCSI_Setup \ingroup ECCSI_Setup
*/ */
WOLFSSL_API int wc_InitEccsiKey_ex(EccsiKey* key, int keySz, int curveId, int wc_InitEccsiKey_ex(EccsiKey* key, int keySz, int curveId,
void* heap, int devId); void* heap, int devId);
/*! /*!
\ingroup ECCSI_Setup \ingroup ECCSI_Setup
*/ */
WOLFSSL_API void wc_FreeEccsiKey(EccsiKey* key); void wc_FreeEccsiKey(EccsiKey* key);
/*! /*!
\ingroup ECCSI_Setup \ingroup ECCSI_Setup
*/ */
WOLFSSL_API int wc_MakeEccsiKey(EccsiKey* key, WC_RNG* rng); int wc_MakeEccsiKey(EccsiKey* key, WC_RNG* rng);
/*! /*!
\ingroup ECCSI_Operations \ingroup ECCSI_Operations
*/ */
WOLFSSL_API int wc_MakeEccsiPair(EccsiKey* key, WC_RNG* rng, int wc_MakeEccsiPair(EccsiKey* key, WC_RNG* rng,
enum wc_HashType hashType, const byte* id, word32 idSz, mp_int* ssk, enum wc_HashType hashType, const byte* id, word32 idSz, mp_int* ssk,
ecc_point* pvt); ecc_point* pvt);
/*! /*!
\ingroup ECCSI_Operations \ingroup ECCSI_Operations
*/ */
WOLFSSL_API int wc_ValidateEccsiPair(EccsiKey* key, enum wc_HashType hashType, int wc_ValidateEccsiPair(EccsiKey* key, enum wc_HashType hashType,
const byte* id, word32 idSz, const mp_int* ssk, ecc_point* pvt, const byte* id, word32 idSz, const mp_int* ssk, ecc_point* pvt,
int* valid); int* valid);
/*! /*!
\ingroup ECCSI_Operations \ingroup ECCSI_Operations
*/ */
WOLFSSL_API int wc_ValidateEccsiPvt(EccsiKey* key, const ecc_point* pvt, int wc_ValidateEccsiPvt(EccsiKey* key, const ecc_point* pvt,
int* valid); int* valid);
/*! /*!
\ingroup ECCSI_Operations \ingroup ECCSI_Operations
*/ */
WOLFSSL_API int wc_EncodeEccsiPair(const EccsiKey* key, mp_int* ssk, int wc_EncodeEccsiPair(const EccsiKey* key, mp_int* ssk,
ecc_point* pvt, byte* data, word32* sz); ecc_point* pvt, byte* data, word32* sz);
/*! /*!
\ingroup ECCSI_Operations \ingroup ECCSI_Operations
*/ */
WOLFSSL_API int wc_EncodeEccsiSsk(const EccsiKey* key, mp_int* ssk, byte* data, int wc_EncodeEccsiSsk(const EccsiKey* key, mp_int* ssk, byte* data,
word32* sz); word32* sz);
/*! /*!
\ingroup ECCSI_Operations \ingroup ECCSI_Operations
*/ */
WOLFSSL_API int wc_EncodeEccsiPvt(const EccsiKey* key, ecc_point* pvt, int wc_EncodeEccsiPvt(const EccsiKey* key, ecc_point* pvt,
byte* data, word32* sz, int raw); byte* data, word32* sz, int raw);
/*! /*!
\ingroup ECCSI_Operations \ingroup ECCSI_Operations
*/ */
WOLFSSL_API int wc_DecodeEccsiPair(const EccsiKey* key, const byte* data, int wc_DecodeEccsiPair(const EccsiKey* key, const byte* data,
word32 sz, mp_int* ssk, ecc_point* pvt); word32 sz, mp_int* ssk, ecc_point* pvt);
/*! /*!
\ingroup ECCSI_Operations \ingroup ECCSI_Operations
*/ */
WOLFSSL_API int wc_DecodeEccsiSsk(const EccsiKey* key, const byte* data, int wc_DecodeEccsiSsk(const EccsiKey* key, const byte* data,
word32 sz, mp_int* ssk); word32 sz, mp_int* ssk);
/*! /*!
\ingroup ECCSI_Operations \ingroup ECCSI_Operations
*/ */
WOLFSSL_API int wc_DecodeEccsiPvt(const EccsiKey* key, const byte* data, int wc_DecodeEccsiPvt(const EccsiKey* key, const byte* data,
word32 sz, ecc_point* pvt); word32 sz, ecc_point* pvt);
/*! /*!
\ingroup ECCSI_Operations \ingroup ECCSI_Operations
*/ */
WOLFSSL_API int wc_DecodeEccsiPvtFromSig(const EccsiKey* key, const byte* sig, int wc_DecodeEccsiPvtFromSig(const EccsiKey* key, const byte* sig,
word32 sz, ecc_point* pvt); word32 sz, ecc_point* pvt);
/*! /*!
\ingroup ECCSI_Setup \ingroup ECCSI_Setup
*/ */
WOLFSSL_API int wc_ExportEccsiKey(EccsiKey* key, byte* data, word32* sz); int wc_ExportEccsiKey(EccsiKey* key, byte* data, word32* sz);
/*! /*!
\ingroup ECCSI_Setup \ingroup ECCSI_Setup
*/ */
WOLFSSL_API int wc_ImportEccsiKey(EccsiKey* key, const byte* data, word32 sz); int wc_ImportEccsiKey(EccsiKey* key, const byte* data, word32 sz);
/*! /*!
\ingroup ECCSI_Setup \ingroup ECCSI_Setup
*/ */
WOLFSSL_API int wc_ExportEccsiPrivateKey(EccsiKey* key, byte* data, word32* sz); int wc_ExportEccsiPrivateKey(EccsiKey* key, byte* data, word32* sz);
/*! /*!
\ingroup ECCSI_Setup \ingroup ECCSI_Setup
*/ */
WOLFSSL_API int wc_ImportEccsiPrivateKey(EccsiKey* key, const byte* data, int wc_ImportEccsiPrivateKey(EccsiKey* key, const byte* data,
word32 sz); word32 sz);
/*! /*!
\ingroup ECCSI_Setup \ingroup ECCSI_Setup
*/ */
WOLFSSL_API int wc_ExportEccsiPublicKey(EccsiKey* key, byte* data, word32* sz, int wc_ExportEccsiPublicKey(EccsiKey* key, byte* data, word32* sz,
int raw); int raw);
/*! /*!
\ingroup ECCSI_Setup \ingroup ECCSI_Setup
*/ */
WOLFSSL_API int wc_ImportEccsiPublicKey(EccsiKey* key, const byte* data, int wc_ImportEccsiPublicKey(EccsiKey* key, const byte* data,
word32 sz, int trusted); word32 sz, int trusted);
/*! /*!
\ingroup ECCSI_Operations \ingroup ECCSI_Operations
*/ */
WOLFSSL_API int wc_HashEccsiId(EccsiKey* key, enum wc_HashType hashType, int wc_HashEccsiId(EccsiKey* key, enum wc_HashType hashType,
const byte* id, word32 idSz, ecc_point* pvt, byte* hash, byte* hashSz); const byte* id, word32 idSz, ecc_point* pvt, byte* hash, byte* hashSz);
/*! /*!
\ingroup ECCSI_Setup \ingroup ECCSI_Setup
*/ */
WOLFSSL_API int wc_SetEccsiHash(EccsiKey* key, const byte* hash, byte hashSz); int wc_SetEccsiHash(EccsiKey* key, const byte* hash, byte hashSz);
/*! /*!
\ingroup ECCSI_Setup \ingroup ECCSI_Setup
*/ */
WOLFSSL_API int wc_SetEccsiPair(EccsiKey* key, const mp_int* ssk, int wc_SetEccsiPair(EccsiKey* key, const mp_int* ssk,
const ecc_point* pvt); const ecc_point* pvt);
/*! /*!
\ingroup ECCSI_Operations \ingroup ECCSI_Operations
*/ */
WOLFSSL_API int wc_SignEccsiHash(EccsiKey* key, WC_RNG* rng, int wc_SignEccsiHash(EccsiKey* key, WC_RNG* rng,
enum wc_HashType hashType, const byte* msg, word32 msgSz, byte* sig, enum wc_HashType hashType, const byte* msg, word32 msgSz, byte* sig,
word32* sigSz); word32* sigSz);
/*! /*!
\ingroup ECCSI_Operations \ingroup ECCSI_Operations
*/ */
WOLFSSL_API int wc_VerifyEccsiHash(EccsiKey* key, enum wc_HashType hashType, int wc_VerifyEccsiHash(EccsiKey* key, enum wc_HashType hashType,
const byte* msg, word32 msgSz, const byte* sig, word32 sigSz, const byte* msg, word32 msgSz, const byte* sig, word32 sigSz,
int* verified); int* verified);

50
doc/dox_comments/header_files/ed25519.h
View File

@ -38,7 +38,7 @@
\sa wc_ed25519_import_private_only \sa wc_ed25519_import_private_only
\sa wc_ed25519_make_key \sa wc_ed25519_make_key
*/ */
WOLFSSL_API
int wc_ed25519_make_public(ed25519_key* key, unsigned char* pubKey, int wc_ed25519_make_public(ed25519_key* key, unsigned char* pubKey,
word32 pubKeySz); word32 pubKeySz);
@ -76,7 +76,7 @@ int wc_ed25519_make_public(ed25519_key* key, unsigned char* pubKey,
\sa wc_ed25519_init \sa wc_ed25519_init
*/ */
WOLFSSL_API
int wc_ed25519_make_key(WC_RNG* rng, int keysize, ed25519_key* key); int wc_ed25519_make_key(WC_RNG* rng, int keysize, ed25519_key* key);
/*! /*!
@ -124,7 +124,7 @@ int wc_ed25519_make_key(WC_RNG* rng, int keysize, ed25519_key* key);
\sa wc_ed25519ph_sign_msg \sa wc_ed25519ph_sign_msg
\sa wc_ed25519_verify_msg \sa wc_ed25519_verify_msg
*/ */
WOLFSSL_API
int wc_ed25519_sign_msg(const byte* in, word32 inlen, byte* out, int wc_ed25519_sign_msg(const byte* in, word32 inlen, byte* out,
word32 *outlen, ed25519_key* key); word32 *outlen, ed25519_key* key);
@ -178,7 +178,7 @@ int wc_ed25519_sign_msg(const byte* in, word32 inlen, byte* out,
\sa wc_ed25519ph_sign_msg \sa wc_ed25519ph_sign_msg
\sa wc_ed25519_verify_msg \sa wc_ed25519_verify_msg
*/ */
WOLFSSL_API
int wc_ed25519ctx_sign_msg(const byte* in, word32 inlen, byte* out, int wc_ed25519ctx_sign_msg(const byte* in, word32 inlen, byte* out,
word32 *outlen, ed25519_key* key, word32 *outlen, ed25519_key* key,
const byte* context, byte contextLen); const byte* context, byte contextLen);
@ -236,7 +236,7 @@ int wc_ed25519ctx_sign_msg(const byte* in, word32 inlen, byte* out,
\sa wc_ed25519ph_sign_msg \sa wc_ed25519ph_sign_msg
\sa wc_ed25519_verify_msg \sa wc_ed25519_verify_msg
*/ */
WOLFSSL_API
int wc_ed25519ph_sign_hash(const byte* hash, word32 hashLen, byte* out, int wc_ed25519ph_sign_hash(const byte* hash, word32 hashLen, byte* out,
word32 *outLen, ed25519_key* key, word32 *outLen, ed25519_key* key,
const byte* context, byte contextLen); const byte* context, byte contextLen);
@ -292,7 +292,7 @@ int wc_ed25519ph_sign_hash(const byte* hash, word32 hashLen, byte* out,
\sa wc_ed25519ph_sign_hash \sa wc_ed25519ph_sign_hash
\sa wc_ed25519_verify_msg \sa wc_ed25519_verify_msg
*/ */
WOLFSSL_API
int wc_ed25519ph_sign_msg(const byte* in, word32 inlen, byte* out, int wc_ed25519ph_sign_msg(const byte* in, word32 inlen, byte* out,
word32 *outlen, ed25519_key* key, word32 *outlen, ed25519_key* key,
const byte* context, byte contextLen); const byte* context, byte contextLen);
@ -342,7 +342,7 @@ int wc_ed25519ph_sign_msg(const byte* in, word32 inlen, byte* out,
\sa wc_ed25519ph_verify_msg \sa wc_ed25519ph_verify_msg
\sa wc_ed25519_sign_msg \sa wc_ed25519_sign_msg
*/ */
WOLFSSL_API
int wc_ed25519_verify_msg(const byte* sig, word32 siglen, const byte* msg, int wc_ed25519_verify_msg(const byte* sig, word32 siglen, const byte* msg,
word32 msgLen, int* ret, ed25519_key* key); word32 msgLen, int* ret, ed25519_key* key);
@ -396,7 +396,7 @@ int wc_ed25519_verify_msg(const byte* sig, word32 siglen, const byte* msg,
\sa wc_ed25519ph_verify_msg \sa wc_ed25519ph_verify_msg
\sa wc_ed25519_sign_msg \sa wc_ed25519_sign_msg
*/ */
WOLFSSL_API
int wc_ed25519ctx_verify_msg(const byte* sig, word32 siglen, const byte* msg, int wc_ed25519ctx_verify_msg(const byte* sig, word32 siglen, const byte* msg,
word32 msgLen, int* ret, ed25519_key* key, word32 msgLen, int* ret, ed25519_key* key,
const byte* context, byte contextLen); const byte* context, byte contextLen);
@ -455,7 +455,7 @@ int wc_ed25519ctx_verify_msg(const byte* sig, word32 siglen, const byte* msg,
\sa wc_ed25519ph_verify_msg \sa wc_ed25519ph_verify_msg
\sa wc_ed25519_sign_msg \sa wc_ed25519_sign_msg
*/ */
WOLFSSL_API
int wc_ed25519ph_verify_hash(const byte* sig, word32 siglen, const byte* hash, int wc_ed25519ph_verify_hash(const byte* sig, word32 siglen, const byte* hash,
word32 hashLen, int* ret, ed25519_key* key, word32 hashLen, int* ret, ed25519_key* key,
const byte* context, byte contextLen); const byte* context, byte contextLen);
@ -511,7 +511,7 @@ int wc_ed25519ph_verify_hash(const byte* sig, word32 siglen, const byte* hash,
\sa wc_ed25519ph_verify_msg \sa wc_ed25519ph_verify_msg
\sa wc_ed25519_sign_msg \sa wc_ed25519_sign_msg
*/ */
WOLFSSL_API
int wc_ed25519ph_verify_msg(const byte* sig, word32 siglen, const byte* msg, int wc_ed25519ph_verify_msg(const byte* sig, word32 siglen, const byte* msg,
word32 msgLen, int* ret, ed25519_key* key, word32 msgLen, int* ret, ed25519_key* key,
const byte* context, byte contextLen); const byte* context, byte contextLen);
@ -536,7 +536,7 @@ int wc_ed25519ph_verify_msg(const byte* sig, word32 siglen, const byte* msg,
\sa wc_ed25519_make_key \sa wc_ed25519_make_key
\sa wc_ed25519_free \sa wc_ed25519_free
*/ */
WOLFSSL_API
int wc_ed25519_init(ed25519_key* key); int wc_ed25519_init(ed25519_key* key);
/*! /*!
@ -556,7 +556,7 @@ int wc_ed25519_init(ed25519_key* key);
\sa wc_ed25519_init \sa wc_ed25519_init
*/ */
WOLFSSL_API
void wc_ed25519_free(ed25519_key* key); void wc_ed25519_free(ed25519_key* key);
/*! /*!
@ -591,7 +591,7 @@ void wc_ed25519_free(ed25519_key* key);
\sa wc_ed25519_import_private_key \sa wc_ed25519_import_private_key
\sa wc_ed25519_export_public \sa wc_ed25519_export_public
*/ */
WOLFSSL_API
int wc_ed25519_import_public(const byte* in, word32 inLen, ed25519_key* key); int wc_ed25519_import_public(const byte* in, word32 inLen, ed25519_key* key);
/*! /*!
@ -628,7 +628,7 @@ int wc_ed25519_import_public(const byte* in, word32 inLen, ed25519_key* key);
\sa wc_ed25519_import_private_key \sa wc_ed25519_import_private_key
\sa wc_ed25519_export_private_only \sa wc_ed25519_export_private_only
*/ */
WOLFSSL_API
int wc_ed25519_import_private_only(const byte* priv, word32 privSz, int wc_ed25519_import_private_only(const byte* priv, word32 privSz,
ed25519_key* key); ed25519_key* key);
@ -670,7 +670,7 @@ int wc_ed25519_import_private_only(const byte* priv, word32 privSz,
\sa wc_ed25519_import_private_only \sa wc_ed25519_import_private_only
\sa wc_ed25519_export_private \sa wc_ed25519_export_private
*/ */
WOLFSSL_API
int wc_ed25519_import_private_key(const byte* priv, word32 privSz, int wc_ed25519_import_private_key(const byte* priv, word32 privSz,
const byte* pub, word32 pubSz, ed25519_key* key); const byte* pub, word32 pubSz, ed25519_key* key);
@ -712,8 +712,8 @@ int wc_ed25519_import_private_key(const byte* priv, word32 privSz,
\sa wc_ed25519_import_public \sa wc_ed25519_import_public
\sa wc_ed25519_export_private_only \sa wc_ed25519_export_private_only
*/ */
WOLFSSL_API
int wc_ed25519_export_public(ed25519_key*, byte* out, word32* outLen); int wc_ed25519_export_public(ed25519_key* key, byte* out, word32* outLen);
/*! /*!
\ingroup ED25519 \ingroup ED25519
@ -751,7 +751,7 @@ int wc_ed25519_export_public(ed25519_key*, byte* out, word32* outLen);
\sa wc_ed25519_export_public \sa wc_ed25519_export_public
\sa wc_ed25519_import_private_key \sa wc_ed25519_import_private_key
*/ */
WOLFSSL_API
int wc_ed25519_export_private_only(ed25519_key* key, byte* out, word32* outLen); int wc_ed25519_export_private_only(ed25519_key* key, byte* out, word32* outLen);
/*! /*!
@ -794,7 +794,7 @@ int wc_ed25519_export_private_only(ed25519_key* key, byte* out, word32* outLen);
\sa wc_ed25519_import_private_key \sa wc_ed25519_import_private_key
\sa wc_ed25519_export_private_only \sa wc_ed25519_export_private_only
*/ */
WOLFSSL_API
int wc_ed25519_export_private(ed25519_key* key, byte* out, word32* outLen); int wc_ed25519_export_private(ed25519_key* key, byte* out, word32* outLen);
/*! /*!
@ -841,7 +841,7 @@ int wc_ed25519_export_private(ed25519_key* key, byte* out, word32* outLen);
\sa wc_ed25519_export_private \sa wc_ed25519_export_private
\sa wc_ed25519_export_public \sa wc_ed25519_export_public
*/ */
WOLFSSL_API
int wc_ed25519_export_key(ed25519_key* key, int wc_ed25519_export_key(ed25519_key* key,
byte* priv, word32 *privSz, byte* priv, word32 *privSz,
byte* pub, word32 *pubSz); byte* pub, word32 *pubSz);
@ -875,7 +875,7 @@ int wc_ed25519_export_key(ed25519_key* key,
\sa wc_ed25519_import_private_key \sa wc_ed25519_import_private_key
*/ */
WOLFSSL_API
int wc_ed25519_check_key(ed25519_key* key); int wc_ed25519_check_key(ed25519_key* key);
/*! /*!
@ -902,7 +902,7 @@ int wc_ed25519_check_key(ed25519_key* key);
\sa wc_ed25519_make_key \sa wc_ed25519_make_key
*/ */
WOLFSSL_API
int wc_ed25519_size(ed25519_key* key); int wc_ed25519_size(ed25519_key* key);
/*! /*!
@ -931,7 +931,7 @@ int wc_ed25519_size(ed25519_key* key);
\sa wc_ed25519_pub_size \sa wc_ed25519_pub_size
*/ */
WOLFSSL_API
int wc_ed25519_priv_size(ed25519_key* key); int wc_ed25519_priv_size(ed25519_key* key);
/*! /*!
@ -959,7 +959,7 @@ int wc_ed25519_priv_size(ed25519_key* key);
\sa wc_ed25519_priv_size \sa wc_ed25519_priv_size
*/ */
WOLFSSL_API
int wc_ed25519_pub_size(ed25519_key* key); int wc_ed25519_pub_size(ed25519_key* key);
/*! /*!
@ -987,5 +987,5 @@ int wc_ed25519_pub_size(ed25519_key* key);
\sa wc_ed25519_sign_msg \sa wc_ed25519_sign_msg
*/ */
WOLFSSL_API
int wc_ed25519_sig_size(ed25519_key* key); int wc_ed25519_sig_size(ed25519_key* key);

46
doc/dox_comments/header_files/ed448.h
View File

@ -38,7 +38,7 @@
\sa wc_ed448_import_private_only \sa wc_ed448_import_private_only
\sa wc_ed448_make_key \sa wc_ed448_make_key
*/ */
WOLFSSL_API
int wc_ed448_make_public(ed448_key* key, unsigned char* pubKey, int wc_ed448_make_public(ed448_key* key, unsigned char* pubKey,
word32 pubKeySz); word32 pubKeySz);
@ -76,7 +76,7 @@ int wc_ed448_make_public(ed448_key* key, unsigned char* pubKey,
\sa wc_ed448_init \sa wc_ed448_init
*/ */
WOLFSSL_API
int wc_ed448_make_key(WC_RNG* rng, int keysize, ed448_key* key); int wc_ed448_make_key(WC_RNG* rng, int keysize, ed448_key* key);
/*! /*!
@ -123,7 +123,7 @@ int wc_ed448_make_key(WC_RNG* rng, int keysize, ed448_key* key);
\sa wc_ed448ph_sign_msg \sa wc_ed448ph_sign_msg
\sa wc_ed448_verify_msg \sa wc_ed448_verify_msg
*/ */
WOLFSSL_API
int wc_ed448_sign_msg(const byte* in, word32 inlen, byte* out, int wc_ed448_sign_msg(const byte* in, word32 inlen, byte* out,
word32 *outlen, ed448_key* key); word32 *outlen, ed448_key* key);
@ -179,7 +179,7 @@ int wc_ed448_sign_msg(const byte* in, word32 inlen, byte* out,
\sa wc_ed448ph_sign_msg \sa wc_ed448ph_sign_msg
\sa wc_ed448ph_verify_hash \sa wc_ed448ph_verify_hash
*/ */
WOLFSSL_API
int wc_ed448ph_sign_hash(const byte* hash, word32 hashLen, byte* out, int wc_ed448ph_sign_hash(const byte* hash, word32 hashLen, byte* out,
word32 *outLen, ed448_key* key, word32 *outLen, ed448_key* key,
const byte* context, byte contextLen); const byte* context, byte contextLen);
@ -234,7 +234,7 @@ int wc_ed448ph_sign_hash(const byte* hash, word32 hashLen, byte* out,
\sa wc_ed448ph_sign_hash \sa wc_ed448ph_sign_hash
\sa wc_ed448ph_verify_msg \sa wc_ed448ph_verify_msg
*/ */
WOLFSSL_API
int wc_ed448ph_sign_msg(const byte* in, word32 inLen, byte* out, int wc_ed448ph_sign_msg(const byte* in, word32 inLen, byte* out,
word32 *outLen, ed448_key* key, const byte* context, word32 *outLen, ed448_key* key, const byte* context,
byte contextLen); byte contextLen);
@ -286,7 +286,7 @@ int wc_ed448ph_sign_msg(const byte* in, word32 inLen, byte* out,
\sa wc_ed448ph_verify_msg \sa wc_ed448ph_verify_msg
\sa wc_ed448_sign_msg \sa wc_ed448_sign_msg
*/ */
WOLFSSL_API
int wc_ed448_verify_msg(const byte* sig, word32 siglen, const byte* msg, int wc_ed448_verify_msg(const byte* sig, word32 siglen, const byte* msg,
word32 msgLen, int* res, ed448_key* key, word32 msgLen, int* res, ed448_key* key,
const byte* context, byte contextLen); const byte* context, byte contextLen);
@ -341,7 +341,7 @@ int wc_ed448_verify_msg(const byte* sig, word32 siglen, const byte* msg,
\sa wc_ed448ph_verify_msg \sa wc_ed448ph_verify_msg
\sa wc_ed448ph_sign_hash \sa wc_ed448ph_sign_hash
*/ */
WOLFSSL_API
int wc_ed448ph_verify_hash(const byte* sig, word32 siglen, const byte* hash, int wc_ed448ph_verify_hash(const byte* sig, word32 siglen, const byte* hash,
word32 hashlen, int* res, ed448_key* key, word32 hashlen, int* res, ed448_key* key,
const byte* context, byte contextLen); const byte* context, byte contextLen);
@ -394,7 +394,7 @@ int wc_ed448ph_verify_hash(const byte* sig, word32 siglen, const byte* hash,
\sa wc_ed448ph_verify_hash \sa wc_ed448ph_verify_hash
\sa wc_ed448ph_sign_msg \sa wc_ed448ph_sign_msg
*/ */
WOLFSSL_API
int wc_ed448ph_verify_msg(const byte* sig, word32 siglen, const byte* msg, int wc_ed448ph_verify_msg(const byte* sig, word32 siglen, const byte* msg,
word32 msgLen, int* res, ed448_key* key, word32 msgLen, int* res, ed448_key* key,
const byte* context, byte contextLen); const byte* context, byte contextLen);
@ -419,7 +419,7 @@ int wc_ed448ph_verify_msg(const byte* sig, word32 siglen, const byte* msg,
\sa wc_ed448_make_key \sa wc_ed448_make_key
\sa wc_ed448_free \sa wc_ed448_free
*/ */
WOLFSSL_API
int wc_ed448_init(ed448_key* key); int wc_ed448_init(ed448_key* key);
/*! /*!
@ -439,7 +439,7 @@ int wc_ed448_init(ed448_key* key);
\sa wc_ed448_init \sa wc_ed448_init
*/ */
WOLFSSL_API
void wc_ed448_free(ed448_key* key); void wc_ed448_free(ed448_key* key);
/*! /*!
@ -474,7 +474,7 @@ void wc_ed448_free(ed448_key* key);
\sa wc_ed448_import_private_key \sa wc_ed448_import_private_key
\sa wc_ed448_export_public \sa wc_ed448_export_public
*/ */
WOLFSSL_API
int wc_ed448_import_public(const byte* in, word32 inLen, ed448_key* key); int wc_ed448_import_public(const byte* in, word32 inLen, ed448_key* key);
/*! /*!
@ -509,7 +509,7 @@ int wc_ed448_import_public(const byte* in, word32 inLen, ed448_key* key);
\sa wc_ed448_import_private_key \sa wc_ed448_import_private_key
\sa wc_ed448_export_private_only \sa wc_ed448_export_private_only
*/ */
WOLFSSL_API
int wc_ed448_import_private_only(const byte* priv, word32 privSz, int wc_ed448_import_private_only(const byte* priv, word32 privSz,
ed448_key* key); ed448_key* key);
@ -551,7 +551,7 @@ int wc_ed448_import_private_only(const byte* priv, word32 privSz,
\sa wc_ed448_import_private_only \sa wc_ed448_import_private_only
\sa wc_ed448_export_private \sa wc_ed448_export_private
*/ */
WOLFSSL_API
int wc_ed448_import_private_key(const byte* priv, word32 privSz, int wc_ed448_import_private_key(const byte* priv, word32 privSz,
const byte* pub, word32 pubSz, ed448_key* key); const byte* pub, word32 pubSz, ed448_key* key);
@ -593,8 +593,8 @@ int wc_ed448_import_private_key(const byte* priv, word32 privSz,
\sa wc_ed448_import_public \sa wc_ed448_import_public
\sa wc_ed448_export_private_only \sa wc_ed448_export_private_only
*/ */
WOLFSSL_API
int wc_ed448_export_public(ed448_key*, byte* out, word32* outLen); int wc_ed448_export_public(ed448_key* key, byte* out, word32* outLen);
/*! /*!
\ingroup ED448 \ingroup ED448
@ -632,7 +632,7 @@ int wc_ed448_export_public(ed448_key*, byte* out, word32* outLen);
\sa wc_ed448_export_public \sa wc_ed448_export_public
\sa wc_ed448_import_private_key \sa wc_ed448_import_private_key
*/ */
WOLFSSL_API
int wc_ed448_export_private_only(ed448_key* key, byte* out, word32* outLen); int wc_ed448_export_private_only(ed448_key* key, byte* out, word32* outLen);
/*! /*!
@ -675,7 +675,7 @@ int wc_ed448_export_private_only(ed448_key* key, byte* out, word32* outLen);
\sa wc_ed448_import_private \sa wc_ed448_import_private
\sa wc_ed448_export_private_only \sa wc_ed448_export_private_only
*/ */
WOLFSSL_API
int wc_ed448_export_private(ed448_key* key, byte* out, word32* outLen); int wc_ed448_export_private(ed448_key* key, byte* out, word32* outLen);
/*! /*!
@ -722,7 +722,7 @@ int wc_ed448_export_private(ed448_key* key, byte* out, word32* outLen);
\sa wc_ed448_export_private \sa wc_ed448_export_private
\sa wc_ed448_export_public \sa wc_ed448_export_public
*/ */
WOLFSSL_API
int wc_ed448_export_key(ed448_key* key, int wc_ed448_export_key(ed448_key* key,
byte* priv, word32 *privSz, byte* priv, word32 *privSz,
byte* pub, word32 *pubSz); byte* pub, word32 *pubSz);
@ -756,7 +756,7 @@ int wc_ed448_export_key(ed448_key* key,
\sa wc_ed448_import_private_key \sa wc_ed448_import_private_key
*/ */
WOLFSSL_API
int wc_ed448_check_key(ed448_key* key); int wc_ed448_check_key(ed448_key* key);
@ -784,7 +784,7 @@ int wc_ed448_check_key(ed448_key* key);
\sa wc_ed448_make_key \sa wc_ed448_make_key
*/ */
WOLFSSL_API
int wc_ed448_size(ed448_key* key); int wc_ed448_size(ed448_key* key);
/*! /*!
@ -813,7 +813,7 @@ int wc_ed448_size(ed448_key* key);
\sa wc_ed448_pub_size \sa wc_ed448_pub_size
*/ */
WOLFSSL_API
int wc_ed448_priv_size(ed448_key* key); int wc_ed448_priv_size(ed448_key* key);
/*! /*!
@ -840,7 +840,7 @@ int wc_ed448_priv_size(ed448_key* key);
\sa wc_ed448_priv_size \sa wc_ed448_priv_size
*/ */
WOLFSSL_API
int wc_ed448_pub_size(ed448_key* key); int wc_ed448_pub_size(ed448_key* key);
/*! /*!
@ -868,5 +868,5 @@ int wc_ed448_pub_size(ed448_key* key);
\sa wc_ed448_sign_msg \sa wc_ed448_sign_msg
*/ */
WOLFSSL_API
int wc_ed448_sig_size(ed448_key* key); int wc_ed448_sig_size(ed448_key* key);

4
doc/dox_comments/header_files/error-crypt.h
View File

@ -22,7 +22,7 @@
\sa wc_GetErrorString \sa wc_GetErrorString
*/ */
WOLFSSL_API void wc_ErrorString(int err, char* buff); void wc_ErrorString(int err, char* buff);
/*! /*!
\ingroup Error \ingroup Error
@ -46,4 +46,4 @@ WOLFSSL_API void wc_ErrorString(int err, char* buff);
\sa wc_ErrorString \sa wc_ErrorString
*/ */
WOLFSSL_API const char* wc_GetErrorString(int error); const char* wc_GetErrorString(int error);

30
doc/dox_comments/header_files/evp.h
View File

@ -20,7 +20,7 @@
\sa wolfSSL_EVP_CIPHER_CTX_init \sa wolfSSL_EVP_CIPHER_CTX_init
*/ */
WOLFSSL_API const WOLFSSL_EVP_CIPHER* wolfSSL_EVP_des_ede3_ecb(void); const WOLFSSL_EVP_CIPHER* wolfSSL_EVP_des_ede3_ecb(void);
/*! /*!
\ingroup openSSL \ingroup openSSL
@ -43,7 +43,7 @@ WOLFSSL_API const WOLFSSL_EVP_CIPHER* wolfSSL_EVP_des_ede3_ecb(void);
\sa wolfSSL_EVP_CIPHER_CTX_init \sa wolfSSL_EVP_CIPHER_CTX_init
*/ */
WOLFSSL_API const WOLFSSL_EVP_CIPHER* wolfSSL_EVP_des_cbc(void); const WOLFSSL_EVP_CIPHER* wolfSSL_EVP_des_cbc(void);
/*! /*!
\ingroup openSSL \ingroup openSSL
@ -77,7 +77,7 @@ WOLFSSL_API const WOLFSSL_EVP_CIPHER* wolfSSL_EVP_des_cbc(void);
\sa wolfCrypt_Init \sa wolfCrypt_Init
\sa wolfSSL_EVP_MD_CTX_free \sa wolfSSL_EVP_MD_CTX_free
*/ */
WOLFSSL_API int wolfSSL_EVP_DigestInit_ex(WOLFSSL_EVP_MD_CTX* ctx, int wolfSSL_EVP_DigestInit_ex(WOLFSSL_EVP_MD_CTX* ctx,
const WOLFSSL_EVP_MD* type, const WOLFSSL_EVP_MD* type,
WOLFSSL_ENGINE *impl); WOLFSSL_ENGINE *impl);
@ -122,7 +122,7 @@ WOLFSSL_API int wolfSSL_EVP_DigestInit_ex(WOLFSSL_EVP_MD_CTX* ctx,
\sa wolfCrypt_Init \sa wolfCrypt_Init
\sa wolfSSL_EVP_CIPHER_CTX_free \sa wolfSSL_EVP_CIPHER_CTX_free
*/ */
WOLFSSL_API int wolfSSL_EVP_CipherInit_ex(WOLFSSL_EVP_CIPHER_CTX* ctx, int wolfSSL_EVP_CipherInit_ex(WOLFSSL_EVP_CIPHER_CTX* ctx,
const WOLFSSL_EVP_CIPHER* type, const WOLFSSL_EVP_CIPHER* type,
WOLFSSL_ENGINE *impl, WOLFSSL_ENGINE *impl,
const unsigned char* key, const unsigned char* key,
@ -163,7 +163,7 @@ WOLFSSL_API int wolfSSL_EVP_CipherInit_ex(WOLFSSL_EVP_CIPHER_CTX* ctx,
\sa wolfCrypt_Init \sa wolfCrypt_Init
\sa wolfSSL_EVP_CIPHER_CTX_free \sa wolfSSL_EVP_CIPHER_CTX_free
*/ */
WOLFSSL_API int wolfSSL_EVP_EncryptInit_ex(WOLFSSL_EVP_CIPHER_CTX* ctx, int wolfSSL_EVP_EncryptInit_ex(WOLFSSL_EVP_CIPHER_CTX* ctx,
const WOLFSSL_EVP_CIPHER* type, const WOLFSSL_EVP_CIPHER* type,
WOLFSSL_ENGINE *impl, WOLFSSL_ENGINE *impl,
const unsigned char* key, const unsigned char* key,
@ -212,7 +212,7 @@ WOLFSSL_API int wolfSSL_EVP_EncryptInit_ex(WOLFSSL_EVP_CIPHER_CTX* ctx,
\sa wolfCrypt_Init \sa wolfCrypt_Init
\sa wolfSSL_EVP_CIPHER_CTX_free \sa wolfSSL_EVP_CIPHER_CTX_free
*/ */
WOLFSSL_API int wolfSSL_EVP_DecryptInit_ex(WOLFSSL_EVP_CIPHER_CTX* ctx, int wolfSSL_EVP_DecryptInit_ex(WOLFSSL_EVP_CIPHER_CTX* ctx,
const WOLFSSL_EVP_CIPHER* type, const WOLFSSL_EVP_CIPHER* type,
WOLFSSL_ENGINE *impl, WOLFSSL_ENGINE *impl,
const unsigned char* key, const unsigned char* key,
@ -254,7 +254,7 @@ WOLFSSL_API int wolfSSL_EVP_DecryptInit_ex(WOLFSSL_EVP_CIPHER_CTX* ctx,
\sa wolfCrypt_Init \sa wolfCrypt_Init
\sa wolfSSL_EVP_CIPHER_CTX_free \sa wolfSSL_EVP_CIPHER_CTX_free
*/ */
WOLFSSL_API int wolfSSL_EVP_CipherUpdate(WOLFSSL_EVP_CIPHER_CTX *ctx, int wolfSSL_EVP_CipherUpdate(WOLFSSL_EVP_CIPHER_CTX *ctx,
unsigned char *out, int *outl, unsigned char *out, int *outl,
const unsigned char *in, int inl); const unsigned char *in, int inl);
@ -286,7 +286,7 @@ WOLFSSL_API int wolfSSL_EVP_CipherUpdate(WOLFSSL_EVP_CIPHER_CTX *ctx,
\sa wolfSSL_EVP_CIPHER_CTX_new \sa wolfSSL_EVP_CIPHER_CTX_new
*/ */
WOLFSSL_API int wolfSSL_EVP_CipherFinal(WOLFSSL_EVP_CIPHER_CTX *ctx, int wolfSSL_EVP_CipherFinal(WOLFSSL_EVP_CIPHER_CTX *ctx,
unsigned char *out, int *outl); unsigned char *out, int *outl);
/*! /*!
@ -310,7 +310,7 @@ WOLFSSL_API int wolfSSL_EVP_CipherFinal(WOLFSSL_EVP_CIPHER_CTX *ctx,
\sa wolfSSL_EVP_CIPHER_flags \sa wolfSSL_EVP_CIPHER_flags
*/ */
WOLFSSL_API int wolfSSL_EVP_CIPHER_CTX_set_key_length(WOLFSSL_EVP_CIPHER_CTX* ctx, int wolfSSL_EVP_CIPHER_CTX_set_key_length(WOLFSSL_EVP_CIPHER_CTX* ctx,
int keylen); int keylen);
/*! /*!
@ -331,7 +331,7 @@ WOLFSSL_API int wolfSSL_EVP_CIPHER_CTX_set_key_length(WOLFSSL_EVP_CIPHER_CTX* c
\sa wolfSSL_EVP_CIPHER_block_size \sa wolfSSL_EVP_CIPHER_block_size
*/ */
WOLFSSL_API int wolfSSL_EVP_CIPHER_CTX_block_size(const WOLFSSL_EVP_CIPHER_CTX *ctx); int wolfSSL_EVP_CIPHER_CTX_block_size(const WOLFSSL_EVP_CIPHER_CTX *ctx);
/*! /*!
\ingroup openSSL \ingroup openSSL
@ -350,7 +350,7 @@ WOLFSSL_API int wolfSSL_EVP_CIPHER_CTX_block_size(const WOLFSSL_EVP_CIPHER_CTX *
\sa wolfSSL_EVP_aes_256_ctr \sa wolfSSL_EVP_aes_256_ctr
*/ */
WOLFSSL_API int wolfSSL_EVP_CIPHER_block_size(const WOLFSSL_EVP_CIPHER *cipher); int wolfSSL_EVP_CIPHER_block_size(const WOLFSSL_EVP_CIPHER *cipher);
/*! /*!
\ingroup openSSL \ingroup openSSL
@ -373,7 +373,7 @@ WOLFSSL_API int wolfSSL_EVP_CIPHER_block_size(const WOLFSSL_EVP_CIPHER *cipher);
\sa wolfSSL_EVP_CIPHER_flags \sa wolfSSL_EVP_CIPHER_flags
\sa wolfSSL_EVP_CIPHER_CTX_flags \sa wolfSSL_EVP_CIPHER_CTX_flags
*/ */
WOLFSSL_API void wolfSSL_EVP_CIPHER_CTX_set_flags(WOLFSSL_EVP_CIPHER_CTX *ctx, int flags); void wolfSSL_EVP_CIPHER_CTX_set_flags(WOLFSSL_EVP_CIPHER_CTX *ctx, int flags);
/*! /*!
\ingroup openSSL \ingroup openSSL
@ -396,7 +396,7 @@ WOLFSSL_API void wolfSSL_EVP_CIPHER_CTX_set_flags(WOLFSSL_EVP_CIPHER_CTX *ctx, i
\sa wolfSSL_EVP_CIPHER_flags \sa wolfSSL_EVP_CIPHER_flags
\sa wolfSSL_EVP_CIPHER_CTX_flags \sa wolfSSL_EVP_CIPHER_CTX_flags
*/ */
WOLFSSL_API void wolfSSL_EVP_CIPHER_CTX_clear_flags(WOLFSSL_EVP_CIPHER_CTX *ctx, int flags); void wolfSSL_EVP_CIPHER_CTX_clear_flags(WOLFSSL_EVP_CIPHER_CTX *ctx, int flags);
/*! /*!
\ingroup openSSL \ingroup openSSL
@ -418,7 +418,7 @@ WOLFSSL_API void wolfSSL_EVP_CIPHER_CTX_clear_flags(WOLFSSL_EVP_CIPHER_CTX *ctx,
\sa wolfSSL_EVP_CIPHER_CTX_new \sa wolfSSL_EVP_CIPHER_CTX_new
*/ */
WOLFSSL_API int wolfSSL_EVP_CIPHER_CTX_set_padding(WOLFSSL_EVP_CIPHER_CTX *c, int pad); int wolfSSL_EVP_CIPHER_CTX_set_padding(WOLFSSL_EVP_CIPHER_CTX *c, int pad);
/*! /*!
@ -441,4 +441,4 @@ WOLFSSL_API int wolfSSL_EVP_CIPHER_CTX_set_padding(WOLFSSL_EVP_CIPHER_CTX *c, i
\sa wolfSSL_EVP_CIPHER_CTX_new \sa wolfSSL_EVP_CIPHER_CTX_new
\sa wolfSSL_EVP_CIPHER_flags \sa wolfSSL_EVP_CIPHER_flags
*/ */
WOLFSSL_API unsigned long wolfSSL_EVP_CIPHER_CTX_flags(const WOLFSSL_EVP_CIPHER_CTX *ctx); unsigned long wolfSSL_EVP_CIPHER_CTX_flags(const WOLFSSL_EVP_CIPHER_CTX *ctx);

18
doc/dox_comments/header_files/hash.h
View File

@ -22,7 +22,7 @@
\sa wc_HashGetDigestSize \sa wc_HashGetDigestSize
\sa wc_Hash \sa wc_Hash
*/ */
WOLFSSL_API int wc_HashGetOID(enum wc_HashType hash_type); int wc_HashGetOID(enum wc_HashType hash_type);
/*! /*!
\ingroup wolfCrypt \ingroup wolfCrypt
@ -50,7 +50,7 @@ WOLFSSL_API int wc_HashGetOID(enum wc_HashType hash_type);
\sa wc_Hash \sa wc_Hash
*/ */
WOLFSSL_API int wc_HashGetDigestSize(enum wc_HashType hash_type); int wc_HashGetDigestSize(enum wc_HashType hash_type);
/*! /*!
\ingroup wolfCrypt \ingroup wolfCrypt
@ -81,7 +81,7 @@ WOLFSSL_API int wc_HashGetDigestSize(enum wc_HashType hash_type);
\sa wc_HashGetDigestSize \sa wc_HashGetDigestSize
*/ */
WOLFSSL_API int wc_Hash(enum wc_HashType hash_type, int wc_Hash(enum wc_HashType hash_type,
const byte* data, word32 data_len, const byte* data, word32 data_len,
byte* hash, word32 hash_len); byte* hash, word32 hash_len);
@ -116,7 +116,7 @@ WOLFSSL_API int wc_Hash(enum wc_HashType hash_type,
\sa wc_Md5Final \sa wc_Md5Final
\sa wc_InitMd5 \sa wc_InitMd5
*/ */
WOLFSSL_API int wc_Md5Hash(const byte* data, word32 len, byte* hash); int wc_Md5Hash(const byte* data, word32 len, byte* hash);
/*! /*!
\ingroup SHA \ingroup SHA
@ -141,7 +141,7 @@ WOLFSSL_API int wc_Md5Hash(const byte* data, word32 len, byte* hash);
\sa wc_ShaFinal \sa wc_ShaFinal
\sa wc_InitSha \sa wc_InitSha
*/ */
WOLFSSL_API int wc_ShaHash(const byte*, word32, byte*); int wc_ShaHash(const byte* data, word32 len, byte* hash);
/*! /*!
\ingroup SHA \ingroup SHA
@ -166,7 +166,7 @@ WOLFSSL_API int wc_ShaHash(const byte*, word32, byte*);
\sa wc_Sha256Final \sa wc_Sha256Final
\sa wc_InitSha256 \sa wc_InitSha256
*/ */
WOLFSSL_API int wc_Sha256Hash(const byte*, word32, byte*); int wc_Sha256Hash(const byte* data, word32 len, byte* hash);
/*! /*!
\ingroup SHA \ingroup SHA
@ -190,7 +190,7 @@ WOLFSSL_API int wc_Sha256Hash(const byte*, word32, byte*);
\sa wc_Sha224Update \sa wc_Sha224Update
\sa wc_Sha224Final \sa wc_Sha224Final
*/ */
WOLFSSL_API int wc_Sha224Hash(const byte*, word32, byte*); int wc_Sha224Hash(const byte* data, word32 len, byte* hash);
/*! /*!
\ingroup SHA \ingroup SHA
@ -215,7 +215,7 @@ WOLFSSL_API int wc_Sha224Hash(const byte*, word32, byte*);
\sa wc_Sha512Final \sa wc_Sha512Final
\sa wc_InitSha512 \sa wc_InitSha512
*/ */
WOLFSSL_API int wc_Sha512Hash(const byte*, word32, byte*); int wc_Sha512Hash(const byte* data, word32 len, byte* hash);
/*! /*!
\ingroup SHA \ingroup SHA
@ -240,4 +240,4 @@ WOLFSSL_API int wc_Sha512Hash(const byte*, word32, byte*);
\sa wc_Sha384Final \sa wc_Sha384Final
\sa wc_InitSha384 \sa wc_InitSha384
*/ */
WOLFSSL_API int wc_Sha384Hash(const byte*, word32, byte*); int wc_Sha384Hash(const byte* data, word32 len, byte* hash);

10
doc/dox_comments/header_files/hmac.h
View File

@ -34,7 +34,7 @@
\sa wc_HmacUpdate \sa wc_HmacUpdate
\sa wc_HmacFinal \sa wc_HmacFinal
*/ */
WOLFSSL_API int wc_HmacSetKey(Hmac*, int type, const byte* key, word32 keySz); int wc_HmacSetKey(Hmac* hmac, int type, const byte* key, word32 keySz);
/*! /*!
\ingroup HMAC \ingroup HMAC
@ -70,7 +70,7 @@ WOLFSSL_API int wc_HmacSetKey(Hmac*, int type, const byte* key, word32 keySz);
\sa wc_HmacSetKey \sa wc_HmacSetKey
\sa wc_HmacFinal \sa wc_HmacFinal
*/ */
WOLFSSL_API int wc_HmacUpdate(Hmac*, const byte*, word32); int wc_HmacUpdate(Hmac* hmac, const byte* in, word32 sz);
/*! /*!
\ingroup HMAC \ingroup HMAC
@ -101,7 +101,7 @@ WOLFSSL_API int wc_HmacUpdate(Hmac*, const byte*, word32);
\sa wc_HmacSetKey \sa wc_HmacSetKey
\sa wc_HmacUpdate \sa wc_HmacUpdate
*/ */
WOLFSSL_API int wc_HmacFinal(Hmac*, byte*); int wc_HmacFinal(Hmac* hmac, byte* out);
/*! /*!
\ingroup HMAC \ingroup HMAC
@ -121,7 +121,7 @@ WOLFSSL_API int wc_HmacFinal(Hmac*, byte*);
\sa none \sa none
*/ */
WOLFSSL_API int wolfSSL_GetHmacMaxSize(void); int wolfSSL_GetHmacMaxSize(void);
/*! /*!
\ingroup HMAC \ingroup HMAC
@ -169,7 +169,7 @@ WOLFSSL_API int wolfSSL_GetHmacMaxSize(void);
\sa wc_HmacSetKey \sa wc_HmacSetKey
*/ */
WOLFSSL_API int wc_HKDF(int type, const byte* inKey, word32 inKeySz, int wc_HKDF(int type, const byte* inKey, word32 inKeySz,
const byte* salt, word32 saltSz, const byte* salt, word32 saltSz,
const byte* info, word32 infoSz, const byte* info, word32 infoSz,
byte* out, word32 outSz); byte* out, word32 outSz);

38
doc/dox_comments/header_files/iotsafe.h
View File

@ -19,7 +19,7 @@
\sa wolfIoTSafe_SetCSIM_read_cb \sa wolfIoTSafe_SetCSIM_read_cb
\sa wolfIoTSafe_SetCSIM_write_cb \sa wolfIoTSafe_SetCSIM_write_cb
*/ */
WOLFSSL_API int wolfSSL_CTX_iotsafe_enable(WOLFSSL_CTX *ctx); int wolfSSL_CTX_iotsafe_enable(WOLFSSL_CTX *ctx);
/*! /*!
@ -61,7 +61,7 @@ WOLFSSL_API int wolfSSL_CTX_iotsafe_enable(WOLFSSL_CTX *ctx);
\sa wolfSSL_iotsafe_on_ex \sa wolfSSL_iotsafe_on_ex
\sa wolfSSL_CTX_iotsafe_enable \sa wolfSSL_CTX_iotsafe_enable
*/ */
WOLFSSL_API int wolfSSL_iotsafe_on(WOLFSSL *ssl, byte privkey_id, int wolfSSL_iotsafe_on(WOLFSSL *ssl, byte privkey_id,
byte ecdh_keypair_slot, byte peer_pubkey_slot, byte peer_cert_slot); byte ecdh_keypair_slot, byte peer_pubkey_slot, byte peer_cert_slot);
@ -114,7 +114,7 @@ WOLFSSL_API int wolfSSL_iotsafe_on(WOLFSSL *ssl, byte privkey_id,
\sa wolfSSL_iotsafe_on \sa wolfSSL_iotsafe_on
\sa wolfSSL_CTX_iotsafe_enable \sa wolfSSL_CTX_iotsafe_enable
*/ */
WOLFSSL_API int wolfSSL_iotsafe_on_ex(WOLFSSL *ssl, byte *privkey_id, int wolfSSL_iotsafe_on_ex(WOLFSSL *ssl, byte *privkey_id,
byte *ecdh_keypair_slot, byte *peer_pubkey_slot, byte *peer_cert_slot, word16 id_size); byte *ecdh_keypair_slot, byte *peer_pubkey_slot, byte *peer_cert_slot, word16 id_size);
@ -141,7 +141,7 @@ WOLFSSL_API int wolfSSL_iotsafe_on_ex(WOLFSSL *ssl, byte *privkey_id,
\sa wolfIoTSafe_SetCSIM_write_cb \sa wolfIoTSafe_SetCSIM_write_cb
*/ */
WOLFSSL_API void wolfIoTSafe_SetCSIM_read_cb(wolfSSL_IOTSafe_CSIM_read_cb rf); void wolfIoTSafe_SetCSIM_read_cb(wolfSSL_IOTSafe_CSIM_read_cb rf);
/*! /*!
\ingroup IoTSafe \ingroup IoTSafe
@ -161,7 +161,7 @@ WOLFSSL_API void wolfIoTSafe_SetCSIM_read_cb(wolfSSL_IOTSafe_CSIM_read_cb rf);
\sa wolfIoTSafe_SetCSIM_read_cb \sa wolfIoTSafe_SetCSIM_read_cb
*/ */
WOLFSSL_API void wolfIoTSafe_SetCSIM_write_cb(wolfSSL_IOTSafe_CSIM_write_cb wf); void wolfIoTSafe_SetCSIM_write_cb(wolfSSL_IOTSafe_CSIM_write_cb wf);
@ -175,7 +175,7 @@ WOLFSSL_API void wolfIoTSafe_SetCSIM_write_cb(wolfSSL_IOTSafe_CSIM_write_cb wf);
\return 0 upon success \return 0 upon success
*/ */
WOLFSSL_API int wolfIoTSafe_GetRandom(unsigned char* out, word32 sz); int wolfIoTSafe_GetRandom(unsigned char* out, word32 sz);
/*! /*!
@ -211,7 +211,7 @@ WOLFSSL_API int wolfIoTSafe_GetRandom(unsigned char* out, word32 sz);
\endcode \endcode
*/ */
WOLFSSL_API int wolfIoTSafe_GetCert(uint8_t id, unsigned char *output, unsigned long sz); int wolfIoTSafe_GetCert(uint8_t id, unsigned char *output, unsigned long sz);
/*! /*!
@ -254,7 +254,7 @@ WOLFSSL_API int wolfIoTSafe_GetCert(uint8_t id, unsigned char *output, unsigned
\endcode \endcode
*/ */
WOLFSSL_API int wolfIoTSafe_GetCert_ex(uint8_t *id, uint16_t id_sz, unsigned char *output, unsigned long sz); int wolfIoTSafe_GetCert_ex(uint8_t *id, uint16_t id_sz, unsigned char *output, unsigned long sz);
/*! /*!
\ingroup IoTSafe \ingroup IoTSafe
@ -271,7 +271,7 @@ WOLFSSL_API int wolfIoTSafe_GetCert_ex(uint8_t *id, uint16_t id_sz, unsigned cha
\sa wc_iotsafe_ecc_export_private \sa wc_iotsafe_ecc_export_private
*/ */
WOLFSSL_API int wc_iotsafe_ecc_import_public(ecc_key *key, byte key_id); int wc_iotsafe_ecc_import_public(ecc_key *key, byte key_id);
/*! /*!
\ingroup IoTSafe \ingroup IoTSafe
@ -286,7 +286,7 @@ WOLFSSL_API int wc_iotsafe_ecc_import_public(ecc_key *key, byte key_id);
\sa wc_iotsafe_ecc_export_private \sa wc_iotsafe_ecc_export_private
*/ */
WOLFSSL_API int wc_iotsafe_ecc_export_public(ecc_key *key, byte key_id); int wc_iotsafe_ecc_export_public(ecc_key *key, byte key_id);
/*! /*!
@ -306,7 +306,7 @@ WOLFSSL_API int wc_iotsafe_ecc_export_public(ecc_key *key, byte key_id);
\sa wc_iotsafe_ecc_export_private \sa wc_iotsafe_ecc_export_private
*/ */
WOLFSSL_API int wc_iotsafe_ecc_import_public_ex(ecc_key *key, byte *key_id, word16 id_size); int wc_iotsafe_ecc_import_public_ex(ecc_key *key, byte *key_id, word16 id_size);
/*! /*!
\ingroup IoTSafe \ingroup IoTSafe
@ -322,7 +322,7 @@ WOLFSSL_API int wc_iotsafe_ecc_import_public_ex(ecc_key *key, byte *key_id, word
\sa wc_iotsafe_ecc_export_public \sa wc_iotsafe_ecc_export_public
*/ */
WOLFSSL_API int wc_iotsafe_ecc_export_private(ecc_key *key, byte key_id); int wc_iotsafe_ecc_export_private(ecc_key *key, byte key_id);
/*! /*!
\ingroup IoTSafe \ingroup IoTSafe
@ -342,7 +342,7 @@ WOLFSSL_API int wc_iotsafe_ecc_export_private(ecc_key *key, byte key_id);
\sa wc_iotsafe_ecc_export_public \sa wc_iotsafe_ecc_export_public
*/ */
WOLFSSL_API int wc_iotsafe_ecc_export_private_ex(ecc_key *key, byte *key_id, word16 id_size); int wc_iotsafe_ecc_export_private_ex(ecc_key *key, byte *key_id, word16 id_size);
/*! /*!
\ingroup IoTSafe \ingroup IoTSafe
@ -363,7 +363,7 @@ WOLFSSL_API int wc_iotsafe_ecc_export_private_ex(ecc_key *key, byte *key_id, wor
\sa wc_iotsafe_ecc_gen_k \sa wc_iotsafe_ecc_gen_k
*/ */
WOLFSSL_API int wc_iotsafe_ecc_sign_hash(byte *in, word32 inlen, byte *out, word32 *outlen, byte key_id); int wc_iotsafe_ecc_sign_hash(byte *in, word32 inlen, byte *out, word32 *outlen, byte key_id);
/*! /*!
\ingroup IoTSafe \ingroup IoTSafe
@ -386,7 +386,7 @@ WOLFSSL_API int wc_iotsafe_ecc_sign_hash(byte *in, word32 inlen, byte *out, word
\sa wc_iotsafe_ecc_gen_k \sa wc_iotsafe_ecc_gen_k
*/ */
WOLFSSL_API int wc_iotsafe_ecc_sign_hash_ex(byte *in, word32 inlen, byte *out, word32 *outlen, byte *key_id, word16 id_size); int wc_iotsafe_ecc_sign_hash_ex(byte *in, word32 inlen, byte *out, word32 *outlen, byte *key_id, word16 id_size);
/*! /*!
\ingroup IoTSafe \ingroup IoTSafe
@ -408,7 +408,7 @@ WOLFSSL_API int wc_iotsafe_ecc_sign_hash_ex(byte *in, word32 inlen, byte *out, w
\sa wc_iotsafe_ecc_gen_k \sa wc_iotsafe_ecc_gen_k
*/ */
WOLFSSL_API int wc_iotsafe_ecc_verify_hash(byte *sig, word32 siglen, byte *hash, word32 hashlen, int *res, byte key_id); int wc_iotsafe_ecc_verify_hash(byte *sig, word32 siglen, byte *hash, word32 hashlen, int *res, byte key_id);
/*! /*!
\ingroup IoTSafe \ingroup IoTSafe
@ -433,7 +433,7 @@ WOLFSSL_API int wc_iotsafe_ecc_verify_hash(byte *sig, word32 siglen, byte *hash,
\sa wc_iotsafe_ecc_gen_k \sa wc_iotsafe_ecc_gen_k
*/ */
WOLFSSL_API int wc_iotsafe_ecc_verify_hash_ex(byte *sig, word32 siglen, byte *hash, word32 hashlen, int *res, byte *key_id, word16 id_size); int wc_iotsafe_ecc_verify_hash_ex(byte *sig, word32 siglen, byte *hash, word32 hashlen, int *res, byte *key_id, word16 id_size);
/*! /*!
\ingroup IoTSafe \ingroup IoTSafe
@ -446,7 +446,7 @@ WOLFSSL_API int wc_iotsafe_ecc_verify_hash_ex(byte *sig, word32 siglen, byte *ha
\sa wc_iotsafe_ecc_sign_hash \sa wc_iotsafe_ecc_sign_hash
\sa wc_iotsafe_ecc_verify_hash \sa wc_iotsafe_ecc_verify_hash
*/ */
WOLFSSL_API int wc_iotsafe_ecc_gen_k(byte key_id); int wc_iotsafe_ecc_gen_k(byte key_id);
/*! /*!
\ingroup IoTSafe \ingroup IoTSafe
@ -462,4 +462,4 @@ WOLFSSL_API int wc_iotsafe_ecc_gen_k(byte key_id);
\sa wc_iotsafe_ecc_sign_hash_ex \sa wc_iotsafe_ecc_sign_hash_ex
\sa wc_iotsafe_ecc_verify_hash_ex \sa wc_iotsafe_ecc_verify_hash_ex
*/ */
WOLFSSL_API int wc_iotsafe_ecc_gen_k(byte key_id); int wc_iotsafe_ecc_gen_k(byte key_id);

6
doc/dox_comments/header_files/logging.h
View File

@ -32,7 +32,7 @@
\sa wolfSSL_Debugging_ON \sa wolfSSL_Debugging_ON
\sa wolfSSL_Debugging_OFF \sa wolfSSL_Debugging_OFF
*/ */
WOLFSSL_API int wolfSSL_SetLoggingCb(wolfSSL_Logging_cb log_function); int wolfSSL_SetLoggingCb(wolfSSL_Logging_cb log_function);
/*! /*!
\ingroup Debug \ingroup Debug
@ -55,7 +55,7 @@ WOLFSSL_API int wolfSSL_SetLoggingCb(wolfSSL_Logging_cb log_function);
\sa wolfSSL_Debugging_OFF \sa wolfSSL_Debugging_OFF
\sa wolfSSL_SetLoggingCb \sa wolfSSL_SetLoggingCb
*/ */
WOLFSSL_API int wolfSSL_Debugging_ON(void); int wolfSSL_Debugging_ON(void);
/*! /*!
\ingroup Debug \ingroup Debug
@ -75,4 +75,4 @@ WOLFSSL_API int wolfSSL_Debugging_ON(void);
\sa wolfSSL_Debugging_ON \sa wolfSSL_Debugging_ON
\sa wolfSSL_SetLoggingCb \sa wolfSSL_SetLoggingCb
*/ */
WOLFSSL_API void wolfSSL_Debugging_OFF(void); void wolfSSL_Debugging_OFF(void);

8
doc/dox_comments/header_files/md2.h
View File

@ -24,7 +24,7 @@
\sa wc_Md2Update \sa wc_Md2Update
\sa wc_Md2Final \sa wc_Md2Final
*/ */
WOLFSSL_API void wc_InitMd2(Md2*); void wc_InitMd2(Md2*);
/*! /*!
\ingroup MD2 \ingroup MD2
@ -57,7 +57,7 @@ WOLFSSL_API void wc_InitMd2(Md2*);
\sa wc_Md2Final \sa wc_Md2Final
\sa wc_InitMd2 \sa wc_InitMd2
*/ */
WOLFSSL_API void wc_Md2Update(Md2*, const byte*, word32); void wc_Md2Update(Md2* md2, const byte* data, word32 len);
/*! /*!
\ingroup MD2 \ingroup MD2
@ -88,7 +88,7 @@ WOLFSSL_API void wc_Md2Update(Md2*, const byte*, word32);
\sa wc_Md2Final \sa wc_Md2Final
\sa wc_InitMd2 \sa wc_InitMd2
*/ */
WOLFSSL_API void wc_Md2Final(Md2*, byte*); void wc_Md2Final(Md2* md2, byte* hash);
/*! /*!
\ingroup MD2 \ingroup MD2
@ -113,4 +113,4 @@ WOLFSSL_API void wc_Md2Final(Md2*, byte*);
\sa wc_Md2Final \sa wc_Md2Final
\sa wc_InitMd2 \sa wc_InitMd2
*/ */
WOLFSSL_API int wc_Md2Hash(const byte*, word32, byte*); int wc_Md2Hash(const byte* data, word32 len, byte* hash);

6
doc/dox_comments/header_files/md4.h
View File

@ -24,7 +24,7 @@
\sa wc_Md4Update \sa wc_Md4Update
\sa wc_Md4Final \sa wc_Md4Final
*/ */
WOLFSSL_API void wc_InitMd4(Md4*); void wc_InitMd4(Md4*);
/*! /*!
\ingroup MD4 \ingroup MD4
@ -57,7 +57,7 @@ WOLFSSL_API void wc_InitMd4(Md4*);
\sa wc_Md4Final \sa wc_Md4Final
\sa wc_InitMd4 \sa wc_InitMd4
*/ */
WOLFSSL_API void wc_Md4Update(Md4*, const byte*, word32); void wc_Md4Update(Md4* md4, const byte* data, word32 len);
/*! /*!
\ingroup MD4 \ingroup MD4
@ -85,4 +85,4 @@ WOLFSSL_API void wc_Md4Update(Md4*, const byte*, word32);
\sa wc_Md4Final \sa wc_Md4Final
\sa wc_InitMd4 \sa wc_InitMd4
*/ */
WOLFSSL_API void wc_Md4Final(Md4*, byte*); void wc_Md4Final(Md4* md4, byte* hash);

10
doc/dox_comments/header_files/md5.h
View File

@ -33,7 +33,7 @@
\sa wc_Md5Update \sa wc_Md5Update
\sa wc_Md5Final \sa wc_Md5Final
*/ */
WOLFSSL_API int wc_InitMd5(wc_Md5*); int wc_InitMd5(wc_Md5*);
/*! /*!
\ingroup MD5 \ingroup MD5
@ -75,7 +75,7 @@ WOLFSSL_API int wc_InitMd5(wc_Md5*);
\sa wc_Md5Final \sa wc_Md5Final
\sa wc_InitMd5 \sa wc_InitMd5
*/ */
WOLFSSL_API int wc_Md5Update(wc_Md5*, const byte*, word32); int wc_Md5Update(wc_Md5* md5, const byte* data, word32 len);
/*! /*!
\ingroup MD5 \ingroup MD5
@ -116,7 +116,7 @@ WOLFSSL_API int wc_Md5Update(wc_Md5*, const byte*, word32);
\sa wc_InitMd5 \sa wc_InitMd5
\sa wc_Md5GetHash \sa wc_Md5GetHash
*/ */
WOLFSSL_API int wc_Md5Final(wc_Md5*, byte*); int wc_Md5Final(wc_Md5* md5, byte* hash);
/*! /*!
\ingroup MD5 \ingroup MD5
@ -148,7 +148,7 @@ WOLFSSL_API int wc_Md5Final(wc_Md5*, byte*);
\sa wc_Md5Update \sa wc_Md5Update
\sa wc_Md5Final \sa wc_Md5Final
*/ */
WOLFSSL_API void wc_Md5Free(wc_Md5*); void wc_Md5Free(wc_Md5*);
/*! /*!
\ingroup MD5 \ingroup MD5
@ -177,4 +177,4 @@ WOLFSSL_API void wc_Md5Free(wc_Md5*);
\sa wc_Md5Final \sa wc_Md5Final
\sa wc_InitMd5 \sa wc_InitMd5
*/ */
WOLFSSL_API int wc_Md5GetHash(wc_Md5*, byte*); int wc_Md5GetHash(wc_Md5* md5, byte* hash);

12
doc/dox_comments/header_files/memory.h
View File

@ -29,7 +29,7 @@
\sa XFREE \sa XFREE
\sa XREALLOC \sa XREALLOC
*/ */
WOLFSSL_API void* wolfSSL_Malloc(size_t size, void* heap, int type); void* wolfSSL_Malloc(size_t size, void* heap, int type);
/*! /*!
\ingroup Memory \ingroup Memory
@ -65,7 +65,7 @@ WOLFSSL_API void* wolfSSL_Malloc(size_t size, void* heap, int type);
\sa XFREE \sa XFREE
\sa XREALLOC \sa XREALLOC
*/ */
WOLFSSL_API void wolfSSL_Free(void *ptr, void* heap, int type); void wolfSSL_Free(void *ptr, void* heap, int type);
/*! /*!
\ingroup Memory \ingroup Memory
@ -101,7 +101,7 @@ WOLFSSL_API void wolfSSL_Free(void *ptr, void* heap, int type);
\sa XFREE \sa XFREE
\sa XREALLOC \sa XREALLOC
*/ */
WOLFSSL_API void* wolfSSL_Realloc(void *ptr, size_t size, void* heap, int type); void* wolfSSL_Realloc(void *ptr, size_t size, void* heap, int type);
/*! /*!
\ingroup Memory \ingroup Memory
@ -148,7 +148,7 @@ WOLFSSL_API void* wolfSSL_Realloc(void *ptr, size_t size, void* heap, int type);
\sa none \sa none
*/ */
WOLFSSL_API int wolfSSL_SetAllocators(wolfSSL_Malloc_cb, int wolfSSL_SetAllocators(wolfSSL_Malloc_cb,
wolfSSL_Free_cb, wolfSSL_Free_cb,
wolfSSL_Realloc_cb); wolfSSL_Realloc_cb);
@ -184,7 +184,7 @@ WOLFSSL_API int wolfSSL_SetAllocators(wolfSSL_Malloc_cb,
\sa wolfSSL_Malloc \sa wolfSSL_Malloc
\sa wolfSSL_Free \sa wolfSSL_Free
*/ */
WOLFSSL_API int wolfSSL_StaticBufferSz(byte* buffer, word32 sz, int flag); int wolfSSL_StaticBufferSz(byte* buffer, word32 sz, int flag);
/*! /*!
\ingroup Memory \ingroup Memory
@ -216,4 +216,4 @@ WOLFSSL_API int wolfSSL_StaticBufferSz(byte* buffer, word32 sz, int flag);
\sa wolfSSL_Malloc \sa wolfSSL_Malloc
\sa wolfSSL_Free \sa wolfSSL_Free
*/ */
WOLFSSL_API int wolfSSL_MemoryPaddingSz(void); int wolfSSL_MemoryPaddingSz(void);

2
doc/dox_comments/header_files/pem.h
View File

@ -27,7 +27,7 @@
\sa wolfSSL_PEM_read_bio_X509_AUX \sa wolfSSL_PEM_read_bio_X509_AUX
*/ */
WOLFSSL_API
int wolfSSL_PEM_write_bio_PrivateKey(WOLFSSL_BIO* bio, WOLFSSL_EVP_PKEY* key, int wolfSSL_PEM_write_bio_PrivateKey(WOLFSSL_BIO* bio, WOLFSSL_EVP_PKEY* key,
const WOLFSSL_EVP_CIPHER* cipher, const WOLFSSL_EVP_CIPHER* cipher,
unsigned char* passwd, int len, unsigned char* passwd, int len,

16
doc/dox_comments/header_files/pkcs11.h
View File

@ -1,43 +1,43 @@
/*! /*!
\ingroup PKCS11 \ingroup PKCS11
*/ */
WOLFSSL_API int wc_Pkcs11_Initialize(Pkcs11Dev* dev, const char* library, int wc_Pkcs11_Initialize(Pkcs11Dev* dev, const char* library,
void* heap); void* heap);
/*! /*!
\ingroup PKCS11 \ingroup PKCS11
*/ */
WOLFSSL_API void wc_Pkcs11_Finalize(Pkcs11Dev* dev); void wc_Pkcs11_Finalize(Pkcs11Dev* dev);
/*! /*!
\ingroup PKCS11 \ingroup PKCS11
*/ */
WOLFSSL_API int wc_Pkcs11Token_Init(Pkcs11Token* token, Pkcs11Dev* dev, int wc_Pkcs11Token_Init(Pkcs11Token* token, Pkcs11Dev* dev,
int slotId, const char* tokenName, const unsigned char *userPin, int slotId, const char* tokenName, const unsigned char *userPin,
int userPinSz); int userPinSz);
/*! /*!
\ingroup PKCS11 \ingroup PKCS11
*/ */
WOLFSSL_API void wc_Pkcs11Token_Final(Pkcs11Token* token); void wc_Pkcs11Token_Final(Pkcs11Token* token);
/*! /*!
\ingroup PKCS11 \ingroup PKCS11
*/ */
WOLFSSL_API int wc_Pkcs11Token_Open(Pkcs11Token* token, int readWrite); int wc_Pkcs11Token_Open(Pkcs11Token* token, int readWrite);
/*! /*!
\ingroup PKCS11 \ingroup PKCS11
*/ */
WOLFSSL_API void wc_Pkcs11Token_Close(Pkcs11Token* token); void wc_Pkcs11Token_Close(Pkcs11Token* token);
/*! /*!
\ingroup PKCS11 \ingroup PKCS11
*/ */
WOLFSSL_API int wc_Pkcs11StoreKey(Pkcs11Token* token, int type, int clear, int wc_Pkcs11StoreKey(Pkcs11Token* token, int type, int clear,
/*! /*!
\ingroup PKCS11 \ingroup PKCS11
*/ */
WOLFSSL_API int wc_Pkcs11_CryptoDevCb(int devId, wc_CryptoInfo* info, int wc_Pkcs11_CryptoDevCb(int devId, wc_CryptoInfo* info,
void* ctx); void* ctx);

18
doc/dox_comments/header_files/pkcs7.h
View File

@ -55,7 +55,7 @@
\sa wc_PKCS7_Free \sa wc_PKCS7_Free
*/ */
WOLFSSL_API int wc_PKCS7_InitWithCert(PKCS7* pkcs7, byte* cert, word32 certSz); int wc_PKCS7_InitWithCert(PKCS7* pkcs7, byte* cert, word32 certSz);
/*! /*!
\ingroup PKCS7 \ingroup PKCS7
@ -76,7 +76,7 @@ WOLFSSL_API int wc_PKCS7_InitWithCert(PKCS7* pkcs7, byte* cert, word32 certSz);
\sa wc_PKCS7_InitWithCert \sa wc_PKCS7_InitWithCert
*/ */
WOLFSSL_API void wc_PKCS7_Free(PKCS7* pkcs7); void wc_PKCS7_Free(PKCS7* pkcs7);
/*! /*!
\ingroup PKCS7 \ingroup PKCS7
@ -119,7 +119,7 @@ WOLFSSL_API void wc_PKCS7_Free(PKCS7* pkcs7);
\sa wc_PKCS7_InitWithCert \sa wc_PKCS7_InitWithCert
*/ */
WOLFSSL_API int wc_PKCS7_EncodeData(PKCS7* pkcs7, byte* output, int wc_PKCS7_EncodeData(PKCS7* pkcs7, byte* output,
word32 outputSz); word32 outputSz);
/*! /*!
@ -197,7 +197,7 @@ WOLFSSL_API int wc_PKCS7_EncodeData(PKCS7* pkcs7, byte* output,
\sa wc_PKCS7_InitWithCert \sa wc_PKCS7_InitWithCert
\sa wc_PKCS7_VerifySignedData \sa wc_PKCS7_VerifySignedData
*/ */
WOLFSSL_API int wc_PKCS7_EncodeSignedData(PKCS7* pkcs7, int wc_PKCS7_EncodeSignedData(PKCS7* pkcs7,
byte* output, word32 outputSz); byte* output, word32 outputSz);
/*! /*!
@ -297,7 +297,7 @@ WOLFSSL_API int wc_PKCS7_EncodeSignedData(PKCS7* pkcs7,
\sa wc_PKCS7_InitWithCert \sa wc_PKCS7_InitWithCert
\sa wc_PKCS7_VerifySignedData_ex \sa wc_PKCS7_VerifySignedData_ex
*/ */
WOLFSSL_API int wc_PKCS7_EncodeSignedData_ex(PKCS7* pkcs7, const byte* hashBuf, int wc_PKCS7_EncodeSignedData_ex(PKCS7* pkcs7, const byte* hashBuf,
word32 hashSz, byte* outputHead, word32* outputHeadSz, byte* outputFoot, word32 hashSz, byte* outputHead, word32* outputHeadSz, byte* outputFoot,
word32* outputFootSz); word32* outputFootSz);
@ -375,7 +375,7 @@ WOLFSSL_API int wc_PKCS7_EncodeSignedData_ex(PKCS7* pkcs7, const byte* hashBuf,
\sa wc_PKCS7_InitWithCert \sa wc_PKCS7_InitWithCert
\sa wc_PKCS7_EncodeSignedData \sa wc_PKCS7_EncodeSignedData
*/ */
WOLFSSL_API int wc_PKCS7_VerifySignedData(PKCS7* pkcs7, int wc_PKCS7_VerifySignedData(PKCS7* pkcs7,
byte* pkiMsg, word32 pkiMsgSz); byte* pkiMsg, word32 pkiMsgSz);
@ -475,7 +475,7 @@ WOLFSSL_API int wc_PKCS7_VerifySignedData(PKCS7* pkcs7,
\sa wc_PKCS7_InitWithCert \sa wc_PKCS7_InitWithCert
\sa wc_PKCS7_EncodeSignedData_ex \sa wc_PKCS7_EncodeSignedData_ex
*/ */
WOLFSSL_API int wc_PKCS7_VerifySignedData_ex(PKCS7* pkcs7, const byte* hashBuf, int wc_PKCS7_VerifySignedData_ex(PKCS7* pkcs7, const byte* hashBuf,
word32 hashSz, byte* pkiMsgHead, word32 pkiMsgHeadSz, byte* pkiMsgFoot, word32 hashSz, byte* pkiMsgHead, word32 pkiMsgHeadSz, byte* pkiMsgFoot,
word32 pkiMsgFootSz); word32 pkiMsgFootSz);
@ -530,7 +530,7 @@ WOLFSSL_API int wc_PKCS7_VerifySignedData_ex(PKCS7* pkcs7, const byte* hashBuf,
\sa wc_PKCS7_InitWithCert \sa wc_PKCS7_InitWithCert
\sa wc_PKCS7_DecodeEnvelopedData \sa wc_PKCS7_DecodeEnvelopedData
*/ */
WOLFSSL_API int wc_PKCS7_EncodeEnvelopedData(PKCS7* pkcs7, int wc_PKCS7_EncodeEnvelopedData(PKCS7* pkcs7,
byte* output, word32 outputSz); byte* output, word32 outputSz);
/*! /*!
@ -608,6 +608,6 @@ WOLFSSL_API int wc_PKCS7_EncodeEnvelopedData(PKCS7* pkcs7,
\sa wc_PKCS7_InitWithCert \sa wc_PKCS7_InitWithCert
\sa wc_PKCS7_EncodeEnvelopedData \sa wc_PKCS7_EncodeEnvelopedData
*/ */
WOLFSSL_API int wc_PKCS7_DecodeEnvelopedData(PKCS7* pkcs7, byte* pkiMsg, int wc_PKCS7_DecodeEnvelopedData(PKCS7* pkcs7, byte* pkiMsg,
word32 pkiMsgSz, byte* output, word32 pkiMsgSz, byte* output,
word32 outputSz); word32 outputSz);

8
doc/dox_comments/header_files/poly1305.h
View File

@ -24,7 +24,7 @@
\sa wc_Poly1305Update \sa wc_Poly1305Update
\sa wc_Poly1305Final \sa wc_Poly1305Final
*/ */
WOLFSSL_API int wc_Poly1305SetKey(Poly1305* poly1305, const byte* key, int wc_Poly1305SetKey(Poly1305* poly1305, const byte* key,
word32 kySz); word32 kySz);
/*! /*!
@ -58,7 +58,7 @@ WOLFSSL_API int wc_Poly1305SetKey(Poly1305* poly1305, const byte* key,
\sa wc_Poly1305SetKey \sa wc_Poly1305SetKey
\sa wc_Poly1305Final \sa wc_Poly1305Final
*/ */
WOLFSSL_API int wc_Poly1305Update(Poly1305* poly1305, const byte*, word32); int wc_Poly1305Update(Poly1305* poly1305, const byte* m, word32 bytes);
/*! /*!
\ingroup Poly1305 \ingroup Poly1305
@ -93,7 +93,7 @@ WOLFSSL_API int wc_Poly1305Update(Poly1305* poly1305, const byte*, word32);
\sa wc_Poly1305SetKey \sa wc_Poly1305SetKey
\sa wc_Poly1305Update \sa wc_Poly1305Update
*/ */
WOLFSSL_API int wc_Poly1305Final(Poly1305* poly1305, byte* tag); int wc_Poly1305Final(Poly1305* poly1305, byte* tag);
/*! /*!
\ingroup Poly1305 \ingroup Poly1305
@ -135,5 +135,5 @@ WOLFSSL_API int wc_Poly1305Final(Poly1305* poly1305, byte* tag);
\sa wc_Poly1305Update \sa wc_Poly1305Update
\sa wcPoly1305Final \sa wcPoly1305Final
*/ */
WOLFSSL_API int wc_Poly1305_MAC(Poly1305* ctx, byte* additional, word32 addSz, int wc_Poly1305_MAC(Poly1305* ctx, byte* additional, word32 addSz,
byte* input, word32 sz, byte* tag, word32 tagSz); byte* input, word32 sz, byte* tag, word32 tagSz);

8
doc/dox_comments/header_files/psa.h
View File

@ -20,7 +20,7 @@
\sa wolfSSL_set_psa_ctx \sa wolfSSL_set_psa_ctx
*/ */
WOLFSSL_API int wolfSSL_CTX_psa_enable(WOLFSSL_CTX *ctx); int wolfSSL_CTX_psa_enable(WOLFSSL_CTX *ctx);
/*! /*!
\ingroup PSA \ingroup PSA
@ -52,7 +52,7 @@ WOLFSSL_API int wolfSSL_CTX_psa_enable(WOLFSSL_CTX *ctx);
\sa wolfSSL_psa_set_private_key_id \sa wolfSSL_psa_set_private_key_id
\sa wolfSSL_psa_free_psa_ctx \sa wolfSSL_psa_free_psa_ctx
*/ */
WOLFSSL_API int wolfSSL_set_psa_ctx(WOLFSSL *ssl, struct psa_ssl_ctx *ctx); int wolfSSL_set_psa_ctx(WOLFSSL *ssl, struct psa_ssl_ctx *ctx);
/*! /*!
\ingroup PSA \ingroup PSA
@ -62,7 +62,7 @@ WOLFSSL_API int wolfSSL_set_psa_ctx(WOLFSSL *ssl, struct psa_ssl_ctx *ctx);
\sa wolfSSL_set_psa_ctx \sa wolfSSL_set_psa_ctx
*/ */
WOLFSSL_API void wolfSSL_free_psa_ctx(struct psa_ssl_ctx *ctx); void wolfSSL_free_psa_ctx(struct psa_ssl_ctx *ctx);
/*! /*!
\ingroup PSA \ingroup PSA
@ -92,5 +92,5 @@ WOLFSSL_API void wolfSSL_free_psa_ctx(struct psa_ssl_ctx *ctx);
\sa wolfSSL_set_psa_ctx \sa wolfSSL_set_psa_ctx
*/ */
WOLFSSL_API int wolfSSL_psa_set_private_key_id(struct psa_ssl_ctx *ctx, int wolfSSL_psa_set_private_key_id(struct psa_ssl_ctx *ctx,
psa_key_id_t id); psa_key_id_t id);

6
doc/dox_comments/header_files/pwdbased.h
View File

@ -43,7 +43,7 @@
\sa wc_PBKDF2 \sa wc_PBKDF2
\sa wc_PKCS12_PBKDF \sa wc_PKCS12_PBKDF
*/ */
WOLFSSL_API int wc_PBKDF1(byte* output, const byte* passwd, int pLen, int wc_PBKDF1(byte* output, const byte* passwd, int pLen,
const byte* salt, int sLen, int iterations, int kLen, const byte* salt, int sLen, int iterations, int kLen,
int typeH); int typeH);
@ -92,7 +92,7 @@ WOLFSSL_API int wc_PBKDF1(byte* output, const byte* passwd, int pLen,
\sa wc_PBKDF1 \sa wc_PBKDF1
\sa wc_PKCS12_PBKDF \sa wc_PKCS12_PBKDF
*/ */
WOLFSSL_API int wc_PBKDF2(byte* output, const byte* passwd, int pLen, int wc_PBKDF2(byte* output, const byte* passwd, int pLen,
const byte* salt, int sLen, int iterations, int kLen, const byte* salt, int sLen, int iterations, int kLen,
int typeH); int typeH);
@ -161,6 +161,6 @@ WOLFSSL_API int wc_PBKDF2(byte* output, const byte* passwd, int pLen,
\sa wc_PBKDF1 \sa wc_PBKDF1
\sa wc_PBKDF2 \sa wc_PBKDF2
*/ */
WOLFSSL_API int wc_PKCS12_PBKDF(byte* output, const byte* passwd, int pLen, int wc_PKCS12_PBKDF(byte* output, const byte* passwd, int pLen,
const byte* salt, int sLen, int iterations, const byte* salt, int sLen, int iterations,
int kLen, int typeH, int purpose); int kLen, int typeH, int purpose);

18
doc/dox_comments/header_files/random.h
View File

@ -24,7 +24,7 @@
\sa wc_FreeNetRandom \sa wc_FreeNetRandom
*/ */
WOLFSSL_API int wc_InitNetRandom(const char*, wnr_hmac_key, int); int wc_InitNetRandom(const char* configFile, wnr_hmac_key hmac_cb, int timeout);
/*! /*!
\ingroup Random \ingroup Random
@ -47,7 +47,7 @@ WOLFSSL_API int wc_InitNetRandom(const char*, wnr_hmac_key, int);
\sa wc_InitNetRandom \sa wc_InitNetRandom
*/ */
WOLFSSL_API int wc_FreeNetRandom(void); int wc_FreeNetRandom(void);
/*! /*!
\ingroup Random \ingroup Random
@ -95,7 +95,7 @@ WOLFSSL_API int wc_FreeNetRandom(void);
\sa wc_FreeRng \sa wc_FreeRng
\sa wc_RNG_HealthTest \sa wc_RNG_HealthTest
*/ */
WOLFSSL_API int wc_InitRng(WC_RNG*); int wc_InitRng(WC_RNG*);
/*! /*!
\ingroup Random \ingroup Random
@ -135,7 +135,7 @@ WOLFSSL_API int wc_InitRng(WC_RNG*);
\sa wc_FreeRng \sa wc_FreeRng
\sa wc_RNG_HealthTest \sa wc_RNG_HealthTest
*/ */
WOLFSSL_API int wc_RNG_GenerateBlock(WC_RNG*, byte*, word32 sz); int wc_RNG_GenerateBlock(WC_RNG* rng, byte* b, word32 sz);
/*! /*!
\ingroup Random \ingroup Random
@ -167,7 +167,7 @@ WOLFSSL_API int wc_RNG_GenerateBlock(WC_RNG*, byte*, word32 sz);
\sa wc_FreeRng \sa wc_FreeRng
\sa wc_RNG_HealthTest \sa wc_RNG_HealthTest
*/ */
WOLFSSL_API WC_RNG* wc_rng_new(byte* nonce, word32 nonceSz, void* heap) WC_RNG* wc_rng_new(byte* nonce, word32 nonceSz, void* heap)
/*! /*!
\ingroup Random \ingroup Random
@ -207,7 +207,7 @@ WOLFSSL_API WC_RNG* wc_rng_new(byte* nonce, word32 nonceSz, void* heap)
\sa wc_FreeRng \sa wc_FreeRng
\sa wc_RNG_HealthTest \sa wc_RNG_HealthTest
*/ */
WOLFSSL_API int wc_RNG_GenerateByte(WC_RNG*, byte*); int wc_RNG_GenerateByte(WC_RNG* rng, byte* b);
/*! /*!
\ingroup Random \ingroup Random
@ -241,7 +241,7 @@ WOLFSSL_API int wc_RNG_GenerateByte(WC_RNG*, byte*);
\sa wc_RNG_GenerateByte, \sa wc_RNG_GenerateByte,
\sa wc_RNG_HealthTest \sa wc_RNG_HealthTest
*/ */
WOLFSSL_API int wc_FreeRng(WC_RNG*); int wc_FreeRng(WC_RNG*);
/*! /*!
\ingroup Random \ingroup Random
@ -271,7 +271,7 @@ WOLFSSL_API int wc_FreeRng(WC_RNG*);
\sa wc_FreeRng \sa wc_FreeRng
\sa wc_RNG_HealthTest \sa wc_RNG_HealthTest
*/ */
WOLFSSL_API WC_RNG* wc_rng_free(WC_RNG* rng); WC_RNG* wc_rng_free(WC_RNG* rng);
/*! /*!
\ingroup Random \ingroup Random
@ -322,7 +322,7 @@ WOLFSSL_API WC_RNG* wc_rng_free(WC_RNG* rng);
\sa wc_RNG_GenerateByte \sa wc_RNG_GenerateByte
\sa wc_FreeRng \sa wc_FreeRng
*/ */
WOLFSSL_API int wc_RNG_HealthTest(int reseed, int wc_RNG_HealthTest(int reseed,
const byte* entropyA, word32 entropyASz, const byte* entropyA, word32 entropyASz,
const byte* entropyB, word32 entropyBSz, const byte* entropyB, word32 entropyBSz,
byte* output, word32 outputSz); byte* output, word32 outputSz);

6
doc/dox_comments/header_files/ripemd.h
View File

@ -23,7 +23,7 @@
\sa wc_RipeMdUpdate \sa wc_RipeMdUpdate
\sa wc_RipeMdFinal \sa wc_RipeMdFinal
*/ */
WOLFSSL_API int wc_InitRipeMd(RipeMd*); int wc_InitRipeMd(RipeMd*);
/*! /*!
\ingroup RIPEMD \ingroup RIPEMD
@ -59,7 +59,7 @@ WOLFSSL_API int wc_InitRipeMd(RipeMd*);
\sa wc_InitRipeMd \sa wc_InitRipeMd
\sa wc_RipeMdFinal \sa wc_RipeMdFinal
*/ */
WOLFSSL_API int wc_RipeMdUpdate(RipeMd*, const byte*, word32); int wc_RipeMdUpdate(RipeMd* ripemd, const byte* data, word32 len);
/*! /*!
\ingroup RIPEMD \ingroup RIPEMD
@ -100,4 +100,4 @@ WOLFSSL_API int wc_RipeMdUpdate(RipeMd*, const byte*, word32);
\sa none \sa none
*/ */
WOLFSSL_API int wc_RipeMdFinal(RipeMd*, byte*); int wc_RipeMdFinal(RipeMd* ripemd, byte* hash);

72
doc/dox_comments/header_files/rsa.h
View File

@ -31,7 +31,7 @@
\sa wc_FreeRsaKey \sa wc_FreeRsaKey
\sa wc_RsaSetRNG \sa wc_RsaSetRNG
*/ */
WOLFSSL_API int wc_InitRsaKey(RsaKey* key, void* heap); int wc_InitRsaKey(RsaKey* key, void* heap);
/*! /*!
\ingroup RSA \ingroup RSA
@ -81,7 +81,7 @@ WOLFSSL_API int wc_InitRsaKey(RsaKey* key, void* heap);
\sa wc_FreeRsaKey \sa wc_FreeRsaKey
\sa wc_RsaSetRNG \sa wc_RsaSetRNG
*/ */
WOLFSSL_API int wc_InitRsaKey_Id(RsaKey* key, unsigned char* id, int len, int wc_InitRsaKey_Id(RsaKey* key, unsigned char* id, int len,
void* heap, int devId); void* heap, int devId);
/*! /*!
@ -109,7 +109,7 @@ WOLFSSL_API int wc_InitRsaKey_Id(RsaKey* key, unsigned char* id, int len,
\sa wc_InitRsaKey \sa wc_InitRsaKey
\sa wc_RsaSetRNG \sa wc_RsaSetRNG
*/ */
WOLFSSL_API int wc_RsaSetRNG(RsaKey* key, WC_RNG* rng); int wc_RsaSetRNG(RsaKey* key, WC_RNG* rng);
/*! /*!
\ingroup RSA \ingroup RSA
@ -131,7 +131,7 @@ WOLFSSL_API int wc_RsaSetRNG(RsaKey* key, WC_RNG* rng);
\sa wc_InitRsaKey \sa wc_InitRsaKey
*/ */
WOLFSSL_API int wc_FreeRsaKey(RsaKey* key); int wc_FreeRsaKey(RsaKey* key);
/*! /*!
\ingroup RSA \ingroup RSA
@ -203,7 +203,7 @@ WOLFSSL_API int wc_FreeRsaKey(RsaKey* key);
\sa wc_RsaPrivateDecrypt \sa wc_RsaPrivateDecrypt
*/ */
WOLFSSL_API int wc_RsaPublicEncrypt(const byte* in, word32 inLen, byte* out, int wc_RsaPublicEncrypt(const byte* in, word32 inLen, byte* out,
word32 outLen, RsaKey* key, WC_RNG* rng); word32 outLen, RsaKey* key, WC_RNG* rng);
/*! /*!
@ -227,7 +227,7 @@ WOLFSSL_API int wc_RsaPublicEncrypt(const byte* in, word32 inLen, byte* out,
\sa wc_RsaPrivateDecrypt \sa wc_RsaPrivateDecrypt
*/ */
WOLFSSL_API int wc_RsaPrivateDecryptInline(byte* in, word32 inLen, byte** out, int wc_RsaPrivateDecryptInline(byte* in, word32 inLen, byte** out,
RsaKey* key); RsaKey* key);
/*! /*!
@ -261,7 +261,7 @@ WOLFSSL_API int wc_RsaPrivateDecryptInline(byte* in, word32 inLen, byte** out,
\sa wc_RsaFunction \sa wc_RsaFunction
\sa wc_RsaPrivateDecryptInline \sa wc_RsaPrivateDecryptInline
*/ */
WOLFSSL_API int wc_RsaPrivateDecrypt(const byte* in, word32 inLen, byte* out, int wc_RsaPrivateDecrypt(const byte* in, word32 inLen, byte* out,
word32 outLen, RsaKey* key); word32 outLen, RsaKey* key);
/*! /*!
@ -294,7 +294,7 @@ WOLFSSL_API int wc_RsaPrivateDecrypt(const byte* in, word32 inLen, byte* out,
\sa wc_RsaPad \sa wc_RsaPad
*/ */
WOLFSSL_API int wc_RsaSSL_Sign(const byte* in, word32 inLen, byte* out, int wc_RsaSSL_Sign(const byte* in, word32 inLen, byte* out,
word32 outLen, RsaKey* key, WC_RNG* rng); word32 outLen, RsaKey* key, WC_RNG* rng);
/*! /*!
@ -332,7 +332,7 @@ WOLFSSL_API int wc_RsaSSL_Sign(const byte* in, word32 inLen, byte* out,
\sa wc_RsaSSL_Verify \sa wc_RsaSSL_Verify
\sa wc_RsaSSL_Sign \sa wc_RsaSSL_Sign
*/ */
WOLFSSL_API int wc_RsaSSL_VerifyInline(byte* in, word32 inLen, byte** out, int wc_RsaSSL_VerifyInline(byte* in, word32 inLen, byte** out,
RsaKey* key); RsaKey* key);
/*! /*!
@ -364,7 +364,7 @@ WOLFSSL_API int wc_RsaSSL_VerifyInline(byte* in, word32 inLen, byte** out,
\sa wc_RsaSSL_Sign \sa wc_RsaSSL_Sign
*/ */
WOLFSSL_API int wc_RsaSSL_Verify(const byte* in, word32 inLen, byte* out, int wc_RsaSSL_Verify(const byte* in, word32 inLen, byte* out,
word32 outLen, RsaKey* key); word32 outLen, RsaKey* key);
/*! /*!
@ -414,7 +414,7 @@ WOLFSSL_API int wc_RsaSSL_Verify(const byte* in, word32 inLen, byte* out,
\sa wc_RsaPSS_Verify \sa wc_RsaPSS_Verify
\sa wc_RsaSetRNG \sa wc_RsaSetRNG
*/ */
WOLFSSL_API int wc_RsaPSS_Sign(const byte* in, word32 inLen, byte* out, int wc_RsaPSS_Sign(const byte* in, word32 inLen, byte* out,
word32 outLen, enum wc_HashType hash, int mgf, word32 outLen, enum wc_HashType hash, int mgf,
RsaKey* key, WC_RNG* rng); RsaKey* key, WC_RNG* rng);
@ -467,7 +467,7 @@ WOLFSSL_API int wc_RsaPSS_Sign(const byte* in, word32 inLen, byte* out,
\sa wc_RsaPSS_CheckPadding \sa wc_RsaPSS_CheckPadding
\sa wc_RsaSetRNG \sa wc_RsaSetRNG
*/ */
WOLFSSL_API int wc_RsaPSS_Verify(byte* in, word32 inLen, byte* out, int wc_RsaPSS_Verify(byte* in, word32 inLen, byte* out,
word32 outLen, enum wc_HashType hash, int mgf, word32 outLen, enum wc_HashType hash, int mgf,
RsaKey* key); RsaKey* key);
@ -528,7 +528,7 @@ WOLFSSL_API int wc_RsaPSS_Verify(byte* in, word32 inLen, byte* out,
*/ */
WOLFSSL_API int wc_RsaPSS_VerifyInline(byte* in, word32 inLen, byte** out, int wc_RsaPSS_VerifyInline(byte* in, word32 inLen, byte** out,
enum wc_HashType hash, int mgf, enum wc_HashType hash, int mgf,
RsaKey* key); RsaKey* key);
/*! /*!
@ -596,7 +596,7 @@ WOLFSSL_API int wc_RsaPSS_VerifyInline(byte* in, word32 inLen, byte** out,
\sa wc_RsaSetRNG \sa wc_RsaSetRNG
*/ */
WOLFSSL_API int wc_RsaPSS_VerifyCheck(byte* in, word32 inLen, int wc_RsaPSS_VerifyCheck(byte* in, word32 inLen,
byte* out, word32 outLen, byte* out, word32 outLen,
const byte* digest, word32 digestLen, const byte* digest, word32 digestLen,
enum wc_HashType hash, int mgf, enum wc_HashType hash, int mgf,
@ -668,7 +668,7 @@ WOLFSSL_API int wc_RsaPSS_VerifyCheck(byte* in, word32 inLen,
\sa wc_RsaPSS_CheckPadding_ex \sa wc_RsaPSS_CheckPadding_ex
\sa wc_RsaSetRNG \sa wc_RsaSetRNG
*/ */
WOLFSSL_API int wc_RsaPSS_VerifyCheck_ex(byte* in, word32 inLen, int wc_RsaPSS_VerifyCheck_ex(byte* in, word32 inLen,
byte* out, word32 outLen, byte* out, word32 outLen,
const byte* digest, word32 digestLen, const byte* digest, word32 digestLen,
enum wc_HashType hash, int mgf, int saltLen, enum wc_HashType hash, int mgf, int saltLen,
@ -738,7 +738,7 @@ WOLFSSL_API int wc_RsaPSS_VerifyCheck_ex(byte* in, word32 inLen,
\sa wc_RsaPSS_CheckPadding_ex \sa wc_RsaPSS_CheckPadding_ex
\sa wc_RsaSetRNG \sa wc_RsaSetRNG
*/ */
WOLFSSL_API int wc_RsaPSS_VerifyCheckInline(byte* in, word32 inLen, byte** out, int wc_RsaPSS_VerifyCheckInline(byte* in, word32 inLen, byte** out,
const byte* digest, word32 digentLen, const byte* digest, word32 digentLen,
enum wc_HashType hash, int mgf, enum wc_HashType hash, int mgf,
RsaKey* key); RsaKey* key);
@ -807,7 +807,7 @@ WOLFSSL_API int wc_RsaPSS_VerifyCheckInline(byte* in, word32 inLen, byte** out,
\sa wc_RsaPSS_CheckPadding_ex \sa wc_RsaPSS_CheckPadding_ex
\sa wc_RsaSetRNG \sa wc_RsaSetRNG
*/ */
WOLFSSL_API int wc_RsaPSS_VerifyCheckInline_ex(byte* in, word32 inLen, byte** out, int wc_RsaPSS_VerifyCheckInline_ex(byte* in, word32 inLen, byte** out,
const byte* digest, word32 digentLen, const byte* digest, word32 digentLen,
enum wc_HashType hash, int mgf, int saltLen, enum wc_HashType hash, int mgf, int saltLen,
RsaKey* key); RsaKey* key);
@ -872,7 +872,7 @@ WOLFSSL_API int wc_RsaPSS_VerifyCheckInline_ex(byte* in, word32 inLen, byte** o
\sa wc_RsaPSS_CheckPadding_ex \sa wc_RsaPSS_CheckPadding_ex
\sa wc_RsaSetRNG \sa wc_RsaSetRNG
*/ */
WOLFSSL_API int wc_RsaPSS_CheckPadding(const byte* in, word32 inLen, byte* sig, int wc_RsaPSS_CheckPadding(const byte* in, word32 inLen, byte* sig,
word32 sigSz, word32 sigSz,
enum wc_HashType hashType); enum wc_HashType hashType);
/*! /*!
@ -937,7 +937,7 @@ WOLFSSL_API int wc_RsaPSS_CheckPadding(const byte* in, word32 inLen, byte* sig,
\sa wc_RsaPSS_VerifyCheckInline_ex \sa wc_RsaPSS_VerifyCheckInline_ex
\sa wc_RsaPSS_CheckPadding \sa wc_RsaPSS_CheckPadding
*/ */
WOLFSSL_API int wc_RsaPSS_CheckPadding_ex(const byte* in, word32 inLen, byte* sig, int wc_RsaPSS_CheckPadding_ex(const byte* in, word32 inLen, byte* sig,
word32 sigSz, enum wc_HashType hashType, int saltLen, int bits); word32 sigSz, enum wc_HashType hashType, int saltLen, int bits);
/*! /*!
\ingroup RSA \ingroup RSA
@ -957,7 +957,7 @@ WOLFSSL_API int wc_RsaPSS_CheckPadding_ex(const byte* in, word32 inLen, byte* s
\sa wc_InitRsaKey_ex \sa wc_InitRsaKey_ex
\sa wc_MakeRsaKey \sa wc_MakeRsaKey
*/ */
WOLFSSL_API int wc_RsaEncryptSize(RsaKey* key); int wc_RsaEncryptSize(RsaKey* key);
/*! /*!
\ingroup RSA \ingroup RSA
@ -1000,8 +1000,8 @@ WOLFSSL_API int wc_RsaEncryptSize(RsaKey* key);
\sa wc_RsaPublicKeyDecode \sa wc_RsaPublicKeyDecode
\sa wc_MakeRsaKey \sa wc_MakeRsaKey
*/ */
WOLFSSL_API int wc_RsaPrivateKeyDecode(const byte* input, word32* inOutIdx, int wc_RsaPrivateKeyDecode(const byte* input, word32* inOutIdx,
RsaKey*, word32); RsaKey* key, word32 inSz);
/*! /*!
\ingroup RSA \ingroup RSA
@ -1049,8 +1049,8 @@ WOLFSSL_API int wc_RsaPrivateKeyDecode(const byte* input, word32* inOutIdx,
\sa wc_RsaPublicKeyDecodeRaw \sa wc_RsaPublicKeyDecodeRaw
*/ */
WOLFSSL_API int wc_RsaPublicKeyDecode(const byte* input, word32* inOutIdx, int wc_RsaPublicKeyDecode(const byte* input, word32* inOutIdx,
RsaKey*, word32); RsaKey* key, word32 inSz);
/*! /*!
\ingroup RSA \ingroup RSA
@ -1094,7 +1094,7 @@ WOLFSSL_API int wc_RsaPublicKeyDecode(const byte* input, word32* inOutIdx,
\sa wc_RsaPublicKeyDecode \sa wc_RsaPublicKeyDecode
*/ */
WOLFSSL_API int wc_RsaPublicKeyDecodeRaw(const byte* n, word32 nSz, int wc_RsaPublicKeyDecodeRaw(const byte* n, word32 nSz,
const byte* e, word32 eSz, RsaKey* key); const byte* e, word32 eSz, RsaKey* key);
/*! /*!
@ -1135,7 +1135,7 @@ WOLFSSL_API int wc_RsaPublicKeyDecodeRaw(const byte* n, word32 nSz,
\sa wc_MakeRsaKey \sa wc_MakeRsaKey
\sa wc_InitRng \sa wc_InitRng
*/ */
WOLFSSL_API int wc_RsaKeyToDer(RsaKey*, byte* output, word32 inLen); int wc_RsaKeyToDer(RsaKey* key, byte* output, word32 inLen);
/*! /*!
\ingroup RSA \ingroup RSA
@ -1178,7 +1178,7 @@ WOLFSSL_API int wc_RsaKeyToDer(RsaKey*, byte* output, word32 inLen);
\sa wc_RsaPublicEncrypt \sa wc_RsaPublicEncrypt
\sa wc_RsaPrivateDecrypt_ex \sa wc_RsaPrivateDecrypt_ex
*/ */
WOLFSSL_API int wc_RsaPublicEncrypt_ex(const byte* in, word32 inLen, byte* out, int wc_RsaPublicEncrypt_ex(const byte* in, word32 inLen, byte* out,
word32 outLen, RsaKey* key, WC_RNG* rng, int type, word32 outLen, RsaKey* key, WC_RNG* rng, int type,
enum wc_HashType hash, int mgf, byte* label, word32 labelSz); enum wc_HashType hash, int mgf, byte* label, word32 labelSz);
@ -1231,7 +1231,7 @@ WOLFSSL_API int wc_RsaPublicEncrypt_ex(const byte* in, word32 inLen, byte* out,
\sa none \sa none
*/ */
WOLFSSL_API int wc_RsaPrivateDecrypt_ex(const byte* in, word32 inLen, int wc_RsaPrivateDecrypt_ex(const byte* in, word32 inLen,
byte* out, word32 outLen, RsaKey* key, int type, byte* out, word32 outLen, RsaKey* key, int type,
enum wc_HashType hash, int mgf, byte* label, word32 labelSz); enum wc_HashType hash, int mgf, byte* label, word32 labelSz);
@ -1289,7 +1289,7 @@ WOLFSSL_API int wc_RsaPrivateDecrypt_ex(const byte* in, word32 inLen,
\sa none \sa none
*/ */
WOLFSSL_API int wc_RsaPrivateDecryptInline_ex(byte* in, word32 inLen, int wc_RsaPrivateDecryptInline_ex(byte* in, word32 inLen,
byte** out, RsaKey* key, int type, enum wc_HashType hash, byte** out, RsaKey* key, int type, enum wc_HashType hash,
int mgf, byte* label, word32 labelSz); int mgf, byte* label, word32 labelSz);
@ -1334,8 +1334,8 @@ WOLFSSL_API int wc_RsaPrivateDecryptInline_ex(byte* in, word32 inLen,
\sa wc_InitRsaKey_ex \sa wc_InitRsaKey_ex
\sa wc_MakeRsaKey \sa wc_MakeRsaKey
*/ */
WOLFSSL_API int wc_RsaFlattenPublicKey(RsaKey*, byte*, word32*, byte*, int wc_RsaFlattenPublicKey(RsaKey* key, byte* e, word32* eSz, byte* n,
word32*); word32* nSz);
/*! /*!
\ingroup RSA \ingroup RSA
@ -1370,7 +1370,7 @@ WOLFSSL_API int wc_RsaFlattenPublicKey(RsaKey*, byte*, word32*, byte*,
\sa wc_RsaKeyToPublicDer_ex \sa wc_RsaKeyToPublicDer_ex
\sa wc_InitRsaKey \sa wc_InitRsaKey
*/ */
WOLFSSL_API int wc_RsaKeyToPublicDer(RsaKey* key, byte* output, word32 inLen); int wc_RsaKeyToPublicDer(RsaKey* key, byte* output, word32 inLen);
/*! /*!
\ingroup RSA \ingroup RSA
@ -1406,7 +1406,7 @@ WOLFSSL_API int wc_RsaKeyToPublicDer(RsaKey* key, byte* output, word32 inLen);
\sa wc_RsaKeyToPublicDer \sa wc_RsaKeyToPublicDer
\sa wc_InitRsaKey \sa wc_InitRsaKey
*/ */
WOLFSSL_API int wc_RsaKeyToPublicDer_ex(RsaKey* key, byte* output, word32 inLen, int wc_RsaKeyToPublicDer_ex(RsaKey* key, byte* output, word32 inLen,
int with_header); int with_header);
/*! /*!
@ -1478,7 +1478,7 @@ WOLFSSL_API int wc_RsaKeyToPublicDer_ex(RsaKey* key, byte* output, word32 inLen,
\sa none \sa none
*/ */
WOLFSSL_API int wc_MakeRsaKey(RsaKey* key, int size, long e, WC_RNG* rng); int wc_MakeRsaKey(RsaKey* key, int size, long e, WC_RNG* rng);
/*! /*!
\ingroup RSA \ingroup RSA
@ -1523,7 +1523,7 @@ WOLFSSL_API int wc_MakeRsaKey(RsaKey* key, int size, long e, WC_RNG* rng);
\sa wc_RsaSetNonBlockTime \sa wc_RsaSetNonBlockTime
*/ */
WOLFSSL_API int wc_RsaSetNonBlock(RsaKey* key, RsaNb* nb); int wc_RsaSetNonBlock(RsaKey* key, RsaNb* nb);
/*! /*!
\ingroup RSA \ingroup RSA
@ -1555,5 +1555,5 @@ WOLFSSL_API int wc_RsaSetNonBlock(RsaKey* key, RsaNb* nb);
\sa wc_RsaSetNonBlock \sa wc_RsaSetNonBlock
*/ */
WOLFSSL_API int wc_RsaSetNonBlockTime(RsaKey* key, word32 maxBlockUs, int wc_RsaSetNonBlockTime(RsaKey* key, word32 maxBlockUs,
word32 cpuMHz); word32 cpuMHz);

58
doc/dox_comments/header_files/sakke.h
View File

@ -2,142 +2,142 @@
/*! /*!
\ingroup SAKKE_Setup \ingroup SAKKE_Setup
*/ */
WOLFSSL_API int wc_InitSakkeKey(SakkeKey* key, void* heap, int devId); int wc_InitSakkeKey(SakkeKey* key, void* heap, int devId);
/*! /*!
\ingroup SAKKE_Setup \ingroup SAKKE_Setup
*/ */
WOLFSSL_API int wc_InitSakkeKey_ex(SakkeKey* key, int keySize, int curveId, int wc_InitSakkeKey_ex(SakkeKey* key, int keySize, int curveId,
void* heap, int devId); void* heap, int devId);
/*! /*!
\ingroup SAKKE_Setup \ingroup SAKKE_Setup
*/ */
WOLFSSL_API void wc_FreeSakkeKey(SakkeKey* key); void wc_FreeSakkeKey(SakkeKey* key);
/*! /*!
\ingroup SAKKE_Setup \ingroup SAKKE_Setup
*/ */
WOLFSSL_API int wc_MakeSakkeKey(SakkeKey* key, WC_RNG* rng); int wc_MakeSakkeKey(SakkeKey* key, WC_RNG* rng);
/*! /*!
\ingroup SAKKE_Setup \ingroup SAKKE_Setup
*/ */
WOLFSSL_API int wc_MakeSakkePublicKey(SakkeKey* key, ecc_point* pub); int wc_MakeSakkePublicKey(SakkeKey* key, ecc_point* pub);
/*! /*!
\ingroup SAKKE_RSK \ingroup SAKKE_RSK
*/ */
WOLFSSL_API int wc_MakeSakkeRsk(SakkeKey* key, const byte* id, word16 idSz, int wc_MakeSakkeRsk(SakkeKey* key, const byte* id, word16 idSz,
ecc_point* rsk); ecc_point* rsk);
/*! /*!
\ingroup SAKKE_RSK \ingroup SAKKE_RSK
*/ */
WOLFSSL_API int wc_ValidateSakkeRsk(SakkeKey* key, const byte* id, word16 idSz, int wc_ValidateSakkeRsk(SakkeKey* key, const byte* id, word16 idSz,
ecc_point* rsk, int* valid); ecc_point* rsk, int* valid);
/*! /*!
\ingroup SAKKE_RSK \ingroup SAKKE_RSK
*/ */
WOLFSSL_API int wc_GenerateSakkeRskTable(const SakkeKey* key, int wc_GenerateSakkeRskTable(const SakkeKey* key,
const ecc_point* rsk, byte* table, word32* len); const ecc_point* rsk, byte* table, word32* len);
/*! /*!
\ingroup SAKKE_Setup \ingroup SAKKE_Setup
*/ */
WOLFSSL_API int wc_ExportSakkeKey(SakkeKey* key, byte* data, word32* sz); int wc_ExportSakkeKey(SakkeKey* key, byte* data, word32* sz);
/*! /*!
\ingroup SAKKE_Setup \ingroup SAKKE_Setup
*/ */
WOLFSSL_API int wc_ImportSakkeKey(SakkeKey* key, const byte* data, word32 sz); int wc_ImportSakkeKey(SakkeKey* key, const byte* data, word32 sz);
/*! /*!
\ingroup SAKKE_Setup \ingroup SAKKE_Setup
*/ */
WOLFSSL_API int wc_ExportSakkePrivateKey(SakkeKey* key, byte* data, word32* sz); int wc_ExportSakkePrivateKey(SakkeKey* key, byte* data, word32* sz);
/*! /*!
\ingroup SAKKE_Setup \ingroup SAKKE_Setup
*/ */
WOLFSSL_API int wc_ImportSakkePrivateKey(SakkeKey* key, const byte* data, int wc_ImportSakkePrivateKey(SakkeKey* key, const byte* data,
word32 sz); word32 sz);
/*! /*!
\ingroup SAKKE_RSK \ingroup SAKKE_RSK
*/ */
WOLFSSL_API int wc_EncodeSakkeRsk(const SakkeKey* key, ecc_point* rsk, int wc_EncodeSakkeRsk(const SakkeKey* key, ecc_point* rsk,
byte* out, word32* sz, int raw); byte* out, word32* sz, int raw);
/*! /*!
\ingroup SAKKE_RSK \ingroup SAKKE_RSK
*/ */
WOLFSSL_API int wc_DecodeSakkeRsk(const SakkeKey* key, const byte* data, int wc_DecodeSakkeRsk(const SakkeKey* key, const byte* data,
word32 sz, ecc_point* rsk); word32 sz, ecc_point* rsk);
/*! /*!
\ingroup SAKKE_RSK \ingroup SAKKE_RSK
*/ */
WOLFSSL_API int wc_ImportSakkeRsk(SakkeKey* key, const byte* data, word32 sz); int wc_ImportSakkeRsk(SakkeKey* key, const byte* data, word32 sz);
/*! /*!
\ingroup SAKKE_Setup \ingroup SAKKE_Setup
*/ */
WOLFSSL_API int wc_ExportSakkePublicKey(SakkeKey* key, byte* data, int wc_ExportSakkePublicKey(SakkeKey* key, byte* data,
word32* sz, int raw); word32* sz, int raw);
/*! /*!
\ingroup SAKKE_Setup \ingroup SAKKE_Setup
*/ */
WOLFSSL_API int wc_ImportSakkePublicKey(SakkeKey* key, const byte* data, int wc_ImportSakkePublicKey(SakkeKey* key, const byte* data,
word32 sz, int trusted); word32 sz, int trusted);
/*! /*!
\ingroup SAKKE_Operations \ingroup SAKKE_Operations
*/ */
WOLFSSL_API int wc_GetSakkeAuthSize(SakkeKey* key, word16* authSz); int wc_GetSakkeAuthSize(SakkeKey* key, word16* authSz);
/*! /*!
\ingroup SAKKE_Setup \ingroup SAKKE_Setup
*/ */
WOLFSSL_API int wc_SetSakkeIdentity(SakkeKey* key, const byte* id, word16 idSz); int wc_SetSakkeIdentity(SakkeKey* key, const byte* id, word16 idSz);
/*! /*!
\ingroup SAKKE_Operations \ingroup SAKKE_Operations
*/ */
WOLFSSL_API int wc_MakeSakkePointI(SakkeKey* key, const byte* id, word16 idSz); int wc_MakeSakkePointI(SakkeKey* key, const byte* id, word16 idSz);
/*! /*!
\ingroup SAKKE_Operations \ingroup SAKKE_Operations
*/ */
WOLFSSL_API int wc_GetSakkePointI(SakkeKey* key, byte* data, word32* sz); int wc_GetSakkePointI(SakkeKey* key, byte* data, word32* sz);
/*! /*!
\ingroup SAKKE_Operations \ingroup SAKKE_Operations
*/ */
WOLFSSL_API int wc_SetSakkePointI(SakkeKey* key, const byte* id, word16 idSz, int wc_SetSakkePointI(SakkeKey* key, const byte* id, word16 idSz,
const byte* data, word32 sz); const byte* data, word32 sz);
/*! /*!
\ingroup SAKKE_Operations \ingroup SAKKE_Operations
*/ */
WOLFSSL_API int wc_GenerateSakkePointITable(SakkeKey* key, byte* table, int wc_GenerateSakkePointITable(SakkeKey* key, byte* table,
word32* len); word32* len);
/*! /*!
\ingroup SAKKE_Operations \ingroup SAKKE_Operations
*/ */
WOLFSSL_API int wc_SetSakkePointITable(SakkeKey* key, byte* table, word32 len); int wc_SetSakkePointITable(SakkeKey* key, byte* table, word32 len);
/*! /*!
\ingroup SAKKE_Operations \ingroup SAKKE_Operations
*/ */
WOLFSSL_API int wc_ClearSakkePointITable(SakkeKey* key); int wc_ClearSakkePointITable(SakkeKey* key);
/*! /*!
\ingroup SAKKE_Operations \ingroup SAKKE_Operations
*/ */
WOLFSSL_API int wc_MakeSakkeEncapsulatedSSV(SakkeKey* key, int wc_MakeSakkeEncapsulatedSSV(SakkeKey* key,
enum wc_HashType hashType, byte* ssv, word16 ssvSz, byte* auth, enum wc_HashType hashType, byte* ssv, word16 ssvSz, byte* auth,
word16* authSz); word16* authSz);
/*! /*!
\ingroup SAKKE_Operations \ingroup SAKKE_Operations
*/ */
WOLFSSL_API int wc_GenerateSakkeSSV(SakkeKey* key, WC_RNG* rng, byte* ssv, int wc_GenerateSakkeSSV(SakkeKey* key, WC_RNG* rng, byte* ssv,
word16* ssvSz); word16* ssvSz);
/*! /*!
\ingroup SAKKE_RSK \ingroup SAKKE_RSK
*/ */
WOLFSSL_API int wc_SetSakkeRsk(SakkeKey* key, const ecc_point* rsk, byte* table, int wc_SetSakkeRsk(SakkeKey* key, const ecc_point* rsk, byte* table,
word32 len); word32 len);
/*! /*!
\ingroup SAKKE_Operations \ingroup SAKKE_Operations
*/ */
WOLFSSL_API int wc_DeriveSakkeSSV(SakkeKey* key, enum wc_HashType hashType, int wc_DeriveSakkeSSV(SakkeKey* key, enum wc_HashType hashType,
byte* ssv, word16 ssvSz, const byte* auth, byte* ssv, word16 ssvSz, const byte* auth,
word16 authSz); word16 authSz);

10
doc/dox_comments/header_files/sha.h
View File

@ -24,7 +24,7 @@
\sa wc_ShaUpdate \sa wc_ShaUpdate
\sa wc_ShaFinal \sa wc_ShaFinal
*/ */
WOLFSSL_API int wc_InitSha(wc_Sha*); int wc_InitSha(wc_Sha*);
/*! /*!
\ingroup SHA \ingroup SHA
@ -57,7 +57,7 @@ WOLFSSL_API int wc_InitSha(wc_Sha*);
\sa wc_ShaFinal \sa wc_ShaFinal
\sa wc_InitSha \sa wc_InitSha
*/ */
WOLFSSL_API int wc_ShaUpdate(wc_Sha*, const byte*, word32); int wc_ShaUpdate(wc_Sha* sha, const byte* data, word32 len);
/*! /*!
\ingroup SHA \ingroup SHA
@ -89,7 +89,7 @@ WOLFSSL_API int wc_ShaUpdate(wc_Sha*, const byte*, word32);
\sa wc_InitSha \sa wc_InitSha
\sa wc_ShaGetHash \sa wc_ShaGetHash
*/ */
WOLFSSL_API int wc_ShaFinal(wc_Sha*, byte*); int wc_ShaFinal(wc_Sha* sha, byte* hash);
/*! /*!
\ingroup SHA \ingroup SHA
@ -113,7 +113,7 @@ WOLFSSL_API int wc_ShaFinal(wc_Sha*, byte*);
\sa wc_ShaUpdate \sa wc_ShaUpdate
\sa wc_ShaFinal \sa wc_ShaFinal
*/ */
WOLFSSL_API void wc_ShaFree(wc_Sha*); void wc_ShaFree(wc_Sha*);
/*! /*!
\ingroup SHA \ingroup SHA
@ -142,4 +142,4 @@ WOLFSSL_API void wc_ShaFree(wc_Sha*);
\sa wc_ShaFinal \sa wc_ShaFinal
\sa wc_InitSha \sa wc_InitSha
*/ */
WOLFSSL_API int wc_ShaGetHash(wc_Sha*, byte*); int wc_ShaGetHash(wc_Sha* sha, byte* hash);

16
doc/dox_comments/header_files/sha256.h
View File

@ -24,7 +24,7 @@
\sa wc_Sha256Update \sa wc_Sha256Update
\sa wc_Sha256Final \sa wc_Sha256Final
*/ */
WOLFSSL_API int wc_InitSha256(wc_Sha256*); int wc_InitSha256(wc_Sha256*);
/*! /*!
\ingroup SHA \ingroup SHA
@ -57,7 +57,7 @@ WOLFSSL_API int wc_InitSha256(wc_Sha256*);
\sa wc_Sha256Final \sa wc_Sha256Final
\sa wc_InitSha256 \sa wc_InitSha256
*/ */
WOLFSSL_API int wc_Sha256Update(wc_Sha256*, const byte*, word32); int wc_Sha256Update(wc_Sha256* sha, const byte* data, word32 len);
/*! /*!
\ingroup SHA \ingroup SHA
@ -89,7 +89,7 @@ WOLFSSL_API int wc_Sha256Update(wc_Sha256*, const byte*, word32);
\sa wc_Sha256GetHash \sa wc_Sha256GetHash
\sa wc_InitSha256 \sa wc_InitSha256
*/ */
WOLFSSL_API int wc_Sha256Final(wc_Sha256*, byte*); int wc_Sha256Final(wc_Sha256* sha256, byte* hash);
/*! /*!
\ingroup SHA \ingroup SHA
@ -121,7 +121,7 @@ WOLFSSL_API int wc_Sha256Final(wc_Sha256*, byte*);
\sa wc_Sha256Update \sa wc_Sha256Update
\sa wc_Sha256Final \sa wc_Sha256Final
*/ */
WOLFSSL_API void wc_Sha256Free(wc_Sha256*); void wc_Sha256Free(wc_Sha256*);
/*! /*!
\ingroup SHA \ingroup SHA
@ -150,7 +150,7 @@ WOLFSSL_API void wc_Sha256Free(wc_Sha256*);
\sa wc_Sha256Final \sa wc_Sha256Final
\sa wc_InitSha256 \sa wc_InitSha256
*/ */
WOLFSSL_API int wc_Sha256GetHash(wc_Sha256*, byte*); int wc_Sha256GetHash(wc_Sha256* sha256, byte* hash);
/*! /*!
\ingroup SHA \ingroup SHA
@ -175,7 +175,7 @@ WOLFSSL_API int wc_Sha256GetHash(wc_Sha256*, byte*);
\sa wc_Sha224Update \sa wc_Sha224Update
\sa wc_Sha224Final \sa wc_Sha224Final
*/ */
WOLFSSL_API int wc_InitSha224(wc_Sha224*); int wc_InitSha224(wc_Sha224*);
/*! /*!
\ingroup SHA \ingroup SHA
@ -210,7 +210,7 @@ WOLFSSL_API int wc_InitSha224(wc_Sha224*);
\sa wc_Sha224Final \sa wc_Sha224Final
\sa wc_Sha224Hash \sa wc_Sha224Hash
*/ */
WOLFSSL_API int wc_Sha224Update(wc_Sha224*, const byte*, word32); int wc_Sha224Update(wc_Sha224* sha224, const byte* data, word32 len);
/*! /*!
\ingroup SHA \ingroup SHA
@ -243,4 +243,4 @@ WOLFSSL_API int wc_Sha224Update(wc_Sha224*, const byte*, word32);
\sa wc_Sha224Hash \sa wc_Sha224Hash
\sa wc_Sha224Update \sa wc_Sha224Update
*/ */
WOLFSSL_API int wc_Sha224Final(wc_Sha224*, byte*); int wc_Sha224Final(wc_Sha224* sha224, byte* hash);

12
doc/dox_comments/header_files/sha512.h
View File

@ -24,7 +24,7 @@
\sa wc_Sha512Update \sa wc_Sha512Update
\sa wc_Sha512Final \sa wc_Sha512Final
*/ */
WOLFSSL_API int wc_InitSha512(wc_Sha512*); int wc_InitSha512(wc_Sha512*);
/*! /*!
\ingroup SHA \ingroup SHA
@ -57,7 +57,7 @@ WOLFSSL_API int wc_InitSha512(wc_Sha512*);
\sa wc_Sha512Final \sa wc_Sha512Final
\sa wc_InitSha512 \sa wc_InitSha512
*/ */
WOLFSSL_API int wc_Sha512Update(wc_Sha512*, const byte*, word32); int wc_Sha512Update(wc_Sha512* sha, const byte* data, word32 len);
/*! /*!
\ingroup SHA \ingroup SHA
@ -88,7 +88,7 @@ WOLFSSL_API int wc_Sha512Update(wc_Sha512*, const byte*, word32);
\sa wc_Sha512Final \sa wc_Sha512Final
\sa wc_InitSha512 \sa wc_InitSha512
*/ */
WOLFSSL_API int wc_Sha512Final(wc_Sha512*, byte*); int wc_Sha512Final(wc_Sha512* sha512, byte* hash);
/*! /*!
\ingroup SHA \ingroup SHA
@ -116,7 +116,7 @@ WOLFSSL_API int wc_Sha512Final(wc_Sha512*, byte*);
\sa wc_Sha384Update \sa wc_Sha384Update
\sa wc_Sha384Final \sa wc_Sha384Final
*/ */
WOLFSSL_API int wc_InitSha384(wc_Sha384*); int wc_InitSha384(wc_Sha384*);
/*! /*!
\ingroup SHA \ingroup SHA
@ -149,7 +149,7 @@ WOLFSSL_API int wc_InitSha384(wc_Sha384*);
\sa wc_Sha384Final \sa wc_Sha384Final
\sa wc_InitSha384 \sa wc_InitSha384
*/ */
WOLFSSL_API int wc_Sha384Update(wc_Sha384*, const byte*, word32); int wc_Sha384Update(wc_Sha384* sha, const byte* data, word32 len);
/*! /*!
\ingroup SHA \ingroup SHA
@ -180,4 +180,4 @@ WOLFSSL_API int wc_Sha384Update(wc_Sha384*, const byte*, word32);
\sa wc_Sha384Final \sa wc_Sha384Final
\sa wc_InitSha384 \sa wc_InitSha384
*/ */
WOLFSSL_API int wc_Sha384Final(wc_Sha384*, byte*); int wc_Sha384Final(wc_Sha384* sha384, byte* hash);

6
doc/dox_comments/header_files/signature.h
View File

@ -29,7 +29,7 @@
\sa wc_SignatureGenerate \sa wc_SignatureGenerate
\sa wc_SignatureVerify \sa wc_SignatureVerify
*/ */
WOLFSSL_API int wc_SignatureGetSize(enum wc_SignatureType sig_type, int wc_SignatureGetSize(enum wc_SignatureType sig_type,
const void* key, word32 key_len); const void* key, word32 key_len);
/*! /*!
@ -76,7 +76,7 @@ WOLFSSL_API int wc_SignatureGetSize(enum wc_SignatureType sig_type,
\sa wc_SignatureGetSize \sa wc_SignatureGetSize
\sa wc_SignatureGenerate \sa wc_SignatureGenerate
*/ */
WOLFSSL_API int wc_SignatureVerify( int wc_SignatureVerify(
enum wc_HashType hash_type, enum wc_SignatureType sig_type, enum wc_HashType hash_type, enum wc_SignatureType sig_type,
const byte* data, word32 data_len, const byte* data, word32 data_len,
const byte* sig, word32 sig_len, const byte* sig, word32 sig_len,
@ -139,7 +139,7 @@ WOLFSSL_API int wc_SignatureVerify(
\sa wc_SignatureGetSize \sa wc_SignatureGetSize
\sa wc_SignatureVerify \sa wc_SignatureVerify
*/ */
WOLFSSL_API int wc_SignatureGenerate( int wc_SignatureGenerate(
enum wc_HashType hash_type, enum wc_SignatureType sig_type, enum wc_HashType hash_type, enum wc_SignatureType sig_type,
const byte* data, word32 data_len, const byte* data, word32 data_len,
byte* sig, word32 *sig_len, byte* sig, word32 *sig_len,

8
doc/dox_comments/header_files/siphash.h
View File

@ -33,7 +33,7 @@
\sa wc_SipHashUpdate \sa wc_SipHashUpdate
\sa wc_SipHashFinal \sa wc_SipHashFinal
*/ */
WOLFSSL_API int wc_InitSipHash(SipHash* siphash, const unsigned char* key, int wc_InitSipHash(SipHash* siphash, const unsigned char* key,
unsigned char outSz); unsigned char outSz);
/*! /*!
@ -71,7 +71,7 @@ WOLFSSL_API int wc_InitSipHash(SipHash* siphash, const unsigned char* key,
\sa wc_InitSipHash \sa wc_InitSipHash
\sa wc_SipHashFinal \sa wc_SipHashFinal
*/ */
WOLFSSL_API int wc_SipHashUpdate(SipHash* siphash, const unsigned char* in, int wc_SipHashUpdate(SipHash* siphash, const unsigned char* in,
word32 inSz); word32 inSz);
/*! /*!
@ -109,7 +109,7 @@ WOLFSSL_API int wc_SipHashUpdate(SipHash* siphash, const unsigned char* in,
\sa wc_InitSipHash \sa wc_InitSipHash
\sa wc_SipHashUpdate \sa wc_SipHashUpdate
*/ */
WOLFSSL_API int wc_SipHashFinal(SipHash* siphash, unsigned char* out, int wc_SipHashFinal(SipHash* siphash, unsigned char* out,
unsigned char outSz); unsigned char outSz);
/*! /*!
@ -146,6 +146,6 @@ WOLFSSL_API int wc_SipHashFinal(SipHash* siphash, unsigned char* out,
\sa wc_SipHashUpdate \sa wc_SipHashUpdate
\sa wc_SipHashFinal \sa wc_SipHashFinal
*/ */
WOLFSSL_API int wc_SipHash(const unsigned char* key, const unsigned char* in, int wc_SipHash(const unsigned char* key, const unsigned char* in,
word32 inSz, unsigned char* out, unsigned char outSz); word32 inSz, unsigned char* out, unsigned char outSz);

24
doc/dox_comments/header_files/srp.h
View File

@ -30,7 +30,7 @@
\sa wc_SrpTerm \sa wc_SrpTerm
\sa wc_SrpSetUsername \sa wc_SrpSetUsername
*/ */
WOLFSSL_API int wc_SrpInit(Srp* srp, SrpType type, SrpSide side); int wc_SrpInit(Srp* srp, SrpType type, SrpSide side);
/*! /*!
\ingroup SRP \ingroup SRP
@ -51,7 +51,7 @@ WOLFSSL_API int wc_SrpInit(Srp* srp, SrpType type, SrpSide side);
\sa wc_SrpInit \sa wc_SrpInit
*/ */
WOLFSSL_API void wc_SrpTerm(Srp* srp); void wc_SrpTerm(Srp* srp);
/*! /*!
\ingroup SRP \ingroup SRP
@ -86,7 +86,7 @@ WOLFSSL_API void wc_SrpTerm(Srp* srp);
\sa wc_SrpSetParams \sa wc_SrpSetParams
\sa wc_SrpTerm \sa wc_SrpTerm
*/ */
WOLFSSL_API int wc_SrpSetUsername(Srp* srp, const byte* username, word32 size); int wc_SrpSetUsername(Srp* srp, const byte* username, word32 size);
/*! /*!
\ingroup SRP \ingroup SRP
@ -133,7 +133,7 @@ WOLFSSL_API int wc_SrpSetUsername(Srp* srp, const byte* username, word32 size);
\sa wc_SrpSetUsername \sa wc_SrpSetUsername
\sa wc_SrpTerm \sa wc_SrpTerm
*/ */
WOLFSSL_API int wc_SrpSetParams(Srp* srp, const byte* N, word32 nSz, int wc_SrpSetParams(Srp* srp, const byte* N, word32 nSz,
const byte* g, word32 gSz, const byte* g, word32 gSz,
const byte* salt, word32 saltSz); const byte* salt, word32 saltSz);
@ -184,7 +184,7 @@ WOLFSSL_API int wc_SrpSetParams(Srp* srp, const byte* N, word32 nSz,
\sa wc_SrpSetUsername \sa wc_SrpSetUsername
\sa wc_SrpSetParams \sa wc_SrpSetParams
*/ */
WOLFSSL_API int wc_SrpSetPassword(Srp* srp, const byte* password, word32 size); int wc_SrpSetPassword(Srp* srp, const byte* password, word32 size);
/*! /*!
\ingroup SRP \ingroup SRP
@ -227,7 +227,7 @@ WOLFSSL_API int wc_SrpSetPassword(Srp* srp, const byte* password, word32 size);
\sa wc_SrpSetParams \sa wc_SrpSetParams
\sa wc_SrpGetVerifier \sa wc_SrpGetVerifier
*/ */
WOLFSSL_API int wc_SrpSetVerifier(Srp* srp, const byte* verifier, word32 size); int wc_SrpSetVerifier(Srp* srp, const byte* verifier, word32 size);
/*! /*!
\ingroup SRP \ingroup SRP
@ -278,7 +278,7 @@ WOLFSSL_API int wc_SrpSetVerifier(Srp* srp, const byte* verifier, word32 size);
\sa wc_SrpSetVerifier \sa wc_SrpSetVerifier
\sa wc_SrpSetPassword \sa wc_SrpSetPassword
*/ */
WOLFSSL_API int wc_SrpGetVerifier(Srp* srp, byte* verifier, word32* size); int wc_SrpGetVerifier(Srp* srp, byte* verifier, word32* size);
/*! /*!
\ingroup SRP \ingroup SRP
@ -328,7 +328,7 @@ WOLFSSL_API int wc_SrpGetVerifier(Srp* srp, byte* verifier, word32* size);
\sa wc_SrpGetPublic \sa wc_SrpGetPublic
*/ */
WOLFSSL_API int wc_SrpSetPrivate(Srp* srp, const byte* priv, word32 size); int wc_SrpSetPrivate(Srp* srp, const byte* priv, word32 size);
/*! /*!
\ingroup SRP \ingroup SRP
@ -383,7 +383,7 @@ WOLFSSL_API int wc_SrpSetPrivate(Srp* srp, const byte* priv, word32 size);
\sa wc_SrpSetPassword \sa wc_SrpSetPassword
\sa wc_SrpSetVerifier \sa wc_SrpSetVerifier
*/ */
WOLFSSL_API int wc_SrpGetPublic(Srp* srp, byte* pub, word32* size); int wc_SrpGetPublic(Srp* srp, byte* pub, word32* size);
/*! /*!
\ingroup SRP \ingroup SRP
@ -434,7 +434,7 @@ WOLFSSL_API int wc_SrpGetPublic(Srp* srp, byte* pub, word32* size);
\sa wc_SrpGetPublic \sa wc_SrpGetPublic
*/ */
WOLFSSL_API int wc_SrpComputeKey(Srp* srp, int wc_SrpComputeKey(Srp* srp,
byte* clientPubKey, word32 clientPubKeySz, byte* clientPubKey, word32 clientPubKeySz,
byte* serverPubKey, word32 serverPubKeySz); byte* serverPubKey, word32 serverPubKeySz);
@ -468,7 +468,7 @@ WOLFSSL_API int wc_SrpComputeKey(Srp* srp,
\sa wc_SrpComputeKey \sa wc_SrpComputeKey
*/ */
WOLFSSL_API int wc_SrpGetProof(Srp* srp, byte* proof, word32* size); int wc_SrpGetProof(Srp* srp, byte* proof, word32* size);
/*! /*!
\ingroup SRP \ingroup SRP
@ -504,4 +504,4 @@ WOLFSSL_API int wc_SrpGetProof(Srp* srp, byte* proof, word32* size);
\sa wc_SrpGetProof \sa wc_SrpGetProof
\sa wc_SrpTerm \sa wc_SrpTerm
*/ */
WOLFSSL_API int wc_SrpVerifyPeersProof(Srp* srp, byte* proof, word32 size); int wc_SrpVerifyPeersProof(Srp* srp, byte* proof, word32 size);

951
doc/dox_comments/header_files/ssl.h
View File

File diff suppressed because it is too large Load Diff

2
doc/dox_comments/header_files/tfm.h
View File

@ -26,4 +26,4 @@
\sa CheckRunTimeSettings \sa CheckRunTimeSettings
*/ */
WOLFSSL_API word32 CheckRunTimeFastMath(void); word32 CheckRunTimeFastMath(void);

8
doc/dox_comments/header_files/types.h
View File

@ -45,7 +45,7 @@
\sa wolfSSL_Free \sa wolfSSL_Free
\sa wolfSSL_SetAllocators \sa wolfSSL_SetAllocators
*/ */
WOLFSSL_API void* XMALLOC(size_t n, void* heap, int type); void* XMALLOC(size_t n, void* heap, int type);
/*! /*!
\ingroup Memory \ingroup Memory
@ -93,7 +93,7 @@ WOLFSSL_API void* XMALLOC(size_t n, void* heap, int type);
\sa wolfSSL_Free \sa wolfSSL_Free
\sa wolfSSL_SetAllocators \sa wolfSSL_SetAllocators
*/ */
WOLFSSL_API void* XREALLOC(void *p, size_t n, void* heap, int type); void* XREALLOC(void *p, size_t n, void* heap, int type);
/*! /*!
\ingroup Memory \ingroup Memory
@ -140,7 +140,7 @@ WOLFSSL_API void* XREALLOC(void *p, size_t n, void* heap, int type);
\sa wolfSSL_Free \sa wolfSSL_Free
\sa wolfSSL_SetAllocators \sa wolfSSL_SetAllocators
*/ */
WOLFSSL_API void XFREE(void *p, void* heap, int type); void XFREE(void *p, void* heap, int type);
/*! /*!
\ingroup Math \ingroup Math
@ -169,4 +169,4 @@ WOLFSSL_API void XFREE(void *p, void* heap, int type);
\sa CheckRunTimeFastMath \sa CheckRunTimeFastMath
*/ */
WOLFSSL_API word32 CheckRunTimeSettings(void); word32 CheckRunTimeSettings(void);

10
doc/dox_comments/header_files/wc_encrypt.h
View File

@ -42,7 +42,7 @@
\sa wc_AesCbcEncrypt \sa wc_AesCbcEncrypt
\sa wc_AesCbcDecrypt \sa wc_AesCbcDecrypt
*/ */
WOLFSSL_API int wc_AesCbcDecryptWithKey(byte* out, const byte* in, word32 inSz, int wc_AesCbcDecryptWithKey(byte* out, const byte* in, word32 inSz,
const byte* key, word32 keySz, const byte* key, word32 keySz,
const byte* iv); const byte* iv);
@ -84,7 +84,7 @@ WOLFSSL_API int wc_AesCbcDecryptWithKey(byte* out, const byte* in, word32 inSz,
\sa wc_Des_CbcDecrypt \sa wc_Des_CbcDecrypt
*/ */
WOLFSSL_API int wc_Des_CbcDecryptWithKey(byte* out, int wc_Des_CbcDecryptWithKey(byte* out,
const byte* in, word32 sz, const byte* in, word32 sz,
const byte* key, const byte* iv); const byte* key, const byte* iv);
@ -123,7 +123,7 @@ WOLFSSL_API int wc_Des_CbcDecryptWithKey(byte* out,
\sa wc_Des_CbcDecryptWithKey \sa wc_Des_CbcDecryptWithKey
\sa wc_Des_CbcEncrypt \sa wc_Des_CbcEncrypt
*/ */
WOLFSSL_API int wc_Des_CbcEncryptWithKey(byte* out, int wc_Des_CbcEncryptWithKey(byte* out,
const byte* in, word32 sz, const byte* in, word32 sz,
const byte* key, const byte* iv); const byte* key, const byte* iv);
@ -165,7 +165,7 @@ WOLFSSL_API int wc_Des_CbcEncryptWithKey(byte* out,
\sa wc_Des_CbcEncryptWithKey \sa wc_Des_CbcEncryptWithKey
\sa wc_Des_CbcDecryptWithKey \sa wc_Des_CbcDecryptWithKey
*/ */
WOLFSSL_API int wc_Des3_CbcEncryptWithKey(byte* out, int wc_Des3_CbcEncryptWithKey(byte* out,
const byte* in, word32 sz, const byte* in, word32 sz,
const byte* key, const byte* iv); const byte* key, const byte* iv);
@ -207,6 +207,6 @@ WOLFSSL_API int wc_Des3_CbcEncryptWithKey(byte* out,
\sa wc_Des3_CbcDecrypt \sa wc_Des3_CbcDecrypt
*/ */
WOLFSSL_API int wc_Des3_CbcDecryptWithKey(byte* out, int wc_Des3_CbcDecryptWithKey(byte* out,
const byte* in, word32 sz, const byte* in, word32 sz,
const byte* key, const byte* iv); const byte* key, const byte* iv);

4
doc/dox_comments/header_files/wc_port.h
View File

@ -18,7 +18,7 @@
\sa wolfCrypt_Cleanup \sa wolfCrypt_Cleanup
*/ */
WOLFSSL_API int wolfCrypt_Init(void); int wolfCrypt_Init(void);
/*! /*!
\ingroup wolfCrypt \ingroup wolfCrypt
@ -40,4 +40,4 @@ WOLFSSL_API int wolfCrypt_Init(void);
\sa wolfCrypt_Init \sa wolfCrypt_Init
*/ */
WOLFSSL_API int wolfCrypt_Cleanup(void); int wolfCrypt_Cleanup(void);

34
doc/dox_comments/header_files/wolfio.h
View File

@ -39,7 +39,7 @@
\sa wolfSSL_CTX_SetIORecv \sa wolfSSL_CTX_SetIORecv
\sa wolfSSL_SSLSetIORecv \sa wolfSSL_SSLSetIORecv
*/ */
WOLFSSL_API int EmbedReceive(WOLFSSL* ssl, char* buf, int sz, void* ctx); int EmbedReceive(WOLFSSL* ssl, char* buf, int sz, void* ctx);
/*! /*!
\brief This function is the send embedded callback. \brief This function is the send embedded callback.
@ -77,7 +77,7 @@ WOLFSSL_API int EmbedReceive(WOLFSSL* ssl, char* buf, int sz, void* ctx);
\sa wolfSSL_CTX_SetIOSend \sa wolfSSL_CTX_SetIOSend
\sa wolfSSL_SSLSetIOSend \sa wolfSSL_SSLSetIOSend
*/ */
WOLFSSL_API int EmbedSend(WOLFSSL* ssl, char* buf, int sz, void* ctx); int EmbedSend(WOLFSSL* ssl, char* buf, int sz, void* ctx);
/*! /*!
\brief This function is the receive embedded callback. \brief This function is the receive embedded callback.
@ -115,7 +115,7 @@ WOLFSSL_API int EmbedSend(WOLFSSL* ssl, char* buf, int sz, void* ctx);
\sa wolfSSL_SSLSetIORecv \sa wolfSSL_SSLSetIORecv
\sa wolfSSL_dtls_get_current_timeout \sa wolfSSL_dtls_get_current_timeout
*/ */
WOLFSSL_API int EmbedReceiveFrom(WOLFSSL* ssl, char* buf, int sz, void*); int EmbedReceiveFrom(WOLFSSL* ssl, char* buf, int sz, void*);
/*! /*!
\brief This function is the send embedded callback. \brief This function is the send embedded callback.
@ -156,7 +156,7 @@ WOLFSSL_API int EmbedReceiveFrom(WOLFSSL* ssl, char* buf, int sz, void*);
\sa wolfSSL_CTX_SetIOSend \sa wolfSSL_CTX_SetIOSend
\sa wolfSSL_SSLSetIOSend \sa wolfSSL_SSLSetIOSend
*/ */
WOLFSSL_API int EmbedSendTo(WOLFSSL* ssl, char* buf, int sz, void* ctx); int EmbedSendTo(WOLFSSL* ssl, char* buf, int sz, void* ctx);
/*! /*!
\brief This function is the DTLS Generate Cookie callback. \brief This function is the DTLS Generate Cookie callback.
@ -189,7 +189,7 @@ WOLFSSL_API int EmbedSendTo(WOLFSSL* ssl, char* buf, int sz, void* ctx);
\sa wolfSSL_CTX_SetGenCookie \sa wolfSSL_CTX_SetGenCookie
*/ */
WOLFSSL_API int EmbedGenerateCookie(WOLFSSL* ssl, unsigned char* buf, int EmbedGenerateCookie(WOLFSSL* ssl, unsigned char* buf,
int sz, void*); int sz, void*);
/*! /*!
@ -212,7 +212,7 @@ WOLFSSL_API int EmbedGenerateCookie(WOLFSSL* ssl, unsigned char* buf,
\sa wolfSSL_CertManagerEnableOCSPStapling \sa wolfSSL_CertManagerEnableOCSPStapling
\sa wolfSSL_CertManagerEnableOCSP \sa wolfSSL_CertManagerEnableOCSP
*/ */
WOLFSSL_API void EmbedOcspRespFree(void*, unsigned char*); void EmbedOcspRespFree(void* ctx, byte* resp);
/*! /*!
\brief This function registers a receive callback for wolfSSL to get input \brief This function registers a receive callback for wolfSSL to get input
@ -247,7 +247,7 @@ WOLFSSL_API void EmbedOcspRespFree(void*, unsigned char*);
\sa wolfSSL_SetIOReadCtx \sa wolfSSL_SetIOReadCtx
\sa wolfSSL_SetIOWriteCtx \sa wolfSSL_SetIOWriteCtx
*/ */
WOLFSSL_API void wolfSSL_CTX_SetIORecv(WOLFSSL_CTX*, CallbackIORecv); void wolfSSL_CTX_SetIORecv(WOLFSSL_CTX* ctx, CallbackIORecv CBIORecv);
/*! /*!
\brief This function registers a context for the SSL session’s receive \brief This function registers a context for the SSL session’s receive
@ -278,7 +278,7 @@ WOLFSSL_API void wolfSSL_CTX_SetIORecv(WOLFSSL_CTX*, CallbackIORecv);
\sa wolfSSL_CTX_SetIOSend \sa wolfSSL_CTX_SetIOSend
\sa wolfSSL_SetIOWriteCtx \sa wolfSSL_SetIOWriteCtx
*/ */
WOLFSSL_API void wolfSSL_SetIOReadCtx( WOLFSSL* ssl, void *ctx); void wolfSSL_SetIOReadCtx( WOLFSSL* ssl, void *ctx);
/*! /*!
\brief This function registers a context for the SSL session’s send \brief This function registers a context for the SSL session’s send
@ -309,7 +309,7 @@ WOLFSSL_API void wolfSSL_SetIOReadCtx( WOLFSSL* ssl, void *ctx);
\sa wolfSSL_CTX_SetIOSend \sa wolfSSL_CTX_SetIOSend
\sa wolfSSL_SetIOReadCtx \sa wolfSSL_SetIOReadCtx
*/ */
WOLFSSL_API void wolfSSL_SetIOWriteCtx(WOLFSSL* ssl, void *ctx); void wolfSSL_SetIOWriteCtx(WOLFSSL* ssl, void *ctx);
/*! /*!
\ingroup IO \ingroup IO
@ -339,7 +339,7 @@ WOLFSSL_API void wolfSSL_SetIOWriteCtx(WOLFSSL* ssl, void *ctx);
\sa wolfSSL_SetIOReadCtx \sa wolfSSL_SetIOReadCtx
\sa wolfSSL_CTX_SetIOSend \sa wolfSSL_CTX_SetIOSend
*/ */
WOLFSSL_API void* wolfSSL_GetIOReadCtx( WOLFSSL* ssl); void* wolfSSL_GetIOReadCtx( WOLFSSL* ssl);
/*! /*!
\ingroup IO \ingroup IO
@ -368,7 +368,7 @@ WOLFSSL_API void* wolfSSL_GetIOReadCtx( WOLFSSL* ssl);
\sa wolfSSL_SetIOReadCtx \sa wolfSSL_SetIOReadCtx
\sa wolfSSL_CTX_SetIOSend \sa wolfSSL_CTX_SetIOSend
*/ */
WOLFSSL_API void* wolfSSL_GetIOWriteCtx(WOLFSSL* ssl); void* wolfSSL_GetIOWriteCtx(WOLFSSL* ssl);
/*! /*!
\brief This function sets the flags for the receive callback to use for \brief This function sets the flags for the receive callback to use for
@ -410,7 +410,7 @@ WOLFSSL_API void* wolfSSL_GetIOWriteCtx(WOLFSSL* ssl);
\sa wolfSSL_CTX_SetIOSend \sa wolfSSL_CTX_SetIOSend
\sa wolfSSL_SetIOReadCtx \sa wolfSSL_SetIOReadCtx
*/ */
WOLFSSL_API void wolfSSL_SetIOReadFlags( WOLFSSL* ssl, int flags); void wolfSSL_SetIOReadFlags( WOLFSSL* ssl, int flags);
/*! /*!
\brief This function sets the flags for the send callback to use for the \brief This function sets the flags for the send callback to use for the
@ -445,7 +445,7 @@ WOLFSSL_API void wolfSSL_SetIOReadFlags( WOLFSSL* ssl, int flags);
\sa wolfSSL_CTX_SetIOSend \sa wolfSSL_CTX_SetIOSend
\sa wolfSSL_SetIOReadCtx \sa wolfSSL_SetIOReadCtx
*/ */
WOLFSSL_API void wolfSSL_SetIOWriteFlags(WOLFSSL* ssl, int flags); void wolfSSL_SetIOWriteFlags(WOLFSSL* ssl, int flags);
/*! /*!
\ingroup IO \ingroup IO
@ -478,7 +478,7 @@ WOLFSSL_API void wolfSSL_SetIOWriteFlags(WOLFSSL* ssl, int flags);
\sa NetX_Send \sa NetX_Send
\sa NetX_Receive \sa NetX_Receive
*/ */
WOLFSSL_API void wolfSSL_SetIO_NetX(WOLFSSL* ssl, NX_TCP_SOCKET* nxsocket, void wolfSSL_SetIO_NetX(WOLFSSL* ssl, NX_TCP_SOCKET* nxsocket,
ULONG waitoption); ULONG waitoption);
/*! /*!
@ -507,7 +507,7 @@ WOLFSSL_API void wolfSSL_SetIO_NetX(WOLFSSL* ssl, NX_TCP_SOCKET* nxsocket,
\sa CallbackGenCookie \sa CallbackGenCookie
*/ */
WOLFSSL_API void wolfSSL_CTX_SetGenCookie(WOLFSSL_CTX*, CallbackGenCookie); void wolfSSL_CTX_SetGenCookie(WOLFSSL_CTX* ctx, CallbackGenCookie cb);
/*! /*!
\ingroup Setup \ingroup Setup
@ -536,7 +536,7 @@ WOLFSSL_API void wolfSSL_CTX_SetGenCookie(WOLFSSL_CTX*, CallbackGenCookie);
\sa wolfSSL_SetCookieCtx \sa wolfSSL_SetCookieCtx
\sa wolfSSL_CTX_SetGenCookie \sa wolfSSL_CTX_SetGenCookie
*/ */
WOLFSSL_API void* wolfSSL_GetCookieCtx(WOLFSSL* ssl); void* wolfSSL_GetCookieCtx(WOLFSSL* ssl);
/*! /*!
@ -571,7 +571,7 @@ WOLFSSL_API void* wolfSSL_GetCookieCtx(WOLFSSL* ssl);
receive_buffer, ISOTP_DEFAULT_BUFFER_SIZE, &can_con_info); receive_buffer, ISOTP_DEFAULT_BUFFER_SIZE, &can_con_info);
\endcode \endcode
*/ */
WOLFSSL_API int wolfSSL_SetIO_ISOTP(WOLFSSL *ssl, isotp_wolfssl_ctx *ctx, int wolfSSL_SetIO_ISOTP(WOLFSSL *ssl, isotp_wolfssl_ctx *ctx,
can_recv_fn recv_fn, can_send_fn send_fn, can_delay_fn delay_fn, can_recv_fn recv_fn, can_send_fn send_fn, can_delay_fn delay_fn,
word32 receive_delay, char *receive_buffer, int receive_buffer_size, word32 receive_delay, char *receive_buffer, int receive_buffer_size,
void *arg); void *arg);