Skip to content

Ed448: check for public key presence on export #10656

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dgarske merged 8 commits into from
Jun 12, 2026
Merged

Ed448: check for public key presence on export #10656

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3d51784
Ed448: check for public key presence on export
holtrop-wolfssl Jun 10, 2026
6270029
Fix wc_Ed25519PublicKeyToDer doxygen documentation
holtrop-wolfssl Jun 12, 2026
92500e7
Preserve Ed25519/448 PublicKeyToDer unit testing for BUFFER_E
holtrop-wolfssl Jun 12, 2026
2914a85
Document PUBLIC_KEY_E error return from wc_edXXX_export_key()
holtrop-wolfssl Jun 12, 2026
955ffb9
Free RNG from updated Ed448/Ed25519 unit tests
holtrop-wolfssl Jun 12, 2026
daa22e9
Document PUBLIC_KEY_E return for wc_ed448_export_public()
holtrop-wolfssl Jun 12, 2026
8c1e3a2
Fix Ed448/25519 export private-only key unit tests for FIPS pre-v7
holtrop-wolfssl Jun 12, 2026
445b8b2
Document PUBLIC_KEY_E return value for wc_ed448_export_public() in so…
holtrop-wolfssl Jun 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 40 additions & 39 deletions doc/dox_comments/header_files/asn_public.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1999,7 +1999,7 @@ int wc_DsaParamsDecode(const byte* input, word32* inOutIdx,

\param key DSA key structure with parameters
\param output Buffer for DER encoded parameters
\param inLen Size of output buffer
\param outLen Size of output buffer
Comment thread
dgarske marked this conversation as resolved.

_Example_
\code
Expand All @@ -2010,7 +2010,7 @@ int wc_DsaParamsDecode(const byte* input, word32* inOutIdx,

\sa wc_DsaParamsDecode
*/
int wc_DsaKeyToParamsDer(DsaKey* key, byte* output, word32 inLen);
int wc_DsaKeyToParamsDer(DsaKey* key, byte* output, word32 outLen);

/*!
\ingroup DSA
Expand All @@ -2021,7 +2021,7 @@ int wc_DsaKeyToParamsDer(DsaKey* key, byte* output, word32 inLen);

\param key DSA key structure with parameters
\param output Buffer for DER encoded parameters
\param inLen Pointer to buffer size (in/out)
\param outLen Pointer to buffer size (in/out)

_Example_
\code
Expand All @@ -2034,7 +2034,7 @@ int wc_DsaKeyToParamsDer(DsaKey* key, byte* output, word32 inLen);
\sa wc_DsaKeyToParamsDer
*/
int wc_DsaKeyToParamsDer_ex(DsaKey* key, byte* output,
word32* inLen);
word32* outLen);

/*!
\ingroup DH
Expand Down Expand Up @@ -2174,7 +2174,7 @@ int wc_EccPrivateKeyDecode(const byte* input, word32* inOutIdx,

\param key ECC key structure with private key
\param output Buffer for DER encoded private key
\param inLen Size of output buffer
\param outLen Size of output buffer

_Example_
\code
Expand All @@ -2186,7 +2186,7 @@ int wc_EccPrivateKeyDecode(const byte* input, word32* inOutIdx,
\sa wc_EccPrivateKeyDecode
*/
int wc_EccPrivateKeyToDer(ecc_key* key, byte* output,
word32 inLen);
word32 outLen);

/*!
\ingroup ECC
Expand Down Expand Up @@ -2217,7 +2217,7 @@ int wc_EccKeyDerSize(ecc_key* key, int pub);

\param key ECC key structure with private key
\param output Buffer for PKCS#8 encoded key
\param inLen Pointer to buffer size (in/out)
\param outLen Pointer to buffer size (in/out)

_Example_
\code
Expand All @@ -2230,7 +2230,7 @@ int wc_EccKeyDerSize(ecc_key* key, int pub);
\sa wc_EccPrivateKeyToDer
*/
int wc_EccPrivateKeyToPKCS8(ecc_key* key, byte* output,
word32* inLen);
word32* outLen);

/*!
\ingroup ECC
Expand All @@ -2241,7 +2241,7 @@ int wc_EccPrivateKeyToPKCS8(ecc_key* key, byte* output,

\param key ECC key structure with key pair
\param output Buffer for PKCS#8 encoded key
\param inLen Pointer to buffer size (in/out)
\param outLen Pointer to buffer size (in/out)

_Example_
\code
Expand All @@ -2254,7 +2254,7 @@ int wc_EccPrivateKeyToPKCS8(ecc_key* key, byte* output,
\sa wc_EccPrivateKeyToPKCS8
*/
int wc_EccKeyToPKCS8(ecc_key* key, byte* output,
word32* inLen);
word32* outLen);

