summaryrefslogtreecommitdiff
path: root/source4/libcli/ldap/ldap_client.c
blob: f2b09e89e326c7a42aa53a998767c93af2c2f130 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
/* 
   Unix SMB/CIFS mplementation.
   LDAP protocol helper functions for SAMBA
   
   Copyright (C) Andrew Tridgell  2004
   Copyright (C) Volker Lendecke 2004
   Copyright (C) Stefan Metzmacher 2004
   Copyright (C) Simo Sorce 2004
    
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
   
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
   
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   
*/

#include "includes.h"
#include "asn_1.h"
#include "dlinklist.h"
#include "lib/events/events.h"
#include "lib/socket/socket.h"
#include "libcli/ldap/ldap.h"
#include "libcli/ldap/ldap_client.h"


/*
  create a new ldap_connection stucture. The event context is optional
*/
struct ldap_connection *ldap_new_connection(TALLOC_CTX *mem_ctx, 
					    struct event_context *ev)
{
	struct ldap_connection *conn;

	conn = talloc_zero(mem_ctx, struct ldap_connection);
	if (conn == NULL) {
		return NULL;
	}

	if (ev == NULL) {
		ev = event_context_init(conn);
		if (ev == NULL) {
			talloc_free(conn);
			return NULL;
		}
	}

	conn->next_messageid  = 1;
	conn->event.event_ctx = ev;

	/* set a reasonable request timeout */
	conn->timeout = 60;

	return conn;
}


/*
  the connection is dead
*/
static void ldap_connection_dead(struct ldap_connection *conn)
{
	struct ldap_request *req;

	while (conn->pending) {
		req = conn->pending;
		DLIST_REMOVE(req->conn->pending, req);
		req->state = LDAP_REQUEST_DONE;
		req->status = NT_STATUS_UNEXPECTED_NETWORK_ERROR;
		if (req->async.fn) {
			req->async.fn(req);
		}
	}	

	while (conn->send_queue) {
		req = conn->send_queue;
		DLIST_REMOVE(req->conn->send_queue, req);
		req->state = LDAP_REQUEST_DONE;
		req->status = NT_STATUS_UNEXPECTED_NETWORK_ERROR;
		if (req->async.fn) {
			req->async.fn(req);
		}
	}

	talloc_free(conn->sock);
	conn->sock = NULL;
}


/*
  match up with a pending message, adding to the replies list
*/
static void ldap_match_message(struct ldap_connection *conn, struct ldap_message *msg)
{
	struct ldap_request *req;

	for (req=conn->pending; req; req=req->next) {
		if (req->messageid == msg->messageid) break;
	}
	if (req == NULL) {
		DEBUG(0,("ldap: no matching message id for %u\n",
			 msg->messageid));
		talloc_free(msg);
		return;
	}

	/* add to the list of replies received */
	talloc_steal(req, msg);
	req->replies = talloc_realloc(req, req->replies, 
				      struct ldap_message *, req->num_replies+1);
	if (req->replies == NULL) {
		req->status = NT_STATUS_NO_MEMORY;
		req->state = LDAP_REQUEST_DONE;
		DLIST_REMOVE(conn->pending, req);
		if (req->async.fn) {
			req->async.fn(req);
		}
		return;
	}

	req->replies[req->num_replies] = talloc_steal(req->replies, msg);
	req->num_replies++;

	if (msg->type != LDAP_TAG_SearchResultEntry) {
		/* currently only search results expect multiple
		   replies */
		req->state = LDAP_REQUEST_DONE;
		DLIST_REMOVE(conn->pending, req);
	}

	if (req->async.fn) {
		req->async.fn(req);
	}
}

/*
  try and decode/process plain data
*/
static void ldap_try_decode_plain(struct ldap_connection *conn)
{
	struct asn1_data asn1;

	if (!asn1_load(&asn1, conn->partial)) {
		ldap_connection_dead(conn);
		return;
	}

	/* try and decode - this will fail if we don't have a full packet yet */
	while (asn1.ofs < asn1.length) {
		struct ldap_message *msg = talloc(conn, struct ldap_message);
		if (msg == NULL) {
			ldap_connection_dead(conn);
			return;
		}

		if (ldap_decode(&asn1, msg)) {
			ldap_match_message(conn, msg);
		} else {
			talloc_free(msg);
			break;
		}
	}

	/* keep any remaining data in conn->partial */
	data_blob_free(&conn->partial);
	if (asn1.ofs != conn->partial.length) {
		conn->partial = data_blob_talloc(conn, 
						 asn1.data + asn1.ofs, 
						 asn1.length - asn1.ofs);
	}
	asn1_free(&asn1);
}

