1 /* slapcommon.c - common routine for the slap tools */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2010 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;
50 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
52 static char **syslog_unknowns;
54 static int syslogUser = SLAP_DEFAULT_SYSLOG_USER;
55 #endif /* LOG_LOCAL4 */
56 #endif /* LDAP_DEBUG && LDAP_SYSLOG */
59 usage( int tool, const char *progname )
63 "usage: %s [-v] [-d debuglevel] [-f configfile] [-F configdir] [-o <name>[=<value>]]",
68 options = "\n\t[-U authcID | -D authcDN] [-X authzID | -o authzDN=<DN>]"
69 "\n\t-b DN [-u] [attr[/access][:value]] [...]\n";
73 options = " [-c]\n\t[-g] [-n databasenumber | -b suffix]\n"
74 "\t[-l ldiffile] [-j linenumber] [-q] [-u] [-s] [-w]\n";
78 options = "\n\t[-U authcID] [-X authzID] [-R realm] [-M mech] ID [...]\n";
82 options = " [-c]\n\t[-g] [-n databasenumber | -b suffix]"
83 " [-l ldiffile] [-a filter] [-s subtree] [-H url]\n";
87 options = "\n\t[-N | -P] DN [...]\n";
91 options = " [-c]\n\t[-g] [-n databasenumber | -b suffix] [attr ...] [-q] [-t]\n";
95 options = " [-n databasenumber] [-u]\n";
99 options = " [-c]\n\t[-g] [-n databasenumber | -b suffix]"
100 " [-l errorfile] [-a filter] [-s subtree] [-H url]\n";
104 if ( options != NULL ) {
105 fputs( options, stderr );
107 exit( EXIT_FAILURE );
111 parse_slapopt( int tool, int *mode )
116 p = strchr( optarg, '=' );
122 if ( strncasecmp( optarg, "sockurl", len ) == 0 ) {
123 if ( !BER_BVISNULL( &listener_url ) ) {
124 ber_memfree( listener_url.bv_val );
126 ber_str2bv( p, 0, 1, &listener_url );
128 } else if ( strncasecmp( optarg, "domain", len ) == 0 ) {
129 if ( !BER_BVISNULL( &peer_domain ) ) {
130 ber_memfree( peer_domain.bv_val );
132 ber_str2bv( p, 0, 1, &peer_domain );
134 } else if ( strncasecmp( optarg, "peername", len ) == 0 ) {
135 if ( !BER_BVISNULL( &peer_name ) ) {
136 ber_memfree( peer_name.bv_val );
138 ber_str2bv( p, 0, 1, &peer_name );
140 } else if ( strncasecmp( optarg, "sockname", len ) == 0 ) {
141 if ( !BER_BVISNULL( &sock_name ) ) {
142 ber_memfree( sock_name.bv_val );
144 ber_str2bv( p, 0, 1, &sock_name );
146 } else if ( strncasecmp( optarg, "ssf", len ) == 0 ) {
147 if ( lutil_atou( &ssf, p ) ) {
148 Debug( LDAP_DEBUG_ANY, "unable to parse ssf=\"%s\".\n", p, 0, 0 );
152 } else if ( strncasecmp( optarg, "transport_ssf", len ) == 0 ) {
153 if ( lutil_atou( &transport_ssf, p ) ) {
154 Debug( LDAP_DEBUG_ANY, "unable to parse transport_ssf=\"%s\".\n", p, 0, 0 );
158 } else if ( strncasecmp( optarg, "tls_ssf", len ) == 0 ) {
159 if ( lutil_atou( &tls_ssf, p ) ) {
160 Debug( LDAP_DEBUG_ANY, "unable to parse tls_ssf=\"%s\".\n", p, 0, 0 );
164 } else if ( strncasecmp( optarg, "sasl_ssf", len ) == 0 ) {
165 if ( lutil_atou( &sasl_ssf, p ) ) {
166 Debug( LDAP_DEBUG_ANY, "unable to parse sasl_ssf=\"%s\".\n", p, 0, 0 );
170 } else if ( strncasecmp( optarg, "authzDN", len ) == 0 ) {
171 ber_str2bv( p, 0, 1, &authzDN );
173 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
174 } else if ( strncasecmp( optarg, "syslog", len ) == 0 ) {
175 if ( parse_debug_level( p, &ldap_syslog, &syslog_unknowns ) ) {
180 } else if ( strncasecmp( optarg, "syslog-level", len ) == 0 ) {
181 if ( parse_syslog_level( p, &ldap_syslog_level ) ) {
187 } else if ( strncasecmp( optarg, "syslog-user", len ) == 0 ) {
188 if ( parse_syslog_user( p, &syslogUser ) ) {
192 #endif /* LOG_LOCAL4 */
193 #endif /* LDAP_DEBUG && LDAP_SYSLOG */
195 } else if ( strncasecmp( optarg, "schema-check", len ) == 0 ) {
198 if ( strcasecmp( p, "yes" ) == 0 ) {
199 *mode &= ~SLAP_TOOL_NO_SCHEMA_CHECK;
200 } else if ( strcasecmp( p, "no" ) == 0 ) {
201 *mode |= SLAP_TOOL_NO_SCHEMA_CHECK;
203 Debug( LDAP_DEBUG_ANY, "unable to parse schema-check=\"%s\".\n", p, 0, 0 );
209 Debug( LDAP_DEBUG_ANY, "schema-check meaningless for tool.\n", 0, 0, 0 );
213 } else if ( strncasecmp( optarg, "value-check", len ) == 0 ) {
216 if ( strcasecmp( p, "yes" ) == 0 ) {
217 *mode |= SLAP_TOOL_VALUE_CHECK;
218 } else if ( strcasecmp( p, "no" ) == 0 ) {
219 *mode &= ~SLAP_TOOL_VALUE_CHECK;
221 Debug( LDAP_DEBUG_ANY, "unable to parse value-check=\"%s\".\n", p, 0, 0 );
227 Debug( LDAP_DEBUG_ANY, "value-check meaningless for tool.\n", 0, 0, 0 );
239 * slap_tool_init - initialize slap utility, handle program options.
243 * argc, argv command line arguments
246 static int need_shutdown;
250 const char* progname,
252 int argc, char **argv )
255 char *conffile = NULL;
256 char *confdir = NULL;
257 struct berval base = BER_BVNULL;
258 char *filterstr = NULL;
259 char *subtree = NULL;
260 char *ldiffile = NULL;
261 char **debug_unknowns = NULL;
263 int mode = SLAP_TOOL_MODE;
264 int truncatemode = 0;
269 /* tools default to "none", so that at least LDAP_DEBUG_ANY
270 * messages show up; use -d 0 to reset */
271 slap_debug = LDAP_DEBUG_NONE;
272 ldif_debug = slap_debug;
277 leakfilename = malloc( strlen( progname ) + STRLENOF( ".leak" ) + 1 );
278 sprintf( leakfilename, "%s.leak", progname );
279 if( ( leakfile = fopen( leakfilename, "w" )) == NULL ) {
282 free( leakfilename );
286 scope = LDAP_SCOPE_DEFAULT;
290 options = "b:cd:f:F:gj:l:n:o:qsS:uvw";
294 options = "a:b:cd:f:F:gH:l:n:o:s:v";
295 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
299 options = "d:f:F:No:Pv";
300 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
304 options = "a:b:cd:f:F:gH:l:n:o:s:v";
305 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
309 options = "d:f:F:n:o:Quv";
310 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
314 options = "d:f:F:M:o:R:U:vX:";
315 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
319 options = "b:cd:f:F:gn:o:qtv";
320 mode |= SLAP_TOOL_READMAIN;
324 options = "b:D:d:f:F:o:uU:vX:";
325 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
329 fprintf( stderr, "%s: unknown tool mode (%d)\n", progname, tool );
330 exit( EXIT_FAILURE );
334 while ( (i = getopt( argc, argv, options )) != EOF ) {
337 filterstr = ch_strdup( optarg );
341 ber_str2bv( optarg, 0, 1, &base );
344 case 'c': /* enable continue mode */
348 case 'd': { /* turn on debugging */
351 if ( parse_debug_level( optarg, &level, &debug_unknowns ) ) {
352 usage( tool, progname );
356 /* allow to reset log level */
364 fputs( "must compile with LDAP_DEBUG for debugging\n",
370 ber_str2bv( optarg, 0, 1, &authcDN );
373 case 'f': /* specify a conf file */
374 conffile = ch_strdup( optarg );
377 case 'F': /* specify a conf dir */
378 confdir = ch_strdup( optarg );
381 case 'g': /* disable subordinate glue */
389 rc = ldap_url_parse_ext( optarg, &ludp,
390 LDAP_PVT_URL_PARSE_NOEMPTY_HOST | LDAP_PVT_URL_PARSE_NOEMPTY_DN );
391 if ( rc != LDAP_URL_SUCCESS ) {
392 usage( tool, progname );
395 /* don't accept host, port, attrs, extensions */
396 if ( ldap_pvt_url_scheme2proto( ludp->lud_scheme ) != LDAP_PROTO_TCP ) {
397 usage( tool, progname );
400 if ( ludp->lud_host != NULL ) {
401 usage( tool, progname );
404 if ( ludp->lud_port != 0 ) {
405 usage( tool, progname );
408 if ( ludp->lud_attrs != NULL ) {
409 usage( tool, progname );
412 if ( ludp->lud_exts != NULL ) {
413 usage( tool, progname );
416 if ( ludp->lud_dn != NULL && ludp->lud_dn[0] != '\0' ) {
417 subtree = ludp->lud_dn;
421 if ( ludp->lud_filter != NULL && ludp->lud_filter[0] != '\0' ) {
422 filterstr = ludp->lud_filter;
423 ludp->lud_filter = NULL;
426 scope = ludp->lud_scope;
428 ldap_free_urldesc( ludp );
431 case 'j': /* jump to linenumber */
432 if ( lutil_atoi( &jumpline, optarg ) ) {
433 usage( tool, progname );
437 case 'l': /* LDIF file */
438 ldiffile = ch_strdup( optarg );
442 ber_str2bv( optarg, 0, 0, &mech );
446 if ( dn_mode && dn_mode != SLAP_TOOL_LDAPDN_NORMAL ) {
447 usage( tool, progname );
449 dn_mode = SLAP_TOOL_LDAPDN_NORMAL;
452 case 'n': /* which config file db to index */
453 if ( lutil_atoi( &dbnum, optarg ) || dbnum < 0 ) {
454 usage( tool, progname );
459 if ( parse_slapopt( tool, &mode ) ) {
460 usage( tool, progname );
465 if ( dn_mode && dn_mode != SLAP_TOOL_LDAPDN_PRETTY ) {
466 usage( tool, progname );
468 dn_mode = SLAP_TOOL_LDAPDN_PRETTY;
476 case 'q': /* turn on quick */
477 mode |= SLAP_TOOL_QUICK;
485 if ( lutil_atou( &csnsid, optarg )
486 || csnsid > SLAP_SYNC_SID_MAX )
488 usage( tool, progname );
496 /* no schema check */
497 mode |= SLAP_TOOL_NO_SCHEMA_CHECK;
503 subtree = ch_strdup( optarg );
508 case 't': /* turn on truncate */
510 mode |= SLAP_TRUNCATE_MODE;
514 ber_str2bv( optarg, 0, 0, &authcID );
517 case 'u': /* dry run */
521 case 'v': /* turn on verbose */
525 case 'w': /* write context csn at the end */
530 ber_str2bv( optarg, 0, 0, &authzID );
534 usage( tool, progname );
539 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
540 if ( start_syslog ) {
543 logName = ch_strdup( progname );
546 logName = (char *)progname;
550 openlog( logName, OPENLOG_OPTIONS, syslogUser );
551 #elif defined LOG_DEBUG
552 openlog( logName, OPENLOG_OPTIONS );
559 #endif /* LDAP_DEBUG && LDAP_SYSLOG */
576 if ( ( argc != optind ) || (dbnum >= 0 && base.bv_val != NULL ) ) {
577 usage( tool, progname );
583 if ( dbnum >= 0 && base.bv_val != NULL ) {
584 usage( tool, progname );
590 if ( argc == optind ) {
591 usage( tool, progname );
596 if ( argc == optind && BER_BVISNULL( &authcID ) ) {
597 usage( tool, progname );
602 if ( argc != optind ) {
603 usage( tool, progname );
608 if ( !BER_BVISNULL( &authcDN ) && !BER_BVISNULL( &authcID ) ) {
609 usage( tool, progname );
611 if ( BER_BVISNULL( &base ) ) {
612 usage( tool, progname );
614 ber_dupbv( &baseDN, &base );
621 if ( ldiffile == NULL ) {
622 dummy.fp = writer ? stdout : stdin;
625 } else if ((ldiffp = ldif_open( ldiffile, writer ? "w" : "r" ))
629 exit( EXIT_FAILURE );
633 * initialize stuff and figure out which backend we're dealing with
636 rc = slap_init( mode, progname );
638 fprintf( stderr, "%s: slap_init failed!\n", progname );
639 exit( EXIT_FAILURE );
642 rc = read_config( conffile, confdir );
645 fprintf( stderr, "%s: bad configuration %s!\n",
646 progname, confdir ? "directory" : "file" );
647 exit( EXIT_FAILURE );
650 if ( debug_unknowns ) {
651 rc = parse_debug_unknowns( debug_unknowns, &slap_debug );
652 ldap_charray_free( debug_unknowns );
653 debug_unknowns = NULL;
655 exit( EXIT_FAILURE );
658 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
659 if ( syslog_unknowns ) {
660 rc = parse_debug_unknowns( syslog_unknowns, &ldap_syslog );
661 ldap_charray_free( syslog_unknowns );
662 syslog_unknowns = NULL;
664 exit( EXIT_FAILURE );
676 fprintf( stderr, "No databases found "
677 "in config file\n" );
678 exit( EXIT_FAILURE );
687 rc = glue_sub_attach( 0 );
691 "%s: subordinate configuration error\n", progname );
692 exit( EXIT_FAILURE );
696 rc = slap_schema_check();
699 fprintf( stderr, "%s: slap_schema_prep failed!\n", progname );
700 exit( EXIT_FAILURE );
718 filter = str2filter( filterstr );
720 if( filter == NULL ) {
721 fprintf( stderr, "Invalid filter '%s'\n", filterstr );
722 exit( EXIT_FAILURE );
725 ch_free( filterstr );
731 ber_str2bv( subtree, 0, 0, &val );
732 rc = dnNormalize( 0, NULL, NULL, &val, &sub_ndn, NULL );
733 if( rc != LDAP_SUCCESS ) {
734 fprintf( stderr, "Invalid subtree DN '%s'\n", subtree );
735 exit( EXIT_FAILURE );
738 if ( BER_BVISNULL( &base ) && dbnum == -1 ) {
746 if( base.bv_val != NULL ) {
749 rc = dnNormalize( 0, NULL, NULL, &base, &nbase, NULL );
750 if( rc != LDAP_SUCCESS ) {
751 fprintf( stderr, "%s: slap_init invalid suffix (\"%s\")\n",
752 progname, base.bv_val );
753 exit( EXIT_FAILURE );
756 be = select_backend( &nbase, 0 );
757 ber_memfree( nbase.bv_val );
758 BER_BVZERO( &nbase );
769 fprintf( stderr, "%s: slap_init no backend for \"%s\"\n",
770 progname, base.bv_val );
771 exit( EXIT_FAILURE );
773 /* If the named base is a glue master, operate on the
776 if ( SLAP_GLUE_INSTANCE( be ) ) {
780 ch_free( base.bv_val );
783 } else if ( dbnum == -1 ) {
784 /* no suffix and no dbnum specified, just default to
785 * the first available database
787 if ( nbackends <= 0 ) {
788 fprintf( stderr, "No available databases\n" );
789 exit( EXIT_FAILURE );
791 LDAP_STAILQ_FOREACH( be, &backendDB, be_next ) {
794 /* db #0 is cn=config, don't select it as a default */
795 if ( dbnum < 1 ) continue;
797 if ( SLAP_MONITOR(be))
800 /* If just doing the first by default and it is a
801 * glue subordinate, find the master.
803 if ( SLAP_GLUE_SUBORDINATE(be) ) {
811 fprintf( stderr, "Available database(s) "
812 "do not allow %s\n", progname );
813 exit( EXIT_FAILURE );
816 if ( nosubordinates == 0 && dbnum > 1 ) {
817 Debug( LDAP_DEBUG_ANY,
818 "The first database does not allow %s;"
819 " using the first available one (%d)\n",
820 progname, dbnum, 0 );
823 } else if ( dbnum >= nbackends ) {
825 "Database number selected via -n is out of range\n"
826 "Must be in the range 0 to %d"
827 " (the number of configured databases)\n",
829 exit( EXIT_FAILURE );
833 LDAP_STAILQ_FOREACH( be, &backendDB, be_next ) {
834 if ( dbnum == 0 ) break;
839 if ( scope != LDAP_SCOPE_DEFAULT && BER_BVISNULL( &sub_ndn ) ) {
840 if ( be && be->be_nsuffix ) {
841 ber_dupbv( &sub_ndn, be->be_nsuffix );
845 "<scope> needs a DN or a valid database\n" );
846 exit( EXIT_FAILURE );
855 LDAP_STAILQ_FOREACH( bdtmp, &backendDB, be_next ) {
856 if ( bdtmp == be ) break;
865 if ( conffile != NULL ) {
870 if ( confdir != NULL ) {
875 if ( ldiffile != NULL ) {
880 /* slapdn doesn't specify a backend to startup */
881 if ( !dryrun && tool != SLAPDN ) {
884 if ( slap_startup( be ) ) {
887 fprintf( stderr, "slap_startup failed "
888 "(test would succeed using "
889 "the -u switch)\n" );
893 fprintf( stderr, "slap_startup failed\n" );
897 exit( EXIT_FAILURE );
902 int slap_tool_destroy( void )
906 if ( need_shutdown ) {
907 if ( slap_shutdown( be ))
914 if ( slapMode == SLAP_SERVER_MODE ) {
915 /* always false. just pulls in necessary symbol references. */
916 lutil_uuidstr(NULL, 0);
922 ldap_pvt_tls_destroy();
927 mal_dumpleaktrace( leakfile );
930 if ( !BER_BVISNULL( &authcDN ) ) {
931 ch_free( authcDN.bv_val );
932 BER_BVZERO( &authcDN );
935 if ( ldiffp && ldiffp != &dummy ) {
936 ldif_close( ldiffp );