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 krb5_error_code smb_krb5_parse_name(krb5_context context,
 113                                 const char *name, /* in unix charset */
 114                                 krb5_principal *principal);
 115
 116 krb5_error_code smb_krb5_unparse_name(TALLOC_CTX *mem_ctx,
 117                                       krb5_context context,
 118                                       krb5_const_principal principal,
 119                                       char **unix_name);
 120
 121 krb5_error_code krb5_set_default_tgs_ktypes(krb5_context ctx, const krb5_enctype *enc);
 122
 123 #if defined(HAVE_KRB5_AUTH_CON_SETKEY) && !defined(HAVE_KRB5_AUTH_CON_SETUSERUSERKEY)
 124 krb5_error_code krb5_auth_con_setuseruserkey(krb5_context context, krb5_auth_context auth_context, krb5_keyblock *keyblock);
 125 #endif
 126
 127 #ifndef HAVE_KRB5_FREE_UNPARSED_NAME
 128 void krb5_free_unparsed_name(krb5_context ctx, char *val);
 129 #endif
 130
 131 /* Stub out initialize_krb5_error_table since it is not present in all
 132  * Kerberos implementations. If it's not present, it's not necessary to
 133  * call it.
 134  */
 135 #ifndef HAVE_INITIALIZE_KRB5_ERROR_TABLE
 136 #define initialize_krb5_error_table()
 137 #endif
 138
 139 /* Samba wrapper functions for krb5 functionality. */
 140 bool setup_kaddr( krb5_address *pkaddr, struct sockaddr_storage *paddr);
 141 int create_kerberos_key_from_string(krb5_context context,
 142                                     krb5_principal host_princ,
 143                                     krb5_data *password,
 144                                     krb5_keyblock *key,
 145                                     krb5_enctype enctype,
 146                                     bool no_salt);
 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(krb5_context context,
 182                                       const char *keytab_name,
 183                                       bool write_access,
 184                                       krb5_keytab *keytab);
 185 krb5_error_code smb_krb5_keytab_name(TALLOC_CTX *mem_ctx,
 186                                      krb5_context context,
 187                                      krb5_keytab keytab,
 188                                      const char **keytab_name);
 189 krb5_error_code smb_krb5_get_credentials(krb5_context context,
 190                                          krb5_ccache ccache,
 191                                          krb5_principal me,
 192                                          krb5_principal server,
 193                                          krb5_principal impersonate_princ,
 194                                          krb5_creds **out_creds);
 195 krb5_error_code smb_krb5_keyblock_init_contents(krb5_context context,
 196                                                 krb5_enctype enctype,
 197                                                 const void *data,
 198                                                 size_t length,
 199                                                 krb5_keyblock *key);
 200 krb5_error_code kerberos_kinit_keyblock_cc(krb5_context ctx, krb5_ccache cc,
 201                                            krb5_principal principal,
 202                                            krb5_keyblock *keyblock,
 203                                            const char *target_service,
 204                                            krb5_get_init_creds_opt *krb_options,
 205                                            time_t *expire_time,
 206                                            time_t *kdc_time);
 207 krb5_error_code kerberos_kinit_password_cc(krb5_context ctx,
 208                                            krb5_ccache cc,
 209                                            krb5_principal principal,
 210                                            const char *password,
 211                                            const char *target_service,
 212                                            krb5_get_init_creds_opt *krb_options,
 213                                            time_t *expire_time,
 214                                            time_t *kdc_time);
 215 #ifdef SAMBA4_USES_HEIMDAL
 216 krb5_error_code kerberos_kinit_s4u2_cc(krb5_context ctx,
 217                                         krb5_ccache store_cc,
 218                                         krb5_principal init_principal,
 219                                         const char *init_password,
 220                                         krb5_principal impersonate_principal,
 221                                         const char *self_service,
 222                                         const char *target_service,
 223                                         krb5_get_init_creds_opt *krb_options,
 224                                         time_t *expire_time,
 225                                         time_t *kdc_time);
 226 #endif
 227
 228 #if defined(HAVE_KRB5_MAKE_PRINCIPAL)
 229 #define smb_krb5_make_principal krb5_make_principal
 230 #elif defined(HAVE_KRB5_BUILD_PRINCIPAL_ALLOC_VA)
 231 krb5_error_code smb_krb5_make_principal(krb5_context context,
 232                                         krb5_principal *principal,
 233                                         const char *realm, ...);
 234 #else
 235 #error krb5_make_principal not available
 236 #endif
 237
 238 #if defined(HAVE_KRB5_CC_GET_LIFETIME)
 239 #define smb_krb5_cc_get_lifetime krb5_cc_get_lifetime
 240 #elif defined(HAVE_KRB5_CC_RETRIEVE_CRED)
 241 krb5_error_code smb_krb5_cc_get_lifetime(krb5_context context,
 242                                          krb5_ccache id,
 243                                          time_t *t);
 244 #else
 245 #error krb5_cc_get_lifetime not available
 246 #endif
 247
 248 #if defined(HAVE_KRB5_FREE_CHECKSUM_CONTENTS)
 249 #define smb_krb5_free_checksum_contents krb5_free_checksum_contents
 250 #elif defined (HAVE_FREE_CHECKSUM)
 251 void smb_krb5_free_checksum_contents(krb5_context ctx, krb5_checksum *cksum);
 252 #else
 253 #error krb5_free_checksum_contents/free_Checksum is not vailable
 254 #endif
 255
 256 krb5_error_code smb_krb5_make_pac_checksum(TALLOC_CTX *mem_ctx,
 257                                            DATA_BLOB *pac_data,
 258                                            krb5_context context,
 259                                            const krb5_keyblock *keyblock,
 260                                            uint32_t *sig_type,
 261                                            DATA_BLOB *sig_blob);
 262
 263 char *smb_krb5_principal_get_realm(krb5_context context,
 264                                    krb5_const_principal principal);
 265
 266 krb5_error_code smb_krb5_principal_set_realm(krb5_context context,
 267                                              krb5_principal principal,
 268                                              const char *realm);
 269
 270 char *kerberos_get_principal_from_service_hostname(TALLOC_CTX *mem_ctx,
 271                                                    const char *service,
 272                                                    const char *remote_name,
 273                                                    const char *default_realm);
 274
 275 char *smb_get_krb5_error_message(krb5_context context,
 276                                  krb5_error_code code,
 277                                  TALLOC_CTX *mem_ctx);
 278
 279 bool unwrap_edata_ntstatus(TALLOC_CTX *mem_ctx,
 280                            DATA_BLOB *edata,
 281                            DATA_BLOB *edata_out);
 282
 283
 284 krb5_error_code kt_copy(krb5_context context,
 285                         const char *from,
 286                         const char *to);
 287 krb5_error_code kt_copy_one_principal(krb5_context context,
 288                                       const char *from,
 289                                       const char *to,
 290                                       const char *principal,
 291                                       krb5_kvno kvno,
 292                                       const krb5_enctype *enctypes);
 293
 294 #if defined(HAVE_KRB5_KT_COMPARE)
 295 #define smb_krb5_kt_compare krb5_kt_compare
 296 #else
 297 krb5_boolean smb_krb5_kt_compare(krb5_context context,
 298                                  krb5_keytab_entry *entry,
 299                                  krb5_const_principal principal,
 300                                  krb5_kvno vno,
 301                                  krb5_enctype enctype);
 302 #endif
 303
 304 const krb5_enctype *samba_all_enctypes(void);
 305
 306 uint32_t kerberos_enctype_to_bitmap(krb5_enctype enc_type_enum);
 307 krb5_enctype ms_suptype_to_ietf_enctype(uint32_t enctype_bitmap);
 308 krb5_error_code ms_suptypes_to_ietf_enctypes(TALLOC_CTX *mem_ctx,
 309                                              uint32_t enctype_bitmap,
 310                                              krb5_enctype **enctypes);
 311 int smb_krb5_get_pw_salt(krb5_context context,
 312                          krb5_principal host_princ,
 313                          krb5_data *psalt);
 314
 315 int smb_krb5_create_key_from_string(krb5_context context,
 316                                     krb5_principal *host_princ,
 317                                     krb5_data *salt,
 318                                     krb5_data *password,
 319                                     krb5_enctype enctype,
 320                                     krb5_keyblock *key);
 321
 322 krb5_boolean smb_krb5_get_allowed_weak_crypto(krb5_context context);
 323
 324 #ifndef krb5_princ_size
 325 #if defined(HAVE_KRB5_PRINCIPAL_GET_NUM_COMP)
 326 #define krb5_princ_size krb5_principal_get_num_comp
 327 #else
 328 #error krb5_princ_size unavailable
 329 #endif
 330 #endif
 331
 332 char *smb_krb5_principal_get_comp_string(TALLOC_CTX *mem_ctx,
 333                                          krb5_context context,
 334                                          krb5_const_principal principal,
 335                                          unsigned int component);
 336
 337 krb5_error_code krb5_copy_data_contents(krb5_data *p,
 338                                         const void *data,
 339                                         size_t len);
 340
 341 int smb_krb5_principal_get_type(krb5_context context,
 342                                 krb5_const_principal principal);
 343
 344 #if !defined(HAVE_KRB5_WARNX)
 345 krb5_error_code krb5_warnx(krb5_context context, const char *fmt, ...);
 346 #endif
 347
 348 #endif /* HAVE_KRB5 */
 349
 350 int cli_krb5_get_ticket(TALLOC_CTX *mem_ctx,
 351                         const char *principal, time_t time_offset,
 352                         DATA_BLOB *ticket, DATA_BLOB *session_key_krb5,
 353                         uint32_t extra_ap_opts, const char *ccname,
 354                         time_t *tgs_expire,
 355                         const char *impersonate_princ_s);
 356
 357 #endif /* _KRB5_SAMBA_H */