/*
  try and decode/process wrapped data
*/
static void ldap_try_decode_wrapped(struct ldap_connection *conn)
{
	uint32_t len;

	/* keep decoding while we have a full wrapped packet */
	while (conn->partial.length >= 4 &&
	       (len=RIVAL(conn->partial.data, 0)) <= conn->partial.length-4) {
		DATA_BLOB wrapped, unwrapped;
		struct asn1_data asn1;
		struct ldap_message *msg = talloc(conn, struct ldap_message);
		NTSTATUS status;

		if (msg == NULL) {
			ldap_connection_dead(conn);
			return;
		}

		wrapped.data   = conn->partial.data+4;
		wrapped.length = len;

		status = gensec_unwrap(conn->gensec, msg, &wrapped, &unwrapped);
		if (!NT_STATUS_IS_OK(status)) {
			ldap_connection_dead(conn);
			return;
		}

		if (!asn1_load(&asn1, unwrapped)) {
			ldap_connection_dead(conn);
			return;
		}

		while (ldap_decode(&asn1, msg)) {
			ldap_match_message(conn, msg);
			msg = talloc(conn, struct ldap_message);
		}
		
		talloc_free(msg);
		asn1_free(&asn1);

		if (conn->partial.length == len + 4) {
			data_blob_free(&conn->partial);
		} else {
			memmove(conn->partial.data, conn->partial.data+len+4,
				conn->partial.length - (len+4));
			conn->partial.length -= len + 4;
		}
	}
}


/*
  handle ldap recv events
*/
static void ldap_recv_handler(struct ldap_connection *conn)
{
	NTSTATUS status;
	size_t npending=0, nread;

	/* work out how much data is pending */
	status = socket_pending(conn->sock, &npending);
	if (!NT_STATUS_IS_OK(status) || npending == 0) {
		ldap_connection_dead(conn);
		return;
	}

	conn->partial.data = talloc_realloc_size(conn, conn->partial.data, 
						 conn->partial.length + npending);
	if (conn->partial.data == NULL) {
		ldap_connection_dead(conn);
		return;
	}

	/* receive the pending data */
	status = socket_recv(conn->sock, conn->partial.data + conn->partial.length,
			     npending, &nread, 0);
	if (NT_STATUS_EQUAL(status, STATUS_MORE_ENTRIES)) {
		return;
	}
	if (!NT_STATUS_IS_OK(status)) {
		ldap_connection_dead(conn);
		return;
	}
	conn->partial.length += nread;

	/* see if we can decode what we have */
	if (conn->enable_wrap) {
		ldap_try_decode_wrapped(conn);
	} else {
		ldap_try_decode_plain(conn);
	}
}


/*
  handle ldap send events
*/
static void ldap_send_handler(struct ldap_connection *conn)
{
	while (conn->send_queue) {
		struct ldap_request *req = conn->send_queue;
		size_t nsent;
		NTSTATUS status;

		status = socket_send(conn->sock, &req->data, &nsent, 0);
		if (NT_STATUS_EQUAL(status, STATUS_MORE_ENTRIES)) {
			break;
		}
		if (!NT_STATUS_IS_OK(status)) {
			ldap_connection_dead(conn);
			return;
		}

		req->data.data += nsent;
		req->data.length -= nsent;
		if (req->data.length == 0) {
			req->state = LDAP_REQUEST_PENDING;
			DLIST_REMOVE(conn->send_queue, req);

			/* some types of requests don't expect a reply */
			if (req->type == LDAP_TAG_AbandonRequest ||
			    req->type == LDAP_TAG_UnbindRequest) {
				req->status = NT_STATUS_OK;
				req->state = LDAP_REQUEST_DONE;
				if (req->async.fn) {
					req->async.fn(req);
				}
			} else {
				DLIST_ADD(conn->pending, req);
			}
		}
	}
	if (conn->send_queue == NULL) {
		EVENT_FD_NOT_WRITEABLE(conn->event.fde);
	}
}


/*
  handle ldap socket events
*/
static void ldap_io_handler(struct event_context *ev, struct fd_event *fde, 
			    uint16_t flags, void *private)
{
	struct ldap_connection *conn = talloc_get_type(private, struct ldap_connection);
	if (flags & EVENT_FD_WRITE) {
		ldap_send_handler(conn);
		if (conn->sock == NULL) return;
	}
	if (flags & EVENT_FD_READ) {
		ldap_recv_handler(conn);
	}
}

