1 /* config.c - configuration file handling routines */
4 * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
15 #include <ac/string.h>
17 #include <ac/socket.h>
25 * defaults for various global variables
27 int defsize = SLAPD_DEFAULT_SIZELIMIT;
28 int deftime = SLAPD_DEFAULT_TIMELIMIT;
29 AccessControl *global_acl = NULL;
30 int global_default_access = ACL_READ;
31 int global_readonly = 0;
33 int global_lastmod = ON;
34 int global_idletimeout = 0;
35 char *global_realm = NULL;
36 char *ldap_srvtab = "";
38 char *slapd_pid_file = NULL;
39 char *slapd_args_file = NULL;
41 static char *fp_getline(FILE *fp, int *lineno);
42 static void fp_getline_init(int *lineno);
43 static int fp_parse_line(char *line, int *argcp, char **argv);
45 static char *strtok_quote(char *line, char *sep);
48 read_config( const char *fname )
51 char *line, *savefname, *saveline;
52 int cargc, savelineno;
58 struct berval *vals[2];
61 static BackendInfo *bi = NULL;
62 static BackendDB *be = NULL;
67 if ( (fp = fopen( fname, "r" )) == NULL ) {
69 Debug( LDAP_DEBUG_ANY,
70 "could not open config file \"%s\" - absolute path?\n",
76 Debug( LDAP_DEBUG_CONFIG, "reading config file %s\n", fname, 0, 0 );
78 if ( schema_init( ) != 0 ) {
79 Debug( LDAP_DEBUG_ANY,
80 "error initializing the schema\n",
85 fp_getline_init( &lineno );
87 while ( (line = fp_getline( fp, &lineno )) != NULL ) {
88 /* skip comments and blank lines */
89 if ( line[0] == '#' || line[0] == '\0' ) {
93 Debug( LDAP_DEBUG_CONFIG, "line %d (%s)\n", lineno, line, 0 );
95 /* fp_parse_line is destructive, we save a copy */
96 saveline = ch_strdup( line );
98 if ( fp_parse_line( line, &cargc, cargv ) != 0 ) {
103 Debug( LDAP_DEBUG_ANY,
104 "%s: line %d: bad config line (ignored)\n",
109 if ( strcasecmp( cargv[0], "backend" ) == 0 ) {
111 Debug( LDAP_DEBUG_ANY,
112 "%s: line %d: missing type in \"backend <type>\" line\n",
118 Debug( LDAP_DEBUG_ANY,
119 "%s: line %d: backend line must appear before any database definition\n",
124 bi = backend_info( cargv[1] );
126 /* start of a new database definition */
127 } else if ( strcasecmp( cargv[0], "database" ) == 0 ) {
129 Debug( LDAP_DEBUG_ANY,
130 "%s: line %d: missing type in \"database <type>\" line\n",
135 be = backend_db_init( cargv[1] );
137 /* get pid file name */
138 } else if ( strcasecmp( cargv[0], "pidfile" ) == 0 ) {
140 Debug( LDAP_DEBUG_ANY,
141 "%s: line %d: missing file name in \"pidfile <file>\" line\n",
146 slapd_pid_file = ch_strdup( cargv[1] );
148 /* get args file name */
149 } else if ( strcasecmp( cargv[0], "argsfile" ) == 0 ) {
151 Debug( LDAP_DEBUG_ANY,
152 "%s: line %d: missing file name in \"argsfile <file>\" line\n",
157 slapd_args_file = ch_strdup( cargv[1] );
159 /* set DIGEST realm */
160 } else if ( strcasecmp( cargv[0], "digest-realm" ) == 0 ) {
162 Debug( LDAP_DEBUG_ANY,
163 "%s: line %d: missing realm in \"digest-realm <realm>\" line\n",
168 be->be_realm = ch_strdup( cargv[1] );
170 } else if ( global_realm != NULL ) {
171 Debug( LDAP_DEBUG_ANY,
172 "%s: line %d: already set global realm!\n",
177 global_realm = ch_strdup( cargv[1] );
181 } else if ( strcasecmp( cargv[0], "sizelimit" ) == 0 ) {
183 Debug( LDAP_DEBUG_ANY,
184 "%s: line %d: missing limit in \"sizelimit <limit>\" line\n",
189 defsize = atoi( cargv[1] );
191 be->be_sizelimit = atoi( cargv[1] );
195 } else if ( strcasecmp( cargv[0], "timelimit" ) == 0 ) {
197 Debug( LDAP_DEBUG_ANY,
198 "%s: line %d: missing limit in \"timelimit <limit>\" line\n",
203 deftime = atoi( cargv[1] );
205 be->be_timelimit = atoi( cargv[1] );
208 /* set database suffix */
209 } else if ( strcasecmp( cargv[0], "suffix" ) == 0 ) {
212 Debug( LDAP_DEBUG_ANY,
213 "%s: line %d: missing dn in \"suffix <dn>\" line\n",
216 } else if ( cargc > 2 ) {
217 Debug( LDAP_DEBUG_ANY,
218 "%s: line %d: extra cruft after <dn> in \"suffix %s\" line (ignored)\n",
219 fname, lineno, cargv[1] );
222 Debug( LDAP_DEBUG_ANY,
223 "%s: line %d: suffix line must appear inside a database definition (ignored)\n",
225 } else if ( ( tmp_be = select_backend( cargv[1] ) ) == be ) {
226 Debug( LDAP_DEBUG_ANY,
227 "%s: line %d: suffix already served by this backend (ignored)\n",
229 } else if ( tmp_be != NULL ) {
230 Debug( LDAP_DEBUG_ANY,
231 "%s: line %d: suffix already served by a preceeding backend \"%s\" (ignored)\n",
232 fname, lineno, tmp_be->be_suffix[0] );
234 char *dn = ch_strdup( cargv[1] );
235 (void) dn_normalize( dn );
236 charray_add( &be->be_suffix, dn );
237 (void) ldap_pvt_str2upper( dn );
238 charray_add( &be->be_nsuffix, dn );
242 /* set database suffixAlias */
243 } else if ( strcasecmp( cargv[0], "suffixAlias" ) == 0 ) {
246 Debug( LDAP_DEBUG_ANY,
247 "%s: line %d: missing alias and aliased_dn in \"suffixAlias <alias> <aliased_dn>\" line\n",
250 } else if ( cargc < 3 ) {
251 Debug( LDAP_DEBUG_ANY,
252 "%s: line %d: missing aliased_dn in \"suffixAlias <alias> <aliased_dn>\" line\n",
255 } else if ( cargc > 3 ) {
256 Debug( LDAP_DEBUG_ANY,
257 "%s: line %d: extra cruft in suffixAlias line (ignored)\n",
262 Debug( LDAP_DEBUG_ANY,
263 "%s: line %d: suffixAlias line"
264 " must appear inside a database definition (ignored)\n",
266 } else if ( (tmp_be = select_backend( cargv[1] )) != NULL ) {
267 Debug( LDAP_DEBUG_ANY,
268 "%s: line %d: suffixAlias served by"
269 " a preceeding backend \"%s\" (ignored)\n",
270 fname, lineno, tmp_be->be_suffix[0] );
272 } else if ( (tmp_be = select_backend( cargv[2] )) != NULL ) {
273 Debug( LDAP_DEBUG_ANY,
274 "%s: line %d: suffixAlias derefs to differnet backend"
275 " a preceeding backend \"%s\" (ignored)\n",
276 fname, lineno, tmp_be->be_suffix[0] );
279 char *alias, *aliased_dn;
281 alias = ch_strdup( cargv[1] );
282 (void) dn_normalize( alias );
284 aliased_dn = ch_strdup( cargv[2] );
285 (void) dn_normalize( aliased_dn );
287 (void) dn_normalize_case( alias );
288 (void) dn_normalize_case( aliased_dn );
289 charray_add( &be->be_suffixAlias, alias );
290 charray_add( &be->be_suffixAlias, aliased_dn );
296 /* set max deref depth */
297 } else if ( strcasecmp( cargv[0], "maxDerefDepth" ) == 0 ) {
300 Debug( LDAP_DEBUG_ANY,
301 "%s: line %d: missing depth in \"maxDerefDepth <depth>\" line\n",
306 Debug( LDAP_DEBUG_ANY,
307 "%s: line %d: depth line must appear inside a database definition (ignored)\n",
309 } else if ((i = atoi(cargv[1])) < 0) {
310 Debug( LDAP_DEBUG_ANY,
311 "%s: line %d: depth must be positive (ignored)\n",
315 be->be_max_deref_depth = i;
319 /* set magic "root" dn for this database */
320 } else if ( strcasecmp( cargv[0], "rootdn" ) == 0 ) {
322 Debug( LDAP_DEBUG_ANY,
323 "%s: line %d: missing dn in \"rootdn <dn>\" line\n",
328 Debug( LDAP_DEBUG_ANY,
329 "%s: line %d: rootdn line must appear inside a database definition (ignored)\n",
332 be->be_root_dn = ch_strdup( cargv[1] );
333 be->be_root_ndn = ch_strdup( cargv[1] );
335 if( dn_normalize_case( be->be_root_ndn ) == NULL ) {
336 free( be->be_root_dn );
337 free( be->be_root_ndn );
338 Debug( LDAP_DEBUG_ANY,
339 "%s: line %d: rootdn DN is invalid\n",
345 /* set super-secret magic database password */
346 } else if ( strcasecmp( cargv[0], "rootpw" ) == 0 ) {
348 Debug( LDAP_DEBUG_ANY,
349 "%s: line %d: missing passwd in \"rootpw <passwd>\" line\n",
354 Debug( LDAP_DEBUG_ANY,
355 "%s: line %d: rootpw line must appear inside a database definition (ignored)\n",
358 be->be_root_pw = ch_strdup( cargv[1] );
361 /* make this database read-only */
362 } else if ( strcasecmp( cargv[0], "readonly" ) == 0 ) {
364 Debug( LDAP_DEBUG_ANY,
365 "%s: line %d: missing on|off in \"readonly <on|off>\" line\n",
370 global_readonly = (strcasecmp( cargv[1], "on" ) == 0);
372 if ( strcasecmp( cargv[1], "on" ) == 0 ) {
379 /* where to send clients when we don't hold it */
380 } else if ( strcasecmp( cargv[0], "referral" ) == 0 ) {
382 Debug( LDAP_DEBUG_ANY,
383 "%s: line %d: missing URL in \"referral <URL>\" line\n",
388 vals[0]->bv_val = cargv[1];
389 vals[0]->bv_len = strlen( vals[0]->bv_val );
390 value_add( &default_referral, vals );
393 } else if ( strcasecmp( cargv[0], "locale" ) == 0 ) {
397 Debug( LDAP_DEBUG_ANY,
398 "%s: line %d: missing locale in \"locale <name | on | off>\" line\n",
403 locale = (strcasecmp( cargv[1], "on" ) == 0 ? ""
404 : strcasecmp( cargv[1], "off" ) == 0 ? "C"
405 : ch_strdup( cargv[1] ) );
407 if ( setlocale( LC_CTYPE, locale ) == 0 ) {
408 Debug( LDAP_DEBUG_ANY,
410 ? "%s: line %d: bad locale \"%s\"\n"
411 : "%s: line %d: bad locale\n"),
412 fname, lineno, locale );
416 Debug( LDAP_DEBUG_ANY,
417 "%s: line %d: \"locale\" unsupported\n",
421 /* specify an Object Identifier macro */
422 } else if ( strcasecmp( cargv[0], "objectidentifier" ) == 0 ) {
423 parse_oidm( fname, lineno, cargc, cargv );
424 /* specify an objectclass */
425 } else if ( strcasecmp( cargv[0], "objectclass" ) == 0 ) {
426 if ( *cargv[1] == '(' ) {
428 p = strchr(saveline,'(');
429 parse_oc( fname, lineno, p, cargv );
431 parse_oc_old( be, fname, lineno, cargc, cargv );
434 /* specify an attribute */
435 } else if ( strcasecmp( cargv[0], "attribute" ) == 0 ) {
436 if ( *cargv[1] == '(' ) {
438 p = strchr(saveline,'(');
439 parse_at( fname, lineno, p, cargv );
441 attr_syntax_config( fname, lineno, cargc - 1,
445 /* turn on/off schema checking */
446 } else if ( strcasecmp( cargv[0], "schemacheck" ) == 0 ) {
448 Debug( LDAP_DEBUG_ANY,
449 "%s: line %d: missing on|off in \"schemacheck <on|off>\" line\n",
453 if ( strcasecmp( cargv[1], "off" ) == 0 ) {
454 global_schemacheck = 0;
456 global_schemacheck = 1;
459 /* specify access control info */
460 } else if ( strcasecmp( cargv[0], "access" ) == 0 ) {
461 parse_acl( be, fname, lineno, cargc, cargv );
463 /* specify default access control info */
464 } else if ( strcasecmp( cargv[0], "defaultaccess" ) == 0 ) {
466 Debug( LDAP_DEBUG_ANY,
467 "%s: line %d: missing limit in \"defaultaccess <access>\" line\n",
472 if ( ACL_IS_INVALID(ACL_SET(global_default_access,
473 str2access(cargv[1]))) )
475 Debug( LDAP_DEBUG_ANY,
476 "%s: line %d: bad access \"%s\" expecting [self]{none|auth|compare|search|read|write}\n",
477 fname, lineno, cargv[1] );
481 if ( ACL_IS_INVALID(ACL_SET(be->be_dfltaccess,
482 str2access(cargv[1]))) )
484 Debug( LDAP_DEBUG_ANY,
485 "%s: line %d: bad access \"%s\", "
486 "expecting [self]{none|auth|compare|search|read|write}\n",
487 fname, lineno, cargv[1] );
492 /* debug level to log things to syslog */
493 } else if ( strcasecmp( cargv[0], "loglevel" ) == 0 ) {
495 Debug( LDAP_DEBUG_ANY,
496 "%s: line %d: missing level in \"loglevel <level>\" line\n",
500 ldap_syslog = atoi( cargv[1] );
502 /* list of replicas of the data in this backend (master only) */
503 } else if ( strcasecmp( cargv[0], "replica" ) == 0 ) {
505 Debug( LDAP_DEBUG_ANY,
506 "%s: line %d: missing host in \"replica <host[:port]>\" line\n",
511 Debug( LDAP_DEBUG_ANY,
512 "%s: line %d: replica line must appear inside a database definition (ignored)\n",
515 for ( i = 1; i < cargc; i++ ) {
516 if ( strncasecmp( cargv[i], "host=", 5 )
518 charray_add( &be->be_replica,
524 Debug( LDAP_DEBUG_ANY,
525 "%s: line %d: missing host in \"replica\" line (ignored)\n",
530 /* dn of master entity allowed to write to replica */
531 } else if ( strcasecmp( cargv[0], "updatedn" ) == 0 ) {
533 Debug( LDAP_DEBUG_ANY,
534 "%s: line %d: missing dn in \"updatedn <dn>\" line\n",
539 Debug( LDAP_DEBUG_ANY,
540 "%s: line %d: updatedn line must appear inside a database definition (ignored)\n",
543 be->be_update_ndn = ch_strdup( cargv[1] );
544 if( dn_normalize_case( be->be_update_ndn ) == NULL ) {
545 Debug( LDAP_DEBUG_ANY,
546 "%s: line %d: updatedn DN is invalid\n",
552 } else if ( strcasecmp( cargv[0], "updateref" ) == 0 ) {
554 Debug( LDAP_DEBUG_ANY,
555 "%s: line %d: missing dn in \"updateref <ldapurl>\" line\n",
560 Debug( LDAP_DEBUG_ANY,
561 "%s: line %d: updateref line must appear inside a database definition (ignored)\n",
563 } else if ( be->be_update_ndn == NULL ) {
564 Debug( LDAP_DEBUG_ANY,
565 "%s: line %d: updateref line must after updatedn (ignored)\n",
568 vals[0]->bv_val = cargv[1];
569 vals[0]->bv_len = strlen( vals[0]->bv_val );
570 value_add( &be->be_update_refs, vals );
573 /* replication log file to which changes are appended */
574 } else if ( strcasecmp( cargv[0], "replogfile" ) == 0 ) {
576 Debug( LDAP_DEBUG_ANY,
577 "%s: line %d: missing dn in \"replogfile <filename>\" line\n",
582 be->be_replogfile = ch_strdup( cargv[1] );
584 replogfile = ch_strdup( cargv[1] );
587 /* maintain lastmodified{by,time} attributes */
588 } else if ( strcasecmp( cargv[0], "lastmod" ) == 0 ) {
590 Debug( LDAP_DEBUG_ANY,
591 "%s: line %d: missing on|off in \"lastmod <on|off>\" line\n",
595 if ( strcasecmp( cargv[1], "on" ) == 0 ) {
602 be->be_lastmod = OFF;
604 global_lastmod = OFF;
607 /* set idle timeout value */
608 } else if ( strcasecmp( cargv[0], "idletimeout" ) == 0 ) {
611 Debug( LDAP_DEBUG_ANY,
612 "%s: line %d: missing timeout value in \"idletimeout <seconds>\" line\n",
617 i = atoi( cargv[1] );
620 Debug( LDAP_DEBUG_ANY,
621 "%s: line %d: timeout value (%d) invalid \"idletimeout <seconds>\" line\n",
626 global_idletimeout = i;
628 /* include another config file */
629 } else if ( strcasecmp( cargv[0], "include" ) == 0 ) {
631 Debug( LDAP_DEBUG_ANY,
632 "%s: line %d: missing filename in \"include <filename>\" line\n",
636 savefname = ch_strdup( cargv[1] );
639 if ( read_config( savefname ) != 0 ) {
644 lineno = savelineno - 1;
646 /* location of kerberos srvtab file */
647 } else if ( strcasecmp( cargv[0], "srvtab" ) == 0 ) {
649 Debug( LDAP_DEBUG_ANY,
650 "%s: line %d: missing filename in \"srvtab <filename>\" line\n",
654 ldap_srvtab = ch_strdup( cargv[1] );
657 } else if (strcasecmp( cargv[0], "moduleload") == 0 ) {
659 Debug( LDAP_DEBUG_ANY,
660 "%s: line %d: missing filename in \"moduleload <filename>\" line\n",
662 exit( EXIT_FAILURE );
664 if (module_load(cargv[1], cargc - 2, (cargc > 2) ? cargv + 2 : NULL)) {
665 Debug( LDAP_DEBUG_ANY,
666 "%s: line %d: failed to load or initialize module %s\n",
667 fname, lineno, cargv[1]);
668 exit( EXIT_FAILURE );
670 } else if (strcasecmp( cargv[0], "modulepath") == 0 ) {
672 Debug( LDAP_DEBUG_ANY,
673 "%s: line %d: missing path in \"modulepath <path>\" line\n",
675 exit( EXIT_FAILURE );
677 if (module_path( cargv[1] )) {
678 Debug( LDAP_DEBUG_ANY,
679 "%s: line %d: failed to set module search path to %s\n",
680 fname, lineno, cargv[1]);
681 exit( EXIT_FAILURE );
684 #endif /*SLAPD_MODULES*/
687 } else if ( !strcasecmp( cargv[0], "TLSProtocol" ) ) {
688 rc = ldap_pvt_tls_set_option( NULL,
689 LDAP_OPT_X_TLS_PROTOCOL,
694 } else if ( !strcasecmp( cargv[0], "TLSCipherSuite" ) ) {
695 rc = ldap_pvt_tls_set_option( NULL,
696 LDAP_OPT_X_TLS_CIPHER_SUITE,
701 } else if ( !strcasecmp( cargv[0], "TLSCertificateFile" ) ) {
702 rc = ldap_pvt_tls_set_option( NULL,
703 LDAP_OPT_X_TLS_CERTFILE,
708 } else if ( !strcasecmp( cargv[0], "TLSCertificateKeyFile" ) ) {
709 rc = ldap_pvt_tls_set_option( NULL,
710 LDAP_OPT_X_TLS_KEYFILE,
715 } else if ( !strcasecmp( cargv[0], "TLSCACertificatePath" ) ) {
716 rc = ldap_pvt_tls_set_option( NULL,
717 LDAP_OPT_X_TLS_CACERTDIR,
722 } else if ( !strcasecmp( cargv[0], "TLSCACertificateFile" ) ) {
723 rc = ldap_pvt_tls_set_option( NULL,
724 LDAP_OPT_X_TLS_CACERTFILE,
728 } else if ( !strcasecmp( cargv[0], "TLSVerifyClient" ) ) {
729 rc = ldap_pvt_tls_set_option( NULL,
730 LDAP_OPT_X_TLS_REQUIRE_CERT,
737 /* pass anything else to the current backend info/db config routine */
740 if ( bi->bi_config == 0 ) {
741 Debug( LDAP_DEBUG_ANY,
742 "%s: line %d: unknown directive \"%s\" inside backend info definition (ignored)\n",
743 fname, lineno, cargv[0] );
745 if ( (*bi->bi_config)( bi, fname, lineno, cargc, cargv )
751 } else if ( be != NULL ) {
752 if ( be->be_config == 0 ) {
753 Debug( LDAP_DEBUG_ANY,
754 "%s: line %d: unknown directive \"%s\" inside backend database definition (ignored)\n",
755 fname, lineno, cargv[0] );
757 if ( (*be->be_config)( be, fname, lineno, cargc, cargv )
764 Debug( LDAP_DEBUG_ANY,
765 "%s: line %d: unknown directive \"%s\" outside backend info and database definitions (ignored)\n",
766 fname, lineno, cargv[0] );
785 for ( token = strtok_quote( line, " \t" ); token != NULL;
786 token = strtok_quote( NULL, " \t" ) ) {
787 if ( *argcp == MAXARGS ) {
788 Debug( LDAP_DEBUG_ANY, "Too many tokens (max %d)\n",
792 argv[(*argcp)++] = token;
799 strtok_quote( char *line, char *sep )
805 if ( line != NULL ) {
808 while ( *next && strchr( sep, *next ) ) {
812 if ( *next == '\0' ) {
818 for ( inquote = 0; *next; ) {
826 SAFEMEMCPY( next, next + 1, strlen( next + 1 ) + 1 );
832 next + 1, strlen( next + 1 ) + 1 );
833 next++; /* dont parse the escaped character */
838 if ( strchr( sep, *next ) != NULL ) {
851 static char buf[BUFSIZ];
853 static int lmax, lcur;
855 #define CATLINE( buf ) { \
857 len = strlen( buf ); \
858 while ( lcur + len + 1 > lmax ) { \
860 line = (char *) ch_realloc( line, lmax ); \
862 strcpy( line + lcur, buf ); \
867 fp_getline( FILE *fp, int *lineno )
875 /* hack attack - keeps us from having to keep a stack of bufs... */
876 if ( strncasecmp( line, "include", 7 ) == 0 ) {
881 while ( fgets( buf, sizeof(buf), fp ) != NULL ) {
882 if ( (p = strchr( buf, '\n' )) != NULL ) {
885 if ( ! isspace( (unsigned char) buf[0] ) ) {
894 return( line[0] ? line : NULL );
898 fp_getline_init( int *lineno )