1/*
2 * Copyright 2000-2025 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#ifndef OPENSSL_HTTP_H
12# define OPENSSL_HTTP_H
13# pragma once
14
15# include <openssl/opensslconf.h>
16
17# include <openssl/bio.h>
18# include <openssl/asn1.h>
19# include <openssl/conf.h>
20
21
22# ifdef __cplusplus
23extern "C" {
24# endif
25
26# define OSSL_HTTP_NAME "http"
27# define OSSL_HTTPS_NAME "https"
28# define OSSL_HTTP_PREFIX OSSL_HTTP_NAME"://"
29# define OSSL_HTTPS_PREFIX OSSL_HTTPS_NAME"://"
30# define OSSL_HTTP_PORT "80"
31# define OSSL_HTTPS_PORT "443"
32# define OPENSSL_NO_PROXY "NO_PROXY"
33# define OPENSSL_HTTP_PROXY "HTTP_PROXY"
34# define OPENSSL_HTTPS_PROXY "HTTPS_PROXY"
35
36/* We want to have this even in case of OPENSSL_NO_HTTP */
37int OSSL_parse_url(const char *url, char **pscheme, char **puser, char **phost,
38 char **pport, int *pport_num,
39 char **ppath, char **pquery, char **pfrag);
40
41# ifndef OPENSSL_NO_HTTP
42
43# define OSSL_HTTP_DEFAULT_MAX_LINE_LEN (4 * 1024)
44# define OSSL_HTTP_DEFAULT_MAX_RESP_LEN (100 * 1024)
45# define OSSL_HTTP_DEFAULT_MAX_CRL_LEN (32 * 1024 * 1024)
46# define OSSL_HTTP_DEFAULT_MAX_RESP_HDR_LINES 256
47
48
49/* Low-level HTTP API */
50OSSL_HTTP_REQ_CTX *OSSL_HTTP_REQ_CTX_new(BIO *wbio, BIO *rbio, int buf_size);
51void OSSL_HTTP_REQ_CTX_free(OSSL_HTTP_REQ_CTX *rctx);
52int OSSL_HTTP_REQ_CTX_set_request_line(OSSL_HTTP_REQ_CTX *rctx, int method_POST,
53 const char *server, const char *port,
54 const char *path);
55int OSSL_HTTP_REQ_CTX_add1_header(OSSL_HTTP_REQ_CTX *rctx,
56 const char *name, const char *value);
57int OSSL_HTTP_REQ_CTX_set_expected(OSSL_HTTP_REQ_CTX *rctx,
58 const char *content_type, int asn1,
59 int timeout, int keep_alive);
60int OSSL_HTTP_REQ_CTX_set1_req(OSSL_HTTP_REQ_CTX *rctx, const char *content_type,
61 const ASN1_ITEM *it, const ASN1_VALUE *req);
62int OSSL_HTTP_REQ_CTX_nbio(OSSL_HTTP_REQ_CTX *rctx);
63int OSSL_HTTP_REQ_CTX_nbio_d2i(OSSL_HTTP_REQ_CTX *rctx,
64 ASN1_VALUE **pval, const ASN1_ITEM *it);
65BIO *OSSL_HTTP_REQ_CTX_exchange(OSSL_HTTP_REQ_CTX *rctx);
66BIO *OSSL_HTTP_REQ_CTX_get0_mem_bio(const OSSL_HTTP_REQ_CTX *rctx);
67size_t OSSL_HTTP_REQ_CTX_get_resp_len(const OSSL_HTTP_REQ_CTX *rctx);
68void OSSL_HTTP_REQ_CTX_set_max_response_length(OSSL_HTTP_REQ_CTX *rctx,
69 unsigned long len);
70void OSSL_HTTP_REQ_CTX_set_max_response_hdr_lines(OSSL_HTTP_REQ_CTX *rctx,
71 size_t count);
72int OSSL_HTTP_is_alive(const OSSL_HTTP_REQ_CTX *rctx);
73
74/* High-level HTTP API */
75typedef BIO *(*OSSL_HTTP_bio_cb_t)(BIO *bio, void *arg, int connect, int detail);
76OSSL_HTTP_REQ_CTX *OSSL_HTTP_open(const char *server, const char *port,
77 const char *proxy, const char *no_proxy,
78 int use_ssl, BIO *bio, BIO *rbio,
79 OSSL_HTTP_bio_cb_t bio_update_fn, void *arg,
80 int buf_size, int overall_timeout);
81int OSSL_HTTP_proxy_connect(BIO *bio, const char *server, const char *port,
82 const char *proxyuser, const char *proxypass,
83 int timeout, BIO *bio_err, const char *prog);
84int OSSL_HTTP_set1_request(OSSL_HTTP_REQ_CTX *rctx, const char *path,
85 const STACK_OF(CONF_VALUE) *headers,
86 const char *content_type, BIO *req,
87 const char *expected_content_type, int expect_asn1,
88 size_t max_resp_len, int timeout, int keep_alive);
89BIO *OSSL_HTTP_exchange(OSSL_HTTP_REQ_CTX *rctx, char **redirection_url);
90BIO *OSSL_HTTP_get(const char *url, const char *proxy, const char *no_proxy,
91 BIO *bio, BIO *rbio,
92 OSSL_HTTP_bio_cb_t bio_update_fn, void *arg,
93 int buf_size, const STACK_OF(CONF_VALUE) *headers,
94 const char *expected_content_type, int expect_asn1,
95 size_t max_resp_len, int timeout);
96BIO *OSSL_HTTP_transfer(OSSL_HTTP_REQ_CTX **prctx,
97 const char *server, const char *port,
98 const char *path, int use_ssl,
99 const char *proxy, const char *no_proxy,
100 BIO *bio, BIO *rbio,
101 OSSL_HTTP_bio_cb_t bio_update_fn, void *arg,
102 int buf_size, const STACK_OF(CONF_VALUE) *headers,
103 const char *content_type, BIO *req,
104 const char *expected_content_type, int expect_asn1,
105 size_t max_resp_len, int timeout, int keep_alive);
106int OSSL_HTTP_close(OSSL_HTTP_REQ_CTX *rctx, int ok);
107
108/* Auxiliary functions */
109int OSSL_HTTP_parse_url(const char *url, int *pssl, char **puser, char **phost,
110 char **pport, int *pport_num,
111 char **ppath, char **pquery, char **pfrag);
112const char *OSSL_HTTP_adapt_proxy(const char *proxy, const char *no_proxy,
113 const char *server, int use_ssl);
114
115# endif /* !defined(OPENSSL_NO_HTTP) */
116# ifdef __cplusplus
117}
118# endif
119#endif /* !defined(OPENSSL_HTTP_H) */
120