My Project
|
Functions | |
int | wolfSSL_Debugging_ON (void) |
If logging has been enabled at build time this function turns on logging at runtime. To enable logging at build time use –enable-debug or define DEBUG_WOLFSSL. More... | |
void | wolfSSL_Debugging_OFF (void) |
This function turns off runtime logging messages. If they’re already off, no action is taken. More... | |
int | wolfSSL_get_error (WOLFSSL *ssl, int ret) |
This function returns a unique error code describing why the previous API function call (wolfSSL_connect, wolfSSL_accept, wolfSSL_read, wolfSSL_write, etc.) resulted in an error return code (SSL_FAILURE). The return value of the previous function is passed to wolfSSL_get_error through ret. After wolfSSL_get_error is called and returns the unique error code, wolfSSL_ERR_error_string() may be called to get a human-readable error string. See wolfSSL_ERR_error_string() for more information. More... | |
void | wolfSSL_load_error_strings (void) |
This function is for OpenSSL compatibility (SSL_load_error_string) only and takes no action. More... | |
char * | wolfSSL_ERR_error_string (unsigned long errNumber, char *data) |
This function converts an error code returned by wolfSSL_get_error() into a more human-readable error string. errNumber is the error code returned by wolfSSL_get_error() and data is the storage buffer which the error string will be placed in. The maximum length of data is 80 characters by default, as defined by MAX_ERROR_SZ is wolfssl/wolfcrypt/error.h. More... | |
void | wolfSSL_ERR_error_string_n (unsigned long e, char *buf, unsigned long sz) |
This function is a version of wolfSSL_ERR_error_string() where len specifies the maximum number of characters that may be written to buf. Like wolfSSL_ERR_error_string(), this function converts an error code returned from wolfSSL_get_error() into a more human-readable error string. The human-readable string is placed in buf. More... | |
void | wolfSSL_ERR_print_errors_fp (XFILE fp, int err) |
This function converts an error code returned by wolfSSL_get_error() into a more human-readable error string and prints that string to the output file - fp. err is the error code returned by wolfSSL_get_error() and fp is the file which the error string will be placed in. More... | |
void | wolfSSL_ERR_print_errors_cb (int(*cb)(const char *str, size_t len, void *u), void *u) |
This function uses the provided callback to handle error reporting. The callback function is executed for each error line. The string, length, and userdata are passed into the callback parameters. More... | |
int | wolfSSL_want_read (WOLFSSL *) |
This function is similar to calling wolfSSL_get_error() and getting SSL_ERROR_WANT_READ in return. If the underlying error state is SSL_ERROR_WANT_READ, this function will return 1, otherwise, 0. More... | |
int | wolfSSL_want_write (WOLFSSL *) |
This function is similar to calling wolfSSL_get_error() and getting SSL_ERROR_WANT_WRITE in return. If the underlying error state is SSL_ERROR_WANT_WRITE, this function will return 1, otherwise, 0. More... | |
unsigned long | wolfSSL_ERR_peek_last_error (void) |
This function returns the absolute value of the last error from WOLFSSL_ERROR encountered. More... | |
void wolfSSL_Debugging_OFF | ( | void | ) |
This function turns off runtime logging messages. If they’re already off, no action is taken.
none | No parameters. |
Example
int wolfSSL_Debugging_ON | ( | void | ) |
If logging has been enabled at build time this function turns on logging at runtime. To enable logging at build time use –enable-debug or define DEBUG_WOLFSSL.
none | No parameters. |
Example
char* wolfSSL_ERR_error_string | ( | unsigned long | errNumber, |
char * | data | ||
) |
This function converts an error code returned by wolfSSL_get_error() into a more human-readable error string. errNumber is the error code returned by wolfSSL_get_error() and data is the storage buffer which the error string will be placed in. The maximum length of data is 80 characters by default, as defined by MAX_ERROR_SZ is wolfssl/wolfcrypt/error.h.
errNumber | error code returned by wolfSSL_get_error(). |
data | output buffer containing human-readable error string matching errNumber. |
Example
void wolfSSL_ERR_error_string_n | ( | unsigned long | e, |
char * | buf, | ||
unsigned long | sz | ||
) |
This function is a version of wolfSSL_ERR_error_string() where len specifies the maximum number of characters that may be written to buf. Like wolfSSL_ERR_error_string(), this function converts an error code returned from wolfSSL_get_error() into a more human-readable error string. The human-readable string is placed in buf.
e | error code returned by wolfSSL_get_error(). |
buff | output buffer containing human-readable error string matching e. |
len | maximum length in characters which may be written to buf. |
Example
unsigned long wolfSSL_ERR_peek_last_error | ( | void | ) |
This function returns the absolute value of the last error from WOLFSSL_ERROR encountered.
none | No parameters. |
Example
void wolfSSL_ERR_print_errors_cb | ( | int(*)(const char *str, size_t len, void *u) | cb, |
void * | u | ||
) |
This function uses the provided callback to handle error reporting. The callback function is executed for each error line. The string, length, and userdata are passed into the callback parameters.
cb | the callback function. |
u | userdata to pass into the callback function. |
Example
void wolfSSL_ERR_print_errors_fp | ( | XFILE | fp, |
int | err | ||
) |
This function converts an error code returned by wolfSSL_get_error() into a more human-readable error string and prints that string to the output file - fp. err is the error code returned by wolfSSL_get_error() and fp is the file which the error string will be placed in.
fp | output file for human-readable error string to be written to. |
err | error code returned by wolfSSL_get_error(). |
Example
int wolfSSL_get_error | ( | WOLFSSL * | ssl, |
int | ret | ||
) |
This function returns a unique error code describing why the previous API function call (wolfSSL_connect, wolfSSL_accept, wolfSSL_read, wolfSSL_write, etc.) resulted in an error return code (SSL_FAILURE). The return value of the previous function is passed to wolfSSL_get_error through ret. After wolfSSL_get_error is called and returns the unique error code, wolfSSL_ERR_error_string() may be called to get a human-readable error string. See wolfSSL_ERR_error_string() for more information.
ssl | pointer to the SSL object, created with wolfSSL_new(). |
ret | return value of the previous function that resulted in an error return code. |
Example
void wolfSSL_load_error_strings | ( | void | ) |
This function is for OpenSSL compatibility (SSL_load_error_string) only and takes no action.
none | No parameters. |
Example
int wolfSSL_want_read | ( | WOLFSSL * | ) |
This function is similar to calling wolfSSL_get_error() and getting SSL_ERROR_WANT_READ in return. If the underlying error state is SSL_ERROR_WANT_READ, this function will return 1, otherwise, 0.
ssl | pointer to the SSL session, created with wolfSSL_new(). |
Example
int wolfSSL_want_write | ( | WOLFSSL * | ) |
This function is similar to calling wolfSSL_get_error() and getting SSL_ERROR_WANT_WRITE in return. If the underlying error state is SSL_ERROR_WANT_WRITE, this function will return 1, otherwise, 0.
ssl | pointer to the SSL session, created with wolfSSL_new(). |
Example