]> jfr.im git - solanum.git/blobdiff - doc/reference.conf
Add hide_tkdline_duration to documentation .confs
[solanum.git] / doc / reference.conf
index 5c9bd0b58364bd98356e0331a75d7f5d657141cf..592380af04f32550fd817842403f59233b456a69 100644 (file)
  *
  * Times/durations are written as:
  *        12 hours 30 minutes 1 second
- *        
+ *
  * Valid units of time:
  *        month, week, day, hour, minute, second
  *
  * Valid units of size:
  *        megabyte/mbyte/mb, kilobyte/kbyte/kb, byte
  *
- * Sizes and times may be singular or plural.  
- */ 
+ * Sizes and times may be singular or plural.
+ */
 
 /* Extensions:
  *
@@ -44,6 +44,7 @@
  * To use them, uncomment the lines below.
  *
  * Channel mode +-A (admin only)                     -- chm_adminonly
+ * 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
@@ -61,6 +62,7 @@
  * Realname (gecos) bans (+b $r:mask)                -- extb_realname
  * 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
  * HURT system                                       -- hurt
  * New host mangling (umode +x)                      -- ip_cloaking_4.0
@@ -68,6 +70,7 @@
  * Dynamically extend channel limits                 -- m_extendchans
  * Find channel forwards                             -- m_findforwards
  * /identify support                                 -- m_identify
+ * /locops support                                   -- m_locops
  * Opers cannot be invisible (umode +i)              -- no_oper_invis
  * Far connection notices (snomask +F)               -- sno_farconnect
  * Remote k/d/x line active notices                  -- sno_globalkline
@@ -78,6 +81,7 @@
  * Stop services kills                               -- no_kill_services
  */
 #loadmodule "extensions/chm_adminonly";
+#loadmodule "extensions/chm_nonotice";
 #loadmodule "extensions/chm_operonly";
 #loadmodule "extensions/chm_sslonly";
 #loadmodule "extensions/chm_operonly_compat";
@@ -95,6 +99,7 @@
 #loadmodule "extensions/extb_realname";
 #loadmodule "extensions/extb_server";
 #loadmodule "extensions/extb_ssl";
+#loadmodule "extensions/extb_usermode";
 #loadmodule "extensions/helpops";
 #loadmodule "extensions/hurt";
 #loadmodule "extensions/ip_cloaking_4.0";
 #loadmodule "extensions/m_extendchans";
 #loadmodule "extensions/m_findforwards";
 #loadmodule "extensions/m_identify";
+#loadmodule "extensions/m_locops";
 #loadmodule "extensions/no_oper_invis";
 #loadmodule "extensions/sno_farconnect";
 #loadmodule "extensions/sno_globalkline";
