Standard preamble:
========================================================================
..
.... Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.
If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.
Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================
Title "DH_METH_NEW 3ossl"
way too many mistakes in technical documents.
The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defining \s-1OPENSSL_API_COMPAT\s0 with a suitable version value, see openssl_user_macros\|(7):
.Vb 1 DH_METHOD *DH_meth_new(const char *name, int flags); \& void DH_meth_free(DH_METHOD *dhm); \& DH_METHOD *DH_meth_dup(const DH_METHOD *dhm); \& const char *DH_meth_get0_name(const DH_METHOD *dhm); int DH_meth_set1_name(DH_METHOD *dhm, const char *name); \& int DH_meth_get_flags(const DH_METHOD *dhm); int DH_meth_set_flags(DH_METHOD *dhm, int flags); \& void *DH_meth_get0_app_data(const DH_METHOD *dhm); int DH_meth_set0_app_data(DH_METHOD *dhm, void *app_data); \& int (*DH_meth_get_generate_key(const DH_METHOD *dhm))(DH *); int DH_meth_set_generate_key(DH_METHOD *dhm, int (*generate_key)(DH *)); \& int (*DH_meth_get_compute_key(const DH_METHOD *dhm)) (unsigned char *key, const BIGNUM *pub_key, DH *dh); int DH_meth_set_compute_key(DH_METHOD *dhm, int (*compute_key)(unsigned char *key, const BIGNUM *pub_key, DH *dh)); \& int (*DH_meth_get_bn_mod_exp(const DH_METHOD *dhm)) (const DH *dh, BIGNUM *r, const BIGNUM *a, const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx); int DH_meth_set_bn_mod_exp(DH_METHOD *dhm, int (*bn_mod_exp)(const DH *dh, BIGNUM *r, const BIGNUM *a, const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)); \& int (*DH_meth_get_init(const DH_METHOD *dhm))(DH *); int DH_meth_set_init(DH_METHOD *dhm, int (*init)(DH *)); \& int (*DH_meth_get_finish(const DH_METHOD *dhm))(DH *); int DH_meth_set_finish(DH_METHOD *dhm, int (*finish)(DH *)); \& int (*DH_meth_get_generate_params(const DH_METHOD *dhm)) (DH *, int, int, BN_GENCB *); int DH_meth_set_generate_params(DH_METHOD *dhm, int (*generate_params)(DH *, int, int, BN_GENCB *)); .Ve
The \s-1DH_METHOD\s0 type is a structure used for the provision of custom \s-1DH\s0 implementations. It provides a set of functions used by OpenSSL for the implementation of the various \s-1DH\s0 capabilities.
\fBDH_meth_new() creates a new \s-1DH_METHOD\s0 structure. It should be given a unique name and a set of flags. The name should be a \s-1NULL\s0 terminated string, which will be duplicated and stored in the \s-1DH_METHOD\s0 object. It is the callers responsibility to free the original string. The flags will be used during the construction of a new \s-1DH\s0 object based on this \s-1DH_METHOD\s0. Any new \s-1DH\s0 object will have those flags set by default.
\fBDH_meth_dup() creates a duplicate copy of the \s-1DH_METHOD\s0 object passed as a parameter. This might be useful for creating a new \s-1DH_METHOD\s0 based on an existing one, but with some differences.
\fBDH_meth_free() destroys a \s-1DH_METHOD\s0 structure and frees up any memory associated with it.
\fBDH_meth_get0_name() will return a pointer to the name of this \s-1DH_METHOD.\s0 This is a pointer to the internal name string and so should not be freed by the caller. DH_meth_set1_name() sets the name of the \s-1DH_METHOD\s0 to name. The string is duplicated and the copy is stored in the \s-1DH_METHOD\s0 structure, so the caller remains responsible for freeing the memory associated with the name.
\fBDH_meth_get_flags() returns the current value of the flags associated with this \s-1DH_METHOD.\s0 DH_meth_set_flags() provides the ability to set these flags.
The functions DH_meth_get0_app_data() and DH_meth_set0_app_data() provide the ability to associate implementation specific data with the \s-1DH_METHOD.\s0 It is the application's responsibility to free this data before the \s-1DH_METHOD\s0 is freed via a call to DH_meth_free().
\fBDH_meth_get_generate_key() and DH_meth_set_generate_key() get and set the function used for generating a new \s-1DH\s0 key pair respectively. This function will be called in response to the application calling DH_generate_key(). The parameter for the function has the same meaning as for DH_generate_key().
\fBDH_meth_get_compute_key() and DH_meth_set_compute_key() get and set the function used for computing a new \s-1DH\s0 shared secret respectively. This function will be called in response to the application calling DH_compute_key(). The parameters for the function have the same meaning as for DH_compute_key().
\fBDH_meth_get_bn_mod_exp() and DH_meth_set_bn_mod_exp() get and set the function used for computing the following value:
.Vb 1 r = a ^ p mod m .Ve
This function will be called by the default OpenSSL function for \fBDH_generate_key(). The result is stored in the r parameter. This function may be \s-1NULL\s0 unless using the default generate key function, in which case it must be present.
\fBDH_meth_get_init() and DH_meth_set_init() get and set the function used for creating a new \s-1DH\s0 instance respectively. This function will be called in response to the application calling DH_new() (if the current default \s-1DH_METHOD\s0 is this one) or DH_new_method(). The DH_new() and DH_new_method() functions will allocate the memory for the new \s-1DH\s0 object, and a pointer to this newly allocated structure will be passed as a parameter to the function. This function may be \s-1NULL.\s0
\fBDH_meth_get_finish() and DH_meth_set_finish() get and set the function used for destroying an instance of a \s-1DH\s0 object respectively. This function will be called in response to the application calling DH_free(). A pointer to the \s-1DH\s0 to be destroyed is passed as a parameter. The destroy function should be used for \s-1DH\s0 implementation specific clean up. The memory for the \s-1DH\s0 itself should not be freed by this function. This function may be \s-1NULL.\s0
\fBDH_meth_get_generate_params() and DH_meth_set_generate_params() get and set the function used for generating \s-1DH\s0 parameters respectively. This function will be called in response to the application calling DH_generate_parameters_ex() (or \fBDH_generate_parameters()). The parameters for the function have the same meaning as for DH_generate_parameters_ex(). This function may be \s-1NULL.\s0
\fBDH_meth_get0_name() and DH_meth_get_flags() return the name and flags associated with the \s-1DH_METHOD\s0 respectively.
All other DH_meth_get_*() functions return the appropriate function pointer that has been set in the \s-1DH_METHOD,\s0 or \s-1NULL\s0 if no such pointer has yet been set.
\fBDH_meth_set1_name() and all DH_meth_set_*() functions return 1 on success or 0 on failure.
The functions described here were added in OpenSSL 1.1.0.
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.