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