]> git.ipfire.org Git - thirdparty/openssl.git/blame - crypto/http/http_client.c
http_client.c: 2nd fix for calculation of Content-Length in set1_content()
[thirdparty/openssl.git] / crypto / http / http_client.c
CommitLineData
29f178bd 1/*
fecb3aae 2 * Copyright 2001-2022 The OpenSSL Project Authors. All Rights Reserved.
29f178bd
DDO
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
d5f9166b 11#include "internal/e_os.h"
29f178bd
DDO
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>
e8fdb060 23#include <openssl/trace.h>
29f178bd 24#include "internal/sockets.h"
af16097f 25#include "internal/common.h" /* for ossl_assert() */
29f178bd 26
29f178bd
DDO
27#define HTTP_PREFIX "HTTP/"
28#define HTTP_VERSION_PATT "1." /* allow 1.x */
47bb597b 29#define HTTP_VERSION_STR_LEN sizeof(HTTP_VERSION_PATT) /* == strlen("1.0") */
19f97fe6
DDO
30#define HTTP_PREFIX_VERSION HTTP_PREFIX""HTTP_VERSION_PATT
31#define HTTP_1_0 HTTP_PREFIX_VERSION"0" /* "HTTP/1.0" */
765860a3 32#define HTTP_LINE1_MINLEN (sizeof(HTTP_PREFIX_VERSION "x 200\n") - 1)
29f178bd
DDO
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
29f178bd
DDO
39/* Stateful HTTP request code, supporting blocking and non-blocking I/O */
40
41/* Opaque HTTP request status structure */
42
43struct ossl_http_req_ctx_st {
44 int state; /* Current I/O state */
e2c38c1a
DDO
45 unsigned char *buf; /* Buffer to write request or read response */
46 int buf_size; /* Buffer size */
19f97fe6
DDO
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 */
7d5019c1 56 BIO *mem; /* Mem BIO holding request header or response */
8b5ca511 57 BIO *req; /* BIO holding the request provided by caller */
19f97fe6
DDO
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 */
8b5ca511
DDO
61 unsigned char *pos; /* Current position sending data */
62 long len_to_send; /* Number of bytes still to send */
be799eb7
DDO
63 size_t resp_len; /* Length of response */
64 size_t max_resp_len; /* Maximum length of response, or 0 */
8f965908
DDO
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 */
19f97fe6 68 char *redirection_url; /* Location obtained from HTTP status 301/302 */
29f178bd
DDO
69};
70
29f178bd
DDO
71/* HTTP states */
72
be799eb7
DDO
73#define OHS_NOREAD 0x1000 /* If set no reading should be performed */
74#define OHS_ERROR (0 | OHS_NOREAD) /* Error condition */
8b5ca511
DDO
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 */
be799eb7
DDO
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 */
29f178bd 87
19f97fe6
DDO
88/* Low-level HTTP API implementation */
89
68bb06f7 90OSSL_HTTP_REQ_CTX *OSSL_HTTP_REQ_CTX_new(BIO *wbio, BIO *rbio, int buf_size)
29f178bd
DDO
91{
92 OSSL_HTTP_REQ_CTX *rctx;
93
94 if (wbio == NULL || rbio == NULL) {
9311d0c4 95 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
29f178bd
DDO
96 return NULL;
97 }
98
99 if ((rctx = OPENSSL_zalloc(sizeof(*rctx))) == NULL)
100 return NULL;
101 rctx->state = OHS_ERROR;
647a5dbf 102 rctx->buf_size = buf_size > 0 ? buf_size : OSSL_HTTP_DEFAULT_MAX_LINE_LEN;
e2c38c1a 103 rctx->buf = OPENSSL_malloc(rctx->buf_size);
29f178bd
DDO
104 rctx->wbio = wbio;
105 rctx->rbio = rbio;
e2c38c1a 106 if (rctx->buf == NULL) {
a6d40689 107 OPENSSL_free(rctx);
29f178bd
DDO
108 return NULL;
109 }
647a5dbf 110 rctx->max_resp_len = OSSL_HTTP_DEFAULT_MAX_RESP_LEN;
a6d40689 111 /* everything else is 0, e.g. rctx->len_to_send, or NULL, e.g. rctx->mem */
29f178bd
DDO
112 return rctx;
113}
114
115void OSSL_HTTP_REQ_CTX_free(OSSL_HTTP_REQ_CTX *rctx)
116{
117 if (rctx == NULL)
118 return;
19f97fe6
DDO
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 */
de5a0198
TM
127 BIO_free(rctx->mem);
128 BIO_free(rctx->req);
e2c38c1a 129 OPENSSL_free(rctx->buf);
19f97fe6
DDO
130 OPENSSL_free(rctx->proxy);
131 OPENSSL_free(rctx->server);
132 OPENSSL_free(rctx->port);
8f965908 133 OPENSSL_free(rctx->expected_ct);
29f178bd
DDO
134 OPENSSL_free(rctx);
135}
136
4d190f99 137BIO *OSSL_HTTP_REQ_CTX_get0_mem_bio(const OSSL_HTTP_REQ_CTX *rctx)
29f178bd
DDO
138{
139 if (rctx == NULL) {
9311d0c4 140 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
29f178bd
DDO
141 return NULL;
142 }
143 return rctx->mem;
144}
145
8f965908
DDO
146size_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
29f178bd
DDO
155void OSSL_HTTP_REQ_CTX_set_max_response_length(OSSL_HTTP_REQ_CTX *rctx,
156 unsigned long len)
157{
158 if (rctx == NULL) {
9311d0c4 159 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
29f178bd
DDO
160 return;
161 }
647a5dbf 162 rctx->max_resp_len = len != 0 ? (size_t)len : OSSL_HTTP_DEFAULT_MAX_RESP_LEN;
29f178bd
DDO
163}
164
165/*
534725fd 166 * Create request line using |rctx| and |path| (or "/" in case |path| is NULL).
29f178bd
DDO
167 * Server name (and port) must be given if and only if plain HTTP proxy is used.
168 */
534725fd 169int OSSL_HTTP_REQ_CTX_set_request_line(OSSL_HTTP_REQ_CTX *rctx, int method_POST,
cddbcf02
DDO
170 const char *server, const char *port,
171 const char *path)
29f178bd
DDO
172{
173 if (rctx == NULL) {
9311d0c4 174 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
29f178bd
DDO
175 return 0;
176 }
a6d40689
DDO
177 BIO_free(rctx->mem);
178 if ((rctx->mem = BIO_new(BIO_s_mem())) == NULL)
179 return 0;
29f178bd 180
534725fd 181 rctx->method_POST = method_POST != 0;
046fba44 182 if (BIO_printf(rctx->mem, "%s ", rctx->method_POST ? "POST" : "GET") <= 0)
29f178bd
DDO
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 */
4b1fe471 190 if (BIO_printf(rctx->mem, OSSL_HTTP_PREFIX"%s", server) <= 0)
29f178bd
DDO
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;
95c0b295
DDO
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 */
19f97fe6 205 if (BIO_printf(rctx->mem, "%s "HTTP_1_0"\r\n", path) <= 0)
29f178bd 206 return 0;
95c0b295 207
19f97fe6 208 rctx->resp_len = 0;
8b5ca511 209 rctx->state = OHS_ADD_HEADERS;
29f178bd
DDO
210 return 1;
211}
212
213int 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) {
9311d0c4 217 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
29f178bd
DDO
218 return 0;
219 }
a6d40689
DDO
220 if (rctx->mem == NULL) {
221 ERR_raise(ERR_LIB_HTTP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
222 return 0;
223 }
29f178bd
DDO
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 }
19f97fe6 233 return BIO_write(rctx->mem, "\r\n", 2) == 2;
29f178bd
DDO
234}
235
8f965908
DDO
236int 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
8b5ca511 245 && rctx->state != OHS_ERROR && rctx->state != OHS_ADD_HEADERS) {
8f965908
DDO
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;
6a1f9cdc 260 else /* take over any |overall_timeout| arg of OSSL_HTTP_open(), else 0 */
8f965908
DDO
261 rctx->max_time = rctx->max_total_time;
262 rctx->keep_alive = keep_alive;
263 return 1;
264}
265
de5a0198
TM
266static int set1_content(OSSL_HTTP_REQ_CTX *rctx,
267 const char *content_type, BIO *req)
29f178bd 268{
8c65e1f7
DDO
269 long req_len = 0;
270#ifndef OPENSSL_NO_STDIO
243465fd 271 FILE *fp = NULL;
8c65e1f7 272#endif
29f178bd 273
8b5ca511 274 if (rctx == NULL || (req == NULL && content_type != NULL)) {
9311d0c4 275 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
29f178bd
DDO
276 return 0;
277 }
19f97fe6
DDO
278
279 if (rctx->keep_alive != 0
280 && !OSSL_HTTP_REQ_CTX_add1_header(rctx, "Connection", "keep-alive"))
281 return 0;
19f97fe6 282
95c0b295
DDO
283 BIO_free(rctx->req);
284 rctx->req = NULL;
8b5ca511 285 if (req == NULL)
19f97fe6
DDO
286 return 1;
287 if (!rctx->method_POST) {
0a20cc4b
DDO
288 ERR_raise(ERR_LIB_HTTP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
289 return 0;
290 }
29f178bd
DDO
291
292 if (content_type != NULL
293 && BIO_printf(rctx->mem, "Content-Type: %s\r\n", content_type) <= 0)
294 return 0;
295
243465fd
DDO
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 */
8c65e1f7
DDO
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
243465fd
DDO
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 */
de5a0198 315 }
8c65e1f7
DDO
316 if ((
317#ifndef OPENSSL_NO_STDIO
318 fp != NULL /* definitely correct req_len */ ||
319#endif
320 req_len > 0)
243465fd
DDO
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;
29f178bd
DDO
328}
329
1c8505fb 330int OSSL_HTTP_REQ_CTX_set1_req(OSSL_HTTP_REQ_CTX *rctx, const char *content_type,
8f965908 331 const ASN1_ITEM *it, const ASN1_VALUE *req)
29f178bd 332{
95c0b295
DDO
333 BIO *mem = NULL;
334 int res = 1;
29f178bd 335
95c0b295
DDO
336 if (req != NULL)
337 res = (mem = ASN1_item_i2d_mem_bio(it, req)) != NULL;
338 res = res && set1_content(rctx, content_type, mem);
29f178bd
DDO
339 BIO_free(mem);
340 return res;
341}
342
e2c38c1a
DDO
343static int add1_headers(OSSL_HTTP_REQ_CTX *rctx,
344 const STACK_OF(CONF_VALUE) *headers, const char *host)
29f178bd
DDO
345{
346 int i;
19a39b29 347 int add_host = host != NULL && *host != '\0';
29f178bd
DDO
348 CONF_VALUE *hdr;
349
350 for (i = 0; i < sk_CONF_VALUE_num(headers); i++) {
351 hdr = sk_CONF_VALUE_value(headers, i);
fba140c7 352 if (add_host && OPENSSL_strcasecmp("host", hdr->name) == 0)
29f178bd
DDO
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
19f97fe6
DDO
363/* Create OSSL_HTTP_REQ_CTX structure using the values provided. */
364static 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,
be799eb7 369 int buf_size, int overall_timeout)
29f178bd 370{
19f97fe6 371 OSSL_HTTP_REQ_CTX *rctx = OSSL_HTTP_REQ_CTX_new(wbio, rbio, buf_size);
29f178bd 372
19f97fe6 373 if (rctx == NULL)
29f178bd 374 return NULL;
19f97fe6
DDO
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;
29f178bd 391
19f97fe6 392 err:
29f178bd
DDO
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".
e2b7dc35
DDO
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.
29f178bd
DDO
401 */
402
19f97fe6 403static int parse_http_line1(char *line, int *found_keep_alive)
29f178bd 404{
e2b7dc35 405 int i, retcode, err;
29f178bd
DDO
406 char *code, *reason, *end;
407
2ff286c2 408 if (!CHECK_AND_SKIP_PREFIX(line, HTTP_PREFIX_VERSION))
19f97fe6
DDO
409 goto err;
410 /* above HTTP 1.0, connection persistence is the default */
2ff286c2 411 *found_keep_alive = *line > '0';
19f97fe6 412
29f178bd
DDO
413 /* Skip to first whitespace (past protocol info) */
414 for (code = line; *code != '\0' && !ossl_isspace(*code); code++)
415 continue;
19f97fe6
DDO
416 if (*code == '\0')
417 goto err;
29f178bd
DDO
418
419 /* Skip past whitespace to start of response code */
420 while (*code != '\0' && ossl_isspace(*code))
421 code++;
19f97fe6
DDO
422 if (*code == '\0')
423 goto err;
29f178bd
DDO
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
19f97fe6
DDO
429 if (*reason == '\0')
430 goto err;
29f178bd
DDO
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);
29f178bd 437 if (*end != '\0')
19f97fe6 438 goto err;
29f178bd
DDO
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:
e2b7dc35 461 err = HTTP_R_RECEIVED_ERROR;
29f178bd 462 if (retcode < 400)
e2b7dc35 463 err = HTTP_R_STATUS_CODE_UNSUPPORTED;
29f178bd 464 if (*reason == '\0')
e2b7dc35 465 ERR_raise_data(ERR_LIB_HTTP, err, "code=%s", code);
29f178bd 466 else
e2b7dc35
DDO
467 ERR_raise_data(ERR_LIB_HTTP, err, "code=%s, reason=%s", code,
468 reason);
469 return retcode;
29f178bd 470 }
19f97fe6
DDO
471
472 err:
e2b7dc35
DDO
473 for (i = 0; i < 60 && line[i] != '\0'; i++)
474 if (!ossl_isprint(line[i]))
475 line[i] = ' ';
be799eb7
DDO
476 line[i] = '\0';
477 ERR_raise_data(ERR_LIB_HTTP, HTTP_R_HEADER_PARSE_ERROR, "content=%s", line);
19f97fe6 478 return 0;
29f178bd
DDO
479}
480
be799eb7 481static int check_set_resp_len(OSSL_HTTP_REQ_CTX *rctx, size_t len)
29f178bd 482{
be799eb7 483 if (rctx->max_resp_len != 0 && len > rctx->max_resp_len)
a150f8e1 484 ERR_raise_data(ERR_LIB_HTTP, HTTP_R_MAX_RESP_LEN_EXCEEDED,
be799eb7 485 "length=%zu, max=%zu", len, rctx->max_resp_len);
a150f8e1
RL
486 if (rctx->resp_len != 0 && rctx->resp_len != len)
487 ERR_raise_data(ERR_LIB_HTTP, HTTP_R_INCONSISTENT_CONTENT_LENGTH,
be799eb7 488 "ASN.1 length=%zu, Content-Length=%zu",
d337af18 489 len, rctx->resp_len);
29f178bd
DDO
490 rctx->resp_len = len;
491 return 1;
492}
493
f0d5a3b6
DDO
494static 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
29f178bd
DDO
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 */
513int OSSL_HTTP_REQ_CTX_nbio(OSSL_HTTP_REQ_CTX *rctx)
514{
19f97fe6 515 int i, found_expected_ct = 0, found_keep_alive = 0;
e8fdb060 516 int found_text_ct = 0;
673474b1 517 long n;
be799eb7 518 size_t resp_len;
29f178bd 519 const unsigned char *p;
606c79e2 520 char *buf, *key, *value, *line_end = NULL;
29f178bd
DDO
521
522 if (rctx == NULL) {
9311d0c4 523 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
29f178bd
DDO
524 return 0;
525 }
a6d40689
DDO
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 }
29f178bd
DDO
530
531 rctx->redirection_url = NULL;
532 next_io:
606c79e2 533 buf = (char *)rctx->buf;
29f178bd 534 if ((rctx->state & OHS_NOREAD) == 0) {
606c79e2 535 if (rctx->expect_asn1) {
e2c38c1a 536 n = BIO_read(rctx->rbio, rctx->buf, rctx->buf_size);
606c79e2
DDO
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 }
29f178bd
DDO
547 if (n <= 0) {
548 if (BIO_should_retry(rctx->rbio))
549 return -1;
a6d40689 550 ERR_raise(ERR_LIB_HTTP, HTTP_R_FAILED_READING_DATA);
29f178bd
DDO
551 return 0;
552 }
553
554 /* Write data to memory BIO */
e2c38c1a 555 if (BIO_write(rctx->mem, rctx->buf, n) != n)
29f178bd
DDO
556 return 0;
557 }
558
559 switch (rctx->state) {
8b5ca511 560 case OHS_ADD_HEADERS:
29f178bd
DDO
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:
8b5ca511
DDO
570 rctx->len_to_send = BIO_get_mem_data(rctx->mem, &rctx->pos);
571 rctx->state = OHS_WRITE_HDR;
e8fdb060
DDO
572 if (OSSL_TRACE_ENABLED(HTTP))
573 OSSL_TRACE(HTTP, "Sending request header:\n");
29f178bd
DDO
574
575 /* fall thru */
8b5ca511
DDO
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) {
e8fdb060
DDO
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
8b5ca511
DDO
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;
29f178bd 596 }
8b5ca511
DDO
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)) {
e2c38c1a 602 n = BIO_read(rctx->req, rctx->buf, rctx->buf_size);
8b5ca511 603 if (n <= 0) {
059a4ad0 604 if (BIO_should_retry(rctx->req))
8b5ca511
DDO
605 return -1;
606 ERR_raise(ERR_LIB_HTTP, HTTP_R_FAILED_READING_DATA);
607 return 0;
608 }
e2c38c1a 609 rctx->pos = rctx->buf;
8b5ca511 610 rctx->len_to_send = n;
29f178bd 611 goto next_io;
8b5ca511 612 }
29f178bd
DDO
613 rctx->state = OHS_FLUSH;
614
29f178bd
DDO
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) {
e2c38c1a 647 if (n >= rctx->buf_size) {
29f178bd
DDO
648 rctx->state = OHS_ERROR;
649 return 0;
650 }
651 goto next_io;
652 }
606c79e2 653 n = BIO_gets(rctx->mem, buf, rctx->buf_size);
29f178bd
DDO
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 */
e2c38c1a 663 if (n == rctx->buf_size) {
9311d0c4 664 ERR_raise(ERR_LIB_HTTP, HTTP_R_RESPONSE_LINE_TOO_LONG);
29f178bd
DDO
665 rctx->state = OHS_ERROR;
666 return 0;
667 }
668
e8fdb060
DDO
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
29f178bd
DDO
676 /* First line */
677 if (rctx->state == OHS_FIRSTLINE) {
606c79e2 678 switch (parse_http_line1(buf, &found_keep_alive)) {
29f178bd
DDO
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 */
046fba44 684 if (!rctx->method_POST) { /* method is GET */
29f178bd
DDO
685 rctx->state = OHS_REDIRECT;
686 goto next_line;
687 }
9311d0c4 688 ERR_raise(ERR_LIB_HTTP, HTTP_R_REDIRECTION_NOT_ENABLED);
29f178bd
DDO
689 /* redirection is not supported/recommended for POST */
690 /* fall through */
691 default:
692 rctx->state = OHS_ERROR;
38288f42 693 goto next_line;
29f178bd
DDO
694 }
695 }
606c79e2 696 key = buf;
29f178bd
DDO
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) {
afe554c2 709 if (rctx->state == OHS_REDIRECT
fba140c7 710 && OPENSSL_strcasecmp(key, "Location") == 0) {
29f178bd
DDO
711 rctx->redirection_url = value;
712 return 0;
713 }
e8fdb060
DDO
714 if (OPENSSL_strcasecmp(key, "Content-Type") == 0) {
715 if (rctx->state == OHS_HEADERS
716 && rctx->expected_ct != NULL) {
717 if (OPENSSL_strcasecmp(rctx->expected_ct, value) != 0) {
718 ERR_raise_data(ERR_LIB_HTTP,
719 HTTP_R_UNEXPECTED_CONTENT_TYPE,
720 "expected=%s, actual=%s",
721 rctx->expected_ct, value);
722 return 0;
723 }
724 found_expected_ct = 1;
29f178bd 725 }
e8fdb060
DDO
726 if (OPENSSL_strncasecmp(value, "text/", 5) == 0)
727 found_text_ct = 1;
19f97fe6
DDO
728 }
729
730 /* https://tools.ietf.org/html/rfc7230#section-6.3 Persistence */
fba140c7
DB
731 if (OPENSSL_strcasecmp(key, "Connection") == 0) {
732 if (OPENSSL_strcasecmp(value, "keep-alive") == 0)
19f97fe6 733 found_keep_alive = 1;
fba140c7 734 else if (OPENSSL_strcasecmp(value, "close") == 0)
19f97fe6 735 found_keep_alive = 0;
fba140c7 736 } else if (OPENSSL_strcasecmp(key, "Content-Length") == 0) {
be799eb7 737 resp_len = (size_t)strtoul(value, &line_end, 10);
29f178bd 738 if (line_end == value || *line_end != '\0') {
a150f8e1
RL
739 ERR_raise_data(ERR_LIB_HTTP,
740 HTTP_R_ERROR_PARSING_CONTENT_LENGTH,
741 "input=%s", value);
29f178bd
DDO
742 return 0;
743 }
744 if (!check_set_resp_len(rctx, resp_len))
745 return 0;
746 }
747 }
748
d337af18 749 /* Look for blank line indicating end of headers */
e2c38c1a 750 for (p = rctx->buf; *p != '\0'; p++) {
29f178bd
DDO
751 if (*p != '\r' && *p != '\n')
752 break;
753 }
754 if (*p != '\0') /* not end of headers */
755 goto next_line;
756
19f97fe6
DDO
757 if (rctx->keep_alive != 0 /* do not let server initiate keep_alive */
758 && !found_keep_alive /* otherwise there is no change */) {
759 if (rctx->keep_alive == 2) {
760 rctx->keep_alive = 0;
761 ERR_raise(ERR_LIB_HTTP, HTTP_R_SERVER_CANCELED_CONNECTION);
762 return 0;
763 }
764 rctx->keep_alive = 0;
765 }
766
e8fdb060
DDO
767 if (rctx->state == OHS_ERROR) {
768 if (OSSL_TRACE_ENABLED(HTTP)
769 && found_text_ct && BIO_get_mem_data(rctx->mem, &p) > 0)
770 OSSL_TRACE1(HTTP, "%s", p);
38288f42 771 return 0;
e8fdb060 772 }
38288f42
DDO
773
774 if (rctx->expected_ct != NULL && !found_expected_ct) {
775 ERR_raise_data(ERR_LIB_HTTP, HTTP_R_MISSING_CONTENT_TYPE,
776 "expected=%s", rctx->expected_ct);
777 return 0;
778 }
29f178bd
DDO
779 if (rctx->state == OHS_REDIRECT) {
780 /* http status code indicated redirect but there was no Location */
9311d0c4 781 ERR_raise(ERR_LIB_HTTP, HTTP_R_MISSING_REDIRECT_LOCATION);
29f178bd
DDO
782 return 0;
783 }
784
785 if (!rctx->expect_asn1) {
be799eb7
DDO
786 rctx->state = OHS_STREAM;
787 return 1;
29f178bd
DDO
788 }
789
790 rctx->state = OHS_ASN1_HEADER;
791
792 /* Fall thru */
793 case OHS_ASN1_HEADER:
794 /*
795 * Now reading ASN1 header: can read at least 2 bytes which is enough
796 * for ASN1 SEQUENCE header and either length field or at least the
797 * length of the length field.
798 */
799 n = BIO_get_mem_data(rctx->mem, &p);
800 if (n < 2)
801 goto next_io;
802
803 /* Check it is an ASN1 SEQUENCE */
804 if (*p++ != (V_ASN1_SEQUENCE | V_ASN1_CONSTRUCTED)) {
9311d0c4 805 ERR_raise(ERR_LIB_HTTP, HTTP_R_MISSING_ASN1_ENCODING);
29f178bd
DDO
806 return 0;
807 }
808
809 /* Check out length field */
810 if ((*p & 0x80) != 0) {
811 /*
812 * If MSB set on initial length octet we can now always read 6
813 * octets: make sure we have them.
814 */
815 if (n < 6)
816 goto next_io;
817 n = *p & 0x7F;
818 /* Not NDEF or excessive length */
819 if (n == 0 || (n > 4)) {
9311d0c4 820 ERR_raise(ERR_LIB_HTTP, HTTP_R_ERROR_PARSING_ASN1_LENGTH);
29f178bd
DDO
821 return 0;
822 }
823 p++;
824 resp_len = 0;
825 for (i = 0; i < n; i++) {
826 resp_len <<= 8;
827 resp_len |= *p++;
828 }
829 resp_len += n + 2;
830 } else {
831 resp_len = *p + 2;
832 }
833 if (!check_set_resp_len(rctx, resp_len))
834 return 0;
835
be799eb7 836 rctx->state = OHS_ASN1_CONTENT;
29f178bd
DDO
837
838 /* Fall thru */
be799eb7 839 case OHS_ASN1_CONTENT:
29f178bd
DDO
840 default:
841 n = BIO_get_mem_data(rctx->mem, NULL);
be799eb7 842 if (n < 0 || (size_t)n < rctx->resp_len)
29f178bd
DDO
843 goto next_io;
844
be799eb7 845 rctx->state = OHS_ASN1_DONE;
29f178bd
DDO
846 return 1;
847 }
848}
849
8f965908
DDO
850int OSSL_HTTP_REQ_CTX_nbio_d2i(OSSL_HTTP_REQ_CTX *rctx,
851 ASN1_VALUE **pval, const ASN1_ITEM *it)
852{
853 const unsigned char *p;
854 int rv;
855
856 *pval = NULL;
857 if ((rv = OSSL_HTTP_REQ_CTX_nbio(rctx)) != 1)
858 return rv;
859 *pval = ASN1_item_d2i(NULL, &p, BIO_get_mem_data(rctx->mem, &p), it);
860 return *pval != NULL;
861
862}
863
29f178bd
DDO
864#ifndef OPENSSL_NO_SOCK
865
866/* set up a new connection BIO, to HTTP server or to HTTP(S) proxy if given */
e2c38c1a 867static BIO *http_new_bio(const char *server /* optionally includes ":port" */,
afe554c2 868 const char *server_port /* explicit server port */,
79a2bccd
DDO
869 int use_ssl,
870 const char *proxy /* optionally includes ":port" */,
871 const char *proxy_port /* explicit proxy port */)
29f178bd 872{
79a2bccd 873 const char *host = server;
29f178bd
DDO
874 const char *port = server_port;
875 BIO *cbio;
876
4b1fe471 877 if (!ossl_assert(server != NULL))
29f178bd 878 return NULL;
29f178bd
DDO
879
880 if (proxy != NULL) {
881 host = proxy;
79a2bccd 882 port = proxy_port;
29f178bd 883 }
afe554c2 884
79a2bccd
DDO
885 if (port == NULL && strchr(host, ':') == NULL)
886 port = use_ssl ? OSSL_HTTPS_PORT : OSSL_HTTP_PORT;
afe554c2
DDO
887
888 cbio = BIO_new_connect(host /* optionally includes ":port" */);
29f178bd
DDO
889 if (cbio == NULL)
890 goto end;
891 if (port != NULL)
892 (void)BIO_set_conn_port(cbio, port);
893
894 end:
895 return cbio;
896}
e8d0819d 897#endif /* OPENSSL_NO_SOCK */
29f178bd 898
82990287 899/* Exchange request and response via HTTP on (non-)blocking BIO */
8f965908 900BIO *OSSL_HTTP_REQ_CTX_exchange(OSSL_HTTP_REQ_CTX *rctx)
29f178bd 901{
29f178bd
DDO
902 int rv;
903
904 if (rctx == NULL) {
9311d0c4 905 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
29f178bd
DDO
906 return NULL;
907 }
908
909 for (;;) {
910 rv = OSSL_HTTP_REQ_CTX_nbio(rctx);
911 if (rv != -1)
912 break;
913 /* BIO_should_retry was true */
29f178bd 914 /* will not actually wait if rctx->max_time == 0 */
e8d0819d 915 if (BIO_wait(rctx->rbio, rctx->max_time, 100 /* milliseconds */) <= 0)
29f178bd
DDO
916 return NULL;
917 }
918
919 if (rv == 0) {
920 if (rctx->redirection_url == NULL) { /* an error occurred */
1e6174b1 921 if (rctx->len_to_send > 0)
9311d0c4 922 ERR_raise(ERR_LIB_HTTP, HTTP_R_ERROR_SENDING);
29f178bd 923 else
9311d0c4 924 ERR_raise(ERR_LIB_HTTP, HTTP_R_ERROR_RECEIVING);
29f178bd
DDO
925 }
926 return NULL;
927 }
be799eb7 928 return rctx->state == OHS_STREAM ? rctx->rbio : rctx->mem;
29f178bd
DDO
929}
930
19f97fe6 931int OSSL_HTTP_is_alive(const OSSL_HTTP_REQ_CTX *rctx)
29f178bd 932{
19f97fe6 933 return rctx != NULL && rctx->keep_alive != 0;
29f178bd
DDO
934}
935
19f97fe6
DDO
936/* High-level HTTP API implementation */
937
938/* Initiate an HTTP session using bio, else use given server, proxy, etc. */
8f965908
DDO
939OSSL_HTTP_REQ_CTX *OSSL_HTTP_open(const char *server, const char *port,
940 const char *proxy, const char *no_proxy,
941 int use_ssl, BIO *bio, BIO *rbio,
942 OSSL_HTTP_bio_cb_t bio_update_fn, void *arg,
be799eb7 943 int buf_size, int overall_timeout)
8f965908 944{
19f97fe6
DDO
945 BIO *cbio; /* == bio if supplied, used as connection BIO if rbio is NULL */
946 OSSL_HTTP_REQ_CTX *rctx = NULL;
29f178bd
DDO
947
948 if (use_ssl && bio_update_fn == NULL) {
9311d0c4 949 ERR_raise(ERR_LIB_HTTP, HTTP_R_TLS_NOT_ENABLED);
29f178bd
DDO
950 return NULL;
951 }
952 if (rbio != NULL && (bio == NULL || bio_update_fn != NULL)) {
9311d0c4 953 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_INVALID_ARGUMENT);
29f178bd
DDO
954 return NULL;
955 }
29f178bd 956
4b1fe471 957 if (bio != NULL) {
29f178bd 958 cbio = bio;
82990287
DDO
959 if (proxy != NULL || no_proxy != NULL) {
960 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_INVALID_ARGUMENT);
961 return NULL;
962 }
4b1fe471 963 } else {
e8d0819d 964#ifndef OPENSSL_NO_SOCK
79a2bccd
DDO
965 char *proxy_host = NULL, *proxy_port = NULL;
966
4b1fe471 967 if (server == NULL) {
9311d0c4 968 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
4b1fe471
DDO
969 return NULL;
970 }
19f97fe6 971 if (port != NULL && *port == '\0')
4b1fe471
DDO
972 port = NULL;
973 if (port == NULL && strchr(server, ':') == NULL)
974 port = use_ssl ? OSSL_HTTPS_PORT : OSSL_HTTP_PORT;
ab9d67ef 975 proxy = OSSL_HTTP_adapt_proxy(proxy, no_proxy, server, use_ssl);
79a2bccd
DDO
976 if (proxy != NULL
977 && !OSSL_HTTP_parse_url(proxy, NULL /* use_ssl */, NULL /* user */,
978 &proxy_host, &proxy_port, NULL /* num */,
979 NULL /* path */, NULL, NULL))
980 return NULL;
e2c38c1a 981 cbio = http_new_bio(server, port, use_ssl, proxy_host, proxy_port);
79a2bccd
DDO
982 OPENSSL_free(proxy_host);
983 OPENSSL_free(proxy_port);
984 if (cbio == NULL)
e8d0819d
DDO
985 return NULL;
986#else
9311d0c4 987 ERR_raise(ERR_LIB_HTTP, HTTP_R_SOCK_NOT_SUPPORTED);
29f178bd 988 return NULL;
e8d0819d 989#endif
4b1fe471 990 }
29f178bd
DDO
991
992 (void)ERR_set_mark(); /* prepare removing any spurious libssl errors */
19f97fe6
DDO
993 if (rbio == NULL && BIO_do_connect_retry(cbio, overall_timeout, -1) <= 0) {
994 if (bio == NULL) /* cbio was not provided by caller */
995 BIO_free_all(cbio);
29f178bd 996 goto end;
19f97fe6
DDO
997 }
998 /* now overall_timeout is guaranteed to be >= 0 */
29f178bd 999
068549f8 1000 /* adapt in order to fix callback design flaw, see #17088 */
29f178bd
DDO
1001 /* callback can be used to wrap or prepend TLS session */
1002 if (bio_update_fn != NULL) {
1003 BIO *orig_bio = cbio;
19f97fe6 1004
35750cb9 1005 cbio = (*bio_update_fn)(cbio, arg, 1 /* connect */, use_ssl != 0);
29f178bd 1006 if (cbio == NULL) {
981a5b7c
DDO
1007 if (bio == NULL) /* cbio was not provided by caller */
1008 BIO_free_all(orig_bio);
29f178bd
DDO
1009 goto end;
1010 }
1011 }
1012
19f97fe6
DDO
1013 rctx = http_req_ctx_new(bio == NULL, cbio, rbio != NULL ? rbio : cbio,
1014 bio_update_fn, arg, use_ssl, proxy, server, port,
be799eb7 1015 buf_size, overall_timeout);
19f97fe6
DDO
1016
1017 end:
1018 if (rctx != NULL)
1019 /* remove any spurious error queue entries by ssl_add_cert_chain() */
1020 (void)ERR_pop_to_mark();
1021 else
1022 (void)ERR_clear_last_mark();
1023
1024 return rctx;
1025}
1026
8ccbf00d
DDO
1027int OSSL_HTTP_set1_request(OSSL_HTTP_REQ_CTX *rctx, const char *path,
1028 const STACK_OF(CONF_VALUE) *headers,
1029 const char *content_type, BIO *req,
1030 const char *expected_content_type, int expect_asn1,
1031 size_t max_resp_len, int timeout, int keep_alive)
19f97fe6
DDO
1032{
1033 int use_http_proxy;
1034
1035 if (rctx == NULL) {
1036 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
1037 return 0;
1038 }
1039 use_http_proxy = rctx->proxy != NULL && !rctx->use_ssl;
266383b4 1040 if (use_http_proxy && rctx->server == NULL) {
19f97fe6
DDO
1041 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_INVALID_ARGUMENT);
1042 return 0;
1043 }
be799eb7 1044 rctx->max_resp_len = max_resp_len; /* allows for 0: indefinite */
19f97fe6 1045
8b5ca511 1046 return OSSL_HTTP_REQ_CTX_set_request_line(rctx, req != NULL,
19f97fe6
DDO
1047 use_http_proxy ? rctx->server
1048 : NULL, rctx->port, path)
e2c38c1a 1049 && add1_headers(rctx, headers, rctx->server)
19f97fe6
DDO
1050 && OSSL_HTTP_REQ_CTX_set_expected(rctx, expected_content_type,
1051 expect_asn1, timeout, keep_alive)
de5a0198 1052 && set1_content(rctx, content_type, req);
19f97fe6
DDO
1053}
1054
1055/*-
1056 * Exchange single HTTP request and response according to rctx.
1057 * If rctx->method_POST then use POST, else use GET and ignore content_type.
1058 * The redirection_url output (freed by caller) parameter is used only for GET.
1059 */
1060BIO *OSSL_HTTP_exchange(OSSL_HTTP_REQ_CTX *rctx, char **redirection_url)
1061{
1062 BIO *resp;
1063
1064 if (rctx == NULL) {
1065 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
1066 return NULL;
1067 }
1068
1069 if (redirection_url != NULL)
1070 *redirection_url = NULL; /* do this beforehand to prevent dbl free */
29f178bd 1071
8f965908 1072 resp = OSSL_HTTP_REQ_CTX_exchange(rctx);
29f178bd
DDO
1073 if (resp == NULL) {
1074 if (rctx->redirection_url != NULL) {
1075 if (redirection_url == NULL)
9311d0c4 1076 ERR_raise(ERR_LIB_HTTP, HTTP_R_REDIRECTION_NOT_ENABLED);
29f178bd
DDO
1077 else
1078 /* may be NULL if out of memory: */
1079 *redirection_url = OPENSSL_strdup(rctx->redirection_url);
1080 } else {
1081 char buf[200];
1082 unsigned long err = ERR_peek_error();
1083 int lib = ERR_GET_LIB(err);
1084 int reason = ERR_GET_REASON(err);
1085
1086 if (lib == ERR_LIB_SSL || lib == ERR_LIB_HTTP
1087 || (lib == ERR_LIB_BIO && reason == BIO_R_CONNECT_TIMEOUT)
1088 || (lib == ERR_LIB_BIO && reason == BIO_R_CONNECT_ERROR)
4b1fe471 1089#ifndef OPENSSL_NO_CMP
29f178bd 1090 || (lib == ERR_LIB_CMP
100cc8b0 1091 && reason == CMP_R_POTENTIALLY_INVALID_CERTIFICATE)
4b1fe471 1092#endif
100cc8b0 1093 ) {
19f97fe6 1094 if (rctx->server != NULL) {
22fe2b12
DDO
1095 BIO_snprintf(buf, sizeof(buf), "server=http%s://%s%s%s",
1096 rctx->use_ssl ? "s" : "", rctx->server,
1097 rctx->port != NULL ? ":" : "",
1098 rctx->port != NULL ? rctx->port : "");
1099 ERR_add_error_data(1, buf);
19f97fe6 1100 }
19f97fe6
DDO
1101 if (rctx->proxy != NULL)
1102 ERR_add_error_data(2, " proxy=", rctx->proxy);
29f178bd 1103 if (err == 0) {
22fe2b12 1104 BIO_snprintf(buf, sizeof(buf), " peer has disconnected%s",
19f97fe6 1105 rctx->use_ssl ? " violating the protocol" :
29f178bd
DDO
1106 ", likely because it requires the use of TLS");
1107 ERR_add_error_data(1, buf);
1108 }
1109 }
1110 }
1111 }
6466cc97
DDO
1112
1113 if (resp != NULL && !BIO_up_ref(resp))
1114 resp = NULL;
29f178bd
DDO
1115 return resp;
1116}
1117
1118static int redirection_ok(int n_redir, const char *old_url, const char *new_url)
1119{
29f178bd 1120 if (n_redir >= HTTP_VERSION_MAX_REDIRECTIONS) {
9311d0c4 1121 ERR_raise(ERR_LIB_HTTP, HTTP_R_TOO_MANY_REDIRECTIONS);
29f178bd
DDO
1122 return 0;
1123 }
1124 if (*new_url == '/') /* redirection to same server => same protocol */
1125 return 1;
b6fec965
DDO
1126 if (HAS_PREFIX(old_url, OSSL_HTTPS_NAME":") &&
1127 !HAS_PREFIX(new_url, OSSL_HTTPS_NAME":")) {
9311d0c4 1128 ERR_raise(ERR_LIB_HTTP, HTTP_R_REDIRECTION_FROM_HTTPS_TO_HTTP);
29f178bd
DDO
1129 return 0;
1130 }
1131 return 1;
1132}
1133
1134/* Get data via HTTP from server at given URL, potentially with redirection */
afe554c2 1135BIO *OSSL_HTTP_get(const char *url, const char *proxy, const char *no_proxy,
29f178bd
DDO
1136 BIO *bio, BIO *rbio,
1137 OSSL_HTTP_bio_cb_t bio_update_fn, void *arg,
68bb06f7 1138 int buf_size, const STACK_OF(CONF_VALUE) *headers,
8f965908 1139 const char *expected_ct, int expect_asn1,
c4005c8b 1140 size_t max_resp_len, int timeout)
29f178bd 1141{
8f965908 1142 char *current_url, *redirection_url = NULL;
29f178bd
DDO
1143 int n_redirs = 0;
1144 char *host;
1145 char *port;
1146 char *path;
1147 int use_ssl;
19f97fe6 1148 OSSL_HTTP_REQ_CTX *rctx;
29f178bd 1149 BIO *resp = NULL;
f0d5a3b6 1150 time_t max_time = timeout > 0 ? time(NULL) + timeout : 0;
29f178bd
DDO
1151
1152 if (url == NULL) {
9311d0c4 1153 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
29f178bd
DDO
1154 return NULL;
1155 }
1156 if ((current_url = OPENSSL_strdup(url)) == NULL)
1157 return NULL;
1158
1159 for (;;) {
7932982b
DDO
1160 if (!OSSL_HTTP_parse_url(current_url, &use_ssl, NULL /* user */, &host,
1161 &port, NULL /* port_num */, &path, NULL, NULL))
29f178bd
DDO
1162 break;
1163
19f97fe6
DDO
1164 rctx = OSSL_HTTP_open(host, port, proxy, no_proxy,
1165 use_ssl, bio, rbio, bio_update_fn, arg,
be799eb7 1166 buf_size, timeout);
8801240b 1167 new_rpath:
19f97fe6 1168 if (rctx != NULL) {
8ccbf00d
DDO
1169 if (!OSSL_HTTP_set1_request(rctx, path, headers,
1170 NULL /* content_type */,
1171 NULL /* req */,
1172 expected_ct, expect_asn1, max_resp_len,
1173 -1 /* use same max time (timeout) */,
1174 0 /* no keep_alive */))
19f97fe6 1175 OSSL_HTTP_REQ_CTX_free(rctx);
8801240b 1176 else
19f97fe6 1177 resp = OSSL_HTTP_exchange(rctx, &redirection_url);
19f97fe6 1178 }
29f178bd
DDO
1179 OPENSSL_free(path);
1180 if (resp == NULL && redirection_url != NULL) {
f0d5a3b6
DDO
1181 if (redirection_ok(++n_redirs, current_url, redirection_url)
1182 && may_still_retry(max_time, &timeout)) {
29f178bd
DDO
1183 (void)BIO_reset(bio);
1184 OPENSSL_free(current_url);
1185 current_url = redirection_url;
1186 if (*redirection_url == '/') { /* redirection to same server */
1187 path = OPENSSL_strdup(redirection_url);
816d6e57
JJ
1188 if (path == NULL) {
1189 OPENSSL_free(host);
1190 OPENSSL_free(port);
1191 (void)OSSL_HTTP_close(rctx, 1);
1192 BIO_free(resp);
1193 OPENSSL_free(current_url);
1194 return NULL;
1195 }
29f178bd
DDO
1196 goto new_rpath;
1197 }
1198 OPENSSL_free(host);
1199 OPENSSL_free(port);
8801240b 1200 (void)OSSL_HTTP_close(rctx, 1);
29f178bd
DDO
1201 continue;
1202 }
8801240b 1203 /* if redirection not allowed, ignore it */
29f178bd
DDO
1204 OPENSSL_free(redirection_url);
1205 }
1206 OPENSSL_free(host);
1207 OPENSSL_free(port);
8801240b
DDO
1208 if (!OSSL_HTTP_close(rctx, resp != NULL)) {
1209 BIO_free(resp);
1210 resp = NULL;
1211 }
29f178bd
DDO
1212 break;
1213 }
1214 OPENSSL_free(current_url);
1215 return resp;
1216}
1217
82990287 1218/* Exchange request and response over a connection managed via |prctx| */
19f97fe6
DDO
1219BIO *OSSL_HTTP_transfer(OSSL_HTTP_REQ_CTX **prctx,
1220 const char *server, const char *port,
1221 const char *path, int use_ssl,
1222 const char *proxy, const char *no_proxy,
1223 BIO *bio, BIO *rbio,
1224 OSSL_HTTP_bio_cb_t bio_update_fn, void *arg,
1225 int buf_size, const STACK_OF(CONF_VALUE) *headers,
1226 const char *content_type, BIO *req,
1227 const char *expected_ct, int expect_asn1,
be799eb7 1228 size_t max_resp_len, int timeout, int keep_alive)
19f97fe6
DDO
1229{
1230 OSSL_HTTP_REQ_CTX *rctx = prctx == NULL ? NULL : *prctx;
1231 BIO *resp = NULL;
1232
1233 if (rctx == NULL) {
1234 rctx = OSSL_HTTP_open(server, port, proxy, no_proxy,
1235 use_ssl, bio, rbio, bio_update_fn, arg,
be799eb7 1236 buf_size, timeout);
19f97fe6
DDO
1237 timeout = -1; /* Already set during opening the connection */
1238 }
1239 if (rctx != NULL) {
8ccbf00d
DDO
1240 if (OSSL_HTTP_set1_request(rctx, path, headers, content_type, req,
1241 expected_ct, expect_asn1,
1242 max_resp_len, timeout, keep_alive))
19f97fe6
DDO
1243 resp = OSSL_HTTP_exchange(rctx, NULL);
1244 if (resp == NULL || !OSSL_HTTP_is_alive(rctx)) {
82990287
DDO
1245 if (!OSSL_HTTP_close(rctx, resp != NULL)) {
1246 BIO_free(resp);
19f97fe6 1247 resp = NULL;
82990287 1248 }
19f97fe6
DDO
1249 rctx = NULL;
1250 }
1251 }
1252 if (prctx != NULL)
1253 *prctx = rctx;
1254 return resp;
1255}
1256
8f965908 1257int OSSL_HTTP_close(OSSL_HTTP_REQ_CTX *rctx, int ok)
29f178bd 1258{
cdaf072f 1259 BIO *wbio;
19f97fe6
DDO
1260 int ret = 1;
1261
cdaf072f
DDO
1262 /* callback can be used to finish TLS session and free its BIO */
1263 if (rctx != NULL && rctx->upd_fn != NULL) {
1264 wbio = (*rctx->upd_fn)(rctx->wbio, rctx->upd_arg,
1265 0 /* disconnect */, ok);
1266 ret = wbio != NULL;
1267 if (ret)
1268 rctx->wbio = wbio;
1269 }
19f97fe6
DDO
1270 OSSL_HTTP_REQ_CTX_free(rctx);
1271 return ret;
29f178bd
DDO
1272}
1273
1274/* BASE64 encoder used for encoding basic proxy authentication credentials */
1275static char *base64encode(const void *buf, size_t len)
1276{
1277 int i;
1278 size_t outl;
1279 char *out;
1280
1281 /* Calculate size of encoded data */
1282 outl = (len / 3);
1283 if (len % 3 > 0)
1284 outl++;
1285 outl <<= 2;
1286 out = OPENSSL_malloc(outl + 1);
1287 if (out == NULL)
1288 return 0;
1289
1290 i = EVP_EncodeBlock((unsigned char *)out, buf, len);
1291 if (!ossl_assert(0 <= i && (size_t)i <= outl)) {
1292 OPENSSL_free(out);
1293 return NULL;
1294 }
1295 return out;
1296}
1297
1298/*
1299 * Promote the given connection BIO using the CONNECT method for a TLS proxy.
1300 * This is typically called by an app, so bio_err and prog are used unless NULL
1301 * to print additional diagnostic information in a user-oriented way.
1302 */
1303int OSSL_HTTP_proxy_connect(BIO *bio, const char *server, const char *port,
1304 const char *proxyuser, const char *proxypass,
1305 int timeout, BIO *bio_err, const char *prog)
1306{
4b1fe471
DDO
1307#undef BUF_SIZE
1308#define BUF_SIZE (8 * 1024)
29f178bd
DDO
1309 char *mbuf = OPENSSL_malloc(BUF_SIZE);
1310 char *mbufp;
1311 int read_len = 0;
29f178bd
DDO
1312 int ret = 0;
1313 BIO *fbio = BIO_new(BIO_f_buffer());
e8d0819d 1314 int rv;
29f178bd
DDO
1315 time_t max_time = timeout > 0 ? time(NULL) + timeout : 0;
1316
4b1fe471 1317 if (bio == NULL || server == NULL
29f178bd 1318 || (bio_err != NULL && prog == NULL)) {
9311d0c4 1319 ERR_raise(ERR_LIB_HTTP, ERR_R_PASSED_NULL_PARAMETER);
29f178bd
DDO
1320 goto end;
1321 }
4b1fe471
DDO
1322 if (port == NULL || *port == '\0')
1323 port = OSSL_HTTPS_PORT;
29f178bd
DDO
1324
1325 if (mbuf == NULL || fbio == NULL) {
1326 BIO_printf(bio_err /* may be NULL */, "%s: out of memory", prog);
1327 goto end;
1328 }
1329 BIO_push(fbio, bio);
1330
19f97fe6 1331 BIO_printf(fbio, "CONNECT %s:%s "HTTP_1_0"\r\n", server, port);
29f178bd
DDO
1332
1333 /*
1334 * Workaround for broken proxies which would otherwise close
1335 * the connection when entering tunnel mode (e.g., Squid 2.6)
1336 */
1337 BIO_printf(fbio, "Proxy-Connection: Keep-Alive\r\n");
1338
1339 /* Support for basic (base64) proxy authentication */
1340 if (proxyuser != NULL) {
1341 size_t len = strlen(proxyuser) + 1;
1342 char *proxyauth, *proxyauthenc = NULL;
1343
1344 if (proxypass != NULL)
1345 len += strlen(proxypass);
1346 proxyauth = OPENSSL_malloc(len + 1);
1347 if (proxyauth == NULL)
1348 goto end;
1349 if (BIO_snprintf(proxyauth, len + 1, "%s:%s", proxyuser,
1350 proxypass != NULL ? proxypass : "") != (int)len)
1351 goto proxy_end;
1352 proxyauthenc = base64encode(proxyauth, len);
1353 if (proxyauthenc != NULL) {
1354 BIO_printf(fbio, "Proxy-Authorization: Basic %s\r\n", proxyauthenc);
1355 OPENSSL_clear_free(proxyauthenc, strlen(proxyauthenc));
1356 }
a6d40689 1357 proxy_end:
29f178bd
DDO
1358 OPENSSL_clear_free(proxyauth, len);
1359 if (proxyauthenc == NULL)
1360 goto end;
1361 }
1362
1363 /* Terminate the HTTP CONNECT request */
1364 BIO_printf(fbio, "\r\n");
1365
1366 for (;;) {
1367 if (BIO_flush(fbio) != 0)
1368 break;
1369 /* potentially needs to be retried if BIO is non-blocking */
1370 if (!BIO_should_retry(fbio))
1371 break;
1372 }
1373
1374 for (;;) {
1375 /* will not actually wait if timeout == 0 */
e8d0819d 1376 rv = BIO_wait(fbio, max_time, 100 /* milliseconds */);
29f178bd
DDO
1377 if (rv <= 0) {
1378 BIO_printf(bio_err, "%s: HTTP CONNECT %s\n", prog,
1379 rv == 0 ? "timed out" : "failed waiting for data");
1380 goto end;
1381 }
1382
1383 /*-
1384 * The first line is the HTTP response.
1385 * According to RFC 7230, it is formatted exactly like this:
552aeaef 1386 * HTTP/d.d ddd reason text\r\n
29f178bd
DDO
1387 */
1388 read_len = BIO_gets(fbio, mbuf, BUF_SIZE);
1389 /* the BIO may not block, so we must wait for the 1st line to come in */
765860a3 1390 if (read_len < (int)HTTP_LINE1_MINLEN)
29f178bd
DDO
1391 continue;
1392
19f97fe6 1393 /* Check for HTTP/1.x */
2ff286c2 1394 mbufp = mbuf;
2490d10d 1395 if (!CHECK_AND_SKIP_PREFIX(mbufp, HTTP_PREFIX)) {
19f97fe6 1396 ERR_raise(ERR_LIB_HTTP, HTTP_R_HEADER_PARSE_ERROR);
29f178bd
DDO
1397 BIO_printf(bio_err, "%s: HTTP CONNECT failed, non-HTTP response\n",
1398 prog);
1399 /* Wrong protocol, not even HTTP, so stop reading headers */
1400 goto end;
1401 }
2ff286c2 1402 if (!HAS_PREFIX(mbufp, HTTP_VERSION_PATT)) {
9311d0c4 1403 ERR_raise(ERR_LIB_HTTP, HTTP_R_RECEIVED_WRONG_HTTP_VERSION);
29f178bd
DDO
1404 BIO_printf(bio_err,
1405 "%s: HTTP CONNECT failed, bad HTTP version %.*s\n",
19f97fe6 1406 prog, (int)HTTP_VERSION_STR_LEN, mbufp);
29f178bd
DDO
1407 goto end;
1408 }
1409 mbufp += HTTP_VERSION_STR_LEN;
19f97fe6
DDO
1410
1411 /* RFC 7231 4.3.6: any 2xx status code is valid */
b6fec965 1412 if (!HAS_PREFIX(mbufp, " 2")) {
2490d10d
DDO
1413 if (ossl_isspace(*mbufp))
1414 mbufp++;
29f178bd
DDO
1415 /* chop any trailing whitespace */
1416 while (read_len > 0 && ossl_isspace(mbuf[read_len - 1]))
1417 read_len--;
1418 mbuf[read_len] = '\0';
a150f8e1 1419 ERR_raise_data(ERR_LIB_HTTP, HTTP_R_CONNECT_FAILURE,
552aeaef
DDO
1420 "reason=%s", mbufp);
1421 BIO_printf(bio_err, "%s: HTTP CONNECT failed, reason=%s\n",
29f178bd
DDO
1422 prog, mbufp);
1423 goto end;
1424 }
1425 ret = 1;
1426 break;
1427 }
1428
1429 /* Read past all following headers */
1430 do {
1431 /*
60e91cc4 1432 * This does not necessarily catch the case when the full
29f178bd
DDO
1433 * HTTP response came in in more than a single TCP message.
1434 */
1435 read_len = BIO_gets(fbio, mbuf, BUF_SIZE);
1436 } while (read_len > 2);
1437
1438 end:
1439 if (fbio != NULL) {
1440 (void)BIO_flush(fbio);
1441 BIO_pop(fbio);
1442 BIO_free(fbio);
1443 }
1444 OPENSSL_free(mbuf);
1445 return ret;
4b1fe471 1446#undef BUF_SIZE
29f178bd 1447}