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