bio.h 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726
  1. /* $OpenBSD: bio.h,v 1.63 2024/03/02 09:22:41 tb Exp $ */
  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. #ifndef HEADER_BIO_H
  59. #define HEADER_BIO_H
  60. #if !defined(HAVE_ATTRIBUTE__BOUNDED__) && !defined(__OpenBSD__)
  61. #define __bounded__(x, y, z)
  62. #endif
  63. #include <openssl/opensslconf.h>
  64. # include <stdio.h>
  65. #include <stdarg.h>
  66. #include <openssl/crypto.h>
  67. #ifdef __cplusplus
  68. extern "C" {
  69. #endif
  70. /* These are the 'types' of BIOs */
  71. #define BIO_TYPE_NONE 0
  72. #define BIO_TYPE_MEM (1|0x0400)
  73. #define BIO_TYPE_FILE (2|0x0400)
  74. #define BIO_TYPE_FD (4|0x0400|0x0100)
  75. #define BIO_TYPE_SOCKET (5|0x0400|0x0100)
  76. #define BIO_TYPE_NULL (6|0x0400)
  77. #define BIO_TYPE_SSL (7|0x0200)
  78. #define BIO_TYPE_MD (8|0x0200) /* passive filter */
  79. #define BIO_TYPE_BUFFER (9|0x0200) /* filter */
  80. #define BIO_TYPE_CIPHER (10|0x0200) /* filter */
  81. #define BIO_TYPE_BASE64 (11|0x0200) /* filter */
  82. #define BIO_TYPE_CONNECT (12|0x0400|0x0100) /* socket - connect */
  83. #define BIO_TYPE_ACCEPT (13|0x0400|0x0100) /* socket for accept */
  84. #define BIO_TYPE_PROXY_CLIENT (14|0x0200) /* client proxy BIO */
  85. #define BIO_TYPE_PROXY_SERVER (15|0x0200) /* server proxy BIO */
  86. #define BIO_TYPE_NBIO_TEST (16|0x0200) /* server proxy BIO */
  87. #define BIO_TYPE_NULL_FILTER (17|0x0200)
  88. #define BIO_TYPE_BER (18|0x0200) /* BER -> bin filter */
  89. #define BIO_TYPE_BIO (19|0x0400) /* (half a) BIO pair */
  90. #define BIO_TYPE_LINEBUFFER (20|0x0200) /* filter */
  91. #define BIO_TYPE_DGRAM (21|0x0400|0x0100)
  92. #define BIO_TYPE_ASN1 (22|0x0200) /* filter */
  93. #define BIO_TYPE_COMP (23|0x0200) /* filter */
  94. #define BIO_TYPE_DESCRIPTOR 0x0100 /* socket, fd, connect or accept */
  95. #define BIO_TYPE_FILTER 0x0200
  96. #define BIO_TYPE_SOURCE_SINK 0x0400
  97. /*
  98. * BIO_TYPE_START is the first user-allocated BIO type. No pre-defined type,
  99. * flag bits aside, may exceed this value.
  100. */
  101. #define BIO_TYPE_START 128
  102. /* BIO_FILENAME_READ|BIO_CLOSE to open or close on free.
  103. * BIO_set_fp(in,stdin,BIO_NOCLOSE); */
  104. #define BIO_NOCLOSE 0x00
  105. #define BIO_CLOSE 0x01
  106. /* These are used in the following macros and are passed to
  107. * BIO_ctrl() */
  108. #define BIO_CTRL_RESET 1 /* opt - rewind/zero etc */
  109. #define BIO_CTRL_EOF 2 /* opt - are we at the eof */
  110. #define BIO_CTRL_INFO 3 /* opt - extra tit-bits */
  111. #define BIO_CTRL_SET 4 /* man - set the 'IO' type */
  112. #define BIO_CTRL_GET 5 /* man - get the 'IO' type */
  113. #define BIO_CTRL_PUSH 6 /* opt - internal, used to signify change */
  114. #define BIO_CTRL_POP 7 /* opt - internal, used to signify change */
  115. #define BIO_CTRL_GET_CLOSE 8 /* man - set the 'close' on free */
  116. #define BIO_CTRL_SET_CLOSE 9 /* man - set the 'close' on free */
  117. #define BIO_CTRL_PENDING 10 /* opt - is their more data buffered */
  118. #define BIO_CTRL_FLUSH 11 /* opt - 'flush' buffered output */
  119. #define BIO_CTRL_DUP 12 /* man - extra stuff for 'duped' BIO */
  120. #define BIO_CTRL_WPENDING 13 /* opt - number of bytes still to write */
  121. /* callback is int cb(BIO *bio,state,ret); */
  122. #define BIO_CTRL_SET_CALLBACK 14 /* opt - set callback function */
  123. #define BIO_CTRL_GET_CALLBACK 15 /* opt - set callback function */
  124. #define BIO_CTRL_SET_FILENAME 30 /* BIO_s_file special */
  125. /* dgram BIO stuff */
  126. #define BIO_CTRL_DGRAM_CONNECT 31 /* BIO dgram special */
  127. #define BIO_CTRL_DGRAM_SET_CONNECTED 32 /* allow for an externally
  128. * connected socket to be
  129. * passed in */
  130. #define BIO_CTRL_DGRAM_SET_RECV_TIMEOUT 33 /* setsockopt, essentially */
  131. #define BIO_CTRL_DGRAM_GET_RECV_TIMEOUT 34 /* getsockopt, essentially */
  132. #define BIO_CTRL_DGRAM_SET_SEND_TIMEOUT 35 /* setsockopt, essentially */
  133. #define BIO_CTRL_DGRAM_GET_SEND_TIMEOUT 36 /* getsockopt, essentially */
  134. #define BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP 37 /* flag whether the last */
  135. #define BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP 38 /* I/O operation tiemd out */
  136. /* #ifdef IP_MTU_DISCOVER */
  137. #define BIO_CTRL_DGRAM_MTU_DISCOVER 39 /* set DF bit on egress packets */
  138. /* #endif */
  139. #define BIO_CTRL_DGRAM_QUERY_MTU 40 /* as kernel for current MTU */
  140. #define BIO_CTRL_DGRAM_GET_FALLBACK_MTU 47
  141. #define BIO_CTRL_DGRAM_GET_MTU 41 /* get cached value for MTU */
  142. #define BIO_CTRL_DGRAM_SET_MTU 42 /* set cached value for
  143. * MTU. want to use this
  144. * if asking the kernel
  145. * fails */
  146. #define BIO_CTRL_DGRAM_MTU_EXCEEDED 43 /* check whether the MTU
  147. * was exceed in the
  148. * previous write
  149. * operation */
  150. #define BIO_CTRL_DGRAM_GET_PEER 46
  151. #define BIO_CTRL_DGRAM_SET_PEER 44 /* Destination for the data */
  152. #define BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT 45 /* Next DTLS handshake timeout to
  153. * adjust socket timeouts */
  154. /* modifiers */
  155. #define BIO_FP_READ 0x02
  156. #define BIO_FP_WRITE 0x04
  157. #define BIO_FP_APPEND 0x08
  158. #define BIO_FP_TEXT 0x10
  159. #define BIO_FLAGS_READ 0x01
  160. #define BIO_FLAGS_WRITE 0x02
  161. #define BIO_FLAGS_IO_SPECIAL 0x04
  162. #define BIO_FLAGS_RWS (BIO_FLAGS_READ|BIO_FLAGS_WRITE|BIO_FLAGS_IO_SPECIAL)
  163. #define BIO_FLAGS_SHOULD_RETRY 0x08
  164. /* Used in BIO_gethostbyname() */
  165. #define BIO_GHBN_CTRL_HITS 1
  166. #define BIO_GHBN_CTRL_MISSES 2
  167. #define BIO_GHBN_CTRL_CACHE_SIZE 3
  168. #define BIO_GHBN_CTRL_GET_ENTRY 4
  169. #define BIO_GHBN_CTRL_FLUSH 5
  170. /* Mostly used in the SSL BIO */
  171. /* Not used anymore
  172. * #define BIO_FLAGS_PROTOCOL_DELAYED_READ 0x10
  173. * #define BIO_FLAGS_PROTOCOL_DELAYED_WRITE 0x20
  174. * #define BIO_FLAGS_PROTOCOL_STARTUP 0x40
  175. */
  176. #define BIO_FLAGS_BASE64_NO_NL 0x100
  177. /* This is used with memory BIOs: it means we shouldn't free up or change the
  178. * data in any way.
  179. */
  180. #define BIO_FLAGS_MEM_RDONLY 0x200
  181. void BIO_set_flags(BIO *b, int flags);
  182. int BIO_test_flags(const BIO *b, int flags);
  183. void BIO_clear_flags(BIO *b, int flags);
  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. /* These are normally used internally in BIOs */
  192. #define BIO_clear_retry_flags(b) \
  193. BIO_clear_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
  194. #define BIO_get_retry_flags(b) \
  195. BIO_test_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
  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. /* The next three are used in conjunction with the
  203. * BIO_should_io_special() condition. After this returns true,
  204. * BIO *BIO_get_retry_BIO(BIO *bio, int *reason); will walk the BIO
  205. * stack and return the 'reason' for the special and the offending BIO.
  206. * Given a BIO, BIO_get_retry_reason(bio) will return the code. */
  207. /* Returned from the SSL bio when the certificate retrieval code had an error */
  208. #define BIO_RR_SSL_X509_LOOKUP 0x01
  209. /* Returned from the connect BIO when a connect would have blocked */
  210. #define BIO_RR_CONNECT 0x02
  211. /* Returned from the accept BIO when an accept would have blocked */
  212. #define BIO_RR_ACCEPT 0x03
  213. /* These are passed by the BIO callback */
  214. #define BIO_CB_FREE 0x01
  215. #define BIO_CB_READ 0x02
  216. #define BIO_CB_WRITE 0x03
  217. #define BIO_CB_PUTS 0x04
  218. #define BIO_CB_GETS 0x05
  219. #define BIO_CB_CTRL 0x06
  220. /*
  221. * The callback is called before and after the underling operation,
  222. * the BIO_CB_RETURN flag indicates if it is after the call.
  223. */
  224. #define BIO_CB_RETURN 0x80
  225. #define BIO_CB_return(a) ((a)|BIO_CB_RETURN))
  226. #define BIO_cb_pre(a) (!((a)&BIO_CB_RETURN))
  227. #define BIO_cb_post(a) ((a)&BIO_CB_RETURN)
  228. typedef long (*BIO_callback_fn)(BIO *b, int oper, const char *argp, int argi,
  229. long argl, long ret);
  230. typedef long (*BIO_callback_fn_ex)(BIO *b, int oper, const char *argp,
  231. size_t len, int argi, long argl, int ret, size_t *processed);
  232. BIO_callback_fn BIO_get_callback(const BIO *b);
  233. void BIO_set_callback(BIO *b, BIO_callback_fn callback);
  234. BIO_callback_fn_ex BIO_get_callback_ex(const BIO *b);
  235. void BIO_set_callback_ex(BIO *b, BIO_callback_fn_ex callback);
  236. char *BIO_get_callback_arg(const BIO *b);
  237. void BIO_set_callback_arg(BIO *b, char *arg);
  238. const char *BIO_method_name(const BIO *b);
  239. int BIO_method_type(const BIO *b);
  240. typedef int BIO_info_cb(BIO *, int, int);
  241. /* Compatibility with OpenSSL's backward compatibility. */
  242. typedef BIO_info_cb bio_info_cb;
  243. typedef struct bio_method_st BIO_METHOD;
  244. DECLARE_STACK_OF(BIO)
  245. /* Prefix and suffix callback in ASN1 BIO */
  246. typedef int asn1_ps_func(BIO *b, unsigned char **pbuf, int *plen, void *parg);
  247. /* BIO_METHOD accessors */
  248. BIO_METHOD *BIO_meth_new(int type, const char *name);
  249. void BIO_meth_free(BIO_METHOD *biom);
  250. int (*BIO_meth_get_write(const BIO_METHOD *biom))(BIO *, const char *, int);
  251. int BIO_meth_set_write(BIO_METHOD *biom,
  252. int (*write)(BIO *, const char *, int));
  253. int (*BIO_meth_get_read(const BIO_METHOD *biom))(BIO *, char *, int);
  254. int BIO_meth_set_read(BIO_METHOD *biom, int (*read)(BIO *, char *, int));
  255. int (*BIO_meth_get_puts(const BIO_METHOD *biom))(BIO *, const char *);
  256. int BIO_meth_set_puts(BIO_METHOD *biom, int (*puts)(BIO *, const char *));
  257. int (*BIO_meth_get_gets(const BIO_METHOD *biom))(BIO *, char *, int);
  258. int BIO_meth_set_gets(BIO_METHOD *biom, int (*gets)(BIO *, char *, int));
  259. long (*BIO_meth_get_ctrl(const BIO_METHOD *biom))(BIO *, int, long, void *);
  260. int BIO_meth_set_ctrl(BIO_METHOD *biom, long (*ctrl)(BIO *, int, long, void *));
  261. int (*BIO_meth_get_create(const BIO_METHOD *biom))(BIO *);
  262. int BIO_meth_set_create(BIO_METHOD *biom, int (*create)(BIO *));
  263. int (*BIO_meth_get_destroy(const BIO_METHOD *biom))(BIO *);
  264. int BIO_meth_set_destroy(BIO_METHOD *biom, int (*destroy)(BIO *));
  265. long (*BIO_meth_get_callback_ctrl(const BIO_METHOD *biom))(BIO *, int, BIO_info_cb *);
  266. int BIO_meth_set_callback_ctrl(BIO_METHOD *biom,
  267. long (*callback_ctrl)(BIO *, int, BIO_info_cb *));
  268. /* connect BIO stuff */
  269. #define BIO_CONN_S_BEFORE 1
  270. #define BIO_CONN_S_GET_IP 2
  271. #define BIO_CONN_S_GET_PORT 3
  272. #define BIO_CONN_S_CREATE_SOCKET 4
  273. #define BIO_CONN_S_CONNECT 5
  274. #define BIO_CONN_S_OK 6
  275. #define BIO_CONN_S_BLOCKED_CONNECT 7
  276. #define BIO_CONN_S_NBIO 8
  277. /*#define BIO_CONN_get_param_hostname BIO_ctrl */
  278. #define BIO_C_SET_CONNECT 100
  279. #define BIO_C_DO_STATE_MACHINE 101
  280. #define BIO_C_SET_NBIO 102
  281. #define BIO_C_SET_PROXY_PARAM 103
  282. #define BIO_C_SET_FD 104
  283. #define BIO_C_GET_FD 105
  284. #define BIO_C_SET_FILE_PTR 106
  285. #define BIO_C_GET_FILE_PTR 107
  286. #define BIO_C_SET_FILENAME 108
  287. #define BIO_C_SET_SSL 109
  288. #define BIO_C_GET_SSL 110
  289. #define BIO_C_SET_MD 111
  290. #define BIO_C_GET_MD 112
  291. #define BIO_C_GET_CIPHER_STATUS 113
  292. #define BIO_C_SET_BUF_MEM 114
  293. #define BIO_C_GET_BUF_MEM_PTR 115
  294. #define BIO_C_GET_BUFF_NUM_LINES 116
  295. #define BIO_C_SET_BUFF_SIZE 117
  296. #define BIO_C_SET_ACCEPT 118
  297. #define BIO_C_SSL_MODE 119
  298. #define BIO_C_GET_MD_CTX 120
  299. #define BIO_C_GET_PROXY_PARAM 121
  300. #define BIO_C_SET_BUFF_READ_DATA 122 /* data to read first */
  301. #define BIO_C_GET_CONNECT 123
  302. #define BIO_C_GET_ACCEPT 124
  303. #define BIO_C_SET_SSL_RENEGOTIATE_BYTES 125
  304. #define BIO_C_GET_SSL_NUM_RENEGOTIATES 126
  305. #define BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT 127
  306. #define BIO_C_FILE_SEEK 128
  307. #define BIO_C_GET_CIPHER_CTX 129
  308. #define BIO_C_SET_BUF_MEM_EOF_RETURN 130/*return end of input value*/
  309. #define BIO_C_SET_BIND_MODE 131
  310. #define BIO_C_GET_BIND_MODE 132
  311. #define BIO_C_FILE_TELL 133
  312. #define BIO_C_GET_SOCKS 134
  313. #define BIO_C_SET_SOCKS 135
  314. #define BIO_C_SET_WRITE_BUF_SIZE 136/* for BIO_s_bio */
  315. #define BIO_C_GET_WRITE_BUF_SIZE 137
  316. #define BIO_C_MAKE_BIO_PAIR 138
  317. #define BIO_C_DESTROY_BIO_PAIR 139
  318. #define BIO_C_GET_WRITE_GUARANTEE 140
  319. #define BIO_C_GET_READ_REQUEST 141
  320. #define BIO_C_SHUTDOWN_WR 142
  321. #define BIO_C_NREAD0 143
  322. #define BIO_C_NREAD 144
  323. #define BIO_C_NWRITE0 145
  324. #define BIO_C_NWRITE 146
  325. #define BIO_C_RESET_READ_REQUEST 147
  326. #define BIO_C_SET_MD_CTX 148
  327. #define BIO_C_SET_EX_ARG 153
  328. #define BIO_C_GET_EX_ARG 154
  329. #define BIO_set_app_data(s,arg) BIO_set_ex_data(s,0,arg)
  330. #define BIO_get_app_data(s) BIO_get_ex_data(s,0)
  331. /* BIO_s_connect() and BIO_s_socks4a_connect() */
  332. #define BIO_set_conn_hostname(b,name) BIO_ctrl(b,BIO_C_SET_CONNECT,0,(char *)name)
  333. #define BIO_set_conn_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,1,(char *)port)
  334. #define BIO_set_conn_ip(b,ip) BIO_ctrl(b,BIO_C_SET_CONNECT,2,(char *)ip)
  335. #define BIO_set_conn_int_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,3,(char *)port)
  336. #define BIO_get_conn_hostname(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,0)
  337. #define BIO_get_conn_port(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,1)
  338. #define BIO_get_conn_ip(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,2)
  339. #define BIO_get_conn_int_port(b) BIO_int_ctrl(b,BIO_C_GET_CONNECT,3,0)
  340. #define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL)
  341. /* BIO_s_accept_socket() */
  342. #define BIO_set_accept_port(b,name) BIO_ctrl(b,BIO_C_SET_ACCEPT,0,(char *)name)
  343. #define BIO_get_accept_port(b) BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,0)
  344. /* #define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL) */
  345. #define BIO_set_nbio_accept(b,n) BIO_ctrl(b,BIO_C_SET_ACCEPT,1,(n)?(void *)"a":NULL)
  346. #define BIO_set_accept_bios(b,bio) BIO_ctrl(b,BIO_C_SET_ACCEPT,2,(char *)bio)
  347. #define BIO_BIND_NORMAL 0
  348. #define BIO_BIND_REUSEADDR_IF_UNUSED 1
  349. #define BIO_BIND_REUSEADDR 2
  350. #define BIO_set_bind_mode(b,mode) BIO_ctrl(b,BIO_C_SET_BIND_MODE,mode,NULL)
  351. #define BIO_get_bind_mode(b,mode) BIO_ctrl(b,BIO_C_GET_BIND_MODE,0,NULL)
  352. #define BIO_do_connect(b) BIO_do_handshake(b)
  353. #define BIO_do_accept(b) BIO_do_handshake(b)
  354. #define BIO_do_handshake(b) BIO_ctrl(b,BIO_C_DO_STATE_MACHINE,0,NULL)
  355. /* BIO_s_proxy_client() */
  356. #define BIO_set_url(b,url) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,0,(char *)(url))
  357. #define BIO_set_proxies(b,p) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,1,(char *)(p))
  358. /* BIO_set_nbio(b,n) */
  359. #define BIO_set_filter_bio(b,s) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,2,(char *)(s))
  360. /* BIO *BIO_get_filter_bio(BIO *bio); */
  361. #define BIO_set_proxy_cb(b,cb) BIO_callback_ctrl(b,BIO_C_SET_PROXY_PARAM,3,(void *(*cb)()))
  362. #define BIO_set_proxy_header(b,sk) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,4,(char *)sk)
  363. #define BIO_set_no_connect_return(b,bool) BIO_int_ctrl(b,BIO_C_SET_PROXY_PARAM,5,bool)
  364. #define BIO_get_proxy_header(b,skp) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,0,(char *)skp)
  365. #define BIO_get_proxies(b,pxy_p) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,1,(char *)(pxy_p))
  366. #define BIO_get_url(b,url) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,2,(char *)(url))
  367. #define BIO_get_no_connect_return(b) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,5,NULL)
  368. #define BIO_set_fd(b,fd,c) BIO_int_ctrl(b,BIO_C_SET_FD,c,fd)
  369. #define BIO_get_fd(b,c) BIO_ctrl(b,BIO_C_GET_FD,0,(char *)c)
  370. #define BIO_set_fp(b,fp,c) BIO_ctrl(b,BIO_C_SET_FILE_PTR,c,(char *)fp)
  371. #define BIO_get_fp(b,fpp) BIO_ctrl(b,BIO_C_GET_FILE_PTR,0,(char *)fpp)
  372. #define BIO_seek(b,ofs) (int)BIO_ctrl(b,BIO_C_FILE_SEEK,ofs,NULL)
  373. #define BIO_tell(b) (int)BIO_ctrl(b,BIO_C_FILE_TELL,0,NULL)
  374. /* name is cast to lose const, but might be better to route through a function
  375. so we can do it safely */
  376. #define BIO_read_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
  377. BIO_CLOSE|BIO_FP_READ,(char *)name)
  378. #define BIO_write_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
  379. BIO_CLOSE|BIO_FP_WRITE,name)
  380. #define BIO_append_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
  381. BIO_CLOSE|BIO_FP_APPEND,name)
  382. #define BIO_rw_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
  383. BIO_CLOSE|BIO_FP_READ|BIO_FP_WRITE,name)
  384. /* WARNING WARNING, this ups the reference count on the read bio of the
  385. * SSL structure. This is because the ssl read BIO is now pointed to by
  386. * the next_bio field in the bio. So when you free the BIO, make sure
  387. * you are doing a BIO_free_all() to catch the underlying BIO. */
  388. #define BIO_set_ssl(b,ssl,c) BIO_ctrl(b,BIO_C_SET_SSL,c,(char *)ssl)
  389. #define BIO_get_ssl(b,sslp) BIO_ctrl(b,BIO_C_GET_SSL,0,(char *)sslp)
  390. #define BIO_set_ssl_mode(b,client) BIO_ctrl(b,BIO_C_SSL_MODE,client,NULL)
  391. #define BIO_set_ssl_renegotiate_bytes(b,num) \
  392. BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_BYTES,num,NULL)
  393. #define BIO_get_num_renegotiates(b) \
  394. BIO_ctrl(b,BIO_C_GET_SSL_NUM_RENEGOTIATES,0,NULL)
  395. #define BIO_set_ssl_renegotiate_timeout(b,seconds) \
  396. BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT,seconds,NULL)
  397. /* defined in evp.h */
  398. /* #define BIO_set_md(b,md) BIO_ctrl(b,BIO_C_SET_MD,1,(char *)md) */
  399. #define BIO_get_mem_data(b,pp) BIO_ctrl(b,BIO_CTRL_INFO,0,(char *)pp)
  400. #define BIO_set_mem_buf(b,bm,c) BIO_ctrl(b,BIO_C_SET_BUF_MEM,c,(char *)bm)
  401. #define BIO_get_mem_ptr(b,pp) BIO_ctrl(b,BIO_C_GET_BUF_MEM_PTR,0,(char *)pp)
  402. #define BIO_set_mem_eof_return(b,v) \
  403. BIO_ctrl(b,BIO_C_SET_BUF_MEM_EOF_RETURN,v,NULL)
  404. /* For the BIO_f_buffer() type */
  405. #define BIO_get_buffer_num_lines(b) BIO_ctrl(b,BIO_C_GET_BUFF_NUM_LINES,0,NULL)
  406. #define BIO_set_buffer_size(b,size) BIO_ctrl(b,BIO_C_SET_BUFF_SIZE,size,NULL)
  407. #define BIO_set_read_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,0)
  408. #define BIO_set_write_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,1)
  409. #define BIO_set_buffer_read_data(b,buf,num) BIO_ctrl(b,BIO_C_SET_BUFF_READ_DATA,num,buf)
  410. /* Don't use the next one unless you know what you are doing :-) */
  411. #define BIO_dup_state(b,ret) BIO_ctrl(b,BIO_CTRL_DUP,0,(char *)(ret))
  412. #define BIO_reset(b) (int)BIO_ctrl(b,BIO_CTRL_RESET,0,NULL)
  413. #define BIO_eof(b) (int)BIO_ctrl(b,BIO_CTRL_EOF,0,NULL)
  414. #define BIO_set_close(b,c) (int)BIO_ctrl(b,BIO_CTRL_SET_CLOSE,(c),NULL)
  415. #define BIO_get_close(b) (int)BIO_ctrl(b,BIO_CTRL_GET_CLOSE,0,NULL)
  416. #define BIO_pending(b) (int)BIO_ctrl(b,BIO_CTRL_PENDING,0,NULL)
  417. #define BIO_wpending(b) (int)BIO_ctrl(b,BIO_CTRL_WPENDING,0,NULL)
  418. /* ...pending macros have inappropriate return type */
  419. size_t BIO_ctrl_pending(BIO *b);
  420. size_t BIO_ctrl_wpending(BIO *b);
  421. #define BIO_flush(b) (int)BIO_ctrl(b,BIO_CTRL_FLUSH,0,NULL)
  422. #define BIO_get_info_callback(b,cbp) (int)BIO_ctrl(b,BIO_CTRL_GET_CALLBACK,0, \
  423. cbp)
  424. #define BIO_set_info_callback(b,cb) (int)BIO_callback_ctrl(b,BIO_CTRL_SET_CALLBACK,cb)
  425. /* For the BIO_f_buffer() type */
  426. #define BIO_buffer_get_num_lines(b) BIO_ctrl(b,BIO_CTRL_GET,0,NULL)
  427. /* For BIO_s_bio() */
  428. #define BIO_set_write_buf_size(b,size) (int)BIO_ctrl(b,BIO_C_SET_WRITE_BUF_SIZE,size,NULL)
  429. #define BIO_get_write_buf_size(b,size) (size_t)BIO_ctrl(b,BIO_C_GET_WRITE_BUF_SIZE,size,NULL)
  430. #define BIO_make_bio_pair(b1,b2) (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2)
  431. #define BIO_destroy_bio_pair(b) (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL)
  432. #define BIO_shutdown_wr(b) (int)BIO_ctrl(b, BIO_C_SHUTDOWN_WR, 0, NULL)
  433. /* macros with inappropriate type -- but ...pending macros use int too: */
  434. #define BIO_get_write_guarantee(b) (int)BIO_ctrl(b,BIO_C_GET_WRITE_GUARANTEE,0,NULL)
  435. #define BIO_get_read_request(b) (int)BIO_ctrl(b,BIO_C_GET_READ_REQUEST,0,NULL)
  436. size_t BIO_ctrl_get_write_guarantee(BIO *b);
  437. size_t BIO_ctrl_get_read_request(BIO *b);
  438. int BIO_ctrl_reset_read_request(BIO *b);
  439. /* ctrl macros for dgram */
  440. #define BIO_ctrl_dgram_connect(b,peer) \
  441. (int)BIO_ctrl(b,BIO_CTRL_DGRAM_CONNECT,0, (char *)peer)
  442. #define BIO_ctrl_set_connected(b, state, peer) \
  443. (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_CONNECTED, state, (char *)peer)
  444. #define BIO_dgram_recv_timedout(b) \
  445. (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP, 0, NULL)
  446. #define BIO_dgram_send_timedout(b) \
  447. (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP, 0, NULL)
  448. #define BIO_dgram_get_peer(b,peer) \
  449. (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_PEER, 0, (char *)peer)
  450. #define BIO_dgram_set_peer(b,peer) \
  451. (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_PEER, 0, (char *)peer)
  452. /* These two aren't currently implemented */
  453. /* int BIO_get_ex_num(BIO *bio); */
  454. /* void BIO_set_ex_free_func(BIO *bio,int idx,void (*cb)()); */
  455. int BIO_set_ex_data(BIO *bio, int idx, void *data);
  456. void *BIO_get_ex_data(BIO *bio, int idx);
  457. int BIO_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
  458. CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
  459. unsigned long BIO_number_read(BIO *bio);
  460. unsigned long BIO_number_written(BIO *bio);
  461. int BIO_get_new_index(void);
  462. const BIO_METHOD *BIO_s_file(void);
  463. BIO *BIO_new_file(const char *filename, const char *mode);
  464. BIO *BIO_new_fp(FILE *stream, int close_flag);
  465. BIO *BIO_new(const BIO_METHOD *type);
  466. int BIO_free(BIO *a);
  467. int BIO_up_ref(BIO *bio);
  468. void *BIO_get_data(BIO *a);
  469. void BIO_set_data(BIO *a, void *ptr);
  470. int BIO_get_init(BIO *a);
  471. void BIO_set_init(BIO *a, int init);
  472. int BIO_get_shutdown(BIO *a);
  473. void BIO_set_shutdown(BIO *a, int shut);
  474. void BIO_vfree(BIO *a);
  475. int BIO_read(BIO *b, void *data, int len)
  476. __attribute__((__bounded__(__buffer__,2,3)));
  477. int BIO_gets(BIO *bp, char *buf, int size)
  478. __attribute__((__bounded__ (__string__,2,3)));
  479. int BIO_write(BIO *b, const void *data, int len)
  480. __attribute__((__bounded__(__buffer__,2,3)));
  481. int BIO_puts(BIO *bp, const char *buf);
  482. int BIO_indent(BIO *b, int indent, int max);
  483. long BIO_ctrl(BIO *bp, int cmd, long larg, void *parg);
  484. long BIO_callback_ctrl(BIO *b, int cmd, BIO_info_cb *fp);
  485. char * BIO_ptr_ctrl(BIO *bp, int cmd, long larg);
  486. long BIO_int_ctrl(BIO *bp, int cmd, long larg, int iarg);
  487. BIO * BIO_push(BIO *b, BIO *append);
  488. BIO * BIO_pop(BIO *b);
  489. void BIO_free_all(BIO *a);
  490. BIO * BIO_find_type(BIO *b, int bio_type);
  491. BIO * BIO_next(BIO *b);
  492. void BIO_set_next(BIO *b, BIO *next);
  493. BIO * BIO_get_retry_BIO(BIO *bio, int *reason);
  494. int BIO_get_retry_reason(BIO *bio);
  495. void BIO_set_retry_reason(BIO *bio, int reason);
  496. BIO * BIO_dup_chain(BIO *in);
  497. int BIO_nread0(BIO *bio, char **buf);
  498. int BIO_nread(BIO *bio, char **buf, int num);
  499. int BIO_nwrite0(BIO *bio, char **buf);
  500. int BIO_nwrite(BIO *bio, char **buf, int num);
  501. long BIO_debug_callback(BIO *bio, int cmd, const char *argp, int argi,
  502. long argl, long ret);
  503. const BIO_METHOD *BIO_s_mem(void);
  504. BIO *BIO_new_mem_buf(const void *buf, int len);
  505. const BIO_METHOD *BIO_s_socket(void);
  506. const BIO_METHOD *BIO_s_connect(void);
  507. const BIO_METHOD *BIO_s_accept(void);
  508. const BIO_METHOD *BIO_s_fd(void);
  509. const BIO_METHOD *BIO_s_log(void);
  510. const BIO_METHOD *BIO_s_bio(void);
  511. const BIO_METHOD *BIO_s_null(void);
  512. const BIO_METHOD *BIO_f_null(void);
  513. const BIO_METHOD *BIO_f_buffer(void);
  514. const BIO_METHOD *BIO_f_nbio_test(void);
  515. #ifndef OPENSSL_NO_DGRAM
  516. const BIO_METHOD *BIO_s_datagram(void);
  517. #endif
  518. /* BIO_METHOD *BIO_f_ber(void); */
  519. int BIO_sock_should_retry(int i);
  520. int BIO_sock_non_fatal_error(int _error);
  521. int BIO_dgram_non_fatal_error(int _error);
  522. int BIO_fd_should_retry(int i);
  523. int BIO_fd_non_fatal_error(int _error);
  524. int BIO_dump(BIO *b, const char *bytes, int len);
  525. int BIO_dump_indent(BIO *b, const char *bytes, int len, int indent);
  526. struct hostent *BIO_gethostbyname(const char *name);
  527. /* We might want a thread-safe interface too:
  528. * struct hostent *BIO_gethostbyname_r(const char *name,
  529. * struct hostent *result, void *buffer, size_t buflen);
  530. * or something similar (caller allocates a struct hostent,
  531. * pointed to by "result", and additional buffer space for the various
  532. * substructures; if the buffer does not suffice, NULL is returned
  533. * and an appropriate error code is set).
  534. */
  535. int BIO_sock_error(int sock);
  536. int BIO_socket_ioctl(int fd, long type, void *arg);
  537. int BIO_socket_nbio(int fd, int mode);
  538. int BIO_get_port(const char *str, unsigned short *port_ptr);
  539. int BIO_get_host_ip(const char *str, unsigned char *ip);
  540. int BIO_get_accept_socket(char *host_port, int mode);
  541. int BIO_accept(int sock, char **ip_port);
  542. int BIO_sock_init(void );
  543. void BIO_sock_cleanup(void);
  544. int BIO_set_tcp_ndelay(int sock, int turn_on);
  545. BIO *BIO_new_socket(int sock, int close_flag);
  546. BIO *BIO_new_dgram(int fd, int close_flag);
  547. BIO *BIO_new_fd(int fd, int close_flag);
  548. BIO *BIO_new_connect(const char *host_port);
  549. BIO *BIO_new_accept(const char *host_port);
  550. int BIO_new_bio_pair(BIO **bio1, size_t writebuf1,
  551. BIO **bio2, size_t writebuf2);
  552. /* If successful, returns 1 and in *bio1, *bio2 two BIO pair endpoints.
  553. * Otherwise returns 0 and sets *bio1 and *bio2 to NULL.
  554. * Size 0 uses default value.
  555. */
  556. void BIO_copy_next_retry(BIO *b);
  557. /*long BIO_ghbn_ctrl(int cmd,int iarg,char *parg);*/
  558. /* Needed for libressl-portable. */
  559. #ifndef __MINGW_PRINTF_FORMAT
  560. int BIO_printf(BIO *bio, const char *format, ...)
  561. __attribute__((__format__(__printf__, 2, 3), __nonnull__(2)));
  562. #else
  563. int BIO_printf(BIO *bio, const char *format, ...)
  564. __attribute__((__format__(__MINGW_PRINTF_FORMAT, 2, 3), __nonnull__(2)));
  565. #endif
  566. void ERR_load_BIO_strings(void);
  567. /* Error codes for the BIO functions. */
  568. /* Function codes. */
  569. #define BIO_F_ACPT_STATE 100
  570. #define BIO_F_BIO_ACCEPT 101
  571. #define BIO_F_BIO_BER_GET_HEADER 102
  572. #define BIO_F_BIO_CALLBACK_CTRL 131
  573. #define BIO_F_BIO_CTRL 103
  574. #define BIO_F_BIO_GETHOSTBYNAME 120
  575. #define BIO_F_BIO_GETS 104
  576. #define BIO_F_BIO_GET_ACCEPT_SOCKET 105
  577. #define BIO_F_BIO_GET_HOST_IP 106
  578. #define BIO_F_BIO_GET_PORT 107
  579. #define BIO_F_BIO_MAKE_PAIR 121
  580. #define BIO_F_BIO_NEW 108
  581. #define BIO_F_BIO_NEW_FILE 109
  582. #define BIO_F_BIO_NEW_MEM_BUF 126
  583. #define BIO_F_BIO_NREAD 123
  584. #define BIO_F_BIO_NREAD0 124
  585. #define BIO_F_BIO_NWRITE 125
  586. #define BIO_F_BIO_NWRITE0 122
  587. #define BIO_F_BIO_PUTS 110
  588. #define BIO_F_BIO_READ 111
  589. #define BIO_F_BIO_SOCK_INIT 112
  590. #define BIO_F_BIO_WRITE 113
  591. #define BIO_F_BUFFER_CTRL 114
  592. #define BIO_F_CONN_CTRL 127
  593. #define BIO_F_CONN_STATE 115
  594. #define BIO_F_DGRAM_SCTP_READ 132
  595. #define BIO_F_FILE_CTRL 116
  596. #define BIO_F_FILE_READ 130
  597. #define BIO_F_LINEBUFFER_CTRL 129
  598. #define BIO_F_MEM_READ 128
  599. #define BIO_F_MEM_WRITE 117
  600. #define BIO_F_SSL_NEW 118
  601. #define BIO_F_WSASTARTUP 119
  602. /* Reason codes. */
  603. #define BIO_R_ACCEPT_ERROR 100
  604. #define BIO_R_BAD_FOPEN_MODE 101
  605. #define BIO_R_BAD_HOSTNAME_LOOKUP 102
  606. #define BIO_R_BROKEN_PIPE 124
  607. #define BIO_R_CONNECT_ERROR 103
  608. #define BIO_R_EOF_ON_MEMORY_BIO 127
  609. #define BIO_R_ERROR_SETTING_NBIO 104
  610. #define BIO_R_ERROR_SETTING_NBIO_ON_ACCEPTED_SOCKET 105
  611. #define BIO_R_ERROR_SETTING_NBIO_ON_ACCEPT_SOCKET 106
  612. #define BIO_R_GETHOSTBYNAME_ADDR_IS_NOT_AF_INET 107
  613. #define BIO_R_INVALID_ARGUMENT 125
  614. #define BIO_R_INVALID_IP_ADDRESS 108
  615. #define BIO_R_INVALID_PORT_NUMBER 129
  616. #define BIO_R_IN_USE 123
  617. #define BIO_R_KEEPALIVE 109
  618. #define BIO_R_LENGTH_TOO_LONG 130
  619. #define BIO_R_NBIO_CONNECT_ERROR 110
  620. #define BIO_R_NO_ACCEPT_PORT_SPECIFIED 111
  621. #define BIO_R_NO_HOSTNAME_SPECIFIED 112
  622. #define BIO_R_NO_PORT_DEFINED 113
  623. #define BIO_R_NO_PORT_SPECIFIED 114
  624. #define BIO_R_NO_SUCH_FILE 128
  625. #define BIO_R_NULL_PARAMETER 115
  626. #define BIO_R_TAG_MISMATCH 116
  627. #define BIO_R_UNABLE_TO_BIND_SOCKET 117
  628. #define BIO_R_UNABLE_TO_CREATE_SOCKET 118
  629. #define BIO_R_UNABLE_TO_LISTEN_SOCKET 119
  630. #define BIO_R_UNINITIALIZED 120
  631. #define BIO_R_UNSUPPORTED_METHOD 121
  632. #define BIO_R_WRITE_TO_READ_ONLY_BIO 126
  633. #define BIO_R_WSASTARTUP 122
  634. #ifdef __cplusplus
  635. }
  636. #endif
  637. #endif