1DH_METH_NEW(3ossl)                  OpenSSL                 DH_METH_NEW(3ossl)
2
3
4

NAME

6       DH_meth_new, DH_meth_free, DH_meth_dup, DH_meth_get0_name,
7       DH_meth_set1_name, DH_meth_get_flags, DH_meth_set_flags,
8       DH_meth_get0_app_data, DH_meth_set0_app_data, DH_meth_get_generate_key,
9       DH_meth_set_generate_key, DH_meth_get_compute_key,
10       DH_meth_set_compute_key, DH_meth_get_bn_mod_exp,
11       DH_meth_set_bn_mod_exp, DH_meth_get_init, DH_meth_set_init,
12       DH_meth_get_finish, DH_meth_set_finish, DH_meth_get_generate_params,
13       DH_meth_set_generate_params - Routines to build up DH methods
14

SYNOPSIS

16        #include <openssl/dh.h>
17
18       The following functions have been deprecated since OpenSSL 3.0, and can
19       be hidden entirely by defining OPENSSL_API_COMPAT with a suitable
20       version value, see openssl_user_macros(7):
21
22        DH_METHOD *DH_meth_new(const char *name, int flags);
23
24        void DH_meth_free(DH_METHOD *dhm);
25
26        DH_METHOD *DH_meth_dup(const DH_METHOD *dhm);
27
28        const char *DH_meth_get0_name(const DH_METHOD *dhm);
29        int DH_meth_set1_name(DH_METHOD *dhm, const char *name);
30
31        int DH_meth_get_flags(const DH_METHOD *dhm);
32        int DH_meth_set_flags(DH_METHOD *dhm, int flags);
33
34        void *DH_meth_get0_app_data(const DH_METHOD *dhm);
35        int DH_meth_set0_app_data(DH_METHOD *dhm, void *app_data);
36
37        int (*DH_meth_get_generate_key(const DH_METHOD *dhm))(DH *);
38        int DH_meth_set_generate_key(DH_METHOD *dhm, int (*generate_key)(DH *));
39
40        int (*DH_meth_get_compute_key(const DH_METHOD *dhm))
41            (unsigned char *key, const BIGNUM *pub_key, DH *dh);
42        int DH_meth_set_compute_key(DH_METHOD *dhm,
43            int (*compute_key)(unsigned char *key, const BIGNUM *pub_key, DH *dh));
44
45        int (*DH_meth_get_bn_mod_exp(const DH_METHOD *dhm))
46            (const DH *dh, BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
47             const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
48        int DH_meth_set_bn_mod_exp(DH_METHOD *dhm,
49            int (*bn_mod_exp)(const DH *dh, BIGNUM *r, const BIGNUM *a,
50                              const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
51                              BN_MONT_CTX *m_ctx));
52
53        int (*DH_meth_get_init(const DH_METHOD *dhm))(DH *);
54        int DH_meth_set_init(DH_METHOD *dhm, int (*init)(DH *));
55
56        int (*DH_meth_get_finish(const DH_METHOD *dhm))(DH *);
57        int DH_meth_set_finish(DH_METHOD *dhm, int (*finish)(DH *));
58
59        int (*DH_meth_get_generate_params(const DH_METHOD *dhm))
60            (DH *, int, int, BN_GENCB *);
61        int DH_meth_set_generate_params(DH_METHOD *dhm,
62            int (*generate_params)(DH *, int, int, BN_GENCB *));
63

DESCRIPTION

65       All of the functions described on this page are deprecated.
66       Applications should instead use the provider APIs.
67
68       The DH_METHOD type is a structure used for the provision of custom DH
69       implementations. It provides a set of functions used by OpenSSL for the
70       implementation of the various DH capabilities.
71
72       DH_meth_new() creates a new DH_METHOD structure. It should be given a
73       unique name and a set of flags. The name should be a NULL terminated
74       string, which will be duplicated and stored in the DH_METHOD object. It
75       is the callers responsibility to free the original string. The flags
76       will be used during the construction of a new DH object based on this
77       DH_METHOD. Any new DH object will have those flags set by default.
78
79       DH_meth_dup() creates a duplicate copy of the DH_METHOD object passed
80       as a parameter. This might be useful for creating a new DH_METHOD based
81       on an existing one, but with some differences.
82
83       DH_meth_free() destroys a DH_METHOD structure and frees up any memory
84       associated with it.
85
86       DH_meth_get0_name() will return a pointer to the name of this
87       DH_METHOD. This is a pointer to the internal name string and so should
88       not be freed by the caller. DH_meth_set1_name() sets the name of the
89       DH_METHOD to name. The string is duplicated and the copy is stored in
90       the DH_METHOD structure, so the caller remains responsible for freeing
91       the memory associated with the name.
92
93       DH_meth_get_flags() returns the current value of the flags associated
94       with this DH_METHOD. DH_meth_set_flags() provides the ability to set
95       these flags.
96
97       The functions DH_meth_get0_app_data() and DH_meth_set0_app_data()
98       provide the ability to associate implementation specific data with the
99       DH_METHOD. It is the application's responsibility to free this data
100       before the DH_METHOD is freed via a call to DH_meth_free().
101
102       DH_meth_get_generate_key() and DH_meth_set_generate_key() get and set
103       the function used for generating a new DH key pair respectively. This
104       function will be called in response to the application calling
105       DH_generate_key(). The parameter for the function has the same meaning
106       as for DH_generate_key().
107
108       DH_meth_get_compute_key() and DH_meth_set_compute_key() get and set the
109       function used for computing a new DH shared secret respectively. This
110       function will be called in response to the application calling
111       DH_compute_key(). The parameters for the function have the same meaning
112       as for DH_compute_key().
113
114       DH_meth_get_bn_mod_exp() and DH_meth_set_bn_mod_exp() get and set the
115       function used for computing the following value:
116
117        r = a ^ p mod m
118
119       This function will be called by the default OpenSSL function for
120       DH_generate_key(). The result is stored in the r parameter. This
121       function may be NULL unless using the default generate key function, in
122       which case it must be present.
123
124       DH_meth_get_init() and DH_meth_set_init() get and set the function used
125       for creating a new DH instance respectively. This function will be
126       called in response to the application calling DH_new() (if the current
127       default DH_METHOD is this one) or DH_new_method(). The DH_new() and
128       DH_new_method() functions will allocate the memory for the new DH
129       object, and a pointer to this newly allocated structure will be passed
130       as a parameter to the function. This function may be NULL.
131
132       DH_meth_get_finish() and DH_meth_set_finish() get and set the function
133       used for destroying an instance of a DH object respectively. This
134       function will be called in response to the application calling
135       DH_free(). A pointer to the DH to be destroyed is passed as a
136       parameter. The destroy function should be used for DH implementation
137       specific clean up. The memory for the DH itself should not be freed by
138       this function. This function may be NULL.
139
140       DH_meth_get_generate_params() and DH_meth_set_generate_params() get and
141       set the function used for generating DH parameters respectively. This
142       function will be called in response to the application calling
143       DH_generate_parameters_ex() (or DH_generate_parameters()). The
144       parameters for the function have the same meaning as for
145       DH_generate_parameters_ex(). This function may be NULL.
146

RETURN VALUES

148       DH_meth_new() and DH_meth_dup() return the newly allocated DH_METHOD
149       object or NULL on failure.
150
151       DH_meth_get0_name() and DH_meth_get_flags() return the name and flags
152       associated with the DH_METHOD respectively.
153
154       All other DH_meth_get_*() functions return the appropriate function
155       pointer that has been set in the DH_METHOD, or NULL if no such pointer
156       has yet been set.
157
158       DH_meth_set1_name() and all DH_meth_set_*() functions return 1 on
159       success or 0 on failure.
160

SEE ALSO

162       DH_new(3), DH_new(3), DH_generate_parameters(3), DH_generate_key(3),
163       DH_set_method(3), DH_size(3), DH_get0_pqg(3)
164

HISTORY

166       All of these functions were deprecated in OpenSSL 3.0.
167
168       The functions described here were added in OpenSSL 1.1.0.
169
171       Copyright 2016-2021 The OpenSSL Project Authors. All Rights Reserved.
172
173       Licensed under the Apache License 2.0 (the "License").  You may not use
174       this file except in compliance with the License.  You can obtain a copy
175       in the file LICENSE in the source distribution or at
176       <https://www.openssl.org/source/license.html>.
177
178
179
1803.0.5                             2022-11-01                DH_METH_NEW(3ossl)
Impressum