2020-01-18 08:38:21 +00:00
|
|
|
/*
|
|
|
|
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
|
|
|
|
*
|
2021-04-22 08:24:48 +00:00
|
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
2020-01-18 08:38:21 +00:00
|
|
|
*/
|
|
|
|
|
2021-06-06 15:01:35 +00:00
|
|
|
#include <AK/Base64.h>
|
2019-04-07 12:36:10 +00:00
|
|
|
#include <AK/StringBuilder.h>
|
2020-04-20 21:25:25 +00:00
|
|
|
#include <LibHTTP/HttpJob.h>
|
|
|
|
#include <LibHTTP/HttpRequest.h>
|
2019-04-07 12:36:10 +00:00
|
|
|
|
2020-04-20 21:25:25 +00:00
|
|
|
namespace HTTP {
|
2020-02-02 11:34:39 +00:00
|
|
|
|
|
|
|
HttpRequest::HttpRequest()
|
2019-04-07 12:36:10 +00:00
|
|
|
{
|
|
|
|
}
|
|
|
|
|
2020-02-02 11:34:39 +00:00
|
|
|
HttpRequest::~HttpRequest()
|
2019-04-07 12:36:10 +00:00
|
|
|
{
|
|
|
|
}
|
|
|
|
|
2020-02-02 11:34:39 +00:00
|
|
|
String HttpRequest::method_name() const
|
2019-04-07 12:36:10 +00:00
|
|
|
{
|
|
|
|
switch (m_method) {
|
|
|
|
case Method::GET:
|
|
|
|
return "GET";
|
|
|
|
case Method::HEAD:
|
|
|
|
return "HEAD";
|
|
|
|
case Method::POST:
|
|
|
|
return "POST";
|
|
|
|
default:
|
2021-02-23 19:42:32 +00:00
|
|
|
VERIFY_NOT_REACHED();
|
2019-04-07 12:36:10 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-02-02 11:34:39 +00:00
|
|
|
ByteBuffer HttpRequest::to_raw_request() const
|
2019-04-07 12:36:10 +00:00
|
|
|
{
|
|
|
|
StringBuilder builder;
|
|
|
|
builder.append(method_name());
|
|
|
|
builder.append(' ');
|
2021-05-29 19:54:35 +00:00
|
|
|
// NOTE: The percent_encode is so that e.g. spaces are properly encoded.
|
|
|
|
auto path = m_url.path();
|
|
|
|
VERIFY(!path.is_empty());
|
|
|
|
builder.append(URL::percent_encode(m_url.path(), URL::PercentEncodeSet::EncodeURI));
|
2020-05-05 02:24:57 +00:00
|
|
|
if (!m_url.query().is_empty()) {
|
|
|
|
builder.append('?');
|
2021-05-29 19:54:35 +00:00
|
|
|
builder.append(URL::percent_encode(m_url.query(), URL::PercentEncodeSet::EncodeURI));
|
2020-05-05 02:24:57 +00:00
|
|
|
}
|
2020-04-20 21:25:25 +00:00
|
|
|
builder.append(" HTTP/1.1\r\nHost: ");
|
2019-08-10 17:32:03 +00:00
|
|
|
builder.append(m_url.host());
|
2020-05-21 10:27:42 +00:00
|
|
|
builder.append("\r\n");
|
|
|
|
for (auto& header : m_headers) {
|
|
|
|
builder.append(header.name);
|
|
|
|
builder.append(": ");
|
|
|
|
builder.append(header.value);
|
|
|
|
builder.append("\r\n");
|
|
|
|
}
|
2020-09-28 09:55:26 +00:00
|
|
|
if (!m_body.is_empty()) {
|
ProtocolServer: Stream the downloaded data if possible
This patchset makes ProtocolServer stream the downloads to its client
(LibProtocol), and as such changes the download API; a possible
download lifecycle could be as such:
notation = client->server:'>', server->client:'<', pipe activity:'*'
```
> StartDownload(GET, url, headers, {})
< Response(0, fd 8)
* {data, 1024b}
< HeadersBecameAvailable(0, response_headers, 200)
< DownloadProgress(0, 4K, 1024)
* {data, 1024b}
* {data, 1024b}
< DownloadProgress(0, 4K, 2048)
* {data, 1024b}
< DownloadProgress(0, 4K, 1024)
< DownloadFinished(0, true, 4K)
```
Since managing the received file descriptor is a pain, LibProtocol
implements `Download::stream_into(OutputStream)`, which can be used to
stream the download into any given output stream (be it a file, or
memory, or writing stuff with a delay, etc.).
Also, as some of the users of this API require all the downloaded data
upfront, LibProtocol also implements `set_should_buffer_all_input()`,
which causes the download instance to buffer all the data until the
download is complete, and to call the `on_buffered_download_finish`
hook.
2020-12-26 13:44:12 +00:00
|
|
|
builder.appendff("Content-Length: {}\r\n\r\n", m_body.size());
|
2021-06-06 15:01:35 +00:00
|
|
|
builder.append((char const*)m_body.data(), m_body.size());
|
2020-09-28 09:55:26 +00:00
|
|
|
}
|
ProtocolServer: Stream the downloaded data if possible
This patchset makes ProtocolServer stream the downloads to its client
(LibProtocol), and as such changes the download API; a possible
download lifecycle could be as such:
notation = client->server:'>', server->client:'<', pipe activity:'*'
```
> StartDownload(GET, url, headers, {})
< Response(0, fd 8)
* {data, 1024b}
< HeadersBecameAvailable(0, response_headers, 200)
< DownloadProgress(0, 4K, 1024)
* {data, 1024b}
* {data, 1024b}
< DownloadProgress(0, 4K, 2048)
* {data, 1024b}
< DownloadProgress(0, 4K, 1024)
< DownloadFinished(0, true, 4K)
```
Since managing the received file descriptor is a pain, LibProtocol
implements `Download::stream_into(OutputStream)`, which can be used to
stream the download into any given output stream (be it a file, or
memory, or writing stuff with a delay, etc.).
Also, as some of the users of this API require all the downloaded data
upfront, LibProtocol also implements `set_should_buffer_all_input()`,
which causes the download instance to buffer all the data until the
download is complete, and to call the `on_buffered_download_finish`
hook.
2020-12-26 13:44:12 +00:00
|
|
|
builder.append("\r\n");
|
2019-04-07 12:36:10 +00:00
|
|
|
return builder.to_byte_buffer();
|
|
|
|
}
|
2020-02-02 11:34:39 +00:00
|
|
|
|
2020-12-19 16:38:33 +00:00
|
|
|
Optional<HttpRequest> HttpRequest::from_raw_request(ReadonlyBytes raw_request)
|
2020-02-09 10:27:36 +00:00
|
|
|
{
|
|
|
|
enum class State {
|
|
|
|
InMethod,
|
|
|
|
InResource,
|
|
|
|
InProtocol,
|
|
|
|
InHeaderName,
|
|
|
|
InHeaderValue,
|
|
|
|
};
|
|
|
|
|
|
|
|
State state { State::InMethod };
|
2020-02-20 11:54:15 +00:00
|
|
|
size_t index = 0;
|
2020-02-09 10:27:36 +00:00
|
|
|
|
|
|
|
auto peek = [&](int offset = 0) -> u8 {
|
|
|
|
if (index + offset >= raw_request.size())
|
|
|
|
return 0;
|
|
|
|
return raw_request[index + offset];
|
|
|
|
};
|
|
|
|
|
|
|
|
auto consume = [&]() -> u8 {
|
2021-02-23 19:42:32 +00:00
|
|
|
VERIFY(index < raw_request.size());
|
2020-02-09 10:27:36 +00:00
|
|
|
return raw_request[index++];
|
|
|
|
};
|
|
|
|
|
|
|
|
Vector<u8, 256> buffer;
|
|
|
|
|
|
|
|
String method;
|
|
|
|
String resource;
|
|
|
|
String protocol;
|
|
|
|
Vector<Header> headers;
|
|
|
|
Header current_header;
|
|
|
|
|
|
|
|
auto commit_and_advance_to = [&](auto& output, State new_state) {
|
|
|
|
output = String::copy(buffer);
|
|
|
|
buffer.clear();
|
|
|
|
state = new_state;
|
|
|
|
};
|
|
|
|
|
|
|
|
while (index < raw_request.size()) {
|
|
|
|
// FIXME: Figure out what the appropriate limitations should be.
|
|
|
|
if (buffer.size() > 65536)
|
|
|
|
return {};
|
|
|
|
switch (state) {
|
|
|
|
case State::InMethod:
|
|
|
|
if (peek() == ' ') {
|
|
|
|
consume();
|
|
|
|
commit_and_advance_to(method, State::InResource);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
buffer.append(consume());
|
|
|
|
break;
|
|
|
|
case State::InResource:
|
|
|
|
if (peek() == ' ') {
|
|
|
|
consume();
|
|
|
|
commit_and_advance_to(resource, State::InProtocol);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
buffer.append(consume());
|
|
|
|
break;
|
|
|
|
case State::InProtocol:
|
|
|
|
if (peek(0) == '\r' && peek(1) == '\n') {
|
|
|
|
consume();
|
|
|
|
consume();
|
|
|
|
commit_and_advance_to(protocol, State::InHeaderName);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
buffer.append(consume());
|
|
|
|
break;
|
|
|
|
case State::InHeaderName:
|
|
|
|
if (peek(0) == ':' && peek(1) == ' ') {
|
|
|
|
consume();
|
|
|
|
consume();
|
|
|
|
commit_and_advance_to(current_header.name, State::InHeaderValue);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
buffer.append(consume());
|
|
|
|
break;
|
|
|
|
case State::InHeaderValue:
|
|
|
|
if (peek(0) == '\r' && peek(1) == '\n') {
|
|
|
|
consume();
|
|
|
|
consume();
|
|
|
|
commit_and_advance_to(current_header.value, State::InHeaderName);
|
|
|
|
headers.append(move(current_header));
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
buffer.append(consume());
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
HttpRequest request;
|
|
|
|
if (method == "GET")
|
|
|
|
request.m_method = Method::GET;
|
|
|
|
else if (method == "HEAD")
|
|
|
|
request.m_method = Method::HEAD;
|
|
|
|
else if (method == "POST")
|
|
|
|
request.m_method = Method::POST;
|
|
|
|
else
|
|
|
|
return {};
|
|
|
|
|
2021-05-29 19:54:35 +00:00
|
|
|
request.m_resource = URL::percent_decode(resource);
|
2020-02-09 10:27:36 +00:00
|
|
|
request.m_headers = move(headers);
|
|
|
|
|
|
|
|
return request;
|
|
|
|
}
|
|
|
|
|
2021-06-06 15:01:35 +00:00
|
|
|
void HttpRequest::set_headers(HashMap<String, String> const& headers)
|
2020-05-21 10:27:42 +00:00
|
|
|
{
|
|
|
|
for (auto& it : headers)
|
|
|
|
m_headers.append({ it.key, it.value });
|
|
|
|
}
|
|
|
|
|
2021-06-06 15:01:35 +00:00
|
|
|
Optional<HttpRequest::Header> HttpRequest::get_http_basic_authentication_header(URL const& url)
|
|
|
|
{
|
|
|
|
if (!url.includes_credentials())
|
|
|
|
return {};
|
|
|
|
StringBuilder builder;
|
|
|
|
builder.append(url.username());
|
|
|
|
builder.append(':');
|
|
|
|
builder.append(url.password());
|
|
|
|
auto token = encode_base64(builder.to_string().bytes());
|
|
|
|
builder.clear();
|
|
|
|
builder.append("Basic ");
|
|
|
|
builder.append(token);
|
|
|
|
return Header { "Authorization", builder.to_string() };
|
|
|
|
}
|
|
|
|
|
|
|
|
Optional<HttpRequest::BasicAuthenticationCredentials> HttpRequest::parse_http_basic_authentication_header(String const& value)
|
|
|
|
{
|
|
|
|
if (!value.starts_with("Basic ", AK::CaseSensitivity::CaseInsensitive))
|
|
|
|
return {};
|
|
|
|
auto token = value.substring_view(6);
|
|
|
|
if (token.is_empty())
|
|
|
|
return {};
|
|
|
|
auto decoded_token = String::copy(decode_base64(token));
|
|
|
|
auto colon_index = decoded_token.find(':');
|
|
|
|
if (!colon_index.has_value())
|
|
|
|
return {};
|
|
|
|
auto username = decoded_token.substring_view(0, colon_index.value());
|
|
|
|
auto password = decoded_token.substring_view(colon_index.value() + 1);
|
|
|
|
return BasicAuthenticationCredentials { username, password };
|
|
|
|
}
|
|
|
|
|
2020-02-02 11:34:39 +00:00
|
|
|
}
|