2 ldb database library - command line handling for ldb tools
4 Copyright (C) Andrew Tridgell 2005
6 ** NOTE! The following LGPL license applies to the ldb
7 ** library. This does NOT imply that all of Samba is released
10 This library is free software; you can redistribute it and/or
11 modify it under the terms of the GNU Lesser General Public
12 License as published by the Free Software Foundation; either
13 version 3 of the License, or (at your option) any later version.
15 This library is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public
21 License along with this library; if not, see <http://www.gnu.org/licenses/>.
24 #include "ldb_includes.h"
26 #include "tools/cmdline.h"
28 #if (_SAMBA_BUILD_ >= 4)
30 #include "lib/cmdline/popt_common.h"
31 #include "lib/ldb-samba/ldif_handlers.h"
32 #include "auth/gensec/gensec.h"
33 #include "auth/auth.h"
35 #include "param/param.h"
36 #include "librpc/gen_ndr/drsblobs.h"
37 #include "dsdb/schema/schema.h"
38 #include "dsdb/common/proto.h"
41 static struct ldb_cmdline options
; /* needs to be static for older compilers */
43 static struct poptOption popt_options
[] = {
45 { "url", 'H', POPT_ARG_STRING
, &options
.url
, 0, "database URL", "URL" },
46 { "basedn", 'b', POPT_ARG_STRING
, &options
.basedn
, 0, "base DN", "DN" },
47 { "editor", 'e', POPT_ARG_STRING
, &options
.editor
, 0, "external editor", "PROGRAM" },
48 { "scope", 's', POPT_ARG_STRING
, NULL
, 's', "search scope", "SCOPE" },
49 { "verbose", 'v', POPT_ARG_NONE
, NULL
, 'v', "increase verbosity", NULL
},
50 { "trace", 0, POPT_ARG_NONE
, &options
.tracing
, 0, "enable tracing", NULL
},
51 { "interactive", 'i', POPT_ARG_NONE
, &options
.interactive
, 0, "input from stdin", NULL
},
52 { "recursive", 'r', POPT_ARG_NONE
, &options
.recursive
, 0, "recursive delete", NULL
},
53 { "modules-path", 0, POPT_ARG_STRING
, &options
.modules_path
, 0, "modules path", "PATH" },
54 { "num-searches", 0, POPT_ARG_INT
, &options
.num_searches
, 0, "number of test searches", NULL
},
55 { "num-records", 0, POPT_ARG_INT
, &options
.num_records
, 0, "number of test records", NULL
},
56 { "all", 'a', POPT_ARG_NONE
, &options
.all_records
, 0, "(|(objectClass=*)(distinguishedName=*))", NULL
},
57 { "nosync", 0, POPT_ARG_NONE
, &options
.nosync
, 0, "non-synchronous transactions", NULL
},
58 { "sorted", 'S', POPT_ARG_NONE
, &options
.sorted
, 0, "sort attributes", NULL
},
59 { "input", 'I', POPT_ARG_STRING
, &options
.input
, 0, "Input File", "Input" },
60 { "output", 'O', POPT_ARG_STRING
, &options
.output
, 0, "Output File", "Output" },
61 { NULL
, 'o', POPT_ARG_STRING
, NULL
, 'o', "ldb_connect option", "OPTION" },
62 { "controls", 0, POPT_ARG_STRING
, NULL
, 'c', "controls", NULL
},
63 { "show-binary", 0, POPT_ARG_NONE
, &options
.show_binary
, 0, "display binary LDIF", NULL
},
64 { "paged", 0, POPT_ARG_NONE
, NULL
, 'P', "use a paged search", NULL
},
65 { "show-deleted", 0, POPT_ARG_NONE
, NULL
, 'D', "show deleted objects", NULL
},
66 { "show-recycled", 0, POPT_ARG_NONE
, NULL
, 'R', "show recycled objects", NULL
},
67 { "show-deactivated-link", 0, POPT_ARG_NONE
, NULL
, 'd', "show deactivated links", NULL
},
68 { "reveal", 0, POPT_ARG_NONE
, NULL
, 'r', "reveal ldb internals", NULL
},
69 { "cross-ncs", 0, POPT_ARG_NONE
, NULL
, 'N', "search across NC boundaries", NULL
},
70 { "extended-dn", 0, POPT_ARG_NONE
, NULL
, 'E', "show extended DNs", NULL
},
71 #if (_SAMBA_BUILD_ >= 4)
73 POPT_COMMON_CREDENTIALS
74 POPT_COMMON_CONNECTION
80 void ldb_cmdline_help(const char *cmdname
, FILE *f
)
83 pc
= poptGetContext(cmdname
, 0, NULL
, popt_options
,
84 POPT_CONTEXT_KEEP_FIRST
);
85 poptPrintHelp(pc
, f
, 0);
89 add a control to the options structure
91 static bool add_control(TALLOC_CTX
*mem_ctx
, const char *control
)
95 /* count how many controls we already have */
96 for (i
=0; options
.controls
&& options
.controls
[i
]; i
++) ;
98 options
.controls
= talloc_realloc(mem_ctx
, options
.controls
, const char *, i
+ 2);
99 if (options
.controls
== NULL
) {
102 options
.controls
[i
] = control
;
103 options
.controls
[i
+1] = NULL
;
108 process command line options
110 struct ldb_cmdline
*ldb_cmdline_process(struct ldb_context
*ldb
,
111 int argc
, const char **argv
,
114 struct ldb_cmdline
*ret
=NULL
;
116 #if (_SAMBA_BUILD_ >= 4)
123 #if (_SAMBA_BUILD_ >= 4)
124 r
= ldb_register_samba_handlers(ldb
);
131 /* make the ldb utilities line buffered */
134 ret
= talloc_zero(ldb
, struct ldb_cmdline
);
136 fprintf(stderr
, "Out of memory!\n");
143 options
.url
= getenv("LDB_URL");
145 /* and editor (used by ldbedit) */
146 options
.editor
= getenv("VISUAL");
147 if (!options
.editor
) {
148 options
.editor
= getenv("EDITOR");
150 if (!options
.editor
) {
151 options
.editor
= "vi";
154 options
.scope
= LDB_SCOPE_DEFAULT
;
156 pc
= poptGetContext(argv
[0], argc
, argv
, popt_options
,
157 POPT_CONTEXT_KEEP_FIRST
);
159 while((opt
= poptGetNextOpt(pc
)) != -1) {
162 const char *arg
= poptGetOptArg(pc
);
163 if (strcmp(arg
, "base") == 0) {
164 options
.scope
= LDB_SCOPE_BASE
;
165 } else if (strcmp(arg
, "sub") == 0) {
166 options
.scope
= LDB_SCOPE_SUBTREE
;
167 } else if (strcmp(arg
, "one") == 0) {
168 options
.scope
= LDB_SCOPE_ONELEVEL
;
170 fprintf(stderr
, "Invalid scope '%s'\n", arg
);
181 options
.options
= talloc_realloc(ret
, options
.options
,
182 const char *, num_options
+3);
183 if (options
.options
== NULL
) {
184 fprintf(stderr
, "Out of memory!\n");
187 options
.options
[num_options
] = poptGetOptArg(pc
);
188 options
.options
[num_options
+1] = NULL
;
193 const char *cs
= poptGetOptArg(pc
);
196 for (p
= cs
; p
!= NULL
; ) {
201 c
= talloc_strdup(options
.controls
, p
);
204 c
= talloc_strndup(options
.controls
, p
, t
-p
);
207 if (c
== NULL
|| !add_control(ret
, c
)) {
208 fprintf(stderr
, __location__
": out of memory\n");
216 if (!add_control(ret
, "paged_results:1:1024")) {
217 fprintf(stderr
, __location__
": out of memory\n");
222 if (!add_control(ret
, "show_deleted:1")) {
223 fprintf(stderr
, __location__
": out of memory\n");
228 if (!add_control(ret
, "show_recycled:0")) {
229 fprintf(stderr
, __location__
": out of memory\n");
234 if (!add_control(ret
, "show_deactivated_link:0")) {
235 fprintf(stderr
, __location__
": out of memory\n");
240 if (!add_control(ret
, "reveal_internals:0")) {
241 fprintf(stderr
, __location__
": out of memory\n");
246 if (!add_control(ret
, "search_options:1:2")) {
247 fprintf(stderr
, __location__
": out of memory\n");
252 if (!add_control(ret
, "extended_dn:1:1")) {
253 fprintf(stderr
, __location__
": out of memory\n");
258 fprintf(stderr
, "Invalid option %s: %s\n",
259 poptBadOption(pc
, 0), poptStrerror(opt
));
265 /* setup the remaining options for the main program to use */
266 options
.argv
= poptGetArgs(pc
);
269 while (options
.argv
[options
.argc
]) options
.argc
++;
274 /* all utils need some option */
275 if (ret
->url
== NULL
) {
276 fprintf(stderr
, "You must supply a url with -H or with $LDB_URL\n");
281 if (strcmp(ret
->url
, "NONE") == 0) {
285 if (options
.nosync
) {
286 flags
|= LDB_FLG_NOSYNC
;
289 if (options
.show_binary
) {
290 flags
|= LDB_FLG_SHOW_BINARY
;
293 if (options
.tracing
) {
294 flags
|= LDB_FLG_ENABLE_TRACING
;
297 #if (_SAMBA_BUILD_ >= 4)
298 /* Must be after we have processed command line options */
299 gensec_init(cmdline_lp_ctx
);
301 if (ldb_set_opaque(ldb
, "sessionInfo", system_session(cmdline_lp_ctx
))) {
304 if (ldb_set_opaque(ldb
, "credentials", cmdline_credentials
)) {
307 if (ldb_set_opaque(ldb
, "loadparm", cmdline_lp_ctx
)) {
311 ldb_set_utf8_fns(ldb
, NULL
, wrap_casefold
);
314 if (options
.modules_path
!= NULL
) {
315 ldb_set_modules_dir(ldb
, options
.modules_path
);
316 } else if (getenv("LDB_MODULES_PATH") != NULL
) {
317 ldb_set_modules_dir(ldb
, getenv("LDB_MODULES_PATH"));
320 /* now connect to the ldb */
321 if (ldb_connect(ldb
, ret
->url
, flags
, ret
->options
) != 0) {
322 fprintf(stderr
, "Failed to connect to %s - %s\n",
323 ret
->url
, ldb_errstring(ldb
));
327 #if (_SAMBA_BUILD_ >= 4)
328 /* get the domain SID into the cache for SDDL processing */
329 samdb_domain_sid(ldb
);
340 /* this function check controls reply and determines if more
341 * processing is needed setting up the request controls correctly
346 * 1 all ok, more processing required
348 int handle_controls_reply(struct ldb_control
**reply
, struct ldb_control
**request
)
353 if (reply
== NULL
|| request
== NULL
) return -1;
355 for (i
= 0; reply
[i
]; i
++) {
356 if (strcmp(LDB_CONTROL_VLV_RESP_OID
, reply
[i
]->oid
) == 0) {
357 struct ldb_vlv_resp_control
*rep_control
;
359 rep_control
= talloc_get_type(reply
[i
]->data
, struct ldb_vlv_resp_control
);
361 /* check we have a matching control in the request */
362 for (j
= 0; request
[j
]; j
++) {
363 if (strcmp(LDB_CONTROL_VLV_REQ_OID
, request
[j
]->oid
) == 0)
367 fprintf(stderr
, "Warning VLV reply received but no request have been made\n");
371 /* check the result */
372 if (rep_control
->vlv_result
!= 0) {
373 fprintf(stderr
, "Warning: VLV not performed with error: %d\n", rep_control
->vlv_result
);
375 fprintf(stderr
, "VLV Info: target position = %d, content count = %d\n", rep_control
->targetPosition
, rep_control
->contentCount
);
381 if (strcmp(LDB_CONTROL_ASQ_OID
, reply
[i
]->oid
) == 0) {
382 struct ldb_asq_control
*rep_control
;
384 rep_control
= talloc_get_type(reply
[i
]->data
, struct ldb_asq_control
);
386 /* check the result */
387 if (rep_control
->result
!= 0) {
388 fprintf(stderr
, "Warning: ASQ not performed with error: %d\n", rep_control
->result
);
394 if (strcmp(LDB_CONTROL_PAGED_RESULTS_OID
, reply
[i
]->oid
) == 0) {
395 struct ldb_paged_control
*rep_control
, *req_control
;
397 rep_control
= talloc_get_type(reply
[i
]->data
, struct ldb_paged_control
);
398 if (rep_control
->cookie_len
== 0) /* we are done */
401 /* more processing required */
402 /* let's fill in the request control with the new cookie */
404 for (j
= 0; request
[j
]; j
++) {
405 if (strcmp(LDB_CONTROL_PAGED_RESULTS_OID
, request
[j
]->oid
) == 0)
408 /* if there's a reply control we must find a request
409 * control matching it */
410 if (! request
[j
]) return -1;
412 req_control
= talloc_get_type(request
[j
]->data
, struct ldb_paged_control
);
414 if (req_control
->cookie
)
415 talloc_free(req_control
->cookie
);
416 req_control
->cookie
= (char *)talloc_memdup(
417 req_control
, rep_control
->cookie
,
418 rep_control
->cookie_len
);
419 req_control
->cookie_len
= rep_control
->cookie_len
;
426 if (strcmp(LDB_CONTROL_SORT_RESP_OID
, reply
[i
]->oid
) == 0) {
427 struct ldb_sort_resp_control
*rep_control
;
429 rep_control
= talloc_get_type(reply
[i
]->data
, struct ldb_sort_resp_control
);
431 /* check we have a matching control in the request */
432 for (j
= 0; request
[j
]; j
++) {
433 if (strcmp(LDB_CONTROL_SERVER_SORT_OID
, request
[j
]->oid
) == 0)
437 fprintf(stderr
, "Warning Server Sort reply received but no request found\n");
441 /* check the result */
442 if (rep_control
->result
!= 0) {
443 fprintf(stderr
, "Warning: Sorting not performed with error: %d\n", rep_control
->result
);
449 if (strcmp(LDB_CONTROL_DIRSYNC_OID
, reply
[i
]->oid
) == 0) {
450 struct ldb_dirsync_control
*rep_control
, *req_control
;
453 rep_control
= talloc_get_type(reply
[i
]->data
, struct ldb_dirsync_control
);
454 if (rep_control
->cookie_len
== 0) /* we are done */
457 /* more processing required */
458 /* let's fill in the request control with the new cookie */
460 for (j
= 0; request
[j
]; j
++) {
461 if (strcmp(LDB_CONTROL_DIRSYNC_OID
, request
[j
]->oid
) == 0)
464 /* if there's a reply control we must find a request
465 * control matching it */
466 if (! request
[j
]) return -1;
468 req_control
= talloc_get_type(request
[j
]->data
, struct ldb_dirsync_control
);
470 if (req_control
->cookie
)
471 talloc_free(req_control
->cookie
);
472 req_control
->cookie
= (char *)talloc_memdup(
473 req_control
, rep_control
->cookie
,
474 rep_control
->cookie_len
);
475 req_control
->cookie_len
= rep_control
->cookie_len
;
477 cookie
= ldb_base64_encode(req_control
, rep_control
->cookie
, rep_control
->cookie_len
);
478 printf("# DIRSYNC cookie returned was:\n# %s\n", cookie
);
483 /* no controls matched, throw a warning */
484 fprintf(stderr
, "Unknown reply control oid: %s\n", reply
[i
]->oid
);