Add.
[shishi.git] / lib / tkt.c
blobb5bcd31ddd2f5829e5a162812be6099afa9caeeb
1 /* tkt.c --- Ticket handling.
2 * Copyright (C) 2002, 2003, 2004, 2006, 2007 Simon Josefsson
4 * This file is part of Shishi.
6 * Shishi is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
11 * Shishi is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with Shishi; if not, see http://www.gnu.org/licenses or write
18 * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
19 * Floor, Boston, MA 02110-1301, USA
23 #include "internal.h"
25 struct Shishi_tkt
27 Shishi *handle;
28 Shishi_asn1 ticket;
29 Shishi_asn1 kdcrep;
30 Shishi_asn1 enckdcreppart;
31 Shishi_asn1 encticketpart;
32 Shishi_key *key;
35 /**
36 * shishi_tkt:
37 * @handle: shishi handle as allocated by shishi_init().
38 * @tkt: output variable with newly allocated ticket.
40 * Create a new ticket handle.
42 * Return value: Returns SHISHI_OK iff successful.
43 **/
44 int
45 shishi_tkt (Shishi * handle, Shishi_tkt ** tkt)
47 Shishi_tkt *t;
48 int res;
50 t = xcalloc (1, sizeof (*t));
52 t->handle = handle;
54 t->ticket = shishi_ticket (handle);
55 if (t->ticket == NULL)
57 shishi_error_printf (handle, "Could not create Ticket: %s\n",
58 shishi_error (handle));
59 return SHISHI_ASN1_ERROR;
62 /* XXX what about tgs's? */
63 t->enckdcreppart = shishi_encasreppart (handle);
64 if (t->enckdcreppart == NULL)
66 shishi_error_printf (handle, "Could not create EncKDCRepPart: %s\n",
67 shishi_error (handle));
68 return SHISHI_ASN1_ERROR;
71 t->encticketpart = shishi_encticketpart (handle);
72 if (t->encticketpart == NULL)
74 shishi_error_printf (handle, "Could not create EncTicketPart: %s\n",
75 shishi_error (handle));
76 return SHISHI_ASN1_ERROR;
79 res = shishi_encticketpart_transited_set (handle,
80 t->encticketpart,
81 SHISHI_TR_DOMAIN_X500_COMPRESS,
82 "", 0);
83 if (res != SHISHI_OK)
84 return res;
86 res = shishi_encticketpart_authtime_set
87 (handle, t->encticketpart, shishi_generalize_time (handle, time (NULL)));
88 if (res != SHISHI_OK)
89 return res;
91 res = shishi_encticketpart_endtime_set
92 (handle, t->encticketpart,
93 shishi_generalize_time (handle, time (NULL) + 1000));
94 if (res != SHISHI_OK)
95 return res;
97 t->kdcrep = shishi_asrep (handle);
98 if (t->kdcrep == NULL)
100 shishi_error_printf (handle, "Could not create AS-REP: %s\n",
101 shishi_error (handle));
102 return SHISHI_ASN1_ERROR;
105 /* XXX We don't allocate t->key here, because shishi_tkt_key()
106 relies on it being NULL. Possibly, we should allocate it here
107 instead, and simplify shishi_tkt_key(). */
109 *tkt = t;
111 return SHISHI_OK;
115 * shishi_tkt2:
116 * @handle: shishi handle as allocated by shishi_init().
117 * @ticket: input variable with ticket.
118 * @enckdcreppart: input variable with auxilliary ticket information.
119 * @kdcrep: input variable with KDC-REP ticket information.
121 * Create a new ticket handle.
123 * Return value: Returns new ticket handle, or %NULL on error.
125 Shishi_tkt *
126 shishi_tkt2 (Shishi * handle,
127 Shishi_asn1 ticket, Shishi_asn1 enckdcreppart,
128 Shishi_asn1 kdcrep)
130 Shishi_tkt *tkt;
132 tkt = xcalloc (1, sizeof (*tkt));
134 tkt->handle = handle;
135 tkt->ticket = ticket;
136 tkt->enckdcreppart = enckdcreppart;
137 tkt->kdcrep = kdcrep;
139 return tkt;
143 * shishi_tkt_done:
144 * @tkt: input variable with ticket info.
146 * Deallocate resources associated with ticket. The ticket must not
147 * be used again after this call.
149 void
150 shishi_tkt_done (Shishi_tkt * tkt)
152 if (tkt->key)
153 shishi_key_done (tkt->key);
154 free (tkt);
159 shishi_tkt_build (Shishi_tkt * tkt, Shishi_key * key)
161 int res;
163 res = shishi_ticket_add_enc_part (tkt->handle, tkt->ticket,
164 key, tkt->encticketpart);
165 if (res != SHISHI_OK)
166 return res;
168 return SHISHI_OK;
172 * shishi_tkt_ticket:
173 * @tkt: input variable with ticket info.
175 * Get ASN.1 Ticket structure from ticket.
177 * Return value: Returns actual ticket.
179 Shishi_asn1
180 shishi_tkt_ticket (Shishi_tkt * tkt)
182 return tkt->ticket;
186 * shishi_tkt_ticket_set:
187 * @tkt: input variable with ticket info.
188 * @ticket: ASN.1 Ticket to store in ticket.
190 * Set the ASN.1 Ticket in the Ticket.
192 void
193 shishi_tkt_ticket_set (Shishi_tkt * tkt, Shishi_asn1 ticket)
195 if (tkt->ticket)
196 shishi_asn1_done (tkt->handle, tkt->ticket);
197 tkt->ticket = ticket;
201 * shishi_tkt_enckdcreppart:
202 * @tkt: input variable with ticket info.
204 * Get ASN.1 EncKDCRepPart structure from ticket.
206 * Return value: Returns auxilliary ticket information.
208 Shishi_asn1
209 shishi_tkt_enckdcreppart (Shishi_tkt * tkt)
211 return tkt->enckdcreppart;
215 * shishi_tkt_enckdcreppart_set:
216 * @tkt: structure that holds information about Ticket exchange
217 * @enckdcreppart: EncKDCRepPart to store in Ticket.
219 * Set the EncKDCRepPart in the Ticket.
221 void
222 shishi_tkt_enckdcreppart_set (Shishi_tkt * tkt, Shishi_asn1 enckdcreppart)
224 if (tkt->enckdcreppart)
225 shishi_asn1_done (tkt->handle, tkt->enckdcreppart);
226 tkt->enckdcreppart = enckdcreppart;
230 * shishi_tkt_kdcrep:
231 * @tkt: input variable with ticket info.
233 * Get ASN.1 KDCRep structure from ticket.
235 * Return value: Returns KDC-REP information.
237 Shishi_asn1
238 shishi_tkt_kdcrep (Shishi_tkt * tkt)
240 return tkt->kdcrep;
244 * shishi_tkt_encticketpart:
245 * @tkt: input variable with ticket info.
247 * Get ASN.1 EncTicketPart structure from ticket.
249 * Return value: Returns EncTicketPart information.
251 Shishi_asn1
252 shishi_tkt_encticketpart (Shishi_tkt * tkt)
254 return tkt->encticketpart;
258 * shishi_tkt_encticketpart_set:
259 * @tkt: input variable with ticket info.
260 * @encticketpart: encticketpart to store in ticket.
262 * Set the EncTicketPart in the Ticket.
264 void
265 shishi_tkt_encticketpart_set (Shishi_tkt * tkt, Shishi_asn1 encticketpart)
267 if (tkt->encticketpart)
268 shishi_asn1_done (tkt->handle, tkt->encticketpart);
269 tkt->encticketpart = encticketpart;
273 * shishi_tkt_key:
274 * @tkt: input variable with ticket info.
276 * Get key used in ticket, by looking first in EncKDCRepPart and then
277 * in EncTicketPart. If key is already populated, it is not extracted
278 * again.
280 * Return value: Returns key extracted from EncKDCRepPart or
281 * EncTicketPart.
283 Shishi_key *
284 shishi_tkt_key (Shishi_tkt * tkt)
286 int rc;
288 /* XXX We probably shouldn't extract the keys here. Where is this
289 extraction actually needed? */
290 if (!tkt->key && tkt->enckdcreppart)
292 rc = shishi_enckdcreppart_get_key (tkt->handle,
293 tkt->enckdcreppart, &tkt->key);
294 if (rc != SHISHI_OK)
295 return NULL;
297 else if (!tkt->key && tkt->encticketpart)
299 rc = shishi_encticketpart_get_key (tkt->handle,
300 tkt->encticketpart, &tkt->key);
301 if (rc != SHISHI_OK)
302 return NULL;
305 return tkt->key;
309 * shishi_tkt_key_set:
310 * @tkt: input variable with ticket info.
311 * @key: key to store in ticket.
313 * Set the key in the EncTicketPart.
315 * Return value: Returns SHISHI_OK iff successful.
318 shishi_tkt_key_set (Shishi_tkt * tkt, Shishi_key * key)
320 int res;
322 res = shishi_encticketpart_key_set (tkt->handle, tkt->encticketpart, key);
323 if (res != SHISHI_OK)
324 return res;
326 res = shishi_enckdcreppart_key_set (tkt->handle, tkt->enckdcreppart, key);
327 if (res != SHISHI_OK)
328 return res;
330 if (!tkt->key)
332 res = shishi_key (tkt->handle, &tkt->key);
333 if (res != SHISHI_OK)
334 return res;
337 shishi_key_copy (tkt->key, key);
339 return SHISHI_OK;
343 shishi_tkt_clientrealm_set (Shishi_tkt * tkt,
344 const char *realm, const char *client)
346 int res;
348 res = shishi_encticketpart_crealm_set (tkt->handle,
349 tkt->encticketpart, realm);
350 if (res != SHISHI_OK)
351 return res;
353 res = shishi_encticketpart_cname_set (tkt->handle,
354 tkt->encticketpart,
355 SHISHI_NT_UNKNOWN, client);
356 if (res != SHISHI_OK)
357 return res;
359 return SHISHI_OK;
363 shishi_tkt_serverrealm_set (Shishi_tkt * tkt,
364 const char *realm, const char *server)
366 int res;
368 res = shishi_ticket_srealmserver_set (tkt->handle, tkt->ticket,
369 realm, server);
370 if (res != SHISHI_OK)
371 return res;
373 res = shishi_enckdcreppart_srealmserver_set
374 (tkt->handle, tkt->enckdcreppart, realm, server);
375 if (res != SHISHI_OK)
376 return res;
378 return SHISHI_OK;
382 * shishi_tkt_client:
383 * @tkt: input variable with ticket info.
384 * @client: pointer to newly allocated zero terminated string containing
385 * principal name. May be %NULL (to only populate @clientlen).
386 * @clientlen: pointer to length of @client on output, excluding terminating
387 * zero. May be %NULL (to only populate @client).
389 * Represent client principal name in Ticket KDC-REP as
390 * zero-terminated string. The string is allocate by this function,
391 * and it is the responsibility of the caller to deallocate it. Note
392 * that the output length @clientlen does not include the terminating
393 * zero.
395 * Return value: Returns SHISHI_OK iff successful.
398 shishi_tkt_client (Shishi_tkt * tkt, char **client, size_t * clientlen)
400 return shishi_principal_name (tkt->handle, tkt->kdcrep,
401 "cname", client, clientlen);
405 * shishi_tkt_client_p:
406 * @tkt: input variable with ticket info.
407 * @client: client name of ticket.
409 * Determine if ticket is for specified client.
411 * Return value: Returns non-0 iff ticket is for specified client.
414 shishi_tkt_client_p (Shishi_tkt * tkt, const char *client)
416 char *buf;
417 size_t buflen;
418 int res;
420 res = shishi_tkt_client (tkt, &buf, &buflen);
421 if (res != SHISHI_OK)
422 return 0;
424 res = strcmp (client, buf) == 0;
426 free (buf);
428 return res;
432 * shishi_tkt_clientrealm:
433 * @tkt: input variable with ticket info.
434 * @client: pointer to newly allocated zero terminated string containing
435 * principal name and realm. May be %NULL (to only populate @clientlen).
436 * @clientlen: pointer to length of @client on output, excluding terminating
437 * zero. May be %NULL (to only populate @client).
439 * Convert cname and realm fields from AS-REQ to printable principal
440 * name format. The string is allocate by this function, and it is
441 * the responsibility of the caller to deallocate it. Note that the
442 * output length @clientlen does not include the terminating zero.
444 * Return value: Returns SHISHI_OK iff successful.
447 shishi_tkt_clientrealm (Shishi_tkt * tkt, char **client, size_t * clientlen)
449 return shishi_principal_name_realm (tkt->handle,
450 tkt->kdcrep, "cname",
451 tkt->kdcrep, "crealm",
452 client, clientlen);
456 * shishi_tkt_clientrealm_p:
457 * @tkt: input variable with ticket info.
458 * @client: principal name (client name and realm) of ticket.
460 * Determine if ticket is for specified client principal.
462 * Return value: Returns non-0 iff ticket is for specified client principal.
465 shishi_tkt_clientrealm_p (Shishi_tkt * tkt, const char *client)
467 char *buf;
468 size_t buflen;
469 int res;
471 res = shishi_tkt_clientrealm (tkt, &buf, &buflen);
472 if (res != SHISHI_OK)
473 return 0;
475 res = strcmp (client, buf) == 0;
477 free (buf);
479 return res;
483 * shishi_tkt_realm:
484 * @tkt: input variable with ticket info.
485 * @realm: pointer to newly allocated character array with realm name.
486 * @realmlen: length of newly allocated character array with realm name.
488 * Extract realm of server in ticket.
490 * Return value: Returns SHISHI_OK iff successful.
493 shishi_tkt_realm (Shishi_tkt * tkt, char **realm, size_t * realmlen)
495 return shishi_ticket_realm_get (tkt->handle, tkt->ticket, realm, realmlen);
499 * shishi_tkt_server:
500 * @tkt: input variable with ticket info.
501 * @server: pointer to newly allocated zero terminated string containing
502 * principal name. May be %NULL (to only populate @serverlen).
503 * @serverlen: pointer to length of @server on output, excluding terminating
504 * zero. May be %NULL (to only populate @server).
506 * Represent server principal name in Ticket as zero-terminated
507 * string. The string is allocate by this function, and it is the
508 * responsibility of the caller to deallocate it. Note that the
509 * output length @serverlen does not include the terminating zero.
511 * Return value: Returns SHISHI_OK iff successful.
514 shishi_tkt_server (Shishi_tkt * tkt, char **server, size_t * serverlen)
516 return shishi_ticket_server (tkt->handle, tkt->ticket, server, serverlen);
520 * shishi_tkt_server_p:
521 * @tkt: input variable with ticket info.
522 * @server: server name of ticket.
524 * Determine if ticket is for specified server.
526 * Return value: Returns non-0 iff ticket is for specified server.
529 shishi_tkt_server_p (Shishi_tkt * tkt, const char *server)
531 char *buf;
532 int res;
534 res = shishi_tkt_server (tkt, &buf, NULL);
535 if (res != SHISHI_OK)
536 return 0;
538 res = strcmp (server, buf) == 0;
540 free (buf);
542 return res;
546 * shishi_tkt_flags:
547 * @tkt: input variable with ticket info.
548 * @flags: pointer to output integer with flags.
550 * Extract flags in ticket (i.e., EncKDCRepPart).
552 * Return value: Returns SHISHI_OK iff successful.
555 shishi_tkt_flags (Shishi_tkt * tkt, uint32_t * flags)
557 return shishi_asn1_read_bitstring (tkt->handle, tkt->enckdcreppart,
558 "flags", flags);
562 * shishi_tkt_flags_set:
563 * @tkt: input variable with ticket info.
564 * @flags: integer with flags to store in ticket.
566 * Set flags in ticket, i.e., both EncTicketPart and EncKDCRepPart.
567 * Note that this reset any already existing flags.
569 * Return value: Returns SHISHI_OK iff successful.
572 shishi_tkt_flags_set (Shishi_tkt * tkt, uint32_t flags)
574 int res;
576 res = shishi_encticketpart_flags_set (tkt->handle, tkt->encticketpart,
577 flags);
578 if (res != SHISHI_OK)
579 return res;
581 res = shishi_enckdcreppart_flags_set (tkt->handle, tkt->enckdcreppart,
582 flags);
583 if (res != SHISHI_OK)
584 return res;
586 return SHISHI_OK;
590 * shishi_tkt_flags_add:
591 * @tkt: input variable with ticket info.
592 * @flag: integer with flags to store in ticket.
594 * Add ticket flags to Ticket and EncKDCRepPart. This preserves all
595 * existing options.
597 * Return value: Returns SHISHI_OK iff successful.
600 shishi_tkt_flags_add (Shishi_tkt * tkt, uint32_t flag)
602 uint32_t flags;
603 int res;
605 res = shishi_tkt_flags (tkt, &flags);
606 if (res != SHISHI_OK)
607 return res;
609 flags |= flag;
611 res = shishi_tkt_flags_set (tkt, flags);
612 if (res != SHISHI_OK)
613 return res;
615 return SHISHI_OK;
619 * shishi_tkt_forwardable_p:
620 * @tkt: input variable with ticket info.
622 * Determine if ticket is forwardable.
624 * The FORWARDABLE flag in a ticket is normally only interpreted by
625 * the ticket-granting service. It can be ignored by application
626 * servers. The FORWARDABLE flag has an interpretation similar to
627 * that of the PROXIABLE flag, except ticket-granting tickets may also
628 * be issued with different network addresses. This flag is reset by
629 * default, but users MAY request that it be set by setting the
630 * FORWARDABLE option in the AS request when they request their
631 * initial ticket-granting ticket.
633 * Return value: Returns non-0 iff forwardable flag is set in ticket.
636 shishi_tkt_forwardable_p (Shishi_tkt * tkt)
638 uint32_t flags = 0;
640 shishi_tkt_flags (tkt, &flags);
642 return flags & SHISHI_TICKETFLAGS_FORWARDABLE;
646 * shishi_tkt_forwarded_p:
647 * @tkt: input variable with ticket info.
649 * Determine if ticket is forwarded.
651 * The FORWARDED flag is set by the TGS when a client presents a
652 * ticket with the FORWARDABLE flag set and requests a forwarded
653 * ticket by specifying the FORWARDED KDC option and supplying a set
654 * of addresses for the new ticket. It is also set in all tickets
655 * issued based on tickets with the FORWARDED flag set. Application
656 * servers may choose to process FORWARDED tickets differently than
657 * non-FORWARDED tickets.
659 * Return value: Returns non-0 iff forwarded flag is set in ticket.
662 shishi_tkt_forwarded_p (Shishi_tkt * tkt)
664 uint32_t flags = 0;
666 shishi_tkt_flags (tkt, &flags);
668 return flags & SHISHI_TICKETFLAGS_FORWARDED;
672 * shishi_tkt_proxiable_p:
673 * @tkt: input variable with ticket info.
675 * Determine if ticket is proxiable.
677 * The PROXIABLE flag in a ticket is normally only interpreted by the
678 * ticket-granting service. It can be ignored by application servers.
679 * When set, this flag tells the ticket-granting server that it is OK
680 * to issue a new ticket (but not a ticket-granting ticket) with a
681 * different network address based on this ticket. This flag is set if
682 * requested by the client on initial authentication. By default, the
683 * client will request that it be set when requesting a
684 * ticket-granting ticket, and reset when requesting any other ticket.
686 * Return value: Returns non-0 iff proxiable flag is set in ticket.
689 shishi_tkt_proxiable_p (Shishi_tkt * tkt)
691 uint32_t flags = 0;
693 shishi_tkt_flags (tkt, &flags);
695 return flags & SHISHI_TICKETFLAGS_PROXIABLE;
699 * shishi_tkt_proxy_p:
700 * @tkt: input variable with ticket info.
702 * Determine if ticket is proxy ticket.
704 * The PROXY flag is set in a ticket by the TGS when it issues a proxy
705 * ticket. Application servers MAY check this flag and at their
706 * option they MAY require additional authentication from the agent
707 * presenting the proxy in order to provide an audit trail.
709 * Return value: Returns non-0 iff proxy flag is set in ticket.
712 shishi_tkt_proxy_p (Shishi_tkt * tkt)
714 uint32_t flags = 0;
716 shishi_tkt_flags (tkt, &flags);
718 return flags & SHISHI_TICKETFLAGS_PROXY;
722 * shishi_tkt_may_postdate_p:
723 * @tkt: input variable with ticket info.
725 * Determine if ticket may be used to grant postdated tickets.
727 * The MAY-POSTDATE flag in a ticket is normally only interpreted by
728 * the ticket-granting service. It can be ignored by application
729 * servers. This flag MUST be set in a ticket-granting ticket in
730 * order to issue a postdated ticket based on the presented ticket. It
731 * is reset by default; it MAY be requested by a client by setting the
732 * ALLOW- POSTDATE option in the KRB_AS_REQ message. This flag does
733 * not allow a client to obtain a postdated ticket-granting ticket;
734 * postdated ticket-granting tickets can only by obtained by
735 * requesting the postdating in the KRB_AS_REQ message. The life
736 * (endtime-starttime) of a postdated ticket will be the remaining
737 * life of the ticket-granting ticket at the time of the request,
738 * unless the RENEWABLE option is also set, in which case it can be
739 * the full life (endtime-starttime) of the ticket-granting
740 * ticket. The KDC MAY limit how far in the future a ticket may be
741 * postdated.
743 * Return value: Returns non-0 iff may-postdate flag is set in ticket.
746 shishi_tkt_may_postdate_p (Shishi_tkt * tkt)
748 uint32_t flags = 0;
750 shishi_tkt_flags (tkt, &flags);
752 return flags & SHISHI_TICKETFLAGS_MAY_POSTDATE;
756 * shishi_tkt_postdated_p:
757 * @tkt: input variable with ticket info.
759 * Determine if ticket is postdated.
761 * The POSTDATED flag indicates that a ticket has been postdated. The
762 * application server can check the authtime field in the ticket to
763 * see when the original authentication occurred. Some services MAY
764 * choose to reject postdated tickets, or they may only accept them
765 * within a certain period after the original authentication. When the
766 * KDC issues a POSTDATED ticket, it will also be marked as INVALID,
767 * so that the application client MUST present the ticket to the KDC
768 * to be validated before use.
770 * Return value: Returns non-0 iff postdated flag is set in ticket.
773 shishi_tkt_postdated_p (Shishi_tkt * tkt)
775 uint32_t flags = 0;
777 shishi_tkt_flags (tkt, &flags);
779 return flags & SHISHI_TICKETFLAGS_POSTDATED;
783 * shishi_tkt_invalid_p:
784 * @tkt: input variable with ticket info.
786 * Determine if ticket is invalid.
788 * The INVALID flag indicates that a ticket is invalid. Application
789 * servers MUST reject tickets which have this flag set. A postdated
790 * ticket will be issued in this form. Invalid tickets MUST be
791 * validated by the KDC before use, by presenting them to the KDC in a
792 * TGS request with the VALIDATE option specified. The KDC will only
793 * validate tickets after their starttime has passed. The validation
794 * is required so that postdated tickets which have been stolen before
795 * their starttime can be rendered permanently invalid (through a
796 * hot-list mechanism).
798 * Return value: Returns non-0 iff invalid flag is set in ticket.
801 shishi_tkt_invalid_p (Shishi_tkt * tkt)
803 uint32_t flags = 0;
805 shishi_tkt_flags (tkt, &flags);
807 return flags & SHISHI_TICKETFLAGS_INVALID;
811 * shishi_tkt_renewable_p:
812 * @tkt: input variable with ticket info.
814 * Determine if ticket is renewable.
816 * The RENEWABLE flag in a ticket is normally only interpreted by the
817 * ticket-granting service (discussed below in section 3.3). It can
818 * usually be ignored by application servers. However, some
819 * particularly careful application servers MAY disallow renewable
820 * tickets.
822 * Return value: Returns non-0 iff renewable flag is set in ticket.
825 shishi_tkt_renewable_p (Shishi_tkt * tkt)
827 uint32_t flags = 0;
829 shishi_tkt_flags (tkt, &flags);
831 return flags & SHISHI_TICKETFLAGS_RENEWABLE;
835 * shishi_tkt_initial_p:
836 * @tkt: input variable with ticket info.
838 * Determine if ticket was issued using AS exchange.
840 * The INITIAL flag indicates that a ticket was issued using the AS
841 * protocol, rather than issued based on a ticket-granting ticket.
842 * Application servers that want to require the demonstrated knowledge
843 * of a client's secret key (e.g. a password-changing program) can
844 * insist that this flag be set in any tickets they accept, and thus
845 * be assured that the client's key was recently presented to the
846 * application client.
848 * Return value: Returns non-0 iff initial flag is set in ticket.
851 shishi_tkt_initial_p (Shishi_tkt * tkt)
853 uint32_t flags = 0;
855 shishi_tkt_flags (tkt, &flags);
857 return flags & SHISHI_TICKETFLAGS_INITIAL;
861 * shishi_tkt_pre_authent_p:
862 * @tkt: input variable with ticket info.
864 * Determine if ticket was pre-authenticated.
866 * The PRE-AUTHENT and HW-AUTHENT flags provide additional information
867 * about the initial authentication, regardless of whether the current
868 * ticket was issued directly (in which case INITIAL will also be set)
869 * or issued on the basis of a ticket-granting ticket (in which case
870 * the INITIAL flag is clear, but the PRE-AUTHENT and HW-AUTHENT flags
871 * are carried forward from the ticket-granting ticket).
873 * Return value: Returns non-0 iff pre-authent flag is set in ticket.
876 shishi_tkt_pre_authent_p (Shishi_tkt * tkt)
878 uint32_t flags = 0;
880 shishi_tkt_flags (tkt, &flags);
882 return flags & SHISHI_TICKETFLAGS_PRE_AUTHENT;
886 * shishi_tkt_hw_authent_p:
887 * @tkt: input variable with ticket info.
889 * Determine if ticket is authenticated using a hardware token.
891 * The PRE-AUTHENT and HW-AUTHENT flags provide additional information
892 * about the initial authentication, regardless of whether the current
893 * ticket was issued directly (in which case INITIAL will also be set)
894 * or issued on the basis of a ticket-granting ticket (in which case
895 * the INITIAL flag is clear, but the PRE-AUTHENT and HW-AUTHENT flags
896 * are carried forward from the ticket-granting ticket).
898 * Return value: Returns non-0 iff hw-authent flag is set in ticket.
901 shishi_tkt_hw_authent_p (Shishi_tkt * tkt)
903 uint32_t flags = 0;
905 shishi_tkt_flags (tkt, &flags);
907 return flags & SHISHI_TICKETFLAGS_HW_AUTHENT;
911 * shishi_tkt_transited_policy_checked_p:
912 * @tkt: input variable with ticket info.
914 * Determine if ticket has been policy checked for transit.
916 * The application server is ultimately responsible for accepting or
917 * rejecting authentication and SHOULD check that only suitably
918 * trusted KDCs are relied upon to authenticate a principal. The
919 * transited field in the ticket identifies which realms (and thus
920 * which KDCs) were involved in the authentication process and an
921 * application server would normally check this field. If any of these
922 * are untrusted to authenticate the indicated client principal
923 * (probably determined by a realm-based policy), the authentication
924 * attempt MUST be rejected. The presence of trusted KDCs in this list
925 * does not provide any guarantee; an untrusted KDC may have
926 * fabricated the list.
928 * While the end server ultimately decides whether authentication is
929 * valid, the KDC for the end server's realm MAY apply a realm
930 * specific policy for validating the transited field and accepting
931 * credentials for cross-realm authentication. When the KDC applies
932 * such checks and accepts such cross-realm authentication it will set
933 * the TRANSITED-POLICY-CHECKED flag in the service tickets it issues
934 * based on the cross-realm TGT. A client MAY request that the KDCs
935 * not check the transited field by setting the
936 * DISABLE-TRANSITED-CHECK flag. KDCs are encouraged but not required
937 * to honor this flag.
939 * Application servers MUST either do the transited-realm checks
940 * themselves, or reject cross-realm tickets without TRANSITED-POLICY-
941 * CHECKED set.
943 * Return value: Returns non-0 iff transited-policy-checked flag is
944 * set in ticket.
947 shishi_tkt_transited_policy_checked_p (Shishi_tkt * tkt)
949 uint32_t flags = 0;
951 shishi_tkt_flags (tkt, &flags);
953 return flags & SHISHI_TICKETFLAGS_TRANSITED_POLICY_CHECKED;
957 * shishi_tkt_ok_as_delegate_p:
958 * @tkt: input variable with ticket info.
960 * Determine if ticket is ok as delegated ticket.
962 * The copy of the ticket flags in the encrypted part of the KDC reply
963 * may have the OK-AS-DELEGATE flag set to indicates to the client
964 * that the server specified in the ticket has been determined by
965 * policy of the realm to be a suitable recipient of delegation. A
966 * client can use the presence of this flag to help it make a decision
967 * whether to delegate credentials (either grant a proxy or a
968 * forwarded ticket- granting ticket) to this server. It is
969 * acceptable to ignore the value of this flag. When setting this
970 * flag, an administrator should consider the security and placement
971 * of the server on which the service will run, as well as whether the
972 * service requires the use of delegated credentials.
974 * Return value: Returns non-0 iff ok-as-delegate flag is set in ticket.
977 shishi_tkt_ok_as_delegate_p (Shishi_tkt * tkt)
979 uint32_t flags = 0;
981 shishi_tkt_flags (tkt, &flags);
983 return flags & SHISHI_TICKETFLAGS_OK_AS_DELEGATE;
987 * shishi_tkt_keytype:
988 * @tkt: input variable with ticket info.
989 * @etype: pointer to encryption type that is set, see Shishi_etype.
991 * Extract encryption type of key in ticket (really EncKDCRepPart).
993 * Return value: Returns SHISHI_OK iff successful.
996 shishi_tkt_keytype (Shishi_tkt * tkt, int32_t * etype)
998 return shishi_asn1_read_int32 (tkt->handle, tkt->enckdcreppart,
999 "key.keytype", etype);
1003 * shishi_tkt_keytype_fast:
1004 * @tkt: input variable with ticket info.
1006 * Extract encryption type of key in ticket (really EncKDCRepPart).
1008 * Return value: Returns encryption type of session key in ticket
1009 * (really EncKDCRepPart), or -1 on error.
1011 int32_t
1012 shishi_tkt_keytype_fast (Shishi_tkt * tkt)
1014 int32_t etype = -1;
1015 int res;
1017 res = shishi_asn1_read_int32 (tkt->handle, tkt->enckdcreppart,
1018 "key.keytype", &etype);
1019 if (res != SHISHI_OK)
1020 return -1;
1022 return etype;
1026 * shishi_tkt_keytype_p:
1027 * @tkt: input variable with ticket info.
1028 * @etype: encryption type, see Shishi_etype.
1030 * Determine if key in ticket (really EncKDCRepPart) is of specified
1031 * key type (really encryption type).
1033 * Return value: Returns non-0 iff key in ticket is of specified
1034 * encryption type.
1037 shishi_tkt_keytype_p (Shishi_tkt * tkt, int32_t etype)
1039 int32_t tktetype;
1040 int rc;
1042 rc = shishi_asn1_read_int32 (tkt->handle, tkt->enckdcreppart,
1043 "key.keytype", &tktetype);
1044 if (rc != SHISHI_OK)
1045 return 0;
1047 return etype == tktetype;
1051 shishi_tkt_lastreq (Shishi_tkt * tkt,
1052 char **lrtime, size_t * lrtimelen, int32_t lrtype)
1054 char *format;
1055 int32_t tmplrtype;
1056 size_t i, n;
1057 int res;
1059 res = shishi_asn1_number_of_elements (tkt->handle, tkt->enckdcreppart,
1060 "last-req", &n);
1061 if (res != SHISHI_OK)
1062 return res;
1064 for (i = 1; i <= n; i++)
1066 asprintf (&format, "last-req.?%d.lr-type", i);
1067 res = shishi_asn1_read_int32 (tkt->handle, tkt->enckdcreppart,
1068 format, &tmplrtype);
1069 free (format);
1070 if (res != SHISHI_OK)
1071 return res;
1073 if (lrtype == tmplrtype)
1075 asprintf (&format, "last-req.?%d.lr-value", i);
1076 res = shishi_asn1_read (tkt->handle, tkt->enckdcreppart,
1077 format, lrtime, lrtimelen);
1078 free (format);
1079 if (res != SHISHI_OK)
1080 return res;
1082 return SHISHI_OK;
1086 return !SHISHI_OK;
1090 * shishi_tkt_lastreqc:
1091 * @tkt: input variable with ticket info.
1092 * @lrtype: lastreq type to extract, see Shishi_lrtype. E.g.,
1093 * SHISHI_LRTYPE_LAST_REQUEST.
1095 * Extract C time corresponding to given lastreq type field in the
1096 * ticket.
1098 * Return value: Returns C time interpretation of the specified
1099 * lastreq field, or (time_t) -1.
1101 time_t
1102 shishi_tkt_lastreqc (Shishi_tkt * tkt, Shishi_lrtype lrtype)
1104 char *lrtime;
1105 size_t lrtimelen;
1106 time_t t = (time_t) - 1;
1107 int res;
1109 res = shishi_tkt_lastreq (tkt, &lrtime, &lrtimelen, lrtype);
1110 if (res != SHISHI_OK)
1111 return t;
1113 if (lrtimelen == SHISHI_GENERALIZEDTIME_LENGTH)
1114 t = shishi_generalize_ctime (tkt->handle, lrtime);
1116 free (lrtime);
1118 return t;
1122 shishi_tkt_authtime (Shishi_tkt * tkt, char **authtime, size_t * authtimelen)
1124 return shishi_asn1_read (tkt->handle, tkt->enckdcreppart, "authtime",
1125 authtime, authtimelen);
1129 * shishi_tkt_authctime:
1130 * @tkt: input variable with ticket info.
1132 * Extract C time corresponding to the authtime field. The field
1133 * holds the time when the original authentication took place that
1134 * later resulted in this ticket.
1136 * Return value: Returns C time interpretation of the endtime in ticket.
1138 time_t
1139 shishi_tkt_authctime (Shishi_tkt * tkt)
1141 char *authtime;
1142 size_t authtimelen;
1143 time_t t = (time_t) - 1;
1144 int res;
1146 res = shishi_tkt_authtime (tkt, &authtime, &authtimelen);
1147 if (res != SHISHI_OK)
1148 return t;
1150 if (authtimelen == SHISHI_GENERALIZEDTIME_LENGTH + 1) /* XXX why +1 ? */
1151 t = shishi_generalize_ctime (tkt->handle, authtime);
1153 free (authtime);
1155 return t;
1159 shishi_tkt_starttime (Shishi_tkt * tkt,
1160 char **starttime, size_t * starttimelen)
1162 return shishi_asn1_read_optional (tkt->handle, tkt->enckdcreppart,
1163 "starttime", starttime, starttimelen);
1167 * shishi_tkt_startctime:
1168 * @tkt: input variable with ticket info.
1170 * Extract C time corresponding to the starttime field. The field
1171 * holds the time where the ticket start to be valid (typically in the
1172 * past).
1174 * Return value: Returns C time interpretation of the endtime in ticket.
1176 time_t
1177 shishi_tkt_startctime (Shishi_tkt * tkt)
1179 char *starttime;
1180 size_t starttimelen;
1181 time_t t = (time_t) - 1;
1182 int res;
1184 res = shishi_tkt_starttime (tkt, &starttime, &starttimelen);
1185 if (res != SHISHI_OK || starttimelen == 0)
1186 return t;
1188 if (starttimelen == SHISHI_GENERALIZEDTIME_LENGTH + 1) /* XXX why +1 ? */
1189 t = shishi_generalize_ctime (tkt->handle, starttime);
1191 free (starttime);
1193 return t;
1197 shishi_tkt_endtime (Shishi_tkt * tkt, char **endtime, size_t * endtimelen)
1199 return shishi_asn1_read (tkt->handle, tkt->enckdcreppart, "endtime",
1200 endtime, endtimelen);
1204 * shishi_tkt_endctime:
1205 * @tkt: input variable with ticket info.
1207 * Extract C time corresponding to the endtime field. The field holds
1208 * the time where the ticket stop being valid.
1210 * Return value: Returns C time interpretation of the endtime in ticket.
1212 time_t
1213 shishi_tkt_endctime (Shishi_tkt * tkt)
1215 char *endtime;
1216 size_t endtimelen;
1217 time_t t = (time_t) - 1;
1218 int res;
1220 res = shishi_tkt_endtime (tkt, &endtime, &endtimelen);
1221 if (res != SHISHI_OK)
1222 return t;
1224 if (endtimelen == SHISHI_GENERALIZEDTIME_LENGTH + 1) /* XXX why +1 ? */
1225 t = shishi_generalize_ctime (tkt->handle, endtime);
1227 free (endtime);
1229 return t;
1233 shishi_tkt_renew_till (Shishi_tkt * tkt,
1234 char **renewtill, size_t * renewtilllen)
1236 return shishi_asn1_read_optional (tkt->handle, tkt->enckdcreppart,
1237 "renew-till", renewtill, renewtilllen);
1241 * shishi_tkt_renew_tillc:
1242 * @tkt: input variable with ticket info.
1244 * Extract C time corresponding to the renew-till field. The field
1245 * holds the time where the ticket stop being valid for renewal.
1247 * Return value: Returns C time interpretation of the renew-till in ticket.
1249 time_t
1250 shishi_tkt_renew_tillc (Shishi_tkt * tkt)
1252 char *renewtill;
1253 size_t renewtilllen;
1254 time_t t = (time_t) - 1;
1255 int res;
1257 res = shishi_tkt_renew_till (tkt, &renewtill, &renewtilllen);
1258 if (res != SHISHI_OK || renewtilllen == 0)
1259 return t;
1261 if (renewtilllen == SHISHI_GENERALIZEDTIME_LENGTH + 1) /* XXX why +1 ? */
1262 t = shishi_generalize_ctime (tkt->handle, renewtill);
1264 free (renewtill);
1266 return t;
1270 * shishi_tkt_valid_at_time_p:
1271 * @tkt: input variable with ticket info.
1272 * @now: time to check for.
1274 * Determine if ticket is valid at a specific point in time.
1276 * Return value: Returns non-0 iff ticket is valid (not expired and
1277 * after starttime) at specified time.
1280 shishi_tkt_valid_at_time_p (Shishi_tkt * tkt, time_t now)
1282 time_t starttime, endtime;
1284 starttime = shishi_tkt_startctime (tkt);
1285 if (starttime == (time_t) - 1)
1286 starttime = shishi_tkt_authctime (tkt);
1287 endtime = shishi_tkt_endctime (tkt);
1289 return starttime <= now && now <= endtime;
1293 * shishi_tkt_valid_now_p:
1294 * @tkt: input variable with ticket info.
1296 * Determine if ticket is valid now.
1298 * Return value: Returns 0 iff ticket is invalid (expired or not yet
1299 * valid).
1302 shishi_tkt_valid_now_p (Shishi_tkt * tkt)
1304 return shishi_tkt_valid_at_time_p (tkt, time (NULL));
1308 * shishi_tkt_expired_p:
1309 * @tkt: input variable with ticket info.
1311 * Determine if ticket has expired (i.e., endtime is in the past).
1313 * Return value: Returns 0 iff ticket has expired.
1316 shishi_tkt_expired_p (Shishi_tkt * tkt)
1318 time_t endtime = shishi_tkt_endctime (tkt);
1319 time_t now = time (NULL);
1321 return endtime < now;
1325 * shishi_tkt_lastreq_pretty_print:
1326 * @tkt: input variable with ticket info.
1327 * @fh: file handle open for writing.
1329 * Print a human readable representation of the various lastreq fields
1330 * in the ticket (really EncKDCRepPart).
1332 void
1333 shishi_tkt_lastreq_pretty_print (Shishi_tkt * tkt, FILE * fh)
1335 time_t t;
1337 t = shishi_tkt_lastreqc (tkt, SHISHI_LRTYPE_LAST_INITIAL_TGT_REQUEST);
1338 if (t != (time_t) - 1)
1339 fprintf (fh, _("Time of last initial request for a TGT:\t%s"),
1340 ctime (&t));
1342 t = shishi_tkt_lastreqc (tkt, SHISHI_LRTYPE_LAST_INITIAL_REQUEST);
1343 if (t != (time_t) - 1)
1344 fprintf (fh, "Time of last initial request:\t%s", ctime (&t));
1346 t = shishi_tkt_lastreqc (tkt, SHISHI_LRTYPE_NEWEST_TGT_ISSUE);
1347 if (t != (time_t) - 1)
1348 fprintf (fh,
1349 "Time of issue for the newest ticket-granting ticket used:\t%s",
1350 ctime (&t));
1352 t = shishi_tkt_lastreqc (tkt, SHISHI_LRTYPE_LAST_RENEWAL);
1353 if (t != (time_t) - 1)
1354 fprintf (fh, "Time of the last renewal:\t%s", ctime (&t));
1356 t = shishi_tkt_lastreqc (tkt, SHISHI_LRTYPE_LAST_REQUEST);
1357 if (t != (time_t) - 1)
1358 fprintf (fh, "Time of last request:\t%s", ctime (&t));
1362 * shishi_tkt_pretty_print:
1363 * @tkt: input variable with ticket info.
1364 * @fh: file handle open for writing.
1366 * Print a human readable representation of a ticket to file handle.
1368 void
1369 shishi_tkt_pretty_print (Shishi_tkt * tkt, FILE * fh)
1371 char *buf;
1372 char *p;
1373 size_t buflen;
1374 int keytype, etype;
1375 uint32_t flags;
1376 int res;
1377 time_t t;
1378 time_t now = time (NULL);
1380 res = shishi_tkt_clientrealm (tkt, &buf, &buflen);
1381 if (res == SHISHI_OK)
1383 fprintf (fh, "%s:\n", buf);
1384 free (buf);
1386 else
1387 fprintf (fh, "<unknown>:\n");
1389 t = shishi_tkt_authctime (tkt);
1390 fprintf (fh, _("Authtime:\t%s"), ctime (&t));
1392 t = shishi_tkt_startctime (tkt);
1393 if (t != (time_t) - 1)
1395 p = ctime (&t);
1396 p[strlen (p) - 1] = '\0';
1397 fprintf (fh, _("Starttime:\t%s"), p);
1398 if (t > now)
1399 fprintf (fh, " NOT YET VALID");
1400 fprintf (fh, "\n");
1403 t = shishi_tkt_endctime (tkt);
1404 if (t != (time_t) - 1)
1406 p = ctime (&t);
1407 p[strlen (p) - 1] = '\0';
1408 fprintf (fh, _("Endtime:\t%s"), p);
1409 if (t < now)
1410 fprintf (fh, " EXPIRED");
1411 fprintf (fh, "\n");
1414 t = shishi_tkt_renew_tillc (tkt);
1415 if (t != (time_t) - 1)
1416 fprintf (fh, _("Renewable till:\t%s"), ctime (&t));
1418 res = shishi_tkt_server (tkt, &buf, NULL);
1419 if (res == SHISHI_OK)
1421 res = shishi_ticket_get_enc_part_etype (tkt->handle, tkt->ticket,
1422 &keytype);
1423 if (res == SHISHI_OK)
1424 fprintf (fh, _("Server:\t\t%s key %s (%d)\n"), buf,
1425 shishi_cipher_name (keytype), keytype);
1426 free (buf);
1429 res = shishi_tkt_keytype (tkt, &keytype);
1430 if (res == SHISHI_OK)
1431 res = shishi_kdcrep_get_enc_part_etype (tkt->handle, tkt->kdcrep, &etype);
1432 if (res == SHISHI_OK)
1433 fprintf (fh, _("Ticket key:\t%s (%d) protected by %s (%d)\n"),
1434 shishi_cipher_name (keytype), keytype,
1435 shishi_cipher_name (etype), etype);
1437 res = shishi_tkt_flags (tkt, &flags);
1438 if (res == SHISHI_OK && flags)
1440 fprintf (fh, _("Ticket flags:\t"));
1441 if (shishi_tkt_forwardable_p (tkt))
1442 fprintf (fh, "FORWARDABLE ");
1443 if (shishi_tkt_forwarded_p (tkt))
1444 fprintf (fh, "FORWARDED ");
1445 if (shishi_tkt_proxiable_p (tkt))
1446 fprintf (fh, "PROXIABLE ");
1447 if (shishi_tkt_proxy_p (tkt))
1448 fprintf (fh, "PROXY ");
1449 if (shishi_tkt_may_postdate_p (tkt))
1450 fprintf (fh, "MAYPOSTDATE ");
1451 if (shishi_tkt_postdated_p (tkt))
1452 fprintf (fh, "POSTDATED ");
1453 if (shishi_tkt_invalid_p (tkt))
1454 fprintf (fh, "INVALID ");
1455 if (shishi_tkt_renewable_p (tkt))
1456 fprintf (fh, "RENEWABLE ");
1457 if (shishi_tkt_initial_p (tkt))
1458 fprintf (fh, "INITIAL ");
1459 if (shishi_tkt_pre_authent_p (tkt))
1460 fprintf (fh, "PREAUTHENT ");
1461 if (shishi_tkt_hw_authent_p (tkt))
1462 fprintf (fh, "HWAUTHENT ");
1463 if (shishi_tkt_transited_policy_checked_p (tkt))
1464 fprintf (fh, "TRANSITEDPOLICYCHECKED ");
1465 if (shishi_tkt_ok_as_delegate_p (tkt))
1466 fprintf (fh, "OKASDELEGATE ");
1467 fprintf (fh, "(%d)\n", flags);
1472 shishi_tkt_decrypt (Shishi_tkt * tkt, Shishi_key * key)
1474 int rc;
1475 Shishi_asn1 encticketpart;
1477 rc = shishi_ticket_decrypt (tkt->handle, tkt->ticket, key, &encticketpart);
1478 if (rc != SHISHI_OK)
1479 return rc;
1481 tkt->encticketpart = encticketpart;
1483 return SHISHI_OK;