docs: fix type for winbind rpc only parameter
[Samba.git] / source3 / winbindd / wb_lookupsids.c
blobe10d511493860688c6641dc0b5e5145f126b5344
1 /*
2 Unix SMB/CIFS implementation.
3 async lookupsids
4 Copyright (C) Volker Lendecke 2011
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/>.
20 #include "includes.h"
21 #include "winbindd.h"
22 #include "librpc/gen_ndr/ndr_wbint_c.h"
23 #include "../libcli/security/security.h"
24 #include "passdb/machine_sid.h"
26 struct wb_lookupsids_domain {
27 struct dom_sid sid;
28 struct winbindd_domain *domain;
31 * Array of sids to be passed into wbint_LookupSids. Preallocated with
32 * num_sids.
34 struct lsa_SidArray sids;
37 * Indexes into wb_lookupsids_state->sids and thus
38 * wb_lookupsids_state->res_names. Preallocated with num_sids.
40 uint32_t *sid_indexes;
43 struct wb_translated_name {
44 const char *domain_name;
45 const char *name;
46 enum lsa_SidType type;
49 static struct wb_lookupsids_domain *wb_lookupsids_get_domain(
50 const struct dom_sid *sid, TALLOC_CTX *mem_ctx,
51 struct wb_lookupsids_domain **domains, uint32_t num_sids);
53 struct wb_lookupsids_state {
54 struct tevent_context *ev;
57 * SIDs passed in
59 struct dom_sid *sids;
60 uint32_t num_sids;
63 * The domains we're using for bulk lookup via wbint_LookupRids or
64 * wbint_LookupSids. We expect very few domains, so we do a
65 * talloc_realloc and rely on talloc_array_length.
67 struct wb_lookupsids_domain *domains;
68 uint32_t domains_done;
71 * These SIDs are looked up individually via
72 * wbint_LookupSid. Preallocated with num_sids.
74 uint32_t *single_sids;
75 uint32_t num_single_sids;
76 uint32_t single_sids_done;
79 * Intermediate store for wbint_LookupRids to passdb. These are
80 * spliced into res_domains/res_names in wb_lookupsids_move_name.
82 struct wbint_RidArray rids;
83 const char *domain_name;
84 struct wbint_Principals rid_names;
87 * Intermediate results for wbint_LookupSids. These results are
88 * spliced into res_domains/res_names in wb_lookupsids_move_name.
90 struct lsa_RefDomainList tmp_domains;
91 struct lsa_TransNameArray tmp_names;
94 * Results
96 struct lsa_RefDomainList *res_domains;
98 * Indexed as "sids" in this structure
100 struct lsa_TransNameArray *res_names;
103 static bool wb_lookupsids_next(struct tevent_req *req,
104 struct wb_lookupsids_state *state);
105 static void wb_lookupsids_single_done(struct tevent_req *subreq);
106 static void wb_lookupsids_lookuprids_done(struct tevent_req *subreq);
107 static void wb_lookupsids_done(struct tevent_req *subreq);
109 struct tevent_req *wb_lookupsids_send(TALLOC_CTX *mem_ctx,
110 struct tevent_context *ev,
111 struct dom_sid *sids,
112 uint32_t num_sids)
114 struct tevent_req *req;
115 struct wb_lookupsids_state *state;
116 uint32_t i;
118 req = tevent_req_create(mem_ctx, &state, struct wb_lookupsids_state);
119 if (req == NULL) {
120 return NULL;
122 state->ev = ev;
123 state->sids = sids;
124 state->num_sids = num_sids;
126 state->single_sids = talloc_array(state, uint32_t, num_sids);
127 if (tevent_req_nomem(state->single_sids, req)) {
128 return tevent_req_post(req, ev);
131 state->res_domains = talloc_zero(state, struct lsa_RefDomainList);
132 if (tevent_req_nomem(state->res_domains, req)) {
133 return tevent_req_post(req, ev);
135 state->res_domains->domains = talloc_array(
136 state->res_domains, struct lsa_DomainInfo, num_sids);
137 if (tevent_req_nomem(state->res_domains->domains, req)) {
138 return tevent_req_post(req, ev);
141 state->res_names = talloc_zero(state, struct lsa_TransNameArray);
142 if (tevent_req_nomem(state->res_names, req)) {
143 return tevent_req_post(req, ev);
145 state->res_names->names = talloc_array(
146 state->res_names, struct lsa_TranslatedName, num_sids);
147 if (tevent_req_nomem(state->res_names->names, req)) {
148 return tevent_req_post(req, ev);
151 if (num_sids == 0) {
152 tevent_req_done(req);
153 return tevent_req_post(req, ev);
156 for (i=0; i<num_sids; i++) {
157 struct wb_lookupsids_domain *d;
159 d = wb_lookupsids_get_domain(&sids[i], state, &state->domains,
160 num_sids);
161 if (d != NULL) {
162 d->sids.sids[d->sids.num_sids].sid = &sids[i];
163 d->sid_indexes[d->sids.num_sids] = i;
164 d->sids.num_sids += 1;
165 } else {
166 state->single_sids[state->num_single_sids] = i;
167 state->num_single_sids += 1;
171 if (!wb_lookupsids_next(req, state)) {
172 return tevent_req_post(req, ev);
174 return req;
177 static bool wb_lookupsids_next(struct tevent_req *req,
178 struct wb_lookupsids_state *state)
180 struct tevent_req *subreq;
182 if (state->domains_done < talloc_array_length(state->domains)) {
183 struct wb_lookupsids_domain *d;
184 uint32_t i;
186 d = &state->domains[state->domains_done];
188 if (sid_check_is_our_sam(&d->sid)) {
189 state->rids.num_rids = d->sids.num_sids;
190 state->rids.rids = talloc_array(state, uint32_t,
191 state->rids.num_rids);
192 if (tevent_req_nomem(state->rids.rids, req)) {
193 return false;
195 for (i=0; i<state->rids.num_rids; i++) {
196 sid_peek_rid(d->sids.sids[i].sid,
197 &state->rids.rids[i]);
199 subreq = dcerpc_wbint_LookupRids_send(
200 state, state->ev, dom_child_handle(d->domain),
201 &d->sid, &state->rids, &state->domain_name,
202 &state->rid_names);
203 if (tevent_req_nomem(subreq, req)) {
204 return false;
206 tevent_req_set_callback(
207 subreq, wb_lookupsids_lookuprids_done, req);
208 return true;
211 subreq = dcerpc_wbint_LookupSids_send(
212 state, state->ev, dom_child_handle(d->domain),
213 &d->sids, &state->tmp_domains, &state->tmp_names);
214 if (tevent_req_nomem(subreq, req)) {
215 return false;
217 tevent_req_set_callback(subreq, wb_lookupsids_done, req);
218 return true;
221 if (state->single_sids_done < state->num_single_sids) {
222 uint32_t sid_idx;
223 const struct dom_sid *sid;
225 sid_idx = state->single_sids[state->single_sids_done];
226 sid = &state->sids[sid_idx];
228 subreq = wb_lookupsid_send(state, state->ev, sid);
229 if (tevent_req_nomem(subreq, req)) {
230 return false;
232 tevent_req_set_callback(subreq, wb_lookupsids_single_done,
233 req);
234 return true;
237 tevent_req_done(req);
238 return false;
242 * Decide whether to do bulk lookupsids. We have optimizations for
243 * passdb via lookuprids and to remote DCs via lookupsids.
246 static bool wb_lookupsids_bulk(const struct dom_sid *sid)
248 if (sid->num_auths != 5) {
250 * Only do "S-1-5-21-x-y-z-rid" domains via bulk
251 * lookup
253 DEBUG(10, ("No bulk setup for SID %s with %d subauths\n",
254 sid_string_dbg(sid), sid->num_auths));
255 return false;
258 if (sid_check_is_in_our_sam(sid)) {
260 * Passdb lookup via lookuprids
262 DEBUG(10, ("%s is in our domain\n", sid_string_tos(sid)));
263 return true;
266 if ((lp_server_role() == ROLE_DOMAIN_PDC) ||
267 (lp_server_role() == ROLE_DOMAIN_BDC)) {
269 * Bulk lookups to trusted DCs
271 return (find_domain_from_sid_noinit(sid) != NULL);
274 if (lp_server_role() != ROLE_DOMAIN_MEMBER) {
276 * Don't do bulk lookups as standalone, the only bulk
277 * lookup left is for domain members.
279 return false;
282 if (sid_check_is_in_unix_groups(sid) ||
283 sid_check_is_unix_groups(sid) ||
284 sid_check_is_in_unix_users(sid) ||
285 sid_check_is_unix_users(sid) ||
286 sid_check_is_in_builtin(sid) ||
287 sid_check_is_builtin(sid)) {
289 * These are locally done piece by piece anyway, no
290 * need for bulk optimizations.
292 return false;
296 * All other SIDs are sent to the DC we're connected to as
297 * member via a single lsa_lookupsids call.
299 return true;
302 static struct wb_lookupsids_domain *wb_lookupsids_get_domain(
303 const struct dom_sid *sid, TALLOC_CTX *mem_ctx,
304 struct wb_lookupsids_domain **pdomains, uint32_t num_sids)
306 struct wb_lookupsids_domain *domains, *domain;
307 struct winbindd_domain *wb_domain;
308 uint32_t i, num_domains;
310 if (!wb_lookupsids_bulk(sid)) {
311 return NULL;
314 domains = *pdomains;
315 num_domains = talloc_array_length(domains);
317 for (i=0; i<num_domains; i++) {
318 if (dom_sid_compare_domain(sid, &domains[i].sid) == 0) {
319 return &domains[i];
323 wb_domain = find_domain_from_sid_noinit(sid);
324 if (wb_domain == NULL) {
325 return NULL;
328 domains = talloc_realloc(
329 mem_ctx, domains, struct wb_lookupsids_domain, num_domains+1);
330 if (domains == NULL) {
331 return NULL;
333 *pdomains = domains;
335 domain = &domains[num_domains];
336 sid_copy(&domain->sid, sid);
337 sid_split_rid(&domain->sid, NULL);
338 domain->domain = wb_domain;
340 domain->sids.sids = talloc_array(domains, struct lsa_SidPtr, num_sids);
341 if (domains->sids.sids == NULL) {
342 goto fail;
344 domain->sids.num_sids = 0;
346 domain->sid_indexes = talloc_array(domains, uint32_t, num_sids);
347 if (domain->sid_indexes == NULL) {
348 TALLOC_FREE(domain->sids.sids);
349 goto fail;
351 return domain;
353 fail:
355 * Realloc to the state it was in before
357 *pdomains = talloc_realloc(
358 mem_ctx, domains, struct wb_lookupsids_domain, num_domains);
359 return NULL;
362 static bool wb_lookupsids_find_dom_idx(struct lsa_DomainInfo *domain,
363 struct lsa_RefDomainList *list,
364 uint32_t *idx)
366 uint32_t i;
367 struct lsa_DomainInfo *new_domain;
369 for (i=0; i<list->count; i++) {
370 if (dom_sid_equal(domain->sid, list->domains[i].sid)) {
371 *idx = i;
372 return true;
376 new_domain = &list->domains[list->count];
378 new_domain->name.string = talloc_strdup(
379 list->domains, domain->name.string);
380 if (new_domain->name.string == NULL) {
381 return false;
384 new_domain->sid = dom_sid_dup(list->domains, domain->sid);
385 if (new_domain->sid == NULL) {
386 return false;
389 *idx = list->count;
390 list->count += 1;
391 return true;
394 static bool wb_lookupsids_move_name(struct lsa_RefDomainList *src_domains,
395 struct lsa_TranslatedName *src_name,
396 struct lsa_RefDomainList *dst_domains,
397 struct lsa_TransNameArray *dst_names,
398 uint32_t dst_name_index)
400 struct lsa_TranslatedName *dst_name;
401 struct lsa_DomainInfo *src_domain;
402 uint32_t src_domain_index, dst_domain_index;
404 src_domain_index = src_name->sid_index;
405 if (src_domain_index >= src_domains->count) {
406 return false;
408 src_domain = &src_domains->domains[src_domain_index];
410 if (!wb_lookupsids_find_dom_idx(
411 src_domain, dst_domains, &dst_domain_index)) {
412 return false;
415 dst_name = &dst_names->names[dst_name_index];
417 dst_name->sid_type = src_name->sid_type;
418 dst_name->name.string = talloc_move(dst_names->names,
419 &src_name->name.string);
420 dst_name->sid_index = dst_domain_index;
421 dst_names->count += 1;
423 return true;
426 static void wb_lookupsids_done(struct tevent_req *subreq)
428 struct tevent_req *req = tevent_req_callback_data(
429 subreq, struct tevent_req);
430 struct wb_lookupsids_state *state = tevent_req_data(
431 req, struct wb_lookupsids_state);
432 struct wb_lookupsids_domain *d;
433 uint32_t i;
434 bool fallback = false;
436 NTSTATUS status, result;
438 status = dcerpc_wbint_LookupSids_recv(subreq, state, &result);
439 TALLOC_FREE(subreq);
440 if (tevent_req_nterror(req, status)) {
441 return;
444 d = &state->domains[state->domains_done];
446 if (NT_STATUS_IS_ERR(result)) {
447 fallback = true;
448 } else if (state->tmp_names.count != d->sids.num_sids) {
449 fallback = true;
452 if (fallback) {
453 for (i=0; i < d->sids.num_sids; i++) {
454 uint32_t res_sid_index = d->sid_indexes[i];
456 state->single_sids[state->num_single_sids] =
457 res_sid_index;
458 state->num_single_sids += 1;
460 state->domains_done += 1;
461 wb_lookupsids_next(req, state);
462 return;
466 * Look at the individual states in the translated names.
469 for (i=0; i<state->tmp_names.count; i++) {
471 uint32_t res_sid_index = d->sid_indexes[i];
473 if (state->tmp_names.names[i].sid_type == SID_NAME_UNKNOWN) {
475 * Make unknown SIDs go through
476 * wb_lookupsid. This retries the forest root.
478 state->single_sids[state->num_single_sids] =
479 res_sid_index;
480 state->num_single_sids += 1;
481 continue;
483 if (!wb_lookupsids_move_name(
484 &state->tmp_domains, &state->tmp_names.names[i],
485 state->res_domains, state->res_names,
486 res_sid_index)) {
487 tevent_req_oom(req);
488 return;
491 state->domains_done += 1;
492 wb_lookupsids_next(req, state);
495 static void wb_lookupsids_single_done(struct tevent_req *subreq)
497 struct tevent_req *req = tevent_req_callback_data(
498 subreq, struct tevent_req);
499 struct wb_lookupsids_state *state = tevent_req_data(
500 req, struct wb_lookupsids_state);
501 const char *domain_name, *name;
502 enum lsa_SidType type;
503 uint32_t res_sid_index;
504 uint32_t src_rid;
506 struct dom_sid src_domain_sid;
507 struct lsa_DomainInfo src_domain;
508 struct lsa_RefDomainList src_domains;
509 struct lsa_TranslatedName src_name;
511 NTSTATUS status;
513 status = wb_lookupsid_recv(subreq, talloc_tos(), &type,
514 &domain_name, &name);
515 TALLOC_FREE(subreq);
516 if (!NT_STATUS_IS_OK(status)) {
517 type = SID_NAME_UNKNOWN;
519 domain_name = talloc_strdup(talloc_tos(), "");
520 if (tevent_req_nomem(domain_name, req)) {
521 return;
523 name = talloc_strdup(talloc_tos(), "");
524 if (tevent_req_nomem(name, req)) {
525 return;
530 * Fake up structs for wb_lookupsids_move_name
532 res_sid_index = state->single_sids[state->single_sids_done];
534 sid_copy(&src_domain_sid, &state->sids[res_sid_index]);
535 sid_split_rid(&src_domain_sid, &src_rid);
536 src_domain.name.string = domain_name;
537 src_domain.sid = &src_domain_sid;
539 src_domains.count = 1;
540 src_domains.domains = &src_domain;
542 src_name.sid_type = type;
543 src_name.name.string = name;
544 src_name.sid_index = 0;
546 if (!wb_lookupsids_move_name(
547 &src_domains, &src_name,
548 state->res_domains, state->res_names,
549 res_sid_index)) {
550 tevent_req_oom(req);
551 return;
553 state->single_sids_done += 1;
554 wb_lookupsids_next(req, state);
557 static void wb_lookupsids_lookuprids_done(struct tevent_req *subreq)
559 struct tevent_req *req = tevent_req_callback_data(
560 subreq, struct tevent_req);
561 struct wb_lookupsids_state *state = tevent_req_data(
562 req, struct wb_lookupsids_state);
563 struct dom_sid src_domain_sid;
564 struct lsa_DomainInfo src_domain;
565 struct lsa_RefDomainList src_domains;
566 NTSTATUS status, result;
567 struct wb_lookupsids_domain *d;
568 uint32_t i;
569 bool fallback = false;
571 status = dcerpc_wbint_LookupRids_recv(subreq, state, &result);
572 TALLOC_FREE(subreq);
573 if (tevent_req_nterror(req, status)) {
574 return;
577 d = &state->domains[state->domains_done];
579 if (NT_STATUS_IS_ERR(result)) {
580 fallback = true;
581 } else if (state->rid_names.num_principals != d->sids.num_sids) {
582 fallback = true;
585 if (fallback) {
586 for (i=0; i < d->sids.num_sids; i++) {
587 uint32_t res_sid_index = d->sid_indexes[i];
589 state->single_sids[state->num_single_sids] =
590 res_sid_index;
591 state->num_single_sids += 1;
593 state->domains_done += 1;
594 wb_lookupsids_next(req, state);
595 return;
599 * Look at the individual states in the translated names.
602 sid_copy(&src_domain_sid, get_global_sam_sid());
603 src_domain.name.string = get_global_sam_name();
604 src_domain.sid = &src_domain_sid;
605 src_domains.count = 1;
606 src_domains.domains = &src_domain;
608 for (i=0; i<state->rid_names.num_principals; i++) {
609 struct lsa_TranslatedName src_name;
610 uint32_t res_sid_index;
613 * Fake up structs for wb_lookupsids_move_name
615 res_sid_index = d->sid_indexes[i];
617 src_name.sid_type = state->rid_names.principals[i].type;
618 src_name.name.string = state->rid_names.principals[i].name;
619 src_name.sid_index = 0;
621 if (!wb_lookupsids_move_name(
622 &src_domains, &src_name,
623 state->res_domains, state->res_names,
624 res_sid_index)) {
625 tevent_req_oom(req);
626 return;
630 state->domains_done += 1;
631 wb_lookupsids_next(req, state);
634 NTSTATUS wb_lookupsids_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
635 struct lsa_RefDomainList **domains,
636 struct lsa_TransNameArray **names)
638 struct wb_lookupsids_state *state = tevent_req_data(
639 req, struct wb_lookupsids_state);
640 NTSTATUS status;
642 if (tevent_req_is_nterror(req, &status)) {
643 return status;
647 * The returned names need to match the given sids,
648 * if not we have a bug in the code!
651 if (state->res_names->count != state->num_sids) {
652 DEBUG(0, ("res_names->count = %d, expected %d\n",
653 state->res_names->count, state->num_sids));
654 return NT_STATUS_INTERNAL_ERROR;
658 * Not strictly needed, but it might make debugging in the callers
659 * easier in future, if the talloc_array_length() returns the
660 * expected result...
662 state->res_domains->domains = talloc_realloc(state->res_domains,
663 state->res_domains->domains,
664 struct lsa_DomainInfo,
665 state->res_domains->count);
667 *domains = talloc_move(mem_ctx, &state->res_domains);
668 *names = talloc_move(mem_ctx, &state->res_names);
669 return NT_STATUS_OK;