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