mirrors/wolfssl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #2606 from kaleb-himes/DOCS_UPDATE_19_NOV_2019

Browse Source 
Add dox documentation for wc_ecc_make_key_ex
This commit is contained in:
David Garske 2019-12-18 13:49:57 -08:00 committed by GitHub
commit 031e78e103
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 61 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -52,6 +52,67 @@
WOLFSSL_API
int wc_ecc_make_key(WC_RNG* rng, int keysize, ecc_key* key);
/*!
\ingroup ECC
\brief This function generates a new ecc_key and stores it in key.
\return 0 Returned on success.
\return ECC_BAD_ARG_E Returned if rng or key evaluate to NULL
\return BAD_FUNC_ARG Returned if the specified key size is not in the
correct range of supported keys
\return MEMORY_E Returned if there is an error allocating memory while
computing the ecc key
\return MP_INIT_E may be returned if there is an error while computing
the ecc key
\return MP_READ_E may be returned if there is an error while computing
the ecc key
\return MP_CMP_E may be returned if there is an error while computing the
ecc key
\return MP_INVMOD_E may be returned if there is an error while computing
the ecc key
\return MP_EXPTMOD_E may be returned if there is an error while computing
the ecc key
\return MP_MOD_E may be returned if there is an error while computing the
ecc key
\return MP_MUL_E may be returned if there is an error while computing the
ecc key
\return MP_ADD_E may be returned if there is an error while computing the
ecc key
\return MP_MULMOD_E may be returned if there is an error while computing
the ecc key
\return MP_TO_E may be returned if there is an error while computing the
ecc key
\return MP_MEM may be returned if there is an error while computing the
ecc key
\param key Pointer to store the created key.
\param keysize size of key to be created in bytes, set based on curveId
\param rng Rng to be used in key creation
\param curve_id Curve to use for key
_Example_
\code
ecc_key key;
int ret;
WC_WC_RNG rng;
wc_ecc_init(&key);
wc_InitRng(&rng);
int curveId = ECC_SECP521R1;
int keySize = wc_ecc_get_curve_size_from_id(curveId);
ret = wc_ecc_make_key_ex(&rng, keySize, &key, curveId);
if (ret != MP_OKAY) {
// error handling
}
\endcode
\sa wc_ecc_make_key
\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);
/*!
\ingroup ECC