database.h File Reference

#include <stdlib.h>
#include <sqlite3.h>

Include dependency graph for database.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	db_result
struct	db_row

Macros
#define	KSM_DB_VERSION   3 /* This needs to match that given in the dbadmin table */
#define	MYSQL_DB   1
#define	SQLITE_DB   2
#define	DB_RESULT_MAGIC   (0x10203044)
#define	DB_ROW_MAGIC   (0xbedea133)

Typedefs
typedef sqlite3 *	DB_HANDLE
typedef unsigned long	DB_ID
typedef struct db_result *	DB_RESULT
typedef struct db_row *	DB_ROW

Functions
void	DbInit (void)
void	DbRundown (void)
int	DbConnect (DB_HANDLE *dbhandle, const char *database,...)
int	DbDisconnect (DB_HANDLE dbhandle)
int	DbConnected (DB_HANDLE dbhandle)
int	DbCheckConnected (DB_HANDLE dbhandle)
DB_HANDLE	DbHandle (void)
int	DbExecuteSql (DB_HANDLE handle, const char *stmt_str, DB_RESULT *result)
void	DbFreeResult (DB_RESULT result)
int	DbFetchRow (DB_RESULT result, DB_ROW *row)
void	DbFreeRow (DB_ROW row)
int	DbString (DB_ROW row, int field_index, char **result)
void	DbStringFree (char *string)
int	DbExecuteSqlNoResult (DB_HANDLE dbhandle, const char *stmt_str)
int	DbUnsignedLong (DB_ROW row, int field_index, unsigned long *value)
int	DbInt (DB_ROW row, int field_index, int *value)
int	DbIntQuery (DB_HANDLE handle, int *value, const char *query)
int	DbStringBuffer (DB_ROW row, int field_index, char *buffer, size_t buflen)
int	DbRowId (DB_ROW, DB_ID *id)
const char *	DbErrmsg (DB_HANDLE handle)
int	DbErrno (DB_HANDLE handle)
int	DbLastRowId (DB_HANDLE handle, DB_ID *id)
int	DbBeginTransaction (void)
int	DbCommit (void)
int	DbRollback (void)
int	DbQuoteString (DB_HANDLE handle, const char *in, char *buffer, size_t buflen)
int	DbDateDiff (const char *start, int delta, int sign, char *buffer, size_t buflen)
int	DbFlavour (void)
int	db_version_check (void)

Macro Definition Documentation

#define DB_RESULT_MAGIC   (0x10203044)

Definition at line 88 of file database.h.

Referenced by DbExecuteSql(), DbFetchRow(), and DbFreeResult().

#define DB_ROW_MAGIC   (0xbedea133)

Definition at line 97 of file database.h.

Referenced by DbFetchRow(), DbFreeRow(), DbString(), and DbStringBuffer().

#define KSM_DB_VERSION   3 /* This needs to match that given in the dbadmin table */

Definition at line 43 of file database.h.

Referenced by db_version_check().

#define MYSQL_DB   1

Definition at line 45 of file database.h.

Referenced by DbFlavour(), get_db_details(), and ReadConfig().

#define SQLITE_DB   2

Definition at line 46 of file database.h.

Referenced by cmd_dbbackup(), cmd_setup(), db_connect(), db_disconnect(), DbFlavour(), get_db_details(), ReadConfig(), and server_main().

Typedef Documentation

typedef sqlite3* DB_HANDLE

Definition at line 77 of file database.h.

typedef unsigned long DB_ID

Definition at line 78 of file database.h.

typedef struct db_result* DB_RESULT

Definition at line 90 of file database.h.

typedef struct db_row* DB_ROW

Definition at line 98 of file database.h.

Function Documentation

int db_version_check

(

void

)

Definition at line 103 of file database_init_rundown.c.

References DbExecuteSql(), DbFetchRow(), DbFreeResult(), DbFreeRow(), DbHandle(), DbInt(), KME_DB_ADMIN, KME_WRONG_DB_VER, KSM_DB_VERSION, and MsgLog().

