Various DSA opacity fixups
[openssl.git] / doc / crypto / DSA_meth_new.pod
1 =pod
2
3 =head1 NAME
4
5 DSA_meth_new, DSA_meth_free, DSA_meth_dup, DSA_meth_get0_name,
6 DSA_meth_set1_name, DSA_meth_get_flags, DSA_meth_set_flags,
7 DSA_meth_get_app_data, DSA_meth_set_app_data, DSA_meth_get_sign,
8 DSA_meth_set_sign, DSA_meth_get_sign_setup, DSA_meth_set_sign_setup,
9 DSA_meth_get_verify, DSA_meth_set_verify, DSA_meth_get_mod_exp,
10 DSA_meth_set_mod_exp, DSA_meth_get_bn_mod_exp, DSA_meth_set_bn_mod_exp,
11 DSA_meth_get_init, DSA_meth_set_init, DSA_meth_get_finish, DSA_meth_set_finish,
12 DSA_meth_get_paramgen, DSA_meth_set_paramgen, DSA_meth_get_keygen,
13 DSA_meth_set_keygen  - Routines to build up DSA methods
14
15 =head1 SYNOPSIS
16
17  #include <openssl/dsa.h>
18
19  DSA_METHOD *DSA_meth_new(const char *name, int flags);
20  void DSA_meth_free(DSA_METHOD *dsam);
21  DSA_METHOD *DSA_meth_dup(const DSA_METHOD *meth);
22  const char *DSA_meth_get0_name(const DSA_METHOD *dsam);
23  int DSA_meth_set1_name(DSA_METHOD *dsam, const char *name);
24  int DSA_meth_get_flags(DSA_METHOD *dsam);
25  int DSA_meth_set_flags(DSA_METHOD *dsam, int flags);
26  void *DSA_meth_get_app_data(const DSA_METHOD *dsam);
27  int DSA_meth_set_app_data(DSA_METHOD *dsam, void *app_data);
28  DSA_SIG *(*DSA_meth_get_sign(const DSA_METHOD *dsam))
29          (const unsigned char *, int, DSA *);
30  int DSA_meth_set_sign(DSA_METHOD *dsam,
31                        DSA_SIG *(*sign) (const unsigned char *, int, DSA *));
32  int (*DSA_meth_get_sign_setup(const DSA_METHOD *dsam))
33          (DSA *, BN_CTX *, BIGNUM **, BIGNUM **);
34  int DSA_meth_set_sign_setup(DSA_METHOD *dsam,
35          int (*sign_setup) (DSA *, BN_CTX *, BIGNUM **, BIGNUM **));
36  int (*DSA_meth_get_verify(const DSA_METHOD *dsam))
37          (const unsigned char *, int , DSA_SIG *, DSA *);
38  int DSA_meth_set_verify(DSA_METHOD *dsam,
39      int (*verify) (const unsigned char *, int, DSA_SIG *, DSA *));
40  int (*DSA_meth_get_mod_exp(const DSA_METHOD *dsam))
41         (DSA *dsa, BIGNUM *rr, BIGNUM *a1, BIGNUM *p1, BIGNUM *a2, BIGNUM *p2,
42          BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *in_mont);
43  int DSA_meth_set_mod_exp(DSA_METHOD *dsam,
44      int (*mod_exp) (DSA *dsa, BIGNUM *rr, BIGNUM *a1, BIGNUM *p1, BIGNUM *a2,
45                      BIGNUM *p2, BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *mont));
46  int (*DSA_meth_get_bn_mod_exp(const DSA_METHOD *dsam))
47      (DSA *dsa, BIGNUM *r, BIGNUM *a, const BIGNUM *p, const BIGNUM *m,
48       BN_CTX *ctx, BN_MONT_CTX *mont);
49  int DSA_meth_set_bn_mod_exp(DSA_METHOD *dsam,
50      int (*bn_mod_exp) (DSA *dsa, BIGNUM *r, BIGNUM *a, const BIGNUM *p,
51                         const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *mont));
52  int (*DSA_meth_get_init(const DSA_METHOD *dsam))(DSA *);
53  int DSA_meth_set_init(DSA_METHOD *dsam, int (*init)(DSA *));
54  int (*DSA_meth_get_finish(const DSA_METHOD *dsam)) (DSA *);
55  int DSA_meth_set_finish(DSA_METHOD *dsam, int (*finish) (DSA *));
56  int (*DSA_meth_get_paramgen(const DSA_METHOD *dsam))
57          (DSA *, int, const unsigned char *, int, int *, unsigned long *,
58           BN_GENCB *);
59  int DSA_meth_set_paramgen(DSA_METHOD *dsam,
60          int (*paramgen) (DSA *, int, const unsigned char *, int, int *,
61                           unsigned long *, BN_GENCB *));
62  int (*DSA_meth_get_keygen(const DSA_METHOD *dsam)) (DSA *);
63  int DSA_meth_set_keygen(DSA_METHOD *dsam, int (*keygen) (DSA *));
64
65 =head1 DESCRIPTION
66
67 The B<DSA_METHOD> type is a structure used for the provision of custom DSA
68 implementations. It provides a set of of functions used by OpenSSL for the
69 implementation of the various DSA capabilities. See the L<dsa> page for more
70 information.
71
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
79 DSA_meth_dup() creates a duplicate copy of the B<DSA_METHOD> object passed as a
80 parameter. This might be useful for creating a new B<DSA_METHOD> based on an
81 existing one, but with some differences.
82
83 DSA_meth_free() destroys a B<DSA_METHOD> structure and frees up any memory
84 associated with it.
85
86 DSA_meth_get0_name() will return a pointer to the name of this DSA_METHOD. This
87 is a pointer to the internal name string and so should not be freed by the
88 caller. DSA_meth_set1_name() sets the name of the DSA_METHOD to B<name>. The
89 string is duplicated and the copy is stored in the DSA_METHOD structure, so the
90 caller remains responsible for freeing the memory associated with the name.
91
92 DSA_meth_get_flags() returns the current value of the flags associated with this
93 DSA_METHOD. DSA_meth_set_flags() provides the ability to set these flags.
94
95 The functions DSA_meth_get_app_data() and DSA_meth_set_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
100 DSA_meth_get_sign() and DSA_meth_set_sign() get and set the function used for
101 creating a DSA signature respectively. This function will be
102 called in response to the application calling DSA_do_sign() (or DSA_sign()). The
103 parameters for the function have the same meaning as for DSA_do_sign().
104
105 DSA_meth_get_sign_setup() and DSA_meth_set_sign_setup() get and set the function
106 used for precalculating the DSA signature values B<k^-1> and B<r>. This function
107 will be called in response to the application calling DSA_sign_setup(). The
108 parameters for the function have the same meaning as for DSA_sign_setup().
109
110 DSA_meth_get_verify() and DSA_meth_set_verify() get and set the function used
111 for verifying a DSA signature respectively. This function will be called in
112 response to the application calling DSA_do_verify() (or DSA_verify()). The
113 parameters for the function have the same meaning as for DSA_do_verify().
114
115 DSA_meth_get_mod_exp() and DSA_meth_set_mod_exp() get and set the function used
116 for computing the following value:
117
118  rr = a1^p1 * a2^p2 mod m
119
120 This function will be called by the default OpenSSL method during verification
121 of a DSA signature. The result is stored in the B<rr> parameter. This function
122 may be NULL.
123
124 DSA_meth_get_bn_mod_exp() and DSA_meth_set_bn_mod_exp() get and set the function
125 used for computing the following value:
126
127  r = a ^ p mod m
128
129 This function will be called by the default OpenSSL function for
130 DSA_sign_setup(). The result is stored in the B<r> parameter. This function
131 may be NULL.
132
133 DSA_meth_get_init() and DSA_meth_set_init() get and set the function used
134 for creating a new DSA instance respectively. This function will be
135 called in response to the application calling DSA_new() (if the current default
136 DSA_METHOD is this one) or DSA_new_method(). The DSA_new() and DSA_new_method()
137 functions will allocate the memory for the new DSA object, and a pointer to this
138 newly allocated structure will be passed as a parameter to the function. This
139 function may be NULL.
140
141 DSA_meth_get_finish() and DSA_meth_set_finish() get and set the function used
142 for destroying an instance of a DSA object respectively. This function will be
143 called in response to the application calling DSA_free(). A pointer to the DSA
144 to be destroyed is passed as a parameter. The destroy function should be used
145 for DSA implementation specific clean up. The memory for the DSA itself should
146 not be freed by this function. This function may be NULL.
147
148 DSA_meth_get_paramgen() and DSA_meth_set_paramgen() get and set the function
149 used for generating DSA parameters respectively. This function will be called in
150 response to the application calling DSA_generate_parameters_ex() (or
151 DSA_generate_parameters()). The parameters for the function have the same
152 meaning as for DSA_generate_parameters_ex().
153
154 DSA_meth_get_keygen() and DSA_meth_set_keygen() get and set the function
155 used for generating a new DSA key pair respectively. This function will be
156 called in response to the application calling DSA_generate_key(). The parameter
157 for the function has the same meaning as for DSA_generate_key().
158
159 =head1 RETURN VALUES
160
161 DSA_meth_new() and DSA_meth_dup() return the newly allocated DSA_METHOD object
162 or NULL on failure.
163
164 DSA_meth_get0_name() and DSA_meth_get_flags() return the name and flags
165 associated with the DSA_METHOD respectively.
166
167 All other DSA_meth_get_*() functions return the appropriate function pointer
168 that has been set in the DSA_METHOD, or NULL if no such pointer has yet been
169 set.
170
171 DSA_meth_set1_name() and all DSA_meth_set_*() functions return 1 on success or
172 0 on failure.
173
174 =head1 SEE ALSO
175
176 L<dsa(3)>, L<DSA_new(3)>, L<DSA_generate_parameters(3)>, L<DSA_generate_key(3)>,
177 L<DSA_dup_DH(3)>, L<DSA_do_sign(3)>, L<DSA_set_method(3)>, L<DSA_SIG_new3)>,
178 L<DSA_sign(3)>, L<DSA_size(3)>, L<DSA_get0_pqg(3)>
179
180 =head1 HISTORY
181
182 The functions described here were added in OpenSSL version 1.1.0.
183
184 =cut