← Back to branch summary

~ubuntu-branches/ubuntu/maverick/krb5/maverick

« back to all changes in this revision

Viewing changes to doc/kim/html/group__kim__options__reference.html

  • Committer: Bazaar Package Importer
  • Author(s): Sam Hartman
  • Date: 2009-05-07 16:16:34 UTC
  • mfrom: (13.1.7 sid)
  • Revision ID: james.westby@ubuntu.com-20090507161634-xqyk0s9na0le4flj
Tags: 1.7dfsg~beta1-4
http://bugs.debian.org/527353
When  decrypting the TGS response fails with the subkey, try with the
session key to work around Heimdal bug, Closes: #527353 

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/kim/html/group__kim__options__reference.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
 
3
<title>Kerberos Identity Management: KIM Options Reference Documentation</title>
 
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
 
5
<link href="tabs.css" rel="stylesheet" type="text/css">
 
6
</head><body>
 
7
<!-- Generated by Doxygen 1.5.3 -->
 
8
<h1>KIM Options Reference Documentation</h1>
 
9
<p>
 
10
<h2>Functions</h2>
 
11
<ul>
 
12
<li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__options__reference.html#ge36eb288b38f18491e4c903f008b1379">kim_options_create</a> (<a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> *out_options)
 
13
<dl class="el"><dd class="mdescRight">Create new options with default values.  <a href="#ge36eb288b38f18491e4c903f008b1379"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__options__reference.html#g17fc17a04097c42afab7a6b1a3f8d7fb">kim_options_copy</a> (<a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> *out_options, <a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> in_options)
 
14
<dl class="el"><dd class="mdescRight">Copy options.  <a href="#g17fc17a04097c42afab7a6b1a3f8d7fb"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__options__reference.html#gf7f6a8a82fedc547c8502ce09a419f91">kim_options_set_start_time</a> (<a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> io_options, <a class="el" href="group__kim__types__reference.html#g3da22452677b45753d40e07f3904dff5">kim_time</a> in_start_time)
 
15
<dl class="el"><dd class="mdescRight">Set the date when a credential should become valid.  <a href="#gf7f6a8a82fedc547c8502ce09a419f91"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__options__reference.html#gca63b972b41530c52bbe83bd974e6f9b">kim_options_get_start_time</a> (<a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> in_options, <a class="el" href="group__kim__types__reference.html#g3da22452677b45753d40e07f3904dff5">kim_time</a> *out_start_time)
 
16
<dl class="el"><dd class="mdescRight">Get the date when a credential should become valid.  <a href="#gca63b972b41530c52bbe83bd974e6f9b"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__options__reference.html#g392369e80bea0ea9c920d6de55e080ed">kim_options_set_lifetime</a> (<a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> io_options, <a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> in_lifetime)
 
17
<dl class="el"><dd class="mdescRight">Set the duration during which a credential should be valid.  <a href="#g392369e80bea0ea9c920d6de55e080ed"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__options__reference.html#gd7a886d6c0a33d0d872bf40420023ee2">kim_options_get_lifetime</a> (<a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> in_options, <a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> *out_lifetime)
 
18
<dl class="el"><dd class="mdescRight">Get the duration during which an acquired credential should be valid.  <a href="#gd7a886d6c0a33d0d872bf40420023ee2"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__options__reference.html#gcfa20d97d1643714a62b81077c1722ba">kim_options_set_renewable</a> (<a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> io_options, <a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> in_renewable)
 
19
<dl class="el"><dd class="mdescRight">Set whether or not to request a renewable credential.  <a href="#gcfa20d97d1643714a62b81077c1722ba"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__options__reference.html#g073245936d6086da6f1d3572872ecfe6">kim_options_get_renewable</a> (<a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> in_options, <a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> *out_renewable)
 
20
<dl class="el"><dd class="mdescRight">Get whether or not to request a renewable credential.  <a href="#g073245936d6086da6f1d3572872ecfe6"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__options__reference.html#g604ed101fa538a6f042fe612d74b5ed2">kim_options_set_renewal_lifetime</a> (<a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> io_options, <a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> in_renewal_lifetime)
 
21
<dl class="el"><dd class="mdescRight">Set the duration during which a valid credential should be renewable.  <a href="#g604ed101fa538a6f042fe612d74b5ed2"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__options__reference.html#g34bcb26ba38f691c6f5d48ec97a49392">kim_options_get_renewal_lifetime</a> (<a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> in_options, <a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> *out_renewal_lifetime)
 
22
<dl class="el"><dd class="mdescRight">Get the duration during which a valid credential should be renewable.  <a href="#g34bcb26ba38f691c6f5d48ec97a49392"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__options__reference.html#gc787d6b18febc22c86299d2668818513">kim_options_set_forwardable</a> (<a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> io_options, <a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> in_forwardable)
 
23
<dl class="el"><dd class="mdescRight">Set whether or not to request a forwardable credential.  <a href="#gc787d6b18febc22c86299d2668818513"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__options__reference.html#g649b9ded186ec13915196a6f8ded7565">kim_options_get_forwardable</a> (<a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> in_options, <a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> *out_forwardable)
 
24
<dl class="el"><dd class="mdescRight">Get whether or not to request a forwardable credential.  <a href="#g649b9ded186ec13915196a6f8ded7565"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__options__reference.html#g15ffe61f06334f4071e5b1ea6be62117">kim_options_set_proxiable</a> (<a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> io_options, <a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> in_proxiable)
 
25
<dl class="el"><dd class="mdescRight">Set whether or not to request a proxiable credential.  <a href="#g15ffe61f06334f4071e5b1ea6be62117"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__options__reference.html#g0193dda96349a6e8d98d6154540a364e">kim_options_get_proxiable</a> (<a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> in_options, <a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> *out_proxiable)
 
26
<dl class="el"><dd class="mdescRight">Get whether or not to request a proxiable credential.  <a href="#g0193dda96349a6e8d98d6154540a364e"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__options__reference.html#g4706fb2cc57109b8593f0b030218261a">kim_options_set_addressless</a> (<a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> io_options, <a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> in_addressless)
 
27
<dl class="el"><dd class="mdescRight">Set whether or not to request an addressless credential.  <a href="#g4706fb2cc57109b8593f0b030218261a"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__options__reference.html#g50495f13e53c49a11729904038e7cdf9">kim_options_get_addressless</a> (<a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> in_options, <a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> *out_addressless)
 
