Botan::Stateful_Key_Index_Registry Class Reference

#include <stateful_key_index_registry.h>

Classes
class	KeyId

Public Member Functions
uint64_t	current_index (const KeyId &key_id)
Stateful_Key_Index_Registry &	operator= (const Stateful_Key_Index_Registry &)=delete
Stateful_Key_Index_Registry &	operator= (Stateful_Key_Index_Registry &&)=delete
uint64_t	remaining_operations (const KeyId &key_id, uint64_t max)
uint64_t	reserve_next_index (const KeyId &key_id)
void	set_index_lower_bound (const KeyId &key_id, uint64_t min)
	Stateful_Key_Index_Registry (const Stateful_Key_Index_Registry &)=delete
	Stateful_Key_Index_Registry (Stateful_Key_Index_Registry &&)=delete
	~Stateful_Key_Index_Registry ()

Static Public Member Functions
static Stateful_Key_Index_Registry &	global ()

Detailed Description

A process-wide registry mapping stateful key identity to a shared atomic counter. Ensures that independent copies of the same key material (e.g. deserialized separately) share a single leaf index, preventing catastrophic one-time signature reuse.

Used by XMSS and HSS-LMS.

Definition at line 28 of file stateful_key_index_registry.h.

Constructor & Destructor Documentation

Stateful_Key_Index_Registry() [1/2]

Botan::Stateful_Key_Index_Registry::Stateful_Key_Index_Registry ( const Stateful_Key_Index_Registry & )

delete

References Stateful_Key_Index_Registry().

Referenced by global(), operator=(), operator=(), Stateful_Key_Index_Registry(), Stateful_Key_Index_Registry(), and ~Stateful_Key_Index_Registry().

Stateful_Key_Index_Registry() [2/2]

Botan::Stateful_Key_Index_Registry::Stateful_Key_Index_Registry ( Stateful_Key_Index_Registry && )

delete

References Stateful_Key_Index_Registry().

~Stateful_Key_Index_Registry()

Botan::Stateful_Key_Index_Registry::~Stateful_Key_Index_Registry ( )

default

References Stateful_Key_Index_Registry().

Member Function Documentation

current_index()

uint64_t Botan::Stateful_Key_Index_Registry::current_index

(

const KeyId &

key_id

)

Return the current counter

Definition at line 51 of file stateful_key_index_registry.cpp.

                                                                       {
   const lock_guard_type<mutex_type> lock(m_mutex);
   auto idx = this->lookup(key_id);
   return idx->second;
}

References Botan::lock().

Referenced by Botan::HSS_LMS_PrivateKeyInternal::to_bytes().

global()

Stateful_Key_Index_Registry & Botan::Stateful_Key_Index_Registry::global ( )

static

Retrieve the process-wide instance

Definition at line 15 of file stateful_key_index_registry.cpp.

                                                                 {
   static Stateful_Key_Index_Registry g_registry;
   return g_registry;
}

References Stateful_Key_Index_Registry().

Referenced by Botan::HSS_LMS_PrivateKeyInternal::remaining_operations(), Botan::HSS_LMS_PrivateKeyInternal::set_idx(), and Botan::HSS_LMS_PrivateKeyInternal::to_bytes().

operator=() [1/2]

Stateful_Key_Index_Registry & Botan::Stateful_Key_Index_Registry::operator= ( const Stateful_Key_Index_Registry & )

delete

References Stateful_Key_Index_Registry().

operator=() [2/2]

Stateful_Key_Index_Registry & Botan::Stateful_Key_Index_Registry::operator= ( Stateful_Key_Index_Registry && )

delete

References Stateful_Key_Index_Registry().

remaining_operations()

uint64_t Botan::Stateful_Key_Index_Registry::remaining_operations	(	const KeyId &	key_id,
		uint64_t	max )

If the current counter is >= max returns 0, otherwise max - counter

Definition at line 71 of file stateful_key_index_registry.cpp.

                                                                                            {
   const lock_guard_type<mutex_type> lock(m_mutex);
   const uint64_t idx = this->lookup(key_id)->second;
 
   if(idx >= max) {
      return 0;
   } else {
      return max - idx;
   }
}

References Botan::lock().

reserve_next_index()

uint64_t Botan::Stateful_Key_Index_Registry::reserve_next_index

(

const KeyId &

key_id

)

Return a new counter

Definition at line 57 of file stateful_key_index_registry.cpp.

                                                                            {
   const lock_guard_type<mutex_type> lock(m_mutex);
   auto idx = this->lookup(key_id);
   const uint64_t cur = idx->second;
   idx->second += 1;
   return cur;
}

References Botan::lock().

set_index_lower_bound()

void Botan::Stateful_Key_Index_Registry::set_index_lower_bound	(	const KeyId &	key_id,
		uint64_t	min )

Set the counter to at least min (but if already higher it will retain its current value)

Definition at line 65 of file stateful_key_index_registry.cpp.

                                                                                         {
   const lock_guard_type<mutex_type> lock(m_mutex);
   auto idx = this->lookup(key_id);
   idx->second = std::max(idx->second, min);
}

References Botan::lock().

Referenced by Botan::HSS_LMS_PrivateKeyInternal::set_idx().

---

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

• src/lib/pubkey/stateful_key_index/stateful_key_index_registry.h
• src/lib/pubkey/stateful_key_index/stateful_key_index_registry.cpp