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

Elliptic-curve crypter. More...

#include <StormByte/crypto/crypter/asymmetric/ecc.hxx>

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

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

Public Member Functions
PointerType	Clone () const noexcept override
	Clone this crypter.
PointerType	Move () noexcept override
	Move this crypter into a new instance.
Construction
	ECC (KeyPair::Generic::PointerType keypair)
	Construct from a keypair pointer.
	ECC (const KeyPair::ECC &keypair)
	Construct by cloning an ECC keypair.
	ECC (KeyPair::ECC &&keypair)
	Construct by moving an ECC keypair.
	ECC (const ECC &other)=default
	Copy constructor.
	ECC (ECC &&other) noexcept=default
	Move constructor.
	~ECC () noexcept
	Destructor.
ECC &	operator= (const ECC &other)=default
	Copy assignment.
ECC &	operator= (ECC &&other) noexcept=default
	Move assignment.
Public Member Functions inherited from StormByte::Crypto::Crypter::Asymmetric
KeyPair::Generic::PointerType	KeyPair () const noexcept
	Keypair used by this crypter.
	Asymmetric (const Asymmetric &other)=default
	Copy constructor.
	Asymmetric (Asymmetric &&other) noexcept=default
	Move constructor.
virtual	~Asymmetric () noexcept override
	Destructor.
Asymmetric &	operator= (const Asymmetric &other)=default
	Copy assignment.
Asymmetric &	operator= (Asymmetric &&other) noexcept=default
	Move assignment.
bool	Encrypt (std::span< const std::byte > input, Buffer::WriteOnly &output, Strategy strategy=Strategy::Native) const noexcept
	Encrypt a byte span.
bool	Encrypt (const Buffer::ReadOnly &input, Buffer::WriteOnly &output, Strategy strategy=Strategy::Native) const noexcept
	Encrypt a read-only buffer (copy).
bool	Encrypt (Buffer::ReadOnly &input, Buffer::WriteOnly &output, Strategy strategy=Strategy::Native) const noexcept
	Encrypt a buffer, consuming it.
Buffer::Consumer	Encrypt (Buffer::Consumer consumer, Strategy strategy=Strategy::Native, ReadMode mode=ReadMode::Move) const noexcept
	Encrypt a Consumer.
bool	Decrypt (std::span< const std::byte > input, Buffer::WriteOnly &output) const noexcept
	Decrypt a byte span.
bool	Decrypt (const Buffer::ReadOnly &input, Buffer::WriteOnly &output) const noexcept
	Decrypt a read-only buffer (copy).
bool	Decrypt (Buffer::ReadOnly &input, Buffer::WriteOnly &output) const noexcept
	Decrypt a buffer, consuming it.
Buffer::Consumer	Decrypt (Buffer::Consumer consumer, ReadMode mode=ReadMode::Move) const noexcept
	Decrypt a Consumer.
Public Member Functions inherited from StormByte::Crypto::Crypter::Generic
enum Type	Type () const noexcept
	Cipher of this crypter.
	Generic (const Generic &other)=default
	Copy constructor.
	Generic (Generic &&other) noexcept=default
	Move constructor.
virtual	~Generic () noexcept
	Destructor.
Generic &	operator= (const Generic &other)=default
	Copy assignment.
Generic &	operator= (Generic &&other) noexcept=default
	Move assignment.
bool	Encrypt (std::span< const std::byte > input, Buffer::WriteOnly &output) const noexcept
	Encrypt a byte span.
template<StormByte::Type::ByteInputRange Range>
bool	Encrypt (const Range &input, Buffer::WriteOnly &output) const
	Encrypt an input range of byte-convertible values.
bool	Encrypt (const Buffer::ReadOnly &input, Buffer::WriteOnly &output) const noexcept
	Encrypt a read-only buffer (copy).
bool	Encrypt (Buffer::ReadOnly &input, Buffer::WriteOnly &output) const noexcept
	Encrypt a buffer, consuming it.
Buffer::Consumer	Encrypt (Buffer::Consumer consumer, ReadMode mode=ReadMode::Move) const noexcept
	Encrypt a Consumer into another Consumer.
