luna - wolfssl/wolfcrypt/src/error.c

  1/* error.c
  2 *
  3 * Copyright (C) 2006-2026 wolfSSL Inc.
  4 *
  5 * This file is part of wolfSSL.
  6 *
  7 * wolfSSL is free software; you can redistribute it and/or modify
  8 * it under the terms of the GNU General Public License as published by
  9 * the Free Software Foundation; either version 3 of the License, or
 10 * (at your option) any later version.
 11 *
 12 * wolfSSL is distributed in the hope that it will be useful,
 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 15 * GNU General Public License for more details.
 16 *
 17 * You should have received a copy of the GNU General Public License
 18 * along with this program; if not, write to the Free Software
 19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA
 20 */
 21
 22#include <wolfssl/wolfcrypt/libwolfssl_sources.h>
 23
 24#ifdef _MSC_VER
 25    /* 4996 warning to use MS extensions e.g., strcpy_s instead of XSTRNCPY */
 26    #pragma warning(disable: 4996)
 27#endif
 28
 29#ifndef NO_ERROR_STRINGS
 30
 31#ifdef WOLFSSL_DEBUG_TRACE_ERROR_CODES_H
 32#include <wolfssl/debug-untrace-error-codes.h>
 33#endif
 34
 35WOLFSSL_ABI
 36const char* wc_GetErrorString(int error)
 37{
 38    switch ((enum wolfCrypt_ErrorCodes)error) {
 39
 40    case WC_SUCCESS:
 41        return "wolfCrypt generic success";
 42
 43    case WC_FAILURE:
 44        return "wolfCrypt generic failure";
 45
 46    case MP_MEM :
 47        return "MP integer dynamic memory allocation failed";
 48
 49    case MP_VAL :
 50        return "MP integer invalid argument";
 51
 52    case MP_WOULDBLOCK :
 53        return "MP integer non-blocking operation would block";
 54
 55    case MP_NOT_INF:
 56        return "MP point not at infinity";
 57
 58    case OPEN_RAN_E :
 59        return "opening random device error";
 60
 61    case READ_RAN_E :
 62        return "reading random device error";
 63
 64    case WINCRYPT_E :
 65        return "windows crypt init error";
 66
 67    case CRYPTGEN_E :
 68        return "windows crypt generation error";
 69
 70    case RAN_BLOCK_E :
 71        return "random device read would block error";
 72
 73    case BAD_MUTEX_E :
 74        return "Bad mutex, operation failed";
 75
 76    case WC_TIMEOUT_E:
 77        return "Timeout error";
 78
 79    case WC_PENDING_E:
 80        return "wolfCrypt Operation Pending (would block / eagain) error";
 81
 82    case WC_NO_PENDING_E:
 83        return "wolfCrypt operation not pending error";
 84
 85    case MP_INIT_E :
 86        return "mp_init error state";
 87
 88    case MP_READ_E :
 89        return "mp_read error state";
 90
 91    case MP_EXPTMOD_E :
 92        return "mp_exptmod error state";
 93
 94    case MP_TO_E :
 95        return "mp_to_xxx error state, can't convert";
 96
 97    case MP_SUB_E :
 98        return "mp_sub error state, can't subtract";
 99
100    case MP_ADD_E :
101        return "mp_add error state, can't add";
102
103    case MP_MUL_E :
104        return "mp_mul error state, can't multiply";
105
106    case MP_MULMOD_E :
107        return "mp_mulmod error state, can't multiply mod";
108
109    case MP_MOD_E :
110        return "mp_mod error state, can't mod";
111
112    case MP_INVMOD_E :
113        return "mp_invmod error state, can't inv mod";
114
115    case MP_CMP_E :
116        return "mp_cmp error state";
117
118    case MP_ZERO_E :
119        return "mp zero result, not expected";
120
121    case MEMORY_E :
122        return "out of memory error";
123
124    case VAR_STATE_CHANGE_E :
125        return "Variable state modified by different thread";
126
127    case RSA_WRONG_TYPE_E :
128        return "RSA wrong block type for RSA function";
129
130    case RSA_BUFFER_E :
131        return "RSA buffer error, output too small or input too big";
132
133    case BUFFER_E :
134        return "Buffer error, output too small or input too big";
135
136    case ALGO_ID_E :
137        return "Setting Cert AlgoID error";
138
139    case PUBLIC_KEY_E :
140        return "Setting Cert Public Key error";
141
142    case DATE_E :
143        return "Setting Cert Date validity error";
144
145    case SUBJECT_E :
146        return "Setting Cert Subject name error";
147
148    case ISSUER_E :
149        return "Setting Cert Issuer name error";
150
151    case CA_TRUE_E :
152        return "Setting basic constraint CA true error";
153
154    case EXTENSIONS_E :
155        return "Setting extensions error";
156
157    case ASN_PARSE_E :
158        return "ASN parsing error, invalid input";
159
160    case ASN_VERSION_E :
161        return "ASN version error, invalid number";
162
163    case ASN_GETINT_E :
164        return "ASN get big int error, invalid data";
165
166    case ASN_RSA_KEY_E :
167        return "ASN key init error, invalid input";
168
169    case ASN_OBJECT_ID_E :
170        return "ASN object id error, invalid id";
171
172    case ASN_TAG_NULL_E :
173        return "ASN tag error, not null";
174
175    case ASN_EXPECT_0_E :
176        return "ASN expect error, not zero";
177
178    case ASN_BITSTR_E :
179        return "ASN bit string error, wrong id";
180
181    case ASN_UNKNOWN_OID_E :
182        return "ASN oid error, unknown sum id";
183
184    case ASN_DATE_SZ_E :
185        return "ASN date error, bad size";
186
187    case ASN_BEFORE_DATE_E :
188        return "ASN date error, current date is before start of validity";
189
190    case ASN_AFTER_DATE_E :
191        return "ASN date error, current date is after expiration";
192
193    case ASN_SIG_OID_E :
194        return "ASN signature error, mismatched oid";
195
196    case ASN_TIME_E :
197        return "ASN time error, unknown time type";
198
199    case ASN_INPUT_E :
200        return "ASN input error, not enough data";
201
202    case ASN_SIG_CONFIRM_E :
203        return "ASN sig error, confirm failure";
204
205    case ASN_SIG_HASH_E :
206        return "ASN sig error, unsupported hash type";
207
208    case ASN_SIG_KEY_E :
209        return "ASN sig error, unsupported key type";
210
211    case ASN_DH_KEY_E :
212        return "ASN key init error, invalid input";
213
214    case ASN_CRIT_EXT_E:
215        return "X.509 Critical extension ignored or invalid";
216
217    case ASN_ALT_NAME_E:
218        return "ASN alternate name error";
219
220    case ECC_BAD_ARG_E :
221        return "ECC input argument wrong type, invalid input";
222
223    case ASN_ECC_KEY_E :
224        return "ECC ASN1 bad key data, invalid input";
225
226    case ECC_CURVE_OID_E :
227        return "ECC curve sum OID unsupported, invalid input";
228
229    case BAD_FUNC_ARG :
230        return "Bad function argument";
231
232    case NOT_COMPILED_IN :
233        return "Feature not compiled in";
234
235    case UNICODE_SIZE_E :
236        return "Unicode password too big";
237
238    case NO_PASSWORD :
239        return "No password provided by user";
240
241    case ALT_NAME_E :
242        return "Alt Name problem, too big";
243
244    case AES_GCM_AUTH_E:
245        return "AES-GCM Authentication check fail";
246
247    case AES_CCM_AUTH_E:
248        return "AES-CCM Authentication check fail";
249
250    case AES_SIV_AUTH_E:
251        return "AES-SIV authentication failure";
252
253    case ASYNC_INIT_E:
254        return "Async Init error";
255
256    case COMPRESS_INIT_E:
257        return "Compress Init error";
258
259    case COMPRESS_E:
260        return "Compress error";
261
262    case DECOMPRESS_INIT_E:
263        return "DeCompress Init error";
264
265    case DECOMPRESS_E:
266        return "DeCompress error";
267
268    case BAD_ALIGN_E:
269        return "Bad alignment error, no alloc help";
270
271    case ASN_NO_SIGNER_E :
272#ifndef OPENSSL_EXTRA
273        return "ASN no signer error to confirm failure";
274#else
275        return "certificate verify failed";
276#endif
277
278    case ASN_CRL_CONFIRM_E :
279        return "ASN CRL sig error, confirm failure";
280
281    case ASN_CRL_NO_SIGNER_E :
282        return "ASN CRL no signer error to confirm failure";
283
284    case CRL_CERT_DATE_ERR:
285        return "CRL date error";
286
287    case ASN_OCSP_CONFIRM_E :
288        return "ASN OCSP sig error, confirm failure";
289
290    case ASN_NO_PEM_HEADER:
291        return "ASN no PEM Header Error";
292
293    case BAD_STATE_E:
294        return "Bad state operation";
295
296    case BAD_PADDING_E:
297        return "Bad padding, message wrong length";
298
299    case REQ_ATTRIBUTE_E:
300        return "Setting cert request attributes error";
301
302    case PKCS7_OID_E:
303        return "PKCS#7 error: mismatched OID value";
304
305    case PKCS7_RECIP_E:
306        return "PKCS#7 error: no matching recipient found";
307
308    case WC_PKCS7_WANT_READ_E:
309        return "PKCS#7 operations wants more input, call again";
310
311    case FIPS_NOT_ALLOWED_E:
312        return "FIPS mode not allowed error";
313
314    case ASN_NAME_INVALID_E:
315        return "Name Constraint error";
316
317    case RNG_FAILURE_E:
318        return "Random Number Generator failed";
319
320    case HMAC_MIN_KEYLEN_E:
321        return "FIPS Mode HMAC Minimum Key or Salt Length error";
322
323    case RSA_PAD_E:
324        return "Rsa Padding error";
325
326    case LENGTH_ONLY_E:
327        return "Output length only set, not for other use error";
328
329    case IN_CORE_FIPS_E:
330        return "In Core Integrity check FIPS error";
331
332    case AES_KAT_FIPS_E:
333        return "AES Known Answer Test check FIPS error";
334
335    case DES3_KAT_FIPS_E:
336        return "DES3 Known Answer Test check FIPS error";
337
338    case HMAC_KAT_FIPS_E:
339        return "HMAC Known Answer Test check FIPS error";
340
341    case RSA_KAT_FIPS_E:
342        return "RSA Known Answer Test check FIPS error";
343
344    case DRBG_KAT_FIPS_E:
345        return "DRBG Known Answer Test check FIPS error";
346
347    case DRBG_CONT_FIPS_E:
348        return "DRBG Continuous Test FIPS error";
349
350    case AESGCM_KAT_FIPS_E:
351        return "AESGCM Known Answer Test check FIPS error";
352
353    case THREAD_STORE_KEY_E:
354        return "Thread Storage Key Create error";
355
356    case THREAD_STORE_SET_E:
357        return "Thread Storage Set error";
358
359    case MAC_CMP_FAILED_E:
360        return "MAC comparison failed";
361
362    case IS_POINT_E:
363        return "ECC is point on curve failed";
364
365    case ECC_INF_E:
366        return "ECC point at infinity error";
367
368    case ECC_OUT_OF_RANGE_E:
369        return "ECC Qx or Qy out of range error";
370
371    case ECC_PRIV_KEY_E:
372        return "ECC private key is not valid error";
373
374    case SRP_CALL_ORDER_E:
375        return "SRP function called in the wrong order error";
376
377    case SRP_VERIFY_E:
378        return "SRP proof verification error";
379
380    case SRP_BAD_KEY_E:
381        return "SRP bad key values error";
382
383    case ASN_NO_SKID:
384        return "ASN no Subject Key Identifier found error";
385
386    case ASN_NO_AKID:
387        return "ASN no Authority Key Identifier found error";
388
389    case ASN_NO_KEYUSAGE:
390        return "ASN no Key Usage found error";
391
392    case SKID_E:
393        return "Setting Subject Key Identifier error";
394
395    case AKID_E:
396        return "Setting Authority Key Identifier error";
397
398    case KEYUSAGE_E:
399        return "Key Usage value error";
400
401    case EXTKEYUSAGE_E:
402        return "Extended Key Usage value error";
403
404    case CERTPOLICIES_E:
405        return "Setting Certificate Policies error";
406
407    case WC_INIT_E:
408        return "wolfCrypt Initialize Failure error";
409
410    case SIG_VERIFY_E:
411        return "Signature verify error";
412
413    case BAD_COND_E:
414        return "Bad condition variable operation error";
415
416    case SIG_TYPE_E:
417        return "Signature type not enabled/available";
418
419    case HASH_TYPE_E:
420        return "Hash type not enabled/available";
421
422    case WC_KEY_SIZE_E:
423        return "Key size error, either too small or large";
424
425    case ASN_COUNTRY_SIZE_E:
426        return "Country code size error, either too small or large";
427
428    case MISSING_RNG_E:
429        return "RNG required but not provided";
430
431    case ASN_PATHLEN_SIZE_E:
432        return "ASN CA path length value too large error";
433
434    case ASN_PATHLEN_INV_E:
435        return "ASN CA path length larger than signer error";
436
437    case BAD_KEYWRAP_ALG_E:
438        return "Unsupported key wrap algorithm error";
439
440    case BAD_KEYWRAP_IV_E:
441        return "Decrypted AES key wrap IV does not match expected";
442
443    case WC_CLEANUP_E:
444        return "wolfcrypt cleanup failed";
445
446    case ECC_CDH_KAT_FIPS_E:
447        return "wolfcrypt FIPS ECC CDH Known Answer Test Failure";
448
449    case DH_CHECK_PUB_E:
450        return "DH Check Public Key failure";
451
452    case BAD_PATH_ERROR:
453        return "Bad path for opendir error";
454
455    case ASYNC_OP_E:
456        return "Async operation error";
457
458    case BAD_OCSP_RESPONDER:
459        return "Invalid OCSP Responder, missing specific key usage extensions";
460
461    case ECC_PRIVATEONLY_E:
462        return "Invalid use of private only ECC key";
463
464    case WC_HW_E:
465        return "Error with hardware crypto use";
466
467    case WC_HW_WAIT_E:
468        return "Hardware waiting on resource";
469
470    case PSS_SALTLEN_E:
471        return "PSS - Length of salt is too big for hash algorithm";
472
473    case PRIME_GEN_E:
474        return "Unable to find a prime for RSA key";
475
476    case BER_INDEF_E:
477        return "Unable to decode an indefinite length encoded message";
478
479    case RSA_OUT_OF_RANGE_E:
480        return "Ciphertext to decrypt is out of range";
481
482    case RSAPSS_PAT_FIPS_E:
483        return "wolfcrypt FIPS RSA-PSS Pairwise Agreement Test Failure";
484
485    case ECDSA_PAT_FIPS_E:
486        return "wolfcrypt FIPS ECDSA Pairwise Agreement Test Failure";
487
488    case DH_KAT_FIPS_E:
489        return "wolfcrypt FIPS DH Known Answer Test Failure";
490
491    case AESCCM_KAT_FIPS_E:
492        return "AESCCM Known Answer Test check FIPS error";
493
494    case SHA3_KAT_FIPS_E:
495        return "SHA-3 Known Answer Test check FIPS error";
496
497    case ECDHE_KAT_FIPS_E:
498        return "wolfcrypt FIPS ECDHE Known Answer Test Failure";
499
500    case AES_GCM_OVERFLOW_E:
501        return "AES-GCM invocation counter overflow";
502
503    case AES_CCM_OVERFLOW_E:
504        return "AES-CCM invocation counter overflow";
505
506    case RSA_KEY_PAIR_E:
507        return "RSA Key Pair-Wise Consistency check fail";
508
509    case DH_CHECK_PRIV_E:
510        return "DH Check Private Key failure";
511
512    case WC_AFALG_SOCK_E:
513        return "AF_ALG socket error";
514
515    case WC_DEVCRYPTO_E:
516        return "Error with /dev/crypto";
517
518    case ZLIB_INIT_ERROR:
519        return "zlib init error";
520
521    case ZLIB_COMPRESS_ERROR:
522        return "zlib compress error";
523
524    case ZLIB_DECOMPRESS_ERROR:
525        return "zlib decompress error";
526
527    case PKCS7_NO_SIGNER_E:
528        return "No signer in PKCS#7 signed data";
529
530    case CRYPTOCB_UNAVAILABLE:
531        return "Crypto callback unavailable";
532
533    case PKCS7_SIGNEEDS_CHECK:
534        return "Signature found but no certificate to verify";
535
536    case PSS_SALTLEN_RECOVER_E:
537        return "PSS - Salt length unable to be recovered";
538
539    case CHACHA_POLY_OVERFLOW:
540        return "wolfcrypt - ChaCha20_Poly1305 limit overflow 4GB";
541
542    case ASN_SELF_SIGNED_E:
543        return "ASN self-signed certificate error";
544
545    case SAKKE_VERIFY_FAIL_E:
546        return "SAKKE derivation verification error";
547
548    case MISSING_IV:
549        return "Required IV not set";
550
551    case MISSING_KEY:
552        return "Required key not set";
553
554    case BAD_LENGTH_E:
555        return "Value of length parameter is invalid.";
556
557    case ECDSA_KAT_FIPS_E:
558        return "wolfcrypt FIPS ECDSA Known Answer Test Failure";
559
560    case RSA_PAT_FIPS_E:
561        return "wolfcrypt FIPS RSA Pairwise Agreement Test Failure";
562
563    case KDF_TLS12_KAT_FIPS_E:
564        return "wolfcrypt FIPS TLSv1.2 KDF Known Answer Test Failure";
565
566    case KDF_TLS13_KAT_FIPS_E:
567        return "wolfcrypt FIPS TLSv1.3 KDF Known Answer Test Failure";
568
569    case KDF_SSH_KAT_FIPS_E:
570        return "wolfcrypt FIPS SSH KDF Known Answer Test Failure";
571
572     case DHE_PCT_E:
573        return "wolfcrypt DHE Pairwise Consistency Test Failure";
574
575    case ECC_PCT_E:
576        return "wolfcrypt ECDHE Pairwise Consistency Test Failure";
577
578    case FIPS_PRIVATE_KEY_LOCKED_E:
579        return "Cannot export private key, locked";
580
581    case PROTOCOLCB_UNAVAILABLE:
582        return "Protocol callback unavailable";
583
584    case NO_VALID_DEVID:
585        return "No valid device ID set";
586
587    case IO_FAILED_E:
588        return "Input/output failure";
589
590    case SYSLIB_FAILED_E:
591        return "System/library call failed";
592
593    case USE_HW_PSK:
594        return "Callback indicates that HW has PSK";
595
596    case ENTROPY_RT_E:
597        return "Entropy Repetition Test failed";
598
599    case ENTROPY_APT_E:
600        return "Entropy Adaptive Proportion Test failed";
601
602    case ASN_DEPTH_E:
603        return "Invalid ASN.1 - depth check";
604
605    case ASN_LEN_E:
606        return "ASN.1 length invalid";
607
608    case SM4_GCM_AUTH_E:
609        return "SM4-GCM Authentication check fail";
610
611    case SM4_CCM_AUTH_E:
612        return "SM4-CCM Authentication check fail";
613
614    case FIPS_DEGRADED_E:
615        return "FIPS module in DEGRADED mode";
616
617    case AES_EAX_AUTH_E:
618        return "AES-EAX Authentication check fail";
619
620    case KEY_EXHAUSTED_E:
621        return "Key no longer usable for operation";
622
623    case FIPS_INVALID_VER_E:
624        return "Invalid FIPS version defined, check length";
625
626    case FIPS_DATA_SZ_E:
627        return "FIPS Module Data too large adjust MAX_FIPS_DATA_SZ";
628
629    case FIPS_CODE_SZ_E:
630        return "FIPS Module Code too large adjust MAX_FIPS_CODE_SZ";
631
632    case KDF_SRTP_KAT_FIPS_E:
633        return "wolfCrypt FIPS SRTP-KDF Known Answer Test Failure";
634
635    case ED25519_KAT_FIPS_E:
636        return "wolfCrypt FIPS Ed25519 Known Answer Test Failure";
637
638    case ED448_KAT_FIPS_E:
639        return "wolfCrypt FIPS Ed448 Known Answer Test Failure";
640
641    case PBKDF2_KAT_FIPS_E:
642        return "wolfCrypt FIPS PBKDF2 Known Answer Test Failure";
643
644    case WC_KEY_MISMATCH_E:
645        return "key values mismatch";
646
647    case DEADLOCK_AVERTED_E:
648        return "Deadlock averted -- retry the call";
649
650    case ASCON_AUTH_E:
651        return "ASCON Authentication check fail";
652
653    case WC_ACCEL_INHIBIT_E:
654        return "Crypto acceleration is currently inhibited";
655
656    case BAD_INDEX_E:
657        return "Bad index";
658
659    case INTERRUPTED_E:
660        return "Process interrupted";
661
662    case MLKEM_PUB_HASH_E:
663        return "ML-KEM priv key's stored hash doesn't match encoded pub key";
664
665    case BUSY_E:
666        return "Object is busy";
667
668    case ALREADY_E:
669        return "Operation was redundant or preempted";
670
671    case ML_KEM_KAT_FIPS_E:
672        return "wolfCrypt FIPS ML-KEM Known Answer Test Failure";
673
674    case ML_DSA_KAT_FIPS_E:
675        return "wolfCrypt FIPS ML-DSA Known Answer Test Failure";
676
677    case LMS_KAT_FIPS_E:
678        return "wolfCrypt FIPS LMS Known Answer Test Failure";
679
680    case XMSS_KAT_FIPS_E:
681        return "wolfCrypt FIPS XMSS Known Answer Test Failure";
682
683    case ML_KEM_PCT_E:
684        return "wolfcrypt ML-KEM Pairwise Consistency Test Failure";
685
686    case ML_DSA_PCT_E:
687        return "wolfcrypt ML-DSA Pairwise Consistency Test Failure";
688
689    case DRBG_SHA512_KAT_FIPS_E:
690        return "SHA-512 DRBG Known Answer Test check FIPS error";
691
692    case SLH_DSA_KAT_FIPS_E:
693        return "SLH-DSA Known Answer Test check FIPS error";
694
695    case SEQ_OVERFLOW_E:
696        return "Sequence counter would overflow";
697
698    case PUF_INIT_E:
699        return "PUF initialization failed";
700
701    case PUF_READ_E:
702        return "PUF SRAM read failed";
703
704    case PUF_ENROLL_E:
705        return "PUF enrollment failed";
706
707    case PUF_RECONSTRUCT_E:
708        return "PUF reconstruction failed";
709
710    case PUF_DERIVE_KEY_E:
711        return "PUF key derivation failed";
712
713    case PUF_IDENTITY_E:
714        return "PUF identity retrieval failed";
715
716    case MAX_CODE_E:
717    case WC_SPAN1_MIN_CODE_E:
718    case MIN_CODE_E:
719    default:
720        return "unknown error number";
721    }
722}
723
724#ifdef WOLFSSL_DEBUG_TRACE_ERROR_CODES
725#include <wolfssl/debug-trace-error-codes.h>
726#endif
727
728void wc_ErrorString(int error, char* buffer)
729{
730    XSTRNCPY(buffer, wc_GetErrorString(error), WOLFSSL_MAX_ERROR_SZ);
731    buffer[WOLFSSL_MAX_ERROR_SZ-1] = 0;
732}
733#endif /* !NO_ERROR_STRINGS */