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"
25 #include "system/gssapi.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 "param/param.h"
32 #include "libcli/resolve/resolve.h"
33 #include "../lib/tsocket/tsocket.h"
34 #include "krb5_init_context.h"
36 context structure for operations on cldap packets
38 struct smb_krb5_socket
{
39 struct socket_context
*sock
;
42 struct tevent_fd
*fde
;
45 DATA_BLOB request
, reply
;
47 struct packet_context
*packet
;
50 #ifdef SAMBA4_USES_HEIMDAL
55 static krb5_error_code
smb_krb5_context_destroy(struct smb_krb5_context
*ctx
)
57 #ifdef SAMBA4_USES_HEIMDAL
58 if (ctx
->pvt_log_data
) {
59 /* Otherwise krb5_free_context will try and close what we
60 * have already free()ed */
61 krb5_set_warn_dest(ctx
->krb5_context
, NULL
);
62 krb5_closelog(ctx
->krb5_context
,
63 (krb5_log_facility
*)ctx
->pvt_log_data
);
66 krb5_free_context(ctx
->krb5_context
);
70 #ifdef SAMBA4_USES_HEIMDAL
71 /* We never close down the DEBUG system, and no need to unreference the use */
72 static void smb_krb5_debug_close(void *private_data
) {
77 #ifdef SAMBA4_USES_HEIMDAL
78 static void smb_krb5_debug_wrapper(const char *timestr
, const char *msg
, void *private_data
)
80 DEBUG(3, ("Kerberos: %s\n", msg
));
84 #ifdef SAMBA4_USES_HEIMDAL
86 handle recv events on a smb_krb5 socket
88 static void smb_krb5_socket_recv(struct smb_krb5_socket
*smb_krb5
)
90 TALLOC_CTX
*tmp_ctx
= talloc_new(smb_krb5
);
94 smb_krb5
->status
= socket_pending(smb_krb5
->sock
, &dsize
);
95 if (!NT_STATUS_IS_OK(smb_krb5
->status
)) {
100 blob
= data_blob_talloc(tmp_ctx
, NULL
, dsize
);
101 if (blob
.data
== NULL
&& dsize
!= 0) {
102 smb_krb5
->status
= NT_STATUS_NO_MEMORY
;
103 talloc_free(tmp_ctx
);
107 smb_krb5
->status
= socket_recv(smb_krb5
->sock
, blob
.data
, blob
.length
, &nread
);
108 if (!NT_STATUS_IS_OK(smb_krb5
->status
)) {
109 talloc_free(tmp_ctx
);
115 smb_krb5
->status
= NT_STATUS_UNEXPECTED_NETWORK_ERROR
;
116 talloc_free(tmp_ctx
);
120 DEBUG(4,("Received smb_krb5 packet of length %d\n",
123 talloc_steal(smb_krb5
, blob
.data
);
124 smb_krb5
->reply
= blob
;
125 talloc_free(tmp_ctx
);
128 static NTSTATUS
smb_krb5_full_packet(void *private_data
, DATA_BLOB data
)
130 struct smb_krb5_socket
*smb_krb5
= talloc_get_type(private_data
, struct smb_krb5_socket
);
131 talloc_steal(smb_krb5
, data
.data
);
132 smb_krb5
->reply
= data
;
133 smb_krb5
->reply
.length
-= 4;
134 smb_krb5
->reply
.data
+= 4;
139 handle request timeouts
141 static void smb_krb5_request_timeout(struct tevent_context
*event_ctx
,
142 struct tevent_timer
*te
, struct timeval t
,
145 struct smb_krb5_socket
*smb_krb5
= talloc_get_type(private_data
, struct smb_krb5_socket
);
146 DEBUG(5,("Timed out smb_krb5 packet\n"));
147 smb_krb5
->status
= NT_STATUS_IO_TIMEOUT
;
150 static void smb_krb5_error_handler(void *private_data
, NTSTATUS status
)
152 struct smb_krb5_socket
*smb_krb5
= talloc_get_type(private_data
, struct smb_krb5_socket
);
153 smb_krb5
->status
= status
;
157 handle send events on a smb_krb5 socket
159 static void smb_krb5_socket_send(struct smb_krb5_socket
*smb_krb5
)
165 len
= smb_krb5
->request
.length
;
166 status
= socket_send(smb_krb5
->sock
, &smb_krb5
->request
, &len
);
168 if (!NT_STATUS_IS_OK(status
)) return;
170 TEVENT_FD_READABLE(smb_krb5
->fde
);
172 TEVENT_FD_NOT_WRITEABLE(smb_krb5
->fde
);
178 handle fd events on a smb_krb5_socket
180 static void smb_krb5_socket_handler(struct tevent_context
*ev
, struct tevent_fd
*fde
,
181 uint16_t flags
, void *private_data
)
183 struct smb_krb5_socket
*smb_krb5
= talloc_get_type(private_data
, struct smb_krb5_socket
);
184 switch (smb_krb5
->hi
->proto
) {
185 case KRB5_KRBHST_UDP
:
186 if (flags
& TEVENT_FD_READ
) {
187 smb_krb5_socket_recv(smb_krb5
);
190 if (flags
& TEVENT_FD_WRITE
) {
191 smb_krb5_socket_send(smb_krb5
);
196 case KRB5_KRBHST_TCP
:
197 if (flags
& TEVENT_FD_READ
) {
198 packet_recv(smb_krb5
->packet
);
201 if (flags
& TEVENT_FD_WRITE
) {
202 packet_queue_run(smb_krb5
->packet
);
207 case KRB5_KRBHST_HTTP
:
213 static krb5_error_code
smb_krb5_send_and_recv_func_int(krb5_context context
,
214 struct tevent_context
*ev
,
215 krb5_krbhst_info
*hi
,
217 krb5_send_to_kdc_func func
,
220 const krb5_data
*send_buf
,
227 struct smb_krb5_socket
*smb_krb5
;
231 TALLOC_CTX
*frame
= talloc_stackframe();
236 send_blob
= data_blob_const(send_buf
->data
, send_buf
->length
);
238 for (a
= ai
; a
; a
= a
->ai_next
) {
239 struct socket_address
*remote_addr
;
240 smb_krb5
= talloc(frame
, struct smb_krb5_socket
);
247 switch (a
->ai_family
) {
261 status
= NT_STATUS_INVALID_PARAMETER
;
263 case KRB5_KRBHST_UDP
:
264 status
= socket_create(name
, SOCKET_TYPE_DGRAM
, &smb_krb5
->sock
, 0);
266 case KRB5_KRBHST_TCP
:
267 status
= socket_create(name
, SOCKET_TYPE_STREAM
, &smb_krb5
->sock
, 0);
269 case KRB5_KRBHST_HTTP
:
273 if (!NT_STATUS_IS_OK(status
)) {
274 talloc_free(smb_krb5
);
278 talloc_steal(smb_krb5
, smb_krb5
->sock
);
280 remote_addr
= socket_address_from_sockaddr(smb_krb5
, a
->ai_addr
, a
->ai_addrlen
);
282 talloc_free(smb_krb5
);
286 status
= socket_connect_ev(smb_krb5
->sock
, NULL
, remote_addr
, 0, ev
);
287 if (!NT_STATUS_IS_OK(status
)) {
288 talloc_free(smb_krb5
);
292 /* Setup the FDE, start listening for read events
293 * from the start (otherwise we may miss a socket
294 * drop) and mark as AUTOCLOSE along with the fde */
296 /* Ths is equivilant to EVENT_FD_READABLE(smb_krb5->fde) */
297 smb_krb5
->fde
= tevent_add_fd(ev
, smb_krb5
->sock
,
298 socket_get_fd(smb_krb5
->sock
),
300 smb_krb5_socket_handler
, smb_krb5
);
301 /* its now the job of the event layer to close the socket */
302 tevent_fd_set_close_fn(smb_krb5
->fde
, socket_tevent_fd_close_fn
);
303 socket_set_flags(smb_krb5
->sock
, SOCKET_FLAG_NOCLOSE
);
305 tevent_add_timer(ev
, smb_krb5
,
306 timeval_current_ofs(timeout
, 0),
307 smb_krb5_request_timeout
, smb_krb5
);
309 smb_krb5
->status
= NT_STATUS_OK
;
310 smb_krb5
->reply
= data_blob(NULL
, 0);
313 case KRB5_KRBHST_UDP
:
314 TEVENT_FD_WRITEABLE(smb_krb5
->fde
);
315 smb_krb5
->request
= send_blob
;
317 case KRB5_KRBHST_TCP
:
319 smb_krb5
->packet
= packet_init(smb_krb5
);
320 if (smb_krb5
->packet
== NULL
) {
321 talloc_free(smb_krb5
);
324 packet_set_private(smb_krb5
->packet
, smb_krb5
);
325 packet_set_socket(smb_krb5
->packet
, smb_krb5
->sock
);
326 packet_set_callback(smb_krb5
->packet
, smb_krb5_full_packet
);
327 packet_set_full_request(smb_krb5
->packet
, packet_full_request_u32
);
328 packet_set_error_handler(smb_krb5
->packet
, smb_krb5_error_handler
);
329 packet_set_event_context(smb_krb5
->packet
, ev
);
330 packet_set_fde(smb_krb5
->packet
, smb_krb5
->fde
);
332 smb_krb5
->request
= data_blob_talloc(smb_krb5
, NULL
, send_blob
.length
+ 4);
333 RSIVAL(smb_krb5
->request
.data
, 0, send_blob
.length
);
334 memcpy(smb_krb5
->request
.data
+4, send_blob
.data
, send_blob
.length
);
335 packet_send(smb_krb5
->packet
, smb_krb5
->request
);
337 case KRB5_KRBHST_HTTP
:
341 while ((NT_STATUS_IS_OK(smb_krb5
->status
)) && !smb_krb5
->reply
.length
) {
342 if (tevent_loop_once(ev
) != 0) {
348 /* After each and every event loop, reset the
349 * send_to_kdc pointers to what they were when
350 * we entered this loop. That way, if a
351 * nested event has invalidated them, we put
352 * it back before we return to the heimdal
354 ret
= krb5_set_send_to_kdc_func(context
,
363 if (NT_STATUS_EQUAL(smb_krb5
->status
, NT_STATUS_IO_TIMEOUT
)) {
364 talloc_free(smb_krb5
);
368 if (!NT_STATUS_IS_OK(smb_krb5
->status
)) {
369 struct tsocket_address
*addr
= socket_address_to_tsocket_address(smb_krb5
, remote_addr
);
370 const char *addr_string
= NULL
;
372 addr_string
= tsocket_address_inet_addr_string(addr
, smb_krb5
);
376 DEBUG(2,("Error reading smb_krb5 reply packet: %s from %s\n", nt_errstr(smb_krb5
->status
),
378 talloc_free(smb_krb5
);
382 ret
= krb5_data_copy(recv_buf
, smb_krb5
->reply
.data
, smb_krb5
->reply
.length
);
387 talloc_free(smb_krb5
);
395 return KRB5_KDC_UNREACH
;
398 krb5_error_code
smb_krb5_send_and_recv_func(krb5_context context
,
400 krb5_krbhst_info
*hi
,
402 const krb5_data
*send_buf
,
408 struct tevent_context
*ev
;
409 TALLOC_CTX
*frame
= talloc_stackframe();
415 /* If no event context was available, then create one for this loop */
416 ev
= samba_tevent_context_init(frame
);
422 ev
= talloc_get_type_abort(data
, struct tevent_context
);
425 ret
= krb5_krbhst_get_addrinfo(context
, hi
, &ai
);
431 ret
= smb_krb5_send_and_recv_func_int(context
, ev
, hi
, ai
, smb_krb5_send_and_recv_func
, data
, timeout
, send_buf
, recv_buf
);
436 krb5_error_code
smb_krb5_send_and_recv_func_forced(krb5_context context
,
437 void *data
, /* struct addrinfo */
438 krb5_krbhst_info
*hi
,
440 const krb5_data
*send_buf
,
443 krb5_error_code k5ret
;
444 struct addrinfo
*ai
= data
;
446 struct tevent_context
*ev
;
447 TALLOC_CTX
*frame
= talloc_stackframe();
452 /* no event context is passed in, create one for this loop */
453 ev
= samba_tevent_context_init(frame
);
459 /* No need to pass in send_and_recv functions, we won't nest on this private event loop */
460 k5ret
= smb_krb5_send_and_recv_func_int(context
, ev
, hi
, ai
, NULL
, NULL
,
461 timeout
, send_buf
, recv_buf
);
468 smb_krb5_init_context_basic(TALLOC_CTX
*tmp_ctx
,
469 struct loadparm_context
*lp_ctx
,
470 krb5_context
*_krb5_context
)
473 #ifdef SAMBA4_USES_HEIMDAL
475 const char *config_file
, *realm
;
477 krb5_context krb5_ctx
;
479 initialize_krb5_error_table();
481 ret
= krb5_init_context(&krb5_ctx
);
483 DEBUG(1,("krb5_init_context failed (%s)\n",
484 error_message(ret
)));
488 /* The MIT Kerberos build relies on using the system krb5.conf file.
489 * If you really want to use another file please set KRB5_CONFIG
491 #ifdef SAMBA4_USES_HEIMDAL
492 config_file
= lpcfg_config_path(tmp_ctx
, lp_ctx
, "krb5.conf");
494 krb5_free_context(krb5_ctx
);
498 /* Use our local krb5.conf file by default */
499 ret
= krb5_prepend_config_files_default(config_file
, &config_files
);
501 DEBUG(1,("krb5_prepend_config_files_default failed (%s)\n",
502 smb_get_krb5_error_message(krb5_ctx
, ret
, tmp_ctx
)));
503 krb5_free_context(krb5_ctx
);
507 ret
= krb5_set_config_files(krb5_ctx
, config_files
);
508 krb5_free_config_files(config_files
);
510 DEBUG(1,("krb5_set_config_files failed (%s)\n",
511 smb_get_krb5_error_message(krb5_ctx
, ret
, tmp_ctx
)));
512 krb5_free_context(krb5_ctx
);
516 realm
= lpcfg_realm(lp_ctx
);
518 ret
= krb5_set_default_realm(krb5_ctx
, realm
);
520 DEBUG(1,("krb5_set_default_realm failed (%s)\n",
521 smb_get_krb5_error_message(krb5_ctx
, ret
, tmp_ctx
)));
522 krb5_free_context(krb5_ctx
);
527 *_krb5_context
= krb5_ctx
;
531 krb5_error_code
smb_krb5_init_context(void *parent_ctx
,
532 struct loadparm_context
*lp_ctx
,
533 struct smb_krb5_context
**smb_krb5_context
)
538 #ifdef SAMBA4_USES_HEIMDAL
539 krb5_log_facility
*logf
;
542 initialize_krb5_error_table();
544 tmp_ctx
= talloc_new(parent_ctx
);
545 *smb_krb5_context
= talloc_zero(tmp_ctx
, struct smb_krb5_context
);
547 if (!*smb_krb5_context
|| !tmp_ctx
) {
548 talloc_free(tmp_ctx
);
552 ret
= smb_krb5_init_context_basic(tmp_ctx
, lp_ctx
, &kctx
);
554 DEBUG(1,("smb_krb5_context_init_basic failed (%s)\n",
555 error_message(ret
)));
556 talloc_free(tmp_ctx
);
559 (*smb_krb5_context
)->krb5_context
= kctx
;
561 talloc_set_destructor(*smb_krb5_context
, smb_krb5_context_destroy
);
563 #ifdef SAMBA4_USES_HEIMDAL
564 /* TODO: Should we have a different name here? */
565 ret
= krb5_initlog(kctx
, "Samba", &logf
);
568 DEBUG(1,("krb5_initlog failed (%s)\n",
569 smb_get_krb5_error_message(kctx
, ret
, tmp_ctx
)));
570 talloc_free(tmp_ctx
);
573 (*smb_krb5_context
)->pvt_log_data
= logf
;
575 ret
= krb5_addlog_func(kctx
, logf
, 0 /* min */, -1 /* max */,
576 smb_krb5_debug_wrapper
,
577 smb_krb5_debug_close
, NULL
);
579 DEBUG(1,("krb5_addlog_func failed (%s)\n",
580 smb_get_krb5_error_message(kctx
, ret
, tmp_ctx
)));
581 talloc_free(tmp_ctx
);
584 krb5_set_warn_dest(kctx
, logf
);
586 /* Set options in kerberos */
588 krb5_set_dns_canonicalize_hostname(kctx
,
589 lpcfg_parm_bool(lp_ctx
, NULL
, "krb5",
590 "set_dns_canonicalize", false));
592 talloc_steal(parent_ctx
, *smb_krb5_context
);
593 talloc_free(tmp_ctx
);
598 #ifdef SAMBA4_USES_HEIMDAL
599 krb5_error_code
smb_krb5_context_set_event_ctx(struct smb_krb5_context
*smb_krb5_context
,
600 struct tevent_context
*ev
,
601 struct tevent_context
**previous_ev
)
608 *previous_ev
= smb_krb5_context
->current_ev
;
610 smb_krb5_context
->current_ev
= talloc_reference(smb_krb5_context
, ev
);
611 if (!smb_krb5_context
->current_ev
) {
615 /* Set use of our socket lib */
616 ret
= krb5_set_send_to_kdc_func(smb_krb5_context
->krb5_context
,
617 smb_krb5_send_and_recv_func
,
620 TALLOC_CTX
*tmp_ctx
= talloc_new(NULL
);
621 DEBUG(1,("krb5_set_send_recv_func failed (%s)\n",
622 smb_get_krb5_error_message(smb_krb5_context
->krb5_context
, ret
, tmp_ctx
)));
623 talloc_free(tmp_ctx
);
624 talloc_unlink(smb_krb5_context
, smb_krb5_context
->current_ev
);
625 smb_krb5_context
->current_ev
= NULL
;
631 krb5_error_code
smb_krb5_context_remove_event_ctx(struct smb_krb5_context
*smb_krb5_context
,
632 struct tevent_context
*previous_ev
,
633 struct tevent_context
*ev
)
636 talloc_unlink(smb_krb5_context
, ev
);
637 /* If there was a mismatch with things happening on a stack, then don't wipe things */
638 smb_krb5_context
->current_ev
= previous_ev
;
639 /* Set use of our socket lib */
640 ret
= krb5_set_send_to_kdc_func(smb_krb5_context
->krb5_context
,
641 smb_krb5_send_and_recv_func
,
644 TALLOC_CTX
*tmp_ctx
= talloc_new(NULL
);
645 DEBUG(1,("krb5_set_send_recv_func failed (%s)\n",
646 smb_get_krb5_error_message(smb_krb5_context
->krb5_context
, ret
, tmp_ctx
)));
647 talloc_free(tmp_ctx
);