secure/lib/libcrypto/man/BIO_f_md.3

   1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
   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.  \*(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<>.
  32 .tr \(*W-
  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 .\" Escape single quotes in literal strings from groff's Unicode transform.
  52 .ie \n(.g .ds Aq \(aq
  53 .el       .ds Aq '
  54 .\"
  55 .\" If the F register is turned on, we'll generate index entries on stderr for
  56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  57 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  58 .\" output yourself in some meaningful fashion.
  59 .ie \nF \{\
  60 .    de IX
  61 .    tm Index:\\$1\t\\n%\t"\\$2"
  62 ..
  63 .    nr % 0
  64 .    rr F
  65 .\}
  66 .el \{\
  67 .    de IX
  68 ..
  69 .\}
  70 .\"
  71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  72 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  73 .    \" fudge factors for nroff and troff
  74 .if n \{\
  75 .    ds #H 0
  76 .    ds #V .8m
  77 .    ds #F .3m
  78 .    ds #[ \f1
  79 .    ds #] \fP
  80 .\}
  81 .if t \{\
  82 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  83 .    ds #V .6m
  84 .    ds #F 0
  85 .    ds #[ \&
  86 .    ds #] \&
  87 .\}
  88 .    \" simple accents for nroff and troff
  89 .if n \{\
  90 .    ds ' \&
  91 .    ds ` \&
  92 .    ds ^ \&
  93 .    ds , \&
  94 .    ds ~ ~
  95 .    ds /
  96 .\}
  97 .if t \{\
  98 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  99 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 100 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 101 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 102 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 103 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 104 .\}
 105 .    \" troff and (daisy-wheel) nroff accents
 106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 113 .ds ae a\h'-(\w'a'u*4/10)'e
 114 .ds Ae A\h'-(\w'A'u*4/10)'E
 115 .    \" corrections for vroff
 116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 118 .    \" for low resolution devices (crt and lpr)
 119 .if \n(.H>23 .if \n(.V>19 \
 120 \{\
 121 .    ds : e
 122 .    ds 8 ss
 123 .    ds o a
 124 .    ds d- d\h'-1'\(ga
 125 .    ds D- D\h'-1'\(hy
 126 .    ds th \o'bp'
 127 .    ds Th \o'LP'
 128 .    ds ae ae
 129 .    ds Ae AE
 130 .\}
 131 .rm #[ #] #H #V #F C
 132 .\" ========================================================================
 133 .\"
 134 .IX Title "BIO_f_md 3"
 135 .TH BIO_f_md 3 "2010-02-27" "0.9.8m" "OpenSSL"
 136 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 137 .\" way too many mistakes in technical documents.
 138 .if n .ad l
 139 .nh
 140 .SH "NAME"
 141 BIO_f_md, BIO_set_md, BIO_get_md, BIO_get_md_ctx \- message digest BIO filter
 142 .SH "SYNOPSIS"
 143 .IX Header "SYNOPSIS"
 144 .Vb 2
 145 \& #include <openssl/bio.h>
 146 \& #include <openssl/evp.h>
 147 \&
 148 \& BIO_METHOD *   BIO_f_md(void);
 149 \& int BIO_set_md(BIO *b,EVP_MD *md);
 150 \& int BIO_get_md(BIO *b,EVP_MD **mdp);
 151 \& int BIO_get_md_ctx(BIO *b,EVP_MD_CTX **mdcp);
 152 .Ve
 153 .SH "DESCRIPTION"
 154 .IX Header "DESCRIPTION"
 155 \&\fIBIO_f_md()\fR returns the message digest \s-1BIO\s0 method. This is a filter
 156 \&\s-1BIO\s0 that digests any data passed through it, it is a \s-1BIO\s0 wrapper
 157 for the digest routines \fIEVP_DigestInit()\fR, \fIEVP_DigestUpdate()\fR
 158 and \fIEVP_DigestFinal()\fR.
 159 .PP
 160 Any data written or read through a digest \s-1BIO\s0 using \fIBIO_read()\fR and
 161 \&\fIBIO_write()\fR is digested.
 162 .PP
 163 \&\fIBIO_gets()\fR, if its \fBsize\fR parameter is large enough finishes the
 164 digest calculation and returns the digest value. \fIBIO_puts()\fR is
 165 not supported.
 166 .PP
 167 \&\fIBIO_reset()\fR reinitialises a digest \s-1BIO\s0.
 168 .PP
 169 \&\fIBIO_set_md()\fR sets the message digest of \s-1BIO\s0 \fBb\fR to \fBmd\fR: this
 170 must be called to initialize a digest \s-1BIO\s0 before any data is
 171 passed through it. It is a \fIBIO_ctrl()\fR macro.
 172 .PP
 173 \&\fIBIO_get_md()\fR places the a pointer to the digest BIOs digest method
 174 in \fBmdp\fR, it is a \fIBIO_ctrl()\fR macro.
 175 .PP
 176 \&\fIBIO_get_md_ctx()\fR returns the digest BIOs context into \fBmdcp\fR.
 177 .SH "NOTES"
 178 .IX Header "NOTES"
 179 The context returned by \fIBIO_get_md_ctx()\fR can be used in calls
 180 to \fIEVP_DigestFinal()\fR and also the signature routines \fIEVP_SignFinal()\fR
 181 and \fIEVP_VerifyFinal()\fR.
 182 .PP
 183 The context returned by \fIBIO_get_md_ctx()\fR is an internal context
 184 structure. Changes made to this context will affect the digest
 185 \&\s-1BIO\s0 itself and the context pointer will become invalid when the digest
 186 \&\s-1BIO\s0 is freed.
 187 .PP
 188 After the digest has been retrieved from a digest \s-1BIO\s0 it must be
 189 reinitialized by calling \fIBIO_reset()\fR, or \fIBIO_set_md()\fR before any more
 190 data is passed through it.
 191 .PP
 192 If an application needs to call \fIBIO_gets()\fR or \fIBIO_puts()\fR through
 193 a chain containing digest BIOs then this can be done by prepending
 194 a buffering \s-1BIO\s0.
 195 .SH "RETURN VALUES"
 196 .IX Header "RETURN VALUES"
 197 \&\fIBIO_f_md()\fR returns the digest \s-1BIO\s0 method.
 198 .PP
 199 \&\fIBIO_set_md()\fR, \fIBIO_get_md()\fR and \fIBIO_md_ctx()\fR return 1 for success and
 200 0 for failure.
 201 .SH "EXAMPLES"
 202 .IX Header "EXAMPLES"
 203 The following example creates a \s-1BIO\s0 chain containing an \s-1SHA1\s0 and \s-1MD5\s0
 204 digest \s-1BIO\s0 and passes the string \*(L"Hello World\*(R" through it. Error
 205 checking has been omitted for clarity.
 206 .PP
 207 .Vb 10
 208 \& BIO *bio, *mdtmp;
 209 \& char message[] = "Hello World";
 210 \& bio = BIO_new(BIO_s_null());
 211 \& mdtmp = BIO_new(BIO_f_md());
 212 \& BIO_set_md(mdtmp, EVP_sha1());
 213 \& /* For BIO_push() we want to append the sink BIO and keep a note of
 214 \&  * the start of the chain.
 215 \&  */
 216 \& bio = BIO_push(mdtmp, bio);
 217 \& mdtmp = BIO_new(BIO_f_md());
 218 \& BIO_set_md(mdtmp, EVP_md5());
 219 \& bio = BIO_push(mdtmp, bio);
 220 \& /* Note: mdtmp can now be discarded */
 221 \& BIO_write(bio, message, strlen(message));
 222 .Ve
 223 .PP
 224 The next example digests data by reading through a chain instead:
 225 .PP
 226 .Vb 10
 227 \& BIO *bio, *mdtmp;
 228 \& char buf[1024];
 229 \& int rdlen;
 230 \& bio = BIO_new_file(file, "rb");
 231 \& mdtmp = BIO_new(BIO_f_md());
 232 \& BIO_set_md(mdtmp, EVP_sha1());
 233 \& bio = BIO_push(mdtmp, bio);
 234 \& mdtmp = BIO_new(BIO_f_md());
 235 \& BIO_set_md(mdtmp, EVP_md5());
 236 \& bio = BIO_push(mdtmp, bio);
 237 \& do {
 238 \&        rdlen = BIO_read(bio, buf, sizeof(buf));
 239 \&        /* Might want to do something with the data here */
 240 \& } while(rdlen > 0);
 241 .Ve
 242 .PP
 243 This next example retrieves the message digests from a \s-1BIO\s0 chain and
 244 outputs them. This could be used with the examples above.
 245 .PP
 246 .Vb 10
 247 \& BIO *mdtmp;
 248 \& unsigned char mdbuf[EVP_MAX_MD_SIZE];
 249 \& int mdlen;
 250 \& int i;
 251 \& mdtmp = bio;   /* Assume bio has previously been set up */
 252 \& do {
 253 \&        EVP_MD *md;
 254 \&        mdtmp = BIO_find_type(mdtmp, BIO_TYPE_MD);
 255 \&        if(!mdtmp) break;
 256 \&        BIO_get_md(mdtmp, &md);
 257 \&        printf("%s digest", OBJ_nid2sn(EVP_MD_type(md)));
 258 \&        mdlen = BIO_gets(mdtmp, mdbuf, EVP_MAX_MD_SIZE);
 259 \&        for(i = 0; i < mdlen; i++) printf(":%02X", mdbuf[i]);
 260 \&        printf("\en");
 261 \&        mdtmp = BIO_next(mdtmp);
 262 \& } while(mdtmp);
 263 \&
 264 \& BIO_free_all(bio);
 265 .Ve
 266 .SH "BUGS"
 267 .IX Header "BUGS"
 268 The lack of support for \fIBIO_puts()\fR and the non standard behaviour of
 269 \&\fIBIO_gets()\fR could be regarded as anomalous. It could be argued that \fIBIO_gets()\fR
 270 and \fIBIO_puts()\fR should be passed to the next \s-1BIO\s0 in the chain and digest
 271 the data passed through and that digests should be retrieved using a
 272 separate \fIBIO_ctrl()\fR call.
 273 .SH "SEE ALSO"
 274 .IX Header "SEE ALSO"
 275 \&\s-1TBA\s0