git.sur5r.net Git - openldap/blob - servers/slapd/slapcommon.c

   1 /* slapcommon.c - common routine for the slap tools */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 1998-2006 The OpenLDAP Foundation.
   6  * Portions Copyright 1998-2003 Kurt D. Zeilenga.
   7  * Portions Copyright 2003 IBM Corporation.
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted only as authorized by the OpenLDAP
  12  * Public License.
  13  *
  14  * A copy of this license is available in file LICENSE in the
  15  * top-level directory of the distribution or, alternatively, at
  16  * <http://www.OpenLDAP.org/license.html>.
  17  */
  18 /* ACKNOWLEDGEMENTS:
  19  * This work was initially developed by Kurt Zeilenga for inclusion
  20  * in OpenLDAP Software.  Additional signficant contributors include
  21  *    Jong Hyuk Choi
  22  *    Hallvard B. Furuseth
  23  *    Howard Chu
  24  *    Pierangelo Masarati
  25  */
  26
  27 #include "portable.h"
  28
  29 #include <stdio.h>
  30
  31 #include <ac/stdlib.h>
  32 #include <ac/ctype.h>
  33 #include <ac/string.h>
  34 #include <ac/socket.h>
  35 #include <ac/unistd.h>
  36
  37 #include "slapcommon.h"
  38 #include "lutil.h"
  39 #include "ldif.h"
  40
  41 tool_vars tool_globals;
  42
  43 #ifdef CSRIMALLOC
  44 static char *leakfilename;
  45 static FILE *leakfile;
  46 #endif
  47
  48 static LDIFFP dummy;
  49
  50 static void
  51 usage( int tool, const char *progname )
  52 {
  53         char *options = NULL;
  54         fprintf( stderr,
  55                 "usage: %s [-v] [-d debuglevel] [-f configfile] [-F configdir]",
  56                 progname );
  57
  58         switch( tool ) {
  59         case SLAPACL:
  60                 options = "\n\t[-U authcID | -D authcDN] [-X authzID | -o authzDN=<DN>]"
  61                         "\n\t-b DN -o <var>[=<val>] [-u] [attr[/access][:value]] [...]\n";
  62                 break;
  63
  64         case SLAPADD:
  65                 options = " [-c]\n\t[-g] [-n databasenumber | -b suffix]\n"
  66                         "\t[-l ldiffile] [-q] [-u] [-w]\n";
  67                 break;
  68
  69         case SLAPAUTH:
  70                 options = "\n\t[-U authcID] [-X authzID] [-R realm] [-M mech] ID [...]\n";
  71                 break;
  72
  73         case SLAPCAT:
  74                 options = " [-c]\n\t[-g] [-n databasenumber | -b suffix]"
  75                         " [-l ldiffile] [-a filter]\n";
  76                 break;
  77
  78         case SLAPDN:
  79                 options = "\n\t[-N | -P] DN [...]\n";
  80                 break;
  81
  82         case SLAPINDEX:
  83                 options = " [-c]\n\t[-g] [-n databasenumber | -b suffix] [-q]\n";
  84                 break;
  85
  86         case SLAPTEST:
  87                 options = " [-u]\n";
  88                 break;
  89         }
  90
  91         if ( options != NULL ) {
  92                 fputs( options, stderr );
  93         }
  94         exit( EXIT_FAILURE );
  95 }
  96
  97 static int
  98 parse_slapacl( void )
  99 {
 100         size_t  len;
 101         char    *p;
 102
 103         p = strchr( optarg, '=' );
 104         if ( p == NULL ) {
 105                 return -1;
 106         }
 107
 108         len = p - optarg;
 109         p++;
 110
 111         if ( strncasecmp( optarg, "sockurl", len ) == 0 ) {
 112                 if ( !BER_BVISNULL( &listener_url ) ) {
 113                         ber_memfree( listener_url.bv_val );
 114                 }
 115                 ber_str2bv( p, 0, 1, &listener_url );
 116
 117         } else if ( strncasecmp( optarg, "domain", len ) == 0 ) {
 118                 if ( !BER_BVISNULL( &peer_domain ) ) {
 119                         ber_memfree( peer_domain.bv_val );
 120                 }
 121                 ber_str2bv( p, 0, 1, &peer_domain );
 122
 123         } else if ( strncasecmp( optarg, "peername", len ) == 0 ) {
 124                 if ( !BER_BVISNULL( &peer_name ) ) {
 125                         ber_memfree( peer_name.bv_val );
 126                 }
 127                 ber_str2bv( p, 0, 1, &peer_name );
 128
 129         } else if ( strncasecmp( optarg, "sockname", len ) == 0 ) {
 130                 if ( !BER_BVISNULL( &sock_name ) ) {
 131                         ber_memfree( sock_name.bv_val );
 132                 }
 133                 ber_str2bv( p, 0, 1, &sock_name );
 134
 135         } else if ( strncasecmp( optarg, "ssf", len ) == 0 ) {
 136                 if ( lutil_atou( &ssf, p ) ) {
 137                         Debug( LDAP_DEBUG_ANY, "unable to parse ssf=\"%s\".\n", p, 0, 0 );
 138                         return -1;
 139                 }
 140
 141         } else if ( strncasecmp( optarg, "transport_ssf", len ) == 0 ) {
 142                 if ( lutil_atou( &transport_ssf, p ) ) {
 143                         Debug( LDAP_DEBUG_ANY, "unable to parse transport_ssf=\"%s\".\n", p, 0, 0 );
 144                         return -1;
 145                 }
 146
 147         } else if ( strncasecmp( optarg, "tls_ssf", len ) == 0 ) {
 148                 if ( lutil_atou( &tls_ssf, p ) ) {
 149                         Debug( LDAP_DEBUG_ANY, "unable to parse tls_ssf=\"%s\".\n", p, 0, 0 );
 150                         return -1;
 151                 }
 152
 153         } else if ( strncasecmp( optarg, "sasl_ssf", len ) == 0 ) {
 154                 if ( lutil_atou( &sasl_ssf, p ) ) {
 155                         Debug( LDAP_DEBUG_ANY, "unable to parse sasl_ssf=\"%s\".\n", p, 0, 0 );
 156                         return -1;
 157                 }
 158
 159         } else if ( strncasecmp( optarg, "authzDN", len ) == 0 ) {
 160                 ber_str2bv( p, 0, 1, &authzDN );
 161
 162         } else {
 163                 return -1;
 164         }
 165
 166         return 0;
 167 }
 168
 169 /*
 170  * slap_tool_init - initialize slap utility, handle program options.
 171  * arguments:
 172  *      name            program name
 173  *      tool            tool code
 174  *      argc, argv      command line arguments
 175  */
 176
 177 static int need_shutdown;
 178
 179 void
 180 slap_tool_init(
 181         const char* progname,
 182         int tool,
 183         int argc, char **argv )
 184 {
 185         char *options;
 186         char *conffile = NULL;
 187         char *confdir = NULL;
 188         struct berval base = BER_BVNULL;
 189         char *filterstr = NULL;
 190         char *subtree = NULL;
 191         char *ldiffile  = NULL;
 192         int rc, i, dbnum;
 193         int mode = SLAP_TOOL_MODE;
 194         int truncatemode = 0;
 195         int use_glue = 1;
 196
 197 #ifdef LDAP_DEBUG
 198         /* tools default to "none", so that at least LDAP_DEBUG_ANY
 199          * messages show up; use -d 0 to reset */
 200         slap_debug = LDAP_DEBUG_NONE;
 201 #endif
 202
 203 #ifdef CSRIMALLOC
 204         leakfilename = malloc( strlen( progname ) + STRLENOF( ".leak" ) + 1 );
 205         sprintf( leakfilename, "%s.leak", progname );
 206         if( ( leakfile = fopen( leakfilename, "w" )) == NULL ) {
 207                 leakfile = stderr;
 208         }
 209         free( leakfilename );
 210 #endif
 211
 212         switch( tool ) {
 213         case SLAPADD:
 214                 options = "b:cd:f:F:gl:n:qtuvw";
 215                 break;
 216
 217         case SLAPCAT:
 218                 options = "a:b:cd:f:F:gl:n:s:v";
 219                 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
 220                 break;
 221
 222         case SLAPDN:
 223                 options = "d:f:F:NPv";
 224                 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
 225                 break;
 226
 227         case SLAPTEST:
 228                 options = "d:f:F:uv";
 229                 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
 230                 break;
 231
 232         case SLAPAUTH:
 233                 options = "d:f:F:M:R:U:vX:";
 234                 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
 235                 break;
 236
 237         case SLAPINDEX:
 238                 options = "b:cd:f:F:gn:qv";
 239                 mode |= SLAP_TOOL_READMAIN;
 240                 break;
 241
 242         case SLAPACL:
 243                 options = "b:D:d:f:F:o:uU:vX:";
 244                 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
 245                 break;
 246
 247         default:
 248                 fprintf( stderr, "%s: unknown tool mode (%d)\n", progname, tool );
 249                 exit( EXIT_FAILURE );
 250         }
 251
 252         dbnum = -1;
 253         while ( (i = getopt( argc, argv, options )) != EOF ) {
 254                 switch ( i ) {
 255                 case 'a':
 256                         filterstr = strdup( optarg );
 257                         break;
 258
 259                 case 'b':
 260                         ber_str2bv( optarg, 0, 1, &base );
 261                         break;
 262
 263                 case 'c':       /* enable continue mode */
 264                         continuemode++;
 265                         break;
 266
 267                 case 'd': {     /* turn on debugging */
 268                         int     level = 0;
 269
 270                         if ( parse_debug_level( optarg, &level ) ) {
 271                                 usage( tool, progname );
 272                         }
 273 #ifdef LDAP_DEBUG
 274                         if ( level == 0 ) {
 275                                 /* allow to reset log level */
 276                                 slap_debug = 0;
 277
 278                         } else {
 279                                 slap_debug |= level;
 280                         }
 281 #else
 282                         if ( level != 0 )
 283                                 fputs( "must compile with LDAP_DEBUG for debugging\n",
 284                                        stderr );
 285 #endif
 286                         } break;
 287
 288                 case 'D':
 289                         ber_str2bv( optarg, 0, 1, &authcDN );
 290                         break;
 291
 292                 case 'f':       /* specify a conf file */
 293                         conffile = strdup( optarg );
 294                         break;
 295
 296                 case 'F':       /* specify a conf dir */
 297                         confdir = strdup( optarg );
 298                         break;
 299
 300                 case 'g':       /* disable subordinate glue */
 301                         use_glue = 0;
 302                         break;
 303
 304                 case 'l':       /* LDIF file */
 305                         ldiffile = strdup( optarg );
 306                         break;
 307
 308                 case 'M':
 309                         ber_str2bv( optarg, 0, 0, &mech );
 310                         break;
 311
 312                 case 'N':
 313                         if ( dn_mode && dn_mode != SLAP_TOOL_LDAPDN_NORMAL ) {
 314                                 usage( tool, progname );
 315                         }
 316                         dn_mode = SLAP_TOOL_LDAPDN_NORMAL;
 317                         break;
 318
 319                 case 'n':       /* which config file db to index */
 320                         if ( lutil_atoi( &dbnum, optarg ) ) {
 321                                 usage( tool, progname );
 322                         }
 323                         break;
 324
 325                 case 'o':
 326                         if ( parse_slapacl() ) {
 327                                 usage( tool, progname );
 328                         }
 329                         break;
 330
 331                 case 'P':
 332                         if ( dn_mode && dn_mode != SLAP_TOOL_LDAPDN_PRETTY ) {
 333                                 usage( tool, progname );
 334                         }
 335                         dn_mode = SLAP_TOOL_LDAPDN_PRETTY;
 336                         break;
 337
 338                 case 'q':       /* turn on quick */
 339                         mode |= SLAP_TOOL_QUICK;
 340                         break;
 341
 342                 case 'R':
 343                         realm = optarg;
 344                         break;
 345
 346                 case 's':       /* dump subtree */
 347                         subtree = strdup( optarg );
 348                         break;
 349
 350                 case 't':       /* turn on truncate */
 351                         truncatemode++;
 352                         mode |= SLAP_TRUNCATE_MODE;
 353                         break;
 354
 355                 case 'U':
 356                         ber_str2bv( optarg, 0, 0, &authcID );
 357                         break;
 358
 359                 case 'u':       /* dry run */
 360                         dryrun++;
 361                         break;
 362
 363                 case 'v':       /* turn on verbose */
 364                         verbose++;
 365                         break;
 366
 367                 case 'w':       /* write context csn at the end */
 368                         update_ctxcsn++;
 369                         break;
 370
 371                 case 'X':
 372                         ber_str2bv( optarg, 0, 0, &authzID );
 373                         break;
 374
 375                 default:
 376                         usage( tool, progname );
 377                         break;
 378                 }
 379         }
 380
 381         switch ( tool ) {
 382         case SLAPADD:
 383         case SLAPCAT:
 384         case SLAPINDEX:
 385                 if ( ( argc != optind ) || (dbnum >= 0 && base.bv_val != NULL ) ) {
 386                         usage( tool, progname );
 387                 }
 388
 389                 break;
 390
 391         case SLAPDN:
 392                 if ( argc == optind ) {
 393                         usage( tool, progname );
 394                 }
 395                 break;
 396
 397         case SLAPAUTH:
 398                 if ( argc == optind && BER_BVISNULL( &authcID ) ) {
 399                         usage( tool, progname );
 400                 }
 401                 break;
 402
 403         case SLAPTEST:
 404                 if ( argc != optind ) {
 405                         usage( tool, progname );
 406                 }
 407                 break;
 408
 409         case SLAPACL:
 410                 if ( !BER_BVISNULL( &authcDN ) && !BER_BVISNULL( &authcID ) ) {
 411                         usage( tool, progname );
 412                 }
 413                 if ( BER_BVISNULL( &base ) ) {
 414                         usage( tool, progname );
 415                 }
 416                 ber_dupbv( &baseDN, &base );
 417                 break;
 418
 419         default:
 420                 break;
 421         }
 422
 423         ldap_syslog = 0;
 424
 425         if ( ldiffile == NULL ) {
 426                 dummy.fp = tool == SLAPCAT ? stdout : stdin;
 427                 ldiffp = &dummy;
 428
 429         } else if ((ldiffp = ldif_open( ldiffile, tool == SLAPCAT ? "w" : "r" ))
 430                 == NULL )
 431         {
 432                 perror( ldiffile );
 433                 exit( EXIT_FAILURE );
 434         }
 435
 436         /*
 437          * initialize stuff and figure out which backend we're dealing with
 438          */
 439
 440         rc = slap_init( mode, progname );
 441         if ( rc != 0 ) {
 442                 fprintf( stderr, "%s: slap_init failed!\n", progname );
 443                 exit( EXIT_FAILURE );
 444         }
 445
 446         rc = read_config( conffile, confdir );
 447
 448         if ( rc != 0 ) {
 449                 fprintf( stderr, "%s: bad configuration %s!\n",
 450                         progname, confdir ? "directory" : "file" );
 451                 exit( EXIT_FAILURE );
 452         }
 453
 454         at_oc_cache = 1;
 455
 456         switch ( tool ) {
 457         case SLAPADD:
 458         case SLAPCAT:
 459         case SLAPINDEX:
 460                 if ( !nbackends ) {
 461                         fprintf( stderr, "No databases found "
 462                                         "in config file\n" );
 463                         exit( EXIT_FAILURE );
 464                 }
 465                 break;
 466
 467         default:
 468                 break;
 469         }
 470
 471         if ( use_glue ) {
 472                 rc = glue_sub_attach();
 473
 474                 if ( rc != 0 ) {
 475                         fprintf( stderr,
 476                                 "%s: subordinate configuration error\n", progname );
 477                         exit( EXIT_FAILURE );
 478                 }
 479         }
 480
 481         rc = slap_schema_check();
 482
 483         if ( rc != 0 ) {
 484                 fprintf( stderr, "%s: slap_schema_prep failed!\n", progname );
 485                 exit( EXIT_FAILURE );
 486         }
 487
 488         switch ( tool ) {
 489         case SLAPDN:
 490         case SLAPTEST:
 491         case SLAPAUTH:
 492                 be = NULL;
 493                 goto startup;
 494
 495         default:
 496                 break;
 497         }
 498
 499         if( filterstr ) {
 500                 filter = str2filter( filterstr );
 501
 502                 if( filter == NULL ) {
 503                         fprintf( stderr, "Invalid filter '%s'\n", filterstr );
 504                         exit( EXIT_FAILURE );
 505                 }
 506         }
 507
 508         if( subtree ) {
 509                 struct berval val;
 510                 ber_str2bv( subtree, 0, 0, &val );
 511                 rc = dnNormalize( 0, NULL, NULL, &val, &sub_ndn, NULL );
 512                 if( rc != LDAP_SUCCESS ) {
 513                         fprintf( stderr, "Invalid subtree DN '%s'\n", subtree );
 514                         exit( EXIT_FAILURE );
 515                 }
 516
 517                 if ( BER_BVISNULL( &base ) && dbnum == -1 ) {
 518                         base = val;
 519                 } else {
 520                         free( subtree );
 521                 }
 522         }
 523
 524         if( base.bv_val != NULL ) {
 525                 struct berval nbase;
 526
 527                 rc = dnNormalize( 0, NULL, NULL, &base, &nbase, NULL );
 528                 if( rc != LDAP_SUCCESS ) {
 529                         fprintf( stderr, "%s: slap_init invalid suffix (\"%s\")\n",
 530                                 progname, base.bv_val );
 531                         exit( EXIT_FAILURE );
 532                 }
 533
 534                 be = select_backend( &nbase, 0, 0 );
 535                 ber_memfree( nbase.bv_val );
 536
 537                 switch ( tool ) {
 538                 case SLAPACL:
 539                         goto startup;
 540
 541                 default:
 542                         break;
 543                 }
 544
 545                 if( be == NULL ) {
 546                         fprintf( stderr, "%s: slap_init no backend for \"%s\"\n",
 547                                 progname, base.bv_val );
 548                         exit( EXIT_FAILURE );
 549                 }
 550                 /* If the named base is a glue master, operate on the
 551                  * entire context
 552                  */
 553                 if ( SLAP_GLUE_INSTANCE( be ) ) {
 554                         nosubordinates = 1;
 555                 }
 556
 557         } else if ( dbnum == -1 ) {
 558                 /* no suffix and no dbnum specified, just default to
 559                  * the first available database
 560                  */
 561                 if ( nbackends <= 0 ) {
 562                         fprintf( stderr, "No available databases\n" );
 563                         exit( EXIT_FAILURE );
 564                 }
 565                 LDAP_STAILQ_FOREACH( be, &backendDB, be_next ) {
 566                         dbnum++;
 567
 568                         /* db #0 is cn=config, don't select it as a default */
 569                         if ( dbnum < 1 ) continue;
 570
 571                         if ( SLAP_MONITOR(be))
 572                                 continue;
 573
 574                 /* If just doing the first by default and it is a
 575                  * glue subordinate, find the master.
 576                  */
 577                         if ( SLAP_GLUE_SUBORDINATE(be) ) {
 578                                 nosubordinates = 1;
 579                                 continue;
 580                         }
 581                         break;
 582                 }
 583
 584                 if ( !be ) {
 585                         fprintf( stderr, "Available database(s) "
 586                                         "do not allow %s\n", progname );
 587                         exit( EXIT_FAILURE );
 588                 }
 589
 590                 if ( nosubordinates == 0 && dbnum > 1 ) {
 591                         Debug( LDAP_DEBUG_ANY,
 592                                 "The first database does not allow %s;"
 593                                 " using the first available one (%d)\n",
 594                                 progname, dbnum, 0 );
 595                 }
 596
 597         } else if ( dbnum < 0 || dbnum > (nbackends-1) ) {
 598                 fprintf( stderr,
 599                         "Database number selected via -n is out of range\n"
 600                         "Must be in the range 0 to %d"
 601                         " (number of configured databases)\n",
 602                         nbackends-1 );
 603                 exit( EXIT_FAILURE );
 604
 605         } else {
 606                 LDAP_STAILQ_FOREACH( be, &backendDB, be_next ) {
 607                         if ( dbnum == 0 ) break;
 608                         dbnum--;
 609                 }
 610         }
 611
 612 startup:;
 613
 614 #ifdef CSRIMALLOC
 615         mal_leaktrace(1);
 616 #endif
 617
 618         if ( conffile != NULL ) {
 619                 ch_free( conffile );
 620         }
 621
 622         if ( ldiffile != NULL ) {
 623                 ch_free( ldiffile );
 624         }
 625
 626         /* slapdn doesn't specify a backend to startup */
 627         if ( !dryrun && tool != SLAPDN && slap_startup( be ) ) {
 628                 need_shutdown = 1;
 629
 630                 switch ( tool ) {
 631                 case SLAPTEST:
 632                         fprintf( stderr, "slap_startup failed "
 633                                         "(test would succeed using "
 634                                         "the -u switch)\n" );
 635                         break;
 636
 637                 default:
 638                         fprintf( stderr, "slap_startup failed\n" );
 639                         break;
 640                 }
 641
 642                 exit( EXIT_FAILURE );
 643         }
 644 }
 645
 646 void slap_tool_destroy( void )
 647 {
 648         if ( !dryrun ) {
 649                 if ( need_shutdown ) {
 650                         slap_shutdown( be );
 651                 }
 652                 slap_destroy();
 653         }
 654 #ifdef SLAPD_MODULES
 655         if ( slapMode == SLAP_SERVER_MODE ) {
 656         /* always false. just pulls in necessary symbol references. */
 657                 lutil_uuidstr(NULL, 0);
 658         }
 659         module_kill();
 660 #endif
 661         schema_destroy();
 662 #ifdef HAVE_TLS
 663         ldap_pvt_tls_destroy();
 664 #endif
 665         config_destroy();
 666
 667 #ifdef CSRIMALLOC
 668         mal_dumpleaktrace( leakfile );
 669 #endif
 670
 671         if ( !BER_BVISNULL( &authcDN ) ) {
 672                 ch_free( authcDN.bv_val );
 673         }
 674 }