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                                   krb5_data *enc_err);
 173
 174 krb5_error_code get_kerberos_allowed_etypes(krb5_context context, krb5_enctype **enctypes);
 175 bool get_krb5_smb_session_key(TALLOC_CTX *mem_ctx,
 176                               krb5_context context,
 177                               krb5_auth_context auth_context,
 178                               DATA_BLOB *session_key, bool remote);
 179 krb5_error_code smb_krb5_kt_free_entry(krb5_context context, krb5_keytab_entry *kt_entry);
 180 void kerberos_set_creds_enctype(krb5_creds *pcreds, int enctype);
 181 bool kerberos_compatible_enctypes(krb5_context context, krb5_enctype enctype1, krb5_enctype enctype2);
 182 void kerberos_free_data_contents(krb5_context context, krb5_data *pdata);
 183 krb5_error_code smb_krb5_parse_name_norealm(krb5_context context,
 184                                             const char *name,
 185                                             krb5_principal *principal);
 186 bool smb_krb5_principal_compare_any_realm(krb5_context context,
 187                                           krb5_const_principal princ1,
 188                                           krb5_const_principal princ2);
 189 krb5_error_code smb_krb5_renew_ticket(const char *ccache_string, const char *client_string, const char *service_string, time_t *expire_time);
 190 krb5_error_code smb_krb5_gen_netbios_krb5_address(smb_krb5_addresses **kerb_addr,
 191                                                   const char *netbios_name);
 192 krb5_error_code smb_krb5_free_addresses(krb5_context context, smb_krb5_addresses *addr);
 193 NTSTATUS krb5_to_nt_status(krb5_error_code kerberos_error);
 194 krb5_error_code nt_status_to_krb5(NTSTATUS nt_status);
 195 void smb_krb5_free_error(krb5_context context, krb5_error *krberror);
 196 krb5_error_code handle_krberror_packet(krb5_context context,
 197                                          krb5_data *packet);
 198
 199 void smb_krb5_get_init_creds_opt_free(krb5_context context,
 200                                     krb5_get_init_creds_opt *opt);
 201 krb5_error_code smb_krb5_get_init_creds_opt_alloc(krb5_context context,
 202                                     krb5_get_init_creds_opt **opt);
 203 krb5_enctype smb_get_enctype_from_kt_entry(krb5_keytab_entry *kt_entry);
 204 krb5_error_code smb_krb5_enctype_to_string(krb5_context context,
 205                                             krb5_enctype enctype,
 206                                             char **etype_s);
 207 krb5_error_code smb_krb5_open_keytab_relative(krb5_context context,
 208                                               const char *keytab_name_req,
 209                                               bool write_access,
 210                                               krb5_keytab *keytab);
 211 krb5_error_code smb_krb5_open_keytab(krb5_context context,
 212                                       const char *keytab_name,
 213                                       bool write_access,
 214                                       krb5_keytab *keytab);
 215 krb5_error_code smb_krb5_keytab_name(TALLOC_CTX *mem_ctx,
 216                                      krb5_context context,
 217                                      krb5_keytab keytab,
 218                                      const char **keytab_name);
 219 krb5_error_code smb_krb5_kt_seek_and_delete_old_entries(krb5_context context,
 220                                                         krb5_keytab keytab,
 221                                                         krb5_kvno kvno,
 222                                                         krb5_enctype enctype,
 223                                                         const char *princ_s,
 224                                                         krb5_principal princ,
 225                                                         bool flush,
 226                                                         bool keep_old_entries);
 227 krb5_error_code smb_krb5_kt_add_entry(krb5_context context,
 228                                       krb5_keytab keytab,
 229                                       krb5_kvno kvno,
 230                                       const char *princ_s,
 231                                       const char *salt_principal,
 232                                       krb5_enctype enctype,
 233                                       krb5_data *password,
 234                                       bool no_salt,
 235                                       bool keep_old_entries);
 236
 237 krb5_error_code smb_krb5_get_credentials(krb5_context context,
 238                                          krb5_ccache ccache,
 239                                          krb5_principal me,
 240                                          krb5_principal server,
 241                                          krb5_principal impersonate_princ,
 242                                          krb5_creds **out_creds);
 243 krb5_error_code smb_krb5_keyblock_init_contents(krb5_context context,
 244                                                 krb5_enctype enctype,
 245                                                 const void *data,
 246                                                 size_t length,
 247                                                 krb5_keyblock *key);
 248 krb5_error_code kerberos_kinit_keyblock_cc(krb5_context ctx, krb5_ccache cc,
 249                                            krb5_principal principal,
 250                                            krb5_keyblock *keyblock,
 251                                            const char *target_service,
 252                                            krb5_get_init_creds_opt *krb_options,
 253                                            time_t *expire_time,
 254                                            time_t *kdc_time);
 255 krb5_error_code kerberos_kinit_password_cc(krb5_context ctx,
 256                                            krb5_ccache cc,
 257                                            krb5_principal principal,
 258                                            const char *password,
 259                                            const char *target_service,
 260                                            krb5_get_init_creds_opt *krb_options,
 261                                            time_t *expire_time,
 262                                            time_t *kdc_time);
 263 #ifdef SAMBA4_USES_HEIMDAL
 264 krb5_error_code kerberos_kinit_s4u2_cc(krb5_context ctx,
 265                                         krb5_ccache store_cc,
 266                                         krb5_principal init_principal,
 267                                         const char *init_password,
 268                                         krb5_principal impersonate_principal,
 269                                         const char *self_service,
 270                                         const char *target_service,
 271                                         krb5_get_init_creds_opt *krb_options,
 272                                         time_t *expire_time,
 273                                         time_t *kdc_time);
 274 #endif
 275
 276 #if defined(HAVE_KRB5_MAKE_PRINCIPAL)
 277 #define smb_krb5_make_principal krb5_make_principal
 278 #elif defined(HAVE_KRB5_BUILD_PRINCIPAL_ALLOC_VA)
 279 krb5_error_code smb_krb5_make_principal(krb5_context context,
 280                                         krb5_principal *principal,
 281                                         const char *realm, ...);
 282 #else
 283 #error krb5_make_principal not available
 284 #endif
 285
 286 #if defined(HAVE_KRB5_CC_GET_LIFETIME)
 287 #define smb_krb5_cc_get_lifetime krb5_cc_get_lifetime
 288 #elif defined(HAVE_KRB5_CC_RETRIEVE_CRED)
 289 krb5_error_code smb_krb5_cc_get_lifetime(krb5_context context,
 290                                          krb5_ccache id,
 291                                          time_t *t);
 292 #else
 293 #error krb5_cc_get_lifetime not available
 294 #endif
 295
 296 #if defined(HAVE_KRB5_FREE_CHECKSUM_CONTENTS)
 297 #define smb_krb5_free_checksum_contents krb5_free_checksum_contents
 298 #elif defined (HAVE_FREE_CHECKSUM)
 299 void smb_krb5_free_checksum_contents(krb5_context ctx, krb5_checksum *cksum);
 300 #else
 301 #error krb5_free_checksum_contents/free_Checksum is not vailable
 302 #endif
 303
 304 krb5_error_code smb_krb5_make_pac_checksum(TALLOC_CTX *mem_ctx,
 305                                            DATA_BLOB *pac_data,
 306                                            krb5_context context,
 307                                            const krb5_keyblock *keyblock,
 308                                            uint32_t *sig_type,
 309                                            DATA_BLOB *sig_blob);
 310
 311 char *smb_krb5_principal_get_realm(krb5_context context,
 312                                    krb5_const_principal principal);
 313
 314 void smb_krb5_principal_set_type(krb5_context context,
 315                                  krb5_principal principal,
 316                                  int type);
 317
 318 krb5_error_code smb_krb5_principal_set_realm(krb5_context context,
 319                                              krb5_principal principal,
 320                                              const char *realm);
 321
 322 char *kerberos_get_principal_from_service_hostname(TALLOC_CTX *mem_ctx,
 323                                                    const char *service,
 324                                                    const char *remote_name,
 325                                                    const char *default_realm);
 326
 327 char *smb_get_krb5_error_message(krb5_context context,
 328                                  krb5_error_code code,
 329                                  TALLOC_CTX *mem_ctx);
 330
 331 bool unwrap_edata_ntstatus(TALLOC_CTX *mem_ctx,
 332                            DATA_BLOB *edata,
 333                            DATA_BLOB *edata_out);
 334
 335
 336 krb5_error_code kt_copy(krb5_context context,
 337                         const char *from,
 338                         const char *to);
 339 krb5_error_code kt_copy_one_principal(krb5_context context,
 340                                       const char *from,
 341                                       const char *to,
 342                                       const char *principal,
 343                                       krb5_kvno kvno,
 344                                       const krb5_enctype *enctypes);
 345
 346 #if defined(HAVE_KRB5_KT_COMPARE)
 347 #define smb_krb5_kt_compare krb5_kt_compare
 348 #else
 349 krb5_boolean smb_krb5_kt_compare(krb5_context context,
 350                                  krb5_keytab_entry *entry,
 351                                  krb5_const_principal principal,
 352                                  krb5_kvno vno,
 353                                  krb5_enctype enctype);
 354 #endif
 355
 356 const krb5_enctype *samba_all_enctypes(void);
 357
 358 uint32_t kerberos_enctype_to_bitmap(krb5_enctype enc_type_enum);
 359 krb5_enctype ms_suptype_to_ietf_enctype(uint32_t enctype_bitmap);
 360 krb5_error_code ms_suptypes_to_ietf_enctypes(TALLOC_CTX *mem_ctx,
 361                                              uint32_t enctype_bitmap,
 362                                              krb5_enctype **enctypes);
 363 int smb_krb5_get_pw_salt(krb5_context context,
 364                          krb5_const_principal host_princ,
 365                          krb5_data *psalt);
 366
 367 int smb_krb5_create_key_from_string(krb5_context context,
 368                                     krb5_const_principal host_princ,
 369                                     krb5_data *salt,
 370                                     krb5_data *password,
 371                                     krb5_enctype enctype,
 372                                     krb5_keyblock *key);
 373
 374 krb5_boolean smb_krb5_get_allowed_weak_crypto(krb5_context context);
 375
 376 #ifndef krb5_princ_size
 377 #if defined(HAVE_KRB5_PRINCIPAL_GET_NUM_COMP)
 378 #define krb5_princ_size krb5_principal_get_num_comp
 379 #else
 380 #error krb5_princ_size unavailable
 381 #endif
 382 #endif
 383
 384 char *smb_krb5_principal_get_comp_string(TALLOC_CTX *mem_ctx,
 385                                          krb5_context context,
 386                                          krb5_const_principal principal,
 387                                          unsigned int component);
 388
 389 krb5_error_code krb5_copy_data_contents(krb5_data *p,
 390                                         const void *data,
 391                                         size_t len);
 392
 393 int smb_krb5_principal_get_type(krb5_context context,
 394                                 krb5_const_principal principal);
 395
 396 #if !defined(HAVE_KRB5_WARNX)
 397 krb5_error_code krb5_warnx(krb5_context context, const char *fmt, ...);
 398 #endif
 399
 400 krb5_error_code smb_krb5_cc_copy_creds(krb5_context context,
 401                                        krb5_ccache incc, krb5_ccache outcc);
 402
 403 #endif /* HAVE_KRB5 */
 404
 405 int cli_krb5_get_ticket(TALLOC_CTX *mem_ctx,
 406                         const char *principal, time_t time_offset,
 407                         DATA_BLOB *ticket, DATA_BLOB *session_key_krb5,
 408                         uint32_t extra_ap_opts, const char *ccname,
 409                         time_t *tgs_expire,
 410                         const char *impersonate_princ_s);
 411
 412 #endif /* _KRB5_SAMBA_H */