crypto/external/bsd/openssl/lib/libcrypto/man/openssl_dsa.3

   1 .\"     $NetBSD: openssl_dsa.3,v 1.14 2015/06/12 17:01:14 christos Exp $
   2 .\"
   3 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
   4 .\"
   5 .\" Standard preamble:
   6 .\" ========================================================================
   7 .de Sp \" Vertical space (when we can't use .PP)
   8 .if t .sp .5v
   9 .if n .sp
  10 ..
  11 .de Vb \" Begin verbatim text
  12 .ft CW
  13 .nf
  14 .ne \\$1
  15 ..
  16 .de Ve \" End verbatim text
  17 .ft R
  18 .fi
  19 ..
  20 .\" Set up some character translations and predefined strings.  \*(-- will
  21 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  22 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  23 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  24 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  25 .\" nothing in troff, for use with C<>.
  26 .tr \(*W-
  27 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  28 .ie n \{\
  29 .    ds -- \(*W-
  30 .    ds PI pi
  31 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  32 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  33 .    ds L" ""
  34 .    ds R" ""
  35 .    ds C` ""
  36 .    ds C' ""
  37 'br\}
  38 .el\{\
  39 .    ds -- \|\(em\|
  40 .    ds PI \(*p
  41 .    ds L" ``
  42 .    ds R" ''
  43 .    ds C`
  44 .    ds C'
  45 'br\}
  46 .\"
  47 .\" Escape single quotes in literal strings from groff's Unicode transform.
  48 .ie \n(.g .ds Aq \(aq
  49 .el       .ds Aq '
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .\"
  56 .\" Avoid warning from groff about undefined register 'F'.
  57 .de IX
  58 ..
  59 .nr rF 0
  60 .if \n(.g .if rF .nr rF 1
  61 .if (\n(rF:(\n(.g==0)) \{
  62 .    if \nF \{
  63 .        de IX
  64 .        tm Index:\\$1\t\\n%\t"\\$2"
  65 ..
  66 .        if !\nF==2 \{
  67 .            nr % 0
  68 .            nr F 2
  69 .        \}
  70 .    \}
  71 .\}
  72 .rr rF
  73 .\"
  74 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  75 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  76 .    \" fudge factors for nroff and troff
  77 .if n \{\
  78 .    ds #H 0
  79 .    ds #V .8m
  80 .    ds #F .3m
  81 .    ds #[ \f1
  82 .    ds #] \fP
  83 .\}
  84 .if t \{\
  85 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  86 .    ds #V .6m
  87 .    ds #F 0
  88 .    ds #[ \&
  89 .    ds #] \&
  90 .\}
  91 .    \" simple accents for nroff and troff
  92 .if n \{\
  93 .    ds ' \&
  94 .    ds ` \&
  95 .    ds ^ \&
  96 .    ds , \&
  97 .    ds ~ ~
  98 .    ds /
  99 .\}
 100 .if t \{\
 101 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 102 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 103 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 104 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 105 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 106 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 107 .\}
 108 .    \" troff and (daisy-wheel) nroff accents
 109 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 110 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 111 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 112 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 113 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 114 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 115 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 116 .ds ae a\h'-(\w'a'u*4/10)'e
 117 .ds Ae A\h'-(\w'A'u*4/10)'E
 118 .    \" corrections for vroff
 119 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 120 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 121 .    \" for low resolution devices (crt and lpr)
 122 .if \n(.H>23 .if \n(.V>19 \
 123 \{\
 124 .    ds : e
 125 .    ds 8 ss
 126 .    ds o a
 127 .    ds d- d\h'-1'\(ga
 128 .    ds D- D\h'-1'\(hy
 129 .    ds th \o'bp'
 130 .    ds Th \o'LP'
 131 .    ds ae ae
 132 .    ds Ae AE
 133 .\}
 134 .rm #[ #] #H #V #F C
 135 .\" ========================================================================
 136 .\"
 137 .IX Title "dsa 3"
 138 .TH dsa 3 "2009-07-19" "1.0.1n" "OpenSSL"
 139 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 140 .\" way too many mistakes in technical documents.
 141 .if n .ad l
 142 .nh
 143 .SH "NAME"
 144 dsa \- Digital Signature Algorithm
 145 .SH "LIBRARY"
 146 libcrypto, -lcrypto
 147 .SH "SYNOPSIS"
 148 .IX Header "SYNOPSIS"
 149 .Vb 2
 150 \& #include <openssl/dsa.h>
 151 \& #include <openssl/engine.h>
 152 \&
 153 \& DSA *  DSA_new(void);
 154 \& void   DSA_free(DSA *dsa);
 155 \&
 156 \& int    DSA_size(const DSA *dsa);
 157 \&
 158 \& DSA *  DSA_generate_parameters(int bits, unsigned char *seed,
 159 \&                int seed_len, int *counter_ret, unsigned long *h_ret,
 160 \&                void (*callback)(int, int, void *), void *cb_arg);
 161 \&
 162 \& DH *   DSA_dup_DH(const DSA *r);
 163 \&
 164 \& int    DSA_generate_key(DSA *dsa);
 165 \&
 166 \& int    DSA_sign(int dummy, const unsigned char *dgst, int len,
 167 \&                unsigned char *sigret, unsigned int *siglen, DSA *dsa);
 168 \& int    DSA_sign_setup(DSA *dsa, BN_CTX *ctx, BIGNUM **kinvp,
 169 \&                BIGNUM **rp);
 170 \& int    DSA_verify(int dummy, const unsigned char *dgst, int len,
 171 \&                const unsigned char *sigbuf, int siglen, DSA *dsa);
 172 \&
 173 \& void DSA_set_default_method(const DSA_METHOD *meth);
 174 \& const DSA_METHOD *DSA_get_default_method(void);
 175 \& int DSA_set_method(DSA *dsa, const DSA_METHOD *meth);
 176 \& DSA *DSA_new_method(ENGINE *engine);
 177 \& const DSA_METHOD *DSA_OpenSSL(void);
 178 \&
 179 \& int DSA_get_ex_new_index(long argl, char *argp, int (*new_func)(),
 180 \&             int (*dup_func)(), void (*free_func)());
 181 \& int DSA_set_ex_data(DSA *d, int idx, char *arg);
 182 \& char *DSA_get_ex_data(DSA *d, int idx);
 183 \&
 184 \& DSA_SIG *DSA_SIG_new(void);
 185 \& void   DSA_SIG_free(DSA_SIG *a);
 186 \& int    i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp);
 187 \& DSA_SIG *d2i_DSA_SIG(DSA_SIG **v, unsigned char **pp, long length);
 188 \&
 189 \& DSA_SIG *DSA_do_sign(const unsigned char *dgst, int dlen, DSA *dsa);
 190 \& int    DSA_do_verify(const unsigned char *dgst, int dgst_len,
 191 \&             DSA_SIG *sig, DSA *dsa);
 192 \&
 193 \& DSA *  d2i_DSAPublicKey(DSA **a, unsigned char **pp, long length);
 194 \& DSA *  d2i_DSAPrivateKey(DSA **a, unsigned char **pp, long length);
 195 \& DSA *  d2i_DSAparams(DSA **a, unsigned char **pp, long length);
 196 \& int    i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
 197 \& int    i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
 198 \& int    i2d_DSAparams(const DSA *a,unsigned char **pp);
 199 \&
 200 \& int    DSAparams_print(BIO *bp, const DSA *x);
 201 \& int    DSAparams_print_fp(FILE *fp, const DSA *x);
 202 \& int    DSA_print(BIO *bp, const DSA *x, int off);
 203 \& int    DSA_print_fp(FILE *bp, const DSA *x, int off);
 204 .Ve
 205 .SH "DESCRIPTION"
 206 .IX Header "DESCRIPTION"
 207 These functions implement the Digital Signature Algorithm (\s-1DSA\s0).  The
 208 generation of shared \s-1DSA\s0 parameters is described in
 209 \&\fIDSA_generate_parameters\fR\|(3);
 210 \&\fIDSA_generate_key\fR\|(3) describes how to
 211 generate a signature key. Signature generation and verification are
 212 described in \fIDSA_sign\fR\|(3).
 213 .PP
 214 The \fB\s-1DSA\s0\fR structure consists of several \s-1BIGNUM\s0 components.
 215 .PP
 216 .Vb 10
 217 \& struct
 218 \&        {
 219 \&        BIGNUM *p;              // prime number (public)
 220 \&        BIGNUM *q;              // 160\-bit subprime, q | p\-1 (public)
 221 \&        BIGNUM *g;              // generator of subgroup (public)
 222 \&        BIGNUM *priv_key;       // private key x
 223 \&        BIGNUM *pub_key;        // public key y = g^x
 224 \&        // ...
 225 \&        }
 226 \& DSA;
 227 .Ve
 228 .PP
 229 In public keys, \fBpriv_key\fR is \s-1NULL.\s0
 230 .PP
 231 Note that \s-1DSA\s0 keys may use non-standard \fB\s-1DSA_METHOD\s0\fR implementations,
 232 either directly or by the use of \fB\s-1ENGINE\s0\fR modules. In some cases (eg. an
 233 \&\s-1ENGINE\s0 providing support for hardware-embedded keys), these \s-1BIGNUM\s0 values
 234 will not be used by the implementation or may be used for alternative data
 235 storage. For this reason, applications should generally avoid using \s-1DSA\s0
 236 structure elements directly and instead use \s-1API\s0 functions to query or
 237 modify keys.
 238 .SH "CONFORMING TO"
 239 .IX Header "CONFORMING TO"
 240 \&\s-1US\s0 Federal Information Processing Standard \s-1FIPS 186 \s0(Digital Signature
 241 Standard, \s-1DSS\s0), \s-1ANSI X9.30\s0
 242 .SH "SEE ALSO"
 243 .IX Header "SEE ALSO"
 244 \&\fIopenssl_bn\fR\|(3), \fIopenssl_dh\fR\|(3), \fIopenssl_err\fR\|(3), \fIopenssl_rand\fR\|(3),
 245 \&\fIopenssl_rsa\fR\|(3), \fIopenssl_sha\fR\|(3), \fIengine\fR\|(3),
 246 \&\fIDSA_new\fR\|(3),
 247 \&\fIDSA_size\fR\|(3),
 248 \&\fIDSA_generate_parameters\fR\|(3),
 249 \&\fIDSA_dup_DH\fR\|(3),
 250 \&\fIDSA_generate_key\fR\|(3),
 251 \&\fIDSA_sign\fR\|(3), \fIDSA_set_method\fR\|(3),
 252 \&\fIDSA_get_ex_new_index\fR\|(3),
 253 \&\fIRSA_print\fR\|(3)