doc/crypto/DH_meth_new.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 DH_meth_new, DH_meth_free, DH_meth_dup, DH_meth_get0_name, DH_meth_set1_name,
   6 DH_meth_get_flags, DH_meth_set_flags, DH_meth_get0_app_data,
   7 DH_meth_set0_app_data, DH_meth_get_generate_key, DH_meth_set_generate_key,
   8 DH_meth_get_compute_key, DH_meth_set_compute_key, DH_meth_get_bn_mod_exp,
   9 DH_meth_set_bn_mod_exp, DH_meth_get_init, DH_meth_set_init, DH_meth_get_finish,
  10 DH_meth_set_finish, DH_meth_get_generate_params,
  11 DH_meth_set_generate_params - Routines to build up DH methods
  12
  13 =head1 SYNOPSIS
  14
  15  #include <openssl/dh.h>
  16
  17  DH_METHOD *DH_meth_new(const char *name, int flags);
  18  void DH_meth_free(DH_METHOD *dhm);
  19  DH_METHOD *DH_meth_dup(const DH_METHOD *dhm);
  20  const char *DH_meth_get0_name(const DH_METHOD *dhm);
  21  int DH_meth_set1_name(DH_METHOD *dhm, const char *name);
  22  int DH_meth_get_flags(DH_METHOD *dhm);
  23  int DH_meth_set_flags(DH_METHOD *dhm, int flags);
  24  void *DH_meth_get0_app_data(const DH_METHOD *dhm);
  25  int DH_meth_set0_app_data(DH_METHOD *dhm, void *app_data);
  26  int (*DH_meth_get_generate_key(const DH_METHOD *dhm)) (DH *);
  27  int DH_meth_set_generate_key(DH_METHOD *dhm, int (*generate_key) (DH *));
  28  int (*DH_meth_get_compute_key(const DH_METHOD *dhm))
  29          (unsigned char *key, const BIGNUM *pub_key, DH *dh);
  30  int DH_meth_set_compute_key(DH_METHOD *dhm,
  31          int (*compute_key) (unsigned char *key, const BIGNUM *pub_key, DH *dh));
  32  int (*DH_meth_get_bn_mod_exp(const DH_METHOD *dhm))
  33      (const DH *dh, BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
  34       const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
  35  int DH_meth_set_bn_mod_exp(DH_METHOD *dhm,
  36      int (*bn_mod_exp) (const DH *dh, BIGNUM *r, const BIGNUM *a,
  37                         const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
  38                         BN_MONT_CTX *m_ctx));
  39  int (*DH_meth_get_init(const DH_METHOD *dhm))(DH *);
  40  int DH_meth_set_init(DH_METHOD *dhm, int (*init)(DH *));
  41  int (*DH_meth_get_finish(const DH_METHOD *dhm)) (DH *);
  42  int DH_meth_set_finish(DH_METHOD *dhm, int (*finish) (DH *));
  43  int (*DH_meth_get_generate_params(const DH_METHOD *dhm))
  44          (DH *, int, int, BN_GENCB *);
  45  int DH_meth_set_generate_params(DH_METHOD *dhm,
  46          int (*generate_params) (DH *, int, int, BN_GENCB *));
  47
  48 =head1 DESCRIPTION
  49
  50 The B<DH_METHOD> type is a structure used for the provision of custom DH
  51 implementations. It provides a set of of functions used by OpenSSL for the
  52 implementation of the various DH capabilities. See the L<dh(3)> page for more
  53 information.
  54
  55 DH_meth_new() creates a new B<DH_METHOD> structure. It should be given a
  56 unique B<name> and a set of B<flags>. The B<name> should be a NULL terminated
  57 string, which will be duplicated and stored in the B<DH_METHOD> object. It is
  58 the callers responsibility to free the original string. The flags will be used
  59 during the construction of a new B<DH> object based on this B<DH_METHOD>. Any
  60 new B<DH> object will have those flags set by default.
  61
  62 DH_meth_dup() creates a duplicate copy of the B<DH_METHOD> object passed as a
  63 parameter. This might be useful for creating a new B<DH_METHOD> based on an
  64 existing one, but with some differences.
  65
  66 DH_meth_free() destroys a B<DH_METHOD> structure and frees up any memory
  67 associated with it.
  68
  69 DH_meth_get0_name() will return a pointer to the name of this DH_METHOD. This
  70 is a pointer to the internal name string and so should not be freed by the
  71 caller. DH_meth_set1_name() sets the name of the DH_METHOD to B<name>. The
  72 string is duplicated and the copy is stored in the DH_METHOD structure, so the
  73 caller remains responsible for freeing the memory associated with the name.
  74
  75 DH_meth_get_flags() returns the current value of the flags associated with this
  76 DH_METHOD. DH_meth_set_flags() provides the ability to set these flags.
  77
  78 The functions DH_meth_get0_app_data() and DH_meth_set0_app_data() provide the
  79 ability to associate implementation specific data with the DH_METHOD. It is
  80 the application's responsibility to free this data before the DH_METHOD is
  81 freed via a call to DH_meth_free().
  82
  83 DH_meth_get_generate_key() and DH_meth_set_generate_key() get and set the
  84 function used for generating a new DH key pair respectively. This function will
  85 be called in response to the application calling DH_generate_key(). The
  86 parameter for the function has the same meaning as for DH_generate_key().
  87
  88 DH_meth_get_compute_key() and DH_meth_set_compute_key() get and set the
  89 function used for computing a new DH shared secret respectively. This function
  90 will be called in response to the application calling DH_compute_key(). The
  91 parameters for the function have the same meaning as for DH_compute_key().
  92
  93 DH_meth_get_bn_mod_exp() and DH_meth_set_bn_mod_exp() get and set the function
  94 used for computing the following value:
  95
  96  r = a ^ p mod m
  97
  98 This function will be called by the default OpenSSL function for
  99 DH_generate_key(). The result is stored in the B<r> parameter. This function
 100 may be NULL unless using the default generate key function, in which case it
 101 must be present.
 102
 103 DH_meth_get_init() and DH_meth_set_init() get and set the function used
 104 for creating a new DH instance respectively. This function will be
 105 called in response to the application calling DH_new() (if the current default
 106 DH_METHOD is this one) or DH_new_method(). The DH_new() and DH_new_method()
 107 functions will allocate the memory for the new DH object, and a pointer to this
 108 newly allocated structure will be passed as a parameter to the function. This
 109 function may be NULL.
 110
 111 DH_meth_get_finish() and DH_meth_set_finish() get and set the function used
 112 for destroying an instance of a DH object respectively. This function will be
 113 called in response to the application calling DH_free(). A pointer to the DH
 114 to be destroyed is passed as a parameter. The destroy function should be used
 115 for DH implementation specific clean up. The memory for the DH itself should
 116 not be freed by this function. This function may be NULL.
 117
 118 DH_meth_get_generate_params() and DH_meth_set_generate_params() get and set the
 119 function used for generating DH parameters respectively. This function will be
 120 called in response to the application calling DH_generate_parameters_ex() (or
 121 DH_generate_parameters()). The parameters for the function have the same
 122 meaning as for DH_generate_parameters_ex(). This function may be NULL.
 123
 124 =head1 RETURN VALUES
 125
 126 DH_meth_new() and DH_meth_dup() return the newly allocated DH_METHOD object
 127 or NULL on failure.
 128
 129 DH_meth_get0_name() and DH_meth_get_flags() return the name and flags
 130 associated with the DH_METHOD respectively.
 131
 132 All other DH_meth_get_*() functions return the appropriate function pointer
 133 that has been set in the DH_METHOD, or NULL if no such pointer has yet been
 134 set.
 135
 136 DH_meth_set1_name() and all DH_meth_set_*() functions return 1 on success or
 137 0 on failure.
 138
 139 =head1 SEE ALSO
 140
 141 L<dh(3)>, L<DH_new(3)>, L<DH_generate_parameters(3)>, L<DH_generate_key(3)>,
 142 L<DH_set_method(3)>, L<DH_size(3)>, L<DH_get0_pqg(3)>
 143
 144 =head1 HISTORY
 145
 146 The functions described here were added in OpenSSL version 1.1.0.
 147
 148 =cut
 149
 150 =head1 COPYRIGHT
 151
 152 Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
 153
 154 Licensed under the OpenSSL license (the "License").  You may not use
 155 this file except in compliance with the License.  You can obtain a copy
 156 in the file LICENSE in the source distribution or at
 157 L<https://www.openssl.org/source/license.html>.
 158
 159 =cut