s4-ldb: added a new "reveal" control
[kamenim/samba.git] / source4 / lib / ldb / tools / cmdline.c
index 3bbc87d05f67795b49d19801163b1bf2a7247928..5204215778957049c683906a412261e35f8a5028 100644 (file)
@@ -10,7 +10,7 @@
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
-   version 2 of the License, or (at your option) any later version.
+   version 3 of the License, or (at your option) any later version.
 
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    Lesser General Public License for more details.
 
    You should have received a copy of the GNU Lesser General Public
-   License along with this library; if not, write to the Free Software
-   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+   License along with this library; if not, see <http://www.gnu.org/licenses/>.
 */
 
+#include "ldb_includes.h"
+#include "ldb.h"
+#include "tools/cmdline.h"
+
+#if (_SAMBA_BUILD_ >= 4)
 #include "includes.h"
-#include "ldb/include/ldb.h"
-#include "ldb/include/ldb_private.h"
-#include "ldb/tools/cmdline.h"
-#ifdef _SAMBA_BUILD_
 #include "lib/cmdline/popt_common.h"
-#include "smb_build.h"
+#include "lib/ldb-samba/ldif_handlers.h"
+#include "auth/gensec/gensec.h"
+#include "auth/auth.h"
+#include "ldb_wrap.h"
+#include "param/param.h"
+#endif
+
+static struct ldb_cmdline options; /* needs to be static for older compilers */
+
+static struct poptOption popt_options[] = {
+       POPT_AUTOHELP
+       { "url",       'H', POPT_ARG_STRING, &options.url, 0, "database URL", "URL" },
+       { "basedn",    'b', POPT_ARG_STRING, &options.basedn, 0, "base DN", "DN" },
+       { "editor",    'e', POPT_ARG_STRING, &options.editor, 0, "external editor", "PROGRAM" },
+       { "scope",     's', POPT_ARG_STRING, NULL, 's', "search scope", "SCOPE" },
+       { "verbose",   'v', POPT_ARG_NONE, NULL, 'v', "increase verbosity", NULL },
+       { "trace",     0,   POPT_ARG_NONE, &options.tracing, 0, "enable tracing", NULL },
+       { "interactive", 'i', POPT_ARG_NONE, &options.interactive, 0, "input from stdin", NULL },
+       { "recursive", 'r', POPT_ARG_NONE, &options.recursive, 0, "recursive delete", NULL },
+       { "modules-path", 0, POPT_ARG_STRING, &options.modules_path, 0, "modules path", "PATH" },
+       { "num-searches", 0, POPT_ARG_INT, &options.num_searches, 0, "number of test searches", NULL },
+       { "num-records", 0, POPT_ARG_INT, &options.num_records, 0, "number of test records", NULL },
+       { "all", 'a',    POPT_ARG_NONE, &options.all_records, 0, "(|(objectClass=*)(distinguishedName=*))", NULL },
+       { "nosync", 0,   POPT_ARG_NONE, &options.nosync, 0, "non-synchronous transactions", NULL },
+       { "sorted", 'S', POPT_ARG_NONE, &options.sorted, 0, "sort attributes", NULL },
+       { "input", 'I', POPT_ARG_STRING, &options.input, 0, "Input File", "Input" },
+       { "output", 'O', POPT_ARG_STRING, &options.output, 0, "Output File", "Output" },
+       { NULL,    'o', POPT_ARG_STRING, NULL, 'o', "ldb_connect option", "OPTION" },
+       { "controls", 0, POPT_ARG_STRING, NULL, 'c', "controls", NULL },
+       { "show-binary", 0, POPT_ARG_NONE, &options.show_binary, 0, "display binary LDIF", NULL },
+       { "paged", 0, POPT_ARG_NONE, NULL, 'P', "use a paged search", NULL },
+       { "show-deleted", 0, POPT_ARG_NONE, NULL, 'D', "show deleted objects", NULL },
+       { "show-recycled", 0, POPT_ARG_NONE, NULL, 'R', "show recycled objects", NULL },
+       { "reveal", 0, POPT_ARG_NONE, NULL, 'r', "reveal ldb internals", NULL },
+       { "cross-ncs", 0, POPT_ARG_NONE, NULL, 'N', "search across NC boundaries", NULL },
+       { "extended-dn", 0, POPT_ARG_NONE, NULL, 'E', "show extended DNs", NULL },
+#if (_SAMBA_BUILD_ >= 4)
+       POPT_COMMON_SAMBA
+       POPT_COMMON_CREDENTIALS
+       POPT_COMMON_CONNECTION
+       POPT_COMMON_VERSION
 #endif
+       { NULL }
+};
+
+void ldb_cmdline_help(const char *cmdname, FILE *f)
+{
+       poptContext pc;
+       pc = poptGetContext(cmdname, 0, NULL, popt_options, 
+                           POPT_CONTEXT_KEEP_FIRST);
+       poptPrintHelp(pc, f, 0);
+}
 
 /*
+  add a control to the options structure
+ */
+static bool add_control(TALLOC_CTX *mem_ctx, const char *control)
+{
+       int i;
+
+       /* count how many controls we already have */
+       for (i=0; options.controls && options.controls[i]; i++) ;
+
+       options.controls = talloc_realloc(mem_ctx, options.controls, const char *, i + 2);
+       if (options.controls == NULL) {
+               return false;
+       }
+       options.controls[i] = control;
+       options.controls[i+1] = NULL;
+       return true;
+}
+
+/**
   process command line options
 */
