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 2 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, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 see RFC1798 for details of CLDAP
27 - carried over UDP on port 389
28 - request and response matched by message ID
29 - request consists of only a single searchRequest element
30 - response can be in one of two forms
31 - a single searchResponse, followed by a searchResult
32 - a single searchResult
36 #include "lib/events/events.h"
37 #include "dlinklist.h"
38 #include "libcli/ldap/ldap.h"
39 #include "libcli/cldap/cldap.h"
40 #include "lib/socket/socket.h"
43 destroy a pending request
45 static int cldap_request_destructor(void *ptr)
47 struct cldap_request *req = talloc_get_type(ptr, struct cldap_request);
48 if (req->state == CLDAP_REQUEST_SEND) {
49 DLIST_REMOVE(req->cldap->send_queue, req);
51 if (!req->is_reply && req->message_id != 0) {
52 idr_remove(req->cldap->idr, req->message_id);
59 handle recv events on a cldap socket
61 static void cldap_socket_recv(struct cldap_socket *cldap)
63 TALLOC_CTX *tmp_ctx = talloc_new(cldap);
65 struct socket_address *src;
68 struct asn1_data asn1;
69 struct ldap_message *ldap_msg;
70 struct cldap_request *req;
72 status = socket_pending(cldap->sock, &dsize);
73 if (!NT_STATUS_IS_OK(status)) {
78 blob = data_blob_talloc(tmp_ctx, NULL, dsize);
79 if (blob.data == NULL) {
84 status = socket_recvfrom(cldap->sock, blob.data, blob.length, &nread, 0,
86 if (!NT_STATUS_IS_OK(status)) {
92 DEBUG(2,("Received cldap packet of length %d from %s:%d\n",
93 (int)blob.length, src->addr, src->port));
95 if (!asn1_load(&asn1, blob)) {
96 DEBUG(2,("Failed to setup for asn.1 decode\n"));
100 talloc_steal(tmp_ctx, asn1.data);
102 ldap_msg = talloc(tmp_ctx, struct ldap_message);
103 if (ldap_msg == NULL) {
104 talloc_free(tmp_ctx);
108 /* this initial decode is used to find the message id */
109 if (!ldap_decode(&asn1, ldap_msg)) {
110 DEBUG(2,("Failed to decode ldap message\n"));
111 talloc_free(tmp_ctx);
115 /* find the pending request */
116 req = idr_find(cldap->idr, ldap_msg->messageid);
118 if (cldap->incoming.handler) {
119 cldap->incoming.handler(cldap, ldap_msg, src);
121 DEBUG(2,("Mismatched cldap reply %u from %s:%d\n",
122 ldap_msg->messageid, src->addr, src->port));
124 talloc_free(tmp_ctx);
129 talloc_steal(req, asn1.data);
132 req->state = CLDAP_REQUEST_DONE;
133 talloc_free(req->te);
135 talloc_free(tmp_ctx);
143 handle request timeouts
145 static void cldap_request_timeout(struct event_context *event_ctx,
146 struct timed_event *te, struct timeval t,
149 struct cldap_request *req = talloc_get_type(private, struct cldap_request);
151 /* possibly try again */
152 if (req->num_retries != 0) {
153 size_t len = req->encoded.length;
157 socket_sendto(req->cldap->sock, &req->encoded, &len, 0,
160 req->te = event_add_timed(req->cldap->event_ctx, req,
161 timeval_current_ofs(req->timeout, 0),
162 cldap_request_timeout, req);
166 req->state = CLDAP_REQUEST_TIMEOUT;
173 handle send events on a cldap socket
175 static void cldap_socket_send(struct cldap_socket *cldap)
177 struct cldap_request *req;
180 while ((req = cldap->send_queue)) {
183 len = req->encoded.length;
184 status = socket_sendto(cldap->sock, &req->encoded, &len, 0,
186 if (NT_STATUS_IS_ERR(status)) {
187 DEBUG(3,("Failed to send cldap request of length %u to %s:%d\n",
188 (unsigned)req->encoded.length, req->dest->addr, req->dest->port));
189 DLIST_REMOVE(cldap->send_queue, req);
194 if (!NT_STATUS_IS_OK(status)) return;
196 DLIST_REMOVE(cldap->send_queue, req);
201 req->state = CLDAP_REQUEST_WAIT;
203 req->te = event_add_timed(cldap->event_ctx, req,
204 timeval_current_ofs(req->timeout, 0),
205 cldap_request_timeout, req);
207 EVENT_FD_READABLE(cldap->fde);
211 EVENT_FD_NOT_WRITEABLE(cldap->fde);
217 handle fd events on a cldap_socket
219 static void cldap_socket_handler(struct event_context *ev, struct fd_event *fde,
220 uint16_t flags, void *private)
222 struct cldap_socket *cldap = talloc_get_type(private, struct cldap_socket);
223 if (flags & EVENT_FD_WRITE) {
224 cldap_socket_send(cldap);
226 if (flags & EVENT_FD_READ) {
227 cldap_socket_recv(cldap);
232 initialise a cldap_socket. The event_ctx is optional, if provided
233 then operations will use that event context
235 struct cldap_socket *cldap_socket_init(TALLOC_CTX *mem_ctx,
236 struct event_context *event_ctx)
238 struct cldap_socket *cldap;
241 cldap = talloc(mem_ctx, struct cldap_socket);
242 if (cldap == NULL) goto failed;
244 if (event_ctx == NULL) {
245 cldap->event_ctx = event_context_init(cldap);
247 cldap->event_ctx = talloc_reference(cldap, event_ctx);
249 if (cldap->event_ctx == NULL) goto failed;
251 cldap->idr = idr_init(cldap);
252 if (cldap->idr == NULL) goto failed;
254 status = socket_create("ip", SOCKET_TYPE_DGRAM, &cldap->sock, 0);
255 if (!NT_STATUS_IS_OK(status)) goto failed;
257 talloc_steal(cldap, cldap->sock);
259 cldap->fde = event_add_fd(cldap->event_ctx, cldap,
260 socket_get_fd(cldap->sock), 0,
261 cldap_socket_handler, cldap);
263 cldap->send_queue = NULL;
264 cldap->incoming.handler = NULL;
275 setup a handler for incoming requests
277 NTSTATUS cldap_set_incoming_handler(struct cldap_socket *cldap,
278 void (*handler)(struct cldap_socket *, struct ldap_message *,
279 struct socket_address *),
282 cldap->incoming.handler = handler;
283 cldap->incoming.private = private;
284 EVENT_FD_READABLE(cldap->fde);
289 queue a cldap request for send
291 struct cldap_request *cldap_search_send(struct cldap_socket *cldap,
292 struct cldap_search *io)
294 struct ldap_message *msg;
295 struct cldap_request *req;
296 struct ldap_SearchRequest *search;
298 req = talloc_zero(cldap, struct cldap_request);
299 if (req == NULL) goto failed;
302 req->state = CLDAP_REQUEST_SEND;
303 req->timeout = io->in.timeout;
304 req->num_retries = io->in.retries;
305 req->is_reply = False;
307 req->dest = socket_address_from_strings(req, cldap->sock->backend_name,
308 io->in.dest_address, lp_cldap_port());
309 if (!req->dest) goto failed;
311 req->message_id = idr_get_new_random(cldap->idr, req, UINT16_MAX);
312 if (req->message_id == -1) goto failed;
314 talloc_set_destructor(req, cldap_request_destructor);
316 msg = talloc(req, struct ldap_message);
317 if (msg == NULL) goto failed;
318 msg->messageid = req->message_id;
319 msg->type = LDAP_TAG_SearchRequest;
320 msg->controls = NULL;
321 search = &msg->r.SearchRequest;
324 search->scope = LDAP_SEARCH_SCOPE_BASE;
325 search->deref = LDAP_DEREFERENCE_NEVER;
326 search->timelimit = 0;
327 search->sizelimit = 0;
328 search->attributesonly = False;
329 search->num_attributes = str_list_length(io->in.attributes);
330 search->attributes = io->in.attributes;
331 search->tree = ldb_parse_tree(req, io->in.filter);
332 if (search->tree == NULL) {
336 if (!ldap_encode(msg, &req->encoded, req)) {
337 DEBUG(0,("Failed to encode cldap message to %s:%d\n",
338 req->dest->addr, req->dest->port));
342 DLIST_ADD_END(cldap->send_queue, req, struct cldap_request *);
344 EVENT_FD_WRITEABLE(cldap->fde);
355 queue a cldap reply for send
357 NTSTATUS cldap_reply_send(struct cldap_socket *cldap, struct cldap_reply *io)
359 struct ldap_message *msg;
360 struct cldap_request *req;
361 DATA_BLOB blob1, blob2;
362 NTSTATUS status = NT_STATUS_NO_MEMORY;
364 req = talloc_zero(cldap, struct cldap_request);
365 if (req == NULL) goto failed;
368 req->state = CLDAP_REQUEST_SEND;
369 req->is_reply = True;
371 req->dest = io->dest;
372 if (talloc_reference(req, io->dest) == NULL) goto failed;
374 talloc_set_destructor(req, cldap_request_destructor);
376 msg = talloc(req, struct ldap_message);
377 if (msg == NULL) goto failed;
378 msg->messageid = io->messageid;
379 msg->controls = NULL;
382 msg->type = LDAP_TAG_SearchResultEntry;
383 msg->r.SearchResultEntry = *io->response;
385 if (!ldap_encode(msg, &blob1, req)) {
386 DEBUG(0,("Failed to encode cldap message to %s:%d\n",
387 req->dest->addr, req->dest->port));
388 status = NT_STATUS_INVALID_PARAMETER;
392 blob1 = data_blob(NULL, 0);
395 msg->type = LDAP_TAG_SearchResultDone;
396 msg->r.SearchResultDone = *io->result;
398 if (!ldap_encode(msg, &blob2, req)) {
399 DEBUG(0,("Failed to encode cldap message to %s:%d\n",
400 req->dest->addr, req->dest->port));
401 status = NT_STATUS_INVALID_PARAMETER;
405 req->encoded = data_blob_talloc(req, NULL, blob1.length + blob2.length);
406 if (req->encoded.data == NULL) goto failed;
408 memcpy(req->encoded.data, blob1.data, blob1.length);
409 memcpy(req->encoded.data+blob1.length, blob2.data, blob2.length);
411 DLIST_ADD_END(cldap->send_queue, req, struct cldap_request *);
413 EVENT_FD_WRITEABLE(cldap->fde);
423 receive a cldap reply
425 NTSTATUS cldap_search_recv(struct cldap_request *req,
427 struct cldap_search *io)
429 struct ldap_message *ldap_msg;
432 return NT_STATUS_NO_MEMORY;
435 while (req->state < CLDAP_REQUEST_DONE) {
436 if (event_loop_once(req->cldap->event_ctx) != 0) {
438 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
442 if (req->state == CLDAP_REQUEST_TIMEOUT) {
444 return NT_STATUS_IO_TIMEOUT;
447 ldap_msg = talloc(mem_ctx, struct ldap_message);
448 NT_STATUS_HAVE_NO_MEMORY(ldap_msg);
450 if (!ldap_decode(&req->asn1, ldap_msg)) {
452 return NT_STATUS_INVALID_PARAMETER;
455 ZERO_STRUCT(io->out);
457 /* the first possible form has a search result in first place */
458 if (ldap_msg->type == LDAP_TAG_SearchResultEntry) {
459 io->out.response = talloc(mem_ctx, struct ldap_SearchResEntry);
460 NT_STATUS_HAVE_NO_MEMORY(io->out.response);
461 *io->out.response = ldap_msg->r.SearchResultEntry;
463 /* decode the 2nd part */
464 if (!ldap_decode(&req->asn1, ldap_msg)) {
466 return NT_STATUS_INVALID_PARAMETER;
470 if (ldap_msg->type != LDAP_TAG_SearchResultDone) {
472 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
475 io->out.result = talloc(mem_ctx, struct ldap_Result);
476 NT_STATUS_HAVE_NO_MEMORY(io->out.result);
477 *io->out.result = ldap_msg->r.SearchResultDone;
485 synchronous cldap search
487 NTSTATUS cldap_search(struct cldap_socket *cldap,
489 struct cldap_search *io)
491 struct cldap_request *req = cldap_search_send(cldap, io);
492 return cldap_search_recv(req, mem_ctx, io);
498 queue a cldap netlogon for send
500 struct cldap_request *cldap_netlogon_send(struct cldap_socket *cldap,
501 struct cldap_netlogon *io)
503 struct cldap_search search;
505 struct cldap_request *req;
506 const char *attr[] = { "NetLogon", NULL };
507 TALLOC_CTX *tmp_ctx = talloc_new(cldap);
509 filter = talloc_asprintf(tmp_ctx, "(&(NtVer=%s)",
510 ldap_encode_ndr_uint32(tmp_ctx, io->in.version));
511 if (filter == NULL) goto failed;
513 filter = talloc_asprintf_append(filter, "(User=%s)", io->in.user);
514 if (filter == NULL) goto failed;
517 filter = talloc_asprintf_append(filter, "(Host=%s)", io->in.host);
518 if (filter == NULL) goto failed;
521 filter = talloc_asprintf_append(filter, "(DnsDomain=%s)", io->in.realm);
522 if (filter == NULL) goto failed;
524 if (io->in.acct_control != -1) {
525 filter = talloc_asprintf_append(filter, "(AAC=%s)",
526 ldap_encode_ndr_uint32(tmp_ctx, io->in.acct_control));
527 if (filter == NULL) goto failed;
529 if (io->in.domain_sid) {
530 struct dom_sid *sid = dom_sid_parse_talloc(tmp_ctx, io->in.domain_sid);
531 if (sid == NULL) goto failed;
532 filter = talloc_asprintf_append(filter, "(domainSid=%s)",
533 ldap_encode_ndr_dom_sid(tmp_ctx, sid));
534 if (filter == NULL) goto failed;
536 if (io->in.domain_guid) {
539 status = GUID_from_string(io->in.domain_guid, &guid);
540 if (!NT_STATUS_IS_OK(status)) goto failed;
541 filter = talloc_asprintf_append(filter, "(DomainGuid=%s)",
542 ldap_encode_ndr_GUID(tmp_ctx, &guid));
543 if (filter == NULL) goto failed;
545 filter = talloc_asprintf_append(filter, ")");
546 if (filter == NULL) goto failed;
548 search.in.dest_address = io->in.dest_address;
549 search.in.filter = filter;
550 search.in.attributes = attr;
551 search.in.timeout = 2;
552 search.in.retries = 2;
554 req = cldap_search_send(cldap, &search);
556 talloc_free(tmp_ctx);
559 talloc_free(tmp_ctx);
565 receive a cldap netlogon reply
567 NTSTATUS cldap_netlogon_recv(struct cldap_request *req,
569 struct cldap_netlogon *io)
572 struct cldap_search search;
575 status = cldap_search_recv(req, mem_ctx, &search);
576 if (!NT_STATUS_IS_OK(status)) {
579 if (search.out.response == NULL) {
580 return NT_STATUS_NOT_FOUND;
583 if (search.out.response->num_attributes != 1 ||
584 strcasecmp(search.out.response->attributes[0].name, "netlogon") != 0 ||
585 search.out.response->attributes[0].num_values != 1 ||
586 search.out.response->attributes[0].values->length < 2) {
587 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
589 data = search.out.response->attributes[0].values;
591 status = ndr_pull_union_blob(data, mem_ctx, &io->out.netlogon,
592 io->in.version & 0xF,
593 (ndr_pull_flags_fn_t)ndr_pull_nbt_cldap_netlogon);
594 if (!NT_STATUS_IS_OK(status)) {
595 DEBUG(2,("cldap failed to parse netlogon response of type 0x%02x\n",
596 SVAL(data->data, 0)));
597 dump_data(10, data->data, data->length);
604 sync cldap netlogon search
606 NTSTATUS cldap_netlogon(struct cldap_socket *cldap,
607 TALLOC_CTX *mem_ctx, struct cldap_netlogon *io)
609 struct cldap_request *req = cldap_netlogon_send(cldap, io);
610 return cldap_netlogon_recv(req, mem_ctx, io);
615 send an empty reply (used on any error, so the client doesn't keep waiting
616 or send the bad request again)
618 NTSTATUS cldap_empty_reply(struct cldap_socket *cldap,
620 struct socket_address *src)
623 struct cldap_reply reply;
624 struct ldap_Result result;
626 reply.messageid = message_id;
628 reply.response = NULL;
629 reply.result = &result;
633 status = cldap_reply_send(cldap, &reply);
640 send a netlogon reply
642 NTSTATUS cldap_netlogon_reply(struct cldap_socket *cldap,
644 struct socket_address *src,
646 union nbt_cldap_netlogon *netlogon)
649 struct cldap_reply reply;
650 struct ldap_SearchResEntry response;
651 struct ldap_Result result;
652 TALLOC_CTX *tmp_ctx = talloc_new(cldap);
655 status = ndr_push_union_blob(&blob, tmp_ctx, netlogon, version & 0xF,
656 (ndr_push_flags_fn_t)ndr_push_nbt_cldap_netlogon);
657 if (!NT_STATUS_IS_OK(status)) {
658 talloc_free(tmp_ctx);
662 reply.messageid = message_id;
664 reply.response = &response;
665 reply.result = &result;
670 response.num_attributes = 1;
671 response.attributes = talloc(tmp_ctx, struct ldb_message_element);
672 NT_STATUS_HAVE_NO_MEMORY(response.attributes);
673 response.attributes->name = "netlogon";
674 response.attributes->num_values = 1;
675 response.attributes->values = &blob;
677 status = cldap_reply_send(cldap, &reply);
679 talloc_free(tmp_ctx);