2 * Copyright 2001-2021 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 HTTP_PREFIX "HTTP/"
29 #define HTTP_VERSION_PATT "1." /* allow 1.x */
30 #define HTTP_VERSION_STR_LEN 3
31 #define HTTP_LINE1_MINLEN ((int)strlen(HTTP_PREFIX HTTP_VERSION_PATT "x 200\n"))
32 #define HTTP_VERSION_MAX_REDIRECTIONS 50
34 #define HTTP_STATUS_CODE_OK 200
35 #define HTTP_STATUS_CODE_MOVED_PERMANENTLY 301
36 #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 *readbuf; /* Buffer for reading response by line */
46 int readbuflen; /* Buffer length, equals maxline */
47 BIO *wbio; /* BIO to send request to */
48 BIO *rbio; /* BIO to read response from */
49 BIO *mem; /* Memory BIO response is built into */
50 int method_POST; /* HTTP method is "POST" (else "GET") */
51 const char *expected_ct; /* expected Content-Type, or NULL */
52 int expect_asn1; /* response must be ASN.1-encoded */
53 long len_to_send; /* number of bytes in request still to send */
54 unsigned long resp_len; /* length of response */
55 unsigned long max_resp_len; /* Maximum length of response */
56 time_t max_time; /* Maximum end time of the transfer, or 0 */
57 char *redirection_url; /* Location given with HTTP status 301/302 */
62 #define OHS_NOREAD 0x1000 /* If set no reading should be performed */
63 #define OHS_ERROR (0 | OHS_NOREAD) /* Error condition */
64 #define OHS_FIRSTLINE 1 /* First line being read */
65 #define OHS_REDIRECT 0xa /* Looking for redirection location */
66 #define OHS_HEADERS 2 /* MIME headers being read */
67 #define OHS_ASN1_HEADER 3 /* HTTP initial header (tag+length) being read */
68 #define OHS_CONTENT 4 /* HTTP content octets being read */
69 #define OHS_WRITE_INIT (5 | OHS_NOREAD) /* 1st call: ready to start send */
70 #define OHS_WRITE (6 | OHS_NOREAD) /* Request being sent */
71 #define OHS_FLUSH (7 | OHS_NOREAD) /* Request being flushed */
72 #define OHS_DONE (8 | OHS_NOREAD) /* Completed */
73 #define OHS_HTTP_HEADER (9 | OHS_NOREAD) /* Headers set, w/o final \r\n */
75 OSSL_HTTP_REQ_CTX *OSSL_HTTP_REQ_CTX_new(BIO *wbio, BIO *rbio,
76 int method_POST, int maxline,
77 unsigned long max_resp_len,
79 const char *expected_content_type,
82 OSSL_HTTP_REQ_CTX *rctx;
84 if (wbio == NULL || rbio == NULL) {
85 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
89 if ((rctx = OPENSSL_zalloc(sizeof(*rctx))) == NULL)
91 rctx->state = OHS_ERROR;
92 rctx->readbuflen = maxline > 0 ? maxline : HTTP_DEFAULT_MAX_LINE_LENGTH;
93 rctx->readbuf = OPENSSL_malloc(rctx->readbuflen);
96 if (rctx->readbuf == NULL) {
100 rctx->method_POST = method_POST;
101 rctx->expected_ct = expected_content_type;
102 rctx->expect_asn1 = expect_asn1;
104 OSSL_HTTP_REQ_CTX_set_max_response_length(rctx, max_resp_len);
105 rctx->max_time = timeout > 0 ? time(NULL) + timeout : 0;
106 /* everything else is 0, e.g. rctx->len_to_send, or NULL, e.g. rctx->mem */
110 void OSSL_HTTP_REQ_CTX_free(OSSL_HTTP_REQ_CTX *rctx)
114 BIO_free(rctx->mem); /* this may indirectly call ERR_clear_error() */
115 OPENSSL_free(rctx->readbuf);
119 BIO *OSSL_HTTP_REQ_CTX_get0_mem_bio(const OSSL_HTTP_REQ_CTX *rctx)
122 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
128 void OSSL_HTTP_REQ_CTX_set_max_response_length(OSSL_HTTP_REQ_CTX *rctx,
132 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
135 rctx->max_resp_len = len != 0 ? len : HTTP_DEFAULT_MAX_RESP_LEN;
139 * Create request line using |ctx| and |path| (or "/" in case |path| is NULL).
140 * Server name (and port) must be given if and only if plain HTTP proxy is used.
142 int OSSL_HTTP_REQ_CTX_set_request_line(OSSL_HTTP_REQ_CTX *rctx,
143 const char *server, const char *port,
147 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
151 if ((rctx->mem = BIO_new(BIO_s_mem())) == NULL)
154 if (BIO_printf(rctx->mem, "%s ", rctx->method_POST ? "POST" : "GET") <= 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 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
187 if (rctx->mem == NULL) {
188 ERR_raise(ERR_LIB_HTTP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
192 if (BIO_puts(rctx->mem, name) <= 0)
195 if (BIO_write(rctx->mem, ": ", 2) != 2)
197 if (BIO_puts(rctx->mem, value) <= 0)
200 if (BIO_write(rctx->mem, "\r\n", 2) != 2)
202 rctx->state = OHS_HTTP_HEADER;
206 static int OSSL_HTTP_REQ_CTX_set_content(OSSL_HTTP_REQ_CTX *rctx,
207 const char *content_type, BIO *req_mem)
209 const unsigned char *req;
212 if (rctx == NULL || req_mem == NULL) {
213 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
216 if (rctx->mem == NULL || !rctx->method_POST) {
217 ERR_raise(ERR_LIB_HTTP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
221 if (content_type != NULL
222 && BIO_printf(rctx->mem, "Content-Type: %s\r\n", content_type) <= 0)
225 if ((req_len = BIO_get_mem_data(req_mem, &req)) <= 0)
227 rctx->state = OHS_WRITE_INIT;
229 return BIO_printf(rctx->mem, "Content-Length: %ld\r\n\r\n", req_len) > 0
230 && BIO_write(rctx->mem, req, req_len) == (int)req_len;
233 BIO *HTTP_asn1_item2bio(const ASN1_ITEM *it, const ASN1_VALUE *val)
237 if (it == NULL || val == NULL) {
238 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
242 if ((res = BIO_new(BIO_s_mem())) == NULL)
244 if (ASN1_item_i2d_bio(it, res, val) <= 0) {
251 int OSSL_HTTP_REQ_CTX_i2d(OSSL_HTTP_REQ_CTX *rctx, const char *content_type,
252 const ASN1_ITEM *it, ASN1_VALUE *req)
257 if (rctx == NULL || it == NULL || req == NULL) {
258 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
262 res = (mem = HTTP_asn1_item2bio(it, req)) != NULL
263 && OSSL_HTTP_REQ_CTX_set_content(rctx, content_type, mem);
268 static int OSSL_HTTP_REQ_CTX_add1_headers(OSSL_HTTP_REQ_CTX *rctx,
269 const STACK_OF(CONF_VALUE) *headers,
276 for (i = 0; i < sk_CONF_VALUE_num(headers); i++) {
277 hdr = sk_CONF_VALUE_value(headers, i);
278 if (add_host && strcasecmp("host", hdr->name) == 0)
280 if (!OSSL_HTTP_REQ_CTX_add1_header(rctx, hdr->name, hdr->value))
284 if (add_host && !OSSL_HTTP_REQ_CTX_add1_header(rctx, "Host", host))
290 * Create OSSL_HTTP_REQ_CTX structure using the values provided.
291 * If !use_http_proxy then the 'server' and 'port' parameters are ignored.
292 * If req_mem == NULL then use GET and ignore content_type, else POST.
294 OSSL_HTTP_REQ_CTX *HTTP_REQ_CTX_new(BIO *wbio, BIO *rbio, int use_http_proxy,
295 const char *server, const char *port,
297 const STACK_OF(CONF_VALUE) *headers,
298 const char *content_type, BIO *req_mem,
299 int maxline, unsigned long max_resp_len,
301 const char *expected_content_type,
304 OSSL_HTTP_REQ_CTX *rctx;
306 if (use_http_proxy && (server == NULL || port == NULL)) {
307 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
310 /* remaining parameters are checked indirectly by the functions called */
312 if ((rctx = OSSL_HTTP_REQ_CTX_new(wbio, rbio, req_mem != NULL, maxline,
313 max_resp_len, timeout,
314 expected_content_type, expect_asn1))
318 if (OSSL_HTTP_REQ_CTX_set_request_line(rctx,
319 use_http_proxy ? server : NULL, port,
321 && OSSL_HTTP_REQ_CTX_add1_headers(rctx, headers, server)
323 || OSSL_HTTP_REQ_CTX_set_content(rctx, content_type, req_mem)))
326 OSSL_HTTP_REQ_CTX_free(rctx);
331 * Parse first HTTP response line. This should be like this: "HTTP/1.0 200 OK".
332 * We need to obtain the numeric code and (optional) informational message.
335 static int parse_http_line1(char *line)
338 char *code, *reason, *end;
340 /* Skip to first whitespace (past protocol info) */
341 for (code = line; *code != '\0' && !ossl_isspace(*code); code++)
344 ERR_raise(ERR_LIB_HTTP, HTTP_R_RESPONSE_PARSE_ERROR);
348 /* Skip past whitespace to start of response code */
349 while (*code != '\0' && ossl_isspace(*code))
353 ERR_raise(ERR_LIB_HTTP, HTTP_R_RESPONSE_PARSE_ERROR);
357 /* Find end of response code: first whitespace after start of code */
358 for (reason = code; *reason != '\0' && !ossl_isspace(*reason); reason++)
361 if (*reason == '\0') {
362 ERR_raise(ERR_LIB_HTTP, HTTP_R_RESPONSE_PARSE_ERROR);
366 /* Set end of response code and start of message */
369 /* Attempt to parse numeric code */
370 retcode = strtoul(code, &end, 10);
375 /* Skip over any leading whitespace in message */
376 while (*reason != '\0' && ossl_isspace(*reason))
379 if (*reason != '\0') {
381 * Finally zap any trailing whitespace in message (include CRLF)
384 /* chop any trailing whitespace from reason */
385 /* We know reason has a non-whitespace character so this is OK */
386 for (end = reason + strlen(reason) - 1; ossl_isspace(*end); end--)
391 case HTTP_STATUS_CODE_OK:
392 case HTTP_STATUS_CODE_MOVED_PERMANENTLY:
393 case HTTP_STATUS_CODE_FOUND:
397 retcode = HTTP_R_STATUS_CODE_UNSUPPORTED;
399 retcode = HTTP_R_RECEIVED_ERROR;
401 ERR_raise_data(ERR_LIB_HTTP, retcode, "Code=%s", code);
403 ERR_raise_data(ERR_LIB_HTTP, retcode,
404 "Code=%s, Reason=%s", code, reason);
409 static int check_set_resp_len(OSSL_HTTP_REQ_CTX *rctx, unsigned long len)
411 if (len > rctx->max_resp_len)
412 ERR_raise_data(ERR_LIB_HTTP, HTTP_R_MAX_RESP_LEN_EXCEEDED,
413 "length=%lu, max=%lu", len, rctx->max_resp_len);
414 if (rctx->resp_len != 0 && rctx->resp_len != len)
415 ERR_raise_data(ERR_LIB_HTTP, HTTP_R_INCONSISTENT_CONTENT_LENGTH,
416 "ASN.1 length=%lu, Content-Length=%lu",
417 len, rctx->resp_len);
418 rctx->resp_len = len;
423 * Try exchanging request and response via HTTP on (non-)blocking BIO in rctx.
424 * Returns 1 on success, 0 on error or redirection, -1 on BIO_should_retry.
426 int OSSL_HTTP_REQ_CTX_nbio(OSSL_HTTP_REQ_CTX *rctx)
430 unsigned long resp_len;
431 const unsigned char *p;
432 char *key, *value, *line_end = NULL;
435 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
438 if (rctx->mem == NULL || rctx->wbio == NULL || rctx->rbio == NULL) {
439 ERR_raise(ERR_LIB_HTTP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
443 rctx->redirection_url = NULL;
445 if ((rctx->state & OHS_NOREAD) == 0) {
446 n = BIO_read(rctx->rbio, rctx->readbuf, rctx->readbuflen);
448 if (BIO_should_retry(rctx->rbio))
450 ERR_raise(ERR_LIB_HTTP, HTTP_R_FAILED_READING_DATA);
454 /* Write data to memory BIO */
455 if (BIO_write(rctx->mem, rctx->readbuf, 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 rctx->len_to_send = BIO_get_mem_data(rctx->mem, NULL);
471 rctx->state = OHS_WRITE;
475 n = BIO_get_mem_data(rctx->mem, &p) - rctx->len_to_send;
476 i = BIO_write(rctx->wbio, p + n, rctx->len_to_send);
479 if (BIO_should_retry(rctx->wbio))
481 rctx->state = OHS_ERROR;
485 rctx->len_to_send -= i;
487 if (rctx->len_to_send > 0)
490 rctx->state = OHS_FLUSH;
492 (void)BIO_reset(rctx->mem);
497 i = BIO_flush(rctx->wbio);
500 rctx->state = OHS_FIRSTLINE;
504 if (BIO_should_retry(rctx->wbio))
507 rctx->state = OHS_ERROR;
517 /* Attempt to read a line in */
520 * Due to strange memory BIO behavior with BIO_gets we have to check
521 * there's a complete line in there before calling BIO_gets or we'll
522 * just get a partial read.
524 n = BIO_get_mem_data(rctx->mem, &p);
525 if (n <= 0 || memchr(p, '\n', n) == 0) {
526 if (n >= rctx->readbuflen) {
527 rctx->state = OHS_ERROR;
532 n = BIO_gets(rctx->mem, (char *)rctx->readbuf, rctx->readbuflen);
535 if (BIO_should_retry(rctx->mem))
537 rctx->state = OHS_ERROR;
541 /* Don't allow excessive lines */
542 if (n == rctx->readbuflen) {
543 ERR_raise(ERR_LIB_HTTP, HTTP_R_RESPONSE_LINE_TOO_LONG);
544 rctx->state = OHS_ERROR;
549 if (rctx->state == OHS_FIRSTLINE) {
550 switch (parse_http_line1((char *)rctx->readbuf)) {
551 case HTTP_STATUS_CODE_OK:
552 rctx->state = OHS_HEADERS;
554 case HTTP_STATUS_CODE_MOVED_PERMANENTLY:
555 case HTTP_STATUS_CODE_FOUND: /* i.e., moved temporarily */
556 if (!rctx->method_POST) { /* method is GET */
557 rctx->state = OHS_REDIRECT;
560 ERR_raise(ERR_LIB_HTTP, HTTP_R_REDIRECTION_NOT_ENABLED);
561 /* redirection is not supported/recommended for POST */
564 rctx->state = OHS_ERROR;
568 key = (char *)rctx->readbuf;
569 value = strchr(key, ':');
572 while (ossl_isspace(*value))
574 line_end = strchr(value, '\r');
575 if (line_end == NULL)
576 line_end = strchr(value, '\n');
577 if (line_end != NULL)
580 if (value != NULL && line_end != NULL) {
581 if (rctx->state == OHS_REDIRECT
582 && strcasecmp(key, "Location") == 0) {
583 rctx->redirection_url = value;
586 if (rctx->expected_ct != NULL
587 && strcasecmp(key, "Content-Type") == 0) {
588 if (strcasecmp(rctx->expected_ct, value) != 0) {
589 ERR_raise_data(ERR_LIB_HTTP, HTTP_R_UNEXPECTED_CONTENT_TYPE,
590 "expected=%s, actual=%s",
591 rctx->expected_ct, value);
594 rctx->expected_ct = NULL; /* content-type has been found */
596 if (strcasecmp(key, "Content-Length") == 0) {
597 resp_len = strtoul(value, &line_end, 10);
598 if (line_end == value || *line_end != '\0') {
599 ERR_raise_data(ERR_LIB_HTTP,
600 HTTP_R_ERROR_PARSING_CONTENT_LENGTH,
604 if (!check_set_resp_len(rctx, resp_len))
609 /* Look for blank line indicating end of headers */
610 for (p = rctx->readbuf; *p != '\0'; p++) {
611 if (*p != '\r' && *p != '\n')
614 if (*p != '\0') /* not end of headers */
617 if (rctx->expected_ct != NULL) {
618 ERR_raise_data(ERR_LIB_HTTP, HTTP_R_MISSING_CONTENT_TYPE,
619 "expected=%s", rctx->expected_ct);
622 if (rctx->state == OHS_REDIRECT) {
623 /* http status code indicated redirect but there was no Location */
624 ERR_raise(ERR_LIB_HTTP, 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 ERR_raise(ERR_LIB_HTTP, 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 ERR_raise(ERR_LIB_HTTP, 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) {
716 size_t host_len = host_end - host;
718 if (host_len < sizeof(host_name)) {
719 /* chop trailing string starting with '/' */
720 strncpy(host_name, host, host_len);
721 host_name[host_len] = '\0';
726 cbio = BIO_new_connect(host /* optionally includes ":port" */);
730 (void)BIO_set_conn_port(cbio, port);
735 #endif /* OPENSSL_NO_SOCK */
737 static ASN1_VALUE *BIO_mem_d2i(BIO *mem, const ASN1_ITEM *it)
739 const unsigned char *p;
740 long len = BIO_get_mem_data(mem, &p);
741 ASN1_VALUE *resp = ASN1_item_d2i(NULL, &p, len, it);
744 ERR_raise(ERR_LIB_HTTP, HTTP_R_RESPONSE_PARSE_ERROR);
748 static BIO *OSSL_HTTP_REQ_CTX_transfer(OSSL_HTTP_REQ_CTX *rctx)
754 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
759 rv = OSSL_HTTP_REQ_CTX_nbio(rctx);
762 /* BIO_should_retry was true */
764 /* will not actually wait if rctx->max_time == 0 */
765 if (BIO_wait(rctx->rbio, rctx->max_time, 100 /* milliseconds */) <= 0)
770 if (rctx->redirection_url == NULL) { /* an error occurred */
771 if (sending && (rctx->state & OHS_NOREAD) != 0)
772 ERR_raise(ERR_LIB_HTTP, HTTP_R_ERROR_SENDING);
774 ERR_raise(ERR_LIB_HTTP, HTTP_R_ERROR_RECEIVING);
778 if (!BIO_up_ref(rctx->mem))
783 /* Exchange ASN.1-encoded request and response via HTTP on (non-)blocking BIO */
784 ASN1_VALUE *OSSL_HTTP_REQ_CTX_sendreq_d2i(OSSL_HTTP_REQ_CTX *rctx,
787 if (rctx == NULL || it == NULL) {
788 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
791 return BIO_mem_d2i(OSSL_HTTP_REQ_CTX_transfer(rctx), it);
794 static int update_timeout(int timeout, time_t start_time)
800 elapsed_time = (long)(time(NULL) - start_time); /* this might overflow */
801 return timeout <= elapsed_time ? -1 : timeout - elapsed_time;
805 * Exchange HTTP request and response with the given server.
806 * If req_mem == NULL then use GET and ignore content_type, else POST.
807 * The redirection_url output (freed by caller) parameter is used only for GET.
809 * Typically the bio and rbio parameters are NULL and a network BIO is created
810 * internally for connecting to the given server and port, optionally via a
811 * proxy and its port, and is then used for exchanging the request and response.
812 * If bio is given and rbio is NULL then this BIO is used instead.
813 * If both bio and rbio are given (which may be memory BIOs for instance)
814 * then no explicit connection is attempted,
815 * bio is used for writing the request, and rbio for reading the response.
817 * bio_update_fn is an optional BIO connect/disconnect callback function,
818 * which has the prototype
819 * BIO *(*OSSL_HTTP_bio_cb_t) (BIO *bio, void *arg, int conn, int detail);
820 * The callback may modify the HTTP BIO provided in the bio argument,
821 * whereby it may make use of any custom defined argument 'arg'.
822 * During connection establishment, just after BIO_do_connect_retry(),
823 * the callback function is invoked with the 'conn' argument being 1
824 * 'detail' indicating whether a HTTPS (i.e., TLS) connection is requested.
825 * On disconnect 'conn' is 0 and 'detail' indicates that no error occurred.
826 * For instance, on connect the funct may prepend a TLS BIO to implement HTTPS;
827 * after disconnect it may do some error diagnostics and/or specific cleanup.
828 * The function should return NULL to indicate failure.
829 * After disconnect the modified BIO will be deallocated using BIO_free_all().
831 BIO *OSSL_HTTP_transfer(const char *server, const char *port, const char *path,
832 int use_ssl, const char *proxy, const char *no_proxy,
834 OSSL_HTTP_bio_cb_t bio_update_fn, void *arg,
835 const STACK_OF(CONF_VALUE) *headers,
836 const char *content_type, BIO *req_mem,
837 int maxline, unsigned long max_resp_len, int timeout,
838 const char *expected_ct, int expect_asn1,
839 char **redirection_url)
841 time_t start_time = timeout > 0 ? time(NULL) : 0;
842 BIO *cbio; /* = bio if present, used as connection BIO if rbio is NULL */
843 OSSL_HTTP_REQ_CTX *rctx;
846 if (redirection_url != NULL)
847 *redirection_url = NULL; /* do this beforehand to prevent dbl free */
849 if (use_ssl && bio_update_fn == NULL) {
850 ERR_raise(ERR_LIB_HTTP, HTTP_R_TLS_NOT_ENABLED);
853 if (rbio != NULL && (bio == NULL || bio_update_fn != NULL)) {
854 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_INVALID_ARGUMENT);
861 #ifndef OPENSSL_NO_SOCK
862 if (server == NULL) {
863 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
868 if (port == NULL && strchr(server, ':') == NULL)
869 port = use_ssl ? OSSL_HTTPS_PORT : OSSL_HTTP_PORT;
870 proxy = http_adapt_proxy(proxy, no_proxy, server, use_ssl);
871 if ((cbio = HTTP_new_bio(server, port, proxy)) == NULL)
874 ERR_raise(ERR_LIB_HTTP, HTTP_R_SOCK_NOT_SUPPORTED);
878 /* remaining parameters are checked indirectly by the functions called */
880 (void)ERR_set_mark(); /* prepare removing any spurious libssl errors */
881 if (rbio == NULL && BIO_do_connect_retry(cbio, timeout, -1) <= 0)
883 /* now timeout is guaranteed to be >= 0 */
885 /* callback can be used to wrap or prepend TLS session */
886 if (bio_update_fn != NULL) {
887 BIO *orig_bio = cbio;
888 cbio = (*bio_update_fn)(cbio, arg, 1 /* connect */, use_ssl);
895 rctx = HTTP_REQ_CTX_new(cbio, rbio != NULL ? rbio : cbio,
896 !use_ssl && proxy != NULL, server, port, path,
897 headers, content_type, req_mem, maxline,
898 max_resp_len, update_timeout(timeout, start_time),
899 expected_ct, expect_asn1);
903 resp = OSSL_HTTP_REQ_CTX_transfer(rctx);
905 if (rctx->redirection_url != NULL) {
906 if (redirection_url == NULL)
907 ERR_raise(ERR_LIB_HTTP, HTTP_R_REDIRECTION_NOT_ENABLED);
909 /* may be NULL if out of memory: */
910 *redirection_url = OPENSSL_strdup(rctx->redirection_url);
913 unsigned long err = ERR_peek_error();
914 int lib = ERR_GET_LIB(err);
915 int reason = ERR_GET_REASON(err);
917 if (lib == ERR_LIB_SSL || lib == ERR_LIB_HTTP
918 || (lib == ERR_LIB_BIO && reason == BIO_R_CONNECT_TIMEOUT)
919 || (lib == ERR_LIB_BIO && reason == BIO_R_CONNECT_ERROR)
920 #ifndef OPENSSL_NO_CMP
921 || (lib == ERR_LIB_CMP
922 && reason == CMP_R_POTENTIALLY_INVALID_CERTIFICATE)
925 BIO_snprintf(buf, 200, "server=%s:%s", server, port);
926 ERR_add_error_data(1, buf);
928 ERR_add_error_data(2, " proxy=", proxy);
930 BIO_snprintf(buf, 200, " peer has disconnected%s",
931 use_ssl ? " violating the protocol" :
932 ", likely because it requires the use of TLS");
933 ERR_add_error_data(1, buf);
938 OSSL_HTTP_REQ_CTX_free(rctx);
940 /* callback can be used to clean up TLS session */
941 if (bio_update_fn != NULL
942 && (*bio_update_fn)(cbio, arg, 0, resp != NULL) == NULL) {
949 * Use BIO_free_all() because bio_update_fn may prepend or append to cbio.
950 * This also frees any (e.g., SSL/TLS) BIOs linked with bio and,
951 * like BIO_reset(bio), calls SSL_shutdown() to notify/alert the peer.
953 if (bio == NULL) /* cbio was not provided by caller */
957 /* remove any spurious error queue entries by ssl_add_cert_chain() */
958 (void)ERR_pop_to_mark();
960 (void)ERR_clear_last_mark();
965 static int redirection_ok(int n_redir, const char *old_url, const char *new_url)
967 size_t https_len = strlen(OSSL_HTTPS_NAME":");
969 if (n_redir >= HTTP_VERSION_MAX_REDIRECTIONS) {
970 ERR_raise(ERR_LIB_HTTP, HTTP_R_TOO_MANY_REDIRECTIONS);
973 if (*new_url == '/') /* redirection to same server => same protocol */
975 if (strncmp(old_url, OSSL_HTTPS_NAME":", https_len) == 0 &&
976 strncmp(new_url, OSSL_HTTPS_NAME":", https_len) != 0) {
977 ERR_raise(ERR_LIB_HTTP, HTTP_R_REDIRECTION_FROM_HTTPS_TO_HTTP);
983 /* Get data via HTTP from server at given URL, potentially with redirection */
984 BIO *OSSL_HTTP_get(const char *url, const char *proxy, const char *no_proxy,
986 OSSL_HTTP_bio_cb_t bio_update_fn, void *arg,
987 const STACK_OF(CONF_VALUE) *headers,
988 int maxline, unsigned long max_resp_len, int timeout,
989 const char *expected_content_type, int expect_asn1)
991 time_t start_time = timeout > 0 ? time(NULL) : 0;
992 char *current_url, *redirection_url;
1001 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
1004 if ((current_url = OPENSSL_strdup(url)) == NULL)
1008 if (!OSSL_HTTP_parse_url(current_url, &host, &port, NULL /* port_num */,
1013 resp = OSSL_HTTP_transfer(host, port, path, use_ssl, proxy, no_proxy,
1015 bio_update_fn, arg, headers, NULL, NULL,
1016 maxline, max_resp_len,
1017 update_timeout(timeout, start_time),
1018 expected_content_type, expect_asn1,
1021 if (resp == NULL && redirection_url != NULL) {
1022 if (redirection_ok(++n_redirs, current_url, redirection_url)) {
1023 (void)BIO_reset(bio);
1024 OPENSSL_free(current_url);
1025 current_url = redirection_url;
1026 if (*redirection_url == '/') { /* redirection to same server */
1027 path = OPENSSL_strdup(redirection_url);
1034 OPENSSL_free(redirection_url);
1040 OPENSSL_free(current_url);
1044 /* Get ASN.1-encoded data via HTTP from server at given URL */
1045 ASN1_VALUE *OSSL_HTTP_get_asn1(const char *url,
1046 const char *proxy, const char *no_proxy,
1047 BIO *bio, BIO *rbio,
1048 OSSL_HTTP_bio_cb_t bio_update_fn, void *arg,
1049 const STACK_OF(CONF_VALUE) *headers,
1050 int maxline, unsigned long max_resp_len,
1051 int timeout, const char *expected_content_type,
1052 const ASN1_ITEM *it)
1055 ASN1_VALUE *resp = NULL;
1057 if (url == NULL || it == NULL) {
1058 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
1061 if ((mem = OSSL_HTTP_get(url, proxy, no_proxy, bio, rbio, bio_update_fn,
1062 arg, headers, maxline, max_resp_len, timeout,
1063 expected_content_type, 1 /* expect_asn1 */))
1065 resp = BIO_mem_d2i(mem, it);
1070 /* Post ASN.1-encoded request via HTTP to server return ASN.1 response */
1071 ASN1_VALUE *OSSL_HTTP_post_asn1(const char *server, const char *port,
1072 const char *path, int use_ssl,
1073 const char *proxy, const char *no_proxy,
1074 BIO *bio, BIO *rbio,
1075 OSSL_HTTP_bio_cb_t bio_update_fn, void *arg,
1076 const STACK_OF(CONF_VALUE) *headers,
1077 const char *content_type,
1078 const ASN1_VALUE *req, const ASN1_ITEM *req_it,
1079 int maxline, unsigned long max_resp_len,
1080 int timeout, const char *expected_ct,
1081 const ASN1_ITEM *rsp_it)
1085 ASN1_VALUE *resp = NULL;
1088 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
1091 /* remaining parameters are checked indirectly */
1093 req_mem = HTTP_asn1_item2bio(req_it, req);
1094 res_mem = OSSL_HTTP_transfer(server, port, path, use_ssl, proxy, no_proxy,
1096 bio_update_fn, arg, headers, content_type,
1097 req_mem /* may be NULL */, maxline,
1098 max_resp_len, timeout,
1099 expected_ct, 1 /* expect_asn1 */, NULL);
1101 if (res_mem != NULL)
1102 resp = BIO_mem_d2i(res_mem, rsp_it);
1107 /* BASE64 encoder used for encoding basic proxy authentication credentials */
1108 static char *base64encode(const void *buf, size_t len)
1114 /* Calculate size of encoded data */
1119 out = OPENSSL_malloc(outl + 1);
1123 i = EVP_EncodeBlock((unsigned char *)out, buf, len);
1124 if (!ossl_assert(0 <= i && (size_t)i <= outl)) {
1132 * Promote the given connection BIO using the CONNECT method for a TLS proxy.
1133 * This is typically called by an app, so bio_err and prog are used unless NULL
1134 * to print additional diagnostic information in a user-oriented way.
1136 int OSSL_HTTP_proxy_connect(BIO *bio, const char *server, const char *port,
1137 const char *proxyuser, const char *proxypass,
1138 int timeout, BIO *bio_err, const char *prog)
1141 #define BUF_SIZE (8 * 1024)
1142 char *mbuf = OPENSSL_malloc(BUF_SIZE);
1146 BIO *fbio = BIO_new(BIO_f_buffer());
1148 time_t max_time = timeout > 0 ? time(NULL) + timeout : 0;
1150 if (bio == NULL || server == NULL
1151 || (bio_err != NULL && prog == NULL)) {
1152 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
1155 if (port == NULL || *port == '\0')
1156 port = OSSL_HTTPS_PORT;
1158 if (mbuf == NULL || fbio == NULL) {
1159 BIO_printf(bio_err /* may be NULL */, "%s: out of memory", prog);
1162 BIO_push(fbio, bio);
1164 BIO_printf(fbio, "CONNECT %s:%s "HTTP_PREFIX"1.0\r\n", server, port);
1167 * Workaround for broken proxies which would otherwise close
1168 * the connection when entering tunnel mode (e.g., Squid 2.6)
1170 BIO_printf(fbio, "Proxy-Connection: Keep-Alive\r\n");
1172 /* Support for basic (base64) proxy authentication */
1173 if (proxyuser != NULL) {
1174 size_t len = strlen(proxyuser) + 1;
1175 char *proxyauth, *proxyauthenc = NULL;
1177 if (proxypass != NULL)
1178 len += strlen(proxypass);
1179 proxyauth = OPENSSL_malloc(len + 1);
1180 if (proxyauth == NULL)
1182 if (BIO_snprintf(proxyauth, len + 1, "%s:%s", proxyuser,
1183 proxypass != NULL ? proxypass : "") != (int)len)
1185 proxyauthenc = base64encode(proxyauth, len);
1186 if (proxyauthenc != NULL) {
1187 BIO_printf(fbio, "Proxy-Authorization: Basic %s\r\n", proxyauthenc);
1188 OPENSSL_clear_free(proxyauthenc, strlen(proxyauthenc));
1191 OPENSSL_clear_free(proxyauth, len);
1192 if (proxyauthenc == NULL)
1196 /* Terminate the HTTP CONNECT request */
1197 BIO_printf(fbio, "\r\n");
1200 if (BIO_flush(fbio) != 0)
1202 /* potentially needs to be retried if BIO is non-blocking */
1203 if (!BIO_should_retry(fbio))
1208 /* will not actually wait if timeout == 0 */
1209 rv = BIO_wait(fbio, max_time, 100 /* milliseconds */);
1211 BIO_printf(bio_err, "%s: HTTP CONNECT %s\n", prog,
1212 rv == 0 ? "timed out" : "failed waiting for data");
1217 * The first line is the HTTP response.
1218 * According to RFC 7230, it is formatted exactly like this:
1219 * HTTP/d.d ddd Reason text\r\n
1221 read_len = BIO_gets(fbio, mbuf, BUF_SIZE);
1222 /* the BIO may not block, so we must wait for the 1st line to come in */
1223 if (read_len < HTTP_LINE1_MINLEN)
1226 /* RFC 7231 4.3.6: any 2xx status code is valid */
1227 if (strncmp(mbuf, HTTP_PREFIX, strlen(HTTP_PREFIX)) != 0) {
1228 ERR_raise(ERR_LIB_HTTP, HTTP_R_RESPONSE_PARSE_ERROR);
1229 BIO_printf(bio_err, "%s: HTTP CONNECT failed, non-HTTP response\n",
1231 /* Wrong protocol, not even HTTP, so stop reading headers */
1234 mbufp = mbuf + strlen(HTTP_PREFIX);
1235 if (strncmp(mbufp, HTTP_VERSION_PATT, strlen(HTTP_VERSION_PATT)) != 0) {
1236 ERR_raise(ERR_LIB_HTTP, HTTP_R_RECEIVED_WRONG_HTTP_VERSION);
1238 "%s: HTTP CONNECT failed, bad HTTP version %.*s\n",
1239 prog, HTTP_VERSION_STR_LEN, mbufp);
1242 mbufp += HTTP_VERSION_STR_LEN;
1243 if (strncmp(mbufp, " 2", strlen(" 2")) != 0) {
1245 /* chop any trailing whitespace */
1246 while (read_len > 0 && ossl_isspace(mbuf[read_len - 1]))
1248 mbuf[read_len] = '\0';
1249 ERR_raise_data(ERR_LIB_HTTP, HTTP_R_CONNECT_FAILURE,
1250 "Reason=%s", mbufp);
1251 BIO_printf(bio_err, "%s: HTTP CONNECT failed, Reason=%s\n",
1259 /* Read past all following headers */
1262 * TODO: This does not necessarily catch the case when the full
1263 * HTTP response came in in more than a single TCP message.
1265 read_len = BIO_gets(fbio, mbuf, BUF_SIZE);
1266 } while (read_len > 2);
1270 (void)BIO_flush(fbio);