/*!
\ingroup ECC
Expand Down Expand Up @@ -2283,7 +2283,7 @@ int wc_EccPublicKeyDerSize(ecc_key* key, int with_AlgCurve);

\return Success On successfully writing the ECC key to der format,
returns the length written to the buffer
\return BAD_FUNC_ARG Returned if key or output is null, or inLen equals zero
\return BAD_FUNC_ARG Returned if key or output is null, or outLen equals zero
\return MEMORY_E Returned if there is an error allocating memory
with XMALLOC
\return BUFFER_E Returned if the converted certificate is too large
Expand All @@ -2299,7 +2299,7 @@ int wc_EccPublicKeyDerSize(ecc_key* key, int with_AlgCurve);

\param key pointer to the buffer containing the input ecc key
\param output pointer to a buffer in which to store the der formatted key
\param inLen the length of the buffer in which to store the
\param outLen the length of the buffer in which to store the
der formatted key

_Example_
Expand All @@ -2318,7 +2318,7 @@ int wc_EccPublicKeyDerSize(ecc_key* key, int with_AlgCurve);

\sa wc_RsaKeyToDer
*/
int wc_EccKeyToDer(ecc_key* key, byte* output, word32 inLen);
int wc_EccKeyToDer(ecc_key* key, byte* output, word32 outLen);

/*!
\ingroup ASN
Expand Down Expand Up @@ -2370,7 +2370,7 @@ int wc_EccPublicKeyDecode(const byte* input, word32* inOutIdx,

\param key Pointer to ECC key
\param output Pointer to output buffer to write to.
\param inLen Size of buffer.
\param outLen Size of buffer.
\param with_AlgCurve a flag for when to include a header that has the
Algorithm and Curve information.

Expand All @@ -2394,7 +2394,7 @@ int wc_EccPublicKeyDecode(const byte* input, word32* inOutIdx,
\sa wc_EccPrivateKeyDecode
*/
int wc_EccPublicKeyToDer(ecc_key* key, byte* output,
word32 inLen, int with_AlgCurve);
word32 outLen, int with_AlgCurve);

/*!
\ingroup ASN
Expand All @@ -2412,7 +2412,7 @@ int wc_EccPublicKeyToDer(ecc_key* key, byte* output,

\param key Pointer to ECC key
\param output Pointer to output buffer to write to.
\param inLen Size of buffer.
\param outLen Size of buffer.
\param with_AlgCurve a flag for when to include a header that has the
Algorithm and Curve information.
\param comp If 1 (non-zero) the ECC public key will be written in
Expand All @@ -2439,7 +2439,7 @@ int wc_EccPublicKeyToDer(ecc_key* key, byte* output,
\sa wc_EccPublicKeyDecode
*/
int wc_EccPublicKeyToDer_ex(ecc_key* key, byte* output,
word32 inLen, int with_AlgCurve, int comp);
word32 outLen, int with_AlgCurve, int comp);


/*!
Expand Down Expand Up @@ -2571,7 +2571,7 @@ int wc_Curve25519KeyDecode(const byte* input, word32* inOutIdx,
\param key Pointer to curve25519_key structure containing private key to
encode
\param output Buffer to hold DER encoding
\param inLen Size of output buffer
\param outLen Size of output buffer

\sa wc_Curve25519KeyToDer
\sa wc_Curve25519PublicKeyToDer
Expand All @@ -2587,7 +2587,7 @@ int wc_Curve25519KeyDecode(const byte* input, word32* inOutIdx,
\endcode
*/
int wc_Curve25519PrivateKeyToDer(curve25519_key* key, byte* output,
word32 inLen);
word32 outLen);

