StormByte::Crypto::Crypter::ECC Class Reference

An asymmetric crypter class. More...

#include <ecc.hxx>

Inheritance diagram for StormByte::Crypto::Crypter::ECC:

Collaboration diagram for StormByte::Crypto::Crypter::ECC:

Public Member Functions
	ECC (KeyPair::Generic::PointerType keypair)
	Constructor.
	ECC (const KeyPair::ECC &keypair)
	Constructor.
	ECC (KeyPair::ECC &&keypair)
	Constructor.
	ECC (const ECC &other)=default
	Copy constructor.
	ECC (ECC &&other) noexcept=default
	Move constructor.
virtual	~ECC () noexcept=default
	Virtual destructor.
ECC &	operator= (const ECC &other)=default
	Copy assignment operator.
ECC &	operator= (ECC &&other) noexcept=default
	Move assignment operator.
PointerType	Clone () const noexcept override
	Clone the ECC crypter.
PointerType	Move () noexcept override
	Move the ECC crypter.
Public Member Functions inherited from StormByte::Crypto::Crypter::Asymmetric
	Asymmetric (const Asymmetric &other)=default
	Copy constructor.
	Asymmetric (Asymmetric &&other) noexcept=default
	Move constructor.
virtual	~Asymmetric () noexcept=default
	Virtual destructor.
Asymmetric &	operator= (const Asymmetric &other)=default
	Copy assignment operator.
Asymmetric &	operator= (Asymmetric &&other) noexcept=default
	Move assignment operator.
KeyPair::Generic::PointerType	KeyPair () const noexcept
	Gets the keypair used for asymmetric encryption.
Public Member Functions inherited from StormByte::Crypto::Crypter::Generic
	Generic (const Generic &other)=default
	Copy constructor.
	Generic (Generic &&other) noexcept=default
	Move constructor.
virtual	~Generic () noexcept=default
	Virtual destructor.
Generic &	operator= (const Generic &other)=default
	Copy assignment operator.
Generic &	operator= (Generic &&other) noexcept=default
	Move assignment operator.
bool	Encrypt (std::span< const std::byte > input, Buffer::WriteOnly &output) const noexcept
	Encrypt data from input buffer to output buffer.
bool	Encrypt (const Buffer::ReadOnly &input, Buffer::WriteOnly &output) const noexcept
	Encrypt data from input buffer to output buffer.
bool	Encrypt (Buffer::ReadOnly &input, Buffer::WriteOnly &output) const noexcept
	Encrypt data from input buffer to output buffer, moving the input data.
Buffer::Consumer	Encrypt (Buffer::Consumer consumer, ReadMode mode=ReadMode::Move) const noexcept
	Encrypt data from a Consumer buffer.
bool	Decrypt (std::span< const std::byte > input, Buffer::WriteOnly &output) const noexcept
	Decrypt data from input buffer to output buffer.
bool	Decrypt (const Buffer::ReadOnly &input, Buffer::WriteOnly &output) const noexcept
	Decrypt data from input buffer to output buffer.
bool	Decrypt (Buffer::ReadOnly &input, Buffer::WriteOnly &output) const noexcept
	Decrypt data from input buffer to output buffer, moving the input data.
Buffer::Consumer	Decrypt (Buffer::Consumer consumer, ReadMode mode=ReadMode::Move) const noexcept
	Decrypt data from a Consumer buffer.
enum Type	Type () const noexcept
	Gets the type of crypter.

Additional Inherited Members
Protected Member Functions inherited from StormByte::Crypto::Crypter::Asymmetric
	Asymmetric (enum Type type, KeyPair::Generic::PointerType keypair)
	Constructor.
	Asymmetric (enum Type type, const KeyPair::Generic &keypair)
	Constructor.
	Asymmetric (enum Type type, KeyPair::Generic &&keypair)
	Constructor.
Protected Member Functions inherited from StormByte::Crypto::Crypter::Generic
	Generic (enum Type type)
	Constructor.
Protected Attributes inherited from StormByte::Crypto::Crypter::Asymmetric
KeyPair::Generic::PointerType	m_keypair
	The password used for asymmetric encryption.
Protected Attributes inherited from StormByte::Crypto::Crypter::Generic
enum Type	m_type
	The type of crypter.

Detailed Description

An asymmetric crypter class.

Constructor & Destructor Documentation

ECC() [1/5]

StormByte::Crypto::Crypter::ECC::ECC ( KeyPair::Generic::PointerType  keypair )

inline

Constructor.

Parameters

keypair

The keypair used for asymmetric encryption.

ECC() [2/5]

StormByte::Crypto::Crypter::ECC::ECC ( const KeyPair::ECC &  keypair )

inline

Constructor.

Parameters

keypair

The keypair used for asymmetric encryption.

ECC() [3/5]

StormByte::Crypto::Crypter::ECC::ECC ( KeyPair::ECC &&  keypair )

inline

Constructor.

Parameters

keypair

The keypair used for asymmetric encryption.

ECC() [4/5]

StormByte::Crypto::Crypter::ECC::ECC ( const ECC &  other )

default

Copy constructor.

Parameters

other

The other ECC crypter to copy from.

ECC() [5/5]

StormByte::Crypto::Crypter::ECC::ECC ( ECC &&  other )

defaultnoexcept

Move constructor.

Parameters

other

The other ECC crypter to move from.

Member Function Documentation

Clone()

PointerType StormByte::Crypto::Crypter::ECC::Clone ( ) const

inlineoverridenoexcept

Clone the ECC crypter.

Returns

A pointer to the cloned ECC crypter.

Move()

PointerType StormByte::Crypto::Crypter::ECC::Move ( )

inlineoverridenoexcept

Move the ECC crypter.

Returns

A pointer to the moved ECC crypter.

operator=() [1/2]

ECC & StormByte::Crypto::Crypter::ECC::operator= ( const ECC &  other )

default

Copy assignment operator.

Parameters

other

The other ECC crypter to copy from.

Returns

Reference to this ECC crypter.

operator=() [2/2]

ECC & StormByte::Crypto::Crypter::ECC::operator= ( ECC &&  other )

defaultnoexcept

Move assignment operator.

Parameters

other

The other ECC crypter to move from.

Returns

Reference to this ECC crypter.

---

The documentation for this class was generated from the following file:

• /home/runner/work/StormByte-Crypto/StormByte-Crypto/lib/public/StormByte/crypto/crypter/asymmetric/ecc.hxx