28
<dl class="el"><dd class="mdescRight">Get whether or not to request an addressless credential.  <a href="#g50495f13e53c49a11729904038e7cdf9"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__options__reference.html#g6e31c69a65efe32a5860125083d0b803">kim_options_set_service_name</a> (<a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> io_options, <a class="el" href="group__kim__types__reference.html#geea99aa292876e06003b7480087eecb0">kim_string</a> in_service_name)
 
29
<dl class="el"><dd class="mdescRight">Set the service name to request a credential for.  <a href="#g6e31c69a65efe32a5860125083d0b803"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__options__reference.html#gdf70addbc8221c252b1223b5e99dfa94">kim_options_get_service_name</a> (<a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> in_options, <a class="el" href="group__kim__types__reference.html#geea99aa292876e06003b7480087eecb0">kim_string</a> *out_service_name)
 
30
<dl class="el"><dd class="mdescRight">Get the service name to request a credential for.  <a href="#gdf70addbc8221c252b1223b5e99dfa94"></a><br></dl><li>void <a class="el" href="group__kim__options__reference.html#gd8de9ea0a4eb9e0ffb8e3056a3899f55">kim_options_free</a> (<a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> *io_options)
 
31
<dl class="el"><dd class="mdescRight">Free memory associated with an options object.  <a href="#gd8de9ea0a4eb9e0ffb8e3056a3899f55"></a><br></dl></ul>
 
32
<hr><h2>Function Documentation</h2>
 
33
<a class="anchor" name="ge36eb288b38f18491e4c903f008b1379"></a><!-- doxytag: member="kim_options.h::kim_options_create" ref="ge36eb288b38f18491e4c903f008b1379" args="(kim_options *out_options)" -->
 
34
<div class="memitem">
 
35
<div class="memproto">
 
36
      <table class="memname">
 
37
        <tr>
 
38
          <td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_options_create           </td>
 
39
          <td>(</td>
 
40
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> *&nbsp;</td>
 
41
          <td class="paramname"> <em>out_options</em>          </td>
 
42
          <td>&nbsp;)&nbsp;</td>
 
43
          <td width="100%"></td>
 
44
        </tr>
 
45
      </table>
 
46
</div>
 
47
<div class="memdoc">
 
48
 
 
49
<p>
 
50
Create new options with default values. 
 
51
<p>
 
52
<dl compact><dt><b>Parameters:</b></dt><dd>
 
53
  <table border="0" cellspacing="2" cellpadding="0">
 
54
    <tr><td valign="top"></td><td valign="top"><em>out_options</em>&nbsp;</td><td>on exit, a new options object. Must be freed with <a class="el" href="group__kim__options__reference.html#gd8de9ea0a4eb9e0ffb8e3056a3899f55" title="Free memory associated with an options object.">kim_options_free()</a>. </td></tr>
 
55
  </table>
 
56
</dl>
 
57
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl>
 
58
 
 
59
</div>
 
60
</div><p>
 
61
<a class="anchor" name="g17fc17a04097c42afab7a6b1a3f8d7fb"></a><!-- doxytag: member="kim_options.h::kim_options_copy" ref="g17fc17a04097c42afab7a6b1a3f8d7fb" args="(kim_options *out_options, kim_options in_options)" -->
 
62
<div class="memitem">
 
63
<div class="memproto">
 
64
      <table class="memname">
 
65
        <tr>
 
66
          <td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_options_copy           </td>
 
67
          <td>(</td>
 
68
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> *&nbsp;</td>
 
69
          <td class="paramname"> <em>out_options</em>, </td>
 
70
        </tr>
 
71
        <tr>
 
72
          <td class="paramkey"></td>
 
73
          <td></td>
 
74
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a>&nbsp;</td>
 
75
          <td class="paramname"> <em>in_options</em></td><td>&nbsp;</td>
 
76
        </tr>
 
77
        <tr>
 
78
          <td></td>
 
79
          <td>)</td>
 
80
          <td></td><td></td><td width="100%"></td>
 
81
        </tr>
 
82
      </table>
 
83
</div>
 
84
<div class="memdoc">
 
85
 
 
86
<p>
 
87
Copy options. 
 
88
<p>
 
89
<dl compact><dt><b>Parameters:</b></dt><dd>
 
90
  <table border="0" cellspacing="2" cellpadding="0">
 
91
    <tr><td valign="top"></td><td valign="top"><em>out_options</em>&nbsp;</td><td>on exit, a new options object which is a copy of <em>in_options</em>. Must be freed with <a class="el" href="group__kim__options__reference.html#gd8de9ea0a4eb9e0ffb8e3056a3899f55" title="Free memory associated with an options object.">kim_options_free()</a>. If passed KIM_OPTIONS_DEFAULT will set <em>out_options</em> to KIM_OPTIONS_DEFAULT. </td></tr>
 
92
    <tr><td valign="top"></td><td valign="top"><em>in_options</em>&nbsp;</td><td>a options object. </td></tr>
 
93
  </table>
 
94
</dl>
 
95
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl>
 
96
 
 
97
</div>
 
98
</div><p>
 
99
<a class="anchor" name="gf7f6a8a82fedc547c8502ce09a419f91"></a><!-- doxytag: member="kim_options.h::kim_options_set_start_time" ref="gf7f6a8a82fedc547c8502ce09a419f91" args="(kim_options io_options, kim_time in_start_time)" -->
 
100
<div class="memitem">
 
101
<div class="memproto">
 
102
      <table class="memname">
 
103
        <tr>
 
104
          <td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_options_set_start_time           </td>
 
105
          <td>(</td>
 
106
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a>&nbsp;</td>
 
107
          <td class="paramname"> <em>io_options</em>, </td>
 
108
        </tr>
 
109
        <tr>
 
110
          <td class="paramkey"></td>
 
111
          <td></td>
 
112
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g3da22452677b45753d40e07f3904dff5">kim_time</a>&nbsp;</td>
 
113
          <td class="paramname"> <em>in_start_time</em></td><td>&nbsp;</td>
 
114
        </tr>
 
115
        <tr>
 
116
          <td></td>
 
117
          <td>)</td>
 
118
          <td></td><td></td><td width="100%"></td>
 
119
        </tr>
 
120
      </table>
 
121
</div>
 
122
<div class="memdoc">
 
123
 
 
124
<p>
 
125
Set the date when a credential should become valid. 
 
126
<p>
 
127
<dl compact><dt><b>Parameters:</b></dt><dd>
 
128
  <table border="0" cellspacing="2" cellpadding="0">
 
129
    <tr><td valign="top"></td><td valign="top"><em>io_options</em>&nbsp;</td><td>an options object to modify. </td></tr>
 
