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"
41 tool_vars tool_globals;
44 static char *leakfilename;
45 static FILE *leakfile;
51 usage( int tool, const char *progname )
55 "usage: %s [-v] [-d debuglevel] [-f configfile] [-F configdir]",
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";
65 options = " [-c]\n\t[-g] [-n databasenumber | -b suffix]\n"
66 "\t[-l ldiffile] [-q] [-u] [-w]\n";
70 options = "\n\t[-U authcID] [-X authzID] [-R realm] [-M mech] ID [...]\n";
74 options = " [-c]\n\t[-g] [-n databasenumber | -b suffix]"
75 " [-l ldiffile] [-a filter]\n";
79 options = "\n\t[-N | -P] DN [...]\n";
83 options = " [-c]\n\t[-g] [-n databasenumber | -b suffix] [-q]\n";
91 if ( options != NULL ) {
92 fputs( options, stderr );
103 p = strchr( optarg, '=' );
111 if ( strncasecmp( optarg, "sockurl", len ) == 0 ) {
112 if ( !BER_BVISNULL( &listener_url ) ) {
113 ber_memfree( listener_url.bv_val );
115 ber_str2bv( p, 0, 1, &listener_url );
117 } else if ( strncasecmp( optarg, "domain", len ) == 0 ) {
118 if ( !BER_BVISNULL( &peer_domain ) ) {
119 ber_memfree( peer_domain.bv_val );
121 ber_str2bv( p, 0, 1, &peer_domain );
123 } else if ( strncasecmp( optarg, "peername", len ) == 0 ) {
124 if ( !BER_BVISNULL( &peer_name ) ) {
125 ber_memfree( peer_name.bv_val );
127 ber_str2bv( p, 0, 1, &peer_name );
129 } else if ( strncasecmp( optarg, "sockname", len ) == 0 ) {
130 if ( !BER_BVISNULL( &sock_name ) ) {
131 ber_memfree( sock_name.bv_val );
133 ber_str2bv( p, 0, 1, &sock_name );
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 );
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 );
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 );
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 );
159 } else if ( strncasecmp( optarg, "authzDN", len ) == 0 ) {
160 ber_str2bv( p, 0, 1, &authzDN );
170 * slap_tool_init - initialize slap utility, handle program options.
174 * argc, argv command line arguments
179 const char* progname,
181 int argc, char **argv )
184 char *conffile = NULL;
185 char *confdir = NULL;
186 struct berval base = BER_BVNULL;
187 char *filterstr = NULL;
188 char *subtree = NULL;
189 char *ldiffile = NULL;
191 int mode = SLAP_TOOL_MODE;
192 int truncatemode = 0;
196 /* tools default to "none", so that at least LDAP_DEBUG_ANY
197 * messages show up; use -d 0 to reset */
198 slap_debug = LDAP_DEBUG_NONE;
202 leakfilename = malloc( strlen( progname ) + STRLENOF( ".leak" ) + 1 );
203 sprintf( leakfilename, "%s.leak", progname );
204 if( ( leakfile = fopen( leakfilename, "w" )) == NULL ) {
207 free( leakfilename );
212 options = "b:cd:f:F:gl:n:qtuvw";
216 options = "a:b:cd:f:F:gl:n:s:v";
217 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
221 options = "d:f:F:NPv";
222 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
226 options = "d:f:F:uv";
227 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
231 options = "d:f:F:M:R:U:vX:";
232 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
236 options = "b:cd:f:F:gn:qv";
237 mode |= SLAP_TOOL_READMAIN;
241 options = "b:D:d:f:F:o:uU:vX:";
242 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
246 fprintf( stderr, "%s: unknown tool mode (%d)\n", progname, tool );
247 exit( EXIT_FAILURE );
251 while ( (i = getopt( argc, argv, options )) != EOF ) {
254 filterstr = strdup( optarg );
258 ber_str2bv( optarg, 0, 1, &base );
261 case 'c': /* enable continue mode */
265 case 'd': /* turn on debugging */
267 if ( optarg != NULL && optarg[ 0 ] != '-' && !isdigit( optarg[ 0 ] ) )
269 int level, i, goterr = 0;
272 levels = ldap_str2charray( optarg, "," );
274 for ( i = 0; levels[ i ] != NULL; i++ ) {
275 if ( str2loglevel( levels[ i ], &level ) ) {
277 "unrecognized log level "
278 "\"%s\"\n", levels[ i ] );
285 /* allow to reset log level */
291 ldap_charray_free( levels );
294 usage( tool, progname );
300 if ( lutil_atoix( &level, optarg, 0 ) != 0 ) {
302 "unrecognized log level "
303 "\"%s\"\n", optarg );
304 usage( tool, progname );
310 /* allow to reset log level */
315 if ( lutil_atoi( &level, optarg ) != 0 || level != 0 )
316 fputs( "must compile with LDAP_DEBUG for debugging\n",
322 ber_str2bv( optarg, 0, 1, &authcDN );
325 case 'f': /* specify a conf file */
326 conffile = strdup( optarg );
329 case 'F': /* specify a conf dir */
330 confdir = strdup( optarg );
333 case 'g': /* disable subordinate glue */
337 case 'l': /* LDIF file */
338 ldiffile = strdup( optarg );
342 ber_str2bv( optarg, 0, 0, &mech );
346 if ( dn_mode && dn_mode != SLAP_TOOL_LDAPDN_NORMAL ) {
347 usage( tool, progname );
349 dn_mode = SLAP_TOOL_LDAPDN_NORMAL;
352 case 'n': /* which config file db to index */
353 if ( lutil_atoi( &dbnum, optarg ) ) {
354 usage( tool, progname );
359 if ( parse_slapacl() ) {
360 usage( tool, progname );
365 if ( dn_mode && dn_mode != SLAP_TOOL_LDAPDN_PRETTY ) {
366 usage( tool, progname );
368 dn_mode = SLAP_TOOL_LDAPDN_PRETTY;
371 case 'q': /* turn on quick */
372 mode |= SLAP_TOOL_QUICK;
379 case 's': /* dump subtree */
380 subtree = strdup( optarg );
383 case 't': /* turn on truncate */
385 mode |= SLAP_TRUNCATE_MODE;
389 ber_str2bv( optarg, 0, 0, &authcID );
392 case 'u': /* dry run */
396 case 'v': /* turn on verbose */
400 case 'w': /* write context csn at the end */
405 ber_str2bv( optarg, 0, 0, &authzID );
409 usage( tool, progname );
418 if ( ( argc != optind ) || (dbnum >= 0 && base.bv_val != NULL ) ) {
419 usage( tool, progname );
425 if ( argc == optind ) {
426 usage( tool, progname );
431 if ( argc == optind && BER_BVISNULL( &authcID ) ) {
432 usage( tool, progname );
437 if ( argc != optind ) {
438 usage( tool, progname );
443 if ( !BER_BVISNULL( &authcDN ) && !BER_BVISNULL( &authcID ) ) {
444 usage( tool, progname );
446 if ( BER_BVISNULL( &base ) ) {
447 usage( tool, progname );
449 ber_dupbv( &baseDN, &base );
458 if ( ldiffile == NULL ) {
459 dummy.fp = tool == SLAPCAT ? stdout : stdin;
462 } else if ((ldiffp = ldif_open( ldiffile, tool == SLAPCAT ? "w" : "r" ))
466 exit( EXIT_FAILURE );
470 * initialize stuff and figure out which backend we're dealing with
473 rc = slap_init( mode, progname );
475 fprintf( stderr, "%s: slap_init failed!\n", progname );
476 exit( EXIT_FAILURE );
479 rc = read_config( conffile, confdir );
482 fprintf( stderr, "%s: bad configuration %s!\n",
483 progname, confdir ? "directory" : "file" );
484 exit( EXIT_FAILURE );
494 fprintf( stderr, "No databases found "
495 "in config file\n" );
496 exit( EXIT_FAILURE );
505 rc = glue_sub_attach();
509 "%s: subordinate configuration error\n", progname );
510 exit( EXIT_FAILURE );
514 rc = slap_schema_check();
517 fprintf( stderr, "%s: slap_schema_prep failed!\n", progname );
518 exit( EXIT_FAILURE );
533 filter = str2filter( filterstr );
535 if( filter == NULL ) {
536 fprintf( stderr, "Invalid filter '%s'\n", filterstr );
537 exit( EXIT_FAILURE );
543 ber_str2bv( subtree, 0, 0, &val );
544 rc = dnNormalize( 0, NULL, NULL, &val, &sub_ndn, NULL );
545 if( rc != LDAP_SUCCESS ) {
546 fprintf( stderr, "Invalid subtree DN '%s'\n", subtree );
547 exit( EXIT_FAILURE );
550 if ( BER_BVISNULL( &base ) && dbnum == -1 ) {
557 if( base.bv_val != NULL ) {
560 rc = dnNormalize( 0, NULL, NULL, &base, &nbase, NULL );
561 if( rc != LDAP_SUCCESS ) {
562 fprintf( stderr, "%s: slap_init invalid suffix (\"%s\")\n",
563 progname, base.bv_val );
564 exit( EXIT_FAILURE );
567 be = select_backend( &nbase, 0, 0 );
568 ber_memfree( nbase.bv_val );
579 fprintf( stderr, "%s: slap_init no backend for \"%s\"\n",
580 progname, base.bv_val );
581 exit( EXIT_FAILURE );
583 /* If the named base is a glue master, operate on the
586 if ( SLAP_GLUE_INSTANCE( be ) ) {
590 } else if ( dbnum == -1 ) {
591 /* no suffix and no dbnum specified, just default to
592 * the first available database
594 if ( nbackends <= 0 ) {
595 fprintf( stderr, "No available databases\n" );
596 exit( EXIT_FAILURE );
598 LDAP_STAILQ_FOREACH( be, &backendDB, be_next ) {
601 /* db #0 is cn=config, don't select it as a default */
602 if ( dbnum < 1 ) continue;
604 if ( SLAP_MONITOR(be))
607 /* If just doing the first by default and it is a
608 * glue subordinate, find the master.
610 if ( SLAP_GLUE_SUBORDINATE(be) ) {
618 fprintf( stderr, "Available database(s) "
619 "do not allow %s\n", progname );
620 exit( EXIT_FAILURE );
623 if ( nosubordinates == 0 && dbnum > 1 ) {
624 Debug( LDAP_DEBUG_ANY,
625 "The first database does not allow %s;"
626 " using the first available one (%d)\n",
627 progname, dbnum, 0 );
630 } else if ( dbnum < 0 || dbnum > (nbackends-1) ) {
632 "Database number selected via -n is out of range\n"
633 "Must be in the range 0 to %d"
634 " (number of configured databases)\n",
636 exit( EXIT_FAILURE );
639 LDAP_STAILQ_FOREACH( be, &backendDB, be_next ) {
640 if ( dbnum == 0 ) break;
651 if ( conffile != NULL ) {
655 if ( ldiffile != NULL ) {
659 /* slapdn doesn't specify a backend to startup */
660 if ( !dryrun && tool != SLAPDN && slap_startup( be ) ) {
663 fprintf( stderr, "slap_startup failed "
664 "(test would succeed using "
665 "the -u switch)\n" );
669 fprintf( stderr, "slap_startup failed\n" );
673 exit( EXIT_FAILURE );
677 void slap_tool_destroy( void )
684 if ( slapMode == SLAP_SERVER_MODE ) {
685 /* always false. just pulls in necessary symbol references. */
686 lutil_uuidstr(NULL, 0);
692 ldap_pvt_tls_destroy();
697 mal_dumpleaktrace( leakfile );
700 if ( !BER_BVISNULL( &authcDN ) ) {
701 ch_free( authcDN.bv_val );