353 lines
16 KiB
Groff
Executable File
353 lines
16 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
.\" nothing in troff, for use with C<>.
|
|
.tr \(*W-
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
.\" output yourself in some meaningful fashion.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "DSA_METH_NEW 3"
|
|
.TH DSA_METH_NEW 3 "2020-03-02" "3.0.0-dev" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
DSA_meth_new, DSA_meth_free, DSA_meth_dup, DSA_meth_get0_name,
|
|
DSA_meth_set1_name, DSA_meth_get_flags, DSA_meth_set_flags,
|
|
DSA_meth_get0_app_data, DSA_meth_set0_app_data, DSA_meth_get_sign,
|
|
DSA_meth_set_sign, DSA_meth_get_sign_setup, DSA_meth_set_sign_setup,
|
|
DSA_meth_get_verify, DSA_meth_set_verify, DSA_meth_get_mod_exp,
|
|
DSA_meth_set_mod_exp, DSA_meth_get_bn_mod_exp, DSA_meth_set_bn_mod_exp,
|
|
DSA_meth_get_init, DSA_meth_set_init, DSA_meth_get_finish, DSA_meth_set_finish,
|
|
DSA_meth_get_paramgen, DSA_meth_set_paramgen, DSA_meth_get_keygen,
|
|
DSA_meth_set_keygen \- Routines to build up DSA methods
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/dsa.h>
|
|
.Ve
|
|
.PP
|
|
Deprecated since OpenSSL 3.0, can be hidden entirely by defining
|
|
\&\fB\s-1OPENSSL_API_COMPAT\s0\fR with a suitable version value, see
|
|
\&\fIopenssl_user_macros\fR\|(7):
|
|
.PP
|
|
.Vb 1
|
|
\& DSA_METHOD *DSA_meth_new(const char *name, int flags);
|
|
\&
|
|
\& void DSA_meth_free(DSA_METHOD *dsam);
|
|
\&
|
|
\& DSA_METHOD *DSA_meth_dup(const DSA_METHOD *meth);
|
|
\&
|
|
\& const char *DSA_meth_get0_name(const DSA_METHOD *dsam);
|
|
\& int DSA_meth_set1_name(DSA_METHOD *dsam, const char *name);
|
|
\&
|
|
\& int DSA_meth_get_flags(const DSA_METHOD *dsam);
|
|
\& int DSA_meth_set_flags(DSA_METHOD *dsam, int flags);
|
|
\&
|
|
\& void *DSA_meth_get0_app_data(const DSA_METHOD *dsam);
|
|
\& int DSA_meth_set0_app_data(DSA_METHOD *dsam, void *app_data);
|
|
\&
|
|
\& DSA_SIG *(*DSA_meth_get_sign(const DSA_METHOD *dsam))(const unsigned char *,
|
|
\& int, DSA *);
|
|
\& int DSA_meth_set_sign(DSA_METHOD *dsam, DSA_SIG *(*sign)(const unsigned char *,
|
|
\& int, DSA *));
|
|
\&
|
|
\& int (*DSA_meth_get_sign_setup(const DSA_METHOD *dsam))(DSA *, BN_CTX *,$
|
|
\& BIGNUM **, BIGNUM **);
|
|
\& int DSA_meth_set_sign_setup(DSA_METHOD *dsam, int (*sign_setup)(DSA *, BN_CTX *,
|
|
\& BIGNUM **, BIGNUM **));
|
|
\&
|
|
\& int (*DSA_meth_get_verify(const DSA_METHOD *dsam))(const unsigned char *,
|
|
\& int, DSA_SIG *, DSA *);
|
|
\& int DSA_meth_set_verify(DSA_METHOD *dsam, int (*verify)(const unsigned char *,
|
|
\& int, DSA_SIG *, DSA *));
|
|
\&
|
|
\& int (*DSA_meth_get_mod_exp(const DSA_METHOD *dsam))(DSA *dsa, BIGNUM *rr, BIGNUM *a1,
|
|
\& BIGNUM *p1, BIGNUM *a2, BIGNUM *p2,
|
|
\& BIGNUM *m, BN_CTX *ctx,
|
|
\& BN_MONT_CTX *in_mont);
|
|
\& int DSA_meth_set_mod_exp(DSA_METHOD *dsam, int (*mod_exp)(DSA *dsa, BIGNUM *rr,
|
|
\& BIGNUM *a1, BIGNUM *p1,
|
|
\& BIGNUM *a2, BIGNUM *p2,
|
|
\& BIGNUM *m, BN_CTX *ctx,
|
|
\& BN_MONT_CTX *mont));
|
|
\&
|
|
\& int (*DSA_meth_get_bn_mod_exp(const DSA_METHOD *dsam))(DSA *dsa, BIGNUM *r, BIGNUM *a,
|
|
\& const BIGNUM *p, const BIGNUM *m,
|
|
\& BN_CTX *ctx, BN_MONT_CTX *mont);
|
|
\& int DSA_meth_set_bn_mod_exp(DSA_METHOD *dsam, int (*bn_mod_exp)(DSA *dsa,
|
|
\& BIGNUM *r,
|
|
\& BIGNUM *a,
|
|
\& const BIGNUM *p,
|
|
\& const BIGNUM *m,
|
|
\& BN_CTX *ctx,
|
|
\& BN_MONT_CTX *mont));
|
|
\&
|
|
\& int (*DSA_meth_get_init(const DSA_METHOD *dsam))(DSA *);
|
|
\& int DSA_meth_set_init(DSA_METHOD *dsam, int (*init)(DSA *));
|
|
\&
|
|
\& int (*DSA_meth_get_finish(const DSA_METHOD *dsam))(DSA *);
|
|
\& int DSA_meth_set_finish(DSA_METHOD *dsam, int (*finish)(DSA *));
|
|
\&
|
|
\& int (*DSA_meth_get_paramgen(const DSA_METHOD *dsam))(DSA *, int,
|
|
\& const unsigned char *,
|
|
\& int, int *, unsigned long *,
|
|
\& BN_GENCB *);
|
|
\& int DSA_meth_set_paramgen(DSA_METHOD *dsam,
|
|
\& int (*paramgen)(DSA *, int, const unsigned char *,
|
|
\& int, int *, unsigned long *, BN_GENCB *));
|
|
\&
|
|
\& int (*DSA_meth_get_keygen(const DSA_METHOD *dsam))(DSA *);
|
|
\& int DSA_meth_set_keygen(DSA_METHOD *dsam, int (*keygen)(DSA *));
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
All of the functions described on this page are deprecated.
|
|
Applications and extension implementations should instead use the
|
|
\&\s-1OSSL_PROVIDER\s0 APIs.
|
|
.PP
|
|
The \fB\s-1DSA_METHOD\s0\fR type is a structure used for the provision of custom \s-1DSA\s0
|
|
implementations. It provides a set of functions used by OpenSSL for the
|
|
implementation of the various \s-1DSA\s0 capabilities.
|
|
.PP
|
|
\&\fIDSA_meth_new()\fR creates a new \fB\s-1DSA_METHOD\s0\fR structure. It should be given a
|
|
unique \fBname\fR and a set of \fBflags\fR. The \fBname\fR should be a \s-1NULL\s0 terminated
|
|
string, which will be duplicated and stored in the \fB\s-1DSA_METHOD\s0\fR object. It is
|
|
the callers responsibility to free the original string. The flags will be used
|
|
during the construction of a new \fB\s-1DSA\s0\fR object based on this \fB\s-1DSA_METHOD\s0\fR. Any
|
|
new \fB\s-1DSA\s0\fR object will have those flags set by default.
|
|
.PP
|
|
\&\fIDSA_meth_dup()\fR creates a duplicate copy of the \fB\s-1DSA_METHOD\s0\fR object passed as a
|
|
parameter. This might be useful for creating a new \fB\s-1DSA_METHOD\s0\fR based on an
|
|
existing one, but with some differences.
|
|
.PP
|
|
\&\fIDSA_meth_free()\fR destroys a \fB\s-1DSA_METHOD\s0\fR structure and frees up any memory
|
|
associated with it.
|
|
.PP
|
|
\&\fIDSA_meth_get0_name()\fR will return a pointer to the name of this \s-1DSA_METHOD\s0. This
|
|
is a pointer to the internal name string and so should not be freed by the
|
|
caller. \fIDSA_meth_set1_name()\fR sets the name of the \s-1DSA_METHOD\s0 to \fBname\fR. The
|
|
string is duplicated and the copy is stored in the \s-1DSA_METHOD\s0 structure, so the
|
|
caller remains responsible for freeing the memory associated with the name.
|
|
.PP
|
|
\&\fIDSA_meth_get_flags()\fR returns the current value of the flags associated with this
|
|
\&\s-1DSA_METHOD\s0. \fIDSA_meth_set_flags()\fR provides the ability to set these flags.
|
|
.PP
|
|
The functions \fIDSA_meth_get0_app_data()\fR and \fIDSA_meth_set0_app_data()\fR provide the
|
|
ability to associate implementation specific data with the \s-1DSA_METHOD\s0. It is
|
|
the application's responsibility to free this data before the \s-1DSA_METHOD\s0 is
|
|
freed via a call to \fIDSA_meth_free()\fR.
|
|
.PP
|
|
\&\fIDSA_meth_get_sign()\fR and \fIDSA_meth_set_sign()\fR get and set the function used for
|
|
creating a \s-1DSA\s0 signature respectively. This function will be
|
|
called in response to the application calling \fIDSA_do_sign()\fR (or \fIDSA_sign()\fR). The
|
|
parameters for the function have the same meaning as for \fIDSA_do_sign()\fR.
|
|
.PP
|
|
\&\fIDSA_meth_get_sign_setup()\fR and \fIDSA_meth_set_sign_setup()\fR get and set the function
|
|
used for precalculating the \s-1DSA\s0 signature values \fBk^\-1\fR and \fBr\fR. This function
|
|
will be called in response to the application calling \fIDSA_sign_setup()\fR. The
|
|
parameters for the function have the same meaning as for \fIDSA_sign_setup()\fR.
|
|
.PP
|
|
\&\fIDSA_meth_get_verify()\fR and \fIDSA_meth_set_verify()\fR get and set the function used
|
|
for verifying a \s-1DSA\s0 signature respectively. This function will be called in
|
|
response to the application calling \fIDSA_do_verify()\fR (or \fIDSA_verify()\fR). The
|
|
parameters for the function have the same meaning as for \fIDSA_do_verify()\fR.
|
|
.PP
|
|
\&\fIDSA_meth_get_mod_exp()\fR and \fIDSA_meth_set_mod_exp()\fR get and set the function used
|
|
for computing the following value:
|
|
.PP
|
|
.Vb 1
|
|
\& rr = a1^p1 * a2^p2 mod m
|
|
.Ve
|
|
.PP
|
|
This function will be called by the default OpenSSL method during verification
|
|
of a \s-1DSA\s0 signature. The result is stored in the \fBrr\fR parameter. This function
|
|
may be \s-1NULL\s0.
|
|
.PP
|
|
\&\fIDSA_meth_get_bn_mod_exp()\fR and \fIDSA_meth_set_bn_mod_exp()\fR get and set the function
|
|
used for computing the following value:
|
|
.PP
|
|
.Vb 1
|
|
\& r = a ^ p mod m
|
|
.Ve
|
|
.PP
|
|
This function will be called by the default OpenSSL function for
|
|
\&\fIDSA_sign_setup()\fR. The result is stored in the \fBr\fR parameter. This function
|
|
may be \s-1NULL\s0.
|
|
.PP
|
|
\&\fIDSA_meth_get_init()\fR and \fIDSA_meth_set_init()\fR get and set the function used
|
|
for creating a new \s-1DSA\s0 instance respectively. This function will be
|
|
called in response to the application calling \fIDSA_new()\fR (if the current default
|
|
\&\s-1DSA_METHOD\s0 is this one) or \fIDSA_new_method()\fR. The \fIDSA_new()\fR and \fIDSA_new_method()\fR
|
|
functions will allocate the memory for the new \s-1DSA\s0 object, and a pointer to this
|
|
newly allocated structure will be passed as a parameter to the function. This
|
|
function may be \s-1NULL\s0.
|
|
.PP
|
|
\&\fIDSA_meth_get_finish()\fR and \fIDSA_meth_set_finish()\fR get and set the function used
|
|
for destroying an instance of a \s-1DSA\s0 object respectively. This function will be
|
|
called in response to the application calling \fIDSA_free()\fR. A pointer to the \s-1DSA\s0
|
|
to be destroyed is passed as a parameter. The destroy function should be used
|
|
for \s-1DSA\s0 implementation specific clean up. The memory for the \s-1DSA\s0 itself should
|
|
not be freed by this function. This function may be \s-1NULL\s0.
|
|
.PP
|
|
\&\fIDSA_meth_get_paramgen()\fR and \fIDSA_meth_set_paramgen()\fR get and set the function
|
|
used for generating \s-1DSA\s0 parameters respectively. This function will be called in
|
|
response to the application calling \fIDSA_generate_parameters_ex()\fR (or
|
|
\&\fIDSA_generate_parameters()\fR). The parameters for the function have the same
|
|
meaning as for \fIDSA_generate_parameters_ex()\fR.
|
|
.PP
|
|
\&\fIDSA_meth_get_keygen()\fR and \fIDSA_meth_set_keygen()\fR get and set the function
|
|
used for generating a new \s-1DSA\s0 key pair respectively. This function will be
|
|
called in response to the application calling \fIDSA_generate_key()\fR. The parameter
|
|
for the function has the same meaning as for \fIDSA_generate_key()\fR.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
\&\fIDSA_meth_new()\fR and \fIDSA_meth_dup()\fR return the newly allocated \s-1DSA_METHOD\s0 object
|
|
or \s-1NULL\s0 on failure.
|
|
.PP
|
|
\&\fIDSA_meth_get0_name()\fR and \fIDSA_meth_get_flags()\fR return the name and flags
|
|
associated with the \s-1DSA_METHOD\s0 respectively.
|
|
.PP
|
|
All other DSA_meth_get_*() functions return the appropriate function pointer
|
|
that has been set in the \s-1DSA_METHOD\s0, or \s-1NULL\s0 if no such pointer has yet been
|
|
set.
|
|
.PP
|
|
\&\fIDSA_meth_set1_name()\fR and all DSA_meth_set_*() functions return 1 on success or
|
|
0 on failure.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIDSA_new\fR\|(3), \fIDSA_new\fR\|(3), \fIDSA_generate_parameters\fR\|(3), \fIDSA_generate_key\fR\|(3),
|
|
\&\fIDSA_dup_DH\fR\|(3), \fIDSA_do_sign\fR\|(3), \fIDSA_set_method\fR\|(3), \fIDSA_SIG_new\fR\|(3),
|
|
\&\fIDSA_sign\fR\|(3), \fIDSA_size\fR\|(3), \fIDSA_get0_pqg\fR\|(3)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
The functions described here were deprecated in OpenSSL 3.0.
|
|
.PP
|
|
The functions described here were added in OpenSSL 1.1.0.
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2016\-2020 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file \s-1LICENSE\s0 in the source distribution or at
|
|
<https://www.openssl.org/source/license.html>.
|