wxSQLite3CipherChaCha20 Class Reference

Cipher class representing ChaCha20 encryption with Poly1305 HMAC. More...

#include <wxsqlite3.h>

Inheritance diagram for wxSQLite3CipherChaCha20:

Public Member Functions
	wxSQLite3CipherChaCha20 ()
	Constructor.
	wxSQLite3CipherChaCha20 (const wxSQLite3CipherChaCha20 &cipher)
	Copy constructor.
virtual	~wxSQLite3CipherChaCha20 ()
	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	SetLegacy (bool legacy)
	Set legacy mode.
bool	GetLegacy () const
	Get legacy mode.
void	SetKdfIter (int kdfIter)
	Set iteration count of KDF function for ordinary key.
int	GetKdfIter () const
	Get iteration count of KDF function for ordinary key.
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 ChaCha20 encryption with Poly1305 HMAC.

Constructor & Destructor Documentation

wxSQLite3CipherChaCha20() [1/2]

wxSQLite3CipherChaCha20::wxSQLite3CipherChaCha20

(

)

Constructor.

wxSQLite3CipherChaCha20() [2/2]

wxSQLite3CipherChaCha20::wxSQLite3CipherChaCha20

(

const wxSQLite3CipherChaCha20 &

cipher

)

Copy constructor.

~wxSQLite3CipherChaCha20()

wxSQLite3CipherChaCha20::~wxSQLite3CipherChaCha20 ( )

virtual

Destructor.

Member Function Documentation

Apply() [1/2]

bool wxSQLite3CipherChaCha20::Apply ( void * dbHandle ) const

virtual

Reimplemented from wxSQLite3Cipher.

Apply() [2/2]

bool wxSQLite3CipherChaCha20::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.

GetKdfIter()

int wxSQLite3CipherChaCha20::GetKdfIter ( ) const

inline

Get iteration count of KDF function for ordinary key.

GetLegacy()

bool wxSQLite3CipherChaCha20::GetLegacy ( ) const

inline

Get legacy mode.

InitializeFromCurrent()

bool wxSQLite3CipherChaCha20::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 wxSQLite3CipherChaCha20::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 wxSQLite3CipherChaCha20::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.

SetKdfIter()

void wxSQLite3CipherChaCha20::SetKdfIter ( int kdfIter )

inline

Set iteration count of KDF function for ordinary key.

SetLegacy()

void wxSQLite3CipherChaCha20::SetLegacy ( bool legacy )

inline

Set legacy mode.

---

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

• wxsqlite3.h
• wxsqlite3.cpp