2 Unix SMB/CIFS implementation.
3 simple kerberos5 routines for active directory
4 Copyright (C) Andrew Tridgell 2001
5 Copyright (C) Luke Howard 2002-2003
6 Copyright (C) Andrew Bartlett <abartlet@samba.org> 2005
7 Copyright (C) Guenther Deschner 2005-2009
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
24 #include "system/filesys.h"
25 #include "krb5_samba.h"
26 #include "lib/util/asn1.h"
30 #endif /* HAVE_COM_ERR_H */
32 #ifndef KRB5_AUTHDATA_WIN2K_PAC
33 #define KRB5_AUTHDATA_WIN2K_PAC 128
36 #ifndef KRB5_AUTHDATA_IF_RELEVANT
37 #define KRB5_AUTHDATA_IF_RELEVANT 1
42 #define GSSAPI_CHECKSUM 0x8003 /* Checksum type value for Kerberos */
43 #define GSSAPI_BNDLENGTH 16 /* Bind Length (rfc-1964 pg.3) */
44 #define GSSAPI_CHECKSUM_SIZE (4+GSSAPI_BNDLENGTH+4) /* Length of bind length,
45 bind field, flags field. */
46 #define GSS_C_DELEG_FLAG 1
48 /* MIT krb5 1.7beta3 (in Ubuntu Karmic) is missing the prototype,
49 but still has the symbol */
50 #if !HAVE_DECL_KRB5_AUTH_CON_SET_REQ_CKSUMTYPE
51 krb5_error_code krb5_auth_con_set_req_cksumtype(
53 krb5_auth_context auth_context,
54 krb5_cksumtype cksumtype);
57 #if !defined(SMB_MALLOC)
59 #define SMB_MALLOC(s) malloc((s))
63 #define SMB_STRDUP(s) strdup(s)
66 /**********************************************************
68 **********************************************************/
70 #if !defined(HAVE_KRB5_SET_DEFAULT_TGS_KTYPES)
72 #if defined(HAVE_KRB5_SET_DEFAULT_TGS_ENCTYPES)
74 /* With MIT kerberos, we should use krb5_set_default_tgs_enctypes in preference
75 * to krb5_set_default_tgs_ktypes. See
76 * http://lists.samba.org/archive/samba-technical/2006-July/048271.html
78 * If the MIT libraries are not exporting internal symbols, we will end up in
79 * this branch, which is correct. Otherwise we will continue to use the
82 krb5_error_code krb5_set_default_tgs_ktypes(krb5_context ctx, const krb5_enctype *enc)
84 return krb5_set_default_tgs_enctypes(ctx, enc);
87 #elif defined(HAVE_KRB5_SET_DEFAULT_IN_TKT_ETYPES)
90 krb5_error_code krb5_set_default_tgs_ktypes(krb5_context ctx, const krb5_enctype *enc)
92 return krb5_set_default_in_tkt_etypes(ctx, enc);
95 #endif /* HAVE_KRB5_SET_DEFAULT_TGS_ENCTYPES */
97 #endif /* HAVE_KRB5_SET_DEFAULT_TGS_KTYPES */
100 #if defined(HAVE_KRB5_AUTH_CON_SETKEY) && !defined(HAVE_KRB5_AUTH_CON_SETUSERUSERKEY)
101 krb5_error_code krb5_auth_con_setuseruserkey(krb5_context context,
102 krb5_auth_context auth_context,
103 krb5_keyblock *keyblock)
105 return krb5_auth_con_setkey(context, auth_context, keyblock);
109 #if !defined(HAVE_KRB5_FREE_UNPARSED_NAME)
110 void krb5_free_unparsed_name(krb5_context context, char *val)
116 #if defined(HAVE_KRB5_PRINCIPAL_GET_COMP_STRING) && !defined(HAVE_KRB5_PRINC_COMPONENT)
117 const krb5_data *krb5_princ_component(krb5_context context,
118 krb5_principal principal, int i);
120 const krb5_data *krb5_princ_component(krb5_context context,
121 krb5_principal principal, int i)
123 static krb5_data kdata;
125 kdata.data = discard_const_p(char, krb5_principal_get_comp_string(context, principal, i));
126 kdata.length = strlen((const char *)kdata.data);
132 /**********************************************************
134 **********************************************************/
136 #if defined(HAVE_ADDR_TYPE_IN_KRB5_ADDRESS)
140 * @brief Stores the address of a 'struct sockaddr_storage' a krb5_address
142 * @param[in] paddr A pointer to a 'struct sockaddr_storage to extract the
145 * @param[out] pkaddr A Kerberos address to store tha address in.
147 * @return True on success, false if an error occured.
149 bool smb_krb5_sockaddr_to_kaddr(struct sockaddr_storage *paddr,
150 krb5_address *pkaddr)
152 memset(pkaddr, '\0', sizeof(krb5_address));
153 #if defined(HAVE_IPV6) && defined(KRB5_ADDRESS_INET6)
154 if (paddr->ss_family == AF_INET6) {
155 pkaddr->addr_type = KRB5_ADDRESS_INET6;
156 pkaddr->address.length = sizeof(((struct sockaddr_in6 *)paddr)->sin6_addr);
157 pkaddr->address.data = (char *)&(((struct sockaddr_in6 *)paddr)->sin6_addr);
161 if (paddr->ss_family == AF_INET) {
162 pkaddr->addr_type = KRB5_ADDRESS_INET;
163 pkaddr->address.length = sizeof(((struct sockaddr_in *)paddr)->sin_addr);
164 pkaddr->address.data = (char *)&(((struct sockaddr_in *)paddr)->sin_addr);
169 #elif defined(HAVE_ADDRTYPE_IN_KRB5_ADDRESS)
173 * @brief Stores the address of a 'struct sockaddr_storage' a krb5_address
175 * @param[in] paddr A pointer to a 'struct sockaddr_storage to extract the
178 * @param[in] pkaddr A Kerberos address to store tha address in.
180 * @return True on success, false if an error occured.
182 bool smb_krb5_sockaddr_to_kaddr(struct sockaddr_storage *paddr,
183 krb5_address *pkaddr)
185 memset(pkaddr, '\0', sizeof(krb5_address));
186 #if defined(HAVE_IPV6) && defined(ADDRTYPE_INET6)
187 if (paddr->ss_family == AF_INET6) {
188 pkaddr->addrtype = ADDRTYPE_INET6;
189 pkaddr->length = sizeof(((struct sockaddr_in6 *)paddr)->sin6_addr);
190 pkaddr->contents = (krb5_octet *)&(((struct sockaddr_in6 *)paddr)->sin6_addr);
194 if (paddr->ss_family == AF_INET) {
195 pkaddr->addrtype = ADDRTYPE_INET;
196 pkaddr->length = sizeof(((struct sockaddr_in *)paddr)->sin_addr);
197 pkaddr->contents = (krb5_octet *)&(((struct sockaddr_in *)paddr)->sin_addr);
203 #error UNKNOWN_ADDRTYPE
206 krb5_error_code smb_krb5_mk_error(krb5_context context,
207 krb5_error_code error_code,
212 krb5_error_code code = EINVAL;
213 #ifdef SAMBA4_USES_HEIMDAL
214 code = krb5_mk_error(context,
220 NULL, /* client_time */
221 NULL, /* client_usec */
224 krb5_error dec_err = {
228 if (e_text != NULL) {
229 dec_err.text.length = strlen(e_text);
230 dec_err.text.data = discard_const_p(char, e_text);
232 if (e_data != NULL) {
233 dec_err.e_data = *e_data;
236 code = krb5_mk_error(context,
244 * @brief Create a keyblock based on input parameters
246 * @param context The krb5_context
247 * @param host_princ The krb5_principal to use
248 * @param salt The optional salt, if omitted, salt is calculated with
249 * the provided principal.
250 * @param password The krb5_data containing the password
251 * @param enctype The krb5_enctype to use for the keyblock generation
252 * @param key The returned krb5_keyblock, caller needs to free with
253 * krb5_free_keyblock().
255 * @return krb5_error_code
257 int smb_krb5_create_key_from_string(krb5_context context,
258 krb5_const_principal host_princ,
261 krb5_enctype enctype,
266 if (host_princ == NULL && salt == NULL) {
270 #if defined(HAVE_KRB5_PRINCIPAL2SALT) && defined(HAVE_KRB5_C_STRING_TO_KEY)
275 ret = krb5_principal2salt(context, host_princ, &_salt);
277 DEBUG(1,("krb5_principal2salt failed (%s)\n", error_message(ret)));
283 ret = krb5_c_string_to_key(context, enctype, password, &_salt, key);
285 SAFE_FREE(_salt.data);
288 #elif defined(HAVE_KRB5_GET_PW_SALT) && defined(HAVE_KRB5_STRING_TO_KEY_SALT)
293 ret = krb5_get_pw_salt(context, host_princ, &_salt);
295 DEBUG(1,("krb5_get_pw_salt failed (%s)\n", error_message(ret)));
299 _salt.saltvalue = *salt;
300 _salt.salttype = KRB5_PW_SALT;
303 ret = krb5_string_to_key_salt(context, enctype, (const char *)password->data, _salt, key);
305 krb5_free_salt(context, _salt);
309 #error UNKNOWN_CREATE_KEY_FUNCTIONS
315 * @brief Create a salt for a given principal
317 * @param context The initialized krb5_context
318 * @param host_princ The krb5_principal to create the salt for
319 * @param psalt A pointer to a krb5_data struct
321 * caller has to free the contents of psalt with smb_krb5_free_data_contents
322 * when function has succeeded
324 * @return krb5_error_code, returns 0 on success, error code otherwise
327 int smb_krb5_get_pw_salt(krb5_context context,
328 krb5_const_principal host_princ,
330 #if defined(HAVE_KRB5_GET_PW_SALT)
336 ret = krb5_get_pw_salt(context, host_princ, &salt);
341 psalt->data = salt.saltvalue.data;
342 psalt->length = salt.saltvalue.length;
346 #elif defined(HAVE_KRB5_PRINCIPAL2SALT)
349 return krb5_principal2salt(context, host_princ, psalt);
352 #error UNKNOWN_SALT_FUNCTIONS
355 #if defined(HAVE_KRB5_GET_PERMITTED_ENCTYPES)
357 * @brief Get a list of encryption types allowed for session keys
359 * @param[in] context The library context
361 * @param[in] enctypes An allocated, zero-terminated list of encryption types
363 * This function returns an allocated list of encryption types allowed for
366 * Use free() to free the enctypes when it is no longer needed.
368 * @retval 0 Success; otherwise - Kerberos error codes
370 krb5_error_code smb_krb5_get_allowed_etypes(krb5_context context,
371 krb5_enctype **enctypes)
373 return krb5_get_permitted_enctypes(context, enctypes);
375 #elif defined(HAVE_KRB5_GET_DEFAULT_IN_TKT_ETYPES)
376 krb5_error_code smb_krb5_get_allowed_etypes(krb5_context context,
377 krb5_enctype **enctypes)
379 #ifdef HAVE_KRB5_PDU_NONE_DECL
380 return krb5_get_default_in_tkt_etypes(context, KRB5_PDU_NONE, enctypes);
382 return krb5_get_default_in_tkt_etypes(context, enctypes);
386 #error UNKNOWN_GET_ENCTYPES_FUNCTIONS
389 bool unwrap_edata_ntstatus(TALLOC_CTX *mem_ctx,
391 DATA_BLOB *edata_out)
393 DATA_BLOB edata_contents;
397 if (!edata->length) {
401 data = asn1_init(mem_ctx);
406 if (!asn1_load(data, *edata)) goto err;
407 if (!asn1_start_tag(data, ASN1_SEQUENCE(0))) goto err;
408 if (!asn1_start_tag(data, ASN1_CONTEXT(1))) goto err;
409 if (!asn1_read_Integer(data, &edata_type)) goto err;
411 if (edata_type != KRB5_PADATA_PW_SALT) {
412 DEBUG(0,("edata is not of required type %d but of type %d\n",
413 KRB5_PADATA_PW_SALT, edata_type));
417 if (!asn1_start_tag(data, ASN1_CONTEXT(2))) goto err;
418 if (!asn1_read_OctetString(data, talloc_tos(), &edata_contents)) goto err;
419 if (!asn1_end_tag(data)) goto err;
420 if (!asn1_end_tag(data)) goto err;
421 if (!asn1_end_tag(data)) goto err;
424 *edata_out = data_blob_talloc(mem_ctx, edata_contents.data, edata_contents.length);
426 data_blob_free(&edata_contents);
437 /**************************************************************
438 krb5_parse_name that takes a UNIX charset.
439 **************************************************************/
441 krb5_error_code smb_krb5_parse_name(krb5_context context,
442 const char *name, /* in unix charset */
443 krb5_principal *principal)
447 size_t converted_size;
448 TALLOC_CTX *frame = talloc_stackframe();
450 if (!push_utf8_talloc(frame, &utf8_name, name, &converted_size)) {
455 ret = krb5_parse_name(context, utf8_name, principal);
460 /**************************************************************
461 krb5_parse_name that returns a UNIX charset name. Must
462 be freed with talloc_free() call.
463 **************************************************************/
465 krb5_error_code smb_krb5_unparse_name(TALLOC_CTX *mem_ctx,
466 krb5_context context,
467 krb5_const_principal principal,
472 size_t converted_size;
475 ret = krb5_unparse_name(context, principal, &utf8_name);
480 if (!pull_utf8_talloc(mem_ctx, unix_name, utf8_name, &converted_size)) {
481 krb5_free_unparsed_name(context, utf8_name);
484 krb5_free_unparsed_name(context, utf8_name);
488 krb5_error_code smb_krb5_parse_name_norealm(krb5_context context,
490 krb5_principal *principal)
492 /* we are cheating here because parse_name will in fact set the realm.
493 * We don't care as the only caller of smb_krb5_parse_name_norealm
494 * ignores the realm anyway when calling
495 * smb_krb5_principal_compare_any_realm later - Guenther */
497 return smb_krb5_parse_name(context, name, principal);
500 bool smb_krb5_principal_compare_any_realm(krb5_context context,
501 krb5_const_principal princ1,
502 krb5_const_principal princ2)
504 return krb5_principal_compare_any_realm(context, princ1, princ2);
508 * @brief Free the contents of a krb5_data structure and zero the data field.
510 * @param[in] context The krb5 context
512 * @param[in] pdata The data structure to free contents of
514 * This function frees the contents, not the structure itself.
516 void smb_krb5_free_data_contents(krb5_context context, krb5_data *pdata)
518 #if defined(HAVE_KRB5_FREE_DATA_CONTENTS)
520 krb5_free_data_contents(context, pdata);
522 #elif defined(HAVE_KRB5_DATA_FREE)
523 krb5_data_free(context, pdata);
525 SAFE_FREE(pdata->data);
530 * @brief copy a buffer into a krb5_data struct
532 * @param[in] p The krb5_data
533 * @param[in] data The data to copy
534 * @param[in] length The length of the data to copy
535 * @return krb5_error_code
537 * Caller has to free krb5_data with smb_krb5_free_data_contents().
539 krb5_error_code smb_krb5_copy_data_contents(krb5_data *p,
543 #if defined(HAVE_KRB5_DATA_COPY)
544 return krb5_data_copy(p, data, len);
547 p->data = malloc(len);
548 if (p->data == NULL) {
551 memmove(p->data, data, len);
556 p->magic = KV5M_DATA;
561 bool smb_krb5_get_smb_session_key(TALLOC_CTX *mem_ctx,
562 krb5_context context,
563 krb5_auth_context auth_context,
564 DATA_BLOB *session_key,
567 krb5_keyblock *skey = NULL;
568 krb5_error_code err = 0;
572 #ifdef HAVE_KRB5_AUTH_CON_GETRECVSUBKEY
573 err = krb5_auth_con_getrecvsubkey(context,
576 #else /* HAVE_KRB5_AUTH_CON_GETRECVSUBKEY */
577 err = krb5_auth_con_getremotesubkey(context,
578 auth_context, &skey);
579 #endif /* HAVE_KRB5_AUTH_CON_GETRECVSUBKEY */
581 #ifdef HAVE_KRB5_AUTH_CON_GETSENDSUBKEY
582 err = krb5_auth_con_getsendsubkey(context,
585 #else /* HAVE_KRB5_AUTH_CON_GETSENDSUBKEY */
586 err = krb5_auth_con_getlocalsubkey(context,
587 auth_context, &skey);
588 #endif /* HAVE_KRB5_AUTH_CON_GETSENDSUBKEY */
591 if (err || skey == NULL) {
592 DEBUG(10, ("KRB5 error getting session key %d\n", err));
596 DEBUG(10, ("Got KRB5 session key of length %d\n",
597 (int)KRB5_KEY_LENGTH(skey)));
599 *session_key = data_blob_talloc(mem_ctx,
601 KRB5_KEY_LENGTH(skey));
602 dump_data_pw("KRB5 Session Key:\n",
604 session_key->length);
610 krb5_free_keyblock(context, skey);
618 * @brief Get talloced string component of a principal
620 * @param[in] mem_ctx The TALLOC_CTX
621 * @param[in] context The krb5_context
622 * @param[in] principal The principal
623 * @param[in] component The component
624 * @return string component
626 * Caller must talloc_free if the return value is not NULL.
629 char *smb_krb5_principal_get_comp_string(TALLOC_CTX *mem_ctx,
630 krb5_context context,
631 krb5_const_principal principal,
632 unsigned int component)
634 #if defined(HAVE_KRB5_PRINCIPAL_GET_COMP_STRING)
635 return talloc_strdup(mem_ctx, krb5_principal_get_comp_string(context, principal, component));
639 if (component >= krb5_princ_size(context, principal)) {
643 data = krb5_princ_component(context, principal, component);
648 return talloc_strndup(mem_ctx, data->data, data->length);
655 * @param[in] ccache_string A string pointing to the cache to renew the ticket
656 * (e.g. FILE:/tmp/krb5cc_0) or NULL. If the principal
657 * ccache has not been specified, the default ccache
660 * @param[in] client_string The client principal string (e.g. user@SAMBA.SITE)
661 * or NULL. If the principal string has not been
662 * specified, the principal from the ccache will be
665 * @param[in] service_string The service ticket string
666 * (e.g. krbtgt/SAMBA.SITE@SAMBA.SITE) or NULL. If
667 * the sevice ticket is specified, it is parsed (
668 * with the realm part ignored) and used as the
669 * server principal of the credential. Otherwise
670 * the ticket-granting service is used.
672 * @param[in] expire_time A pointer to store the credentials end time or
675 * @return 0 on Succes, a Kerberos error code otherwise.
677 krb5_error_code smb_krb5_renew_ticket(const char *ccache_string,
678 const char *client_string,
679 const char *service_string,
683 krb5_context context = NULL;
684 krb5_ccache ccache = NULL;
685 krb5_principal client = NULL;
686 krb5_creds creds, creds_in;
689 ZERO_STRUCT(creds_in);
691 initialize_krb5_error_table();
692 ret = krb5_init_context(&context);
697 if (!ccache_string) {
698 ccache_string = krb5_cc_default_name(context);
701 if (!ccache_string) {
706 DEBUG(10,("smb_krb5_renew_ticket: using %s as ccache\n", ccache_string));
708 /* FIXME: we should not fall back to defaults */
709 ret = krb5_cc_resolve(context, discard_const_p(char, ccache_string), &ccache);
715 ret = smb_krb5_parse_name(context, client_string, &client);
720 ret = krb5_cc_get_principal(context, ccache, &client);
726 ret = krb5_get_renewed_creds(context, &creds, client, ccache, discard_const_p(char, service_string));
728 DEBUG(10,("smb_krb5_renew_ticket: krb5_get_kdc_cred failed: %s\n", error_message(ret)));
732 /* hm, doesn't that create a new one if the old one wasn't there? - Guenther */
733 ret = krb5_cc_initialize(context, ccache, client);
738 ret = krb5_cc_store_cred(context, ccache, &creds);
741 *expire_time = (time_t) creds.times.endtime;
745 krb5_free_cred_contents(context, &creds_in);
746 krb5_free_cred_contents(context, &creds);
749 krb5_free_principal(context, client);
752 krb5_cc_close(context, ccache);
755 krb5_free_context(context);
762 * @brief Free the data stored in an smb_krb5_addresses structure.
764 * @param[in] context The library context
766 * @param[in] addr The address structure to free.
768 * @return 0 on success, a Kerberos error code otherwise.
770 krb5_error_code smb_krb5_free_addresses(krb5_context context,
771 smb_krb5_addresses *addr)
773 krb5_error_code ret = 0;
777 #if defined(HAVE_MAGIC_IN_KRB5_ADDRESS) && defined(HAVE_ADDRTYPE_IN_KRB5_ADDRESS) /* MIT */
778 krb5_free_addresses(context, addr->addrs);
779 #elif defined(HAVE_ADDR_TYPE_IN_KRB5_ADDRESS) /* Heimdal */
780 ret = krb5_free_addresses(context, addr->addrs);
781 SAFE_FREE(addr->addrs);
788 #define MAX_NETBIOSNAME_LEN 16
791 * @brief Add a netbios name to the array of addresses
793 * @param[in] kerb_addr A pointer to the smb_krb5_addresses to add the
796 * @param[in] netbios_name The netbios name to add.
798 * @return 0 on success, a Kerberos error code otherwise.
800 krb5_error_code smb_krb5_gen_netbios_krb5_address(smb_krb5_addresses **kerb_addr,
801 const char *netbios_name)
803 krb5_error_code ret = 0;
804 char buf[MAX_NETBIOSNAME_LEN];
806 #if defined(HAVE_MAGIC_IN_KRB5_ADDRESS) && defined(HAVE_ADDRTYPE_IN_KRB5_ADDRESS) /* MIT */
807 krb5_address **addrs = NULL;
808 #elif defined(HAVE_ADDR_TYPE_IN_KRB5_ADDRESS) /* Heimdal */
809 krb5_addresses *addrs = NULL;
812 *kerb_addr = (smb_krb5_addresses *)SMB_MALLOC(sizeof(smb_krb5_addresses));
813 if (*kerb_addr == NULL) {
817 /* temporarily duplicate put_name() code here to avoid dependency
818 * issues for a 5 lines function */
819 len = strlen(netbios_name);
820 memcpy(buf, netbios_name,
821 (len < MAX_NETBIOSNAME_LEN) ? len : MAX_NETBIOSNAME_LEN - 1);
822 if (len < MAX_NETBIOSNAME_LEN - 1) {
823 memset(buf + len, ' ', MAX_NETBIOSNAME_LEN - 1 - len);
825 buf[MAX_NETBIOSNAME_LEN - 1] = 0x20;
827 #if defined(HAVE_MAGIC_IN_KRB5_ADDRESS) && defined(HAVE_ADDRTYPE_IN_KRB5_ADDRESS) /* MIT */
831 addrs = (krb5_address **)SMB_MALLOC(sizeof(krb5_address *) * num_addr);
833 SAFE_FREE(*kerb_addr);
837 memset(addrs, 0, sizeof(krb5_address *) * num_addr);
839 addrs[0] = (krb5_address *)SMB_MALLOC(sizeof(krb5_address));
840 if (addrs[0] == NULL) {
842 SAFE_FREE(*kerb_addr);
846 addrs[0]->magic = KV5M_ADDRESS;
847 addrs[0]->addrtype = KRB5_ADDR_NETBIOS;
848 addrs[0]->length = MAX_NETBIOSNAME_LEN;
849 addrs[0]->contents = (unsigned char *)SMB_MALLOC(addrs[0]->length);
850 if (addrs[0]->contents == NULL) {
853 SAFE_FREE(*kerb_addr);
857 memcpy(addrs[0]->contents, buf, addrs[0]->length);
861 #elif defined(HAVE_ADDR_TYPE_IN_KRB5_ADDRESS) /* Heimdal */
863 addrs = (krb5_addresses *)SMB_MALLOC(sizeof(krb5_addresses));
865 SAFE_FREE(*kerb_addr);
869 memset(addrs, 0, sizeof(krb5_addresses));
872 addrs->val = (krb5_address *)SMB_MALLOC(sizeof(krb5_address));
873 if (addrs->val == NULL) {
875 SAFE_FREE(kerb_addr);
879 addrs->val[0].addr_type = KRB5_ADDR_NETBIOS;
880 addrs->val[0].address.length = MAX_NETBIOSNAME_LEN;
881 addrs->val[0].address.data = (unsigned char *)SMB_MALLOC(addrs->val[0].address.length);
882 if (addrs->val[0].address.data == NULL) {
883 SAFE_FREE(addrs->val);
885 SAFE_FREE(*kerb_addr);
889 memcpy(addrs->val[0].address.data, buf, addrs->val[0].address.length);
892 #error UNKNOWN_KRB5_ADDRESS_FORMAT
894 (*kerb_addr)->addrs = addrs;
900 * @brief Get the enctype from a key table entry
902 * @param[in] kt_entry Key table entry to get the enctype from.
904 * @return The enctype from the entry.
906 krb5_enctype smb_krb5_kt_get_enctype_from_entry(krb5_keytab_entry *kt_entry)
908 return KRB5_KEY_TYPE(KRB5_KT_KEY(kt_entry));
912 * @brief Free the contents of a key table entry.
914 * @param[in] context The library context.
916 * @param[in] kt_entry The key table entry to free the contents of.
918 * @return 0 on success, a Kerberos error code otherwise.
920 * The pointer itself is not freed.
922 krb5_error_code smb_krb5_kt_free_entry(krb5_context context,
923 krb5_keytab_entry *kt_entry)
925 /* Try krb5_free_keytab_entry_contents first, since
926 * MIT Kerberos >= 1.7 has both krb5_free_keytab_entry_contents and
927 * krb5_kt_free_entry but only has a prototype for the first, while the
928 * second is considered private.
930 #if defined(HAVE_KRB5_FREE_KEYTAB_ENTRY_CONTENTS)
931 return krb5_free_keytab_entry_contents(context, kt_entry);
932 #elif defined(HAVE_KRB5_KT_FREE_ENTRY)
933 return krb5_kt_free_entry(context, kt_entry);
935 #error UNKNOWN_KT_FREE_FUNCTION
941 * @brief Convert an encryption type to a string.
943 * @param[in] context The library context.
945 * @param[in] enctype The encryption type.
947 * @param[in] etype_s A pointer to store the allocated encryption type as a
950 * @return 0 on success, a Kerberos error code otherwise.
952 * The caller needs to free the allocated string etype_s.
954 krb5_error_code smb_krb5_enctype_to_string(krb5_context context,
955 krb5_enctype enctype,
958 #ifdef HAVE_KRB5_ENCTYPE_TO_STRING_WITH_KRB5_CONTEXT_ARG
959 return krb5_enctype_to_string(context, enctype, etype_s); /* Heimdal */
960 #elif defined(HAVE_KRB5_ENCTYPE_TO_STRING_WITH_SIZE_T_ARG)
962 krb5_error_code ret = krb5_enctype_to_string(enctype, buf, 256); /* MIT */
966 *etype_s = SMB_STRDUP(buf);
972 #error UNKNOWN_KRB5_ENCTYPE_TO_STRING_FUNCTION
976 /* This MAX_NAME_LEN is a constant defined in krb5.h */
977 #ifndef MAX_KEYTAB_NAME_LEN
978 #define MAX_KEYTAB_NAME_LEN 1100
982 * @brief Open a key table readonly or with readwrite access.
984 * Allows to use a different keytab than the default one using a relative
985 * path to the keytab.
987 * @param[in] context The library context
989 * @param[in] keytab_name_req The path to the key table.
991 * @param[in] write_access Open with readwrite access.
993 * @param[in] keytab A pointer o the opended key table.
995 * The keytab pointer should be freed using krb5_kt_close().
997 * @return 0 on success, a Kerberos error code otherwise.
999 krb5_error_code smb_krb5_kt_open_relative(krb5_context context,
1000 const char *keytab_name_req,
1002 krb5_keytab *keytab)
1004 krb5_error_code ret = 0;
1005 TALLOC_CTX *mem_ctx;
1006 char keytab_string[MAX_KEYTAB_NAME_LEN];
1007 char *kt_str = NULL;
1008 bool found_valid_name = false;
1009 const char *pragma = "FILE";
1010 const char *tmp = NULL;
1012 if (!write_access && !keytab_name_req) {
1013 /* caller just wants to read the default keytab readonly, so be it */
1014 return krb5_kt_default(context, keytab);
1017 mem_ctx = talloc_init("smb_krb5_open_keytab");
1022 #ifdef HAVE_WRFILE_KEYTAB
1028 if (keytab_name_req) {
1030 if (strlen(keytab_name_req) > MAX_KEYTAB_NAME_LEN) {
1031 ret = KRB5_CONFIG_NOTENUFSPACE;
1035 if ((strncmp(keytab_name_req, "WRFILE:/", 8) == 0) ||
1036 (strncmp(keytab_name_req, "FILE:/", 6) == 0)) {
1037 tmp = keytab_name_req;
1041 tmp = talloc_asprintf(mem_ctx, "%s:%s", pragma, keytab_name_req);
1050 /* we need to handle more complex keytab_strings, like:
1051 * "ANY:FILE:/etc/krb5.keytab,krb4:/etc/srvtab" */
1053 ret = krb5_kt_default_name(context, &keytab_string[0], MAX_KEYTAB_NAME_LEN - 2);
1058 DEBUG(10,("smb_krb5_open_keytab: krb5_kt_default_name returned %s\n", keytab_string));
1060 tmp = talloc_strdup(mem_ctx, keytab_string);
1066 if (strncmp(tmp, "ANY:", 4) == 0) {
1070 memset(&keytab_string, '\0', sizeof(keytab_string));
1072 while (next_token_talloc(mem_ctx, &tmp, &kt_str, ",")) {
1073 if (strncmp(kt_str, "WRFILE:", 7) == 0) {
1074 found_valid_name = true;
1079 if (strncmp(kt_str, "FILE:", 5) == 0) {
1080 found_valid_name = true;
1085 if (tmp[0] == '/') {
1086 /* Treat as a FILE: keytab definition. */
1087 found_valid_name = true;
1090 if (found_valid_name) {
1091 if (tmp[0] != '/') {
1092 ret = KRB5_KT_BADNAME;
1096 tmp = talloc_asprintf(mem_ctx, "%s:%s", pragma, tmp);
1105 if (!found_valid_name) {
1106 ret = KRB5_KT_UNKNOWN_TYPE;
1111 DEBUG(10,("smb_krb5_open_keytab: resolving: %s\n", tmp));
1112 ret = krb5_kt_resolve(context, tmp, keytab);
1115 TALLOC_FREE(mem_ctx);
1120 * @brief Open a key table readonly or with readwrite access.
1122 * Allows to use a different keytab than the default one. The path needs to be
1123 * an absolute path or an error will be returned.
1125 * @param[in] context The library context
1127 * @param[in] keytab_name_req The path to the key table.
1129 * @param[in] write_access Open with readwrite access.
1131 * @param[in] keytab A pointer o the opended key table.
1133 * The keytab pointer should be freed using krb5_kt_close().
1135 * @return 0 on success, a Kerberos error code otherwise.
1137 krb5_error_code smb_krb5_kt_open(krb5_context context,
1138 const char *keytab_name_req,
1140 krb5_keytab *keytab)
1142 if (keytab_name_req != NULL) {
1143 if (keytab_name_req[0] != '/') {
1144 return KRB5_KT_BADNAME;
1148 return smb_krb5_kt_open_relative(context,
1155 * @brief Get a key table name.
1157 * @param[in] mem_ctx The talloc context to use for allocation.
1159 * @param[in] context The library context.
1161 * @param[in] keytab The key table to get the name from.
1163 * @param[in] keytab_name A talloc'ed string of the key table name.
1165 * The talloc'ed name string needs to be freed with talloc_free().
1167 * @return 0 on success, a Kerberos error code otherwise.
1169 krb5_error_code smb_krb5_kt_get_name(TALLOC_CTX *mem_ctx,
1170 krb5_context context,
1172 const char **keytab_name)
1174 char keytab_string[MAX_KEYTAB_NAME_LEN];
1175 krb5_error_code ret = 0;
1177 ret = krb5_kt_get_name(context, keytab,
1178 keytab_string, MAX_KEYTAB_NAME_LEN - 2);
1183 *keytab_name = talloc_strdup(mem_ctx, keytab_string);
1184 if (!*keytab_name) {
1192 * @brief Seek and delete old entries in a keytab based on the passed
1195 * @param[in] context The KRB5 context to use.
1197 * @param[in] keytab The keytab to operate on.
1199 * @param[in] kvno The kvnco to use.
1201 * @param[in] princ_s The principal as a string to search for.
1203 * @param[in] princ The principal as a krb5_principal to search for.
1205 * @param[in] flush Weather to flush the complete keytab.
1207 * @param[in] keep_old_entries Keep the entry with the previous kvno.
1209 * @retval 0 on Sucess
1211 * @return An appropriate KRB5 error code.
1213 krb5_error_code smb_krb5_kt_seek_and_delete_old_entries(krb5_context context,
1216 krb5_enctype enctype,
1217 const char *princ_s,
1218 krb5_principal princ,
1220 bool keep_old_entries)
1222 krb5_error_code ret;
1223 krb5_kt_cursor cursor;
1224 krb5_kt_cursor zero_csr;
1225 krb5_keytab_entry kt_entry;
1226 krb5_keytab_entry zero_kt_entry;
1227 char *ktprinc = NULL;
1228 krb5_kvno old_kvno = kvno - 1;
1229 TALLOC_CTX *tmp_ctx;
1231 ZERO_STRUCT(cursor);
1232 ZERO_STRUCT(zero_csr);
1233 ZERO_STRUCT(kt_entry);
1234 ZERO_STRUCT(zero_kt_entry);
1236 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
1237 if (ret == KRB5_KT_END || ret == ENOENT ) {
1242 tmp_ctx = talloc_new(NULL);
1243 if (tmp_ctx == NULL) {
1247 DEBUG(3, (__location__ ": Will try to delete old keytab entries\n"));
1248 while (!krb5_kt_next_entry(context, keytab, &kt_entry, &cursor)) {
1249 bool name_ok = false;
1250 krb5_enctype kt_entry_enctype =
1251 smb_krb5_kt_get_enctype_from_entry(&kt_entry);
1253 if (!flush && (princ_s != NULL)) {
1254 ret = smb_krb5_unparse_name(tmp_ctx, context,
1258 DEBUG(1, (__location__
1259 ": smb_krb5_unparse_name failed "
1260 "(%s)\n", error_message(ret)));
1264 #ifdef HAVE_KRB5_KT_COMPARE
1265 name_ok = krb5_kt_compare(context, &kt_entry,
1268 name_ok = (strcmp(ktprinc, princ_s) == 0);
1272 DEBUG(10, (__location__ ": ignoring keytab "
1273 "entry principal %s, kvno = %d\n",
1274 ktprinc, kt_entry.vno));
1277 * just free this entry and continue. */
1278 ret = smb_krb5_kt_free_entry(context,
1280 ZERO_STRUCT(kt_entry);
1282 DEBUG(1, (__location__
1283 ": smb_krb5_kt_free_entry "
1285 error_message(ret)));
1289 TALLOC_FREE(ktprinc);
1293 TALLOC_FREE(ktprinc);
1296 /*------------------------------------------------------------
1297 * Save the entries with kvno - 1. This is what microsoft does
1298 * to allow people with existing sessions that have kvno - 1
1299 * to still work. Otherwise, when the password for the machine
1300 * changes, all kerberizied sessions will 'break' until either
1301 * the client reboots or the client's session key expires and
1302 * they get a new session ticket with the new kvno.
1303 * Some keytab files only store the kvno in 8bits, limit
1304 * the compare accordingly.
1307 if (!flush && ((kt_entry.vno & 0xff) == (old_kvno & 0xff))) {
1308 DEBUG(5, (__location__ ": Saving previous (kvno %d) "
1309 "entry for principal: %s.\n",
1310 old_kvno, princ_s));
1314 if (keep_old_entries) {
1315 DEBUG(5, (__location__ ": Saving old (kvno %d) "
1316 "entry for principal: %s.\n",
1322 (kt_entry.vno == kvno) &&
1323 (kt_entry_enctype != enctype))
1325 DEBUG(5, (__location__ ": Saving entry with kvno [%d] "
1326 "enctype [%d] for principal: %s.\n",
1327 kvno, kt_entry_enctype, princ_s));
1331 DEBUG(5, (__location__ ": Found old entry for principal: %s "
1332 "(kvno %d) - trying to remove it.\n",
1333 princ_s, kt_entry.vno));
1335 ret = krb5_kt_end_seq_get(context, keytab, &cursor);
1336 ZERO_STRUCT(cursor);
1338 DEBUG(1, (__location__ ": krb5_kt_end_seq_get() "
1339 "failed (%s)\n", error_message(ret)));
1342 ret = krb5_kt_remove_entry(context, keytab, &kt_entry);
1344 DEBUG(1, (__location__ ": krb5_kt_remove_entry() "
1345 "failed (%s)\n", error_message(ret)));
1349 DEBUG(5, (__location__ ": removed old entry for principal: "
1350 "%s (kvno %d).\n", princ_s, kt_entry.vno));
1352 ret = krb5_kt_start_seq_get(context, keytab, &cursor);
1354 DEBUG(1, (__location__ ": krb5_kt_start_seq() failed "
1355 "(%s)\n", error_message(ret)));
1358 ret = smb_krb5_kt_free_entry(context, &kt_entry);
1359 ZERO_STRUCT(kt_entry);
1361 DEBUG(1, (__location__ ": krb5_kt_remove_entry() "
1362 "failed (%s)\n", error_message(ret)));
1368 talloc_free(tmp_ctx);
1369 if (memcmp(&zero_kt_entry, &kt_entry, sizeof(krb5_keytab_entry))) {
1370 smb_krb5_kt_free_entry(context, &kt_entry);
1372 if (memcmp(&cursor, &zero_csr, sizeof(krb5_kt_cursor)) != 0) {
1373 krb5_kt_end_seq_get(context, keytab, &cursor);
1379 * @brief Add a keytab entry for the given principal
1381 * @param[in] context The krb5 context to use.
1383 * @param[in] keytab The keytab to add the entry to.
1385 * @param[in] kvno The kvno to use.
1387 * @param[in] princ_s The principal as a string.
1389 * @param[in] salt_principal The salt principal to salt the password with.
1390 * Only needed for keys which support salting.
1391 * If no salt is used set no_salt to false and
1394 * @param[in] enctype The encryption type of the keytab entry.
1396 * @param[in] password The password of the keytab entry.
1398 * @param[in] no_salt If the password should not be salted. Normally
1399 * this is only set to false for encryption types
1400 * which do not support salting like RC4.
1402 * @param[in] keep_old_entries Wether to keep or delte old keytab entries.
1404 * @retval 0 on Success
1406 * @return A corresponding KRB5 error code.
1408 * @see smb_krb5_kt_open()
1410 krb5_error_code smb_krb5_kt_add_entry(krb5_context context,
1413 const char *princ_s,
1414 const char *salt_principal,
1415 krb5_enctype enctype,
1416 krb5_data *password,
1418 bool keep_old_entries)
1420 krb5_error_code ret;
1421 krb5_keytab_entry kt_entry;
1422 krb5_principal princ = NULL;
1423 krb5_keyblock *keyp;
1425 ZERO_STRUCT(kt_entry);
1427 ret = smb_krb5_parse_name(context, princ_s, &princ);
1429 DEBUG(1, (__location__ ": smb_krb5_parse_name(%s) "
1430 "failed (%s)\n", princ_s, error_message(ret)));
1434 /* Seek and delete old keytab entries */
1435 ret = smb_krb5_kt_seek_and_delete_old_entries(context,
1447 /* If we get here, we have deleted all the old entries with kvno's
1448 * not equal to the current kvno-1. */
1450 keyp = KRB5_KT_KEY(&kt_entry);
1453 KRB5_KEY_DATA(keyp) = (KRB5_KEY_DATA_CAST *)SMB_MALLOC(password->length);
1454 if (KRB5_KEY_DATA(keyp) == NULL) {
1458 memcpy(KRB5_KEY_DATA(keyp), password->data, password->length);
1459 KRB5_KEY_LENGTH(keyp) = password->length;
1460 KRB5_KEY_TYPE(keyp) = enctype;
1462 krb5_principal salt_princ = NULL;
1464 /* Now add keytab entries for all encryption types */
1465 ret = smb_krb5_parse_name(context, salt_principal, &salt_princ);
1467 DBG_WARNING("krb5_parse_name(%s) failed (%s)\n",
1468 salt_principal, error_message(ret));
1472 ret = smb_krb5_create_key_from_string(context,
1478 krb5_free_principal(context, salt_princ);
1484 kt_entry.principal = princ;
1485 kt_entry.vno = kvno;
1487 DEBUG(3, (__location__ ": adding keytab entry for (%s) with "
1488 "encryption type (%d) and version (%d)\n",
1489 princ_s, enctype, kt_entry.vno));
1490 ret = krb5_kt_add_entry(context, keytab, &kt_entry);
1491 krb5_free_keyblock_contents(context, keyp);
1492 ZERO_STRUCT(kt_entry);
1494 DEBUG(1, (__location__ ": adding entry to keytab "
1495 "failed (%s)\n", error_message(ret)));
1501 krb5_free_principal(context, princ);
1507 #if defined(HAVE_KRB5_GET_CREDS_OPT_SET_IMPERSONATE) && \
1508 defined(HAVE_KRB5_GET_CREDS_OPT_ALLOC) && \
1509 defined(HAVE_KRB5_GET_CREDS)
1510 static krb5_error_code smb_krb5_get_credentials_for_user_opt(krb5_context context,
1513 krb5_principal server,
1514 krb5_principal impersonate_princ,
1515 krb5_creds **out_creds)
1517 krb5_error_code ret;
1518 krb5_get_creds_opt opt;
1520 ret = krb5_get_creds_opt_alloc(context, &opt);
1524 krb5_get_creds_opt_add_options(context, opt, KRB5_GC_FORWARDABLE);
1526 if (impersonate_princ) {
1527 ret = krb5_get_creds_opt_set_impersonate(context, opt,
1534 ret = krb5_get_creds(context, opt, ccache, server, out_creds);
1541 krb5_get_creds_opt_free(context, opt);
1545 #endif /* HAVE_KRB5_GET_CREDS_OPT_SET_IMPERSONATE */
1547 #ifdef HAVE_KRB5_GET_CREDENTIALS_FOR_USER
1549 #if !HAVE_DECL_KRB5_GET_CREDENTIALS_FOR_USER
1550 krb5_error_code KRB5_CALLCONV
1551 krb5_get_credentials_for_user(krb5_context context, krb5_flags options,
1552 krb5_ccache ccache, krb5_creds *in_creds,
1553 krb5_data *subject_cert,
1554 krb5_creds **out_creds);
1555 #endif /* !HAVE_DECL_KRB5_GET_CREDENTIALS_FOR_USER */
1557 static krb5_error_code smb_krb5_get_credentials_for_user(krb5_context context,
1560 krb5_principal server,
1561 krb5_principal impersonate_princ,
1562 krb5_creds **out_creds)
1564 krb5_error_code ret;
1565 krb5_creds in_creds;
1567 ZERO_STRUCT(in_creds);
1569 if (impersonate_princ) {
1571 in_creds.server = me;
1572 in_creds.client = impersonate_princ;
1574 ret = krb5_get_credentials_for_user(context,
1575 0, /* krb5_flags options */
1578 NULL, /* krb5_data *subject_cert */
1581 in_creds.client = me;
1582 in_creds.server = server;
1584 ret = krb5_get_credentials(context, 0, ccache,
1585 &in_creds, out_creds);
1590 #endif /* HAVE_KRB5_GET_CREDENTIALS_FOR_USER */
1593 * smb_krb5_get_credentials
1595 * @brief Get krb5 credentials for a server
1597 * @param[in] context An initialized krb5_context
1598 * @param[in] ccache An initialized krb5_ccache
1599 * @param[in] me The krb5_principal of the caller
1600 * @param[in] server The krb5_principal of the requested service
1601 * @param[in] impersonate_princ The krb5_principal of a user to impersonate as (optional)
1602 * @param[out] out_creds The returned krb5_creds structure
1603 * @return krb5_error_code
1606 krb5_error_code smb_krb5_get_credentials(krb5_context context,
1609 krb5_principal server,
1610 krb5_principal impersonate_princ,
1611 krb5_creds **out_creds)
1613 krb5_error_code ret;
1614 krb5_creds *creds = NULL;
1616 if (out_creds != NULL) {
1620 if (impersonate_princ) {
1621 #ifdef HAVE_KRB5_GET_CREDS_OPT_SET_IMPERSONATE /* Heimdal */
1622 ret = smb_krb5_get_credentials_for_user_opt(context, ccache, me, server, impersonate_princ, &creds);
1623 #elif defined(HAVE_KRB5_GET_CREDENTIALS_FOR_USER) /* MIT */
1624 ret = smb_krb5_get_credentials_for_user(context, ccache, me, server, impersonate_princ, &creds);
1629 krb5_creds in_creds;
1631 ZERO_STRUCT(in_creds);
1633 in_creds.client = me;
1634 in_creds.server = server;
1636 ret = krb5_get_credentials(context, 0, ccache,
1649 krb5_free_creds(context, creds);
1656 * @brief Initialize a krb5_keyblock with the given data.
1658 * Initialized a new keyblock, allocates the contents fo the key and
1659 * copies the data into the keyblock.
1661 * @param[in] context The library context
1663 * @param[in] enctype The encryption type.
1665 * @param[in] data The date to initialize the keyblock with.
1667 * @param[in] length The length of the keyblock.
1669 * @param[in] key Newly allocated keyblock structure.
1671 * The key date must be freed using krb5_free_keyblock_contents() when it is
1674 * @return 0 on success, a Kerberos error code otherwise.
1676 krb5_error_code smb_krb5_keyblock_init_contents(krb5_context context,
1677 krb5_enctype enctype,
1682 #if defined(HAVE_KRB5_KEYBLOCK_INIT)
1683 return krb5_keyblock_init(context, enctype, data, length, key);
1684 #elif defined(HAVE_KRB5_INIT_KEYBLOCK)
1685 krb5_error_code code;
1687 code = krb5_init_keyblock(context,
1696 memcpy(KRB5_KEY_DATA(key), data, length);
1701 memset(key, 0, sizeof(krb5_keyblock));
1702 KRB5_KEY_DATA(key) = SMB_MALLOC(length);
1703 if (NULL == KRB5_KEY_DATA(key)) {
1706 memcpy(KRB5_KEY_DATA(key), data, length);
1707 KRB5_KEY_LENGTH(key) = length;
1708 KRB5_KEY_TYPE(key) = enctype;
1714 * @brief Simulate a kinit by putting the tgt in the given credential cache.
1716 * This function uses a keyblock rather than needingthe original password.
1718 * @param[in] ctx The library context
1720 * @param[in] cc The credential cache to put the tgt in.
1722 * @param[in] principal The client princial
1724 * @param[in] keyblock The keyblock to use.
1726 * @param[in] target_service The service name of the initial credentials (or NULL).
1728 * @param[in] krb_options Initial credential options.
1730 * @param[in] expire_time A pointer to store the experation time of the
1731 * credentials (or NULL).
1733 * @param[in] kdc_time A pointer to store the time when the ticket becomes
1736 * @return 0 on success, a Kerberos error code otherwise.
1738 krb5_error_code smb_krb5_kinit_keyblock_ccache(krb5_context ctx,
1740 krb5_principal principal,
1741 krb5_keyblock *keyblock,
1742 const char *target_service,
1743 krb5_get_init_creds_opt *krb_options,
1744 time_t *expire_time,
1747 krb5_error_code code = 0;
1748 krb5_creds my_creds;
1750 #if defined(HAVE_KRB5_GET_INIT_CREDS_KEYBLOCK)
1751 code = krb5_get_init_creds_keyblock(ctx, &my_creds, principal,
1752 keyblock, 0, target_service,
1754 #elif defined(HAVE_KRB5_GET_INIT_CREDS_KEYTAB)
1756 #define SMB_CREDS_KEYTAB "MEMORY:tmp_smb_creds_XXXXXX"
1757 char tmp_name[sizeof(SMB_CREDS_KEYTAB)];
1758 krb5_keytab_entry entry;
1762 memset(&entry, 0, sizeof(entry));
1763 entry.principal = principal;
1764 *(KRB5_KT_KEY(&entry)) = *keyblock;
1766 memcpy(tmp_name, SMB_CREDS_KEYTAB, sizeof(SMB_CREDS_KEYTAB));
1767 mask = umask(S_IRWXO | S_IRWXG);
1770 if (tmp_name[0] == 0) {
1771 return KRB5_KT_BADNAME;
1773 code = krb5_kt_resolve(ctx, tmp_name, &keytab);
1778 code = krb5_kt_add_entry(ctx, keytab, &entry);
1780 (void)krb5_kt_close(ctx, keytab);
1784 code = krb5_get_init_creds_keytab(ctx, &my_creds, principal,
1785 keytab, 0, target_service,
1787 (void)krb5_kt_close(ctx, keytab);
1790 #error krb5_get_init_creds_keyblock not available!
1796 #ifndef SAMBA4_USES_HEIMDAL /* MIT */
1798 * We need to store the principal as returned from the KDC to the
1799 * credentials cache. If we don't do that the KRB5 library is not
1800 * able to find the tickets it is looking for
1802 principal = my_creds.client;
1804 code = krb5_cc_initialize(ctx, cc, principal);
1809 code = krb5_cc_store_cred(ctx, cc, &my_creds);
1815 *expire_time = (time_t) my_creds.times.endtime;
1819 *kdc_time = (time_t) my_creds.times.starttime;
1824 krb5_free_cred_contents(ctx, &my_creds);
1829 * @brief Simulate a kinit by putting the tgt in the given credential cache.
1831 * @param[in] ctx The library context
1833 * @param[in] cc The credential cache to put the tgt in.
1835 * @param[in] principal The client princial
1837 * @param[in] password The password (or NULL).
1839 * @param[in] target_service The service name of the initial credentials (or NULL).
1841 * @param[in] krb_options Initial credential options.
1843 * @param[in] expire_time A pointer to store the experation time of the
1844 * credentials (or NULL).
1846 * @param[in] kdc_time A pointer to store the time when the ticket becomes
1849 * @return 0 on success, a Kerberos error code otherwise.
1851 krb5_error_code smb_krb5_kinit_password_ccache(krb5_context ctx,
1853 krb5_principal principal,
1854 const char *password,
1855 const char *target_service,
1856 krb5_get_init_creds_opt *krb_options,
1857 time_t *expire_time,
1860 krb5_error_code code = 0;
1861 krb5_creds my_creds;
1863 code = krb5_get_init_creds_password(ctx, &my_creds, principal,
1864 password, NULL, NULL, 0,
1865 target_service, krb_options);
1870 #ifndef SAMBA4_USES_HEIMDAL /* MIT */
1872 * We need to store the principal as returned from the KDC to the
1873 * credentials cache. If we don't do that the KRB5 library is not
1874 * able to find the tickets it is looking for
1876 principal = my_creds.client;
1878 code = krb5_cc_initialize(ctx, cc, principal);
1883 code = krb5_cc_store_cred(ctx, cc, &my_creds);
1889 *expire_time = (time_t) my_creds.times.endtime;
1893 *kdc_time = (time_t) my_creds.times.starttime;
1898 krb5_free_cred_contents(ctx, &my_creds);
1902 #ifdef SAMBA4_USES_HEIMDAL
1904 * @brief Simulate a kinit by putting the tgt in the given credential cache.
1906 * @param[in] ctx The library context
1908 * @param[in] cc The credential cache to store the tgt in.
1910 * @param[in] principal The initial client princial.
1912 * @param[in] password The password (or NULL).
1914 * @param[in] impersonate_principal The impersonatiion principal (or NULL).
1916 * @param[in] self_service The local service for S4U2Self if
1917 * impersonate_principal is specified).
1919 * @param[in] target_service The service name of the initial credentials
1920 * (kpasswd/REALM or a remote service). It defaults
1921 * to the krbtgt if NULL.
1923 * @param[in] krb_options Initial credential options.
1925 * @param[in] expire_time A pointer to store the experation time of the
1926 * credentials (or NULL).
1928 * @param[in] kdc_time A pointer to store the time when the ticket becomes
1931 * @return 0 on success, a Kerberos error code otherwise.
1933 krb5_error_code smb_krb5_kinit_s4u2_ccache(krb5_context ctx,
1934 krb5_ccache store_cc,
1935 krb5_principal init_principal,
1936 const char *init_password,
1937 krb5_principal impersonate_principal,
1938 const char *self_service,
1939 const char *target_service,
1940 krb5_get_init_creds_opt *krb_options,
1941 time_t *expire_time,
1944 krb5_error_code code = 0;
1945 krb5_get_creds_opt options;
1946 krb5_principal store_principal;
1947 krb5_creds store_creds;
1948 krb5_creds *s4u2self_creds;
1949 Ticket s4u2self_ticket;
1950 size_t s4u2self_ticketlen;
1951 krb5_creds *s4u2proxy_creds;
1952 krb5_principal self_princ;
1954 krb5_principal target_princ;
1956 const char *self_realm;
1957 krb5_principal blacklist_principal = NULL;
1958 krb5_principal whitelist_principal = NULL;
1960 code = krb5_get_init_creds_password(ctx, &store_creds,
1971 store_principal = init_principal;
1974 * We are trying S4U2Self now:
1976 * As we do not want to expose our TGT in the
1977 * krb5_ccache, which is also holds the impersonated creds.
1979 * Some low level krb5/gssapi function might use the TGT
1980 * identity and let the client act as our machine account.
1982 * We need to avoid that and use a temporary krb5_ccache
1983 * in order to pass our TGT to the krb5_get_creds() function.
1985 code = krb5_cc_new_unique(ctx, NULL, NULL, &tmp_cc);
1987 krb5_free_cred_contents(ctx, &store_creds);
1991 code = krb5_cc_initialize(ctx, tmp_cc, store_creds.client);
1993 krb5_cc_destroy(ctx, tmp_cc);
1994 krb5_free_cred_contents(ctx, &store_creds);
1998 code = krb5_cc_store_cred(ctx, tmp_cc, &store_creds);
2000 krb5_free_cred_contents(ctx, &store_creds);
2001 krb5_cc_destroy(ctx, tmp_cc);
2006 * we need to remember the client principal of our
2007 * TGT and make sure the KDC does not return this
2008 * in the impersonated tickets. This can happen
2009 * if the KDC does not support S4U2Self and S4U2Proxy.
2011 blacklist_principal = store_creds.client;
2012 store_creds.client = NULL;
2013 krb5_free_cred_contents(ctx, &store_creds);
2016 * Check if we also need S4U2Proxy or if S4U2Self is
2017 * enough in order to get a ticket for the target.
2019 if (target_service == NULL) {
2021 } else if (strcmp(target_service, self_service) == 0) {
2028 * For S4U2Self we need our own service principal,
2029 * which belongs to our own realm (available on
2030 * our client principal).
2032 self_realm = krb5_principal_get_realm(ctx, init_principal);
2034 code = krb5_parse_name(ctx, self_service, &self_princ);
2036 krb5_free_principal(ctx, blacklist_principal);
2037 krb5_cc_destroy(ctx, tmp_cc);
2041 code = krb5_principal_set_realm(ctx, self_princ, self_realm);
2043 krb5_free_principal(ctx, blacklist_principal);
2044 krb5_free_principal(ctx, self_princ);
2045 krb5_cc_destroy(ctx, tmp_cc);
2049 code = krb5_get_creds_opt_alloc(ctx, &options);
2051 krb5_free_principal(ctx, blacklist_principal);
2052 krb5_free_principal(ctx, self_princ);
2053 krb5_cc_destroy(ctx, tmp_cc);
2059 * If we want S4U2Proxy, we need the forwardable flag
2060 * on the S4U2Self ticket.
2062 krb5_get_creds_opt_set_options(ctx, options, KRB5_GC_FORWARDABLE);
2065 code = krb5_get_creds_opt_set_impersonate(ctx, options,
2066 impersonate_principal);
2068 krb5_get_creds_opt_free(ctx, options);
2069 krb5_free_principal(ctx, blacklist_principal);
2070 krb5_free_principal(ctx, self_princ);
2071 krb5_cc_destroy(ctx, tmp_cc);
2075 code = krb5_get_creds(ctx, options, tmp_cc,
2076 self_princ, &s4u2self_creds);
2077 krb5_get_creds_opt_free(ctx, options);
2078 krb5_free_principal(ctx, self_princ);
2080 krb5_free_principal(ctx, blacklist_principal);
2081 krb5_cc_destroy(ctx, tmp_cc);
2086 krb5_cc_destroy(ctx, tmp_cc);
2089 * Now make sure we store the impersonated principal
2090 * and creds instead of the TGT related stuff
2091 * in the krb5_ccache of the caller.
2093 code = krb5_copy_creds_contents(ctx, s4u2self_creds,
2095 krb5_free_creds(ctx, s4u2self_creds);
2101 * It's important to store the principal the KDC
2102 * returned, as otherwise the caller would not find
2103 * the S4U2Self ticket in the krb5_ccache lookup.
2105 store_principal = store_creds.client;
2110 * We are trying S4U2Proxy:
2112 * We need the ticket from the S4U2Self step
2113 * and our TGT in order to get the delegated ticket.
2115 code = decode_Ticket((const uint8_t *)s4u2self_creds->ticket.data,
2116 s4u2self_creds->ticket.length,
2118 &s4u2self_ticketlen);
2120 krb5_free_creds(ctx, s4u2self_creds);
2121 krb5_free_principal(ctx, blacklist_principal);
2122 krb5_cc_destroy(ctx, tmp_cc);
2127 * we need to remember the client principal of the
2128 * S4U2Self stage and as it needs to match the one we
2129 * will get for the S4U2Proxy stage. We need this
2130 * in order to detect KDCs which does not support S4U2Proxy.
2132 whitelist_principal = s4u2self_creds->client;
2133 s4u2self_creds->client = NULL;
2134 krb5_free_creds(ctx, s4u2self_creds);
2137 * For S4U2Proxy we also got a target service principal,
2138 * which also belongs to our own realm (available on
2139 * our client principal).
2141 code = krb5_parse_name(ctx, target_service, &target_princ);
2143 free_Ticket(&s4u2self_ticket);
2144 krb5_free_principal(ctx, whitelist_principal);
2145 krb5_free_principal(ctx, blacklist_principal);
2146 krb5_cc_destroy(ctx, tmp_cc);
2150 code = krb5_principal_set_realm(ctx, target_princ, self_realm);
2152 free_Ticket(&s4u2self_ticket);
2153 krb5_free_principal(ctx, target_princ);
2154 krb5_free_principal(ctx, whitelist_principal);
2155 krb5_free_principal(ctx, blacklist_principal);
2156 krb5_cc_destroy(ctx, tmp_cc);
2160 code = krb5_get_creds_opt_alloc(ctx, &options);
2162 free_Ticket(&s4u2self_ticket);
2163 krb5_free_principal(ctx, target_princ);
2164 krb5_free_principal(ctx, whitelist_principal);
2165 krb5_free_principal(ctx, blacklist_principal);
2166 krb5_cc_destroy(ctx, tmp_cc);
2170 krb5_get_creds_opt_set_options(ctx, options, KRB5_GC_FORWARDABLE);
2171 krb5_get_creds_opt_set_options(ctx, options, KRB5_GC_CONSTRAINED_DELEGATION);
2173 code = krb5_get_creds_opt_set_ticket(ctx, options, &s4u2self_ticket);
2174 free_Ticket(&s4u2self_ticket);
2176 krb5_get_creds_opt_free(ctx, options);
2177 krb5_free_principal(ctx, target_princ);
2178 krb5_free_principal(ctx, whitelist_principal);
2179 krb5_free_principal(ctx, blacklist_principal);
2180 krb5_cc_destroy(ctx, tmp_cc);
2184 code = krb5_get_creds(ctx, options, tmp_cc,
2185 target_princ, &s4u2proxy_creds);
2186 krb5_get_creds_opt_free(ctx, options);
2187 krb5_free_principal(ctx, target_princ);
2188 krb5_cc_destroy(ctx, tmp_cc);
2190 krb5_free_principal(ctx, whitelist_principal);
2191 krb5_free_principal(ctx, blacklist_principal);
2196 * Now make sure we store the impersonated principal
2197 * and creds instead of the TGT related stuff
2198 * in the krb5_ccache of the caller.
2200 code = krb5_copy_creds_contents(ctx, s4u2proxy_creds,
2202 krb5_free_creds(ctx, s4u2proxy_creds);
2204 krb5_free_principal(ctx, whitelist_principal);
2205 krb5_free_principal(ctx, blacklist_principal);
2210 * It's important to store the principal the KDC
2211 * returned, as otherwise the caller would not find
2212 * the S4U2Self ticket in the krb5_ccache lookup.
2214 store_principal = store_creds.client;
2217 if (blacklist_principal &&
2218 krb5_principal_compare(ctx, store_creds.client, blacklist_principal)) {
2222 code = krb5_unparse_name(ctx, blacklist_principal, &sp);
2226 code = krb5_unparse_name(ctx, impersonate_principal, &ip);
2230 DEBUG(1, ("smb_krb5_kinit_password_cache: "
2231 "KDC returned self principal[%s] while impersonating [%s]\n",
2232 sp?sp:"<no memory>",
2233 ip?ip:"<no memory>"));
2238 krb5_free_principal(ctx, whitelist_principal);
2239 krb5_free_principal(ctx, blacklist_principal);
2240 krb5_free_cred_contents(ctx, &store_creds);
2241 return KRB5_FWD_BAD_PRINCIPAL;
2243 if (blacklist_principal) {
2244 krb5_free_principal(ctx, blacklist_principal);
2247 if (whitelist_principal &&
2248 !krb5_principal_compare(ctx, store_creds.client, whitelist_principal)) {
2252 code = krb5_unparse_name(ctx, store_creds.client, &sp);
2256 code = krb5_unparse_name(ctx, whitelist_principal, &ep);
2260 DEBUG(1, ("smb_krb5_kinit_password_cache: "
2261 "KDC returned wrong principal[%s] we expected [%s]\n",
2262 sp?sp:"<no memory>",
2263 ep?ep:"<no memory>"));
2268 krb5_free_principal(ctx, whitelist_principal);
2269 krb5_free_cred_contents(ctx, &store_creds);
2270 return KRB5_FWD_BAD_PRINCIPAL;
2272 if (whitelist_principal) {
2273 krb5_free_principal(ctx, whitelist_principal);
2276 code = krb5_cc_initialize(ctx, store_cc, store_principal);
2278 krb5_free_cred_contents(ctx, &store_creds);
2282 code = krb5_cc_store_cred(ctx, store_cc, &store_creds);
2284 krb5_free_cred_contents(ctx, &store_creds);
2289 *expire_time = (time_t) store_creds.times.endtime;
2293 *kdc_time = (time_t) store_creds.times.starttime;
2296 krb5_free_cred_contents(ctx, &store_creds);
2302 #if !defined(HAVE_KRB5_MAKE_PRINCIPAL) && defined(HAVE_KRB5_BUILD_PRINCIPAL_ALLOC_VA)
2304 * @brief Create a principal name using a variable argument list.
2306 * @param[in] context The library context.
2308 * @param[inout] principal A pointer to the principal structure.
2310 * @param[in] _realm The realm to use. If NULL then the function will
2311 * get the default realm name.
2313 * @param[in] ... A list of 'char *' components, ending with NULL.
2315 * Use krb5_free_principal() to free the principal when it is no longer needed.
2317 * @return 0 on success, a Kerberos error code otherwise.
2319 krb5_error_code smb_krb5_make_principal(krb5_context context,
2320 krb5_principal *principal,
2321 const char *_realm, ...)
2323 krb5_error_code code;
2329 realm = discard_const_p(char, _realm);
2332 code = krb5_get_default_realm(context, &realm);
2339 va_start(ap, _realm);
2340 code = krb5_build_principal_alloc_va(context, principal,
2341 strlen(realm), realm,
2346 krb5_free_default_realm(context, realm);
2353 #if !defined(HAVE_KRB5_CC_GET_LIFETIME) && defined(HAVE_KRB5_CC_RETRIEVE_CRED)
2355 * @brief Get the lifetime of the initial ticket in the cache.
2357 * @param[in] context The kerberos context.
2359 * @param[in] id The credential cache to get the ticket lifetime.
2361 * @param[out] t A pointer to a time value to store the lifetime.
2363 * @return 0 on success, a krb5_error_code on error.
2365 krb5_error_code smb_krb5_cc_get_lifetime(krb5_context context,
2369 krb5_cc_cursor cursor;
2370 krb5_error_code kerr;
2376 kerr = krb5_timeofday(context, &now);
2381 kerr = krb5_cc_start_seq_get(context, id, &cursor);
2386 while ((kerr = krb5_cc_next_cred(context, id, &cursor, &cred)) == 0) {
2387 #ifndef HAVE_FLAGS_IN_KRB5_CREDS
2388 if (cred.ticket_flags & TKT_FLG_INITIAL) {
2390 if (cred.flags.b.initial) {
2392 if (now < cred.times.endtime) {
2393 *t = (time_t) (cred.times.endtime - now);
2395 krb5_free_cred_contents(context, &cred);
2398 krb5_free_cred_contents(context, &cred);
2401 krb5_cc_end_seq_get(context, id, &cursor);
2405 #endif /* HAVE_KRB5_CC_GET_LIFETIME */
2407 #if !defined(HAVE_KRB5_FREE_CHECKSUM_CONTENTS) && defined(HAVE_FREE_CHECKSUM)
2408 void smb_krb5_free_checksum_contents(krb5_context ctx, krb5_checksum *cksum)
2410 free_Checksum(cksum);
2415 * @brief Compute a checksum operating on a keyblock.
2417 * This function computes a checksum over a PAC using the keyblock for a keyed
2420 * @param[in] mem_ctx A talloc context to alocate the signature on.
2422 * @param[in] pac_data The PAC as input.
2424 * @param[in] context The library context.
2426 * @param[in] keyblock Encryption key for a keyed checksum.
2428 * @param[out] sig_type The checksum type
2430 * @param[out] sig_blob The talloc'ed checksum
2432 * The caller must free the sig_blob with talloc_free() when it is not needed
2435 * @return 0 on success, a Kerberos error code otherwise.
2437 krb5_error_code smb_krb5_make_pac_checksum(TALLOC_CTX *mem_ctx,
2438 DATA_BLOB *pac_data,
2439 krb5_context context,
2440 const krb5_keyblock *keyblock,
2442 DATA_BLOB *sig_blob)
2444 krb5_error_code ret;
2445 krb5_checksum cksum;
2446 #if defined(HAVE_KRB5_CRYPTO_INIT) && defined(HAVE_KRB5_CREATE_CHECKSUM)
2450 ret = krb5_crypto_init(context,
2455 DEBUG(0,("krb5_crypto_init() failed: %s\n",
2456 smb_get_krb5_error_message(context, ret, mem_ctx)));
2459 ret = krb5_create_checksum(context,
2461 KRB5_KU_OTHER_CKSUM,
2467 DEBUG(2, ("PAC Verification failed: %s\n",
2468 smb_get_krb5_error_message(context, ret, mem_ctx)));
2471 krb5_crypto_destroy(context, crypto);
2477 *sig_type = cksum.cksumtype;
2478 *sig_blob = data_blob_talloc(mem_ctx,
2479 cksum.checksum.data,
2480 cksum.checksum.length);
2481 #elif defined(HAVE_KRB5_C_MAKE_CHECKSUM)
2484 input.data = (char *)pac_data->data;
2485 input.length = pac_data->length;
2487 ret = krb5_c_make_checksum(context,
2490 KRB5_KEYUSAGE_APP_DATA_CKSUM,
2494 DEBUG(2, ("PAC Verification failed: %s\n",
2495 smb_get_krb5_error_message(context, ret, mem_ctx)));
2499 *sig_type = cksum.checksum_type;
2500 *sig_blob = data_blob_talloc(mem_ctx,
2505 #error krb5_create_checksum or krb5_c_make_checksum not available
2506 #endif /* HAVE_KRB5_C_MAKE_CHECKSUM */
2507 smb_krb5_free_checksum_contents(context, &cksum);
2514 * @brief Get realm of a principal
2516 * @param[in] context The library context
2518 * @param[in] principal The principal to get the realm from.
2520 * @return An allocated string with the realm or NULL if an error occured.
2522 * The caller must free the realm string with free() if not needed anymore.
2524 char *smb_krb5_principal_get_realm(krb5_context context,
2525 krb5_const_principal principal)
2527 #ifdef HAVE_KRB5_PRINCIPAL_GET_REALM /* Heimdal */
2528 return strdup(discard_const_p(char, krb5_principal_get_realm(context, principal)));
2529 #elif defined(krb5_princ_realm) /* MIT */
2531 realm = discard_const_p(krb5_data,
2532 krb5_princ_realm(context, principal));
2533 return strndup(realm->data, realm->length);
2535 #error UNKNOWN_GET_PRINC_REALM_FUNCTIONS
2540 * @brief Get realm of a principal
2542 * @param[in] context The library context
2544 * @param[in] principal The principal to set the realm
2546 * @param[in] realm The realm as a string to set.
2548 * @retur 0 on success, a Kerberos error code otherwise.
2550 krb5_error_code smb_krb5_principal_set_realm(krb5_context context,
2551 krb5_principal principal,
2554 #ifdef HAVE_KRB5_PRINCIPAL_SET_REALM /* Heimdal */
2555 return krb5_principal_set_realm(context, principal, realm);
2556 #elif defined(krb5_princ_realm) && defined(krb5_princ_set_realm) /* MIT */
2557 krb5_error_code ret;
2559 krb5_data *old_data;
2561 old_data = krb5_princ_realm(context, principal);
2563 ret = smb_krb5_copy_data_contents(&data,
2570 /* free realm before setting */
2571 free(old_data->data);
2573 krb5_princ_set_realm(context, principal, &data);
2577 #error UNKNOWN_PRINC_SET_REALM_FUNCTION
2582 /************************************************************************
2583 Routine to get the default realm from the kerberos credentials cache.
2584 Caller must free if the return value is not NULL.
2585 ************************************************************************/
2587 static char *smb_krb5_get_default_realm_from_ccache(TALLOC_CTX *mem_ctx)
2590 krb5_context ctx = NULL;
2591 krb5_ccache cc = NULL;
2592 krb5_principal princ = NULL;
2594 initialize_krb5_error_table();
2595 if (krb5_init_context(&ctx)) {
2599 DEBUG(5,("kerberos_get_default_realm_from_ccache: "
2600 "Trying to read krb5 cache: %s\n",
2601 krb5_cc_default_name(ctx)));
2602 if (krb5_cc_default(ctx, &cc)) {
2603 DEBUG(5,("kerberos_get_default_realm_from_ccache: "
2604 "failed to read default cache\n"));
2607 if (krb5_cc_get_principal(ctx, cc, &princ)) {
2608 DEBUG(5,("kerberos_get_default_realm_from_ccache: "
2609 "failed to get default principal\n"));
2613 #if defined(HAVE_KRB5_PRINCIPAL_GET_REALM)
2614 realm = talloc_strdup(mem_ctx, krb5_principal_get_realm(ctx, princ));
2615 #elif defined(HAVE_KRB5_PRINC_REALM)
2617 krb5_data *realm_data = krb5_princ_realm(ctx, princ);
2618 realm = talloc_strndup(mem_ctx, realm_data->data, realm_data->length);
2626 krb5_free_principal(ctx, princ);
2629 krb5_cc_close(ctx, cc);
2631 krb5_free_context(ctx);
2637 /************************************************************************
2638 Routine to get the realm from a given DNS name.
2639 ************************************************************************/
2641 static char *smb_krb5_get_realm_from_hostname(TALLOC_CTX *mem_ctx,
2642 const char *hostname)
2644 #if defined(HAVE_KRB5_REALM_TYPE)
2646 krb5_realm *realm_list = NULL;
2649 char **realm_list = NULL;
2652 krb5_error_code kerr;
2653 krb5_context ctx = NULL;
2655 initialize_krb5_error_table();
2656 if (krb5_init_context(&ctx)) {
2660 kerr = krb5_get_host_realm(ctx, hostname, &realm_list);
2662 DEBUG(3,("kerberos_get_realm_from_hostname %s: "
2664 hostname ? hostname : "(NULL)",
2665 error_message(kerr) ));
2669 if (realm_list && realm_list[0]) {
2670 realm = talloc_strdup(mem_ctx, realm_list[0]);
2677 krb5_free_host_realm(ctx, realm_list);
2680 krb5_free_context(ctx);
2687 * @brief Get the principal as a string from the service hostname.
2689 * @param[in] mem_ctx The talloc context
2691 * @param[in] service The service name
2693 * @param[in] remote_name The remote name
2695 * @param[in] default_realm The default_realm if we cannot get it from the
2696 * hostname or netbios name.
2698 * @return A talloc'ed principal string or NULL if an error occured.
2700 * The caller needs to free the principal with talloc_free() if it isn't needed
2703 char *smb_krb5_get_principal_from_service_hostname(TALLOC_CTX *mem_ctx,
2704 const char *service,
2705 const char *remote_name,
2706 const char *default_realm)
2711 host = strchr_m(remote_name, '.');
2714 realm = smb_krb5_get_realm_from_hostname(talloc_tos(),
2717 /* NetBIOS name - use our realm. */
2718 realm = smb_krb5_get_default_realm_from_ccache(talloc_tos());
2721 if (realm == NULL || *realm == '\0') {
2722 realm = talloc_strdup(talloc_tos(), default_realm);
2726 DEBUG(3,("Cannot get realm from, "
2727 "desthost %s or default ccache. Using default "
2728 "smb.conf realm %s\n",
2733 principal = talloc_asprintf(mem_ctx,
2735 service, remote_name,
2742 * @brief Get an error string from a Kerberos error code.
2744 * @param[in] context The library context.
2746 * @param[in] code The Kerberos error code.
2748 * @param[in] mem_ctx The talloc context to allocate the error string on.
2750 * @return A talloc'ed error string or NULL if an error occured.
2752 * The caller must free the returned error string with talloc_free() if not
2755 char *smb_get_krb5_error_message(krb5_context context,
2756 krb5_error_code code,
2757 TALLOC_CTX *mem_ctx)
2761 #if defined(HAVE_KRB5_GET_ERROR_MESSAGE) && defined(HAVE_KRB5_FREE_ERROR_MESSAGE)
2762 const char *context_error = krb5_get_error_message(context, code);
2763 if (context_error) {
2764 ret = talloc_asprintf(mem_ctx, "%s: %s",
2765 error_message(code), context_error);
2766 krb5_free_error_message(context, context_error);
2770 ret = talloc_strdup(mem_ctx, error_message(code));
2776 * @brief Return the kerberos library setting for: libdefaults:allow_weak_crypto
2778 * @param[in] context The library context
2780 * @return True if weak crypto is allowed, false if not.
2782 krb5_boolean smb_krb5_get_allowed_weak_crypto(krb5_context context)
2783 #if defined(HAVE_KRB5_CONFIG_GET_BOOL_DEFAULT)
2785 return krb5_config_get_bool_default(context,
2789 "allow_weak_crypto",
2792 #elif defined(HAVE_PROFILE_H) && defined(HAVE_KRB5_GET_PROFILE)
2794 #include <profile.h>
2795 krb5_error_code ret;
2796 krb5_boolean ret_default = false;
2800 ret = krb5_get_profile(context,
2806 ret = profile_get_boolean(profile,
2808 "allow_weak_crypto",
2809 NULL, /* subsubname */
2810 ret_default, /* def_val */
2811 &ret_profile /* *ret_default */);
2816 profile_release(profile);
2821 #error UNKNOWN_KRB5_CONFIG_ROUTINES
2825 * @brief Return the type of a krb5_principal
2827 * @param[in] context The library context.
2829 * @param[in] principal The principal to get the type from.
2831 * @return The integer type of the principal.
2833 int smb_krb5_principal_get_type(krb5_context context,
2834 krb5_const_principal principal)
2836 #ifdef HAVE_KRB5_PRINCIPAL_GET_TYPE /* Heimdal */
2837 return krb5_principal_get_type(context, principal);
2838 #elif defined(krb5_princ_type) /* MIT */
2839 return krb5_princ_type(context, principal);
2841 #error UNKNOWN_PRINC_GET_TYPE_FUNCTION
2846 * @brief Set the type of a principal
2848 * @param[in] context The library context
2850 * @param[inout] principal The principal to set the type for.
2852 * @param[in] type The principal type to set.
2854 void smb_krb5_principal_set_type(krb5_context context,
2855 krb5_principal principal,
2858 #ifdef HAVE_KRB5_PRINCIPAL_SET_TYPE /* Heimdal */
2859 krb5_principal_set_type(context, principal, type);
2860 #elif defined(krb5_princ_type) /* MIT */
2861 krb5_princ_type(context, principal) = type;
2863 #error UNKNOWN_PRINC_SET_TYPE_FUNCTION
2868 * @brief Generate a krb5 warning, forwarding to com_err
2870 * @param context The krb5_context
2871 * @param fmt The message format
2872 * @param ... The message arguments
2876 #if !defined(HAVE_KRB5_WARNX)
2877 krb5_error_code krb5_warnx(krb5_context context, const char *fmt, ...)
2881 va_start(args, fmt);
2882 com_err_va("kdb_samba", errno, fmt, args);
2889 krb5_error_code smb_krb5_cc_copy_creds(krb5_context context,
2890 krb5_ccache incc, krb5_ccache outcc)
2892 #ifdef HAVE_KRB5_CC_COPY_CACHE /* Heimdal */
2893 return krb5_cc_copy_cache(context, incc, outcc);
2894 #elif defined(HAVE_KRB5_CC_COPY_CREDS)
2895 return krb5_cc_copy_creds(context, incc, outcc);
2897 #error UNKNOWN_KRB5_CC_COPY_CACHE_OR_CREDS_FUNCTION
2901 /**********************************************************
2903 **********************************************************/
2905 static bool ads_cleanup_expired_creds(krb5_context context,
2909 krb5_error_code retval;
2910 const char *cc_type = krb5_cc_get_type(context, ccache);
2912 DEBUG(3, ("ads_cleanup_expired_creds: Ticket in ccache[%s:%s] expiration %s\n",
2913 cc_type, krb5_cc_get_name(context, ccache),
2914 http_timestring(talloc_tos(), credsp->times.endtime)));
2916 /* we will probably need new tickets if the current ones
2917 will expire within 10 seconds.
2919 if (credsp->times.endtime >= (time(NULL) + 10))
2922 /* heimdal won't remove creds from a file ccache, and
2923 perhaps we shouldn't anyway, since internally we
2924 use memory ccaches, and a FILE one probably means that
2925 we're using creds obtained outside of our exectuable
2927 if (strequal(cc_type, "FILE")) {
2928 DEBUG(5, ("ads_cleanup_expired_creds: We do not remove creds from a %s ccache\n", cc_type));
2932 retval = krb5_cc_remove_cred(context, ccache, 0, credsp);
2934 DEBUG(1, ("ads_cleanup_expired_creds: krb5_cc_remove_cred failed, err %s\n",
2935 error_message(retval)));
2936 /* If we have an error in this, we want to display it,
2937 but continue as though we deleted it */
2942 /* Allocate and setup the auth context into the state we need. */
2944 static krb5_error_code ads_setup_auth_context(krb5_context context,
2945 krb5_auth_context *auth_context)
2947 krb5_error_code retval;
2949 retval = krb5_auth_con_init(context, auth_context );
2951 DEBUG(1,("krb5_auth_con_init failed (%s)\n",
2952 error_message(retval)));
2956 /* Ensure this is an addressless ticket. */
2957 retval = krb5_auth_con_setaddrs(context, *auth_context, NULL, NULL);
2959 DEBUG(1,("krb5_auth_con_setaddrs failed (%s)\n",
2960 error_message(retval)));
2966 #if defined(TKT_FLG_OK_AS_DELEGATE ) && defined(HAVE_KRB5_AUTH_CON_SETUSERUSERKEY) && defined(KRB5_AUTH_CONTEXT_USE_SUBKEY) && defined(HAVE_KRB5_AUTH_CON_SET_REQ_CKSUMTYPE)
2967 static krb5_error_code ads_create_gss_checksum(krb5_data *in_data, /* [inout] */
2970 unsigned int orig_length = in_data->length;
2971 unsigned int base_cksum_size = GSSAPI_CHECKSUM_SIZE;
2972 char *gss_cksum = NULL;
2975 /* Extra length field for delgated ticket. */
2976 base_cksum_size += 4;
2979 if ((unsigned int)base_cksum_size + orig_length <
2980 (unsigned int)base_cksum_size) {
2984 gss_cksum = (char *)SMB_MALLOC(base_cksum_size + orig_length);
2985 if (gss_cksum == NULL) {
2989 memset(gss_cksum, '\0', base_cksum_size + orig_length);
2990 SIVAL(gss_cksum, 0, GSSAPI_BNDLENGTH);
2993 * GSS_C_NO_CHANNEL_BINDINGS means 16 zero bytes.
2994 * This matches the behavior of heimdal and mit.
2996 * And it is needed to work against some closed source
3001 memset(&gss_cksum[4], 0x00, GSSAPI_BNDLENGTH);
3003 SIVAL(gss_cksum, 20, gss_flags);
3006 SSVAL(gss_cksum, 24, 1); /* The Delegation Option identifier */
3007 SSVAL(gss_cksum, 26, orig_length);
3008 /* Copy the kerberos KRB_CRED data */
3009 memcpy(gss_cksum + 28, in_data->data, orig_length);
3010 free(in_data->data);
3011 in_data->data = NULL;
3012 in_data->length = 0;
3014 in_data->data = gss_cksum;
3015 in_data->length = base_cksum_size + orig_length;
3021 * We can't use krb5_mk_req because w2k wants the service to be in a particular
3024 static krb5_error_code ads_krb5_mk_req(krb5_context context,
3025 krb5_auth_context *auth_context,
3026 const krb5_flags ap_req_options,
3027 const char *principal,
3030 time_t *expire_time,
3031 const char *impersonate_princ_s)
3033 krb5_error_code retval;
3034 krb5_principal server;
3035 krb5_principal impersonate_princ = NULL;
3039 bool creds_ready = false;
3040 int i = 0, maxtries = 3;
3043 ZERO_STRUCT(in_data);
3045 retval = smb_krb5_parse_name(context, principal, &server);
3047 DEBUG(1,("ads_krb5_mk_req: Failed to parse principal %s\n", principal));
3051 if (impersonate_princ_s) {
3052 retval = smb_krb5_parse_name(context, impersonate_princ_s,
3053 &impersonate_princ);
3055 DEBUG(1,("ads_krb5_mk_req: Failed to parse principal %s\n", impersonate_princ_s));
3060 /* obtain ticket & session key */
3062 if ((retval = krb5_copy_principal(context, server, &creds.server))) {
3063 DEBUG(1,("ads_krb5_mk_req: krb5_copy_principal failed (%s)\n",
3064 error_message(retval)));
3068 retval = krb5_cc_get_principal(context, ccache, &creds.client);
3070 /* This can commonly fail on smbd startup with no ticket in the cache.
3071 * Report at higher level than 1. */
3072 DEBUG(3,("ads_krb5_mk_req: krb5_cc_get_principal failed (%s)\n",
3073 error_message(retval)));
3077 while (!creds_ready && (i < maxtries)) {
3079 retval = smb_krb5_get_credentials(context,
3086 DBG_WARNING("smb_krb5_get_credentials failed for %s "
3089 error_message(retval));
3093 /* cope with ticket being in the future due to clock skew */
3094 if ((unsigned)credsp->times.starttime > time(NULL)) {
3095 time_t t = time(NULL);
3096 int time_offset =(int)((unsigned)credsp->times.starttime-t);
3097 DEBUG(4,("ads_krb5_mk_req: Advancing clock by %d seconds to cope with clock skew\n", time_offset));
3098 krb5_set_real_time(context, t + time_offset + 1, 0);
3101 ok = ads_cleanup_expired_creds(context, ccache, credsp);
3109 DBG_DEBUG("Ticket (%s) in ccache (%s:%s) is valid until: (%s - %u)\n",
3111 krb5_cc_get_type(context, ccache),
3112 krb5_cc_get_name(context, ccache),
3113 http_timestring(talloc_tos(),
3114 (unsigned)credsp->times.endtime),
3115 (unsigned)credsp->times.endtime);
3118 *expire_time = (time_t)credsp->times.endtime;
3121 /* Allocate the auth_context. */
3122 retval = ads_setup_auth_context(context, auth_context);
3124 DBG_WARNING("ads_setup_auth_context failed (%s)\n",
3125 error_message(retval));
3129 #if defined(TKT_FLG_OK_AS_DELEGATE ) && defined(HAVE_KRB5_AUTH_CON_SETUSERUSERKEY) && defined(KRB5_AUTH_CONTEXT_USE_SUBKEY) && defined(HAVE_KRB5_AUTH_CON_SET_REQ_CKSUMTYPE)
3131 uint32_t gss_flags = 0;
3133 if (credsp->ticket_flags & TKT_FLG_OK_AS_DELEGATE) {
3135 * Fetch a forwarded TGT from the KDC so that we can
3136 * hand off a 2nd ticket as part of the kerberos
3140 DBG_INFO("Server marked as OK to delegate to, building "
3141 "forwardable TGT\n");
3143 retval = krb5_auth_con_setuseruserkey(context,
3145 &credsp->keyblock );
3147 DBG_WARNING("krb5_auth_con_setuseruserkey "
3149 error_message(retval)));
3153 /* Must use a subkey for forwarded tickets. */
3154 retval = krb5_auth_con_setflags(context,
3156 KRB5_AUTH_CONTEXT_USE_SUBKEY);
3158 DBG_WARNING("krb5_auth_con_setflags failed (%s)\n",
3159 error_message(retval)));
3163 retval = krb5_fwd_tgt_creds(context,/* Krb5 context [in] */
3164 *auth_context, /* Authentication context [in] */
3165 discard_const_p(char, KRB5_TGS_NAME), /* Ticket service name ("krbtgt") [in] */
3166 credsp->client, /* Client principal for the tgt [in] */
3167 credsp->server, /* Server principal for the tgt [in] */
3168 ccache, /* Credential cache to use for storage [in] */
3169 1, /* Turn on for "Forwardable ticket" [in] */
3170 &in_data ); /* Resulting response [out] */
3173 DBG_INFO("krb5_fwd_tgt_creds failed (%s)\n",
3174 error_message(retval));
3177 * This is not fatal. Delete the *auth_context and continue
3178 * with krb5_mk_req_extended to get a non-forwardable ticket.
3182 free( in_data.data );
3183 in_data.data = NULL;
3186 krb5_auth_con_free(context, *auth_context);
3187 *auth_context = NULL;
3188 retval = ads_setup_auth_context(context, auth_context);
3190 DBG_WARNING("ads_setup_auth_context failed (%s)\n",
3191 error_message(retval)));
3195 /* We got a delegated ticket. */
3196 gss_flags |= GSS_C_DELEG_FLAG;
3200 /* Frees and reallocates in_data into a GSS checksum blob. */
3201 retval = ads_create_gss_checksum(&in_data, gss_flags);
3206 /* We always want GSS-checksum types. */
3207 retval = krb5_auth_con_set_req_cksumtype(context, *auth_context, GSSAPI_CHECKSUM );
3209 DEBUG(1,("krb5_auth_con_set_req_cksumtype failed (%s)\n",
3210 error_message(retval)));
3216 retval = krb5_mk_req_extended(context, auth_context, ap_req_options,
3217 &in_data, credsp, outbuf);
3219 DBG_WARNING("krb5_mk_req_extended failed (%s)\n",
3220 error_message(retval));
3223 #if defined(TKT_FLG_OK_AS_DELEGATE ) && defined(HAVE_KRB5_AUTH_CON_SETUSERUSERKEY) && defined(KRB5_AUTH_CONTEXT_USE_SUBKEY) && defined(HAVE_KRB5_AUTH_CON_SET_REQ_CKSUMTYPE)
3228 free( in_data.data );
3232 krb5_free_creds(context, credsp);
3235 krb5_free_cred_contents(context, &creds);
3238 krb5_free_principal(context, server);
3239 if (impersonate_princ) {
3240 krb5_free_principal(context, impersonate_princ);
3247 get a kerberos5 ticket for the given service
3249 int ads_krb5_cli_get_ticket(TALLOC_CTX *mem_ctx,
3250 const char *principal,
3253 DATA_BLOB *session_key_krb5,
3254 uint32_t extra_ap_opts, const char *ccname,
3256 const char *impersonate_princ_s)
3258 krb5_error_code retval;
3260 krb5_context context = NULL;
3261 krb5_ccache ccdef = NULL;
3262 krb5_auth_context auth_context = NULL;
3263 krb5_enctype enc_types[] = {
3264 #ifdef HAVE_ENCTYPE_AES256_CTS_HMAC_SHA1_96
3265 ENCTYPE_AES256_CTS_HMAC_SHA1_96,
3267 #ifdef HAVE_ENCTYPE_AES128_CTS_HMAC_SHA1_96
3268 ENCTYPE_AES128_CTS_HMAC_SHA1_96,
3270 ENCTYPE_ARCFOUR_HMAC,
3271 ENCTYPE_DES_CBC_MD5,
3272 ENCTYPE_DES_CBC_CRC,
3276 initialize_krb5_error_table();
3277 retval = krb5_init_context(&context);
3279 DBG_WARNING("krb5_init_context failed (%s)\n",
3280 error_message(retval));
3284 if (time_offset != 0) {
3285 krb5_set_real_time(context, time(NULL) + time_offset, 0);
3288 retval = krb5_cc_resolve(context,
3289 ccname ? ccname : krb5_cc_default_name(context),
3292 DBG_WARNING("krb5_cc_default failed (%s)\n",
3293 error_message(retval));
3297 retval = krb5_set_default_tgs_ktypes(context, enc_types);
3299 DBG_WARNING("krb5_set_default_tgs_ktypes failed (%s)\n",
3300 error_message(retval));
3304 retval = ads_krb5_mk_req(context,
3306 AP_OPTS_USE_SUBKEY | (krb5_flags)extra_ap_opts,
3311 impersonate_princ_s);
3316 ok = smb_krb5_get_smb_session_key(mem_ctx,
3326 *ticket = data_blob_talloc(mem_ctx, packet.data, packet.length);
3328 smb_krb5_free_data_contents(context, &packet);
3334 krb5_cc_close(context, ccdef);
3337 krb5_auth_con_free(context, auth_context);
3339 krb5_free_context(context);
3345 #else /* HAVE_KRB5 */
3346 /* This saves a few linking headaches */
3347 int ads_krb5_cli_get_ticket(TALLOC_CTX *mem_ctx,
3348 const char *principal,
3351 DATA_BLOB *session_key_krb5,
3352 uint32_t extra_ap_opts, const char *ccname,
3354 const char *impersonate_princ_s)
3356 DEBUG(0,("NO KERBEROS SUPPORT\n"));
3360 #endif /* HAVE_KRB5 */