Referenced by DbConnect().

int DbBeginTransaction

(

void

)

Definition at line 462 of file database_access_lite.c.

References DbExecuteSqlNoResult(), and DbHandle().

Referenced by ChangeKeyState(), cmd_purgepolicy(), KsmRequestKeys(), MarkDSSeen(), and RetireOldKey().

int DbCheckConnected

(

DB_HANDLE

dbhandle

)

Definition at line 206 of file database_connection_lite.c.

References DbConnected(), DBS_NOTCONERR, and MsgLog().

int DbCommit

(

void

)

Definition at line 478 of file database_access_lite.c.

References DbExecuteSqlNoResult(), and DbHandle().

Referenced by ChangeKeyState(), cmd_purgepolicy(), KsmRequestKeys(), MarkDSSeen(), and RetireOldKey().

int DbConnect	(	DB_HANDLE *	dbhandle,
		const char *	database,
			...
	)

Definition at line 82 of file database_connection_lite.c.

References db_version_check(), DbInit(), DBS_AUTOCOMM, DBS_CONNFAIL, DBS_INITFAIL, MsgLog(), and StrStrtoui().

Referenced by cmd_setup(), db_connect(), kaspConnect(), kaspTryConnect(), and TdbSetup().

int DbConnected

(

DB_HANDLE

dbhandle

)

Definition at line 184 of file database_connection_lite.c.

Referenced by DbCheckConnected().

int DbDateDiff	(	const char *	start,
		int	delta,
		int	sign,
		char *	buffer,
		size_t	buflen
	)

Definition at line 543 of file database_support_lite.c.

References DBS_INVARG, and MsgLog().

Referenced by ChangeKeyState(), do_purge(), MarkDSSeen(), and RetireOldKey().

int DbDisconnect

(

DB_HANDLE

dbhandle

)

Definition at line 150 of file database_connection_lite.c.

References DBS_NOTCONN, and MsgLog().

Referenced by cmd_addzone(), cmd_backup(), cmd_dsseen(), cmd_exportkeys(), cmd_exportpolicy(), cmd_exportzonelist(), cmd_import(), cmd_keypurge(), cmd_kskretire(), cmd_listbackups(), cmd_listkeys(), cmd_listpolicy(), cmd_listrepo(), cmd_listrolls(), cmd_listzone(), cmd_rollpolicy(), cmd_rollzone(), cmd_setup(), cmd_update(), kaspDisconnect(), and TdbTeardown().

const char* DbErrmsg

(

DB_HANDLE

handle

)

Definition at line 426 of file database_support_lite.c.

Referenced by ChangeKeyState(), cmd_delkey(), cmd_purgepolicy(), DbExecuteSql(), do_purge(), get_policy_name_from_id(), keyRoll(), KsmCheckHSMkeyID(), KsmDeleteZone(), KsmDNSSECKeysInSMCount(), KsmImportRepository(), KsmImportZone(), KsmKeyCountQueue(), KsmKeyCountStillGood(), KsmKeyGetUnallocated(), KsmMarkBackup(), KsmMarkPreBackup(), KsmPolicy(), KsmPolicyExists(), KsmPolicyIdFromName(), KsmPolicyIdFromZoneId(), KsmPolicyNameFromId(), KsmPolicyParameter(), KsmPolicyPopulateSMFromIds(), KsmPolicySetIdFromName(), KsmPolicyUpdateSalt(), KsmRequestAvailableCount(), KsmRequestChangeState(), KsmRequestChangeStateN(), KsmRequestCheckActiveKey(), KsmRequestCheckCompromisedFlag(), KsmRequestCheckFirstPass(), KsmRequestCountReadyKey(), KsmRequestGenerateCount(), KsmRequestKeys(), KsmRequestKeysByType(), KsmRequestPendingRetireCount(), KsmRequestSetActiveExpectedRetire(), KsmRequestStandbyKSKCount(), KsmRollbackMarkPreBackup(), KsmSerialIdFromName(), KsmSmIdFromName(), KsmZone(), KsmZoneCount(), KsmZoneIdAndPolicyFromName(), KsmZoneIdFromName(), KsmZoneNameFromId(), MarkDSSeen(), PurgeKeys(), and RetireOldKey().

