wxSQLite3CipherAegis Class Reference

Cipher class representing Aegis encryption with Ascon tag. More...

#include <wxsqlite3.h>

Inheritance diagram for wxSQLite3CipherAegis:

Public Types
enum	Algorithm {   ALGORITHM_AEGIS_128L = 1 , ALGORITHM_AEGIS_128X2 , ALGORITHM_AEGIS_128X4 , ALGORITHM_AEGIS_256 ,   ALGORITHM_AEGIS_256X2 , ALGORITHM_AEGIS_256X4 }
	Aegis algorithm types. More...

Public Member Functions
	wxSQLite3CipherAegis ()
	Constructor.
	wxSQLite3CipherAegis (const wxSQLite3CipherAegis &cipher)
	Copy constructor.
virtual	~wxSQLite3CipherAegis ()
	Destructor.
virtual bool	InitializeFromGlobalDefault ()
	Initialize the cipher instance based on global default settings.
virtual bool	InitializeFromCurrent (wxSQLite3Database &db)
	Initialize the cipher instance based on current settings.
virtual bool	InitializeFromCurrentDefault (wxSQLite3Database &db)
	Initialize the cipher instance based on current default settings.
virtual bool	Apply (wxSQLite3Database &db) const
	Apply the cipher parameters to a database connection.
virtual bool	Apply (void *dbHandle) const
void	SetIterCount (int iterCount)
	Set number of iterations of KDF function for ordinary key.
int	GetIterCount () const
	Get number of iterations of KDF function for ordinary key.
void	SetMemorySize (int memSize)
	Set size of memory in kB of KDF function for ordinary key.
int	GetMemorySize () const
	Get size of memory in kB of KDF function for ordinary key.
void	SetThreadCount (int threads)
	Set number of threads of KDF function for ordinary key.
int	GetThreadCount () const
	Get number of threads of KDF function for ordinary key.
void	SetAlgorithm (Algorithm algorithm)
	Set Aegis algorithm to be used for encryption.
Algorithm	GetAlgorithm () const
	Get Aegis algorithm used for encryption.
Public Member Functions inherited from wxSQLite3Cipher
	wxSQLite3Cipher ()
	Constructor.
virtual	~wxSQLite3Cipher ()
	Destructor.
void	SetLegacyPageSize (int pageSize)
int	GetLegacyPageSize () const
wxSQLite3CipherType	GetCipherType () const
	Get the type of this cipher instance.
bool	IsOk () const
	Check whether the cipher instance is valid.

Additional Inherited Members
Static Public Member Functions inherited from wxSQLite3Cipher
static const wxString	GetCipherName (wxSQLite3CipherType cipherType)
	Convert cipher type to string representation.
static wxSQLite3CipherType	GetCipherType (const wxString &cipherName)
	Convert string representation to cipher type.
static bool	SetCipher (wxSQLite3Database &db, wxSQLite3CipherType cipherType)
	Set the current cipher type for a database connection.
static bool	SetCipherDefault (wxSQLite3Database &db, wxSQLite3CipherType cipherType)
	Set the default cipher type for a database connection.
static wxSQLite3CipherType	GetCipher (wxSQLite3Database &db)
	Get the current cipher type of a database connection.
static wxSQLite3CipherType	GetCipherDefault (wxSQLite3Database &db)
	Get the default cipher type of a database connection.
static wxSQLite3CipherType	GetGlobalCipherDefault ()
	Get the globally defined default cipher type.
static int	GetCipherParameterMin (const wxString &cipherName, const wxString &paramName)
	Get minimum allowed cipher parameter value.
static int	GetCipherParameterMax (const wxString &cipherName, const wxString &paramName)
	Get maximum allowed cipher parameter value.
Protected Member Functions inherited from wxSQLite3Cipher
	wxSQLite3Cipher (wxSQLite3CipherType cipherType)
	Constructor.
	wxSQLite3Cipher (const wxSQLite3Cipher &cipher)
	Copy constructor.
void	SetInitialized (bool initialized)
	Set initialization status of the cipher instance.
void	SetCipherType (wxSQLite3CipherType cipherType)
	Set type of the cipher instance.
Static Protected Member Functions inherited from wxSQLite3Cipher
static void *	GetDatabaseHandle (wxSQLite3Database &db)
	Get the SQLite3 database handle of a database instance.

