Merge branch 'wip/generic-p10-support' into devel

Closes #330. Really fixes #329.

README.md

@@ -81,7 +81,7 @@ These IRCds (in alphabetical order) are frequently tested and well supported. If
 * [InspIRCd](http://www.inspircd.org/) 2.0.x - module `inspircd`
     - For vHost setting to work, `m_chghost.so` must be loaded.
     - Supported channel, user, and prefix modes are negotiated on connect, but hotloading modules that change these is not supported. After changing module configuration, it is recommended to SQUIT PyLink to force a protocol renegotiation.
-* [Nefarious IRCu](https://github.com/evilnet/nefarious2) (2.0.0+) - module `nefarious`
+* [Nefarious IRCu](https://github.com/evilnet/nefarious2) (2.0.0+) - module `p10`
     - Note: Both account cloaks (user and oper) and hashed IP cloaks are optionally supported (HOST_HIDING_STYLE settings 0 to 3). Make sure you configure PyLink to match your IRCd settings.
 * [UnrealIRCd](https://www.unrealircd.org/) 4.x - module `unreal`
     - Linking to UnrealIRCd 3.2 servers is only possible when using an UnrealIRCd 4.x server as a hub, with topology such as `pylink<->unreal4<->unreal3.2`. We nevertheless encourage you to upgrade so all your IRCds are running the same version.
@@ -97,7 +97,11 @@ Support for these IRCds exist, but are not tested as frequently and thoroughly.
 * [ircd-ratbox](http://www.ratbox.org/) (3.x) - module `ratbox`
     - Host changing is not supported on ircd-ratbox.
     - On ircd-ratbox, all known IPs of users will be shown in `/whois`, even if the client is a cloaked relay client: if you're paranoid about this, turn off Relay IP forwarding by setting the `relay_no_ips` option in the ratbox network's `server:` block.
+* [IRCu](http://coder-com.undernet.org/) (u2.10.12.16+) - module `p10`
+    - Host changing is not supported.
 * [juno-ircd](https://github.com/cooper/yiria) (11.x / janet) - module `ts6` (see [configuration example](https://github.com/cooper/juno/blob/master/doc/ts6.md#pylink))
+* [snircd](https://development.quakenet.org/) (1.3.x+) - module `p10`
+    - Outbound host changing (i.e. for the `changehost` plugin) is not supported on P10 variants other than Nefarious.
 
 Other TS6 and P10 variations may work, but are not officially supported.
 

docs/technical/channel-modes.csv

@@ -1,59 +1,59 @@
-Channel Mode / IRCd,InspIRCd,charybdis,Elemental-IRCd,UnrealIRCd,IRCd-Hybrid,Nefarious IRCu,ircd-ratbox
+Channel Mode / IRCd,InspIRCd,charybdis,Elemental-IRCd,UnrealIRCd,IRCd-Hybrid,Nefarious IRCu,ircd-ratbox,snircd,IRCu
-admin,a (m_customprefix/m_chanprotect),,a (when enabled),a,,,
+admin,a (m_customprefix/m_chanprotect),,a (when enabled),a,,,,,
-adminonly,,A (extensions/chm_adminonly),A (extensions/chm_adminonly.c),,,a,
+adminonly,,A (extensions/chm_adminonly),A (extensions/chm_adminonly.c),,,a,,,
-allowinvite,A (m_allowinvite),g,g,,,,
+allowinvite,A (m_allowinvite),g,g,,,,,,
-autoop,w (m_autoop),,,,,,
+autoop,w (m_autoop),,,,,,,,
-ban,b,b,b,b,b,b,b
+ban,b,b,b,b,b,b,b,b,b
-banexception,e (m_banexception),e,e,e,e,e,e
+banexception,e (m_banexception),e,e,e,e,e,e,,
-blockcaps,B (m_blockcaps),,G (extensions/chm_nocaps.c),,,,
+blockcaps,B (m_blockcaps),,G (extensions/chm_nocaps.c),,,,,,
-blockcolor,c (m_blockcolor),,,c,c,c,
+blockcolor,c (m_blockcolor),,,c,c,c,,c,c
-delayjoin,,,,,,D,
+delayjoin,,,,,,D,,D,D
-exemptchanops,X (m_exemptchanops),,,,,,
+exemptchanops,X (m_exemptchanops),,,,,,,,
-filter,g (m_filter),,,,,,
+filter,g (m_filter),,,,,,,,
-flood,f (m_messageflood),,,,,,
+flood,f (m_messageflood),,,,,,,,
-flood_unreal,,,,f,,,
+flood_unreal,,,,f,,,,,
-freetarget,,F,F,,,,
+freetarget,,F,F,,,,,,
-had_delayjoins,,,,,,d,
+had_delayjoin,,,,,,d,,d,d
-halfop,h (m_customprefix/m_halfop),,h (when enabled),h,h,,
+halfop,h (m_customprefix/m_halfop),,h (when enabled),h,h,,,,
-hiddenbans,,,u,,,,
+hiddenbans,,,u,,,,,,
-hidequits,,,,,,Q,
+hidequits,,,,,,Q,,u,
-history,H (m_chanhistory),,,,,,
+history,H (m_chanhistory),,,,,,,,
-invex,I (m_inviteexception),I,I,I,I,,I
+invex,I (m_inviteexception),I,I,I,I,,I,,
-inviteonly,i,i,i,i,i,i,i
+inviteonly,i,i,i,i,i,i,i,i,i
-issecure,,,,Z,,,
+issecure,,,,Z,,,,,
-joinflood,j (m_joinflood),j,j,,,,
+joinflood,j (m_joinflood),j,j,,,,,,
-key,k,k,k,k,k,k,k
+key,k,k,k,k,k,k,k,k,k
-kicknorejoin,J (m_kicknorejoin),,J,,,,
+kicknorejoin,J (m_kicknorejoin),,J,,,,,,
-largebanlist,,L,L,,,,
+largebanlist,,L,L,,,,,,
-limit,l,l,l,l,l,l,l
+limit,l,l,l,l,l,l,l,l,l
-moderated,m,m,m,m,m,m,m
+moderated,m,m,m,m,m,m,m,m,m
-nickflood,F (m_nickflood),,,,,,n
+nickflood,F (m_nickflood),,,,,,,,
-noamsg,,,,,,T,
+noamsg,,,,,,T,,T,
-noctcp,C (m_noctcp),C,C,C,C,C,
+noctcp,C (m_noctcp),C,C,C,C,C,,C,C
-noextmsg,n,n,n,n,n,n,n
+noextmsg,n,n,n,n,n,n,n,,
-noforwards,,Q,Q,,,,
+noforwards,,Q,Q,,,,,,
-noinvite,,,,,,,
+noinvite,,,,,,,,,
-nokick,Q (m_nokicks),,E,Q,,,
+nokick,Q (m_nokicks),,E,Q,,,,,
-noknock,K (m_knock),p,,K,p,,
+noknock,K (m_knock),p,,K,p,,,,
-nonick,N (m_nonicks),,d,N,,,
+nonick,N (m_nonicks),,d,N,,,,,
-nonotice,T (m_nonotice),T (extensions/chm_nonotice),T,T,,N,
+nonotice,T (m_nonotice),T (extensions/chm_nonotice),T,T,,N,,N,
-official-join,Y (m_ojoin),,,,,,
+official-join,Y (m_ojoin),,,,,,,,
-op,o,o,o,o,o,o,o
+op,o,o,o,o,o,o,o,o,o
-operonly,O (m_operchans),O (extensions/chm_operonly),O (extensions/chm_operonly.c),O,O,O,
+operonly,O (m_operchans),O (extensions/chm_operonly),O (extensions/chm_operonly.c),O,O,O,,,
-oplevel_apass,,,,,,A,
+oplevel_apass,,,,,,A,,A,A
-oplevel_upass,,,,,,U,
+oplevel_upass,,,,,,U,,U,U
-opmoderated,U (extras/m_opmoderated),z,z,,,,
+opmoderated,U (extras/m_opmoderated),z,z,,,,,,
-owner,q (m_customprefix/m_chanprotect),,y (when enabled),q,,,
+owner,q (m_customprefix/m_chanprotect),,y (when enabled),q,,,,,
-permanent,P (m_permchannels),P,P,P,,z,
+permanent,P (m_permchannels),P,P,P,,z,,,
-private,p,,,p,,p,p
+private,p,,,p,,p,p,p,p
-quiet,,q,q,,,,
+quiet,,q,q,,,,,,
-redirect,L (m_redirect),f,f,L,,L,
+redirect,L (m_redirect),f,f,L,,L,,,
-registered,r (m_services_account),,,r,r,R,
+registered,r (m_services_account),,,r,r,R,,R,R
-regmoderated,M (m_services_account),,,M,M,M,
+regmoderated,M (m_services_account),,,M,M,M,,M,
-regonly,R (m_services_account),r,r,R,R,r,r
+regonly,R (m_services_account),r,r,R,R,r,r,r,r
-repeat,E (m_repeat),,K (extensions/chm_norepeat.c),,,,
+repeat,E (m_repeat),,K (extensions/chm_norepeat.c),,,,,,
-secret,s,s,s,s,s,s,s
+secret,s,s,s,s,s,s,s,s,s
-sslonly,z (m_sslmodes),S (extensions/chm_sslonly),S (extensions/chm_sslonly.c),z,S,,S
+sslonly,z (m_sslmodes),S (extensions/chm_sslonly),S (extensions/chm_sslonly.c),z,S,,S,,
-stripcolor,S (m_stripcolor),c,c,S,,S,
+stripcolor,S (m_stripcolor),c,c,S,,S,,,
-topiclock,t,t,t,t,t,t,t
+topiclock,t,t,t,t,t,t,t,t,t
-voice,v,v,v,v,v,v,v
+voice,v,v,v,v,v,v,v,v,v

docs/technical/user-modes.csv

@@ -1,48 +1,49 @@
-User Mode / IRCd,InspIRCd,charybdis,Elemental-IRCd,UnrealIRCd,IRCd-Hybrid,Nefarious IRCu,ircd-ratbox
+User Mode / IRCd,InspIRCd,charybdis,Elemental-IRCd,UnrealIRCd,IRCd-Hybrid,Nefarious IRCu,ircd-ratbox,snircd,IRCu
-admin,,a,a,,a,a,a
+admin,,a,a,,a,a,a,,
-bot,B,,B,B,,B,
+bot,B,,B,B,,B,,,
-callerid,g,g,g,,g,g,g
+callerid,g,g,g,,g,,g,,
-cloak,x,x,x,x,x,x,
+cloak,x,x,x,x,x,x,,x,x
-cloak_fakehost,,,,,,f,
+cloak_fakehost,,,,,,f,,,
-cloak_hashedhost,,,,,,C,
+cloak_hashedhost,,,,,,C,,,
-cloak_hashedip,,,,,,c,
+cloak_hashedip,,,,,,c,,,
-cloak_sethost,,,,,,h,
+cloak_sethost,,,,,,h,,h,
-deaf,d,D,D,d,D,D,D
+deaf,d,D,D,d,D,d,D,d,d
-deaf_commonchan,c,,,,G,q,
+deaf_commonchan,c,,,,G,q,,,
-debug,,,,,d,,
+debug,,,,,d,,,,
-filter,,,,G,,,
+filter,,,,G,,,,,
-helpop,h,,,,,,
+helpop,h,,,,,,,,
-hidechans,I,,I,p,p,n,
+hidechans,I,,I,p,p,n,,n,
-hideidle,,,,I,q,I,
+hideidle,,,,I,q,I,,I,
-hideoper,H,,,H,H,H,
+hideoper,H,,,H,H,H,,,
-invisible,i,i,i,i,i,i,i
+invisible,i,i,i,i,i,i,i,i,i
-locops,,l,l,,l,O,l
+locops,,l,l,,l,O,l,O,O
-noctcp,,,C,T,,,
+noctcp,,,C,T,,,,,
-noforward,,Q,Q,,,L,
+noforward,,Q,Q,,,L,,,
-noinvite,,,V,,,,
+noinvite,,,V,,,,,,
-oper,o,o,o,,o,o,o
+oper,o,o,o,,o,o,o,o,o
-operwall,,z,z,,,,z
+operwall,,z,z,,,,z,,
-override,,p,p,,,X,
+override,,p,p,,,X,,X,
-protected,,,,q,,,
+privdeaf,,,,,,D,,,
-regdeaf,R,R,R,R,R,R,
+protected,,,,q,,,,,
-registered,r,,,r,r,r,
+regdeaf,R,R,R,R,R,R,,R,
-servprotect,k,S,S,S,,k,S
+registered,r,,,r,r,r,,r,r
-showwhois,W,,,W,,W,
+servprotect,k,S,S,S,,k,S,k,k
-sno_admin_requests,,,,,y,,y
+showwhois,W,,,W,,W,,,
-sno_badclientconnections,,,,,u,,u
+sno_admin_requests,,,,,y,,y,,
-sno_botfloods,,,,,b,,b
+sno_badclientconnections,,,,,u,,u,,
-sno_clientconnections,,,,,c,,c
+sno_botfloods,,,,,b,,b,,
-sno_debug,,,,,,g,d
+sno_clientconnections,,,,,c,,c,,
-sno_extclientconnections,,,,,,,C
+sno_debug,,,,,,g,d,g,g
-sno_fullauthblock,,,,,f,,f
+sno_extclientconnections,,,,,,,C,,
-sno_nickchange,,,,,n,,
+sno_fullauthblock,,,,,f,,f,,
-sno_rejectedclients,,,,,j,,r
+sno_nickchange,,,,,n,,,,
-sno_remoteclientconnections,,,,,F,,
+sno_rejectedclients,,,,,j,,r,,
-sno_server_connects,,,,,e,,x
+sno_remoteclientconnections,,,,,F,,,,
-sno_skill,,,,,k,,k
+sno_server_connects,,,,,e,,x,,
-snomask,s,s,s,s,s,s,s
+sno_skill,,,,,k,,k,,
-ssl,,,,z,S,z,
+snomask,s,s,s,s,s,s,s,,
-stripcolor,S,,,,,,
+ssl,,,,z,S,z,,,
-vhost,,,,t,,,
+stripcolor,S,,,,,,,,
-wallops,w,w,w,w,w,w,w
+vhost,,,,t,,,,,
-webirc,,,,,W,,
+wallops,w,w,w,w,w,w,w,,
+webirc,,,,,W,,,,

example-conf.yml

@@ -268,27 +268,52 @@ servers:
         sid: 50
         sidrange: "100-150"
         channels: ["#lounge"]
-        protocol: nefarious
+        protocol: p10
         autoconnect: 5
         netname: "Nefarious test server"
 
-        # The following options are specific to Nefarious servers.
+        ### The following options are specific to P10 servers:
-        # Halfop is optional in Nefarious. This should match your IRCd configuration.
+        # Determines whether extended accounts should be used for this network.
-        use_halfop: false
+        # For Nefarious, this **MUST** match the EXTENDED_ACCOUNTS setting in your IRCd configuration.
+        # Disable this if you are using X3, and leave it on for any other service package
+        # (atheme, etc.)
+        # For other P10 IRCds, this should be set to FALSE.
+        use_extended_accounts: true
+
+        # Sets the IRCd type. The following options are supported here: 'nefarious', 'snircd', 'ircu', and
+        # 'generic'. This defaults to 'nefarious'.
+        # With this key set to 'nefarious', FAKE (external vHost changing) and SETHOST (host changing
+        # for PyLink / relay clients) are enabled, along with a set of modes tailored to Nefarious.
+
+        # With this key set to 'snircd', SETHOST and a set of modes tailored to snircd are enabled.
+        # vHost changing of other users (e.g. via the changehost plugin) is not supported.
+
+        # With this key set to 'ircu', a set of modes tailored to IRCu is enabled.
+        # vHost changing is not supported.
+
+        # With this key set to 'generic', neither of these host changing features are enabled
+        # and a baseline RFC1459 mode set is used. This configuration is not officially supported.
+        #p10_ircd: nefarious
 
         # Determines whether account-based cloaks should be used (someone.users.yournet.org
         # format). This should match your IRCd configuration:
-        # ENABLE this if HOST_HIDING_STYLE is set to either 1 or 3.
+        # On Nefarious, ENABLE this if HOST_HIDING_STYLE is set to either 1 or 3.
-        use_account_cloaks: true
+        # On other P10 IRCds, ENABLE this if HOST_HIDING is set to TRUE.
+        use_account_cloaks: false
 
         # The cloak suffix to be used for account-based cloaks. This **MUST** match your
         # IRCd configuration if use_account_cloaks is enabled.
         cloak_suffix: "users.yournet.org"
 
+        ### The following options are specific to Nefarious servers and should be set to false if
+        ### you're using another P10 IRCd (unless your variant supports them as well):
+        # Halfop is optional in Nefarious. This should match your IRCd configuration.
+        use_halfop: false
+
         # Determines whether account-based cloaks should be used for opers
         # (someone.opers.yournet.org format). If use_account_cloaks is disabled,
         # this will have no effect. This should match your IRCd configuration:
-        use_oper_account_cloaks: true
+        use_oper_account_cloaks: false
 
         # The cloak suffix to be used for IRCop account-based cloaks. This **MUST** match your
         # IRCd configuration if use_oper_account_cloaks is enabled.
@@ -297,13 +322,7 @@ servers:
         # Determines whether UnrealIRCd-style hashed-host cloaks will be used.
         # This should match your IRCd configuration:
         # ENABLE this if HOST_HIDING_STYLE is set to either 2 or 3.
-        use_hashed_cloaks: true
+        use_hashed_cloaks: false
-
-        # Determines whether extended accounts should be used for this network.
-        # This **MUST** match the EXTENDED_ACCOUNTS setting in your IRCd configuration.
-        # Disable this if you are using X3, and leave it on for any other service package
-        # (atheme, etc.)
-        use_extended_accounts: true
 
     # Sample Clientbot configuration, if you want to connect PyLink as a bot to relay somewhere
     # (or do other bot things).