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