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