Google GitGoogle Git
Sign in
flutter/third_party/openssl/refs/heads/upstream/master/./crypto/err
tree: 2e374f6aa1fe01319e1ba96a978f778ed1a54bd5
  1. build.info
  2. err.c
  3. err_all.c
  4. err_all_legacy.c
  5. err_blocks.c
  6. err_local.h
  7. err_mark.c
  8. err_prn.c
  9. err_save.c
  10. openssl.ec
  11. openssl.txt
  12. README.md
crypto/err/README.md

Adding new libraries

When adding a new sub-library to OpenSSL:

  • assign it a library number ERR_LIB_XXX in include/openssl/err.h;

  • add its name to ERR_str_libraries[] in crypto/err/err.c;

  • add a call to ossl_err_load_XXX_strings() in ossl_err_load_crypto_strings() in crypto/err/err_all.c. That function is defined in the generated source named below;

  • add an entry to crypto/err/openssl.ec:

    L      XXX     include/openssl/xxxerr.h    crypto/xxx/xxx_err.c

    The fields after the library name are the public header, the source file, and an optional private header. NONE stands for a file that is not wanted. The public header must be under include/openssl/, and a private header may only be given for an internal library;

  • add the files named on that entry to the block of generated error files in .gitignore.

Those files are produced during the build from crypto/err/openssl.ec and crypto/err/openssl.txt, and are not in git. They are left read-only: an edit to one is lost the next time it is generated.

Adding new error codes

Raise an error with ERR_raise(), using a reason name of the form XXX_R_...:

ERR_raise(ERR_LIB_XXX, XXX_R_SOMETHING_FAILED);

The reason does not have to be declared first. Running

make update

scans the sources, assigns a number to each reason that does not have one, and records it in crypto/err/openssl.txt:

XXX_R_SOMETHING_FAILED:100:something failed

Numbers already recorded there are kept, so they remain stable for applications that have compiled against them.

The third field is the string returned by ERR_reason_error_string(). It is derived from the reason name, with underscores replaced by spaces; edit crypto/err/openssl.txt if it should read differently.