2 Unix SMB/CIFS implementation.
3 Infrastructure for async ldap client requests
4 Copyright (C) Volker Lendecke 2009
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "tldap_util.h"
23 #include "../libcli/security/security.h"
25 bool tldap_entry_values(struct tldap_message *msg, const char *attribute,
26 int *num_values, DATA_BLOB **values)
28 struct tldap_attribute *attributes;
29 int i, num_attributes;
31 if (!tldap_entry_attributes(msg, &num_attributes, &attributes)) {
35 for (i=0; i<num_attributes; i++) {
36 if (strequal(attribute, attributes[i].name)) {
40 if (i == num_attributes) {
43 *num_values = attributes[i].num_values;
44 *values = attributes[i].values;
48 bool tldap_get_single_valueblob(struct tldap_message *msg,
49 const char *attribute, DATA_BLOB *blob)
54 if (attribute == NULL) {
57 if (!tldap_entry_values(msg, attribute, &num_values, &values)) {
60 if (num_values != 1) {
67 char *tldap_talloc_single_attribute(struct tldap_message *msg,
68 const char *attribute,
75 if (!tldap_get_single_valueblob(msg, attribute, &val)) {
78 if (!convert_string_talloc(mem_ctx, CH_UTF8, CH_UNIX,
80 &result, &len, false)) {
86 bool tldap_pull_binsid(struct tldap_message *msg, const char *attribute,
91 if (!tldap_get_single_valueblob(msg, attribute, &val)) {
94 return sid_parse((char *)val.data, val.length, sid);
97 bool tldap_pull_guid(struct tldap_message *msg, const char *attribute,
102 if (!tldap_get_single_valueblob(msg, attribute, &val)) {
105 return NT_STATUS_IS_OK(GUID_from_data_blob(&val, guid));
108 static bool tldap_add_blob_vals(TALLOC_CTX *mem_ctx, struct tldap_mod *mod,
109 int num_newvals, DATA_BLOB *newvals)
111 int num_values = talloc_array_length(mod->values);
115 tmp = talloc_realloc(mem_ctx, mod->values, DATA_BLOB,
116 num_values + num_newvals);
122 for (i=0; i<num_newvals; i++) {
123 mod->values[i+num_values].data = (uint8_t *)talloc_memdup(
124 mod->values, newvals[i].data, newvals[i].length);
125 if (mod->values[i+num_values].data == NULL) {
128 mod->values[i+num_values].length = newvals[i].length;
130 mod->num_values = num_values + num_newvals;
134 bool tldap_add_mod_blobs(TALLOC_CTX *mem_ctx,
135 struct tldap_mod **pmods,
136 int mod_op, const char *attrib,
137 DATA_BLOB *newvals, int num_newvals)
139 struct tldap_mod new_mod;
140 struct tldap_mod *mods = *pmods;
141 struct tldap_mod *mod = NULL;
145 mods = talloc_array(mem_ctx, struct tldap_mod, 0);
151 num_mods = talloc_array_length(mods);
153 for (i=0; i<num_mods; i++) {
154 if ((mods[i].mod_op == mod_op)
155 && strequal(mods[i].attribute, attrib)) {
162 new_mod.mod_op = mod_op;
163 new_mod.attribute = talloc_strdup(mods, attrib);
164 if (new_mod.attribute == NULL) {
167 new_mod.num_values = 0;
168 new_mod.values = NULL;
172 if ((num_newvals != 0)
173 && !tldap_add_blob_vals(mods, mod, num_newvals, newvals)) {
178 mods = talloc_realloc(talloc_tos(), mods, struct tldap_mod,
183 mods[num_mods] = *mod;
190 bool tldap_add_mod_str(TALLOC_CTX *mem_ctx, struct tldap_mod **pmods,
191 int mod_op, const char *attrib, const char *str)
196 if (!convert_string_talloc(talloc_tos(), CH_UNIX, CH_UTF8, str,
197 strlen(str), &utf8.data, &utf8.length,
202 ret = tldap_add_mod_blobs(mem_ctx, pmods, mod_op, attrib, &utf8, 1);
203 TALLOC_FREE(utf8.data);
207 static bool tldap_make_mod_blob_int(struct tldap_message *existing,
209 int *pnum_mods, struct tldap_mod **pmods,
210 const char *attrib, DATA_BLOB newval,
211 int (*comparison)(const DATA_BLOB *d1,
212 const DATA_BLOB *d2))
215 DATA_BLOB *values = NULL;
216 DATA_BLOB oldval = data_blob_null;
218 if ((existing != NULL)
219 && tldap_entry_values(existing, attrib, &num_values, &values)) {
221 if (num_values > 1) {
222 /* can't change multivalue attributes atm */
225 if (num_values == 1) {
230 if ((oldval.data != NULL) && (newval.data != NULL)
231 && (comparison(&oldval, &newval) == 0)) {
232 /* Believe it or not, but LDAP will deny a delete and
233 an add at the same time if the values are the
235 DEBUG(10,("smbldap_make_mod_blob: attribute |%s| not "
236 "changed.\n", attrib));
240 if (oldval.data != NULL) {
241 /* By deleting exactly the value we found in the entry this
242 * should be race-free in the sense that the LDAP-Server will
243 * deny the complete operation if somebody changed the
244 * attribute behind our back. */
245 /* This will also allow modifying single valued attributes in
246 * Novell NDS. In NDS you have to first remove attribute and
247 * then you could add new value */
249 DEBUG(10, ("smbldap_make_mod_blob: deleting attribute |%s|\n",
251 if (!tldap_add_mod_blobs(mem_ctx, pmods, TLDAP_MOD_DELETE,
252 attrib, &oldval, 1)) {
257 /* Regardless of the real operation (add or modify)
258 we add the new value here. We rely on deleting
259 the old value, should it exist. */
261 if (newval.data != NULL) {
262 DEBUG(10, ("smbldap_make_mod: adding attribute |%s| value len "
263 "%d\n", attrib, (int)newval.length));
264 if (!tldap_add_mod_blobs(mem_ctx, pmods, TLDAP_MOD_ADD,
265 attrib, &newval, 1)) {
269 *pnum_mods = talloc_array_length(*pmods);
273 bool tldap_make_mod_blob(struct tldap_message *existing, TALLOC_CTX *mem_ctx,
274 int *pnum_mods, struct tldap_mod **pmods,
275 const char *attrib, DATA_BLOB newval)
277 return tldap_make_mod_blob_int(existing, mem_ctx, pnum_mods, pmods,
278 attrib, newval, data_blob_cmp);
281 static int compare_utf8_blobs(const DATA_BLOB *d1, const DATA_BLOB *d2)
287 if (!convert_string_talloc(talloc_tos(), CH_UTF8, CH_UNIX, d1->data,
288 d1->length, &s1, &s1len, false)) {
289 /* can't do much here */
292 if (!convert_string_talloc(talloc_tos(), CH_UTF8, CH_UNIX, d2->data,
293 d2->length, &s2, &s2len, false)) {
294 /* can't do much here */
298 ret = StrCaseCmp(s1, s2);
304 bool tldap_make_mod_fmt(struct tldap_message *existing, TALLOC_CTX *mem_ctx,
305 int *pnum_mods, struct tldap_mod **pmods,
306 const char *attrib, const char *fmt, ...)
311 DATA_BLOB blob = data_blob_null;
314 newval = talloc_vasprintf(talloc_tos(), fmt, ap);
317 if (newval == NULL) {
321 blob.length = strlen(newval);
322 if (blob.length != 0) {
323 blob.data = CONST_DISCARD(uint8_t *, newval);
325 ret = tldap_make_mod_blob_int(existing, mem_ctx, pnum_mods, pmods,
326 attrib, blob, compare_utf8_blobs);
331 const char *tldap_errstr(TALLOC_CTX *mem_ctx, struct tldap_context *ld, int rc)
333 const char *ld_error = NULL;
336 ld_error = tldap_msg_diagnosticmessage(tldap_ctx_lastmsg(ld));
337 res = talloc_asprintf(mem_ctx, "LDAP error %d (%s), %s", rc,
338 tldap_err2string(rc),
339 ld_error ? ld_error : "unknown");
343 int tldap_search_va(struct tldap_context *ld, const char *base, int scope,
344 const char *attrs[], int num_attrs, int attrsonly,
345 TALLOC_CTX *mem_ctx, struct tldap_message ***res,
346 const char *fmt, va_list ap)
351 filter = talloc_vasprintf(talloc_tos(), fmt, ap);
352 if (filter == NULL) {
353 return TLDAP_NO_MEMORY;
356 ret = tldap_search(ld, base, scope, filter,
357 attrs, num_attrs, attrsonly,
358 NULL /*sctrls*/, 0, NULL /*cctrls*/, 0,
359 0 /*timelimit*/, 0 /*sizelimit*/, 0 /*deref*/,
365 int tldap_search_fmt(struct tldap_context *ld, const char *base, int scope,
366 const char *attrs[], int num_attrs, int attrsonly,
367 TALLOC_CTX *mem_ctx, struct tldap_message ***res,
368 const char *fmt, ...)
374 ret = tldap_search_va(ld, base, scope, attrs, num_attrs, attrsonly,
375 mem_ctx, res, fmt, ap);
380 bool tldap_pull_uint64(struct tldap_message *msg, const char *attr,
386 str = tldap_talloc_single_attribute(msg, attr, talloc_tos());
388 DEBUG(10, ("Could not find attribute %s\n", attr));
391 result = strtoull(str, NULL, 10);
397 bool tldap_pull_uint32(struct tldap_message *msg, const char *attr,
402 if (!tldap_pull_uint64(msg, attr, &result)) {
405 *presult = (uint32_t)result;
409 struct tldap_fetch_rootdse_state {
410 struct tldap_context *ld;
411 struct tldap_message *rootdse;
414 static void tldap_fetch_rootdse_done(struct tevent_req *subreq);
416 struct tevent_req *tldap_fetch_rootdse_send(TALLOC_CTX *mem_ctx,
417 struct tevent_context *ev,
418 struct tldap_context *ld)
420 struct tevent_req *req, *subreq;
421 struct tldap_fetch_rootdse_state *state;
422 static const char *attrs[2] = { "*", "+" };
424 req = tevent_req_create(mem_ctx, &state,
425 struct tldap_fetch_rootdse_state);
430 state->rootdse = NULL;
432 subreq = tldap_search_send(
433 mem_ctx, ev, ld, "", TLDAP_SCOPE_BASE, "(objectclass=*)",
434 attrs, ARRAY_SIZE(attrs), 0, NULL, 0, NULL, 0, 0, 0, 0);
435 if (tevent_req_nomem(subreq, req)) {
436 return tevent_req_post(req, ev);
438 tevent_req_set_callback(subreq, tldap_fetch_rootdse_done, req);
442 static void tldap_fetch_rootdse_done(struct tevent_req *subreq)
444 struct tevent_req *req = tevent_req_callback_data(
445 subreq, struct tevent_req);
446 struct tldap_fetch_rootdse_state *state = tevent_req_data(
447 req, struct tldap_fetch_rootdse_state);
448 struct tldap_message *msg;
451 rc = tldap_search_recv(subreq, state, &msg);
452 if (rc != TLDAP_SUCCESS) {
454 tevent_req_error(req, rc);
458 switch (tldap_msg_type(msg)) {
459 case TLDAP_RES_SEARCH_ENTRY:
460 if (state->rootdse != NULL) {
463 state->rootdse = msg;
465 case TLDAP_RES_SEARCH_RESULT:
467 if (state->rootdse == NULL) {
470 tevent_req_done(req);
478 tevent_req_error(req, TLDAP_PROTOCOL_ERROR);
482 int tldap_fetch_rootdse_recv(struct tevent_req *req)
484 struct tldap_fetch_rootdse_state *state = tevent_req_data(
485 req, struct tldap_fetch_rootdse_state);
489 if (tevent_req_is_ldap_error(req, &err)) {
492 /* Trigger parsing the dn, just to make sure it's ok */
493 if (!tldap_entry_dn(state->rootdse, &dn)) {
494 return TLDAP_DECODING_ERROR;
496 if (!tldap_context_setattr(state->ld, "tldap:rootdse",
498 return TLDAP_NO_MEMORY;
503 int tldap_fetch_rootdse(struct tldap_context *ld)
505 TALLOC_CTX *frame = talloc_stackframe();
506 struct tevent_context *ev;
507 struct tevent_req *req;
510 ev = event_context_init(frame);
512 result = TLDAP_NO_MEMORY;
516 req = tldap_fetch_rootdse_send(frame, ev, ld);
518 result = TLDAP_NO_MEMORY;
522 if (!tevent_req_poll(req, ev)) {
523 result = TLDAP_OPERATIONS_ERROR;
527 result = tldap_fetch_rootdse_recv(req);
533 struct tldap_message *tldap_rootdse(struct tldap_context *ld)
535 return talloc_get_type(tldap_context_getattr(ld, "tldap:rootdse"),
536 struct tldap_message);
539 bool tldap_entry_has_attrvalue(struct tldap_message *msg,
540 const char *attribute,
541 const DATA_BLOB blob)
546 if (!tldap_entry_values(msg, attribute, &num_values, &values)) {
549 for (i=0; i<num_values; i++) {
550 if (data_blob_cmp(&values[i], &blob) == 0) {
557 bool tldap_supports_control(struct tldap_context *ld, const char *oid)
559 struct tldap_message *rootdse = tldap_rootdse(ld);
561 if (rootdse == NULL) {
564 return tldap_entry_has_attrvalue(rootdse, "supportedControl",
565 data_blob_const(oid, strlen(oid)));
568 struct tldap_control *tldap_add_control(TALLOC_CTX *mem_ctx,
569 struct tldap_control *ctrls,
571 struct tldap_control *ctrl)
573 struct tldap_control *result;
575 result = talloc_array(mem_ctx, struct tldap_control, num_ctrls+1);
576 if (result == NULL) {
579 memcpy(result, ctrls, sizeof(struct tldap_control) * num_ctrls);
580 result[num_ctrls] = *ctrl;
585 * Find a control returned by the server
587 struct tldap_control *tldap_msg_findcontrol(struct tldap_message *msg,
590 struct tldap_control *controls;
593 tldap_msg_sctrls(msg, &num_controls, &controls);
595 for (i=0; i<num_controls; i++) {
596 if (strcmp(controls[i].oid, oid) == 0) {
603 struct tldap_search_paged_state {
604 struct tevent_context *ev;
605 struct tldap_context *ld;
612 struct tldap_control *sctrls;
614 struct tldap_control *cctrls;
621 struct asn1_data *asn1;
623 struct tldap_message *result;
626 static struct tevent_req *tldap_ship_paged_search(
628 struct tldap_search_paged_state *state)
630 struct tldap_control *pgctrl;
631 struct asn1_data *asn1;
633 asn1 = asn1_init(state);
637 asn1_push_tag(asn1, ASN1_SEQUENCE(0));
638 asn1_write_Integer(asn1, state->page_size);
639 asn1_write_OctetString(asn1, state->cookie.data, state->cookie.length);
641 if (asn1->has_error) {
647 pgctrl = &state->sctrls[state->num_sctrls-1];
648 pgctrl->oid = TLDAP_CONTROL_PAGEDRESULTS;
649 pgctrl->critical = true;
650 if (!asn1_blob(state->asn1, &pgctrl->value)) {
654 return tldap_search_send(mem_ctx, state->ev, state->ld, state->base,
655 state->scope, state->filter, state->attrs,
656 state->num_attrs, state->attrsonly,
657 state->sctrls, state->num_sctrls,
658 state->cctrls, state->num_cctrls,
659 state->timelimit, state->sizelimit,
663 static void tldap_search_paged_done(struct tevent_req *subreq);
665 struct tevent_req *tldap_search_paged_send(TALLOC_CTX *mem_ctx,
666 struct tevent_context *ev,
667 struct tldap_context *ld,
668 const char *base, int scope,
673 struct tldap_control *sctrls,
675 struct tldap_control *cctrls,
682 struct tevent_req *req, *subreq;
683 struct tldap_search_paged_state *state;
684 struct tldap_control empty_control;
686 req = tevent_req_create(mem_ctx, &state,
687 struct tldap_search_paged_state);
694 state->filter = filter;
695 state->scope = scope;
696 state->attrs = attrs;
697 state->num_attrs = num_attrs;
698 state->attrsonly = attrsonly;
699 state->cctrls = cctrls;
700 state->num_cctrls = num_cctrls;
701 state->timelimit = timelimit;
702 state->sizelimit = sizelimit;
703 state->deref = deref;
705 state->page_size = page_size;
707 state->cookie = data_blob_null;
709 ZERO_STRUCT(empty_control);
711 state->sctrls = tldap_add_control(state, sctrls, num_sctrls,
713 if (tevent_req_nomem(state->sctrls, req)) {
714 return tevent_req_post(req, ev);
716 state->num_sctrls = num_sctrls+1;
718 subreq = tldap_ship_paged_search(state, state);
719 if (tevent_req_nomem(subreq, req)) {
720 return tevent_req_post(req, ev);
722 tevent_req_set_callback(subreq, tldap_search_paged_done, req);
727 static void tldap_search_paged_done(struct tevent_req *subreq)
729 struct tevent_req *req = tevent_req_callback_data(
730 subreq, struct tevent_req);
731 struct tldap_search_paged_state *state = tevent_req_data(
732 req, struct tldap_search_paged_state);
733 struct asn1_data *asn1;
734 struct tldap_control *pgctrl;
737 rc = tldap_search_recv(subreq, state, &state->result);
738 if (rc != TLDAP_SUCCESS) {
740 tevent_req_error(req, rc);
744 TALLOC_FREE(state->asn1);
746 switch (tldap_msg_type(state->result)) {
747 case TLDAP_RES_SEARCH_ENTRY:
748 case TLDAP_RES_SEARCH_REFERENCE:
749 tevent_req_notify_callback(req);
751 case TLDAP_RES_SEARCH_RESULT:
755 tevent_req_error(req, TLDAP_PROTOCOL_ERROR);
761 /* We've finished one paged search, fire the next */
763 pgctrl = tldap_msg_findcontrol(state->result,
764 TLDAP_CONTROL_PAGEDRESULTS);
765 if (pgctrl == NULL) {
766 /* RFC2696 requires the server to return the control */
767 tevent_req_error(req, TLDAP_PROTOCOL_ERROR);
771 TALLOC_FREE(state->cookie.data);
773 asn1 = asn1_init(talloc_tos());
775 tevent_req_error(req, TLDAP_NO_MEMORY);
779 asn1_load_nocopy(asn1, pgctrl->value.data, pgctrl->value.length);
780 asn1_start_tag(asn1, ASN1_SEQUENCE(0));
781 asn1_read_Integer(asn1, &size);
782 asn1_read_OctetString(asn1, state, &state->cookie);
784 if (asn1->has_error) {
785 tevent_req_error(req, TLDAP_DECODING_ERROR);
790 if (state->cookie.length == 0) {
791 /* We're done, no cookie anymore */
792 tevent_req_done(req);
796 TALLOC_FREE(state->result);
798 subreq = tldap_ship_paged_search(state, state);
799 if (tevent_req_nomem(subreq, req)) {
802 tevent_req_set_callback(subreq, tldap_search_paged_done, req);
805 int tldap_search_paged_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
806 struct tldap_message **pmsg)
808 struct tldap_search_paged_state *state = tevent_req_data(
809 req, struct tldap_search_paged_state);
812 if (!tevent_req_is_in_progress(req)
813 && tevent_req_is_ldap_error(req, &err)) {
816 if (tevent_req_is_in_progress(req)) {
817 switch (tldap_msg_type(state->result)) {
818 case TLDAP_RES_SEARCH_ENTRY:
819 case TLDAP_RES_SEARCH_REFERENCE:
822 return TLDAP_PROTOCOL_ERROR;
825 *pmsg = talloc_move(mem_ctx, &state->result);
826 return TLDAP_SUCCESS;