mirror of
https://github.com/DarkStore-3DS/Project_CTR.git
synced 2026-07-03 08:49:03 +00:00
jakcron
166 lines
6.4 KiB
C++
166 lines
6.4 KiB
C++
/**
|
|
* @file Aes128CtrEncryptedStream.h
|
|
* @brief Declaration of tc::crypto::Aes128CtrEncryptedStream
|
|
* @author Jack (jakcron)
|
|
* @version 0.2
|
|
* @date 2022/02/13
|
|
**/
|
|
#pragma once
|
|
#include <list>
|
|
#include <tc/ByteData.h>
|
|
#include <tc/io/IStream.h>
|
|
#include <tc/crypto/Aes128CtrEncryptor.h>
|
|
|
|
#include <tc/ArgumentOutOfRangeException.h>
|
|
#include <tc/ObjectDisposedException.h>
|
|
#include <tc/NotSupportedException.h>
|
|
#include <tc/NotImplementedException.h>
|
|
#include <tc/io/IOException.h>
|
|
|
|
namespace tc { namespace crypto {
|
|
|
|
/**
|
|
* @class Aes128CtrEncryptedStream
|
|
* @brief Class for reading from a stream that is encrypted with AES128-CTR.
|
|
* @details This class takes an encrypted IStream, encryption parameters and creates an IStream that will transparently decrypt data when reading.
|
|
*/
|
|
class Aes128CtrEncryptedStream : public tc::io::IStream
|
|
{
|
|
public:
|
|
/**
|
|
* @brief This is the data-type for AES128-CTR key used with Aes128CtrEncryptedStream.
|
|
*
|
|
*/
|
|
using key_t = std::array<byte_t, tc::crypto::Aes128CtrEncryptor::kKeySize>;
|
|
|
|
/**
|
|
* @brief This is the data-type for AES128-CTR block counter used with Aes128CtrEncryptedStream.
|
|
*
|
|
*/
|
|
using counter_t = std::array<byte_t, tc::crypto::Aes128CtrEncryptor::kBlockSize>;
|
|
|
|
/**
|
|
* @brief This is the data-type for AES128-CTR data block used with Aes128CtrEncryptedStream.
|
|
*
|
|
*/
|
|
using block_t = std::array<byte_t, tc::crypto::Aes128CtrEncryptor::kBlockSize>;
|
|
|
|
/**
|
|
* @brief Default Constructor
|
|
* @post This will create an uninitialized Aes128CtrEncryptedStream, it will have to be assigned from a valid Aes128CtrEncryptedStream object to be usable.
|
|
**/
|
|
Aes128CtrEncryptedStream();
|
|
|
|
/**
|
|
* @brief Create Aes128CtrEncryptedStream
|
|
*
|
|
* @param[in] stream The base IStream object which this stream will decrypt data from.
|
|
* @param[in] key AES128 Encryption Key. See @ref key_t.
|
|
* @param[in] counter AES128-CTR Counter relative to offset 0x0 of the base stream. See @ref counter_t.
|
|
*
|
|
* @pre The sub stream must be a subset of the base stream.
|
|
* @pre A stream must support seeking for @ref seek to work.
|
|
*
|
|
* @throw tc::ArgumentNullException @p stream is a @p nullptr.
|
|
* @throw tc::NotSupportedException The base stream does not support seeking or reading.
|
|
**/
|
|
Aes128CtrEncryptedStream(const std::shared_ptr<tc::io::IStream>& stream, const key_t& key, const counter_t& counter);
|
|
|
|
/**
|
|
* @brief Indicates whether the current stream supports reading.
|
|
**/
|
|
bool canRead() const;
|
|
|
|
/**
|
|
* @brief Indicates whether the current stream supports writing.
|
|
**/
|
|
bool canWrite() const;
|
|
|
|
/**
|
|
* @brief Indicates whether the current stream supports seeking.
|
|
**/
|
|
bool canSeek() const;
|
|
|
|
/**
|
|
* @brief Gets the length in bytes of the stream.
|
|
**/
|
|
int64_t length();
|
|
|
|
/**
|
|
* @brief Gets the position within the current stream.
|
|
*
|
|
* @return This is returns the current position within the stream.
|
|
**/
|
|
int64_t position();
|
|
|
|
/**
|
|
* @brief Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
|
|
*
|
|
* @param[out] ptr Pointer to an array of bytes. When this method returns, @p ptr contains the specified byte array with the values between 0 and (@p count - 1) replaced by the bytes read from the current source.
|
|
* @param[in] count The maximum number of bytes to be read from the current stream.
|
|
*
|
|
* @return The total number of bytes read into @p ptr. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.
|
|
*
|
|
* @pre A stream must support reading for @ref read to work.
|
|
* @note Use @ref canRead to determine if this stream supports reading.
|
|
* @note Exceptions thrown by the base stream are not altered/intercepted, refer to that module's documentation for those exceptions.
|
|
*
|
|
* @throw tc::ArgumentOutOfRangeException @p count exceeds the length of readable data in the sub stream.
|
|
* @throw tc::ObjectDisposedException Methods were called after the stream was closed.
|
|
**/
|
|
size_t read(byte_t* ptr, size_t count);
|
|
|
|
/**
|
|
* @brief Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. @ref write is not implemented for @ref Aes128CtrEncryptedStream.
|
|
* @throw tc::NotImplementedException @ref write is not implemented for @ref Aes128CtrEncryptedStream.
|
|
* @throw tc::ObjectDisposedException Methods were called after the stream was closed.
|
|
**/
|
|
size_t write(const byte_t* ptr, size_t count);
|
|
|
|
/**
|
|
* @brief Sets the position within the current stream.
|
|
*
|
|
* @param[in] offset A byte offset relative to the origin parameter.
|
|
* @param[in] origin A value of type @ref tc::io::SeekOrigin indicating the reference point used to obtain the new position.
|
|
*
|
|
* @return The new position within the current stream.
|
|
*
|
|
* @pre A stream must support seeking for @ref seek to work.
|
|
* @note Use @ref canSeek to determine if this stream supports seeking.
|
|
* @note Exceptions thrown by the base stream are not altered/intercepted, refer to that module's documentation for those exceptions.
|
|
*
|
|
* @throw tc::ArgumentOutOfRangeException @p origin contains an invalid value.
|
|
* @throw tc::ObjectDisposedException Methods were called after the stream was closed.
|
|
**/
|
|
int64_t seek(int64_t offset, tc::io::SeekOrigin origin);
|
|
|
|
/**
|
|
* @brief Sets the length of the current stream. This is not implemented for @ref Aes128CtrEncryptedStream.
|
|
* @throw tc::NotImplementedException @ref setLength is not implemented for @ref Aes128CtrEncryptedStream.
|
|
* @throw tc::ObjectDisposedException Methods were called after the stream was closed.
|
|
**/
|
|
void setLength(int64_t length);
|
|
|
|
/**
|
|
* @brief Clears all buffers for this and the base stream and causes any buffered data to be written to the underlying device.
|
|
*
|
|
* @throw tc::io::IOException An I/O error occurs.
|
|
* @throw tc::ObjectDisposedException Methods were called after the stream was closed.
|
|
**/
|
|
void flush();
|
|
|
|
/**
|
|
* @brief Releases internal resources including base stream and clears internal state.
|
|
**/
|
|
void dispose();
|
|
private:
|
|
static const std::string kClassName;
|
|
|
|
// base source
|
|
std::shared_ptr<tc::io::IStream> mBaseStream;
|
|
|
|
// encryption cfg
|
|
std::shared_ptr<tc::crypto::Aes128CtrEncryptor> mCryptor;
|
|
};
|
|
|
|
}} // namespace tc::crypto
|