krb5_wrap: Add smb_krb5_open_keytab_relative() function
[samba.git] / lib / krb5_wrap / krb5_samba.h
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
8
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.
13
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.
18
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/>.
21 */
22
23 #ifndef _KRB5_SAMBA_H
24 #define _KRB5_SAMBA_H
25
26 #ifdef HAVE_KRB5
27
28 #define KRB5_PRIVATE    1       /* this file uses PRIVATE interfaces! */
29 /* this file uses DEPRECATED interfaces! */
30
31 #ifdef KRB5_DEPRECATED
32 #undef KRB5_DEPRECATED
33 #endif
34
35 #if defined(HAVE_KRB5_DEPRECATED_WITH_IDENTIFIER)
36 #define KRB5_DEPRECATED 1
37 #else
38 #define KRB5_DEPRECATED
39 #endif
40
41 #include "system/kerberos.h"
42 #include "system/network.h"
43
44 #ifndef KRB5_ADDR_NETBIOS
45 #define KRB5_ADDR_NETBIOS 0x14
46 #endif
47
48 #ifndef KRB5KRB_ERR_RESPONSE_TOO_BIG
49 #define KRB5KRB_ERR_RESPONSE_TOO_BIG (-1765328332L)
50 #endif
51
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
59
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
66
67 #ifndef KRB5_PW_SALT
68 #define KRB5_PW_SALT 3
69 #endif
70
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
76
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;
86
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 */
94
95 /* work around broken krb5.h on sles9 */
96 #ifdef SIZEOF_LONG
97 #undef SIZEOF_LONG
98 #endif
99
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 */
111
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 */
117
118 krb5_error_code smb_krb5_parse_name(krb5_context context,
119                                 const char *name, /* in unix charset */
120                                 krb5_principal *principal);
121
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);
126
127 krb5_error_code krb5_set_default_tgs_ktypes(krb5_context ctx, const krb5_enctype *enc);
128
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
132
133 #ifndef HAVE_KRB5_FREE_UNPARSED_NAME
134 void krb5_free_unparsed_name(krb5_context ctx, char *val);
135 #endif
136
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.
140  */
141 #ifndef HAVE_INITIALIZE_KRB5_ERROR_TABLE
142 #define initialize_krb5_error_table()
143 #endif
144
145 /* Samba wrapper functions for krb5 functionality. */
146 bool setup_kaddr( krb5_address *pkaddr, struct sockaddr_storage *paddr);
147
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,
158                                             const char *name,
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,
171                                          krb5_data *packet);
172
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,
180                                             char **etype_s);
181 krb5_error_code smb_krb5_open_keytab_relative(krb5_context context,
182                                               const char *keytab_name_req,
183                                               bool write_access,
184                                               krb5_keytab *keytab);
185 krb5_error_code smb_krb5_open_keytab(krb5_context context,
186                                       const char *keytab_name,
187                                       bool write_access,
188                                       krb5_keytab *keytab);
189 krb5_error_code smb_krb5_keytab_name(TALLOC_CTX *mem_ctx,
190                                      krb5_context context,
191                                      krb5_keytab keytab,
192                                      const char **keytab_name);
193 krb5_error_code smb_krb5_kt_seek_and_delete_old_entries(krb5_context context,
194                                                         krb5_keytab keytab,
195                                                         krb5_kvno kvno,
196                                                         const char *princ_s,
197                                                         krb5_principal princ,
198                                                         bool flush,
199                                                         bool keep_old_entries);
200 krb5_error_code smb_krb5_kt_add_entry(krb5_context context,
201                                       krb5_keytab keytab,
202                                       krb5_kvno kvno,
203                                       const char *princ_s,
204                                       const char *salt_principal,
205                                       krb5_enctype enctype,
206                                       krb5_data *password,
207                                       bool no_salt,
208                                       bool keep_old_entries);
209
210 krb5_error_code smb_krb5_get_credentials(krb5_context context,
211                                          krb5_ccache ccache,
212                                          krb5_principal me,
213                                          krb5_principal server,
214                                          krb5_principal impersonate_princ,
215                                          krb5_creds **out_creds);
216 krb5_error_code smb_krb5_keyblock_init_contents(krb5_context context,
217                                                 krb5_enctype enctype,
218                                                 const void *data,
219                                                 size_t length,
220                                                 krb5_keyblock *key);
221 krb5_error_code kerberos_kinit_keyblock_cc(krb5_context ctx, krb5_ccache cc,
222                                            krb5_principal principal,
223                                            krb5_keyblock *keyblock,
224                                            const char *target_service,
225                                            krb5_get_init_creds_opt *krb_options,
226                                            time_t *expire_time,
227                                            time_t *kdc_time);
228 krb5_error_code kerberos_kinit_password_cc(krb5_context ctx,
229                                            krb5_ccache cc,
230                                            krb5_principal principal,
231                                            const char *password,
232                                            const char *target_service,
233                                            krb5_get_init_creds_opt *krb_options,
234                                            time_t *expire_time,
235                                            time_t *kdc_time);
236 #ifdef SAMBA4_USES_HEIMDAL
237 krb5_error_code kerberos_kinit_s4u2_cc(krb5_context ctx,
238                                         krb5_ccache store_cc,
239                                         krb5_principal init_principal,
240                                         const char *init_password,
241                                         krb5_principal impersonate_principal,
242                                         const char *self_service,
243                                         const char *target_service,
244                                         krb5_get_init_creds_opt *krb_options,
245                                         time_t *expire_time,
246                                         time_t *kdc_time);
247 #endif
248
249 #if defined(HAVE_KRB5_MAKE_PRINCIPAL)
250 #define smb_krb5_make_principal krb5_make_principal
251 #elif defined(HAVE_KRB5_BUILD_PRINCIPAL_ALLOC_VA)
252 krb5_error_code smb_krb5_make_principal(krb5_context context,
253                                         krb5_principal *principal,
254                                         const char *realm, ...);
255 #else
256 #error krb5_make_principal not available
257 #endif
258
259 #if defined(HAVE_KRB5_CC_GET_LIFETIME)
260 #define smb_krb5_cc_get_lifetime krb5_cc_get_lifetime
261 #elif defined(HAVE_KRB5_CC_RETRIEVE_CRED)
262 krb5_error_code smb_krb5_cc_get_lifetime(krb5_context context,
263                                          krb5_ccache id,
264                                          time_t *t);
265 #else
266 #error krb5_cc_get_lifetime not available
267 #endif
268
269 #if defined(HAVE_KRB5_FREE_CHECKSUM_CONTENTS)
270 #define smb_krb5_free_checksum_contents krb5_free_checksum_contents
271 #elif defined (HAVE_FREE_CHECKSUM)
272 void smb_krb5_free_checksum_contents(krb5_context ctx, krb5_checksum *cksum);
273 #else
274 #error krb5_free_checksum_contents/free_Checksum is not vailable
275 #endif
276
277 krb5_error_code smb_krb5_make_pac_checksum(TALLOC_CTX *mem_ctx,
278                                            DATA_BLOB *pac_data,
279                                            krb5_context context,
280                                            const krb5_keyblock *keyblock,
281                                            uint32_t *sig_type,
282                                            DATA_BLOB *sig_blob);
283
284 char *smb_krb5_principal_get_realm(krb5_context context,
285                                    krb5_const_principal principal);
286
287 void smb_krb5_principal_set_type(krb5_context context,
288                                  krb5_principal principal,
289                                  int type);
290
291 krb5_error_code smb_krb5_principal_set_realm(krb5_context context,
292                                              krb5_principal principal,
293                                              const char *realm);
294
295 char *kerberos_get_principal_from_service_hostname(TALLOC_CTX *mem_ctx,
296                                                    const char *service,
297                                                    const char *remote_name,
298                                                    const char *default_realm);
299
300 char *smb_get_krb5_error_message(krb5_context context,
301                                  krb5_error_code code,
302                                  TALLOC_CTX *mem_ctx);
303
304 bool unwrap_edata_ntstatus(TALLOC_CTX *mem_ctx,
305                            DATA_BLOB *edata,
306                            DATA_BLOB *edata_out);
307
308
309 krb5_error_code kt_copy(krb5_context context,
310                         const char *from,
311                         const char *to);
312 krb5_error_code kt_copy_one_principal(krb5_context context,
313                                       const char *from,
314                                       const char *to,
315                                       const char *principal,
316                                       krb5_kvno kvno,
317                                       const krb5_enctype *enctypes);
318
319 #if defined(HAVE_KRB5_KT_COMPARE)
320 #define smb_krb5_kt_compare krb5_kt_compare
321 #else
322 krb5_boolean smb_krb5_kt_compare(krb5_context context,
323                                  krb5_keytab_entry *entry,
324                                  krb5_const_principal principal,
325                                  krb5_kvno vno,
326                                  krb5_enctype enctype);
327 #endif
328
329 const krb5_enctype *samba_all_enctypes(void);
330
331 uint32_t kerberos_enctype_to_bitmap(krb5_enctype enc_type_enum);
332 krb5_enctype ms_suptype_to_ietf_enctype(uint32_t enctype_bitmap);
333 krb5_error_code ms_suptypes_to_ietf_enctypes(TALLOC_CTX *mem_ctx,
334                                              uint32_t enctype_bitmap,
335                                              krb5_enctype **enctypes);
336 int smb_krb5_get_pw_salt(krb5_context context,
337                          krb5_const_principal host_princ,
338                          krb5_data *psalt);
339
340 int smb_krb5_create_key_from_string(krb5_context context,
341                                     krb5_const_principal host_princ,
342                                     krb5_data *salt,
343                                     krb5_data *password,
344                                     krb5_enctype enctype,
345                                     krb5_keyblock *key);
346
347 krb5_boolean smb_krb5_get_allowed_weak_crypto(krb5_context context);
348
349 #ifndef krb5_princ_size
350 #if defined(HAVE_KRB5_PRINCIPAL_GET_NUM_COMP)
351 #define krb5_princ_size krb5_principal_get_num_comp
352 #else
353 #error krb5_princ_size unavailable
354 #endif
355 #endif
356
357 char *smb_krb5_principal_get_comp_string(TALLOC_CTX *mem_ctx,
358                                          krb5_context context,
359                                          krb5_const_principal principal,
360                                          unsigned int component);
361
362 krb5_error_code krb5_copy_data_contents(krb5_data *p,
363                                         const void *data,
364                                         size_t len);
365
366 int smb_krb5_principal_get_type(krb5_context context,
367                                 krb5_const_principal principal);
368
369 #if !defined(HAVE_KRB5_WARNX)
370 krb5_error_code krb5_warnx(krb5_context context, const char *fmt, ...);
371 #endif
372
373 #endif /* HAVE_KRB5 */
374
375 int cli_krb5_get_ticket(TALLOC_CTX *mem_ctx,
376                         const char *principal, time_t time_offset,
377                         DATA_BLOB *ticket, DATA_BLOB *session_key_krb5,
378                         uint32_t extra_ap_opts, const char *ccname,
379                         time_t *tgs_expire,
380                         const char *impersonate_princ_s);
381
382 #endif /* _KRB5_SAMBA_H */