Update documentation for cloaking

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@11869 e03df62e-2008-0410-955e-edbf42e46eb7

diff --git a/conf/modules.conf.example b/conf/modules.conf.example
index 691068a73f082368b95eb60e6efd9d6a7b3a7c8e..9be66715943606b8db1449875993b35787408968 100644 (file)
--- a/conf/modules.conf.example
+++ b/conf/modules.conf.example
@@ -474,34 +474,37 @@
 #
 #-#-#-#-#-#-#-#-#-#-#- CLOAKING  CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
-# Optional - If you specify the m_cloaking.so module as above, you    #
-# must define cloak keys, and optionally a cloak prefix as shown      #
-# below. When using cloaking, the cloak keys are MANDITORY and must   #
-# be included. However, if prefix is not included, it will default    #
-# to your networks name from the <server> tag. You can also include   #
-# the following optional values:                                      #
-#                                                                     #
-#   ipalways         - Always cloak the IP address, not the hostname, #
-#                      which doesn't reveal the user's ISP, but       #
-#                      results in hosts that are harder to read and   #
-#                      ban.                                           #
-#                                                                     #
-#   lowercase        - Display the cloaked hostnames in lowercase     #
-#                      characters instead of uppercase                #
-#                                                                     #
-# <cloak key1="0x2AF39F40"                                            #
-#        key2="0x78E10B32"                                            #
-#        key3="0x4F2D2E82"                                            #
-#        key4="0x043A4C81"                                            #
-#        prefix="mynet"                                               #
-#        ipalways="false"                                             #
-#        lowercase="false">                                           #
-#                                                                     #
-# Please note that the key values will accept any number, and should  #
-# be large numbers. Using small numbers such as "7" or "1924" will    #
-# seriously weaken the security of your cloak. It is recommended you  #
-# use hexdecimal numbers prefixed by "0x", as shown in this example,  #
-# with each key eight hex digits long.                                #
+# If you specify the m_cloaking.so module as above, you must define   #
+# cloak keys, and optionally a cloak prefix as shown below. The cloak #
+# keys must be shared across the network for correct cloaking.        #
+#                                                                     #
+# There are four methods of cloaking:                                 #
+#                                                                     #
+#   half           Cloak only the "unique" portion of a host; show    #
+#                  the last 2 parts of the domain, /16 subnet of IPv4 #
+#                  or /48 subnet of the IPv6 address.                 #
+#                                                                     #
+#   full           Cloak the users completely, using three slices for #
+#                  common CIDR bans (IPv4: /16, /24; IPv6: /48, /64)  #
+#                                                                     #
+# These methods use a single key that can be any length of text.      #
+# An optional prefix may be specified to mark cloaked hosts.          #
+#                                                                     #
+# The following methods are maintained for backwards compatibility;   #
+# they are slightly less secure, and always hide unresolved IPs       #
+#                                                                     #
+#   compat-host    InspIRCd 1.2-compatible host-based cloaking        #
+#   compat-ip      InspIRCd 1.2-compatible ip-always cloaking         #
+#                                                                     #
+# You must specify key1, key2, key3, key4 for the compat cloaking     #
+# modes; the values must be less than 0x80000000 and should be picked #
+# at random. Prefix is mandatory, will default to network name if not #
+# specified, and will always have a "-" appended.                     #
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+#
+#<cloak mode="half"
+#       key="secret"
+#       prefix="net-">
 
 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Close module: Allows an oper to close all unregistered connections.
@@ -1238,9 +1241,7 @@
 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
 # If you want to do this, set the filename below, and uncomment the include.
 #
-# The conf file generated has a path relative to the inspircd binary, hence '../conf/'.
-#
-#<permchanneldb filename="../conf/permchannels.conf">
+#<permchanneldb filename="conf/permchannels.conf">
 #<include file="permchannels.conf">
 #
 # You may also create channels on startup by using the <permchannels> block.

diff --git a/src/modules/m_cloaking.cpp b/src/modules/m_cloaking.cpp
index 3e22ff73ed0de855dafc8a17eaf38fe0506b6502..2dfc449ae4557b4590f83bdae73139fa461dfe52 100644 (file)
--- a/src/modules/m_cloaking.cpp
+++ b/src/modules/m_cloaking.cpp
@@ -476,7 +476,7 @@ class ModuleCloaking : public Module
                        }
                        case MODE_OPAQUE:
                        default:
-                               chost = SegmentIP(dest->client_sa);
+                               chost = prefix + SegmentIP(dest->client_sa);
                }
                cu.ext.set(dest,chost);
        }