130
    <tr><td valign="top"></td><td valign="top"><em>in_start_time</em>&nbsp;</td><td>a start date (in seconds since January 1, 1970). Set to <a class="el" href="group__kim__types__reference.html#g88d98fa3bd4ca00913bff414d65c3590">KIM_OPTIONS_START_IMMEDIATELY</a> for the acquired credential to be valid immediately. </td></tr>
 
131
  </table>
 
132
</dl>
 
133
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl>
 
134
<dl class="note" compact><dt><b>Note:</b></dt><dd>When using a start time in the future, once the start time has been reached the credential must be validated before it can be used. </dd></dl>
 
135
<dl class="user" compact><dt><b>Default value</b></dt><dd>0, indicating "now". The credential will be valid immediately. </dd></dl>
 
136
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#gca63b972b41530c52bbe83bd974e6f9b" title="Get the date when a credential should become valid.">kim_options_get_start_time()</a>, <a class="el" href="group__kim__credential__reference.html#g63a591ef509219ae83d11b635065984d" title="Validate a TGT credential.">kim_credential_validate()</a>, <a class="el" href="group__kim__ccache__reference.html#g73f5b201d24a58936244fc4e43cd3d59" title="Validate the TGT in a ccache.">kim_ccache_validate()</a>, kim_identity_validate() </dd></dl>
 
137
 
 
138
</div>
 
139
</div><p>
 
140
<a class="anchor" name="gca63b972b41530c52bbe83bd974e6f9b"></a><!-- doxytag: member="kim_options.h::kim_options_get_start_time" ref="gca63b972b41530c52bbe83bd974e6f9b" args="(kim_options in_options, kim_time *out_start_time)" -->
 
141
<div class="memitem">
 
142
<div class="memproto">
 
143
      <table class="memname">
 
144
        <tr>
 
145
          <td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_options_get_start_time           </td>
 
146
          <td>(</td>
 
147
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a>&nbsp;</td>
 
148
          <td class="paramname"> <em>in_options</em>, </td>
 
149
        </tr>
 
150
        <tr>
 
151
          <td class="paramkey"></td>
 
152
          <td></td>
 
153
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g3da22452677b45753d40e07f3904dff5">kim_time</a> *&nbsp;</td>
 
154
          <td class="paramname"> <em>out_start_time</em></td><td>&nbsp;</td>
 
155
        </tr>
 
156
        <tr>
 
157
          <td></td>
 
158
          <td>)</td>
 
159
          <td></td><td></td><td width="100%"></td>
 
160
        </tr>
 
161
      </table>
 
162
</div>
 
163
<div class="memdoc">
 
164
 
 
165
<p>
 
166
Get the date when a credential should become valid. 
 
167
<p>
 
168
<dl compact><dt><b>Parameters:</b></dt><dd>
 
169
  <table border="0" cellspacing="2" cellpadding="0">
 
170
    <tr><td valign="top"></td><td valign="top"><em>in_options</em>&nbsp;</td><td>an options object. </td></tr>
 
171
    <tr><td valign="top"></td><td valign="top"><em>out_start_time</em>&nbsp;</td><td>on exit, the start date (in seconds since January 1, 1970) specified by <em>in_options</em>. <a class="el" href="group__kim__types__reference.html#g88d98fa3bd4ca00913bff414d65c3590">KIM_OPTIONS_START_IMMEDIATELY</a> indicates the credential will be valid immediately. </td></tr>
 
172
  </table>
 
173
</dl>
 
174
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl>
 
175
<dl class="note" compact><dt><b>Note:</b></dt><dd>When using a start time in the future, once the start time has been reached the credential must be validated before it can be used. </dd></dl>
 
176
<dl class="user" compact><dt><b>Default value</b></dt><dd>0, indicating "now". The credential will be valid immediately. </dd></dl>
 
177
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#gf7f6a8a82fedc547c8502ce09a419f91" title="Set the date when a credential should become valid.">kim_options_set_start_time()</a>, <a class="el" href="group__kim__credential__reference.html#g63a591ef509219ae83d11b635065984d" title="Validate a TGT credential.">kim_credential_validate()</a>, <a class="el" href="group__kim__ccache__reference.html#g73f5b201d24a58936244fc4e43cd3d59" title="Validate the TGT in a ccache.">kim_ccache_validate()</a>, kim_identity_validate() </dd></dl>
 
178
 
 
179
</div>
 
180
</div><p>
 
181
<a class="anchor" name="g392369e80bea0ea9c920d6de55e080ed"></a><!-- doxytag: member="kim_options.h::kim_options_set_lifetime" ref="g392369e80bea0ea9c920d6de55e080ed" args="(kim_options io_options, kim_lifetime in_lifetime)" -->
 
182
<div class="memitem">
 
183
<div class="memproto">
 
184
      <table class="memname">
 
185
        <tr>
 
186
          <td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_options_set_lifetime           </td>
 
187
          <td>(</td>
 
188
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a>&nbsp;</td>
 
189
          <td class="paramname"> <em>io_options</em>, </td>
 
190
        </tr>
 
191
        <tr>
 
192
          <td class="paramkey"></td>
 
193
          <td></td>
 
194
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a>&nbsp;</td>
 
195
          <td class="paramname"> <em>in_lifetime</em></td><td>&nbsp;</td>
 
196
        </tr>
 
197
        <tr>
 
198
          <td></td>
 
199
          <td>)</td>
 
200
          <td></td><td></td><td width="100%"></td>
 
201
        </tr>
 
202
      </table>
 
203
</div>
 
204
<div class="memdoc">
 
205
 
 
206
<p>
 
207
Set the duration during which a credential should be valid. 
 
208
<p>
 
209
<dl compact><dt><b>Parameters:</b></dt><dd>
 
210
  <table border="0" cellspacing="2" cellpadding="0">
 
211
    <tr><td valign="top"></td><td valign="top"><em>io_options</em>&nbsp;</td><td>an options object to modify. </td></tr>
 
212
    <tr><td valign="top"></td><td valign="top"><em>in_lifetime</em>&nbsp;</td><td>a lifetime duration (in seconds). </td></tr>
 
213
  </table>
 
214
</dl>
 
215
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl>
 
216
<dl class="note" compact><dt><b>Note:</b></dt><dd>KDCs have a maximum allowed lifetime per identity (usually 10 to 21 hours). As a result the credential will actually have a lifetime which is the minimum of <em>in_lifetime</em> and the KDC's maximum allowed lifetime. </dd></dl>
 
217
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#gd7a886d6c0a33d0d872bf40420023ee2" title="Get the duration during which an acquired credential should be valid.">kim_options_get_lifetime()</a> </dd></dl>
 
