Botan::Encrypted_PSK_Database_SQL Class Reference

#include <psk_db.h>

Inheritance diagram for Botan::Encrypted_PSK_Database_SQL:

Public Member Functions
	Encrypted_PSK_Database_SQL (const Encrypted_PSK_Database_SQL &other)=delete
	Encrypted_PSK_Database_SQL (const secure_vector< uint8_t > &master_key, std::shared_ptr< SQL_Database > db, std::string_view table_name)
	Encrypted_PSK_Database_SQL (Encrypted_PSK_Database_SQL &&other)=delete
secure_vector< uint8_t >	get (std::string_view name) const override
std::string	get_str (std::string_view name) const
bool	is_encrypted () const override
std::set< std::string >	list_names () const override
Encrypted_PSK_Database_SQL &	operator= (const Encrypted_PSK_Database_SQL &other)=delete
Encrypted_PSK_Database_SQL &	operator= (Encrypted_PSK_Database_SQL &&other)=delete
void	remove (std::string_view name) override
void	set (std::string_view name, const uint8_t psk[], size_t psk_len) override
void	set_str (std::string_view name, std::string_view psk)
void	set_vec (std::string_view name, std::span< const uint8_t > psk)
	~Encrypted_PSK_Database_SQL () override

Detailed Description

An Encrypted_PSK_Database which stores its key/value pairs in a SQL table

Definition at line 191 of file psk_db.h.

Constructor & Destructor Documentation

Encrypted_PSK_Database_SQL() [1/3]

Botan::Encrypted_PSK_Database_SQL::Encrypted_PSK_Database_SQL	(	const secure_vector< uint8_t > &	master_key,
		std::shared_ptr< SQL_Database >	db,
		std::string_view	table_name )

Creates or uses the named table in db. The SQL schema of the table is (psk_name TEXT PRIMARY KEY, psk_value TEXT).

Definition at line 14 of file psk_db_sql.cpp.

                                                                                  :
      Encrypted_PSK_Database(master_key), m_db(std::move(db)), m_table_name(table_name) {
   using DB = SQL_Database;
   BOTAN_ARG_CHECK(m_db->is_valid_table_name(m_table_name), "Provided table name is not valid for this database");
   m_db->create_table(DB::Table_Schema(m_table_name,
                                       {
                                          DB::Column("psk_name", DB::Column_Type::String).primary_key(),
                                          DB::Column("psk_value", DB::Column_Type::String),
                                       })
                         .if_not_exists());
}

References BOTAN_ARG_CHECK, and Botan::Encrypted_PSK_Database::Encrypted_PSK_Database().

Referenced by Encrypted_PSK_Database_SQL(), Encrypted_PSK_Database_SQL(), operator=(), and operator=().

~Encrypted_PSK_Database_SQL()

Botan::Encrypted_PSK_Database_SQL::~Encrypted_PSK_Database_SQL ( )

overridedefault

Encrypted_PSK_Database_SQL() [2/3]

Botan::Encrypted_PSK_Database_SQL::Encrypted_PSK_Database_SQL ( const Encrypted_PSK_Database_SQL & other )

delete

References Encrypted_PSK_Database_SQL().

Encrypted_PSK_Database_SQL() [3/3]

Botan::Encrypted_PSK_Database_SQL::Encrypted_PSK_Database_SQL ( Encrypted_PSK_Database_SQL && other )

delete

References Encrypted_PSK_Database_SQL().

Member Function Documentation

get()

secure_vector< uint8_t > Botan::Encrypted_PSK_Database::get ( std::string_view name ) const

overridevirtualinherited

Retrieve a PSK from the database

Parameters

name	the name of the PSK to retrieve

Returns

the value associated with name, or throw if not found

Implements Botan::PSK_Database.

Definition at line 62 of file psk_db.cpp.

                                                                            {
   const auto wrapped_name = nist_key_wrap_padded(as_span_of_bytes(name), *m_cipher);
 
   const std::string val_base64 = kv_get(base64_encode(wrapped_name));
 
   if(val_base64.empty()) {
      throw Invalid_Argument("Named PSK not located");
   }
 
   const secure_vector<uint8_t> val = base64_decode(val_base64);
 
   auto wrap_cipher = m_cipher->new_object();
   wrap_cipher->set_key(m_hmac->process(wrapped_name));
 
   return nist_key_unwrap_padded(val.data(), val.size(), *wrap_cipher);
}

References Botan::as_span_of_bytes(), Botan::base64_decode(), Botan::base64_encode(), kv_get(), Botan::nist_key_unwrap_padded(), and Botan::nist_key_wrap_padded().

Referenced by ~Encrypted_PSK_Database().

get_str()

std::string Botan::PSK_Database::get_str ( std::string_view name ) const

inherited

Get a PSK in the form of a string (eg if the PSK is a password)

