DSA_meth_new.pod 10 KB

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