Detailed Description

Cipher class representing Aegis encryption with Ascon tag.

Member Enumeration Documentation

Algorithm

enum wxSQLite3CipherAegis::Algorithm

Aegis algorithm types.

Enumerator
ALGORITHM_AEGIS_128L
ALGORITHM_AEGIS_128X2
ALGORITHM_AEGIS_128X4
ALGORITHM_AEGIS_256
ALGORITHM_AEGIS_256X2
ALGORITHM_AEGIS_256X4

Constructor & Destructor Documentation

wxSQLite3CipherAegis() [1/2]

wxSQLite3CipherAegis::wxSQLite3CipherAegis

(

)

Constructor.

wxSQLite3CipherAegis() [2/2]

wxSQLite3CipherAegis::wxSQLite3CipherAegis

(

const wxSQLite3CipherAegis &

cipher

)

Copy constructor.

~wxSQLite3CipherAegis()

wxSQLite3CipherAegis::~wxSQLite3CipherAegis ( )

virtual

Destructor.

Member Function Documentation

Apply() [1/2]

bool wxSQLite3CipherAegis::Apply ( void * dbHandle ) const

virtual

Reimplemented from wxSQLite3Cipher.

Apply() [2/2]

bool wxSQLite3CipherAegis::Apply ( wxSQLite3Database & db ) const

virtual

Apply the cipher parameters to a database connection.

The parameters of the cipher instance are applied to the given database connection.

Parameters

db	database instance representing a database connection

Returns

true if the cipher parameters could be applied successfully, false otherwise

Reimplemented from wxSQLite3Cipher.

GetAlgorithm()

Algorithm wxSQLite3CipherAegis::GetAlgorithm ( ) const

inline

Get Aegis algorithm used for encryption.

GetIterCount()

int wxSQLite3CipherAegis::GetIterCount ( ) const

inline

Get number of iterations of KDF function for ordinary key.

GetMemorySize()

int wxSQLite3CipherAegis::GetMemorySize ( ) const

inline

Get size of memory in kB of KDF function for ordinary key.

GetThreadCount()

int wxSQLite3CipherAegis::GetThreadCount ( ) const

inline

Get number of threads of KDF function for ordinary key.

InitializeFromCurrent()

bool wxSQLite3CipherAegis::InitializeFromCurrent ( wxSQLite3Database & db )

virtual

Initialize the cipher instance based on current settings.

The parameters of the cipher instance are initialize with the current settings of the associated cipher type as defined in the given database connection.

Parameters

db	database instance representing a database connection

Returns

true if the cipher instance could be initialized successfully, false otherwise

Reimplemented from wxSQLite3Cipher.

InitializeFromCurrentDefault()

bool wxSQLite3CipherAegis::InitializeFromCurrentDefault ( wxSQLite3Database & db )

virtual

Initialize the cipher instance based on current default settings.

The parameters of the cipher instance are initialize with the current default settings of the associated cipher type as defined in the given database connection.

Parameters

db	database instance representing a database connection

Returns

true if the cipher instance could be initialized successfully, false otherwise

Reimplemented from wxSQLite3Cipher.

InitializeFromGlobalDefault()

bool wxSQLite3CipherAegis::InitializeFromGlobalDefault ( )

virtual

Initialize the cipher instance based on global default settings.

The parameters of the cipher instance are initialize with the global default settings of the associated cipher type.

Returns

true if the cipher instance could be initialized successfully, false otherwise

Reimplemented from wxSQLite3Cipher.

SetAlgorithm()

void wxSQLite3CipherAegis::SetAlgorithm ( Algorithm algorithm )

inline

Set Aegis algorithm to be used for encryption.

SetIterCount()

void wxSQLite3CipherAegis::SetIterCount ( int iterCount )

inline

Set number of iterations of KDF function for ordinary key.

SetMemorySize()

void wxSQLite3CipherAegis::SetMemorySize ( int memSize )

inline

Set size of memory in kB of KDF function for ordinary key.

SetThreadCount()

void wxSQLite3CipherAegis::SetThreadCount ( int threads )

inline

Set number of threads of KDF function for ordinary key.

---

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

• wxsqlite3.h
• wxsqlite3.cpp