Coverage Report

Created: 2024-11-21 07:03

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