#include <bppp.hpp>

Public Member Functions
	KeyPair (const KeyPair &)=delete

KeyPair &	operator= (const KeyPair &)=delete

	KeyPair (KeyPair &&other) noexcept=default

KeyPair &	operator= (KeyPair &&other) noexcept=default

	~KeyPair ()=default

const PublicKey &	public_key () const noexcept
	Returns the public key bundle associated with this signer.

Result< PreparedNonce >	prepare_message_nonce (std::span< const unsigned char > message, purify_secp_context *secp_context) const
	Deterministically prepares a message-bound nonce.

Result< PreparedNonceWithProof >	prepare_message_nonce_with_proof (std::span< const unsigned char > message, purify_secp_context secp_context, bppp::ExperimentalCircuitBackend circuit_cache=nullptr) const
	Deterministically prepares a message-bound nonce together with its BPPP proof.

Result< PreparedNonceWithProof >	prepare_message_nonce_with_proof (const MessageProofCache &cache, purify_secp_context secp_context, bppp::ExperimentalCircuitBackend circuit_cache=nullptr) const
	Prepares a message-bound nonce proof using a reusable message cache.

Result< PreparedNonce >	prepare_topic_nonce (std::span< const unsigned char > topic, purify_secp_context *secp_context) const
	Deterministically prepares a topic-bound nonce.

Result< PreparedNonceWithProof >	prepare_topic_nonce_with_proof (std::span< const unsigned char > topic, purify_secp_context secp_context, bppp::ExperimentalCircuitBackend circuit_cache=nullptr) const
	Deterministically prepares a topic-bound nonce together with its BPPP proof.

Result< PreparedNonceWithProof >	prepare_topic_nonce_with_proof (const TopicProofCache &cache, purify_secp_context secp_context, bppp::ExperimentalCircuitBackend circuit_cache=nullptr) const
	Prepares a topic-bound nonce proof using a reusable topic cache.

Result< Signature >	sign_message (std::span< const unsigned char > message, purify_secp_context *secp_context) const
	Signs a message with a deterministically derived message-bound nonce.

Result< Signature >	sign_message_with_prepared (std::span< const unsigned char > message, PreparedNonce &&prepared, purify_secp_context *secp_context) const
	Signs a message using an already prepared message-bound nonce.

Result< ProvenSignature >	sign_message_with_prepared_proof (std::span< const unsigned char > message, PreparedNonceWithProof &&prepared, purify_secp_context *secp_context) const
	Signs a message using an already prepared message-bound nonce proof bundle.

Result< Signature >	sign_with_topic (std::span< const unsigned char > message, std::span< const unsigned char > topic, purify_secp_context *secp_context) const
	Signs a message using a topic-bound deterministic nonce.

Result< Signature >	sign_with_prepared_topic (std::span< const unsigned char > message, PreparedNonce &&prepared, purify_secp_context *secp_context) const
	Signs a message using an already prepared topic-bound nonce.

Result< ProvenSignature >	sign_with_prepared_topic_proof (std::span< const unsigned char > message, PreparedNonceWithProof &&prepared, purify_secp_context *secp_context) const
	Signs a message using an already prepared topic-bound nonce proof bundle.

Result< ProvenSignature >	sign_message_with_proof (std::span< const unsigned char > message, purify_secp_context secp_context, bppp::ExperimentalCircuitBackend circuit_cache=nullptr) const
	Signs a message and returns the signature bundled with its BPPP nonce proof.

Result< ProvenSignature >	sign_message_with_proof (const MessageProofCache &cache, purify_secp_context secp_context, bppp::ExperimentalCircuitBackend circuit_cache=nullptr) const
	Signs a message with proof using a reusable message cache.

Result< ProvenSignature >	sign_with_topic_proof (std::span< const unsigned char > message, std::span< const unsigned char > topic, purify_secp_context secp_context, bppp::ExperimentalCircuitBackend circuit_cache=nullptr) const
	Signs a message with a topic-bound nonce proof.

Result< ProvenSignature >	sign_with_topic_proof (std::span< const unsigned char > message, const TopicProofCache &cache, purify_secp_context secp_context, bppp::ExperimentalCircuitBackend circuit_cache=nullptr) const
	Signs a message with a topic-bound nonce proof using a reusable topic cache.

Static Public Member Functions
static Result< KeyPair >	from_secret (const SecretKey &secret, purify_secp_context *secp_context)
	Derives a PureSign++ signing key pair from one packed Purify secret.

