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