1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-05-18 16:05:06 +00:00
serenity/Userland/Libraries/LibCrypto/Hash/HashFunction.h
Linus Groh 6e19ab2bbc AK+Everywhere: Rename String to DeprecatedString
We have a new, improved string type coming up in AK (OOM aware, no null
state), and while it's going to use UTF-8, the name UTF8String is a
mouthful - so let's free up the String name by renaming the existing
class.
Making the old one have an annoying name will hopefully also help with
quick adoption :^)
2022-12-06 08:54:33 +01:00

62 lines
1.7 KiB
C++

/*
* Copyright (c) 2020, Ali Mohammad Pur <mpfard@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/ByteBuffer.h>
#include <AK/StringView.h>
#include <AK/Types.h>
namespace Crypto {
namespace Hash {
template<size_t DigestS>
struct Digest {
static_assert(DigestS % 8 == 0);
constexpr static size_t Size = DigestS / 8;
u8 data[Size];
[[nodiscard]] ALWAYS_INLINE u8 const* immutable_data() const { return data; }
[[nodiscard]] ALWAYS_INLINE size_t data_length() const { return Size; }
[[nodiscard]] ALWAYS_INLINE ReadonlyBytes bytes() const { return { immutable_data(), data_length() }; }
};
template<size_t BlockS, size_t DigestS, typename DigestT = Digest<DigestS>>
class HashFunction {
public:
static_assert(BlockS % 8 == 0);
static constexpr auto BlockSize = BlockS / 8;
static_assert(DigestS % 8 == 0);
static constexpr auto DigestSize = DigestS / 8;
using DigestType = DigestT;
constexpr static size_t block_size() { return BlockSize; }
constexpr static size_t digest_size() { return DigestSize; }
virtual void update(u8 const*, size_t) = 0;
void update(Bytes buffer) { update(buffer.data(), buffer.size()); }
void update(ReadonlyBytes buffer) { update(buffer.data(), buffer.size()); }
void update(ByteBuffer const& buffer) { update(buffer.data(), buffer.size()); }
void update(StringView string) { update((u8 const*)string.characters_without_null_termination(), string.length()); }
virtual DigestType peek() = 0;
virtual DigestType digest() = 0;
virtual void reset() = 0;
#ifndef KERNEL
virtual DeprecatedString class_name() const = 0;
#endif
protected:
virtual ~HashFunction() = default;
};
}
}