Botan 3.9.0
Crypto and TLS for C&
Botan::HTTP Namespace Reference

Classes

class  HTTP_Error
class  Response

Typedefs

typedef std::function< std::string(std::string_view, std::string_view, std::string_view)> http_exch_fn

Functions

Response GET_sync (std::string_view url, size_t allowable_redirects, std::chrono::milliseconds timeout)
Response http_sync (const http_exch_fn &http_transact, std::string_view verb, std::string_view url, std::string_view content_type, const std::vector< uint8_t > &body, size_t allowable_redirects)
Response http_sync (std::string_view verb, std::string_view url, std::string_view content_type, const std::vector< uint8_t > &body, size_t allowable_redirects, std::chrono::milliseconds timeout)
std::ostream & operator<< (std::ostream &o, const Response &resp)
Response POST_sync (std::string_view url, std::string_view content_type, const std::vector< uint8_t > &body, size_t allowable_redirects, std::chrono::milliseconds timeout)
std::string url_encode (std::string_view in)

Typedef Documentation

◆ http_exch_fn

typedef std::function<std::string(std::string_view, std::string_view, std::string_view)> Botan::HTTP::http_exch_fn

Definition at line 64 of file http_util.h.

Function Documentation

◆ GET_sync()

Response BOTAN_TEST_API Botan::HTTP::GET_sync ( std::string_view url,
size_t allowable_redirects,
std::chrono::milliseconds timeout )

Definition at line 245 of file http_util.cpp.

245 {
246 return http_sync("GET", url, "", std::vector<uint8_t>(), allowable_redirects, timeout);
247}
Response http_sync(const http_exch_fn &http_transact, std::string_view verb, std::string_view url, std::string_view content_type, const std::vector< uint8_t > &body, size_t allowable_redirects)

References http_sync().

Referenced by http_sync().

◆ http_sync() [1/2]

Response Botan::HTTP::http_sync ( const http_exch_fn & http_transact,
std::string_view verb,
std::string_view url,
std::string_view content_type,
const std::vector< uint8_t > & body,
size_t allowable_redirects )

Definition at line 113 of file http_util.cpp.

118 {
119 if(url.empty()) {
120 throw HTTP_Error("URL empty");
121 }
122
123 const auto protocol_host_sep = url.find("://");
124 if(protocol_host_sep == std::string::npos) {
125 throw HTTP_Error(fmt("Invalid URL '{}'", url));
126 }
127
128 const auto host_loc_sep = url.find('/', protocol_host_sep + 3);
129
130 std::string hostname;
131 std::string loc;
132 std::string service;
133
134 if(host_loc_sep == std::string::npos) {
135 hostname = url.substr(protocol_host_sep + 3);
136 loc = "/";
137 } else {
138 hostname = url.substr(protocol_host_sep + 3, host_loc_sep - protocol_host_sep - 3);
139 loc = url.substr(host_loc_sep);
140 }
141
142 const auto port_sep = hostname.find(':');
143 if(port_sep == std::string::npos) {
144 service = "http";
145 // hostname not modified
146 } else {
147 service = hostname.substr(port_sep + 1, std::string::npos);
148 hostname = hostname.substr(0, port_sep);
149 }
150
151 std::ostringstream outbuf;
152
153 outbuf << verb << " " << loc << " HTTP/1.0\r\n";
154 outbuf << "Host: " << hostname << "\r\n";
155
156 if(verb == "GET") {
157 outbuf << "Accept: */*\r\n";
158 outbuf << "Cache-Control: no-cache\r\n";
159 } else if(verb == "POST") {
160 outbuf << "Content-Length: " << body.size() << "\r\n";
161 }
162
163 if(!content_type.empty()) {
164 outbuf << "Content-Type: " << content_type << "\r\n";
165 }
166 outbuf << "Connection: close\r\n\r\n";
167 outbuf.write(cast_uint8_ptr_to_char(body.data()), body.size());
168
169 std::istringstream io(http_transact(hostname, service, outbuf.str()));
170
171 std::string line1;
172 std::getline(io, line1);
173 if(!io || line1.empty()) {
174 throw HTTP_Error("No response");
175 }
176
177 std::stringstream response_stream(line1);
178 std::string http_version;
179 unsigned int status_code = 0;
180 std::string status_message;
181
182 response_stream >> http_version >> status_code;
183
184 std::getline(response_stream, status_message);
185
186 if(!response_stream || !http_version.starts_with("HTTP/")) {
187 throw HTTP_Error("Not an HTTP response");
188 }
189
190 std::map<std::string, std::string> headers;
191 std::string header_line;
192 while(std::getline(io, header_line) && header_line != "\r") {
193 auto sep = header_line.find(": ");
194 if(sep == std::string::npos || sep > header_line.size() - 2) {
195 throw HTTP_Error(fmt("Invalid HTTP header '{}'", header_line));
196 }
197 const std::string key = header_line.substr(0, sep);
198
199 if(sep + 2 < header_line.size() - 1) {
200 const std::string val = header_line.substr(sep + 2, (header_line.size() - 1) - (sep + 2));
201 headers[key] = val;
202 }
203 }
204
205 if(status_code == 301 && headers.contains("Location")) {
206 if(allowable_redirects == 0) {
207 throw HTTP_Error("HTTP redirection count exceeded");
208 }
209 return GET_sync(headers["Location"], allowable_redirects - 1);
210 }
211
212 std::vector<uint8_t> resp_body;
213 std::vector<uint8_t> buf(4096);
214 while(io.good()) {
215 io.read(cast_uint8_ptr_to_char(buf.data()), buf.size());
216 const size_t got = static_cast<size_t>(io.gcount());
217 resp_body.insert(resp_body.end(), buf.data(), &buf[got]);
218 }
219
220 auto cl_hdr = headers.find("Content-Length");
221 if(cl_hdr != headers.end()) {
222 const std::string header_size = cl_hdr->second;
223 if(resp_body.size() != to_u32bit(header_size)) {
224 throw HTTP_Error(fmt("Content-Length disagreement, header says {} got {}", header_size, resp_body.size()));
225 }
226 }
227
228 return Response(status_code, status_message, resp_body, headers);
229}
Response GET_sync(std::string_view url, size_t allowable_redirects, std::chrono::milliseconds timeout)
uint32_t to_u32bit(std::string_view str_view)
Definition parsing.cpp:32
std::string fmt(std::string_view format, const T &... args)
Definition fmt.h:53
const char * cast_uint8_ptr_to_char(const uint8_t *b)
Definition mem_ops.h:282

