1/* crypto/bio/bio.h */
2/* Copyright (C) 1995-1998 Eric Young ([email protected])
3 * All rights reserved.
4 *
5 * This package is an SSL implementation written
6 * by Eric Young ([email protected]).
7 * The implementation was written so as to conform with Netscapes SSL.
8 *
9 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to. The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson ([email protected]).
15 *
16 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
22 *
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
25 * are met:
26 * 1. Redistributions of source code must retain the copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * "This product includes cryptographic software written by
34 * Eric Young ([email protected])"
35 * The word 'cryptographic' can be left out if the rouines from the library
36 * being used are not cryptographic related :-).
37 * 4. If you include any Windows specific code (or a derivative thereof) from
38 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson ([email protected])"
40 *
41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51 * SUCH DAMAGE.
52 *
53 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
57 */
58
59#ifndef HEADER_BIO_H
60# define HEADER_BIO_H
61
62# include <openssl/e_os2.h>
63
64# ifndef OPENSSL_NO_FP_API
65# include <stdio.h>
66# endif
67# include <stdarg.h>
68
69# include <openssl/crypto.h>
70
71# ifndef OPENSSL_NO_SCTP
72# ifndef OPENSSL_SYS_VMS
73# include <stdint.h>
74# else
75# include <inttypes.h>
76# endif
77# endif
78
79#ifdef __cplusplus
80extern "C" {
81#endif
82
83/* These are the 'types' of BIOs */
84# define BIO_TYPE_NONE 0
85# define BIO_TYPE_MEM (1|0x0400)
86# define BIO_TYPE_FILE (2|0x0400)
87
88# define BIO_TYPE_FD (4|0x0400|0x0100)
89# define BIO_TYPE_SOCKET (5|0x0400|0x0100)
90# define BIO_TYPE_NULL (6|0x0400)
91# define BIO_TYPE_SSL (7|0x0200)
92# define BIO_TYPE_MD (8|0x0200)/* passive filter */
93# define BIO_TYPE_BUFFER (9|0x0200)/* filter */
94# define BIO_TYPE_CIPHER (10|0x0200)/* filter */
95# define BIO_TYPE_BASE64 (11|0x0200)/* filter */
96# define BIO_TYPE_CONNECT (12|0x0400|0x0100)/* socket - connect */
97# define BIO_TYPE_ACCEPT (13|0x0400|0x0100)/* socket for accept */
98# define BIO_TYPE_PROXY_CLIENT (14|0x0200)/* client proxy BIO */
99# define BIO_TYPE_PROXY_SERVER (15|0x0200)/* server proxy BIO */
100# define BIO_TYPE_NBIO_TEST (16|0x0200)/* server proxy BIO */
101# define BIO_TYPE_NULL_FILTER (17|0x0200)
102# define BIO_TYPE_BER (18|0x0200)/* BER -> bin filter */
103# define BIO_TYPE_BIO (19|0x0400)/* (half a) BIO pair */
104# define BIO_TYPE_LINEBUFFER (20|0x0200)/* filter */
105# define BIO_TYPE_DGRAM (21|0x0400|0x0100)
106# ifndef OPENSSL_NO_SCTP
107# define BIO_TYPE_DGRAM_SCTP (24|0x0400|0x0100)
108# endif
109# define BIO_TYPE_ASN1 (22|0x0200)/* filter */
110# define BIO_TYPE_COMP (23|0x0200)/* filter */
111
112# define BIO_TYPE_DESCRIPTOR 0x0100/* socket, fd, connect or accept */
113# define BIO_TYPE_FILTER 0x0200
114# define BIO_TYPE_SOURCE_SINK 0x0400
115
116/*
117 * BIO_FILENAME_READ|BIO_CLOSE to open or close on free.
118 * BIO_set_fp(in,stdin,BIO_NOCLOSE);
119 */
120# define BIO_NOCLOSE 0x00
121# define BIO_CLOSE 0x01
122
123/*
124 * These are used in the following macros and are passed to BIO_ctrl()
125 */
126# define BIO_CTRL_RESET 1/* opt - rewind/zero etc */
127# define BIO_CTRL_EOF 2/* opt - are we at the eof */
128# define BIO_CTRL_INFO 3/* opt - extra tit-bits */
129# define BIO_CTRL_SET 4/* man - set the 'IO' type */
130# define BIO_CTRL_GET 5/* man - get the 'IO' type */
131# define BIO_CTRL_PUSH 6/* opt - internal, used to signify change */
132# define BIO_CTRL_POP 7/* opt - internal, used to signify change */
133# define BIO_CTRL_GET_CLOSE 8/* man - set the 'close' on free */
134# define BIO_CTRL_SET_CLOSE 9/* man - set the 'close' on free */
135# define BIO_CTRL_PENDING 10/* opt - is their more data buffered */
136# define BIO_CTRL_FLUSH 11/* opt - 'flush' buffered output */
137# define BIO_CTRL_DUP 12/* man - extra stuff for 'duped' BIO */
138# define BIO_CTRL_WPENDING 13/* opt - number of bytes still to write */
139/* callback is int cb(BIO *bio,state,ret); */
140# define BIO_CTRL_SET_CALLBACK 14/* opt - set callback function */
141# define BIO_CTRL_GET_CALLBACK 15/* opt - set callback function */
142
143# define BIO_CTRL_SET_FILENAME 30/* BIO_s_file special */
144
145/* dgram BIO stuff */
146# define BIO_CTRL_DGRAM_CONNECT 31/* BIO dgram special */
147# define BIO_CTRL_DGRAM_SET_CONNECTED 32/* allow for an externally connected
148 * socket to be passed in */
149# define BIO_CTRL_DGRAM_SET_RECV_TIMEOUT 33/* setsockopt, essentially */
150# define BIO_CTRL_DGRAM_GET_RECV_TIMEOUT 34/* getsockopt, essentially */
151# define BIO_CTRL_DGRAM_SET_SEND_TIMEOUT 35/* setsockopt, essentially */
152# define BIO_CTRL_DGRAM_GET_SEND_TIMEOUT 36/* getsockopt, essentially */
153
154# define BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP 37/* flag whether the last */
155# define BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP 38/* I/O operation tiemd out */
156
157/* #ifdef IP_MTU_DISCOVER */
158# define BIO_CTRL_DGRAM_MTU_DISCOVER 39/* set DF bit on egress packets */
159/* #endif */
160
161# define BIO_CTRL_DGRAM_QUERY_MTU 40/* as kernel for current MTU */
162# define BIO_CTRL_DGRAM_GET_FALLBACK_MTU 47
163# define BIO_CTRL_DGRAM_GET_MTU 41/* get cached value for MTU */
164# define BIO_CTRL_DGRAM_SET_MTU 42/* set cached value for MTU.
165 * want to use this if asking
166 * the kernel fails */
167
168# define BIO_CTRL_DGRAM_MTU_EXCEEDED 43/* check whether the MTU was
169 * exceed in the previous write
170 * operation */
171
172# define BIO_CTRL_DGRAM_GET_PEER 46
173# define BIO_CTRL_DGRAM_SET_PEER 44/* Destination for the data */
174
175# define BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT 45/* Next DTLS handshake timeout
176 * to adjust socket timeouts */
177# define BIO_CTRL_DGRAM_SET_DONT_FRAG 48
178
179# define BIO_CTRL_DGRAM_GET_MTU_OVERHEAD 49
180
181# ifndef OPENSSL_NO_SCTP
182/* SCTP stuff */
183# define BIO_CTRL_DGRAM_SCTP_SET_IN_HANDSHAKE 50
184# define BIO_CTRL_DGRAM_SCTP_ADD_AUTH_KEY 51
185# define BIO_CTRL_DGRAM_SCTP_NEXT_AUTH_KEY 52
186# define BIO_CTRL_DGRAM_SCTP_AUTH_CCS_RCVD 53
187# define BIO_CTRL_DGRAM_SCTP_GET_SNDINFO 60
188# define BIO_CTRL_DGRAM_SCTP_SET_SNDINFO 61
189# define BIO_CTRL_DGRAM_SCTP_GET_RCVINFO 62
190# define BIO_CTRL_DGRAM_SCTP_SET_RCVINFO 63
191# define BIO_CTRL_DGRAM_SCTP_GET_PRINFO 64
192# define BIO_CTRL_DGRAM_SCTP_SET_PRINFO 65
193# define BIO_CTRL_DGRAM_SCTP_SAVE_SHUTDOWN 70
194# endif
195
196/* modifiers */
197# define BIO_FP_READ 0x02
198# define BIO_FP_WRITE 0x04
199# define BIO_FP_APPEND 0x08
200# define BIO_FP_TEXT 0x10
201
202# define BIO_FLAGS_READ 0x01
203# define BIO_FLAGS_WRITE 0x02
204# define BIO_FLAGS_IO_SPECIAL 0x04
205# define BIO_FLAGS_RWS (BIO_FLAGS_READ|BIO_FLAGS_WRITE|BIO_FLAGS_IO_SPECIAL)
206# define BIO_FLAGS_SHOULD_RETRY 0x08
207# ifndef BIO_FLAGS_UPLINK
208/*
209 * "UPLINK" flag denotes file descriptors provided by application. It
210 * defaults to 0, as most platforms don't require UPLINK interface.
211 */
212# define BIO_FLAGS_UPLINK 0
213# endif
214
215/* Used in BIO_gethostbyname() */
216# define BIO_GHBN_CTRL_HITS 1
217# define BIO_GHBN_CTRL_MISSES 2
218# define BIO_GHBN_CTRL_CACHE_SIZE 3
219# define BIO_GHBN_CTRL_GET_ENTRY 4
220# define BIO_GHBN_CTRL_FLUSH 5
221
222/* Mostly used in the SSL BIO */
223/*-
224 * Not used anymore
225 * #define BIO_FLAGS_PROTOCOL_DELAYED_READ 0x10
226 * #define BIO_FLAGS_PROTOCOL_DELAYED_WRITE 0x20
227 * #define BIO_FLAGS_PROTOCOL_STARTUP 0x40
228 */
229
230# define BIO_FLAGS_BASE64_NO_NL 0x100
231
232/*
233 * This is used with memory BIOs: it means we shouldn't free up or change the
234 * data in any way.
235 */
236# define BIO_FLAGS_MEM_RDONLY 0x200
237
238typedef struct bio_st BIO;
239
240void BIO_set_flags(BIO *b, int flags);
241int BIO_test_flags(const BIO *b, int flags);
242void BIO_clear_flags(BIO *b, int flags);
243
244# define BIO_get_flags(b) BIO_test_flags(b, ~(0x0))
245# define BIO_set_retry_special(b) \
246 BIO_set_flags(b, (BIO_FLAGS_IO_SPECIAL|BIO_FLAGS_SHOULD_RETRY))
247# define BIO_set_retry_read(b) \
248 BIO_set_flags(b, (BIO_FLAGS_READ|BIO_FLAGS_SHOULD_RETRY))
249# define BIO_set_retry_write(b) \
250 BIO_set_flags(b, (BIO_FLAGS_WRITE|BIO_FLAGS_SHOULD_RETRY))
251
252/* These are normally used internally in BIOs */
253# define BIO_clear_retry_flags(b) \
254 BIO_clear_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
255# define BIO_get_retry_flags(b) \
256 BIO_test_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
257
258/* These should be used by the application to tell why we should retry */
259# define BIO_should_read(a) BIO_test_flags(a, BIO_FLAGS_READ)
260# define BIO_should_write(a) BIO_test_flags(a, BIO_FLAGS_WRITE)
261# define BIO_should_io_special(a) BIO_test_flags(a, BIO_FLAGS_IO_SPECIAL)
262# define BIO_retry_type(a) BIO_test_flags(a, BIO_FLAGS_RWS)
263# define BIO_should_retry(a) BIO_test_flags(a, BIO_FLAGS_SHOULD_RETRY)
264
265/*
266 * The next three are used in conjunction with the BIO_should_io_special()
267 * condition. After this returns true, BIO *BIO_get_retry_BIO(BIO *bio, int
268 * *reason); will walk the BIO stack and return the 'reason' for the special
269 * and the offending BIO. Given a BIO, BIO_get_retry_reason(bio) will return
270 * the code.
271 */
272/*
273 * Returned from the SSL bio when the certificate retrieval code had an error
274 */
275# define BIO_RR_SSL_X509_LOOKUP 0x01
276/* Returned from the connect BIO when a connect would have blocked */
277# define BIO_RR_CONNECT 0x02
278/* Returned from the accept BIO when an accept would have blocked */
279# define BIO_RR_ACCEPT 0x03
280
281/* These are passed by the BIO callback */
282# define BIO_CB_FREE 0x01
283# define BIO_CB_READ 0x02
284# define BIO_CB_WRITE 0x03
285# define BIO_CB_PUTS 0x04
286# define BIO_CB_GETS 0x05
287# define BIO_CB_CTRL 0x06
288
289/*
290 * The callback is called before and after the underling operation, The
291 * BIO_CB_RETURN flag indicates if it is after the call
292 */
293# define BIO_CB_RETURN 0x80
294# define BIO_CB_return(a) ((a)|BIO_CB_RETURN)
295# define BIO_cb_pre(a) (!((a)&BIO_CB_RETURN))
296# define BIO_cb_post(a) ((a)&BIO_CB_RETURN)
297
298long (*BIO_get_callback(const BIO *b)) (struct bio_st *, int, const char *,
299 int, long, long);
300void BIO_set_callback(BIO *b,
301 long (*callback) (struct bio_st *, int, const char *,
302 int, long, long));
303char *BIO_get_callback_arg(const BIO *b);
304void BIO_set_callback_arg(BIO *b, char *arg);
305
306const char *BIO_method_name(const BIO *b);
307int BIO_method_type(const BIO *b);
308
309typedef void bio_info_cb (struct bio_st *, int, const char *, int, long,
310 long);
311
312typedef struct bio_method_st {
313 int type;
314 const char *name;
315 int (*bwrite) (BIO *, const char *, int);
316 int (*bread) (BIO *, char *, int);
317 int (*bputs) (BIO *, const char *);
318 int (*bgets) (BIO *, char *, int);
319 long (*ctrl) (BIO *, int, long, void *);
320 int (*create) (BIO *);
321 int (*destroy) (BIO *);
322 long (*callback_ctrl) (BIO *, int, bio_info_cb *);
323} BIO_METHOD;
324
325struct bio_st {
326 BIO_METHOD *method;
327 /* bio, mode, argp, argi, argl, ret */
328 long (*callback) (struct bio_st *, int, const char *, int, long, long);
329 char *cb_arg; /* first argument for the callback */
330 int init;
331 int shutdown;
332 int flags; /* extra storage */
333 int retry_reason;
334 int num;
335 void *ptr;
336 struct bio_st *next_bio; /* used by filter BIOs */
337 struct bio_st *prev_bio; /* used by filter BIOs */
338 int references;
339 unsigned long num_read;
340 unsigned long num_write;
341 CRYPTO_EX_DATA ex_data;
342};
343
344DECLARE_STACK_OF(BIO)
345
346typedef struct bio_f_buffer_ctx_struct {
347 /*-
348 * Buffers are setup like this:
349 *
350 * <---------------------- size ----------------------->
351 * +---------------------------------------------------+
352 * | consumed | remaining | free space |
353 * +---------------------------------------------------+
354 * <-- off --><------- len ------->
355 */
356 /*- BIO *bio; *//*
357 * this is now in the BIO struct
358 */
359 int ibuf_size; /* how big is the input buffer */
360 int obuf_size; /* how big is the output buffer */
361 char *ibuf; /* the char array */
362 int ibuf_len; /* how many bytes are in it */
363 int ibuf_off; /* write/read offset */
364 char *obuf; /* the char array */
365 int obuf_len; /* how many bytes are in it */
366 int obuf_off; /* write/read offset */
367} BIO_F_BUFFER_CTX;
368
369/* Prefix and suffix callback in ASN1 BIO */
370typedef int asn1_ps_func (BIO *b, unsigned char **pbuf, int *plen,
371 void *parg);
372
373# ifndef OPENSSL_NO_SCTP
374/* SCTP parameter structs */
375struct bio_dgram_sctp_sndinfo {
376 uint16_t snd_sid;
377 uint16_t snd_flags;
378 uint32_t snd_ppid;
379 uint32_t snd_context;
380};
381
382struct bio_dgram_sctp_rcvinfo {
383 uint16_t rcv_sid;
384 uint16_t rcv_ssn;
385 uint16_t rcv_flags;
386 uint32_t rcv_ppid;
387 uint32_t rcv_tsn;
388 uint32_t rcv_cumtsn;
389 uint32_t rcv_context;
390};
391
392struct bio_dgram_sctp_prinfo {
393 uint16_t pr_policy;
394 uint32_t pr_value;
395};
396# endif
397
398/* connect BIO stuff */
399# define BIO_CONN_S_BEFORE 1
400# define BIO_CONN_S_GET_IP 2
401# define BIO_CONN_S_GET_PORT 3
402# define BIO_CONN_S_CREATE_SOCKET 4
403# define BIO_CONN_S_CONNECT 5
404# define BIO_CONN_S_OK 6
405# define BIO_CONN_S_BLOCKED_CONNECT 7
406# define BIO_CONN_S_NBIO 8
407/*
408 * #define BIO_CONN_get_param_hostname BIO_ctrl
409 */
410
411# define BIO_C_SET_CONNECT 100
412# define BIO_C_DO_STATE_MACHINE 101
413# define BIO_C_SET_NBIO 102
414# define BIO_C_SET_PROXY_PARAM 103
415# define BIO_C_SET_FD 104
416# define BIO_C_GET_FD 105
417# define BIO_C_SET_FILE_PTR 106
418# define BIO_C_GET_FILE_PTR 107
419# define BIO_C_SET_FILENAME 108
420# define BIO_C_SET_SSL 109
421# define BIO_C_GET_SSL 110
422# define BIO_C_SET_MD 111
423# define BIO_C_GET_MD 112
424# define BIO_C_GET_CIPHER_STATUS 113
425# define BIO_C_SET_BUF_MEM 114
426# define BIO_C_GET_BUF_MEM_PTR 115
427# define BIO_C_GET_BUFF_NUM_LINES 116
428# define BIO_C_SET_BUFF_SIZE 117
429# define BIO_C_SET_ACCEPT 118
430# define BIO_C_SSL_MODE 119
431# define BIO_C_GET_MD_CTX 120
432# define BIO_C_GET_PROXY_PARAM 121
433# define BIO_C_SET_BUFF_READ_DATA 122/* data to read first */
434# define BIO_C_GET_CONNECT 123
435# define BIO_C_GET_ACCEPT 124
436# define BIO_C_SET_SSL_RENEGOTIATE_BYTES 125
437# define BIO_C_GET_SSL_NUM_RENEGOTIATES 126
438# define BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT 127
439# define BIO_C_FILE_SEEK 128
440# define BIO_C_GET_CIPHER_CTX 129
441# define BIO_C_SET_BUF_MEM_EOF_RETURN 130/* return end of input
442 * value */
443# define BIO_C_SET_BIND_MODE 131
444# define BIO_C_GET_BIND_MODE 132
445# define BIO_C_FILE_TELL 133
446# define BIO_C_GET_SOCKS 134
447# define BIO_C_SET_SOCKS 135
448
449# define BIO_C_SET_WRITE_BUF_SIZE 136/* for BIO_s_bio */
450# define BIO_C_GET_WRITE_BUF_SIZE 137
451# define BIO_C_MAKE_BIO_PAIR 138
452# define BIO_C_DESTROY_BIO_PAIR 139
453# define BIO_C_GET_WRITE_GUARANTEE 140
454# define BIO_C_GET_READ_REQUEST 141
455# define BIO_C_SHUTDOWN_WR 142
456# define BIO_C_NREAD0 143
457# define BIO_C_NREAD 144
458# define BIO_C_NWRITE0 145
459# define BIO_C_NWRITE 146
460# define BIO_C_RESET_READ_REQUEST 147
461# define BIO_C_SET_MD_CTX 148
462
463# define BIO_C_SET_PREFIX 149
464# define BIO_C_GET_PREFIX 150
465# define BIO_C_SET_SUFFIX 151
466# define BIO_C_GET_SUFFIX 152
467
468# define BIO_C_SET_EX_ARG 153
469# define BIO_C_GET_EX_ARG 154
470
471# define BIO_set_app_data(s,arg) BIO_set_ex_data(s,0,arg)
472# define BIO_get_app_data(s) BIO_get_ex_data(s,0)
473
474/* BIO_s_connect() and BIO_s_socks4a_connect() */
475# define BIO_set_conn_hostname(b,name) BIO_ctrl(b,BIO_C_SET_CONNECT,0,(char *)name)
476# define BIO_set_conn_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,1,(char *)port)
477# define BIO_set_conn_ip(b,ip) BIO_ctrl(b,BIO_C_SET_CONNECT,2,(char *)ip)
478# define BIO_set_conn_int_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,3,(char *)port)
479# define BIO_get_conn_hostname(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,0)
480# define BIO_get_conn_port(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,1)
481# define BIO_get_conn_ip(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,2)
482# define BIO_get_conn_int_port(b) BIO_ctrl(b,BIO_C_GET_CONNECT,3,NULL)
483
484# define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL)
485
486/* BIO_s_accept() */
487# define BIO_set_accept_port(b,name) BIO_ctrl(b,BIO_C_SET_ACCEPT,0,(char *)name)
488# define BIO_get_accept_port(b) BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,0)
489/* #define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL) */
490# define BIO_set_nbio_accept(b,n) BIO_ctrl(b,BIO_C_SET_ACCEPT,1,(n)?(void *)"a":NULL)
491# define BIO_set_accept_bios(b,bio) BIO_ctrl(b,BIO_C_SET_ACCEPT,2,(char *)bio)
492
493# define BIO_BIND_NORMAL 0
494# define BIO_BIND_REUSEADDR_IF_UNUSED 1
495# define BIO_BIND_REUSEADDR 2
496# define BIO_set_bind_mode(b,mode) BIO_ctrl(b,BIO_C_SET_BIND_MODE,mode,NULL)
497# define BIO_get_bind_mode(b,mode) BIO_ctrl(b,BIO_C_GET_BIND_MODE,0,NULL)
498
499/* BIO_s_accept() and BIO_s_connect() */
500# define BIO_do_connect(b) BIO_do_handshake(b)
501# define BIO_do_accept(b) BIO_do_handshake(b)
502# define BIO_do_handshake(b) BIO_ctrl(b,BIO_C_DO_STATE_MACHINE,0,NULL)
503
504/* BIO_s_proxy_client() */
505# define BIO_set_url(b,url) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,0,(char *)(url))
506# define BIO_set_proxies(b,p) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,1,(char *)(p))
507/* BIO_set_nbio(b,n) */
508# define BIO_set_filter_bio(b,s) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,2,(char *)(s))
509/* BIO *BIO_get_filter_bio(BIO *bio); */
510# define BIO_set_proxy_cb(b,cb) BIO_callback_ctrl(b,BIO_C_SET_PROXY_PARAM,3,(void *(*cb)()))
511# define BIO_set_proxy_header(b,sk) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,4,(char *)sk)
512# define BIO_set_no_connect_return(b,bool) BIO_int_ctrl(b,BIO_C_SET_PROXY_PARAM,5,bool)
513
514# define BIO_get_proxy_header(b,skp) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,0,(char *)skp)
515# define BIO_get_proxies(b,pxy_p) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,1,(char *)(pxy_p))
516# define BIO_get_url(b,url) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,2,(char *)(url))
517# define BIO_get_no_connect_return(b) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,5,NULL)
518
519/* BIO_s_datagram(), BIO_s_fd(), BIO_s_socket(), BIO_s_accept() and BIO_s_connect() */
520# define BIO_set_fd(b,fd,c) BIO_int_ctrl(b,BIO_C_SET_FD,c,fd)
521# define BIO_get_fd(b,c) BIO_ctrl(b,BIO_C_GET_FD,0,(char *)c)
522
523/* BIO_s_file() */
524# define BIO_set_fp(b,fp,c) BIO_ctrl(b,BIO_C_SET_FILE_PTR,c,(char *)fp)
525# define BIO_get_fp(b,fpp) BIO_ctrl(b,BIO_C_GET_FILE_PTR,0,(char *)fpp)
526
527/* BIO_s_fd() and BIO_s_file() */
528# define BIO_seek(b,ofs) (int)BIO_ctrl(b,BIO_C_FILE_SEEK,ofs,NULL)
529# define BIO_tell(b) (int)BIO_ctrl(b,BIO_C_FILE_TELL,0,NULL)
530
531/*
532 * name is cast to lose const, but might be better to route through a
533 * function so we can do it safely
534 */
535# ifdef CONST_STRICT
536/*
537 * If you are wondering why this isn't defined, its because CONST_STRICT is
538 * purely a compile-time kludge to allow const to be checked.
539 */
540int BIO_read_filename(BIO *b, const char *name);
541# else
542# define BIO_read_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
543 BIO_CLOSE|BIO_FP_READ,(char *)name)
544# endif
545# define BIO_write_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
546 BIO_CLOSE|BIO_FP_WRITE,name)
547# define BIO_append_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
548 BIO_CLOSE|BIO_FP_APPEND,name)
549# define BIO_rw_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
550 BIO_CLOSE|BIO_FP_READ|BIO_FP_WRITE,name)
551
552/*
553 * WARNING WARNING, this ups the reference count on the read bio of the SSL
554 * structure. This is because the ssl read BIO is now pointed to by the
555 * next_bio field in the bio. So when you free the BIO, make sure you are
556 * doing a BIO_free_all() to catch the underlying BIO.
557 */
558# define BIO_set_ssl(b,ssl,c) BIO_ctrl(b,BIO_C_SET_SSL,c,(char *)ssl)
559# define BIO_get_ssl(b,sslp) BIO_ctrl(b,BIO_C_GET_SSL,0,(char *)sslp)
560# define BIO_set_ssl_mode(b,client) BIO_ctrl(b,BIO_C_SSL_MODE,client,NULL)
561# define BIO_set_ssl_renegotiate_bytes(b,num) \
562 BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_BYTES,num,NULL);
563# define BIO_get_num_renegotiates(b) \
564 BIO_ctrl(b,BIO_C_GET_SSL_NUM_RENEGOTIATES,0,NULL);
565# define BIO_set_ssl_renegotiate_timeout(b,seconds) \
566 BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT,seconds,NULL);
567
568/* defined in evp.h */
569/* #define BIO_set_md(b,md) BIO_ctrl(b,BIO_C_SET_MD,1,(char *)md) */
570
571# define BIO_get_mem_data(b,pp) BIO_ctrl(b,BIO_CTRL_INFO,0,(char *)pp)
572# define BIO_set_mem_buf(b,bm,c) BIO_ctrl(b,BIO_C_SET_BUF_MEM,c,(char *)bm)
573# define BIO_get_mem_ptr(b,pp) BIO_ctrl(b,BIO_C_GET_BUF_MEM_PTR,0,(char *)pp)
574# define BIO_set_mem_eof_return(b,v) \
575 BIO_ctrl(b,BIO_C_SET_BUF_MEM_EOF_RETURN,v,NULL)
576
577/* For the BIO_f_buffer() type */
578# define BIO_get_buffer_num_lines(b) BIO_ctrl(b,BIO_C_GET_BUFF_NUM_LINES,0,NULL)
579# define BIO_set_buffer_size(b,size) BIO_ctrl(b,BIO_C_SET_BUFF_SIZE,size,NULL)
580# define BIO_set_read_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,0)
581# define BIO_set_write_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,1)
582# define BIO_set_buffer_read_data(b,buf,num) BIO_ctrl(b,BIO_C_SET_BUFF_READ_DATA,num,buf)
583
584/* Don't use the next one unless you know what you are doing :-) */
585# define BIO_dup_state(b,ret) BIO_ctrl(b,BIO_CTRL_DUP,0,(char *)(ret))
586
587# define BIO_reset(b) (int)BIO_ctrl(b,BIO_CTRL_RESET,0,NULL)
588# define BIO_eof(b) (int)BIO_ctrl(b,BIO_CTRL_EOF,0,NULL)
589# define BIO_set_close(b,c) (int)BIO_ctrl(b,BIO_CTRL_SET_CLOSE,(c),NULL)
590# define BIO_get_close(b) (int)BIO_ctrl(b,BIO_CTRL_GET_CLOSE,0,NULL)
591# define BIO_pending(b) (int)BIO_ctrl(b,BIO_CTRL_PENDING,0,NULL)
592# define BIO_wpending(b) (int)BIO_ctrl(b,BIO_CTRL_WPENDING,0,NULL)
593/* ...pending macros have inappropriate return type */
594size_t BIO_ctrl_pending(BIO *b);
595size_t BIO_ctrl_wpending(BIO *b);
596# define BIO_flush(b) (int)BIO_ctrl(b,BIO_CTRL_FLUSH,0,NULL)
597# define BIO_get_info_callback(b,cbp) (int)BIO_ctrl(b,BIO_CTRL_GET_CALLBACK,0, \
598 cbp)
599# define BIO_set_info_callback(b,cb) (int)BIO_callback_ctrl(b,BIO_CTRL_SET_CALLBACK,cb)
600
601/* For the BIO_f_buffer() type */
602# define BIO_buffer_get_num_lines(b) BIO_ctrl(b,BIO_CTRL_GET,0,NULL)
603
604/* For BIO_s_bio() */
605# define BIO_set_write_buf_size(b,size) (int)BIO_ctrl(b,BIO_C_SET_WRITE_BUF_SIZE,size,NULL)
606# define BIO_get_write_buf_size(b,size) (size_t)BIO_ctrl(b,BIO_C_GET_WRITE_BUF_SIZE,size,NULL)
607# define BIO_make_bio_pair(b1,b2) (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2)
608# define BIO_destroy_bio_pair(b) (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL)
609# define BIO_shutdown_wr(b) (int)BIO_ctrl(b, BIO_C_SHUTDOWN_WR, 0, NULL)
610/* macros with inappropriate type -- but ...pending macros use int too: */
611# define BIO_get_write_guarantee(b) (int)BIO_ctrl(b,BIO_C_GET_WRITE_GUARANTEE,0,NULL)
612# define BIO_get_read_request(b) (int)BIO_ctrl(b,BIO_C_GET_READ_REQUEST,0,NULL)
613size_t BIO_ctrl_get_write_guarantee(BIO *b);
614size_t BIO_ctrl_get_read_request(BIO *b);
615int BIO_ctrl_reset_read_request(BIO *b);
616
617/* ctrl macros for dgram */
618# define BIO_ctrl_dgram_connect(b,peer) \
619 (int)BIO_ctrl(b,BIO_CTRL_DGRAM_CONNECT,0, (char *)peer)
620# define BIO_ctrl_set_connected(b, state, peer) \
621 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_CONNECTED, state, (char *)peer)
622# define BIO_dgram_recv_timedout(b) \
623 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP, 0, NULL)
624# define BIO_dgram_send_timedout(b) \
625 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP, 0, NULL)
626# define BIO_dgram_get_peer(b,peer) \
627 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_PEER, 0, (char *)peer)
628# define BIO_dgram_set_peer(b,peer) \
629 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_PEER, 0, (char *)peer)
630# define BIO_dgram_get_mtu_overhead(b) \
631 (unsigned int)BIO_ctrl((b), BIO_CTRL_DGRAM_GET_MTU_OVERHEAD, 0, NULL)
632
633/* These two aren't currently implemented */
634/* int BIO_get_ex_num(BIO *bio); */
635/* void BIO_set_ex_free_func(BIO *bio,int idx,void (*cb)()); */
636int BIO_set_ex_data(BIO *bio, int idx, void *data);
637void *BIO_get_ex_data(BIO *bio, int idx);
638int BIO_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
639 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
640unsigned long BIO_number_read(BIO *bio);
641unsigned long BIO_number_written(BIO *bio);
642
643/* For BIO_f_asn1() */
644int BIO_asn1_set_prefix(BIO *b, asn1_ps_func *prefix,
645 asn1_ps_func *prefix_free);
646int BIO_asn1_get_prefix(BIO *b, asn1_ps_func **pprefix,
647 asn1_ps_func **pprefix_free);
648int BIO_asn1_set_suffix(BIO *b, asn1_ps_func *suffix,
649 asn1_ps_func *suffix_free);
650int BIO_asn1_get_suffix(BIO *b, asn1_ps_func **psuffix,
651 asn1_ps_func **psuffix_free);
652
653# ifndef OPENSSL_NO_FP_API
654BIO_METHOD *BIO_s_file(void);
655BIO *BIO_new_file(const char *filename, const char *mode);
656BIO *BIO_new_fp(FILE *stream, int close_flag);
657# define BIO_s_file_internal BIO_s_file
658# endif
659BIO *BIO_new(BIO_METHOD *type);
660int BIO_set(BIO *a, BIO_METHOD *type);
661int BIO_free(BIO *a);
662void BIO_vfree(BIO *a);
663int BIO_read(BIO *b, void *data, int len);
664int BIO_gets(BIO *bp, char *buf, int size);
665int BIO_write(BIO *b, const void *data, int len);
666int BIO_puts(BIO *bp, const char *buf);
667int BIO_indent(BIO *b, int indent, int max);
668long BIO_ctrl(BIO *bp, int cmd, long larg, void *parg);
669long BIO_callback_ctrl(BIO *b, int cmd,
670 void (*fp) (struct bio_st *, int, const char *, int,
671 long, long));
672char *BIO_ptr_ctrl(BIO *bp, int cmd, long larg);
673long BIO_int_ctrl(BIO *bp, int cmd, long larg, int iarg);
674BIO *BIO_push(BIO *b, BIO *append);
675BIO *BIO_pop(BIO *b);
676void BIO_free_all(BIO *a);
677BIO *BIO_find_type(BIO *b, int bio_type);
678BIO *BIO_next(BIO *b);
679BIO *BIO_get_retry_BIO(BIO *bio, int *reason);
680int BIO_get_retry_reason(BIO *bio);
681BIO *BIO_dup_chain(BIO *in);
682
683int BIO_nread0(BIO *bio, char **buf);
684int BIO_nread(BIO *bio, char **buf, int num);
685int BIO_nwrite0(BIO *bio, char **buf);
686int BIO_nwrite(BIO *bio, char **buf, int num);
687
688long BIO_debug_callback(BIO *bio, int cmd, const char *argp, int argi,
689 long argl, long ret);
690
691BIO_METHOD *BIO_s_mem(void);
692BIO *BIO_new_mem_buf(const void *buf, int len);
693BIO_METHOD *BIO_s_socket(void);
694BIO_METHOD *BIO_s_connect(void);
695BIO_METHOD *BIO_s_accept(void);
696BIO_METHOD *BIO_s_fd(void);
697# ifndef OPENSSL_SYS_OS2
698BIO_METHOD *BIO_s_log(void);
699# endif
700BIO_METHOD *BIO_s_bio(void);
701BIO_METHOD *BIO_s_null(void);
702BIO_METHOD *BIO_f_null(void);
703BIO_METHOD *BIO_f_buffer(void);
704# ifdef OPENSSL_SYS_VMS
705BIO_METHOD *BIO_f_linebuffer(void);
706# endif
707BIO_METHOD *BIO_f_nbio_test(void);
708# ifndef OPENSSL_NO_DGRAM
709BIO_METHOD *BIO_s_datagram(void);
710# ifndef OPENSSL_NO_SCTP
711BIO_METHOD *BIO_s_datagram_sctp(void);
712# endif
713# endif
714
715/* BIO_METHOD *BIO_f_ber(void); */
716
717int BIO_sock_should_retry(int i);
718int BIO_sock_non_fatal_error(int error);
719int BIO_dgram_non_fatal_error(int error);
720
721int BIO_fd_should_retry(int i);
722int BIO_fd_non_fatal_error(int error);
723int BIO_dump_cb(int (*cb) (const void *data, size_t len, void *u),
724 void *u, const char *s, int len);
725int BIO_dump_indent_cb(int (*cb) (const void *data, size_t len, void *u),
726 void *u, const char *s, int len, int indent);
727int BIO_dump(BIO *b, const char *bytes, int len);
728int BIO_dump_indent(BIO *b, const char *bytes, int len, int indent);
729# ifndef OPENSSL_NO_FP_API
730int BIO_dump_fp(FILE *fp, const char *s, int len);
731int BIO_dump_indent_fp(FILE *fp, const char *s, int len, int indent);
732# endif
733int BIO_hex_string(BIO *out, int indent, int width, unsigned char *data,
734 int datalen);
735
736struct hostent *BIO_gethostbyname(const char *name);
737/*-
738 * We might want a thread-safe interface too:
739 * struct hostent *BIO_gethostbyname_r(const char *name,
740 * struct hostent *result, void *buffer, size_t buflen);
741 * or something similar (caller allocates a struct hostent,
742 * pointed to by "result", and additional buffer space for the various
743 * substructures; if the buffer does not suffice, NULL is returned
744 * and an appropriate error code is set).
745 */
746int BIO_sock_error(int sock);
747int BIO_socket_ioctl(int fd, long type, void *arg);
748int BIO_socket_nbio(int fd, int mode);
749int BIO_get_port(const char *str, unsigned short *port_ptr);
750int BIO_get_host_ip(const char *str, unsigned char *ip);
751int BIO_get_accept_socket(char *host_port, int mode);
752int BIO_accept(int sock, char **ip_port);
753int BIO_sock_init(void);
754void BIO_sock_cleanup(void);
755int BIO_set_tcp_ndelay(int sock, int turn_on);
756
757BIO *BIO_new_socket(int sock, int close_flag);
758BIO *BIO_new_dgram(int fd, int close_flag);
759# ifndef OPENSSL_NO_SCTP
760BIO *BIO_new_dgram_sctp(int fd, int close_flag);
761int BIO_dgram_is_sctp(BIO *bio);
762int BIO_dgram_sctp_notification_cb(BIO *b,
763 void (*handle_notifications) (BIO *bio,
764 void
765 *context,
766 void *buf),
767 void *context);
768int BIO_dgram_sctp_wait_for_dry(BIO *b);
769int BIO_dgram_sctp_msg_waiting(BIO *b);
770# endif
771BIO *BIO_new_fd(int fd, int close_flag);
772BIO *BIO_new_connect(const char *host_port);
773BIO *BIO_new_accept(const char *host_port);
774
775int BIO_new_bio_pair(BIO **bio1, size_t writebuf1,
776 BIO **bio2, size_t writebuf2);
777/*
778 * If successful, returns 1 and in *bio1, *bio2 two BIO pair endpoints.
779 * Otherwise returns 0 and sets *bio1 and *bio2 to NULL. Size 0 uses default
780 * value.
781 */
782
783void BIO_copy_next_retry(BIO *b);
784
785/*
786 * long BIO_ghbn_ctrl(int cmd,int iarg,char *parg);
787 */
788
789# ifdef __GNUC__
790# define __bio_h__attr__ __attribute__
791# else
792# define __bio_h__attr__(x)
793# endif
794int BIO_printf(BIO *bio, const char *format, ...)
795__bio_h__attr__((__format__(__printf__, 2, 3)));
796int BIO_vprintf(BIO *bio, const char *format, va_list args)
797__bio_h__attr__((__format__(__printf__, 2, 0)));
798int BIO_snprintf(char *buf, size_t n, const char *format, ...)
799__bio_h__attr__((__format__(__printf__, 3, 4)));
800int BIO_vsnprintf(char *buf, size_t n, const char *format, va_list args)
801__bio_h__attr__((__format__(__printf__, 3, 0)));
802# undef __bio_h__attr__
803
804/* BEGIN ERROR CODES */
805/*
806 * The following lines are auto generated by the script mkerr.pl. Any changes
807 * made after this point may be overwritten when the script is next run.
808 */
809void ERR_load_BIO_strings(void);
810
811/* Error codes for the BIO functions. */
812
813/* Function codes. */
814# define BIO_F_ACPT_STATE 100
815# define BIO_F_BIO_ACCEPT 101
816# define BIO_F_BIO_BER_GET_HEADER 102
817# define BIO_F_BIO_CALLBACK_CTRL 131
818# define BIO_F_BIO_CTRL 103
819# define BIO_F_BIO_GETHOSTBYNAME 120
820# define BIO_F_BIO_GETS 104
821# define BIO_F_BIO_GET_ACCEPT_SOCKET 105
822# define BIO_F_BIO_GET_HOST_IP 106
823# define BIO_F_BIO_GET_PORT 107
824# define BIO_F_BIO_MAKE_PAIR 121
825# define BIO_F_BIO_NEW 108
826# define BIO_F_BIO_NEW_FILE 109
827# define BIO_F_BIO_NEW_MEM_BUF 126
828# define BIO_F_BIO_NREAD 123
829# define BIO_F_BIO_NREAD0 124
830# define BIO_F_BIO_NWRITE 125
831# define BIO_F_BIO_NWRITE0 122
832# define BIO_F_BIO_PUTS 110
833# define BIO_F_BIO_READ 111
834# define BIO_F_BIO_SOCK_INIT 112
835# define BIO_F_BIO_WRITE 113
836# define BIO_F_BUFFER_CTRL 114
837# define BIO_F_CONN_CTRL 127
838# define BIO_F_CONN_STATE 115
839# define BIO_F_DGRAM_SCTP_READ 132
840# define BIO_F_DGRAM_SCTP_WRITE 133
841# define BIO_F_FILE_CTRL 116
842# define BIO_F_FILE_READ 130
843# define BIO_F_LINEBUFFER_CTRL 129
844# define BIO_F_MEM_READ 128
845# define BIO_F_MEM_WRITE 117
846# define BIO_F_SSL_NEW 118
847# define BIO_F_WSASTARTUP 119
848
849/* Reason codes. */
850# define BIO_R_ACCEPT_ERROR 100
851# define BIO_R_BAD_FOPEN_MODE 101
852# define BIO_R_BAD_HOSTNAME_LOOKUP 102
853# define BIO_R_BROKEN_PIPE 124
854# define BIO_R_CONNECT_ERROR 103
855# define BIO_R_EOF_ON_MEMORY_BIO 127
856# define BIO_R_ERROR_SETTING_NBIO 104
857# define BIO_R_ERROR_SETTING_NBIO_ON_ACCEPTED_SOCKET 105
858# define BIO_R_ERROR_SETTING_NBIO_ON_ACCEPT_SOCKET 106
859# define BIO_R_GETHOSTBYNAME_ADDR_IS_NOT_AF_INET 107
860# define BIO_R_INVALID_ARGUMENT 125
861# define BIO_R_INVALID_IP_ADDRESS 108
862# define BIO_R_IN_USE 123
863# define BIO_R_KEEPALIVE 109
864# define BIO_R_NBIO_CONNECT_ERROR 110
865# define BIO_R_NO_ACCEPT_PORT_SPECIFIED 111
866# define BIO_R_NO_HOSTNAME_SPECIFIED 112
867# define BIO_R_NO_PORT_DEFINED 113
868# define BIO_R_NO_PORT_SPECIFIED 114
869# define BIO_R_NO_SUCH_FILE 128
870# define BIO_R_NULL_PARAMETER 115
871# define BIO_R_TAG_MISMATCH 116
872# define BIO_R_UNABLE_TO_BIND_SOCKET 117
873# define BIO_R_UNABLE_TO_CREATE_SOCKET 118
874# define BIO_R_UNABLE_TO_LISTEN_SOCKET 119
875# define BIO_R_UNINITIALIZED 120
876# define BIO_R_UNSUPPORTED_METHOD 121
877# define BIO_R_WRITE_TO_READ_ONLY_BIO 126
878# define BIO_R_WSASTARTUP 122
879
880#ifdef __cplusplus
881}
882#endif
883#endif
884