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