PSA PAKE: Align macro names with psa_pake_step_t

Signed-off-by: Janos Follath <janos.follath@arm.com>
This commit is contained in:
Janos Follath 2021-05-13 12:01:11 +01:00
parent 3c09c47333
commit 56cc9ccc39
2 changed files with 24 additions and 24 deletions

View file

@ -4273,9 +4273,9 @@ static psa_pake_operation_t psa_pake_operation_init(void);
*
* A typical sequence of calls to perform a password-authenticated key
* exchange:
* -# Call psa_pake_output(operation, #PSA_PAKE_DATA_KEY_SHARE, ...) to get the
* -# Call psa_pake_output(operation, #PSA_PAKE_STEP_KEY_SHARE, ...) to get the
* key share that needs to be sent to the peer.
* -# Call psa_pake_input(operation, #PSA_PAKE_DATA_KEY_SHARE, ...) to provide
* -# Call psa_pake_input(operation, #PSA_PAKE_STEP_KEY_SHARE, ...) to provide
* the key share that was received from the peer.
* -# Call psa_pake_get_implicit_key() for accessing the shared secret.
* -# Make a sequence of function calls to execute the password-authenticated

View file

@ -1993,52 +1993,52 @@
* The key exchange flow for JPAKE is as follows:
* -# To get the first round data that needs to be sent to the peer, call
* // Get g1
* psa_pake_output(operation, #PSA_PAKE_DATA_KEY_SHARE, ...);
* psa_pake_output(operation, #PSA_PAKE_STEP_KEY_SHARE, ...);
* // Get the ZKP public key for x1
* psa_pake_output(operation, #PSA_PAKE_DATA_ZK_PUBLIC, ...);
* psa_pake_output(operation, #PSA_PAKE_STEP_ZK_PUBLIC, ...);
* // Get the ZKP proof for x1
* psa_pake_output(operation, #PSA_PAKE_DATA_ZK_PROOF, ...);
* psa_pake_output(operation, #PSA_PAKE_STEP_ZK_PROOF, ...);
* // Get g2
* psa_pake_output(operation, #PSA_PAKE_DATA_KEY_SHARE, ...);
* psa_pake_output(operation, #PSA_PAKE_STEP_KEY_SHARE, ...);
* // Get the ZKP public key for x2
* psa_pake_output(operation, #PSA_PAKE_DATA_ZK_PUBLIC, ...);
* psa_pake_output(operation, #PSA_PAKE_STEP_ZK_PUBLIC, ...);
* // Get the ZKP proof for x2
* psa_pake_output(operation, #PSA_PAKE_DATA_ZK_PROOF, ...);
* psa_pake_output(operation, #PSA_PAKE_STEP_ZK_PROOF, ...);
* -# To provide the first round data received from the peer to the operation,
* call
* // Set g3
* psa_pake_input(operation, #PSA_PAKE_DATA_KEY_SHARE, ...);
* psa_pake_input(operation, #PSA_PAKE_STEP_KEY_SHARE, ...);
* // Set the ZKP public key for x3
* psa_pake_input(operation, #PSA_PAKE_DATA_ZK_PUBLIC, ...);
* psa_pake_input(operation, #PSA_PAKE_STEP_ZK_PUBLIC, ...);
* // Set the ZKP proof for x3
* psa_pake_input(operation, #PSA_PAKE_DATA_ZK_PROOF, ...);
* psa_pake_input(operation, #PSA_PAKE_STEP_ZK_PROOF, ...);
* // Set g4
* psa_pake_input(operation, #PSA_PAKE_DATA_KEY_SHARE, ...);
* psa_pake_input(operation, #PSA_PAKE_STEP_KEY_SHARE, ...);
* // Set the ZKP public key for x4
* psa_pake_input(operation, #PSA_PAKE_DATA_ZK_PUBLIC, ...);
* psa_pake_input(operation, #PSA_PAKE_STEP_ZK_PUBLIC, ...);
* // Set the ZKP proof for x4
* psa_pake_input(operation, #PSA_PAKE_DATA_ZK_PROOF, ...);
* psa_pake_input(operation, #PSA_PAKE_STEP_ZK_PROOF, ...);
* -# To get the second round data that needs to be sent to the peer, call
* // Get A
* psa_pake_output(operation, #PSA_PAKE_DATA_KEY_SHARE, ...);
* psa_pake_output(operation, #PSA_PAKE_STEP_KEY_SHARE, ...);
* // Get ZKP public key for x2*s
* psa_pake_output(operation, #PSA_PAKE_DATA_ZK_PUBLIC, ...);
* psa_pake_output(operation, #PSA_PAKE_STEP_ZK_PUBLIC, ...);
* // Get ZKP proof for x2*s
* psa_pake_output(operation, #PSA_PAKE_DATA_ZK_PROOF, ...);
* psa_pake_output(operation, #PSA_PAKE_STEP_ZK_PROOF, ...);
* -# To provide the second round data received from the peer to the operation,
* call
* // Set B
* psa_pake_input(operation, #PSA_PAKE_DATA_KEY_SHARE, ...);
* psa_pake_input(operation, #PSA_PAKE_STEP_KEY_SHARE, ...);
* // Set ZKP public key for x4*s
* psa_pake_input(operation, #PSA_PAKE_DATA_ZK_PUBLIC, ...);
* psa_pake_input(operation, #PSA_PAKE_STEP_ZK_PUBLIC, ...);
* // Set ZKP proof for x4*s
* psa_pake_input(operation, #PSA_PAKE_DATA_ZK_PROOF, ...);
* psa_pake_input(operation, #PSA_PAKE_STEP_ZK_PROOF, ...);
* -# To access the shared secret call
* // Get Ka=Kb=K
* psa_pake_get_implicit_key()
*
* For more information consult the documentation of the individual
* PSA_PAKE_DATA_XXX constants.
* PSA_PAKE_STEP_XXX constants.
*
* J-PAKE is standardised for example in RFC 8236.
*/
@ -2578,7 +2578,7 @@ static inline int mbedtls_svc_key_id_is_null( mbedtls_svc_key_id_t key )
* For information regarding representation consult the documentation of
* individual ::psa_pake_primitive_type_t constants.
*/
#define PSA_PAKE_DATA_KEY_SHARE ((psa_pake_step_t)0x01)
#define PSA_PAKE_STEP_KEY_SHARE ((psa_pake_step_t)0x01)
/** A Schnorr NIZKP public key.
*
@ -2587,7 +2587,7 @@ static inline int mbedtls_svc_key_id_is_null( mbedtls_svc_key_id_t key )
* For information regarding representation consult the documentation of
* individual ::psa_pake_primitive_type_t constants.
*/
#define PSA_PAKE_DATA_ZK_PUBLIC ((psa_pake_step_t)0x02)
#define PSA_PAKE_STEP_ZK_PUBLIC ((psa_pake_step_t)0x02)
/** A Schnorr NIZKP proof.
*
@ -2596,7 +2596,7 @@ static inline int mbedtls_svc_key_id_is_null( mbedtls_svc_key_id_t key )
* For information regarding representation consult the documentation of
* individual ::psa_pake_primitive_type_t constants.
*/
#define PSA_PAKE_DATA_ZK_PROOF ((psa_pake_step_t)0x03)
#define PSA_PAKE_STEP_ZK_PROOF ((psa_pake_step_t)0x03)
/**@}*/
#endif /* PSA_CRYPTO_VALUES_H */