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/common.h" /* for ossl_assert() */
26 #define HTTP_PREFIX "HTTP/"
27 #define HTTP_VERSION_PATT "1." /* allow 1.x */
28 #define HTTP_VERSION_STR_LEN sizeof(HTTP_VERSION_PATT) /* == strlen("1.0") */
29 #define HTTP_PREFIX_VERSION HTTP_PREFIX""HTTP_VERSION_PATT
30 #define HTTP_1_0 HTTP_PREFIX_VERSION"0" /* "HTTP/1.0" */
31 #define HTTP_LINE1_MINLEN (sizeof(HTTP_PREFIX_VERSION "x 200\n") - 1)
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
38 /* Stateful HTTP request code, supporting blocking and non-blocking I/O */
40 /* Opaque HTTP request status structure */
42 struct ossl_http_req_ctx_st
{
43 int state
; /* Current I/O state */
44 unsigned char *buf
; /* Buffer to write request or read response */
45 int buf_size
; /* Buffer size */
46 int free_wbio
; /* wbio allocated internally, free with ctx */
47 BIO
*wbio
; /* BIO to write/send request to */
48 BIO
*rbio
; /* BIO to read/receive response from */
49 OSSL_HTTP_bio_cb_t upd_fn
; /* Optional BIO update callback used for TLS */
50 void *upd_arg
; /* Optional arg for update callback function */
51 int use_ssl
; /* Use HTTPS */
52 char *proxy
; /* Optional proxy name or URI */
53 char *server
; /* Optional server host name */
54 char *port
; /* Optional server port */
55 BIO
*mem
; /* Memory BIO holding request/response header */
56 BIO
*req
; /* BIO holding the request provided by caller */
57 int method_POST
; /* HTTP method is POST (else GET) */
58 char *expected_ct
; /* Optional expected Content-Type */
59 int expect_asn1
; /* Response must be ASN.1-encoded */
60 unsigned char *pos
; /* Current position sending data */
61 long len_to_send
; /* Number of bytes still to send */
62 size_t resp_len
; /* Length of response */
63 size_t max_resp_len
; /* Maximum length of response, or 0 */
64 int keep_alive
; /* Persistent conn. 0=no, 1=prefer, 2=require */
65 time_t max_time
; /* Maximum end time of current transfer, or 0 */
66 time_t max_total_time
; /* Maximum end time of total transfer, or 0 */
67 char *redirection_url
; /* Location obtained from HTTP status 301/302 */
72 #define OHS_NOREAD 0x1000 /* If set no reading should be performed */
73 #define OHS_ERROR (0 | OHS_NOREAD) /* Error condition */
74 #define OHS_ADD_HEADERS (1 | OHS_NOREAD) /* Adding header lines to request */
75 #define OHS_WRITE_INIT (2 | OHS_NOREAD) /* 1st call: ready to start send */
76 #define OHS_WRITE_HDR (3 | OHS_NOREAD) /* Request header being sent */
77 #define OHS_WRITE_REQ (4 | OHS_NOREAD) /* Request contents being sent */
78 #define OHS_FLUSH (5 | OHS_NOREAD) /* Request being flushed */
79 #define OHS_FIRSTLINE 1 /* First line of response being read */
80 #define OHS_HEADERS 2 /* MIME headers of response being read */
81 #define OHS_REDIRECT 3 /* MIME headers being read, expecting Location */
82 #define OHS_ASN1_HEADER 4 /* ASN1 sequence header (tag+length) being read */
83 #define OHS_ASN1_CONTENT 5 /* ASN1 content octets being read */
84 #define OHS_ASN1_DONE (6 | OHS_NOREAD) /* ASN1 content read completed */
85 #define OHS_STREAM (7 | OHS_NOREAD) /* HTTP content stream to be read */
87 /* Low-level HTTP API implementation */
89 OSSL_HTTP_REQ_CTX
*OSSL_HTTP_REQ_CTX_new(BIO
*wbio
, BIO
*rbio
, int buf_size
)
91 OSSL_HTTP_REQ_CTX
*rctx
;
93 if (wbio
== NULL
|| rbio
== NULL
) {
94 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
98 if ((rctx
= OPENSSL_zalloc(sizeof(*rctx
))) == NULL
)
100 rctx
->state
= OHS_ERROR
;
101 rctx
->buf_size
= buf_size
> 0 ? buf_size
: OSSL_HTTP_DEFAULT_MAX_LINE_LEN
;
102 rctx
->buf
= OPENSSL_malloc(rctx
->buf_size
);
105 if (rctx
->buf
== NULL
) {
109 rctx
->max_resp_len
= OSSL_HTTP_DEFAULT_MAX_RESP_LEN
;
110 /* everything else is 0, e.g. rctx->len_to_send, or NULL, e.g. rctx->mem */
114 void OSSL_HTTP_REQ_CTX_free(OSSL_HTTP_REQ_CTX
*rctx
)
119 * Use BIO_free_all() because bio_update_fn may prepend or append to cbio.
120 * This also frees any (e.g., SSL/TLS) BIOs linked with bio and,
121 * like BIO_reset(bio), calls SSL_shutdown() to notify/alert the peer.
124 BIO_free_all(rctx
->wbio
);
125 /* do not free rctx->rbio */
128 OPENSSL_free(rctx
->buf
);
129 OPENSSL_free(rctx
->proxy
);
130 OPENSSL_free(rctx
->server
);
131 OPENSSL_free(rctx
->port
);
132 OPENSSL_free(rctx
->expected_ct
);
136 BIO
*OSSL_HTTP_REQ_CTX_get0_mem_bio(const OSSL_HTTP_REQ_CTX
*rctx
)
139 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
145 size_t OSSL_HTTP_REQ_CTX_get_resp_len(const OSSL_HTTP_REQ_CTX
*rctx
)
148 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
151 return rctx
->resp_len
;
154 void OSSL_HTTP_REQ_CTX_set_max_response_length(OSSL_HTTP_REQ_CTX
*rctx
,
158 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
161 rctx
->max_resp_len
= len
!= 0 ? (size_t)len
: OSSL_HTTP_DEFAULT_MAX_RESP_LEN
;
165 * Create request line using |rctx| and |path| (or "/" in case |path| is NULL).
166 * Server name (and port) must be given if and only if plain HTTP proxy is used.
168 int OSSL_HTTP_REQ_CTX_set_request_line(OSSL_HTTP_REQ_CTX
*rctx
, int method_POST
,
169 const char *server
, const char *port
,
173 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
177 if ((rctx
->mem
= BIO_new(BIO_s_mem())) == NULL
)
180 rctx
->method_POST
= method_POST
!= 0;
181 if (BIO_printf(rctx
->mem
, "%s ", rctx
->method_POST
? "POST" : "GET") <= 0)
184 if (server
!= NULL
) { /* HTTP (but not HTTPS) proxy is used */
186 * Section 5.1.2 of RFC 1945 states that the absoluteURI form is only
187 * allowed when using a proxy
189 if (BIO_printf(rctx
->mem
, OSSL_HTTP_PREFIX
"%s", server
) <= 0)
191 if (port
!= NULL
&& BIO_printf(rctx
->mem
, ":%s", port
) <= 0)
195 /* Make sure path includes a forward slash */
198 if (path
[0] != '/' && BIO_printf(rctx
->mem
, "/") <= 0)
201 * Add (the rest of) the path and the HTTP version,
202 * which is fixed to 1.0 for straightforward implementation of keep-alive
204 if (BIO_printf(rctx
->mem
, "%s "HTTP_1_0
"\r\n", path
) <= 0)
208 rctx
->state
= OHS_ADD_HEADERS
;
212 int OSSL_HTTP_REQ_CTX_add1_header(OSSL_HTTP_REQ_CTX
*rctx
,
213 const char *name
, const char *value
)
215 if (rctx
== NULL
|| name
== NULL
) {
216 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
219 if (rctx
->mem
== NULL
) {
220 ERR_raise(ERR_LIB_HTTP
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
224 if (BIO_puts(rctx
->mem
, name
) <= 0)
227 if (BIO_write(rctx
->mem
, ": ", 2) != 2)
229 if (BIO_puts(rctx
->mem
, value
) <= 0)
232 return BIO_write(rctx
->mem
, "\r\n", 2) == 2;
235 int OSSL_HTTP_REQ_CTX_set_expected(OSSL_HTTP_REQ_CTX
*rctx
,
236 const char *content_type
, int asn1
,
237 int timeout
, int keep_alive
)
240 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
244 && rctx
->state
!= OHS_ERROR
&& rctx
->state
!= OHS_ADD_HEADERS
) {
245 /* Cannot anymore set keep-alive in request header */
246 ERR_raise(ERR_LIB_HTTP
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
250 OPENSSL_free(rctx
->expected_ct
);
251 rctx
->expected_ct
= NULL
;
252 if (content_type
!= NULL
253 && (rctx
->expected_ct
= OPENSSL_strdup(content_type
)) == NULL
)
256 rctx
->expect_asn1
= asn1
;
258 rctx
->max_time
= timeout
> 0 ? time(NULL
) + timeout
: 0;
259 else /* take over any |overall_timeout| arg of OSSL_HTTP_open(), else 0 */
260 rctx
->max_time
= rctx
->max_total_time
;
261 rctx
->keep_alive
= keep_alive
;
265 static int set1_content(OSSL_HTTP_REQ_CTX
*rctx
,
266 const char *content_type
, BIO
*req
)
270 if (rctx
== NULL
|| (req
== NULL
&& content_type
!= NULL
)) {
271 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
275 if (rctx
->keep_alive
!= 0
276 && !OSSL_HTTP_REQ_CTX_add1_header(rctx
, "Connection", "keep-alive"))
283 if (!rctx
->method_POST
) {
284 ERR_raise(ERR_LIB_HTTP
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
288 if (content_type
!= NULL
289 && BIO_printf(rctx
->mem
, "Content-Type: %s\r\n", content_type
) <= 0)
292 /* streaming BIO may not support querying size */
293 if (((req_len
= BIO_ctrl(req
, BIO_CTRL_INFO
, 0, NULL
)) <= 0
294 || BIO_printf(rctx
->mem
, "Content-Length: %ld\r\n", req_len
) > 0)
295 && BIO_up_ref(req
)) {
302 int OSSL_HTTP_REQ_CTX_set1_req(OSSL_HTTP_REQ_CTX
*rctx
, const char *content_type
,
303 const ASN1_ITEM
*it
, const ASN1_VALUE
*req
)
309 res
= (mem
= ASN1_item_i2d_mem_bio(it
, req
)) != NULL
;
310 res
= res
&& set1_content(rctx
, content_type
, mem
);
315 static int add1_headers(OSSL_HTTP_REQ_CTX
*rctx
,
316 const STACK_OF(CONF_VALUE
) *headers
, const char *host
)
319 int add_host
= host
!= NULL
&& *host
!= '\0';
322 for (i
= 0; i
< sk_CONF_VALUE_num(headers
); i
++) {
323 hdr
= sk_CONF_VALUE_value(headers
, i
);
324 if (add_host
&& strcasecmp("host", hdr
->name
) == 0)
326 if (!OSSL_HTTP_REQ_CTX_add1_header(rctx
, hdr
->name
, hdr
->value
))
330 if (add_host
&& !OSSL_HTTP_REQ_CTX_add1_header(rctx
, "Host", host
))
335 /* Create OSSL_HTTP_REQ_CTX structure using the values provided. */
336 static OSSL_HTTP_REQ_CTX
*http_req_ctx_new(int free_wbio
, BIO
*wbio
, BIO
*rbio
,
337 OSSL_HTTP_bio_cb_t bio_update_fn
,
338 void *arg
, int use_ssl
,
340 const char *server
, const char *port
,
341 int buf_size
, int overall_timeout
)
343 OSSL_HTTP_REQ_CTX
*rctx
= OSSL_HTTP_REQ_CTX_new(wbio
, rbio
, buf_size
);
347 rctx
->free_wbio
= free_wbio
;
348 rctx
->upd_fn
= bio_update_fn
;
350 rctx
->use_ssl
= use_ssl
;
352 && (rctx
->proxy
= OPENSSL_strdup(proxy
)) == NULL
)
355 && (rctx
->server
= OPENSSL_strdup(server
)) == NULL
)
358 && (rctx
->port
= OPENSSL_strdup(port
)) == NULL
)
360 rctx
->max_total_time
=
361 overall_timeout
> 0 ? time(NULL
) + overall_timeout
: 0;
365 OSSL_HTTP_REQ_CTX_free(rctx
);
370 * Parse first HTTP response line. This should be like this: "HTTP/1.0 200 OK".
371 * We need to obtain the status code and (optional) informational message.
372 * Return any received HTTP response status code, or 0 on fatal error.
375 static int parse_http_line1(char *line
, int *found_keep_alive
)
378 char *code
, *reason
, *end
;
380 if (!CHECK_AND_SKIP_PREFIX(line
, HTTP_PREFIX_VERSION
))
382 /* above HTTP 1.0, connection persistence is the default */
383 *found_keep_alive
= *line
> '0';
385 /* Skip to first whitespace (past protocol info) */
386 for (code
= line
; *code
!= '\0' && !ossl_isspace(*code
); code
++)
391 /* Skip past whitespace to start of response code */
392 while (*code
!= '\0' && ossl_isspace(*code
))
397 /* Find end of response code: first whitespace after start of code */
398 for (reason
= code
; *reason
!= '\0' && !ossl_isspace(*reason
); reason
++)
404 /* Set end of response code and start of message */
407 /* Attempt to parse numeric code */
408 retcode
= strtoul(code
, &end
, 10);
412 /* Skip over any leading whitespace in message */
413 while (*reason
!= '\0' && ossl_isspace(*reason
))
416 if (*reason
!= '\0') {
418 * Finally zap any trailing whitespace in message (include CRLF)
421 /* chop any trailing whitespace from reason */
422 /* We know reason has a non-whitespace character so this is OK */
423 for (end
= reason
+ strlen(reason
) - 1; ossl_isspace(*end
); end
--)
428 case HTTP_STATUS_CODE_OK
:
429 case HTTP_STATUS_CODE_MOVED_PERMANENTLY
:
430 case HTTP_STATUS_CODE_FOUND
:
433 err
= HTTP_R_RECEIVED_ERROR
;
435 err
= HTTP_R_STATUS_CODE_UNSUPPORTED
;
437 ERR_raise_data(ERR_LIB_HTTP
, err
, "code=%s", code
);
439 ERR_raise_data(ERR_LIB_HTTP
, err
, "code=%s, reason=%s", code
,
445 for (i
= 0; i
< 60 && line
[i
] != '\0'; i
++)
446 if (!ossl_isprint(line
[i
]))
449 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_HEADER_PARSE_ERROR
, "content=%s", line
);
453 static int check_set_resp_len(OSSL_HTTP_REQ_CTX
*rctx
, size_t len
)
455 if (rctx
->max_resp_len
!= 0 && len
> rctx
->max_resp_len
)
456 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_MAX_RESP_LEN_EXCEEDED
,
457 "length=%zu, max=%zu", len
, rctx
->max_resp_len
);
458 if (rctx
->resp_len
!= 0 && rctx
->resp_len
!= len
)
459 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_INCONSISTENT_CONTENT_LENGTH
,
460 "ASN.1 length=%zu, Content-Length=%zu",
461 len
, rctx
->resp_len
);
462 rctx
->resp_len
= len
;
467 * Try exchanging request and response via HTTP on (non-)blocking BIO in rctx.
468 * Returns 1 on success, 0 on error or redirection, -1 on BIO_should_retry.
470 int OSSL_HTTP_REQ_CTX_nbio(OSSL_HTTP_REQ_CTX
*rctx
)
472 int i
, found_expected_ct
= 0, found_keep_alive
= 0;
475 const unsigned char *p
;
476 char *key
, *value
, *line_end
= NULL
;
479 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
482 if (rctx
->mem
== NULL
|| rctx
->wbio
== NULL
|| rctx
->rbio
== NULL
) {
483 ERR_raise(ERR_LIB_HTTP
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
487 rctx
->redirection_url
= NULL
;
489 if ((rctx
->state
& OHS_NOREAD
) == 0) {
490 if (rctx
->expect_asn1
)
491 n
= BIO_read(rctx
->rbio
, rctx
->buf
, rctx
->buf_size
);
493 n
= BIO_gets(rctx
->rbio
, (char *)rctx
->buf
, rctx
->buf_size
);
495 if (BIO_should_retry(rctx
->rbio
))
497 ERR_raise(ERR_LIB_HTTP
, HTTP_R_FAILED_READING_DATA
);
501 /* Write data to memory BIO */
502 if (BIO_write(rctx
->mem
, rctx
->buf
, n
) != n
)
506 switch (rctx
->state
) {
507 case OHS_ADD_HEADERS
:
508 /* Last operation was adding headers: need a final \r\n */
509 if (BIO_write(rctx
->mem
, "\r\n", 2) != 2) {
510 rctx
->state
= OHS_ERROR
;
513 rctx
->state
= OHS_WRITE_INIT
;
517 rctx
->len_to_send
= BIO_get_mem_data(rctx
->mem
, &rctx
->pos
);
518 rctx
->state
= OHS_WRITE_HDR
;
522 /* Copy some chunk of data from rctx->mem to rctx->wbio */
524 /* Copy some chunk of data from rctx->req to rctx->wbio */
526 if (rctx
->len_to_send
> 0) {
527 i
= BIO_write(rctx
->wbio
, rctx
->pos
, rctx
->len_to_send
);
529 if (BIO_should_retry(rctx
->wbio
))
531 rctx
->state
= OHS_ERROR
;
535 rctx
->len_to_send
-= i
;
538 if (rctx
->state
== OHS_WRITE_HDR
) {
539 (void)BIO_reset(rctx
->mem
);
540 rctx
->state
= OHS_WRITE_REQ
;
542 if (rctx
->req
!= NULL
&& !BIO_eof(rctx
->req
)) {
543 n
= BIO_read(rctx
->req
, rctx
->buf
, rctx
->buf_size
);
545 if (BIO_should_retry(rctx
->rbio
))
547 ERR_raise(ERR_LIB_HTTP
, HTTP_R_FAILED_READING_DATA
);
550 rctx
->pos
= rctx
->buf
;
551 rctx
->len_to_send
= n
;
554 rctx
->state
= OHS_FLUSH
;
559 i
= BIO_flush(rctx
->wbio
);
562 rctx
->state
= OHS_FIRSTLINE
;
566 if (BIO_should_retry(rctx
->wbio
))
569 rctx
->state
= OHS_ERROR
;
579 /* Attempt to read a line in */
582 * Due to strange memory BIO behavior with BIO_gets we have to check
583 * there's a complete line in there before calling BIO_gets or we'll
584 * just get a partial read.
586 n
= BIO_get_mem_data(rctx
->mem
, &p
);
587 if (n
<= 0 || memchr(p
, '\n', n
) == 0) {
588 if (n
>= rctx
->buf_size
) {
589 rctx
->state
= OHS_ERROR
;
594 n
= BIO_gets(rctx
->mem
, (char *)rctx
->buf
, rctx
->buf_size
);
597 if (BIO_should_retry(rctx
->mem
))
599 rctx
->state
= OHS_ERROR
;
603 /* Don't allow excessive lines */
604 if (n
== rctx
->buf_size
) {
605 ERR_raise(ERR_LIB_HTTP
, HTTP_R_RESPONSE_LINE_TOO_LONG
);
606 rctx
->state
= OHS_ERROR
;
611 if (rctx
->state
== OHS_FIRSTLINE
) {
612 switch (parse_http_line1((char *)rctx
->buf
, &found_keep_alive
)) {
613 case HTTP_STATUS_CODE_OK
:
614 rctx
->state
= OHS_HEADERS
;
616 case HTTP_STATUS_CODE_MOVED_PERMANENTLY
:
617 case HTTP_STATUS_CODE_FOUND
: /* i.e., moved temporarily */
618 if (!rctx
->method_POST
) { /* method is GET */
619 rctx
->state
= OHS_REDIRECT
;
622 ERR_raise(ERR_LIB_HTTP
, HTTP_R_REDIRECTION_NOT_ENABLED
);
623 /* redirection is not supported/recommended for POST */
626 rctx
->state
= OHS_ERROR
;
630 key
= (char *)rctx
->buf
;
631 value
= strchr(key
, ':');
634 while (ossl_isspace(*value
))
636 line_end
= strchr(value
, '\r');
637 if (line_end
== NULL
)
638 line_end
= strchr(value
, '\n');
639 if (line_end
!= NULL
)
642 if (value
!= NULL
&& line_end
!= NULL
) {
643 if (rctx
->state
== OHS_REDIRECT
644 && strcasecmp(key
, "Location") == 0) {
645 rctx
->redirection_url
= value
;
648 if (rctx
->expected_ct
!= NULL
649 && strcasecmp(key
, "Content-Type") == 0) {
650 if (strcasecmp(rctx
->expected_ct
, value
) != 0) {
651 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_UNEXPECTED_CONTENT_TYPE
,
652 "expected=%s, actual=%s",
653 rctx
->expected_ct
, value
);
656 found_expected_ct
= 1;
659 /* https://tools.ietf.org/html/rfc7230#section-6.3 Persistence */
660 if (strcasecmp(key
, "Connection") == 0) {
661 if (strcasecmp(value
, "keep-alive") == 0)
662 found_keep_alive
= 1;
663 else if (strcasecmp(value
, "close") == 0)
664 found_keep_alive
= 0;
665 } else if (strcasecmp(key
, "Content-Length") == 0) {
666 resp_len
= (size_t)strtoul(value
, &line_end
, 10);
667 if (line_end
== value
|| *line_end
!= '\0') {
668 ERR_raise_data(ERR_LIB_HTTP
,
669 HTTP_R_ERROR_PARSING_CONTENT_LENGTH
,
673 if (!check_set_resp_len(rctx
, resp_len
))
678 /* Look for blank line indicating end of headers */
679 for (p
= rctx
->buf
; *p
!= '\0'; p
++) {
680 if (*p
!= '\r' && *p
!= '\n')
683 if (*p
!= '\0') /* not end of headers */
686 if (rctx
->expected_ct
!= NULL
&& !found_expected_ct
) {
687 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_MISSING_CONTENT_TYPE
,
688 "expected=%s", rctx
->expected_ct
);
691 if (rctx
->keep_alive
!= 0 /* do not let server initiate keep_alive */
692 && !found_keep_alive
/* otherwise there is no change */) {
693 if (rctx
->keep_alive
== 2) {
694 rctx
->keep_alive
= 0;
695 ERR_raise(ERR_LIB_HTTP
, HTTP_R_SERVER_CANCELED_CONNECTION
);
698 rctx
->keep_alive
= 0;
701 if (rctx
->state
== OHS_REDIRECT
) {
702 /* http status code indicated redirect but there was no Location */
703 ERR_raise(ERR_LIB_HTTP
, HTTP_R_MISSING_REDIRECT_LOCATION
);
707 if (!rctx
->expect_asn1
) {
708 rctx
->state
= OHS_STREAM
;
712 rctx
->state
= OHS_ASN1_HEADER
;
715 case OHS_ASN1_HEADER
:
717 * Now reading ASN1 header: can read at least 2 bytes which is enough
718 * for ASN1 SEQUENCE header and either length field or at least the
719 * length of the length field.
721 n
= BIO_get_mem_data(rctx
->mem
, &p
);
725 /* Check it is an ASN1 SEQUENCE */
726 if (*p
++ != (V_ASN1_SEQUENCE
| V_ASN1_CONSTRUCTED
)) {
727 ERR_raise(ERR_LIB_HTTP
, HTTP_R_MISSING_ASN1_ENCODING
);
731 /* Check out length field */
732 if ((*p
& 0x80) != 0) {
734 * If MSB set on initial length octet we can now always read 6
735 * octets: make sure we have them.
740 /* Not NDEF or excessive length */
741 if (n
== 0 || (n
> 4)) {
742 ERR_raise(ERR_LIB_HTTP
, HTTP_R_ERROR_PARSING_ASN1_LENGTH
);
747 for (i
= 0; i
< n
; i
++) {
755 if (!check_set_resp_len(rctx
, resp_len
))
758 rctx
->state
= OHS_ASN1_CONTENT
;
761 case OHS_ASN1_CONTENT
:
763 n
= BIO_get_mem_data(rctx
->mem
, NULL
);
764 if (n
< 0 || (size_t)n
< rctx
->resp_len
)
767 rctx
->state
= OHS_ASN1_DONE
;
772 int OSSL_HTTP_REQ_CTX_nbio_d2i(OSSL_HTTP_REQ_CTX
*rctx
,
773 ASN1_VALUE
**pval
, const ASN1_ITEM
*it
)
775 const unsigned char *p
;
779 if ((rv
= OSSL_HTTP_REQ_CTX_nbio(rctx
)) != 1)
781 *pval
= ASN1_item_d2i(NULL
, &p
, BIO_get_mem_data(rctx
->mem
, &p
), it
);
782 return *pval
!= NULL
;
786 #ifndef OPENSSL_NO_SOCK
788 /* set up a new connection BIO, to HTTP server or to HTTP(S) proxy if given */
789 static BIO
*http_new_bio(const char *server
/* optionally includes ":port" */,
790 const char *server_port
/* explicit server port */,
792 const char *proxy
/* optionally includes ":port" */,
793 const char *proxy_port
/* explicit proxy port */)
795 const char *host
= server
;
796 const char *port
= server_port
;
799 if (!ossl_assert(server
!= NULL
))
807 if (port
== NULL
&& strchr(host
, ':') == NULL
)
808 port
= use_ssl
? OSSL_HTTPS_PORT
: OSSL_HTTP_PORT
;
810 cbio
= BIO_new_connect(host
/* optionally includes ":port" */);
814 (void)BIO_set_conn_port(cbio
, port
);
819 #endif /* OPENSSL_NO_SOCK */
821 /* Exchange request and response via HTTP on (non-)blocking BIO */
822 BIO
*OSSL_HTTP_REQ_CTX_exchange(OSSL_HTTP_REQ_CTX
*rctx
)
827 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
832 rv
= OSSL_HTTP_REQ_CTX_nbio(rctx
);
835 /* BIO_should_retry was true */
836 /* will not actually wait if rctx->max_time == 0 */
837 if (BIO_wait(rctx
->rbio
, rctx
->max_time
, 100 /* milliseconds */) <= 0)
842 if (rctx
->redirection_url
== NULL
) { /* an error occurred */
843 if (rctx
->len_to_send
> 0)
844 ERR_raise(ERR_LIB_HTTP
, HTTP_R_ERROR_SENDING
);
846 ERR_raise(ERR_LIB_HTTP
, HTTP_R_ERROR_RECEIVING
);
850 return rctx
->state
== OHS_STREAM
? rctx
->rbio
: rctx
->mem
;
853 int OSSL_HTTP_is_alive(const OSSL_HTTP_REQ_CTX
*rctx
)
855 return rctx
!= NULL
&& rctx
->keep_alive
!= 0;
858 /* High-level HTTP API implementation */
860 /* Initiate an HTTP session using bio, else use given server, proxy, etc. */
861 OSSL_HTTP_REQ_CTX
*OSSL_HTTP_open(const char *server
, const char *port
,
862 const char *proxy
, const char *no_proxy
,
863 int use_ssl
, BIO
*bio
, BIO
*rbio
,
864 OSSL_HTTP_bio_cb_t bio_update_fn
, void *arg
,
865 int buf_size
, int overall_timeout
)
867 BIO
*cbio
; /* == bio if supplied, used as connection BIO if rbio is NULL */
868 OSSL_HTTP_REQ_CTX
*rctx
= NULL
;
870 if (use_ssl
&& bio_update_fn
== NULL
) {
871 ERR_raise(ERR_LIB_HTTP
, HTTP_R_TLS_NOT_ENABLED
);
874 if (rbio
!= NULL
&& (bio
== NULL
|| bio_update_fn
!= NULL
)) {
875 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_INVALID_ARGUMENT
);
881 if (proxy
!= NULL
|| no_proxy
!= NULL
) {
882 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_INVALID_ARGUMENT
);
886 #ifndef OPENSSL_NO_SOCK
887 char *proxy_host
= NULL
, *proxy_port
= NULL
;
889 if (server
== NULL
) {
890 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
893 if (port
!= NULL
&& *port
== '\0')
895 if (port
== NULL
&& strchr(server
, ':') == NULL
)
896 port
= use_ssl
? OSSL_HTTPS_PORT
: OSSL_HTTP_PORT
;
897 proxy
= OSSL_HTTP_adapt_proxy(proxy
, no_proxy
, server
, use_ssl
);
899 && !OSSL_HTTP_parse_url(proxy
, NULL
/* use_ssl */, NULL
/* user */,
900 &proxy_host
, &proxy_port
, NULL
/* num */,
901 NULL
/* path */, NULL
, NULL
))
903 cbio
= http_new_bio(server
, port
, use_ssl
, proxy_host
, proxy_port
);
904 OPENSSL_free(proxy_host
);
905 OPENSSL_free(proxy_port
);
909 ERR_raise(ERR_LIB_HTTP
, HTTP_R_SOCK_NOT_SUPPORTED
);
914 (void)ERR_set_mark(); /* prepare removing any spurious libssl errors */
915 if (rbio
== NULL
&& BIO_do_connect_retry(cbio
, overall_timeout
, -1) <= 0) {
916 if (bio
== NULL
) /* cbio was not provided by caller */
920 /* now overall_timeout is guaranteed to be >= 0 */
922 /* callback can be used to wrap or prepend TLS session */
923 if (bio_update_fn
!= NULL
) {
924 BIO
*orig_bio
= cbio
;
926 cbio
= (*bio_update_fn
)(cbio
, arg
, 1 /* connect */, use_ssl
);
928 if (bio
== NULL
) /* cbio was not provided by caller */
929 BIO_free_all(orig_bio
);
934 rctx
= http_req_ctx_new(bio
== NULL
, cbio
, rbio
!= NULL
? rbio
: cbio
,
935 bio_update_fn
, arg
, use_ssl
, proxy
, server
, port
,
936 buf_size
, overall_timeout
);
940 /* remove any spurious error queue entries by ssl_add_cert_chain() */
941 (void)ERR_pop_to_mark();
943 (void)ERR_clear_last_mark();
948 int OSSL_HTTP_set1_request(OSSL_HTTP_REQ_CTX
*rctx
, const char *path
,
949 const STACK_OF(CONF_VALUE
) *headers
,
950 const char *content_type
, BIO
*req
,
951 const char *expected_content_type
, int expect_asn1
,
952 size_t max_resp_len
, int timeout
, int keep_alive
)
957 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
960 use_http_proxy
= rctx
->proxy
!= NULL
&& !rctx
->use_ssl
;
961 if (use_http_proxy
&& (rctx
->server
== NULL
|| rctx
->port
== NULL
)) {
962 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_INVALID_ARGUMENT
);
965 rctx
->max_resp_len
= max_resp_len
; /* allows for 0: indefinite */
967 return OSSL_HTTP_REQ_CTX_set_request_line(rctx
, req
!= NULL
,
968 use_http_proxy
? rctx
->server
969 : NULL
, rctx
->port
, path
)
970 && add1_headers(rctx
, headers
, rctx
->server
)
971 && OSSL_HTTP_REQ_CTX_set_expected(rctx
, expected_content_type
,
972 expect_asn1
, timeout
, keep_alive
)
973 && set1_content(rctx
, content_type
, req
);
977 * Exchange single HTTP request and response according to rctx.
978 * If rctx->method_POST then use POST, else use GET and ignore content_type.
979 * The redirection_url output (freed by caller) parameter is used only for GET.
981 BIO
*OSSL_HTTP_exchange(OSSL_HTTP_REQ_CTX
*rctx
, char **redirection_url
)
986 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
990 if (redirection_url
!= NULL
)
991 *redirection_url
= NULL
; /* do this beforehand to prevent dbl free */
993 resp
= OSSL_HTTP_REQ_CTX_exchange(rctx
);
995 if (rctx
->redirection_url
!= NULL
) {
996 if (redirection_url
== NULL
)
997 ERR_raise(ERR_LIB_HTTP
, HTTP_R_REDIRECTION_NOT_ENABLED
);
999 /* may be NULL if out of memory: */
1000 *redirection_url
= OPENSSL_strdup(rctx
->redirection_url
);
1003 unsigned long err
= ERR_peek_error();
1004 int lib
= ERR_GET_LIB(err
);
1005 int reason
= ERR_GET_REASON(err
);
1007 if (lib
== ERR_LIB_SSL
|| lib
== ERR_LIB_HTTP
1008 || (lib
== ERR_LIB_BIO
&& reason
== BIO_R_CONNECT_TIMEOUT
)
1009 || (lib
== ERR_LIB_BIO
&& reason
== BIO_R_CONNECT_ERROR
)
1010 #ifndef OPENSSL_NO_CMP
1011 || (lib
== ERR_LIB_CMP
1012 && reason
== CMP_R_POTENTIALLY_INVALID_CERTIFICATE
)
1015 if (rctx
->server
!= NULL
) {
1016 BIO_snprintf(buf
, sizeof(buf
), "server=http%s://%s%s%s",
1017 rctx
->use_ssl
? "s" : "", rctx
->server
,
1018 rctx
->port
!= NULL
? ":" : "",
1019 rctx
->port
!= NULL
? rctx
->port
: "");
1020 ERR_add_error_data(1, buf
);
1022 if (rctx
->proxy
!= NULL
)
1023 ERR_add_error_data(2, " proxy=", rctx
->proxy
);
1025 BIO_snprintf(buf
, sizeof(buf
), " peer has disconnected%s",
1026 rctx
->use_ssl
? " violating the protocol" :
1027 ", likely because it requires the use of TLS");
1028 ERR_add_error_data(1, buf
);
1034 if (resp
!= NULL
&& !BIO_up_ref(resp
))
1039 static int redirection_ok(int n_redir
, const char *old_url
, const char *new_url
)
1041 if (n_redir
>= HTTP_VERSION_MAX_REDIRECTIONS
) {
1042 ERR_raise(ERR_LIB_HTTP
, HTTP_R_TOO_MANY_REDIRECTIONS
);
1045 if (*new_url
== '/') /* redirection to same server => same protocol */
1047 if (HAS_PREFIX(old_url
, OSSL_HTTPS_NAME
":") &&
1048 !HAS_PREFIX(new_url
, OSSL_HTTPS_NAME
":")) {
1049 ERR_raise(ERR_LIB_HTTP
, HTTP_R_REDIRECTION_FROM_HTTPS_TO_HTTP
);
1055 /* Get data via HTTP from server at given URL, potentially with redirection */
1056 BIO
*OSSL_HTTP_get(const char *url
, const char *proxy
, const char *no_proxy
,
1057 BIO
*bio
, BIO
*rbio
,
1058 OSSL_HTTP_bio_cb_t bio_update_fn
, void *arg
,
1059 int buf_size
, const STACK_OF(CONF_VALUE
) *headers
,
1060 const char *expected_ct
, int expect_asn1
,
1061 size_t max_resp_len
, int timeout
)
1063 char *current_url
, *redirection_url
= NULL
;
1069 OSSL_HTTP_REQ_CTX
*rctx
;
1073 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
1076 if ((current_url
= OPENSSL_strdup(url
)) == NULL
)
1080 if (!OSSL_HTTP_parse_url(current_url
, &use_ssl
, NULL
/* user */, &host
,
1081 &port
, NULL
/* port_num */, &path
, NULL
, NULL
))
1084 rctx
= OSSL_HTTP_open(host
, port
, proxy
, no_proxy
,
1085 use_ssl
, bio
, rbio
, bio_update_fn
, arg
,
1089 if (!OSSL_HTTP_set1_request(rctx
, path
, headers
,
1090 NULL
/* content_type */,
1092 expected_ct
, expect_asn1
, max_resp_len
,
1093 -1 /* use same max time (timeout) */,
1094 0 /* no keep_alive */))
1095 OSSL_HTTP_REQ_CTX_free(rctx
);
1097 resp
= OSSL_HTTP_exchange(rctx
, &redirection_url
);
1100 if (resp
== NULL
&& redirection_url
!= NULL
) {
1101 if (redirection_ok(++n_redirs
, current_url
, redirection_url
)) {
1102 (void)BIO_reset(bio
);
1103 OPENSSL_free(current_url
);
1104 current_url
= redirection_url
;
1105 if (*redirection_url
== '/') { /* redirection to same server */
1106 path
= OPENSSL_strdup(redirection_url
);
1111 (void)OSSL_HTTP_close(rctx
, 1);
1114 /* if redirection not allowed, ignore it */
1115 OPENSSL_free(redirection_url
);
1119 if (!OSSL_HTTP_close(rctx
, resp
!= NULL
)) {
1125 OPENSSL_free(current_url
);
1129 /* Exchange request and response over a connection managed via |prctx| */
1130 BIO
*OSSL_HTTP_transfer(OSSL_HTTP_REQ_CTX
**prctx
,
1131 const char *server
, const char *port
,
1132 const char *path
, int use_ssl
,
1133 const char *proxy
, const char *no_proxy
,
1134 BIO
*bio
, BIO
*rbio
,
1135 OSSL_HTTP_bio_cb_t bio_update_fn
, void *arg
,
1136 int buf_size
, const STACK_OF(CONF_VALUE
) *headers
,
1137 const char *content_type
, BIO
*req
,
1138 const char *expected_ct
, int expect_asn1
,
1139 size_t max_resp_len
, int timeout
, int keep_alive
)
1141 OSSL_HTTP_REQ_CTX
*rctx
= prctx
== NULL
? NULL
: *prctx
;
1145 rctx
= OSSL_HTTP_open(server
, port
, proxy
, no_proxy
,
1146 use_ssl
, bio
, rbio
, bio_update_fn
, arg
,
1148 timeout
= -1; /* Already set during opening the connection */
1151 if (OSSL_HTTP_set1_request(rctx
, path
, headers
, content_type
, req
,
1152 expected_ct
, expect_asn1
,
1153 max_resp_len
, timeout
, keep_alive
))
1154 resp
= OSSL_HTTP_exchange(rctx
, NULL
);
1155 if (resp
== NULL
|| !OSSL_HTTP_is_alive(rctx
)) {
1156 if (!OSSL_HTTP_close(rctx
, resp
!= NULL
)) {
1168 int OSSL_HTTP_close(OSSL_HTTP_REQ_CTX
*rctx
, int ok
)
1172 /* callback can be used to clean up TLS session on disconnect */
1173 if (rctx
!= NULL
&& rctx
->upd_fn
!= NULL
)
1174 ret
= (*rctx
->upd_fn
)(rctx
->wbio
, rctx
->upd_arg
, 0, ok
) != NULL
;
1175 OSSL_HTTP_REQ_CTX_free(rctx
);
1179 /* BASE64 encoder used for encoding basic proxy authentication credentials */
1180 static char *base64encode(const void *buf
, size_t len
)
1186 /* Calculate size of encoded data */
1191 out
= OPENSSL_malloc(outl
+ 1);
1195 i
= EVP_EncodeBlock((unsigned char *)out
, buf
, len
);
1196 if (!ossl_assert(0 <= i
&& (size_t)i
<= outl
)) {
1204 * Promote the given connection BIO using the CONNECT method for a TLS proxy.
1205 * This is typically called by an app, so bio_err and prog are used unless NULL
1206 * to print additional diagnostic information in a user-oriented way.
1208 int OSSL_HTTP_proxy_connect(BIO
*bio
, const char *server
, const char *port
,
1209 const char *proxyuser
, const char *proxypass
,
1210 int timeout
, BIO
*bio_err
, const char *prog
)
1213 #define BUF_SIZE (8 * 1024)
1214 char *mbuf
= OPENSSL_malloc(BUF_SIZE
);
1218 BIO
*fbio
= BIO_new(BIO_f_buffer());
1220 time_t max_time
= timeout
> 0 ? time(NULL
) + timeout
: 0;
1222 if (bio
== NULL
|| server
== NULL
1223 || (bio_err
!= NULL
&& prog
== NULL
)) {
1224 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
1227 if (port
== NULL
|| *port
== '\0')
1228 port
= OSSL_HTTPS_PORT
;
1230 if (mbuf
== NULL
|| fbio
== NULL
) {
1231 BIO_printf(bio_err
/* may be NULL */, "%s: out of memory", prog
);
1234 BIO_push(fbio
, bio
);
1236 BIO_printf(fbio
, "CONNECT %s:%s "HTTP_1_0
"\r\n", server
, port
);
1239 * Workaround for broken proxies which would otherwise close
1240 * the connection when entering tunnel mode (e.g., Squid 2.6)
1242 BIO_printf(fbio
, "Proxy-Connection: Keep-Alive\r\n");
1244 /* Support for basic (base64) proxy authentication */
1245 if (proxyuser
!= NULL
) {
1246 size_t len
= strlen(proxyuser
) + 1;
1247 char *proxyauth
, *proxyauthenc
= NULL
;
1249 if (proxypass
!= NULL
)
1250 len
+= strlen(proxypass
);
1251 proxyauth
= OPENSSL_malloc(len
+ 1);
1252 if (proxyauth
== NULL
)
1254 if (BIO_snprintf(proxyauth
, len
+ 1, "%s:%s", proxyuser
,
1255 proxypass
!= NULL
? proxypass
: "") != (int)len
)
1257 proxyauthenc
= base64encode(proxyauth
, len
);
1258 if (proxyauthenc
!= NULL
) {
1259 BIO_printf(fbio
, "Proxy-Authorization: Basic %s\r\n", proxyauthenc
);
1260 OPENSSL_clear_free(proxyauthenc
, strlen(proxyauthenc
));
1263 OPENSSL_clear_free(proxyauth
, len
);
1264 if (proxyauthenc
== NULL
)
1268 /* Terminate the HTTP CONNECT request */
1269 BIO_printf(fbio
, "\r\n");
1272 if (BIO_flush(fbio
) != 0)
1274 /* potentially needs to be retried if BIO is non-blocking */
1275 if (!BIO_should_retry(fbio
))
1280 /* will not actually wait if timeout == 0 */
1281 rv
= BIO_wait(fbio
, max_time
, 100 /* milliseconds */);
1283 BIO_printf(bio_err
, "%s: HTTP CONNECT %s\n", prog
,
1284 rv
== 0 ? "timed out" : "failed waiting for data");
1289 * The first line is the HTTP response.
1290 * According to RFC 7230, it is formatted exactly like this:
1291 * HTTP/d.d ddd reason text\r\n
1293 read_len
= BIO_gets(fbio
, mbuf
, BUF_SIZE
);
1294 /* the BIO may not block, so we must wait for the 1st line to come in */
1295 if (read_len
< (int)HTTP_LINE1_MINLEN
)
1298 /* Check for HTTP/1.x */
1300 if (!HAS_PREFIX(mbufp
, HTTP_PREFIX
)) {
1301 ERR_raise(ERR_LIB_HTTP
, HTTP_R_HEADER_PARSE_ERROR
);
1302 BIO_printf(bio_err
, "%s: HTTP CONNECT failed, non-HTTP response\n",
1304 /* Wrong protocol, not even HTTP, so stop reading headers */
1307 if (!HAS_PREFIX(mbufp
, HTTP_VERSION_PATT
)) {
1308 ERR_raise(ERR_LIB_HTTP
, HTTP_R_RECEIVED_WRONG_HTTP_VERSION
);
1310 "%s: HTTP CONNECT failed, bad HTTP version %.*s\n",
1311 prog
, (int)HTTP_VERSION_STR_LEN
, mbufp
);
1314 mbufp
+= HTTP_VERSION_STR_LEN
;
1316 /* RFC 7231 4.3.6: any 2xx status code is valid */
1317 if (!HAS_PREFIX(mbufp
, " 2")) {
1318 /* chop any trailing whitespace */
1319 while (read_len
> 0 && ossl_isspace(mbuf
[read_len
- 1]))
1321 mbuf
[read_len
] = '\0';
1322 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_CONNECT_FAILURE
,
1323 "reason=%s", mbufp
);
1324 BIO_printf(bio_err
, "%s: HTTP CONNECT failed, reason=%s\n",
1332 /* Read past all following headers */
1335 * This does not necessarily catch the case when the full
1336 * HTTP response came in in more than a single TCP message.
1338 read_len
= BIO_gets(fbio
, mbuf
, BUF_SIZE
);
1339 } while (read_len
> 2);
1343 (void)BIO_flush(fbio
);