group__kim__types__reference.html [plain text]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Kerberos Identity Management: KIM Types and Constants</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>KIM Types and Constants</h1>
<p>
<h2>Defines</h2>
<ul>
<li>#define <a class="el" href="group__kim__types__reference.html#g322f65f7d72470d57e21a4c8777ee9fb">KIM_IDENTITY_ANY</a> ((<a class="el" href="group__kim__types__reference.html#gf96cafc394b0d02327b4df8ff669d589">kim_identity</a>) NULL)
<li>#define <a class="el" href="group__kim__types__reference.html#ge0384d3f6d9108e3ec84e322c61235a7">KIM_OPTIONS_DEFAULT</a> ((<a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a>) NULL)
<li>#define <a class="el" href="group__kim__types__reference.html#g88d98fa3bd4ca00913bff414d65c3590">KIM_OPTIONS_START_IMMEDIATELY</a> ((kim_time_t) 0)
<li>#define <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a> ((<a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a>) 0)
<li>#define <a class="el" href="group__kim__types__reference.html#g4d38dda6e945454742fd5c0e2038a370">kim_comparison_is_less_than</a>(c) (c < 0)
<li>#define <a class="el" href="group__kim__types__reference.html#g82110d33192b3618a1c3d8d51965e80f">kim_comparison_is_equal_to</a>(c) (c == 0)
<li>#define <a class="el" href="group__kim__types__reference.html#g95693c83e1981bd08bc616ab947ee01d">kim_comparison_is_greater_than</a>(c) (c > 0)
</ul>
<h2>Typedefs</h2>
<ul>
<li>typedef int <a class="el" href="group__kim__types__reference.html#g48e19d7e4aec7dc6662149cab39bbe20">kim_credential_state</a>
<li>typedef int32_t <a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a>
<li>typedef int64_t <a class="el" href="group__kim__types__reference.html#g3da22452677b45753d40e07f3904dff5">kim_time</a>
<li>typedef int64_t <a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a>
<li>typedef uint64_t <a class="el" href="group__kim__types__reference.html#g098e3611b2bc3af38b5f06838153165d">kim_count</a>
<li>typedef int <a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a>
<li>typedef int <a class="el" href="group__kim__types__reference.html#gae48569e847ff6af9d10add42a4338e7">kim_comparison</a>
<li>typedef const char * <a class="el" href="group__kim__types__reference.html#geea99aa292876e06003b7480087eecb0">kim_string</a>
<li>typedef struct <br>
kim_identity_opaque * <a class="el" href="group__kim__types__reference.html#gf96cafc394b0d02327b4df8ff669d589">kim_identity</a>
<li>typedef struct <br>
kim_options_opaque * <a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a>
<li>typedef struct <br>
kim_selection_hints_opaque * <a class="el" href="group__kim__types__reference.html#gda34b5ed23fb7cc4e4db533edec4e942">kim_selection_hints</a>
<li>typedef struct <br>
kim_preferences_opaque * <a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a>
<li>typedef struct <br>
kim_ccache_iterator_opaque * <a class="el" href="group__kim__types__reference.html#gdf94e85294f9f42293bfb6a4ec35817c">kim_ccache_iterator</a>
<li>typedef struct <br>
kim_ccache_opaque * <a class="el" href="group__kim__types__reference.html#gaecf0d1ae48c995038dd20b21e3781c2">kim_ccache</a>
<li>typedef struct <br>
kim_credential_iterator_opaque * <a class="el" href="group__kim__types__reference.html#gdd760f1db624009792f1b5100cd6c4e3">kim_credential_iterator</a>
<li>typedef struct <br>
kim_credential_opaque * <a class="el" href="group__kim__types__reference.html#ge57b4df3376c4a34a119078a7f4a0030">kim_credential</a>
</ul>
<h2>Enumerations</h2>
<ul>
<li>enum <a class="el" href="group__kim__types__reference.html#g6e5c2c986359589562c83f1da2cf0ca0">kim_credential_state_enum</a> { <br>
<b>kim_credentials_state_valid</b> = 0,
<b>kim_credentials_state_expired</b> = 1,
<b>kim_credentials_state_not_yet_valid</b> = 2,
<b>kim_credentials_state_needs_validation</b> = 3,
<br>
<b>kim_credentials_state_address_mismatch</b> = 4
<br>
}
</ul>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="g322f65f7d72470d57e21a4c8777ee9fb"></a><!-- doxytag: member="kim_identity.h::KIM_IDENTITY_ANY" ref="g322f65f7d72470d57e21a4c8777ee9fb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define KIM_IDENTITY_ANY ((<a class="el" href="group__kim__types__reference.html#gf96cafc394b0d02327b4df8ff669d589">kim_identity</a>) NULL) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constant to specify any Kerberos identity is acceptable.
</div>
</div><p>
<a class="anchor" name="ge0384d3f6d9108e3ec84e322c61235a7"></a><!-- doxytag: member="kim_options.h::KIM_OPTIONS_DEFAULT" ref="ge0384d3f6d9108e3ec84e322c61235a7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define KIM_OPTIONS_DEFAULT ((<a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a>) NULL) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Specifies the user's default options.
</div>
</div><p>
<a class="anchor" name="g88d98fa3bd4ca00913bff414d65c3590"></a><!-- doxytag: member="kim_options.h::KIM_OPTIONS_START_IMMEDIATELY" ref="g88d98fa3bd4ca00913bff414d65c3590" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define KIM_OPTIONS_START_IMMEDIATELY ((kim_time_t) 0) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Specifies that credentials should be valid immediately.
</div>
</div><p>
<a class="anchor" name="g8712727bab9e6b02712a8a01285441d1"></a><!-- doxytag: member="kim_types.h::KIM_NO_ERROR" ref="g8712727bab9e6b02712a8a01285441d1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define KIM_NO_ERROR ((<a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a>) 0) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
No error value for the kim_error type.
</div>
</div><p>
<a class="anchor" name="g4d38dda6e945454742fd5c0e2038a370"></a><!-- doxytag: member="kim_types.h::kim_comparison_is_less_than" ref="g4d38dda6e945454742fd5c0e2038a370" args="(c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define kim_comparison_is_less_than </td>
<td>(</td>
<td class="paramtype">c </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> (c < 0)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Convenience macro for interpreting <a class="el" href="group__kim__types__reference.html#gae48569e847ff6af9d10add42a4338e7">kim_comparison</a>.
</div>
</div><p>
<a class="anchor" name="g82110d33192b3618a1c3d8d51965e80f"></a><!-- doxytag: member="kim_types.h::kim_comparison_is_equal_to" ref="g82110d33192b3618a1c3d8d51965e80f" args="(c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define kim_comparison_is_equal_to </td>
<td>(</td>
<td class="paramtype">c </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> (c == 0)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Convenience macro for interpreting <a class="el" href="group__kim__types__reference.html#gae48569e847ff6af9d10add42a4338e7">kim_comparison</a>.
</div>
</div><p>
<a class="anchor" name="g95693c83e1981bd08bc616ab947ee01d"></a><!-- doxytag: member="kim_types.h::kim_comparison_is_greater_than" ref="g95693c83e1981bd08bc616ab947ee01d" args="(c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define kim_comparison_is_greater_than </td>
<td>(</td>
<td class="paramtype">c </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> (c > 0)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Convenience macro for interpreting <a class="el" href="group__kim__types__reference.html#gae48569e847ff6af9d10add42a4338e7">kim_comparison</a>.
</div>
</div><p>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="g48e19d7e4aec7dc6662149cab39bbe20"></a><!-- doxytag: member="kim_credential.h::kim_credential_state" ref="g48e19d7e4aec7dc6662149cab39bbe20" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int <a class="el" href="group__kim__types__reference.html#g48e19d7e4aec7dc6662149cab39bbe20">kim_credential_state</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The state of a credential. See <a class="el" href="group__kim__types__reference.html#g6e5c2c986359589562c83f1da2cf0ca0">kim_credential_state_enum</a> for possible values.
</div>
</div><p>
<a class="anchor" name="g40f5fe10ab395bddc34286e0c2ff76eb"></a><!-- doxytag: member="kim_types.h::kim_error" ref="g40f5fe10ab395bddc34286e0c2ff76eb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int32_t <a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The KIM Error type.
</div>
</div><p>
<a class="anchor" name="g3da22452677b45753d40e07f3904dff5"></a><!-- doxytag: member="kim_types.h::kim_time" ref="g3da22452677b45753d40e07f3904dff5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int64_t <a class="el" href="group__kim__types__reference.html#g3da22452677b45753d40e07f3904dff5">kim_time</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A time value represented in seconds since January 1, 1970.
</div>
</div><p>
<a class="anchor" name="g245934c4ef7f94ff7960e20e0cc01123"></a><!-- doxytag: member="kim_types.h::kim_lifetime" ref="g245934c4ef7f94ff7960e20e0cc01123" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int64_t <a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A duration represented in seconds.
</div>
</div><p>
<a class="anchor" name="g098e3611b2bc3af38b5f06838153165d"></a><!-- doxytag: member="kim_types.h::kim_count" ref="g098e3611b2bc3af38b5f06838153165d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef uint64_t <a class="el" href="group__kim__types__reference.html#g098e3611b2bc3af38b5f06838153165d">kim_count</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
An quantity, usually used to return the number of elements in an array.
</div>
</div><p>
<a class="anchor" name="g6f8afd4047c4fe420c05f940f89ffba0"></a><!-- doxytag: member="kim_types.h::kim_boolean" ref="g6f8afd4047c4fe420c05f940f89ffba0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int <a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A boolean value. 0 means false, all other values mean true.
</div>
</div><p>
<a class="anchor" name="gae48569e847ff6af9d10add42a4338e7"></a><!-- doxytag: member="kim_types.h::kim_comparison" ref="gae48569e847ff6af9d10add42a4338e7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int <a class="el" href="group__kim__types__reference.html#gae48569e847ff6af9d10add42a4338e7">kim_comparison</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A comparison between two sortable objects. <ul>
<li>Less than 0 means the first object is less than the second. </li>
<li>0 means the two objects are identical. </li>
<li>Greater than 0 means the first object is greater than the second. <dl class="note" compact><dt><b>Note:</b></dt><dd>Convenience macros are provided for interpreting <a class="el" href="group__kim__types__reference.html#gae48569e847ff6af9d10add42a4338e7">kim_comparison</a> values to improve code readability. See <a class="el" href="group__kim__types__reference.html#g4d38dda6e945454742fd5c0e2038a370">kim_comparison_is_less_than()</a>, <a class="el" href="group__kim__types__reference.html#g82110d33192b3618a1c3d8d51965e80f">kim_comparison_is_equal_to()</a> and <a class="el" href="group__kim__types__reference.html#g95693c83e1981bd08bc616ab947ee01d">kim_comparison_is_greater_than()</a> </dd></dl>
</li>
</ul>
</div>
</div><p>
<a class="anchor" name="geea99aa292876e06003b7480087eecb0"></a><!-- doxytag: member="kim_types.h::kim_string" ref="geea99aa292876e06003b7480087eecb0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef const char* <a class="el" href="group__kim__types__reference.html#geea99aa292876e06003b7480087eecb0">kim_string</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The KIM String type. See <a class="el" href="kim_string_overview.html">KIM String Overview</a> for more information.
</div>
</div><p>
<a class="anchor" name="gf96cafc394b0d02327b4df8ff669d589"></a><!-- doxytag: member="kim_types.h::kim_identity" ref="gf96cafc394b0d02327b4df8ff669d589" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct kim_identity_opaque* <a class="el" href="group__kim__types__reference.html#gf96cafc394b0d02327b4df8ff669d589">kim_identity</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A KIM Principal object. See <a class="el" href="kim_identity_overview.html">KIM Identity Overview</a> for more information.
</div>
</div><p>
<a class="anchor" name="gc61f3242847e46c14c73e423829888ab"></a><!-- doxytag: member="kim_types.h::kim_options" ref="gc61f3242847e46c14c73e423829888ab" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct kim_options_opaque* <a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A KIM Options object. See <a class="el" href="kim_options_overview.html">KIM Options Overview</a> for more information.
</div>
</div><p>
<a class="anchor" name="gda34b5ed23fb7cc4e4db533edec4e942"></a><!-- doxytag: member="kim_types.h::kim_selection_hints" ref="gda34b5ed23fb7cc4e4db533edec4e942" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct kim_selection_hints_opaque* <a class="el" href="group__kim__types__reference.html#gda34b5ed23fb7cc4e4db533edec4e942">kim_selection_hints</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A KIM Selection Hints object. See <a class="el" href="kim_selection_hints_overview.html">KIM Selection Hints Overview</a> for more information.
</div>
</div><p>
<a class="anchor" name="g2da1f3d3fb0bfbcdd77886a4fd64128c"></a><!-- doxytag: member="kim_types.h::kim_preferences" ref="g2da1f3d3fb0bfbcdd77886a4fd64128c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct kim_preferences_opaque* <a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A KIM Preferences object. See <a class="el" href="kim_preferences_overview.html">KIM Preferences Overview</a> for more information.
</div>
</div><p>
<a class="anchor" name="gdf94e85294f9f42293bfb6a4ec35817c"></a><!-- doxytag: member="kim_types.h::kim_ccache_iterator" ref="gdf94e85294f9f42293bfb6a4ec35817c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct kim_ccache_iterator_opaque* <a class="el" href="group__kim__types__reference.html#gdf94e85294f9f42293bfb6a4ec35817c">kim_ccache_iterator</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A KIM CCache Iterator object. See <a class="el" href="kim_ccache_overview.html#kim_credential_cache_collection">Acquiring a CCache from the Cache Collection</a> for more information.
</div>
</div><p>
<a class="anchor" name="gaecf0d1ae48c995038dd20b21e3781c2"></a><!-- doxytag: member="kim_types.h::kim_ccache" ref="gaecf0d1ae48c995038dd20b21e3781c2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct kim_ccache_opaque* <a class="el" href="group__kim__types__reference.html#gaecf0d1ae48c995038dd20b21e3781c2">kim_ccache</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A KIM CCache object. See <a class="el" href="kim_ccache_overview.html">KIM CCache Overview</a> for more information.
</div>
</div><p>
<a class="anchor" name="gdd760f1db624009792f1b5100cd6c4e3"></a><!-- doxytag: member="kim_types.h::kim_credential_iterator" ref="gdd760f1db624009792f1b5100cd6c4e3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct kim_credential_iterator_opaque* <a class="el" href="group__kim__types__reference.html#gdd760f1db624009792f1b5100cd6c4e3">kim_credential_iterator</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A KIM Credential Iterator object. See <a class="el" href="kim_credential_overview.html#kim_credential_iterator">Iterating over the Credentials in a CCache</a> for more information.
</div>
</div><p>
<a class="anchor" name="ge57b4df3376c4a34a119078a7f4a0030"></a><!-- doxytag: member="kim_types.h::kim_credential" ref="ge57b4df3376c4a34a119078a7f4a0030" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct kim_credential_opaque* <a class="el" href="group__kim__types__reference.html#ge57b4df3376c4a34a119078a7f4a0030">kim_credential</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A KIM Credential object. See <a class="el" href="kim_credential_overview.html">KIM Credential Overview</a> for more information.
</div>
</div><p>
<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="g6e5c2c986359589562c83f1da2cf0ca0"></a><!-- doxytag: member="kim_credential.h::kim_credential_state_enum" ref="g6e5c2c986359589562c83f1da2cf0ca0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__kim__types__reference.html#g6e5c2c986359589562c83f1da2cf0ca0">kim_credential_state_enum</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Possible credential states. Credentials may be: <ul>
<li>valid - The credential can be used. </li>
<li>expired - The credential's lifetime has been exceeded. </li>
<li>not_yet_valid - The credential is post dated and the time when it becomes valid has not yet been reached. </li>
<li>needs_validation - The credential is post-dated and although the time when it becomes valid has been reached it has not yet been validated. </li>
<li>address_mismatch - The credential contains IP address(es) which do not match the host's local address(es). </li>
</ul>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Nov 3 17:45:44 2008 for Kerberos Identity Management by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>