A generic signer class. More...

#include <generic.hxx>

Inheritance diagram for StormByte::Crypto::Signer::Generic:

Collaboration diagram for StormByte::Crypto::Signer::Generic:

Public Member Functions
	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.

KeyPair::Generic::PointerType	KeyPair () const noexcept
	Gets the keypair used for asymmetric encryption.

bool	Sign (std::span< const std::byte > input, Buffer::WriteOnly &output) const noexcept
	Sign data from input span to output buffer.

bool	Sign (const Buffer::ReadOnly &input, Buffer::WriteOnly &output) const noexcept
	Sign data from input buffer to output buffer.

bool	Sign (Buffer::ReadOnly &input, Buffer::WriteOnly &output) const noexcept
	Sign data from input buffer to output buffer, moving the input data.

Buffer::Consumer	Sign (Buffer::Consumer consumer, ReadMode mode=ReadMode::Move) const noexcept
	Sign data from a Consumer buffer.

bool	Verify (std::span< const std::byte > input, const std::string &signature) const noexcept
	Verify data from input span to output buffer.

bool	Verify (const Buffer::ReadOnly &input, const std::string &signature) const noexcept
	Verify data from input buffer to output buffer.

bool	Verify (Buffer::ReadOnly &input, const std::string &signature) const noexcept
	Verify data from input buffer to output buffer, moving the input data.

bool	Verify (Buffer::Consumer consumer, const std::string &signature, ReadMode mode=ReadMode::Move) const noexcept
	Verify data from a Consumer buffer.

Protected Member Functions
	Generic (enum Type type, KeyPair::Generic::PointerType keypair)
	Constructor.

	Generic (enum Type type, const KeyPair::Generic &keypair)
	Constructor.

	Generic (enum Type type, KeyPair::Generic &&keypair)
	Constructor.

Protected Attributes
enum Type	m_type
	The type of signer.

KeyPair::Generic::PointerType	m_keypair
	The password used for asymmetric encryption.

Detailed Description

A generic signer class.

Constructor & Destructor Documentation

◆ Generic() [1/5]

StormByte::Crypto::Signer::Generic::Generic ( const Generic & other )

default

Copy constructor.

Parameters

other The other Generic signer to copy from.

◆ Generic() [2/5]

StormByte::Crypto::Signer::Generic::Generic ( Generic && other )

defaultnoexcept

Move constructor.

Parameters

other The other Generic signer to move from.

◆ Generic() [3/5]

StormByte::Crypto::Signer::Generic::Generic	(	enum Type	type,
		KeyPair::Generic::PointerType	keypair
	)

inlineprotected

Constructor.

Parameters

type	The type of signer.
keypair	The keypair used for asymmetric encryption.

◆ Generic() [4/5]

StormByte::Crypto::Signer::Generic::Generic	(	enum Type	type,
		const KeyPair::Generic &	keypair
	)

inlineprotected

Constructor.

Parameters

type	The type of signer.
keypair	The keypair used for asymmetric encryption.

◆ Generic() [5/5]

StormByte::Crypto::Signer::Generic::Generic	(	enum Type	type,
		KeyPair::Generic &&	keypair
	)

inlineprotected

Constructor.

Parameters

type	The type of signer.
keypair	The keypair used for asymmetric encryption.

Member Function Documentation

◆ KeyPair()

KeyPair::Generic::PointerType StormByte::Crypto::Signer::Generic::KeyPair ( ) const

inlinenoexcept

Gets the keypair used for asymmetric encryption.

Returns: The keypair.

◆ operator=() [1/2]

Generic & StormByte::Crypto::Signer::Generic::operator= ( const Generic & other )

default

Copy assignment operator.

Parameters

other The other Generic signer to copy from.

Returns: Reference to this Generic signer.

◆ operator=() [2/2]

Generic & StormByte::Crypto::Signer::Generic::operator= ( Generic && other )

