DSA_meth_new.pod 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224
  1. =pod
  2. =head1 NAME
  3. DSA_meth_new, DSA_meth_free, DSA_meth_dup, DSA_meth_get0_name,
  4. DSA_meth_set1_name, DSA_meth_get_flags, DSA_meth_set_flags,
  5. DSA_meth_get0_app_data, DSA_meth_set0_app_data, DSA_meth_get_sign,
  6. DSA_meth_set_sign, DSA_meth_get_sign_setup, DSA_meth_set_sign_setup,
  7. DSA_meth_get_verify, DSA_meth_set_verify, DSA_meth_get_mod_exp,
  8. DSA_meth_set_mod_exp, DSA_meth_get_bn_mod_exp, DSA_meth_set_bn_mod_exp,
  9. DSA_meth_get_init, DSA_meth_set_init, DSA_meth_get_finish, DSA_meth_set_finish,
  10. DSA_meth_get_paramgen, DSA_meth_set_paramgen, DSA_meth_get_keygen,
  11. DSA_meth_set_keygen - Routines to build up DSA methods
  12. =head1 SYNOPSIS
  13. #include <openssl/dsa.h>
  14. Deprecated since OpenSSL 3.0, can be hidden entirely by defining
  15. B<OPENSSL_API_COMPAT> with a suitable version value, see
  16. L<openssl_user_macros(7)>:
  17. DSA_METHOD *DSA_meth_new(const char *name, int flags);
  18. void DSA_meth_free(DSA_METHOD *dsam);
  19. DSA_METHOD *DSA_meth_dup(const DSA_METHOD *meth);
  20. const char *DSA_meth_get0_name(const DSA_METHOD *dsam);
  21. int DSA_meth_set1_name(DSA_METHOD *dsam, const char *name);
  22. int DSA_meth_get_flags(const DSA_METHOD *dsam);
  23. int DSA_meth_set_flags(DSA_METHOD *dsam, int flags);
  24. void *DSA_meth_get0_app_data(const DSA_METHOD *dsam);
  25. int DSA_meth_set0_app_data(DSA_METHOD *dsam, void *app_data);
  26. DSA_SIG *(*DSA_meth_get_sign(const DSA_METHOD *dsam))(const unsigned char *,
  27. int, DSA *);
  28. int DSA_meth_set_sign(DSA_METHOD *dsam, DSA_SIG *(*sign)(const unsigned char *,
  29. int, DSA *));
  30. int (*DSA_meth_get_sign_setup(const DSA_METHOD *dsam))(DSA *, BN_CTX *,$
  31. BIGNUM **, BIGNUM **);
  32. int DSA_meth_set_sign_setup(DSA_METHOD *dsam, int (*sign_setup)(DSA *, BN_CTX *,
  33. BIGNUM **, BIGNUM **));
  34. int (*DSA_meth_get_verify(const DSA_METHOD *dsam))(const unsigned char *,
  35. int, DSA_SIG *, DSA *);
  36. int DSA_meth_set_verify(DSA_METHOD *dsam, int (*verify)(const unsigned char *,
  37. int, DSA_SIG *, DSA *));
  38. int (*DSA_meth_get_mod_exp(const DSA_METHOD *dsam))(DSA *dsa, BIGNUM *rr, BIGNUM *a1,
  39. BIGNUM *p1, BIGNUM *a2, BIGNUM *p2,
  40. BIGNUM *m, BN_CTX *ctx,
  41. BN_MONT_CTX *in_mont);
  42. int DSA_meth_set_mod_exp(DSA_METHOD *dsam, int (*mod_exp)(DSA *dsa, BIGNUM *rr,
  43. BIGNUM *a1, BIGNUM *p1,
  44. BIGNUM *a2, BIGNUM *p2,
  45. BIGNUM *m, BN_CTX *ctx,
  46. BN_MONT_CTX *mont));
  47. int (*DSA_meth_get_bn_mod_exp(const DSA_METHOD *dsam))(DSA *dsa, BIGNUM *r, BIGNUM *a,
  48. const BIGNUM *p, const BIGNUM *m,
  49. BN_CTX *ctx, BN_MONT_CTX *mont);
  50. int DSA_meth_set_bn_mod_exp(DSA_METHOD *dsam, int (*bn_mod_exp)(DSA *dsa,
  51. BIGNUM *r,
  52. BIGNUM *a,
  53. const BIGNUM *p,
  54. const BIGNUM *m,
  55. BN_CTX *ctx,
  56. BN_MONT_CTX *mont));
  57. int (*DSA_meth_get_init(const DSA_METHOD *dsam))(DSA *);
  58. int DSA_meth_set_init(DSA_METHOD *dsam, int (*init)(DSA *));
  59. int (*DSA_meth_get_finish(const DSA_METHOD *dsam))(DSA *);
  60. int DSA_meth_set_finish(DSA_METHOD *dsam, int (*finish)(DSA *));
  61. int (*DSA_meth_get_paramgen(const DSA_METHOD *dsam))(DSA *, int,
  62. const unsigned char *,
  63. int, int *, unsigned long *,
  64. BN_GENCB *);
  65. int DSA_meth_set_paramgen(DSA_METHOD *dsam,
  66. int (*paramgen)(DSA *, int, const unsigned char *,
  67. int, int *, unsigned long *, BN_GENCB *));
  68. int (*DSA_meth_get_keygen(const DSA_METHOD *dsam))(DSA *);
  69. int DSA_meth_set_keygen(DSA_METHOD *dsam, int (*keygen)(DSA *));
  70. =head1 DESCRIPTION
  71. All of the functions described on this page are deprecated.
  72. Applications and extension implementations should instead use the
  73. OSSL_PROVIDER APIs.
  74. The B<DSA_METHOD> type is a structure used for the provision of custom DSA
  75. implementations. It provides a set of functions used by OpenSSL for the
  76. implementation of the various DSA capabilities.
  77. DSA_meth_new() creates a new B<DSA_METHOD> structure. It should be given a
  78. unique B<name> and a set of B<flags>. The B<name> should be a NULL terminated
  79. string, which will be duplicated and stored in the B<DSA_METHOD> object. It is
  80. the callers responsibility to free the original string. The flags will be used
  81. during the construction of a new B<DSA> object based on this B<DSA_METHOD>. Any
  82. new B<DSA> object will have those flags set by default.
  83. DSA_meth_dup() creates a duplicate copy of the B<DSA_METHOD> object passed as a
  84. parameter. This might be useful for creating a new B<DSA_METHOD> based on an
  85. existing one, but with some differences.
  86. DSA_meth_free() destroys a B<DSA_METHOD> structure and frees up any memory
  87. associated with it.
  88. DSA_meth_get0_name() will return a pointer to the name of this DSA_METHOD. This
  89. is a pointer to the internal name string and so should not be freed by the
  90. caller. DSA_meth_set1_name() sets the name of the DSA_METHOD to B<name>. The
  91. string is duplicated and the copy is stored in the DSA_METHOD structure, so the
  92. caller remains responsible for freeing the memory associated with the name.
  93. DSA_meth_get_flags() returns the current value of the flags associated with this
  94. DSA_METHOD. DSA_meth_set_flags() provides the ability to set these flags.
  95. The functions DSA_meth_get0_app_data() and DSA_meth_set0_app_data() provide the
  96. ability to associate implementation specific data with the DSA_METHOD. It is
  97. the application's responsibility to free this data before the DSA_METHOD is
  98. freed via a call to DSA_meth_free().
  99. DSA_meth_get_sign() and DSA_meth_set_sign() get and set the function used for
  100. creating a DSA signature respectively. This function will be
  101. called in response to the application calling DSA_do_sign() (or DSA_sign()). The
  102. parameters for the function have the same meaning as for DSA_do_sign().
  103. DSA_meth_get_sign_setup() and DSA_meth_set_sign_setup() get and set the function
  104. used for precalculating the DSA signature values B<k^-1> and B<r>. This function
  105. will be called in response to the application calling DSA_sign_setup(). The
  106. parameters for the function have the same meaning as for DSA_sign_setup().
  107. DSA_meth_get_verify() and DSA_meth_set_verify() get and set the function used
  108. for verifying a DSA signature respectively. This function will be called in
  109. response to the application calling DSA_do_verify() (or DSA_verify()). The
  110. parameters for the function have the same meaning as for DSA_do_verify().
  111. DSA_meth_get_mod_exp() and DSA_meth_set_mod_exp() get and set the function used
  112. for computing the following value:
  113. rr = a1^p1 * a2^p2 mod m
  114. This function will be called by the default OpenSSL method during verification
  115. of a DSA signature. The result is stored in the B<rr> parameter. This function
  116. may be NULL.
  117. DSA_meth_get_bn_mod_exp() and DSA_meth_set_bn_mod_exp() get and set the function
  118. used for computing the following value:
  119. r = a ^ p mod m
  120. This function will be called by the default OpenSSL function for
  121. DSA_sign_setup(). The result is stored in the B<r> parameter. This function
  122. may be NULL.
  123. DSA_meth_get_init() and DSA_meth_set_init() get and set the function used
  124. for creating a new DSA instance respectively. This function will be
  125. called in response to the application calling DSA_new() (if the current default
  126. DSA_METHOD is this one) or DSA_new_method(). The DSA_new() and DSA_new_method()
  127. functions will allocate the memory for the new DSA object, and a pointer to this
  128. newly allocated structure will be passed as a parameter to the function. This
  129. function may be NULL.
  130. DSA_meth_get_finish() and DSA_meth_set_finish() get and set the function used
  131. for destroying an instance of a DSA object respectively. This function will be
  132. called in response to the application calling DSA_free(). A pointer to the DSA
  133. to be destroyed is passed as a parameter. The destroy function should be used
  134. for DSA implementation specific clean up. The memory for the DSA itself should
  135. not be freed by this function. This function may be NULL.
  136. DSA_meth_get_paramgen() and DSA_meth_set_paramgen() get and set the function
  137. used for generating DSA parameters respectively. This function will be called in
  138. response to the application calling DSA_generate_parameters_ex() (or
  139. DSA_generate_parameters()). The parameters for the function have the same
  140. meaning as for DSA_generate_parameters_ex().
  141. DSA_meth_get_keygen() and DSA_meth_set_keygen() get and set the function
  142. used for generating a new DSA key pair respectively. This function will be
  143. called in response to the application calling DSA_generate_key(). The parameter
  144. for the function has the same meaning as for DSA_generate_key().
  145. =head1 RETURN VALUES
  146. DSA_meth_new() and DSA_meth_dup() return the newly allocated DSA_METHOD object
  147. or NULL on failure.
  148. DSA_meth_get0_name() and DSA_meth_get_flags() return the name and flags
  149. associated with the DSA_METHOD respectively.
  150. All other DSA_meth_get_*() functions return the appropriate function pointer
  151. that has been set in the DSA_METHOD, or NULL if no such pointer has yet been
  152. set.
  153. DSA_meth_set1_name() and all DSA_meth_set_*() functions return 1 on success or
  154. 0 on failure.
  155. =head1 SEE ALSO
  156. L<DSA_new(3)>, L<DSA_new(3)>, L<DSA_generate_parameters(3)>, L<DSA_generate_key(3)>,
  157. L<DSA_dup_DH(3)>, L<DSA_do_sign(3)>, L<DSA_set_method(3)>, L<DSA_SIG_new(3)>,
  158. L<DSA_sign(3)>, L<DSA_size(3)>, L<DSA_get0_pqg(3)>
  159. =head1 HISTORY
  160. The functions described here were deprecated in OpenSSL 3.0.
  161. The functions described here were added in OpenSSL 1.1.0.
  162. =head1 COPYRIGHT
  163. Copyright 2016-2020 The OpenSSL Project Authors. All Rights Reserved.
  164. Licensed under the Apache License 2.0 (the "License"). You may not use
  165. this file except in compliance with the License. You can obtain a copy
  166. in the file LICENSE in the source distribution or at
  167. L<https://www.openssl.org/source/license.html>.
  168. =cut