From 1975508b01244f80caa7338cbad852b08ae3344b Mon Sep 17 00:00:00 2001 From: Andrew Thoelke Date: Fri, 3 Nov 2023 18:12:46 +0000 Subject: [PATCH] Fixed the return type to psa_pake_cs_get_hash() --- doc/ext-pake/api.db/psa/crypto-pake.h | 4 ++-- doc/ext-pake/api/pake.rst | 2 +- doc/ext-pake/appendix/history.rst | 5 +++-- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/ext-pake/api.db/psa/crypto-pake.h b/doc/ext-pake/api.db/psa/crypto-pake.h index d27bce00..f6ea3f5a 100644 --- a/doc/ext-pake/api.db/psa/crypto-pake.h +++ b/doc/ext-pake/api.db/psa/crypto-pake.h @@ -1,4 +1,4 @@ -// SPDX-FileCopyrightText: Copyright 2018-2022 Arm Limited and/or its affiliates +// SPDX-FileCopyrightText: Copyright 2018-2023 Arm Limited and/or its affiliates // SPDX-License-Identifier: Apache-2.0 typedef /* implementation-defined type */ psa_pake_cipher_suite_t; @@ -33,7 +33,7 @@ typedef uint8_t psa_pake_step_t; psa_status_t psa_pake_abort(psa_pake_operation_t * operation); psa_pake_cipher_suite_t psa_pake_cipher_suite_init(void); psa_algorithm_t psa_pake_cs_get_algorithm(const psa_pake_cipher_suite_t* cipher_suite); -psa_pake_primitive_t psa_pake_cs_get_hash(const psa_pake_cipher_suite_t* cipher_suite); +psa_algorithm_t psa_pake_cs_get_hash(const psa_pake_cipher_suite_t* cipher_suite); psa_pake_primitive_t psa_pake_cs_get_primitive(const psa_pake_cipher_suite_t* cipher_suite); void psa_pake_cs_set_algorithm(psa_pake_cipher_suite_t* cipher_suite, psa_algorithm_t alg); diff --git a/doc/ext-pake/api/pake.rst b/doc/ext-pake/api/pake.rst index 79f23ecb..ad00d0ce 100644 --- a/doc/ext-pake/api/pake.rst +++ b/doc/ext-pake/api/pake.rst @@ -504,7 +504,7 @@ A PAKE cipher suite is required when setting up a PAKE operation in `psa_pake_se .. param:: const psa_pake_cipher_suite_t* cipher_suite The cipher suite object to query. - .. return:: psa_pake_primitive_t + .. return:: psa_algorithm_t The hash algorithm stored in the cipher suite object. The return value is :code:`PSA_ALG_NONE` if the PAKE is not parametrized by a hash algorithm, or if the hash algorithm is not set. diff --git a/doc/ext-pake/appendix/history.rst b/doc/ext-pake/appendix/history.rst index d90e278b..cf9df6f7 100644 --- a/doc/ext-pake/appendix/history.rst +++ b/doc/ext-pake/appendix/history.rst @@ -14,10 +14,11 @@ This section provides the detailed changes made between published version of the Changes between *Beta 1* and *Beta 2* ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Clarifications -~~~~~~~~~~~~~~ +Clarifications and bug fixes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Clarified the behavior of the PAKE operation following a call to `psa_pake_setup()`. +* Fixed the return type to `psa_pake_cs_get_hash()`. Changes between *Beta 0* and *Beta 1* ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^