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/crypto/crypto.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 occurred.
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 occurred.
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
,
210 const krb5_principal client
,
211 const krb5_principal server
,
214 krb5_error_code code
= EINVAL
;
215 #ifdef SAMBA4_USES_HEIMDAL
216 code
= krb5_mk_error(context
,
222 NULL
, /* client_time */
223 NULL
, /* client_usec */
226 krb5_principal unspec_server
= NULL
;
232 code
= krb5_us_timeofday(context
,
239 errpkt
.error
= error_code
;
241 errpkt
.text
.length
= 0;
242 if (e_text
!= NULL
) {
243 errpkt
.text
.length
= strlen(e_text
);
244 errpkt
.text
.data
= discard_const_p(char, e_text
);
247 errpkt
.e_data
.magic
= KV5M_DATA
;
248 errpkt
.e_data
.length
= 0;
249 errpkt
.e_data
.data
= NULL
;
250 if (e_data
!= NULL
) {
251 errpkt
.e_data
= *e_data
;
254 errpkt
.client
= client
;
256 if (server
!= NULL
) {
257 errpkt
.server
= server
;
259 code
= smb_krb5_make_principal(context
,
261 "<unspecified realm>",
266 errpkt
.server
= unspec_server
;
269 code
= krb5_mk_error(context
,
272 krb5_free_principal(context
, unspec_server
);
278 * @brief Create a keyblock based on input parameters
280 * @param context The krb5_context
281 * @param host_princ The krb5_principal to use
282 * @param salt The optional salt, if omitted, salt is calculated with
283 * the provided principal.
284 * @param password The krb5_data containing the password
285 * @param enctype The krb5_enctype to use for the keyblock generation
286 * @param key The returned krb5_keyblock, caller needs to free with
287 * krb5_free_keyblock().
289 * @return krb5_error_code
291 int smb_krb5_create_key_from_string(krb5_context context
,
292 krb5_const_principal host_princ
,
295 krb5_enctype enctype
,
300 if (host_princ
== NULL
&& salt
== NULL
) {
304 if ((int)enctype
== (int)ENCTYPE_ARCFOUR_HMAC
) {
305 TALLOC_CTX
*frame
= talloc_stackframe();
306 uint8_t *utf16
= NULL
;
307 size_t utf16_size
= 0;
311 ok
= convert_string_talloc(frame
, CH_UNIX
, CH_UTF16LE
,
312 password
->data
, password
->length
,
313 (void **)&utf16
, &utf16_size
);
323 mdfour(nt_hash
, utf16
, utf16_size
);
324 memset(utf16
, 0, utf16_size
);
325 ret
= smb_krb5_keyblock_init_contents(context
,
326 ENCTYPE_ARCFOUR_HMAC
,
330 ZERO_STRUCT(nt_hash
);
340 #if defined(HAVE_KRB5_PRINCIPAL2SALT) && defined(HAVE_KRB5_C_STRING_TO_KEY)
345 ret
= krb5_principal2salt(context
, host_princ
, &_salt
);
347 DEBUG(1,("krb5_principal2salt failed (%s)\n", error_message(ret
)));
353 ret
= krb5_c_string_to_key(context
, enctype
, password
, &_salt
, key
);
355 SAFE_FREE(_salt
.data
);
358 #elif defined(HAVE_KRB5_GET_PW_SALT) && defined(HAVE_KRB5_STRING_TO_KEY_SALT)
363 ret
= krb5_get_pw_salt(context
, host_princ
, &_salt
);
365 DEBUG(1,("krb5_get_pw_salt failed (%s)\n", error_message(ret
)));
369 _salt
.saltvalue
= *salt
;
370 _salt
.salttype
= KRB5_PW_SALT
;
373 ret
= krb5_string_to_key_salt(context
, enctype
, (const char *)password
->data
, _salt
, key
);
375 krb5_free_salt(context
, _salt
);
379 #error UNKNOWN_CREATE_KEY_FUNCTIONS
385 * @brief Create a salt for a given principal
387 * @param context The initialized krb5_context
388 * @param host_princ The krb5_principal to create the salt for
389 * @param psalt A pointer to a krb5_data struct
391 * caller has to free the contents of psalt with smb_krb5_free_data_contents
392 * when function has succeeded
394 * @return krb5_error_code, returns 0 on success, error code otherwise
397 int smb_krb5_get_pw_salt(krb5_context context
,
398 krb5_const_principal host_princ
,
400 #if defined(HAVE_KRB5_GET_PW_SALT)
406 ret
= krb5_get_pw_salt(context
, host_princ
, &salt
);
411 psalt
->data
= salt
.saltvalue
.data
;
412 psalt
->length
= salt
.saltvalue
.length
;
416 #elif defined(HAVE_KRB5_PRINCIPAL2SALT)
419 return krb5_principal2salt(context
, host_princ
, psalt
);
422 #error UNKNOWN_SALT_FUNCTIONS
425 #if defined(HAVE_KRB5_GET_PERMITTED_ENCTYPES)
427 * @brief Get a list of encryption types allowed for session keys
429 * @param[in] context The library context
431 * @param[in] enctypes An allocated, zero-terminated list of encryption types
433 * This function returns an allocated list of encryption types allowed for
436 * Use free() to free the enctypes when it is no longer needed.
438 * @retval 0 Success; otherwise - Kerberos error codes
440 krb5_error_code
smb_krb5_get_allowed_etypes(krb5_context context
,
441 krb5_enctype
**enctypes
)
443 return krb5_get_permitted_enctypes(context
, enctypes
);
445 #elif defined(HAVE_KRB5_GET_DEFAULT_IN_TKT_ETYPES)
446 krb5_error_code
smb_krb5_get_allowed_etypes(krb5_context context
,
447 krb5_enctype
**enctypes
)
449 #ifdef HAVE_KRB5_PDU_NONE_DECL
450 return krb5_get_default_in_tkt_etypes(context
, KRB5_PDU_NONE
, enctypes
);
452 return krb5_get_default_in_tkt_etypes(context
, enctypes
);
456 #error UNKNOWN_GET_ENCTYPES_FUNCTIONS
461 * @brief Convert a string principal name to a Kerberos principal.
463 * @param[in] context The library context
465 * @param[in] name The principal as a unix charset string.
467 * @param[out] principal The newly allocated principal.
469 * Use krb5_free_principal() to free a principal when it is no longer needed.
471 * @return 0 on success, a Kerberos error code otherwise.
473 krb5_error_code
smb_krb5_parse_name(krb5_context context
,
475 krb5_principal
*principal
)
479 size_t converted_size
;
480 TALLOC_CTX
*frame
= talloc_stackframe();
482 if (!push_utf8_talloc(frame
, &utf8_name
, name
, &converted_size
)) {
487 ret
= krb5_parse_name(context
, utf8_name
, principal
);
493 * @brief Convert a Kerberos principal structure to a string representation.
495 * The resulting string representation will be a unix charset name and is
498 * @param[in] mem_ctx The talloc context to allocate memory on.
500 * @param[in] context The library context.
502 * @param[in] principal The principal.
504 * @param[out] unix_name A string representation of the princpial name as with
507 * Use talloc_free() to free the string representation if it is no longer
510 * @return 0 on success, a Kerberos error code otherwise.
512 krb5_error_code
smb_krb5_unparse_name(TALLOC_CTX
*mem_ctx
,
513 krb5_context context
,
514 krb5_const_principal principal
,
519 size_t converted_size
;
522 ret
= krb5_unparse_name(context
, principal
, &utf8_name
);
527 if (!pull_utf8_talloc(mem_ctx
, unix_name
, utf8_name
, &converted_size
)) {
528 krb5_free_unparsed_name(context
, utf8_name
);
531 krb5_free_unparsed_name(context
, utf8_name
);
536 * @brief Free the contents of a krb5_data structure and zero the data field.
538 * @param[in] context The krb5 context
540 * @param[in] pdata The data structure to free contents of
542 * This function frees the contents, not the structure itself.
544 void smb_krb5_free_data_contents(krb5_context context
, krb5_data
*pdata
)
546 #if defined(HAVE_KRB5_FREE_DATA_CONTENTS)
548 krb5_free_data_contents(context
, pdata
);
550 #elif defined(HAVE_KRB5_DATA_FREE)
551 krb5_data_free(context
, pdata
);
553 SAFE_FREE(pdata
->data
);
558 * @brief copy a buffer into a krb5_data struct
560 * @param[in] p The krb5_data
561 * @param[in] data The data to copy
562 * @param[in] length The length of the data to copy
563 * @return krb5_error_code
565 * Caller has to free krb5_data with smb_krb5_free_data_contents().
567 krb5_error_code
smb_krb5_copy_data_contents(krb5_data
*p
,
571 #if defined(HAVE_KRB5_DATA_COPY)
572 return krb5_data_copy(p
, data
, len
);
575 p
->data
= malloc(len
);
576 if (p
->data
== NULL
) {
579 memmove(p
->data
, data
, len
);
584 p
->magic
= KV5M_DATA
;
589 bool smb_krb5_get_smb_session_key(TALLOC_CTX
*mem_ctx
,
590 krb5_context context
,
591 krb5_auth_context auth_context
,
592 DATA_BLOB
*session_key
,
595 krb5_keyblock
*skey
= NULL
;
596 krb5_error_code err
= 0;
600 #ifdef HAVE_KRB5_AUTH_CON_GETRECVSUBKEY
601 err
= krb5_auth_con_getrecvsubkey(context
,
604 #else /* HAVE_KRB5_AUTH_CON_GETRECVSUBKEY */
605 err
= krb5_auth_con_getremotesubkey(context
,
606 auth_context
, &skey
);
607 #endif /* HAVE_KRB5_AUTH_CON_GETRECVSUBKEY */
609 #ifdef HAVE_KRB5_AUTH_CON_GETSENDSUBKEY
610 err
= krb5_auth_con_getsendsubkey(context
,
613 #else /* HAVE_KRB5_AUTH_CON_GETSENDSUBKEY */
614 err
= krb5_auth_con_getlocalsubkey(context
,
615 auth_context
, &skey
);
616 #endif /* HAVE_KRB5_AUTH_CON_GETSENDSUBKEY */
619 if (err
|| skey
== NULL
) {
620 DEBUG(10, ("KRB5 error getting session key %d\n", err
));
624 DEBUG(10, ("Got KRB5 session key of length %d\n",
625 (int)KRB5_KEY_LENGTH(skey
)));
627 *session_key
= data_blob_talloc(mem_ctx
,
629 KRB5_KEY_LENGTH(skey
));
630 dump_data_pw("KRB5 Session Key:\n",
632 session_key
->length
);
638 krb5_free_keyblock(context
, skey
);
646 * @brief Get talloced string component of a principal
648 * @param[in] mem_ctx The TALLOC_CTX
649 * @param[in] context The krb5_context
650 * @param[in] principal The principal
651 * @param[in] component The component
652 * @return string component
654 * Caller must talloc_free if the return value is not NULL.
657 char *smb_krb5_principal_get_comp_string(TALLOC_CTX
*mem_ctx
,
658 krb5_context context
,
659 krb5_const_principal principal
,
660 unsigned int component
)
662 #if defined(HAVE_KRB5_PRINCIPAL_GET_COMP_STRING)
663 return talloc_strdup(mem_ctx
, krb5_principal_get_comp_string(context
, principal
, component
));
667 if (component
>= krb5_princ_size(context
, principal
)) {
671 data
= krb5_princ_component(context
, principal
, component
);
676 return talloc_strndup(mem_ctx
, data
->data
, data
->length
);
683 * @param[in] ccache_string A string pointing to the cache to renew the ticket
684 * (e.g. FILE:/tmp/krb5cc_0) or NULL. If the principal
685 * ccache has not been specified, the default ccache
688 * @param[in] client_string The client principal string (e.g. user@SAMBA.SITE)
689 * or NULL. If the principal string has not been
690 * specified, the principal from the ccache will be
693 * @param[in] service_string The service ticket string
694 * (e.g. krbtgt/SAMBA.SITE@SAMBA.SITE) or NULL. If
695 * the sevice ticket is specified, it is parsed (
696 * with the realm part ignored) and used as the
697 * server principal of the credential. Otherwise
698 * the ticket-granting service is used.
700 * @param[in] expire_time A pointer to store the credentials end time or
703 * @return 0 on Succes, a Kerberos error code otherwise.
705 krb5_error_code
smb_krb5_renew_ticket(const char *ccache_string
,
706 const char *client_string
,
707 const char *service_string
,
711 krb5_context context
= NULL
;
712 krb5_ccache ccache
= NULL
;
713 krb5_principal client
= NULL
;
714 krb5_creds creds
, creds_in
;
717 ZERO_STRUCT(creds_in
);
719 initialize_krb5_error_table();
720 ret
= krb5_init_context(&context
);
725 if (!ccache_string
) {
726 ccache_string
= krb5_cc_default_name(context
);
729 if (!ccache_string
) {
734 DEBUG(10,("smb_krb5_renew_ticket: using %s as ccache\n", ccache_string
));
736 /* FIXME: we should not fall back to defaults */
737 ret
= krb5_cc_resolve(context
, discard_const_p(char, ccache_string
), &ccache
);
743 ret
= smb_krb5_parse_name(context
, client_string
, &client
);
748 ret
= krb5_cc_get_principal(context
, ccache
, &client
);
754 ret
= krb5_get_renewed_creds(context
, &creds
, client
, ccache
, discard_const_p(char, service_string
));
756 DEBUG(10,("smb_krb5_renew_ticket: krb5_get_kdc_cred failed: %s\n", error_message(ret
)));
760 /* hm, doesn't that create a new one if the old one wasn't there? - Guenther */
761 ret
= krb5_cc_initialize(context
, ccache
, client
);
766 ret
= krb5_cc_store_cred(context
, ccache
, &creds
);
769 *expire_time
= (time_t) creds
.times
.endtime
;
773 krb5_free_cred_contents(context
, &creds_in
);
774 krb5_free_cred_contents(context
, &creds
);
777 krb5_free_principal(context
, client
);
780 krb5_cc_close(context
, ccache
);
783 krb5_free_context(context
);
790 * @brief Free the data stored in an smb_krb5_addresses structure.
792 * @param[in] context The library context
794 * @param[in] addr The address structure to free.
796 * @return 0 on success, a Kerberos error code otherwise.
798 krb5_error_code
smb_krb5_free_addresses(krb5_context context
,
799 smb_krb5_addresses
*addr
)
801 krb5_error_code ret
= 0;
805 #if defined(HAVE_MAGIC_IN_KRB5_ADDRESS) && defined(HAVE_ADDRTYPE_IN_KRB5_ADDRESS) /* MIT */
806 krb5_free_addresses(context
, addr
->addrs
);
807 #elif defined(HAVE_ADDR_TYPE_IN_KRB5_ADDRESS) /* Heimdal */
808 ret
= krb5_free_addresses(context
, addr
->addrs
);
809 SAFE_FREE(addr
->addrs
);
816 #define MAX_NETBIOSNAME_LEN 16
819 * @brief Add a netbios name to the array of addresses
821 * @param[in] kerb_addr A pointer to the smb_krb5_addresses to add the
824 * @param[in] netbios_name The netbios name to add.
826 * @return 0 on success, a Kerberos error code otherwise.
828 krb5_error_code
smb_krb5_gen_netbios_krb5_address(smb_krb5_addresses
**kerb_addr
,
829 const char *netbios_name
)
831 krb5_error_code ret
= 0;
832 char buf
[MAX_NETBIOSNAME_LEN
];
834 #if defined(HAVE_MAGIC_IN_KRB5_ADDRESS) && defined(HAVE_ADDRTYPE_IN_KRB5_ADDRESS) /* MIT */
835 krb5_address
**addrs
= NULL
;
836 #elif defined(HAVE_ADDR_TYPE_IN_KRB5_ADDRESS) /* Heimdal */
837 krb5_addresses
*addrs
= NULL
;
840 *kerb_addr
= (smb_krb5_addresses
*)SMB_MALLOC(sizeof(smb_krb5_addresses
));
841 if (*kerb_addr
== NULL
) {
845 /* temporarily duplicate put_name() code here to avoid dependency
846 * issues for a 5 lines function */
847 len
= strlen(netbios_name
);
848 memcpy(buf
, netbios_name
,
849 (len
< MAX_NETBIOSNAME_LEN
) ? len
: MAX_NETBIOSNAME_LEN
- 1);
850 if (len
< MAX_NETBIOSNAME_LEN
- 1) {
851 memset(buf
+ len
, ' ', MAX_NETBIOSNAME_LEN
- 1 - len
);
853 buf
[MAX_NETBIOSNAME_LEN
- 1] = 0x20;
855 #if defined(HAVE_MAGIC_IN_KRB5_ADDRESS) && defined(HAVE_ADDRTYPE_IN_KRB5_ADDRESS) /* MIT */
859 addrs
= (krb5_address
**)SMB_MALLOC(sizeof(krb5_address
*) * num_addr
);
861 SAFE_FREE(*kerb_addr
);
865 memset(addrs
, 0, sizeof(krb5_address
*) * num_addr
);
867 addrs
[0] = (krb5_address
*)SMB_MALLOC(sizeof(krb5_address
));
868 if (addrs
[0] == NULL
) {
870 SAFE_FREE(*kerb_addr
);
874 addrs
[0]->magic
= KV5M_ADDRESS
;
875 addrs
[0]->addrtype
= KRB5_ADDR_NETBIOS
;
876 addrs
[0]->length
= MAX_NETBIOSNAME_LEN
;
877 addrs
[0]->contents
= (unsigned char *)SMB_MALLOC(addrs
[0]->length
);
878 if (addrs
[0]->contents
== NULL
) {
881 SAFE_FREE(*kerb_addr
);
885 memcpy(addrs
[0]->contents
, buf
, addrs
[0]->length
);
889 #elif defined(HAVE_ADDR_TYPE_IN_KRB5_ADDRESS) /* Heimdal */
891 addrs
= (krb5_addresses
*)SMB_MALLOC(sizeof(krb5_addresses
));
893 SAFE_FREE(*kerb_addr
);
897 memset(addrs
, 0, sizeof(krb5_addresses
));
900 addrs
->val
= (krb5_address
*)SMB_MALLOC(sizeof(krb5_address
));
901 if (addrs
->val
== NULL
) {
903 SAFE_FREE(kerb_addr
);
907 addrs
->val
[0].addr_type
= KRB5_ADDR_NETBIOS
;
908 addrs
->val
[0].address
.length
= MAX_NETBIOSNAME_LEN
;
909 addrs
->val
[0].address
.data
= (unsigned char *)SMB_MALLOC(addrs
->val
[0].address
.length
);
910 if (addrs
->val
[0].address
.data
== NULL
) {
911 SAFE_FREE(addrs
->val
);
913 SAFE_FREE(*kerb_addr
);
917 memcpy(addrs
->val
[0].address
.data
, buf
, addrs
->val
[0].address
.length
);
920 #error UNKNOWN_KRB5_ADDRESS_FORMAT
922 (*kerb_addr
)->addrs
= addrs
;
928 * @brief Get the enctype from a key table entry
930 * @param[in] kt_entry Key table entry to get the enctype from.
932 * @return The enctype from the entry.
934 krb5_enctype
smb_krb5_kt_get_enctype_from_entry(krb5_keytab_entry
*kt_entry
)
936 return KRB5_KEY_TYPE(KRB5_KT_KEY(kt_entry
));
940 * @brief Free the contents of a key table entry.
942 * @param[in] context The library context.
944 * @param[in] kt_entry The key table entry to free the contents of.
946 * @return 0 on success, a Kerberos error code otherwise.
948 * The pointer itself is not freed.
950 krb5_error_code
smb_krb5_kt_free_entry(krb5_context context
,
951 krb5_keytab_entry
*kt_entry
)
953 /* Try krb5_free_keytab_entry_contents first, since
954 * MIT Kerberos >= 1.7 has both krb5_free_keytab_entry_contents and
955 * krb5_kt_free_entry but only has a prototype for the first, while the
956 * second is considered private.
958 #if defined(HAVE_KRB5_FREE_KEYTAB_ENTRY_CONTENTS)
959 return krb5_free_keytab_entry_contents(context
, kt_entry
);
960 #elif defined(HAVE_KRB5_KT_FREE_ENTRY)
961 return krb5_kt_free_entry(context
, kt_entry
);
963 #error UNKNOWN_KT_FREE_FUNCTION
969 * @brief Convert an encryption type to a string.
971 * @param[in] context The library context.
973 * @param[in] enctype The encryption type.
975 * @param[in] etype_s A pointer to store the allocated encryption type as a
978 * @return 0 on success, a Kerberos error code otherwise.
980 * The caller needs to free the allocated string etype_s.
982 krb5_error_code
smb_krb5_enctype_to_string(krb5_context context
,
983 krb5_enctype enctype
,
986 #ifdef HAVE_KRB5_ENCTYPE_TO_STRING_WITH_KRB5_CONTEXT_ARG
987 return krb5_enctype_to_string(context
, enctype
, etype_s
); /* Heimdal */
988 #elif defined(HAVE_KRB5_ENCTYPE_TO_STRING_WITH_SIZE_T_ARG)
990 krb5_error_code ret
= krb5_enctype_to_string(enctype
, buf
, 256); /* MIT */
994 *etype_s
= SMB_STRDUP(buf
);
1000 #error UNKNOWN_KRB5_ENCTYPE_TO_STRING_FUNCTION
1004 /* This MAX_NAME_LEN is a constant defined in krb5.h */
1005 #ifndef MAX_KEYTAB_NAME_LEN
1006 #define MAX_KEYTAB_NAME_LEN 1100
1010 * @brief Open a key table readonly or with readwrite access.
1012 * Allows to use a different keytab than the default one using a relative
1013 * path to the keytab.
1015 * @param[in] context The library context
1017 * @param[in] keytab_name_req The path to the key table.
1019 * @param[in] write_access Open with readwrite access.
1021 * @param[in] keytab A pointer o the opended key table.
1023 * The keytab pointer should be freed using krb5_kt_close().
1025 * @return 0 on success, a Kerberos error code otherwise.
1027 krb5_error_code
smb_krb5_kt_open_relative(krb5_context context
,
1028 const char *keytab_name_req
,
1030 krb5_keytab
*keytab
)
1032 krb5_error_code ret
= 0;
1033 TALLOC_CTX
*mem_ctx
;
1034 char keytab_string
[MAX_KEYTAB_NAME_LEN
];
1035 char *kt_str
= NULL
;
1036 bool found_valid_name
= false;
1037 const char *pragma
= "FILE";
1038 const char *tmp
= NULL
;
1040 if (!write_access
&& !keytab_name_req
) {
1041 /* caller just wants to read the default keytab readonly, so be it */
1042 return krb5_kt_default(context
, keytab
);
1045 mem_ctx
= talloc_init("smb_krb5_open_keytab");
1050 #ifdef HAVE_WRFILE_KEYTAB
1056 if (keytab_name_req
) {
1058 if (strlen(keytab_name_req
) > MAX_KEYTAB_NAME_LEN
) {
1059 ret
= KRB5_CONFIG_NOTENUFSPACE
;
1063 if ((strncmp(keytab_name_req
, "WRFILE:", 7) == 0) ||
1064 (strncmp(keytab_name_req
, "FILE:", 5) == 0)) {
1065 tmp
= keytab_name_req
;
1069 tmp
= talloc_asprintf(mem_ctx
, "%s:%s", pragma
, keytab_name_req
);
1078 /* we need to handle more complex keytab_strings, like:
1079 * "ANY:FILE:/etc/krb5.keytab,krb4:/etc/srvtab" */
1081 ret
= krb5_kt_default_name(context
, &keytab_string
[0], MAX_KEYTAB_NAME_LEN
- 2);
1086 DEBUG(10,("smb_krb5_open_keytab: krb5_kt_default_name returned %s\n", keytab_string
));
1088 tmp
= talloc_strdup(mem_ctx
, keytab_string
);
1094 if (strncmp(tmp
, "ANY:", 4) == 0) {
1098 memset(&keytab_string
, '\0', sizeof(keytab_string
));
1100 while (next_token_talloc(mem_ctx
, &tmp
, &kt_str
, ",")) {
1101 if (strncmp(kt_str
, "WRFILE:", 7) == 0) {
1102 found_valid_name
= true;
1107 if (strncmp(kt_str
, "FILE:", 5) == 0) {
1108 found_valid_name
= true;
1113 if (tmp
[0] == '/') {
1114 /* Treat as a FILE: keytab definition. */
1115 found_valid_name
= true;
1118 if (found_valid_name
) {
1119 if (tmp
[0] != '/') {
1120 ret
= KRB5_KT_BADNAME
;
1124 tmp
= talloc_asprintf(mem_ctx
, "%s:%s", pragma
, tmp
);
1133 if (!found_valid_name
) {
1134 ret
= KRB5_KT_UNKNOWN_TYPE
;
1139 DEBUG(10,("smb_krb5_open_keytab: resolving: %s\n", tmp
));
1140 ret
= krb5_kt_resolve(context
, tmp
, keytab
);
1143 TALLOC_FREE(mem_ctx
);
1148 * @brief Open a key table readonly or with readwrite access.
1150 * Allows to use a different keytab than the default one. The path needs to be
1151 * an absolute path or an error will be returned.
1153 * @param[in] context The library context
1155 * @param[in] keytab_name_req The path to the key table.
1157 * @param[in] write_access Open with readwrite access.
1159 * @param[in] keytab A pointer o the opended key table.
1161 * The keytab pointer should be freed using krb5_kt_close().
1163 * @return 0 on success, a Kerberos error code otherwise.
1165 krb5_error_code
smb_krb5_kt_open(krb5_context context
,
1166 const char *keytab_name_req
,
1168 krb5_keytab
*keytab
)
1172 if (keytab_name_req
== NULL
) {
1173 return KRB5_KT_BADNAME
;
1176 if (keytab_name_req
[0] == '/') {
1180 cmp
= strncmp(keytab_name_req
, "FILE:/", 6);
1185 cmp
= strncmp(keytab_name_req
, "WRFILE:/", 8);
1190 return KRB5_KT_BADNAME
;
1193 return smb_krb5_kt_open_relative(context
,
1200 * @brief Get a key table name.
1202 * @param[in] mem_ctx The talloc context to use for allocation.
1204 * @param[in] context The library context.
1206 * @param[in] keytab The key table to get the name from.
1208 * @param[in] keytab_name A talloc'ed string of the key table name.
1210 * The talloc'ed name string needs to be freed with talloc_free().
1212 * @return 0 on success, a Kerberos error code otherwise.
1214 krb5_error_code
smb_krb5_kt_get_name(TALLOC_CTX
*mem_ctx
,
1215 krb5_context context
,
1217 const char **keytab_name
)
1219 char keytab_string
[MAX_KEYTAB_NAME_LEN
];
1220 krb5_error_code ret
= 0;
1222 ret
= krb5_kt_get_name(context
, keytab
,
1223 keytab_string
, MAX_KEYTAB_NAME_LEN
- 2);
1228 *keytab_name
= talloc_strdup(mem_ctx
, keytab_string
);
1229 if (!*keytab_name
) {
1237 * @brief Seek and delete old entries in a keytab based on the passed
1240 * @param[in] context The KRB5 context to use.
1242 * @param[in] keytab The keytab to operate on.
1244 * @param[in] kvno The kvnco to use.
1246 * @param[in] princ_s The principal as a string to search for.
1248 * @param[in] princ The principal as a krb5_principal to search for.
1250 * @param[in] flush Weather to flush the complete keytab.
1252 * @param[in] keep_old_entries Keep the entry with the previous kvno.
1254 * @retval 0 on Sucess
1256 * @return An appropriate KRB5 error code.
1258 krb5_error_code
smb_krb5_kt_seek_and_delete_old_entries(krb5_context context
,
1261 krb5_enctype enctype
,
1262 const char *princ_s
,
1263 krb5_principal princ
,
1265 bool keep_old_entries
)
1267 krb5_error_code ret
;
1268 krb5_kt_cursor cursor
;
1269 krb5_keytab_entry kt_entry
;
1270 char *ktprinc
= NULL
;
1271 krb5_kvno old_kvno
= kvno
- 1;
1272 TALLOC_CTX
*tmp_ctx
;
1274 ZERO_STRUCT(cursor
);
1275 ZERO_STRUCT(kt_entry
);
1277 ret
= krb5_kt_start_seq_get(context
, keytab
, &cursor
);
1278 if (ret
== KRB5_KT_END
|| ret
== ENOENT
) {
1283 tmp_ctx
= talloc_new(NULL
);
1284 if (tmp_ctx
== NULL
) {
1288 DEBUG(3, (__location__
": Will try to delete old keytab entries\n"));
1289 while (!krb5_kt_next_entry(context
, keytab
, &kt_entry
, &cursor
)) {
1290 bool name_ok
= false;
1291 krb5_enctype kt_entry_enctype
=
1292 smb_krb5_kt_get_enctype_from_entry(&kt_entry
);
1294 if (!flush
&& (princ_s
!= NULL
)) {
1295 ret
= smb_krb5_unparse_name(tmp_ctx
, context
,
1299 DEBUG(1, (__location__
1300 ": smb_krb5_unparse_name failed "
1301 "(%s)\n", error_message(ret
)));
1305 #ifdef HAVE_KRB5_KT_COMPARE
1306 name_ok
= krb5_kt_compare(context
, &kt_entry
,
1309 name_ok
= (strcmp(ktprinc
, princ_s
) == 0);
1313 DEBUG(10, (__location__
": ignoring keytab "
1314 "entry principal %s, kvno = %d\n",
1315 ktprinc
, kt_entry
.vno
));
1318 * just free this entry and continue. */
1319 ret
= smb_krb5_kt_free_entry(context
,
1321 ZERO_STRUCT(kt_entry
);
1323 DEBUG(1, (__location__
1324 ": smb_krb5_kt_free_entry "
1326 error_message(ret
)));
1330 TALLOC_FREE(ktprinc
);
1334 TALLOC_FREE(ktprinc
);
1337 /*------------------------------------------------------------
1338 * Save the entries with kvno - 1. This is what microsoft does
1339 * to allow people with existing sessions that have kvno - 1
1340 * to still work. Otherwise, when the password for the machine
1341 * changes, all kerberizied sessions will 'break' until either
1342 * the client reboots or the client's session key expires and
1343 * they get a new session ticket with the new kvno.
1344 * Some keytab files only store the kvno in 8bits, limit
1345 * the compare accordingly.
1348 if (!flush
&& ((kt_entry
.vno
& 0xff) == (old_kvno
& 0xff))) {
1349 DEBUG(5, (__location__
": Saving previous (kvno %d) "
1350 "entry for principal: %s.\n",
1351 old_kvno
, princ_s
));
1355 if (keep_old_entries
) {
1356 DEBUG(5, (__location__
": Saving old (kvno %d) "
1357 "entry for principal: %s.\n",
1363 (kt_entry
.vno
== kvno
) &&
1364 (kt_entry_enctype
!= enctype
))
1366 DEBUG(5, (__location__
": Saving entry with kvno [%d] "
1367 "enctype [%d] for principal: %s.\n",
1368 kvno
, kt_entry_enctype
, princ_s
));
1372 DEBUG(5, (__location__
": Found old entry for principal: %s "
1373 "(kvno %d) - trying to remove it.\n",
1374 princ_s
, kt_entry
.vno
));
1376 ret
= krb5_kt_end_seq_get(context
, keytab
, &cursor
);
1377 ZERO_STRUCT(cursor
);
1379 DEBUG(1, (__location__
": krb5_kt_end_seq_get() "
1380 "failed (%s)\n", error_message(ret
)));
1383 ret
= krb5_kt_remove_entry(context
, keytab
, &kt_entry
);
1385 DEBUG(1, (__location__
": krb5_kt_remove_entry() "
1386 "failed (%s)\n", error_message(ret
)));
1390 DEBUG(5, (__location__
": removed old entry for principal: "
1391 "%s (kvno %d).\n", princ_s
, kt_entry
.vno
));
1393 ret
= krb5_kt_start_seq_get(context
, keytab
, &cursor
);
1395 DEBUG(1, (__location__
": krb5_kt_start_seq() failed "
1396 "(%s)\n", error_message(ret
)));
1399 ret
= smb_krb5_kt_free_entry(context
, &kt_entry
);
1400 ZERO_STRUCT(kt_entry
);
1402 DEBUG(1, (__location__
": krb5_kt_remove_entry() "
1403 "failed (%s)\n", error_message(ret
)));
1409 talloc_free(tmp_ctx
);
1410 if (!all_zero((uint8_t *)&kt_entry
, sizeof(kt_entry
))) {
1411 smb_krb5_kt_free_entry(context
, &kt_entry
);
1413 if (!all_zero((uint8_t *)&cursor
, sizeof(cursor
))) {
1414 krb5_kt_end_seq_get(context
, keytab
, &cursor
);
1420 * @brief Add a keytab entry for the given principal
1422 * @param[in] context The krb5 context to use.
1424 * @param[in] keytab The keytab to add the entry to.
1426 * @param[in] kvno The kvno to use.
1428 * @param[in] princ_s The principal as a string.
1430 * @param[in] salt_principal The salt principal to salt the password with.
1431 * Only needed for keys which support salting.
1432 * If no salt is used set no_salt to false and
1435 * @param[in] enctype The encryption type of the keytab entry.
1437 * @param[in] password The password of the keytab entry.
1439 * @param[in] no_salt If the password should not be salted. Normally
1440 * this is only set to false for encryption types
1441 * which do not support salting like RC4.
1443 * @param[in] keep_old_entries Wether to keep or delte old keytab entries.
1445 * @retval 0 on Success
1447 * @return A corresponding KRB5 error code.
1449 * @see smb_krb5_kt_open()
1451 krb5_error_code
smb_krb5_kt_add_entry(krb5_context context
,
1454 const char *princ_s
,
1455 const char *salt_principal
,
1456 krb5_enctype enctype
,
1457 krb5_data
*password
,
1459 bool keep_old_entries
)
1461 krb5_error_code ret
;
1462 krb5_keytab_entry kt_entry
;
1463 krb5_principal princ
= NULL
;
1464 krb5_keyblock
*keyp
;
1466 ZERO_STRUCT(kt_entry
);
1468 ret
= smb_krb5_parse_name(context
, princ_s
, &princ
);
1470 DEBUG(1, (__location__
": smb_krb5_parse_name(%s) "
1471 "failed (%s)\n", princ_s
, error_message(ret
)));
1475 /* Seek and delete old keytab entries */
1476 ret
= smb_krb5_kt_seek_and_delete_old_entries(context
,
1488 /* If we get here, we have deleted all the old entries with kvno's
1489 * not equal to the current kvno-1. */
1491 keyp
= KRB5_KT_KEY(&kt_entry
);
1494 KRB5_KEY_DATA(keyp
) = (KRB5_KEY_DATA_CAST
*)SMB_MALLOC(password
->length
);
1495 if (KRB5_KEY_DATA(keyp
) == NULL
) {
1499 memcpy(KRB5_KEY_DATA(keyp
), password
->data
, password
->length
);
1500 KRB5_KEY_LENGTH(keyp
) = password
->length
;
1501 KRB5_KEY_TYPE(keyp
) = enctype
;
1503 krb5_principal salt_princ
= NULL
;
1505 /* Now add keytab entries for all encryption types */
1506 ret
= smb_krb5_parse_name(context
, salt_principal
, &salt_princ
);
1508 DBG_WARNING("krb5_parse_name(%s) failed (%s)\n",
1509 salt_principal
, error_message(ret
));
1513 ret
= smb_krb5_create_key_from_string(context
,
1519 krb5_free_principal(context
, salt_princ
);
1525 kt_entry
.principal
= princ
;
1526 kt_entry
.vno
= kvno
;
1528 DEBUG(3, (__location__
": adding keytab entry for (%s) with "
1529 "encryption type (%d) and version (%d)\n",
1530 princ_s
, enctype
, kt_entry
.vno
));
1531 ret
= krb5_kt_add_entry(context
, keytab
, &kt_entry
);
1532 krb5_free_keyblock_contents(context
, keyp
);
1533 ZERO_STRUCT(kt_entry
);
1535 DEBUG(1, (__location__
": adding entry to keytab "
1536 "failed (%s)\n", error_message(ret
)));
1542 krb5_free_principal(context
, princ
);
1548 #if defined(HAVE_KRB5_GET_CREDS_OPT_SET_IMPERSONATE) && \
1549 defined(HAVE_KRB5_GET_CREDS_OPT_ALLOC) && \
1550 defined(HAVE_KRB5_GET_CREDS)
1551 static krb5_error_code
smb_krb5_get_credentials_for_user_opt(krb5_context context
,
1554 krb5_principal server
,
1555 krb5_principal impersonate_princ
,
1556 krb5_creds
**out_creds
)
1558 krb5_error_code ret
;
1559 krb5_get_creds_opt opt
;
1561 ret
= krb5_get_creds_opt_alloc(context
, &opt
);
1565 krb5_get_creds_opt_add_options(context
, opt
, KRB5_GC_FORWARDABLE
);
1567 if (impersonate_princ
) {
1568 ret
= krb5_get_creds_opt_set_impersonate(context
, opt
,
1575 ret
= krb5_get_creds(context
, opt
, ccache
, server
, out_creds
);
1582 krb5_get_creds_opt_free(context
, opt
);
1586 #endif /* HAVE_KRB5_GET_CREDS_OPT_SET_IMPERSONATE */
1588 #ifdef HAVE_KRB5_GET_CREDENTIALS_FOR_USER
1590 #if !HAVE_DECL_KRB5_GET_CREDENTIALS_FOR_USER
1591 krb5_error_code KRB5_CALLCONV
1592 krb5_get_credentials_for_user(krb5_context context
, krb5_flags options
,
1593 krb5_ccache ccache
, krb5_creds
*in_creds
,
1594 krb5_data
*subject_cert
,
1595 krb5_creds
**out_creds
);
1596 #endif /* !HAVE_DECL_KRB5_GET_CREDENTIALS_FOR_USER */
1598 static krb5_error_code
smb_krb5_get_credentials_for_user(krb5_context context
,
1601 krb5_principal server
,
1602 krb5_principal impersonate_princ
,
1603 krb5_creds
**out_creds
)
1605 krb5_error_code ret
;
1606 krb5_creds in_creds
;
1608 ZERO_STRUCT(in_creds
);
1610 if (impersonate_princ
) {
1612 in_creds
.server
= me
;
1613 in_creds
.client
= impersonate_princ
;
1615 ret
= krb5_get_credentials_for_user(context
,
1616 0, /* krb5_flags options */
1619 NULL
, /* krb5_data *subject_cert */
1622 in_creds
.client
= me
;
1623 in_creds
.server
= server
;
1625 ret
= krb5_get_credentials(context
, 0, ccache
,
1626 &in_creds
, out_creds
);
1631 #endif /* HAVE_KRB5_GET_CREDENTIALS_FOR_USER */
1634 * smb_krb5_get_credentials
1636 * @brief Get krb5 credentials for a server
1638 * @param[in] context An initialized krb5_context
1639 * @param[in] ccache An initialized krb5_ccache
1640 * @param[in] me The krb5_principal of the caller
1641 * @param[in] server The krb5_principal of the requested service
1642 * @param[in] impersonate_princ The krb5_principal of a user to impersonate as (optional)
1643 * @param[out] out_creds The returned krb5_creds structure
1644 * @return krb5_error_code
1647 krb5_error_code
smb_krb5_get_credentials(krb5_context context
,
1650 krb5_principal server
,
1651 krb5_principal impersonate_princ
,
1652 krb5_creds
**out_creds
)
1654 krb5_error_code ret
;
1655 krb5_creds
*creds
= NULL
;
1657 if (out_creds
!= NULL
) {
1661 if (impersonate_princ
) {
1662 #ifdef HAVE_KRB5_GET_CREDS_OPT_SET_IMPERSONATE /* Heimdal */
1663 ret
= smb_krb5_get_credentials_for_user_opt(context
, ccache
, me
, server
, impersonate_princ
, &creds
);
1664 #elif defined(HAVE_KRB5_GET_CREDENTIALS_FOR_USER) /* MIT */
1665 ret
= smb_krb5_get_credentials_for_user(context
, ccache
, me
, server
, impersonate_princ
, &creds
);
1670 krb5_creds in_creds
;
1672 ZERO_STRUCT(in_creds
);
1674 in_creds
.client
= me
;
1675 in_creds
.server
= server
;
1677 ret
= krb5_get_credentials(context
, 0, ccache
,
1690 krb5_free_creds(context
, creds
);
1697 * @brief Initialize a krb5_keyblock with the given data.
1699 * Initialized a new keyblock, allocates the contents fo the key and
1700 * copies the data into the keyblock.
1702 * @param[in] context The library context
1704 * @param[in] enctype The encryption type.
1706 * @param[in] data The date to initialize the keyblock with.
1708 * @param[in] length The length of the keyblock.
1710 * @param[in] key Newly allocated keyblock structure.
1712 * The key date must be freed using krb5_free_keyblock_contents() when it is
1715 * @return 0 on success, a Kerberos error code otherwise.
1717 krb5_error_code
smb_krb5_keyblock_init_contents(krb5_context context
,
1718 krb5_enctype enctype
,
1723 #if defined(HAVE_KRB5_KEYBLOCK_INIT)
1724 return krb5_keyblock_init(context
, enctype
, data
, length
, key
);
1726 memset(key
, 0, sizeof(krb5_keyblock
));
1727 KRB5_KEY_DATA(key
) = SMB_MALLOC(length
);
1728 if (NULL
== KRB5_KEY_DATA(key
)) {
1731 memcpy(KRB5_KEY_DATA(key
), data
, length
);
1732 KRB5_KEY_LENGTH(key
) = length
;
1733 KRB5_KEY_TYPE(key
) = enctype
;
1739 * @brief Simulate a kinit by putting the tgt in the given credential cache.
1741 * This function uses a keyblock rather than needingthe original password.
1743 * @param[in] ctx The library context
1745 * @param[in] cc The credential cache to put the tgt in.
1747 * @param[in] principal The client princial
1749 * @param[in] keyblock The keyblock to use.
1751 * @param[in] target_service The service name of the initial credentials (or NULL).
1753 * @param[in] krb_options Initial credential options.
1755 * @param[in] expire_time A pointer to store the experation time of the
1756 * credentials (or NULL).
1758 * @param[in] kdc_time A pointer to store the time when the ticket becomes
1761 * @return 0 on success, a Kerberos error code otherwise.
1763 krb5_error_code
smb_krb5_kinit_keyblock_ccache(krb5_context ctx
,
1765 krb5_principal principal
,
1766 krb5_keyblock
*keyblock
,
1767 const char *target_service
,
1768 krb5_get_init_creds_opt
*krb_options
,
1769 time_t *expire_time
,
1772 krb5_error_code code
= 0;
1773 krb5_creds my_creds
;
1775 #if defined(HAVE_KRB5_GET_INIT_CREDS_KEYBLOCK)
1776 code
= krb5_get_init_creds_keyblock(ctx
, &my_creds
, principal
,
1777 keyblock
, 0, target_service
,
1779 #elif defined(HAVE_KRB5_GET_INIT_CREDS_KEYTAB)
1781 #define SMB_CREDS_KEYTAB "MEMORY:tmp_smb_creds_XXXXXX"
1782 char tmp_name
[sizeof(SMB_CREDS_KEYTAB
)];
1783 krb5_keytab_entry entry
;
1787 memset(&entry
, 0, sizeof(entry
));
1788 entry
.principal
= principal
;
1789 *(KRB5_KT_KEY(&entry
)) = *keyblock
;
1791 memcpy(tmp_name
, SMB_CREDS_KEYTAB
, sizeof(SMB_CREDS_KEYTAB
));
1792 mask
= umask(S_IRWXO
| S_IRWXG
);
1795 if (tmp_name
[0] == 0) {
1796 return KRB5_KT_BADNAME
;
1798 code
= krb5_kt_resolve(ctx
, tmp_name
, &keytab
);
1803 code
= krb5_kt_add_entry(ctx
, keytab
, &entry
);
1805 (void)krb5_kt_close(ctx
, keytab
);
1809 code
= krb5_get_init_creds_keytab(ctx
, &my_creds
, principal
,
1810 keytab
, 0, target_service
,
1812 (void)krb5_kt_close(ctx
, keytab
);
1815 #error krb5_get_init_creds_keyblock not available!
1821 #ifndef SAMBA4_USES_HEIMDAL /* MIT */
1823 * We need to store the principal as returned from the KDC to the
1824 * credentials cache. If we don't do that the KRB5 library is not
1825 * able to find the tickets it is looking for
1827 principal
= my_creds
.client
;
1829 code
= krb5_cc_initialize(ctx
, cc
, principal
);
1834 code
= krb5_cc_store_cred(ctx
, cc
, &my_creds
);
1840 *expire_time
= (time_t) my_creds
.times
.endtime
;
1844 *kdc_time
= (time_t) my_creds
.times
.starttime
;
1849 krb5_free_cred_contents(ctx
, &my_creds
);
1854 * @brief Simulate a kinit by putting the tgt in the given credential cache.
1856 * @param[in] ctx The library context
1858 * @param[in] cc The credential cache to put the tgt in.
1860 * @param[in] principal The client princial
1862 * @param[in] password The password (or NULL).
1864 * @param[in] target_service The service name of the initial credentials (or NULL).
1866 * @param[in] krb_options Initial credential options.
1868 * @param[in] expire_time A pointer to store the experation time of the
1869 * credentials (or NULL).
1871 * @param[in] kdc_time A pointer to store the time when the ticket becomes
1874 * @return 0 on success, a Kerberos error code otherwise.
1876 krb5_error_code
smb_krb5_kinit_password_ccache(krb5_context ctx
,
1878 krb5_principal principal
,
1879 const char *password
,
1880 const char *target_service
,
1881 krb5_get_init_creds_opt
*krb_options
,
1882 time_t *expire_time
,
1885 krb5_error_code code
= 0;
1886 krb5_creds my_creds
;
1888 code
= krb5_get_init_creds_password(ctx
, &my_creds
, principal
,
1889 password
, NULL
, NULL
, 0,
1890 target_service
, krb_options
);
1895 #ifndef SAMBA4_USES_HEIMDAL /* MIT */
1897 * We need to store the principal as returned from the KDC to the
1898 * credentials cache. If we don't do that the KRB5 library is not
1899 * able to find the tickets it is looking for
1901 principal
= my_creds
.client
;
1903 code
= krb5_cc_initialize(ctx
, cc
, principal
);
1908 code
= krb5_cc_store_cred(ctx
, cc
, &my_creds
);
1914 *expire_time
= (time_t) my_creds
.times
.endtime
;
1918 *kdc_time
= (time_t) my_creds
.times
.starttime
;
1923 krb5_free_cred_contents(ctx
, &my_creds
);
1927 #ifdef SAMBA4_USES_HEIMDAL
1929 * @brief Simulate a kinit by putting the tgt in the given credential cache.
1931 * @param[in] ctx The library context
1933 * @param[in] cc The credential cache to store the tgt in.
1935 * @param[in] principal The initial client princial.
1937 * @param[in] password The password (or NULL).
1939 * @param[in] impersonate_principal The impersonatiion principal (or NULL).
1941 * @param[in] self_service The local service for S4U2Self if
1942 * impersonate_principal is specified).
1944 * @param[in] target_service The service name of the initial credentials
1945 * (kpasswd/REALM or a remote service). It defaults
1946 * to the krbtgt if NULL.
1948 * @param[in] krb_options Initial credential options.
1950 * @param[in] expire_time A pointer to store the experation time of the
1951 * credentials (or NULL).
1953 * @param[in] kdc_time A pointer to store the time when the ticket becomes
1956 * @return 0 on success, a Kerberos error code otherwise.
1958 krb5_error_code
smb_krb5_kinit_s4u2_ccache(krb5_context ctx
,
1959 krb5_ccache store_cc
,
1960 krb5_principal init_principal
,
1961 const char *init_password
,
1962 krb5_principal impersonate_principal
,
1963 const char *self_service
,
1964 const char *target_service
,
1965 krb5_get_init_creds_opt
*krb_options
,
1966 time_t *expire_time
,
1969 krb5_error_code code
= 0;
1970 krb5_get_creds_opt options
;
1971 krb5_principal store_principal
;
1972 krb5_creds store_creds
;
1973 krb5_creds
*s4u2self_creds
;
1974 Ticket s4u2self_ticket
;
1975 size_t s4u2self_ticketlen
;
1976 krb5_creds
*s4u2proxy_creds
;
1977 krb5_principal self_princ
;
1979 krb5_principal target_princ
;
1981 const char *self_realm
;
1982 const char *client_realm
= NULL
;
1983 krb5_principal blacklist_principal
= NULL
;
1984 krb5_principal whitelist_principal
= NULL
;
1986 code
= krb5_get_init_creds_password(ctx
, &store_creds
,
1997 store_principal
= init_principal
;
2000 * We are trying S4U2Self now:
2002 * As we do not want to expose our TGT in the
2003 * krb5_ccache, which is also holds the impersonated creds.
2005 * Some low level krb5/gssapi function might use the TGT
2006 * identity and let the client act as our machine account.
2008 * We need to avoid that and use a temporary krb5_ccache
2009 * in order to pass our TGT to the krb5_get_creds() function.
2011 code
= krb5_cc_new_unique(ctx
, NULL
, NULL
, &tmp_cc
);
2013 krb5_free_cred_contents(ctx
, &store_creds
);
2017 code
= krb5_cc_initialize(ctx
, tmp_cc
, store_creds
.client
);
2019 krb5_cc_destroy(ctx
, tmp_cc
);
2020 krb5_free_cred_contents(ctx
, &store_creds
);
2024 code
= krb5_cc_store_cred(ctx
, tmp_cc
, &store_creds
);
2026 krb5_free_cred_contents(ctx
, &store_creds
);
2027 krb5_cc_destroy(ctx
, tmp_cc
);
2032 * we need to remember the client principal of our
2033 * TGT and make sure the KDC does not return this
2034 * in the impersonated tickets. This can happen
2035 * if the KDC does not support S4U2Self and S4U2Proxy.
2037 blacklist_principal
= store_creds
.client
;
2038 store_creds
.client
= NULL
;
2039 krb5_free_cred_contents(ctx
, &store_creds
);
2042 * Check if we also need S4U2Proxy or if S4U2Self is
2043 * enough in order to get a ticket for the target.
2045 if (target_service
== NULL
) {
2047 } else if (strcmp(target_service
, self_service
) == 0) {
2054 * For S4U2Self we need our own service principal,
2055 * which belongs to our own realm (available on
2056 * our client principal).
2058 self_realm
= krb5_principal_get_realm(ctx
, init_principal
);
2060 code
= krb5_parse_name(ctx
, self_service
, &self_princ
);
2062 krb5_free_principal(ctx
, blacklist_principal
);
2063 krb5_cc_destroy(ctx
, tmp_cc
);
2067 code
= krb5_principal_set_realm(ctx
, self_princ
, self_realm
);
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_opt_alloc(ctx
, &options
);
2077 krb5_free_principal(ctx
, blacklist_principal
);
2078 krb5_free_principal(ctx
, self_princ
);
2079 krb5_cc_destroy(ctx
, tmp_cc
);
2085 * If we want S4U2Proxy, we need the forwardable flag
2086 * on the S4U2Self ticket.
2088 krb5_get_creds_opt_set_options(ctx
, options
, KRB5_GC_FORWARDABLE
);
2091 code
= krb5_get_creds_opt_set_impersonate(ctx
, options
,
2092 impersonate_principal
);
2094 krb5_get_creds_opt_free(ctx
, options
);
2095 krb5_free_principal(ctx
, blacklist_principal
);
2096 krb5_free_principal(ctx
, self_princ
);
2097 krb5_cc_destroy(ctx
, tmp_cc
);
2101 code
= krb5_get_creds(ctx
, options
, tmp_cc
,
2102 self_princ
, &s4u2self_creds
);
2103 krb5_get_creds_opt_free(ctx
, options
);
2104 krb5_free_principal(ctx
, self_princ
);
2106 krb5_free_principal(ctx
, blacklist_principal
);
2107 krb5_cc_destroy(ctx
, tmp_cc
);
2112 krb5_cc_destroy(ctx
, tmp_cc
);
2115 * Now make sure we store the impersonated principal
2116 * and creds instead of the TGT related stuff
2117 * in the krb5_ccache of the caller.
2119 code
= krb5_copy_creds_contents(ctx
, s4u2self_creds
,
2121 krb5_free_creds(ctx
, s4u2self_creds
);
2127 * It's important to store the principal the KDC
2128 * returned, as otherwise the caller would not find
2129 * the S4U2Self ticket in the krb5_ccache lookup.
2131 store_principal
= store_creds
.client
;
2136 * We are trying S4U2Proxy:
2138 * We need the ticket from the S4U2Self step
2139 * and our TGT in order to get the delegated ticket.
2141 code
= decode_Ticket((const uint8_t *)s4u2self_creds
->ticket
.data
,
2142 s4u2self_creds
->ticket
.length
,
2144 &s4u2self_ticketlen
);
2146 krb5_free_creds(ctx
, s4u2self_creds
);
2147 krb5_free_principal(ctx
, blacklist_principal
);
2148 krb5_cc_destroy(ctx
, tmp_cc
);
2153 * we need to remember the client principal of the
2154 * S4U2Self stage and as it needs to match the one we
2155 * will get for the S4U2Proxy stage. We need this
2156 * in order to detect KDCs which does not support S4U2Proxy.
2158 whitelist_principal
= s4u2self_creds
->client
;
2159 s4u2self_creds
->client
= NULL
;
2160 krb5_free_creds(ctx
, s4u2self_creds
);
2163 * For S4U2Proxy we also got a target service principal,
2164 * which also belongs to our own realm (available on
2165 * our client principal).
2167 code
= krb5_parse_name(ctx
, target_service
, &target_princ
);
2169 free_Ticket(&s4u2self_ticket
);
2170 krb5_free_principal(ctx
, whitelist_principal
);
2171 krb5_free_principal(ctx
, blacklist_principal
);
2172 krb5_cc_destroy(ctx
, tmp_cc
);
2176 code
= krb5_principal_set_realm(ctx
, target_princ
, self_realm
);
2178 free_Ticket(&s4u2self_ticket
);
2179 krb5_free_principal(ctx
, target_princ
);
2180 krb5_free_principal(ctx
, whitelist_principal
);
2181 krb5_free_principal(ctx
, blacklist_principal
);
2182 krb5_cc_destroy(ctx
, tmp_cc
);
2186 code
= krb5_get_creds_opt_alloc(ctx
, &options
);
2188 free_Ticket(&s4u2self_ticket
);
2189 krb5_free_principal(ctx
, target_princ
);
2190 krb5_free_principal(ctx
, whitelist_principal
);
2191 krb5_free_principal(ctx
, blacklist_principal
);
2192 krb5_cc_destroy(ctx
, tmp_cc
);
2196 krb5_get_creds_opt_set_options(ctx
, options
, KRB5_GC_FORWARDABLE
);
2197 krb5_get_creds_opt_set_options(ctx
, options
, KRB5_GC_CONSTRAINED_DELEGATION
);
2199 code
= krb5_get_creds_opt_set_ticket(ctx
, options
, &s4u2self_ticket
);
2200 free_Ticket(&s4u2self_ticket
);
2202 krb5_get_creds_opt_free(ctx
, options
);
2203 krb5_free_principal(ctx
, target_princ
);
2204 krb5_free_principal(ctx
, whitelist_principal
);
2205 krb5_free_principal(ctx
, blacklist_principal
);
2206 krb5_cc_destroy(ctx
, tmp_cc
);
2210 code
= krb5_get_creds(ctx
, options
, tmp_cc
,
2211 target_princ
, &s4u2proxy_creds
);
2212 krb5_get_creds_opt_free(ctx
, options
);
2213 krb5_free_principal(ctx
, target_princ
);
2214 krb5_cc_destroy(ctx
, tmp_cc
);
2216 krb5_free_principal(ctx
, whitelist_principal
);
2217 krb5_free_principal(ctx
, blacklist_principal
);
2222 * Now make sure we store the impersonated principal
2223 * and creds instead of the TGT related stuff
2224 * in the krb5_ccache of the caller.
2226 code
= krb5_copy_creds_contents(ctx
, s4u2proxy_creds
,
2228 krb5_free_creds(ctx
, s4u2proxy_creds
);
2230 krb5_free_principal(ctx
, whitelist_principal
);
2231 krb5_free_principal(ctx
, blacklist_principal
);
2236 * It's important to store the principal the KDC
2237 * returned, as otherwise the caller would not find
2238 * the S4U2Self ticket in the krb5_ccache lookup.
2240 store_principal
= store_creds
.client
;
2243 if (blacklist_principal
&&
2244 krb5_principal_compare(ctx
, store_creds
.client
, blacklist_principal
)) {
2248 code
= krb5_unparse_name(ctx
, blacklist_principal
, &sp
);
2252 code
= krb5_unparse_name(ctx
, impersonate_principal
, &ip
);
2256 DEBUG(1, ("smb_krb5_kinit_password_cache: "
2257 "KDC returned self principal[%s] while impersonating [%s]\n",
2258 sp
?sp
:"<no memory>",
2259 ip
?ip
:"<no memory>"));
2264 krb5_free_principal(ctx
, whitelist_principal
);
2265 krb5_free_principal(ctx
, blacklist_principal
);
2266 krb5_free_cred_contents(ctx
, &store_creds
);
2267 return KRB5_FWD_BAD_PRINCIPAL
;
2269 if (blacklist_principal
) {
2270 krb5_free_principal(ctx
, blacklist_principal
);
2273 if (whitelist_principal
&&
2274 !krb5_principal_compare(ctx
, store_creds
.client
, whitelist_principal
)) {
2278 code
= krb5_unparse_name(ctx
, store_creds
.client
, &sp
);
2282 code
= krb5_unparse_name(ctx
, whitelist_principal
, &ep
);
2286 DEBUG(1, ("smb_krb5_kinit_password_cache: "
2287 "KDC returned wrong principal[%s] we expected [%s]\n",
2288 sp
?sp
:"<no memory>",
2289 ep
?ep
:"<no memory>"));
2294 krb5_free_principal(ctx
, whitelist_principal
);
2295 krb5_free_cred_contents(ctx
, &store_creds
);
2296 return KRB5_FWD_BAD_PRINCIPAL
;
2298 if (whitelist_principal
) {
2299 krb5_free_principal(ctx
, whitelist_principal
);
2302 code
= krb5_cc_initialize(ctx
, store_cc
, store_principal
);
2304 krb5_free_cred_contents(ctx
, &store_creds
);
2308 code
= krb5_cc_store_cred(ctx
, store_cc
, &store_creds
);
2310 krb5_free_cred_contents(ctx
, &store_creds
);
2314 client_realm
= krb5_principal_get_realm(ctx
, store_creds
.client
);
2315 if (client_realm
!= NULL
) {
2317 * Because the CANON flag doesn't have any impact
2318 * on the impersonate_principal => store_creds.client
2319 * realm mapping. We need to store the credentials twice,
2320 * once with the returned realm and once with the
2321 * realm of impersonate_principal.
2323 code
= krb5_principal_set_realm(ctx
, store_creds
.server
,
2326 krb5_free_cred_contents(ctx
, &store_creds
);
2330 code
= krb5_cc_store_cred(ctx
, store_cc
, &store_creds
);
2332 krb5_free_cred_contents(ctx
, &store_creds
);
2338 *expire_time
= (time_t) store_creds
.times
.endtime
;
2342 *kdc_time
= (time_t) store_creds
.times
.starttime
;
2345 krb5_free_cred_contents(ctx
, &store_creds
);
2351 #if !defined(HAVE_KRB5_MAKE_PRINCIPAL) && defined(HAVE_KRB5_BUILD_PRINCIPAL_ALLOC_VA)
2353 * @brief Create a principal name using a variable argument list.
2355 * @param[in] context The library context.
2357 * @param[inout] principal A pointer to the principal structure.
2359 * @param[in] _realm The realm to use. If NULL then the function will
2360 * get the default realm name.
2362 * @param[in] ... A list of 'char *' components, ending with NULL.
2364 * Use krb5_free_principal() to free the principal when it is no longer needed.
2366 * @return 0 on success, a Kerberos error code otherwise.
2368 krb5_error_code
smb_krb5_make_principal(krb5_context context
,
2369 krb5_principal
*principal
,
2370 const char *_realm
, ...)
2372 krb5_error_code code
;
2378 realm
= discard_const_p(char, _realm
);
2381 code
= krb5_get_default_realm(context
, &realm
);
2388 va_start(ap
, _realm
);
2389 code
= krb5_build_principal_alloc_va(context
, principal
,
2390 strlen(realm
), realm
,
2395 krb5_free_default_realm(context
, realm
);
2402 #if !defined(HAVE_KRB5_CC_GET_LIFETIME) && defined(HAVE_KRB5_CC_RETRIEVE_CRED)
2404 * @brief Get the lifetime of the initial ticket in the cache.
2406 * @param[in] context The kerberos context.
2408 * @param[in] id The credential cache to get the ticket lifetime.
2410 * @param[out] t A pointer to a time value to store the lifetime.
2412 * @return 0 on success, a krb5_error_code on error.
2414 krb5_error_code
smb_krb5_cc_get_lifetime(krb5_context context
,
2418 krb5_cc_cursor cursor
;
2419 krb5_error_code kerr
;
2425 kerr
= krb5_timeofday(context
, &now
);
2430 kerr
= krb5_cc_start_seq_get(context
, id
, &cursor
);
2435 while ((kerr
= krb5_cc_next_cred(context
, id
, &cursor
, &cred
)) == 0) {
2436 #ifndef HAVE_FLAGS_IN_KRB5_CREDS
2437 if (cred
.ticket_flags
& TKT_FLG_INITIAL
) {
2439 if (cred
.flags
.b
.initial
) {
2441 if (now
< cred
.times
.endtime
) {
2442 *t
= (time_t) (cred
.times
.endtime
- now
);
2444 krb5_free_cred_contents(context
, &cred
);
2447 krb5_free_cred_contents(context
, &cred
);
2450 krb5_cc_end_seq_get(context
, id
, &cursor
);
2454 #endif /* HAVE_KRB5_CC_GET_LIFETIME */
2456 #if !defined(HAVE_KRB5_FREE_CHECKSUM_CONTENTS) && defined(HAVE_FREE_CHECKSUM)
2457 void smb_krb5_free_checksum_contents(krb5_context ctx
, krb5_checksum
*cksum
)
2459 free_Checksum(cksum
);
2464 * @brief Compute a checksum operating on a keyblock.
2466 * This function computes a checksum over a PAC using the keyblock for a keyed
2469 * @param[in] mem_ctx A talloc context to alocate the signature on.
2471 * @param[in] pac_data The PAC as input.
2473 * @param[in] context The library context.
2475 * @param[in] keyblock Encryption key for a keyed checksum.
2477 * @param[out] sig_type The checksum type
2479 * @param[out] sig_blob The talloc'ed checksum
2481 * The caller must free the sig_blob with talloc_free() when it is not needed
2484 * @return 0 on success, a Kerberos error code otherwise.
2486 krb5_error_code
smb_krb5_make_pac_checksum(TALLOC_CTX
*mem_ctx
,
2487 DATA_BLOB
*pac_data
,
2488 krb5_context context
,
2489 const krb5_keyblock
*keyblock
,
2491 DATA_BLOB
*sig_blob
)
2493 krb5_error_code ret
;
2494 krb5_checksum cksum
;
2495 #if defined(HAVE_KRB5_CRYPTO_INIT) && defined(HAVE_KRB5_CREATE_CHECKSUM)
2499 ret
= krb5_crypto_init(context
,
2504 DEBUG(0,("krb5_crypto_init() failed: %s\n",
2505 smb_get_krb5_error_message(context
, ret
, mem_ctx
)));
2508 ret
= krb5_create_checksum(context
,
2510 KRB5_KU_OTHER_CKSUM
,
2516 DEBUG(2, ("PAC Verification failed: %s\n",
2517 smb_get_krb5_error_message(context
, ret
, mem_ctx
)));
2520 krb5_crypto_destroy(context
, crypto
);
2526 *sig_type
= cksum
.cksumtype
;
2527 *sig_blob
= data_blob_talloc(mem_ctx
,
2528 cksum
.checksum
.data
,
2529 cksum
.checksum
.length
);
2530 #elif defined(HAVE_KRB5_C_MAKE_CHECKSUM)
2533 input
.data
= (char *)pac_data
->data
;
2534 input
.length
= pac_data
->length
;
2536 ret
= krb5_c_make_checksum(context
,
2539 KRB5_KEYUSAGE_APP_DATA_CKSUM
,
2543 DEBUG(2, ("PAC Verification failed: %s\n",
2544 smb_get_krb5_error_message(context
, ret
, mem_ctx
)));
2548 *sig_type
= cksum
.checksum_type
;
2549 *sig_blob
= data_blob_talloc(mem_ctx
,
2554 #error krb5_create_checksum or krb5_c_make_checksum not available
2555 #endif /* HAVE_KRB5_C_MAKE_CHECKSUM */
2556 smb_krb5_free_checksum_contents(context
, &cksum
);
2563 * @brief Get realm of a principal
2565 * @param[in] context The library context
2567 * @param[in] principal The principal to get the realm from.
2569 * @return An allocated string with the realm or NULL if an error occurred.
2571 * The caller must free the realm string with free() if not needed anymore.
2573 char *smb_krb5_principal_get_realm(krb5_context context
,
2574 krb5_const_principal principal
)
2576 #ifdef HAVE_KRB5_PRINCIPAL_GET_REALM /* Heimdal */
2577 return strdup(discard_const_p(char, krb5_principal_get_realm(context
, principal
)));
2578 #elif defined(krb5_princ_realm) /* MIT */
2580 realm
= discard_const_p(krb5_data
,
2581 krb5_princ_realm(context
, principal
));
2582 return strndup(realm
->data
, realm
->length
);
2584 #error UNKNOWN_GET_PRINC_REALM_FUNCTIONS
2589 * @brief Get realm of a principal
2591 * @param[in] context The library context
2593 * @param[in] principal The principal to set the realm
2595 * @param[in] realm The realm as a string to set.
2597 * @retur 0 on success, a Kerberos error code otherwise.
2599 krb5_error_code
smb_krb5_principal_set_realm(krb5_context context
,
2600 krb5_principal principal
,
2603 #ifdef HAVE_KRB5_PRINCIPAL_SET_REALM /* Heimdal */
2604 return krb5_principal_set_realm(context
, principal
, realm
);
2605 #elif defined(krb5_princ_realm) && defined(krb5_princ_set_realm) /* MIT */
2606 krb5_error_code ret
;
2608 krb5_data
*old_data
;
2610 old_data
= krb5_princ_realm(context
, principal
);
2612 ret
= smb_krb5_copy_data_contents(&data
,
2619 /* free realm before setting */
2620 free(old_data
->data
);
2622 krb5_princ_set_realm(context
, principal
, &data
);
2626 #error UNKNOWN_PRINC_SET_REALM_FUNCTION
2631 /************************************************************************
2632 Routine to get the default realm from the kerberos credentials cache.
2633 Caller must free if the return value is not NULL.
2634 ************************************************************************/
2636 static char *smb_krb5_get_default_realm_from_ccache(TALLOC_CTX
*mem_ctx
)
2639 krb5_context ctx
= NULL
;
2640 krb5_ccache cc
= NULL
;
2641 krb5_principal princ
= NULL
;
2643 initialize_krb5_error_table();
2644 if (krb5_init_context(&ctx
)) {
2648 DEBUG(5,("kerberos_get_default_realm_from_ccache: "
2649 "Trying to read krb5 cache: %s\n",
2650 krb5_cc_default_name(ctx
)));
2651 if (krb5_cc_default(ctx
, &cc
)) {
2652 DEBUG(5,("kerberos_get_default_realm_from_ccache: "
2653 "failed to read default cache\n"));
2656 if (krb5_cc_get_principal(ctx
, cc
, &princ
)) {
2657 DEBUG(5,("kerberos_get_default_realm_from_ccache: "
2658 "failed to get default principal\n"));
2662 #if defined(HAVE_KRB5_PRINCIPAL_GET_REALM)
2663 realm
= talloc_strdup(mem_ctx
, krb5_principal_get_realm(ctx
, princ
));
2664 #elif defined(HAVE_KRB5_PRINC_REALM)
2666 krb5_data
*realm_data
= krb5_princ_realm(ctx
, princ
);
2667 realm
= talloc_strndup(mem_ctx
, realm_data
->data
, realm_data
->length
);
2675 krb5_free_principal(ctx
, princ
);
2678 krb5_cc_close(ctx
, cc
);
2680 krb5_free_context(ctx
);
2686 /************************************************************************
2687 Routine to get the realm from a given DNS name.
2688 ************************************************************************/
2690 static char *smb_krb5_get_realm_from_hostname(TALLOC_CTX
*mem_ctx
,
2691 const char *hostname
)
2693 #if defined(HAVE_KRB5_REALM_TYPE)
2695 krb5_realm
*realm_list
= NULL
;
2698 char **realm_list
= NULL
;
2701 krb5_error_code kerr
;
2702 krb5_context ctx
= NULL
;
2704 initialize_krb5_error_table();
2705 if (krb5_init_context(&ctx
)) {
2709 kerr
= krb5_get_host_realm(ctx
, hostname
, &realm_list
);
2711 DEBUG(3,("kerberos_get_realm_from_hostname %s: "
2713 hostname
? hostname
: "(NULL)",
2714 error_message(kerr
) ));
2718 if (realm_list
&& realm_list
[0]) {
2719 realm
= talloc_strdup(mem_ctx
, realm_list
[0]);
2726 krb5_free_host_realm(ctx
, realm_list
);
2729 krb5_free_context(ctx
);
2736 * @brief Get the principal as a string from the service hostname.
2738 * @param[in] mem_ctx The talloc context
2740 * @param[in] service The service name
2742 * @param[in] remote_name The remote name
2744 * @param[in] default_realm The default_realm if we cannot get it from the
2745 * hostname or netbios name.
2747 * @return A talloc'ed principal string or NULL if an error occurred.
2749 * The caller needs to free the principal with talloc_free() if it isn't needed
2752 char *smb_krb5_get_principal_from_service_hostname(TALLOC_CTX
*mem_ctx
,
2753 const char *service
,
2754 const char *remote_name
,
2755 const char *default_realm
)
2760 host
= strchr_m(remote_name
, '.');
2763 realm
= smb_krb5_get_realm_from_hostname(talloc_tos(),
2766 /* NetBIOS name - use our realm. */
2767 realm
= smb_krb5_get_default_realm_from_ccache(talloc_tos());
2770 if (realm
== NULL
|| *realm
== '\0') {
2771 realm
= talloc_strdup(talloc_tos(), default_realm
);
2775 DEBUG(3,("Cannot get realm from, "
2776 "desthost %s or default ccache. Using default "
2777 "smb.conf realm %s\n",
2782 principal
= talloc_asprintf(mem_ctx
,
2784 service
, remote_name
,
2791 * @brief Get an error string from a Kerberos error code.
2793 * @param[in] context The library context.
2795 * @param[in] code The Kerberos error code.
2797 * @param[in] mem_ctx The talloc context to allocate the error string on.
2799 * @return A talloc'ed error string or NULL if an error occurred.
2801 * The caller must free the returned error string with talloc_free() if not
2804 char *smb_get_krb5_error_message(krb5_context context
,
2805 krb5_error_code code
,
2806 TALLOC_CTX
*mem_ctx
)
2810 #if defined(HAVE_KRB5_GET_ERROR_MESSAGE) && defined(HAVE_KRB5_FREE_ERROR_MESSAGE)
2811 const char *context_error
= krb5_get_error_message(context
, code
);
2812 if (context_error
) {
2813 ret
= talloc_asprintf(mem_ctx
, "%s: %s",
2814 error_message(code
), context_error
);
2815 krb5_free_error_message(context
, context_error
);
2819 ret
= talloc_strdup(mem_ctx
, error_message(code
));
2825 * @brief Return the kerberos library setting for: libdefaults:allow_weak_crypto
2827 * @param[in] context The library context
2829 * @return True if weak crypto is allowed, false if not.
2831 krb5_boolean
smb_krb5_get_allowed_weak_crypto(krb5_context context
)
2832 #if defined(HAVE_KRB5_CONFIG_GET_BOOL_DEFAULT)
2834 return krb5_config_get_bool_default(context
,
2838 "allow_weak_crypto",
2841 #elif defined(HAVE_PROFILE_H) && defined(HAVE_KRB5_GET_PROFILE)
2843 #include <profile.h>
2844 krb5_error_code ret
;
2845 krb5_boolean ret_default
= false;
2849 ret
= krb5_get_profile(context
,
2855 ret
= profile_get_boolean(profile
,
2857 "allow_weak_crypto",
2858 NULL
, /* subsubname */
2859 ret_default
, /* def_val */
2860 &ret_profile
/* *ret_default */);
2865 profile_release(profile
);
2870 #error UNKNOWN_KRB5_CONFIG_ROUTINES
2874 * @brief Return the type of a krb5_principal
2876 * @param[in] context The library context.
2878 * @param[in] principal The principal to get the type from.
2880 * @return The integer type of the principal.
2882 int smb_krb5_principal_get_type(krb5_context context
,
2883 krb5_const_principal principal
)
2885 #ifdef HAVE_KRB5_PRINCIPAL_GET_TYPE /* Heimdal */
2886 return krb5_principal_get_type(context
, principal
);
2887 #elif defined(krb5_princ_type) /* MIT */
2888 return krb5_princ_type(context
, principal
);
2890 #error UNKNOWN_PRINC_GET_TYPE_FUNCTION
2895 * @brief Set the type of a principal
2897 * @param[in] context The library context
2899 * @param[inout] principal The principal to set the type for.
2901 * @param[in] type The principal type to set.
2903 void smb_krb5_principal_set_type(krb5_context context
,
2904 krb5_principal principal
,
2907 #ifdef HAVE_KRB5_PRINCIPAL_SET_TYPE /* Heimdal */
2908 krb5_principal_set_type(context
, principal
, type
);
2909 #elif defined(krb5_princ_type) /* MIT */
2910 krb5_princ_type(context
, principal
) = type
;
2912 #error UNKNOWN_PRINC_SET_TYPE_FUNCTION
2916 #if !defined(HAVE_KRB5_WARNX)
2918 * @brief Log a Kerberos message
2920 * It sends the message to com_err.
2922 * @param[in] context The library context
2924 * @param[in] fmt The message format
2926 * @param[in] ... The message arguments
2928 * @return 0 on success.
2930 krb5_error_code
krb5_warnx(krb5_context context
, const char *fmt
, ...)
2934 va_start(args
, fmt
);
2935 com_err_va("samba-kdc", errno
, fmt
, args
);
2943 * @brief Copy a credential cache.
2945 * @param[in] context The library context.
2947 * @param[in] incc Credential cache to be copied.
2949 * @param[inout] outcc Copy of credential cache to be filled in.
2951 * @return 0 on success, a Kerberos error code otherwise.
2953 krb5_error_code
smb_krb5_cc_copy_creds(krb5_context context
,
2954 krb5_ccache incc
, krb5_ccache outcc
)
2956 #ifdef HAVE_KRB5_CC_COPY_CACHE /* Heimdal */
2957 return krb5_cc_copy_cache(context
, incc
, outcc
);
2958 #elif defined(HAVE_KRB5_CC_COPY_CREDS)
2959 krb5_error_code ret
;
2960 krb5_principal princ
= NULL
;
2962 ret
= krb5_cc_get_principal(context
, incc
, &princ
);
2966 ret
= krb5_cc_initialize(context
, outcc
, princ
);
2967 krb5_free_principal(context
, princ
);
2971 return krb5_cc_copy_creds(context
, incc
, outcc
);
2973 #error UNKNOWN_KRB5_CC_COPY_CACHE_OR_CREDS_FUNCTION
2977 /**********************************************************
2979 **********************************************************/
2981 static bool ads_cleanup_expired_creds(krb5_context context
,
2985 krb5_error_code retval
;
2986 const char *cc_type
= krb5_cc_get_type(context
, ccache
);
2988 DEBUG(3, ("ads_cleanup_expired_creds: Ticket in ccache[%s:%s] expiration %s\n",
2989 cc_type
, krb5_cc_get_name(context
, ccache
),
2990 http_timestring(talloc_tos(), credsp
->times
.endtime
)));
2992 /* we will probably need new tickets if the current ones
2993 will expire within 10 seconds.
2995 if (credsp
->times
.endtime
>= (time(NULL
) + 10))
2998 /* heimdal won't remove creds from a file ccache, and
2999 perhaps we shouldn't anyway, since internally we
3000 use memory ccaches, and a FILE one probably means that
3001 we're using creds obtained outside of our exectuable
3003 if (strequal(cc_type
, "FILE")) {
3004 DEBUG(5, ("ads_cleanup_expired_creds: We do not remove creds from a %s ccache\n", cc_type
));
3008 retval
= krb5_cc_remove_cred(context
, ccache
, 0, credsp
);
3010 DEBUG(1, ("ads_cleanup_expired_creds: krb5_cc_remove_cred failed, err %s\n",
3011 error_message(retval
)));
3012 /* If we have an error in this, we want to display it,
3013 but continue as though we deleted it */
3018 /* Allocate and setup the auth context into the state we need. */
3020 static krb5_error_code
ads_setup_auth_context(krb5_context context
,
3021 krb5_auth_context
*auth_context
)
3023 krb5_error_code retval
;
3025 retval
= krb5_auth_con_init(context
, auth_context
);
3027 DEBUG(1,("krb5_auth_con_init failed (%s)\n",
3028 error_message(retval
)));
3032 /* Ensure this is an addressless ticket. */
3033 retval
= krb5_auth_con_setaddrs(context
, *auth_context
, NULL
, NULL
);
3035 DEBUG(1,("krb5_auth_con_setaddrs failed (%s)\n",
3036 error_message(retval
)));
3042 #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)
3043 static krb5_error_code
ads_create_gss_checksum(krb5_data
*in_data
, /* [inout] */
3046 unsigned int orig_length
= in_data
->length
;
3047 unsigned int base_cksum_size
= GSSAPI_CHECKSUM_SIZE
;
3048 char *gss_cksum
= NULL
;
3051 /* Extra length field for delgated ticket. */
3052 base_cksum_size
+= 4;
3055 if ((unsigned int)base_cksum_size
+ orig_length
<
3056 (unsigned int)base_cksum_size
) {
3060 gss_cksum
= (char *)SMB_MALLOC(base_cksum_size
+ orig_length
);
3061 if (gss_cksum
== NULL
) {
3065 memset(gss_cksum
, '\0', base_cksum_size
+ orig_length
);
3066 SIVAL(gss_cksum
, 0, GSSAPI_BNDLENGTH
);
3069 * GSS_C_NO_CHANNEL_BINDINGS means 16 zero bytes.
3070 * This matches the behavior of heimdal and mit.
3072 * And it is needed to work against some closed source
3077 memset(&gss_cksum
[4], 0x00, GSSAPI_BNDLENGTH
);
3079 SIVAL(gss_cksum
, 20, gss_flags
);
3082 SSVAL(gss_cksum
, 24, 1); /* The Delegation Option identifier */
3083 SSVAL(gss_cksum
, 26, orig_length
);
3084 /* Copy the kerberos KRB_CRED data */
3085 memcpy(gss_cksum
+ 28, in_data
->data
, orig_length
);
3086 free(in_data
->data
);
3087 in_data
->data
= NULL
;
3088 in_data
->length
= 0;
3090 in_data
->data
= gss_cksum
;
3091 in_data
->length
= base_cksum_size
+ orig_length
;
3097 * We can't use krb5_mk_req because w2k wants the service to be in a particular
3100 static krb5_error_code
ads_krb5_mk_req(krb5_context context
,
3101 krb5_auth_context
*auth_context
,
3102 const krb5_flags ap_req_options
,
3103 const char *principal
,
3106 time_t *expire_time
,
3107 const char *impersonate_princ_s
)
3109 krb5_error_code retval
;
3110 krb5_principal server
;
3111 krb5_principal impersonate_princ
= NULL
;
3115 bool creds_ready
= false;
3116 int i
= 0, maxtries
= 3;
3119 ZERO_STRUCT(in_data
);
3121 retval
= smb_krb5_parse_name(context
, principal
, &server
);
3123 DEBUG(1,("ads_krb5_mk_req: Failed to parse principal %s\n", principal
));
3127 if (impersonate_princ_s
) {
3128 retval
= smb_krb5_parse_name(context
, impersonate_princ_s
,
3129 &impersonate_princ
);
3131 DEBUG(1,("ads_krb5_mk_req: Failed to parse principal %s\n", impersonate_princ_s
));
3136 /* obtain ticket & session key */
3138 if ((retval
= krb5_copy_principal(context
, server
, &creds
.server
))) {
3139 DEBUG(1,("ads_krb5_mk_req: krb5_copy_principal failed (%s)\n",
3140 error_message(retval
)));
3144 retval
= krb5_cc_get_principal(context
, ccache
, &creds
.client
);
3146 /* This can commonly fail on smbd startup with no ticket in the cache.
3147 * Report at higher level than 1. */
3148 DEBUG(3,("ads_krb5_mk_req: krb5_cc_get_principal failed (%s)\n",
3149 error_message(retval
)));
3153 while (!creds_ready
&& (i
< maxtries
)) {
3155 retval
= smb_krb5_get_credentials(context
,
3162 DBG_WARNING("smb_krb5_get_credentials failed for %s "
3165 error_message(retval
));
3169 /* cope with ticket being in the future due to clock skew */
3170 if ((unsigned)credsp
->times
.starttime
> time(NULL
)) {
3171 time_t t
= time(NULL
);
3172 int time_offset
=(int)((unsigned)credsp
->times
.starttime
-t
);
3173 DEBUG(4,("ads_krb5_mk_req: Advancing clock by %d seconds to cope with clock skew\n", time_offset
));
3174 krb5_set_real_time(context
, t
+ time_offset
+ 1, 0);
3177 ok
= ads_cleanup_expired_creds(context
, ccache
, credsp
);
3185 DBG_DEBUG("Ticket (%s) in ccache (%s:%s) is valid until: (%s - %u)\n",
3187 krb5_cc_get_type(context
, ccache
),
3188 krb5_cc_get_name(context
, ccache
),
3189 http_timestring(talloc_tos(),
3190 (unsigned)credsp
->times
.endtime
),
3191 (unsigned)credsp
->times
.endtime
);
3194 *expire_time
= (time_t)credsp
->times
.endtime
;
3197 /* Allocate the auth_context. */
3198 retval
= ads_setup_auth_context(context
, auth_context
);
3200 DBG_WARNING("ads_setup_auth_context failed (%s)\n",
3201 error_message(retval
));
3205 #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)
3207 uint32_t gss_flags
= 0;
3209 if (credsp
->ticket_flags
& TKT_FLG_OK_AS_DELEGATE
) {
3211 * Fetch a forwarded TGT from the KDC so that we can
3212 * hand off a 2nd ticket as part of the kerberos
3216 DBG_INFO("Server marked as OK to delegate to, building "
3217 "forwardable TGT\n");
3219 retval
= krb5_auth_con_setuseruserkey(context
,
3221 &credsp
->keyblock
);
3223 DBG_WARNING("krb5_auth_con_setuseruserkey "
3225 error_message(retval
));
3229 /* Must use a subkey for forwarded tickets. */
3230 retval
= krb5_auth_con_setflags(context
,
3232 KRB5_AUTH_CONTEXT_USE_SUBKEY
);
3234 DBG_WARNING("krb5_auth_con_setflags failed (%s)\n",
3235 error_message(retval
));
3239 retval
= krb5_fwd_tgt_creds(context
,/* Krb5 context [in] */
3240 *auth_context
, /* Authentication context [in] */
3241 discard_const_p(char, KRB5_TGS_NAME
), /* Ticket service name ("krbtgt") [in] */
3242 credsp
->client
, /* Client principal for the tgt [in] */
3243 credsp
->server
, /* Server principal for the tgt [in] */
3244 ccache
, /* Credential cache to use for storage [in] */
3245 1, /* Turn on for "Forwardable ticket" [in] */
3246 &in_data
); /* Resulting response [out] */
3249 DBG_INFO("krb5_fwd_tgt_creds failed (%s)\n",
3250 error_message(retval
));
3253 * This is not fatal. Delete the *auth_context and continue
3254 * with krb5_mk_req_extended to get a non-forwardable ticket.
3258 free( in_data
.data
);
3259 in_data
.data
= NULL
;
3262 krb5_auth_con_free(context
, *auth_context
);
3263 *auth_context
= NULL
;
3264 retval
= ads_setup_auth_context(context
, auth_context
);
3266 DBG_WARNING("ads_setup_auth_context failed (%s)\n",
3267 error_message(retval
));
3271 /* We got a delegated ticket. */
3272 gss_flags
|= GSS_C_DELEG_FLAG
;
3276 /* Frees and reallocates in_data into a GSS checksum blob. */
3277 retval
= ads_create_gss_checksum(&in_data
, gss_flags
);
3282 /* We always want GSS-checksum types. */
3283 retval
= krb5_auth_con_set_req_cksumtype(context
, *auth_context
, GSSAPI_CHECKSUM
);
3285 DEBUG(1,("krb5_auth_con_set_req_cksumtype failed (%s)\n",
3286 error_message(retval
)));
3292 retval
= krb5_mk_req_extended(context
, auth_context
, ap_req_options
,
3293 &in_data
, credsp
, outbuf
);
3295 DBG_WARNING("krb5_mk_req_extended failed (%s)\n",
3296 error_message(retval
));
3299 #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)
3304 free( in_data
.data
);
3308 krb5_free_creds(context
, credsp
);
3311 krb5_free_cred_contents(context
, &creds
);
3314 krb5_free_principal(context
, server
);
3315 if (impersonate_princ
) {
3316 krb5_free_principal(context
, impersonate_princ
);
3323 get a kerberos5 ticket for the given service
3325 int ads_krb5_cli_get_ticket(TALLOC_CTX
*mem_ctx
,
3326 const char *principal
,
3329 DATA_BLOB
*session_key_krb5
,
3330 uint32_t extra_ap_opts
, const char *ccname
,
3332 const char *impersonate_princ_s
)
3334 krb5_error_code retval
;
3336 krb5_context context
= NULL
;
3337 krb5_ccache ccdef
= NULL
;
3338 krb5_auth_context auth_context
= NULL
;
3339 krb5_enctype enc_types
[] = {
3340 #ifdef HAVE_ENCTYPE_AES256_CTS_HMAC_SHA1_96
3341 ENCTYPE_AES256_CTS_HMAC_SHA1_96
,
3343 #ifdef HAVE_ENCTYPE_AES128_CTS_HMAC_SHA1_96
3344 ENCTYPE_AES128_CTS_HMAC_SHA1_96
,
3346 ENCTYPE_ARCFOUR_HMAC
,
3347 ENCTYPE_DES_CBC_MD5
,
3348 ENCTYPE_DES_CBC_CRC
,
3352 initialize_krb5_error_table();
3353 retval
= krb5_init_context(&context
);
3355 DBG_WARNING("krb5_init_context failed (%s)\n",
3356 error_message(retval
));
3360 if (time_offset
!= 0) {
3361 krb5_set_real_time(context
, time(NULL
) + time_offset
, 0);
3364 retval
= krb5_cc_resolve(context
,
3365 ccname
? ccname
: krb5_cc_default_name(context
),
3368 DBG_WARNING("krb5_cc_default failed (%s)\n",
3369 error_message(retval
));
3373 retval
= krb5_set_default_tgs_ktypes(context
, enc_types
);
3375 DBG_WARNING("krb5_set_default_tgs_ktypes failed (%s)\n",
3376 error_message(retval
));
3380 retval
= ads_krb5_mk_req(context
,
3382 AP_OPTS_USE_SUBKEY
| (krb5_flags
)extra_ap_opts
,
3387 impersonate_princ_s
);
3392 ok
= smb_krb5_get_smb_session_key(mem_ctx
,
3402 *ticket
= data_blob_talloc(mem_ctx
, packet
.data
, packet
.length
);
3404 smb_krb5_free_data_contents(context
, &packet
);
3410 krb5_cc_close(context
, ccdef
);
3413 krb5_auth_con_free(context
, auth_context
);
3415 krb5_free_context(context
);
3421 #else /* HAVE_KRB5 */
3422 /* This saves a few linking headaches */
3423 int ads_krb5_cli_get_ticket(TALLOC_CTX
*mem_ctx
,
3424 const char *principal
,
3427 DATA_BLOB
*session_key_krb5
,
3428 uint32_t extra_ap_opts
, const char *ccname
,
3430 const char *impersonate_princ_s
)
3432 DEBUG(0,("NO KERBEROS SUPPORT\n"));
3436 #endif /* HAVE_KRB5 */