X-Git-Url: https://jfr.im/git/solanum.git/blobdiff_plain/51fa2ab8a39eb4529a9544fcea76f2f09dac4f85..4a8bd0b2fb32e1b0672c765615867f94cf328761:/doc/reference.conf diff --git a/doc/reference.conf b/doc/reference.conf index e8cd9937..22ba0160 100644 --- a/doc/reference.conf +++ b/doc/reference.conf @@ -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 @@ -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 @@ -62,13 +63,14 @@ * 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 * 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 @@ -79,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"; @@ -104,6 +107,7 @@ #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"; @@ -144,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"; + #vhost6 = "2001:db8:2::6"; - /* ssl_private_key: our ssl private key */ - ssl_private_key = "etc/ssl.key"; - - /* 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 */ @@ -284,17 +290,20 @@ 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; + sendq = 2 megabytes; }; /* listen {}: contain information about the ports ircd listens on (OLD P:) */ @@ -318,8 +327,8 @@ listen { /* 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; + /* 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. @@ -331,6 +340,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:) */ @@ -367,8 +382,10 @@ 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,6 +398,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; @@ -414,8 +433,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 @@ -426,19 +452,30 @@ 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: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" { @@ -449,8 +486,8 @@ 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:remoteban; }; privset "admin" { @@ -534,9 +571,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"; @@ -562,22 +599,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"; @@ -596,12 +631,7 @@ connect "ssl.uplink.com" { 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. @@ -634,8 +664,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. */ @@ -644,59 +673,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"; @@ -705,6 +681,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 @@ -823,6 +805,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; }; @@ -905,13 +892,11 @@ blacklist { * notified upon connect if they are being scanned. * * WARNING: - * These settings are considered experimental, and as of this writing, the - * Charybdis scanner is not as comprehensive as the one available in HOPM. Only - * basic SOCKS4 and SOCKS5 scanning is performed on a few well-known ports. You - * may disable the open proxy scanning feature by deleting this block if you are - * uncomfortable with this. + * 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 { +#opm { /* IPv4 address to listen on. This must be a publicly facing IP address * to be effective. * If omitted, it defaults to serverinfo::vhost. @@ -921,34 +906,53 @@ opm { /* 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. * If omitted, it defaults to serverinfo::vhost6. */ - #listen_ipv6 = "0::1"; + #listen_ipv6 = "::1"; /* 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. + */ + #listen_port = 32000; - /* You can also set a port directive which will set both the IPv4 and - * IPv6 ports at once. + /* 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. */ - port = 32000; + #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; + #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; -}; + #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) @@ -1074,7 +1078,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. @@ -1144,17 +1148,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. */ @@ -1190,36 +1193,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 * 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; @@ -1282,6 +1285,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. */ @@ -1289,7 +1298,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 @@ -1383,13 +1392,29 @@ 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; + + /* 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"; }; modules {