1 .\" Automatically generated by Pod::Man 2.12 (Pod::Simple 3.05)
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
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. \*(C+ will
29 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
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
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.
57 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear. Run. Save yourself. No user-serviceable parts.
65 . \" fudge factors for nroff and troff
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 . \" simple accents for nroff and troff
90 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
97 . \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 . \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 . \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
124 .\" ========================================================================
126 .IX Title "BIO_f_md 3"
127 .TH BIO_f_md 3 "2007-10-24" "0.9.8g" "OpenSSL"
128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
133 BIO_f_md, BIO_set_md, BIO_get_md, BIO_get_md_ctx \- message digest BIO filter
135 .IX Header "SYNOPSIS"
137 \& #include <openssl/bio.h>
138 \& #include <openssl/evp.h>
140 \& BIO_METHOD * BIO_f_md(void);
141 \& int BIO_set_md(BIO *b,EVP_MD *md);
142 \& int BIO_get_md(BIO *b,EVP_MD **mdp);
143 \& int BIO_get_md_ctx(BIO *b,EVP_MD_CTX **mdcp);
146 .IX Header "DESCRIPTION"
147 \&\fIBIO_f_md()\fR returns the message digest \s-1BIO\s0 method. This is a filter
148 \&\s-1BIO\s0 that digests any data passed through it, it is a \s-1BIO\s0 wrapper
149 for the digest routines \fIEVP_DigestInit()\fR, \fIEVP_DigestUpdate()\fR
150 and \fIEVP_DigestFinal()\fR.
152 Any data written or read through a digest \s-1BIO\s0 using \fIBIO_read()\fR and
153 \&\fIBIO_write()\fR is digested.
155 \&\fIBIO_gets()\fR, if its \fBsize\fR parameter is large enough finishes the
156 digest calculation and returns the digest value. \fIBIO_puts()\fR is
159 \&\fIBIO_reset()\fR reinitialises a digest \s-1BIO\s0.
161 \&\fIBIO_set_md()\fR sets the message digest of \s-1BIO\s0 \fBb\fR to \fBmd\fR: this
162 must be called to initialize a digest \s-1BIO\s0 before any data is
163 passed through it. It is a \fIBIO_ctrl()\fR macro.
165 \&\fIBIO_get_md()\fR places the a pointer to the digest BIOs digest method
166 in \fBmdp\fR, it is a \fIBIO_ctrl()\fR macro.
168 \&\fIBIO_get_md_ctx()\fR returns the digest BIOs context into \fBmdcp\fR.
171 The context returned by \fIBIO_get_md_ctx()\fR can be used in calls
172 to \fIEVP_DigestFinal()\fR and also the signature routines \fIEVP_SignFinal()\fR
173 and \fIEVP_VerifyFinal()\fR.
175 The context returned by \fIBIO_get_md_ctx()\fR is an internal context
176 structure. Changes made to this context will affect the digest
177 \&\s-1BIO\s0 itself and the context pointer will become invalid when the digest
178 \&\s-1BIO\s0 is freed.
180 After the digest has been retrieved from a digest \s-1BIO\s0 it must be
181 reinitialized by calling \fIBIO_reset()\fR, or \fIBIO_set_md()\fR before any more
182 data is passed through it.
184 If an application needs to call \fIBIO_gets()\fR or \fIBIO_puts()\fR through
185 a chain containing digest BIOs then this can be done by prepending
186 a buffering \s-1BIO\s0.
188 .IX Header "RETURN VALUES"
189 \&\fIBIO_f_md()\fR returns the digest \s-1BIO\s0 method.
191 \&\fIBIO_set_md()\fR, \fIBIO_get_md()\fR and \fIBIO_md_ctx()\fR return 1 for success and
194 .IX Header "EXAMPLES"
195 The following example creates a \s-1BIO\s0 chain containing an \s-1SHA1\s0 and \s-1MD5\s0
196 digest \s-1BIO\s0 and passes the string \*(L"Hello World\*(R" through it. Error
197 checking has been omitted for clarity.
201 \& char message[] = "Hello World";
202 \& bio = BIO_new(BIO_s_null());
203 \& mdtmp = BIO_new(BIO_f_md());
204 \& BIO_set_md(mdtmp, EVP_sha1());
205 \& /* For BIO_push() we want to append the sink BIO and keep a note of
206 \& * the start of the chain.
208 \& bio = BIO_push(mdtmp, bio);
209 \& mdtmp = BIO_new(BIO_f_md());
210 \& BIO_set_md(mdtmp, EVP_md5());
211 \& bio = BIO_push(mdtmp, bio);
212 \& /* Note: mdtmp can now be discarded */
213 \& BIO_write(bio, message, strlen(message));
216 The next example digests data by reading through a chain instead:
222 \& bio = BIO_new_file(file, "rb");
223 \& mdtmp = BIO_new(BIO_f_md());
224 \& BIO_set_md(mdtmp, EVP_sha1());
225 \& bio = BIO_push(mdtmp, bio);
226 \& mdtmp = BIO_new(BIO_f_md());
227 \& BIO_set_md(mdtmp, EVP_md5());
228 \& bio = BIO_push(mdtmp, bio);
230 \& rdlen = BIO_read(bio, buf, sizeof(buf));
231 \& /* Might want to do something with the data here */
232 \& } while(rdlen > 0);
235 This next example retrieves the message digests from a \s-1BIO\s0 chain and
236 outputs them. This could be used with the examples above.
240 \& unsigned char mdbuf[EVP_MAX_MD_SIZE];
243 \& mdtmp = bio; /* Assume bio has previously been set up */
246 \& mdtmp = BIO_find_type(mdtmp, BIO_TYPE_MD);
248 \& BIO_get_md(mdtmp, &md);
249 \& printf("%s digest", OBJ_nid2sn(EVP_MD_type(md)));
250 \& mdlen = BIO_gets(mdtmp, mdbuf, EVP_MAX_MD_SIZE);
251 \& for(i = 0; i < mdlen; i++) printf(":%02X", mdbuf[i]);
253 \& mdtmp = BIO_next(mdtmp);
256 \& BIO_free_all(bio);
260 The lack of support for \fIBIO_puts()\fR and the non standard behaviour of
261 \&\fIBIO_gets()\fR could be regarded as anomalous. It could be argued that \fIBIO_gets()\fR
262 and \fIBIO_puts()\fR should be passed to the next \s-1BIO\s0 in the chain and digest
263 the data passed through and that digests should be retrieved using a
264 separate \fIBIO_ctrl()\fR call.
266 .IX Header "SEE ALSO"