218
<dl class="user" compact><dt><b>Default value</b></dt><dd>Read from the user's preferences and the Kerberos configuration. 10 hours if unspecified. </dd></dl>
 
219
 
 
220
</div>
 
221
</div><p>
 
222
<a class="anchor" name="gd7a886d6c0a33d0d872bf40420023ee2"></a><!-- doxytag: member="kim_options.h::kim_options_get_lifetime" ref="gd7a886d6c0a33d0d872bf40420023ee2" args="(kim_options in_options, kim_lifetime *out_lifetime)" -->
 
223
<div class="memitem">
 
224
<div class="memproto">
 
225
      <table class="memname">
 
226
        <tr>
 
227
          <td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_options_get_lifetime           </td>
 
228
          <td>(</td>
 
229
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a>&nbsp;</td>
 
230
          <td class="paramname"> <em>in_options</em>, </td>
 
231
        </tr>
 
232
        <tr>
 
233
          <td class="paramkey"></td>
 
234
          <td></td>
 
235
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> *&nbsp;</td>
 
236
          <td class="paramname"> <em>out_lifetime</em></td><td>&nbsp;</td>
 
237
        </tr>
 
238
        <tr>
 
239
          <td></td>
 
240
          <td>)</td>
 
241
          <td></td><td></td><td width="100%"></td>
 
242
        </tr>
 
243
      </table>
 
244
</div>
 
245
<div class="memdoc">
 
246
 
 
247
<p>
 
248
Get the duration during which an acquired credential should be valid. 
 
249
<p>
 
250
<dl compact><dt><b>Parameters:</b></dt><dd>
 
251
  <table border="0" cellspacing="2" cellpadding="0">
 
252
    <tr><td valign="top"></td><td valign="top"><em>in_options</em>&nbsp;</td><td>an options object. </td></tr>
 
253
    <tr><td valign="top"></td><td valign="top"><em>out_lifetime</em>&nbsp;</td><td>on exit, the lifetime duration (in seconds) specified in <em>in_options</em>. </td></tr>
 
254
  </table>
 
255
</dl>
 
256
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl>
 
257
<dl class="note" compact><dt><b>Note:</b></dt><dd>KDCs have a maximum allowed lifetime per identity (usually 10 to 21 hours). As a result the credential will actually have a lifetime which is the minimum of <em>in_lifetime</em> and the KDC's maximum allowed lifetime. </dd></dl>
 
258
<dl class="user" compact><dt><b>Default value</b></dt><dd>Read from the user's preferences and the Kerberos configuration. 10 hours if unspecified. </dd></dl>
 
259
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g392369e80bea0ea9c920d6de55e080ed" title="Set the duration during which a credential should be valid.">kim_options_set_lifetime()</a> </dd></dl>
 
260
 
 
261
</div>
 
262
</div><p>
 
263
<a class="anchor" name="gcfa20d97d1643714a62b81077c1722ba"></a><!-- doxytag: member="kim_options.h::kim_options_set_renewable" ref="gcfa20d97d1643714a62b81077c1722ba" args="(kim_options io_options, kim_boolean in_renewable)" -->
 
264
<div class="memitem">
 
265
<div class="memproto">
 
266
      <table class="memname">
 
267
        <tr>
 
268
          <td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_options_set_renewable           </td>
 
269
          <td>(</td>
 
270
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a>&nbsp;</td>
 
271
          <td class="paramname"> <em>io_options</em>, </td>
 
272
        </tr>
 
273
        <tr>
 
274
          <td class="paramkey"></td>
 
275
          <td></td>
 
276
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a>&nbsp;</td>
 
277
          <td class="paramname"> <em>in_renewable</em></td><td>&nbsp;</td>
 
278
        </tr>
 
279
        <tr>
 
280
          <td></td>
 
281
          <td>)</td>
 
282
          <td></td><td></td><td width="100%"></td>
 
283
        </tr>
 
284
      </table>
 
285
</div>
 
286
<div class="memdoc">
 
287
 
 
288
<p>
 
289
Set whether or not to request a renewable credential. 
 
290
<p>
 
291
<dl compact><dt><b>Parameters:</b></dt><dd>
 
292
  <table border="0" cellspacing="2" cellpadding="0">
 
293
    <tr><td valign="top"></td><td valign="top"><em>io_options</em>&nbsp;</td><td>an options object to modify. </td></tr>
 
294
    <tr><td valign="top"></td><td valign="top"><em>in_renewable</em>&nbsp;</td><td>a boolean value indicating whether or not to request a renewable credential. </td></tr>
 
295
  </table>
 
296
</dl>
 
297
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl>
 
298
<dl class="user" compact><dt><b>Default value</b></dt><dd>Read from the user's preferences and the Kerberos configuration. TRUE if unspecified. </dd></dl>
 
299
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g073245936d6086da6f1d3572872ecfe6" title="Get whether or not to request a renewable credential.">kim_options_get_renewable()</a> </dd></dl>
 
300
 
 
301
</div>
 
302
</div><p>
 
303
<a class="anchor" name="g073245936d6086da6f1d3572872ecfe6"></a><!-- doxytag: member="kim_options.h::kim_options_get_renewable" ref="g073245936d6086da6f1d3572872ecfe6" args="(kim_options in_options, kim_boolean *out_renewable)" -->
 
304
<div class="memitem">
 
305
<div class="memproto">
 
306
      <table class="memname">
 
307
        <tr>
 
308
          <td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_options_get_renewable           </td>
 
309
          <td>(</td>
 
310
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a>&nbsp;</td>
 
311
          <td class="paramname"> <em>in_options</em>, </td>
 
312
        </tr>
 
313
        <tr>
 
314
          <td class="paramkey"></td>
 
315
          <td></td>
 
316
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> *&nbsp;</td>
 
317
          <td class="paramname"> <em>out_renewable</em></td><td>&nbsp;</td>
 
318
        </tr>
 
319
        <tr>
 
320
          <td></td>
 
321
          <td>)</td>
 
322
          <td></td><td></td><td width="100%"></td>
 
323
        </tr>
 
324
      </table>
 
325
</div>
 
326
<div class="memdoc">
 
327
 
 
328
<p>
 
329
Get whether or not to request a renewable credential. 
 
330
<p>
 
331
<dl compact><dt><b>Parameters:</b></dt><dd>
 
332
  <table border="0" cellspacing="2" cellpadding="0">
 
333
    <tr><td valign="top"></td><td valign="top"><em>in_options</em>&nbsp;</td><td>an options object. </td></tr>
 
