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_PREFIX_VERSION HTTP_PREFIX""HTTP_VERSION_PATT
31 #define HTTP_1_0 HTTP_PREFIX_VERSION"0" /* "HTTP/1.0" */
32 #define HTTP_VERSION_PATT_LEN strlen(HTTP_PREFIX_VERSION)
33 #define HTTP_VERSION_STR_LEN (HTTP_VERSION_PATT_LEN + 1)
34 #define HTTP_LINE1_MINLEN ((int)strlen(HTTP_PREFIX_VERSION "x 200\n"))
35 #define HTTP_VERSION_MAX_REDIRECTIONS 50
37 #define HTTP_STATUS_CODE_OK 200
38 #define HTTP_STATUS_CODE_MOVED_PERMANENTLY 301
39 #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 *buf
; /* Buffer to write request or read response */
48 int buf_size
; /* Buffer size */
49 int free_wbio
; /* wbio allocated internally, free with ctx */
50 BIO
*wbio
; /* BIO to write/send request to */
51 BIO
*rbio
; /* BIO to read/receive response from */
52 OSSL_HTTP_bio_cb_t upd_fn
; /* Optional BIO update callback used for TLS */
53 void *upd_arg
; /* Optional arg for update callback function */
54 int use_ssl
; /* Use HTTPS */
55 char *proxy
; /* Optional proxy name or URI */
56 char *server
; /* Optional server host name */
57 char *port
; /* Optional server port */
58 BIO
*mem
; /* Memory BIO holding request/response header */
59 BIO
*req
; /* BIO holding the request provided by caller */
60 int method_POST
; /* HTTP method is POST (else GET) */
61 char *expected_ct
; /* Optional expected Content-Type */
62 int expect_asn1
; /* Response must be ASN.1-encoded */
63 unsigned char *pos
; /* Current position sending data */
64 long len_to_send
; /* Number of bytes still to send */
65 size_t resp_len
; /* Length of response */
66 size_t max_resp_len
; /* Maximum length of response, or 0 */
67 int keep_alive
; /* Persistent conn. 0=no, 1=prefer, 2=require */
68 time_t max_time
; /* Maximum end time of current transfer, or 0 */
69 time_t max_total_time
; /* Maximum end time of total transfer, or 0 */
70 char *redirection_url
; /* Location obtained from HTTP status 301/302 */
75 #define OHS_NOREAD 0x1000 /* If set no reading should be performed */
76 #define OHS_ERROR (0 | OHS_NOREAD) /* Error condition */
77 #define OHS_ADD_HEADERS (1 | OHS_NOREAD) /* Adding header lines to request */
78 #define OHS_WRITE_INIT (2 | OHS_NOREAD) /* 1st call: ready to start send */
79 #define OHS_WRITE_HDR (3 | OHS_NOREAD) /* Request header being sent */
80 #define OHS_WRITE_REQ (4 | OHS_NOREAD) /* Request contents being sent */
81 #define OHS_FLUSH (5 | OHS_NOREAD) /* Request being flushed */
82 #define OHS_FIRSTLINE 1 /* First line of response being read */
83 #define OHS_HEADERS 2 /* MIME headers of response being read */
84 #define OHS_REDIRECT 3 /* MIME headers being read, expecting Location */
85 #define OHS_ASN1_HEADER 4 /* ASN1 sequence header (tag+length) being read */
86 #define OHS_ASN1_CONTENT 5 /* ASN1 content octets being read */
87 #define OHS_ASN1_DONE (6 | OHS_NOREAD) /* ASN1 content read completed */
88 #define OHS_STREAM (7 | OHS_NOREAD) /* HTTP content stream to be read */
90 /* Low-level HTTP API implementation */
92 OSSL_HTTP_REQ_CTX
*OSSL_HTTP_REQ_CTX_new(BIO
*wbio
, BIO
*rbio
, int buf_size
)
94 OSSL_HTTP_REQ_CTX
*rctx
;
96 if (wbio
== NULL
|| rbio
== NULL
) {
97 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
101 if ((rctx
= OPENSSL_zalloc(sizeof(*rctx
))) == NULL
)
103 rctx
->state
= OHS_ERROR
;
104 rctx
->buf_size
= buf_size
> 0 ? buf_size
: OSSL_HTTP_DEFAULT_MAX_LINE_LEN
;
105 rctx
->buf
= OPENSSL_malloc(rctx
->buf_size
);
108 if (rctx
->buf
== NULL
) {
112 rctx
->max_resp_len
= OSSL_HTTP_DEFAULT_MAX_RESP_LEN
;
113 /* everything else is 0, e.g. rctx->len_to_send, or NULL, e.g. rctx->mem */
117 void OSSL_HTTP_REQ_CTX_free(OSSL_HTTP_REQ_CTX
*rctx
)
122 * Use BIO_free_all() because bio_update_fn may prepend or append to cbio.
123 * This also frees any (e.g., SSL/TLS) BIOs linked with bio and,
124 * like BIO_reset(bio), calls SSL_shutdown() to notify/alert the peer.
127 BIO_free_all(rctx
->wbio
);
128 /* do not free rctx->rbio */
129 BIO_free(rctx
->mem
); /* this may indirectly call ERR_clear_error() */
130 OPENSSL_free(rctx
->buf
);
131 OPENSSL_free(rctx
->proxy
);
132 OPENSSL_free(rctx
->server
);
133 OPENSSL_free(rctx
->port
);
134 OPENSSL_free(rctx
->expected_ct
);
138 BIO
*OSSL_HTTP_REQ_CTX_get0_mem_bio(const OSSL_HTTP_REQ_CTX
*rctx
)
141 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
147 size_t OSSL_HTTP_REQ_CTX_get_resp_len(const OSSL_HTTP_REQ_CTX
*rctx
)
150 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
153 return rctx
->resp_len
;
156 void OSSL_HTTP_REQ_CTX_set_max_response_length(OSSL_HTTP_REQ_CTX
*rctx
,
160 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
163 rctx
->max_resp_len
= len
!= 0 ? (size_t)len
: OSSL_HTTP_DEFAULT_MAX_RESP_LEN
;
167 * Create request line using |rctx| and |path| (or "/" in case |path| is NULL).
168 * Server name (and port) must be given if and only if plain HTTP proxy is used.
170 int OSSL_HTTP_REQ_CTX_set_request_line(OSSL_HTTP_REQ_CTX
*rctx
, int method_POST
,
171 const char *server
, const char *port
,
175 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
179 if ((rctx
->mem
= BIO_new(BIO_s_mem())) == NULL
)
182 rctx
->method_POST
= method_POST
!= 0;
183 if (BIO_printf(rctx
->mem
, "%s ", rctx
->method_POST
? "POST" : "GET") <= 0)
186 if (server
!= NULL
) { /* HTTP (but not HTTPS) proxy is used */
188 * Section 5.1.2 of RFC 1945 states that the absoluteURI form is only
189 * allowed when using a proxy
191 if (BIO_printf(rctx
->mem
, OSSL_HTTP_PREFIX
"%s", server
) <= 0)
193 if (port
!= NULL
&& BIO_printf(rctx
->mem
, ":%s", port
) <= 0)
197 /* Make sure path includes a forward slash */
200 if (path
[0] != '/' && BIO_printf(rctx
->mem
, "/") <= 0)
203 if (BIO_printf(rctx
->mem
, "%s "HTTP_1_0
"\r\n", path
) <= 0)
206 rctx
->state
= OHS_ADD_HEADERS
;
210 int OSSL_HTTP_REQ_CTX_add1_header(OSSL_HTTP_REQ_CTX
*rctx
,
211 const char *name
, const char *value
)
213 if (rctx
== NULL
|| name
== NULL
) {
214 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
217 if (rctx
->mem
== NULL
) {
218 ERR_raise(ERR_LIB_HTTP
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
222 if (BIO_puts(rctx
->mem
, name
) <= 0)
225 if (BIO_write(rctx
->mem
, ": ", 2) != 2)
227 if (BIO_puts(rctx
->mem
, value
) <= 0)
230 return BIO_write(rctx
->mem
, "\r\n", 2) == 2;
233 int OSSL_HTTP_REQ_CTX_set_expected(OSSL_HTTP_REQ_CTX
*rctx
,
234 const char *content_type
, int asn1
,
235 int timeout
, int keep_alive
)
238 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
242 && rctx
->state
!= OHS_ERROR
&& rctx
->state
!= OHS_ADD_HEADERS
) {
243 /* Cannot anymore set keep-alive in request header */
244 ERR_raise(ERR_LIB_HTTP
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
248 OPENSSL_free(rctx
->expected_ct
);
249 rctx
->expected_ct
= NULL
;
250 if (content_type
!= NULL
251 && (rctx
->expected_ct
= OPENSSL_strdup(content_type
)) == NULL
)
254 rctx
->expect_asn1
= asn1
;
256 rctx
->max_time
= timeout
> 0 ? time(NULL
) + timeout
: 0;
258 rctx
->max_time
= rctx
->max_total_time
;
259 rctx
->keep_alive
= keep_alive
;
263 static int set_content(OSSL_HTTP_REQ_CTX
*rctx
,
264 const char *content_type
, BIO
*req
)
268 if (rctx
== NULL
|| (req
== NULL
&& content_type
!= NULL
)) {
269 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
273 if (rctx
->keep_alive
!= 0
274 && !OSSL_HTTP_REQ_CTX_add1_header(rctx
, "Connection", "keep-alive"))
279 if (!rctx
->method_POST
) {
280 ERR_raise(ERR_LIB_HTTP
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
284 if (content_type
!= NULL
285 && BIO_printf(rctx
->mem
, "Content-Type: %s\r\n", content_type
) <= 0)
289 if ((req_len
= BIO_ctrl(req
, BIO_CTRL_INFO
, 0, NULL
)) <= 0)
290 return 1; /* streaming BIO may not support querying size */
291 return BIO_printf(rctx
->mem
, "Content-Length: %ld\r\n", req_len
) > 0;
294 int OSSL_HTTP_REQ_CTX_set1_req(OSSL_HTTP_REQ_CTX
*rctx
, const char *content_type
,
295 const ASN1_ITEM
*it
, const ASN1_VALUE
*req
)
300 if (rctx
== NULL
|| it
== NULL
|| req
== NULL
) {
301 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
305 res
= (mem
= ASN1_item_i2d_mem_bio(it
, req
)) != NULL
306 && set_content(rctx
, content_type
, mem
);
311 static int add1_headers(OSSL_HTTP_REQ_CTX
*rctx
,
312 const STACK_OF(CONF_VALUE
) *headers
, const char *host
)
315 int add_host
= host
!= NULL
&& *host
!= '\0';
318 for (i
= 0; i
< sk_CONF_VALUE_num(headers
); i
++) {
319 hdr
= sk_CONF_VALUE_value(headers
, i
);
320 if (add_host
&& strcasecmp("host", hdr
->name
) == 0)
322 if (!OSSL_HTTP_REQ_CTX_add1_header(rctx
, hdr
->name
, hdr
->value
))
326 if (add_host
&& !OSSL_HTTP_REQ_CTX_add1_header(rctx
, "Host", host
))
331 /* Create OSSL_HTTP_REQ_CTX structure using the values provided. */
332 static OSSL_HTTP_REQ_CTX
*http_req_ctx_new(int free_wbio
, BIO
*wbio
, BIO
*rbio
,
333 OSSL_HTTP_bio_cb_t bio_update_fn
,
334 void *arg
, int use_ssl
,
336 const char *server
, const char *port
,
337 int buf_size
, int overall_timeout
)
339 OSSL_HTTP_REQ_CTX
*rctx
= OSSL_HTTP_REQ_CTX_new(wbio
, rbio
, buf_size
);
343 rctx
->free_wbio
= free_wbio
;
344 rctx
->upd_fn
= bio_update_fn
;
346 rctx
->use_ssl
= use_ssl
;
348 && (rctx
->proxy
= OPENSSL_strdup(proxy
)) == NULL
)
351 && (rctx
->server
= OPENSSL_strdup(server
)) == NULL
)
354 && (rctx
->port
= OPENSSL_strdup(port
)) == NULL
)
356 rctx
->max_total_time
=
357 overall_timeout
> 0 ? time(NULL
) + overall_timeout
: 0;
361 OSSL_HTTP_REQ_CTX_free(rctx
);
366 * Parse first HTTP response line. This should be like this: "HTTP/1.0 200 OK".
367 * We need to obtain the numeric code and (optional) informational message.
370 static int parse_http_line1(char *line
, int *found_keep_alive
)
373 char *code
, *reason
, *end
;
375 if (strncmp(line
, HTTP_PREFIX_VERSION
, HTTP_VERSION_PATT_LEN
) != 0)
377 /* above HTTP 1.0, connection persistence is the default */
378 *found_keep_alive
= line
[HTTP_VERSION_PATT_LEN
] > '0';
380 /* Skip to first whitespace (past protocol info) */
381 for (code
= line
; *code
!= '\0' && !ossl_isspace(*code
); code
++)
386 /* Skip past whitespace to start of response code */
387 while (*code
!= '\0' && ossl_isspace(*code
))
392 /* Find end of response code: first whitespace after start of code */
393 for (reason
= code
; *reason
!= '\0' && !ossl_isspace(*reason
); reason
++)
399 /* Set end of response code and start of message */
402 /* Attempt to parse numeric code */
403 retcode
= strtoul(code
, &end
, 10);
407 /* Skip over any leading whitespace in message */
408 while (*reason
!= '\0' && ossl_isspace(*reason
))
411 if (*reason
!= '\0') {
413 * Finally zap any trailing whitespace in message (include CRLF)
416 /* chop any trailing whitespace from reason */
417 /* We know reason has a non-whitespace character so this is OK */
418 for (end
= reason
+ strlen(reason
) - 1; ossl_isspace(*end
); end
--)
423 case HTTP_STATUS_CODE_OK
:
424 case HTTP_STATUS_CODE_MOVED_PERMANENTLY
:
425 case HTTP_STATUS_CODE_FOUND
:
429 retcode
= HTTP_R_STATUS_CODE_UNSUPPORTED
;
431 retcode
= HTTP_R_RECEIVED_ERROR
;
433 ERR_raise_data(ERR_LIB_HTTP
, retcode
, "Code=%s", code
);
435 ERR_raise_data(ERR_LIB_HTTP
, retcode
,
436 "Code=%s, Reason=%s", code
, reason
);
442 while (i
< 60 && ossl_isprint(line
[i
]))
445 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_HEADER_PARSE_ERROR
, "content=%s", line
);
449 static int check_set_resp_len(OSSL_HTTP_REQ_CTX
*rctx
, size_t len
)
451 if (rctx
->max_resp_len
!= 0 && len
> rctx
->max_resp_len
)
452 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_MAX_RESP_LEN_EXCEEDED
,
453 "length=%zu, max=%zu", len
, rctx
->max_resp_len
);
454 if (rctx
->resp_len
!= 0 && rctx
->resp_len
!= len
)
455 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_INCONSISTENT_CONTENT_LENGTH
,
456 "ASN.1 length=%zu, Content-Length=%zu",
457 len
, rctx
->resp_len
);
458 rctx
->resp_len
= len
;
463 * Try exchanging request and response via HTTP on (non-)blocking BIO in rctx.
464 * Returns 1 on success, 0 on error or redirection, -1 on BIO_should_retry.
466 int OSSL_HTTP_REQ_CTX_nbio(OSSL_HTTP_REQ_CTX
*rctx
)
468 int i
, found_expected_ct
= 0, found_keep_alive
= 0;
471 const unsigned char *p
;
472 char *key
, *value
, *line_end
= NULL
;
475 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
478 if (rctx
->mem
== NULL
|| rctx
->wbio
== NULL
|| rctx
->rbio
== NULL
) {
479 ERR_raise(ERR_LIB_HTTP
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
483 rctx
->redirection_url
= NULL
;
485 if ((rctx
->state
& OHS_NOREAD
) == 0) {
486 if (rctx
->expect_asn1
)
487 n
= BIO_read(rctx
->rbio
, rctx
->buf
, rctx
->buf_size
);
489 n
= BIO_gets(rctx
->rbio
, (char *)rctx
->buf
, rctx
->buf_size
);
491 if (BIO_should_retry(rctx
->rbio
))
493 ERR_raise(ERR_LIB_HTTP
, HTTP_R_FAILED_READING_DATA
);
497 /* Write data to memory BIO */
498 if (BIO_write(rctx
->mem
, rctx
->buf
, n
) != n
)
502 switch (rctx
->state
) {
503 case OHS_ADD_HEADERS
:
504 /* Last operation was adding headers: need a final \r\n */
505 if (BIO_write(rctx
->mem
, "\r\n", 2) != 2) {
506 rctx
->state
= OHS_ERROR
;
509 rctx
->state
= OHS_WRITE_INIT
;
513 rctx
->len_to_send
= BIO_get_mem_data(rctx
->mem
, &rctx
->pos
);
514 rctx
->state
= OHS_WRITE_HDR
;
518 /* Copy some chunk of data from rctx->mem to rctx->wbio */
520 /* Copy some chunk of data from rctx->req to rctx->wbio */
522 if (rctx
->len_to_send
> 0) {
523 i
= BIO_write(rctx
->wbio
, rctx
->pos
, rctx
->len_to_send
);
525 if (BIO_should_retry(rctx
->wbio
))
527 rctx
->state
= OHS_ERROR
;
531 rctx
->len_to_send
-= i
;
534 if (rctx
->state
== OHS_WRITE_HDR
) {
535 (void)BIO_reset(rctx
->mem
);
536 rctx
->state
= OHS_WRITE_REQ
;
538 if (rctx
->req
!= NULL
&& !BIO_eof(rctx
->req
)) {
539 n
= BIO_read(rctx
->req
, rctx
->buf
, rctx
->buf_size
);
541 if (BIO_should_retry(rctx
->rbio
))
543 ERR_raise(ERR_LIB_HTTP
, HTTP_R_FAILED_READING_DATA
);
546 rctx
->pos
= rctx
->buf
;
547 rctx
->len_to_send
= n
;
550 rctx
->state
= OHS_FLUSH
;
555 i
= BIO_flush(rctx
->wbio
);
558 rctx
->state
= OHS_FIRSTLINE
;
562 if (BIO_should_retry(rctx
->wbio
))
565 rctx
->state
= OHS_ERROR
;
575 /* Attempt to read a line in */
578 * Due to strange memory BIO behavior with BIO_gets we have to check
579 * there's a complete line in there before calling BIO_gets or we'll
580 * just get a partial read.
582 n
= BIO_get_mem_data(rctx
->mem
, &p
);
583 if (n
<= 0 || memchr(p
, '\n', n
) == 0) {
584 if (n
>= rctx
->buf_size
) {
585 rctx
->state
= OHS_ERROR
;
590 n
= BIO_gets(rctx
->mem
, (char *)rctx
->buf
, rctx
->buf_size
);
593 if (BIO_should_retry(rctx
->mem
))
595 rctx
->state
= OHS_ERROR
;
599 /* Don't allow excessive lines */
600 if (n
== rctx
->buf_size
) {
601 ERR_raise(ERR_LIB_HTTP
, HTTP_R_RESPONSE_LINE_TOO_LONG
);
602 rctx
->state
= OHS_ERROR
;
607 if (rctx
->state
== OHS_FIRSTLINE
) {
608 switch (parse_http_line1((char *)rctx
->buf
, &found_keep_alive
)) {
609 case HTTP_STATUS_CODE_OK
:
610 rctx
->state
= OHS_HEADERS
;
612 case HTTP_STATUS_CODE_MOVED_PERMANENTLY
:
613 case HTTP_STATUS_CODE_FOUND
: /* i.e., moved temporarily */
614 if (!rctx
->method_POST
) { /* method is GET */
615 rctx
->state
= OHS_REDIRECT
;
618 ERR_raise(ERR_LIB_HTTP
, HTTP_R_REDIRECTION_NOT_ENABLED
);
619 /* redirection is not supported/recommended for POST */
622 rctx
->state
= OHS_ERROR
;
626 key
= (char *)rctx
->buf
;
627 value
= strchr(key
, ':');
630 while (ossl_isspace(*value
))
632 line_end
= strchr(value
, '\r');
633 if (line_end
== NULL
)
634 line_end
= strchr(value
, '\n');
635 if (line_end
!= NULL
)
638 if (value
!= NULL
&& line_end
!= NULL
) {
639 if (rctx
->state
== OHS_REDIRECT
640 && strcasecmp(key
, "Location") == 0) {
641 rctx
->redirection_url
= value
;
644 if (rctx
->expected_ct
!= NULL
645 && strcasecmp(key
, "Content-Type") == 0) {
646 if (strcasecmp(rctx
->expected_ct
, value
) != 0) {
647 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_UNEXPECTED_CONTENT_TYPE
,
648 "expected=%s, actual=%s",
649 rctx
->expected_ct
, value
);
652 found_expected_ct
= 1;
655 /* https://tools.ietf.org/html/rfc7230#section-6.3 Persistence */
656 if (strcasecmp(key
, "Connection") == 0) {
657 if (strcasecmp(value
, "keep-alive") == 0)
658 found_keep_alive
= 1;
659 else if (strcasecmp(value
, "close") == 0)
660 found_keep_alive
= 0;
661 } else if (strcasecmp(key
, "Content-Length") == 0) {
662 resp_len
= (size_t)strtoul(value
, &line_end
, 10);
663 if (line_end
== value
|| *line_end
!= '\0') {
664 ERR_raise_data(ERR_LIB_HTTP
,
665 HTTP_R_ERROR_PARSING_CONTENT_LENGTH
,
669 if (!check_set_resp_len(rctx
, resp_len
))
674 /* Look for blank line indicating end of headers */
675 for (p
= rctx
->buf
; *p
!= '\0'; p
++) {
676 if (*p
!= '\r' && *p
!= '\n')
679 if (*p
!= '\0') /* not end of headers */
682 if (rctx
->expected_ct
!= NULL
&& !found_expected_ct
) {
683 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_MISSING_CONTENT_TYPE
,
684 "expected=%s", rctx
->expected_ct
);
687 if (rctx
->keep_alive
!= 0 /* do not let server initiate keep_alive */
688 && !found_keep_alive
/* otherwise there is no change */) {
689 if (rctx
->keep_alive
== 2) {
690 rctx
->keep_alive
= 0;
691 ERR_raise(ERR_LIB_HTTP
, HTTP_R_SERVER_CANCELED_CONNECTION
);
694 rctx
->keep_alive
= 0;
697 if (rctx
->state
== OHS_REDIRECT
) {
698 /* http status code indicated redirect but there was no Location */
699 ERR_raise(ERR_LIB_HTTP
, HTTP_R_MISSING_REDIRECT_LOCATION
);
703 if (!rctx
->expect_asn1
) {
704 rctx
->state
= OHS_STREAM
;
708 rctx
->state
= OHS_ASN1_HEADER
;
711 case OHS_ASN1_HEADER
:
713 * Now reading ASN1 header: can read at least 2 bytes which is enough
714 * for ASN1 SEQUENCE header and either length field or at least the
715 * length of the length field.
717 n
= BIO_get_mem_data(rctx
->mem
, &p
);
721 /* Check it is an ASN1 SEQUENCE */
722 if (*p
++ != (V_ASN1_SEQUENCE
| V_ASN1_CONSTRUCTED
)) {
723 ERR_raise(ERR_LIB_HTTP
, HTTP_R_MISSING_ASN1_ENCODING
);
727 /* Check out length field */
728 if ((*p
& 0x80) != 0) {
730 * If MSB set on initial length octet we can now always read 6
731 * octets: make sure we have them.
736 /* Not NDEF or excessive length */
737 if (n
== 0 || (n
> 4)) {
738 ERR_raise(ERR_LIB_HTTP
, HTTP_R_ERROR_PARSING_ASN1_LENGTH
);
743 for (i
= 0; i
< n
; i
++) {
751 if (!check_set_resp_len(rctx
, resp_len
))
754 rctx
->state
= OHS_ASN1_CONTENT
;
757 case OHS_ASN1_CONTENT
:
759 n
= BIO_get_mem_data(rctx
->mem
, NULL
);
760 if (n
< 0 || (size_t)n
< rctx
->resp_len
)
763 rctx
->state
= OHS_ASN1_DONE
;
768 int OSSL_HTTP_REQ_CTX_nbio_d2i(OSSL_HTTP_REQ_CTX
*rctx
,
769 ASN1_VALUE
**pval
, const ASN1_ITEM
*it
)
771 const unsigned char *p
;
775 if ((rv
= OSSL_HTTP_REQ_CTX_nbio(rctx
)) != 1)
777 *pval
= ASN1_item_d2i(NULL
, &p
, BIO_get_mem_data(rctx
->mem
, &p
), it
);
778 return *pval
!= NULL
;
782 #ifndef OPENSSL_NO_SOCK
784 /* set up a new connection BIO, to HTTP server or to HTTP(S) proxy if given */
785 static BIO
*http_new_bio(const char *server
/* optionally includes ":port" */,
786 const char *server_port
/* explicit server port */,
788 const char *proxy
/* optionally includes ":port" */,
789 const char *proxy_port
/* explicit proxy port */)
791 const char *host
= server
;
792 const char *port
= server_port
;
795 if (!ossl_assert(server
!= NULL
))
803 if (port
== NULL
&& strchr(host
, ':') == NULL
)
804 port
= use_ssl
? OSSL_HTTPS_PORT
: OSSL_HTTP_PORT
;
806 cbio
= BIO_new_connect(host
/* optionally includes ":port" */);
810 (void)BIO_set_conn_port(cbio
, port
);
815 #endif /* OPENSSL_NO_SOCK */
817 /* Exchange request and response via HTTP on (non-)blocking BIO */
818 BIO
*OSSL_HTTP_REQ_CTX_exchange(OSSL_HTTP_REQ_CTX
*rctx
)
823 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
828 rv
= OSSL_HTTP_REQ_CTX_nbio(rctx
);
831 /* BIO_should_retry was true */
832 /* will not actually wait if rctx->max_time == 0 */
833 if (BIO_wait(rctx
->rbio
, rctx
->max_time
, 100 /* milliseconds */) <= 0)
838 if (rctx
->redirection_url
== NULL
) { /* an error occurred */
839 if (rctx
->len_to_send
> 0)
840 ERR_raise(ERR_LIB_HTTP
, HTTP_R_ERROR_SENDING
);
842 ERR_raise(ERR_LIB_HTTP
, HTTP_R_ERROR_RECEIVING
);
846 return rctx
->state
== OHS_STREAM
? rctx
->rbio
: rctx
->mem
;
849 int OSSL_HTTP_is_alive(const OSSL_HTTP_REQ_CTX
*rctx
)
851 return rctx
!= NULL
&& rctx
->keep_alive
!= 0;
854 /* High-level HTTP API implementation */
856 /* Initiate an HTTP session using bio, else use given server, proxy, etc. */
857 OSSL_HTTP_REQ_CTX
*OSSL_HTTP_open(const char *server
, const char *port
,
858 const char *proxy
, const char *no_proxy
,
859 int use_ssl
, BIO
*bio
, BIO
*rbio
,
860 OSSL_HTTP_bio_cb_t bio_update_fn
, void *arg
,
861 int buf_size
, int overall_timeout
)
863 BIO
*cbio
; /* == bio if supplied, used as connection BIO if rbio is NULL */
864 OSSL_HTTP_REQ_CTX
*rctx
= NULL
;
866 if (use_ssl
&& bio_update_fn
== NULL
) {
867 ERR_raise(ERR_LIB_HTTP
, HTTP_R_TLS_NOT_ENABLED
);
870 if (rbio
!= NULL
&& (bio
== NULL
|| bio_update_fn
!= NULL
)) {
871 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_INVALID_ARGUMENT
);
877 if (proxy
!= NULL
|| no_proxy
!= NULL
) {
878 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_INVALID_ARGUMENT
);
882 #ifndef OPENSSL_NO_SOCK
883 char *proxy_host
= NULL
, *proxy_port
= NULL
;
885 if (server
== NULL
) {
886 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
889 if (port
!= NULL
&& *port
== '\0')
891 if (port
== NULL
&& strchr(server
, ':') == NULL
)
892 port
= use_ssl
? OSSL_HTTPS_PORT
: OSSL_HTTP_PORT
;
893 proxy
= ossl_http_adapt_proxy(proxy
, no_proxy
, server
, use_ssl
);
895 && !OSSL_HTTP_parse_url(proxy
, NULL
/* use_ssl */, NULL
/* user */,
896 &proxy_host
, &proxy_port
, NULL
/* num */,
897 NULL
/* path */, NULL
, NULL
))
899 cbio
= http_new_bio(server
, port
, use_ssl
, proxy_host
, proxy_port
);
900 OPENSSL_free(proxy_host
);
901 OPENSSL_free(proxy_port
);
905 ERR_raise(ERR_LIB_HTTP
, HTTP_R_SOCK_NOT_SUPPORTED
);
910 (void)ERR_set_mark(); /* prepare removing any spurious libssl errors */
911 if (rbio
== NULL
&& BIO_do_connect_retry(cbio
, overall_timeout
, -1) <= 0) {
912 if (bio
== NULL
) /* cbio was not provided by caller */
916 /* now overall_timeout is guaranteed to be >= 0 */
918 /* callback can be used to wrap or prepend TLS session */
919 if (bio_update_fn
!= NULL
) {
920 BIO
*orig_bio
= cbio
;
922 cbio
= (*bio_update_fn
)(cbio
, arg
, 1 /* connect */, use_ssl
);
929 rctx
= http_req_ctx_new(bio
== NULL
, cbio
, rbio
!= NULL
? rbio
: cbio
,
930 bio_update_fn
, arg
, use_ssl
, proxy
, server
, port
,
931 buf_size
, overall_timeout
);
935 /* remove any spurious error queue entries by ssl_add_cert_chain() */
936 (void)ERR_pop_to_mark();
938 (void)ERR_clear_last_mark();
943 int OSSL_HTTP_set_request(OSSL_HTTP_REQ_CTX
*rctx
, const char *path
,
944 const STACK_OF(CONF_VALUE
) *headers
,
945 const char *content_type
, BIO
*req
,
946 const char *expected_content_type
, int expect_asn1
,
947 size_t max_resp_len
, int timeout
, int keep_alive
)
952 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
955 use_http_proxy
= rctx
->proxy
!= NULL
&& !rctx
->use_ssl
;
956 if (use_http_proxy
&& (rctx
->server
== NULL
|| rctx
->port
== NULL
)) {
957 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_INVALID_ARGUMENT
);
960 rctx
->max_resp_len
= max_resp_len
; /* allows for 0: indefinite */
962 return OSSL_HTTP_REQ_CTX_set_request_line(rctx
, req
!= NULL
,
963 use_http_proxy
? rctx
->server
964 : NULL
, rctx
->port
, path
)
965 && add1_headers(rctx
, headers
, rctx
->server
)
966 && OSSL_HTTP_REQ_CTX_set_expected(rctx
, expected_content_type
,
967 expect_asn1
, timeout
, keep_alive
)
968 && set_content(rctx
, content_type
, req
);
972 * Exchange single HTTP request and response according to rctx.
973 * If rctx->method_POST then use POST, else use GET and ignore content_type.
974 * The redirection_url output (freed by caller) parameter is used only for GET.
976 BIO
*OSSL_HTTP_exchange(OSSL_HTTP_REQ_CTX
*rctx
, char **redirection_url
)
981 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
985 if (redirection_url
!= NULL
)
986 *redirection_url
= NULL
; /* do this beforehand to prevent dbl free */
988 resp
= OSSL_HTTP_REQ_CTX_exchange(rctx
);
990 if (rctx
->redirection_url
!= NULL
) {
991 if (redirection_url
== NULL
)
992 ERR_raise(ERR_LIB_HTTP
, HTTP_R_REDIRECTION_NOT_ENABLED
);
994 /* may be NULL if out of memory: */
995 *redirection_url
= OPENSSL_strdup(rctx
->redirection_url
);
998 unsigned long err
= ERR_peek_error();
999 int lib
= ERR_GET_LIB(err
);
1000 int reason
= ERR_GET_REASON(err
);
1002 if (lib
== ERR_LIB_SSL
|| lib
== ERR_LIB_HTTP
1003 || (lib
== ERR_LIB_BIO
&& reason
== BIO_R_CONNECT_TIMEOUT
)
1004 || (lib
== ERR_LIB_BIO
&& reason
== BIO_R_CONNECT_ERROR
)
1005 #ifndef OPENSSL_NO_CMP
1006 || (lib
== ERR_LIB_CMP
1007 && reason
== CMP_R_POTENTIALLY_INVALID_CERTIFICATE
)
1010 if (rctx
->server
!= NULL
) {
1011 BIO_snprintf(buf
, sizeof(buf
), "server=http%s://%s%s%s",
1012 rctx
->use_ssl
? "s" : "", rctx
->server
,
1013 rctx
->port
!= NULL
? ":" : "",
1014 rctx
->port
!= NULL
? rctx
->port
: "");
1015 ERR_add_error_data(1, buf
);
1017 if (rctx
->proxy
!= NULL
)
1018 ERR_add_error_data(2, " proxy=", rctx
->proxy
);
1020 BIO_snprintf(buf
, sizeof(buf
), " peer has disconnected%s",
1021 rctx
->use_ssl
? " violating the protocol" :
1022 ", likely because it requires the use of TLS");
1023 ERR_add_error_data(1, buf
);
1029 if (resp
!= NULL
&& !BIO_up_ref(resp
))
1034 static int redirection_ok(int n_redir
, const char *old_url
, const char *new_url
)
1036 size_t https_len
= strlen(OSSL_HTTPS_NAME
":");
1038 if (n_redir
>= HTTP_VERSION_MAX_REDIRECTIONS
) {
1039 ERR_raise(ERR_LIB_HTTP
, HTTP_R_TOO_MANY_REDIRECTIONS
);
1042 if (*new_url
== '/') /* redirection to same server => same protocol */
1044 if (strncmp(old_url
, OSSL_HTTPS_NAME
":", https_len
) == 0 &&
1045 strncmp(new_url
, OSSL_HTTPS_NAME
":", https_len
) != 0) {
1046 ERR_raise(ERR_LIB_HTTP
, HTTP_R_REDIRECTION_FROM_HTTPS_TO_HTTP
);
1052 /* Get data via HTTP from server at given URL, potentially with redirection */
1053 BIO
*OSSL_HTTP_get(const char *url
, const char *proxy
, const char *no_proxy
,
1054 BIO
*bio
, BIO
*rbio
,
1055 OSSL_HTTP_bio_cb_t bio_update_fn
, void *arg
,
1056 int buf_size
, const STACK_OF(CONF_VALUE
) *headers
,
1057 const char *expected_ct
, int expect_asn1
,
1058 size_t max_resp_len
, int timeout
)
1060 char *current_url
, *redirection_url
= NULL
;
1066 OSSL_HTTP_REQ_CTX
*rctx
;
1070 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
1073 if ((current_url
= OPENSSL_strdup(url
)) == NULL
)
1077 if (!OSSL_HTTP_parse_url(current_url
, &use_ssl
, NULL
/* user */, &host
,
1078 &port
, NULL
/* port_num */, &path
, NULL
, NULL
))
1081 rctx
= OSSL_HTTP_open(host
, port
, proxy
, no_proxy
,
1082 use_ssl
, bio
, rbio
, bio_update_fn
, arg
,
1086 if (!OSSL_HTTP_set_request(rctx
, path
, headers
,
1087 NULL
/* content_type */,
1089 expected_ct
, expect_asn1
, max_resp_len
,
1090 -1 /* use same max time (timeout) */,
1091 0 /* no keep_alive */))
1092 OSSL_HTTP_REQ_CTX_free(rctx
);
1094 resp
= OSSL_HTTP_exchange(rctx
, &redirection_url
);
1097 if (resp
== NULL
&& redirection_url
!= NULL
) {
1098 if (redirection_ok(++n_redirs
, current_url
, redirection_url
)) {
1099 (void)BIO_reset(bio
);
1100 OPENSSL_free(current_url
);
1101 current_url
= redirection_url
;
1102 if (*redirection_url
== '/') { /* redirection to same server */
1103 path
= OPENSSL_strdup(redirection_url
);
1108 (void)OSSL_HTTP_close(rctx
, 1);
1111 /* if redirection not allowed, ignore it */
1112 OPENSSL_free(redirection_url
);
1116 if (!OSSL_HTTP_close(rctx
, resp
!= NULL
)) {
1122 OPENSSL_free(current_url
);
1126 /* Exchange request and response over a connection managed via |prctx| */
1127 BIO
*OSSL_HTTP_transfer(OSSL_HTTP_REQ_CTX
**prctx
,
1128 const char *server
, const char *port
,
1129 const char *path
, int use_ssl
,
1130 const char *proxy
, const char *no_proxy
,
1131 BIO
*bio
, BIO
*rbio
,
1132 OSSL_HTTP_bio_cb_t bio_update_fn
, void *arg
,
1133 int buf_size
, const STACK_OF(CONF_VALUE
) *headers
,
1134 const char *content_type
, BIO
*req
,
1135 const char *expected_ct
, int expect_asn1
,
1136 size_t max_resp_len
, int timeout
, int keep_alive
)
1138 OSSL_HTTP_REQ_CTX
*rctx
= prctx
== NULL
? NULL
: *prctx
;
1142 rctx
= OSSL_HTTP_open(server
, port
, proxy
, no_proxy
,
1143 use_ssl
, bio
, rbio
, bio_update_fn
, arg
,
1145 timeout
= -1; /* Already set during opening the connection */
1148 if (OSSL_HTTP_set_request(rctx
, path
, headers
, content_type
, req
,
1149 expected_ct
, expect_asn1
,
1150 max_resp_len
, timeout
, keep_alive
))
1151 resp
= OSSL_HTTP_exchange(rctx
, NULL
);
1152 if (resp
== NULL
|| !OSSL_HTTP_is_alive(rctx
)) {
1153 if (!OSSL_HTTP_close(rctx
, resp
!= NULL
)) {
1165 int OSSL_HTTP_close(OSSL_HTTP_REQ_CTX
*rctx
, int ok
)
1169 /* callback can be used to clean up TLS session on disconnect */
1170 if (rctx
!= NULL
&& rctx
->upd_fn
!= NULL
)
1171 ret
= (*rctx
->upd_fn
)(rctx
->wbio
, rctx
->upd_arg
, 0, ok
) != NULL
;
1172 OSSL_HTTP_REQ_CTX_free(rctx
);
1176 /* BASE64 encoder used for encoding basic proxy authentication credentials */
1177 static char *base64encode(const void *buf
, size_t len
)
1183 /* Calculate size of encoded data */
1188 out
= OPENSSL_malloc(outl
+ 1);
1192 i
= EVP_EncodeBlock((unsigned char *)out
, buf
, len
);
1193 if (!ossl_assert(0 <= i
&& (size_t)i
<= outl
)) {
1201 * Promote the given connection BIO using the CONNECT method for a TLS proxy.
1202 * This is typically called by an app, so bio_err and prog are used unless NULL
1203 * to print additional diagnostic information in a user-oriented way.
1205 int OSSL_HTTP_proxy_connect(BIO
*bio
, const char *server
, const char *port
,
1206 const char *proxyuser
, const char *proxypass
,
1207 int timeout
, BIO
*bio_err
, const char *prog
)
1210 #define BUF_SIZE (8 * 1024)
1211 char *mbuf
= OPENSSL_malloc(BUF_SIZE
);
1215 BIO
*fbio
= BIO_new(BIO_f_buffer());
1217 time_t max_time
= timeout
> 0 ? time(NULL
) + timeout
: 0;
1219 if (bio
== NULL
|| server
== NULL
1220 || (bio_err
!= NULL
&& prog
== NULL
)) {
1221 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
1224 if (port
== NULL
|| *port
== '\0')
1225 port
= OSSL_HTTPS_PORT
;
1227 if (mbuf
== NULL
|| fbio
== NULL
) {
1228 BIO_printf(bio_err
/* may be NULL */, "%s: out of memory", prog
);
1231 BIO_push(fbio
, bio
);
1233 BIO_printf(fbio
, "CONNECT %s:%s "HTTP_1_0
"\r\n", server
, port
);
1236 * Workaround for broken proxies which would otherwise close
1237 * the connection when entering tunnel mode (e.g., Squid 2.6)
1239 BIO_printf(fbio
, "Proxy-Connection: Keep-Alive\r\n");
1241 /* Support for basic (base64) proxy authentication */
1242 if (proxyuser
!= NULL
) {
1243 size_t len
= strlen(proxyuser
) + 1;
1244 char *proxyauth
, *proxyauthenc
= NULL
;
1246 if (proxypass
!= NULL
)
1247 len
+= strlen(proxypass
);
1248 proxyauth
= OPENSSL_malloc(len
+ 1);
1249 if (proxyauth
== NULL
)
1251 if (BIO_snprintf(proxyauth
, len
+ 1, "%s:%s", proxyuser
,
1252 proxypass
!= NULL
? proxypass
: "") != (int)len
)
1254 proxyauthenc
= base64encode(proxyauth
, len
);
1255 if (proxyauthenc
!= NULL
) {
1256 BIO_printf(fbio
, "Proxy-Authorization: Basic %s\r\n", proxyauthenc
);
1257 OPENSSL_clear_free(proxyauthenc
, strlen(proxyauthenc
));
1260 OPENSSL_clear_free(proxyauth
, len
);
1261 if (proxyauthenc
== NULL
)
1265 /* Terminate the HTTP CONNECT request */
1266 BIO_printf(fbio
, "\r\n");
1269 if (BIO_flush(fbio
) != 0)
1271 /* potentially needs to be retried if BIO is non-blocking */
1272 if (!BIO_should_retry(fbio
))
1277 /* will not actually wait if timeout == 0 */
1278 rv
= BIO_wait(fbio
, max_time
, 100 /* milliseconds */);
1280 BIO_printf(bio_err
, "%s: HTTP CONNECT %s\n", prog
,
1281 rv
== 0 ? "timed out" : "failed waiting for data");
1286 * The first line is the HTTP response.
1287 * According to RFC 7230, it is formatted exactly like this:
1288 * HTTP/d.d ddd Reason text\r\n
1290 read_len
= BIO_gets(fbio
, mbuf
, BUF_SIZE
);
1291 /* the BIO may not block, so we must wait for the 1st line to come in */
1292 if (read_len
< HTTP_LINE1_MINLEN
)
1295 /* Check for HTTP/1.x */
1296 if (strncmp(mbuf
, HTTP_PREFIX
, strlen(HTTP_PREFIX
)) != 0) {
1297 ERR_raise(ERR_LIB_HTTP
, HTTP_R_HEADER_PARSE_ERROR
);
1298 BIO_printf(bio_err
, "%s: HTTP CONNECT failed, non-HTTP response\n",
1300 /* Wrong protocol, not even HTTP, so stop reading headers */
1303 mbufp
= mbuf
+ strlen(HTTP_PREFIX
);
1304 if (strncmp(mbufp
, HTTP_VERSION_PATT
, HTTP_VERSION_PATT_LEN
) != 0) {
1305 ERR_raise(ERR_LIB_HTTP
, HTTP_R_RECEIVED_WRONG_HTTP_VERSION
);
1307 "%s: HTTP CONNECT failed, bad HTTP version %.*s\n",
1308 prog
, (int)HTTP_VERSION_STR_LEN
, mbufp
);
1311 mbufp
+= HTTP_VERSION_STR_LEN
;
1313 /* RFC 7231 4.3.6: any 2xx status code is valid */
1314 if (strncmp(mbufp
, " 2", strlen(" 2")) != 0) {
1316 /* chop any trailing whitespace */
1317 while (read_len
> 0 && ossl_isspace(mbuf
[read_len
- 1]))
1319 mbuf
[read_len
] = '\0';
1320 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_CONNECT_FAILURE
,
1321 "Reason=%s", mbufp
);
1322 BIO_printf(bio_err
, "%s: HTTP CONNECT failed, Reason=%s\n",
1330 /* Read past all following headers */
1333 * This does not necessarily catch the case when the full
1334 * HTTP response came in in more than a single TCP message.
1336 read_len
= BIO_gets(fbio
, mbuf
, BUF_SIZE
);
1337 } while (read_len
> 2);
1341 (void)BIO_flush(fbio
);