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(" MaxListSize = %d\n", Conf_MaxListSize);
392 printf(" PingTimeout = %d\n", Conf_PingTimeout);
393 printf(" PongTimeout = %d\n", Conf_PongTimeout);
397 printf(" AllowedChannelTypes = %s\n", Conf_AllowedChannelTypes);
398 printf(" AllowRemoteOper = %s\n", yesno_to_str(Conf_AllowRemoteOper));
399 printf(" ChrootDir = %s\n", Conf_Chroot);
400 printf(" CloakHost = %s\n", Conf_CloakHost);
401 printf(" CloakHostModeX = %s\n", Conf_CloakHostModeX);
402 printf(" CloakHostSalt = %s\n", Conf_CloakHostSalt);
403 printf(" CloakUserToNick = %s\n", yesno_to_str(Conf_CloakUserToNick));
405 printf(" ConnectIPv4 = %s\n", yesno_to_str(Conf_ConnectIPv6));
406 printf(" ConnectIPv6 = %s\n", yesno_to_str(Conf_ConnectIPv4));
408 printf(" DefaultUserModes = %s\n", Conf_DefaultUserModes);
409 printf(" DNS = %s\n", yesno_to_str(Conf_DNS));
411 printf(" Ident = %s\n", yesno_to_str(Conf_Ident));
413 printf(" IncludeDir = %s\n", Conf_IncludeDir);
414 printf(" MorePrivacy = %s\n", yesno_to_str(Conf_MorePrivacy));
415 printf(" NoticeBeforeRegistration = %s\n", yesno_to_str(Conf_NoticeBeforeRegistration));
416 printf(" OperCanUseMode = %s\n", yesno_to_str(Conf_OperCanMode));
417 printf(" OperChanPAutoOp = %s\n", yesno_to_str(Conf_OperChanPAutoOp));
418 printf(" OperServerMode = %s\n", yesno_to_str(Conf_OperServerMode));
420 printf(" PAM = %s\n", yesno_to_str(Conf_PAM));
421 printf(" PAMIsOptional = %s\n", yesno_to_str(Conf_PAMIsOptional));
422 printf(" PAMServiceName = %s\n", Conf_PAMServiceName);
425 printf(" RequireAuthPing = %s\n", yesno_to_str(Conf_AuthPing));
427 printf(" ScrubCTCP = %s\n", yesno_to_str(Conf_ScrubCTCP));
429 printf(" SyslogFacility = %s\n",
430 ngt_SyslogFacilityName(Conf_SyslogFacility));
432 printf(" WebircPassword = %s\n", Conf_WebircPwd);
437 printf(" CertFile = %s\n", Conf_SSLOptions.CertFile
438 ? Conf_SSLOptions.CertFile : "");
439 printf(" CipherList = %s\n", Conf_SSLOptions.CipherList ?
440 Conf_SSLOptions.CipherList : DEFAULT_CIPHERS);
441 printf(" DHFile = %s\n", Conf_SSLOptions.DHFile
442 ? Conf_SSLOptions.DHFile : "");
443 printf(" KeyFile = %s\n", Conf_SSLOptions.KeyFile
444 ? Conf_SSLOptions.KeyFile : "");
445 if (array_bytes(&Conf_SSLOptions.KeyFilePassword))
446 puts(" KeyFilePassword = <secret>");
448 puts(" KeyFilePassword = ");
449 array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
451 ports_puts(&Conf_SSLOptions.ListenPorts);
457 for( i = 0; i < MAX_SERVERS; i++ ) {
458 if( ! Conf_Server[i].name[0] ) continue;
460 /* Valid "Server" section */
462 printf( " Name = %s\n", Conf_Server[i].name );
463 printf( " Host = %s\n", Conf_Server[i].host );
464 printf( " Port = %u\n", (unsigned int)Conf_Server[i].port );
466 printf( " SSLConnect = %s\n", Conf_Server[i].SSLConnect?"yes":"no");
468 printf( " MyPassword = %s\n", Conf_Server[i].pwd_in );
469 printf( " PeerPassword = %s\n", Conf_Server[i].pwd_out );
470 printf( " ServiceMask = %s\n", Conf_Server[i].svs_mask);
471 printf( " Group = %d\n", Conf_Server[i].group );
472 printf( " Passive = %s\n\n", Conf_Server[i].flags & CONF_SFLAG_DISABLED ? "yes" : "no");
475 predef_channel_count = array_length(&Conf_Channels, sizeof(*predef_chan));
476 predef_chan = array_start(&Conf_Channels);
478 for (i = 0; i < predef_channel_count; i++, predef_chan++) {
479 if (!predef_chan->name[0])
482 /* Valid "Channel" section */
484 printf(" Name = %s\n", predef_chan->name);
485 printf(" Modes = %s\n", predef_chan->modes);
486 printf(" Key = %s\n", predef_chan->key);
487 printf(" MaxUsers = %lu\n", predef_chan->maxusers);
488 printf(" Topic = %s\n", predef_chan->topic);
489 printf(" KeyFile = %s\n\n", predef_chan->keyfile);
492 return (config_valid ? 0 : 1);
496 * Remove connection information from configured server.
498 * If the server is set as "once", delete it from our configuration;
499 * otherwise set the time for the next connection attempt.
501 * Non-server connections will be silently ignored.
504 Conf_UnsetServer( CONN_ID Idx )
509 /* Check all our configured servers */
510 for( i = 0; i < MAX_SERVERS; i++ ) {
511 if( Conf_Server[i].conn_id != Idx ) continue;
513 /* Gotcha! Mark server configuration as "unused": */
514 Conf_Server[i].conn_id = NONE;
516 if( Conf_Server[i].flags & CONF_SFLAG_ONCE ) {
517 /* Delete configuration here */
518 Init_Server_Struct( &Conf_Server[i] );
520 /* Set time for next connect attempt */
522 if (Conf_Server[i].lasttry < t - Conf_ConnectRetry) {
523 /* The connection has been "long", so we don't
524 * require the next attempt to be delayed. */
525 Conf_Server[i].lasttry =
526 t - Conf_ConnectRetry + RECONNECT_DELAY;
528 /* "Short" connection, enforce "ConnectRetry"
529 * but randomize it a little bit: 15 seconds. */
530 Conf_Server[i].lasttry =
531 #ifdef HAVE_ARC4RANDOM
532 t + (arc4random() % 15);
534 t + rand() / (RAND_MAX / 15);
542 * Set connection information for specified configured server.
545 Conf_SetServer( int ConfServer, CONN_ID Idx )
547 assert( ConfServer > NONE );
548 assert( Idx > NONE );
550 if (Conf_Server[ConfServer].conn_id > NONE &&
551 Conf_Server[ConfServer].conn_id != Idx) {
553 "Connection %d: Server configuration of \"%s\" already in use by connection %d!",
554 Idx, Conf_Server[ConfServer].name,
555 Conf_Server[ConfServer].conn_id);
556 Conn_Close(Idx, NULL, "Server configuration already in use", true);
559 Conf_Server[ConfServer].conn_id = Idx;
564 * Get index of server in configuration structure.
567 Conf_GetServer( CONN_ID Idx )
571 assert( Idx > NONE );
573 for( i = 0; i < MAX_SERVERS; i++ ) {
574 if( Conf_Server[i].conn_id == Idx ) return i;
580 * Enable a server by name and adjust its port number.
582 * @returns true if a server has been enabled and now has a valid port
583 * number and host name for outgoing connections.
586 Conf_EnableServer( const char *Name, UINT16 Port )
590 assert( Name != NULL );
591 for( i = 0; i < MAX_SERVERS; i++ ) {
592 if( strcasecmp( Conf_Server[i].name, Name ) == 0 ) {
593 /* Gotcha! Set port and enable server: */
594 Conf_Server[i].port = Port;
595 Conf_Server[i].flags &= ~CONF_SFLAG_DISABLED;
596 return (Conf_Server[i].port && Conf_Server[i].host[0]);
603 * Enable a server by name.
605 * The server is only usable as outgoing server, if it has set a valid port
606 * number for outgoing connections!
607 * If not, you have to use Conf_EnableServer() function to make it available.
609 * @returns true if a server has been enabled; false otherwise.
612 Conf_EnablePassiveServer(const char *Name)
616 assert( Name != NULL );
617 for (i = 0; i < MAX_SERVERS; i++) {
618 if ((strcasecmp( Conf_Server[i].name, Name ) == 0)
619 && (Conf_Server[i].port > 0)) {
620 /* BINGO! Enable server */
621 Conf_Server[i].flags &= ~CONF_SFLAG_DISABLED;
622 Conf_Server[i].lasttry = 0;
630 * Disable a server by name.
631 * An already established connection will be disconnected.
633 * @returns true if a server was found and has been disabled.
636 Conf_DisableServer( const char *Name )
640 assert( Name != NULL );
641 for( i = 0; i < MAX_SERVERS; i++ ) {
642 if( strcasecmp( Conf_Server[i].name, Name ) == 0 ) {
643 /* Gotcha! Disable and disconnect server: */
644 Conf_Server[i].flags |= CONF_SFLAG_DISABLED;
645 if( Conf_Server[i].conn_id > NONE )
646 Conn_Close(Conf_Server[i].conn_id, NULL,
647 "Server link terminated on operator request",
656 * Add a new remote server to our configuration.
658 * @param Name Name of the new server.
659 * @param Port Port number to connect to or 0 for incoming connections.
660 * @param Host Host name to connect to.
661 * @param MyPwd Password that will be sent to the peer.
662 * @param PeerPwd Password that must be received from the peer.
663 * @returns true if the new server has been added; false otherwise.
666 Conf_AddServer(const char *Name, UINT16 Port, const char *Host,
667 const char *MyPwd, const char *PeerPwd)
671 assert( Name != NULL );
672 assert( Host != NULL );
673 assert( MyPwd != NULL );
674 assert( PeerPwd != NULL );
676 /* Search unused item in server configuration structure */
677 for( i = 0; i < MAX_SERVERS; i++ ) {
678 /* Is this item used? */
679 if( ! Conf_Server[i].name[0] ) break;
681 if( i >= MAX_SERVERS ) return false;
683 Init_Server_Struct( &Conf_Server[i] );
684 strlcpy( Conf_Server[i].name, Name, sizeof( Conf_Server[i].name ));
685 strlcpy( Conf_Server[i].host, Host, sizeof( Conf_Server[i].host ));
686 strlcpy( Conf_Server[i].pwd_out, MyPwd, sizeof( Conf_Server[i].pwd_out ));
687 strlcpy( Conf_Server[i].pwd_in, PeerPwd, sizeof( Conf_Server[i].pwd_in ));
688 Conf_Server[i].port = Port;
689 Conf_Server[i].flags = CONF_SFLAG_ONCE;
695 * Check if the given nickname is reserved for services on a particular server.
697 * @param ConfServer The server index to check.
698 * @param Nick The nickname to check.
699 * @returns true if the given nickname belongs to an "IRC service".
702 Conf_NickIsService(int ConfServer, const char *Nick)
704 assert (ConfServer >= 0);
705 assert (ConfServer < MAX_SERVERS);
707 return MatchCaseInsensitiveList(Conf_Server[ConfServer].svs_mask,
712 * Check if the given nickname is blocked for "normal client" use.
714 * @param Nick The nickname to check.
715 * @returns true if the given nickname belongs to an "IRC service".
718 Conf_NickIsBlocked(const char *Nick)
722 for(i = 0; i < MAX_SERVERS; i++) {
723 if (!Conf_Server[i].name[0])
725 if (Conf_NickIsService(i, Nick))
732 * Initialize configuration settings with their default values.
735 Set_Defaults(bool InitServers)
738 char random[RANDOM_SALT_LEN + 1];
741 strcpy(Conf_ServerName, "");
742 strcpy(Conf_ServerAdmin1, "");
743 strcpy(Conf_ServerAdmin2, "");
744 strcpy(Conf_ServerAdminMail, "");
745 snprintf(Conf_ServerInfo, sizeof Conf_ServerInfo, "%s %s",
746 PACKAGE_NAME, PACKAGE_VERSION);
747 strcpy(Conf_Network, "");
748 free(Conf_ListenAddress);
749 Conf_ListenAddress = NULL;
750 array_free(&Conf_ListenPorts);
751 array_free(&Conf_Motd);
752 array_free(&Conf_Helptext);
753 strlcpy(Conf_MotdFile, SYSCONFDIR, sizeof(Conf_MotdFile));
754 strlcat(Conf_MotdFile, MOTD_FILE, sizeof(Conf_MotdFile));
755 strlcpy(Conf_HelpFile, DOCDIR, sizeof(Conf_HelpFile));
756 strlcat(Conf_HelpFile, HELP_FILE, sizeof(Conf_HelpFile));
757 strcpy(Conf_ServerPwd, "");
758 strlcpy(Conf_PidFile, PID_FILE, sizeof(Conf_PidFile));
759 Conf_UID = Conf_GID = 0;
762 Conf_ConnectRetry = 60;
763 Conf_IdleTimeout = 0;
764 Conf_MaxConnections = 0;
765 Conf_MaxConnectionsIP = 5;
767 Conf_MaxNickLength = CLIENT_NICK_LEN_DEFAULT;
768 Conf_MaxListSize = 100;
769 Conf_PingTimeout = 120;
770 Conf_PongTimeout = 20;
773 strlcpy(Conf_AllowedChannelTypes, CHANTYPES,
774 sizeof(Conf_AllowedChannelTypes));
775 Conf_AllowRemoteOper = false;
777 Conf_AuthPing = false;
779 strlcpy(Conf_Chroot, CHROOT_DIR, sizeof(Conf_Chroot));
780 strcpy(Conf_CloakHost, "");
781 strcpy(Conf_CloakHostModeX, "");
782 strlcpy(Conf_CloakHostSalt, ngt_RandomStr(random, RANDOM_SALT_LEN),
783 sizeof(Conf_CloakHostSalt));
784 Conf_CloakUserToNick = false;
785 Conf_ConnectIPv4 = true;
787 Conf_ConnectIPv6 = true;
789 Conf_ConnectIPv6 = false;
791 strcpy(Conf_DefaultUserModes, "");
798 strcpy(Conf_IncludeDir, "");
799 Conf_MorePrivacy = false;
800 Conf_NoticeBeforeRegistration = false;
801 Conf_OperCanMode = false;
802 Conf_OperChanPAutoOp = true;
803 Conf_OperServerMode = false;
809 Conf_PAMIsOptional = false;
810 strcpy(Conf_PAMServiceName, "ngircd");
811 Conf_ScrubCTCP = false;
814 Conf_SyslogFacility = LOG_LOCAL5;
816 Conf_SyslogFacility = 0;
820 /* Initialize server configuration structures */
822 for (i = 0; i < MAX_SERVERS;
823 Init_Server_Struct(&Conf_Server[i++]));
828 * Get number of configured listening ports.
830 * @returns The number of ports (IPv4+IPv6) on which the server should listen.
835 size_t cnt = array_bytes(&Conf_ListenPorts);
837 cnt += array_bytes(&Conf_SSLOptions.ListenPorts);
843 * Read contents of a text file into an array.
845 * This function is used to read the MOTD and help text file, for example.
847 * @param Filename Name of the file to read.
848 * @return true, when the file has been read in.
851 Read_TextFile(const char *Filename, const char *Name, array *Destination)
857 if (*Filename == '\0')
860 fp = fopen(Filename, "r");
862 Config_Error(LOG_ERR, "Can't read %s file \"%s\": %s",
863 Name, Filename, strerror(errno));
867 array_free(Destination);
868 while (fgets(line, (int)sizeof line, fp)) {
869 ngt_TrimLastChr(line, '\n');
871 /* add text including \0 */
872 if (!array_catb(Destination, line, strlen(line) + 1)) {
873 Log(LOG_ERR, "Cannot read/add \"%s\", line %d: %s",
874 Filename, line_no, strerror(errno));
884 * Read ngIRCd configuration file.
886 * Please note that this function uses exit(1) on fatal errors and therefore
887 * can result in ngIRCd terminating!
889 * @param IsStarting Flag indicating if ngIRCd is starting or not.
890 * @returns true when the configuration file has been read
891 * successfully; false otherwise.
894 Read_Config(bool TestOnly, bool IsStarting)
896 const UINT16 defaultport = 6667;
897 char *ptr, file[FNAME_LEN];
898 struct dirent *entry;
903 /* Open configuration file */
904 fd = fopen( NGIRCd_ConfFile, "r" );
906 /* No configuration file found! */
907 Config_Error( LOG_ALERT, "Can't read configuration \"%s\": %s",
908 NGIRCd_ConfFile, strerror( errno ));
911 Config_Error( LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE_NAME );
916 Set_Defaults(IsStarting);
919 Config_Error(LOG_INFO,
920 "Reading configuration from \"%s\" ...",
923 /* Clean up server configuration structure: mark all already
924 * configured servers as "once" so that they are deleted
925 * after the next disconnect and delete all unused servers.
926 * And delete all servers which are "duplicates" of servers
927 * that are already marked as "once" (such servers have been
928 * created by the last rehash but are now useless). */
929 for( i = 0; i < MAX_SERVERS; i++ ) {
930 if( Conf_Server[i].conn_id == NONE ) Init_Server_Struct( &Conf_Server[i] );
932 /* This structure is in use ... */
933 if( Conf_Server[i].flags & CONF_SFLAG_ONCE ) {
934 /* Check for duplicates */
935 for( n = 0; n < MAX_SERVERS; n++ ) {
936 if( n == i ) continue;
938 if( Conf_Server[i].conn_id == Conf_Server[n].conn_id ) {
939 Init_Server_Struct( &Conf_Server[n] );
941 Log(LOG_DEBUG,"Deleted unused duplicate server %d (kept %d).",
947 /* Mark server as "once" */
948 Conf_Server[i].flags |= CONF_SFLAG_ONCE;
949 Log( LOG_DEBUG, "Marked server %d as \"once\"", i );
954 /* Initialize variables */
955 Init_Server_Struct( &New_Server );
956 New_Server_Idx = NONE;
961 Read_Config_File(NGIRCd_ConfFile, fd);
964 if (Conf_IncludeDir[0]) {
965 dh = opendir(Conf_IncludeDir);
967 Config_Error(LOG_ALERT,
968 "Can't open include directory \"%s\": %s",
969 Conf_IncludeDir, strerror(errno));
971 strlcpy(Conf_IncludeDir, SYSCONFDIR, sizeof(Conf_IncludeDir));
972 strlcat(Conf_IncludeDir, CONFIG_DIR, sizeof(Conf_IncludeDir));
973 dh = opendir(Conf_IncludeDir);
976 /* Include further configuration files, if IncludeDir is available */
978 while ((entry = readdir(dh)) != NULL) {
979 ptr = strrchr(entry->d_name, '.');
980 if (!ptr || strcasecmp(ptr, ".conf") != 0)
982 snprintf(file, sizeof(file), "%s/%s",
983 Conf_IncludeDir, entry->d_name);
985 Config_Error(LOG_INFO,
986 "Reading configuration from \"%s\" ...",
988 fd = fopen(file, "r");
990 Read_Config_File(file, fd);
993 Config_Error(LOG_ALERT,
994 "Can't read configuration \"%s\": %s",
995 file, strerror(errno));
1000 /* Check if there is still a server to add */
1001 if( New_Server.name[0] ) {
1002 /* Copy data to "real" server structure */
1003 assert( New_Server_Idx > NONE );
1004 Conf_Server[New_Server_Idx] = New_Server;
1007 /* not a single listening port? Add default. */
1008 if (no_listenports() &&
1009 !array_copyb(&Conf_ListenPorts, (char*) &defaultport, sizeof defaultport))
1011 Config_Error(LOG_ALERT, "Could not add default listening Port %u: %s",
1012 (unsigned int) defaultport, strerror(errno));
1017 if (!Conf_ListenAddress)
1018 Conf_ListenAddress = strdup_warn(DEFAULT_LISTEN_ADDRSTR);
1020 if (!Conf_ListenAddress) {
1021 Config_Error(LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE_NAME);
1025 /* No MOTD phrase configured? (re)try motd file. */
1026 if (array_bytes(&Conf_Motd) == 0) {
1027 if (Read_TextFile(Conf_MotdFile, "MOTD", &Conf_Motd))
1028 Using_MotdFile = true;
1031 /* Try to read ngIRCd help text file. */
1032 (void)Read_TextFile(Conf_HelpFile, "help text", &Conf_Helptext);
1033 if (!array_bytes(&Conf_Helptext))
1034 Config_Error(LOG_WARNING,
1035 "No help text available, HELP command will be of limited use.");
1038 /* Make sure that all SSL-related files are readable */
1039 CheckFileReadable("CertFile", Conf_SSLOptions.CertFile);
1040 CheckFileReadable("DHFile", Conf_SSLOptions.DHFile);
1041 CheckFileReadable("KeyFile", Conf_SSLOptions.KeyFile);
1043 /* Set the default ciphers if none were configured */
1044 if (!Conf_SSLOptions.CipherList)
1045 Conf_SSLOptions.CipherList = strdup_warn(DEFAULT_CIPHERS);
1052 * Read in and handle a configuration file.
1054 * @param File Name of the configuration file.
1055 * @param fd File descriptor already opened for reading.
1058 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) {
1802 * TODO: This section and support for "NoticeAuth" variable
1803 * could be removed starting with ngIRCd release 24 (one
1804 * release after marking it "deprecated") ...
1806 Config_Error(LOG_WARNING,
1807 "%s, line %d (section \"Options\"): \"%s\" is deprecated, please use \"NoticeBeforeRegistration\"!",
1809 Conf_NoticeBeforeRegistration = Check_ArgIsTrue(Arg);
1812 if (strcasecmp(Var, "NoticeBeforeRegistration") == 0) {
1813 Conf_NoticeBeforeRegistration = Check_ArgIsTrue(Arg);
1816 if (strcasecmp(Var, "OperCanUseMode") == 0) {
1817 Conf_OperCanMode = Check_ArgIsTrue(Arg);
1820 if (strcasecmp(Var, "OperChanPAutoOp") == 0) {
1821 Conf_OperChanPAutoOp = Check_ArgIsTrue(Arg);
1824 if (strcasecmp(Var, "OperServerMode") == 0) {
1825 Conf_OperServerMode = Check_ArgIsTrue(Arg);
1828 if (strcasecmp(Var, "PAM") == 0) {
1829 Conf_PAM = Check_ArgIsTrue(Arg);
1830 WarnPAM(File, Line);
1833 if (strcasecmp(Var, "PAMIsOptional") == 0 ) {
1834 Conf_PAMIsOptional = Check_ArgIsTrue(Arg);
1837 if (strcasecmp(Var, "PAMServiceName") == 0) {
1838 len = strlcpy(Conf_PAMServiceName, Arg, sizeof(Conf_PAMServiceName));
1839 if (len >= sizeof(Conf_PAMServiceName))
1840 Config_Error_TooLong(File, Line, Var);
1843 if (strcasecmp(Var, "PredefChannelsOnly") == 0) {
1845 * TODO: This section and support for "PredefChannelsOnly"
1846 * could be removed starting with ngIRCd release 22 (one
1847 * release after marking it "deprecated") ...
1849 Config_Error(LOG_WARNING,
1850 "%s, line %d (section \"Options\"): \"%s\" is deprecated, please use \"AllowedChannelTypes\"!",
1852 if (Check_ArgIsTrue(Arg))
1853 Conf_AllowedChannelTypes[0] = '\0';
1855 strlcpy(Conf_AllowedChannelTypes, CHANTYPES,
1856 sizeof(Conf_AllowedChannelTypes));
1860 if (strcasecmp(Var, "RequireAuthPing") == 0) {
1861 Conf_AuthPing = Check_ArgIsTrue(Arg);
1865 if (strcasecmp(Var, "ScrubCTCP") == 0) {
1866 Conf_ScrubCTCP = Check_ArgIsTrue(Arg);
1870 if (strcasecmp(Var, "SyslogFacility") == 0) {
1871 Conf_SyslogFacility = ngt_SyslogFacilityID(Arg,
1872 Conf_SyslogFacility);
1876 if (strcasecmp(Var, "WebircPassword") == 0) {
1877 len = strlcpy(Conf_WebircPwd, Arg, sizeof(Conf_WebircPwd));
1878 if (len >= sizeof(Conf_WebircPwd))
1879 Config_Error_TooLong(File, Line, Var);
1883 Config_Error_Section(File, Line, Var, "Options");
1889 * Handle variable in [SSL] configuration section.
1891 * @param Line Line numer in configuration file.
1892 * @param Var Variable name.
1893 * @param Arg Variable argument.
1896 Handle_SSL(const char *File, int Line, char *Var, char *Arg)
1898 assert(File != NULL);
1900 assert(Var != NULL);
1901 assert(Arg != NULL);
1903 if (strcasecmp(Var, "CertFile") == 0) {
1904 assert(Conf_SSLOptions.CertFile == NULL);
1905 Conf_SSLOptions.CertFile = strdup_warn(Arg);
1908 if (strcasecmp(Var, "DHFile") == 0) {
1909 assert(Conf_SSLOptions.DHFile == NULL);
1910 Conf_SSLOptions.DHFile = strdup_warn(Arg);
1913 if (strcasecmp(Var, "KeyFile") == 0) {
1914 assert(Conf_SSLOptions.KeyFile == NULL);
1915 Conf_SSLOptions.KeyFile = strdup_warn(Arg);
1918 if (strcasecmp(Var, "KeyFilePassword") == 0) {
1919 assert(array_bytes(&Conf_SSLOptions.KeyFilePassword) == 0);
1920 if (!array_copys(&Conf_SSLOptions.KeyFilePassword, Arg))
1921 Config_Error(LOG_ERR,
1922 "%s, line %d (section \"SSL\"): Could not copy %s: %s!",
1923 File, Line, Var, strerror(errno));
1926 if (strcasecmp(Var, "Ports") == 0) {
1927 ports_parse(&Conf_SSLOptions.ListenPorts, File, Line, Arg);
1930 if (strcasecmp(Var, "CipherList") == 0) {
1931 assert(Conf_SSLOptions.CipherList == NULL);
1932 Conf_SSLOptions.CipherList = strdup_warn(Arg);
1936 Config_Error_Section(File, Line, Var, "SSL");
1942 * Handle variable in [Operator] configuration section.
1944 * @param Line Line numer in configuration file.
1945 * @param Var Variable name.
1946 * @param Arg Variable argument.
1949 Handle_OPERATOR(const char *File, int Line, char *Var, char *Arg )
1952 struct Conf_Oper *op;
1954 assert( File != NULL );
1956 assert( Var != NULL );
1957 assert( Arg != NULL );
1959 op = array_get(&Conf_Opers, sizeof(*op),
1960 array_length(&Conf_Opers, sizeof(*op)) - 1);
1964 if (strcasecmp(Var, "Name") == 0) {
1965 /* Name of IRC operator */
1966 len = strlcpy(op->name, Arg, sizeof(op->name));
1967 if (len >= sizeof(op->name))
1968 Config_Error_TooLong(File, Line, Var);
1971 if (strcasecmp(Var, "Password") == 0) {
1972 /* Password of IRC operator */
1973 len = strlcpy(op->pwd, Arg, sizeof(op->pwd));
1974 if (len >= sizeof(op->pwd))
1975 Config_Error_TooLong(File, Line, Var);
1978 if (strcasecmp(Var, "Mask") == 0) {
1980 return; /* Hostname already configured */
1981 op->mask = strdup_warn( Arg );
1985 Config_Error_Section(File, Line, Var, "Operator");
1989 * Handle variable in [Server] configuration section.
1991 * @param Line Line numer in configuration file.
1992 * @param Var Variable name.
1993 * @param Arg Variable argument.
1996 Handle_SERVER(const char *File, int Line, char *Var, char *Arg )
2001 assert( File != NULL );
2003 assert( Var != NULL );
2004 assert( Arg != NULL );
2006 /* Ignore server block if no space is left in server configuration structure */
2007 if( New_Server_Idx <= NONE ) return;
2009 if( strcasecmp( Var, "Host" ) == 0 ) {
2010 /* Hostname of the server */
2011 len = strlcpy( New_Server.host, Arg, sizeof( New_Server.host ));
2012 if (len >= sizeof( New_Server.host ))
2013 Config_Error_TooLong(File, Line, Var);
2016 if( strcasecmp( Var, "Name" ) == 0 ) {
2017 /* Name of the server ("Nick"/"ID") */
2018 len = strlcpy( New_Server.name, Arg, sizeof( New_Server.name ));
2019 if (len >= sizeof( New_Server.name ))
2020 Config_Error_TooLong(File, Line, Var);
2023 if (strcasecmp(Var, "Bind") == 0) {
2024 if (ng_ipaddr_init(&New_Server.bind_addr, Arg, 0))
2027 Config_Error(LOG_ERR, "%s, line %d (section \"Server\"): Can't parse IP address \"%s\"",
2031 if( strcasecmp( Var, "MyPassword" ) == 0 ) {
2032 /* Password of this server which is sent to the peer */
2034 Config_Error(LOG_ERR,
2035 "%s, line %d (section \"Server\"): MyPassword must not start with ':'!",
2038 len = strlcpy( New_Server.pwd_in, Arg, sizeof( New_Server.pwd_in ));
2039 if (len >= sizeof( New_Server.pwd_in ))
2040 Config_Error_TooLong(File, Line, Var);
2043 if( strcasecmp( Var, "PeerPassword" ) == 0 ) {
2044 /* Passwort of the peer which must be received */
2045 len = strlcpy( New_Server.pwd_out, Arg, sizeof( New_Server.pwd_out ));
2046 if (len >= sizeof( New_Server.pwd_out ))
2047 Config_Error_TooLong(File, Line, Var);
2050 if( strcasecmp( Var, "Port" ) == 0 ) {
2051 /* Port to which this server should connect */
2053 if (port >= 0 && port < 0xFFFF)
2054 New_Server.port = (UINT16)port;
2056 Config_Error(LOG_ERR,
2057 "%s, line %d (section \"Server\"): Illegal port number %ld!",
2062 if( strcasecmp( Var, "SSLConnect" ) == 0 ) {
2063 New_Server.SSLConnect = Check_ArgIsTrue(Arg);
2067 if( strcasecmp( Var, "Group" ) == 0 ) {
2069 New_Server.group = atoi( Arg );
2070 if (!New_Server.group && strcmp(Arg, "0"))
2071 Config_Error_NaN(File, Line, Var);
2074 if( strcasecmp( Var, "Passive" ) == 0 ) {
2075 if (Check_ArgIsTrue(Arg))
2076 New_Server.flags |= CONF_SFLAG_DISABLED;
2079 if (strcasecmp(Var, "ServiceMask") == 0) {
2080 len = strlcpy(New_Server.svs_mask, ngt_LowerStr(Arg),
2081 sizeof(New_Server.svs_mask));
2082 if (len >= sizeof(New_Server.svs_mask))
2083 Config_Error_TooLong(File, Line, Var);
2087 Config_Error_Section(File, Line, Var, "Server");
2091 * Copy channel name into channel structure.
2093 * If the channel name is not valid because of a missing prefix ('#', '&'),
2094 * a default prefix of '#' will be added.
2096 * @param new_chan New already allocated channel structure.
2097 * @param name Name of the new channel.
2098 * @returns true on success, false otherwise.
2101 Handle_Channelname(struct Conf_Channel *new_chan, const char *name)
2103 size_t size = sizeof(new_chan->name);
2104 char *dest = new_chan->name;
2106 if (!Channel_IsValidName(name)) {
2108 * maybe user forgot to add a '#'.
2109 * This is only here for user convenience.
2115 return size > strlcpy(dest, name, size);
2119 * Handle variable in [Channel] configuration section.
2121 * @param Line Line numer in configuration file.
2122 * @param Var Variable name.
2123 * @param Arg Variable argument.
2126 Handle_CHANNEL(const char *File, int Line, char *Var, char *Arg)
2129 struct Conf_Channel *chan;
2131 assert( File != NULL );
2133 assert( Var != NULL );
2134 assert( Arg != NULL );
2136 chan = array_get(&Conf_Channels, sizeof(*chan),
2137 array_length(&Conf_Channels, sizeof(*chan)) - 1);
2141 if (strcasecmp(Var, "Name") == 0) {
2142 if (!Handle_Channelname(chan, Arg))
2143 Config_Error_TooLong(File, Line, Var);
2146 if (strcasecmp(Var, "Modes") == 0) {
2148 len = strlcpy(chan->modes, Arg, sizeof(chan->modes));
2149 if (len >= sizeof(chan->modes))
2150 Config_Error_TooLong(File, Line, Var);
2153 if( strcasecmp( Var, "Topic" ) == 0 ) {
2155 len = strlcpy(chan->topic, Arg, sizeof(chan->topic));
2156 if (len >= sizeof(chan->topic))
2157 Config_Error_TooLong(File, Line, Var);
2160 if( strcasecmp( Var, "Key" ) == 0 ) {
2161 /* Initial Channel Key (mode k) */
2162 len = strlcpy(chan->key, Arg, sizeof(chan->key));
2163 if (len >= sizeof(chan->key))
2164 Config_Error_TooLong(File, Line, Var);
2167 if( strcasecmp( Var, "MaxUsers" ) == 0 ) {
2168 /* maximum user limit, mode l */
2169 chan->maxusers = (unsigned long) atol(Arg);
2170 if (!chan->maxusers && strcmp(Arg, "0"))
2171 Config_Error_NaN(File, Line, Var);
2174 if (strcasecmp(Var, "KeyFile") == 0) {
2176 len = strlcpy(chan->keyfile, Arg, sizeof(chan->keyfile));
2177 if (len >= sizeof(chan->keyfile))
2178 Config_Error_TooLong(File, Line, Var);
2182 Config_Error_Section(File, Line, Var, "Channel");
2186 * Validate server configuration.
2188 * Please note that this function uses exit(1) on fatal errors and therefore
2189 * can result in ngIRCd terminating!
2191 * @param Configtest true if the daemon has been called with "--configtest".
2192 * @param Rehash true if re-reading configuration on runtime.
2193 * @returns true if configuration is valid.
2196 Validate_Config(bool Configtest, bool Rehash)
2198 /* Validate configuration settings. */
2201 int i, servers, servers_once;
2203 bool config_valid = true;
2206 /* Emit a warning when the config file is not a full path name */
2207 if (NGIRCd_ConfFile[0] && NGIRCd_ConfFile[0] != '/') {
2208 Config_Error(LOG_WARNING,
2209 "Not specifying a full path name to \"%s\" can cause problems when rehashing the server!",
2213 /* Validate configured server name, see RFC 2812 section 2.3.1 */
2214 ptr = Conf_ServerName;
2216 if (*ptr >= 'a' && *ptr <= 'z') continue;
2217 if (*ptr >= 'A' && *ptr <= 'Z') continue;
2218 if (*ptr >= '0' && *ptr <= '9') continue;
2219 if (ptr > Conf_ServerName) {
2220 if (*ptr == '.' || *ptr == '-')
2223 Conf_ServerName[0] = '\0';
2227 if (!Conf_ServerName[0]) {
2228 /* No server name configured! */
2229 config_valid = false;
2230 Config_Error(LOG_ALERT,
2231 "No (valid) server name configured in \"%s\" (section 'Global': 'Name')!",
2233 if (!Configtest && !Rehash) {
2234 Config_Error(LOG_ALERT,
2235 "%s exiting due to fatal errors!",
2241 if (Conf_ServerName[0] && !strchr(Conf_ServerName, '.')) {
2242 /* No dot in server name! */
2243 config_valid = false;
2244 Config_Error(LOG_ALERT,
2245 "Invalid server name configured in \"%s\" (section 'Global': 'Name'): Dot missing!",
2248 Config_Error(LOG_ALERT,
2249 "%s exiting due to fatal errors!",
2256 if (!Conf_ServerAdminMail[0]) {
2257 /* No administrative contact configured! */
2258 config_valid = false;
2259 Config_Error(LOG_ALERT,
2260 "No administrator email address configured in \"%s\" ('AdminEMail')!",
2263 Config_Error(LOG_ALERT,
2264 "%s exiting due to fatal errors!",
2271 if (!Conf_ServerAdmin1[0] && !Conf_ServerAdmin2[0]
2272 && !Conf_ServerAdminMail[0]) {
2273 /* No administrative information configured! */
2274 Config_Error(LOG_WARNING,
2275 "No administrative information configured but required by RFC!");
2279 if (Conf_PAM && Conf_ServerPwd[0])
2280 Config_Error(LOG_ERR,
2281 "This server uses PAM, \"Password\" in [Global] section will be ignored!");
2285 servers = servers_once = 0;
2286 for (i = 0; i < MAX_SERVERS; i++) {
2287 if (Conf_Server[i].name[0]) {
2289 if (Conf_Server[i].flags & CONF_SFLAG_ONCE)
2294 "Configuration: Operators=%ld, Servers=%d[%d], Channels=%ld",
2295 array_length(&Conf_Opers, sizeof(struct Conf_Oper)),
2296 servers, servers_once,
2297 array_length(&Conf_Channels, sizeof(struct Conf_Channel)));
2300 return config_valid;
2304 * Output "line too long" warning.
2306 * @param Line Line number in configuration file.
2307 * @param Item Affected variable name.
2310 Config_Error_TooLong(const char *File, const int Line, const char *Item)
2312 Config_Error(LOG_WARNING, "%s, line %d: Value of \"%s\" too long!",
2317 * Output "unknown variable" warning.
2319 * @param Line Line number in configuration file.
2320 * @param Item Affected variable name.
2321 * @param Section Section name.
2324 Config_Error_Section(const char *File, const int Line, const char *Item,
2325 const char *Section)
2327 Config_Error(LOG_ERR, "%s, line %d (section \"%s\"): Unknown variable \"%s\"!",
2328 File, Line, Section, Item);
2332 * Output "not a number" warning.
2334 * @param Line Line number in configuration file.
2335 * @param Item Affected variable name.
2338 Config_Error_NaN(const char *File, const int Line, const char *Item )
2340 Config_Error(LOG_WARNING, "%s, line %d: Value of \"%s\" is not a number!",
2345 * Output configuration error to console and/or logfile.
2347 * On runtime, the normal log functions of the daemon are used. But when
2348 * testing the configuration ("--configtest"), all messages go directly
2351 * @param Level Severity level of the message.
2352 * @param Format Format string; see printf() function.
2355 static void Config_Error( const int Level, const char *Format, ... )
2357 static void Config_Error( Level, Format, va_alist )
2363 char msg[MAX_LOG_MSG_LEN];
2366 assert( Format != NULL );
2369 va_start( ap, Format );
2373 vsnprintf( msg, MAX_LOG_MSG_LEN, Format, ap );
2377 if (Level <= LOG_WARNING)
2378 printf(" - %s\n", msg);
2382 Log(Level, "%s", msg);
2388 * Dump internal state of the "configuration module".
2391 Conf_DebugDump(void)
2395 Log(LOG_DEBUG, "Configured servers:");
2396 for (i = 0; i < MAX_SERVERS; i++) {
2397 if (! Conf_Server[i].name[0])
2400 " - %s: %s:%d, last=%ld, group=%d, flags=%d, conn=%d",
2401 Conf_Server[i].name, Conf_Server[i].host,
2402 Conf_Server[i].port, Conf_Server[i].lasttry,
2403 Conf_Server[i].group, Conf_Server[i].flags,
2404 Conf_Server[i].conn_id);
2411 * Initialize server configuration structure to default values.
2413 * @param Server Pointer to server structure to initialize.
2416 Init_Server_Struct( CONF_SERVER *Server )
2418 assert( Server != NULL );
2420 memset( Server, 0, sizeof (CONF_SERVER) );
2422 Server->group = NONE;
2423 Server->lasttry = time( NULL ) - Conf_ConnectRetry + STARTUP_DELAY;
2425 if( NGIRCd_Passive ) Server->flags = CONF_SFLAG_DISABLED;
2427 Proc_InitStruct(&Server->res_stat);
2428 Server->conn_id = NONE;
2429 memset(&Server->bind_addr, 0, sizeof(Server->bind_addr));