Botan::LMS_PrivateKey Class Reference

Representation of an LMS Private key. More...

#include <lms.h>

Inheritance diagram for Botan::LMS_PrivateKey:

Public Member Functions
const LMS_Identifier &	identifier () const
	The identifier of this LMS tree ('I' in RFC 8554).
const LMOTS_Params &	lmots_params () const
	The LMOTS parameters used for OTS instances of this LMS instance.
const LMS_Params &	lms_params () const
	The LMS parameters for this LMS instance.
	LMS_PrivateKey (LMS_Params lms_params, LMOTS_Params lmots_params, LMS_Identifier I, LMS_Seed seed)
	Construct storing the LMS instance data and the secret seed.
const LMS_Seed &	seed () const
	The secret seed used for LMOTS' WOTS chain input creation (RFC 8554 Appendix A).
LMS_PublicKey	sign_and_get_pk (StrongSpan< LMS_Signature_Bytes > out_sig, LMS_Tree_Node_Idx q, const LMS_Message &msg) const
	Sign a message using an LMS_PrivateKey and the used leaf index (RFC 8554 5.4.1).

Detailed Description

Representation of an LMS Private key.

Contains the secret seed used for OTS key derivation as described in RFC 8554 Appendix A.

Definition at line 192 of file lms.h.

Constructor & Destructor Documentation

LMS_PrivateKey()

Botan::LMS_PrivateKey::LMS_PrivateKey ( LMS_Params lms_params, LMOTS_Params lmots_params, LMS_Identifier I, LMS_Seed seed )

inline

Construct storing the LMS instance data and the secret seed.

Definition at line 197 of file lms.h.

                                                                                                        :
            LMS_Instance(std::move(lms_params), std::move(lmots_params), std::move(I)), m_seed(std::move(seed)) {}

References Botan::LMS_Instance::lmots_params(), Botan::LMS_Instance::LMS_Instance(), Botan::LMS_Instance::lms_params(), and seed().

Member Function Documentation

identifier()

const LMS_Identifier & Botan::LMS_Instance::identifier ( ) const

inlineinherited

The identifier of this LMS tree ('I' in RFC 8554).

Definition at line 176 of file lms.h.

{ return m_identifier; }

Referenced by LMS_Instance(), Botan::LMS_PublicKey::LMS_PublicKey(), Botan::LMS_PrivateKey::sign_and_get_pk(), and Botan::LMS_PublicKey::to_bytes().

lmots_params()

const LMOTS_Params & Botan::LMS_Instance::lmots_params ( ) const

inlineinherited

The LMOTS parameters used for OTS instances of this LMS instance.

Definition at line 171 of file lms.h.

{ return m_lmots_params; }

Referenced by Botan::LMS_PublicKey::from_bytes_or_throw(), LMS_Instance(), Botan::LMS_PrivateKey::LMS_PrivateKey(), Botan::LMS_PublicKey::LMS_PublicKey(), Botan::LMS_PrivateKey::sign_and_get_pk(), Botan::LMS_PublicKey::to_bytes(), Botan::HSS_LMS_PublicKeyInternal::verify_signature(), and Botan::LMS_PublicKey::verify_signature().

lms_params()

const LMS_Params & Botan::LMS_Instance::lms_params ( ) const

inlineinherited

The LMS parameters for this LMS instance.

Definition at line 166 of file lms.h.

{ return m_lms_params; }

Referenced by Botan::LMS_PublicKey::from_bytes_or_throw(), LMS_Instance(), Botan::LMS_PrivateKey::LMS_PrivateKey(), Botan::LMS_PublicKey::LMS_PublicKey(), Botan::LMS_PublicKey::LMS_PublicKey(), Botan::LMS_PrivateKey::sign_and_get_pk(), Botan::LMS_PublicKey::size(), Botan::LMS_PublicKey::to_bytes(), Botan::HSS_LMS_PublicKeyInternal::verify_signature(), and Botan::LMS_PublicKey::verify_signature().

seed()

const LMS_Seed & Botan::LMS_PrivateKey::seed ( ) const

inline

The secret seed used for LMOTS' WOTS chain input creation (RFC 8554 Appendix A).

Definition at line 203 of file lms.h.

{ return m_seed; }

Referenced by LMS_PrivateKey(), and sign_and_get_pk().

sign_and_get_pk()

LMS_PublicKey Botan::LMS_PrivateKey::sign_and_get_pk	(	StrongSpan< LMS_Signature_Bytes >	out_sig,
		LMS_Tree_Node_Idx	q,
		const LMS_Message &	msg ) const

Sign a message using an LMS_PrivateKey and the used leaf index (RFC 8554 5.4.1).

The signature is written in the provided buffer. The LMS_PublicKey associated with the given private key is returned.

Definition at line 249 of file lms.cpp.

                                                                            {
   // Pre-alloc space for the signature
   BOTAN_ARG_CHECK(out_sig.size() == LMS_Signature::size(lms_params(), lmots_params()), "Invalid output buffer size");
 
   BufferStuffer sig_stuffer(out_sig);
   sig_stuffer.append(store_be(q));
   const LMOTS_Private_Key lmots_sk(lmots_params(), identifier(), q, seed());
   lmots_sk.sign(sig_stuffer.next<LMOTS_Signature_Bytes>(LMOTS_Signature::size(lmots_params())), msg);
   sig_stuffer.append(store_be(lms_params().algorithm_type()));
   const auto auth_path_buffer = sig_stuffer.next<LMS_AuthenticationPath>(lms_params().m() * lms_params().h());
 
   BOTAN_ASSERT_NOMSG(sig_stuffer.full());
 
   const TreeAddress lms_tree_address(lms_params().h());
   LMS_Tree_Node pk_buffer(lms_params().m());
   lms_treehash(StrongSpan<LMS_Tree_Node>(pk_buffer.get()), auth_path_buffer, q, *this);
 
   CT::unpoison(pk_buffer);
   return LMS_PublicKey(lms_params(), lmots_params(), identifier(), std::move(pk_buffer));
}

References Botan::BufferStuffer::append(), BOTAN_ARG_CHECK, BOTAN_ASSERT_NOMSG, Botan::BufferStuffer::full(), Botan::detail::Strong_Base< T >::get(), Botan::LMS_Params::h(), Botan::LMS_Instance::identifier(), Botan::LMS_Instance::lmots_params(), Botan::LMS_Instance::lms_params(), Botan::LMS_Params::m(), Botan::BufferStuffer::next(), seed(), Botan::LMOTS_Private_Key::sign(), Botan::LMOTS_Signature::size(), Botan::LMS_Signature::size(), Botan::StrongSpan< T >::size(), Botan::store_be(), and Botan::CT::unpoison().

---

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

• src/lib/pubkey/hss_lms/lms.h
• src/lib/pubkey/hss_lms/lms.cpp