Skip to content

Commit 76d7bfe

Browse files
Terminology: consistently use "set up" for multipart operations
hash_setup and mac_setup used to be called hash_start and mac_start, but we've now converged on _setup as names. Finish making the terminology in the documentation consistent.
1 parent d6292ca commit 76d7bfe

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

include/psa/crypto.h

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -750,7 +750,7 @@ typedef struct psa_hash_operation_s psa_hash_operation_t;
750750
*/
751751
static psa_hash_operation_t psa_hash_operation_init(void);
752752

753-
/** Start a multipart hash operation.
753+
/** Set up a multipart hash operation.
754754
*
755755
* The sequence of operations to calculate a hash (message digest)
756756
* is as follows:
@@ -805,7 +805,7 @@ psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
805805
* \retval #PSA_SUCCESS
806806
* Success.
807807
* \retval #PSA_ERROR_BAD_STATE
808-
* The operation state is not valid (not started, or already completed).
808+
* The operation state is not valid (not set up, or already completed).
809809
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
810810
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
811811
* \retval #PSA_ERROR_HARDWARE_FAILURE
@@ -842,7 +842,7 @@ psa_status_t psa_hash_update(psa_hash_operation_t *operation,
842842
* \retval #PSA_SUCCESS
843843
* Success.
844844
* \retval #PSA_ERROR_BAD_STATE
845-
* The operation state is not valid (not started, or already completed).
845+
* The operation state is not valid (not set up, or already completed).
846846
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
847847
* The size of the \p hash buffer is too small. You can determine a
848848
* sufficient buffer size by calling #PSA_HASH_SIZE(\c alg)
@@ -882,7 +882,7 @@ psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
882882
* The hash of the message was calculated successfully, but it
883883
* differs from the expected hash.
884884
* \retval #PSA_ERROR_BAD_STATE
885-
* The operation state is not valid (not started, or already completed).
885+
* The operation state is not valid (not set up, or already completed).
886886
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
887887
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
888888
* \retval #PSA_ERROR_HARDWARE_FAILURE
@@ -973,7 +973,7 @@ typedef struct psa_mac_operation_s psa_mac_operation_t;
973973
*/
974974
static psa_mac_operation_t psa_mac_operation_init(void);
975975

976-
/** Start a multipart MAC calculation operation.
976+
/** Set up a multipart MAC calculation operation.
977977
*
978978
* This function sets up the calculation of the MAC
979979
* (message authentication code) of a byte string.
@@ -1031,7 +1031,7 @@ psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
10311031
psa_key_handle_t handle,
10321032
psa_algorithm_t alg);
10331033

1034-
/** Start a multipart MAC verification operation.
1034+
/** Set up a multipart MAC verification operation.
10351035
*
10361036
* This function sets up the verification of the MAC
10371037
* (message authentication code) of a byte string against an expected value.
@@ -1103,7 +1103,7 @@ psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
11031103
* \retval #PSA_SUCCESS
11041104
* Success.
11051105
* \retval #PSA_ERROR_BAD_STATE
1106-
* The operation state is not valid (not started, or already completed).
1106+
* The operation state is not valid (not set up, or already completed).
11071107
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
11081108
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
11091109
* \retval #PSA_ERROR_HARDWARE_FAILURE
@@ -1142,7 +1142,7 @@ psa_status_t psa_mac_update(psa_mac_operation_t *operation,
11421142
* \retval #PSA_SUCCESS
11431143
* Success.
11441144
* \retval #PSA_ERROR_BAD_STATE
1145-
* The operation state is not valid (not started, or already completed).
1145+
* The operation state is not valid (not set up, or already completed).
11461146
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
11471147
* The size of the \p mac buffer is too small. You can determine a
11481148
* sufficient buffer size by calling PSA_MAC_FINAL_SIZE().
@@ -1181,7 +1181,7 @@ psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
11811181
* The MAC of the message was calculated successfully, but it
11821182
* differs from the expected MAC.
11831183
* \retval #PSA_ERROR_BAD_STATE
1184-
* The operation state is not valid (not started, or already completed).
1184+
* The operation state is not valid (not set up, or already completed).
11851185
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
11861186
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
11871187
* \retval #PSA_ERROR_HARDWARE_FAILURE
@@ -1412,7 +1412,7 @@ psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
14121412
* \retval #PSA_SUCCESS
14131413
* Success.
14141414
* \retval #PSA_ERROR_BAD_STATE
1415-
* The operation state is not valid (not started, or IV already set).
1415+
* The operation state is not valid (not set up, or IV already set).
14161416
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
14171417
* The size of the \p iv buffer is too small.
14181418
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
@@ -1446,7 +1446,7 @@ psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
14461446
* \retval #PSA_SUCCESS
14471447
* Success.
14481448
* \retval #PSA_ERROR_BAD_STATE
1449-
* The operation state is not valid (not started, or IV already set).
1449+
* The operation state is not valid (not set up, or IV already set).
14501450
* \retval #PSA_ERROR_INVALID_ARGUMENT
14511451
* The size of \p iv is not acceptable for the chosen algorithm,
14521452
* or the chosen algorithm does not use an IV.
@@ -1482,7 +1482,7 @@ psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
14821482
* \retval #PSA_SUCCESS
14831483
* Success.
14841484
* \retval #PSA_ERROR_BAD_STATE
1485-
* The operation state is not valid (not started, IV required but
1485+
* The operation state is not valid (not set up, IV required but
14861486
* not set, or already completed).
14871487
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
14881488
* The size of the \p output buffer is too small.
@@ -1520,7 +1520,7 @@ psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
15201520
* \retval #PSA_SUCCESS
15211521
* Success.
15221522
* \retval #PSA_ERROR_BAD_STATE
1523-
* The operation state is not valid (not started, IV required but
1523+
* The operation state is not valid (not set up, IV required but
15241524
* not set, or already completed).
15251525
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
15261526
* The size of the \p output buffer is too small.

0 commit comments

Comments
 (0)