490a03d50e835debd8ec66bc491da6d455cf334a
[kamenim/samba.git] / source4 / libcli / cldap / cldap.c
1 /* 
2    Unix SMB/CIFS implementation.
3
4    cldap client library
5
6    Copyright (C) Andrew Tridgell 2005
7    
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.
12    
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.
17    
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.
21 */
22
23 /*
24   see RFC1798 for details of CLDAP
25
26   basic properties
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
33 */
34
35 #include "includes.h"
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"
41
42 /*
43   destroy a pending request
44 */
45 static int cldap_request_destructor(void *ptr)
46 {
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);
50         }
51         if (!req->is_reply && req->message_id != 0) {
52                 idr_remove(req->cldap->idr, req->message_id);
53                 req->message_id = 0;
54         }
55         return 0;
56 }
57
58 /*
59   handle recv events on a cldap socket
60 */
61 static void cldap_socket_recv(struct cldap_socket *cldap)
62 {
63         TALLOC_CTX *tmp_ctx = talloc_new(cldap);
64         NTSTATUS status;
65         struct socket_address *src;
66         DATA_BLOB blob;
67         size_t nread, dsize;
68         struct asn1_data asn1;
69         struct ldap_message *ldap_msg;
70         struct cldap_request *req;
71
72         status = socket_pending(cldap->sock, &dsize);
73         if (!NT_STATUS_IS_OK(status)) {
74                 talloc_free(tmp_ctx);
75                 return;
76         }
77
78         blob = data_blob_talloc(tmp_ctx, NULL, dsize);
79         if (blob.data == NULL) {
80                 talloc_free(tmp_ctx);
81                 return;
82         }
83
84         status = socket_recvfrom(cldap->sock, blob.data, blob.length, &nread, 0,
85                                  tmp_ctx, &src);
86         if (!NT_STATUS_IS_OK(status)) {
87                 talloc_free(tmp_ctx);
88                 return;
89         }
90         blob.length = nread;
91
92         DEBUG(2,("Received cldap packet of length %d from %s:%d\n", 
93                  (int)blob.length, src->addr, src->port));
94
95         if (!asn1_load(&asn1, blob)) {
96                 DEBUG(2,("Failed to setup for asn.1 decode\n"));
97                 talloc_free(tmp_ctx);
98                 return;
99         }
100         talloc_steal(tmp_ctx, asn1.data);
101
102         ldap_msg = talloc(tmp_ctx, struct ldap_message);
103         if (ldap_msg == NULL) {
104                 talloc_free(tmp_ctx);
105                 return;
106         }
107
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);
112                 return;
113         }
114
115         /* find the pending request */
116         req = idr_find(cldap->idr, ldap_msg->messageid);
117         if (req == NULL) {
118                 if (cldap->incoming.handler) {
119                         cldap->incoming.handler(cldap, ldap_msg, src);
120                 } else {
121                         DEBUG(2,("Mismatched cldap reply %u from %s:%d\n",
122                                  ldap_msg->messageid, src->addr, src->port));
123                 }
124                 talloc_free(tmp_ctx);
125                 return;
126         }
127
128         req->asn1 = asn1;
129         talloc_steal(req, asn1.data);
130         req->asn1.ofs = 0;
131
132         req->state = CLDAP_REQUEST_DONE;
133         talloc_free(req->te);
134
135         talloc_free(tmp_ctx);
136
137         if (req->async.fn) {
138                 req->async.fn(req);
139         }
140 }
141
142 /*
143   handle request timeouts
144 */
145 static void cldap_request_timeout(struct event_context *event_ctx, 
146                                   struct timed_event *te, struct timeval t,
147                                   void *private)
148 {
149         struct cldap_request *req = talloc_get_type(private, struct cldap_request);
150
151         /* possibly try again */
152         if (req->num_retries != 0) {
153                 size_t len = req->encoded.length;
154
155                 req->num_retries--;
156
157                 socket_sendto(req->cldap->sock, &req->encoded, &len, 0, 
158                               req->dest);
159
160                 req->te = event_add_timed(req->cldap->event_ctx, req, 
161                                           timeval_current_ofs(req->timeout, 0),
162                                           cldap_request_timeout, req);
163                 return;
164         }
165
166         req->state = CLDAP_REQUEST_TIMEOUT;
167         if (req->async.fn) {
168                 req->async.fn(req);
169         }
170 }
171
172 /*
173   handle send events on a cldap socket
174 */
175 static void cldap_socket_send(struct cldap_socket *cldap)
176 {
177         struct cldap_request *req;
178         NTSTATUS status;
179
180         while ((req = cldap->send_queue)) {
181                 size_t len;
182                 
183                 len = req->encoded.length;
184                 status = socket_sendto(cldap->sock, &req->encoded, &len, 0, 
185                                        req->dest);
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);
190                         talloc_free(req);
191                         continue;
192                 }
193
194                 if (!NT_STATUS_IS_OK(status)) return;
195
196                 DLIST_REMOVE(cldap->send_queue, req);
197
198                 if (req->is_reply) {
199                         talloc_free(req);
200                 } else {
201                         req->state = CLDAP_REQUEST_WAIT;
202
203                         req->te = event_add_timed(cldap->event_ctx, req, 
204                                                   timeval_current_ofs(req->timeout, 0),
205                                                   cldap_request_timeout, req);
206
207                         EVENT_FD_READABLE(cldap->fde);
208                 }
209         }
210
211         EVENT_FD_NOT_WRITEABLE(cldap->fde);
212         return;
213 }
214
215
216 /*
217   handle fd events on a cldap_socket
218 */
219 static void cldap_socket_handler(struct event_context *ev, struct fd_event *fde,
220                                  uint16_t flags, void *private)
221 {
222         struct cldap_socket *cldap = talloc_get_type(private, struct cldap_socket);
223         if (flags & EVENT_FD_WRITE) {
224                 cldap_socket_send(cldap);
225         } 
226         if (flags & EVENT_FD_READ) {
227                 cldap_socket_recv(cldap);
228         }
229 }
230
231 /*
232   initialise a cldap_socket. The event_ctx is optional, if provided
233   then operations will use that event context
234 */
235 struct cldap_socket *cldap_socket_init(TALLOC_CTX *mem_ctx, 
236                                        struct event_context *event_ctx)
237 {
238         struct cldap_socket *cldap;
239         NTSTATUS status;
240
241         cldap = talloc(mem_ctx, struct cldap_socket);
242         if (cldap == NULL) goto failed;
243
244         if (event_ctx == NULL) {
245                 cldap->event_ctx = event_context_init(cldap);
246         } else {
247                 cldap->event_ctx = talloc_reference(cldap, event_ctx);
248         }
249         if (cldap->event_ctx == NULL) goto failed;
250
251         cldap->idr = idr_init(cldap);
252         if (cldap->idr == NULL) goto failed;
253
254         status = socket_create("ip", SOCKET_TYPE_DGRAM, &cldap->sock, 0);
255         if (!NT_STATUS_IS_OK(status)) goto failed;
256
257         talloc_steal(cldap, cldap->sock);
258
259         cldap->fde = event_add_fd(cldap->event_ctx, cldap, 
260                                       socket_get_fd(cldap->sock), 0,
261                                       cldap_socket_handler, cldap);
262
263         cldap->send_queue = NULL;
264         cldap->incoming.handler = NULL;
265         
266         return cldap;
267
268 failed:
269         talloc_free(cldap);
270         return NULL;
271 }
272
273
274 /*
275   setup a handler for incoming requests
276 */
277 NTSTATUS cldap_set_incoming_handler(struct cldap_socket *cldap,
278                                   void (*handler)(struct cldap_socket *, struct ldap_message *, 
279                                                   struct socket_address *),
280                                   void *private)
281 {
282         cldap->incoming.handler = handler;
283         cldap->incoming.private = private;
284         EVENT_FD_READABLE(cldap->fde);
285         return NT_STATUS_OK;
286 }
287
288 /*
289   queue a cldap request for send
290 */
291 struct cldap_request *cldap_search_send(struct cldap_socket *cldap, 
292                                         struct cldap_search *io)
293 {
294         struct ldap_message *msg;
295         struct cldap_request *req;
296         struct ldap_SearchRequest *search;
297
298         req = talloc_zero(cldap, struct cldap_request);
299         if (req == NULL) goto failed;
300
301         req->cldap       = cldap;
302         req->state       = CLDAP_REQUEST_SEND;
303         req->timeout     = io->in.timeout;
304         req->num_retries = io->in.retries;
305         req->is_reply    = False;
306
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;
310
311         req->message_id = idr_get_new_random(cldap->idr, req, UINT16_MAX);
312         if (req->message_id == -1) goto failed;
313
314         talloc_set_destructor(req, cldap_request_destructor);
315
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;
322
323         search->basedn         = "";
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) {
333                 goto failed;
334         }
335
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));
339                 goto failed;
340         }
341
342         DLIST_ADD_END(cldap->send_queue, req, struct cldap_request *);
343
344         EVENT_FD_WRITEABLE(cldap->fde);
345
346         return req;
347
348 failed:
349         talloc_free(req);
350         return NULL;
351 }
352
353
354 /*
355   queue a cldap reply for send
356 */
357 NTSTATUS cldap_reply_send(struct cldap_socket *cldap, struct cldap_reply *io)
358 {
359         struct ldap_message *msg;
360         struct cldap_request *req;
361         DATA_BLOB blob1, blob2;
362         NTSTATUS status = NT_STATUS_NO_MEMORY;
363
364         req = talloc_zero(cldap, struct cldap_request);
365         if (req == NULL) goto failed;
366
367         req->cldap       = cldap;
368         req->state       = CLDAP_REQUEST_SEND;
369         req->is_reply    = True;
370
371         req->dest        = io->dest;
372         if (talloc_reference(req, io->dest) == NULL) goto failed;
373
374         talloc_set_destructor(req, cldap_request_destructor);
375
376         msg = talloc(req, struct ldap_message);
377         if (msg == NULL) goto failed;
378         msg->messageid       = io->messageid;
379         msg->controls        = NULL;
380         
381         if (io->response) {
382                 msg->type = LDAP_TAG_SearchResultEntry;
383                 msg->r.SearchResultEntry = *io->response;
384
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;
389                         goto failed;
390                 }
391         } else {
392                 blob1 = data_blob(NULL, 0);
393         }
394
395         msg->type = LDAP_TAG_SearchResultDone;
396         msg->r.SearchResultDone = *io->result;
397
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;
402                 goto failed;
403         }
404
405         req->encoded = data_blob_talloc(req, NULL, blob1.length + blob2.length);
406         if (req->encoded.data == NULL) goto failed;
407
408         memcpy(req->encoded.data, blob1.data, blob1.length);
409         memcpy(req->encoded.data+blob1.length, blob2.data, blob2.length);
410
411         DLIST_ADD_END(cldap->send_queue, req, struct cldap_request *);
412
413         EVENT_FD_WRITEABLE(cldap->fde);
414
415         return NT_STATUS_OK;
416
417 failed:
418         talloc_free(req);
419         return status;
420 }
421
422 /*
423   receive a cldap reply
424 */
425 NTSTATUS cldap_search_recv(struct cldap_request *req, 
426                            TALLOC_CTX *mem_ctx, 
427                            struct cldap_search *io)
428 {
429         struct ldap_message *ldap_msg;
430
431         if (req == NULL) {
432                 return NT_STATUS_NO_MEMORY;
433         }
434
435         while (req->state < CLDAP_REQUEST_DONE) {
436                 if (event_loop_once(req->cldap->event_ctx) != 0) {
437                         talloc_free(req);
438                         return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
439                 }
440         }
441
442         if (req->state == CLDAP_REQUEST_TIMEOUT) {
443                 talloc_free(req);
444                 return NT_STATUS_IO_TIMEOUT;
445         }
446
447         ldap_msg = talloc(mem_ctx, struct ldap_message);
448         NT_STATUS_HAVE_NO_MEMORY(ldap_msg);
449
450         if (!ldap_decode(&req->asn1, ldap_msg)) {
451                 talloc_free(req);
452                 return NT_STATUS_INVALID_PARAMETER;
453         }
454
455         ZERO_STRUCT(io->out);
456
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;
462
463                 /* decode the 2nd part */
464                 if (!ldap_decode(&req->asn1, ldap_msg)) {
465                         talloc_free(req);
466                         return NT_STATUS_INVALID_PARAMETER;
467                 }
468         }
469
470         if (ldap_msg->type != LDAP_TAG_SearchResultDone) {
471                 talloc_free(req);
472                 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
473         }
474
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;
478
479         talloc_free(req);
480         return NT_STATUS_OK;
481 }
482
483
484 /*
485   synchronous cldap search
486 */
487 NTSTATUS cldap_search(struct cldap_socket *cldap, 
488                       TALLOC_CTX *mem_ctx, 
489                       struct cldap_search *io)
490 {
491         struct cldap_request *req = cldap_search_send(cldap, io);
492         return cldap_search_recv(req, mem_ctx, io);
493 }
494
495
496
497 /*
498   queue a cldap netlogon for send
499 */
500 struct cldap_request *cldap_netlogon_send(struct cldap_socket *cldap, 
501                                           struct cldap_netlogon *io)
502 {
503         struct cldap_search search;
504         char *filter;
505         struct cldap_request *req;
506         const char *attr[] = { "NetLogon", NULL };
507         TALLOC_CTX *tmp_ctx = talloc_new(cldap);
508
509         filter = talloc_asprintf(tmp_ctx, "(&(NtVer=%s)", 
510                                  ldap_encode_ndr_uint32(tmp_ctx, io->in.version));
511         if (filter == NULL) goto failed;
512         if (io->in.user) {
513                 filter = talloc_asprintf_append(filter, "(User=%s)", io->in.user);
514                 if (filter == NULL) goto failed;
515         }
516         if (io->in.host) {
517                 filter = talloc_asprintf_append(filter, "(Host=%s)", io->in.host);
518                 if (filter == NULL) goto failed;
519         }
520         if (io->in.realm) {
521                 filter = talloc_asprintf_append(filter, "(DnsDomain=%s)", io->in.realm);
522                 if (filter == NULL) goto failed;
523         }
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;
528         }
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;
535         }
536         if (io->in.domain_guid) {
537                 struct GUID guid;
538                 NTSTATUS status;
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;
544         }
545         filter = talloc_asprintf_append(filter, ")");
546         if (filter == NULL) goto failed;
547
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;
553
554         req = cldap_search_send(cldap, &search);
555
556         talloc_free(tmp_ctx);
557         return req;
558 failed:
559         talloc_free(tmp_ctx);
560         return NULL;
561 }
562
563
564 /*
565   receive a cldap netlogon reply
566 */
567 NTSTATUS cldap_netlogon_recv(struct cldap_request *req, 
568                              TALLOC_CTX *mem_ctx, 
569                              struct cldap_netlogon *io)
570 {
571         NTSTATUS status;
572         struct cldap_search search;
573         DATA_BLOB *data;
574
575         status = cldap_search_recv(req, mem_ctx, &search);
576         if (!NT_STATUS_IS_OK(status)) {
577                 return status;
578         }
579         if (search.out.response == NULL) {
580                 return NT_STATUS_NOT_FOUND;
581         }
582
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;
588         }
589         data = search.out.response->attributes[0].values;
590
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);
598         }
599
600         return status;
601 }
602
603 /*
604   sync cldap netlogon search
605 */
606 NTSTATUS cldap_netlogon(struct cldap_socket *cldap, 
607                         TALLOC_CTX *mem_ctx, struct cldap_netlogon *io)
608 {
609         struct cldap_request *req = cldap_netlogon_send(cldap, io);
610         return cldap_netlogon_recv(req, mem_ctx, io);
611 }
612
613
614 /*
615   send an empty reply (used on any error, so the client doesn't keep waiting
616   or send the bad request again)
617 */
618 NTSTATUS cldap_empty_reply(struct cldap_socket *cldap, 
619                            uint32_t message_id,
620                            struct socket_address *src)
621 {
622         NTSTATUS status;
623         struct cldap_reply reply;
624         struct ldap_Result result;
625
626         reply.messageid    = message_id;
627         reply.dest         = src;
628         reply.response     = NULL;
629         reply.result       = &result;
630
631         ZERO_STRUCT(result);
632
633         status = cldap_reply_send(cldap, &reply);
634
635         return status;
636 }
637
638
639 /*
640   send a netlogon reply 
641 */
642 NTSTATUS cldap_netlogon_reply(struct cldap_socket *cldap, 
643                               uint32_t message_id,
644                               struct socket_address *src,
645                               uint32_t version,
646                               union nbt_cldap_netlogon *netlogon)
647 {
648         NTSTATUS status;
649         struct cldap_reply reply;
650         struct ldap_SearchResEntry response;
651         struct ldap_Result result;
652         TALLOC_CTX *tmp_ctx = talloc_new(cldap);
653         DATA_BLOB blob;
654
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);
659                 return status;
660         }
661
662         reply.messageid    = message_id;
663         reply.dest         = src;
664         reply.response     = &response;
665         reply.result       = &result;
666
667         ZERO_STRUCT(result);
668
669         response.dn = "";
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;
676
677         status = cldap_reply_send(cldap, &reply);
678
679         talloc_free(tmp_ctx);
680
681         return status;
682 }
683
684