/*
  parse a ldap URL
*/
static NTSTATUS ldap_parse_basic_url(TALLOC_CTX *mem_ctx, const char *url,
				     char **host, uint16_t *port, BOOL *ldaps)
{
	int tmp_port = 0;
	char protocol[11];
	char tmp_host[255];
	const char *p = url;
	int ret;

	/* skip leading "URL:" (if any) */
	if (strncasecmp(p, "URL:", 4) == 0) {
		p += 4;
	}

	/* Paranoia check */
	SMB_ASSERT(sizeof(protocol)>10 && sizeof(tmp_host)>254);
		
	ret = sscanf(p, "%10[^:]://%254[^:/]:%d", protocol, tmp_host, &tmp_port);
	if (ret < 2) {
		return NT_STATUS_INVALID_PARAMETER;
	}

	if (strequal(protocol, "ldap")) {
		*port = 389;
		*ldaps = False;
	} else if (strequal(protocol, "ldaps")) {
		*port = 636;
		*ldaps = True;
	} else {
		DEBUG(0, ("unrecognised ldap protocol (%s)!\n", protocol));
		return NT_STATUS_PROTOCOL_UNREACHABLE;
	}

	if (tmp_port != 0)
		*port = tmp_port;

	*host = talloc_strdup(mem_ctx, tmp_host);
	NT_STATUS_HAVE_NO_MEMORY(*host);

	return NT_STATUS_OK;
}

/*
  connect to a ldap server
*/
NTSTATUS ldap_connect(struct ldap_connection *conn, const char *url)
{
	NTSTATUS status;

	status = ldap_parse_basic_url(conn, url, &conn->host,
				      &conn->port, &conn->ldaps);
	NT_STATUS_NOT_OK_RETURN(status);

	status = socket_create("ipv4", SOCKET_TYPE_STREAM, &conn->sock, 0);
	NT_STATUS_NOT_OK_RETURN(status);

	talloc_steal(conn, conn->sock);

	/* connect in a event friendly way */
	status = socket_connect_ev(conn->sock, NULL, 0, conn->host, conn->port, 0, 
				   conn->event.event_ctx);
	if (!NT_STATUS_IS_OK(status)) {
		talloc_free(conn->sock);
		return status;
	}

	/* setup a handler for events on this socket */
	conn->event.fde = event_add_fd(conn->event.event_ctx, conn->sock, 
				       socket_get_fd(conn->sock), 
				       EVENT_FD_READ, ldap_io_handler, conn);
	if (conn->event.fde == NULL) {
		talloc_free(conn->sock);
		return NT_STATUS_INTERNAL_ERROR;
	}

	return NT_STATUS_OK;
}

/* destroy an open ldap request */
static int ldap_request_destructor(void *ptr)
{
	struct ldap_request *req = talloc_get_type(ptr, struct ldap_request);
	if (req->state == LDAP_REQUEST_SEND) {
		DLIST_REMOVE(req->conn->send_queue, req);
	}
	if (req->state == LDAP_REQUEST_PENDING) {
		DLIST_REMOVE(req->conn->pending, req);
	}
	return 0;
}

/*
  called on timeout of a ldap request
*/
static void ldap_request_timeout(struct event_context *ev, struct timed_event *te, 
				      struct timeval t, void *private)
{
	struct ldap_request *req = talloc_get_type(private, struct ldap_request);
	req->status = NT_STATUS_IO_TIMEOUT;
	if (req->state == LDAP_REQUEST_SEND) {
		DLIST_REMOVE(req->conn->send_queue, req);
	}
	if (req->state == LDAP_REQUEST_PENDING) {
		DLIST_REMOVE(req->conn->pending, req);
	}
	req->state = LDAP_REQUEST_DONE;
	if (req->async.fn) {
		req->async.fn(req);
	}
}

/*
  send a ldap message - async interface
*/
struct ldap_request *ldap_request_send(struct ldap_connection *conn,
				       struct ldap_message *msg)
{
	struct ldap_request *req;

	if (conn->sock == NULL) {
		return NULL;
	}

	req = talloc_zero(conn, struct ldap_request);
	if (req == NULL) goto failed;

	req->state       = LDAP_REQUEST_SEND;
	req->conn        = conn;
	req->messageid   = conn->next_messageid++;
	req->type        = msg->type;
	if (req->messageid == -1) {
		goto failed;
	}

	talloc_set_destructor(req, ldap_request_destructor);

