2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2005 The OpenLDAP Foundation.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted only as authorized by the OpenLDAP
11 * A copy of this license is available in the file LICENSE in the
12 * top-level directory of the distribution or, alternatively, at
13 * <http://www.OpenLDAP.org/license.html>.
15 /* Portions Copyright (c) 1995 Regents of the University of Michigan.
16 * All rights reserved.
18 * Redistribution and use in source and binary forms are permitted
19 * provided that this notice is preserved and that due credit is given
20 * to the University of Michigan at Ann Arbor. The name of the University
21 * may not be used to endorse or promote products derived from this
22 * software without specific prior written permission. This software
23 * is provided ``as is'' without express or implied warranty.
31 #include <ac/socket.h>
32 #include <ac/string.h>
34 #include <ac/unistd.h>
43 #include "slapi/slapi.h"
47 static RETSIGTYPE wait4child( int sig );
50 #ifdef HAVE_NT_SERVICE_MANAGER
51 #define MAIN_RETURN(x) return
52 static struct sockaddr_in bind_addr;
54 #define SERVICE_EXIT( e, n ) do { \
55 if ( is_NT_Service ) { \
56 lutil_ServiceStatus.dwWin32ExitCode = (e); \
57 lutil_ServiceStatus.dwServiceSpecificExitCode = (n); \
62 #define SERVICE_EXIT( e, n )
63 #define MAIN_RETURN(x) return(x)
66 typedef int (MainFunc) LDAP_P(( int argc, char *argv[] ));
67 extern MainFunc slapadd, slapcat, slapdn, slapindex, slappasswd,
68 slaptest, slapauth, slapacl;
77 {"slapindex", slapindex},
78 {"slappasswd", slappasswd},
79 {"slaptest", slaptest},
80 {"slapauth", slapauth},
82 /* NOTE: new tools must be added in chronological order,
83 * not in alphabetical order, because for backwards
84 * compatibility name[4] is used to identify the
85 * tools; so name[4]=='a' must refer to "slapadd" and
86 * not to "slapauth". Alphabetical order can be used
87 * for tools whose name[4] is not used yet */
92 * when more than one slapd is running on one machine, each one might have
93 * it's own LOCAL for syslogging and must have its own pid/args files
96 #ifndef HAVE_MKVERSION
97 const char Versionstr[] =
98 OPENLDAP_PACKAGE " " OPENLDAP_VERSION " Standalone LDAP Server (slapd)";
101 #define CHECK_NONE 0x00
102 #define CHECK_CONFIG 0x01
103 static int check = CHECK_NONE;
104 static int version = 0;
109 #define DEFAULT_SYSLOG_USER LOG_LOCAL4
110 #endif /* LOG_LOCAL4 */
113 slapd_opt_slp( const char *val, void *arg )
116 /* NULL is default */
117 if ( val == NULL || strcasecmp( val, "on" ) == 0 ) {
118 slapd_register_slp = 1;
120 } else if ( strcasecmp( val, "off" ) == 0 ) {
121 slapd_register_slp = 0;
123 /* NOTE: add support for URL specification? */
126 fprintf(stderr, "unrecognized value \"%s\" for SLP option\n", val );
133 fputs( "slapd: SLP support is not available\n", stderr );
139 * Option helper structure:
141 * oh_nam is left-hand part of <option>[=<value>]
142 * oh_fnc is handler function
143 * oh_arg is an optional arg to oh_fnc
144 * oh_usage is the one-line usage string related to the option,
145 * which is assumed to start with <option>[=<value>]
147 * please leave valid options in the structure, and optionally #ifdef
148 * their processing inside the helper, so that reasonable and helpful
149 * error messages can be generated if a disabled option is requested.
151 struct option_helper {
152 struct berval oh_name;
153 int (*oh_fnc)(const char *val, void *arg);
155 const char *oh_usage;
156 } option_helpers[] = {
157 { BER_BVC("slp"), slapd_opt_slp, NULL, "slp[={on|off}] enable/disable SLP" },
158 { BER_BVNULL, 0, NULL, NULL }
163 parse_syslog_user( const char *arg, int *syslogUser )
165 static slap_verbmasks syslogUsers[] = {
166 { BER_BVC( "LOCAL0" ), LOG_LOCAL0 },
167 { BER_BVC( "LOCAL1" ), LOG_LOCAL1 },
168 { BER_BVC( "LOCAL2" ), LOG_LOCAL2 },
169 { BER_BVC( "LOCAL3" ), LOG_LOCAL3 },
170 { BER_BVC( "LOCAL4" ), LOG_LOCAL4 },
171 { BER_BVC( "LOCAL5" ), LOG_LOCAL5 },
172 { BER_BVC( "LOCAL6" ), LOG_LOCAL6 },
173 { BER_BVC( "LOCAL7" ), LOG_LOCAL7 },
175 { BER_BVC( "USER" ), LOG_USER },
176 #endif /* LOG_USER */
178 { BER_BVC( "DAEMON" ), LOG_DAEMON },
179 #endif /* LOG_DAEMON */
182 int i = verb_to_mask( optarg, syslogUsers );
184 if ( BER_BVISNULL( &syslogUsers[ i ].word ) ) {
185 Debug( LDAP_DEBUG_ANY,
186 "unrecognized syslog user \"%s\".\n",
191 *syslogUser = syslogUsers[ i ].mask;
195 #endif /* LOG_LOCAL4 */
198 parse_syslog_level( const char *arg, int *levelp )
200 static slap_verbmasks str2syslog_level[] = {
201 { BER_BVC( "EMERG" ), LOG_EMERG },
202 { BER_BVC( "ALERT" ), LOG_ALERT },
203 { BER_BVC( "CRIT" ), LOG_CRIT },
204 { BER_BVC( "ERR" ), LOG_ERR },
205 { BER_BVC( "WARNING" ), LOG_WARNING },
206 { BER_BVC( "NOTICE" ), LOG_NOTICE },
207 { BER_BVC( "INFO" ), LOG_INFO },
208 { BER_BVC( "DEBUG" ), LOG_DEBUG },
211 int i = verb_to_mask( arg, str2syslog_level );
212 if ( BER_BVISNULL( &str2syslog_level[ i ].word ) ) {
213 Debug( LDAP_DEBUG_ANY,
214 "unknown syslog level \"%s\".\n",
219 *levelp = str2syslog_level[ i ].mask;
225 parse_debug_level( const char *arg, int *levelp )
229 if ( arg != NULL && arg[ 0 ] != '-' && !isdigit( arg[ 0 ] ) )
234 levels = ldap_str2charray( arg, "," );
236 for ( i = 0; levels[ i ] != NULL; i++ ) {
239 if ( str2loglevel( levels[ i ], &level ) ) {
241 "unrecognized log level "
242 "\"%s\"\n", levels[ i ] );
244 /* but keep parsing... */
251 ldap_charray_free( levels );
258 if ( lutil_atoix( &level, arg, 0 ) != 0 ) {
260 "unrecognized log level "
280 "usage: %s options\n", name );
282 "\t-4\t\tIPv4 only\n"
283 "\t-6\t\tIPv6 only\n"
284 "\t-T {acl|add|auth|cat|dn|index|passwd|test}\n"
285 "\t\t\tRun in Tool mode\n"
286 "\t-c cookie\tSync cookie of consumer\n"
287 "\t-d level\tDebug level" "\n"
288 "\t-f filename\tConfiguration file\n"
289 "\t-F dir\tConfiguration directory\n"
290 #if defined(HAVE_SETUID) && defined(HAVE_SETGID)
291 "\t-g group\tGroup (id or name) to run as\n"
293 "\t-h URLs\t\tList of URLs to serve\n"
295 "\t-l facility\tSyslog facility (default: LOCAL4)\n"
297 "\t-n serverName\tService name\n"
298 "\t-o <opt>[=val] generic means to specify options" );
299 if ( !BER_BVISNULL( &option_helpers[0].oh_name ) ) {
302 fprintf( stderr, "; supported options:\n" );
303 for ( i = 0; !BER_BVISNULL( &option_helpers[i].oh_name ); i++) {
304 fprintf( stderr, "\t\t%s\n", option_helpers[i].oh_usage );
307 fprintf( stderr, "\n" );
311 "\t-r directory\tSandbox directory to chroot to\n"
313 "\t-s level\tSyslog level\n"
314 #if defined(HAVE_SETUID) && defined(HAVE_SETGID)
315 "\t-u user\t\tUser (id or name) to run as\n"
317 "\t-V\t\tprint version info (-VV only)\n"
321 #ifdef HAVE_NT_SERVICE_MANAGER
322 void WINAPI ServiceMain( DWORD argc, LPTSTR *argv )
324 int main( int argc, char **argv )
327 int i, no_detach = 0;
330 #if defined(HAVE_SETUID) && defined(HAVE_SETGID)
331 char *username = NULL;
332 char *groupname = NULL;
334 #if defined(HAVE_CHROOT)
335 char *sandbox = NULL;
338 int syslogUser = DEFAULT_SYSLOG_USER;
342 char **g_argv = argv;
344 char *configfile = NULL;
345 char *configdir = NULL;
347 int serverMode = SLAP_SERVER_MODE;
349 struct sync_cookie *scp = NULL;
350 struct sync_cookie *scp_entry = NULL;
352 char *serverNamePrefix = "";
355 int slapd_pid_file_unlink = 0, slapd_args_file_unlink = 0;
359 if( ( leakfile = fopen( "slapd.leak", "w" )) == NULL ) {
366 (void) ldap_pvt_thread_initialize();
368 serverName = lutil_progname( "slapd", argc, argv );
370 if ( strcmp( serverName, "slapd" ) ) {
371 for (i=0; tools[i].name; i++) {
372 if ( !strcmp( serverName, tools[i].name ) ) {
373 rc = tools[i].func(argc, argv);
379 #ifdef HAVE_NT_SERVICE_MANAGER
385 char *regService = NULL;
387 if ( is_NT_Service ) {
388 lutil_CommenceStartupProcessing( serverName, slap_sig_shutdown );
389 if ( strcmp(serverName, SERVICE_NAME) )
390 regService = serverName;
393 i = (int*)lutil_getRegParam( regService, "DebugLevel" );
396 Debug( LDAP_DEBUG_ANY,
397 "new debug level from registry is: %d\n", slap_debug, 0, 0 );
400 newUrls = (char *) lutil_getRegParam(regService, "Urls");
405 urls = ch_strdup(newUrls);
406 Debug(LDAP_DEBUG_ANY, "new urls from registry: %s\n",
410 newConfigFile = (char*)lutil_getRegParam( regService, "ConfigFile" );
411 if ( newConfigFile != NULL ) {
412 configfile = newConfigFile;
413 Debug ( LDAP_DEBUG_ANY, "new config file from registry is: %s\n", configfile, 0, 0 );
416 newConfigDir = (char*)lutil_getRegParam( regService, "ConfigDir" );
417 if ( newConfigDir != NULL ) {
418 configdir = newConfigDir;
419 Debug ( LDAP_DEBUG_ANY, "new config dir from registry is: %s\n", configdir, 0, 0 );
424 while ( (i = getopt( argc, argv,
425 "c:d:f:F:h:n:o:s:tT:V"
438 #if defined(HAVE_SETUID) && defined(HAVE_SETGID)
445 slap_inet4or6 = AF_INET;
448 slap_inet4or6 = AF_INET6;
452 case 'h': /* listen URLs */
453 if ( urls != NULL ) free( urls );
454 urls = ch_strdup( optarg );
457 case 'c': /* provide sync cookie, override if exist in replica */
458 scp = (struct sync_cookie *) ch_calloc( 1,
459 sizeof( struct sync_cookie ));
460 ber_str2bv( optarg, 0, 1, &scp->octet_str );
462 /* This only parses out the rid at this point */
463 slap_parse_sync_cookie( scp, NULL );
465 if ( scp->rid == -1 ) {
466 Debug( LDAP_DEBUG_ANY,
467 "main: invalid cookie \"%s\"\n",
469 slap_sync_cookie_free( scp, 1 );
473 LDAP_STAILQ_FOREACH( scp_entry, &slap_sync_cookie, sc_next ) {
474 if ( scp->rid == scp_entry->rid ) {
475 Debug( LDAP_DEBUG_ANY,
476 "main: duplicated replica id in cookies\n",
478 slap_sync_cookie_free( scp, 1 );
482 LDAP_STAILQ_INSERT_TAIL( &slap_sync_cookie, scp, sc_next );
485 case 'd': { /* set debug level and 'do not detach' flag */
489 if ( parse_debug_level( optarg, &level ) ) {
496 fputs( "must compile with LDAP_DEBUG for debugging\n",
501 case 'f': /* read config file */
502 configfile = ch_strdup( optarg );
505 case 'F': /* use config dir */
506 configdir = ch_strdup( optarg );
510 char *val = strchr( optarg, '=' );
517 opt.bv_len = ( val - optarg );
521 opt.bv_len = strlen( optarg );
524 for ( i = 0; !BER_BVISNULL( &option_helpers[i].oh_name ); i++ ) {
525 if ( ber_bvstrcasecmp( &option_helpers[i].oh_name, &opt ) == 0 ) {
526 assert( option_helpers[i].oh_fnc != NULL );
527 if ( (*option_helpers[i].oh_fnc)( val, option_helpers[i].oh_arg ) == -1 ) {
528 /* we assume the option parsing helper
529 * issues appropriate and self-explanatory
530 * error messages... */
537 if ( BER_BVISNULL( &option_helpers[i].oh_name ) ) {
538 goto unhandled_option;
543 case 's': /* set syslog level */
544 if ( parse_debug_level( optarg, &ldap_syslog ) ) {
549 #if defined(LDAP_DEBUG) && defined(LDAP_SYSLOG)
551 if ( parse_syslog_level( optarg, &ldap_syslog_level ) ) {
555 #endif /* LDAP_DEBUG && LDAP_SYSLOG */
558 case 'l': /* set syslog local user */
559 if ( parse_syslog_user( optarg, &syslogUser ) ) {
567 if( sandbox ) free(sandbox);
568 sandbox = ch_strdup( optarg );
572 #if defined(HAVE_SETUID) && defined(HAVE_SETGID)
573 case 'u': /* user name */
574 if( username ) free(username);
575 username = ch_strdup( optarg );
578 case 'g': /* group name */
579 if( groupname ) free(groupname);
580 groupname = ch_strdup( optarg );
582 #endif /* SETUID && GETUID */
584 case 'n': /* NT service name */
585 serverName = ch_strdup( optarg );
589 /* deprecated; use slaptest instead */
590 fprintf( stderr, "option -t deprecated; "
591 "use slaptest command instead\n" );
592 check |= CHECK_CONFIG;
600 /* try full option string first */
601 for ( i = 0; tools[i].name; i++ ) {
602 if ( strcmp( optarg, &tools[i].name[4] ) == 0 ) {
603 rc = tools[i].func( argc, argv );
608 /* try bits of option string (backward compatibility for single char) */
609 l = strlen( optarg );
610 for ( i = 0; tools[i].name; i++ ) {
611 if ( strncmp( optarg, &tools[i].name[4], l ) == 0 ) {
612 rc = tools[i].func( argc, argv );
619 serverNamePrefix = "slap";
620 fprintf( stderr, "program name \"%s%s\" unrecognized; "
621 "aborting...\n", serverNamePrefix, serverName );
627 SERVICE_EXIT( ERROR_SERVICE_SPECIFIC_ERROR, 15 );
632 ber_set_option(NULL, LBER_OPT_DEBUG_LEVEL, &slap_debug);
633 ldap_set_option(NULL, LDAP_OPT_DEBUG_LEVEL, &slap_debug);
634 ldif_debug = slap_debug;
637 fprintf( stderr, "%s\n", Versionstr );
638 if ( version > 1 ) goto stop;
644 logName = ch_strdup( serverName );
647 logName = serverName;
651 openlog( logName, OPENLOG_OPTIONS, syslogUser );
653 openlog( logName, OPENLOG_OPTIONS );
660 Debug( LDAP_DEBUG_ANY, "%s", Versionstr, 0, 0 );
662 if( check == CHECK_NONE && slapd_daemon_init( urls ) != 0 ) {
664 SERVICE_EXIT( ERROR_SERVICE_SPECIFIC_ERROR, 16 );
668 #if defined(HAVE_CHROOT)
670 if ( chdir( sandbox ) ) {
675 if ( chroot( sandbox ) ) {
683 #if defined(HAVE_SETUID) && defined(HAVE_SETGID)
684 if ( username != NULL || groupname != NULL ) {
685 slap_init_user( username, groupname );
693 rc = slap_init( serverMode, serverName );
695 SERVICE_EXIT( ERROR_SERVICE_SPECIFIC_ERROR, 18 );
699 if ( read_config( configfile, configdir ) != 0 ) {
701 SERVICE_EXIT( ERROR_SERVICE_SPECIFIC_ERROR, 19 );
703 if ( check & CHECK_CONFIG ) {
704 fprintf( stderr, "config check failed\n" );
710 if ( check & CHECK_CONFIG ) {
711 fprintf( stderr, "config check succeeded\n" );
713 check &= ~CHECK_CONFIG;
714 if ( check == CHECK_NONE ) {
720 if ( glue_sub_attach( ) != 0 ) {
721 Debug( LDAP_DEBUG_ANY,
722 "subordinate config error\n",
728 if ( slap_schema_check( ) != 0 ) {
729 Debug( LDAP_DEBUG_ANY,
730 "schema prep error\n",
737 rc = ldap_pvt_tls_init();
739 Debug( LDAP_DEBUG_ANY,
740 "main: TLS init failed: %d\n",
743 SERVICE_EXIT( ERROR_SERVICE_SPECIFIC_ERROR, 20 );
748 void *def_ctx = NULL;
750 /* Save existing default ctx, if any */
751 ldap_pvt_tls_get_option( NULL, LDAP_OPT_X_TLS_CTX, &def_ctx );
753 /* Force new ctx to be created */
754 ldap_pvt_tls_set_option( NULL, LDAP_OPT_X_TLS_CTX, NULL );
756 rc = ldap_pvt_tls_init_def_ctx( 1 );
758 ldap_pvt_tls_get_option( NULL, LDAP_OPT_X_TLS_CTX, &slap_tls_ctx );
759 /* Restore previous ctx */
760 ldap_pvt_tls_set_option( NULL, LDAP_OPT_X_TLS_CTX, def_ctx );
761 load_extop( &slap_EXOP_START_TLS, 0, starttls_extop );
762 } else if ( rc != LDAP_NOT_SUPPORTED ) {
763 Debug( LDAP_DEBUG_ANY,
764 "main: TLS init def ctx failed: %d\n",
767 SERVICE_EXIT( ERROR_SERVICE_SPECIFIC_ERROR, 20 );
773 (void) SIGNAL( LDAP_SIGUSR1, slap_sig_wake );
774 (void) SIGNAL( LDAP_SIGUSR2, slap_sig_shutdown );
777 (void) SIGNAL( SIGPIPE, SIG_IGN );
780 (void) SIGNAL( SIGHUP, slap_sig_shutdown );
782 (void) SIGNAL( SIGINT, slap_sig_shutdown );
783 (void) SIGNAL( SIGTERM, slap_sig_shutdown );
785 (void) SIGNAL( SIGTRAP, slap_sig_shutdown );
788 (void) SIGNAL( LDAP_SIGCHLD, wait4child );
791 /* SIGBREAK is generated when Ctrl-Break is pressed. */
792 (void) SIGNAL( SIGBREAK, slap_sig_shutdown );
796 lutil_detach( no_detach, 0 );
797 #endif /* HAVE_WINSOCK */
803 if ( slapd_pid_file != NULL ) {
804 FILE *fp = fopen( slapd_pid_file, "w" );
807 int save_errno = errno;
809 Debug( LDAP_DEBUG_ANY, "unable to open pid file "
812 save_errno, strerror( save_errno ) );
814 free( slapd_pid_file );
815 slapd_pid_file = NULL;
820 fprintf( fp, "%d\n", (int) getpid() );
822 slapd_pid_file_unlink = 1;
825 if ( slapd_args_file != NULL ) {
826 FILE *fp = fopen( slapd_args_file, "w" );
829 int save_errno = errno;
831 Debug( LDAP_DEBUG_ANY, "unable to open args file "
834 save_errno, strerror( save_errno ) );
836 free( slapd_args_file );
837 slapd_args_file = NULL;
843 for ( i = 0; i < g_argc; i++ ) {
844 fprintf( fp, "%s ", g_argv[i] );
848 slapd_args_file_unlink = 1;
852 * FIXME: moved here from slapd_daemon_task()
853 * because back-monitor db_open() needs it
857 if ( slap_startup( NULL ) != 0 ) {
859 SERVICE_EXIT( ERROR_SERVICE_SPECIFIC_ERROR, 21 );
863 Debug( LDAP_DEBUG_ANY, "slapd starting\n", 0, 0, 0 );
865 #ifdef HAVE_NT_EVENT_LOG
867 lutil_LogStartedEvent( serverName, slap_debug, configfile ?
868 configfile : SLAPD_DEFAULT_CONFIGFILE , urls );
873 #ifdef HAVE_NT_SERVICE_MANAGER
874 /* Throw away the event that we used during the startup process. */
876 ldap_pvt_thread_cond_destroy( &started_event );
880 /* remember an error during shutdown */
881 rc |= slap_shutdown( NULL );
884 /* remember an error during destroy */
885 rc |= slap_destroy();
887 while ( !LDAP_STAILQ_EMPTY( &slap_sync_cookie )) {
888 scp = LDAP_STAILQ_FIRST( &slap_sync_cookie );
889 LDAP_STAILQ_REMOVE_HEAD( &slap_sync_cookie, sc_next );
901 supported_feature_destroy();
904 #ifdef HAVE_NT_EVENT_LOG
906 lutil_LogStoppedEvent( serverName );
909 Debug( LDAP_DEBUG_ANY, "slapd stopped.\n", 0, 0, 0 );
912 #ifdef HAVE_NT_SERVICE_MANAGER
913 lutil_ReportShutdownComplete();
919 slapd_daemon_destroy();
925 lutil_passwd_destroy();
928 ldap_pvt_tls_destroy();
931 if ( slapd_pid_file_unlink ) {
932 unlink( slapd_pid_file );
934 if ( slapd_args_file_unlink ) {
935 unlink( slapd_args_file );
941 ch_free( configfile );
943 ch_free( configdir );
948 mal_dumpleaktrace( leakfile );
958 * Catch and discard terminated child processes, to avoid zombies.
962 wait4child( int sig )
964 int save_errno = errno;
969 while ( waitpid( (pid_t)-1, NULL, WNOHANG ) > 0 || errno == EINTR )
972 while ( wait3( NULL, WNOHANG, NULL ) > 0 || errno == EINTR )
978 (void) SIGNAL_REINSTALL( sig, wait4child );
982 #endif /* LDAP_SIGCHLD */