]> jfr.im git - irc/rqf/shadowircd.git/blobdiff - doc/reference.conf
BOPM/TCM do not need the ability to global kill, so remove it from server_bot
[irc/rqf/shadowircd.git] / doc / reference.conf
index 7b359789dd4c8f0b9a17e2f00be31bcf3602c25c..716d4f59b8074f07d9875c70ca064b361d1de665 100755 (executable)
@@ -18,6 +18,9 @@
  * that matches a user will be used.  So place spoofs first, then specials,
  * then general access, then restricted.
  *
+ * privset {} blocks MUST be specified before anything that uses them.  That
+ * means they must be defined before operator {}.
+ *
  * Both shell style (#) and C style comments are supported.
  *
  * Files may be included by either:
  * Charybdis contains several extensions that are not enabled by default.
  * To use them, uncomment the lines below.
  *
- * Restrict channel creation to logged in users   -- createauthonly.so
- * Account bans (+b $a[:mask])                    -- extb_account.so
- * Banned from another channel (+b $j:mask)       -- extb_canjoin.so
- * Other-channel bans (+b $c:mask)                -- extb_channel.so
- * Extended ban (+b $x:mask)                      -- extb_extgecos.so
- * Oper bans (+b $o)                              -- extb_oper.so
- * Realname (gecos) bans (+b $r:mask)             -- extb_realname.so
- * Server bans (+b $s:mask)                       -- extb_server.so
- * HURT system                                    -- hurt.so
- * Host mangling (umode +h)                       -- ip_cloaking.so
- * Find channel forwards                          -- m_findforwards.so
- * /identify support                              -- m_identify.so
- * Opers cannot be invisible (umode +i)           -- no_oper_invis.so
- * Far connection notices (snomask +F)            -- sno_farconnect.so
- * Remote k/d/g/x line active notices             -- sno_globalkline.so
- * Remote oper up notices                         -- sno_globaloper.so
- * /whois notifications (snomask +W)              -- sno_whois.so
+ * Channel mode +-A (admin only)                     -- chm_adminonly.so
+ * Channel mode +-O (oper only)                      -- chm_operonly.so
+ * Channel mode +-S (ssl only)                       -- chm_sslonly.so
+ * Emulates channel mode +-O (oper only) (+-iI $o)   -- chm_operonly_compat.so
+ * Emulates channel mode +-R (quiet unreg) (+-q $~a) -- chm_quietunreg_compat.so
+ * Emulates channel mode +-S (ssl only) (+-b $~z)    -- chm_sslonly_compat.so
+ * Restrict channel creation to logged in users      -- createauthonly.so
+ * Account bans (+b $a[:mask])                       -- extb_account.so
+ * Banned from another channel (+b $j:mask)          -- extb_canjoin.so
+ * Other-channel bans (+b $c:mask)                   -- extb_channel.so
+ * Extended ban (+b $x:mask)                         -- extb_extgecos.so
+ * Oper bans (+b $o)                                 -- extb_oper.so
+ * Realname (gecos) bans (+b $r:mask)                -- extb_realname.so
+ * Server bans (+b $s:mask)                          -- extb_server.so
+ * SSL bans (+b $z)                                  -- extb_ssl.so
+ * HURT system                                       -- hurt.so
+ * Host mangling (umode +h)                          -- ip_cloaking.so
+ * Find channel forwards                             -- m_findforwards.so
+ * /identify support                                 -- m_identify.so
+ * Opers cannot be invisible (umode +i)              -- no_oper_invis.so
+ * Far connection notices (snomask +F)               -- sno_farconnect.so
+ * Remote k/d/x line active notices                  -- sno_globalkline.so
+ * Remote oper up notices                            -- sno_globaloper.so
+ * /whois notifications (snomask +W)                 -- sno_whois.so
  */
+#loadmodule "extensions/chm_adminonly.so";
+#loadmodule "extensions/chm_operonly.so";
+#loadmodule "extensions/chm_sslonly.so";
+#loadmodule "extensions/chm_operonly_compat.so";
+#loadmodule "extensions/chm_quietunreg_compat.so";
+#loadmodule "extensions/chm_sslonly_compat.so";
 #loadmodule "extensions/createauthonly.so";
 #loadmodule "extensions/extb_account.so";
 #loadmodule "extensions/extb_canjoin.so";
@@ -67,6 +83,7 @@
 #loadmodule "extensions/extb_oper.so";
 #loadmodule "extensions/extb_realname.so";
 #loadmodule "extensions/extb_server.so";
+#loadmodule "extensions/extb_ssl.so";
 #loadmodule "extensions/hurt.so";
 #loadmodule "extensions/ip_cloaking.so";
 #loadmodule "extensions/m_findforwards.so";
@@ -115,13 +132,27 @@ serverinfo {
         * This should be an ipv6 IP only.
         */
        #vhost6 = "3ffe:80e8:546::2";
+       
+       /* ssl_private_key: our ssl private key */
+       ssl_private_key = "etc/test.key";
+
+       /* ssl_cert: certificate for our ssl server */
+       ssl_cert = "etc/test.cert";
+
+       /* ssl_dh_params: DH parameters, generate with openssl dhparam -out dh.pem 1024 */
+       ssl_dh_params = "etc/dh.pem";
+
+       /* 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 cpu/cpu cores you have might be useful
+        */
+       ssld_count = 1;
 
-       /* max_clients: this should be set to the maximum amount of clients
-        * that the server should support. Note that you should leave some
-        * file descriptors free for log files, server connections, ident
-        * lookups (if enabled), exceed_limit clients, etc.
+       /* default max clients: the default maximum number of clients
+        * allowed to connect.  This can be changed once ircd has started by
+        * issuing:
+        *   /quote set maxclients <limit>
         */
-       max_clients = 1024;
+       default_max_clients = 1024;
 };
 
 /* admin {}: contains admin information about the server. (OLD A:) */
@@ -142,7 +173,6 @@ log {
         * - operlog:    /oper usage
         * - foperlog:   failed /oper usage
         * - serverlog:  server connects/disconnects
-        * - glinelog:   glines
         * - klinelog:   klines, etc
         * - killlog:    kills
         * - operspylog: operspy usage
@@ -153,7 +183,6 @@ log {
        fname_operlog = "logs/operlog";
        #fname_foperlog = "logs/foperlog";
        fname_serverlog = "logs/serverlog";
-       fname_glinelog = "logs/glinelog";
        #fname_klinelog = "logs/klinelog";
        fname_killlog = "logs/killlog";
        fname_operspylog = "logs/operspylog";
@@ -184,19 +213,19 @@ class "users" {
          */
         number_per_ip_global = 5;
 
-       /* cidr_bitlen:  Limits numbers of connections from a subnet size
+       /* cidr_ipv4_bitlen:  Limits numbers of connections from a subnet size
+        */
+       cidr_ipv4_bitlen = 24;
+
+       /* cidr_ipv6_bitlen:  Limits numbers of connections from a subnet size
         * the following example makes the subnet /64 this is useful
         * for IPv6 connections in particular
-        * Also note that the way charybdis is written if you have
-        * compiled support for IPv6, IPv4 cidr bitlens need to be modified
-        * Basically to get the approriate length add 96 to the IPv4 length
-        * For example for a /24 do 96+24 = 120
-        *
         */
-       cidr_bitlen = 64;
+       cidr_ipv6_bitlen = 64;
 
        /* number_per_cidr:  Number of connections to allow from a subnet of the 
-        * size given in cidr_bitlen.  4 seems to be a good default to me.
+        * size given in cidr_ipv4_bitlen/cidr_ipv6_bitlen.
+        * 4 seems to be a good default to me.
         */
        number_per_cidr = 4;
 
@@ -243,20 +272,28 @@ listen {
        /* port: the specific port to listen on.  if no host is specified
         * before, it will listen on all available IPs.
         *
+        * sslport: the specific port to listen ssl connections on. if no 
+        * host is specified before, it will listen on all available IPs.
+        *
         * ports are seperated via a comma, a range may be specified using ".."
         */
        
        /* port: listen on all available IPs, ports 5000 and 6665 to 6669 */
        port = 5000, 6665 .. 6669;
+       
+       /* sslport: listen for ssl connections on all available IPs, port 9999 */
+       sslport = 9999;
 
        /* host: set a specific IP/host the ports after the line will listen 
         * on.  This may be ipv4 or ipv6.
         */
        host = "1.2.3.4";
        port = 7000, 7001;
+       sslport = 9000, 9001;
 
        host = "3ffe:1234:a:b:c::d";
         port = 7002;
+        sslport = 9002;
 };
 
 /* auth {}: allow users to connect to the ircd (OLD I:) */
@@ -289,7 +326,6 @@ auth {
         * exceed_limit (old > flag)  | allow user to exceed class user limits
         * kline_exempt (old ^ flag)  | exempt this user from k/g/xlines&dnsbls
         * dnsbl_exempt               | exempt this user from dnsbls
-        * gline_exempt (old _ flag)  | exempt this user from glines
         * spambot_exempt             | exempt this user from spambot checks
         * shide_exempt               | exempt this user from serverhiding
         * jupe_exempt                | exempt this user from generating
@@ -299,6 +335,7 @@ auth {
          *                                     USE WITH CAUTION.
         * no_tilde     (old - flag)  | don't prefix ~ to username if no ident
         * need_ident   (old + flag)  | require ident for user in this class
+        * need_ssl                   | require SSL/TLS for user in this class
         * need_sasl                  | require SASL id for user in this class
         */
        flags = kline_exempt, exceed_limit;
@@ -328,10 +365,57 @@ auth {
        flags = need_ident;
 };
 
-/* operator {}: defines ircd operators. (OLD O:)
- * charybdis no longer supports local operators, privileges are
- * controlled via flags.
- */
+/* privset{}: defines operator privilege sets. */
+privset "local_op" {
+       /* privs: controls the activities and commands an oper is
+        * allowed to do on the server
+        *
+        * 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:routing:         allows remote SQUIT and CONNECT
+        * oper:kline:           allows KLINE and DLINE
+        * oper:unkline:         allows UNKLINE and UNDLINE
+        * snomask:nick_changes: allows oper to see nickchanges via snomask +n
+        * oper:rehash:          allows oper to REHASH config
+        * oper:die:             allows DIE and RESTART
+        * oper:admin:           gives admin privileges.  admins
+        *                       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
+        * 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:hidden:          hides the oper from /stats p
+        * oper:remoteban:       allows remote kline etc
+        * oper:mass_notice:     allows sending wallops and mass notices
+        */
+       privs = oper:local_kill, oper:operwall;
+};
+
+privset "server_bot" {
+       /* extends: a privset to inherit in this privset */
+       extends = "local_op";
+       privs = oper:kline, oper:remoteban, snomask:nick_changes;
+};
+
+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;
+};
+
+privset "admin" {
+       extends = "global_op";
+       privs = oper:admin, oper:die, oper:rehash, oper:spy;
+};
+
+/* operator {}: defines ircd operators. (OLD O:) */
 operator "god" {
        /* name: the name of the oper must go above */
 
@@ -365,42 +449,20 @@ operator "god" {
         */
        snomask = "+Zbfkrsuy";
 
-       /* privileges: controls the activities and commands an oper is
-        * allowed to do on the server.  You may prefix an option with ~ to
-        * disable it, ie ~operwall
+       /* flags: misc options for the operator.  You may prefix an option
+        * with ~ to disable it, e.g. ~encrypted.
         *
-        * Default flags are operwall, remoteban and encrypted.
+        * Default flags are encrypted.
         *
         * Available options:
         *
         * encrypted:    the password above is encrypted [DEFAULT]
-        * local_kill:   allows local users to be /KILL'd
-        * global_kill:  allows local and remote users to be 
-        *               /KILL'd                           (OLD 'O' flag)
-        * remote:       allows remote SQUIT and CONNECT   (OLD 'R' flag)
-        * kline:        allows KLINE and DLINE            (OLD 'K' flag)
-        * unkline:      allows UNKLINE and UNDLINE        (OLD 'U' flag)
-        * gline:        allows GLINE                      (OLD 'G' flag)
-        * nick_changes: allows oper to see nickchanges    (OLD 'N' flag)
-        *               via snomask +n
-        * rehash:       allows oper to REHASH config      (OLD 'H' flag)
-        * die:          allows DIE and RESTART            (OLD 'D' flag)
-        * admin:        gives admin privileges.  admins
-        *               may (un)load modules and see the
-        *               real IPs of servers.
-        * hidden_admin: gives admin privileges except
-        *               will not have the admin lines in
-        *               stats p and whois.
-        * xline:        allows use of /quote xline/unxline
-        * resv:         allows /quote resv/unresv and cmode +LP [DEFAULT]
-        * operwall:     allows the oper to send/receive operwalls [DEFAULT]
-        * oper_spy:     allows 'operspy' features to see through +s
-        *               channels etc. see /quote help operspy
-        * hidden_oper:  hides the oper from /stats p    (OLD UMODE +p) 
-        * remoteban:    allows remote kline etc [DEFAULT]
+        * need_ssl:     must be using SSL/TLS to oper up
          */
-       flags = global_kill, remote, kline, unkline, gline,
-               die, rehash, admin, xline, operwall;
+       flags = encrypted;
+
+       /* privset: privileges set to grant */
+       privset = "admin";
 };
 
 /* connect {}: controls servers we connect to (OLD C:, N:, H:, L:) */
@@ -444,6 +506,7 @@ connect "irc.uplink.com" {
         * autoconn     - automatically connect to this server
         * compressed   - compress traffic via ziplinks
         * topicburst   - burst topics between servers
+        * ssl          - ssl/tls encrypted server connections
         */
        flags = compressed, topicburst;
 };
@@ -465,6 +528,19 @@ connect "ipv6.some.server" {
         class = "server";
 };
 
+connect "ssl.uplink.com" {
+       /* Example of ssl server-to-server connection, ssl flag doesn't need
+        * compressed flag, 'cause it uses own compression
+        */
+       host = "192.168.0.1";
+       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
@@ -539,6 +615,9 @@ shared {
         *    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
         *    none    - disallow everything
         */
 
@@ -764,11 +843,13 @@ alias "MS" {
  */
 general {
        /* hide error messages: defines whether error messages from
-        * servers are hidden or not.  These can sometimes contain IPs and
-        * can have an adverse effect on server ip hiding.  Set to:
+        * servers that are not deemed fully safe are hidden or not.
+        * These can sometimes contain IPs and can have an adverse
+        * effect on server ip hiding.  Set to:
         *   yes:   hide from opers and admin
         *   opers: hide from opers only
         *   no:    do not hide error messages
+        * Admins on other servers count as opers.
         */
        hide_error_messages = opers;
 
@@ -833,12 +914,6 @@ general {
         */
        dots_in_ident=2;
 
-       /* dot in ipv6: ircd-hybrid-6.0 and earlier will disallow hosts 
-        * without a '.' in them.  this will add one to the end.  only needed
-        * for older servers.
-        */
-        dot_in_ip6_addr = no;
-        
         /* min nonwildcard: the minimum non wildcard characters in k/d/g lines
         * placed via the server.  klines hand placed are exempt from limits.
         * wildcard chars: '.' '*' '?' '@'
@@ -906,7 +981,7 @@ general {
         */
        kline_delay = 0 seconds;
 
-       /* kline reason: show the user the reason why they are k/d/glined 
+       /* 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;
@@ -1018,22 +1093,6 @@ general {
        /* no oper flood: increase flood limits for opers. */
        no_oper_flood = yes;
 
-       /* glines: enable glines, network wide temp klines */
-       glines = no;
-
-       /* gline time: the amount of time a gline will remain before expiring */
-       gline_time = 1 day;
-
-       /* gline_min_cidr: If using a CIDR gline, the minimum length the
-        * mask must be
-        */
-       gline_min_cidr = 16;
-
-       /* idletime: the maximum amount of time a user may idle before
-        * they are disconnected
-        */
-        idletime = 0;
-
        /* REMOVE ME.  The following line checks you've been reading. */
        havent_read_conf = yes;
        
@@ -1076,13 +1135,6 @@ general {
         * provided they have umode +s set */
        oper_snomask = "+s";
 
-       /* servlink path: path to 'servlink' program used by ircd to handle
-        * encrypted/compressed server <-> server links.
-        *
-        * only define if servlink is not in same directory as ircd itself.
-        */
-       #servlink_path = "/usr/local/ircd/bin/servlink";
-
        /* use egd: if your system does not have *random devices yet you
         * want to use OpenSSL and encrypted links, enable this.  Beware -
         * EGD is *very* CPU intensive when gathering data for its pool
@@ -1129,10 +1181,14 @@ general {
        /* reject duration: the amount of time to cache the rejection */
        reject_duration = 5 minutes;
 
-       /* max_unknown_ip: maximum number of pending connections to the server
-         * that are allowed per IP address
+       /* throttle_duration: Amount of time that throttling will be applied to an IP
+        * address.
         */
-       max_unknown_ip = 2;
+       throttle_duration = 60;
+
+       /* throttle_count: Number of connections within throttle_duration that it takes
+        * for throttling to take effect */
+       throttle_count = 4;
 };
 
 modules {