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)";
102 #define DEFAULT_SYSLOG_USER LOG_LOCAL4
104 typedef struct _str2intDispatch {
108 } STRDISP, *STRDISP_P;
110 /* table to compute syslog-options to integer */
111 static STRDISP syslog_types[] = {
112 { "LOCAL0", sizeof("LOCAL0"), LOG_LOCAL0 },
113 { "LOCAL1", sizeof("LOCAL1"), LOG_LOCAL1 },
114 { "LOCAL2", sizeof("LOCAL2"), LOG_LOCAL2 },
115 { "LOCAL3", sizeof("LOCAL3"), LOG_LOCAL3 },
116 { "LOCAL4", sizeof("LOCAL4"), LOG_LOCAL4 },
117 { "LOCAL5", sizeof("LOCAL5"), LOG_LOCAL5 },
118 { "LOCAL6", sizeof("LOCAL6"), LOG_LOCAL6 },
119 { "LOCAL7", sizeof("LOCAL7"), LOG_LOCAL7 },
121 { "USER", sizeof("USER"), LOG_USER },
124 { "DAEMON", sizeof("DAEMON"), LOG_DAEMON },
129 static int cnvt_str2int( char *, STRDISP_P, int );
130 #endif /* LOG_LOCAL4 */
132 #define CHECK_NONE 0x00
133 #define CHECK_CONFIG 0x01
134 static int check = CHECK_NONE;
135 static int version = 0;
140 slapd_opt_slp( const char *val, void *arg )
143 /* NULL is default */
144 if ( val == NULL || strcasecmp( val, "on" ) == 0 ) {
145 slapd_register_slp = 1;
147 } else if ( strcasecmp( val, "off" ) == 0 ) {
148 slapd_register_slp = 0;
150 /* NOTE: add support for URL specification? */
153 fprintf(stderr, "unrecognized value \"%s\" for SLP option\n", val );
160 fputs( "slapd: SLP support is not available\n", stderr );
166 * Option helper structure:
168 * oh_nam is left-hand part of <option>[=<value>]
169 * oh_fnc is handler function
170 * oh_arg is an optional arg to oh_fnc
171 * oh_usage is the one-line usage string related to the option,
172 * which is assumed to start with <option>[=<value>]
174 * please leave valid options in the structure, and optionally #ifdef
175 * their processing inside the helper, so that reasonable and helpful
176 * error messages can be generated if a disabled option is requested.
178 struct option_helper {
179 struct berval oh_name;
180 int (*oh_fnc)(const char *val, void *arg);
182 const char *oh_usage;
183 } option_helpers[] = {
184 { BER_BVC("slp"), slapd_opt_slp, NULL, "slp[={on|off}] enable/disable SLP" },
185 { BER_BVNULL, 0, NULL, NULL }
192 "usage: %s options\n", name );
194 "\t-4\t\tIPv4 only\n"
195 "\t-6\t\tIPv6 only\n"
196 "\t-T {acl|add|auth|cat|dn|index|passwd|test}\n"
197 "\t\t\tRun in Tool mode\n"
198 "\t-c cookie\tSync cookie of consumer\n"
199 "\t-d level\tDebug level" "\n"
200 "\t-f filename\tConfiguration file\n"
201 "\t-F dir\tConfiguration directory\n"
202 #if defined(HAVE_SETUID) && defined(HAVE_SETGID)
203 "\t-g group\tGroup (id or name) to run as\n"
205 "\t-h URLs\t\tList of URLs to serve\n"
207 "\t-l facility\tSyslog facility (default: LOCAL4)\n"
209 "\t-n serverName\tService name\n"
210 "\t-o <opt>[=val] generic means to specify options" );
211 if ( !BER_BVISNULL( &option_helpers[0].oh_name ) ) {
214 fprintf( stderr, "; supported options:\n" );
215 for ( i = 0; !BER_BVISNULL( &option_helpers[i].oh_name ); i++) {
216 fprintf( stderr, "\t\t%s\n", option_helpers[i].oh_usage );
219 fprintf( stderr, "\n" );
223 "\t-r directory\tSandbox directory to chroot to\n"
225 "\t-s level\tSyslog level\n"
226 #if defined(HAVE_SETUID) && defined(HAVE_SETGID)
227 "\t-u user\t\tUser (id or name) to run as\n"
229 "\t-V\t\tprint version info (-VV only)\n"
233 #ifdef HAVE_NT_SERVICE_MANAGER
234 void WINAPI ServiceMain( DWORD argc, LPTSTR *argv )
236 int main( int argc, char **argv )
239 int i, no_detach = 0;
242 #if defined(HAVE_SETUID) && defined(HAVE_SETGID)
243 char *username = NULL;
244 char *groupname = NULL;
246 #if defined(HAVE_CHROOT)
247 char *sandbox = NULL;
250 int syslogUser = DEFAULT_SYSLOG_USER;
254 char **g_argv = argv;
256 char *configfile = NULL;
257 char *configdir = NULL;
259 int serverMode = SLAP_SERVER_MODE;
261 struct sync_cookie *scp = NULL;
262 struct sync_cookie *scp_entry = NULL;
266 if( ( leakfile = fopen( "slapd.leak", "w" )) == NULL ) {
270 char *serverNamePrefix = "";
275 (void) ldap_pvt_thread_initialize();
277 serverName = lutil_progname( "slapd", argc, argv );
279 if ( strcmp( serverName, "slapd" ) ) {
280 for (i=0; tools[i].name; i++) {
281 if ( !strcmp( serverName, tools[i].name ) ) {
282 rc = tools[i].func(argc, argv);
288 #ifdef HAVE_NT_SERVICE_MANAGER
294 char *regService = NULL;
296 if ( is_NT_Service ) {
297 lutil_CommenceStartupProcessing( serverName, slap_sig_shutdown );
298 if ( strcmp(serverName, SERVICE_NAME) )
299 regService = serverName;
302 i = (int*)lutil_getRegParam( regService, "DebugLevel" );
305 Debug( LDAP_DEBUG_ANY,
306 "new debug level from registry is: %d\n", slap_debug, 0, 0 );
309 newUrls = (char *) lutil_getRegParam(regService, "Urls");
314 urls = ch_strdup(newUrls);
315 Debug(LDAP_DEBUG_ANY, "new urls from registry: %s\n",
319 newConfigFile = (char*)lutil_getRegParam( regService, "ConfigFile" );
320 if ( newConfigFile != NULL ) {
321 configfile = newConfigFile;
322 Debug ( LDAP_DEBUG_ANY, "new config file from registry is: %s\n", configfile, 0, 0 );
325 newConfigDir = (char*)lutil_getRegParam( regService, "ConfigDir" );
326 if ( newConfigDir != NULL ) {
327 configdir = newConfigDir;
328 Debug ( LDAP_DEBUG_ANY, "new config dir from registry is: %s\n", configdir, 0, 0 );
333 while ( (i = getopt( argc, argv,
334 "c:d:f:F:h:n:o:s:StT:V"
344 #if defined(HAVE_SETUID) && defined(HAVE_SETGID)
351 slap_inet4or6 = AF_INET;
354 slap_inet4or6 = AF_INET6;
358 case 'h': /* listen URLs */
359 if ( urls != NULL ) free( urls );
360 urls = ch_strdup( optarg );
363 case 'c': /* provide sync cookie, override if exist in replica */
364 scp = (struct sync_cookie *) ch_calloc( 1,
365 sizeof( struct sync_cookie ));
366 ber_str2bv( optarg, 0, 1, &scp->octet_str );
368 /* This only parses out the rid at this point */
369 slap_parse_sync_cookie( scp, NULL );
371 if ( scp->rid == -1 ) {
372 Debug( LDAP_DEBUG_ANY,
373 "main: invalid cookie \"%s\"\n",
375 slap_sync_cookie_free( scp, 1 );
379 LDAP_STAILQ_FOREACH( scp_entry, &slap_sync_cookie, sc_next ) {
380 if ( scp->rid == scp_entry->rid ) {
381 Debug( LDAP_DEBUG_ANY,
382 "main: duplicated replica id in cookies\n",
384 slap_sync_cookie_free( scp, 1 );
388 LDAP_STAILQ_INSERT_TAIL( &slap_sync_cookie, scp, sc_next );
391 case 'd': /* set debug level and 'do not detach' flag */
394 if ( optarg != NULL && optarg[ 0 ] != '-' && !isdigit( optarg[ 0 ] ) )
398 if ( str2loglevel( optarg, &level ) ) {
400 "unrecognized log level "
401 "\"%s\"\n", optarg );
410 level = strtol( optarg, &next, 0 );
411 if ( next == NULL || next[ 0 ] != '\0' ) {
413 "unrecognized log level "
414 "\"%s\"\n", optarg );
420 if ( atoi( optarg ) != 0 )
421 fputs( "must compile with LDAP_DEBUG for debugging\n",
426 case 'f': /* read config file */
427 configfile = ch_strdup( optarg );
430 case 'F': /* use config dir */
431 configdir = ch_strdup( optarg );
435 char *val = strchr( optarg, '=' );
442 opt.bv_len = ( val - optarg );
446 opt.bv_len = strlen( optarg );
449 for ( i = 0; !BER_BVISNULL( &option_helpers[i].oh_name ); i++ ) {
450 if ( ber_bvstrcasecmp( &option_helpers[i].oh_name, &opt ) == 0 ) {
451 assert( option_helpers[i].oh_fnc != NULL );
452 if ( (*option_helpers[i].oh_fnc)( val, option_helpers[i].oh_arg ) == -1 ) {
453 /* we assume the option parsing helper
454 * issues appropriate and self-explanatory
455 * error messages... */
462 if ( BER_BVISNULL( &option_helpers[i].oh_name ) ) {
463 goto unhandled_option;
468 case 's': /* set syslog level */
469 ldap_syslog = atoi( optarg );
473 case 'l': /* set syslog local user */
474 syslogUser = cnvt_str2int( optarg,
475 syslog_types, DEFAULT_SYSLOG_USER );
481 if( sandbox ) free(sandbox);
482 sandbox = ch_strdup( optarg );
486 #if defined(HAVE_SETUID) && defined(HAVE_SETGID)
487 case 'u': /* user name */
488 if( username ) free(username);
489 username = ch_strdup( optarg );
492 case 'g': /* group name */
493 if( groupname ) free(groupname);
494 groupname = ch_strdup( optarg );
496 #endif /* SETUID && GETUID */
498 case 'n': /* NT service name */
499 serverName = ch_strdup( optarg );
503 /* deprecated; use slaptest instead */
504 fprintf( stderr, "option -t deprecated; "
505 "use slaptest command instead\n" );
506 check |= CHECK_CONFIG;
514 /* try full option string first */
515 for ( i = 0; tools[i].name; i++ ) {
516 if ( strcmp( optarg, &tools[i].name[4] ) == 0 ) {
517 rc = tools[i].func( argc, argv );
522 /* try bits of option string (backward compatibility for single char) */
523 l = strlen( optarg );
524 for ( i = 0; tools[i].name; i++ ) {
525 if ( strncmp( optarg, &tools[i].name[4], l ) == 0 ) {
526 rc = tools[i].func( argc, argv );
533 serverNamePrefix = "slap";
534 fprintf( stderr, "program name \"%s%s\" unrecognized; "
535 "aborting...\n", serverNamePrefix, serverName );
541 SERVICE_EXIT( ERROR_SERVICE_SPECIFIC_ERROR, 15 );
546 ber_set_option(NULL, LBER_OPT_DEBUG_LEVEL, &slap_debug);
547 ldap_set_option(NULL, LDAP_OPT_DEBUG_LEVEL, &slap_debug);
548 ldif_debug = slap_debug;
551 fprintf( stderr, "%s\n", Versionstr );
552 if ( version > 1 ) goto stop;
558 logName = ch_strdup( serverName );
561 logName = serverName;
565 openlog( logName, OPENLOG_OPTIONS, syslogUser );
567 openlog( logName, OPENLOG_OPTIONS );
574 Debug( LDAP_DEBUG_ANY, "%s", Versionstr, 0, 0 );
576 if( check == CHECK_NONE && slapd_daemon_init( urls ) != 0 ) {
578 SERVICE_EXIT( ERROR_SERVICE_SPECIFIC_ERROR, 16 );
582 #if defined(HAVE_CHROOT)
584 if ( chdir( sandbox ) ) {
589 if ( chroot( sandbox ) ) {
597 #if defined(HAVE_SETUID) && defined(HAVE_SETGID)
598 if ( username != NULL || groupname != NULL ) {
599 slap_init_user( username, groupname );
607 rc = slap_init( serverMode, serverName );
609 SERVICE_EXIT( ERROR_SERVICE_SPECIFIC_ERROR, 18 );
613 if ( read_config( configfile, configdir ) != 0 ) {
615 SERVICE_EXIT( ERROR_SERVICE_SPECIFIC_ERROR, 19 );
617 if ( check & CHECK_CONFIG ) {
618 fprintf( stderr, "config check failed\n" );
624 if ( check & CHECK_CONFIG ) {
625 fprintf( stderr, "config check succeeded\n" );
627 check &= ~CHECK_CONFIG;
628 if ( check == CHECK_NONE ) {
634 if ( glue_sub_init( ) != 0 ) {
635 Debug( LDAP_DEBUG_ANY,
636 "subordinate config error\n",
642 if ( slap_schema_check( ) != 0 ) {
643 Debug( LDAP_DEBUG_ANY,
644 "schema prep error\n",
651 rc = ldap_pvt_tls_init();
653 Debug( LDAP_DEBUG_ANY,
654 "main: TLS init failed: %d\n",
657 SERVICE_EXIT( ERROR_SERVICE_SPECIFIC_ERROR, 20 );
662 void *def_ctx = NULL;
664 /* Save existing default ctx, if any */
665 ldap_pvt_tls_get_option( NULL, LDAP_OPT_X_TLS_CTX, &def_ctx );
667 /* Force new ctx to be created */
668 ldap_pvt_tls_set_option( NULL, LDAP_OPT_X_TLS_CTX, NULL );
670 rc = ldap_pvt_tls_init_def_ctx();
672 Debug( LDAP_DEBUG_ANY,
673 "main: TLS init def ctx failed: %d\n",
676 SERVICE_EXIT( ERROR_SERVICE_SPECIFIC_ERROR, 20 );
679 /* Retrieve slapd's own ctx */
680 ldap_pvt_tls_get_option( NULL, LDAP_OPT_X_TLS_CTX, &slap_tls_ctx );
681 /* Restore previous ctx */
682 ldap_pvt_tls_set_option( NULL, LDAP_OPT_X_TLS_CTX, def_ctx );
686 (void) SIGNAL( LDAP_SIGUSR1, slap_sig_wake );
687 (void) SIGNAL( LDAP_SIGUSR2, slap_sig_shutdown );
690 (void) SIGNAL( SIGPIPE, SIG_IGN );
693 (void) SIGNAL( SIGHUP, slap_sig_shutdown );
695 (void) SIGNAL( SIGINT, slap_sig_shutdown );
696 (void) SIGNAL( SIGTERM, slap_sig_shutdown );
698 (void) SIGNAL( SIGTRAP, slap_sig_shutdown );
701 (void) SIGNAL( LDAP_SIGCHLD, wait4child );
704 /* SIGBREAK is generated when Ctrl-Break is pressed. */
705 (void) SIGNAL( SIGBREAK, slap_sig_shutdown );
709 lutil_detach( no_detach, 0 );
710 #endif /* HAVE_WINSOCK */
717 * FIXME: moved here from slapd_daemon_task()
718 * because back-monitor db_open() needs it
722 if ( slap_startup( NULL ) != 0 ) {
724 SERVICE_EXIT( ERROR_SERVICE_SPECIFIC_ERROR, 21 );
728 Debug( LDAP_DEBUG_ANY, "slapd starting\n", 0, 0, 0 );
731 if ( slapd_pid_file != NULL ) {
732 FILE *fp = fopen( slapd_pid_file, "w" );
735 fprintf( fp, "%d\n", (int) getpid() );
739 free(slapd_pid_file);
740 slapd_pid_file = NULL;
744 if ( slapd_args_file != NULL ) {
745 FILE *fp = fopen( slapd_args_file, "w" );
748 for ( i = 0; i < g_argc; i++ ) {
749 fprintf( fp, "%s ", g_argv[i] );
754 free(slapd_args_file);
755 slapd_args_file = NULL;
759 #ifdef HAVE_NT_EVENT_LOG
761 lutil_LogStartedEvent( serverName, slap_debug, configfile ?
762 configfile : SLAPD_DEFAULT_CONFIGFILE , urls );
767 #ifdef HAVE_NT_SERVICE_MANAGER
768 /* Throw away the event that we used during the startup process. */
770 ldap_pvt_thread_cond_destroy( &started_event );
774 /* remember an error during shutdown */
775 rc |= slap_shutdown( NULL );
778 /* remember an error during destroy */
779 rc |= slap_destroy();
781 while ( !LDAP_STAILQ_EMPTY( &slap_sync_cookie )) {
782 scp = LDAP_STAILQ_FIRST( &slap_sync_cookie );
783 LDAP_STAILQ_REMOVE_HEAD( &slap_sync_cookie, sc_next );
796 #ifdef HAVE_NT_EVENT_LOG
798 lutil_LogStoppedEvent( serverName );
801 Debug( LDAP_DEBUG_ANY, "slapd stopped.\n", 0, 0, 0 );
804 #ifdef HAVE_NT_SERVICE_MANAGER
805 lutil_ReportShutdownComplete();
811 slapd_daemon_destroy();
817 lutil_passwd_destroy();
820 ldap_pvt_tls_destroy();
823 if ( slapd_pid_file != NULL ) {
824 unlink( slapd_pid_file );
826 if ( slapd_args_file != NULL ) {
827 unlink( slapd_args_file );
833 ch_free( configfile );
835 ch_free( configdir );
840 mal_dumpleaktrace( leakfile );
850 * Catch and discard terminated child processes, to avoid zombies.
854 wait4child( int sig )
856 int save_errno = errno;
861 while ( waitpid( (pid_t)-1, NULL, WNOHANG ) > 0 || errno == EINTR )
864 while ( wait3( NULL, WNOHANG, NULL ) > 0 || errno == EINTR )
870 (void) SIGNAL_REINSTALL( sig, wait4child );
874 #endif /* LDAP_SIGCHLD */
880 * Convert a string to an integer by means of a dispatcher table
881 * if the string is not in the table return the default
885 cnvt_str2int( char *stringVal, STRDISP_P dispatcher, int defaultVal )
887 int retVal = defaultVal;
890 for (disp = dispatcher; disp->stringVal; disp++) {
892 if (!strncasecmp (stringVal, disp->stringVal, disp->abbr)) {
894 retVal = disp->intVal;
903 #endif /* LOG_LOCAL4 */