1 /* slapcommon.c - common routine for the slap tools */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2005 The OpenLDAP Foundation.
6 * Portions Copyright 1998-2003 Kurt D. Zeilenga.
7 * Portions Copyright 2003 IBM Corporation.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted only as authorized by the OpenLDAP
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>.
19 * This work was initially developed by Kurt Zeilenga for inclusion
20 * in OpenLDAP Software. Additional signficant contributors include
22 * Hallvard B. Furuseth
31 #include <ac/stdlib.h>
33 #include <ac/string.h>
34 #include <ac/socket.h>
35 #include <ac/unistd.h>
37 #include "slapcommon.h"
40 tool_vars tool_globals;
43 static char *leakfilename;
44 static FILE *leakfile;
48 usage( int tool, const char *progname )
52 "usage: %s [-v] [-d debuglevel] [-f configfile] [-F configdir]",
57 options = "\n\t[-U authcID | -D authcDN]"
58 " -b DN -o <var>[=<val>] [-u]"
59 "\n\t[attr[/access][:value]] [...]\n";
63 options = " [-c]\n\t[-n databasenumber | -b suffix]\n"
64 "\t[-l ldiffile] [-q] [-u] [-w]\n";
68 options = "\n\t[-U authcID] [-X authzID] [-R realm] [-M mech] ID [...]\n";
72 options = " [-c]\n\t[-n databasenumber | -b suffix]"
73 " [-l ldiffile] [-a filter]\n";
77 options = " DN [...]\n";
81 options = " [-c]\n\t[-n databasenumber | -b suffix] [-q]\n";
89 if ( options != NULL ) {
90 fputs( options, stderr );
101 p = strchr( optarg, '=' );
109 if ( strncasecmp( optarg, "sockurl", len ) == 0 ) {
110 if ( !BER_BVISNULL( &listener_url ) ) {
111 ber_memfree( listener_url.bv_val );
113 ber_str2bv( p, 0, 1, &listener_url );
115 } else if ( strncasecmp( optarg, "domain", len ) == 0 ) {
116 if ( !BER_BVISNULL( &peer_domain ) ) {
117 ber_memfree( peer_domain.bv_val );
119 ber_str2bv( p, 0, 1, &peer_domain );
121 } else if ( strncasecmp( optarg, "peername", len ) == 0 ) {
122 if ( !BER_BVISNULL( &peer_name ) ) {
123 ber_memfree( peer_name.bv_val );
125 ber_str2bv( p, 0, 1, &peer_name );
127 } else if ( strncasecmp( optarg, "sockname", len ) == 0 ) {
128 if ( !BER_BVISNULL( &sock_name ) ) {
129 ber_memfree( sock_name.bv_val );
131 ber_str2bv( p, 0, 1, &sock_name );
133 } else if ( strncasecmp( optarg, "ssf", len ) == 0 ) {
136 } else if ( strncasecmp( optarg, "transport_ssf", len ) == 0 ) {
137 transport_ssf = atoi( p );
139 } else if ( strncasecmp( optarg, "tls_ssf", len ) == 0 ) {
142 } else if ( strncasecmp( optarg, "sasl_ssf", len ) == 0 ) {
143 sasl_ssf = atoi( p );
153 * slap_tool_init - initialize slap utility, handle program options.
157 * argc, argv command line arguments
162 const char* progname,
164 int argc, char **argv )
167 char *conffile = SLAPD_DEFAULT_CONFIGFILE;
168 char *confdir = SLAPD_DEFAULT_CONFIGDIR;
169 struct berval base = BER_BVNULL;
170 char *filterstr = NULL;
171 char *subtree = NULL;
172 char *ldiffile = NULL;
174 int mode = SLAP_TOOL_MODE;
175 int truncatemode = 0;
178 leakfilename = malloc( strlen( progname ) + STRLENOF( ".leak" ) + 1 );
179 sprintf( leakfilename, "%s.leak", progname );
180 if( ( leakfile = fopen( leakfilename, "w" )) == NULL ) {
183 free( leakfilename );
188 options = "b:cd:f:F:l:n:qtuvw";
192 options = "a:b:cd:f:F:l:n:s:v";
193 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
198 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
202 options = "d:f:F:uv";
203 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
207 options = "d:f:F:M:R:U:vX:";
208 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
212 options = "b:cd:f:F:n:qv";
213 mode |= SLAP_TOOL_READMAIN;
217 options = "b:D:d:f:F:o:uU:v";
218 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
222 fprintf( stderr, "%s: unknown tool mode (%d)\n", progname, tool );
223 exit( EXIT_FAILURE );
227 while ( (i = getopt( argc, argv, options )) != EOF ) {
230 filterstr = strdup( optarg );
234 ber_str2bv( optarg, 0, 1, &base );
237 case 'c': /* enable continue mode */
241 case 'd': /* turn on debugging */
242 ldap_debug += atoi( optarg );
246 ber_str2bv( optarg, 0, 1, &authcDN );
249 case 'f': /* specify a conf file */
250 conffile = strdup( optarg );
253 case 'F': /* specify a conf dir */
254 confdir = strdup( optarg );
257 case 'l': /* LDIF file */
258 ldiffile = strdup( optarg );
262 ber_str2bv( optarg, 0, 0, &mech );
265 case 'n': /* which config file db to index */
266 dbnum = atoi( optarg );
270 if ( parse_slapacl() ) {
271 usage( tool, progname );
275 case 'q': /* turn on quick */
276 mode |= SLAP_TOOL_QUICK;
283 case 's': /* dump subtree */
284 subtree = strdup( optarg );
287 case 't': /* turn on truncate */
289 mode |= SLAP_TRUNCATE_MODE;
293 ber_str2bv( optarg, 0, 0, &authcID );
296 case 'u': /* dry run */
300 case 'v': /* turn on verbose */
304 case 'w': /* write context csn at the end */
309 ber_str2bv( optarg, 0, 0, &authzID );
313 usage( tool, progname );
322 if ( ( argc != optind ) || (dbnum >= 0 && base.bv_val != NULL ) ) {
323 usage( tool, progname );
329 if ( argc == optind ) {
330 usage( tool, progname );
335 if ( argc == optind && BER_BVISNULL( &authcID ) ) {
336 usage( tool, progname );
341 if ( argc != optind ) {
342 usage( tool, progname );
347 if ( !BER_BVISNULL( &authcDN ) && !BER_BVISNULL( &authcID ) ) {
348 usage( tool, progname );
350 if ( BER_BVISNULL( &base ) ) {
351 usage( tool, progname );
353 ber_dupbv( &baseDN, &base );
362 if ( ldiffile == NULL ) {
363 ldiffp = tool == SLAPCAT ? stdout : stdin;
365 } else if ((ldiffp = fopen( ldiffile, tool == SLAPCAT ? "w" : "r" ))
369 exit( EXIT_FAILURE );
373 * initialize stuff and figure out which backend we're dealing with
377 if ( module_init() != 0 ) {
378 fprintf( stderr, "%s: module_init failed!\n", progname );
379 exit( EXIT_FAILURE );
383 rc = slap_schema_init();
386 fprintf( stderr, "%s: slap_schema_init failed!\n", progname );
387 exit( EXIT_FAILURE );
390 rc = slap_init( mode, progname );
393 fprintf( stderr, "%s: slap_init failed!\n", progname );
394 exit( EXIT_FAILURE );
397 if ( frontend_init() ) {
398 fprintf( stderr, "%s: frontend_init failed!\n", progname );
399 exit( EXIT_FAILURE );
402 if ( overlay_init() ) {
403 fprintf( stderr, "%s: overlay_init failed!\n", progname );
404 exit( EXIT_FAILURE );
407 rc = read_config( conffile, confdir );
410 fprintf( stderr, "%s: bad configuration file!\n", progname );
411 exit( EXIT_FAILURE );
421 fprintf( stderr, "No databases found "
422 "in config file\n" );
423 exit( EXIT_FAILURE );
431 rc = slap_schema_check();
434 fprintf( stderr, "%s: slap_schema_prep failed!\n", progname );
435 exit( EXIT_FAILURE );
450 filter = str2filter( filterstr );
452 if( filter == NULL ) {
453 fprintf( stderr, "Invalid filter '%s'\n", filterstr );
454 exit( EXIT_FAILURE );
460 ber_str2bv( subtree, 0, 0, &val );
461 rc = dnNormalize( 0, NULL, NULL, &val, &sub_ndn, NULL );
462 if( rc != LDAP_SUCCESS ) {
463 fprintf( stderr, "Invalid subtree DN '%s'\n", subtree );
464 exit( EXIT_FAILURE );
467 if ( BER_BVISNULL( &base ) && dbnum == -1 ) {
474 if( base.bv_val != NULL ) {
477 rc = dnNormalize( 0, NULL, NULL, &base, &nbase, NULL );
478 if( rc != LDAP_SUCCESS ) {
479 fprintf( stderr, "%s: slap_init invalid suffix (\"%s\")\n",
480 progname, base.bv_val );
481 exit( EXIT_FAILURE );
484 be = select_backend( &nbase, 0, 0 );
485 ber_memfree( nbase.bv_val );
496 fprintf( stderr, "%s: slap_init no backend for \"%s\"\n",
497 progname, base.bv_val );
498 exit( EXIT_FAILURE );
500 /* If the named base is a glue master, operate on the
503 if (SLAP_GLUE_INSTANCE(be)) {
507 } else if ( dbnum == -1 ) {
508 if ( nbackends <= 0 ) {
509 fprintf( stderr, "No available databases\n" );
510 exit( EXIT_FAILURE );
512 LDAP_STAILQ_FOREACH( be, &backendDB, be_next ) {
514 if ( dbnum < 1 ) continue;
516 if ( SLAP_MONITOR(be))
519 /* If just doing the first by default and it is a
520 * glue subordinate, find the master.
522 if ( SLAP_GLUE_SUBORDINATE(be) ) {
530 fprintf( stderr, "Available database(s) "
531 "do not allow %s\n", progname );
532 exit( EXIT_FAILURE );
535 if ( nosubordinates == 0 && dbnum > 0 ) {
536 Debug( LDAP_DEBUG_ANY,
537 "The first database does not allow %s;"
538 " using the first available one (%d)\n",
539 progname, dbnum + 1, 0 );
542 } else if ( dbnum < 0 || dbnum > (nbackends-1) ) {
544 "Database number selected via -n is out of range\n"
545 "Must be in the range 1 to %d"
546 " (number of databases in the config file)\n",
548 exit( EXIT_FAILURE );
551 LDAP_STAILQ_FOREACH( be, &backendDB, be_next ) {
552 if ( dbnum == 0 ) break;
563 if ( !dryrun && slap_startup( be ) ) {
567 fprintf( stderr, "slap_startup failed "
568 "(test would succeed using "
569 "the -u switch)\n" );
573 fprintf( stderr, "slap_startup failed\n" );
577 exit( EXIT_FAILURE );
581 void slap_tool_destroy( void )
588 if ( slapMode == SLAP_SERVER_MODE ) {
589 /* always false. just pulls in necessary symbol references. */
590 lutil_uuidstr(NULL, 0);
596 ldap_pvt_tls_destroy();
601 mal_dumpleaktrace( leakfile );
604 if ( !BER_BVISNULL( &authcDN ) ) {
605 ch_free( authcDN.bv_val );