blob: 49e9eeec3283f1bbc858e24ec731dd654bde90a0 (
plain)
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
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
// Copyright 2022 Huawei Cloud Computing Technology Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef INCLUDED_SRC_BUILDTOOL_CRYPTO_HASHER_HPP
#define INCLUDED_SRC_BUILDTOOL_CRYPTO_HASHER_HPP
#include <cstddef>
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
#include <utility> // std::move
#include "src/utils/cpp/hex_string.hpp"
/// \brief Incremental hasher.
class Hasher final {
public:
/// \brief Types of hash implementations supported by generator.
enum class HashType : std::uint8_t { SHA1, SHA256, SHA512 };
struct ShaContext;
/// \brief The universal hash digest.
/// The type of hash and the digest length depends on the hash
/// implementation used to generated this digest.
class HashDigest final {
friend Hasher;
public:
/// \brief Get pointer to raw bytes of digest.
/// Length can be obtained using \ref Length.
[[nodiscard]] auto Bytes() const& noexcept -> std::string const& {
return bytes_;
}
[[nodiscard]] auto Bytes() && noexcept -> std::string {
return std::move(bytes_);
}
/// \brief Get hexadecimal string of digest.
/// Length is twice the length of raw bytes (\ref Length).
[[nodiscard]] auto HexString() const -> std::string {
return ToHexString(bytes_);
}
/// \brief Get digest length in raw bytes.
[[nodiscard]] auto Length() const -> std::size_t {
return bytes_.size();
}
private:
std::string bytes_;
explicit HashDigest(std::string bytes) : bytes_{std::move(bytes)} {}
};
/// \brief Create and initialize a hasher
/// \return An initialized hasher on success or std::nullopt on failure.
[[nodiscard]] static auto Create(HashType type) noexcept
-> std::optional<Hasher>;
Hasher(Hasher&& other) noexcept;
auto operator=(Hasher&& other) noexcept -> Hasher&;
Hasher(Hasher const& other) noexcept = delete;
auto operator=(Hasher const& other) noexcept -> Hasher& = delete;
~Hasher() noexcept;
/// \brief Feed data to the hasher.
auto Update(std::string const& data) noexcept -> bool;
/// \brief Finalize hash.
[[nodiscard]] auto Finalize() && noexcept -> HashDigest;
/// \brief Obtain length of the resulting hash string.
[[nodiscard]] auto GetHashLength() const noexcept -> std::size_t;
private:
std::unique_ptr<ShaContext> sha_ctx_;
explicit Hasher(std::unique_ptr<ShaContext> sha_ctx) noexcept;
};
#endif // INCLUDED_SRC_BUILDTOOL_CRYPTO_HASHER_HPP
|
