xref: /aosp_15_r20/external/boringssl/src/crypto/fipsmodule/dh/internal.h (revision 8fb009dc861624b67b6cdb62ea21f0f22d0c584b)
1 /* Copyright (c) 2022, Google Inc.
2  *
3  * Permission to use, copy, modify, and/or distribute this software for any
4  * purpose with or without fee is hereby granted, provided that the above
5  * copyright notice and this permission notice appear in all copies.
6  *
7  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
10  * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
12  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
13  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */
14 
15 #ifndef OPENSSL_HEADER_CRYPTO_FIPSMODULE_DH_INTERNAL_H
16 #define OPENSSL_HEADER_CRYPTO_FIPSMODULE_DH_INTERNAL_H
17 
18 #include <openssl/base.h>
19 
20 #include <openssl/thread.h>
21 
22 #include "../../internal.h"
23 
24 #if defined(__cplusplus)
25 extern "C" {
26 #endif
27 
28 
29 #define OPENSSL_DH_MAX_MODULUS_BITS 10000
30 
31 struct dh_st {
32   BIGNUM *p;
33   BIGNUM *g;
34   BIGNUM *q;
35   BIGNUM *pub_key;   // g^x mod p
36   BIGNUM *priv_key;  // x
37 
38   // priv_length contains the length, in bits, of the private value. If zero,
39   // the private value will be the same length as |p|.
40   unsigned priv_length;
41 
42   CRYPTO_MUTEX method_mont_p_lock;
43   BN_MONT_CTX *method_mont_p;
44 
45   int flags;
46   CRYPTO_refcount_t references;
47 };
48 
49 // dh_check_params_fast checks basic invariants on |dh|'s domain parameters. It
50 // does not check that |dh| forms a valid group, only that the sizes are within
51 // DoS bounds.
52 int dh_check_params_fast(const DH *dh);
53 
54 // dh_compute_key_padded_no_self_test does the same as |DH_compute_key_padded|,
55 // but doesn't try to run the self-test first. This is for use in the self tests
56 // themselves, to prevent an infinite loop.
57 int dh_compute_key_padded_no_self_test(unsigned char *out,
58                                        const BIGNUM *peers_key, DH *dh);
59 
60 
61 #if defined(__cplusplus)
62 }
63 #endif
64 
65 #endif  // OPENSSL_HEADER_CRYPTO_FIPSMODULE_DH_INTERNAL_H
66