Remove two debug parameters, not used anywhere.
[Samba/gebeck_regimport.git] / source4 / auth / kerberos / krb5_init_context.c
blob06db904130504379661a19ca8fc18390c3c22cd1
1 /*
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/>.
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"
34 context structure for operations on cldap packets
36 struct smb_krb5_socket {
37 struct socket_context *sock;
39 /* the fd event */
40 struct fd_event *fde;
42 NTSTATUS status;
43 DATA_BLOB request, reply;
45 struct packet_context *packet;
47 size_t partial_read;
49 krb5_krbhst_info *hi;
52 static krb5_error_code smb_krb5_context_destroy_1(struct smb_krb5_context *ctx)
54 krb5_free_context(ctx->krb5_context);
55 return 0;
58 static krb5_error_code smb_krb5_context_destroy_2(struct smb_krb5_context *ctx)
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;
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;
72 static void smb_krb5_debug_wrapper(const char *timestr, const char *msg, void *private)
74 DEBUG(2, ("Kerberos: %s\n", msg));
78 handle recv events on a smb_krb5 socket
80 static void smb_krb5_socket_recv(struct smb_krb5_socket *smb_krb5)
82 TALLOC_CTX *tmp_ctx = talloc_new(smb_krb5);
83 DATA_BLOB blob;
84 size_t nread, dsize;
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;
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;
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;
104 blob.length = nread;
106 if (nread == 0) {
107 smb_krb5->status = NT_STATUS_UNEXPECTED_NETWORK_ERROR;
108 talloc_free(tmp_ctx);
109 return;
112 DEBUG(2,("Received smb_krb5 packet of length %d\n",
113 (int)blob.length));
115 talloc_steal(smb_krb5, blob.data);
116 smb_krb5->reply = blob;
117 talloc_free(tmp_ctx);
120 static NTSTATUS smb_krb5_full_packet(void *private, DATA_BLOB data)
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;
131 handle request timeouts
133 static void smb_krb5_request_timeout(struct event_context *event_ctx,
134 struct timed_event *te, struct timeval t,
135 void *private)
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;
142 static void smb_krb5_error_handler(void *private, NTSTATUS status)
144 struct smb_krb5_socket *smb_krb5 = talloc_get_type(private, struct smb_krb5_socket);
145 smb_krb5->status = status;
149 handle send events on a smb_krb5 socket
151 static void smb_krb5_socket_send(struct smb_krb5_socket *smb_krb5)
153 NTSTATUS status;
155 size_t len;
157 len = smb_krb5->request.length;
158 status = socket_send(smb_krb5->sock, &smb_krb5->request, &len);
160 if (!NT_STATUS_IS_OK(status)) return;
162 EVENT_FD_READABLE(smb_krb5->fde);
164 EVENT_FD_NOT_WRITEABLE(smb_krb5->fde);
165 return;
170 handle fd events on a smb_krb5_socket
172 static void smb_krb5_socket_handler(struct event_context *ev, struct fd_event *fde,
173 uint16_t flags, void *private)
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;
182 if (flags & EVENT_FD_WRITE) {
183 smb_krb5_socket_send(smb_krb5);
184 return;
186 /* not reached */
187 return;
188 case KRB5_KRBHST_TCP:
189 if (flags & EVENT_FD_READ) {
190 packet_recv(smb_krb5->packet);
191 return;
193 if (flags & EVENT_FD_WRITE) {
194 packet_queue_run(smb_krb5->packet);
195 return;
197 /* not reached */
198 return;
199 case KRB5_KRBHST_HTTP:
200 /* can't happen */
201 break;
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)
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;
220 struct event_context *ev = talloc_get_type(data, struct event_context);
222 DATA_BLOB send_blob = data_blob_const(send_buf->data, send_buf->length);
224 ret = krb5_krbhst_get_addrinfo(context, hi, &ai);
225 if (ret) {
226 return ret;
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;
234 smb_krb5->hi = hi;
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;
250 status = NT_STATUS_INVALID_PARAMETER;
251 switch (hi->proto) {
252 case KRB5_KRBHST_UDP:
253 status = socket_create(name, SOCKET_TYPE_DGRAM, &smb_krb5->sock, 0);
254 break;
255 case KRB5_KRBHST_TCP:
256 status = socket_create(name, SOCKET_TYPE_STREAM, &smb_krb5->sock, 0);
257 break;
258 case KRB5_KRBHST_HTTP:
259 talloc_free(smb_krb5);
260 return EINVAL;
262 if (!NT_STATUS_IS_OK(status)) {
263 talloc_free(smb_krb5);
264 continue;
267 talloc_steal(smb_krb5, smb_krb5->sock);
269 remote_addr = socket_address_from_sockaddr(smb_krb5, a->ai_addr, a->ai_addrlen);
270 if (!remote_addr) {
271 talloc_free(smb_krb5);
272 continue;
275 status = socket_connect_ev(smb_krb5->sock, NULL, remote_addr, 0,
276 NULL, ev);
277 if (!NT_STATUS_IS_OK(status)) {
278 talloc_free(smb_krb5);
279 continue;
281 talloc_free(remote_addr);
283 /* Setup the FDE, start listening for read events
284 * from the start (otherwise we may miss a socket
285 * drop) and mark as AUTOCLOSE along with the fde */
287 /* Ths is equivilant to EVENT_FD_READABLE(smb_krb5->fde) */
288 smb_krb5->fde = event_add_fd(ev, smb_krb5->sock,
289 socket_get_fd(smb_krb5->sock),
290 EVENT_FD_READ|EVENT_FD_AUTOCLOSE,
291 smb_krb5_socket_handler, smb_krb5);
292 /* its now the job of the event layer to close the socket */
293 socket_set_flags(smb_krb5->sock, SOCKET_FLAG_NOCLOSE);
295 event_add_timed(ev, smb_krb5,
296 timeval_current_ofs(timeout, 0),
297 smb_krb5_request_timeout, smb_krb5);
300 smb_krb5->status = NT_STATUS_OK;
301 smb_krb5->reply = data_blob(NULL, 0);
303 switch (hi->proto) {
304 case KRB5_KRBHST_UDP:
305 EVENT_FD_WRITEABLE(smb_krb5->fde);
306 smb_krb5->request = send_blob;
307 break;
308 case KRB5_KRBHST_TCP:
310 smb_krb5->packet = packet_init(smb_krb5);
311 if (smb_krb5->packet == NULL) {
312 talloc_free(smb_krb5);
313 return ENOMEM;
315 packet_set_private(smb_krb5->packet, smb_krb5);
316 packet_set_socket(smb_krb5->packet, smb_krb5->sock);
317 packet_set_callback(smb_krb5->packet, smb_krb5_full_packet);
318 packet_set_full_request(smb_krb5->packet, packet_full_request_u32);
319 packet_set_error_handler(smb_krb5->packet, smb_krb5_error_handler);
320 packet_set_event_context(smb_krb5->packet, ev);
321 packet_set_fde(smb_krb5->packet, smb_krb5->fde);
323 smb_krb5->request = data_blob_talloc(smb_krb5, NULL, send_blob.length + 4);
324 RSIVAL(smb_krb5->request.data, 0, send_blob.length);
325 memcpy(smb_krb5->request.data+4, send_blob.data, send_blob.length);
326 packet_send(smb_krb5->packet, smb_krb5->request);
327 break;
328 case KRB5_KRBHST_HTTP:
329 talloc_free(smb_krb5);
330 return EINVAL;
332 while ((NT_STATUS_IS_OK(smb_krb5->status)) && !smb_krb5->reply.length) {
333 if (event_loop_once(ev) != 0) {
334 talloc_free(smb_krb5);
335 return EINVAL;
338 if (NT_STATUS_EQUAL(smb_krb5->status, NT_STATUS_IO_TIMEOUT)) {
339 talloc_free(smb_krb5);
340 continue;
343 if (!NT_STATUS_IS_OK(smb_krb5->status)) {
344 DEBUG(2,("Error reading smb_krb5 reply packet: %s\n", nt_errstr(smb_krb5->status)));
345 talloc_free(smb_krb5);
346 continue;
349 ret = krb5_data_copy(recv_buf, smb_krb5->reply.data, smb_krb5->reply.length);
350 if (ret) {
351 talloc_free(smb_krb5);
352 return ret;
354 talloc_free(smb_krb5);
356 break;
358 if (a) {
359 return 0;
361 return KRB5_KDC_UNREACH;
364 krb5_error_code smb_krb5_init_context(void *parent_ctx,
365 struct event_context *ev,
366 struct loadparm_context *lp_ctx,
367 struct smb_krb5_context **smb_krb5_context)
369 krb5_error_code ret;
370 TALLOC_CTX *tmp_ctx;
371 char **config_files;
372 const char *config_file;
374 initialize_krb5_error_table();
376 tmp_ctx = talloc_new(parent_ctx);
377 *smb_krb5_context = talloc(tmp_ctx, struct smb_krb5_context);
379 if (!*smb_krb5_context || !tmp_ctx) {
380 talloc_free(tmp_ctx);
381 return ENOMEM;
384 ret = krb5_init_context(&(*smb_krb5_context)->krb5_context);
385 if (ret) {
386 DEBUG(1,("krb5_init_context failed (%s)\n",
387 error_message(ret)));
388 talloc_free(tmp_ctx);
389 return ret;
392 talloc_set_destructor(*smb_krb5_context, smb_krb5_context_destroy_1);
394 config_file = config_path(tmp_ctx, lp_ctx, "krb5.conf");
395 if (!config_file) {
396 talloc_free(tmp_ctx);
397 return ENOMEM;
400 /* Use our local krb5.conf file by default */
401 ret = krb5_prepend_config_files_default(config_file == NULL?"":config_file, &config_files);
402 if (ret) {
403 DEBUG(1,("krb5_prepend_config_files_default failed (%s)\n",
404 smb_get_krb5_error_message((*smb_krb5_context)->krb5_context, ret, tmp_ctx)));
405 talloc_free(tmp_ctx);
406 return ret;
409 ret = krb5_set_config_files((*smb_krb5_context)->krb5_context,
410 config_files);
411 krb5_free_config_files(config_files);
412 if (ret) {
413 DEBUG(1,("krb5_set_config_files failed (%s)\n",
414 smb_get_krb5_error_message((*smb_krb5_context)->krb5_context, ret, tmp_ctx)));
415 talloc_free(tmp_ctx);
416 return ret;
419 if (lp_realm(lp_ctx) && *lp_realm(lp_ctx)) {
420 char *upper_realm = strupper_talloc(tmp_ctx, lp_realm(lp_ctx));
421 if (!upper_realm) {
422 DEBUG(1,("gensec_krb5_start: could not uppercase realm: %s\n", lp_realm(lp_ctx)));
423 talloc_free(tmp_ctx);
424 return ENOMEM;
426 ret = krb5_set_default_realm((*smb_krb5_context)->krb5_context, upper_realm);
427 if (ret) {
428 DEBUG(1,("krb5_set_default_realm failed (%s)\n",
429 smb_get_krb5_error_message((*smb_krb5_context)->krb5_context, ret, tmp_ctx)));
430 talloc_free(tmp_ctx);
431 return ret;
435 /* TODO: Should we have a different name here? */
436 ret = krb5_initlog((*smb_krb5_context)->krb5_context, "Samba", &(*smb_krb5_context)->logf);
438 if (ret) {
439 DEBUG(1,("krb5_initlog failed (%s)\n",
440 smb_get_krb5_error_message((*smb_krb5_context)->krb5_context, ret, tmp_ctx)));
441 talloc_free(tmp_ctx);
442 return ret;
445 talloc_set_destructor(*smb_krb5_context, smb_krb5_context_destroy_2);
447 ret = krb5_addlog_func((*smb_krb5_context)->krb5_context, (*smb_krb5_context)->logf, 0 /* min */, -1 /* max */,
448 smb_krb5_debug_wrapper, smb_krb5_debug_close, NULL);
449 if (ret) {
450 DEBUG(1,("krb5_addlog_func failed (%s)\n",
451 smb_get_krb5_error_message((*smb_krb5_context)->krb5_context, ret, tmp_ctx)));
452 talloc_free(tmp_ctx);
453 return ret;
455 krb5_set_warn_dest((*smb_krb5_context)->krb5_context, (*smb_krb5_context)->logf);
457 /* Set use of our socket lib */
458 ret = krb5_set_send_to_kdc_func((*smb_krb5_context)->krb5_context,
459 smb_krb5_send_and_recv_func,
460 ev);
461 if (ret) {
462 DEBUG(1,("krb5_set_send_recv_func failed (%s)\n",
463 smb_get_krb5_error_message((*smb_krb5_context)->krb5_context, ret, tmp_ctx)));
464 talloc_free(tmp_ctx);
465 return ret;
468 talloc_steal(parent_ctx, *smb_krb5_context);
469 talloc_free(tmp_ctx);
471 /* Set options in kerberos */
473 krb5_set_dns_canonicalize_hostname((*smb_krb5_context)->krb5_context,
474 lp_parm_bool(lp_ctx, NULL, "krb5", "set_dns_canonicalize", false));
476 return 0;