2 Unix SMB/CIFS implementation.
3 Wrapper for krb5_init_context
5 Copyright (C) Andrew Bartlett <abartlet@samba.org> 2005
6 Copyright (C) Andrew Tridgell 2005
7 Copyright (C) Stefan Metzmacher 2004
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.
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.
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/>.
24 #include "system/kerberos.h"
26 #include "auth/kerberos/kerberos.h"
27 #include "lib/socket/socket.h"
28 #include "lib/stream/packet.h"
29 #include "system/network.h"
30 #include "param/param.h"
31 #include "libcli/resolve/resolve.h"
32 #include "../lib/tsocket/tsocket.h"
33 #include "krb5_init_context.h"
35 context structure for operations on cldap packets
37 struct smb_krb5_socket {
38 struct socket_context *sock;
41 struct tevent_fd *fde;
44 DATA_BLOB request, reply;
46 struct packet_context *packet;
53 static krb5_error_code smb_krb5_context_destroy(struct smb_krb5_context *ctx)
55 #ifdef SAMBA4_USES_HEIMDAL
56 if (ctx->pvt_log_data) {
57 /* Otherwise krb5_free_context will try and close what we
58 * have already free()ed */
59 krb5_set_warn_dest(ctx->krb5_context, NULL);
60 krb5_closelog(ctx->krb5_context,
61 (krb5_log_facility *)ctx->pvt_log_data);
64 krb5_set_trace_callback(ctx->krb5_context, NULL, NULL);
66 krb5_free_context(ctx->krb5_context);
70 /* We never close down the DEBUG system, and no need to unreference the use */
71 static void smb_krb5_debug_close(void *private_data) {
75 #ifdef SAMBA4_USES_HEIMDAL
76 static void smb_krb5_debug_wrapper(const char *timestr, const char *msg, void *private_data)
78 DEBUG(3, ("Kerberos: %s\n", msg));
81 static void smb_krb5_debug_wrapper(krb5_context context,
82 const struct krb5_trace_info *info,
85 DEBUG(3, ("Kerberos: %s\n", info->message));
90 handle recv events on a smb_krb5 socket
92 static void smb_krb5_socket_recv(struct smb_krb5_socket *smb_krb5)
94 TALLOC_CTX *tmp_ctx = talloc_new(smb_krb5);
98 smb_krb5->status = socket_pending(smb_krb5->sock, &dsize);
99 if (!NT_STATUS_IS_OK(smb_krb5->status)) {
100 talloc_free(tmp_ctx);
104 blob = data_blob_talloc(tmp_ctx, NULL, dsize);
105 if (blob.data == NULL && dsize != 0) {
106 smb_krb5->status = NT_STATUS_NO_MEMORY;
107 talloc_free(tmp_ctx);
111 smb_krb5->status = socket_recv(smb_krb5->sock, blob.data, blob.length, &nread);
112 if (!NT_STATUS_IS_OK(smb_krb5->status)) {
113 talloc_free(tmp_ctx);
119 smb_krb5->status = NT_STATUS_UNEXPECTED_NETWORK_ERROR;
120 talloc_free(tmp_ctx);
124 DEBUG(4,("Received smb_krb5 packet of length %d\n",
127 talloc_steal(smb_krb5, blob.data);
128 smb_krb5->reply = blob;
129 talloc_free(tmp_ctx);
132 static NTSTATUS smb_krb5_full_packet(void *private_data, DATA_BLOB data)
134 struct smb_krb5_socket *smb_krb5 = talloc_get_type(private_data, struct smb_krb5_socket);
135 talloc_steal(smb_krb5, data.data);
136 smb_krb5->reply = data;
137 smb_krb5->reply.length -= 4;
138 smb_krb5->reply.data += 4;
143 handle request timeouts
145 static void smb_krb5_request_timeout(struct tevent_context *event_ctx,
146 struct tevent_timer *te, struct timeval t,
149 struct smb_krb5_socket *smb_krb5 = talloc_get_type(private_data, struct smb_krb5_socket);
150 DEBUG(5,("Timed out smb_krb5 packet\n"));
151 smb_krb5->status = NT_STATUS_IO_TIMEOUT;
154 static void smb_krb5_error_handler(void *private_data, NTSTATUS status)
156 struct smb_krb5_socket *smb_krb5 = talloc_get_type(private_data, struct smb_krb5_socket);
157 smb_krb5->status = status;
161 handle send events on a smb_krb5 socket
163 static void smb_krb5_socket_send(struct smb_krb5_socket *smb_krb5)
169 len = smb_krb5->request.length;
170 status = socket_send(smb_krb5->sock, &smb_krb5->request, &len);
172 if (!NT_STATUS_IS_OK(status)) return;
174 TEVENT_FD_READABLE(smb_krb5->fde);
176 TEVENT_FD_NOT_WRITEABLE(smb_krb5->fde);
182 handle fd events on a smb_krb5_socket
184 static void smb_krb5_socket_handler(struct tevent_context *ev, struct tevent_fd *fde,
185 uint16_t flags, void *private_data)
187 struct smb_krb5_socket *smb_krb5 = talloc_get_type(private_data, struct smb_krb5_socket);
188 switch (smb_krb5->hi->proto) {
189 case KRB5_KRBHST_UDP:
190 if (flags & TEVENT_FD_READ) {
191 smb_krb5_socket_recv(smb_krb5);
194 if (flags & TEVENT_FD_WRITE) {
195 smb_krb5_socket_send(smb_krb5);
200 case KRB5_KRBHST_TCP:
201 if (flags & TEVENT_FD_READ) {
202 packet_recv(smb_krb5->packet);
205 if (flags & TEVENT_FD_WRITE) {
206 packet_queue_run(smb_krb5->packet);
211 case KRB5_KRBHST_HTTP:
218 krb5_error_code smb_krb5_send_and_recv_func(krb5_context context,
220 krb5_krbhst_info *hi,
222 const krb5_data *send_buf,
228 struct addrinfo *ai, *a;
229 struct smb_krb5_socket *smb_krb5;
233 struct tevent_context *ev;
234 TALLOC_CTX *tmp_ctx = talloc_new(NULL);
240 /* If no event context was available, then create one for this loop */
241 ev = tevent_context_init(tmp_ctx);
243 talloc_free(tmp_ctx);
247 ev = talloc_get_type_abort(data, struct tevent_context);
250 send_blob = data_blob_const(send_buf->data, send_buf->length);
252 ret = krb5_krbhst_get_addrinfo(context, hi, &ai);
254 talloc_free(tmp_ctx);
258 for (a = ai; a; a = a->ai_next) {
259 struct socket_address *remote_addr;
260 smb_krb5 = talloc(tmp_ctx, struct smb_krb5_socket);
262 talloc_free(tmp_ctx);
267 switch (a->ai_family) {
277 talloc_free(tmp_ctx);
281 status = NT_STATUS_INVALID_PARAMETER;
283 case KRB5_KRBHST_UDP:
284 status = socket_create(name, SOCKET_TYPE_DGRAM, &smb_krb5->sock, 0);
286 case KRB5_KRBHST_TCP:
287 status = socket_create(name, SOCKET_TYPE_STREAM, &smb_krb5->sock, 0);
289 case KRB5_KRBHST_HTTP:
290 talloc_free(tmp_ctx);
293 if (!NT_STATUS_IS_OK(status)) {
294 talloc_free(smb_krb5);
298 talloc_steal(smb_krb5, smb_krb5->sock);
300 remote_addr = socket_address_from_sockaddr(smb_krb5, a->ai_addr, a->ai_addrlen);
302 talloc_free(smb_krb5);
306 status = socket_connect_ev(smb_krb5->sock, NULL, remote_addr, 0, ev);
307 if (!NT_STATUS_IS_OK(status)) {
308 talloc_free(smb_krb5);
312 /* Setup the FDE, start listening for read events
313 * from the start (otherwise we may miss a socket
314 * drop) and mark as AUTOCLOSE along with the fde */
316 /* Ths is equivilant to EVENT_FD_READABLE(smb_krb5->fde) */
317 smb_krb5->fde = tevent_add_fd(ev, smb_krb5->sock,
318 socket_get_fd(smb_krb5->sock),
320 smb_krb5_socket_handler, smb_krb5);
321 /* its now the job of the event layer to close the socket */
322 tevent_fd_set_close_fn(smb_krb5->fde, socket_tevent_fd_close_fn);
323 socket_set_flags(smb_krb5->sock, SOCKET_FLAG_NOCLOSE);
325 tevent_add_timer(ev, smb_krb5,
326 timeval_current_ofs(timeout, 0),
327 smb_krb5_request_timeout, smb_krb5);
329 smb_krb5->status = NT_STATUS_OK;
330 smb_krb5->reply = data_blob(NULL, 0);
333 case KRB5_KRBHST_UDP:
334 TEVENT_FD_WRITEABLE(smb_krb5->fde);
335 smb_krb5->request = send_blob;
337 case KRB5_KRBHST_TCP:
339 smb_krb5->packet = packet_init(smb_krb5);
340 if (smb_krb5->packet == NULL) {
341 talloc_free(smb_krb5);
344 packet_set_private(smb_krb5->packet, smb_krb5);
345 packet_set_socket(smb_krb5->packet, smb_krb5->sock);
346 packet_set_callback(smb_krb5->packet, smb_krb5_full_packet);
347 packet_set_full_request(smb_krb5->packet, packet_full_request_u32);
348 packet_set_error_handler(smb_krb5->packet, smb_krb5_error_handler);
349 packet_set_event_context(smb_krb5->packet, ev);
350 packet_set_fde(smb_krb5->packet, smb_krb5->fde);
352 smb_krb5->request = data_blob_talloc(smb_krb5, NULL, send_blob.length + 4);
353 RSIVAL(smb_krb5->request.data, 0, send_blob.length);
354 memcpy(smb_krb5->request.data+4, send_blob.data, send_blob.length);
355 packet_send(smb_krb5->packet, smb_krb5->request);
357 case KRB5_KRBHST_HTTP:
358 talloc_free(tmp_ctx);
361 while ((NT_STATUS_IS_OK(smb_krb5->status)) && !smb_krb5->reply.length) {
362 if (tevent_loop_once(ev) != 0) {
363 talloc_free(tmp_ctx);
367 /* After each and every event loop, reset the
368 * send_to_kdc pointers to what they were when
369 * we entered this loop. That way, if a
370 * nested event has invalidated them, we put
371 * it back before we return to the heimdal
373 ret = krb5_set_send_to_kdc_func(context,
374 smb_krb5_send_and_recv_func,
377 talloc_free(tmp_ctx);
381 if (NT_STATUS_EQUAL(smb_krb5->status, NT_STATUS_IO_TIMEOUT)) {
382 talloc_free(smb_krb5);
386 if (!NT_STATUS_IS_OK(smb_krb5->status)) {
387 struct tsocket_address *addr = socket_address_to_tsocket_address(smb_krb5, remote_addr);
388 const char *addr_string = NULL;
390 addr_string = tsocket_address_inet_addr_string(addr, smb_krb5);
394 DEBUG(2,("Error reading smb_krb5 reply packet: %s from %s\n", nt_errstr(smb_krb5->status),
396 talloc_free(smb_krb5);
400 ret = krb5_data_copy(recv_buf, smb_krb5->reply.data, smb_krb5->reply.length);
402 talloc_free(tmp_ctx);
405 talloc_free(smb_krb5);
409 talloc_free(tmp_ctx);
413 return KRB5_KDC_UNREACH;
417 smb_krb5_init_context_basic(TALLOC_CTX *tmp_ctx,
418 struct loadparm_context *lp_ctx,
419 krb5_context *_krb5_context)
423 const char *config_file, *realm;
424 krb5_context krb5_ctx;
426 initialize_krb5_error_table();
428 ret = krb5_init_context(&krb5_ctx);
430 DEBUG(1,("krb5_init_context failed (%s)\n",
431 error_message(ret)));
435 config_file = lpcfg_config_path(tmp_ctx, lp_ctx, "krb5.conf");
437 krb5_free_context(krb5_ctx);
441 /* Use our local krb5.conf file by default */
442 ret = krb5_prepend_config_files_default(config_file == NULL?"":config_file, &config_files);
444 DEBUG(1,("krb5_prepend_config_files_default failed (%s)\n",
445 smb_get_krb5_error_message(krb5_ctx, ret, tmp_ctx)));
446 krb5_free_context(krb5_ctx);
450 ret = krb5_set_config_files(krb5_ctx, config_files);
451 krb5_free_config_files(config_files);
453 DEBUG(1,("krb5_set_config_files failed (%s)\n",
454 smb_get_krb5_error_message(krb5_ctx, ret, tmp_ctx)));
455 krb5_free_context(krb5_ctx);
459 realm = lpcfg_realm(lp_ctx);
461 ret = krb5_set_default_realm(krb5_ctx, realm);
463 DEBUG(1,("krb5_set_default_realm failed (%s)\n",
464 smb_get_krb5_error_message(krb5_ctx, ret, tmp_ctx)));
465 krb5_free_context(krb5_ctx);
470 *_krb5_context = krb5_ctx;
474 krb5_error_code smb_krb5_init_context(void *parent_ctx,
475 struct tevent_context *ev,
476 struct loadparm_context *lp_ctx,
477 struct smb_krb5_context **smb_krb5_context)
482 #ifdef SAMBA4_USES_HEIMDAL
483 krb5_log_facility *logf;
486 initialize_krb5_error_table();
488 tmp_ctx = talloc_new(parent_ctx);
489 *smb_krb5_context = talloc_zero(tmp_ctx, struct smb_krb5_context);
491 if (!*smb_krb5_context || !tmp_ctx) {
492 talloc_free(tmp_ctx);
496 ret = smb_krb5_init_context_basic(tmp_ctx, lp_ctx, &kctx);
498 DEBUG(1,("smb_krb5_context_init_basic failed (%s)\n",
499 error_message(ret)));
500 talloc_free(tmp_ctx);
503 (*smb_krb5_context)->krb5_context = kctx;
505 talloc_set_destructor(*smb_krb5_context, smb_krb5_context_destroy);
507 #ifdef SAMBA4_USES_HEIMDAL
508 /* TODO: Should we have a different name here? */
509 ret = krb5_initlog(kctx, "Samba", &logf);
512 DEBUG(1,("krb5_initlog failed (%s)\n",
513 smb_get_krb5_error_message(kctx, ret, tmp_ctx)));
514 talloc_free(tmp_ctx);
517 (*smb_krb5_context)->pvt_log_data = logf;
519 ret = krb5_addlog_func(kctx, logf, 0 /* min */, -1 /* max */,
520 smb_krb5_debug_wrapper,
521 smb_krb5_debug_close, NULL);
523 DEBUG(1,("krb5_addlog_func failed (%s)\n",
524 smb_get_krb5_error_message(kctx, ret, tmp_ctx)));
525 talloc_free(tmp_ctx);
528 krb5_set_warn_dest(kctx, logf);
530 /* Set use of our socket lib */
532 struct tevent_context *previous_ev;
533 ret = smb_krb5_context_set_event_ctx(*smb_krb5_context,
536 talloc_free(tmp_ctx);
541 /* Set options in kerberos */
543 krb5_set_dns_canonicalize_hostname(kctx,
544 lpcfg_parm_bool(lp_ctx, NULL, "krb5",
545 "set_dns_canonicalize", false));
547 ret = krb5_set_trace_callback(kctx, smb_krb5_debug_wrapper, NULL);
548 if (ret && ret != KRB5_TRACE_NOSUPP) {
549 DEBUG(1, ("krb5_set_trace_callback failed (%s)\n"
550 smb_get_krb5_error_message(kctx, ret, tmp_ctx)));
551 talloc_free(tmp_ctx);
555 talloc_steal(parent_ctx, *smb_krb5_context);
556 talloc_free(tmp_ctx);
561 krb5_error_code smb_krb5_context_set_event_ctx(struct smb_krb5_context *smb_krb5_context,
562 struct tevent_context *ev,
563 struct tevent_context **previous_ev)
570 *previous_ev = smb_krb5_context->current_ev;
572 smb_krb5_context->current_ev = talloc_reference(smb_krb5_context, ev);
573 if (!smb_krb5_context->current_ev) {
577 /* Set use of our socket lib */
578 ret = krb5_set_send_to_kdc_func(smb_krb5_context->krb5_context,
579 smb_krb5_send_and_recv_func,
582 TALLOC_CTX *tmp_ctx = talloc_new(NULL);
583 DEBUG(1,("krb5_set_send_recv_func failed (%s)\n",
584 smb_get_krb5_error_message(smb_krb5_context->krb5_context, ret, tmp_ctx)));
585 talloc_free(tmp_ctx);
586 talloc_unlink(smb_krb5_context, smb_krb5_context->current_ev);
587 smb_krb5_context->current_ev = NULL;
593 krb5_error_code smb_krb5_context_remove_event_ctx(struct smb_krb5_context *smb_krb5_context,
594 struct tevent_context *previous_ev,
595 struct tevent_context *ev)
598 talloc_unlink(smb_krb5_context, ev);
599 /* If there was a mismatch with things happening on a stack, then don't wipe things */
600 smb_krb5_context->current_ev = previous_ev;
601 /* Set use of our socket lib */
602 ret = krb5_set_send_to_kdc_func(smb_krb5_context->krb5_context,
603 smb_krb5_send_and_recv_func,
606 TALLOC_CTX *tmp_ctx = talloc_new(NULL);
607 DEBUG(1,("krb5_set_send_recv_func failed (%s)\n",
608 smb_get_krb5_error_message(smb_krb5_context->krb5_context, ret, tmp_ctx)));
609 talloc_free(tmp_ctx);