krb5-samba: interdomain trust uses different salt principal
[vlendec/samba-autobuild/.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 /*
78  * CKSUMTYPE_HMAC_SHA1_96_AES_* in Heimdal
79  * CKSUMTYPE_HMAC_SHA1_96_AES* in MIT
80  */
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
83 #endif
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
86 #endif
87
88 /*
89  * KRB5_KU_OTHER_ENCRYPTED in Heimdal
90  * KRB5_KEYUSAGE_APP_DATA_ENCRYPT in MIT
91  */
92 #if defined(KRB5_KEYUSAGE_APP_DATA_ENCRYPT) && !defined(KRB5_KU_OTHER_ENCRYPTED)
93 #define KRB5_KU_OTHER_ENCRYPTED KRB5_KEYUSAGE_APP_DATA_ENCRYPT
94 #endif
95
96 typedef struct {
97 #if defined(HAVE_MAGIC_IN_KRB5_ADDRESS) && defined(HAVE_ADDRTYPE_IN_KRB5_ADDRESS) /* MIT */
98         krb5_address **addrs;
99 #elif defined(HAVE_KRB5_ADDRESSES) /* Heimdal */
100         krb5_addresses *addrs;
101 #else
102 #error UNKNOWN_KRB5_ADDRESS_TYPE
103 #endif /* defined(HAVE_MAGIC_IN_KRB5_ADDRESS) && defined(HAVE_ADDRTYPE_IN_KRB5_ADDRESS) */
104 } smb_krb5_addresses;
105
106 #ifdef HAVE_KRB5_KEYTAB_ENTRY_KEY               /* MIT */
107 #define KRB5_KT_KEY(k)          (&(k)->key)
108 #elif HAVE_KRB5_KEYTAB_ENTRY_KEYBLOCK          /* Heimdal */
109 #define KRB5_KT_KEY(k)          (&(k)->keyblock)
110 #else
111 #error krb5_keytab_entry has no key or keyblock member
112 #endif /* HAVE_KRB5_KEYTAB_ENTRY_KEY */
113
114 /* work around broken krb5.h on sles9 */
115 #ifdef SIZEOF_LONG
116 #undef SIZEOF_LONG
117 #endif
118
119 #ifdef HAVE_KRB5_KEYBLOCK_KEYVALUE /* Heimdal */
120 #define KRB5_KEY_TYPE(k)        ((k)->keytype)
121 #define KRB5_KEY_LENGTH(k)      ((k)->keyvalue.length)
122 #define KRB5_KEY_DATA(k)        ((k)->keyvalue.data)
123 #define KRB5_KEY_DATA_CAST      void
124 #else /* MIT */
125 #define KRB5_KEY_TYPE(k)        ((k)->enctype)
126 #define KRB5_KEY_LENGTH(k)      ((k)->length)
127 #define KRB5_KEY_DATA(k)        ((k)->contents)
128 #define KRB5_KEY_DATA_CAST      krb5_octet
129 #endif /* HAVE_KRB5_KEYBLOCK_KEYVALUE */
130
131 #ifdef HAVE_E_DATA_POINTER_IN_KRB5_ERROR /* Heimdal */
132 #define KRB5_ERROR_CODE(k)      ((k)->error_code)
133 #else /* MIT */
134 #define KRB5_ERROR_CODE(k)      ((k)->error)
135 #endif /* HAVE_E_DATA_POINTER_IN_KRB5_ERROR */
136
137 krb5_error_code smb_krb5_parse_name(krb5_context context,
138                                 const char *name, /* in unix charset */
139                                 krb5_principal *principal);
140
141 krb5_error_code smb_krb5_unparse_name(TALLOC_CTX *mem_ctx,
142                                       krb5_context context,
143                                       krb5_const_principal principal,
144                                       char **unix_name);
145
146 krb5_error_code krb5_set_default_tgs_ktypes(krb5_context ctx, const krb5_enctype *enc);
147
148 #if defined(HAVE_KRB5_AUTH_CON_SETKEY) && !defined(HAVE_KRB5_AUTH_CON_SETUSERUSERKEY)
149 krb5_error_code krb5_auth_con_setuseruserkey(krb5_context context, krb5_auth_context auth_context, krb5_keyblock *keyblock);
150 #endif
151
152 #ifndef HAVE_KRB5_FREE_UNPARSED_NAME
153 void krb5_free_unparsed_name(krb5_context ctx, char *val);
154 #endif
155
156 /* Stub out initialize_krb5_error_table since it is not present in all
157  * Kerberos implementations. If it's not present, it's not necessary to
158  * call it.
159  */
160 #ifndef HAVE_INITIALIZE_KRB5_ERROR_TABLE
161 #define initialize_krb5_error_table()
162 #endif
163
164 /* Samba wrapper functions for krb5 functionality. */
165 bool smb_krb5_sockaddr_to_kaddr(struct sockaddr_storage *paddr,
166                                 krb5_address *pkaddr);
167
168 krb5_error_code smb_krb5_mk_error(krb5_context context,
169                                   krb5_error_code error_code,
170                                   const char *e_text,
171                                   krb5_data *e_data,
172                                   const krb5_principal client,
173                                   const krb5_principal server,
174                                   krb5_data *enc_err);
175
176 krb5_error_code smb_krb5_get_allowed_etypes(krb5_context context,
177                                             krb5_enctype **enctypes);
178
179 bool smb_krb5_get_smb_session_key(TALLOC_CTX *mem_ctx,
180                                   krb5_context context,
181                                   krb5_auth_context auth_context,
182                                   DATA_BLOB *session_key,
183                                   bool remote);
184
185 krb5_error_code smb_krb5_kt_free_entry(krb5_context context, krb5_keytab_entry *kt_entry);
186 void smb_krb5_free_data_contents(krb5_context context, krb5_data *pdata);
187 krb5_error_code smb_krb5_renew_ticket(const char *ccache_string, const char *client_string, const char *service_string, time_t *expire_time);
188 krb5_error_code smb_krb5_gen_netbios_krb5_address(smb_krb5_addresses **kerb_addr,
189                                                   const char *netbios_name);
190 krb5_error_code smb_krb5_free_addresses(krb5_context context, smb_krb5_addresses *addr);
191 NTSTATUS krb5_to_nt_status(krb5_error_code kerberos_error);
192 krb5_error_code nt_status_to_krb5(NTSTATUS nt_status);
193
194 krb5_enctype smb_krb5_kt_get_enctype_from_entry(krb5_keytab_entry *kt_entry);
195
196 krb5_error_code smb_krb5_enctype_to_string(krb5_context context,
197                                             krb5_enctype enctype,
198                                             char **etype_s);
199 krb5_error_code smb_krb5_kt_open_relative(krb5_context context,
200                                           const char *keytab_name_req,
201                                           bool write_access,
202                                           krb5_keytab *keytab);
203 krb5_error_code smb_krb5_kt_open(krb5_context context,
204                                  const char *keytab_name,
205                                  bool write_access,
206                                  krb5_keytab *keytab);
207 krb5_error_code smb_krb5_kt_get_name(TALLOC_CTX *mem_ctx,
208                                      krb5_context context,
209                                      krb5_keytab keytab,
210                                      const char **keytab_name);
211 krb5_error_code smb_krb5_kt_seek_and_delete_old_entries(krb5_context context,
212                                                         krb5_keytab keytab,
213                                                         krb5_kvno kvno,
214                                                         krb5_enctype enctype,
215                                                         const char *princ_s,
216                                                         krb5_principal princ,
217                                                         bool flush,
218                                                         bool keep_old_entries);
219 krb5_error_code smb_krb5_kt_add_entry(krb5_context context,
220                                       krb5_keytab keytab,
221                                       krb5_kvno kvno,
222                                       const char *princ_s,
223                                       const char *salt_principal,
224                                       krb5_enctype enctype,
225                                       krb5_data *password,
226                                       bool no_salt,
227                                       bool keep_old_entries);
228
229 krb5_error_code smb_krb5_get_credentials(krb5_context context,
230                                          krb5_ccache ccache,
231                                          krb5_principal me,
232                                          krb5_principal server,
233                                          krb5_principal impersonate_princ,
234                                          krb5_creds **out_creds);
235 krb5_error_code smb_krb5_keyblock_init_contents(krb5_context context,
236                                                 krb5_enctype enctype,
237                                                 const void *data,
238                                                 size_t length,
239                                                 krb5_keyblock *key);
240 krb5_error_code smb_krb5_kinit_keyblock_ccache(krb5_context ctx,
241                                                krb5_ccache cc,
242                                                krb5_principal principal,
243                                                krb5_keyblock *keyblock,
244                                                const char *target_service,
245                                                krb5_get_init_creds_opt *krb_options,
246                                                time_t *expire_time,
247                                                time_t *kdc_time);
248 krb5_error_code smb_krb5_kinit_password_ccache(krb5_context ctx,
249                                                krb5_ccache cc,
250                                                krb5_principal principal,
251                                                const char *password,
252                                                const char *target_service,
253                                                krb5_get_init_creds_opt *krb_options,
254                                                time_t *expire_time,
255                                                time_t *kdc_time);
256 #ifdef SAMBA4_USES_HEIMDAL
257 krb5_error_code smb_krb5_kinit_s4u2_ccache(krb5_context ctx,
258                                            krb5_ccache store_cc,
259                                            krb5_principal init_principal,
260                                            const char *init_password,
261                                            krb5_principal impersonate_principal,
262                                            const char *self_service,
263                                            const char *target_service,
264                                            krb5_get_init_creds_opt *krb_options,
265                                            time_t *expire_time,
266                                            time_t *kdc_time);
267 #endif
268
269 #if defined(HAVE_KRB5_MAKE_PRINCIPAL)
270 #define smb_krb5_make_principal krb5_make_principal
271 #elif defined(HAVE_KRB5_BUILD_PRINCIPAL_ALLOC_VA)
272 krb5_error_code smb_krb5_make_principal(krb5_context context,
273                                         krb5_principal *principal,
274                                         const char *realm, ...);
275 #else
276 #error krb5_make_principal not available
277 #endif
278
279 #if defined(HAVE_KRB5_CC_GET_LIFETIME)
280 #define smb_krb5_cc_get_lifetime krb5_cc_get_lifetime
281 #elif defined(HAVE_KRB5_CC_RETRIEVE_CRED)
282 krb5_error_code smb_krb5_cc_get_lifetime(krb5_context context,
283                                          krb5_ccache id,
284                                          time_t *t);
285 #else
286 #error krb5_cc_get_lifetime not available
287 #endif
288
289 #if defined(HAVE_KRB5_FREE_CHECKSUM_CONTENTS)
290 #define smb_krb5_free_checksum_contents krb5_free_checksum_contents
291 #elif defined (HAVE_FREE_CHECKSUM)
292 void smb_krb5_free_checksum_contents(krb5_context ctx, krb5_checksum *cksum);
293 #else
294 #error krb5_free_checksum_contents/free_Checksum is not vailable
295 #endif
296
297 krb5_error_code smb_krb5_make_pac_checksum(TALLOC_CTX *mem_ctx,
298                                            DATA_BLOB *pac_data,
299                                            krb5_context context,
300                                            const krb5_keyblock *keyblock,
301                                            uint32_t *sig_type,
302                                            DATA_BLOB *sig_blob);
303
304 char *smb_krb5_principal_get_realm(krb5_context context,
305                                    krb5_const_principal principal);
306
307 void smb_krb5_principal_set_type(krb5_context context,
308                                  krb5_principal principal,
309                                  int type);
310
311 krb5_error_code smb_krb5_principal_set_realm(krb5_context context,
312                                              krb5_principal principal,
313                                              const char *realm);
314
315 char *smb_krb5_get_realm_from_hostname(TALLOC_CTX *mem_ctx,
316                                        const char *hostname,
317                                        const char *client_realm);
318
319 char *smb_get_krb5_error_message(krb5_context context,
320                                  krb5_error_code code,
321                                  TALLOC_CTX *mem_ctx);
322
323 krb5_error_code kt_copy(krb5_context context,
324                         const char *from,
325                         const char *to);
326 krb5_error_code kt_copy_one_principal(krb5_context context,
327                                       const char *from,
328                                       const char *to,
329                                       const char *principal,
330                                       krb5_kvno kvno,
331                                       const krb5_enctype *enctypes);
332
333 #if defined(HAVE_KRB5_KT_COMPARE)
334 #define smb_krb5_kt_compare krb5_kt_compare
335 #else
336 krb5_boolean smb_krb5_kt_compare(krb5_context context,
337                                  krb5_keytab_entry *entry,
338                                  krb5_const_principal principal,
339                                  krb5_kvno vno,
340                                  krb5_enctype enctype);
341 #endif
342
343 const krb5_enctype *samba_all_enctypes(void);
344
345 uint32_t kerberos_enctype_to_bitmap(krb5_enctype enc_type_enum);
346 krb5_enctype ms_suptype_to_ietf_enctype(uint32_t enctype_bitmap);
347 krb5_error_code ms_suptypes_to_ietf_enctypes(TALLOC_CTX *mem_ctx,
348                                              uint32_t enctype_bitmap,
349                                              krb5_enctype **enctypes);
350 int smb_krb5_get_pw_salt(krb5_context context,
351                          krb5_const_principal host_princ,
352                          krb5_data *psalt);
353 int smb_krb5_salt_principal(const char *realm,
354                             const char *sAMAccountName,
355                             const char *userPrincipalName,
356                             uint32_t uac_flags,
357                             TALLOC_CTX *mem_ctx,
358                             char **_salt_principal);
359 int smb_krb5_salt_principal2data(krb5_context context,
360                                  const char *salt_principal,
361                                  TALLOC_CTX *mem_ctx,
362                                  char **_salt_data);
363
364 int smb_krb5_create_key_from_string(krb5_context context,
365                                     krb5_const_principal host_princ,
366                                     krb5_data *salt,
367                                     krb5_data *password,
368                                     krb5_enctype enctype,
369                                     krb5_keyblock *key);
370
371 krb5_boolean smb_krb5_get_allowed_weak_crypto(krb5_context context);
372
373 #ifndef krb5_princ_size
374 #if defined(HAVE_KRB5_PRINCIPAL_GET_NUM_COMP)
375 #define krb5_princ_size krb5_principal_get_num_comp
376 #else
377 #error krb5_princ_size unavailable
378 #endif
379 #endif
380
381 char *smb_krb5_principal_get_comp_string(TALLOC_CTX *mem_ctx,
382                                          krb5_context context,
383                                          krb5_const_principal principal,
384                                          unsigned int component);
385
386 krb5_error_code smb_krb5_copy_data_contents(krb5_data *p,
387                                             const void *data,
388                                             size_t len);
389
390 int smb_krb5_principal_get_type(krb5_context context,
391                                 krb5_const_principal principal);
392
393 #if !defined(HAVE_KRB5_WARNX)
394 krb5_error_code krb5_warnx(krb5_context context, const char *fmt, ...);
395 #endif
396
397 krb5_error_code smb_krb5_cc_copy_creds(krb5_context context,
398                                        krb5_ccache incc, krb5_ccache outcc);
399
400 #endif /* HAVE_KRB5 */
401
402 int ads_krb5_cli_get_ticket(TALLOC_CTX *mem_ctx,
403                             const char *principal,
404                             time_t time_offset,
405                             DATA_BLOB *ticket,
406                             DATA_BLOB *session_key_krb5,
407                             uint32_t extra_ap_opts, const char *ccname,
408                             time_t *tgs_expire,
409                             const char *impersonate_princ_s);
410
411 #endif /* _KRB5_SAMBA_H */