Update docs.

This commit is contained in:
Dr. Stephen Henson 2000-02-02 01:33:28 +00:00
parent 1399f17a07
commit 54a34aecc3
2 changed files with 52 additions and 1 deletions

View file

@ -27,6 +27,7 @@ It can be used for
o Calculation of Message Digests
o Encryption and Decryption with Ciphers
o SSL/TLS Client and Server Tests
o Handling of S/MIME signed or encrypted mail
=head1 COMMAND SUMMARY
@ -130,6 +131,10 @@ SSL Connection Timer.
SSL Session Data Management.
=item B<smime>
S/MIME mail processing.
=item B<speed>
Algorithm Speed Measurement.

View file

@ -71,7 +71,7 @@ See L<ERR_put_error(3)> if you want to record error codes in the
OpenSSL error system from within your application.
The remainder of this section is of interest only if you want to add
new functionality to OpenSSL.
new error codes to OpenSSL or add error codes from external libraries.
=head2 Reporting errors
@ -88,6 +88,11 @@ When you are using new function or reason codes, run B<make errors>.
The necessary B<#define>s will then automatically be added to the
sub-library's header file.
Although a library will normally report errors using its own specific
macro, a different macro is used. This is normally only done when a
library wants to include ASN1 code which must user the ASN1 libraries
error macro.
=head2 Adding new libraries
When adding a new sub-library to OpenSSL, assign it a library number
@ -102,6 +107,47 @@ to B<crypto/err/openssl.ec>, and add B<xxx_err.c> to the Makefile.
Running B<make errors> will then generate a file B<xxx_err.c>, and
add all error codes used in the library to B<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 B<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 B<make errors> is run.
The closing #endif etc will be automatically added by the script.
The generated C error code file B<xxx_err.c> will load the header
files B<stdio.h>, B<openssl/err.h> and B<openssl/xxx.h> so the
header file must load any additional header files containg any
definitions it uses.
=head1 USING ERROR CODES IN EXTERNAL LIBRARIES
It is also possible to use OpenSSL's error code scheme in external
libraries. The library needs to load its own codes and call the OpenSSL
error code insertion script B<mkerr.pl> explicitly to add codes to
the header file and generate the C error code file. This will normally
be done if the external library needs to generate new ASN1 structures
but it can also be used to add more general purpose error code handling.
TBA more details
=head1 INTERNALS
The error queues are stored in a hash table with one B<ERR_STATE>