From 7f6ffa0bdae7603dbcc97f7c670a8d1f736bd6cb Mon Sep 17 00:00:00 2001 From: Sadie Powell Date: Tue, 20 Jun 2023 15:29:17 +0100 Subject: Merge the cloak_account and cloak_nick modules. These modules are 90% identical and were only separate because before commit 78cd3898f5 we could not conditionally regenerate cloaks. --- docs/conf/modules.conf.example | 126 ++++++++++++++++------------------------- 1 file changed, 50 insertions(+), 76 deletions(-) (limited to 'docs') diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example index afaf3861a..599ed7e8e 100644 --- a/docs/conf/modules.conf.example +++ b/docs/conf/modules.conf.example @@ -516,47 +516,6 @@ # load the conn_umodes module and add "x" to . # -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Account cloak module: Adds the "account" (services account name) and -# "account-id" (services account identifier) cloak methods. -# -# -#-#-#-#-#-#-#-#-#-#- ACCOUNT CLOAK CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# -# To use the cloak_account module you must define a tag. This # -# tag can have the following fields. # -# # -# class - If non-empty then a comma-delimited list of connect # -# class names that a user has to be in to get the cloak # -# from this tag. # -# # -# prefix - A freeform value to prefix cloaks with. This must not # -# contain spaces. # -# # -# suffix - A freeform value to suffix IPv4/IPv6 cloaks with. This # -# must not contain spaces. # -# # -# sanitize - If enabled then any characters in the account name/id # -# that are not valid in a hostname will be removed rather # -# than skipping the cloak method. Defaults to yes. # -# # -# IMPORTANT: Changing these details will break all of your existing # -# bans. If you do not want this to happen you can define multiple # -# cloak tags. The first will be used for hostnames and the rest will # -# be used for checking if a user is banned in a channel. # -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# -# -# -# - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # MD5 cloak module: Adds the "half" and "full" cloak methods. These # methods are obsolete and should only be used on a network which is @@ -612,40 +571,6 @@ # prefix="MyNet-" # suffix=".IP"> -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Nickname cloak module: Adds the "nick" (user nickname) cloak method. -# -# -#-#-#-#-#-#-#-#-#-#- ACCOUNT CLOAK CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# -# To use the cloak_nick module you must define a tag. This # -# tag can have the following fields. # -# # -# class - If non-empty then a comma-delimited list of connect # -# class names that a user has to be in to get the cloak # -# from this tag. # -# # -# prefix - A freeform value to prefix cloaks with. This must not # -# contain spaces. # -# # -# suffix - A freeform value to suffix cloaks with. This must not # -# contain spaces. # -# # -# sanitize - If enabled then any characters in the nickname that are # -# not valid in a hostname will be removed rather than # -# than skipping the cloak method. # -# # -# IMPORTANT: Changing these details will break all of your existing # -# bans. If you do not want this to happen you can define multiple # -# cloak tags. The first will be used for hostnames and the rest will # -# be used for checking if a user is banned in a channel. # -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# -# - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # HMAC-SHA256 cloak module: Adds the "hmac-sha256" (hostname or IP) and # "hmac-sha256-ip" (IP only) cloak methods. This is the recommended @@ -715,7 +640,7 @@ # Static cloak module: Adds the "static" (fixed value) cloak method. # # -#-#-#-#-#-#-#-#-#-#- ACCOUNT CLOAK CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +#-#-#-#-#-#-#-#-#-#- STATIC CLOAK CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # To use the cloak_static module you must define a tag. This # # tag can have the following fields. # # # @@ -734,6 +659,55 @@ # class="" # cloak="some.fixed.value"> +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# User data cloak module: Adds the "account" (services account name), +# "account-id" (services account identifier), and "nick" (nickname) +# cloak methods. +# +# +#-#-#-#-#-#-#-#-#-#-#- USER CLOAK CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# To use the cloak_user module you must define a tag. This # +# tag can have the following fields. # +# # +# class - If non-empty then a comma-delimited list of connect # +# class names that a user has to be in to get the cloak # +# from this tag. # +# # +# prefix - A freeform value to prefix cloaks with. This must not # +# contain spaces. # +# # +# suffix - A freeform value to suffix IPv4/IPv6 cloaks with. This # +# must not contain spaces. # +# # +# sanitize - If enabled then any characters in the account name, # +# account id or nickname that are not valid in a hostname # +# will be removed rather than skipping the cloak method. # +# Defaults to yes. # +# # +# IMPORTANT: Changing these details will break all of your existing # +# bans. If you do not want this to happen you can define multiple # +# cloak tags. The first will be used for hostnames and the rest will # +# be used for checking if a user is banned in a channel. # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# +# +# +# +# +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Codepage module: Allows using a custom 8-bit codepage for nicknames # and case mapping. -- cgit v1.3.1-10-gc9f91