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 bool tldap_entry_values(struct tldap_message
*msg
, const char *attribute
,
23 int *num_values
, DATA_BLOB
**values
)
25 struct tldap_attribute
*attributes
;
26 int i
, num_attributes
;
28 if (!tldap_entry_attributes(msg
, &num_attributes
, &attributes
)) {
32 for (i
=0; i
<num_attributes
; i
++) {
33 if (strequal(attribute
, attributes
[i
].name
)) {
37 if (i
== num_attributes
) {
40 *num_values
= attributes
[i
].num_values
;
41 *values
= attributes
[i
].values
;
45 bool tldap_get_single_valueblob(struct tldap_message
*msg
,
46 const char *attribute
, DATA_BLOB
*blob
)
51 if (attribute
== NULL
) {
54 if (!tldap_entry_values(msg
, attribute
, &num_values
, &values
)) {
57 if (num_values
!= 1) {
64 char *tldap_talloc_single_attribute(struct tldap_message
*msg
,
65 const char *attribute
,
72 if (!tldap_get_single_valueblob(msg
, attribute
, &val
)) {
75 if (!convert_string_talloc(mem_ctx
, CH_UTF8
, CH_UNIX
,
77 &result
, &len
, false)) {
83 bool tldap_pull_binsid(struct tldap_message
*msg
, const char *attribute
,
88 if (!tldap_get_single_valueblob(msg
, attribute
, &val
)) {
91 return sid_parse((char *)val
.data
, val
.length
, sid
);
94 bool tldap_pull_guid(struct tldap_message
*msg
, const char *attribute
,
99 if (!tldap_get_single_valueblob(msg
, attribute
, &val
)) {
102 return NT_STATUS_IS_OK(GUID_from_data_blob(&val
, guid
));
105 static bool tldap_add_blob_vals(TALLOC_CTX
*mem_ctx
, struct tldap_mod
*mod
,
106 int num_newvals
, DATA_BLOB
*newvals
)
108 int num_values
= talloc_array_length(mod
->values
);
112 tmp
= talloc_realloc(mem_ctx
, mod
->values
, DATA_BLOB
,
113 num_values
+ num_newvals
);
119 for (i
=0; i
<num_newvals
; i
++) {
120 mod
->values
[i
+num_values
].data
= (uint8_t *)talloc_memdup(
121 mod
->values
, newvals
[i
].data
, newvals
[i
].length
);
122 if (mod
->values
[i
+num_values
].data
== NULL
) {
125 mod
->values
[i
+num_values
].length
= newvals
[i
].length
;
127 mod
->num_values
= num_values
+ num_newvals
;
131 bool tldap_add_mod_blobs(TALLOC_CTX
*mem_ctx
, struct tldap_mod
**pmods
,
132 int mod_op
, const char *attrib
,
133 int num_newvals
, DATA_BLOB
*newvals
)
135 struct tldap_mod new_mod
;
136 struct tldap_mod
*mods
= *pmods
;
137 struct tldap_mod
*mod
= NULL
;
141 mods
= talloc_array(mem_ctx
, struct tldap_mod
, 0);
147 num_mods
= talloc_array_length(mods
);
149 for (i
=0; i
<num_mods
; i
++) {
150 if ((mods
[i
].mod_op
== mod_op
)
151 && strequal(mods
[i
].attribute
, attrib
)) {
158 new_mod
.mod_op
= mod_op
;
159 new_mod
.attribute
= talloc_strdup(mods
, attrib
);
160 if (new_mod
.attribute
== NULL
) {
163 new_mod
.num_values
= 0;
164 new_mod
.values
= NULL
;
168 if ((num_newvals
!= 0)
169 && !tldap_add_blob_vals(mods
, mod
, num_newvals
, newvals
)) {
174 mods
= talloc_realloc(talloc_tos(), mods
, struct tldap_mod
,
179 mods
[num_mods
] = *mod
;
186 bool tldap_add_mod_str(TALLOC_CTX
*mem_ctx
, struct tldap_mod
**pmods
,
187 int mod_op
, const char *attrib
, const char *str
)
192 if (!convert_string_talloc(talloc_tos(), CH_UNIX
, CH_UTF8
, str
,
193 strlen(str
), &utf8
.data
, &utf8
.length
,
198 ret
= tldap_add_mod_blobs(mem_ctx
, pmods
, mod_op
, attrib
, 1, &utf8
);
199 TALLOC_FREE(utf8
.data
);
203 static bool tldap_make_mod_blob_int(struct tldap_message
*existing
,
205 int *pnum_mods
, struct tldap_mod
**pmods
,
206 const char *attrib
, DATA_BLOB newval
,
207 int (*comparison
)(const DATA_BLOB
*d1
,
208 const DATA_BLOB
*d2
))
211 DATA_BLOB
*values
= NULL
;
212 DATA_BLOB oldval
= data_blob_null
;
214 if ((existing
!= NULL
)
215 && tldap_entry_values(existing
, attrib
, &num_values
, &values
)) {
217 if (num_values
> 1) {
218 /* can't change multivalue attributes atm */
221 if (num_values
== 1) {
226 if ((oldval
.data
!= NULL
) && (newval
.data
!= NULL
)
227 && (comparison(&oldval
, &newval
) == 0)) {
228 /* Believe it or not, but LDAP will deny a delete and
229 an add at the same time if the values are the
231 DEBUG(10,("smbldap_make_mod_blob: attribute |%s| not "
232 "changed.\n", attrib
));
236 if (oldval
.data
!= NULL
) {
237 /* By deleting exactly the value we found in the entry this
238 * should be race-free in the sense that the LDAP-Server will
239 * deny the complete operation if somebody changed the
240 * attribute behind our back. */
241 /* This will also allow modifying single valued attributes in
242 * Novell NDS. In NDS you have to first remove attribute and
243 * then you could add new value */
245 DEBUG(10, ("smbldap_make_mod_blob: deleting attribute |%s|\n",
247 if (!tldap_add_mod_blobs(mem_ctx
, pmods
, TLDAP_MOD_DELETE
,
248 attrib
, 1, &oldval
)) {
253 /* Regardless of the real operation (add or modify)
254 we add the new value here. We rely on deleting
255 the old value, should it exist. */
257 if (newval
.data
!= NULL
) {
258 DEBUG(10, ("smbldap_make_mod: adding attribute |%s| value len "
259 "%d\n", attrib
, (int)newval
.length
));
260 if (!tldap_add_mod_blobs(mem_ctx
, pmods
, TLDAP_MOD_ADD
,
261 attrib
, 1, &newval
)) {
265 *pnum_mods
= talloc_array_length(*pmods
);
269 bool tldap_make_mod_blob(struct tldap_message
*existing
, TALLOC_CTX
*mem_ctx
,
270 int *pnum_mods
, struct tldap_mod
**pmods
,
271 const char *attrib
, DATA_BLOB newval
)
273 return tldap_make_mod_blob_int(existing
, mem_ctx
, pnum_mods
, pmods
,
274 attrib
, newval
, data_blob_cmp
);
277 static int compare_utf8_blobs(const DATA_BLOB
*d1
, const DATA_BLOB
*d2
)
283 if (!convert_string_talloc(talloc_tos(), CH_UTF8
, CH_UNIX
, d1
->data
,
284 d1
->length
, &s1
, &s1len
, false)) {
285 /* can't do much here */
288 if (!convert_string_talloc(talloc_tos(), CH_UTF8
, CH_UNIX
, d2
->data
,
289 d2
->length
, &s2
, &s2len
, false)) {
290 /* can't do much here */
294 ret
= StrCaseCmp(s1
, s2
);
300 bool tldap_make_mod_fmt(struct tldap_message
*existing
, TALLOC_CTX
*mem_ctx
,
301 int *pnum_mods
, struct tldap_mod
**pmods
,
302 const char *attrib
, const char *fmt
, ...)
307 DATA_BLOB blob
= data_blob_null
;
310 newval
= talloc_vasprintf(talloc_tos(), fmt
, ap
);
313 if (newval
== NULL
) {
317 blob
.length
= strlen(newval
);
318 if (blob
.length
!= 0) {
319 blob
.data
= CONST_DISCARD(uint8_t *, newval
);
321 ret
= tldap_make_mod_blob_int(existing
, mem_ctx
, pnum_mods
, pmods
,
322 attrib
, blob
, compare_utf8_blobs
);
327 const char *tldap_errstr(TALLOC_CTX
*mem_ctx
, struct tldap_context
*ld
, int rc
)
329 const char *ld_error
= NULL
;
332 ld_error
= tldap_msg_diagnosticmessage(tldap_ctx_lastmsg(ld
));
333 res
= talloc_asprintf(mem_ctx
, "LDAP error %d (%s), %s", rc
,
334 tldap_err2string(rc
),
335 ld_error
? ld_error
: "unknown");
339 int tldap_search_va(struct tldap_context
*ld
, const char *base
, int scope
,
340 const char *attrs
[], int num_attrs
, int attrsonly
,
341 TALLOC_CTX
*mem_ctx
, struct tldap_message
***res
,
342 const char *fmt
, va_list ap
)
347 filter
= talloc_vasprintf(talloc_tos(), fmt
, ap
);
348 if (filter
== NULL
) {
349 return TLDAP_NO_MEMORY
;
352 ret
= tldap_search(ld
, base
, scope
, filter
,
353 attrs
, num_attrs
, attrsonly
,
354 NULL
/*sctrls*/, 0, NULL
/*cctrls*/, 0,
355 0 /*timelimit*/, 0 /*sizelimit*/, 0 /*deref*/,
361 int tldap_search_fmt(struct tldap_context
*ld
, const char *base
, int scope
,
362 const char *attrs
[], int num_attrs
, int attrsonly
,
363 TALLOC_CTX
*mem_ctx
, struct tldap_message
***res
,
364 const char *fmt
, ...)
370 ret
= tldap_search_va(ld
, base
, scope
, attrs
, num_attrs
, attrsonly
,
371 mem_ctx
, res
, fmt
, ap
);
376 bool tldap_pull_uint64(struct tldap_message
*msg
, const char *attr
,
382 str
= tldap_talloc_single_attribute(msg
, attr
, talloc_tos());
384 DEBUG(10, ("Could not find attribute %s\n", attr
));
387 result
= strtoull(str
, NULL
, 10);
393 bool tldap_pull_uint32(struct tldap_message
*msg
, const char *attr
,
398 if (!tldap_pull_uint64(msg
, attr
, &result
)) {
401 *presult
= (uint32_t)result
;
405 struct tldap_fetch_rootdse_state
{
406 struct tldap_context
*ld
;
407 struct tldap_message
*rootdse
;
410 static void tldap_fetch_rootdse_done(struct tevent_req
*subreq
);
412 struct tevent_req
*tldap_fetch_rootdse_send(TALLOC_CTX
*mem_ctx
,
413 struct tevent_context
*ev
,
414 struct tldap_context
*ld
)
416 struct tevent_req
*req
, *subreq
;
417 struct tldap_fetch_rootdse_state
*state
;
418 static const char *attrs
[2] = { "*", "+" };
420 req
= tevent_req_create(mem_ctx
, &state
,
421 struct tldap_fetch_rootdse_state
);
426 state
->rootdse
= NULL
;
428 subreq
= tldap_search_send(
429 mem_ctx
, ev
, ld
, "", TLDAP_SCOPE_BASE
, "(objectclass=*)",
430 attrs
, ARRAY_SIZE(attrs
), 0, NULL
, 0, NULL
, 0, 0, 0, 0);
431 if (tevent_req_nomem(subreq
, req
)) {
432 return tevent_req_post(req
, ev
);
434 tevent_req_set_callback(subreq
, tldap_fetch_rootdse_done
, req
);
438 static void tldap_fetch_rootdse_done(struct tevent_req
*subreq
)
440 struct tevent_req
*req
= tevent_req_callback_data(
441 subreq
, struct tevent_req
);
442 struct tldap_fetch_rootdse_state
*state
= tevent_req_data(
443 req
, struct tldap_fetch_rootdse_state
);
444 struct tldap_message
*msg
;
447 rc
= tldap_search_recv(subreq
, state
, &msg
);
448 if (rc
!= TLDAP_SUCCESS
) {
450 tevent_req_error(req
, rc
);
454 switch (tldap_msg_type(msg
)) {
455 case TLDAP_RES_SEARCH_ENTRY
:
456 if (state
->rootdse
!= NULL
) {
459 state
->rootdse
= msg
;
461 case TLDAP_RES_SEARCH_RESULT
:
463 if (state
->rootdse
== NULL
) {
466 tevent_req_done(req
);
474 tevent_req_error(req
, TLDAP_PROTOCOL_ERROR
);
478 int tldap_fetch_rootdse_recv(struct tevent_req
*req
)
480 struct tldap_fetch_rootdse_state
*state
= tevent_req_data(
481 req
, struct tldap_fetch_rootdse_state
);
485 if (tevent_req_is_ldap_error(req
, &err
)) {
488 /* Trigger parsing the dn, just to make sure it's ok */
489 if (!tldap_entry_dn(state
->rootdse
, &dn
)) {
490 return TLDAP_DECODING_ERROR
;
492 if (!tldap_context_setattr(state
->ld
, "tldap:rootdse",
494 return TLDAP_NO_MEMORY
;
499 int tldap_fetch_rootdse(struct tldap_context
*ld
)
501 TALLOC_CTX
*frame
= talloc_stackframe();
502 struct tevent_context
*ev
;
503 struct tevent_req
*req
;
506 ev
= event_context_init(frame
);
508 result
= TLDAP_NO_MEMORY
;
512 req
= tldap_fetch_rootdse_send(frame
, ev
, ld
);
514 result
= TLDAP_NO_MEMORY
;
518 if (!tevent_req_poll(req
, ev
)) {
519 result
= TLDAP_OPERATIONS_ERROR
;
523 result
= tldap_fetch_rootdse_recv(req
);
529 struct tldap_message
*tldap_rootdse(struct tldap_context
*ld
)
531 return talloc_get_type(tldap_context_getattr(ld
, "tldap:rootdse"),
532 struct tldap_message
);
535 bool tldap_entry_has_attrvalue(struct tldap_message
*msg
,
536 const char *attribute
,
537 const DATA_BLOB blob
)
542 if (!tldap_entry_values(msg
, attribute
, &num_values
, &values
)) {
545 for (i
=0; i
<num_values
; i
++) {
546 if (data_blob_cmp(&values
[i
], &blob
) == 0) {
553 bool tldap_supports_control(struct tldap_context
*ld
, const char *oid
)
555 struct tldap_message
*rootdse
= tldap_rootdse(ld
);
557 if (rootdse
== NULL
) {
560 return tldap_entry_has_attrvalue(rootdse
, "supportedControl",
561 data_blob_const(oid
, strlen(oid
)));
564 struct tldap_control
*tldap_add_control(TALLOC_CTX
*mem_ctx
,
565 struct tldap_control
*ctrls
,
567 struct tldap_control
*ctrl
)
569 struct tldap_control
*result
;
571 result
= talloc_array(mem_ctx
, struct tldap_control
, num_ctrls
+1);
572 if (result
== NULL
) {
575 memcpy(result
, ctrls
, sizeof(struct tldap_control
) * num_ctrls
);
576 result
[num_ctrls
] = *ctrl
;
581 * Find a control returned by the server
583 struct tldap_control
*tldap_msg_findcontrol(struct tldap_message
*msg
,
586 struct tldap_control
*controls
;
589 tldap_msg_sctrls(msg
, &num_controls
, &controls
);
591 for (i
=0; i
<num_controls
; i
++) {
592 if (strcmp(controls
[i
].oid
, oid
) == 0) {
599 struct tldap_search_paged_state
{
600 struct tevent_context
*ev
;
601 struct tldap_context
*ld
;
608 struct tldap_control
*sctrls
;
610 struct tldap_control
*cctrls
;
617 struct asn1_data
*asn1
;
619 struct tldap_message
*result
;
622 static struct tevent_req
*tldap_ship_paged_search(
624 struct tldap_search_paged_state
*state
)
626 struct tldap_control
*pgctrl
;
627 struct asn1_data
*asn1
;
629 asn1
= asn1_init(state
);
633 asn1_push_tag(asn1
, ASN1_SEQUENCE(0));
634 asn1_write_Integer(asn1
, state
->page_size
);
635 asn1_write_OctetString(asn1
, state
->cookie
.data
, state
->cookie
.length
);
637 if (asn1
->has_error
) {
643 pgctrl
= &state
->sctrls
[state
->num_sctrls
-1];
644 pgctrl
->oid
= TLDAP_CONTROL_PAGEDRESULTS
;
645 pgctrl
->critical
= true;
646 if (!asn1_blob(state
->asn1
, &pgctrl
->value
)) {
650 return tldap_search_send(mem_ctx
, state
->ev
, state
->ld
, state
->base
,
651 state
->scope
, state
->filter
, state
->attrs
,
652 state
->num_attrs
, state
->attrsonly
,
653 state
->sctrls
, state
->num_sctrls
,
654 state
->cctrls
, state
->num_cctrls
,
655 state
->timelimit
, state
->sizelimit
,
659 static void tldap_search_paged_done(struct tevent_req
*subreq
);
661 struct tevent_req
*tldap_search_paged_send(TALLOC_CTX
*mem_ctx
,
662 struct tevent_context
*ev
,
663 struct tldap_context
*ld
,
664 const char *base
, int scope
,
669 struct tldap_control
*sctrls
,
671 struct tldap_control
*cctrls
,
678 struct tevent_req
*req
, *subreq
;
679 struct tldap_search_paged_state
*state
;
680 struct tldap_control empty_control
;
682 req
= tevent_req_create(mem_ctx
, &state
,
683 struct tldap_search_paged_state
);
690 state
->filter
= filter
;
691 state
->scope
= scope
;
692 state
->attrs
= attrs
;
693 state
->num_attrs
= num_attrs
;
694 state
->attrsonly
= attrsonly
;
695 state
->cctrls
= cctrls
;
696 state
->num_cctrls
= num_cctrls
;
697 state
->timelimit
= timelimit
;
698 state
->sizelimit
= sizelimit
;
699 state
->deref
= deref
;
701 state
->page_size
= page_size
;
703 state
->cookie
= data_blob_null
;
705 ZERO_STRUCT(empty_control
);
707 state
->sctrls
= tldap_add_control(state
, sctrls
, num_sctrls
,
709 if (tevent_req_nomem(state
->sctrls
, req
)) {
710 return tevent_req_post(req
, ev
);
712 state
->num_sctrls
= num_sctrls
+1;
714 subreq
= tldap_ship_paged_search(state
, state
);
715 if (tevent_req_nomem(subreq
, req
)) {
716 return tevent_req_post(req
, ev
);
718 tevent_req_set_callback(subreq
, tldap_search_paged_done
, req
);
723 static void tldap_search_paged_done(struct tevent_req
*subreq
)
725 struct tevent_req
*req
= tevent_req_callback_data(
726 subreq
, struct tevent_req
);
727 struct tldap_search_paged_state
*state
= tevent_req_data(
728 req
, struct tldap_search_paged_state
);
729 struct asn1_data
*asn1
;
730 struct tldap_control
*pgctrl
;
733 rc
= tldap_search_recv(subreq
, state
, &state
->result
);
734 if (rc
!= TLDAP_SUCCESS
) {
736 tevent_req_error(req
, rc
);
740 TALLOC_FREE(state
->asn1
);
742 switch (tldap_msg_type(state
->result
)) {
743 case TLDAP_RES_SEARCH_ENTRY
:
744 case TLDAP_RES_SEARCH_REFERENCE
:
745 tevent_req_notify_callback(req
);
747 case TLDAP_RES_SEARCH_RESULT
:
751 tevent_req_error(req
, TLDAP_PROTOCOL_ERROR
);
757 /* We've finished one paged search, fire the next */
759 pgctrl
= tldap_msg_findcontrol(state
->result
,
760 TLDAP_CONTROL_PAGEDRESULTS
);
761 if (pgctrl
== NULL
) {
762 /* RFC2696 requires the server to return the control */
763 tevent_req_error(req
, TLDAP_PROTOCOL_ERROR
);
767 TALLOC_FREE(state
->cookie
.data
);
769 asn1
= asn1_init(talloc_tos());
771 tevent_req_error(req
, TLDAP_NO_MEMORY
);
775 asn1_load_nocopy(asn1
, pgctrl
->value
.data
, pgctrl
->value
.length
);
776 asn1_start_tag(asn1
, ASN1_SEQUENCE(0));
777 asn1_read_Integer(asn1
, &size
);
778 asn1_read_OctetString(asn1
, state
, &state
->cookie
);
780 if (asn1
->has_error
) {
781 tevent_req_error(req
, TLDAP_DECODING_ERROR
);
786 if (state
->cookie
.length
== 0) {
787 /* We're done, no cookie anymore */
788 tevent_req_done(req
);
792 TALLOC_FREE(state
->result
);
794 subreq
= tldap_ship_paged_search(state
, state
);
795 if (tevent_req_nomem(subreq
, req
)) {
798 tevent_req_set_callback(subreq
, tldap_search_paged_done
, req
);
801 int tldap_search_paged_recv(struct tevent_req
*req
, TALLOC_CTX
*mem_ctx
,
802 struct tldap_message
**pmsg
)
804 struct tldap_search_paged_state
*state
= tevent_req_data(
805 req
, struct tldap_search_paged_state
);
808 if (!tevent_req_is_in_progress(req
)
809 && tevent_req_is_ldap_error(req
, &err
)) {
812 if (tevent_req_is_in_progress(req
)) {
813 switch (tldap_msg_type(state
->result
)) {
814 case TLDAP_RES_SEARCH_ENTRY
:
815 case TLDAP_RES_SEARCH_REFERENCE
:
818 return TLDAP_PROTOCOL_ERROR
;
821 *pmsg
= talloc_move(mem_ctx
, &state
->result
);
822 return TLDAP_SUCCESS
;