wxSQLite3  5.0.1
Loading...
Searching...
No Matches
wxSQLite3::CipherAes128 Class Reference

Cipher class representing AES 128 bit encryption in CBC mode. More...

#include <wxsqlite3.h>

Inheritance diagram for wxSQLite3::CipherAes128:
wxSQLite3::Cipher

Public Member Functions

 CipherAes128 ()
 Constructor.
 CipherAes128 (const CipherAes128 &cipher)
 Copy constructor.
virtual ~CipherAes128 ()
 Destructor.
virtual bool InitializeFromGlobalDefault ()
 Initialize the cipher instance based on global default settings.
virtual bool InitializeFromCurrent (Database &db)
 Initialize the cipher instance based on current settings.
virtual bool InitializeFromCurrentDefault (Database &db)
 Initialize the cipher instance based on current default settings.
virtual bool Apply (Database &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.
Public Member Functions inherited from wxSQLite3::Cipher
 Cipher ()
 Constructor.
virtual ~Cipher ()
 Destructor.
void SetLegacyPageSize (int pageSize)
int GetLegacyPageSize () const
CipherType 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 wxSQLite3::Cipher
static const wxString GetCipherName (CipherType cipherType)
 Convert cipher type to string representation.
static CipherType GetCipherType (const wxString &cipherName)
 Convert string representation to cipher type.
static bool SetCipher (Database &db, CipherType cipherType)
 Set the current cipher type for a database connection.
static bool SetCipherDefault (Database &db, CipherType cipherType)
 Set the default cipher type for a database connection.
static CipherType GetCipher (Database &db)
 Get the current cipher type of a database connection.
static CipherType GetCipherDefault (Database &db)
 Get the default cipher type of a database connection.
static CipherType 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 wxSQLite3::Cipher
 Cipher (CipherType cipherType)
 Constructor.
 Cipher (const Cipher &cipher)
 Copy constructor.
void SetInitialized (bool initialized)
 Set initialization status of the cipher instance.
void SetCipherType (CipherType cipherType)
 Set type of the cipher instance.
Static Protected Member Functions inherited from wxSQLite3::Cipher
static void * GetDatabaseHandle (Database &db)
 Get the SQLite3 database handle of a database instance.

Detailed Description

Cipher class representing AES 128 bit encryption in CBC mode.

Constructor & Destructor Documentation

◆ CipherAes128() [1/2]

wxSQLite3::CipherAes128::CipherAes128 ( )

Constructor.

◆ CipherAes128() [2/2]

wxSQLite3::CipherAes128::CipherAes128 ( const CipherAes128 & cipher)

Copy constructor.

◆ ~CipherAes128()

virtual wxSQLite3::CipherAes128::~CipherAes128 ( )
virtual

Destructor.

Member Function Documentation

◆ Apply() [1/2]

virtual bool wxSQLite3::CipherAes128::Apply ( Database & 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
dbdatabase instance representing a database connection
Returns
true if the cipher parameters could be applied successfully, false otherwise

Reimplemented from wxSQLite3::Cipher.

◆ Apply() [2/2]

virtual bool wxSQLite3::CipherAes128::Apply ( void * dbHandle) const
virtual

Reimplemented from wxSQLite3::Cipher.

◆ GetLegacy()

bool wxSQLite3::CipherAes128::GetLegacy ( ) const
inline

Get legacy mode.

◆ InitializeFromCurrent()

virtual bool wxSQLite3::CipherAes128::InitializeFromCurrent ( Database & 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
dbdatabase instance representing a database connection
Returns
true if the cipher instance could be initialized successfully, false otherwise

Reimplemented from wxSQLite3::Cipher.

◆ InitializeFromCurrentDefault()

virtual bool wxSQLite3::CipherAes128::InitializeFromCurrentDefault ( Database & 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
dbdatabase instance representing a database connection
Returns
true if the cipher instance could be initialized successfully, false otherwise

Reimplemented from wxSQLite3::Cipher.

◆ InitializeFromGlobalDefault()

virtual bool wxSQLite3::CipherAes128::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 wxSQLite3::Cipher.

◆ SetLegacy()

void wxSQLite3::CipherAes128::SetLegacy ( bool legacy)
inline

Set legacy mode.


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