2 * ngIRCd -- The Next Generation IRC Daemon
3 * Copyright (c)2001-2013 Alexander Barton (alex@barton.de) and Contributors.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 * Please read the file COPYING, README and AUTHORS for more information.
16 * Configuration management (reading, parsing & validation)
35 #include <sys/types.h>
52 static bool Use_Log = true, Using_MotdFile = true;
53 static CONF_SERVER New_Server;
54 static int New_Server_Idx;
56 static char Conf_MotdFile[FNAME_LEN];
57 static char Conf_HelpFile[FNAME_LEN];
58 static char Conf_IncludeDir[FNAME_LEN];
60 static void Set_Defaults PARAMS(( bool InitServers ));
61 static bool Read_Config PARAMS(( bool TestOnly, bool IsStarting ));
62 static void Read_Config_File PARAMS(( const char *File, FILE *fd ));
63 static bool Validate_Config PARAMS(( bool TestOnly, bool Rehash ));
65 static void Handle_GLOBAL PARAMS((const char *File, int Line,
66 char *Var, char *Arg ));
67 static void Handle_LIMITS PARAMS((const char *File, int Line,
68 char *Var, char *Arg ));
69 static void Handle_OPTIONS PARAMS((const char *File, int Line,
70 char *Var, char *Arg ));
71 static void Handle_OPERATOR PARAMS((const char *File, int Line,
72 char *Var, char *Arg ));
73 static void Handle_SERVER PARAMS((const char *File, int Line,
74 char *Var, char *Arg ));
75 static void Handle_CHANNEL PARAMS((const char *File, int Line,
76 char *Var, char *Arg ));
78 static void Config_Error PARAMS((const int Level, const char *Format, ...));
80 static void Config_Error_NaN PARAMS((const char *File, const int LINE,
82 static void Config_Error_Section PARAMS((const char *File, const int Line,
83 const char *Item, const char *Section));
84 static void Config_Error_TooLong PARAMS((const char *File, const int LINE,
87 static void Init_Server_Struct PARAMS(( CONF_SERVER *Server ));
91 #define DEFAULT_LISTEN_ADDRSTR "::,0.0.0.0"
93 #define DEFAULT_LISTEN_ADDRSTR "0.0.0.0"
97 #define DEFAULT_CIPHERS "HIGH:!aNULL:@STRENGTH"
100 #define DEFAULT_CIPHERS "SECURE128"
105 static void Handle_SSL PARAMS((const char *File, int Line, char *Var, char *Ark));
107 struct SSLOptions Conf_SSLOptions;
110 * Initialize SSL configuration.
115 free(Conf_SSLOptions.KeyFile);
116 Conf_SSLOptions.KeyFile = NULL;
118 free(Conf_SSLOptions.CertFile);
119 Conf_SSLOptions.CertFile = NULL;
121 free(Conf_SSLOptions.DHFile);
122 Conf_SSLOptions.DHFile = NULL;
123 array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
125 array_free(&Conf_SSLOptions.ListenPorts);
127 free(Conf_SSLOptions.CipherList);
128 Conf_SSLOptions.CipherList = NULL;
132 * Check if the current configuration uses/requires SSL.
134 * @returns true if SSL is used and should be initialized.
141 /* SSL listen ports configured? */
142 if (array_bytes(&Conf_SSLOptions.ListenPorts))
145 for (i = 0; i < MAX_SERVERS; i++) {
146 if (Conf_Server[i].port > 0
147 && Conf_Server[i].SSLConnect)
154 * Make sure that a configured file is readable.
156 * Currently, this function is only used for SSL-related options ...
158 * @param Var Configuration variable
159 * @param Filename Configured filename
162 CheckFileReadable(const char *Var, const char *Filename)
169 fp = fopen(Filename, "r");
173 Config_Error(LOG_ERR, "Can't read \"%s\" (\"%s\"): %s",
174 Filename, Var, strerror(errno));
181 * Duplicate string and warn on errors.
183 * @returns Pointer to string on success, NULL otherwise.
186 strdup_warn(const char *str)
188 char *ptr = strdup(str);
190 Config_Error(LOG_ERR,
191 "Could not allocate memory for string: %s", str);
196 * Output a comma separated list of ports (integer values).
203 len = array_length(a, sizeof(UINT16));
205 ports = (UINT16*) array_start(a);
206 printf("%u", (unsigned int) *ports);
209 printf(", %u", (unsigned int) *ports);
216 * Parse a comma separated string into an array of port numbers (integers).
219 ports_parse(array *a, const char *File, int Line, char *Arg)
227 ptr = strtok( Arg, "," );
231 if (port > 0 && port < 0xFFFF) {
232 port16 = (UINT16) port;
233 if (!array_catb(a, (char*)&port16, sizeof port16))
234 Config_Error(LOG_ERR, "%s, line %d Could not add port number %ld: %s",
235 File, Line, port, strerror(errno));
237 Config_Error( LOG_ERR, "%s, line %d (section \"Global\"): Illegal port number %ld!",
241 ptr = strtok( NULL, "," );
246 * Initialize configuration module.
251 Read_Config(false, true);
252 Validate_Config(false, false);
256 * "Rehash" (reload) server configuration.
258 * @returns true if configuration has been re-read, false on errors.
263 if (!Read_Config(false, false))
265 Validate_Config(false, true);
267 /* Update CLIENT structure of local server */
268 Client_SetInfo(Client_ThisServer(), Conf_ServerInfo);
273 * Output a boolean value as "yes/no" string.
276 yesno_to_str(int boolean_value)
284 * Free all IRC operator configuration structures.
289 struct Conf_Oper *op;
292 len = array_length(&Conf_Opers, sizeof(*op));
293 op = array_start(&Conf_Opers);
298 array_free(&Conf_Opers);
302 * Output all IRC operator configuration structures.
307 struct Conf_Oper *op;
310 count = array_length(&Conf_Opers, sizeof(*op));
311 op = array_start(&Conf_Opers);
312 for (i = 0; i < count; i++, op++) {
317 printf(" Name = %s\n", op->name);
318 printf(" Password = %s\n", op->pwd);
319 printf(" Mask = %s\n\n", op->mask ? op->mask : "");
324 * Read configuration, validate and output it.
326 * This function waits for a keypress of the user when stdin/stdout are valid
327 * tty's ("you can read our nice message and we can read in your keypress").
329 * @return 0 on success, 1 on failure(s); therefore the result code can
330 * directly be used by exit() when running "ngircd --configtest".
339 size_t predef_channel_count;
340 struct Conf_Channel *predef_chan;
344 if (!Read_Config(true, true))
347 config_valid = Validate_Config(true, false);
350 if(isatty(fileno(stdin)) && isatty(fileno(stdout))) {
351 puts("OK, press enter to see a dump of your server configuration ...");
354 puts("Ok, dump of your server configuration follows:\n");
357 printf(" Name = %s\n", Conf_ServerName);
358 printf(" AdminInfo1 = %s\n", Conf_ServerAdmin1);
359 printf(" AdminInfo2 = %s\n", Conf_ServerAdmin2);
360 printf(" AdminEMail = %s\n", Conf_ServerAdminMail);
361 printf(" HelpFile = %s\n", Conf_HelpFile);
362 printf(" Info = %s\n", Conf_ServerInfo);
363 printf(" Listen = %s\n", Conf_ListenAddress);
364 if (Using_MotdFile) {
365 printf(" MotdFile = %s\n", Conf_MotdFile);
366 printf(" MotdPhrase =\n");
368 printf(" MotdFile = \n");
369 printf(" MotdPhrase = %s\n", array_bytes(&Conf_Motd)
370 ? (const char*) array_start(&Conf_Motd) : "");
372 printf(" Network = %s\n", Conf_Network);
374 printf(" Password = %s\n", Conf_ServerPwd);
375 printf(" PidFile = %s\n", Conf_PidFile);
377 ports_puts(&Conf_ListenPorts);
378 grp = getgrgid(Conf_GID);
380 printf(" ServerGID = %s\n", grp->gr_name);
382 printf(" ServerGID = %ld\n", (long)Conf_GID);
383 pwd = getpwuid(Conf_UID);
385 printf(" ServerUID = %s\n", pwd->pw_name);
387 printf(" ServerUID = %ld\n", (long)Conf_UID);
391 printf(" ConnectRetry = %d\n", Conf_ConnectRetry);
392 printf(" IdleTimeout = %d\n", Conf_IdleTimeout);
393 printf(" MaxConnections = %d\n", Conf_MaxConnections);
394 printf(" MaxConnectionsIP = %d\n", Conf_MaxConnectionsIP);
395 printf(" MaxJoins = %d\n", Conf_MaxJoins > 0 ? Conf_MaxJoins : -1);
396 printf(" MaxNickLength = %u\n", Conf_MaxNickLength - 1);
397 printf(" MaxListSize = %d\n", Conf_MaxListSize);
398 printf(" PingTimeout = %d\n", Conf_PingTimeout);
399 printf(" PongTimeout = %d\n", Conf_PongTimeout);
403 printf(" AllowedChannelTypes = %s\n", Conf_AllowedChannelTypes);
404 printf(" AllowRemoteOper = %s\n", yesno_to_str(Conf_AllowRemoteOper));
405 printf(" ChrootDir = %s\n", Conf_Chroot);
406 printf(" CloakHost = %s\n", Conf_CloakHost);
407 printf(" CloakHostModeX = %s\n", Conf_CloakHostModeX);
408 printf(" CloakHostSalt = %s\n", Conf_CloakHostSalt);
409 printf(" CloakUserToNick = %s\n", yesno_to_str(Conf_CloakUserToNick));
411 printf(" ConnectIPv4 = %s\n", yesno_to_str(Conf_ConnectIPv6));
412 printf(" ConnectIPv6 = %s\n", yesno_to_str(Conf_ConnectIPv4));
414 printf(" DefaultUserModes = %s\n", Conf_DefaultUserModes);
415 printf(" DNS = %s\n", yesno_to_str(Conf_DNS));
417 printf(" Ident = %s\n", yesno_to_str(Conf_Ident));
419 printf(" IncludeDir = %s\n", Conf_IncludeDir);
420 printf(" MorePrivacy = %s\n", yesno_to_str(Conf_MorePrivacy));
421 printf(" NoticeAuth = %s\n", yesno_to_str(Conf_NoticeAuth));
422 printf(" OperCanUseMode = %s\n", yesno_to_str(Conf_OperCanMode));
423 printf(" OperChanPAutoOp = %s\n", yesno_to_str(Conf_OperChanPAutoOp));
424 printf(" OperServerMode = %s\n", yesno_to_str(Conf_OperServerMode));
426 printf(" PAM = %s\n", yesno_to_str(Conf_PAM));
427 printf(" PAMIsOptional = %s\n", yesno_to_str(Conf_PAMIsOptional));
430 printf(" RequireAuthPing = %s\n", yesno_to_str(Conf_AuthPing));
432 printf(" ScrubCTCP = %s\n", yesno_to_str(Conf_ScrubCTCP));
434 printf(" SyslogFacility = %s\n",
435 ngt_SyslogFacilityName(Conf_SyslogFacility));
437 printf(" WebircPassword = %s\n", Conf_WebircPwd);
442 printf(" CertFile = %s\n", Conf_SSLOptions.CertFile
443 ? Conf_SSLOptions.CertFile : "");
444 printf(" CipherList = %s\n", Conf_SSLOptions.CipherList ?
445 Conf_SSLOptions.CipherList : DEFAULT_CIPHERS);
446 printf(" DHFile = %s\n", Conf_SSLOptions.DHFile
447 ? Conf_SSLOptions.DHFile : "");
448 printf(" KeyFile = %s\n", Conf_SSLOptions.KeyFile
449 ? Conf_SSLOptions.KeyFile : "");
450 if (array_bytes(&Conf_SSLOptions.KeyFilePassword))
451 puts(" KeyFilePassword = <secret>");
453 puts(" KeyFilePassword = ");
454 array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
456 ports_puts(&Conf_SSLOptions.ListenPorts);
462 for( i = 0; i < MAX_SERVERS; i++ ) {
463 if( ! Conf_Server[i].name[0] ) continue;
465 /* Valid "Server" section */
467 printf( " Name = %s\n", Conf_Server[i].name );
468 printf( " Host = %s\n", Conf_Server[i].host );
469 printf( " Port = %u\n", (unsigned int)Conf_Server[i].port );
471 printf( " SSLConnect = %s\n", Conf_Server[i].SSLConnect?"yes":"no");
473 printf( " MyPassword = %s\n", Conf_Server[i].pwd_in );
474 printf( " PeerPassword = %s\n", Conf_Server[i].pwd_out );
475 printf( " ServiceMask = %s\n", Conf_Server[i].svs_mask);
476 printf( " Group = %d\n", Conf_Server[i].group );
477 printf( " Passive = %s\n\n", Conf_Server[i].flags & CONF_SFLAG_DISABLED ? "yes" : "no");
480 predef_channel_count = array_length(&Conf_Channels, sizeof(*predef_chan));
481 predef_chan = array_start(&Conf_Channels);
483 for (i = 0; i < predef_channel_count; i++, predef_chan++) {
484 if (!predef_chan->name[0])
487 /* Valid "Channel" section */
489 printf(" Name = %s\n", predef_chan->name);
490 printf(" Modes = %s\n", predef_chan->modes);
491 printf(" Key = %s\n", predef_chan->key);
492 printf(" MaxUsers = %lu\n", predef_chan->maxusers);
493 printf(" Topic = %s\n", predef_chan->topic);
494 printf(" KeyFile = %s\n\n", predef_chan->keyfile);
497 return (config_valid ? 0 : 1);
501 * Remove connection information from configured server.
503 * If the server is set as "once", delete it from our configuration;
504 * otherwise set the time for the next connection attempt.
506 * Non-server connections will be silently ignored.
509 Conf_UnsetServer( CONN_ID Idx )
514 /* Check all our configured servers */
515 for( i = 0; i < MAX_SERVERS; i++ ) {
516 if( Conf_Server[i].conn_id != Idx ) continue;
518 /* Gotcha! Mark server configuration as "unused": */
519 Conf_Server[i].conn_id = NONE;
521 if( Conf_Server[i].flags & CONF_SFLAG_ONCE ) {
522 /* Delete configuration here */
523 Init_Server_Struct( &Conf_Server[i] );
525 /* Set time for next connect attempt */
527 if (Conf_Server[i].lasttry < t - Conf_ConnectRetry) {
528 /* The connection has been "long", so we don't
529 * require the next attempt to be delayed. */
530 Conf_Server[i].lasttry =
531 t - Conf_ConnectRetry + RECONNECT_DELAY;
533 /* "Short" connection, enforce "ConnectRetry"
534 * but randomize it a little bit: 15 seconds. */
535 Conf_Server[i].lasttry =
536 #ifdef HAVE_ARC4RANDOM
537 t + (arc4random() % 15);
539 t + rand() / (RAND_MAX / 15);
547 * Set connection information for specified configured server.
550 Conf_SetServer( int ConfServer, CONN_ID Idx )
552 assert( ConfServer > NONE );
553 assert( Idx > NONE );
555 if (Conf_Server[ConfServer].conn_id > NONE &&
556 Conf_Server[ConfServer].conn_id != Idx) {
558 "Connection %d: Server configuration of \"%s\" already in use by connection %d!",
559 Idx, Conf_Server[ConfServer].name,
560 Conf_Server[ConfServer].conn_id);
561 Conn_Close(Idx, NULL, "Server configuration already in use", true);
564 Conf_Server[ConfServer].conn_id = Idx;
569 * Get index of server in configuration structure.
572 Conf_GetServer( CONN_ID Idx )
576 assert( Idx > NONE );
578 for( i = 0; i < MAX_SERVERS; i++ ) {
579 if( Conf_Server[i].conn_id == Idx ) return i;
585 * Enable a server by name and adjust its port number.
587 * @returns true if a server has been enabled and now has a valid port
588 * number and host name for outgoing connections.
591 Conf_EnableServer( const char *Name, UINT16 Port )
595 assert( Name != NULL );
596 for( i = 0; i < MAX_SERVERS; i++ ) {
597 if( strcasecmp( Conf_Server[i].name, Name ) == 0 ) {
598 /* Gotcha! Set port and enable server: */
599 Conf_Server[i].port = Port;
600 Conf_Server[i].flags &= ~CONF_SFLAG_DISABLED;
601 return (Conf_Server[i].port && Conf_Server[i].host[0]);
608 * Enable a server by name.
610 * The server is only usable as outgoing server, if it has set a valid port
611 * number for outgoing connections!
612 * If not, you have to use Conf_EnableServer() function to make it available.
614 * @returns true if a server has been enabled; false otherwise.
617 Conf_EnablePassiveServer(const char *Name)
621 assert( Name != NULL );
622 for (i = 0; i < MAX_SERVERS; i++) {
623 if ((strcasecmp( Conf_Server[i].name, Name ) == 0)
624 && (Conf_Server[i].port > 0)) {
625 /* BINGO! Enable server */
626 Conf_Server[i].flags &= ~CONF_SFLAG_DISABLED;
634 * Disable a server by name.
635 * An already established connection will be disconnected.
637 * @returns true if a server was found and has been disabled.
640 Conf_DisableServer( const char *Name )
644 assert( Name != NULL );
645 for( i = 0; i < MAX_SERVERS; i++ ) {
646 if( strcasecmp( Conf_Server[i].name, Name ) == 0 ) {
647 /* Gotcha! Disable and disconnect server: */
648 Conf_Server[i].flags |= CONF_SFLAG_DISABLED;
649 if( Conf_Server[i].conn_id > NONE )
650 Conn_Close(Conf_Server[i].conn_id, NULL,
651 "Server link terminated on operator request",
660 * Add a new remote server to our configuration.
662 * @param Name Name of the new server.
663 * @param Port Port number to connect to or 0 for incoming connections.
664 * @param Host Host name to connect to.
665 * @param MyPwd Password that will be sent to the peer.
666 * @param PeerPwd Password that must be received from the peer.
667 * @returns true if the new server has been added; false otherwise.
670 Conf_AddServer(const char *Name, UINT16 Port, const char *Host,
671 const char *MyPwd, const char *PeerPwd)
675 assert( Name != NULL );
676 assert( Host != NULL );
677 assert( MyPwd != NULL );
678 assert( PeerPwd != NULL );
680 /* Search unused item in server configuration structure */
681 for( i = 0; i < MAX_SERVERS; i++ ) {
682 /* Is this item used? */
683 if( ! Conf_Server[i].name[0] ) break;
685 if( i >= MAX_SERVERS ) return false;
687 Init_Server_Struct( &Conf_Server[i] );
688 strlcpy( Conf_Server[i].name, Name, sizeof( Conf_Server[i].name ));
689 strlcpy( Conf_Server[i].host, Host, sizeof( Conf_Server[i].host ));
690 strlcpy( Conf_Server[i].pwd_out, MyPwd, sizeof( Conf_Server[i].pwd_out ));
691 strlcpy( Conf_Server[i].pwd_in, PeerPwd, sizeof( Conf_Server[i].pwd_in ));
692 Conf_Server[i].port = Port;
693 Conf_Server[i].flags = CONF_SFLAG_ONCE;
699 * Check if the given nickname is reserved for services on a particular server.
701 * @param ConfServer The server index to check.
702 * @param Nick The nickname to check.
703 * @returns true if the given nickname belongs to an "IRC service".
706 Conf_NickIsService(int ConfServer, const char *Nick)
708 assert (ConfServer >= 0);
709 assert (ConfServer < MAX_SERVERS);
711 return MatchCaseInsensitiveList(Conf_Server[ConfServer].svs_mask,
716 * Check if the given nickname is blocked for "normal client" use.
718 * @param ConfServer The server index or NONE to check all configured servers.
719 * @param Nick The nickname to check.
720 * @returns true if the given nickname belongs to an "IRC service".
723 Conf_NickIsBlocked(const char *Nick)
727 for(i = 0; i < MAX_SERVERS; i++) {
728 if (!Conf_Server[i].name[0])
730 if (Conf_NickIsService(i, Nick))
737 * Initialize configuration settings with their default values.
740 Set_Defaults(bool InitServers)
743 char random[RANDOM_SALT_LEN + 1];
746 strcpy(Conf_ServerName, "");
747 strcpy(Conf_ServerAdmin1, "");
748 strcpy(Conf_ServerAdmin2, "");
749 strcpy(Conf_ServerAdminMail, "");
750 snprintf(Conf_ServerInfo, sizeof Conf_ServerInfo, "%s %s",
751 PACKAGE_NAME, PACKAGE_VERSION);
752 strcpy(Conf_Network, "");
753 free(Conf_ListenAddress);
754 Conf_ListenAddress = NULL;
755 array_free(&Conf_ListenPorts);
756 array_free(&Conf_Motd);
757 array_free(&Conf_Helptext);
758 strlcpy(Conf_MotdFile, SYSCONFDIR, sizeof(Conf_MotdFile));
759 strlcat(Conf_MotdFile, MOTD_FILE, sizeof(Conf_MotdFile));
760 strlcpy(Conf_HelpFile, DOCDIR, sizeof(Conf_HelpFile));
761 strlcat(Conf_HelpFile, HELP_FILE, sizeof(Conf_HelpFile));
762 strcpy(Conf_ServerPwd, "");
763 strlcpy(Conf_PidFile, PID_FILE, sizeof(Conf_PidFile));
764 Conf_UID = Conf_GID = 0;
767 Conf_ConnectRetry = 60;
768 Conf_IdleTimeout = 0;
769 Conf_MaxConnections = 0;
770 Conf_MaxConnectionsIP = 5;
772 Conf_MaxNickLength = CLIENT_NICK_LEN_DEFAULT;
773 Conf_MaxListSize = 100;
774 Conf_PingTimeout = 120;
775 Conf_PongTimeout = 20;
778 strlcpy(Conf_AllowedChannelTypes, CHANTYPES,
779 sizeof(Conf_AllowedChannelTypes));
780 Conf_AllowRemoteOper = false;
782 Conf_AuthPing = false;
784 strlcpy(Conf_Chroot, CHROOT_DIR, sizeof(Conf_Chroot));
785 strcpy(Conf_CloakHost, "");
786 strcpy(Conf_CloakHostModeX, "");
787 strlcpy(Conf_CloakHostSalt, ngt_RandomStr(random, RANDOM_SALT_LEN),
788 sizeof(Conf_CloakHostSalt));
789 Conf_CloakUserToNick = false;
790 Conf_ConnectIPv4 = true;
792 Conf_ConnectIPv6 = true;
794 Conf_ConnectIPv6 = false;
796 strcpy(Conf_DefaultUserModes, "");
803 strcpy(Conf_IncludeDir, "");
804 Conf_MorePrivacy = false;
805 Conf_NoticeAuth = false;
806 Conf_OperCanMode = false;
807 Conf_OperChanPAutoOp = true;
808 Conf_OperServerMode = false;
814 Conf_PAMIsOptional = false;
816 Conf_ScrubCTCP = false;
818 Conf_SyslogFacility = LOG_LOCAL5;
820 Conf_SyslogFacility = 0;
824 /* Initialize server configuration structures */
826 for (i = 0; i < MAX_SERVERS;
827 Init_Server_Struct(&Conf_Server[i++]));
832 * Get number of configured listening ports.
834 * @returns The number of ports (IPv4+IPv6) on which the server should listen.
839 size_t cnt = array_bytes(&Conf_ListenPorts);
841 cnt += array_bytes(&Conf_SSLOptions.ListenPorts);
847 * Read contents of a text file into an array.
849 * This function is used to read the MOTD and help text file, for example.
851 * @param filename Name of the file to read.
852 * @return true, when the file has been read in.
855 Read_TextFile(const char *Filename, const char *Name, array *Destination)
861 if (*Filename == '\0')
864 fp = fopen(Filename, "r");
866 Config_Error(LOG_ERR, "Can't read %s file \"%s\": %s",
867 Name, Filename, strerror(errno));
871 array_free(Destination);
872 while (fgets(line, (int)sizeof line, fp)) {
873 ngt_TrimLastChr(line, '\n');
875 /* add text including \0 */
876 if (!array_catb(Destination, line, strlen(line) + 1)) {
877 Log(LOG_ERR, "Cannot read/add \"%s\", line %d: %s",
878 Filename, line_no, strerror(errno));
888 * Read ngIRCd configuration file.
890 * Please note that this function uses exit(1) on fatal errors and therefore
891 * can result in ngIRCd terminating!
893 * @param ngircd_starting Flag indicating if ngIRCd is starting or not.
894 * @returns true when the configuration file has been read
895 * successfully; false otherwise.
898 Read_Config(bool TestOnly, bool IsStarting)
900 const UINT16 defaultport = 6667;
901 char *ptr, file[FNAME_LEN];
902 struct dirent *entry;
907 /* Open configuration file */
908 fd = fopen( NGIRCd_ConfFile, "r" );
910 /* No configuration file found! */
911 Config_Error( LOG_ALERT, "Can't read configuration \"%s\": %s",
912 NGIRCd_ConfFile, strerror( errno ));
915 Config_Error( LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE_NAME );
920 Set_Defaults(IsStarting);
923 Config_Error(LOG_INFO,
924 "Reading configuration from \"%s\" ...",
927 /* Clean up server configuration structure: mark all already
928 * configured servers as "once" so that they are deleted
929 * after the next disconnect and delete all unused servers.
930 * And delete all servers which are "duplicates" of servers
931 * that are already marked as "once" (such servers have been
932 * created by the last rehash but are now useless). */
933 for( i = 0; i < MAX_SERVERS; i++ ) {
934 if( Conf_Server[i].conn_id == NONE ) Init_Server_Struct( &Conf_Server[i] );
936 /* This structure is in use ... */
937 if( Conf_Server[i].flags & CONF_SFLAG_ONCE ) {
938 /* Check for duplicates */
939 for( n = 0; n < MAX_SERVERS; n++ ) {
940 if( n == i ) continue;
942 if( Conf_Server[i].conn_id == Conf_Server[n].conn_id ) {
943 Init_Server_Struct( &Conf_Server[n] );
945 Log(LOG_DEBUG,"Deleted unused duplicate server %d (kept %d).",
951 /* Mark server as "once" */
952 Conf_Server[i].flags |= CONF_SFLAG_ONCE;
953 Log( LOG_DEBUG, "Marked server %d as \"once\"", i );
958 /* Initialize variables */
959 Init_Server_Struct( &New_Server );
960 New_Server_Idx = NONE;
965 Read_Config_File(NGIRCd_ConfFile, fd);
968 if (Conf_IncludeDir[0]) {
969 dh = opendir(Conf_IncludeDir);
971 Config_Error(LOG_ALERT,
972 "Can't open include directory \"%s\": %s",
973 Conf_IncludeDir, strerror(errno));
975 strlcpy(Conf_IncludeDir, SYSCONFDIR, sizeof(Conf_IncludeDir));
976 strlcat(Conf_IncludeDir, CONFIG_DIR, sizeof(Conf_IncludeDir));
977 dh = opendir(Conf_IncludeDir);
980 /* Include further configuration files, if IncludeDir is available */
982 while ((entry = readdir(dh)) != NULL) {
983 ptr = strrchr(entry->d_name, '.');
984 if (!ptr || strcasecmp(ptr, ".conf") != 0)
986 snprintf(file, sizeof(file), "%s/%s",
987 Conf_IncludeDir, entry->d_name);
989 Config_Error(LOG_INFO,
990 "Reading configuration from \"%s\" ...",
992 fd = fopen(file, "r");
994 Read_Config_File(file, fd);
997 Config_Error(LOG_ALERT,
998 "Can't read configuration \"%s\": %s",
999 file, strerror(errno));
1004 /* Check if there is still a server to add */
1005 if( New_Server.name[0] ) {
1006 /* Copy data to "real" server structure */
1007 assert( New_Server_Idx > NONE );
1008 Conf_Server[New_Server_Idx] = New_Server;
1011 /* not a single listening port? Add default. */
1012 if (no_listenports() &&
1013 !array_copyb(&Conf_ListenPorts, (char*) &defaultport, sizeof defaultport))
1015 Config_Error(LOG_ALERT, "Could not add default listening Port %u: %s",
1016 (unsigned int) defaultport, strerror(errno));
1021 if (!Conf_ListenAddress)
1022 Conf_ListenAddress = strdup_warn(DEFAULT_LISTEN_ADDRSTR);
1024 if (!Conf_ListenAddress) {
1025 Config_Error(LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE_NAME);
1029 /* No MOTD phrase configured? (re)try motd file. */
1030 if (array_bytes(&Conf_Motd) == 0) {
1031 if (Read_TextFile(Conf_MotdFile, "MOTD", &Conf_Motd))
1032 Using_MotdFile = true;
1035 /* Try to read ngIRCd help text file. */
1036 (void)Read_TextFile(Conf_HelpFile, "help text", &Conf_Helptext);
1037 if (!array_bytes(&Conf_Helptext))
1038 Config_Error(LOG_WARNING,
1039 "No help text available, HELP command will be of limited use.");
1042 /* Make sure that all SSL-related files are readable */
1043 CheckFileReadable("CertFile", Conf_SSLOptions.CertFile);
1044 CheckFileReadable("DHFile", Conf_SSLOptions.DHFile);
1045 CheckFileReadable("KeyFile", Conf_SSLOptions.KeyFile);
1047 /* Set the default ciphers if none were configured */
1048 if (!Conf_SSLOptions.CipherList)
1049 Conf_SSLOptions.CipherList = strdup_warn(DEFAULT_CIPHERS);
1058 static void Read_Config_File(const char *File, FILE *fd)
1060 char section[LINE_LEN], str[LINE_LEN], *var, *arg, *ptr;
1064 /* Read configuration file */
1067 if (!fgets(str, sizeof(str), fd))
1072 /* Skip comments and empty lines */
1073 if (str[0] == ';' || str[0] == '#' || str[0] == '\0')
1076 if (strlen(str) >= sizeof(str) - 1) {
1077 Config_Error(LOG_WARNING, "%s, line %d too long!",
1082 /* Is this the beginning of a new section? */
1083 if ((str[0] == '[') && (str[strlen(str) - 1] == ']')) {
1084 strlcpy(section, str, sizeof(section));
1085 if (strcasecmp(section, "[GLOBAL]") == 0
1086 || strcasecmp(section, "[LIMITS]") == 0
1087 || strcasecmp(section, "[OPTIONS]") == 0
1089 || strcasecmp(section, "[SSL]") == 0
1094 if (strcasecmp(section, "[SERVER]") == 0) {
1095 /* Check if there is already a server to add */
1096 if (New_Server.name[0]) {
1097 /* Copy data to "real" server structure */
1098 assert(New_Server_Idx > NONE);
1099 Conf_Server[New_Server_Idx] =
1103 /* Re-init structure for new server */
1104 Init_Server_Struct(&New_Server);
1106 /* Search unused item in server configuration structure */
1107 for (i = 0; i < MAX_SERVERS; i++) {
1108 /* Is this item used? */
1109 if (!Conf_Server[i].name[0])
1112 if (i >= MAX_SERVERS) {
1113 /* Oops, no free item found! */
1114 Config_Error(LOG_ERR,
1115 "Too many servers configured.");
1116 New_Server_Idx = NONE;
1122 if (strcasecmp(section, "[CHANNEL]") == 0) {
1123 count = array_length(&Conf_Channels,
1128 sizeof(struct Conf_Channel), count)) {
1129 Config_Error(LOG_ERR,
1130 "Could not allocate memory for new operator (line %d)",
1136 if (strcasecmp(section, "[OPERATOR]") == 0) {
1137 count = array_length(&Conf_Opers,
1138 sizeof(struct Conf_Oper));
1139 if (!array_alloc(&Conf_Opers,
1140 sizeof(struct Conf_Oper),
1142 Config_Error(LOG_ERR,
1143 "Could not allocate memory for new channel (line &d)",
1149 Config_Error(LOG_ERR,
1150 "%s, line %d: Unknown section \"%s\"!",
1151 File, line, section);
1154 if (section[0] == 0x1)
1157 /* Split line into variable name and parameters */
1158 ptr = strchr(str, '=');
1160 Config_Error(LOG_ERR, "%s, line %d: Syntax error!",
1170 if (strcasecmp(section, "[GLOBAL]") == 0)
1171 Handle_GLOBAL(File, line, var, arg);
1172 else if (strcasecmp(section, "[LIMITS]") == 0)
1173 Handle_LIMITS(File, line, var, arg);
1174 else if (strcasecmp(section, "[OPTIONS]") == 0)
1175 Handle_OPTIONS(File, line, var, arg);
1177 else if (strcasecmp(section, "[SSL]") == 0)
1178 Handle_SSL(File, line, var, arg);
1180 else if (strcasecmp(section, "[OPERATOR]") == 0)
1181 Handle_OPERATOR(File, line, var, arg);
1182 else if (strcasecmp(section, "[SERVER]") == 0)
1183 Handle_SERVER(File, line, var, arg);
1184 else if (strcasecmp(section, "[CHANNEL]") == 0)
1185 Handle_CHANNEL(File, line, var, arg);
1187 Config_Error(LOG_ERR,
1188 "%s, line %d: Variable \"%s\" outside section!",
1194 * Check whether a string argument is "true" or "false".
1196 * @param Arg Input string.
1197 * @returns true if the input string has been parsed as "yes", "true"
1198 * (case insensitive) or a non-zero integer value.
1201 Check_ArgIsTrue(const char *Arg)
1203 if (strcasecmp(Arg, "yes") == 0)
1205 if (strcasecmp(Arg, "true") == 0)
1214 * Handle setting of "MaxNickLength".
1216 * @param Line Line number in configuration file.
1217 * @raram Arg Input string.
1218 * @returns New configured maximum nickname length.
1221 Handle_MaxNickLength(const char *File, int Line, const char *Arg)
1225 new = (unsigned) atoi(Arg) + 1;
1226 if (new > CLIENT_NICK_LEN) {
1227 Config_Error(LOG_WARNING,
1228 "%s, line %d: Value of \"MaxNickLength\" exceeds %u!",
1229 File, Line, CLIENT_NICK_LEN - 1);
1230 return CLIENT_NICK_LEN;
1233 Config_Error(LOG_WARNING,
1234 "%s, line %d: Value of \"MaxNickLength\" must be at least 1!",
1242 * Output a warning messages if IDENT is configured but not compiled in.
1245 WarnIdent(const char UNUSED *File, int UNUSED Line)
1249 /* user has enabled ident lookups explicitly, but ... */
1250 Config_Error(LOG_WARNING,
1251 "%s: line %d: \"Ident = yes\", but ngircd was built without IDENT support!",
1258 * Output a warning messages if IPv6 is configured but not compiled in.
1261 WarnIPv6(const char UNUSED *File, int UNUSED Line)
1264 if (Conf_ConnectIPv6) {
1265 /* user has enabled IPv6 explicitly, but ... */
1266 Config_Error(LOG_WARNING,
1267 "%s: line %d: \"ConnectIPv6 = yes\", but ngircd was built without IPv6 support!",
1274 * Output a warning messages if PAM is configured but not compiled in.
1277 WarnPAM(const char UNUSED *File, int UNUSED Line)
1281 Config_Error(LOG_WARNING,
1282 "%s: line %d: \"PAM = yes\", but ngircd was built without PAM support!",
1289 * Handle legacy "NoXXX" options in [GLOBAL] section.
1291 * TODO: This function and support for "NoXXX" could be removed starting
1292 * with ngIRCd release 19 (one release after marking it "deprecated").
1294 * @param Var Variable name.
1295 * @param Arg Argument string.
1296 * @returns true if a NoXXX option has been processed; false otherwise.
1299 CheckLegacyNoOption(const char *Var, const char *Arg)
1301 if(strcasecmp(Var, "NoDNS") == 0) {
1302 Conf_DNS = !Check_ArgIsTrue( Arg );
1305 if (strcasecmp(Var, "NoIdent") == 0) {
1306 Conf_Ident = !Check_ArgIsTrue(Arg);
1309 if(strcasecmp(Var, "NoPAM") == 0) {
1310 Conf_PAM = !Check_ArgIsTrue(Arg);
1317 * Handle deprecated legacy options in [GLOBAL] section.
1319 * TODO: This function and support for these options in the [Global] section
1320 * could be removed starting with ngIRCd release 19 (one release after
1321 * marking it "deprecated").
1323 * @param Var Variable name.
1324 * @param Arg Argument string.
1325 * @returns true if a legacy option has been processed; false otherwise.
1328 CheckLegacyGlobalOption(const char *File, int Line, char *Var, char *Arg)
1330 if (strcasecmp(Var, "AllowRemoteOper") == 0
1331 || strcasecmp(Var, "ChrootDir") == 0
1332 || strcasecmp(Var, "ConnectIPv4") == 0
1333 || strcasecmp(Var, "ConnectIPv6") == 0
1334 || strcasecmp(Var, "OperCanUseMode") == 0
1335 || strcasecmp(Var, "OperChanPAutoOp") == 0
1336 || strcasecmp(Var, "OperServerMode") == 0
1337 || strcasecmp(Var, "PredefChannelsOnly") == 0
1338 || strcasecmp(Var, "SyslogFacility") == 0
1339 || strcasecmp(Var, "WebircPassword") == 0) {
1340 Handle_OPTIONS(File, Line, Var, Arg);
1343 if (strcasecmp(Var, "ConnectRetry") == 0
1344 || strcasecmp(Var, "IdleTimeout") == 0
1345 || strcasecmp(Var, "MaxConnections") == 0
1346 || strcasecmp(Var, "MaxConnectionsIP") == 0
1347 || strcasecmp(Var, "MaxJoins") == 0
1348 || strcasecmp(Var, "MaxNickLength") == 0
1349 || strcasecmp(Var, "PingTimeout") == 0
1350 || strcasecmp(Var, "PongTimeout") == 0) {
1351 Handle_LIMITS(File, Line, Var, Arg);
1355 if (strcasecmp(Var, "SSLCertFile") == 0
1356 || strcasecmp(Var, "SSLDHFile") == 0
1357 || strcasecmp(Var, "SSLKeyFile") == 0
1358 || strcasecmp(Var, "SSLKeyFilePassword") == 0
1359 || strcasecmp(Var, "SSLPorts") == 0) {
1360 Handle_SSL(File, Line, Var + 3, Arg);
1369 * Strip "no" prefix of a string.
1371 * TODO: This function and support for "NoXXX" should be removed starting
1372 * with ngIRCd release 19! (One release after marking it "deprecated").
1374 * @param str Pointer to input string starting with "no".
1375 * @returns New pointer to string without "no" prefix.
1378 NoNo(const char *str)
1380 assert(strncasecmp("no", str, 2) == 0 && str[2]);
1385 * Invert "boolean" string.
1387 * TODO: This function and support for "NoXXX" should be removed starting
1388 * with ngIRCd release 19! (One release after marking it "deprecated").
1390 * @param arg "Boolean" input string.
1391 * @returns Pointer to inverted "boolean string".
1394 InvertArg(const char *arg)
1396 return yesno_to_str(!Check_ArgIsTrue(arg));
1400 * Handle variable in [Global] configuration section.
1402 * @param Line Line numer in configuration file.
1403 * @param Var Variable name.
1404 * @param Arg Variable argument.
1407 Handle_GLOBAL(const char *File, int Line, char *Var, char *Arg )
1412 const char *section;
1415 assert(File != NULL);
1417 assert(Var != NULL);
1418 assert(Arg != NULL);
1420 if (strcasecmp(Var, "Name") == 0) {
1421 len = strlcpy(Conf_ServerName, Arg, sizeof(Conf_ServerName));
1422 if (len >= sizeof(Conf_ServerName))
1423 Config_Error_TooLong(File, Line, Var);
1426 if (strcasecmp(Var, "AdminInfo1") == 0) {
1427 len = strlcpy(Conf_ServerAdmin1, Arg, sizeof(Conf_ServerAdmin1));
1428 if (len >= sizeof(Conf_ServerAdmin1))
1429 Config_Error_TooLong(File, Line, Var);
1432 if (strcasecmp(Var, "AdminInfo2") == 0) {
1433 len = strlcpy(Conf_ServerAdmin2, Arg, sizeof(Conf_ServerAdmin2));
1434 if (len >= sizeof(Conf_ServerAdmin2))
1435 Config_Error_TooLong(File, Line, Var);
1438 if (strcasecmp(Var, "AdminEMail") == 0) {
1439 len = strlcpy(Conf_ServerAdminMail, Arg,
1440 sizeof(Conf_ServerAdminMail));
1441 if (len >= sizeof(Conf_ServerAdminMail))
1442 Config_Error_TooLong(File, Line, Var);
1445 if (strcasecmp(Var, "Info") == 0) {
1446 len = strlcpy(Conf_ServerInfo, Arg, sizeof(Conf_ServerInfo));
1447 if (len >= sizeof(Conf_ServerInfo))
1448 Config_Error_TooLong(File, Line, Var);
1451 if (strcasecmp(Var, "HelpFile") == 0) {
1452 len = strlcpy(Conf_HelpFile, Arg, sizeof(Conf_HelpFile));
1453 if (len >= sizeof(Conf_HelpFile))
1454 Config_Error_TooLong(File, Line, Var);
1457 if (strcasecmp(Var, "Listen") == 0) {
1458 if (Conf_ListenAddress) {
1459 Config_Error(LOG_ERR,
1460 "Multiple Listen= options, ignoring: %s",
1464 Conf_ListenAddress = strdup_warn(Arg);
1465 /* If allocation fails, we're in trouble: we cannot ignore the
1466 * error -- otherwise ngircd would listen on all interfaces. */
1467 if (!Conf_ListenAddress) {
1468 Config_Error(LOG_ALERT,
1469 "%s exiting due to fatal errors!",
1475 if (strcasecmp(Var, "MotdFile") == 0) {
1476 len = strlcpy(Conf_MotdFile, Arg, sizeof(Conf_MotdFile));
1477 if (len >= sizeof(Conf_MotdFile))
1478 Config_Error_TooLong(File, Line, Var);
1481 if (strcasecmp(Var, "MotdPhrase") == 0) {
1486 Config_Error_TooLong(File, Line, Var);
1489 if (!array_copyb(&Conf_Motd, Arg, len + 1))
1490 Config_Error(LOG_WARNING,
1491 "%s, line %d: Could not append MotdPhrase: %s",
1492 File, Line, strerror(errno));
1493 Using_MotdFile = false;
1496 if (strcasecmp(Var, "Network") == 0) {
1497 len = strlcpy(Conf_Network, Arg, sizeof(Conf_Network));
1498 if (len >= sizeof(Conf_Network))
1499 Config_Error_TooLong(File, Line, Var);
1500 ptr = strchr(Conf_Network, ' ');
1502 Config_Error(LOG_WARNING,
1503 "%s, line %d: \"Network\" can't contain spaces!",
1509 if(strcasecmp(Var, "Password") == 0) {
1510 len = strlcpy(Conf_ServerPwd, Arg, sizeof(Conf_ServerPwd));
1511 if (len >= sizeof(Conf_ServerPwd))
1512 Config_Error_TooLong(File, Line, Var);
1515 if (strcasecmp(Var, "PidFile") == 0) {
1516 len = strlcpy(Conf_PidFile, Arg, sizeof(Conf_PidFile));
1517 if (len >= sizeof(Conf_PidFile))
1518 Config_Error_TooLong(File, Line, Var);
1521 if (strcasecmp(Var, "Ports") == 0) {
1522 ports_parse(&Conf_ListenPorts, File, Line, Arg);
1525 if (strcasecmp(Var, "ServerGID") == 0) {
1526 grp = getgrnam(Arg);
1528 Conf_GID = grp->gr_gid;
1530 Conf_GID = (unsigned int)atoi(Arg);
1531 if (!Conf_GID && strcmp(Arg, "0"))
1532 Config_Error(LOG_WARNING,
1533 "%s, line %d: Value of \"%s\" is not a valid group name or ID!",
1538 if (strcasecmp(Var, "ServerUID") == 0) {
1539 pwd = getpwnam(Arg);
1541 Conf_UID = pwd->pw_uid;
1543 Conf_UID = (unsigned int)atoi(Arg);
1544 if (!Conf_UID && strcmp(Arg, "0"))
1545 Config_Error(LOG_WARNING,
1546 "%s, line %d: Value of \"%s\" is not a valid user name or ID!",
1552 if (CheckLegacyNoOption(Var, Arg)) {
1553 /* TODO: This function and support for "NoXXX" could be
1554 * be removed starting with ngIRCd release 19 (one release
1555 * after marking it "deprecated"). */
1556 Config_Error(LOG_WARNING,
1557 "%s, line %d (section \"Global\"): \"No\"-Prefix is deprecated, use \"%s = %s\" in [Options] section!",
1558 File, Line, NoNo(Var), InvertArg(Arg));
1559 if (strcasecmp(Var, "NoIdent") == 0)
1560 WarnIdent(File, Line);
1561 else if (strcasecmp(Var, "NoPam") == 0)
1562 WarnPAM(File, Line);
1565 if ((section = CheckLegacyGlobalOption(File, Line, Var, Arg))) {
1566 /** TODO: This function and support for these options in the
1567 * [Global] section could be removed starting with ngIRCd
1568 * release 19 (one release after marking it "deprecated"). */
1569 if (strncasecmp(Var, "SSL", 3) == 0) {
1570 Config_Error(LOG_WARNING,
1571 "%s, line %d (section \"Global\"): \"%s\" is deprecated here, move it to %s and rename to \"%s\"!",
1572 File, Line, Var, section,
1575 Config_Error(LOG_WARNING,
1576 "%s, line %d (section \"Global\"): \"%s\" is deprecated here, move it to %s!",
1577 File, Line, Var, section);
1582 Config_Error_Section(File, Line, Var, "Global");
1586 * Handle variable in [Limits] configuration section.
1588 * @param Line Line numer in configuration file.
1589 * @param Var Variable name.
1590 * @param Arg Variable argument.
1593 Handle_LIMITS(const char *File, int Line, char *Var, char *Arg)
1595 assert(File != NULL);
1597 assert(Var != NULL);
1598 assert(Arg != NULL);
1600 if (strcasecmp(Var, "ConnectRetry") == 0) {
1601 Conf_ConnectRetry = atoi(Arg);
1602 if (Conf_ConnectRetry < 5) {
1603 Config_Error(LOG_WARNING,
1604 "%s, line %d: Value of \"ConnectRetry\" too low!",
1606 Conf_ConnectRetry = 5;
1610 if (strcasecmp(Var, "IdleTimeout") == 0) {
1611 Conf_IdleTimeout = atoi(Arg);
1612 if (!Conf_IdleTimeout && strcmp(Arg, "0"))
1613 Config_Error_NaN(File, Line, Var);
1616 if (strcasecmp(Var, "MaxConnections") == 0) {
1617 Conf_MaxConnections = atoi(Arg);
1618 if (!Conf_MaxConnections && strcmp(Arg, "0"))
1619 Config_Error_NaN(File, Line, Var);
1622 if (strcasecmp(Var, "MaxConnectionsIP") == 0) {
1623 Conf_MaxConnectionsIP = atoi(Arg);
1624 if (!Conf_MaxConnectionsIP && strcmp(Arg, "0"))
1625 Config_Error_NaN(File, Line, Var);
1628 if (strcasecmp(Var, "MaxJoins") == 0) {
1629 Conf_MaxJoins = atoi(Arg);
1630 if (!Conf_MaxJoins && strcmp(Arg, "0"))
1631 Config_Error_NaN(File, Line, Var);
1634 if (strcasecmp(Var, "MaxNickLength") == 0) {
1635 Conf_MaxNickLength = Handle_MaxNickLength(File, Line, Arg);
1638 if (strcasecmp(Var, "MaxListSize") == 0) {
1639 Conf_MaxListSize = atoi(Arg);
1640 if (!Conf_MaxListSize && strcmp(Arg, "0"))
1641 Config_Error_NaN(File, Line, Var);
1644 if (strcasecmp(Var, "PingTimeout") == 0) {
1645 Conf_PingTimeout = atoi(Arg);
1646 if (Conf_PingTimeout < 5) {
1647 Config_Error(LOG_WARNING,
1648 "%s, line %d: Value of \"PingTimeout\" too low!",
1650 Conf_PingTimeout = 5;
1654 if (strcasecmp(Var, "PongTimeout") == 0) {
1655 Conf_PongTimeout = atoi(Arg);
1656 if (Conf_PongTimeout < 5) {
1657 Config_Error(LOG_WARNING,
1658 "%s, line %d: Value of \"PongTimeout\" too low!",
1660 Conf_PongTimeout = 5;
1665 Config_Error_Section(File, Line, Var, "Limits");
1669 * Handle variable in [Options] configuration section.
1671 * @param Line Line numer in configuration file.
1672 * @param Var Variable name.
1673 * @param Arg Variable argument.
1676 Handle_OPTIONS(const char *File, int Line, char *Var, char *Arg)
1681 assert(File != NULL);
1683 assert(Var != NULL);
1684 assert(Arg != NULL);
1686 if (strcasecmp(Var, "AllowedChannelTypes") == 0) {
1688 Conf_AllowedChannelTypes[0] = '\0';
1690 if (strchr(Conf_AllowedChannelTypes, *p)) {
1691 /* Prefix is already included; ignore it */
1696 if (strchr(CHANTYPES, *p)) {
1697 len = strlen(Conf_AllowedChannelTypes) + 1;
1698 assert(len < sizeof(Conf_AllowedChannelTypes));
1699 Conf_AllowedChannelTypes[len - 1] = *p;
1700 Conf_AllowedChannelTypes[len] = '\0';
1702 Config_Error(LOG_WARNING,
1703 "%s, line %d: Unknown channel prefix \"%c\" in \"AllowedChannelTypes\"!",
1710 if (strcasecmp(Var, "AllowRemoteOper") == 0) {
1711 Conf_AllowRemoteOper = Check_ArgIsTrue(Arg);
1714 if (strcasecmp(Var, "ChrootDir") == 0) {
1715 len = strlcpy(Conf_Chroot, Arg, sizeof(Conf_Chroot));
1716 if (len >= sizeof(Conf_Chroot))
1717 Config_Error_TooLong(File, Line, Var);
1720 if (strcasecmp(Var, "CloakHost") == 0) {
1721 len = strlcpy(Conf_CloakHost, Arg, sizeof(Conf_CloakHost));
1722 if (len >= sizeof(Conf_CloakHost))
1723 Config_Error_TooLong(File, Line, Var);
1726 if (strcasecmp(Var, "CloakHostModeX") == 0) {
1727 len = strlcpy(Conf_CloakHostModeX, Arg, sizeof(Conf_CloakHostModeX));
1728 if (len >= sizeof(Conf_CloakHostModeX))
1729 Config_Error_TooLong(File, Line, Var);
1732 if (strcasecmp(Var, "CloakHostSalt") == 0) {
1733 len = strlcpy(Conf_CloakHostSalt, Arg, sizeof(Conf_CloakHostSalt));
1734 if (len >= sizeof(Conf_CloakHostSalt))
1735 Config_Error_TooLong(File, Line, Var);
1738 if (strcasecmp(Var, "CloakUserToNick") == 0) {
1739 Conf_CloakUserToNick = Check_ArgIsTrue(Arg);
1742 if (strcasecmp(Var, "ConnectIPv6") == 0) {
1743 Conf_ConnectIPv6 = Check_ArgIsTrue(Arg);
1744 WarnIPv6(File, Line);
1747 if (strcasecmp(Var, "ConnectIPv4") == 0) {
1748 Conf_ConnectIPv4 = Check_ArgIsTrue(Arg);
1751 if (strcasecmp(Var, "DefaultUserModes") == 0) {
1753 Conf_DefaultUserModes[0] = '\0';
1755 if (strchr(Conf_DefaultUserModes, *p)) {
1756 /* Mode is already included; ignore it */
1761 if (strchr(USERMODES, *p)) {
1762 len = strlen(Conf_DefaultUserModes) + 1;
1763 assert(len < sizeof(Conf_DefaultUserModes));
1764 Conf_DefaultUserModes[len - 1] = *p;
1765 Conf_DefaultUserModes[len] = '\0';
1767 Config_Error(LOG_WARNING,
1768 "%s, line %d: Unknown user mode \"%c\" in \"DefaultUserModes\"!",
1775 if (strcasecmp(Var, "DNS") == 0) {
1776 Conf_DNS = Check_ArgIsTrue(Arg);
1779 if (strcasecmp(Var, "Ident") == 0) {
1780 Conf_Ident = Check_ArgIsTrue(Arg);
1781 WarnIdent(File, Line);
1784 if (strcasecmp(Var, "IncludeDir") == 0) {
1785 if (Conf_IncludeDir[0]) {
1786 Config_Error(LOG_ERR,
1787 "%s, line %d: Can't overwrite value of \"IncludeDir\" variable!",
1791 len = strlcpy(Conf_IncludeDir, Arg, sizeof(Conf_IncludeDir));
1792 if (len >= sizeof(Conf_IncludeDir))
1793 Config_Error_TooLong(File, Line, Var);
1796 if (strcasecmp(Var, "MorePrivacy") == 0) {
1797 Conf_MorePrivacy = Check_ArgIsTrue(Arg);
1800 if (strcasecmp(Var, "NoticeAuth") == 0) {
1801 Conf_NoticeAuth = Check_ArgIsTrue(Arg);
1804 if (strcasecmp(Var, "OperCanUseMode") == 0) {
1805 Conf_OperCanMode = Check_ArgIsTrue(Arg);
1808 if (strcasecmp(Var, "OperChanPAutoOp") == 0) {
1809 Conf_OperChanPAutoOp = Check_ArgIsTrue(Arg);
1812 if (strcasecmp(Var, "OperServerMode") == 0) {
1813 Conf_OperServerMode = Check_ArgIsTrue(Arg);
1816 if (strcasecmp(Var, "PAM") == 0) {
1817 Conf_PAM = Check_ArgIsTrue(Arg);
1818 WarnPAM(File, Line);
1821 if (strcasecmp(Var, "PAMIsOptional") == 0 ) {
1822 Conf_PAMIsOptional = Check_ArgIsTrue(Arg);
1825 if (strcasecmp(Var, "PredefChannelsOnly") == 0) {
1827 * TODO: This section and support for "PredefChannelsOnly"
1828 * could be removed starting with ngIRCd release 22 (one
1829 * release after marking it "deprecated") ...
1831 Config_Error(LOG_WARNING,
1832 "%s, line %d (section \"Options\"): \"%s\" is deprecated, please use \"AllowedChannelTypes\"!",
1834 if (Check_ArgIsTrue(Arg))
1835 Conf_AllowedChannelTypes[0] = '\0';
1837 strlcpy(Conf_AllowedChannelTypes, CHANTYPES,
1838 sizeof(Conf_AllowedChannelTypes));
1842 if (strcasecmp(Var, "RequireAuthPing") == 0) {
1843 Conf_AuthPing = Check_ArgIsTrue(Arg);
1847 if (strcasecmp(Var, "ScrubCTCP") == 0) {
1848 Conf_ScrubCTCP = Check_ArgIsTrue(Arg);
1852 if (strcasecmp(Var, "SyslogFacility") == 0) {
1853 Conf_SyslogFacility = ngt_SyslogFacilityID(Arg,
1854 Conf_SyslogFacility);
1858 if (strcasecmp(Var, "WebircPassword") == 0) {
1859 len = strlcpy(Conf_WebircPwd, Arg, sizeof(Conf_WebircPwd));
1860 if (len >= sizeof(Conf_WebircPwd))
1861 Config_Error_TooLong(File, Line, Var);
1865 Config_Error_Section(File, Line, Var, "Options");
1871 * Handle variable in [SSL] configuration section.
1873 * @param Line Line numer in configuration file.
1874 * @param Var Variable name.
1875 * @param Arg Variable argument.
1878 Handle_SSL(const char *File, int Line, char *Var, char *Arg)
1880 assert(File != NULL);
1882 assert(Var != NULL);
1883 assert(Arg != NULL);
1885 if (strcasecmp(Var, "CertFile") == 0) {
1886 assert(Conf_SSLOptions.CertFile == NULL);
1887 Conf_SSLOptions.CertFile = strdup_warn(Arg);
1890 if (strcasecmp(Var, "DHFile") == 0) {
1891 assert(Conf_SSLOptions.DHFile == NULL);
1892 Conf_SSLOptions.DHFile = strdup_warn(Arg);
1895 if (strcasecmp(Var, "KeyFile") == 0) {
1896 assert(Conf_SSLOptions.KeyFile == NULL);
1897 Conf_SSLOptions.KeyFile = strdup_warn(Arg);
1900 if (strcasecmp(Var, "KeyFilePassword") == 0) {
1901 assert(array_bytes(&Conf_SSLOptions.KeyFilePassword) == 0);
1902 if (!array_copys(&Conf_SSLOptions.KeyFilePassword, Arg))
1903 Config_Error(LOG_ERR,
1904 "%s, line %d (section \"SSL\"): Could not copy %s: %s!",
1905 File, Line, Var, strerror(errno));
1908 if (strcasecmp(Var, "Ports") == 0) {
1909 ports_parse(&Conf_SSLOptions.ListenPorts, File, Line, Arg);
1912 if (strcasecmp(Var, "CipherList") == 0) {
1913 assert(Conf_SSLOptions.CipherList == NULL);
1914 Conf_SSLOptions.CipherList = strdup_warn(Arg);
1918 Config_Error_Section(File, Line, Var, "SSL");
1924 * Handle variable in [Operator] configuration section.
1926 * @param Line Line numer in configuration file.
1927 * @param Var Variable name.
1928 * @param Arg Variable argument.
1931 Handle_OPERATOR(const char *File, int Line, char *Var, char *Arg )
1934 struct Conf_Oper *op;
1936 assert( File != NULL );
1938 assert( Var != NULL );
1939 assert( Arg != NULL );
1941 op = array_get(&Conf_Opers, sizeof(*op),
1942 array_length(&Conf_Opers, sizeof(*op)) - 1);
1946 if (strcasecmp(Var, "Name") == 0) {
1947 /* Name of IRC operator */
1948 len = strlcpy(op->name, Arg, sizeof(op->name));
1949 if (len >= sizeof(op->name))
1950 Config_Error_TooLong(File, Line, Var);
1953 if (strcasecmp(Var, "Password") == 0) {
1954 /* Password of IRC operator */
1955 len = strlcpy(op->pwd, Arg, sizeof(op->pwd));
1956 if (len >= sizeof(op->pwd))
1957 Config_Error_TooLong(File, Line, Var);
1960 if (strcasecmp(Var, "Mask") == 0) {
1962 return; /* Hostname already configured */
1963 op->mask = strdup_warn( Arg );
1967 Config_Error_Section(File, Line, Var, "Operator");
1971 * Handle variable in [Server] configuration section.
1973 * @param Line Line numer in configuration file.
1974 * @param Var Variable name.
1975 * @param Arg Variable argument.
1978 Handle_SERVER(const char *File, int Line, char *Var, char *Arg )
1983 assert( File != NULL );
1985 assert( Var != NULL );
1986 assert( Arg != NULL );
1988 /* Ignore server block if no space is left in server configuration structure */
1989 if( New_Server_Idx <= NONE ) return;
1991 if( strcasecmp( Var, "Host" ) == 0 ) {
1992 /* Hostname of the server */
1993 len = strlcpy( New_Server.host, Arg, sizeof( New_Server.host ));
1994 if (len >= sizeof( New_Server.host ))
1995 Config_Error_TooLong(File, Line, Var);
1998 if( strcasecmp( Var, "Name" ) == 0 ) {
1999 /* Name of the server ("Nick"/"ID") */
2000 len = strlcpy( New_Server.name, Arg, sizeof( New_Server.name ));
2001 if (len >= sizeof( New_Server.name ))
2002 Config_Error_TooLong(File, Line, Var);
2005 if (strcasecmp(Var, "Bind") == 0) {
2006 if (ng_ipaddr_init(&New_Server.bind_addr, Arg, 0))
2009 Config_Error(LOG_ERR, "%s, line %d (section \"Server\"): Can't parse IP address \"%s\"",
2013 if( strcasecmp( Var, "MyPassword" ) == 0 ) {
2014 /* Password of this server which is sent to the peer */
2016 Config_Error(LOG_ERR,
2017 "%s, line %d (section \"Server\"): MyPassword must not start with ':'!",
2020 len = strlcpy( New_Server.pwd_in, Arg, sizeof( New_Server.pwd_in ));
2021 if (len >= sizeof( New_Server.pwd_in ))
2022 Config_Error_TooLong(File, Line, Var);
2025 if( strcasecmp( Var, "PeerPassword" ) == 0 ) {
2026 /* Passwort of the peer which must be received */
2027 len = strlcpy( New_Server.pwd_out, Arg, sizeof( New_Server.pwd_out ));
2028 if (len >= sizeof( New_Server.pwd_out ))
2029 Config_Error_TooLong(File, Line, Var);
2032 if( strcasecmp( Var, "Port" ) == 0 ) {
2033 /* Port to which this server should connect */
2035 if (port >= 0 && port < 0xFFFF)
2036 New_Server.port = (UINT16)port;
2038 Config_Error(LOG_ERR,
2039 "%s, line %d (section \"Server\"): Illegal port number %ld!",
2044 if( strcasecmp( Var, "SSLConnect" ) == 0 ) {
2045 New_Server.SSLConnect = Check_ArgIsTrue(Arg);
2049 if( strcasecmp( Var, "Group" ) == 0 ) {
2051 New_Server.group = atoi( Arg );
2052 if (!New_Server.group && strcmp(Arg, "0"))
2053 Config_Error_NaN(File, Line, Var);
2056 if( strcasecmp( Var, "Passive" ) == 0 ) {
2057 if (Check_ArgIsTrue(Arg))
2058 New_Server.flags |= CONF_SFLAG_DISABLED;
2061 if (strcasecmp(Var, "ServiceMask") == 0) {
2062 len = strlcpy(New_Server.svs_mask, ngt_LowerStr(Arg),
2063 sizeof(New_Server.svs_mask));
2064 if (len >= sizeof(New_Server.svs_mask))
2065 Config_Error_TooLong(File, Line, Var);
2069 Config_Error_Section(File, Line, Var, "Server");
2073 * Copy channel name into channel structure.
2075 * If the channel name is not valid because of a missing prefix ('#', '&'),
2076 * a default prefix of '#' will be added.
2078 * @param new_chan New already allocated channel structure.
2079 * @param name Name of the new channel.
2080 * @returns true on success, false otherwise.
2083 Handle_Channelname(struct Conf_Channel *new_chan, const char *name)
2085 size_t size = sizeof(new_chan->name);
2086 char *dest = new_chan->name;
2088 if (!Channel_IsValidName(name)) {
2090 * maybe user forgot to add a '#'.
2091 * This is only here for user convenience.
2097 return size > strlcpy(dest, name, size);
2101 * Handle variable in [Channel] configuration section.
2103 * @param Line Line numer in configuration file.
2104 * @param Var Variable name.
2105 * @param Arg Variable argument.
2108 Handle_CHANNEL(const char *File, int Line, char *Var, char *Arg)
2111 struct Conf_Channel *chan;
2113 assert( File != NULL );
2115 assert( Var != NULL );
2116 assert( Arg != NULL );
2118 chan = array_get(&Conf_Channels, sizeof(*chan),
2119 array_length(&Conf_Channels, sizeof(*chan)) - 1);
2123 if (strcasecmp(Var, "Name") == 0) {
2124 if (!Handle_Channelname(chan, Arg))
2125 Config_Error_TooLong(File, Line, Var);
2128 if (strcasecmp(Var, "Modes") == 0) {
2130 len = strlcpy(chan->modes, Arg, sizeof(chan->modes));
2131 if (len >= sizeof(chan->modes))
2132 Config_Error_TooLong(File, Line, Var);
2135 if( strcasecmp( Var, "Topic" ) == 0 ) {
2137 len = strlcpy(chan->topic, Arg, sizeof(chan->topic));
2138 if (len >= sizeof(chan->topic))
2139 Config_Error_TooLong(File, Line, Var);
2142 if( strcasecmp( Var, "Key" ) == 0 ) {
2143 /* Initial Channel Key (mode k) */
2144 len = strlcpy(chan->key, Arg, sizeof(chan->key));
2145 if (len >= sizeof(chan->key))
2146 Config_Error_TooLong(File, Line, Var);
2149 if( strcasecmp( Var, "MaxUsers" ) == 0 ) {
2150 /* maximum user limit, mode l */
2151 chan->maxusers = (unsigned long) atol(Arg);
2152 if (!chan->maxusers && strcmp(Arg, "0"))
2153 Config_Error_NaN(File, Line, Var);
2156 if (strcasecmp(Var, "KeyFile") == 0) {
2158 len = strlcpy(chan->keyfile, Arg, sizeof(chan->keyfile));
2159 if (len >= sizeof(chan->keyfile))
2160 Config_Error_TooLong(File, Line, Var);
2164 Config_Error_Section(File, Line, Var, "Channel");
2168 * Validate server configuration.
2170 * Please note that this function uses exit(1) on fatal errors and therefore
2171 * can result in ngIRCd terminating!
2173 * @param Configtest true if the daemon has been called with "--configtest".
2174 * @param Rehash true if re-reading configuration on runtime.
2175 * @returns true if configuration is valid.
2178 Validate_Config(bool Configtest, bool Rehash)
2180 /* Validate configuration settings. */
2183 int i, servers, servers_once;
2185 bool config_valid = true;
2188 /* Emit a warning when the config file is not a full path name */
2189 if (NGIRCd_ConfFile[0] && NGIRCd_ConfFile[0] != '/') {
2190 Config_Error(LOG_WARNING,
2191 "Not specifying a full path name to \"%s\" can cause problems when rehashing the server!",
2195 /* Validate configured server name, see RFC 2812 section 2.3.1 */
2196 ptr = Conf_ServerName;
2198 if (*ptr >= 'a' && *ptr <= 'z') continue;
2199 if (*ptr >= 'A' && *ptr <= 'Z') continue;
2200 if (*ptr >= '0' && *ptr <= '9') continue;
2201 if (ptr > Conf_ServerName) {
2202 if (*ptr == '.' || *ptr == '-')
2205 Conf_ServerName[0] = '\0';
2209 if (!Conf_ServerName[0]) {
2210 /* No server name configured! */
2211 config_valid = false;
2212 Config_Error(LOG_ALERT,
2213 "No (valid) server name configured in \"%s\" (section 'Global': 'Name')!",
2215 if (!Configtest && !Rehash) {
2216 Config_Error(LOG_ALERT,
2217 "%s exiting due to fatal errors!",
2223 if (Conf_ServerName[0] && !strchr(Conf_ServerName, '.')) {
2224 /* No dot in server name! */
2225 config_valid = false;
2226 Config_Error(LOG_ALERT,
2227 "Invalid server name configured in \"%s\" (section 'Global': 'Name'): Dot missing!",
2230 Config_Error(LOG_ALERT,
2231 "%s exiting due to fatal errors!",
2238 if (!Conf_ServerAdminMail[0]) {
2239 /* No administrative contact configured! */
2240 config_valid = false;
2241 Config_Error(LOG_ALERT,
2242 "No administrator email address configured in \"%s\" ('AdminEMail')!",
2245 Config_Error(LOG_ALERT,
2246 "%s exiting due to fatal errors!",
2253 if (!Conf_ServerAdmin1[0] && !Conf_ServerAdmin2[0]
2254 && !Conf_ServerAdminMail[0]) {
2255 /* No administrative information configured! */
2256 Config_Error(LOG_WARNING,
2257 "No administrative information configured but required by RFC!");
2261 if (Conf_PAM && Conf_ServerPwd[0])
2262 Config_Error(LOG_ERR,
2263 "This server uses PAM, \"Password\" in [Global] section will be ignored!");
2267 servers = servers_once = 0;
2268 for (i = 0; i < MAX_SERVERS; i++) {
2269 if (Conf_Server[i].name[0]) {
2271 if (Conf_Server[i].flags & CONF_SFLAG_ONCE)
2276 "Configuration: Operators=%ld, Servers=%d[%d], Channels=%ld",
2277 array_length(&Conf_Opers, sizeof(struct Conf_Oper)),
2278 servers, servers_once,
2279 array_length(&Conf_Channels, sizeof(struct Conf_Channel)));
2282 return config_valid;
2286 * Output "line too long" warning.
2288 * @param Line Line number in configuration file.
2289 * @param Item Affected variable name.
2292 Config_Error_TooLong(const char *File, const int Line, const char *Item)
2294 Config_Error(LOG_WARNING, "%s, line %d: Value of \"%s\" too long!",
2299 * Output "unknown variable" warning.
2301 * @param Line Line number in configuration file.
2302 * @param Item Affected variable name.
2303 * @param Section Section name.
2306 Config_Error_Section(const char *File, const int Line, const char *Item,
2307 const char *Section)
2309 Config_Error(LOG_ERR, "%s, line %d (section \"%s\"): Unknown variable \"%s\"!",
2310 File, Line, Section, Item);
2314 * Output "not a number" warning.
2316 * @param Line Line number in configuration file.
2317 * @param Item Affected variable name.
2320 Config_Error_NaN(const char *File, const int Line, const char *Item )
2322 Config_Error(LOG_WARNING, "%s, line %d: Value of \"%s\" is not a number!",
2327 * Output configuration error to console and/or logfile.
2329 * On runtime, the normal log functions of the daemon are used. But when
2330 * testing the configuration ("--configtest"), all messages go directly
2333 * @param Level Severity level of the message.
2334 * @param Format Format string; see printf() function.
2337 static void Config_Error( const int Level, const char *Format, ... )
2339 static void Config_Error( Level, Format, va_alist )
2345 char msg[MAX_LOG_MSG_LEN];
2348 assert( Format != NULL );
2351 va_start( ap, Format );
2355 vsnprintf( msg, MAX_LOG_MSG_LEN, Format, ap );
2359 if (Level <= LOG_WARNING)
2360 printf(" - %s\n", msg);
2364 Log(Level, "%s", msg);
2370 * Dump internal state of the "configuration module".
2373 Conf_DebugDump(void)
2377 Log(LOG_DEBUG, "Configured servers:");
2378 for (i = 0; i < MAX_SERVERS; i++) {
2379 if (! Conf_Server[i].name[0])
2382 " - %s: %s:%d, last=%ld, group=%d, flags=%d, conn=%d",
2383 Conf_Server[i].name, Conf_Server[i].host,
2384 Conf_Server[i].port, Conf_Server[i].lasttry,
2385 Conf_Server[i].group, Conf_Server[i].flags,
2386 Conf_Server[i].conn_id);
2393 * Initialize server configuration structure to default values.
2395 * @param Server Pointer to server structure to initialize.
2398 Init_Server_Struct( CONF_SERVER *Server )
2400 assert( Server != NULL );
2402 memset( Server, 0, sizeof (CONF_SERVER) );
2404 Server->group = NONE;
2405 Server->lasttry = time( NULL ) - Conf_ConnectRetry + STARTUP_DELAY;
2407 if( NGIRCd_Passive ) Server->flags = CONF_SFLAG_DISABLED;
2409 Proc_InitStruct(&Server->res_stat);
2410 Server->conn_id = NONE;
2411 memset(&Server->bind_addr, 0, sizeof(Server->bind_addr));