To create new wiki account, please join us on #znc at freenode and ask admins to create a wiki account for you. You can say thanks to spambots for this inconvenience.

Difference between revisions of "Sasl"

From ZNC
Jump to: navigation, search
m (Commands: Add Athemenet to networks supporting SASL)
m (freenode supports sasl external)
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Core Module}}
+
{{Core Module | version = 1.0}}
  
The SASL module allows you to authenticate to an IRC network via SASL.
+
The '''SASL''' module allows you to authenticate to an IRC network via [http://ircv3.net/specs/extensions/sasl-3.1.html SASL]. This is preferable to using [[perform]] or [[nickserv]] because you can auth to services ''before'' you are even visible on the server.
 +
 
 +
This module supports the ''EXTERNAL'' SASL mechanism if you set up a certificate with the [[cert]] module. Once cert is properly enabled and setup, you can set the SASL module to use the ''EXTERNAL'' mechanism.
  
This module can be used with the [[cert]] module to support the EXTERNAL SASL mechanism. You can do this by setting up a certificate with [[cert]] and then setting the module to use the EXTERNAL mechanism. `/msg *sasl mechanism external`.
 
  
 
===Commands===
 
===Commands===
  
<*sasl> +-------------+-------------------+-----------------------------------------------+
+
; <code>/msg *sasl Help [<search term>]</code>
<*sasl> | Command    | Arguments        | Description                                  |
+
: Generate this help output, optionally search for word/phrase in this output.
<*sasl> +-------------+-------------------+-----------------------------------------------+
+
 
<*sasl> | Help        | search           | Generate this output                         |
+
; <code>/msg *sasl Mechanism [mechanism[ ...]]</code>
<*sasl> | Mechanism   | [mechanism[ ...]] | Set the mechanisms to be attempted (in order) |
+
: Set the mechanisms to be attempted (in order). The following mechanisms are available:
<*sasl> | RequireAuth | [yes|no]          | Don't connect if SASL cannot be authenticated |
+
:* <code>EXTERNAL</code>
<*sasl> | Set        | username password | Set the password for DH-BLOWFISH/DH-AES/PLAIN |
+
:*: TLS certificate, for use with the *[[cert]] module. [[Cert]] must be setup, and the network must [[#Support for SASL|support this mechanism]].
<*sasl> +-------------+-------------------+-----------------------------------------------+
+
:* <code>PLAIN</code>
<*sasl> The following mechanisms are available:
+
:*: Plain text negotiation; this should always work if the network supports SASL
<*sasl> +-------------+----------------------------------------------------+
+
 
<*sasl> | Mechanism  | Description                                        |
+
; <code>/msg *sasl RequireAuth [yes|no]</code>
<*sasl> +-------------+----------------------------------------------------+
+
: Don't connect unless SASL authentication succeeds
<*sasl> | EXTERNAL    | TLS certificate, for use with the *cert module     |
+
 
<*sasl> | DH-BLOWFISH | Secure negotiation using the DH-BLOWFISH mechanism |
+
; <code>/msg *sasl Set <username> [<password>]</code>
<*sasl> | DH-AES      | More secure negotiation using the DH-AES mechanism |
+
: Set username and password for the mechanisms that need them. Password is optional
<*sasl> | PLAIN      | Plain text negotiation                            |
 
<*sasl> +-------------+----------------------------------------------------+
 
  
Example:
+
=== Example ===
/msg *sasl set MyUsername pa$$w0rd
 
  
'''Note:''' The password is saved unencrypted, so don't make your ZNC data directory readable to other users!
+
Basic configuration of the *sasl module. First, be sure the SASL module is loaded:
  
The following networks support sasl:
+
'''/query *status'''
 +
'''loadmod sasl'''
 +
<*status> Loaded module [sasl] [/home/znc/.local/lib/znc/sasl.so]
  
* Athemenet <!-- Atheme, Charybdis etc. network -->
+
Configure the module:
* ChatSpike <!-- InspIRCd network -->
+
 
 +
'''/query *sasl'''
 +
'''mechanism external plain'''
 +
<*sasl> Current mechanisms set: EXTERNAL PLAIN
 +
'''set MyNickservName pa$$w0rd'''
 +
<*sasl> Username has been set to [MyNickservName]
 +
<*sasl> Password has been set to [pa$$w0rd]
 +
 
 +
SASL won't be used until you reconnect to the server:
 +
 
 +
'''/query *status'''
 +
'''jump'''
 +
<*status> Jumping to the next server in the list...
 +
 
 +
; Please note:
 +
* The password is saved unencrypted, so don't make your ZNC data directory readable to other users! If you are using [[Providers|a ZNC bouncer provided by someone else]], be sure you trust them with your password.
 +
* If you don't use SSL, the password is transmitted to the IRC server in plain text. There's no problem with sending an unencrypted password inside an SSL secured connection, so if you're using SSL you probably don't need to bother worrying about anything other than the PLAIN mechanism.
 +
: Nowadays, most networks support either SASL ''PLAIN'' or ''EXTERNAL''. ''DH-BLOWFISH'' and ''DH-AES'' support were removed due to people believing them to be more secure than SASL ''PLAIN'' + SSL, which is not the case. If you use SASL ''PLAIN'' with an SSL connection, you'll be fine.
 +
 
 +
=== Support for SASL ===
 +
 
 +
Many networks support SASL, including:
 +
* ChatSpike
 
* EsperNet
 
* EsperNet
* Freenode  
+
* Freenode
* PirateIRC <!-- Pirate Parties International -->
+
* PirateIRC
* Snoonet <!-- Reddit like network -->
+
* Snoonet
 +
 
 +
<small>''A network not listed here '''may or may not''' support SASL.''</small>

Latest revision as of 18:56, 14 May 2017


The SASL module allows you to authenticate to an IRC network via SASL. This is preferable to using perform or nickserv because you can auth to services before you are even visible on the server.

This module supports the EXTERNAL SASL mechanism if you set up a certificate with the cert module. Once cert is properly enabled and setup, you can set the SASL module to use the EXTERNAL mechanism.


Commands[edit]

/msg *sasl Help [<search term>]
Generate this help output, optionally search for word/phrase in this output.
/msg *sasl Mechanism [mechanism[ ...]]
Set the mechanisms to be attempted (in order). The following mechanisms are available:
  • EXTERNAL
    TLS certificate, for use with the *cert module. Cert must be setup, and the network must support this mechanism.
  • PLAIN
    Plain text negotiation; this should always work if the network supports SASL
/msg *sasl RequireAuth [yes|no]
Don't connect unless SASL authentication succeeds
/msg *sasl Set <username> [<password>]
Set username and password for the mechanisms that need them. Password is optional

Example[edit]

Basic configuration of the *sasl module. First, be sure the SASL module is loaded:

/query *status
loadmod sasl
<*status> Loaded module [sasl] [/home/znc/.local/lib/znc/sasl.so]

Configure the module:

/query *sasl
mechanism external plain
<*sasl> Current mechanisms set: EXTERNAL PLAIN
set MyNickservName pa$$w0rd
<*sasl> Username has been set to [MyNickservName]
<*sasl> Password has been set to [pa$$w0rd]

SASL won't be used until you reconnect to the server:

/query *status
jump
<*status> Jumping to the next server in the list...
Please note
  • The password is saved unencrypted, so don't make your ZNC data directory readable to other users! If you are using a ZNC bouncer provided by someone else, be sure you trust them with your password.
  • If you don't use SSL, the password is transmitted to the IRC server in plain text. There's no problem with sending an unencrypted password inside an SSL secured connection, so if you're using SSL you probably don't need to bother worrying about anything other than the PLAIN mechanism.
Nowadays, most networks support either SASL PLAIN or EXTERNAL. DH-BLOWFISH and DH-AES support were removed due to people believing them to be more secure than SASL PLAIN + SSL, which is not the case. If you use SASL PLAIN with an SSL connection, you'll be fine.

Support for SASL[edit]

Many networks support SASL, including:

  • ChatSpike
  • EsperNet
  • Freenode
  • PirateIRC
  • Snoonet

A network not listed here may or may not support SASL.