/*!
\ingroup ASN
Expand All @@ -2603,7 +2603,7 @@ int wc_Curve25519PrivateKeyToDer(curve25519_key* key, byte* output,
\param key Pointer to curve25519_key structure containing public key to
encode
\param output Buffer to hold DER encoding
\param inLen Size of output buffer
\param outLen Size of output buffer
\param withAlg Whether to include algorithm identifier in the DER encoding

\sa wc_Curve25519KeyToDer
Expand All @@ -2619,7 +2619,7 @@ int wc_Curve25519PrivateKeyToDer(curve25519_key* key, byte* output,
wc_Curve25519PublicKeyToDer(&key, der, derSz, 1);
\endcode
*/
int wc_Curve25519PublicKeyToDer(curve25519_key* key, byte* output, word32 inLen,
int wc_Curve25519PublicKeyToDer(curve25519_key* key, byte* output, word32 outLen,
int withAlg);

/*!
Expand All @@ -2635,7 +2635,7 @@ int wc_Curve25519PublicKeyToDer(curve25519_key* key, byte* output, word32 inLen,

\param key Pointer to curve25519_key structure containing key to encode
\param output Buffer to hold DER encoding
\param inLen Size of output buffer
\param outLen Size of output buffer
\param withAlg Whether to include algorithm identifier in the DER encoding

\sa wc_Curve25519PrivateKeyToDer
Expand All @@ -2651,7 +2651,7 @@ int wc_Curve25519PublicKeyToDer(curve25519_key* key, byte* output, word32 inLen,
wc_Curve25519KeyToDer(&key, der, derSz, 1);
\endcode
*/
int wc_Curve25519KeyToDer(curve25519_key* key, byte* output, word32 inLen,
int wc_Curve25519KeyToDer(curve25519_key* key, byte* output, word32 outLen,
int withAlg);

/*!
Expand Down Expand Up @@ -2713,7 +2713,7 @@ int wc_Ed25519PublicKeyDecode(const byte* input, word32* inOutIdx,

\param key Ed25519 key structure
\param output Buffer for DER encoded key
\param inLen Size of output buffer
\param outLen Size of output buffer

_Example_
\code
Expand All @@ -2725,7 +2725,7 @@ int wc_Ed25519PublicKeyDecode(const byte* input, word32* inOutIdx,
\sa wc_Ed25519PrivateKeyToDer
*/
int wc_Ed25519KeyToDer(const ed25519_key* key, byte* output,
word32 inLen);
word32 outLen);

/*!
\ingroup Ed25519
Expand All @@ -2736,7 +2736,7 @@ int wc_Ed25519KeyToDer(const ed25519_key* key, byte* output,

\param key Ed25519 key structure with private key
\param output Buffer for DER encoded private key
\param inLen Size of output buffer
\param outLen Size of output buffer

_Example_
\code
Expand All @@ -2749,7 +2749,7 @@ int wc_Ed25519KeyToDer(const ed25519_key* key, byte* output,
\sa wc_Ed25519PrivateKeyDecode
*/
int wc_Ed25519PrivateKeyToDer(const ed25519_key* key, byte* output,
word32 inLen);
word32 outLen);

/*!
\ingroup Ed25519
Expand All @@ -2760,7 +2760,8 @@ int wc_Ed25519PrivateKeyToDer(const ed25519_key* key, byte* output,

\param key Ed25519 key structure with public key
\param output Buffer for DER encoded public key
\param inLen Size of output buffer
\param outLen Size of output buffer
\param withAlg Whether to use SubjectPublicKeyInfo format.

_Example_
\code
Expand All @@ -2773,7 +2774,7 @@ int wc_Ed25519PrivateKeyToDer(const ed25519_key* key, byte* output,
\sa wc_Ed25519PublicKeyDecode
*/
int wc_Ed25519PublicKeyToDer(const ed25519_key* key, byte* output,
int inLen);
word32 outLen, int withAlg);

/*!
\ingroup Ed448
Expand Down Expand Up @@ -2834,7 +2835,7 @@ int wc_Ed448PublicKeyDecode(const byte* input, word32* inOutIdx,

\param key Ed448 key structure
\param output Buffer for DER encoded key
\param inLen Size of output buffer
\param outLen Size of output buffer

_Example_
\code
Expand All @@ -2845,7 +2846,7 @@ int wc_Ed448PublicKeyDecode(const byte* input, word32* inOutIdx,

\sa wc_Ed448PrivateKeyToDer
*/
int wc_Ed448KeyToDer(const ed448_key* key, byte* output, word32 inLen);
int wc_Ed448KeyToDer(const ed448_key* key, byte* output, word32 outLen);

