source4/auth/kerberos/krb5_init_context.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Wrapper for krb5_init_context
   4
   5    Copyright (C) Andrew Bartlett <abartlet@samba.org> 2005
   6    Copyright (C) Andrew Tridgell 2005
   7    Copyright (C) Stefan Metzmacher 2004
   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 2 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, write to the Free Software
  21    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22 */
  23
  24 #include "includes.h"
  25 #include "system/kerberos.h"
  26 #include "heimdal/lib/krb5/krb5_locl.h"
  27 #include "auth/kerberos/kerberos.h"
  28 #include "lib/socket/socket.h"
  29 #include "lib/stream/packet.h"
  30 #include "system/network.h"
  31 #include "lib/events/events.h"
  32 #include "roken.h"
  33
  34 /*
  35   context structure for operations on cldap packets
  36 */
  37 struct smb_krb5_socket {
  38         struct socket_context *sock;
  39
  40         /* the fd event */
  41         struct fd_event *fde;
  42
  43         NTSTATUS status;
  44         DATA_BLOB request, reply;
  45
  46         struct packet_context *packet;
  47
  48         size_t partial_read;
  49
  50         krb5_krbhst_info *hi;
  51 };
  52
  53 static int smb_krb5_context_destroy_1(struct smb_krb5_context *ctx)
  54 {
  55         krb5_free_context(ctx->krb5_context);
  56         return 0;
  57 }
  58
  59 static int smb_krb5_context_destroy_2(struct smb_krb5_context *ctx)
  60 {
  61         /* Otherwise krb5_free_context will try and close what we have already free()ed */
  62         krb5_set_warn_dest(ctx->krb5_context, NULL);
  63         krb5_closelog(ctx->krb5_context, ctx->logf);
  64         smb_krb5_context_destroy_1(ctx);
  65         return 0;
  66 }
  67
  68 /* We never close down the DEBUG system, and no need to unreference the use */
  69 static void smb_krb5_debug_close(void *private) {
  70         return;
  71 }
  72
  73 static void smb_krb5_debug_wrapper(const char *timestr, const char *msg, void *private)
  74 {
  75         DEBUG(2, ("Kerberos: %s\n", msg));
  76 }
  77
  78 /*
  79   handle recv events on a smb_krb5 socket
  80 */
  81 static void smb_krb5_socket_recv(struct smb_krb5_socket *smb_krb5)
  82 {
  83         TALLOC_CTX *tmp_ctx = talloc_new(smb_krb5);
  84         DATA_BLOB blob;
  85         size_t nread, dsize;
  86
  87         smb_krb5->status = socket_pending(smb_krb5->sock, &dsize);
  88         if (!NT_STATUS_IS_OK(smb_krb5->status)) {
  89                 talloc_free(tmp_ctx);
  90                 return;
  91         }
  92
  93         blob = data_blob_talloc(tmp_ctx, NULL, dsize);
  94         if (blob.data == NULL && dsize != 0) {
  95                 smb_krb5->status = NT_STATUS_NO_MEMORY;
  96                 talloc_free(tmp_ctx);
  97                 return;
  98         }
  99
 100         smb_krb5->status = socket_recv(smb_krb5->sock, blob.data, blob.length, &nread);
 101         if (!NT_STATUS_IS_OK(smb_krb5->status)) {
 102                 talloc_free(tmp_ctx);
 103                 return;
 104         }
 105         blob.length = nread;
 106
 107         if (nread == 0) {
 108                 smb_krb5->status = NT_STATUS_UNEXPECTED_NETWORK_ERROR;
 109                 talloc_free(tmp_ctx);
 110                 return;
 111         }
 112
 113         DEBUG(2,("Received smb_krb5 packet of length %d\n",
 114                  (int)blob.length));
 115
 116         talloc_steal(smb_krb5, blob.data);
 117         smb_krb5->reply = blob;
 118         talloc_free(tmp_ctx);
 119 }
 120
 121 static NTSTATUS smb_krb5_full_packet(void *private, DATA_BLOB data)
 122 {
 123         struct smb_krb5_socket *smb_krb5 = talloc_get_type(private, struct smb_krb5_socket);
 124         talloc_steal(smb_krb5, data.data);
 125         smb_krb5->reply = data;
 126         smb_krb5->reply.length -= 4;
 127         smb_krb5->reply.data += 4;
 128         return NT_STATUS_OK;
 129 }
 130
 131 /*
 132   handle request timeouts
 133 */
 134 static void smb_krb5_request_timeout(struct event_context *event_ctx,
 135                                   struct timed_event *te, struct timeval t,
 136                                   void *private)
 137 {
 138         struct smb_krb5_socket *smb_krb5 = talloc_get_type(private, struct smb_krb5_socket);
 139         DEBUG(5,("Timed out smb_krb5 packet\n"));
 140         smb_krb5->status = NT_STATUS_IO_TIMEOUT;
 141 }
 142
 143 static void smb_krb5_error_handler(void *private, NTSTATUS status)
 144 {
 145         struct smb_krb5_socket *smb_krb5 = talloc_get_type(private, struct smb_krb5_socket);
 146         smb_krb5->status = status;
 147 }
 148
 149 /*
 150   handle send events on a smb_krb5 socket
 151 */
 152 static void smb_krb5_socket_send(struct smb_krb5_socket *smb_krb5)
 153 {
 154         NTSTATUS status;
 155
 156         size_t len;
 157
 158         len = smb_krb5->request.length;
 159         status = socket_send(smb_krb5->sock, &smb_krb5->request, &len);
 160
 161         if (!NT_STATUS_IS_OK(status)) return;
 162
 163         EVENT_FD_READABLE(smb_krb5->fde);
 164
 165         EVENT_FD_NOT_WRITEABLE(smb_krb5->fde);
 166         return;
 167 }
 168
 169
 170 /*
 171   handle fd events on a smb_krb5_socket
 172 */
 173 static void smb_krb5_socket_handler(struct event_context *ev, struct fd_event *fde,
 174                                  uint16_t flags, void *private)
 175 {
 176         struct smb_krb5_socket *smb_krb5 = talloc_get_type(private, struct smb_krb5_socket);
 177         switch (smb_krb5->hi->proto) {
 178         case KRB5_KRBHST_UDP:
 179                 if (flags & EVENT_FD_WRITE) {
 180                         smb_krb5_socket_send(smb_krb5);
 181                 }
 182                 if (flags & EVENT_FD_READ) {
 183                         smb_krb5_socket_recv(smb_krb5);
 184                 }
 185                 break;
 186         case KRB5_KRBHST_TCP:
 187                 if (flags & EVENT_FD_READ) {
 188                         packet_recv(smb_krb5->packet);
 189                 }
 190                 if (flags & EVENT_FD_WRITE) {
 191                         packet_queue_run(smb_krb5->packet);
 192                 }
 193                 break;
 194         case KRB5_KRBHST_HTTP:
 195                 /* can't happen */
 196                 break;
 197         }
 198 }
 199
 200
 201 krb5_error_code smb_krb5_send_and_recv_func(krb5_context context,
 202                                             void *data,
 203                                             krb5_krbhst_info *hi,
 204                                             const krb5_data *send_buf,
 205                                             krb5_data *recv_buf)
 206 {
 207         krb5_error_code ret;
 208         NTSTATUS status;
 209         struct socket_address *remote_addr;
 210         const char *name;
 211         struct addrinfo *ai, *a;
 212         struct smb_krb5_socket *smb_krb5;
 213
 214         struct event_context *ev = talloc_get_type(data, struct event_context);
 215
 216         DATA_BLOB send_blob = data_blob_const(send_buf->data, send_buf->length);
 217
 218         ret = krb5_krbhst_get_addrinfo(context, hi, &ai);
 219         if (ret) {
 220                 return ret;
 221         }
 222
 223         for (a = ai; a; a = ai->ai_next) {
 224                 smb_krb5 = talloc(NULL, struct smb_krb5_socket);
 225                 if (!smb_krb5) {
 226                         return ENOMEM;
 227                 }
 228                 smb_krb5->hi = hi;
 229
 230                 switch (a->ai_family) {
 231                 case PF_INET:
 232                         name = "ipv4";
 233                         break;
 234 #ifdef HAVE_IPV6
 235                 case PF_INET6:
 236                         name = "ipv6";
 237                         break;
 238 #endif
 239                 default:
 240                         talloc_free(smb_krb5);
 241                         return EINVAL;
 242                 }
 243
 244                 status = NT_STATUS_INVALID_PARAMETER;
 245                 switch (hi->proto) {
 246                 case KRB5_KRBHST_UDP:
 247                         if (lp_parm_bool(-1, "krb5", "udp", True)) {
 248                                 status = socket_create(name, SOCKET_TYPE_DGRAM, &smb_krb5->sock, 0);
 249                         }
 250                         break;
 251                 case KRB5_KRBHST_TCP:
 252                         if (lp_parm_bool(-1, "krb5", "tcp", True)) {
 253                                 status = socket_create(name, SOCKET_TYPE_STREAM, &smb_krb5->sock, 0);
 254                         }
 255                         break;
 256                 case KRB5_KRBHST_HTTP:
 257                         talloc_free(smb_krb5);
 258                         return EINVAL;
 259                 }
 260                 if (!NT_STATUS_IS_OK(status)) {
 261                         talloc_free(smb_krb5);
 262                         continue;
 263                 }
 264
 265                 talloc_steal(smb_krb5, smb_krb5->sock);
 266
 267                 remote_addr = socket_address_from_sockaddr(smb_krb5, a->ai_addr, a->ai_addrlen);
 268                 if (!remote_addr) {
 269                         talloc_free(smb_krb5);
 270                         continue;
 271                 }
 272
 273                 status = socket_connect_ev(smb_krb5->sock, NULL, remote_addr, 0, ev);
 274                 if (!NT_STATUS_IS_OK(status)) {
 275                         talloc_free(smb_krb5);
 276                         continue;
 277                 }
 278                 talloc_free(remote_addr);
 279
 280                 smb_krb5->fde = event_add_fd(ev, smb_krb5->sock,
 281                                              socket_get_fd(smb_krb5->sock),
 282                                              EVENT_FD_AUTOCLOSE,
 283                                              smb_krb5_socket_handler, smb_krb5);
 284                 /* its now the job of the event layer to close the socket */
 285                 socket_set_flags(smb_krb5->sock, SOCKET_FLAG_NOCLOSE);
 286
 287                 event_add_timed(ev, smb_krb5,
 288                                 timeval_current_ofs(context->kdc_timeout, 0),
 289                                 smb_krb5_request_timeout, smb_krb5);
 290
 291
 292                 smb_krb5->status = NT_STATUS_OK;
 293                 smb_krb5->reply = data_blob(NULL, 0);
 294
 295                 switch (hi->proto) {
 296                 case KRB5_KRBHST_UDP:
 297                         EVENT_FD_WRITEABLE(smb_krb5->fde);
 298                         smb_krb5->request = send_blob;
 299                         break;
 300                 case KRB5_KRBHST_TCP:
 301
 302                         smb_krb5->packet = packet_init(smb_krb5);
 303                         if (smb_krb5->packet == NULL) {
 304                                 talloc_free(smb_krb5);
 305                                 return ENOMEM;
 306                         }
 307                         packet_set_private(smb_krb5->packet, smb_krb5);
 308                         packet_set_socket(smb_krb5->packet, smb_krb5->sock);
 309                         packet_set_callback(smb_krb5->packet, smb_krb5_full_packet);
 310                         packet_set_full_request(smb_krb5->packet, packet_full_request_u32);
 311                         packet_set_error_handler(smb_krb5->packet, smb_krb5_error_handler);
 312                         packet_set_event_context(smb_krb5->packet, ev);
 313                         packet_set_fde(smb_krb5->packet, smb_krb5->fde);
 314
 315                         smb_krb5->request = data_blob_talloc(smb_krb5, NULL, send_blob.length + 4);
 316                         RSIVAL(smb_krb5->request.data, 0, send_blob.length);
 317                         memcpy(smb_krb5->request.data+4, send_blob.data, send_blob.length);
 318                         packet_send(smb_krb5->packet, smb_krb5->request);
 319                         EVENT_FD_READABLE(smb_krb5->fde);
 320                         break;
 321                 case KRB5_KRBHST_HTTP:
 322                         talloc_free(smb_krb5);
 323                         return EINVAL;
 324                 }
 325                 while ((NT_STATUS_IS_OK(smb_krb5->status)) && !smb_krb5->reply.length) {
 326                         if (event_loop_once(ev) != 0) {
 327                                 talloc_free(smb_krb5);
 328                                 return EINVAL;
 329                         }
 330                 }
 331                 if (NT_STATUS_EQUAL(smb_krb5->status, NT_STATUS_IO_TIMEOUT)) {
 332                         talloc_free(smb_krb5);
 333                         continue;
 334                 }
 335
 336                 if (!NT_STATUS_IS_OK(smb_krb5->status)) {
 337                         DEBUG(2,("Error reading smb_krb5 reply packet: %s\n", nt_errstr(smb_krb5->status)));
 338                         talloc_free(smb_krb5);
 339                         continue;
 340                 }
 341
 342                 ret = krb5_data_copy(recv_buf, smb_krb5->reply.data, smb_krb5->reply.length);
 343                 if (ret) {
 344                         talloc_free(smb_krb5);
 345                         return ret;
 346                 }
 347                 talloc_free(smb_krb5);
 348
 349                 break;
 350         }
 351         if (a) {
 352                 return 0;
 353         }
 354         return KRB5_KDC_UNREACH;
 355 }
 356
 357 krb5_error_code smb_krb5_init_context(void *parent_ctx,
 358                                       struct event_context *ev,
 359                                        struct smb_krb5_context **smb_krb5_context)
 360 {
 361         krb5_error_code ret;
 362         TALLOC_CTX *tmp_ctx;
 363         char **config_files;
 364         const char *config_file;
 365
 366         initialize_krb5_error_table();
 367
 368         tmp_ctx = talloc_new(parent_ctx);
 369         *smb_krb5_context = talloc(tmp_ctx, struct smb_krb5_context);
 370
 371         if (!*smb_krb5_context || !tmp_ctx) {
 372                 talloc_free(tmp_ctx);
 373                 return ENOMEM;
 374         }
 375
 376         ret = krb5_init_context(&(*smb_krb5_context)->krb5_context);
 377         if (ret) {
 378                 DEBUG(1,("krb5_init_context failed (%s)\n",
 379                          error_message(ret)));
 380                 talloc_free(tmp_ctx);
 381                 return ret;
 382         }
 383
 384         talloc_set_destructor(*smb_krb5_context, smb_krb5_context_destroy_1);
 385
 386         config_file = config_path(tmp_ctx, "krb5.conf");
 387         if (!config_file) {
 388                 talloc_free(tmp_ctx);
 389                 return ENOMEM;
 390         }
 391
 392         /* Use our local krb5.conf file by default */
 393         ret = krb5_prepend_config_files_default(config_file, &config_files);
 394         if (ret) {
 395                 DEBUG(1,("krb5_prepend_config_files_default failed (%s)\n",
 396                          smb_get_krb5_error_message((*smb_krb5_context)->krb5_context, ret, tmp_ctx)));
 397                 talloc_free(tmp_ctx);
 398                 return ret;
 399         }
 400
 401         ret = krb5_set_config_files((*smb_krb5_context)->krb5_context,
 402                                     config_files);
 403         krb5_free_config_files(config_files);
 404         if (ret) {
 405                 DEBUG(1,("krb5_set_config_files failed (%s)\n",
 406                          smb_get_krb5_error_message((*smb_krb5_context)->krb5_context, ret, tmp_ctx)));
 407                 talloc_free(tmp_ctx);
 408                 return ret;
 409         }
 410
 411         if (lp_realm() && *lp_realm()) {
 412                 char *upper_realm = strupper_talloc(tmp_ctx, lp_realm());
 413                 if (!upper_realm) {
 414                         DEBUG(1,("gensec_krb5_start: could not uppercase realm: %s\n", lp_realm()));
 415                         talloc_free(tmp_ctx);
 416                         return ENOMEM;
 417                 }
 418                 ret = krb5_set_default_realm((*smb_krb5_context)->krb5_context, upper_realm);
 419                 if (ret) {
 420                         DEBUG(1,("krb5_set_default_realm failed (%s)\n",
 421                                  smb_get_krb5_error_message((*smb_krb5_context)->krb5_context, ret, tmp_ctx)));
 422                         talloc_free(tmp_ctx);
 423                         return ret;
 424                 }
 425         }
 426
 427         /* TODO: Should we have a different name here? */
 428         ret = krb5_initlog((*smb_krb5_context)->krb5_context, "Samba", &(*smb_krb5_context)->logf);
 429
 430         if (ret) {
 431                 DEBUG(1,("krb5_initlog failed (%s)\n",
 432                          smb_get_krb5_error_message((*smb_krb5_context)->krb5_context, ret, tmp_ctx)));
 433                 talloc_free(tmp_ctx);
 434                 return ret;
 435         }
 436
 437         talloc_set_destructor(*smb_krb5_context, smb_krb5_context_destroy_2);
 438
 439         ret = krb5_addlog_func((*smb_krb5_context)->krb5_context, (*smb_krb5_context)->logf, 0 /* min */, -1 /* max */,
 440                                smb_krb5_debug_wrapper, smb_krb5_debug_close, NULL);
 441         if (ret) {
 442                 DEBUG(1,("krb5_addlog_func failed (%s)\n",
 443                          smb_get_krb5_error_message((*smb_krb5_context)->krb5_context, ret, tmp_ctx)));
 444                 talloc_free(tmp_ctx);
 445                 return ret;
 446         }
 447         krb5_set_warn_dest((*smb_krb5_context)->krb5_context, (*smb_krb5_context)->logf);
 448
 449         /* Set use of our socket lib */
 450         ret = krb5_set_send_to_kdc_func((*smb_krb5_context)->krb5_context,
 451                                         smb_krb5_send_and_recv_func,
 452                                         ev);
 453         if (ret) {
 454                 DEBUG(1,("krb5_set_send_recv_func failed (%s)\n",
 455                          smb_get_krb5_error_message((*smb_krb5_context)->krb5_context, ret, tmp_ctx)));
 456                 talloc_free(tmp_ctx);
 457                 return ret;
 458         }
 459
 460         talloc_steal(parent_ctx, *smb_krb5_context);
 461         talloc_free(tmp_ctx);
 462
 463         /* Set options in kerberos */
 464
 465         krb5_set_dns_canonicalize_hostname((*smb_krb5_context)->krb5_context,
 466                                            lp_parm_bool(-1, "krb5", "set_dns_canonicalize", false));
 467
 468         return 0;
 469 }
 470