1 /***************************************************************************
3 * Project ___| | | | _ \| |
5 * | (__| |_| | _ <| |___
6 * \___|\___/|_| \_\_____|
8 * Copyright (C) 2010, Howard Chu, <hyc@openldap.org>
9 * Copyright (C) 2011 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
11 * This software is licensed as described in the file COPYING, which
12 * you should have received as part of this distribution. The terms
13 * are also available at https://curl.haxx.se/docs/copyright.html.
15 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
16 * copies of the Software, and permit persons to whom the Software is
17 * furnished to do so, under the terms of the COPYING file.
19 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
20 * KIND, either express or implied.
22 ***************************************************************************/
24 #include "curl_setup.h"
26 #if !defined(CURL_DISABLE_LDAP) && defined(USE_OPENLDAP)
29 * Notice that USE_OPENLDAP is only a source code selection switch. When
30 * libcurl is built with USE_OPENLDAP defined the libcurl source code that
31 * gets compiled is the code from openldap.c, otherwise the code that gets
32 * compiled is the code from ldap.c.
34 * When USE_OPENLDAP is defined a recent version of the OpenLDAP library
35 * might be required for compilation and runtime. In order to use ancient
36 * OpenLDAP library versions, USE_OPENLDAP shall not be defined.
42 #include <curl/curl.h>
44 #include "vtls/vtls.h"
46 #include "curl_ldap.h"
47 #include "curl_base64.h"
49 /* The last 3 #include files should be in this order */
50 #include "curl_printf.h"
51 #include "curl_memory.h"
55 * Uncommenting this will enable the built-in debug logging of the openldap
56 * library. The debug log level can be set using the CURL_OPENLDAP_TRACE
57 * environment variable. The debug output is written to stderr.
59 * The library supports the following debug flags:
60 * LDAP_DEBUG_NONE 0x0000
61 * LDAP_DEBUG_TRACE 0x0001
62 * LDAP_DEBUG_CONSTRUCT 0x0002
63 * LDAP_DEBUG_DESTROY 0x0004
64 * LDAP_DEBUG_PARAMETER 0x0008
65 * LDAP_DEBUG_ANY 0xffff
67 * For example, use CURL_OPENLDAP_TRACE=0 for no debug,
68 * CURL_OPENLDAP_TRACE=2 for LDAP_DEBUG_CONSTRUCT messages only,
69 * CURL_OPENLDAP_TRACE=65535 for all debug message levels.
71 /* #define CURL_OPENLDAP_DEBUG */
74 extern int ldap_pvt_url_scheme2proto(const char *);
75 extern int ldap_init_fd(ber_socket_t fd, int proto, const char *url,
79 static CURLcode ldap_setup_connection(struct connectdata *conn);
80 static CURLcode ldap_do(struct connectdata *conn, bool *done);
81 static CURLcode ldap_done(struct connectdata *conn, CURLcode, bool);
82 static CURLcode ldap_connect(struct connectdata *conn, bool *done);
83 static CURLcode ldap_connecting(struct connectdata *conn, bool *done);
84 static CURLcode ldap_disconnect(struct connectdata *conn, bool dead);
86 static Curl_recv ldap_recv;
89 * LDAP protocol handler.
92 const struct Curl_handler Curl_handler_ldap = {
94 ldap_setup_connection, /* setup_connection */
97 ZERO_NULL, /* do_more */
98 ldap_connect, /* connect_it */
99 ldap_connecting, /* connecting */
100 ZERO_NULL, /* doing */
101 ZERO_NULL, /* proto_getsock */
102 ZERO_NULL, /* doing_getsock */
103 ZERO_NULL, /* domore_getsock */
104 ZERO_NULL, /* perform_getsock */
105 ldap_disconnect, /* disconnect */
106 ZERO_NULL, /* readwrite */
107 ZERO_NULL, /* connection_check */
108 PORT_LDAP, /* defport */
109 CURLPROTO_LDAP, /* protocol */
110 CURLPROTO_LDAP, /* family */
111 PROTOPT_NONE /* flags */
116 * LDAPS protocol handler.
119 const struct Curl_handler Curl_handler_ldaps = {
120 "LDAPS", /* scheme */
121 ldap_setup_connection, /* setup_connection */
123 ldap_done, /* done */
124 ZERO_NULL, /* do_more */
125 ldap_connect, /* connect_it */
126 ldap_connecting, /* connecting */
127 ZERO_NULL, /* doing */
128 ZERO_NULL, /* proto_getsock */
129 ZERO_NULL, /* doing_getsock */
130 ZERO_NULL, /* domore_getsock */
131 ZERO_NULL, /* perform_getsock */
132 ldap_disconnect, /* disconnect */
133 ZERO_NULL, /* readwrite */
134 ZERO_NULL, /* connection_check */
135 PORT_LDAPS, /* defport */
136 CURLPROTO_LDAPS, /* protocol */
137 CURLPROTO_LDAP, /* family */
138 PROTOPT_SSL /* flags */
142 static const char *url_errs[] = {
146 "unrecognized scheme",
147 "unbalanced delimiter",
150 "bad or missing attributes",
151 "bad or missing scope",
152 "bad or missing filter",
153 "bad or missing extensions"
156 struct ldapconninfo {
158 Curl_recv *recv; /* for stacking SSL handler */
172 static CURLcode ldap_setup_connection(struct connectdata *conn)
174 struct ldapconninfo *li;
176 struct Curl_easy *data = conn->data;
180 rc = ldap_url_parse(data->change.url, &lud);
181 if(rc != LDAP_URL_SUCCESS) {
182 const char *msg = "url parsing problem";
183 status = CURLE_URL_MALFORMAT;
184 if(rc > LDAP_URL_SUCCESS && rc <= LDAP_URL_ERR_BADEXTS) {
185 if(rc == LDAP_URL_ERR_MEM)
186 status = CURLE_OUT_OF_MEMORY;
189 failf(conn->data, "LDAP local: %s", msg);
192 proto = ldap_pvt_url_scheme2proto(lud->lud_scheme);
193 ldap_free_urldesc(lud);
195 li = calloc(1, sizeof(struct ldapconninfo));
197 return CURLE_OUT_OF_MEMORY;
199 conn->proto.ldapc = li;
200 connkeep(conn, "OpenLDAP default");
205 static Sockbuf_IO ldapsb_tls;
208 static CURLcode ldap_connect(struct connectdata *conn, bool *done)
210 struct ldapconninfo *li = conn->proto.ldapc;
211 struct Curl_easy *data = conn->data;
212 int rc, proto = LDAP_VERSION3;
218 strcpy(hosturl, "ldap");
220 if(conn->handler->flags & PROTOPT_SSL)
222 msnprintf(ptr, sizeof(hosturl)-(ptr-hosturl), "://%s:%d",
223 conn->host.name, conn->remote_port);
225 #ifdef CURL_OPENLDAP_DEBUG
226 static int do_trace = 0;
227 const char *env = getenv("CURL_OPENLDAP_TRACE");
228 do_trace = (env && strtol(env, NULL, 10) > 0);
230 ldap_set_option(li->ld, LDAP_OPT_DEBUG_LEVEL, &do_trace);
234 rc = ldap_init_fd(conn->sock[FIRSTSOCKET], li->proto, hosturl, &li->ld);
236 failf(data, "LDAP local: Cannot connect to %s, %s",
237 hosturl, ldap_err2string(rc));
238 return CURLE_COULDNT_CONNECT;
241 ldap_set_option(li->ld, LDAP_OPT_PROTOCOL_VERSION, &proto);
244 if(conn->handler->flags & PROTOPT_SSL) {
246 result = Curl_ssl_connect_nonblocking(conn, FIRSTSOCKET, &li->ssldone);
255 static CURLcode ldap_connecting(struct connectdata *conn, bool *done)
257 struct ldapconninfo *li = conn->proto.ldapc;
258 struct Curl_easy *data = conn->data;
259 LDAPMessage *msg = NULL;
260 struct timeval tv = {0, 1}, *tvp;
265 if(conn->handler->flags & PROTOPT_SSL) {
266 /* Is the SSL handshake complete yet? */
268 CURLcode result = Curl_ssl_connect_nonblocking(conn, FIRSTSOCKET,
270 if(result || !li->ssldone)
274 /* Have we installed the libcurl SSL handlers into the sockbuf yet? */
277 ldap_get_option(li->ld, LDAP_OPT_SOCKBUF, &sb);
278 ber_sockbuf_add_io(sb, &ldapsb_tls, LBER_SBIOD_LEVEL_TRANSPORT, conn);
280 li->recv = conn->recv[FIRSTSOCKET];
281 li->send = conn->send[FIRSTSOCKET];
291 struct berval passwd;
293 if(conn->bits.user_passwd) {
295 passwd.bv_val = conn->passwd;
296 passwd.bv_len = strlen(passwd.bv_val);
300 passwd.bv_val = NULL;
303 rc = ldap_sasl_bind(li->ld, binddn, LDAP_SASL_SIMPLE, &passwd,
304 NULL, NULL, &li->msgid);
306 return CURLE_LDAP_CANNOT_BIND;
312 rc = ldap_result(li->ld, li->msgid, LDAP_MSG_ONE, tvp, &msg);
314 failf(data, "LDAP local: bind ldap_result %s", ldap_err2string(rc));
315 return CURLE_LDAP_CANNOT_BIND;
322 rc = ldap_parse_result(li->ld, msg, &err, NULL, &info, NULL, NULL, 1);
324 failf(data, "LDAP local: bind ldap_parse_result %s", ldap_err2string(rc));
325 return CURLE_LDAP_CANNOT_BIND;
328 /* Try to fallback to LDAPv2? */
329 if(err == LDAP_PROTOCOL_ERROR) {
331 ldap_get_option(li->ld, LDAP_OPT_PROTOCOL_VERSION, &proto);
332 if(proto == LDAP_VERSION3) {
337 proto = LDAP_VERSION2;
338 ldap_set_option(li->ld, LDAP_OPT_PROTOCOL_VERSION, &proto);
345 failf(data, "LDAP remote: bind failed %s %s", ldap_err2string(rc),
349 return CURLE_LOGIN_DENIED;
354 conn->recv[FIRSTSOCKET] = ldap_recv;
360 static CURLcode ldap_disconnect(struct connectdata *conn, bool dead_connection)
362 struct ldapconninfo *li = conn->proto.ldapc;
363 (void) dead_connection;
367 ldap_unbind_ext(li->ld, NULL, NULL);
370 conn->proto.ldapc = NULL;
376 static CURLcode ldap_do(struct connectdata *conn, bool *done)
378 struct ldapconninfo *li = conn->proto.ldapc;
379 struct ldapreqinfo *lr;
380 CURLcode status = CURLE_OK;
382 LDAPURLDesc *ludp = NULL;
384 struct Curl_easy *data = conn->data;
386 connkeep(conn, "OpenLDAP do");
388 infof(data, "LDAP local: %s\n", data->change.url);
390 rc = ldap_url_parse(data->change.url, &ludp);
391 if(rc != LDAP_URL_SUCCESS) {
392 const char *msg = "url parsing problem";
393 status = CURLE_URL_MALFORMAT;
394 if(rc > LDAP_URL_SUCCESS && rc <= LDAP_URL_ERR_BADEXTS) {
395 if(rc == LDAP_URL_ERR_MEM)
396 status = CURLE_OUT_OF_MEMORY;
399 failf(conn->data, "LDAP local: %s", msg);
403 rc = ldap_search_ext(li->ld, ludp->lud_dn, ludp->lud_scope,
404 ludp->lud_filter, ludp->lud_attrs, 0,
405 NULL, NULL, NULL, 0, &msgid);
406 ldap_free_urldesc(ludp);
407 if(rc != LDAP_SUCCESS) {
408 failf(data, "LDAP local: ldap_search_ext %s", ldap_err2string(rc));
409 return CURLE_LDAP_SEARCH_FAILED;
411 lr = calloc(1, sizeof(struct ldapreqinfo));
413 return CURLE_OUT_OF_MEMORY;
415 data->req.protop = lr;
416 Curl_setup_transfer(data, FIRSTSOCKET, -1, FALSE, -1);
421 static CURLcode ldap_done(struct connectdata *conn, CURLcode res,
424 struct ldapreqinfo *lr = conn->data->req.protop;
430 /* if there was a search in progress, abandon it */
432 struct ldapconninfo *li = conn->proto.ldapc;
433 ldap_abandon_ext(li->ld, lr->msgid, NULL, NULL);
436 conn->data->req.protop = NULL;
443 static ssize_t ldap_recv(struct connectdata *conn, int sockindex, char *buf,
444 size_t len, CURLcode *err)
446 struct ldapconninfo *li = conn->proto.ldapc;
447 struct Curl_easy *data = conn->data;
448 struct ldapreqinfo *lr = data->req.protop;
450 LDAPMessage *msg = NULL;
452 BerElement *ber = NULL;
453 struct timeval tv = {0, 1};
459 rc = ldap_result(li->ld, lr->msgid, LDAP_MSG_RECEIVED, &tv, &msg);
461 failf(data, "LDAP local: search ldap_result %s", ldap_err2string(rc));
462 *err = CURLE_RECV_ERROR;
473 for(ent = ldap_first_message(li->ld, msg); ent;
474 ent = ldap_next_message(li->ld, ent)) {
475 struct berval bv, *bvals;
476 int binary = 0, msgtype;
479 msgtype = ldap_msgtype(ent);
480 if(msgtype == LDAP_RES_SEARCH_RESULT) {
483 rc = ldap_parse_result(li->ld, ent, &code, NULL, &info, NULL, NULL, 0);
485 failf(data, "LDAP local: search ldap_parse_result %s",
486 ldap_err2string(rc));
487 *err = CURLE_LDAP_SEARCH_FAILED;
489 else if(code && code != LDAP_SIZELIMIT_EXCEEDED) {
490 failf(data, "LDAP remote: search failed %s %s", ldap_err2string(rc),
492 *err = CURLE_LDAP_SEARCH_FAILED;
496 if(code == LDAP_SIZELIMIT_EXCEEDED)
497 infof(data, "There are more than %d entries\n", lr->nument);
498 data->req.size = data->req.bytecount;
506 else if(msgtype != LDAP_RES_SEARCH_ENTRY)
510 rc = ldap_get_dn_ber(li->ld, ent, &ber, &bv);
512 *err = CURLE_RECV_ERROR;
515 writeerr = Curl_client_write(conn, CLIENTWRITE_BODY, (char *)"DN: ", 4);
521 writeerr = Curl_client_write(conn, CLIENTWRITE_BODY, (char *)bv.bv_val,
528 writeerr = Curl_client_write(conn, CLIENTWRITE_BODY, (char *)"\n", 1);
533 data->req.bytecount += bv.bv_len + 5;
535 for(rc = ldap_get_attribute_ber(li->ld, ent, ber, &bv, &bvals);
537 rc = ldap_get_attribute_ber(li->ld, ent, ber, &bv, &bvals)) {
540 if(bv.bv_val == NULL)
543 if(bv.bv_len > 7 && !strncmp(bv.bv_val + bv.bv_len - 7, ";binary", 7))
549 writeerr = Curl_client_write(conn, CLIENTWRITE_BODY, (char *)"\t", 1);
554 writeerr = Curl_client_write(conn, CLIENTWRITE_BODY, (char *)bv.bv_val,
560 writeerr = Curl_client_write(conn, CLIENTWRITE_BODY, (char *)":\n", 2);
565 data->req.bytecount += bv.bv_len + 3;
569 for(i = 0; bvals[i].bv_val != NULL; i++) {
571 writeerr = Curl_client_write(conn, CLIENTWRITE_BODY, (char *)"\t", 1);
577 writeerr = Curl_client_write(conn, CLIENTWRITE_BODY, (char *)bv.bv_val,
584 writeerr = Curl_client_write(conn, CLIENTWRITE_BODY, (char *)":", 1);
589 data->req.bytecount += bv.bv_len + 2;
592 /* check for leading or trailing whitespace */
593 if(ISSPACE(bvals[i].bv_val[0]) ||
594 ISSPACE(bvals[i].bv_val[bvals[i].bv_len-1]))
597 /* check for unprintable characters */
599 for(j = 0; j<bvals[i].bv_len; j++)
600 if(!ISPRINT(bvals[i].bv_val[j])) {
606 if(binary || binval) {
607 char *val_b64 = NULL;
608 size_t val_b64_sz = 0;
609 /* Binary value, encode to base64. */
610 CURLcode error = Curl_base64_encode(data,
622 writeerr = Curl_client_write(conn, CLIENTWRITE_BODY,
629 data->req.bytecount += 2;
631 writeerr = Curl_client_write(conn, CLIENTWRITE_BODY, val_b64,
638 data->req.bytecount += val_b64_sz;
642 writeerr = Curl_client_write(conn, CLIENTWRITE_BODY, (char *)" ", 1);
648 writeerr = Curl_client_write(conn, CLIENTWRITE_BODY, bvals[i].bv_val,
655 data->req.bytecount += bvals[i].bv_len + 1;
657 writeerr = Curl_client_write(conn, CLIENTWRITE_BODY, (char *)"\n", 0);
663 data->req.bytecount++;
666 writeerr = Curl_client_write(conn, CLIENTWRITE_BODY, (char *)"\n", 0);
671 data->req.bytecount++;
673 writeerr = Curl_client_write(conn, CLIENTWRITE_BODY, (char *)"\n", 0);
678 data->req.bytecount++;
687 ldapsb_tls_setup(Sockbuf_IO_Desc *sbiod, void *arg)
689 sbiod->sbiod_pvt = arg;
694 ldapsb_tls_remove(Sockbuf_IO_Desc *sbiod)
696 sbiod->sbiod_pvt = NULL;
700 /* We don't need to do anything because libcurl does it already */
702 ldapsb_tls_close(Sockbuf_IO_Desc *sbiod)
709 ldapsb_tls_ctrl(Sockbuf_IO_Desc *sbiod, int opt, void *arg)
712 if(opt == LBER_SB_OPT_DATA_READY) {
713 struct connectdata *conn = sbiod->sbiod_pvt;
714 return Curl_ssl_data_pending(conn, FIRSTSOCKET);
720 ldapsb_tls_read(Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
722 struct connectdata *conn = sbiod->sbiod_pvt;
723 struct ldapconninfo *li = conn->proto.ldapc;
725 CURLcode err = CURLE_RECV_ERROR;
727 ret = (li->recv)(conn, FIRSTSOCKET, buf, len, &err);
728 if(ret < 0 && err == CURLE_AGAIN) {
729 SET_SOCKERRNO(EWOULDBLOCK);
735 ldapsb_tls_write(Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
737 struct connectdata *conn = sbiod->sbiod_pvt;
738 struct ldapconninfo *li = conn->proto.ldapc;
740 CURLcode err = CURLE_SEND_ERROR;
742 ret = (li->send)(conn, FIRSTSOCKET, buf, len, &err);
743 if(ret < 0 && err == CURLE_AGAIN) {
744 SET_SOCKERRNO(EWOULDBLOCK);
749 static Sockbuf_IO ldapsb_tls =
760 #endif /* !CURL_DISABLE_LDAP && USE_OPENLDAP */