Botan::PSK_Database Class Reference

#include <psk_db.h>

Inheritance diagram for Botan::PSK_Database:

Public Member Functions
virtual secure_vector< uint8_t >	get (std::string_view name) const =0
std::string	get_str (std::string_view name) const
virtual bool	is_encrypted () const =0
virtual std::set< std::string >	list_names () const =0
virtual void	remove (std::string_view name)=0
virtual void	set (std::string_view name, const uint8_t psk[], size_t psk_len)=0
void	set_str (std::string_view name, std::string_view psk)
void	set_vec (std::string_view name, std::span< const uint8_t > psk)
virtual	~PSK_Database ()=default

Detailed Description

This is an interface to a generic PSK (pre-shared key) database. It might be implemented as a plaintext storage or via some mechanism that encrypts the keys and/or values.

Definition at line 26 of file psk_db.h.

Constructor & Destructor Documentation

~PSK_Database()

virtual Botan::PSK_Database::~PSK_Database ( )

virtualdefault

Member Function Documentation

get()

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

pure virtual

Returns

the value associated with the specified name or otherwise throw an exception.

Implemented in Botan::Encrypted_PSK_Database.

Referenced by get_str().

get_str()

std::string Botan::PSK_Database::get_str

(

std::string_view

name

)

const

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.

                                                         {
   secure_vector<uint8_t> psk = this->get(name);
   return std::string(cast_uint8_ptr_to_char(psk.data()), psk.size());
}

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

is_encrypted()

virtual bool Botan::PSK_Database::is_encrypted ( ) const

pure virtual

Returns

true if the values in the PSK database are encrypted. If false, saved values are being stored in plaintext.

Implemented in Botan::Encrypted_PSK_Database.

list_names()

virtual std::set< std::string > Botan::PSK_Database::list_names ( ) const

pure virtual

Returns

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

Implemented in Botan::Encrypted_PSK_Database.

remove()

virtual void Botan::PSK_Database::remove ( std::string_view name )

pure virtual

Remove the PSK with the given name from the database

Implemented in Botan::Encrypted_PSK_Database.

set()

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

pure virtual

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

Implemented in Botan::Encrypted_PSK_Database.

Referenced by set_str().

set_str()

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

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

Definition at line 23 of file psk_db.cpp.

                                                                  {
   this->set(name, cast_char_ptr_to_uint8(psk.data()), psk.size());
}

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

set_vec()

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

inline

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

Definition at line 69 of file psk_db.h.

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

References name.

---

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

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