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 defined(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 smb_krb5_init_context_common(krb5_context *_krb5_context);
 147
 148 krb5_error_code krb5_set_default_tgs_ktypes(krb5_context ctx, const krb5_enctype *enc);
 149
 150 #if defined(HAVE_KRB5_AUTH_CON_SETKEY) && !defined(HAVE_KRB5_AUTH_CON_SETUSERUSERKEY)
 151 krb5_error_code krb5_auth_con_setuseruserkey(krb5_context context, krb5_auth_context auth_context, krb5_keyblock *keyblock);
 152 #endif
 153
 154 #ifndef HAVE_KRB5_FREE_UNPARSED_NAME
 155 void krb5_free_unparsed_name(krb5_context ctx, char *val);
 156 #endif
 157
 158 /* Stub out initialize_krb5_error_table since it is not present in all
 159  * Kerberos implementations. If it's not present, it's not necessary to
 160  * call it.
 161  */
 162 #ifndef HAVE_INITIALIZE_KRB5_ERROR_TABLE
 163 #define initialize_krb5_error_table()
 164 #endif
 165
 166 /* Samba wrapper functions for krb5 functionality. */
 167 bool smb_krb5_sockaddr_to_kaddr(struct sockaddr_storage *paddr,
 168                                 krb5_address *pkaddr);
 169
 170 krb5_error_code smb_krb5_mk_error(krb5_context context,
 171                                   krb5_error_code error_code,
 172                                   const char *e_text,
 173                                   krb5_data *e_data,
 174                                   const krb5_principal client,
 175                                   const krb5_principal server,
 176                                   krb5_data *enc_err);
 177
 178 krb5_error_code smb_krb5_get_allowed_etypes(krb5_context context,
 179                                             krb5_enctype **enctypes);
 180
 181 bool smb_krb5_get_smb_session_key(TALLOC_CTX *mem_ctx,
 182                                   krb5_context context,
 183                                   krb5_auth_context auth_context,
 184                                   DATA_BLOB *session_key,
 185                                   bool remote);
 186
 187 krb5_error_code smb_krb5_kt_free_entry(krb5_context context, krb5_keytab_entry *kt_entry);
 188 void smb_krb5_free_data_contents(krb5_context context, krb5_data *pdata);
 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 krb5_enctype smb_krb5_kt_get_enctype_from_entry(krb5_keytab_entry *kt_entry);
 194
 195 krb5_error_code smb_krb5_enctype_to_string(krb5_context context,
 196                                             krb5_enctype enctype,
 197                                             char **etype_s);
 198 krb5_error_code smb_krb5_kt_open_relative(krb5_context context,
 199                                           const char *keytab_name_req,
 200                                           bool write_access,
 201                                           krb5_keytab *keytab);
 202 krb5_error_code smb_krb5_kt_open(krb5_context context,
 203                                  const char *keytab_name,
 204                                  bool write_access,
 205                                  krb5_keytab *keytab);
 206 krb5_error_code smb_krb5_kt_get_name(TALLOC_CTX *mem_ctx,
 207                                      krb5_context context,
 208                                      krb5_keytab keytab,
 209                                      const char **keytab_name);
 210 krb5_error_code smb_krb5_kt_seek_and_delete_old_entries(krb5_context context,
 211                                                         krb5_keytab keytab,
 212                                                         krb5_kvno kvno,
 213                                                         krb5_enctype enctype,
 214                                                         const char *princ_s,
 215                                                         krb5_principal princ,
 216                                                         bool flush,
 217                                                         bool keep_old_entries);
 218 krb5_error_code smb_krb5_kt_add_entry(krb5_context context,
 219                                       krb5_keytab keytab,
 220                                       krb5_kvno kvno,
 221                                       const char *princ_s,
 222                                       const char *salt_principal,
 223                                       krb5_enctype enctype,
 224                                       krb5_data *password,
 225                                       bool no_salt,
 226                                       bool keep_old_entries);
 227
 228 krb5_error_code smb_krb5_get_credentials(krb5_context context,
 229                                          krb5_ccache ccache,
 230                                          krb5_principal me,
 231                                          krb5_principal server,
 232                                          krb5_principal impersonate_princ,
 233                                          krb5_creds **out_creds);
 234 krb5_error_code smb_krb5_keyblock_init_contents(krb5_context context,
 235                                                 krb5_enctype enctype,
 236                                                 const void *data,
 237                                                 size_t length,
 238                                                 krb5_keyblock *key);
 239 krb5_error_code smb_krb5_kinit_keyblock_ccache(krb5_context ctx,
 240                                                krb5_ccache cc,
 241                                                krb5_principal principal,
 242                                                krb5_keyblock *keyblock,
 243                                                const char *target_service,
 244                                                krb5_get_init_creds_opt *krb_options,
 245                                                time_t *expire_time,
 246                                                time_t *kdc_time);
 247 krb5_error_code smb_krb5_kinit_password_ccache(krb5_context ctx,
 248                                                krb5_ccache cc,
 249                                                krb5_principal principal,
 250                                                const char *password,
 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 smb_krb5_kinit_s4u2_ccache(krb5_context ctx,
 256                                            krb5_ccache store_cc,
 257                                            krb5_principal init_principal,
 258                                            const char *init_password,
 259                                            krb5_principal impersonate_principal,
 260                                            const char *self_service,
 261                                            const char *target_service,
 262                                            krb5_get_init_creds_opt *krb_options,
 263                                            time_t *expire_time,
 264                                            time_t *kdc_time);
 265
 266 #if defined(HAVE_KRB5_MAKE_PRINCIPAL)
 267 #define smb_krb5_make_principal krb5_make_principal
 268 #elif defined(HAVE_KRB5_BUILD_PRINCIPAL_ALLOC_VA)
 269 krb5_error_code smb_krb5_make_principal(krb5_context context,
 270                                         krb5_principal *principal,
 271                                         const char *realm, ...);
 272 #else
 273 #error krb5_make_principal not available
 274 #endif
 275
 276 #if defined(HAVE_KRB5_CC_GET_LIFETIME)
 277 #define smb_krb5_cc_get_lifetime krb5_cc_get_lifetime
 278 #elif defined(HAVE_KRB5_CC_RETRIEVE_CRED)
 279 krb5_error_code smb_krb5_cc_get_lifetime(krb5_context context,
 280                                          krb5_ccache id,
 281                                          time_t *t);
 282 #else
 283 #error krb5_cc_get_lifetime not available
 284 #endif
 285
 286 #if defined(HAVE_KRB5_FREE_CHECKSUM_CONTENTS)
 287 #define smb_krb5_free_checksum_contents krb5_free_checksum_contents
 288 #elif defined (HAVE_FREE_CHECKSUM)
 289 void smb_krb5_free_checksum_contents(krb5_context ctx, krb5_checksum *cksum);
 290 #else
 291 #error krb5_free_checksum_contents/free_Checksum is not vailable
 292 #endif
 293
 294 krb5_error_code smb_krb5_make_pac_checksum(TALLOC_CTX *mem_ctx,
 295                                            DATA_BLOB *pac_data,
 296                                            krb5_context context,
 297                                            const krb5_keyblock *keyblock,
 298                                            uint32_t *sig_type,
 299                                            DATA_BLOB *sig_blob);
 300
 301 char *smb_krb5_principal_get_realm(TALLOC_CTX *mem_ctx,
 302                                    krb5_context context,
 303                                    krb5_const_principal principal);
 304
 305 void smb_krb5_principal_set_type(krb5_context context,
 306                                  krb5_principal principal,
 307                                  int type);
 308
 309 int smb_krb5_principal_is_tgs(krb5_context context,
 310                               krb5_const_principal principal);
 311
 312 krb5_error_code smb_krb5_principal_set_realm(krb5_context context,
 313                                              krb5_principal principal,
 314                                              const char *realm);
 315
 316 char *smb_krb5_get_realm_from_hostname(TALLOC_CTX *mem_ctx,
 317                                        const char *hostname,
 318                                        const char *client_realm);
 319
 320 char *smb_get_krb5_error_message(krb5_context context,
 321                                  krb5_error_code code,
 322                                  TALLOC_CTX *mem_ctx);
 323
 324 #if defined(HAVE_KRB5_KT_COMPARE)
 325 #define smb_krb5_kt_compare krb5_kt_compare
 326 #else
 327 krb5_boolean smb_krb5_kt_compare(krb5_context context,
 328                                  krb5_keytab_entry *entry,
 329                                  krb5_const_principal principal,
 330                                  krb5_kvno vno,
 331                                  krb5_enctype enctype);
 332 #endif
 333
 334 const krb5_enctype *samba_all_enctypes(void);
 335
 336 uint32_t kerberos_enctype_to_bitmap(krb5_enctype enc_type_enum);
 337 krb5_enctype ms_suptype_to_ietf_enctype(uint32_t enctype_bitmap);
 338 krb5_error_code ms_suptypes_to_ietf_enctypes(TALLOC_CTX *mem_ctx,
 339                                              uint32_t enctype_bitmap,
 340                                              krb5_enctype **enctypes);
 341 int smb_krb5_get_pw_salt(krb5_context context,
 342                          krb5_const_principal host_princ,
 343                          krb5_data *psalt);
 344 int smb_krb5_salt_principal(krb5_context krb5_ctx,
 345                             const char *realm,
 346                             const char *sAMAccountName,
 347                             const char *userPrincipalName,
 348                             uint32_t uac_flags,
 349                             krb5_principal *salt_princ);
 350
 351 int smb_krb5_salt_principal_str(const char *realm,
 352                                 const char *sAMAccountName,
 353                                 const char *userPrincipalName,
 354                                 uint32_t uac_flags,
 355                                 TALLOC_CTX *mem_ctx,
 356                                 char **_salt_principal);
 357 int smb_krb5_salt_principal2data(krb5_context context,
 358                                  const char *salt_principal,
 359                                  TALLOC_CTX *mem_ctx,
 360                                  char **_salt_data);
 361
 362 int smb_krb5_create_key_from_string(krb5_context context,
 363                                     krb5_const_principal host_princ,
 364                                     krb5_data *salt,
 365                                     krb5_data *password,
 366                                     krb5_enctype enctype,
 367                                     krb5_keyblock *key);
 368
 369 #ifndef krb5_princ_size
 370 #if defined(HAVE_KRB5_PRINCIPAL_GET_NUM_COMP)
 371 #define krb5_princ_size krb5_principal_get_num_comp
 372 #else
 373 #error krb5_princ_size unavailable
 374 #endif
 375 #endif
 376
 377 char *smb_krb5_principal_get_comp_string(TALLOC_CTX *mem_ctx,
 378                                          krb5_context context,
 379                                          krb5_const_principal principal,
 380                                          unsigned int component);
 381
 382 krb5_error_code smb_krb5_copy_data_contents(krb5_data *p,
 383                                             const void *data,
 384                                             size_t len);
 385
 386 int smb_krb5_principal_get_type(krb5_context context,
 387                                 krb5_const_principal principal);
 388
 389 #if !defined(HAVE_KRB5_WARNX)
 390 krb5_error_code krb5_warnx(krb5_context context, const char *fmt, ...)
 391         PRINTF_ATTRIBUTE(2, 0);
 392 #endif
 393
 394 krb5_error_code smb_krb5_cc_copy_creds(krb5_context context,
 395                                        krb5_ccache incc, krb5_ccache outcc);
 396
 397 #endif /* HAVE_KRB5 */
 398
 399 int ads_krb5_cli_get_ticket(TALLOC_CTX *mem_ctx,
 400                             const char *principal,
 401                             time_t time_offset,
 402                             DATA_BLOB *ticket,
 403                             DATA_BLOB *session_key_krb5,
 404                             uint32_t extra_ap_opts, const char *ccname,
 405                             time_t *tgs_expire,
 406                             const char *impersonate_princ_s);
 407
 408 NTSTATUS krb5_to_nt_status(krb5_error_code kerberos_error);
 409 krb5_error_code nt_status_to_krb5(NTSTATUS nt_status);
 410
 411 #endif /* _KRB5_SAMBA_H */