2 * Copyright 2001-2025 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright Siemens AG 2018-2020
5 * Licensed under the Apache License 2.0 (the "License"). You may not use
6 * this file except in compliance with the License. You can obtain a copy
7 * in the file LICENSE in the source distribution or at
8 * https://www.openssl.org/source/license.html
11 #include "internal/e_os.h"
14 #include "crypto/ctype.h"
16 #include <openssl/asn1.h>
17 #include <openssl/evp.h>
18 #include <openssl/err.h>
19 #include <openssl/httperr.h>
20 #include <openssl/cmperr.h>
21 #include <openssl/buffer.h>
22 #include <openssl/http.h>
23 #include <openssl/trace.h>
24 #include "internal/sockets.h"
25 #include "internal/common.h" /* for ossl_assert() */
27 #define HTTP_PREFIX "HTTP/"
28 #define HTTP_VERSION_PATT "1." /* allow 1.x */
29 #define HTTP_VERSION_STR_LEN sizeof(HTTP_VERSION_PATT) /* == strlen("1.0") */
30 #define HTTP_PREFIX_VERSION HTTP_PREFIX""HTTP_VERSION_PATT
31 #define HTTP_1_0 HTTP_PREFIX_VERSION"0" /* "HTTP/1.0" */
32 #define HTTP_LINE1_MINLEN (sizeof(HTTP_PREFIX_VERSION "x 200\n") - 1)
33 #define HTTP_VERSION_MAX_REDIRECTIONS 50
35 #define HTTP_STATUS_CODE_OK 200
36 #define HTTP_STATUS_CODE_MOVED_PERMANENTLY 301
37 #define HTTP_STATUS_CODE_FOUND 302
38 #define HTTP_STATUS_CODES_NONFATAL_ERROR 400
40 /* Stateful HTTP request code, supporting blocking and non-blocking I/O */
42 /* Opaque HTTP request status structure */
44 struct ossl_http_req_ctx_st
{
45 int state
; /* Current I/O state */
46 unsigned char *buf
; /* Buffer to write request or read response */
47 int buf_size
; /* Buffer size */
48 int free_wbio
; /* wbio allocated internally, free with ctx */
49 BIO
*wbio
; /* BIO to write/send request to */
50 BIO
*rbio
; /* BIO to read/receive response from */
51 OSSL_HTTP_bio_cb_t upd_fn
; /* Optional BIO update callback used for TLS */
52 void *upd_arg
; /* Optional arg for update callback function */
53 int use_ssl
; /* Use HTTPS */
54 char *proxy
; /* Optional proxy name or URI */
55 char *server
; /* Optional server hostname */
56 char *port
; /* Optional server port */
57 BIO
*mem
; /* Mem BIO holding request header or response */
58 BIO
*req
; /* BIO holding the request provided by caller */
59 int method_POST
; /* HTTP method is POST (else GET) */
60 int text
; /* Request content type is (likely) text */
61 char *expected_ct
; /* Optional expected Content-Type */
62 int expect_asn1
; /* Response content must be ASN.1-encoded */
63 unsigned char *pos
; /* Current position sending data */
64 long len_to_send
; /* Number of bytes still to send */
65 size_t resp_len
; /* Length of response */
66 size_t max_resp_len
; /* Maximum length of response, or 0 */
67 int keep_alive
; /* Persistent conn. 0=no, 1=prefer, 2=require */
68 time_t max_time
; /* Maximum end time of current transfer, or 0 */
69 time_t max_total_time
; /* Maximum end time of total transfer, or 0 */
70 char *redirection_url
; /* Location obtained from HTTP status 301/302 */
71 size_t max_hdr_lines
; /* Max. number of response header lines, or 0 */
74 /* HTTP client OSSL_HTTP_REQ_CTX_nbio() internal states, in typical order */
76 #define OHS_NOREAD 0x1000 /* If set no reading should be performed */
77 #define OHS_ERROR (0 | OHS_NOREAD) /* Error condition */
78 #define OHS_ADD_HEADERS (1 | OHS_NOREAD) /* Adding header lines to request */
79 #define OHS_WRITE_INIT (2 | OHS_NOREAD) /* 1st call: ready to start send */
80 #define OHS_WRITE_HDR1 (3 | OHS_NOREAD) /* Request header to be sent */
81 #define OHS_WRITE_HDR (4 | OHS_NOREAD) /* Request header being sent */
82 #define OHS_WRITE_REQ (5 | OHS_NOREAD) /* Request content (body) being sent */
83 #define OHS_FLUSH (6 | OHS_NOREAD) /* Request being flushed */
85 #define OHS_FIRSTLINE 1 /* First line of response being read */
86 #define OHS_HEADERS 2 /* MIME headers of response being read */
87 #define OHS_HEADERS_ERROR 3 /* MIME headers of response being read after fatal error */
88 #define OHS_REDIRECT 4 /* MIME headers being read, expecting Location */
89 #define OHS_ASN1_HEADER 5 /* ASN1 sequence header (tag+length) being read */
90 #define OHS_ASN1_CONTENT 6 /* ASN1 content octets being read */
91 #define OHS_ASN1_DONE 7 /* ASN1 content read completed */
92 #define OHS_STREAM 8 /* HTTP content stream to be read by caller */
93 #define OHS_ERROR_CONTENT 9 /* response content (body) being read after fatal error */
95 /* Low-level HTTP API implementation */
97 OSSL_HTTP_REQ_CTX
*OSSL_HTTP_REQ_CTX_new(BIO
*wbio
, BIO
*rbio
, int buf_size
)
99 OSSL_HTTP_REQ_CTX
*rctx
;
101 if (wbio
== NULL
|| rbio
== NULL
) {
102 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
106 if ((rctx
= OPENSSL_zalloc(sizeof(*rctx
))) == NULL
)
108 rctx
->state
= OHS_ERROR
;
109 rctx
->buf_size
= buf_size
> 0 ? buf_size
: OSSL_HTTP_DEFAULT_MAX_LINE_LEN
;
110 rctx
->buf
= OPENSSL_malloc(rctx
->buf_size
);
113 rctx
->max_hdr_lines
= OSSL_HTTP_DEFAULT_MAX_RESP_HDR_LINES
;
114 if (rctx
->buf
== NULL
) {
118 rctx
->max_resp_len
= OSSL_HTTP_DEFAULT_MAX_RESP_LEN
;
119 /* everything else is 0, e.g. rctx->len_to_send, or NULL, e.g. rctx->mem */
123 void OSSL_HTTP_REQ_CTX_free(OSSL_HTTP_REQ_CTX
*rctx
)
128 * Use BIO_free_all() because bio_update_fn may prepend or append to cbio.
129 * This also frees any (e.g., SSL/TLS) BIOs linked with bio and,
130 * like BIO_reset(bio), calls SSL_shutdown() to notify/alert the peer.
133 BIO_free_all(rctx
->wbio
);
134 /* do not free rctx->rbio */
137 OPENSSL_free(rctx
->buf
);
138 OPENSSL_free(rctx
->proxy
);
139 OPENSSL_free(rctx
->server
);
140 OPENSSL_free(rctx
->port
);
141 OPENSSL_free(rctx
->expected_ct
);
145 BIO
*OSSL_HTTP_REQ_CTX_get0_mem_bio(const OSSL_HTTP_REQ_CTX
*rctx
)
148 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
154 size_t OSSL_HTTP_REQ_CTX_get_resp_len(const OSSL_HTTP_REQ_CTX
*rctx
)
157 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
160 return rctx
->resp_len
;
163 void OSSL_HTTP_REQ_CTX_set_max_response_length(OSSL_HTTP_REQ_CTX
*rctx
,
167 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
170 rctx
->max_resp_len
= len
!= 0 ? (size_t)len
: OSSL_HTTP_DEFAULT_MAX_RESP_LEN
;
174 * Create request line using |rctx| and |path| (or "/" in case |path| is NULL).
175 * Server name (and optional port) must be given if and only if
176 * a plain HTTP proxy is used and |path| does not begin with 'http://'.
178 int OSSL_HTTP_REQ_CTX_set_request_line(OSSL_HTTP_REQ_CTX
*rctx
, int method_POST
,
179 const char *server
, const char *port
,
183 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
187 if ((rctx
->mem
= BIO_new(BIO_s_mem())) == NULL
)
190 rctx
->method_POST
= method_POST
!= 0;
191 if (BIO_printf(rctx
->mem
, "%s ", rctx
->method_POST
? "POST" : "GET") <= 0)
194 if (server
!= NULL
) { /* HTTP (but not HTTPS) proxy is used */
196 * Section 5.1.2 of RFC 1945 states that the absoluteURI form is only
197 * allowed when using a proxy
199 if (BIO_printf(rctx
->mem
, OSSL_HTTP_PREFIX
"%s", server
) <= 0)
201 if (port
!= NULL
&& BIO_printf(rctx
->mem
, ":%s", port
) <= 0)
205 /* Make sure path includes a forward slash (abs_path) */
208 } else if (HAS_PREFIX(path
, "http://")) { /* absoluteURI for proxy use */
209 if (server
!= NULL
) {
210 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_INVALID_ARGUMENT
);
213 } else if (path
[0] != '/' && BIO_printf(rctx
->mem
, "/") <= 0) {
217 * Add (the rest of) the path and the HTTP version,
218 * which is fixed to 1.0 for straightforward implementation of keep-alive
220 if (BIO_printf(rctx
->mem
, "%s "HTTP_1_0
"\r\n", path
) <= 0)
224 rctx
->state
= OHS_ADD_HEADERS
;
228 int OSSL_HTTP_REQ_CTX_add1_header(OSSL_HTTP_REQ_CTX
*rctx
,
229 const char *name
, const char *value
)
231 if (rctx
== NULL
|| name
== NULL
) {
232 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
235 if (rctx
->mem
== NULL
) {
236 ERR_raise(ERR_LIB_HTTP
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
240 if (BIO_puts(rctx
->mem
, name
) <= 0)
243 if (BIO_write(rctx
->mem
, ": ", 2) != 2)
245 if (BIO_puts(rctx
->mem
, value
) <= 0)
248 return BIO_write(rctx
->mem
, "\r\n", 2) == 2;
251 int OSSL_HTTP_REQ_CTX_set_expected(OSSL_HTTP_REQ_CTX
*rctx
,
252 const char *content_type
, int asn1
,
253 int timeout
, int keep_alive
)
256 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
260 && rctx
->state
!= OHS_ERROR
&& rctx
->state
!= OHS_ADD_HEADERS
) {
261 /* Cannot anymore set keep-alive in request header */
262 ERR_raise(ERR_LIB_HTTP
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
266 OPENSSL_free(rctx
->expected_ct
);
267 rctx
->expected_ct
= NULL
;
268 if (content_type
!= NULL
269 && (rctx
->expected_ct
= OPENSSL_strdup(content_type
)) == NULL
)
272 rctx
->expect_asn1
= asn1
;
274 rctx
->max_time
= timeout
> 0 ? time(NULL
) + timeout
: 0;
275 else /* take over any |overall_timeout| arg of OSSL_HTTP_open(), else 0 */
276 rctx
->max_time
= rctx
->max_total_time
;
277 rctx
->keep_alive
= keep_alive
;
281 static int set1_content(OSSL_HTTP_REQ_CTX
*rctx
,
282 const char *content_type
, BIO
*req
)
285 #ifndef OPENSSL_NO_STDIO
289 if (rctx
== NULL
|| (req
== NULL
&& content_type
!= NULL
)) {
290 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
294 if (rctx
->keep_alive
!= 0
295 && !OSSL_HTTP_REQ_CTX_add1_header(rctx
, "Connection", "keep-alive"))
302 if (!rctx
->method_POST
) {
303 ERR_raise(ERR_LIB_HTTP
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
307 if (content_type
== NULL
) {
308 rctx
->text
= 1; /* assuming request to be text by default, used just for tracing */
310 if (HAS_CASE_PREFIX(content_type
, "text/"))
312 if (BIO_printf(rctx
->mem
, "Content-Type: %s\r\n", content_type
) <= 0)
317 * BIO_CTRL_INFO yields the data length at least for memory BIOs, but for
318 * file-based BIOs it gives the current position, which is not what we need.
320 if (BIO_method_type(req
) == BIO_TYPE_FILE
) {
321 #ifndef OPENSSL_NO_STDIO
322 if (BIO_get_fp(req
, &fp
) == 1 && fseek(fp
, 0, SEEK_END
) == 0) {
324 (void)fseek(fp
, 0, SEEK_SET
);
330 req_len
= BIO_ctrl(req
, BIO_CTRL_INFO
, 0, NULL
);
332 * Streaming BIOs likely will not support querying the size at all,
333 * and we assume we got a correct value if req_len > 0.
337 #ifndef OPENSSL_NO_STDIO
338 fp
!= NULL
/* definitely correct req_len */ ||
341 && BIO_printf(rctx
->mem
, "Content-Length: %ld\r\n", req_len
) < 0)
344 if (!BIO_up_ref(req
))
350 int OSSL_HTTP_REQ_CTX_set1_req(OSSL_HTTP_REQ_CTX
*rctx
, const char *content_type
,
351 const ASN1_ITEM
*it
, const ASN1_VALUE
*req
)
357 res
= (mem
= ASN1_item_i2d_mem_bio(it
, req
)) != NULL
;
358 res
= res
&& set1_content(rctx
, content_type
, mem
);
363 void OSSL_HTTP_REQ_CTX_set_max_response_hdr_lines(OSSL_HTTP_REQ_CTX
*rctx
,
367 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
370 rctx
->max_hdr_lines
= count
;
373 static int add1_headers(OSSL_HTTP_REQ_CTX
*rctx
,
374 const STACK_OF(CONF_VALUE
) *headers
, const char *host
)
377 int add_host
= host
!= NULL
&& *host
!= '\0';
380 for (i
= 0; i
< sk_CONF_VALUE_num(headers
); i
++) {
381 hdr
= sk_CONF_VALUE_value(headers
, i
);
382 if (add_host
&& OPENSSL_strcasecmp("host", hdr
->name
) == 0)
384 if (!OSSL_HTTP_REQ_CTX_add1_header(rctx
, hdr
->name
, hdr
->value
))
388 if (add_host
&& !OSSL_HTTP_REQ_CTX_add1_header(rctx
, "Host", host
))
393 /* Create OSSL_HTTP_REQ_CTX structure using the values provided. */
394 static OSSL_HTTP_REQ_CTX
*http_req_ctx_new(int free_wbio
, BIO
*wbio
, BIO
*rbio
,
395 OSSL_HTTP_bio_cb_t bio_update_fn
,
396 void *arg
, int use_ssl
,
398 const char *server
, const char *port
,
399 int buf_size
, int overall_timeout
)
401 OSSL_HTTP_REQ_CTX
*rctx
= OSSL_HTTP_REQ_CTX_new(wbio
, rbio
, buf_size
);
405 rctx
->free_wbio
= free_wbio
;
406 rctx
->upd_fn
= bio_update_fn
;
408 rctx
->use_ssl
= use_ssl
;
410 && (rctx
->proxy
= OPENSSL_strdup(proxy
)) == NULL
)
413 && (rctx
->server
= OPENSSL_strdup(server
)) == NULL
)
416 && (rctx
->port
= OPENSSL_strdup(port
)) == NULL
)
418 rctx
->max_total_time
=
419 overall_timeout
> 0 ? time(NULL
) + overall_timeout
: 0;
423 OSSL_HTTP_REQ_CTX_free(rctx
);
428 * Parse first HTTP response line. This should be like this: "HTTP/1.0 200 OK".
429 * We need to obtain the status code and (optional) informational message.
430 * Return any received HTTP response status code, or 0 on fatal error.
433 static int parse_http_line1(char *line
, int *found_keep_alive
)
436 char *code
, *reason
, *end
;
438 if (!CHECK_AND_SKIP_PREFIX(line
, HTTP_PREFIX_VERSION
))
440 /* above HTTP 1.0, connection persistence is the default */
441 *found_keep_alive
= *line
> '0';
443 /* Skip to first whitespace (past protocol info) */
444 for (code
= line
; *code
!= '\0' && !ossl_isspace(*code
); code
++)
449 /* Skip past whitespace to start of response code */
450 while (*code
!= '\0' && ossl_isspace(*code
))
455 /* Find end of response code: first whitespace after start of code */
456 for (reason
= code
; *reason
!= '\0' && !ossl_isspace(*reason
); reason
++)
462 /* Set end of response code and start of message */
465 /* Attempt to parse numeric code */
466 retcode
= strtoul(code
, &end
, 10);
470 /* Skip over any leading whitespace in message */
471 while (*reason
!= '\0' && ossl_isspace(*reason
))
474 if (*reason
!= '\0') {
476 * Finally zap any trailing whitespace in message (include CRLF)
479 /* chop any trailing whitespace from reason */
480 /* We know reason has a non-whitespace character so this is OK */
481 for (end
= reason
+ strlen(reason
) - 1; ossl_isspace(*end
); end
--)
486 case HTTP_STATUS_CODE_OK
:
487 case HTTP_STATUS_CODE_MOVED_PERMANENTLY
:
488 case HTTP_STATUS_CODE_FOUND
:
491 if (retcode
< HTTP_STATUS_CODES_NONFATAL_ERROR
) {
492 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_STATUS_CODE_UNSUPPORTED
, "code=%s", code
);
494 ERR_add_error_data(2, ", reason=", reason
);
495 } /* must return content normally if status >= 400 */
500 for (i
= 0; i
< 60 && line
[i
] != '\0'; i
++)
501 if (!ossl_isprint(line
[i
]))
504 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_HEADER_PARSE_ERROR
, "content=%s", line
);
508 static int check_max_len(const char *desc
, size_t max_len
, size_t len
)
510 if (max_len
!= 0 && len
> max_len
) {
511 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_MAX_RESP_LEN_EXCEEDED
,
512 "%s length=%zu, max=%zu", desc
, len
, max_len
);
518 static int check_set_resp_len(const char *desc
, OSSL_HTTP_REQ_CTX
*rctx
, size_t len
)
520 if (!check_max_len(desc
, rctx
->max_resp_len
, len
))
522 if (rctx
->resp_len
!= 0 && rctx
->resp_len
!= len
) {
523 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_INCONSISTENT_CONTENT_LENGTH
,
524 "%s length=%zu, Content-Length=%zu", desc
, len
, rctx
->resp_len
);
527 rctx
->resp_len
= len
;
531 static int may_still_retry(time_t max_time
, int *ptimeout
)
533 time_t time_diff
, now
= time(NULL
);
536 if (max_time
< now
) {
537 ERR_raise(ERR_LIB_HTTP
, HTTP_R_RETRY_TIMEOUT
);
540 time_diff
= max_time
- now
;
541 *ptimeout
= time_diff
> INT_MAX
? INT_MAX
: (int)time_diff
;
547 * Try exchanging request and response via HTTP on (non-)blocking BIO in rctx.
548 * Returns 1 on success, 0 on error or redirection, -1 on BIO_should_retry.
550 int OSSL_HTTP_REQ_CTX_nbio(OSSL_HTTP_REQ_CTX
*rctx
)
552 int i
, found_expected_ct
= 0, found_keep_alive
= 0;
556 const unsigned char *p
;
557 char *buf
, *key
, *value
, *line_end
= NULL
;
558 size_t resp_hdr_lines
= 0;
561 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
564 if (rctx
->mem
== NULL
|| rctx
->wbio
== NULL
|| rctx
->rbio
== NULL
) {
565 ERR_raise(ERR_LIB_HTTP
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
569 rctx
->redirection_url
= NULL
;
571 buf
= (char *)rctx
->buf
;
572 if ((rctx
->state
& OHS_NOREAD
) == 0) {
573 if (rctx
->expect_asn1
&& (rctx
->state
== OHS_ASN1_HEADER
574 || rctx
->state
== OHS_ASN1_CONTENT
)) {
575 n
= BIO_read(rctx
->rbio
, buf
, rctx
->buf_size
);
576 } else { /* read one text line */
577 (void)ERR_set_mark();
578 n
= BIO_gets(rctx
->rbio
, buf
, rctx
->buf_size
);
579 if (n
== -2) { /* some BIOs, such as SSL, do not support "gets" */
580 (void)ERR_pop_to_mark();
581 n
= BIO_get_line(rctx
->rbio
, buf
, rctx
->buf_size
);
583 (void)ERR_clear_last_mark();
587 if (rctx
->state
== OHS_ERROR_CONTENT
) {
588 if (OSSL_TRACE_ENABLED(HTTP
))
589 OSSL_TRACE(HTTP
, "]\n"); /* end of error response content */
590 /* in addition, throw error on inconsistent length: */
591 (void)check_set_resp_len("error response content", rctx
, resp_len
);
594 if (BIO_should_retry(rctx
->rbio
))
596 ERR_raise(ERR_LIB_HTTP
, HTTP_R_FAILED_READING_DATA
);
600 /* Write data to memory BIO */
601 if (BIO_write(rctx
->mem
, buf
, n
) != n
)
605 switch (rctx
->state
) {
610 case OHS_ADD_HEADERS
:
611 /* Last operation was adding headers: need a final \r\n */
612 if (BIO_write(rctx
->mem
, "\r\n", 2) != 2) {
613 rctx
->state
= OHS_ERROR
;
616 rctx
->state
= OHS_WRITE_INIT
;
620 rctx
->len_to_send
= BIO_get_mem_data(rctx
->mem
, &rctx
->pos
);
621 rctx
->state
= OHS_WRITE_HDR1
;
626 /* Copy some chunk of data from rctx->mem to rctx->wbio */
628 /* Copy some chunk of data from rctx->req to rctx->wbio */
630 if (rctx
->len_to_send
> 0) {
633 if (!BIO_write_ex(rctx
->wbio
, rctx
->pos
, rctx
->len_to_send
, &sz
)) {
634 if (BIO_should_retry(rctx
->wbio
))
636 rctx
->state
= OHS_ERROR
;
639 if (OSSL_TRACE_ENABLED(HTTP
)) {
640 if (rctx
->state
== OHS_WRITE_HDR1
)
641 OSSL_TRACE(HTTP
, "Sending request header: [\n");
642 /* for request headers, this usually traces several lines at once: */
643 OSSL_TRACE_STRING(HTTP
, rctx
->state
!= OHS_WRITE_REQ
|| rctx
->text
,
644 rctx
->state
!= OHS_WRITE_REQ
, rctx
->pos
, sz
);
645 OSSL_TRACE(HTTP
, "]\n"); /* end of request header or content */
647 if (rctx
->state
== OHS_WRITE_HDR1
)
648 rctx
->state
= OHS_WRITE_HDR
;
650 rctx
->len_to_send
-= (long)sz
;
653 if (rctx
->state
== OHS_WRITE_HDR
) {
654 (void)BIO_reset(rctx
->mem
);
655 rctx
->state
= OHS_WRITE_REQ
;
657 if (rctx
->req
!= NULL
&& !BIO_eof(rctx
->req
)) {
658 if (OSSL_TRACE_ENABLED(HTTP
))
659 OSSL_TRACE1(HTTP
, "Sending request content (likely %s)\n",
660 rctx
->text
? "text" : "ASN.1");
661 n
= BIO_read(rctx
->req
, rctx
->buf
, rctx
->buf_size
);
663 if (BIO_should_retry(rctx
->req
))
665 ERR_raise(ERR_LIB_HTTP
, HTTP_R_FAILED_READING_DATA
);
668 rctx
->pos
= rctx
->buf
;
669 rctx
->len_to_send
= n
;
672 rctx
->state
= OHS_FLUSH
;
677 i
= BIO_flush(rctx
->wbio
);
680 rctx
->state
= OHS_FIRSTLINE
;
684 if (BIO_should_retry(rctx
->wbio
))
687 rctx
->state
= OHS_ERROR
;
690 /* State machine could be broken up at this point and bulky code sections factorized out. */
694 case OHS_HEADERS_ERROR
:
696 case OHS_ERROR_CONTENT
:
698 /* Attempt to read a line in */
701 * Due to strange memory BIO behavior with BIO_gets we have to check
702 * there's a complete line in there before calling BIO_gets or we'll
703 * just get a partial read.
705 n
= BIO_get_mem_data(rctx
->mem
, &p
);
706 if (n
<= 0 || memchr(p
, '\n', n
) == 0) {
707 if (n
>= rctx
->buf_size
) {
708 rctx
->state
= OHS_ERROR
;
713 n
= BIO_gets(rctx
->mem
, buf
, rctx
->buf_size
);
716 if (BIO_should_retry(rctx
->mem
))
718 rctx
->state
= OHS_ERROR
;
722 if (rctx
->state
== OHS_ERROR_CONTENT
) {
724 if (!check_max_len("error response content", rctx
->max_resp_len
, resp_len
))
726 if (OSSL_TRACE_ENABLED(HTTP
)) /* dump response content line */
727 OSSL_TRACE_STRING(HTTP
, got_text
, 1, (unsigned char *)buf
, n
);
732 if (rctx
->max_hdr_lines
!= 0 && rctx
->max_hdr_lines
< resp_hdr_lines
) {
733 ERR_raise(ERR_LIB_HTTP
, HTTP_R_RESPONSE_TOO_MANY_HDRLINES
);
734 rctx
->state
= OHS_ERROR
;
738 /* Don't allow excessive lines */
739 if (n
== rctx
->buf_size
) {
740 ERR_raise(ERR_LIB_HTTP
, HTTP_R_RESPONSE_LINE_TOO_LONG
);
741 rctx
->state
= OHS_ERROR
;
745 if (OSSL_TRACE_ENABLED(HTTP
)) {
746 /* dump all response header line */
747 if (rctx
->state
== OHS_FIRSTLINE
)
748 OSSL_TRACE(HTTP
, "Receiving response header: [\n");
749 OSSL_TRACE_STRING(HTTP
, 1, 1, (unsigned char *)buf
, n
);
752 /* First line in response header */
753 if (rctx
->state
== OHS_FIRSTLINE
) {
754 i
= parse_http_line1(buf
, &found_keep_alive
);
756 case HTTP_STATUS_CODE_OK
:
757 rctx
->state
= OHS_HEADERS
;
759 case HTTP_STATUS_CODE_MOVED_PERMANENTLY
:
760 case HTTP_STATUS_CODE_FOUND
: /* i.e., moved temporarily */
761 if (!rctx
->method_POST
) { /* method is GET */
762 rctx
->state
= OHS_REDIRECT
;
765 ERR_raise(ERR_LIB_HTTP
, HTTP_R_REDIRECTION_NOT_ENABLED
);
766 /* redirection is not supported/recommended for POST */
769 /* must return content if status >= 400 */
770 rctx
->state
= i
< HTTP_STATUS_CODES_NONFATAL_ERROR
771 ? OHS_HEADERS_ERROR
: OHS_HEADERS
;
772 goto next_line
; /* continue parsing, also on HTTP error */
776 value
= strchr(key
, ':');
779 while (ossl_isspace(*value
))
781 line_end
= strchr(value
, '\r');
782 if (line_end
== NULL
)
783 line_end
= strchr(value
, '\n');
784 if (line_end
!= NULL
)
787 if (value
!= NULL
&& line_end
!= NULL
) {
788 if (rctx
->state
== OHS_REDIRECT
789 && OPENSSL_strcasecmp(key
, "Location") == 0) {
790 rctx
->redirection_url
= value
;
791 if (OSSL_TRACE_ENABLED(HTTP
))
792 OSSL_TRACE(HTTP
, "]\n");
793 /* stop reading due to redirect */
794 (void)BIO_reset(rctx
->rbio
);
797 if (OPENSSL_strcasecmp(key
, "Content-Type") == 0) {
798 got_text
= HAS_CASE_PREFIX(value
, "text/");
799 if (rctx
->state
== OHS_HEADERS
800 && rctx
->expected_ct
!= NULL
) {
801 const char *semicolon
;
803 if (OPENSSL_strcasecmp(rctx
->expected_ct
, value
) != 0
804 /* ignore past ';' unless expected_ct contains ';' */
805 && (strchr(rctx
->expected_ct
, ';') != NULL
806 || (semicolon
= strchr(value
, ';')) == NULL
807 || (size_t)(semicolon
- value
) != strlen(rctx
->expected_ct
)
808 || OPENSSL_strncasecmp(rctx
->expected_ct
, value
,
809 semicolon
- value
) != 0)) {
810 ERR_raise_data(ERR_LIB_HTTP
,
811 HTTP_R_UNEXPECTED_CONTENT_TYPE
,
812 "expected=%s, actual=%s",
813 rctx
->expected_ct
, value
);
816 found_expected_ct
= 1;
820 /* https://tools.ietf.org/html/rfc7230#section-6.3 Persistence */
821 if (OPENSSL_strcasecmp(key
, "Connection") == 0) {
822 if (OPENSSL_strcasecmp(value
, "keep-alive") == 0)
823 found_keep_alive
= 1;
824 else if (OPENSSL_strcasecmp(value
, "close") == 0)
825 found_keep_alive
= 0;
826 } else if (OPENSSL_strcasecmp(key
, "Content-Length") == 0) {
827 size_t content_len
= (size_t)strtoul(value
, &line_end
, 10);
829 if (line_end
== value
|| *line_end
!= '\0') {
830 ERR_raise_data(ERR_LIB_HTTP
,
831 HTTP_R_ERROR_PARSING_CONTENT_LENGTH
,
835 if (!check_set_resp_len("response content-length", rctx
, content_len
))
840 /* Look for blank line indicating end of headers */
841 for (p
= rctx
->buf
; *p
!= '\0'; p
++) {
842 if (*p
!= '\r' && *p
!= '\n')
845 if (*p
!= '\0') /* not end of headers or not end of error reponse content */
848 /* Found blank line(s) indicating end of headers */
849 if (OSSL_TRACE_ENABLED(HTTP
))
850 OSSL_TRACE(HTTP
, "]\n"); /* end of response header */
852 if (rctx
->keep_alive
!= 0 /* do not let server initiate keep_alive */
853 && !found_keep_alive
/* otherwise there is no change */) {
854 if (rctx
->keep_alive
== 2) {
855 rctx
->keep_alive
= 0;
856 ERR_raise(ERR_LIB_HTTP
, HTTP_R_SERVER_CANCELED_CONNECTION
);
859 rctx
->keep_alive
= 0;
862 if (rctx
->state
== OHS_HEADERS_ERROR
) {
863 rctx
->state
= OHS_ERROR_CONTENT
;
864 if (OSSL_TRACE_ENABLED(HTTP
)) {
865 OSSL_TRACE1(HTTP
, "Receiving error response content (likely %s): [\n",
866 got_text
? "text" : "ASN.1");
869 /* discard response content when trace not enabled */
870 (void)BIO_reset(rctx
->rbio
);
874 if (rctx
->expected_ct
!= NULL
&& !found_expected_ct
) {
875 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_MISSING_CONTENT_TYPE
,
876 "expected=%s", rctx
->expected_ct
);
879 if (rctx
->state
== OHS_REDIRECT
) {
880 /* http status code indicated redirect but there was no Location */
881 ERR_raise(ERR_LIB_HTTP
, HTTP_R_MISSING_REDIRECT_LOCATION
);
885 /* Note: in non-error situations cannot trace response content */
886 if (!rctx
->expect_asn1
) {
887 if (OSSL_TRACE_ENABLED(HTTP
))
888 OSSL_TRACE(HTTP
, "Receiving response text content\n");
889 rctx
->state
= OHS_STREAM
;
893 if (OSSL_TRACE_ENABLED(HTTP
))
894 OSSL_TRACE(HTTP
, "Receiving response ASN.1 content\n");
895 rctx
->state
= OHS_ASN1_HEADER
;
898 case OHS_ASN1_HEADER
:
900 * Now reading ASN1 header: can read at least 2 bytes which is enough
901 * for ASN1 SEQUENCE header and either length field or at least the
902 * length of the length field.
904 n
= BIO_get_mem_data(rctx
->mem
, &p
);
908 /* Check it is an ASN1 SEQUENCE */
909 if (*p
++ != (V_ASN1_SEQUENCE
| V_ASN1_CONSTRUCTED
)) {
910 ERR_raise(ERR_LIB_HTTP
, HTTP_R_MISSING_ASN1_ENCODING
);
914 /* Check out length field */
915 if ((*p
& 0x80) != 0) {
917 * If MSB set on initial length octet we can now always read 6
918 * octets: make sure we have them.
923 /* Not NDEF or excessive length */
924 if (n
== 0 || (n
> 4)) {
925 ERR_raise(ERR_LIB_HTTP
, HTTP_R_ERROR_PARSING_ASN1_LENGTH
);
930 for (i
= 0; i
< n
; i
++) {
938 if (!check_set_resp_len("ASN.1 DER content", rctx
, resp_len
))
941 if (OSSL_TRACE_ENABLED(HTTP
))
942 OSSL_TRACE1(HTTP
, "Expected response ASN.1 DER content length: %zd\n", resp_len
);
943 rctx
->state
= OHS_ASN1_CONTENT
;
946 case OHS_ASN1_CONTENT
:
947 n
= BIO_get_mem_data(rctx
->mem
, NULL
);
948 if (n
< 0 || (size_t)n
< rctx
->resp_len
)
951 if (OSSL_TRACE_ENABLED(HTTP
))
952 OSSL_TRACE(HTTP
, "Finished receiving response ASN.1 content\n");
953 rctx
->state
= OHS_ASN1_DONE
;
958 int OSSL_HTTP_REQ_CTX_nbio_d2i(OSSL_HTTP_REQ_CTX
*rctx
,
959 ASN1_VALUE
**pval
, const ASN1_ITEM
*it
)
961 const unsigned char *p
;
965 if ((rv
= OSSL_HTTP_REQ_CTX_nbio(rctx
)) != 1)
967 *pval
= ASN1_item_d2i(NULL
, &p
, BIO_get_mem_data(rctx
->mem
, &p
), it
);
968 return *pval
!= NULL
;
972 #ifndef OPENSSL_NO_SOCK
974 static const char *explict_or_default_port(const char *hostserv
, const char *port
, int use_ssl
)
977 char *service
= NULL
;
979 if (!BIO_parse_hostserv(hostserv
, NULL
, &service
, BIO_PARSE_PRIO_HOST
))
981 if (service
== NULL
) /* implicit port */
982 port
= use_ssl
? OSSL_HTTPS_PORT
: OSSL_HTTP_PORT
;
983 OPENSSL_free(service
);
984 } /* otherwise take the explicitly given port */
988 /* set up a new connection BIO, to HTTP server or to HTTP(S) proxy if given */
989 static BIO
*http_new_bio(const char *server
/* optionally includes ":port" */,
990 const char *server_port
/* explicit server port */,
992 const char *proxy
/* optionally includes ":port" */,
993 const char *proxy_port
/* explicit proxy port */)
995 const char *host
= server
;
996 const char *port
= server_port
;
999 if (!ossl_assert(server
!= NULL
))
1002 if (proxy
!= NULL
) {
1007 port
= explict_or_default_port(host
, port
, use_ssl
);
1009 cbio
= BIO_new_connect(host
/* optionally includes ":port" */);
1013 (void)BIO_set_conn_port(cbio
, port
);
1018 #endif /* OPENSSL_NO_SOCK */
1020 /* Exchange request and response via HTTP on (non-)blocking BIO */
1021 BIO
*OSSL_HTTP_REQ_CTX_exchange(OSSL_HTTP_REQ_CTX
*rctx
)
1026 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
1031 rv
= OSSL_HTTP_REQ_CTX_nbio(rctx
);
1034 /* BIO_should_retry was true */
1035 /* will not actually wait if rctx->max_time == 0 */
1036 if (BIO_wait(rctx
->rbio
, rctx
->max_time
, 100 /* milliseconds */) <= 0)
1041 if (rctx
->redirection_url
== NULL
) { /* an error occurred */
1042 if (rctx
->len_to_send
> 0)
1043 ERR_raise(ERR_LIB_HTTP
, HTTP_R_ERROR_SENDING
);
1045 ERR_raise(ERR_LIB_HTTP
, HTTP_R_ERROR_RECEIVING
);
1049 return rctx
->state
== OHS_STREAM
? rctx
->rbio
: rctx
->mem
;
1052 int OSSL_HTTP_is_alive(const OSSL_HTTP_REQ_CTX
*rctx
)
1054 return rctx
!= NULL
&& rctx
->keep_alive
!= 0;
1057 /* High-level HTTP API implementation */
1059 /* Initiate an HTTP session using bio, else use given server, proxy, etc. */
1060 OSSL_HTTP_REQ_CTX
*OSSL_HTTP_open(const char *server
, const char *port
,
1061 const char *proxy
, const char *no_proxy
,
1062 int use_ssl
, BIO
*bio
, BIO
*rbio
,
1063 OSSL_HTTP_bio_cb_t bio_update_fn
, void *arg
,
1064 int buf_size
, int overall_timeout
)
1066 BIO
*cbio
; /* == bio if supplied, used as connection BIO if rbio is NULL */
1067 OSSL_HTTP_REQ_CTX
*rctx
= NULL
;
1069 if (use_ssl
&& bio_update_fn
== NULL
) {
1070 ERR_raise(ERR_LIB_HTTP
, HTTP_R_TLS_NOT_ENABLED
);
1073 if (rbio
!= NULL
&& (bio
== NULL
|| bio_update_fn
!= NULL
)) {
1074 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_INVALID_ARGUMENT
);
1080 if (proxy
!= NULL
|| no_proxy
!= NULL
) {
1081 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_INVALID_ARGUMENT
);
1085 #ifndef OPENSSL_NO_SOCK
1086 char *proxy_host
= NULL
, *proxy_port
= NULL
;
1088 if (server
== NULL
) {
1089 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
1092 if (port
!= NULL
&& *port
== '\0')
1094 proxy
= OSSL_HTTP_adapt_proxy(proxy
, no_proxy
, server
, use_ssl
);
1096 && !OSSL_HTTP_parse_url(proxy
, NULL
/* use_ssl */, NULL
/* user */,
1097 &proxy_host
, &proxy_port
, NULL
/* num */,
1098 NULL
/* path */, NULL
, NULL
))
1100 cbio
= http_new_bio(server
, port
, use_ssl
, proxy_host
, proxy_port
);
1101 OPENSSL_free(proxy_host
);
1102 OPENSSL_free(proxy_port
);
1106 ERR_raise(ERR_LIB_HTTP
, HTTP_R_SOCK_NOT_SUPPORTED
);
1111 (void)ERR_set_mark(); /* prepare removing any spurious libssl errors */
1112 if (rbio
== NULL
&& BIO_do_connect_retry(cbio
, overall_timeout
, -1) <= 0) {
1113 if (bio
== NULL
) /* cbio was not provided by caller */
1117 /* now overall_timeout is guaranteed to be >= 0 */
1119 /* adapt in order to fix callback design flaw, see #17088 */
1120 /* callback can be used to wrap or prepend TLS session */
1121 if (bio_update_fn
!= NULL
) {
1122 BIO
*orig_bio
= cbio
;
1124 cbio
= (*bio_update_fn
)(cbio
, arg
, 1 /* connect */, use_ssl
!= 0);
1126 if (bio
== NULL
) /* cbio was not provided by caller */
1127 BIO_free_all(orig_bio
);
1132 rctx
= http_req_ctx_new(bio
== NULL
, cbio
, rbio
!= NULL
? rbio
: cbio
,
1133 bio_update_fn
, arg
, use_ssl
, proxy
, server
, port
,
1134 buf_size
, overall_timeout
);
1138 /* remove any spurious error queue entries by ssl_add_cert_chain() */
1139 (void)ERR_pop_to_mark();
1141 (void)ERR_clear_last_mark();
1146 int OSSL_HTTP_set1_request(OSSL_HTTP_REQ_CTX
*rctx
, const char *path
,
1147 const STACK_OF(CONF_VALUE
) *headers
,
1148 const char *content_type
, BIO
*req
,
1149 const char *expected_content_type
, int expect_asn1
,
1150 size_t max_resp_len
, int timeout
, int keep_alive
)
1155 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
1158 use_http_proxy
= rctx
->proxy
!= NULL
&& !rctx
->use_ssl
;
1159 if (use_http_proxy
&& rctx
->server
== NULL
) {
1160 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_INVALID_ARGUMENT
);
1163 rctx
->max_resp_len
= max_resp_len
; /* allows for 0: indefinite */
1165 return OSSL_HTTP_REQ_CTX_set_request_line(rctx
, req
!= NULL
,
1166 use_http_proxy
? rctx
->server
1167 : NULL
, rctx
->port
, path
)
1168 && add1_headers(rctx
, headers
, rctx
->server
)
1169 && OSSL_HTTP_REQ_CTX_set_expected(rctx
, expected_content_type
,
1170 expect_asn1
, timeout
, keep_alive
)
1171 && set1_content(rctx
, content_type
, req
);
1175 * Exchange single HTTP request and response according to rctx.
1176 * If rctx->method_POST then use POST, else use GET and ignore content_type.
1177 * The redirection_url output (freed by caller) parameter is used only for GET.
1179 BIO
*OSSL_HTTP_exchange(OSSL_HTTP_REQ_CTX
*rctx
, char **redirection_url
)
1184 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
1188 if (redirection_url
!= NULL
)
1189 *redirection_url
= NULL
; /* do this beforehand to prevent dbl free */
1191 resp
= OSSL_HTTP_REQ_CTX_exchange(rctx
);
1193 if (rctx
->redirection_url
!= NULL
) {
1194 if (redirection_url
== NULL
)
1195 ERR_raise(ERR_LIB_HTTP
, HTTP_R_REDIRECTION_NOT_ENABLED
);
1197 /* may be NULL if out of memory: */
1198 *redirection_url
= OPENSSL_strdup(rctx
->redirection_url
);
1201 unsigned long err
= ERR_peek_error();
1202 int lib
= ERR_GET_LIB(err
);
1203 int reason
= ERR_GET_REASON(err
);
1205 if (lib
== ERR_LIB_SSL
|| lib
== ERR_LIB_HTTP
1206 || (lib
== ERR_LIB_BIO
&& reason
== BIO_R_CONNECT_TIMEOUT
)
1207 || (lib
== ERR_LIB_BIO
&& reason
== BIO_R_CONNECT_ERROR
)
1208 #ifndef OPENSSL_NO_CMP
1209 || (lib
== ERR_LIB_CMP
1210 && reason
== CMP_R_POTENTIALLY_INVALID_CERTIFICATE
)
1213 if (rctx
->server
!= NULL
&& *rctx
->server
!= '\0') {
1214 BIO_snprintf(buf
, sizeof(buf
), "server=http%s://%s%s%s",
1215 rctx
->use_ssl
? "s" : "", rctx
->server
,
1216 rctx
->port
!= NULL
? ":" : "",
1217 rctx
->port
!= NULL
? rctx
->port
: "");
1218 ERR_add_error_data(1, buf
);
1220 if (rctx
->proxy
!= NULL
)
1221 ERR_add_error_data(2, " proxy=", rctx
->proxy
);
1223 BIO_snprintf(buf
, sizeof(buf
), " peer has disconnected%s",
1224 rctx
->use_ssl
? " violating the protocol" :
1225 ", likely because it requires the use of TLS");
1226 ERR_add_error_data(1, buf
);
1232 if (resp
!= NULL
&& !BIO_up_ref(resp
))
1237 static int redirection_ok(int n_redir
, const char *old_url
, const char *new_url
)
1239 if (n_redir
>= HTTP_VERSION_MAX_REDIRECTIONS
) {
1240 ERR_raise(ERR_LIB_HTTP
, HTTP_R_TOO_MANY_REDIRECTIONS
);
1243 if (*new_url
== '/') /* redirection to same server => same protocol */
1245 if (HAS_PREFIX(old_url
, OSSL_HTTPS_NAME
":") &&
1246 !HAS_PREFIX(new_url
, OSSL_HTTPS_NAME
":")) {
1247 ERR_raise(ERR_LIB_HTTP
, HTTP_R_REDIRECTION_FROM_HTTPS_TO_HTTP
);
1253 /* Get data via HTTP from server at given URL, potentially with redirection */
1254 BIO
*OSSL_HTTP_get(const char *url
, const char *proxy
, const char *no_proxy
,
1255 BIO
*bio
, BIO
*rbio
,
1256 OSSL_HTTP_bio_cb_t bio_update_fn
, void *arg
,
1257 int buf_size
, const STACK_OF(CONF_VALUE
) *headers
,
1258 const char *expected_ct
, int expect_asn1
,
1259 size_t max_resp_len
, int timeout
)
1268 time_t max_time
= timeout
> 0 ? time(NULL
) + timeout
: 0;
1271 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
1274 if ((current_url
= OPENSSL_strdup(url
)) == NULL
)
1278 OSSL_HTTP_REQ_CTX
*rctx
;
1279 char *redirection_url
;
1281 if (!OSSL_HTTP_parse_url(current_url
, &use_ssl
, NULL
/* user */, &host
,
1282 &port
, NULL
/* port_num */, &path
, NULL
, NULL
))
1285 rctx
= OSSL_HTTP_open(host
, port
, proxy
, no_proxy
,
1286 use_ssl
, bio
, rbio
, bio_update_fn
, arg
,
1289 redirection_url
= NULL
;
1291 if (!OSSL_HTTP_set1_request(rctx
, path
, headers
,
1292 NULL
/* content_type */,
1294 expected_ct
, expect_asn1
, max_resp_len
,
1295 -1 /* use same max time (timeout) */,
1296 0 /* no keep_alive */)) {
1297 OSSL_HTTP_REQ_CTX_free(rctx
);
1300 resp
= OSSL_HTTP_exchange(rctx
, &redirection_url
);
1304 if (resp
== NULL
&& redirection_url
!= NULL
) {
1305 if (redirection_ok(++n_redirs
, current_url
, redirection_url
)
1306 && may_still_retry(max_time
, &timeout
)) {
1307 (void)BIO_reset(bio
);
1308 OPENSSL_free(current_url
);
1309 current_url
= redirection_url
;
1310 if (*redirection_url
== '/') { /* redirection to same server */
1311 path
= OPENSSL_strdup(redirection_url
);
1315 (void)OSSL_HTTP_close(rctx
, 1);
1317 OPENSSL_free(current_url
);
1324 (void)OSSL_HTTP_close(rctx
, 1);
1327 /* if redirection not allowed, ignore it */
1328 OPENSSL_free(redirection_url
);
1332 if (!OSSL_HTTP_close(rctx
, resp
!= NULL
)) {
1338 OPENSSL_free(current_url
);
1342 /* Exchange request and response over a connection managed via |prctx| */
1343 BIO
*OSSL_HTTP_transfer(OSSL_HTTP_REQ_CTX
**prctx
,
1344 const char *server
, const char *port
,
1345 const char *path
, int use_ssl
,
1346 const char *proxy
, const char *no_proxy
,
1347 BIO
*bio
, BIO
*rbio
,
1348 OSSL_HTTP_bio_cb_t bio_update_fn
, void *arg
,
1349 int buf_size
, const STACK_OF(CONF_VALUE
) *headers
,
1350 const char *content_type
, BIO
*req
,
1351 const char *expected_ct
, int expect_asn1
,
1352 size_t max_resp_len
, int timeout
, int keep_alive
)
1354 OSSL_HTTP_REQ_CTX
*rctx
= prctx
== NULL
? NULL
: *prctx
;
1358 rctx
= OSSL_HTTP_open(server
, port
, proxy
, no_proxy
,
1359 use_ssl
, bio
, rbio
, bio_update_fn
, arg
,
1361 timeout
= -1; /* Already set during opening the connection */
1364 if (OSSL_HTTP_set1_request(rctx
, path
, headers
, content_type
, req
,
1365 expected_ct
, expect_asn1
,
1366 max_resp_len
, timeout
, keep_alive
))
1367 resp
= OSSL_HTTP_exchange(rctx
, NULL
);
1368 if (resp
== NULL
|| !OSSL_HTTP_is_alive(rctx
)) {
1369 if (!OSSL_HTTP_close(rctx
, resp
!= NULL
)) {
1381 int OSSL_HTTP_close(OSSL_HTTP_REQ_CTX
*rctx
, int ok
)
1386 /* callback can be used to finish TLS session and free its BIO */
1387 if (rctx
!= NULL
&& rctx
->upd_fn
!= NULL
) {
1388 wbio
= (*rctx
->upd_fn
)(rctx
->wbio
, rctx
->upd_arg
,
1389 0 /* disconnect */, ok
);
1394 OSSL_HTTP_REQ_CTX_free(rctx
);
1398 /* BASE64 encoder used for encoding basic proxy authentication credentials */
1399 static char *base64encode(const void *buf
, size_t len
)
1407 /* Calculate size of encoded data */
1412 out
= OPENSSL_malloc(outl
+ 1);
1416 i
= EVP_EncodeBlock((unsigned char *)out
, buf
, (int)len
);
1417 if (!ossl_assert(0 <= i
&& (size_t)i
<= outl
)) {
1425 * Promote the given connection BIO using the CONNECT method for a TLS proxy.
1426 * This is typically called by an app, so bio_err and prog are used unless NULL
1427 * to print additional diagnostic information in a user-oriented way.
1429 int OSSL_HTTP_proxy_connect(BIO
*bio
, const char *server
, const char *port
,
1430 const char *proxyuser
, const char *proxypass
,
1431 int timeout
, BIO
*bio_err
, const char *prog
)
1434 #define BUF_SIZE (8 * 1024)
1435 char *mbuf
= OPENSSL_malloc(BUF_SIZE
);
1439 BIO
*fbio
= BIO_new(BIO_f_buffer());
1441 time_t max_time
= timeout
> 0 ? time(NULL
) + timeout
: 0;
1443 if (bio
== NULL
|| server
== NULL
1444 || (bio_err
!= NULL
&& prog
== NULL
)) {
1445 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
1448 if (port
== NULL
|| *port
== '\0')
1449 port
= OSSL_HTTPS_PORT
;
1451 if (mbuf
== NULL
|| fbio
== NULL
) {
1452 BIO_printf(bio_err
/* may be NULL */, "%s: out of memory", prog
);
1455 BIO_push(fbio
, bio
);
1457 BIO_printf(fbio
, "CONNECT %s:%s "HTTP_1_0
"\r\n", server
, port
);
1460 * Workaround for broken proxies which would otherwise close
1461 * the connection when entering tunnel mode (e.g., Squid 2.6)
1463 BIO_printf(fbio
, "Proxy-Connection: Keep-Alive\r\n");
1465 /* Support for basic (base64) proxy authentication */
1466 if (proxyuser
!= NULL
) {
1467 size_t len
= strlen(proxyuser
) + 1;
1468 char *proxyauth
, *proxyauthenc
= NULL
;
1470 if (proxypass
!= NULL
)
1471 len
+= strlen(proxypass
);
1472 proxyauth
= OPENSSL_malloc(len
+ 1);
1473 if (proxyauth
== NULL
)
1475 if (BIO_snprintf(proxyauth
, len
+ 1, "%s:%s", proxyuser
,
1476 proxypass
!= NULL
? proxypass
: "") != (int)len
)
1478 proxyauthenc
= base64encode(proxyauth
, len
);
1479 if (proxyauthenc
!= NULL
) {
1480 BIO_printf(fbio
, "Proxy-Authorization: Basic %s\r\n", proxyauthenc
);
1481 OPENSSL_clear_free(proxyauthenc
, strlen(proxyauthenc
));
1484 OPENSSL_clear_free(proxyauth
, len
);
1485 if (proxyauthenc
== NULL
)
1489 /* Terminate the HTTP CONNECT request */
1490 BIO_printf(fbio
, "\r\n");
1493 if (BIO_flush(fbio
) != 0)
1495 /* potentially needs to be retried if BIO is non-blocking */
1496 if (!BIO_should_retry(fbio
))
1501 /* will not actually wait if timeout == 0 */
1502 rv
= BIO_wait(fbio
, max_time
, 100 /* milliseconds */);
1504 BIO_printf(bio_err
, "%s: HTTP CONNECT %s\n", prog
,
1505 rv
== 0 ? "timed out" : "failed waiting for data");
1510 * The first line is the HTTP response.
1511 * According to RFC 7230, it is formatted exactly like this:
1512 * HTTP/d.d ddd reason text\r\n
1514 read_len
= BIO_gets(fbio
, mbuf
, BUF_SIZE
);
1515 /* the BIO may not block, so we must wait for the 1st line to come in */
1516 if (read_len
< (int)HTTP_LINE1_MINLEN
)
1519 /* Check for HTTP/1.x */
1521 if (!CHECK_AND_SKIP_PREFIX(mbufp
, HTTP_PREFIX
)) {
1522 ERR_raise(ERR_LIB_HTTP
, HTTP_R_HEADER_PARSE_ERROR
);
1523 BIO_printf(bio_err
, "%s: HTTP CONNECT failed, non-HTTP response\n",
1525 /* Wrong protocol, not even HTTP, so stop reading headers */
1528 if (!HAS_PREFIX(mbufp
, HTTP_VERSION_PATT
)) {
1529 ERR_raise(ERR_LIB_HTTP
, HTTP_R_RECEIVED_WRONG_HTTP_VERSION
);
1531 "%s: HTTP CONNECT failed, bad HTTP version %.*s\n",
1532 prog
, (int)HTTP_VERSION_STR_LEN
, mbufp
);
1535 mbufp
+= HTTP_VERSION_STR_LEN
;
1537 /* RFC 7231 4.3.6: any 2xx status code is valid */
1538 if (!HAS_PREFIX(mbufp
, " 2")) {
1539 if (ossl_isspace(*mbufp
))
1541 /* chop any trailing whitespace */
1542 while (read_len
> 0 && ossl_isspace(mbuf
[read_len
- 1]))
1544 mbuf
[read_len
] = '\0';
1545 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_CONNECT_FAILURE
,
1546 "reason=%s", mbufp
);
1547 BIO_printf(bio_err
, "%s: HTTP CONNECT failed, reason=%s\n",
1555 /* Read past all following headers */
1558 * This does not necessarily catch the case when the full
1559 * HTTP response came in more than a single TCP message.
1561 read_len
= BIO_gets(fbio
, mbuf
, BUF_SIZE
);
1562 } while (read_len
> 2);
1566 (void)BIO_flush(fbio
);