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 typedef struct {
  68 #if defined(HAVE_MAGIC_IN_KRB5_ADDRESS) && defined(HAVE_ADDRTYPE_IN_KRB5_ADDRESS) /* MIT */
  69         krb5_address **addrs;
  70 #elif defined(HAVE_KRB5_ADDRESSES) /* Heimdal */
  71         krb5_addresses *addrs;
  72 #else
  73 #error UNKNOWN_KRB5_ADDRESS_TYPE
  74 #endif /* defined(HAVE_MAGIC_IN_KRB5_ADDRESS) && defined(HAVE_ADDRTYPE_IN_KRB5_ADDRESS) */
  75 } smb_krb5_addresses;
  76
  77 #ifdef HAVE_KRB5_KEYTAB_ENTRY_KEY               /* MIT */
  78 #define KRB5_KT_KEY(k)          (&(k)->key)
  79 #elif HAVE_KRB5_KEYTAB_ENTRY_KEYBLOCK          /* Heimdal */
  80 #define KRB5_KT_KEY(k)          (&(k)->keyblock)
  81 #else
  82 #error krb5_keytab_entry has no key or keyblock member
  83 #endif /* HAVE_KRB5_KEYTAB_ENTRY_KEY */
  84
  85 /* work around broken krb5.h on sles9 */
  86 #ifdef SIZEOF_LONG
  87 #undef SIZEOF_LONG
  88 #endif
  89
  90 #ifdef HAVE_KRB5_KEYBLOCK_KEYVALUE /* Heimdal */
  91 #define KRB5_KEY_TYPE(k)        ((k)->keytype)
  92 #define KRB5_KEY_LENGTH(k)      ((k)->keyvalue.length)
  93 #define KRB5_KEY_DATA(k)        ((k)->keyvalue.data)
  94 #define KRB5_KEY_DATA_CAST      void
  95 #else /* MIT */
  96 #define KRB5_KEY_TYPE(k)        ((k)->enctype)
  97 #define KRB5_KEY_LENGTH(k)      ((k)->length)
  98 #define KRB5_KEY_DATA(k)        ((k)->contents)
  99 #define KRB5_KEY_DATA_CAST      krb5_octet
 100 #endif /* HAVE_KRB5_KEYBLOCK_KEYVALUE */
 101
 102 krb5_error_code smb_krb5_parse_name(krb5_context context,
 103                                 const char *name, /* in unix charset */
 104                                 krb5_principal *principal);
 105
 106 krb5_error_code smb_krb5_unparse_name(TALLOC_CTX *mem_ctx,
 107                                       krb5_context context,
 108                                       krb5_const_principal principal,
 109                                       char **unix_name);
 110
 111 krb5_error_code krb5_set_default_tgs_ktypes(krb5_context ctx, const krb5_enctype *enc);
 112
 113 #if defined(HAVE_KRB5_AUTH_CON_SETKEY) && !defined(HAVE_KRB5_AUTH_CON_SETUSERUSERKEY)
 114 krb5_error_code krb5_auth_con_setuseruserkey(krb5_context context, krb5_auth_context auth_context, krb5_keyblock *keyblock);
 115 #endif
 116
 117 #ifndef HAVE_KRB5_FREE_UNPARSED_NAME
 118 void krb5_free_unparsed_name(krb5_context ctx, char *val);
 119 #endif
 120
 121 /* Stub out initialize_krb5_error_table since it is not present in all
 122  * Kerberos implementations. If it's not present, it's not necessary to
 123  * call it.
 124  */
 125 #ifndef HAVE_INITIALIZE_KRB5_ERROR_TABLE
 126 #define initialize_krb5_error_table()
 127 #endif
 128
 129 /* Samba wrapper functions for krb5 functionality. */
 130 bool setup_kaddr( krb5_address *pkaddr, struct sockaddr_storage *paddr);
 131 int create_kerberos_key_from_string(krb5_context context,
 132                                     krb5_principal host_princ,
 133                                     krb5_data *password,
 134                                     krb5_keyblock *key,
 135                                     krb5_enctype enctype,
 136                                     bool no_salt);
 137
 138 krb5_error_code get_kerberos_allowed_etypes(krb5_context context, krb5_enctype **enctypes);
 139 bool get_krb5_smb_session_key(TALLOC_CTX *mem_ctx,
 140                               krb5_context context,
 141                               krb5_auth_context auth_context,
 142                               DATA_BLOB *session_key, bool remote);
 143 krb5_error_code smb_krb5_kt_free_entry(krb5_context context, krb5_keytab_entry *kt_entry);
 144 void kerberos_set_creds_enctype(krb5_creds *pcreds, int enctype);
 145 bool kerberos_compatible_enctypes(krb5_context context, krb5_enctype enctype1, krb5_enctype enctype2);
 146 void kerberos_free_data_contents(krb5_context context, krb5_data *pdata);
 147 krb5_error_code smb_krb5_parse_name_norealm(krb5_context context,
 148                                             const char *name,
 149                                             krb5_principal *principal);
 150 bool smb_krb5_principal_compare_any_realm(krb5_context context,
 151                                           krb5_const_principal princ1,
 152                                           krb5_const_principal princ2);
 153 krb5_error_code smb_krb5_renew_ticket(const char *ccache_string, const char *client_string, const char *service_string, time_t *expire_time);
 154 krb5_error_code kpasswd_err_to_krb5_err(krb5_error_code res_code);
 155 krb5_error_code smb_krb5_gen_netbios_krb5_address(smb_krb5_addresses **kerb_addr,
 156                                                   const char *netbios_name);
 157 krb5_error_code smb_krb5_free_addresses(krb5_context context, smb_krb5_addresses *addr);
 158 NTSTATUS krb5_to_nt_status(krb5_error_code kerberos_error);
 159 krb5_error_code nt_status_to_krb5(NTSTATUS nt_status);
 160 void smb_krb5_free_error(krb5_context context, krb5_error *krberror);
 161 krb5_error_code handle_krberror_packet(krb5_context context,
 162                                          krb5_data *packet);
 163
 164 void smb_krb5_get_init_creds_opt_free(krb5_context context,
 165                                     krb5_get_init_creds_opt *opt);
 166 krb5_error_code smb_krb5_get_init_creds_opt_alloc(krb5_context context,
 167                                     krb5_get_init_creds_opt **opt);
 168 krb5_enctype smb_get_enctype_from_kt_entry(krb5_keytab_entry *kt_entry);
 169 krb5_error_code smb_krb5_enctype_to_string(krb5_context context,
 170                                             krb5_enctype enctype,
 171                                             char **etype_s);
 172 krb5_error_code smb_krb5_open_keytab(krb5_context context,
 173                                       const char *keytab_name,
 174                                       bool write_access,
 175                                       krb5_keytab *keytab);
 176 krb5_error_code smb_krb5_keytab_name(TALLOC_CTX *mem_ctx,
 177                                      krb5_context context,
 178                                      krb5_keytab keytab,
 179                                      const char **keytab_name);
 180 krb5_error_code smb_krb5_get_credentials(krb5_context context,
 181                                          krb5_ccache ccache,
 182                                          krb5_principal me,
 183                                          krb5_principal server,
 184                                          krb5_principal impersonate_princ,
 185                                          krb5_creds **out_creds);
 186 krb5_error_code smb_krb5_keyblock_init_contents(krb5_context context,
 187                                                 krb5_enctype enctype,
 188                                                 const void *data,
 189                                                 size_t length,
 190                                                 krb5_keyblock *key);
 191 krb5_error_code kerberos_kinit_keyblock_cc(krb5_context ctx, krb5_ccache cc,
 192                                            krb5_principal principal,
 193                                            krb5_keyblock *keyblock,
 194                                            const char *target_service,
 195                                            krb5_get_init_creds_opt *krb_options,
 196                                            time_t *expire_time,
 197                                            time_t *kdc_time);
 198 krb5_error_code kerberos_kinit_password_cc(krb5_context ctx,
 199                                            krb5_ccache cc,
 200                                            krb5_principal principal,
 201                                            const char *password,
 202                                            const char *target_service,
 203                                            krb5_get_init_creds_opt *krb_options,
 204                                            time_t *expire_time,
 205                                            time_t *kdc_time);
 206 #ifdef SAMBA4_USES_HEIMDAL
 207 krb5_error_code kerberos_kinit_s4u2_cc(krb5_context ctx,
 208                                         krb5_ccache store_cc,
 209                                         krb5_principal init_principal,
 210                                         const char *init_password,
 211                                         krb5_principal impersonate_principal,
 212                                         const char *self_service,
 213                                         const char *target_service,
 214                                         krb5_get_init_creds_opt *krb_options,
 215                                         time_t *expire_time,
 216                                         time_t *kdc_time);
 217 #endif
 218
 219 #if defined(HAVE_KRB5_MAKE_PRINCIPAL)
 220 #define smb_krb5_make_principal krb5_make_principal
 221 #elif defined(HAVE_KRB5_BUILD_PRINCIPAL_ALLOC_VA)
 222 krb5_error_code smb_krb5_make_principal(krb5_context context,
 223                                         krb5_principal *principal,
 224                                         const char *realm, ...);
 225 #else
 226 #error krb5_make_principal not available
 227 #endif
 228
 229 #if defined(HAVE_KRB5_CC_GET_LIFETIME)
 230 #define smb_krb5_cc_get_lifetime krb5_cc_get_lifetime
 231 #elif defined(HAVE_KRB5_CC_RETRIEVE_CRED)
 232 krb5_error_code smb_krb5_cc_get_lifetime(krb5_context context,
 233                                          krb5_ccache id,
 234                                          time_t *t);
 235 #else
 236 #error krb5_cc_get_lifetime not available
 237 #endif
 238
 239 #if defined(HAVE_KRB5_FREE_CHECKSUM_CONTENTS)
 240 #define smb_krb5_free_checksum_contents krb5_free_checksum_contents
 241 #elif defined (HAVE_FREE_CHECKSUM)
 242 void smb_krb5_free_checksum_contents(krb5_context ctx, krb5_checksum *cksum);
 243 #else
 244 #error krb5_free_checksum_contents/free_Checksum is not vailable
 245 #endif
 246
 247 krb5_error_code smb_krb5_make_pac_checksum(TALLOC_CTX *mem_ctx,
 248                                            DATA_BLOB *pac_data,
 249                                            krb5_context context,
 250                                            const krb5_keyblock *keyblock,
 251                                            uint32_t *sig_type,
 252                                            DATA_BLOB *sig_blob);
 253
 254 char *smb_krb5_principal_get_realm(krb5_context context,
 255                                    krb5_principal principal);
 256
 257 char *kerberos_get_principal_from_service_hostname(TALLOC_CTX *mem_ctx,
 258                                                    const char *service,
 259                                                    const char *remote_name,
 260                                                    const char *default_realm);
 261
 262 char *smb_get_krb5_error_message(krb5_context context,
 263                                  krb5_error_code code,
 264                                  TALLOC_CTX *mem_ctx);
 265
 266 bool unwrap_edata_ntstatus(TALLOC_CTX *mem_ctx,
 267                            DATA_BLOB *edata,
 268                            DATA_BLOB *edata_out);
 269
 270
 271 krb5_error_code kt_copy(krb5_context context,
 272                         const char *from,
 273                         const char *to);
 274 krb5_error_code kt_copy_one_principal(krb5_context context,
 275                                       const char *from,
 276                                       const char *to,
 277                                       const char *principal,
 278                                       krb5_kvno kvno,
 279                                       const krb5_enctype *enctypes);
 280
 281 #if defined(HAVE_KRB5_KT_COMPARE)
 282 #define smb_krb5_kt_compare krb5_kt_compare
 283 #else
 284 krb5_boolean smb_krb5_kt_compare(krb5_context context,
 285                                  krb5_keytab_entry *entry,
 286                                  krb5_const_principal principal,
 287                                  krb5_kvno vno,
 288                                  krb5_enctype enctype);
 289 #endif
 290
 291 const krb5_enctype *samba_all_enctypes(void);
 292
 293 uint32_t kerberos_enctype_to_bitmap(krb5_enctype enc_type_enum);
 294 krb5_enctype ms_suptype_to_ietf_enctype(uint32_t enctype_bitmap);
 295 krb5_error_code ms_suptypes_to_ietf_enctypes(TALLOC_CTX *mem_ctx,
 296                                              uint32_t enctype_bitmap,
 297                                              krb5_enctype **enctypes);
 298 int smb_krb5_get_pw_salt(krb5_context context,
 299                          krb5_principal host_princ,
 300                          krb5_data *psalt);
 301
 302 int smb_krb5_create_key_from_string(krb5_context context,
 303                                     krb5_principal *host_princ,
 304                                     krb5_data *salt,
 305                                     krb5_data *password,
 306                                     krb5_enctype enctype,
 307                                     krb5_keyblock *key);
 308
 309 krb5_boolean smb_krb5_get_allowed_weak_crypto(krb5_context context);
 310
 311 #ifndef krb5_princ_size
 312 #if defined(HAVE_KRB5_PRINCIPAL_GET_NUM_COMP)
 313 #define krb5_princ_size krb5_principal_get_num_comp
 314 #else
 315 #error krb5_princ_size unavailable
 316 #endif
 317 #endif
 318
 319 char *smb_krb5_principal_get_comp_string(TALLOC_CTX *mem_ctx,
 320                                          krb5_context context,
 321                                          krb5_const_principal principal,
 322                                          unsigned int component);
 323
 324 #endif /* HAVE_KRB5 */
 325
 326 int cli_krb5_get_ticket(TALLOC_CTX *mem_ctx,
 327                         const char *principal, time_t time_offset,
 328                         DATA_BLOB *ticket, DATA_BLOB *session_key_krb5,
 329                         uint32_t extra_ap_opts, const char *ccname,
 330                         time_t *tgs_expire,
 331                         const char *impersonate_princ_s);
 332
 333 #endif /* _KRB5_SAMBA_H */