yuzu-emu/mbedtls
1
0
Fork 0
mirror of https://github.com/yuzu-emu/mbedtls.git synced 2024-11-22 21:25:38 +01:00
Code Issues Packages Projects Releases Wiki Activity

Further documentation improvements

Browse Source 
Signed-off-by: Paul Elliott <paul.elliott@arm.com>
This commit is contained in:
Paul Elliott 2021-11-18 12:39:10 +00:00
parent f294ff5d87
commit a59cc3dbc7
1 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
include/mbedtls/pkcs12.h
View File

@ -80,12 +80,12 @@ int mbedtls_pkcs12_pbe_sha1_rc4_128( mbedtls_asn1_buf *pbe_params, int mode,
* for cipher-based and mbedtls_md-based PBE's * for cipher-based and mbedtls_md-based PBE's
* *
* \param pbe_params an ASN1 buffer containing the pkcs-12 PbeParams structure * \param pbe_params an ASN1 buffer containing the pkcs-12 PbeParams structure
* \param mode either MBEDTLS_PKCS12_PBE_ENCRYPT or * \param mode either #MBEDTLS_PKCS12_PBE_ENCRYPT or
* MBEDTLS_PKCS12_PBE_DECRYPT * #MBEDTLS_PKCS12_PBE_DECRYPT
* \param cipher_type the cipher used * \param cipher_type the cipher used
* \param md_type the mbedtls_md used * \param md_type the mbedtls_md used
* \param pwd Latin1-encoded password used (may be NULL if no password is * \param pwd Latin1-encoded password used. This may only be \c NULL when
* used, but not if pwdlen is non-zero) * pwdlen is 0. No \c NULL terminator should be used.
* \param pwdlen length of the password (may be 0) * \param pwdlen length of the password (may be 0)
* \param input the input data * \param input the input data
* \param len data length * \param len data length
@ -106,20 +106,24 @@ int mbedtls_pkcs12_pbe( mbedtls_asn1_buf *pbe_params, int mode,
* to produce pseudo-random bits for a particular "purpose". * to produce pseudo-random bits for a particular "purpose".
* *
* Depending on the given id, this function can produce an * Depending on the given id, this function can produce an
* encryption/decryption key, an nitialization vector or an * encryption/decryption key, an initialization vector or an
* integrity key. * integrity key.
* *
* \param data buffer to store the derived data in * \param data buffer to store the derived data in
* \param datalen length of buffer to fill * \param datalen length of buffer to fill
* \param pwd Null terminated BMPString password to use (may be NULL if * \param pwd The password to use. For compliance with PKCS#12 §B.1, this
* no password is used, but not if pwdlen is non-zero) * should be a BMPString, i.e. a Unicode string where each
* \param pwdlen length of the password (may be 0) * character is encoded as 2 bytes in big-endian order, with
* \param salt salt buffer to use * no byte order mark and with a null terminator (i.e. the
* \param saltlen length of the salt * last two bytes should be 0x00 0x00).
* \param pwdlen length of the password (may be 0).
* \param salt Salt buffer to use This may only be \c NULL when
* saltlen is 0.
* \param saltlen length of the salt (may be zero)
* \param mbedtls_md mbedtls_md type to use during the derivation * \param mbedtls_md mbedtls_md type to use during the derivation
* \param id id that describes the purpose (can be * \param id id that describes the purpose (can be
* MBEDTLS_PKCS12_DERIVE_KEY, MBEDTLS_PKCS12_DERIVE_IV or * #MBEDTLS_PKCS12_DERIVE_KEY, #MBEDTLS_PKCS12_DERIVE_IV or
* MBEDTLS_PKCS12_DERIVE_MAC_KEY) * #MBEDTLS_PKCS12_DERIVE_MAC_KEY)
* \param iterations number of iterations * \param iterations number of iterations
* *
* \return 0 if successful, or a MD, BIGNUM type error. * \return 0 if successful, or a MD, BIGNUM type error.