openssl/crypto
Richard Levitte 7c214f1092 Providers: move all digests
From providers/{common,default,legacy}/ to providers/implementations/
However, providers/common/digests/digest_common.c stays where it is,
because it's support code rather than an implementation.

To better support all kinds of implementations with common code, we
add the library providers/libcommon.a.  Code that ends up in this
library must be FIPS agnostic.

While we're moving things around, though, we move digestscommon.h
from providers/common/include/internal to providers/common/include/prov,
thereby starting on a provider specific include structure, which
follows the line of thoughts of the recent header file reorganization.
We modify the affected '#include "internal/something.h"' to
'#include "prov/something.h"'.

Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/10088)
2019-10-10 14:12:15 +02:00
..
aes Rework how our providers are built 2019-10-10 14:12:15 +02:00
aria Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
asn1 Explicitly test against NULL; do not use !p or similar 2019-10-09 21:32:15 +02:00
async Explicitly test against NULL; do not use !p or similar 2019-10-09 21:32:15 +02:00
bf Fix header file include guard names 2019-09-28 20:26:36 +02:00
bio Fix header file include guard names 2019-09-28 20:26:36 +02:00
blake2 Providers: move all digests 2019-10-10 14:12:15 +02:00
bn Rework how our providers are built 2019-10-10 14:12:15 +02:00
buffer Rework how our providers are built 2019-10-10 14:12:15 +02:00
camellia Fix header file include guard names 2019-09-28 20:26:36 +02:00
cast Reorganize local header files 2019-09-28 20:26:35 +02:00
chacha Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
cmac Rework how our providers are built 2019-10-10 14:12:15 +02:00
cmp Fix header file include guard names 2019-09-28 20:26:36 +02:00
cms Explicitly test against NULL; do not use !p or similar 2019-10-09 21:32:15 +02:00
comp Reorganize local header files 2019-09-28 20:26:35 +02:00
conf Explicitly test against NULL; do not use !p or similar 2019-10-09 21:32:15 +02:00
crmf Fix header file include guard names 2019-09-28 20:26:36 +02:00
ct Reorganize local header files 2019-09-28 20:26:35 +02:00
des Rework how our providers are built 2019-10-10 14:12:15 +02:00
dh Explicitly test against NULL; do not use !p or similar 2019-10-09 21:32:15 +02:00
dsa Explicitly test against NULL; do not use !p or similar 2019-10-09 21:32:15 +02:00
dso Reorganize local header files 2019-09-28 20:26:35 +02:00
ec Rework how our providers are built 2019-10-10 14:12:15 +02:00
engine Explicitly test against NULL; do not use !p or similar 2019-10-09 21:32:15 +02:00
err Explicitly test against NULL; do not use !p or similar 2019-10-09 21:32:15 +02:00
ess Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
evp Providers: move all digests 2019-10-10 14:12:15 +02:00
hmac Rework how our providers are built 2019-10-10 14:12:15 +02:00
idea Reorganize local header files 2019-09-28 20:26:35 +02:00
lhash Rework how our providers are built 2019-10-10 14:12:15 +02:00
md2
md4 Reorganize local header files 2019-09-28 20:26:35 +02:00
md5 Providers: move all digests 2019-10-10 14:12:15 +02:00
mdc2
modes Rework how our providers are built 2019-10-10 14:12:15 +02:00
objects Fix long name of some Microsoft objects 2019-10-03 08:24:38 +10:00
ocsp Explicitly test against NULL; do not use !p or similar 2019-10-09 21:32:15 +02:00
pem Explicitly test against NULL; do not use !p or similar 2019-10-09 21:32:15 +02:00
perlasm
pkcs7 Explicitly test against NULL; do not use !p or similar 2019-10-09 21:32:15 +02:00
pkcs12 Explicitly test against NULL; do not use !p or similar 2019-10-09 21:32:15 +02:00
poly1305 Reorganize local header files 2019-09-28 20:26:35 +02:00
property Rework how our providers are built 2019-10-10 14:12:15 +02:00
rand Rework how our providers are built 2019-10-10 14:12:15 +02:00
rc2 Reorganize local header files 2019-09-28 20:26:35 +02:00
rc4 Fix header file include guard names 2019-09-28 20:26:36 +02:00
rc5 Reorganize local header files 2019-09-28 20:26:35 +02:00
ripemd Reorganize local header files 2019-09-28 20:26:35 +02:00
rsa rsa: replace magic number '11' by RSA_PKCS1_PADDING_SIZE 2019-10-03 14:37:16 +02:00
seed Fix header file include guard names 2019-09-28 20:26:36 +02:00
sha Rework how our providers are built 2019-10-10 14:12:15 +02:00
siphash Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
sm2 Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
sm3 Reorganize local header files 2019-09-28 20:26:35 +02:00
sm4 Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
srp Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
stack Rework how our providers are built 2019-10-10 14:12:15 +02:00
store Reorganize local header files 2019-09-28 20:26:35 +02:00
ts Explicitly test against NULL; do not use !p or similar 2019-10-09 21:32:15 +02:00
txt_db
ui Fix header file include guard names 2019-09-28 20:26:36 +02:00
whrlpool Reorganize local header files 2019-09-28 20:26:35 +02:00
x509 Explicitly test against NULL; do not use !p or similar 2019-10-09 21:32:15 +02:00
alphacpuid.pl Unify all assembler file generators 2019-09-16 16:29:57 +02:00
arm64cpuid.pl Unify all assembler file generators 2019-09-16 16:29:57 +02:00
arm_arch.h Fix header file include guard names 2019-09-28 20:26:36 +02:00
armcap.c
armv4cpuid.pl Unify all assembler file generators 2019-09-16 16:29:57 +02:00
asn1_dsa.c Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
bsearch.c
build.info Rework how our providers are built 2019-10-10 14:12:15 +02:00
c64xpluscpuid.pl
context.c Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
core_algorithm.c Replumbing: make it possible for providers to specify multiple names 2019-10-03 15:47:25 +02:00
core_fetch.c Replumbing: make it possible for providers to specify multiple names 2019-10-03 15:47:25 +02:00
core_namemap.c Replumbing: make it possible for providers to specify multiple names 2019-10-03 15:47:25 +02:00
cpt_err.c util/mkerr.pl: make it not depend on the function code 2019-09-12 17:59:52 +02:00
cryptlib.c Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
ctype.c Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
cversion.c
dllmain.c Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
ebcdic.c
ex_data.c Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
getenv.c
ia64cpuid.S
info.c Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
init.c Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
initthread.c Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
LPdir_nyi.c
LPdir_unix.c
LPdir_vms.c
LPdir_win32.c
LPdir_win.c
LPdir_wince.c
mem_clr.c
mem_dbg.c
mem_sec.c
mem.c Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
mips_arch.h Fix header file include guard names 2019-09-28 20:26:36 +02:00
o_dir.c
o_fips.c
o_fopen.c
o_init.c
o_str.c
o_time.c
packet.c
param_build.c
params_from_text.c
params.c OSSL_PARAM functions: change to allow the data field to be NULL 2019-09-27 19:03:34 +02:00
pariscid.pl Unify all assembler file generators 2019-09-16 16:29:57 +02:00
ppc_arch.h Fix header file include guard names 2019-09-28 20:26:36 +02:00
ppccap.c Reorganize local header files 2019-09-28 20:26:35 +02:00
ppccpuid.pl Unify all assembler file generators 2019-09-16 16:29:57 +02:00
provider_conf.c
provider_core.c Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
provider_local.h
provider_predefined.c When building of modules is disabled, build the legacy provider into libcrypto 2019-09-26 22:41:47 +02:00
provider.c
README.sparse_array
s390x_arch.h Fix header file include guard names 2019-09-28 20:26:36 +02:00
s390xcap.c Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
s390xcpuid.pl s390x assembly pack: accelerate X25519, X448, Ed25519 and Ed448 2019-09-25 15:53:53 +02:00
sparc_arch.h Fix header file include guard names 2019-09-28 20:26:36 +02:00
sparccpuid.S
sparcv9cap.c Fix missing bn_mul_mont symbol in solaris fips module 2019-09-20 12:29:53 +10:00
sparse_array.c Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
threads_none.c drbg: ensure fork-safety without using a pthread_atfork handler 2019-09-11 11:22:18 +02:00
threads_pthread.c drbg: ensure fork-safety without using a pthread_atfork handler 2019-09-11 11:22:18 +02:00
threads_win.c crypto/threads_win.c: fix preprocessor indentation 2019-09-11 11:22:18 +02:00
trace.c Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
uid.c
vms_rms.h
x86_64cpuid.pl Unify all assembler file generators 2019-09-16 16:29:57 +02:00
x86cpuid.pl Unify all assembler file generators 2019-09-16 16:29:57 +02:00

