2 * Copyright (c) 1997 - 2007 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"
36 RCSID("$Id: cache.c 22127 2007-12-04 00:54:37Z lha $");
39 * Add a new ccache type with operations `ops', overwriting any
40 * existing one if `override'.
42 * @param context a Keberos context
43 * @param ops type of plugin symbol
44 * @param override flag to select if the registration is to overide
45 * an existing ops with the same name.
47 * @return Return an error code or 0.
49 * @ingroup krb5_ccache
52 krb5_error_code KRB5_LIB_FUNCTION
53 krb5_cc_register(krb5_context context,
54 const krb5_cc_ops *ops,
55 krb5_boolean override)
59 for(i = 0; i < context->num_cc_ops && context->cc_ops[i].prefix; i++) {
60 if(strcmp(context->cc_ops[i].prefix, ops->prefix) == 0) {
62 krb5_set_error_string(context,
63 "ccache type %s already exists",
65 return KRB5_CC_TYPE_EXISTS;
70 if(i == context->num_cc_ops) {
71 krb5_cc_ops *o = realloc(context->cc_ops,
72 (context->num_cc_ops + 1) *
73 sizeof(*context->cc_ops));
75 krb5_set_error_string(context, "malloc: out of memory");
78 context->num_cc_ops++;
80 memset(context->cc_ops + i, 0,
81 (context->num_cc_ops - i) * sizeof(*context->cc_ops));
83 memcpy(&context->cc_ops[i], ops, sizeof(context->cc_ops[i]));
88 * Allocate the memory for a `id' and the that function table to
89 * `ops'. Returns 0 or and error code.
93 _krb5_cc_allocate(krb5_context context,
94 const krb5_cc_ops *ops,
99 p = malloc (sizeof(*p));
101 krb5_set_error_string(context, "malloc: out of memory");
102 return KRB5_CC_NOMEM;
111 * Allocate memory for a new ccache in `id' with operations `ops'
112 * and name `residual'. Return 0 or an error code.
115 static krb5_error_code
116 allocate_ccache (krb5_context context,
117 const krb5_cc_ops *ops,
118 const char *residual,
123 ret = _krb5_cc_allocate(context, ops, id);
126 ret = (*id)->ops->resolve(context, id, residual);
133 * Find and allocate a ccache in `id' from the specification in `residual'.
134 * If the ccache name doesn't contain any colon, interpret it as a file name.
136 * @param context a Keberos context.
137 * @param name string name of a credential cache.
138 * @param id return pointer to a found credential cache.
140 * @return Return 0 or an error code. In case of an error, id is set
143 * @ingroup krb5_ccache
147 krb5_error_code KRB5_LIB_FUNCTION
148 krb5_cc_resolve(krb5_context context,
156 for(i = 0; i < context->num_cc_ops && context->cc_ops[i].prefix; i++) {
157 size_t prefix_len = strlen(context->cc_ops[i].prefix);
159 if(strncmp(context->cc_ops[i].prefix, name, prefix_len) == 0
160 && name[prefix_len] == ':') {
161 return allocate_ccache (context, &context->cc_ops[i],
162 name + prefix_len + 1,
166 if (strchr (name, ':') == NULL)
167 return allocate_ccache (context, &krb5_fcc_ops, name, id);
169 krb5_set_error_string(context, "unknown ccache type %s", name);
170 return KRB5_CC_UNKNOWN_TYPE;
175 * Generate a new ccache of type `ops' in `id'.
177 * @return Return 0 or an error code.
179 * @ingroup krb5_ccache
183 krb5_error_code KRB5_LIB_FUNCTION
184 krb5_cc_gen_new(krb5_context context,
185 const krb5_cc_ops *ops,
188 return krb5_cc_new_unique(context, ops->prefix, NULL, id);
192 * Generates a new unique ccache of `type` in `id'. If `type' is NULL,
193 * the library chooses the default credential cache type. The supplied
194 * `hint' (that can be NULL) is a string that the credential cache
195 * type can use to base the name of the credential on, this is to make
196 * it easier for the user to differentiate the credentials.
198 * @return Returns 0 or an error code.
200 * @ingroup krb5_ccache
203 krb5_error_code KRB5_LIB_FUNCTION
204 krb5_cc_new_unique(krb5_context context, const char *type,
205 const char *hint, krb5_ccache *id)
207 const krb5_cc_ops *ops = KRB5_DEFAULT_CCTYPE;
211 ops = krb5_cc_get_prefix_ops(context, type);
213 krb5_set_error_string(context,
214 "Credential cache type %s is unknown", type);
215 return KRB5_CC_UNKNOWN_TYPE;
219 ret = _krb5_cc_allocate(context, ops, id);
222 return (*id)->ops->gen_new(context, id);
226 * Return the name of the ccache `id'
228 * @ingroup krb5_ccache
232 const char* KRB5_LIB_FUNCTION
233 krb5_cc_get_name(krb5_context context,
236 return id->ops->get_name(context, id);
240 * Return the type of the ccache `id'.
242 * @ingroup krb5_ccache
246 const char* KRB5_LIB_FUNCTION
247 krb5_cc_get_type(krb5_context context,
250 return id->ops->prefix;
254 * Return the complete resolvable name the ccache `id' in `str´.
255 * `str` should be freed with free(3).
256 * Returns 0 or an error (and then *str is set to NULL).
258 * @ingroup krb5_ccache
262 krb5_error_code KRB5_LIB_FUNCTION
263 krb5_cc_get_full_name(krb5_context context,
267 const char *type, *name;
271 type = krb5_cc_get_type(context, id);
273 krb5_set_error_string(context, "cache have no name of type");
274 return KRB5_CC_UNKNOWN_TYPE;
277 name = krb5_cc_get_name(context, id);
279 krb5_set_error_string(context, "cache of type %s have no name", type);
280 return KRB5_CC_BADNAME;
283 if (asprintf(str, "%s:%s", type, name) == -1) {
284 krb5_set_error_string(context, "malloc - out of memory");
292 * Return krb5_cc_ops of a the ccache `id'.
294 * @ingroup krb5_ccache
299 krb5_cc_get_ops(krb5_context context, krb5_ccache id)
305 * Expand variables in `str' into `res'
309 _krb5_expand_default_cc_name(krb5_context context, const char *str, char **res)
311 size_t tlen, len = 0;
312 char *tmp, *tmp2, *append;
316 while (str && *str) {
317 tmp = strstr(str, "%{");
318 if (tmp && tmp != str) {
319 append = malloc((tmp - str) + 1);
321 memcpy(append, str, tmp - str);
322 append[tmp - str] = '\0';
326 tmp2 = strchr(tmp, '}');
330 krb5_set_error_string(context, "variable missing }");
331 return KRB5_CONFIG_BADFORMAT;
333 if (strncasecmp(tmp, "%{uid}", 6) == 0)
334 asprintf(&append, "%u", (unsigned)getuid());
335 else if (strncasecmp(tmp, "%{null}", 7) == 0)
340 krb5_set_error_string(context,
341 "expand default cache unknown "
343 (int)(tmp2 - tmp) - 2, tmp + 2);
344 return KRB5_CONFIG_BADFORMAT;
348 append = strdup(str);
351 if (append == NULL) {
354 krb5_set_error_string(context, "malloc - out of memory");
358 tlen = strlen(append);
359 tmp = realloc(*res, len + tlen + 1);
364 krb5_set_error_string(context, "malloc - out of memory");
368 memcpy(*res + len, append, tlen + 1);
376 * Return non-zero if envirnoment that will determine default krb5cc
381 environment_changed(krb5_context context)
385 /* if the cc name was set, don't change it */
386 if (context->default_cc_name_set)
392 e = getenv("KRB5CCNAME");
394 if (context->default_cc_name_env) {
395 free(context->default_cc_name_env);
396 context->default_cc_name_env = NULL;
400 if (context->default_cc_name_env == NULL)
402 if (strcmp(e, context->default_cc_name_env) != 0)
409 * Set the default cc name for `context' to `name'.
411 * @ingroup krb5_ccache
415 krb5_error_code KRB5_LIB_FUNCTION
416 krb5_cc_set_default_name(krb5_context context, const char *name)
418 krb5_error_code ret = 0;
422 const char *e = NULL;
425 e = getenv("KRB5CCNAME");
428 if (context->default_cc_name_env)
429 free(context->default_cc_name_env);
430 context->default_cc_name_env = strdup(e);
434 e = krb5_config_get_string(context, NULL, "libdefaults",
435 "default_cc_name", NULL);
437 ret = _krb5_expand_default_cc_name(context, e, &p);
442 const krb5_cc_ops *ops = KRB5_DEFAULT_CCTYPE;
443 ret = (*ops->default_name)(context, &p);
448 context->default_cc_name_set = 0;
451 context->default_cc_name_set = 1;
455 krb5_set_error_string(context, "malloc - out of memory");
459 if (context->default_cc_name)
460 free(context->default_cc_name);
462 context->default_cc_name = p;
468 * Return a pointer to a context static string containing the default
471 * @return String to the default credential cache name.
473 * @ingroup krb5_ccache
477 const char* KRB5_LIB_FUNCTION
478 krb5_cc_default_name(krb5_context context)
480 if (context->default_cc_name == NULL || environment_changed(context))
481 krb5_cc_set_default_name(context, NULL);
483 return context->default_cc_name;
487 * Open the default ccache in `id'.
489 * @return Return 0 or an error code.
491 * @ingroup krb5_ccache
495 krb5_error_code KRB5_LIB_FUNCTION
496 krb5_cc_default(krb5_context context,
499 const char *p = krb5_cc_default_name(context);
502 krb5_set_error_string(context, "malloc - out of memory");
505 return krb5_cc_resolve(context, p, id);
509 * Create a new ccache in `id' for `primary_principal'.
511 * @return Return 0 or an error code.
513 * @ingroup krb5_ccache
517 krb5_error_code KRB5_LIB_FUNCTION
518 krb5_cc_initialize(krb5_context context,
520 krb5_principal primary_principal)
522 return (*id->ops->init)(context, id, primary_principal);
527 * Remove the ccache `id'.
529 * @return Return 0 or an error code.
531 * @ingroup krb5_ccache
535 krb5_error_code KRB5_LIB_FUNCTION
536 krb5_cc_destroy(krb5_context context,
541 ret = (*id->ops->destroy)(context, id);
542 krb5_cc_close (context, id);
547 * Stop using the ccache `id' and free the related resources.
549 * @return Return 0 or an error code.
551 * @ingroup krb5_ccache
555 krb5_error_code KRB5_LIB_FUNCTION
556 krb5_cc_close(krb5_context context,
560 ret = (*id->ops->close)(context, id);
566 * Store `creds' in the ccache `id'.
568 * @return Return 0 or an error code.
570 * @ingroup krb5_ccache
574 krb5_error_code KRB5_LIB_FUNCTION
575 krb5_cc_store_cred(krb5_context context,
579 return (*id->ops->store)(context, id, creds);
583 * Retrieve the credential identified by `mcreds' (and `whichfields')
584 * from `id' in `creds'. 'creds' must be free by the caller using
585 * krb5_free_cred_contents.
587 * @return Return 0 or an error code.
589 * @ingroup krb5_ccache
593 krb5_error_code KRB5_LIB_FUNCTION
594 krb5_cc_retrieve_cred(krb5_context context,
596 krb5_flags whichfields,
597 const krb5_creds *mcreds,
601 krb5_cc_cursor cursor;
603 if (id->ops->retrieve != NULL) {
604 return (*id->ops->retrieve)(context, id, whichfields,
608 ret = krb5_cc_start_seq_get(context, id, &cursor);
611 while((ret = krb5_cc_next_cred(context, id, &cursor, creds)) == 0){
612 if(krb5_compare_creds(context, whichfields, mcreds, creds)){
616 krb5_free_cred_contents (context, creds);
618 krb5_cc_end_seq_get(context, id, &cursor);
623 * Return the principal of `id' in `principal'.
625 * @return Return 0 or an error code.
627 * @ingroup krb5_ccache
631 krb5_error_code KRB5_LIB_FUNCTION
632 krb5_cc_get_principal(krb5_context context,
634 krb5_principal *principal)
636 return (*id->ops->get_princ)(context, id, principal);
640 * Start iterating over `id', `cursor' is initialized to the
643 * @return Return 0 or an error code.
645 * @ingroup krb5_ccache
649 krb5_error_code KRB5_LIB_FUNCTION
650 krb5_cc_start_seq_get (krb5_context context,
651 const krb5_ccache id,
652 krb5_cc_cursor *cursor)
654 return (*id->ops->get_first)(context, id, cursor);
658 * Retrieve the next cred pointed to by (`id', `cursor') in `creds'
659 * and advance `cursor'.
661 * @return Return 0 or an error code.
663 * @ingroup krb5_ccache
667 krb5_error_code KRB5_LIB_FUNCTION
668 krb5_cc_next_cred (krb5_context context,
669 const krb5_ccache id,
670 krb5_cc_cursor *cursor,
673 return (*id->ops->get_next)(context, id, cursor, creds);
677 * Like krb5_cc_next_cred, but allow for selective retrieval
679 * @ingroup krb5_ccache
683 krb5_error_code KRB5_LIB_FUNCTION
684 krb5_cc_next_cred_match(krb5_context context,
685 const krb5_ccache id,
686 krb5_cc_cursor * cursor,
688 krb5_flags whichfields,
689 const krb5_creds * mcreds)
693 ret = krb5_cc_next_cred(context, id, cursor, creds);
696 if (mcreds == NULL || krb5_compare_creds(context, whichfields, mcreds, creds))
698 krb5_free_cred_contents(context, creds);
703 * Destroy the cursor `cursor'.
705 * @ingroup krb5_ccache
709 krb5_error_code KRB5_LIB_FUNCTION
710 krb5_cc_end_seq_get (krb5_context context,
711 const krb5_ccache id,
712 krb5_cc_cursor *cursor)
714 return (*id->ops->end_get)(context, id, cursor);
718 * Remove the credential identified by `cred', `which' from `id'.
720 * @ingroup krb5_ccache
724 krb5_error_code KRB5_LIB_FUNCTION
725 krb5_cc_remove_cred(krb5_context context,
730 if(id->ops->remove_cred == NULL) {
731 krb5_set_error_string(context,
732 "ccache %s does not support remove_cred",
734 return EACCES; /* XXX */
736 return (*id->ops->remove_cred)(context, id, which, cred);
740 * Set the flags of `id' to `flags'.
742 * @ingroup krb5_ccache
746 krb5_error_code KRB5_LIB_FUNCTION
747 krb5_cc_set_flags(krb5_context context,
751 return (*id->ops->set_flags)(context, id, flags);
755 * Copy the contents of `from' to `to'.
757 * @ingroup krb5_ccache
761 krb5_error_code KRB5_LIB_FUNCTION
762 krb5_cc_copy_cache_match(krb5_context context,
763 const krb5_ccache from,
765 krb5_flags whichfields,
766 const krb5_creds * mcreds,
767 unsigned int *matched)
770 krb5_cc_cursor cursor;
772 krb5_principal princ;
774 ret = krb5_cc_get_principal(context, from, &princ);
777 ret = krb5_cc_initialize(context, to, princ);
779 krb5_free_principal(context, princ);
782 ret = krb5_cc_start_seq_get(context, from, &cursor);
784 krb5_free_principal(context, princ);
790 krb5_cc_next_cred_match(context, from, &cursor, &cred,
791 whichfields, mcreds) == 0) {
794 ret = krb5_cc_store_cred(context, to, &cred);
795 krb5_free_cred_contents(context, &cred);
797 krb5_cc_end_seq_get(context, from, &cursor);
798 krb5_free_principal(context, princ);
803 * Just like krb5_cc_copy_cache_match, but copy everything.
805 * @ingroup krb5_ccache
809 krb5_error_code KRB5_LIB_FUNCTION
810 krb5_cc_copy_cache(krb5_context context,
811 const krb5_ccache from,
814 return krb5_cc_copy_cache_match(context, from, to, 0, NULL, NULL);
818 * Return the version of `id'.
820 * @ingroup krb5_ccache
824 krb5_error_code KRB5_LIB_FUNCTION
825 krb5_cc_get_version(krb5_context context,
826 const krb5_ccache id)
828 if(id->ops->get_version)
829 return (*id->ops->get_version)(context, id);
835 * Clear `mcreds' so it can be used with krb5_cc_retrieve_cred
837 * @ingroup krb5_ccache
841 void KRB5_LIB_FUNCTION
842 krb5_cc_clear_mcred(krb5_creds *mcred)
844 memset(mcred, 0, sizeof(*mcred));
848 * Get the cc ops that is registered in `context' to handle the
849 * `prefix'. `prefix' can be a complete credential cache name or a
850 * prefix, the function will only use part up to the first colon (:)
852 * Returns NULL if ops not found.
854 * @ingroup krb5_ccache
859 krb5_cc_get_prefix_ops(krb5_context context, const char *prefix)
864 if (prefix[0] == '/')
865 return &krb5_fcc_ops;
869 krb5_set_error_string(context, "malloc - out of memory");
876 for(i = 0; i < context->num_cc_ops && context->cc_ops[i].prefix; i++) {
877 if(strcmp(context->cc_ops[i].prefix, p) == 0) {
879 return &context->cc_ops[i];
886 struct krb5_cc_cache_cursor_data {
887 const krb5_cc_ops *ops;
888 krb5_cc_cursor cursor;
892 * Start iterating over all caches of `type'. If `type' is NULL, the
893 * default type is * used. `cursor' is initialized to the beginning.
895 * @return Return 0 or an error code.
897 * @ingroup krb5_ccache
901 krb5_error_code KRB5_LIB_FUNCTION
902 krb5_cc_cache_get_first (krb5_context context,
904 krb5_cc_cache_cursor *cursor)
906 const krb5_cc_ops *ops;
910 type = krb5_cc_default_name(context);
912 ops = krb5_cc_get_prefix_ops(context, type);
914 krb5_set_error_string(context, "Unknown type \"%s\" when iterating "
915 "trying to iterate the credential caches", type);
916 return KRB5_CC_UNKNOWN_TYPE;
919 if (ops->get_cache_first == NULL) {
920 krb5_set_error_string(context, "Credential cache type %s doesn't support "
921 "iterations over caches", ops->prefix);
922 return KRB5_CC_NOSUPP;
925 *cursor = calloc(1, sizeof(**cursor));
926 if (*cursor == NULL) {
927 krb5_set_error_string(context, "malloc - out of memory");
931 (*cursor)->ops = ops;
933 ret = ops->get_cache_first(context, &(*cursor)->cursor);
942 * Retrieve the next cache pointed to by (`cursor') in `id'
943 * and advance `cursor'.
945 * @return Return 0 or an error code.
947 * @ingroup krb5_ccache
951 krb5_error_code KRB5_LIB_FUNCTION
952 krb5_cc_cache_next (krb5_context context,
953 krb5_cc_cache_cursor cursor,
956 return cursor->ops->get_cache_next(context, cursor->cursor, id);
960 * Destroy the cursor `cursor'.
962 * @return Return 0 or an error code.
964 * @ingroup krb5_ccache
968 krb5_error_code KRB5_LIB_FUNCTION
969 krb5_cc_cache_end_seq_get (krb5_context context,
970 krb5_cc_cache_cursor cursor)
973 ret = cursor->ops->end_cache_get(context, cursor->cursor);
980 * Search for a matching credential cache of type `type' that have the
981 * `principal' as the default principal. If NULL is used for `type',
982 * the default type is used. On success, `id' needs to be freed with
983 * krb5_cc_close or krb5_cc_destroy.
985 * @return On failure, error code is returned and `id' is set to NULL.
987 * @ingroup krb5_ccache
991 krb5_error_code KRB5_LIB_FUNCTION
992 krb5_cc_cache_match (krb5_context context,
993 krb5_principal client,
997 krb5_cc_cache_cursor cursor;
999 krb5_ccache cache = NULL;
1003 ret = krb5_cc_cache_get_first (context, type, &cursor);
1007 while ((ret = krb5_cc_cache_next (context, cursor, &cache)) == 0) {
1008 krb5_principal principal;
1010 ret = krb5_cc_get_principal(context, cache, &principal);
1014 match = krb5_principal_compare(context, principal, client);
1015 krb5_free_principal(context, principal);
1020 krb5_cc_close(context, cache);
1024 krb5_cc_cache_end_seq_get(context, cursor);
1026 if (cache == NULL) {
1029 krb5_unparse_name(context, client, &str);
1031 krb5_set_error_string(context, "Principal %s not found in a "
1032 "credential cache", str ? str : "<out of memory>");
1035 return KRB5_CC_NOTFOUND;
1043 * Move the content from one credential cache to another. The
1044 * operation is an atomic switch.
1046 * @param context a Keberos context
1047 * @param from the credential cache to move the content from
1048 * @param to the credential cache to move the content to
1050 * @return On sucess, from is freed. On failure, error code is
1051 * returned and from and to are both still allocated.
1053 * @ingroup krb5_ccache
1057 krb5_cc_move(krb5_context context, krb5_ccache from, krb5_ccache to)
1059 krb5_error_code ret;
1061 if (strcmp(from->ops->prefix, to->ops->prefix) != 0) {
1062 krb5_set_error_string(context, "Moving credentials between diffrent "
1063 "types not yet supported");
1064 return KRB5_CC_NOSUPP;
1067 ret = (*to->ops->move)(context, from, to);
1069 memset(from, 0, sizeof(*from));