@@ -142,15 +148,17 @@ serverinfo {
        /* vhost6: the IP to bind to when we connect outward to ipv6 servers.
         * This should be an ipv6 IP only.
         */
-       #vhost6 = "2001:db7:2::6";
-       
-       /* ssl_private_key: our ssl private key */
-       ssl_private_key = "etc/ssl.key";
+       #vhost6 = "2001:db8:2::6";
 
-       /* ssl_cert: certificate for our ssl server */
+       /* ssl_cert: certificate (and optionally key) for our ssl server */
        ssl_cert = "etc/ssl.pem";
 
-       /* ssl_dh_params: DH parameters, generate with openssl dhparam -out dh.pem 1024 */
+       /* ssl_private_key: our ssl private key (if not contained in ssl_cert file) */
+       #ssl_private_key = "etc/ssl.key";
+
+       /* ssl_dh_params: DH parameters, generate with openssl dhparam -out dh.pem 2048 */
+       /* If you do not provide parameters, some TLS backends will fail on DHE- ciphers,
+          and some will succeed but use weak, common DH groups! */
        ssl_dh_params = "etc/dh.pem";
 
        /* ssl_cipher_list: A list of ciphers, dependent on your TLS backend */
@@ -245,7 +253,7 @@ class "users" {
         */
        cidr_ipv6_bitlen = 64;
 
-       /* number_per_cidr:  Number of connections to allow from a subnet of the 
+       /* number_per_cidr:  Number of connections to allow from a subnet of the
         * size given in cidr_ipv4_bitlen/cidr_ipv6_bitlen.
         * 4 seems to be a good default to me.
         */
@@ -292,7 +300,7 @@ class "server" {
        max_number = 1;
 
        /* sendq: servers need a higher sendq as they are sent more data */
-       sendq=2 megabytes;
+       sendq = 2 megabytes;
 };
 
 /* listen {}: contain information about the ports ircd listens on (OLD P:) */
@@ -307,19 +315,19 @@ 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 
+        * 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 
+       /* sslport: listen for ssl connections on all available IPs, port 6697 */
+       sslport = 6697;
+
+       /* host: set a specific IP/host the ports after the line will listen
         * on.  This may be ipv4 or ipv6.
         */
        host = "192.0.2.6";
@@ -329,6 +337,12 @@ listen {
        host = "2001:db8:2::6";
        port = 7002;
        sslport = 9002;
+
+       /* wsock: listeners defined with this option enabled will be websocket listeners,
+        * and will not accept normal clients.
+        */
+       wsock = yes;
+       sslport = 9999;
 };
 
 /* auth {}: allow users to connect to the ircd (OLD I:) */
@@ -353,7 +367,7 @@ auth {
         * flags = ...; below if it is.
         */
        password = "letmein";
-       
+
        /* spoof: fake the users user@host to be be this.  You may either
         * specify a host or a user@host to spoof to.  This is free-form,
         * just do everyone a favour and dont abuse it. (OLD I: = flag)
@@ -361,12 +375,14 @@ auth {
        spoof = "I.still.hate.packets";
 
        /* Possible flags in auth:
-        * 
+        *
         * encrypted                  | password is encrypted with mkpasswd
         * spoof_notice               | give a notice when spoofing hosts
         * exceed_limit (old > flag)  | allow user to exceed class user limits
-        * kline_exempt (old ^ flag)  | exempt this user from k/g/xlines&dnsbls
+        * kline_exempt (old ^ flag)  | exempt this user from k/g/xlines,
+        *                            | dnsbls, and proxies
         * dnsbl_exempt               | exempt this user from dnsbls
+        * proxy_exempt               | exempt this user from proxies
         * spambot_exempt             | exempt this user from spambot checks
         * shide_exempt               | exempt this user from serverhiding
         * jupe_exempt                | exempt this user from generating
@@ -381,7 +397,7 @@ auth {
         * extend_chans               | allow this user to join more channels than normal
         */
        flags = kline_exempt, exceed_limit;
-       
+
        /* class: the class the user is placed in */
        class = "opers";
 };
@@ -393,7 +409,7 @@ auth {
         */
        redirserv = "irc.example.net";
        redirport = 6667;
-       
+
        user = "*.example.com";
 
        /* class: a class is required even though it is not used */
@@ -468,13 +484,13 @@ operator "god" {
        user = "*@127.0.0.1";
 
        /* password: the password required to oper.  Unless ~encrypted is
-        * contained in flags = ...; this will need to be encrypted using 
+        * contained in flags = ...; this will need to be encrypted using
         * mkpasswd, MD5 is supported
         */
        password = "etcnjl8juSU1E";
 
        /* rsa key: the public key for this oper when using Challenge.
-        * A password should not be defined when this is used, see 
+        * A password should not be defined when this is used, see
         * doc/challenge.txt for more information.
         */
        #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
@@ -532,9 +548,9 @@ connect "irc.uplink.com" {
        send_password = "password";
        accept_password = "anotherpassword";
 
-       /* fingerprint: if specified, the server's client certificate
-        * fingerprint will be checked against the specified fingerprint
-        * below.
+       /* fingerprint: if flags = ssl is specified, the server's
+        * certificate fingerprint will be checked against the fingerprint
+        * specified below. required if using flags = ssl.
         */
        #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
 
@@ -560,22 +576,20 @@ connect "irc.uplink.com" {
         * compressed   - compress traffic via ziplinks
         * topicburst   - burst topics between servers
         * ssl          - ssl/tls encrypted server connections
+        * no-export    - marks the link as a no-export link (not exported to other links)
         */
        flags = compressed, topicburst;
 };
 
 connect "ipv6.lame.server" {
-       /* Hosts that are IPv6 addresses must be in :: shortened form
-        * if applicable.  Addresses starting with a colon get an extra
-        * zero prepended, for example: 0::1
-        */
+       host = "192.0.2.1";
        host = "2001:db8:3::8";
        send_password = "password";
        accept_password = "password";
        port = 6666;
 
-       /* aftype: controls whether the connection uses "ipv4" or "ipv6".
-        * Default is ipv4.
+       /* aftype: controls whether the outgoing connection uses "ipv4" or "ipv6".
+        * Default is to try either at random.
         */
        aftype = ipv6;
        class = "server";
@@ -763,7 +777,7 @@ channel {
        default_split_user_count = 0;
 
        /* split servers: when the amount of servers that have acknowledged
-        * theyve finished bursting is lower than this, consider ourselves 
+        * theyve finished bursting is lower than this, consider ourselves
         * split.  this must be set for automatic splitmode
         */
        default_split_server_count = 0;
@@ -852,8 +866,7 @@ serverhide {
  * You can have multiple combinations of host and rejection reasons.
  * They are used in pairs of one host/rejection reason.
  *
- * These settings should be adequate for most networks, and are (presently)
- * required for use on StaticBox.
+ * These settings should be adequate for most networks.
  *
  * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
  * connections.
@@ -878,7 +891,7 @@ serverhide {
  * to match the final octet (e.g. 127.0.0.1) or "127.x.y.z" to explicitly match
  * an A record. The blacklist is only applied if it matches anything in the
  * list. You may freely mix full IP's and final octets.
- * 
+ *
  * Consult your blacklist provider for the meaning of these parameters; they
  * are usually used to denote different ban types.
  */
@@ -894,6 +907,78 @@ blacklist {
 #      reject_reason = "${nick}, your IP (${ip}) is listed in ${dnsbl-host} for some reason. In order to protect ${network-name} from abuse, we are not allowing connections listed in ${dnsbl-host} to connect";
 };
 
+/* These are the OPM settings.
+ * This is similar to the functionality provided by BOPM. It will scan incoming
+ * connections for open proxies by connecting to clients and attempting several
+ * different open proxy handshakes. If they connect back to us (via a dedicated
+ * listening port), and send back the data we send them, they are considered
+ * an open proxy. For politeness reasons (users may be confused by the incoming
+ * connection attempts if they are logging incoming connections), the user is
+ * notified upon connect if they are being scanned.
+ *
+ * WARNING:
+ * These settings are considered experimental. Only the most common proxy types
+ * are checked for (Charybdis is immune from POST and GET proxies). If you are
+ * not comfortable with experimental code, do not use this feature.
+ */
+#opm {
+       /* IPv4 address to listen on. This must be a publicly facing IP address
+        * to be effective.
+        * If omitted, it defaults to serverinfo::vhost.
+        */
+       #listen_ipv4 = "127.0.0.1";
+
+       /* IPv4 port to listen on.
+        * This should not be the same as any existing listeners.
+        */
+       #port_v4 = 32000;
+
+       /* IPv6 address to listen on. This must be a publicly facing IP address
+        * to be effective.
+        * If omitted, it defaults to serverinfo::vhost6.
+        */
+       #listen_ipv6 = "::1";
+
+       /* IPv6 port to listen on.
+        * This should not be the same as any existing listeners.
+        */
+       #port_v6 = 32000;
+
+       /* You can also set the listen_port directive which will set both the
+        * IPv4 and IPv6 ports at once.
+        */
+       #listen_port = 32000;
+
+       /* This sets the timeout in seconds before ending open proxy scans.
+        * Values less than 1 or greater than 60 are ignored.
+        * It is advisable to keep it as short as feasible, so clients do not
+        * get held up by excessively long scan times.
+        */
+       #timeout = 5;
+
+       /* These are the ports to scan for SOCKS4 proxies on. They may overlap
+        * with other scan types. Sensible defaults are given below.
+        */
+       #socks4_ports = 80, 443, 1080, 8000, 8080, 10800;
+
+       /* These are the ports to scan for SOCKS5 proxies on. They may overlap
+        * with other scan types. Sensible defaults are given below.
+        */
+       #socks5_ports = 80, 443, 1080, 8000, 8080, 10800;
+
+       /* These are the ports to scan for HTTP CONNECT proxies on (plaintext).
+        * They may overlap with other scan types. Sensible defaults are given
+        * below.
+        */
+       #httpconnect_ports = 80, 8080, 8000;
+
+       /* These are the ports to scan for HTTPS CONNECT proxies on (SSL).
+        * They may overlap with other scan types. Sensible defaults are given
+        * below.
+        */
+       #httpsconnect_ports = 443, 4443;
+#};
+
 /*
  * Alias blocks allow you to define custom commands. (Old m_sshortcut.c)
  * They send PRIVMSG to the given target. A real command takes
@@ -1010,7 +1095,7 @@ general {
         */
        default_floodcount = 10;
 
-       /* failed oper notice: send a notice to all opers on the server when 
+       /* failed oper notice: send a notice to all opers on the server when
         * someone tries to OPER and uses the wrong password, host or ident.
         */
        failed_oper_notice = yes;
@@ -1018,7 +1103,7 @@ general {
        /* dots in ident: the amount of '.' characters permitted in an ident
         * reply before the user is rejected.
         */
-       dots_in_ident=2;
+       dots_in_ident = 2;
 
        /* min nonwildcard: the minimum non wildcard characters in k/d/g lines
         * placed via the server.  klines hand placed are exempt from limits.
@@ -1082,23 +1167,22 @@ general {
         * displayed unconditionally.
         */
        global_snotices = yes;
-       
-       /* dline reason: show the user the dline reason when they connect 
+
+       /* dline reason: show the user the dline reason when they connect
         * and are dlined.
         */
        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 
+       /* 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.
         */
@@ -1116,7 +1200,7 @@ general {
        non_redundant_klines = yes;
 
        /* warn no nline: warn opers about servers that try to connect but
-        * we dont have a connect {} block for.  Twits with misconfigured 
+        * we dont have a connect {} block for.  Twits with misconfigured
         * servers can get really annoying with this enabled.
         */
        warn_no_nline = yes;
@@ -1134,36 +1218,36 @@ general {
        stats_e_disabled = no;
 
        /* stats c oper only: make stats c (connect {}) oper only */
-       stats_c_oper_only=no;
+       stats_c_oper_only = no;
 
        /* stats h oper only: make stats h (hub_mask/leaf_mask) oper only */
-       stats_h_oper_only=no;
+       stats_h_oper_only = no;
 
        /* stats y oper only: make stats y (class {}) oper only */
-       stats_y_oper_only=no;
+       stats_y_oper_only = no;
 
        /* stats o oper only: make stats o (opers) oper only */
-       stats_o_oper_only=yes;
+       stats_o_oper_only = yes;
 
        /* stats P oper only: make stats P (ports) oper only
-        * NOTE: users doing stats P will never be given the ips that the 
+        * NOTE: users doing stats P will never be given the ips that the
         * server listens on, simply the ports.
         */
-       stats_P_oper_only=no;
+       stats_P_oper_only = no;
 
        /* stats i oper only: make stats i (auth {}) oper only. set to:
         *     yes:    show users no auth blocks, made oper only.
         *     masked: show users first matching auth block
         *     no:     show users all auth blocks.
         */
-       stats_i_oper_only=masked;
+       stats_i_oper_only = masked;
 
        /* stats k/K oper only: make stats k/K (klines) oper only.  set to:
         *     yes:    show users no auth blocks, made oper only
         *     masked: show users first matching auth block
         *     no:     show users all auth blocks.
         */
-       stats_k_oper_only=masked;
+       stats_k_oper_only = masked;
 
        /* map oper only: make /map oper only */
        map_oper_only = no;
@@ -1220,8 +1304,8 @@ general {
 
        /* REMOVE ME.  The following line checks you've been reading. */
        havent_read_conf = yes;
-       
-       /* max targets: the maximum amount of targets in a single 
+
+       /* max targets: the maximum amount of targets in a single
         * PRIVMSG/NOTICE.  set to 999 NOT 0 for unlimited.
         */
        max_targets = 4;
@@ -1235,7 +1319,7 @@ general {
         *
         * +g - callerid   - Server Side Ignore
         * +D - deaf       - Don't see channel messages
-        * +i - invisible  - Not shown in NAMES or WHO unless you share a 
+        * +i - invisible  - Not shown in NAMES or WHO unless you share a
         *                   a channel
         * +l - locops     - See LOCOPS messages
         * +Q - noforward  - Unaffected by channel forwarding
@@ -1244,7 +1328,7 @@ general {
         * +w - wallop     - See oper and server generated WALLOPS
         * +z - operwall   - See operwalls
         */
-        
+
        /* oper only umodes: usermodes only opers may set */
        oper_only_umodes = operwall, locops, servnotice;
 
@@ -1256,7 +1340,7 @@ general {
        oper_snomask = "+s";
 
        /* compression level: level of compression for compressed links between
-        * servers.  
+        * servers.
         *
         * values are between: 1 (least compression, fastest)
         *                and: 9 (most compression, slowest).
@@ -1327,17 +1411,27 @@ general {
        away_interval = 30;
 
        /* certfp_method: the method that should be used for computing certificate fingerprints.
-        * Acceptable options are sha1, sha256 and sha512.  Networks running versions of charybdis
-        * prior to charybdis 3.5 MUST use sha1 for certfp_method.
+        * Acceptable options are sha1, sha256, spki_sha256, sha512 and spki_sha512.  Networks
+        * running versions of charybdis prior to charybdis 3.5 MUST use sha1 for certfp_method.
+        *
+        * The spki_* variants operate on the SubjectPublicKeyInfo of the certificate, which does
+        * not change unless the private key is changed.  This allows the fingerprint to stay
+        * constant even if the certificate is reissued.  These fingerprints will be prefixed with
+        * "SPKI:SHA2-256:" or "SPKI:SHA2-512:" depending on the hash type.  These fingerprints
+        * are not supported on servers running charybdis 3.5.3 or earlier.
+        *
+        * To generate a fingerprint from a certificate file, please use the mkfingerprint utility
+        * program located in the bin/ subdirectory of your IRCd installation. Running it with no
+        * arguments will give you a brief usage message; it takes method and filename arguments.
         */
-       certfp_method = sha1;
+       certfp_method = spki_sha256;
 
        /* hide_opers_in_whois: if set to YES, then oper status will be hidden in /WHOIS output. */
        hide_opers_in_whois = no;
 };
 
 modules {
-       /* module path: paths to search for modules specified below and 
+       /* module path: paths to search for modules specified below and
         * in /modload.
         */
        path = "/usr/local/ircd/modules";