bio.h 40 KB

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