DH_meth_new.pod 7.5 KB

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