The sparse_array.c file contains an implementation of a sparse array that
attempts to be both space and time efficient.

The sparse array is represented using a tree structure.  Each node in the
tree contains a block of pointers to either the user supplied leaf values or
to another node.

There are a number of parameters used to define the block size:

    OPENSSL_SA_BLOCK_BITS   Specifies the number of bits covered by each block
    SA_BLOCK_MAX            Specifies the number of pointers in each block
    SA_BLOCK_MASK           Specifies a bit mask to perform modulo block size
    SA_BLOCK_MAX_LEVELS     Indicates the maximum possible height of the tree

These constants are inter-related:
    SA_BLOCK_MAX        = 2 ^ OPENSSL_SA_BLOCK_BITS
    SA_BLOCK_MASK       = SA_BLOCK_MAX - 1
    SA_BLOCK_MAX_LEVELS = number of bits in size_t divided by
                          OPENSSL_SA_BLOCK_BITS rounded up to the next multiple
                          of OPENSSL_SA_BLOCK_BITS

OPENSSL_SA_BLOCK_BITS can be defined at compile time and this overrides the
built in setting.

As a space and performance optimisation, the height of the tree is usually
less than the maximum possible height.  Only sufficient height is allocated to
accommodate the largest index added to the data structure.

The largest index used to add a value to the array determines the tree height:

        +----------------------+---------------------+
        | Largest Added Index  |   Height of Tree    |
        +----------------------+---------------------+
        | SA_BLOCK_MAX     - 1 |          1          |
        | SA_BLOCK_MAX ^ 2 - 1 |          2          |
        | SA_BLOCK_MAX ^ 3 - 1 |          3          |
        | ...                  |          ...        |
        | size_t max           | SA_BLOCK_MAX_LEVELS |
        +----------------------+---------------------+

