openssl/crypto/err
Todd Short 3c95ef22df RFC7250 (RPK) support
Add support for the RFC7250 certificate-type extensions.
Alows the use of only private keys for connection (i.e. certs not needed).

Add APIs
Add unit tests
Add documentation
Add s_client/s_server support

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Viktor Dukhovni <viktor@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/18185)
2023-03-28 13:49:54 -04:00
..
build.info ERR: Move ERR_set_mark(), ERR_pop_to_mark() and ERR_clear_last_mark() 2022-01-21 14:44:16 +01:00
err_all_legacy.c Update copyright year 2021-06-17 13:24:59 +01:00
err_all.c err: rename err_load_xxx_strings_int functions 2021-05-26 13:01:47 +10:00
err_blocks.c err: remove TODOs 2021-06-02 16:30:15 +10:00
err_local.h err_set_debug(): Prevent possible recursion on malloc failure 2022-10-04 15:34:15 +02:00
err_mark.c ERR: Move ERR_set_mark(), ERR_pop_to_mark() and ERR_clear_last_mark() 2022-01-21 14:44:16 +01:00
err_prn.c err: remove TODOs 2021-06-02 16:30:15 +10:00
err.c ERR: Make CRYPTO_malloc() and friends report ERR_R_MALLOC_FAILURE 2022-08-27 09:40:09 +02:00
openssl.ec Write SSL_R alerts to error state to keep updated strings 2023-01-05 19:48:01 +01:00
openssl.txt RFC7250 (RPK) support 2023-03-28 13:49:54 -04:00
README.md crypto/err: expand on error code generation 2022-12-12 11:38:37 +01:00

Adding new libraries

When adding a new sub-library to OpenSSL, assign it a library number ERR_LIB_XXX, define a macro XXXerr() (both in err.h), add its name to ERR_str_libraries[] (in crypto/err/err.c), and add ERR_load_XXX_strings() to the ERR_load_crypto_strings() function (in crypto/err/err_all.c). Finally, add an entry:

L      XXX     xxx.h   xxx_err.c

to crypto/err/openssl.ec, and add xxx_err.c to the Makefile. Running make errors will then generate a file xxx_err.c, and add all error codes used in the library to xxx.h.

Additionally the library include file must have a certain form. Typically it will initially look like this:

#ifndef HEADER_XXX_H
#define HEADER_XXX_H

#ifdef __cplusplus
extern "C" {
#endif

/* Include files */

#include <openssl/bio.h>
#include <openssl/x509.h>

/* Macros, structures and function prototypes */


/* BEGIN ERROR CODES */

The BEGIN ERROR CODES sequence is used by the error code generation script as the point to place new error codes, any text after this point will be overwritten when make errors is run. The closing #endif etc will be automatically added by the script.

The generated C error code file xxx_err.c will load the header files stdio.h, openssl/err.h and openssl/xxx.h so the header file must load any additional header files containing any definitions it uses.

Adding new error codes

Instead of manually adding error codes into crypto/err/openssl.txt, it is recommended to leverage make update for error code generation. The target will process relevant sources and generate error codes for any used error codes.

If an error code is added manually into crypto/err/openssl.txt, subsequent make update has no effect.