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 request line using |ctx| 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_set_request_line(OSSL_HTTP_REQ_CTX
*rctx
,
145 const char *server
, const char *port
,
149 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
153 if (BIO_printf(rctx
->mem
, "%s ", rctx
->method_GET
? "GET" : "POST") <= 0)
156 if (server
!= NULL
) { /* HTTP (but not HTTPS) proxy is used */
158 * Section 5.1.2 of RFC 1945 states that the absoluteURI form is only
159 * allowed when using a proxy
161 if (BIO_printf(rctx
->mem
, OSSL_HTTP_PREFIX
"%s", server
) <= 0)
163 if (port
!= NULL
&& BIO_printf(rctx
->mem
, ":%s", port
) <= 0)
167 /* Make sure path includes a forward slash */
170 if (path
[0] != '/' && BIO_printf(rctx
->mem
, "/") <= 0)
173 if (BIO_printf(rctx
->mem
, "%s "HTTP_PREFIX
"1.0\r\n", path
) <= 0)
175 rctx
->state
= OHS_HTTP_HEADER
;
179 int OSSL_HTTP_REQ_CTX_add1_header(OSSL_HTTP_REQ_CTX
*rctx
,
180 const char *name
, const char *value
)
182 if (rctx
== NULL
|| name
== NULL
) {
183 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
187 if (BIO_puts(rctx
->mem
, name
) <= 0)
190 if (BIO_write(rctx
->mem
, ": ", 2) != 2)
192 if (BIO_puts(rctx
->mem
, value
) <= 0)
195 if (BIO_write(rctx
->mem
, "\r\n", 2) != 2)
197 rctx
->state
= OHS_HTTP_HEADER
;
201 static int OSSL_HTTP_REQ_CTX_content(OSSL_HTTP_REQ_CTX
*rctx
,
202 const char *content_type
, BIO
*req_mem
)
204 const unsigned char *req
;
207 if (rctx
== NULL
|| req_mem
== NULL
) {
208 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
211 if (rctx
->method_GET
) {
212 ERR_raise(ERR_LIB_HTTP
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
216 if (content_type
!= NULL
217 && BIO_printf(rctx
->mem
, "Content-Type: %s\r\n", content_type
) <= 0)
220 if ((req_len
= BIO_get_mem_data(req_mem
, &req
)) <= 0)
222 rctx
->state
= OHS_WRITE_INIT
;
224 return BIO_printf(rctx
->mem
, "Content-Length: %ld\r\n\r\n", req_len
) > 0
225 && BIO_write(rctx
->mem
, req
, req_len
) == (int)req_len
;
228 BIO
*HTTP_asn1_item2bio(const ASN1_ITEM
*it
, const ASN1_VALUE
*val
)
232 if (it
== NULL
|| val
== NULL
) {
233 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
237 if ((res
= BIO_new(BIO_s_mem())) == NULL
)
239 if (ASN1_item_i2d_bio(it
, res
, val
) <= 0) {
246 int OSSL_HTTP_REQ_CTX_i2d(OSSL_HTTP_REQ_CTX
*rctx
, const char *content_type
,
247 const ASN1_ITEM
*it
, ASN1_VALUE
*req
)
252 if (rctx
== NULL
|| it
== NULL
|| req
== NULL
) {
253 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
257 res
= (mem
= HTTP_asn1_item2bio(it
, req
)) != NULL
258 && OSSL_HTTP_REQ_CTX_content(rctx
, content_type
, mem
);
263 static int OSSL_HTTP_REQ_CTX_add1_headers(OSSL_HTTP_REQ_CTX
*rctx
,
264 const STACK_OF(CONF_VALUE
) *headers
,
271 for (i
= 0; i
< sk_CONF_VALUE_num(headers
); i
++) {
272 hdr
= sk_CONF_VALUE_value(headers
, i
);
273 if (add_host
&& strcasecmp("host", hdr
->name
) == 0)
275 if (!OSSL_HTTP_REQ_CTX_add1_header(rctx
, hdr
->name
, hdr
->value
))
279 if (add_host
&& !OSSL_HTTP_REQ_CTX_add1_header(rctx
, "Host", host
))
285 * Create OSSL_HTTP_REQ_CTX structure using the values provided.
286 * If !use_http_proxy then the 'server' and 'port' parameters are ignored.
287 * If req_mem == NULL then use GET and ignore content_type, else POST.
289 OSSL_HTTP_REQ_CTX
*HTTP_REQ_CTX_new(BIO
*wbio
, BIO
*rbio
, int use_http_proxy
,
290 const char *server
, const char *port
,
292 const STACK_OF(CONF_VALUE
) *headers
,
293 const char *content_type
, BIO
*req_mem
,
294 int maxline
, unsigned long max_resp_len
,
296 const char *expected_content_type
,
299 OSSL_HTTP_REQ_CTX
*rctx
;
301 if (use_http_proxy
&& (server
== NULL
|| port
== NULL
)) {
302 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
305 /* remaining parameters are checked indirectly by the functions called */
307 if ((rctx
= OSSL_HTTP_REQ_CTX_new(wbio
, rbio
, req_mem
== NULL
, maxline
,
308 max_resp_len
, timeout
,
309 expected_content_type
, expect_asn1
))
313 if (OSSL_HTTP_REQ_CTX_set_request_line(rctx
,
314 use_http_proxy
? server
: NULL
, port
,
316 && OSSL_HTTP_REQ_CTX_add1_headers(rctx
, headers
, server
)
318 || OSSL_HTTP_REQ_CTX_content(rctx
, content_type
, req_mem
)))
321 OSSL_HTTP_REQ_CTX_free(rctx
);
326 * Parse first HTTP response line. This should be like this: "HTTP/1.0 200 OK".
327 * We need to obtain the numeric code and (optional) informational message.
330 static int parse_http_line1(char *line
)
333 char *code
, *reason
, *end
;
335 /* Skip to first whitespace (past protocol info) */
336 for (code
= line
; *code
!= '\0' && !ossl_isspace(*code
); code
++)
339 ERR_raise(ERR_LIB_HTTP
, HTTP_R_RESPONSE_PARSE_ERROR
);
343 /* Skip past whitespace to start of response code */
344 while (*code
!= '\0' && ossl_isspace(*code
))
348 ERR_raise(ERR_LIB_HTTP
, HTTP_R_RESPONSE_PARSE_ERROR
);
352 /* Find end of response code: first whitespace after start of code */
353 for (reason
= code
; *reason
!= '\0' && !ossl_isspace(*reason
); reason
++)
356 if (*reason
== '\0') {
357 ERR_raise(ERR_LIB_HTTP
, HTTP_R_RESPONSE_PARSE_ERROR
);
361 /* Set end of response code and start of message */
364 /* Attempt to parse numeric code */
365 retcode
= strtoul(code
, &end
, 10);
370 /* Skip over any leading whitespace in message */
371 while (*reason
!= '\0' && ossl_isspace(*reason
))
374 if (*reason
!= '\0') {
376 * Finally zap any trailing whitespace in message (include CRLF)
379 /* chop any trailing whitespace from reason */
380 /* We know reason has a non-whitespace character so this is OK */
381 for (end
= reason
+ strlen(reason
) - 1; ossl_isspace(*end
); end
--)
386 case HTTP_STATUS_CODE_OK
:
387 case HTTP_STATUS_CODE_MOVED_PERMANENTLY
:
388 case HTTP_STATUS_CODE_FOUND
:
392 retcode
= HTTP_R_STATUS_CODE_UNSUPPORTED
;
394 retcode
= HTTP_R_RECEIVED_ERROR
;
396 ERR_raise_data(ERR_LIB_HTTP
, retcode
, "Code=%s", code
);
398 ERR_raise_data(ERR_LIB_HTTP
, retcode
,
399 "Code=%s, Reason=%s", code
, reason
);
404 static int check_set_resp_len(OSSL_HTTP_REQ_CTX
*rctx
, unsigned long len
)
406 if (len
> rctx
->max_resp_len
)
407 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_MAX_RESP_LEN_EXCEEDED
,
408 "length=%lu, max=%lu", len
, rctx
->max_resp_len
);
409 if (rctx
->resp_len
!= 0 && rctx
->resp_len
!= len
)
410 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_INCONSISTENT_CONTENT_LENGTH
,
411 "length=%lu, before=%lu", len
, rctx
->resp_len
);
412 rctx
->resp_len
= len
;
417 * Try exchanging request and response via HTTP on (non-)blocking BIO in rctx.
418 * Returns 1 on success, 0 on error or redirection, -1 on BIO_should_retry.
420 int OSSL_HTTP_REQ_CTX_nbio(OSSL_HTTP_REQ_CTX
*rctx
)
423 long n
, n_to_send
= 0;
424 unsigned long resp_len
;
425 const unsigned char *p
;
426 char *key
, *value
, *line_end
= NULL
;
429 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
433 rctx
->redirection_url
= NULL
;
435 if ((rctx
->state
& OHS_NOREAD
) == 0) {
436 n
= BIO_read(rctx
->rbio
, rctx
->iobuf
, rctx
->iobuflen
);
438 if (BIO_should_retry(rctx
->rbio
))
443 /* Write data to memory BIO */
444 if (BIO_write(rctx
->mem
, rctx
->iobuf
, n
) != n
)
448 switch (rctx
->state
) {
449 case OHS_HTTP_HEADER
:
450 /* Last operation was adding headers: need a final \r\n */
451 if (BIO_write(rctx
->mem
, "\r\n", 2) != 2) {
452 rctx
->state
= OHS_ERROR
;
455 rctx
->state
= OHS_WRITE_INIT
;
459 n_to_send
= BIO_get_mem_data(rctx
->mem
, NULL
);
460 rctx
->state
= OHS_WRITE
;
464 n
= BIO_get_mem_data(rctx
->mem
, &p
);
466 i
= BIO_write(rctx
->wbio
, p
+ (n
- n_to_send
), n_to_send
);
469 if (BIO_should_retry(rctx
->wbio
))
471 rctx
->state
= OHS_ERROR
;
480 rctx
->state
= OHS_FLUSH
;
482 (void)BIO_reset(rctx
->mem
);
487 i
= BIO_flush(rctx
->wbio
);
490 rctx
->state
= OHS_FIRSTLINE
;
494 if (BIO_should_retry(rctx
->wbio
))
497 rctx
->state
= OHS_ERROR
;
507 /* Attempt to read a line in */
510 * Due to strange memory BIO behavior with BIO_gets we have to check
511 * there's a complete line in there before calling BIO_gets or we'll
512 * just get a partial read.
514 n
= BIO_get_mem_data(rctx
->mem
, &p
);
515 if (n
<= 0 || memchr(p
, '\n', n
) == 0) {
516 if (n
>= rctx
->iobuflen
) {
517 rctx
->state
= OHS_ERROR
;
522 n
= BIO_gets(rctx
->mem
, (char *)rctx
->iobuf
, rctx
->iobuflen
);
525 if (BIO_should_retry(rctx
->mem
))
527 rctx
->state
= OHS_ERROR
;
531 /* Don't allow excessive lines */
532 if (n
== rctx
->iobuflen
) {
533 ERR_raise(ERR_LIB_HTTP
, HTTP_R_RESPONSE_LINE_TOO_LONG
);
534 rctx
->state
= OHS_ERROR
;
539 if (rctx
->state
== OHS_FIRSTLINE
) {
540 switch (parse_http_line1((char *)rctx
->iobuf
)) {
541 case HTTP_STATUS_CODE_OK
:
542 rctx
->state
= OHS_HEADERS
;
544 case HTTP_STATUS_CODE_MOVED_PERMANENTLY
:
545 case HTTP_STATUS_CODE_FOUND
: /* i.e., moved temporarily */
546 if (rctx
->method_GET
) {
547 rctx
->state
= OHS_REDIRECT
;
550 ERR_raise(ERR_LIB_HTTP
, HTTP_R_REDIRECTION_NOT_ENABLED
);
551 /* redirection is not supported/recommended for POST */
554 rctx
->state
= OHS_ERROR
;
558 key
= (char *)rctx
->iobuf
;
559 value
= strchr(key
, ':');
562 while (ossl_isspace(*value
))
564 line_end
= strchr(value
, '\r');
565 if (line_end
== NULL
)
566 line_end
= strchr(value
, '\n');
567 if (line_end
!= NULL
)
570 if (value
!= NULL
&& line_end
!= NULL
) {
571 if (rctx
->state
== OHS_REDIRECT
572 && strcasecmp(key
, "Location") == 0) {
573 rctx
->redirection_url
= value
;
576 if (rctx
->expected_ct
!= NULL
577 && strcasecmp(key
, "Content-Type") == 0) {
578 if (strcasecmp(rctx
->expected_ct
, value
) != 0) {
579 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_UNEXPECTED_CONTENT_TYPE
,
580 "expected=%s, actual=%s",
581 rctx
->expected_ct
, value
);
584 rctx
->expected_ct
= NULL
; /* content-type has been found */
586 if (strcasecmp(key
, "Content-Length") == 0) {
587 resp_len
= strtoul(value
, &line_end
, 10);
588 if (line_end
== value
|| *line_end
!= '\0') {
589 ERR_raise_data(ERR_LIB_HTTP
,
590 HTTP_R_ERROR_PARSING_CONTENT_LENGTH
,
594 if (!check_set_resp_len(rctx
, resp_len
))
599 /* Look for blank line: end of headers */
600 for (p
= rctx
->iobuf
; *p
!= '\0'; p
++) {
601 if (*p
!= '\r' && *p
!= '\n')
604 if (*p
!= '\0') /* not end of headers */
607 if (rctx
->expected_ct
!= NULL
) {
608 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_MISSING_CONTENT_TYPE
,
609 "expected=%s", rctx
->expected_ct
);
612 if (rctx
->state
== OHS_REDIRECT
) {
613 /* http status code indicated redirect but there was no Location */
614 ERR_raise(ERR_LIB_HTTP
, HTTP_R_MISSING_REDIRECT_LOCATION
);
618 if (!rctx
->expect_asn1
) {
619 rctx
->state
= OHS_CONTENT
;
623 rctx
->state
= OHS_ASN1_HEADER
;
626 case OHS_ASN1_HEADER
:
628 * Now reading ASN1 header: can read at least 2 bytes which is enough
629 * for ASN1 SEQUENCE header and either length field or at least the
630 * length of the length field.
632 n
= BIO_get_mem_data(rctx
->mem
, &p
);
636 /* Check it is an ASN1 SEQUENCE */
637 if (*p
++ != (V_ASN1_SEQUENCE
| V_ASN1_CONSTRUCTED
)) {
638 ERR_raise(ERR_LIB_HTTP
, HTTP_R_MISSING_ASN1_ENCODING
);
642 /* Check out length field */
643 if ((*p
& 0x80) != 0) {
645 * If MSB set on initial length octet we can now always read 6
646 * octets: make sure we have them.
651 /* Not NDEF or excessive length */
652 if (n
== 0 || (n
> 4)) {
653 ERR_raise(ERR_LIB_HTTP
, HTTP_R_ERROR_PARSING_ASN1_LENGTH
);
658 for (i
= 0; i
< n
; i
++) {
666 if (!check_set_resp_len(rctx
, resp_len
))
670 rctx
->state
= OHS_CONTENT
;
675 n
= BIO_get_mem_data(rctx
->mem
, NULL
);
676 if (n
< (long)rctx
->resp_len
/* may be 0 if no Content-Type or ASN.1 */)
679 rctx
->state
= OHS_DONE
;
684 #ifndef OPENSSL_NO_SOCK
686 /* set up a new connection BIO, to HTTP server or to HTTP(S) proxy if given */
687 static BIO
*HTTP_new_bio(const char *server
/* optionally includes ":port" */,
688 const char *server_port
/* explicit server port */,
689 const char *proxy
/* optionally includes ":port" */)
691 const char *host
= server
, *host_end
;
693 const char *port
= server_port
;
696 if (!ossl_assert(server
!= NULL
))
704 host_end
= strchr(host
, '/');
705 if (host_end
!= NULL
) {
706 size_t host_len
= host_end
- host
;
708 if (host_len
< sizeof(host_name
)) {
709 /* chop trailing string starting with '/' */
710 strncpy(host_name
, host
, host_len
);
711 host_name
[host_len
] = '\0';
716 cbio
= BIO_new_connect(host
/* optionally includes ":port" */);
720 (void)BIO_set_conn_port(cbio
, port
);
725 #endif /* OPENSSL_NO_SOCK */
727 static ASN1_VALUE
*BIO_mem_d2i(BIO
*mem
, const ASN1_ITEM
*it
)
729 const unsigned char *p
;
730 long len
= BIO_get_mem_data(mem
, &p
);
731 ASN1_VALUE
*resp
= ASN1_item_d2i(NULL
, &p
, len
, it
);
734 ERR_raise(ERR_LIB_HTTP
, HTTP_R_RESPONSE_PARSE_ERROR
);
738 static BIO
*OSSL_HTTP_REQ_CTX_transfer(OSSL_HTTP_REQ_CTX
*rctx
)
744 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
749 rv
= OSSL_HTTP_REQ_CTX_nbio(rctx
);
752 /* BIO_should_retry was true */
754 /* will not actually wait if rctx->max_time == 0 */
755 if (BIO_wait(rctx
->rbio
, rctx
->max_time
, 100 /* milliseconds */) <= 0)
760 if (rctx
->redirection_url
== NULL
) { /* an error occurred */
761 if (sending
&& (rctx
->state
& OHS_NOREAD
) != 0)
762 ERR_raise(ERR_LIB_HTTP
, HTTP_R_ERROR_SENDING
);
764 ERR_raise(ERR_LIB_HTTP
, HTTP_R_ERROR_RECEIVING
);
768 if (!BIO_up_ref(rctx
->mem
))
773 /* Exchange ASN.1-encoded request and response via HTTP on (non-)blocking BIO */
774 ASN1_VALUE
*OSSL_HTTP_REQ_CTX_sendreq_d2i(OSSL_HTTP_REQ_CTX
*rctx
,
777 if (rctx
== NULL
|| it
== NULL
) {
778 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
781 return BIO_mem_d2i(OSSL_HTTP_REQ_CTX_transfer(rctx
), it
);
784 static int update_timeout(int timeout
, time_t start_time
)
790 elapsed_time
= (long)(time(NULL
) - start_time
); /* this might overflow */
791 return timeout
<= elapsed_time
? -1 : timeout
- elapsed_time
;
795 * Exchange HTTP request and response with the given server.
796 * If req_mem == NULL then use GET and ignore content_type, else POST.
797 * The redirection_url output (freed by caller) parameter is used only for GET.
799 * Typically the bio and rbio parameters are NULL and a network BIO is created
800 * internally for connecting to the given server and port, optionally via a
801 * proxy and its port, and is then used for exchanging the request and response.
802 * If bio is given and rbio is NULL then this BIO is used instead.
803 * If both bio and rbio are given (which may be memory BIOs for instance)
804 * then no explicit connection is attempted,
805 * bio is used for writing the request, and rbio for reading the response.
807 * bio_update_fn is an optional BIO connect/disconnect callback function,
808 * which has the prototype
809 * BIO *(*OSSL_HTTP_bio_cb_t) (BIO *bio, void *arg, int conn, int detail);
810 * The callback may modify the HTTP BIO provided in the bio argument,
811 * whereby it may make use of any custom defined argument 'arg'.
812 * During connection establishment, just after BIO_do_connect_retry(),
813 * the callback function is invoked with the 'conn' argument being 1
814 * 'detail' indicating whether a HTTPS (i.e., TLS) connection is requested.
815 * On disconnect 'conn' is 0 and 'detail' indicates that no error occurred.
816 * For instance, on connect the funct may prepend a TLS BIO to implement HTTPS;
817 * after disconnect it may do some error diagnostics and/or specific cleanup.
818 * The function should return NULL to indicate failure.
819 * After disconnect the modified BIO will be deallocated using BIO_free_all().
821 BIO
*OSSL_HTTP_transfer(const char *server
, const char *port
, const char *path
,
822 int use_ssl
, const char *proxy
, const char *no_proxy
,
824 OSSL_HTTP_bio_cb_t bio_update_fn
, void *arg
,
825 const STACK_OF(CONF_VALUE
) *headers
,
826 const char *content_type
, BIO
*req_mem
,
827 int maxline
, unsigned long max_resp_len
, int timeout
,
828 const char *expected_ct
, int expect_asn1
,
829 char **redirection_url
)
831 time_t start_time
= timeout
> 0 ? time(NULL
) : 0;
832 BIO
*cbio
; /* = bio if present, used as connection BIO if rbio is NULL */
833 OSSL_HTTP_REQ_CTX
*rctx
;
836 if (redirection_url
!= NULL
)
837 *redirection_url
= NULL
; /* do this beforehand to prevent dbl free */
839 if (use_ssl
&& bio_update_fn
== NULL
) {
840 ERR_raise(ERR_LIB_HTTP
, HTTP_R_TLS_NOT_ENABLED
);
843 if (rbio
!= NULL
&& (bio
== NULL
|| bio_update_fn
!= NULL
)) {
844 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_INVALID_ARGUMENT
);
851 #ifndef OPENSSL_NO_SOCK
852 if (server
== NULL
) {
853 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
858 if (port
== NULL
&& strchr(server
, ':') == NULL
)
859 port
= use_ssl
? OSSL_HTTPS_PORT
: OSSL_HTTP_PORT
;
860 proxy
= http_adapt_proxy(proxy
, no_proxy
, server
, use_ssl
);
861 if ((cbio
= HTTP_new_bio(server
, port
, proxy
)) == NULL
)
864 ERR_raise(ERR_LIB_HTTP
, HTTP_R_SOCK_NOT_SUPPORTED
);
868 /* remaining parameters are checked indirectly by the functions called */
870 (void)ERR_set_mark(); /* prepare removing any spurious libssl errors */
871 if (rbio
== NULL
&& BIO_do_connect_retry(cbio
, timeout
, -1) <= 0)
873 /* now timeout is guaranteed to be >= 0 */
875 /* callback can be used to wrap or prepend TLS session */
876 if (bio_update_fn
!= NULL
) {
877 BIO
*orig_bio
= cbio
;
878 cbio
= (*bio_update_fn
)(cbio
, arg
, 1 /* connect */, use_ssl
);
885 rctx
= HTTP_REQ_CTX_new(cbio
, rbio
!= NULL
? rbio
: cbio
,
886 !use_ssl
&& proxy
!= NULL
, server
, port
, path
,
887 headers
, content_type
, req_mem
, maxline
,
888 max_resp_len
, update_timeout(timeout
, start_time
),
889 expected_ct
, expect_asn1
);
893 resp
= OSSL_HTTP_REQ_CTX_transfer(rctx
);
895 if (rctx
->redirection_url
!= NULL
) {
896 if (redirection_url
== NULL
)
897 ERR_raise(ERR_LIB_HTTP
, HTTP_R_REDIRECTION_NOT_ENABLED
);
899 /* may be NULL if out of memory: */
900 *redirection_url
= OPENSSL_strdup(rctx
->redirection_url
);
903 unsigned long err
= ERR_peek_error();
904 int lib
= ERR_GET_LIB(err
);
905 int reason
= ERR_GET_REASON(err
);
907 if (lib
== ERR_LIB_SSL
|| lib
== ERR_LIB_HTTP
908 || (lib
== ERR_LIB_BIO
&& reason
== BIO_R_CONNECT_TIMEOUT
)
909 || (lib
== ERR_LIB_BIO
&& reason
== BIO_R_CONNECT_ERROR
)
910 #ifndef OPENSSL_NO_CMP
911 || (lib
== ERR_LIB_CMP
912 && reason
== CMP_R_POTENTIALLY_INVALID_CERTIFICATE
)
915 BIO_snprintf(buf
, 200, "server=%s:%s", server
, port
);
916 ERR_add_error_data(1, buf
);
918 ERR_add_error_data(2, " proxy=", proxy
);
920 BIO_snprintf(buf
, 200, " peer has disconnected%s",
921 use_ssl
? " violating the protocol" :
922 ", likely because it requires the use of TLS");
923 ERR_add_error_data(1, buf
);
928 OSSL_HTTP_REQ_CTX_free(rctx
);
930 /* callback can be used to clean up TLS session */
931 if (bio_update_fn
!= NULL
932 && (*bio_update_fn
)(cbio
, arg
, 0, resp
!= NULL
) == NULL
) {
939 * Use BIO_free_all() because bio_update_fn may prepend or append to cbio.
940 * This also frees any (e.g., SSL/TLS) BIOs linked with bio and,
941 * like BIO_reset(bio), calls SSL_shutdown() to notify/alert the peer.
943 if (bio
== NULL
) /* cbio was not provided by caller */
947 /* remove any spurious error queue entries by ssl_add_cert_chain() */
948 (void)ERR_pop_to_mark();
950 (void)ERR_clear_last_mark();
955 static int redirection_ok(int n_redir
, const char *old_url
, const char *new_url
)
957 size_t https_len
= strlen(OSSL_HTTPS_NAME
":");
959 if (n_redir
>= HTTP_VERSION_MAX_REDIRECTIONS
) {
960 ERR_raise(ERR_LIB_HTTP
, HTTP_R_TOO_MANY_REDIRECTIONS
);
963 if (*new_url
== '/') /* redirection to same server => same protocol */
965 if (strncmp(old_url
, OSSL_HTTPS_NAME
":", https_len
) == 0 &&
966 strncmp(new_url
, OSSL_HTTPS_NAME
":", https_len
) != 0) {
967 ERR_raise(ERR_LIB_HTTP
, HTTP_R_REDIRECTION_FROM_HTTPS_TO_HTTP
);
973 /* Get data via HTTP from server at given URL, potentially with redirection */
974 BIO
*OSSL_HTTP_get(const char *url
, const char *proxy
, const char *no_proxy
,
976 OSSL_HTTP_bio_cb_t bio_update_fn
, void *arg
,
977 const STACK_OF(CONF_VALUE
) *headers
,
978 int maxline
, unsigned long max_resp_len
, int timeout
,
979 const char *expected_content_type
, int expect_asn1
)
981 time_t start_time
= timeout
> 0 ? time(NULL
) : 0;
982 char *current_url
, *redirection_url
;
991 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
994 if ((current_url
= OPENSSL_strdup(url
)) == NULL
)
998 if (!OSSL_HTTP_parse_url(current_url
, &host
, &port
, NULL
/* port_num */,
1003 resp
= OSSL_HTTP_transfer(host
, port
, path
, use_ssl
, proxy
, no_proxy
,
1005 bio_update_fn
, arg
, headers
, NULL
, NULL
,
1006 maxline
, max_resp_len
,
1007 update_timeout(timeout
, start_time
),
1008 expected_content_type
, expect_asn1
,
1011 if (resp
== NULL
&& redirection_url
!= NULL
) {
1012 if (redirection_ok(++n_redirs
, current_url
, redirection_url
)) {
1013 (void)BIO_reset(bio
);
1014 OPENSSL_free(current_url
);
1015 current_url
= redirection_url
;
1016 if (*redirection_url
== '/') { /* redirection to same server */
1017 path
= OPENSSL_strdup(redirection_url
);
1024 OPENSSL_free(redirection_url
);
1030 OPENSSL_free(current_url
);
1034 /* Get ASN.1-encoded data via HTTP from server at given URL */
1035 ASN1_VALUE
*OSSL_HTTP_get_asn1(const char *url
,
1036 const char *proxy
, const char *no_proxy
,
1037 BIO
*bio
, BIO
*rbio
,
1038 OSSL_HTTP_bio_cb_t bio_update_fn
, void *arg
,
1039 const STACK_OF(CONF_VALUE
) *headers
,
1040 int maxline
, unsigned long max_resp_len
,
1041 int timeout
, const char *expected_content_type
,
1042 const ASN1_ITEM
*it
)
1045 ASN1_VALUE
*resp
= NULL
;
1047 if (url
== NULL
|| it
== NULL
) {
1048 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
1051 if ((mem
= OSSL_HTTP_get(url
, proxy
, no_proxy
, bio
, rbio
, bio_update_fn
,
1052 arg
, headers
, maxline
, max_resp_len
, timeout
,
1053 expected_content_type
, 1 /* expect_asn1 */))
1055 resp
= BIO_mem_d2i(mem
, it
);
1060 /* Post ASN.1-encoded request via HTTP to server return ASN.1 response */
1061 ASN1_VALUE
*OSSL_HTTP_post_asn1(const char *server
, const char *port
,
1062 const char *path
, int use_ssl
,
1063 const char *proxy
, const char *no_proxy
,
1064 BIO
*bio
, BIO
*rbio
,
1065 OSSL_HTTP_bio_cb_t bio_update_fn
, void *arg
,
1066 const STACK_OF(CONF_VALUE
) *headers
,
1067 const char *content_type
,
1068 const ASN1_VALUE
*req
, const ASN1_ITEM
*req_it
,
1069 int maxline
, unsigned long max_resp_len
,
1070 int timeout
, const char *expected_ct
,
1071 const ASN1_ITEM
*rsp_it
)
1075 ASN1_VALUE
*resp
= NULL
;
1078 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
1081 /* remaining parameters are checked indirectly */
1083 req_mem
= HTTP_asn1_item2bio(req_it
, req
);
1084 res_mem
= OSSL_HTTP_transfer(server
, port
, path
, use_ssl
, proxy
, no_proxy
,
1086 bio_update_fn
, arg
, headers
, content_type
,
1087 req_mem
/* may be NULL */, maxline
,
1088 max_resp_len
, timeout
,
1089 expected_ct
, 1 /* expect_asn1 */, NULL
);
1091 if (res_mem
!= NULL
)
1092 resp
= BIO_mem_d2i(res_mem
, rsp_it
);
1097 /* BASE64 encoder used for encoding basic proxy authentication credentials */
1098 static char *base64encode(const void *buf
, size_t len
)
1104 /* Calculate size of encoded data */
1109 out
= OPENSSL_malloc(outl
+ 1);
1113 i
= EVP_EncodeBlock((unsigned char *)out
, buf
, len
);
1114 if (!ossl_assert(0 <= i
&& (size_t)i
<= outl
)) {
1122 * Promote the given connection BIO using the CONNECT method for a TLS proxy.
1123 * This is typically called by an app, so bio_err and prog are used unless NULL
1124 * to print additional diagnostic information in a user-oriented way.
1126 int OSSL_HTTP_proxy_connect(BIO
*bio
, const char *server
, const char *port
,
1127 const char *proxyuser
, const char *proxypass
,
1128 int timeout
, BIO
*bio_err
, const char *prog
)
1131 #define BUF_SIZE (8 * 1024)
1132 char *mbuf
= OPENSSL_malloc(BUF_SIZE
);
1136 BIO
*fbio
= BIO_new(BIO_f_buffer());
1138 time_t max_time
= timeout
> 0 ? time(NULL
) + timeout
: 0;
1140 if (bio
== NULL
|| server
== NULL
1141 || (bio_err
!= NULL
&& prog
== NULL
)) {
1142 ERR_raise(ERR_LIB_HTTP
, ERR_R_PASSED_NULL_PARAMETER
);
1145 if (port
== NULL
|| *port
== '\0')
1146 port
= OSSL_HTTPS_PORT
;
1148 if (mbuf
== NULL
|| fbio
== NULL
) {
1149 BIO_printf(bio_err
/* may be NULL */, "%s: out of memory", prog
);
1152 BIO_push(fbio
, bio
);
1154 BIO_printf(fbio
, "CONNECT %s:%s "HTTP_PREFIX
"1.0\r\n", server
, port
);
1157 * Workaround for broken proxies which would otherwise close
1158 * the connection when entering tunnel mode (e.g., Squid 2.6)
1160 BIO_printf(fbio
, "Proxy-Connection: Keep-Alive\r\n");
1162 /* Support for basic (base64) proxy authentication */
1163 if (proxyuser
!= NULL
) {
1164 size_t len
= strlen(proxyuser
) + 1;
1165 char *proxyauth
, *proxyauthenc
= NULL
;
1167 if (proxypass
!= NULL
)
1168 len
+= strlen(proxypass
);
1169 proxyauth
= OPENSSL_malloc(len
+ 1);
1170 if (proxyauth
== NULL
)
1172 if (BIO_snprintf(proxyauth
, len
+ 1, "%s:%s", proxyuser
,
1173 proxypass
!= NULL
? proxypass
: "") != (int)len
)
1175 proxyauthenc
= base64encode(proxyauth
, len
);
1176 if (proxyauthenc
!= NULL
) {
1177 BIO_printf(fbio
, "Proxy-Authorization: Basic %s\r\n", proxyauthenc
);
1178 OPENSSL_clear_free(proxyauthenc
, strlen(proxyauthenc
));
1181 OPENSSL_clear_free(proxyauth
, len
);
1182 if (proxyauthenc
== NULL
)
1186 /* Terminate the HTTP CONNECT request */
1187 BIO_printf(fbio
, "\r\n");
1190 if (BIO_flush(fbio
) != 0)
1192 /* potentially needs to be retried if BIO is non-blocking */
1193 if (!BIO_should_retry(fbio
))
1198 /* will not actually wait if timeout == 0 */
1199 rv
= BIO_wait(fbio
, max_time
, 100 /* milliseconds */);
1201 BIO_printf(bio_err
, "%s: HTTP CONNECT %s\n", prog
,
1202 rv
== 0 ? "timed out" : "failed waiting for data");
1207 * The first line is the HTTP response.
1208 * According to RFC 7230, it is formatted exactly like this:
1209 * HTTP/d.d ddd Reason text\r\n
1211 read_len
= BIO_gets(fbio
, mbuf
, BUF_SIZE
);
1212 /* the BIO may not block, so we must wait for the 1st line to come in */
1213 if (read_len
< HTTP_LINE1_MINLEN
)
1216 /* RFC 7231 4.3.6: any 2xx status code is valid */
1217 if (strncmp(mbuf
, HTTP_PREFIX
, strlen(HTTP_PREFIX
)) != 0) {
1218 ERR_raise(ERR_LIB_HTTP
, HTTP_R_RESPONSE_PARSE_ERROR
);
1219 BIO_printf(bio_err
, "%s: HTTP CONNECT failed, non-HTTP response\n",
1221 /* Wrong protocol, not even HTTP, so stop reading headers */
1224 mbufp
= mbuf
+ strlen(HTTP_PREFIX
);
1225 if (strncmp(mbufp
, HTTP_VERSION_PATT
, strlen(HTTP_VERSION_PATT
)) != 0) {
1226 ERR_raise(ERR_LIB_HTTP
, HTTP_R_RECEIVED_WRONG_HTTP_VERSION
);
1228 "%s: HTTP CONNECT failed, bad HTTP version %.*s\n",
1229 prog
, HTTP_VERSION_STR_LEN
, mbufp
);
1232 mbufp
+= HTTP_VERSION_STR_LEN
;
1233 if (strncmp(mbufp
, " 2", strlen(" 2")) != 0) {
1235 /* chop any trailing whitespace */
1236 while (read_len
> 0 && ossl_isspace(mbuf
[read_len
- 1]))
1238 mbuf
[read_len
] = '\0';
1239 ERR_raise_data(ERR_LIB_HTTP
, HTTP_R_CONNECT_FAILURE
,
1240 "Reason=%s", mbufp
);
1241 BIO_printf(bio_err
, "%s: HTTP CONNECT failed, Reason=%s\n",
1249 /* Read past all following headers */
1252 * TODO: This does not necessarily catch the case when the full
1253 * HTTP response came in in more than a single TCP message.
1255 read_len
= BIO_gets(fbio
, mbuf
, BUF_SIZE
);
1256 } while (read_len
> 2);
1260 (void)BIO_flush(fbio
);