	msg->messageid = req->messageid;

	if (!ldap_encode(msg, &req->data)) {
		goto failed;		
	}

	/* possibly encrypt/sign the request */
	if (conn->enable_wrap) {
		DATA_BLOB wrapped;
		NTSTATUS status;

		status = gensec_wrap(conn->gensec, req, &req->data, &wrapped);
		if (!NT_STATUS_IS_OK(status)) {
			goto failed;
		}
		data_blob_free(&req->data);
		req->data = data_blob_talloc(req, NULL, wrapped.length + 4);
		if (req->data.data == NULL) {
			goto failed;
		}
		RSIVAL(req->data.data, 0, wrapped.length);
		memcpy(req->data.data+4, wrapped.data, wrapped.length);
		data_blob_free(&wrapped);
	}


	if (conn->send_queue == NULL) {
		EVENT_FD_WRITEABLE(conn->event.fde);
	}
	DLIST_ADD_END(conn->send_queue, req, struct ldap_request *);

	/* put a timeout on the request */
	event_add_timed(conn->event.event_ctx, req, 
			timeval_current_ofs(conn->timeout, 0),
			ldap_request_timeout, req);

	return req;

failed:
	talloc_free(req);
	return NULL;
}


/*
  wait for a request to complete
  note that this does not destroy the request
*/
NTSTATUS ldap_request_wait(struct ldap_request *req)
{
	while (req->state != LDAP_REQUEST_DONE) {
		if (event_loop_once(req->conn->event.event_ctx) != 0) {
			req->status = NT_STATUS_UNEXPECTED_NETWORK_ERROR;
			break;
		}
	}
	return req->status;
}


/*
  used to setup the status code from a ldap response
*/
NTSTATUS ldap_check_response(struct ldap_connection *conn, struct ldap_Result *r)
{
	if (r->resultcode == LDAP_SUCCESS) {
		return NT_STATUS_OK;
	}

	if (conn->last_error) {
		talloc_free(conn->last_error);
	}
	conn->last_error = talloc_asprintf(conn, "LDAP error %u - %s <%s> <%s>", 
					   r->resultcode,
					   r->dn?r->dn:"(NULL)", 
					   r->errormessage?r->errormessage:"", 
					   r->referral?r->referral:"");
	
	return NT_STATUS_LDAP(r->resultcode);
}

/*
  return error string representing the last error
*/
const char *ldap_errstr(struct ldap_connection *conn, NTSTATUS status)
{
	if (NT_STATUS_IS_LDAP(status) && conn->last_error != NULL) {
		return conn->last_error;
	}
	return nt_errstr(status);
}


/*
  return the Nth result message, waiting if necessary
*/
NTSTATUS ldap_result_n(struct ldap_request *req, int n, struct ldap_message **msg)
{
	*msg = NULL;

	NT_STATUS_HAVE_NO_MEMORY(req);

	while (req->state != LDAP_REQUEST_DONE && n >= req->num_replies) {
		if (event_loop_once(req->conn->event.event_ctx) != 0) {
			return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
		}
	}

	if (n < req->num_replies) {
		*msg = req->replies[n];
		return NT_STATUS_OK;
	}

	if (!NT_STATUS_IS_OK(req->status)) {
		return req->status;
	}

	return NT_STATUS_NO_MORE_ENTRIES;
}


/*
  return a single result message, checking if it is of the expected LDAP type
*/
NTSTATUS ldap_result_one(struct ldap_request *req, struct ldap_message **msg, int type)
{
	NTSTATUS status;
	status = ldap_result_n(req, 0, msg);
	if (!NT_STATUS_IS_OK(status)) {
		return status;
	}
	if ((*msg)->type != type) {
		*msg = NULL;
		return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
	}
	return status;
}

/*
  a simple ldap transaction, for single result requests that only need a status code
  this relies on single valued requests having the response type == request type + 1
*/
NTSTATUS ldap_transaction(struct ldap_connection *conn, struct ldap_message *msg)
{
	struct ldap_request *req = ldap_request_send(conn, msg);
	struct ldap_message *res;
	NTSTATUS status;
	status = ldap_result_n(req, 0, &res);
	if (!NT_STATUS_IS_OK(status)) {
		talloc_free(req);
		return status;
	}
	if (res->type != msg->type + 1) {
		talloc_free(req);
		return NT_STATUS_LDAP(LDAP_PROTOCOL_ERROR);
	}
	status = ldap_check_response(conn, &res->r.GeneralResult);
	talloc_free(req);
	return status;
}