2 * Copyright (c) 1997-2005 Kungliga Tekniska Högskolan
3 * (Royal Institute of Technology, Stockholm, Sweden).
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of the Institute nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 #include "krb5_locl.h"
39 * Add a new ccache type with operations `ops', overwriting any
40 * existing one if `override'.
41 * Return an error code or 0.
44 krb5_error_code KRB5_LIB_FUNCTION
45 krb5_cc_register(krb5_context context,
46 const krb5_cc_ops *ops,
47 krb5_boolean override)
51 for(i = 0; i < context->num_cc_ops && context->cc_ops[i].prefix; i++) {
52 if(strcmp(context->cc_ops[i].prefix, ops->prefix) == 0) {
54 krb5_set_error_string(context,
55 "ccache type %s already exists",
57 return KRB5_CC_TYPE_EXISTS;
62 if(i == context->num_cc_ops) {
63 krb5_cc_ops *o = realloc(context->cc_ops,
64 (context->num_cc_ops + 1) *
65 sizeof(*context->cc_ops));
67 krb5_set_error_string(context, "malloc: out of memory");
70 context->num_cc_ops++;
72 memset(context->cc_ops + i, 0,
73 (context->num_cc_ops - i) * sizeof(*context->cc_ops));
75 memcpy(&context->cc_ops[i], ops, sizeof(context->cc_ops[i]));
80 * Allocate the memory for a `id' and the that function table to
81 * `ops'. Returns 0 or and error code.
85 _krb5_cc_allocate(krb5_context context,
86 const krb5_cc_ops *ops,
91 p = malloc (sizeof(*p));
93 krb5_set_error_string(context, "malloc: out of memory");
103 * Allocate memory for a new ccache in `id' with operations `ops'
104 * and name `residual'.
105 * Return 0 or an error code.
108 static krb5_error_code
109 allocate_ccache (krb5_context context,
110 const krb5_cc_ops *ops,
111 const char *residual,
116 ret = _krb5_cc_allocate(context, ops, id);
119 ret = (*id)->ops->resolve(context, id, residual);
126 * Find and allocate a ccache in `id' from the specification in `residual'.
127 * If the ccache name doesn't contain any colon, interpret it as a file name.
128 * Return 0 or an error code.
131 krb5_error_code KRB5_LIB_FUNCTION
132 krb5_cc_resolve(krb5_context context,
138 for(i = 0; i < context->num_cc_ops && context->cc_ops[i].prefix; i++) {
139 size_t prefix_len = strlen(context->cc_ops[i].prefix);
141 if(strncmp(context->cc_ops[i].prefix, name, prefix_len) == 0
142 && name[prefix_len] == ':') {
143 return allocate_ccache (context, &context->cc_ops[i],
144 name + prefix_len + 1,
148 if (strchr (name, ':') == NULL)
149 return allocate_ccache (context, &krb5_fcc_ops, name, id);
151 krb5_set_error_string(context, "unknown ccache type %s", name);
152 return KRB5_CC_UNKNOWN_TYPE;
157 * Generate a new ccache of type `ops' in `id'.
158 * Return 0 or an error code.
161 krb5_error_code KRB5_LIB_FUNCTION
162 krb5_cc_gen_new(krb5_context context,
163 const krb5_cc_ops *ops,
168 ret = _krb5_cc_allocate(context, ops, id);
171 return (*id)->ops->gen_new(context, id);
175 * Generates a new unique ccache of `type` in `id'. If `type' is NULL,
176 * the library chooses the default credential cache type. The supplied
177 * `hint' (that can be NULL) is a string that the credential cache
178 * type can use to base the name of the credential on, this is to make
179 * its easier for the user to differentiate the credentials.
181 * Returns 0 or an error code.
184 krb5_error_code KRB5_LIB_FUNCTION
185 krb5_cc_new_unique(krb5_context context, const char *type,
186 const char *hint, krb5_ccache *id)
188 const krb5_cc_ops *ops;
193 ops = krb5_cc_get_prefix_ops(context, type);
195 krb5_set_error_string(context, "Credential cache type %s is unknown",
197 return KRB5_CC_UNKNOWN_TYPE;
200 return krb5_cc_gen_new(context, ops, id);
204 * Return the name of the ccache `id'
207 const char* KRB5_LIB_FUNCTION
208 krb5_cc_get_name(krb5_context context,
211 return id->ops->get_name(context, id);
215 * Return the type of the ccache `id'.
218 const char* KRB5_LIB_FUNCTION
219 krb5_cc_get_type(krb5_context context,
222 return id->ops->prefix;
226 * Return krb5_cc_ops of a the ccache `id'.
230 krb5_cc_get_ops(krb5_context context, krb5_ccache id)
236 * Expand variables in `str' into `res'
240 _krb5_expand_default_cc_name(krb5_context context, const char *str, char **res)
242 size_t tlen, len = 0;
243 char *tmp, *tmp2, *append;
247 while (str && *str) {
248 tmp = strstr(str, "%{");
249 if (tmp && tmp != str) {
250 append = malloc((tmp - str) + 1);
252 memcpy(append, str, tmp - str);
253 append[tmp - str] = '\0';
257 tmp2 = strchr(tmp, '}');
261 krb5_set_error_string(context, "variable missing }");
262 return KRB5_CONFIG_BADFORMAT;
264 if (strncasecmp(tmp, "%{uid}", 6) == 0)
265 asprintf(&append, "%u", (unsigned)getuid());
266 else if (strncasecmp(tmp, "%{null}", 7) == 0)
271 krb5_set_error_string(context,
272 "expand default cache unknown "
274 (int)(tmp2 - tmp) - 2, tmp + 2);
275 return KRB5_CONFIG_BADFORMAT;
279 append = strdup(str);
282 if (append == NULL) {
285 krb5_set_error_string(context, "malloc - out of memory");
289 tlen = strlen(append);
290 tmp = realloc(*res, len + tlen + 1);
294 krb5_set_error_string(context, "malloc - out of memory");
298 memcpy(*res + len, append, tlen + 1);
306 * Set the default cc name for `context' to `name'.
309 krb5_error_code KRB5_LIB_FUNCTION
310 krb5_cc_set_default_name(krb5_context context, const char *name)
312 krb5_error_code ret = 0;
316 const char *e = NULL;
319 e = getenv("KRB5CCNAME");
324 e = krb5_config_get_string(context, NULL, "libdefaults",
325 "default_cc_name", NULL);
327 ret = _krb5_expand_default_cc_name(context, e, &p);
333 asprintf(&p,"FILE:/tmp/krb5cc_%u", (unsigned)getuid());
338 krb5_set_error_string(context, "malloc - out of memory");
342 if (context->default_cc_name)
343 free(context->default_cc_name);
345 context->default_cc_name = p;
351 * Return a pointer to a context static string containing the default
355 const char* KRB5_LIB_FUNCTION
356 krb5_cc_default_name(krb5_context context)
358 if (context->default_cc_name == NULL)
359 krb5_cc_set_default_name(context, NULL);
361 return context->default_cc_name;
365 * Open the default ccache in `id'.
366 * Return 0 or an error code.
369 krb5_error_code KRB5_LIB_FUNCTION
370 krb5_cc_default(krb5_context context,
373 const char *p = krb5_cc_default_name(context);
376 krb5_set_error_string(context, "malloc - out of memory");
379 return krb5_cc_resolve(context, p, id);
383 * Create a new ccache in `id' for `primary_principal'.
384 * Return 0 or an error code.
387 krb5_error_code KRB5_LIB_FUNCTION
388 krb5_cc_initialize(krb5_context context,
390 krb5_principal primary_principal)
392 return id->ops->init(context, id, primary_principal);
397 * Remove the ccache `id'.
398 * Return 0 or an error code.
401 krb5_error_code KRB5_LIB_FUNCTION
402 krb5_cc_destroy(krb5_context context,
407 ret = id->ops->destroy(context, id);
408 krb5_cc_close (context, id);
413 * Stop using the ccache `id' and free the related resources.
414 * Return 0 or an error code.
417 krb5_error_code KRB5_LIB_FUNCTION
418 krb5_cc_close(krb5_context context,
422 ret = id->ops->close(context, id);
428 * Store `creds' in the ccache `id'.
429 * Return 0 or an error code.
432 krb5_error_code KRB5_LIB_FUNCTION
433 krb5_cc_store_cred(krb5_context context,
437 return id->ops->store(context, id, creds);
441 * Retrieve the credential identified by `mcreds' (and `whichfields')
442 * from `id' in `creds'.
443 * Return 0 or an error code.
446 krb5_error_code KRB5_LIB_FUNCTION
447 krb5_cc_retrieve_cred(krb5_context context,
449 krb5_flags whichfields,
450 const krb5_creds *mcreds,
454 krb5_cc_cursor cursor;
456 if (id->ops->retrieve != NULL) {
457 return id->ops->retrieve(context, id, whichfields,
461 krb5_cc_start_seq_get(context, id, &cursor);
462 while((ret = krb5_cc_next_cred(context, id, &cursor, creds)) == 0){
463 if(krb5_compare_creds(context, whichfields, mcreds, creds)){
467 krb5_free_cred_contents (context, creds);
469 krb5_cc_end_seq_get(context, id, &cursor);
474 * Return the principal of `id' in `principal'.
475 * Return 0 or an error code.
478 krb5_error_code KRB5_LIB_FUNCTION
479 krb5_cc_get_principal(krb5_context context,
481 krb5_principal *principal)
483 return id->ops->get_princ(context, id, principal);
487 * Start iterating over `id', `cursor' is initialized to the
489 * Return 0 or an error code.
492 krb5_error_code KRB5_LIB_FUNCTION
493 krb5_cc_start_seq_get (krb5_context context,
494 const krb5_ccache id,
495 krb5_cc_cursor *cursor)
497 return id->ops->get_first(context, id, cursor);
501 * Retrieve the next cred pointed to by (`id', `cursor') in `creds'
502 * and advance `cursor'.
503 * Return 0 or an error code.
506 krb5_error_code KRB5_LIB_FUNCTION
507 krb5_cc_next_cred (krb5_context context,
508 const krb5_ccache id,
509 krb5_cc_cursor *cursor,
512 return id->ops->get_next(context, id, cursor, creds);
515 /* like krb5_cc_next_cred, but allow for selective retrieval */
517 krb5_error_code KRB5_LIB_FUNCTION
518 krb5_cc_next_cred_match(krb5_context context,
519 const krb5_ccache id,
520 krb5_cc_cursor * cursor,
522 krb5_flags whichfields,
523 const krb5_creds * mcreds)
527 ret = krb5_cc_next_cred(context, id, cursor, creds);
530 if (mcreds == NULL || krb5_compare_creds(context, whichfields, mcreds, creds))
532 krb5_free_cred_contents(context, creds);
537 * Destroy the cursor `cursor'.
540 krb5_error_code KRB5_LIB_FUNCTION
541 krb5_cc_end_seq_get (krb5_context context,
542 const krb5_ccache id,
543 krb5_cc_cursor *cursor)
545 return id->ops->end_get(context, id, cursor);
549 * Remove the credential identified by `cred', `which' from `id'.
552 krb5_error_code KRB5_LIB_FUNCTION
553 krb5_cc_remove_cred(krb5_context context,
558 if(id->ops->remove_cred == NULL) {
559 krb5_set_error_string(context,
560 "ccache %s does not support remove_cred",
562 return EACCES; /* XXX */
564 return (*id->ops->remove_cred)(context, id, which, cred);
568 * Set the flags of `id' to `flags'.
571 krb5_error_code KRB5_LIB_FUNCTION
572 krb5_cc_set_flags(krb5_context context,
576 return id->ops->set_flags(context, id, flags);
580 * Copy the contents of `from' to `to'.
583 krb5_error_code KRB5_LIB_FUNCTION
584 krb5_cc_copy_cache_match(krb5_context context,
585 const krb5_ccache from,
587 krb5_flags whichfields,
588 const krb5_creds * mcreds,
589 unsigned int *matched)
592 krb5_cc_cursor cursor;
594 krb5_principal princ;
596 ret = krb5_cc_get_principal(context, from, &princ);
599 ret = krb5_cc_initialize(context, to, princ);
601 krb5_free_principal(context, princ);
604 ret = krb5_cc_start_seq_get(context, from, &cursor);
606 krb5_free_principal(context, princ);
612 krb5_cc_next_cred_match(context, from, &cursor, &cred,
613 whichfields, mcreds) == 0) {
616 ret = krb5_cc_store_cred(context, to, &cred);
617 krb5_free_cred_contents(context, &cred);
619 krb5_cc_end_seq_get(context, from, &cursor);
620 krb5_free_principal(context, princ);
624 krb5_error_code KRB5_LIB_FUNCTION
625 krb5_cc_copy_cache(krb5_context context,
626 const krb5_ccache from,
629 return krb5_cc_copy_cache_match(context, from, to, 0, NULL, NULL);
633 * Return the version of `id'.
636 krb5_error_code KRB5_LIB_FUNCTION
637 krb5_cc_get_version(krb5_context context,
638 const krb5_ccache id)
640 if(id->ops->get_version)
641 return id->ops->get_version(context, id);
647 * Clear `mcreds' so it can be used with krb5_cc_retrieve_cred
650 void KRB5_LIB_FUNCTION
651 krb5_cc_clear_mcred(krb5_creds *mcred)
653 memset(mcred, 0, sizeof(*mcred));
657 * Get the cc ops that is registered in `context' to handle the
658 * `prefix'. `prefix' can be a complete credential cache name or a
659 * prefix, the function will only use part up to the first colon (:)
660 * if there is one. Returns NULL if ops not found.
664 krb5_cc_get_prefix_ops(krb5_context context, const char *prefix)
671 krb5_set_error_string(context, "malloc - out of memory");
678 for(i = 0; i < context->num_cc_ops && context->cc_ops[i].prefix; i++) {
679 if(strcmp(context->cc_ops[i].prefix, p) == 0) {
681 return &context->cc_ops[i];
688 struct krb5_cc_cache_cursor_data {
689 const krb5_cc_ops *ops;
690 krb5_cc_cursor cursor;
694 * Start iterating over all caches of `type'. If `type' is NULL, the
695 * default type is * used. `cursor' is initialized to the beginning.
696 * Return 0 or an error code.
699 krb5_error_code KRB5_LIB_FUNCTION
700 krb5_cc_cache_get_first (krb5_context context,
702 krb5_cc_cache_cursor *cursor)
704 const krb5_cc_ops *ops;
708 type = krb5_cc_default_name(context);
710 ops = krb5_cc_get_prefix_ops(context, type);
712 krb5_set_error_string(context, "Unknown type \"%s\" when iterating "
713 "trying to iterate the credential caches", type);
714 return KRB5_CC_UNKNOWN_TYPE;
717 if (ops->get_cache_first == NULL) {
718 krb5_set_error_string(context, "Credential cache type %s doesn't support "
719 "iterations over caches", ops->prefix);
720 return KRB5_CC_NOSUPP;
723 *cursor = calloc(1, sizeof(**cursor));
724 if (*cursor == NULL) {
725 krb5_set_error_string(context, "malloc - out of memory");
729 (*cursor)->ops = ops;
731 ret = ops->get_cache_first(context, &(*cursor)->cursor);
740 * Retrieve the next cache pointed to by (`cursor') in `id'
741 * and advance `cursor'.
742 * Return 0 or an error code.
745 krb5_error_code KRB5_LIB_FUNCTION
746 krb5_cc_cache_next (krb5_context context,
747 krb5_cc_cache_cursor cursor,
750 return cursor->ops->get_cache_next(context, cursor->cursor, id);
754 * Destroy the cursor `cursor'.
757 krb5_error_code KRB5_LIB_FUNCTION
758 krb5_cc_cache_end_seq_get (krb5_context context,
759 krb5_cc_cache_cursor cursor)
762 ret = cursor->ops->end_cache_get(context, cursor->cursor);