int DbErrno

(

DB_HANDLE

handle

)

Definition at line 403 of file database_support_lite.c.

int DbExecuteSql	(	DB_HANDLE	handle,
		const char *	stmt_str,
		DB_RESULT *	result
	)

Definition at line 136 of file database_access_lite.c.

References db_result::count, DB_RESULT_MAGIC, DbErrmsg(), DBS_INVARG, DBS_SQLFAIL, MemCalloc(), MemFree, and MsgLog().

Referenced by cmd_listzone(), CountKeys(), db_version_check(), DbExecuteSqlNoResult(), DbIntQuery(), do_purge(), get_policy_name_from_id(), GetKeyState(), keyRoll(), KsmCheckNextRollover(), KsmDNSSECKeysInSMCountInit(), KsmDNSSECKeysStateCountInit(), KsmKeyGetUnallocated(), KsmKeyInitSql(), KsmListBackups(), KsmListPolicies(), KsmListRepos(), KsmListRollovers(), KsmParameterExist(), KsmParameterInit(), KsmPolicyIdFromZoneId(), KsmPolicyInit(), KsmPolicyNameFromId(), KsmPolicyParametersInit(), KsmPolicyPopulateSMFromIds(), KsmPolicyUpdateSalt(), KsmPurge(), KsmZoneCountInit(), KsmZoneIdAndPolicyFromName(), KsmZoneIdFromName(), KsmZoneInit(), KsmZoneNameFromId(), ListDS(), ListKeys(), PurgeKeys(), and update_zones().

int DbExecuteSqlNoResult	(	DB_HANDLE	dbhandle,
		const char *	stmt_str
	)

Definition at line 76 of file database_support_lite.c.

References DbExecuteSql(), DbFreeResult(), DBS_UNEXRES, and MsgLog().

Referenced by ChangeKeyState(), cmd_delkey(), cmd_purgepolicy(), DbBeginTransaction(), DbCommit(), DbRollback(), do_purge(), keyRoll(), KsmDeleteKeyRange(), KsmDeleteZone(), KsmDnssecKeyCreate(), KsmImportKeyPair(), KsmImportPolicy(), KsmImportRepository(), KsmImportZone(), KsmKeyPairCreate(), KsmKillKey(), KsmMarkBackup(), KsmMarkPreBackup(), KsmParameterSet(), KsmPolicyNullSaltStamp(), KsmPolicyUpdateDesc(), KsmPolicyUpdateSalt(), KsmPurge(), KsmRequestChangeState(), KsmRequestChangeStateN(), KsmRequestSetActiveExpectedRetire(), KsmRollbackMarkPreBackup(), KsmUpdateKeyTime(), MarkDSSeen(), PurgeKeys(), and RetireOldKey().

int DbFetchRow	(	DB_RESULT	result,
		DB_ROW *	row
	)

Definition at line 284 of file database_access_lite.c.

References db_result::data, DB_RESULT_MAGIC, DB_ROW_MAGIC, DBS_INVARG, db_result::first_row, db_result::magic, MemCalloc(), and MsgLog().

Referenced by cmd_listzone(), CountKeys(), db_version_check(), DbIntQuery(), do_purge(), get_policy_name_from_id(), GetKeyState(), keyRoll(), KsmCheckNextRollover(), KsmDNSSECKeysInSMCount(), KsmKey(), KsmKeyGetUnallocated(), KsmListBackups(), KsmListPolicies(), KsmListRepos(), KsmListRollovers(), KsmParameter(), KsmParameterExist(), KsmPolicy(), KsmPolicyExists(), KsmPolicyIdFromZoneId(), KsmPolicyNameFromId(), KsmPolicyParameter(), KsmPolicyPopulateSMFromIds(), KsmPolicySetIdFromName(), KsmPolicyUpdateSalt(), KsmPurge(), KsmZone(), KsmZoneCount(), KsmZoneIdAndPolicyFromName(), KsmZoneIdFromName(), KsmZoneNameFromId(), ListDS(), ListKeys(), PurgeKeys(), and update_zones().

