1 /* config.c - configuration file handling routines */
3 * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
14 #include <ac/string.h>
16 #include <ac/socket.h>
18 #include "ldap_defaults.h"
24 * defaults for various global variables
26 int defsize = SLAPD_DEFAULT_SIZELIMIT;
27 int deftime = SLAPD_DEFAULT_TIMELIMIT;
28 AccessControl *global_acl = NULL;
29 int global_default_access = ACL_READ;
31 int global_lastmod = ON;
32 int global_idletimeout = 0;
33 char *global_realm = NULL;
34 char *ldap_srvtab = "";
36 char *slapd_pid_file = NULL;
37 char *slapd_args_file = NULL;
39 static char *fp_getline(FILE *fp, int *lineno);
40 static void fp_getline_init(int *lineno);
41 static int fp_parse_line(char *line, int *argcp, char **argv);
43 static char *strtok_quote(char *line, char *sep);
46 read_config( const char *fname )
49 char *line, *savefname, *saveline;
50 int cargc, savelineno;
56 struct berval *vals[2];
59 static BackendInfo *bi = NULL;
60 static BackendDB *be = NULL;
65 if ( (fp = fopen( fname, "r" )) == NULL ) {
67 Debug( LDAP_DEBUG_ANY,
68 "could not open config file \"%s\" - absolute path?\n",
74 Debug( LDAP_DEBUG_CONFIG, "reading config file %s\n", fname, 0, 0 );
76 if ( schema_init( ) != 0 ) {
77 Debug( LDAP_DEBUG_ANY,
78 "error initializing the schema\n",
83 fp_getline_init( &lineno );
85 while ( (line = fp_getline( fp, &lineno )) != NULL ) {
86 /* skip comments and blank lines */
87 if ( line[0] == '#' || line[0] == '\0' ) {
91 Debug( LDAP_DEBUG_CONFIG, "line %d (%s)\n", lineno, line, 0 );
93 /* fp_parse_line is destructive, we save a copy */
94 saveline = ch_strdup( line );
96 if ( fp_parse_line( line, &cargc, cargv ) != 0 ) {
101 Debug( LDAP_DEBUG_ANY,
102 "%s: line %d: bad config line (ignored)\n",
107 if ( strcasecmp( cargv[0], "backend" ) == 0 ) {
109 Debug( LDAP_DEBUG_ANY,
110 "%s: line %d: missing type in \"backend <type>\" line\n",
116 Debug( LDAP_DEBUG_ANY,
117 "%s: line %d: backend line must appear before any database definition\n",
122 bi = backend_info( cargv[1] );
124 /* start of a new database definition */
125 } else if ( strcasecmp( cargv[0], "database" ) == 0 ) {
127 Debug( LDAP_DEBUG_ANY,
128 "%s: line %d: missing type in \"database <type>\" line\n",
133 be = backend_db_init( cargv[1] );
135 /* assign a default depth limit for alias deref */
136 be->be_max_deref_depth = SLAPD_DEFAULT_MAXDEREFDEPTH;
138 /* get pid file name */
139 } else if ( strcasecmp( cargv[0], "pidfile" ) == 0 ) {
141 Debug( LDAP_DEBUG_ANY,
142 "%s: line %d: missing file name in \"pidfile <file>\" line\n",
147 slapd_pid_file = ch_strdup( cargv[1] );
149 /* get args file name */
150 } else if ( strcasecmp( cargv[0], "argsfile" ) == 0 ) {
152 Debug( LDAP_DEBUG_ANY,
153 "%s: line %d: missing file name in \"argsfile <file>\" line\n",
158 slapd_args_file = ch_strdup( cargv[1] );
160 /* set DIGEST realm */
161 } else if ( strcasecmp( cargv[0], "digest-realm" ) == 0 ) {
163 Debug( LDAP_DEBUG_ANY,
164 "%s: line %d: missing realm in \"digest-realm <realm>\" line\n",
169 be->be_realm = ch_strdup( cargv[1] );
171 } else if ( global_realm != NULL ) {
172 Debug( LDAP_DEBUG_ANY,
173 "%s: line %d: already set global realm!\n",
178 global_realm = ch_strdup( cargv[1] );
182 } else if ( strcasecmp( cargv[0], "sizelimit" ) == 0 ) {
184 Debug( LDAP_DEBUG_ANY,
185 "%s: line %d: missing limit in \"sizelimit <limit>\" line\n",
190 defsize = atoi( cargv[1] );
192 be->be_sizelimit = atoi( cargv[1] );
196 } else if ( strcasecmp( cargv[0], "timelimit" ) == 0 ) {
198 Debug( LDAP_DEBUG_ANY,
199 "%s: line %d: missing limit in \"timelimit <limit>\" line\n",
204 deftime = atoi( cargv[1] );
206 be->be_timelimit = atoi( cargv[1] );
209 /* set database suffix */
210 } else if ( strcasecmp( cargv[0], "suffix" ) == 0 ) {
213 Debug( LDAP_DEBUG_ANY,
214 "%s: line %d: missing dn in \"suffix <dn>\" line\n",
217 } else if ( cargc > 2 ) {
218 Debug( LDAP_DEBUG_ANY,
219 "%s: line %d: extra cruft after <dn> in \"suffix %s\" line (ignored)\n",
220 fname, lineno, cargv[1] );
223 Debug( LDAP_DEBUG_ANY,
224 "%s: line %d: suffix line must appear inside a database definition (ignored)\n",
226 } else if ( ( tmp_be = select_backend( cargv[1] ) ) == be ) {
227 Debug( LDAP_DEBUG_ANY,
228 "%s: line %d: suffix already served by this backend (ignored)\n",
230 } else if ( tmp_be != NULL ) {
231 Debug( LDAP_DEBUG_ANY,
232 "%s: line %d: suffix already served by a preceeding backend \"%s\" (ignored)\n",
233 fname, lineno, tmp_be->be_suffix[0] );
235 char *dn = ch_strdup( cargv[1] );
236 (void) dn_normalize( dn );
237 charray_add( &be->be_suffix, dn );
238 (void) str2upper( dn );
239 charray_add( &be->be_nsuffix, dn );
243 /* set database suffixAlias */
244 } else if ( strcasecmp( cargv[0], "suffixAlias" ) == 0 ) {
247 Debug( LDAP_DEBUG_ANY,
248 "%s: line %d: missing alias and aliased_dn in \"suffixAlias <alias> <aliased_dn>\" line\n",
251 } else if ( cargc < 3 ) {
252 Debug( LDAP_DEBUG_ANY,
253 "%s: line %d: missing aliased_dn in \"suffixAlias <alias> <aliased_dn>\" line\n",
256 } else if ( cargc > 3 ) {
257 Debug( LDAP_DEBUG_ANY,
258 "%s: line %d: extra cruft in suffixAlias line (ignored)\n",
263 Debug( LDAP_DEBUG_ANY,
264 "%s: line %d: suffixAlias line"
265 " must appear inside a database definition (ignored)\n",
267 } else if ( (tmp_be = select_backend( cargv[1] )) != NULL ) {
268 Debug( LDAP_DEBUG_ANY,
269 "%s: line %d: suffixAlias served by"
270 " a preceeding backend \"%s\" (ignored)\n",
271 fname, lineno, tmp_be->be_suffix[0] );
273 } else if ( (tmp_be = select_backend( cargv[2] )) != NULL ) {
274 Debug( LDAP_DEBUG_ANY,
275 "%s: line %d: suffixAlias derefs to differnet backend"
276 " a preceeding backend \"%s\" (ignored)\n",
277 fname, lineno, tmp_be->be_suffix[0] );
280 char *alias, *aliased_dn;
282 alias = ch_strdup( cargv[1] );
283 (void) dn_normalize( alias );
285 aliased_dn = ch_strdup( cargv[2] );
286 (void) dn_normalize( aliased_dn );
288 (void) dn_normalize_case( alias );
289 (void) dn_normalize_case( aliased_dn );
290 charray_add( &be->be_suffixAlias, alias );
291 charray_add( &be->be_suffixAlias, aliased_dn );
297 /* set max deref depth */
298 } else if ( strcasecmp( cargv[0], "maxDerefDepth" ) == 0 ) {
301 Debug( LDAP_DEBUG_ANY,
302 "%s: line %d: missing depth in \"maxDerefDepth <depth>\" line\n",
307 Debug( LDAP_DEBUG_ANY,
308 "%s: line %d: depth line must appear inside a database definition (ignored)\n",
310 } else if ((i = atoi(cargv[1])) < 0) {
311 Debug( LDAP_DEBUG_ANY,
312 "%s: line %d: depth must be positive (ignored)\n",
316 be->be_max_deref_depth = i;
320 /* set magic "root" dn for this database */
321 } else if ( strcasecmp( cargv[0], "rootdn" ) == 0 ) {
323 Debug( LDAP_DEBUG_ANY,
324 "%s: line %d: missing dn in \"rootdn <dn>\" line\n",
329 Debug( LDAP_DEBUG_ANY,
330 "%s: line %d: rootdn line must appear inside a database definition (ignored)\n",
333 be->be_root_dn = ch_strdup( cargv[1] );
334 be->be_root_ndn = ch_strdup( cargv[1] );
336 if( dn_normalize_case( be->be_root_ndn ) == NULL ) {
337 free( be->be_root_dn );
338 free( be->be_root_ndn );
339 Debug( LDAP_DEBUG_ANY,
340 "%s: line %d: rootdn DN is invalid\n",
346 /* set super-secret magic database password */
347 } else if ( strcasecmp( cargv[0], "rootpw" ) == 0 ) {
349 Debug( LDAP_DEBUG_ANY,
350 "%s: line %d: missing passwd in \"rootpw <passwd>\" line\n",
355 Debug( LDAP_DEBUG_ANY,
356 "%s: line %d: rootpw line must appear inside a database definition (ignored)\n",
359 be->be_root_pw = ch_strdup( cargv[1] );
362 /* make this database read-only */
363 } else if ( strcasecmp( cargv[0], "readonly" ) == 0 ) {
365 Debug( LDAP_DEBUG_ANY,
366 "%s: line %d: missing on|off in \"readonly <on|off>\" line\n",
371 Debug( LDAP_DEBUG_ANY,
372 "%s: line %d: readonly line must appear inside a database definition (ignored)\n",
375 if ( strcasecmp( cargv[1], "on" ) == 0 ) {
382 /* where to send clients when we don't hold it */
383 } else if ( strcasecmp( cargv[0], "referral" ) == 0 ) {
385 Debug( LDAP_DEBUG_ANY,
386 "%s: line %d: missing URL in \"referral <URL>\" line\n",
391 vals[0]->bv_val = cargv[1];
392 vals[0]->bv_len = strlen( vals[0]->bv_val );
393 value_add( &default_referral, vals );
396 } else if ( strcasecmp( cargv[0], "locale" ) == 0 ) {
400 Debug( LDAP_DEBUG_ANY,
401 "%s: line %d: missing locale in \"locale <name | on | off>\" line\n",
406 locale = (strcasecmp( cargv[1], "on" ) == 0 ? ""
407 : strcasecmp( cargv[1], "off" ) == 0 ? "C"
408 : ch_strdup( cargv[1] ) );
410 if ( setlocale( LC_CTYPE, locale ) == 0 ) {
411 Debug( LDAP_DEBUG_ANY,
413 ? "%s: line %d: bad locale \"%s\"\n"
414 : "%s: line %d: bad locale\n"),
415 fname, lineno, locale );
419 Debug( LDAP_DEBUG_ANY,
420 "%s: line %d: \"locale\" unsupported\n",
424 /* specify an Object Identifier macro */
425 } else if ( strcasecmp( cargv[0], "objectidentifier" ) == 0 ) {
426 parse_oidm( fname, lineno, cargc, cargv );
427 /* specify an objectclass */
428 } else if ( strcasecmp( cargv[0], "objectclass" ) == 0 ) {
429 if ( *cargv[1] == '(' ) {
431 p = strchr(saveline,'(');
432 parse_oc( fname, lineno, p, cargv );
434 parse_oc_old( be, fname, lineno, cargc, cargv );
437 /* specify an attribute */
438 } else if ( strcasecmp( cargv[0], "attribute" ) == 0 ) {
439 if ( *cargv[1] == '(' ) {
441 p = strchr(saveline,'(');
442 parse_at( fname, lineno, p, cargv );
444 attr_syntax_config( fname, lineno, cargc - 1,
448 /* turn on/off schema checking */
449 } else if ( strcasecmp( cargv[0], "schemacheck" ) == 0 ) {
451 Debug( LDAP_DEBUG_ANY,
452 "%s: line %d: missing on|off in \"schemacheck <on|off>\" line\n",
456 if ( strcasecmp( cargv[1], "off" ) == 0 ) {
457 global_schemacheck = 0;
459 global_schemacheck = 1;
462 /* specify access control info */
463 } else if ( strcasecmp( cargv[0], "access" ) == 0 ) {
464 parse_acl( be, fname, lineno, cargc, cargv );
466 /* specify default access control info */
467 } else if ( strcasecmp( cargv[0], "defaultaccess" ) == 0 ) {
469 Debug( LDAP_DEBUG_ANY,
470 "%s: line %d: missing limit in \"defaultaccess <access>\" line\n",
475 if ( ACL_IS_INVALID(ACL_SET(global_default_access,
476 str2access(cargv[1]))) )
478 Debug( LDAP_DEBUG_ANY,
479 "%s: line %d: bad access \"%s\" expecting [self]{none|auth|compare|search|read|write}\n",
480 fname, lineno, cargv[1] );
484 if ( ACL_IS_INVALID(ACL_SET(be->be_dfltaccess,
485 str2access(cargv[1]))) )
487 Debug( LDAP_DEBUG_ANY,
488 "%s: line %d: bad access \"%s\", "
489 "expecting [self]{none|auth|compare|search|read|write}\n",
490 fname, lineno, cargv[1] );
495 /* debug level to log things to syslog */
496 } else if ( strcasecmp( cargv[0], "loglevel" ) == 0 ) {
498 Debug( LDAP_DEBUG_ANY,
499 "%s: line %d: missing level in \"loglevel <level>\" line\n",
503 ldap_syslog = atoi( cargv[1] );
505 /* list of replicas of the data in this backend (master only) */
506 } else if ( strcasecmp( cargv[0], "replica" ) == 0 ) {
508 Debug( LDAP_DEBUG_ANY,
509 "%s: line %d: missing host in \"replica <host[:port]>\" line\n",
514 Debug( LDAP_DEBUG_ANY,
515 "%s: line %d: replica line must appear inside a database definition (ignored)\n",
518 for ( i = 1; i < cargc; i++ ) {
519 if ( strncasecmp( cargv[i], "host=", 5 )
521 charray_add( &be->be_replica,
527 Debug( LDAP_DEBUG_ANY,
528 "%s: line %d: missing host in \"replica\" line (ignored)\n",
533 /* dn of master entity allowed to write to replica */
534 } else if ( strcasecmp( cargv[0], "updatedn" ) == 0 ) {
536 Debug( LDAP_DEBUG_ANY,
537 "%s: line %d: missing dn in \"updatedn <dn>\" line\n",
542 Debug( LDAP_DEBUG_ANY,
543 "%s: line %d: updatedn line must appear inside a database definition (ignored)\n",
546 be->be_update_ndn = ch_strdup( cargv[1] );
547 if( dn_normalize_case( be->be_update_ndn ) == NULL ) {
548 Debug( LDAP_DEBUG_ANY,
549 "%s: line %d: updatedn DN is invalid\n",
555 } else if ( strcasecmp( cargv[0], "updateref" ) == 0 ) {
557 Debug( LDAP_DEBUG_ANY,
558 "%s: line %d: missing dn in \"updateref <ldapurl>\" line\n",
563 Debug( LDAP_DEBUG_ANY,
564 "%s: line %d: updateref line must appear inside a database definition (ignored)\n",
566 } else if ( be->be_update_ndn == NULL ) {
567 Debug( LDAP_DEBUG_ANY,
568 "%s: line %d: updateref line must after updatedn (ignored)\n",
571 vals[0]->bv_val = cargv[1];
572 vals[0]->bv_len = strlen( vals[0]->bv_val );
573 value_add( &be->be_update_refs, vals );
576 /* replication log file to which changes are appended */
577 } else if ( strcasecmp( cargv[0], "replogfile" ) == 0 ) {
579 Debug( LDAP_DEBUG_ANY,
580 "%s: line %d: missing dn in \"replogfile <filename>\" line\n",
585 be->be_replogfile = ch_strdup( cargv[1] );
587 replogfile = ch_strdup( cargv[1] );
590 /* maintain lastmodified{by,time} attributes */
591 } else if ( strcasecmp( cargv[0], "lastmod" ) == 0 ) {
593 Debug( LDAP_DEBUG_ANY,
594 "%s: line %d: missing on|off in \"lastmod <on|off>\" line\n",
598 if ( strcasecmp( cargv[1], "on" ) == 0 ) {
605 be->be_lastmod = OFF;
607 global_lastmod = OFF;
610 /* set idle timeout value */
611 } else if ( strcasecmp( cargv[0], "idletimeout" ) == 0 ) {
614 Debug( LDAP_DEBUG_ANY,
615 "%s: line %d: missing timeout value in \"idletimeout <seconds>\" line\n",
620 i = atoi( cargv[1] );
623 Debug( LDAP_DEBUG_ANY,
624 "%s: line %d: timeout value (%d) invalid \"idletimeout <seconds>\" line\n",
629 global_idletimeout = i;
631 /* include another config file */
632 } else if ( strcasecmp( cargv[0], "include" ) == 0 ) {
634 Debug( LDAP_DEBUG_ANY,
635 "%s: line %d: missing filename in \"include <filename>\" line\n",
639 savefname = ch_strdup( cargv[1] );
642 if ( read_config( savefname ) != 0 ) {
647 lineno = savelineno - 1;
649 /* location of kerberos srvtab file */
650 } else if ( strcasecmp( cargv[0], "srvtab" ) == 0 ) {
652 Debug( LDAP_DEBUG_ANY,
653 "%s: line %d: missing filename in \"srvtab <filename>\" line\n",
657 ldap_srvtab = ch_strdup( cargv[1] );
660 } else if (strcasecmp( cargv[0], "moduleload") == 0 ) {
662 Debug( LDAP_DEBUG_ANY,
663 "%s: line %d: missing filename in \"moduleload <filename>\" line\n",
665 exit( EXIT_FAILURE );
667 if (module_load(cargv[1], cargc - 2, (cargc > 2) ? cargv + 2 : NULL)) {
668 Debug( LDAP_DEBUG_ANY,
669 "%s: line %d: failed to load or initialize module %s\n",
670 fname, lineno, cargv[1]);
671 exit( EXIT_FAILURE );
673 } else if (strcasecmp( cargv[0], "modulepath") == 0 ) {
675 Debug( LDAP_DEBUG_ANY,
676 "%s: line %d: missing path in \"modulepath <path>\" line\n",
678 exit( EXIT_FAILURE );
680 if (module_path( cargv[1] )) {
681 Debug( LDAP_DEBUG_ANY,
682 "%s: line %d: failed to set module search path to %s\n",
683 fname, lineno, cargv[1]);
684 exit( EXIT_FAILURE );
687 #endif /*SLAPD_MODULES*/
690 } else if ( !strcasecmp( cargv[0], "TLSProtocol" ) ) {
691 rc = ldap_pvt_tls_set_option( NULL,
692 LDAP_OPT_X_TLS_PROTOCOL,
697 } else if ( !strcasecmp( cargv[0], "TLSCipherSuite" ) ) {
698 rc = ldap_pvt_tls_set_option( NULL,
699 LDAP_OPT_X_TLS_CIPHER_SUITE,
704 } else if ( !strcasecmp( cargv[0], "TLSCertificateFile" ) ) {
705 rc = ldap_pvt_tls_set_option( NULL,
706 LDAP_OPT_X_TLS_CERTFILE,
711 } else if ( !strcasecmp( cargv[0], "TLSCertificateKeyFile" ) ) {
712 rc = ldap_pvt_tls_set_option( NULL,
713 LDAP_OPT_X_TLS_KEYFILE,
718 } else if ( !strcasecmp( cargv[0], "TLSCACertificatePath" ) ) {
719 rc = ldap_pvt_tls_set_option( NULL,
720 LDAP_OPT_X_TLS_CACERTDIR,
725 } else if ( !strcasecmp( cargv[0], "TLSCACertificateFile" ) ) {
726 rc = ldap_pvt_tls_set_option( NULL,
727 LDAP_OPT_X_TLS_CACERTFILE,
731 } else if ( !strcasecmp( cargv[0], "TLSVerifyClient" ) ) {
732 rc = ldap_pvt_tls_set_option( NULL,
733 LDAP_OPT_X_TLS_REQUIRE_CERT,
740 /* pass anything else to the current backend info/db config routine */
743 if ( bi->bi_config == 0 ) {
744 Debug( LDAP_DEBUG_ANY,
745 "%s: line %d: unknown directive \"%s\" inside backend info definition (ignored)\n",
746 fname, lineno, cargv[0] );
748 if ( (*bi->bi_config)( bi, fname, lineno, cargc, cargv )
754 } else if ( be != NULL ) {
755 if ( be->be_config == 0 ) {
756 Debug( LDAP_DEBUG_ANY,
757 "%s: line %d: unknown directive \"%s\" inside backend database definition (ignored)\n",
758 fname, lineno, cargv[0] );
760 if ( (*be->be_config)( be, fname, lineno, cargc, cargv )
767 Debug( LDAP_DEBUG_ANY,
768 "%s: line %d: unknown directive \"%s\" outside backend info and database definitions (ignored)\n",
769 fname, lineno, cargv[0] );
788 for ( token = strtok_quote( line, " \t" ); token != NULL;
789 token = strtok_quote( NULL, " \t" ) ) {
790 if ( *argcp == MAXARGS ) {
791 Debug( LDAP_DEBUG_ANY, "Too many tokens (max %d)\n",
795 argv[(*argcp)++] = token;
802 strtok_quote( char *line, char *sep )
808 if ( line != NULL ) {
811 while ( *next && strchr( sep, *next ) ) {
815 if ( *next == '\0' ) {
821 for ( inquote = 0; *next; ) {
829 SAFEMEMCPY( next, next + 1, strlen( next + 1 ) + 1 );
835 next + 1, strlen( next + 1 ) + 1 );
836 next++; /* dont parse the escaped character */
841 if ( strchr( sep, *next ) != NULL ) {
854 static char buf[BUFSIZ];
856 static int lmax, lcur;
858 #define CATLINE( buf ) { \
860 len = strlen( buf ); \
861 while ( lcur + len + 1 > lmax ) { \
863 line = (char *) ch_realloc( line, lmax ); \
865 strcpy( line + lcur, buf ); \
870 fp_getline( FILE *fp, int *lineno )
878 /* hack attack - keeps us from having to keep a stack of bufs... */
879 if ( strncasecmp( line, "include", 7 ) == 0 ) {
884 while ( fgets( buf, sizeof(buf), fp ) != NULL ) {
885 if ( (p = strchr( buf, '\n' )) != NULL ) {
888 if ( ! isspace( (unsigned char) buf[0] ) ) {
897 return( line[0] ? line : NULL );
901 fp_getline_init( int *lineno )