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 #if defined(HAVE_MAGIC_IN_KRB5_ADDRESS) && defined(HAVE_ADDRTYPE_IN_KRB5_ADDRESS) /* MIT */
91 #elif defined(HAVE_KRB5_ADDRESSES) /* Heimdal */
92 krb5_addresses
*addrs
;
94 #error UNKNOWN_KRB5_ADDRESS_TYPE
95 #endif /* defined(HAVE_MAGIC_IN_KRB5_ADDRESS) && defined(HAVE_ADDRTYPE_IN_KRB5_ADDRESS) */
98 #ifdef HAVE_KRB5_KEYTAB_ENTRY_KEY /* MIT */
99 #define KRB5_KT_KEY(k) (&(k)->key)
100 #elif HAVE_KRB5_KEYTAB_ENTRY_KEYBLOCK /* Heimdal */
101 #define KRB5_KT_KEY(k) (&(k)->keyblock)
103 #error krb5_keytab_entry has no key or keyblock member
104 #endif /* HAVE_KRB5_KEYTAB_ENTRY_KEY */
106 /* work around broken krb5.h on sles9 */
111 #ifdef HAVE_KRB5_KEYBLOCK_KEYVALUE /* Heimdal */
112 #define KRB5_KEY_TYPE(k) ((k)->keytype)
113 #define KRB5_KEY_LENGTH(k) ((k)->keyvalue.length)
114 #define KRB5_KEY_DATA(k) ((k)->keyvalue.data)
115 #define KRB5_KEY_DATA_CAST void
117 #define KRB5_KEY_TYPE(k) ((k)->enctype)
118 #define KRB5_KEY_LENGTH(k) ((k)->length)
119 #define KRB5_KEY_DATA(k) ((k)->contents)
120 #define KRB5_KEY_DATA_CAST krb5_octet
121 #endif /* HAVE_KRB5_KEYBLOCK_KEYVALUE */
123 #ifdef HAVE_E_DATA_POINTER_IN_KRB5_ERROR /* Heimdal */
124 #define KRB5_ERROR_CODE(k) ((k)->error_code)
126 #define KRB5_ERROR_CODE(k) ((k)->error)
127 #endif /* HAVE_E_DATA_POINTER_IN_KRB5_ERROR */
129 krb5_error_code
smb_krb5_parse_name(krb5_context context
,
130 const char *name
, /* in unix charset */
131 krb5_principal
*principal
);
133 krb5_error_code
smb_krb5_unparse_name(TALLOC_CTX
*mem_ctx
,
134 krb5_context context
,
135 krb5_const_principal principal
,
138 krb5_error_code
krb5_set_default_tgs_ktypes(krb5_context ctx
, const krb5_enctype
*enc
);
140 #if defined(HAVE_KRB5_AUTH_CON_SETKEY) && !defined(HAVE_KRB5_AUTH_CON_SETUSERUSERKEY)
141 krb5_error_code
krb5_auth_con_setuseruserkey(krb5_context context
, krb5_auth_context auth_context
, krb5_keyblock
*keyblock
);
144 #ifndef HAVE_KRB5_FREE_UNPARSED_NAME
145 void krb5_free_unparsed_name(krb5_context ctx
, char *val
);
148 /* Stub out initialize_krb5_error_table since it is not present in all
149 * Kerberos implementations. If it's not present, it's not necessary to
152 #ifndef HAVE_INITIALIZE_KRB5_ERROR_TABLE
153 #define initialize_krb5_error_table()
156 /* Samba wrapper functions for krb5 functionality. */
157 bool setup_kaddr( krb5_address
*pkaddr
, struct sockaddr_storage
*paddr
);
159 krb5_error_code
smb_krb5_mk_error(krb5_context context
,
160 krb5_error_code error_code
,
165 krb5_error_code
get_kerberos_allowed_etypes(krb5_context context
, krb5_enctype
**enctypes
);
166 bool get_krb5_smb_session_key(TALLOC_CTX
*mem_ctx
,
167 krb5_context context
,
168 krb5_auth_context auth_context
,
169 DATA_BLOB
*session_key
, bool remote
);
170 krb5_error_code
smb_krb5_kt_free_entry(krb5_context context
, krb5_keytab_entry
*kt_entry
);
171 void kerberos_set_creds_enctype(krb5_creds
*pcreds
, int enctype
);
172 bool kerberos_compatible_enctypes(krb5_context context
, krb5_enctype enctype1
, krb5_enctype enctype2
);
173 void kerberos_free_data_contents(krb5_context context
, krb5_data
*pdata
);
174 krb5_error_code
smb_krb5_parse_name_norealm(krb5_context context
,
176 krb5_principal
*principal
);
177 bool smb_krb5_principal_compare_any_realm(krb5_context context
,
178 krb5_const_principal princ1
,
179 krb5_const_principal princ2
);
180 krb5_error_code
smb_krb5_renew_ticket(const char *ccache_string
, const char *client_string
, const char *service_string
, time_t *expire_time
);
181 krb5_error_code
smb_krb5_gen_netbios_krb5_address(smb_krb5_addresses
**kerb_addr
,
182 const char *netbios_name
);
183 krb5_error_code
smb_krb5_free_addresses(krb5_context context
, smb_krb5_addresses
*addr
);
184 NTSTATUS
krb5_to_nt_status(krb5_error_code kerberos_error
);
185 krb5_error_code
nt_status_to_krb5(NTSTATUS nt_status
);
186 void smb_krb5_free_error(krb5_context context
, krb5_error
*krberror
);
187 krb5_error_code
handle_krberror_packet(krb5_context context
,
190 void smb_krb5_get_init_creds_opt_free(krb5_context context
,
191 krb5_get_init_creds_opt
*opt
);
192 krb5_error_code
smb_krb5_get_init_creds_opt_alloc(krb5_context context
,
193 krb5_get_init_creds_opt
**opt
);
194 krb5_enctype
smb_get_enctype_from_kt_entry(krb5_keytab_entry
*kt_entry
);
195 krb5_error_code
smb_krb5_enctype_to_string(krb5_context context
,
196 krb5_enctype enctype
,
198 krb5_error_code
smb_krb5_open_keytab_relative(krb5_context context
,
199 const char *keytab_name_req
,
201 krb5_keytab
*keytab
);
202 krb5_error_code
smb_krb5_open_keytab(krb5_context context
,
203 const char *keytab_name
,
205 krb5_keytab
*keytab
);
206 krb5_error_code
smb_krb5_keytab_name(TALLOC_CTX
*mem_ctx
,
207 krb5_context context
,
209 const char **keytab_name
);
210 krb5_error_code
smb_krb5_kt_seek_and_delete_old_entries(krb5_context context
,
213 krb5_enctype enctype
,
215 krb5_principal princ
,
217 bool keep_old_entries
);
218 krb5_error_code
smb_krb5_kt_add_entry(krb5_context context
,
222 const char *salt_principal
,
223 krb5_enctype enctype
,
226 bool keep_old_entries
);
228 krb5_error_code
smb_krb5_get_credentials(krb5_context context
,
231 krb5_principal server
,
232 krb5_principal impersonate_princ
,
233 krb5_creds
**out_creds
);
234 krb5_error_code
smb_krb5_keyblock_init_contents(krb5_context context
,
235 krb5_enctype enctype
,
239 krb5_error_code
kerberos_kinit_keyblock_cc(krb5_context ctx
, krb5_ccache cc
,
240 krb5_principal principal
,
241 krb5_keyblock
*keyblock
,
242 const char *target_service
,
243 krb5_get_init_creds_opt
*krb_options
,
246 krb5_error_code
kerberos_kinit_password_cc(krb5_context ctx
,
248 krb5_principal principal
,
249 const char *password
,
250 const char *target_service
,
251 krb5_get_init_creds_opt
*krb_options
,
254 #ifdef SAMBA4_USES_HEIMDAL
255 krb5_error_code
kerberos_kinit_s4u2_cc(krb5_context ctx
,
256 krb5_ccache store_cc
,
257 krb5_principal init_principal
,
258 const char *init_password
,
259 krb5_principal impersonate_principal
,
260 const char *self_service
,
261 const char *target_service
,
262 krb5_get_init_creds_opt
*krb_options
,
267 #if defined(HAVE_KRB5_MAKE_PRINCIPAL)
268 #define smb_krb5_make_principal krb5_make_principal
269 #elif defined(HAVE_KRB5_BUILD_PRINCIPAL_ALLOC_VA)
270 krb5_error_code
smb_krb5_make_principal(krb5_context context
,
271 krb5_principal
*principal
,
272 const char *realm
, ...);
274 #error krb5_make_principal not available
277 #if defined(HAVE_KRB5_CC_GET_LIFETIME)
278 #define smb_krb5_cc_get_lifetime krb5_cc_get_lifetime
279 #elif defined(HAVE_KRB5_CC_RETRIEVE_CRED)
280 krb5_error_code
smb_krb5_cc_get_lifetime(krb5_context context
,
284 #error krb5_cc_get_lifetime not available
287 #if defined(HAVE_KRB5_FREE_CHECKSUM_CONTENTS)
288 #define smb_krb5_free_checksum_contents krb5_free_checksum_contents
289 #elif defined (HAVE_FREE_CHECKSUM)
290 void smb_krb5_free_checksum_contents(krb5_context ctx
, krb5_checksum
*cksum
);
292 #error krb5_free_checksum_contents/free_Checksum is not vailable
295 krb5_error_code
smb_krb5_make_pac_checksum(TALLOC_CTX
*mem_ctx
,
297 krb5_context context
,
298 const krb5_keyblock
*keyblock
,
300 DATA_BLOB
*sig_blob
);
302 char *smb_krb5_principal_get_realm(krb5_context context
,
303 krb5_const_principal principal
);
305 void smb_krb5_principal_set_type(krb5_context context
,
306 krb5_principal principal
,
309 krb5_error_code
smb_krb5_principal_set_realm(krb5_context context
,
310 krb5_principal principal
,
313 char *kerberos_get_principal_from_service_hostname(TALLOC_CTX
*mem_ctx
,
315 const char *remote_name
,
316 const char *default_realm
);
318 char *smb_get_krb5_error_message(krb5_context context
,
319 krb5_error_code code
,
320 TALLOC_CTX
*mem_ctx
);
322 bool unwrap_edata_ntstatus(TALLOC_CTX
*mem_ctx
,
324 DATA_BLOB
*edata_out
);
327 krb5_error_code
kt_copy(krb5_context context
,
330 krb5_error_code
kt_copy_one_principal(krb5_context context
,
333 const char *principal
,
335 const krb5_enctype
*enctypes
);
337 #if defined(HAVE_KRB5_KT_COMPARE)
338 #define smb_krb5_kt_compare krb5_kt_compare
340 krb5_boolean
smb_krb5_kt_compare(krb5_context context
,
341 krb5_keytab_entry
*entry
,
342 krb5_const_principal principal
,
344 krb5_enctype enctype
);
347 const krb5_enctype
*samba_all_enctypes(void);
349 uint32_t kerberos_enctype_to_bitmap(krb5_enctype enc_type_enum
);
350 krb5_enctype
ms_suptype_to_ietf_enctype(uint32_t enctype_bitmap
);
351 krb5_error_code
ms_suptypes_to_ietf_enctypes(TALLOC_CTX
*mem_ctx
,
352 uint32_t enctype_bitmap
,
353 krb5_enctype
**enctypes
);
354 int smb_krb5_get_pw_salt(krb5_context context
,
355 krb5_const_principal host_princ
,
358 int smb_krb5_create_key_from_string(krb5_context context
,
359 krb5_const_principal host_princ
,
362 krb5_enctype enctype
,
365 krb5_boolean
smb_krb5_get_allowed_weak_crypto(krb5_context context
);
367 #ifndef krb5_princ_size
368 #if defined(HAVE_KRB5_PRINCIPAL_GET_NUM_COMP)
369 #define krb5_princ_size krb5_principal_get_num_comp
371 #error krb5_princ_size unavailable
375 char *smb_krb5_principal_get_comp_string(TALLOC_CTX
*mem_ctx
,
376 krb5_context context
,
377 krb5_const_principal principal
,
378 unsigned int component
);
380 krb5_error_code
krb5_copy_data_contents(krb5_data
*p
,
384 int smb_krb5_principal_get_type(krb5_context context
,
385 krb5_const_principal principal
);
387 #if !defined(HAVE_KRB5_WARNX)
388 krb5_error_code
krb5_warnx(krb5_context context
, const char *fmt
, ...);
391 #endif /* HAVE_KRB5 */
393 int cli_krb5_get_ticket(TALLOC_CTX
*mem_ctx
,
394 const char *principal
, time_t time_offset
,
395 DATA_BLOB
*ticket
, DATA_BLOB
*session_key_krb5
,
396 uint32_t extra_ap_opts
, const char *ccname
,
398 const char *impersonate_princ_s
);
400 #endif /* _KRB5_SAMBA_H */