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 3 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, see <http://www.gnu.org/licenses/>.
26 #include "libcli/util/asn_1.h"
27 #include "lib/util/dlinklist.h"
28 #include "lib/events/events.h"
29 #include "lib/socket/socket.h"
30 #include "libcli/ldap/ldap.h"
31 #include "libcli/ldap/ldap_client.h"
32 #include "libcli/composite/composite.h"
33 #include "lib/stream/packet.h"
34 #include "lib/tls/tls.h"
35 #include "auth/gensec/gensec.h"
36 #include "system/time.h"
37 #include "param/param.h"
41 create a new ldap_connection stucture. The event context is optional
43 struct ldap_connection *ldap4_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;
122 for (req=conn->pending; req; req=req->next) {
123 if (req->messageid == msg->messageid) break;
125 /* match a zero message id to the last request sent.
126 It seems that servers send 0 if unable to parse */
127 if (req == NULL && msg->messageid == 0) {
131 DEBUG(0,("ldap: no matching message id for %u\n",
137 /* Check for undecoded critical extensions */
138 for (i=0; msg->controls && msg->controls[i]; i++) {
139 if (!msg->controls_decoded[i] &&
140 msg->controls[i]->critical) {
141 req->status = NT_STATUS_LDAP(LDAP_UNAVAILABLE_CRITICAL_EXTENSION);
142 req->state = LDAP_REQUEST_DONE;
143 DLIST_REMOVE(conn->pending, req);
151 /* add to the list of replies received */
152 talloc_steal(req, msg);
153 req->replies = talloc_realloc(req, req->replies,
154 struct ldap_message *, req->num_replies+1);
155 if (req->replies == NULL) {
156 req->status = NT_STATUS_NO_MEMORY;
157 req->state = LDAP_REQUEST_DONE;
158 DLIST_REMOVE(conn->pending, req);
165 req->replies[req->num_replies] = talloc_steal(req->replies, msg);
168 if (msg->type != LDAP_TAG_SearchResultEntry &&
169 msg->type != LDAP_TAG_SearchResultReference) {
170 /* currently only search results expect multiple
172 req->state = LDAP_REQUEST_DONE;
173 DLIST_REMOVE(conn->pending, req);
183 decode/process LDAP data
185 static NTSTATUS ldap_recv_handler(void *private_data, DATA_BLOB blob)
188 struct ldap_connection *conn = talloc_get_type(private_data,
189 struct ldap_connection);
190 struct ldap_message *msg = talloc(conn, struct ldap_message);
191 struct asn1_data *asn1 = asn1_init(conn);
193 if (asn1 == NULL || msg == NULL) {
194 return NT_STATUS_LDAP(LDAP_PROTOCOL_ERROR);
197 if (!asn1_load(asn1, blob)) {
200 return NT_STATUS_LDAP(LDAP_PROTOCOL_ERROR);
203 status = ldap_decode(asn1, msg);
204 if (!NT_STATUS_IS_OK(status)) {
209 ldap_match_message(conn, msg);
211 data_blob_free(&blob);
216 /* Handle read events, from the GENSEC socket callback, or real events */
217 void ldap_read_io_handler(void *private_data, uint16_t flags)
219 struct ldap_connection *conn = talloc_get_type(private_data,
220 struct ldap_connection);
221 packet_recv(conn->packet);
225 handle ldap socket events
227 static void ldap_io_handler(struct event_context *ev, struct fd_event *fde,
228 uint16_t flags, void *private_data)
230 struct ldap_connection *conn = talloc_get_type(private_data,
231 struct ldap_connection);
232 if (flags & EVENT_FD_WRITE) {
233 packet_queue_run(conn->packet);
234 if (!tls_enabled(conn->sock)) return;
236 if (flags & EVENT_FD_READ) {
237 ldap_read_io_handler(private_data, flags);
244 static NTSTATUS ldap_parse_basic_url(TALLOC_CTX *mem_ctx, const char *url,
245 char **host, uint16_t *port, bool *ldaps)
253 SMB_ASSERT(sizeof(protocol)>10 && sizeof(tmp_host)>254);
255 ret = sscanf(url, "%10[^:]://%254[^:/]:%d", protocol, tmp_host, &tmp_port);
257 return NT_STATUS_INVALID_PARAMETER;
260 if (strequal(protocol, "ldap")) {
263 } else if (strequal(protocol, "ldaps")) {
267 DEBUG(0, ("unrecognised ldap protocol (%s)!\n", protocol));
268 return NT_STATUS_PROTOCOL_UNREACHABLE;
274 *host = talloc_strdup(mem_ctx, tmp_host);
275 NT_STATUS_HAVE_NO_MEMORY(*host);
281 connect to a ldap server
284 struct ldap_connect_state {
285 struct composite_context *ctx;
286 struct ldap_connection *conn;
289 static void ldap_connect_recv_unix_conn(struct composite_context *ctx);
290 static void ldap_connect_recv_tcp_conn(struct composite_context *ctx);
292 struct composite_context *ldap_connect_send(struct ldap_connection *conn,
295 struct composite_context *result, *ctx;
296 struct ldap_connect_state *state;
300 result = talloc_zero(NULL, struct composite_context);
301 if (result == NULL) goto failed;
302 result->state = COMPOSITE_STATE_IN_PROGRESS;
303 result->async.fn = NULL;
304 result->event_ctx = conn->event.event_ctx;
306 state = talloc(result, struct ldap_connect_state);
307 if (state == NULL) goto failed;
309 result->private_data = state;
313 if (conn->reconnect.url == NULL) {
314 conn->reconnect.url = talloc_strdup(conn, url);
315 if (conn->reconnect.url == NULL) goto failed;
319 SMB_ASSERT(sizeof(protocol)>10);
321 ret = sscanf(url, "%10[^:]://", protocol);
326 if (strequal(protocol, "ldapi")) {
327 struct socket_address *unix_addr;
330 NTSTATUS status = socket_create("unix", SOCKET_TYPE_STREAM, &conn->sock, 0);
331 if (!NT_STATUS_IS_OK(status)) {
334 talloc_steal(conn, conn->sock);
335 SMB_ASSERT(sizeof(protocol)>10);
336 SMB_ASSERT(sizeof(path)>1024);
338 /* The %c specifier doesn't null terminate :-( */
340 ret = sscanf(url, "%10[^:]://%1025c", protocol, path);
342 composite_error(state->ctx, NT_STATUS_INVALID_PARAMETER);
346 rfc1738_unescape(path);
348 unix_addr = socket_address_from_strings(conn, conn->sock->backend_name,
354 ctx = socket_connect_send(conn->sock, NULL, unix_addr,
355 0, conn->event.event_ctx);
356 ctx->async.fn = ldap_connect_recv_unix_conn;
357 ctx->async.private_data = state;
360 NTSTATUS status = ldap_parse_basic_url(conn, url, &conn->host,
361 &conn->port, &conn->ldaps);
362 if (!NT_STATUS_IS_OK(state->ctx->status)) {
363 composite_error(state->ctx, status);
367 ctx = socket_connect_multi_send(state, conn->host, 1, &conn->port,
368 conn->event.event_ctx);
369 if (ctx == NULL) goto failed;
371 ctx->async.fn = ldap_connect_recv_tcp_conn;
372 ctx->async.private_data = state;
380 static void ldap_connect_got_sock(struct composite_context *ctx, struct ldap_connection *conn)
382 /* setup a handler for events on this socket */
383 conn->event.fde = event_add_fd(conn->event.event_ctx, conn->sock,
384 socket_get_fd(conn->sock),
385 EVENT_FD_READ | EVENT_FD_AUTOCLOSE, ldap_io_handler, conn);
386 if (conn->event.fde == NULL) {
387 composite_error(ctx, NT_STATUS_INTERNAL_ERROR);
391 socket_set_flags(conn->sock, SOCKET_FLAG_NOCLOSE);
393 talloc_steal(conn, conn->sock);
395 struct socket_context *tls_socket;
396 char *cafile = private_path(conn->sock, global_loadparm, lp_tls_cafile(global_loadparm));
398 if (!cafile || !*cafile) {
399 talloc_free(conn->sock);
403 tls_socket = tls_init_client(conn->sock, conn->event.fde, cafile);
406 if (tls_socket == NULL) {
407 talloc_free(conn->sock);
410 talloc_unlink(conn, conn->sock);
411 conn->sock = tls_socket;
412 talloc_steal(conn, conn->sock);
415 conn->packet = packet_init(conn);
416 if (conn->packet == NULL) {
417 talloc_free(conn->sock);
421 packet_set_private(conn->packet, conn);
422 packet_set_socket(conn->packet, conn->sock);
423 packet_set_callback(conn->packet, ldap_recv_handler);
424 packet_set_full_request(conn->packet, ldap_full_packet);
425 packet_set_error_handler(conn->packet, ldap_error_handler);
426 packet_set_event_context(conn->packet, conn->event.event_ctx);
427 packet_set_fde(conn->packet, conn->event.fde);
428 packet_set_serialise(conn->packet);
433 static void ldap_connect_recv_tcp_conn(struct composite_context *ctx)
435 struct ldap_connect_state *state =
436 talloc_get_type(ctx->async.private_data,
437 struct ldap_connect_state);
438 struct ldap_connection *conn = state->conn;
440 NTSTATUS status = socket_connect_multi_recv(ctx, state, &conn->sock,
442 if (!NT_STATUS_IS_OK(status)) {
443 composite_error(state->ctx, status);
447 ldap_connect_got_sock(state->ctx, conn);
450 static void ldap_connect_recv_unix_conn(struct composite_context *ctx)
452 struct ldap_connect_state *state =
453 talloc_get_type(ctx->async.private_data,
454 struct ldap_connect_state);
455 struct ldap_connection *conn = state->conn;
457 NTSTATUS status = socket_connect_recv(ctx);
459 if (!NT_STATUS_IS_OK(state->ctx->status)) {
460 composite_error(state->ctx, status);
464 ldap_connect_got_sock(state->ctx, conn);
467 _PUBLIC_ NTSTATUS ldap_connect_recv(struct composite_context *ctx)
469 NTSTATUS status = composite_wait(ctx);
474 NTSTATUS ldap_connect(struct ldap_connection *conn, const char *url)
476 struct composite_context *ctx = ldap_connect_send(conn, url);
477 return ldap_connect_recv(ctx);
480 /* set reconnect parameters */
482 void ldap_set_reconn_params(struct ldap_connection *conn, int max_retries)
485 conn->reconnect.max_retries = max_retries;
486 conn->reconnect.retries = 0;
487 conn->reconnect.previous = time(NULL);
491 /* Actually this function is NOT ASYNC safe, FIXME? */
492 static void ldap_reconnect(struct ldap_connection *conn)
495 time_t now = time(NULL);
497 /* do we have set up reconnect ? */
498 if (conn->reconnect.max_retries == 0) return;
500 /* is the retry time expired ? */
501 if (now > conn->reconnect.previous + 30) {
502 conn->reconnect.retries = 0;
503 conn->reconnect.previous = now;
506 /* are we reconnectind too often and too fast? */
507 if (conn->reconnect.retries > conn->reconnect.max_retries) return;
509 /* keep track of the number of reconnections */
510 conn->reconnect.retries++;
513 status = ldap_connect(conn, conn->reconnect.url);
514 if ( ! NT_STATUS_IS_OK(status)) {
519 status = ldap_rebind(conn);
520 if ( ! NT_STATUS_IS_OK(status)) {
521 ldap_connection_dead(conn);
525 /* destroy an open ldap request */
526 static int ldap_request_destructor(struct ldap_request *req)
528 if (req->state == LDAP_REQUEST_PENDING) {
529 DLIST_REMOVE(req->conn->pending, req);
535 called on timeout of a ldap request
537 static void ldap_request_timeout(struct event_context *ev, struct timed_event *te,
538 struct timeval t, void *private_data)
540 struct ldap_request *req = talloc_get_type(private_data, struct ldap_request);
541 req->status = NT_STATUS_IO_TIMEOUT;
542 if (req->state == LDAP_REQUEST_PENDING) {
543 DLIST_REMOVE(req->conn->pending, req);
545 req->state = LDAP_REQUEST_DONE;
553 called on completion of a one-way ldap request
555 static void ldap_request_complete(struct event_context *ev, struct timed_event *te,
556 struct timeval t, void *private_data)
558 struct ldap_request *req = talloc_get_type(private_data, struct ldap_request);
565 send a ldap message - async interface
567 struct ldap_request *ldap_request_send(struct ldap_connection *conn,
568 struct ldap_message *msg)
570 struct ldap_request *req;
571 NTSTATUS status = NT_STATUS_UNSUCCESSFUL;
573 req = talloc_zero(conn, struct ldap_request);
574 if (req == NULL) return NULL;
576 if (conn->sock == NULL) {
577 status = NT_STATUS_INVALID_CONNECTION;
581 req->state = LDAP_REQUEST_SEND;
583 req->messageid = conn->next_messageid++;
584 if (conn->next_messageid == 0) {
585 conn->next_messageid = 1;
587 req->type = msg->type;
588 if (req->messageid == -1) {
592 talloc_set_destructor(req, ldap_request_destructor);
594 msg->messageid = req->messageid;
596 if (!ldap_encode(msg, &req->data, req)) {
597 status = NT_STATUS_INTERNAL_ERROR;
601 status = packet_send(conn->packet, req->data);
602 if (!NT_STATUS_IS_OK(status)) {
606 /* some requests don't expect a reply, so don't add those to the
608 if (req->type == LDAP_TAG_AbandonRequest ||
609 req->type == LDAP_TAG_UnbindRequest) {
610 req->status = NT_STATUS_OK;
611 req->state = LDAP_REQUEST_DONE;
612 /* we can't call the async callback now, as it isn't setup, so
613 call it as next event */
614 event_add_timed(conn->event.event_ctx, req, timeval_zero(),
615 ldap_request_complete, req);
619 req->state = LDAP_REQUEST_PENDING;
620 DLIST_ADD(conn->pending, req);
622 /* put a timeout on the request */
623 req->time_event = event_add_timed(conn->event.event_ctx, req,
624 timeval_current_ofs(conn->timeout, 0),
625 ldap_request_timeout, req);
630 req->status = status;
631 req->state = LDAP_REQUEST_ERROR;
632 event_add_timed(conn->event.event_ctx, req, timeval_zero(),
633 ldap_request_complete, req);
640 wait for a request to complete
641 note that this does not destroy the request
643 NTSTATUS ldap_request_wait(struct ldap_request *req)
645 while (req->state < LDAP_REQUEST_DONE) {
646 if (event_loop_once(req->conn->event.event_ctx) != 0) {
647 req->status = NT_STATUS_UNEXPECTED_NETWORK_ERROR;
656 a mapping of ldap response code to strings
658 static const struct {
659 enum ldap_result_code code;
661 } ldap_code_map[] = {
662 #define _LDAP_MAP_CODE(c) { c, #c }
663 _LDAP_MAP_CODE(LDAP_SUCCESS),
664 _LDAP_MAP_CODE(LDAP_OPERATIONS_ERROR),
665 _LDAP_MAP_CODE(LDAP_PROTOCOL_ERROR),
666 _LDAP_MAP_CODE(LDAP_TIME_LIMIT_EXCEEDED),
667 _LDAP_MAP_CODE(LDAP_SIZE_LIMIT_EXCEEDED),
668 _LDAP_MAP_CODE(LDAP_COMPARE_FALSE),
669 _LDAP_MAP_CODE(LDAP_COMPARE_TRUE),
670 _LDAP_MAP_CODE(LDAP_AUTH_METHOD_NOT_SUPPORTED),
671 _LDAP_MAP_CODE(LDAP_STRONG_AUTH_REQUIRED),
672 _LDAP_MAP_CODE(LDAP_REFERRAL),
673 _LDAP_MAP_CODE(LDAP_ADMIN_LIMIT_EXCEEDED),
674 _LDAP_MAP_CODE(LDAP_UNAVAILABLE_CRITICAL_EXTENSION),
675 _LDAP_MAP_CODE(LDAP_CONFIDENTIALITY_REQUIRED),
676 _LDAP_MAP_CODE(LDAP_SASL_BIND_IN_PROGRESS),
677 _LDAP_MAP_CODE(LDAP_NO_SUCH_ATTRIBUTE),
678 _LDAP_MAP_CODE(LDAP_UNDEFINED_ATTRIBUTE_TYPE),
679 _LDAP_MAP_CODE(LDAP_INAPPROPRIATE_MATCHING),
680 _LDAP_MAP_CODE(LDAP_CONSTRAINT_VIOLATION),
681 _LDAP_MAP_CODE(LDAP_ATTRIBUTE_OR_VALUE_EXISTS),
682 _LDAP_MAP_CODE(LDAP_INVALID_ATTRIBUTE_SYNTAX),
683 _LDAP_MAP_CODE(LDAP_NO_SUCH_OBJECT),
684 _LDAP_MAP_CODE(LDAP_ALIAS_PROBLEM),
685 _LDAP_MAP_CODE(LDAP_INVALID_DN_SYNTAX),
686 _LDAP_MAP_CODE(LDAP_ALIAS_DEREFERENCING_PROBLEM),
687 _LDAP_MAP_CODE(LDAP_INAPPROPRIATE_AUTHENTICATION),
688 _LDAP_MAP_CODE(LDAP_INVALID_CREDENTIALS),
689 _LDAP_MAP_CODE(LDAP_INSUFFICIENT_ACCESS_RIGHTS),
690 _LDAP_MAP_CODE(LDAP_BUSY),
691 _LDAP_MAP_CODE(LDAP_UNAVAILABLE),
692 _LDAP_MAP_CODE(LDAP_UNWILLING_TO_PERFORM),
693 _LDAP_MAP_CODE(LDAP_LOOP_DETECT),
694 _LDAP_MAP_CODE(LDAP_NAMING_VIOLATION),
695 _LDAP_MAP_CODE(LDAP_OBJECT_CLASS_VIOLATION),
696 _LDAP_MAP_CODE(LDAP_NOT_ALLOWED_ON_NON_LEAF),
697 _LDAP_MAP_CODE(LDAP_NOT_ALLOWED_ON_RDN),
698 _LDAP_MAP_CODE(LDAP_ENTRY_ALREADY_EXISTS),
699 _LDAP_MAP_CODE(LDAP_OBJECT_CLASS_MODS_PROHIBITED),
700 _LDAP_MAP_CODE(LDAP_AFFECTS_MULTIPLE_DSAS),
701 _LDAP_MAP_CODE(LDAP_OTHER)
705 used to setup the status code from a ldap response
707 NTSTATUS ldap_check_response(struct ldap_connection *conn, struct ldap_Result *r)
710 const char *codename = "unknown";
712 if (r->resultcode == LDAP_SUCCESS) {
716 if (conn->last_error) {
717 talloc_free(conn->last_error);
720 for (i=0;i<ARRAY_SIZE(ldap_code_map);i++) {
721 if (r->resultcode == ldap_code_map[i].code) {
722 codename = ldap_code_map[i].str;
727 conn->last_error = talloc_asprintf(conn, "LDAP error %u %s - %s <%s> <%s>",
730 r->dn?r->dn:"(NULL)",
731 r->errormessage?r->errormessage:"",
732 r->referral?r->referral:"");
734 return NT_STATUS_LDAP(r->resultcode);
738 return error string representing the last error
740 const char *ldap_errstr(struct ldap_connection *conn,
744 if (NT_STATUS_IS_LDAP(status) && conn->last_error != NULL) {
745 return talloc_strdup(mem_ctx, conn->last_error);
747 return talloc_asprintf(mem_ctx, "LDAP client internal error: %s", nt_errstr(status));
752 return the Nth result message, waiting if necessary
754 NTSTATUS ldap_result_n(struct ldap_request *req, int n, struct ldap_message **msg)
758 NT_STATUS_HAVE_NO_MEMORY(req);
760 while (req->state < LDAP_REQUEST_DONE && n >= req->num_replies) {
761 if (event_loop_once(req->conn->event.event_ctx) != 0) {
762 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
766 if (n < req->num_replies) {
767 *msg = req->replies[n];
771 if (!NT_STATUS_IS_OK(req->status)) {
775 return NT_STATUS_NO_MORE_ENTRIES;
780 return a single result message, checking if it is of the expected LDAP type
782 NTSTATUS ldap_result_one(struct ldap_request *req, struct ldap_message **msg, int type)
785 status = ldap_result_n(req, 0, msg);
786 if (!NT_STATUS_IS_OK(status)) {
789 if ((*msg)->type != type) {
791 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
797 a simple ldap transaction, for single result requests that only need a status code
798 this relies on single valued requests having the response type == request type + 1
800 NTSTATUS ldap_transaction(struct ldap_connection *conn, struct ldap_message *msg)
802 struct ldap_request *req = ldap_request_send(conn, msg);
803 struct ldap_message *res;
805 status = ldap_result_n(req, 0, &res);
806 if (!NT_STATUS_IS_OK(status)) {
810 if (res->type != msg->type + 1) {
812 return NT_STATUS_LDAP(LDAP_PROTOCOL_ERROR);
814 status = ldap_check_response(conn, &res->r.GeneralResult);