Skip to content

Document that raw ECC import does not validate the point #11099

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

Open
MarkAtwood wants to merge 1 commit into
base: master
Choose a base branch
from
+13 −1
Open

Document that raw ECC import does not validate the point #11099

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 13 additions & 1 deletion doc/dox_comments/header_files/ecc.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1453,7 +1453,11 @@ int wc_ecc_rs_to_sig(const char* r, const char* s, byte* out, word32* outlen);
\ingroup ECC

\brief This function fills an ecc_key structure with the raw components
of an ECC signature.
of an ECC key.

\note This function does not check that the imported public point lies on
the curve. Define WOLFSSL_VALIDATE_ECC_IMPORT to validate the point on
import, or call wc_ecc_check_key before the key is used.

\return 0 Returned upon successfully importing into the ecc_key structure
\return ECC_BAD_ARG_E Returned if any of the input values evaluate to NULL
Expand Down Expand Up @@ -3038,6 +3042,10 @@ int wc_ecc_sig_to_rs(const byte* sig, word32 sigLen, byte* r,
\ingroup ECC
\brief Imports raw key with curve ID.

\note This function does not check that the imported public point lies on
the curve. Define WOLFSSL_VALIDATE_ECC_IMPORT to validate the point on
import, or call wc_ecc_check_key before the key is used.

\return 0 on success
\return negative on error

Expand All @@ -3063,6 +3071,10 @@ int wc_ecc_import_raw_ex(ecc_key* key, const char* qx,
\ingroup ECC
\brief Imports unsigned key with curve ID.

\note This function does not check that the imported public point lies on
the curve. Define WOLFSSL_VALIDATE_ECC_IMPORT to validate the point on
import, or call wc_ecc_check_key before the key is used.

\return 0 on success
\return negative on error

Expand Down