Edit File: kim_favorite_identities_overview.html
<!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 Favorite Identities Overview</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><a class="anchor" name="kim_favorite_identities_overview">KIM Favorite Identities Overview</a></h1><h2><a class="anchor" name="kim_favorite_identities_introduction"> Introduction</a></h2> As Kerberos becomes more widespread, the number of possible Kerberos identities and realms a user might want to use will become very large. Sites may list hundreds of realms in their Kerberos configuration files. In addition, sites may wish to use DNS SRV records to avoid having to list all the realms they use in their Kerberos configuration. As a result, the list of realms in the Kerberos configuration may be exceedingly large and/or incomplete. Users may also use multiple identities from the same realm.<p> On platforms which use a GUI to acquire credentials, the KIM would like to to display a list of identities for the user to select from. Depending on what is appropriate for the platform, identities may be displayed in a popup menu or other list.<p> To solve this problem, the KIM maintains a list of favorite identities specifically for identity selection. This list is a set of unique identities in alphabetical order (as appropriate for the user's language localization).<p> On most platforms the list of favorite identities has both an administrator preference and a user preference which overrides it. The administrator preference exists only to initialize the favorite identities for new user accounts. Once the user modifies the list their favorite identities may diverge from the site favorite identities preference.<p> <dl class="note" compact><dt><b>Note:</b></dt><dd>The location of user preferences and the semantics of preference synchronization is platform-specific. Where possible KIM will use platform-specific preference mechanisms.</dd></dl> Most callers will not need to use the favorite identities APIs. However if you are implementing your own graphical prompt callback or a credential management application, you may to view and/or edit the user's favorite identities.<h2><a class="anchor" name="kim_favorite_identities_edit"> Viewing and Editing the Favorite Identities</a></h2> First, you need to acquire the Favorite Identities stored in the user's preferences using <a class="el" href="group__kim__preferences__reference.html#g88fba2fb35d73c5905eb21dcfad57578" title="Create a new preferences object from the current user's preferences.">kim_preferences_create()</a> and <a class="el" href="group__kim__preferences__reference.html#g4ce6a3e2d6b92eb335e7110bf43ef1ab" title="Get the user's preferred list of identities.">kim_preferences_get_favorite_identities()</a>. Or you can use <a class="el" href="group__kim__favorite__identities__reference.html#gce53e4a9c9edb531a9e7e26c37e0a5ea" title="Create a new favorite identities list.">kim_favorite_identities_create()</a> to get an empty identities list if you want to overwrite the user's identities list entirely. See <a class="el" href="kim_preferences_overview.html">KIM Preferences Overview</a> for more information on modifying the user's preferences.<p> Then use <a class="el" href="group__kim__favorite__identities__reference.html#g122519ef11a212852a6045f3f1929fdb" title="Get the number of identities in a favorite identities list.">kim_favorite_identities_get_number_of_identities()</a> and <a class="el" href="group__kim__favorite__identities__reference.html#gac6ce0a4eaa521fe77b7ae0dbe5097b9" title="Get the Nth identity in a favorite identities list.">kim_favorite_identities_get_identity_at_index()</a> to display the identities list. Use <a class="el" href="group__kim__favorite__identities__reference.html#gb298ff23c6e8363d0d34b4c9fdb986e3" title="Add an identity to a favorite identities list.">kim_favorite_identities_add_identity()</a> and <a class="el" href="group__kim__favorite__identities__reference.html#g30b32603f1fa3c1fbb275682620c5d83" title="Remove an identity from a identities list.">kim_favorite_identities_remove_identity()</a> to change which identities are in the identities list. Identities are always stored in alphabetical order and duplicate identities are not permitted, so when you add or remove a identity you should redisplay the entire list.<p> Once you are done editing the identities list, store changes in the user's preference file using <a class="el" href="group__kim__preferences__reference.html#g2c0ee43f07affdeeec76624777e662d7" title="Set the user's preferred list of identities.">kim_preferences_set_favorite_identities()</a> and <a class="el" href="group__kim__preferences__reference.html#gd4548bdc2cd52ad21d7a3e1bb60edba0" title="Synchronize a preferences object with the user's preferences, writing pending...">kim_preferences_synchronize()</a>.<p> See <a class="el" href="group__kim__favorite__identities__reference.html">KIM Favorite Identities Documentation</a> for information on specific APIs. <hr size="1"><address style="text-align: right;"><small>Generated on Wed May 7 15:22:19 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>
Back to File Manager