Skip to content

Commit

Permalink
move several MP error codes from wolfssl/wolfcrypt/sp_int.h, wolfssl/…
Browse files Browse the repository at this point in the history 
…wolfcrypt/tfm.h, and wolfssl/wolfcrypt/integer.h, to wolfssl/wolfcrypt/error-crypt.h, harmonizing their names and numbers.

wolfssl/wolfcrypt/error-crypt.h: add WC_FIRST_E.

wolfcrypt/src/error.c: add MP error code strings.

wolfssl/error-ssl.h: add WOLFSSL_FIRST_E and WOLFSSL_LAST_E.

wolfcrypt/test/test.c: update error_test() for new error code layout, refactoring the "missing" check.

src/internal.c: use WC_FIRST_E and WC_LAST_E  in wolfSSL_ERR_reason_error_string().

src/ssl.c: fix wolfSSL_ERR_GET_REASON() to identify in-range error codes using WC_FIRST_E, WC_LAST_E, WOLFSSL_FIRST_E, and WOLFSSL_LAST_E.

sp_int.h: provide for WOLFSSL_DEBUG_TRACE_ERROR_CODES, and refactor MP error codes as enums, for consistency with other error codes.

wolfcrypt/src/ecc.c: fix 2 identicalInnerCondition's.
  • Loading branch information
@douzzer
douzzer committed Aug 17, 2024
1 parent 9a693f5 commit 558d3c1
Show file tree
Hide file tree
Showing 13 changed files with 78 additions and 45 deletions.
2 changes: 1 addition & 1 deletion src/internal.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25116,7 +25116,7 @@ const char* wolfSSL_ERR_reason_error_string(unsigned long e)
}

