- update OpenSSL to 0.9.8
[dragonfly.git] / secure / lib / libcrypto / man / EVP_OpenInit.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_OpenInit 3"
a561f9ff 132.TH EVP_OpenInit 3 "2005-07-06" "0.9.8" "OpenSSL"
984263bc 133.SH "NAME"
74dab6c2 134EVP_OpenInit, EVP_OpenUpdate, EVP_OpenFinal \- EVP envelope decryption
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 6
142\& int EVP_OpenInit(EVP_CIPHER_CTX *ctx,EVP_CIPHER *type,unsigned char *ek,
143\& int ekl,unsigned char *iv,EVP_PKEY *priv);
144\& int EVP_OpenUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out,
145\& int *outl, unsigned char *in, int inl);
146\& int EVP_OpenFinal(EVP_CIPHER_CTX *ctx, unsigned char *out,
147\& int *outl);
148.Ve
149.SH "DESCRIPTION"
8b0cefbb
JR
150.IX Header "DESCRIPTION"
151The \s-1EVP\s0 envelope routines are a high level interface to envelope
984263bc
MD
152decryption. They decrypt a public key encrypted symmetric key and
153then decrypt data using it.
154.PP
8b0cefbb 155\&\fIEVP_OpenInit()\fR initializes a cipher context \fBctx\fR for decryption
984263bc 156with cipher \fBtype\fR. It decrypts the encrypted symmetric key of length
8b0cefbb
JR
157\&\fBekl\fR bytes passed in the \fBek\fR parameter using the private key \fBpriv\fR.
158The \s-1IV\s0 is supplied in the \fBiv\fR parameter.
984263bc 159.PP
8b0cefbb 160\&\fIEVP_OpenUpdate()\fR and \fIEVP_OpenFinal()\fR have exactly the same properties
984263bc 161as the \fIEVP_DecryptUpdate()\fR and \fIEVP_DecryptFinal()\fR routines, as
8b0cefbb 162documented on the \fIEVP_EncryptInit\fR\|(3) manual
984263bc
MD
163page.
164.SH "NOTES"
8b0cefbb 165.IX Header "NOTES"
984263bc 166It is possible to call \fIEVP_OpenInit()\fR twice in the same way as
8b0cefbb 167\&\fIEVP_DecryptInit()\fR. The first call should have \fBpriv\fR set to \s-1NULL\s0
984263bc 168and (after setting any cipher parameters) it should be called again
8b0cefbb 169with \fBtype\fR set to \s-1NULL\s0.
984263bc
MD
170.PP
171If the cipher passed in the \fBtype\fR parameter is a variable length
172cipher then the key length will be set to the value of the recovered
173key length. If the cipher is a fixed length cipher then the recovered
174key length must match the fixed cipher length.
175.SH "RETURN VALUES"
8b0cefbb
JR
176.IX Header "RETURN VALUES"
177\&\fIEVP_OpenInit()\fR returns 0 on error or a non zero integer (actually the
984263bc
MD
178recovered secret key size) if successful.
179.PP
8b0cefbb 180\&\fIEVP_OpenUpdate()\fR returns 1 for success or 0 for failure.
984263bc 181.PP
8b0cefbb 182\&\fIEVP_OpenFinal()\fR returns 0 if the decrypt failed or 1 for success.
984263bc 183.SH "SEE ALSO"
74dab6c2 184.IX Header "SEE ALSO"
8b0cefbb
JR
185\&\fIevp\fR\|(3), \fIrand\fR\|(3),
186\&\fIEVP_EncryptInit\fR\|(3),
187\&\fIEVP_SealInit\fR\|(3)
188.SH "HISTORY"
984263bc 189.IX Header "HISTORY"