Ed Tanous | 40e9b92 | 2024-09-10 13:50:16 -0700 | [diff] [blame] | 1 | // SPDX-License-Identifier: Apache-2.0 |
2 | // SPDX-FileCopyrightText: Copyright OpenBMC Authors | ||||
Ed Tanous | 7045c8d | 2017-04-03 10:04:37 -0700 | [diff] [blame] | 3 | #pragma once |
4 | |||||
Ed Tanous | b289614 | 2024-01-31 15:25:47 -0800 | [diff] [blame] | 5 | #include "http_body.hpp" |
Ratan Gupta | 6f35956 | 2019-04-03 10:39:08 +0530 | [diff] [blame] | 6 | #include "sessions.hpp" |
7 | |||||
Sunitha Harish | c0ea7ae | 2020-10-30 02:37:30 -0500 | [diff] [blame] | 8 | #include <boost/asio/ip/address.hpp> |
Ed Tanous | d785720 | 2025-01-28 15:32:26 -0800 | [diff] [blame] | 9 | #include <boost/beast/http/field.hpp> |
10 | #include <boost/beast/http/fields.hpp> | ||||
Ed Tanous | d43cd0c | 2020-09-30 20:46:53 -0700 | [diff] [blame] | 11 | #include <boost/beast/http/message.hpp> |
Ed Tanous | d785720 | 2025-01-28 15:32:26 -0800 | [diff] [blame] | 12 | #include <boost/beast/http/verb.hpp> |
13 | #include <boost/beast/websocket/rfc6455.hpp> | ||||
14 | #include <boost/url/parse.hpp> | ||||
Ed Tanous | 39662a3 | 2023-02-06 15:09:46 -0800 | [diff] [blame] | 15 | #include <boost/url/url.hpp> |
Ed Tanous | d785720 | 2025-01-28 15:32:26 -0800 | [diff] [blame] | 16 | #include <boost/url/url_view.hpp> |
raviteja-b | 4722efe | 2020-02-03 12:23:18 -0600 | [diff] [blame] | 17 | |
Ed Tanous | d785720 | 2025-01-28 15:32:26 -0800 | [diff] [blame] | 18 | #include <memory> |
Ed Tanous | 8a9a25c | 2021-05-11 14:50:58 -0700 | [diff] [blame] | 19 | #include <string> |
20 | #include <string_view> | ||||
Ed Tanous | f79b7a5 | 2021-09-22 19:04:29 -0700 | [diff] [blame] | 21 | #include <system_error> |
Ed Tanous | d785720 | 2025-01-28 15:32:26 -0800 | [diff] [blame] | 22 | #include <utility> |
Ed Tanous | 8a9a25c | 2021-05-11 14:50:58 -0700 | [diff] [blame] | 23 | |
Ed Tanous | 1abe55e | 2018-09-05 08:30:59 -0700 | [diff] [blame] | 24 | namespace crow |
25 | { | ||||
Ed Tanous | 7045c8d | 2017-04-03 10:04:37 -0700 | [diff] [blame] | 26 | |
Ed Tanous | 1abe55e | 2018-09-05 08:30:59 -0700 | [diff] [blame] | 27 | struct Request |
28 | { | ||||
Jonathan Doman | 102a4cd | 2024-04-15 16:56:23 -0700 | [diff] [blame] | 29 | using Body = boost::beast::http::request<bmcweb::HttpBody>; |
30 | Body req; | ||||
Ed Tanous | 50b8a43 | 2022-02-03 16:29:50 -0800 | [diff] [blame] | 31 | |
Ed Tanous | 39662a3 | 2023-02-06 15:09:46 -0800 | [diff] [blame] | 32 | private: |
Ed Tanous | 47f2934 | 2024-03-19 12:18:06 -0700 | [diff] [blame] | 33 | boost::urls::url urlBase; |
Ed Tanous | 39662a3 | 2023-02-06 15:09:46 -0800 | [diff] [blame] | 34 | |
Ed Tanous | 608ad2c | 2024-05-20 19:14:50 -0700 | [diff] [blame] | 35 | Request(const Request& other) = default; |
36 | |||||
Ed Tanous | 39662a3 | 2023-02-06 15:09:46 -0800 | [diff] [blame] | 37 | public: |
Ed Tanous | 47f2934 | 2024-03-19 12:18:06 -0700 | [diff] [blame] | 38 | boost::asio::ip::address ipAddress; |
Ed Tanous | 7045c8d | 2017-04-03 10:04:37 -0700 | [diff] [blame] | 39 | |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 40 | std::shared_ptr<persistent_data::UserSession> session; |
Ratan Gupta | 6f35956 | 2019-04-03 10:39:08 +0530 | [diff] [blame] | 41 | |
Ed Tanous | 47f2934 | 2024-03-19 12:18:06 -0700 | [diff] [blame] | 42 | std::string userRole; |
Jonathan Doman | 102a4cd | 2024-04-15 16:56:23 -0700 | [diff] [blame] | 43 | Request(Body reqIn, std::error_code& ec) : req(std::move(reqIn)) |
Ed Tanous | 33c6b58 | 2023-02-14 15:05:48 -0800 | [diff] [blame] | 44 | { |
45 | if (!setUrlInfo()) | ||||
46 | { | ||||
47 | ec = std::make_error_code(std::errc::invalid_argument); | ||||
48 | } | ||||
49 | } | ||||
50 | |||||
Ed Tanous | 818db20 | 2023-09-11 09:58:39 -0700 | [diff] [blame] | 51 | Request(std::string_view bodyIn, std::error_code& /*ec*/) : req({}, bodyIn) |
52 | {} | ||||
Ed Tanous | 7045c8d | 2017-04-03 10:04:37 -0700 | [diff] [blame] | 53 | |
Ed Tanous | fca2cbe | 2021-01-28 14:49:59 -0800 | [diff] [blame] | 54 | Request() = default; |
55 | |||||
Ed Tanous | 39662a3 | 2023-02-06 15:09:46 -0800 | [diff] [blame] | 56 | Request(Request&& other) = default; |
Ed Tanous | 2d6cb56 | 2022-07-07 20:44:54 -0700 | [diff] [blame] | 57 | |
Ed Tanous | 608ad2c | 2024-05-20 19:14:50 -0700 | [diff] [blame] | 58 | Request& operator=(const Request&) = delete; |
Ed Tanous | f42e859 | 2023-08-25 10:47:44 -0700 | [diff] [blame] | 59 | Request& operator=(Request&&) = default; |
Ed Tanous | ecd6a3a | 2022-01-07 09:18:40 -0800 | [diff] [blame] | 60 | ~Request() = default; |
Ed Tanous | 597d2b1 | 2021-09-16 15:07:53 -0700 | [diff] [blame] | 61 | |
Ed Tanous | 608ad2c | 2024-05-20 19:14:50 -0700 | [diff] [blame] | 62 | Request copy() const |
63 | { | ||||
64 | return {*this}; | ||||
65 | } | ||||
66 | |||||
Ed Tanous | 6fb96ce | 2024-01-28 21:30:06 -0800 | [diff] [blame] | 67 | void addHeader(std::string_view key, std::string_view value) |
68 | { | ||||
69 | req.insert(key, value); | ||||
70 | } | ||||
71 | |||||
72 | void addHeader(boost::beast::http::field key, std::string_view value) | ||||
73 | { | ||||
74 | req.insert(key, value); | ||||
75 | } | ||||
76 | |||||
Ed Tanous | 52e3162 | 2024-01-23 16:31:11 -0800 | [diff] [blame] | 77 | void clear() |
78 | { | ||||
79 | req.clear(); | ||||
80 | urlBase.clear(); | ||||
Ed Tanous | 52e3162 | 2024-01-23 16:31:11 -0800 | [diff] [blame] | 81 | ipAddress = boost::asio::ip::address(); |
82 | session = nullptr; | ||||
83 | userRole = ""; | ||||
84 | } | ||||
85 | |||||
Ed Tanous | 271584a | 2019-07-09 16:24:22 -0700 | [diff] [blame] | 86 | boost::beast::http::verb method() const |
Ed Tanous | 1abe55e | 2018-09-05 08:30:59 -0700 | [diff] [blame] | 87 | { |
88 | return req.method(); | ||||
89 | } | ||||
Ed Tanous | 50bfc91 | 2024-07-29 14:20:50 -0700 | [diff] [blame] | 90 | |
Myung Bae | 1873a04 | 2024-04-01 09:27:39 -0500 | [diff] [blame] | 91 | void method(boost::beast::http::verb verb) |
92 | { | ||||
Ed Tanous | 1919a03 | 2024-04-03 15:56:36 -0700 | [diff] [blame] | 93 | req.method(verb); |
Myung Bae | 1873a04 | 2024-04-01 09:27:39 -0500 | [diff] [blame] | 94 | } |
Ed Tanous | 7045c8d | 2017-04-03 10:04:37 -0700 | [diff] [blame] | 95 | |
Ed Tanous | 50bfc91 | 2024-07-29 14:20:50 -0700 | [diff] [blame] | 96 | std::string_view methodString() |
97 | { | ||||
98 | return req.method_string(); | ||||
99 | } | ||||
100 | |||||
Ed Tanous | 3174e4d | 2020-10-07 11:41:22 -0700 | [diff] [blame] | 101 | std::string_view getHeaderValue(std::string_view key) const |
Ed Tanous | 1abe55e | 2018-09-05 08:30:59 -0700 | [diff] [blame] | 102 | { |
103 | return req[key]; | ||||
104 | } | ||||
Ed Tanous | 7045c8d | 2017-04-03 10:04:37 -0700 | [diff] [blame] | 105 | |
Ed Tanous | 3174e4d | 2020-10-07 11:41:22 -0700 | [diff] [blame] | 106 | std::string_view getHeaderValue(boost::beast::http::field key) const |
Ed Tanous | 1abe55e | 2018-09-05 08:30:59 -0700 | [diff] [blame] | 107 | { |
108 | return req[key]; | ||||
109 | } | ||||
Ed Tanous | e0d918b | 2018-03-27 17:41:04 -0700 | [diff] [blame] | 110 | |
Myung Bae | 1873a04 | 2024-04-01 09:27:39 -0500 | [diff] [blame] | 111 | void clearHeader(boost::beast::http::field key) |
112 | { | ||||
113 | req.erase(key); | ||||
114 | } | ||||
115 | |||||
Ed Tanous | 3174e4d | 2020-10-07 11:41:22 -0700 | [diff] [blame] | 116 | std::string_view methodString() const |
Ed Tanous | 1abe55e | 2018-09-05 08:30:59 -0700 | [diff] [blame] | 117 | { |
118 | return req.method_string(); | ||||
119 | } | ||||
Ed Tanous | e0d918b | 2018-03-27 17:41:04 -0700 | [diff] [blame] | 120 | |
Ed Tanous | 3174e4d | 2020-10-07 11:41:22 -0700 | [diff] [blame] | 121 | std::string_view target() const |
Ed Tanous | 1abe55e | 2018-09-05 08:30:59 -0700 | [diff] [blame] | 122 | { |
123 | return req.target(); | ||||
124 | } | ||||
Ed Tanous | e0d918b | 2018-03-27 17:41:04 -0700 | [diff] [blame] | 125 | |
Ed Tanous | 6282bc7 | 2024-08-19 11:46:20 -0700 | [diff] [blame] | 126 | boost::urls::url& url() |
127 | { | ||||
128 | return urlBase; | ||||
129 | } | ||||
130 | |||||
Ed Tanous | 39662a3 | 2023-02-06 15:09:46 -0800 | [diff] [blame] | 131 | boost::urls::url_view url() const |
132 | { | ||||
133 | return {urlBase}; | ||||
134 | } | ||||
135 | |||||
Ed Tanous | 98fe740 | 2023-02-14 14:50:33 -0800 | [diff] [blame] | 136 | const boost::beast::http::fields& fields() const |
137 | { | ||||
138 | return req.base(); | ||||
139 | } | ||||
140 | |||||
Ed Tanous | 33c6b58 | 2023-02-14 15:05:48 -0800 | [diff] [blame] | 141 | const std::string& body() const |
142 | { | ||||
Ed Tanous | 52e3162 | 2024-01-23 16:31:11 -0800 | [diff] [blame] | 143 | return req.body().str(); |
Ed Tanous | 33c6b58 | 2023-02-14 15:05:48 -0800 | [diff] [blame] | 144 | } |
145 | |||||
Ed Tanous | 26ccae3 | 2023-02-16 10:28:44 -0800 | [diff] [blame] | 146 | bool target(std::string_view target) |
Ed Tanous | f79b7a5 | 2021-09-22 19:04:29 -0700 | [diff] [blame] | 147 | { |
148 | req.target(target); | ||||
149 | return setUrlInfo(); | ||||
150 | } | ||||
151 | |||||
Ed Tanous | 3174e4d | 2020-10-07 11:41:22 -0700 | [diff] [blame] | 152 | unsigned version() const |
Ed Tanous | 1abe55e | 2018-09-05 08:30:59 -0700 | [diff] [blame] | 153 | { |
154 | return req.version(); | ||||
155 | } | ||||
Ed Tanous | e0d918b | 2018-03-27 17:41:04 -0700 | [diff] [blame] | 156 | |
Ed Tanous | 3174e4d | 2020-10-07 11:41:22 -0700 | [diff] [blame] | 157 | bool isUpgrade() const |
Ed Tanous | 1abe55e | 2018-09-05 08:30:59 -0700 | [diff] [blame] | 158 | { |
Ed Tanous | d785720 | 2025-01-28 15:32:26 -0800 | [diff] [blame] | 159 | // NOLINTNEXTLINE(misc-include-cleaner) |
Ed Tanous | 1abe55e | 2018-09-05 08:30:59 -0700 | [diff] [blame] | 160 | return boost::beast::websocket::is_upgrade(req); |
161 | } | ||||
Ed Tanous | e0d918b | 2018-03-27 17:41:04 -0700 | [diff] [blame] | 162 | |
Ed Tanous | 3174e4d | 2020-10-07 11:41:22 -0700 | [diff] [blame] | 163 | bool keepAlive() const |
Ed Tanous | 1abe55e | 2018-09-05 08:30:59 -0700 | [diff] [blame] | 164 | { |
165 | return req.keep_alive(); | ||||
166 | } | ||||
Ed Tanous | f79b7a5 | 2021-09-22 19:04:29 -0700 | [diff] [blame] | 167 | |
168 | private: | ||||
Ed Tanous | 67df073 | 2021-10-26 11:23:56 -0700 | [diff] [blame] | 169 | bool setUrlInfo() |
170 | { | ||||
Ed Tanous | 079360a | 2022-06-29 10:05:19 -0700 | [diff] [blame] | 171 | auto result = boost::urls::parse_relative_ref(target()); |
Ed Tanous | 67df073 | 2021-10-26 11:23:56 -0700 | [diff] [blame] | 172 | |
173 | if (!result) | ||||
174 | { | ||||
175 | return false; | ||||
176 | } | ||||
Ed Tanous | 39662a3 | 2023-02-06 15:09:46 -0800 | [diff] [blame] | 177 | urlBase = *result; |
Ed Tanous | 67df073 | 2021-10-26 11:23:56 -0700 | [diff] [blame] | 178 | return true; |
179 | } | ||||
Ed Tanous | 7045c8d | 2017-04-03 10:04:37 -0700 | [diff] [blame] | 180 | }; |
Ed Tanous | e0d918b | 2018-03-27 17:41:04 -0700 | [diff] [blame] | 181 | |
Ed Tanous | 1abe55e | 2018-09-05 08:30:59 -0700 | [diff] [blame] | 182 | } // namespace crow |