StormByte::Crypto::Secret::X25519 Class Reference

X25519 shared-secret derivation. More...

#include <StormByte/crypto/secret/x25519.hxx>

Inheritance diagram for StormByte::Crypto::Secret::X25519:

Collaboration diagram for StormByte::Crypto::Secret::X25519:

Public Member Functions
Generic::PointerType	Clone () const override
	Clone this object.
Generic::PointerType	Move () override
	Move this object into a new instance.
std::optional< Secure::Password >	Share (std::string_view peerPublicKey) const noexcept override
	Derive a shared secret.
Construction
	X25519 (KeyPair::Generic::PointerType keypair) noexcept
	Construct from an X25519 keypair (needs private key).
	X25519 (const X25519 &other)=default
	Copy constructor.
	X25519 (X25519 &&other) noexcept=default
	Move constructor.
	~X25519 () noexcept
	Destructor.
X25519 &	operator= (const X25519 &other)=default
	Copy assignment.
X25519 &	operator= (X25519 &&other) noexcept=default
	Move assignment.
Public Member Functions inherited from StormByte::Crypto::Secret::Generic
Type	Type () const noexcept
	Algorithm of this instance.
	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.
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

Static Public Member Functions
static std::optional< Secure::Password >	DeriveSharedSecret (KeyPair::Generic::PointerType keypair, std::string_view peerPublicKey) noexcept
	Derive a shared secret without an instance.
Static Public Member Functions inherited from StormByte::Safe::Clonable< Generic >
static PointerType	MakePointer (Args &&... args)

Additional Inherited Members
Public Types inherited from StormByte::Safe::Clonable< Generic >
typedef SmartPointer	PointerType
Protected Member Functions inherited from StormByte::Crypto::Secret::Generic
	Generic (enum Type type, KeyPair::Generic::PointerType keypair) noexcept
	Construct with algorithm and keypair.
Protected Attributes inherited from StormByte::Crypto::Secret::Generic
enum Type	m_type
	Algorithm.
KeyPair::Generic::PointerType	m_keypair
	Local keypair (needs private key)

Detailed Description

X25519 shared-secret derivation.

Constructor & Destructor Documentation

X25519() [1/3]

StormByte::Crypto::Secret::X25519::X25519 ( KeyPair::Generic::PointerType  keypair )

inlineexplicitnoexcept

Construct from an X25519 keypair (needs private key).

Parameters

keypair

Keypair.

X25519() [2/3]

StormByte::Crypto::Secret::X25519::X25519 ( const X25519 &  other )

default

Copy constructor.

Parameters

other

Object to copy.

X25519() [3/3]

StormByte::Crypto::Secret::X25519::X25519 ( X25519 &&  other )

defaultnoexcept

Move constructor.

Parameters

other

Object to move.

~X25519()

StormByte::Crypto::Secret::X25519::~X25519 ( )

noexcept

Destructor.

Member Function Documentation

Clone()

Generic::PointerType StormByte::Crypto::Secret::X25519::Clone ( ) const

inlineoverridevirtual

Clone this object.

Returns

Shared pointer to the clone.

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

DeriveSharedSecret()

static std::optional< Secure::Password > StormByte::Crypto::Secret::X25519::DeriveSharedSecret ( KeyPair::Generic::PointerType  keypair, std::string_view  peerPublicKey  )

staticnoexcept

Derive a shared secret without an instance.

Parameters

keypair	Local keypair (needs private key).
peerPublicKey	Peer public key as Base64. Accepts String and std::string via string_view.

Returns

Password on success, or empty.

Move()

Generic::PointerType StormByte::Crypto::Secret::X25519::Move ( )

inlineoverridevirtual

Move this object into a new instance.

Returns

Shared pointer to the moved object.

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

operator=() [1/2]

X25519 & StormByte::Crypto::Secret::X25519::operator= ( const X25519 &  other )

default

Copy assignment.

Parameters

other

Object to copy.

Returns

Reference to this object.

operator=() [2/2]

X25519 & StormByte::Crypto::Secret::X25519::operator= ( X25519 &&  other )

defaultnoexcept

Move assignment.

Parameters

other

Object to move.

Returns

Reference to this object.

Share()

std::optional< Secure::Password > StormByte::Crypto::Secret::X25519::Share ( std::string_view  peerPublicKey ) const

overridevirtualnoexcept

Derive a shared secret.

Parameters

peerPublicKey

Peer public key as Base64. Accepts String and std::string via string_view.

Returns

Password on success, or empty.

Implements StormByte::Crypto::Secret::Generic.

---

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

• lib/public/StormByte/crypto/secret/x25519.hxx