int DbFlavour

(

void

)

Definition at line 84 of file database_init_rundown.c.

References MYSQL_DB, and SQLITE_DB.

Referenced by cmd_dbbackup(), cmd_setup(), db_connect(), db_disconnect(), get_db_details(), ReadConfig(), and server_main().

void DbFreeResult

(

DB_RESULT

result

)

Definition at line 239 of file database_access_lite.c.

References db_result::data, DB_RESULT_MAGIC, DBS_INVARG, db_result::magic, MemFree, and MsgLog().

Referenced by cmd_genkeys(), cmd_listzone(), cmd_purgepolicy(), cmd_rollpolicy(), CountKeys(), db_version_check(), DbExecuteSqlNoResult(), DbIntQuery(), do_keygen(), do_purge(), get_policy_name_from_id(), keyRoll(), KsmCheckNextRollover(), KsmKeyEnd(), KsmKeyGetUnallocated(), KsmListBackups(), KsmListPolicies(), KsmListRepos(), KsmListRollovers(), KsmParameterEnd(), KsmParameterValue(), KsmPolicyExists(), KsmPolicyIdFromZoneId(), KsmPolicyNameFromId(), KsmPolicyPopulateSMFromIds(), KsmPolicySetIdFromName(), KsmPolicyUpdateSalt(), KsmPurge(), KsmZoneIdAndPolicyFromName(), KsmZoneIdFromName(), KsmZoneNameFromId(), ListKeys(), PurgeKeys(), server_main(), and update_zones().

void DbFreeRow

(

DB_ROW

row

)

Definition at line 344 of file database_access_lite.c.

References DB_ROW_MAGIC, DBS_INVARG, db_row::magic, MemFree, and MsgLog().

Referenced by cmd_listzone(), CountKeys(), db_version_check(), DbIntQuery(), do_purge(), get_policy_name_from_id(), GetKeyState(), keyRoll(), KsmCheckNextRollover(), KsmDNSSECKeysInSMCount(), KsmKey(), KsmKeyGetUnallocated(), KsmListBackups(), KsmListPolicies(), KsmListRepos(), KsmListRollovers(), KsmParameter(), KsmParameterExist(), KsmPolicy(), KsmPolicyExists(), KsmPolicyIdFromZoneId(), KsmPolicyNameFromId(), KsmPolicyParameter(), KsmPolicyPopulateSMFromIds(), KsmPolicySetIdFromName(), KsmPolicyUpdateSalt(), KsmPurge(), KsmZone(), KsmZoneCount(), KsmZoneIdAndPolicyFromName(), KsmZoneIdFromName(), KsmZoneNameFromId(), ListDS(), ListKeys(), PurgeKeys(), and update_zones().

DB_HANDLE DbHandle

(

void

)

Definition at line 234 of file database_connection_lite.c.

