source4/lib/ldb/tools/cmdline.c

   1 /*
   2    ldb database library - command line handling for ldb tools
   3
   4    Copyright (C) Andrew Tridgell  2005
   5
   6      ** NOTE! The following LGPL license applies to the ldb
   7      ** library. This does NOT imply that all of Samba is released
   8      ** under the LGPL
   9
  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.
  14
  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.
  19
  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/>.
  22 */
  23
  24 #include "ldb_includes.h"
  25 #include "tools/cmdline.h"
  26
  27 #if (_SAMBA_BUILD_ >= 4)
  28 #include "includes.h"
  29 #include "lib/cmdline/popt_common.h"
  30 #include "lib/ldb-samba/ldif_handlers.h"
  31 #include "auth/gensec/gensec.h"
  32 #include "auth/auth.h"
  33 #include "db_wrap.h"
  34 #endif
  35
  36
  37
  38 /*
  39   process command line options
  40 */
  41 struct ldb_cmdline *ldb_cmdline_process(struct ldb_context *ldb, int argc, const char **argv,
  42                                         void (*usage)(void))
  43 {
  44         static struct ldb_cmdline options; /* needs to be static for older compilers */
  45         struct ldb_cmdline *ret=NULL;
  46         poptContext pc;
  47 #if (_SAMBA_BUILD_ >= 4)
  48         int r;
  49 #endif
  50         int num_options = 0;
  51         int opt;
  52         int flags = 0;
  53
  54         struct poptOption popt_options[] = {
  55                 POPT_AUTOHELP
  56                 { "url",       'H', POPT_ARG_STRING, &options.url, 0, "database URL", "URL" },
  57                 { "basedn",    'b', POPT_ARG_STRING, &options.basedn, 0, "base DN", "DN" },
  58                 { "editor",    'e', POPT_ARG_STRING, &options.editor, 0, "external editor", "PROGRAM" },
  59                 { "scope",     's', POPT_ARG_STRING, NULL, 's', "search scope", "SCOPE" },
  60                 { "verbose",   'v', POPT_ARG_NONE, NULL, 'v', "increase verbosity", NULL },
  61                 { "interactive", 'i', POPT_ARG_NONE, &options.interactive, 0, "input from stdin", NULL },
  62                 { "recursive", 'r', POPT_ARG_NONE, &options.recursive, 0, "recursive delete", NULL },
  63                 { "modules-path", 0, POPT_ARG_STRING, &options.modules_path, 0, "modules path", "PATH" },
  64                 { "num-searches", 0, POPT_ARG_INT, &options.num_searches, 0, "number of test searches", NULL },
  65                 { "num-records", 0, POPT_ARG_INT, &options.num_records, 0, "number of test records", NULL },
  66                 { "all", 'a',    POPT_ARG_NONE, &options.all_records, 0, "(|(objectClass=*)(distinguishedName=*))", NULL },
  67                 { "nosync", 0,   POPT_ARG_NONE, &options.nosync, 0, "non-synchronous transactions", NULL },
  68                 { "sorted", 'S', POPT_ARG_NONE, &options.sorted, 0, "sort attributes", NULL },
  69                 { "input", 'I', POPT_ARG_STRING, &options.input, 0, "Input File", "Input" },
  70                 { "output", 'O', POPT_ARG_STRING, &options.output, 0, "Output File", "Output" },
  71                 { NULL,    'o', POPT_ARG_STRING, NULL, 'o', "ldb_connect option", "OPTION" },
  72                 { "controls", 0, POPT_ARG_STRING, NULL, 'c', "controls", NULL },
  73 #if (_SAMBA_BUILD_ >= 4)
  74                 POPT_COMMON_SAMBA
  75                 POPT_COMMON_CREDENTIALS
  76                 POPT_COMMON_VERSION
  77 #endif
  78                 { NULL }
  79         };
  80
  81         ldb_global_init();
  82
  83 #if (_SAMBA_BUILD_ >= 4)
  84         r = ldb_register_samba_handlers(ldb);
  85         if (r != 0) {
  86                 goto failed;
  87         }
  88
  89 #endif
  90
  91         ret = talloc_zero(ldb, struct ldb_cmdline);
  92         if (ret == NULL) {
  93                 ldb_oom(ldb);
  94                 goto failed;
  95         }
  96
  97         options = *ret;
  98
  99         /* pull in URL */
 100         options.url = getenv("LDB_URL");
 101
 102         /* and editor (used by ldbedit) */
 103         options.editor = getenv("VISUAL");
 104         if (!options.editor) {
 105                 options.editor = getenv("EDITOR");
 106         }
 107         if (!options.editor) {
 108                 options.editor = "vi";
 109         }
 110
 111         options.scope = LDB_SCOPE_DEFAULT;
 112
 113         pc = poptGetContext(argv[0], argc, argv, popt_options,
 114                             POPT_CONTEXT_KEEP_FIRST);
 115
 116         while((opt = poptGetNextOpt(pc)) != -1) {
 117                 switch (opt) {
 118                 case 's': {
 119                         const char *arg = poptGetOptArg(pc);
 120                         if (strcmp(arg, "base") == 0) {
 121                                 options.scope = LDB_SCOPE_BASE;
 122                         } else if (strcmp(arg, "sub") == 0) {
 123                                 options.scope = LDB_SCOPE_SUBTREE;
 124                         } else if (strcmp(arg, "one") == 0) {
 125                                 options.scope = LDB_SCOPE_ONELEVEL;
 126                         } else {
 127                                 fprintf(stderr, "Invalid scope '%s'\n", arg);
 128                                 goto failed;
 129                         }
 130                         break;
 131                 }
 132
 133                 case 'v':
 134                         options.verbose++;
 135                         break;
 136
 137                 case 'o':
 138                         options.options = talloc_realloc(ret, options.options,
 139                                                          const char *, num_options+3);
 140                         if (options.options == NULL) {
 141                                 ldb_oom(ldb);
 142                                 goto failed;
 143                         }
 144                         options.options[num_options] = poptGetOptArg(pc);
 145                         options.options[num_options+1] = NULL;
 146                         num_options++;
 147                         break;
 148
 149                 case 'c': {
 150                         const char *cs = poptGetOptArg(pc);
 151                         const char *p, *q;
 152                         int cc;
 153
 154                         for (p = cs, cc = 1; (q = strchr(p, ',')); cc++, p = q + 1) ;
 155
 156                         options.controls = talloc_array(ret, char *, cc + 1);
 157                         if (options.controls == NULL) {
 158                                 ldb_oom(ldb);
 159                                 goto failed;
 160                         }
 161                         for (p = cs, cc = 0; p != NULL; cc++) {
 162                                 const char *t;
 163
 164                                 t = strchr(p, ',');
 165                                 if (t == NULL) {
 166                                         options.controls[cc] = talloc_strdup(options.controls, p);
 167                                         p = NULL;
 168                                 } else {
 169                                         options.controls[cc] = talloc_strndup(options.controls, p, t-p);
 170                                         p = t + 1;
 171                                 }
 172                         }
 173                         options.controls[cc] = NULL;
 174
 175                         break;
 176                 }
 177                 default:
 178                         fprintf(stderr, "Invalid option %s: %s\n",
 179                                 poptBadOption(pc, 0), poptStrerror(opt));
 180                         if (usage) usage();
 181                         goto failed;
 182                 }
 183         }
 184
 185         /* setup the remaining options for the main program to use */
 186         options.argv = poptGetArgs(pc);
 187         if (options.argv) {
 188                 options.argv++;
 189                 while (options.argv[options.argc]) options.argc++;
 190         }
 191
 192         *ret = options;
 193
 194         /* all utils need some option */
 195         if (ret->url == NULL) {
 196                 fprintf(stderr, "You must supply a url with -H or with $LDB_URL\n");
 197                 if (usage) usage();
 198                 goto failed;
 199         }
 200
 201         if (strcmp(ret->url, "NONE") == 0) {
 202                 return ret;
 203         }
 204
 205         if (options.nosync) {
 206                 flags |= LDB_FLG_NOSYNC;
 207         }
 208
 209 #if (_SAMBA_BUILD_ >= 4)
 210         /* Must be after we have processed command line options */
 211         gensec_init();
 212
 213         if (ldb_set_opaque(ldb, "sessionInfo", system_session(ldb))) {
 214                 goto failed;
 215         }
 216         if (ldb_set_opaque(ldb, "credentials", cmdline_credentials)) {
 217                 goto failed;
 218         }
 219         ldb_set_utf8_fns(ldb, NULL, wrap_casefold);
 220 #endif
 221
 222         if (options.modules_path != NULL) {
 223                 ldb_set_modules_dir(ldb, options.modules_path);
 224         } else if (getenv("LDB_MODULES_PATH") != NULL) {
 225                 ldb_set_modules_dir(ldb, getenv("LDB_MODULES_PATH"));
 226         }
 227
 228         /* now connect to the ldb */
 229         if (ldb_connect(ldb, ret->url, flags, ret->options) != 0) {
 230                 fprintf(stderr, "Failed to connect to %s - %s\n",
 231                         ret->url, ldb_errstring(ldb));
 232                 goto failed;
 233         }
 234
 235         return ret;
 236
 237 failed:
 238         talloc_free(ret);
 239         exit(1);
 240         return NULL;
 241 }
 242
 243 /* this function check controls reply and determines if more
 244  * processing is needed setting up the request controls correctly
 245  *
 246  * returns:
 247  *      -1 error
 248  *      0 all ok
 249  *      1 all ok, more processing required
 250  */
 251 int handle_controls_reply(struct ldb_control **reply, struct ldb_control **request)
 252 {
 253         int i, j;
 254         int ret = 0;
 255
 256         if (reply == NULL || request == NULL) return -1;
 257
 258         for (i = 0; reply[i]; i++) {
 259                 if (strcmp(LDB_CONTROL_VLV_RESP_OID, reply[i]->oid) == 0) {
 260                         struct ldb_vlv_resp_control *rep_control;
 261
 262                         rep_control = talloc_get_type(reply[i]->data, struct ldb_vlv_resp_control);
 263
 264                         /* check we have a matching control in the request */
 265                         for (j = 0; request[j]; j++) {
 266                                 if (strcmp(LDB_CONTROL_VLV_REQ_OID, request[j]->oid) == 0)
 267                                         break;
 268                         }
 269                         if (! request[j]) {
 270                                 fprintf(stderr, "Warning VLV reply received but no request have been made\n");
 271                                 continue;
 272                         }
 273
 274                         /* check the result */
 275                         if (rep_control->vlv_result != 0) {
 276                                 fprintf(stderr, "Warning: VLV not performed with error: %d\n", rep_control->vlv_result);
 277                         } else {
 278                                 fprintf(stderr, "VLV Info: target position = %d, content count = %d\n", rep_control->targetPosition, rep_control->contentCount);
 279                         }
 280
 281                         continue;
 282                 }
 283
 284                 if (strcmp(LDB_CONTROL_ASQ_OID, reply[i]->oid) == 0) {
 285                         struct ldb_asq_control *rep_control;
 286
 287                         rep_control = talloc_get_type(reply[i]->data, struct ldb_asq_control);
 288
 289                         /* check the result */
 290                         if (rep_control->result != 0) {
 291                                 fprintf(stderr, "Warning: ASQ not performed with error: %d\n", rep_control->result);
 292                         }
 293
 294                         continue;
 295                 }
 296
 297                 if (strcmp(LDB_CONTROL_PAGED_RESULTS_OID, reply[i]->oid) == 0) {
 298                         struct ldb_paged_control *rep_control, *req_control;
 299
 300                         rep_control = talloc_get_type(reply[i]->data, struct ldb_paged_control);
 301                         if (rep_control->cookie_len == 0) /* we are done */
 302                                 break;
 303
 304                         /* more processing required */
 305                         /* let's fill in the request control with the new cookie */
 306
 307                         for (j = 0; request[j]; j++) {
 308                                 if (strcmp(LDB_CONTROL_PAGED_RESULTS_OID, request[j]->oid) == 0)
 309                                         break;
 310                         }
 311                         /* if there's a reply control we must find a request
 312                          * control matching it */
 313                         if (! request[j]) return -1;
 314
 315                         req_control = talloc_get_type(request[j]->data, struct ldb_paged_control);
 316
 317                         if (req_control->cookie)
 318                                 talloc_free(req_control->cookie);
 319                         req_control->cookie = (char *)talloc_memdup(
 320                                 req_control, rep_control->cookie,
 321                                 rep_control->cookie_len);
 322                         req_control->cookie_len = rep_control->cookie_len;
 323
 324                         ret = 1;
 325
 326                         continue;
 327                 }
 328
 329                 if (strcmp(LDB_CONTROL_SORT_RESP_OID, reply[i]->oid) == 0) {
 330                         struct ldb_sort_resp_control *rep_control;
 331
 332                         rep_control = talloc_get_type(reply[i]->data, struct ldb_sort_resp_control);
 333
 334                         /* check we have a matching control in the request */
 335                         for (j = 0; request[j]; j++) {
 336                                 if (strcmp(LDB_CONTROL_SERVER_SORT_OID, request[j]->oid) == 0)
 337                                         break;
 338                         }
 339                         if (! request[j]) {
 340                                 fprintf(stderr, "Warning Server Sort reply received but no request found\n");
 341                                 continue;
 342                         }
 343
 344                         /* check the result */
 345                         if (rep_control->result != 0) {
 346                                 fprintf(stderr, "Warning: Sorting not performed with error: %d\n", rep_control->result);
 347                         }
 348
 349                         continue;
 350                 }
 351
 352                 if (strcmp(LDB_CONTROL_DIRSYNC_OID, reply[i]->oid) == 0) {
 353                         struct ldb_dirsync_control *rep_control, *req_control;
 354                         char *cookie;
 355
 356                         rep_control = talloc_get_type(reply[i]->data, struct ldb_dirsync_control);
 357                         if (rep_control->cookie_len == 0) /* we are done */
 358                                 break;
 359
 360                         /* more processing required */
 361                         /* let's fill in the request control with the new cookie */
 362
 363                         for (j = 0; request[j]; j++) {
 364                                 if (strcmp(LDB_CONTROL_DIRSYNC_OID, request[j]->oid) == 0)
 365                                         break;
 366                         }
 367                         /* if there's a reply control we must find a request
 368                          * control matching it */
 369                         if (! request[j]) return -1;
 370
 371                         req_control = talloc_get_type(request[j]->data, struct ldb_dirsync_control);
 372
 373                         if (req_control->cookie)
 374                                 talloc_free(req_control->cookie);
 375                         req_control->cookie = (char *)talloc_memdup(
 376                                 req_control, rep_control->cookie,
 377                                 rep_control->cookie_len);
 378                         req_control->cookie_len = rep_control->cookie_len;
 379
 380                         cookie = ldb_base64_encode(req_control, rep_control->cookie, rep_control->cookie_len);
 381                         printf("# DIRSYNC cookie returned was:\n# %s\n", cookie);
 382
 383                         continue;
 384                 }
 385
 386                 /* no controls matched, throw a warning */
 387                 fprintf(stderr, "Unknown reply control oid: %s\n", reply[i]->oid);
 388         }
 389
 390         return ret;
 391 }
 392