2 Unix SMB/CIFS implementation.
6 Copyright (C) Andrew Tridgell 2005
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 see RFC1798 for details of CLDAP
26 - carried over UDP on port 389
27 - request and response matched by message ID
28 - request consists of only a single searchRequest element
29 - response can be in one of two forms
30 - a single searchResponse, followed by a searchResult
31 - a single searchResult
35 #include "lib/events/events.h"
36 #include "lib/util/dlinklist.h"
37 #include "libcli/ldap/ldap.h"
38 #include "libcli/ldap/ldap_ndr.h"
39 #include "libcli/cldap/cldap.h"
40 #include "lib/socket/socket.h"
41 #include "libcli/security/security.h"
42 #include "librpc/gen_ndr/ndr_nbt.h"
43 #include "param/param.h"
46 destroy a pending request
48 static int cldap_request_destructor(struct cldap_request *req)
50 if (req->state == CLDAP_REQUEST_SEND) {
51 DLIST_REMOVE(req->cldap->send_queue, req);
53 if (!req->is_reply && req->message_id != 0) {
54 idr_remove(req->cldap->idr, req->message_id);
61 handle recv events on a cldap socket
63 static void cldap_socket_recv(struct cldap_socket *cldap)
65 TALLOC_CTX *tmp_ctx = talloc_new(cldap);
67 struct socket_address *src;
70 struct asn1_data *asn1 = asn1_init(tmp_ctx);
71 struct ldap_message *ldap_msg;
72 struct cldap_request *req;
76 status = socket_pending(cldap->sock, &dsize);
77 if (!NT_STATUS_IS_OK(status)) {
82 blob = data_blob_talloc(tmp_ctx, NULL, dsize);
83 if (blob.data == NULL) {
88 status = socket_recvfrom(cldap->sock, blob.data, blob.length, &nread,
90 if (!NT_STATUS_IS_OK(status)) {
96 DEBUG(2,("Received cldap packet of length %d from %s:%d\n",
97 (int)blob.length, src->addr, src->port));
99 if (!asn1_load(asn1, blob)) {
100 DEBUG(2,("Failed to setup for asn.1 decode\n"));
101 talloc_free(tmp_ctx);
105 ldap_msg = talloc(tmp_ctx, struct ldap_message);
106 if (ldap_msg == NULL) {
107 talloc_free(tmp_ctx);
111 /* this initial decode is used to find the message id */
112 status = ldap_decode(asn1, ldap_msg);
113 if (!NT_STATUS_IS_OK(status)) {
114 DEBUG(2,("Failed to decode ldap message: %s\n", nt_errstr(status)));
115 talloc_free(tmp_ctx);
119 /* find the pending request */
120 req = idr_find(cldap->idr, ldap_msg->messageid);
122 if (cldap->incoming.handler) {
123 cldap->incoming.handler(cldap, ldap_msg, src);
125 DEBUG(2,("Mismatched cldap reply %u from %s:%d\n",
126 ldap_msg->messageid, src->addr, src->port));
128 talloc_free(tmp_ctx);
132 req->asn1 = talloc_steal(req, asn1);
135 req->state = CLDAP_REQUEST_DONE;
136 talloc_free(req->te);
138 talloc_free(tmp_ctx);
146 handle request timeouts
148 static void cldap_request_timeout(struct event_context *event_ctx,
149 struct timed_event *te, struct timeval t,
152 struct cldap_request *req = talloc_get_type(private, struct cldap_request);
154 /* possibly try again */
155 if (req->num_retries != 0) {
156 size_t len = req->encoded.length;
160 socket_sendto(req->cldap->sock, &req->encoded, &len,
163 req->te = event_add_timed(req->cldap->event_ctx, req,
164 timeval_current_ofs(req->timeout, 0),
165 cldap_request_timeout, req);
169 req->state = CLDAP_REQUEST_ERROR;
170 req->status = NT_STATUS_IO_TIMEOUT;
177 handle send events on a cldap socket
179 static void cldap_socket_send(struct cldap_socket *cldap)
181 struct cldap_request *req;
184 while ((req = cldap->send_queue)) {
187 len = req->encoded.length;
188 status = socket_sendto(cldap->sock, &req->encoded, &len,
190 if (NT_STATUS_IS_ERR(status)) {
191 DEBUG(0,("Failed to send cldap request of length %u to %s:%d\n",
192 (unsigned)req->encoded.length, req->dest->addr, req->dest->port));
193 DLIST_REMOVE(cldap->send_queue, req);
194 req->state = CLDAP_REQUEST_ERROR;
195 req->status = status;
202 if (!NT_STATUS_IS_OK(status)) return;
204 DLIST_REMOVE(cldap->send_queue, req);
209 req->state = CLDAP_REQUEST_WAIT;
211 req->te = event_add_timed(cldap->event_ctx, req,
212 timeval_current_ofs(req->timeout, 0),
213 cldap_request_timeout, req);
215 EVENT_FD_READABLE(cldap->fde);
219 EVENT_FD_NOT_WRITEABLE(cldap->fde);
225 handle fd events on a cldap_socket
227 static void cldap_socket_handler(struct event_context *ev, struct fd_event *fde,
228 uint16_t flags, void *private)
230 struct cldap_socket *cldap = talloc_get_type(private, struct cldap_socket);
231 if (flags & EVENT_FD_WRITE) {
232 cldap_socket_send(cldap);
234 if (flags & EVENT_FD_READ) {
235 cldap_socket_recv(cldap);
240 initialise a cldap_socket. The event_ctx is optional, if provided
241 then operations will use that event context
243 struct cldap_socket *cldap_socket_init(TALLOC_CTX *mem_ctx,
244 struct event_context *event_ctx,
245 struct smb_iconv_convenience *iconv_convenience)
247 struct cldap_socket *cldap;
250 cldap = talloc(mem_ctx, struct cldap_socket);
251 if (cldap == NULL) goto failed;
253 cldap->event_ctx = talloc_reference(cldap, event_ctx);
254 if (cldap->event_ctx == NULL) goto failed;
256 cldap->idr = idr_init(cldap);
257 if (cldap->idr == NULL) goto failed;
259 status = socket_create("ip", SOCKET_TYPE_DGRAM, &cldap->sock, 0);
260 if (!NT_STATUS_IS_OK(status)) goto failed;
262 talloc_steal(cldap, cldap->sock);
264 cldap->fde = event_add_fd(cldap->event_ctx, cldap,
265 socket_get_fd(cldap->sock), 0,
266 cldap_socket_handler, cldap);
268 cldap->send_queue = NULL;
269 cldap->incoming.handler = NULL;
270 cldap->iconv_convenience = iconv_convenience;
281 setup a handler for incoming requests
283 NTSTATUS cldap_set_incoming_handler(struct cldap_socket *cldap,
284 void (*handler)(struct cldap_socket *, struct ldap_message *,
285 struct socket_address *),
288 cldap->incoming.handler = handler;
289 cldap->incoming.private = private;
290 EVENT_FD_READABLE(cldap->fde);
295 queue a cldap request for send
297 struct cldap_request *cldap_search_send(struct cldap_socket *cldap,
298 struct cldap_search *io)
300 struct ldap_message *msg;
301 struct cldap_request *req;
302 struct ldap_SearchRequest *search;
304 req = talloc_zero(cldap, struct cldap_request);
305 if (req == NULL) goto failed;
308 req->state = CLDAP_REQUEST_SEND;
309 req->timeout = io->in.timeout;
310 req->num_retries = io->in.retries;
311 req->is_reply = false;
312 req->asn1 = asn1_init(req);
317 req->dest = socket_address_from_strings(req, cldap->sock->backend_name,
320 if (!req->dest) goto failed;
322 req->message_id = idr_get_new_random(cldap->idr, req, UINT16_MAX);
323 if (req->message_id == -1) goto failed;
325 talloc_set_destructor(req, cldap_request_destructor);
327 msg = talloc(req, struct ldap_message);
328 if (msg == NULL) goto failed;
329 msg->messageid = req->message_id;
330 msg->type = LDAP_TAG_SearchRequest;
331 msg->controls = NULL;
332 search = &msg->r.SearchRequest;
335 search->scope = LDAP_SEARCH_SCOPE_BASE;
336 search->deref = LDAP_DEREFERENCE_NEVER;
337 search->timelimit = 0;
338 search->sizelimit = 0;
339 search->attributesonly = false;
340 search->num_attributes = str_list_length(io->in.attributes);
341 search->attributes = io->in.attributes;
342 search->tree = ldb_parse_tree(req, io->in.filter);
343 if (search->tree == NULL) {
347 if (!ldap_encode(msg, &req->encoded, req)) {
348 DEBUG(0,("Failed to encode cldap message to %s:%d\n",
349 req->dest->addr, req->dest->port));
353 DLIST_ADD_END(cldap->send_queue, req, struct cldap_request *);
355 EVENT_FD_WRITEABLE(cldap->fde);
366 queue a cldap reply for send
368 NTSTATUS cldap_reply_send(struct cldap_socket *cldap, struct cldap_reply *io)
370 struct ldap_message *msg;
371 struct cldap_request *req;
372 DATA_BLOB blob1, blob2;
373 NTSTATUS status = NT_STATUS_NO_MEMORY;
375 req = talloc_zero(cldap, struct cldap_request);
376 if (req == NULL) goto failed;
379 req->state = CLDAP_REQUEST_SEND;
380 req->is_reply = true;
381 req->asn1 = asn1_init(req);
386 req->dest = io->dest;
387 if (talloc_reference(req, io->dest) == NULL) goto failed;
389 talloc_set_destructor(req, cldap_request_destructor);
391 msg = talloc(req, struct ldap_message);
392 if (msg == NULL) goto failed;
393 msg->messageid = io->messageid;
394 msg->controls = NULL;
397 msg->type = LDAP_TAG_SearchResultEntry;
398 msg->r.SearchResultEntry = *io->response;
400 if (!ldap_encode(msg, &blob1, req)) {
401 DEBUG(0,("Failed to encode cldap message to %s:%d\n",
402 req->dest->addr, req->dest->port));
403 status = NT_STATUS_INVALID_PARAMETER;
407 blob1 = data_blob(NULL, 0);
410 msg->type = LDAP_TAG_SearchResultDone;
411 msg->r.SearchResultDone = *io->result;
413 if (!ldap_encode(msg, &blob2, req)) {
414 DEBUG(0,("Failed to encode cldap message to %s:%d\n",
415 req->dest->addr, req->dest->port));
416 status = NT_STATUS_INVALID_PARAMETER;
420 req->encoded = data_blob_talloc(req, NULL, blob1.length + blob2.length);
421 if (req->encoded.data == NULL) goto failed;
423 memcpy(req->encoded.data, blob1.data, blob1.length);
424 memcpy(req->encoded.data+blob1.length, blob2.data, blob2.length);
426 DLIST_ADD_END(cldap->send_queue, req, struct cldap_request *);
428 EVENT_FD_WRITEABLE(cldap->fde);
438 receive a cldap reply
440 NTSTATUS cldap_search_recv(struct cldap_request *req,
442 struct cldap_search *io)
444 struct ldap_message *ldap_msg;
448 return NT_STATUS_NO_MEMORY;
451 while (req->state < CLDAP_REQUEST_DONE) {
452 if (event_loop_once(req->cldap->event_ctx) != 0) {
454 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
458 if (req->state == CLDAP_REQUEST_ERROR) {
459 status = req->status;
464 ldap_msg = talloc(mem_ctx, struct ldap_message);
465 NT_STATUS_HAVE_NO_MEMORY(ldap_msg);
467 status = ldap_decode(req->asn1, ldap_msg);
468 if (!NT_STATUS_IS_OK(status)) {
469 DEBUG(2,("Failed to decode cldap search reply: %s\n", nt_errstr(status)));
474 ZERO_STRUCT(io->out);
476 /* the first possible form has a search result in first place */
477 if (ldap_msg->type == LDAP_TAG_SearchResultEntry) {
478 io->out.response = talloc(mem_ctx, struct ldap_SearchResEntry);
479 NT_STATUS_HAVE_NO_MEMORY(io->out.response);
480 *io->out.response = ldap_msg->r.SearchResultEntry;
482 /* decode the 2nd part */
483 status = ldap_decode(req->asn1, ldap_msg);
484 if (!NT_STATUS_IS_OK(status)) {
485 DEBUG(2,("Failed to decode cldap search result entry: %s\n", nt_errstr(status)));
491 if (ldap_msg->type != LDAP_TAG_SearchResultDone) {
493 return NT_STATUS_LDAP(LDAP_PROTOCOL_ERROR);
496 io->out.result = talloc(mem_ctx, struct ldap_Result);
497 NT_STATUS_HAVE_NO_MEMORY(io->out.result);
498 *io->out.result = ldap_msg->r.SearchResultDone;
502 if (io->out.result->resultcode != LDAP_SUCCESS) {
503 return NT_STATUS_LDAP(io->out.result->resultcode);
510 synchronous cldap search
512 NTSTATUS cldap_search(struct cldap_socket *cldap,
514 struct cldap_search *io)
516 struct cldap_request *req = cldap_search_send(cldap, io);
517 return cldap_search_recv(req, mem_ctx, io);
523 queue a cldap netlogon for send
525 struct cldap_request *cldap_netlogon_send(struct cldap_socket *cldap,
526 struct cldap_netlogon *io)
528 struct cldap_search search;
530 struct cldap_request *req;
531 const char *attr[] = { "NetLogon", NULL };
532 TALLOC_CTX *tmp_ctx = talloc_new(cldap);
534 filter = talloc_asprintf(tmp_ctx, "(&(NtVer=%s)",
535 ldap_encode_ndr_uint32(tmp_ctx, io->in.version));
536 if (filter == NULL) goto failed;
538 filter = talloc_asprintf_append_buffer(filter, "(User=%s)", io->in.user);
539 if (filter == NULL) goto failed;
542 filter = talloc_asprintf_append_buffer(filter, "(Host=%s)", io->in.host);
543 if (filter == NULL) goto failed;
546 filter = talloc_asprintf_append_buffer(filter, "(DnsDomain=%s)", io->in.realm);
547 if (filter == NULL) goto failed;
549 if (io->in.acct_control != -1) {
550 filter = talloc_asprintf_append_buffer(filter, "(AAC=%s)",
551 ldap_encode_ndr_uint32(tmp_ctx, io->in.acct_control));
552 if (filter == NULL) goto failed;
554 if (io->in.domain_sid) {
555 struct dom_sid *sid = dom_sid_parse_talloc(tmp_ctx, io->in.domain_sid);
556 if (sid == NULL) goto failed;
557 filter = talloc_asprintf_append_buffer(filter, "(domainSid=%s)",
558 ldap_encode_ndr_dom_sid(tmp_ctx, sid));
559 if (filter == NULL) goto failed;
561 if (io->in.domain_guid) {
564 status = GUID_from_string(io->in.domain_guid, &guid);
565 if (!NT_STATUS_IS_OK(status)) goto failed;
566 filter = talloc_asprintf_append_buffer(filter, "(DomainGuid=%s)",
567 ldap_encode_ndr_GUID(tmp_ctx, &guid));
568 if (filter == NULL) goto failed;
570 filter = talloc_asprintf_append_buffer(filter, ")");
571 if (filter == NULL) goto failed;
573 search.in.dest_address = io->in.dest_address;
574 search.in.dest_port = io->in.dest_port;
575 search.in.filter = filter;
576 search.in.attributes = attr;
577 search.in.timeout = 2;
578 search.in.retries = 2;
580 req = cldap_search_send(cldap, &search);
582 talloc_free(tmp_ctx);
585 talloc_free(tmp_ctx);
591 receive a cldap netlogon reply
593 NTSTATUS cldap_netlogon_recv(struct cldap_request *req,
595 struct cldap_netlogon *io)
598 struct cldap_search search;
599 struct cldap_socket *cldap;
604 status = cldap_search_recv(req, mem_ctx, &search);
605 if (!NT_STATUS_IS_OK(status)) {
608 if (search.out.response == NULL) {
609 return NT_STATUS_NOT_FOUND;
612 if (search.out.response->num_attributes != 1 ||
613 strcasecmp(search.out.response->attributes[0].name, "netlogon") != 0 ||
614 search.out.response->attributes[0].num_values != 1 ||
615 search.out.response->attributes[0].values->length < 2) {
616 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
618 data = search.out.response->attributes[0].values;
620 status = pull_netlogon_samlogon_response(data, mem_ctx, req->cldap->iconv_convenience,
622 if (!NT_STATUS_IS_OK(status)) {
626 if (io->in.map_response) {
627 map_netlogon_samlogon_response(&io->out.netlogon);
633 sync cldap netlogon search
635 NTSTATUS cldap_netlogon(struct cldap_socket *cldap,
636 TALLOC_CTX *mem_ctx, struct cldap_netlogon *io)
638 struct cldap_request *req = cldap_netlogon_send(cldap, io);
639 return cldap_netlogon_recv(req, mem_ctx, io);
644 send an empty reply (used on any error, so the client doesn't keep waiting
645 or send the bad request again)
647 NTSTATUS cldap_empty_reply(struct cldap_socket *cldap,
649 struct socket_address *src)
652 struct cldap_reply reply;
653 struct ldap_Result result;
655 reply.messageid = message_id;
657 reply.response = NULL;
658 reply.result = &result;
662 status = cldap_reply_send(cldap, &reply);
668 send an error reply (used on any error, so the client doesn't keep waiting
669 or send the bad request again)
671 NTSTATUS cldap_error_reply(struct cldap_socket *cldap,
673 struct socket_address *src,
675 const char *errormessage)
678 struct cldap_reply reply;
679 struct ldap_Result result;
681 reply.messageid = message_id;
683 reply.response = NULL;
684 reply.result = &result;
687 result.resultcode = resultcode;
688 result.errormessage = errormessage;
690 status = cldap_reply_send(cldap, &reply);
697 send a netlogon reply
699 NTSTATUS cldap_netlogon_reply(struct cldap_socket *cldap,
701 struct socket_address *src,
703 struct netlogon_samlogon_response *netlogon)
706 struct cldap_reply reply;
707 struct ldap_SearchResEntry response;
708 struct ldap_Result result;
709 TALLOC_CTX *tmp_ctx = talloc_new(cldap);
712 status = push_netlogon_samlogon_response(&blob, tmp_ctx, cldap->iconv_convenience,
714 if (!NT_STATUS_IS_OK(status)) {
717 reply.messageid = message_id;
719 reply.response = &response;
720 reply.result = &result;
725 response.num_attributes = 1;
726 response.attributes = talloc(tmp_ctx, struct ldb_message_element);
727 NT_STATUS_HAVE_NO_MEMORY(response.attributes);
728 response.attributes->name = "netlogon";
729 response.attributes->num_values = 1;
730 response.attributes->values = &blob;
732 status = cldap_reply_send(cldap, &reply);
734 talloc_free(tmp_ctx);