mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-02-03 20:54:00 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve doc of pk_parse_* functions

Browse Source
This commit is contained in:
Manuel Pégourié-Gonnard 2014-03-13 19:21:49 +01:00
parent fcf2fc2960
commit e3b3d19e5a
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
include/polarssl/pk.h
View File

@ -400,6 +400,12 @@ pk_type_t pk_get_type( const pk_context *ctx );
* \param pwd password for decryption (optional) * \param pwd password for decryption (optional)
* \param pwdlen size of the password * \param pwdlen size of the password
* *
* \note On entry, ctx must be empty, either freshly initialised
* with pk_init() or reset with pk_free(). If you need a
* specific key type, check the result with pk_can_do().
*
* \note The key is also checked for correctness.
*
* \return 0 if successful, or a specific PK or PEM error code * \return 0 if successful, or a specific PK or PEM error code
*/ */
int pk_parse_key( pk_context *ctx, int pk_parse_key( pk_context *ctx,
@ -414,6 +420,12 @@ int pk_parse_key( pk_context *ctx,
* \param key input buffer * \param key input buffer
* \param keylen size of the buffer * \param keylen size of the buffer
* *
* \note On entry, ctx must be empty, either freshly initialised
* with pk_init() or reset with pk_free(). If you need a
* specific key type, check the result with pk_can_do().
*
* \note The key is also checked for correctness.
*
* \return 0 if successful, or a specific PK or PEM error code * \return 0 if successful, or a specific PK or PEM error code
*/ */
int pk_parse_public_key( pk_context *ctx, int pk_parse_public_key( pk_context *ctx,
@ -428,6 +440,12 @@ int pk_parse_public_key( pk_context *ctx,
* \param path filename to read the private key from * \param path filename to read the private key from
* \param password password to decrypt the file (can be NULL) * \param password password to decrypt the file (can be NULL)
* *
* \note On entry, ctx must be empty, either freshly initialised
* with pk_init() or reset with pk_free(). If you need a
* specific key type, check the result with pk_can_do().
*
* \note The key is also checked for correctness.
*
* \return 0 if successful, or a specific PK or PEM error code * \return 0 if successful, or a specific PK or PEM error code
*/ */
int pk_parse_keyfile( pk_context *ctx, int pk_parse_keyfile( pk_context *ctx,
@ -440,6 +458,12 @@ int pk_parse_keyfile( pk_context *ctx,
* \param ctx key to be initialized * \param ctx key to be initialized
* \param path filename to read the private key from * \param path filename to read the private key from
* *
* \note On entry, ctx must be empty, either freshly initialised
* with pk_init() or reset with pk_free(). If you need a
* specific key type, check the result with pk_can_do().
*
* \note The key is also checked for correctness.
*
* \return 0 if successful, or a specific PK or PEM error code * \return 0 if successful, or a specific PK or PEM error code
*/ */
int pk_parse_public_keyfile( pk_context *ctx, const char *path ); int pk_parse_public_keyfile( pk_context *ctx, const char *path );