-struct ldb_cmdline *ldb_cmdline_process(struct ldb_context *ldb, int argc, const char **argv,
+struct ldb_cmdline *ldb_cmdline_process(struct ldb_context *ldb, 
+                                       int argc, const char **argv,
                                        void (*usage)(void))
 {
-       struct ldb_cmdline options, *ret=NULL;
+       struct ldb_cmdline *ret=NULL;
        poptContext pc;
-#ifdef _SAMBA_BUILD_
+#if (_SAMBA_BUILD_ >= 4)
        int r;
 #endif
-        int num_options = 0;
+       int num_options = 0;
        int opt;
-       struct poptOption popt_options[] = {
-               POPT_AUTOHELP
-               { "url",       'H', POPT_ARG_STRING, &options.url, 0, "database URL", "URL" },
-               { "basedn",    'b', POPT_ARG_STRING, &options.basedn, 0, "base DN", "DN" },
-               { "editor",    'e', POPT_ARG_STRING, &options.editor, 0, "external editor", "PROGRAM" },
-               { "scope",     's', POPT_ARG_STRING, NULL, 's', "search scope", "SCOPE" },
-               { "verbose",   'v', POPT_ARG_NONE, NULL, 'v', "increase verbosity", NULL },
-               { "interactive", 'i', POPT_ARG_NONE, &options.interactive, 0, "input from stdin", NULL },
-               { "recursive", 'r', POPT_ARG_NONE, &options.recursive, 0, "recursive delete", NULL },
-               { "num-searches", 0, POPT_ARG_INT, &options.num_searches, 0, "number of test searches", NULL },
-               { "num-records", 0, POPT_ARG_INT, &options.num_records, 0, "number of test records", NULL },
-               { "all", 'a',    POPT_ARG_NONE, &options.all_records, 0, "objectClass=*", NULL },
-               { "nosync", 0,   POPT_ARG_NONE, &options.nosync, 0, "non-synchronous transactions", NULL },
-               { "sorted", 'S', POPT_ARG_NONE, &options.sorted, 0, "sort attributes", NULL },
-               { "sasl-mechanism", 0, POPT_ARG_STRING, &options.sasl_mechanism, 0, "choose SASL mechanism", "MECHANISM" },
-               { "input", 'I', POPT_ARG_STRING, &options.input, 0, "Input File", "Input" },
-               { "output", 'O', POPT_ARG_STRING, &options.output, 0, "Output File", "Output" },
-               { NULL,    'o', POPT_ARG_STRING, NULL, 'o', "ldb_connect option", "OPTION" },
-#ifdef _SAMBA_BUILD_
-               POPT_COMMON_SAMBA
-               POPT_COMMON_CREDENTIALS
-               POPT_COMMON_VERSION
-#endif
-               POPT_TABLEEND
-       };
+       int flags = 0;
 
-#ifdef _SAMBA_BUILD_
-       ldbsearch_init_subsystems;
+#if (_SAMBA_BUILD_ >= 4)
        r = ldb_register_samba_handlers(ldb);
        if (r != 0) {
                goto failed;
@@ -79,9 +124,12 @@ struct ldb_cmdline *ldb_cmdline_process(struct ldb_context *ldb, int argc, const
 
 #endif
 
+       /* make the ldb utilities line buffered */
+       setlinebuf(stdout);
+
        ret = talloc_zero(ldb, struct ldb_cmdline);
        if (ret == NULL) {
-               ldb_oom(ldb);
+               fprintf(stderr, "Out of memory!\n");
                goto failed;
        }
 
@@ -129,14 +177,73 @@ struct ldb_cmdline *ldb_cmdline_process(struct ldb_context *ldb, int argc, const
                        options.options = talloc_realloc(ret, options.options, 
                                                         const char *, num_options+3);
                        if (options.options == NULL) {
-                               ldb_oom(ldb);
+                               fprintf(stderr, "Out of memory!\n");
                                goto failed;
                        }
                        options.options[num_options] = poptGetOptArg(pc);
                        options.options[num_options+1] = NULL;
                        num_options++;
                        break;
-                       
+
+               case 'c': {
+                       const char *cs = poptGetOptArg(pc);
+                       const char *p;
+
+                       for (p = cs; p != NULL; ) {
+                               const char *t, *c;
+
+                               t = strchr(p, ',');
+                               if (t == NULL) {
+                                       c = talloc_strdup(options.controls, p);
+                                       p = NULL;
+                               } else {
+                                       c = talloc_strndup(options.controls, p, t-p);
+                                       p = t + 1;
+                               }
+                               if (c == NULL || !add_control(ret, c)) {
+                                       fprintf(stderr, __location__ ": out of memory\n");
+                                       goto failed;
+                               }
+                       }
+
+                       break;    
+               }
+               case 'P':
+                       if (!add_control(ret, "paged_results:1:1024")) {
+                               fprintf(stderr, __location__ ": out of memory\n");
+                               goto failed;
+                       }
+                       break;
+               case 'D':
+                       if (!add_control(ret, "show_deleted:1")) {
+                               fprintf(stderr, __location__ ": out of memory\n");
+                               goto failed;
+                       }
+                       break;
+               case 'R':
+                       if (!add_control(ret, "show_recycled:1")) {
+                               fprintf(stderr, __location__ ": out of memory\n");
+                               goto failed;
+                       }
+                       break;
+               case 'r':
+                       if (!add_control(ret, "reveal_internals:0")) {
+                               fprintf(stderr, __location__ ": out of memory\n");
+                               goto failed;
+                       }
+                       break;
+               case 'N':
+                       if (!add_control(ret, "search_options:1:2")) {
+                               fprintf(stderr, __location__ ": out of memory\n");
+                               goto failed;
+                       }
+                       break;
+               case 'E':
+                       if (!add_control(ret, "extended_dn:1:1")) {
+                               fprintf(stderr, __location__ ": out of memory\n");
+                               goto failed;
+                       }
+                       break;
                default:
                        fprintf(stderr, "Invalid option %s: %s\n", 
                                poptBadOption(pc, 0), poptStrerror(opt));
@@ -161,25 +268,50 @@ struct ldb_cmdline *ldb_cmdline_process(struct ldb_context *ldb, int argc, const
                goto failed;
        }
 
-       if (strcmp(ret->url, "NONE") != 0) {
-               int flags = 0;
-               if (options.nosync) {
-                       flags |= LDB_FLG_NOSYNC;
-               }
+       if (strcmp(ret->url, "NONE") == 0) {
+               return ret;
+       }
 
-#ifdef _SAMBA_BUILD_
-               if (ldb_set_opaque(ldb, "sessionInfo", system_session(ldb))) {
-                       goto failed;
-               }
-               if (ldb_set_opaque(ldb, "credentials", cmdline_credentials)) {
-                       goto failed;
-               }
+       if (options.nosync) {
+               flags |= LDB_FLG_NOSYNC;
+       }
+
+       if (options.show_binary) {
+               flags |= LDB_FLG_SHOW_BINARY;
+       }
+
+       if (options.tracing) {
+               flags |= LDB_FLG_ENABLE_TRACING;
+       }
+
+#if (_SAMBA_BUILD_ >= 4)
+       /* Must be after we have processed command line options */
+       gensec_init(cmdline_lp_ctx); 
+       
+       if (ldb_set_opaque(ldb, "sessionInfo", system_session(cmdline_lp_ctx))) {
+               goto failed;
+       }
+       if (ldb_set_opaque(ldb, "credentials", cmdline_credentials)) {
+               goto failed;
+       }
+       if (ldb_set_opaque(ldb, "loadparm", cmdline_lp_ctx)) {
+               goto failed;
+       }
+
+       ldb_set_utf8_fns(ldb, NULL, wrap_casefold);
 #endif
-               if (ldb_connect(ldb, ret->url, flags, ret->options) != 0) {
-                       fprintf(stderr, "Failed to connect to %s - %s\n", 
-                               ret->url, ldb_errstring(ldb));
-                       goto failed;
-               }
+
+       if (options.modules_path != NULL) {
+               ldb_set_modules_dir(ldb, options.modules_path);
+       } else if (getenv("LDB_MODULES_PATH") != NULL) {
+               ldb_set_modules_dir(ldb, getenv("LDB_MODULES_PATH"));
+       }
+
+       /* now connect to the ldb */
+       if (ldb_connect(ldb, ret->url, flags, ret->options) != 0) {
+               fprintf(stderr, "Failed to connect to %s - %s\n", 
+                       ret->url, ldb_errstring(ldb));
+               goto failed;
        }
 
        return ret;
@@ -189,3 +321,154 @@ failed:
        exit(1);
        return NULL;
 }
+
+/* this function check controls reply and determines if more
+ * processing is needed setting up the request controls correctly
+ *
+ * returns:
+ *     -1 error
+ *     0 all ok
+ *     1 all ok, more processing required
+ */
+int handle_controls_reply(struct ldb_control **reply, struct ldb_control **request)
+{
+       int i, j;
+               int ret = 0;
+
+       if (reply == NULL || request == NULL) return -1;
+       
+       for (i = 0; reply[i]; i++) {
+               if (strcmp(LDB_CONTROL_VLV_RESP_OID, reply[i]->oid) == 0) {
+                       struct ldb_vlv_resp_control *rep_control;
+
+                       rep_control = talloc_get_type(reply[i]->data, struct ldb_vlv_resp_control);
+                       
+                       /* check we have a matching control in the request */
+                       for (j = 0; request[j]; j++) {
+                               if (strcmp(LDB_CONTROL_VLV_REQ_OID, request[j]->oid) == 0)
+                                       break;
+                       }
+                       if (! request[j]) {
+                               fprintf(stderr, "Warning VLV reply received but no request have been made\n");
+                               continue;
+                       }
+
+                       /* check the result */
+                       if (rep_control->vlv_result != 0) {
+                               fprintf(stderr, "Warning: VLV not performed with error: %d\n", rep_control->vlv_result);
+                       } else {
+                               fprintf(stderr, "VLV Info: target position = %d, content count = %d\n", rep_control->targetPosition, rep_control->contentCount);
+                       }
+
+                       continue;
+               }
+
+               if (strcmp(LDB_CONTROL_ASQ_OID, reply[i]->oid) == 0) {
+                       struct ldb_asq_control *rep_control;
+
+                       rep_control = talloc_get_type(reply[i]->data, struct ldb_asq_control);
+
+                       /* check the result */
+                       if (rep_control->result != 0) {
+                               fprintf(stderr, "Warning: ASQ not performed with error: %d\n", rep_control->result);
+                       }
+
+                       continue;
+               }
+
+               if (strcmp(LDB_CONTROL_PAGED_RESULTS_OID, reply[i]->oid) == 0) {
+                       struct ldb_paged_control *rep_control, *req_control;
+
+                       rep_control = talloc_get_type(reply[i]->data, struct ldb_paged_control);
+                       if (rep_control->cookie_len == 0) /* we are done */
+                               break;
+
+                       /* more processing required */
+                       /* let's fill in the request control with the new cookie */
+
+                       for (j = 0; request[j]; j++) {
+                               if (strcmp(LDB_CONTROL_PAGED_RESULTS_OID, request[j]->oid) == 0)
+                                       break;
+                       }
+                       /* if there's a reply control we must find a request
+                        * control matching it */
+                       if (! request[j]) return -1;
+
+                       req_control = talloc_get_type(request[j]->data, struct ldb_paged_control);
+
+                       if (req_control->cookie)
+                               talloc_free(req_control->cookie);
+                       req_control->cookie = (char *)talloc_memdup(
+                               req_control, rep_control->cookie,
+                               rep_control->cookie_len);
+                       req_control->cookie_len = rep_control->cookie_len;
+
+                       ret = 1;
+
+                       continue;
+               }
+
+               if (strcmp(LDB_CONTROL_SORT_RESP_OID, reply[i]->oid) == 0) {
+                       struct ldb_sort_resp_control *rep_control;
+
+                       rep_control = talloc_get_type(reply[i]->data, struct ldb_sort_resp_control);
+
+                       /* check we have a matching control in the request */
+                       for (j = 0; request[j]; j++) {
+                               if (strcmp(LDB_CONTROL_SERVER_SORT_OID, request[j]->oid) == 0)
+                                       break;
+                       }
+                       if (! request[j]) {
+                               fprintf(stderr, "Warning Server Sort reply received but no request found\n");
+                               continue;
+                       }
+
+                       /* check the result */
+                       if (rep_control->result != 0) {
+                               fprintf(stderr, "Warning: Sorting not performed with error: %d\n", rep_control->result);
+                       }
+
+                       continue;
+               }
+
+               if (strcmp(LDB_CONTROL_DIRSYNC_OID, reply[i]->oid) == 0) {
+                       struct ldb_dirsync_control *rep_control, *req_control;
+                       char *cookie;
+
+                       rep_control = talloc_get_type(reply[i]->data, struct ldb_dirsync_control);
+                       if (rep_control->cookie_len == 0) /* we are done */
+                               break;
+
+                       /* more processing required */
+                       /* let's fill in the request control with the new cookie */
+
+                       for (j = 0; request[j]; j++) {
+                               if (strcmp(LDB_CONTROL_DIRSYNC_OID, request[j]->oid) == 0)
+                                       break;
+                       }
+                       /* if there's a reply control we must find a request
+                        * control matching it */
+                       if (! request[j]) return -1;
+
+                       req_control = talloc_get_type(request[j]->data, struct ldb_dirsync_control);
+
+                       if (req_control->cookie)
+                               talloc_free(req_control->cookie);
+                       req_control->cookie = (char *)talloc_memdup(
+                               req_control, rep_control->cookie,
+                               rep_control->cookie_len);
+                       req_control->cookie_len = rep_control->cookie_len;
+
+                       cookie = ldb_base64_encode(req_control, rep_control->cookie, rep_control->cookie_len);
+                       printf("# DIRSYNC cookie returned was:\n# %s\n", cookie);
+
+                       continue;
+               }
+
+               /* no controls matched, throw a warning */
+               fprintf(stderr, "Unknown reply control oid: %s\n", reply[i]->oid);
+       }
+
+       return ret;
+}
+