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

   1 .\"     $NetBSD: libcrypto.pl,v 1.3 2007/11/27 22:16:03 christos Exp $
   2 .\"
   3 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
   4 .\"
   5 .\" Standard preamble:
   6 .\" ========================================================================
   7 .de Sh \" Subsection heading
   8 .br
   9 .if t .Sp
  10 .ne 5
  11 .PP
  12 \fB\\$1\fR
  13 .PP
  14 ..
  15 .de Sp \" Vertical space (when we can't use .PP)
  16 .if t .sp .5v
  17 .if n .sp
  18 ..
  19 .de Vb \" Begin verbatim text
  20 .ft CW
  21 .nf
  22 .ne \\$1
  23 ..
  24 .de Ve \" End verbatim text
  25 .ft R
  26 .fi
  27 ..
  28 .\" Set up some character translations and predefined strings.  \*(-- will
  29 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  30 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  31 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  32 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  33 .\" nothing in troff, for use with C<>.
  34 .tr \(*W-
  35 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  36 .ie n \{\
  37 .    ds -- \(*W-
  38 .    ds PI pi
  39 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  40 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  41 .    ds L" ""
  42 .    ds R" ""
  43 .    ds C` ""
  44 .    ds C' ""
  45 'br\}
  46 .el\{\
  47 .    ds -- \|\(em\|
  48 .    ds PI \(*p
  49 .    ds L" ``
  50 .    ds R" ''
  51 'br\}
  52 .\"
  53 .\" Escape single quotes in literal strings from groff's Unicode transform.
  54 .ie \n(.g .ds Aq \(aq
  55 .el       .ds Aq '
  56 .\"
  57 .\" If the F register is turned on, we'll generate index entries on stderr for
  58 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  59 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  60 .\" output yourself in some meaningful fashion.
  61 .ie \nF \{\
  62 .    de IX
  63 .    tm Index:\\$1\t\\n%\t"\\$2"
  64 ..
  65 .    nr % 0
  66 .    rr F
  67 .\}
  68 .el \{\
  69 .    de IX
  70 ..
  71 .\}
  72 .\"
  73 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  74 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  75 .    \" fudge factors for nroff and troff
  76 .if n \{\
  77 .    ds #H 0
  78 .    ds #V .8m
  79 .    ds #F .3m
  80 .    ds #[ \f1
  81 .    ds #] \fP
  82 .\}
  83 .if t \{\
  84 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  85 .    ds #V .6m
  86 .    ds #F 0
  87 .    ds #[ \&
  88 .    ds #] \&
  89 .\}
  90 .    \" simple accents for nroff and troff
  91 .if n \{\
  92 .    ds ' \&
  93 .    ds ` \&
  94 .    ds ^ \&
  95 .    ds , \&
  96 .    ds ~ ~
  97 .    ds /
  98 .\}
  99 .if t \{\
 100 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 101 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 102 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 103 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 104 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 105 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 106 .\}
 107 .    \" troff and (daisy-wheel) nroff accents
 108 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 109 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 110 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 111 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 112 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 113 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 114 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 115 .ds ae a\h'-(\w'a'u*4/10)'e
 116 .ds Ae A\h'-(\w'A'u*4/10)'E
 117 .    \" corrections for vroff
 118 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 119 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 120 .    \" for low resolution devices (crt and lpr)
 121 .if \n(.H>23 .if \n(.V>19 \
 122 \{\
 123 .    ds : e
 124 .    ds 8 ss
 125 .    ds o a
 126 .    ds d- d\h'-1'\(ga
 127 .    ds D- D\h'-1'\(hy
 128 .    ds th \o'bp'
 129 .    ds Th \o'LP'
 130 .    ds ae ae
 131 .    ds Ae AE
 132 .\}
 133 .rm #[ #] #H #V #F C
 134 .\" ========================================================================
 135 .\"
 136 .IX Title "EVP_SignInit 3"
 137 .TH EVP_SignInit 3 "2006-07-12" "1.1.0-dev" "OpenSSL"
 138 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 139 .\" way too many mistakes in technical documents.
 140 .if n .ad l
 141 .nh
 142 .SH "NAME"
 143 EVP_SignInit, EVP_SignUpdate, EVP_SignFinal \- EVP signing functions
 144 .SH "LIBRARY"
 145 libcrypto, -lcrypto
 146 .SH "SYNOPSIS"
 147 .IX Header "SYNOPSIS"
 148 .Vb 1
 149 \& #include <openssl/evp.h>
 150 \&
 151 \& int EVP_SignInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type, ENGINE *impl);
 152 \& int EVP_SignUpdate(EVP_MD_CTX *ctx, const void *d, unsigned int cnt);
 153 \& int EVP_SignFinal(EVP_MD_CTX *ctx,unsigned char *sig,unsigned int *s, EVP_PKEY *pkey);
 154 \&
 155 \& void EVP_SignInit(EVP_MD_CTX *ctx, const EVP_MD *type);
 156 \&
 157 \& int EVP_PKEY_size(EVP_PKEY *pkey);
 158 .Ve
 159 .SH "DESCRIPTION"
 160 .IX Header "DESCRIPTION"
 161 The \s-1EVP\s0 signature routines are a high level interface to digital
 162 signatures.
 163 .PP
 164 \&\fIEVP_SignInit_ex()\fR sets up signing context \fBctx\fR to use digest
 165 \&\fBtype\fR from \s-1ENGINE\s0 \fBimpl\fR. \fBctx\fR must be initialized with
 166 \&\fIEVP_MD_CTX_init()\fR before calling this function.
 167 .PP
 168 \&\fIEVP_SignUpdate()\fR hashes \fBcnt\fR bytes of data at \fBd\fR into the
 169 signature context \fBctx\fR. This function can be called several times on the
 170 same \fBctx\fR to include additional data.
 171 .PP
 172 \&\fIEVP_SignFinal()\fR signs the data in \fBctx\fR using the private key \fBpkey\fR and
 173 places the signature in \fBsig\fR. The number of bytes of data written (i.e. the
 174 length of the signature) will be written to the integer at \fBs\fR, at most
 175 EVP_PKEY_size(pkey) bytes will be written.
 176 .PP
 177 \&\fIEVP_SignInit()\fR initializes a signing context \fBctx\fR to use the default
 178 implementation of digest \fBtype\fR.
 179 .PP
 180 \&\fIEVP_PKEY_size()\fR returns the maximum size of a signature in bytes. The actual
 181 signature returned by \fIEVP_SignFinal()\fR may be smaller.
 182 .SH "RETURN VALUES"
 183 .IX Header "RETURN VALUES"
 184 \&\fIEVP_SignInit_ex()\fR, \fIEVP_SignUpdate()\fR and \fIEVP_SignFinal()\fR return 1
 185 for success and 0 for failure.
 186 .PP
 187 \&\fIEVP_PKEY_size()\fR returns the maximum size of a signature in bytes.
 188 .PP
 189 The error codes can be obtained by \fIERR_get_error\fR\|(3).
 190 .SH "NOTES"
 191 .IX Header "NOTES"
 192 The \fB\s-1EVP\s0\fR interface to digital signatures should almost always be used in
 193 preference to the low level interfaces. This is because the code then becomes
 194 transparent to the algorithm used and much more flexible.
 195 .PP
 196 Due to the link between message digests and public key algorithms the correct
 197 digest algorithm must be used with the correct public key type. A list of
 198 algorithms and associated public key algorithms appears in
 199 \&\fIEVP_DigestInit\fR\|(3).
 200 .PP
 201 When signing with \s-1DSA\s0 private keys the random number generator must be seeded
 202 or the operation will fail. The random number generator does not need to be
 203 seeded for \s-1RSA\s0 signatures.
 204 .PP
 205 The call to \fIEVP_SignFinal()\fR internally finalizes a copy of the digest context.
 206 This means that calls to \fIEVP_SignUpdate()\fR and \fIEVP_SignFinal()\fR can be called
 207 later to digest and sign additional data.
 208 .PP
 209 Since only a copy of the digest context is ever finalized the context must
 210 be cleaned up after use by calling \fIEVP_MD_CTX_cleanup()\fR or a memory leak
 211 will occur.
 212 .SH "BUGS"
 213 .IX Header "BUGS"
 214 Older versions of this documentation wrongly stated that calls to
 215 \&\fIEVP_SignUpdate()\fR could not be made after calling \fIEVP_SignFinal()\fR.
 216 .PP
 217 Since the private key is passed in the call to \fIEVP_SignFinal()\fR any error
 218 relating to the private key (for example an unsuitable key and digest
 219 combination) will not be indicated until after potentially large amounts of
 220 data have been passed through \fIEVP_SignUpdate()\fR.
 221 .PP
 222 It is not possible to change the signing parameters using these function.
 223 .PP
 224 The previous two bugs are fixed in the newer EVP_SignDigest*() function.
 225 .SH "SEE ALSO"
 226 .IX Header "SEE ALSO"
 227 \&\fIEVP_VerifyInit\fR\|(3),
 228 \&\fIEVP_DigestInit\fR\|(3), \fIopenssl_err\fR\|(3),
 229 \&\fIopenssl_evp\fR\|(3), \fIopenssl_hmac\fR\|(3), \fImd2\fR\|(3),
 230 \&\fIopenssl_md5\fR\|(3), \fIopenssl_mdc2\fR\|(3), \fIopenssl_ripemd\fR\|(3),
 231 \&\fIopenssl_sha\fR\|(3), \fIopenssl_dgst\fR\|(1)
 232 .SH "HISTORY"
 233 .IX Header "HISTORY"
 234 \&\fIEVP_SignInit()\fR, \fIEVP_SignUpdate()\fR and \fIEVP_SignFinal()\fR are
 235 available in all versions of SSLeay and OpenSSL.
 236 .PP
 237 \&\fIEVP_SignInit_ex()\fR was added in OpenSSL 0.9.7.