Referenced by ChangeKeyState(), cmd_delkey(), cmd_listzone(), cmd_purgepolicy(), CountKeys(), CountKeysInState(), db_version_check(), DbBeginTransaction(), DbCommit(), DbRollback(), do_purge(), get_policy_name_from_id(), GetKeyState(), keyRoll(), KsmCheckHSMkeyID(), KsmCheckNextRollover(), KsmDeleteKeyRange(), KsmDeleteZone(), KsmDnssecKeyCreate(), KsmDNSSECKeysInSMCount(), KsmDNSSECKeysInSMCountInit(), KsmDNSSECKeysStateCountInit(), KsmImportKeyPair(), KsmImportPolicy(), KsmImportRepository(), KsmImportZone(), KsmKeyCountQueue(), KsmKeyCountStillGood(), KsmKeyGetUnallocated(), KsmKeyInitSql(), KsmKeyPairCreate(), KsmKillKey(), KsmListBackups(), KsmListPolicies(), KsmListRepos(), KsmListRollovers(), KsmMarkBackup(), KsmMarkPreBackup(), KsmParameterExist(), KsmParameterInit(), KsmParameterSet(), KsmPolicy(), KsmPolicyExists(), KsmPolicyIdFromName(), KsmPolicyIdFromZoneId(), KsmPolicyInit(), KsmPolicyNameFromId(), KsmPolicyNullSaltStamp(), KsmPolicyParameter(), KsmPolicyParametersInit(), KsmPolicyPopulateSMFromIds(), KsmPolicySetIdFromName(), KsmPolicyUpdateDesc(), KsmPolicyUpdateSalt(), KsmPurge(), KsmRequestAvailableCount(), KsmRequestChangeState(), KsmRequestChangeStateN(), KsmRequestCheckActiveKey(), KsmRequestCheckCompromisedFlag(), KsmRequestCheckFirstPass(), KsmRequestCountReadyKey(), KsmRequestGenerateCount(), KsmRequestKeys(), KsmRequestKeysByType(), KsmRequestPendingRetireCount(), KsmRequestSetActiveExpectedRetire(), KsmRequestStandbyKSKCount(), KsmRollbackMarkPreBackup(), KsmSerialIdFromName(), KsmSmIdFromName(), KsmUpdateKeyTime(), KsmZone(), KsmZoneCount(), KsmZoneCountInit(), KsmZoneIdAndPolicyFromName(), KsmZoneIdFromName(), KsmZoneInit(), KsmZoneNameFromId(), ListDS(), ListKeys(), MarkDSSeen(), NewDSSet(), PurgeKeys(), RetireOldKey(), TdbTeardown(), and update_zones().

void DbInit

(

void

)

Definition at line 57 of file database_init_rundown.c.

References DBS_MAX_VALUE, DBS_MIN_VALUE, and MsgRegister().

Referenced by DbConnect(), KsmInit(), and TdbSetup().

int DbInt	(	DB_ROW	row,
		int	field_index,
		int *	value
	)

Definition at line 160 of file database_support_lite.c.

References DBS_NOTINT, DbString(), DbStringFree(), MsgLog(), and StrStrtoi().

Referenced by CountKeys(), db_version_check(), DbIntQuery(), do_purge(), GetKeyState(), keyRoll(), KsmDNSSECKeysInSMCount(), KsmKey(), KsmKeyGetUnallocated(), KsmListBackups(), KsmListRepos(), KsmListRollovers(), KsmParameter(), KsmParameterExist(), KsmPolicy(), KsmPolicyIdFromZoneId(), KsmPolicyParameter(), KsmPolicyPopulateSMFromIds(), KsmPolicySetIdFromName(), KsmPurge(), KsmZone(), KsmZoneCount(), KsmZoneIdAndPolicyFromName(), KsmZoneIdFromName(), ListDS(), ListKeys(), PurgeKeys(), and update_zones().

int DbIntQuery	(	DB_HANDLE	handle,
		int *	value,
		const char *	query
	)

Definition at line 291 of file database_support_lite.c.

References DbExecuteSql(), DbFetchRow(), DbFreeResult(), DbFreeRow(), DbInt(), DBS_NORESULT, DBS_TOOMANYROW, and MsgLog().

