blob: 6633343427d9261a54f9f20e680866e73eef2b76 [file] [log] [blame]
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef NET_BASE_HASH_VALUE_H_
#define NET_BASE_HASH_VALUE_H_
#include <string.h>
#include <string>
#include <vector>
#include "base/containers/span.h"
#include "base/strings/string_piece.h"
#include "build/build_config.h"
#include "net/base/net_export.h"
#if defined(STARBOARD)
#include "starboard/configuration.h"
#include "starboard/memory.h"
#include "starboard/types.h"
#endif
namespace net {
struct NET_EXPORT SHA256HashValue {
unsigned char data[32];
};
inline bool operator==(const SHA256HashValue& lhs, const SHA256HashValue& rhs) {
return SbMemoryCompare(lhs.data, rhs.data, sizeof(lhs.data)) == 0;
}
inline bool operator!=(const SHA256HashValue& lhs, const SHA256HashValue& rhs) {
return SbMemoryCompare(lhs.data, rhs.data, sizeof(lhs.data)) != 0;
}
inline bool operator<(const SHA256HashValue& lhs, const SHA256HashValue& rhs) {
return SbMemoryCompare(lhs.data, rhs.data, sizeof(lhs.data)) < 0;
}
inline bool operator>(const SHA256HashValue& lhs, const SHA256HashValue& rhs) {
return SbMemoryCompare(lhs.data, rhs.data, sizeof(lhs.data)) > 0;
}
inline bool operator<=(const SHA256HashValue& lhs, const SHA256HashValue& rhs) {
return SbMemoryCompare(lhs.data, rhs.data, sizeof(lhs.data)) <= 0;
}
inline bool operator>=(const SHA256HashValue& lhs, const SHA256HashValue& rhs) {
return SbMemoryCompare(lhs.data, rhs.data, sizeof(lhs.data)) >= 0;
}
enum HashValueTag {
HASH_VALUE_SHA256,
};
class NET_EXPORT HashValue {
public:
explicit HashValue(const SHA256HashValue& hash);
explicit HashValue(HashValueTag tag) : tag_(tag) {}
HashValue() : tag_(HASH_VALUE_SHA256) {}
// Serializes/Deserializes hashes in the form of
// <hash-name>"/"<base64-hash-value>
// (eg: "sha256/...")
// This format may be persisted to permanent storage, so
// care should be taken before changing the serialization.
//
// This format is used for:
// - net_internals display/setting public-key pins
// - logging public-key pins
// - serializing public-key pins
// Deserializes a HashValue from a string. On error, returns
// false and MAY change the contents of HashValue to contain invalid data.
bool FromString(const base::StringPiece input);
// Serializes the HashValue to a string. If an invalid HashValue
// is supplied (eg: an unknown hash tag), returns "unknown"/<base64>
std::string ToString() const;
size_t size() const;
unsigned char* data();
const unsigned char* data() const;
HashValueTag tag() const { return tag_; }
NET_EXPORT friend bool operator==(const HashValue& lhs, const HashValue& rhs);
NET_EXPORT friend bool operator!=(const HashValue& lhs, const HashValue& rhs);
NET_EXPORT friend bool operator<(const HashValue& lhs, const HashValue& rhs);
NET_EXPORT friend bool operator>(const HashValue& lhs, const HashValue& rhs);
NET_EXPORT friend bool operator<=(const HashValue& lhs, const HashValue& rhs);
NET_EXPORT friend bool operator>=(const HashValue& lhs, const HashValue& rhs);
private:
HashValueTag tag_;
union {
SHA256HashValue sha256;
} fingerprint;
};
typedef std::vector<HashValue> HashValueVector;
// IsSHA256HashInSortedArray returns true iff |hash| is in |array|, a sorted
// array of SHA256 hashes.
bool IsSHA256HashInSortedArray(const HashValue& hash,
base::span<const SHA256HashValue> array);
#if defined(STARBOARD) && SB_IS(COMPILER_MSVC)
// MSVC can not implicitly convert HashValueVector to span<HashValue>.
bool IsAnySHA256HashInSortedArray(const HashValueVector& hashes,
base::span<const SHA256HashValue> array);
#endif
// IsAnySHA256HashInSortedArray returns true iff any value in |hashes| is in
// |array|, a sorted array of SHA256 hashes.
bool IsAnySHA256HashInSortedArray(base::span<const HashValue> hashes,
base::span<const SHA256HashValue> array);
} // namespace net
#endif // NET_BASE_HASH_VALUE_H_