Rename library/ecp_alt.h to ecp_internal_alt.h

library/ecp_alt.h (declaring individual functions of the ECP module that can
be substituted, included when building the library with
MBEDTLS_ECP_INTERNAL_ALT enabled) clashes with ecp_alt.h (not provided,
declaring types of the ECP module when the whole implementation is
substituted, included when building the library with MBEDTLS_ECP_ALT enabled).
Depending on the search path during build, this can make MBEDTLS_ECP_ALT
unusable.

Rename library/ecp_alt.h to follow the naming convention of other alt headers:
MBEDTLS_XXX_ALT corresponds to xxx_alt.h.

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine 2021-05-24 22:25:04 +02:00
parent b9ccb25f33
commit 6a2fb61896
4 changed files with 5 additions and 5 deletions

View file

@ -22,7 +22,7 @@ API changes
Various helpers and definitions available for use in alt implementations Various helpers and definitions available for use in alt implementations
have been moved out of the include/ directory and into the library/ have been moved out of the include/ directory and into the library/
directory. The files concerned are ecp_internal.h and rsa_internal.h directory. The files concerned are ecp_internal.h and rsa_internal.h
which have also been renamed to ecp_alt.h and rsa_alt_helpers.h which have also been renamed to ecp_internal_alt.h and rsa_alt_helpers.h
respectively. respectively.
* Move internal headers. * Move internal headers.
Header files that were only meant for the library's internal use and Header files that were only meant for the library's internal use and

View file

@ -59,7 +59,7 @@ were documented as internal, despite being in the public include directory.
If you're providing alt implementations of ECP or RSA, you'll need to add our If you're providing alt implementations of ECP or RSA, you'll need to add our
`library` directory to your include path when building your alt `library` directory to your include path when building your alt
implementations, and note that `ecp_internal.h` and `rsa_internal.h` have been implementations, and note that `ecp_internal.h` and `rsa_internal.h` have been
renamed to `ecp_alt.h` and `rsa_alt_helpers.h` respectively. renamed to `ecp_internal_alt.h` and `rsa_alt_helpers.h` respectively.
If you're a library user and used to rely on having access to a structure or If you're a library user and used to rely on having access to a structure or
function that's now in a private header, please reach out on the mailing list function that's now in a private header, please reach out on the mailing list

View file

@ -99,7 +99,7 @@
#define mbedtls_free free #define mbedtls_free free
#endif #endif
#include "ecp_alt.h" #include "ecp_internal_alt.h"
#if !defined(MBEDTLS_ECP_NO_INTERNAL_RNG) #if !defined(MBEDTLS_ECP_NO_INTERNAL_RNG)
#if defined(MBEDTLS_HMAC_DRBG_C) #if defined(MBEDTLS_HMAC_DRBG_C)

View file

@ -1,5 +1,5 @@
/** /**
* \file ecp_alt.h * \file ecp_internal_alt.h
* *
* \brief Function declarations for alternative implementation of elliptic curve * \brief Function declarations for alternative implementation of elliptic curve
* point arithmetic. * point arithmetic.
@ -293,5 +293,5 @@ int mbedtls_internal_ecp_normalize_mxz( const mbedtls_ecp_group *grp,
#endif /* MBEDTLS_ECP_INTERNAL_ALT */ #endif /* MBEDTLS_ECP_INTERNAL_ALT */
#endif /* ecp_alt.h */ #endif /* ecp_internal_alt.h */