2 * Copyright 2001-2020 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
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 "internal/sockets.h"
24 #include "internal/cryptlib.h" /* for ossl_assert() */
26 #include "http_local.h"
28 DEFINE_STACK_OF(CONF_VALUE)
30 #define HTTP_PREFIX "HTTP/"
31 #define HTTP_VERSION_PATT "1." /* allow 1.x */
32 #define HTTP_VERSION_STR_LEN 3
33 #define HTTP_LINE1_MINLEN ((int)strlen(HTTP_PREFIX HTTP_VERSION_PATT "x 200\n"))
34 #define HTTP_VERSION_MAX_REDIRECTIONS 50
36 #define HTTP_STATUS_CODE_OK 200
37 #define HTTP_STATUS_CODE_MOVED_PERMANENTLY 301
38 #define HTTP_STATUS_CODE_FOUND 302
41 /* Stateful HTTP request code, supporting blocking and non-blocking I/O */
43 /* Opaque HTTP request status structure */
45 struct ossl_http_req_ctx_st {
46 int state; /* Current I/O state */
47 unsigned char *iobuf; /* Line buffer */
48 int iobuflen; /* Line buffer length */
49 BIO *wbio; /* BIO to send request to */
50 BIO *rbio; /* BIO to read response from */
51 BIO *mem; /* Memory BIO response is built into */
52 int method_GET; /* HTTP method "GET" or "POST" */
53 const char *expected_ct; /* expected Content-Type, or NULL */
54 int expect_asn1; /* response must be ASN.1-encoded */
55 unsigned long resp_len; /* length of response */
56 unsigned long max_resp_len; /* Maximum length of response */
57 time_t max_time; /* Maximum end time of the transfer, or 0 */
58 char *redirection_url; /* Location given with HTTP status 301/302 */
61 #define HTTP_DEFAULT_MAX_LINE_LENGTH (4 * 1024)
62 #define HTTP_DEFAULT_MAX_RESP_LEN (100 * 1024)
66 #define OHS_NOREAD 0x1000 /* If set no reading should be performed */
67 #define OHS_ERROR (0 | OHS_NOREAD) /* Error condition */
68 #define OHS_FIRSTLINE 1 /* First line being read */
69 #define OHS_REDIRECT 0xa /* Looking for redirection location */
70 #define OHS_HEADERS 2 /* MIME headers being read */
71 #define OHS_ASN1_HEADER 3 /* HTTP initial header (tag+length) being read */
72 #define OHS_CONTENT 4 /* HTTP content octets being read */
73 #define OHS_WRITE_INIT (5 | OHS_NOREAD) /* 1st call: ready to start I/O */
74 #define OHS_WRITE (6 | OHS_NOREAD) /* Request being sent */
75 #define OHS_FLUSH (7 | OHS_NOREAD) /* Request being flushed */
76 #define OHS_DONE (8 | OHS_NOREAD) /* Completed */
77 #define OHS_HTTP_HEADER (9 | OHS_NOREAD) /* Headers set, w/o final \r\n */
79 OSSL_HTTP_REQ_CTX *OSSL_HTTP_REQ_CTX_new(BIO *wbio, BIO *rbio,
80 int method_GET, int maxline,
81 unsigned long max_resp_len,
83 const char *expected_content_type,
86 OSSL_HTTP_REQ_CTX *rctx;
88 if (wbio == NULL || rbio == NULL) {
89 HTTPerr(0, ERR_R_PASSED_NULL_PARAMETER);
93 if ((rctx = OPENSSL_zalloc(sizeof(*rctx))) == NULL)
95 rctx->state = OHS_ERROR;
96 rctx->iobuflen = maxline > 0 ? maxline : HTTP_DEFAULT_MAX_LINE_LENGTH;
97 rctx->iobuf = OPENSSL_malloc(rctx->iobuflen);
100 rctx->mem = BIO_new(BIO_s_mem());
101 if (rctx->iobuf == NULL || rctx->mem == NULL) {
102 OSSL_HTTP_REQ_CTX_free(rctx);
105 rctx->method_GET = method_GET;
106 rctx->expected_ct = expected_content_type;
107 rctx->expect_asn1 = expect_asn1;
109 OSSL_HTTP_REQ_CTX_set_max_response_length(rctx, max_resp_len);
110 rctx->max_time = timeout > 0 ? time(NULL) + timeout : 0;
114 void OSSL_HTTP_REQ_CTX_free(OSSL_HTTP_REQ_CTX *rctx)
118 BIO_free(rctx->mem); /* this may indirectly call ERR_clear_error() */
119 OPENSSL_free(rctx->iobuf);
123 BIO *OSSL_HTTP_REQ_CTX_get0_mem_bio(OSSL_HTTP_REQ_CTX *rctx)
126 HTTPerr(0, ERR_R_PASSED_NULL_PARAMETER);
132 void OSSL_HTTP_REQ_CTX_set_max_response_length(OSSL_HTTP_REQ_CTX *rctx,
136 HTTPerr(0, ERR_R_PASSED_NULL_PARAMETER);
139 rctx->max_resp_len = len != 0 ? len : HTTP_DEFAULT_MAX_RESP_LEN;
143 * Create HTTP header using given op and path (or "/" in case path is NULL).
144 * Server name (and port) must be given if and only if plain HTTP proxy is used.
146 int OSSL_HTTP_REQ_CTX_header(OSSL_HTTP_REQ_CTX *rctx, const char *server,
147 const char *port, const char *path)
150 HTTPerr(0, ERR_R_PASSED_NULL_PARAMETER);
154 if (BIO_printf(rctx->mem, "%s ", rctx->method_GET ? "GET" : "POST") <= 0)
157 if (server != NULL) { /* HTTP (but not HTTPS) proxy is used */
159 * Section 5.1.2 of RFC 1945 states that the absoluteURI form is only
160 * allowed when using a proxy
162 if (BIO_printf(rctx->mem, OSSL_HTTP_PREFIX"%s", server) <= 0)
164 if (port != NULL && BIO_printf(rctx->mem, ":%s", port) <= 0)
168 /* Make sure path includes a forward slash */
171 if (path[0] != '/' && BIO_printf(rctx->mem, "/") <= 0)
174 if (BIO_printf(rctx->mem, "%s "HTTP_PREFIX"1.0\r\n", path) <= 0)
176 rctx->state = OHS_HTTP_HEADER;
180 int OSSL_HTTP_REQ_CTX_add1_header(OSSL_HTTP_REQ_CTX *rctx,
181 const char *name, const char *value)
183 if (rctx == NULL || name == NULL) {
184 HTTPerr(0, ERR_R_PASSED_NULL_PARAMETER);
188 if (BIO_puts(rctx->mem, name) <= 0)
191 if (BIO_write(rctx->mem, ": ", 2) != 2)
193 if (BIO_puts(rctx->mem, value) <= 0)
196 if (BIO_write(rctx->mem, "\r\n", 2) != 2)
198 rctx->state = OHS_HTTP_HEADER;
202 static int OSSL_HTTP_REQ_CTX_content(OSSL_HTTP_REQ_CTX *rctx,
203 const char *content_type, BIO *req_mem)
205 const unsigned char *req;
208 if (rctx == NULL || req_mem == NULL) {
209 HTTPerr(0, ERR_R_PASSED_NULL_PARAMETER);
213 if (content_type != NULL
214 && BIO_printf(rctx->mem, "Content-Type: %s\r\n", content_type) <= 0)
217 if ((req_len = BIO_get_mem_data(req_mem, &req)) <= 0)
219 rctx->state = OHS_WRITE_INIT;
221 return BIO_printf(rctx->mem, "Content-Length: %ld\r\n\r\n", req_len) > 0
222 && BIO_write(rctx->mem, req, req_len) == (int)req_len;
225 BIO *HTTP_asn1_item2bio(const ASN1_ITEM *it, const ASN1_VALUE *val)
229 if (it == NULL || val == NULL) {
230 HTTPerr(0, ERR_R_PASSED_NULL_PARAMETER);
234 if ((res = BIO_new(BIO_s_mem())) == NULL)
236 if (ASN1_item_i2d_bio(it, res, val) <= 0) {
243 int OSSL_HTTP_REQ_CTX_i2d(OSSL_HTTP_REQ_CTX *rctx, const char *content_type,
244 const ASN1_ITEM *it, ASN1_VALUE *req)
249 if (rctx == NULL || it == NULL || req == NULL) {
250 HTTPerr(0, ERR_R_PASSED_NULL_PARAMETER);
254 res = (mem = HTTP_asn1_item2bio(it, req)) != NULL
255 && OSSL_HTTP_REQ_CTX_content(rctx, content_type, mem);
260 static int OSSL_HTTP_REQ_CTX_add1_headers(OSSL_HTTP_REQ_CTX *rctx,
261 const STACK_OF(CONF_VALUE) *headers,
268 for (i = 0; i < sk_CONF_VALUE_num(headers); i++) {
269 hdr = sk_CONF_VALUE_value(headers, i);
270 if (add_host && strcasecmp("host", hdr->name) == 0)
272 if (!OSSL_HTTP_REQ_CTX_add1_header(rctx, hdr->name, hdr->value))
276 if (add_host && !OSSL_HTTP_REQ_CTX_add1_header(rctx, "Host", host))
282 * Create OSSL_HTTP_REQ_CTX structure using the values provided.
283 * If !use_http_proxy then the 'server' and 'port' parameters are ignored.
284 * If req_mem == NULL then use GET and ignore content_type, else POST.
286 OSSL_HTTP_REQ_CTX *HTTP_REQ_CTX_new(BIO *wbio, BIO *rbio, int use_http_proxy,
287 const char *server, const char *port,
289 const STACK_OF(CONF_VALUE) *headers,
290 const char *content_type, BIO *req_mem,
291 int maxline, unsigned long max_resp_len,
293 const char *expected_content_type,
296 OSSL_HTTP_REQ_CTX *rctx;
298 if (use_http_proxy && (server == NULL || port == NULL)) {
299 HTTPerr(0, ERR_R_PASSED_NULL_PARAMETER);
302 /* remaining parameters are checked indirectly by the functions called */
304 if ((rctx = OSSL_HTTP_REQ_CTX_new(wbio, rbio, req_mem == NULL, maxline,
305 max_resp_len, timeout,
306 expected_content_type, expect_asn1))
310 if (OSSL_HTTP_REQ_CTX_header(rctx, use_http_proxy ? server : NULL,
312 && OSSL_HTTP_REQ_CTX_add1_headers(rctx, headers, server)
314 || OSSL_HTTP_REQ_CTX_content(rctx, content_type, req_mem)))
317 OSSL_HTTP_REQ_CTX_free(rctx);
322 * Parse first HTTP response line. This should be like this: "HTTP/1.0 200 OK".
323 * We need to obtain the numeric code and (optional) informational message.
326 static int parse_http_line1(char *line)
329 char *code, *reason, *end;
331 /* Skip to first whitespace (past protocol info) */
332 for (code = line; *code != '\0' && !ossl_isspace(*code); code++)
335 HTTPerr(0, HTTP_R_RESPONSE_PARSE_ERROR);
339 /* Skip past whitespace to start of response code */
340 while (*code != '\0' && ossl_isspace(*code))
344 HTTPerr(0, HTTP_R_RESPONSE_PARSE_ERROR);
348 /* Find end of response code: first whitespace after start of code */
349 for (reason = code; *reason != '\0' && !ossl_isspace(*reason); reason++)
352 if (*reason == '\0') {
353 HTTPerr(0, HTTP_R_RESPONSE_PARSE_ERROR);
357 /* Set end of response code and start of message */
360 /* Attempt to parse numeric code */
361 retcode = strtoul(code, &end, 10);
366 /* Skip over any leading whitespace in message */
367 while (*reason != '\0' && ossl_isspace(*reason))
370 if (*reason != '\0') {
372 * Finally zap any trailing whitespace in message (include CRLF)
375 /* chop any trailing whitespace from reason */
376 /* We know reason has a non-whitespace character so this is OK */
377 for (end = reason + strlen(reason) - 1; ossl_isspace(*end); end--)
382 case HTTP_STATUS_CODE_OK:
383 case HTTP_STATUS_CODE_MOVED_PERMANENTLY:
384 case HTTP_STATUS_CODE_FOUND:
388 HTTPerr(0, HTTP_R_STATUS_CODE_UNSUPPORTED);
390 HTTPerr(0, HTTP_R_RECEIVED_ERROR);
392 ERR_add_error_data(2, "Code=", code);
394 ERR_add_error_data(4, "Code=", code, ",Reason=", reason);
399 static int check_set_resp_len(OSSL_HTTP_REQ_CTX *rctx, unsigned long len)
401 const char *tag = NULL;
402 unsigned long val = 0;
404 if (len > rctx->max_resp_len) {
405 HTTPerr(0, HTTP_R_MAX_RESP_LEN_EXCEEDED);
407 val = rctx->max_resp_len;
409 if (rctx->resp_len != 0 && rctx->resp_len != len) {
410 HTTPerr(0, HTTP_R_INCONSISTENT_CONTENT_LENGTH);
412 val = rctx->resp_len;
418 BIO_snprintf(len_str, sizeof(len_str), "%lu", len);
419 BIO_snprintf(str, sizeof(str), "%lu", val);
420 ERR_add_error_data(4, "length=", len_str, tag, str);
423 rctx->resp_len = len;
428 * Try exchanging request and response via HTTP on (non-)blocking BIO in rctx.
429 * Returns 1 on success, 0 on error or redirection, -1 on BIO_should_retry.
431 int OSSL_HTTP_REQ_CTX_nbio(OSSL_HTTP_REQ_CTX *rctx)
434 long n, n_to_send = 0;
435 unsigned long resp_len;
436 const unsigned char *p;
437 char *key, *value, *line_end = NULL;
440 HTTPerr(0, ERR_R_PASSED_NULL_PARAMETER);
444 rctx->redirection_url = NULL;
446 if ((rctx->state & OHS_NOREAD) == 0) {
447 n = BIO_read(rctx->rbio, rctx->iobuf, rctx->iobuflen);
449 if (BIO_should_retry(rctx->rbio))
454 /* Write data to memory BIO */
455 if (BIO_write(rctx->mem, rctx->iobuf, n) != n)
459 switch (rctx->state) {
460 case OHS_HTTP_HEADER:
461 /* Last operation was adding headers: need a final \r\n */
462 if (BIO_write(rctx->mem, "\r\n", 2) != 2) {
463 rctx->state = OHS_ERROR;
466 rctx->state = OHS_WRITE_INIT;
470 n_to_send = BIO_get_mem_data(rctx->mem, NULL);
471 rctx->state = OHS_WRITE;
475 n = BIO_get_mem_data(rctx->mem, &p);
477 i = BIO_write(rctx->wbio, p + (n - n_to_send), n_to_send);
480 if (BIO_should_retry(rctx->wbio))
482 rctx->state = OHS_ERROR;
491 rctx->state = OHS_FLUSH;
493 (void)BIO_reset(rctx->mem);
498 i = BIO_flush(rctx->wbio);
501 rctx->state = OHS_FIRSTLINE;
505 if (BIO_should_retry(rctx->wbio))
508 rctx->state = OHS_ERROR;
518 /* Attempt to read a line in */
521 * Due to strange memory BIO behavior with BIO_gets we have to check
522 * there's a complete line in there before calling BIO_gets or we'll
523 * just get a partial read.
525 n = BIO_get_mem_data(rctx->mem, &p);
526 if (n <= 0 || memchr(p, '\n', n) == 0) {
527 if (n >= rctx->iobuflen) {
528 rctx->state = OHS_ERROR;
533 n = BIO_gets(rctx->mem, (char *)rctx->iobuf, rctx->iobuflen);
536 if (BIO_should_retry(rctx->mem))
538 rctx->state = OHS_ERROR;
542 /* Don't allow excessive lines */
543 if (n == rctx->iobuflen) {
544 HTTPerr(0, HTTP_R_RESPONSE_LINE_TOO_LONG);
545 rctx->state = OHS_ERROR;
550 if (rctx->state == OHS_FIRSTLINE) {
551 switch (parse_http_line1((char *)rctx->iobuf)) {
552 case HTTP_STATUS_CODE_OK:
553 rctx->state = OHS_HEADERS;
555 case HTTP_STATUS_CODE_MOVED_PERMANENTLY:
556 case HTTP_STATUS_CODE_FOUND: /* i.e., moved temporarily */
557 if (rctx->method_GET) {
558 rctx->state = OHS_REDIRECT;
561 HTTPerr(0, HTTP_R_REDIRECTION_NOT_ENABLED);
562 /* redirection is not supported/recommended for POST */
565 rctx->state = OHS_ERROR;
569 key = (char *)rctx->iobuf;
570 value = strchr(key, ':');
573 while (ossl_isspace(*value))
575 line_end = strchr(value, '\r');
576 if (line_end == NULL)
577 line_end = strchr(value, '\n');
578 if (line_end != NULL)
581 if (value != NULL && line_end != NULL) {
582 if (rctx->state == OHS_REDIRECT
583 && strcasecmp(key, "Location") == 0) {
584 rctx->redirection_url = value;
587 if (rctx->expected_ct != NULL
588 && strcasecmp(key, "Content-Type") == 0) {
589 if (strcasecmp(rctx->expected_ct, value) != 0) {
590 HTTPerr(0, HTTP_R_UNEXPECTED_CONTENT_TYPE);
591 ERR_add_error_data(4, "expected=", rctx->expected_ct,
595 rctx->expected_ct = NULL; /* content-type has been found */
597 if (strcasecmp(key, "Content-Length") == 0) {
598 resp_len = strtoul(value, &line_end, 10);
599 if (line_end == value || *line_end != '\0') {
600 HTTPerr(0, HTTP_R_ERROR_PARSING_CONTENT_LENGTH);
601 ERR_add_error_data(2, "input=", value);
604 if (!check_set_resp_len(rctx, resp_len))
609 /* Look for blank line: end of headers */
610 for (p = rctx->iobuf; *p != '\0'; p++) {
611 if (*p != '\r' && *p != '\n')
614 if (*p != '\0') /* not end of headers */
617 if (rctx->expected_ct != NULL) {
618 HTTPerr(0, HTTP_R_MISSING_CONTENT_TYPE);
619 ERR_add_error_data(2, "expected=", rctx->expected_ct);
622 if (rctx->state == OHS_REDIRECT) {
623 /* http status code indicated redirect but there was no Location */
624 HTTPerr(0, HTTP_R_MISSING_REDIRECT_LOCATION);
628 if (!rctx->expect_asn1) {
629 rctx->state = OHS_CONTENT;
633 rctx->state = OHS_ASN1_HEADER;
636 case OHS_ASN1_HEADER:
638 * Now reading ASN1 header: can read at least 2 bytes which is enough
639 * for ASN1 SEQUENCE header and either length field or at least the
640 * length of the length field.
642 n = BIO_get_mem_data(rctx->mem, &p);
646 /* Check it is an ASN1 SEQUENCE */
647 if (*p++ != (V_ASN1_SEQUENCE | V_ASN1_CONSTRUCTED)) {
648 HTTPerr(0, HTTP_R_MISSING_ASN1_ENCODING);
652 /* Check out length field */
653 if ((*p & 0x80) != 0) {
655 * If MSB set on initial length octet we can now always read 6
656 * octets: make sure we have them.
661 /* Not NDEF or excessive length */
662 if (n == 0 || (n > 4)) {
663 HTTPerr(0, HTTP_R_ERROR_PARSING_ASN1_LENGTH);
668 for (i = 0; i < n; i++) {
676 if (!check_set_resp_len(rctx, resp_len))
680 rctx->state = OHS_CONTENT;
685 n = BIO_get_mem_data(rctx->mem, NULL);
686 if (n < (long)rctx->resp_len /* may be 0 if no Content-Type or ASN.1 */)
689 rctx->state = OHS_DONE;
694 #ifndef OPENSSL_NO_SOCK
696 /* set up a new connection BIO, to HTTP server or to HTTP(S) proxy if given */
697 static BIO *HTTP_new_bio(const char *server /* optionally includes ":port" */,
698 const char *server_port /* explicit server port */,
699 const char *proxy /* optionally includes ":port" */)
701 const char *host = server, *host_end;
703 const char *port = server_port;
706 if (!ossl_assert(server != NULL))
714 host_end = strchr(host, '/');
715 if (host_end != NULL && (size_t)(host_end - host) < sizeof(host_name)) {
716 /* chop trailing string starting with '/' */
717 strncpy(host_name, host, host_end - host + 1);
721 cbio = BIO_new_connect(host /* optionally includes ":port" */);
725 (void)BIO_set_conn_port(cbio, port);
730 #endif /* OPENSSL_NO_SOCK */
732 static ASN1_VALUE *BIO_mem_d2i(BIO *mem, const ASN1_ITEM *it)
734 const unsigned char *p;
735 long len = BIO_get_mem_data(mem, &p);
736 ASN1_VALUE *resp = ASN1_item_d2i(NULL, &p, len, it);
739 HTTPerr(0, HTTP_R_RESPONSE_PARSE_ERROR);
743 static BIO *OSSL_HTTP_REQ_CTX_transfer(OSSL_HTTP_REQ_CTX *rctx)
749 HTTPerr(0, ERR_R_PASSED_NULL_PARAMETER);
754 rv = OSSL_HTTP_REQ_CTX_nbio(rctx);
757 /* BIO_should_retry was true */
759 /* will not actually wait if rctx->max_time == 0 */
760 if (BIO_wait(rctx->rbio, rctx->max_time, 100 /* milliseconds */) <= 0)
765 if (rctx->redirection_url == NULL) { /* an error occurred */
766 if (sending && (rctx->state & OHS_NOREAD) != 0)
767 HTTPerr(0, HTTP_R_ERROR_SENDING);
769 HTTPerr(0, HTTP_R_ERROR_RECEIVING);
773 if (!BIO_up_ref(rctx->mem))
778 /* Exchange ASN.1-encoded request and response via HTTP on (non-)blocking BIO */
779 ASN1_VALUE *OSSL_HTTP_REQ_CTX_sendreq_d2i(OSSL_HTTP_REQ_CTX *rctx,
782 if (rctx == NULL || it == NULL) {
783 HTTPerr(0, ERR_R_PASSED_NULL_PARAMETER);
786 return BIO_mem_d2i(OSSL_HTTP_REQ_CTX_transfer(rctx), it);
789 static int update_timeout(int timeout, time_t start_time)
795 elapsed_time = (long)(time(NULL) - start_time); /* this might overflow */
796 return timeout <= elapsed_time ? -1 : timeout - elapsed_time;
800 * Exchange HTTP request and response with the given server.
801 * If req_mem == NULL then use GET and ignore content_type, else POST.
802 * The redirection_url output (freed by caller) parameter is used only for GET.
804 * Typically the bio and rbio parameters are NULL and a network BIO is created
805 * internally for connecting to the given server and port, optionally via a
806 * proxy and its port, and is then used for exchanging the request and response.
807 * If bio is given and rbio is NULL then this BIO is used instead.
808 * If both bio and rbio are given (which may be memory BIOs for instance)
809 * then no explicit connection is attempted,
810 * bio is used for writing the request, and rbio for reading the response.
812 * bio_update_fn is an optional BIO connect/disconnect callback function,
813 * which has the prototype
814 * BIO *(*OSSL_HTTP_bio_cb_t) (BIO *bio, void *arg, int conn, int detail);
815 * The callback may modify the HTTP BIO provided in the bio argument,
816 * whereby it may make use of any custom defined argument 'arg'.
817 * During connection establishment, just after BIO_do_connect_retry(),
818 * the callback function is invoked with the 'conn' argument being 1
819 * 'detail' indicating whether a HTTPS (i.e., TLS) connection is requested.
820 * On disconnect 'conn' is 0 and 'detail' indicates that no error occurred.
821 * For instance, on connect the funct may prepend a TLS BIO to implement HTTPS;
822 * after disconnect it may do some error diagnostics and/or specific cleanup.
823 * The function should return NULL to indicate failure.
824 * After disconnect the modified BIO will be deallocated using BIO_free_all().
826 BIO *OSSL_HTTP_transfer(const char *server, const char *port, const char *path,
827 int use_ssl, const char *proxy, const char *no_proxy,
829 OSSL_HTTP_bio_cb_t bio_update_fn, void *arg,
830 const STACK_OF(CONF_VALUE) *headers,
831 const char *content_type, BIO *req_mem,
832 int maxline, unsigned long max_resp_len, int timeout,
833 const char *expected_ct, int expect_asn1,
834 char **redirection_url)
836 time_t start_time = timeout > 0 ? time(NULL) : 0;
837 BIO *cbio; /* = bio if present, used as connection BIO if rbio is NULL */
838 OSSL_HTTP_REQ_CTX *rctx;
841 if (redirection_url != NULL)
842 *redirection_url = NULL; /* do this beforehand to prevent dbl free */
844 if (use_ssl && bio_update_fn == NULL) {
845 HTTPerr(0, HTTP_R_TLS_NOT_ENABLED);
848 if (rbio != NULL && (bio == NULL || bio_update_fn != NULL)) {
849 HTTPerr(0, ERR_R_PASSED_INVALID_ARGUMENT);
856 #ifndef OPENSSL_NO_SOCK
857 if (server == NULL) {
858 HTTPerr(0, ERR_R_PASSED_NULL_PARAMETER);
863 if (port == NULL && strchr(server, ':') == NULL)
864 port = use_ssl ? OSSL_HTTPS_PORT : OSSL_HTTP_PORT;
865 proxy = http_adapt_proxy(proxy, no_proxy, server, use_ssl);
866 if ((cbio = HTTP_new_bio(server, port, proxy)) == NULL)
869 HTTPerr(0, HTTP_R_SOCK_NOT_SUPPORTED);
873 /* remaining parameters are checked indirectly by the functions called */
875 (void)ERR_set_mark(); /* prepare removing any spurious libssl errors */
876 if (rbio == NULL && BIO_do_connect_retry(cbio, timeout, -1) <= 0)
878 /* now timeout is guaranteed to be >= 0 */
880 /* callback can be used to wrap or prepend TLS session */
881 if (bio_update_fn != NULL) {
882 BIO *orig_bio = cbio;
883 cbio = (*bio_update_fn)(cbio, arg, 1 /* connect */, use_ssl);
890 rctx = HTTP_REQ_CTX_new(cbio, rbio != NULL ? rbio : cbio,
891 !use_ssl && proxy != NULL, server, port, path,
892 headers, content_type, req_mem, maxline,
893 max_resp_len, update_timeout(timeout, start_time),
894 expected_ct, expect_asn1);
898 resp = OSSL_HTTP_REQ_CTX_transfer(rctx);
900 if (rctx->redirection_url != NULL) {
901 if (redirection_url == NULL)
902 HTTPerr(0, HTTP_R_REDIRECTION_NOT_ENABLED);
904 /* may be NULL if out of memory: */
905 *redirection_url = OPENSSL_strdup(rctx->redirection_url);
908 unsigned long err = ERR_peek_error();
909 int lib = ERR_GET_LIB(err);
910 int reason = ERR_GET_REASON(err);
912 if (lib == ERR_LIB_SSL || lib == ERR_LIB_HTTP
913 || (lib == ERR_LIB_BIO && reason == BIO_R_CONNECT_TIMEOUT)
914 || (lib == ERR_LIB_BIO && reason == BIO_R_CONNECT_ERROR)
915 #ifndef OPENSSL_NO_CMP
916 || (lib == ERR_LIB_CMP
917 && reason == CMP_R_POTENTIALLY_INVALID_CERTIFICATE)
920 BIO_snprintf(buf, 200, "server=%s:%s", server, port);
921 ERR_add_error_data(1, buf);
923 ERR_add_error_data(2, " proxy=", proxy);
925 BIO_snprintf(buf, 200, " peer has disconnected%s",
926 use_ssl ? " violating the protocol" :
927 ", likely because it requires the use of TLS");
928 ERR_add_error_data(1, buf);
933 OSSL_HTTP_REQ_CTX_free(rctx);
935 /* callback can be used to clean up TLS session */
936 if (bio_update_fn != NULL
937 && (*bio_update_fn)(cbio, arg, 0, resp != NULL) == NULL) {
944 * Use BIO_free_all() because bio_update_fn may prepend or append to cbio.
945 * This also frees any (e.g., SSL/TLS) BIOs linked with bio and,
946 * like BIO_reset(bio), calls SSL_shutdown() to notify/alert the peer.
948 if (bio == NULL) /* cbio was not provided by caller */
952 /* remove any spurious error queue entries by ssl_add_cert_chain() */
953 (void)ERR_pop_to_mark();
955 (void)ERR_clear_last_mark();
960 static int redirection_ok(int n_redir, const char *old_url, const char *new_url)
962 size_t https_len = strlen(OSSL_HTTPS_NAME":");
964 if (n_redir >= HTTP_VERSION_MAX_REDIRECTIONS) {
965 HTTPerr(0, HTTP_R_TOO_MANY_REDIRECTIONS);
968 if (*new_url == '/') /* redirection to same server => same protocol */
970 if (strncmp(old_url, OSSL_HTTPS_NAME":", https_len) == 0 &&
971 strncmp(new_url, OSSL_HTTPS_NAME":", https_len) != 0) {
972 HTTPerr(0, HTTP_R_REDIRECTION_FROM_HTTPS_TO_HTTP);
978 /* Get data via HTTP from server at given URL, potentially with redirection */
979 BIO *OSSL_HTTP_get(const char *url, const char *proxy, const char *no_proxy,
981 OSSL_HTTP_bio_cb_t bio_update_fn, void *arg,
982 const STACK_OF(CONF_VALUE) *headers,
983 int maxline, unsigned long max_resp_len, int timeout,
984 const char *expected_content_type, int expect_asn1)
986 time_t start_time = timeout > 0 ? time(NULL) : 0;
987 char *current_url, *redirection_url;
996 HTTPerr(0, ERR_R_PASSED_NULL_PARAMETER);
999 if ((current_url = OPENSSL_strdup(url)) == NULL)
1003 if (!OSSL_HTTP_parse_url(current_url, &host, &port, &path, &use_ssl))
1007 resp = OSSL_HTTP_transfer(host, port, path, use_ssl, proxy, no_proxy,
1009 bio_update_fn, arg, headers, NULL, NULL,
1010 maxline, max_resp_len,
1011 update_timeout(timeout, start_time),
1012 expected_content_type, expect_asn1,
1015 if (resp == NULL && redirection_url != NULL) {
1016 if (redirection_ok(++n_redirs, current_url, redirection_url)) {
1017 (void)BIO_reset(bio);
1018 OPENSSL_free(current_url);
1019 current_url = redirection_url;
1020 if (*redirection_url == '/') { /* redirection to same server */
1021 path = OPENSSL_strdup(redirection_url);
1028 OPENSSL_free(redirection_url);
1034 OPENSSL_free(current_url);
1038 /* Get ASN.1-encoded data via HTTP from server at given URL */
1039 ASN1_VALUE *OSSL_HTTP_get_asn1(const char *url,
1040 const char *proxy, const char *no_proxy,
1041 BIO *bio, BIO *rbio,
1042 OSSL_HTTP_bio_cb_t bio_update_fn, void *arg,
1043 const STACK_OF(CONF_VALUE) *headers,
1044 int maxline, unsigned long max_resp_len,
1045 int timeout, const char *expected_content_type,
1046 const ASN1_ITEM *it)
1049 ASN1_VALUE *resp = NULL;
1051 if (url == NULL || it == NULL) {
1052 HTTPerr(0, ERR_R_PASSED_NULL_PARAMETER);
1055 if ((mem = OSSL_HTTP_get(url, proxy, no_proxy, bio, rbio, bio_update_fn,
1056 arg, headers, maxline, max_resp_len, timeout,
1057 expected_content_type, 1 /* expect_asn1 */))
1059 resp = BIO_mem_d2i(mem, it);
1064 /* Post ASN.1-encoded request via HTTP to server return ASN.1 response */
1065 ASN1_VALUE *OSSL_HTTP_post_asn1(const char *server, const char *port,
1066 const char *path, int use_ssl,
1067 const char *proxy, const char *no_proxy,
1068 BIO *bio, BIO *rbio,
1069 OSSL_HTTP_bio_cb_t bio_update_fn, void *arg,
1070 const STACK_OF(CONF_VALUE) *headers,
1071 const char *content_type,
1072 const ASN1_VALUE *req, const ASN1_ITEM *req_it,
1073 int maxline, unsigned long max_resp_len,
1074 int timeout, const char *expected_ct,
1075 const ASN1_ITEM *rsp_it)
1079 ASN1_VALUE *resp = NULL;
1082 HTTPerr(0, ERR_R_PASSED_NULL_PARAMETER);
1085 /* remaining parameters are checked indirectly */
1087 req_mem = HTTP_asn1_item2bio(req_it, req);
1088 res_mem = OSSL_HTTP_transfer(server, port, path, use_ssl, proxy, no_proxy,
1090 bio_update_fn, arg, headers, content_type,
1091 req_mem /* may be NULL */, maxline,
1092 max_resp_len, timeout,
1093 expected_ct, 1 /* expect_asn1 */, NULL);
1095 if (res_mem != NULL)
1096 resp = BIO_mem_d2i(res_mem, rsp_it);
1101 /* BASE64 encoder used for encoding basic proxy authentication credentials */
1102 static char *base64encode(const void *buf, size_t len)
1108 /* Calculate size of encoded data */
1113 out = OPENSSL_malloc(outl + 1);
1117 i = EVP_EncodeBlock((unsigned char *)out, buf, len);
1118 if (!ossl_assert(0 <= i && (size_t)i <= outl)) {
1126 * Promote the given connection BIO using the CONNECT method for a TLS proxy.
1127 * This is typically called by an app, so bio_err and prog are used unless NULL
1128 * to print additional diagnostic information in a user-oriented way.
1130 int OSSL_HTTP_proxy_connect(BIO *bio, const char *server, const char *port,
1131 const char *proxyuser, const char *proxypass,
1132 int timeout, BIO *bio_err, const char *prog)
1135 #define BUF_SIZE (8 * 1024)
1136 char *mbuf = OPENSSL_malloc(BUF_SIZE);
1140 BIO *fbio = BIO_new(BIO_f_buffer());
1142 time_t max_time = timeout > 0 ? time(NULL) + timeout : 0;
1144 if (bio == NULL || server == NULL
1145 || (bio_err != NULL && prog == NULL)) {
1146 HTTPerr(0, ERR_R_PASSED_NULL_PARAMETER);
1149 if (port == NULL || *port == '\0')
1150 port = OSSL_HTTPS_PORT;
1152 if (mbuf == NULL || fbio == NULL) {
1153 BIO_printf(bio_err /* may be NULL */, "%s: out of memory", prog);
1156 BIO_push(fbio, bio);
1158 BIO_printf(fbio, "CONNECT %s:%s "HTTP_PREFIX"1.0\r\n", server, port);
1161 * Workaround for broken proxies which would otherwise close
1162 * the connection when entering tunnel mode (e.g., Squid 2.6)
1164 BIO_printf(fbio, "Proxy-Connection: Keep-Alive\r\n");
1166 /* Support for basic (base64) proxy authentication */
1167 if (proxyuser != NULL) {
1168 size_t len = strlen(proxyuser) + 1;
1169 char *proxyauth, *proxyauthenc = NULL;
1171 if (proxypass != NULL)
1172 len += strlen(proxypass);
1173 proxyauth = OPENSSL_malloc(len + 1);
1174 if (proxyauth == NULL)
1176 if (BIO_snprintf(proxyauth, len + 1, "%s:%s", proxyuser,
1177 proxypass != NULL ? proxypass : "") != (int)len)
1179 proxyauthenc = base64encode(proxyauth, len);
1180 if (proxyauthenc != NULL) {
1181 BIO_printf(fbio, "Proxy-Authorization: Basic %s\r\n", proxyauthenc);
1182 OPENSSL_clear_free(proxyauthenc, strlen(proxyauthenc));
1185 OPENSSL_clear_free(proxyauth, len);
1186 if (proxyauthenc == NULL)
1190 /* Terminate the HTTP CONNECT request */
1191 BIO_printf(fbio, "\r\n");
1194 if (BIO_flush(fbio) != 0)
1196 /* potentially needs to be retried if BIO is non-blocking */
1197 if (!BIO_should_retry(fbio))
1202 /* will not actually wait if timeout == 0 */
1203 rv = BIO_wait(fbio, max_time, 100 /* milliseconds */);
1205 BIO_printf(bio_err, "%s: HTTP CONNECT %s\n", prog,
1206 rv == 0 ? "timed out" : "failed waiting for data");
1211 * The first line is the HTTP response.
1212 * According to RFC 7230, it is formatted exactly like this:
1213 * HTTP/d.d ddd Reason text\r\n
1215 read_len = BIO_gets(fbio, mbuf, BUF_SIZE);
1216 /* the BIO may not block, so we must wait for the 1st line to come in */
1217 if (read_len < HTTP_LINE1_MINLEN)
1220 /* RFC 7231 4.3.6: any 2xx status code is valid */
1221 if (strncmp(mbuf, HTTP_PREFIX, strlen(HTTP_PREFIX)) != 0) {
1222 HTTPerr(0, HTTP_R_RESPONSE_PARSE_ERROR);
1223 BIO_printf(bio_err, "%s: HTTP CONNECT failed, non-HTTP response\n",
1225 /* Wrong protocol, not even HTTP, so stop reading headers */
1228 mbufp = mbuf + strlen(HTTP_PREFIX);
1229 if (strncmp(mbufp, HTTP_VERSION_PATT, strlen(HTTP_VERSION_PATT)) != 0) {
1230 HTTPerr(0, HTTP_R_RECEIVED_WRONG_HTTP_VERSION);
1232 "%s: HTTP CONNECT failed, bad HTTP version %.*s\n",
1233 prog, HTTP_VERSION_STR_LEN, mbufp);
1236 mbufp += HTTP_VERSION_STR_LEN;
1237 if (strncmp(mbufp, " 2", strlen(" 2")) != 0) {
1239 /* chop any trailing whitespace */
1240 while (read_len > 0 && ossl_isspace(mbuf[read_len - 1]))
1242 mbuf[read_len] = '\0';
1243 HTTPerr(0, HTTP_R_CONNECT_FAILURE);
1244 ERR_add_error_data(2, "Reason=", mbufp);
1245 BIO_printf(bio_err, "%s: HTTP CONNECT failed, Reason=%s\n",
1253 /* Read past all following headers */
1256 * TODO: This does not necessarily catch the case when the full
1257 * HTTP response came in in more than a single TCP message.
1259 read_len = BIO_gets(fbio, mbuf, BUF_SIZE);
1260 } while (read_len > 2);
1264 (void)BIO_flush(fbio);