2 Unix SMB/CIFS implementation.
4 Copyright (C) Rafal Szczesniak 2007
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 "libnet/libnet.h"
23 #include "libcli/composite/composite.h"
24 #include "librpc/gen_ndr/lsa.h"
25 #include "librpc/gen_ndr/ndr_lsa_c.h"
26 #include "librpc/gen_ndr/samr.h"
27 #include "librpc/gen_ndr/ndr_samr_c.h"
28 #include "libcli/security/security.h"
31 struct create_group_state {
32 struct libnet_context *ctx;
33 struct libnet_CreateGroup r;
34 struct libnet_DomainOpen domain_open;
35 struct libnet_rpc_groupadd group_add;
37 /* information about the progress */
38 void (*monitor_fn)(struct monitor_msg *);
42 static void continue_domain_opened(struct composite_context *ctx);
43 static void continue_rpc_group_added(struct composite_context *ctx);
46 struct composite_context* libnet_CreateGroup_send(struct libnet_context *ctx,
48 struct libnet_CreateGroup *r,
49 void (*monitor)(struct monitor_msg*))
51 struct composite_context *c;
52 struct create_group_state *s;
53 struct composite_context *create_req;
54 bool prereq_met = false;
56 /* composite context allocation and setup */
57 c = composite_create(mem_ctx, ctx->event_ctx);
58 if (c == NULL) return NULL;
60 s = talloc_zero(c, struct create_group_state);
61 if (composite_nomem(s, c)) return c;
67 ZERO_STRUCT(s->r.out);
69 /* prerequisite: make sure we have a valid samr domain handle */
70 prereq_met = samr_domain_opened(ctx, s->r.in.domain_name, &c, &s->domain_open,
71 continue_domain_opened, monitor);
72 if (!prereq_met) return c;
74 /* prepare arguments of rpc group add call */
75 s->group_add.in.groupname = r->in.group_name;
76 s->group_add.in.domain_handle = ctx->samr.handle;
78 /* send the request */
79 create_req = libnet_rpc_groupadd_send(ctx->samr.pipe, &s->group_add, monitor);
80 if (composite_nomem(create_req, c)) return c;
82 composite_continue(c, create_req, continue_rpc_group_added, c);
87 static void continue_domain_opened(struct composite_context *ctx)
89 struct composite_context *c;
90 struct create_group_state *s;
91 struct composite_context *create_req;
93 c = talloc_get_type(ctx->async.private_data, struct composite_context);
94 s = talloc_get_type(c->private_data, struct create_group_state);
96 c->status = libnet_DomainOpen_recv(ctx, s->ctx, c, &s->domain_open);
97 if (!composite_is_ok(c)) return;
99 /* prepare arguments of groupadd call */
100 s->group_add.in.groupname = s->r.in.group_name;
101 s->group_add.in.domain_handle = s->ctx->samr.handle;
103 /* send the request */
104 create_req = libnet_rpc_groupadd_send(s->ctx->samr.pipe, &s->group_add,
106 if (composite_nomem(create_req, c)) return;
108 composite_continue(c, create_req, continue_rpc_group_added, c);
112 static void continue_rpc_group_added(struct composite_context *ctx)
114 struct composite_context *c;
115 struct create_group_state *s;
117 c = talloc_get_type(ctx->async.private_data, struct composite_context);
118 s = talloc_get_type(c->private_data, struct create_group_state);
120 /* receive result of group add call */
121 c->status = libnet_rpc_groupadd_recv(ctx, c, &s->group_add);
122 if (!composite_is_ok(c)) return;
130 * Receive result of CreateGroup call
132 * @param c composite context returned by send request routine
133 * @param mem_ctx memory context of this call
134 * @param r pointer to a structure containing arguments and result of this call
137 NTSTATUS libnet_CreateGroup_recv(struct composite_context *c,
139 struct libnet_CreateGroup *r)
142 struct create_group_state *s;
144 status = composite_wait(c);
145 if (!NT_STATUS_IS_OK(status)) {
146 s = talloc_get_type(c->private_data, struct create_group_state);
147 r->out.error_string = talloc_strdup(mem_ctx, nt_errstr(status));
155 * Create domain group
157 * @param ctx initialised libnet context
158 * @param mem_ctx memory context of this call
159 * @param io pointer to structure containing arguments and result of this call
162 NTSTATUS libnet_CreateGroup(struct libnet_context *ctx, TALLOC_CTX *mem_ctx,
163 struct libnet_CreateGroup *io)
165 struct composite_context *c;
167 c = libnet_CreateGroup_send(ctx, mem_ctx, io, NULL);
168 return libnet_CreateGroup_recv(c, mem_ctx, io);
172 struct group_info_state {
173 struct libnet_context *ctx;
174 const char *domain_name;
175 const char *group_name;
176 struct libnet_LookupName lookup;
177 struct libnet_DomainOpen domopen;
178 struct libnet_rpc_groupinfo info;
180 /* information about the progress */
181 void (*monitor_fn)(struct monitor_msg *);
185 static void continue_domain_open_info(struct composite_context *ctx);
186 static void continue_name_found(struct composite_context *ctx);
187 static void continue_group_info(struct composite_context *ctx);
190 * Sends request to get group information
192 * @param ctx initialised libnet context
193 * @param mem_ctx memory context of this call
194 * @param io pointer to structure containing arguments the call
195 * @param monitor function pointer for receiving monitor messages
196 * @return composite context of this request
198 struct composite_context* libnet_GroupInfo_send(struct libnet_context *ctx,
200 struct libnet_GroupInfo *io,
201 void (*monitor)(struct monitor_msg*))
203 struct composite_context *c;
204 struct group_info_state *s;
205 bool prereq_met = false;
206 struct composite_context *lookup_req;
208 /* composite context allocation and setup */
209 c = composite_create(mem_ctx, ctx->event_ctx);
210 if (c == NULL) return NULL;
212 s = talloc_zero(c, struct group_info_state);
213 if (composite_nomem(s, c)) return c;
217 /* store arguments in the state structure */
218 s->monitor_fn = monitor;
220 s->domain_name = talloc_strdup(c, io->in.domain_name);
221 s->group_name = talloc_strdup(c, io->in.group_name);
223 /* prerequisite: make sure the domain is opened */
224 prereq_met = samr_domain_opened(ctx, s->domain_name, &c, &s->domopen,
225 continue_domain_open_info, monitor);
226 if (!prereq_met) return c;
228 /* prepare arguments for LookupName call */
229 s->lookup.in.name = s->group_name;
230 s->lookup.in.domain_name = s->domain_name;
232 /* send the request */
233 lookup_req = libnet_LookupName_send(s->ctx, c, &s->lookup, s->monitor_fn);
234 if (composite_nomem(lookup_req, c)) return c;
236 /* set the next stage */
237 composite_continue(c, lookup_req, continue_name_found, c);
243 * Stage 0.5 (optional): receive opened domain and send lookup name request
245 static void continue_domain_open_info(struct composite_context *ctx)
247 struct composite_context *c;
248 struct group_info_state *s;
249 struct composite_context *lookup_req;
251 c = talloc_get_type(ctx->async.private_data, struct composite_context);
252 s = talloc_get_type(c->private_data, struct group_info_state);
254 /* receive domain handle */
255 c->status = libnet_DomainOpen_recv(ctx, s->ctx, c, &s->domopen);
256 if (!composite_is_ok(c)) return;
258 /* prepare arguments for LookupName call */
259 s->lookup.in.name = s->group_name;
260 s->lookup.in.domain_name = s->domain_name;
262 /* send the request */
263 lookup_req = libnet_LookupName_send(s->ctx, c, &s->lookup, s->monitor_fn);
264 if (composite_nomem(lookup_req, c)) return;
266 /* set the next stage */
267 composite_continue(c, lookup_req, continue_name_found, c);
272 * Stage 1: Receive SID found and send request for group info
274 static void continue_name_found(struct composite_context *ctx)
276 struct composite_context *c;
277 struct group_info_state *s;
278 struct composite_context *info_req;
280 c = talloc_get_type(ctx->async.private_data, struct composite_context);
281 s = talloc_get_type(c->private_data, struct group_info_state);
283 /* receive SID assiociated with name found */
284 c->status = libnet_LookupName_recv(ctx, c, &s->lookup);
285 if (!composite_is_ok(c)) return;
287 /* Is is a group SID actually ? */
288 if (s->lookup.out.sid_type != SID_NAME_DOM_GRP &&
289 s->lookup.out.sid_type != SID_NAME_ALIAS) {
290 composite_error(c, NT_STATUS_NO_SUCH_GROUP);
293 /* prepare arguments for groupinfo call */
294 s->info.in.domain_handle = s->ctx->samr.handle;
295 s->info.in.groupname = s->group_name;
296 s->info.in.sid = s->lookup.out.sidstr;
297 /* we're looking for all information available */
298 s->info.in.level = GROUPINFOALL;
300 /* send the request */
301 info_req = libnet_rpc_groupinfo_send(s->ctx->samr.pipe, &s->info, s->monitor_fn);
302 if (composite_nomem(info_req, c)) return;
304 /* set the next stage */
305 composite_continue(c, info_req, continue_group_info, c);
310 * Stage 2: Receive group information
312 static void continue_group_info(struct composite_context *ctx)
314 struct composite_context *c;
315 struct group_info_state *s;
317 c = talloc_get_type(ctx->async.private_data, struct composite_context);
318 s = talloc_get_type(c->private_data, struct group_info_state);
320 /* receive group information */
321 c->status = libnet_rpc_groupinfo_recv(ctx, c, &s->info);
322 if (!composite_is_ok(c)) return;
330 * Receive group information
332 * @param c composite context returned by libnet_GroupInfo_send
333 * @param mem_ctx memory context of this call
334 * @param io pointer to structure receiving results of the call
337 NTSTATUS libnet_GroupInfo_recv(struct composite_context* c, TALLOC_CTX *mem_ctx,
338 struct libnet_GroupInfo *io)
341 struct group_info_state *s;
343 status = composite_wait(c);
344 if (NT_STATUS_IS_OK(status)) {
345 /* put the results into io structure if everything went fine */
346 s = talloc_get_type(c->private_data, struct group_info_state);
348 io->out.group_sid = talloc_steal(mem_ctx, s->lookup.out.sid);
349 io->out.num_members = s->info.out.info.all.num_members;
350 io->out.description = talloc_steal(mem_ctx, s->info.out.info.all.description.string);
352 io->out.error_string = talloc_strdup(mem_ctx, "Success");
355 io->out.error_string = talloc_asprintf(mem_ctx, "Error: %s", nt_errstr(status));
365 * Obtains specified group information
367 * @param ctx initialised libnet context
368 * @param mem_ctx memory context of the call
369 * @param io pointer to a structure containing arguments and results of the call
371 NTSTATUS libnet_GroupInfo(struct libnet_context *ctx, TALLOC_CTX *mem_ctx,
372 struct libnet_GroupInfo *io)
374 struct composite_context *c = libnet_GroupInfo_send(ctx, mem_ctx,
376 return libnet_GroupInfo_recv(c, mem_ctx, io);
380 struct grouplist_state {
381 struct libnet_context *ctx;
382 const char *domain_name;
383 struct lsa_DomainInfo dominfo;
385 uint32_t resume_index;
386 struct grouplist *groups;
389 struct libnet_DomainOpen domain_open;
390 struct lsa_QueryInfoPolicy query_domain;
391 struct samr_EnumDomainGroups group_list;
393 void (*monitor_fn)(struct monitor_msg*);
397 static void continue_lsa_domain_opened(struct composite_context *ctx);
398 static void continue_domain_queried(struct rpc_request *req);
399 static void continue_samr_domain_opened(struct composite_context *ctx);
400 static void continue_domain_queried(struct rpc_request *req);
401 static void continue_groups_enumerated(struct rpc_request *req);
405 * Sends request to list (enumerate) group accounts
407 * @param ctx initialised libnet context
408 * @param mem_ctx memory context of this call
409 * @param io pointer to structure containing arguments and results of this call
410 * @param monitor function pointer for receiving monitor messages
411 * @return compostite context of this request
413 struct composite_context *libnet_GroupList_send(struct libnet_context *ctx,
415 struct libnet_GroupList *io,
416 void (*monitor)(struct monitor_msg*))
418 struct composite_context *c;
419 struct grouplist_state *s;
420 struct rpc_request *query_req;
421 bool prereq_met = false;
423 /* composite context allocation and setup */
424 c = composite_create(mem_ctx, ctx->event_ctx);
425 if (c == NULL) return NULL;
427 s = talloc_zero(c, struct grouplist_state);
428 if (composite_nomem(s, c)) return c;
432 /* store the arguments in the state structure */
434 s->page_size = io->in.page_size;
435 s->resume_index = (uint32_t)io->in.resume_index;
436 s->domain_name = talloc_strdup(c, io->in.domain_name);
437 s->monitor_fn = monitor;
439 /* make sure we have lsa domain handle before doing anything */
440 prereq_met = lsa_domain_opened(ctx, s->domain_name, &c, &s->domain_open,
441 continue_lsa_domain_opened, monitor);
442 if (!prereq_met) return c;
444 /* prepare arguments of QueryDomainInfo call */
445 s->query_domain.in.handle = &ctx->lsa.handle;
446 s->query_domain.in.level = LSA_POLICY_INFO_DOMAIN;
448 /* send the request */
449 query_req = dcerpc_lsa_QueryInfoPolicy_send(ctx->lsa.pipe, c, &s->query_domain);
450 if (composite_nomem(query_req, c)) return c;
452 composite_continue_rpc(c, query_req, continue_domain_queried, c);
458 * Stage 0.5 (optional): receive lsa domain handle and send
459 * request to query domain info
461 static void continue_lsa_domain_opened(struct composite_context *ctx)
463 struct composite_context *c;
464 struct grouplist_state *s;
465 struct rpc_request *query_req;
467 c = talloc_get_type(ctx->async.private_data, struct composite_context);
468 s = talloc_get_type(c->private_data, struct grouplist_state);
470 /* receive lsa domain handle */
471 c->status = libnet_DomainOpen_recv(ctx, s->ctx, c, &s->domain_open);
472 if (!composite_is_ok(c)) return;
474 /* prepare arguments of QueryDomainInfo call */
475 s->query_domain.in.handle = &s->ctx->lsa.handle;
476 s->query_domain.in.level = LSA_POLICY_INFO_DOMAIN;
478 /* send the request */
479 query_req = dcerpc_lsa_QueryInfoPolicy_send(s->ctx->lsa.pipe, c, &s->query_domain);
480 if (composite_nomem(query_req, c)) return;
482 composite_continue_rpc(c, query_req, continue_domain_queried, c);
487 * Stage 1: receive domain info and request to enum groups
488 * provided a valid samr handle is opened
490 static void continue_domain_queried(struct rpc_request *req)
492 struct composite_context *c;
493 struct grouplist_state *s;
494 struct rpc_request *enum_req;
495 bool prereq_met = false;
497 c = talloc_get_type(req->async.private_data, struct composite_context);
498 s = talloc_get_type(c->private_data, struct grouplist_state);
500 /* receive result of rpc request */
501 c->status = dcerpc_ndr_request_recv(req);
502 if (!composite_is_ok(c)) return;
504 /* get the returned domain info */
505 s->dominfo = s->query_domain.out.info->domain;
507 /* make sure we have samr domain handle before continuing */
508 prereq_met = samr_domain_opened(s->ctx, s->domain_name, &c, &s->domain_open,
509 continue_samr_domain_opened, s->monitor_fn);
510 if (!prereq_met) return;
512 /* prepare arguments od EnumDomainGroups call */
513 s->group_list.in.domain_handle = &s->ctx->samr.handle;
514 s->group_list.in.max_size = s->page_size;
515 s->group_list.in.resume_handle = &s->resume_index;
516 s->group_list.out.resume_handle = &s->resume_index;
518 /* send the request */
519 enum_req = dcerpc_samr_EnumDomainGroups_send(s->ctx->samr.pipe, c, &s->group_list);
520 if (composite_nomem(enum_req, c)) return;
522 composite_continue_rpc(c, enum_req, continue_groups_enumerated, c);
527 * Stage 1.5 (optional): receive samr domain handle
528 * and request to enumerate accounts
530 static void continue_samr_domain_opened(struct composite_context *ctx)
532 struct composite_context *c;
533 struct grouplist_state *s;
534 struct rpc_request *enum_req;
536 c = talloc_get_type(ctx->async.private_data, struct composite_context);
537 s = talloc_get_type(c->private_data, struct grouplist_state);
539 /* receive samr domain handle */
540 c->status = libnet_DomainOpen_recv(ctx, s->ctx, c, &s->domain_open);
541 if (!composite_is_ok(c)) return;
543 /* prepare arguments of EnumDomainGroups call */
544 s->group_list.in.domain_handle = &s->ctx->samr.handle;
545 s->group_list.in.max_size = s->page_size;
546 s->group_list.in.resume_handle = &s->resume_index;
547 s->group_list.out.resume_handle = &s->resume_index;
549 /* send the request */
550 enum_req = dcerpc_samr_EnumDomainGroups_send(s->ctx->samr.pipe, c, &s->group_list);
551 if (composite_nomem(enum_req, c)) return;
553 composite_continue_rpc(c, enum_req, continue_groups_enumerated, c);
558 * Stage 2: receive enumerated groups and their rids
560 static void continue_groups_enumerated(struct rpc_request *req)
562 struct composite_context *c;
563 struct grouplist_state *s;
566 c = talloc_get_type(req->async.private_data, struct composite_context);
567 s = talloc_get_type(c->private_data, struct grouplist_state);
569 /* receive result of rpc request */
570 c->status = dcerpc_ndr_request_recv(req);
571 if (!composite_is_ok(c)) return;
573 /* get the actual status of the rpc call result
574 (instead of rpc layer) */
575 c->status = s->group_list.out.result;
577 /* we're interested in status "ok" as well as two
578 enum-specific status codes */
579 if (NT_STATUS_IS_OK(c->status) ||
580 NT_STATUS_EQUAL(c->status, STATUS_MORE_ENTRIES) ||
581 NT_STATUS_EQUAL(c->status, NT_STATUS_NO_MORE_ENTRIES)) {
583 /* get enumerated accounts counter and resume handle (the latter allows
584 making subsequent call to continue enumeration) */
585 s->resume_index = *s->group_list.out.resume_handle;
586 s->count = s->group_list.out.num_entries;
588 /* prepare returned group accounts array */
589 s->groups = talloc_array(c, struct grouplist, s->group_list.out.sam->count);
590 if (composite_nomem(s->groups, c)) return;
592 for (i = 0; i < s->group_list.out.sam->count; i++) {
593 struct dom_sid *group_sid;
594 struct samr_SamEntry *entry = &s->group_list.out.sam->entries[i];
595 struct dom_sid *domain_sid = s->query_domain.out.info->domain.sid;
597 /* construct group sid from returned rid and queried domain sid */
598 group_sid = dom_sid_add_rid(c, domain_sid, entry->idx);
599 if (composite_nomem(group_sid, c)) return;
602 s->groups[i].groupname = talloc_strdup(c, entry->name.string);
603 if (composite_nomem(s->groups[i].groupname, c)) return;
606 s->groups[i].sid = dom_sid_string(c, group_sid);
607 if (composite_nomem(s->groups[i].sid, c)) return;
614 /* something went wrong */
615 composite_error(c, c->status);
621 * Receive result of GroupList call
623 * @param c composite context returned by send request routine
624 * @param mem_ctx memory context of this call
625 * @param io pointer to structure containing arguments and result of this call
628 NTSTATUS libnet_GroupList_recv(struct composite_context *c, TALLOC_CTX *mem_ctx,
629 struct libnet_GroupList *io)
632 struct grouplist_state *s;
634 if (c == NULL || mem_ctx == NULL || io == NULL) {
635 return NT_STATUS_INVALID_PARAMETER;
638 status = composite_wait(c);
639 if (NT_STATUS_IS_OK(status) ||
640 NT_STATUS_EQUAL(status, STATUS_MORE_ENTRIES) ||
641 NT_STATUS_EQUAL(status, NT_STATUS_NO_MORE_ENTRIES)) {
643 s = talloc_get_type(c->private_data, struct grouplist_state);
645 /* get results from composite context */
646 io->out.count = s->count;
647 io->out.resume_index = s->resume_index;
648 io->out.groups = talloc_steal(mem_ctx, s->groups);
650 if (NT_STATUS_IS_OK(status)) {
651 io->out.error_string = talloc_asprintf(mem_ctx, "Success");
653 /* success, but we're not done yet */
654 io->out.error_string = talloc_asprintf(mem_ctx, "Success (status: %s)",
659 io->out.error_string = talloc_asprintf(mem_ctx, "Error: %s", nt_errstr(status));
667 * Enumerate domain groups
669 * @param ctx initialised libnet context
670 * @param mem_ctx memory context of this call
671 * @param io pointer to structure containing arguments and result of this call
674 NTSTATUS libnet_GroupList(struct libnet_context *ctx, TALLOC_CTX *mem_ctx,
675 struct libnet_GroupList *io)
677 struct composite_context *c;
679 c = libnet_GroupList_send(ctx, mem_ctx, io, NULL);
680 return libnet_GroupList_recv(c, mem_ctx, io);