334
    <tr><td valign="top"></td><td valign="top"><em>out_renewable</em>&nbsp;</td><td>on exit, a boolean value indicating whether or <em>in_options</em> will request a renewable credential. </td></tr>
 
335
  </table>
 
336
</dl>
 
337
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl>
 
338
<dl class="user" compact><dt><b>Default value</b></dt><dd>Read from the user's preferences and the Kerberos configuration. TRUE if unspecified. </dd></dl>
 
339
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#gcfa20d97d1643714a62b81077c1722ba" title="Set whether or not to request a renewable credential.">kim_options_set_renewable()</a> </dd></dl>
 
340
 
 
341
</div>
 
342
</div><p>
 
343
<a class="anchor" name="g604ed101fa538a6f042fe612d74b5ed2"></a><!-- doxytag: member="kim_options.h::kim_options_set_renewal_lifetime" ref="g604ed101fa538a6f042fe612d74b5ed2" args="(kim_options io_options, kim_lifetime in_renewal_lifetime)" -->
 
344
<div class="memitem">
 
345
<div class="memproto">
 
346
      <table class="memname">
 
347
        <tr>
 
348
          <td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_options_set_renewal_lifetime           </td>
 
349
          <td>(</td>
 
350
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a>&nbsp;</td>
 
351
          <td class="paramname"> <em>io_options</em>, </td>
 
352
        </tr>
 
353
        <tr>
 
354
          <td class="paramkey"></td>
 
355
          <td></td>
 
356
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a>&nbsp;</td>
 
357
          <td class="paramname"> <em>in_renewal_lifetime</em></td><td>&nbsp;</td>
 
358
        </tr>
 
359
        <tr>
 
360
          <td></td>
 
361
          <td>)</td>
 
362
          <td></td><td></td><td width="100%"></td>
 
363
        </tr>
 
364
      </table>
 
365
</div>
 
366
<div class="memdoc">
 
367
 
 
368
<p>
 
369
Set the duration during which a valid credential should be renewable. 
 
370
<p>
 
371
<dl compact><dt><b>Parameters:</b></dt><dd>
 
372
  <table border="0" cellspacing="2" cellpadding="0">
 
373
    <tr><td valign="top"></td><td valign="top"><em>io_options</em>&nbsp;</td><td>an options object to modify. </td></tr>
 
374
    <tr><td valign="top"></td><td valign="top"><em>in_renewal_lifetime</em>&nbsp;</td><td>a renewal lifetime duration (in seconds). </td></tr>
 
375
  </table>
 
376
</dl>
 
377
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl>
 
378
<dl class="note" compact><dt><b>Note:</b></dt><dd>KDCs have a maximum allowed renewal lifetime per identity (usually 10 to 21 hours). As a result the credential will actually have a lifetime which is the minimum of <em>in_lifetime</em> and the KDC's maximum allowed lifetime. </dd></dl>
 
379
<dl class="user" compact><dt><b>Default value</b></dt><dd>Read from the user's preferences and the Kerberos configuration. 7 days if unspecified. </dd></dl>
 
380
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g34bcb26ba38f691c6f5d48ec97a49392" title="Get the duration during which a valid credential should be renewable.">kim_options_get_renewal_lifetime()</a>, kim_identity_renew(), <a class="el" href="group__kim__credential__reference.html#g18f43112f7ae046b2a5918b061a2072d" title="Renew a TGT credential.">kim_credential_renew()</a>, <a class="el" href="group__kim__ccache__reference.html#g574a0ef674116589dcf57460af81de39" title="Renew the TGT in a ccache.">kim_ccache_renew()</a> </dd></dl>
 
381
 
 
382
</div>
 
383
</div><p>
 
384
<a class="anchor" name="g34bcb26ba38f691c6f5d48ec97a49392"></a><!-- doxytag: member="kim_options.h::kim_options_get_renewal_lifetime" ref="g34bcb26ba38f691c6f5d48ec97a49392" args="(kim_options in_options, kim_lifetime *out_renewal_lifetime)" -->
 
385
<div class="memitem">
 
386
<div class="memproto">
 
387
      <table class="memname">
 
388
        <tr>
 
389
          <td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_options_get_renewal_lifetime           </td>
 
390
          <td>(</td>
 
391
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a>&nbsp;</td>
 
392
          <td class="paramname"> <em>in_options</em>, </td>
 
393
        </tr>
 
394
        <tr>
 
395
          <td class="paramkey"></td>
 
396
          <td></td>
 
397
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> *&nbsp;</td>
 
398
          <td class="paramname"> <em>out_renewal_lifetime</em></td><td>&nbsp;</td>
 
399
        </tr>
 
400
        <tr>
 
401
          <td></td>
 
402
          <td>)</td>
 
403
          <td></td><td></td><td width="100%"></td>
 
404
        </tr>
 
405
      </table>
 
406
</div>
 
407
<div class="memdoc">
 
408
 
 
409
<p>
 
410
Get the duration during which a valid credential should be renewable. 
 
411
<p>
 
412
<dl compact><dt><b>Parameters:</b></dt><dd>
 
413
  <table border="0" cellspacing="2" cellpadding="0">
 
414
    <tr><td valign="top"></td><td valign="top"><em>in_options</em>&nbsp;</td><td>an options object. </td></tr>
 
415
    <tr><td valign="top"></td><td valign="top"><em>out_renewal_lifetime</em>&nbsp;</td><td>on exit, the renewal lifetime duration (in seconds) specified in <em>in_options</em>. </td></tr>
 
416
  </table>
 
417
</dl>
 
418
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl>
 
419
<dl class="note" compact><dt><b>Note:</b></dt><dd>KDCs have a maximum allowed lifetime per identity (usually 10 to 21 hours). As a result the credential will actually have a lifetime which is the minimum of <em>in_lifetime</em> and the KDC's maximum allowed lifetime. </dd></dl>
 
420
<dl class="user" compact><dt><b>Default value</b></dt><dd>Read from the user's preferences and the Kerberos configuration. 7 days if unspecified. </dd></dl>
 
421
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g604ed101fa538a6f042fe612d74b5ed2" title="Set the duration during which a valid credential should be renewable.">kim_options_set_renewal_lifetime()</a>, kim_identity_renew(), <a class="el" href="group__kim__credential__reference.html#g18f43112f7ae046b2a5918b061a2072d" title="Renew a TGT credential.">kim_credential_renew()</a>, <a class="el" href="group__kim__ccache__reference.html#g574a0ef674116589dcf57460af81de39" title="Renew the TGT in a ccache.">kim_ccache_renew()</a> </dd></dl>
 
