wolfSSL/wolfssl
1
0
Fork 1
mirror of https://github.com/wolfSSL/wolfssl.git synced 2026-01-27 12:32:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix issues with the API documentation

Browse Source
This commit is contained in:
Andrew Hutchings
2025-11-21 17:43:55 +00:00
parent 59f4fa5686
commit 026fa2dd4e
24 changed files with 193 additions and 185 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1021,7 +1021,7 @@ int wc_AesInit(Aes* aes, void* heap, int devId);
\sa wc_AesInit
*/
int wc_AesFree(Aes* aes);
void wc_AesFree(Aes* aes);
/*!
\ingroup AES

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

@@ -19,7 +19,7 @@
\sa wc_MakeCert
\sa wc_MakeCertReq
*/
int wc_InitCert(Cert*);
int wc_InitCert(Cert* cert);
/*!
\ingroup ASN
@@ -2524,4 +2524,3 @@ int wc_Asn1_SetFile(Asn1* asn1, XFILE file);
*/
int wc_Asn1_PrintAll(Asn1* asn1, Asn1PrintOptions* opts, unsigned char* data,
word32 len);

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

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

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

@@ -50,8 +50,8 @@
int wc_ChaCha20Poly1305_Encrypt(
const byte inKey[CHACHA20_POLY1305_AEAD_KEYSIZE],
const byte inIV[CHACHA20_POLY1305_AEAD_IV_SIZE],
const byte* inAAD, const word32 inAADLen,
const byte* inPlaintext, const word32 inPlaintextLen,
const byte* inAAD, word32 inAADLen,
const byte* inPlaintext, word32 inPlaintextLen,
byte* outCiphertext,
byte outAuthTag[CHACHA20_POLY1305_AEAD_AUTHTAG_SIZE]);
@@ -118,7 +118,7 @@ int wc_ChaCha20Poly1305_Encrypt(
int wc_ChaCha20Poly1305_Decrypt(
const byte inKey[CHACHA20_POLY1305_AEAD_KEYSIZE],
const byte inIV[CHACHA20_POLY1305_AEAD_IV_SIZE],
const byte* inAAD, const word32 inAADLen,
const byte* inCiphertext, const word32 inCiphertextLen,
const byte* inAAD, word32 inAADLen,
const byte* inCiphertext, word32 inCiphertextLen,
const byte inAuthTag[CHACHA20_POLY1305_AEAD_AUTHTAG_SIZE],
byte* outPlaintext);

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

@@ -40,7 +40,7 @@ int wc_InitDhKey(DhKey* key);
\sa wc_InitDhKey
*/
void wc_FreeDhKey(DhKey* key);
int wc_FreeDhKey(DhKey* key);
/*!
\ingroup Diffie-Hellman
@@ -185,7 +185,7 @@ int wc_DhAgree(DhKey* key, byte* agree, word32* agreeSz,
\sa wc_DhSetKey
*/
int wc_DhKeyDecode(const byte* input, word32* inOutIdx, DhKey* key,
word32);
word32 inSz);
/*!
\ingroup Diffie-Hellman
@@ -396,5 +396,5 @@ int wc_DhSetKey_ex(DhKey* key, const byte* p, word32 pSz,
/*!
\ingroup Diffie-Hellman
*/
*/
int wc_FreeDhKey(DhKey* key);

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

