2 * Copyright 2001-2022 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
39 /* Stateful HTTP request code, supporting blocking and non-blocking I/O */
41 /* Opaque HTTP request status structure */
43 struct ossl_http_req_ctx_st {
44 int state; /* Current I/O state */
45 unsigned char *buf; /* Buffer to write request or read response */
46 int buf_size; /* Buffer size */
47 int free_wbio; /* wbio allocated internally, free with ctx */
48 BIO *wbio; /* BIO to write/send request to */
49 BIO *rbio; /* BIO to read/receive response from */
50 OSSL_HTTP_bio_cb_t upd_fn; /* Optional BIO update callback used for TLS */
51 void *upd_arg; /* Optional arg for update callback function */
52 int use_ssl; /* Use HTTPS */
53 char *proxy; /* Optional proxy name or URI */
54 char *server; /* Optional server host name */
55 char *port; /* Optional server port */
56 BIO *mem; /* Memory BIO holding request/response header */
57 BIO *req; /* BIO holding the request provided by caller */
58 int method_POST; /* HTTP method is POST (else GET) */
59 char *expected_ct; /* Optional expected Content-Type */
60 int expect_asn1; /* Response must be ASN.1-encoded */
61 unsigned char *pos; /* Current position sending data */
62 long len_to_send; /* Number of bytes still to send */
63 size_t resp_len; /* Length of response */
64 size_t max_resp_len; /* Maximum length of response, or 0 */
65 int keep_alive; /* Persistent conn. 0=no, 1=prefer, 2=require */
66 time_t max_time; /* Maximum end time of current transfer, or 0 */
67 time_t max_total_time; /* Maximum end time of total transfer, or 0 */
68 char *redirection_url; /* Location obtained from HTTP status 301/302 */
73 #define OHS_NOREAD 0x1000 /* If set no reading should be performed */
74 #define OHS_ERROR (0 | OHS_NOREAD) /* Error condition */
75 #define OHS_ADD_HEADERS (1 | OHS_NOREAD) /* Adding header lines to request */
76 #define OHS_WRITE_INIT (2 | OHS_NOREAD) /* 1st call: ready to start send */
77 #define OHS_WRITE_HDR (3 | OHS_NOREAD) /* Request header being sent */
78 #define OHS_WRITE_REQ (4 | OHS_NOREAD) /* Request contents being sent */
79 #define OHS_FLUSH (5 | OHS_NOREAD) /* Request being flushed */
80 #define OHS_FIRSTLINE 1 /* First line of response being read */
81 #define OHS_HEADERS 2 /* MIME headers of response being read */
82 #define OHS_REDIRECT 3 /* MIME headers being read, expecting Location */
83 #define OHS_ASN1_HEADER 4 /* ASN1 sequence header (tag+length) being read */
84 #define OHS_ASN1_CONTENT 5 /* ASN1 content octets being read */
85 #define OHS_ASN1_DONE (6 | OHS_NOREAD) /* ASN1 content read completed */
86 #define OHS_STREAM (7 | OHS_NOREAD) /* HTTP content stream to be read */
88 /* Low-level HTTP API implementation */
90 OSSL_HTTP_REQ_CTX *OSSL_HTTP_REQ_CTX_new(BIO *wbio, BIO *rbio, int buf_size)
92 OSSL_HTTP_REQ_CTX *rctx;
94 if (wbio == NULL || rbio == NULL) {
95 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
99 if ((rctx = OPENSSL_zalloc(sizeof(*rctx))) == NULL)
101 rctx->state = OHS_ERROR;
102 rctx->buf_size = buf_size > 0 ? buf_size : OSSL_HTTP_DEFAULT_MAX_LINE_LEN;
103 rctx->buf = OPENSSL_malloc(rctx->buf_size);
106 if (rctx->buf == NULL) {
110 rctx->max_resp_len = OSSL_HTTP_DEFAULT_MAX_RESP_LEN;
111 /* everything else is 0, e.g. rctx->len_to_send, or NULL, e.g. rctx->mem */
115 void OSSL_HTTP_REQ_CTX_free(OSSL_HTTP_REQ_CTX *rctx)
120 * Use BIO_free_all() because bio_update_fn may prepend or append to cbio.
121 * This also frees any (e.g., SSL/TLS) BIOs linked with bio and,
122 * like BIO_reset(bio), calls SSL_shutdown() to notify/alert the peer.
125 BIO_free_all(rctx->wbio);
126 /* do not free rctx->rbio */
129 OPENSSL_free(rctx->buf);
130 OPENSSL_free(rctx->proxy);
131 OPENSSL_free(rctx->server);
132 OPENSSL_free(rctx->port);
133 OPENSSL_free(rctx->expected_ct);
137 BIO *OSSL_HTTP_REQ_CTX_get0_mem_bio(const OSSL_HTTP_REQ_CTX *rctx)
140 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
146 size_t OSSL_HTTP_REQ_CTX_get_resp_len(const OSSL_HTTP_REQ_CTX *rctx)
149 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
152 return rctx->resp_len;
155 void OSSL_HTTP_REQ_CTX_set_max_response_length(OSSL_HTTP_REQ_CTX *rctx,
159 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
162 rctx->max_resp_len = len != 0 ? (size_t)len : OSSL_HTTP_DEFAULT_MAX_RESP_LEN;
166 * Create request line using |rctx| and |path| (or "/" in case |path| is NULL).
167 * Server name (and port) must be given if and only if plain HTTP proxy is used.
169 int OSSL_HTTP_REQ_CTX_set_request_line(OSSL_HTTP_REQ_CTX *rctx, int method_POST,
170 const char *server, const char *port,
174 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
178 if ((rctx->mem = BIO_new(BIO_s_mem())) == NULL)
181 rctx->method_POST = method_POST != 0;
182 if (BIO_printf(rctx->mem, "%s ", rctx->method_POST ? "POST" : "GET") <= 0)
185 if (server != NULL) { /* HTTP (but not HTTPS) proxy is used */
187 * Section 5.1.2 of RFC 1945 states that the absoluteURI form is only
188 * allowed when using a proxy
190 if (BIO_printf(rctx->mem, OSSL_HTTP_PREFIX"%s", server) <= 0)
192 if (port != NULL && BIO_printf(rctx->mem, ":%s", port) <= 0)
196 /* Make sure path includes a forward slash */
199 if (path[0] != '/' && BIO_printf(rctx->mem, "/") <= 0)
202 * Add (the rest of) the path and the HTTP version,
203 * which is fixed to 1.0 for straightforward implementation of keep-alive
205 if (BIO_printf(rctx->mem, "%s "HTTP_1_0"\r\n", path) <= 0)
209 rctx->state = OHS_ADD_HEADERS;
213 int OSSL_HTTP_REQ_CTX_add1_header(OSSL_HTTP_REQ_CTX *rctx,
214 const char *name, const char *value)
216 if (rctx == NULL || name == NULL) {
217 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
220 if (rctx->mem == NULL) {
221 ERR_raise(ERR_LIB_HTTP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
225 if (BIO_puts(rctx->mem, name) <= 0)
228 if (BIO_write(rctx->mem, ": ", 2) != 2)
230 if (BIO_puts(rctx->mem, value) <= 0)
233 return BIO_write(rctx->mem, "\r\n", 2) == 2;
236 int OSSL_HTTP_REQ_CTX_set_expected(OSSL_HTTP_REQ_CTX *rctx,
237 const char *content_type, int asn1,
238 int timeout, int keep_alive)
241 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
245 && rctx->state != OHS_ERROR && rctx->state != OHS_ADD_HEADERS) {
246 /* Cannot anymore set keep-alive in request header */
247 ERR_raise(ERR_LIB_HTTP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
251 OPENSSL_free(rctx->expected_ct);
252 rctx->expected_ct = NULL;
253 if (content_type != NULL
254 && (rctx->expected_ct = OPENSSL_strdup(content_type)) == NULL)
257 rctx->expect_asn1 = asn1;
259 rctx->max_time = timeout > 0 ? time(NULL) + timeout : 0;
260 else /* take over any |overall_timeout| arg of OSSL_HTTP_open(), else 0 */
261 rctx->max_time = rctx->max_total_time;
262 rctx->keep_alive = keep_alive;
266 static int set1_content(OSSL_HTTP_REQ_CTX *rctx,
267 const char *content_type, BIO *req)
271 if (rctx == NULL || (req == NULL && content_type != NULL)) {
272 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
276 if (rctx->keep_alive != 0
277 && !OSSL_HTTP_REQ_CTX_add1_header(rctx, "Connection", "keep-alive"))
284 if (!rctx->method_POST) {
285 ERR_raise(ERR_LIB_HTTP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
289 if (content_type != NULL
290 && BIO_printf(rctx->mem, "Content-Type: %s\r\n", content_type) <= 0)
293 /* streaming BIO may not support querying size */
294 if (((req_len = BIO_ctrl(req, BIO_CTRL_INFO, 0, NULL)) <= 0
295 || BIO_printf(rctx->mem, "Content-Length: %ld\r\n", req_len) > 0)
296 && BIO_up_ref(req)) {
303 int OSSL_HTTP_REQ_CTX_set1_req(OSSL_HTTP_REQ_CTX *rctx, const char *content_type,
304 const ASN1_ITEM *it, const ASN1_VALUE *req)
310 res = (mem = ASN1_item_i2d_mem_bio(it, req)) != NULL;
311 res = res && set1_content(rctx, content_type, mem);
316 static int add1_headers(OSSL_HTTP_REQ_CTX *rctx,
317 const STACK_OF(CONF_VALUE) *headers, const char *host)
320 int add_host = host != NULL && *host != '\0';
323 for (i = 0; i < sk_CONF_VALUE_num(headers); i++) {
324 hdr = sk_CONF_VALUE_value(headers, i);
325 if (add_host && OPENSSL_strcasecmp("host", hdr->name) == 0)
327 if (!OSSL_HTTP_REQ_CTX_add1_header(rctx, hdr->name, hdr->value))
331 if (add_host && !OSSL_HTTP_REQ_CTX_add1_header(rctx, "Host", host))
336 /* Create OSSL_HTTP_REQ_CTX structure using the values provided. */
337 static OSSL_HTTP_REQ_CTX *http_req_ctx_new(int free_wbio, BIO *wbio, BIO *rbio,
338 OSSL_HTTP_bio_cb_t bio_update_fn,
339 void *arg, int use_ssl,
341 const char *server, const char *port,
342 int buf_size, int overall_timeout)
344 OSSL_HTTP_REQ_CTX *rctx = OSSL_HTTP_REQ_CTX_new(wbio, rbio, buf_size);
348 rctx->free_wbio = free_wbio;
349 rctx->upd_fn = bio_update_fn;
351 rctx->use_ssl = use_ssl;
353 && (rctx->proxy = OPENSSL_strdup(proxy)) == NULL)
356 && (rctx->server = OPENSSL_strdup(server)) == NULL)
359 && (rctx->port = OPENSSL_strdup(port)) == NULL)
361 rctx->max_total_time =
362 overall_timeout > 0 ? time(NULL) + overall_timeout : 0;
366 OSSL_HTTP_REQ_CTX_free(rctx);
371 * Parse first HTTP response line. This should be like this: "HTTP/1.0 200 OK".
372 * We need to obtain the status code and (optional) informational message.
373 * Return any received HTTP response status code, or 0 on fatal error.
376 static int parse_http_line1(char *line, int *found_keep_alive)
379 char *code, *reason, *end;
381 if (!CHECK_AND_SKIP_PREFIX(line, HTTP_PREFIX_VERSION))
383 /* above HTTP 1.0, connection persistence is the default */
384 *found_keep_alive = *line > '0';
386 /* Skip to first whitespace (past protocol info) */
387 for (code = line; *code != '\0' && !ossl_isspace(*code); code++)
392 /* Skip past whitespace to start of response code */
393 while (*code != '\0' && ossl_isspace(*code))
398 /* Find end of response code: first whitespace after start of code */
399 for (reason = code; *reason != '\0' && !ossl_isspace(*reason); reason++)
405 /* Set end of response code and start of message */
408 /* Attempt to parse numeric code */
409 retcode = strtoul(code, &end, 10);
413 /* Skip over any leading whitespace in message */
414 while (*reason != '\0' && ossl_isspace(*reason))
417 if (*reason != '\0') {
419 * Finally zap any trailing whitespace in message (include CRLF)
422 /* chop any trailing whitespace from reason */
423 /* We know reason has a non-whitespace character so this is OK */
424 for (end = reason + strlen(reason) - 1; ossl_isspace(*end); end--)
429 case HTTP_STATUS_CODE_OK:
430 case HTTP_STATUS_CODE_MOVED_PERMANENTLY:
431 case HTTP_STATUS_CODE_FOUND:
434 err = HTTP_R_RECEIVED_ERROR;
436 err = HTTP_R_STATUS_CODE_UNSUPPORTED;
438 ERR_raise_data(ERR_LIB_HTTP, err, "code=%s", code);
440 ERR_raise_data(ERR_LIB_HTTP, err, "code=%s, reason=%s", code,
446 for (i = 0; i < 60 && line[i] != '\0'; i++)
447 if (!ossl_isprint(line[i]))
450 ERR_raise_data(ERR_LIB_HTTP, HTTP_R_HEADER_PARSE_ERROR, "content=%s", line);
454 static int check_set_resp_len(OSSL_HTTP_REQ_CTX *rctx, size_t len)
456 if (rctx->max_resp_len != 0 && len > rctx->max_resp_len)
457 ERR_raise_data(ERR_LIB_HTTP, HTTP_R_MAX_RESP_LEN_EXCEEDED,
458 "length=%zu, max=%zu", len, rctx->max_resp_len);
459 if (rctx->resp_len != 0 && rctx->resp_len != len)
460 ERR_raise_data(ERR_LIB_HTTP, HTTP_R_INCONSISTENT_CONTENT_LENGTH,
461 "ASN.1 length=%zu, Content-Length=%zu",
462 len, rctx->resp_len);
463 rctx->resp_len = len;
467 static int may_still_retry(time_t max_time, int *ptimeout)
469 time_t time_diff, now = time(NULL);
472 if (max_time < now) {
473 ERR_raise(ERR_LIB_HTTP, HTTP_R_RETRY_TIMEOUT);
476 time_diff = max_time - now;
477 *ptimeout = time_diff > INT_MAX ? INT_MAX : (int)time_diff;
483 * Try exchanging request and response via HTTP on (non-)blocking BIO in rctx.
484 * Returns 1 on success, 0 on error or redirection, -1 on BIO_should_retry.
486 int OSSL_HTTP_REQ_CTX_nbio(OSSL_HTTP_REQ_CTX *rctx)
488 int i, found_expected_ct = 0, found_keep_alive = 0;
489 int found_text_ct = 0;
492 const unsigned char *p;
493 char *buf, *key, *value, *line_end = NULL;
496 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
499 if (rctx->mem == NULL || rctx->wbio == NULL || rctx->rbio == NULL) {
500 ERR_raise(ERR_LIB_HTTP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
504 rctx->redirection_url = NULL;
506 buf = (char *)rctx->buf;
507 if ((rctx->state & OHS_NOREAD) == 0) {
508 if (rctx->expect_asn1) {
509 n = BIO_read(rctx->rbio, rctx->buf, rctx->buf_size);
511 (void)ERR_set_mark();
512 n = BIO_gets(rctx->rbio, buf, rctx->buf_size);
513 if (n == -2) { /* some BIOs, such as SSL, do not support "gets" */
514 (void)ERR_pop_to_mark();
515 n = BIO_get_line(rctx->rbio, buf, rctx->buf_size);
517 (void)ERR_clear_last_mark();
521 if (BIO_should_retry(rctx->rbio))
523 ERR_raise(ERR_LIB_HTTP, HTTP_R_FAILED_READING_DATA);
527 /* Write data to memory BIO */
528 if (BIO_write(rctx->mem, rctx->buf, n) != n)
532 switch (rctx->state) {
533 case OHS_ADD_HEADERS:
534 /* Last operation was adding headers: need a final \r\n */
535 if (BIO_write(rctx->mem, "\r\n", 2) != 2) {
536 rctx->state = OHS_ERROR;
539 rctx->state = OHS_WRITE_INIT;
543 rctx->len_to_send = BIO_get_mem_data(rctx->mem, &rctx->pos);
544 rctx->state = OHS_WRITE_HDR;
545 if (OSSL_TRACE_ENABLED(HTTP))
546 OSSL_TRACE(HTTP, "Sending request header:\n");
550 /* Copy some chunk of data from rctx->mem to rctx->wbio */
552 /* Copy some chunk of data from rctx->req to rctx->wbio */
554 if (rctx->len_to_send > 0) {
555 if (OSSL_TRACE_ENABLED(HTTP)
556 && rctx->state == OHS_WRITE_HDR && rctx->len_to_send <= INT_MAX)
557 OSSL_TRACE2(HTTP, "%.*s", (int)rctx->len_to_send, rctx->pos);
559 i = BIO_write(rctx->wbio, rctx->pos, rctx->len_to_send);
561 if (BIO_should_retry(rctx->wbio))
563 rctx->state = OHS_ERROR;
567 rctx->len_to_send -= i;
570 if (rctx->state == OHS_WRITE_HDR) {
571 (void)BIO_reset(rctx->mem);
572 rctx->state = OHS_WRITE_REQ;
574 if (rctx->req != NULL && !BIO_eof(rctx->req)) {
575 n = BIO_read(rctx->req, rctx->buf, rctx->buf_size);
577 if (BIO_should_retry(rctx->rbio))
579 ERR_raise(ERR_LIB_HTTP, HTTP_R_FAILED_READING_DATA);
582 rctx->pos = rctx->buf;
583 rctx->len_to_send = n;
586 rctx->state = OHS_FLUSH;
591 i = BIO_flush(rctx->wbio);
594 rctx->state = OHS_FIRSTLINE;
598 if (BIO_should_retry(rctx->wbio))
601 rctx->state = OHS_ERROR;
611 /* Attempt to read a line in */
614 * Due to strange memory BIO behavior with BIO_gets we have to check
615 * there's a complete line in there before calling BIO_gets or we'll
616 * just get a partial read.
618 n = BIO_get_mem_data(rctx->mem, &p);
619 if (n <= 0 || memchr(p, '\n', n) == 0) {
620 if (n >= rctx->buf_size) {
621 rctx->state = OHS_ERROR;
626 n = BIO_gets(rctx->mem, buf, rctx->buf_size);
629 if (BIO_should_retry(rctx->mem))
631 rctx->state = OHS_ERROR;
635 /* Don't allow excessive lines */
636 if (n == rctx->buf_size) {
637 ERR_raise(ERR_LIB_HTTP, HTTP_R_RESPONSE_LINE_TOO_LONG);
638 rctx->state = OHS_ERROR;
642 /* dump all response header lines */
643 if (OSSL_TRACE_ENABLED(HTTP)) {
644 if (rctx->state == OHS_FIRSTLINE)
645 OSSL_TRACE(HTTP, "Received response header:\n");
646 OSSL_TRACE1(HTTP, "%s", buf);
650 if (rctx->state == OHS_FIRSTLINE) {
651 switch (parse_http_line1(buf, &found_keep_alive)) {
652 case HTTP_STATUS_CODE_OK:
653 rctx->state = OHS_HEADERS;
655 case HTTP_STATUS_CODE_MOVED_PERMANENTLY:
656 case HTTP_STATUS_CODE_FOUND: /* i.e., moved temporarily */
657 if (!rctx->method_POST) { /* method is GET */
658 rctx->state = OHS_REDIRECT;
661 ERR_raise(ERR_LIB_HTTP, HTTP_R_REDIRECTION_NOT_ENABLED);
662 /* redirection is not supported/recommended for POST */
665 rctx->state = OHS_ERROR;
670 value = strchr(key, ':');
673 while (ossl_isspace(*value))
675 line_end = strchr(value, '\r');
676 if (line_end == NULL)
677 line_end = strchr(value, '\n');
678 if (line_end != NULL)
681 if (value != NULL && line_end != NULL) {
682 if (rctx->state == OHS_REDIRECT
683 && OPENSSL_strcasecmp(key, "Location") == 0) {
684 rctx->redirection_url = value;
687 if (OPENSSL_strcasecmp(key, "Content-Type") == 0) {
688 if (rctx->state == OHS_HEADERS
689 && rctx->expected_ct != NULL) {
690 if (OPENSSL_strcasecmp(rctx->expected_ct, value) != 0) {
691 ERR_raise_data(ERR_LIB_HTTP,
692 HTTP_R_UNEXPECTED_CONTENT_TYPE,
693 "expected=%s, actual=%s",
694 rctx->expected_ct, value);
697 found_expected_ct = 1;
699 if (OPENSSL_strncasecmp(value, "text/", 5) == 0)
703 /* https://tools.ietf.org/html/rfc7230#section-6.3 Persistence */
704 if (OPENSSL_strcasecmp(key, "Connection") == 0) {
705 if (OPENSSL_strcasecmp(value, "keep-alive") == 0)
706 found_keep_alive = 1;
707 else if (OPENSSL_strcasecmp(value, "close") == 0)
708 found_keep_alive = 0;
709 } else if (OPENSSL_strcasecmp(key, "Content-Length") == 0) {
710 resp_len = (size_t)strtoul(value, &line_end, 10);
711 if (line_end == value || *line_end != '\0') {
712 ERR_raise_data(ERR_LIB_HTTP,
713 HTTP_R_ERROR_PARSING_CONTENT_LENGTH,
717 if (!check_set_resp_len(rctx, resp_len))
722 /* Look for blank line indicating end of headers */
723 for (p = rctx->buf; *p != '\0'; p++) {
724 if (*p != '\r' && *p != '\n')
727 if (*p != '\0') /* not end of headers */
730 if (rctx->keep_alive != 0 /* do not let server initiate keep_alive */
731 && !found_keep_alive /* otherwise there is no change */) {
732 if (rctx->keep_alive == 2) {
733 rctx->keep_alive = 0;
734 ERR_raise(ERR_LIB_HTTP, HTTP_R_SERVER_CANCELED_CONNECTION);
737 rctx->keep_alive = 0;
740 if (rctx->state == OHS_ERROR) {
741 if (OSSL_TRACE_ENABLED(HTTP)
742 && found_text_ct && BIO_get_mem_data(rctx->mem, &p) > 0)
743 OSSL_TRACE1(HTTP, "%s", p);
747 if (rctx->expected_ct != NULL && !found_expected_ct) {
748 ERR_raise_data(ERR_LIB_HTTP, HTTP_R_MISSING_CONTENT_TYPE,
749 "expected=%s", rctx->expected_ct);
752 if (rctx->state == OHS_REDIRECT) {
753 /* http status code indicated redirect but there was no Location */
754 ERR_raise(ERR_LIB_HTTP, HTTP_R_MISSING_REDIRECT_LOCATION);
758 if (!rctx->expect_asn1) {
759 rctx->state = OHS_STREAM;
763 rctx->state = OHS_ASN1_HEADER;
766 case OHS_ASN1_HEADER:
768 * Now reading ASN1 header: can read at least 2 bytes which is enough
769 * for ASN1 SEQUENCE header and either length field or at least the
770 * length of the length field.
772 n = BIO_get_mem_data(rctx->mem, &p);
776 /* Check it is an ASN1 SEQUENCE */
777 if (*p++ != (V_ASN1_SEQUENCE | V_ASN1_CONSTRUCTED)) {
778 ERR_raise(ERR_LIB_HTTP, HTTP_R_MISSING_ASN1_ENCODING);
782 /* Check out length field */
783 if ((*p & 0x80) != 0) {
785 * If MSB set on initial length octet we can now always read 6
786 * octets: make sure we have them.
791 /* Not NDEF or excessive length */
792 if (n == 0 || (n > 4)) {
793 ERR_raise(ERR_LIB_HTTP, HTTP_R_ERROR_PARSING_ASN1_LENGTH);
798 for (i = 0; i < n; i++) {
806 if (!check_set_resp_len(rctx, resp_len))
809 rctx->state = OHS_ASN1_CONTENT;
812 case OHS_ASN1_CONTENT:
814 n = BIO_get_mem_data(rctx->mem, NULL);
815 if (n < 0 || (size_t)n < rctx->resp_len)
818 rctx->state = OHS_ASN1_DONE;
823 int OSSL_HTTP_REQ_CTX_nbio_d2i(OSSL_HTTP_REQ_CTX *rctx,
824 ASN1_VALUE **pval, const ASN1_ITEM *it)
826 const unsigned char *p;
830 if ((rv = OSSL_HTTP_REQ_CTX_nbio(rctx)) != 1)
832 *pval = ASN1_item_d2i(NULL, &p, BIO_get_mem_data(rctx->mem, &p), it);
833 return *pval != NULL;
837 #ifndef OPENSSL_NO_SOCK
839 /* set up a new connection BIO, to HTTP server or to HTTP(S) proxy if given */
840 static BIO *http_new_bio(const char *server /* optionally includes ":port" */,
841 const char *server_port /* explicit server port */,
843 const char *proxy /* optionally includes ":port" */,
844 const char *proxy_port /* explicit proxy port */)
846 const char *host = server;
847 const char *port = server_port;
850 if (!ossl_assert(server != NULL))
858 if (port == NULL && strchr(host, ':') == NULL)
859 port = use_ssl ? OSSL_HTTPS_PORT : OSSL_HTTP_PORT;
861 cbio = BIO_new_connect(host /* optionally includes ":port" */);
865 (void)BIO_set_conn_port(cbio, port);
870 #endif /* OPENSSL_NO_SOCK */
872 /* Exchange request and response via HTTP on (non-)blocking BIO */
873 BIO *OSSL_HTTP_REQ_CTX_exchange(OSSL_HTTP_REQ_CTX *rctx)
878 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
883 rv = OSSL_HTTP_REQ_CTX_nbio(rctx);
886 /* BIO_should_retry was true */
887 /* will not actually wait if rctx->max_time == 0 */
888 if (BIO_wait(rctx->rbio, rctx->max_time, 100 /* milliseconds */) <= 0)
893 if (rctx->redirection_url == NULL) { /* an error occurred */
894 if (rctx->len_to_send > 0)
895 ERR_raise(ERR_LIB_HTTP, HTTP_R_ERROR_SENDING);
897 ERR_raise(ERR_LIB_HTTP, HTTP_R_ERROR_RECEIVING);
901 return rctx->state == OHS_STREAM ? rctx->rbio : rctx->mem;
904 int OSSL_HTTP_is_alive(const OSSL_HTTP_REQ_CTX *rctx)
906 return rctx != NULL && rctx->keep_alive != 0;
909 /* High-level HTTP API implementation */
911 /* Initiate an HTTP session using bio, else use given server, proxy, etc. */
912 OSSL_HTTP_REQ_CTX *OSSL_HTTP_open(const char *server, const char *port,
913 const char *proxy, const char *no_proxy,
914 int use_ssl, BIO *bio, BIO *rbio,
915 OSSL_HTTP_bio_cb_t bio_update_fn, void *arg,
916 int buf_size, int overall_timeout)
918 BIO *cbio; /* == bio if supplied, used as connection BIO if rbio is NULL */
919 OSSL_HTTP_REQ_CTX *rctx = NULL;
921 if (use_ssl && bio_update_fn == NULL) {
922 ERR_raise(ERR_LIB_HTTP, HTTP_R_TLS_NOT_ENABLED);
925 if (rbio != NULL && (bio == NULL || bio_update_fn != NULL)) {
926 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_INVALID_ARGUMENT);
932 if (proxy != NULL || no_proxy != NULL) {
933 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_INVALID_ARGUMENT);
937 #ifndef OPENSSL_NO_SOCK
938 char *proxy_host = NULL, *proxy_port = NULL;
940 if (server == NULL) {
941 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
944 if (port != NULL && *port == '\0')
946 if (port == NULL && strchr(server, ':') == NULL)
947 port = use_ssl ? OSSL_HTTPS_PORT : OSSL_HTTP_PORT;
948 proxy = OSSL_HTTP_adapt_proxy(proxy, no_proxy, server, use_ssl);
950 && !OSSL_HTTP_parse_url(proxy, NULL /* use_ssl */, NULL /* user */,
951 &proxy_host, &proxy_port, NULL /* num */,
952 NULL /* path */, NULL, NULL))
954 cbio = http_new_bio(server, port, use_ssl, proxy_host, proxy_port);
955 OPENSSL_free(proxy_host);
956 OPENSSL_free(proxy_port);
960 ERR_raise(ERR_LIB_HTTP, HTTP_R_SOCK_NOT_SUPPORTED);
965 (void)ERR_set_mark(); /* prepare removing any spurious libssl errors */
966 if (rbio == NULL && BIO_do_connect_retry(cbio, overall_timeout, -1) <= 0) {
967 if (bio == NULL) /* cbio was not provided by caller */
971 /* now overall_timeout is guaranteed to be >= 0 */
973 /* adapt in order to fix callback design flaw, see #17088 */
974 /* callback can be used to wrap or prepend TLS session */
975 if (bio_update_fn != NULL) {
976 BIO *orig_bio = cbio;
978 cbio = (*bio_update_fn)(cbio, arg, 1 /* connect */, use_ssl);
980 if (bio == NULL) /* cbio was not provided by caller */
981 BIO_free_all(orig_bio);
986 rctx = http_req_ctx_new(bio == NULL, cbio, rbio != NULL ? rbio : cbio,
987 bio_update_fn, arg, use_ssl, proxy, server, port,
988 buf_size, overall_timeout);
992 /* remove any spurious error queue entries by ssl_add_cert_chain() */
993 (void)ERR_pop_to_mark();
995 (void)ERR_clear_last_mark();
1000 int OSSL_HTTP_set1_request(OSSL_HTTP_REQ_CTX *rctx, const char *path,
1001 const STACK_OF(CONF_VALUE) *headers,
1002 const char *content_type, BIO *req,
1003 const char *expected_content_type, int expect_asn1,
1004 size_t max_resp_len, int timeout, int keep_alive)
1009 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
1012 use_http_proxy = rctx->proxy != NULL && !rctx->use_ssl;
1013 if (use_http_proxy && rctx->server == NULL) {
1014 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_INVALID_ARGUMENT);
1017 rctx->max_resp_len = max_resp_len; /* allows for 0: indefinite */
1019 return OSSL_HTTP_REQ_CTX_set_request_line(rctx, req != NULL,
1020 use_http_proxy ? rctx->server
1021 : NULL, rctx->port, path)
1022 && add1_headers(rctx, headers, rctx->server)
1023 && OSSL_HTTP_REQ_CTX_set_expected(rctx, expected_content_type,
1024 expect_asn1, timeout, keep_alive)
1025 && set1_content(rctx, content_type, req);
1029 * Exchange single HTTP request and response according to rctx.
1030 * If rctx->method_POST then use POST, else use GET and ignore content_type.
1031 * The redirection_url output (freed by caller) parameter is used only for GET.
1033 BIO *OSSL_HTTP_exchange(OSSL_HTTP_REQ_CTX *rctx, char **redirection_url)
1038 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
1042 if (redirection_url != NULL)
1043 *redirection_url = NULL; /* do this beforehand to prevent dbl free */
1045 resp = OSSL_HTTP_REQ_CTX_exchange(rctx);
1047 if (rctx->redirection_url != NULL) {
1048 if (redirection_url == NULL)
1049 ERR_raise(ERR_LIB_HTTP, HTTP_R_REDIRECTION_NOT_ENABLED);
1051 /* may be NULL if out of memory: */
1052 *redirection_url = OPENSSL_strdup(rctx->redirection_url);
1055 unsigned long err = ERR_peek_error();
1056 int lib = ERR_GET_LIB(err);
1057 int reason = ERR_GET_REASON(err);
1059 if (lib == ERR_LIB_SSL || lib == ERR_LIB_HTTP
1060 || (lib == ERR_LIB_BIO && reason == BIO_R_CONNECT_TIMEOUT)
1061 || (lib == ERR_LIB_BIO && reason == BIO_R_CONNECT_ERROR)
1062 #ifndef OPENSSL_NO_CMP
1063 || (lib == ERR_LIB_CMP
1064 && reason == CMP_R_POTENTIALLY_INVALID_CERTIFICATE)
1067 if (rctx->server != NULL) {
1068 BIO_snprintf(buf, sizeof(buf), "server=http%s://%s%s%s",
1069 rctx->use_ssl ? "s" : "", rctx->server,
1070 rctx->port != NULL ? ":" : "",
1071 rctx->port != NULL ? rctx->port : "");
1072 ERR_add_error_data(1, buf);
1074 if (rctx->proxy != NULL)
1075 ERR_add_error_data(2, " proxy=", rctx->proxy);
1077 BIO_snprintf(buf, sizeof(buf), " peer has disconnected%s",
1078 rctx->use_ssl ? " violating the protocol" :
1079 ", likely because it requires the use of TLS");
1080 ERR_add_error_data(1, buf);
1086 if (resp != NULL && !BIO_up_ref(resp))
1091 static int redirection_ok(int n_redir, const char *old_url, const char *new_url)
1093 if (n_redir >= HTTP_VERSION_MAX_REDIRECTIONS) {
1094 ERR_raise(ERR_LIB_HTTP, HTTP_R_TOO_MANY_REDIRECTIONS);
1097 if (*new_url == '/') /* redirection to same server => same protocol */
1099 if (HAS_PREFIX(old_url, OSSL_HTTPS_NAME":") &&
1100 !HAS_PREFIX(new_url, OSSL_HTTPS_NAME":")) {
1101 ERR_raise(ERR_LIB_HTTP, HTTP_R_REDIRECTION_FROM_HTTPS_TO_HTTP);
1107 /* Get data via HTTP from server at given URL, potentially with redirection */
1108 BIO *OSSL_HTTP_get(const char *url, const char *proxy, const char *no_proxy,
1109 BIO *bio, BIO *rbio,
1110 OSSL_HTTP_bio_cb_t bio_update_fn, void *arg,
1111 int buf_size, const STACK_OF(CONF_VALUE) *headers,
1112 const char *expected_ct, int expect_asn1,
1113 size_t max_resp_len, int timeout)
1115 char *current_url, *redirection_url = NULL;
1121 OSSL_HTTP_REQ_CTX *rctx;
1123 time_t max_time = timeout > 0 ? time(NULL) + timeout : 0;
1126 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
1129 if ((current_url = OPENSSL_strdup(url)) == NULL)
1133 if (!OSSL_HTTP_parse_url(current_url, &use_ssl, NULL /* user */, &host,
1134 &port, NULL /* port_num */, &path, NULL, NULL))
1137 rctx = OSSL_HTTP_open(host, port, proxy, no_proxy,
1138 use_ssl, bio, rbio, bio_update_fn, arg,
1142 if (!OSSL_HTTP_set1_request(rctx, path, headers,
1143 NULL /* content_type */,
1145 expected_ct, expect_asn1, max_resp_len,
1146 -1 /* use same max time (timeout) */,
1147 0 /* no keep_alive */))
1148 OSSL_HTTP_REQ_CTX_free(rctx);
1150 resp = OSSL_HTTP_exchange(rctx, &redirection_url);
1153 if (resp == NULL && redirection_url != NULL) {
1154 if (redirection_ok(++n_redirs, current_url, redirection_url)
1155 && may_still_retry(max_time, &timeout)) {
1156 (void)BIO_reset(bio);
1157 OPENSSL_free(current_url);
1158 current_url = redirection_url;
1159 if (*redirection_url == '/') { /* redirection to same server */
1160 path = OPENSSL_strdup(redirection_url);
1164 (void)OSSL_HTTP_close(rctx, 1);
1166 OPENSSL_free(current_url);
1173 (void)OSSL_HTTP_close(rctx, 1);
1176 /* if redirection not allowed, ignore it */
1177 OPENSSL_free(redirection_url);
1181 if (!OSSL_HTTP_close(rctx, resp != NULL)) {
1187 OPENSSL_free(current_url);
1191 /* Exchange request and response over a connection managed via |prctx| */
1192 BIO *OSSL_HTTP_transfer(OSSL_HTTP_REQ_CTX **prctx,
1193 const char *server, const char *port,
1194 const char *path, int use_ssl,
1195 const char *proxy, const char *no_proxy,
1196 BIO *bio, BIO *rbio,
1197 OSSL_HTTP_bio_cb_t bio_update_fn, void *arg,
1198 int buf_size, const STACK_OF(CONF_VALUE) *headers,
1199 const char *content_type, BIO *req,
1200 const char *expected_ct, int expect_asn1,
1201 size_t max_resp_len, int timeout, int keep_alive)
1203 OSSL_HTTP_REQ_CTX *rctx = prctx == NULL ? NULL : *prctx;
1207 rctx = OSSL_HTTP_open(server, port, proxy, no_proxy,
1208 use_ssl, bio, rbio, bio_update_fn, arg,
1210 timeout = -1; /* Already set during opening the connection */
1213 if (OSSL_HTTP_set1_request(rctx, path, headers, content_type, req,
1214 expected_ct, expect_asn1,
1215 max_resp_len, timeout, keep_alive))
1216 resp = OSSL_HTTP_exchange(rctx, NULL);
1217 if (resp == NULL || !OSSL_HTTP_is_alive(rctx)) {
1218 if (!OSSL_HTTP_close(rctx, resp != NULL)) {
1230 int OSSL_HTTP_close(OSSL_HTTP_REQ_CTX *rctx, int ok)
1235 /* callback can be used to finish TLS session and free its BIO */
1236 if (rctx != NULL && rctx->upd_fn != NULL) {
1237 wbio = (*rctx->upd_fn)(rctx->wbio, rctx->upd_arg,
1238 0 /* disconnect */, ok);
1243 OSSL_HTTP_REQ_CTX_free(rctx);
1247 /* BASE64 encoder used for encoding basic proxy authentication credentials */
1248 static char *base64encode(const void *buf, size_t len)
1254 /* Calculate size of encoded data */
1259 out = OPENSSL_malloc(outl + 1);
1263 i = EVP_EncodeBlock((unsigned char *)out, buf, len);
1264 if (!ossl_assert(0 <= i && (size_t)i <= outl)) {
1272 * Promote the given connection BIO using the CONNECT method for a TLS proxy.
1273 * This is typically called by an app, so bio_err and prog are used unless NULL
1274 * to print additional diagnostic information in a user-oriented way.
1276 int OSSL_HTTP_proxy_connect(BIO *bio, const char *server, const char *port,
1277 const char *proxyuser, const char *proxypass,
1278 int timeout, BIO *bio_err, const char *prog)
1281 #define BUF_SIZE (8 * 1024)
1282 char *mbuf = OPENSSL_malloc(BUF_SIZE);
1286 BIO *fbio = BIO_new(BIO_f_buffer());
1288 time_t max_time = timeout > 0 ? time(NULL) + timeout : 0;
1290 if (bio == NULL || server == NULL
1291 || (bio_err != NULL && prog == NULL)) {
1292 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
1295 if (port == NULL || *port == '\0')
1296 port = OSSL_HTTPS_PORT;
1298 if (mbuf == NULL || fbio == NULL) {
1299 BIO_printf(bio_err /* may be NULL */, "%s: out of memory", prog);
1302 BIO_push(fbio, bio);
1304 BIO_printf(fbio, "CONNECT %s:%s "HTTP_1_0"\r\n", server, port);
1307 * Workaround for broken proxies which would otherwise close
1308 * the connection when entering tunnel mode (e.g., Squid 2.6)
1310 BIO_printf(fbio, "Proxy-Connection: Keep-Alive\r\n");
1312 /* Support for basic (base64) proxy authentication */
1313 if (proxyuser != NULL) {
1314 size_t len = strlen(proxyuser) + 1;
1315 char *proxyauth, *proxyauthenc = NULL;
1317 if (proxypass != NULL)
1318 len += strlen(proxypass);
1319 proxyauth = OPENSSL_malloc(len + 1);
1320 if (proxyauth == NULL)
1322 if (BIO_snprintf(proxyauth, len + 1, "%s:%s", proxyuser,
1323 proxypass != NULL ? proxypass : "") != (int)len)
1325 proxyauthenc = base64encode(proxyauth, len);
1326 if (proxyauthenc != NULL) {
1327 BIO_printf(fbio, "Proxy-Authorization: Basic %s\r\n", proxyauthenc);
1328 OPENSSL_clear_free(proxyauthenc, strlen(proxyauthenc));
1331 OPENSSL_clear_free(proxyauth, len);
1332 if (proxyauthenc == NULL)
1336 /* Terminate the HTTP CONNECT request */
1337 BIO_printf(fbio, "\r\n");
1340 if (BIO_flush(fbio) != 0)
1342 /* potentially needs to be retried if BIO is non-blocking */
1343 if (!BIO_should_retry(fbio))
1348 /* will not actually wait if timeout == 0 */
1349 rv = BIO_wait(fbio, max_time, 100 /* milliseconds */);
1351 BIO_printf(bio_err, "%s: HTTP CONNECT %s\n", prog,
1352 rv == 0 ? "timed out" : "failed waiting for data");
1357 * The first line is the HTTP response.
1358 * According to RFC 7230, it is formatted exactly like this:
1359 * HTTP/d.d ddd reason text\r\n
1361 read_len = BIO_gets(fbio, mbuf, BUF_SIZE);
1362 /* the BIO may not block, so we must wait for the 1st line to come in */
1363 if (read_len < (int)HTTP_LINE1_MINLEN)
1366 /* Check for HTTP/1.x */
1368 if (!CHECK_AND_SKIP_PREFIX(mbufp, HTTP_PREFIX)) {
1369 ERR_raise(ERR_LIB_HTTP, HTTP_R_HEADER_PARSE_ERROR);
1370 BIO_printf(bio_err, "%s: HTTP CONNECT failed, non-HTTP response\n",
1372 /* Wrong protocol, not even HTTP, so stop reading headers */
1375 if (!HAS_PREFIX(mbufp, HTTP_VERSION_PATT)) {
1376 ERR_raise(ERR_LIB_HTTP, HTTP_R_RECEIVED_WRONG_HTTP_VERSION);
1378 "%s: HTTP CONNECT failed, bad HTTP version %.*s\n",
1379 prog, (int)HTTP_VERSION_STR_LEN, mbufp);
1382 mbufp += HTTP_VERSION_STR_LEN;
1384 /* RFC 7231 4.3.6: any 2xx status code is valid */
1385 if (!HAS_PREFIX(mbufp, " 2")) {
1386 if (ossl_isspace(*mbufp))
1388 /* chop any trailing whitespace */
1389 while (read_len > 0 && ossl_isspace(mbuf[read_len - 1]))
1391 mbuf[read_len] = '\0';
1392 ERR_raise_data(ERR_LIB_HTTP, HTTP_R_CONNECT_FAILURE,
1393 "reason=%s", mbufp);
1394 BIO_printf(bio_err, "%s: HTTP CONNECT failed, reason=%s\n",
1402 /* Read past all following headers */
1405 * This does not necessarily catch the case when the full
1406 * HTTP response came in in more than a single TCP message.
1408 read_len = BIO_gets(fbio, mbuf, BUF_SIZE);
1409 } while (read_len > 2);
1413 (void)BIO_flush(fbio);