openssl/doc
Pauli 7ffbd7ca96 OSSL_PARAM helper functions.
Provide a number of functions to allow parameters to be set and
retrieved in a type safe manner.  Functions are provided for many
integral types plus double, BIGNUM, UTF8 strings and OCTET strings.

All of the integer functions will widen the parameter data as
required.  This permits a degree of malleability in the parameter
definition.  For example a type can be changed from a thirty two bit
integer to a sixty four bit one without changing application code.
Only four and eight byte integral sizes are supported here.

A pair of real functions are available for doubles.

A pair of functions is available for BIGNUMs.  These accept any sized
unsigned integer input and convert to/from a BIGNUM.

For each OCTET and UTF8 strings, four functions are defined.  This
provide get and set functionality for string and for pointers to
strings.  The latter avoiding copies but have other inherent risks.

Finally, some utility macros and functions are defined to allow
OSSL_PARAM definition arrays to be specified in a simple manner.
There are two macro and one function for most types.  The exception
being BIGNUM, for which there is one macro and one function.

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/8451)
2019-03-12 19:12:12 +01:00
..
HOWTO Remove unnecessary trailing whitespace 2019-02-05 16:25:11 +01:00
internal/man3 Add documentation 2019-03-11 20:40:13 +01:00
man1 openssl app for macs that uses the new EVP_MAC interface (the code inside dgst uses EVP_PKEY) 2019-03-11 12:44:56 +00:00
man3 OSSL_PARAM helper functions. 2019-03-12 19:12:12 +01:00
man5 Allow the syntax of the .include directive to optionally have '=' 2019-02-11 15:24:12 +01:00
man7 Replumbing: Add include/openssl/core.h, initially with core types 2019-02-27 18:36:30 +01:00
dir-locals.example.el
fingerprints.txt Remove unnecessary trailing whitespace 2019-02-05 16:25:11 +01:00
openssl-c-indent.el OpenSSL-II style for emacs: don't indent because of extern block 2018-06-23 07:59:06 +02:00
README

README  This file

fingerprints.txt
        PGP fingerprints of authorised release signers

standards.txt
        Moved to the web, https://www.openssl.org/docs/standards.html

HOWTO/
        A few how-to documents; not necessarily up-to-date

man1/
        The openssl command-line tools; start with openssl.pod

man3/
        The SSL library and the crypto library

man5/
        File formats

man7/
        Overviews; start with crypto.pod and ssl.pod, for example
        Algorithm specific EVP_PKEY documentation.

Formatted versions of the manpages (apps,ssl,crypto) can be found at
        https://www.openssl.org/docs/manpages.html