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
57 /* The older versions of heimdal that don't have this
58 define don't seem to use it anyway. I'm told they
59 always use a subkey */
60 #ifndef HAVE_AP_OPTS_USE_SUBKEY
61 #define AP_OPTS_USE_SUBKEY 0
64 #ifndef krb5_princ_size
65 #if defined(HAVE_KRB5_KRB5_PRINCIPAL_GET_NUM_COMP)
66 #define krb5_princ_size krb5_principal_get_num_comp
68 #error krb5_princ_size unavailable
73 #if defined(HAVE_MAGIC_IN_KRB5_ADDRESS) && defined(HAVE_ADDRTYPE_IN_KRB5_ADDRESS) /* MIT */
75 #elif defined(HAVE_KRB5_ADDRESSES) /* Heimdal */
76 krb5_addresses *addrs;
78 #error UNKNOWN_KRB5_ADDRESS_TYPE
79 #endif /* defined(HAVE_MAGIC_IN_KRB5_ADDRESS) && defined(HAVE_ADDRTYPE_IN_KRB5_ADDRESS) */
82 #ifdef HAVE_KRB5_KEYTAB_ENTRY_KEY /* MIT */
83 #define KRB5_KT_KEY(k) (&(k)->key)
84 #elif HAVE_KRB5_KEYTAB_ENTRY_KEYBLOCK /* Heimdal */
85 #define KRB5_KT_KEY(k) (&(k)->keyblock)
87 #error krb5_keytab_entry has no key or keyblock member
88 #endif /* HAVE_KRB5_KEYTAB_ENTRY_KEY */
90 /* work around broken krb5.h on sles9 */
95 #ifdef HAVE_KRB5_KEYBLOCK_KEYVALUE /* Heimdal */
96 #define KRB5_KEY_TYPE(k) ((k)->keytype)
97 #define KRB5_KEY_LENGTH(k) ((k)->keyvalue.length)
98 #define KRB5_KEY_DATA(k) ((k)->keyvalue.data)
99 #define KRB5_KEY_DATA_CAST void
101 #define KRB5_KEY_TYPE(k) ((k)->enctype)
102 #define KRB5_KEY_LENGTH(k) ((k)->length)
103 #define KRB5_KEY_DATA(k) ((k)->contents)
104 #define KRB5_KEY_DATA_CAST krb5_octet
105 #endif /* HAVE_KRB5_KEYBLOCK_KEYVALUE */
107 krb5_error_code smb_krb5_parse_name(krb5_context context,
108 const char *name, /* in unix charset */
109 krb5_principal *principal);
111 krb5_error_code smb_krb5_unparse_name(TALLOC_CTX *mem_ctx,
112 krb5_context context,
113 krb5_const_principal principal,
116 krb5_error_code krb5_set_default_tgs_ktypes(krb5_context ctx, const krb5_enctype *enc);
118 #if defined(HAVE_KRB5_AUTH_CON_SETKEY) && !defined(HAVE_KRB5_AUTH_CON_SETUSERUSERKEY)
119 krb5_error_code krb5_auth_con_setuseruserkey(krb5_context context, krb5_auth_context auth_context, krb5_keyblock *keyblock);
122 #ifndef HAVE_KRB5_FREE_UNPARSED_NAME
123 void krb5_free_unparsed_name(krb5_context ctx, char *val);
126 /* Stub out initialize_krb5_error_table since it is not present in all
127 * Kerberos implementations. If it's not present, it's not necessary to
130 #ifndef HAVE_INITIALIZE_KRB5_ERROR_TABLE
131 #define initialize_krb5_error_table()
134 /* Samba wrapper functions for krb5 functionality. */
135 bool setup_kaddr( krb5_address *pkaddr, struct sockaddr_storage *paddr);
136 int create_kerberos_key_from_string(krb5_context context,
137 krb5_principal host_princ,
140 krb5_enctype enctype,
142 int create_kerberos_key_from_string_direct(krb5_context context,
143 krb5_principal host_princ,
146 krb5_enctype enctype);
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 kpasswd_err_to_krb5_err(krb5_error_code res_code);
165 krb5_error_code smb_krb5_gen_netbios_krb5_address(smb_krb5_addresses **kerb_addr,
166 const char *netbios_name);
167 krb5_error_code smb_krb5_free_addresses(krb5_context context, smb_krb5_addresses *addr);
168 NTSTATUS krb5_to_nt_status(krb5_error_code kerberos_error);
169 krb5_error_code nt_status_to_krb5(NTSTATUS nt_status);
170 void smb_krb5_free_error(krb5_context context, krb5_error *krberror);
171 krb5_error_code handle_krberror_packet(krb5_context context,
174 void smb_krb5_get_init_creds_opt_free(krb5_context context,
175 krb5_get_init_creds_opt *opt);
176 krb5_error_code smb_krb5_get_init_creds_opt_alloc(krb5_context context,
177 krb5_get_init_creds_opt **opt);
178 krb5_enctype smb_get_enctype_from_kt_entry(krb5_keytab_entry *kt_entry);
179 krb5_error_code smb_krb5_enctype_to_string(krb5_context context,
180 krb5_enctype enctype,
182 krb5_error_code smb_krb5_open_keytab(krb5_context context,
183 const char *keytab_name,
185 krb5_keytab *keytab);
186 krb5_error_code smb_krb5_keytab_name(TALLOC_CTX *mem_ctx,
187 krb5_context context,
189 const char **keytab_name);
190 krb5_error_code smb_krb5_get_credentials(krb5_context context,
193 krb5_principal server,
194 krb5_principal impersonate_princ,
195 krb5_creds **out_creds);
196 krb5_error_code smb_krb5_get_creds(const char *server_s,
199 const char *impersonate_princ_s,
200 krb5_creds **creds_p);
201 krb5_error_code smb_krb5_keyblock_init_contents(krb5_context context,
202 krb5_enctype enctype,
206 krb5_error_code kerberos_kinit_keyblock_cc(krb5_context ctx, krb5_ccache cc,
207 krb5_principal principal,
208 krb5_keyblock *keyblock,
209 const char *target_service,
210 krb5_get_init_creds_opt *krb_options,
213 krb5_error_code kerberos_kinit_password_cc(krb5_context ctx,
215 krb5_principal principal,
216 const char *password,
217 const char *target_service,
218 krb5_get_init_creds_opt *krb_options,
221 #ifdef SAMBA4_USES_HEIMDAL
222 krb5_error_code kerberos_kinit_s4u2_cc(krb5_context ctx,
223 krb5_ccache store_cc,
224 krb5_principal init_principal,
225 const char *init_password,
226 krb5_principal impersonate_principal,
227 const char *self_service,
228 const char *target_service,
229 krb5_get_init_creds_opt *krb_options,
234 #if defined(HAVE_KRB5_MAKE_PRINCIPAL)
235 #define smb_krb5_make_principal krb5_make_principal
236 #elif defined(HAVE_KRB5_BUILD_PRINCIPAL_ALLOC_VA)
237 krb5_error_code smb_krb5_make_principal(krb5_context context,
238 krb5_principal *principal,
239 const char *realm, ...);
241 #error krb5_make_principal not available
244 #if defined(HAVE_KRB5_CC_GET_LIFETIME)
245 #define smb_krb5_cc_get_lifetime krb5_cc_get_lifetime
246 #elif defined(HAVE_KRB5_CC_RETRIEVE_CRED)
247 krb5_error_code smb_krb5_cc_get_lifetime(krb5_context context,
251 #error krb5_cc_get_lifetime not available
254 #if defined(HAVE_KRB5_FREE_CHECKSUM_CONTENTS)
255 #define smb_krb5_free_checksum_contents krb5_free_checksum_contents
256 #elif defined (HAVE_FREE_CHECKSUM)
257 void smb_krb5_free_checksum_contents(krb5_context ctx, krb5_checksum *cksum);
259 #error krb5_free_checksum_contents/free_Checksum is not vailable
262 char *smb_krb5_principal_get_realm(krb5_context context,
263 krb5_principal principal);
265 char *kerberos_get_principal_from_service_hostname(TALLOC_CTX *mem_ctx,
267 const char *remote_name,
268 const char *default_realm);
270 char *smb_get_krb5_error_message(krb5_context context,
271 krb5_error_code code,
272 TALLOC_CTX *mem_ctx);
274 bool unwrap_edata_ntstatus(TALLOC_CTX *mem_ctx,
276 DATA_BLOB *edata_out);
279 krb5_error_code kt_copy(krb5_context context,
282 krb5_error_code kt_copy_one_principal(krb5_context context,
285 const char *principal,
287 krb5_enctype *enctypes);
289 #if defined(HAVE_KRB5_KT_COMPARE)
290 #define smb_krb5_kt_compare krb5_kt_compare
292 krb5_boolean smb_krb5_kt_compare(krb5_context context,
293 krb5_keytab_entry *entry,
294 krb5_const_principal principal,
296 krb5_enctype enctype);
299 #endif /* HAVE_KRB5 */
301 int cli_krb5_get_ticket(TALLOC_CTX *mem_ctx,
302 const char *principal, time_t time_offset,
303 DATA_BLOB *ticket, DATA_BLOB *session_key_krb5,
304 uint32_t extra_ap_opts, const char *ccname,
306 const char *impersonate_princ_s);
308 #endif /* _KRB5_SAMBA_H */