Merge from vendor branch CVS:
[dragonfly.git] / secure / lib / libcrypto / man / BIO_f_md.3
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
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<>.
32 .tr \(*W-|\(bv\*(Tr
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
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' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
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"
58 ..
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
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
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
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'
101 .\}
102 .    \" troff and (daisy-wheel) nroff accents
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
112 .    \" corrections for vroff
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'
115 .    \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
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
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "BIO_f_md 3"
132 .TH BIO_f_md 3 "2004-12-18" "0.9.7e" "OpenSSL"
133 .SH "NAME"
134 BIO_f_md, BIO_set_md, BIO_get_md, BIO_get_md_ctx \- message digest BIO filter
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 .Vb 2
138 \& #include <openssl/bio.h>
139 \& #include <openssl/evp.h>
140 .Ve
141 .PP
142 .Vb 4
143 \& BIO_METHOD *   BIO_f_md(void);
144 \& int BIO_set_md(BIO *b,EVP_MD *md);
145 \& int BIO_get_md(BIO *b,EVP_MD **mdp);
146 \& int BIO_get_md_ctx(BIO *b,EVP_MD_CTX **mdcp);
147 .Ve
148 .SH "DESCRIPTION"
149 .IX Header "DESCRIPTION"
150 \&\fIBIO_f_md()\fR returns the message digest \s-1BIO\s0 method. This is a filter
151 \&\s-1BIO\s0 that digests any data passed through it, it is a \s-1BIO\s0 wrapper
152 for the digest routines \fIEVP_DigestInit()\fR, \fIEVP_DigestUpdate()\fR
153 and \fIEVP_DigestFinal()\fR.
154 .PP
155 Any data written or read through a digest \s-1BIO\s0 using \fIBIO_read()\fR and
156 \&\fIBIO_write()\fR is digested.
157 .PP
158 \&\fIBIO_gets()\fR, if its \fBsize\fR parameter is large enough finishes the
159 digest calculation and returns the digest value. \fIBIO_puts()\fR is
160 not supported.
161 .PP
162 \&\fIBIO_reset()\fR reinitialises a digest \s-1BIO\s0.
163 .PP
164 \&\fIBIO_set_md()\fR sets the message digest of \s-1BIO\s0 \fBb\fR to \fBmd\fR: this
165 must be called to initialize a digest \s-1BIO\s0 before any data is
166 passed through it. It is a \fIBIO_ctrl()\fR macro.
167 .PP
168 \&\fIBIO_get_md()\fR places the a pointer to the digest BIOs digest method
169 in \fBmdp\fR, it is a \fIBIO_ctrl()\fR macro.
170 .PP
171 \&\fIBIO_get_md_ctx()\fR returns the digest BIOs context into \fBmdcp\fR.
172 .SH "NOTES"
173 .IX Header "NOTES"
174 The context returned by \fIBIO_get_md_ctx()\fR can be used in calls
175 to \fIEVP_DigestFinal()\fR and also the signature routines \fIEVP_SignFinal()\fR
176 and \fIEVP_VerifyFinal()\fR.
177 .PP
178 The context returned by \fIBIO_get_md_ctx()\fR is an internal context
179 structure. Changes made to this context will affect the digest
180 \&\s-1BIO\s0 itself and the context pointer will become invalid when the digest
181 \&\s-1BIO\s0 is freed.
182 .PP
183 After the digest has been retrieved from a digest \s-1BIO\s0 it must be
184 reinitialized by calling \fIBIO_reset()\fR, or \fIBIO_set_md()\fR before any more
185 data is passed through it.
186 .PP
187 If an application needs to call \fIBIO_gets()\fR or \fIBIO_puts()\fR through
188 a chain containing digest BIOs then this can be done by prepending
189 a buffering \s-1BIO\s0.
190 .SH "RETURN VALUES"
191 .IX Header "RETURN VALUES"
192 \&\fIBIO_f_md()\fR returns the digest \s-1BIO\s0 method.
193 .PP
194 \&\fIBIO_set_md()\fR, \fIBIO_get_md()\fR and \fIBIO_md_ctx()\fR return 1 for success and
195 0 for failure.
196 .SH "EXAMPLES"
197 .IX Header "EXAMPLES"
198 The following example creates a \s-1BIO\s0 chain containing an \s-1SHA1\s0 and \s-1MD5\s0
199 digest \s-1BIO\s0 and passes the string \*(L"Hello World\*(R" through it. Error
200 checking has been omitted for clarity.
201 .PP
202 .Vb 14
203 \& BIO *bio, *mdtmp;
204 \& char message[] = "Hello World";
205 \& bio = BIO_new(BIO_s_null());
206 \& mdtmp = BIO_new(BIO_f_md());
207 \& BIO_set_md(mdtmp, EVP_sha1());
208 \& /* For BIO_push() we want to append the sink BIO and keep a note of
209 \&  * the start of the chain.
210 \&  */
211 \& bio = BIO_push(mdtmp, bio);
212 \& mdtmp = BIO_new(BIO_f_md());
213 \& BIO_set_md(mdtmp, EVP_md5());
214 \& bio = BIO_push(mdtmp, bio);
215 \& /* Note: mdtmp can now be discarded */
216 \& BIO_write(bio, message, strlen(message));
217 .Ve
218 .PP
219 The next example digests data by reading through a chain instead:
220 .PP
221 .Vb 14
222 \& BIO *bio, *mdtmp;
223 \& char buf[1024];
224 \& int rdlen;
225 \& bio = BIO_new_file(file, "rb");
226 \& mdtmp = BIO_new(BIO_f_md());
227 \& BIO_set_md(mdtmp, EVP_sha1());
228 \& bio = BIO_push(mdtmp, bio);
229 \& mdtmp = BIO_new(BIO_f_md());
230 \& BIO_set_md(mdtmp, EVP_md5());
231 \& bio = BIO_push(mdtmp, bio);
232 \& do {
233 \&        rdlen = BIO_read(bio, buf, sizeof(buf));
234 \&        /* Might want to do something with the data here */
235 \& } while(rdlen > 0);
236 .Ve
237 .PP
238 This next example retrieves the message digests from a \s-1BIO\s0 chain and
239 outputs them. This could be used with the examples above.
240 .PP
241 .Vb 16
242 \& BIO *mdtmp;
243 \& unsigned char mdbuf[EVP_MAX_MD_SIZE];
244 \& int mdlen;
245 \& int i;
246 \& mdtmp = bio;   /* Assume bio has previously been set up */
247 \& do {
248 \&        EVP_MD *md;
249 \&        mdtmp = BIO_find_type(mdtmp, BIO_TYPE_MD);
250 \&        if(!mdtmp) break;
251 \&        BIO_get_md(mdtmp, &md);
252 \&        printf("%s digest", OBJ_nid2sn(EVP_MD_type(md)));
253 \&        mdlen = BIO_gets(mdtmp, mdbuf, EVP_MAX_MD_SIZE);
254 \&        for(i = 0; i < mdlen; i++) printf(":%02X", mdbuf[i]);
255 \&        printf("\en");
256 \&        mdtmp = BIO_next(mdtmp);
257 \& } while(mdtmp);
258 .Ve
259 .PP
260 .Vb 1
261 \& BIO_free_all(bio);
262 .Ve
263 .SH "BUGS"
264 .IX Header "BUGS"
265 The lack of support for \fIBIO_puts()\fR and the non standard behaviour of
266 \&\fIBIO_gets()\fR could be regarded as anomalous. It could be argued that \fIBIO_gets()\fR
267 and \fIBIO_puts()\fR should be passed to the next \s-1BIO\s0 in the chain and digest
268 the data passed through and that digests should be retrieved using a
269 separate \fIBIO_ctrl()\fR call.
270 .SH "SEE ALSO"
271 .IX Header "SEE ALSO"
272 \&\s-1TBA\s0