]> jfr.im git - solanum.git/blobdiff - doc/reference.conf
doc/reference.conf: add an example TLSv1.3 ciphersuite name
[solanum.git] / doc / reference.conf
index c174abeec8f507375113fd39b89e147f01874cb6..7d2bc2e7f66d7517de47227ea7c82a50f55d7219 100644 (file)
@@ -1,4 +1,4 @@
-/* doc/reference.conf - charybdis Example configuration file
+/* doc/reference.conf - solanum example configuration file
  *
  * Copyright (C) 2000-2002 Hybrid Development Team
  * Copyright (C) 2002-2005 ircd-ratbox development team
@@ -47,9 +47,6 @@
  * Channel mode +-T (blocks notices)                 -- chm_nonotice
  * Channel mode +-O (oper only)                      -- chm_operonly
  * Channel mode +-S (ssl only)                       -- chm_sslonly
- * Emulates channel mode +-O (oper only) (+-iI $o)   -- chm_operonly_compat
- * Emulates channel mode +-R (quiet unreg) (+-q $~a) -- chm_quietunreg_compat
- * Emulates channel mode +-S (ssl only) (+-b $~z)    -- chm_sslonly_compat
  * Channel mode +-M (disallow KICK on IRC ops)       -- chm_operpeace
  * Restrict channel creation to logged in users      -- createauthonly
  * Account bans (+b $a[:mask])                       -- extb_account
@@ -63,7 +60,7 @@
  * Server bans (+b $s:mask)                          -- extb_server
  * SSL bans (+b $z)                                  -- extb_ssl
  * User mode bans (+b $u:modes)                      -- extb_usermode
- * Helpops system (umode +H)                         -- helpops
+ * Helpops system (umode +h)                         -- helpops
  * HURT system                                       -- hurt
  * New host mangling (umode +x)                      -- ip_cloaking_4.0
  * Old host mangling (umode +h)                      -- ip_cloaking
@@ -84,9 +81,6 @@
 #loadmodule "extensions/chm_nonotice";
 #loadmodule "extensions/chm_operonly";
 #loadmodule "extensions/chm_sslonly";
-#loadmodule "extensions/chm_operonly_compat";
-#loadmodule "extensions/chm_quietunreg_compat";
-#loadmodule "extensions/chm_sslonly_compat";
 #loadmodule "extensions/chm_operpeace";
 #loadmodule "extensions/createauthonly";
 #loadmodule "extensions/extb_account";
@@ -162,7 +156,7 @@ serverinfo {
        ssl_dh_params = "etc/dh.pem";
 
        /* ssl_cipher_list: A list of ciphers, dependent on your TLS backend */
-       #ssl_cipher_list = "EECDH+HIGH:EDH+HIGH:HIGH:!aNULL";
+       #ssl_cipher_list = "TLS_CHACHA20_POLY1305_SHA256:EECDH+HIGH:EDH+HIGH:HIGH:!aNULL";
 
        /* ssld_count: number of ssld processes you want to start, if you
         * have a really busy server, using N-1 where N is the number of
@@ -290,14 +284,17 @@ class "server" {
         */
        connectfreq = 5 minutes;
 
-       /* max number: the amount of servers to autoconnect to.  if the number
+       /* max_autoconn: the amount of servers to autoconnect to.  if the number
         * of servers in the class is or exceeds this, no more servers in the
         * class are autoconnected.  oper initiated connects are unaffected.
         * this should usually be set to either 0 or 1.  (autoconnecting from
         * hubs to leaves may cause leaves to function as hubs by having
         * multiple servers connected to them.)
         */
-       max_number = 1;
+       max_autoconn = 1;
+
+       /* max_number: the maximum number of servers allowed in this class */
+       max_number = 100;
 
        /* sendq: servers need a higher sendq as they are sent more data */
        sendq = 2 megabytes;
