KIM Types and Constants

Defines

Typedefs

Enumerations

Variables

Define Documentation

#define KIM_NO_ERROR   ((kim_error_t) NULL)
 

The kim_error_t returned when no error occurred. Does not need to be freed with kim_error_free().

#define KIM_NO_ERROR_ECODE   ((kim_error_code_t) 0)
 

The kim_error_code_t for KIM_NO_ERROR.

#define KIM_IDENTITY_ANY   ((kim_identity_t) NULL)
 

Constant to specify any Kerberos identity is acceptable.

#define KIM_OPTIONS_DEFAULT   ((kim_options_t) NULL)
 

Specifies the user's default options.

#define KIM_OPTIONS_START_IMMEDIATELY   ((kim_time_t) 0)
 

Specifies that credentials should be valid immediately.

Typedef Documentation

typedef uint32_t kim_prompt_type_t
 

The type of prompt which needs to be displayed. This value determines what type of user interface is displayed. See Providing a Custom Prompt Callback for more information.

typedef kim_error_code_t(* kim_prompt_callback_t)(kim_options_t *io_options, kim_prompt_type_t in_type, kim_string_t in_title, kim_string_t in_message, kim_string_t in_description, void **out_reply)
 

The prompt callback used to display a prompt to the user. See Providing a Custom Prompt Callback for more information.

typedef int32_t kim_error_code_t
 

The KIM String type. See KIM String Overview for more information.

typedef int64_t kim_time_t
 

A time value represented in seconds since January 1, 1970.

typedef int64_t kim_lifetime_t
 

A duration represented in seconds.

typedef uint64_t kim_index_t
 

An 0-based index into an array (ie: zero is the first element in the array).

typedef uint64_t kim_count_t
 

An quantity, usually used to return the number of elements in an array.

typedef int kim_boolean_t
 

A boolean value. 0 means false, all other values mean true.

typedef const char* kim_string_t
 

The KIM String type. See KIM String Overview for more information.

typedef struct kim_error_opaque* kim_error_t
 

A KIM Error object. See KIM Error Overview for more information.

typedef struct kim_identity_opaque* kim_identity_t
 

A KIM Principal object. See KIM Identity Overview for more information.

typedef struct kim_options_opaque* kim_options_t
 

A KIM Options object. See KIM Options Overview for more information.

typedef struct kim_selection_hints_opaque* kim_selection_hints_t
 

A KIM Selection Hints object. See KIM Selection Hints Overview for more information.

typedef struct kim_favorite_realms_opaque* kim_favorite_realms_t
 

A KIM Favorite Realms object. See KIM Favorite Realms Overview for more information.

typedef struct kim_preferences_opaque* kim_preferences_t
 

A KIM Preferences object. See KIM Preferences Overview for more information.

typedef struct kim_ccache_iterator_opaque* kim_ccache_iterator_t
 

A KIM CCache Iterator object. See Acquiring a CCache from the Cache Collection for more information.

typedef struct kim_ccache_opaque* kim_ccache_t
 

A KIM CCache object. See KIM CCache Overview for more information.

typedef struct kim_credential_iterator_opaque* kim_credential_iterator_t
 

A KIM Credential Iterator object. See Iterating over the Credentials in a CCache for more information.

typedef struct kim_credential_opaque* kim_credential_t
 

A KIM Credential object. See KIM Credential Overview for more information.

Variable Documentation

const kim_prompt_callback_t kim_prompt_callback_default
 

The default prompt callback. See Providing a Custom Prompt Callback for more information.

const kim_prompt_callback_t kim_prompt_callback_gui
 

The graphical prompt callback. See Providing a Custom Prompt Callback for more information.

const kim_prompt_callback_t kim_prompt_callback_cli
 

The command line prompt callback. See Providing a Custom Prompt Callback for more information.

const kim_prompt_callback_t kim_prompt_callback_none
 

The prompt callback which always returns an error. Use to turn off prompting entirely.

Note:
Using this callback may prevent the user from authenicating. See Providing a Custom Prompt Callback for more information.