2 * Copyright (c) 2005, PADL Software Pty Ltd.
5 * Portions Copyright (c) 2009 Apple Inc. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of PADL Software nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY PADL SOFTWARE AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL PADL SOFTWARE OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 #include "krb5_locl.h"
39 * Client library for Kerberos Credentials Manager (KCM) daemon
45 static krb5_error_code
46 kcm_set_kdc_offset(krb5_context, krb5_ccache, krb5_deltat);
48 static const char *kcm_ipc_name = "ANY:org.h5l.kcm";
50 typedef struct krb5_kcmcache {
54 typedef struct krb5_kcm_cursor {
61 #define KCMCACHE(X) ((krb5_kcmcache *)(X)->data.data)
62 #define CACHENAME(X) (KCMCACHE(X)->name)
63 #define KCMCURSOR(C) ((krb5_kcm_cursor)(C))
65 static HEIMDAL_MUTEX kcm_mutex = HEIMDAL_MUTEX_INITIALIZER;
66 static heim_ipc kcm_ipc = NULL;
68 static krb5_error_code
69 kcm_send_request(krb5_context context,
70 krb5_storage *request,
71 krb5_data *response_data)
73 krb5_error_code ret = 0;
74 krb5_data request_data;
76 HEIMDAL_MUTEX_lock(&kcm_mutex);
78 ret = heim_ipc_init_context(kcm_ipc_name, &kcm_ipc);
79 HEIMDAL_MUTEX_unlock(&kcm_mutex);
81 return KRB5_CC_NOSUPP;
83 ret = krb5_storage_to_data(request, &request_data);
85 krb5_clear_error_message(context);
89 ret = heim_ipc_call(kcm_ipc, &request_data, response_data, NULL);
90 krb5_data_free(&request_data);
93 krb5_clear_error_message(context);
100 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
101 krb5_kcm_storage_request(krb5_context context,
103 krb5_storage **storage_p)
110 sp = krb5_storage_emem();
112 krb5_set_error_message(context, KRB5_CC_NOMEM, N_("malloc: out of memory", ""));
113 return KRB5_CC_NOMEM;
116 /* Send MAJOR | VERSION | OPCODE */
117 ret = krb5_store_int8(sp, KCM_PROTOCOL_VERSION_MAJOR);
120 ret = krb5_store_int8(sp, KCM_PROTOCOL_VERSION_MINOR);
123 ret = krb5_store_int16(sp, opcode);
130 krb5_set_error_message(context, ret,
131 N_("Failed to encode KCM request", ""));
132 krb5_storage_free(sp);
138 static krb5_error_code
139 kcm_alloc(krb5_context context, const char *name, krb5_ccache *id)
143 k = malloc(sizeof(*k));
145 krb5_set_error_message(context, KRB5_CC_NOMEM,
146 N_("malloc: out of memory", ""));
147 return KRB5_CC_NOMEM;
151 k->name = strdup(name);
152 if (k->name == NULL) {
154 krb5_set_error_message(context, KRB5_CC_NOMEM,
155 N_("malloc: out of memory", ""));
156 return KRB5_CC_NOMEM;
161 (*id)->data.data = k;
162 (*id)->data.length = sizeof(*k);
167 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
168 krb5_kcm_call(krb5_context context,
169 krb5_storage *request,
170 krb5_storage **response_p,
171 krb5_data *response_data_p)
173 krb5_data response_data;
176 krb5_storage *response;
178 if (response_p != NULL)
181 krb5_data_zero(&response_data);
183 ret = kcm_send_request(context, request, &response_data);
187 response = krb5_storage_from_data(&response_data);
188 if (response == NULL) {
189 krb5_data_free(&response_data);
193 ret = krb5_ret_int32(response, &status);
195 krb5_storage_free(response);
196 krb5_data_free(&response_data);
197 return KRB5_CC_FORMAT;
201 krb5_storage_free(response);
202 krb5_data_free(&response_data);
206 if (response_p != NULL) {
207 *response_data_p = response_data;
208 *response_p = response;
213 krb5_storage_free(response);
214 krb5_data_free(&response_data);
220 kcm_free(krb5_context context, krb5_ccache *id)
222 krb5_kcmcache *k = KCMCACHE(*id);
227 memset(k, 0, sizeof(*k));
228 krb5_data_free(&(*id)->data);
233 kcm_get_name(krb5_context context,
236 return CACHENAME(id);
239 static krb5_error_code
240 kcm_resolve(krb5_context context, krb5_ccache *id, const char *res)
242 return kcm_alloc(context, res, id);
251 static krb5_error_code
252 kcm_gen_new(krb5_context context, krb5_ccache *id)
256 krb5_storage *request, *response;
257 krb5_data response_data;
259 ret = kcm_alloc(context, NULL, id);
265 ret = krb5_kcm_storage_request(context, KCM_OP_GEN_NEW, &request);
267 kcm_free(context, id);
271 ret = krb5_kcm_call(context, request, &response, &response_data);
273 krb5_storage_free(request);
274 kcm_free(context, id);
278 ret = krb5_ret_stringz(response, &k->name);
282 krb5_storage_free(request);
283 krb5_storage_free(response);
284 krb5_data_free(&response_data);
287 kcm_free(context, id);
300 static krb5_error_code
301 kcm_initialize(krb5_context context,
303 krb5_principal primary_principal)
306 krb5_kcmcache *k = KCMCACHE(id);
307 krb5_storage *request;
309 ret = krb5_kcm_storage_request(context, KCM_OP_INITIALIZE, &request);
313 ret = krb5_store_stringz(request, k->name);
315 krb5_storage_free(request);
319 ret = krb5_store_principal(request, primary_principal);
321 krb5_storage_free(request);
325 ret = krb5_kcm_call(context, request, NULL, NULL);
327 krb5_storage_free(request);
329 if (context->kdc_sec_offset)
330 kcm_set_kdc_offset(context, id, context->kdc_sec_offset);
335 static krb5_error_code
336 kcm_close(krb5_context context,
339 kcm_free(context, &id);
350 static krb5_error_code
351 kcm_destroy(krb5_context context,
355 krb5_kcmcache *k = KCMCACHE(id);
356 krb5_storage *request;
358 ret = krb5_kcm_storage_request(context, KCM_OP_DESTROY, &request);
362 ret = krb5_store_stringz(request, k->name);
364 krb5_storage_free(request);
368 ret = krb5_kcm_call(context, request, NULL, NULL);
370 krb5_storage_free(request);
382 static krb5_error_code
383 kcm_store_cred(krb5_context context,
388 krb5_kcmcache *k = KCMCACHE(id);
389 krb5_storage *request;
391 ret = krb5_kcm_storage_request(context, KCM_OP_STORE, &request);
395 ret = krb5_store_stringz(request, k->name);
397 krb5_storage_free(request);
401 ret = krb5_store_creds(request, creds);
403 krb5_storage_free(request);
407 ret = krb5_kcm_call(context, request, NULL, NULL);
409 krb5_storage_free(request);
424 static krb5_error_code
425 kcm_retrieve(krb5_context context,
428 const krb5_creds *mcred,
432 krb5_kcmcache *k = KCMCACHE(id);
433 krb5_storage *request, *response;
434 krb5_data response_data;
436 ret = krb5_kcm_storage_request(context, KCM_OP_RETRIEVE, &request);
440 ret = krb5_store_stringz(request, k->name);
442 krb5_storage_free(request);
446 ret = krb5_store_int32(request, which);
448 krb5_storage_free(request);
452 ret = krb5_store_creds_tag(request, rk_UNCONST(mcred));
454 krb5_storage_free(request);
458 ret = krb5_kcm_call(context, request, &response, &response_data);
460 krb5_storage_free(request);
464 ret = krb5_ret_creds(response, creds);
468 krb5_storage_free(request);
469 krb5_storage_free(response);
470 krb5_data_free(&response_data);
483 static krb5_error_code
484 kcm_get_principal(krb5_context context,
486 krb5_principal *principal)
489 krb5_kcmcache *k = KCMCACHE(id);
490 krb5_storage *request, *response;
491 krb5_data response_data;
493 ret = krb5_kcm_storage_request(context, KCM_OP_GET_PRINCIPAL, &request);
497 ret = krb5_store_stringz(request, k->name);
499 krb5_storage_free(request);
503 ret = krb5_kcm_call(context, request, &response, &response_data);
505 krb5_storage_free(request);
509 ret = krb5_ret_principal(response, principal);
513 krb5_storage_free(request);
514 krb5_storage_free(response);
515 krb5_data_free(&response_data);
528 static krb5_error_code
529 kcm_get_first (krb5_context context,
531 krb5_cc_cursor *cursor)
535 krb5_kcmcache *k = KCMCACHE(id);
536 krb5_storage *request, *response;
537 krb5_data response_data;
539 ret = krb5_kcm_storage_request(context, KCM_OP_GET_CRED_UUID_LIST, &request);
543 ret = krb5_store_stringz(request, k->name);
545 krb5_storage_free(request);
549 ret = krb5_kcm_call(context, request, &response, &response_data);
550 krb5_storage_free(request);
554 c = calloc(1, sizeof(*c));
557 krb5_set_error_message(context, ret,
558 N_("malloc: out of memory", ""));
567 sret = krb5_storage_read(response, &uuid, sizeof(uuid));
571 } else if (sret != sizeof(uuid)) {
576 ptr = realloc(c->uuids, sizeof(c->uuids[0]) * (c->length + 1));
580 krb5_set_error_message(context, ENOMEM,
581 N_("malloc: out of memory", ""));
586 memcpy(&c->uuids[c->length], &uuid, sizeof(uuid));
590 krb5_storage_free(response);
591 krb5_data_free(&response_data);
612 static krb5_error_code
613 kcm_get_next (krb5_context context,
615 krb5_cc_cursor *cursor,
619 krb5_kcmcache *k = KCMCACHE(id);
620 krb5_kcm_cursor c = KCMCURSOR(*cursor);
621 krb5_storage *request, *response;
622 krb5_data response_data;
627 if (c->offset >= c->length)
630 ret = krb5_kcm_storage_request(context, KCM_OP_GET_CRED_BY_UUID, &request);
634 ret = krb5_store_stringz(request, k->name);
636 krb5_storage_free(request);
640 sret = krb5_storage_write(request,
641 &c->uuids[c->offset],
642 sizeof(c->uuids[c->offset]));
644 if (sret != sizeof(c->uuids[c->offset])) {
645 krb5_storage_free(request);
646 krb5_clear_error_message(context);
650 ret = krb5_kcm_call(context, request, &response, &response_data);
651 krb5_storage_free(request);
652 if (ret == KRB5_CC_END) {
656 ret = krb5_ret_creds(response, creds);
660 krb5_storage_free(response);
661 krb5_data_free(&response_data);
674 static krb5_error_code
675 kcm_end_get (krb5_context context,
677 krb5_cc_cursor *cursor)
679 krb5_kcm_cursor c = KCMCURSOR(*cursor);
698 static krb5_error_code
699 kcm_remove_cred(krb5_context context,
705 krb5_kcmcache *k = KCMCACHE(id);
706 krb5_storage *request;
708 ret = krb5_kcm_storage_request(context, KCM_OP_REMOVE_CRED, &request);
712 ret = krb5_store_stringz(request, k->name);
714 krb5_storage_free(request);
718 ret = krb5_store_int32(request, which);
720 krb5_storage_free(request);
724 ret = krb5_store_creds_tag(request, cred);
726 krb5_storage_free(request);
730 ret = krb5_kcm_call(context, request, NULL, NULL);
732 krb5_storage_free(request);
736 static krb5_error_code
737 kcm_set_flags(krb5_context context,
742 krb5_kcmcache *k = KCMCACHE(id);
743 krb5_storage *request;
745 ret = krb5_kcm_storage_request(context, KCM_OP_SET_FLAGS, &request);
749 ret = krb5_store_stringz(request, k->name);
751 krb5_storage_free(request);
755 ret = krb5_store_int32(request, flags);
757 krb5_storage_free(request);
761 ret = krb5_kcm_call(context, request, NULL, NULL);
763 krb5_storage_free(request);
768 kcm_get_version(krb5_context context,
776 * get back list of uuids
779 static krb5_error_code
780 kcm_get_cache_first(krb5_context context, krb5_cc_cursor *cursor)
784 krb5_storage *request, *response;
785 krb5_data response_data;
789 c = calloc(1, sizeof(*c));
792 krb5_set_error_message(context, ret,
793 N_("malloc: out of memory", ""));
797 ret = krb5_kcm_storage_request(context, KCM_OP_GET_CACHE_UUID_LIST, &request);
801 ret = krb5_kcm_call(context, request, &response, &response_data);
802 krb5_storage_free(request);
811 sret = krb5_storage_read(response, &uuid, sizeof(uuid));
815 } else if (sret != sizeof(uuid)) {
820 ptr = realloc(c->uuids, sizeof(c->uuids[0]) * (c->length + 1));
823 krb5_set_error_message(context, ret,
824 N_("malloc: out of memory", ""));
829 memcpy(&c->uuids[c->length], &uuid, sizeof(uuid));
833 krb5_storage_free(response);
834 krb5_data_free(&response_data);
851 static krb5_error_code
852 kcm_get_cache_next(krb5_context context, krb5_cc_cursor cursor, const krb5_cc_ops *ops, krb5_ccache *id)
855 krb5_kcm_cursor c = KCMCURSOR(cursor);
856 krb5_storage *request, *response;
857 krb5_data response_data;
865 if (c->offset >= c->length)
868 ret = krb5_kcm_storage_request(context, KCM_OP_GET_CACHE_BY_UUID, &request);
872 sret = krb5_storage_write(request,
873 &c->uuids[c->offset],
874 sizeof(c->uuids[c->offset]));
876 if (sret != sizeof(c->uuids[c->offset])) {
877 krb5_storage_free(request);
878 krb5_clear_error_message(context);
882 ret = krb5_kcm_call(context, request, &response, &response_data);
883 krb5_storage_free(request);
884 if (ret == KRB5_CC_END)
887 ret = krb5_ret_stringz(response, &name);
888 krb5_storage_free(response);
889 krb5_data_free(&response_data);
892 ret = _krb5_cc_allocate(context, ops, id);
894 ret = kcm_alloc(context, name, id);
901 static krb5_error_code
902 kcm_get_cache_next_kcm(krb5_context context, krb5_cc_cursor cursor, krb5_ccache *id)
904 #ifndef KCM_IS_API_CACHE
905 return kcm_get_cache_next(context, cursor, &krb5_kcm_ops, id);
911 static krb5_error_code
912 kcm_get_cache_next_api(krb5_context context, krb5_cc_cursor cursor, krb5_ccache *id)
914 return kcm_get_cache_next(context, cursor, &krb5_akcm_ops, id);
918 static krb5_error_code
919 kcm_end_cache_get(krb5_context context, krb5_cc_cursor cursor)
921 krb5_kcm_cursor c = KCMCURSOR(cursor);
929 static krb5_error_code
930 kcm_move(krb5_context context, krb5_ccache from, krb5_ccache to)
933 krb5_kcmcache *oldk = KCMCACHE(from);
934 krb5_kcmcache *newk = KCMCACHE(to);
935 krb5_storage *request;
937 ret = krb5_kcm_storage_request(context, KCM_OP_MOVE_CACHE, &request);
941 ret = krb5_store_stringz(request, oldk->name);
943 krb5_storage_free(request);
947 ret = krb5_store_stringz(request, newk->name);
949 krb5_storage_free(request);
952 ret = krb5_kcm_call(context, request, NULL, NULL);
954 krb5_storage_free(request);
958 static krb5_error_code
959 kcm_get_default_name(krb5_context context, const krb5_cc_ops *ops,
960 const char *defstr, char **str)
963 krb5_storage *request, *response;
964 krb5_data response_data;
969 ret = krb5_kcm_storage_request(context, KCM_OP_GET_DEFAULT_CACHE, &request);
973 ret = krb5_kcm_call(context, request, &response, &response_data);
974 krb5_storage_free(request);
976 return _krb5_expand_default_cc_name(context, defstr, str);
978 ret = krb5_ret_stringz(response, &name);
979 krb5_storage_free(response);
980 krb5_data_free(&response_data);
984 asprintf(str, "%s:%s", ops->prefix, name);
992 static krb5_error_code
993 kcm_get_default_name_api(krb5_context context, char **str)
995 return kcm_get_default_name(context, &krb5_akcm_ops,
996 KRB5_DEFAULT_CCNAME_KCM_API, str);
999 static krb5_error_code
1000 kcm_get_default_name_kcm(krb5_context context, char **str)
1002 return kcm_get_default_name(context, &krb5_kcm_ops,
1003 KRB5_DEFAULT_CCNAME_KCM_KCM, str);
1006 static krb5_error_code
1007 kcm_set_default(krb5_context context, krb5_ccache id)
1009 krb5_error_code ret;
1010 krb5_storage *request;
1011 krb5_kcmcache *k = KCMCACHE(id);
1013 ret = krb5_kcm_storage_request(context, KCM_OP_SET_DEFAULT_CACHE, &request);
1017 ret = krb5_store_stringz(request, k->name);
1019 krb5_storage_free(request);
1023 ret = krb5_kcm_call(context, request, NULL, NULL);
1024 krb5_storage_free(request);
1029 static krb5_error_code
1030 kcm_lastchange(krb5_context context, krb5_ccache id, krb5_timestamp *mtime)
1032 *mtime = time(NULL);
1036 static krb5_error_code
1037 kcm_set_kdc_offset(krb5_context context, krb5_ccache id, krb5_deltat kdc_offset)
1039 krb5_kcmcache *k = KCMCACHE(id);
1040 krb5_error_code ret;
1041 krb5_storage *request;
1043 ret = krb5_kcm_storage_request(context, KCM_OP_SET_KDC_OFFSET, &request);
1047 ret = krb5_store_stringz(request, k->name);
1049 krb5_storage_free(request);
1052 ret = krb5_store_int32(request, kdc_offset);
1054 krb5_storage_free(request);
1058 ret = krb5_kcm_call(context, request, NULL, NULL);
1059 krb5_storage_free(request);
1064 static krb5_error_code
1065 kcm_get_kdc_offset(krb5_context context, krb5_ccache id, krb5_deltat *kdc_offset)
1067 krb5_kcmcache *k = KCMCACHE(id);
1068 krb5_error_code ret;
1069 krb5_storage *request, *response;
1070 krb5_data response_data;
1073 ret = krb5_kcm_storage_request(context, KCM_OP_GET_KDC_OFFSET, &request);
1077 ret = krb5_store_stringz(request, k->name);
1079 krb5_storage_free(request);
1083 ret = krb5_kcm_call(context, request, &response, &response_data);
1084 krb5_storage_free(request);
1088 ret = krb5_ret_int32(response, &offset);
1089 krb5_storage_free(response);
1090 krb5_data_free(&response_data);
1094 *kdc_offset = offset;
1100 * Variable containing the KCM based credential cache implemention.
1102 * @ingroup krb5_ccache
1105 KRB5_LIB_VARIABLE const krb5_cc_ops krb5_kcm_ops = {
1106 KRB5_CC_OPS_VERSION,
1115 NULL /* kcm_retrieve */,
1123 kcm_get_cache_first,
1124 kcm_get_cache_next_kcm,
1127 kcm_get_default_name_kcm,
1134 KRB5_LIB_VARIABLE const krb5_cc_ops krb5_akcm_ops = {
1135 KRB5_CC_OPS_VERSION,
1144 NULL /* kcm_retrieve */,
1152 kcm_get_cache_first,
1153 kcm_get_cache_next_api,
1156 kcm_get_default_name_api,
1164 KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL
1165 _krb5_kcm_is_running(krb5_context context)
1167 krb5_error_code ret;
1168 krb5_ccache_data ccdata;
1169 krb5_ccache id = &ccdata;
1170 krb5_boolean running;
1172 ret = kcm_alloc(context, NULL, &id);
1176 running = (_krb5_kcm_noop(context, id) == 0);
1178 kcm_free(context, &id);
1189 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1190 _krb5_kcm_noop(krb5_context context,
1193 krb5_error_code ret;
1194 krb5_storage *request;
1196 ret = krb5_kcm_storage_request(context, KCM_OP_NOOP, &request);
1200 ret = krb5_kcm_call(context, request, NULL, NULL);
1202 krb5_storage_free(request);
1210 * ServerPrincipalPresent
1211 * ServerPrincipal OPTIONAL
1217 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1218 _krb5_kcm_get_initial_ticket(krb5_context context,
1220 krb5_principal server,
1223 krb5_kcmcache *k = KCMCACHE(id);
1224 krb5_error_code ret;
1225 krb5_storage *request;
1227 ret = krb5_kcm_storage_request(context, KCM_OP_GET_INITIAL_TICKET, &request);
1231 ret = krb5_store_stringz(request, k->name);
1233 krb5_storage_free(request);
1237 ret = krb5_store_int8(request, (server == NULL) ? 0 : 1);
1239 krb5_storage_free(request);
1243 if (server != NULL) {
1244 ret = krb5_store_principal(request, server);
1246 krb5_storage_free(request);
1251 ret = krb5_store_keyblock(request, *key);
1253 krb5_storage_free(request);
1257 ret = krb5_kcm_call(context, request, NULL, NULL);
1259 krb5_storage_free(request);
1274 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1275 _krb5_kcm_get_ticket(krb5_context context,
1277 krb5_kdc_flags flags,
1278 krb5_enctype enctype,
1279 krb5_principal server)
1281 krb5_error_code ret;
1282 krb5_kcmcache *k = KCMCACHE(id);
1283 krb5_storage *request;
1285 ret = krb5_kcm_storage_request(context, KCM_OP_GET_TICKET, &request);
1289 ret = krb5_store_stringz(request, k->name);
1291 krb5_storage_free(request);
1295 ret = krb5_store_int32(request, flags.i);
1297 krb5_storage_free(request);
1301 ret = krb5_store_int32(request, enctype);
1303 krb5_storage_free(request);
1307 ret = krb5_store_principal(request, server);
1309 krb5_storage_free(request);
1313 ret = krb5_kcm_call(context, request, NULL, NULL);
1315 krb5_storage_free(request);
1319 #endif /* HAVE_KCM */