openssl/crypto
Billy Brumley e0033efc30 SCA hardening for mod. field inversion in EC_GROUP
This commit adds a dedicated function in `EC_METHOD` to access a modular
field inversion implementation suitable for the specifics of the
implemented curve, featuring SCA countermeasures.

The new pointer is defined as:
`int (*field_inv)(const EC_GROUP*, BIGNUM *r, const BIGNUM *a, BN_CTX*)`
and computes the multiplicative inverse of `a` in the underlying field,
storing the result in `r`.

Three implementations are included, each including specific SCA
countermeasures:
  - `ec_GFp_simple_field_inv()`, featuring SCA hardening through
    blinding.
  - `ec_GFp_mont_field_inv()`, featuring SCA hardening through Fermat's
    Little Theorem (FLT) inversion.
  - `ec_GF2m_simple_field_inv()`, that uses `BN_GF2m_mod_inv()` which
    already features SCA hardening through blinding.

From a security point of view, this also helps addressing a leakage
previously affecting conversions from projective to affine coordinates.

This commit also adds a new error reason code (i.e.,
`EC_R_CANNOT_INVERT`) to improve consistency between the three
implementations as all of them could fail for the same reason but
through different code paths resulting in inconsistent error stack
states.

Co-authored-by: Nicola Tuveri <nic.tuv@gmail.com>

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Nicola Tuveri <nic.tuv@gmail.com>
(Merged from https://github.com/openssl/openssl/pull/8254)
2019-02-17 21:02:36 +02:00
..
aes ARM64 assembly pack: make it Windows-friendly. 2019-02-16 17:01:15 +01:00
aria Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
asn1 Fix d2i_PublicKey() for EC keys 2019-02-08 09:57:26 +00:00
async add an additional async notification communication method based on callback 2019-01-27 12:27:17 +00:00
bf Following the license change, modify the boilerplates in crypto/bf/ 2018-12-06 14:27:41 +01:00
bio Cleanup vxworks support to be able to compile for VxWorks 7 2019-01-24 17:55:04 +01:00
blake2 blake2: avoid writing to output buffer when using default digest length 2019-02-06 09:24:28 +00:00
bn ARM64 assembly pack: make it Windows-friendly. 2019-02-16 17:01:15 +01:00
buffer Following the license change, modify the boilerplates in crypto/buffer/ 2018-12-06 14:32:34 +01:00
camellia Following the license change, modify the boilerplates in crypto/camellia/ 2018-12-06 14:34:55 +01:00
cast Following the license change, modify the boilerplates in crypto/cast/ 2018-12-06 14:36:10 +01:00
chacha ARM64 assembly pack: make it Windows-friendly. 2019-02-16 17:01:15 +01:00
cmac Following the license change, modify the boilerplates in crypto/cmac/ 2018-12-06 14:39:25 +01:00
cms Fix null pointer dereference in cms_RecipientInfo_kari_init 2019-02-13 14:26:14 +08:00
comp Following the license change, modify the boilerplates in crypto/comp/ 2018-12-06 14:42:18 +01:00
conf Allow the syntax of the .include directive to optionally have '=' 2019-02-11 15:24:12 +01:00
ct Following the license change, modify the boilerplates in crypto/ct/ 2018-12-06 14:44:27 +01:00
des Remove unnecessary trailing whitespace 2019-02-05 16:25:11 +01:00
dh Following the license change, modify the boilerplates in crypto/dh/ 2018-12-06 14:47:24 +01:00
dsa Document and add macros for additional DSA options 2019-01-30 10:04:47 -06:00
dso Fix compilation with -DREF_PRINT 2019-01-13 18:30:38 +01:00
ec SCA hardening for mod. field inversion in EC_GROUP 2019-02-17 21:02:36 +02:00
engine e_devcrypto: make the /dev/crypto engine dynamic 2019-02-12 20:06:00 +01:00
err SCA hardening for mod. field inversion in EC_GROUP 2019-02-17 21:02:36 +02:00
ess crypto/cms: Add support for CAdES Basic Electronic Signatures (CAdES-BES) 2019-01-27 23:59:21 +01:00
evp Added new EVP/KDF API. 2019-02-13 12:11:49 +01:00
gmac Following the license change, modify the boilerplates in crypto/gmac/ 2018-12-06 15:00:48 +01:00
hmac Following the license change, modify the boilerplates in crypto/hmac/ 2018-12-06 15:01:38 +01:00
idea Following the license change, modify the boilerplates in crypto/idea/ 2018-12-06 14:56:39 +01:00
include/internal Mark generated functions unused (applies to safestack, lhash, sparse_array) 2019-02-15 11:44:35 +01:00
kdf Added new EVP/KDF API. 2019-02-13 12:11:49 +01:00
kmac Update kmac.c 2018-12-08 11:00:18 +01:00
lhash Following the license change, modify the boilerplates in crypto/lhash/ 2018-12-06 15:02:41 +01:00
md2 Following the license change, modify the boilerplates in crypto/mdN/ 2018-12-06 15:04:11 +01:00
md4 Following the license change, modify the boilerplates in crypto/mdN/ 2018-12-06 15:04:11 +01:00
md5 Following the license change, modify the boilerplates in crypto/mdN/ 2018-12-06 15:04:11 +01:00
mdc2 Following the license change, modify the boilerplates in crypto/mdc2/ 2018-12-06 15:04:57 +01:00
modes ARM assembly pack: make it Windows-friendly. 2019-02-16 16:59:23 +01:00
objects blake2: register MAC objects 2019-02-06 09:18:43 +00:00
ocsp Following the license change, modify the boilerplates in crypto/ocsp/ 2018-12-06 15:08:20 +01:00
pem Remove unnecessary trailing whitespace 2019-02-05 16:25:11 +01:00
perlasm ARM64 assembly pack: make it Windows-friendly. 2019-02-16 17:01:15 +01:00
pkcs7 Following the license change, modify the boilerplates in crypto/pkcs7/ 2018-12-06 15:12:24 +01:00
pkcs12 Following the license change, modify the boilerplates in crypto/pkcs12/ 2018-12-06 15:11:42 +01:00
poly1305 ARM64 assembly pack: make it Windows-friendly. 2019-02-16 17:01:15 +01:00
rand Cleanup vxworks support to be able to compile for VxWorks 7 2019-01-24 17:55:04 +01:00
rc2 Following the license change, modify the boilerplates in crypto/rcN/ 2018-12-06 15:14:57 +01:00
rc4 Build: correct assembler generation in crypto/rc4/build.info 2019-02-04 21:34:32 +01:00
rc5 Following the license change, modify the boilerplates in crypto/rcN/ 2018-12-06 15:14:57 +01:00
ripemd Following the license change, modify the boilerplates in crypto/ripemd/ 2018-12-06 15:15:42 +01:00
rsa Fix comment typo 2019-02-11 11:27:01 +10:00
seed Following the license change, modify the boilerplates in crypto/seed/ 2018-12-06 15:22:15 +01:00
sha ARM64 assembly pack: make it Windows-friendly. 2019-02-16 17:01:15 +01:00
siphash Following the license change, modify the boilerplates in crypto/siphash/ 2018-12-06 15:24:02 +01:00
sm2 Following the license change, modify the boilerplates in crypto/smN/ 2018-12-06 15:24:52 +01:00
sm3 Following the license change, modify the boilerplates in crypto/smN/ 2018-12-06 15:24:52 +01:00
sm4 Following the license change, modify the boilerplates in crypto/smN/ 2018-12-06 15:24:52 +01:00
srp Remove unnecessary trailing whitespace 2019-02-05 16:25:11 +01:00
stack Following the license change, modify the boilerplates in crypto/stack/ 2018-12-06 15:26:59 +01:00
store Following the license change, modify the boilerplates in crypto/store/ 2018-12-06 15:27:43 +01:00
ts crypto/cms: Add support for CAdES Basic Electronic Signatures (CAdES-BES) 2019-01-27 23:59:21 +01:00
txt_db Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
ui Cleanup vxworks support to be able to compile for VxWorks 7 2019-01-24 17:55:04 +01:00
whrlpool Following the license change, modify the boilerplates in crypto/whrlpool/ 2018-12-06 15:29:22 +01:00
x509 Fix a crash in reuse of i2d_X509_PUBKEY 2019-01-31 19:24:07 +01:00
x509v3 X509_check_issued: check that signature algo matches signing key algo 2018-12-19 13:33:54 +01:00
alphacpuid.pl Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
arm64cpuid.pl Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
arm_arch.h Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
armcap.c crypto/armcap.c, crypto/ppccap.c: stricter use of getauxval() 2019-01-16 18:00:48 +01:00
armv4cpuid.pl ARM assembly pack: make it Windows-friendly. 2019-02-16 16:59:23 +01:00
build.info Add an OpenSSL library context 2019-02-16 00:29:42 +01:00
c64xpluscpuid.pl Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
context.c Add an OpenSSL library context 2019-02-16 00:29:42 +01:00
cpt_err.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
cryptlib.c Remove unnecessary trailing whitespace 2019-02-05 16:25:11 +01:00
ctype.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
cversion.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
dllmain.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
ebcdic.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
ex_data.c Add CRYPTO_alloc_ex_data() 2019-02-16 00:29:20 +01:00
getenv.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
ia64cpuid.S Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
init.c e_devcrypto: make the /dev/crypto engine dynamic 2019-02-12 20:06:00 +01:00
LPdir_nyi.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
LPdir_unix.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
LPdir_vms.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
LPdir_win.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
LPdir_win32.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
LPdir_wince.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
mem.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
mem_clr.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
mem_dbg.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
mem_sec.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
mips_arch.h Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
o_dir.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
o_fips.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
o_fopen.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
o_init.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
o_str.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
o_time.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
pariscid.pl Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
ppc_arch.h PPC: Try out if mftb works before using it 2019-01-21 15:42:04 +01:00
ppccap.c poly1305/asm/poly1305-ppc.pl: add vector base 2^26 implementation. 2019-02-01 09:23:25 +01:00
ppccpuid.pl PPC: Try out if mftb works before using it 2019-01-21 15:42:04 +01:00
README.sparse_array Add sparse array data type. 2019-02-12 21:07:29 +10:00
s390x_arch.h Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
s390xcap.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
s390xcpuid.pl Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
sparc_arch.h Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
sparccpuid.S Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
sparcv9cap.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
sparse_array.c Sparse array iterators include index position. 2019-02-14 09:09:51 +10:00
threads_none.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
threads_pthread.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
threads_win.c Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
uid.c crypto/uid.c: use own macro as guard rather than AT_SECURE 2019-01-16 06:19:17 +01:00
vms_rms.h Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
x86_64cpuid.pl Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01:00
x86cpuid.pl Following the license change, modify the boilerplates in crypto/ 2018-12-06 15:32:17 +01: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
breviety):

        +----+
        |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.