mirror of
https://github.com/juce-framework/JUCE.git
synced 2026-01-16 00:34:19 +00:00
107 lines
3.6 KiB
C++
107 lines
3.6 KiB
C++
/*
|
|
==============================================================================
|
|
|
|
This file is part of the JUCE library.
|
|
Copyright (c) 2013 - Raw Material Software Ltd.
|
|
|
|
Permission is granted to use this software under the terms of either:
|
|
a) the GPL v2 (or any later version)
|
|
b) the Affero GPL v3
|
|
|
|
Details of these licenses can be found at: www.gnu.org/licenses
|
|
|
|
JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
|
|
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
|
|
|
------------------------------------------------------------------------------
|
|
|
|
To release a closed-source product which uses JUCE, commercial licenses are
|
|
available: visit www.juce.com for more information.
|
|
|
|
==============================================================================
|
|
*/
|
|
|
|
#ifndef JUCE_SHA256_H_INCLUDED
|
|
#define JUCE_SHA256_H_INCLUDED
|
|
|
|
|
|
//==============================================================================
|
|
/**
|
|
SHA-256 secure hash generator.
|
|
|
|
Create one of these objects from a block of source data or a stream, and it
|
|
calculates the SHA-256 hash of that data.
|
|
|
|
You can retrieve the hash as a raw 32-byte block, or as a 64-digit hex string.
|
|
@see MD5
|
|
*/
|
|
class JUCE_API SHA256
|
|
{
|
|
public:
|
|
//==============================================================================
|
|
/** Creates an empty SHA256 object.
|
|
The default constructor just creates a hash filled with zeros. (This is not
|
|
equal to the hash of an empty block of data).
|
|
*/
|
|
SHA256() noexcept;
|
|
|
|
/** Destructor. */
|
|
~SHA256() noexcept;
|
|
|
|
/** Creates a copy of another SHA256. */
|
|
SHA256 (const SHA256& other) noexcept;
|
|
|
|
/** Copies another SHA256. */
|
|
SHA256& operator= (const SHA256& other) noexcept;
|
|
|
|
//==============================================================================
|
|
/** Creates a hash from a block of raw data. */
|
|
explicit SHA256 (const MemoryBlock& data);
|
|
|
|
/** Creates a hash from a block of raw data. */
|
|
SHA256 (const void* data, size_t numBytes);
|
|
|
|
/** Creates a hash from the contents of a stream.
|
|
|
|
This will read from the stream until the stream is exhausted, or until
|
|
maxBytesToRead bytes have been read. If maxBytesToRead is negative, the entire
|
|
stream will be read.
|
|
*/
|
|
SHA256 (InputStream& input, int64 maxBytesToRead = -1);
|
|
|
|
/** Reads a file and generates the hash of its contents.
|
|
If the file can't be opened, the hash will be left uninitialised (i.e. full
|
|
of zeros).
|
|
*/
|
|
explicit SHA256 (const File& file);
|
|
|
|
/** Creates a checksum from a UTF-8 buffer.
|
|
E.g.
|
|
@code SHA256 checksum (myString.toUTF8());
|
|
@endcode
|
|
*/
|
|
explicit SHA256 (CharPointer_UTF8 utf8Text) noexcept;
|
|
|
|
//==============================================================================
|
|
/** Returns the hash as a 32-byte block of data. */
|
|
MemoryBlock getRawData() const;
|
|
|
|
/** Returns the checksum as a 64-digit hex string. */
|
|
String toHexString() const;
|
|
|
|
//==============================================================================
|
|
bool operator== (const SHA256&) const noexcept;
|
|
bool operator!= (const SHA256&) const noexcept;
|
|
|
|
|
|
private:
|
|
//==============================================================================
|
|
uint8 result [32];
|
|
void process (const void*, size_t);
|
|
|
|
JUCE_LEAK_DETECTOR (SHA256)
|
|
};
|
|
|
|
|
|
#endif // JUCE_SHA256_H_INCLUDED
|