static Result< KeyPair >	from_secret (SecretKey &&secret, purify_secp_context *secp_context)
	Derives a PureSign++ signing key pair from one owned Purify secret.

Detailed Description

Definition at line 430 of file bppp.hpp.

Constructor & Destructor Documentation

◆ KeyPair() [1/2]

purify::puresign_plusplus::KeyPair::KeyPair ( const KeyPair & )

delete

◆ KeyPair() [2/2]

purify::puresign_plusplus::KeyPair::KeyPair ( KeyPair && other )

defaultnoexcept

◆ ~KeyPair()

purify::puresign_plusplus::KeyPair::~KeyPair ( )

default

Member Function Documentation

◆ from_secret() [1/2]

Result< KeyPair > purify::puresign_plusplus::KeyPair::from_secret	(	const SecretKey &	secret,
		purify_secp_context *	secp_context
	)

static

Parameters

secret The secret to clone into the returned key pair.

Returns: A move-only signer object bundling the secret and public key.

Definition at line 798 of file bppp.cpp.

References purify::SecretKey::clone(), from_secret(), and PURIFY_ASSIGN_OR_RETURN.

Referenced by from_secret().

◆ from_secret() [2/2]

Result< KeyPair > purify::puresign_plusplus::KeyPair::from_secret	(	SecretKey &&	secret,
		purify_secp_context *	secp_context
	)

static

Parameters

secret The secret to move into the returned key pair.

Returns: A move-only signer object bundling the secret and public key.

Definition at line 803 of file bppp.cpp.

References purify::puresign_plusplus::PublicKey::from_secret(), public_key(), and PURIFY_ASSIGN_OR_RETURN.

◆ operator=() [1/2]

KeyPair & purify::puresign_plusplus::KeyPair::operator= ( const KeyPair & )

delete

◆ operator=() [2/2]

KeyPair & purify::puresign_plusplus::KeyPair::operator= ( KeyPair && other )

defaultnoexcept

◆ prepare_message_nonce()

Result< PreparedNonce > purify::puresign_plusplus::KeyPair::prepare_message_nonce	(	std::span< const unsigned char >	message,
		purify_secp_context *	secp_context
	)		const

Parameters

message The message to bind into the nonce derivation.

Returns: The move-only prepared nonce.

Definition at line 808 of file bppp.cpp.

References purify::puresign_plusplus::api_impl::prepare_message_nonce().

Referenced by sign_message().

◆ prepare_message_nonce_with_proof() [1/2]

Result< PreparedNonceWithProof > purify::puresign_plusplus::KeyPair::prepare_message_nonce_with_proof	(	const MessageProofCache &	cache,
		purify_secp_context *	secp_context,
		bppp::ExperimentalCircuitBackend *	circuit_cache = `nullptr`
	)		const

Parameters

cache	The prebuilt cache for the exact message to bind.
circuit_cache	Optional BPPP prover cache to reuse across calls.

Returns: The prepared nonce plus its public proof.

Definition at line 820 of file bppp.cpp.

References purify::puresign_plusplus::api_impl::prepare_message_nonce_with_proof().

◆ prepare_message_nonce_with_proof() [2/2]

Result< PreparedNonceWithProof > purify::puresign_plusplus::KeyPair::prepare_message_nonce_with_proof	(	std::span< const unsigned char >	message,
		purify_secp_context *	secp_context,
		bppp::ExperimentalCircuitBackend *	circuit_cache = `nullptr`
	)		const

Parameters

message	The message to bind into the nonce derivation and proof statement.
circuit_cache	Optional BPPP prover cache to reuse across calls.

Returns: The prepared nonce plus its public proof.

Definition at line 813 of file bppp.cpp.

References purify::puresign_plusplus::api_impl::prepare_message_nonce_with_proof().

Referenced by sign_message_with_proof(), and sign_message_with_proof().

◆ prepare_topic_nonce()

Result< PreparedNonce > purify::puresign_plusplus::KeyPair::prepare_topic_nonce	(	std::span< const unsigned char >	topic,
		purify_secp_context *	secp_context
	)		const

Parameters

topic The topic to bind into the nonce derivation.

Returns: The move-only prepared nonce.

Definition at line 827 of file bppp.cpp.

References purify::puresign_plusplus::api_impl::prepare_topic_nonce().

Referenced by sign_with_topic().

◆ prepare_topic_nonce_with_proof() [1/2]

