#pragma once
#include <bmcweb_config.h>
#include <openssl/crypto.h>
#include <boost/callable_traits.hpp>
#include <boost/url/url.hpp>
#include <nlohmann/json.hpp>
#include <array>
#include <chrono>
#include <cstddef>
#include <cstdint>
#include <ctime>
#include <functional>
#include <iomanip>
#include <limits>
#include <stdexcept>
#include <string>
#include <string_view>
#include <tuple>
#include <type_traits>
#include <utility>
#include <variant>
namespace crow
{
namespace black_magic
{
enum class TypeCode : uint8_t
{
Unspecified = 0,
Integer = 1,
UnsignedInteger = 2,
Float = 3,
String = 4,
Path = 5,
Max = 6,
};
// Remove when we have c++23
template <typename E>
constexpr typename std::underlying_type<E>::type toUnderlying(E e) noexcept
{
return static_cast<typename std::underlying_type<E>::type>(e);
}
template <typename T>
constexpr TypeCode getParameterTag()
{
if constexpr (std::is_same_v<int, T>)
{
return TypeCode::Integer;
}
if constexpr (std::is_same_v<char, T>)
{
return TypeCode::Integer;
}
if constexpr (std::is_same_v<short, T>)
{
return TypeCode::Integer;
}
if constexpr (std::is_same_v<long, T>)
{
return TypeCode::Integer;
}
if constexpr (std::is_same_v<long long, T>)
{
return TypeCode::Integer;
}
if constexpr (std::is_same_v<unsigned int, T>)
{
return TypeCode::UnsignedInteger;
}
if constexpr (std::is_same_v<unsigned char, T>)
{
return TypeCode::UnsignedInteger;
}
if constexpr (std::is_same_v<unsigned short, T>)
{
return TypeCode::UnsignedInteger;
}
if constexpr (std::is_same_v<unsigned long, T>)
{
return TypeCode::UnsignedInteger;
}
if constexpr (std::is_same_v<unsigned long long, T>)
{
return TypeCode::UnsignedInteger;
}
if constexpr (std::is_same_v<double, T>)
{
return TypeCode::Float;
}
if constexpr (std::is_same_v<std::string, T>)
{
return TypeCode::String;
}
return TypeCode::Unspecified;
}
template <typename... Args>
struct computeParameterTagFromArgsList;
template <>
struct computeParameterTagFromArgsList<>
{
static constexpr int value = 0;
};
template <typename Arg, typename... Args>
struct computeParameterTagFromArgsList<Arg, Args...>
{
static constexpr int subValue =
computeParameterTagFromArgsList<Args...>::value;
static constexpr int value =
getParameterTag<typename std::decay<Arg>::type>() !=
TypeCode::Unspecified
? static_cast<unsigned long>(subValue *
toUnderlying(TypeCode::Max)) +
static_cast<uint64_t>(
getParameterTag<typename std::decay<Arg>::type>())
: subValue;
};
inline bool isParameterTagCompatible(uint64_t a, uint64_t b)
{
while (true)
{
if (a == 0 && b == 0)
{
// Both tags were equivalent, parameters are compatible
return true;
}
if (a == 0 || b == 0)
{
// one of the tags had more parameters than the other
return false;
}
TypeCode sa = static_cast<TypeCode>(a % toUnderlying(TypeCode::Max));
TypeCode sb = static_cast<TypeCode>(b % toUnderlying(TypeCode::Max));
if (sa == TypeCode::Path)
{
sa = TypeCode::String;
}
if (sb == TypeCode::Path)
{
sb = TypeCode::String;
}
if (sa != sb)
{
return false;
}
a /= toUnderlying(TypeCode::Max);
b /= toUnderlying(TypeCode::Max);
}
return false;
}
constexpr inline uint64_t getParameterTag(std::string_view url)
{
uint64_t tagValue = 0;
size_t urlSegmentIndex = std::string_view::npos;
size_t paramIndex = 0;
for (size_t urlIndex = 0; urlIndex < url.size(); urlIndex++)
{
char character = url[urlIndex];
if (character == '<')
{
if (urlSegmentIndex != std::string_view::npos)
{
return 0;
}
urlSegmentIndex = urlIndex;
}
if (character == '>')
{
if (urlSegmentIndex == std::string_view::npos)
{
return 0;
}
std::string_view tag =
url.substr(urlSegmentIndex, urlIndex + 1 - urlSegmentIndex);
// Note, this is a really lame way to do std::pow(6, paramIndex)
// std::pow doesn't work in constexpr in clang.
// Ideally in the future we'd move this to use a power of 2 packing
// (probably 8 instead of 6) so that these just become bit shifts
uint64_t insertIndex = 1;
for (size_t unused = 0; unused < paramIndex; unused++)
{
insertIndex *= 6;
}
if (tag == "<int>")
{
tagValue += insertIndex * toUnderlying(TypeCode::Integer);
}
if (tag == "<uint>")
{
tagValue +=
insertIndex * toUnderlying(TypeCode::UnsignedInteger);
}
if (tag == "<float>" || tag == "<double>")
{
tagValue += insertIndex * toUnderlying(TypeCode::Float);
}
if (tag == "<str>" || tag == "<string>")
{
tagValue += insertIndex * toUnderlying(TypeCode::String);
}
if (tag == "<path>")
{
tagValue += insertIndex * toUnderlying(TypeCode::Path);
}
paramIndex++;
urlSegmentIndex = std::string_view::npos;
}
}
if (urlSegmentIndex != std::string_view::npos)
{
return 0;
}
return tagValue;
}
template <typename... T>
struct S
{
template <typename U>
using push = S<U, T...>;
template <typename U>
using push_back = S<T..., U>;
template <template <typename... Args> class U>
using rebind = U<T...>;
};
template <typename F, typename Set>
struct CallHelper;
template <typename F, typename... Args>
struct CallHelper<F, S<Args...>>
{
template <typename F1, typename... Args1,
typename = decltype(std::declval<F1>()(std::declval<Args1>()...))>
static char test(int);
template <typename...>
static int test(...);
static constexpr bool value = sizeof(test<F, Args...>(0)) == sizeof(char);
};
template <uint64_t N>
struct SingleTagToType
{};
template <>
struct SingleTagToType<1>
{
using type = int64_t;
};
template <>
struct SingleTagToType<2>
{
using type = uint64_t;
};
template <>
struct SingleTagToType<3>
{
using type = double;
};
template <>
struct SingleTagToType<4>
{
using type = std::string;
};
template <>
struct SingleTagToType<5>
{
using type = std::string;
};
template <uint64_t Tag>
struct Arguments
{
using subarguments = typename Arguments<Tag / 6>::type;
using type = typename subarguments::template push<
typename SingleTagToType<Tag % 6>::type>;
};
template <>
struct Arguments<0>
{
using type = S<>;
};
template <typename T>
struct Promote
{
using type = T;
};
template <typename T>
using PromoteT = typename Promote<T>::type;
template <>
struct Promote<char>
{
using type = int64_t;
};
template <>
struct Promote<short>
{
using type = int64_t;
};
template <>
struct Promote<int>
{
using type = int64_t;
};
template <>
struct Promote<long>
{
using type = int64_t;
};
template <>
struct Promote<long long>
{
using type = int64_t;
};
template <>
struct Promote<unsigned char>
{
using type = uint64_t;
};
template <>
struct Promote<unsigned short>
{
using type = uint64_t;
};
template <>
struct Promote<unsigned int>
{
using type = uint64_t;
};
template <>
struct Promote<unsigned long>
{
using type = uint64_t;
};
template <>
struct Promote<unsigned long long>
{
using type = uint64_t;
};
} // namespace black_magic
namespace utility
{
template <typename T>
struct FunctionTraits
{
template <size_t i>
using arg = std::tuple_element_t<i, boost::callable_traits::args_t<T>>;
};
inline std::string base64encode(const std::string_view data)
{
const std::array<char, 64> key = {
'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M',
'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z',
'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm',
'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z',
'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '+', '/'};
size_t size = data.size();
std::string ret;
ret.resize((size + 2) / 3 * 4);
auto it = ret.begin();
size_t i = 0;
while (i < size)
{
size_t keyIndex = 0;
keyIndex = static_cast<size_t>(data[i] & 0xFC) >> 2;
*it++ = key[keyIndex];
if (i + 1 < size)
{
keyIndex = static_cast<size_t>(data[i] & 0x03) << 4;
keyIndex += static_cast<size_t>(data[i + 1] & 0xF0) >> 4;
*it++ = key[keyIndex];
if (i + 2 < size)
{
keyIndex = static_cast<size_t>(data[i + 1] & 0x0F) << 2;
keyIndex += static_cast<size_t>(data[i + 2] & 0xC0) >> 6;
*it++ = key[keyIndex];
keyIndex = static_cast<size_t>(data[i + 2] & 0x3F);
*it++ = key[keyIndex];
}
else
{
keyIndex = static_cast<size_t>(data[i + 1] & 0x0F) << 2;
*it++ = key[keyIndex];
*it++ = '=';
}
}
else
{
keyIndex = static_cast<size_t>(data[i] & 0x03) << 4;
*it++ = key[keyIndex];
*it++ = '=';
*it++ = '=';
}
i += 3;
}
return ret;
}
// TODO this is temporary and should be deleted once base64 is refactored out of
// crow
inline bool base64Decode(const std::string_view input, std::string& output)
{
static const char nop = static_cast<char>(-1);
// See note on encoding_data[] in above function
static const std::array<char, 256> decodingData = {
nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop,
nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop,
nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop,
nop, 62, nop, nop, nop, 63, 52, 53, 54, 55, 56, 57, 58, 59,
60, 61, nop, nop, nop, nop, nop, nop, nop, 0, 1, 2, 3, 4,
5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18,
19, 20, 21, 22, 23, 24, 25, nop, nop, nop, nop, nop, nop, 26,
27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40,
41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, nop, nop, nop,
nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop,
nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop,
nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop,
nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop,
nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop,
nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop,
nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop,
nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop,
nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop, nop,
nop, nop, nop, nop};
size_t inputLength = input.size();
// allocate space for output string
output.clear();
output.reserve(((inputLength + 2) / 3) * 4);
auto getCodeValue = [](char c) {
auto code = static_cast<unsigned char>(c);
// Ensure we cannot index outside the bounds of the decoding array
static_assert(std::numeric_limits<decltype(code)>::max() <
decodingData.size());
return decodingData[code];
};
// for each 4-bytes sequence from the input, extract 4 6-bits sequences by
// dropping first two bits
// and regenerate into 3 8-bits sequences
for (size_t i = 0; i < inputLength; i++)
{
char base64code0 = 0;
char base64code1 = 0;
char base64code2 = 0; // initialized to 0 to suppress warnings
char base64code3 = 0;
base64code0 = getCodeValue(input[i]);
if (base64code0 == nop)
{ // non base64 character
return false;
}
if (!(++i < inputLength))
{ // we need at least two input bytes for first
// byte output
return false;
}
base64code1 = getCodeValue(input[i]);
if (base64code1 == nop)
{ // non base64 character
return false;
}
output +=
static_cast<char>((base64code0 << 2) | ((base64code1 >> 4) & 0x3));
if (++i < inputLength)
{
char c = input[i];
if (c == '=')
{ // padding , end of input
return (base64code1 & 0x0f) == 0;
}
base64code2 = getCodeValue(input[i]);
if (base64code2 == nop)
{ // non base64 character
return false;
}
output += static_cast<char>(((base64code1 << 4) & 0xf0) |
((base64code2 >> 2) & 0x0f));
}
if (++i < inputLength)
{
char c = input[i];
if (c == '=')
{ // padding , end of input
return (base64code2 & 0x03) == 0;
}
base64code3 = getCodeValue(input[i]);
if (base64code3 == nop)
{ // non base64 character
return false;
}
output +=
static_cast<char>((((base64code2 << 6) & 0xc0) | base64code3));
}
}
return true;
}
inline bool constantTimeStringCompare(const std::string_view a,
const std::string_view b)
{
// Important note, this function is ONLY constant time if the two input
// sizes are the same
if (a.size() != b.size())
{
return false;
}
return CRYPTO_memcmp(a.data(), b.data(), a.size()) == 0;
}
struct ConstantTimeCompare
{
bool operator()(const std::string_view a, const std::string_view b) const
{
return constantTimeStringCompare(a, b);
}
};
namespace details
{
inline boost::urls::url
appendUrlPieces(boost::urls::url& url,
const std::initializer_list<std::string_view> args)
{
for (const std::string_view& arg : args)
{
url.segments().push_back(arg);
}
return url;
}
inline boost::urls::url
urlFromPiecesDetail(const std::initializer_list<std::string_view> args)
{
boost::urls::url url("/");
appendUrlPieces(url, args);
return url;
}
} // namespace details
class OrMorePaths
{};
template <typename... AV>
inline boost::urls::url urlFromPieces(const AV... args)
{
return details::urlFromPiecesDetail({args...});
}
template <typename... AV>
inline void appendUrlPieces(boost::urls::url& url, const AV... args)
{
details::appendUrlPieces(url, {args...});
}
namespace details
{
// std::reference_wrapper<std::string> - extracts segment to variable
// std::string_view - checks if segment is equal to variable
using UrlSegment = std::variant<std::reference_wrapper<std::string>,
std::string_view, OrMorePaths>;
enum class UrlParseResult
{
Continue,
Fail,
Done,
};
class UrlSegmentMatcherVisitor
{
public:
UrlParseResult operator()(std::string& output)
{
output = std::string_view(segment.data(), segment.size());
return UrlParseResult::Continue;
}
UrlParseResult operator()(std::string_view expected)
{
if (std::string_view(segment.data(), segment.size()) == expected)
{
return UrlParseResult::Continue;
}
return UrlParseResult::Fail;
}
UrlParseResult operator()(OrMorePaths /*unused*/)
{
return UrlParseResult::Done;
}
explicit UrlSegmentMatcherVisitor(
const boost::urls::string_value& segmentIn) :
segment(segmentIn)
{}
private:
const boost::urls::string_value& segment;
};
inline bool readUrlSegments(const boost::urls::url_view& urlView,
std::initializer_list<UrlSegment>&& segments)
{
const boost::urls::segments_view& urlSegments = urlView.segments();
if (!urlSegments.is_absolute())
{
return false;
}
boost::urls::segments_view::iterator it = urlSegments.begin();
boost::urls::segments_view::iterator end = urlSegments.end();
for (const auto& segment : segments)
{
if (it == end)
{
// If the request ends with an "any" path, this was successful
return std::holds_alternative<OrMorePaths>(segment);
}
UrlParseResult res = std::visit(UrlSegmentMatcherVisitor(*it), segment);
if (res == UrlParseResult::Done)
{
return true;
}
if (res == UrlParseResult::Fail)
{
return false;
}
it++;
}
// There will be an empty segment at the end if the URI ends with a "/"
// e.g. /redfish/v1/Chassis/
if ((it != end) && urlSegments.back().empty())
{
it++;
}
return it == end;
}
} // namespace details
template <typename... Args>
inline bool readUrlSegments(const boost::urls::url_view& urlView,
Args&&... args)
{
return details::readUrlSegments(urlView, {std::forward<Args>(args)...});
}
inline boost::urls::url replaceUrlSegment(const boost::urls::url_view& urlView,
const uint replaceLoc,
const std::string_view newSegment)
{
const boost::urls::segments_view& urlSegments = urlView.segments();
boost::urls::url url("/");
if (!urlSegments.is_absolute())
{
return url;
}
boost::urls::segments_view::iterator it = urlSegments.begin();
boost::urls::segments_view::iterator end = urlSegments.end();
for (uint idx = 0; it != end; it++, idx++)
{
if (idx == replaceLoc)
{
url.segments().push_back(newSegment);
}
else
{
url.segments().push_back(*it);
}
}
return url;
}
inline std::string setProtocolDefaults(const boost::urls::url_view& url)
{
if (url.scheme() == "https")
{
return "https";
}
if (url.scheme() == "http")
{
if (bmcwebInsecureEnableHttpPushStyleEventing)
{
return "http";
}
return "";
}
return "";
}
inline uint16_t setPortDefaults(const boost::urls::url_view& url)
{
uint16_t port = url.port_number();
if (port != 0)
{
// user picked a port already.
return port;
}
// If the user hasn't explicitly stated a port, pick one explicitly for them
// based on the protocol defaults
if (url.scheme() == "http")
{
return 80;
}
if (url.scheme() == "https")
{
return 443;
}
return 0;
}
inline bool validateAndSplitUrl(std::string_view destUrl, std::string& urlProto,
std::string& host, uint16_t& port,
std::string& path)
{
boost::string_view urlBoost(destUrl.data(), destUrl.size());
boost::urls::result<boost::urls::url_view> url =
boost::urls::parse_uri(urlBoost);
if (!url)
{
return false;
}
urlProto = setProtocolDefaults(url.value());
if (urlProto.empty())
{
return false;
}
port = setPortDefaults(url.value());
host = std::string_view(url->encoded_host().data(),
url->encoded_host().size());
path = std::string_view(url->encoded_path().data(),
url->encoded_path().size());
if (path.empty())
{
path = "/";
}
if (url->has_fragment())
{
path += '#';
path += std::string_view(url->encoded_fragment().data(),
url->encoded_fragment().size());
}
if (url->has_query())
{
path += '?';
path += std::string_view(url->encoded_query().data(),
url->encoded_query().size());
}
return true;
}
} // namespace utility
} // namespace crow
namespace nlohmann
{
template <>
struct adl_serializer<boost::urls::url>
{
// nlohmann requires a specific casing to look these up in adl
// NOLINTNEXTLINE(readability-identifier-naming)
static void to_json(json& j, const boost::urls::url& url)
{
j = url.string();
}
};
template <>
struct adl_serializer<boost::urls::url_view>
{
// NOLINTNEXTLINE(readability-identifier-naming)
static void to_json(json& j, const boost::urls::url_view& url)
{
j = url.string();
}
};
} // namespace nlohmann