defaultnoexcept

Move assignment operator.

Parameters

other The other Generic signer to move from.

Returns: Reference to this Generic signer.

◆ Sign() [1/4]

Buffer::Consumer StormByte::Crypto::Signer::Generic::Sign	(	Buffer::Consumer	consumer,
		ReadMode	mode = `ReadMode::Move`
	)		const

inlinenoexcept

Sign data from a Consumer buffer.

Parameters

consumer	The Consumer buffer to sign.
mode	The read mode indicating copy or move.

Returns: A Consumer buffer containing the signed data.

◆ Sign() [2/4]

bool StormByte::Crypto::Signer::Generic::Sign	(	Buffer::ReadOnly &	input,
		Buffer::WriteOnly &	output
	)		const

inlinenoexcept

Sign data from input buffer to output buffer, moving the input data.

Parameters

input	The input buffer to sign.
output	The output buffer to write the signed data to.

Returns: true if signing was successful, false otherwise.

◆ Sign() [3/4]

bool StormByte::Crypto::Signer::Generic::Sign	(	const Buffer::ReadOnly &	input,
		Buffer::WriteOnly &	output
	)		const

inlinenoexcept

Sign data from input buffer to output buffer.

Parameters

input	The input buffer to sign.
output	The output buffer to write the signed data to.

Returns: true if signing was successful, false otherwise.

◆ Sign() [4/4]

bool StormByte::Crypto::Signer::Generic::Sign	(	std::span< const std::byte >	input,
		Buffer::WriteOnly &	output
	)		const

inlinenoexcept

Sign data from input span to output buffer.

Parameters

input	The input data span to sign.
output	The output buffer to write the signed data to.

Returns: true if signing was successful, false otherwise.

◆ Verify() [1/4]

bool StormByte::Crypto::Signer::Generic::Verify	(	Buffer::Consumer	consumer,
		const std::string &	signature,
		ReadMode	mode = `ReadMode::Move`
	)		const

inlinenoexcept

Verify data from a Consumer buffer.

Parameters

consumer	The Consumer buffer to verify.
signature	The signature to verify against.
mode	The read mode indicating copy or move.

Returns: A Consumer buffer containing the verified data.

◆ Verify() [2/4]

bool StormByte::Crypto::Signer::Generic::Verify	(	Buffer::ReadOnly &	input,
		const std::string &	signature
	)		const

inlinenoexcept

Verify data from input buffer to output buffer, moving the input data.

Parameters

input	The input buffer to verify.
signature	The signature to verify against.

Returns: true if verification was successful, false otherwise.

◆ Verify() [3/4]

bool StormByte::Crypto::Signer::Generic::Verify	(	const Buffer::ReadOnly &	input,
		const std::string &	signature
	)		const

inlinenoexcept

Verify data from input buffer to output buffer.

Parameters

input	The input buffer to verify.
signature	The signature to verify against.

Returns: true if verification was successful, false otherwise.

◆ Verify() [4/4]

bool StormByte::Crypto::Signer::Generic::Verify	(	std::span< const std::byte >	input,
		const std::string &	signature
	)		const

inlinenoexcept

Verify data from input span to output buffer.

Parameters

input	The input buffer to verify.
signature	The signature to verify against.

Returns: true if verification was successful, false otherwise.

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

/home/runner/work/StormByte-Crypto/StormByte-Crypto/lib/public/StormByte/crypto/signer/generic.hxx

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Generic() [1/5]

◆ Generic() [2/5]

◆ Generic() [3/5]

◆ Generic() [4/5]

◆ Generic() [5/5]

Member Function Documentation

◆ KeyPair()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Sign() [1/4]

◆ Sign() [2/4]

◆ Sign() [3/4]

◆ Sign() [4/4]

◆ Verify() [1/4]

◆ Verify() [2/4]

◆ Verify() [3/4]

◆ Verify() [4/4]