Definition at line 18 of file psk_db.cpp.

                                                         {
   return bytes_to_string(this->get(name));
}

References Botan::bytes_to_string(), and get().

Referenced by is_encrypted().

is_encrypted()

bool Botan::Encrypted_PSK_Database::is_encrypted ( ) const

inlineoverridevirtualinherited

Test whether values in this database are stored encrypted

Returns

always true for this type

Implements Botan::PSK_Database.

Definition at line 155 of file psk_db.h.

{ return true; }

list_names()

std::set< std::string > Botan::Encrypted_PSK_Database::list_names ( ) const

overridevirtualinherited

List the names stored in the database

Returns

the set of names for which get() will return a value

Implements Botan::PSK_Database.

Definition at line 38 of file psk_db.cpp.

                                                           {
   const std::set<std::string> encrypted_names = kv_get_all();
 
   std::set<std::string> names;
 
   for(const auto& enc_name : encrypted_names) {
      try {
         const secure_vector<uint8_t> raw_name = base64_decode(enc_name);
         const secure_vector<uint8_t> name_bits = nist_key_unwrap_padded(raw_name.data(), raw_name.size(), *m_cipher);
 
         const auto pt_name = bytes_to_string(name_bits);
         names.insert(pt_name);
      } catch(Invalid_Authentication_Tag&) {}
   }
 
   return names;
}

References Botan::base64_decode(), Botan::bytes_to_string(), kv_get_all(), and Botan::nist_key_unwrap_padded().

Referenced by ~Encrypted_PSK_Database().

operator=() [1/2]

Encrypted_PSK_Database_SQL & Botan::Encrypted_PSK_Database_SQL::operator= ( const Encrypted_PSK_Database_SQL & other )

delete

References Encrypted_PSK_Database_SQL().

operator=() [2/2]

Encrypted_PSK_Database_SQL & Botan::Encrypted_PSK_Database_SQL::operator= ( Encrypted_PSK_Database_SQL && other )

delete

References Encrypted_PSK_Database_SQL().

remove()

void Botan::Encrypted_PSK_Database::remove ( std::string_view name )

overridevirtualinherited

Remove the PSK with the given name from the database

Parameters

name	the name of the PSK to remove

Implements Botan::PSK_Database.

Definition at line 56 of file psk_db.cpp.

                                                       {
   const auto wrapped_name = nist_key_wrap_padded(as_span_of_bytes(name), *m_cipher);
 
   this->kv_del(base64_encode(wrapped_name));
}

References Botan::as_span_of_bytes(), Botan::base64_encode(), kv_del(), and Botan::nist_key_wrap_padded().

Referenced by ~Encrypted_PSK_Database().

set()

void Botan::Encrypted_PSK_Database::set ( std::string_view name, const uint8_t psk[], size_t psk_len )

overridevirtualinherited

Set a value that can later be accessed with get() If name already exists in the database, the old value will be overwritten.

Parameters

name	the name to store the PSK under
psk	the PSK to store
psk_len	length of psk in bytes

Implements Botan::PSK_Database.

Definition at line 79 of file psk_db.cpp.

                                                                                     {
   /*
   * Both as a basic precaution wrt key separation, and specifically to prevent
   * cut-and-paste attacks against the database, each PSK is encrypted with a
   * distinct key which is derived by hashing the wrapped key name with HMAC.
   */
   const auto wrapped_name = nist_key_wrap_padded(as_span_of_bytes(name), *m_cipher);
 
   auto wrap_cipher = m_cipher->new_object();
   wrap_cipher->set_key(m_hmac->process(wrapped_name));
   const std::vector<uint8_t> wrapped_key = nist_key_wrap_padded(val, len, *wrap_cipher);
 
   this->kv_set(base64_encode(wrapped_name), base64_encode(wrapped_key));
}

References Botan::as_span_of_bytes(), Botan::base64_encode(), kv_set(), and Botan::nist_key_wrap_padded().

Referenced by ~Encrypted_PSK_Database().

set_str()

void Botan::PSK_Database::set_str ( std::string_view name, std::string_view psk )

inherited

Like set() but accepts the PSK as a string (eg for a password).

Definition at line 22 of file psk_db.cpp.

                                                                  {
   auto pskb = as_span_of_bytes(psk);
   this->set(name, pskb.data(), pskb.size());
}

References Botan::as_span_of_bytes(), and set().

Referenced by is_encrypted().

set_vec()

void Botan::PSK_Database::set_vec ( std::string_view name, std::span< const uint8_t > psk )

inlineinherited

Like set() but accepting an arbitrary contiguous byte array.

Definition at line 72 of file psk_db.h.

{ set(name, psk.data(), psk.size()); }

References set().

---

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

• src/lib/psk_db/psk_db.h
• src/lib/psk_db/psk_db_sql.cpp