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_client.h"
32 #include "libcli/composite/composite.h"
33 #include "lib/stream/packet.h"
34 #include "auth/gensec/gensec.h"
38 create a new ldap_connection stucture. The event context is optional
40 struct ldap_connection *ldap_new_connection(TALLOC_CTX *mem_ctx,
41 struct event_context *ev)
43 struct ldap_connection *conn;
45 conn = talloc_zero(mem_ctx, struct ldap_connection);
51 ev = event_context_init(conn);
58 conn->next_messageid = 1;
59 conn->event.event_ctx = ev;
61 /* set a reasonable request timeout */
69 the connection is dead
71 static void ldap_connection_dead(struct ldap_connection *conn)
73 struct ldap_request *req;
75 while (conn->pending) {
77 DLIST_REMOVE(req->conn->pending, req);
78 req->state = LDAP_REQUEST_DONE;
79 req->status = NT_STATUS_UNEXPECTED_NETWORK_ERROR;
85 talloc_free(conn->tls);
92 static void ldap_error_handler(void *private, NTSTATUS status)
94 struct ldap_connection *conn = talloc_get_type(private,
95 struct ldap_connection);
96 ldap_connection_dead(conn);
101 match up with a pending message, adding to the replies list
103 static void ldap_match_message(struct ldap_connection *conn, struct ldap_message *msg)
105 struct ldap_request *req;
107 for (req=conn->pending; req; req=req->next) {
108 if (req->messageid == msg->messageid) break;
110 /* match a zero message id to the last request sent.
111 It seems that servers send 0 if unable to parse */
112 if (req == NULL && msg->messageid == 0) {
116 DEBUG(0,("ldap: no matching message id for %u\n",
122 /* add to the list of replies received */
123 talloc_steal(req, msg);
124 req->replies = talloc_realloc(req, req->replies,
125 struct ldap_message *, req->num_replies+1);
126 if (req->replies == NULL) {
127 req->status = NT_STATUS_NO_MEMORY;
128 req->state = LDAP_REQUEST_DONE;
129 DLIST_REMOVE(conn->pending, req);
136 req->replies[req->num_replies] = talloc_steal(req->replies, msg);
139 if (msg->type != LDAP_TAG_SearchResultEntry &&
140 msg->type != LDAP_TAG_SearchResultReference) {
141 /* currently only search results expect multiple
143 req->state = LDAP_REQUEST_DONE;
144 DLIST_REMOVE(conn->pending, req);
154 check if a blob is a complete ldap packet
155 handle wrapper or unwrapped connections
157 NTSTATUS ldap_complete_packet(void *private, DATA_BLOB blob, size_t *size)
159 struct ldap_connection *conn = talloc_get_type(private,
160 struct ldap_connection);
161 if (conn->enable_wrap) {
162 return packet_full_request_u32(private, blob, size);
164 return ldap_full_packet(private, blob, size);
168 decode/process plain data
170 static NTSTATUS ldap_decode_plain(struct ldap_connection *conn, DATA_BLOB blob)
172 struct asn1_data asn1;
173 struct ldap_message *msg = talloc(conn, struct ldap_message);
176 return NT_STATUS_LDAP(LDAP_PROTOCOL_ERROR);
179 if (!asn1_load(&asn1, blob)) {
180 return NT_STATUS_LDAP(LDAP_PROTOCOL_ERROR);
183 if (!ldap_decode(&asn1, msg)) {
184 return NT_STATUS_LDAP(LDAP_PROTOCOL_ERROR);
187 ldap_match_message(conn, msg);
189 data_blob_free(&blob);
195 decode/process wrapped data
197 static NTSTATUS ldap_decode_wrapped(struct ldap_connection *conn, DATA_BLOB blob)
199 DATA_BLOB wrapped, unwrapped;
200 struct asn1_data asn1;
201 struct ldap_message *msg = talloc(conn, struct ldap_message);
205 return NT_STATUS_LDAP(LDAP_PROTOCOL_ERROR);
208 wrapped = data_blob_const(blob.data+4, blob.length-4);
210 status = gensec_unwrap(conn->gensec, msg, &wrapped, &unwrapped);
211 if (!NT_STATUS_IS_OK(status)) {
212 return NT_STATUS_LDAP(LDAP_PROTOCOL_ERROR);
215 data_blob_free(&blob);
217 if (!asn1_load(&asn1, unwrapped)) {
218 return NT_STATUS_LDAP(LDAP_PROTOCOL_ERROR);
221 while (ldap_decode(&asn1, msg)) {
222 ldap_match_message(conn, msg);
223 msg = talloc(conn, struct ldap_message);
234 handle ldap recv events
236 static NTSTATUS ldap_recv_handler(void *private, DATA_BLOB blob)
238 struct ldap_connection *conn = talloc_get_type(private,
239 struct ldap_connection);
240 if (conn->enable_wrap) {
241 return ldap_decode_wrapped(conn, blob);
244 return ldap_decode_plain(conn, blob);
249 handle ldap socket events
251 static void ldap_io_handler(struct event_context *ev, struct fd_event *fde,
252 uint16_t flags, void *private)
254 struct ldap_connection *conn = talloc_get_type(private,
255 struct ldap_connection);
256 if (flags & EVENT_FD_WRITE) {
257 packet_queue_run(conn->packet);
258 if (conn->tls == NULL) return;
260 if (flags & EVENT_FD_READ) {
261 packet_recv(conn->packet);
268 static NTSTATUS ldap_parse_basic_url(TALLOC_CTX *mem_ctx, const char *url,
269 char **host, uint16_t *port, BOOL *ldaps)
277 /* skip leading "URL:" (if any) */
278 if (strncasecmp(p, "URL:", 4) == 0) {
283 SMB_ASSERT(sizeof(protocol)>10 && sizeof(tmp_host)>254);
285 ret = sscanf(p, "%10[^:]://%254[^:/]:%d", protocol, tmp_host, &tmp_port);
287 return NT_STATUS_INVALID_PARAMETER;
290 if (strequal(protocol, "ldap")) {
293 } else if (strequal(protocol, "ldaps")) {
297 DEBUG(0, ("unrecognised ldap protocol (%s)!\n", protocol));
298 return NT_STATUS_PROTOCOL_UNREACHABLE;
304 *host = talloc_strdup(mem_ctx, tmp_host);
305 NT_STATUS_HAVE_NO_MEMORY(*host);
311 connect to a ldap server
314 struct ldap_connect_state {
315 struct composite_context *ctx;
316 struct ldap_connection *conn;
319 static void ldap_connect_recv_conn(struct composite_context *ctx);
321 struct composite_context *ldap_connect_send(struct ldap_connection *conn,
324 struct composite_context *result, *ctx;
325 struct ldap_connect_state *state;
327 result = talloc_zero(NULL, struct composite_context);
328 if (result == NULL) goto failed;
329 result->state = COMPOSITE_STATE_IN_PROGRESS;
330 result->async.fn = NULL;
331 result->event_ctx = conn->event.event_ctx;
333 state = talloc(result, struct ldap_connect_state);
334 if (state == NULL) goto failed;
336 result->private_data = state;
340 state->ctx->status = ldap_parse_basic_url(conn, url, &conn->host,
341 &conn->port, &conn->ldaps);
342 if (!NT_STATUS_IS_OK(state->ctx->status)) {
343 composite_error(state->ctx, state->ctx->status);
347 ctx = socket_connect_multi_send(state, conn->host, 1, &conn->port,
348 conn->event.event_ctx);
349 if (ctx == NULL) goto failed;
351 ctx->async.fn = ldap_connect_recv_conn;
352 ctx->async.private_data = state;
360 static void ldap_connect_recv_conn(struct composite_context *ctx)
362 struct ldap_connect_state *state =
363 talloc_get_type(ctx->async.private_data,
364 struct ldap_connect_state);
365 struct ldap_connection *conn = state->conn;
368 state->ctx->status = socket_connect_multi_recv(ctx, state, &conn->sock,
370 if (!composite_is_ok(state->ctx)) return;
372 /* setup a handler for events on this socket */
373 conn->event.fde = event_add_fd(conn->event.event_ctx, conn->sock,
374 socket_get_fd(conn->sock),
375 EVENT_FD_READ, ldap_io_handler, conn);
376 if (conn->event.fde == NULL) {
377 composite_error(state->ctx, NT_STATUS_INTERNAL_ERROR);
381 conn->tls = tls_init_client(conn->sock, conn->event.fde, conn->ldaps);
382 if (conn->tls == NULL) {
383 talloc_free(conn->sock);
386 talloc_steal(conn, conn->tls);
387 talloc_steal(conn->tls, conn->sock);
389 conn->packet = packet_init(conn);
390 if (conn->packet == NULL) {
391 talloc_free(conn->sock);
394 packet_set_private(conn->packet, conn);
395 packet_set_tls(conn->packet, conn->tls);
396 packet_set_callback(conn->packet, ldap_recv_handler);
397 packet_set_full_request(conn->packet, ldap_complete_packet);
398 packet_set_error_handler(conn->packet, ldap_error_handler);
399 packet_set_event_context(conn->packet, conn->event.event_ctx);
400 packet_set_fde(conn->packet, conn->event.fde);
401 packet_set_serialise(conn->packet);
403 composite_done(state->ctx);
408 NTSTATUS ldap_connect_recv(struct composite_context *ctx)
410 NTSTATUS status = composite_wait(ctx);
415 NTSTATUS ldap_connect(struct ldap_connection *conn, const char *url)
417 struct composite_context *ctx = ldap_connect_send(conn, url);
418 return ldap_connect_recv(ctx);
421 /* destroy an open ldap request */
422 static int ldap_request_destructor(void *ptr)
424 struct ldap_request *req = talloc_get_type(ptr, struct ldap_request);
425 if (req->state == LDAP_REQUEST_PENDING) {
426 DLIST_REMOVE(req->conn->pending, req);
432 called on timeout of a ldap request
434 static void ldap_request_timeout(struct event_context *ev, struct timed_event *te,
435 struct timeval t, void *private)
437 struct ldap_request *req = talloc_get_type(private, struct ldap_request);
438 req->status = NT_STATUS_IO_TIMEOUT;
439 if (req->state == LDAP_REQUEST_PENDING) {
440 DLIST_REMOVE(req->conn->pending, req);
442 req->state = LDAP_REQUEST_DONE;
450 called on completion of a one-way ldap request
452 static void ldap_request_complete(struct event_context *ev, struct timed_event *te,
453 struct timeval t, void *private)
455 struct ldap_request *req = talloc_get_type(private, struct ldap_request);
462 send a ldap message - async interface
464 struct ldap_request *ldap_request_send(struct ldap_connection *conn,
465 struct ldap_message *msg)
467 struct ldap_request *req;
470 if (conn->tls == NULL) {
474 req = talloc_zero(conn, struct ldap_request);
475 if (req == NULL) goto failed;
477 req->state = LDAP_REQUEST_SEND;
479 req->messageid = conn->next_messageid++;
480 if (conn->next_messageid == 0) {
481 conn->next_messageid = 1;
483 req->type = msg->type;
484 if (req->messageid == -1) {
488 talloc_set_destructor(req, ldap_request_destructor);
490 msg->messageid = req->messageid;
492 if (!ldap_encode(msg, &req->data, req)) {
496 /* possibly encrypt/sign the request */
497 if (conn->enable_wrap) {
500 status = gensec_wrap(conn->gensec, req, &req->data, &wrapped);
501 if (!NT_STATUS_IS_OK(status)) {
504 data_blob_free(&req->data);
505 req->data = data_blob_talloc(req, NULL, wrapped.length + 4);
506 if (req->data.data == NULL) {
509 RSIVAL(req->data.data, 0, wrapped.length);
510 memcpy(req->data.data+4, wrapped.data, wrapped.length);
511 data_blob_free(&wrapped);
514 status = packet_send(conn->packet, req->data);
515 if (!NT_STATUS_IS_OK(status)) {
519 /* some requests don't expect a reply, so don't add those to the
521 if (req->type == LDAP_TAG_AbandonRequest ||
522 req->type == LDAP_TAG_UnbindRequest) {
523 req->status = NT_STATUS_OK;
524 req->state = LDAP_REQUEST_DONE;
525 /* we can't call the async callback now, as it isn't setup, so
526 call it as next event */
527 event_add_timed(conn->event.event_ctx, req, timeval_zero(),
528 ldap_request_complete, req);
532 req->state = LDAP_REQUEST_PENDING;
533 DLIST_ADD(conn->pending, req);
535 /* put a timeout on the request */
536 event_add_timed(conn->event.event_ctx, req,
537 timeval_current_ofs(conn->timeout, 0),
538 ldap_request_timeout, req);
549 wait for a request to complete
550 note that this does not destroy the request
552 NTSTATUS ldap_request_wait(struct ldap_request *req)
554 while (req->state != LDAP_REQUEST_DONE) {
555 if (event_loop_once(req->conn->event.event_ctx) != 0) {
556 req->status = NT_STATUS_UNEXPECTED_NETWORK_ERROR;
565 a mapping of ldap response code to strings
567 static const struct {
568 enum ldap_result_code code;
570 } ldap_code_map[] = {
571 #define _LDAP_MAP_CODE(c) { c, #c }
572 _LDAP_MAP_CODE(LDAP_SUCCESS),
573 _LDAP_MAP_CODE(LDAP_OPERATIONS_ERROR),
574 _LDAP_MAP_CODE(LDAP_PROTOCOL_ERROR),
575 _LDAP_MAP_CODE(LDAP_TIME_LIMIT_EXCEEDED),
576 _LDAP_MAP_CODE(LDAP_SIZE_LIMIT_EXCEEDED),
577 _LDAP_MAP_CODE(LDAP_COMPARE_FALSE),
578 _LDAP_MAP_CODE(LDAP_COMPARE_TRUE),
579 _LDAP_MAP_CODE(LDAP_AUTH_METHOD_NOT_SUPPORTED),
580 _LDAP_MAP_CODE(LDAP_STRONG_AUTH_REQUIRED),
581 _LDAP_MAP_CODE(LDAP_REFERRAL),
582 _LDAP_MAP_CODE(LDAP_ADMIN_LIMIT_EXCEEDED),
583 _LDAP_MAP_CODE(LDAP_UNAVAILABLE_CRITICAL_EXTENSION),
584 _LDAP_MAP_CODE(LDAP_CONFIDENTIALITY_REQUIRED),
585 _LDAP_MAP_CODE(LDAP_SASL_BIND_IN_PROGRESS),
586 _LDAP_MAP_CODE(LDAP_NO_SUCH_ATTRIBUTE),
587 _LDAP_MAP_CODE(LDAP_UNDEFINED_ATTRIBUTE_TYPE),
588 _LDAP_MAP_CODE(LDAP_INAPPROPRIATE_MATCHING),
589 _LDAP_MAP_CODE(LDAP_CONSTRAINT_VIOLATION),
590 _LDAP_MAP_CODE(LDAP_ATTRIBUTE_OR_VALUE_EXISTS),
591 _LDAP_MAP_CODE(LDAP_INVALID_ATTRIBUTE_SYNTAX),
592 _LDAP_MAP_CODE(LDAP_NO_SUCH_OBJECT),
593 _LDAP_MAP_CODE(LDAP_ALIAS_PROBLEM),
594 _LDAP_MAP_CODE(LDAP_INVALID_DN_SYNTAX),
595 _LDAP_MAP_CODE(LDAP_ALIAS_DEREFERENCING_PROBLEM),
596 _LDAP_MAP_CODE(LDAP_INAPPROPRIATE_AUTHENTICATION),
597 _LDAP_MAP_CODE(LDAP_INVALID_CREDENTIALS),
598 _LDAP_MAP_CODE(LDAP_INSUFFICIENT_ACCESS_RIGHTs),
599 _LDAP_MAP_CODE(LDAP_BUSY),
600 _LDAP_MAP_CODE(LDAP_UNAVAILABLE),
601 _LDAP_MAP_CODE(LDAP_UNWILLING_TO_PERFORM),
602 _LDAP_MAP_CODE(LDAP_LOOP_DETECT),
603 _LDAP_MAP_CODE(LDAP_NAMING_VIOLATION),
604 _LDAP_MAP_CODE(LDAP_OBJECT_CLASS_VIOLATION),
605 _LDAP_MAP_CODE(LDAP_NOT_ALLOWED_ON_NON_LEAF),
606 _LDAP_MAP_CODE(LDAP_NOT_ALLOWED_ON_RDN),
607 _LDAP_MAP_CODE(LDAP_ENTRY_ALREADY_EXISTS),
608 _LDAP_MAP_CODE(LDAP_OBJECT_CLASS_MODS_PROHIBITED),
609 _LDAP_MAP_CODE(LDAP_AFFECTS_MULTIPLE_DSAS),
610 _LDAP_MAP_CODE(LDAP_OTHER)
614 used to setup the status code from a ldap response
616 NTSTATUS ldap_check_response(struct ldap_connection *conn, struct ldap_Result *r)
619 const char *codename = "unknown";
621 if (r->resultcode == LDAP_SUCCESS) {
625 if (conn->last_error) {
626 talloc_free(conn->last_error);
629 for (i=0;i<ARRAY_SIZE(ldap_code_map);i++) {
630 if (r->resultcode == ldap_code_map[i].code) {
631 codename = ldap_code_map[i].str;
636 conn->last_error = talloc_asprintf(conn, "LDAP error %u %s - %s <%s> <%s>",
639 r->dn?r->dn:"(NULL)",
640 r->errormessage?r->errormessage:"",
641 r->referral?r->referral:"");
643 return NT_STATUS_LDAP(r->resultcode);
647 return error string representing the last error
649 const char *ldap_errstr(struct ldap_connection *conn, NTSTATUS status)
651 if (NT_STATUS_IS_LDAP(status) && conn->last_error != NULL) {
652 return conn->last_error;
654 return nt_errstr(status);
659 return the Nth result message, waiting if necessary
661 NTSTATUS ldap_result_n(struct ldap_request *req, int n, struct ldap_message **msg)
665 NT_STATUS_HAVE_NO_MEMORY(req);
667 while (req->state != LDAP_REQUEST_DONE && n >= req->num_replies) {
668 if (event_loop_once(req->conn->event.event_ctx) != 0) {
669 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
673 if (n < req->num_replies) {
674 *msg = req->replies[n];
678 if (!NT_STATUS_IS_OK(req->status)) {
682 return NT_STATUS_NO_MORE_ENTRIES;
687 return a single result message, checking if it is of the expected LDAP type
689 NTSTATUS ldap_result_one(struct ldap_request *req, struct ldap_message **msg, int type)
692 status = ldap_result_n(req, 0, msg);
693 if (!NT_STATUS_IS_OK(status)) {
696 if ((*msg)->type != type) {
698 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
704 a simple ldap transaction, for single result requests that only need a status code
705 this relies on single valued requests having the response type == request type + 1
707 NTSTATUS ldap_transaction(struct ldap_connection *conn, struct ldap_message *msg)
709 struct ldap_request *req = ldap_request_send(conn, msg);
710 struct ldap_message *res;
712 status = ldap_result_n(req, 0, &res);
713 if (!NT_STATUS_IS_OK(status)) {
717 if (res->type != msg->type + 1) {
719 return NT_STATUS_LDAP(LDAP_PROTOCOL_ERROR);
721 status = ldap_check_response(conn, &res->r.GeneralResult);