2 Unix SMB/CIFS mplementation.
3 LDAP protocol helper functions for SAMBA
5 Copyright (C) Andrew Tridgell 2004
6 Copyright (C) Volker Lendecke 2004
7 Copyright (C) Stefan Metzmacher 2004
8 Copyright (C) Simo Sorce 2004
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
27 #include "libcli/util/asn_1.h"
28 #include "dlinklist.h"
29 #include "lib/events/events.h"
30 #include "lib/socket/socket.h"
31 #include "libcli/ldap/ldap.h"
32 #include "libcli/ldap/ldap_client.h"
33 #include "libcli/composite/composite.h"
34 #include "lib/stream/packet.h"
35 #include "lib/tls/tls.h"
36 #include "auth/gensec/gensec.h"
37 #include "system/time.h"
41 create a new ldap_connection stucture. The event context is optional
43 struct ldap_connection *ldap_new_connection(TALLOC_CTX *mem_ctx,
44 struct event_context *ev)
46 struct ldap_connection *conn;
48 conn = talloc_zero(mem_ctx, struct ldap_connection);
54 ev = event_context_init(conn);
61 conn->next_messageid = 1;
62 conn->event.event_ctx = ev;
64 /* set a reasonable request timeout */
67 /* explicitly avoid reconnections by default */
68 conn->reconnect.max_retries = 0;
74 the connection is dead
76 static void ldap_connection_dead(struct ldap_connection *conn)
78 struct ldap_request *req;
80 /* return an error for any pending request ... */
81 while (conn->pending) {
83 DLIST_REMOVE(req->conn->pending, req);
84 req->state = LDAP_REQUEST_DONE;
85 req->status = NT_STATUS_UNEXPECTED_NETWORK_ERROR;
91 talloc_free(conn->sock); /* this will also free event.fde */
92 talloc_free(conn->packet);
94 conn->event.fde = NULL;
98 static void ldap_reconnect(struct ldap_connection *conn);
103 static void ldap_error_handler(void *private_data, NTSTATUS status)
105 struct ldap_connection *conn = talloc_get_type(private_data,
106 struct ldap_connection);
107 ldap_connection_dead(conn);
109 /* but try to reconnect so that the ldb client can go on */
110 ldap_reconnect(conn);
115 match up with a pending message, adding to the replies list
117 static void ldap_match_message(struct ldap_connection *conn, struct ldap_message *msg)
119 struct ldap_request *req;
121 for (req=conn->pending; req; req=req->next) {
122 if (req->messageid == msg->messageid) break;
124 /* match a zero message id to the last request sent.
125 It seems that servers send 0 if unable to parse */
126 if (req == NULL && msg->messageid == 0) {
130 DEBUG(0,("ldap: no matching message id for %u\n",
136 /* add to the list of replies received */
137 talloc_steal(req, msg);
138 req->replies = talloc_realloc(req, req->replies,
139 struct ldap_message *, req->num_replies+1);
140 if (req->replies == NULL) {
141 req->status = NT_STATUS_NO_MEMORY;
142 req->state = LDAP_REQUEST_DONE;
143 DLIST_REMOVE(conn->pending, req);
150 req->replies[req->num_replies] = talloc_steal(req->replies, msg);
153 if (msg->type != LDAP_TAG_SearchResultEntry &&
154 msg->type != LDAP_TAG_SearchResultReference) {
155 /* currently only search results expect multiple
157 req->state = LDAP_REQUEST_DONE;
158 DLIST_REMOVE(conn->pending, req);
168 check if a blob is a complete ldap packet
169 handle wrapper or unwrapped connections
171 NTSTATUS ldap_complete_packet(void *private_data, DATA_BLOB blob, size_t *size)
173 struct ldap_connection *conn = talloc_get_type(private_data,
174 struct ldap_connection);
175 if (conn->enable_wrap) {
176 return packet_full_request_u32(private_data, blob, size);
178 return ldap_full_packet(private_data, blob, size);
182 decode/process plain data
184 static NTSTATUS ldap_decode_plain(struct ldap_connection *conn, DATA_BLOB blob)
186 struct asn1_data asn1;
187 struct ldap_message *msg = talloc(conn, struct ldap_message);
190 return NT_STATUS_LDAP(LDAP_PROTOCOL_ERROR);
193 if (!asn1_load(&asn1, blob)) {
194 return NT_STATUS_LDAP(LDAP_PROTOCOL_ERROR);
197 if (!ldap_decode(&asn1, msg)) {
198 return NT_STATUS_LDAP(LDAP_PROTOCOL_ERROR);
201 ldap_match_message(conn, msg);
203 data_blob_free(&blob);
209 decode/process wrapped data
211 static NTSTATUS ldap_decode_wrapped(struct ldap_connection *conn, DATA_BLOB blob)
213 DATA_BLOB wrapped, unwrapped;
214 struct asn1_data asn1;
215 struct ldap_message *msg = talloc(conn, struct ldap_message);
219 return NT_STATUS_LDAP(LDAP_PROTOCOL_ERROR);
222 wrapped = data_blob_const(blob.data+4, blob.length-4);
224 status = gensec_unwrap(conn->gensec, msg, &wrapped, &unwrapped);
225 if (!NT_STATUS_IS_OK(status)) {
226 return NT_STATUS_LDAP(LDAP_PROTOCOL_ERROR);
229 data_blob_free(&blob);
231 if (!asn1_load(&asn1, unwrapped)) {
232 return NT_STATUS_LDAP(LDAP_PROTOCOL_ERROR);
235 while (ldap_decode(&asn1, msg)) {
236 ldap_match_message(conn, msg);
237 msg = talloc(conn, struct ldap_message);
248 handle ldap recv events
250 static NTSTATUS ldap_recv_handler(void *private_data, DATA_BLOB blob)
252 struct ldap_connection *conn = talloc_get_type(private_data,
253 struct ldap_connection);
254 if (conn->enable_wrap) {
255 return ldap_decode_wrapped(conn, blob);
258 return ldap_decode_plain(conn, blob);
263 handle ldap socket events
265 static void ldap_io_handler(struct event_context *ev, struct fd_event *fde,
266 uint16_t flags, void *private_data)
268 struct ldap_connection *conn = talloc_get_type(private_data,
269 struct ldap_connection);
270 if (flags & EVENT_FD_WRITE) {
271 packet_queue_run(conn->packet);
272 if (!tls_enabled(conn->sock)) return;
274 if (flags & EVENT_FD_READ) {
275 packet_recv(conn->packet);
282 static NTSTATUS ldap_parse_basic_url(TALLOC_CTX *mem_ctx, const char *url,
283 char **host, uint16_t *port, BOOL *ldaps)
291 /* skip leading "URL:" (if any) */
292 if (strncasecmp(p, "URL:", 4) == 0) {
297 SMB_ASSERT(sizeof(protocol)>10 && sizeof(tmp_host)>254);
299 ret = sscanf(p, "%10[^:]://%254[^:/]:%d", protocol, tmp_host, &tmp_port);
301 return NT_STATUS_INVALID_PARAMETER;
304 if (strequal(protocol, "ldap")) {
307 } else if (strequal(protocol, "ldaps")) {
311 DEBUG(0, ("unrecognised ldap protocol (%s)!\n", protocol));
312 return NT_STATUS_PROTOCOL_UNREACHABLE;
318 *host = talloc_strdup(mem_ctx, tmp_host);
319 NT_STATUS_HAVE_NO_MEMORY(*host);
325 connect to a ldap server
328 struct ldap_connect_state {
329 struct composite_context *ctx;
330 struct ldap_connection *conn;
333 static void ldap_connect_recv_conn(struct composite_context *ctx);
335 struct composite_context *ldap_connect_send(struct ldap_connection *conn,
338 struct composite_context *result, *ctx;
339 struct ldap_connect_state *state;
341 result = talloc_zero(NULL, struct composite_context);
342 if (result == NULL) goto failed;
343 result->state = COMPOSITE_STATE_IN_PROGRESS;
344 result->async.fn = NULL;
345 result->event_ctx = conn->event.event_ctx;
347 state = talloc(result, struct ldap_connect_state);
348 if (state == NULL) goto failed;
350 result->private_data = state;
354 if (conn->reconnect.url == NULL) {
355 conn->reconnect.url = talloc_strdup(conn, url);
356 if (conn->reconnect.url == NULL) goto failed;
359 state->ctx->status = ldap_parse_basic_url(conn, url, &conn->host,
360 &conn->port, &conn->ldaps);
361 if (!NT_STATUS_IS_OK(state->ctx->status)) {
362 composite_error(state->ctx, state->ctx->status);
366 ctx = socket_connect_multi_send(state, conn->host, 1, &conn->port,
367 conn->event.event_ctx);
368 if (ctx == NULL) goto failed;
370 ctx->async.fn = ldap_connect_recv_conn;
371 ctx->async.private_data = state;
379 static void ldap_connect_recv_conn(struct composite_context *ctx)
381 struct socket_context *initial_socket;
382 struct ldap_connect_state *state =
383 talloc_get_type(ctx->async.private_data,
384 struct ldap_connect_state);
385 struct ldap_connection *conn = state->conn;
388 state->ctx->status = socket_connect_multi_recv(ctx, state, &conn->sock,
390 if (!composite_is_ok(state->ctx)) return;
392 /* setup a handler for events on this socket */
393 conn->event.fde = event_add_fd(conn->event.event_ctx, conn->sock,
394 socket_get_fd(conn->sock),
395 EVENT_FD_READ, ldap_io_handler, conn);
396 if (conn->event.fde == NULL) {
397 composite_error(state->ctx, NT_STATUS_INTERNAL_ERROR);
401 talloc_steal(conn, conn->sock);
402 initial_socket = conn->sock;
404 conn->sock = tls_init_client(conn->sock, conn->event.fde);
405 if (conn->sock == NULL) {
406 talloc_free(initial_socket);
411 conn->packet = packet_init(conn);
412 if (conn->packet == NULL) {
413 talloc_free(conn->sock);
417 packet_set_private(conn->packet, conn);
418 packet_set_socket(conn->packet, conn->sock);
419 packet_set_callback(conn->packet, ldap_recv_handler);
420 packet_set_full_request(conn->packet, ldap_complete_packet);
421 packet_set_error_handler(conn->packet, ldap_error_handler);
422 packet_set_event_context(conn->packet, conn->event.event_ctx);
423 packet_set_fde(conn->packet, conn->event.fde);
424 packet_set_serialise(conn->packet);
426 composite_done(state->ctx);
431 NTSTATUS ldap_connect_recv(struct composite_context *ctx)
433 NTSTATUS status = composite_wait(ctx);
438 NTSTATUS ldap_connect(struct ldap_connection *conn, const char *url)
440 struct composite_context *ctx = ldap_connect_send(conn, url);
441 return ldap_connect_recv(ctx);
444 /* set reconnect parameters */
446 void ldap_set_reconn_params(struct ldap_connection *conn, int max_retries)
449 conn->reconnect.max_retries = max_retries;
450 conn->reconnect.retries = 0;
451 conn->reconnect.previous = time(NULL);
455 /* Actually this function is NOT ASYNC safe, FIXME? */
456 static void ldap_reconnect(struct ldap_connection *conn)
459 time_t now = time(NULL);
461 /* do we have set up reconnect ? */
462 if (conn->reconnect.max_retries == 0) return;
464 /* is the retry time expired ? */
465 if (now > conn->reconnect.previous + 30) {
466 conn->reconnect.retries = 0;
467 conn->reconnect.previous = now;
470 /* are we reconnectind too often and too fast? */
471 if (conn->reconnect.retries > conn->reconnect.max_retries) return;
473 /* keep track of the number of reconnections */
474 conn->reconnect.retries++;
477 status = ldap_connect(conn, conn->reconnect.url);
478 if ( ! NT_STATUS_IS_OK(status)) {
483 status = ldap_rebind(conn);
484 if ( ! NT_STATUS_IS_OK(status)) {
485 ldap_connection_dead(conn);
489 /* destroy an open ldap request */
490 static int ldap_request_destructor(void *ptr)
492 struct ldap_request *req = talloc_get_type(ptr, struct ldap_request);
493 if (req->state == LDAP_REQUEST_PENDING) {
494 DLIST_REMOVE(req->conn->pending, req);
500 called on timeout of a ldap request
502 static void ldap_request_timeout(struct event_context *ev, struct timed_event *te,
503 struct timeval t, void *private_data)
505 struct ldap_request *req = talloc_get_type(private_data, struct ldap_request);
506 req->status = NT_STATUS_IO_TIMEOUT;
507 if (req->state == LDAP_REQUEST_PENDING) {
508 DLIST_REMOVE(req->conn->pending, req);
510 req->state = LDAP_REQUEST_DONE;
518 called on completion of a one-way ldap request
520 static void ldap_request_complete(struct event_context *ev, struct timed_event *te,
521 struct timeval t, void *private_data)
523 struct ldap_request *req = talloc_get_type(private_data, struct ldap_request);
530 send a ldap message - async interface
532 struct ldap_request *ldap_request_send(struct ldap_connection *conn,
533 struct ldap_message *msg)
535 struct ldap_request *req;
536 NTSTATUS status = NT_STATUS_UNSUCCESSFUL;
538 req = talloc_zero(conn, struct ldap_request);
539 if (req == NULL) return NULL;
541 if (conn->sock == NULL) {
542 status = NT_STATUS_INVALID_CONNECTION;
546 req->state = LDAP_REQUEST_SEND;
548 req->messageid = conn->next_messageid++;
549 if (conn->next_messageid == 0) {
550 conn->next_messageid = 1;
552 req->type = msg->type;
553 if (req->messageid == -1) {
557 talloc_set_destructor(req, ldap_request_destructor);
559 msg->messageid = req->messageid;
561 if (!ldap_encode(msg, &req->data, req)) {
565 /* possibly encrypt/sign the request */
566 if (conn->enable_wrap) {
569 status = gensec_wrap(conn->gensec, req, &req->data, &wrapped);
570 if (!NT_STATUS_IS_OK(status)) {
573 data_blob_free(&req->data);
574 req->data = data_blob_talloc(req, NULL, wrapped.length + 4);
575 if (req->data.data == NULL) {
578 RSIVAL(req->data.data, 0, wrapped.length);
579 memcpy(req->data.data+4, wrapped.data, wrapped.length);
580 data_blob_free(&wrapped);
583 status = packet_send(conn->packet, req->data);
584 if (!NT_STATUS_IS_OK(status)) {
588 /* some requests don't expect a reply, so don't add those to the
590 if (req->type == LDAP_TAG_AbandonRequest ||
591 req->type == LDAP_TAG_UnbindRequest) {
592 req->status = NT_STATUS_OK;
593 req->state = LDAP_REQUEST_DONE;
594 /* we can't call the async callback now, as it isn't setup, so
595 call it as next event */
596 event_add_timed(conn->event.event_ctx, req, timeval_zero(),
597 ldap_request_complete, req);
601 req->state = LDAP_REQUEST_PENDING;
602 DLIST_ADD(conn->pending, req);
604 /* put a timeout on the request */
605 req->time_event = event_add_timed(conn->event.event_ctx, req,
606 timeval_current_ofs(conn->timeout, 0),
607 ldap_request_timeout, req);
612 req->status = status;
613 req->state = LDAP_REQUEST_ERROR;
614 event_add_timed(conn->event.event_ctx, req, timeval_zero(),
615 ldap_request_complete, req);
622 wait for a request to complete
623 note that this does not destroy the request
625 NTSTATUS ldap_request_wait(struct ldap_request *req)
627 while (req->state < LDAP_REQUEST_DONE) {
628 if (event_loop_once(req->conn->event.event_ctx) != 0) {
629 req->status = NT_STATUS_UNEXPECTED_NETWORK_ERROR;
638 a mapping of ldap response code to strings
640 static const struct {
641 enum ldap_result_code code;
643 } ldap_code_map[] = {
644 #define _LDAP_MAP_CODE(c) { c, #c }
645 _LDAP_MAP_CODE(LDAP_SUCCESS),
646 _LDAP_MAP_CODE(LDAP_OPERATIONS_ERROR),
647 _LDAP_MAP_CODE(LDAP_PROTOCOL_ERROR),
648 _LDAP_MAP_CODE(LDAP_TIME_LIMIT_EXCEEDED),
649 _LDAP_MAP_CODE(LDAP_SIZE_LIMIT_EXCEEDED),
650 _LDAP_MAP_CODE(LDAP_COMPARE_FALSE),
651 _LDAP_MAP_CODE(LDAP_COMPARE_TRUE),
652 _LDAP_MAP_CODE(LDAP_AUTH_METHOD_NOT_SUPPORTED),
653 _LDAP_MAP_CODE(LDAP_STRONG_AUTH_REQUIRED),
654 _LDAP_MAP_CODE(LDAP_REFERRAL),
655 _LDAP_MAP_CODE(LDAP_ADMIN_LIMIT_EXCEEDED),
656 _LDAP_MAP_CODE(LDAP_UNAVAILABLE_CRITICAL_EXTENSION),
657 _LDAP_MAP_CODE(LDAP_CONFIDENTIALITY_REQUIRED),
658 _LDAP_MAP_CODE(LDAP_SASL_BIND_IN_PROGRESS),
659 _LDAP_MAP_CODE(LDAP_NO_SUCH_ATTRIBUTE),
660 _LDAP_MAP_CODE(LDAP_UNDEFINED_ATTRIBUTE_TYPE),
661 _LDAP_MAP_CODE(LDAP_INAPPROPRIATE_MATCHING),
662 _LDAP_MAP_CODE(LDAP_CONSTRAINT_VIOLATION),
663 _LDAP_MAP_CODE(LDAP_ATTRIBUTE_OR_VALUE_EXISTS),
664 _LDAP_MAP_CODE(LDAP_INVALID_ATTRIBUTE_SYNTAX),
665 _LDAP_MAP_CODE(LDAP_NO_SUCH_OBJECT),
666 _LDAP_MAP_CODE(LDAP_ALIAS_PROBLEM),
667 _LDAP_MAP_CODE(LDAP_INVALID_DN_SYNTAX),
668 _LDAP_MAP_CODE(LDAP_ALIAS_DEREFERENCING_PROBLEM),
669 _LDAP_MAP_CODE(LDAP_INAPPROPRIATE_AUTHENTICATION),
670 _LDAP_MAP_CODE(LDAP_INVALID_CREDENTIALS),
671 _LDAP_MAP_CODE(LDAP_INSUFFICIENT_ACCESS_RIGHTs),
672 _LDAP_MAP_CODE(LDAP_BUSY),
673 _LDAP_MAP_CODE(LDAP_UNAVAILABLE),
674 _LDAP_MAP_CODE(LDAP_UNWILLING_TO_PERFORM),
675 _LDAP_MAP_CODE(LDAP_LOOP_DETECT),
676 _LDAP_MAP_CODE(LDAP_NAMING_VIOLATION),
677 _LDAP_MAP_CODE(LDAP_OBJECT_CLASS_VIOLATION),
678 _LDAP_MAP_CODE(LDAP_NOT_ALLOWED_ON_NON_LEAF),
679 _LDAP_MAP_CODE(LDAP_NOT_ALLOWED_ON_RDN),
680 _LDAP_MAP_CODE(LDAP_ENTRY_ALREADY_EXISTS),
681 _LDAP_MAP_CODE(LDAP_OBJECT_CLASS_MODS_PROHIBITED),
682 _LDAP_MAP_CODE(LDAP_AFFECTS_MULTIPLE_DSAS),
683 _LDAP_MAP_CODE(LDAP_OTHER)
687 used to setup the status code from a ldap response
689 NTSTATUS ldap_check_response(struct ldap_connection *conn, struct ldap_Result *r)
692 const char *codename = "unknown";
694 if (r->resultcode == LDAP_SUCCESS) {
698 if (conn->last_error) {
699 talloc_free(conn->last_error);
702 for (i=0;i<ARRAY_SIZE(ldap_code_map);i++) {
703 if (r->resultcode == ldap_code_map[i].code) {
704 codename = ldap_code_map[i].str;
709 conn->last_error = talloc_asprintf(conn, "LDAP error %u %s - %s <%s> <%s>",
712 r->dn?r->dn:"(NULL)",
713 r->errormessage?r->errormessage:"",
714 r->referral?r->referral:"");
716 return NT_STATUS_LDAP(r->resultcode);
720 return error string representing the last error
722 const char *ldap_errstr(struct ldap_connection *conn, NTSTATUS status)
724 if (NT_STATUS_IS_LDAP(status) && conn->last_error != NULL) {
725 return conn->last_error;
727 return nt_errstr(status);
732 return the Nth result message, waiting if necessary
734 NTSTATUS ldap_result_n(struct ldap_request *req, int n, struct ldap_message **msg)
738 NT_STATUS_HAVE_NO_MEMORY(req);
740 while (req->state < LDAP_REQUEST_DONE && n >= req->num_replies) {
741 if (event_loop_once(req->conn->event.event_ctx) != 0) {
742 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
746 if (n < req->num_replies) {
747 *msg = req->replies[n];
751 if (!NT_STATUS_IS_OK(req->status)) {
755 return NT_STATUS_NO_MORE_ENTRIES;
760 return a single result message, checking if it is of the expected LDAP type
762 NTSTATUS ldap_result_one(struct ldap_request *req, struct ldap_message **msg, int type)
765 status = ldap_result_n(req, 0, msg);
766 if (!NT_STATUS_IS_OK(status)) {
769 if ((*msg)->type != type) {
771 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
777 a simple ldap transaction, for single result requests that only need a status code
778 this relies on single valued requests having the response type == request type + 1
780 NTSTATUS ldap_transaction(struct ldap_connection *conn, struct ldap_message *msg)
782 struct ldap_request *req = ldap_request_send(conn, msg);
783 struct ldap_message *res;
785 status = ldap_result_n(req, 0, &res);
786 if (!NT_STATUS_IS_OK(status)) {
790 if (res->type != msg->type + 1) {
792 return NT_STATUS_LDAP(LDAP_PROTOCOL_ERROR);
794 status = ldap_check_response(conn, &res->r.GeneralResult);