add doxygen support and json export document support
[heimdal.git] / kcm / acquire.c
blob562b77b81fc1c4a8972a34058d3121246f0d532d
1 /*
2 * Copyright (c) 2005, PADL Software Pty Ltd.
3 * All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of PADL Software nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY PADL SOFTWARE AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL PADL SOFTWARE OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
33 #include "kcm_locl.h"
36 * Get a new ticket using a keytab/cached key and swap it into
37 * an existing redentials cache
40 krb5_error_code
41 kcm_ccache_acquire(krb5_context context,
42 kcm_ccache ccache,
43 krb5_creds **credp)
45 krb5_error_code ret = 0;
46 krb5_creds cred;
47 krb5_const_realm realm;
48 krb5_get_init_creds_opt *opt = NULL;
49 krb5_ccache_data ccdata;
50 char *in_tkt_service = NULL;
51 const char *estr;
53 memset(&cred, 0, sizeof(cred));
55 KCM_ASSERT_VALID(ccache);
57 /* We need a cached key or keytab to acquire credentials */
58 if (ccache->flags & KCM_FLAGS_USE_CACHED_KEY) {
59 if (ccache->key.keyblock.keyvalue.length == 0)
60 krb5_abortx(context,
61 "kcm_ccache_acquire: KCM_FLAGS_USE_CACHED_KEY without key");
62 } else if (ccache->flags & KCM_FLAGS_USE_KEYTAB) {
63 if (ccache->key.keytab == NULL)
64 krb5_abortx(context,
65 "kcm_ccache_acquire: KCM_FLAGS_USE_KEYTAB without keytab");
66 } else {
67 kcm_log(0, "Cannot acquire initial credentials for cache %s without key",
68 ccache->name);
69 return KRB5_FCC_INTERNAL;
72 HEIMDAL_MUTEX_lock(&ccache->mutex);
74 /* Fake up an internal ccache */
75 kcm_internal_ccache(context, ccache, &ccdata);
77 /* Now, actually acquire the creds */
78 if (ccache->server != NULL) {
79 ret = krb5_unparse_name(context, ccache->server, &in_tkt_service);
80 if (ret) {
81 estr = krb5_get_error_message(context, ret);
82 kcm_log(0, "Failed to unparse service principal name for cache %s: %s",
83 ccache->name, estr);
84 krb5_free_error_message(context, estr);
85 return ret;
89 realm = krb5_principal_get_realm(context, ccache->client);
91 ret = krb5_get_init_creds_opt_alloc(context, &opt);
92 if (ret)
93 goto out;
94 krb5_get_init_creds_opt_set_default_flags(context, "kcm", realm, opt);
95 if (ccache->tkt_life != 0)
96 krb5_get_init_creds_opt_set_tkt_life(opt, ccache->tkt_life);
97 if (ccache->renew_life != 0)
98 krb5_get_init_creds_opt_set_renew_life(opt, ccache->renew_life);
100 if (ccache->flags & KCM_FLAGS_USE_CACHED_KEY) {
101 ret = krb5_get_init_creds_keyblock(context,
102 &cred,
103 ccache->client,
104 &ccache->key.keyblock,
106 in_tkt_service,
107 opt);
108 } else {
109 /* loosely based on lib/krb5/init_creds_pw.c */
110 ret = krb5_get_init_creds_keytab(context,
111 &cred,
112 ccache->client,
113 ccache->key.keytab,
115 in_tkt_service,
116 opt);
119 if (ret) {
120 estr = krb5_get_error_message(context, ret);
121 kcm_log(0, "Failed to acquire credentials for cache %s: %s",
122 ccache->name, estr);
123 krb5_free_error_message(context, estr);
124 if (in_tkt_service != NULL)
125 free(in_tkt_service);
126 goto out;
129 if (in_tkt_service != NULL)
130 free(in_tkt_service);
132 /* Swap them in */
133 kcm_ccache_remove_creds_internal(context, ccache);
135 ret = kcm_ccache_store_cred_internal(context, ccache, &cred, 0, credp);
136 if (ret) {
137 estr = krb5_get_error_message(context, ret);
138 kcm_log(0, "Failed to store credentials for cache %s: %s",
139 ccache->name, estr);
140 krb5_free_error_message(context, estr);
141 krb5_free_cred_contents(context, &cred);
142 goto out;
145 out:
146 if (opt)
147 krb5_get_init_creds_opt_free(context, opt);
149 HEIMDAL_MUTEX_unlock(&ccache->mutex);
151 return ret;