References Botan::cast_uint8_ptr_to_char(), Botan::fmt(), GET_sync(), and Botan::to_u32bit().

Referenced by GET_sync(), http_sync(), and POST_sync().

◆ http_sync() [2/2]

Response Botan::HTTP::http_sync ( std::string_view verb,
std::string_view url,
std::string_view content_type,
const std::vector< uint8_t > & body,
size_t allowable_redirects,
std::chrono::milliseconds timeout )

Definition at line 231 of file http_util.cpp.

236 {
237 auto transact_with_timeout = [timeout](
238 std::string_view hostname, std::string_view service, std::string_view message) {
239 return http_transact(hostname, service, message, timeout);
240 };
241
242 return http_sync(transact_with_timeout, verb, url, content_type, body, allowable_redirects);
243}

References http_sync().

◆ operator<<()

BOTAN_TEST_API std::ostream & Botan::HTTP::operator<< ( std::ostream & o,
const Response & resp )

Definition at line 103 of file http_util.cpp.

103 {
104 o << "HTTP " << resp.status_code() << " " << resp.status_message() << "\n";
105 for(const auto& h : resp.headers()) {
106 o << "Header '" << h.first << "' = '" << h.second << "'\n";
107 }
108 o << "Body " << std::to_string(resp.body().size()) << " bytes:\n";
109 o.write(cast_uint8_ptr_to_char(resp.body().data()), resp.body().size());
110 return o;
111}
const std::vector< uint8_t > & body() const
Definition http_util.h:43
const std::map< std::string, std::string > & headers() const
Definition http_util.h:45
unsigned int status_code() const
Definition http_util.h:41
std::string status_message() const
Definition http_util.h:47

References Botan::HTTP::Response::body(), Botan::cast_uint8_ptr_to_char(), Botan::HTTP::Response::headers(), Botan::HTTP::Response::status_code(), and Botan::HTTP::Response::status_message().

◆ POST_sync()

Response Botan::HTTP::POST_sync ( std::string_view url,
std::string_view content_type,
const std::vector< uint8_t > & body,
size_t allowable_redirects,
std::chrono::milliseconds timeout )

Definition at line 249 of file http_util.cpp.

253 {
254 return http_sync("POST", url, content_type, body, allowable_redirects, timeout);
255}

References http_sync().

◆ url_encode()

std::string Botan::HTTP::url_encode ( std::string_view in)

Definition at line 88 of file http_util.cpp.

88 {
89 std::ostringstream out;
90
91 for(auto c : in) {
92 if(needs_url_encoding(c)) {
93 out << '%' << std::uppercase << std::hex << std::setfill('0') << std::setw(2) << static_cast<int>(c);
94 out << std::dec << std::nouppercase; // reset flags
95 } else {
96 out << c;
97 }
98 }
99
100 return out.str();
101}