The tree height is dynamically increased as needed based on additions.

An empty tree is represented by a NULL root pointer.  Inserting a value at
index 0 results in the allocation of a top level node full of null pointers
except for the single pointer to the user's data (N = SA_BLOCK_MAX for
brevity):

        +----+
        |Root|
        |Node|
        +-+--+
          |
          |
          |
          v
        +-+-+---+---+---+---+
        | 0 | 1 | 2 |...|N-1|
        |   |nil|nil|...|nil|
        +-+-+---+---+---+---+
          |
          |
          |
          v
        +-+--+
        |User|
        |Data|
        +----+
    Index 0


Inserting at element 2N+1 creates a new root node and pushes down the old root
node.  It then creates a second second level node to hold the pointer to the
user's new data:

        +----+
        |Root|
        |Node|
        +-+--+
          |
          |
          |
          v
        +-+-+---+---+---+---+
        | 0 | 1 | 2 |...|N-1|
        |   |nil|   |...|nil|
        +-+-+---+-+-+---+---+
          |       |
          |       +------------------+
          |                          |
          v                          v
        +-+-+---+---+---+---+      +-+-+---+---+---+---+
        | 0 | 1 | 2 |...|N-1|      | 0 | 1 | 2 |...|N-1|
        |nil|   |nil|...|nil|      |nil|   |nil|...|nil|
        +-+-+---+---+---+---+      +---+-+-+---+---+---+
          |                              |
          |                              |
          |                              |
          v                              v
        +-+--+                         +-+--+
        |User|                         |User|
        |Data|                         |Data|
        +----+                         +----+
    Index 0                       Index 2N+1


The nodes themselves are allocated in a sparse manner.  Only nodes which exist
along a path from the root of the tree to an added leaf will be allocated.
The complexity is hidden and nodes are allocated on an as needed basis.
Because the data is expected to be sparse this doesn't result in a large waste
of space.

Values can be removed from the sparse array by setting their index position to
NULL.  The data structure does not attempt to reclaim nodes or reduce the
height of the tree on removal.  For example, now setting index 0 to NULL would
result in:

        +----+
        |Root|
        |Node|
        +-+--+
          |
          |
          |
          v
        +-+-+---+---+---+---+
        | 0 | 1 | 2 |...|N-1|
        |   |nil|   |...|nil|
        +-+-+---+-+-+---+---+
          |       |
          |       +------------------+
          |                          |
          v                          v
        +-+-+---+---+---+---+      +-+-+---+---+---+---+
        | 0 | 1 | 2 |...|N-1|      | 0 | 1 | 2 |...|N-1|
        |nil|nil|nil|...|nil|      |nil|   |nil|...|nil|
        +---+---+---+---+---+      +---+-+-+---+---+---+
                                         |
                                         |
                                         |
                                         v
                                       +-+--+
                                       |User|
                                       |Data|
                                       +----+
                                  Index 2N+1


Accesses to elements in the sparse array take O(log n) time where n is the
largest element.  The base of the logarithm is SA_BLOCK_MAX, so for moderately
small indices (e.g. NIDs), single level (constant time) access is achievable.
Space usage is O(minimum(m, n log(n)) where m is the number of elements in the
array.

Note: sparse arrays only include pointers to types.  Thus, SPARSE_ARRAY_OF(char)
can be used to store a string.