Data Fields

char* HDB::hdb_name

krb5_error_code(* HDB::hdb_open)(krb5_context, struct HDB *, int, mode_t)

Open (or create) the a Kerberos database that was resolved with hdb_create(). The third and fourth flag to the function are the same as open(), thus passing O_CREAT will create the data base if it doesn't exists.

Then done the caller should call hdb_close(), and to release all resources hdb_destroy().

krb5_error_code(* HDB::hdb_close)(krb5_context, struct HDB *)

Closes the database for further transactions, wont release any permanant resources. the database can be ->hdb_open-ed again.

void(* HDB::hdb_free)(krb5_context, struct HDB *, hdb_entry_ex *)

krb5_error_code(* HDB::hdb_fetch_kvno)(krb5_context, struct HDB *, krb5_const_principal, unsigned, krb5_kvno, hdb_entry_ex *)

Fetch an entry from the backend, flags are what type of entry should be fetch: client, server, krbtgt. knvo (if specified and flags HDB_F_KVNO_SPECIFIED set) is the kvno to get

krb5_error_code(* HDB::hdb_store)(krb5_context, struct HDB *, unsigned, hdb_entry_ex *)

krb5_error_code(* HDB::hdb_remove)(krb5_context, struct HDB *, krb5_const_principal)

krb5_error_code(* HDB::hdb_firstkey)(krb5_context, struct HDB *, unsigned, hdb_entry_ex *)

krb5_error_code(* HDB::hdb_nextkey)(krb5_context, struct HDB *, unsigned, hdb_entry_ex *)

krb5_error_code(* HDB::hdb_lock)(krb5_context, struct HDB *, int)

A lock can only be held by one consumers. Transaction can still happen on the database while the lock is held, so the entry is only useful for syncroning creation of the database and renaming of the database.

krb5_error_code(* HDB::hdb_unlock)(krb5_context, struct HDB *)

krb5_error_code(* HDB::hdb_rename)(krb5_context, struct HDB *, const char *)

Assume that the database is not hdb_open'ed and not locked.

krb5_error_code(* HDB::hdb__get)(krb5_context, struct HDB *, krb5_data, krb5_data *)

If the database is a classical DB (ie BDB, NDBM, GDBM, etc) backend, this function will take a principal key (krb5_data) and return all data related to principal in the return krb5_data. The returned encoded entry is of type hdb_entry or hdb_entry_alias.

krb5_error_code(* HDB::hdb__put)(krb5_context, struct HDB *, int, krb5_data, krb5_data)

Same discussion as in HDB::hdb__get

krb5_error_code(* HDB::hdb__del)(krb5_context, struct HDB *, krb5_data)

Same discussion as in HDB::hdb__get

krb5_error_code(* HDB::hdb_destroy)(krb5_context, struct HDB *)

Destroy the handle to the database, deallocate all memory and related resources. Does not remove any permanent data. Its the logical reverse of hdb_create() function that is the entry point for the module.

krb5_error_code(* HDB::hdb_get_realms)(krb5_context, struct HDB *, krb5_realm **)

krb5_error_code(* HDB::hdb_password)(krb5_context, struct HDB *, hdb_entry_ex *, const char *, int)

Will update keys for the entry when given password. The new keys must be written into the entry and will then later be ->hdb_store() into the database. The backend will still perform all other operations, increasing the kvno, and update modification timestamp.

The backend needs to call _kadm5_set_keys() and perform password quality checks.

krb5_error_code(* HDB::hdb_auth_status)(krb5_context, struct HDB *, hdb_entry_ex *, int)

This is a feedback call that allows backends that provides lockout functionality to register failure and/or successes.

In case the entry is locked out, the backend should set the hdb_entry.flags.locked-out flag.

krb5_error_code(* HDB::hdb_check_constrained_delegation)(krb5_context, struct HDB *, hdb_entry_ex *, krb5_const_principal)

krb5_error_code(* HDB::hdb_check_pkinit_ms_upn_match)(krb5_context, struct HDB *, hdb_entry_ex *, krb5_const_principal)

krb5_error_code(* HDB::hdb_check_s4u2self)(krb5_context, struct HDB *, hdb_entry_ex *, krb5_const_principal)