2 * ngIRCd -- The Next Generation IRC Daemon
3 * Copyright (c)2001-2018 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)
34 #include <sys/types.h>
46 static bool Use_Log = true, Using_MotdFile = true;
47 static CONF_SERVER New_Server;
48 static int New_Server_Idx;
50 static char Conf_MotdFile[FNAME_LEN];
51 static char Conf_HelpFile[FNAME_LEN];
52 static char Conf_IncludeDir[FNAME_LEN];
54 static void Set_Defaults PARAMS(( bool InitServers ));
55 static bool Read_Config PARAMS(( bool TestOnly, bool IsStarting ));
56 static void Read_Config_File PARAMS(( const char *File, FILE *fd ));
57 static bool Validate_Config PARAMS(( bool TestOnly, bool Rehash ));
59 static void Handle_GLOBAL PARAMS((const char *File, int Line,
60 char *Var, char *Arg ));
61 static void Handle_LIMITS PARAMS((const char *File, int Line,
62 char *Var, char *Arg ));
63 static void Handle_OPTIONS PARAMS((const char *File, int Line,
64 char *Var, char *Arg ));
65 static void Handle_OPERATOR PARAMS((const char *File, int Line,
66 char *Var, char *Arg ));
67 static void Handle_SERVER PARAMS((const char *File, int Line,
68 char *Var, char *Arg ));
69 static void Handle_CHANNEL PARAMS((const char *File, int Line,
70 char *Var, char *Arg ));
72 static void Config_Error PARAMS((const int Level, const char *Format, ...));
74 static void Config_Error_NaN PARAMS((const char *File, const int LINE,
76 static void Config_Error_Section PARAMS((const char *File, const int Line,
77 const char *Item, const char *Section));
78 static void Config_Error_TooLong PARAMS((const char *File, const int LINE,
81 static void Init_Server_Struct PARAMS(( CONF_SERVER *Server ));
85 #define DEFAULT_LISTEN_ADDRSTR "::,0.0.0.0"
87 #define DEFAULT_LISTEN_ADDRSTR "0.0.0.0"
91 #define DEFAULT_CIPHERS "HIGH:!aNULL:@STRENGTH:!SSLv3"
94 #define DEFAULT_CIPHERS "SECURE128:-VERS-SSL3.0"
99 static void Handle_SSL PARAMS((const char *File, int Line, char *Var, char *Ark));
101 struct SSLOptions Conf_SSLOptions;
104 * Initialize SSL configuration.
109 free(Conf_SSLOptions.KeyFile);
110 Conf_SSLOptions.KeyFile = NULL;
112 free(Conf_SSLOptions.CertFile);
113 Conf_SSLOptions.CertFile = NULL;
115 free(Conf_SSLOptions.DHFile);
116 Conf_SSLOptions.DHFile = NULL;
117 array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
119 array_free(&Conf_SSLOptions.ListenPorts);
121 free(Conf_SSLOptions.CipherList);
122 Conf_SSLOptions.CipherList = NULL;
126 * Check if the current configuration uses/requires SSL.
128 * @returns true if SSL is used and should be initialized.
135 /* SSL listen ports configured? */
136 if (array_bytes(&Conf_SSLOptions.ListenPorts))
139 for (i = 0; i < MAX_SERVERS; i++) {
140 if (Conf_Server[i].port > 0
141 && Conf_Server[i].SSLConnect)
148 * Make sure that a configured file is readable.
150 * Currently, this function is only used for SSL-related options ...
152 * @param Var Configuration variable
153 * @param Filename Configured filename
156 CheckFileReadable(const char *Var, const char *Filename)
163 fp = fopen(Filename, "r");
167 Config_Error(LOG_ERR, "Can't read \"%s\" (\"%s\"): %s",
168 Filename, Var, strerror(errno));
175 * Duplicate string and warn on errors.
177 * @returns Pointer to string on success, NULL otherwise.
180 strdup_warn(const char *str)
182 char *ptr = strdup(str);
184 Config_Error(LOG_ERR,
185 "Could not allocate memory for string: %s", str);
190 * Output a comma separated list of ports (integer values).
197 len = array_length(a, sizeof(UINT16));
199 ports = (UINT16*) array_start(a);
200 printf("%u", (unsigned int) *ports);
203 printf(", %u", (unsigned int) *ports);
210 * Parse a comma separated string into an array of port numbers (integers).
213 ports_parse(array *a, const char *File, int Line, char *Arg)
221 ptr = strtok( Arg, "," );
225 if (port > 0 && port < 0xFFFF) {
226 port16 = (UINT16) port;
227 if (!array_catb(a, (char*)&port16, sizeof port16))
228 Config_Error(LOG_ERR, "%s, line %d Could not add port number %ld: %s",
229 File, Line, port, strerror(errno));
231 Config_Error( LOG_ERR, "%s, line %d (section \"Global\"): Illegal port number %ld!",
235 ptr = strtok( NULL, "," );
240 * Initialize configuration module.
245 Read_Config(false, true);
246 Validate_Config(false, false);
250 * "Rehash" (reload) server configuration.
252 * @returns true if configuration has been re-read, false on errors.
257 if (!Read_Config(false, false))
259 Validate_Config(false, true);
261 /* Update CLIENT structure of local server */
262 Client_SetInfo(Client_ThisServer(), Conf_ServerInfo);
267 * Output a boolean value as "yes/no" string.
270 yesno_to_str(int boolean_value)
278 * Free all IRC operator configuration structures.
283 struct Conf_Oper *op;
286 len = array_length(&Conf_Opers, sizeof(*op));
287 op = array_start(&Conf_Opers);
292 array_free(&Conf_Opers);
296 * Output all IRC operator configuration structures.
301 struct Conf_Oper *op;
304 count = array_length(&Conf_Opers, sizeof(*op));
305 op = array_start(&Conf_Opers);
306 for (i = 0; i < count; i++, op++) {
311 printf(" Name = %s\n", op->name);
312 printf(" Password = %s\n", op->pwd);
313 printf(" Mask = %s\n\n", op->mask ? op->mask : "");
318 * Read configuration, validate and output it.
320 * This function waits for a keypress of the user when stdin/stdout are valid
321 * tty's ("you can read our nice message and we can read in your keypress").
323 * @return 0 on success, 1 on failure(s); therefore the result code can
324 * directly be used by exit() when running "ngircd --configtest".
333 size_t predef_channel_count;
334 struct Conf_Channel *predef_chan;
338 if (!Read_Config(true, true))
341 config_valid = Validate_Config(true, false);
344 if(isatty(fileno(stdin)) && isatty(fileno(stdout))) {
345 puts("OK, press enter to see a dump of your server configuration ...");
348 puts("Ok, dump of your server configuration follows:\n");
351 printf(" Name = %s\n", Conf_ServerName);
352 printf(" AdminInfo1 = %s\n", Conf_ServerAdmin1);
353 printf(" AdminInfo2 = %s\n", Conf_ServerAdmin2);
354 printf(" AdminEMail = %s\n", Conf_ServerAdminMail);
355 printf(" HelpFile = %s\n", Conf_HelpFile);
356 printf(" Info = %s\n", Conf_ServerInfo);
357 printf(" Listen = %s\n", Conf_ListenAddress);
358 if (Using_MotdFile) {
359 printf(" MotdFile = %s\n", Conf_MotdFile);
360 printf(" MotdPhrase =\n");
362 printf(" MotdFile = \n");
363 printf(" MotdPhrase = %s\n", array_bytes(&Conf_Motd)
364 ? (const char*) array_start(&Conf_Motd) : "");
366 printf(" Network = %s\n", Conf_Network);
368 printf(" Password = %s\n", Conf_ServerPwd);
369 printf(" PidFile = %s\n", Conf_PidFile);
371 ports_puts(&Conf_ListenPorts);
372 grp = getgrgid(Conf_GID);
374 printf(" ServerGID = %s\n", grp->gr_name);
376 printf(" ServerGID = %ld\n", (long)Conf_GID);
377 pwd = getpwuid(Conf_UID);
379 printf(" ServerUID = %s\n", pwd->pw_name);
381 printf(" ServerUID = %ld\n", (long)Conf_UID);
385 printf(" ConnectRetry = %d\n", Conf_ConnectRetry);
386 printf(" IdleTimeout = %d\n", Conf_IdleTimeout);
387 printf(" MaxConnections = %d\n", Conf_MaxConnections);
388 printf(" MaxConnectionsIP = %d\n", Conf_MaxConnectionsIP);
389 printf(" MaxJoins = %d\n", Conf_MaxJoins > 0 ? Conf_MaxJoins : -1);
390 printf(" MaxNickLength = %u\n", Conf_MaxNickLength - 1);
391 printf(" MaxPenaltyTime = %ld\n", Conf_MaxPenaltyTime);
392 printf(" MaxListSize = %d\n", Conf_MaxListSize);
393 printf(" PingTimeout = %d\n", Conf_PingTimeout);
394 printf(" PongTimeout = %d\n", Conf_PongTimeout);
398 printf(" AllowedChannelTypes = %s\n", Conf_AllowedChannelTypes);
399 printf(" AllowRemoteOper = %s\n", yesno_to_str(Conf_AllowRemoteOper));
400 printf(" ChrootDir = %s\n", Conf_Chroot);
401 printf(" CloakHost = %s\n", Conf_CloakHost);
402 printf(" CloakHostModeX = %s\n", Conf_CloakHostModeX);
403 printf(" CloakHostSalt = %s\n", Conf_CloakHostSalt);
404 printf(" CloakUserToNick = %s\n", yesno_to_str(Conf_CloakUserToNick));
406 printf(" ConnectIPv4 = %s\n", yesno_to_str(Conf_ConnectIPv6));
407 printf(" ConnectIPv6 = %s\n", yesno_to_str(Conf_ConnectIPv4));
409 printf(" DefaultUserModes = %s\n", Conf_DefaultUserModes);
410 printf(" DNS = %s\n", yesno_to_str(Conf_DNS));
412 printf(" Ident = %s\n", yesno_to_str(Conf_Ident));
414 printf(" IncludeDir = %s\n", Conf_IncludeDir);
415 printf(" MorePrivacy = %s\n", yesno_to_str(Conf_MorePrivacy));
416 printf(" NoticeBeforeRegistration = %s\n", yesno_to_str(Conf_NoticeBeforeRegistration));
417 printf(" OperCanUseMode = %s\n", yesno_to_str(Conf_OperCanMode));
418 printf(" OperChanPAutoOp = %s\n", yesno_to_str(Conf_OperChanPAutoOp));
419 printf(" OperServerMode = %s\n", yesno_to_str(Conf_OperServerMode));
421 printf(" PAM = %s\n", yesno_to_str(Conf_PAM));
422 printf(" PAMIsOptional = %s\n", yesno_to_str(Conf_PAMIsOptional));
423 printf(" PAMServiceName = %s\n", Conf_PAMServiceName);
426 printf(" RequireAuthPing = %s\n", yesno_to_str(Conf_AuthPing));
428 printf(" ScrubCTCP = %s\n", yesno_to_str(Conf_ScrubCTCP));
430 printf(" SyslogFacility = %s\n",
431 ngt_SyslogFacilityName(Conf_SyslogFacility));
433 printf(" WebircPassword = %s\n", Conf_WebircPwd);
438 printf(" CertFile = %s\n", Conf_SSLOptions.CertFile
439 ? Conf_SSLOptions.CertFile : "");
440 printf(" CipherList = %s\n", Conf_SSLOptions.CipherList ?
441 Conf_SSLOptions.CipherList : DEFAULT_CIPHERS);
442 printf(" DHFile = %s\n", Conf_SSLOptions.DHFile
443 ? Conf_SSLOptions.DHFile : "");
444 printf(" KeyFile = %s\n", Conf_SSLOptions.KeyFile
445 ? Conf_SSLOptions.KeyFile : "");
446 if (array_bytes(&Conf_SSLOptions.KeyFilePassword))
447 puts(" KeyFilePassword = <secret>");
449 puts(" KeyFilePassword = ");
450 array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
452 ports_puts(&Conf_SSLOptions.ListenPorts);
458 for( i = 0; i < MAX_SERVERS; i++ ) {
459 if( ! Conf_Server[i].name[0] ) continue;
461 /* Valid "Server" section */
463 printf( " Name = %s\n", Conf_Server[i].name );
464 printf( " Host = %s\n", Conf_Server[i].host );
465 printf( " Port = %u\n", (unsigned int)Conf_Server[i].port );
467 printf( " SSLConnect = %s\n", Conf_Server[i].SSLConnect?"yes":"no");
469 printf( " MyPassword = %s\n", Conf_Server[i].pwd_in );
470 printf( " PeerPassword = %s\n", Conf_Server[i].pwd_out );
471 printf( " ServiceMask = %s\n", Conf_Server[i].svs_mask);
472 printf( " Group = %d\n", Conf_Server[i].group );
473 printf( " Passive = %s\n\n", Conf_Server[i].flags & CONF_SFLAG_DISABLED ? "yes" : "no");
476 predef_channel_count = array_length(&Conf_Channels, sizeof(*predef_chan));
477 predef_chan = array_start(&Conf_Channels);
479 for (i = 0; i < predef_channel_count; i++, predef_chan++) {
480 if (!predef_chan->name[0])
483 /* Valid "Channel" section */
485 printf(" Name = %s\n", predef_chan->name);
486 printf(" Modes = %s\n", predef_chan->modes);
487 printf(" Key = %s\n", predef_chan->key);
488 printf(" MaxUsers = %lu\n", predef_chan->maxusers);
489 printf(" Topic = %s\n", predef_chan->topic);
490 printf(" KeyFile = %s\n\n", predef_chan->keyfile);
493 return (config_valid ? 0 : 1);
497 * Remove connection information from configured server.
499 * If the server is set as "once", delete it from our configuration;
500 * otherwise set the time for the next connection attempt.
502 * Non-server connections will be silently ignored.
505 Conf_UnsetServer( CONN_ID Idx )
510 /* Check all our configured servers */
511 for( i = 0; i < MAX_SERVERS; i++ ) {
512 if( Conf_Server[i].conn_id != Idx ) continue;
514 /* Gotcha! Mark server configuration as "unused": */
515 Conf_Server[i].conn_id = NONE;
517 if( Conf_Server[i].flags & CONF_SFLAG_ONCE ) {
518 /* Delete configuration here */
519 Init_Server_Struct( &Conf_Server[i] );
521 /* Set time for next connect attempt */
523 if (Conf_Server[i].lasttry < t - Conf_ConnectRetry) {
524 /* The connection has been "long", so we don't
525 * require the next attempt to be delayed. */
526 Conf_Server[i].lasttry =
527 t - Conf_ConnectRetry + RECONNECT_DELAY;
529 /* "Short" connection, enforce "ConnectRetry"
530 * but randomize it a little bit: 15 seconds. */
531 Conf_Server[i].lasttry =
532 #ifdef HAVE_ARC4RANDOM
533 t + (arc4random() % 15);
535 t + rand() / (RAND_MAX / 15);
543 * Set connection information for specified configured server.
546 Conf_SetServer( int ConfServer, CONN_ID Idx )
548 assert( ConfServer > NONE );
549 assert( Idx > NONE );
551 if (Conf_Server[ConfServer].conn_id > NONE &&
552 Conf_Server[ConfServer].conn_id != Idx) {
554 "Connection %d: Server configuration of \"%s\" already in use by connection %d!",
555 Idx, Conf_Server[ConfServer].name,
556 Conf_Server[ConfServer].conn_id);
557 Conn_Close(Idx, NULL, "Server configuration already in use", true);
560 Conf_Server[ConfServer].conn_id = Idx;
565 * Get index of server in configuration structure.
568 Conf_GetServer( CONN_ID Idx )
572 assert( Idx > NONE );
574 for( i = 0; i < MAX_SERVERS; i++ ) {
575 if( Conf_Server[i].conn_id == Idx ) return i;
581 * Enable a server by name and adjust its port number.
583 * @returns true if a server has been enabled and now has a valid port
584 * number and host name for outgoing connections.
587 Conf_EnableServer( const char *Name, UINT16 Port )
591 assert( Name != NULL );
592 for( i = 0; i < MAX_SERVERS; i++ ) {
593 if( strcasecmp( Conf_Server[i].name, Name ) == 0 ) {
594 /* Gotcha! Set port and enable server: */
595 Conf_Server[i].port = Port;
596 Conf_Server[i].flags &= ~CONF_SFLAG_DISABLED;
597 return (Conf_Server[i].port && Conf_Server[i].host[0]);
604 * Enable a server by name.
606 * The server is only usable as outgoing server, if it has set a valid port
607 * number for outgoing connections!
608 * If not, you have to use Conf_EnableServer() function to make it available.
610 * @returns true if a server has been enabled; false otherwise.
613 Conf_EnablePassiveServer(const char *Name)
617 assert( Name != NULL );
618 for (i = 0; i < MAX_SERVERS; i++) {
619 if ((strcasecmp( Conf_Server[i].name, Name ) == 0)
620 && (Conf_Server[i].port > 0)) {
621 /* BINGO! Enable server */
622 Conf_Server[i].flags &= ~CONF_SFLAG_DISABLED;
623 Conf_Server[i].lasttry = 0;
631 * Disable a server by name.
632 * An already established connection will be disconnected.
634 * @returns true if a server was found and has been disabled.
637 Conf_DisableServer( const char *Name )
641 assert( Name != NULL );
642 for( i = 0; i < MAX_SERVERS; i++ ) {
643 if( strcasecmp( Conf_Server[i].name, Name ) == 0 ) {
644 /* Gotcha! Disable and disconnect server: */
645 Conf_Server[i].flags |= CONF_SFLAG_DISABLED;
646 if( Conf_Server[i].conn_id > NONE )
647 Conn_Close(Conf_Server[i].conn_id, NULL,
648 "Server link terminated on operator request",
657 * Add a new remote server to our configuration.
659 * @param Name Name of the new server.
660 * @param Port Port number to connect to or 0 for incoming connections.
661 * @param Host Host name to connect to.
662 * @param MyPwd Password that will be sent to the peer.
663 * @param PeerPwd Password that must be received from the peer.
664 * @returns true if the new server has been added; false otherwise.
667 Conf_AddServer(const char *Name, UINT16 Port, const char *Host,
668 const char *MyPwd, const char *PeerPwd)
672 assert( Name != NULL );
673 assert( Host != NULL );
674 assert( MyPwd != NULL );
675 assert( PeerPwd != NULL );
677 /* Search unused item in server configuration structure */
678 for( i = 0; i < MAX_SERVERS; i++ ) {
679 /* Is this item used? */
680 if( ! Conf_Server[i].name[0] ) break;
682 if( i >= MAX_SERVERS ) return false;
684 Init_Server_Struct( &Conf_Server[i] );
685 strlcpy( Conf_Server[i].name, Name, sizeof( Conf_Server[i].name ));
686 strlcpy( Conf_Server[i].host, Host, sizeof( Conf_Server[i].host ));
687 strlcpy( Conf_Server[i].pwd_out, MyPwd, sizeof( Conf_Server[i].pwd_out ));
688 strlcpy( Conf_Server[i].pwd_in, PeerPwd, sizeof( Conf_Server[i].pwd_in ));
689 Conf_Server[i].port = Port;
690 Conf_Server[i].flags = CONF_SFLAG_ONCE;
696 * Check if the given nickname is reserved for services on a particular server.
698 * @param ConfServer The server index to check.
699 * @param Nick The nickname to check.
700 * @returns true if the given nickname belongs to an "IRC service".
703 Conf_NickIsService(int ConfServer, const char *Nick)
705 assert (ConfServer >= 0);
706 assert (ConfServer < MAX_SERVERS);
708 return MatchCaseInsensitiveList(Conf_Server[ConfServer].svs_mask,
713 * Check if the given nickname is blocked for "normal client" use.
715 * @param Nick The nickname to check.
716 * @returns true if the given nickname belongs to an "IRC service".
719 Conf_NickIsBlocked(const char *Nick)
723 for(i = 0; i < MAX_SERVERS; i++) {
724 if (!Conf_Server[i].name[0])
726 if (Conf_NickIsService(i, Nick))
733 * Initialize configuration settings with their default values.
736 Set_Defaults(bool InitServers)
739 char random[RANDOM_SALT_LEN + 1];
742 strcpy(Conf_ServerName, "");
743 strcpy(Conf_ServerAdmin1, "");
744 strcpy(Conf_ServerAdmin2, "");
745 strcpy(Conf_ServerAdminMail, "");
746 snprintf(Conf_ServerInfo, sizeof Conf_ServerInfo, "%s %s",
747 PACKAGE_NAME, PACKAGE_VERSION);
748 strcpy(Conf_Network, "");
749 free(Conf_ListenAddress);
750 Conf_ListenAddress = NULL;
751 array_free(&Conf_ListenPorts);
752 array_free(&Conf_Motd);
753 array_free(&Conf_Helptext);
754 strlcpy(Conf_MotdFile, SYSCONFDIR, sizeof(Conf_MotdFile));
755 strlcat(Conf_MotdFile, MOTD_FILE, sizeof(Conf_MotdFile));
756 strlcpy(Conf_HelpFile, DOCDIR, sizeof(Conf_HelpFile));
757 strlcat(Conf_HelpFile, HELP_FILE, sizeof(Conf_HelpFile));
758 strcpy(Conf_ServerPwd, "");
759 strlcpy(Conf_PidFile, PID_FILE, sizeof(Conf_PidFile));
760 Conf_UID = Conf_GID = 0;
763 Conf_ConnectRetry = 60;
764 Conf_IdleTimeout = 0;
765 Conf_MaxConnections = 0;
766 Conf_MaxConnectionsIP = 5;
768 Conf_MaxNickLength = CLIENT_NICK_LEN_DEFAULT;
769 Conf_MaxPenaltyTime = -1;
770 Conf_MaxListSize = 100;
771 Conf_PingTimeout = 120;
772 Conf_PongTimeout = 20;
775 strlcpy(Conf_AllowedChannelTypes, CHANTYPES,
776 sizeof(Conf_AllowedChannelTypes));
777 Conf_AllowRemoteOper = false;
779 Conf_AuthPing = false;
781 strlcpy(Conf_Chroot, CHROOT_DIR, sizeof(Conf_Chroot));
782 strcpy(Conf_CloakHost, "");
783 strcpy(Conf_CloakHostModeX, "");
784 strlcpy(Conf_CloakHostSalt, ngt_RandomStr(random, RANDOM_SALT_LEN),
785 sizeof(Conf_CloakHostSalt));
786 Conf_CloakUserToNick = false;
787 Conf_ConnectIPv4 = true;
789 Conf_ConnectIPv6 = true;
791 Conf_ConnectIPv6 = false;
793 strcpy(Conf_DefaultUserModes, "");
800 strcpy(Conf_IncludeDir, "");
801 Conf_MorePrivacy = false;
802 Conf_NoticeBeforeRegistration = false;
803 Conf_OperCanMode = false;
804 Conf_OperChanPAutoOp = true;
805 Conf_OperServerMode = false;
811 Conf_PAMIsOptional = false;
812 strcpy(Conf_PAMServiceName, "ngircd");
813 Conf_ScrubCTCP = false;
816 Conf_SyslogFacility = LOG_LOCAL5;
818 Conf_SyslogFacility = 0;
822 /* Initialize server configuration structures */
824 for (i = 0; i < MAX_SERVERS;
825 Init_Server_Struct(&Conf_Server[i++]));
830 * Get number of configured listening ports.
832 * @returns The number of ports (IPv4+IPv6) on which the server should listen.
837 size_t cnt = array_bytes(&Conf_ListenPorts);
839 cnt += array_bytes(&Conf_SSLOptions.ListenPorts);
845 * Read contents of a text file into an array.
847 * This function is used to read the MOTD and help text file, for example.
849 * @param Filename Name of the file to read.
850 * @return true, when the file has been read in.
853 Read_TextFile(const char *Filename, const char *Name, array *Destination)
859 if (*Filename == '\0')
862 fp = fopen(Filename, "r");
864 Config_Error(LOG_ERR, "Can't read %s file \"%s\": %s",
865 Name, Filename, strerror(errno));
869 array_free(Destination);
870 while (fgets(line, (int)sizeof line, fp)) {
871 ngt_TrimLastChr(line, '\n');
873 /* add text including \0 */
874 if (!array_catb(Destination, line, strlen(line) + 1)) {
875 Log(LOG_ERR, "Cannot read/add \"%s\", line %d: %s",
876 Filename, line_no, strerror(errno));
886 * Read ngIRCd configuration file.
888 * Please note that this function uses exit(1) on fatal errors and therefore
889 * can result in ngIRCd terminating!
891 * @param IsStarting Flag indicating if ngIRCd is starting or not.
892 * @returns true when the configuration file has been read
893 * successfully; false otherwise.
896 Read_Config(bool TestOnly, bool IsStarting)
898 const UINT16 defaultport = 6667;
899 char *ptr, file[FNAME_LEN];
900 struct dirent *entry;
905 /* Open configuration file */
906 fd = fopen( NGIRCd_ConfFile, "r" );
908 /* No configuration file found! */
909 Config_Error( LOG_ALERT, "Can't read configuration \"%s\": %s",
910 NGIRCd_ConfFile, strerror( errno ));
913 Config_Error( LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE_NAME );
918 Set_Defaults(IsStarting);
921 Config_Error(LOG_INFO,
922 "Reading configuration from \"%s\" ...",
925 /* Clean up server configuration structure: mark all already
926 * configured servers as "once" so that they are deleted
927 * after the next disconnect and delete all unused servers.
928 * And delete all servers which are "duplicates" of servers
929 * that are already marked as "once" (such servers have been
930 * created by the last rehash but are now useless). */
931 for( i = 0; i < MAX_SERVERS; i++ ) {
932 if( Conf_Server[i].conn_id == NONE ) Init_Server_Struct( &Conf_Server[i] );
934 /* This structure is in use ... */
935 if( Conf_Server[i].flags & CONF_SFLAG_ONCE ) {
936 /* Check for duplicates */
937 for( n = 0; n < MAX_SERVERS; n++ ) {
938 if( n == i ) continue;
940 if( Conf_Server[i].conn_id == Conf_Server[n].conn_id ) {
941 Init_Server_Struct( &Conf_Server[n] );
943 Log(LOG_DEBUG,"Deleted unused duplicate server %d (kept %d).",
949 /* Mark server as "once" */
950 Conf_Server[i].flags |= CONF_SFLAG_ONCE;
951 Log( LOG_DEBUG, "Marked server %d as \"once\"", i );
956 /* Initialize variables */
957 Init_Server_Struct( &New_Server );
958 New_Server_Idx = NONE;
963 Read_Config_File(NGIRCd_ConfFile, fd);
966 if (Conf_IncludeDir[0]) {
967 dh = opendir(Conf_IncludeDir);
969 Config_Error(LOG_ALERT,
970 "Can't open include directory \"%s\": %s",
971 Conf_IncludeDir, strerror(errno));
973 strlcpy(Conf_IncludeDir, SYSCONFDIR, sizeof(Conf_IncludeDir));
974 strlcat(Conf_IncludeDir, CONFIG_DIR, sizeof(Conf_IncludeDir));
975 dh = opendir(Conf_IncludeDir);
978 /* Include further configuration files, if IncludeDir is available */
980 while ((entry = readdir(dh)) != NULL) {
981 ptr = strrchr(entry->d_name, '.');
982 if (!ptr || strcasecmp(ptr, ".conf") != 0)
984 snprintf(file, sizeof(file), "%s/%s",
985 Conf_IncludeDir, entry->d_name);
987 Config_Error(LOG_INFO,
988 "Reading configuration from \"%s\" ...",
990 fd = fopen(file, "r");
992 Read_Config_File(file, fd);
995 Config_Error(LOG_ALERT,
996 "Can't read configuration \"%s\": %s",
997 file, strerror(errno));
1002 /* Check if there is still a server to add */
1003 if( New_Server.name[0] ) {
1004 /* Copy data to "real" server structure */
1005 assert( New_Server_Idx > NONE );
1006 Conf_Server[New_Server_Idx] = New_Server;
1009 /* not a single listening port? Add default. */
1010 if (no_listenports() &&
1011 !array_copyb(&Conf_ListenPorts, (char*) &defaultport, sizeof defaultport))
1013 Config_Error(LOG_ALERT, "Could not add default listening Port %u: %s",
1014 (unsigned int) defaultport, strerror(errno));
1019 if (!Conf_ListenAddress)
1020 Conf_ListenAddress = strdup_warn(DEFAULT_LISTEN_ADDRSTR);
1022 if (!Conf_ListenAddress) {
1023 Config_Error(LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE_NAME);
1027 /* No MOTD phrase configured? (re)try motd file. */
1028 if (array_bytes(&Conf_Motd) == 0) {
1029 if (Read_TextFile(Conf_MotdFile, "MOTD", &Conf_Motd))
1030 Using_MotdFile = true;
1033 /* Try to read ngIRCd help text file. */
1034 (void)Read_TextFile(Conf_HelpFile, "help text", &Conf_Helptext);
1035 if (!array_bytes(&Conf_Helptext))
1036 Config_Error(LOG_WARNING,
1037 "No help text available, HELP command will be of limited use.");
1040 /* Make sure that all SSL-related files are readable */
1041 CheckFileReadable("CertFile", Conf_SSLOptions.CertFile);
1042 CheckFileReadable("DHFile", Conf_SSLOptions.DHFile);
1043 CheckFileReadable("KeyFile", Conf_SSLOptions.KeyFile);
1045 /* Set the default ciphers if none were configured */
1046 if (!Conf_SSLOptions.CipherList)
1047 Conf_SSLOptions.CipherList = strdup_warn(DEFAULT_CIPHERS);
1054 * Read in and handle a configuration file.
1056 * @param File Name of the configuration file.
1057 * @param fd File descriptor already opened for reading.
1060 Read_Config_File(const char *File, FILE *fd)
1062 char section[LINE_LEN], str[LINE_LEN], *var, *arg, *ptr;
1066 /* Read configuration file */
1069 if (!fgets(str, sizeof(str), fd))
1074 /* Skip comments and empty lines */
1075 if (str[0] == ';' || str[0] == '#' || str[0] == '\0')
1078 if (strlen(str) >= sizeof(str) - 1) {
1079 Config_Error(LOG_WARNING, "%s, line %d too long!",
1084 /* Is this the beginning of a new section? */
1085 if ((str[0] == '[') && (str[strlen(str) - 1] == ']')) {
1086 strlcpy(section, str, sizeof(section));
1087 if (strcasecmp(section, "[GLOBAL]") == 0
1088 || strcasecmp(section, "[LIMITS]") == 0
1089 || strcasecmp(section, "[OPTIONS]") == 0
1091 || strcasecmp(section, "[SSL]") == 0
1096 if (strcasecmp(section, "[SERVER]") == 0) {
1097 /* Check if there is already a server to add */
1098 if (New_Server.name[0]) {
1099 /* Copy data to "real" server structure */
1100 assert(New_Server_Idx > NONE);
1101 Conf_Server[New_Server_Idx] =
1105 /* Re-init structure for new server */
1106 Init_Server_Struct(&New_Server);
1108 /* Search unused item in server configuration structure */
1109 for (i = 0; i < MAX_SERVERS; i++) {
1110 /* Is this item used? */
1111 if (!Conf_Server[i].name[0])
1114 if (i >= MAX_SERVERS) {
1115 /* Oops, no free item found! */
1116 Config_Error(LOG_ERR,
1117 "Too many servers configured.");
1118 New_Server_Idx = NONE;
1124 if (strcasecmp(section, "[CHANNEL]") == 0) {
1125 count = array_length(&Conf_Channels,
1130 sizeof(struct Conf_Channel), count)) {
1131 Config_Error(LOG_ERR,
1132 "Could not allocate memory for new operator (line %d)",
1138 if (strcasecmp(section, "[OPERATOR]") == 0) {
1139 count = array_length(&Conf_Opers,
1140 sizeof(struct Conf_Oper));
1141 if (!array_alloc(&Conf_Opers,
1142 sizeof(struct Conf_Oper),
1144 Config_Error(LOG_ERR,
1145 "Could not allocate memory for new channel (line &d)",
1151 Config_Error(LOG_ERR,
1152 "%s, line %d: Unknown section \"%s\"!",
1153 File, line, section);
1156 if (section[0] == 0x1)
1159 /* Split line into variable name and parameters */
1160 ptr = strchr(str, '=');
1162 Config_Error(LOG_ERR, "%s, line %d: Syntax error!",
1172 if (strcasecmp(section, "[GLOBAL]") == 0)
1173 Handle_GLOBAL(File, line, var, arg);
1174 else if (strcasecmp(section, "[LIMITS]") == 0)
1175 Handle_LIMITS(File, line, var, arg);
1176 else if (strcasecmp(section, "[OPTIONS]") == 0)
1177 Handle_OPTIONS(File, line, var, arg);
1179 else if (strcasecmp(section, "[SSL]") == 0)
1180 Handle_SSL(File, line, var, arg);
1182 else if (strcasecmp(section, "[OPERATOR]") == 0)
1183 Handle_OPERATOR(File, line, var, arg);
1184 else if (strcasecmp(section, "[SERVER]") == 0)
1185 Handle_SERVER(File, line, var, arg);
1186 else if (strcasecmp(section, "[CHANNEL]") == 0)
1187 Handle_CHANNEL(File, line, var, arg);
1189 Config_Error(LOG_ERR,
1190 "%s, line %d: Variable \"%s\" outside section!",
1196 * Check whether a string argument is "true" or "false".
1198 * @param Arg Input string.
1199 * @returns true if the input string has been parsed as "yes", "true"
1200 * (case insensitive) or a non-zero integer value.
1203 Check_ArgIsTrue(const char *Arg)
1205 if (strcasecmp(Arg, "yes") == 0)
1207 if (strcasecmp(Arg, "true") == 0)
1216 * Handle setting of "MaxNickLength".
1218 * @param Line Line number in configuration file.
1219 * @raram Arg Input string.
1220 * @returns New configured maximum nickname length.
1223 Handle_MaxNickLength(const char *File, int Line, const char *Arg)
1227 new = (unsigned) atoi(Arg) + 1;
1228 if (new > CLIENT_NICK_LEN) {
1229 Config_Error(LOG_WARNING,
1230 "%s, line %d: Value of \"MaxNickLength\" exceeds %u!",
1231 File, Line, CLIENT_NICK_LEN - 1);
1232 return CLIENT_NICK_LEN;
1235 Config_Error(LOG_WARNING,
1236 "%s, line %d: Value of \"MaxNickLength\" must be at least 1!",
1244 * Output a warning messages if IDENT is configured but not compiled in.
1247 WarnIdent(const char UNUSED *File, int UNUSED Line)
1251 /* user has enabled ident lookups explicitly, but ... */
1252 Config_Error(LOG_WARNING,
1253 "%s: line %d: \"Ident = yes\", but ngircd was built without IDENT support!",
1260 * Output a warning messages if IPv6 is configured but not compiled in.
1263 WarnIPv6(const char UNUSED *File, int UNUSED Line)
1266 if (Conf_ConnectIPv6) {
1267 /* user has enabled IPv6 explicitly, but ... */
1268 Config_Error(LOG_WARNING,
1269 "%s: line %d: \"ConnectIPv6 = yes\", but ngircd was built without IPv6 support!",
1276 * Output a warning messages if PAM is configured but not compiled in.
1279 WarnPAM(const char UNUSED *File, int UNUSED Line)
1283 Config_Error(LOG_WARNING,
1284 "%s: line %d: \"PAM = yes\", but ngircd was built without PAM support!",
1291 * Handle legacy "NoXXX" options in [GLOBAL] section.
1293 * TODO: This function and support for "NoXXX" could be removed starting
1294 * with ngIRCd release 19 (one release after marking it "deprecated").
1296 * @param Var Variable name.
1297 * @param Arg Argument string.
1298 * @returns true if a NoXXX option has been processed; false otherwise.
1301 CheckLegacyNoOption(const char *Var, const char *Arg)
1303 if(strcasecmp(Var, "NoDNS") == 0) {
1304 Conf_DNS = !Check_ArgIsTrue( Arg );
1307 if (strcasecmp(Var, "NoIdent") == 0) {
1308 Conf_Ident = !Check_ArgIsTrue(Arg);
1311 if(strcasecmp(Var, "NoPAM") == 0) {
1312 Conf_PAM = !Check_ArgIsTrue(Arg);
1319 * Handle deprecated legacy options in [GLOBAL] section.
1321 * TODO: This function and support for these options in the [Global] section
1322 * could be removed starting with ngIRCd release 19 (one release after
1323 * marking it "deprecated").
1325 * @param Var Variable name.
1326 * @param Arg Argument string.
1327 * @returns true if a legacy option has been processed; false otherwise.
1330 CheckLegacyGlobalOption(const char *File, int Line, char *Var, char *Arg)
1332 if (strcasecmp(Var, "AllowRemoteOper") == 0
1333 || strcasecmp(Var, "ChrootDir") == 0
1334 || strcasecmp(Var, "ConnectIPv4") == 0
1335 || strcasecmp(Var, "ConnectIPv6") == 0
1336 || strcasecmp(Var, "OperCanUseMode") == 0
1337 || strcasecmp(Var, "OperChanPAutoOp") == 0
1338 || strcasecmp(Var, "OperServerMode") == 0
1339 || strcasecmp(Var, "PredefChannelsOnly") == 0
1340 || strcasecmp(Var, "SyslogFacility") == 0
1341 || strcasecmp(Var, "WebircPassword") == 0) {
1342 Handle_OPTIONS(File, Line, Var, Arg);
1345 if (strcasecmp(Var, "ConnectRetry") == 0
1346 || strcasecmp(Var, "IdleTimeout") == 0
1347 || strcasecmp(Var, "MaxConnections") == 0
1348 || strcasecmp(Var, "MaxConnectionsIP") == 0
1349 || strcasecmp(Var, "MaxJoins") == 0
1350 || strcasecmp(Var, "MaxNickLength") == 0
1351 || strcasecmp(Var, "PingTimeout") == 0
1352 || strcasecmp(Var, "PongTimeout") == 0) {
1353 Handle_LIMITS(File, Line, Var, Arg);
1357 if (strcasecmp(Var, "SSLCertFile") == 0
1358 || strcasecmp(Var, "SSLDHFile") == 0
1359 || strcasecmp(Var, "SSLKeyFile") == 0
1360 || strcasecmp(Var, "SSLKeyFilePassword") == 0
1361 || strcasecmp(Var, "SSLPorts") == 0) {
1362 Handle_SSL(File, Line, Var + 3, Arg);
1371 * Strip "no" prefix of a string.
1373 * TODO: This function and support for "NoXXX" should be removed starting
1374 * with ngIRCd release 19! (One release after marking it "deprecated").
1376 * @param str Pointer to input string starting with "no".
1377 * @returns New pointer to string without "no" prefix.
1380 NoNo(const char *str)
1382 assert(strncasecmp("no", str, 2) == 0 && str[2]);
1387 * Invert "boolean" string.
1389 * TODO: This function and support for "NoXXX" should be removed starting
1390 * with ngIRCd release 19! (One release after marking it "deprecated").
1392 * @param arg "Boolean" input string.
1393 * @returns Pointer to inverted "boolean string".
1396 InvertArg(const char *arg)
1398 return yesno_to_str(!Check_ArgIsTrue(arg));
1402 * Handle variable in [Global] configuration section.
1404 * @param Line Line numer in configuration file.
1405 * @param Var Variable name.
1406 * @param Arg Variable argument.
1409 Handle_GLOBAL(const char *File, int Line, char *Var, char *Arg )
1414 const char *section;
1417 assert(File != NULL);
1419 assert(Var != NULL);
1420 assert(Arg != NULL);
1422 if (strcasecmp(Var, "Name") == 0) {
1423 len = strlcpy(Conf_ServerName, Arg, sizeof(Conf_ServerName));
1424 if (len >= sizeof(Conf_ServerName))
1425 Config_Error_TooLong(File, Line, Var);
1428 if (strcasecmp(Var, "AdminInfo1") == 0) {
1429 len = strlcpy(Conf_ServerAdmin1, Arg, sizeof(Conf_ServerAdmin1));
1430 if (len >= sizeof(Conf_ServerAdmin1))
1431 Config_Error_TooLong(File, Line, Var);
1434 if (strcasecmp(Var, "AdminInfo2") == 0) {
1435 len = strlcpy(Conf_ServerAdmin2, Arg, sizeof(Conf_ServerAdmin2));
1436 if (len >= sizeof(Conf_ServerAdmin2))
1437 Config_Error_TooLong(File, Line, Var);
1440 if (strcasecmp(Var, "AdminEMail") == 0) {
1441 len = strlcpy(Conf_ServerAdminMail, Arg,
1442 sizeof(Conf_ServerAdminMail));
1443 if (len >= sizeof(Conf_ServerAdminMail))
1444 Config_Error_TooLong(File, Line, Var);
1447 if (strcasecmp(Var, "Info") == 0) {
1448 len = strlcpy(Conf_ServerInfo, Arg, sizeof(Conf_ServerInfo));
1449 if (len >= sizeof(Conf_ServerInfo))
1450 Config_Error_TooLong(File, Line, Var);
1453 if (strcasecmp(Var, "HelpFile") == 0) {
1454 len = strlcpy(Conf_HelpFile, Arg, sizeof(Conf_HelpFile));
1455 if (len >= sizeof(Conf_HelpFile))
1456 Config_Error_TooLong(File, Line, Var);
1459 if (strcasecmp(Var, "Listen") == 0) {
1460 if (Conf_ListenAddress) {
1461 Config_Error(LOG_ERR,
1462 "Multiple Listen= options, ignoring: %s",
1466 Conf_ListenAddress = strdup_warn(Arg);
1467 /* If allocation fails, we're in trouble: we cannot ignore the
1468 * error -- otherwise ngircd would listen on all interfaces. */
1469 if (!Conf_ListenAddress) {
1470 Config_Error(LOG_ALERT,
1471 "%s exiting due to fatal errors!",
1477 if (strcasecmp(Var, "MotdFile") == 0) {
1478 len = strlcpy(Conf_MotdFile, Arg, sizeof(Conf_MotdFile));
1479 if (len >= sizeof(Conf_MotdFile))
1480 Config_Error_TooLong(File, Line, Var);
1483 if (strcasecmp(Var, "MotdPhrase") == 0) {
1488 Config_Error_TooLong(File, Line, Var);
1491 if (!array_copyb(&Conf_Motd, Arg, len + 1))
1492 Config_Error(LOG_WARNING,
1493 "%s, line %d: Could not append MotdPhrase: %s",
1494 File, Line, strerror(errno));
1495 Using_MotdFile = false;
1498 if (strcasecmp(Var, "Network") == 0) {
1499 len = strlcpy(Conf_Network, Arg, sizeof(Conf_Network));
1500 if (len >= sizeof(Conf_Network))
1501 Config_Error_TooLong(File, Line, Var);
1502 ptr = strchr(Conf_Network, ' ');
1504 Config_Error(LOG_WARNING,
1505 "%s, line %d: \"Network\" can't contain spaces!",
1511 if(strcasecmp(Var, "Password") == 0) {
1512 len = strlcpy(Conf_ServerPwd, Arg, sizeof(Conf_ServerPwd));
1513 if (len >= sizeof(Conf_ServerPwd))
1514 Config_Error_TooLong(File, Line, Var);
1517 if (strcasecmp(Var, "PidFile") == 0) {
1518 len = strlcpy(Conf_PidFile, Arg, sizeof(Conf_PidFile));
1519 if (len >= sizeof(Conf_PidFile))
1520 Config_Error_TooLong(File, Line, Var);
1523 if (strcasecmp(Var, "Ports") == 0) {
1524 ports_parse(&Conf_ListenPorts, File, Line, Arg);
1527 if (strcasecmp(Var, "ServerGID") == 0) {
1528 grp = getgrnam(Arg);
1530 Conf_GID = grp->gr_gid;
1532 Conf_GID = (unsigned int)atoi(Arg);
1533 if (!Conf_GID && strcmp(Arg, "0"))
1534 Config_Error(LOG_WARNING,
1535 "%s, line %d: Value of \"%s\" is not a valid group name or ID!",
1540 if (strcasecmp(Var, "ServerUID") == 0) {
1541 pwd = getpwnam(Arg);
1543 Conf_UID = pwd->pw_uid;
1545 Conf_UID = (unsigned int)atoi(Arg);
1546 if (!Conf_UID && strcmp(Arg, "0"))
1547 Config_Error(LOG_WARNING,
1548 "%s, line %d: Value of \"%s\" is not a valid user name or ID!",
1554 if (CheckLegacyNoOption(Var, Arg)) {
1555 /* TODO: This function and support for "NoXXX" could be
1556 * be removed starting with ngIRCd release 19 (one release
1557 * after marking it "deprecated"). */
1558 Config_Error(LOG_WARNING,
1559 "%s, line %d (section \"Global\"): \"No\"-Prefix is deprecated, use \"%s = %s\" in [Options] section!",
1560 File, Line, NoNo(Var), InvertArg(Arg));
1561 if (strcasecmp(Var, "NoIdent") == 0)
1562 WarnIdent(File, Line);
1563 else if (strcasecmp(Var, "NoPam") == 0)
1564 WarnPAM(File, Line);
1567 if ((section = CheckLegacyGlobalOption(File, Line, Var, Arg))) {
1568 /** TODO: This function and support for these options in the
1569 * [Global] section could be removed starting with ngIRCd
1570 * release 19 (one release after marking it "deprecated"). */
1571 if (strncasecmp(Var, "SSL", 3) == 0) {
1572 Config_Error(LOG_WARNING,
1573 "%s, line %d (section \"Global\"): \"%s\" is deprecated here, move it to %s and rename to \"%s\"!",
1574 File, Line, Var, section,
1577 Config_Error(LOG_WARNING,
1578 "%s, line %d (section \"Global\"): \"%s\" is deprecated here, move it to %s!",
1579 File, Line, Var, section);
1584 Config_Error_Section(File, Line, Var, "Global");
1588 * Handle variable in [Limits] configuration section.
1590 * @param Line Line numer in configuration file.
1591 * @param Var Variable name.
1592 * @param Arg Variable argument.
1595 Handle_LIMITS(const char *File, int Line, char *Var, char *Arg)
1597 assert(File != NULL);
1599 assert(Var != NULL);
1600 assert(Arg != NULL);
1602 if (strcasecmp(Var, "ConnectRetry") == 0) {
1603 Conf_ConnectRetry = atoi(Arg);
1604 if (Conf_ConnectRetry < 5) {
1605 Config_Error(LOG_WARNING,
1606 "%s, line %d: Value of \"ConnectRetry\" too low!",
1608 Conf_ConnectRetry = 5;
1612 if (strcasecmp(Var, "IdleTimeout") == 0) {
1613 Conf_IdleTimeout = atoi(Arg);
1614 if (!Conf_IdleTimeout && strcmp(Arg, "0"))
1615 Config_Error_NaN(File, Line, Var);
1618 if (strcasecmp(Var, "MaxConnections") == 0) {
1619 Conf_MaxConnections = atoi(Arg);
1620 if (!Conf_MaxConnections && strcmp(Arg, "0"))
1621 Config_Error_NaN(File, Line, Var);
1624 if (strcasecmp(Var, "MaxConnectionsIP") == 0) {
1625 Conf_MaxConnectionsIP = atoi(Arg);
1626 if (!Conf_MaxConnectionsIP && strcmp(Arg, "0"))
1627 Config_Error_NaN(File, Line, Var);
1630 if (strcasecmp(Var, "MaxJoins") == 0) {
1631 Conf_MaxJoins = atoi(Arg);
1632 if (!Conf_MaxJoins && strcmp(Arg, "0"))
1633 Config_Error_NaN(File, Line, Var);
1636 if (strcasecmp(Var, "MaxNickLength") == 0) {
1637 Conf_MaxNickLength = Handle_MaxNickLength(File, Line, Arg);
1640 if (strcasecmp(Var, "MaxListSize") == 0) {
1641 Conf_MaxListSize = atoi(Arg);
1642 if (!Conf_MaxListSize && strcmp(Arg, "0"))
1643 Config_Error_NaN(File, Line, Var);
1646 if (strcasecmp(Var, "MaxPenaltyTime") == 0) {
1647 Conf_MaxPenaltyTime = atol(Arg);
1648 if (Conf_MaxPenaltyTime < -1)
1649 Conf_MaxPenaltyTime = -1; /* "unlimited" */
1652 if (strcasecmp(Var, "PingTimeout") == 0) {
1653 Conf_PingTimeout = atoi(Arg);
1654 if (Conf_PingTimeout < 5) {
1655 Config_Error(LOG_WARNING,
1656 "%s, line %d: Value of \"PingTimeout\" too low!",
1658 Conf_PingTimeout = 5;
1662 if (strcasecmp(Var, "PongTimeout") == 0) {
1663 Conf_PongTimeout = atoi(Arg);
1664 if (Conf_PongTimeout < 5) {
1665 Config_Error(LOG_WARNING,
1666 "%s, line %d: Value of \"PongTimeout\" too low!",
1668 Conf_PongTimeout = 5;
1673 Config_Error_Section(File, Line, Var, "Limits");
1677 * Handle variable in [Options] configuration section.
1679 * @param Line Line numer in configuration file.
1680 * @param Var Variable name.
1681 * @param Arg Variable argument.
1684 Handle_OPTIONS(const char *File, int Line, char *Var, char *Arg)
1689 assert(File != NULL);
1691 assert(Var != NULL);
1692 assert(Arg != NULL);
1694 if (strcasecmp(Var, "AllowedChannelTypes") == 0) {
1696 Conf_AllowedChannelTypes[0] = '\0';
1698 if (strchr(Conf_AllowedChannelTypes, *p)) {
1699 /* Prefix is already included; ignore it */
1704 if (strchr(CHANTYPES, *p)) {
1705 len = strlen(Conf_AllowedChannelTypes) + 1;
1706 assert(len < sizeof(Conf_AllowedChannelTypes));
1707 Conf_AllowedChannelTypes[len - 1] = *p;
1708 Conf_AllowedChannelTypes[len] = '\0';
1710 Config_Error(LOG_WARNING,
1711 "%s, line %d: Unknown channel prefix \"%c\" in \"AllowedChannelTypes\"!",
1718 if (strcasecmp(Var, "AllowRemoteOper") == 0) {
1719 Conf_AllowRemoteOper = Check_ArgIsTrue(Arg);
1722 if (strcasecmp(Var, "ChrootDir") == 0) {
1723 len = strlcpy(Conf_Chroot, Arg, sizeof(Conf_Chroot));
1724 if (len >= sizeof(Conf_Chroot))
1725 Config_Error_TooLong(File, Line, Var);
1728 if (strcasecmp(Var, "CloakHost") == 0) {
1729 len = strlcpy(Conf_CloakHost, Arg, sizeof(Conf_CloakHost));
1730 if (len >= sizeof(Conf_CloakHost))
1731 Config_Error_TooLong(File, Line, Var);
1734 if (strcasecmp(Var, "CloakHostModeX") == 0) {
1735 len = strlcpy(Conf_CloakHostModeX, Arg, sizeof(Conf_CloakHostModeX));
1736 if (len >= sizeof(Conf_CloakHostModeX))
1737 Config_Error_TooLong(File, Line, Var);
1740 if (strcasecmp(Var, "CloakHostSalt") == 0) {
1741 len = strlcpy(Conf_CloakHostSalt, Arg, sizeof(Conf_CloakHostSalt));
1742 if (len >= sizeof(Conf_CloakHostSalt))
1743 Config_Error_TooLong(File, Line, Var);
1746 if (strcasecmp(Var, "CloakUserToNick") == 0) {
1747 Conf_CloakUserToNick = Check_ArgIsTrue(Arg);
1750 if (strcasecmp(Var, "ConnectIPv6") == 0) {
1751 Conf_ConnectIPv6 = Check_ArgIsTrue(Arg);
1752 WarnIPv6(File, Line);
1755 if (strcasecmp(Var, "ConnectIPv4") == 0) {
1756 Conf_ConnectIPv4 = Check_ArgIsTrue(Arg);
1759 if (strcasecmp(Var, "DefaultUserModes") == 0) {
1761 Conf_DefaultUserModes[0] = '\0';
1763 if (strchr(Conf_DefaultUserModes, *p)) {
1764 /* Mode is already included; ignore it */
1769 if (strchr(USERMODES, *p)) {
1770 len = strlen(Conf_DefaultUserModes) + 1;
1771 assert(len < sizeof(Conf_DefaultUserModes));
1772 Conf_DefaultUserModes[len - 1] = *p;
1773 Conf_DefaultUserModes[len] = '\0';
1775 Config_Error(LOG_WARNING,
1776 "%s, line %d: Unknown user mode \"%c\" in \"DefaultUserModes\"!",
1783 if (strcasecmp(Var, "DNS") == 0) {
1784 Conf_DNS = Check_ArgIsTrue(Arg);
1787 if (strcasecmp(Var, "Ident") == 0) {
1788 Conf_Ident = Check_ArgIsTrue(Arg);
1789 WarnIdent(File, Line);
1792 if (strcasecmp(Var, "IncludeDir") == 0) {
1793 if (Conf_IncludeDir[0]) {
1794 Config_Error(LOG_ERR,
1795 "%s, line %d: Can't overwrite value of \"IncludeDir\" variable!",
1799 len = strlcpy(Conf_IncludeDir, Arg, sizeof(Conf_IncludeDir));
1800 if (len >= sizeof(Conf_IncludeDir))
1801 Config_Error_TooLong(File, Line, Var);
1804 if (strcasecmp(Var, "MorePrivacy") == 0) {
1805 Conf_MorePrivacy = Check_ArgIsTrue(Arg);
1808 if (strcasecmp(Var, "NoticeAuth") == 0) {
1810 * TODO: This section and support for "NoticeAuth" variable
1811 * could be removed starting with ngIRCd release 24 (one
1812 * release after marking it "deprecated") ...
1814 Config_Error(LOG_WARNING,
1815 "%s, line %d (section \"Options\"): \"%s\" is deprecated, please use \"NoticeBeforeRegistration\"!",
1817 Conf_NoticeBeforeRegistration = Check_ArgIsTrue(Arg);
1820 if (strcasecmp(Var, "NoticeBeforeRegistration") == 0) {
1821 Conf_NoticeBeforeRegistration = Check_ArgIsTrue(Arg);
1824 if (strcasecmp(Var, "OperCanUseMode") == 0) {
1825 Conf_OperCanMode = Check_ArgIsTrue(Arg);
1828 if (strcasecmp(Var, "OperChanPAutoOp") == 0) {
1829 Conf_OperChanPAutoOp = Check_ArgIsTrue(Arg);
1832 if (strcasecmp(Var, "OperServerMode") == 0) {
1833 Conf_OperServerMode = Check_ArgIsTrue(Arg);
1836 if (strcasecmp(Var, "PAM") == 0) {
1837 Conf_PAM = Check_ArgIsTrue(Arg);
1838 WarnPAM(File, Line);
1841 if (strcasecmp(Var, "PAMIsOptional") == 0 ) {
1842 Conf_PAMIsOptional = Check_ArgIsTrue(Arg);
1845 if (strcasecmp(Var, "PAMServiceName") == 0) {
1846 len = strlcpy(Conf_PAMServiceName, Arg, sizeof(Conf_PAMServiceName));
1847 if (len >= sizeof(Conf_PAMServiceName))
1848 Config_Error_TooLong(File, Line, Var);
1851 if (strcasecmp(Var, "PredefChannelsOnly") == 0) {
1853 * TODO: This section and support for "PredefChannelsOnly"
1854 * could be removed starting with ngIRCd release 22 (one
1855 * release after marking it "deprecated") ...
1857 Config_Error(LOG_WARNING,
1858 "%s, line %d (section \"Options\"): \"%s\" is deprecated, please use \"AllowedChannelTypes\"!",
1860 if (Check_ArgIsTrue(Arg))
1861 Conf_AllowedChannelTypes[0] = '\0';
1863 strlcpy(Conf_AllowedChannelTypes, CHANTYPES,
1864 sizeof(Conf_AllowedChannelTypes));
1868 if (strcasecmp(Var, "RequireAuthPing") == 0) {
1869 Conf_AuthPing = Check_ArgIsTrue(Arg);
1873 if (strcasecmp(Var, "ScrubCTCP") == 0) {
1874 Conf_ScrubCTCP = Check_ArgIsTrue(Arg);
1878 if (strcasecmp(Var, "SyslogFacility") == 0) {
1879 Conf_SyslogFacility = ngt_SyslogFacilityID(Arg,
1880 Conf_SyslogFacility);
1884 if (strcasecmp(Var, "WebircPassword") == 0) {
1885 len = strlcpy(Conf_WebircPwd, Arg, sizeof(Conf_WebircPwd));
1886 if (len >= sizeof(Conf_WebircPwd))
1887 Config_Error_TooLong(File, Line, Var);
1891 Config_Error_Section(File, Line, Var, "Options");
1897 * Handle variable in [SSL] configuration section.
1899 * @param Line Line numer in configuration file.
1900 * @param Var Variable name.
1901 * @param Arg Variable argument.
1904 Handle_SSL(const char *File, int Line, char *Var, char *Arg)
1906 assert(File != NULL);
1908 assert(Var != NULL);
1909 assert(Arg != NULL);
1911 if (strcasecmp(Var, "CertFile") == 0) {
1912 assert(Conf_SSLOptions.CertFile == NULL);
1913 Conf_SSLOptions.CertFile = strdup_warn(Arg);
1916 if (strcasecmp(Var, "DHFile") == 0) {
1917 assert(Conf_SSLOptions.DHFile == NULL);
1918 Conf_SSLOptions.DHFile = strdup_warn(Arg);
1921 if (strcasecmp(Var, "KeyFile") == 0) {
1922 assert(Conf_SSLOptions.KeyFile == NULL);
1923 Conf_SSLOptions.KeyFile = strdup_warn(Arg);
1926 if (strcasecmp(Var, "KeyFilePassword") == 0) {
1927 assert(array_bytes(&Conf_SSLOptions.KeyFilePassword) == 0);
1928 if (!array_copys(&Conf_SSLOptions.KeyFilePassword, Arg))
1929 Config_Error(LOG_ERR,
1930 "%s, line %d (section \"SSL\"): Could not copy %s: %s!",
1931 File, Line, Var, strerror(errno));
1934 if (strcasecmp(Var, "Ports") == 0) {
1935 ports_parse(&Conf_SSLOptions.ListenPorts, File, Line, Arg);
1938 if (strcasecmp(Var, "CipherList") == 0) {
1939 assert(Conf_SSLOptions.CipherList == NULL);
1940 Conf_SSLOptions.CipherList = strdup_warn(Arg);
1944 Config_Error_Section(File, Line, Var, "SSL");
1950 * Handle variable in [Operator] configuration section.
1952 * @param Line Line numer in configuration file.
1953 * @param Var Variable name.
1954 * @param Arg Variable argument.
1957 Handle_OPERATOR(const char *File, int Line, char *Var, char *Arg )
1960 struct Conf_Oper *op;
1962 assert( File != NULL );
1964 assert( Var != NULL );
1965 assert( Arg != NULL );
1967 op = array_get(&Conf_Opers, sizeof(*op),
1968 array_length(&Conf_Opers, sizeof(*op)) - 1);
1972 if (strcasecmp(Var, "Name") == 0) {
1973 /* Name of IRC operator */
1974 len = strlcpy(op->name, Arg, sizeof(op->name));
1975 if (len >= sizeof(op->name))
1976 Config_Error_TooLong(File, Line, Var);
1979 if (strcasecmp(Var, "Password") == 0) {
1980 /* Password of IRC operator */
1981 len = strlcpy(op->pwd, Arg, sizeof(op->pwd));
1982 if (len >= sizeof(op->pwd))
1983 Config_Error_TooLong(File, Line, Var);
1986 if (strcasecmp(Var, "Mask") == 0) {
1988 return; /* Hostname already configured */
1989 op->mask = strdup_warn( Arg );
1993 Config_Error_Section(File, Line, Var, "Operator");
1997 * Handle variable in [Server] configuration section.
1999 * @param Line Line numer in configuration file.
2000 * @param Var Variable name.
2001 * @param Arg Variable argument.
2004 Handle_SERVER(const char *File, int Line, char *Var, char *Arg )
2009 assert( File != NULL );
2011 assert( Var != NULL );
2012 assert( Arg != NULL );
2014 /* Ignore server block if no space is left in server configuration structure */
2015 if( New_Server_Idx <= NONE ) return;
2017 if( strcasecmp( Var, "Host" ) == 0 ) {
2018 /* Hostname of the server */
2019 len = strlcpy( New_Server.host, Arg, sizeof( New_Server.host ));
2020 if (len >= sizeof( New_Server.host ))
2021 Config_Error_TooLong(File, Line, Var);
2024 if( strcasecmp( Var, "Name" ) == 0 ) {
2025 /* Name of the server ("Nick"/"ID") */
2026 len = strlcpy( New_Server.name, Arg, sizeof( New_Server.name ));
2027 if (len >= sizeof( New_Server.name ))
2028 Config_Error_TooLong(File, Line, Var);
2031 if (strcasecmp(Var, "Bind") == 0) {
2032 if (ng_ipaddr_init(&New_Server.bind_addr, Arg, 0))
2035 Config_Error(LOG_ERR, "%s, line %d (section \"Server\"): Can't parse IP address \"%s\"",
2039 if( strcasecmp( Var, "MyPassword" ) == 0 ) {
2040 /* Password of this server which is sent to the peer */
2042 Config_Error(LOG_ERR,
2043 "%s, line %d (section \"Server\"): MyPassword must not start with ':'!",
2046 len = strlcpy( New_Server.pwd_in, Arg, sizeof( New_Server.pwd_in ));
2047 if (len >= sizeof( New_Server.pwd_in ))
2048 Config_Error_TooLong(File, Line, Var);
2051 if( strcasecmp( Var, "PeerPassword" ) == 0 ) {
2052 /* Passwort of the peer which must be received */
2053 len = strlcpy( New_Server.pwd_out, Arg, sizeof( New_Server.pwd_out ));
2054 if (len >= sizeof( New_Server.pwd_out ))
2055 Config_Error_TooLong(File, Line, Var);
2058 if( strcasecmp( Var, "Port" ) == 0 ) {
2059 /* Port to which this server should connect */
2061 if (port >= 0 && port < 0xFFFF)
2062 New_Server.port = (UINT16)port;
2064 Config_Error(LOG_ERR,
2065 "%s, line %d (section \"Server\"): Illegal port number %ld!",
2070 if( strcasecmp( Var, "SSLConnect" ) == 0 ) {
2071 New_Server.SSLConnect = Check_ArgIsTrue(Arg);
2075 if( strcasecmp( Var, "Group" ) == 0 ) {
2077 New_Server.group = atoi( Arg );
2078 if (!New_Server.group && strcmp(Arg, "0"))
2079 Config_Error_NaN(File, Line, Var);
2082 if( strcasecmp( Var, "Passive" ) == 0 ) {
2083 if (Check_ArgIsTrue(Arg))
2084 New_Server.flags |= CONF_SFLAG_DISABLED;
2087 if (strcasecmp(Var, "ServiceMask") == 0) {
2088 len = strlcpy(New_Server.svs_mask, ngt_LowerStr(Arg),
2089 sizeof(New_Server.svs_mask));
2090 if (len >= sizeof(New_Server.svs_mask))
2091 Config_Error_TooLong(File, Line, Var);
2095 Config_Error_Section(File, Line, Var, "Server");
2099 * Copy channel name into channel structure.
2101 * If the channel name is not valid because of a missing prefix ('#', '&'),
2102 * a default prefix of '#' will be added.
2104 * @param new_chan New already allocated channel structure.
2105 * @param name Name of the new channel.
2106 * @returns true on success, false otherwise.
2109 Handle_Channelname(struct Conf_Channel *new_chan, const char *name)
2111 size_t size = sizeof(new_chan->name);
2112 char *dest = new_chan->name;
2114 if (!Channel_IsValidName(name)) {
2116 * maybe user forgot to add a '#'.
2117 * This is only here for user convenience.
2123 return size > strlcpy(dest, name, size);
2127 * Handle variable in [Channel] configuration section.
2129 * @param Line Line numer in configuration file.
2130 * @param Var Variable name.
2131 * @param Arg Variable argument.
2134 Handle_CHANNEL(const char *File, int Line, char *Var, char *Arg)
2137 struct Conf_Channel *chan;
2139 assert( File != NULL );
2141 assert( Var != NULL );
2142 assert( Arg != NULL );
2144 chan = array_get(&Conf_Channels, sizeof(*chan),
2145 array_length(&Conf_Channels, sizeof(*chan)) - 1);
2149 if (strcasecmp(Var, "Name") == 0) {
2150 if (!Handle_Channelname(chan, Arg))
2151 Config_Error_TooLong(File, Line, Var);
2154 if (strcasecmp(Var, "Modes") == 0) {
2156 len = strlcpy(chan->modes, Arg, sizeof(chan->modes));
2157 if (len >= sizeof(chan->modes))
2158 Config_Error_TooLong(File, Line, Var);
2161 if( strcasecmp( Var, "Topic" ) == 0 ) {
2163 len = strlcpy(chan->topic, Arg, sizeof(chan->topic));
2164 if (len >= sizeof(chan->topic))
2165 Config_Error_TooLong(File, Line, Var);
2168 if( strcasecmp( Var, "Key" ) == 0 ) {
2169 /* Initial Channel Key (mode k) */
2170 len = strlcpy(chan->key, Arg, sizeof(chan->key));
2171 if (len >= sizeof(chan->key))
2172 Config_Error_TooLong(File, Line, Var);
2175 if( strcasecmp( Var, "MaxUsers" ) == 0 ) {
2176 /* maximum user limit, mode l */
2177 chan->maxusers = (unsigned long) atol(Arg);
2178 if (!chan->maxusers && strcmp(Arg, "0"))
2179 Config_Error_NaN(File, Line, Var);
2182 if (strcasecmp(Var, "KeyFile") == 0) {
2184 len = strlcpy(chan->keyfile, Arg, sizeof(chan->keyfile));
2185 if (len >= sizeof(chan->keyfile))
2186 Config_Error_TooLong(File, Line, Var);
2190 Config_Error_Section(File, Line, Var, "Channel");
2194 * Validate server configuration.
2196 * Please note that this function uses exit(1) on fatal errors and therefore
2197 * can result in ngIRCd terminating!
2199 * @param Configtest true if the daemon has been called with "--configtest".
2200 * @param Rehash true if re-reading configuration on runtime.
2201 * @returns true if configuration is valid.
2204 Validate_Config(bool Configtest, bool Rehash)
2206 /* Validate configuration settings. */
2209 int i, servers, servers_once;
2211 bool config_valid = true;
2214 /* Emit a warning when the config file is not a full path name */
2215 if (NGIRCd_ConfFile[0] && NGIRCd_ConfFile[0] != '/') {
2216 Config_Error(LOG_WARNING,
2217 "Not specifying a full path name to \"%s\" can cause problems when rehashing the server!",
2221 /* Validate configured server name, see RFC 2812 section 2.3.1 */
2222 ptr = Conf_ServerName;
2224 if (*ptr >= 'a' && *ptr <= 'z') continue;
2225 if (*ptr >= 'A' && *ptr <= 'Z') continue;
2226 if (*ptr >= '0' && *ptr <= '9') continue;
2227 if (ptr > Conf_ServerName) {
2228 if (*ptr == '.' || *ptr == '-')
2231 Conf_ServerName[0] = '\0';
2235 if (!Conf_ServerName[0]) {
2236 /* No server name configured! */
2237 config_valid = false;
2238 Config_Error(LOG_ALERT,
2239 "No (valid) server name configured in \"%s\" (section 'Global': 'Name')!",
2241 if (!Configtest && !Rehash) {
2242 Config_Error(LOG_ALERT,
2243 "%s exiting due to fatal errors!",
2249 if (Conf_ServerName[0] && !strchr(Conf_ServerName, '.')) {
2250 /* No dot in server name! */
2251 config_valid = false;
2252 Config_Error(LOG_ALERT,
2253 "Invalid server name configured in \"%s\" (section 'Global': 'Name'): Dot missing!",
2256 Config_Error(LOG_ALERT,
2257 "%s exiting due to fatal errors!",
2264 if (!Conf_ServerAdminMail[0]) {
2265 /* No administrative contact configured! */
2266 config_valid = false;
2267 Config_Error(LOG_ALERT,
2268 "No administrator email address configured in \"%s\" ('AdminEMail')!",
2271 Config_Error(LOG_ALERT,
2272 "%s exiting due to fatal errors!",
2279 if (!Conf_ServerAdmin1[0] && !Conf_ServerAdmin2[0]
2280 && !Conf_ServerAdminMail[0]) {
2281 /* No administrative information configured! */
2282 Config_Error(LOG_WARNING,
2283 "No administrative information configured but required by RFC!");
2287 if (Conf_PAM && Conf_ServerPwd[0])
2288 Config_Error(LOG_ERR,
2289 "This server uses PAM, \"Password\" in [Global] section will be ignored!");
2292 if (Conf_MaxPenaltyTime != -1)
2293 Config_Error(LOG_WARNING,
2294 "Maximum penalty increase ('MaxPenaltyTime') is set to %ld, this is not recommended!",
2295 Conf_MaxPenaltyTime);
2298 servers = servers_once = 0;
2299 for (i = 0; i < MAX_SERVERS; i++) {
2300 if (Conf_Server[i].name[0]) {
2302 if (Conf_Server[i].flags & CONF_SFLAG_ONCE)
2307 "Configuration: Operators=%ld, Servers=%d[%d], Channels=%ld",
2308 array_length(&Conf_Opers, sizeof(struct Conf_Oper)),
2309 servers, servers_once,
2310 array_length(&Conf_Channels, sizeof(struct Conf_Channel)));
2313 return config_valid;
2317 * Output "line too long" warning.
2319 * @param Line Line number in configuration file.
2320 * @param Item Affected variable name.
2323 Config_Error_TooLong(const char *File, const int Line, const char *Item)
2325 Config_Error(LOG_WARNING, "%s, line %d: Value of \"%s\" too long!",
2330 * Output "unknown variable" warning.
2332 * @param Line Line number in configuration file.
2333 * @param Item Affected variable name.
2334 * @param Section Section name.
2337 Config_Error_Section(const char *File, const int Line, const char *Item,
2338 const char *Section)
2340 Config_Error(LOG_ERR, "%s, line %d (section \"%s\"): Unknown variable \"%s\"!",
2341 File, Line, Section, Item);
2345 * Output "not a number" warning.
2347 * @param Line Line number in configuration file.
2348 * @param Item Affected variable name.
2351 Config_Error_NaN(const char *File, const int Line, const char *Item )
2353 Config_Error(LOG_WARNING, "%s, line %d: Value of \"%s\" is not a number!",
2358 * Output configuration error to console and/or logfile.
2360 * On runtime, the normal log functions of the daemon are used. But when
2361 * testing the configuration ("--configtest"), all messages go directly
2364 * @param Level Severity level of the message.
2365 * @param Format Format string; see printf() function.
2368 static void Config_Error( const int Level, const char *Format, ... )
2370 static void Config_Error( Level, Format, va_alist )
2376 char msg[MAX_LOG_MSG_LEN];
2379 assert( Format != NULL );
2382 va_start( ap, Format );
2386 vsnprintf( msg, MAX_LOG_MSG_LEN, Format, ap );
2390 if (Level <= LOG_WARNING)
2391 printf(" - %s\n", msg);
2395 Log(Level, "%s", msg);
2401 * Dump internal state of the "configuration module".
2404 Conf_DebugDump(void)
2408 Log(LOG_DEBUG, "Configured servers:");
2409 for (i = 0; i < MAX_SERVERS; i++) {
2410 if (! Conf_Server[i].name[0])
2413 " - %s: %s:%d, last=%ld, group=%d, flags=%d, conn=%d",
2414 Conf_Server[i].name, Conf_Server[i].host,
2415 Conf_Server[i].port, Conf_Server[i].lasttry,
2416 Conf_Server[i].group, Conf_Server[i].flags,
2417 Conf_Server[i].conn_id);
2424 * Initialize server configuration structure to default values.
2426 * @param Server Pointer to server structure to initialize.
2429 Init_Server_Struct( CONF_SERVER *Server )
2431 assert( Server != NULL );
2433 memset( Server, 0, sizeof (CONF_SERVER) );
2435 Server->group = NONE;
2436 Server->lasttry = time( NULL ) - Conf_ConnectRetry + STARTUP_DELAY;
2438 if( NGIRCd_Passive ) Server->flags = CONF_SFLAG_DISABLED;
2440 Proc_InitStruct(&Server->res_stat);
2441 Server->conn_id = NONE;
2442 memset(&Server->bind_addr, 0, sizeof(Server->bind_addr));