Fix invalid function type casts.
[openssl.git] / include / openssl / bio.h
1 /*
2  * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #ifndef HEADER_BIO_H
11 # define HEADER_BIO_H
12
13 # include <openssl/e_os2.h>
14
15 # ifndef OPENSSL_NO_STDIO
16 #  include <stdio.h>
17 # endif
18 # include <stdarg.h>
19
20 # include <openssl/crypto.h>
21 # include <openssl/bioerr.h>
22
23 # ifndef OPENSSL_NO_SCTP
24 #  include <openssl/e_os2.h>
25 # endif
26
27 #ifdef  __cplusplus
28 extern "C" {
29 #endif
30
31 /* There are the classes of BIOs */
32 # define BIO_TYPE_DESCRIPTOR     0x0100 /* socket, fd, connect or accept */
33 # define BIO_TYPE_FILTER         0x0200
34 # define BIO_TYPE_SOURCE_SINK    0x0400
35
36 /* These are the 'types' of BIOs */
37 # define BIO_TYPE_NONE             0
38 # define BIO_TYPE_MEM            ( 1|BIO_TYPE_SOURCE_SINK)
39 # define BIO_TYPE_FILE           ( 2|BIO_TYPE_SOURCE_SINK)
40
41 # define BIO_TYPE_FD             ( 4|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
42 # define BIO_TYPE_SOCKET         ( 5|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
43 # define BIO_TYPE_NULL           ( 6|BIO_TYPE_SOURCE_SINK)
44 # define BIO_TYPE_SSL            ( 7|BIO_TYPE_FILTER)
45 # define BIO_TYPE_MD             ( 8|BIO_TYPE_FILTER)
46 # define BIO_TYPE_BUFFER         ( 9|BIO_TYPE_FILTER)
47 # define BIO_TYPE_CIPHER         (10|BIO_TYPE_FILTER)
48 # define BIO_TYPE_BASE64         (11|BIO_TYPE_FILTER)
49 # define BIO_TYPE_CONNECT        (12|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
50 # define BIO_TYPE_ACCEPT         (13|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
51
52 # define BIO_TYPE_NBIO_TEST      (16|BIO_TYPE_FILTER)/* server proxy BIO */
53 # define BIO_TYPE_NULL_FILTER    (17|BIO_TYPE_FILTER)
54 # define BIO_TYPE_BIO            (19|BIO_TYPE_SOURCE_SINK)/* half a BIO pair */
55 # define BIO_TYPE_LINEBUFFER     (20|BIO_TYPE_FILTER)
56 # define BIO_TYPE_DGRAM          (21|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
57 # define BIO_TYPE_ASN1           (22|BIO_TYPE_FILTER)
58 # define BIO_TYPE_COMP           (23|BIO_TYPE_FILTER)
59 # ifndef OPENSSL_NO_SCTP
60 #  define BIO_TYPE_DGRAM_SCTP    (24|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
61 # endif
62
63 #define BIO_TYPE_START           128
64
65 /*
66  * BIO_FILENAME_READ|BIO_CLOSE to open or close on free.
67  * BIO_set_fp(in,stdin,BIO_NOCLOSE);
68  */
69 # define BIO_NOCLOSE             0x00
70 # define BIO_CLOSE               0x01
71
72 /*
73  * These are used in the following macros and are passed to BIO_ctrl()
74  */
75 # define BIO_CTRL_RESET          1/* opt - rewind/zero etc */
76 # define BIO_CTRL_EOF            2/* opt - are we at the eof */
77 # define BIO_CTRL_INFO           3/* opt - extra tit-bits */
78 # define BIO_CTRL_SET            4/* man - set the 'IO' type */
79 # define BIO_CTRL_GET            5/* man - get the 'IO' type */
80 # define BIO_CTRL_PUSH           6/* opt - internal, used to signify change */
81 # define BIO_CTRL_POP            7/* opt - internal, used to signify change */
82 # define BIO_CTRL_GET_CLOSE      8/* man - set the 'close' on free */
83 # define BIO_CTRL_SET_CLOSE      9/* man - set the 'close' on free */
84 # define BIO_CTRL_PENDING        10/* opt - is their more data buffered */
85 # define BIO_CTRL_FLUSH          11/* opt - 'flush' buffered output */
86 # define BIO_CTRL_DUP            12/* man - extra stuff for 'duped' BIO */
87 # define BIO_CTRL_WPENDING       13/* opt - number of bytes still to write */
88 # define BIO_CTRL_SET_CALLBACK   14/* opt - set callback function */
89 # define BIO_CTRL_GET_CALLBACK   15/* opt - set callback function */
90
91 # define BIO_CTRL_PEEK           29/* BIO_f_buffer special */
92 # define BIO_CTRL_SET_FILENAME   30/* BIO_s_file special */
93
94 /* dgram BIO stuff */
95 # define BIO_CTRL_DGRAM_CONNECT       31/* BIO dgram special */
96 # define BIO_CTRL_DGRAM_SET_CONNECTED 32/* allow for an externally connected
97                                          * socket to be passed in */
98 # define BIO_CTRL_DGRAM_SET_RECV_TIMEOUT 33/* setsockopt, essentially */
99 # define BIO_CTRL_DGRAM_GET_RECV_TIMEOUT 34/* getsockopt, essentially */
100 # define BIO_CTRL_DGRAM_SET_SEND_TIMEOUT 35/* setsockopt, essentially */
101 # define BIO_CTRL_DGRAM_GET_SEND_TIMEOUT 36/* getsockopt, essentially */
102
103 # define BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP 37/* flag whether the last */
104 # define BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP 38/* I/O operation tiemd out */
105
106 /* #ifdef IP_MTU_DISCOVER */
107 # define BIO_CTRL_DGRAM_MTU_DISCOVER       39/* set DF bit on egress packets */
108 /* #endif */
109
110 # define BIO_CTRL_DGRAM_QUERY_MTU          40/* as kernel for current MTU */
111 # define BIO_CTRL_DGRAM_GET_FALLBACK_MTU   47
112 # define BIO_CTRL_DGRAM_GET_MTU            41/* get cached value for MTU */
113 # define BIO_CTRL_DGRAM_SET_MTU            42/* set cached value for MTU.
114                                               * want to use this if asking
115                                               * the kernel fails */
116
117 # define BIO_CTRL_DGRAM_MTU_EXCEEDED       43/* check whether the MTU was
118                                               * exceed in the previous write
119                                               * operation */
120
121 # define BIO_CTRL_DGRAM_GET_PEER           46
122 # define BIO_CTRL_DGRAM_SET_PEER           44/* Destination for the data */
123
124 # define BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT   45/* Next DTLS handshake timeout
125                                               * to adjust socket timeouts */
126 # define BIO_CTRL_DGRAM_SET_DONT_FRAG      48
127
128 # define BIO_CTRL_DGRAM_GET_MTU_OVERHEAD   49
129
130 /* Deliberately outside of OPENSSL_NO_SCTP - used in bss_dgram.c */
131 #  define BIO_CTRL_DGRAM_SCTP_SET_IN_HANDSHAKE    50
132 # ifndef OPENSSL_NO_SCTP
133 /* SCTP stuff */
134 #  define BIO_CTRL_DGRAM_SCTP_ADD_AUTH_KEY                51
135 #  define BIO_CTRL_DGRAM_SCTP_NEXT_AUTH_KEY               52
136 #  define BIO_CTRL_DGRAM_SCTP_AUTH_CCS_RCVD               53
137 #  define BIO_CTRL_DGRAM_SCTP_GET_SNDINFO         60
138 #  define BIO_CTRL_DGRAM_SCTP_SET_SNDINFO         61
139 #  define BIO_CTRL_DGRAM_SCTP_GET_RCVINFO         62
140 #  define BIO_CTRL_DGRAM_SCTP_SET_RCVINFO         63
141 #  define BIO_CTRL_DGRAM_SCTP_GET_PRINFO                  64
142 #  define BIO_CTRL_DGRAM_SCTP_SET_PRINFO                  65
143 #  define BIO_CTRL_DGRAM_SCTP_SAVE_SHUTDOWN               70
144 # endif
145
146 # define BIO_CTRL_DGRAM_SET_PEEK_MODE      71
147
148 /* modifiers */
149 # define BIO_FP_READ             0x02
150 # define BIO_FP_WRITE            0x04
151 # define BIO_FP_APPEND           0x08
152 # define BIO_FP_TEXT             0x10
153
154 # define BIO_FLAGS_READ          0x01
155 # define BIO_FLAGS_WRITE         0x02
156 # define BIO_FLAGS_IO_SPECIAL    0x04
157 # define BIO_FLAGS_RWS (BIO_FLAGS_READ|BIO_FLAGS_WRITE|BIO_FLAGS_IO_SPECIAL)
158 # define BIO_FLAGS_SHOULD_RETRY  0x08
159 # ifndef BIO_FLAGS_UPLINK
160 /*
161  * "UPLINK" flag denotes file descriptors provided by application. It
162  * defaults to 0, as most platforms don't require UPLINK interface.
163  */
164 #  define BIO_FLAGS_UPLINK        0
165 # endif
166
167 # define BIO_FLAGS_BASE64_NO_NL  0x100
168
169 /*
170  * This is used with memory BIOs:
171  * BIO_FLAGS_MEM_RDONLY means we shouldn't free up or change the data in any way;
172  * BIO_FLAGS_NONCLEAR_RST means we shouldn't clear data on reset.
173  */
174 # define BIO_FLAGS_MEM_RDONLY    0x200
175 # define BIO_FLAGS_NONCLEAR_RST  0x400
176
177 typedef union bio_addr_st BIO_ADDR;
178 typedef struct bio_addrinfo_st BIO_ADDRINFO;
179
180 int BIO_get_new_index(void);
181 void BIO_set_flags(BIO *b, int flags);
182 int BIO_test_flags(const BIO *b, int flags);
183 void BIO_clear_flags(BIO *b, int flags);
184
185 # define BIO_get_flags(b) BIO_test_flags(b, ~(0x0))
186 # define BIO_set_retry_special(b) \
187                 BIO_set_flags(b, (BIO_FLAGS_IO_SPECIAL|BIO_FLAGS_SHOULD_RETRY))
188 # define BIO_set_retry_read(b) \
189                 BIO_set_flags(b, (BIO_FLAGS_READ|BIO_FLAGS_SHOULD_RETRY))
190 # define BIO_set_retry_write(b) \
191                 BIO_set_flags(b, (BIO_FLAGS_WRITE|BIO_FLAGS_SHOULD_RETRY))
192
193 /* These are normally used internally in BIOs */
194 # define BIO_clear_retry_flags(b) \
195                 BIO_clear_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
196 # define BIO_get_retry_flags(b) \
197                 BIO_test_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
198
199 /* These should be used by the application to tell why we should retry */
200 # define BIO_should_read(a)              BIO_test_flags(a, BIO_FLAGS_READ)
201 # define BIO_should_write(a)             BIO_test_flags(a, BIO_FLAGS_WRITE)
202 # define BIO_should_io_special(a)        BIO_test_flags(a, BIO_FLAGS_IO_SPECIAL)
203 # define BIO_retry_type(a)               BIO_test_flags(a, BIO_FLAGS_RWS)
204 # define BIO_should_retry(a)             BIO_test_flags(a, BIO_FLAGS_SHOULD_RETRY)
205
206 /*
207  * The next three are used in conjunction with the BIO_should_io_special()
208  * condition.  After this returns true, BIO *BIO_get_retry_BIO(BIO *bio, int
209  * *reason); will walk the BIO stack and return the 'reason' for the special
210  * and the offending BIO. Given a BIO, BIO_get_retry_reason(bio) will return
211  * the code.
212  */
213 /*
214  * Returned from the SSL bio when the certificate retrieval code had an error
215  */
216 # define BIO_RR_SSL_X509_LOOKUP          0x01
217 /* Returned from the connect BIO when a connect would have blocked */
218 # define BIO_RR_CONNECT                  0x02
219 /* Returned from the accept BIO when an accept would have blocked */
220 # define BIO_RR_ACCEPT                   0x03
221
222 /* These are passed by the BIO callback */
223 # define BIO_CB_FREE     0x01
224 # define BIO_CB_READ     0x02
225 # define BIO_CB_WRITE    0x03
226 # define BIO_CB_PUTS     0x04
227 # define BIO_CB_GETS     0x05
228 # define BIO_CB_CTRL     0x06
229
230 /*
231  * The callback is called before and after the underling operation, The
232  * BIO_CB_RETURN flag indicates if it is after the call
233  */
234 # define BIO_CB_RETURN   0x80
235 # define BIO_CB_return(a) ((a)|BIO_CB_RETURN)
236 # define BIO_cb_pre(a)   (!((a)&BIO_CB_RETURN))
237 # define BIO_cb_post(a)  ((a)&BIO_CB_RETURN)
238
239 typedef long (*BIO_callback_fn)(BIO *b, int oper, const char *argp, int argi,
240                                 long argl, long ret);
241 typedef long (*BIO_callback_fn_ex)(BIO *b, int oper, const char *argp,
242                                    size_t len, int argi,
243                                    long argl, int ret, size_t *processed);
244 BIO_callback_fn BIO_get_callback(const BIO *b);
245 void BIO_set_callback(BIO *b, BIO_callback_fn callback);
246
247 BIO_callback_fn_ex BIO_get_callback_ex(const BIO *b);
248 void BIO_set_callback_ex(BIO *b, BIO_callback_fn_ex callback);
249
250 char *BIO_get_callback_arg(const BIO *b);
251 void BIO_set_callback_arg(BIO *b, char *arg);
252
253 typedef struct bio_method_st BIO_METHOD;
254
255 const char *BIO_method_name(const BIO *b);
256 int BIO_method_type(const BIO *b);
257
258 typedef int BIO_info_cb(BIO *, int, int);
259 typedef BIO_info_cb bio_info_cb;  /* backward compatibility */
260
261 DEFINE_STACK_OF(BIO)
262
263 /* Prefix and suffix callback in ASN1 BIO */
264 typedef int asn1_ps_func (BIO *b, unsigned char **pbuf, int *plen,
265                           void *parg);
266
267 # ifndef OPENSSL_NO_SCTP
268 /* SCTP parameter structs */
269 struct bio_dgram_sctp_sndinfo {
270     uint16_t snd_sid;
271     uint16_t snd_flags;
272     uint32_t snd_ppid;
273     uint32_t snd_context;
274 };
275
276 struct bio_dgram_sctp_rcvinfo {
277     uint16_t rcv_sid;
278     uint16_t rcv_ssn;
279     uint16_t rcv_flags;
280     uint32_t rcv_ppid;
281     uint32_t rcv_tsn;
282     uint32_t rcv_cumtsn;
283     uint32_t rcv_context;
284 };
285
286 struct bio_dgram_sctp_prinfo {
287     uint16_t pr_policy;
288     uint32_t pr_value;
289 };
290 # endif
291
292 /*
293  * #define BIO_CONN_get_param_hostname BIO_ctrl
294  */
295
296 # define BIO_C_SET_CONNECT                       100
297 # define BIO_C_DO_STATE_MACHINE                  101
298 # define BIO_C_SET_NBIO                          102
299 /* # define BIO_C_SET_PROXY_PARAM                   103 */
300 # define BIO_C_SET_FD                            104
301 # define BIO_C_GET_FD                            105
302 # define BIO_C_SET_FILE_PTR                      106
303 # define BIO_C_GET_FILE_PTR                      107
304 # define BIO_C_SET_FILENAME                      108
305 # define BIO_C_SET_SSL                           109
306 # define BIO_C_GET_SSL                           110
307 # define BIO_C_SET_MD                            111
308 # define BIO_C_GET_MD                            112
309 # define BIO_C_GET_CIPHER_STATUS                 113
310 # define BIO_C_SET_BUF_MEM                       114
311 # define BIO_C_GET_BUF_MEM_PTR                   115
312 # define BIO_C_GET_BUFF_NUM_LINES                116
313 # define BIO_C_SET_BUFF_SIZE                     117
314 # define BIO_C_SET_ACCEPT                        118
315 # define BIO_C_SSL_MODE                          119
316 # define BIO_C_GET_MD_CTX                        120
317 /* # define BIO_C_GET_PROXY_PARAM                   121 */
318 # define BIO_C_SET_BUFF_READ_DATA                122/* data to read first */
319 # define BIO_C_GET_CONNECT                       123
320 # define BIO_C_GET_ACCEPT                        124
321 # define BIO_C_SET_SSL_RENEGOTIATE_BYTES         125
322 # define BIO_C_GET_SSL_NUM_RENEGOTIATES          126
323 # define BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT       127
324 # define BIO_C_FILE_SEEK                         128
325 # define BIO_C_GET_CIPHER_CTX                    129
326 # define BIO_C_SET_BUF_MEM_EOF_RETURN            130/* return end of input
327                                                      * value */
328 # define BIO_C_SET_BIND_MODE                     131
329 # define BIO_C_GET_BIND_MODE                     132
330 # define BIO_C_FILE_TELL                         133
331 # define BIO_C_GET_SOCKS                         134
332 # define BIO_C_SET_SOCKS                         135
333
334 # define BIO_C_SET_WRITE_BUF_SIZE                136/* for BIO_s_bio */
335 # define BIO_C_GET_WRITE_BUF_SIZE                137
336 # define BIO_C_MAKE_BIO_PAIR                     138
337 # define BIO_C_DESTROY_BIO_PAIR                  139
338 # define BIO_C_GET_WRITE_GUARANTEE               140
339 # define BIO_C_GET_READ_REQUEST                  141
340 # define BIO_C_SHUTDOWN_WR                       142
341 # define BIO_C_NREAD0                            143
342 # define BIO_C_NREAD                             144
343 # define BIO_C_NWRITE0                           145
344 # define BIO_C_NWRITE                            146
345 # define BIO_C_RESET_READ_REQUEST                147
346 # define BIO_C_SET_MD_CTX                        148
347
348 # define BIO_C_SET_PREFIX                        149
349 # define BIO_C_GET_PREFIX                        150
350 # define BIO_C_SET_SUFFIX                        151
351 # define BIO_C_GET_SUFFIX                        152
352
353 # define BIO_C_SET_EX_ARG                        153
354 # define BIO_C_GET_EX_ARG                        154
355
356 # define BIO_C_SET_CONNECT_MODE                  155
357
358 # define BIO_set_app_data(s,arg)         BIO_set_ex_data(s,0,arg)
359 # define BIO_get_app_data(s)             BIO_get_ex_data(s,0)
360
361 # define BIO_set_nbio(b,n)             BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL)
362
363 # ifndef OPENSSL_NO_SOCK
364 /* IP families we support, for BIO_s_connect() and BIO_s_accept() */
365 /* Note: the underlying operating system may not support some of them */
366 #  define BIO_FAMILY_IPV4                         4
367 #  define BIO_FAMILY_IPV6                         6
368 #  define BIO_FAMILY_IPANY                        256
369
370 /* BIO_s_connect() */
371 #  define BIO_set_conn_hostname(b,name) BIO_ctrl(b,BIO_C_SET_CONNECT,0, \
372                                                  (char *)(name))
373 #  define BIO_set_conn_port(b,port)     BIO_ctrl(b,BIO_C_SET_CONNECT,1, \
374                                                  (char *)(port))
375 #  define BIO_set_conn_address(b,addr)  BIO_ctrl(b,BIO_C_SET_CONNECT,2, \
376                                                  (char *)(addr))
377 #  define BIO_set_conn_ip_family(b,f)   BIO_int_ctrl(b,BIO_C_SET_CONNECT,3,f)
378 #  define BIO_get_conn_hostname(b)      ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,0))
379 #  define BIO_get_conn_port(b)          ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,1))
380 #  define BIO_get_conn_address(b)       ((const BIO_ADDR *)BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,2))
381 #  define BIO_get_conn_ip_family(b)     BIO_ctrl(b,BIO_C_GET_CONNECT,3,NULL)
382 #  define BIO_set_conn_mode(b,n)        BIO_ctrl(b,BIO_C_SET_CONNECT_MODE,(n),NULL)
383
384 /* BIO_s_accept() */
385 #  define BIO_set_accept_name(b,name)   BIO_ctrl(b,BIO_C_SET_ACCEPT,0, \
386                                                  (char *)(name))
387 #  define BIO_set_accept_port(b,port)   BIO_ctrl(b,BIO_C_SET_ACCEPT,1, \
388                                                  (char *)(port))
389 #  define BIO_get_accept_name(b)        ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,0))
390 #  define BIO_get_accept_port(b)        ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,1))
391 #  define BIO_get_peer_name(b)          ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,2))
392 #  define BIO_get_peer_port(b)          ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,3))
393 /* #define BIO_set_nbio(b,n)    BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL) */
394 #  define BIO_set_nbio_accept(b,n)      BIO_ctrl(b,BIO_C_SET_ACCEPT,2,(n)?(void *)"a":NULL)
395 #  define BIO_set_accept_bios(b,bio)    BIO_ctrl(b,BIO_C_SET_ACCEPT,3, \
396                                                  (char *)(bio))
397 #  define BIO_set_accept_ip_family(b,f) BIO_int_ctrl(b,BIO_C_SET_ACCEPT,4,f)
398 #  define BIO_get_accept_ip_family(b)   BIO_ctrl(b,BIO_C_GET_ACCEPT,4,NULL)
399
400 /* Aliases kept for backward compatibility */
401 #  define BIO_BIND_NORMAL                 0
402 #  define BIO_BIND_REUSEADDR              BIO_SOCK_REUSEADDR
403 #  define BIO_BIND_REUSEADDR_IF_UNUSED    BIO_SOCK_REUSEADDR
404 #  define BIO_set_bind_mode(b,mode) BIO_ctrl(b,BIO_C_SET_BIND_MODE,mode,NULL)
405 #  define BIO_get_bind_mode(b)    BIO_ctrl(b,BIO_C_GET_BIND_MODE,0,NULL)
406
407 /* BIO_s_accept() and BIO_s_connect() */
408 #  define BIO_do_connect(b)       BIO_do_handshake(b)
409 #  define BIO_do_accept(b)        BIO_do_handshake(b)
410 # endif /* OPENSSL_NO_SOCK */
411
412 # define BIO_do_handshake(b)     BIO_ctrl(b,BIO_C_DO_STATE_MACHINE,0,NULL)
413
414 /* BIO_s_datagram(), BIO_s_fd(), BIO_s_socket(), BIO_s_accept() and BIO_s_connect() */
415 # define BIO_set_fd(b,fd,c)      BIO_int_ctrl(b,BIO_C_SET_FD,c,fd)
416 # define BIO_get_fd(b,c)         BIO_ctrl(b,BIO_C_GET_FD,0,(char *)(c))
417
418 /* BIO_s_file() */
419 # define BIO_set_fp(b,fp,c)      BIO_ctrl(b,BIO_C_SET_FILE_PTR,c,(char *)(fp))
420 # define BIO_get_fp(b,fpp)       BIO_ctrl(b,BIO_C_GET_FILE_PTR,0,(char *)(fpp))
421
422 /* BIO_s_fd() and BIO_s_file() */
423 # define BIO_seek(b,ofs) (int)BIO_ctrl(b,BIO_C_FILE_SEEK,ofs,NULL)
424 # define BIO_tell(b)     (int)BIO_ctrl(b,BIO_C_FILE_TELL,0,NULL)
425
426 /*
427  * name is cast to lose const, but might be better to route through a
428  * function so we can do it safely
429  */
430 # ifdef CONST_STRICT
431 /*
432  * If you are wondering why this isn't defined, its because CONST_STRICT is
433  * purely a compile-time kludge to allow const to be checked.
434  */
435 int BIO_read_filename(BIO *b, const char *name);
436 # else
437 #  define BIO_read_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
438                 BIO_CLOSE|BIO_FP_READ,(char *)(name))
439 # endif
440 # define BIO_write_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
441                 BIO_CLOSE|BIO_FP_WRITE,name)
442 # define BIO_append_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
443                 BIO_CLOSE|BIO_FP_APPEND,name)
444 # define BIO_rw_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
445                 BIO_CLOSE|BIO_FP_READ|BIO_FP_WRITE,name)
446
447 /*
448  * WARNING WARNING, this ups the reference count on the read bio of the SSL
449  * structure.  This is because the ssl read BIO is now pointed to by the
450  * next_bio field in the bio.  So when you free the BIO, make sure you are
451  * doing a BIO_free_all() to catch the underlying BIO.
452  */
453 # define BIO_set_ssl(b,ssl,c)    BIO_ctrl(b,BIO_C_SET_SSL,c,(char *)(ssl))
454 # define BIO_get_ssl(b,sslp)     BIO_ctrl(b,BIO_C_GET_SSL,0,(char *)(sslp))
455 # define BIO_set_ssl_mode(b,client)      BIO_ctrl(b,BIO_C_SSL_MODE,client,NULL)
456 # define BIO_set_ssl_renegotiate_bytes(b,num) \
457         BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_BYTES,num,NULL)
458 # define BIO_get_num_renegotiates(b) \
459         BIO_ctrl(b,BIO_C_GET_SSL_NUM_RENEGOTIATES,0,NULL)
460 # define BIO_set_ssl_renegotiate_timeout(b,seconds) \
461         BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT,seconds,NULL)
462
463 /* defined in evp.h */
464 /* #define BIO_set_md(b,md)     BIO_ctrl(b,BIO_C_SET_MD,1,(char *)(md)) */
465
466 # define BIO_get_mem_data(b,pp)  BIO_ctrl(b,BIO_CTRL_INFO,0,(char *)(pp))
467 # define BIO_set_mem_buf(b,bm,c) BIO_ctrl(b,BIO_C_SET_BUF_MEM,c,(char *)(bm))
468 # define BIO_get_mem_ptr(b,pp)   BIO_ctrl(b,BIO_C_GET_BUF_MEM_PTR,0, \
469                                           (char *)(pp))
470 # define BIO_set_mem_eof_return(b,v) \
471                                 BIO_ctrl(b,BIO_C_SET_BUF_MEM_EOF_RETURN,v,NULL)
472
473 /* For the BIO_f_buffer() type */
474 # define BIO_get_buffer_num_lines(b)     BIO_ctrl(b,BIO_C_GET_BUFF_NUM_LINES,0,NULL)
475 # define BIO_set_buffer_size(b,size)     BIO_ctrl(b,BIO_C_SET_BUFF_SIZE,size,NULL)
476 # define BIO_set_read_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,0)
477 # define BIO_set_write_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,1)
478 # define BIO_set_buffer_read_data(b,buf,num) BIO_ctrl(b,BIO_C_SET_BUFF_READ_DATA,num,buf)
479
480 /* Don't use the next one unless you know what you are doing :-) */
481 # define BIO_dup_state(b,ret)    BIO_ctrl(b,BIO_CTRL_DUP,0,(char *)(ret))
482
483 # define BIO_reset(b)            (int)BIO_ctrl(b,BIO_CTRL_RESET,0,NULL)
484 # define BIO_eof(b)              (int)BIO_ctrl(b,BIO_CTRL_EOF,0,NULL)
485 # define BIO_set_close(b,c)      (int)BIO_ctrl(b,BIO_CTRL_SET_CLOSE,(c),NULL)
486 # define BIO_get_close(b)        (int)BIO_ctrl(b,BIO_CTRL_GET_CLOSE,0,NULL)
487 # define BIO_pending(b)          (int)BIO_ctrl(b,BIO_CTRL_PENDING,0,NULL)
488 # define BIO_wpending(b)         (int)BIO_ctrl(b,BIO_CTRL_WPENDING,0,NULL)
489 /* ...pending macros have inappropriate return type */
490 size_t BIO_ctrl_pending(BIO *b);
491 size_t BIO_ctrl_wpending(BIO *b);
492 # define BIO_flush(b)            (int)BIO_ctrl(b,BIO_CTRL_FLUSH,0,NULL)
493 # define BIO_get_info_callback(b,cbp) (int)BIO_ctrl(b,BIO_CTRL_GET_CALLBACK,0, \
494                                                    cbp)
495 # define BIO_set_info_callback(b,cb) (int)BIO_callback_ctrl(b,BIO_CTRL_SET_CALLBACK,cb)
496
497 /* For the BIO_f_buffer() type */
498 # define BIO_buffer_get_num_lines(b) BIO_ctrl(b,BIO_CTRL_GET,0,NULL)
499 # define BIO_buffer_peek(b,s,l) BIO_ctrl(b,BIO_CTRL_PEEK,(l),(s))
500
501 /* For BIO_s_bio() */
502 # define BIO_set_write_buf_size(b,size) (int)BIO_ctrl(b,BIO_C_SET_WRITE_BUF_SIZE,size,NULL)
503 # define BIO_get_write_buf_size(b,size) (size_t)BIO_ctrl(b,BIO_C_GET_WRITE_BUF_SIZE,size,NULL)
504 # define BIO_make_bio_pair(b1,b2)   (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2)
505 # define BIO_destroy_bio_pair(b)    (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL)
506 # define BIO_shutdown_wr(b) (int)BIO_ctrl(b, BIO_C_SHUTDOWN_WR, 0, NULL)
507 /* macros with inappropriate type -- but ...pending macros use int too: */
508 # define BIO_get_write_guarantee(b) (int)BIO_ctrl(b,BIO_C_GET_WRITE_GUARANTEE,0,NULL)
509 # define BIO_get_read_request(b)    (int)BIO_ctrl(b,BIO_C_GET_READ_REQUEST,0,NULL)
510 size_t BIO_ctrl_get_write_guarantee(BIO *b);
511 size_t BIO_ctrl_get_read_request(BIO *b);
512 int BIO_ctrl_reset_read_request(BIO *b);
513
514 /* ctrl macros for dgram */
515 # define BIO_ctrl_dgram_connect(b,peer)  \
516                      (int)BIO_ctrl(b,BIO_CTRL_DGRAM_CONNECT,0, (char *)(peer))
517 # define BIO_ctrl_set_connected(b,peer) \
518          (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_CONNECTED, 0, (char *)(peer))
519 # define BIO_dgram_recv_timedout(b) \
520          (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP, 0, NULL)
521 # define BIO_dgram_send_timedout(b) \
522          (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP, 0, NULL)
523 # define BIO_dgram_get_peer(b,peer) \
524          (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_PEER, 0, (char *)(peer))
525 # define BIO_dgram_set_peer(b,peer) \
526          (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_PEER, 0, (char *)(peer))
527 # define BIO_dgram_get_mtu_overhead(b) \
528          (unsigned int)BIO_ctrl((b), BIO_CTRL_DGRAM_GET_MTU_OVERHEAD, 0, NULL)
529
530 #define BIO_get_ex_new_index(l, p, newf, dupf, freef) \
531     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_BIO, l, p, newf, dupf, freef)
532 int BIO_set_ex_data(BIO *bio, int idx, void *data);
533 void *BIO_get_ex_data(BIO *bio, int idx);
534 uint64_t BIO_number_read(BIO *bio);
535 uint64_t BIO_number_written(BIO *bio);
536
537 /* For BIO_f_asn1() */
538 int BIO_asn1_set_prefix(BIO *b, asn1_ps_func *prefix,
539                         asn1_ps_func *prefix_free);
540 int BIO_asn1_get_prefix(BIO *b, asn1_ps_func **pprefix,
541                         asn1_ps_func **pprefix_free);
542 int BIO_asn1_set_suffix(BIO *b, asn1_ps_func *suffix,
543                         asn1_ps_func *suffix_free);
544 int BIO_asn1_get_suffix(BIO *b, asn1_ps_func **psuffix,
545                         asn1_ps_func **psuffix_free);
546
547 const BIO_METHOD *BIO_s_file(void);
548 BIO *BIO_new_file(const char *filename, const char *mode);
549 # ifndef OPENSSL_NO_STDIO
550 BIO *BIO_new_fp(FILE *stream, int close_flag);
551 # endif
552 BIO *BIO_new(const BIO_METHOD *type);
553 int BIO_free(BIO *a);
554 void BIO_set_data(BIO *a, void *ptr);
555 void *BIO_get_data(BIO *a);
556 void BIO_set_init(BIO *a, int init);
557 int BIO_get_init(BIO *a);
558 void BIO_set_shutdown(BIO *a, int shut);
559 int BIO_get_shutdown(BIO *a);
560 void BIO_vfree(BIO *a);
561 int BIO_up_ref(BIO *a);
562 int BIO_read(BIO *b, void *data, int dlen);
563 int BIO_read_ex(BIO *b, void *data, size_t dlen, size_t *readbytes);
564 int BIO_gets(BIO *bp, char *buf, int size);
565 int BIO_write(BIO *b, const void *data, int dlen);
566 int BIO_write_ex(BIO *b, const void *data, size_t dlen, size_t *written);
567 int BIO_puts(BIO *bp, const char *buf);
568 int BIO_indent(BIO *b, int indent, int max);
569 long BIO_ctrl(BIO *bp, int cmd, long larg, void *parg);
570 long BIO_callback_ctrl(BIO *b, int cmd, BIO_info_cb *fp);
571 void *BIO_ptr_ctrl(BIO *bp, int cmd, long larg);
572 long BIO_int_ctrl(BIO *bp, int cmd, long larg, int iarg);
573 BIO *BIO_push(BIO *b, BIO *append);
574 BIO *BIO_pop(BIO *b);
575 void BIO_free_all(BIO *a);
576 BIO *BIO_find_type(BIO *b, int bio_type);
577 BIO *BIO_next(BIO *b);
578 void BIO_set_next(BIO *b, BIO *next);
579 BIO *BIO_get_retry_BIO(BIO *bio, int *reason);
580 int BIO_get_retry_reason(BIO *bio);
581 void BIO_set_retry_reason(BIO *bio, int reason);
582 BIO *BIO_dup_chain(BIO *in);
583
584 int BIO_nread0(BIO *bio, char **buf);
585 int BIO_nread(BIO *bio, char **buf, int num);
586 int BIO_nwrite0(BIO *bio, char **buf);
587 int BIO_nwrite(BIO *bio, char **buf, int num);
588
589 long BIO_debug_callback(BIO *bio, int cmd, const char *argp, int argi,
590                         long argl, long ret);
591
592 const BIO_METHOD *BIO_s_mem(void);
593 const BIO_METHOD *BIO_s_secmem(void);
594 BIO *BIO_new_mem_buf(const void *buf, int len);
595 # ifndef OPENSSL_NO_SOCK
596 const BIO_METHOD *BIO_s_socket(void);
597 const BIO_METHOD *BIO_s_connect(void);
598 const BIO_METHOD *BIO_s_accept(void);
599 # endif
600 const BIO_METHOD *BIO_s_fd(void);
601 const BIO_METHOD *BIO_s_log(void);
602 const BIO_METHOD *BIO_s_bio(void);
603 const BIO_METHOD *BIO_s_null(void);
604 const BIO_METHOD *BIO_f_null(void);
605 const BIO_METHOD *BIO_f_buffer(void);
606 const BIO_METHOD *BIO_f_linebuffer(void);
607 const BIO_METHOD *BIO_f_nbio_test(void);
608 # ifndef OPENSSL_NO_DGRAM
609 const BIO_METHOD *BIO_s_datagram(void);
610 int BIO_dgram_non_fatal_error(int error);
611 BIO *BIO_new_dgram(int fd, int close_flag);
612 #  ifndef OPENSSL_NO_SCTP
613 const BIO_METHOD *BIO_s_datagram_sctp(void);
614 BIO *BIO_new_dgram_sctp(int fd, int close_flag);
615 int BIO_dgram_is_sctp(BIO *bio);
616 int BIO_dgram_sctp_notification_cb(BIO *b,
617                                    void (*handle_notifications) (BIO *bio,
618                                                                  void *context,
619                                                                  void *buf),
620                                    void *context);
621 int BIO_dgram_sctp_wait_for_dry(BIO *b);
622 int BIO_dgram_sctp_msg_waiting(BIO *b);
623 #  endif
624 # endif
625
626 # ifndef OPENSSL_NO_SOCK
627 int BIO_sock_should_retry(int i);
628 int BIO_sock_non_fatal_error(int error);
629 # endif
630
631 int BIO_fd_should_retry(int i);
632 int BIO_fd_non_fatal_error(int error);
633 int BIO_dump_cb(int (*cb) (const void *data, size_t len, void *u),
634                 void *u, const char *s, int len);
635 int BIO_dump_indent_cb(int (*cb) (const void *data, size_t len, void *u),
636                        void *u, const char *s, int len, int indent);
637 int BIO_dump(BIO *b, const char *bytes, int len);
638 int BIO_dump_indent(BIO *b, const char *bytes, int len, int indent);
639 # ifndef OPENSSL_NO_STDIO
640 int BIO_dump_fp(FILE *fp, const char *s, int len);
641 int BIO_dump_indent_fp(FILE *fp, const char *s, int len, int indent);
642 # endif
643 int BIO_hex_string(BIO *out, int indent, int width, unsigned char *data,
644                    int datalen);
645
646 # ifndef OPENSSL_NO_SOCK
647 BIO_ADDR *BIO_ADDR_new(void);
648 int BIO_ADDR_rawmake(BIO_ADDR *ap, int family,
649                      const void *where, size_t wherelen, unsigned short port);
650 void BIO_ADDR_free(BIO_ADDR *);
651 void BIO_ADDR_clear(BIO_ADDR *ap);
652 int BIO_ADDR_family(const BIO_ADDR *ap);
653 int BIO_ADDR_rawaddress(const BIO_ADDR *ap, void *p, size_t *l);
654 unsigned short BIO_ADDR_rawport(const BIO_ADDR *ap);
655 char *BIO_ADDR_hostname_string(const BIO_ADDR *ap, int numeric);
656 char *BIO_ADDR_service_string(const BIO_ADDR *ap, int numeric);
657 char *BIO_ADDR_path_string(const BIO_ADDR *ap);
658
659 const BIO_ADDRINFO *BIO_ADDRINFO_next(const BIO_ADDRINFO *bai);
660 int BIO_ADDRINFO_family(const BIO_ADDRINFO *bai);
661 int BIO_ADDRINFO_socktype(const BIO_ADDRINFO *bai);
662 int BIO_ADDRINFO_protocol(const BIO_ADDRINFO *bai);
663 const BIO_ADDR *BIO_ADDRINFO_address(const BIO_ADDRINFO *bai);
664 void BIO_ADDRINFO_free(BIO_ADDRINFO *bai);
665
666 enum BIO_hostserv_priorities {
667     BIO_PARSE_PRIO_HOST, BIO_PARSE_PRIO_SERV
668 };
669 int BIO_parse_hostserv(const char *hostserv, char **host, char **service,
670                        enum BIO_hostserv_priorities hostserv_prio);
671 enum BIO_lookup_type {
672     BIO_LOOKUP_CLIENT, BIO_LOOKUP_SERVER
673 };
674 int BIO_lookup(const char *host, const char *service,
675                enum BIO_lookup_type lookup_type,
676                int family, int socktype, BIO_ADDRINFO **res);
677 int BIO_lookup_ex(const char *host, const char *service,
678                   int lookup_type, int family, int socktype, int protocol,
679                   BIO_ADDRINFO **res);
680 int BIO_sock_error(int sock);
681 int BIO_socket_ioctl(int fd, long type, void *arg);
682 int BIO_socket_nbio(int fd, int mode);
683 int BIO_sock_init(void);
684 # if OPENSSL_API_COMPAT < 0x10100000L
685 #  define BIO_sock_cleanup() while(0) continue
686 # endif
687 int BIO_set_tcp_ndelay(int sock, int turn_on);
688
689 DEPRECATEDIN_1_1_0(struct hostent *BIO_gethostbyname(const char *name))
690 DEPRECATEDIN_1_1_0(int BIO_get_port(const char *str, unsigned short *port_ptr))
691 DEPRECATEDIN_1_1_0(int BIO_get_host_ip(const char *str, unsigned char *ip))
692 DEPRECATEDIN_1_1_0(int BIO_get_accept_socket(char *host_port, int mode))
693 DEPRECATEDIN_1_1_0(int BIO_accept(int sock, char **ip_port))
694
695 union BIO_sock_info_u {
696     BIO_ADDR *addr;
697 };
698 enum BIO_sock_info_type {
699     BIO_SOCK_INFO_ADDRESS
700 };
701 int BIO_sock_info(int sock,
702                   enum BIO_sock_info_type type, union BIO_sock_info_u *info);
703
704 #  define BIO_SOCK_REUSEADDR    0x01
705 #  define BIO_SOCK_V6_ONLY      0x02
706 #  define BIO_SOCK_KEEPALIVE    0x04
707 #  define BIO_SOCK_NONBLOCK     0x08
708 #  define BIO_SOCK_NODELAY      0x10
709
710 int BIO_socket(int domain, int socktype, int protocol, int options);
711 int BIO_connect(int sock, const BIO_ADDR *addr, int options);
712 int BIO_listen(int sock, const BIO_ADDR *addr, int options);
713 int BIO_accept_ex(int accept_sock, BIO_ADDR *addr, int options);
714 int BIO_closesocket(int sock);
715
716 BIO *BIO_new_socket(int sock, int close_flag);
717 BIO *BIO_new_connect(const char *host_port);
718 BIO *BIO_new_accept(const char *host_port);
719 # endif /* OPENSSL_NO_SOCK*/
720
721 BIO *BIO_new_fd(int fd, int close_flag);
722
723 int BIO_new_bio_pair(BIO **bio1, size_t writebuf1,
724                      BIO **bio2, size_t writebuf2);
725 /*
726  * If successful, returns 1 and in *bio1, *bio2 two BIO pair endpoints.
727  * Otherwise returns 0 and sets *bio1 and *bio2 to NULL. Size 0 uses default
728  * value.
729  */
730
731 void BIO_copy_next_retry(BIO *b);
732
733 /*
734  * long BIO_ghbn_ctrl(int cmd,int iarg,char *parg);
735  */
736
737 # define __bio_h__attr__(x)
738 # if defined(__GNUC__) && defined(__STDC_VERSION__)
739     /*
740      * Because we support the 'z' modifier, which made its appearance in C99,
741      * we can't use __attribute__ with pre C99 dialects.
742      */
743 #  if __STDC_VERSION__ >= 199901L
744 #   undef __bio_h__attr__
745 #   define __bio_h__attr__ __attribute__
746 #  endif
747 # endif
748 int BIO_printf(BIO *bio, const char *format, ...)
749 __bio_h__attr__((__format__(__printf__, 2, 3)));
750 int BIO_vprintf(BIO *bio, const char *format, va_list args)
751 __bio_h__attr__((__format__(__printf__, 2, 0)));
752 int BIO_snprintf(char *buf, size_t n, const char *format, ...)
753 __bio_h__attr__((__format__(__printf__, 3, 4)));
754 int BIO_vsnprintf(char *buf, size_t n, const char *format, va_list args)
755 __bio_h__attr__((__format__(__printf__, 3, 0)));
756 # undef __bio_h__attr__
757
758
759 BIO_METHOD *BIO_meth_new(int type, const char *name);
760 void BIO_meth_free(BIO_METHOD *biom);
761 int (*BIO_meth_get_write(BIO_METHOD *biom)) (BIO *, const char *, int);
762 int (*BIO_meth_get_write_ex(BIO_METHOD *biom)) (BIO *, const char *, size_t,
763                                                 size_t *);
764 int BIO_meth_set_write(BIO_METHOD *biom,
765                        int (*write) (BIO *, const char *, int));
766 int BIO_meth_set_write_ex(BIO_METHOD *biom,
767                        int (*bwrite) (BIO *, const char *, size_t, size_t *));
768 int (*BIO_meth_get_read(BIO_METHOD *biom)) (BIO *, char *, int);
769 int (*BIO_meth_get_read_ex(BIO_METHOD *biom)) (BIO *, char *, size_t, size_t *);
770 int BIO_meth_set_read(BIO_METHOD *biom,
771                       int (*read) (BIO *, char *, int));
772 int BIO_meth_set_read_ex(BIO_METHOD *biom,
773                          int (*bread) (BIO *, char *, size_t, size_t *));
774 int (*BIO_meth_get_puts(BIO_METHOD *biom)) (BIO *, const char *);
775 int BIO_meth_set_puts(BIO_METHOD *biom,
776                       int (*puts) (BIO *, const char *));
777 int (*BIO_meth_get_gets(BIO_METHOD *biom)) (BIO *, char *, int);
778 int BIO_meth_set_gets(BIO_METHOD *biom,
779                       int (*gets) (BIO *, char *, int));
780 long (*BIO_meth_get_ctrl(BIO_METHOD *biom)) (BIO *, int, long, void *);
781 int BIO_meth_set_ctrl(BIO_METHOD *biom,
782                       long (*ctrl) (BIO *, int, long, void *));
783 int (*BIO_meth_get_create(BIO_METHOD *bion)) (BIO *);
784 int BIO_meth_set_create(BIO_METHOD *biom, int (*create) (BIO *));
785 int (*BIO_meth_get_destroy(BIO_METHOD *biom)) (BIO *);
786 int BIO_meth_set_destroy(BIO_METHOD *biom, int (*destroy) (BIO *));
787 long (*BIO_meth_get_callback_ctrl(BIO_METHOD *biom))
788                                  (BIO *, int, BIO_info_cb *);
789 int BIO_meth_set_callback_ctrl(BIO_METHOD *biom,
790                                long (*callback_ctrl) (BIO *, int,
791                                                       BIO_info_cb *));
792 int ERR_load_BIO_strings(void);
793
794 # ifdef  __cplusplus
795 }
796 # endif
797 #endif