Referenced by ChangeKeyState(), CountKeysInState(), do_purge(), KsmCheckHSMkeyID(), KsmImportRepository(), KsmImportZone(), KsmKeyCountQueue(), KsmKeyCountStillGood(), KsmMarkBackup(), KsmMarkPreBackup(), KsmPolicyIdFromName(), KsmRequestAvailableCount(), KsmRequestChangeState(), KsmRequestChangeStateN(), KsmRequestCheckActiveKey(), KsmRequestCheckCompromisedFlag(), KsmRequestCheckFirstPass(), KsmRequestCountReadyKey(), KsmRequestGenerateCount(), KsmRequestPendingRetireCount(), KsmRequestSetActiveExpectedRetire(), KsmRequestStandbyKSKCount(), KsmRollbackMarkPreBackup(), KsmSerialIdFromName(), KsmSmIdFromName(), NewDSSet(), PurgeKeys(), RetireOldKey(), and update_zones().

int DbLastRowId	(	DB_HANDLE	handle,
		DB_ID *	id
	)

Definition at line 457 of file database_support_lite.c.

References DBS_INVARG, DBS_NOSUCHROW, and MsgLog().

Referenced by KsmDnssecKeyCreate(), KsmImportKeyPair(), and KsmKeyPairCreate().

int DbQuoteString	(	DB_HANDLE	handle,
		const char *	in,
		char *	buffer,
		size_t	buflen
	)

Definition at line 501 of file database_support_lite.c.

References DBS_INVARG, and MsgLog().

Referenced by KsmImportPolicy(), and KsmPolicyUpdateDesc().

int DbRollback

(

void

)

Definition at line 494 of file database_access_lite.c.

References DbExecuteSqlNoResult(), and DbHandle().

Referenced by ChangeKeyState(), cmd_purgepolicy(), KsmRequestKeys(), MarkDSSeen(), and RetireOldKey().

int DbRowId	(	DB_ROW	,
		DB_ID *	id
	)

Definition at line 118 of file database_support_lite.c.

References DBS_INVARG, DbUnsignedLong(), and MsgLog().

void DbRundown

(

void

)

Definition at line 79 of file database_init_rundown.c.

Referenced by KsmRundown(), and TdbTeardown().

int DbString	(	DB_ROW	row,
		int	field_index,
		char **	result
	)

Definition at line 387 of file database_access_lite.c.

References db_result::count, db_result::data, DB_ROW_MAGIC, DBS_INVARG, DBS_INVINDEX, db_row::magic, MemMalloc(), MsgLog(), and db_row::result.

Referenced by cmd_listzone(), CountKeys(), DbInt(), DbStringBuffer(), DbUnsignedLong(), do_purge(), KsmCheckNextRollover(), KsmListBackups(), KsmListPolicies(), KsmListRepos(), KsmListRollovers(), KsmZoneNameFromId(), ListDS(), ListKeys(), PurgeKeys(), and update_zones().

int DbStringBuffer	(	DB_ROW	row,
		int	field_index,
		char *	buffer,
		size_t	buflen
	)

Definition at line 356 of file database_support_lite.c.

References DB_ROW_MAGIC, DBS_INVARG, DbString(), DbStringFree(), db_row::magic, MsgLog(), and StrStrncpy().

Referenced by get_policy_name_from_id(), KsmKey(), KsmParameter(), KsmPolicy(), KsmPolicyNameFromId(), KsmPolicyParameter(), KsmPolicyPopulateSMFromIds(), KsmPolicySetIdFromName(), KsmPolicyUpdateSalt(), and KsmZone().

void DbStringFree

(

char *

string

)

Definition at line 447 of file database_access_lite.c.

References MemFree.

Referenced by CountKeys(), DbInt(), DbStringBuffer(), DbUnsignedLong(), do_purge(), KsmListBackups(), KsmListPolicies(), KsmListRepos(), KsmListRollovers(), ListDS(), ListKeys(), PurgeKeys(), and update_zones().

int DbUnsignedLong	(	DB_ROW	row,
		int	field_index,
		unsigned long *	value
	)

Definition at line 223 of file database_support_lite.c.

References DBS_NOTINT, DbString(), DbStringFree(), MsgLog(), and StrStrtoul().

Referenced by DbRowId(), KsmKey(), and KsmPolicyPopulateSMFromIds().