/* pass to wolfCrypt */
if (error < MAX_CODE_E && error > MIN_CODE_E) {
if (error <= WC_FIRST_E && error >= WC_LAST_E) {
return wc_GetErrorString(error);
}

Expand Down
4 changes: 3 additions & 1 deletion src/ssl.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15361,7 +15361,9 @@ int wolfSSL_ERR_GET_REASON(unsigned long err)
ret = 0 - ret; /* setting as negative value */
/* wolfCrypt range is less than MAX (-100)
wolfSSL range is MIN (-300) and lower */
if (ret < MAX_CODE_E && ret > MIN_CODE_E) {
if ((ret <= WC_FIRST_E && ret >= WC_LAST_E) ||
(ret <= WOLFSSL_FIRST_E && ret >= WOLFSSL_LAST_E))
{
return ret;
}
else {
Expand Down
2 changes: 1 addition & 1 deletion support/gen-debug-trace-error-codes.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ BEGIN {
print("#undef WOLFSSL_DEBUG_TRACE_ERROR_CODES_H") >> "wolfssl/debug-untrace-error-codes.h";
}
{
if (match($0, "^[[:space:]]+([A-Z][A-Z0-9_]+)[[:space:]]*=[[:space:]]*(-[0-9]+)[,[:space:]]")) {
if (match($0, "^[[:space:]]+([A-Z][A-Z0-9_]+)[[:space:]]*=[[:space:]]*(-[0-9]+)([,[:space:]]|$)")) {
# for mawkward compatibility -- gawk allows errcode_a as the 3rd arg to match().
gsub("^[[:space:]]+", "", $0);
Expand Down
6 changes: 2 additions & 4 deletions wolfcrypt/src/ecc.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2491,8 +2491,7 @@ static int _ecc_projective_dbl_point(ecc_point *P, ecc_point *R, mp_int* a,
}
if (err == MP_OKAY && mp_iszero((MP_INT_SIZE*)t2)) {
/* T2 = X * X */
if (err == MP_OKAY)
err = mp_sqr(x, t2);
err = mp_sqr(x, t2);
if (err == MP_OKAY)
err = mp_montgomery_reduce(t2, modulus, mp);
/* T1 = T2 + T1 */
Expand All @@ -2506,8 +2505,7 @@ static int _ecc_projective_dbl_point(ecc_point *P, ecc_point *R, mp_int* a,
/* use "a" in calc */

/* T2 = T1 * T1 */
if (err == MP_OKAY)
err = mp_sqr(t1, t2);
err = mp_sqr(t1, t2);
if (err == MP_OKAY)
err = mp_montgomery_reduce(t2, modulus, mp);
/* T1 = T2 * a */
Expand Down
12 changes: 12 additions & 0 deletions wolfcrypt/src/error.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,18 @@ const char* wc_GetErrorString(int error)
{
switch (error) {

case MP_MEM :
return "MP integer dynamic memory allocation failed";

case MP_VAL :
return "MP integer invalid argument";

case MP_WOULDBLOCK :
return "MP integer non-blocking operation would block";

case MP_NOT_INF:
return "MP point not at infinity";

case OPEN_RAN_E :
return "opening random device error";

Expand Down
1 change: 1 addition & 0 deletions wolfcrypt/src/sp_int.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ This library provides single precision (SP) integer math functions.
#endif

#include <wolfssl/wolfcrypt/settings.h>
#include <wolfssl/wolfcrypt/error-crypt.h>

#if defined(WOLFSSL_SP_MATH) || defined(WOLFSSL_SP_MATH_ALL)

Expand Down
4 changes: 2 additions & 2 deletions wolfcrypt/src/tfm.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5685,9 +5685,9 @@ int mp_rand_prime(mp_int* a, int len, WC_RNG* rng, void* heap)

err = fp_randprime(a, len, rng, heap);
switch(err) {
case FP_VAL:
case WC_NO_ERR_TRACE(MP_VAL):
return MP_VAL;
case FP_MEM:
case WC_NO_ERR_TRACE(MP_MEM):
return MP_MEM;
default:
break;
Expand Down
32 changes: 23 additions & 9 deletions wolfcrypt/test/test.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2623,40 +2623,54 @@ WOLFSSL_TEST_SUBROUTINE wc_test_ret_t error_test(void)
int i;
int j = 0;
/* Values that are not or no longer error codes. */
int missing[] = { -124, -166, -167, -168, -169, 0 };
static const struct {
int first;
int last;
} missing[] = {
{ -6, -100 },
{ -124, -124 },
{ -166, -169 }
};

/* Check that all errors have a string and it's the same through the two
* APIs. Check that the values that are not errors map to the unknown
* string.
*/
for (i = MAX_CODE_E-1; i >= WC_LAST_E; i--) {
for (i = WC_FIRST_E; i >= WC_LAST_E; i--) {
int this_missing = 0;
for (j = 0; j < (int)XELEM_CNT(missing); ++j) {
if ((i <= missing[j].first) && (i >= missing[j].last)) {
this_missing = 1;
break;
}
}
errStr = wc_GetErrorString(i);
wc_ErrorString(i, out);

if (i != missing[j]) {
if (! this_missing) {
if (XSTRCMP(errStr, unknownStr) == 0) {
WOLFSSL_MSG("errStr unknown");
return WC_TEST_RET_ENC_NC;
return WC_TEST_RET_ENC_I(-i);
}
if (XSTRCMP(out, unknownStr) == 0) {
WOLFSSL_MSG("out unknown");
return WC_TEST_RET_ENC_NC;
return WC_TEST_RET_ENC_I(-i);
}
if (XSTRCMP(errStr, out) != 0) {
WOLFSSL_MSG("errStr does not match output");
return WC_TEST_RET_ENC_NC;
return WC_TEST_RET_ENC_I(-i);
}
if (XSTRLEN(errStr) >= WOLFSSL_MAX_ERROR_SZ) {
WOLFSSL_MSG("errStr too long");
return WC_TEST_RET_ENC_NC;
return WC_TEST_RET_ENC_I(-i);
}
}
else {
j++;
if (XSTRCMP(errStr, unknownStr) != 0)
return WC_TEST_RET_ENC_NC;
return WC_TEST_RET_ENC_I(-i);
if (XSTRCMP(out, unknownStr) != 0)
return WC_TEST_RET_ENC_NC;
return WC_TEST_RET_ENC_I(-i);
}
}

Expand Down
7 changes: 6 additions & 1 deletion wolfssl/error-ssl.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@
#endif

enum wolfSSL_ErrorCodes {
WOLFSSL_FIRST_E = -301,

INPUT_CASE_ERROR = -301, /* process input state error */
PREFIX_ERROR = -302, /* bad index to key rounds */
MEMORY_ERROR = -303, /* out of memory */
Expand Down Expand Up @@ -196,8 +198,11 @@ enum wolfSSL_ErrorCodes {
KEY_SHARE_ERROR = -503, /* key share mismatch */
POST_HAND_AUTH_ERROR = -504, /* client won't do post-hand auth */
HRR_COOKIE_ERROR = -505, /* HRR msg cookie mismatch */
UNSUPPORTED_CERTIFICATE = -506 /* unsupported certificate type */
UNSUPPORTED_CERTIFICATE = -506, /* unsupported certificate type */
/* end negotiation parameter errors only 10 for now */

WOLFSSL_LAST_E = -506

/* add strings to wolfSSL_ERR_reason_error_string in internal.c !!!!! */

/* no error strings go down here, add above negotiation errors !!!! */
Expand Down
16 changes: 13 additions & 3 deletions wolfssl/wolfcrypt/error-crypt.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,21 @@ the error status.
extern "C" {
#endif

#ifdef WOLFSSL_DEBUG_TRACE_ERROR_CODES_H
#include <wolfssl/debug-untrace-error-codes.h>
#endif

/* error codes, add string for new errors !!! */
enum {
MAX_CODE_E = -100, /* errors -101 - -299 */
MAX_CODE_E = -1, /* errors -2 - -299 */
WC_FIRST_E = -2, /* errors -2 - -299 */

MP_MEM = -2, /* MP dynamic memory allocation failed. */
MP_VAL = -3, /* MP value passed is not able to be used. */
MP_WOULDBLOCK = -4, /* MP non-blocking operation is returning after
* partial completion. */
MP_NOT_INF = -5, /* MP point not at infinity */

OPEN_RAN_E = -101, /* opening random device error */
READ_RAN_E = -102, /* reading random device error */
WINCRYPT_E = -103, /* windows crypt init error */
Expand Down Expand Up @@ -276,13 +287,12 @@ enum {
SM4_CCM_AUTH_E = -299, /* SM4-CCM Authentication check failure */

WC_LAST_E = -299, /* Update this to indicate last error */
MIN_CODE_E = -300 /* errors -101 - -299 */
MIN_CODE_E = -300 /* errors -2 - -299 */

/* add new companion error id strings for any new error codes
wolfcrypt/src/error.c !!! */
};


#ifdef NO_ERROR_STRINGS
#define wc_GetErrorString(error) "no support for error strings built in"
#define wc_ErrorString(err, buf) \
Expand Down
5 changes: 2 additions & 3 deletions wolfssl/wolfcrypt/integer.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@

#else

#include <wolfssl/wolfcrypt/types.h>
#include <wolfssl/wolfcrypt/error-crypt.h>
#include <wolfssl/wolfcrypt/random.h>

#ifndef CHAR_BIT
Expand Down Expand Up @@ -162,9 +164,6 @@ extern "C" {
#define MP_NEG 1 /* negative */

#define MP_OKAY 0 /* ok result */
#define MP_MEM (-2) /* out of mem */
#define MP_VAL (-3) /* invalid input */
#define MP_NOT_INF (-4) /* point not at infinity */
#define MP_RANGE MP_NOT_INF

#define MP_YES 1 /* yes response */
Expand Down
18 changes: 6 additions & 12 deletions wolfssl/wolfcrypt/sp_int.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -742,24 +742,18 @@ typedef struct sp_ecc_ctx {
#define MP_LT (-1)

/* ERROR VALUES */

/* MP_MEM, MP_VAL, MP_WOULDBLOCK, and MP_NOT_INF are defined in error-crypt.h */

/** Error value on success. */
#define MP_OKAY 0
/** Error value when dynamic memory allocation fails. */
#define MP_MEM (-2)
/** Error value when value passed is not able to be used. */
#define MP_VAL (-3)
/** Error value when non-blocking operation is returning after partial
* completion.
*/
#define FP_WOULDBLOCK (-4)
/* Unused error. Defined for backward compatibility. */
#define MP_NOT_INF (-5)

#define FP_WOULDBLOCK MP_WOULDBLOCK
/* Unused error. Defined for backward compatibility. */
#define MP_RANGE MP_NOT_INF

#ifdef USE_FAST_MATH
/* For old FIPS, need FP_MEM defined for old implementation. */
#define FP_MEM (-2)
#define FP_MEM MP_MEM
#endif

/* Number of bits in each word/digit. */
Expand Down
14 changes: 6 additions & 8 deletions wolfssl/wolfcrypt/tfm.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
#define WOLF_CRYPT_TFM_H

#include <wolfssl/wolfcrypt/types.h>
#include <wolfssl/wolfcrypt/error-crypt.h>
#ifndef CHAR_BIT
#include <limits.h>
#endif
Expand Down Expand Up @@ -305,10 +306,10 @@

/* return codes */
#define FP_OKAY 0
#define FP_VAL (-1)
#define FP_MEM (-2)
#define FP_NOT_INF (-3)
#define FP_WOULDBLOCK (-4)
#define FP_VAL MP_VAL
#define FP_MEM MP_MEM
#define FP_NOT_INF MP_NOT_INF
#define FP_WOULDBLOCK MP_WOULDBLOCK

/* equalities */
#define FP_LT (-1) /* less than */
Expand Down Expand Up @@ -776,10 +777,7 @@ int fp_sqr_comba64(fp_int *a, fp_int *b);
#define MP_LT FP_LT /* less than */
#define MP_EQ FP_EQ /* equal to */
#define MP_GT FP_GT /* greater than */
#define MP_VAL FP_VAL /* invalid */
#define MP_MEM FP_MEM /* memory error */
#define MP_NOT_INF FP_NOT_INF /* point not at infinity */
#define MP_RANGE FP_NOT_INF
#define MP_RANGE MP_NOT_INF
#define MP_OKAY FP_OKAY /* ok result */
#define MP_NO FP_NO /* yes/no result */
#define MP_YES FP_YES /* yes/no result */
Expand Down

0 comments on commit 558d3c1

Please sign in to comment.