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/>.
28 #define KRB5_PRIVATE 1 /* this file uses PRIVATE interfaces! */
29 /* this file uses DEPRECATED interfaces! */
31 #ifdef KRB5_DEPRECATED
32 #undef KRB5_DEPRECATED
35 #if defined(HAVE_KRB5_DEPRECATED_WITH_IDENTIFIER)
36 #define KRB5_DEPRECATED 1
38 #define KRB5_DEPRECATED
41 #include "system/kerberos.h"
42 #include "system/network.h"
44 #ifndef KRB5_ADDR_NETBIOS
45 #define KRB5_ADDR_NETBIOS 0x14
48 #ifndef KRB5KRB_ERR_RESPONSE_TOO_BIG
49 #define KRB5KRB_ERR_RESPONSE_TOO_BIG (-1765328332L)
52 /* Heimdal uses a slightly different name */
53 #if defined(HAVE_ENCTYPE_ARCFOUR_HMAC_MD5) && !defined(HAVE_ENCTYPE_ARCFOUR_HMAC)
54 #define ENCTYPE_ARCFOUR_HMAC ENCTYPE_ARCFOUR_HMAC_MD5
56 #if defined(HAVE_ENCTYPE_ARCFOUR_HMAC_MD5_56) && !defined(HAVE_ENCTYPE_ARCFOUR_HMAC_EXP)
57 #define ENCTYPE_ARCFOUR_HMAC_EXP ENCTYPE_ARCFOUR_HMAC_MD5_56
60 /* The older versions of heimdal that don't have this
61 define don't seem to use it anyway. I'm told they
62 always use a subkey */
63 #ifndef HAVE_AP_OPTS_USE_SUBKEY
64 #define AP_OPTS_USE_SUBKEY 0
68 #define KRB5_PW_SALT 3
71 /* CKSUMTYPE_HMAC_MD5 in Heimdal
72 CKSUMTYPE_HMAC_MD5_ARCFOUR in MIT */
73 #if defined(CKSUMTYPE_HMAC_MD5_ARCFOUR) && !defined(CKSUMTYPE_HMAC_MD5)
74 #define CKSUMTYPE_HMAC_MD5 CKSUMTYPE_HMAC_MD5_ARCFOUR
78 * CKSUMTYPE_HMAC_SHA1_96_AES_* in Heimdal
79 * CKSUMTYPE_HMAC_SHA1_96_AES* in MIT
81 #if defined(CKSUMTYPE_HMAC_SHA1_96_AES128) && !defined(CKSUMTYPE_HMAC_SHA1_96_AES_128)
82 #define CKSUMTYPE_HMAC_SHA1_96_AES_128 CKSUMTYPE_HMAC_SHA1_96_AES128
84 #if defined(CKSUMTYPE_HMAC_SHA1_96_AES256) && !defined(CKSUMTYPE_HMAC_SHA1_96_AES_256)
85 #define CKSUMTYPE_HMAC_SHA1_96_AES_256 CKSUMTYPE_HMAC_SHA1_96_AES256
89 * KRB5_KU_OTHER_ENCRYPTED in Heimdal
90 * KRB5_KEYUSAGE_APP_DATA_ENCRYPT in MIT
92 #if defined(KRB5_KEYUSAGE_APP_DATA_ENCRYPT) && !defined(KRB5_KU_OTHER_ENCRYPTED)
93 #define KRB5_KU_OTHER_ENCRYPTED KRB5_KEYUSAGE_APP_DATA_ENCRYPT
97 #if defined(HAVE_MAGIC_IN_KRB5_ADDRESS) && defined(HAVE_ADDRTYPE_IN_KRB5_ADDRESS) /* MIT */
99 #elif defined(HAVE_KRB5_ADDRESSES) /* Heimdal */
100 krb5_addresses *addrs;
102 #error UNKNOWN_KRB5_ADDRESS_TYPE
103 #endif /* defined(HAVE_MAGIC_IN_KRB5_ADDRESS) && defined(HAVE_ADDRTYPE_IN_KRB5_ADDRESS) */
104 } smb_krb5_addresses;
106 #ifdef HAVE_KRB5_KEYTAB_ENTRY_KEY /* MIT */
107 #define KRB5_KT_KEY(k) (&(k)->key)
108 #elif HAVE_KRB5_KEYTAB_ENTRY_KEYBLOCK /* Heimdal */
109 #define KRB5_KT_KEY(k) (&(k)->keyblock)
111 #error krb5_keytab_entry has no key or keyblock member
112 #endif /* HAVE_KRB5_KEYTAB_ENTRY_KEY */
114 /* work around broken krb5.h on sles9 */
119 #ifdef HAVE_KRB5_KEYBLOCK_KEYVALUE /* Heimdal */
120 #define KRB5_KEY_TYPE(k) ((k)->keytype)
121 #define KRB5_KEY_LENGTH(k) ((k)->keyvalue.length)
122 #define KRB5_KEY_DATA(k) ((k)->keyvalue.data)
123 #define KRB5_KEY_DATA_CAST void
125 #define KRB5_KEY_TYPE(k) ((k)->enctype)
126 #define KRB5_KEY_LENGTH(k) ((k)->length)
127 #define KRB5_KEY_DATA(k) ((k)->contents)
128 #define KRB5_KEY_DATA_CAST krb5_octet
129 #endif /* HAVE_KRB5_KEYBLOCK_KEYVALUE */
131 #ifdef HAVE_E_DATA_POINTER_IN_KRB5_ERROR /* Heimdal */
132 #define KRB5_ERROR_CODE(k) ((k)->error_code)
134 #define KRB5_ERROR_CODE(k) ((k)->error)
135 #endif /* HAVE_E_DATA_POINTER_IN_KRB5_ERROR */
137 krb5_error_code smb_krb5_parse_name(krb5_context context,
138 const char *name, /* in unix charset */
139 krb5_principal *principal);
141 krb5_error_code smb_krb5_unparse_name(TALLOC_CTX *mem_ctx,
142 krb5_context context,
143 krb5_const_principal principal,
146 krb5_error_code krb5_set_default_tgs_ktypes(krb5_context ctx, const krb5_enctype *enc);
148 #if defined(HAVE_KRB5_AUTH_CON_SETKEY) && !defined(HAVE_KRB5_AUTH_CON_SETUSERUSERKEY)
149 krb5_error_code krb5_auth_con_setuseruserkey(krb5_context context, krb5_auth_context auth_context, krb5_keyblock *keyblock);
152 #ifndef HAVE_KRB5_FREE_UNPARSED_NAME
153 void krb5_free_unparsed_name(krb5_context ctx, char *val);
156 /* Stub out initialize_krb5_error_table since it is not present in all
157 * Kerberos implementations. If it's not present, it's not necessary to
160 #ifndef HAVE_INITIALIZE_KRB5_ERROR_TABLE
161 #define initialize_krb5_error_table()
164 /* Samba wrapper functions for krb5 functionality. */
165 bool smb_krb5_sockaddr_to_kaddr(struct sockaddr_storage *paddr,
166 krb5_address *pkaddr);
168 krb5_error_code smb_krb5_mk_error(krb5_context context,
169 krb5_error_code error_code,
174 krb5_error_code smb_krb5_get_allowed_etypes(krb5_context context,
175 krb5_enctype **enctypes);
177 bool smb_krb5_get_smb_session_key(TALLOC_CTX *mem_ctx,
178 krb5_context context,
179 krb5_auth_context auth_context,
180 DATA_BLOB *session_key,
183 krb5_error_code smb_krb5_kt_free_entry(krb5_context context, krb5_keytab_entry *kt_entry);
184 void kerberos_set_creds_enctype(krb5_creds *pcreds, int enctype);
185 bool kerberos_compatible_enctypes(krb5_context context, krb5_enctype enctype1, krb5_enctype enctype2);
186 void smb_krb5_free_data_contents(krb5_context context, krb5_data *pdata);
187 krb5_error_code smb_krb5_parse_name_norealm(krb5_context context,
189 krb5_principal *principal);
190 bool smb_krb5_principal_compare_any_realm(krb5_context context,
191 krb5_const_principal princ1,
192 krb5_const_principal princ2);
193 krb5_error_code smb_krb5_renew_ticket(const char *ccache_string, const char *client_string, const char *service_string, time_t *expire_time);
194 krb5_error_code smb_krb5_gen_netbios_krb5_address(smb_krb5_addresses **kerb_addr,
195 const char *netbios_name);
196 krb5_error_code smb_krb5_free_addresses(krb5_context context, smb_krb5_addresses *addr);
197 NTSTATUS krb5_to_nt_status(krb5_error_code kerberos_error);
198 krb5_error_code nt_status_to_krb5(NTSTATUS nt_status);
200 krb5_enctype smb_krb5_kt_get_enctype_from_entry(krb5_keytab_entry *kt_entry);
202 krb5_error_code smb_krb5_enctype_to_string(krb5_context context,
203 krb5_enctype enctype,
205 krb5_error_code smb_krb5_kt_open_relative(krb5_context context,
206 const char *keytab_name_req,
208 krb5_keytab *keytab);
209 krb5_error_code smb_krb5_kt_open(krb5_context context,
210 const char *keytab_name,
212 krb5_keytab *keytab);
213 krb5_error_code smb_krb5_kt_get_name(TALLOC_CTX *mem_ctx,
214 krb5_context context,
216 const char **keytab_name);
217 krb5_error_code smb_krb5_kt_seek_and_delete_old_entries(krb5_context context,
220 krb5_enctype enctype,
222 krb5_principal princ,
224 bool keep_old_entries);
225 krb5_error_code smb_krb5_kt_add_entry(krb5_context context,
229 const char *salt_principal,
230 krb5_enctype enctype,
233 bool keep_old_entries);
235 krb5_error_code smb_krb5_get_credentials(krb5_context context,
238 krb5_principal server,
239 krb5_principal impersonate_princ,
240 krb5_creds **out_creds);
241 krb5_error_code smb_krb5_keyblock_init_contents(krb5_context context,
242 krb5_enctype enctype,
246 krb5_error_code kerberos_kinit_keyblock_cc(krb5_context ctx, krb5_ccache cc,
247 krb5_principal principal,
248 krb5_keyblock *keyblock,
249 const char *target_service,
250 krb5_get_init_creds_opt *krb_options,
253 krb5_error_code kerberos_kinit_password_cc(krb5_context ctx,
255 krb5_principal principal,
256 const char *password,
257 const char *target_service,
258 krb5_get_init_creds_opt *krb_options,
261 #ifdef SAMBA4_USES_HEIMDAL
262 krb5_error_code kerberos_kinit_s4u2_cc(krb5_context ctx,
263 krb5_ccache store_cc,
264 krb5_principal init_principal,
265 const char *init_password,
266 krb5_principal impersonate_principal,
267 const char *self_service,
268 const char *target_service,
269 krb5_get_init_creds_opt *krb_options,
274 #if defined(HAVE_KRB5_MAKE_PRINCIPAL)
275 #define smb_krb5_make_principal krb5_make_principal
276 #elif defined(HAVE_KRB5_BUILD_PRINCIPAL_ALLOC_VA)
277 krb5_error_code smb_krb5_make_principal(krb5_context context,
278 krb5_principal *principal,
279 const char *realm, ...);
281 #error krb5_make_principal not available
284 #if defined(HAVE_KRB5_CC_GET_LIFETIME)
285 #define smb_krb5_cc_get_lifetime krb5_cc_get_lifetime
286 #elif defined(HAVE_KRB5_CC_RETRIEVE_CRED)
287 krb5_error_code smb_krb5_cc_get_lifetime(krb5_context context,
291 #error krb5_cc_get_lifetime not available
294 #if defined(HAVE_KRB5_FREE_CHECKSUM_CONTENTS)
295 #define smb_krb5_free_checksum_contents krb5_free_checksum_contents
296 #elif defined (HAVE_FREE_CHECKSUM)
297 void smb_krb5_free_checksum_contents(krb5_context ctx, krb5_checksum *cksum);
299 #error krb5_free_checksum_contents/free_Checksum is not vailable
302 krb5_error_code smb_krb5_make_pac_checksum(TALLOC_CTX *mem_ctx,
304 krb5_context context,
305 const krb5_keyblock *keyblock,
307 DATA_BLOB *sig_blob);
309 char *smb_krb5_principal_get_realm(krb5_context context,
310 krb5_const_principal principal);
312 void smb_krb5_principal_set_type(krb5_context context,
313 krb5_principal principal,
316 krb5_error_code smb_krb5_principal_set_realm(krb5_context context,
317 krb5_principal principal,
320 char *kerberos_get_principal_from_service_hostname(TALLOC_CTX *mem_ctx,
322 const char *remote_name,
323 const char *default_realm);
325 char *smb_get_krb5_error_message(krb5_context context,
326 krb5_error_code code,
327 TALLOC_CTX *mem_ctx);
329 bool unwrap_edata_ntstatus(TALLOC_CTX *mem_ctx,
331 DATA_BLOB *edata_out);
334 krb5_error_code kt_copy(krb5_context context,
337 krb5_error_code kt_copy_one_principal(krb5_context context,
340 const char *principal,
342 const krb5_enctype *enctypes);
344 #if defined(HAVE_KRB5_KT_COMPARE)
345 #define smb_krb5_kt_compare krb5_kt_compare
347 krb5_boolean smb_krb5_kt_compare(krb5_context context,
348 krb5_keytab_entry *entry,
349 krb5_const_principal principal,
351 krb5_enctype enctype);
354 const krb5_enctype *samba_all_enctypes(void);
356 uint32_t kerberos_enctype_to_bitmap(krb5_enctype enc_type_enum);
357 krb5_enctype ms_suptype_to_ietf_enctype(uint32_t enctype_bitmap);
358 krb5_error_code ms_suptypes_to_ietf_enctypes(TALLOC_CTX *mem_ctx,
359 uint32_t enctype_bitmap,
360 krb5_enctype **enctypes);
361 int smb_krb5_get_pw_salt(krb5_context context,
362 krb5_const_principal host_princ,
365 int smb_krb5_create_key_from_string(krb5_context context,
366 krb5_const_principal host_princ,
369 krb5_enctype enctype,
372 krb5_boolean smb_krb5_get_allowed_weak_crypto(krb5_context context);
374 #ifndef krb5_princ_size
375 #if defined(HAVE_KRB5_PRINCIPAL_GET_NUM_COMP)
376 #define krb5_princ_size krb5_principal_get_num_comp
378 #error krb5_princ_size unavailable
382 char *smb_krb5_principal_get_comp_string(TALLOC_CTX *mem_ctx,
383 krb5_context context,
384 krb5_const_principal principal,
385 unsigned int component);
387 krb5_error_code smb_krb5_copy_data_contents(krb5_data *p,
391 int smb_krb5_principal_get_type(krb5_context context,
392 krb5_const_principal principal);
394 #if !defined(HAVE_KRB5_WARNX)
395 krb5_error_code krb5_warnx(krb5_context context, const char *fmt, ...);
398 krb5_error_code smb_krb5_cc_copy_creds(krb5_context context,
399 krb5_ccache incc, krb5_ccache outcc);
401 #endif /* HAVE_KRB5 */
403 int ads_krb5_cli_get_ticket(TALLOC_CTX *mem_ctx,
404 const char *principal,
407 DATA_BLOB *session_key_krb5,
408 uint32_t extra_ap_opts, const char *ccname,
410 const char *impersonate_princ_s);
412 #endif /* _KRB5_SAMBA_H */