--- /dev/null
+
+ ngIRCd - Next Generation IRC Server
+ http://ngircd.barton.de/
+
+ (c)2001-2011 Alexander Barton and Contributors.
+ ngIRCd is free software and published under the
+ terms of the GNU General Public License.
+
+ -- Contributing.txt --
+
+
+If you want to contribute to ngIRCd, please read the following paragraphs to
+get an idea of how to do it the best :-)
+
+ - Use GIT
+
+ The source code of ngIRCd is maintained using GIT, see doc/GIT.txt. So if
+ remotely possible, use GIT for your work, too. It makes your and our lifes
+ much easier ;-)
+
+ - Don't forget to include documentation
+
+ When adding features and new configuration options, don't forget to not
+ only code the features but to describe them in doc/sample-ngircd.conf,
+ man/ngircd.8.tmp and/or man/ngircd.conf.5.tmpl as well!
+
+ - Be present on IRC
+
+ If you intend to code some new features or do some code cleanups or better
+ documentation, please be present on <irc://irc.barton.de/#ngircd> and
+ discuss your plans early! So other developers have an idea on what others
+ are working on, can offer help, and can synchronize their own work.
+
+ - Check and validate your work!
+
+ Use "make check" to validate your work, and use "make distcheck" to
+ validate the resulting archives, especially when adding/removing files!
+
+ - Send patches in "unified diff" format
+
+ Please send patches in "unified" format, that is, use "diff -u".
+ Or even better: use GIT ("git diff"), see above.
+
+ - Send patches to the mailing list
+
+ If you have some code to present, send the patch(es) and/or pointers to
+ your GIT repository to the official ngIRCd mailing list for review, not
+ only to #ngircd: so it becomes archived and more people have a chance to
+ review your patch.
+
+ Sure it is a good idea to post some notes to #ngircd, too! :-)
+
+ And this is open source, your work must not be 100% finished and perfect,
+ work in progress is interesting, too: "release early, release often"!
# Use "ngircd --configtest" (see manual page ngircd(8)) to validate that the
# server interprets the configuration file as expected!
#
-# Please see ngircd.conf(5) for a complete list of configuration options.
+# Please see ngircd.conf(5) for a complete list of configuration options
+# and their descriptions.
#
[Global]
# Silently drop all incomming CTCP requests.
;ScrubCTCP = no
+ # Syslog "facility" to which ngIRCd should send log messages.
+ # Possible values are system dependent, but most probably auth, daemon,
+ # user and local1 through local7 are possible values; see syslog(3).
+ # Default is "local5" for historical reasons, you probably want to
+ # change this to "daemon", for example.
+ ;SyslogFacility = local1
+
+ # Password required for using the WEBIRC command used by some
+ # Web-to-IRC gateways. If not set/empty, the WEBIRC command can't
+ # be used. (Default: not set)
+ ;WebircPassword = xyz
+
+;[SSL]
+ # SSL-related configuration options. Please note that this section
+ # is only available when ngIRCd is compiled with support for SSL!
+ # So don't forget to remove the ";" above if this is the case ...
+
# SSL Server Key Certificate
;SSLCertFile = :ETCDIR:/ssl/server-cert.pem
# Additional Listen Ports that expect SSL/TLS encrypted connections
;SSLPorts = 6697, 9999
- # Syslog "facility" to which ngIRCd should send log messages.
- # Possible values are system dependent, but most probably auth, daemon,
- # user and local1 through local7 are possible values; see syslog(3).
- # Default is "local5" for historical reasons, you probably want to
- # change this to "daemon", for example.
- SyslogFacility = local1
-
- # Password required for using the WEBIRC command used by some
- # Web-to-IRC gateways. If not set/empty, the WEBIRC command can't
- # be used. (Default: not set)
- ;WebircPassword = xyz
-
[Operator]
# [Operator] sections are used to define IRC Operators. There may be
# more than one [Operator] block, one for each local operator.
In addition, some string or numerical variables accept lists of values,
separated by commas (",").
.SH "SECTION OVERVIEW"
-The file can contain blocks of four types: [Global], [Limits], [Options],
-[Operator], [Server], and [Channel].
+The file can contain blocks of seven types: [Global], [Limits], [Options],
+[SSL], [Operator], [Server], and [Channel].
.PP
The main configuration of the server is stored in the
.I [Global]
maximum number of clients allowed to connect to this server. Variables in the
.I [Options]
section can be used to enable or disable specific features of ngIRCd, like
-support for IDENT, PAM, IPv6, SSL, and protocol and cloaking features. These
-two sections are both optional.
+support for IDENT, PAM, IPv6, and protocol and cloaking features. The
+.I [SSL]
+block contains all SSL-related configuration variables. These three sections
+are all optional.
.PP
IRC operators of this server are defined in
.I [Operator]
.PP
There can be more than one [Operator], [Server] and [Channel] section per
configuration file (one for each operator, server, and channel), but only
-exactly one [Global], one [Limits], and one [Options] section.
+exactly one [Global], one [Limits], one [Options], and one [SSL] section.
.SH [GLOBAL]
The
.I [Global]
blocking CTCP will disable file sharing between users!
Default: no.
.TP
+\fBSyslogFacility\fR (string)
+Syslog "facility" to which ngIRCd should send log messages. Possible
+values are system dependent, but most probably "auth", "daemon", "user"
+and "local1" through "local7" are possible values; see syslog(3).
+Default is "local5" for historical reasons, you probably want to
+change this to "daemon", for example.
+.TP
+\fBWebircPassword\fR (string)
+Password required for using the WEBIRC command used by some Web-to-IRC
+gateways. If not set or empty, the WEBIRC command can't be used.
+Default: not set.
+.SH [SSL]
+All SSL-related configuration variables are located in the
+.I [SSL]
+section. Please note that this whole section is only recognized by ngIRCd
+when it is compiled with support for SSL using OpenSSL or GnuTLS!
+.TP
\fBSSLCertFile\fR (string)
SSL Certificate file of the private server key.
.TP
Same as \fBPorts\fR , except that ngIRCd will expect incoming connections
to be SSL/TLS encrypted. Common port numbers for SSL-encrypted IRC are 6669
and 6697. Default: none.
-.TP
-\fBSyslogFacility\fR (string)
-Syslog "facility" to which ngIRCd should send log messages. Possible
-values are system dependent, but most probably "auth", "daemon", "user"
-and "local1" through "local7" are possible values; see syslog(3).
-Default is "local5" for historical reasons, you probably want to
-change this to "daemon", for example.
-.TP
-\fBWebircPassword\fR (string)
-Password required for using the WEBIRC command used by some Web-to-IRC
-gateways. If not set or empty, the WEBIRC command can't be used.
-Default: not set.
.SH [OPERATOR]
.I [Operator]
sections are used to define IRC Operators. There may be more than one
\fBMask\fR (string)
Mask that is to be checked before an /OPER for this account is accepted.
Example: nick!ident@*.example.com
-.SH [FEATURES]
-An optional section that can be used to disable features at
-run-time. A feature is enabled by default if if ngircd was built with
-support for it.
.SH [SERVER]
Other servers are configured in
.I [Server]
#ifdef SSL_SUPPORT
+static void Handle_SSL PARAMS(( int Line, char *Var, char *Ark ));
+
struct SSLOptions Conf_SSLOptions;
/**
{
FILE *fp;
+ if (!Filename)
+ return;
+
fp = fopen(Filename, "r");
if (fp)
fclose(fp);
printf(" RequireAuthPing = %s\n", yesno_to_str(Conf_AuthPing));
#endif
printf(" ScrubCTCP = %s\n", yesno_to_str(Conf_ScrubCTCP));
-#ifdef SSL_SUPPORT
- printf(" SSLCertFile = %s\n", Conf_SSLOptions.CertFile);
- printf(" SSLDHFile = %s\n", Conf_SSLOptions.DHFile);
- printf(" SSLKeyFile = %s\n", Conf_SSLOptions.KeyFile);
- if (array_bytes(&Conf_SSLOptions.KeyFilePassword))
- puts(" SSLKeyFilePassword = <secret>");
- else
- puts(" SSLKeyFilePassword = ");
- array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
- printf(" SSLPorts = ");
- ports_puts(&Conf_SSLOptions.ListenPorts);
-#endif
#ifdef SYSLOG
printf(" SyslogFacility = %s\n",
ngt_SyslogFacilityName(Conf_SyslogFacility));
printf(" WebircPassword = %s\n", Conf_WebircPwd);
puts("");
+#ifdef SSL_SUPPORT
+ puts("[SSL]");
+ printf(" CertFile = %s\n", Conf_SSLOptions.CertFile
+ ? Conf_SSLOptions.CertFile : "");
+ printf(" DHFile = %s\n", Conf_SSLOptions.DHFile
+ ? Conf_SSLOptions.DHFile : "");
+ printf(" KeyFile = %s\n", Conf_SSLOptions.KeyFile
+ ? Conf_SSLOptions.KeyFile : "");
+ if (array_bytes(&Conf_SSLOptions.KeyFilePassword))
+ puts(" KeyFilePassword = <secret>");
+ else
+ puts(" KeyFilePassword = ");
+ array_free_wipe(&Conf_SSLOptions.KeyFilePassword);
+ printf(" Ports = ");
+ ports_puts(&Conf_SSLOptions.ListenPorts);
+ puts("");
+#endif
+
opers_puts();
for( i = 0; i < MAX_SERVERS; i++ ) {
strlcpy( section, str, sizeof( section ));
if (strcasecmp(section, "[GLOBAL]") == 0 ||
strcasecmp(section, "[LIMITS]") == 0 ||
- strcasecmp(section, "[OPTIONS]") == 0)
+ strcasecmp(section, "[OPTIONS]") == 0 ||
+ strcasecmp(section, "[SSL]") == 0)
continue;
if( strcasecmp( section, "[SERVER]" ) == 0 ) {
Handle_LIMITS(line, var, arg);
else if(strcasecmp(section, "[OPTIONS]") == 0)
Handle_OPTIONS(line, var, arg);
+#ifdef SSL_SUPPORT
+ else if(strcasecmp(section, "[SSL]") == 0)
+ Handle_SSL(line, var, arg);
+#endif
else if(strcasecmp(section, "[OPERATOR]") == 0)
Handle_OPERATOR(line, var, arg);
else if(strcasecmp(section, "[SERVER]") == 0)
#ifdef SSL_SUPPORT
/* Make sure that all SSL-related files are readable */
- CheckFileReadable("SSLCertFile", Conf_SSLOptions.CertFile);
- CheckFileReadable("SSLDHFile", Conf_SSLOptions.DHFile);
- CheckFileReadable("SSLKeyFile", Conf_SSLOptions.KeyFile);
+ CheckFileReadable("CertFile", Conf_SSLOptions.CertFile);
+ CheckFileReadable("DHFile", Conf_SSLOptions.DHFile);
+ CheckFileReadable("KeyFile", Conf_SSLOptions.KeyFile);
#endif
return true;
|| strcasecmp(Var, "OperCanUseMode") == 0
|| strcasecmp(Var, "OperServerMode") == 0
|| strcasecmp(Var, "PredefChannelsOnly") == 0
-#ifdef SSL_SUPPORT
- || strcasecmp(Var, "SSLCertFile") == 0
- || strcasecmp(Var, "SSLDHFile") == 0
- || strcasecmp(Var, "SSLKeyFile") == 0
- || strcasecmp(Var, "SSLKeyFilePassword") == 0
- || strcasecmp(Var, "SSLPorts") == 0
-#endif
|| strcasecmp(Var, "SyslogFacility") == 0
|| strcasecmp(Var, "WebircPassword") == 0) {
Handle_OPTIONS(Line, Var, Arg);
Handle_LIMITS(Line, Var, Arg);
return "[Limits]";
}
+#ifdef SSL_SUPPORT
+ if (strcasecmp(Var, "SSLCertFile") == 0
+ || strcasecmp(Var, "SSLDHFile") == 0
+ || strcasecmp(Var, "SSLKeyFile") == 0
+ || strcasecmp(Var, "SSLKeyFilePassword") == 0
+ || strcasecmp(Var, "SSLPorts") == 0) {
+ Handle_SSL(Line, Var + 3, Arg);
+ return "[SSL]";
+ }
+#endif
return NULL;
}
/** TODO: This function and support for these options in the
* [Global] section could be removed starting with ngIRCd
* release 19 (one release after marking it "deprecated"). */
- Config_Error(LOG_WARNING,
- "%s, line %d (section \"Global\"): \"%s\" is deprecated here, move it to %s!",
- NGIRCd_ConfFile, Line, Var, section);
+ if (strncasecmp(Var, "SSL", 3) == 0) {
+ Config_Error(LOG_WARNING,
+ "%s, line %d (section \"Global\"): \"%s\" is deprecated here, move it to %s and rename to \"%s\"!",
+ NGIRCd_ConfFile, Line, Var, section,
+ Var + 3);
+ } else {
+ Config_Error(LOG_WARNING,
+ "%s, line %d (section \"Global\"): \"%s\" is deprecated here, move it to %s!",
+ NGIRCd_ConfFile, Line, Var, section);
+ }
return;
}
Conf_ScrubCTCP = Check_ArgIsTrue(Arg);
return;
}
+#ifdef SYSLOG
+ if (strcasecmp(Var, "SyslogFacility") == 0) {
+ Conf_SyslogFacility = ngt_SyslogFacilityID(Arg,
+ Conf_SyslogFacility);
+ return;
+ }
+#endif
+ if (strcasecmp(Var, "WebircPassword") == 0) {
+ len = strlcpy(Conf_WebircPwd, Arg, sizeof(Conf_WebircPwd));
+ if (len >= sizeof(Conf_WebircPwd))
+ Config_Error_TooLong(Line, Var);
+ return;
+ }
+
+ Config_Error_Section(Line, Var, "Options");
+}
+
#ifdef SSL_SUPPORT
- if (strcasecmp(Var, "SSLCertFile") == 0) {
+
+/**
+ * Handle variable in [SSL] configuration section.
+ *
+ * @param Line Line numer in configuration file.
+ * @param Var Variable name.
+ * @param Arg Variable argument.
+ */
+static void
+Handle_SSL(int Line, char *Var, char *Arg)
+{
+ assert(Line > 0);
+ assert(Var != NULL);
+ assert(Arg != NULL);
+
+ if (strcasecmp(Var, "CertFile") == 0) {
assert(Conf_SSLOptions.CertFile == NULL);
Conf_SSLOptions.CertFile = strdup_warn(Arg);
return;
}
- if (strcasecmp(Var, "SSLDHFile") == 0) {
+ if (strcasecmp(Var, "DHFile") == 0) {
assert(Conf_SSLOptions.DHFile == NULL);
Conf_SSLOptions.DHFile = strdup_warn(Arg);
return;
}
- if (strcasecmp(Var, "SSLKeyFile") == 0) {
+ if (strcasecmp(Var, "KeyFile") == 0) {
assert(Conf_SSLOptions.KeyFile == NULL);
Conf_SSLOptions.KeyFile = strdup_warn(Arg);
return;
}
- if (strcasecmp(Var, "SSLKeyFilePassword") == 0) {
+ if (strcasecmp(Var, "KeyFilePassword") == 0) {
assert(array_bytes(&Conf_SSLOptions.KeyFilePassword) == 0);
if (!array_copys(&Conf_SSLOptions.KeyFilePassword, Arg))
Config_Error(LOG_ERR,
- "%s, line %d (section \"Global\"): Could not copy %s: %s!",
+ "%s, line %d (section \"SSL\"): Could not copy %s: %s!",
NGIRCd_ConfFile, Line, Var,
strerror(errno));
return;
}
- if (strcasecmp(Var, "SSLPorts") == 0) {
+ if (strcasecmp(Var, "Ports") == 0) {
ports_parse(&Conf_SSLOptions.ListenPorts, Line, Arg);
return;
}
-#endif
-#ifdef SYSLOG
- if (strcasecmp(Var, "SyslogFacility") == 0) {
- Conf_SyslogFacility = ngt_SyslogFacilityID(Arg,
- Conf_SyslogFacility);
- return;
- }
-#endif
- if (strcasecmp(Var, "WebircPassword") == 0) {
- len = strlcpy(Conf_WebircPwd, Arg, sizeof(Conf_WebircPwd));
- if (len >= sizeof(Conf_WebircPwd))
- Config_Error_TooLong(Line, Var);
- return;
- }
- Config_Error_Section(Line, Var, "Options");
+ Config_Error_Section(Line, Var, "SSL");
}
+#endif
+
/**
* Handle variable in [Operator] configuration section.
*
#ifdef PAM
if (Conf_ServerPwd[0])
Config_Error(LOG_ERR,
- "This server uses PAM, \"Password\" will be ignored!");
+ "This server uses PAM, \"Password\" in [Global] section will be ignored!");
#endif
#ifdef DEBUG
projects / ngircd.git / commitdiff