bool	Decrypt (std::span< const std::byte > input, Buffer::WriteOnly &output) const noexcept
	Decrypt a byte span.
template<StormByte::Type::ByteInputRange Range>
bool	Decrypt (const Range &input, Buffer::WriteOnly &output) const
	Decrypt an input range of byte-convertible values.
bool	Decrypt (const Buffer::ReadOnly &input, Buffer::WriteOnly &output) const noexcept
	Decrypt a read-only buffer (copy).
bool	Decrypt (Buffer::ReadOnly &input, Buffer::WriteOnly &output) const noexcept
	Decrypt a buffer, consuming it.
Buffer::Consumer	Decrypt (Buffer::Consumer consumer, ReadMode mode=ReadMode::Move) const noexcept
	Decrypt a Consumer into another Consumer.
Public Member Functions inherited from StormByte::Safe::Clonable< Generic >
constexpr	Clonable ()=default
constexpr	Clonable (const Clonable &)=default
constexpr	Clonable (Clonable &&) noexcept=default
constexpr Clonable &	operator= (const Clonable &)=default
constexpr Clonable &	operator= (Clonable &&) noexcept=default
virtual constexpr	~Clonable () noexcept=default

Additional Inherited Members
Public Types inherited from StormByte::Crypto::Crypter::Asymmetric
enum class	Strategy { Hybrid , Native }
	How payload bytes are sealed. More...
Public Types inherited from StormByte::Safe::Clonable< Generic >
typedef SmartPointer	PointerType
Static Public Member Functions inherited from StormByte::Safe::Clonable< Generic >
static PointerType	MakePointer (Args &&... args)
Protected Member Functions inherited from StormByte::Crypto::Crypter::Asymmetric
	Asymmetric (enum Type type, KeyPair::Generic::PointerType keypair)
	Construct from a keypair pointer.
	Asymmetric (enum Type type, const KeyPair::Generic &keypair)
	Construct by cloning a keypair.
	Asymmetric (enum Type type, KeyPair::Generic &&keypair)
	Construct by moving a keypair.
Protected Member Functions inherited from StormByte::Crypto::Crypter::Generic
	Generic (enum Type type)
	Construct with a cipher.
Protected Attributes inherited from StormByte::Crypto::Crypter::Asymmetric
KeyPair::Generic::PointerType	m_keypair
	Shared keypair.
Protected Attributes inherited from StormByte::Crypto::Crypter::Generic
enum Type	m_type
	Cipher.

Detailed Description

Elliptic-curve crypter.

Constructor & Destructor Documentation

ECC() [1/5]

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

inline

Construct from a keypair pointer.

Parameters

keypair

Keypair.

ECC() [2/5]

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

inline

Construct by cloning an ECC keypair.

Parameters

keypair

Keypair.

ECC() [3/5]

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

inline

Construct by moving an ECC keypair.

Parameters

keypair

Keypair.

ECC() [4/5]

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

default

Copy constructor.

Parameters

other

Crypter to copy.

ECC() [5/5]

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

defaultnoexcept

Move constructor.

Parameters

other

Crypter to move.

~ECC()

StormByte::Crypto::Crypter::ECC::~ECC ( )

noexcept

Destructor.

Member Function Documentation

Clone()

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

inlineoverridevirtualnoexcept

Clone this crypter.

Returns

Shared pointer to the clone.

Implements StormByte::Safe::Clonable< Generic >.

Move()

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

inlineoverridevirtualnoexcept

Move this crypter into a new instance.

Returns

Shared pointer to the moved crypter.

Implements StormByte::Safe::Clonable< Generic >.

operator=() [1/2]

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

default

Copy assignment.

Parameters

other

Crypter to copy.

Returns

Reference to this crypter.

operator=() [2/2]

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

defaultnoexcept

Move assignment.

Parameters

other

Crypter to move.

Returns

Reference to this crypter.

---

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

• lib/public/StormByte/crypto/crypter/asymmetric/ecc.hxx