#include <spake2p.h>

Public Member Functions
secure_vector< uint8_t >	serialize () const

Static Public Member Functions
static RegistrationRecord	deserialize (const SystemParameters &params, std::span< const uint8_t > record)
static RegistrationRecord	from_password (const SystemParameters &params, std::string_view password, std::span< const uint8_t > prover_id, std::span< const uint8_t > verifier_id, std::span< const uint8_t > salt, RandomNumberGenerator &rng)

Friends
class	ProverSecret
class	VerifierContext

Detailed Description

SPAKE2+ Registration Record

This is the information (w0 and L in RFC 9383) which the verifier stores in order to authenticate the prover.

Definition at line 159 of file spake2p.h.

Member Function Documentation

◆ deserialize()

RegistrationRecord Botan::SPAKE2p::RegistrationRecord::deserialize	(	const SystemParameters &	params,
		std::span< const uint8_t >	record )

static

Deserialize a RegistrationRecord previously serialized by serialize

Definition at line 261 of file spake2p.cpp.

                                                                                                                {
   const size_t scalar_len = params.group().get_order_bytes();
   const size_t point_len = params.share_size();
 
   if(record.size() != scalar_len + point_len) {
      throw Decoding_Error("Invalid length for SPAKE2+ registration record");
   }
 
   auto w0 = EC_Scalar::deserialize(params.group(), record.first(scalar_len));
   auto l = EC_AffinePoint::deserialize_uncompressed(params.group(), record.last(point_len));
 
   if(!w0 || !l) {
      throw Decoding_Error("Invalid SPAKE2+ registration record");
   }
 
   return RegistrationRecord(std::move(*w0), std::move(*l));
}

References Botan::EC_Scalar::deserialize(), Botan::EC_AffinePoint::deserialize_uncompressed(), Botan::EC_Group::get_order_bytes(), Botan::SPAKE2p::SystemParameters::group(), and Botan::SPAKE2p::SystemParameters::share_size().

Referenced by botan_spake2p_verifier_init().

◆ from_password()

RegistrationRecord Botan::SPAKE2p::RegistrationRecord::from_password	(	const SystemParameters &	params,
		std::string_view	password,
		std::span< const uint8_t >	prover_id,
		std::span< const uint8_t >	verifier_id,
		std::span< const uint8_t >	salt,
		RandomNumberGenerator &	rng )

static

Perform password registration, returning the registration record

This derives the record from the password using Argon2id; see ProverSecret::from_password for the details. The same password, identities, and salt must later be used to create the prover's secret.

The identities and salt may be empty.

Definition at line 252 of file spake2p.cpp.

                                                                                 {
   return ProverSecret::from_password(params, password, prover_id, verifier_id, salt).registration_record(rng);
}

References Botan::SPAKE2p::ProverSecret::from_password(), and Botan::SPAKE2p::ProverSecret::registration_record().

◆ serialize()

secure_vector< uint8_t > Botan::SPAKE2p::RegistrationRecord::serialize ( ) const

Serialize the registration record

Warning: the return value is the unencrypted registration record, which is a sensitive value allowing password guessing attacks. Encrypt it for persistent storage if possible.

Definition at line 279 of file spake2p.cpp.

                                                           {
   return concat<secure_vector<uint8_t>>(m_w0.serialize(), m_l.serialize_uncompressed());
}