Mercurial > repos > rliterman > csp2

comparison CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/openssl/bio.h @ 69:33d812a61356

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 17:55:14 -0400
parents
children
comparison
equal deleted inserted replaced
67:0e9998148a16 69:33d812a61356
1 /*
2 * Copyright 1995-2020 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
24 extern "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 # define BIO_FLAGS_IN_EOF 0x800
173
174 typedef union bio_addr_st BIO_ADDR;
175 typedef struct bio_addrinfo_st BIO_ADDRINFO;
176
177 int BIO_get_new_index(void);
178 void BIO_set_flags(BIO *b, int flags);
179 int BIO_test_flags(const BIO *b, int flags);
180 void 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
236 typedef long (*BIO_callback_fn)(BIO *b, int oper, const char *argp, int argi,
237 long argl, long ret);
238 typedef long (*BIO_callback_fn_ex)(BIO *b, int oper, const char *argp,
239 size_t len, int argi,
240 long argl, int ret, size_t *processed);
241 BIO_callback_fn BIO_get_callback(const BIO *b);
242 void BIO_set_callback(BIO *b, BIO_callback_fn callback);
243
244 BIO_callback_fn_ex BIO_get_callback_ex(const BIO *b);
245 void BIO_set_callback_ex(BIO *b, BIO_callback_fn_ex callback);
246
247 char *BIO_get_callback_arg(const BIO *b);
248 void BIO_set_callback_arg(BIO *b, char *arg);
249
250 typedef struct bio_method_st BIO_METHOD;
251
252 const char *BIO_method_name(const BIO *b);
253 int BIO_method_type(const BIO *b);
254
255 typedef int BIO_info_cb(BIO *, int, int);
256 typedef BIO_info_cb bio_info_cb; /* backward compatibility */
257
258 DEFINE_STACK_OF(BIO)
259
260 /* Prefix and suffix callback in ASN1 BIO */
261 typedef int asn1_ps_func (BIO *b, unsigned char **pbuf, int *plen,
262 void *parg);
263
264 # ifndef OPENSSL_NO_SCTP
265 /* SCTP parameter structs */
266 struct bio_dgram_sctp_sndinfo {
267 uint16_t snd_sid;
268 uint16_t snd_flags;
269 uint32_t snd_ppid;
270 uint32_t snd_context;
271 };
272
273 struct bio_dgram_sctp_rcvinfo {
274 uint16_t rcv_sid;
275 uint16_t rcv_ssn;
276 uint16_t rcv_flags;
277 uint32_t rcv_ppid;
278 uint32_t rcv_tsn;
279 uint32_t rcv_cumtsn;
280 uint32_t rcv_context;
281 };
282
283 struct bio_dgram_sctp_prinfo {
284 uint16_t pr_policy;
285 uint32_t pr_value;
286 };
287 # endif
288
289 /*
290 * #define BIO_CONN_get_param_hostname BIO_ctrl
291 */
292
293 # define BIO_C_SET_CONNECT 100
294 # define BIO_C_DO_STATE_MACHINE 101
295 # define BIO_C_SET_NBIO 102
296 /* # define BIO_C_SET_PROXY_PARAM 103 */
297 # define BIO_C_SET_FD 104
298 # define BIO_C_GET_FD 105
299 # define BIO_C_SET_FILE_PTR 106
300 # define BIO_C_GET_FILE_PTR 107
301 # define BIO_C_SET_FILENAME 108
302 # define BIO_C_SET_SSL 109
303 # define BIO_C_GET_SSL 110
304 # define BIO_C_SET_MD 111
305 # define BIO_C_GET_MD 112
306 # define BIO_C_GET_CIPHER_STATUS 113
307 # define BIO_C_SET_BUF_MEM 114
308 # define BIO_C_GET_BUF_MEM_PTR 115
309 # define BIO_C_GET_BUFF_NUM_LINES 116
310 # define BIO_C_SET_BUFF_SIZE 117
311 # define BIO_C_SET_ACCEPT 118
312 # define BIO_C_SSL_MODE 119
313 # define BIO_C_GET_MD_CTX 120
314 /* # define BIO_C_GET_PROXY_PARAM 121 */
315 # define BIO_C_SET_BUFF_READ_DATA 122/* data to read first */
316 # define BIO_C_GET_CONNECT 123
317 # define BIO_C_GET_ACCEPT 124
318 # define BIO_C_SET_SSL_RENEGOTIATE_BYTES 125
319 # define BIO_C_GET_SSL_NUM_RENEGOTIATES 126
320 # define BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT 127
321 # define BIO_C_FILE_SEEK 128
322 # define BIO_C_GET_CIPHER_CTX 129
323 # define BIO_C_SET_BUF_MEM_EOF_RETURN 130/* return end of input
324 * value */
325 # define BIO_C_SET_BIND_MODE 131
326 # define BIO_C_GET_BIND_MODE 132
327 # define BIO_C_FILE_TELL 133
328 # define BIO_C_GET_SOCKS 134
329 # define BIO_C_SET_SOCKS 135
330
331 # define BIO_C_SET_WRITE_BUF_SIZE 136/* for BIO_s_bio */
332 # define BIO_C_GET_WRITE_BUF_SIZE 137
333 # define BIO_C_MAKE_BIO_PAIR 138
334 # define BIO_C_DESTROY_BIO_PAIR 139
335 # define BIO_C_GET_WRITE_GUARANTEE 140
336 # define BIO_C_GET_READ_REQUEST 141
337 # define BIO_C_SHUTDOWN_WR 142
338 # define BIO_C_NREAD0 143
339 # define BIO_C_NREAD 144
340 # define BIO_C_NWRITE0 145
341 # define BIO_C_NWRITE 146
342 # define BIO_C_RESET_READ_REQUEST 147
343 # define BIO_C_SET_MD_CTX 148
344
345 # define BIO_C_SET_PREFIX 149
346 # define BIO_C_GET_PREFIX 150
347 # define BIO_C_SET_SUFFIX 151
348 # define BIO_C_GET_SUFFIX 152
349
350 # define BIO_C_SET_EX_ARG 153
351 # define BIO_C_GET_EX_ARG 154
352
353 # define BIO_C_SET_CONNECT_MODE 155
354
355 # define BIO_set_app_data(s,arg) BIO_set_ex_data(s,0,arg)
356 # define BIO_get_app_data(s) BIO_get_ex_data(s,0)
357
358 # define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL)
359
360 # ifndef OPENSSL_NO_SOCK
361 /* IP families we support, for BIO_s_connect() and BIO_s_accept() */
362 /* Note: the underlying operating system may not support some of them */
363 # define BIO_FAMILY_IPV4 4
364 # define BIO_FAMILY_IPV6 6
365 # define BIO_FAMILY_IPANY 256
366
367 /* BIO_s_connect() */
368 # define BIO_set_conn_hostname(b,name) BIO_ctrl(b,BIO_C_SET_CONNECT,0, \
369 (char *)(name))
370 # define BIO_set_conn_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,1, \
371 (char *)(port))
372 # define BIO_set_conn_address(b,addr) BIO_ctrl(b,BIO_C_SET_CONNECT,2, \
373 (char *)(addr))
374 # define BIO_set_conn_ip_family(b,f) BIO_int_ctrl(b,BIO_C_SET_CONNECT,3,f)
375 # define BIO_get_conn_hostname(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,0))
376 # define BIO_get_conn_port(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,1))
377 # define BIO_get_conn_address(b) ((const BIO_ADDR *)BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,2))
378 # define BIO_get_conn_ip_family(b) BIO_ctrl(b,BIO_C_GET_CONNECT,3,NULL)
379 # define BIO_set_conn_mode(b,n) BIO_ctrl(b,BIO_C_SET_CONNECT_MODE,(n),NULL)
380
381 /* BIO_s_accept() */
382 # define BIO_set_accept_name(b,name) BIO_ctrl(b,BIO_C_SET_ACCEPT,0, \
383 (char *)(name))
384 # define BIO_set_accept_port(b,port) BIO_ctrl(b,BIO_C_SET_ACCEPT,1, \
385 (char *)(port))
386 # define BIO_get_accept_name(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,0))
387 # define BIO_get_accept_port(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,1))
388 # define BIO_get_peer_name(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,2))
389 # define BIO_get_peer_port(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,3))
390 /* #define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL) */
391 # define BIO_set_nbio_accept(b,n) BIO_ctrl(b,BIO_C_SET_ACCEPT,2,(n)?(void *)"a":NULL)
392 # define BIO_set_accept_bios(b,bio) BIO_ctrl(b,BIO_C_SET_ACCEPT,3, \
393 (char *)(bio))
394 # define BIO_set_accept_ip_family(b,f) BIO_int_ctrl(b,BIO_C_SET_ACCEPT,4,f)
395 # define BIO_get_accept_ip_family(b) BIO_ctrl(b,BIO_C_GET_ACCEPT,4,NULL)
396
397 /* Aliases kept for backward compatibility */
398 # define BIO_BIND_NORMAL 0
399 # define BIO_BIND_REUSEADDR BIO_SOCK_REUSEADDR
400 # define BIO_BIND_REUSEADDR_IF_UNUSED BIO_SOCK_REUSEADDR
401 # define BIO_set_bind_mode(b,mode) BIO_ctrl(b,BIO_C_SET_BIND_MODE,mode,NULL)
402 # define BIO_get_bind_mode(b) BIO_ctrl(b,BIO_C_GET_BIND_MODE,0,NULL)
403
404 /* BIO_s_accept() and BIO_s_connect() */
405 # define BIO_do_connect(b) BIO_do_handshake(b)
406 # define BIO_do_accept(b) BIO_do_handshake(b)
407 # endif /* OPENSSL_NO_SOCK */
408
409 # define BIO_do_handshake(b) BIO_ctrl(b,BIO_C_DO_STATE_MACHINE,0,NULL)
410
411 /* BIO_s_datagram(), BIO_s_fd(), BIO_s_socket(), BIO_s_accept() and BIO_s_connect() */
412 # define BIO_set_fd(b,fd,c) BIO_int_ctrl(b,BIO_C_SET_FD,c,fd)
413 # define BIO_get_fd(b,c) BIO_ctrl(b,BIO_C_GET_FD,0,(char *)(c))
414
415 /* BIO_s_file() */
416 # define BIO_set_fp(b,fp,c) BIO_ctrl(b,BIO_C_SET_FILE_PTR,c,(char *)(fp))
417 # define BIO_get_fp(b,fpp) BIO_ctrl(b,BIO_C_GET_FILE_PTR,0,(char *)(fpp))
418
419 /* BIO_s_fd() and BIO_s_file() */
420 # define BIO_seek(b,ofs) (int)BIO_ctrl(b,BIO_C_FILE_SEEK,ofs,NULL)
421 # define BIO_tell(b) (int)BIO_ctrl(b,BIO_C_FILE_TELL,0,NULL)
422
423 /*
424 * name is cast to lose const, but might be better to route through a
425 * function so we can do it safely
426 */
427 # ifdef CONST_STRICT
428 /*
429 * If you are wondering why this isn't defined, its because CONST_STRICT is
430 * purely a compile-time kludge to allow const to be checked.
431 */
432 int BIO_read_filename(BIO *b, const char *name);
433 # else
434 # define BIO_read_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
435 BIO_CLOSE|BIO_FP_READ,(char *)(name))
436 # endif
437 # define BIO_write_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
438 BIO_CLOSE|BIO_FP_WRITE,name)
439 # define BIO_append_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
440 BIO_CLOSE|BIO_FP_APPEND,name)
441 # define BIO_rw_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
442 BIO_CLOSE|BIO_FP_READ|BIO_FP_WRITE,name)
443
444 /*
445 * WARNING WARNING, this ups the reference count on the read bio of the SSL
446 * structure. This is because the ssl read BIO is now pointed to by the
447 * next_bio field in the bio. So when you free the BIO, make sure you are
448 * doing a BIO_free_all() to catch the underlying BIO.
449 */
450 # define BIO_set_ssl(b,ssl,c) BIO_ctrl(b,BIO_C_SET_SSL,c,(char *)(ssl))
451 # define BIO_get_ssl(b,sslp) BIO_ctrl(b,BIO_C_GET_SSL,0,(char *)(sslp))
452 # define BIO_set_ssl_mode(b,client) BIO_ctrl(b,BIO_C_SSL_MODE,client,NULL)
453 # define BIO_set_ssl_renegotiate_bytes(b,num) \
454 BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_BYTES,num,NULL)
455 # define BIO_get_num_renegotiates(b) \
456 BIO_ctrl(b,BIO_C_GET_SSL_NUM_RENEGOTIATES,0,NULL)
457 # define BIO_set_ssl_renegotiate_timeout(b,seconds) \
458 BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT,seconds,NULL)
459
460 /* defined in evp.h */
461 /* #define BIO_set_md(b,md) BIO_ctrl(b,BIO_C_SET_MD,1,(char *)(md)) */
462
463 # define BIO_get_mem_data(b,pp) BIO_ctrl(b,BIO_CTRL_INFO,0,(char *)(pp))
464 # define BIO_set_mem_buf(b,bm,c) BIO_ctrl(b,BIO_C_SET_BUF_MEM,c,(char *)(bm))
465 # define BIO_get_mem_ptr(b,pp) BIO_ctrl(b,BIO_C_GET_BUF_MEM_PTR,0, \
466 (char *)(pp))
467 # define BIO_set_mem_eof_return(b,v) \
468 BIO_ctrl(b,BIO_C_SET_BUF_MEM_EOF_RETURN,v,NULL)
469
470 /* For the BIO_f_buffer() type */
471 # define BIO_get_buffer_num_lines(b) BIO_ctrl(b,BIO_C_GET_BUFF_NUM_LINES,0,NULL)
472 # define BIO_set_buffer_size(b,size) BIO_ctrl(b,BIO_C_SET_BUFF_SIZE,size,NULL)
473 # define BIO_set_read_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,0)
474 # define BIO_set_write_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,1)
475 # define BIO_set_buffer_read_data(b,buf,num) BIO_ctrl(b,BIO_C_SET_BUFF_READ_DATA,num,buf)
476
477 /* Don't use the next one unless you know what you are doing :-) */
478 # define BIO_dup_state(b,ret) BIO_ctrl(b,BIO_CTRL_DUP,0,(char *)(ret))
479
480 # define BIO_reset(b) (int)BIO_ctrl(b,BIO_CTRL_RESET,0,NULL)
481 # define BIO_eof(b) (int)BIO_ctrl(b,BIO_CTRL_EOF,0,NULL)
482 # define BIO_set_close(b,c) (int)BIO_ctrl(b,BIO_CTRL_SET_CLOSE,(c),NULL)
483 # define BIO_get_close(b) (int)BIO_ctrl(b,BIO_CTRL_GET_CLOSE,0,NULL)
484 # define BIO_pending(b) (int)BIO_ctrl(b,BIO_CTRL_PENDING,0,NULL)
485 # define BIO_wpending(b) (int)BIO_ctrl(b,BIO_CTRL_WPENDING,0,NULL)
486 /* ...pending macros have inappropriate return type */
487 size_t BIO_ctrl_pending(BIO *b);
488 size_t BIO_ctrl_wpending(BIO *b);
489 # define BIO_flush(b) (int)BIO_ctrl(b,BIO_CTRL_FLUSH,0,NULL)
490 # define BIO_get_info_callback(b,cbp) (int)BIO_ctrl(b,BIO_CTRL_GET_CALLBACK,0, \
491 cbp)
492 # define BIO_set_info_callback(b,cb) (int)BIO_callback_ctrl(b,BIO_CTRL_SET_CALLBACK,cb)
493
494 /* For the BIO_f_buffer() type */
495 # define BIO_buffer_get_num_lines(b) BIO_ctrl(b,BIO_CTRL_GET,0,NULL)
496 # define BIO_buffer_peek(b,s,l) BIO_ctrl(b,BIO_CTRL_PEEK,(l),(s))
497
498 /* For BIO_s_bio() */
499 # define BIO_set_write_buf_size(b,size) (int)BIO_ctrl(b,BIO_C_SET_WRITE_BUF_SIZE,size,NULL)
500 # define BIO_get_write_buf_size(b,size) (size_t)BIO_ctrl(b,BIO_C_GET_WRITE_BUF_SIZE,size,NULL)
501 # define BIO_make_bio_pair(b1,b2) (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2)
502 # define BIO_destroy_bio_pair(b) (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL)
503 # define BIO_shutdown_wr(b) (int)BIO_ctrl(b, BIO_C_SHUTDOWN_WR, 0, NULL)
504 /* macros with inappropriate type -- but ...pending macros use int too: */
505 # define BIO_get_write_guarantee(b) (int)BIO_ctrl(b,BIO_C_GET_WRITE_GUARANTEE,0,NULL)
506 # define BIO_get_read_request(b) (int)BIO_ctrl(b,BIO_C_GET_READ_REQUEST,0,NULL)
507 size_t BIO_ctrl_get_write_guarantee(BIO *b);
508 size_t BIO_ctrl_get_read_request(BIO *b);
509 int BIO_ctrl_reset_read_request(BIO *b);
510
511 /* ctrl macros for dgram */
512 # define BIO_ctrl_dgram_connect(b,peer) \
513 (int)BIO_ctrl(b,BIO_CTRL_DGRAM_CONNECT,0, (char *)(peer))
514 # define BIO_ctrl_set_connected(b,peer) \
515 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_CONNECTED, 0, (char *)(peer))
516 # define BIO_dgram_recv_timedout(b) \
517 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP, 0, NULL)
518 # define BIO_dgram_send_timedout(b) \
519 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP, 0, NULL)
520 # define BIO_dgram_get_peer(b,peer) \
521 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_PEER, 0, (char *)(peer))
522 # define BIO_dgram_set_peer(b,peer) \
523 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_PEER, 0, (char *)(peer))
524 # define BIO_dgram_get_mtu_overhead(b) \
525 (unsigned int)BIO_ctrl((b), BIO_CTRL_DGRAM_GET_MTU_OVERHEAD, 0, NULL)
526
527 #define BIO_get_ex_new_index(l, p, newf, dupf, freef) \
528 CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_BIO, l, p, newf, dupf, freef)
529 int BIO_set_ex_data(BIO *bio, int idx, void *data);
530 void *BIO_get_ex_data(BIO *bio, int idx);
531 uint64_t BIO_number_read(BIO *bio);
532 uint64_t BIO_number_written(BIO *bio);
533
534 /* For BIO_f_asn1() */
535 int BIO_asn1_set_prefix(BIO *b, asn1_ps_func *prefix,
536 asn1_ps_func *prefix_free);
537 int BIO_asn1_get_prefix(BIO *b, asn1_ps_func **pprefix,
538 asn1_ps_func **pprefix_free);
539 int BIO_asn1_set_suffix(BIO *b, asn1_ps_func *suffix,
540 asn1_ps_func *suffix_free);
541 int BIO_asn1_get_suffix(BIO *b, asn1_ps_func **psuffix,
542 asn1_ps_func **psuffix_free);
543
544 const BIO_METHOD *BIO_s_file(void);
545 BIO *BIO_new_file(const char *filename, const char *mode);
546 # ifndef OPENSSL_NO_STDIO
547 BIO *BIO_new_fp(FILE *stream, int close_flag);
548 # endif
549 BIO *BIO_new(const BIO_METHOD *type);
550 int BIO_free(BIO *a);
551 void BIO_set_data(BIO *a, void *ptr);
552 void *BIO_get_data(BIO *a);
553 void BIO_set_init(BIO *a, int init);
554 int BIO_get_init(BIO *a);
555 void BIO_set_shutdown(BIO *a, int shut);
556 int BIO_get_shutdown(BIO *a);
557 void BIO_vfree(BIO *a);
558 int BIO_up_ref(BIO *a);
559 int BIO_read(BIO *b, void *data, int dlen);
560 int BIO_read_ex(BIO *b, void *data, size_t dlen, size_t *readbytes);
561 int BIO_gets(BIO *bp, char *buf, int size);
562 int BIO_write(BIO *b, const void *data, int dlen);
563 int BIO_write_ex(BIO *b, const void *data, size_t dlen, size_t *written);
564 int BIO_puts(BIO *bp, const char *buf);
565 int BIO_indent(BIO *b, int indent, int max);
566 long BIO_ctrl(BIO *bp, int cmd, long larg, void *parg);
567 long BIO_callback_ctrl(BIO *b, int cmd, BIO_info_cb *fp);
568 void *BIO_ptr_ctrl(BIO *bp, int cmd, long larg);
569 long BIO_int_ctrl(BIO *bp, int cmd, long larg, int iarg);
570 BIO *BIO_push(BIO *b, BIO *append);
571 BIO *BIO_pop(BIO *b);
572 void BIO_free_all(BIO *a);
573 BIO *BIO_find_type(BIO *b, int bio_type);
574 BIO *BIO_next(BIO *b);
575 void BIO_set_next(BIO *b, BIO *next);
576 BIO *BIO_get_retry_BIO(BIO *bio, int *reason);
577 int BIO_get_retry_reason(BIO *bio);
578 void BIO_set_retry_reason(BIO *bio, int reason);
579 BIO *BIO_dup_chain(BIO *in);
580
581 int BIO_nread0(BIO *bio, char **buf);
582 int BIO_nread(BIO *bio, char **buf, int num);
583 int BIO_nwrite0(BIO *bio, char **buf);
584 int BIO_nwrite(BIO *bio, char **buf, int num);
585
586 long BIO_debug_callback(BIO *bio, int cmd, const char *argp, int argi,
587 long argl, long ret);
588
589 const BIO_METHOD *BIO_s_mem(void);
590 const BIO_METHOD *BIO_s_secmem(void);
591 BIO *BIO_new_mem_buf(const void *buf, int len);
592 # ifndef OPENSSL_NO_SOCK
593 const BIO_METHOD *BIO_s_socket(void);
594 const BIO_METHOD *BIO_s_connect(void);
595 const BIO_METHOD *BIO_s_accept(void);
596 # endif
597 const BIO_METHOD *BIO_s_fd(void);
598 const BIO_METHOD *BIO_s_log(void);
599 const BIO_METHOD *BIO_s_bio(void);
600 const BIO_METHOD *BIO_s_null(void);
601 const BIO_METHOD *BIO_f_null(void);
602 const BIO_METHOD *BIO_f_buffer(void);
603 const BIO_METHOD *BIO_f_linebuffer(void);
604 const BIO_METHOD *BIO_f_nbio_test(void);
605 # ifndef OPENSSL_NO_DGRAM
606 const BIO_METHOD *BIO_s_datagram(void);
607 int BIO_dgram_non_fatal_error(int error);
608 BIO *BIO_new_dgram(int fd, int close_flag);
609 # ifndef OPENSSL_NO_SCTP
610 const BIO_METHOD *BIO_s_datagram_sctp(void);
611 BIO *BIO_new_dgram_sctp(int fd, int close_flag);
612 int BIO_dgram_is_sctp(BIO *bio);
613 int BIO_dgram_sctp_notification_cb(BIO *b,
614 void (*handle_notifications) (BIO *bio,
615 void *context,
616 void *buf),
617 void *context);
618 int BIO_dgram_sctp_wait_for_dry(BIO *b);
619 int BIO_dgram_sctp_msg_waiting(BIO *b);
620 # endif
621 # endif
622
623 # ifndef OPENSSL_NO_SOCK
624 int BIO_sock_should_retry(int i);
625 int BIO_sock_non_fatal_error(int error);
626 # endif
627
628 int BIO_fd_should_retry(int i);
629 int BIO_fd_non_fatal_error(int error);
630 int BIO_dump_cb(int (*cb) (const void *data, size_t len, void *u),
631 void *u, const char *s, int len);
632 int BIO_dump_indent_cb(int (*cb) (const void *data, size_t len, void *u),
633 void *u, const char *s, int len, int indent);
634 int BIO_dump(BIO *b, const char *bytes, int len);
635 int BIO_dump_indent(BIO *b, const char *bytes, int len, int indent);
636 # ifndef OPENSSL_NO_STDIO
637 int BIO_dump_fp(FILE *fp, const char *s, int len);
638 int BIO_dump_indent_fp(FILE *fp, const char *s, int len, int indent);
639 # endif
640 int BIO_hex_string(BIO *out, int indent, int width, unsigned char *data,
641 int datalen);
642
643 # ifndef OPENSSL_NO_SOCK
644 BIO_ADDR *BIO_ADDR_new(void);
645 int BIO_ADDR_rawmake(BIO_ADDR *ap, int family,
646 const void *where, size_t wherelen, unsigned short port);
647 void BIO_ADDR_free(BIO_ADDR *);
648 void BIO_ADDR_clear(BIO_ADDR *ap);
649 int BIO_ADDR_family(const BIO_ADDR *ap);
650 int BIO_ADDR_rawaddress(const BIO_ADDR *ap, void *p, size_t *l);
651 unsigned short BIO_ADDR_rawport(const BIO_ADDR *ap);
652 char *BIO_ADDR_hostname_string(const BIO_ADDR *ap, int numeric);
653 char *BIO_ADDR_service_string(const BIO_ADDR *ap, int numeric);
654 char *BIO_ADDR_path_string(const BIO_ADDR *ap);
655
656 const BIO_ADDRINFO *BIO_ADDRINFO_next(const BIO_ADDRINFO *bai);
657 int BIO_ADDRINFO_family(const BIO_ADDRINFO *bai);
658 int BIO_ADDRINFO_socktype(const BIO_ADDRINFO *bai);
659 int BIO_ADDRINFO_protocol(const BIO_ADDRINFO *bai);
660 const BIO_ADDR *BIO_ADDRINFO_address(const BIO_ADDRINFO *bai);
661 void BIO_ADDRINFO_free(BIO_ADDRINFO *bai);
662
663 enum BIO_hostserv_priorities {
664 BIO_PARSE_PRIO_HOST, BIO_PARSE_PRIO_SERV
665 };
666 int BIO_parse_hostserv(const char *hostserv, char **host, char **service,
667 enum BIO_hostserv_priorities hostserv_prio);
668 enum BIO_lookup_type {
669 BIO_LOOKUP_CLIENT, BIO_LOOKUP_SERVER
670 };
671 int BIO_lookup(const char *host, const char *service,
672 enum BIO_lookup_type lookup_type,
673 int family, int socktype, BIO_ADDRINFO **res);
674 int BIO_lookup_ex(const char *host, const char *service,
675 int lookup_type, int family, int socktype, int protocol,
676 BIO_ADDRINFO **res);
677 int BIO_sock_error(int sock);
678 int BIO_socket_ioctl(int fd, long type, void *arg);
679 int BIO_socket_nbio(int fd, int mode);
680 int BIO_sock_init(void);
681 # if OPENSSL_API_COMPAT < 0x10100000L
682 # define BIO_sock_cleanup() while(0) continue
683 # endif
684 int BIO_set_tcp_ndelay(int sock, int turn_on);
685
686 DEPRECATEDIN_1_1_0(struct hostent *BIO_gethostbyname(const char *name))
687 DEPRECATEDIN_1_1_0(int BIO_get_port(const char *str, unsigned short *port_ptr))
688 DEPRECATEDIN_1_1_0(int BIO_get_host_ip(const char *str, unsigned char *ip))
689 DEPRECATEDIN_1_1_0(int BIO_get_accept_socket(char *host_port, int mode))
690 DEPRECATEDIN_1_1_0(int BIO_accept(int sock, char **ip_port))
691
692 union BIO_sock_info_u {
693 BIO_ADDR *addr;
694 };
695 enum BIO_sock_info_type {
696 BIO_SOCK_INFO_ADDRESS
697 };
698 int BIO_sock_info(int sock,
699 enum BIO_sock_info_type type, union BIO_sock_info_u *info);
700
701 # define BIO_SOCK_REUSEADDR 0x01
702 # define BIO_SOCK_V6_ONLY 0x02
703 # define BIO_SOCK_KEEPALIVE 0x04
704 # define BIO_SOCK_NONBLOCK 0x08
705 # define BIO_SOCK_NODELAY 0x10
706
707 int BIO_socket(int domain, int socktype, int protocol, int options);
708 int BIO_connect(int sock, const BIO_ADDR *addr, int options);
709 int BIO_bind(int sock, const BIO_ADDR *addr, int options);
710 int BIO_listen(int sock, const BIO_ADDR *addr, int options);
711 int BIO_accept_ex(int accept_sock, BIO_ADDR *addr, int options);
712 int BIO_closesocket(int sock);
713
714 BIO *BIO_new_socket(int sock, int close_flag);
715 BIO *BIO_new_connect(const char *host_port);
716 BIO *BIO_new_accept(const char *host_port);
717 # endif /* OPENSSL_NO_SOCK*/
718
719 BIO *BIO_new_fd(int fd, int close_flag);
720
721 int BIO_new_bio_pair(BIO **bio1, size_t writebuf1,
722 BIO **bio2, size_t writebuf2);
723 /*
724 * If successful, returns 1 and in *bio1, *bio2 two BIO pair endpoints.
725 * Otherwise returns 0 and sets *bio1 and *bio2 to NULL. Size 0 uses default
726 * value.
727 */
728
729 void BIO_copy_next_retry(BIO *b);
730
731 /*
732 * long BIO_ghbn_ctrl(int cmd,int iarg,char *parg);
733 */
734
735 # define ossl_bio__attr__(x)
736 # if defined(__GNUC__) && defined(__STDC_VERSION__) \
737 && !defined(__APPLE__)
738 /*
739 * Because we support the 'z' modifier, which made its appearance in C99,
740 * we can't use __attribute__ with pre C99 dialects.
741 */
742 # if __STDC_VERSION__ >= 199901L
743 # undef ossl_bio__attr__
744 # define ossl_bio__attr__ __attribute__
745 # if __GNUC__*10 + __GNUC_MINOR__ >= 44
746 # define ossl_bio__printf__ __gnu_printf__
747 # else
748 # define ossl_bio__printf__ __printf__
749 # endif
750 # endif
751 # endif
752 int BIO_printf(BIO *bio, const char *format, ...)
753 ossl_bio__attr__((__format__(ossl_bio__printf__, 2, 3)));
754 int BIO_vprintf(BIO *bio, const char *format, va_list args)
755 ossl_bio__attr__((__format__(ossl_bio__printf__, 2, 0)));
756 int BIO_snprintf(char *buf, size_t n, const char *format, ...)
757 ossl_bio__attr__((__format__(ossl_bio__printf__, 3, 4)));
758 int BIO_vsnprintf(char *buf, size_t n, const char *format, va_list args)
759 ossl_bio__attr__((__format__(ossl_bio__printf__, 3, 0)));
760 # undef ossl_bio__attr__
761 # undef ossl_bio__printf__
762
763
764 BIO_METHOD *BIO_meth_new(int type, const char *name);
765 void BIO_meth_free(BIO_METHOD *biom);
766 int (*BIO_meth_get_write(const BIO_METHOD *biom)) (BIO *, const char *, int);
767 int (*BIO_meth_get_write_ex(const BIO_METHOD *biom)) (BIO *, const char *, size_t,
768 size_t *);
769 int BIO_meth_set_write(BIO_METHOD *biom,
770 int (*write) (BIO *, const char *, int));
771 int BIO_meth_set_write_ex(BIO_METHOD *biom,
772 int (*bwrite) (BIO *, const char *, size_t, size_t *));
773 int (*BIO_meth_get_read(const BIO_METHOD *biom)) (BIO *, char *, int);
774 int (*BIO_meth_get_read_ex(const BIO_METHOD *biom)) (BIO *, char *, size_t, size_t *);
775 int BIO_meth_set_read(BIO_METHOD *biom,
776 int (*read) (BIO *, char *, int));
777 int BIO_meth_set_read_ex(BIO_METHOD *biom,
778 int (*bread) (BIO *, char *, size_t, size_t *));
779 int (*BIO_meth_get_puts(const BIO_METHOD *biom)) (BIO *, const char *);
780 int BIO_meth_set_puts(BIO_METHOD *biom,
781 int (*puts) (BIO *, const char *));
782 int (*BIO_meth_get_gets(const BIO_METHOD *biom)) (BIO *, char *, int);
783 int BIO_meth_set_gets(BIO_METHOD *biom,
784 int (*gets) (BIO *, char *, int));
785 long (*BIO_meth_get_ctrl(const BIO_METHOD *biom)) (BIO *, int, long, void *);
786 int BIO_meth_set_ctrl(BIO_METHOD *biom,
787 long (*ctrl) (BIO *, int, long, void *));
788 int (*BIO_meth_get_create(const BIO_METHOD *bion)) (BIO *);
789 int BIO_meth_set_create(BIO_METHOD *biom, int (*create) (BIO *));
790 int (*BIO_meth_get_destroy(const BIO_METHOD *biom)) (BIO *);
791 int BIO_meth_set_destroy(BIO_METHOD *biom, int (*destroy) (BIO *));
792 long (*BIO_meth_get_callback_ctrl(const BIO_METHOD *biom))
793 (BIO *, int, BIO_info_cb *);
794 int BIO_meth_set_callback_ctrl(BIO_METHOD *biom,
795 long (*callback_ctrl) (BIO *, int,
796 BIO_info_cb *));
797
798 # ifdef __cplusplus
799 }
800 # endif
801 #endif