StormByte-Crypto 3.1.0
C++26 cryptography module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Crypto::Secret::X25519 Class Referencefinal

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.
StormByte::Safe::Optional< Secure::Password > Share (const StormByte::Safe::String &peerPublicKey) const 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 & operator= (const Clonable &)=default
virtual constexpr ~Clonable () noexcept=default

Static Public Member Functions

static StormByte::Safe::Optional< Secure::Password > DeriveSharedSecret (KeyPair::Generic::PointerType keypair, const StormByte::Safe::String &peerPublicKey)
 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.

Note
MaybeSafe inherits all provider requirements of StormByte::Crypto::Secret::Generic. This leaf adds no fields; exported Clone/Move bind ownership callbacks in Crypto.

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
keypairKeypair.

◆ X25519() [2/3]

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

Copy constructor.

Parameters
otherObject to copy.

◆ X25519() [3/3]

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

Move constructor.

Parameters
otherObject to move.

◆ ~X25519()

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

Destructor.

Member Function Documentation

◆ Clone()

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

Clone this object.

Returns
Shared pointer to the clone.

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

◆ DeriveSharedSecret()

StormByte::Safe::Optional< Secure::Password > StormByte::Crypto::Secret::X25519::DeriveSharedSecret ( KeyPair::Generic::PointerType keypair,
const StormByte::Safe::String & peerPublicKey )
static

Derive a shared secret without an instance.

Parameters
keypairLocal keypair (needs private key).
peerPublicKeyPeer public key as Base64, borrowed for this call.
Returns
Password on success, or empty.
Exceptions
StormByte::ExceptionIf Safe result storage cannot be created.

◆ Move()

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

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
otherObject to copy.
Returns
Reference to this object.

◆ operator=() [2/2]

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

Move assignment.

Parameters
otherObject to move.
Returns
Reference to this object.

◆ Share()

StormByte::Safe::Optional< Secure::Password > StormByte::Crypto::Secret::X25519::Share ( const StormByte::Safe::String & peerPublicKey) const
overridevirtual

Derive a shared secret.

Parameters
peerPublicKeyPeer public key as Base64, borrowed for this call.
Returns
Password on success, or empty.
Exceptions
StormByte::ExceptionIf Safe result storage cannot be created.

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


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