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

Merge pull request #1642 from ejohnstown/conner-doc-update

Browse Source 
Doxy Update
This commit is contained in:
Chris Conlon
2018-06-27 14:37:52 -06:00
committed by GitHub
parent 5d767aa004 47497f5aaa
commit ac3eb470f9
42 changed files with 752 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -30,6 +30,7 @@
*/
WOLFSSL_API int wc_AesSetKey(Aes* aes, const byte* key, word32 len,
const byte* iv, int dir);
/*!
\ingroup AES
\brief This function sets the initialization vector for a
@ -58,6 +59,7 @@ WOLFSSL_API int wc_AesSetKey(Aes* aes, const byte* key, word32 len,
\sa wc_AesSetKey
*/
WOLFSSL_API int wc_AesSetIV(Aes* aes, const byte* iv);
/*!
\ingroup AES
\brief Encrypts a plaintext message from the input buffer in, and places
@ -100,6 +102,7 @@ WOLFSSL_API int wc_AesSetIV(Aes* aes, const byte* iv);
*/
WOLFSSL_API int wc_AesCbcEncrypt(Aes* aes, byte* out,
const byte* in, word32 sz);
/*!
\ingroup AES
\brief Decrypts a cipher from the input buffer in, and places the
@ -142,6 +145,7 @@ WOLFSSL_API int wc_AesCbcEncrypt(Aes* aes, byte* out,
*/
WOLFSSL_API int wc_AesCbcDecrypt(Aes* aes, byte* out,
const byte* in, word32 sz);
/*!
\ingroup AES
\brief Encrypts/Decrypts a message from the input buffer in, and places
@ -184,8 +188,9 @@ WOLFSSL_API int wc_AesCbcDecrypt(Aes* aes, byte* out,
\sa wc_AesSetKey
*/
WOLFSSL_API int wc_AesCtrEncrypt(Aes* aes, byte* out,
WOLFSSL_API int wc_AesCtrEncrypt(Aes* aes, byte* out,
const byte* in, word32 sz);
/*!
\ingroup AES
\brief This function is a one-block encrypt of the input block, in, into
@ -214,7 +219,8 @@ WOLFSSL_API int wc_AesCbcDecrypt(Aes* aes, byte* out,
\sa wc_AesDecryptDirect
\sa wc_AesSetKeyDirect
*/
WOLFSSL_API void wc_AesEncryptDirect(Aes* aes, byte* out, const byte* in);
WOLFSSL_API void wc_AesEncryptDirect(Aes* aes, byte* out, const byte* in);
/*!
\ingroup AES
\brief This function is a one-block decrypt of the input block, in, into
@ -247,7 +253,8 @@ WOLFSSL_API int wc_AesCbcDecrypt(Aes* aes, byte* out,
\sa wc_AesEncryptDirect
\sa wc_AesSetKeyDirect
*/
WOLFSSL_API void wc_AesDecryptDirect(Aes* aes, byte* out, const byte* in);
WOLFSSL_API void wc_AesDecryptDirect(Aes* aes, byte* out, const byte* in);
/*!
\ingroup AES
\brief This function is used to set the AES keys for CTR mode with AES.
@ -286,8 +293,9 @@ WOLFSSL_API int wc_AesCbcDecrypt(Aes* aes, byte* out,
\sa wc_AesDecryptDirect
\sa wc_AesSetKey
*/
WOLFSSL_API int wc_AesSetKeyDirect(Aes* aes, const byte* key, word32 len,
WOLFSSL_API int wc_AesSetKeyDirect(Aes* aes, const byte* key, word32 len,
const byte* iv, int dir);
/*!
\ingroup AES
\brief This function is used to set the key for AES GCM
@ -315,7 +323,8 @@ WOLFSSL_API int wc_AesCbcDecrypt(Aes* aes, byte* out,
\sa wc_AesGcmEncrypt
\sa wc_AesGcmDecrypt
*/
WOLFSSL_API int wc_AesGcmSetKey(Aes* aes, const byte* key, word32 len);
WOLFSSL_API int wc_AesGcmSetKey(Aes* aes, const byte* key, word32 len);
/*!
\ingroup AES
\brief This function encrypts the input message, held in the buffer in,
@ -359,11 +368,12 @@ WOLFSSL_API int wc_AesCbcDecrypt(Aes* aes, byte* out,
\sa wc_AesGcmSetKey
\sa wc_AesGcmDecrypt
*/
WOLFSSL_API int wc_AesGcmEncrypt(Aes* aes, byte* out,
WOLFSSL_API int wc_AesGcmEncrypt(Aes* aes, byte* out,
const byte* in, word32 sz,
const byte* iv, word32 ivSz,
byte* authTag, word32 authTagSz,
const byte* authIn, word32 authInSz);
/*!
\ingroup AES
\brief This function decrypts the input cipher text, held in the buffer
@ -407,11 +417,12 @@ WOLFSSL_API int wc_AesCbcDecrypt(Aes* aes, byte* out,
\sa wc_AesGcmSetKey
\sa wc_AesGcmEncrypt
*/
WOLFSSL_API int wc_AesGcmDecrypt(Aes* aes, byte* out,
WOLFSSL_API int wc_AesGcmDecrypt(Aes* aes, byte* out,
const byte* in, word32 sz,
const byte* iv, word32 ivSz,
const byte* authTag, word32 authTagSz,
const byte* authIn, word32 authInSz);
/*!
\ingroup AES
\brief This function initializes and sets the key for a GMAC object
@ -433,7 +444,8 @@ WOLFSSL_API int wc_AesCbcDecrypt(Aes* aes, byte* out,
\sa wc_GmacUpdate
*/
WOLFSSL_API int wc_GmacSetKey(Gmac* gmac, const byte* key, word32 len);
WOLFSSL_API int wc_GmacSetKey(Gmac* gmac, const byte* key, word32 len);
/*!
\ingroup AES
\brief This function generates the Gmac hash of the authIn input and
@ -468,9 +480,10 @@ WOLFSSL_API int wc_AesCbcDecrypt(Aes* aes, byte* out,
\sa wc_GmacSetKey
*/
WOLFSSL_API int wc_GmacUpdate(Gmac* gmac, const byte* iv, word32 ivSz,
WOLFSSL_API int wc_GmacUpdate(Gmac* gmac, const byte* iv, word32 ivSz,
const byte* authIn, word32 authInSz,
byte* authTag, word32 authTagSz);
/*!
\ingroup AES
\brief This function sets the key for an AES object using CCM
@ -494,7 +507,8 @@ WOLFSSL_API int wc_AesCbcDecrypt(Aes* aes, byte* out,
\sa wc_AesCcmEncrypt
\sa wc_AesCcmDecrypt
*/
WOLFSSL_API int wc_AesCcmSetKey(Aes* aes, const byte* key, word32 keySz);
WOLFSSL_API int wc_AesCcmSetKey(Aes* aes, const byte* key, word32 keySz);
/*!
\ingroup AES
@ -538,11 +552,12 @@ WOLFSSL_API int wc_AesCbcDecrypt(Aes* aes, byte* out,
\sa wc_AesCcmSetKey
\sa wc_AesCcmDecrypt
*/
WOLFSSL_API int wc_AesCcmEncrypt(Aes* aes, byte* out,
WOLFSSL_API int wc_AesCcmEncrypt(Aes* aes, byte* out,
const byte* in, word32 inSz,
const byte* nonce, word32 nonceSz,
byte* authTag, word32 authTagSz,
const byte* authIn, word32 authInSz);
/*!
\ingroup AES
@ -592,11 +607,12 @@ WOLFSSL_API int wc_AesCbcDecrypt(Aes* aes, byte* out,
\sa wc_AesCcmSetKey
\sa wc_AesCcmEncrypt
*/
WOLFSSL_API int wc_AesCcmDecrypt(Aes* aes, byte* out,
WOLFSSL_API int wc_AesCcmDecrypt(Aes* aes, byte* out,
const byte* in, word32 inSz,
const byte* nonce, word32 nonceSz,
const byte* authTag, word32 authTagSz,
const byte* authIn, word32 authInSz);
/*!
\ingroup AES
@ -631,6 +647,7 @@ WOLFSSL_API int wc_AesCbcDecrypt(Aes* aes, byte* out,
*/
WOLFSSL_API int wc_AesXtsSetKey(XtsAes* aes, const byte* key,
word32 len, int dir, void* heap, int devId);
/*!
\ingroup AES
@ -669,6 +686,7 @@ WOLFSSL_API int wc_AesXtsSetKey(XtsAes* aes, const byte* key,
*/
WOLFSSL_API int wc_AesXtsEncryptSector(XtsAes* aes, byte* out,
const byte* in, word32 sz, word64 sector);
/*!
\ingroup AES
@ -707,6 +725,7 @@ WOLFSSL_API int wc_AesXtsEncryptSector(XtsAes* aes, byte* out,
*/
WOLFSSL_API int wc_AesXtsDecryptSector(XtsAes* aes, byte* out,
const byte* in, word32 sz, word64 sector);
/*!
\ingroup AES
@ -746,6 +765,7 @@ WOLFSSL_API int wc_AesXtsDecryptSector(XtsAes* aes, byte* out,
*/
WOLFSSL_API int wc_AesXtsEncrypt(XtsAes* aes, byte* out,
const byte* in, word32 sz, const byte* i, word32 iSz);
/*!
\ingroup AES
@ -784,6 +804,7 @@ WOLFSSL_API int wc_AesXtsEncrypt(XtsAes* aes, byte* out,
*/
WOLFSSL_API int wc_AesXtsDecrypt(XtsAes* aes, byte* out,
const byte* in, word32 sz, const byte* i, word32 iSz);
/*!
\ingroup AES
@ -835,5 +856,5 @@ WOLFSSL_API int wc_AesXtsFree(XtsAes* aes);
\sa wc_AesSetKey
\sa wc_AesSetIV
*/
WOLFSSL_API int wc_AesInit(Aes* aes, void* heap, int devId);
WOLFSSL_API int wc_AesInit(Aes*, void*, int);

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

@ -33,6 +33,7 @@
\sa wc_Arc4SetKey
*/
WOLFSSL_API int wc_Arc4Process(Arc4*, byte*, const byte*, word32);
/*!
\ingroup ARC4

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

@ -694,6 +694,7 @@ WOLFSSL_API int wc_SetDatesBuffer(Cert*, const byte*, int);
*/
WOLFSSL_API int wc_SetAuthKeyIdFromPublicKey(Cert *cert, RsaKey *rsakey,
ecc_key *eckey);
/*!
\ingroup ASN

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

@ -20,6 +20,7 @@
\sa wc_Blake2bUpdate
*/
WOLFSSL_API int wc_InitBlake2b(Blake2b*, word32);
/*!
\ingroup BLAKE2
@ -54,6 +55,7 @@ WOLFSSL_API int wc_InitBlake2b(Blake2b*, word32);
\sa wc_Blake2bFinal
*/
WOLFSSL_API int wc_Blake2bUpdate(Blake2b*, const byte*, word32);
/*!
\ingroup BLAKE2

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

@ -37,6 +37,7 @@
*/
WOLFSSL_API int wc_CamelliaSetKey(Camellia* cam,
const byte* key, word32 len, const byte* iv);
/*!
\ingroup Camellia
@ -64,6 +65,7 @@ WOLFSSL_API int wc_CamelliaSetKey(Camellia* cam,
\sa wc_CamelliaSetKey
*/
WOLFSSL_API int wc_CamelliaSetIV(Camellia* cam, const byte* iv);
/*!
\ingroup Camellia
@ -92,6 +94,7 @@ WOLFSSL_API int wc_CamelliaSetIV(Camellia* cam, const byte* iv);
*/
WOLFSSL_API int wc_CamelliaEncryptDirect(Camellia* cam, byte* out,
const byte* in);
/*!
\ingroup Camellia
@ -121,6 +124,7 @@ WOLFSSL_API int wc_CamelliaEncryptDirect(Camellia* cam, byte* out,
*/
WOLFSSL_API int wc_CamelliaDecryptDirect(Camellia* cam, byte* out,
const byte* in);
/*!
\ingroup Camellia
@ -149,6 +153,7 @@ WOLFSSL_API int wc_CamelliaDecryptDirect(Camellia* cam, byte* out,
*/
WOLFSSL_API int wc_CamelliaCbcEncrypt(Camellia* cam,
byte* out, const byte* in, word32 sz);
/*!
\ingroup Camellia

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

@ -31,6 +31,7 @@
\sa wc_Chacha_Process
*/
WOLFSSL_API int wc_Chacha_SetIV(ChaCha* ctx, const byte* inIv, word32 counter);
/*!
\ingroup ChaCha
@ -65,6 +66,7 @@ WOLFSSL_API int wc_Chacha_SetIV(ChaCha* ctx, const byte* inIv, word32 counter);
*/
WOLFSSL_API int wc_Chacha_Process(ChaCha* ctx, byte* cipher, const byte* plain,
word32 msglen);
/*!
\ingroup ChaCha

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

@ -54,6 +54,7 @@ int wc_ChaCha20Poly1305_Encrypt(
const byte* inPlaintext, const word32 inPlaintextLen,
byte* outCiphertext,
byte outAuthTag[CHACHA20_POLY1305_AEAD_AUTHTAG_SIZE]);
/*!
\ingroup ChaCha20Poly1305

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

@ -37,6 +37,7 @@
*/
WOLFSSL_API int Base64_Decode(const byte* in, word32 inLen, byte* out,
word32* outLen);
/*!
\ingroup Base_Encoding
@ -77,6 +78,7 @@ WOLFSSL_API int Base64_Decode(const byte* in, word32 inLen, byte* out,
WOLFSSL_API
int Base64_Encode(const byte* in, word32 inLen, byte* out,
word32* outLen);
/*!
\ingroup Base_Encoding
@ -118,6 +120,7 @@ int Base64_Encode(const byte* in, word32 inLen, byte* out,
*/
int Base64_EncodeEsc(const byte* in, word32 inLen, byte* out,
word32* outLen);
/*!
\ingroup Base_Encoding
@ -157,6 +160,7 @@ int Base64_EncodeEsc(const byte* in, word32 inLen, byte* out,
WOLFSSL_API
int Base64_Encode_NoNl(const byte* in, word32 inLen, byte* out,
word32* outLen);
/*!
\ingroup Base_Encoding
@ -194,6 +198,7 @@ int Base64_Encode_NoNl(const byte* in, word32 inLen, byte* out,
*/
WOLFSSL_API
int Base16_Decode(const byte* in, word32 inLen, byte* out, word32* outLen);
/*!
\ingroup Base_Encoding

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

@ -37,6 +37,7 @@
\sa wc_DeCompress
*/
WOLFSSL_API int wc_Compress(byte*, word32, const byte*, word32, word32);
/*!
\ingroup Compression

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

@ -35,6 +35,7 @@
*/
WOLFSSL_API
int wc_curve25519_make_key(WC_RNG* rng, int keysize, curve25519_key* key);
/*!
\ingroup Curve25519
@ -79,6 +80,7 @@ WOLFSSL_API
int wc_curve25519_shared_secret(curve25519_key* private_key,
curve25519_key* public_key,
byte* out, word32* outlen);
/*!
\ingroup Curve25519
@ -126,6 +128,7 @@ WOLFSSL_API
int wc_curve25519_shared_secret_ex(curve25519_key* private_key,
curve25519_key* public_key,
byte* out, word32* outlen, int endian);
/*!
\ingroup Curve25519
@ -149,6 +152,7 @@ int wc_curve25519_shared_secret_ex(curve25519_key* private_key,
*/
WOLFSSL_API
int wc_curve25519_init(curve25519_key* key);
/*!
\ingroup Curve25519
@ -170,6 +174,7 @@ int wc_curve25519_init(curve25519_key* key);
*/
WOLFSSL_API
void wc_curve25519_free(curve25519_key* key);
/*!
\ingroup Curve25519
@ -202,6 +207,7 @@ void wc_curve25519_free(curve25519_key* key);
WOLFSSL_API
int wc_curve25519_import_private(const byte* priv, word32 privSz,
curve25519_key* key);
/*!
\ingroup Curve25519
@ -238,6 +244,7 @@ int wc_curve25519_import_private(const byte* priv, word32 privSz,
WOLFSSL_API
int wc_curve25519_import_private_ex(const byte* priv, word32 privSz,
curve25519_key* key, int endian);
/*!
\ingroup Curve25519
@ -282,6 +289,7 @@ int wc_curve25519_import_private_ex(const byte* priv, word32 privSz,
WOLFSSL_API
int wc_curve25519_import_private_raw(const byte* priv, word32 privSz,
const byte* pub, word32 pubSz, curve25519_key* key);
/*!
\ingroup Curve25519
@ -327,6 +335,7 @@ WOLFSSL_API
int wc_curve25519_import_private_raw_ex(const byte* priv, word32 privSz,
const byte* pub, word32 pubSz,
curve25519_key* key, int endian);
/*!
\ingroup Curve25519
@ -366,6 +375,7 @@ int wc_curve25519_import_private_raw_ex(const byte* priv, word32 privSz,
WOLFSSL_API
int wc_curve25519_export_private_raw(curve25519_key* key, byte* out,
word32* outLen);
/*!
\ingroup Curve25519
@ -408,6 +418,7 @@ int wc_curve25519_export_private_raw(curve25519_key* key, byte* out,
WOLFSSL_API
int wc_curve25519_export_private_raw_ex(curve25519_key* key, byte* out,
word32* outLen, int endian);
/*!
\ingroup Curve25519
@ -450,6 +461,7 @@ parameter does not match the key size of the key structure.
WOLFSSL_API
int wc_curve25519_import_public(const byte* in, word32 inLen,
curve25519_key* key);
/*!
\ingroup Curve25519
@ -493,6 +505,7 @@ int wc_curve25519_import_public(const byte* in, word32 inLen,
WOLFSSL_API
int wc_curve25519_import_public_ex(const byte* in, word32 inLen,
curve25519_key* key, int endian);
/*!
\ingroup Curve25519
@ -527,6 +540,7 @@ int wc_curve25519_import_public_ex(const byte* in, word32 inLen,
*/
WOLFSSL_API
int wc_curve25519_export_public(curve25519_key* key, byte* out, word32* outLen);
/*!
\ingroup Curve25519
@ -566,6 +580,7 @@ int wc_curve25519_export_public(curve25519_key* key, byte* out, word32* outLen);
WOLFSSL_API
int wc_curve25519_export_public_ex(curve25519_key* key, byte* out,
word32* outLen, int endian);
/*!
\ingroup Curve25519
@ -606,6 +621,7 @@ WOLFSSL_API
int wc_curve25519_export_key_raw(curve25519_key* key,
byte* priv, word32 *privSz,
byte* pub, word32 *pubSz);
/*!
\ingroup Curve25519
@ -651,6 +667,7 @@ int wc_curve25519_export_key_raw_ex(curve25519_key* key,
byte* priv, word32 *privSz,
byte* pub, word32 *pubSz,
int endian);
/*!
\ingroup Curve25519

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

@ -36,6 +36,7 @@
*/
WOLFSSL_API int wc_Des_SetKey(Des* des, const byte* key,
const byte* iv, int dir);
/*!
\ingroup 3DES
@ -61,6 +62,7 @@ WOLFSSL_API int wc_Des_SetKey(Des* des, const byte* key,
\sa wc_Des_SetKey
*/
WOLFSSL_API void wc_Des_SetIV(Des* des, const byte* iv);
/*!
\ingroup 3DES
@ -93,6 +95,7 @@ WOLFSSL_API void wc_Des_SetIV(Des* des, const byte* iv);
*/
WOLFSSL_API int wc_Des_CbcEncrypt(Des* des, byte* out,
const byte* in, word32 sz);
/*!
\ingroup 3DES
@ -125,6 +128,7 @@ WOLFSSL_API int wc_Des_CbcEncrypt(Des* des, byte* out,
*/
WOLFSSL_API int wc_Des_CbcDecrypt(Des* des, byte* out,
const byte* in, word32 sz);
/*!
\ingroup 3DES
@ -156,6 +160,7 @@ WOLFSSL_API int wc_Des_CbcDecrypt(Des* des, byte* out,
*/
WOLFSSL_API int wc_Des_EcbEncrypt(Des* des, byte* out,
const byte* in, word32 sz);
/*!
\ingroup 3DES
@ -189,6 +194,7 @@ WOLFSSL_API int wc_Des_EcbEncrypt(Des* des, byte* out,
*/
WOLFSSL_API int wc_Des3_EcbEncrypt(Des3* des, byte* out,
const byte* in, word32 sz);
/*!
\ingroup 3DES
@ -229,6 +235,7 @@ WOLFSSL_API int wc_Des3_EcbEncrypt(Des3* des, byte* out,
*/
WOLFSSL_API int wc_Des3_SetKey(Des3* des, const byte* key,
const byte* iv,int dir);
/*!
\ingroup 3DES
@ -257,6 +264,7 @@ WOLFSSL_API int wc_Des3_SetKey(Des3* des, const byte* key,
\sa wc_Des3_SetKey
*/
WOLFSSL_API int wc_Des3_SetIV(Des3* des, const byte* iv);
/*!
\ingroup 3DES
@ -289,6 +297,7 @@ WOLFSSL_API int wc_Des3_SetIV(Des3* des, const byte* iv);
*/
WOLFSSL_API int wc_Des3_CbcEncrypt(Des3* des, byte* out,
const byte* in,word32 sz);
/*!
\ingroup 3DES

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

@ -19,6 +19,7 @@
\sa wc_DhGenerateKeyPair
*/
WOLFSSL_API int wc_InitDhKey(DhKey* key);
/*!
\ingroup Diffie-Hellman
@ -40,6 +41,7 @@ WOLFSSL_API int wc_InitDhKey(DhKey* key);
\sa wc_InitDhKey
*/
WOLFSSL_API void wc_FreeDhKey(DhKey* key);
/*!
\ingroup Diffie-Hellman
@ -91,6 +93,7 @@ WOLFSSL_API void wc_FreeDhKey(DhKey* key);
*/
WOLFSSL_API int wc_DhGenerateKeyPair(DhKey* key, WC_RNG* rng, byte* priv,
word32* privSz, byte* pub, word32* pubSz);
/*!
\ingroup Diffie-Hellman
@ -142,6 +145,7 @@ WOLFSSL_API int wc_DhGenerateKeyPair(DhKey* key, WC_RNG* rng, byte* priv,
WOLFSSL_API int wc_DhAgree(DhKey* key, byte* agree, word32* agreeSz,
const byte* priv, word32 privSz, const byte* otherPub,
word32 pubSz);
/*!
\ingroup Diffie-Hellman
@ -182,6 +186,7 @@ WOLFSSL_API int wc_DhAgree(DhKey* key, byte* agree, word32* agreeSz,
*/
WOLFSSL_API int wc_DhKeyDecode(const byte* input, word32* inOutIdx, DhKey* key,
word32);
/*!
\ingroup Diffie-Hellman
@ -222,6 +227,7 @@ WOLFSSL_API int wc_DhKeyDecode(const byte* input, word32* inOutIdx, DhKey* key,
*/
WOLFSSL_API int wc_DhSetKey(DhKey* key, const byte* p, word32 pSz, const byte* g,
word32 gSz);
/*!
\ingroup Diffie-Hellman

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

@ -19,6 +19,7 @@
\sa wc_FreeDsaKey
*/
WOLFSSL_API int wc_InitDsaKey(DsaKey* key);
/*!
\ingroup DSA
@ -39,6 +40,7 @@ WOLFSSL_API int wc_InitDsaKey(DsaKey* key);
\sa wc_FreeDsaKey
*/
WOLFSSL_API void wc_FreeDsaKey(DsaKey* key);
/*!
\ingroup DSA
@ -96,6 +98,7 @@ WOLFSSL_API void wc_FreeDsaKey(DsaKey* key);
*/
WOLFSSL_API int wc_DsaSign(const byte* digest, byte* out,
DsaKey* key, WC_RNG* rng);
/*!
\ingroup DSA
@ -158,6 +161,7 @@ WOLFSSL_API int wc_DsaSign(const byte* digest, byte* out,
*/
WOLFSSL_API int wc_DsaVerify(const byte* digest, const byte* sig,
DsaKey* key, int* answer);
/*!
\ingroup DSA
@ -197,6 +201,7 @@ WOLFSSL_API int wc_DsaVerify(const byte* digest, const byte* sig,
*/
WOLFSSL_API int wc_DsaPublicKeyDecode(const byte* input, word32* inOutIdx,
DsaKey*, word32);
/*!
\ingroup DSA
@ -237,6 +242,7 @@ WOLFSSL_API int wc_DsaPublicKeyDecode(const byte* input, word32* inOutIdx,
*/
WOLFSSL_API int wc_DsaPrivateKeyDecode(const byte* input, word32* inOutIdx,
DsaKey*, word32);
/*!
\ingroup DSA
@ -271,6 +277,7 @@ WOLFSSL_API int wc_DsaPrivateKeyDecode(const byte* input, word32* inOutIdx,
\sa wc_MakeDsaKey
*/
WOLFSSL_API int wc_DsaKeyToDer(DsaKey* key, byte* output, word32 inLen);
/*!
\ingroup DSA
@ -301,6 +308,7 @@ WOLFSSL_API int wc_DsaKeyToDer(DsaKey* key, byte* output, word32 inLen);
\sa wc_DsaSign
*/
WOLFSSL_API int wc_MakeDsaKey(WC_RNG *rng, DsaKey *dsa);
/*!
\ingroup DSA

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

@ -27,6 +27,7 @@
*/
WOLFSSL_API
int wc_ed25519_make_key(WC_RNG* rng, int keysize, ed25519_key* key);
/*!
\ingroup ED25519
@ -72,6 +73,7 @@ int wc_ed25519_make_key(WC_RNG* rng, int keysize, ed25519_key* key);
WOLFSSL_API
int wc_ed25519_sign_msg(const byte* in, word32 inlen, byte* out,
word32 *outlen, ed25519_key* key);
/*!
\ingroup ED25519
@ -119,6 +121,7 @@ int wc_ed25519_sign_msg(const byte* in, word32 inlen, byte* out,
WOLFSSL_API
int wc_ed25519_verify_msg(const byte* sig, word32 siglen, const byte* msg,
word32 msglen, int* stat, ed25519_key* key);
/*!
\ingroup ED25519
@ -141,6 +144,7 @@ int wc_ed25519_verify_msg(const byte* sig, word32 siglen, const byte* msg,
*/
WOLFSSL_API
int wc_ed25519_init(ed25519_key* key);
/*!
\ingroup ED25519
@ -162,6 +166,7 @@ int wc_ed25519_init(ed25519_key* key);
*/
WOLFSSL_API
void wc_ed25519_free(ed25519_key* key);
/*!
\ingroup ED25519
@ -196,6 +201,7 @@ void wc_ed25519_free(ed25519_key* key);
*/
WOLFSSL_API
int wc_ed25519_import_public(const byte* in, word32 inLen, ed25519_key* key);
/*!
\ingroup ED25519
@ -235,6 +241,7 @@ int wc_ed25519_import_public(const byte* in, word32 inLen, ed25519_key* key);
WOLFSSL_API
int wc_ed25519_import_private_key(const byte* priv, word32 privSz,
const byte* pub, word32 pubSz, ed25519_key* key);
/*!
\ingroup ED25519
@ -275,6 +282,7 @@ int wc_ed25519_import_private_key(const byte* priv, word32 privSz,
*/
WOLFSSL_API
int wc_ed25519_export_public(ed25519_key*, byte* out, word32* outLen);
/*!
\ingroup ED25519
@ -313,6 +321,7 @@ int wc_ed25519_export_public(ed25519_key*, byte* out, word32* outLen);
*/
WOLFSSL_API
int wc_ed25519_export_private_only(ed25519_key* key, byte* out, word32* outLen);
/*!
\ingroup ED25519
@ -350,6 +359,7 @@ int wc_ed25519_export_private_only(ed25519_key* key, byte* out, word32* outLen);
*/
WOLFSSL_API
int wc_ed25519_export_private(ed25519_key* key, byte* out, word32* outLen);
/*!
\ingroup ED25519
@ -390,6 +400,7 @@ WOLFSSL_API
int wc_ed25519_export_key(ed25519_key* key,
byte* priv, word32 *privSz,
byte* pub, word32 *pubSz);
/*!
\ingroup ED25519
@ -417,6 +428,7 @@ int wc_ed25519_export_key(ed25519_key* key,
*/
WOLFSSL_API
int wc_ed25519_size(ed25519_key* key);
/*!
\ingroup ED25519
@ -443,6 +455,7 @@ int wc_ed25519_size(ed25519_key* key);
*/
WOLFSSL_API
int wc_ed25519_priv_size(ed25519_key* key);
/*!
\ingroup ED25519
@ -468,6 +481,7 @@ int wc_ed25519_priv_size(ed25519_key* key);
*/
WOLFSSL_API
int wc_ed25519_pub_size(ed25519_key* key);
/*!
\ingroup ED25519

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

@ -23,6 +23,7 @@
\sa wc_GetErrorString
*/
WOLFSSL_API void wc_ErrorString(int err, char* buff);
/*!
\ingroup Error

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

@ -21,6 +21,7 @@
\sa wolfSSL_EVP_CIPHER_CTX_init
*/
WOLFSSL_API const WOLFSSL_EVP_CIPHER* wolfSSL_EVP_des_ede3_ecb(void);
/*!
\ingroup openSSL
@ -43,6 +44,7 @@ WOLFSSL_API const WOLFSSL_EVP_CIPHER* wolfSSL_EVP_des_ede3_ecb(void);
\sa wolfSSL_EVP_CIPHER_CTX_init
*/
WOLFSSL_API const WOLFSSL_EVP_CIPHER* wolfSSL_EVP_des_cbc(void);
/*!
\ingroup openSSL
@ -78,6 +80,7 @@ WOLFSSL_API const WOLFSSL_EVP_CIPHER* wolfSSL_EVP_des_cbc(void);
WOLFSSL_API int wolfSSL_EVP_DigestInit_ex(WOLFSSL_EVP_MD_CTX* ctx,
const WOLFSSL_EVP_MD* type,
WOLFSSL_ENGINE *impl);
/*!
\ingroup openSSL
@ -125,6 +128,7 @@ WOLFSSL_API int wolfSSL_EVP_CipherInit_ex(WOLFSSL_EVP_CIPHER_CTX* ctx,
const unsigned char* key,
const unsigned char* iv,
int enc);
/*!
\ingroup openSSL
@ -164,6 +168,7 @@ WOLFSSL_API int wolfSSL_EVP_EncryptInit_ex(WOLFSSL_EVP_CIPHER_CTX* ctx,
WOLFSSL_ENGINE *impl,
const unsigned char* key,
const unsigned char* iv);
/*!
\ingroup openSSL
@ -212,6 +217,7 @@ WOLFSSL_API int wolfSSL_EVP_DecryptInit_ex(WOLFSSL_EVP_CIPHER_CTX* ctx,
WOLFSSL_ENGINE *impl,
const unsigned char* key,
const unsigned char* iv);
/*!
\ingroup openSSL
@ -251,6 +257,7 @@ WOLFSSL_API int wolfSSL_EVP_DecryptInit_ex(WOLFSSL_EVP_CIPHER_CTX* ctx,
WOLFSSL_API int wolfSSL_EVP_CipherUpdate(WOLFSSL_EVP_CIPHER_CTX *ctx,
unsigned char *out, int *outl,
const unsigned char *in, int inl);
/*!
\ingroup openSSL
@ -281,6 +288,7 @@ WOLFSSL_API int wolfSSL_EVP_CipherUpdate(WOLFSSL_EVP_CIPHER_CTX *ctx,
*/
WOLFSSL_API int wolfSSL_EVP_CipherFinal(WOLFSSL_EVP_CIPHER_CTX *ctx,
unsigned char *out, int *outl);
/*!
\ingroup openSSL
@ -304,6 +312,7 @@ WOLFSSL_API int wolfSSL_EVP_CipherFinal(WOLFSSL_EVP_CIPHER_CTX *ctx,
*/
WOLFSSL_API int wolfSSL_EVP_CIPHER_CTX_set_key_length(WOLFSSL_EVP_CIPHER_CTX* ctx,
int keylen);
/*!
\ingroup openSSL
@ -323,6 +332,7 @@ WOLFSSL_API int wolfSSL_EVP_CIPHER_CTX_set_key_length(WOLFSSL_EVP_CIPHER_CTX* c
\sa wolfSSL_EVP_CIPHER_block_size
*/
WOLFSSL_API int wolfSSL_EVP_CIPHER_CTX_block_size(const WOLFSSL_EVP_CIPHER_CTX *ctx);
/*!
\ingroup openSSL
@ -341,6 +351,7 @@ WOLFSSL_API int wolfSSL_EVP_CIPHER_CTX_block_size(const WOLFSSL_EVP_CIPHER_CTX *
\sa wolfSSL_EVP_aes_256_ctr
*/
WOLFSSL_API int wolfSSL_EVP_CIPHER_block_size(const WOLFSSL_EVP_CIPHER *cipher);
/*!
\ingroup openSSL
@ -362,6 +373,7 @@ WOLFSSL_API int wolfSSL_EVP_CIPHER_block_size(const WOLFSSL_EVP_CIPHER *cipher);
\sa wolfSSL_EVP_CIPHER_flags
*/
WOLFSSL_API void wolfSSL_EVP_CIPHER_CTX_set_flags(WOLFSSL_EVP_CIPHER_CTX *ctx, int flags);
/*!
\ingroup openSSL

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

@ -23,6 +23,7 @@
\sa wc_Hash
*/
WOLFSSL_API int wc_HashGetOID(enum wc_HashType hash_type);
/*!
\ingroup wolfCrypt
@ -50,6 +51,7 @@ WOLFSSL_API int wc_HashGetOID(enum wc_HashType hash_type);
\sa wc_Hash
*/
WOLFSSL_API int wc_HashGetDigestSize(enum wc_HashType hash_type);
/*!
\ingroup wolfCrypt
@ -82,6 +84,7 @@ WOLFSSL_API int wc_HashGetDigestSize(enum wc_HashType hash_type);
WOLFSSL_API int wc_Hash(enum wc_HashType hash_type,
const byte* data, word32 data_len,
byte* hash, word32 hash_len);
/*!
\ingroup MD5
@ -114,6 +117,7 @@ WOLFSSL_API int wc_Hash(enum wc_HashType hash_type,
\sa wc_InitMd5
*/
WOLFSSL_API int wc_Md5Hash(const byte* data, word32 len, byte* hash);
/*!
\ingroup SHA
@ -138,6 +142,7 @@ WOLFSSL_API int wc_Md5Hash(const byte* data, word32 len, byte* hash);
\sa wc_InitSha
*/
WOLFSSL_API int wc_ShaHash(const byte*, word32, byte*);
/*!
\ingroup SHA
@ -162,6 +167,7 @@ WOLFSSL_API int wc_ShaHash(const byte*, word32, byte*);
\sa wc_InitSha256
*/
WOLFSSL_API int wc_Sha256Hash(const byte*, word32, byte*);
/*!
\ingroup SHA
@ -184,7 +190,8 @@ WOLFSSL_API int wc_Sha256Hash(const byte*, word32, byte*);
\sa wc_Sha224Update
\sa wc_Sha224Final
*/
WOLFSSL_API int wc_Sha224Hash(const byte*, word32, byte*);
WOLFSSL_API int wc_Sha224Hash(const byte*, word32, byte*);
/*!
\ingroup SHA
@ -209,6 +216,7 @@ WOLFSSL_API int wc_Sha256Hash(const byte*, word32, byte*);
\sa wc_InitSha512
*/
WOLFSSL_API int wc_Sha512Hash(const byte*, word32, byte*);
/*!
\ingroup SHA
@ -232,4 +240,4 @@ WOLFSSL_API int wc_Sha512Hash(const byte*, word32, byte*);
\sa wc_Sha384Final
\sa wc_InitSha384
*/
WOLFSSL_API int wc_Sha384Hash(const byte*, word32, byte*);
WOLFSSL_API int wc_Sha384Hash(const byte*, word32, byte*);

1
doc/dox_comments/header_files/hc128.h
View File

@ -37,6 +37,7 @@
\sa wc_Hc128_SetKey
*/
WOLFSSL_API int wc_Hc128_Process(HC128*, byte*, const byte*, word32);
/*!
\ingroup HC128

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

@ -33,6 +33,7 @@
\sa wc_HmacFinal
*/
WOLFSSL_API int wc_HmacSetKey(Hmac*, int type, const byte* key, word32 keySz);
/*!
\ingroup HMAC
@ -68,6 +69,7 @@ WOLFSSL_API int wc_HmacSetKey(Hmac*, int type, const byte* key, word32 keySz);
\sa wc_HmacFinal
*/
WOLFSSL_API int wc_HmacUpdate(Hmac*, const byte*, word32);
/*!
\ingroup HMAC
@ -98,6 +100,7 @@ WOLFSSL_API int wc_HmacUpdate(Hmac*, const byte*, word32);
\sa wc_HmacUpdate
*/
WOLFSSL_API int wc_HmacFinal(Hmac*, byte*);
/*!
\ingroup HMAC
@ -117,6 +120,7 @@ WOLFSSL_API int wc_HmacFinal(Hmac*, byte*);
\sa none
*/
WOLFSSL_API int wolfSSL_GetHmacMaxSize(void);
/*!
\ingroup HMAC

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

@ -28,6 +28,7 @@
*/
WOLFSSL_API int wc_IdeaSetKey(Idea *idea, const byte* key, word16 keySz,
const byte *iv, int dir);
/*!
\ingroup IDEA
@ -55,6 +56,7 @@ WOLFSSL_API int wc_IdeaSetKey(Idea *idea, const byte* key, word16 keySz,
\sa wc_IdeaSetKey
*/
WOLFSSL_API int wc_IdeaSetIV(Idea *idea, const byte* iv);
/*!
\ingroup IDEA
@ -87,6 +89,7 @@ WOLFSSL_API int wc_IdeaSetIV(Idea *idea, const byte* iv);
\sa wc_IdeaCbcDecrypt
*/
WOLFSSL_API int wc_IdeaCipher(Idea *idea, byte* out, const byte* in);
/*!
\ingroup IDEA
@ -122,6 +125,7 @@ WOLFSSL_API int wc_IdeaCipher(Idea *idea, byte* out, const byte* in);
*/
WOLFSSL_API int wc_IdeaCbcEncrypt(Idea *idea, byte* out,
const byte* in, word32 len);
/*!
\ingroup IDEA

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

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

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

@ -25,6 +25,7 @@
\sa wc_Md2Final
*/
WOLFSSL_API void wc_InitMd2(Md2*);
/*!
\ingroup MD2
@ -57,6 +58,7 @@ WOLFSSL_API void wc_InitMd2(Md2*);
\sa wc_InitMd2
*/
WOLFSSL_API void wc_Md2Update(Md2*, const byte*, word32);
/*!
\ingroup MD2
@ -87,6 +89,7 @@ WOLFSSL_API void wc_Md2Update(Md2*, const byte*, word32);
\sa wc_InitMd2
*/
WOLFSSL_API void wc_Md2Final(Md2*, byte*);
/*!
\ingroup MD2

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

@ -25,6 +25,7 @@
\sa wc_Md4Final
*/
WOLFSSL_API void wc_InitMd4(Md4*);
/*!
\ingroup MD4
@ -57,6 +58,7 @@ WOLFSSL_API void wc_InitMd4(Md4*);
\sa wc_InitMd4
*/
WOLFSSL_API void wc_Md4Update(Md4*, const byte*, word32);
/*!
\ingroup MD4

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

@ -34,6 +34,7 @@
\sa wc_Md5Final
*/
WOLFSSL_API int wc_InitMd5(wc_Md5*);
/*!
\ingroup MD5
@ -75,6 +76,7 @@ WOLFSSL_API int wc_InitMd5(wc_Md5*);
\sa wc_InitMd5
*/
WOLFSSL_API int wc_Md5Update(wc_Md5*, const byte*, word32);
/*!
\ingroup MD5
@ -115,6 +117,7 @@ WOLFSSL_API int wc_Md5Update(wc_Md5*, const byte*, word32);
\sa wc_Md5GetHash
*/
WOLFSSL_API int wc_Md5Final(wc_Md5*, byte*);
/*!
\ingroup MD5
@ -146,6 +149,7 @@ WOLFSSL_API int wc_Md5Final(wc_Md5*, byte*);
\sa wc_Md5Final
*/
WOLFSSL_API void wc_Md5Free(wc_Md5*);
/*!
\ingroup MD5

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

@ -25,6 +25,7 @@
\sa XREALLOC
*/
WOLFSSL_API void* wolfSSL_Malloc(size_t size, void* heap, int type, const char* func, unsigned int line);
/*!
\ingroup Memory
@ -55,6 +56,7 @@ WOLFSSL_API void* wolfSSL_Malloc(size_t size, void* heap, int type, const char*
\sa XREALLOC
*/
WOLFSSL_API void wolfSSL_Free(void *ptr, void* heap, int type, const char* func, unsigned int line);
/*!
\ingroup Memory
@ -84,6 +86,7 @@ WOLFSSL_API void wolfSSL_Free(void *ptr, void* heap, int type, const char* func
\sa XREALLOC
*/
WOLFSSL_API void* wolfSSL_Realloc(void *ptr, size_t size, void* heap, int type, const char* func, unsigned int line);
/*!
\ingroup Memory
@ -114,6 +117,7 @@ WOLFSSL_API void* wolfSSL_Realloc(void *ptr, size_t size, void* heap, int type,
\sa wolfSSL_SetAllocators
*/
WOLFSSL_API void* wolfSSL_Malloc(size_t size, void* heap, int type);
/*!
\ingroup Memory
@ -148,6 +152,7 @@ WOLFSSL_API void* wolfSSL_Malloc(size_t size, void* heap, int type);
\sa wolfSSL_SetAllocators
*/
WOLFSSL_API void* wolfSSL_Realloc(void *ptr, size_t size, void* heap, int type);
/*!
\ingroup Memory
@ -172,6 +177,7 @@ WOLFSSL_API void* wolfSSL_Realloc(void *ptr, size_t size, void* heap, int type);
\sa wolfSSL_SetAllocators
*/
WOLFSSL_API void wolfSSL_Free(void *ptr, const char* func, unsigned int line);
/*!
\ingroup Memory
@ -226,6 +232,7 @@ WOLFSSL_API void wolfSSL_Free(void *ptr, const char* func, unsigned int line);
WOLFSSL_API int wolfSSL_SetAllocators(wolfSSL_Malloc_cb,
wolfSSL_Free_cb,
wolfSSL_Realloc_cb);
/*!
\ingroup Memory
@ -258,7 +265,8 @@ WOLFSSL_API int wolfSSL_SetAllocators(wolfSSL_Malloc_cb,
\sa wolfSSL_Malloc
\sa wolfSSL_Free
*/
WOLFSSL_API int wolfSSL_StaticBufferSz(byte* buffer, word32 sz, int flag);
WOLFSSL_API int wolfSSL_StaticBufferSz(byte* buffer, word32 sz, int flag);
/*!
\ingroup Memory

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

@ -58,6 +58,7 @@
\sa wc_PKCS7_Free
*/
WOLFSSL_API int wc_PKCS7_InitWithCert(PKCS7* pkcs7, byte* cert, word32 certSz);
/*!
\ingroup PKCS7
@ -78,6 +79,7 @@ WOLFSSL_API int wc_PKCS7_InitWithCert(PKCS7* pkcs7, byte* cert, word32 certSz);
\sa wc_PKCS7_InitWithCert
*/
WOLFSSL_API void wc_PKCS7_Free(PKCS7* pkcs7);
/*!
\ingroup PKCS7
@ -121,6 +123,7 @@ WOLFSSL_API void wc_PKCS7_Free(PKCS7* pkcs7);
*/
WOLFSSL_API int wc_PKCS7_EncodeData(PKCS7* pkcs7, byte* output,
word32 outputSz);
/*!
\ingroup PKCS7
@ -193,6 +196,7 @@ WOLFSSL_API int wc_PKCS7_EncodeData(PKCS7* pkcs7, byte* output,
*/
WOLFSSL_API int wc_PKCS7_EncodeSignedData(PKCS7* pkcs7,
byte* output, word32 outputSz);
/*!
\ingroup PKCS7
@ -269,6 +273,7 @@ WOLFSSL_API int wc_PKCS7_EncodeSignedData(PKCS7* pkcs7,
*/
WOLFSSL_API int wc_PKCS7_VerifySignedData(PKCS7* pkcs7,
byte* pkiMsg, word32 pkiMsgSz);
/*!
\ingroup PKCS7
@ -322,6 +327,7 @@ WOLFSSL_API int wc_PKCS7_VerifySignedData(PKCS7* pkcs7,
*/
WOLFSSL_API int wc_PKCS7_EncodeEnvelopedData(PKCS7* pkcs7,
byte* output, word32 outputSz);
/*!
\ingroup PKCS7

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

@ -26,6 +26,7 @@
*/
WOLFSSL_API int wc_Poly1305SetKey(Poly1305* poly1305, const byte* key,
word32 kySz);
/*!
\ingroup Poly1305
@ -58,6 +59,7 @@ WOLFSSL_API int wc_Poly1305SetKey(Poly1305* poly1305, const byte* key,
\sa wc_Poly1305Final
*/
WOLFSSL_API int wc_Poly1305Update(Poly1305* poly1305, const byte*, word32);
/*!
\ingroup Poly1305
@ -92,6 +94,7 @@ WOLFSSL_API int wc_Poly1305Update(Poly1305* poly1305, const byte*, word32);
\sa wc_Poly1305Update
*/
WOLFSSL_API int wc_Poly1305Final(Poly1305* poly1305, byte* tag);
/*!
\ingroup Poly1305

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

@ -46,6 +46,7 @@
WOLFSSL_API int wc_PBKDF1(byte* output, const byte* passwd, int pLen,
const byte* salt, int sLen, int iterations, int kLen,
int typeH);
/*!
\ingroup Password
@ -94,6 +95,7 @@ WOLFSSL_API int wc_PBKDF1(byte* output, const byte* passwd, int pLen,
WOLFSSL_API int wc_PBKDF2(byte* output, const byte* passwd, int pLen,
const byte* salt, int sLen, int iterations, int kLen,
int typeH);
/*!
\ingroup Password

1
doc/dox_comments/header_files/rabbit.h
View File

@ -36,6 +36,7 @@
\sa wc_RabbitSetKey
*/
WOLFSSL_API int wc_RabbitProcess(Rabbit*, byte*, const byte*, word32);
/*!
\ingroup Rabbit

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

@ -25,6 +25,7 @@
\sa wc_FreeNetRandom
*/
WOLFSSL_API int wc_InitNetRandom(const char*, wnr_hmac_key, int);
/*!
\ingroup Random
@ -47,6 +48,7 @@ WOLFSSL_API int wc_InitNetRandom(const char*, wnr_hmac_key, int);
\sa wc_InitNetRandom
*/
WOLFSSL_API int wc_FreeNetRandom(void);
/*!
\ingroup Random
@ -94,6 +96,7 @@ WOLFSSL_API int wc_FreeNetRandom(void);
\sa wc_RNG_HealthTest
*/
WOLFSSL_API int wc_InitRng(WC_RNG*);
/*!
\ingroup Random
@ -133,6 +136,7 @@ WOLFSSL_API int wc_InitRng(WC_RNG*);
\sa wc_RNG_HealthTest
*/
WOLFSSL_API int wc_RNG_GenerateBlock(WC_RNG*, byte*, word32 sz);
/*!
\ingroup Random
@ -172,6 +176,7 @@ WOLFSSL_API int wc_RNG_GenerateBlock(WC_RNG*, byte*, word32 sz);
\sa wc_RNG_HealthTest
*/
WOLFSSL_API int wc_RNG_GenerateByte(WC_RNG*, byte*);
/*!
\ingroup Random
@ -205,6 +210,7 @@ WOLFSSL_API int wc_RNG_GenerateByte(WC_RNG*, byte*);
\sa wc_RNG_HealthTest
*/
WOLFSSL_API int wc_FreeRng(WC_RNG*);
/*!
\ingroup Random

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

@ -24,6 +24,7 @@
\sa wc_RipeMdFinal
*/
WOLFSSL_API int wc_InitRipeMd(RipeMd*);
/*!
\ingroup RIPEMD
@ -59,6 +60,7 @@ WOLFSSL_API int wc_InitRipeMd(RipeMd*);
\sa wc_RipeMdFinal
*/
WOLFSSL_API int wc_RipeMdUpdate(RipeMd*, const byte*, word32);
/*!
\ingroup RIPEMD

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

@ -483,7 +483,7 @@ WOLFSSL_API int wc_RsaPublicKeyDecodeRaw(const byte* n, word32 nSz,
\sa wc_MakeRsaKey
\sa wc_InitRng
*/
WOLFSSL_API int wc_RsaKeyToDer(RsaKey*, byte* output, word32 inLen);
WOLFSSL_API int wc_RsaKeyToDer(RsaKey*, byte* output, word32 inLen);
/*!
\ingroup RSA
@ -719,7 +719,7 @@ WOLFSSL_API int wc_RsaFlattenPublicKey(RsaKey*, byte*, word32*, byte*,
\sa wc_RsaKeyToPublicDer
\sa wc_RsaInitKey
*/
WOLFSSL_API int wc_RsaKeyToPublicDer(RsaKey*, byte* output, word32 inLen);
WOLFSSL_API int wc_RsaKeyToPublicDer(RsaKey*, byte* output, word32 inLen);
/*!
\ingroup RSA
@ -790,4 +790,4 @@ WOLFSSL_API int wc_RsaFlattenPublicKey(RsaKey*, byte*, word32*, byte*,
\sa none
*/
WOLFSSL_API int wc_MakeRsaKey(RsaKey* key, int size, long e, WC_RNG* rng);
WOLFSSL_API int wc_MakeRsaKey(RsaKey* key, int size, long e, WC_RNG* rng);

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

@ -25,6 +25,7 @@
\sa wc_ShaFinal
*/
WOLFSSL_API int wc_InitSha(wc_Sha*);
/*!
\ingroup SHA
@ -57,6 +58,7 @@ WOLFSSL_API int wc_InitSha(wc_Sha*);
\sa wc_InitSha
*/
WOLFSSL_API int wc_ShaUpdate(wc_Sha*, const byte*, word32);
/*!
\ingroup SHA
@ -88,6 +90,7 @@ WOLFSSL_API int wc_ShaUpdate(wc_Sha*, const byte*, word32);
\sa wc_ShaGetHash
*/
WOLFSSL_API int wc_ShaFinal(wc_Sha*, byte*);
/*!
\ingroup SHA
@ -111,6 +114,7 @@ WOLFSSL_API int wc_ShaFinal(wc_Sha*, byte*);
\sa wc_ShaFinal
*/
WOLFSSL_API void wc_ShaFree(wc_Sha*);
/*!
\ingroup SHA

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

@ -25,6 +25,7 @@
\sa wc_Sha256Final
*/
WOLFSSL_API int wc_InitSha256(wc_Sha256*);
/*!
\ingroup SHA
@ -57,6 +58,7 @@ WOLFSSL_API int wc_InitSha256(wc_Sha256*);
\sa wc_InitSha256
*/
WOLFSSL_API int wc_Sha256Update(wc_Sha256*, const byte*, word32);
/*!
\ingroup SHA
@ -88,6 +90,7 @@ WOLFSSL_API int wc_Sha256Update(wc_Sha256*, const byte*, word32);
\sa wc_InitSha256
*/
WOLFSSL_API int wc_Sha256Final(wc_Sha256*, byte*);
/*!
\ingroup SHA
@ -119,6 +122,7 @@ WOLFSSL_API int wc_Sha256Final(wc_Sha256*, byte*);
\sa wc_Sha256Final
*/
WOLFSSL_API void wc_Sha256Free(wc_Sha256*);
/*!
\ingroup SHA
@ -147,6 +151,7 @@ WOLFSSL_API void wc_Sha256Free(wc_Sha256*);
\sa wc_InitSha256
*/
WOLFSSL_API int wc_Sha256GetHash(wc_Sha256*, byte*);
/*!
\ingroup SHA
@ -171,6 +176,7 @@ WOLFSSL_API int wc_Sha256GetHash(wc_Sha256*, byte*);
\sa wc_Sha224Final
*/
WOLFSSL_API int wc_InitSha224(wc_Sha224*);
/*!
\ingroup SHA
@ -205,6 +211,7 @@ WOLFSSL_API int wc_InitSha224(wc_Sha224*);
\sa wc_Sha224Hash
*/
WOLFSSL_API int wc_Sha224Update(wc_Sha224*, const byte*, word32);
/*!
\ingroup SHA

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

@ -25,6 +25,7 @@
\sa wc_Sha512Final
*/
WOLFSSL_API int wc_InitSha512(wc_Sha512*);
/*!
\ingroup SHA
@ -57,6 +58,7 @@ WOLFSSL_API int wc_InitSha512(wc_Sha512*);
\sa wc_InitSha512
*/
WOLFSSL_API int wc_Sha512Update(wc_Sha512*, const byte*, word32);
/*!
\ingroup SHA
@ -87,6 +89,7 @@ WOLFSSL_API int wc_Sha512Update(wc_Sha512*, const byte*, word32);
\sa wc_InitSha512
*/
WOLFSSL_API int wc_Sha512Final(wc_Sha512*, byte*);
/*!
\ingroup SHA
@ -114,6 +117,7 @@ WOLFSSL_API int wc_Sha512Final(wc_Sha512*, byte*);
\sa wc_Sha384Final
*/
WOLFSSL_API int wc_InitSha384(wc_Sha384*);
/*!
\ingroup SHA
@ -146,6 +150,7 @@ WOLFSSL_API int wc_InitSha384(wc_Sha384*);
\sa wc_InitSha384
*/
WOLFSSL_API int wc_Sha384Update(wc_Sha384*, const byte*, word32);
/*!
\ingroup SHA

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

@ -31,6 +31,7 @@
*/
WOLFSSL_API int wc_SignatureGetSize(enum wc_SignatureType sig_type,
const void* key, word32 key_len);
/*!
\ingroup Signature
@ -80,6 +81,7 @@ WOLFSSL_API int wc_SignatureVerify(
const byte* data, word32 data_len,
const byte* sig, word32 sig_len,
const void* key, word32 key_len);
/*!
\ingroup Signature

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

@ -31,6 +31,7 @@
\sa wc_SrpSetUsername
*/
WOLFSSL_API int wc_SrpInit(Srp* srp, SrpType type, SrpSide side);
/*!
\ingroup SRP
@ -51,6 +52,7 @@ WOLFSSL_API int wc_SrpInit(Srp* srp, SrpType type, SrpSide side);
\sa wc_SrpInit
*/
WOLFSSL_API void wc_SrpTerm(Srp* srp);
/*!
\ingroup SRP
@ -85,6 +87,7 @@ WOLFSSL_API void wc_SrpTerm(Srp* srp);
\sa wc_SrpTerm
*/
WOLFSSL_API int wc_SrpSetUsername(Srp* srp, const byte* username, word32 size);
/*!
\ingroup SRP
@ -133,6 +136,7 @@ wc_SrpSetUsername.
WOLFSSL_API int wc_SrpSetParams(Srp* srp, const byte* N, word32 nSz,
const byte* g, word32 gSz,
const byte* salt, word32 saltSz);
/*!
\ingroup SRP
@ -181,6 +185,7 @@ WOLFSSL_API int wc_SrpSetParams(Srp* srp, const byte* N, word32 nSz,
\sa wc_SrpSetParams
*/
WOLFSSL_API int wc_SrpSetPassword(Srp* srp, const byte* password, word32 size);
/*!
\ingroup SRP
@ -223,6 +228,7 @@ WOLFSSL_API int wc_SrpSetPassword(Srp* srp, const byte* password, word32 size);
\sa wc_SrpGetVerifier
*/
WOLFSSL_API int wc_SrpSetVerifier(Srp* srp, const byte* verifier, word32 size);
/*!
\ingroup SRP
@ -273,6 +279,7 @@ WOLFSSL_API int wc_SrpSetVerifier(Srp* srp, const byte* verifier, word32 size);
\sa wc_SrpSetPassword
*/
WOLFSSL_API int wc_SrpGetVerifier(Srp* srp, byte* verifier, word32* size);
/*!
\ingroup SRP
@ -322,6 +329,7 @@ WOLFSSL_API int wc_SrpGetVerifier(Srp* srp, byte* verifier, word32* size);
\sa wc_SrpGetPublic
*/
WOLFSSL_API int wc_SrpSetPrivate(Srp* srp, const byte* priv, word32 size);
/*!
\ingroup SRP
@ -376,6 +384,7 @@ WOLFSSL_API int wc_SrpSetPrivate(Srp* srp, const byte* priv, word32 size);
\sa wc_SrpSetVerifier
*/
WOLFSSL_API int wc_SrpGetPublic(Srp* srp, byte* pub, word32* size);
/*!
\ingroup SRP
@ -428,6 +437,7 @@ WOLFSSL_API int wc_SrpGetPublic(Srp* srp, byte* pub, word32* size);
WOLFSSL_API int wc_SrpComputeKey(Srp* srp,
byte* clientPubKey, word32 clientPubKeySz,
byte* serverPubKey, word32 serverPubKeySz);
/*!
\ingroup SRP
@ -459,6 +469,7 @@ WOLFSSL_API int wc_SrpComputeKey(Srp* srp,
\sa wc_SrpComputeKey
*/
WOLFSSL_API int wc_SrpGetProof(Srp* srp, byte* proof, word32* size);
/*!
\ingroup SRP

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

File diff suppressed because it is too large Load Diff

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

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

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

@ -45,6 +45,7 @@
WOLFSSL_API int wc_AesCbcDecryptWithKey(byte* out, const byte* in, word32 inSz,
const byte* key, word32 keySz,
const byte* iv);
/*!
\ingroup 3DES
@ -86,6 +87,7 @@ WOLFSSL_API int wc_AesCbcDecryptWithKey(byte* out, const byte* in, word32 inSz,
WOLFSSL_API int wc_Des_CbcDecryptWithKey(byte* out,
const byte* in, word32 sz,
const byte* key, const byte* iv);
/*!
\ingroup 3DES
@ -124,6 +126,7 @@ WOLFSSL_API int wc_Des_CbcDecryptWithKey(byte* out,
WOLFSSL_API int wc_Des_CbcEncryptWithKey(byte* out,
const byte* in, word32 sz,
const byte* key, const byte* iv);
/*!
\ingroup 3DES
@ -165,6 +168,7 @@ WOLFSSL_API int wc_Des_CbcEncryptWithKey(byte* out,
WOLFSSL_API int wc_Des3_CbcEncryptWithKey(byte* out,
const byte* in, word32 sz,
const byte* key, const byte* iv);
/*!
\ingroup 3DES

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

@ -39,7 +39,8 @@
\sa TranslateReturnCode
\sa RECV_FUNCTION
*/
WOLFSSL_API int EmbedReceive(WOLFSSL* ssl, char* buf, int sz, void* ctx);
WOLFSSL_API int EmbedReceive(WOLFSSL* ssl, char* buf, int sz, void* ctx);
/*!
\brief This function is the send embedded callback.
@ -78,7 +79,8 @@
\sa InitSSL_Ctx
\sa LastError
*/
WOLFSSL_API int EmbedSend(WOLFSSL* ssl, char* buf, int sz, void* ctx);
WOLFSSL_API int EmbedSend(WOLFSSL* ssl, char* buf, int sz, void* ctx);
/*!
\brief This function is the receive embedded callback.
@ -114,7 +116,8 @@
\sa RECVFROM_FUNCTION
\sa Setsockopt
*/
WOLFSSL_API int EmbedReceiveFrom(WOLFSSL* ssl, char* buf, int sz, void*);
WOLFSSL_API int EmbedReceiveFrom(WOLFSSL* ssl, char* buf, int sz, void*);
/*!
\brief This function is the send embedded callback.
@ -154,7 +157,8 @@
\sa EmbedSend
\sa EmbedReceive
*/
WOLFSSL_API int EmbedSendTo(WOLFSSL* ssl, char* buf, int sz, void* ctx);
WOLFSSL_API int EmbedSendTo(WOLFSSL* ssl, char* buf, int sz, void* ctx);
/*!
\brief This function is the DTLS Generate Cookie callback.
@ -189,8 +193,9 @@
\sa XMEMCPY
\sa XMEMSET
*/
WOLFSSL_API int EmbedGenerateCookie(WOLFSSL* ssl, unsigned char* buf,
WOLFSSL_API int EmbedGenerateCookie(WOLFSSL* ssl, unsigned char* buf,
int sz, void*);
/*!
\brief This function frees the response buffer.
@ -209,7 +214,8 @@
\sa XFREE
*/
WOLFSSL_API void EmbedOcspRespFree(void*, unsigned char*);
WOLFSSL_API void EmbedOcspRespFree(void*, unsigned char*);
/*!
\brief This function registers a receive callback for wolfSSL to get input
data. By default, wolfSSL uses EmbedReceive() as the callback which uses
@ -244,6 +250,7 @@
\sa wolfSSL_SetIOWriteCtx
*/
WOLFSSL_API void wolfSSL_CTX_SetIORecv(WOLFSSL_CTX*, CallbackIORecv);
/*!
\brief This function registers a context for the SSL session’s receive
callback function. By default, wolfSSL sets the file descriptor passed to
@ -274,6 +281,7 @@ WOLFSSL_API void wolfSSL_CTX_SetIORecv(WOLFSSL_CTX*, CallbackIORecv);
\sa wolfSSL_SetIOWriteCtx
*/
WOLFSSL_API void wolfSSL_SetIOReadCtx( WOLFSSL* ssl, void *ctx);
/*!
\brief This function registers a context for the SSL session’s send
callback function. By default, wolfSSL sets the file descriptor passed to
@ -304,6 +312,7 @@ WOLFSSL_API void wolfSSL_SetIOReadCtx( WOLFSSL* ssl, void *ctx);
\sa wolfSSL_SetIOReadCtx
*/
WOLFSSL_API void wolfSSL_SetIOWriteCtx(WOLFSSL* ssl, void *ctx);
/*!
\ingroup IO
@ -333,6 +342,7 @@ WOLFSSL_API void wolfSSL_SetIOWriteCtx(WOLFSSL* ssl, void *ctx);
\sa wolfSSL_CTX_SetIOSend
*/
WOLFSSL_API void* wolfSSL_GetIOReadCtx( WOLFSSL* ssl);
/*!
\ingroup IO
@ -361,6 +371,7 @@ WOLFSSL_API void* wolfSSL_GetIOReadCtx( WOLFSSL* ssl);
\sa wolfSSL_CTX_SetIOSend
*/
WOLFSSL_API void* wolfSSL_GetIOWriteCtx(WOLFSSL* ssl);
/*!
\brief This function sets the flags for the receive callback to use for
the given SSL session. The receive callback could be either the default
@ -402,6 +413,7 @@ WOLFSSL_API void* wolfSSL_GetIOWriteCtx(WOLFSSL* ssl);
\sa wolfSSL_SetIOReadCtx
*/
WOLFSSL_API void wolfSSL_SetIOReadFlags( WOLFSSL* ssl, int flags);
/*!
\brief This function sets the flags for the send callback to use for the
given SSL session. The send callback could be either the default wolfSSL
@ -436,6 +448,7 @@ WOLFSSL_API void wolfSSL_SetIOReadFlags( WOLFSSL* ssl, int flags);
\sa wolfSSL_SetIOReadCtx
*/
WOLFSSL_API void wolfSSL_SetIOWriteFlags(WOLFSSL* ssl, int flags);
/*!
\ingroup IO
@ -467,8 +480,9 @@ WOLFSSL_API void wolfSSL_SetIOWriteFlags(WOLFSSL* ssl, int flags);
\sa NetX_Send
\sa NetX_Receive
*/
WOLFSSL_API void wolfSSL_SetIO_NetX(WOLFSSL* ssl, NX_TCP_SOCKET* nxsocket,
WOLFSSL_API void wolfSSL_SetIO_NetX(WOLFSSL* ssl, NX_TCP_SOCKET* nxsocket,
ULONG waitoption);
/*!
\brief This function sets the callback for the CBIOCookie member of the
WOLFSSL_CTX structure. The CallbackGenCookie type is a function pointer
@ -495,7 +509,8 @@ WOLFSSL_API void wolfSSL_SetIOWriteFlags(WOLFSSL* ssl, int flags);
\sa CallbackGenCookie
*/
WOLFSSL_API void wolfSSL_CTX_SetGenCookie(WOLFSSL_CTX*, CallbackGenCookie);
WOLFSSL_API void wolfSSL_CTX_SetGenCookie(WOLFSSL_CTX*, CallbackGenCookie);
/*!
\ingroup Setup
@ -523,4 +538,4 @@ WOLFSSL_API void wolfSSL_SetIOWriteFlags(WOLFSSL* ssl, int flags);
\sa wolfSSL_SetCookieCtx
\sa wolfSSL_CTX_SetGenCookie
*/
WOLFSSL_API void* wolfSSL_GetCookieCtx(WOLFSSL* ssl);
WOLFSSL_API void* wolfSSL_GetCookieCtx(WOLFSSL* ssl);

6
src/ssl.c
View File

@ -16173,10 +16173,13 @@ WOLFSSL_EVP_PKEY* wolfSSL_X509_get_pubkey(WOLFSSL_X509* x509)
return WOLFSSL_FAILURE;
}
if (GetTimeString(x509->notBefore + 2, ASN_UTC_TIME,
tmp, sizeof(tmp)) != WOLFSSL_SUCCESS) {
if (GetTimeString(x509->notBefore + 2, ASN_GENERALIZED_TIME,
tmp, sizeof(tmp)) != WOLFSSL_SUCCESS) {
WOLFSSL_MSG("Error getting not before date");
return WOLFSSL_FAILURE;
}
}
tmp[sizeof(tmp) - 1] = '\0'; /* make sure null terminated */
if (wolfSSL_BIO_write(bio, tmp, (int)XSTRLEN(tmp)) <= 0) {
return WOLFSSL_FAILURE;
@ -16186,10 +16189,13 @@ WOLFSSL_EVP_PKEY* wolfSSL_X509_get_pubkey(WOLFSSL_X509* x509)
return WOLFSSL_FAILURE;
}
if (GetTimeString(x509->notAfter + 2,ASN_UTC_TIME,
tmp, sizeof(tmp)) != WOLFSSL_SUCCESS) {
if (GetTimeString(x509->notAfter + 2,ASN_GENERALIZED_TIME,
tmp, sizeof(tmp)) != WOLFSSL_SUCCESS) {
WOLFSSL_MSG("Error getting not before date");
return WOLFSSL_FAILURE;
}
}
tmp[sizeof(tmp) - 1] = '\0'; /* make sure null terminated */
if (wolfSSL_BIO_write(bio, tmp, (int)XSTRLEN(tmp)) <= 0) {
return WOLFSSL_FAILURE;