Ed Tanous | 11baefe | 2022-02-09 12:14:12 -0800 | [diff] [blame] | 1 | #include "bmcweb_config.h" |
| 2 | |
Ed Tanous | 04e438c | 2020-10-03 08:06:26 -0700 | [diff] [blame] | 3 | #include "utility.hpp" |
Jonathan Doman | 5beaf84 | 2020-08-14 11:23:33 -0700 | [diff] [blame] | 4 | |
Nan Zhou | 26500f2 | 2022-06-26 23:35:30 +0000 | [diff] [blame] | 5 | #include <boost/url/error.hpp> |
| 6 | #include <boost/url/url.hpp> |
| 7 | #include <boost/url/url_view.hpp> |
| 8 | #include <nlohmann/json.hpp> |
| 9 | |
| 10 | #include <cstdint> |
| 11 | #include <ctime> |
| 12 | #include <functional> |
| 13 | #include <limits> |
| 14 | #include <string> |
| 15 | #include <string_view> |
| 16 | |
Nan Zhou | d5c80ad | 2022-07-11 01:16:31 +0000 | [diff] [blame] | 17 | #include <gtest/gtest.h> // IWYU pragma: keep |
| 18 | // IWYU pragma: no_include <gtest/gtest-message.h> |
| 19 | // IWYU pragma: no_include <gtest/gtest-test-part.h> |
| 20 | // IWYU pragma: no_include "gtest/gtest_pred_impl.h" |
Jonathan Doman | 5beaf84 | 2020-08-14 11:23:33 -0700 | [diff] [blame] | 21 | |
Ed Tanous | 22ce545 | 2022-01-11 10:50:23 -0800 | [diff] [blame] | 22 | namespace crow::utility |
| 23 | { |
| 24 | namespace |
| 25 | { |
| 26 | |
Nan Zhou | bf8ab7a | 2022-06-26 23:43:28 +0000 | [diff] [blame] | 27 | using ::crow::black_magic::getParameterTag; |
| 28 | |
Jonathan Doman | 5beaf84 | 2020-08-14 11:23:33 -0700 | [diff] [blame] | 29 | TEST(Utility, Base64DecodeAuthString) |
| 30 | { |
| 31 | std::string authString("dXNlcm40bWU6cGFzc3cwcmQ="); |
| 32 | std::string result; |
Ed Tanous | 22ce545 | 2022-01-11 10:50:23 -0800 | [diff] [blame] | 33 | EXPECT_TRUE(base64Decode(authString, result)); |
Jonathan Doman | 5beaf84 | 2020-08-14 11:23:33 -0700 | [diff] [blame] | 34 | EXPECT_EQ(result, "usern4me:passw0rd"); |
| 35 | } |
| 36 | |
| 37 | TEST(Utility, Base64DecodeNonAscii) |
| 38 | { |
| 39 | std::string junkString("\xff\xee\xdd\xcc\x01\x11\x22\x33"); |
| 40 | std::string result; |
Ed Tanous | 22ce545 | 2022-01-11 10:50:23 -0800 | [diff] [blame] | 41 | EXPECT_FALSE(base64Decode(junkString, result)); |
Jonathan Doman | 5beaf84 | 2020-08-14 11:23:33 -0700 | [diff] [blame] | 42 | } |
Adriana Kobylak | d830ff5 | 2021-01-27 14:15:27 -0600 | [diff] [blame] | 43 | |
| 44 | TEST(Utility, Base64EncodeString) |
| 45 | { |
| 46 | using namespace std::string_literals; |
| 47 | std::string encoded; |
| 48 | |
Ed Tanous | 22ce545 | 2022-01-11 10:50:23 -0800 | [diff] [blame] | 49 | encoded = base64encode(""); |
Adriana Kobylak | d830ff5 | 2021-01-27 14:15:27 -0600 | [diff] [blame] | 50 | EXPECT_EQ(encoded, ""); |
| 51 | |
Ed Tanous | 22ce545 | 2022-01-11 10:50:23 -0800 | [diff] [blame] | 52 | encoded = base64encode("f"); |
Adriana Kobylak | d830ff5 | 2021-01-27 14:15:27 -0600 | [diff] [blame] | 53 | EXPECT_EQ(encoded, "Zg=="); |
| 54 | |
Ed Tanous | 22ce545 | 2022-01-11 10:50:23 -0800 | [diff] [blame] | 55 | encoded = base64encode("f0"); |
Adriana Kobylak | d830ff5 | 2021-01-27 14:15:27 -0600 | [diff] [blame] | 56 | EXPECT_EQ(encoded, "ZjA="); |
| 57 | |
Ed Tanous | 22ce545 | 2022-01-11 10:50:23 -0800 | [diff] [blame] | 58 | encoded = base64encode("f0\0"s); |
Adriana Kobylak | d830ff5 | 2021-01-27 14:15:27 -0600 | [diff] [blame] | 59 | EXPECT_EQ(encoded, "ZjAA"); |
| 60 | |
Ed Tanous | 22ce545 | 2022-01-11 10:50:23 -0800 | [diff] [blame] | 61 | encoded = base64encode("f0\0 "s); |
Adriana Kobylak | d830ff5 | 2021-01-27 14:15:27 -0600 | [diff] [blame] | 62 | EXPECT_EQ(encoded, "ZjAAIA=="); |
| 63 | |
Ed Tanous | 22ce545 | 2022-01-11 10:50:23 -0800 | [diff] [blame] | 64 | encoded = base64encode("f0\0 B"s); |
Adriana Kobylak | d830ff5 | 2021-01-27 14:15:27 -0600 | [diff] [blame] | 65 | EXPECT_EQ(encoded, "ZjAAIEI="); |
| 66 | |
Ed Tanous | 22ce545 | 2022-01-11 10:50:23 -0800 | [diff] [blame] | 67 | encoded = base64encode("f0\0 Ba"s); |
Adriana Kobylak | d830ff5 | 2021-01-27 14:15:27 -0600 | [diff] [blame] | 68 | EXPECT_EQ(encoded, "ZjAAIEJh"); |
| 69 | |
Ed Tanous | 22ce545 | 2022-01-11 10:50:23 -0800 | [diff] [blame] | 70 | encoded = base64encode("f0\0 Bar"s); |
Adriana Kobylak | d830ff5 | 2021-01-27 14:15:27 -0600 | [diff] [blame] | 71 | EXPECT_EQ(encoded, "ZjAAIEJhcg=="); |
| 72 | } |
| 73 | |
| 74 | TEST(Utility, Base64EncodeDecodeString) |
| 75 | { |
| 76 | using namespace std::string_literals; |
| 77 | std::string data("Data fr\0m 90 reading a \nFile"s); |
Ed Tanous | 22ce545 | 2022-01-11 10:50:23 -0800 | [diff] [blame] | 78 | std::string encoded = base64encode(data); |
Adriana Kobylak | d830ff5 | 2021-01-27 14:15:27 -0600 | [diff] [blame] | 79 | std::string decoded; |
Ed Tanous | 22ce545 | 2022-01-11 10:50:23 -0800 | [diff] [blame] | 80 | EXPECT_TRUE(base64Decode(encoded, decoded)); |
Adriana Kobylak | d830ff5 | 2021-01-27 14:15:27 -0600 | [diff] [blame] | 81 | EXPECT_EQ(data, decoded); |
| 82 | } |
Nan Zhou | 1d8782e | 2021-11-29 22:23:18 -0800 | [diff] [blame] | 83 | |
Ed Tanous | eae855c | 2021-10-26 11:26:02 -0700 | [diff] [blame] | 84 | TEST(Utility, UrlFromPieces) |
| 85 | { |
Ed Tanous | eae855c | 2021-10-26 11:26:02 -0700 | [diff] [blame] | 86 | boost::urls::url url = urlFromPieces("redfish", "v1", "foo"); |
| 87 | EXPECT_EQ(std::string_view(url.data(), url.size()), "/redfish/v1/foo"); |
| 88 | |
| 89 | url = urlFromPieces("/", "badString"); |
| 90 | EXPECT_EQ(std::string_view(url.data(), url.size()), "/%2f/badString"); |
| 91 | |
| 92 | url = urlFromPieces("bad?tring"); |
| 93 | EXPECT_EQ(std::string_view(url.data(), url.size()), "/bad%3ftring"); |
| 94 | |
| 95 | url = urlFromPieces("/", "bad&tring"); |
| 96 | EXPECT_EQ(std::string_view(url.data(), url.size()), "/%2f/bad&tring"); |
| 97 | } |
Ed Tanous | 11baefe | 2022-02-09 12:14:12 -0800 | [diff] [blame] | 98 | |
Szymon Dompke | ca1600c | 2022-03-03 14:42:52 +0100 | [diff] [blame] | 99 | TEST(Utility, readUrlSegments) |
| 100 | { |
Szymon Dompke | ca1600c | 2022-03-03 14:42:52 +0100 | [diff] [blame] | 101 | boost::urls::result<boost::urls::url_view> parsed = |
| 102 | boost::urls::parse_relative_ref("/redfish/v1/Chassis#/Fans/0/Reading"); |
| 103 | |
| 104 | EXPECT_TRUE(readUrlSegments(*parsed, "redfish", "v1", "Chassis")); |
| 105 | |
| 106 | EXPECT_FALSE(readUrlSegments(*parsed, "FOOBAR", "v1", "Chassis")); |
| 107 | |
| 108 | EXPECT_FALSE(readUrlSegments(*parsed, "redfish", "v1")); |
| 109 | |
| 110 | EXPECT_FALSE( |
| 111 | readUrlSegments(*parsed, "redfish", "v1", "Chassis", "FOOBAR")); |
| 112 | |
| 113 | std::string out1; |
| 114 | std::string out2; |
| 115 | std::string out3; |
| 116 | EXPECT_TRUE(readUrlSegments(*parsed, "redfish", "v1", std::ref(out1))); |
| 117 | EXPECT_EQ(out1, "Chassis"); |
| 118 | |
| 119 | out1 = out2 = out3 = ""; |
| 120 | EXPECT_TRUE(readUrlSegments(*parsed, std::ref(out1), std::ref(out2), |
| 121 | std::ref(out3))); |
| 122 | EXPECT_EQ(out1, "redfish"); |
| 123 | EXPECT_EQ(out2, "v1"); |
| 124 | EXPECT_EQ(out3, "Chassis"); |
| 125 | |
| 126 | out1 = out2 = out3 = ""; |
| 127 | EXPECT_TRUE(readUrlSegments(*parsed, "redfish", std::ref(out1), "Chassis")); |
| 128 | EXPECT_EQ(out1, "v1"); |
| 129 | |
| 130 | out1 = out2 = out3 = ""; |
| 131 | EXPECT_TRUE(readUrlSegments(*parsed, std::ref(out1), "v1", std::ref(out2))); |
| 132 | EXPECT_EQ(out1, "redfish"); |
| 133 | EXPECT_EQ(out2, "Chassis"); |
| 134 | |
| 135 | EXPECT_FALSE(readUrlSegments(*parsed, "too", "short")); |
| 136 | |
| 137 | EXPECT_FALSE(readUrlSegments(*parsed, "too", "long", "too", "long")); |
| 138 | |
| 139 | EXPECT_FALSE( |
| 140 | readUrlSegments(*parsed, std::ref(out1), "v2", std::ref(out2))); |
| 141 | |
| 142 | EXPECT_FALSE(readUrlSegments(*parsed, "redfish", std::ref(out1), |
| 143 | std::ref(out2), std::ref(out3))); |
| 144 | |
| 145 | parsed = boost::urls::parse_relative_ref("/absolute/url"); |
| 146 | EXPECT_TRUE(readUrlSegments(*parsed, "absolute", "url")); |
| 147 | |
| 148 | parsed = boost::urls::parse_relative_ref("not/absolute/url"); |
| 149 | EXPECT_FALSE(readUrlSegments(*parsed, "not", "absolute", "url")); |
Ed Tanous | 7f8d8fa | 2022-08-19 07:00:38 -0700 | [diff] [blame^] | 150 | |
| 151 | parsed = boost::urls::parse_relative_ref("/excellent/path"); |
| 152 | |
| 153 | EXPECT_TRUE(readUrlSegments(*parsed, "excellent", "path", OrMorePaths())); |
| 154 | EXPECT_TRUE(readUrlSegments(*parsed, "excellent", OrMorePaths())); |
| 155 | EXPECT_TRUE(readUrlSegments(*parsed, OrMorePaths())); |
Szymon Dompke | ca1600c | 2022-03-03 14:42:52 +0100 | [diff] [blame] | 156 | } |
| 157 | |
Ed Tanous | 11baefe | 2022-02-09 12:14:12 -0800 | [diff] [blame] | 158 | TEST(Utility, ValidateAndSplitUrlPositive) |
| 159 | { |
Ed Tanous | 11baefe | 2022-02-09 12:14:12 -0800 | [diff] [blame] | 160 | std::string host; |
| 161 | std::string urlProto; |
Ed Tanous | eb1c47d | 2022-02-09 11:47:27 -0800 | [diff] [blame] | 162 | uint16_t port = 0; |
Ed Tanous | 11baefe | 2022-02-09 12:14:12 -0800 | [diff] [blame] | 163 | std::string path; |
| 164 | ASSERT_TRUE(validateAndSplitUrl("https://foo.com:18080/bar", urlProto, host, |
| 165 | port, path)); |
| 166 | EXPECT_EQ(host, "foo.com"); |
| 167 | EXPECT_EQ(urlProto, "https"); |
Ed Tanous | eb1c47d | 2022-02-09 11:47:27 -0800 | [diff] [blame] | 168 | EXPECT_EQ(port, 18080); |
Ed Tanous | 11baefe | 2022-02-09 12:14:12 -0800 | [diff] [blame] | 169 | |
| 170 | EXPECT_EQ(path, "/bar"); |
| 171 | |
| 172 | // query string |
| 173 | ASSERT_TRUE(validateAndSplitUrl("https://foo.com:18080/bar?foobar=1", |
| 174 | urlProto, host, port, path)); |
| 175 | EXPECT_EQ(path, "/bar?foobar=1"); |
| 176 | |
Ed Tanous | eb1c47d | 2022-02-09 11:47:27 -0800 | [diff] [blame] | 177 | // fragment |
| 178 | ASSERT_TRUE(validateAndSplitUrl("https://foo.com:18080/bar#frag", urlProto, |
| 179 | host, port, path)); |
| 180 | EXPECT_EQ(path, "/bar#frag"); |
| 181 | |
Ed Tanous | 11baefe | 2022-02-09 12:14:12 -0800 | [diff] [blame] | 182 | // Missing port |
| 183 | ASSERT_TRUE( |
| 184 | validateAndSplitUrl("https://foo.com/bar", urlProto, host, port, path)); |
Ed Tanous | eb1c47d | 2022-02-09 11:47:27 -0800 | [diff] [blame] | 185 | EXPECT_EQ(port, 443); |
Ed Tanous | 11baefe | 2022-02-09 12:14:12 -0800 | [diff] [blame] | 186 | |
Ed Tanous | eb1c47d | 2022-02-09 11:47:27 -0800 | [diff] [blame] | 187 | // Missing path defaults to "/" |
Ed Tanous | 11baefe | 2022-02-09 12:14:12 -0800 | [diff] [blame] | 188 | ASSERT_TRUE( |
Ed Tanous | eb1c47d | 2022-02-09 11:47:27 -0800 | [diff] [blame] | 189 | validateAndSplitUrl("https://foo.com/", urlProto, host, port, path)); |
| 190 | EXPECT_EQ(path, "/"); |
| 191 | |
| 192 | // If http push eventing is allowed, allow http and pick a default port of |
| 193 | // 80, if it's not, parse should fail. |
| 194 | ASSERT_EQ( |
| 195 | validateAndSplitUrl("http://foo.com/bar", urlProto, host, port, path), |
| 196 | bmcwebInsecureEnableHttpPushStyleEventing); |
| 197 | if constexpr (bmcwebInsecureEnableHttpPushStyleEventing) |
| 198 | { |
| 199 | EXPECT_EQ(port, 80); |
| 200 | } |
Ed Tanous | 11baefe | 2022-02-09 12:14:12 -0800 | [diff] [blame] | 201 | } |
| 202 | |
Ed Tanous | 4456f08 | 2022-03-08 18:01:18 -0800 | [diff] [blame] | 203 | TEST(Router, ParameterTagging) |
| 204 | { |
Nan Zhou | bf8ab7a | 2022-06-26 23:43:28 +0000 | [diff] [blame] | 205 | EXPECT_EQ(6 * 6 + 6 * 3 + 2, getParameterTag("<uint><double><int>")); |
| 206 | EXPECT_EQ(1, getParameterTag("<int>")); |
| 207 | EXPECT_EQ(2, getParameterTag("<uint>")); |
| 208 | EXPECT_EQ(3, getParameterTag("<float>")); |
| 209 | EXPECT_EQ(3, getParameterTag("<double>")); |
| 210 | EXPECT_EQ(4, getParameterTag("<str>")); |
| 211 | EXPECT_EQ(4, getParameterTag("<string>")); |
| 212 | EXPECT_EQ(5, getParameterTag("<path>")); |
| 213 | EXPECT_EQ(6 * 6 + 6 + 1, getParameterTag("<int><int><int>")); |
| 214 | EXPECT_EQ(6 * 6 + 6 + 2, getParameterTag("<uint><int><int>")); |
| 215 | EXPECT_EQ(6 * 6 + 6 * 3 + 2, getParameterTag("<uint><double><int>")); |
Ed Tanous | 4456f08 | 2022-03-08 18:01:18 -0800 | [diff] [blame] | 216 | } |
| 217 | |
Ed Tanous | 71f2db7 | 2022-05-25 12:28:09 -0700 | [diff] [blame] | 218 | TEST(URL, JsonEncoding) |
| 219 | { |
Ed Tanous | 71f2db7 | 2022-05-25 12:28:09 -0700 | [diff] [blame] | 220 | std::string urlString = "/foo"; |
Nan Zhou | bf8ab7a | 2022-06-26 23:43:28 +0000 | [diff] [blame] | 221 | EXPECT_EQ(nlohmann::json(boost::urls::url(urlString)), urlString); |
| 222 | EXPECT_EQ(nlohmann::json(boost::urls::url_view(urlString)), urlString); |
Ed Tanous | 71f2db7 | 2022-05-25 12:28:09 -0700 | [diff] [blame] | 223 | } |
| 224 | |
Ed Tanous | 22ce545 | 2022-01-11 10:50:23 -0800 | [diff] [blame] | 225 | } // namespace |
| 226 | } // namespace crow::utility |