Cipher base class.
More...
#include <wxsqlite3.h>
◆ wxSQLite3Cipher() [1/3]
wxSQLite3Cipher::wxSQLite3Cipher |
( |
| ) |
|
◆ ~wxSQLite3Cipher()
wxSQLite3Cipher::~wxSQLite3Cipher |
( |
| ) |
|
|
virtual |
◆ wxSQLite3Cipher() [2/3]
Constructor.
- Parameters
-
cipherType | the type of the cipher |
◆ wxSQLite3Cipher() [3/3]
◆ Apply() [1/2]
bool wxSQLite3Cipher::Apply |
( |
void * |
dbHandle | ) |
const |
|
virtual |
◆ Apply() [2/2]
◆ GetCipher()
Get the current cipher type of a database connection.
- Parameters
-
- Returns
- the enum representation of the cipher type
◆ GetCipherDefault()
Get the default cipher type of a database connection.
- Parameters
-
- Returns
- the enum representation of the cipher type
◆ GetCipherName()
Convert cipher type to string representation.
The given cipher type is converted to a string representation.
- Parameters
-
cipherType | the type of a cipher |
- Returns
- string representation of the given cipher type
◆ GetCipherParameterMax()
int wxSQLite3Cipher::GetCipherParameterMax |
( |
const wxString & |
cipherName, |
|
|
const wxString & |
paramName |
|
) |
| |
|
static |
Get maximum allowed cipher parameter value.
- Parameters
-
cipherName | the name of the cipher to be queried |
paramName | the name of the parameter to be queried |
- Returns
- the maximum value for the given cipher parameter
◆ GetCipherParameterMin()
int wxSQLite3Cipher::GetCipherParameterMin |
( |
const wxString & |
cipherName, |
|
|
const wxString & |
paramName |
|
) |
| |
|
static |
Get minimum allowed cipher parameter value.
- Parameters
-
cipherName | the name of the cipher to be queried |
paramName | the name of the parameter to be queried |
- Returns
- the minimum value for the given cipher parameter
◆ GetCipherType() [1/2]
Get the type of this cipher instance.
The type of the cipher instance is returned.
- Returns
- the cipher type
◆ GetCipherType() [2/2]
Convert string representation to cipher type.
The given string representation of a cipher is converted to the corresponding cipher type.. The parameters of the cipher instance are applied to the given database connection. WXSQLITE_CIPHER_UNKNOWN will be returned if the string representation is invalid.
- Parameters
-
cipherName | the string representation of a cipher type |
- Returns
- cipher type corresponding to the given string representation
◆ GetDatabaseHandle()
Get the SQLite3 database handle of a database instance.
- Parameters
-
- Returns
- SQLite3 database handle
◆ GetGlobalCipherDefault()
Get the globally defined default cipher type.
- Returns
- the enum representation of the cipher type
◆ GetLegacyPageSize()
int wxSQLite3Cipher::GetLegacyPageSize |
( |
| ) |
const |
◆ InitializeFromCurrent()
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 in wxSQLite3CipherAes128, wxSQLite3CipherAes256, wxSQLite3CipherChaCha20, and wxSQLite3CipherSQLCipher.
◆ InitializeFromCurrentDefault()
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 in wxSQLite3CipherAes128, wxSQLite3CipherAes256, wxSQLite3CipherChaCha20, and wxSQLite3CipherSQLCipher.
◆ InitializeFromGlobalDefault()
bool wxSQLite3Cipher::InitializeFromGlobalDefault |
( |
| ) |
|
|
virtual |
◆ IsOk()
bool wxSQLite3Cipher::IsOk |
( |
| ) |
const |
Check whether the cipher instance is valid.
The method checks whether the cipher instance is initialized correctly.
- Returns
- true if the cipher instance is valid, false otherwise
◆ SetCipher()
Set the current cipher type for a database connection.
- Parameters
-
db | database instance |
cipherType | the cipher type to be set |
- Returns
- true if the cipher type could be set, false otherwise
◆ SetCipherDefault()
Set the default cipher type for a database connection.
- Parameters
-
db | database instance |
cipherType | the cipher type to be set |
- Returns
- true if the cipher type could be set, false otherwise
◆ SetCipherType()
Set type of the cipher instance.
- Parameters
-
cipherType | the cipher type to be set |
◆ SetInitialized()
void wxSQLite3Cipher::SetInitialized |
( |
bool |
initialized | ) |
|
|
protected |
Set initialization status of the cipher instance.
- Parameters
-
initialized | the initialization status |
◆ SetLegacyPageSize()
void wxSQLite3Cipher::SetLegacyPageSize |
( |
int |
pageSize | ) |
|
The documentation for this class was generated from the following files: