lib/krb5/krb5_locl.h

   1 /*
   2  * Copyright (c) 1997-2006 Kungliga Tekniska Högskolan
   3  * (Royal Institute of Technology, Stockholm, Sweden).
   4  * All rights reserved.
   5  *
   6  * Portions Copyright (c) 2009 Apple Inc. All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  *
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * 3. Neither the name of the Institute nor the names of its contributors
  20  *    may be used to endorse or promote products derived from this software
  21  *    without specific prior written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  */
  35
  36 /* $Id$ */
  37
  38 #ifndef __KRB5_LOCL_H__
  39 #define __KRB5_LOCL_H__
  40
  41 #include <config.h>
  42
  43 #include <errno.h>
  44 #include <ctype.h>
  45 #include <string.h>
  46 #include <stdio.h>
  47 #include <stdlib.h>
  48 #include <limits.h>
  49
  50 #include <krb5-types.h>
  51
  52 #ifdef HAVE_SYS_TYPES_H
  53 #include <sys/types.h>
  54 #endif
  55 #ifdef HAVE_SYS_MMAN_H
  56 #include <sys/mman.h>
  57 #endif
  58 #ifdef HAVE_UNISTD_H
  59 #include <unistd.h>
  60 #endif
  61 #ifdef HAVE_FCNTL_H
  62 #include <fcntl.h>
  63 #endif
  64
  65 #if defined(HAVE_SYS_IOCTL_H) && SunOS != 40
  66 #include <sys/ioctl.h>
  67 #endif
  68 #ifdef HAVE_PWD_H
  69 #undef _POSIX_PTHREAD_SEMANTICS
  70 /* This gets us the 5-arg getpwnam_r on Solaris 9.  */
  71 #define _POSIX_PTHREAD_SEMANTICS
  72 #include <pwd.h>
  73 #endif
  74
  75 #ifdef HAVE_SYS_PARAM_H
  76 #include <sys/param.h>
  77 #endif
  78 #include <time.h>
  79 #ifdef HAVE_SYS_TIME_H
  80 #include <sys/time.h>
  81 #endif
  82 #ifdef HAVE_SYS_SELECT_H
  83 #include <sys/select.h>
  84 #endif
  85 #ifdef HAVE_SYS_SOCKET_H
  86 #include <sys/socket.h>
  87 #endif
  88 #ifdef HAVE_NETINET_IN_H
  89 #include <netinet/in.h>
  90 #endif
  91 #ifdef HAVE_NETINET_IN6_H
  92 #include <netinet/in6.h>
  93 #endif
  94 #ifdef HAVE_NETINET6_IN6_H
  95 #include <netinet6/in6.h>
  96 #endif
  97 #ifdef HAVE_NETDB_H
  98 #include <netdb.h>
  99 #endif
 100 #ifdef _AIX
 101 struct ether_addr;
 102 struct mbuf;
 103 struct sockaddr_dl;
 104 #endif
 105 #ifdef HAVE_ARPA_INET_H
 106 #include <arpa/inet.h>
 107 #endif
 108 #ifdef HAVE_ARPA_NAMESER_H
 109 #include <arpa/nameser.h>
 110 #endif
 111 #ifdef HAVE_SYS_UIO_H
 112 #include <sys/uio.h>
 113 #endif
 114 #ifdef HAVE_SYS_FILIO_H
 115 #include <sys/filio.h>
 116 #endif
 117 #ifdef HAVE_SYS_FILE_H
 118 #include <sys/file.h>
 119 #endif
 120
 121 #include <com_err.h>
 122
 123 #define HEIMDAL_TEXTDOMAIN "heimdal_krb5"
 124
 125 #ifdef LIBINTL
 126 #include <libintl.h>
 127 #define N_(x,y) dgettext(HEIMDAL_TEXTDOMAIN, x)
 128 #else
 129 #define N_(x,y) (x)
 130 #define bindtextdomain(package, localedir)
 131 #endif
 132
 133
 134 #ifdef HAVE_CRYPT_H
 135 #undef des_encrypt
 136 #define des_encrypt wingless_pigs_mostly_fail_to_fly
 137 #include <crypt.h>
 138 #undef des_encrypt
 139 #endif
 140
 141 #ifdef HAVE_DOOR_CREATE
 142 #include <door.h>
 143 #endif
 144
 145 #include <roken.h>
 146 #include <parse_time.h>
 147 #include <base64.h>
 148
 149 #include <wind.h>
 150
 151 #define HC_DEPRECATED_CRYPTO
 152 #include "crypto-headers.h"
 153
 154
 155 #include <krb5_asn1.h>
 156
 157 struct send_to_kdc;
 158
 159 /* XXX glue for pkinit */
 160 struct hx509_certs_data;
 161 struct krb5_pk_identity;
 162 struct krb5_pk_cert;
 163 struct ContentInfo;
 164 struct AlgorithmIdentifier;
 165 typedef struct krb5_pk_init_ctx_data *krb5_pk_init_ctx;
 166 struct krb5_dh_moduli;
 167
 168 /* v4 glue */
 169 struct _krb5_krb_auth_data;
 170
 171 #include <der.h>
 172
 173 #include <krb5.h>
 174 #include <krb5_err.h>
 175 #include <asn1_err.h>
 176 #ifdef PKINIT
 177 #include <hx509.h>
 178 #endif
 179 #include <krb5-private.h>
 180
 181 #include "heim_threads.h"
 182
 183 #define ALLOC(X, N) (X) = calloc((N), sizeof(*(X)))
 184 #define ALLOC_SEQ(X, N) do { (X)->len = (N); ALLOC((X)->val, (N)); } while(0)
 185
 186 /* should this be public? */
 187 #define KEYTAB_DEFAULT "FILE:" SYSCONFDIR "/krb5.keytab"
 188 #define KEYTAB_DEFAULT_MODIFY "FILE:" SYSCONFDIR "/krb5.keytab"
 189
 190
 191 #define MODULI_FILE SYSCONFDIR "/krb5.moduli"
 192
 193 #ifndef O_BINARY
 194 #define O_BINARY 0
 195 #endif
 196
 197 #ifndef O_CLOEXEC
 198 #define O_CLOEXEC 0
 199 #endif
 200
 201 #ifndef SOCK_CLOEXEC
 202 #define SOCK_CLOEXEC 0
 203 #endif
 204
 205
 206 #define KRB5_BUFSIZ 1024
 207
 208 typedef enum {
 209     KRB5_INIT_CREDS_TRISTATE_UNSET = 0,
 210     KRB5_INIT_CREDS_TRISTATE_TRUE,
 211     KRB5_INIT_CREDS_TRISTATE_FALSE
 212 } krb5_get_init_creds_tristate;
 213
 214 struct _krb5_get_init_creds_opt_private {
 215     int refcount;
 216     /* ENC_TIMESTAMP */
 217     const char *password;
 218     krb5_s2k_proc key_proc;
 219     /* PA_PAC_REQUEST */
 220     krb5_get_init_creds_tristate req_pac;
 221     /* PKINIT */
 222     krb5_pk_init_ctx pk_init_ctx;
 223     krb5_get_init_creds_tristate addressless;
 224     int flags;
 225 #define KRB5_INIT_CREDS_CANONICALIZE            1
 226 #define KRB5_INIT_CREDS_NO_C_CANON_CHECK        2
 227 #define KRB5_INIT_CREDS_NO_C_NO_EKU_CHECK       4
 228     struct {
 229         krb5_gic_process_last_req func;
 230         void *ctx;
 231     } lr;
 232 };
 233
 234 typedef struct krb5_context_data {
 235     krb5_enctype *etypes;
 236     krb5_enctype *etypes_des;
 237     char **default_realms;
 238     time_t max_skew;
 239     time_t kdc_timeout;
 240     unsigned max_retries;
 241     int32_t kdc_sec_offset;
 242     int32_t kdc_usec_offset;
 243     krb5_config_section *cf;
 244     struct et_list *et_list;
 245     struct krb5_log_facility *warn_dest;
 246     struct krb5_log_facility *debug_dest;
 247     const krb5_cc_ops **cc_ops;
 248     int num_cc_ops;
 249     const char *http_proxy;
 250     const char *time_fmt;
 251     krb5_boolean log_utc;
 252     const char *default_keytab;
 253     const char *default_keytab_modify;
 254     krb5_boolean use_admin_kdc;
 255     krb5_addresses *extra_addresses;
 256     krb5_boolean scan_interfaces;       /* `ifconfig -a' */
 257     krb5_boolean srv_lookup;            /* do SRV lookups */
 258     krb5_boolean srv_try_txt;           /* try TXT records also */
 259     int32_t fcache_vno;                 /* create cache files w/ this
 260                                            version */
 261     int num_kt_types;                   /* # of registered keytab types */
 262     struct krb5_keytab_data *kt_types;  /* registered keytab types */
 263     const char *date_fmt;
 264     char *error_string;
 265     krb5_error_code error_code;
 266     krb5_addresses *ignore_addresses;
 267     char *default_cc_name;
 268     char *default_cc_name_env;
 269     int default_cc_name_set;
 270     void *mutex;                        /* protects error_string/error_buf */
 271     int large_msg_size;
 272     int flags;
 273 #define KRB5_CTX_F_DNS_CANONICALIZE_HOSTNAME    1
 274 #define KRB5_CTX_F_CHECK_PAC                    2
 275 #define KRB5_CTX_F_HOMEDIR_ACCESS               4
 276 #define KRB5_CTX_F_SOCKETS_INITIALIZED          8
 277 #define KRB5_CTX_F_RD_REQ_IGNORE                16
 278     struct send_to_kdc *send_to_kdc;
 279 #ifdef PKINIT
 280     hx509_context hx509ctx;
 281 #endif
 282 } krb5_context_data;
 283
 284 #ifndef KRB5_USE_PATH_TOKENS
 285 #define KRB5_DEFAULT_CCNAME_FILE "FILE:/tmp/krb5cc_%{uid}"
 286 #else
 287 #define KRB5_DEFAULT_CCNAME_FILE "FILE:%{TEMP}/krb5cc_%{uid}"
 288 #endif
 289 #define KRB5_DEFAULT_CCNAME_API "API:"
 290 #define KRB5_DEFAULT_CCNAME_KCM_KCM "KCM:%{uid}"
 291 #define KRB5_DEFAULT_CCNAME_KCM_API "API:%{uid}"
 292
 293 #define EXTRACT_TICKET_ALLOW_CNAME_MISMATCH             1
 294 #define EXTRACT_TICKET_ALLOW_SERVER_MISMATCH            2
 295 #define EXTRACT_TICKET_MATCH_REALM                      4
 296 #define EXTRACT_TICKET_AS_REQ                           8
 297 #define EXTRACT_TICKET_TIMESYNC                         16
 298
 299 /*
 300  * Configurable options
 301  */
 302
 303 #ifndef KRB5_DEFAULT_CCTYPE
 304 #ifdef __APPLE__
 305 #define KRB5_DEFAULT_CCTYPE (&krb5_acc_ops)
 306 #else
 307 #define KRB5_DEFAULT_CCTYPE (&krb5_fcc_ops)
 308 #endif
 309 #endif
 310
 311 #ifndef KRB5_ADDRESSLESS_DEFAULT
 312 #define KRB5_ADDRESSLESS_DEFAULT TRUE
 313 #endif
 314
 315 #ifndef KRB5_FORWARDABLE_DEFAULT
 316 #define KRB5_FORWARDABLE_DEFAULT TRUE
 317 #endif
 318
 319 #ifdef PKINIT
 320
 321 struct krb5_pk_identity {
 322     hx509_verify_ctx verify_ctx;
 323     hx509_certs certs;
 324     hx509_cert cert;
 325     hx509_certs anchors;
 326     hx509_certs certpool;
 327     hx509_revoke_ctx revokectx;
 328     int flags;
 329 #define PKINIT_BTMM 1
 330 };
 331
 332 enum krb5_pk_type {
 333     PKINIT_WIN2K = 1,
 334     PKINIT_27 = 2
 335 };
 336
 337 #endif /* PKINIT */
 338
 339 #endif /* __KRB5_LOCL_H__ */