1 .\" Copyright (c) 2003 Kungliga Tekniska Högskolan
2 .\" (Royal Institute of Technology, Stockholm, Sweden).
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\" notice, this list of conditions and the following disclaimer in the
14 .\" documentation and/or other materials provided with the distribution.
16 .\" 3. Neither the name of the Institute nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" $Id: krb5_ccache.3,v 1.7 2003/04/16 13:58:12 lha Exp $
44 .Nm krb5_cc_copy_cache ,
46 .Nm krb5_cc_default_name ,
48 .Nm krb5_cc_end_seq_get ,
50 .Nm krb5_cc_get_name ,
51 .Nm krb5_cc_get_principal ,
52 .Nm krb5_cc_get_type ,
54 .Nm krb5_cc_get_version ,
55 .Nm krb5_cc_initialize ,
56 .Nm krb5_cc_register ,
58 .Nm krb5_cc_retrieve_cred ,
59 .Nm krb5_cc_remove_cred ,
60 .Nm krb5_cc_set_default_name ,
61 .Nm krb5_cc_store_cred ,
62 .Nm krb5_cc_set_flags ,
64 .Nd mange credential cache.
66 Kerberos 5 Library (libkrb5, -lkrb5)
70 .Li "struct krb5_ccache;"
72 .Li "struct krb5_cc_cursor;"
74 .Li "struct krb5_cc_ops;"
76 .Li "struct krb5_cc_ops *krb5_fcc_ops;"
78 .Li "struct krb5_cc_ops *krb5_mcc_ops;"
82 .Fa "krb5_context *context"
86 .Fo krb5_cc_copy_cache
87 .Fa "krb5_context *context"
88 .Fa "const krb5_ccache from"
93 .Fa "krb5_context *context"
97 .Fo krb5_cc_default_name
98 .Fa "krb5_context *context"
102 .Fa "krb5_context *context"
106 .Fo krb5_cc_end_seq_get
107 .Fa "krb5_context *context"
108 .Fa "const krb5_ccache id"
109 .Fa "krb5_cc_cursor *cursor"
113 .Fa "krb5_context *context"
114 .Fa "const krb5_cc_ops *ops"
115 .Fa "krb5_ccache *id"
119 .Fa "krb5_context *context"
123 .Fo krb5_cc_get_principal
124 .Fa "krb5_context *context"
126 .Fa "krb5_principal *principal"
130 .Fa "krb5_context *context"
133 .Ft "const krb5_cc_ops *"
135 .Fa "krb5_context *context"
139 .Fo krb5_cc_get_version
140 .Fa "krb5_context *context"
141 .Fa "const krb5_ccache id"
144 .Fo krb5_cc_initialize
145 .Fa "krb5_context *context"
147 .Fa "krb5_principal primary_principal"
151 .Fa "krb5_context *context"
152 .Fa "const krb5_cc_ops *ops"
153 .Fa "krb5_boolean override"
157 .Fa "krb5_context *context"
158 .Fa "const char *name"
159 .Fa "krb5_ccache *id"
162 .Fo krb5_cc_retrieve_cred
163 .Fa "krb5_context *context"
165 .Fa "krb5_flags whichfields"
166 .Fa "const krb5_creds *mcreds"
167 .Fa "krb5_creds *creds"
170 .Fo krb5_cc_remove_cred
171 .Fa "krb5_context *context"
173 .Fa "krb5_flags which"
174 .Fa "krb5_creds *cred"
177 .Fo krb5_cc_set_default_name
178 .Fa "krb5_context *context"
179 .Fa "const char *name"
182 .Fo krb5_cc_store_cred
183 .Fa "krb5_context *context"
185 .Fa "krb5_creds *creds"
188 .Fo krb5_cc_set_flags
189 .Fa "krb5_context *context"
190 .Fa "krb5_cc_set_flags id"
191 .Fa "krb5_flags flags"
194 .Fo krb5_cc_next_cred
195 .Fa "krb5_context *context"
196 .Fa "const krb5_ccache id"
197 .Fa "krb5_cc_cursor *cursor"
198 .Fa "krb5_creds *creds"
203 structure holds a Kerberos credential cache.
207 structure holds current position in a credential cache when
208 iterating over the cache.
212 structure holds a set of operations that can me preformed on a
215 There is no component inside
220 that is directly referable.
224 holds a Kerberos credential, see manpage for
227 .Fn krb5_cc_default_name
229 .Fn krb5_cc_set_default_name
230 gets and sets the default name for the
234 opens the default ccache in
236 Return 0 or an error code.
239 generates a new ccache of type
243 Return 0 or an error code.
246 finds and allocates a ccache in
248 from the specification in
250 If the ccache name doesn't contain any colon (:), interpret it as a
252 Return 0 or an error code.
254 .Fn krb5_cc_initialize
255 creates a new ccache in
258 .Fa primary_principal .
259 Return 0 or an error code.
262 stops using the ccache
264 and frees the related resources.
265 Return 0 or an error code.
268 and closes (by calling
271 Return 0 or an error code.
273 .Fn krb5_cc_copy_cache
274 copys the contents of
280 returns the name of the ccache
283 .Fn krb5_cc_get_principal
284 returns the principal of
288 Return 0 or an error code.
291 returns the type of the ccache
295 returns the ops of the ccache
298 .Fn krb5_cc_get_version
299 returns the version of
303 Adds a new ccache type with operations
305 overwriting any existing one if
307 Return an error code or 0.
309 .Fn krb5_cc_remove_cred
310 removes the credential identified by
316 .Fn krb5_cc_store_cred
321 Return 0 or an error code.
323 .Fn krb5_cc_set_flags
329 .Fn krb5_cc_retrieve_cred ,
330 retrieves the credential identified by
338 Return 0 or an error code.
340 .Fn krb5_cc_next_cred
341 retrieves the next cred pointed to by
348 Return 0 or an error code.
350 .Fn krb5_cc_end_seq_get