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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
// 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_HASH_FUNCTION_HPP
#define INCLUDED_SRC_BUILDTOOL_CRYPTO_HASH_FUNCTION_HPP
#include <cstddef>
#include <cstdint>
#include <filesystem>
#include <functional>
#include <optional>
#include <string>
#include <utility>
#include "gsl/gsl"
#include "src/buildtool/crypto/hasher.hpp"
/// \brief Hash function used for the entire buildtool.
class HashFunction {
public:
enum class Type : std::uint8_t {
GitSHA1, ///< SHA1 for plain hashes, and Git for blobs and trees.
PlainSHA256 ///< SHA256 for all hashes.
};
explicit HashFunction(Type type) noexcept : type_{type} {
static_assert(
sizeof(HashFunction) <= sizeof(void*),
"HashFunction is passed and stored by value. If the "
"class is extended so that its size exceeds the size of a pointer, "
"the way how HashFunction is passed and stored must be changed.");
}
[[nodiscard]] auto GetType() const noexcept -> Type { return type_; }
/// \brief Compute the blob hash of a string.
[[nodiscard]] auto HashBlobData(std::string const& data) const noexcept
-> Hasher::HashDigest;
/// \brief Compute the tree hash of a string.
[[nodiscard]] auto HashTreeData(std::string const& data) const noexcept
-> Hasher::HashDigest;
/// \brief Compute the plain hash of a string.
[[nodiscard]] auto PlainHashData(std::string const& data) const noexcept
-> Hasher::HashDigest;
/// \brief Compute the blob hash of a file or std::nullopt on IO error.
[[nodiscard]] auto HashBlobFile(
std::filesystem::path const& path) const noexcept
-> std::optional<std::pair<Hasher::HashDigest, std::uintmax_t>>;
/// \brief Compute the tree hash of a file or std::nullopt on IO error.
[[nodiscard]] auto HashTreeFile(
std::filesystem::path const& path) const noexcept
-> std::optional<std::pair<Hasher::HashDigest, std::uintmax_t>>;
/// \brief Obtain incremental hasher for computing plain hashes.
[[nodiscard]] auto MakeHasher() const noexcept -> Hasher {
std::optional<Hasher> hasher;
switch (type_) {
case Type::GitSHA1:
hasher = Hasher::Create(Hasher::HashType::SHA1);
break;
case Type::PlainSHA256:
hasher = Hasher::Create(Hasher::HashType::SHA256);
break;
}
Ensures(hasher.has_value());
return *std::move(hasher);
}
private:
Type const type_;
using TagCreator = std::function<std::string(std::size_t)>;
[[nodiscard]] auto HashTaggedLine(std::string const& data,
std::optional<TagCreator> tag_creator)
const noexcept -> Hasher::HashDigest;
[[nodiscard]] auto HashTaggedFile(
std::filesystem::path const& path,
TagCreator const& tag_creator) const noexcept
-> std::optional<std::pair<Hasher::HashDigest, std::uintmax_t>>;
};
[[nodiscard]] constexpr auto ToString(HashFunction::Type type) noexcept -> const
char* {
switch (type) {
case HashFunction::Type::GitSHA1:
return "git-SHA1";
case HashFunction::Type::PlainSHA256:
return "plain-SHA256";
}
Ensures(false); // unreachable
}
#endif // INCLUDED_SRC_BUILDTOOL_CRYPTO_HASH_FUNCTION_HPP
|
