GHA: Make UBSAN build run
[heimdal.git] / kadmin / get.c
blob6e8ada01ea48e0cae59788864cf3ad7160ffe768
1 /*
2 * Copyright (c) 1997-2006 Kungliga Tekniska Högskolan
3 * (Royal Institute of Technology, Stockholm, Sweden).
4 * All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
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
31 * SUCH DAMAGE.
34 #include "kadmin_locl.h"
35 #include "kadmin-commands.h"
36 #include <parse_units.h>
37 #include <rtbl.h>
39 static struct field_name {
40 const char *fieldname;
41 unsigned int fieldvalue;
42 unsigned int subvalue;
43 uint32_t extra_mask;
44 const char *default_header;
45 const char *def_longheader;
46 unsigned int flags;
47 } field_names[] = {
48 { "principal", KADM5_PRINCIPAL, 0, 0, "Principal", "Principal", 0 },
49 { "princ_expire_time", KADM5_PRINC_EXPIRE_TIME, 0, 0, "Expiration", "Principal expires", 0 },
50 { "pw_expiration", KADM5_PW_EXPIRATION, 0, 0, "PW-exp", "Password expires", 0 },
51 { "last_pwd_change", KADM5_LAST_PWD_CHANGE, 0, 0, "PW-change", "Last password change", 0 },
52 { "max_life", KADM5_MAX_LIFE, 0, 0, "Max life", "Max ticket life", 0 },
53 { "max_rlife", KADM5_MAX_RLIFE, 0, 0, "Max renew", "Max renewable life", 0 },
54 { "mod_time", KADM5_MOD_TIME, 0, 0, "Mod time", "Last modified", 0 },
55 { "mod_name", KADM5_MOD_NAME, 0, 0, "Modifier", "Modifier", 0 },
56 { "attributes", KADM5_ATTRIBUTES, 0, 0, "Attributes", "Attributes", 0 },
57 { "kvno", KADM5_KVNO, 0, 0, "Kvno", "Kvno", RTBL_ALIGN_RIGHT },
58 { "mkvno", KADM5_MKVNO, 0, 0, "Mkvno", "Mkvno", RTBL_ALIGN_RIGHT },
59 { "last_success", KADM5_LAST_SUCCESS, 0, 0, "Last login", "Last successful login", 0 },
60 { "last_failed", KADM5_LAST_FAILED, 0, 0, "Last fail", "Last failed login", 0 },
61 { "fail_auth_count", KADM5_FAIL_AUTH_COUNT, 0, 0, "Fail count", "Failed login count", RTBL_ALIGN_RIGHT },
62 { "policy", KADM5_POLICY, 0, 0, "Policy", "Policy", 0 },
63 { "keytypes", KADM5_KEY_DATA, 0, KADM5_PRINCIPAL | KADM5_KVNO, "Keytypes", "Keytypes", 0 },
64 { "server-keytypes", KADM5_TL_DATA, KRB5_TL_ETYPES, 0, "Server keytypes", "Supported keytypes (servers)", 0 },
65 { "password", KADM5_TL_DATA, KRB5_TL_PASSWORD, KADM5_KEY_DATA, "Password", "Password", 0 },
66 { "pkinit-acl", KADM5_TL_DATA, KRB5_TL_PKINIT_ACL, 0, "PK-INIT ACL", "PK-INIT ACL", 0 },
67 { "aliases", KADM5_TL_DATA, KRB5_TL_ALIASES, 0, "Aliases", "Aliases", 0 },
68 { "hist-kvno-diff-clnt", KADM5_TL_DATA, KRB5_TL_HIST_KVNO_DIFF_CLNT, 0, "Clnt hist keys", "Historic keys allowed for client", 0 },
69 { "hist-kvno-diff-svc", KADM5_TL_DATA, KRB5_TL_HIST_KVNO_DIFF_SVC, 0, "Svc hist keys", "Historic keys allowed for service", 0 },
70 { NULL, 0, 0, 0, NULL, NULL, 0 }
73 struct field_info {
74 struct field_name *ff;
75 char *header;
76 struct field_info *next;
79 struct get_entry_data {
80 void (*format)(struct get_entry_data*, kadm5_principal_ent_t);
81 rtbl_t table;
82 uint32_t mask;
83 uint32_t extra_mask;
84 struct field_info *chead, **ctail;
85 const char *krb5_config_fname;
86 void *kadm_handle;
87 uint32_t n;
88 int upto;
91 static int
92 add_column(struct get_entry_data *data, struct field_name *ff, const char *header)
94 struct field_info *f = malloc(sizeof(*f));
95 if (f == NULL)
96 return ENOMEM;
97 f->ff = ff;
98 if(header)
99 f->header = strdup(header);
100 else
101 f->header = NULL;
102 f->next = NULL;
103 *data->ctail = f;
104 data->ctail = &f->next;
105 data->mask |= ff->fieldvalue;
106 data->extra_mask |= ff->extra_mask;
107 if(data->table != NULL)
108 rtbl_add_column_by_id(data->table, ff->fieldvalue,
109 header ? header : ff->default_header, ff->flags);
110 return 0;
114 * return 0 iff `salt' actually is the same as the current salt in `k'
117 static int
118 cmp_salt (const krb5_salt *salt, const krb5_key_data *k)
120 if (salt->salttype != (size_t)k->key_data_type[1])
121 return 1;
122 if (salt->saltvalue.length != (size_t)k->key_data_length[1])
123 return 1;
124 return memcmp (salt->saltvalue.data, k->key_data_contents[1],
125 salt->saltvalue.length);
128 static void
129 format_keytype(krb5_key_data *k, krb5_salt *def_salt, char *buf, size_t buf_len)
131 krb5_error_code ret;
132 char *s;
133 int aret;
135 buf[0] = '\0';
136 ret = krb5_enctype_to_string (context,
137 k->key_data_type[0],
138 &s);
139 if (ret) {
140 aret = asprintf (&s, "unknown(%d)", k->key_data_type[0]);
141 if (aret == -1)
142 return; /* Nothing to do here, we have no way to pass the err */
144 strlcpy(buf, s, buf_len);
145 free(s);
147 strlcat(buf, "(", buf_len);
149 ret = krb5_salttype_to_string (context,
150 k->key_data_type[0],
151 k->key_data_type[1],
152 &s);
153 if (ret) {
154 aret = asprintf (&s, "unknown(%d)", k->key_data_type[1]);
155 if (aret == -1)
156 return; /* Again, nothing else to do... */
158 strlcat(buf, s, buf_len);
159 free(s);
161 aret = 0;
162 if (cmp_salt(def_salt, k) == 0)
163 s = strdup("");
164 else if(k->key_data_length[1] == 0)
165 s = strdup("()");
166 else
167 aret = asprintf (&s, "(%.*s)", k->key_data_length[1],
168 (char *)k->key_data_contents[1]);
169 if (aret == -1 || s == NULL)
170 return; /* Again, nothing else we can do... */
171 strlcat(buf, s, buf_len);
172 free(s);
173 aret = asprintf (&s, "[%d]", k->key_data_kvno);
174 if (aret == -1)
175 return;
176 strlcat(buf, ")", buf_len);
178 strlcat(buf, s, buf_len);
179 free(s);
182 static int
183 is_special_file(const char *fname)
185 #ifdef WIN32
186 if (strcasecmp(fname, "con") == 0 || strcasecmp(fname, "nul") == 0 ||
187 strcasecmp(fname, "aux") == 0 || strcasecmp(fname, "prn") == 0)
188 return 1;
189 if ((strncasecmp(fname, "com", sizeof("com") - 1) == 0 ||
190 strncasecmp(fname, "lpt", sizeof("lpt") - 1) == 0) &&
191 fname[sizeof("lpt")] >= '0' && fname[sizeof("lpt")] <= '9' &&
192 fname[sizeof("lpt") + 1] == '\0')
193 return 1;
194 #else
195 if (strncmp(fname, "/dev/", sizeof("/dev/") - 1) == 0)
196 return 1;
197 #endif
198 return 0;
201 static char *
202 write_krb5_config(krb5_tl_data *tl,
203 const char *fn,
204 uint32_t i)
206 char *s = NULL;
207 FILE *f = NULL;
209 if (fn == NULL)
210 return NULL;
211 if (i == 0 || is_special_file(fn))
212 s = strdup(fn);
213 else if (asprintf(&s, "%s-%u", fn, i) == -1)
214 s = NULL;
215 if (s == NULL)
216 krb5_err(context, 1, errno, "Out of memory");
218 /* rk_dumpdata() doesn't allow error checking :( */
219 if ((f = fopen(s, "w")) &&
220 fwrite(tl->tl_data_contents, tl->tl_data_length, 1, f) != 1)
221 krb5_warn(context, errno, "Could not write to %s", fn);
222 if (f && fclose(f))
223 krb5_warn(context, errno, "Could not write to %s", fn);
224 return s;
227 static void
228 format_field(struct get_entry_data *data,
229 kadm5_principal_ent_t princ,
230 unsigned int field,
231 unsigned int subfield,
232 char *buf,
233 size_t buf_len,
234 int condensed)
236 switch(field) {
237 case KADM5_PRINCIPAL:
238 if(condensed)
239 krb5_unparse_name_fixed_short(context, princ->principal, buf, buf_len);
240 else
241 krb5_unparse_name_fixed(context, princ->principal, buf, buf_len);
242 break;
244 case KADM5_PRINC_EXPIRE_TIME:
245 time_t2str(princ->princ_expire_time, buf, buf_len, !condensed);
246 break;
248 case KADM5_PW_EXPIRATION:
249 time_t2str(princ->pw_expiration, buf, buf_len, !condensed);
250 break;
252 case KADM5_LAST_PWD_CHANGE:
253 time_t2str(princ->last_pwd_change, buf, buf_len, !condensed);
254 break;
256 case KADM5_MAX_LIFE:
257 deltat2str(princ->max_life, buf, buf_len);
258 break;
260 case KADM5_MAX_RLIFE:
261 deltat2str(princ->max_renewable_life, buf, buf_len);
262 break;
264 case KADM5_MOD_TIME:
265 time_t2str(princ->mod_date, buf, buf_len, !condensed);
266 break;
268 case KADM5_MOD_NAME:
269 if (princ->mod_name == NULL)
270 strlcpy(buf, "unknown", buf_len);
271 else if(condensed)
272 krb5_unparse_name_fixed_short(context, princ->mod_name, buf, buf_len);
273 else
274 krb5_unparse_name_fixed(context, princ->mod_name, buf, buf_len);
275 break;
276 case KADM5_ATTRIBUTES:
277 attributes2str (princ->attributes, buf, buf_len);
278 break;
279 case KADM5_KVNO:
280 snprintf(buf, buf_len, "%d", princ->kvno);
281 break;
282 case KADM5_MKVNO:
283 /* XXX libkadm5srv decrypts the keys, so mkvno is always 0. */
284 strlcpy(buf, "unknown", buf_len);
285 break;
286 case KADM5_LAST_SUCCESS:
287 time_t2str(princ->last_success, buf, buf_len, !condensed);
288 break;
289 case KADM5_LAST_FAILED:
290 time_t2str(princ->last_failed, buf, buf_len, !condensed);
291 break;
292 case KADM5_FAIL_AUTH_COUNT:
293 snprintf(buf, buf_len, "%d", princ->fail_auth_count);
294 break;
295 case KADM5_POLICY:
296 if(princ->policy != NULL)
297 strlcpy(buf, princ->policy, buf_len);
298 else
299 strlcpy(buf, "none", buf_len);
300 break;
301 case KADM5_KEY_DATA:{
302 krb5_salt def_salt;
303 int i;
304 char buf2[1024];
305 krb5_get_pw_salt (context, princ->principal, &def_salt);
307 *buf = '\0';
308 for (i = 0; i < princ->n_key_data; ++i) {
309 format_keytype(&princ->key_data[i], &def_salt, buf2, sizeof(buf2));
310 if(i > 0)
311 strlcat(buf, ", ", buf_len);
312 strlcat(buf, buf2, buf_len);
314 krb5_free_salt (context, def_salt);
315 break;
317 case KADM5_TL_DATA: {
318 krb5_tl_data *tl;
320 for (tl = princ->tl_data; tl != NULL; tl = tl->tl_data_next)
321 if ((unsigned)tl->tl_data_type == subfield)
322 break;
323 if (tl == NULL) {
324 strlcpy(buf, "", buf_len);
325 break;
328 switch (subfield) {
329 case KRB5_TL_PASSWORD:
330 snprintf(buf, buf_len, "\"%.*s\"",
331 (int)tl->tl_data_length,
332 (const char *)tl->tl_data_contents);
333 break;
334 case KRB5_TL_ETYPES: {
335 HDB_EncTypeList etypes;
336 size_t i, size;
337 char *str;
338 int ret;
340 ret = decode_HDB_EncTypeList(tl->tl_data_contents,
341 tl->tl_data_length,
342 &etypes, &size);
343 if (ret) {
344 snprintf(buf, buf_len, "failed to decode server etypes");
345 break;
347 buf[0] = '\0';
348 for (i = 0; i < etypes.len; i++) {
349 ret = krb5_enctype_to_string(context, etypes.val[i], &str);
350 if (ret == 0) {
351 if (i)
352 strlcat(buf, ",", buf_len);
353 strlcat(buf, str, buf_len);
354 krb5_xfree(str);
357 free_HDB_EncTypeList(&etypes);
358 break;
360 case KRB5_TL_PKINIT_ACL: {
361 HDB_Ext_PKINIT_acl acl;
362 size_t size;
363 int ret;
364 size_t i;
366 ret = decode_HDB_Ext_PKINIT_acl(tl->tl_data_contents,
367 tl->tl_data_length,
368 &acl,
369 &size);
370 if (ret) {
371 snprintf(buf, buf_len, "failed to decode ACL");
372 break;
375 buf[0] = '\0';
376 for (i = 0; i < acl.len; i++) {
377 strlcat(buf, "subject: ", buf_len);
378 strlcat(buf, acl.val[i].subject, buf_len);
379 if (acl.val[i].issuer) {
380 strlcat(buf, " issuer:", buf_len);
381 strlcat(buf, *acl.val[i].issuer, buf_len);
383 if (acl.val[i].anchor) {
384 strlcat(buf, " anchor:", buf_len);
385 strlcat(buf, *acl.val[i].anchor, buf_len);
387 if (i + 1 < acl.len)
388 strlcat(buf, ", ", buf_len);
390 free_HDB_Ext_PKINIT_acl(&acl);
391 break;
393 case KRB5_TL_KRB5_CONFIG: {
394 char *fname;
396 fname = write_krb5_config(tl, data->krb5_config_fname, data->n);
397 if (fname) {
398 strlcat(buf, fname, buf_len);
399 free(fname);
401 break;
403 case KRB5_TL_ALIASES: {
404 HDB_Ext_Aliases alias;
405 size_t size;
406 int ret;
407 size_t i;
409 ret = decode_HDB_Ext_Aliases(tl->tl_data_contents,
410 tl->tl_data_length,
411 &alias,
412 &size);
413 if (ret) {
414 snprintf(buf, buf_len, "failed to decode alias");
415 break;
417 buf[0] = '\0';
418 for (i = 0; i < alias.aliases.len; i++) {
419 char *p;
420 ret = krb5_unparse_name(context, &alias.aliases.val[i], &p);
421 if (ret)
422 break;
423 if (i > 0)
424 strlcat(buf, " ", buf_len);
425 strlcat(buf, p, buf_len);
426 free(p);
428 free_HDB_Ext_Aliases(&alias);
429 break;
431 default:
432 snprintf(buf, buf_len, "unknown type %d", subfield);
433 break;
435 break;
437 default:
438 strlcpy(buf, "<unknown>", buf_len);
439 break;
443 static void
444 print_entry_short(struct get_entry_data *data, kadm5_principal_ent_t princ)
446 char buf[1024];
447 struct field_info *f;
449 for(f = data->chead; f != NULL; f = f->next) {
450 format_field(data, princ, f->ff->fieldvalue, f->ff->subvalue, buf,
451 sizeof(buf), 1);
452 rtbl_add_column_entry_by_id(data->table, f->ff->fieldvalue, buf);
456 static void
457 print_entry_long(struct get_entry_data *data, kadm5_principal_ent_t princ)
459 char buf[1024];
460 struct field_info *f;
461 int width = 0;
463 for(f = data->chead; f != NULL; f = f->next) {
464 int w = strlen(f->header ? f->header : f->ff->def_longheader);
465 if(w > width)
466 width = w;
468 for(f = data->chead; f != NULL; f = f->next) {
469 format_field(data, princ, f->ff->fieldvalue, f->ff->subvalue, buf,
470 sizeof(buf), 0);
471 printf("%*s: %s\n", width, f->header ? f->header : f->ff->def_longheader, buf);
473 printf("\n");
476 static int
477 do_get_entry(krb5_principal principal, void *data)
479 kadm5_principal_ent_rec princ;
480 krb5_error_code ret;
481 struct get_entry_data *e = data;
483 if (e->upto == 0)
484 return EINTR;
485 if (e->upto > 0)
486 e->upto--;
488 memset(&princ, 0, sizeof(princ));
489 ret = kadm5_get_principal(e->kadm_handle, principal,
490 &princ,
491 e->mask | e->extra_mask);
492 if (ret == 0) {
493 (e->format)(e, &princ);
494 kadm5_free_principal_ent(e->kadm_handle, &princ);
497 e->n++;
498 return ret;
501 static void
502 free_columns(struct get_entry_data *data)
504 struct field_info *f, *next;
505 for(f = data->chead; f != NULL; f = next) {
506 free(f->header);
507 next = f->next;
508 free(f);
510 data->chead = NULL;
511 data->ctail = &data->chead;
514 static int
515 setup_columns(struct get_entry_data *data, const char *column_info)
517 char buf[1024], *q;
518 char *field, *header;
519 struct field_name *f;
521 while(strsep_copy(&column_info, ",", buf, sizeof(buf)) != -1) {
522 q = buf;
523 field = strsep(&q, "=");
524 header = strsep(&q, "=");
525 for(f = field_names; f->fieldname != NULL; f++) {
526 if(strcasecmp(field, f->fieldname) == 0) {
527 add_column(data, f, header);
528 break;
531 if(f->fieldname == NULL) {
532 krb5_warnx(context, "unknown field name \"%s\"", field);
533 free_columns(data);
534 return -1;
537 return 0;
540 static int
541 do_list_entry(krb5_principal principal, void *data)
543 char buf[1024];
544 int *upto = data;
545 krb5_error_code ret;
547 if (*upto == 0)
548 return EINTR;
549 if (*upto > 0)
550 (*upto)--;
552 ret = krb5_unparse_name_fixed_short(context, principal, buf, sizeof(buf));
553 if (ret != 0)
554 return ret;
555 printf("%s\n", buf);
556 return 0;
559 static int
560 listit(const char *funcname, int upto, int argc, char **argv)
562 int i;
563 krb5_error_code ret, saved_ret = 0;
565 for (i = 0; i < argc; i++) {
566 ret = foreach_principal(argv[i], do_list_entry, funcname, &upto);
567 if (saved_ret == 0 && ret != 0)
568 saved_ret = ret;
570 return saved_ret != 0;
573 #define DEFAULT_COLUMNS_SHORT "principal,princ_expire_time,pw_expiration,last_pwd_change,max_life,max_rlife"
574 #define DEFAULT_COLUMNS_LONG "principal,princ_expire_time,pw_expiration,last_pwd_change,max_life,max_rlife,kvno,mkvno,last_success,last_failed,fail_auth_count,mod_time,mod_name,attributes,server-keytypes,keytypes,pkinit-acl,aliases"
576 static int
577 getit(struct get_options *opt, const char *name, int argc, char **argv)
579 int i;
580 krb5_error_code ret;
581 struct get_entry_data data;
583 if(opt->long_flag == -1 && (opt->short_flag == 1 || opt->terse_flag == 1))
584 opt->long_flag = 0;
585 if(opt->short_flag == -1 && (opt->long_flag == 1 || opt->terse_flag == 1))
586 opt->short_flag = 0;
587 if(opt->terse_flag == -1 && (opt->long_flag == 1 || opt->short_flag == 1))
588 opt->terse_flag = 0;
589 if(opt->long_flag == 0 && opt->short_flag == 0 && opt->terse_flag == 0)
590 opt->short_flag = 1;
592 if (opt->terse_flag)
593 return listit(name, opt->upto_integer, argc, argv);
595 data.kadm_handle = NULL;
596 ret = kadm5_dup_context(kadm_handle, &data.kadm_handle);
597 if (ret)
598 krb5_err(context, 1, ret, "Could not duplicate kadmin connection");
599 data.table = NULL;
600 data.chead = NULL;
601 data.ctail = &data.chead;
602 data.mask = 0;
603 data.extra_mask = 0;
604 data.krb5_config_fname = opt->krb5_config_file_string;
605 data.upto = opt->upto_integer;
606 data.n = 0;
608 if(opt->short_flag) {
609 data.table = rtbl_create();
610 rtbl_set_separator(data.table, " ");
611 data.format = print_entry_short;
612 } else
613 data.format = print_entry_long;
614 if(opt->column_info_string == NULL) {
615 if(opt->long_flag)
616 ret = setup_columns(&data, DEFAULT_COLUMNS_LONG);
617 else
618 ret = setup_columns(&data, DEFAULT_COLUMNS_SHORT);
619 } else
620 ret = setup_columns(&data, opt->column_info_string);
622 if(ret != 0) {
623 if(data.table != NULL)
624 rtbl_destroy(data.table);
625 return 0;
628 for(i = 0; i < argc; i++)
629 ret = foreach_principal(argv[i], do_get_entry, name, &data);
631 kadm5_destroy(data.kadm_handle);
633 if(data.table != NULL) {
634 rtbl_format(data.table, stdout);
635 rtbl_destroy(data.table);
637 free_columns(&data);
638 return ret != 0;
642 get_entry(struct get_options *opt, int argc, char **argv)
644 return getit(opt, "get", argc, argv);
648 list_princs(struct list_options *opt, int argc, char **argv)
650 struct get_options get_opt;
652 if(sizeof(struct get_options) != sizeof(struct list_options)) {
653 krb5_warnx(context, "programmer error: sizeof(struct get_options) != sizeof(struct list_options)");
654 return 0;
656 memset(&get_opt, 0, sizeof(get_opt));
657 get_opt.long_flag = opt->long_flag;
658 get_opt.short_flag = opt->short_flag;
659 get_opt.terse_flag = opt->terse_flag;
660 get_opt.column_info_string = opt->column_info_string;
661 get_opt.upto_integer = opt->upto_integer;
662 return getit(&get_opt, "list", argc, argv);