2 * Copyright 2001-2020 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright Siemens AG 2018-2020
5 * Licensed under the Apache License 2.0 (the "License"). You may not use
6 * this file except in compliance with the License. You can obtain a copy
7 * in the file LICENSE in the source distribution or at
8 * https://www.openssl.org/source/license.html
14 #include "crypto/ctype.h"
16 #include <openssl/asn1.h>
17 #include <openssl/evp.h>
18 #include <openssl/err.h>
19 #include <openssl/httperr.h>
20 #include <openssl/cmperr.h>
21 #include <openssl/buffer.h>
22 #include <openssl/http.h>
23 #include "internal/sockets.h"
24 #include "internal/cryptlib.h" /* for ossl_assert() */
26 #include "http_local.h"
28 #define 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 *iobuf
; /* Line buffer */
46 int iobuflen
; /* Line buffer length */
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_GET
; /* HTTP method "GET" or "POST" */
51 const char *expected_ct
; /* expected Content-Type, or NULL */
52 int expect_asn1
; /* response must be ASN.1-encoded */
53 unsigned long resp_len
; /* length of response */
54 unsigned long max_resp_len
; /* Maximum length of response */
55 time_t max_time
; /* Maximum end time of the transfer, or 0 */
56 char *redirection_url
; /* Location given with HTTP status 301/302 */
59 #define HTTP_DEFAULT_MAX_LINE_LENGTH (4 * 1024)
60 #define HTTP_DEFAULT_MAX_RESP_LEN (100 * 1024)
64 #define OHS_NOREAD 0x1000 /* If set no reading should be performed */
65 #define OHS_ERROR (0 | OHS_NOREAD) /* Error condition */
66 #define OHS_FIRSTLINE 1 /* First line being read */
67 #define OHS_REDIRECT 0xa /* Looking for redirection location */
68 #define OHS_HEADERS 2 /* MIME headers being read */
69 #define OHS_ASN1_HEADER 3 /* HTTP initial header (tag+length) being read */
70 #define OHS_CONTENT 4 /* HTTP content octets being read */
71 #define OHS_WRITE_INIT (5 | OHS_NOREAD) /* 1st call: ready to start I/O */
72 #define OHS_WRITE (6 | OHS_NOREAD) /* Request being sent */
73 #define OHS_FLUSH (7 | OHS_NOREAD) /* Request being flushed */
74 #define OHS_DONE (8 | OHS_NOREAD) /* Completed */
75 #define OHS_HTTP_HEADER (9 | OHS_NOREAD) /* Headers set, w/o final \r\n */
77 OSSL_HTTP_REQ_CTX
*OSSL_HTTP_REQ_CTX_new(BIO
*wbio
, BIO
*rbio
,
78 int method_GET
, int maxline
,
79 unsigned long max_resp_len
,
81 const char *expected_content_type
,
84 OSSL_HTTP_REQ_CTX
*rctx
;
86 if (wbio
== NULL
|| rbio
== NULL
) {
87 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
91 if ((rctx
= OPENSSL_zalloc(sizeof(*rctx
))) == NULL
)
93 rctx
->state
= OHS_ERROR
;
94 rctx
->iobuflen
= maxline
> 0 ? maxline
: HTTP_DEFAULT_MAX_LINE_LENGTH
;
95 rctx
->iobuf
= OPENSSL_malloc(rctx
->iobuflen
);
98 rctx
->mem
= BIO_new(BIO_s_mem());
99 if (rctx
->iobuf
== NULL
|| rctx
->mem
== NULL
) {
100 OSSL_HTTP_REQ_CTX_free(rctx
);
103 rctx
->method_GET
= method_GET
;
104 rctx
->expected_ct
= expected_content_type
;
105 rctx
->expect_asn1
= expect_asn1
;
107 OSSL_HTTP_REQ_CTX_set_max_response_length(rctx
, max_resp_len
);
108 rctx
->max_time
= timeout
> 0 ? time(NULL
) + timeout
: 0;
112 void OSSL_HTTP_REQ_CTX_free(OSSL_HTTP_REQ_CTX
*rctx
)
116 BIO_free(rctx
->mem
); /* this may indirectly call ERR_clear_error() */
117 OPENSSL_free(rctx
->iobuf
);
121 BIO
*OSSL_HTTP_REQ_CTX_get0_mem_bio(OSSL_HTTP_REQ_CTX
*rctx
)
124 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
130 void OSSL_HTTP_REQ_CTX_set_max_response_length(OSSL_HTTP_REQ_CTX
*rctx
,
134 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
137 rctx
->max_resp_len
= len
!= 0 ? len
: HTTP_DEFAULT_MAX_RESP_LEN
;
141 * Create HTTP header using given op and path (or "/" in case path is NULL).
142 * Server name (and port) must be given if and only if plain HTTP proxy is used.
144 int OSSL_HTTP_REQ_CTX_header(OSSL_HTTP_REQ_CTX
*rctx
, const char *server
,
145 const char *port
, const char *path
)
148 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
152 if (BIO_printf(rctx
->mem
, "%s ", rctx
->method_GET
? "GET" : "POST") <= 0)
155 if (server
!= NULL
) { /* HTTP (but not HTTPS) proxy is used */
157 * Section 5.1.2 of RFC 1945 states that the absoluteURI form is only
158 * allowed when using a proxy
160 if (BIO_printf(rctx
->mem
, OSSL_HTTP_PREFIX
"%s", server
) <= 0)
162 if (port
!= NULL
&& BIO_printf(rctx
->mem
, ":%s", port
) <= 0)
166 /* Make sure path includes a forward slash */
169 if (path
[0] != '/' && BIO_printf(rctx
->mem
, "/") <= 0)
172 if (BIO_printf(rctx
->mem
, "%s "HTTP_PREFIX
"1.0\r\n", path
) <= 0)
174 rctx
->state
= OHS_HTTP_HEADER
;
178 int OSSL_HTTP_REQ_CTX_add1_header(OSSL_HTTP_REQ_CTX
*rctx
,
179 const char *name
, const char *value
)
181 if (rctx
== NULL
|| name
== NULL
) {
182 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
186 if (BIO_puts(rctx
->mem
, name
) <= 0)
189 if (BIO_write(rctx
->mem
, ": ", 2) != 2)
191 if (BIO_puts(rctx
->mem
, value
) <= 0)
194 if (BIO_write(rctx
->mem
, "\r\n", 2) != 2)
196 rctx
->state
= OHS_HTTP_HEADER
;
200 static int OSSL_HTTP_REQ_CTX_content(OSSL_HTTP_REQ_CTX
*rctx
,
201 const char *content_type
, BIO
*req_mem
)
203 const unsigned char *req
;
206 if (rctx
== NULL
|| req_mem
== NULL
) {
207 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
210 if (rctx
->method_GET
) {
211 ERR_raise(ERR_LIB_HTTP
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
215 if (content_type
!= NULL
216 && BIO_printf(rctx
->mem
, "Content-Type: %s\r\n", content_type
) <= 0)
219 if ((req_len
= BIO_get_mem_data(req_mem
, &req
)) <= 0)
221 rctx
->state
= OHS_WRITE_INIT
;
223 return BIO_printf(rctx
->mem
, "Content-Length: %ld\r\n\r\n", req_len
) > 0
224 && BIO_write(rctx
->mem
, req
, req_len
) == (int)req_len
;
227 BIO
*HTTP_asn1_item2bio(const ASN1_ITEM
*it
, const ASN1_VALUE
*val
)
231 if (it
== NULL
|| val
== NULL
) {
232 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
236 if ((res
= BIO_new(BIO_s_mem())) == NULL
)
238 if (ASN1_item_i2d_bio(it
, res
, val
) <= 0) {
245 int OSSL_HTTP_REQ_CTX_i2d(OSSL_HTTP_REQ_CTX
*rctx
, const char *content_type
,
246 const ASN1_ITEM
*it
, ASN1_VALUE
*req
)
251 if (rctx
== NULL
|| it
== NULL
|| req
== NULL
) {
252 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
256 res
= (mem
= HTTP_asn1_item2bio(it
, req
)) != NULL
257 && OSSL_HTTP_REQ_CTX_content(rctx
, content_type
, mem
);
262 static int OSSL_HTTP_REQ_CTX_add1_headers(OSSL_HTTP_REQ_CTX
*rctx
,
263 const STACK_OF(CONF_VALUE
) *headers
,
270 for (i
= 0; i
< sk_CONF_VALUE_num(headers
); i
++) {
271 hdr
= sk_CONF_VALUE_value(headers
, i
);
272 if (add_host
&& strcasecmp("host", hdr
->name
) == 0)
274 if (!OSSL_HTTP_REQ_CTX_add1_header(rctx
, hdr
->name
, hdr
->value
))
278 if (add_host
&& !OSSL_HTTP_REQ_CTX_add1_header(rctx
, "Host", host
))
284 * Create OSSL_HTTP_REQ_CTX structure using the values provided.
285 * If !use_http_proxy then the 'server' and 'port' parameters are ignored.
286 * If req_mem == NULL then use GET and ignore content_type, else POST.
288 OSSL_HTTP_REQ_CTX
*HTTP_REQ_CTX_new(BIO
*wbio
, BIO
*rbio
, int use_http_proxy
,
289 const char *server
, const char *port
,
291 const STACK_OF(CONF_VALUE
) *headers
,
292 const char *content_type
, BIO
*req_mem
,
293 int maxline
, unsigned long max_resp_len
,
295 const char *expected_content_type
,
298 OSSL_HTTP_REQ_CTX
*rctx
;
300 if (use_http_proxy
&& (server
== NULL
|| port
== NULL
)) {
301 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
304 /* remaining parameters are checked indirectly by the functions called */
306 if ((rctx
= OSSL_HTTP_REQ_CTX_new(wbio
, rbio
, req_mem
== NULL
, maxline
,
307 max_resp_len
, timeout
,
308 expected_content_type
, expect_asn1
))
312 if (OSSL_HTTP_REQ_CTX_header(rctx
, use_http_proxy
? server
: NULL
,
314 && OSSL_HTTP_REQ_CTX_add1_headers(rctx
, headers
, server
)
316 || OSSL_HTTP_REQ_CTX_content(rctx
, content_type
, req_mem
)))
319 OSSL_HTTP_REQ_CTX_free(rctx
);
324 * Parse first HTTP response line. This should be like this: "HTTP/1.0 200 OK".
325 * We need to obtain the numeric code and (optional) informational message.
328 static int parse_http_line1(char *line
)
331 char *code
, *reason
, *end
;
333 /* Skip to first whitespace (past protocol info) */
334 for (code
= line
; *code
!= '\0' && !ossl_isspace(*code
); code
++)
337 ERR_raise(ERR_LIB_HTTP
, HTTP_R_RESPONSE_PARSE_ERROR
);
341 /* Skip past whitespace to start of response code */
342 while (*code
!= '\0' && ossl_isspace(*code
))
346 ERR_raise(ERR_LIB_HTTP
, HTTP_R_RESPONSE_PARSE_ERROR
);
350 /* Find end of response code: first whitespace after start of code */
351 for (reason
= code
; *reason
!= '\0' && !ossl_isspace(*reason
); reason
++)
354 if (*reason
== '\0') {
355 ERR_raise(ERR_LIB_HTTP
, HTTP_R_RESPONSE_PARSE_ERROR
);
359 /* Set end of response code and start of message */
362 /* Attempt to parse numeric code */
363 retcode
= strtoul(code
, &end
, 10);
368 /* Skip over any leading whitespace in message */
369 while (*reason
!= '\0' && ossl_isspace(*reason
))
372 if (*reason
!= '\0') {
374 * Finally zap any trailing whitespace in message (include CRLF)
377 /* chop any trailing whitespace from reason */
378 /* We know reason has a non-whitespace character so this is OK */
379 for (end
= reason
+ strlen(reason
) - 1; ossl_isspace(*end
); end
--)
384 case HTTP_STATUS_CODE_OK
:
385 case HTTP_STATUS_CODE_MOVED_PERMANENTLY
:
386 case HTTP_STATUS_CODE_FOUND
:
390 retcode
= HTTP_R_STATUS_CODE_UNSUPPORTED
;
392 retcode
= HTTP_R_RECEIVED_ERROR
;
394 ERR_raise_data(ERR_LIB_HTTP
, retcode
, "Code=%s", code
);
396 ERR_raise_data(ERR_LIB_HTTP
, retcode
,
397 "Code=%s, Reason=%s", code
, reason
);
402 static int check_set_resp_len(OSSL_HTTP_REQ_CTX
*rctx
, unsigned long len
)
404 if (len
> rctx
->max_resp_len
)
405 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_MAX_RESP_LEN_EXCEEDED
,
406 "length=%lu, max=%lu", len
, rctx
->max_resp_len
);
407 if (rctx
->resp_len
!= 0 && rctx
->resp_len
!= len
)
408 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_INCONSISTENT_CONTENT_LENGTH
,
409 "length=%lu, before=%lu", len
, rctx
->resp_len
);
410 rctx
->resp_len
= len
;
415 * Try exchanging request and response via HTTP on (non-)blocking BIO in rctx.
416 * Returns 1 on success, 0 on error or redirection, -1 on BIO_should_retry.
418 int OSSL_HTTP_REQ_CTX_nbio(OSSL_HTTP_REQ_CTX
*rctx
)
421 long n
, n_to_send
= 0;
422 unsigned long resp_len
;
423 const unsigned char *p
;
424 char *key
, *value
, *line_end
= NULL
;
427 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
431 rctx
->redirection_url
= NULL
;
433 if ((rctx
->state
& OHS_NOREAD
) == 0) {
434 n
= BIO_read(rctx
->rbio
, rctx
->iobuf
, rctx
->iobuflen
);
436 if (BIO_should_retry(rctx
->rbio
))
441 /* Write data to memory BIO */
442 if (BIO_write(rctx
->mem
, rctx
->iobuf
, n
) != n
)
446 switch (rctx
->state
) {
447 case OHS_HTTP_HEADER
:
448 /* Last operation was adding headers: need a final \r\n */
449 if (BIO_write(rctx
->mem
, "\r\n", 2) != 2) {
450 rctx
->state
= OHS_ERROR
;
453 rctx
->state
= OHS_WRITE_INIT
;
457 n_to_send
= BIO_get_mem_data(rctx
->mem
, NULL
);
458 rctx
->state
= OHS_WRITE
;
462 n
= BIO_get_mem_data(rctx
->mem
, &p
);
464 i
= BIO_write(rctx
->wbio
, p
+ (n
- n_to_send
), n_to_send
);
467 if (BIO_should_retry(rctx
->wbio
))
469 rctx
->state
= OHS_ERROR
;
478 rctx
->state
= OHS_FLUSH
;
480 (void)BIO_reset(rctx
->mem
);
485 i
= BIO_flush(rctx
->wbio
);
488 rctx
->state
= OHS_FIRSTLINE
;
492 if (BIO_should_retry(rctx
->wbio
))
495 rctx
->state
= OHS_ERROR
;
505 /* Attempt to read a line in */
508 * Due to strange memory BIO behavior with BIO_gets we have to check
509 * there's a complete line in there before calling BIO_gets or we'll
510 * just get a partial read.
512 n
= BIO_get_mem_data(rctx
->mem
, &p
);
513 if (n
<= 0 || memchr(p
, '\n', n
) == 0) {
514 if (n
>= rctx
->iobuflen
) {
515 rctx
->state
= OHS_ERROR
;
520 n
= BIO_gets(rctx
->mem
, (char *)rctx
->iobuf
, rctx
->iobuflen
);
523 if (BIO_should_retry(rctx
->mem
))
525 rctx
->state
= OHS_ERROR
;
529 /* Don't allow excessive lines */
530 if (n
== rctx
->iobuflen
) {
531 ERR_raise(ERR_LIB_HTTP
, HTTP_R_RESPONSE_LINE_TOO_LONG
);
532 rctx
->state
= OHS_ERROR
;
537 if (rctx
->state
== OHS_FIRSTLINE
) {
538 switch (parse_http_line1((char *)rctx
->iobuf
)) {
539 case HTTP_STATUS_CODE_OK
:
540 rctx
->state
= OHS_HEADERS
;
542 case HTTP_STATUS_CODE_MOVED_PERMANENTLY
:
543 case HTTP_STATUS_CODE_FOUND
: /* i.e., moved temporarily */
544 if (rctx
->method_GET
) {
545 rctx
->state
= OHS_REDIRECT
;
548 ERR_raise(ERR_LIB_HTTP
, HTTP_R_REDIRECTION_NOT_ENABLED
);
549 /* redirection is not supported/recommended for POST */
552 rctx
->state
= OHS_ERROR
;
556 key
= (char *)rctx
->iobuf
;
557 value
= strchr(key
, ':');
560 while (ossl_isspace(*value
))
562 line_end
= strchr(value
, '\r');
563 if (line_end
== NULL
)
564 line_end
= strchr(value
, '\n');
565 if (line_end
!= NULL
)
568 if (value
!= NULL
&& line_end
!= NULL
) {
569 if (rctx
->state
== OHS_REDIRECT
570 && strcasecmp(key
, "Location") == 0) {
571 rctx
->redirection_url
= value
;
574 if (rctx
->expected_ct
!= NULL
575 && strcasecmp(key
, "Content-Type") == 0) {
576 if (strcasecmp(rctx
->expected_ct
, value
) != 0) {
577 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_UNEXPECTED_CONTENT_TYPE
,
578 "expected=%s, actual=%s",
579 rctx
->expected_ct
, value
);
582 rctx
->expected_ct
= NULL
; /* content-type has been found */
584 if (strcasecmp(key
, "Content-Length") == 0) {
585 resp_len
= strtoul(value
, &line_end
, 10);
586 if (line_end
== value
|| *line_end
!= '\0') {
587 ERR_raise_data(ERR_LIB_HTTP
,
588 HTTP_R_ERROR_PARSING_CONTENT_LENGTH
,
592 if (!check_set_resp_len(rctx
, resp_len
))
597 /* Look for blank line: end of headers */
598 for (p
= rctx
->iobuf
; *p
!= '\0'; p
++) {
599 if (*p
!= '\r' && *p
!= '\n')
602 if (*p
!= '\0') /* not end of headers */
605 if (rctx
->expected_ct
!= NULL
) {
606 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_MISSING_CONTENT_TYPE
,
607 "expected=%s", rctx
->expected_ct
);
610 if (rctx
->state
== OHS_REDIRECT
) {
611 /* http status code indicated redirect but there was no Location */
612 ERR_raise(ERR_LIB_HTTP
, HTTP_R_MISSING_REDIRECT_LOCATION
);
616 if (!rctx
->expect_asn1
) {
617 rctx
->state
= OHS_CONTENT
;
621 rctx
->state
= OHS_ASN1_HEADER
;
624 case OHS_ASN1_HEADER
:
626 * Now reading ASN1 header: can read at least 2 bytes which is enough
627 * for ASN1 SEQUENCE header and either length field or at least the
628 * length of the length field.
630 n
= BIO_get_mem_data(rctx
->mem
, &p
);
634 /* Check it is an ASN1 SEQUENCE */
635 if (*p
++ != (V_ASN1_SEQUENCE
| V_ASN1_CONSTRUCTED
)) {
636 ERR_raise(ERR_LIB_HTTP
, HTTP_R_MISSING_ASN1_ENCODING
);
640 /* Check out length field */
641 if ((*p
& 0x80) != 0) {
643 * If MSB set on initial length octet we can now always read 6
644 * octets: make sure we have them.
649 /* Not NDEF or excessive length */
650 if (n
== 0 || (n
> 4)) {
651 ERR_raise(ERR_LIB_HTTP
, HTTP_R_ERROR_PARSING_ASN1_LENGTH
);
656 for (i
= 0; i
< n
; i
++) {
664 if (!check_set_resp_len(rctx
, resp_len
))
668 rctx
->state
= OHS_CONTENT
;
673 n
= BIO_get_mem_data(rctx
->mem
, NULL
);
674 if (n
< (long)rctx
->resp_len
/* may be 0 if no Content-Type or ASN.1 */)
677 rctx
->state
= OHS_DONE
;
682 #ifndef OPENSSL_NO_SOCK
684 /* set up a new connection BIO, to HTTP server or to HTTP(S) proxy if given */
685 static BIO
*HTTP_new_bio(const char *server
/* optionally includes ":port" */,
686 const char *server_port
/* explicit server port */,
687 const char *proxy
/* optionally includes ":port" */)
689 const char *host
= server
, *host_end
;
691 const char *port
= server_port
;
694 if (!ossl_assert(server
!= NULL
))
702 host_end
= strchr(host
, '/');
703 if (host_end
!= NULL
) {
704 size_t host_len
= host_end
- host
;
706 if (host_len
< sizeof(host_name
)) {
707 /* chop trailing string starting with '/' */
708 strncpy(host_name
, host
, host_len
);
709 host_name
[host_len
] = '\0';
714 cbio
= BIO_new_connect(host
/* optionally includes ":port" */);
718 (void)BIO_set_conn_port(cbio
, port
);
723 #endif /* OPENSSL_NO_SOCK */
725 static ASN1_VALUE
*BIO_mem_d2i(BIO
*mem
, const ASN1_ITEM
*it
)
727 const unsigned char *p
;
728 long len
= BIO_get_mem_data(mem
, &p
);
729 ASN1_VALUE
*resp
= ASN1_item_d2i(NULL
, &p
, len
, it
);
732 ERR_raise(ERR_LIB_HTTP
, HTTP_R_RESPONSE_PARSE_ERROR
);
736 static BIO
*OSSL_HTTP_REQ_CTX_transfer(OSSL_HTTP_REQ_CTX
*rctx
)
742 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
747 rv
= OSSL_HTTP_REQ_CTX_nbio(rctx
);
750 /* BIO_should_retry was true */
752 /* will not actually wait if rctx->max_time == 0 */
753 if (BIO_wait(rctx
->rbio
, rctx
->max_time
, 100 /* milliseconds */) <= 0)
758 if (rctx
->redirection_url
== NULL
) { /* an error occurred */
759 if (sending
&& (rctx
->state
& OHS_NOREAD
) != 0)
760 ERR_raise(ERR_LIB_HTTP
, HTTP_R_ERROR_SENDING
);
762 ERR_raise(ERR_LIB_HTTP
, HTTP_R_ERROR_RECEIVING
);
766 if (!BIO_up_ref(rctx
->mem
))
771 /* Exchange ASN.1-encoded request and response via HTTP on (non-)blocking BIO */
772 ASN1_VALUE
*OSSL_HTTP_REQ_CTX_sendreq_d2i(OSSL_HTTP_REQ_CTX
*rctx
,
775 if (rctx
== NULL
|| it
== NULL
) {
776 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
779 return BIO_mem_d2i(OSSL_HTTP_REQ_CTX_transfer(rctx
), it
);
782 static int update_timeout(int timeout
, time_t start_time
)
788 elapsed_time
= (long)(time(NULL
) - start_time
); /* this might overflow */
789 return timeout
<= elapsed_time
? -1 : timeout
- elapsed_time
;
793 * Exchange HTTP request and response with the given server.
794 * If req_mem == NULL then use GET and ignore content_type, else POST.
795 * The redirection_url output (freed by caller) parameter is used only for GET.
797 * Typically the bio and rbio parameters are NULL and a network BIO is created
798 * internally for connecting to the given server and port, optionally via a
799 * proxy and its port, and is then used for exchanging the request and response.
800 * If bio is given and rbio is NULL then this BIO is used instead.
801 * If both bio and rbio are given (which may be memory BIOs for instance)
802 * then no explicit connection is attempted,
803 * bio is used for writing the request, and rbio for reading the response.
805 * bio_update_fn is an optional BIO connect/disconnect callback function,
806 * which has the prototype
807 * BIO *(*OSSL_HTTP_bio_cb_t) (BIO *bio, void *arg, int conn, int detail);
808 * The callback may modify the HTTP BIO provided in the bio argument,
809 * whereby it may make use of any custom defined argument 'arg'.
810 * During connection establishment, just after BIO_do_connect_retry(),
811 * the callback function is invoked with the 'conn' argument being 1
812 * 'detail' indicating whether a HTTPS (i.e., TLS) connection is requested.
813 * On disconnect 'conn' is 0 and 'detail' indicates that no error occurred.
814 * For instance, on connect the funct may prepend a TLS BIO to implement HTTPS;
815 * after disconnect it may do some error diagnostics and/or specific cleanup.
816 * The function should return NULL to indicate failure.
817 * After disconnect the modified BIO will be deallocated using BIO_free_all().
819 BIO
*OSSL_HTTP_transfer(const char *server
, const char *port
, const char *path
,
820 int use_ssl
, const char *proxy
, const char *no_proxy
,
822 OSSL_HTTP_bio_cb_t bio_update_fn
, void *arg
,
823 const STACK_OF(CONF_VALUE
) *headers
,
824 const char *content_type
, BIO
*req_mem
,
825 int maxline
, unsigned long max_resp_len
, int timeout
,
826 const char *expected_ct
, int expect_asn1
,
827 char **redirection_url
)
829 time_t start_time
= timeout
> 0 ? time(NULL
) : 0;
830 BIO
*cbio
; /* = bio if present, used as connection BIO if rbio is NULL */
831 OSSL_HTTP_REQ_CTX
*rctx
;
834 if (redirection_url
!= NULL
)
835 *redirection_url
= NULL
; /* do this beforehand to prevent dbl free */
837 if (use_ssl
&& bio_update_fn
== NULL
) {
838 ERR_raise(ERR_LIB_HTTP
, HTTP_R_TLS_NOT_ENABLED
);
841 if (rbio
!= NULL
&& (bio
== NULL
|| bio_update_fn
!= NULL
)) {
842 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_INVALID_ARGUMENT
);
849 #ifndef OPENSSL_NO_SOCK
850 if (server
== NULL
) {
851 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
856 if (port
== NULL
&& strchr(server
, ':') == NULL
)
857 port
= use_ssl
? OSSL_HTTPS_PORT
: OSSL_HTTP_PORT
;
858 proxy
= http_adapt_proxy(proxy
, no_proxy
, server
, use_ssl
);
859 if ((cbio
= HTTP_new_bio(server
, port
, proxy
)) == NULL
)
862 ERR_raise(ERR_LIB_HTTP
, HTTP_R_SOCK_NOT_SUPPORTED
);
866 /* remaining parameters are checked indirectly by the functions called */
868 (void)ERR_set_mark(); /* prepare removing any spurious libssl errors */
869 if (rbio
== NULL
&& BIO_do_connect_retry(cbio
, timeout
, -1) <= 0)
871 /* now timeout is guaranteed to be >= 0 */
873 /* callback can be used to wrap or prepend TLS session */
874 if (bio_update_fn
!= NULL
) {
875 BIO
*orig_bio
= cbio
;
876 cbio
= (*bio_update_fn
)(cbio
, arg
, 1 /* connect */, use_ssl
);
883 rctx
= HTTP_REQ_CTX_new(cbio
, rbio
!= NULL
? rbio
: cbio
,
884 !use_ssl
&& proxy
!= NULL
, server
, port
, path
,
885 headers
, content_type
, req_mem
, maxline
,
886 max_resp_len
, update_timeout(timeout
, start_time
),
887 expected_ct
, expect_asn1
);
891 resp
= OSSL_HTTP_REQ_CTX_transfer(rctx
);
893 if (rctx
->redirection_url
!= NULL
) {
894 if (redirection_url
== NULL
)
895 ERR_raise(ERR_LIB_HTTP
, HTTP_R_REDIRECTION_NOT_ENABLED
);
897 /* may be NULL if out of memory: */
898 *redirection_url
= OPENSSL_strdup(rctx
->redirection_url
);
901 unsigned long err
= ERR_peek_error();
902 int lib
= ERR_GET_LIB(err
);
903 int reason
= ERR_GET_REASON(err
);
905 if (lib
== ERR_LIB_SSL
|| lib
== ERR_LIB_HTTP
906 || (lib
== ERR_LIB_BIO
&& reason
== BIO_R_CONNECT_TIMEOUT
)
907 || (lib
== ERR_LIB_BIO
&& reason
== BIO_R_CONNECT_ERROR
)
908 #ifndef OPENSSL_NO_CMP
909 || (lib
== ERR_LIB_CMP
910 && reason
== CMP_R_POTENTIALLY_INVALID_CERTIFICATE
)
913 BIO_snprintf(buf
, 200, "server=%s:%s", server
, port
);
914 ERR_add_error_data(1, buf
);
916 ERR_add_error_data(2, " proxy=", proxy
);
918 BIO_snprintf(buf
, 200, " peer has disconnected%s",
919 use_ssl
? " violating the protocol" :
920 ", likely because it requires the use of TLS");
921 ERR_add_error_data(1, buf
);
926 OSSL_HTTP_REQ_CTX_free(rctx
);
928 /* callback can be used to clean up TLS session */
929 if (bio_update_fn
!= NULL
930 && (*bio_update_fn
)(cbio
, arg
, 0, resp
!= NULL
) == NULL
) {
937 * Use BIO_free_all() because bio_update_fn may prepend or append to cbio.
938 * This also frees any (e.g., SSL/TLS) BIOs linked with bio and,
939 * like BIO_reset(bio), calls SSL_shutdown() to notify/alert the peer.
941 if (bio
== NULL
) /* cbio was not provided by caller */
945 /* remove any spurious error queue entries by ssl_add_cert_chain() */
946 (void)ERR_pop_to_mark();
948 (void)ERR_clear_last_mark();
953 static int redirection_ok(int n_redir
, const char *old_url
, const char *new_url
)
955 size_t https_len
= strlen(OSSL_HTTPS_NAME
":");
957 if (n_redir
>= HTTP_VERSION_MAX_REDIRECTIONS
) {
958 ERR_raise(ERR_LIB_HTTP
, HTTP_R_TOO_MANY_REDIRECTIONS
);
961 if (*new_url
== '/') /* redirection to same server => same protocol */
963 if (strncmp(old_url
, OSSL_HTTPS_NAME
":", https_len
) == 0 &&
964 strncmp(new_url
, OSSL_HTTPS_NAME
":", https_len
) != 0) {
965 ERR_raise(ERR_LIB_HTTP
, HTTP_R_REDIRECTION_FROM_HTTPS_TO_HTTP
);
971 /* Get data via HTTP from server at given URL, potentially with redirection */
972 BIO
*OSSL_HTTP_get(const char *url
, const char *proxy
, const char *no_proxy
,
974 OSSL_HTTP_bio_cb_t bio_update_fn
, void *arg
,
975 const STACK_OF(CONF_VALUE
) *headers
,
976 int maxline
, unsigned long max_resp_len
, int timeout
,
977 const char *expected_content_type
, int expect_asn1
)
979 time_t start_time
= timeout
> 0 ? time(NULL
) : 0;
980 char *current_url
, *redirection_url
;
989 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
992 if ((current_url
= OPENSSL_strdup(url
)) == NULL
)
996 if (!OSSL_HTTP_parse_url(current_url
, &host
, &port
, NULL
/* port_num */,
1001 resp
= OSSL_HTTP_transfer(host
, port
, path
, use_ssl
, proxy
, no_proxy
,
1003 bio_update_fn
, arg
, headers
, NULL
, NULL
,
1004 maxline
, max_resp_len
,
1005 update_timeout(timeout
, start_time
),
1006 expected_content_type
, expect_asn1
,
1009 if (resp
== NULL
&& redirection_url
!= NULL
) {
1010 if (redirection_ok(++n_redirs
, current_url
, redirection_url
)) {
1011 (void)BIO_reset(bio
);
1012 OPENSSL_free(current_url
);
1013 current_url
= redirection_url
;
1014 if (*redirection_url
== '/') { /* redirection to same server */
1015 path
= OPENSSL_strdup(redirection_url
);
1022 OPENSSL_free(redirection_url
);
1028 OPENSSL_free(current_url
);
1032 /* Get ASN.1-encoded data via HTTP from server at given URL */
1033 ASN1_VALUE
*OSSL_HTTP_get_asn1(const char *url
,
1034 const char *proxy
, const char *no_proxy
,
1035 BIO
*bio
, BIO
*rbio
,
1036 OSSL_HTTP_bio_cb_t bio_update_fn
, void *arg
,
1037 const STACK_OF(CONF_VALUE
) *headers
,
1038 int maxline
, unsigned long max_resp_len
,
1039 int timeout
, const char *expected_content_type
,
1040 const ASN1_ITEM
*it
)
1043 ASN1_VALUE
*resp
= NULL
;
1045 if (url
== NULL
|| it
== NULL
) {
1046 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
1049 if ((mem
= OSSL_HTTP_get(url
, proxy
, no_proxy
, bio
, rbio
, bio_update_fn
,
1050 arg
, headers
, maxline
, max_resp_len
, timeout
,
1051 expected_content_type
, 1 /* expect_asn1 */))
1053 resp
= BIO_mem_d2i(mem
, it
);
1058 /* Post ASN.1-encoded request via HTTP to server return ASN.1 response */
1059 ASN1_VALUE
*OSSL_HTTP_post_asn1(const char *server
, const char *port
,
1060 const char *path
, int use_ssl
,
1061 const char *proxy
, const char *no_proxy
,
1062 BIO
*bio
, BIO
*rbio
,
1063 OSSL_HTTP_bio_cb_t bio_update_fn
, void *arg
,
1064 const STACK_OF(CONF_VALUE
) *headers
,
1065 const char *content_type
,
1066 const ASN1_VALUE
*req
, const ASN1_ITEM
*req_it
,
1067 int maxline
, unsigned long max_resp_len
,
1068 int timeout
, const char *expected_ct
,
1069 const ASN1_ITEM
*rsp_it
)
1073 ASN1_VALUE
*resp
= NULL
;
1076 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
1079 /* remaining parameters are checked indirectly */
1081 req_mem
= HTTP_asn1_item2bio(req_it
, req
);
1082 res_mem
= OSSL_HTTP_transfer(server
, port
, path
, use_ssl
, proxy
, no_proxy
,
1084 bio_update_fn
, arg
, headers
, content_type
,
1085 req_mem
/* may be NULL */, maxline
,
1086 max_resp_len
, timeout
,
1087 expected_ct
, 1 /* expect_asn1 */, NULL
);
1089 if (res_mem
!= NULL
)
1090 resp
= BIO_mem_d2i(res_mem
, rsp_it
);
1095 /* BASE64 encoder used for encoding basic proxy authentication credentials */
1096 static char *base64encode(const void *buf
, size_t len
)
1102 /* Calculate size of encoded data */
1107 out
= OPENSSL_malloc(outl
+ 1);
1111 i
= EVP_EncodeBlock((unsigned char *)out
, buf
, len
);
1112 if (!ossl_assert(0 <= i
&& (size_t)i
<= outl
)) {
1120 * Promote the given connection BIO using the CONNECT method for a TLS proxy.
1121 * This is typically called by an app, so bio_err and prog are used unless NULL
1122 * to print additional diagnostic information in a user-oriented way.
1124 int OSSL_HTTP_proxy_connect(BIO
*bio
, const char *server
, const char *port
,
1125 const char *proxyuser
, const char *proxypass
,
1126 int timeout
, BIO
*bio_err
, const char *prog
)
1129 #define BUF_SIZE (8 * 1024)
1130 char *mbuf
= OPENSSL_malloc(BUF_SIZE
);
1134 BIO
*fbio
= BIO_new(BIO_f_buffer());
1136 time_t max_time
= timeout
> 0 ? time(NULL
) + timeout
: 0;
1138 if (bio
== NULL
|| server
== NULL
1139 || (bio_err
!= NULL
&& prog
== NULL
)) {
1140 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
1143 if (port
== NULL
|| *port
== '\0')
1144 port
= OSSL_HTTPS_PORT
;
1146 if (mbuf
== NULL
|| fbio
== NULL
) {
1147 BIO_printf(bio_err
/* may be NULL */, "%s: out of memory", prog
);
1150 BIO_push(fbio
, bio
);
1152 BIO_printf(fbio
, "CONNECT %s:%s "HTTP_PREFIX
"1.0\r\n", server
, port
);
1155 * Workaround for broken proxies which would otherwise close
1156 * the connection when entering tunnel mode (e.g., Squid 2.6)
1158 BIO_printf(fbio
, "Proxy-Connection: Keep-Alive\r\n");
1160 /* Support for basic (base64) proxy authentication */
1161 if (proxyuser
!= NULL
) {
1162 size_t len
= strlen(proxyuser
) + 1;
1163 char *proxyauth
, *proxyauthenc
= NULL
;
1165 if (proxypass
!= NULL
)
1166 len
+= strlen(proxypass
);
1167 proxyauth
= OPENSSL_malloc(len
+ 1);
1168 if (proxyauth
== NULL
)
1170 if (BIO_snprintf(proxyauth
, len
+ 1, "%s:%s", proxyuser
,
1171 proxypass
!= NULL
? proxypass
: "") != (int)len
)
1173 proxyauthenc
= base64encode(proxyauth
, len
);
1174 if (proxyauthenc
!= NULL
) {
1175 BIO_printf(fbio
, "Proxy-Authorization: Basic %s\r\n", proxyauthenc
);
1176 OPENSSL_clear_free(proxyauthenc
, strlen(proxyauthenc
));
1179 OPENSSL_clear_free(proxyauth
, len
);
1180 if (proxyauthenc
== NULL
)
1184 /* Terminate the HTTP CONNECT request */
1185 BIO_printf(fbio
, "\r\n");
1188 if (BIO_flush(fbio
) != 0)
1190 /* potentially needs to be retried if BIO is non-blocking */
1191 if (!BIO_should_retry(fbio
))
1196 /* will not actually wait if timeout == 0 */
1197 rv
= BIO_wait(fbio
, max_time
, 100 /* milliseconds */);
1199 BIO_printf(bio_err
, "%s: HTTP CONNECT %s\n", prog
,
1200 rv
== 0 ? "timed out" : "failed waiting for data");
1205 * The first line is the HTTP response.
1206 * According to RFC 7230, it is formatted exactly like this:
1207 * HTTP/d.d ddd Reason text\r\n
1209 read_len
= BIO_gets(fbio
, mbuf
, BUF_SIZE
);
1210 /* the BIO may not block, so we must wait for the 1st line to come in */
1211 if (read_len
< HTTP_LINE1_MINLEN
)
1214 /* RFC 7231 4.3.6: any 2xx status code is valid */
1215 if (strncmp(mbuf
, HTTP_PREFIX
, strlen(HTTP_PREFIX
)) != 0) {
1216 ERR_raise(ERR_LIB_HTTP
, HTTP_R_RESPONSE_PARSE_ERROR
);
1217 BIO_printf(bio_err
, "%s: HTTP CONNECT failed, non-HTTP response\n",
1219 /* Wrong protocol, not even HTTP, so stop reading headers */
1222 mbufp
= mbuf
+ strlen(HTTP_PREFIX
);
1223 if (strncmp(mbufp
, HTTP_VERSION_PATT
, strlen(HTTP_VERSION_PATT
)) != 0) {
1224 ERR_raise(ERR_LIB_HTTP
, HTTP_R_RECEIVED_WRONG_HTTP_VERSION
);
1226 "%s: HTTP CONNECT failed, bad HTTP version %.*s\n",
1227 prog
, HTTP_VERSION_STR_LEN
, mbufp
);
1230 mbufp
+= HTTP_VERSION_STR_LEN
;
1231 if (strncmp(mbufp
, " 2", strlen(" 2")) != 0) {
1233 /* chop any trailing whitespace */
1234 while (read_len
> 0 && ossl_isspace(mbuf
[read_len
- 1]))
1236 mbuf
[read_len
] = '\0';
1237 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_CONNECT_FAILURE
,
1238 "Reason=%s", mbufp
);
1239 BIO_printf(bio_err
, "%s: HTTP CONNECT failed, Reason=%s\n",
1247 /* Read past all following headers */
1250 * TODO: This does not necessarily catch the case when the full
1251 * HTTP response came in in more than a single TCP message.
1253 read_len
= BIO_gets(fbio
, mbuf
, BUF_SIZE
);
1254 } while (read_len
> 2);
1258 (void)BIO_flush(fbio
);