xref: /freebsd/crypto/heimdal/lib/krb5/cache.c (revision 6a068746777241722b2b32c5d0bc443a2a64d80b)
1b528cefcSMark Murray /*
2*ae771770SStanislav Sedov  * Copyright (c) 1997 - 2008 Kungliga Tekniska Högskolan
3b528cefcSMark Murray  * (Royal Institute of Technology, Stockholm, Sweden).
4b528cefcSMark Murray  * All rights reserved.
5b528cefcSMark Murray  *
6*ae771770SStanislav Sedov  * Portions Copyright (c) 2009 Apple Inc. All rights reserved.
7*ae771770SStanislav Sedov  *
8b528cefcSMark Murray  * Redistribution and use in source and binary forms, with or without
9b528cefcSMark Murray  * modification, are permitted provided that the following conditions
10b528cefcSMark Murray  * are met:
11b528cefcSMark Murray  *
12b528cefcSMark Murray  * 1. Redistributions of source code must retain the above copyright
13b528cefcSMark Murray  *    notice, this list of conditions and the following disclaimer.
14b528cefcSMark Murray  *
15b528cefcSMark Murray  * 2. Redistributions in binary form must reproduce the above copyright
16b528cefcSMark Murray  *    notice, this list of conditions and the following disclaimer in the
17b528cefcSMark Murray  *    documentation and/or other materials provided with the distribution.
18b528cefcSMark Murray  *
19b528cefcSMark Murray  * 3. Neither the name of the Institute nor the names of its contributors
20b528cefcSMark Murray  *    may be used to endorse or promote products derived from this software
21b528cefcSMark Murray  *    without specific prior written permission.
22b528cefcSMark Murray  *
23b528cefcSMark Murray  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
24b528cefcSMark Murray  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25b528cefcSMark Murray  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26b528cefcSMark Murray  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
27b528cefcSMark Murray  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28b528cefcSMark Murray  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29b528cefcSMark Murray  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30b528cefcSMark Murray  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31b528cefcSMark Murray  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32b528cefcSMark Murray  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33b528cefcSMark Murray  * SUCH DAMAGE.
34b528cefcSMark Murray  */
35b528cefcSMark Murray 
36b528cefcSMark Murray #include "krb5_locl.h"
37b528cefcSMark Murray 
38*ae771770SStanislav Sedov /**
39*ae771770SStanislav Sedov  * @page krb5_ccache_intro The credential cache functions
40*ae771770SStanislav Sedov  * @section section_krb5_ccache Kerberos credential caches
41*ae771770SStanislav Sedov  *
42*ae771770SStanislav Sedov  * krb5_ccache structure holds a Kerberos credential cache.
43*ae771770SStanislav Sedov  *
44*ae771770SStanislav Sedov  * Heimdal support the follow types of credential caches:
45*ae771770SStanislav Sedov  *
46*ae771770SStanislav Sedov  * - SCC
47*ae771770SStanislav Sedov  *   Store the credential in a database
48*ae771770SStanislav Sedov  * - FILE
49*ae771770SStanislav Sedov  *   Store the credential in memory
50*ae771770SStanislav Sedov  * - MEMORY
51*ae771770SStanislav Sedov  *   Store the credential in memory
52*ae771770SStanislav Sedov  * - API
53*ae771770SStanislav Sedov  *   A credential cache server based solution for Mac OS X
54*ae771770SStanislav Sedov  * - KCM
55*ae771770SStanislav Sedov  *   A credential cache server based solution for all platforms
56*ae771770SStanislav Sedov  *
57*ae771770SStanislav Sedov  * @subsection Example
58*ae771770SStanislav Sedov  *
59*ae771770SStanislav Sedov  * This is a minimalistic version of klist:
60*ae771770SStanislav Sedov @code
61*ae771770SStanislav Sedov #include <krb5.h>
62*ae771770SStanislav Sedov 
63*ae771770SStanislav Sedov int
64*ae771770SStanislav Sedov main (int argc, char **argv)
65*ae771770SStanislav Sedov {
66*ae771770SStanislav Sedov     krb5_context context;
67*ae771770SStanislav Sedov     krb5_cc_cursor cursor;
68*ae771770SStanislav Sedov     krb5_error_code ret;
69*ae771770SStanislav Sedov     krb5_ccache id;
70*ae771770SStanislav Sedov     krb5_creds creds;
71*ae771770SStanislav Sedov 
72*ae771770SStanislav Sedov     if (krb5_init_context (&context) != 0)
73*ae771770SStanislav Sedov 	errx(1, "krb5_context");
74*ae771770SStanislav Sedov 
75*ae771770SStanislav Sedov     ret = krb5_cc_default (context, &id);
76*ae771770SStanislav Sedov     if (ret)
77*ae771770SStanislav Sedov 	krb5_err(context, 1, ret, "krb5_cc_default");
78*ae771770SStanislav Sedov 
79*ae771770SStanislav Sedov     ret = krb5_cc_start_seq_get(context, id, &cursor);
80*ae771770SStanislav Sedov     if (ret)
81*ae771770SStanislav Sedov 	krb5_err(context, 1, ret, "krb5_cc_start_seq_get");
82*ae771770SStanislav Sedov 
83*ae771770SStanislav Sedov     while((ret = krb5_cc_next_cred(context, id, &cursor, &creds)) == 0){
84*ae771770SStanislav Sedov         char *principal;
85*ae771770SStanislav Sedov 
86*ae771770SStanislav Sedov 	krb5_unparse_name(context, creds.server, &principal);
87*ae771770SStanislav Sedov 	printf("principal: %s\\n", principal);
88*ae771770SStanislav Sedov 	free(principal);
89*ae771770SStanislav Sedov 	krb5_free_cred_contents (context, &creds);
90*ae771770SStanislav Sedov     }
91*ae771770SStanislav Sedov     ret = krb5_cc_end_seq_get(context, id, &cursor);
92*ae771770SStanislav Sedov     if (ret)
93*ae771770SStanislav Sedov 	krb5_err(context, 1, ret, "krb5_cc_end_seq_get");
94*ae771770SStanislav Sedov 
95*ae771770SStanislav Sedov     krb5_cc_close(context, id);
96*ae771770SStanislav Sedov 
97*ae771770SStanislav Sedov     krb5_free_context(context);
98*ae771770SStanislav Sedov     return 0;
99*ae771770SStanislav Sedov }
100*ae771770SStanislav Sedov * @endcode
101*ae771770SStanislav Sedov */
102b528cefcSMark Murray 
103c19800e8SDoug Rabson /**
104b528cefcSMark Murray  * Add a new ccache type with operations `ops', overwriting any
105b528cefcSMark Murray  * existing one if `override'.
106c19800e8SDoug Rabson  *
107c19800e8SDoug Rabson  * @param context a Keberos context
108c19800e8SDoug Rabson  * @param ops type of plugin symbol
109c19800e8SDoug Rabson  * @param override flag to select if the registration is to overide
110c19800e8SDoug Rabson  * an existing ops with the same name.
111c19800e8SDoug Rabson  *
112*ae771770SStanislav Sedov  * @return Return an error code or 0, see krb5_get_error_message().
113c19800e8SDoug Rabson  *
114c19800e8SDoug Rabson  * @ingroup krb5_ccache
115b528cefcSMark Murray  */
116b528cefcSMark Murray 
117*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_register(krb5_context context,const krb5_cc_ops * ops,krb5_boolean override)118b528cefcSMark Murray krb5_cc_register(krb5_context context,
119b528cefcSMark Murray 		 const krb5_cc_ops *ops,
120b528cefcSMark Murray 		 krb5_boolean override)
121b528cefcSMark Murray {
122b528cefcSMark Murray     int i;
123b528cefcSMark Murray 
124*ae771770SStanislav Sedov     for(i = 0; i < context->num_cc_ops && context->cc_ops[i]->prefix; i++) {
125*ae771770SStanislav Sedov 	if(strcmp(context->cc_ops[i]->prefix, ops->prefix) == 0) {
1268373020dSJacques Vidrine 	    if(!override) {
127*ae771770SStanislav Sedov 		krb5_set_error_message(context,
128*ae771770SStanislav Sedov 				       KRB5_CC_TYPE_EXISTS,
129*ae771770SStanislav Sedov 				       N_("cache type %s already exists", "type"),
130adb0ddaeSAssar Westerlund 				       ops->prefix);
131b528cefcSMark Murray 		return KRB5_CC_TYPE_EXISTS;
132b528cefcSMark Murray 	    }
1338373020dSJacques Vidrine 	    break;
134b528cefcSMark Murray 	}
135adb0ddaeSAssar Westerlund     }
136b528cefcSMark Murray     if(i == context->num_cc_ops) {
137*ae771770SStanislav Sedov 	const krb5_cc_ops **o = realloc(rk_UNCONST(context->cc_ops),
138b528cefcSMark Murray 					(context->num_cc_ops + 1) *
139*ae771770SStanislav Sedov 					sizeof(context->cc_ops[0]));
140adb0ddaeSAssar Westerlund 	if(o == NULL) {
141*ae771770SStanislav Sedov 	    krb5_set_error_message(context, KRB5_CC_NOMEM,
142*ae771770SStanislav Sedov 				   N_("malloc: out of memory", ""));
143b528cefcSMark Murray 	    return KRB5_CC_NOMEM;
144adb0ddaeSAssar Westerlund 	}
145b528cefcSMark Murray 	context->cc_ops = o;
146*ae771770SStanislav Sedov 	context->cc_ops[context->num_cc_ops] = NULL;
147*ae771770SStanislav Sedov 	context->num_cc_ops++;
148b528cefcSMark Murray     }
149*ae771770SStanislav Sedov     context->cc_ops[i] = ops;
150b528cefcSMark Murray     return 0;
151b528cefcSMark Murray }
152b528cefcSMark Murray 
153b528cefcSMark Murray /*
154c19800e8SDoug Rabson  * Allocate the memory for a `id' and the that function table to
155c19800e8SDoug Rabson  * `ops'. Returns 0 or and error code.
156b528cefcSMark Murray  */
157b528cefcSMark Murray 
158c19800e8SDoug Rabson krb5_error_code
_krb5_cc_allocate(krb5_context context,const krb5_cc_ops * ops,krb5_ccache * id)159c19800e8SDoug Rabson _krb5_cc_allocate(krb5_context context,
160b528cefcSMark Murray 		  const krb5_cc_ops *ops,
161b528cefcSMark Murray 		  krb5_ccache *id)
162b528cefcSMark Murray {
163b528cefcSMark Murray     krb5_ccache p;
164b528cefcSMark Murray 
165b528cefcSMark Murray     p = malloc (sizeof(*p));
166adb0ddaeSAssar Westerlund     if(p == NULL) {
167*ae771770SStanislav Sedov 	krb5_set_error_message(context, KRB5_CC_NOMEM,
168*ae771770SStanislav Sedov 			       N_("malloc: out of memory", ""));
169b528cefcSMark Murray 	return KRB5_CC_NOMEM;
170adb0ddaeSAssar Westerlund     }
171b528cefcSMark Murray     p->ops = ops;
172b528cefcSMark Murray     *id = p;
173c19800e8SDoug Rabson 
174c19800e8SDoug Rabson     return 0;
175b528cefcSMark Murray }
176b528cefcSMark Murray 
177b528cefcSMark Murray /*
178c19800e8SDoug Rabson  * Allocate memory for a new ccache in `id' with operations `ops'
179c19800e8SDoug Rabson  * and name `residual'. Return 0 or an error code.
180b528cefcSMark Murray  */
181b528cefcSMark Murray 
182c19800e8SDoug Rabson static krb5_error_code
allocate_ccache(krb5_context context,const krb5_cc_ops * ops,const char * residual,krb5_ccache * id)183c19800e8SDoug Rabson allocate_ccache (krb5_context context,
184c19800e8SDoug Rabson 		 const krb5_cc_ops *ops,
185c19800e8SDoug Rabson 		 const char *residual,
186c19800e8SDoug Rabson 		 krb5_ccache *id)
187c19800e8SDoug Rabson {
188c19800e8SDoug Rabson     krb5_error_code ret;
189*ae771770SStanislav Sedov #ifdef KRB5_USE_PATH_TOKENS
190*ae771770SStanislav Sedov     char * exp_residual = NULL;
191*ae771770SStanislav Sedov 
192*ae771770SStanislav Sedov     ret = _krb5_expand_path_tokens(context, residual, &exp_residual);
193*ae771770SStanislav Sedov     if (ret)
194*ae771770SStanislav Sedov 	return ret;
195*ae771770SStanislav Sedov 
196*ae771770SStanislav Sedov     residual = exp_residual;
197*ae771770SStanislav Sedov #endif
198c19800e8SDoug Rabson 
199c19800e8SDoug Rabson     ret = _krb5_cc_allocate(context, ops, id);
200*ae771770SStanislav Sedov     if (ret) {
201*ae771770SStanislav Sedov #ifdef KRB5_USE_PATH_TOKENS
202*ae771770SStanislav Sedov 	if (exp_residual)
203*ae771770SStanislav Sedov 	    free(exp_residual);
204*ae771770SStanislav Sedov #endif
205c19800e8SDoug Rabson 	return ret;
206*ae771770SStanislav Sedov     }
207*ae771770SStanislav Sedov 
208c19800e8SDoug Rabson     ret = (*id)->ops->resolve(context, id, residual);
209*ae771770SStanislav Sedov     if(ret) {
210c19800e8SDoug Rabson 	free(*id);
211*ae771770SStanislav Sedov         *id = NULL;
212*ae771770SStanislav Sedov     }
213*ae771770SStanislav Sedov 
214*ae771770SStanislav Sedov #ifdef KRB5_USE_PATH_TOKENS
215*ae771770SStanislav Sedov     if (exp_residual)
216*ae771770SStanislav Sedov 	free(exp_residual);
217*ae771770SStanislav Sedov #endif
218*ae771770SStanislav Sedov 
219c19800e8SDoug Rabson     return ret;
220c19800e8SDoug Rabson }
221c19800e8SDoug Rabson 
222*ae771770SStanislav Sedov static int
is_possible_path_name(const char * name)223*ae771770SStanislav Sedov is_possible_path_name(const char * name)
224*ae771770SStanislav Sedov {
225*ae771770SStanislav Sedov     const char * colon;
226*ae771770SStanislav Sedov 
227*ae771770SStanislav Sedov     if ((colon = strchr(name, ':')) == NULL)
228*ae771770SStanislav Sedov         return TRUE;
229*ae771770SStanislav Sedov 
230*ae771770SStanislav Sedov #ifdef _WIN32
231*ae771770SStanislav Sedov     /* <drive letter>:\path\to\cache ? */
232*ae771770SStanislav Sedov 
233*ae771770SStanislav Sedov     if (colon == name + 1 &&
234*ae771770SStanislav Sedov         strchr(colon + 1, ':') == NULL)
235*ae771770SStanislav Sedov         return TRUE;
236*ae771770SStanislav Sedov #endif
237*ae771770SStanislav Sedov 
238*ae771770SStanislav Sedov     return FALSE;
239*ae771770SStanislav Sedov }
240*ae771770SStanislav Sedov 
241c19800e8SDoug Rabson /**
242c19800e8SDoug Rabson  * Find and allocate a ccache in `id' from the specification in `residual'.
243c19800e8SDoug Rabson  * If the ccache name doesn't contain any colon, interpret it as a file name.
244c19800e8SDoug Rabson  *
245c19800e8SDoug Rabson  * @param context a Keberos context.
246c19800e8SDoug Rabson  * @param name string name of a credential cache.
247c19800e8SDoug Rabson  * @param id return pointer to a found credential cache.
248c19800e8SDoug Rabson  *
249c19800e8SDoug Rabson  * @return Return 0 or an error code. In case of an error, id is set
250*ae771770SStanislav Sedov  * to NULL, see krb5_get_error_message().
251c19800e8SDoug Rabson  *
252c19800e8SDoug Rabson  * @ingroup krb5_ccache
253c19800e8SDoug Rabson  */
254c19800e8SDoug Rabson 
255c19800e8SDoug Rabson 
256*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_resolve(krb5_context context,const char * name,krb5_ccache * id)257b528cefcSMark Murray krb5_cc_resolve(krb5_context context,
258b528cefcSMark Murray 		const char *name,
259b528cefcSMark Murray 		krb5_ccache *id)
260b528cefcSMark Murray {
261b528cefcSMark Murray     int i;
262b528cefcSMark Murray 
263c19800e8SDoug Rabson     *id = NULL;
264c19800e8SDoug Rabson 
265*ae771770SStanislav Sedov     for(i = 0; i < context->num_cc_ops && context->cc_ops[i]->prefix; i++) {
266*ae771770SStanislav Sedov 	size_t prefix_len = strlen(context->cc_ops[i]->prefix);
267b528cefcSMark Murray 
268*ae771770SStanislav Sedov 	if(strncmp(context->cc_ops[i]->prefix, name, prefix_len) == 0
269b528cefcSMark Murray 	   && name[prefix_len] == ':') {
270*ae771770SStanislav Sedov 	    return allocate_ccache (context, context->cc_ops[i],
271b528cefcSMark Murray 				    name + prefix_len + 1,
272b528cefcSMark Murray 				    id);
273b528cefcSMark Murray 	}
274b528cefcSMark Murray     }
275*ae771770SStanislav Sedov     if (is_possible_path_name(name))
276b528cefcSMark Murray 	return allocate_ccache (context, &krb5_fcc_ops, name, id);
277adb0ddaeSAssar Westerlund     else {
278*ae771770SStanislav Sedov 	krb5_set_error_message(context, KRB5_CC_UNKNOWN_TYPE,
279*ae771770SStanislav Sedov 			       N_("unknown ccache type %s", "name"), name);
280b528cefcSMark Murray 	return KRB5_CC_UNKNOWN_TYPE;
281b528cefcSMark Murray     }
282adb0ddaeSAssar Westerlund }
283b528cefcSMark Murray 
284c19800e8SDoug Rabson /**
285c19800e8SDoug Rabson  * Generates a new unique ccache of `type` in `id'. If `type' is NULL,
286c19800e8SDoug Rabson  * the library chooses the default credential cache type. The supplied
287c19800e8SDoug Rabson  * `hint' (that can be NULL) is a string that the credential cache
288c19800e8SDoug Rabson  * type can use to base the name of the credential on, this is to make
289c19800e8SDoug Rabson  * it easier for the user to differentiate the credentials.
290c19800e8SDoug Rabson  *
291*ae771770SStanislav Sedov  * @return Return an error code or 0, see krb5_get_error_message().
292c19800e8SDoug Rabson  *
293c19800e8SDoug Rabson  * @ingroup krb5_ccache
294b528cefcSMark Murray  */
295b528cefcSMark Murray 
296*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_new_unique(krb5_context context,const char * type,const char * hint,krb5_ccache * id)297c19800e8SDoug Rabson krb5_cc_new_unique(krb5_context context, const char *type,
298c19800e8SDoug Rabson 		   const char *hint, krb5_ccache *id)
299c19800e8SDoug Rabson {
300*ae771770SStanislav Sedov     const krb5_cc_ops *ops;
301c19800e8SDoug Rabson     krb5_error_code ret;
302c19800e8SDoug Rabson 
303c19800e8SDoug Rabson     ops = krb5_cc_get_prefix_ops(context, type);
304c19800e8SDoug Rabson     if (ops == NULL) {
305*ae771770SStanislav Sedov 	krb5_set_error_message(context, KRB5_CC_UNKNOWN_TYPE,
306c19800e8SDoug Rabson 			      "Credential cache type %s is unknown", type);
307c19800e8SDoug Rabson 	return KRB5_CC_UNKNOWN_TYPE;
308c19800e8SDoug Rabson     }
309c19800e8SDoug Rabson 
310c19800e8SDoug Rabson     ret = _krb5_cc_allocate(context, ops, id);
311c19800e8SDoug Rabson     if (ret)
312c19800e8SDoug Rabson 	return ret;
313*ae771770SStanislav Sedov     ret = (*id)->ops->gen_new(context, id);
314*ae771770SStanislav Sedov     if (ret) {
315*ae771770SStanislav Sedov 	free(*id);
316*ae771770SStanislav Sedov 	*id = NULL;
317*ae771770SStanislav Sedov     }
318*ae771770SStanislav Sedov     return ret;
319c19800e8SDoug Rabson }
320c19800e8SDoug Rabson 
321c19800e8SDoug Rabson /**
322c19800e8SDoug Rabson  * Return the name of the ccache `id'
323c19800e8SDoug Rabson  *
324c19800e8SDoug Rabson  * @ingroup krb5_ccache
325c19800e8SDoug Rabson  */
326c19800e8SDoug Rabson 
327c19800e8SDoug Rabson 
328*ae771770SStanislav Sedov KRB5_LIB_FUNCTION const char* KRB5_LIB_CALL
krb5_cc_get_name(krb5_context context,krb5_ccache id)329b528cefcSMark Murray krb5_cc_get_name(krb5_context context,
330b528cefcSMark Murray 		 krb5_ccache id)
331b528cefcSMark Murray {
332b528cefcSMark Murray     return id->ops->get_name(context, id);
333b528cefcSMark Murray }
334b528cefcSMark Murray 
335c19800e8SDoug Rabson /**
336b528cefcSMark Murray  * Return the type of the ccache `id'.
337c19800e8SDoug Rabson  *
338c19800e8SDoug Rabson  * @ingroup krb5_ccache
339b528cefcSMark Murray  */
340b528cefcSMark Murray 
341c19800e8SDoug Rabson 
342*ae771770SStanislav Sedov KRB5_LIB_FUNCTION const char* KRB5_LIB_CALL
krb5_cc_get_type(krb5_context context,krb5_ccache id)343b528cefcSMark Murray krb5_cc_get_type(krb5_context context,
344b528cefcSMark Murray 		 krb5_ccache id)
345b528cefcSMark Murray {
346b528cefcSMark Murray     return id->ops->prefix;
347b528cefcSMark Murray }
348b528cefcSMark Murray 
349c19800e8SDoug Rabson /**
350*ae771770SStanislav Sedov  * Return the complete resolvable name the cache
351*ae771770SStanislav Sedov 
352*ae771770SStanislav Sedov  * @param context a Keberos context
353*ae771770SStanislav Sedov  * @param id return pointer to a found credential cache
354*ae771770SStanislav Sedov  * @param str the returned name of a credential cache, free with krb5_xfree()
355*ae771770SStanislav Sedov  *
356*ae771770SStanislav Sedov  * @return Returns 0 or an error (and then *str is set to NULL).
357c19800e8SDoug Rabson  *
358c19800e8SDoug Rabson  * @ingroup krb5_ccache
359bbd80c28SJacques Vidrine  */
360bbd80c28SJacques Vidrine 
361c19800e8SDoug Rabson 
362*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_get_full_name(krb5_context context,krb5_ccache id,char ** str)363c19800e8SDoug Rabson krb5_cc_get_full_name(krb5_context context,
364c19800e8SDoug Rabson 		      krb5_ccache id,
365c19800e8SDoug Rabson 		      char **str)
366c19800e8SDoug Rabson {
367c19800e8SDoug Rabson     const char *type, *name;
368c19800e8SDoug Rabson 
369c19800e8SDoug Rabson     *str = NULL;
370c19800e8SDoug Rabson 
371c19800e8SDoug Rabson     type = krb5_cc_get_type(context, id);
372c19800e8SDoug Rabson     if (type == NULL) {
373*ae771770SStanislav Sedov 	krb5_set_error_message(context, KRB5_CC_UNKNOWN_TYPE,
374*ae771770SStanislav Sedov 			       "cache have no name of type");
375c19800e8SDoug Rabson 	return KRB5_CC_UNKNOWN_TYPE;
376c19800e8SDoug Rabson     }
377c19800e8SDoug Rabson 
378c19800e8SDoug Rabson     name = krb5_cc_get_name(context, id);
379c19800e8SDoug Rabson     if (name == NULL) {
380*ae771770SStanislav Sedov 	krb5_set_error_message(context, KRB5_CC_BADNAME,
381*ae771770SStanislav Sedov 			       "cache of type %s have no name", type);
382c19800e8SDoug Rabson 	return KRB5_CC_BADNAME;
383c19800e8SDoug Rabson     }
384c19800e8SDoug Rabson 
385c19800e8SDoug Rabson     if (asprintf(str, "%s:%s", type, name) == -1) {
386*ae771770SStanislav Sedov 	krb5_set_error_message(context, ENOMEM, N_("malloc: out of memory", ""));
387c19800e8SDoug Rabson 	*str = NULL;
388c19800e8SDoug Rabson 	return ENOMEM;
389c19800e8SDoug Rabson     }
390c19800e8SDoug Rabson     return 0;
391c19800e8SDoug Rabson }
392c19800e8SDoug Rabson 
393c19800e8SDoug Rabson /**
394c19800e8SDoug Rabson  * Return krb5_cc_ops of a the ccache `id'.
395c19800e8SDoug Rabson  *
396c19800e8SDoug Rabson  * @ingroup krb5_ccache
397c19800e8SDoug Rabson  */
398c19800e8SDoug Rabson 
399c19800e8SDoug Rabson 
400*ae771770SStanislav Sedov KRB5_LIB_FUNCTION const krb5_cc_ops * KRB5_LIB_CALL
krb5_cc_get_ops(krb5_context context,krb5_ccache id)401bbd80c28SJacques Vidrine krb5_cc_get_ops(krb5_context context, krb5_ccache id)
402bbd80c28SJacques Vidrine {
403bbd80c28SJacques Vidrine     return id->ops;
404bbd80c28SJacques Vidrine }
405bbd80c28SJacques Vidrine 
406bbd80c28SJacques Vidrine /*
407c19800e8SDoug Rabson  * Expand variables in `str' into `res'
408bbd80c28SJacques Vidrine  */
409bbd80c28SJacques Vidrine 
410bbd80c28SJacques Vidrine krb5_error_code
_krb5_expand_default_cc_name(krb5_context context,const char * str,char ** res)411c19800e8SDoug Rabson _krb5_expand_default_cc_name(krb5_context context, const char *str, char **res)
412c19800e8SDoug Rabson {
413*ae771770SStanislav Sedov     return _krb5_expand_path_tokens(context, str, res);
414c19800e8SDoug Rabson }
415c19800e8SDoug Rabson 
416c19800e8SDoug Rabson /*
417c19800e8SDoug Rabson  * Return non-zero if envirnoment that will determine default krb5cc
418c19800e8SDoug Rabson  * name has changed.
419c19800e8SDoug Rabson  */
420c19800e8SDoug Rabson 
421c19800e8SDoug Rabson static int
environment_changed(krb5_context context)422c19800e8SDoug Rabson environment_changed(krb5_context context)
423c19800e8SDoug Rabson {
424c19800e8SDoug Rabson     const char *e;
425c19800e8SDoug Rabson 
426c19800e8SDoug Rabson     /* if the cc name was set, don't change it */
427c19800e8SDoug Rabson     if (context->default_cc_name_set)
428c19800e8SDoug Rabson 	return 0;
429c19800e8SDoug Rabson 
430*ae771770SStanislav Sedov     /* XXX performance: always ask KCM/API if default name has changed */
431*ae771770SStanislav Sedov     if (context->default_cc_name &&
432*ae771770SStanislav Sedov 	(strncmp(context->default_cc_name, "KCM:", 4) == 0 ||
433*ae771770SStanislav Sedov 	 strncmp(context->default_cc_name, "API:", 4) == 0))
434*ae771770SStanislav Sedov 	return 1;
435*ae771770SStanislav Sedov 
436c19800e8SDoug Rabson     if(issuid())
437c19800e8SDoug Rabson 	return 0;
438c19800e8SDoug Rabson 
439c19800e8SDoug Rabson     e = getenv("KRB5CCNAME");
440c19800e8SDoug Rabson     if (e == NULL) {
441c19800e8SDoug Rabson 	if (context->default_cc_name_env) {
442c19800e8SDoug Rabson 	    free(context->default_cc_name_env);
443c19800e8SDoug Rabson 	    context->default_cc_name_env = NULL;
444c19800e8SDoug Rabson 	    return 1;
445c19800e8SDoug Rabson 	}
446c19800e8SDoug Rabson     } else {
447c19800e8SDoug Rabson 	if (context->default_cc_name_env == NULL)
448c19800e8SDoug Rabson 	    return 1;
449c19800e8SDoug Rabson 	if (strcmp(e, context->default_cc_name_env) != 0)
450c19800e8SDoug Rabson 	    return 1;
451c19800e8SDoug Rabson     }
452c19800e8SDoug Rabson     return 0;
453c19800e8SDoug Rabson }
454c19800e8SDoug Rabson 
455c19800e8SDoug Rabson /**
456*ae771770SStanislav Sedov  * Switch the default default credential cache for a specific
457*ae771770SStanislav Sedov  * credcache type (and name for some implementations).
458*ae771770SStanislav Sedov  *
459*ae771770SStanislav Sedov  * @return Return an error code or 0, see krb5_get_error_message().
460*ae771770SStanislav Sedov  *
461*ae771770SStanislav Sedov  * @ingroup krb5_ccache
462*ae771770SStanislav Sedov  */
463*ae771770SStanislav Sedov 
464*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_switch(krb5_context context,krb5_ccache id)465*ae771770SStanislav Sedov krb5_cc_switch(krb5_context context, krb5_ccache id)
466*ae771770SStanislav Sedov {
467*ae771770SStanislav Sedov #ifdef _WIN32
468*ae771770SStanislav Sedov     _krb5_set_default_cc_name_to_registry(context, id);
469*ae771770SStanislav Sedov #endif
470*ae771770SStanislav Sedov 
471*ae771770SStanislav Sedov     if (id->ops->set_default == NULL)
472*ae771770SStanislav Sedov 	return 0;
473*ae771770SStanislav Sedov 
474*ae771770SStanislav Sedov     return (*id->ops->set_default)(context, id);
475*ae771770SStanislav Sedov }
476*ae771770SStanislav Sedov 
477*ae771770SStanislav Sedov /**
478*ae771770SStanislav Sedov  * Return true if the default credential cache support switch
479*ae771770SStanislav Sedov  *
480*ae771770SStanislav Sedov  * @ingroup krb5_ccache
481*ae771770SStanislav Sedov  */
482*ae771770SStanislav Sedov 
483*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL
krb5_cc_support_switch(krb5_context context,const char * type)484*ae771770SStanislav Sedov krb5_cc_support_switch(krb5_context context, const char *type)
485*ae771770SStanislav Sedov {
486*ae771770SStanislav Sedov     const krb5_cc_ops *ops;
487*ae771770SStanislav Sedov 
488*ae771770SStanislav Sedov     ops = krb5_cc_get_prefix_ops(context, type);
489*ae771770SStanislav Sedov     if (ops && ops->set_default)
490*ae771770SStanislav Sedov 	return 1;
491*ae771770SStanislav Sedov     return FALSE;
492*ae771770SStanislav Sedov }
493*ae771770SStanislav Sedov 
494*ae771770SStanislav Sedov /**
495c19800e8SDoug Rabson  * Set the default cc name for `context' to `name'.
496c19800e8SDoug Rabson  *
497c19800e8SDoug Rabson  * @ingroup krb5_ccache
498c19800e8SDoug Rabson  */
499c19800e8SDoug Rabson 
500*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_set_default_name(krb5_context context,const char * name)501bbd80c28SJacques Vidrine krb5_cc_set_default_name(krb5_context context, const char *name)
502bbd80c28SJacques Vidrine {
503bbd80c28SJacques Vidrine     krb5_error_code ret = 0;
504*ae771770SStanislav Sedov     char *p = NULL, *exp_p = NULL;
505bbd80c28SJacques Vidrine 
506bbd80c28SJacques Vidrine     if (name == NULL) {
507c19800e8SDoug Rabson 	const char *e = NULL;
508bbd80c28SJacques Vidrine 
509c19800e8SDoug Rabson 	if(!issuid()) {
510c19800e8SDoug Rabson 	    e = getenv("KRB5CCNAME");
511c19800e8SDoug Rabson 	    if (e) {
512c19800e8SDoug Rabson 		p = strdup(e);
513c19800e8SDoug Rabson 		if (context->default_cc_name_env)
514c19800e8SDoug Rabson 		    free(context->default_cc_name_env);
515c19800e8SDoug Rabson 		context->default_cc_name_env = strdup(e);
516c19800e8SDoug Rabson 	    }
517c19800e8SDoug Rabson 	}
518*ae771770SStanislav Sedov 
519*ae771770SStanislav Sedov #ifdef _WIN32
520*ae771770SStanislav Sedov         if (e == NULL) {
521*ae771770SStanislav Sedov             e = p = _krb5_get_default_cc_name_from_registry(context);
522*ae771770SStanislav Sedov         }
523*ae771770SStanislav Sedov #endif
524c19800e8SDoug Rabson 	if (e == NULL) {
525c19800e8SDoug Rabson 	    e = krb5_config_get_string(context, NULL, "libdefaults",
526c19800e8SDoug Rabson 				       "default_cc_name", NULL);
527c19800e8SDoug Rabson 	    if (e) {
528c19800e8SDoug Rabson 		ret = _krb5_expand_default_cc_name(context, e, &p);
529c19800e8SDoug Rabson 		if (ret)
530c19800e8SDoug Rabson 		    return ret;
531c19800e8SDoug Rabson 	    }
532c19800e8SDoug Rabson 	    if (e == NULL) {
533c19800e8SDoug Rabson 		const krb5_cc_ops *ops = KRB5_DEFAULT_CCTYPE;
534*ae771770SStanislav Sedov 		e = krb5_config_get_string(context, NULL, "libdefaults",
535*ae771770SStanislav Sedov 					   "default_cc_type", NULL);
536*ae771770SStanislav Sedov 		if (e) {
537*ae771770SStanislav Sedov 		    ops = krb5_cc_get_prefix_ops(context, e);
538*ae771770SStanislav Sedov 		    if (ops == NULL) {
539*ae771770SStanislav Sedov 			krb5_set_error_message(context,
540*ae771770SStanislav Sedov 					       KRB5_CC_UNKNOWN_TYPE,
541*ae771770SStanislav Sedov 					       "Credential cache type %s "
542*ae771770SStanislav Sedov 					      "is unknown", e);
543*ae771770SStanislav Sedov 			return KRB5_CC_UNKNOWN_TYPE;
544*ae771770SStanislav Sedov 		    }
545*ae771770SStanislav Sedov 		}
546*ae771770SStanislav Sedov 		ret = (*ops->get_default_name)(context, &p);
547c19800e8SDoug Rabson 		if (ret)
548c19800e8SDoug Rabson 		    return ret;
549c19800e8SDoug Rabson 	    }
550c19800e8SDoug Rabson 	}
551c19800e8SDoug Rabson 	context->default_cc_name_set = 0;
552c19800e8SDoug Rabson     } else {
553c19800e8SDoug Rabson 	p = strdup(name);
554c19800e8SDoug Rabson 	context->default_cc_name_set = 1;
555c19800e8SDoug Rabson     }
556c19800e8SDoug Rabson 
557c19800e8SDoug Rabson     if (p == NULL) {
558*ae771770SStanislav Sedov 	krb5_set_error_message(context, ENOMEM, N_("malloc: out of memory", ""));
559bbd80c28SJacques Vidrine 	return ENOMEM;
560c19800e8SDoug Rabson     }
561bbd80c28SJacques Vidrine 
562*ae771770SStanislav Sedov     ret = _krb5_expand_path_tokens(context, p, &exp_p);
563*ae771770SStanislav Sedov     free(p);
564*ae771770SStanislav Sedov     if (ret)
565*ae771770SStanislav Sedov 	return ret;
566*ae771770SStanislav Sedov 
567bbd80c28SJacques Vidrine     if (context->default_cc_name)
568bbd80c28SJacques Vidrine 	free(context->default_cc_name);
569bbd80c28SJacques Vidrine 
570*ae771770SStanislav Sedov     context->default_cc_name = exp_p;
571bbd80c28SJacques Vidrine 
572*ae771770SStanislav Sedov     return 0;
573bbd80c28SJacques Vidrine }
574bbd80c28SJacques Vidrine 
575c19800e8SDoug Rabson /**
576c19800e8SDoug Rabson  * Return a pointer to a context static string containing the default
577c19800e8SDoug Rabson  * ccache name.
578c19800e8SDoug Rabson  *
579c19800e8SDoug Rabson  * @return String to the default credential cache name.
580c19800e8SDoug Rabson  *
581c19800e8SDoug Rabson  * @ingroup krb5_ccache
582b528cefcSMark Murray  */
583b528cefcSMark Murray 
584c19800e8SDoug Rabson 
585*ae771770SStanislav Sedov KRB5_LIB_FUNCTION const char* KRB5_LIB_CALL
krb5_cc_default_name(krb5_context context)586b528cefcSMark Murray krb5_cc_default_name(krb5_context context)
587b528cefcSMark Murray {
588c19800e8SDoug Rabson     if (context->default_cc_name == NULL || environment_changed(context))
589bbd80c28SJacques Vidrine 	krb5_cc_set_default_name(context, NULL);
590b528cefcSMark Murray 
591bbd80c28SJacques Vidrine     return context->default_cc_name;
592b528cefcSMark Murray }
593b528cefcSMark Murray 
594c19800e8SDoug Rabson /**
595b528cefcSMark Murray  * Open the default ccache in `id'.
596c19800e8SDoug Rabson  *
597*ae771770SStanislav Sedov  * @return Return an error code or 0, see krb5_get_error_message().
598c19800e8SDoug Rabson  *
599c19800e8SDoug Rabson  * @ingroup krb5_ccache
600b528cefcSMark Murray  */
601b528cefcSMark Murray 
602c19800e8SDoug Rabson 
603*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_default(krb5_context context,krb5_ccache * id)604b528cefcSMark Murray krb5_cc_default(krb5_context context,
605b528cefcSMark Murray 		krb5_ccache *id)
606b528cefcSMark Murray {
607bbd80c28SJacques Vidrine     const char *p = krb5_cc_default_name(context);
608bbd80c28SJacques Vidrine 
609c19800e8SDoug Rabson     if (p == NULL) {
610*ae771770SStanislav Sedov 	krb5_set_error_message(context, ENOMEM, N_("malloc: out of memory", ""));
611bbd80c28SJacques Vidrine 	return ENOMEM;
612c19800e8SDoug Rabson     }
613bbd80c28SJacques Vidrine     return krb5_cc_resolve(context, p, id);
614b528cefcSMark Murray }
615b528cefcSMark Murray 
616c19800e8SDoug Rabson /**
617b528cefcSMark Murray  * Create a new ccache in `id' for `primary_principal'.
618c19800e8SDoug Rabson  *
619*ae771770SStanislav Sedov  * @return Return an error code or 0, see krb5_get_error_message().
620c19800e8SDoug Rabson  *
621c19800e8SDoug Rabson  * @ingroup krb5_ccache
622b528cefcSMark Murray  */
623b528cefcSMark Murray 
624c19800e8SDoug Rabson 
625*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_initialize(krb5_context context,krb5_ccache id,krb5_principal primary_principal)626b528cefcSMark Murray krb5_cc_initialize(krb5_context context,
627b528cefcSMark Murray 		   krb5_ccache id,
628b528cefcSMark Murray 		   krb5_principal primary_principal)
629b528cefcSMark Murray {
630c19800e8SDoug Rabson     return (*id->ops->init)(context, id, primary_principal);
631b528cefcSMark Murray }
632b528cefcSMark Murray 
633b528cefcSMark Murray 
634c19800e8SDoug Rabson /**
635b528cefcSMark Murray  * Remove the ccache `id'.
636c19800e8SDoug Rabson  *
637*ae771770SStanislav Sedov  * @return Return an error code or 0, see krb5_get_error_message().
638c19800e8SDoug Rabson  *
639c19800e8SDoug Rabson  * @ingroup krb5_ccache
640b528cefcSMark Murray  */
641b528cefcSMark Murray 
642c19800e8SDoug Rabson 
643*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_destroy(krb5_context context,krb5_ccache id)644b528cefcSMark Murray krb5_cc_destroy(krb5_context context,
645b528cefcSMark Murray 		krb5_ccache id)
646b528cefcSMark Murray {
647b528cefcSMark Murray     krb5_error_code ret;
648b528cefcSMark Murray 
649c19800e8SDoug Rabson     ret = (*id->ops->destroy)(context, id);
650b528cefcSMark Murray     krb5_cc_close (context, id);
651b528cefcSMark Murray     return ret;
652b528cefcSMark Murray }
653b528cefcSMark Murray 
654c19800e8SDoug Rabson /**
655b528cefcSMark Murray  * Stop using the ccache `id' and free the related resources.
656c19800e8SDoug Rabson  *
657*ae771770SStanislav Sedov  * @return Return an error code or 0, see krb5_get_error_message().
658c19800e8SDoug Rabson  *
659c19800e8SDoug Rabson  * @ingroup krb5_ccache
660b528cefcSMark Murray  */
661b528cefcSMark Murray 
662c19800e8SDoug Rabson 
663*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_close(krb5_context context,krb5_ccache id)664b528cefcSMark Murray krb5_cc_close(krb5_context context,
665b528cefcSMark Murray 	      krb5_ccache id)
666b528cefcSMark Murray {
667b528cefcSMark Murray     krb5_error_code ret;
668c19800e8SDoug Rabson     ret = (*id->ops->close)(context, id);
669b528cefcSMark Murray     free(id);
670b528cefcSMark Murray     return ret;
671b528cefcSMark Murray }
672b528cefcSMark Murray 
673c19800e8SDoug Rabson /**
674b528cefcSMark Murray  * Store `creds' in the ccache `id'.
675c19800e8SDoug Rabson  *
676*ae771770SStanislav Sedov  * @return Return an error code or 0, see krb5_get_error_message().
677c19800e8SDoug Rabson  *
678c19800e8SDoug Rabson  * @ingroup krb5_ccache
679b528cefcSMark Murray  */
680b528cefcSMark Murray 
681c19800e8SDoug Rabson 
682*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_store_cred(krb5_context context,krb5_ccache id,krb5_creds * creds)683b528cefcSMark Murray krb5_cc_store_cred(krb5_context context,
684b528cefcSMark Murray 		   krb5_ccache id,
685b528cefcSMark Murray 		   krb5_creds *creds)
686b528cefcSMark Murray {
687c19800e8SDoug Rabson     return (*id->ops->store)(context, id, creds);
688b528cefcSMark Murray }
689b528cefcSMark Murray 
690c19800e8SDoug Rabson /**
691b528cefcSMark Murray  * Retrieve the credential identified by `mcreds' (and `whichfields')
692c19800e8SDoug Rabson  * from `id' in `creds'. 'creds' must be free by the caller using
693c19800e8SDoug Rabson  * krb5_free_cred_contents.
694c19800e8SDoug Rabson  *
695*ae771770SStanislav Sedov  * @param context A Kerberos 5 context
696*ae771770SStanislav Sedov  * @param id a Kerberos 5 credential cache
697*ae771770SStanislav Sedov  * @param whichfields what fields to use for matching credentials, same
698*ae771770SStanislav Sedov  *        flags as whichfields in krb5_compare_creds()
699*ae771770SStanislav Sedov  * @param mcreds template credential to use for comparing
700*ae771770SStanislav Sedov  * @param creds returned credential, free with krb5_free_cred_contents()
701*ae771770SStanislav Sedov  *
702*ae771770SStanislav Sedov  * @return Return an error code or 0, see krb5_get_error_message().
703c19800e8SDoug Rabson  *
704c19800e8SDoug Rabson  * @ingroup krb5_ccache
705b528cefcSMark Murray  */
706b528cefcSMark Murray 
707c19800e8SDoug Rabson 
708*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_retrieve_cred(krb5_context context,krb5_ccache id,krb5_flags whichfields,const krb5_creds * mcreds,krb5_creds * creds)709b528cefcSMark Murray krb5_cc_retrieve_cred(krb5_context context,
710b528cefcSMark Murray 		      krb5_ccache id,
711b528cefcSMark Murray 		      krb5_flags whichfields,
712b528cefcSMark Murray 		      const krb5_creds *mcreds,
713b528cefcSMark Murray 		      krb5_creds *creds)
714b528cefcSMark Murray {
715b528cefcSMark Murray     krb5_error_code ret;
716b528cefcSMark Murray     krb5_cc_cursor cursor;
717c19800e8SDoug Rabson 
718c19800e8SDoug Rabson     if (id->ops->retrieve != NULL) {
719c19800e8SDoug Rabson 	return (*id->ops->retrieve)(context, id, whichfields,
720c19800e8SDoug Rabson 				    mcreds, creds);
721c19800e8SDoug Rabson     }
722c19800e8SDoug Rabson 
723c19800e8SDoug Rabson     ret = krb5_cc_start_seq_get(context, id, &cursor);
724c19800e8SDoug Rabson     if (ret)
725c19800e8SDoug Rabson 	return ret;
726adb0ddaeSAssar Westerlund     while((ret = krb5_cc_next_cred(context, id, &cursor, creds)) == 0){
727b528cefcSMark Murray 	if(krb5_compare_creds(context, whichfields, mcreds, creds)){
728b528cefcSMark Murray 	    ret = 0;
729b528cefcSMark Murray 	    break;
730b528cefcSMark Murray 	}
731c19800e8SDoug Rabson 	krb5_free_cred_contents (context, creds);
732b528cefcSMark Murray     }
733b528cefcSMark Murray     krb5_cc_end_seq_get(context, id, &cursor);
734b528cefcSMark Murray     return ret;
735b528cefcSMark Murray }
736b528cefcSMark Murray 
737c19800e8SDoug Rabson /**
738b528cefcSMark Murray  * Return the principal of `id' in `principal'.
739c19800e8SDoug Rabson  *
740*ae771770SStanislav Sedov  * @return Return an error code or 0, see krb5_get_error_message().
741c19800e8SDoug Rabson  *
742c19800e8SDoug Rabson  * @ingroup krb5_ccache
743b528cefcSMark Murray  */
744b528cefcSMark Murray 
745c19800e8SDoug Rabson 
746*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_get_principal(krb5_context context,krb5_ccache id,krb5_principal * principal)747b528cefcSMark Murray krb5_cc_get_principal(krb5_context context,
748b528cefcSMark Murray 		      krb5_ccache id,
749b528cefcSMark Murray 		      krb5_principal *principal)
750b528cefcSMark Murray {
751c19800e8SDoug Rabson     return (*id->ops->get_princ)(context, id, principal);
752b528cefcSMark Murray }
753b528cefcSMark Murray 
754c19800e8SDoug Rabson /**
755b528cefcSMark Murray  * Start iterating over `id', `cursor' is initialized to the
756*ae771770SStanislav Sedov  * beginning.  Caller must free the cursor with krb5_cc_end_seq_get().
757c19800e8SDoug Rabson  *
758*ae771770SStanislav Sedov  * @return Return an error code or 0, see krb5_get_error_message().
759c19800e8SDoug Rabson  *
760c19800e8SDoug Rabson  * @ingroup krb5_ccache
761b528cefcSMark Murray  */
762b528cefcSMark Murray 
763c19800e8SDoug Rabson 
764*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_start_seq_get(krb5_context context,const krb5_ccache id,krb5_cc_cursor * cursor)765b528cefcSMark Murray krb5_cc_start_seq_get (krb5_context context,
766b528cefcSMark Murray 		       const krb5_ccache id,
767b528cefcSMark Murray 		       krb5_cc_cursor *cursor)
768b528cefcSMark Murray {
769c19800e8SDoug Rabson     return (*id->ops->get_first)(context, id, cursor);
770b528cefcSMark Murray }
771b528cefcSMark Murray 
772c19800e8SDoug Rabson /**
773b528cefcSMark Murray  * Retrieve the next cred pointed to by (`id', `cursor') in `creds'
774b528cefcSMark Murray  * and advance `cursor'.
775c19800e8SDoug Rabson  *
776*ae771770SStanislav Sedov  * @return Return an error code or 0, see krb5_get_error_message().
777c19800e8SDoug Rabson  *
778c19800e8SDoug Rabson  * @ingroup krb5_ccache
779b528cefcSMark Murray  */
780b528cefcSMark Murray 
781c19800e8SDoug Rabson 
782*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_next_cred(krb5_context context,const krb5_ccache id,krb5_cc_cursor * cursor,krb5_creds * creds)783b528cefcSMark Murray krb5_cc_next_cred (krb5_context context,
784b528cefcSMark Murray 		   const krb5_ccache id,
785adb0ddaeSAssar Westerlund 		   krb5_cc_cursor *cursor,
786adb0ddaeSAssar Westerlund 		   krb5_creds *creds)
787b528cefcSMark Murray {
788c19800e8SDoug Rabson     return (*id->ops->get_next)(context, id, cursor, creds);
789b528cefcSMark Murray }
790b528cefcSMark Murray 
791c19800e8SDoug Rabson /**
792c19800e8SDoug Rabson  * Destroy the cursor `cursor'.
793c19800e8SDoug Rabson  *
794c19800e8SDoug Rabson  * @ingroup krb5_ccache
795c19800e8SDoug Rabson  */
796c19800e8SDoug Rabson 
797c19800e8SDoug Rabson 
798*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_end_seq_get(krb5_context context,const krb5_ccache id,krb5_cc_cursor * cursor)799b528cefcSMark Murray krb5_cc_end_seq_get (krb5_context context,
800b528cefcSMark Murray 		     const krb5_ccache id,
801b528cefcSMark Murray 		     krb5_cc_cursor *cursor)
802b528cefcSMark Murray {
803c19800e8SDoug Rabson     return (*id->ops->end_get)(context, id, cursor);
804b528cefcSMark Murray }
805b528cefcSMark Murray 
806c19800e8SDoug Rabson /**
807b528cefcSMark Murray  * Remove the credential identified by `cred', `which' from `id'.
808c19800e8SDoug Rabson  *
809c19800e8SDoug Rabson  * @ingroup krb5_ccache
810b528cefcSMark Murray  */
811b528cefcSMark Murray 
812c19800e8SDoug Rabson 
813*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_remove_cred(krb5_context context,krb5_ccache id,krb5_flags which,krb5_creds * cred)814b528cefcSMark Murray krb5_cc_remove_cred(krb5_context context,
815b528cefcSMark Murray 		    krb5_ccache id,
816b528cefcSMark Murray 		    krb5_flags which,
817b528cefcSMark Murray 		    krb5_creds *cred)
818b528cefcSMark Murray {
819adb0ddaeSAssar Westerlund     if(id->ops->remove_cred == NULL) {
820*ae771770SStanislav Sedov 	krb5_set_error_message(context,
821*ae771770SStanislav Sedov 			       EACCES,
822adb0ddaeSAssar Westerlund 			       "ccache %s does not support remove_cred",
823adb0ddaeSAssar Westerlund 			       id->ops->prefix);
8245e9cd1aeSAssar Westerlund 	return EACCES; /* XXX */
825adb0ddaeSAssar Westerlund     }
8265e9cd1aeSAssar Westerlund     return (*id->ops->remove_cred)(context, id, which, cred);
827b528cefcSMark Murray }
828b528cefcSMark Murray 
829c19800e8SDoug Rabson /**
830b528cefcSMark Murray  * Set the flags of `id' to `flags'.
831c19800e8SDoug Rabson  *
832c19800e8SDoug Rabson  * @ingroup krb5_ccache
833b528cefcSMark Murray  */
834b528cefcSMark Murray 
835c19800e8SDoug Rabson 
836*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_set_flags(krb5_context context,krb5_ccache id,krb5_flags flags)837b528cefcSMark Murray krb5_cc_set_flags(krb5_context context,
838b528cefcSMark Murray 		  krb5_ccache id,
839b528cefcSMark Murray 		  krb5_flags flags)
840b528cefcSMark Murray {
841c19800e8SDoug Rabson     return (*id->ops->set_flags)(context, id, flags);
842b528cefcSMark Murray }
843b528cefcSMark Murray 
844c19800e8SDoug Rabson /**
845*ae771770SStanislav Sedov  * Get the flags of `id', store them in `flags'.
846c19800e8SDoug Rabson  *
847c19800e8SDoug Rabson  * @ingroup krb5_ccache
848b528cefcSMark Murray  */
849b528cefcSMark Murray 
850*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_get_flags(krb5_context context,krb5_ccache id,krb5_flags * flags)851*ae771770SStanislav Sedov krb5_cc_get_flags(krb5_context context,
852*ae771770SStanislav Sedov 		  krb5_ccache id,
853*ae771770SStanislav Sedov 		  krb5_flags *flags)
854*ae771770SStanislav Sedov {
855*ae771770SStanislav Sedov     *flags = 0;
856*ae771770SStanislav Sedov     return 0;
857*ae771770SStanislav Sedov }
858c19800e8SDoug Rabson 
859*ae771770SStanislav Sedov /**
860*ae771770SStanislav Sedov  * Copy the contents of `from' to `to' if the given match function
861*ae771770SStanislav Sedov  * return true.
862*ae771770SStanislav Sedov  *
863*ae771770SStanislav Sedov  * @param context A Kerberos 5 context.
864*ae771770SStanislav Sedov  * @param from the cache to copy data from.
865*ae771770SStanislav Sedov  * @param to the cache to copy data to.
866*ae771770SStanislav Sedov  * @param match a match function that should return TRUE if cred argument should be copied, if NULL, all credentials are copied.
867*ae771770SStanislav Sedov  * @param matchctx context passed to match function.
868*ae771770SStanislav Sedov  * @param matched set to true if there was a credential that matched, may be NULL.
869*ae771770SStanislav Sedov  *
870*ae771770SStanislav Sedov  * @return Return an error code or 0, see krb5_get_error_message().
871*ae771770SStanislav Sedov  *
872*ae771770SStanislav Sedov  * @ingroup krb5_ccache
873*ae771770SStanislav Sedov  */
874*ae771770SStanislav Sedov 
875*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_copy_match_f(krb5_context context,const krb5_ccache from,krb5_ccache to,krb5_boolean (* match)(krb5_context,void *,const krb5_creds *),void * matchctx,unsigned int * matched)876*ae771770SStanislav Sedov krb5_cc_copy_match_f(krb5_context context,
877b528cefcSMark Murray 		     const krb5_ccache from,
878c19800e8SDoug Rabson 		     krb5_ccache to,
879*ae771770SStanislav Sedov 		     krb5_boolean (*match)(krb5_context, void *, const krb5_creds *),
880*ae771770SStanislav Sedov 		     void *matchctx,
881c19800e8SDoug Rabson 		     unsigned int *matched)
882b528cefcSMark Murray {
883b528cefcSMark Murray     krb5_error_code ret;
884b528cefcSMark Murray     krb5_cc_cursor cursor;
885b528cefcSMark Murray     krb5_creds cred;
886b528cefcSMark Murray     krb5_principal princ;
887b528cefcSMark Murray 
888*ae771770SStanislav Sedov     if (matched)
889*ae771770SStanislav Sedov 	*matched = 0;
890*ae771770SStanislav Sedov 
891b528cefcSMark Murray     ret = krb5_cc_get_principal(context, from, &princ);
892b528cefcSMark Murray     if (ret)
893b528cefcSMark Murray 	return ret;
894b528cefcSMark Murray     ret = krb5_cc_initialize(context, to, princ);
895b528cefcSMark Murray     if (ret) {
896b528cefcSMark Murray 	krb5_free_principal(context, princ);
897b528cefcSMark Murray 	return ret;
898b528cefcSMark Murray     }
899b528cefcSMark Murray     ret = krb5_cc_start_seq_get(context, from, &cursor);
900b528cefcSMark Murray     if (ret) {
901b528cefcSMark Murray 	krb5_free_principal(context, princ);
902b528cefcSMark Murray 	return ret;
903b528cefcSMark Murray     }
904*ae771770SStanislav Sedov 
905*ae771770SStanislav Sedov     while ((ret = krb5_cc_next_cred(context, from, &cursor, &cred)) == 0) {
906*ae771770SStanislav Sedov 	   if (match == NULL || (*match)(context, matchctx, &cred) == 0) {
907c19800e8SDoug Rabson 	       if (matched)
908c19800e8SDoug Rabson 		   (*matched)++;
909b528cefcSMark Murray 	       ret = krb5_cc_store_cred(context, to, &cred);
910*ae771770SStanislav Sedov 	       if (ret)
911*ae771770SStanislav Sedov 		   break;
912*ae771770SStanislav Sedov 	   }
913c19800e8SDoug Rabson 	   krb5_free_cred_contents(context, &cred);
914b528cefcSMark Murray     }
915b528cefcSMark Murray     krb5_cc_end_seq_get(context, from, &cursor);
916b528cefcSMark Murray     krb5_free_principal(context, princ);
917*ae771770SStanislav Sedov     if (ret == KRB5_CC_END)
918*ae771770SStanislav Sedov 	ret = 0;
919b528cefcSMark Murray     return ret;
920b528cefcSMark Murray }
921b528cefcSMark Murray 
922c19800e8SDoug Rabson /**
923*ae771770SStanislav Sedov  * Just like krb5_cc_copy_match_f(), but copy everything.
924c19800e8SDoug Rabson  *
925*ae771770SStanislav Sedov  * @ingroup @krb5_ccache
926b528cefcSMark Murray  */
927b528cefcSMark Murray 
928*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_copy_cache(krb5_context context,const krb5_ccache from,krb5_ccache to)929c19800e8SDoug Rabson krb5_cc_copy_cache(krb5_context context,
930c19800e8SDoug Rabson 		   const krb5_ccache from,
931c19800e8SDoug Rabson 		   krb5_ccache to)
932c19800e8SDoug Rabson {
933*ae771770SStanislav Sedov     return krb5_cc_copy_match_f(context, from, to, NULL, NULL, NULL);
934c19800e8SDoug Rabson }
935c19800e8SDoug Rabson 
936c19800e8SDoug Rabson /**
937c19800e8SDoug Rabson  * Return the version of `id'.
938c19800e8SDoug Rabson  *
939c19800e8SDoug Rabson  * @ingroup krb5_ccache
940c19800e8SDoug Rabson  */
941c19800e8SDoug Rabson 
942c19800e8SDoug Rabson 
943*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_get_version(krb5_context context,const krb5_ccache id)944b528cefcSMark Murray krb5_cc_get_version(krb5_context context,
945b528cefcSMark Murray 		    const krb5_ccache id)
946b528cefcSMark Murray {
947b528cefcSMark Murray     if(id->ops->get_version)
948c19800e8SDoug Rabson 	return (*id->ops->get_version)(context, id);
949b528cefcSMark Murray     else
950b528cefcSMark Murray 	return 0;
951b528cefcSMark Murray }
952c19800e8SDoug Rabson 
953c19800e8SDoug Rabson /**
954c19800e8SDoug Rabson  * Clear `mcreds' so it can be used with krb5_cc_retrieve_cred
955c19800e8SDoug Rabson  *
956c19800e8SDoug Rabson  * @ingroup krb5_ccache
957c19800e8SDoug Rabson  */
958c19800e8SDoug Rabson 
959c19800e8SDoug Rabson 
960*ae771770SStanislav Sedov KRB5_LIB_FUNCTION void KRB5_LIB_CALL
krb5_cc_clear_mcred(krb5_creds * mcred)961c19800e8SDoug Rabson krb5_cc_clear_mcred(krb5_creds *mcred)
962c19800e8SDoug Rabson {
963c19800e8SDoug Rabson     memset(mcred, 0, sizeof(*mcred));
964c19800e8SDoug Rabson }
965c19800e8SDoug Rabson 
966c19800e8SDoug Rabson /**
967c19800e8SDoug Rabson  * Get the cc ops that is registered in `context' to handle the
968*ae771770SStanislav Sedov  * prefix. prefix can be a complete credential cache name or a
969c19800e8SDoug Rabson  * prefix, the function will only use part up to the first colon (:)
970*ae771770SStanislav Sedov  * if there is one. If prefix the argument is NULL, the default ccache
971*ae771770SStanislav Sedov  * implemtation is returned.
972*ae771770SStanislav Sedov  *
973*ae771770SStanislav Sedov  * @return Returns NULL if ops not found.
974c19800e8SDoug Rabson  *
975c19800e8SDoug Rabson  * @ingroup krb5_ccache
976c19800e8SDoug Rabson  */
977c19800e8SDoug Rabson 
978c19800e8SDoug Rabson 
979*ae771770SStanislav Sedov KRB5_LIB_FUNCTION const krb5_cc_ops * KRB5_LIB_CALL
krb5_cc_get_prefix_ops(krb5_context context,const char * prefix)980c19800e8SDoug Rabson krb5_cc_get_prefix_ops(krb5_context context, const char *prefix)
981c19800e8SDoug Rabson {
982c19800e8SDoug Rabson     char *p, *p1;
983c19800e8SDoug Rabson     int i;
984c19800e8SDoug Rabson 
985*ae771770SStanislav Sedov     if (prefix == NULL)
986*ae771770SStanislav Sedov 	return KRB5_DEFAULT_CCTYPE;
987c19800e8SDoug Rabson     if (prefix[0] == '/')
988c19800e8SDoug Rabson 	return &krb5_fcc_ops;
989c19800e8SDoug Rabson 
990c19800e8SDoug Rabson     p = strdup(prefix);
991c19800e8SDoug Rabson     if (p == NULL) {
992*ae771770SStanislav Sedov 	krb5_set_error_message(context, ENOMEM, N_("malloc: out of memory", ""));
993c19800e8SDoug Rabson 	return NULL;
994c19800e8SDoug Rabson     }
995c19800e8SDoug Rabson     p1 = strchr(p, ':');
996c19800e8SDoug Rabson     if (p1)
997c19800e8SDoug Rabson 	*p1 = '\0';
998c19800e8SDoug Rabson 
999*ae771770SStanislav Sedov     for(i = 0; i < context->num_cc_ops && context->cc_ops[i]->prefix; i++) {
1000*ae771770SStanislav Sedov 	if(strcmp(context->cc_ops[i]->prefix, p) == 0) {
1001c19800e8SDoug Rabson 	    free(p);
1002*ae771770SStanislav Sedov 	    return context->cc_ops[i];
1003c19800e8SDoug Rabson 	}
1004c19800e8SDoug Rabson     }
1005c19800e8SDoug Rabson     free(p);
1006c19800e8SDoug Rabson     return NULL;
1007c19800e8SDoug Rabson }
1008c19800e8SDoug Rabson 
1009c19800e8SDoug Rabson struct krb5_cc_cache_cursor_data {
1010c19800e8SDoug Rabson     const krb5_cc_ops *ops;
1011c19800e8SDoug Rabson     krb5_cc_cursor cursor;
1012c19800e8SDoug Rabson };
1013c19800e8SDoug Rabson 
1014c19800e8SDoug Rabson /**
1015*ae771770SStanislav Sedov  * Start iterating over all caches of specified type. See also
1016*ae771770SStanislav Sedov  * krb5_cccol_cursor_new().
1017*ae771770SStanislav Sedov 
1018*ae771770SStanislav Sedov  * @param context A Kerberos 5 context
1019*ae771770SStanislav Sedov  * @param type optional type to iterate over, if NULL, the default cache is used.
1020*ae771770SStanislav Sedov  * @param cursor cursor should be freed with krb5_cc_cache_end_seq_get().
1021c19800e8SDoug Rabson  *
1022*ae771770SStanislav Sedov  * @return Return an error code or 0, see krb5_get_error_message().
1023c19800e8SDoug Rabson  *
1024c19800e8SDoug Rabson  * @ingroup krb5_ccache
1025c19800e8SDoug Rabson  */
1026c19800e8SDoug Rabson 
1027c19800e8SDoug Rabson 
1028*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_cache_get_first(krb5_context context,const char * type,krb5_cc_cache_cursor * cursor)1029c19800e8SDoug Rabson krb5_cc_cache_get_first (krb5_context context,
1030c19800e8SDoug Rabson 			 const char *type,
1031c19800e8SDoug Rabson 			 krb5_cc_cache_cursor *cursor)
1032c19800e8SDoug Rabson {
1033c19800e8SDoug Rabson     const krb5_cc_ops *ops;
1034c19800e8SDoug Rabson     krb5_error_code ret;
1035c19800e8SDoug Rabson 
1036c19800e8SDoug Rabson     if (type == NULL)
1037c19800e8SDoug Rabson 	type = krb5_cc_default_name(context);
1038c19800e8SDoug Rabson 
1039c19800e8SDoug Rabson     ops = krb5_cc_get_prefix_ops(context, type);
1040c19800e8SDoug Rabson     if (ops == NULL) {
1041*ae771770SStanislav Sedov 	krb5_set_error_message(context, KRB5_CC_UNKNOWN_TYPE,
1042*ae771770SStanislav Sedov 			       "Unknown type \"%s\" when iterating "
1043c19800e8SDoug Rabson 			       "trying to iterate the credential caches", type);
1044c19800e8SDoug Rabson 	return KRB5_CC_UNKNOWN_TYPE;
1045c19800e8SDoug Rabson     }
1046c19800e8SDoug Rabson 
1047c19800e8SDoug Rabson     if (ops->get_cache_first == NULL) {
1048*ae771770SStanislav Sedov 	krb5_set_error_message(context, KRB5_CC_NOSUPP,
1049*ae771770SStanislav Sedov 			       N_("Credential cache type %s doesn't support "
1050*ae771770SStanislav Sedov 				 "iterations over caches", "type"),
1051*ae771770SStanislav Sedov 			       ops->prefix);
1052c19800e8SDoug Rabson 	return KRB5_CC_NOSUPP;
1053c19800e8SDoug Rabson     }
1054c19800e8SDoug Rabson 
1055c19800e8SDoug Rabson     *cursor = calloc(1, sizeof(**cursor));
1056c19800e8SDoug Rabson     if (*cursor == NULL) {
1057*ae771770SStanislav Sedov 	krb5_set_error_message(context, ENOMEM, N_("malloc: out of memory", ""));
1058c19800e8SDoug Rabson 	return ENOMEM;
1059c19800e8SDoug Rabson     }
1060c19800e8SDoug Rabson 
1061c19800e8SDoug Rabson     (*cursor)->ops = ops;
1062c19800e8SDoug Rabson 
1063c19800e8SDoug Rabson     ret = ops->get_cache_first(context, &(*cursor)->cursor);
1064c19800e8SDoug Rabson     if (ret) {
1065c19800e8SDoug Rabson 	free(*cursor);
1066c19800e8SDoug Rabson 	*cursor = NULL;
1067c19800e8SDoug Rabson     }
1068c19800e8SDoug Rabson     return ret;
1069c19800e8SDoug Rabson }
1070c19800e8SDoug Rabson 
1071c19800e8SDoug Rabson /**
1072c19800e8SDoug Rabson  * Retrieve the next cache pointed to by (`cursor') in `id'
1073c19800e8SDoug Rabson  * and advance `cursor'.
1074c19800e8SDoug Rabson  *
1075*ae771770SStanislav Sedov  * @param context A Kerberos 5 context
1076*ae771770SStanislav Sedov  * @param cursor the iterator cursor, returned by krb5_cc_cache_get_first()
1077*ae771770SStanislav Sedov  * @param id next ccache
1078*ae771770SStanislav Sedov  *
1079*ae771770SStanislav Sedov  * @return Return 0 or an error code. Returns KRB5_CC_END when the end
1080*ae771770SStanislav Sedov  *         of caches is reached, see krb5_get_error_message().
1081c19800e8SDoug Rabson  *
1082c19800e8SDoug Rabson  * @ingroup krb5_ccache
1083c19800e8SDoug Rabson  */
1084c19800e8SDoug Rabson 
1085c19800e8SDoug Rabson 
1086*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_cache_next(krb5_context context,krb5_cc_cache_cursor cursor,krb5_ccache * id)1087c19800e8SDoug Rabson krb5_cc_cache_next (krb5_context context,
1088c19800e8SDoug Rabson 		   krb5_cc_cache_cursor cursor,
1089c19800e8SDoug Rabson 		   krb5_ccache *id)
1090c19800e8SDoug Rabson {
1091c19800e8SDoug Rabson     return cursor->ops->get_cache_next(context, cursor->cursor, id);
1092c19800e8SDoug Rabson }
1093c19800e8SDoug Rabson 
1094c19800e8SDoug Rabson /**
1095c19800e8SDoug Rabson  * Destroy the cursor `cursor'.
1096c19800e8SDoug Rabson  *
1097*ae771770SStanislav Sedov  * @return Return an error code or 0, see krb5_get_error_message().
1098c19800e8SDoug Rabson  *
1099c19800e8SDoug Rabson  * @ingroup krb5_ccache
1100c19800e8SDoug Rabson  */
1101c19800e8SDoug Rabson 
1102c19800e8SDoug Rabson 
1103*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_cache_end_seq_get(krb5_context context,krb5_cc_cache_cursor cursor)1104c19800e8SDoug Rabson krb5_cc_cache_end_seq_get (krb5_context context,
1105c19800e8SDoug Rabson 			   krb5_cc_cache_cursor cursor)
1106c19800e8SDoug Rabson {
1107c19800e8SDoug Rabson     krb5_error_code ret;
1108c19800e8SDoug Rabson     ret = cursor->ops->end_cache_get(context, cursor->cursor);
1109c19800e8SDoug Rabson     cursor->ops = NULL;
1110c19800e8SDoug Rabson     free(cursor);
1111c19800e8SDoug Rabson     return ret;
1112c19800e8SDoug Rabson }
1113c19800e8SDoug Rabson 
1114c19800e8SDoug Rabson /**
1115*ae771770SStanislav Sedov  * Search for a matching credential cache that have the
1116*ae771770SStanislav Sedov  * `principal' as the default principal. On success, `id' needs to be
1117*ae771770SStanislav Sedov  * freed with krb5_cc_close() or krb5_cc_destroy().
1118*ae771770SStanislav Sedov  *
1119*ae771770SStanislav Sedov  * @param context A Kerberos 5 context
1120*ae771770SStanislav Sedov  * @param client The principal to search for
1121*ae771770SStanislav Sedov  * @param id the returned credential cache
1122c19800e8SDoug Rabson  *
1123c19800e8SDoug Rabson  * @return On failure, error code is returned and `id' is set to NULL.
1124c19800e8SDoug Rabson  *
1125c19800e8SDoug Rabson  * @ingroup krb5_ccache
1126c19800e8SDoug Rabson  */
1127c19800e8SDoug Rabson 
1128c19800e8SDoug Rabson 
1129*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_cache_match(krb5_context context,krb5_principal client,krb5_ccache * id)1130c19800e8SDoug Rabson krb5_cc_cache_match (krb5_context context,
1131c19800e8SDoug Rabson 		     krb5_principal client,
1132c19800e8SDoug Rabson 		     krb5_ccache *id)
1133c19800e8SDoug Rabson {
1134*ae771770SStanislav Sedov     krb5_cccol_cursor cursor;
1135c19800e8SDoug Rabson     krb5_error_code ret;
1136c19800e8SDoug Rabson     krb5_ccache cache = NULL;
1137c19800e8SDoug Rabson 
1138c19800e8SDoug Rabson     *id = NULL;
1139c19800e8SDoug Rabson 
1140*ae771770SStanislav Sedov     ret = krb5_cccol_cursor_new (context, &cursor);
1141c19800e8SDoug Rabson     if (ret)
1142c19800e8SDoug Rabson 	return ret;
1143c19800e8SDoug Rabson 
1144*ae771770SStanislav Sedov     while (krb5_cccol_cursor_next (context, cursor, &cache) == 0 && cache != NULL) {
1145c19800e8SDoug Rabson 	krb5_principal principal;
1146c19800e8SDoug Rabson 
1147c19800e8SDoug Rabson 	ret = krb5_cc_get_principal(context, cache, &principal);
1148c19800e8SDoug Rabson 	if (ret == 0) {
1149c19800e8SDoug Rabson 	    krb5_boolean match;
1150c19800e8SDoug Rabson 
1151c19800e8SDoug Rabson 	    match = krb5_principal_compare(context, principal, client);
1152c19800e8SDoug Rabson 	    krb5_free_principal(context, principal);
1153c19800e8SDoug Rabson 	    if (match)
1154c19800e8SDoug Rabson 		break;
1155c19800e8SDoug Rabson 	}
1156c19800e8SDoug Rabson 
1157c19800e8SDoug Rabson 	krb5_cc_close(context, cache);
1158c19800e8SDoug Rabson 	cache = NULL;
1159c19800e8SDoug Rabson     }
1160c19800e8SDoug Rabson 
1161*ae771770SStanislav Sedov     krb5_cccol_cursor_free(context, &cursor);
1162c19800e8SDoug Rabson 
1163c19800e8SDoug Rabson     if (cache == NULL) {
1164c19800e8SDoug Rabson 	char *str;
1165c19800e8SDoug Rabson 
1166c19800e8SDoug Rabson 	krb5_unparse_name(context, client, &str);
1167c19800e8SDoug Rabson 
1168*ae771770SStanislav Sedov 	krb5_set_error_message(context, KRB5_CC_NOTFOUND,
1169*ae771770SStanislav Sedov 			       N_("Principal %s not found in any "
1170*ae771770SStanislav Sedov 				  "credential cache", ""),
1171*ae771770SStanislav Sedov 			       str ? str : "<out of memory>");
1172c19800e8SDoug Rabson 	if (str)
1173c19800e8SDoug Rabson 	    free(str);
1174c19800e8SDoug Rabson 	return KRB5_CC_NOTFOUND;
1175c19800e8SDoug Rabson     }
1176c19800e8SDoug Rabson     *id = cache;
1177c19800e8SDoug Rabson 
1178c19800e8SDoug Rabson     return 0;
1179c19800e8SDoug Rabson }
1180c19800e8SDoug Rabson 
1181c19800e8SDoug Rabson /**
1182c19800e8SDoug Rabson  * Move the content from one credential cache to another. The
1183c19800e8SDoug Rabson  * operation is an atomic switch.
1184c19800e8SDoug Rabson  *
1185c19800e8SDoug Rabson  * @param context a Keberos context
1186c19800e8SDoug Rabson  * @param from the credential cache to move the content from
1187c19800e8SDoug Rabson  * @param to the credential cache to move the content to
1188c19800e8SDoug Rabson 
1189c19800e8SDoug Rabson  * @return On sucess, from is freed. On failure, error code is
1190*ae771770SStanislav Sedov  * returned and from and to are both still allocated, see krb5_get_error_message().
1191c19800e8SDoug Rabson  *
1192c19800e8SDoug Rabson  * @ingroup krb5_ccache
1193c19800e8SDoug Rabson  */
1194c19800e8SDoug Rabson 
1195*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_move(krb5_context context,krb5_ccache from,krb5_ccache to)1196c19800e8SDoug Rabson krb5_cc_move(krb5_context context, krb5_ccache from, krb5_ccache to)
1197c19800e8SDoug Rabson {
1198c19800e8SDoug Rabson     krb5_error_code ret;
1199c19800e8SDoug Rabson 
1200c19800e8SDoug Rabson     if (strcmp(from->ops->prefix, to->ops->prefix) != 0) {
1201*ae771770SStanislav Sedov 	krb5_set_error_message(context, KRB5_CC_NOSUPP,
1202*ae771770SStanislav Sedov 			       N_("Moving credentials between diffrent "
1203*ae771770SStanislav Sedov 				 "types not yet supported", ""));
1204c19800e8SDoug Rabson 	return KRB5_CC_NOSUPP;
1205c19800e8SDoug Rabson     }
1206c19800e8SDoug Rabson 
1207c19800e8SDoug Rabson     ret = (*to->ops->move)(context, from, to);
1208c19800e8SDoug Rabson     if (ret == 0) {
1209c19800e8SDoug Rabson 	memset(from, 0, sizeof(*from));
1210c19800e8SDoug Rabson 	free(from);
1211c19800e8SDoug Rabson     }
1212c19800e8SDoug Rabson     return ret;
1213c19800e8SDoug Rabson }
1214*ae771770SStanislav Sedov 
1215*ae771770SStanislav Sedov #define KRB5_CONF_NAME "krb5_ccache_conf_data"
1216*ae771770SStanislav Sedov #define KRB5_REALM_NAME "X-CACHECONF:"
1217*ae771770SStanislav Sedov 
1218*ae771770SStanislav Sedov static krb5_error_code
build_conf_principals(krb5_context context,krb5_ccache id,krb5_const_principal principal,const char * name,krb5_creds * cred)1219*ae771770SStanislav Sedov build_conf_principals(krb5_context context, krb5_ccache id,
1220*ae771770SStanislav Sedov 		      krb5_const_principal principal,
1221*ae771770SStanislav Sedov 		      const char *name, krb5_creds *cred)
1222*ae771770SStanislav Sedov {
1223*ae771770SStanislav Sedov     krb5_principal client;
1224*ae771770SStanislav Sedov     krb5_error_code ret;
1225*ae771770SStanislav Sedov     char *pname = NULL;
1226*ae771770SStanislav Sedov 
1227*ae771770SStanislav Sedov     memset(cred, 0, sizeof(*cred));
1228*ae771770SStanislav Sedov 
1229*ae771770SStanislav Sedov     ret = krb5_cc_get_principal(context, id, &client);
1230*ae771770SStanislav Sedov     if (ret)
1231*ae771770SStanislav Sedov 	return ret;
1232*ae771770SStanislav Sedov 
1233*ae771770SStanislav Sedov     if (principal) {
1234*ae771770SStanislav Sedov 	ret = krb5_unparse_name(context, principal, &pname);
1235*ae771770SStanislav Sedov 	if (ret)
1236*ae771770SStanislav Sedov 	    return ret;
1237*ae771770SStanislav Sedov     }
1238*ae771770SStanislav Sedov 
1239*ae771770SStanislav Sedov     ret = krb5_make_principal(context, &cred->server,
1240*ae771770SStanislav Sedov 			      KRB5_REALM_NAME,
1241*ae771770SStanislav Sedov 			      KRB5_CONF_NAME, name, pname, NULL);
1242*ae771770SStanislav Sedov     free(pname);
1243*ae771770SStanislav Sedov     if (ret) {
1244*ae771770SStanislav Sedov 	krb5_free_principal(context, client);
1245*ae771770SStanislav Sedov 	return ret;
1246*ae771770SStanislav Sedov     }
1247*ae771770SStanislav Sedov     ret = krb5_copy_principal(context, client, &cred->client);
1248*ae771770SStanislav Sedov     krb5_free_principal(context, client);
1249*ae771770SStanislav Sedov     return ret;
1250*ae771770SStanislav Sedov }
1251*ae771770SStanislav Sedov 
1252*ae771770SStanislav Sedov /**
1253*ae771770SStanislav Sedov  * Return TRUE (non zero) if the principal is a configuration
1254*ae771770SStanislav Sedov  * principal (generated part of krb5_cc_set_config()). Returns FALSE
1255*ae771770SStanislav Sedov  * (zero) if not a configuration principal.
1256*ae771770SStanislav Sedov  *
1257*ae771770SStanislav Sedov  * @param context a Keberos context
1258*ae771770SStanislav Sedov  * @param principal principal to check if it a configuration principal
1259*ae771770SStanislav Sedov  *
1260*ae771770SStanislav Sedov  * @ingroup krb5_ccache
1261*ae771770SStanislav Sedov  */
1262*ae771770SStanislav Sedov 
1263*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL
krb5_is_config_principal(krb5_context context,krb5_const_principal principal)1264*ae771770SStanislav Sedov krb5_is_config_principal(krb5_context context,
1265*ae771770SStanislav Sedov 			 krb5_const_principal principal)
1266*ae771770SStanislav Sedov {
1267*ae771770SStanislav Sedov     if (strcmp(principal->realm, KRB5_REALM_NAME) != 0)
1268*ae771770SStanislav Sedov 	return FALSE;
1269*ae771770SStanislav Sedov 
1270*ae771770SStanislav Sedov     if (principal->name.name_string.len == 0 ||
1271*ae771770SStanislav Sedov 	strcmp(principal->name.name_string.val[0], KRB5_CONF_NAME) != 0)
1272*ae771770SStanislav Sedov 	return FALSE;
1273*ae771770SStanislav Sedov 
1274*ae771770SStanislav Sedov     return TRUE;
1275*ae771770SStanislav Sedov }
1276*ae771770SStanislav Sedov 
1277*ae771770SStanislav Sedov /**
1278*ae771770SStanislav Sedov  * Store some configuration for the credential cache in the cache.
1279*ae771770SStanislav Sedov  * Existing configuration under the same name is over-written.
1280*ae771770SStanislav Sedov  *
1281*ae771770SStanislav Sedov  * @param context a Keberos context
1282*ae771770SStanislav Sedov  * @param id the credential cache to store the data for
1283*ae771770SStanislav Sedov  * @param principal configuration for a specific principal, if
1284*ae771770SStanislav Sedov  * NULL, global for the whole cache.
1285*ae771770SStanislav Sedov  * @param name name under which the configuraion is stored.
1286*ae771770SStanislav Sedov  * @param data data to store, if NULL, configure is removed.
1287*ae771770SStanislav Sedov  *
1288*ae771770SStanislav Sedov  * @ingroup krb5_ccache
1289*ae771770SStanislav Sedov  */
1290*ae771770SStanislav Sedov 
1291*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_set_config(krb5_context context,krb5_ccache id,krb5_const_principal principal,const char * name,krb5_data * data)1292*ae771770SStanislav Sedov krb5_cc_set_config(krb5_context context, krb5_ccache id,
1293*ae771770SStanislav Sedov 		   krb5_const_principal principal,
1294*ae771770SStanislav Sedov 		   const char *name, krb5_data *data)
1295*ae771770SStanislav Sedov {
1296*ae771770SStanislav Sedov     krb5_error_code ret;
1297*ae771770SStanislav Sedov     krb5_creds cred;
1298*ae771770SStanislav Sedov 
1299*ae771770SStanislav Sedov     ret = build_conf_principals(context, id, principal, name, &cred);
1300*ae771770SStanislav Sedov     if (ret)
1301*ae771770SStanislav Sedov 	goto out;
1302*ae771770SStanislav Sedov 
1303*ae771770SStanislav Sedov     /* Remove old configuration */
1304*ae771770SStanislav Sedov     ret = krb5_cc_remove_cred(context, id, 0, &cred);
1305*ae771770SStanislav Sedov     if (ret && ret != KRB5_CC_NOTFOUND)
1306*ae771770SStanislav Sedov         goto out;
1307*ae771770SStanislav Sedov 
1308*ae771770SStanislav Sedov     if (data) {
1309*ae771770SStanislav Sedov 	/* not that anyone care when this expire */
1310*ae771770SStanislav Sedov 	cred.times.authtime = time(NULL);
1311*ae771770SStanislav Sedov 	cred.times.endtime = cred.times.authtime + 3600 * 24 * 30;
1312*ae771770SStanislav Sedov 
1313*ae771770SStanislav Sedov 	ret = krb5_data_copy(&cred.ticket, data->data, data->length);
1314*ae771770SStanislav Sedov 	if (ret)
1315*ae771770SStanislav Sedov 	    goto out;
1316*ae771770SStanislav Sedov 
1317*ae771770SStanislav Sedov 	ret = krb5_cc_store_cred(context, id, &cred);
1318*ae771770SStanislav Sedov     }
1319*ae771770SStanislav Sedov 
1320*ae771770SStanislav Sedov out:
1321*ae771770SStanislav Sedov     krb5_free_cred_contents (context, &cred);
1322*ae771770SStanislav Sedov     return ret;
1323*ae771770SStanislav Sedov }
1324*ae771770SStanislav Sedov 
1325*ae771770SStanislav Sedov /**
1326*ae771770SStanislav Sedov  * Get some configuration for the credential cache in the cache.
1327*ae771770SStanislav Sedov  *
1328*ae771770SStanislav Sedov  * @param context a Keberos context
1329*ae771770SStanislav Sedov  * @param id the credential cache to store the data for
1330*ae771770SStanislav Sedov  * @param principal configuration for a specific principal, if
1331*ae771770SStanislav Sedov  * NULL, global for the whole cache.
1332*ae771770SStanislav Sedov  * @param name name under which the configuraion is stored.
1333*ae771770SStanislav Sedov  * @param data data to fetched, free with krb5_data_free()
1334*ae771770SStanislav Sedov  *
1335*ae771770SStanislav Sedov  * @ingroup krb5_ccache
1336*ae771770SStanislav Sedov  */
1337*ae771770SStanislav Sedov 
1338*ae771770SStanislav Sedov 
1339*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_get_config(krb5_context context,krb5_ccache id,krb5_const_principal principal,const char * name,krb5_data * data)1340*ae771770SStanislav Sedov krb5_cc_get_config(krb5_context context, krb5_ccache id,
1341*ae771770SStanislav Sedov 		   krb5_const_principal principal,
1342*ae771770SStanislav Sedov 		   const char *name, krb5_data *data)
1343*ae771770SStanislav Sedov {
1344*ae771770SStanislav Sedov     krb5_creds mcred, cred;
1345*ae771770SStanislav Sedov     krb5_error_code ret;
1346*ae771770SStanislav Sedov 
1347*ae771770SStanislav Sedov     memset(&cred, 0, sizeof(cred));
1348*ae771770SStanislav Sedov     krb5_data_zero(data);
1349*ae771770SStanislav Sedov 
1350*ae771770SStanislav Sedov     ret = build_conf_principals(context, id, principal, name, &mcred);
1351*ae771770SStanislav Sedov     if (ret)
1352*ae771770SStanislav Sedov 	goto out;
1353*ae771770SStanislav Sedov 
1354*ae771770SStanislav Sedov     ret = krb5_cc_retrieve_cred(context, id, 0, &mcred, &cred);
1355*ae771770SStanislav Sedov     if (ret)
1356*ae771770SStanislav Sedov 	goto out;
1357*ae771770SStanislav Sedov 
1358*ae771770SStanislav Sedov     ret = krb5_data_copy(data, cred.ticket.data, cred.ticket.length);
1359*ae771770SStanislav Sedov 
1360*ae771770SStanislav Sedov out:
1361*ae771770SStanislav Sedov     krb5_free_cred_contents (context, &cred);
1362*ae771770SStanislav Sedov     krb5_free_cred_contents (context, &mcred);
1363*ae771770SStanislav Sedov     return ret;
1364*ae771770SStanislav Sedov }
1365*ae771770SStanislav Sedov 
1366*ae771770SStanislav Sedov /*
1367*ae771770SStanislav Sedov  *
1368*ae771770SStanislav Sedov  */
1369*ae771770SStanislav Sedov 
1370*ae771770SStanislav Sedov struct krb5_cccol_cursor_data {
1371*ae771770SStanislav Sedov     int idx;
1372*ae771770SStanislav Sedov     krb5_cc_cache_cursor cursor;
1373*ae771770SStanislav Sedov };
1374*ae771770SStanislav Sedov 
1375*ae771770SStanislav Sedov /**
1376*ae771770SStanislav Sedov  * Get a new cache interation cursor that will interate over all
1377*ae771770SStanislav Sedov  * credentials caches independent of type.
1378*ae771770SStanislav Sedov  *
1379*ae771770SStanislav Sedov  * @param context a Keberos context
1380*ae771770SStanislav Sedov  * @param cursor passed into krb5_cccol_cursor_next() and free with krb5_cccol_cursor_free().
1381*ae771770SStanislav Sedov  *
1382*ae771770SStanislav Sedov  * @return Returns 0 or and error code, see krb5_get_error_message().
1383*ae771770SStanislav Sedov  *
1384*ae771770SStanislav Sedov  * @ingroup krb5_ccache
1385*ae771770SStanislav Sedov  */
1386*ae771770SStanislav Sedov 
1387*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cccol_cursor_new(krb5_context context,krb5_cccol_cursor * cursor)1388*ae771770SStanislav Sedov krb5_cccol_cursor_new(krb5_context context, krb5_cccol_cursor *cursor)
1389*ae771770SStanislav Sedov {
1390*ae771770SStanislav Sedov     *cursor = calloc(1, sizeof(**cursor));
1391*ae771770SStanislav Sedov     if (*cursor == NULL) {
1392*ae771770SStanislav Sedov 	krb5_set_error_message(context, ENOMEM, N_("malloc: out of memory", ""));
1393*ae771770SStanislav Sedov 	return ENOMEM;
1394*ae771770SStanislav Sedov     }
1395*ae771770SStanislav Sedov     (*cursor)->idx = 0;
1396*ae771770SStanislav Sedov     (*cursor)->cursor = NULL;
1397*ae771770SStanislav Sedov 
1398*ae771770SStanislav Sedov     return 0;
1399*ae771770SStanislav Sedov }
1400*ae771770SStanislav Sedov 
1401*ae771770SStanislav Sedov /**
1402*ae771770SStanislav Sedov  * Get next credential cache from the iteration.
1403*ae771770SStanislav Sedov  *
1404*ae771770SStanislav Sedov  * @param context A Kerberos 5 context
1405*ae771770SStanislav Sedov  * @param cursor the iteration cursor
1406*ae771770SStanislav Sedov  * @param cache the returned cursor, pointer is set to NULL on failure
1407*ae771770SStanislav Sedov  *        and a cache on success. The returned cache needs to be freed
1408*ae771770SStanislav Sedov  *        with krb5_cc_close() or destroyed with krb5_cc_destroy().
1409*ae771770SStanislav Sedov  *        MIT Kerberos behavies slightly diffrent and sets cache to NULL
1410*ae771770SStanislav Sedov  *        when all caches are iterated over and return 0.
1411*ae771770SStanislav Sedov  *
1412*ae771770SStanislav Sedov  * @return Return 0 or and error, KRB5_CC_END is returned at the end
1413*ae771770SStanislav Sedov  *        of iteration. See krb5_get_error_message().
1414*ae771770SStanislav Sedov  *
1415*ae771770SStanislav Sedov  * @ingroup krb5_ccache
1416*ae771770SStanislav Sedov  */
1417*ae771770SStanislav Sedov 
1418*ae771770SStanislav Sedov 
1419*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cccol_cursor_next(krb5_context context,krb5_cccol_cursor cursor,krb5_ccache * cache)1420*ae771770SStanislav Sedov krb5_cccol_cursor_next(krb5_context context, krb5_cccol_cursor cursor,
1421*ae771770SStanislav Sedov 		       krb5_ccache *cache)
1422*ae771770SStanislav Sedov {
1423*ae771770SStanislav Sedov     krb5_error_code ret;
1424*ae771770SStanislav Sedov 
1425*ae771770SStanislav Sedov     *cache = NULL;
1426*ae771770SStanislav Sedov 
1427*ae771770SStanislav Sedov     while (cursor->idx < context->num_cc_ops) {
1428*ae771770SStanislav Sedov 
1429*ae771770SStanislav Sedov 	if (cursor->cursor == NULL) {
1430*ae771770SStanislav Sedov 	    ret = krb5_cc_cache_get_first (context,
1431*ae771770SStanislav Sedov 					   context->cc_ops[cursor->idx]->prefix,
1432*ae771770SStanislav Sedov 					   &cursor->cursor);
1433*ae771770SStanislav Sedov 	    if (ret) {
1434*ae771770SStanislav Sedov 		cursor->idx++;
1435*ae771770SStanislav Sedov 		continue;
1436*ae771770SStanislav Sedov 	    }
1437*ae771770SStanislav Sedov 	}
1438*ae771770SStanislav Sedov 	ret = krb5_cc_cache_next(context, cursor->cursor, cache);
1439*ae771770SStanislav Sedov 	if (ret == 0)
1440*ae771770SStanislav Sedov 	    break;
1441*ae771770SStanislav Sedov 
1442*ae771770SStanislav Sedov 	krb5_cc_cache_end_seq_get(context, cursor->cursor);
1443*ae771770SStanislav Sedov 	cursor->cursor = NULL;
1444*ae771770SStanislav Sedov 	if (ret != KRB5_CC_END)
1445*ae771770SStanislav Sedov 	    break;
1446*ae771770SStanislav Sedov 
1447*ae771770SStanislav Sedov 	cursor->idx++;
1448*ae771770SStanislav Sedov     }
1449*ae771770SStanislav Sedov     if (cursor->idx >= context->num_cc_ops) {
1450*ae771770SStanislav Sedov 	krb5_set_error_message(context, KRB5_CC_END,
1451*ae771770SStanislav Sedov 			       N_("Reached end of credential caches", ""));
1452*ae771770SStanislav Sedov 	return KRB5_CC_END;
1453*ae771770SStanislav Sedov     }
1454*ae771770SStanislav Sedov 
1455*ae771770SStanislav Sedov     return 0;
1456*ae771770SStanislav Sedov }
1457*ae771770SStanislav Sedov 
1458*ae771770SStanislav Sedov /**
1459*ae771770SStanislav Sedov  * End an iteration and free all resources, can be done before end is reached.
1460*ae771770SStanislav Sedov  *
1461*ae771770SStanislav Sedov  * @param context A Kerberos 5 context
1462*ae771770SStanislav Sedov  * @param cursor the iteration cursor to be freed.
1463*ae771770SStanislav Sedov  *
1464*ae771770SStanislav Sedov  * @return Return 0 or and error, KRB5_CC_END is returned at the end
1465*ae771770SStanislav Sedov  *        of iteration. See krb5_get_error_message().
1466*ae771770SStanislav Sedov  *
1467*ae771770SStanislav Sedov  * @ingroup krb5_ccache
1468*ae771770SStanislav Sedov  */
1469*ae771770SStanislav Sedov 
1470*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cccol_cursor_free(krb5_context context,krb5_cccol_cursor * cursor)1471*ae771770SStanislav Sedov krb5_cccol_cursor_free(krb5_context context, krb5_cccol_cursor *cursor)
1472*ae771770SStanislav Sedov {
1473*ae771770SStanislav Sedov     krb5_cccol_cursor c = *cursor;
1474*ae771770SStanislav Sedov 
1475*ae771770SStanislav Sedov     *cursor = NULL;
1476*ae771770SStanislav Sedov     if (c) {
1477*ae771770SStanislav Sedov 	if (c->cursor)
1478*ae771770SStanislav Sedov 	    krb5_cc_cache_end_seq_get(context, c->cursor);
1479*ae771770SStanislav Sedov 	free(c);
1480*ae771770SStanislav Sedov     }
1481*ae771770SStanislav Sedov     return 0;
1482*ae771770SStanislav Sedov }
1483*ae771770SStanislav Sedov 
1484*ae771770SStanislav Sedov /**
1485*ae771770SStanislav Sedov  * Return the last time the credential cache was modified.
1486*ae771770SStanislav Sedov  *
1487*ae771770SStanislav Sedov  * @param context A Kerberos 5 context
1488*ae771770SStanislav Sedov  * @param id The credential cache to probe
1489*ae771770SStanislav Sedov  * @param mtime the last modification time, set to 0 on error.
1490*ae771770SStanislav Sedov 
1491*ae771770SStanislav Sedov  * @return Return 0 or and error. See krb5_get_error_message().
1492*ae771770SStanislav Sedov  *
1493*ae771770SStanislav Sedov  * @ingroup krb5_ccache
1494*ae771770SStanislav Sedov  */
1495*ae771770SStanislav Sedov 
1496*ae771770SStanislav Sedov 
1497*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_last_change_time(krb5_context context,krb5_ccache id,krb5_timestamp * mtime)1498*ae771770SStanislav Sedov krb5_cc_last_change_time(krb5_context context,
1499*ae771770SStanislav Sedov 			 krb5_ccache id,
1500*ae771770SStanislav Sedov 			 krb5_timestamp *mtime)
1501*ae771770SStanislav Sedov {
1502*ae771770SStanislav Sedov     *mtime = 0;
1503*ae771770SStanislav Sedov     return (*id->ops->lastchange)(context, id, mtime);
1504*ae771770SStanislav Sedov }
1505*ae771770SStanislav Sedov 
1506*ae771770SStanislav Sedov /**
1507*ae771770SStanislav Sedov  * Return the last modfication time for a cache collection. The query
1508*ae771770SStanislav Sedov  * can be limited to a specific cache type. If the function return 0
1509*ae771770SStanislav Sedov  * and mtime is 0, there was no credentials in the caches.
1510*ae771770SStanislav Sedov  *
1511*ae771770SStanislav Sedov  * @param context A Kerberos 5 context
1512*ae771770SStanislav Sedov  * @param type The credential cache to probe, if NULL, all type are traversed.
1513*ae771770SStanislav Sedov  * @param mtime the last modification time, set to 0 on error.
1514*ae771770SStanislav Sedov 
1515*ae771770SStanislav Sedov  * @return Return 0 or and error. See krb5_get_error_message().
1516*ae771770SStanislav Sedov  *
1517*ae771770SStanislav Sedov  * @ingroup krb5_ccache
1518*ae771770SStanislav Sedov  */
1519*ae771770SStanislav Sedov 
1520*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cccol_last_change_time(krb5_context context,const char * type,krb5_timestamp * mtime)1521*ae771770SStanislav Sedov krb5_cccol_last_change_time(krb5_context context,
1522*ae771770SStanislav Sedov 			    const char *type,
1523*ae771770SStanislav Sedov 			    krb5_timestamp *mtime)
1524*ae771770SStanislav Sedov {
1525*ae771770SStanislav Sedov     krb5_cccol_cursor cursor;
1526*ae771770SStanislav Sedov     krb5_error_code ret;
1527*ae771770SStanislav Sedov     krb5_ccache id;
1528*ae771770SStanislav Sedov     krb5_timestamp t = 0;
1529*ae771770SStanislav Sedov 
1530*ae771770SStanislav Sedov     *mtime = 0;
1531*ae771770SStanislav Sedov 
1532*ae771770SStanislav Sedov     ret = krb5_cccol_cursor_new (context, &cursor);
1533*ae771770SStanislav Sedov     if (ret)
1534*ae771770SStanislav Sedov 	return ret;
1535*ae771770SStanislav Sedov 
1536*ae771770SStanislav Sedov     while (krb5_cccol_cursor_next(context, cursor, &id) == 0 && id != NULL) {
1537*ae771770SStanislav Sedov 
1538*ae771770SStanislav Sedov 	if (type && strcmp(krb5_cc_get_type(context, id), type) != 0)
1539*ae771770SStanislav Sedov 	    continue;
1540*ae771770SStanislav Sedov 
1541*ae771770SStanislav Sedov 	ret = krb5_cc_last_change_time(context, id, &t);
1542*ae771770SStanislav Sedov 	krb5_cc_close(context, id);
1543*ae771770SStanislav Sedov 	if (ret)
1544*ae771770SStanislav Sedov 	    continue;
1545*ae771770SStanislav Sedov 	if (t > *mtime)
1546*ae771770SStanislav Sedov 	    *mtime = t;
1547*ae771770SStanislav Sedov     }
1548*ae771770SStanislav Sedov 
1549*ae771770SStanislav Sedov     krb5_cccol_cursor_free(context, &cursor);
1550*ae771770SStanislav Sedov 
1551*ae771770SStanislav Sedov     return 0;
1552*ae771770SStanislav Sedov }
1553*ae771770SStanislav Sedov /**
1554*ae771770SStanislav Sedov  * Return a friendly name on credential cache. Free the result with krb5_xfree().
1555*ae771770SStanislav Sedov  *
1556*ae771770SStanislav Sedov  * @return Return an error code or 0, see krb5_get_error_message().
1557*ae771770SStanislav Sedov  *
1558*ae771770SStanislav Sedov  * @ingroup krb5_ccache
1559*ae771770SStanislav Sedov  */
1560*ae771770SStanislav Sedov 
1561*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_get_friendly_name(krb5_context context,krb5_ccache id,char ** name)1562*ae771770SStanislav Sedov krb5_cc_get_friendly_name(krb5_context context,
1563*ae771770SStanislav Sedov 			  krb5_ccache id,
1564*ae771770SStanislav Sedov 			  char **name)
1565*ae771770SStanislav Sedov {
1566*ae771770SStanislav Sedov     krb5_error_code ret;
1567*ae771770SStanislav Sedov     krb5_data data;
1568*ae771770SStanislav Sedov 
1569*ae771770SStanislav Sedov     ret = krb5_cc_get_config(context, id, NULL, "FriendlyName", &data);
1570*ae771770SStanislav Sedov     if (ret) {
1571*ae771770SStanislav Sedov 	krb5_principal principal;
1572*ae771770SStanislav Sedov 	ret = krb5_cc_get_principal(context, id, &principal);
1573*ae771770SStanislav Sedov 	if (ret)
1574*ae771770SStanislav Sedov 	    return ret;
1575*ae771770SStanislav Sedov 	ret = krb5_unparse_name(context, principal, name);
1576*ae771770SStanislav Sedov 	krb5_free_principal(context, principal);
1577*ae771770SStanislav Sedov     } else {
1578*ae771770SStanislav Sedov 	ret = asprintf(name, "%.*s", (int)data.length, (char *)data.data);
1579*ae771770SStanislav Sedov 	krb5_data_free(&data);
1580*ae771770SStanislav Sedov 	if (ret <= 0) {
1581*ae771770SStanislav Sedov 	    ret = ENOMEM;
1582*ae771770SStanislav Sedov 	    krb5_set_error_message(context, ret, N_("malloc: out of memory", ""));
1583*ae771770SStanislav Sedov 	} else
1584*ae771770SStanislav Sedov 	    ret = 0;
1585*ae771770SStanislav Sedov     }
1586*ae771770SStanislav Sedov 
1587*ae771770SStanislav Sedov     return ret;
1588*ae771770SStanislav Sedov }
1589*ae771770SStanislav Sedov 
1590*ae771770SStanislav Sedov /**
1591*ae771770SStanislav Sedov  * Set the friendly name on credential cache.
1592*ae771770SStanislav Sedov  *
1593*ae771770SStanislav Sedov  * @return Return an error code or 0, see krb5_get_error_message().
1594*ae771770SStanislav Sedov  *
1595*ae771770SStanislav Sedov  * @ingroup krb5_ccache
1596*ae771770SStanislav Sedov  */
1597*ae771770SStanislav Sedov 
1598*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_set_friendly_name(krb5_context context,krb5_ccache id,const char * name)1599*ae771770SStanislav Sedov krb5_cc_set_friendly_name(krb5_context context,
1600*ae771770SStanislav Sedov 			  krb5_ccache id,
1601*ae771770SStanislav Sedov 			  const char *name)
1602*ae771770SStanislav Sedov {
1603*ae771770SStanislav Sedov     krb5_data data;
1604*ae771770SStanislav Sedov 
1605*ae771770SStanislav Sedov     data.data = rk_UNCONST(name);
1606*ae771770SStanislav Sedov     data.length = strlen(name);
1607*ae771770SStanislav Sedov 
1608*ae771770SStanislav Sedov     return krb5_cc_set_config(context, id, NULL, "FriendlyName", &data);
1609*ae771770SStanislav Sedov }
1610*ae771770SStanislav Sedov 
1611*ae771770SStanislav Sedov /**
1612*ae771770SStanislav Sedov  * Get the lifetime of the initial ticket in the cache
1613*ae771770SStanislav Sedov  *
1614*ae771770SStanislav Sedov  * Get the lifetime of the initial ticket in the cache, if the initial
1615*ae771770SStanislav Sedov  * ticket was not found, the error code KRB5_CC_END is returned.
1616*ae771770SStanislav Sedov  *
1617*ae771770SStanislav Sedov  * @param context A Kerberos 5 context.
1618*ae771770SStanislav Sedov  * @param id a credential cache
1619*ae771770SStanislav Sedov  * @param t the relative lifetime of the initial ticket
1620*ae771770SStanislav Sedov  *
1621*ae771770SStanislav Sedov  * @return Return an error code or 0, see krb5_get_error_message().
1622*ae771770SStanislav Sedov  *
1623*ae771770SStanislav Sedov  * @ingroup krb5_ccache
1624*ae771770SStanislav Sedov  */
1625*ae771770SStanislav Sedov 
1626*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_get_lifetime(krb5_context context,krb5_ccache id,time_t * t)1627*ae771770SStanislav Sedov krb5_cc_get_lifetime(krb5_context context, krb5_ccache id, time_t *t)
1628*ae771770SStanislav Sedov {
1629*ae771770SStanislav Sedov     krb5_cc_cursor cursor;
1630*ae771770SStanislav Sedov     krb5_error_code ret;
1631*ae771770SStanislav Sedov     krb5_creds cred;
1632*ae771770SStanislav Sedov     time_t now;
1633*ae771770SStanislav Sedov 
1634*ae771770SStanislav Sedov     *t = 0;
1635*ae771770SStanislav Sedov     now = time(NULL);
1636*ae771770SStanislav Sedov 
1637*ae771770SStanislav Sedov     ret = krb5_cc_start_seq_get(context, id, &cursor);
1638*ae771770SStanislav Sedov     if (ret)
1639*ae771770SStanislav Sedov 	return ret;
1640*ae771770SStanislav Sedov 
1641*ae771770SStanislav Sedov     while ((ret = krb5_cc_next_cred(context, id, &cursor, &cred)) == 0) {
1642*ae771770SStanislav Sedov 	if (cred.flags.b.initial) {
1643*ae771770SStanislav Sedov 	    if (now < cred.times.endtime)
1644*ae771770SStanislav Sedov 		*t = cred.times.endtime - now;
1645*ae771770SStanislav Sedov 	    krb5_free_cred_contents(context, &cred);
1646*ae771770SStanislav Sedov 	    break;
1647*ae771770SStanislav Sedov 	}
1648*ae771770SStanislav Sedov 	krb5_free_cred_contents(context, &cred);
1649*ae771770SStanislav Sedov     }
1650*ae771770SStanislav Sedov 
1651*ae771770SStanislav Sedov     krb5_cc_end_seq_get(context, id, &cursor);
1652*ae771770SStanislav Sedov 
1653*ae771770SStanislav Sedov     return ret;
1654*ae771770SStanislav Sedov }
1655*ae771770SStanislav Sedov 
1656*ae771770SStanislav Sedov /**
1657*ae771770SStanislav Sedov  * Set the time offset betwen the client and the KDC
1658*ae771770SStanislav Sedov  *
1659*ae771770SStanislav Sedov  * If the backend doesn't support KDC offset, use the context global setting.
1660*ae771770SStanislav Sedov  *
1661*ae771770SStanislav Sedov  * @param context A Kerberos 5 context.
1662*ae771770SStanislav Sedov  * @param id a credential cache
1663*ae771770SStanislav Sedov  * @param offset the offset in seconds
1664*ae771770SStanislav Sedov  *
1665*ae771770SStanislav Sedov  * @return Return an error code or 0, see krb5_get_error_message().
1666*ae771770SStanislav Sedov  *
1667*ae771770SStanislav Sedov  * @ingroup krb5_ccache
1668*ae771770SStanislav Sedov  */
1669*ae771770SStanislav Sedov 
1670*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_set_kdc_offset(krb5_context context,krb5_ccache id,krb5_deltat offset)1671*ae771770SStanislav Sedov krb5_cc_set_kdc_offset(krb5_context context, krb5_ccache id, krb5_deltat offset)
1672*ae771770SStanislav Sedov {
1673*ae771770SStanislav Sedov     if (id->ops->set_kdc_offset == NULL) {
1674*ae771770SStanislav Sedov 	context->kdc_sec_offset = offset;
1675*ae771770SStanislav Sedov 	context->kdc_usec_offset = 0;
1676*ae771770SStanislav Sedov 	return 0;
1677*ae771770SStanislav Sedov     }
1678*ae771770SStanislav Sedov     return (*id->ops->set_kdc_offset)(context, id, offset);
1679*ae771770SStanislav Sedov }
1680*ae771770SStanislav Sedov 
1681*ae771770SStanislav Sedov /**
1682*ae771770SStanislav Sedov  * Get the time offset betwen the client and the KDC
1683*ae771770SStanislav Sedov  *
1684*ae771770SStanislav Sedov  * If the backend doesn't support KDC offset, use the context global setting.
1685*ae771770SStanislav Sedov  *
1686*ae771770SStanislav Sedov  * @param context A Kerberos 5 context.
1687*ae771770SStanislav Sedov  * @param id a credential cache
1688*ae771770SStanislav Sedov  * @param offset the offset in seconds
1689*ae771770SStanislav Sedov  *
1690*ae771770SStanislav Sedov  * @return Return an error code or 0, see krb5_get_error_message().
1691*ae771770SStanislav Sedov  *
1692*ae771770SStanislav Sedov  * @ingroup krb5_ccache
1693*ae771770SStanislav Sedov  */
1694*ae771770SStanislav Sedov 
1695*ae771770SStanislav Sedov KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_cc_get_kdc_offset(krb5_context context,krb5_ccache id,krb5_deltat * offset)1696*ae771770SStanislav Sedov krb5_cc_get_kdc_offset(krb5_context context, krb5_ccache id, krb5_deltat *offset)
1697*ae771770SStanislav Sedov {
1698*ae771770SStanislav Sedov     if (id->ops->get_kdc_offset == NULL) {
1699*ae771770SStanislav Sedov 	*offset = context->kdc_sec_offset;
1700*ae771770SStanislav Sedov 	return 0;
1701*ae771770SStanislav Sedov     }
1702*ae771770SStanislav Sedov     return (*id->ops->get_kdc_offset)(context, id, offset);
1703*ae771770SStanislav Sedov }
1704*ae771770SStanislav Sedov 
1705*ae771770SStanislav Sedov 
1706*ae771770SStanislav Sedov #ifdef _WIN32
1707*ae771770SStanislav Sedov 
1708*ae771770SStanislav Sedov #define REGPATH_MIT_KRB5 "SOFTWARE\\MIT\\Kerberos5"
1709*ae771770SStanislav Sedov char *
_krb5_get_default_cc_name_from_registry(krb5_context context)1710*ae771770SStanislav Sedov _krb5_get_default_cc_name_from_registry(krb5_context context)
1711*ae771770SStanislav Sedov {
1712*ae771770SStanislav Sedov     HKEY hk_k5 = 0;
1713*ae771770SStanislav Sedov     LONG code;
1714*ae771770SStanislav Sedov     char * ccname = NULL;
1715*ae771770SStanislav Sedov 
1716*ae771770SStanislav Sedov     code = RegOpenKeyEx(HKEY_CURRENT_USER,
1717*ae771770SStanislav Sedov                         REGPATH_MIT_KRB5,
1718*ae771770SStanislav Sedov                         0, KEY_READ, &hk_k5);
1719*ae771770SStanislav Sedov 
1720*ae771770SStanislav Sedov     if (code != ERROR_SUCCESS)
1721*ae771770SStanislav Sedov         return NULL;
1722*ae771770SStanislav Sedov 
1723*ae771770SStanislav Sedov     ccname = _krb5_parse_reg_value_as_string(context, hk_k5, "ccname",
1724*ae771770SStanislav Sedov                                              REG_NONE, 0);
1725*ae771770SStanislav Sedov 
1726*ae771770SStanislav Sedov     RegCloseKey(hk_k5);
1727*ae771770SStanislav Sedov 
1728*ae771770SStanislav Sedov     return ccname;
1729*ae771770SStanislav Sedov }
1730*ae771770SStanislav Sedov 
1731*ae771770SStanislav Sedov int
_krb5_set_default_cc_name_to_registry(krb5_context context,krb5_ccache id)1732*ae771770SStanislav Sedov _krb5_set_default_cc_name_to_registry(krb5_context context, krb5_ccache id)
1733*ae771770SStanislav Sedov {
1734*ae771770SStanislav Sedov     HKEY hk_k5 = 0;
1735*ae771770SStanislav Sedov     LONG code;
1736*ae771770SStanislav Sedov     int ret = -1;
1737*ae771770SStanislav Sedov     char * ccname = NULL;
1738*ae771770SStanislav Sedov 
1739*ae771770SStanislav Sedov     code = RegOpenKeyEx(HKEY_CURRENT_USER,
1740*ae771770SStanislav Sedov                         REGPATH_MIT_KRB5,
1741*ae771770SStanislav Sedov                         0, KEY_READ|KEY_WRITE, &hk_k5);
1742*ae771770SStanislav Sedov 
1743*ae771770SStanislav Sedov     if (code != ERROR_SUCCESS)
1744*ae771770SStanislav Sedov         return -1;
1745*ae771770SStanislav Sedov 
1746*ae771770SStanislav Sedov     ret = asprintf(&ccname, "%s:%s", krb5_cc_get_type(context, id), krb5_cc_get_name(context, id));
1747*ae771770SStanislav Sedov     if (ret < 0)
1748*ae771770SStanislav Sedov         goto cleanup;
1749*ae771770SStanislav Sedov 
1750*ae771770SStanislav Sedov     ret = _krb5_store_string_to_reg_value(context, hk_k5, "ccname",
1751*ae771770SStanislav Sedov                                           REG_SZ, ccname, -1, 0);
1752*ae771770SStanislav Sedov 
1753*ae771770SStanislav Sedov   cleanup:
1754*ae771770SStanislav Sedov 
1755*ae771770SStanislav Sedov     if (ccname)
1756*ae771770SStanislav Sedov         free(ccname);
1757*ae771770SStanislav Sedov 
1758*ae771770SStanislav Sedov     RegCloseKey(hk_k5);
1759*ae771770SStanislav Sedov 
1760*ae771770SStanislav Sedov     return ret;
1761*ae771770SStanislav Sedov }
1762*ae771770SStanislav Sedov 
1763*ae771770SStanislav Sedov #endif
1764