xref: /openssl/crypto/http/http_client.c (revision 52f61699)
1 /*
2  * Copyright 2001-2022 The OpenSSL Project Authors. All Rights Reserved.
3  * Copyright Siemens AG 2018-2020
4  *
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
9  */
10 
11 #include "internal/e_os.h"
12 #include <stdio.h>
13 #include <stdlib.h>
14 #include "crypto/ctype.h"
15 #include <string.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 <openssl/trace.h>
24 #include "internal/sockets.h"
25 #include "internal/common.h" /* for ossl_assert() */
26 
27 #define HTTP_PREFIX "HTTP/"
28 #define HTTP_VERSION_PATT "1." /* allow 1.x */
29 #define HTTP_VERSION_STR_LEN sizeof(HTTP_VERSION_PATT) /* == strlen("1.0") */
30 #define HTTP_PREFIX_VERSION HTTP_PREFIX""HTTP_VERSION_PATT
31 #define HTTP_1_0 HTTP_PREFIX_VERSION"0" /* "HTTP/1.0" */
32 #define HTTP_LINE1_MINLEN (sizeof(HTTP_PREFIX_VERSION "x 200\n") - 1)
33 #define HTTP_VERSION_MAX_REDIRECTIONS 50
34 
35 #define HTTP_STATUS_CODE_OK                200
36 #define HTTP_STATUS_CODE_MOVED_PERMANENTLY 301
37 #define HTTP_STATUS_CODE_FOUND             302
38 
39 /* Stateful HTTP request code, supporting blocking and non-blocking I/O */
40 
41 /* Opaque HTTP request status structure */
42 
43 struct ossl_http_req_ctx_st {
44     int state;                  /* Current I/O state */
45     unsigned char *buf;         /* Buffer to write request or read response */
46     int buf_size;               /* Buffer size */
47     int free_wbio;              /* wbio allocated internally, free with ctx */
48     BIO *wbio;                  /* BIO to write/send request to */
49     BIO *rbio;                  /* BIO to read/receive response from */
50     OSSL_HTTP_bio_cb_t upd_fn;  /* Optional BIO update callback used for TLS */
51     void *upd_arg;              /* Optional arg for update callback function */
52     int use_ssl;                /* Use HTTPS */
53     char *proxy;                /* Optional proxy name or URI */
54     char *server;               /* Optional server host name */
55     char *port;                 /* Optional server port */
56     BIO *mem;                   /* Mem BIO holding request header or response */
57     BIO *req;                   /* BIO holding the request provided by caller */
58     int method_POST;            /* HTTP method is POST (else GET) */
59     char *expected_ct;          /* Optional expected Content-Type */
60     int expect_asn1;            /* Response must be ASN.1-encoded */
61     unsigned char *pos;         /* Current position sending data */
62     long len_to_send;           /* Number of bytes still to send */
63     size_t resp_len;            /* Length of response */
64     size_t max_resp_len;        /* Maximum length of response, or 0 */
65     int keep_alive;             /* Persistent conn. 0=no, 1=prefer, 2=require */
66     time_t max_time;            /* Maximum end time of current transfer, or 0 */
67     time_t max_total_time;      /* Maximum end time of total transfer, or 0 */
68     char *redirection_url;      /* Location obtained from HTTP status 301/302 */
69 };
70 
71 /* HTTP states */
72 
73 #define OHS_NOREAD         0x1000 /* If set no reading should be performed */
74 #define OHS_ERROR          (0 | OHS_NOREAD) /* Error condition */
75 #define OHS_ADD_HEADERS    (1 | OHS_NOREAD) /* Adding header lines to request */
76 #define OHS_WRITE_INIT     (2 | OHS_NOREAD) /* 1st call: ready to start send */
77 #define OHS_WRITE_HDR      (3 | OHS_NOREAD) /* Request header being sent */
78 #define OHS_WRITE_REQ      (4 | OHS_NOREAD) /* Request contents being sent */
79 #define OHS_FLUSH          (5 | OHS_NOREAD) /* Request being flushed */
80 #define OHS_FIRSTLINE       1 /* First line of response being read */
81 #define OHS_HEADERS         2 /* MIME headers of response being read */
82 #define OHS_REDIRECT        3 /* MIME headers being read, expecting Location */
83 #define OHS_ASN1_HEADER     4 /* ASN1 sequence header (tag+length) being read */
84 #define OHS_ASN1_CONTENT    5 /* ASN1 content octets being read */
85 #define OHS_ASN1_DONE      (6 | OHS_NOREAD) /* ASN1 content read completed */
86 #define OHS_STREAM         (7 | OHS_NOREAD) /* HTTP content stream to be read */
87 
88 /* Low-level HTTP API implementation */
89 
OSSL_HTTP_REQ_CTX_new(BIO * wbio,BIO * rbio,int buf_size)90 OSSL_HTTP_REQ_CTX *OSSL_HTTP_REQ_CTX_new(BIO *wbio, BIO *rbio, int buf_size)
91 {
92     OSSL_HTTP_REQ_CTX *rctx;
93 
94     if (wbio == NULL || rbio == NULL) {
95         ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
96         return NULL;
97     }
98 
99     if ((rctx = OPENSSL_zalloc(sizeof(*rctx))) == NULL)
100         return NULL;
101     rctx->state = OHS_ERROR;
102     rctx->buf_size = buf_size > 0 ? buf_size : OSSL_HTTP_DEFAULT_MAX_LINE_LEN;
103     rctx->buf = OPENSSL_malloc(rctx->buf_size);
104     rctx->wbio = wbio;
105     rctx->rbio = rbio;
106     if (rctx->buf == NULL) {
107         OPENSSL_free(rctx);
108         return NULL;
109     }
110     rctx->max_resp_len = OSSL_HTTP_DEFAULT_MAX_RESP_LEN;
111     /* everything else is 0, e.g. rctx->len_to_send, or NULL, e.g. rctx->mem  */
112     return rctx;
113 }
114 
OSSL_HTTP_REQ_CTX_free(OSSL_HTTP_REQ_CTX * rctx)115 void OSSL_HTTP_REQ_CTX_free(OSSL_HTTP_REQ_CTX *rctx)
116 {
117     if (rctx == NULL)
118         return;
119     /*
120      * Use BIO_free_all() because bio_update_fn may prepend or append to cbio.
121      * This also frees any (e.g., SSL/TLS) BIOs linked with bio and,
122      * like BIO_reset(bio), calls SSL_shutdown() to notify/alert the peer.
123      */
124     if (rctx->free_wbio)
125         BIO_free_all(rctx->wbio);
126     /* do not free rctx->rbio */
127     BIO_free(rctx->mem);
128     BIO_free(rctx->req);
129     OPENSSL_free(rctx->buf);
130     OPENSSL_free(rctx->proxy);
131     OPENSSL_free(rctx->server);
132     OPENSSL_free(rctx->port);
133     OPENSSL_free(rctx->expected_ct);
134     OPENSSL_free(rctx);
135 }
136 
OSSL_HTTP_REQ_CTX_get0_mem_bio(const OSSL_HTTP_REQ_CTX * rctx)137 BIO *OSSL_HTTP_REQ_CTX_get0_mem_bio(const OSSL_HTTP_REQ_CTX *rctx)
138 {
139     if (rctx == NULL) {
140         ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
141         return NULL;
142     }
143     return rctx->mem;
144 }
145 
OSSL_HTTP_REQ_CTX_get_resp_len(const OSSL_HTTP_REQ_CTX * rctx)146 size_t OSSL_HTTP_REQ_CTX_get_resp_len(const OSSL_HTTP_REQ_CTX *rctx)
147 {
148     if (rctx == NULL) {
149         ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
150         return 0;
151     }
152     return rctx->resp_len;
153 }
154 
OSSL_HTTP_REQ_CTX_set_max_response_length(OSSL_HTTP_REQ_CTX * rctx,unsigned long len)155 void OSSL_HTTP_REQ_CTX_set_max_response_length(OSSL_HTTP_REQ_CTX *rctx,
156                                                unsigned long len)
157 {
158     if (rctx == NULL) {
159         ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
160         return;
161     }
162     rctx->max_resp_len = len != 0 ? (size_t)len : OSSL_HTTP_DEFAULT_MAX_RESP_LEN;
163 }
164 
165 /*
166  * Create request line using |rctx| and |path| (or "/" in case |path| is NULL).
167  * Server name (and port) must be given if and only if plain HTTP proxy is used.
168  */
OSSL_HTTP_REQ_CTX_set_request_line(OSSL_HTTP_REQ_CTX * rctx,int method_POST,const char * server,const char * port,const char * path)169 int OSSL_HTTP_REQ_CTX_set_request_line(OSSL_HTTP_REQ_CTX *rctx, int method_POST,
170                                        const char *server, const char *port,
171                                        const char *path)
172 {
173     if (rctx == NULL) {
174         ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
175         return 0;
176     }
177     BIO_free(rctx->mem);
178     if ((rctx->mem = BIO_new(BIO_s_mem())) == NULL)
179         return 0;
180 
181     rctx->method_POST = method_POST != 0;
182     if (BIO_printf(rctx->mem, "%s ", rctx->method_POST ? "POST" : "GET") <= 0)
183         return 0;
184 
185     if (server != NULL) { /* HTTP (but not HTTPS) proxy is used */
186         /*
187          * Section 5.1.2 of RFC 1945 states that the absoluteURI form is only
188          * allowed when using a proxy
189          */
190         if (BIO_printf(rctx->mem, OSSL_HTTP_PREFIX"%s", server) <= 0)
191             return 0;
192         if (port != NULL && BIO_printf(rctx->mem, ":%s", port) <= 0)
193             return 0;
194     }
195 
196     /* Make sure path includes a forward slash */
197     if (path == NULL)
198         path = "/";
199     if (path[0] != '/' && BIO_printf(rctx->mem, "/") <= 0)
200         return 0;
201     /*
202      * Add (the rest of) the path and the HTTP version,
203      * which is fixed to 1.0 for straightforward implementation of keep-alive
204      */
205     if (BIO_printf(rctx->mem, "%s "HTTP_1_0"\r\n", path) <= 0)
206         return 0;
207 
208     rctx->resp_len = 0;
209     rctx->state = OHS_ADD_HEADERS;
210     return 1;
211 }
212 
OSSL_HTTP_REQ_CTX_add1_header(OSSL_HTTP_REQ_CTX * rctx,const char * name,const char * value)213 int OSSL_HTTP_REQ_CTX_add1_header(OSSL_HTTP_REQ_CTX *rctx,
214                                   const char *name, const char *value)
215 {
216     if (rctx == NULL || name == NULL) {
217         ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
218         return 0;
219     }
220     if (rctx->mem == NULL) {
221         ERR_raise(ERR_LIB_HTTP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
222         return 0;
223     }
224 
225     if (BIO_puts(rctx->mem, name) <= 0)
226         return 0;
227     if (value != NULL) {
228         if (BIO_write(rctx->mem, ": ", 2) != 2)
229             return 0;
230         if (BIO_puts(rctx->mem, value) <= 0)
231             return 0;
232     }
233     return BIO_write(rctx->mem, "\r\n", 2) == 2;
234 }
235 
OSSL_HTTP_REQ_CTX_set_expected(OSSL_HTTP_REQ_CTX * rctx,const char * content_type,int asn1,int timeout,int keep_alive)236 int OSSL_HTTP_REQ_CTX_set_expected(OSSL_HTTP_REQ_CTX *rctx,
237                                    const char *content_type, int asn1,
238                                    int timeout, int keep_alive)
239 {
240     if (rctx == NULL) {
241         ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
242         return 0;
243     }
244     if (keep_alive != 0
245             && rctx->state != OHS_ERROR && rctx->state != OHS_ADD_HEADERS) {
246         /* Cannot anymore set keep-alive in request header */
247         ERR_raise(ERR_LIB_HTTP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
248         return 0;
249     }
250 
251     OPENSSL_free(rctx->expected_ct);
252     rctx->expected_ct = NULL;
253     if (content_type != NULL
254             && (rctx->expected_ct = OPENSSL_strdup(content_type)) == NULL)
255         return 0;
256 
257     rctx->expect_asn1 = asn1;
258     if (timeout >= 0)
259         rctx->max_time = timeout > 0 ? time(NULL) + timeout : 0;
260     else /* take over any |overall_timeout| arg of OSSL_HTTP_open(), else 0 */
261         rctx->max_time = rctx->max_total_time;
262     rctx->keep_alive = keep_alive;
263     return 1;
264 }
265 
set1_content(OSSL_HTTP_REQ_CTX * rctx,const char * content_type,BIO * req)266 static int set1_content(OSSL_HTTP_REQ_CTX *rctx,
267                         const char *content_type, BIO *req)
268 {
269     long req_len = 0;
270 #ifndef OPENSSL_NO_STDIO
271     FILE *fp = NULL;
272 #endif
273 
274     if (rctx == NULL || (req == NULL && content_type != NULL)) {
275         ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
276         return 0;
277     }
278 
279     if (rctx->keep_alive != 0
280             && !OSSL_HTTP_REQ_CTX_add1_header(rctx, "Connection", "keep-alive"))
281         return 0;
282 
283     BIO_free(rctx->req);
284     rctx->req = NULL;
285     if (req == NULL)
286         return 1;
287     if (!rctx->method_POST) {
288         ERR_raise(ERR_LIB_HTTP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
289         return 0;
290     }
291 
292     if (content_type != NULL
293             && BIO_printf(rctx->mem, "Content-Type: %s\r\n", content_type) <= 0)
294         return 0;
295 
296     /*
297      * BIO_CTRL_INFO yields the data length at least for memory BIOs, but for
298      * file-based BIOs it gives the current position, which is not what we need.
299      */
300     if (BIO_method_type(req) == BIO_TYPE_FILE) {
301 #ifndef OPENSSL_NO_STDIO
302         if (BIO_get_fp(req, &fp) == 1 && fseek(fp, 0, SEEK_END) == 0) {
303             req_len = ftell(fp);
304             (void)fseek(fp, 0, SEEK_SET);
305         } else {
306             fp = NULL;
307         }
308 #endif
309     } else {
310         req_len = BIO_ctrl(req, BIO_CTRL_INFO, 0, NULL);
311         /*
312          * Streaming BIOs likely will not support querying the size at all,
313          * and we assume we got a correct value if req_len > 0.
314          */
315     }
316     if ((
317 #ifndef OPENSSL_NO_STDIO
318          fp != NULL /* definitely correct req_len */ ||
319 #endif
320          req_len > 0)
321             && BIO_printf(rctx->mem, "Content-Length: %ld\r\n", req_len) < 0)
322         return 0;
323 
324     if (!BIO_up_ref(req))
325         return 0;
326     rctx->req = req;
327     return 1;
328 }
329 
OSSL_HTTP_REQ_CTX_set1_req(OSSL_HTTP_REQ_CTX * rctx,const char * content_type,const ASN1_ITEM * it,const ASN1_VALUE * req)330 int OSSL_HTTP_REQ_CTX_set1_req(OSSL_HTTP_REQ_CTX *rctx, const char *content_type,
331                                const ASN1_ITEM *it, const ASN1_VALUE *req)
332 {
333     BIO *mem = NULL;
334     int res = 1;
335 
336     if (req != NULL)
337         res = (mem = ASN1_item_i2d_mem_bio(it, req)) != NULL;
338     res = res && set1_content(rctx, content_type, mem);
339     BIO_free(mem);
340     return res;
341 }
342 
add1_headers(OSSL_HTTP_REQ_CTX * rctx,const STACK_OF (CONF_VALUE)* headers,const char * host)343 static int add1_headers(OSSL_HTTP_REQ_CTX *rctx,
344                         const STACK_OF(CONF_VALUE) *headers, const char *host)
345 {
346     int i;
347     int add_host = host != NULL && *host != '\0';
348     CONF_VALUE *hdr;
349 
350     for (i = 0; i < sk_CONF_VALUE_num(headers); i++) {
351         hdr = sk_CONF_VALUE_value(headers, i);
352         if (add_host && OPENSSL_strcasecmp("host", hdr->name) == 0)
353             add_host = 0;
354         if (!OSSL_HTTP_REQ_CTX_add1_header(rctx, hdr->name, hdr->value))
355             return 0;
356     }
357 
358     if (add_host && !OSSL_HTTP_REQ_CTX_add1_header(rctx, "Host", host))
359         return 0;
360     return 1;
361 }
362 
363 /* Create OSSL_HTTP_REQ_CTX structure using the values provided. */
http_req_ctx_new(int free_wbio,BIO * wbio,BIO * rbio,OSSL_HTTP_bio_cb_t bio_update_fn,void * arg,int use_ssl,const char * proxy,const char * server,const char * port,int buf_size,int overall_timeout)364 static OSSL_HTTP_REQ_CTX *http_req_ctx_new(int free_wbio, BIO *wbio, BIO *rbio,
365                                            OSSL_HTTP_bio_cb_t bio_update_fn,
366                                            void *arg, int use_ssl,
367                                            const char *proxy,
368                                            const char *server, const char *port,
369                                            int buf_size, int overall_timeout)
370 {
371     OSSL_HTTP_REQ_CTX *rctx = OSSL_HTTP_REQ_CTX_new(wbio, rbio, buf_size);
372 
373     if (rctx == NULL)
374         return NULL;
375     rctx->free_wbio = free_wbio;
376     rctx->upd_fn = bio_update_fn;
377     rctx->upd_arg = arg;
378     rctx->use_ssl = use_ssl;
379     if (proxy != NULL
380             && (rctx->proxy = OPENSSL_strdup(proxy)) == NULL)
381         goto err;
382     if (server != NULL
383             && (rctx->server = OPENSSL_strdup(server)) == NULL)
384         goto err;
385     if (port != NULL
386             && (rctx->port = OPENSSL_strdup(port)) == NULL)
387         goto err;
388     rctx->max_total_time =
389         overall_timeout > 0 ? time(NULL) + overall_timeout : 0;
390     return rctx;
391 
392  err:
393     OSSL_HTTP_REQ_CTX_free(rctx);
394     return NULL;
395 }
396 
397 /*
398  * Parse first HTTP response line. This should be like this: "HTTP/1.0 200 OK".
399  * We need to obtain the status code and (optional) informational message.
400  * Return any received HTTP response status code, or 0 on fatal error.
401  */
402 
parse_http_line1(char * line,int * found_keep_alive)403 static int parse_http_line1(char *line, int *found_keep_alive)
404 {
405     int i, retcode, err;
406     char *code, *reason, *end;
407 
408     if (!CHECK_AND_SKIP_PREFIX(line, HTTP_PREFIX_VERSION))
409         goto err;
410     /* above HTTP 1.0, connection persistence is the default */
411     *found_keep_alive = *line > '0';
412 
413     /* Skip to first whitespace (past protocol info) */
414     for (code = line; *code != '\0' && !ossl_isspace(*code); code++)
415         continue;
416     if (*code == '\0')
417         goto err;
418 
419     /* Skip past whitespace to start of response code */
420     while (*code != '\0' && ossl_isspace(*code))
421         code++;
422     if (*code == '\0')
423         goto err;
424 
425     /* Find end of response code: first whitespace after start of code */
426     for (reason = code; *reason != '\0' && !ossl_isspace(*reason); reason++)
427         continue;
428 
429     if (*reason == '\0')
430         goto err;
431 
432     /* Set end of response code and start of message */
433     *reason++ = '\0';
434 
435     /* Attempt to parse numeric code */
436     retcode = strtoul(code, &end, 10);
437     if (*end != '\0')
438         goto err;
439 
440     /* Skip over any leading whitespace in message */
441     while (*reason != '\0' && ossl_isspace(*reason))
442         reason++;
443 
444     if (*reason != '\0') {
445         /*
446          * Finally zap any trailing whitespace in message (include CRLF)
447          */
448 
449         /* chop any trailing whitespace from reason */
450         /* We know reason has a non-whitespace character so this is OK */
451         for (end = reason + strlen(reason) - 1; ossl_isspace(*end); end--)
452             *end = '\0';
453     }
454 
455     switch (retcode) {
456     case HTTP_STATUS_CODE_OK:
457     case HTTP_STATUS_CODE_MOVED_PERMANENTLY:
458     case HTTP_STATUS_CODE_FOUND:
459         return retcode;
460     default:
461         err = HTTP_R_RECEIVED_ERROR;
462         if (retcode < 400)
463             err = HTTP_R_STATUS_CODE_UNSUPPORTED;
464         if (*reason == '\0')
465             ERR_raise_data(ERR_LIB_HTTP, err, "code=%s", code);
466         else
467             ERR_raise_data(ERR_LIB_HTTP, err, "code=%s, reason=%s", code,
468                            reason);
469         return retcode;
470     }
471 
472  err:
473     for (i = 0; i < 60 && line[i] != '\0'; i++)
474         if (!ossl_isprint(line[i]))
475             line[i] = ' ';
476     line[i] = '\0';
477     ERR_raise_data(ERR_LIB_HTTP, HTTP_R_HEADER_PARSE_ERROR, "content=%s", line);
478     return 0;
479 }
480 
check_set_resp_len(OSSL_HTTP_REQ_CTX * rctx,size_t len)481 static int check_set_resp_len(OSSL_HTTP_REQ_CTX *rctx, size_t len)
482 {
483     if (rctx->max_resp_len != 0 && len > rctx->max_resp_len)
484         ERR_raise_data(ERR_LIB_HTTP, HTTP_R_MAX_RESP_LEN_EXCEEDED,
485                        "length=%zu, max=%zu", len, rctx->max_resp_len);
486     if (rctx->resp_len != 0 && rctx->resp_len != len)
487         ERR_raise_data(ERR_LIB_HTTP, HTTP_R_INCONSISTENT_CONTENT_LENGTH,
488                        "ASN.1 length=%zu, Content-Length=%zu",
489                        len, rctx->resp_len);
490     rctx->resp_len = len;
491     return 1;
492 }
493 
may_still_retry(time_t max_time,int * ptimeout)494 static int may_still_retry(time_t max_time, int *ptimeout)
495 {
496     time_t time_diff, now = time(NULL);
497 
498     if (max_time != 0) {
499         if (max_time < now) {
500             ERR_raise(ERR_LIB_HTTP, HTTP_R_RETRY_TIMEOUT);
501             return 0;
502         }
503         time_diff = max_time - now;
504         *ptimeout = time_diff > INT_MAX ? INT_MAX : (int)time_diff;
505     }
506     return 1;
507 }
508 
509 /*
510  * Try exchanging request and response via HTTP on (non-)blocking BIO in rctx.
511  * Returns 1 on success, 0 on error or redirection, -1 on BIO_should_retry.
512  */
OSSL_HTTP_REQ_CTX_nbio(OSSL_HTTP_REQ_CTX * rctx)513 int OSSL_HTTP_REQ_CTX_nbio(OSSL_HTTP_REQ_CTX *rctx)
514 {
515     int i, found_expected_ct = 0, found_keep_alive = 0;
516     int found_text_ct = 0;
517     long n;
518     size_t resp_len;
519     const unsigned char *p;
520     char *buf, *key, *value, *line_end = NULL;
521 
522     if (rctx == NULL) {
523         ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
524         return 0;
525     }
526     if (rctx->mem == NULL || rctx->wbio == NULL || rctx->rbio == NULL) {
527         ERR_raise(ERR_LIB_HTTP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
528         return 0;
529     }
530 
531     rctx->redirection_url = NULL;
532  next_io:
533     buf = (char *)rctx->buf;
534     if ((rctx->state & OHS_NOREAD) == 0) {
535         if (rctx->expect_asn1) {
536             n = BIO_read(rctx->rbio, rctx->buf, rctx->buf_size);
537         } else {
538             (void)ERR_set_mark();
539             n = BIO_gets(rctx->rbio, buf, rctx->buf_size);
540             if (n == -2) { /* some BIOs, such as SSL, do not support "gets" */
541                 (void)ERR_pop_to_mark();
542                 n = BIO_get_line(rctx->rbio, buf, rctx->buf_size);
543             } else {
544                 (void)ERR_clear_last_mark();
545             }
546         }
547         if (n <= 0) {
548             if (BIO_should_retry(rctx->rbio))
549                 return -1;
550             ERR_raise(ERR_LIB_HTTP, HTTP_R_FAILED_READING_DATA);
551             return 0;
552         }
553 
554         /* Write data to memory BIO */
555         if (BIO_write(rctx->mem, rctx->buf, n) != n)
556             return 0;
557     }
558 
559     switch (rctx->state) {
560     case OHS_ADD_HEADERS:
561         /* Last operation was adding headers: need a final \r\n */
562         if (BIO_write(rctx->mem, "\r\n", 2) != 2) {
563             rctx->state = OHS_ERROR;
564             return 0;
565         }
566         rctx->state = OHS_WRITE_INIT;
567 
568         /* fall thru */
569     case OHS_WRITE_INIT:
570         rctx->len_to_send = BIO_get_mem_data(rctx->mem, &rctx->pos);
571         rctx->state = OHS_WRITE_HDR;
572         if (OSSL_TRACE_ENABLED(HTTP))
573             OSSL_TRACE(HTTP, "Sending request header:\n");
574 
575         /* fall thru */
576     case OHS_WRITE_HDR:
577         /* Copy some chunk of data from rctx->mem to rctx->wbio */
578     case OHS_WRITE_REQ:
579         /* Copy some chunk of data from rctx->req to rctx->wbio */
580 
581         if (rctx->len_to_send > 0) {
582             if (OSSL_TRACE_ENABLED(HTTP)
583                 && rctx->state == OHS_WRITE_HDR && rctx->len_to_send <= INT_MAX)
584                 OSSL_TRACE2(HTTP, "%.*s", (int)rctx->len_to_send, rctx->pos);
585 
586             i = BIO_write(rctx->wbio, rctx->pos, rctx->len_to_send);
587             if (i <= 0) {
588                 if (BIO_should_retry(rctx->wbio))
589                     return -1;
590                 rctx->state = OHS_ERROR;
591                 return 0;
592             }
593             rctx->pos += i;
594             rctx->len_to_send -= i;
595             goto next_io;
596         }
597         if (rctx->state == OHS_WRITE_HDR) {
598             (void)BIO_reset(rctx->mem);
599             rctx->state = OHS_WRITE_REQ;
600         }
601         if (rctx->req != NULL && !BIO_eof(rctx->req)) {
602             n = BIO_read(rctx->req, rctx->buf, rctx->buf_size);
603             if (n <= 0) {
604                 if (BIO_should_retry(rctx->req))
605                     return -1;
606                 ERR_raise(ERR_LIB_HTTP, HTTP_R_FAILED_READING_DATA);
607                 return 0;
608             }
609             rctx->pos = rctx->buf;
610             rctx->len_to_send = n;
611             goto next_io;
612         }
613         rctx->state = OHS_FLUSH;
614 
615         /* fall thru */
616     case OHS_FLUSH:
617 
618         i = BIO_flush(rctx->wbio);
619 
620         if (i > 0) {
621             rctx->state = OHS_FIRSTLINE;
622             goto next_io;
623         }
624 
625         if (BIO_should_retry(rctx->wbio))
626             return -1;
627 
628         rctx->state = OHS_ERROR;
629         return 0;
630 
631     case OHS_ERROR:
632         return 0;
633 
634     case OHS_FIRSTLINE:
635     case OHS_HEADERS:
636     case OHS_REDIRECT:
637 
638         /* Attempt to read a line in */
639  next_line:
640         /*
641          * Due to strange memory BIO behavior with BIO_gets we have to check
642          * there's a complete line in there before calling BIO_gets or we'll
643          * just get a partial read.
644          */
645         n = BIO_get_mem_data(rctx->mem, &p);
646         if (n <= 0 || memchr(p, '\n', n) == 0) {
647             if (n >= rctx->buf_size) {
648                 rctx->state = OHS_ERROR;
649                 return 0;
650             }
651             goto next_io;
652         }
653         n = BIO_gets(rctx->mem, buf, rctx->buf_size);
654 
655         if (n <= 0) {
656             if (BIO_should_retry(rctx->mem))
657                 goto next_io;
658             rctx->state = OHS_ERROR;
659             return 0;
660         }
661 
662         /* Don't allow excessive lines */
663         if (n == rctx->buf_size) {
664             ERR_raise(ERR_LIB_HTTP, HTTP_R_RESPONSE_LINE_TOO_LONG);
665             rctx->state = OHS_ERROR;
666             return 0;
667         }
668 
669         /* dump all response header lines */
670         if (OSSL_TRACE_ENABLED(HTTP)) {
671             if (rctx->state == OHS_FIRSTLINE)
672                 OSSL_TRACE(HTTP, "Received response header:\n");
673             OSSL_TRACE1(HTTP, "%s", buf);
674         }
675 
676         /* First line */
677         if (rctx->state == OHS_FIRSTLINE) {
678             switch (parse_http_line1(buf, &found_keep_alive)) {
679             case HTTP_STATUS_CODE_OK:
680                 rctx->state = OHS_HEADERS;
681                 goto next_line;
682             case HTTP_STATUS_CODE_MOVED_PERMANENTLY:
683             case HTTP_STATUS_CODE_FOUND: /* i.e., moved temporarily */
684                 if (!rctx->method_POST) { /* method is GET */
685                     rctx->state = OHS_REDIRECT;
686                     goto next_line;
687                 }
688                 ERR_raise(ERR_LIB_HTTP, HTTP_R_REDIRECTION_NOT_ENABLED);
689                 /* redirection is not supported/recommended for POST */
690                 /* fall through */
691             default:
692                 rctx->state = OHS_ERROR;
693                 goto next_line;
694             }
695         }
696         key = buf;
697         value = strchr(key, ':');
698         if (value != NULL) {
699             *(value++) = '\0';
700             while (ossl_isspace(*value))
701                 value++;
702             line_end = strchr(value, '\r');
703             if (line_end == NULL)
704                 line_end = strchr(value, '\n');
705             if (line_end != NULL)
706                 *line_end = '\0';
707         }
708         if (value != NULL && line_end != NULL) {
709             if (rctx->state == OHS_REDIRECT
710                     && OPENSSL_strcasecmp(key, "Location") == 0) {
711                 rctx->redirection_url = value;
712                 return 0;
713             }
714             if (OPENSSL_strcasecmp(key, "Content-Type") == 0) {
715                 if (rctx->state == OHS_HEADERS
716                     && rctx->expected_ct != NULL) {
717                     const char *semicolon;
718 
719                     if (OPENSSL_strcasecmp(rctx->expected_ct, value) != 0
720                         /* ignore past ';' unless expected_ct contains ';' */
721                         && (strchr(rctx->expected_ct, ';') != NULL
722                             || (semicolon = strchr(value, ';')) == NULL
723                             || (size_t)(semicolon - value) != strlen(rctx->expected_ct)
724                             || OPENSSL_strncasecmp(rctx->expected_ct, value,
725                                                    semicolon - value) != 0)) {
726                         ERR_raise_data(ERR_LIB_HTTP,
727                                        HTTP_R_UNEXPECTED_CONTENT_TYPE,
728                                        "expected=%s, actual=%s",
729                                        rctx->expected_ct, value);
730                         return 0;
731                     }
732                     found_expected_ct = 1;
733                 }
734                 if (OPENSSL_strncasecmp(value, "text/", 5) == 0)
735                     found_text_ct = 1;
736             }
737 
738             /* https://tools.ietf.org/html/rfc7230#section-6.3 Persistence */
739             if (OPENSSL_strcasecmp(key, "Connection") == 0) {
740                 if (OPENSSL_strcasecmp(value, "keep-alive") == 0)
741                     found_keep_alive = 1;
742                 else if (OPENSSL_strcasecmp(value, "close") == 0)
743                     found_keep_alive = 0;
744             } else if (OPENSSL_strcasecmp(key, "Content-Length") == 0) {
745                 resp_len = (size_t)strtoul(value, &line_end, 10);
746                 if (line_end == value || *line_end != '\0') {
747                     ERR_raise_data(ERR_LIB_HTTP,
748                                    HTTP_R_ERROR_PARSING_CONTENT_LENGTH,
749                                    "input=%s", value);
750                     return 0;
751                 }
752                 if (!check_set_resp_len(rctx, resp_len))
753                     return 0;
754             }
755         }
756 
757         /* Look for blank line indicating end of headers */
758         for (p = rctx->buf; *p != '\0'; p++) {
759             if (*p != '\r' && *p != '\n')
760                 break;
761         }
762         if (*p != '\0') /* not end of headers */
763             goto next_line;
764 
765         if (rctx->keep_alive != 0 /* do not let server initiate keep_alive */
766                 && !found_keep_alive /* otherwise there is no change */) {
767             if (rctx->keep_alive == 2) {
768                 rctx->keep_alive = 0;
769                 ERR_raise(ERR_LIB_HTTP, HTTP_R_SERVER_CANCELED_CONNECTION);
770                 return 0;
771             }
772             rctx->keep_alive = 0;
773         }
774 
775         if (rctx->state == OHS_ERROR) {
776             if (OSSL_TRACE_ENABLED(HTTP)
777                     && found_text_ct && BIO_get_mem_data(rctx->mem, &p) > 0)
778                 OSSL_TRACE1(HTTP, "%s", p);
779             return 0;
780         }
781 
782         if (rctx->expected_ct != NULL && !found_expected_ct) {
783             ERR_raise_data(ERR_LIB_HTTP, HTTP_R_MISSING_CONTENT_TYPE,
784                            "expected=%s", rctx->expected_ct);
785             return 0;
786         }
787         if (rctx->state == OHS_REDIRECT) {
788             /* http status code indicated redirect but there was no Location */
789             ERR_raise(ERR_LIB_HTTP, HTTP_R_MISSING_REDIRECT_LOCATION);
790             return 0;
791         }
792 
793         if (!rctx->expect_asn1) {
794             rctx->state = OHS_STREAM;
795             return 1;
796         }
797 
798         rctx->state = OHS_ASN1_HEADER;
799 
800         /* Fall thru */
801     case OHS_ASN1_HEADER:
802         /*
803          * Now reading ASN1 header: can read at least 2 bytes which is enough
804          * for ASN1 SEQUENCE header and either length field or at least the
805          * length of the length field.
806          */
807         n = BIO_get_mem_data(rctx->mem, &p);
808         if (n < 2)
809             goto next_io;
810 
811         /* Check it is an ASN1 SEQUENCE */
812         if (*p++ != (V_ASN1_SEQUENCE | V_ASN1_CONSTRUCTED)) {
813             ERR_raise(ERR_LIB_HTTP, HTTP_R_MISSING_ASN1_ENCODING);
814             return 0;
815         }
816 
817         /* Check out length field */
818         if ((*p & 0x80) != 0) {
819             /*
820              * If MSB set on initial length octet we can now always read 6
821              * octets: make sure we have them.
822              */
823             if (n < 6)
824                 goto next_io;
825             n = *p & 0x7F;
826             /* Not NDEF or excessive length */
827             if (n == 0 || (n > 4)) {
828                 ERR_raise(ERR_LIB_HTTP, HTTP_R_ERROR_PARSING_ASN1_LENGTH);
829                 return 0;
830             }
831             p++;
832             resp_len = 0;
833             for (i = 0; i < n; i++) {
834                 resp_len <<= 8;
835                 resp_len |= *p++;
836             }
837             resp_len += n + 2;
838         } else {
839             resp_len = *p + 2;
840         }
841         if (!check_set_resp_len(rctx, resp_len))
842             return 0;
843 
844         rctx->state = OHS_ASN1_CONTENT;
845 
846         /* Fall thru */
847     case OHS_ASN1_CONTENT:
848     default:
849         n = BIO_get_mem_data(rctx->mem, NULL);
850         if (n < 0 || (size_t)n < rctx->resp_len)
851             goto next_io;
852 
853         rctx->state = OHS_ASN1_DONE;
854         return 1;
855     }
856 }
857 
OSSL_HTTP_REQ_CTX_nbio_d2i(OSSL_HTTP_REQ_CTX * rctx,ASN1_VALUE ** pval,const ASN1_ITEM * it)858 int OSSL_HTTP_REQ_CTX_nbio_d2i(OSSL_HTTP_REQ_CTX *rctx,
859                                ASN1_VALUE **pval, const ASN1_ITEM *it)
860 {
861     const unsigned char *p;
862     int rv;
863 
864     *pval = NULL;
865     if ((rv = OSSL_HTTP_REQ_CTX_nbio(rctx)) != 1)
866         return rv;
867     *pval = ASN1_item_d2i(NULL, &p, BIO_get_mem_data(rctx->mem, &p), it);
868     return *pval != NULL;
869 
870 }
871 
872 #ifndef OPENSSL_NO_SOCK
873 
874 /* set up a new connection BIO, to HTTP server or to HTTP(S) proxy if given */
http_new_bio(const char * server,const char * server_port,int use_ssl,const char * proxy,const char * proxy_port)875 static BIO *http_new_bio(const char *server /* optionally includes ":port" */,
876                          const char *server_port /* explicit server port */,
877                          int use_ssl,
878                          const char *proxy /* optionally includes ":port" */,
879                          const char *proxy_port /* explicit proxy port */)
880 {
881     const char *host = server;
882     const char *port = server_port;
883     BIO *cbio;
884 
885     if (!ossl_assert(server != NULL))
886         return NULL;
887 
888     if (proxy != NULL) {
889         host = proxy;
890         port = proxy_port;
891     }
892 
893     if (port == NULL && strchr(host, ':') == NULL)
894         port = use_ssl ? OSSL_HTTPS_PORT : OSSL_HTTP_PORT;
895 
896     cbio = BIO_new_connect(host /* optionally includes ":port" */);
897     if (cbio == NULL)
898         goto end;
899     if (port != NULL)
900         (void)BIO_set_conn_port(cbio, port);
901 
902  end:
903     return cbio;
904 }
905 #endif /* OPENSSL_NO_SOCK */
906 
907 /* Exchange request and response via HTTP on (non-)blocking BIO */
OSSL_HTTP_REQ_CTX_exchange(OSSL_HTTP_REQ_CTX * rctx)908 BIO *OSSL_HTTP_REQ_CTX_exchange(OSSL_HTTP_REQ_CTX *rctx)
909 {
910     int rv;
911 
912     if (rctx == NULL) {
913         ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
914         return NULL;
915     }
916 
917     for (;;) {
918         rv = OSSL_HTTP_REQ_CTX_nbio(rctx);
919         if (rv != -1)
920             break;
921         /* BIO_should_retry was true */
922         /* will not actually wait if rctx->max_time == 0 */
923         if (BIO_wait(rctx->rbio, rctx->max_time, 100 /* milliseconds */) <= 0)
924             return NULL;
925     }
926 
927     if (rv == 0) {
928         if (rctx->redirection_url == NULL) { /* an error occurred */
929             if (rctx->len_to_send > 0)
930                 ERR_raise(ERR_LIB_HTTP, HTTP_R_ERROR_SENDING);
931             else
932                 ERR_raise(ERR_LIB_HTTP, HTTP_R_ERROR_RECEIVING);
933         }
934         return NULL;
935     }
936     return rctx->state == OHS_STREAM ? rctx->rbio : rctx->mem;
937 }
938 
OSSL_HTTP_is_alive(const OSSL_HTTP_REQ_CTX * rctx)939 int OSSL_HTTP_is_alive(const OSSL_HTTP_REQ_CTX *rctx)
940 {
941     return rctx != NULL && rctx->keep_alive != 0;
942 }
943 
944 /* High-level HTTP API implementation */
945 
946 /* Initiate an HTTP session using bio, else use given server, proxy, etc. */
OSSL_HTTP_open(const char * server,const char * port,const char * proxy,const char * no_proxy,int use_ssl,BIO * bio,BIO * rbio,OSSL_HTTP_bio_cb_t bio_update_fn,void * arg,int buf_size,int overall_timeout)947 OSSL_HTTP_REQ_CTX *OSSL_HTTP_open(const char *server, const char *port,
948                                   const char *proxy, const char *no_proxy,
949                                   int use_ssl, BIO *bio, BIO *rbio,
950                                   OSSL_HTTP_bio_cb_t bio_update_fn, void *arg,
951                                   int buf_size, int overall_timeout)
952 {
953     BIO *cbio; /* == bio if supplied, used as connection BIO if rbio is NULL */
954     OSSL_HTTP_REQ_CTX *rctx = NULL;
955 
956     if (use_ssl && bio_update_fn == NULL) {
957         ERR_raise(ERR_LIB_HTTP, HTTP_R_TLS_NOT_ENABLED);
958         return NULL;
959     }
960     if (rbio != NULL && (bio == NULL || bio_update_fn != NULL)) {
961         ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_INVALID_ARGUMENT);
962         return NULL;
963     }
964 
965     if (bio != NULL) {
966         cbio = bio;
967         if (proxy != NULL || no_proxy != NULL) {
968             ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_INVALID_ARGUMENT);
969             return NULL;
970         }
971     } else {
972 #ifndef OPENSSL_NO_SOCK
973         char *proxy_host = NULL, *proxy_port = NULL;
974 
975         if (server == NULL) {
976             ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
977             return NULL;
978         }
979         if (port != NULL && *port == '\0')
980             port = NULL;
981         if (port == NULL && strchr(server, ':') == NULL)
982             port = use_ssl ? OSSL_HTTPS_PORT : OSSL_HTTP_PORT;
983         proxy = OSSL_HTTP_adapt_proxy(proxy, no_proxy, server, use_ssl);
984         if (proxy != NULL
985             && !OSSL_HTTP_parse_url(proxy, NULL /* use_ssl */, NULL /* user */,
986                                     &proxy_host, &proxy_port, NULL /* num */,
987                                     NULL /* path */, NULL, NULL))
988             return NULL;
989         cbio = http_new_bio(server, port, use_ssl, proxy_host, proxy_port);
990         OPENSSL_free(proxy_host);
991         OPENSSL_free(proxy_port);
992         if (cbio == NULL)
993             return NULL;
994 #else
995         ERR_raise(ERR_LIB_HTTP, HTTP_R_SOCK_NOT_SUPPORTED);
996         return NULL;
997 #endif
998     }
999 
1000     (void)ERR_set_mark(); /* prepare removing any spurious libssl errors */
1001     if (rbio == NULL && BIO_do_connect_retry(cbio, overall_timeout, -1) <= 0) {
1002         if (bio == NULL) /* cbio was not provided by caller */
1003             BIO_free_all(cbio);
1004         goto end;
1005     }
1006     /* now overall_timeout is guaranteed to be >= 0 */
1007 
1008     /* adapt in order to fix callback design flaw, see #17088 */
1009     /* callback can be used to wrap or prepend TLS session */
1010     if (bio_update_fn != NULL) {
1011         BIO *orig_bio = cbio;
1012 
1013         cbio = (*bio_update_fn)(cbio, arg, 1 /* connect */, use_ssl != 0);
1014         if (cbio == NULL) {
1015             if (bio == NULL) /* cbio was not provided by caller */
1016                 BIO_free_all(orig_bio);
1017             goto end;
1018         }
1019     }
1020 
1021     rctx = http_req_ctx_new(bio == NULL, cbio, rbio != NULL ? rbio : cbio,
1022                             bio_update_fn, arg, use_ssl, proxy, server, port,
1023                             buf_size, overall_timeout);
1024 
1025  end:
1026     if (rctx != NULL)
1027         /* remove any spurious error queue entries by ssl_add_cert_chain() */
1028         (void)ERR_pop_to_mark();
1029     else
1030         (void)ERR_clear_last_mark();
1031 
1032     return rctx;
1033 }
1034 
OSSL_HTTP_set1_request(OSSL_HTTP_REQ_CTX * rctx,const char * path,const STACK_OF (CONF_VALUE)* headers,const char * content_type,BIO * req,const char * expected_content_type,int expect_asn1,size_t max_resp_len,int timeout,int keep_alive)1035 int OSSL_HTTP_set1_request(OSSL_HTTP_REQ_CTX *rctx, const char *path,
1036                            const STACK_OF(CONF_VALUE) *headers,
1037                            const char *content_type, BIO *req,
1038                            const char *expected_content_type, int expect_asn1,
1039                            size_t max_resp_len, int timeout, int keep_alive)
1040 {
1041     int use_http_proxy;
1042 
1043     if (rctx == NULL) {
1044         ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
1045         return 0;
1046     }
1047     use_http_proxy = rctx->proxy != NULL && !rctx->use_ssl;
1048     if (use_http_proxy && rctx->server == NULL) {
1049         ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_INVALID_ARGUMENT);
1050         return 0;
1051     }
1052     rctx->max_resp_len = max_resp_len; /* allows for 0: indefinite */
1053 
1054     return OSSL_HTTP_REQ_CTX_set_request_line(rctx, req != NULL,
1055                                               use_http_proxy ? rctx->server
1056                                               : NULL, rctx->port, path)
1057         && add1_headers(rctx, headers, rctx->server)
1058         && OSSL_HTTP_REQ_CTX_set_expected(rctx, expected_content_type,
1059                                           expect_asn1, timeout, keep_alive)
1060         && set1_content(rctx, content_type, req);
1061 }
1062 
1063 /*-
1064  * Exchange single HTTP request and response according to rctx.
1065  * If rctx->method_POST then use POST, else use GET and ignore content_type.
1066  * The redirection_url output (freed by caller) parameter is used only for GET.
1067  */
OSSL_HTTP_exchange(OSSL_HTTP_REQ_CTX * rctx,char ** redirection_url)1068 BIO *OSSL_HTTP_exchange(OSSL_HTTP_REQ_CTX *rctx, char **redirection_url)
1069 {
1070     BIO *resp;
1071 
1072     if (rctx == NULL) {
1073         ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
1074         return NULL;
1075     }
1076 
1077     if (redirection_url != NULL)
1078         *redirection_url = NULL; /* do this beforehand to prevent dbl free */
1079 
1080     resp = OSSL_HTTP_REQ_CTX_exchange(rctx);
1081     if (resp == NULL) {
1082         if (rctx->redirection_url != NULL) {
1083             if (redirection_url == NULL)
1084                 ERR_raise(ERR_LIB_HTTP, HTTP_R_REDIRECTION_NOT_ENABLED);
1085             else
1086                 /* may be NULL if out of memory: */
1087                 *redirection_url = OPENSSL_strdup(rctx->redirection_url);
1088         } else {
1089             char buf[200];
1090             unsigned long err = ERR_peek_error();
1091             int lib = ERR_GET_LIB(err);
1092             int reason = ERR_GET_REASON(err);
1093 
1094             if (lib == ERR_LIB_SSL || lib == ERR_LIB_HTTP
1095                     || (lib == ERR_LIB_BIO && reason == BIO_R_CONNECT_TIMEOUT)
1096                     || (lib == ERR_LIB_BIO && reason == BIO_R_CONNECT_ERROR)
1097 #ifndef OPENSSL_NO_CMP
1098                     || (lib == ERR_LIB_CMP
1099                         && reason == CMP_R_POTENTIALLY_INVALID_CERTIFICATE)
1100 #endif
1101                 ) {
1102                 if (rctx->server != NULL) {
1103                     BIO_snprintf(buf, sizeof(buf), "server=http%s://%s%s%s",
1104                                  rctx->use_ssl ? "s" : "", rctx->server,
1105                                  rctx->port != NULL ? ":" : "",
1106                                  rctx->port != NULL ? rctx->port : "");
1107                     ERR_add_error_data(1, buf);
1108                 }
1109                 if (rctx->proxy != NULL)
1110                     ERR_add_error_data(2, " proxy=", rctx->proxy);
1111                 if (err == 0) {
1112                     BIO_snprintf(buf, sizeof(buf), " peer has disconnected%s",
1113                                  rctx->use_ssl ? " violating the protocol" :
1114                                  ", likely because it requires the use of TLS");
1115                     ERR_add_error_data(1, buf);
1116                 }
1117             }
1118         }
1119     }
1120 
1121     if (resp != NULL && !BIO_up_ref(resp))
1122         resp = NULL;
1123     return resp;
1124 }
1125 
redirection_ok(int n_redir,const char * old_url,const char * new_url)1126 static int redirection_ok(int n_redir, const char *old_url, const char *new_url)
1127 {
1128     if (n_redir >= HTTP_VERSION_MAX_REDIRECTIONS) {
1129         ERR_raise(ERR_LIB_HTTP, HTTP_R_TOO_MANY_REDIRECTIONS);
1130         return 0;
1131     }
1132     if (*new_url == '/') /* redirection to same server => same protocol */
1133         return 1;
1134     if (HAS_PREFIX(old_url, OSSL_HTTPS_NAME":") &&
1135         !HAS_PREFIX(new_url, OSSL_HTTPS_NAME":")) {
1136         ERR_raise(ERR_LIB_HTTP, HTTP_R_REDIRECTION_FROM_HTTPS_TO_HTTP);
1137         return 0;
1138     }
1139     return 1;
1140 }
1141 
1142 /* Get data via HTTP from server at given URL, potentially with redirection */
OSSL_HTTP_get(const char * url,const char * proxy,const char * no_proxy,BIO * bio,BIO * rbio,OSSL_HTTP_bio_cb_t bio_update_fn,void * arg,int buf_size,const STACK_OF (CONF_VALUE)* headers,const char * expected_ct,int expect_asn1,size_t max_resp_len,int timeout)1143 BIO *OSSL_HTTP_get(const char *url, const char *proxy, const char *no_proxy,
1144                    BIO *bio, BIO *rbio,
1145                    OSSL_HTTP_bio_cb_t bio_update_fn, void *arg,
1146                    int buf_size, const STACK_OF(CONF_VALUE) *headers,
1147                    const char *expected_ct, int expect_asn1,
1148                    size_t max_resp_len, int timeout)
1149 {
1150     char *current_url, *redirection_url = NULL;
1151     int n_redirs = 0;
1152     char *host;
1153     char *port;
1154     char *path;
1155     int use_ssl;
1156     OSSL_HTTP_REQ_CTX *rctx;
1157     BIO *resp = NULL;
1158     time_t max_time = timeout > 0 ? time(NULL) + timeout : 0;
1159 
1160     if (url == NULL) {
1161         ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
1162         return NULL;
1163     }
1164     if ((current_url = OPENSSL_strdup(url)) == NULL)
1165         return NULL;
1166 
1167     for (;;) {
1168         if (!OSSL_HTTP_parse_url(current_url, &use_ssl, NULL /* user */, &host,
1169                                  &port, NULL /* port_num */, &path, NULL, NULL))
1170             break;
1171 
1172         rctx = OSSL_HTTP_open(host, port, proxy, no_proxy,
1173                               use_ssl, bio, rbio, bio_update_fn, arg,
1174                               buf_size, timeout);
1175     new_rpath:
1176         if (rctx != NULL) {
1177             if (!OSSL_HTTP_set1_request(rctx, path, headers,
1178                                         NULL /* content_type */,
1179                                         NULL /* req */,
1180                                         expected_ct, expect_asn1, max_resp_len,
1181                                         -1 /* use same max time (timeout) */,
1182                                         0 /* no keep_alive */))
1183                 OSSL_HTTP_REQ_CTX_free(rctx);
1184             else
1185                 resp = OSSL_HTTP_exchange(rctx, &redirection_url);
1186         }
1187         OPENSSL_free(path);
1188         if (resp == NULL && redirection_url != NULL) {
1189             if (redirection_ok(++n_redirs, current_url, redirection_url)
1190                     && may_still_retry(max_time, &timeout)) {
1191                 (void)BIO_reset(bio);
1192                 OPENSSL_free(current_url);
1193                 current_url = redirection_url;
1194                 if (*redirection_url == '/') { /* redirection to same server */
1195                     path = OPENSSL_strdup(redirection_url);
1196                     if (path == NULL) {
1197                         OPENSSL_free(host);
1198                         OPENSSL_free(port);
1199                         (void)OSSL_HTTP_close(rctx, 1);
1200                         BIO_free(resp);
1201                         OPENSSL_free(current_url);
1202                         return NULL;
1203                     }
1204                     goto new_rpath;
1205                 }
1206                 OPENSSL_free(host);
1207                 OPENSSL_free(port);
1208                 (void)OSSL_HTTP_close(rctx, 1);
1209                 continue;
1210             }
1211             /* if redirection not allowed, ignore it */
1212             OPENSSL_free(redirection_url);
1213         }
1214         OPENSSL_free(host);
1215         OPENSSL_free(port);
1216         if (!OSSL_HTTP_close(rctx, resp != NULL)) {
1217             BIO_free(resp);
1218             resp = NULL;
1219         }
1220         break;
1221     }
1222     OPENSSL_free(current_url);
1223     return resp;
1224 }
1225 
1226 /* Exchange request and response over a connection managed via |prctx| */
OSSL_HTTP_transfer(OSSL_HTTP_REQ_CTX ** prctx,const char * server,const char * port,const char * path,int use_ssl,const char * proxy,const char * no_proxy,BIO * bio,BIO * rbio,OSSL_HTTP_bio_cb_t bio_update_fn,void * arg,int buf_size,const STACK_OF (CONF_VALUE)* headers,const char * content_type,BIO * req,const char * expected_ct,int expect_asn1,size_t max_resp_len,int timeout,int keep_alive)1227 BIO *OSSL_HTTP_transfer(OSSL_HTTP_REQ_CTX **prctx,
1228                         const char *server, const char *port,
1229                         const char *path, int use_ssl,
1230                         const char *proxy, const char *no_proxy,
1231                         BIO *bio, BIO *rbio,
1232                         OSSL_HTTP_bio_cb_t bio_update_fn, void *arg,
1233                         int buf_size, const STACK_OF(CONF_VALUE) *headers,
1234                         const char *content_type, BIO *req,
1235                         const char *expected_ct, int expect_asn1,
1236                         size_t max_resp_len, int timeout, int keep_alive)
1237 {
1238     OSSL_HTTP_REQ_CTX *rctx = prctx == NULL ? NULL : *prctx;
1239     BIO *resp = NULL;
1240 
1241     if (rctx == NULL) {
1242         rctx = OSSL_HTTP_open(server, port, proxy, no_proxy,
1243                               use_ssl, bio, rbio, bio_update_fn, arg,
1244                               buf_size, timeout);
1245         timeout = -1; /* Already set during opening the connection */
1246     }
1247     if (rctx != NULL) {
1248         if (OSSL_HTTP_set1_request(rctx, path, headers, content_type, req,
1249                                    expected_ct, expect_asn1,
1250                                    max_resp_len, timeout, keep_alive))
1251             resp = OSSL_HTTP_exchange(rctx, NULL);
1252         if (resp == NULL || !OSSL_HTTP_is_alive(rctx)) {
1253             if (!OSSL_HTTP_close(rctx, resp != NULL)) {
1254                 BIO_free(resp);
1255                 resp = NULL;
1256             }
1257             rctx = NULL;
1258         }
1259     }
1260     if (prctx != NULL)
1261         *prctx = rctx;
1262     return resp;
1263 }
1264 
OSSL_HTTP_close(OSSL_HTTP_REQ_CTX * rctx,int ok)1265 int OSSL_HTTP_close(OSSL_HTTP_REQ_CTX *rctx, int ok)
1266 {
1267     BIO *wbio;
1268     int ret = 1;
1269 
1270     /* callback can be used to finish TLS session and free its BIO */
1271     if (rctx != NULL && rctx->upd_fn != NULL) {
1272         wbio = (*rctx->upd_fn)(rctx->wbio, rctx->upd_arg,
1273                                0 /* disconnect */, ok);
1274         ret = wbio != NULL;
1275         if (ret)
1276             rctx->wbio = wbio;
1277     }
1278     OSSL_HTTP_REQ_CTX_free(rctx);
1279     return ret;
1280 }
1281 
1282 /* BASE64 encoder used for encoding basic proxy authentication credentials */
base64encode(const void * buf,size_t len)1283 static char *base64encode(const void *buf, size_t len)
1284 {
1285     int i;
1286     size_t outl;
1287     char *out;
1288 
1289     /* Calculate size of encoded data */
1290     outl = (len / 3);
1291     if (len % 3 > 0)
1292         outl++;
1293     outl <<= 2;
1294     out = OPENSSL_malloc(outl + 1);
1295     if (out == NULL)
1296         return 0;
1297 
1298     i = EVP_EncodeBlock((unsigned char *)out, buf, len);
1299     if (!ossl_assert(0 <= i && (size_t)i <= outl)) {
1300         OPENSSL_free(out);
1301         return NULL;
1302     }
1303     return out;
1304 }
1305 
1306 /*
1307  * Promote the given connection BIO using the CONNECT method for a TLS proxy.
1308  * This is typically called by an app, so bio_err and prog are used unless NULL
1309  * to print additional diagnostic information in a user-oriented way.
1310  */
OSSL_HTTP_proxy_connect(BIO * bio,const char * server,const char * port,const char * proxyuser,const char * proxypass,int timeout,BIO * bio_err,const char * prog)1311 int OSSL_HTTP_proxy_connect(BIO *bio, const char *server, const char *port,
1312                             const char *proxyuser, const char *proxypass,
1313                             int timeout, BIO *bio_err, const char *prog)
1314 {
1315 #undef BUF_SIZE
1316 #define BUF_SIZE (8 * 1024)
1317     char *mbuf = OPENSSL_malloc(BUF_SIZE);
1318     char *mbufp;
1319     int read_len = 0;
1320     int ret = 0;
1321     BIO *fbio = BIO_new(BIO_f_buffer());
1322     int rv;
1323     time_t max_time = timeout > 0 ? time(NULL) + timeout : 0;
1324 
1325     if (bio == NULL || server == NULL
1326             || (bio_err != NULL && prog == NULL)) {
1327         ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
1328         goto end;
1329     }
1330     if (port == NULL || *port == '\0')
1331         port = OSSL_HTTPS_PORT;
1332 
1333     if (mbuf == NULL || fbio == NULL) {
1334         BIO_printf(bio_err /* may be NULL */, "%s: out of memory", prog);
1335         goto end;
1336     }
1337     BIO_push(fbio, bio);
1338 
1339     BIO_printf(fbio, "CONNECT %s:%s "HTTP_1_0"\r\n", server, port);
1340 
1341     /*
1342      * Workaround for broken proxies which would otherwise close
1343      * the connection when entering tunnel mode (e.g., Squid 2.6)
1344      */
1345     BIO_printf(fbio, "Proxy-Connection: Keep-Alive\r\n");
1346 
1347     /* Support for basic (base64) proxy authentication */
1348     if (proxyuser != NULL) {
1349         size_t len = strlen(proxyuser) + 1;
1350         char *proxyauth, *proxyauthenc = NULL;
1351 
1352         if (proxypass != NULL)
1353             len += strlen(proxypass);
1354         proxyauth = OPENSSL_malloc(len + 1);
1355         if (proxyauth == NULL)
1356             goto end;
1357         if (BIO_snprintf(proxyauth, len + 1, "%s:%s", proxyuser,
1358                          proxypass != NULL ? proxypass : "") != (int)len)
1359             goto proxy_end;
1360         proxyauthenc = base64encode(proxyauth, len);
1361         if (proxyauthenc != NULL) {
1362             BIO_printf(fbio, "Proxy-Authorization: Basic %s\r\n", proxyauthenc);
1363             OPENSSL_clear_free(proxyauthenc, strlen(proxyauthenc));
1364         }
1365     proxy_end:
1366         OPENSSL_clear_free(proxyauth, len);
1367         if (proxyauthenc == NULL)
1368             goto end;
1369     }
1370 
1371     /* Terminate the HTTP CONNECT request */
1372     BIO_printf(fbio, "\r\n");
1373 
1374     for (;;) {
1375         if (BIO_flush(fbio) != 0)
1376             break;
1377         /* potentially needs to be retried if BIO is non-blocking */
1378         if (!BIO_should_retry(fbio))
1379             break;
1380     }
1381 
1382     for (;;) {
1383         /* will not actually wait if timeout == 0 */
1384         rv = BIO_wait(fbio, max_time, 100 /* milliseconds */);
1385         if (rv <= 0) {
1386             BIO_printf(bio_err, "%s: HTTP CONNECT %s\n", prog,
1387                        rv == 0 ? "timed out" : "failed waiting for data");
1388             goto end;
1389         }
1390 
1391         /*-
1392          * The first line is the HTTP response.
1393          * According to RFC 7230, it is formatted exactly like this:
1394          * HTTP/d.d ddd reason text\r\n
1395          */
1396         read_len = BIO_gets(fbio, mbuf, BUF_SIZE);
1397         /* the BIO may not block, so we must wait for the 1st line to come in */
1398         if (read_len < (int)HTTP_LINE1_MINLEN)
1399             continue;
1400 
1401         /* Check for HTTP/1.x */
1402         mbufp = mbuf;
1403         if (!CHECK_AND_SKIP_PREFIX(mbufp, HTTP_PREFIX)) {
1404             ERR_raise(ERR_LIB_HTTP, HTTP_R_HEADER_PARSE_ERROR);
1405             BIO_printf(bio_err, "%s: HTTP CONNECT failed, non-HTTP response\n",
1406                        prog);
1407             /* Wrong protocol, not even HTTP, so stop reading headers */
1408             goto end;
1409         }
1410         if (!HAS_PREFIX(mbufp, HTTP_VERSION_PATT)) {
1411             ERR_raise(ERR_LIB_HTTP, HTTP_R_RECEIVED_WRONG_HTTP_VERSION);
1412             BIO_printf(bio_err,
1413                        "%s: HTTP CONNECT failed, bad HTTP version %.*s\n",
1414                        prog, (int)HTTP_VERSION_STR_LEN, mbufp);
1415             goto end;
1416         }
1417         mbufp += HTTP_VERSION_STR_LEN;
1418 
1419         /* RFC 7231 4.3.6: any 2xx status code is valid */
1420         if (!HAS_PREFIX(mbufp, " 2")) {
1421             if (ossl_isspace(*mbufp))
1422                 mbufp++;
1423             /* chop any trailing whitespace */
1424             while (read_len > 0 && ossl_isspace(mbuf[read_len - 1]))
1425                 read_len--;
1426             mbuf[read_len] = '\0';
1427             ERR_raise_data(ERR_LIB_HTTP, HTTP_R_CONNECT_FAILURE,
1428                            "reason=%s", mbufp);
1429             BIO_printf(bio_err, "%s: HTTP CONNECT failed, reason=%s\n",
1430                        prog, mbufp);
1431             goto end;
1432         }
1433         ret = 1;
1434         break;
1435     }
1436 
1437     /* Read past all following headers */
1438     do {
1439         /*
1440          * This does not necessarily catch the case when the full
1441          * HTTP response came in in more than a single TCP message.
1442          */
1443         read_len = BIO_gets(fbio, mbuf, BUF_SIZE);
1444     } while (read_len > 2);
1445 
1446  end:
1447     if (fbio != NULL) {
1448         (void)BIO_flush(fbio);
1449         BIO_pop(fbio);
1450         BIO_free(fbio);
1451     }
1452     OPENSSL_free(mbuf);
1453     return ret;
1454 #undef BUF_SIZE
1455 }
1456