2 * Copyright (c) 1997-2007 Kungliga Tekniska Högskolan
3 * (Royal Institute of Technology, Stockholm, Sweden).
6 * Portions Copyright (c) 2009 Apple Inc. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the Institute nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 #include "kuser_locl.h"
39 #include <Security/Security.h>
46 int forwardable_flag = -1;
47 int proxiable_flag = -1;
48 int renewable_flag = -1;
51 int validate_flag = 0;
55 struct getarg_strings extra_addresses;
56 int anonymous_flag = 0;
57 char *lifetime = NULL;
58 char *renew_life = NULL;
59 char *server_str = NULL;
60 char *cred_cache = NULL;
61 char *start_str = NULL;
62 static int switch_cache_flags = 1;
63 struct getarg_strings etype_str;
65 char *keytab_str = NULL;
68 char *password_file = NULL;
69 char *pk_user_id = NULL;
70 int pk_enterprise_flag = 0;
71 struct hx509_certs_data *ent_user_id = NULL;
72 char *pk_x509_anchors = NULL;
73 int pk_use_enckey = 0;
74 static int canonicalize_flag = 0;
75 static int enterprise_flag = 0;
76 static int ok_as_delegate_flag = 0;
77 static int use_referrals_flag = 0;
78 static int windows_flag = 0;
80 static char *ntlm_domain;
84 static struct getargs args[] = {
98 { "afslog", 0 , arg_flag, &do_afslog,
99 NP_("obtain afs tokens", ""), NULL },
101 { "cache", 'c', arg_string, &cred_cache,
102 NP_("credentials cache", ""), "cachename" },
104 { "forwardable", 0, arg_negative_flag, &forwardable_flag,
105 NP_("get tickets not forwardable", ""), NULL },
107 { NULL, 'f', arg_flag, &forwardable_flag,
108 NP_("get forwardable tickets", ""), NULL },
110 { "keytab", 't', arg_string, &keytab_str,
111 NP_("keytab to use", ""), "keytabname" },
113 { "lifetime", 'l', arg_string, &lifetime,
114 NP_("lifetime of tickets", ""), "time" },
116 { "proxiable", 'p', arg_flag, &proxiable_flag,
117 NP_("get proxiable tickets", ""), NULL },
119 { "renew", 'R', arg_flag, &renew_flag,
120 NP_("renew TGT", ""), NULL },
122 { "renewable", 0, arg_flag, &renewable_flag,
123 NP_("get renewable tickets", ""), NULL },
125 { "renewable-life", 'r', arg_string, &renew_life,
126 NP_("renewable lifetime of tickets", ""), "time" },
128 { "server", 'S', arg_string, &server_str,
129 NP_("server to get ticket for", ""), "principal" },
131 { "start-time", 's', arg_string, &start_str,
132 NP_("when ticket gets valid", ""), "time" },
134 { "use-keytab", 'k', arg_flag, &use_keytab,
135 NP_("get key from keytab", ""), NULL },
137 { "validate", 'v', arg_flag, &validate_flag,
138 NP_("validate TGT", ""), NULL },
140 { "enctypes", 'e', arg_strings, &etype_str,
141 NP_("encryption types to use", ""), "enctypes" },
143 { "fcache-version", 0, arg_integer, &fcache_version,
144 NP_("file cache version to create", ""), NULL },
146 { "addresses", 'A', arg_negative_flag, &addrs_flag,
147 NP_("request a ticket with no addresses", ""), NULL },
149 { "extra-addresses",'a', arg_strings, &extra_addresses,
150 NP_("include these extra addresses", ""), "addresses" },
152 { "anonymous", 0, arg_flag, &anonymous_flag,
153 NP_("request an anonymous ticket", ""), NULL },
155 { "request-pac", 0, arg_flag, &pac_flag,
156 NP_("request a Windows PAC", ""), NULL },
158 { "password-file", 0, arg_string, &password_file,
159 NP_("read the password from a file", ""), NULL },
161 { "canonicalize",0, arg_flag, &canonicalize_flag,
162 NP_("canonicalize client principal", ""), NULL },
164 { "enterprise",0, arg_flag, &enterprise_flag,
165 NP_("parse principal as a KRB5-NT-ENTERPRISE name", ""), NULL },
167 { "pk-enterprise", 0, arg_flag, &pk_enterprise_flag,
168 NP_("use enterprise name from certificate", ""), NULL },
170 { "pk-user", 'C', arg_string, &pk_user_id,
171 NP_("principal's public/private/certificate identifier", ""), "id" },
173 { "x509-anchors", 'D', arg_string, &pk_x509_anchors,
174 NP_("directory with CA certificates", ""), "directory" },
176 { "pk-use-enckey", 0, arg_flag, &pk_use_enckey,
177 NP_("Use RSA encrypted reply (instead of DH)", ""), NULL },
180 { "ntlm-domain", 0, arg_string, &ntlm_domain,
181 NP_("NTLM domain", ""), "domain" },
184 { "change-default", 0, arg_negative_flag, &switch_cache_flags,
185 NP_("switch the default cache to the new credentials cache", ""), NULL },
187 { "ok-as-delegate", 0, arg_flag, &ok_as_delegate_flag,
188 NP_("honor ok-as-delegate on tickets", ""), NULL },
190 { "use-referrals", 0, arg_flag, &use_referrals_flag,
191 NP_("only use referrals, no dns canalisation", ""), NULL },
193 { "windows", 0, arg_flag, &windows_flag,
194 NP_("get windows behavior", ""), NULL },
196 { "version", 0, arg_flag, &version_flag, NULL, NULL },
197 { "help", 0, arg_flag, &help_flag, NULL, NULL }
203 arg_printusage_i18n (args,
204 sizeof(args)/sizeof(*args),
207 "[principal [command]]",
212 static krb5_error_code
213 get_server(krb5_context context,
214 krb5_principal client,
216 krb5_principal *princ)
218 krb5_const_realm realm;
220 return krb5_parse_name(context, server, princ);
222 realm = krb5_principal_get_realm(context, client);
223 return krb5_make_principal(context, princ, realm,
224 KRB5_TGS_NAME, realm, NULL);
228 renew_validate(krb5_context context,
236 krb5_creds in, *out = NULL;
237 krb5_kdc_flags flags;
239 memset(&in, 0, sizeof(in));
241 ret = krb5_cc_get_principal(context, cache, &in.client);
243 krb5_warn(context, ret, "krb5_cc_get_principal");
246 ret = get_server(context, in.client, server, &in.server);
248 krb5_warn(context, ret, "get_server");
254 * no need to check the error here, it's only to be
255 * friendly to the user
257 krb5_get_credentials(context, KRB5_GC_CACHED, cache, &in, &out);
261 flags.b.renewable = flags.b.renew = renew;
262 flags.b.validate = validate;
264 if (forwardable_flag != -1)
265 flags.b.forwardable = forwardable_flag;
267 flags.b.forwardable = out->flags.b.forwardable;
269 if (proxiable_flag != -1)
270 flags.b.proxiable = proxiable_flag;
272 flags.b.proxiable = out->flags.b.proxiable;
275 flags.b.request_anonymous = anonymous_flag;
277 in.times.endtime = time(NULL) + life;
280 krb5_free_creds (context, out);
285 ret = krb5_get_kdc_cred(context,
293 krb5_warn(context, ret, "krb5_get_kdc_cred");
296 ret = krb5_cc_initialize(context, cache, in.client);
298 krb5_free_creds (context, out);
299 krb5_warn(context, ret, "krb5_cc_initialize");
302 ret = krb5_cc_store_cred(context, cache, out);
304 if(ret == 0 && server == NULL) {
305 /* only do this if it's a general renew-my-tgt request */
307 if(do_afslog && k_hasafs())
308 krb5_afslog(context, cache, NULL, NULL);
312 krb5_free_creds (context, out);
314 krb5_warn(context, ret, "krb5_cc_store_cred");
318 krb5_free_cred_contents(context, &in);
324 static krb5_error_code
325 store_ntlmkey(krb5_context context, krb5_ccache id,
326 const char *domain, struct ntlm_buf *buf)
332 asprintf(&name, "ntlm-key-%s", domain);
334 krb5_clear_error_message(context);
338 data.length = buf->length;
339 data.data = buf->data;
341 ret = krb5_cc_set_config(context, id, NULL, name, &data);
347 static krb5_error_code
348 get_new_tickets(krb5_context context,
349 krb5_principal principal,
351 krb5_deltat ticket_life,
355 krb5_get_init_creds_opt *opt;
358 krb5_deltat start_time = 0;
359 krb5_deltat renew = 0;
360 const char *renewstr = NULL;
361 krb5_enctype *enctype = NULL;
362 krb5_ccache tempccache;
364 struct ntlm_buf ntlmkey;
365 memset(&ntlmkey, 0, sizeof(ntlmkey));
372 if (strcasecmp("STDIN", password_file) == 0)
375 f = fopen(password_file, "r");
377 krb5_errx(context, 1, "Failed to open the password file %s",
380 if (fgets(passwd, sizeof(passwd), f) == NULL)
381 krb5_errx(context, 1,
382 N_("Failed to read password from file %s", ""),
386 passwd[strcspn(passwd, "\n")] = '\0';
390 if (passwd[0] == '\0') {
397 realm = krb5_principal_get_realm(context, principal);
399 ret = krb5_unparse_name_flags(context, principal,
400 KRB5_PRINCIPAL_UNPARSE_NO_REALM, &name);
404 osret = SecKeychainFindGenericPassword(NULL, strlen(realm), realm,
406 &length, &buffer, NULL);
408 if (osret == noErr && length < sizeof(passwd) - 1) {
409 memcpy(passwd, buffer, length);
410 passwd[length] = '\0';
417 memset(&cred, 0, sizeof(cred));
419 ret = krb5_get_init_creds_opt_alloc (context, &opt);
421 krb5_err(context, 1, ret, "krb5_get_init_creds_opt_alloc");
423 krb5_get_init_creds_opt_set_default_flags(context, "kinit",
424 krb5_principal_get_realm(context, principal), opt);
426 if(forwardable_flag != -1)
427 krb5_get_init_creds_opt_set_forwardable (opt, forwardable_flag);
428 if(proxiable_flag != -1)
429 krb5_get_init_creds_opt_set_proxiable (opt, proxiable_flag);
431 krb5_get_init_creds_opt_set_anonymous (opt, anonymous_flag);
433 krb5_get_init_creds_opt_set_pac_request(context, opt,
434 pac_flag ? TRUE : FALSE);
435 if (canonicalize_flag)
436 krb5_get_init_creds_opt_set_canonicalize(context, opt, TRUE);
437 if (pk_enterprise_flag || enterprise_flag || canonicalize_flag || windows_flag)
438 krb5_get_init_creds_opt_set_win2k(context, opt, TRUE);
439 if (pk_user_id || ent_user_id || anonymous_flag) {
440 ret = krb5_get_init_creds_opt_set_pkinit(context, opt,
446 pk_use_enckey ? 2 : 0 |
447 anonymous_flag ? 4 : 0,
452 krb5_err(context, 1, ret, "krb5_get_init_creds_opt_set_pkinit");
454 krb5_get_init_creds_opt_set_pkinit_user_certs(context, opt, ent_user_id);
457 if (addrs_flag != -1)
458 krb5_get_init_creds_opt_set_addressless(context, opt,
459 addrs_flag ? FALSE : TRUE);
461 if (renew_life == NULL && renewable_flag)
462 renewstr = "1 month";
464 renewstr = renew_life;
466 renew = parse_time (renewstr, "s");
468 errx (1, "unparsable time: %s", renewstr);
470 krb5_get_init_creds_opt_set_renew_life (opt, renew);
474 krb5_get_init_creds_opt_set_tkt_life (opt, ticket_life);
477 int tmp = parse_time (start_str, "s");
479 errx (1, N_("unparsable time: %s", ""), start_str);
484 if(etype_str.num_strings) {
487 enctype = malloc(etype_str.num_strings * sizeof(*enctype));
489 errx(1, "out of memory");
490 for(i = 0; i < etype_str.num_strings; i++) {
491 ret = krb5_string_to_enctype(context,
492 etype_str.strings[i],
495 errx(1, "unrecognized enctype: %s", etype_str.strings[i]);
497 krb5_get_init_creds_opt_set_etype_list(opt, enctype,
498 etype_str.num_strings);
501 if(use_keytab || keytab_str) {
504 ret = krb5_kt_resolve(context, keytab_str, &kt);
506 ret = krb5_kt_default(context, &kt);
508 krb5_err (context, 1, ret, "resolving keytab");
509 ret = krb5_get_init_creds_keytab (context,
516 krb5_kt_close(context, kt);
517 } else if (pk_user_id || ent_user_id || anonymous_flag) {
518 ret = krb5_get_init_creds_password (context,
527 } else if (!interactive) {
528 krb5_warnx(context, "Not interactive, failed to get initial ticket");
529 krb5_get_init_creds_opt_free(context, opt);
533 if (passwd[0] == '\0') {
536 krb5_unparse_name (context, principal, &p);
537 asprintf (&prompt, N_("%s's Password: ", ""), p);
540 if (UI_UTIL_read_pw_string(passwd, sizeof(passwd)-1, prompt, 0)){
541 memset(passwd, 0, sizeof(passwd));
548 ret = krb5_get_init_creds_password (context,
558 krb5_get_init_creds_opt_free(context, opt);
560 if (ntlm_domain && passwd[0])
561 heim_ntlm_nt_key(passwd, &ntlmkey);
563 memset(passwd, 0, sizeof(passwd));
568 case KRB5_LIBOS_PWDINTR: /* don't print anything if it was just C-c:ed */
570 case KRB5KRB_AP_ERR_BAD_INTEGRITY:
571 case KRB5KRB_AP_ERR_MODIFIED:
572 case KRB5KDC_ERR_PREAUTH_FAILED:
573 krb5_errx(context, 1, N_("Password incorrect", ""));
575 case KRB5KRB_AP_ERR_V4_REPLY:
576 krb5_errx(context, 1, N_("Looks like a Kerberos 4 reply", ""));
579 krb5_err(context, 1, ret, "krb5_get_init_creds");
582 if(ticket_life != 0) {
583 if(abs(cred.times.endtime - cred.times.starttime - ticket_life) > 30) {
585 unparse_time_approx(cred.times.endtime - cred.times.starttime,
587 krb5_warnx(context, N_("NOTICE: ticket lifetime is %s", ""), life);
591 if(abs(cred.times.renew_till - cred.times.starttime - renew) > 30) {
593 unparse_time_approx(cred.times.renew_till - cred.times.starttime,
596 N_("NOTICE: ticket renewable lifetime is %s", ""),
601 ret = krb5_cc_new_unique(context, krb5_cc_get_type(context, ccache),
604 krb5_err (context, 1, ret, "krb5_cc_new_unique");
606 ret = krb5_cc_initialize (context, tempccache, cred.client);
608 krb5_err (context, 1, ret, "krb5_cc_initialize");
610 ret = krb5_cc_store_cred (context, tempccache, &cred);
612 krb5_err (context, 1, ret, "krb5_cc_store_cred");
614 krb5_free_cred_contents (context, &cred);
616 ret = krb5_cc_move(context, tempccache, ccache);
618 krb5_err (context, 1, ret, "krb5_cc_move");
620 if (switch_cache_flags)
621 krb5_cc_switch(context, ccache);
624 if (ntlm_domain && ntlmkey.data)
625 store_ntlmkey(context, ccache, ntlm_domain, &ntlmkey);
628 if (ok_as_delegate_flag || windows_flag || use_referrals_flag) {
632 if (ok_as_delegate_flag || windows_flag)
634 if (use_referrals_flag || windows_flag)
640 krb5_cc_set_config(context, ccache, NULL, "realm-config", &data);
651 ticket_lifetime(krb5_context context, krb5_ccache cache,
652 krb5_principal client, const char *server)
654 krb5_creds in_cred, *cred;
658 memset(&in_cred, 0, sizeof(in_cred));
660 ret = krb5_cc_get_principal(context, cache, &in_cred.client);
662 krb5_warn(context, ret, "krb5_cc_get_principal");
665 ret = get_server(context, in_cred.client, server, &in_cred.server);
667 krb5_free_principal(context, in_cred.client);
668 krb5_warn(context, ret, "get_server");
672 ret = krb5_get_credentials(context, KRB5_GC_CACHED,
673 cache, &in_cred, &cred);
674 krb5_free_principal(context, in_cred.client);
675 krb5_free_principal(context, in_cred.server);
677 krb5_warn(context, ret, "krb5_get_credentials");
680 timeout = cred->times.endtime - cred->times.starttime;
683 krb5_free_creds(context, cred);
688 krb5_context context;
690 krb5_principal principal;
691 krb5_deltat ticket_life;
695 renew_func(void *ptr)
697 struct renew_ctx *ctx = ptr;
702 if (renewable_flag) {
703 ret = renew_validate(ctx->context, renewable_flag, validate_flag,
704 ctx->ccache, server_str, ctx->ticket_life);
711 get_new_tickets(ctx->context, ctx->principal,
712 ctx->ccache, ctx->ticket_life, 0);
715 if(do_afslog && k_hasafs())
716 krb5_afslog(ctx->context, ctx->ccache, NULL, NULL);
719 expire = ticket_lifetime(ctx->context, ctx->ccache, ctx->principal,
725 main (int argc, char **argv)
728 krb5_context context;
730 krb5_principal principal;
732 krb5_deltat ticket_life = 0;
735 setprogname (argv[0]);
737 setlocale (LC_ALL, "");
738 bindtextdomain ("heimdal_kuser", HEIMDAL_LOCALEDIR);
739 textdomain("heimdal_kuser");
741 ret = krb5_init_context (&context);
742 if (ret == KRB5_CONFIG_BADFORMAT)
743 errx (1, "krb5_init_context failed to parse configuration file");
745 errx(1, "krb5_init_context failed: %d", ret);
747 if(getarg(args, sizeof(args) / sizeof(args[0]), argc, argv, &optidx))
761 if (canonicalize_flag || enterprise_flag)
762 parseflags |= KRB5_PRINCIPAL_PARSE_ENTERPRISE;
764 if (pk_enterprise_flag) {
765 ret = krb5_pk_enterprise_cert(context, pk_user_id,
769 krb5_err(context, 1, ret, "krb5_pk_enterprise_certs");
773 } else if (anonymous_flag) {
775 ret = krb5_make_principal(context, &principal, argv[0],
776 KRB5_WELLKNOWN_NAME, KRB5_ANON_NAME,
779 krb5_err(context, 1, ret, "krb5_make_principal");
780 krb5_principal_set_type(context, principal, KRB5_NT_WELLKNOWN);
784 ret = krb5_parse_name_flags (context, argv[0], parseflags,
787 krb5_err (context, 1, ret, "krb5_parse_name");
789 ret = krb5_get_default_principal (context, &principal);
791 krb5_err (context, 1, ret, "krb5_get_default_principal");
796 krb5_set_fcache_version(context, fcache_version);
798 if(renewable_flag == -1)
799 /* this seems somewhat pointless, but whatever */
800 krb5_appdefault_boolean(context, "kinit",
801 krb5_principal_get_realm(context, principal),
802 "renewable", FALSE, &renewable_flag);
804 krb5_appdefault_boolean(context, "kinit",
805 krb5_principal_get_realm(context, principal),
806 "afslog", TRUE, &do_afslog);
809 ret = krb5_cc_resolve(context, cred_cache, &ccache);
813 ret = krb5_cc_new_unique(context, NULL, NULL, &ccache);
815 krb5_err(context, 1, ret, "creating cred cache");
816 snprintf(s, sizeof(s), "%s:%s",
817 krb5_cc_get_type(context, ccache),
818 krb5_cc_get_name(context, ccache));
819 setenv("KRB5CCNAME", s, 1);
821 ret = krb5_cc_cache_match(context, principal, &ccache);
824 ret = krb5_cc_default (context, &ccache);
826 krb5_err (context, 1, ret, N_("resolving credentials cache", ""));
829 * Check if the type support switching, and we do,
830 * then do that instead over overwriting the current
833 type = krb5_cc_get_type(context, ccache);
834 if (krb5_cc_support_switch(context, type)) {
835 krb5_cc_close(context, ccache);
836 ret = krb5_cc_new_unique(context, type, NULL, &ccache);
842 krb5_err (context, 1, ret, N_("resolving credentials cache", ""));
845 if(argc > 1 && k_hasafs ())
850 int tmp = parse_time (lifetime, "s");
852 errx (1, N_("unparsable time: %s", ""), lifetime);
857 if(addrs_flag == 0 && extra_addresses.num_strings > 0)
858 krb5_errx(context, 1,
859 N_("specifying both extra addresses and "
860 "no addresses makes no sense", ""));
863 krb5_addresses addresses;
864 memset(&addresses, 0, sizeof(addresses));
865 for(i = 0; i < extra_addresses.num_strings; i++) {
866 ret = krb5_parse_address(context, extra_addresses.strings[i],
869 krb5_add_extra_addresses(context, &addresses);
870 krb5_free_addresses(context, &addresses);
873 free_getarg_strings(&extra_addresses);
876 if(renew_flag || validate_flag) {
877 ret = renew_validate(context, renew_flag, validate_flag,
878 ccache, server_str, ticket_life);
882 get_new_tickets(context, principal, ccache, ticket_life, 1);
885 if(do_afslog && k_hasafs())
886 krb5_afslog(context, ccache, NULL, NULL);
889 struct renew_ctx ctx;
892 timeout = ticket_lifetime(context, ccache, principal, server_str) / 2;
894 ctx.context = context;
896 ctx.principal = principal;
897 ctx.ticket_life = ticket_life;
899 ret = simple_execvp_timed(argv[1], argv+1,
900 renew_func, &ctx, timeout);
901 #define EX_NOEXEC 126
902 #define EX_NOTFOUND 127
904 krb5_warnx(context, N_("permission denied: %s", ""), argv[1]);
905 else if(ret == EX_NOTFOUND)
906 krb5_warnx(context, N_("command not found: %s", ""), argv[1]);
908 krb5_cc_destroy(context, ccache);
914 krb5_cc_close (context, ccache);
917 krb5_free_principal(context, principal);
918 krb5_free_context (context);