OpenSSL  1.0.1c
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros
bio.h
Go to the documentation of this file.
1 /* crypto/bio/bio.h */
2 /* Copyright (C) 1995-1998 Eric Young ([email protected])
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young ([email protected]).
7  * The implementation was written so as to conform with Netscapes SSL.
8  *
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to. The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson ([email protected]).
15  *
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  *
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  * notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  * notice, this list of conditions and the following disclaimer in the
30  * documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  * must display the following acknowledgement:
33  * "This product includes cryptographic software written by
34  * Eric Young ([email protected])"
35  * The word 'cryptographic' can be left out if the rouines from the library
36  * being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from
38  * the apps directory (application code) you must include an acknowledgement:
39  * "This product includes software written by Tim Hudson ([email protected])"
40  *
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  *
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed. i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58 
59 #ifndef HEADER_BIO_H
60 #define HEADER_BIO_H
61 
62 #include <openssl/e_os2.h>
63 
64 #ifndef OPENSSL_NO_FP_API
65 # include <stdio.h>
66 #endif
67 #include <stdarg.h>
68 
69 #include <openssl/crypto.h>
70 
71 #ifndef OPENSSL_NO_SCTP
72 # ifndef OPENSSL_SYS_VMS
73 # include <stdint.h>
74 # else
75 # include <inttypes.h>
76 # endif
77 #endif
78 
79 #ifdef __cplusplus
80 extern "C" {
81 #endif
82 
83 /* These are the 'types' of BIOs */
84 #define BIO_TYPE_NONE 0
85 #define BIO_TYPE_MEM (1|0x0400)
86 #define BIO_TYPE_FILE (2|0x0400)
87 
88 #define BIO_TYPE_FD (4|0x0400|0x0100)
89 #define BIO_TYPE_SOCKET (5|0x0400|0x0100)
90 #define BIO_TYPE_NULL (6|0x0400)
91 #define BIO_TYPE_SSL (7|0x0200)
92 #define BIO_TYPE_MD (8|0x0200) /* passive filter */
93 #define BIO_TYPE_BUFFER (9|0x0200) /* filter */
94 #define BIO_TYPE_CIPHER (10|0x0200) /* filter */
95 #define BIO_TYPE_BASE64 (11|0x0200) /* filter */
96 #define BIO_TYPE_CONNECT (12|0x0400|0x0100) /* socket - connect */
97 #define BIO_TYPE_ACCEPT (13|0x0400|0x0100) /* socket for accept */
98 #define BIO_TYPE_PROXY_CLIENT (14|0x0200) /* client proxy BIO */
99 #define BIO_TYPE_PROXY_SERVER (15|0x0200) /* server proxy BIO */
100 #define BIO_TYPE_NBIO_TEST (16|0x0200) /* server proxy BIO */
101 #define BIO_TYPE_NULL_FILTER (17|0x0200)
102 #define BIO_TYPE_BER (18|0x0200) /* BER -> bin filter */
103 #define BIO_TYPE_BIO (19|0x0400) /* (half a) BIO pair */
104 #define BIO_TYPE_LINEBUFFER (20|0x0200) /* filter */
105 #define BIO_TYPE_DGRAM (21|0x0400|0x0100)
106 #ifndef OPENSSL_NO_SCTP
107 #define BIO_TYPE_DGRAM_SCTP (24|0x0400|0x0100)
108 #endif
109 #define BIO_TYPE_ASN1 (22|0x0200) /* filter */
110 #define BIO_TYPE_COMP (23|0x0200) /* filter */
111 
112 #define BIO_TYPE_DESCRIPTOR 0x0100 /* socket, fd, connect or accept */
113 #define BIO_TYPE_FILTER 0x0200
114 #define BIO_TYPE_SOURCE_SINK 0x0400
115 
116 /* BIO_FILENAME_READ|BIO_CLOSE to open or close on free.
117  * BIO_set_fp(in,stdin,BIO_NOCLOSE); */
118 #define BIO_NOCLOSE 0x00
119 #define BIO_CLOSE 0x01
120 
121 /* These are used in the following macros and are passed to
122  * BIO_ctrl() */
123 #define BIO_CTRL_RESET 1 /* opt - rewind/zero etc */
124 #define BIO_CTRL_EOF 2 /* opt - are we at the eof */
125 #define BIO_CTRL_INFO 3 /* opt - extra tit-bits */
126 #define BIO_CTRL_SET 4 /* man - set the 'IO' type */
127 #define BIO_CTRL_GET 5 /* man - get the 'IO' type */
128 #define BIO_CTRL_PUSH 6 /* opt - internal, used to signify change */
129 #define BIO_CTRL_POP 7 /* opt - internal, used to signify change */
130 #define BIO_CTRL_GET_CLOSE 8 /* man - set the 'close' on free */
131 #define BIO_CTRL_SET_CLOSE 9 /* man - set the 'close' on free */
132 #define BIO_CTRL_PENDING 10 /* opt - is their more data buffered */
133 #define BIO_CTRL_FLUSH 11 /* opt - 'flush' buffered output */
134 #define BIO_CTRL_DUP 12 /* man - extra stuff for 'duped' BIO */
135 #define BIO_CTRL_WPENDING 13 /* opt - number of bytes still to write */
136 /* callback is int cb(BIO *bio,state,ret); */
137 #define BIO_CTRL_SET_CALLBACK 14 /* opt - set callback function */
138 #define BIO_CTRL_GET_CALLBACK 15 /* opt - set callback function */
139 
140 #define BIO_CTRL_SET_FILENAME 30 /* BIO_s_file special */
141 
142 /* dgram BIO stuff */
143 #define BIO_CTRL_DGRAM_CONNECT 31 /* BIO dgram special */
144 #define BIO_CTRL_DGRAM_SET_CONNECTED 32 /* allow for an externally
145  * connected socket to be
146  * passed in */
147 #define BIO_CTRL_DGRAM_SET_RECV_TIMEOUT 33 /* setsockopt, essentially */
148 #define BIO_CTRL_DGRAM_GET_RECV_TIMEOUT 34 /* getsockopt, essentially */
149 #define BIO_CTRL_DGRAM_SET_SEND_TIMEOUT 35 /* setsockopt, essentially */
150 #define BIO_CTRL_DGRAM_GET_SEND_TIMEOUT 36 /* getsockopt, essentially */
152 #define BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP 37 /* flag whether the last */
153 #define BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP 38 /* I/O operation tiemd out */
154 
155 /* #ifdef IP_MTU_DISCOVER */
156 #define BIO_CTRL_DGRAM_MTU_DISCOVER 39 /* set DF bit on egress packets */
157 /* #endif */
159 #define BIO_CTRL_DGRAM_QUERY_MTU 40 /* as kernel for current MTU */
160 #define BIO_CTRL_DGRAM_GET_FALLBACK_MTU 47
161 #define BIO_CTRL_DGRAM_GET_MTU 41 /* get cached value for MTU */
162 #define BIO_CTRL_DGRAM_SET_MTU 42 /* set cached value for
163  * MTU. want to use this
164  * if asking the kernel
165  * fails */
166 
167 #define BIO_CTRL_DGRAM_MTU_EXCEEDED 43 /* check whether the MTU
168  * was exceed in the
169  * previous write
170  * operation */
172 #define BIO_CTRL_DGRAM_GET_PEER 46
173 #define BIO_CTRL_DGRAM_SET_PEER 44 /* Destination for the data */
175 #define BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT 45 /* Next DTLS handshake timeout to
176  * adjust socket timeouts */
178 #ifndef OPENSSL_NO_SCTP
179 /* SCTP stuff */
180 #define BIO_CTRL_DGRAM_SCTP_SET_IN_HANDSHAKE 50
181 #define BIO_CTRL_DGRAM_SCTP_ADD_AUTH_KEY 51
182 #define BIO_CTRL_DGRAM_SCTP_NEXT_AUTH_KEY 52
183 #define BIO_CTRL_DGRAM_SCTP_AUTH_CCS_RCVD 53
184 #define BIO_CTRL_DGRAM_SCTP_GET_SNDINFO 60
185 #define BIO_CTRL_DGRAM_SCTP_SET_SNDINFO 61
186 #define BIO_CTRL_DGRAM_SCTP_GET_RCVINFO 62
187 #define BIO_CTRL_DGRAM_SCTP_SET_RCVINFO 63
188 #define BIO_CTRL_DGRAM_SCTP_GET_PRINFO 64
189 #define BIO_CTRL_DGRAM_SCTP_SET_PRINFO 65
190 #define BIO_CTRL_DGRAM_SCTP_SAVE_SHUTDOWN 70
191 #endif
193 /* modifiers */
194 #define BIO_FP_READ 0x02
195 #define BIO_FP_WRITE 0x04
196 #define BIO_FP_APPEND 0x08
197 #define BIO_FP_TEXT 0x10
199 #define BIO_FLAGS_READ 0x01
200 #define BIO_FLAGS_WRITE 0x02
201 #define BIO_FLAGS_IO_SPECIAL 0x04
202 #define BIO_FLAGS_RWS (BIO_FLAGS_READ|BIO_FLAGS_WRITE|BIO_FLAGS_IO_SPECIAL)
203 #define BIO_FLAGS_SHOULD_RETRY 0x08
204 #ifndef BIO_FLAGS_UPLINK
205 /* "UPLINK" flag denotes file descriptors provided by application.
206  It defaults to 0, as most platforms don't require UPLINK interface. */
207 #define BIO_FLAGS_UPLINK 0
208 #endif
209 
210 /* Used in BIO_gethostbyname() */
211 #define BIO_GHBN_CTRL_HITS 1
212 #define BIO_GHBN_CTRL_MISSES 2
213 #define BIO_GHBN_CTRL_CACHE_SIZE 3
214 #define BIO_GHBN_CTRL_GET_ENTRY 4
215 #define BIO_GHBN_CTRL_FLUSH 5
216 
217 /* Mostly used in the SSL BIO */
218 /* Not used anymore
219  * #define BIO_FLAGS_PROTOCOL_DELAYED_READ 0x10
220  * #define BIO_FLAGS_PROTOCOL_DELAYED_WRITE 0x20
221  * #define BIO_FLAGS_PROTOCOL_STARTUP 0x40
222  */
223 
224 #define BIO_FLAGS_BASE64_NO_NL 0x100
225 
226 /* This is used with memory BIOs: it means we shouldn't free up or change the
227  * data in any way.
228  */
229 #define BIO_FLAGS_MEM_RDONLY 0x200
230 
231 typedef struct bio_st BIO;
232 
233 void BIO_set_flags(BIO *b, int flags);
234 int BIO_test_flags(const BIO *b, int flags);
235 void BIO_clear_flags(BIO *b, int flags);
236 
237 #define BIO_get_flags(b) BIO_test_flags(b, ~(0x0))
238 #define BIO_set_retry_special(b) \
239  BIO_set_flags(b, (BIO_FLAGS_IO_SPECIAL|BIO_FLAGS_SHOULD_RETRY))
240 #define BIO_set_retry_read(b) \
241  BIO_set_flags(b, (BIO_FLAGS_READ|BIO_FLAGS_SHOULD_RETRY))
242 #define BIO_set_retry_write(b) \
243  BIO_set_flags(b, (BIO_FLAGS_WRITE|BIO_FLAGS_SHOULD_RETRY))
245 /* These are normally used internally in BIOs */
246 #define BIO_clear_retry_flags(b) \
247  BIO_clear_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
248 #define BIO_get_retry_flags(b) \
249  BIO_test_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
250 
251 /* These should be used by the application to tell why we should retry */
252 #define BIO_should_read(a) BIO_test_flags(a, BIO_FLAGS_READ)
253 #define BIO_should_write(a) BIO_test_flags(a, BIO_FLAGS_WRITE)
254 #define BIO_should_io_special(a) BIO_test_flags(a, BIO_FLAGS_IO_SPECIAL)
255 #define BIO_retry_type(a) BIO_test_flags(a, BIO_FLAGS_RWS)
256 #define BIO_should_retry(a) BIO_test_flags(a, BIO_FLAGS_SHOULD_RETRY)
258 /* The next three are used in conjunction with the
259  * BIO_should_io_special() condition. After this returns true,
260  * BIO *BIO_get_retry_BIO(BIO *bio, int *reason); will walk the BIO
261  * stack and return the 'reason' for the special and the offending BIO.
262  * Given a BIO, BIO_get_retry_reason(bio) will return the code. */
263 /* Returned from the SSL bio when the certificate retrieval code had an error */
264 #define BIO_RR_SSL_X509_LOOKUP 0x01
265 /* Returned from the connect BIO when a connect would have blocked */
266 #define BIO_RR_CONNECT 0x02
267 /* Returned from the accept BIO when an accept would have blocked */
268 #define BIO_RR_ACCEPT 0x03
269 
270 /* These are passed by the BIO callback */
271 #define BIO_CB_FREE 0x01
272 #define BIO_CB_READ 0x02
273 #define BIO_CB_WRITE 0x03
274 #define BIO_CB_PUTS 0x04
275 #define BIO_CB_GETS 0x05
276 #define BIO_CB_CTRL 0x06
277 
278 /* The callback is called before and after the underling operation,
279  * The BIO_CB_RETURN flag indicates if it is after the call */
280 #define BIO_CB_RETURN 0x80
281 #define BIO_CB_return(a) ((a)|BIO_CB_RETURN))
282 #define BIO_cb_pre(a) (!((a)&BIO_CB_RETURN))
283 #define BIO_cb_post(a) ((a)&BIO_CB_RETURN)
284 
285 long (*BIO_get_callback(const BIO *b)) (struct bio_st *,int,const char *,int, long,long);
286 void BIO_set_callback(BIO *b,
287  long (*callback)(struct bio_st *,int,const char *,int, long,long));
288 char *BIO_get_callback_arg(const BIO *b);
289 void BIO_set_callback_arg(BIO *b, char *arg);
290 
291 const char * BIO_method_name(const BIO *b);
292 int BIO_method_type(const BIO *b);
293 
294 typedef void bio_info_cb(struct bio_st *, int, const char *, int, long, long);
295 
296 typedef struct bio_method_st
297  {
298  int type;
299  const char *name;
300  int (*bwrite)(BIO *, const char *, int);
301  int (*bread)(BIO *, char *, int);
302  int (*bputs)(BIO *, const char *);
303  int (*bgets)(BIO *, char *, int);
304  long (*ctrl)(BIO *, int, long, void *);
305  int (*create)(BIO *);
306  int (*destroy)(BIO *);
307  long (*callback_ctrl)(BIO *, int, bio_info_cb *);
308  } BIO_METHOD;
309 
310 struct bio_st
311  {
313  /* bio, mode, argp, argi, argl, ret */
314  long (*callback)(struct bio_st *,int,const char *,int, long,long);
315  char *cb_arg; /* first argument for the callback */
316 
317  int init;
318  int shutdown;
319  int flags; /* extra storage */
320  int retry_reason;
321  int num;
322  void *ptr;
323  struct bio_st *next_bio; /* used by filter BIOs */
324  struct bio_st *prev_bio; /* used by filter BIOs */
325  int references;
326  unsigned long num_read;
327  unsigned long num_write;
328 
330  };
331 
333 
334 typedef struct bio_f_buffer_ctx_struct
335  {
336  /* Buffers are setup like this:
337  *
338  * <---------------------- size ----------------------->
339  * +---------------------------------------------------+
340  * | consumed | remaining | free space |
341  * +---------------------------------------------------+
342  * <-- off --><------- len ------->
343  */
344 
345  /* BIO *bio; */ /* this is now in the BIO struct */
346  int ibuf_size; /* how big is the input buffer */
347  int obuf_size; /* how big is the output buffer */
348 
349  char *ibuf; /* the char array */
350  int ibuf_len; /* how many bytes are in it */
351  int ibuf_off; /* write/read offset */
352 
353  char *obuf; /* the char array */
354  int obuf_len; /* how many bytes are in it */
355  int obuf_off; /* write/read offset */
357 
358 /* Prefix and suffix callback in ASN1 BIO */
359 typedef int asn1_ps_func(BIO *b, unsigned char **pbuf, int *plen, void *parg);
360 
361 #ifndef OPENSSL_NO_SCTP
362 /* SCTP parameter structs */
364  {
365  uint16_t snd_sid;
366  uint16_t snd_flags;
367  uint32_t snd_ppid;
368  uint32_t snd_context;
369  };
370 
372  {
373  uint16_t rcv_sid;
374  uint16_t rcv_ssn;
375  uint16_t rcv_flags;
376  uint32_t rcv_ppid;
377  uint32_t rcv_tsn;
378  uint32_t rcv_cumtsn;
379  uint32_t rcv_context;
380  };
383  {
384  uint16_t pr_policy;
385  uint32_t pr_value;
386  };
387 #endif
389 /* connect BIO stuff */
390 #define BIO_CONN_S_BEFORE 1
391 #define BIO_CONN_S_GET_IP 2
392 #define BIO_CONN_S_GET_PORT 3
393 #define BIO_CONN_S_CREATE_SOCKET 4
394 #define BIO_CONN_S_CONNECT 5
395 #define BIO_CONN_S_OK 6
396 #define BIO_CONN_S_BLOCKED_CONNECT 7
397 #define BIO_CONN_S_NBIO 8
398 /*#define BIO_CONN_get_param_hostname BIO_ctrl */
400 #define BIO_C_SET_CONNECT 100
401 #define BIO_C_DO_STATE_MACHINE 101
402 #define BIO_C_SET_NBIO 102
403 #define BIO_C_SET_PROXY_PARAM 103
404 #define BIO_C_SET_FD 104
405 #define BIO_C_GET_FD 105
406 #define BIO_C_SET_FILE_PTR 106
407 #define BIO_C_GET_FILE_PTR 107
408 #define BIO_C_SET_FILENAME 108
409 #define BIO_C_SET_SSL 109
410 #define BIO_C_GET_SSL 110
411 #define BIO_C_SET_MD 111
412 #define BIO_C_GET_MD 112
413 #define BIO_C_GET_CIPHER_STATUS 113
414 #define BIO_C_SET_BUF_MEM 114
415 #define BIO_C_GET_BUF_MEM_PTR 115
416 #define BIO_C_GET_BUFF_NUM_LINES 116
417 #define BIO_C_SET_BUFF_SIZE 117
418 #define BIO_C_SET_ACCEPT 118
419 #define BIO_C_SSL_MODE 119
420 #define BIO_C_GET_MD_CTX 120
421 #define BIO_C_GET_PROXY_PARAM 121
422 #define BIO_C_SET_BUFF_READ_DATA 122 /* data to read first */
423 #define BIO_C_GET_CONNECT 123
424 #define BIO_C_GET_ACCEPT 124
425 #define BIO_C_SET_SSL_RENEGOTIATE_BYTES 125
426 #define BIO_C_GET_SSL_NUM_RENEGOTIATES 126
427 #define BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT 127
428 #define BIO_C_FILE_SEEK 128
429 #define BIO_C_GET_CIPHER_CTX 129
430 #define BIO_C_SET_BUF_MEM_EOF_RETURN 130/*return end of input value*/
431 #define BIO_C_SET_BIND_MODE 131
432 #define BIO_C_GET_BIND_MODE 132
433 #define BIO_C_FILE_TELL 133
434 #define BIO_C_GET_SOCKS 134
435 #define BIO_C_SET_SOCKS 135
437 #define BIO_C_SET_WRITE_BUF_SIZE 136/* for BIO_s_bio */
438 #define BIO_C_GET_WRITE_BUF_SIZE 137
439 #define BIO_C_MAKE_BIO_PAIR 138
440 #define BIO_C_DESTROY_BIO_PAIR 139
441 #define BIO_C_GET_WRITE_GUARANTEE 140
442 #define BIO_C_GET_READ_REQUEST 141
443 #define BIO_C_SHUTDOWN_WR 142
444 #define BIO_C_NREAD0 143
445 #define BIO_C_NREAD 144
446 #define BIO_C_NWRITE0 145
447 #define BIO_C_NWRITE 146
448 #define BIO_C_RESET_READ_REQUEST 147
449 #define BIO_C_SET_MD_CTX 148
451 #define BIO_C_SET_PREFIX 149
452 #define BIO_C_GET_PREFIX 150
453 #define BIO_C_SET_SUFFIX 151
454 #define BIO_C_GET_SUFFIX 152
456 #define BIO_C_SET_EX_ARG 153
457 #define BIO_C_GET_EX_ARG 154
459 #define BIO_set_app_data(s,arg) BIO_set_ex_data(s,0,arg)
460 #define BIO_get_app_data(s) BIO_get_ex_data(s,0)
462 /* BIO_s_connect() and BIO_s_socks4a_connect() */
463 #define BIO_set_conn_hostname(b,name) BIO_ctrl(b,BIO_C_SET_CONNECT,0,(char *)name)
464 #define BIO_set_conn_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,1,(char *)port)
465 #define BIO_set_conn_ip(b,ip) BIO_ctrl(b,BIO_C_SET_CONNECT,2,(char *)ip)
466 #define BIO_set_conn_int_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,3,(char *)port)
467 #define BIO_get_conn_hostname(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,0)
468 #define BIO_get_conn_port(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,1)
469 #define BIO_get_conn_ip(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,2)
470 #define BIO_get_conn_int_port(b) BIO_int_ctrl(b,BIO_C_GET_CONNECT,3,0)
472 
473 #define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL)
475 /* BIO_s_accept_socket() */
476 #define BIO_set_accept_port(b,name) BIO_ctrl(b,BIO_C_SET_ACCEPT,0,(char *)name)
477 #define BIO_get_accept_port(b) BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,0)
478 /* #define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL) */
479 #define BIO_set_nbio_accept(b,n) BIO_ctrl(b,BIO_C_SET_ACCEPT,1,(n)?(void *)"a":NULL)
480 #define BIO_set_accept_bios(b,bio) BIO_ctrl(b,BIO_C_SET_ACCEPT,2,(char *)bio)
482 #define BIO_BIND_NORMAL 0
483 #define BIO_BIND_REUSEADDR_IF_UNUSED 1
484 #define BIO_BIND_REUSEADDR 2
485 #define BIO_set_bind_mode(b,mode) BIO_ctrl(b,BIO_C_SET_BIND_MODE,mode,NULL)
486 #define BIO_get_bind_mode(b,mode) BIO_ctrl(b,BIO_C_GET_BIND_MODE,0,NULL)
488 #define BIO_do_connect(b) BIO_do_handshake(b)
489 #define BIO_do_accept(b) BIO_do_handshake(b)
490 #define BIO_do_handshake(b) BIO_ctrl(b,BIO_C_DO_STATE_MACHINE,0,NULL)
492 /* BIO_s_proxy_client() */
493 #define BIO_set_url(b,url) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,0,(char *)(url))
494 #define BIO_set_proxies(b,p) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,1,(char *)(p))
495 /* BIO_set_nbio(b,n) */
496 #define BIO_set_filter_bio(b,s) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,2,(char *)(s))
497 /* BIO *BIO_get_filter_bio(BIO *bio); */
498 #define BIO_set_proxy_cb(b,cb) BIO_callback_ctrl(b,BIO_C_SET_PROXY_PARAM,3,(void *(*cb)()))
499 #define BIO_set_proxy_header(b,sk) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,4,(char *)sk)
500 #define BIO_set_no_connect_return(b,bool) BIO_int_ctrl(b,BIO_C_SET_PROXY_PARAM,5,bool)
502 #define BIO_get_proxy_header(b,skp) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,0,(char *)skp)
503 #define BIO_get_proxies(b,pxy_p) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,1,(char *)(pxy_p))
504 #define BIO_get_url(b,url) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,2,(char *)(url))
505 #define BIO_get_no_connect_return(b) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,5,NULL)
506 
507 #define BIO_set_fd(b,fd,c) BIO_int_ctrl(b,BIO_C_SET_FD,c,fd)
508 #define BIO_get_fd(b,c) BIO_ctrl(b,BIO_C_GET_FD,0,(char *)c)
509 
510 #define BIO_set_fp(b,fp,c) BIO_ctrl(b,BIO_C_SET_FILE_PTR,c,(char *)fp)
511 #define BIO_get_fp(b,fpp) BIO_ctrl(b,BIO_C_GET_FILE_PTR,0,(char *)fpp)
512 
513 #define BIO_seek(b,ofs) (int)BIO_ctrl(b,BIO_C_FILE_SEEK,ofs,NULL)
514 #define BIO_tell(b) (int)BIO_ctrl(b,BIO_C_FILE_TELL,0,NULL)
516 /* name is cast to lose const, but might be better to route through a function
517  so we can do it safely */
518 #ifdef CONST_STRICT
519 /* If you are wondering why this isn't defined, its because CONST_STRICT is
520  * purely a compile-time kludge to allow const to be checked.
521  */
522 int BIO_read_filename(BIO *b,const char *name);
523 #else
524 #define BIO_read_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
525  BIO_CLOSE|BIO_FP_READ,(char *)name)
526 #endif
527 #define BIO_write_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
528  BIO_CLOSE|BIO_FP_WRITE,name)
529 #define BIO_append_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
530  BIO_CLOSE|BIO_FP_APPEND,name)
531 #define BIO_rw_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
532  BIO_CLOSE|BIO_FP_READ|BIO_FP_WRITE,name)
533 
534 /* WARNING WARNING, this ups the reference count on the read bio of the
535  * SSL structure. This is because the ssl read BIO is now pointed to by
536  * the next_bio field in the bio. So when you free the BIO, make sure
537  * you are doing a BIO_free_all() to catch the underlying BIO. */
538 #define BIO_set_ssl(b,ssl,c) BIO_ctrl(b,BIO_C_SET_SSL,c,(char *)ssl)
539 #define BIO_get_ssl(b,sslp) BIO_ctrl(b,BIO_C_GET_SSL,0,(char *)sslp)
540 #define BIO_set_ssl_mode(b,client) BIO_ctrl(b,BIO_C_SSL_MODE,client,NULL)
541 #define BIO_set_ssl_renegotiate_bytes(b,num) \
542  BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_BYTES,num,NULL);
543 #define BIO_get_num_renegotiates(b) \
544  BIO_ctrl(b,BIO_C_GET_SSL_NUM_RENEGOTIATES,0,NULL);
545 #define BIO_set_ssl_renegotiate_timeout(b,seconds) \
546  BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT,seconds,NULL);
547 
548 /* defined in evp.h */
549 /* #define BIO_set_md(b,md) BIO_ctrl(b,BIO_C_SET_MD,1,(char *)md) */
551 #define BIO_get_mem_data(b,pp) BIO_ctrl(b,BIO_CTRL_INFO,0,(char *)pp)
552 #define BIO_set_mem_buf(b,bm,c) BIO_ctrl(b,BIO_C_SET_BUF_MEM,c,(char *)bm)
553 #define BIO_get_mem_ptr(b,pp) BIO_ctrl(b,BIO_C_GET_BUF_MEM_PTR,0,(char *)pp)
554 #define BIO_set_mem_eof_return(b,v) \
555  BIO_ctrl(b,BIO_C_SET_BUF_MEM_EOF_RETURN,v,NULL)
557 /* For the BIO_f_buffer() type */
558 #define BIO_get_buffer_num_lines(b) BIO_ctrl(b,BIO_C_GET_BUFF_NUM_LINES,0,NULL)
559 #define BIO_set_buffer_size(b,size) BIO_ctrl(b,BIO_C_SET_BUFF_SIZE,size,NULL)
560 #define BIO_set_read_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,0)
561 #define BIO_set_write_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,1)
562 #define BIO_set_buffer_read_data(b,buf,num) BIO_ctrl(b,BIO_C_SET_BUFF_READ_DATA,num,buf)
564 /* Don't use the next one unless you know what you are doing :-) */
565 #define BIO_dup_state(b,ret) BIO_ctrl(b,BIO_CTRL_DUP,0,(char *)(ret))
566 
567 #define BIO_reset(b) (int)BIO_ctrl(b,BIO_CTRL_RESET,0,NULL)
568 #define BIO_eof(b) (int)BIO_ctrl(b,BIO_CTRL_EOF,0,NULL)
569 #define BIO_set_close(b,c) (int)BIO_ctrl(b,BIO_CTRL_SET_CLOSE,(c),NULL)
570 #define BIO_get_close(b) (int)BIO_ctrl(b,BIO_CTRL_GET_CLOSE,0,NULL)
571 #define BIO_pending(b) (int)BIO_ctrl(b,BIO_CTRL_PENDING,0,NULL)
572 #define BIO_wpending(b) (int)BIO_ctrl(b,BIO_CTRL_WPENDING,0,NULL)
573 /* ...pending macros have inappropriate return type */
574 size_t BIO_ctrl_pending(BIO *b);
575 size_t BIO_ctrl_wpending(BIO *b);
576 #define BIO_flush(b) (int)BIO_ctrl(b,BIO_CTRL_FLUSH,0,NULL)
577 #define BIO_get_info_callback(b,cbp) (int)BIO_ctrl(b,BIO_CTRL_GET_CALLBACK,0, \
578  cbp)
579 #define BIO_set_info_callback(b,cb) (int)BIO_callback_ctrl(b,BIO_CTRL_SET_CALLBACK,cb)
581 /* For the BIO_f_buffer() type */
582 #define BIO_buffer_get_num_lines(b) BIO_ctrl(b,BIO_CTRL_GET,0,NULL)
584 /* For BIO_s_bio() */
585 #define BIO_set_write_buf_size(b,size) (int)BIO_ctrl(b,BIO_C_SET_WRITE_BUF_SIZE,size,NULL)
586 #define BIO_get_write_buf_size(b,size) (size_t)BIO_ctrl(b,BIO_C_GET_WRITE_BUF_SIZE,size,NULL)
587 #define BIO_make_bio_pair(b1,b2) (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2)
588 #define BIO_destroy_bio_pair(b) (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL)
589 #define BIO_shutdown_wr(b) (int)BIO_ctrl(b, BIO_C_SHUTDOWN_WR, 0, NULL)
590 /* macros with inappropriate type -- but ...pending macros use int too: */
591 #define BIO_get_write_guarantee(b) (int)BIO_ctrl(b,BIO_C_GET_WRITE_GUARANTEE,0,NULL)
592 #define BIO_get_read_request(b) (int)BIO_ctrl(b,BIO_C_GET_READ_REQUEST,0,NULL)
594 size_t BIO_ctrl_get_read_request(BIO *b);
596 
597 /* ctrl macros for dgram */
598 #define BIO_ctrl_dgram_connect(b,peer) \
599  (int)BIO_ctrl(b,BIO_CTRL_DGRAM_CONNECT,0, (char *)peer)
600 #define BIO_ctrl_set_connected(b, state, peer) \
601  (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_CONNECTED, state, (char *)peer)
602 #define BIO_dgram_recv_timedout(b) \
603  (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP, 0, NULL)
604 #define BIO_dgram_send_timedout(b) \
605  (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP, 0, NULL)
606 #define BIO_dgram_get_peer(b,peer) \
607  (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_PEER, 0, (char *)peer)
608 #define BIO_dgram_set_peer(b,peer) \
609  (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_PEER, 0, (char *)peer)
610 
611 /* These two aren't currently implemented */
612 /* int BIO_get_ex_num(BIO *bio); */
613 /* void BIO_set_ex_free_func(BIO *bio,int idx,void (*cb)()); */
614 int BIO_set_ex_data(BIO *bio,int idx,void *data);
615 void *BIO_get_ex_data(BIO *bio,int idx);
616 int BIO_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
618 unsigned long BIO_number_read(BIO *bio);
619 unsigned long BIO_number_written(BIO *bio);
620 
621 /* For BIO_f_asn1() */
622 int BIO_asn1_set_prefix(BIO *b, asn1_ps_func *prefix,
623  asn1_ps_func *prefix_free);
624 int BIO_asn1_get_prefix(BIO *b, asn1_ps_func **pprefix,
625  asn1_ps_func **pprefix_free);
627  asn1_ps_func *suffix_free);
628 int BIO_asn1_get_suffix(BIO *b, asn1_ps_func **psuffix,
629  asn1_ps_func **psuffix_free);
630 
631 # ifndef OPENSSL_NO_FP_API
632 BIO_METHOD *BIO_s_file(void );
633 BIO *BIO_new_file(const char *filename, const char *mode);
634 BIO *BIO_new_fp(FILE *stream, int close_flag);
635 # define BIO_s_file_internal BIO_s_file
636 # endif
638 int BIO_set(BIO *a,BIO_METHOD *type);
639 int BIO_free(BIO *a);
640 void BIO_vfree(BIO *a);
641 int BIO_read(BIO *b, void *data, int len);
642 int BIO_gets(BIO *bp,char *buf, int size);
643 int BIO_write(BIO *b, const void *data, int len);
644 int BIO_puts(BIO *bp,const char *buf);
645 int BIO_indent(BIO *b,int indent,int max);
646 long BIO_ctrl(BIO *bp,int cmd,long larg,void *parg);
647 long BIO_callback_ctrl(BIO *b, int cmd, void (*fp)(struct bio_st *, int, const char *, int, long, long));
648 char * BIO_ptr_ctrl(BIO *bp,int cmd,long larg);
649 long BIO_int_ctrl(BIO *bp,int cmd,long larg,int iarg);
650 BIO * BIO_push(BIO *b,BIO *append);
651 BIO * BIO_pop(BIO *b);
652 void BIO_free_all(BIO *a);
653 BIO * BIO_find_type(BIO *b,int bio_type);
654 BIO * BIO_next(BIO *b);
655 BIO * BIO_get_retry_BIO(BIO *bio, int *reason);
656 int BIO_get_retry_reason(BIO *bio);
657 BIO * BIO_dup_chain(BIO *in);
658 
659 int BIO_nread0(BIO *bio, char **buf);
660 int BIO_nread(BIO *bio, char **buf, int num);
661 int BIO_nwrite0(BIO *bio, char **buf);
662 int BIO_nwrite(BIO *bio, char **buf, int num);
663 
664 long BIO_debug_callback(BIO *bio,int cmd,const char *argp,int argi,
665  long argl,long ret);
666 
667 BIO_METHOD *BIO_s_mem(void);
668 BIO *BIO_new_mem_buf(void *buf, int len);
669 BIO_METHOD *BIO_s_socket(void);
671 BIO_METHOD *BIO_s_accept(void);
672 BIO_METHOD *BIO_s_fd(void);
673 #ifndef OPENSSL_SYS_OS2
674 BIO_METHOD *BIO_s_log(void);
675 #endif
676 BIO_METHOD *BIO_s_bio(void);
677 BIO_METHOD *BIO_s_null(void);
678 BIO_METHOD *BIO_f_null(void);
679 BIO_METHOD *BIO_f_buffer(void);
680 #ifdef OPENSSL_SYS_VMS
682 #endif
684 #ifndef OPENSSL_NO_DGRAM
686 #ifndef OPENSSL_NO_SCTP
688 #endif
689 #endif
690 
691 /* BIO_METHOD *BIO_f_ber(void); */
692 
693 int BIO_sock_should_retry(int i);
696 
697 int BIO_fd_should_retry(int i);
699 int BIO_dump_cb(int (*cb)(const void *data, size_t len, void *u),
700  void *u, const char *s, int len);
701 int BIO_dump_indent_cb(int (*cb)(const void *data, size_t len, void *u),
702  void *u, const char *s, int len, int indent);
703 int BIO_dump(BIO *b,const char *bytes,int len);
704 int BIO_dump_indent(BIO *b,const char *bytes,int len,int indent);
705 #ifndef OPENSSL_NO_FP_API
706 int BIO_dump_fp(FILE *fp, const char *s, int len);
707 int BIO_dump_indent_fp(FILE *fp, const char *s, int len, int indent);
708 #endif
709 struct hostent *BIO_gethostbyname(const char *name);
710 /* We might want a thread-safe interface too:
711  * struct hostent *BIO_gethostbyname_r(const char *name,
712  * struct hostent *result, void *buffer, size_t buflen);
713  * or something similar (caller allocates a struct hostent,
714  * pointed to by "result", and additional buffer space for the various
715  * substructures; if the buffer does not suffice, NULL is returned
716  * and an appropriate error code is set).
717  */
718 int BIO_sock_error(int sock);
719 int BIO_socket_ioctl(int fd, long type, void *arg);
720 int BIO_socket_nbio(int fd,int mode);
721 int BIO_get_port(const char *str, unsigned short *port_ptr);
722 int BIO_get_host_ip(const char *str, unsigned char *ip);
723 int BIO_get_accept_socket(char *host_port,int mode);
724 int BIO_accept(int sock,char **ip_port);
725 int BIO_sock_init(void );
726 void BIO_sock_cleanup(void);
727 int BIO_set_tcp_ndelay(int sock,int turn_on);
728 
729 BIO *BIO_new_socket(int sock, int close_flag);
730 BIO *BIO_new_dgram(int fd, int close_flag);
731 #ifndef OPENSSL_NO_SCTP
732 BIO *BIO_new_dgram_sctp(int fd, int close_flag);
733 int BIO_dgram_is_sctp(BIO *bio);
735  void (*handle_notifications)(BIO *bio, void *context, void *buf),
736  void *context);
739 #endif
740 BIO *BIO_new_fd(int fd, int close_flag);
741 BIO *BIO_new_connect(char *host_port);
742 BIO *BIO_new_accept(char *host_port);
743 
744 int BIO_new_bio_pair(BIO **bio1, size_t writebuf1,
745  BIO **bio2, size_t writebuf2);
746 /* If successful, returns 1 and in *bio1, *bio2 two BIO pair endpoints.
747  * Otherwise returns 0 and sets *bio1 and *bio2 to NULL.
748  * Size 0 uses default value.
749  */
750 
751 void BIO_copy_next_retry(BIO *b);
752 
753 /*long BIO_ghbn_ctrl(int cmd,int iarg,char *parg);*/
754 
755 #ifdef __GNUC__
756 # define __bio_h__attr__ __attribute__
757 #else
758 # define __bio_h__attr__(x)
759 #endif
760 int BIO_printf(BIO *bio, const char *format, ...)
761  __bio_h__attr__((__format__(__printf__,2,3)));
762 int BIO_vprintf(BIO *bio, const char *format, va_list args)
763  __bio_h__attr__((__format__(__printf__,2,0)));
764 int BIO_snprintf(char *buf, size_t n, const char *format, ...)
765  __bio_h__attr__((__format__(__printf__,3,4)));
766 int BIO_vsnprintf(char *buf, size_t n, const char *format, va_list args)
767  __bio_h__attr__((__format__(__printf__,3,0)));
768 #undef __bio_h__attr__
769 
770 /* BEGIN ERROR CODES */
771 /* The following lines are auto generated by the script mkerr.pl. Any changes
772  * made after this point may be overwritten when the script is next run.
773  */
776 /* Error codes for the BIO functions. */
778 /* Function codes. */
779 #define BIO_F_ACPT_STATE 100
780 #define BIO_F_BIO_ACCEPT 101
781 #define BIO_F_BIO_BER_GET_HEADER 102
782 #define BIO_F_BIO_CALLBACK_CTRL 131
783 #define BIO_F_BIO_CTRL 103
784 #define BIO_F_BIO_GETHOSTBYNAME 120
785 #define BIO_F_BIO_GETS 104
786 #define BIO_F_BIO_GET_ACCEPT_SOCKET 105
787 #define BIO_F_BIO_GET_HOST_IP 106
788 #define BIO_F_BIO_GET_PORT 107
789 #define BIO_F_BIO_MAKE_PAIR 121
790 #define BIO_F_BIO_NEW 108
791 #define BIO_F_BIO_NEW_FILE 109
792 #define BIO_F_BIO_NEW_MEM_BUF 126
793 #define BIO_F_BIO_NREAD 123
794 #define BIO_F_BIO_NREAD0 124
795 #define BIO_F_BIO_NWRITE 125
796 #define BIO_F_BIO_NWRITE0 122
797 #define BIO_F_BIO_PUTS 110
798 #define BIO_F_BIO_READ 111
799 #define BIO_F_BIO_SOCK_INIT 112
800 #define BIO_F_BIO_WRITE 113
801 #define BIO_F_BUFFER_CTRL 114
802 #define BIO_F_CONN_CTRL 127
803 #define BIO_F_CONN_STATE 115
804 #define BIO_F_DGRAM_SCTP_READ 132
805 #define BIO_F_FILE_CTRL 116
806 #define BIO_F_FILE_READ 130
807 #define BIO_F_LINEBUFFER_CTRL 129
808 #define BIO_F_MEM_READ 128
809 #define BIO_F_MEM_WRITE 117
810 #define BIO_F_SSL_NEW 118
811 #define BIO_F_WSASTARTUP 119
813 /* Reason codes. */
814 #define BIO_R_ACCEPT_ERROR 100
815 #define BIO_R_BAD_FOPEN_MODE 101
816 #define BIO_R_BAD_HOSTNAME_LOOKUP 102
817 #define BIO_R_BROKEN_PIPE 124
818 #define BIO_R_CONNECT_ERROR 103
819 #define BIO_R_EOF_ON_MEMORY_BIO 127
820 #define BIO_R_ERROR_SETTING_NBIO 104
821 #define BIO_R_ERROR_SETTING_NBIO_ON_ACCEPTED_SOCKET 105
822 #define BIO_R_ERROR_SETTING_NBIO_ON_ACCEPT_SOCKET 106
823 #define BIO_R_GETHOSTBYNAME_ADDR_IS_NOT_AF_INET 107
824 #define BIO_R_INVALID_ARGUMENT 125
825 #define BIO_R_INVALID_IP_ADDRESS 108
826 #define BIO_R_IN_USE 123
827 #define BIO_R_KEEPALIVE 109
828 #define BIO_R_NBIO_CONNECT_ERROR 110
829 #define BIO_R_NO_ACCEPT_PORT_SPECIFIED 111
830 #define BIO_R_NO_HOSTNAME_SPECIFIED 112
831 #define BIO_R_NO_PORT_DEFINED 113
832 #define BIO_R_NO_PORT_SPECIFIED 114
833 #define BIO_R_NO_SUCH_FILE 128
834 #define BIO_R_NULL_PARAMETER 115
835 #define BIO_R_TAG_MISMATCH 116
836 #define BIO_R_UNABLE_TO_BIND_SOCKET 117
837 #define BIO_R_UNABLE_TO_CREATE_SOCKET 118
838 #define BIO_R_UNABLE_TO_LISTEN_SOCKET 119
839 #define BIO_R_UNINITIALIZED 120
840 #define BIO_R_UNSUPPORTED_METHOD 121
841 #define BIO_R_WRITE_TO_READ_ONLY_BIO 126
842 #define BIO_R_WSASTARTUP 122
843 
844 #ifdef __cplusplus
845 }
846 #endif
847 #endif