]>
Commit | Line | Data |
---|---|---|
b1322259 | 1 | /* |
4333b89f | 2 | * Copyright 1995-2021 The OpenSSL Project Authors. All Rights Reserved. |
d02b48c6 | 3 | * |
09abbca1 | 4 | * Licensed under the Apache License 2.0 (the "License"). You may not use |
b1322259 RS |
5 | * this file except in compliance with the License. You can obtain a copy |
6 | * in the file LICENSE in the source distribution or at | |
7 | * https://www.openssl.org/source/license.html | |
d02b48c6 RE |
8 | */ |
9 | ||
0800318a TM |
10 | #define OPENSSL_SUPPRESS_DEPRECATED |
11 | ||
d02b48c6 RE |
12 | #include <stdio.h> |
13 | #include <errno.h> | |
ec577822 | 14 | #include <openssl/crypto.h> |
706457b7 | 15 | #include "bio_local.h" |
58964a49 | 16 | |
98e553d2 MC |
17 | /* |
18 | * Helper macro for the callback to determine whether an operator expects a | |
19 | * len parameter or not | |
20 | */ | |
dc88a039 DDO |
21 | #define HAS_LEN_OPER(o) ((o) == BIO_CB_READ || (o) == BIO_CB_WRITE \ |
22 | || (o) == BIO_CB_GETS) | |
98e553d2 | 23 | |
0800318a TM |
24 | #ifndef OPENSSL_NO_DEPRECATED_3_0 |
25 | # define HAS_CALLBACK(b) ((b)->callback != NULL || (b)->callback_ex != NULL) | |
26 | #else | |
27 | # define HAS_CALLBACK(b) ((b)->callback_ex != NULL) | |
28 | #endif | |
98e553d2 MC |
29 | /* |
30 | * Helper function to work out whether to call the new style callback or the old | |
31 | * one, and translate between the two. | |
32 | * | |
33 | * This has a long return type for consistency with the old callback. Similarly | |
34 | * for the "long" used for "inret" | |
35 | */ | |
36 | static long bio_call_callback(BIO *b, int oper, const char *argp, size_t len, | |
dc88a039 DDO |
37 | int argi, long argl, long inret, |
38 | size_t *processed) | |
98e553d2 | 39 | { |
0800318a TM |
40 | long ret = inret; |
41 | #ifndef OPENSSL_NO_DEPRECATED_3_0 | |
98e553d2 MC |
42 | int bareoper; |
43 | ||
c911e5da | 44 | if (b->callback_ex != NULL) |
0800318a | 45 | #endif |
98e553d2 | 46 | return b->callback_ex(b, oper, argp, len, argi, argl, inret, processed); |
98e553d2 | 47 | |
0800318a | 48 | #ifndef OPENSSL_NO_DEPRECATED_3_0 |
98e553d2 MC |
49 | /* Strip off any BIO_CB_RETURN flag */ |
50 | bareoper = oper & ~BIO_CB_RETURN; | |
51 | ||
52 | /* | |
53 | * We have an old style callback, so we will have to do nasty casts and | |
54 | * check for overflows. | |
55 | */ | |
56 | if (HAS_LEN_OPER(bareoper)) { | |
57 | /* In this case |len| is set, and should be used instead of |argi| */ | |
58 | if (len > INT_MAX) | |
59 | return -1; | |
60 | ||
61 | argi = (int)len; | |
c911e5da | 62 | } |
98e553d2 | 63 | |
d97ce8d9 | 64 | if (inret > 0 && (oper & BIO_CB_RETURN) && bareoper != BIO_CB_CTRL) { |
c911e5da BE |
65 | if (*processed > INT_MAX) |
66 | return -1; | |
67 | inret = *processed; | |
98e553d2 MC |
68 | } |
69 | ||
70 | ret = b->callback(b, oper, argp, argi, argl, inret); | |
71 | ||
d97ce8d9 | 72 | if (ret > 0 && (oper & BIO_CB_RETURN) && bareoper != BIO_CB_CTRL) { |
98e553d2 MC |
73 | *processed = (size_t)ret; |
74 | ret = 1; | |
75 | } | |
0800318a | 76 | #endif |
98e553d2 MC |
77 | return ret; |
78 | } | |
79 | ||
b0ee1de9 | 80 | BIO *BIO_new_ex(OSSL_LIB_CTX *libctx, const BIO_METHOD *method) |
0f113f3e | 81 | { |
9d7bfb14 | 82 | BIO *bio = OPENSSL_zalloc(sizeof(*bio)); |
0f113f3e | 83 | |
9d7bfb14 | 84 | if (bio == NULL) { |
9311d0c4 | 85 | ERR_raise(ERR_LIB_BIO, ERR_R_MALLOC_FAILURE); |
26a7d938 | 86 | return NULL; |
0f113f3e | 87 | } |
d02b48c6 | 88 | |
b0ee1de9 | 89 | bio->libctx = libctx; |
0f113f3e | 90 | bio->method = method; |
0f113f3e | 91 | bio->shutdown = 1; |
0f113f3e | 92 | bio->references = 1; |
9d7bfb14 | 93 | |
25a807bc | 94 | if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_BIO, bio, &bio->ex_data)) |
9d7bfb14 | 95 | goto err; |
fb46be03 AG |
96 | |
97 | bio->lock = CRYPTO_THREAD_lock_new(); | |
98 | if (bio->lock == NULL) { | |
9311d0c4 | 99 | ERR_raise(ERR_LIB_BIO, ERR_R_MALLOC_FAILURE); |
fb46be03 | 100 | CRYPTO_free_ex_data(CRYPTO_EX_INDEX_BIO, bio, &bio->ex_data); |
9d7bfb14 | 101 | goto err; |
fb46be03 AG |
102 | } |
103 | ||
9d7bfb14 | 104 | if (method->create != NULL && !method->create(bio)) { |
9311d0c4 | 105 | ERR_raise(ERR_LIB_BIO, ERR_R_INIT_FAIL); |
9d7bfb14 F |
106 | CRYPTO_free_ex_data(CRYPTO_EX_INDEX_BIO, bio, &bio->ex_data); |
107 | CRYPTO_THREAD_lock_free(bio->lock); | |
108 | goto err; | |
fb46be03 | 109 | } |
7f55808f RL |
110 | if (method->create == NULL) |
111 | bio->init = 1; | |
fb46be03 | 112 | |
9d7bfb14 F |
113 | return bio; |
114 | ||
115 | err: | |
116 | OPENSSL_free(bio); | |
117 | return NULL; | |
0f113f3e | 118 | } |
d02b48c6 | 119 | |
b0ee1de9 MC |
120 | BIO *BIO_new(const BIO_METHOD *method) |
121 | { | |
122 | return BIO_new_ex(NULL, method); | |
123 | } | |
124 | ||
6b691a5c | 125 | int BIO_free(BIO *a) |
0f113f3e | 126 | { |
98e553d2 | 127 | int ret; |
d02b48c6 | 128 | |
0f113f3e | 129 | if (a == NULL) |
fb46be03 AG |
130 | return 0; |
131 | ||
2f545ae4 | 132 | if (CRYPTO_DOWN_REF(&a->references, &ret, a->lock) <= 0) |
fb46be03 | 133 | return 0; |
d02b48c6 | 134 | |
f3f1cf84 | 135 | REF_PRINT_COUNT("BIO", a); |
98e553d2 | 136 | if (ret > 0) |
fb46be03 | 137 | return 1; |
98e553d2 MC |
138 | REF_ASSERT_ISNT(ret < 0); |
139 | ||
0800318a | 140 | if (HAS_CALLBACK(a)) { |
98e553d2 MC |
141 | ret = (int)bio_call_callback(a, BIO_CB_FREE, NULL, 0, 0, 0L, 1L, NULL); |
142 | if (ret <= 0) | |
143 | return ret; | |
144 | } | |
d02b48c6 | 145 | |
a14a740d F |
146 | if ((a->method != NULL) && (a->method->destroy != NULL)) |
147 | a->method->destroy(a); | |
148 | ||
0f113f3e | 149 | CRYPTO_free_ex_data(CRYPTO_EX_INDEX_BIO, a, &a->ex_data); |
58964a49 | 150 | |
fb46be03 AG |
151 | CRYPTO_THREAD_lock_free(a->lock); |
152 | ||
0f113f3e | 153 | OPENSSL_free(a); |
fb46be03 AG |
154 | |
155 | return 1; | |
0f113f3e | 156 | } |
d02b48c6 | 157 | |
a146ae55 MC |
158 | void BIO_set_data(BIO *a, void *ptr) |
159 | { | |
160 | a->ptr = ptr; | |
161 | } | |
162 | ||
163 | void *BIO_get_data(BIO *a) | |
164 | { | |
165 | return a->ptr; | |
166 | } | |
167 | ||
168 | void BIO_set_init(BIO *a, int init) | |
169 | { | |
170 | a->init = init; | |
171 | } | |
172 | ||
173 | int BIO_get_init(BIO *a) | |
174 | { | |
175 | return a->init; | |
176 | } | |
177 | ||
178 | void BIO_set_shutdown(BIO *a, int shut) | |
179 | { | |
180 | a->shutdown = shut; | |
181 | } | |
182 | ||
183 | int BIO_get_shutdown(BIO *a) | |
184 | { | |
185 | return a->shutdown; | |
186 | } | |
187 | ||
371acb22 | 188 | void BIO_vfree(BIO *a) |
0f113f3e MC |
189 | { |
190 | BIO_free(a); | |
191 | } | |
371acb22 | 192 | |
fb46be03 AG |
193 | int BIO_up_ref(BIO *a) |
194 | { | |
195 | int i; | |
196 | ||
2f545ae4 | 197 | if (CRYPTO_UP_REF(&a->references, &i, a->lock) <= 0) |
fb46be03 AG |
198 | return 0; |
199 | ||
200 | REF_PRINT_COUNT("BIO", a); | |
201 | REF_ASSERT_ISNT(i < 2); | |
dc88a039 | 202 | return i > 1; |
fb46be03 AG |
203 | } |
204 | ||
7806f3dd | 205 | void BIO_clear_flags(BIO *b, int flags) |
0f113f3e MC |
206 | { |
207 | b->flags &= ~flags; | |
208 | } | |
209 | ||
210 | int BIO_test_flags(const BIO *b, int flags) | |
211 | { | |
212 | return (b->flags & flags); | |
213 | } | |
214 | ||
215 | void BIO_set_flags(BIO *b, int flags) | |
216 | { | |
217 | b->flags |= flags; | |
218 | } | |
219 | ||
0800318a | 220 | #ifndef OPENSSL_NO_DEPRECATED_3_0 |
d07aee2c MC |
221 | BIO_callback_fn BIO_get_callback(const BIO *b) |
222 | { | |
0f113f3e MC |
223 | return b->callback; |
224 | } | |
225 | ||
d07aee2c | 226 | void BIO_set_callback(BIO *b, BIO_callback_fn cb) |
0f113f3e MC |
227 | { |
228 | b->callback = cb; | |
229 | } | |
0800318a | 230 | #endif |
7806f3dd | 231 | |
d07aee2c MC |
232 | BIO_callback_fn_ex BIO_get_callback_ex(const BIO *b) |
233 | { | |
234 | return b->callback_ex; | |
235 | } | |
236 | ||
237 | void BIO_set_callback_ex(BIO *b, BIO_callback_fn_ex cb) | |
238 | { | |
239 | b->callback_ex = cb; | |
240 | } | |
241 | ||
7806f3dd | 242 | void BIO_set_callback_arg(BIO *b, char *arg) |
0f113f3e MC |
243 | { |
244 | b->cb_arg = arg; | |
245 | } | |
7806f3dd | 246 | |
0f113f3e MC |
247 | char *BIO_get_callback_arg(const BIO *b) |
248 | { | |
249 | return b->cb_arg; | |
250 | } | |
7806f3dd | 251 | |
0f113f3e MC |
252 | const char *BIO_method_name(const BIO *b) |
253 | { | |
254 | return b->method->name; | |
255 | } | |
7806f3dd NL |
256 | |
257 | int BIO_method_type(const BIO *b) | |
0f113f3e MC |
258 | { |
259 | return b->method->type; | |
260 | } | |
7806f3dd | 261 | |
bb5310be MC |
262 | /* |
263 | * This is essentially the same as BIO_read_ex() except that it allows | |
7bf79e33 MC |
264 | * 0 or a negative value to indicate failure (retryable or not) in the return. |
265 | * This is for compatibility with the old style BIO_read(), where existing code | |
266 | * may make assumptions about the return value that it might get. | |
bb5310be | 267 | */ |
d62bf89c | 268 | static int bio_read_intern(BIO *b, void *data, size_t dlen, size_t *readbytes) |
d07aee2c MC |
269 | { |
270 | int ret; | |
d02b48c6 | 271 | |
dc88a039 | 272 | if (b == NULL) { |
ed4a9b15 | 273 | ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER); |
dc88a039 DDO |
274 | return -1; |
275 | } | |
276 | if (b->method == NULL || b->method->bread == NULL) { | |
9311d0c4 | 277 | ERR_raise(ERR_LIB_BIO, BIO_R_UNSUPPORTED_METHOD); |
bb5310be | 278 | return -2; |
0f113f3e | 279 | } |
d02b48c6 | 280 | |
0800318a | 281 | if (HAS_CALLBACK(b) && |
7bf79e33 | 282 | ((ret = (int)bio_call_callback(b, BIO_CB_READ, data, dlen, 0, 0L, 1L, |
c911e5da | 283 | NULL)) <= 0)) |
d07aee2c | 284 | return ret; |
d02b48c6 | 285 | |
0f113f3e | 286 | if (!b->init) { |
9311d0c4 | 287 | ERR_raise(ERR_LIB_BIO, BIO_R_UNINITIALIZED); |
dc88a039 | 288 | return -1; |
0f113f3e | 289 | } |
d02b48c6 | 290 | |
d62bf89c | 291 | ret = b->method->bread(b, data, dlen, readbytes); |
dfeab068 | 292 | |
d07aee2c | 293 | if (ret > 0) |
82cb311f | 294 | b->num_read += (uint64_t)*readbytes; |
d07aee2c | 295 | |
0800318a | 296 | if (HAS_CALLBACK(b)) |
42c60460 | 297 | ret = (int)bio_call_callback(b, BIO_CB_READ | BIO_CB_RETURN, data, |
d62bf89c | 298 | dlen, 0, 0L, ret, readbytes); |
d02b48c6 | 299 | |
fbba62f6 | 300 | /* Shouldn't happen */ |
d62bf89c | 301 | if (ret > 0 && *readbytes > dlen) { |
9311d0c4 | 302 | ERR_raise(ERR_LIB_BIO, ERR_R_INTERNAL_ERROR); |
fbba62f6 | 303 | return -1; |
7bf79e33 | 304 | } |
fbba62f6 | 305 | |
d07aee2c | 306 | return ret; |
0f113f3e | 307 | } |
d02b48c6 | 308 | |
7bf79e33 | 309 | int BIO_read(BIO *b, void *data, int dlen) |
0f113f3e | 310 | { |
d62bf89c | 311 | size_t readbytes; |
3befffa3 MC |
312 | int ret; |
313 | ||
7bf79e33 | 314 | if (dlen < 0) |
3befffa3 MC |
315 | return 0; |
316 | ||
d62bf89c | 317 | ret = bio_read_intern(b, data, (size_t)dlen, &readbytes); |
3befffa3 MC |
318 | |
319 | if (ret > 0) { | |
4e3973b4 | 320 | /* *readbytes should always be <= dlen */ |
d62bf89c | 321 | ret = (int)readbytes; |
3befffa3 MC |
322 | } |
323 | ||
324 | return ret; | |
325 | } | |
326 | ||
d62bf89c | 327 | int BIO_read_ex(BIO *b, void *data, size_t dlen, size_t *readbytes) |
bb5310be | 328 | { |
dc88a039 | 329 | return bio_read_intern(b, data, dlen, readbytes) > 0; |
bb5310be MC |
330 | } |
331 | ||
7bf79e33 | 332 | static int bio_write_intern(BIO *b, const void *data, size_t dlen, |
42c60460 | 333 | size_t *written) |
3befffa3 | 334 | { |
5d43bfa7 | 335 | size_t local_written; |
3befffa3 | 336 | int ret; |
58964a49 | 337 | |
5d43bfa7 DDO |
338 | if (written != NULL) |
339 | *written = 0; | |
f505161e SL |
340 | /* |
341 | * b == NULL is not an error but just means that zero bytes are written. | |
342 | * Do not raise an error here. | |
343 | */ | |
344 | if (b == NULL) | |
345 | return 0; | |
346 | ||
dc88a039 | 347 | if (b->method == NULL || b->method->bwrite == NULL) { |
9311d0c4 | 348 | ERR_raise(ERR_LIB_BIO, BIO_R_UNSUPPORTED_METHOD); |
bb5310be | 349 | return -2; |
0f113f3e | 350 | } |
d02b48c6 | 351 | |
0800318a | 352 | if (HAS_CALLBACK(b) && |
7bf79e33 | 353 | ((ret = (int)bio_call_callback(b, BIO_CB_WRITE, data, dlen, 0, 0L, 1L, |
c911e5da | 354 | NULL)) <= 0)) |
3befffa3 | 355 | return ret; |
d02b48c6 | 356 | |
0f113f3e | 357 | if (!b->init) { |
9311d0c4 | 358 | ERR_raise(ERR_LIB_BIO, BIO_R_UNINITIALIZED); |
dc88a039 | 359 | return -1; |
0f113f3e | 360 | } |
d02b48c6 | 361 | |
5d43bfa7 | 362 | ret = b->method->bwrite(b, data, dlen, &local_written); |
dfeab068 | 363 | |
3befffa3 | 364 | if (ret > 0) |
5d43bfa7 | 365 | b->num_write += (uint64_t)local_written; |
d02b48c6 | 366 | |
0800318a | 367 | if (HAS_CALLBACK(b)) |
42c60460 | 368 | ret = (int)bio_call_callback(b, BIO_CB_WRITE | BIO_CB_RETURN, data, |
5d43bfa7 | 369 | dlen, 0, 0L, ret, &local_written); |
3befffa3 | 370 | |
5d43bfa7 DDO |
371 | if (written != NULL) |
372 | *written = local_written; | |
3befffa3 | 373 | return ret; |
0f113f3e | 374 | } |
d02b48c6 | 375 | |
7bf79e33 | 376 | int BIO_write(BIO *b, const void *data, int dlen) |
bb5310be MC |
377 | { |
378 | size_t written; | |
379 | int ret; | |
380 | ||
5d43bfa7 | 381 | if (dlen <= 0) |
bb5310be MC |
382 | return 0; |
383 | ||
7bf79e33 | 384 | ret = bio_write_intern(b, data, (size_t)dlen, &written); |
bb5310be MC |
385 | |
386 | if (ret > 0) { | |
5d43bfa7 | 387 | /* written should always be <= dlen */ |
bb5310be MC |
388 | ret = (int)written; |
389 | } | |
390 | ||
391 | return ret; | |
392 | } | |
393 | ||
7bf79e33 | 394 | int BIO_write_ex(BIO *b, const void *data, size_t dlen, size_t *written) |
bb5310be | 395 | { |
bb19b9d4 DDO |
396 | return bio_write_intern(b, data, dlen, written) > 0 |
397 | || (b != NULL && dlen == 0); /* order is important for *written */ | |
bb5310be MC |
398 | } |
399 | ||
4e3973b4 | 400 | int BIO_puts(BIO *b, const char *buf) |
0f113f3e | 401 | { |
98e553d2 | 402 | int ret; |
47263ace | 403 | size_t written = 0; |
d02b48c6 | 404 | |
dc88a039 | 405 | if (b == NULL) { |
ed4a9b15 | 406 | ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER); |
dc88a039 DDO |
407 | return -1; |
408 | } | |
409 | if (b->method == NULL || b->method->bputs == NULL) { | |
9311d0c4 | 410 | ERR_raise(ERR_LIB_BIO, BIO_R_UNSUPPORTED_METHOD); |
98e553d2 | 411 | return -2; |
0f113f3e | 412 | } |
d02b48c6 | 413 | |
0800318a | 414 | if (HAS_CALLBACK(b)) { |
4e3973b4 | 415 | ret = (int)bio_call_callback(b, BIO_CB_PUTS, buf, 0, 0, 0L, 1L, NULL); |
98e553d2 MC |
416 | if (ret <= 0) |
417 | return ret; | |
418 | } | |
d02b48c6 | 419 | |
0f113f3e | 420 | if (!b->init) { |
9311d0c4 | 421 | ERR_raise(ERR_LIB_BIO, BIO_R_UNINITIALIZED); |
dc88a039 | 422 | return -1; |
0f113f3e | 423 | } |
d02b48c6 | 424 | |
4e3973b4 | 425 | ret = b->method->bputs(b, buf); |
d02b48c6 | 426 | |
98e553d2 MC |
427 | if (ret > 0) { |
428 | b->num_write += (uint64_t)ret; | |
429 | written = ret; | |
430 | ret = 1; | |
431 | } | |
432 | ||
0800318a | 433 | if (HAS_CALLBACK(b)) |
4e3973b4 | 434 | ret = (int)bio_call_callback(b, BIO_CB_PUTS | BIO_CB_RETURN, buf, 0, 0, |
98e553d2 MC |
435 | 0L, ret, &written); |
436 | ||
437 | if (ret > 0) { | |
7bf79e33 | 438 | if (written > INT_MAX) { |
9311d0c4 | 439 | ERR_raise(ERR_LIB_BIO, BIO_R_LENGTH_TOO_LONG); |
98e553d2 | 440 | ret = -1; |
7bf79e33 | 441 | } else { |
98e553d2 | 442 | ret = (int)written; |
7bf79e33 | 443 | } |
98e553d2 | 444 | } |
7d95ff76 | 445 | |
98e553d2 | 446 | return ret; |
0f113f3e | 447 | } |
d02b48c6 | 448 | |
4e3973b4 | 449 | int BIO_gets(BIO *b, char *buf, int size) |
0f113f3e | 450 | { |
98e553d2 | 451 | int ret; |
d62bf89c | 452 | size_t readbytes = 0; |
0f113f3e | 453 | |
dc88a039 | 454 | if (b == NULL) { |
ed4a9b15 | 455 | ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER); |
dc88a039 DDO |
456 | return -1; |
457 | } | |
458 | if (b->method == NULL || b->method->bgets == NULL) { | |
9311d0c4 | 459 | ERR_raise(ERR_LIB_BIO, BIO_R_UNSUPPORTED_METHOD); |
26a7d938 | 460 | return -2; |
0f113f3e MC |
461 | } |
462 | ||
4e3973b4 | 463 | if (size < 0) { |
9311d0c4 | 464 | ERR_raise(ERR_LIB_BIO, BIO_R_INVALID_ARGUMENT); |
dc88a039 | 465 | return -1; |
fbba62f6 MC |
466 | } |
467 | ||
0800318a | 468 | if (HAS_CALLBACK(b)) { |
4e3973b4 | 469 | ret = (int)bio_call_callback(b, BIO_CB_GETS, buf, size, 0, 0L, 1, NULL); |
98e553d2 MC |
470 | if (ret <= 0) |
471 | return ret; | |
472 | } | |
0f113f3e MC |
473 | |
474 | if (!b->init) { | |
9311d0c4 | 475 | ERR_raise(ERR_LIB_BIO, BIO_R_UNINITIALIZED); |
dc88a039 | 476 | return -1; |
0f113f3e MC |
477 | } |
478 | ||
4e3973b4 | 479 | ret = b->method->bgets(b, buf, size); |
98e553d2 MC |
480 | |
481 | if (ret > 0) { | |
d62bf89c | 482 | readbytes = ret; |
98e553d2 MC |
483 | ret = 1; |
484 | } | |
485 | ||
0800318a | 486 | if (HAS_CALLBACK(b)) |
4e3973b4 | 487 | ret = (int)bio_call_callback(b, BIO_CB_GETS | BIO_CB_RETURN, buf, size, |
d62bf89c | 488 | 0, 0L, ret, &readbytes); |
98e553d2 MC |
489 | |
490 | if (ret > 0) { | |
fbba62f6 | 491 | /* Shouldn't happen */ |
4e3973b4 | 492 | if (readbytes > (size_t)size) |
98e553d2 MC |
493 | ret = -1; |
494 | else | |
d62bf89c | 495 | ret = (int)readbytes; |
98e553d2 | 496 | } |
0f113f3e | 497 | |
98e553d2 | 498 | return ret; |
0f113f3e MC |
499 | } |
500 | ||
18423879 DDO |
501 | int BIO_get_line(BIO *bio, char *buf, int size) |
502 | { | |
503 | int ret = 0; | |
504 | char *ptr = buf; | |
505 | ||
506 | if (buf == NULL) { | |
507 | ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER); | |
508 | return -1; | |
509 | } | |
510 | if (size <= 0) { | |
511 | ERR_raise(ERR_LIB_BIO, BIO_R_INVALID_ARGUMENT); | |
512 | return -1; | |
513 | } | |
514 | *buf = '\0'; | |
515 | ||
516 | if (bio == NULL) { | |
517 | ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER); | |
518 | return -1; | |
519 | } | |
520 | if (!bio->init) { | |
521 | ERR_raise(ERR_LIB_BIO, BIO_R_UNINITIALIZED); | |
522 | return -1; | |
523 | } | |
524 | ||
525 | while (size-- > 1 && (ret = BIO_read(bio, ptr, 1)) > 0) | |
526 | if (*ptr++ == '\n') | |
527 | break; | |
528 | *ptr = '\0'; | |
529 | return ret > 0 || BIO_eof(bio) ? ptr - buf : ret; | |
530 | } | |
531 | ||
0f113f3e MC |
532 | int BIO_indent(BIO *b, int indent, int max) |
533 | { | |
534 | if (indent < 0) | |
535 | indent = 0; | |
536 | if (indent > max) | |
537 | indent = max; | |
538 | while (indent--) | |
539 | if (BIO_puts(b, " ") != 1) | |
540 | return 0; | |
541 | return 1; | |
542 | } | |
54a656ef | 543 | |
6b691a5c | 544 | long BIO_int_ctrl(BIO *b, int cmd, long larg, int iarg) |
0f113f3e MC |
545 | { |
546 | int i; | |
d02b48c6 | 547 | |
0f113f3e | 548 | i = iarg; |
26a7d938 | 549 | return BIO_ctrl(b, cmd, larg, (char *)&i); |
0f113f3e | 550 | } |
d02b48c6 | 551 | |
417be660 | 552 | void *BIO_ptr_ctrl(BIO *b, int cmd, long larg) |
0f113f3e | 553 | { |
417be660 | 554 | void *p = NULL; |
58964a49 | 555 | |
0f113f3e | 556 | if (BIO_ctrl(b, cmd, larg, (char *)&p) <= 0) |
26a7d938 | 557 | return NULL; |
0f113f3e | 558 | else |
26a7d938 | 559 | return p; |
0f113f3e | 560 | } |
58964a49 | 561 | |
95d29597 | 562 | long BIO_ctrl(BIO *b, int cmd, long larg, void *parg) |
0f113f3e MC |
563 | { |
564 | long ret; | |
d02b48c6 | 565 | |
dc88a039 | 566 | if (b == NULL) { |
ed4a9b15 | 567 | ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER); |
dc88a039 DDO |
568 | return -1; |
569 | } | |
570 | if (b->method == NULL || b->method->ctrl == NULL) { | |
9311d0c4 | 571 | ERR_raise(ERR_LIB_BIO, BIO_R_UNSUPPORTED_METHOD); |
98e553d2 | 572 | return -2; |
0f113f3e | 573 | } |
d02b48c6 | 574 | |
0800318a | 575 | if (HAS_CALLBACK(b)) { |
98e553d2 MC |
576 | ret = bio_call_callback(b, BIO_CB_CTRL, parg, 0, cmd, larg, 1L, NULL); |
577 | if (ret <= 0) | |
578 | return ret; | |
579 | } | |
d02b48c6 | 580 | |
0f113f3e | 581 | ret = b->method->ctrl(b, cmd, larg, parg); |
d02b48c6 | 582 | |
0800318a | 583 | if (HAS_CALLBACK(b)) |
98e553d2 MC |
584 | ret = bio_call_callback(b, BIO_CB_CTRL | BIO_CB_RETURN, parg, 0, cmd, |
585 | larg, ret, NULL); | |
586 | ||
587 | return ret; | |
0f113f3e | 588 | } |
d02b48c6 | 589 | |
fce78bd4 | 590 | long BIO_callback_ctrl(BIO *b, int cmd, BIO_info_cb *fp) |
0f113f3e MC |
591 | { |
592 | long ret; | |
d3442bc7 | 593 | |
dc88a039 | 594 | if (b == NULL) { |
ed4a9b15 DDO |
595 | ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER); |
596 | return -2; | |
dc88a039 DDO |
597 | } |
598 | if (b->method == NULL || b->method->callback_ctrl == NULL | |
599 | || cmd != BIO_CTRL_SET_CALLBACK) { | |
9311d0c4 | 600 | ERR_raise(ERR_LIB_BIO, BIO_R_UNSUPPORTED_METHOD); |
26a7d938 | 601 | return -2; |
0f113f3e | 602 | } |
d3442bc7 | 603 | |
0800318a | 604 | if (HAS_CALLBACK(b)) { |
98e553d2 MC |
605 | ret = bio_call_callback(b, BIO_CB_CTRL, (void *)&fp, 0, cmd, 0, 1L, |
606 | NULL); | |
607 | if (ret <= 0) | |
608 | return ret; | |
609 | } | |
d3442bc7 | 610 | |
0f113f3e | 611 | ret = b->method->callback_ctrl(b, cmd, fp); |
d3442bc7 | 612 | |
0800318a | 613 | if (HAS_CALLBACK(b)) |
98e553d2 MC |
614 | ret = bio_call_callback(b, BIO_CB_CTRL | BIO_CB_RETURN, (void *)&fp, 0, |
615 | cmd, 0, ret, NULL); | |
616 | ||
617 | return ret; | |
0f113f3e | 618 | } |
d3442bc7 | 619 | |
0f113f3e MC |
620 | /* |
621 | * It is unfortunate to duplicate in functions what the BIO_(w)pending macros | |
95d29597 | 622 | * do; but those macros have inappropriate return type, and for interfacing |
0f113f3e MC |
623 | * from other programming languages, C macros aren't much of a help anyway. |
624 | */ | |
95d29597 | 625 | size_t BIO_ctrl_pending(BIO *bio) |
0f113f3e MC |
626 | { |
627 | return BIO_ctrl(bio, BIO_CTRL_PENDING, 0, NULL); | |
628 | } | |
95d29597 BM |
629 | |
630 | size_t BIO_ctrl_wpending(BIO *bio) | |
0f113f3e MC |
631 | { |
632 | return BIO_ctrl(bio, BIO_CTRL_WPENDING, 0, NULL); | |
633 | } | |
95d29597 | 634 | |
d02b48c6 | 635 | /* put the 'bio' on the end of b's list of operators */ |
6b691a5c | 636 | BIO *BIO_push(BIO *b, BIO *bio) |
0f113f3e MC |
637 | { |
638 | BIO *lb; | |
639 | ||
640 | if (b == NULL) | |
26a7d938 | 641 | return bio; |
0f113f3e MC |
642 | lb = b; |
643 | while (lb->next_bio != NULL) | |
644 | lb = lb->next_bio; | |
645 | lb->next_bio = bio; | |
646 | if (bio != NULL) | |
647 | bio->prev_bio = lb; | |
648 | /* called to do internal processing */ | |
649 | BIO_ctrl(b, BIO_CTRL_PUSH, 0, lb); | |
26a7d938 | 650 | return b; |
0f113f3e | 651 | } |
d02b48c6 RE |
652 | |
653 | /* Remove the first and return the rest */ | |
6b691a5c | 654 | BIO *BIO_pop(BIO *b) |
0f113f3e MC |
655 | { |
656 | BIO *ret; | |
d02b48c6 | 657 | |
dc88a039 | 658 | if (b == NULL) { |
ed4a9b15 | 659 | ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER); |
26a7d938 | 660 | return NULL; |
dc88a039 | 661 | } |
0f113f3e | 662 | ret = b->next_bio; |
d02b48c6 | 663 | |
0f113f3e | 664 | BIO_ctrl(b, BIO_CTRL_POP, 0, b); |
5d780bab | 665 | |
0f113f3e MC |
666 | if (b->prev_bio != NULL) |
667 | b->prev_bio->next_bio = b->next_bio; | |
668 | if (b->next_bio != NULL) | |
669 | b->next_bio->prev_bio = b->prev_bio; | |
d02b48c6 | 670 | |
0f113f3e MC |
671 | b->next_bio = NULL; |
672 | b->prev_bio = NULL; | |
26a7d938 | 673 | return ret; |
0f113f3e | 674 | } |
d02b48c6 | 675 | |
6b691a5c | 676 | BIO *BIO_get_retry_BIO(BIO *bio, int *reason) |
0f113f3e MC |
677 | { |
678 | BIO *b, *last; | |
679 | ||
680 | b = last = bio; | |
681 | for (;;) { | |
682 | if (!BIO_should_retry(b)) | |
683 | break; | |
684 | last = b; | |
685 | b = b->next_bio; | |
686 | if (b == NULL) | |
687 | break; | |
688 | } | |
689 | if (reason != NULL) | |
690 | *reason = last->retry_reason; | |
26a7d938 | 691 | return last; |
0f113f3e | 692 | } |
d02b48c6 | 693 | |
6b691a5c | 694 | int BIO_get_retry_reason(BIO *bio) |
0f113f3e | 695 | { |
26a7d938 | 696 | return bio->retry_reason; |
0f113f3e | 697 | } |
d02b48c6 | 698 | |
a146ae55 MC |
699 | void BIO_set_retry_reason(BIO *bio, int reason) |
700 | { | |
701 | bio->retry_reason = reason; | |
702 | } | |
703 | ||
6b691a5c | 704 | BIO *BIO_find_type(BIO *bio, int type) |
0f113f3e MC |
705 | { |
706 | int mt, mask; | |
707 | ||
dc88a039 | 708 | if (bio == NULL) { |
ed4a9b15 | 709 | ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER); |
0f113f3e | 710 | return NULL; |
dc88a039 | 711 | } |
0f113f3e MC |
712 | mask = type & 0xff; |
713 | do { | |
714 | if (bio->method != NULL) { | |
715 | mt = bio->method->type; | |
716 | ||
717 | if (!mask) { | |
718 | if (mt & type) | |
26a7d938 | 719 | return bio; |
dc88a039 | 720 | } else if (mt == type) { |
26a7d938 | 721 | return bio; |
dc88a039 | 722 | } |
0f113f3e MC |
723 | } |
724 | bio = bio->next_bio; | |
725 | } while (bio != NULL); | |
26a7d938 | 726 | return NULL; |
0f113f3e | 727 | } |
d02b48c6 | 728 | |
cfd3bb17 | 729 | BIO *BIO_next(BIO *b) |
0f113f3e | 730 | { |
dc88a039 | 731 | if (b == NULL) { |
ed4a9b15 | 732 | ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER); |
0f113f3e | 733 | return NULL; |
dc88a039 | 734 | } |
0f113f3e MC |
735 | return b->next_bio; |
736 | } | |
cfd3bb17 | 737 | |
a146ae55 MC |
738 | void BIO_set_next(BIO *b, BIO *next) |
739 | { | |
740 | b->next_bio = next; | |
741 | } | |
742 | ||
6b691a5c | 743 | void BIO_free_all(BIO *bio) |
0f113f3e MC |
744 | { |
745 | BIO *b; | |
746 | int ref; | |
747 | ||
748 | while (bio != NULL) { | |
749 | b = bio; | |
750 | ref = b->references; | |
751 | bio = bio->next_bio; | |
752 | BIO_free(b); | |
753 | /* Since ref count > 1, don't free anyone else. */ | |
754 | if (ref > 1) | |
755 | break; | |
756 | } | |
757 | } | |
d02b48c6 | 758 | |
6b691a5c | 759 | BIO *BIO_dup_chain(BIO *in) |
0f113f3e MC |
760 | { |
761 | BIO *ret = NULL, *eoc = NULL, *bio, *new_bio; | |
762 | ||
763 | for (bio = in; bio != NULL; bio = bio->next_bio) { | |
764 | if ((new_bio = BIO_new(bio->method)) == NULL) | |
765 | goto err; | |
0800318a | 766 | #ifndef OPENSSL_NO_DEPRECATED_3_0 |
0f113f3e | 767 | new_bio->callback = bio->callback; |
0800318a | 768 | #endif |
98e553d2 | 769 | new_bio->callback_ex = bio->callback_ex; |
0f113f3e MC |
770 | new_bio->cb_arg = bio->cb_arg; |
771 | new_bio->init = bio->init; | |
772 | new_bio->shutdown = bio->shutdown; | |
773 | new_bio->flags = bio->flags; | |
774 | ||
775 | /* This will let SSL_s_sock() work with stdin/stdout */ | |
776 | new_bio->num = bio->num; | |
777 | ||
778 | if (!BIO_dup_state(bio, (char *)new_bio)) { | |
779 | BIO_free(new_bio); | |
780 | goto err; | |
781 | } | |
782 | ||
783 | /* copy app data */ | |
784 | if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_BIO, &new_bio->ex_data, | |
aec54108 MC |
785 | &bio->ex_data)) { |
786 | BIO_free(new_bio); | |
0f113f3e | 787 | goto err; |
aec54108 | 788 | } |
0f113f3e MC |
789 | |
790 | if (ret == NULL) { | |
791 | eoc = new_bio; | |
792 | ret = eoc; | |
793 | } else { | |
794 | BIO_push(eoc, new_bio); | |
795 | eoc = new_bio; | |
796 | } | |
797 | } | |
26a7d938 | 798 | return ret; |
0f113f3e | 799 | err: |
aec54108 MC |
800 | BIO_free_all(ret); |
801 | ||
26a7d938 | 802 | return NULL; |
0f113f3e | 803 | } |
d02b48c6 | 804 | |
6b691a5c | 805 | void BIO_copy_next_retry(BIO *b) |
0f113f3e MC |
806 | { |
807 | BIO_set_flags(b, BIO_get_retry_flags(b->next_bio)); | |
808 | b->retry_reason = b->next_bio->retry_reason; | |
809 | } | |
d02b48c6 | 810 | |
dd9d233e | 811 | int BIO_set_ex_data(BIO *bio, int idx, void *data) |
0f113f3e | 812 | { |
26a7d938 | 813 | return CRYPTO_set_ex_data(&(bio->ex_data), idx, data); |
0f113f3e | 814 | } |
58964a49 | 815 | |
8cc86b81 | 816 | void *BIO_get_ex_data(const BIO *bio, int idx) |
0f113f3e | 817 | { |
26a7d938 | 818 | return CRYPTO_get_ex_data(&(bio->ex_data), idx); |
0f113f3e | 819 | } |
58964a49 | 820 | |
b8b12aad | 821 | uint64_t BIO_number_read(BIO *bio) |
c3ed3b6e | 822 | { |
0f113f3e MC |
823 | if (bio) |
824 | return bio->num_read; | |
825 | return 0; | |
c3ed3b6e DSH |
826 | } |
827 | ||
b8b12aad | 828 | uint64_t BIO_number_written(BIO *bio) |
c3ed3b6e | 829 | { |
0f113f3e MC |
830 | if (bio) |
831 | return bio->num_write; | |
832 | return 0; | |
c3ed3b6e | 833 | } |
ff234405 | 834 | |
1ee7b8b9 MC |
835 | void bio_free_ex_data(BIO *bio) |
836 | { | |
837 | CRYPTO_free_ex_data(CRYPTO_EX_INDEX_BIO, bio, &bio->ex_data); | |
838 | } | |
ff234405 MC |
839 | |
840 | void bio_cleanup(void) | |
841 | { | |
842 | #ifndef OPENSSL_NO_SOCK | |
843 | bio_sock_cleanup_int(); | |
844 | CRYPTO_THREAD_lock_free(bio_lookup_lock); | |
845 | bio_lookup_lock = NULL; | |
5a7ad1f0 | 846 | #endif |
8b8d963d RS |
847 | CRYPTO_THREAD_lock_free(bio_type_lock); |
848 | bio_type_lock = NULL; | |
ff234405 | 849 | } |
e8d0819d DDO |
850 | |
851 | /* Internal variant of the below BIO_wait() not calling BIOerr() */ | |
e98c7350 | 852 | static int bio_wait(BIO *bio, time_t max_time, unsigned int nap_milliseconds) |
e8d0819d | 853 | { |
d8c78e5f | 854 | #ifndef OPENSSL_NO_SOCK |
e8d0819d | 855 | int fd; |
d8c78e5f | 856 | #endif |
e98c7350 | 857 | long sec_diff; |
e8d0819d | 858 | |
e98c7350 | 859 | if (max_time == 0) /* no timeout */ |
e8d0819d DDO |
860 | return 1; |
861 | ||
862 | #ifndef OPENSSL_NO_SOCK | |
e98c7350 | 863 | if (BIO_get_fd(bio, &fd) > 0 && fd < FD_SETSIZE) |
e8d0819d DDO |
864 | return BIO_socket_wait(fd, BIO_should_read(bio), max_time); |
865 | #endif | |
e98c7350 | 866 | /* fall back to polling since no sockets are available */ |
e8d0819d | 867 | |
e98c7350 DDO |
868 | sec_diff = (long)(max_time - time(NULL)); /* might overflow */ |
869 | if (sec_diff < 0) | |
870 | return 0; /* clearly timeout */ | |
871 | ||
872 | /* now take a nap at most the given number of milliseconds */ | |
873 | if (sec_diff == 0) { /* we are below the 1 seconds resolution of max_time */ | |
874 | if (nap_milliseconds > 1000) | |
875 | nap_milliseconds = 1000; | |
876 | } else { /* for sec_diff > 0, take min(sec_diff * 1000, nap_milliseconds) */ | |
877 | if ((unsigned long)sec_diff * 1000 < nap_milliseconds) | |
878 | nap_milliseconds = (unsigned int)sec_diff * 1000; | |
e8d0819d | 879 | } |
e98c7350 | 880 | ossl_sleep(nap_milliseconds); |
e8d0819d DDO |
881 | return 1; |
882 | } | |
883 | ||
e98c7350 | 884 | /*- |
e8d0819d | 885 | * Wait on (typically socket-based) BIO at most until max_time. |
e98c7350 DDO |
886 | * Succeed immediately if max_time == 0. |
887 | * If sockets are not available support polling: succeed after waiting at most | |
888 | * the number of nap_milliseconds in order to avoid a tight busy loop. | |
889 | * Call BIOerr(...) on timeout or error. | |
e8d0819d DDO |
890 | * Returns -1 on error, 0 on timeout, and 1 on success. |
891 | */ | |
e98c7350 | 892 | int BIO_wait(BIO *bio, time_t max_time, unsigned int nap_milliseconds) |
e8d0819d | 893 | { |
e98c7350 | 894 | int rv = bio_wait(bio, max_time, nap_milliseconds); |
e8d0819d DDO |
895 | |
896 | if (rv <= 0) | |
9311d0c4 RL |
897 | ERR_raise(ERR_LIB_BIO, |
898 | rv == 0 ? BIO_R_TRANSFER_TIMEOUT : BIO_R_TRANSFER_ERROR); | |
e8d0819d DDO |
899 | return rv; |
900 | } | |
901 | ||
902 | /* | |
e98c7350 DDO |
903 | * Connect via given BIO using BIO_do_connect() until success/timeout/error. |
904 | * Parameter timeout == 0 means no timeout, < 0 means exactly one try. | |
905 | * For non-blocking and potentially even non-socket BIOs perform polling with | |
906 | * the given density: between polls sleep nap_milliseconds using BIO_wait() | |
907 | * in order to avoid a tight busy loop. | |
e8d0819d DDO |
908 | * Returns -1 on error, 0 on timeout, and 1 on success. |
909 | */ | |
e98c7350 | 910 | int BIO_do_connect_retry(BIO *bio, int timeout, int nap_milliseconds) |
e8d0819d | 911 | { |
e98c7350 | 912 | int blocking = timeout <= 0; |
e8d0819d DDO |
913 | time_t max_time = timeout > 0 ? time(NULL) + timeout : 0; |
914 | int rv; | |
915 | ||
916 | if (bio == NULL) { | |
ed4a9b15 | 917 | ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER); |
e8d0819d DDO |
918 | return -1; |
919 | } | |
920 | ||
e98c7350 DDO |
921 | if (nap_milliseconds < 0) |
922 | nap_milliseconds = 100; | |
923 | BIO_set_nbio(bio, !blocking); | |
924 | ||
925 | retry: | |
afecd85d TM |
926 | ERR_set_mark(); |
927 | rv = BIO_do_connect(bio); | |
e98c7350 DDO |
928 | |
929 | if (rv <= 0) { /* could be timeout or retryable error or fatal error */ | |
930 | int err = ERR_peek_last_error(); | |
931 | int reason = ERR_GET_REASON(err); | |
932 | int do_retry = BIO_should_retry(bio); /* may be 1 only if !blocking */ | |
933 | ||
934 | if (ERR_GET_LIB(err) == ERR_LIB_BIO) { | |
935 | switch (reason) { | |
936 | case ERR_R_SYS_LIB: | |
937 | /* | |
938 | * likely retryable system error occurred, which may be | |
939 | * EAGAIN (resource temporarily unavailable) some 40 secs after | |
940 | * calling getaddrinfo(): Temporary failure in name resolution | |
941 | * or a premature ETIMEDOUT, some 30 seconds after connect() | |
942 | */ | |
943 | case BIO_R_CONNECT_ERROR: | |
944 | case BIO_R_NBIO_CONNECT_ERROR: | |
945 | /* some likely retryable connection error occurred */ | |
946 | (void)BIO_reset(bio); /* often needed to avoid retry failure */ | |
947 | do_retry = 1; | |
948 | break; | |
949 | default: | |
950 | break; | |
951 | } | |
952 | } | |
953 | if (timeout >= 0 && do_retry) { | |
afecd85d | 954 | ERR_pop_to_mark(); |
e98c7350 DDO |
955 | /* will not actually wait if timeout == 0 (i.e., blocking BIO): */ |
956 | rv = bio_wait(bio, max_time, nap_milliseconds); | |
e8d0819d DDO |
957 | if (rv > 0) |
958 | goto retry; | |
9311d0c4 RL |
959 | ERR_raise(ERR_LIB_BIO, |
960 | rv == 0 ? BIO_R_CONNECT_TIMEOUT : BIO_R_CONNECT_ERROR); | |
e8d0819d | 961 | } else { |
afecd85d | 962 | ERR_clear_last_mark(); |
e8d0819d | 963 | rv = -1; |
e98c7350 | 964 | if (err == 0) /* missing error queue entry */ |
dc88a039 DDO |
965 | /* workaround: general error */ |
966 | ERR_raise(ERR_LIB_BIO, BIO_R_CONNECT_ERROR); | |
e8d0819d | 967 | } |
afecd85d TM |
968 | } else { |
969 | ERR_clear_last_mark(); | |
e8d0819d DDO |
970 | } |
971 | ||
972 | return rv; | |
973 | } |