free NULL cleanup
[openssl.git] / doc / crypto / BIO_f_md.pod
1 =pod
2
3 =head1 NAME
4
5 BIO_f_md, BIO_set_md, BIO_get_md, BIO_get_md_ctx - message digest BIO filter
6
7 =head1 SYNOPSIS
8
9  #include <openssl/bio.h>
10  #include <openssl/evp.h>
11
12  BIO_METHOD *   BIO_f_md(void);
13  int BIO_set_md(BIO *b,EVP_MD *md);
14  int BIO_get_md(BIO *b,EVP_MD **mdp);
15  int BIO_get_md_ctx(BIO *b,EVP_MD_CTX **mdcp);
16
17 =head1 DESCRIPTION
18
19 BIO_f_md() returns the message digest BIO method. This is a filter
20 BIO that digests any data passed through it, it is a BIO wrapper
21 for the digest routines EVP_DigestInit(), EVP_DigestUpdate()
22 and EVP_DigestFinal().
23
24 Any data written or read through a digest BIO using BIO_read() and
25 BIO_write() is digested.
26
27 BIO_gets(), if its B<size> parameter is large enough finishes the
28 digest calculation and returns the digest value. BIO_puts() is
29 not supported.
30
31 BIO_reset() reinitialises a digest BIO.
32
33 BIO_set_md() sets the message digest of BIO B<b> to B<md>: this
34 must be called to initialize a digest BIO before any data is
35 passed through it. It is a BIO_ctrl() macro.
36
37 BIO_get_md() places the a pointer to the digest BIOs digest method
38 in B<mdp>, it is a BIO_ctrl() macro.
39
40 BIO_get_md_ctx() returns the digest BIOs context into B<mdcp>.
41
42 =head1 NOTES
43
44 The context returned by BIO_get_md_ctx() can be used in calls
45 to EVP_DigestFinal() and also the signature routines EVP_SignFinal()
46 and EVP_VerifyFinal().
47
48 The context returned by BIO_get_md_ctx() is an internal context
49 structure. Changes made to this context will affect the digest
50 BIO itself and the context pointer will become invalid when the digest
51 BIO is freed.
52
53 After the digest has been retrieved from a digest BIO it must be
54 reinitialized by calling BIO_reset(), or BIO_set_md() before any more
55 data is passed through it.
56
57 If an application needs to call BIO_gets() or BIO_puts() through
58 a chain containing digest BIOs then this can be done by prepending
59 a buffering BIO.
60
61 Before OpenSSL 1.0.0 the call to BIO_get_md_ctx() would only work if the BIO
62 had been initialized for example by calling BIO_set_md() ). In OpenSSL
63 1.0.0 and later the context is always returned and the BIO is state is set
64 to initialized. This allows applications to initialize the context externally
65 if the standard calls such as BIO_set_md() are not sufficiently flexible.
66
67 =head1 RETURN VALUES
68
69 BIO_f_md() returns the digest BIO method.
70
71 BIO_set_md(), BIO_get_md() and BIO_md_ctx() return 1 for success and
72 0 for failure.
73
74 =head1 EXAMPLES
75
76 The following example creates a BIO chain containing an SHA1 and MD5
77 digest BIO and passes the string "Hello World" through it. Error
78 checking has been omitted for clarity.
79
80  BIO *bio, *mdtmp;
81  char message[] = "Hello World";
82  bio = BIO_new(BIO_s_null());
83  mdtmp = BIO_new(BIO_f_md());
84  BIO_set_md(mdtmp, EVP_sha1());
85  /* For BIO_push() we want to append the sink BIO and keep a note of
86   * the start of the chain.
87   */
88  bio = BIO_push(mdtmp, bio);
89  mdtmp = BIO_new(BIO_f_md());
90  BIO_set_md(mdtmp, EVP_md5());
91  bio = BIO_push(mdtmp, bio);
92  /* Note: mdtmp can now be discarded */
93  BIO_write(bio, message, strlen(message));
94
95 The next example digests data by reading through a chain instead:
96
97  BIO *bio, *mdtmp;
98  char buf[1024];
99  int rdlen;
100  bio = BIO_new_file(file, "rb");
101  mdtmp = BIO_new(BIO_f_md());
102  BIO_set_md(mdtmp, EVP_sha1());
103  bio = BIO_push(mdtmp, bio);
104  mdtmp = BIO_new(BIO_f_md());
105  BIO_set_md(mdtmp, EVP_md5());
106  bio = BIO_push(mdtmp, bio);
107  do {
108         rdlen = BIO_read(bio, buf, sizeof(buf));
109         /* Might want to do something with the data here */
110  } while(rdlen > 0);
111
112 This next example retrieves the message digests from a BIO chain and
113 outputs them. This could be used with the examples above.
114
115  BIO *mdtmp;
116  unsigned char mdbuf[EVP_MAX_MD_SIZE];
117  int mdlen;
118  int i;
119  mdtmp = bio;   /* Assume bio has previously been set up */
120  do {
121         EVP_MD *md;
122         mdtmp = BIO_find_type(mdtmp, BIO_TYPE_MD);
123         if(!mdtmp) break;
124         BIO_get_md(mdtmp, &md);
125         printf("%s digest", OBJ_nid2sn(EVP_MD_type(md)));
126         mdlen = BIO_gets(mdtmp, mdbuf, EVP_MAX_MD_SIZE);
127         for(i = 0; i < mdlen; i++) printf(":%02X", mdbuf[i]);
128         printf("\n");
129         mdtmp = BIO_next(mdtmp);
130  } while(mdtmp);
131
132  BIO_free_all(bio);
133
134 =head1 BUGS
135
136 The lack of support for BIO_puts() and the non standard behaviour of
137 BIO_gets() could be regarded as anomalous. It could be argued that BIO_gets()
138 and BIO_puts() should be passed to the next BIO in the chain and digest
139 the data passed through and that digests should be retrieved using a
140 separate BIO_ctrl() call.
141
142 =head1 SEE ALSO
143
144 TBA