C++ Essence Library 0.1.0
A Utility Library for Modern C++ Programming
Loading...
Searching...
No Matches
digest.hpp
1/*
2 * Copyright (c) 2024 The RefValue Project
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20 * THE SOFTWARE.
21 */
22
23#pragma once
24
25#include "../abi/string.hpp"
26#include "../abi/vector.hpp"
27#include "../compat.hpp"
28#include "../range.hpp"
29#include "../zstring_view.hpp"
30#include "common_types.hpp"
31
32#include <cstddef>
33#include <optional>
34#include <span>
35#include <string_view>
36
37namespace essence::crypto {
51 ES_API(CPPESSENCE) abi::string hex_encode(std::span<const std::byte> buffer, std::optional<char> delimiter = {});
52
60 ES_API(CPPESSENCE) abi::vector<std::byte> hex_decode(zstring_view hex, std::optional<char> delimiter = {});
61
69 ES_API(CPPESSENCE) abi::string md5_hash(std::span<const std::byte> buffer);
70
77 ES_API(CPPESSENCE) abi::string base64_encode(std::span<const std::byte> buffer);
78
85 ES_API(CPPESSENCE) abi::vector<std::byte> base64_decode(std::string_view encoded_text);
86
94 ES_API(CPPESSENCE)
95 abi::string hmac_hash(digest_mode mode, std::string_view key, std::span<const std::byte> buffer);
96
103 ES_API(CPPESSENCE) abi::string make_digest(digest_mode mode, std::span<const std::byte> buffer);
104
111 ES_API(CPPESSENCE) abi::string make_file_digest(digest_mode mode, std::string_view path);
112
113 template <byte_like_contiguous_range Range>
114 abi::string hex_encode(
115 Range&& range, std::optional<char> delimiter = {}) {
116 return hex_encode(as_const_byte_span(range), delimiter);
117 }
118
119 template <byte_like_contiguous_range Range>
120 abi::string md5_hash(Range&& range) {
121 return md5_hash(as_const_byte_span(range));
122 }
123
124 template <byte_like_contiguous_range Range>
125 abi::string base64_encode(Range&& range) {
126 return base64_encode(as_const_byte_span(range));
127 }
128
129 template <byte_like_contiguous_range Range>
130 abi::string hmac_hash(
131 digest_mode mode, std::string_view key, Range&& range) {
132 return hmac_hash(mode, key, as_const_byte_span(range));
133 }
134
135 template <byte_like_contiguous_range Range>
136 abi::string make_digest(digest_mode mode, Range&& range) {
137 return make_digest(mode, as_const_byte_span(range));
138 }
139} // namespace essence::crypto