StormByte::Crypto::KeyPair Namespace Reference

Keypairs of the Crypto module. More...

Classes
class	DSA
	DSA keypair. More...
class	ECC
	ECC keypair. More...
class	ECDH
	ECDH keypair. More...
class	ECDSA
	ECDSA keypair. More...
class	ED25519
	Ed25519 keypair. More...
class	Exception
	Exception from the key-pair component. More...
class	Generic
	Abstract keypair. More...
class	RSA
	RSA keypair. More...
class	X25519
	X25519 keypair. More...

Enumerations
enum class	Type {   DSA , ECC , ECDH , ECDSA ,   ED25519 , RSA , X25519 }
	Available keypair algorithms. More...
enum class	StorageFormat { PEM , DER }
	On-disk encoding. More...

Functions
Generic::PointerType	Create (Type type, unsigned short bits) noexcept
	Generate a keypair.
Generic::PointerType	Load (const std::filesystem::path &publicKeyPath, const std::filesystem::path &privateKeyPath) noexcept
	Load from separate public and private files.
Generic::PointerType	Load (const std::filesystem::path &publicKeyPath, const std::filesystem::path &privateKeyPath, const Secure::Password &password) noexcept
	Load from separate files; decrypt the private key if needed.
Generic::PointerType	Load (const std::filesystem::path &path) noexcept
	Load from one file (public, private, or concatenated PEM).
Generic::PointerType	Load (const std::filesystem::path &path, const Secure::Password &password) noexcept
	Load from one file; decrypt if needed.

Detailed Description

Keypairs of the Crypto module.

Key pairs of the Crypto module.

Enumeration Type Documentation

StorageFormat

enum class StormByte::Crypto::KeyPair::StorageFormat

strong

On-disk encoding.

Enumerator
PEM	OpenSSL PEM.
DER	Binary DER.

Type

enum class StormByte::Crypto::KeyPair::Type

strong

Available keypair algorithms.

Enumerator
DSA	DSA.
ECC	Elliptic-curve encryption.
ECDH	ECDH.
ECDSA	ECDSA.
ED25519	Ed25519.
RSA	RSA.
X25519	X25519.

Function Documentation

Create()

Generic::PointerType StormByte::Crypto::KeyPair::Create ( Type  type, unsigned short  bits  )

noexcept

Generate a keypair.

Parameters

type	Algorithm.
bits	Key size in bits.

Returns

Keypair pointer.

Load() [1/4]

Generic::PointerType StormByte::Crypto::KeyPair::Load ( const std::filesystem::path &  path )

noexcept

Load from one file (public, private, or concatenated PEM).

Parameters

path

Key file.

Returns

Keypair pointer, or nullptr.

Load() [2/4]

Generic::PointerType StormByte::Crypto::KeyPair::Load ( const std::filesystem::path &  path, const Secure::Password &  password  )

noexcept

Load from one file; decrypt if needed.

Parameters

path	Key file.
password	Password for encrypted private material.

Returns

Keypair pointer, or nullptr.

Load() [3/4]

Generic::PointerType StormByte::Crypto::KeyPair::Load ( const std::filesystem::path &  publicKeyPath, const std::filesystem::path &  privateKeyPath  )

noexcept

Load from separate public and private files.

Format is auto-detected.

Parameters

publicKeyPath	Public file, or empty.
privateKeyPath	Private file, or empty. No default: a single path is Load(const std::filesystem::path&).

Returns

Keypair pointer, or nullptr.

Load() [4/4]

Generic::PointerType StormByte::Crypto::KeyPair::Load ( const std::filesystem::path &  publicKeyPath, const std::filesystem::path &  privateKeyPath, const Secure::Password &  password  )

noexcept

Load from separate files; decrypt the private key if needed.

Parameters

publicKeyPath	Public file, or empty.
privateKeyPath	Private file.
password	Password for an encrypted private key.

Returns

Keypair pointer, or nullptr.