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 #if defined(HAVE_MAGIC_IN_KRB5_ADDRESS) && defined(HAVE_ADDRTYPE_IN_KRB5_ADDRESS) /* MIT */
80 #elif defined(HAVE_KRB5_ADDRESSES) /* Heimdal */
81 krb5_addresses *addrs;
83 #error UNKNOWN_KRB5_ADDRESS_TYPE
84 #endif /* defined(HAVE_MAGIC_IN_KRB5_ADDRESS) && defined(HAVE_ADDRTYPE_IN_KRB5_ADDRESS) */
87 #ifdef HAVE_KRB5_KEYTAB_ENTRY_KEY /* MIT */
88 #define KRB5_KT_KEY(k) (&(k)->key)
89 #elif HAVE_KRB5_KEYTAB_ENTRY_KEYBLOCK /* Heimdal */
90 #define KRB5_KT_KEY(k) (&(k)->keyblock)
92 #error krb5_keytab_entry has no key or keyblock member
93 #endif /* HAVE_KRB5_KEYTAB_ENTRY_KEY */
95 /* work around broken krb5.h on sles9 */
100 #ifdef HAVE_KRB5_KEYBLOCK_KEYVALUE /* Heimdal */
101 #define KRB5_KEY_TYPE(k) ((k)->keytype)
102 #define KRB5_KEY_LENGTH(k) ((k)->keyvalue.length)
103 #define KRB5_KEY_DATA(k) ((k)->keyvalue.data)
104 #define KRB5_KEY_DATA_CAST void
106 #define KRB5_KEY_TYPE(k) ((k)->enctype)
107 #define KRB5_KEY_LENGTH(k) ((k)->length)
108 #define KRB5_KEY_DATA(k) ((k)->contents)
109 #define KRB5_KEY_DATA_CAST krb5_octet
110 #endif /* HAVE_KRB5_KEYBLOCK_KEYVALUE */
112 #ifdef HAVE_E_DATA_POINTER_IN_KRB5_ERROR /* Heimdal */
113 #define KRB5_ERROR_CODE(k) ((k)->error_code)
115 #define KRB5_ERROR_CODE(k) ((k)->error)
116 #endif /* HAVE_E_DATA_POINTER_IN_KRB5_ERROR */
118 krb5_error_code smb_krb5_parse_name(krb5_context context,
119 const char *name, /* in unix charset */
120 krb5_principal *principal);
122 krb5_error_code smb_krb5_unparse_name(TALLOC_CTX *mem_ctx,
123 krb5_context context,
124 krb5_const_principal principal,
127 krb5_error_code krb5_set_default_tgs_ktypes(krb5_context ctx, const krb5_enctype *enc);
129 #if defined(HAVE_KRB5_AUTH_CON_SETKEY) && !defined(HAVE_KRB5_AUTH_CON_SETUSERUSERKEY)
130 krb5_error_code krb5_auth_con_setuseruserkey(krb5_context context, krb5_auth_context auth_context, krb5_keyblock *keyblock);
133 #ifndef HAVE_KRB5_FREE_UNPARSED_NAME
134 void krb5_free_unparsed_name(krb5_context ctx, char *val);
137 /* Stub out initialize_krb5_error_table since it is not present in all
138 * Kerberos implementations. If it's not present, it's not necessary to
141 #ifndef HAVE_INITIALIZE_KRB5_ERROR_TABLE
142 #define initialize_krb5_error_table()
145 /* Samba wrapper functions for krb5 functionality. */
146 bool setup_kaddr( krb5_address *pkaddr, struct sockaddr_storage *paddr);
148 krb5_error_code get_kerberos_allowed_etypes(krb5_context context, krb5_enctype **enctypes);
149 bool get_krb5_smb_session_key(TALLOC_CTX *mem_ctx,
150 krb5_context context,
151 krb5_auth_context auth_context,
152 DATA_BLOB *session_key, bool remote);
153 krb5_error_code smb_krb5_kt_free_entry(krb5_context context, krb5_keytab_entry *kt_entry);
154 void kerberos_set_creds_enctype(krb5_creds *pcreds, int enctype);
155 bool kerberos_compatible_enctypes(krb5_context context, krb5_enctype enctype1, krb5_enctype enctype2);
156 void kerberos_free_data_contents(krb5_context context, krb5_data *pdata);
157 krb5_error_code smb_krb5_parse_name_norealm(krb5_context context,
159 krb5_principal *principal);
160 bool smb_krb5_principal_compare_any_realm(krb5_context context,
161 krb5_const_principal princ1,
162 krb5_const_principal princ2);
163 krb5_error_code smb_krb5_renew_ticket(const char *ccache_string, const char *client_string, const char *service_string, time_t *expire_time);
164 krb5_error_code smb_krb5_gen_netbios_krb5_address(smb_krb5_addresses **kerb_addr,
165 const char *netbios_name);
166 krb5_error_code smb_krb5_free_addresses(krb5_context context, smb_krb5_addresses *addr);
167 NTSTATUS krb5_to_nt_status(krb5_error_code kerberos_error);
168 krb5_error_code nt_status_to_krb5(NTSTATUS nt_status);
169 void smb_krb5_free_error(krb5_context context, krb5_error *krberror);
170 krb5_error_code handle_krberror_packet(krb5_context context,
173 void smb_krb5_get_init_creds_opt_free(krb5_context context,
174 krb5_get_init_creds_opt *opt);
175 krb5_error_code smb_krb5_get_init_creds_opt_alloc(krb5_context context,
176 krb5_get_init_creds_opt **opt);
177 krb5_enctype smb_get_enctype_from_kt_entry(krb5_keytab_entry *kt_entry);
178 krb5_error_code smb_krb5_enctype_to_string(krb5_context context,
179 krb5_enctype enctype,
181 krb5_error_code smb_krb5_open_keytab(krb5_context context,
182 const char *keytab_name,
184 krb5_keytab *keytab);
185 krb5_error_code smb_krb5_keytab_name(TALLOC_CTX *mem_ctx,
186 krb5_context context,
188 const char **keytab_name);
189 krb5_error_code smb_krb5_kt_seek_and_delete_old_entries(krb5_context context,
193 krb5_principal princ,
195 bool keep_old_entries);
196 krb5_error_code smb_krb5_kt_add_entry(krb5_context context,
200 const char *salt_principal,
201 krb5_enctype enctype,
204 bool keep_old_entries);
206 krb5_error_code smb_krb5_get_credentials(krb5_context context,
209 krb5_principal server,
210 krb5_principal impersonate_princ,
211 krb5_creds **out_creds);
212 krb5_error_code smb_krb5_keyblock_init_contents(krb5_context context,
213 krb5_enctype enctype,
217 krb5_error_code kerberos_kinit_keyblock_cc(krb5_context ctx, krb5_ccache cc,
218 krb5_principal principal,
219 krb5_keyblock *keyblock,
220 const char *target_service,
221 krb5_get_init_creds_opt *krb_options,
224 krb5_error_code kerberos_kinit_password_cc(krb5_context ctx,
226 krb5_principal principal,
227 const char *password,
228 const char *target_service,
229 krb5_get_init_creds_opt *krb_options,
232 #ifdef SAMBA4_USES_HEIMDAL
233 krb5_error_code kerberos_kinit_s4u2_cc(krb5_context ctx,
234 krb5_ccache store_cc,
235 krb5_principal init_principal,
236 const char *init_password,
237 krb5_principal impersonate_principal,
238 const char *self_service,
239 const char *target_service,
240 krb5_get_init_creds_opt *krb_options,
245 #if defined(HAVE_KRB5_MAKE_PRINCIPAL)
246 #define smb_krb5_make_principal krb5_make_principal
247 #elif defined(HAVE_KRB5_BUILD_PRINCIPAL_ALLOC_VA)
248 krb5_error_code smb_krb5_make_principal(krb5_context context,
249 krb5_principal *principal,
250 const char *realm, ...);
252 #error krb5_make_principal not available
255 #if defined(HAVE_KRB5_CC_GET_LIFETIME)
256 #define smb_krb5_cc_get_lifetime krb5_cc_get_lifetime
257 #elif defined(HAVE_KRB5_CC_RETRIEVE_CRED)
258 krb5_error_code smb_krb5_cc_get_lifetime(krb5_context context,
262 #error krb5_cc_get_lifetime not available
265 #if defined(HAVE_KRB5_FREE_CHECKSUM_CONTENTS)
266 #define smb_krb5_free_checksum_contents krb5_free_checksum_contents
267 #elif defined (HAVE_FREE_CHECKSUM)
268 void smb_krb5_free_checksum_contents(krb5_context ctx, krb5_checksum *cksum);
270 #error krb5_free_checksum_contents/free_Checksum is not vailable
273 krb5_error_code smb_krb5_make_pac_checksum(TALLOC_CTX *mem_ctx,
275 krb5_context context,
276 const krb5_keyblock *keyblock,
278 DATA_BLOB *sig_blob);
280 char *smb_krb5_principal_get_realm(krb5_context context,
281 krb5_const_principal principal);
283 void smb_krb5_principal_set_type(krb5_context context,
284 krb5_principal principal,
287 krb5_error_code smb_krb5_principal_set_realm(krb5_context context,
288 krb5_principal principal,
291 char *kerberos_get_principal_from_service_hostname(TALLOC_CTX *mem_ctx,
293 const char *remote_name,
294 const char *default_realm);
296 char *smb_get_krb5_error_message(krb5_context context,
297 krb5_error_code code,
298 TALLOC_CTX *mem_ctx);
300 bool unwrap_edata_ntstatus(TALLOC_CTX *mem_ctx,
302 DATA_BLOB *edata_out);
305 krb5_error_code kt_copy(krb5_context context,
308 krb5_error_code kt_copy_one_principal(krb5_context context,
311 const char *principal,
313 const krb5_enctype *enctypes);
315 #if defined(HAVE_KRB5_KT_COMPARE)
316 #define smb_krb5_kt_compare krb5_kt_compare
318 krb5_boolean smb_krb5_kt_compare(krb5_context context,
319 krb5_keytab_entry *entry,
320 krb5_const_principal principal,
322 krb5_enctype enctype);
325 const krb5_enctype *samba_all_enctypes(void);
327 uint32_t kerberos_enctype_to_bitmap(krb5_enctype enc_type_enum);
328 krb5_enctype ms_suptype_to_ietf_enctype(uint32_t enctype_bitmap);
329 krb5_error_code ms_suptypes_to_ietf_enctypes(TALLOC_CTX *mem_ctx,
330 uint32_t enctype_bitmap,
331 krb5_enctype **enctypes);
332 int smb_krb5_get_pw_salt(krb5_context context,
333 krb5_const_principal host_princ,
336 int smb_krb5_create_key_from_string(krb5_context context,
337 krb5_const_principal host_princ,
340 krb5_enctype enctype,
343 krb5_boolean smb_krb5_get_allowed_weak_crypto(krb5_context context);
345 #ifndef krb5_princ_size
346 #if defined(HAVE_KRB5_PRINCIPAL_GET_NUM_COMP)
347 #define krb5_princ_size krb5_principal_get_num_comp
349 #error krb5_princ_size unavailable
353 char *smb_krb5_principal_get_comp_string(TALLOC_CTX *mem_ctx,
354 krb5_context context,
355 krb5_const_principal principal,
356 unsigned int component);
358 krb5_error_code krb5_copy_data_contents(krb5_data *p,
362 int smb_krb5_principal_get_type(krb5_context context,
363 krb5_const_principal principal);
365 #if !defined(HAVE_KRB5_WARNX)
366 krb5_error_code krb5_warnx(krb5_context context, const char *fmt, ...);
369 #endif /* HAVE_KRB5 */
371 int cli_krb5_get_ticket(TALLOC_CTX *mem_ctx,
372 const char *principal, time_t time_offset,
373 DATA_BLOB *ticket, DATA_BLOB *session_key_krb5,
374 uint32_t extra_ap_opts, const char *ccname,
376 const char *impersonate_princ_s);
378 #endif /* _KRB5_SAMBA_H */