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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
#pragma once
#include <absl/status/statusor.h>
#include "libproto/worker.grpc.pb.h"
#include "libutil/serialise.hh"
#include "libutil/types.hh"
namespace nix {
// Size of the hashes rendered in store paths, in bytes
constexpr unsigned int kStorePathHashSize = 20;
MakeError(BadHash, Error);
// TODO(grfn): Replace this with the hash type enum from the daemon proto so we
// don't have to juggle two different types
enum HashType : char { htUnknown, htMD5, htSHA1, htSHA256, htSHA512 };
std::optional<HashType> hash_type_from(nix::proto::HashType hash_type);
nix::proto::HashType HashTypeToProto(HashType hash_type);
const int md5HashSize = 16;
const int sha1HashSize = 20;
const int sha256HashSize = 32;
const int sha512HashSize = 64;
// omitted: E O U T
constexpr char base32Chars[] = "0123456789abcdfghijklmnpqrsvwxyz";
enum Base : int { Base64, Base32, Base16, SRI };
struct Hash {
static const unsigned int maxHashSize = 64;
unsigned int hashSize = 0;
unsigned char hash[maxHashSize] = {};
HashType type = htUnknown;
/* Create an unset hash object. */
Hash(){};
/* Create a zero-filled hash object. */
explicit Hash(HashType type) : type(type) { init(); };
/* Initialize the hash from a string representation, in the format
"[<type>:]<base16|base32|base64>" or "<type>-<base64>" (a
Subresource Integrity hash expression). If the 'type' argument
is htUnknown, then the hash type must be specified in the
string. */
explicit Hash(std::string_view s, HashType type = htUnknown);
/* Status-returning version of above constructor */
static absl::StatusOr<Hash> deserialize(std::string_view s,
HashType type = htUnknown);
// Legacy unwrapper for StatusOr. Throws BadHash.
static Hash unwrap_throw(absl::StatusOr<Hash> hash) noexcept(false);
void init();
/* Check whether a hash is set. */
explicit operator bool() const { return type != htUnknown; }
/* Check whether two hash are equal. */
bool operator==(const Hash& h2) const;
/* Check whether two hash are not equal. */
bool operator!=(const Hash& h2) const;
/* For sorting. */
bool operator<(const Hash& h) const;
/* Returns the length of a base-16 representation of this hash. */
size_t base16Len() const { return hashSize * 2; }
/* Returns the length of a base-32 representation of this hash. */
size_t base32Len() const { return (hashSize * 8 - 1) / 5 + 1; }
/* Returns the length of a base-64 representation of this hash. */
size_t base64Len() const { return ((4 * hashSize / 3) + 3) & ~3; }
/* Return a string representation of the hash, in base-16, base-32
or base-64. By default, this is prefixed by the hash type
(e.g. "sha256:"). */
std::string to_string(Base base = Base32, bool includeType = true) const;
/* Returns whether the passed string contains entirely valid base16
characters. */
static bool IsValidBase16(absl::string_view s);
/* Returns whether the passed string contains entirely valid base32
characters. */
static bool IsValidBase32(absl::string_view s);
// Convert this Hash to the format expected in store paths
[[nodiscard]] std::string ToStorePathHash() const;
};
/* Print a hash in base-16 if it's MD5, or base-32 otherwise. */
std::string printHash16or32(const Hash& hash);
/* Compute the hash of the given string. */
Hash hashString(HashType ht, const std::string& s);
/* Compute the hash of the given file. */
Hash hashFile(HashType ht, const Path& path);
/* A pair of the Hash, and the number of bytes consumed. */
typedef std::pair<Hash, unsigned long long> HashResult;
/* Compute the hash of the given path. The hash is defined as
(essentially) hashString(ht, dumpPath(path)). */
HashResult hashPath(HashType ht, const Path& path,
PathFilter& filter = defaultPathFilter);
/* Compress a hash to the specified number of bytes by cyclically
XORing bytes together. */
Hash compressHash(const Hash& hash, unsigned int newSize);
/* Parse a string representing a hash type. */
HashType parseHashType(const std::string& s);
/* And the reverse. */
std::string printHashType(HashType ht);
namespace hash {
union Ctx;
}
class HashSink : public BufferedSink {
private:
HashType ht;
std::unique_ptr<hash::Ctx> ctx;
unsigned long long bytes;
public:
explicit HashSink(HashType ht);
HashSink(const HashSink& h);
~HashSink();
void write(const unsigned char* data, size_t len);
HashResult finish();
HashResult currentHash();
};
} // namespace nix
|
