2 * ngIRCd -- The Next Generation IRC Daemon
3 * Copyright (c)2001-2014 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 ConfServer The server index or NONE to check all configured servers.
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_MaxListSize = 100;
770 Conf_PingTimeout = 120;
771 Conf_PongTimeout = 20;
774 strlcpy(Conf_AllowedChannelTypes, CHANTYPES,
775 sizeof(Conf_AllowedChannelTypes));
776 Conf_AllowRemoteOper = false;
778 Conf_AuthPing = false;
780 strlcpy(Conf_Chroot, CHROOT_DIR, sizeof(Conf_Chroot));
781 strcpy(Conf_CloakHost, "");
782 strcpy(Conf_CloakHostModeX, "");
783 strlcpy(Conf_CloakHostSalt, ngt_RandomStr(random, RANDOM_SALT_LEN),
784 sizeof(Conf_CloakHostSalt));
785 Conf_CloakUserToNick = false;
786 Conf_ConnectIPv4 = true;
788 Conf_ConnectIPv6 = true;
790 Conf_ConnectIPv6 = false;
792 strcpy(Conf_DefaultUserModes, "");
799 strcpy(Conf_IncludeDir, "");
800 Conf_MorePrivacy = false;
801 Conf_NoticeBeforeRegistration = false;
802 Conf_OperCanMode = false;
803 Conf_OperChanPAutoOp = true;
804 Conf_OperServerMode = false;
810 Conf_PAMIsOptional = false;
811 strcpy(Conf_PAMServiceName, "ngircd");
812 Conf_ScrubCTCP = false;
815 Conf_SyslogFacility = LOG_LOCAL5;
817 Conf_SyslogFacility = 0;
821 /* Initialize server configuration structures */
823 for (i = 0; i < MAX_SERVERS;
824 Init_Server_Struct(&Conf_Server[i++]));
829 * Get number of configured listening ports.
831 * @returns The number of ports (IPv4+IPv6) on which the server should listen.
836 size_t cnt = array_bytes(&Conf_ListenPorts);
838 cnt += array_bytes(&Conf_SSLOptions.ListenPorts);
844 * Read contents of a text file into an array.
846 * This function is used to read the MOTD and help text file, for example.
848 * @param filename Name of the file to read.
849 * @return true, when the file has been read in.
852 Read_TextFile(const char *Filename, const char *Name, array *Destination)
858 if (*Filename == '\0')
861 fp = fopen(Filename, "r");
863 Config_Error(LOG_ERR, "Can't read %s file \"%s\": %s",
864 Name, Filename, strerror(errno));
868 array_free(Destination);
869 while (fgets(line, (int)sizeof line, fp)) {
870 ngt_TrimLastChr(line, '\n');
872 /* add text including \0 */
873 if (!array_catb(Destination, line, strlen(line) + 1)) {
874 Log(LOG_ERR, "Cannot read/add \"%s\", line %d: %s",
875 Filename, line_no, strerror(errno));
885 * Read ngIRCd configuration file.
887 * Please note that this function uses exit(1) on fatal errors and therefore
888 * can result in ngIRCd terminating!
890 * @param ngircd_starting Flag indicating if ngIRCd is starting or not.
891 * @returns true when the configuration file has been read
892 * successfully; false otherwise.
895 Read_Config(bool TestOnly, bool IsStarting)
897 const UINT16 defaultport = 6667;
898 char *ptr, file[FNAME_LEN];
899 struct dirent *entry;
904 /* Open configuration file */
905 fd = fopen( NGIRCd_ConfFile, "r" );
907 /* No configuration file found! */
908 Config_Error( LOG_ALERT, "Can't read configuration \"%s\": %s",
909 NGIRCd_ConfFile, strerror( errno ));
912 Config_Error( LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE_NAME );
917 Set_Defaults(IsStarting);
920 Config_Error(LOG_INFO,
921 "Reading configuration from \"%s\" ...",
924 /* Clean up server configuration structure: mark all already
925 * configured servers as "once" so that they are deleted
926 * after the next disconnect and delete all unused servers.
927 * And delete all servers which are "duplicates" of servers
928 * that are already marked as "once" (such servers have been
929 * created by the last rehash but are now useless). */
930 for( i = 0; i < MAX_SERVERS; i++ ) {
931 if( Conf_Server[i].conn_id == NONE ) Init_Server_Struct( &Conf_Server[i] );
933 /* This structure is in use ... */
934 if( Conf_Server[i].flags & CONF_SFLAG_ONCE ) {
935 /* Check for duplicates */
936 for( n = 0; n < MAX_SERVERS; n++ ) {
937 if( n == i ) continue;
939 if( Conf_Server[i].conn_id == Conf_Server[n].conn_id ) {
940 Init_Server_Struct( &Conf_Server[n] );
942 Log(LOG_DEBUG,"Deleted unused duplicate server %d (kept %d).",
948 /* Mark server as "once" */
949 Conf_Server[i].flags |= CONF_SFLAG_ONCE;
950 Log( LOG_DEBUG, "Marked server %d as \"once\"", i );
955 /* Initialize variables */
956 Init_Server_Struct( &New_Server );
957 New_Server_Idx = NONE;
962 Read_Config_File(NGIRCd_ConfFile, fd);
965 if (Conf_IncludeDir[0]) {
966 dh = opendir(Conf_IncludeDir);
968 Config_Error(LOG_ALERT,
969 "Can't open include directory \"%s\": %s",
970 Conf_IncludeDir, strerror(errno));
972 strlcpy(Conf_IncludeDir, SYSCONFDIR, sizeof(Conf_IncludeDir));
973 strlcat(Conf_IncludeDir, CONFIG_DIR, sizeof(Conf_IncludeDir));
974 dh = opendir(Conf_IncludeDir);
977 /* Include further configuration files, if IncludeDir is available */
979 while ((entry = readdir(dh)) != NULL) {
980 ptr = strrchr(entry->d_name, '.');
981 if (!ptr || strcasecmp(ptr, ".conf") != 0)
983 snprintf(file, sizeof(file), "%s/%s",
984 Conf_IncludeDir, entry->d_name);
986 Config_Error(LOG_INFO,
987 "Reading configuration from \"%s\" ...",
989 fd = fopen(file, "r");
991 Read_Config_File(file, fd);
994 Config_Error(LOG_ALERT,
995 "Can't read configuration \"%s\": %s",
996 file, strerror(errno));
1001 /* Check if there is still a server to add */
1002 if( New_Server.name[0] ) {
1003 /* Copy data to "real" server structure */
1004 assert( New_Server_Idx > NONE );
1005 Conf_Server[New_Server_Idx] = New_Server;
1008 /* not a single listening port? Add default. */
1009 if (no_listenports() &&
1010 !array_copyb(&Conf_ListenPorts, (char*) &defaultport, sizeof defaultport))
1012 Config_Error(LOG_ALERT, "Could not add default listening Port %u: %s",
1013 (unsigned int) defaultport, strerror(errno));
1018 if (!Conf_ListenAddress)
1019 Conf_ListenAddress = strdup_warn(DEFAULT_LISTEN_ADDRSTR);
1021 if (!Conf_ListenAddress) {
1022 Config_Error(LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE_NAME);
1026 /* No MOTD phrase configured? (re)try motd file. */
1027 if (array_bytes(&Conf_Motd) == 0) {
1028 if (Read_TextFile(Conf_MotdFile, "MOTD", &Conf_Motd))
1029 Using_MotdFile = true;
1032 /* Try to read ngIRCd help text file. */
1033 (void)Read_TextFile(Conf_HelpFile, "help text", &Conf_Helptext);
1034 if (!array_bytes(&Conf_Helptext))
1035 Config_Error(LOG_WARNING,
1036 "No help text available, HELP command will be of limited use.");
1039 /* Make sure that all SSL-related files are readable */
1040 CheckFileReadable("CertFile", Conf_SSLOptions.CertFile);
1041 CheckFileReadable("DHFile", Conf_SSLOptions.DHFile);
1042 CheckFileReadable("KeyFile", Conf_SSLOptions.KeyFile);
1044 /* Set the default ciphers if none were configured */
1045 if (!Conf_SSLOptions.CipherList)
1046 Conf_SSLOptions.CipherList = strdup_warn(DEFAULT_CIPHERS);
1053 * Read in and handle a configuration file.
1055 * @param File Name of the configuration file.
1056 * @param fd File descriptor already opened for reading.
1059 Read_Config_File(const char *File, FILE *fd)
1061 char section[LINE_LEN], str[LINE_LEN], *var, *arg, *ptr;
1065 /* Read configuration file */
1068 if (!fgets(str, sizeof(str), fd))
1073 /* Skip comments and empty lines */
1074 if (str[0] == ';' || str[0] == '#' || str[0] == '\0')
1077 if (strlen(str) >= sizeof(str) - 1) {
1078 Config_Error(LOG_WARNING, "%s, line %d too long!",
1083 /* Is this the beginning of a new section? */
1084 if ((str[0] == '[') && (str[strlen(str) - 1] == ']')) {
1085 strlcpy(section, str, sizeof(section));
1086 if (strcasecmp(section, "[GLOBAL]") == 0
1087 || strcasecmp(section, "[LIMITS]") == 0
1088 || strcasecmp(section, "[OPTIONS]") == 0
1090 || strcasecmp(section, "[SSL]") == 0
1095 if (strcasecmp(section, "[SERVER]") == 0) {
1096 /* Check if there is already a server to add */
1097 if (New_Server.name[0]) {
1098 /* Copy data to "real" server structure */
1099 assert(New_Server_Idx > NONE);
1100 Conf_Server[New_Server_Idx] =
1104 /* Re-init structure for new server */
1105 Init_Server_Struct(&New_Server);
1107 /* Search unused item in server configuration structure */
1108 for (i = 0; i < MAX_SERVERS; i++) {
1109 /* Is this item used? */
1110 if (!Conf_Server[i].name[0])
1113 if (i >= MAX_SERVERS) {
1114 /* Oops, no free item found! */
1115 Config_Error(LOG_ERR,
1116 "Too many servers configured.");
1117 New_Server_Idx = NONE;
1123 if (strcasecmp(section, "[CHANNEL]") == 0) {
1124 count = array_length(&Conf_Channels,
1129 sizeof(struct Conf_Channel), count)) {
1130 Config_Error(LOG_ERR,
1131 "Could not allocate memory for new operator (line %d)",
1137 if (strcasecmp(section, "[OPERATOR]") == 0) {
1138 count = array_length(&Conf_Opers,
1139 sizeof(struct Conf_Oper));
1140 if (!array_alloc(&Conf_Opers,
1141 sizeof(struct Conf_Oper),
1143 Config_Error(LOG_ERR,
1144 "Could not allocate memory for new channel (line &d)",
1150 Config_Error(LOG_ERR,
1151 "%s, line %d: Unknown section \"%s\"!",
1152 File, line, section);
1155 if (section[0] == 0x1)
1158 /* Split line into variable name and parameters */
1159 ptr = strchr(str, '=');
1161 Config_Error(LOG_ERR, "%s, line %d: Syntax error!",
1171 if (strcasecmp(section, "[GLOBAL]") == 0)
1172 Handle_GLOBAL(File, line, var, arg);
1173 else if (strcasecmp(section, "[LIMITS]") == 0)
1174 Handle_LIMITS(File, line, var, arg);
1175 else if (strcasecmp(section, "[OPTIONS]") == 0)
1176 Handle_OPTIONS(File, line, var, arg);
1178 else if (strcasecmp(section, "[SSL]") == 0)
1179 Handle_SSL(File, line, var, arg);
1181 else if (strcasecmp(section, "[OPERATOR]") == 0)
1182 Handle_OPERATOR(File, line, var, arg);
1183 else if (strcasecmp(section, "[SERVER]") == 0)
1184 Handle_SERVER(File, line, var, arg);
1185 else if (strcasecmp(section, "[CHANNEL]") == 0)
1186 Handle_CHANNEL(File, line, var, arg);
1188 Config_Error(LOG_ERR,
1189 "%s, line %d: Variable \"%s\" outside section!",
1195 * Check whether a string argument is "true" or "false".
1197 * @param Arg Input string.
1198 * @returns true if the input string has been parsed as "yes", "true"
1199 * (case insensitive) or a non-zero integer value.
1202 Check_ArgIsTrue(const char *Arg)
1204 if (strcasecmp(Arg, "yes") == 0)
1206 if (strcasecmp(Arg, "true") == 0)
1215 * Handle setting of "MaxNickLength".
1217 * @param Line Line number in configuration file.
1218 * @raram Arg Input string.
1219 * @returns New configured maximum nickname length.
1222 Handle_MaxNickLength(const char *File, int Line, const char *Arg)
1226 new = (unsigned) atoi(Arg) + 1;
1227 if (new > CLIENT_NICK_LEN) {
1228 Config_Error(LOG_WARNING,
1229 "%s, line %d: Value of \"MaxNickLength\" exceeds %u!",
1230 File, Line, CLIENT_NICK_LEN - 1);
1231 return CLIENT_NICK_LEN;
1234 Config_Error(LOG_WARNING,
1235 "%s, line %d: Value of \"MaxNickLength\" must be at least 1!",
1243 * Output a warning messages if IDENT is configured but not compiled in.
1246 WarnIdent(const char UNUSED *File, int UNUSED Line)
1250 /* user has enabled ident lookups explicitly, but ... */
1251 Config_Error(LOG_WARNING,
1252 "%s: line %d: \"Ident = yes\", but ngircd was built without IDENT support!",
1259 * Output a warning messages if IPv6 is configured but not compiled in.
1262 WarnIPv6(const char UNUSED *File, int UNUSED Line)
1265 if (Conf_ConnectIPv6) {
1266 /* user has enabled IPv6 explicitly, but ... */
1267 Config_Error(LOG_WARNING,
1268 "%s: line %d: \"ConnectIPv6 = yes\", but ngircd was built without IPv6 support!",
1275 * Output a warning messages if PAM is configured but not compiled in.
1278 WarnPAM(const char UNUSED *File, int UNUSED Line)
1282 Config_Error(LOG_WARNING,
1283 "%s: line %d: \"PAM = yes\", but ngircd was built without PAM support!",
1290 * Handle legacy "NoXXX" options in [GLOBAL] section.
1292 * TODO: This function and support for "NoXXX" could be removed starting
1293 * with ngIRCd release 19 (one release after marking it "deprecated").
1295 * @param Var Variable name.
1296 * @param Arg Argument string.
1297 * @returns true if a NoXXX option has been processed; false otherwise.
1300 CheckLegacyNoOption(const char *Var, const char *Arg)
1302 if(strcasecmp(Var, "NoDNS") == 0) {
1303 Conf_DNS = !Check_ArgIsTrue( Arg );
1306 if (strcasecmp(Var, "NoIdent") == 0) {
1307 Conf_Ident = !Check_ArgIsTrue(Arg);
1310 if(strcasecmp(Var, "NoPAM") == 0) {
1311 Conf_PAM = !Check_ArgIsTrue(Arg);
1318 * Handle deprecated legacy options in [GLOBAL] section.
1320 * TODO: This function and support for these options in the [Global] section
1321 * could be removed starting with ngIRCd release 19 (one release after
1322 * marking it "deprecated").
1324 * @param Var Variable name.
1325 * @param Arg Argument string.
1326 * @returns true if a legacy option has been processed; false otherwise.
1329 CheckLegacyGlobalOption(const char *File, int Line, char *Var, char *Arg)
1331 if (strcasecmp(Var, "AllowRemoteOper") == 0
1332 || strcasecmp(Var, "ChrootDir") == 0
1333 || strcasecmp(Var, "ConnectIPv4") == 0
1334 || strcasecmp(Var, "ConnectIPv6") == 0
1335 || strcasecmp(Var, "OperCanUseMode") == 0
1336 || strcasecmp(Var, "OperChanPAutoOp") == 0
1337 || strcasecmp(Var, "OperServerMode") == 0
1338 || strcasecmp(Var, "PredefChannelsOnly") == 0
1339 || strcasecmp(Var, "SyslogFacility") == 0
1340 || strcasecmp(Var, "WebircPassword") == 0) {
1341 Handle_OPTIONS(File, Line, Var, Arg);
1344 if (strcasecmp(Var, "ConnectRetry") == 0
1345 || strcasecmp(Var, "IdleTimeout") == 0
1346 || strcasecmp(Var, "MaxConnections") == 0
1347 || strcasecmp(Var, "MaxConnectionsIP") == 0
1348 || strcasecmp(Var, "MaxJoins") == 0
1349 || strcasecmp(Var, "MaxNickLength") == 0
1350 || strcasecmp(Var, "PingTimeout") == 0
1351 || strcasecmp(Var, "PongTimeout") == 0) {
1352 Handle_LIMITS(File, Line, Var, Arg);
1356 if (strcasecmp(Var, "SSLCertFile") == 0
1357 || strcasecmp(Var, "SSLDHFile") == 0
1358 || strcasecmp(Var, "SSLKeyFile") == 0
1359 || strcasecmp(Var, "SSLKeyFilePassword") == 0
1360 || strcasecmp(Var, "SSLPorts") == 0) {
1361 Handle_SSL(File, Line, Var + 3, Arg);
1370 * Strip "no" prefix of a string.
1372 * TODO: This function and support for "NoXXX" should be removed starting
1373 * with ngIRCd release 19! (One release after marking it "deprecated").
1375 * @param str Pointer to input string starting with "no".
1376 * @returns New pointer to string without "no" prefix.
1379 NoNo(const char *str)
1381 assert(strncasecmp("no", str, 2) == 0 && str[2]);
1386 * Invert "boolean" string.
1388 * TODO: This function and support for "NoXXX" should be removed starting
1389 * with ngIRCd release 19! (One release after marking it "deprecated").
1391 * @param arg "Boolean" input string.
1392 * @returns Pointer to inverted "boolean string".
1395 InvertArg(const char *arg)
1397 return yesno_to_str(!Check_ArgIsTrue(arg));
1401 * Handle variable in [Global] configuration section.
1403 * @param Line Line numer in configuration file.
1404 * @param Var Variable name.
1405 * @param Arg Variable argument.
1408 Handle_GLOBAL(const char *File, int Line, char *Var, char *Arg )
1413 const char *section;
1416 assert(File != NULL);
1418 assert(Var != NULL);
1419 assert(Arg != NULL);
1421 if (strcasecmp(Var, "Name") == 0) {
1422 len = strlcpy(Conf_ServerName, Arg, sizeof(Conf_ServerName));
1423 if (len >= sizeof(Conf_ServerName))
1424 Config_Error_TooLong(File, Line, Var);
1427 if (strcasecmp(Var, "AdminInfo1") == 0) {
1428 len = strlcpy(Conf_ServerAdmin1, Arg, sizeof(Conf_ServerAdmin1));
1429 if (len >= sizeof(Conf_ServerAdmin1))
1430 Config_Error_TooLong(File, Line, Var);
1433 if (strcasecmp(Var, "AdminInfo2") == 0) {
1434 len = strlcpy(Conf_ServerAdmin2, Arg, sizeof(Conf_ServerAdmin2));
1435 if (len >= sizeof(Conf_ServerAdmin2))
1436 Config_Error_TooLong(File, Line, Var);
1439 if (strcasecmp(Var, "AdminEMail") == 0) {
1440 len = strlcpy(Conf_ServerAdminMail, Arg,
1441 sizeof(Conf_ServerAdminMail));
1442 if (len >= sizeof(Conf_ServerAdminMail))
1443 Config_Error_TooLong(File, Line, Var);
1446 if (strcasecmp(Var, "Info") == 0) {
1447 len = strlcpy(Conf_ServerInfo, Arg, sizeof(Conf_ServerInfo));
1448 if (len >= sizeof(Conf_ServerInfo))
1449 Config_Error_TooLong(File, Line, Var);
1452 if (strcasecmp(Var, "HelpFile") == 0) {
1453 len = strlcpy(Conf_HelpFile, Arg, sizeof(Conf_HelpFile));
1454 if (len >= sizeof(Conf_HelpFile))
1455 Config_Error_TooLong(File, Line, Var);
1458 if (strcasecmp(Var, "Listen") == 0) {
1459 if (Conf_ListenAddress) {
1460 Config_Error(LOG_ERR,
1461 "Multiple Listen= options, ignoring: %s",
1465 Conf_ListenAddress = strdup_warn(Arg);
1466 /* If allocation fails, we're in trouble: we cannot ignore the
1467 * error -- otherwise ngircd would listen on all interfaces. */
1468 if (!Conf_ListenAddress) {
1469 Config_Error(LOG_ALERT,
1470 "%s exiting due to fatal errors!",
1476 if (strcasecmp(Var, "MotdFile") == 0) {
1477 len = strlcpy(Conf_MotdFile, Arg, sizeof(Conf_MotdFile));
1478 if (len >= sizeof(Conf_MotdFile))
1479 Config_Error_TooLong(File, Line, Var);
1482 if (strcasecmp(Var, "MotdPhrase") == 0) {
1487 Config_Error_TooLong(File, Line, Var);
1490 if (!array_copyb(&Conf_Motd, Arg, len + 1))
1491 Config_Error(LOG_WARNING,
1492 "%s, line %d: Could not append MotdPhrase: %s",
1493 File, Line, strerror(errno));
1494 Using_MotdFile = false;
1497 if (strcasecmp(Var, "Network") == 0) {
1498 len = strlcpy(Conf_Network, Arg, sizeof(Conf_Network));
1499 if (len >= sizeof(Conf_Network))
1500 Config_Error_TooLong(File, Line, Var);
1501 ptr = strchr(Conf_Network, ' ');
1503 Config_Error(LOG_WARNING,
1504 "%s, line %d: \"Network\" can't contain spaces!",
1510 if(strcasecmp(Var, "Password") == 0) {
1511 len = strlcpy(Conf_ServerPwd, Arg, sizeof(Conf_ServerPwd));
1512 if (len >= sizeof(Conf_ServerPwd))
1513 Config_Error_TooLong(File, Line, Var);
1516 if (strcasecmp(Var, "PidFile") == 0) {
1517 len = strlcpy(Conf_PidFile, Arg, sizeof(Conf_PidFile));
1518 if (len >= sizeof(Conf_PidFile))
1519 Config_Error_TooLong(File, Line, Var);
1522 if (strcasecmp(Var, "Ports") == 0) {
1523 ports_parse(&Conf_ListenPorts, File, Line, Arg);
1526 if (strcasecmp(Var, "ServerGID") == 0) {
1527 grp = getgrnam(Arg);
1529 Conf_GID = grp->gr_gid;
1531 Conf_GID = (unsigned int)atoi(Arg);
1532 if (!Conf_GID && strcmp(Arg, "0"))
1533 Config_Error(LOG_WARNING,
1534 "%s, line %d: Value of \"%s\" is not a valid group name or ID!",
1539 if (strcasecmp(Var, "ServerUID") == 0) {
1540 pwd = getpwnam(Arg);
1542 Conf_UID = pwd->pw_uid;
1544 Conf_UID = (unsigned int)atoi(Arg);
1545 if (!Conf_UID && strcmp(Arg, "0"))
1546 Config_Error(LOG_WARNING,
1547 "%s, line %d: Value of \"%s\" is not a valid user name or ID!",
1553 if (CheckLegacyNoOption(Var, Arg)) {
1554 /* TODO: This function and support for "NoXXX" could be
1555 * be removed starting with ngIRCd release 19 (one release
1556 * after marking it "deprecated"). */
1557 Config_Error(LOG_WARNING,
1558 "%s, line %d (section \"Global\"): \"No\"-Prefix is deprecated, use \"%s = %s\" in [Options] section!",
1559 File, Line, NoNo(Var), InvertArg(Arg));
1560 if (strcasecmp(Var, "NoIdent") == 0)
1561 WarnIdent(File, Line);
1562 else if (strcasecmp(Var, "NoPam") == 0)
1563 WarnPAM(File, Line);
1566 if ((section = CheckLegacyGlobalOption(File, Line, Var, Arg))) {
1567 /** TODO: This function and support for these options in the
1568 * [Global] section could be removed starting with ngIRCd
1569 * release 19 (one release after marking it "deprecated"). */
1570 if (strncasecmp(Var, "SSL", 3) == 0) {
1571 Config_Error(LOG_WARNING,
1572 "%s, line %d (section \"Global\"): \"%s\" is deprecated here, move it to %s and rename to \"%s\"!",
1573 File, Line, Var, section,
1576 Config_Error(LOG_WARNING,
1577 "%s, line %d (section \"Global\"): \"%s\" is deprecated here, move it to %s!",
1578 File, Line, Var, section);
1583 Config_Error_Section(File, Line, Var, "Global");
1587 * Handle variable in [Limits] configuration section.
1589 * @param Line Line numer in configuration file.
1590 * @param Var Variable name.
1591 * @param Arg Variable argument.
1594 Handle_LIMITS(const char *File, int Line, char *Var, char *Arg)
1596 assert(File != NULL);
1598 assert(Var != NULL);
1599 assert(Arg != NULL);
1601 if (strcasecmp(Var, "ConnectRetry") == 0) {
1602 Conf_ConnectRetry = atoi(Arg);
1603 if (Conf_ConnectRetry < 5) {
1604 Config_Error(LOG_WARNING,
1605 "%s, line %d: Value of \"ConnectRetry\" too low!",
1607 Conf_ConnectRetry = 5;
1611 if (strcasecmp(Var, "IdleTimeout") == 0) {
1612 Conf_IdleTimeout = atoi(Arg);
1613 if (!Conf_IdleTimeout && strcmp(Arg, "0"))
1614 Config_Error_NaN(File, Line, Var);
1617 if (strcasecmp(Var, "MaxConnections") == 0) {
1618 Conf_MaxConnections = atoi(Arg);
1619 if (!Conf_MaxConnections && strcmp(Arg, "0"))
1620 Config_Error_NaN(File, Line, Var);
1623 if (strcasecmp(Var, "MaxConnectionsIP") == 0) {
1624 Conf_MaxConnectionsIP = atoi(Arg);
1625 if (!Conf_MaxConnectionsIP && strcmp(Arg, "0"))
1626 Config_Error_NaN(File, Line, Var);
1629 if (strcasecmp(Var, "MaxJoins") == 0) {
1630 Conf_MaxJoins = atoi(Arg);
1631 if (!Conf_MaxJoins && strcmp(Arg, "0"))
1632 Config_Error_NaN(File, Line, Var);
1635 if (strcasecmp(Var, "MaxNickLength") == 0) {
1636 Conf_MaxNickLength = Handle_MaxNickLength(File, Line, Arg);
1639 if (strcasecmp(Var, "MaxListSize") == 0) {
1640 Conf_MaxListSize = atoi(Arg);
1641 if (!Conf_MaxListSize && strcmp(Arg, "0"))
1642 Config_Error_NaN(File, Line, Var);
1645 if (strcasecmp(Var, "PingTimeout") == 0) {
1646 Conf_PingTimeout = atoi(Arg);
1647 if (Conf_PingTimeout < 5) {
1648 Config_Error(LOG_WARNING,
1649 "%s, line %d: Value of \"PingTimeout\" too low!",
1651 Conf_PingTimeout = 5;
1655 if (strcasecmp(Var, "PongTimeout") == 0) {
1656 Conf_PongTimeout = atoi(Arg);
1657 if (Conf_PongTimeout < 5) {
1658 Config_Error(LOG_WARNING,
1659 "%s, line %d: Value of \"PongTimeout\" too low!",
1661 Conf_PongTimeout = 5;
1666 Config_Error_Section(File, Line, Var, "Limits");
1670 * Handle variable in [Options] configuration section.
1672 * @param Line Line numer in configuration file.
1673 * @param Var Variable name.
1674 * @param Arg Variable argument.
1677 Handle_OPTIONS(const char *File, int Line, char *Var, char *Arg)
1682 assert(File != NULL);
1684 assert(Var != NULL);
1685 assert(Arg != NULL);
1687 if (strcasecmp(Var, "AllowedChannelTypes") == 0) {
1689 Conf_AllowedChannelTypes[0] = '\0';
1691 if (strchr(Conf_AllowedChannelTypes, *p)) {
1692 /* Prefix is already included; ignore it */
1697 if (strchr(CHANTYPES, *p)) {
1698 len = strlen(Conf_AllowedChannelTypes) + 1;
1699 assert(len < sizeof(Conf_AllowedChannelTypes));
1700 Conf_AllowedChannelTypes[len - 1] = *p;
1701 Conf_AllowedChannelTypes[len] = '\0';
1703 Config_Error(LOG_WARNING,
1704 "%s, line %d: Unknown channel prefix \"%c\" in \"AllowedChannelTypes\"!",
1711 if (strcasecmp(Var, "AllowRemoteOper") == 0) {
1712 Conf_AllowRemoteOper = Check_ArgIsTrue(Arg);
1715 if (strcasecmp(Var, "ChrootDir") == 0) {
1716 len = strlcpy(Conf_Chroot, Arg, sizeof(Conf_Chroot));
1717 if (len >= sizeof(Conf_Chroot))
1718 Config_Error_TooLong(File, Line, Var);
1721 if (strcasecmp(Var, "CloakHost") == 0) {
1722 len = strlcpy(Conf_CloakHost, Arg, sizeof(Conf_CloakHost));
1723 if (len >= sizeof(Conf_CloakHost))
1724 Config_Error_TooLong(File, Line, Var);
1727 if (strcasecmp(Var, "CloakHostModeX") == 0) {
1728 len = strlcpy(Conf_CloakHostModeX, Arg, sizeof(Conf_CloakHostModeX));
1729 if (len >= sizeof(Conf_CloakHostModeX))
1730 Config_Error_TooLong(File, Line, Var);
1733 if (strcasecmp(Var, "CloakHostSalt") == 0) {
1734 len = strlcpy(Conf_CloakHostSalt, Arg, sizeof(Conf_CloakHostSalt));
1735 if (len >= sizeof(Conf_CloakHostSalt))
1736 Config_Error_TooLong(File, Line, Var);
1739 if (strcasecmp(Var, "CloakUserToNick") == 0) {
1740 Conf_CloakUserToNick = Check_ArgIsTrue(Arg);
1743 if (strcasecmp(Var, "ConnectIPv6") == 0) {
1744 Conf_ConnectIPv6 = Check_ArgIsTrue(Arg);
1745 WarnIPv6(File, Line);
1748 if (strcasecmp(Var, "ConnectIPv4") == 0) {
1749 Conf_ConnectIPv4 = Check_ArgIsTrue(Arg);
1752 if (strcasecmp(Var, "DefaultUserModes") == 0) {
1754 Conf_DefaultUserModes[0] = '\0';
1756 if (strchr(Conf_DefaultUserModes, *p)) {
1757 /* Mode is already included; ignore it */
1762 if (strchr(USERMODES, *p)) {
1763 len = strlen(Conf_DefaultUserModes) + 1;
1764 assert(len < sizeof(Conf_DefaultUserModes));
1765 Conf_DefaultUserModes[len - 1] = *p;
1766 Conf_DefaultUserModes[len] = '\0';
1768 Config_Error(LOG_WARNING,
1769 "%s, line %d: Unknown user mode \"%c\" in \"DefaultUserModes\"!",
1776 if (strcasecmp(Var, "DNS") == 0) {
1777 Conf_DNS = Check_ArgIsTrue(Arg);
1780 if (strcasecmp(Var, "Ident") == 0) {
1781 Conf_Ident = Check_ArgIsTrue(Arg);
1782 WarnIdent(File, Line);
1785 if (strcasecmp(Var, "IncludeDir") == 0) {
1786 if (Conf_IncludeDir[0]) {
1787 Config_Error(LOG_ERR,
1788 "%s, line %d: Can't overwrite value of \"IncludeDir\" variable!",
1792 len = strlcpy(Conf_IncludeDir, Arg, sizeof(Conf_IncludeDir));
1793 if (len >= sizeof(Conf_IncludeDir))
1794 Config_Error_TooLong(File, Line, Var);
1797 if (strcasecmp(Var, "MorePrivacy") == 0) {
1798 Conf_MorePrivacy = Check_ArgIsTrue(Arg);
1801 if (strcasecmp(Var, "NoticeAuth") == 0) {
1803 * TODO: This section and support for "NoticeAuth" variable
1804 * could be removed starting with ngIRCd release 24 (one
1805 * release after marking it "deprecated") ...
1807 Config_Error(LOG_WARNING,
1808 "%s, line %d (section \"Options\"): \"%s\" is deprecated, please use \"NoticeBeforeRegistration\"!",
1810 Conf_NoticeBeforeRegistration = Check_ArgIsTrue(Arg);
1813 if (strcasecmp(Var, "NoticeBeforeRegistration") == 0) {
1814 Conf_NoticeBeforeRegistration = Check_ArgIsTrue(Arg);
1817 if (strcasecmp(Var, "OperCanUseMode") == 0) {
1818 Conf_OperCanMode = Check_ArgIsTrue(Arg);
1821 if (strcasecmp(Var, "OperChanPAutoOp") == 0) {
1822 Conf_OperChanPAutoOp = Check_ArgIsTrue(Arg);
1825 if (strcasecmp(Var, "OperServerMode") == 0) {
1826 Conf_OperServerMode = Check_ArgIsTrue(Arg);
1829 if (strcasecmp(Var, "PAM") == 0) {
1830 Conf_PAM = Check_ArgIsTrue(Arg);
1831 WarnPAM(File, Line);
1834 if (strcasecmp(Var, "PAMIsOptional") == 0 ) {
1835 Conf_PAMIsOptional = Check_ArgIsTrue(Arg);
1838 if (strcasecmp(Var, "PAMServiceName") == 0) {
1839 len = strlcpy(Conf_PAMServiceName, Arg, sizeof(Conf_PAMServiceName));
1840 if (len >= sizeof(Conf_PAMServiceName))
1841 Config_Error_TooLong(File, Line, Var);
1844 if (strcasecmp(Var, "PredefChannelsOnly") == 0) {
1846 * TODO: This section and support for "PredefChannelsOnly"
1847 * could be removed starting with ngIRCd release 22 (one
1848 * release after marking it "deprecated") ...
1850 Config_Error(LOG_WARNING,
1851 "%s, line %d (section \"Options\"): \"%s\" is deprecated, please use \"AllowedChannelTypes\"!",
1853 if (Check_ArgIsTrue(Arg))
1854 Conf_AllowedChannelTypes[0] = '\0';
1856 strlcpy(Conf_AllowedChannelTypes, CHANTYPES,
1857 sizeof(Conf_AllowedChannelTypes));
1861 if (strcasecmp(Var, "RequireAuthPing") == 0) {
1862 Conf_AuthPing = Check_ArgIsTrue(Arg);
1866 if (strcasecmp(Var, "ScrubCTCP") == 0) {
1867 Conf_ScrubCTCP = Check_ArgIsTrue(Arg);
1871 if (strcasecmp(Var, "SyslogFacility") == 0) {
1872 Conf_SyslogFacility = ngt_SyslogFacilityID(Arg,
1873 Conf_SyslogFacility);
1877 if (strcasecmp(Var, "WebircPassword") == 0) {
1878 len = strlcpy(Conf_WebircPwd, Arg, sizeof(Conf_WebircPwd));
1879 if (len >= sizeof(Conf_WebircPwd))
1880 Config_Error_TooLong(File, Line, Var);
1884 Config_Error_Section(File, Line, Var, "Options");
1890 * Handle variable in [SSL] configuration section.
1892 * @param Line Line numer in configuration file.
1893 * @param Var Variable name.
1894 * @param Arg Variable argument.
1897 Handle_SSL(const char *File, int Line, char *Var, char *Arg)
1899 assert(File != NULL);
1901 assert(Var != NULL);
1902 assert(Arg != NULL);
1904 if (strcasecmp(Var, "CertFile") == 0) {
1905 assert(Conf_SSLOptions.CertFile == NULL);
1906 Conf_SSLOptions.CertFile = strdup_warn(Arg);
1909 if (strcasecmp(Var, "DHFile") == 0) {
1910 assert(Conf_SSLOptions.DHFile == NULL);
1911 Conf_SSLOptions.DHFile = strdup_warn(Arg);
1914 if (strcasecmp(Var, "KeyFile") == 0) {
1915 assert(Conf_SSLOptions.KeyFile == NULL);
1916 Conf_SSLOptions.KeyFile = strdup_warn(Arg);
1919 if (strcasecmp(Var, "KeyFilePassword") == 0) {
1920 assert(array_bytes(&Conf_SSLOptions.KeyFilePassword) == 0);
1921 if (!array_copys(&Conf_SSLOptions.KeyFilePassword, Arg))
1922 Config_Error(LOG_ERR,
1923 "%s, line %d (section \"SSL\"): Could not copy %s: %s!",
1924 File, Line, Var, strerror(errno));
1927 if (strcasecmp(Var, "Ports") == 0) {
1928 ports_parse(&Conf_SSLOptions.ListenPorts, File, Line, Arg);
1931 if (strcasecmp(Var, "CipherList") == 0) {
1932 assert(Conf_SSLOptions.CipherList == NULL);
1933 Conf_SSLOptions.CipherList = strdup_warn(Arg);
1937 Config_Error_Section(File, Line, Var, "SSL");
1943 * Handle variable in [Operator] configuration section.
1945 * @param Line Line numer in configuration file.
1946 * @param Var Variable name.
1947 * @param Arg Variable argument.
1950 Handle_OPERATOR(const char *File, int Line, char *Var, char *Arg )
1953 struct Conf_Oper *op;
1955 assert( File != NULL );
1957 assert( Var != NULL );
1958 assert( Arg != NULL );
1960 op = array_get(&Conf_Opers, sizeof(*op),
1961 array_length(&Conf_Opers, sizeof(*op)) - 1);
1965 if (strcasecmp(Var, "Name") == 0) {
1966 /* Name of IRC operator */
1967 len = strlcpy(op->name, Arg, sizeof(op->name));
1968 if (len >= sizeof(op->name))
1969 Config_Error_TooLong(File, Line, Var);
1972 if (strcasecmp(Var, "Password") == 0) {
1973 /* Password of IRC operator */
1974 len = strlcpy(op->pwd, Arg, sizeof(op->pwd));
1975 if (len >= sizeof(op->pwd))
1976 Config_Error_TooLong(File, Line, Var);
1979 if (strcasecmp(Var, "Mask") == 0) {
1981 return; /* Hostname already configured */
1982 op->mask = strdup_warn( Arg );
1986 Config_Error_Section(File, Line, Var, "Operator");
1990 * Handle variable in [Server] configuration section.
1992 * @param Line Line numer in configuration file.
1993 * @param Var Variable name.
1994 * @param Arg Variable argument.
1997 Handle_SERVER(const char *File, int Line, char *Var, char *Arg )
2002 assert( File != NULL );
2004 assert( Var != NULL );
2005 assert( Arg != NULL );
2007 /* Ignore server block if no space is left in server configuration structure */
2008 if( New_Server_Idx <= NONE ) return;
2010 if( strcasecmp( Var, "Host" ) == 0 ) {
2011 /* Hostname of the server */
2012 len = strlcpy( New_Server.host, Arg, sizeof( New_Server.host ));
2013 if (len >= sizeof( New_Server.host ))
2014 Config_Error_TooLong(File, Line, Var);
2017 if( strcasecmp( Var, "Name" ) == 0 ) {
2018 /* Name of the server ("Nick"/"ID") */
2019 len = strlcpy( New_Server.name, Arg, sizeof( New_Server.name ));
2020 if (len >= sizeof( New_Server.name ))
2021 Config_Error_TooLong(File, Line, Var);
2024 if (strcasecmp(Var, "Bind") == 0) {
2025 if (ng_ipaddr_init(&New_Server.bind_addr, Arg, 0))
2028 Config_Error(LOG_ERR, "%s, line %d (section \"Server\"): Can't parse IP address \"%s\"",
2032 if( strcasecmp( Var, "MyPassword" ) == 0 ) {
2033 /* Password of this server which is sent to the peer */
2035 Config_Error(LOG_ERR,
2036 "%s, line %d (section \"Server\"): MyPassword must not start with ':'!",
2039 len = strlcpy( New_Server.pwd_in, Arg, sizeof( New_Server.pwd_in ));
2040 if (len >= sizeof( New_Server.pwd_in ))
2041 Config_Error_TooLong(File, Line, Var);
2044 if( strcasecmp( Var, "PeerPassword" ) == 0 ) {
2045 /* Passwort of the peer which must be received */
2046 len = strlcpy( New_Server.pwd_out, Arg, sizeof( New_Server.pwd_out ));
2047 if (len >= sizeof( New_Server.pwd_out ))
2048 Config_Error_TooLong(File, Line, Var);
2051 if( strcasecmp( Var, "Port" ) == 0 ) {
2052 /* Port to which this server should connect */
2054 if (port >= 0 && port < 0xFFFF)
2055 New_Server.port = (UINT16)port;
2057 Config_Error(LOG_ERR,
2058 "%s, line %d (section \"Server\"): Illegal port number %ld!",
2063 if( strcasecmp( Var, "SSLConnect" ) == 0 ) {
2064 New_Server.SSLConnect = Check_ArgIsTrue(Arg);
2068 if( strcasecmp( Var, "Group" ) == 0 ) {
2070 New_Server.group = atoi( Arg );
2071 if (!New_Server.group && strcmp(Arg, "0"))
2072 Config_Error_NaN(File, Line, Var);
2075 if( strcasecmp( Var, "Passive" ) == 0 ) {
2076 if (Check_ArgIsTrue(Arg))
2077 New_Server.flags |= CONF_SFLAG_DISABLED;
2080 if (strcasecmp(Var, "ServiceMask") == 0) {
2081 len = strlcpy(New_Server.svs_mask, ngt_LowerStr(Arg),
2082 sizeof(New_Server.svs_mask));
2083 if (len >= sizeof(New_Server.svs_mask))
2084 Config_Error_TooLong(File, Line, Var);
2088 Config_Error_Section(File, Line, Var, "Server");
2092 * Copy channel name into channel structure.
2094 * If the channel name is not valid because of a missing prefix ('#', '&'),
2095 * a default prefix of '#' will be added.
2097 * @param new_chan New already allocated channel structure.
2098 * @param name Name of the new channel.
2099 * @returns true on success, false otherwise.
2102 Handle_Channelname(struct Conf_Channel *new_chan, const char *name)
2104 size_t size = sizeof(new_chan->name);
2105 char *dest = new_chan->name;
2107 if (!Channel_IsValidName(name)) {
2109 * maybe user forgot to add a '#'.
2110 * This is only here for user convenience.
2116 return size > strlcpy(dest, name, size);
2120 * Handle variable in [Channel] configuration section.
2122 * @param Line Line numer in configuration file.
2123 * @param Var Variable name.
2124 * @param Arg Variable argument.
2127 Handle_CHANNEL(const char *File, int Line, char *Var, char *Arg)
2130 struct Conf_Channel *chan;
2132 assert( File != NULL );
2134 assert( Var != NULL );
2135 assert( Arg != NULL );
2137 chan = array_get(&Conf_Channels, sizeof(*chan),
2138 array_length(&Conf_Channels, sizeof(*chan)) - 1);
2142 if (strcasecmp(Var, "Name") == 0) {
2143 if (!Handle_Channelname(chan, Arg))
2144 Config_Error_TooLong(File, Line, Var);
2147 if (strcasecmp(Var, "Modes") == 0) {
2149 len = strlcpy(chan->modes, Arg, sizeof(chan->modes));
2150 if (len >= sizeof(chan->modes))
2151 Config_Error_TooLong(File, Line, Var);
2154 if( strcasecmp( Var, "Topic" ) == 0 ) {
2156 len = strlcpy(chan->topic, Arg, sizeof(chan->topic));
2157 if (len >= sizeof(chan->topic))
2158 Config_Error_TooLong(File, Line, Var);
2161 if( strcasecmp( Var, "Key" ) == 0 ) {
2162 /* Initial Channel Key (mode k) */
2163 len = strlcpy(chan->key, Arg, sizeof(chan->key));
2164 if (len >= sizeof(chan->key))
2165 Config_Error_TooLong(File, Line, Var);
2168 if( strcasecmp( Var, "MaxUsers" ) == 0 ) {
2169 /* maximum user limit, mode l */
2170 chan->maxusers = (unsigned long) atol(Arg);
2171 if (!chan->maxusers && strcmp(Arg, "0"))
2172 Config_Error_NaN(File, Line, Var);
2175 if (strcasecmp(Var, "KeyFile") == 0) {
2177 len = strlcpy(chan->keyfile, Arg, sizeof(chan->keyfile));
2178 if (len >= sizeof(chan->keyfile))
2179 Config_Error_TooLong(File, Line, Var);
2183 Config_Error_Section(File, Line, Var, "Channel");
2187 * Validate server configuration.
2189 * Please note that this function uses exit(1) on fatal errors and therefore
2190 * can result in ngIRCd terminating!
2192 * @param Configtest true if the daemon has been called with "--configtest".
2193 * @param Rehash true if re-reading configuration on runtime.
2194 * @returns true if configuration is valid.
2197 Validate_Config(bool Configtest, bool Rehash)
2199 /* Validate configuration settings. */
2202 int i, servers, servers_once;
2204 bool config_valid = true;
2207 /* Emit a warning when the config file is not a full path name */
2208 if (NGIRCd_ConfFile[0] && NGIRCd_ConfFile[0] != '/') {
2209 Config_Error(LOG_WARNING,
2210 "Not specifying a full path name to \"%s\" can cause problems when rehashing the server!",
2214 /* Validate configured server name, see RFC 2812 section 2.3.1 */
2215 ptr = Conf_ServerName;
2217 if (*ptr >= 'a' && *ptr <= 'z') continue;
2218 if (*ptr >= 'A' && *ptr <= 'Z') continue;
2219 if (*ptr >= '0' && *ptr <= '9') continue;
2220 if (ptr > Conf_ServerName) {
2221 if (*ptr == '.' || *ptr == '-')
2224 Conf_ServerName[0] = '\0';
2228 if (!Conf_ServerName[0]) {
2229 /* No server name configured! */
2230 config_valid = false;
2231 Config_Error(LOG_ALERT,
2232 "No (valid) server name configured in \"%s\" (section 'Global': 'Name')!",
2234 if (!Configtest && !Rehash) {
2235 Config_Error(LOG_ALERT,
2236 "%s exiting due to fatal errors!",
2242 if (Conf_ServerName[0] && !strchr(Conf_ServerName, '.')) {
2243 /* No dot in server name! */
2244 config_valid = false;
2245 Config_Error(LOG_ALERT,
2246 "Invalid server name configured in \"%s\" (section 'Global': 'Name'): Dot missing!",
2249 Config_Error(LOG_ALERT,
2250 "%s exiting due to fatal errors!",
2257 if (!Conf_ServerAdminMail[0]) {
2258 /* No administrative contact configured! */
2259 config_valid = false;
2260 Config_Error(LOG_ALERT,
2261 "No administrator email address configured in \"%s\" ('AdminEMail')!",
2264 Config_Error(LOG_ALERT,
2265 "%s exiting due to fatal errors!",
2272 if (!Conf_ServerAdmin1[0] && !Conf_ServerAdmin2[0]
2273 && !Conf_ServerAdminMail[0]) {
2274 /* No administrative information configured! */
2275 Config_Error(LOG_WARNING,
2276 "No administrative information configured but required by RFC!");
2280 if (Conf_PAM && Conf_ServerPwd[0])
2281 Config_Error(LOG_ERR,
2282 "This server uses PAM, \"Password\" in [Global] section will be ignored!");
2286 servers = servers_once = 0;
2287 for (i = 0; i < MAX_SERVERS; i++) {
2288 if (Conf_Server[i].name[0]) {
2290 if (Conf_Server[i].flags & CONF_SFLAG_ONCE)
2295 "Configuration: Operators=%ld, Servers=%d[%d], Channels=%ld",
2296 array_length(&Conf_Opers, sizeof(struct Conf_Oper)),
2297 servers, servers_once,
2298 array_length(&Conf_Channels, sizeof(struct Conf_Channel)));
2301 return config_valid;
2305 * Output "line too long" warning.
2307 * @param Line Line number in configuration file.
2308 * @param Item Affected variable name.
2311 Config_Error_TooLong(const char *File, const int Line, const char *Item)
2313 Config_Error(LOG_WARNING, "%s, line %d: Value of \"%s\" too long!",
2318 * Output "unknown variable" warning.
2320 * @param Line Line number in configuration file.
2321 * @param Item Affected variable name.
2322 * @param Section Section name.
2325 Config_Error_Section(const char *File, const int Line, const char *Item,
2326 const char *Section)
2328 Config_Error(LOG_ERR, "%s, line %d (section \"%s\"): Unknown variable \"%s\"!",
2329 File, Line, Section, Item);
2333 * Output "not a number" warning.
2335 * @param Line Line number in configuration file.
2336 * @param Item Affected variable name.
2339 Config_Error_NaN(const char *File, const int Line, const char *Item )
2341 Config_Error(LOG_WARNING, "%s, line %d: Value of \"%s\" is not a number!",
2346 * Output configuration error to console and/or logfile.
2348 * On runtime, the normal log functions of the daemon are used. But when
2349 * testing the configuration ("--configtest"), all messages go directly
2352 * @param Level Severity level of the message.
2353 * @param Format Format string; see printf() function.
2356 static void Config_Error( const int Level, const char *Format, ... )
2358 static void Config_Error( Level, Format, va_alist )
2364 char msg[MAX_LOG_MSG_LEN];
2367 assert( Format != NULL );
2370 va_start( ap, Format );
2374 vsnprintf( msg, MAX_LOG_MSG_LEN, Format, ap );
2378 if (Level <= LOG_WARNING)
2379 printf(" - %s\n", msg);
2383 Log(Level, "%s", msg);
2389 * Dump internal state of the "configuration module".
2392 Conf_DebugDump(void)
2396 Log(LOG_DEBUG, "Configured servers:");
2397 for (i = 0; i < MAX_SERVERS; i++) {
2398 if (! Conf_Server[i].name[0])
2401 " - %s: %s:%d, last=%ld, group=%d, flags=%d, conn=%d",
2402 Conf_Server[i].name, Conf_Server[i].host,
2403 Conf_Server[i].port, Conf_Server[i].lasttry,
2404 Conf_Server[i].group, Conf_Server[i].flags,
2405 Conf_Server[i].conn_id);
2412 * Initialize server configuration structure to default values.
2414 * @param Server Pointer to server structure to initialize.
2417 Init_Server_Struct( CONF_SERVER *Server )
2419 assert( Server != NULL );
2421 memset( Server, 0, sizeof (CONF_SERVER) );
2423 Server->group = NONE;
2424 Server->lasttry = time( NULL ) - Conf_ConnectRetry + STARTUP_DELAY;
2426 if( NGIRCd_Passive ) Server->flags = CONF_SFLAG_DISABLED;
2428 Proc_InitStruct(&Server->res_stat);
2429 Server->conn_id = NONE;
2430 memset(&Server->bind_addr, 0, sizeof(Server->bind_addr));