@@ -885,7 +885,7 @@ void wc_ecc_del_point(ecc_point* p);
\sa wc_ecc_del_point
*/
int wc_ecc_copy_point(ecc_point* p, ecc_point *r);
int wc_ecc_copy_point(const ecc_point* p, ecc_point *r);
/*!
\ingroup ECC
@@ -1003,7 +1003,7 @@ int wc_ecc_point_is_at_infinity(ecc_point *p);
\sa none
*/
int wc_ecc_mulmod(mp_int* k, ecc_point *G, ecc_point *R,
int wc_ecc_mulmod(const mp_int* k, ecc_point *G, ecc_point *R,
mp_int* a, mp_int* modulus, int map);
/*!
@@ -1534,7 +1534,7 @@ int wc_ecc_export_point_der(const int curve_idx, ecc_point* point,
\sa wc_ecc_export_point_der
*/
int wc_ecc_import_point_der(byte* in, word32 inLen, const int curve_idx,
int wc_ecc_import_point_der(const byte* in, word32 inLen, const int curve_idx,
ecc_point* point);
/*!
@@ -1621,7 +1621,7 @@ int wc_ecc_sig_size_calc(int sz);
\sa wc_ecc_sig_size_calc
*/
int wc_ecc_sig_size(ecc_key* key);
int wc_ecc_sig_size(const ecc_key* key);
/*!
@@ -1681,7 +1681,7 @@ ecEncCtx* wc_ecc_ctx_new(int flags, WC_RNG* rng);
\sa wc_ecc_ctx_new
*/
void wc_ecc_ctx_free(ecEncCtx*);
void wc_ecc_ctx_free(ecEncCtx* ctx);
/*!
\ingroup ECC

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

@@ -124,8 +124,9 @@ int wc_ed448_make_key(WC_RNG* rng, int keysize, ed448_key* key);
\sa wc_ed448_verify_msg
*/
int wc_ed448_sign_msg(const byte* in, word32 inlen, byte* out,
word32 *outlen, ed448_key* key);
int wc_ed448_sign_msg(const byte* in, word32 inLen, byte* out,
word32 *outLen, ed448_key* key,
const byte* context, byte contextLen);
/*!
\ingroup ED448
@@ -685,7 +686,7 @@ int wc_ed448_import_private_key_ex(const byte* priv, word32 privSz,
\sa wc_ed448_export_private_only
*/
int wc_ed448_export_public(ed448_key* key, byte* out, word32* outLen);
int wc_ed448_export_public(const ed448_key* key, byte* out, word32* outLen);
/*!
\ingroup ED448
@@ -725,7 +726,8 @@ int wc_ed448_export_public(ed448_key* key, byte* out, word32* outLen);
\sa wc_ed448_import_private_key_ex
*/
int wc_ed448_export_private_only(ed448_key* key, byte* out, word32* outLen);
int wc_ed448_export_private_only(const ed448_key* key, byte* out,
word32* outLen);
/*!
\ingroup ED448
@@ -768,7 +770,7 @@ int wc_ed448_export_private_only(ed448_key* key, byte* out, word32* outLen);
\sa wc_ed448_export_private_only
*/
int wc_ed448_export_private(ed448_key* key, byte* out, word32* outLen);
int wc_ed448_export_private(const ed448_key* key, byte* out, word32* outLen);
/*!
\ingroup ED448
@@ -815,7 +817,7 @@ int wc_ed448_export_private(ed448_key* key, byte* out, word32* outLen);
\sa wc_ed448_export_public
*/
int wc_ed448_export_key(ed448_key* key,
int wc_ed448_export_key(const ed448_key* key,
byte* priv, word32 *privSz,
byte* pub, word32 *pubSz);
@@ -879,7 +881,7 @@ int wc_ed448_check_key(ed448_key* key);
\sa wc_ed448_make_key
*/
int wc_ed448_size(ed448_key* key);
int wc_ed448_size(const ed448_key* key);
/*!
\ingroup ED448
@@ -908,7 +910,7 @@ int wc_ed448_size(ed448_key* key);
\sa wc_ed448_pub_size
*/
int wc_ed448_priv_size(ed448_key* key);
int wc_ed448_priv_size(const ed448_key* key);
/*!
\ingroup ED448
@@ -935,7 +937,7 @@ int wc_ed448_priv_size(ed448_key* key);
\sa wc_ed448_priv_size
*/
int wc_ed448_pub_size(ed448_key* key);
int wc_ed448_pub_size(const ed448_key* key);
/*!
\ingroup ED448
@@ -963,4 +965,4 @@ int wc_ed448_pub_size(ed448_key* key);
\sa wc_ed448_sign_msg
*/
int wc_ed448_sig_size(ed448_key* key);
int wc_ed448_sig_size(const ed448_key* key);

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

@@ -98,6 +98,7 @@ int wc_Hash(enum wc_HashType hash_type,
\param data the data to hash
\param len the length of data
\param hash Byte array to hold hash value.
\param hashLen Number of bytes to write to hash.
_Example_
\code
@@ -365,7 +366,8 @@ int wc_Sha3_512Hash(const byte* data, word32 len, byte* hash);
\sa wc_Shake128_Update
\sa wc_Shake128_Final
*/
int wc_Shake128Hash(const byte* data, word32 len, byte* hash);
int wc_Shake128Hash(const byte* data, word32 len, byte* hash,
word32 hashLen);
/*!
\ingroup SHA
@@ -380,6 +382,7 @@ int wc_Shake128Hash(const byte* data, word32 len, byte* hash);
\param data the data to hash
\param len the length of data
\param hash Byte array to hold hash value.
\param hashLen Number of bytes to write to hash.
_Example_
\code
@@ -390,7 +393,7 @@ int wc_Shake128Hash(const byte* data, word32 len, byte* hash);
\sa wc_Shake256_Update
\sa wc_Shake256_Final
*/
int wc_Shake256Hash(const byte* data, word32 len, byte* hash);
int wc_Shake256Hash(const byte* data, word32 len, byte* hash,
word32 hashLen);

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

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

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

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

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

@@ -33,7 +33,7 @@
\sa wc_Md5Update
\sa wc_Md5Final
*/
int wc_InitMd5(wc_Md5*);
int wc_InitMd5(wc_Md5* md5);
/*!
\ingroup MD5
@@ -148,7 +148,7 @@ int wc_Md5Final(wc_Md5* md5, byte* hash);
\sa wc_Md5Update
\sa wc_Md5Final
*/
void wc_Md5Free(wc_Md5*);
void wc_Md5Free(wc_Md5* md5);
/*!
\ingroup MD5

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

@@ -47,6 +47,8 @@ void* wolfSSL_Malloc(size_t size, void* heap, int type);
\param ptr pointer to the memory to be freed.
\param heap heap hint to use for memory. Can be NULL
\param type dynamic type (see DYNAMIC_TYPE_ list in types.h)
\param func name of calling function (for allocation tracking)
\param line source line number of call site
_Example_
\code
@@ -65,7 +67,8 @@ void* wolfSSL_Malloc(size_t size, void* heap, int type);
\sa XFREE
\sa XREALLOC
*/
void wolfSSL_Free(void *ptr, void* heap, int type);
void wolfSSL_Free(void *ptr, void* heap, int type, const char* func,
unsigned int line);
/*!
\ingroup Memory
@@ -148,9 +151,8 @@ void* wolfSSL_Realloc(void *ptr, size_t size, void* heap, int type);
\sa none
*/
int wolfSSL_SetAllocators(wolfSSL_Malloc_cb,
wolfSSL_Free_cb,
wolfSSL_Realloc_cb);
int wolfSSL_SetAllocators(wolfSSL_Malloc_cb mf, wolfSSL_Free_cb ff,
wolfSSL_Realloc_cb rf);
/*!
\ingroup Memory
@@ -380,7 +382,7 @@ int wolfSSL_is_static_memory(WOLFSSL* ssl, WOLFSSL_MEM_CONN_STATS* mem_stats);
\return If successful, 0 will be returned.
\return All unsuccessful return values will be less than 0.
\param hint WOLFSSL_HEAP_HINT structure to use
\param pHint WOLFSSL_HEAP_HINT structure to use
\param buf memory to use for all operations.
\param sz size of memory buffer being passed in.
\param flag type of memory.
@@ -410,8 +412,8 @@ int wolfSSL_is_static_memory(WOLFSSL* ssl, WOLFSSL_MEM_CONN_STATS* mem_stats);
\sa none
*/
int wc_LoadStaticMemory(WOLFSSL_HEAP_HINT* hint, unsigned char* buf, unsigned int sz,
int flag, int max);
int wc_LoadStaticMemory(WOLFSSL_HEAP_HINT** pHint, unsigned char* buf,
unsigned int sz, int flag, int max);
/*!
\ingroup Memory
@@ -424,13 +426,14 @@ int wc_LoadStaticMemory(WOLFSSL_HEAP_HINT* hint, unsigned char* buf, unsigned in
\return If successful, 0 will be returned.
\return All unsuccessful return values will be less than 0.
\param hint WOLFSSL_HEAP_HINT structure to use
\param pHint WOLFSSL_HEAP_HINT handle to initialize
\param listSz number of entries in the size and distribution lists
\param sizeList array of bucket sizes to use
\param distList distribution list matching sizeList
\param buf memory to use for all operations.
\param sz size of memory buffer being passed in.
\param flag type of memory.
\param max max concurrent operations (handshakes, IO).
\param bucket_sizes array of bucket sizes to use
\param bucket_count number of bucket sizes in the array
_Example_
\code
@@ -439,14 +442,16 @@ int wc_LoadStaticMemory(WOLFSSL_HEAP_HINT* hint, unsigned char* buf, unsigned in
unsigned char memory[MAX];
int memorySz = MAX;
int flag = WOLFMEM_GENERAL | WOLFMEM_TRACK_STATS;
word16 bucket_sizes[] = {64, 128, 256, 512, 1024};
int bucket_count = 5;
const word32 sizeList[] = {64, 128, 256, 512, 1024};
const word32 distList[] = {1, 1, 1, 1, 1};
unsigned int listSz = (unsigned int)(sizeof(sizeList)/
sizeof(sizeList[0]));
...
// load in memory for use with custom bucket sizes
ret = wc_LoadStaticMemory_ex(&hint, memory, memorySz, flag, 0,
bucket_sizes, bucket_count);
ret = wc_LoadStaticMemory_ex(&hint, listSz, sizeList, distList,
memory, memorySz, flag, 0);
if (ret != SSL_SUCCESS) {
// handle error case
}
@@ -460,8 +465,9 @@ int wc_LoadStaticMemory(WOLFSSL_HEAP_HINT* hint, unsigned char* buf, unsigned in
\sa wc_LoadStaticMemory
\sa wc_UnloadStaticMemory
*/
int wc_LoadStaticMemory_ex(WOLFSSL_HEAP_HINT* hint, unsigned char* buf, unsigned int sz,
int flag, int max, word16* bucket_sizes, int bucket_count);
int wc_LoadStaticMemory_ex(WOLFSSL_HEAP_HINT** pHint, unsigned int listSz,
const word32 *sizeList, const word32 *distList,
unsigned char* buf, unsigned int sz, int flag, int max);
/*!
\ingroup Memory
@@ -560,7 +566,7 @@ WOLFSSL_HEAP_HINT* wolfSSL_GetGlobalHeapHint(void);
\sa none
*/
int wolfSSL_SetDebugMemoryCb(wolfSSL_DebugMemoryCb cb);
void wolfSSL_SetDebugMemoryCb(DebugMemoryCb cb);
/*!
\ingroup Memory
@@ -591,16 +597,13 @@ int wolfSSL_SetDebugMemoryCb(wolfSSL_DebugMemoryCb cb);
...
// cleanup when done
ret = wc_UnloadStaticMemory(&hint);
if (ret != 0) {
// handle error case
}
wc_UnloadStaticMemory(&hint);
\endcode
\sa wc_LoadStaticMemory
\sa wc_LoadStaticMemory_ex
*/
int wc_UnloadStaticMemory(WOLFSSL_HEAP_HINT* hint);
void wc_UnloadStaticMemory(WOLFSSL_HEAP_HINT* heap);
/*!
\ingroup Memory
@@ -636,4 +639,3 @@ int wc_UnloadStaticMemory(WOLFSSL_HEAP_HINT* hint);
int wolfSSL_StaticBufferSz_ex(unsigned int listSz,
const word32 *sizeList, const word32 *distList,
byte* buffer, word32 sz, int flag);

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

@@ -34,7 +34,7 @@ void wc_Pkcs11Token_Close(Pkcs11Token* token);
/*!
\ingroup PKCS11
*/
int wc_Pkcs11StoreKey(Pkcs11Token* token, int type, int clear,
int wc_Pkcs11StoreKey(Pkcs11Token* token, int type, int clear, void* key);
/*!
\ingroup PKCS11

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

@@ -60,13 +60,13 @@ typedef int (*CallbackAESKeyWrapUnwrap)(const byte* key, word32 keySz,
\param pkcs7 pointer to the PKCS7 structure in which to
store the decoded cert
\param cert pointer to a buffer containing a DER formatted ASN.1
\param der pointer to a buffer containing a DER formatted ASN.1
certificate with which to initialize the PKCS7 structure
\param certSz size of the certificate buffer
\param derSz size of the certificate buffer
_Example_
\code
PKCS7 pkcs7;
wc_PKCS7 pkcs7;
byte derBuff[] = { }; // initialize with DER-encoded certificate
if ( wc_PKCS7_InitWithCert(&pkcs7, derBuff, sizeof(derBuff)) != 0 ) {
// error parsing certificate into pkcs7 format
@@ -75,7 +75,7 @@ typedef int (*CallbackAESKeyWrapUnwrap)(const byte* key, word32 keySz,
\sa wc_PKCS7_Free
*/
int wc_PKCS7_InitWithCert(PKCS7* pkcs7, byte* cert, word32 certSz);
int wc_PKCS7_InitWithCert(wc_PKCS7* pkcs7, byte* der, word32 derSz);
/*!
\ingroup PKCS7
@@ -96,7 +96,7 @@ int wc_PKCS7_InitWithCert(PKCS7* pkcs7, byte* cert, word32 certSz);
\sa wc_PKCS7_InitWithCert
*/
void wc_PKCS7_Free(PKCS7* pkcs7);
void wc_PKCS7_Free(wc_PKCS7* pkcs7);
/*!
\ingroup PKCS7
@@ -139,7 +139,7 @@ void wc_PKCS7_Free(PKCS7* pkcs7);
\sa wc_PKCS7_InitWithCert
*/
int wc_PKCS7_EncodeData(PKCS7* pkcs7, byte* output,
int wc_PKCS7_EncodeData(wc_PKCS7* pkcs7, byte* output,
word32 outputSz);
/*!
@@ -217,7 +217,7 @@ int wc_PKCS7_EncodeData(PKCS7* pkcs7, byte* output,
\sa wc_PKCS7_InitWithCert
\sa wc_PKCS7_VerifySignedData
*/
int wc_PKCS7_EncodeSignedData(PKCS7* pkcs7,
int wc_PKCS7_EncodeSignedData(wc_PKCS7* pkcs7,
byte* output, word32 outputSz);
/*!
@@ -317,7 +317,7 @@ int wc_PKCS7_EncodeSignedData(PKCS7* pkcs7,
\sa wc_PKCS7_InitWithCert
\sa wc_PKCS7_VerifySignedData_ex
*/
int wc_PKCS7_EncodeSignedData_ex(PKCS7* pkcs7, const byte* hashBuf,
int wc_PKCS7_EncodeSignedData_ex(wc_PKCS7* pkcs7, const byte* hashBuf,
word32 hashSz, byte* outputHead, word32* outputHeadSz, byte* outputFoot,
word32* outputFootSz);
@@ -394,7 +394,7 @@ int wc_PKCS7_EncodeSignedData_ex(PKCS7* pkcs7, const byte* hashBuf,
\sa wc_PKCS7_InitWithCert
\sa wc_PKCS7_EncodeSignedData
*/
int wc_PKCS7_VerifySignedData(PKCS7* pkcs7,
int wc_PKCS7_VerifySignedData(wc_PKCS7* pkcs7,
byte* pkiMsg, word32 pkiMsgSz);
@@ -493,7 +493,7 @@ int wc_PKCS7_VerifySignedData(PKCS7* pkcs7,
\sa wc_PKCS7_InitWithCert
\sa wc_PKCS7_EncodeSignedData_ex
*/
int wc_PKCS7_VerifySignedData_ex(PKCS7* pkcs7, const byte* hashBuf,
int wc_PKCS7_VerifySignedData_ex(wc_PKCS7* pkcs7, const byte* hashBuf,
word32 hashSz, byte* pkiMsgHead, word32 pkiMsgHeadSz, byte* pkiMsgFoot,
word32 pkiMsgFootSz);
@@ -565,7 +565,7 @@ int wc_PKCS7_SetAESKeyWrapUnwrapCb(wc_PKCS7* pkcs7,
\sa wc_PKCS7_InitWithCert
\sa wc_PKCS7_DecodeEnvelopedData
*/
int wc_PKCS7_EncodeEnvelopedData(PKCS7* pkcs7,
int wc_PKCS7_EncodeEnvelopedData(wc_PKCS7* pkcs7,
byte* output, word32 outputSz);
/*!
@@ -651,7 +651,7 @@ int wc_PKCS7_EncodeEnvelopedData(PKCS7* pkcs7,
\sa wc_PKCS7_InitWithCert
\sa wc_PKCS7_EncodeEnvelopedData
*/
int wc_PKCS7_DecodeEnvelopedData(PKCS7* pkcs7, byte* pkiMsg,
int wc_PKCS7_DecodeEnvelopedData(wc_PKCS7* pkcs7, byte* pkiMsg,
word32 pkiMsgSz, byte* output, word32 outputSz);
/*!
@@ -725,7 +725,7 @@ int wc_PKCS7_GetEnvelopedDataKariRid(const byte * in, word32 inSz,
\sa wc_PKCS7_InitWithCert
*/
int wc_PKCS7_DecodeEncryptedData(PKCS7* pkcs7, byte* pkiMsg,
int wc_PKCS7_DecodeEncryptedData(wc_PKCS7* pkcs7, byte* pkiMsg,
word32 pkiMsgSz, byte* output, word32 outputSz);
/*!

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

@@ -135,5 +135,5 @@ int wc_Poly1305Final(Poly1305* poly1305, byte* tag);
\sa wc_Poly1305Update
\sa wcPoly1305Final
*/
int wc_Poly1305_MAC(Poly1305* ctx, byte* additional, word32 addSz,
byte* input, word32 sz, byte* tag, word32 tagSz);
int wc_Poly1305_MAC(Poly1305* ctx, const byte* additional, word32 addSz,
const byte* input, word32 sz, byte* tag, word32 tagSz);

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

@@ -24,7 +24,7 @@
\sa wc_FreeNetRandom
*/
int wc_InitNetRandom(const char* configFile, wnr_hmac_key hmac_cb, int timeout);
int wc_InitNetRandom(const char*, wnr_hmac_key, int);
/*!
\ingroup Random
@@ -95,7 +95,7 @@ int wc_FreeNetRandom(void);
\sa wc_FreeRng
\sa wc_RNG_HealthTest
*/
int wc_InitRng(WC_RNG*);
int wc_InitRng(WC_RNG* rng);
/*!
\ingroup Random
@@ -241,7 +241,7 @@ int wc_RNG_GenerateByte(WC_RNG* rng, byte* b);
\sa wc_RNG_GenerateByte,
\sa wc_RNG_HealthTest
*/
int wc_FreeRng(WC_RNG*);
int wc_FreeRng(WC_RNG* rng);
/*!
\ingroup Random

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

@@ -23,7 +23,7 @@
\sa wc_RipeMdUpdate
\sa wc_RipeMdFinal
*/
int wc_InitRipeMd(RipeMd*);
int wc_InitRipeMd(RipeMd* ripemd);
/*!
\ingroup RIPEMD

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

@@ -522,7 +522,7 @@ int wc_RsaPSS_Sign(const byte* in, word32 inLen, byte* out,
\sa wc_RsaPSS_CheckPadding
\sa wc_RsaSetRNG
*/
int wc_RsaPSS_Verify(byte* in, word32 inLen, byte* out,
int wc_RsaPSS_Verify(const byte* in, word32 inLen, byte* out,
word32 outLen, enum wc_HashType hash, int mgf,
RsaKey* key);
@@ -651,7 +651,7 @@ int wc_RsaPSS_VerifyInline(byte* in, word32 inLen, byte** out,
\sa wc_RsaSetRNG
*/
int wc_RsaPSS_VerifyCheck(byte* in, word32 inLen,
int wc_RsaPSS_VerifyCheck(const byte* in, word32 inLen,
byte* out, word32 outLen,
const byte* digest, word32 digestLen,
enum wc_HashType hash, int mgf,
@@ -927,7 +927,7 @@ int wc_RsaPSS_VerifyCheckInline_ex(byte* in, word32 inLen, byte** out,
\sa wc_RsaPSS_CheckPadding_ex
\sa wc_RsaSetRNG
*/
int wc_RsaPSS_CheckPadding(const byte* in, word32 inLen, byte* sig,
int wc_RsaPSS_CheckPadding(const byte* in, word32 inLen, const byte* sig,
word32 sigSz,
enum wc_HashType hashType);
/*!
@@ -992,7 +992,7 @@ int wc_RsaPSS_CheckPadding(const byte* in, word32 inLen, byte* sig,
\sa wc_RsaPSS_VerifyCheckInline_ex
\sa wc_RsaPSS_CheckPadding
*/
int wc_RsaPSS_CheckPadding_ex(const byte* in, word32 inLen, byte* sig,
int wc_RsaPSS_CheckPadding_ex(const byte* in, word32 inLen, const byte* sig,
word32 sigSz, enum wc_HashType hashType, int saltLen, int bits);
/*!
\ingroup RSA
@@ -1012,7 +1012,7 @@ int wc_RsaPSS_CheckPadding_ex(const byte* in, word32 inLen, byte* sig,
\sa wc_InitRsaKey_ex
\sa wc_MakeRsaKey
*/
int wc_RsaEncryptSize(RsaKey* key);
int wc_RsaEncryptSize(const RsaKey* key);
/*!
\ingroup RSA
@@ -1389,7 +1389,7 @@ int wc_RsaPrivateDecryptInline_ex(byte* in, word32 inLen,
\sa wc_InitRsaKey_ex
\sa wc_MakeRsaKey
*/
int wc_RsaFlattenPublicKey(RsaKey* key, byte* e, word32* eSz, byte* n,
int wc_RsaFlattenPublicKey(const RsaKey* key, byte* e, word32* eSz, byte* n,
word32* nSz);
/*!

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

@@ -24,7 +24,7 @@
\sa wc_ShaUpdate
\sa wc_ShaFinal
*/
int wc_InitSha(wc_Sha*);
int wc_InitSha(wc_Sha* sha);
/*!
\ingroup SHA
@@ -112,7 +112,7 @@ int wc_ShaFinal(wc_Sha* sha, byte* hash);
\sa wc_ShaUpdate
\sa wc_ShaFinal
*/
void wc_ShaFree(wc_Sha*);
void wc_ShaFree(wc_Sha* sha);
/*!
\ingroup SHA

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

@@ -24,7 +24,7 @@
\sa wc_Sha256Update
\sa wc_Sha256Final
*/
int wc_InitSha256(wc_Sha256*);
int wc_InitSha256(wc_Sha256* sha);
/*!
\ingroup SHA
@@ -121,7 +121,7 @@ int wc_Sha256Final(wc_Sha256* sha256, byte* hash);
\sa wc_Sha256Update
\sa wc_Sha256Final
*/
void wc_Sha256Free(wc_Sha256*);
void wc_Sha256Free(wc_Sha256* sha256);
/*!
\ingroup SHA
@@ -175,7 +175,7 @@ int wc_Sha256GetHash(wc_Sha256* sha256, byte* hash);
\sa wc_Sha224Update
\sa wc_Sha224Final
*/
int wc_InitSha224(wc_Sha224*);
int wc_InitSha224(wc_Sha224* sha224);
/*!
\ingroup SHA

21
doc/dox_comments/header_files/sha3.h
View File

@@ -121,7 +121,7 @@ int wc_Sha3_224_Final(wc_Sha3* sha3, byte* hash);
\sa wc_Sha3_224_Update
\sa wc_Sha3_224_Final
*/
void wc_Sha3_224_Free(wc_Sha3*);
void wc_Sha3_224_Free(wc_Sha3* sha3);
/*!
\ingroup SHA
@@ -306,7 +306,7 @@ int wc_Sha3_256_Final(wc_Sha3* sha3, byte* hash);
\sa wc_Sha3_256_Update
\sa wc_Sha3_256_Final
*/
void wc_Sha3_256_Free(wc_Sha3*);
void wc_Sha3_256_Free(wc_Sha3* sha3);
/*!
\ingroup SHA
@@ -491,7 +491,7 @@ int wc_Sha3_384_Final(wc_Sha3* sha3, byte* hash);
\sa wc_Sha3_384_Update
\sa wc_Sha3_384_Final
*/
void wc_Sha3_384_Free(wc_Sha3*);
void wc_Sha3_384_Free(wc_Sha3* sha3);
/*!
\ingroup SHA
@@ -676,7 +676,7 @@ int wc_Sha3_512_Final(wc_Sha3* sha3, byte* hash);
\sa wc_Sha3_512_Update
\sa wc_Sha3_512_Final
*/
void wc_Sha3_512_Free(wc_Sha3*);
void wc_Sha3_512_Free(wc_Sha3* sha3);
/*!
\ingroup SHA
@@ -809,6 +809,7 @@ int wc_Shake128_Update(wc_Shake* sha, const byte* data, word32 len);
\param shake pointer to the shake structure to use for encryption
\param hash Byte array to hold hash value.
\param hashLen Number of bytes to write to hash.
_Example_
\code
@@ -829,7 +830,7 @@ int wc_Shake128_Update(wc_Shake* sha, const byte* data, word32 len);
\sa wc_Shake128_GetHash
\sa wc_InitShake128
*/
int wc_Shake128_Final(wc_Shake* shake, byte* hash);
int wc_Shake128_Final(wc_Shake* shake, byte* hash, word32 hashLen);
/*!
\ingroup SHA
@@ -930,7 +931,7 @@ int wc_Shake128_SqueezeBlocks(wc_Shake* shake, byte* out, word32 blockCnt);
\sa wc_Shake128_Update
\sa wc_Shake128_Final
*/
void wc_Shake128_Free(wc_Shake*);
void wc_Shake128_Free(wc_Shake* shake);
/*!
\ingroup SHA
@@ -990,7 +991,7 @@ int wc_Shake128_GetHash(wc_Shake* shake, byte* hash);
\sa wc_InitShake128
\sa wc_Shake128_GetHash
*/
int wc_Shake128_Copy(wc_Shake* shake, wc_Shake* dst);
int wc_Shake128_Copy(wc_Shake* src, wc_Sha3* dst);
/*!
\ingroup SHA
@@ -1185,7 +1186,7 @@ int wc_Shake256_SqueezeBlocks(wc_Shake* shake, byte* out, word32 blockCnt);
\sa wc_Shake256_Update
\sa wc_Shake256_Final
*/
void wc_Shake256_Free(wc_Shake*);
void wc_Shake256_Free(wc_Shake* shake);
/*!
\ingroup SHA
@@ -1245,6 +1246,4 @@ int wc_Shake256_GetHash(wc_Shake* shake, byte* hash);
\sa wc_InitShake256
\sa wc_Shake256_GetHash
*/
int wc_Shake256_Copy(wc_Shake* shake, wc_Shake* dst);
int wc_Shake256_Copy(wc_Shake* src, wc_Sha3* dst);

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

@@ -24,7 +24,7 @@
\sa wc_Sha512Update
\sa wc_Sha512Final
*/
int wc_InitSha512(wc_Sha512*);
int wc_InitSha512(wc_Sha512* sha);
/*!
\ingroup SHA
@@ -116,7 +116,7 @@ int wc_Sha512Final(wc_Sha512* sha512, byte* hash);
\sa wc_Sha384Update
\sa wc_Sha384Final
*/
int wc_InitSha384(wc_Sha384*);
int wc_InitSha384(wc_Sha384* sha);
/*!
\ingroup SHA

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

@@ -721,7 +721,7 @@ int wolfSSL_use_old_poly(WOLFSSL* ssl, int value);
\sa wolfSSL_CTX_new
\sa wolfSSL_CTX_dtls_set_export
*/
int wolfSSL_dtls_import(WOLFSSL* ssl, unsigned char* buf,
int wolfSSL_dtls_import(WOLFSSL* ssl, const unsigned char* buf,
unsigned int sz);
@@ -1229,7 +1229,7 @@ int wolfSSL_CTX_load_verify_locations(WOLFSSL_CTX* ctx, const char* file,
\sa wolfSSL_use_certificate_chain_file
*/
int wolfSSL_CTX_load_verify_locations_ex(WOLFSSL_CTX* ctx, const char* file,
const char* path, unsigned int flags);
const char* path, word32 flags);
/*!
\ingroup CertsKeys
@@ -2019,7 +2019,7 @@ const char* wolfSSL_get_cipher_name(WOLFSSL* ssl);
\sa wolfSSL_set_read_fd
\sa wolfSSL_set_write_fd
*/
int wolfSSL_get_fd(const WOLFSSL*);
int wolfSSL_get_fd(const WOLFSSL* ssl);
/*!
\ingroup IO
@@ -2046,7 +2046,7 @@ int wolfSSL_get_fd(const WOLFSSL*);
\sa wolfSSL_set_read_fd
\sa wolfSSL_set_write_fd
*/
int wolfSSL_get_wfd(const WOLFSSL*);
int wolfSSL_get_wfd(const WOLFSSL* ssl);
/*!
\ingroup Setup
@@ -2316,7 +2316,7 @@ int wolfSSL_peek(WOLFSSL* ssl, void* data, int sz);
\sa wolfSSL_get_error
\sa wolfSSL_connect
*/
int wolfSSL_accept(WOLFSSL*);
int wolfSSL_accept(WOLFSSL* ssl);
/*!
\ingroup IO
@@ -2382,7 +2382,7 @@ int wolfDTLS_accept_stateless(WOLFSSL* ssl);
\sa wolfSSL_new
\sa wolfSSL_free
*/
void wolfSSL_CTX_free(WOLFSSL_CTX*);
void wolfSSL_CTX_free(WOLFSSL_CTX* ctx);
/*!
\ingroup Setup
@@ -2406,7 +2406,7 @@ void wolfSSL_CTX_free(WOLFSSL_CTX*);
\sa wolfSSL_new
\sa wolfSSL_CTX_free
*/
void wolfSSL_free(WOLFSSL*);
void wolfSSL_free(WOLFSSL* ssl);
/*!
\ingroup TLS
@@ -2452,7 +2452,7 @@ void wolfSSL_free(WOLFSSL*);
\sa wolfSSL_free
\sa wolfSSL_CTX_free
*/
int wolfSSL_shutdown(WOLFSSL*);
int wolfSSL_shutdown(WOLFSSL* ssl);
/*!
\ingroup IO
@@ -2847,7 +2847,7 @@ int wolfSSL_GetSessionIndex(WOLFSSL* ssl);
\sa LockMutex
\sa wolfSSL_GetSessionIndex
*/
int wolfSSL_GetSessionAtIndex(int idx, WOLFSSL_SESSION* session);
int wolfSSL_GetSessionAtIndex(int index, WOLFSSL_SESSION* session);
/*!
\ingroup IO
@@ -3054,7 +3054,7 @@ void wolfSSL_CTX_SetCertCbCtx(WOLFSSL_CTX* ctx, void* userCtx);
\sa wolfSSL_read
\sa wolfSSL_peek
*/
int wolfSSL_pending(WOLFSSL*);
int wolfSSL_pending(WOLFSSL* ssl);
/*!
\ingroup Debug
@@ -3786,7 +3786,7 @@ void wolfSSL_dtls13_set_send_more_acks(WOLFSSL *ssl, int value);
\sa wolfSSL_dtls_set_timeout_max
\sa wolfSSL_dtls_got_timeout
*/
int wolfSSL_dtls_set_timeout_init(WOLFSSL* ssl, int);
int wolfSSL_dtls_set_timeout_init(WOLFSSL* ssl, int timeout);
/*!
\brief This function sets the maximum dtls timeout.
@@ -3814,7 +3814,7 @@ int wolfSSL_dtls_set_timeout_init(WOLFSSL* ssl, int);
\sa wolfSSL_dtls_set_timeout_init
\sa wolfSSL_dtls_got_timeout
*/
int wolfSSL_dtls_set_timeout_max(WOLFSSL* ssl, int);
int wolfSSL_dtls_set_timeout_max(WOLFSSL* ssl, int timeout);
/*!
\brief When using non-blocking sockets with DTLS, this function should
@@ -4208,7 +4208,7 @@ int wolfSSL_session_reused(WOLFSSL* ssl);
\sa wolfSSL_get_keys
\sa wolfSSL_set_shutdown
*/
int wolfSSL_is_init_finished(WOLFSSL* ssl);
int wolfSSL_is_init_finished(const WOLFSSL* ssl);
/*!
\ingroup IO
@@ -4644,7 +4644,7 @@ int wolfSSL_BIO_make_bio_pair(WOLFSSL_BIO *b1, WOLFSSL_BIO *b2);
\sa wolfSSL_BIO_new, wolfSSL_BIO_s_mem
\sa wolfSSL_BIO_new, wolfSSL_BIO_free
*/
int wolfSSL_BIO_ctrl_reset_read_request(WOLFSSL_BIO *bio);
int wolfSSL_BIO_ctrl_reset_read_request(WOLFSSL_BIO *b);
/*!
\ingroup IO
@@ -5004,7 +5004,7 @@ WOLFSSL_X509_NAME* wolfSSL_X509_get_subject_name(WOLFSSL_X509* cert);
\sa wolfSSL_X509_get_issuer_name
\sa wolfSSL_X509_get_isCA
*/
int wolfSSL_X509_get_isCA(WOLFSSL_X509* cert);
int wolfSSL_X509_get_isCA(WOLFSSL_X509* x509);
/*!
\ingroup CertsKeys
@@ -5068,7 +5068,7 @@ int wolfSSL_X509_NAME_get_text_by_NID(WOLFSSL_X509_NAME* name, int nid,
\sa wolfSSL_X509_notAfter
\sa wolfSSL_X509_free
*/
int wolfSSL_X509_get_signature_type(WOLFSSL_X509* cert);
int wolfSSL_X509_get_signature_type(WOLFSSL_X509* x509);
/*!
\brief This function frees a WOLFSSL_X509 structure.
@@ -5726,7 +5726,7 @@ long wolfSSL_set_options(WOLFSSL *s, long op);
\sa wolfSSL_free
\sa wolfSSL_set_options
*/
long wolfSSL_get_options(const WOLFSSL *ssl);
long wolfSSL_get_options(const WOLFSSL *s);
/*!
\ingroup Setup
@@ -5752,7 +5752,7 @@ long wolfSSL_get_options(const WOLFSSL *ssl);
\sa wolfSSL_new
\sa wolfSSL_free
*/
long wolfSSL_set_tlsext_debug_arg(WOLFSSL *ssl, void *arg);
long wolfSSL_set_tlsext_debug_arg(WOLFSSL *s, void *arg);
/*!
\ingroup openSSL
@@ -5950,7 +5950,7 @@ void wolfSSL_CTX_set_psk_client_callback(WOLFSSL_CTX* ctx,
\sa wolfSSL_set_psk_server_callback
*/
void wolfSSL_set_psk_client_callback(WOLFSSL* ssl,
wc_psk_client_callback);
wc_psk_client_callback cb);
/*!
\ingroup CertsKeys
@@ -6244,7 +6244,7 @@ void* wolfSSL_CTX_get_psk_callback_ctx(WOLFSSL_CTX* ctx);
\sa none
*/
int wolfSSL_CTX_allow_anon_cipher(WOLFSSL_CTX*);
int wolfSSL_CTX_allow_anon_cipher(WOLFSSL_CTX* ctx);
/*!
\ingroup Setup
@@ -6368,7 +6368,7 @@ WOLFSSL_X509* wolfSSL_get_peer_certificate(WOLFSSL* ssl);
\sa wolfSSL_want_write
\sa wolfSSL_get_error
*/
int wolfSSL_want_read(WOLFSSL*);
int wolfSSL_want_read(WOLFSSL* ssl);
/*!
\ingroup Debug
@@ -6398,7 +6398,7 @@ int wolfSSL_want_read(WOLFSSL*);
\sa wolfSSL_want_read
\sa wolfSSL_get_error
*/
int wolfSSL_want_write(WOLFSSL*);
int wolfSSL_want_write(WOLFSSL* ssl);
/*!
\ingroup Setup
@@ -6977,7 +6977,7 @@ WOLFSSL_ASN1_TIME* wolfSSL_X509_get_notAfter(WOLFSSL_X509*);
\sa wolfSSL_X509_get_isCA
\sa wolfSSL_get_peer_certificate
*/
int wolfSSL_X509_version(WOLFSSL_X509*);
int wolfSSL_X509_version(WOLFSSL_X509* x509);
/*!
\ingroup CertsKeys
@@ -7632,7 +7632,7 @@ int wolfSSL_CTX_SetTmpDH_file(WOLFSSL_CTX* ctx, const char* f,
\sa wolfSSL_GetDhKey_Sz
\sa wolfSSL_CTX_SetTMpDH_file
*/
int wolfSSL_CTX_SetMinDhKey_Sz(WOLFSSL_CTX* ctx, word16);
int wolfSSL_CTX_SetMinDhKey_Sz(WOLFSSL_CTX* ctx, word16 keySz_bits);
/*!
\ingroup CertsKeys
@@ -7754,7 +7754,7 @@ int wolfSSL_SetMaxDhKey_Sz(WOLFSSL* ssl, word16 keySz_bits);
\sa wolfSSL_SetTmpDH
\sa wolfSSL_CTX_SetTmpDH_file
*/
int wolfSSL_GetDhKey_Sz(WOLFSSL*);
int wolfSSL_GetDhKey_Sz(WOLFSSL* ssl);
/*!
\ingroup CertsKeys
@@ -7844,7 +7844,7 @@ int wolfSSL_SetMinRsaKey_Sz(WOLFSSL* ssl, short keySz);
\sa wolfSSL_SetMinEccKey_Sz
*/
int wolfSSL_CTX_SetMinEccKey_Sz(WOLFSSL_CTX* ssl, short keySz);
int wolfSSL_CTX_SetMinEccKey_Sz(WOLFSSL_CTX* ctx, short keySz);
/*!
\ingroup CertsKeys
@@ -7985,7 +7985,7 @@ int wolfSSL_writev(WOLFSSL* ssl, const struct iovec* iov,
\sa LockMutex
\sa UnlockMutex
*/
int wolfSSL_CTX_UnloadCAs(WOLFSSL_CTX*);
int wolfSSL_CTX_UnloadCAs(WOLFSSL_CTX* ctx);
/*!
@@ -8049,7 +8049,7 @@ int wolfSSL_CTX_UnloadIntermediateCerts(WOLFSSL_CTX* ctx);
\sa wolfSSL_CTX_trust_peer_buffer
\sa wolfSSL_CTX_trust_peer_cert
*/
int wolfSSL_CTX_Unload_trust_peers(WOLFSSL_CTX*);
int wolfSSL_CTX_Unload_trust_peers(WOLFSSL_CTX* ctx);
/*!
\ingroup Setup
@@ -8581,7 +8581,7 @@ int wolfSSL_use_certificate_chain_buffer(WOLFSSL* ssl,
\sa wolfSSL_CTX_UnloadCAs
*/
int wolfSSL_UnloadCertsKeys(WOLFSSL*);
int wolfSSL_UnloadCertsKeys(WOLFSSL* ssl);
/*!
\ingroup Setup
@@ -8606,7 +8606,7 @@ int wolfSSL_UnloadCertsKeys(WOLFSSL*);
\sa wolfSSL_set_group_messages
\sa wolfSSL_CTX_new
*/
int wolfSSL_CTX_set_group_messages(WOLFSSL_CTX*);
int wolfSSL_CTX_set_group_messages(WOLFSSL_CTX* ctx);
/*!
\ingroup Setup
@@ -8631,7 +8631,7 @@ int wolfSSL_CTX_set_group_messages(WOLFSSL_CTX*);
\sa wolfSSL_CTX_set_group_messages
\sa wolfSSL_new
*/
int wolfSSL_set_group_messages(WOLFSSL*);
int wolfSSL_set_group_messages(WOLFSSL* ssl);
/*!
\brief This function sets the fuzzer callback.
@@ -8695,8 +8695,8 @@ void wolfSSL_SetFuzzerCb(WOLFSSL* ssl, CallbackFuzzer cbf, void* fCtx);
\sa wc_RNG_GenerateBlock
*/
int wolfSSL_DTLS_SetCookieSecret(WOLFSSL* ssl,
const unsigned char* secret,
unsigned int secretSz);
const byte* secret,
word32 secretSz);
/*!
\brief This function retrieves the random number.
@@ -8850,7 +8850,7 @@ int wolfSSL_GetOutputSize(WOLFSSL* ssl, int inSz);
\sa wolfSSL_GetOutputSize
*/
int wolfSSL_GetMaxOutputSize(WOLFSSL*);
int wolfSSL_GetMaxOutputSize(WOLFSSL* ssl);
/*!
\ingroup Setup
@@ -8910,7 +8910,7 @@ int wolfSSL_SetVersion(WOLFSSL* ssl, int version);
\sa wolfSSL_SetMacEncryptCtx
\sa wolfSSL_GetMacEncryptCtx
*/
void wolfSSL_CTX_SetMacEncryptCb(WOLFSSL_CTX* ctx, CallbackMacEncrypti cb);
void wolfSSL_CTX_SetMacEncryptCb(WOLFSSL_CTX* ctx, CallbackMacEncrypt cb);
/*!
\brief Allows caller to set the Atomic User Record Processing Mac/Encrypt
@@ -9127,7 +9127,7 @@ const unsigned char* wolfSSL_GetServerWriteIV(WOLFSSL*);
\sa wolfSSL_GetClientWriteKey
\sa wolfSSL_GetServerWriteKey
*/
int wolfSSL_GetKeySize(WOLFSSL*);
int wolfSSL_GetKeySize(WOLFSSL* ssl);
/*!
\ingroup CertsKeys
@@ -9157,7 +9157,7 @@ int wolfSSL_GetKeySize(WOLFSSL*);
\sa wolfSSL_GetClientWriteIV
\sa wolfSSL_GetServerWriteIV
*/
int wolfSSL_GetIVSize(WOLFSSL*);
int wolfSSL_GetIVSize(WOLFSSL* ssl);
/*!
\brief Allows retrieval of the side of this WOLFSSL connection.
@@ -9177,7 +9177,7 @@ int wolfSSL_GetIVSize(WOLFSSL*);
\sa wolfSSL_GetClientWriteKey
\sa wolfSSL_GetServerWriteKey
*/
int wolfSSL_GetSide(WOLFSSL*);
int wolfSSL_GetSide(WOLFSSL* ssl);
/*!
\brief Allows caller to determine if the negotiated protocol version
@@ -9196,7 +9196,7 @@ int wolfSSL_GetSide(WOLFSSL*);
\sa wolfSSL_GetSide
*/
int wolfSSL_IsTLSv1_1(WOLFSSL*);
int wolfSSL_IsTLSv1_1(WOLFSSL* ssl);
/*!
\brief Allows caller to determine the negotiated bulk cipher algorithm
@@ -9217,7 +9217,7 @@ int wolfSSL_IsTLSv1_1(WOLFSSL*);
\sa wolfSSL_GetCipherBlockSize
\sa wolfSSL_GetKeySize
*/
int wolfSSL_GetBulkCipher(WOLFSSL*);
int wolfSSL_GetBulkCipher(WOLFSSL* ssl);
/*!
\brief Allows caller to determine the negotiated cipher block size from
@@ -9237,7 +9237,7 @@ int wolfSSL_GetBulkCipher(WOLFSSL*);
\sa wolfSSL_GetBulkCipher
\sa wolfSSL_GetKeySize
*/
int wolfSSL_GetCipherBlockSize(WOLFSSL*);
int wolfSSL_GetCipherBlockSize(WOLFSSL* ssl);
/*!
\brief Allows caller to determine the negotiated aead mac size from the
@@ -9257,7 +9257,7 @@ int wolfSSL_GetCipherBlockSize(WOLFSSL*);
\sa wolfSSL_GetBulkCipher
\sa wolfSSL_GetKeySize
*/
int wolfSSL_GetAeadMacSize(WOLFSSL*);
int wolfSSL_GetAeadMacSize(WOLFSSL* ssl);
/*!
\brief Allows caller to determine the negotiated (h)mac size from the
@@ -9277,7 +9277,7 @@ int wolfSSL_GetAeadMacSize(WOLFSSL*);
\sa wolfSSL_GetBulkCipher
\sa wolfSSL_GetHmacType
*/
int wolfSSL_GetHmacSize(WOLFSSL*);
int wolfSSL_GetHmacSize(WOLFSSL* ssl);
/*!
\brief Allows caller to determine the negotiated (h)mac type from the
@@ -9298,7 +9298,7 @@ int wolfSSL_GetHmacSize(WOLFSSL*);
\sa wolfSSL_GetBulkCipher
\sa wolfSSL_GetHmacSize
*/
int wolfSSL_GetHmacType(WOLFSSL*);
int wolfSSL_GetHmacType(WOLFSSL* ssl);
/*!
\brief Allows caller to determine the negotiated cipher type
@@ -9318,7 +9318,7 @@ int wolfSSL_GetHmacType(WOLFSSL*);
\sa wolfSSL_GetBulkCipher
\sa wolfSSL_GetHmacType
*/
int wolfSSL_GetCipherType(WOLFSSL*);
int wolfSSL_GetCipherType(WOLFSSL* ssl);
/*!
\brief Allows caller to set the Hmac Inner vector for message
@@ -9861,7 +9861,7 @@ WOLFSSL_CERT_MANAGER* wolfSSL_CertManagerNew(void);
\sa wolfSSL_CertManagerNew
*/
void wolfSSL_CertManagerFree(WOLFSSL_CERT_MANAGER*);
void wolfSSL_CertManagerFree(WOLFSSL_CERT_MANAGER* cm);
/*!
\ingroup CertManager
@@ -9941,7 +9941,8 @@ int wolfSSL_CertManagerLoadCA(WOLFSSL_CERT_MANAGER* cm, const char* f,
\sa cm_pick_method
*/
int wolfSSL_CertManagerLoadCABuffer(WOLFSSL_CERT_MANAGER* cm,
const unsigned char* in, long sz, int format);
const unsigned char* buff, long sz,
int format);
/*!
\ingroup CertManager
@@ -10198,7 +10199,7 @@ void wolfSSL_CertManagerSetVerify(WOLFSSL_CERT_MANAGER* cm,
\sa InitDecodedCert
*/
int wolfSSL_CertManagerCheckCRL(WOLFSSL_CERT_MANAGER* cm,
unsigned char* der, int sz);
const unsigned char* der, int sz);
/*!
\ingroup CertManager
@@ -10273,7 +10274,7 @@ int wolfSSL_CertManagerEnableCRL(WOLFSSL_CERT_MANAGER* cm,
\sa wolfSSL_CertManagerEnableCRL
*/
int wolfSSL_CertManagerDisableCRL(WOLFSSL_CERT_MANAGER*);
int wolfSSL_CertManagerDisableCRL(WOLFSSL_CERT_MANAGER* cm);
/*!
\ingroup CertManager
@@ -10533,7 +10534,7 @@ int wolfSSL_CertManagerFreeCRL(WOLFSSL_CERT_MANAGER* cm);
\sa CheckCertOCSP
*/
int wolfSSL_CertManagerCheckOCSP(WOLFSSL_CERT_MANAGER* cm,
unsigned char* der, int sz);
const unsigned char* der, int sz);
/*!
\ingroup CertManager
@@ -10594,7 +10595,7 @@ int wolfSSL_CertManagerEnableOCSP(WOLFSSL_CERT_MANAGER* cm,
\sa wolfSSL_DisableCRL
*/
int wolfSSL_CertManagerDisableOCSP(WOLFSSL_CERT_MANAGER*);
int wolfSSL_CertManagerDisableOCSP(WOLFSSL_CERT_MANAGER* cm);
/*!
\ingroup CertManager
@@ -10871,7 +10872,7 @@ int wolfSSL_EnableOCSP(WOLFSSL* ssl, int options);
\sa wolfSSL_CertManagerDisableOCSP
*/
int wolfSSL_DisableOCSP(WOLFSSL*);
int wolfSSL_DisableOCSP(WOLFSSL* ssl);
/*!
\brief This function sets the ocspOverrideURL member in the
@@ -11131,7 +11132,7 @@ int wolfSSL_CTX_EnableOCSP(WOLFSSL_CTX* ctx, int options);
\sa wolfSSL_DisableOCSP
\sa wolfSSL_CertManagerDisableOCSP
*/
int wolfSSL_CTX_DisableOCSP(WOLFSSL_CTX*);
int wolfSSL_CTX_DisableOCSP(WOLFSSL_CTX* ctx);
/*!
\brief This function manually sets the URL for OCSP to use. By default,
@@ -11226,7 +11227,7 @@ int wolfSSL_CTX_SetOCSP_Cb(WOLFSSL_CTX* ctx,
\sa wolfSSL_CertManagerEnableOCSPStapling
\sa InitOCSP
*/
int wolfSSL_CTX_EnableOCSPStapling(WOLFSSL_CTX*);
int wolfSSL_CTX_EnableOCSPStapling(WOLFSSL_CTX* ctx);
/*!
\ingroup CertsKeys
@@ -11252,7 +11253,7 @@ int wolfSSL_CTX_EnableOCSPStapling(WOLFSSL_CTX*);
\sa wolfSSL_FreeArrays
*/
void wolfSSL_KeepArrays(WOLFSSL*);
void wolfSSL_KeepArrays(WOLFSSL* ssl);
/*!
\ingroup CertsKeys
@@ -11277,7 +11278,7 @@ void wolfSSL_KeepArrays(WOLFSSL*);
\sa wolfSSL_KeepArrays
*/
void wolfSSL_FreeArrays(WOLFSSL*);
void wolfSSL_FreeArrays(WOLFSSL* ssl);
/*!
\brief This function enables the use of Server Name Indication in the SSL
@@ -12379,7 +12380,7 @@ int wolfSSL_send_SessionTicket(WOLFSSL* ssl);
\sa wolfSSL_CTX_set_TicketEncCtx
*/
int wolfSSL_CTX_set_TicketEncCb(WOLFSSL_CTX* ctx,
SessionTicketEncCb);
SessionTicketEncCb cb);
/*!
\brief This function sets the session ticket hint relayed to the client.
@@ -12399,7 +12400,7 @@ int wolfSSL_CTX_set_TicketEncCb(WOLFSSL_CTX* ctx,
\sa wolfSSL_CTX_set_TicketEncCb
*/
int wolfSSL_CTX_set_TicketHint(WOLFSSL_CTX* ctx, int);
int wolfSSL_CTX_set_TicketHint(WOLFSSL_CTX* ctx, int hint);
/*!
\brief This function sets the session ticket encrypt user context for the
@@ -12420,7 +12421,7 @@ int wolfSSL_CTX_set_TicketHint(WOLFSSL_CTX* ctx, int);
\sa wolfSSL_CTX_set_TicketEncCb
*/
int wolfSSL_CTX_set_TicketEncCtx(WOLFSSL_CTX* ctx, void*);
int wolfSSL_CTX_set_TicketEncCtx(WOLFSSL_CTX* ctx, void* userCtx);
/*!
\brief This function gets the session ticket encrypt user context for the
@@ -12690,7 +12691,7 @@ int wolfSSL_connect_ex(WOLFSSL* ssl, HandShakeCallBack hsCb,
\sa wolfSSL_connect_ex
*/
int wolfSSL_accept_ex(WOLFSSL* ssl, HandShakeCallBacki hsCb,
int wolfSSL_accept_ex(WOLFSSL* ssl, HandShakeCallBack hsCb,
TimeoutCallBack toCb, WOLFSSL_TIMEVAL timeout);
/*!
@@ -12800,8 +12801,7 @@ int wolfSSL_check_private_key(const WOLFSSL* ssl);
\endcode
*/
int wolfSSL_X509_get_ext_by_NID(const WOLFSSL_X509* x509,
int nid, int lastPos);
int wolfSSL_X509_get_ext_by_NID(const WOLFSSL_X509 *x, int nid, int lastpos);
/*!
\ingroup CertsKeys
@@ -12918,8 +12918,8 @@ int wolfSSL_use_certificate(WOLFSSL* ssl, WOLFSSL_X509* x509);
\sa wolfSSL_new
\sa wolfSSL_free
*/
int wolfSSL_use_certificate_ASN1(WOLFSSL* ssl, unsigned char* der,
int derSz);
int wolfSSL_use_certificate_ASN1(WOLFSSL* ssl, const unsigned char* der,
int derSz);
/*!
\ingroup CertsKeys
@@ -12980,7 +12980,7 @@ int wolfSSL_use_PrivateKey(WOLFSSL* ssl, WOLFSSL_EVP_PKEY* pkey);
\sa wolfSSL_use_PrivateKey
*/
int wolfSSL_use_PrivateKey_ASN1(int pri, WOLFSSL* ssl,
unsigned char* der, long derSz);
const unsigned char* der, long derSz);
/*!
\ingroup CertsKeys
@@ -14071,7 +14071,7 @@ int wolfSSL_request_certificate(WOLFSSL* ssl);
\sa wolfSSL_UseKeyShare
\sa wolfSSL_preferred_group
*/
int wolfSSL_CTX_set1_groups_list(WOLFSSL_CTX *ctx, char *list);
int wolfSSL_CTX_set1_groups_list(WOLFSSL_CTX *ctx, const char *list);
/*!
\ingroup Setup
@@ -14109,7 +14109,7 @@ int wolfSSL_CTX_set1_groups_list(WOLFSSL_CTX *ctx, char *list);
\sa wolfSSL_UseKeyShare
\sa wolfSSL_preferred_group
*/
int wolfSSL_set1_groups_list(WOLFSSL *ssl, char *list);
int wolfSSL_set1_groups_list(WOLFSSL *ssl, const char *list);
/*!
\ingroup TLS
@@ -14284,7 +14284,7 @@ int wolfSSL_set_groups(WOLFSSL* ssl, int* groups, int count);
\sa wolfSSL_accept_TLSv13
\sa wolfSSL_accept
*/
int wolfSSL_connect_TLSv13(WOLFSSL*);
int wolfSSL_connect_TLSv13(WOLFSSL* ssl);
/*!
\ingroup IO
@@ -15023,8 +15023,8 @@ int wolfSSL_get_ephemeral_key(WOLFSSL* ssl, int keyAlgo,
\param padding Padding to use. Only RSA_PKCS1_PSS_PADDING and
RSA_PKCS1_PADDING are currently supported for signing.
*/
int wolfSSL_RSA_sign_generic_padding(int type, const unsigned char* m,
unsigned int mLen, unsigned char* sigRet,
int wolfSSL_RSA_sign_generic_padding(int hashAlg, const unsigned char* hash,
unsigned int hLen, unsigned char* sigRet,
unsigned int* sigLen, WOLFSSL_RSA* rsa,
int flag, int padding);
/*!
@@ -15066,8 +15066,11 @@ unsigned int wolfSSL_SESSION_get_max_early_data(const WOLFSSL_SESSION *s);
\return The new index value to be used with the external data API for this
object class.
*/
int wolfSSL_CRYPTO_get_ex_new_index(int, void*, void*, void*, void*);
*/
int wolfSSL_CRYPTO_get_ex_new_index(int class_index, long argl, void *argp,
WOLFSSL_CRYPTO_EX_new* new_func,
WOLFSSL_CRYPTO_EX_dup* dup_func,
WOLFSSL_CRYPTO_EX_free* free_func);
/*!
\ingroup Setup

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

@@ -115,7 +115,7 @@ int EmbedSend(WOLFSSL* ssl, char* buf, int sz, void* ctx);
\sa wolfSSL_SSLSetIORecv
\sa wolfSSL_dtls_get_current_timeout
*/
int EmbedReceiveFrom(WOLFSSL* ssl, char* buf, int sz, void*);
int EmbedReceiveFrom(WOLFSSL *ssl, char *buf, int sz, void *ctx);
/*!
\brief This function is the send embedded callback.
@@ -189,8 +189,8 @@ int EmbedSendTo(WOLFSSL* ssl, char* buf, int sz, void* ctx);
\sa wolfSSL_CTX_SetGenCookie
*/
int EmbedGenerateCookie(WOLFSSL* ssl, unsigned char* buf,
int sz, void*);
int EmbedGenerateCookie(WOLFSSL* ssl, byte *buf,
int sz, void *ctx);
/*!
\brief This function frees the response buffer.