2 * Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright Siemens AG 2018-2020
5 * Licensed under the Apache License 2.0 (the "License"). You may not use
6 * this file except in compliance with the License. You can obtain a copy
7 * in the file LICENSE in the source distribution or at
8 * https://www.openssl.org/source/license.html
11 #ifndef OPENSSL_HTTP_H
12 # define OPENSSL_HTTP_H
15 # include <openssl/opensslconf.h>
17 # include <openssl/bio.h>
18 # include <openssl/asn1.h>
19 # include <openssl/conf.h>
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"
36 #define HTTP_DEFAULT_MAX_LINE_LENGTH (4 * 1024)
37 #define HTTP_DEFAULT_MAX_RESP_LEN (100 * 1024)
39 /* Low-level HTTP API */
40 OSSL_HTTP_REQ_CTX
*OSSL_HTTP_REQ_CTX_new(BIO
*wbio
, BIO
*rbio
, int buf_size
);
41 void OSSL_HTTP_REQ_CTX_free(OSSL_HTTP_REQ_CTX
*rctx
);
42 int OSSL_HTTP_REQ_CTX_set_request_line(OSSL_HTTP_REQ_CTX
*rctx
, int method_POST
,
43 const char *server
, const char *port
,
45 int OSSL_HTTP_REQ_CTX_add1_header(OSSL_HTTP_REQ_CTX
*rctx
,
46 const char *name
, const char *value
);
47 int OSSL_HTTP_REQ_CTX_set_expected(OSSL_HTTP_REQ_CTX
*rctx
,
48 const char *content_type
, int asn1
,
49 int timeout
, int keep_alive
);
50 int OSSL_HTTP_REQ_CTX_set1_req(OSSL_HTTP_REQ_CTX
*rctx
, const char *content_type
,
51 const ASN1_ITEM
*it
, const ASN1_VALUE
*req
);
52 int OSSL_HTTP_REQ_CTX_nbio(OSSL_HTTP_REQ_CTX
*rctx
);
53 int OSSL_HTTP_REQ_CTX_nbio_d2i(OSSL_HTTP_REQ_CTX
*rctx
,
54 ASN1_VALUE
**pval
, const ASN1_ITEM
*it
);
55 BIO
*OSSL_HTTP_REQ_CTX_exchange(OSSL_HTTP_REQ_CTX
*rctx
);
56 BIO
*OSSL_HTTP_REQ_CTX_get0_mem_bio(const OSSL_HTTP_REQ_CTX
*rctx
);
57 size_t OSSL_HTTP_REQ_CTX_get_resp_len(const OSSL_HTTP_REQ_CTX
*rctx
);
58 void OSSL_HTTP_REQ_CTX_set_max_response_length(OSSL_HTTP_REQ_CTX
*rctx
,
60 int OSSL_HTTP_is_alive(const OSSL_HTTP_REQ_CTX
*rctx
);
62 /* High-level HTTP API */
63 typedef BIO
*(*OSSL_HTTP_bio_cb_t
)(BIO
*bio
, void *arg
, int connect
, int detail
);
64 OSSL_HTTP_REQ_CTX
*OSSL_HTTP_open(const char *server
, const char *port
,
65 const char *proxy
, const char *no_proxy
,
66 int use_ssl
, BIO
*bio
, BIO
*rbio
,
67 OSSL_HTTP_bio_cb_t bio_update_fn
, void *arg
,
68 int buf_size
, unsigned long max_resp_len
,
70 int OSSL_HTTP_proxy_connect(BIO
*bio
, const char *server
, const char *port
,
71 const char *proxyuser
, const char *proxypass
,
72 int timeout
, BIO
*bio_err
, const char *prog
);
73 int OSSL_HTTP_set_request(OSSL_HTTP_REQ_CTX
*rctx
, const char *path
,
74 const STACK_OF(CONF_VALUE
) *headers
,
75 const char *content_type
, BIO
*req_mem
,
76 const char *expected_content_type
, int expect_asn1
,
77 int timeout
, int keep_alive
);
78 BIO
*OSSL_HTTP_exchange(OSSL_HTTP_REQ_CTX
*rctx
, char **redirection_url
);
79 BIO
*OSSL_HTTP_get(const char *url
, const char *proxy
, const char *no_proxy
,
81 OSSL_HTTP_bio_cb_t bio_update_fn
, void *arg
,
82 int buf_size
, const STACK_OF(CONF_VALUE
) *headers
,
83 const char *expected_content_type
, int expect_asn1
,
84 unsigned long max_resp_len
, int timeout
);
85 BIO
*OSSL_HTTP_transfer(OSSL_HTTP_REQ_CTX
**prctx
,
86 const char *server
, const char *port
,
87 const char *path
, int use_ssl
,
88 const char *proxy
, const char *no_proxy
,
90 OSSL_HTTP_bio_cb_t bio_update_fn
, void *arg
,
91 int buf_size
, const STACK_OF(CONF_VALUE
) *headers
,
92 const char *content_type
, BIO
*req
,
93 const char *expected_content_type
, int expect_asn1
,
94 unsigned long max_resp_len
, int timeout
, int keep_alive
);
95 int OSSL_HTTP_close(OSSL_HTTP_REQ_CTX
*rctx
, int ok
);
97 /* Auxiliary functions */
98 int OSSL_parse_url(const char *url
, char **pscheme
, char **puser
, char **phost
,
99 char **pport
, int *pport_num
,
100 char **ppath
, char **pquery
, char **pfrag
);
101 int OSSL_HTTP_parse_url(const char *url
, int *pssl
, char **puser
, char **phost
,
102 char **pport
, int *pport_num
,
103 char **ppath
, char **pquery
, char **pfrag
);
108 #endif /* !defined(OPENSSL_HTTP_H) */