422
 
 
423
</div>
 
424
</div><p>
 
425
<a class="anchor" name="gc787d6b18febc22c86299d2668818513"></a><!-- doxytag: member="kim_options.h::kim_options_set_forwardable" ref="gc787d6b18febc22c86299d2668818513" args="(kim_options io_options, kim_boolean in_forwardable)" -->
 
426
<div class="memitem">
 
427
<div class="memproto">
 
428
      <table class="memname">
 
429
        <tr>
 
430
          <td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_options_set_forwardable           </td>
 
431
          <td>(</td>
 
432
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a>&nbsp;</td>
 
433
          <td class="paramname"> <em>io_options</em>, </td>
 
434
        </tr>
 
435
        <tr>
 
436
          <td class="paramkey"></td>
 
437
          <td></td>
 
438
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a>&nbsp;</td>
 
439
          <td class="paramname"> <em>in_forwardable</em></td><td>&nbsp;</td>
 
440
        </tr>
 
441
        <tr>
 
442
          <td></td>
 
443
          <td>)</td>
 
444
          <td></td><td></td><td width="100%"></td>
 
445
        </tr>
 
446
      </table>
 
447
</div>
 
448
<div class="memdoc">
 
449
 
 
450
<p>
 
451
Set whether or not to request a forwardable credential. 
 
452
<p>
 
453
<dl compact><dt><b>Parameters:</b></dt><dd>
 
454
  <table border="0" cellspacing="2" cellpadding="0">
 
455
    <tr><td valign="top"></td><td valign="top"><em>io_options</em>&nbsp;</td><td>an options object to modify. </td></tr>
 
456
    <tr><td valign="top"></td><td valign="top"><em>in_forwardable</em>&nbsp;</td><td>a boolean value indicating whether or not to request a forwardable credential. </td></tr>
 
457
  </table>
 
458
</dl>
 
459
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl>
 
460
<dl class="user" compact><dt><b>Default value</b></dt><dd>Read from the user's preferences and the Kerberos configuration. TRUE if unspecified. </dd></dl>
 
461
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g649b9ded186ec13915196a6f8ded7565" title="Get whether or not to request a forwardable credential.">kim_options_get_forwardable()</a> </dd></dl>
 
462
 
 
463
</div>
 
464
</div><p>
 
465
<a class="anchor" name="g649b9ded186ec13915196a6f8ded7565"></a><!-- doxytag: member="kim_options.h::kim_options_get_forwardable" ref="g649b9ded186ec13915196a6f8ded7565" args="(kim_options in_options, kim_boolean *out_forwardable)" -->
 
466
<div class="memitem">
 
467
<div class="memproto">
 
468
      <table class="memname">
 
469
        <tr>
 
470
          <td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_options_get_forwardable           </td>
 
471
          <td>(</td>
 
472
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a>&nbsp;</td>
 
473
          <td class="paramname"> <em>in_options</em>, </td>
 
474
        </tr>
 
475
        <tr>
 
476
          <td class="paramkey"></td>
 
477
          <td></td>
 
478
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> *&nbsp;</td>
 
479
          <td class="paramname"> <em>out_forwardable</em></td><td>&nbsp;</td>
 
480
        </tr>
 
481
        <tr>
 
482
          <td></td>
 
483
          <td>)</td>
 
484
          <td></td><td></td><td width="100%"></td>
 
485
        </tr>
 
486
      </table>
 
487
</div>
 
488
<div class="memdoc">
 
489
 
 
490
<p>
 
491
Get whether or not to request a forwardable credential. 
 
492
<p>
 
493
<dl compact><dt><b>Parameters:</b></dt><dd>
 
494
  <table border="0" cellspacing="2" cellpadding="0">
 
495
    <tr><td valign="top"></td><td valign="top"><em>in_options</em>&nbsp;</td><td>an options object. </td></tr>
 
496
    <tr><td valign="top"></td><td valign="top"><em>out_forwardable</em>&nbsp;</td><td>on exit, a boolean value indicating whether or <em>in_options</em> will request a forwardable credential. </td></tr>
 
497
  </table>
 
498
</dl>
 
499
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl>
 
500
<dl class="user" compact><dt><b>Default value</b></dt><dd>Read from the user's preferences and the Kerberos configuration. TRUE if unspecified. </dd></dl>
 
501
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#gc787d6b18febc22c86299d2668818513" title="Set whether or not to request a forwardable credential.">kim_options_set_forwardable()</a> </dd></dl>
 
502
 
 
503
</div>
 
504
</div><p>
 
505
<a class="anchor" name="g15ffe61f06334f4071e5b1ea6be62117"></a><!-- doxytag: member="kim_options.h::kim_options_set_proxiable" ref="g15ffe61f06334f4071e5b1ea6be62117" args="(kim_options io_options, kim_boolean in_proxiable)" -->
 
506
<div class="memitem">
 
507
<div class="memproto">
 
508
      <table class="memname">
 
509
        <tr>
 
510
          <td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_options_set_proxiable           </td>
 
511
          <td>(</td>
 
512
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a>&nbsp;</td>
 
513
          <td class="paramname"> <em>io_options</em>, </td>
 
514
        </tr>
 
515
        <tr>
 
516
          <td class="paramkey"></td>
 
517
          <td></td>
 
518
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a>&nbsp;</td>
 
519
          <td class="paramname"> <em>in_proxiable</em></td><td>&nbsp;</td>
 
520
        </tr>
 
521
        <tr>
 
522
          <td></td>
 
523
          <td>)</td>
 
524
          <td></td><td></td><td width="100%"></td>
 
525
        </tr>
 
526
      </table>
 
527
</div>
 
528
<div class="memdoc">
 
529
 
 
530
<p>
 
531
Set whether or not to request a proxiable credential. 
 
532
<p>
 
533
<dl compact><dt><b>Parameters:</b></dt><dd>
 
534
  <table border="0" cellspacing="2" cellpadding="0">
 
535
    <tr><td valign="top"></td><td valign="top"><em>io_options</em>&nbsp;</td><td>an options object to modify. </td></tr>
 
536
    <tr><td valign="top"></td><td valign="top"><em>in_proxiable</em>&nbsp;</td><td>a boolean value indicating whether or not to request a proxiable credential. </td></tr>
 
537
  </table>
 
538
</dl>
 
539
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl>
 
540
<dl class="user" compact><dt><b>Default value</b></dt><dd>Read from the user's preferences and the Kerberos configuration. TRUE if unspecified. </dd></dl>
 