/*!
\ingroup Ed448
Expand All @@ -2856,7 +2857,7 @@ int wc_Ed448KeyToDer(const ed448_key* key, byte* output, word32 inLen);

\param key Ed448 key structure with private key
\param output Buffer for DER encoded private key
\param inLen Size of output buffer
\param outLen Size of output buffer

_Example_
\code
Expand All @@ -2869,7 +2870,7 @@ int wc_Ed448KeyToDer(const ed448_key* key, byte* output, word32 inLen);
\sa wc_Ed448PrivateKeyDecode
*/
int wc_Ed448PrivateKeyToDer(const ed448_key* key, byte* output,
word32 inLen);
word32 outLen);

/*!
\ingroup Ed448
Expand All @@ -2880,7 +2881,7 @@ int wc_Ed448PrivateKeyToDer(const ed448_key* key, byte* output,

\param key Ed448 key structure with public key
\param output Buffer for DER encoded public key
\param inLen Size of output buffer
\param outLen Size of output buffer
\param withAlg 1 to include algorithm identifier, 0 for key data only

_Example_
Expand All @@ -2894,7 +2895,7 @@ int wc_Ed448PrivateKeyToDer(const ed448_key* key, byte* output,
\sa wc_Ed448PublicKeyDecode
*/
int wc_Ed448PublicKeyToDer(const ed448_key* key, byte* output,
word32 inLen, int withAlg);
word32 outLen, int withAlg);

/*!
\ingroup Curve448
Expand Down Expand Up @@ -2955,7 +2956,7 @@ int wc_Curve448PublicKeyDecode(const byte* input, word32* inOutIdx,

\param key Curve448 key structure with private key
\param output Buffer for DER encoded private key
\param inLen Size of output buffer
\param outLen Size of output buffer

_Example_
\code
Expand All @@ -2968,7 +2969,7 @@ int wc_Curve448PublicKeyDecode(const byte* input, word32* inOutIdx,
\sa wc_Curve448PrivateKeyDecode
*/
int wc_Curve448PrivateKeyToDer(curve448_key* key, byte* output,
word32 inLen);
word32 outLen);

/*!
\ingroup Curve448
Expand All @@ -2979,7 +2980,7 @@ int wc_Curve448PrivateKeyToDer(curve448_key* key, byte* output,

\param key Curve448 key structure with public key
\param output Buffer for DER encoded public key
\param inLen Size of output buffer
\param outLen Size of output buffer

_Example_
\code
Expand All @@ -2992,7 +2993,7 @@ int wc_Curve448PrivateKeyToDer(curve448_key* key, byte* output,
\sa wc_Curve448PublicKeyDecode
*/
int wc_Curve448PublicKeyToDer(curve448_key* key, byte* output,
word32 inLen);
word32 outLen);

/*!
\ingroup ASN
Expand Down
10 changes: 5 additions & 5 deletions doc/dox_comments/header_files/dsa.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ int wc_DsaPrivateKeyDecode(const byte* input, word32* inOutIdx,
/*!
\ingroup DSA

\brief Convert DsaKey key to DER format, write to output (inLen),
\brief Convert DsaKey key to DER format, write to output (outLen),
return bytes written.

\return outLen Success, number of bytes written
Expand All @@ -306,7 +306,7 @@ int wc_DsaPrivateKeyDecode(const byte* input, word32* inOutIdx,

\param key Pointer to DsaKey structure to convert.
\param output Pointer to output buffer for converted key.
\param inLen Length of key input.
\param outLen Length of output buffer.

_Example_
\code
Expand All @@ -326,7 +326,7 @@ int wc_DsaPrivateKeyDecode(const byte* input, word32* inOutIdx,
\sa wc_FreeDsaKey
\sa wc_MakeDsaKey
*/
int wc_DsaKeyToDer(DsaKey* key, byte* output, word32 inLen);
int wc_DsaKeyToDer(DsaKey* key, byte* output, word32 outLen);

/*!
\ingroup DSA
Expand Down Expand Up @@ -496,7 +496,7 @@ int wc_SetDsaPublicKey(byte* output, DsaKey* key, int outLen,

\param key DSA key
\param output Output buffer
\param inLen Output buffer length
\param outLen Output buffer length

_Example_
\code
Expand All @@ -523,7 +523,7 @@ int wc_SetDsaPublicKey(byte* output, DsaKey* key, int outLen,

\sa wc_SetDsaPublicKey
*/
int wc_DsaKeyToPublicDer(DsaKey* key, byte* output, word32 inLen);
int wc_DsaKeyToPublicDer(DsaKey* key, byte* output, word32 outLen);

/*!
\ingroup DSA
Expand Down
Loading
Loading