xref: /freebsd/crypto/openssh/dh.h (revision 848ee2a3a8b47c9905fc51fefcf60eb371edbb98)
1 /* $OpenBSD: dh.h,v 1.19 2021/03/12 04:08:19 dtucker Exp $ */
2 
3 /*
4  * Copyright (c) 2000 Niels Provos.  All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26 #ifndef DH_H
27 #define DH_H
28 
29 #ifdef WITH_OPENSSL
30 
31 struct dhgroup {
32 	int size;
33 	BIGNUM *g;
34 	BIGNUM *p;
35 };
36 
37 DH	*choose_dh(int, int, int);
38 DH	*dh_new_group_asc(const char *, const char *);
39 DH	*dh_new_group(BIGNUM *, BIGNUM *);
40 DH	*dh_new_group1(void);
41 DH	*dh_new_group14(void);
42 DH	*dh_new_group16(void);
43 DH	*dh_new_group18(void);
44 DH	*dh_new_group_fallback(int);
45 
46 int	 dh_gen_key(DH *, int);
47 int	 dh_pub_is_valid(const DH *, const BIGNUM *);
48 
49 u_int	 dh_estimate(int);
50 void	 dh_set_moduli_file(const char *);
51 
52 /*
53  * Max value from RFC4419.
54  * Min value from RFC8270.
55  */
56 #define DH_GRP_MIN	2048
57 #define DH_GRP_MAX	8192
58 
59 /*
60  * Values for "type" field of moduli(5)
61  * Specifies the internal structure of the prime modulus.
62  */
63 #define MODULI_TYPE_UNKNOWN		(0)
64 #define MODULI_TYPE_UNSTRUCTURED	(1)
65 #define MODULI_TYPE_SAFE		(2)
66 #define MODULI_TYPE_SCHNORR		(3)
67 #define MODULI_TYPE_SOPHIE_GERMAIN	(4)
68 #define MODULI_TYPE_STRONG		(5)
69 
70 /*
71  * Values for "tests" field of moduli(5)
72  * Specifies the methods used in checking for primality.
73  * Usually, more than one test is used.
74  */
75 #define MODULI_TESTS_UNTESTED		(0x00)
76 #define MODULI_TESTS_COMPOSITE		(0x01)
77 #define MODULI_TESTS_SIEVE		(0x02)
78 #define MODULI_TESTS_MILLER_RABIN	(0x04)
79 #define MODULI_TESTS_JACOBI		(0x08)
80 #define MODULI_TESTS_ELLIPTIC		(0x10)
81 
82 #endif /* WITH_OPENSSL */
83 
84 #endif /* DH_H */
85