541
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g0193dda96349a6e8d98d6154540a364e" title="Get whether or not to request a proxiable credential.">kim_options_get_proxiable()</a> </dd></dl>
 
542
 
 
543
</div>
 
544
</div><p>
 
545
<a class="anchor" name="g0193dda96349a6e8d98d6154540a364e"></a><!-- doxytag: member="kim_options.h::kim_options_get_proxiable" ref="g0193dda96349a6e8d98d6154540a364e" args="(kim_options in_options, kim_boolean *out_proxiable)" -->
 
546
<div class="memitem">
 
547
<div class="memproto">
 
548
      <table class="memname">
 
549
        <tr>
 
550
          <td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_options_get_proxiable           </td>
 
551
          <td>(</td>
 
552
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a>&nbsp;</td>
 
553
          <td class="paramname"> <em>in_options</em>, </td>
 
554
        </tr>
 
555
        <tr>
 
556
          <td class="paramkey"></td>
 
557
          <td></td>
 
558
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> *&nbsp;</td>
 
559
          <td class="paramname"> <em>out_proxiable</em></td><td>&nbsp;</td>
 
560
        </tr>
 
561
        <tr>
 
562
          <td></td>
 
563
          <td>)</td>
 
564
          <td></td><td></td><td width="100%"></td>
 
565
        </tr>
 
566
      </table>
 
567
</div>
 
568
<div class="memdoc">
 
569
 
 
570
<p>
 
571
Get whether or not to request a proxiable credential. 
 
572
<p>
 
573
<dl compact><dt><b>Parameters:</b></dt><dd>
 
574
  <table border="0" cellspacing="2" cellpadding="0">
 
575
    <tr><td valign="top"></td><td valign="top"><em>in_options</em>&nbsp;</td><td>an options object. </td></tr>
 
576
    <tr><td valign="top"></td><td valign="top"><em>out_proxiable</em>&nbsp;</td><td>on exit, a boolean value indicating whether or <em>in_options</em> will request a proxiable credential. </td></tr>
 
577
  </table>
 
578
</dl>
 
579
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl>
 
580
<dl class="user" compact><dt><b>Default value</b></dt><dd>Read from the user's preferences and the Kerberos configuration. TRUE if unspecified. </dd></dl>
 
581
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g15ffe61f06334f4071e5b1ea6be62117" title="Set whether or not to request a proxiable credential.">kim_options_set_proxiable()</a> </dd></dl>
 
582
 
 
583
</div>
 
584
</div><p>
 
585
<a class="anchor" name="g4706fb2cc57109b8593f0b030218261a"></a><!-- doxytag: member="kim_options.h::kim_options_set_addressless" ref="g4706fb2cc57109b8593f0b030218261a" args="(kim_options io_options, kim_boolean in_addressless)" -->
 
586
<div class="memitem">
 
587
<div class="memproto">
 
588
      <table class="memname">
 
589
        <tr>
 
590
          <td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_options_set_addressless           </td>
 
591
          <td>(</td>
 
592
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a>&nbsp;</td>
 
593
          <td class="paramname"> <em>io_options</em>, </td>
 
594
        </tr>
 
595
        <tr>
 
596
          <td class="paramkey"></td>
 
597
          <td></td>
 
598
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a>&nbsp;</td>
 
599
          <td class="paramname"> <em>in_addressless</em></td><td>&nbsp;</td>
 
600
        </tr>
 
601
        <tr>
 
602
          <td></td>
 
603
          <td>)</td>
 
604
          <td></td><td></td><td width="100%"></td>
 
605
        </tr>
 
606
      </table>
 
607
</div>
 
608
<div class="memdoc">
 
609
 
 
610
<p>
 
611
Set whether or not to request an addressless credential. 
 
612
<p>
 
613
<dl compact><dt><b>Parameters:</b></dt><dd>
 
614
  <table border="0" cellspacing="2" cellpadding="0">
 
615
    <tr><td valign="top"></td><td valign="top"><em>io_options</em>&nbsp;</td><td>an options object to modify. </td></tr>
 
616
    <tr><td valign="top"></td><td valign="top"><em>in_addressless</em>&nbsp;</td><td>a boolean value indicating whether or not to request an addressless credential. </td></tr>
 
617
  </table>
 
618
</dl>
 
619
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl>
 
620
<dl class="user" compact><dt><b>Default value</b></dt><dd>Read from the user's preferences and the Kerberos configuration. TRUE if unspecified. </dd></dl>
 
621
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g50495f13e53c49a11729904038e7cdf9" title="Get whether or not to request an addressless credential.">kim_options_get_addressless()</a> </dd></dl>
 
622
 
 
623
</div>
 
624
</div><p>
 
625
<a class="anchor" name="g50495f13e53c49a11729904038e7cdf9"></a><!-- doxytag: member="kim_options.h::kim_options_get_addressless" ref="g50495f13e53c49a11729904038e7cdf9" args="(kim_options in_options, kim_boolean *out_addressless)" -->
 
626
<div class="memitem">
 
627
<div class="memproto">
 
628
      <table class="memname">
 
629
        <tr>
 
630
          <td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_options_get_addressless           </td>
 
631
          <td>(</td>
 
632
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a>&nbsp;</td>
 
633
          <td class="paramname"> <em>in_options</em>, </td>
 
634
        </tr>
 
635
        <tr>
 
636
          <td class="paramkey"></td>
 
637
          <td></td>
 
638
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> *&nbsp;</td>
 
639
          <td class="paramname"> <em>out_addressless</em></td><td>&nbsp;</td>
 
640
        </tr>
 
641
        <tr>
 
642
          <td></td>
 
643
          <td>)</td>
 
644
          <td></td><td></td><td width="100%"></td>
 
645
        </tr>
 
646
      </table>
 
647
</div>
 
648
<div class="memdoc">
 
649
 
 
650
<p>
 
651
Get whether or not to request an addressless credential. 
 
652
<p>
 
653
<dl compact><dt><b>Parameters:</b></dt><dd>
 
654
  <table border="0" cellspacing="2" cellpadding="0">
 
655
    <tr><td valign="top"></td><td valign="top"><em>in_options</em>&nbsp;</td><td>an options object. </td></tr>
 
656
    <tr><td valign="top"></td><td valign="top"><em>out_addressless</em>&nbsp;</td><td>on exit, a boolean value indicating whether or <em>in_options</em> will request an addressless credential. </td></tr>
 
657
  </table>
 
658
</dl>
 
659
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl>
 
