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

Minor documentation fixes

Browse Source
This commit is contained in:
Gilles Peskine 2018-03-03 21:29:30 +01:00 committed by itayzafrir
parent 3b555710e2
commit 92b3073e36
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
include/psa/crypto.h
View File

@ -360,7 +360,7 @@ psa_status_t psa_get_key_information(psa_key_slot_t key,
* If a key is created with psa_import_key() and then exported with * If a key is created with psa_import_key() and then exported with
* this function, it is not guaranteed that the resulting data is * this function, it is not guaranteed that the resulting data is
* identical: the implementation may choose a different representation * identical: the implementation may choose a different representation
* of the same key. * of the same key if the format permits it.
* *
* For standard key types, the output format is as follows: * For standard key types, the output format is as follows:
* *
@ -370,7 +370,7 @@ psa_status_t psa_get_key_information(psa_key_slot_t key,
* correct. * correct.
* - For Triple-DES, the format is the concatenation of the * - For Triple-DES, the format is the concatenation of the
* two or three DES keys. * two or three DES keys.
* - For RSA key pairs keys (#PSA_KEY_TYPE_RSA_KEYPAIR), the format * - For RSA key pairs (#PSA_KEY_TYPE_RSA_KEYPAIR), the format
* is the non-encrypted DER representation defined by PKCS\#8 (RFC 5208) * is the non-encrypted DER representation defined by PKCS\#8 (RFC 5208)
* as PrivateKeyInfo. * as PrivateKeyInfo.
* - For RSA public keys (#PSA_KEY_TYPE_RSA_PUBLIC_KEY), the format * - For RSA public keys (#PSA_KEY_TYPE_RSA_PUBLIC_KEY), the format
@ -385,6 +385,7 @@ psa_status_t psa_get_key_information(psa_key_slot_t key,
* *
* \retval PSA_SUCCESS * \retval PSA_SUCCESS
* \retval PSA_ERROR_EMPTY_SLOT * \retval PSA_ERROR_EMPTY_SLOT
* \retval PSA_ERROR_NOT_PERMITTED
* \retval PSA_ERROR_COMMUNICATION_FAILURE * \retval PSA_ERROR_COMMUNICATION_FAILURE
* \retval PSA_ERROR_HARDWARE_FAILURE * \retval PSA_ERROR_HARDWARE_FAILURE
* \retval PSA_ERROR_TAMPERING_DETECTED * \retval PSA_ERROR_TAMPERING_DETECTED
@ -403,7 +404,7 @@ psa_status_t psa_export_key(psa_key_slot_t key,
/** The type of the state data structure for multipart hash operations. /** The type of the state data structure for multipart hash operations.
* *
* This is an implementation-define \c struct. Applications should not * This is an implementation-defined \c struct. Applications should not
* make any assumptions about the content of this structure except * make any assumptions about the content of this structure except
* as directed by the documentation of a specific implementation. */ * as directed by the documentation of a specific implementation. */
typedef struct psa_hash_operation_s psa_hash_operation_t; typedef struct psa_hash_operation_s psa_hash_operation_t;
@ -609,7 +610,7 @@ psa_status_t psa_hash_abort(psa_hash_operation_t *operation);
/** The type of the state data structure for multipart MAC operations. /** The type of the state data structure for multipart MAC operations.
* *
* This is an implementation-define \c struct. Applications should not * This is an implementation-defined \c struct. Applications should not
* make any assumptions about the content of this structure except * make any assumptions about the content of this structure except
* as directed by the documentation of a specific implementation. */ * as directed by the documentation of a specific implementation. */
typedef struct psa_mac_operation_s psa_mac_operation_t; typedef struct psa_mac_operation_s psa_mac_operation_t;
@ -661,6 +662,7 @@ typedef struct psa_mac_operation_s psa_mac_operation_t;
* \retval PSA_SUCCESS * \retval PSA_SUCCESS
* Success. * Success.
* \retval PSA_ERROR_EMPTY_SLOT * \retval PSA_ERROR_EMPTY_SLOT
* \retval PSA_ERROR_NOT_PERMITTED
* \retval PSA_ERROR_INVALID_ARGUMENT * \retval PSA_ERROR_INVALID_ARGUMENT
* \c key is not compatible with \c alg. * \c key is not compatible with \c alg.
* \retval PSA_ERROR_NOT_SUPPORTED * \retval PSA_ERROR_NOT_SUPPORTED