Result< PreparedNonceWithProof > purify::puresign_plusplus::KeyPair::prepare_topic_nonce_with_proof	(	const TopicProofCache &	cache,
		purify_secp_context *	secp_context,
		bppp::ExperimentalCircuitBackend *	circuit_cache = `nullptr`
	)		const

Parameters

cache	The prebuilt cache for the exact topic to bind.
circuit_cache	Optional BPPP prover cache to reuse across calls.

Returns: The prepared nonce plus its public proof.

Definition at line 839 of file bppp.cpp.

References purify::puresign_plusplus::api_impl::prepare_topic_nonce_with_proof().

◆ prepare_topic_nonce_with_proof() [2/2]

Result< PreparedNonceWithProof > purify::puresign_plusplus::KeyPair::prepare_topic_nonce_with_proof	(	std::span< const unsigned char >	topic,
		purify_secp_context *	secp_context,
		bppp::ExperimentalCircuitBackend *	circuit_cache = `nullptr`
	)		const

Parameters

topic	The topic to bind into the nonce derivation and proof statement.
circuit_cache	Optional BPPP prover cache to reuse across calls.

Returns: The prepared nonce plus its public proof.

Definition at line 832 of file bppp.cpp.

References purify::puresign_plusplus::api_impl::prepare_topic_nonce_with_proof().

Referenced by sign_with_topic_proof(), and sign_with_topic_proof().

◆ public_key()

const PublicKey & purify::puresign_plusplus::KeyPair::public_key ( ) const

inlinenoexcept

Returns: The derived public-key bundle.

Definition at line 458 of file bppp.hpp.

Referenced by from_secret().

◆ sign_message()

Result< Signature > purify::puresign_plusplus::KeyPair::sign_message	(	std::span< const unsigned char >	message,
		purify_secp_context *	secp_context
	)		const

Parameters

message The message to sign.

Returns: The resulting BIP340 signature.

Definition at line 846 of file bppp.cpp.

References prepare_message_nonce(), PURIFY_ASSIGN_OR_RETURN, and sign_message_with_prepared().

◆ sign_message_with_prepared()

Result< Signature > purify::puresign_plusplus::KeyPair::sign_message_with_prepared	(	std::span< const unsigned char >	message,
		PreparedNonce &&	prepared,
		purify_secp_context *	secp_context
	)		const

Parameters

message	The message that must match the prepared nonce binding.
prepared	The prepared message-bound nonce to consume.

Returns: The resulting BIP340 signature.

Definition at line 852 of file bppp.cpp.

References purify::derive_bip340_key(), and PURIFY_ASSIGN_OR_RETURN.

Referenced by sign_message().

◆ sign_message_with_prepared_proof()

Result< ProvenSignature > purify::puresign_plusplus::KeyPair::sign_message_with_prepared_proof	(	std::span< const unsigned char >	message,
		PreparedNonceWithProof &&	prepared,
		purify_secp_context *	secp_context
	)		const

Parameters

message	The message that must match the prepared nonce binding.
prepared	The prepared nonce-plus-proof bundle to consume.

Returns: The resulting signature bundled with its nonce proof.

Definition at line 859 of file bppp.cpp.

Referenced by sign_message_with_proof(), and sign_message_with_proof().

◆ sign_message_with_proof() [1/2]

Result< ProvenSignature > purify::puresign_plusplus::KeyPair::sign_message_with_proof	(	const MessageProofCache &	cache,
		purify_secp_context *	secp_context,
		bppp::ExperimentalCircuitBackend *	circuit_cache = `nullptr`
	)		const

Parameters

cache	The prebuilt cache for the exact signed message.
circuit_cache	Optional BPPP prover cache to reuse across calls.

Returns: The resulting signature-plus-proof bundle.

Definition at line 893 of file bppp.cpp.

References purify::puresign_plusplus::MessageProofCache::message, prepare_message_nonce_with_proof(), PURIFY_ASSIGN_OR_RETURN, and sign_message_with_prepared_proof().

◆ sign_message_with_proof() [2/2]

Result< ProvenSignature > purify::puresign_plusplus::KeyPair::sign_message_with_proof	(	std::span< const unsigned char >	message,
		purify_secp_context *	secp_context,
		bppp::ExperimentalCircuitBackend *	circuit_cache = `nullptr`
	)		const

Parameters

message	The message to sign.
circuit_cache	Optional BPPP prover cache to reuse across calls.

Returns: The resulting signature-plus-proof bundle.

