lib: Use poll_intr_one_fd in ctdb_read_packet
[Samba.git] / lib / krb5_wrap / krb5_samba.h
blobcef9144a17e8bd3049932ba0bd3efdc45b0f9f07
1 /*
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/>.
23 #ifndef _KRB5_SAMBA_H
24 #define _KRB5_SAMBA_H
26 #ifdef HAVE_KRB5
28 #define KRB5_PRIVATE 1 /* this file uses PRIVATE interfaces! */
29 /* this file uses DEPRECATED interfaces! */
31 #ifdef KRB5_DEPRECATED
32 #undef KRB5_DEPRECATED
33 #endif
35 #if defined(HAVE_KRB5_DEPRECATED_WITH_IDENTIFIER)
36 #define KRB5_DEPRECATED 1
37 #else
38 #define KRB5_DEPRECATED
39 #endif
41 #include "system/kerberos.h"
42 #include "system/network.h"
44 #ifndef KRB5_ADDR_NETBIOS
45 #define KRB5_ADDR_NETBIOS 0x14
46 #endif
48 #ifndef KRB5KRB_ERR_RESPONSE_TOO_BIG
49 #define KRB5KRB_ERR_RESPONSE_TOO_BIG (-1765328332L)
50 #endif
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
55 #endif
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
58 #endif
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
65 #endif
67 #ifndef KRB5_PW_SALT
68 #define KRB5_PW_SALT 3
69 #endif
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
75 #endif
77 typedef struct {
78 #if defined(HAVE_MAGIC_IN_KRB5_ADDRESS) && defined(HAVE_ADDRTYPE_IN_KRB5_ADDRESS) /* MIT */
79 krb5_address **addrs;
80 #elif defined(HAVE_KRB5_ADDRESSES) /* Heimdal */
81 krb5_addresses *addrs;
82 #else
83 #error UNKNOWN_KRB5_ADDRESS_TYPE
84 #endif /* defined(HAVE_MAGIC_IN_KRB5_ADDRESS) && defined(HAVE_ADDRTYPE_IN_KRB5_ADDRESS) */
85 } smb_krb5_addresses;
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)
91 #else
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 */
96 #ifdef SIZEOF_LONG
97 #undef SIZEOF_LONG
98 #endif
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
105 #else /* MIT */
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)
114 #else /* MIT */
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,
125 char **unix_name);
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);
131 #endif
133 #ifndef HAVE_KRB5_FREE_UNPARSED_NAME
134 void krb5_free_unparsed_name(krb5_context ctx, char *val);
135 #endif
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
139 * call it.
141 #ifndef HAVE_INITIALIZE_KRB5_ERROR_TABLE
142 #define initialize_krb5_error_table()
143 #endif
145 /* Samba wrapper functions for krb5 functionality. */
146 bool setup_kaddr( krb5_address *pkaddr, struct sockaddr_storage *paddr);
147 int create_kerberos_key_from_string(krb5_context context,
148 krb5_principal host_princ,
149 krb5_data *password,
150 krb5_keyblock *key,
151 krb5_enctype enctype,
152 bool no_salt);
154 krb5_error_code get_kerberos_allowed_etypes(krb5_context context, krb5_enctype **enctypes);
155 bool get_krb5_smb_session_key(TALLOC_CTX *mem_ctx,
156 krb5_context context,
157 krb5_auth_context auth_context,
158 DATA_BLOB *session_key, bool remote);
159 krb5_error_code smb_krb5_kt_free_entry(krb5_context context, krb5_keytab_entry *kt_entry);
160 void kerberos_set_creds_enctype(krb5_creds *pcreds, int enctype);
161 bool kerberos_compatible_enctypes(krb5_context context, krb5_enctype enctype1, krb5_enctype enctype2);
162 void kerberos_free_data_contents(krb5_context context, krb5_data *pdata);
163 krb5_error_code smb_krb5_parse_name_norealm(krb5_context context,
164 const char *name,
165 krb5_principal *principal);
166 bool smb_krb5_principal_compare_any_realm(krb5_context context,
167 krb5_const_principal princ1,
168 krb5_const_principal princ2);
169 krb5_error_code smb_krb5_renew_ticket(const char *ccache_string, const char *client_string, const char *service_string, time_t *expire_time);
170 krb5_error_code smb_krb5_gen_netbios_krb5_address(smb_krb5_addresses **kerb_addr,
171 const char *netbios_name);
172 krb5_error_code smb_krb5_free_addresses(krb5_context context, smb_krb5_addresses *addr);
173 NTSTATUS krb5_to_nt_status(krb5_error_code kerberos_error);
174 krb5_error_code nt_status_to_krb5(NTSTATUS nt_status);
175 void smb_krb5_free_error(krb5_context context, krb5_error *krberror);
176 krb5_error_code handle_krberror_packet(krb5_context context,
177 krb5_data *packet);
179 void smb_krb5_get_init_creds_opt_free(krb5_context context,
180 krb5_get_init_creds_opt *opt);
181 krb5_error_code smb_krb5_get_init_creds_opt_alloc(krb5_context context,
182 krb5_get_init_creds_opt **opt);
183 krb5_enctype smb_get_enctype_from_kt_entry(krb5_keytab_entry *kt_entry);
184 krb5_error_code smb_krb5_enctype_to_string(krb5_context context,
185 krb5_enctype enctype,
186 char **etype_s);
187 krb5_error_code smb_krb5_open_keytab(krb5_context context,
188 const char *keytab_name,
189 bool write_access,
190 krb5_keytab *keytab);
191 krb5_error_code smb_krb5_keytab_name(TALLOC_CTX *mem_ctx,
192 krb5_context context,
193 krb5_keytab keytab,
194 const char **keytab_name);
195 krb5_error_code smb_krb5_get_credentials(krb5_context context,
196 krb5_ccache ccache,
197 krb5_principal me,
198 krb5_principal server,
199 krb5_principal impersonate_princ,
200 krb5_creds **out_creds);
201 krb5_error_code smb_krb5_keyblock_init_contents(krb5_context context,
202 krb5_enctype enctype,
203 const void *data,
204 size_t length,
205 krb5_keyblock *key);
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,
211 time_t *expire_time,
212 time_t *kdc_time);
213 krb5_error_code kerberos_kinit_password_cc(krb5_context ctx,
214 krb5_ccache cc,
215 krb5_principal principal,
216 const char *password,
217 const char *target_service,
218 krb5_get_init_creds_opt *krb_options,
219 time_t *expire_time,
220 time_t *kdc_time);
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,
230 time_t *expire_time,
231 time_t *kdc_time);
232 #endif
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, ...);
240 #else
241 #error krb5_make_principal not available
242 #endif
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,
248 krb5_ccache id,
249 time_t *t);
250 #else
251 #error krb5_cc_get_lifetime not available
252 #endif
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);
258 #else
259 #error krb5_free_checksum_contents/free_Checksum is not vailable
260 #endif
262 krb5_error_code smb_krb5_make_pac_checksum(TALLOC_CTX *mem_ctx,
263 DATA_BLOB *pac_data,
264 krb5_context context,
265 const krb5_keyblock *keyblock,
266 uint32_t *sig_type,
267 DATA_BLOB *sig_blob);
269 char *smb_krb5_principal_get_realm(krb5_context context,
270 krb5_const_principal principal);
272 void smb_krb5_principal_set_type(krb5_context context,
273 krb5_principal principal,
274 int type);
276 krb5_error_code smb_krb5_principal_set_realm(krb5_context context,
277 krb5_principal principal,
278 const char *realm);
280 char *kerberos_get_principal_from_service_hostname(TALLOC_CTX *mem_ctx,
281 const char *service,
282 const char *remote_name,
283 const char *default_realm);
285 char *smb_get_krb5_error_message(krb5_context context,
286 krb5_error_code code,
287 TALLOC_CTX *mem_ctx);
289 bool unwrap_edata_ntstatus(TALLOC_CTX *mem_ctx,
290 DATA_BLOB *edata,
291 DATA_BLOB *edata_out);
294 krb5_error_code kt_copy(krb5_context context,
295 const char *from,
296 const char *to);
297 krb5_error_code kt_copy_one_principal(krb5_context context,
298 const char *from,
299 const char *to,
300 const char *principal,
301 krb5_kvno kvno,
302 const krb5_enctype *enctypes);
304 #if defined(HAVE_KRB5_KT_COMPARE)
305 #define smb_krb5_kt_compare krb5_kt_compare
306 #else
307 krb5_boolean smb_krb5_kt_compare(krb5_context context,
308 krb5_keytab_entry *entry,
309 krb5_const_principal principal,
310 krb5_kvno vno,
311 krb5_enctype enctype);
312 #endif
314 const krb5_enctype *samba_all_enctypes(void);
316 uint32_t kerberos_enctype_to_bitmap(krb5_enctype enc_type_enum);
317 krb5_enctype ms_suptype_to_ietf_enctype(uint32_t enctype_bitmap);
318 krb5_error_code ms_suptypes_to_ietf_enctypes(TALLOC_CTX *mem_ctx,
319 uint32_t enctype_bitmap,
320 krb5_enctype **enctypes);
321 int smb_krb5_get_pw_salt(krb5_context context,
322 krb5_const_principal host_princ,
323 krb5_data *psalt);
325 int smb_krb5_create_key_from_string(krb5_context context,
326 krb5_const_principal host_princ,
327 krb5_data *salt,
328 krb5_data *password,
329 krb5_enctype enctype,
330 krb5_keyblock *key);
332 krb5_boolean smb_krb5_get_allowed_weak_crypto(krb5_context context);
334 #ifndef krb5_princ_size
335 #if defined(HAVE_KRB5_PRINCIPAL_GET_NUM_COMP)
336 #define krb5_princ_size krb5_principal_get_num_comp
337 #else
338 #error krb5_princ_size unavailable
339 #endif
340 #endif
342 char *smb_krb5_principal_get_comp_string(TALLOC_CTX *mem_ctx,
343 krb5_context context,
344 krb5_const_principal principal,
345 unsigned int component);
347 krb5_error_code krb5_copy_data_contents(krb5_data *p,
348 const void *data,
349 size_t len);
351 int smb_krb5_principal_get_type(krb5_context context,
352 krb5_const_principal principal);
354 #if !defined(HAVE_KRB5_WARNX)
355 krb5_error_code krb5_warnx(krb5_context context, const char *fmt, ...);
356 #endif
358 #endif /* HAVE_KRB5 */
360 int cli_krb5_get_ticket(TALLOC_CTX *mem_ctx,
361 const char *principal, time_t time_offset,
362 DATA_BLOB *ticket, DATA_BLOB *session_key_krb5,
363 uint32_t extra_ap_opts, const char *ccname,
364 time_t *tgs_expire,
365 const char *impersonate_princ_s);
367 #endif /* _KRB5_SAMBA_H */