660
<dl class="user" compact><dt><b>Default value</b></dt><dd>Read from the user's preferences and the Kerberos configuration. TRUE if unspecified. </dd></dl>
 
661
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g4706fb2cc57109b8593f0b030218261a" title="Set whether or not to request an addressless credential.">kim_options_set_addressless()</a> </dd></dl>
 
662
 
 
663
</div>
 
664
</div><p>
 
665
<a class="anchor" name="g6e31c69a65efe32a5860125083d0b803"></a><!-- doxytag: member="kim_options.h::kim_options_set_service_name" ref="g6e31c69a65efe32a5860125083d0b803" args="(kim_options io_options, kim_string in_service_name)" -->
 
666
<div class="memitem">
 
667
<div class="memproto">
 
668
      <table class="memname">
 
669
        <tr>
 
670
          <td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_options_set_service_name           </td>
 
671
          <td>(</td>
 
672
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a>&nbsp;</td>
 
673
          <td class="paramname"> <em>io_options</em>, </td>
 
674
        </tr>
 
675
        <tr>
 
676
          <td class="paramkey"></td>
 
677
          <td></td>
 
678
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#geea99aa292876e06003b7480087eecb0">kim_string</a>&nbsp;</td>
 
679
          <td class="paramname"> <em>in_service_name</em></td><td>&nbsp;</td>
 
680
        </tr>
 
681
        <tr>
 
682
          <td></td>
 
683
          <td>)</td>
 
684
          <td></td><td></td><td width="100%"></td>
 
685
        </tr>
 
686
      </table>
 
687
</div>
 
688
<div class="memdoc">
 
689
 
 
690
<p>
 
691
Set the service name to request a credential for. 
 
692
<p>
 
693
<dl compact><dt><b>Parameters:</b></dt><dd>
 
694
  <table border="0" cellspacing="2" cellpadding="0">
 
695
    <tr><td valign="top"></td><td valign="top"><em>io_options</em>&nbsp;</td><td>an options object to modify. </td></tr>
 
696
    <tr><td valign="top"></td><td valign="top"><em>in_service_name</em>&nbsp;</td><td>a service name. </td></tr>
 
697
  </table>
 
698
</dl>
 
699
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl>
 
700
<dl class="user" compact><dt><b>Default value</b></dt><dd>NULL, indicating "krbtgt@&lt;REALM&gt;", the ticket granting ticket (TGT) service. </dd></dl>
 
701
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#gdf70addbc8221c252b1223b5e99dfa94" title="Get the service name to request a credential for.">kim_options_get_service_name()</a> </dd></dl>
 
702
 
 
703
</div>
 
704
</div><p>
 
705
<a class="anchor" name="gdf70addbc8221c252b1223b5e99dfa94"></a><!-- doxytag: member="kim_options.h::kim_options_get_service_name" ref="gdf70addbc8221c252b1223b5e99dfa94" args="(kim_options in_options, kim_string *out_service_name)" -->
 
706
<div class="memitem">
 
707
<div class="memproto">
 
708
      <table class="memname">
 
709
        <tr>
 
710
          <td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_options_get_service_name           </td>
 
711
          <td>(</td>
 
712
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a>&nbsp;</td>
 
713
          <td class="paramname"> <em>in_options</em>, </td>
 
714
        </tr>
 
715
        <tr>
 
716
          <td class="paramkey"></td>
 
717
          <td></td>
 
718
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#geea99aa292876e06003b7480087eecb0">kim_string</a> *&nbsp;</td>
 
719
          <td class="paramname"> <em>out_service_name</em></td><td>&nbsp;</td>
 
720
        </tr>
 
721
        <tr>
 
722
          <td></td>
 
723
          <td>)</td>
 
724
          <td></td><td></td><td width="100%"></td>
 
725
        </tr>
 
726
      </table>
 
727
</div>
 
728
<div class="memdoc">
 
729
 
 
730
<p>
 
731
Get the service name to request a credential for. 
 
732
<p>
 
733
<dl compact><dt><b>Parameters:</b></dt><dd>
 
734
  <table border="0" cellspacing="2" cellpadding="0">
 
735
    <tr><td valign="top"></td><td valign="top"><em>in_options</em>&nbsp;</td><td>an options object. </td></tr>
 
736
    <tr><td valign="top"></td><td valign="top"><em>out_service_name</em>&nbsp;</td><td>on exit, the service name specified in <em>in_options</em>. Must be freed with <a class="el" href="group__kim__string__reference.html#g7e7207329022e97473ec71574e52a1fc" title="Free memory associated with a string.">kim_string_free()</a>. </td></tr>
 
737
  </table>
 
738
</dl>
 
739
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl>
 
740
<dl class="user" compact><dt><b>Default value</b></dt><dd>NULL, indicating "krbtgt@&lt;REALM&gt;", the ticket granting ticket (TGT) service. </dd></dl>
 
741
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g6e31c69a65efe32a5860125083d0b803" title="Set the service name to request a credential for.">kim_options_set_service_name()</a> </dd></dl>
 
742
 
 
743
</div>
 
744
</div><p>
 
745
<a class="anchor" name="gd8de9ea0a4eb9e0ffb8e3056a3899f55"></a><!-- doxytag: member="kim_options.h::kim_options_free" ref="gd8de9ea0a4eb9e0ffb8e3056a3899f55" args="(kim_options *io_options)" -->
 
746
<div class="memitem">
 
747
<div class="memproto">
 
748
      <table class="memname">
 
749
        <tr>
 
750
          <td class="memname">void kim_options_free           </td>
 
751
          <td>(</td>
 
752
          <td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> *&nbsp;</td>
 
753
          <td class="paramname"> <em>io_options</em>          </td>
 
754
          <td>&nbsp;)&nbsp;</td>
 
755
          <td width="100%"></td>
 
756
        </tr>
 
757
      </table>
 
758
</div>
 
759
<div class="memdoc">
 
760
 
 
761
<p>
 
762
Free memory associated with an options object. 
 
763
<p>
 
764
<dl compact><dt><b>Parameters:</b></dt><dd>
 
765
  <table border="0" cellspacing="2" cellpadding="0">
 
766
    <tr><td valign="top"></td><td valign="top"><em>io_options</em>&nbsp;</td><td>the options object to be freed. Set to NULL on exit. </td></tr>
 
767
  </table>
 
768
</dl>
 
769
 
 
770
</div>
 
771
</div><p>
 
772
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Nov 3 17:45:44 2008 for Kerberos Identity Management by&nbsp;
 
773
<a href="http://www.doxygen.org/index.html">
 
774
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
 
775
</body>
 
776
</html>