Definition at line 885 of file bppp.cpp.

References prepare_message_nonce_with_proof(), PURIFY_ASSIGN_OR_RETURN, and sign_message_with_prepared_proof().

◆ sign_with_prepared_topic()

Result< Signature > purify::puresign_plusplus::KeyPair::sign_with_prepared_topic	(	std::span< const unsigned char >	message,
		PreparedNonce &&	prepared,
		purify_secp_context *	secp_context
	)		const

Parameters

message	The message to sign.
prepared	The topic-bound nonce to consume.

Returns: The resulting BIP340 signature.

Definition at line 872 of file bppp.cpp.

References purify::derive_bip340_key(), and PURIFY_ASSIGN_OR_RETURN.

Referenced by sign_with_topic().

◆ sign_with_prepared_topic_proof()

Result< ProvenSignature > purify::puresign_plusplus::KeyPair::sign_with_prepared_topic_proof	(	std::span< const unsigned char >	message,
		PreparedNonceWithProof &&	prepared,
		purify_secp_context *	secp_context
	)		const

Parameters

message	The message to sign.
prepared	The topic-bound nonce-plus-proof bundle to consume.

Returns: The resulting signature bundled with its nonce proof.

Definition at line 879 of file bppp.cpp.

Referenced by sign_with_topic_proof(), and sign_with_topic_proof().

◆ sign_with_topic()

Result< Signature > purify::puresign_plusplus::KeyPair::sign_with_topic	(	std::span< const unsigned char >	message,
		std::span< const unsigned char >	topic,
		purify_secp_context *	secp_context
	)		const

Parameters

message	The message to sign.
topic	The topic that the nonce must be bound to.

Returns: The resulting BIP340 signature.

Definition at line 865 of file bppp.cpp.

References prepare_topic_nonce(), PURIFY_ASSIGN_OR_RETURN, and sign_with_prepared_topic().

◆ sign_with_topic_proof() [1/2]

Result< ProvenSignature > purify::puresign_plusplus::KeyPair::sign_with_topic_proof	(	std::span< const unsigned char >	message,
		const TopicProofCache &	cache,
		purify_secp_context *	secp_context,
		bppp::ExperimentalCircuitBackend *	circuit_cache = `nullptr`
	)		const

Parameters

message	The message to sign.
cache	The prebuilt cache for the exact topic bound into the proof.
circuit_cache	Optional BPPP prover cache to reuse across calls.

Returns: The resulting signature-plus-proof bundle.

Definition at line 910 of file bppp.cpp.

References prepare_topic_nonce_with_proof(), PURIFY_ASSIGN_OR_RETURN, and sign_with_prepared_topic_proof().

◆ sign_with_topic_proof() [2/2]

Result< ProvenSignature > purify::puresign_plusplus::KeyPair::sign_with_topic_proof	(	std::span< const unsigned char >	message,
		std::span< const unsigned char >	topic,
		purify_secp_context *	secp_context,
		bppp::ExperimentalCircuitBackend *	circuit_cache = `nullptr`
	)		const

Parameters

message	The message to sign.
topic	The topic that the nonce proof must bind to.
circuit_cache	Optional BPPP prover cache to reuse across calls.

Returns: The resulting signature-plus-proof bundle.

Definition at line 901 of file bppp.cpp.

References prepare_topic_nonce_with_proof(), PURIFY_ASSIGN_OR_RETURN, and sign_with_prepared_topic_proof().

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

include/purify/puresign/bppp.hpp
src/puresign/bppp.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ KeyPair() [1/2]

◆ KeyPair() [2/2]

◆ ~KeyPair()

Member Function Documentation

◆ from_secret() [1/2]

◆ from_secret() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ prepare_message_nonce()

◆ prepare_message_nonce_with_proof() [1/2]

◆ prepare_message_nonce_with_proof() [2/2]

◆ prepare_topic_nonce()

◆ prepare_topic_nonce_with_proof() [1/2]

◆ prepare_topic_nonce_with_proof() [2/2]

◆ public_key()

◆ sign_message()

◆ sign_message_with_prepared()

◆ sign_message_with_prepared_proof()

◆ sign_message_with_proof() [1/2]

◆ sign_message_with_proof() [2/2]

◆ sign_with_prepared_topic()

◆ sign_with_prepared_topic_proof()

◆ sign_with_topic()

◆ sign_with_topic_proof() [1/2]

◆ sign_with_topic_proof() [2/2]