@@ -395,6 +392,8 @@ auth {
         * need_ssl                   | require SSL/TLS for user in this class
         * need_sasl                  | require SASL id for user in this class
         * extend_chans               | allow this user to join more channels than normal
+        * kline_spoof_ip             | if this block has a spoof host, klines match only
+        *                            | the spoof and not the underlying IP
         */
        flags = kline_exempt, exceed_limit;
 
@@ -428,8 +427,15 @@ privset "local_op" {
         *
         * Available options:
         *
-        * oper:local_kill:      allows local users to be /KILL'd
-        * oper:global_kill:     allows local and remote users to be /KILL'd
+        * oper:general:         enable most general oper privileges that came
+        *                       with +o in older releases
+        * auspex:oper:          allows the oper to see through oper hiding
+        * auspex:umodes:        allows viewing other users' modes
+        * auspex:cmodes:        shows privileged cmodes
+        * auspex:hostname:      shows hidden hostnames/ips
+        * oper:privs:           allows /stats o/O and seeing privset in /whois
+        * oper:testline:        allows /testline and /testgecos
+        * oper:kill:            allows local and remote users to be /KILL'd
         * oper:routing:         allows remote SQUIT and CONNECT
         * oper:kline:           allows KLINE and DLINE
         * oper:unkline:         allows UNKLINE and UNDLINE
@@ -440,19 +446,31 @@ privset "local_op" {
         *                       may (un)load modules and see various
         *                       additional information.
         * oper:hidden_admin:    gives admin privileges except
-        *                       will not have the admin lines in
-        *                       whois.
-        * oper:xline:           allows use of /quote xline/unxline
-        * oper:resv:            allows /quote resv/unresv and cmode +LP
+        *                       will not have the admin lines in
+        *                       whois.
+        * oper:xline:           allows use of /quote xline/unxline
+        * oper:resv:            allows /quote resv/unresv
+        * oper:cmodes:          allows cmode +LP
         * oper:operwall:        allows the oper to send/receive operwalls
-        * oper:spy:             allows 'operspy' features to see through +s
-        *                       channels etc. see /quote help operspy
+        * oper:spy:             allows 'operspy' features to see through +s
+        *                       channels etc. see /quote help operspy
         * oper:hidden:          hides the oper from /stats p
         * oper:remoteban:       allows remote kline etc
-        * oper:mass_notice:     allows sending wallops and mass notices
-        * oper:grant:           allows using the GRANT command
-        */
-       privs = oper:local_kill, oper:operwall;
+        * oper:mass_notice:     allows sending mass notices
+        * oper:wallops:         allows sending wallops messages
+        * oper:grant:           allows using the GRANT command
+        * usermode:servnotice:  allows setting +s
+        *
+        * Privileges provided by extensions include:
+        *
+        * oper:dehelper:        allows the DEHELPER command (from extensions/helpops)
+        * oper:override:        enables oper override via umode +p (from extensions/override)
+        * oper:receive_immunity:
+        *   confers the benefits of chmode +M (operpeace) (from extensions/chm_operpeace)
+        * usermode:helpops      allows setting +h (from extensions/helpops)
+        */
+       privs = oper:general, oper:privs, oper:testline, oper:kill, oper:operwall, usermode:servnotice,
+               auspex:oper, auspex:hostname, auspex:umodes, auspex:cmodes;
 };
 
 privset "server_bot" {
@@ -463,8 +481,9 @@ privset "server_bot" {
 
 privset "global_op" {
        extends = "local_op";
-       privs = oper:global_kill, oper:routing, oper:kline, oper:unkline, oper:xline,
-               oper:resv, oper:mass_notice, oper:remoteban;
+       privs = oper:routing, oper:kline, oper:unkline, oper:xline,
+               oper:resv, oper:cmodes, oper:mass_notice, oper:wallops,
+               oper:remoteban;
 };
 
 privset "admin" {
@@ -557,16 +576,6 @@ connect "irc.uplink.com" {
        /* port: the port to connect to this server on */
        port = 6666;
 
-       /* hub mask: the mask of servers that this server may hub. Multiple
-        * entries are permitted
-        */
-       hub_mask = "*";
-
-       /* leaf mask: the mask of servers this server may not hub.  Multiple
-        * entries are permitted.  Useful for forbidding EU -> US -> EU routes.
-        */
-       #leaf_mask = "*.uk";
-
        /* class: the class this server is in */
        class = "server";
 
@@ -603,17 +612,11 @@ connect "ssl.uplink.com" {
        send_password = "password";
        accept_password = "anotherpassword";
        port = 9999;
-       hub_mask = "*";
        class = "server";
        flags = ssl, topicburst;
 };
 
-/* cluster {}; servers that we propagate things to automatically.
- * NOTE: This does NOT grant them privileges to apply anything locally,
- *       you must add a seperate shared block for that.  Clustering will
- *       only be done for actions by LOCAL opers, that arent directed
- *       remotely.
- */
+/* cluster {}; servers that we propagate things to automatically. */
 cluster {
        /* name: the server to share with, this can be a wildcard and may be
         * stacked.
@@ -646,8 +649,7 @@ cluster {
 
 /* service{}: privileged servers (services). These servers have extra
  * privileges such as setting login names on users and introducing clients
- * with umode +S (unkickable, hide channels, etc). This does not allow them
- * to set bans, you need a separate shared{} for that.
+ * with umode +S (unkickable, hide channels, etc).
  * Do not place normal servers here.
  * There may be only one service{} block.
  */
@@ -656,59 +658,6 @@ service {
        name = "services.int";
 };
 
-/* shared {}: users that are allowed to place remote bans on our server.
- * NOTE: These are ordered top down.  The first one the user@host and server
- *       matches will be used.  Their access will then be decided on that
- *       block and will not fall back to another block that matches.
- */
-shared {
-       /* oper: the user@host and server the user must be on to set klines.
-        * The first field must be a user@host, the second field is an
-        * optional server.  These may be stacked.
-        */
-       /* flags: list of what to allow them to place, all the oper lines
-        * above this (up until another flags entry) will receive these
-        * flags.  This *must* be present.
-        *
-        *    kline   - allow setting perm/temp klines
-        *    tkline  - allow setting temp klines
-        *    unkline - allow removing klines
-        *    xline   - allow setting perm/temp xlines
-        *    txline  - allow setting temp xlines
-        *    unxline - allow removing xlines
-        *    resv    - allow setting perm/temp resvs
-        *    tresv   - allow setting temp resvs
-        *    unresv  - allow removing xlines
-        *    all     - allow oper/server to do all of above.
-        *    locops  - allow locops - only used for servers who cluster
-        *    rehash  - allow rehashing
-        *    dline   - allow setting perm/temp dlines
-        *    tdline  - allow setting temp dlines
-        *    undline - allow removing dlines
-        *    grant   - allow granting operator status
-        *    die     - allow remote DIE/RESTART
-        *    module  - allow remote module commands
-        *    none    - disallow everything
-        */
-
-       /* allow flame@*.leeh.co.uk on server irc.ircd-ratbox.org and
-        * allow leeh@*.leeh.co.uk on server ircd.ircd-ratbox.org to kline
-        */
-       oper = "flame@*.leeh.co.uk", "irc.ircd-ratbox.org";
-       oper = "leeh@*.leeh.co.uk", "ircd.ircd-ratbox.org";
-       flags = kline;
-
-       /* you may forbid certain opers/servers from doing anything */
-       oper = "irc@vanity.oper", "*";
-       oper = "*@*", "irc.vanity.server";
-       oper = "irc@another.vanity.oper", "bigger.vanity.server";
-       flags = none;
-
-       /* or allow everyone to place temp klines */
-       oper = "*@*";
-       flags = tkline;
-};
-
 /* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
 exempt {
        ip = "192.0.2.0/24";
@@ -717,6 +666,12 @@ exempt {
        ip = "127.0.0.1";
 };
 
+/* secure {}: IPs that are considered to be secure networks, and get
+ * +Z without using TLS */
+secure {
+       ip = "127.0.0.1";
+};
+
 /* The channel block contains options pertaining to channels */
 channel {
        /* invex: Enable/disable channel mode +I, a n!u@h list of masks
@@ -835,6 +790,11 @@ channel {
 
        /* strip_topic_colors: whether or not color codes in TOPIC should be stripped. */
        strip_topic_colors = no;
+
+       /* opmod_send_statusmsg: format messages sent to ops due to +z
+        * as PRIVMSG @#channel when sent to clients.
+        */
+       opmod_send_statusmsg = no;
 };
 
 
@@ -931,7 +891,7 @@ blacklist {
        /* IPv4 port to listen on.
         * This should not be the same as any existing listeners.
         */
-       #port_ipv4 = 32000;
+       #port_v4 = 32000;
 
        /* IPv6 address to listen on. This must be a publicly facing IP address
         * to be effective.
@@ -942,7 +902,7 @@ blacklist {
        /* IPv6 port to listen on.
         * This should not be the same as any existing listeners.
         */
-       #port_ipv6 = 32000;
+       #port_v6 = 32000;
 
        /* You can also set the listen_port directive which will set both the
         * IPv4 and IPv6 ports at once.
@@ -1173,17 +1133,16 @@ general {
         */
        dline_with_reason = yes;
 
-       /* kline delay: delay the checking of klines until a specified time.
-        * Useful if large kline lists are applied often to prevent the
-        * server eating CPU.
-        */
-       kline_delay = 0 seconds;
-
        /* kline reason: show the user the reason why they are k/dlined
         * on exit.  may give away who set k/dline when set via tcm.
         */
        kline_with_reason = yes;
 
+       /* tkline duration: when showing users their k/dline reason (see
+        * kline_with_reason), don't add "Temporary K-line 123 min."
+        */
+       hide_tkdline_duration = no;
+
        /* kline reason: make the users quit message on channels this
         * reason instead of the oper's reason.
         */
@@ -1221,9 +1180,6 @@ general {
        /* stats c oper only: make stats c (connect {}) oper only */
        stats_c_oper_only = no;
 
-       /* stats h oper only: make stats h (hub_mask/leaf_mask) oper only */
-       stats_h_oper_only = no;
-
        /* stats y oper only: make stats y (class {}) oper only */
        stats_y_oper_only = no;
 
@@ -1250,6 +1206,13 @@ general {
         */
        stats_k_oper_only = masked;
 
+       /* stats l/L oper only:
+        *     yes:  non-opers can't use this at all
+        *     self: non-opers see only themselves
+        *     no:   show targeted users or non-hidden opers to everyone
+        */
+       stats_l_oper_only = self;
+
        /* map oper only: make /map oper only */
        map_oper_only = no;
 
@@ -1311,6 +1274,12 @@ general {
         */
        max_targets = 4;
 
+       /* post-registration delay: wait this long before processing commands from a newly
+        * registered user. Used to allow network utility bots to perform any actions
+        * (such as host changes or proxy scanning) before the user can join channels.
+        */
+       post_registration_delay = 2 seconds;
+
        /* use_whois_actually: send clients requesting a whois a numeric
         * giving the real IP of non-spoofed clients to prevent DNS abuse.
         */
@@ -1318,7 +1287,7 @@ general {
 
        /* usermodes configurable: a list of usermodes for the options below
         *
-        * +g - callerid   - Server Side Ignore
+        * +g - callerid   - Server-side private message allow list
         * +D - deaf       - Don't see channel messages
         * +i - invisible  - Not shown in NAMES or WHO unless you share a
         *                   a channel
@@ -1429,6 +1398,15 @@ general {
 
        /* hide_opers_in_whois: if set to YES, then oper status will be hidden in /WHOIS output. */
        hide_opers_in_whois = no;
+
+       /* tls_ciphers_oper_only: show the TLS cipher string in /WHOIS only to opers and self */
+       tls_ciphers_oper_only = no;
+
+       /* hidden_caps: client capabilities we'll pretend we don't support until they're requested */
+       #hidden_caps = "userhost-in-names";
+
+       /* oper_secure_only: require TLS on any connection trying to oper up */
+       oper_secure_only = no;
 };
 
 modules {