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

   1 .\"     $NetBSD: EVP_SignInit.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 "EVP_SignInit 3"
 138 .TH EVP_SignInit 3 "2014-08-10" "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 EVP_SignInit, EVP_SignUpdate, EVP_SignFinal \- EVP signing functions
 145 .SH "LIBRARY"
 146 libcrypto, -lcrypto
 147 .SH "SYNOPSIS"
 148 .IX Header "SYNOPSIS"
 149 .Vb 1
 150 \& #include <openssl/evp.h>
 151 \&
 152 \& int EVP_SignInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type, ENGINE *impl);
 153 \& int EVP_SignUpdate(EVP_MD_CTX *ctx, const void *d, unsigned int cnt);
 154 \& int EVP_SignFinal(EVP_MD_CTX *ctx,unsigned char *sig,unsigned int *s, EVP_PKEY *pkey);
 155 \&
 156 \& void EVP_SignInit(EVP_MD_CTX *ctx, const EVP_MD *type);
 157 \&
 158 \& int EVP_PKEY_size(EVP_PKEY *pkey);
 159 .Ve
 160 .SH "DESCRIPTION"
 161 .IX Header "DESCRIPTION"
 162 The \s-1EVP\s0 signature routines are a high level interface to digital
 163 signatures.
 164 .PP
 165 \&\fIEVP_SignInit_ex()\fR sets up signing context \fBctx\fR to use digest
 166 \&\fBtype\fR from \s-1ENGINE \s0\fBimpl\fR. \fBctx\fR must be initialized with
 167 \&\fIEVP_MD_CTX_init()\fR before calling this function.
 168 .PP
 169 \&\fIEVP_SignUpdate()\fR hashes \fBcnt\fR bytes of data at \fBd\fR into the
 170 signature context \fBctx\fR. This function can be called several times on the
 171 same \fBctx\fR to include additional data.
 172 .PP
 173 \&\fIEVP_SignFinal()\fR signs the data in \fBctx\fR using the private key \fBpkey\fR and
 174 places the signature in \fBsig\fR. \fBsig\fR must be at least EVP_PKEY_size(pkey)
 175 bytes in size. \fBs\fR is an \s-1OUT\s0 paramter, and not used as an \s-1IN\s0 parameter.
 176 The number of bytes of data written (i.e. the length of the signature)
 177 will be written to the integer at \fBs\fR, at most EVP_PKEY_size(pkey) bytes
 178 will be written.
 179 .PP
 180 \&\fIEVP_SignInit()\fR initializes a signing context \fBctx\fR to use the default
 181 implementation of digest \fBtype\fR.
 182 .PP
 183 \&\fIEVP_PKEY_size()\fR returns the maximum size of a signature in bytes. The actual
 184 signature returned by \fIEVP_SignFinal()\fR may be smaller.
 185 .SH "RETURN VALUES"
 186 .IX Header "RETURN VALUES"
 187 \&\fIEVP_SignInit_ex()\fR, \fIEVP_SignUpdate()\fR and \fIEVP_SignFinal()\fR return 1
 188 for success and 0 for failure.
 189 .PP
 190 \&\fIEVP_PKEY_size()\fR returns the maximum size of a signature in bytes.
 191 .PP
 192 The error codes can be obtained by \fIERR_get_error\fR\|(3).
 193 .SH "NOTES"
 194 .IX Header "NOTES"
 195 The \fB\s-1EVP\s0\fR interface to digital signatures should almost always be used in
 196 preference to the low level interfaces. This is because the code then becomes
 197 transparent to the algorithm used and much more flexible.
 198 .PP
 199 Due to the link between message digests and public key algorithms the correct
 200 digest algorithm must be used with the correct public key type. A list of
 201 algorithms and associated public key algorithms appears in
 202 \&\fIEVP_DigestInit\fR\|(3).
 203 .PP
 204 When signing with \s-1DSA\s0 private keys the random number generator must be seeded
 205 or the operation will fail. The random number generator does not need to be
 206 seeded for \s-1RSA\s0 signatures.
 207 .PP
 208 The call to \fIEVP_SignFinal()\fR internally finalizes a copy of the digest context.
 209 This means that calls to \fIEVP_SignUpdate()\fR and \fIEVP_SignFinal()\fR can be called
 210 later to digest and sign additional data.
 211 .PP
 212 Since only a copy of the digest context is ever finalized the context must
 213 be cleaned up after use by calling \fIEVP_MD_CTX_cleanup()\fR or a memory leak
 214 will occur.
 215 .SH "BUGS"
 216 .IX Header "BUGS"
 217 Older versions of this documentation wrongly stated that calls to
 218 \&\fIEVP_SignUpdate()\fR could not be made after calling \fIEVP_SignFinal()\fR.
 219 .PP
 220 Since the private key is passed in the call to \fIEVP_SignFinal()\fR any error
 221 relating to the private key (for example an unsuitable key and digest
 222 combination) will not be indicated until after potentially large amounts of
 223 data have been passed through \fIEVP_SignUpdate()\fR.
 224 .PP
 225 It is not possible to change the signing parameters using these function.
 226 .PP
 227 The previous two bugs are fixed in the newer EVP_SignDigest*() function.
 228 .SH "SEE ALSO"
 229 .IX Header "SEE ALSO"
 230 \&\fIEVP_VerifyInit\fR\|(3),
 231 \&\fIEVP_DigestInit\fR\|(3), \fIopenssl_err\fR\|(3),
 232 \&\fIopenssl_evp\fR\|(3), \fIopenssl_hmac\fR\|(3), \fImd2\fR\|(3),
 233 \&\fIopenssl_md5\fR\|(3), \fIopenssl_mdc2\fR\|(3), \fIopenssl_ripemd\fR\|(3),
 234 \&\fIopenssl_sha\fR\|(3), \fIopenssl_dgst\fR\|(1)
 235 .SH "HISTORY"
 236 .IX Header "HISTORY"
 237 \&\fIEVP_SignInit()\fR, \fIEVP_SignUpdate()\fR and \fIEVP_SignFinal()\fR are
 238 available in all versions of SSLeay and OpenSSL.
 239 .PP
 240 \&\fIEVP_SignInit_ex()\fR was added in OpenSSL 0.9.7.