Difference between revisions of "SASL"

From Rizon Wiki
Jump to: navigation, search
m (Formed HexChat sections into procedure steps.)
m (Enhanced intro and headings, and replaced SSL flags with TLS in Irssi.)
 
Line 1: Line 1:
SASL is a way to identify to your registered nickname during the connection to the network, ensuring that you don't have to manually identify to services. To use SASL you need a [[Nick_Registration|registered nickname]].
+
SASL is a way to automatically identify to your registered nickname during the connection to the network, ensuring that you don't have to manually identify to services. To use SASL, first, you need a [[Nick_Registration|registered nickname]]; then, you need to configure your client as explained later.
 +
<p>Rizon supports these two SASL mechanisms:
 +
* '''SASL PLAIN''' with your nickname and password
 +
* '''SASL EXTERNAL''' via a client certificate ([[CertFP]])
 +
</p>
  
==Configuring your client to use SASL==
+
 
 +
==SASL PLAIN Client Configurations==
 
{{Expand list|date=June 2017}}
 
{{Expand list|date=June 2017}}
Rizon supports both PLAIN and EXTERNAL SASL mechanisms. Instructions for configuring SASL PLAIN can be found below:
+
 
 
===Irssi===
 
===Irssi===
''Note: You need Irssi version >=0.8.18 to use SASL''
+
'''''Note:''' You need Irssi version >=0.8.18 to use SASL''<br />
<pre>/NETWORK ADD -sasl_mechanism plain -sasl_username <nickname> -sasl_password <password> rizon</pre>
+
<!-- <pre>/NETWORK ADD -sasl_mechanism plain -sasl_username <nickname> -sasl_password <password> rizon</pre> -->
 +
<code>/NETWORK ADD -sasl_mechanism PLAIN -sasl_username <em>YourNickname</em> -sasl_password <em>YourPassword</em> Rizon</code>
 +
 
 
===WeeChat===
 
===WeeChat===
 
<pre>
 
<pre>
Line 14: Line 21:
 
/set irc.server.rizon.sasl_password password
 
/set irc.server.rizon.sasl_password password
 
</pre>
 
</pre>
 +
 
===HexChat===
 
===HexChat===
 
# '''HexChat''' → '''Network List''' (or press {{Key Txt|Ctrl}} + {{Key Txt|S}}) for the ''' Network List''' dialogue box.
 
# '''HexChat''' → '''Network List''' (or press {{Key Txt|Ctrl}} + {{Key Txt|S}}) for the ''' Network List''' dialogue box.
Line 20: Line 28:
 
# In the '''Password''' field enter <code><em>YourPassword</em></code>
 
# In the '''Password''' field enter <code><em>YourPassword</em></code>
 
# Press {{Button|Close}} then {{Button|Connect}}
 
# Press {{Button|Close}} then {{Button|Connect}}
 +
 
===ZNC===
 
===ZNC===
 
Please refer to the [https://wiki.znc.in/Sasl ZNC wiki] for instructions.
 
Please refer to the [https://wiki.znc.in/Sasl ZNC wiki] for instructions.
 +
 
=== mIRC ===
 
=== mIRC ===
 
# '''Tools''' → '''Options...''' (or press {{Key Txt|Alt}} + {{Key Txt|O}}) to&nbsp;open the&nbsp;'''mIRC Options''' dialogue box.
 
# '''Tools''' → '''Options...''' (or press {{Key Txt|Alt}} + {{Key Txt|O}}) to&nbsp;open the&nbsp;'''mIRC Options''' dialogue box.
Line 54: Line 64:
 
<ol><li value=5>Press {{Button|OK}} then {{Button|Select}} and&nbsp;(re)connect.</li></ol>
 
<ol><li value=5>Press {{Button|OK}} then {{Button|Select}} and&nbsp;(re)connect.</li></ol>
  
==SASL EXTERNAL==
+
 
To configure SASL EXTERNAL first set up [[CertFP]], then set the following settings in your client:
+
==SASL EXTERNAL Client Configurations==
 +
To configure SASL EXTERNAL, first set up your client [[CertFP]], then set the following settings in your client:
 +
 
 
===Irssi===
 
===Irssi===
<pre>
+
'''''Note:''' You need Irssi version ≥ 0.8.18 to use SASL''<br />
 +
 
 +
<!-- <pre>
 
/NETWORK ADD -sasl_mechanism external rizon
 
/NETWORK ADD -sasl_mechanism external rizon
 
/SERVER ADD -auto -tls -tls_verify -tls_cert ~/.irssi/certs/Rizon.pem -network rizon -port 6697 irc.rizon.net
 
/SERVER ADD -auto -tls -tls_verify -tls_cert ~/.irssi/certs/Rizon.pem -network rizon -port 6697 irc.rizon.net
</pre>
+
</pre> -->
 +
# <code>/NETWORK ADD -sasl_mechanism EXTERNAL Rizon</code>
 +
# <code>/SERVER ADD -auto -tls -tls_verify -tls_cert ~/.irssi/certs/Rizon.pem -network Rizon -port 6697 irc.rizon.net</code>
 +
 
 
===WeeChat===
 
===WeeChat===
 
<pre>
 
<pre>
Line 69: Line 86:
 
/set irc.server.rizon.sasl_mechanism external
 
/set irc.server.rizon.sasl_mechanism external
 
</pre>
 
</pre>
 +
 
===HexChat===
 
===HexChat===
''Note: The '''<big><kbd>.pem</kbd></big>''' file name should match what appears in the '''Networks''' list (step #2, below). This guide assumes that they are both named '''Rizon'''.<br />
+
'''''Note:''' The '''<big><kbd>.pem</kbd></big>''' file name should match what appears in the '''Networks''' list (step #2, below). This guide assumes that they are both named '''Rizon'''.<br />
The generated '''<big><kbd>.pem</kbd></big>''' file should be in <code>~/.config/hexchat/certs/Rizon.pem</code> for Linux/Unix users, and <code>%appdata%\HexChat\certs\Rizon.pem</code> for Windows users.
+
 
 +
The generated '''<big><kbd>.pem</kbd></big>''' file should be in <code>~/.config/hexchat/certs/Rizon.pem</code> for Linux/Unix users, and <code>%AppData%\HexChat\certs\Rizon.pem</code> for Windows users.
 
# '''HexChat''' → '''Network List''' (or press {{Key Txt|Ctrl}} + {{Key Txt|S}}) for the ''' Network List''' dialogue box.
 
# '''HexChat''' → '''Network List''' (or press {{Key Txt|Ctrl}} + {{Key Txt|S}}) for the ''' Network List''' dialogue box.
 
# In the '''Networks''' list, find and select '''Rizon''' item, then press {{Button|Edit...}}
 
# In the '''Networks''' list, find and select '''Rizon''' item, then press {{Button|Edit...}}
Line 80: Line 99:
 
===ZNC===
 
===ZNC===
 
Please refer to the [https://wiki.znc.in/Sasl ZNC wiki] for instructions.
 
Please refer to the [https://wiki.znc.in/Sasl ZNC wiki] for instructions.
 +
 
=== mIRC ===
 
=== mIRC ===
 
# '''Tools''' → '''Options...''' (or press {{Key Txt|Alt}} + {{Key Txt|O}}) to&nbsp;open the&nbsp;'''mIRC Options''' dialogue box.
 
# '''Tools''' → '''Options...''' (or press {{Key Txt|Alt}} + {{Key Txt|O}}) to&nbsp;open the&nbsp;'''mIRC Options''' dialogue box.
 
# Go to '''Connect''' → '''Servers'''.
 
# Go to '''Connect''' → '''Servers'''.
# Under '''IRC Servers:''', find and select '''Rizon''' group, and press {{Button|Add}}
+
# Press {{Button|Add}}
 
# Fill the fields with the following data:
 
# Fill the fields with the following data:
 
<blockquote>
 
<blockquote>

Latest revision as of 17:11, 27 September 2020

SASL is a way to automatically identify to your registered nickname during the connection to the network, ensuring that you don't have to manually identify to services. To use SASL, first, you need a registered nickname; then, you need to configure your client as explained later.

Rizon supports these two SASL mechanisms:

  • SASL PLAIN with your nickname and password
  • SASL EXTERNAL via a client certificate (CertFP)


SASL PLAIN Client Configurations

Irssi

Note: You need Irssi version >=0.8.18 to use SASL
/NETWORK ADD -sasl_mechanism PLAIN -sasl_username YourNickname -sasl_password YourPassword Rizon

WeeChat

/set irc.server.rizon.addresses irc.rizon.net/6697
/set irc.server.rizon.sasl_mechanism plain
/set irc.server.rizon.sasl_username username (nick)
/set irc.server.rizon.sasl_password password

HexChat

  1. HexChatNetwork List (or press Ctrl + S) for the Network List dialogue box.
  2. In the Networks list, find and select Rizon item, then press Edit...
  3. As Login method select SASL (username + password)    
  4. In the Password field enter YourPassword
  5. Press Close then Connect

ZNC

Please refer to the ZNC wiki for instructions.

mIRC

  1. ToolsOptions... (or press Alt + O) to open the mIRC Options dialogue box.
  2. Go to ConnectServers.
  3. Under IRC Servers:, find and select Rizon group, and press Add
  4. Fill the fields with the following data:
Description Random server SASL (Plain)
Address irc.rizon.net
Ports +6697,+9999
Group Rizon
Password Leave it emptry!
Login Method SASL (/CAP)           
Password YourPassword
  1. Press OK then Select and (re)connect.


SASL EXTERNAL Client Configurations

To configure SASL EXTERNAL, first set up your client CertFP, then set the following settings in your client:

Irssi

Note: You need Irssi version ≥ 0.8.18 to use SASL

  1. /NETWORK ADD -sasl_mechanism EXTERNAL Rizon
  2. /SERVER ADD -auto -tls -tls_verify -tls_cert ~/.irssi/certs/Rizon.pem -network Rizon -port 6697 irc.rizon.net

WeeChat

/set irc.server.rizon.addresses irc.rizon.net/6697
/set irc.server.rizon.ssl on
/set irc.server.rizon.ssl_verify on
/set irc.server.rizon.ssl_cert %h/ssl/Rizon.pem
/set irc.server.rizon.sasl_mechanism external

HexChat

Note: The .pem file name should match what appears in the Networks list (step #2, below). This guide assumes that they are both named Rizon.

The generated .pem file should be in ~/.config/hexchat/certs/Rizon.pem for Linux/Unix users, and %AppData%\HexChat\certs\Rizon.pem for Windows users.

  1. HexChatNetwork List (or press Ctrl + S) for the Network List dialogue box.
  2. In the Networks list, find and select Rizon item, then press Edit...
  3. As Login method select SASL EXTERNAL (cert)      
  4. Press Close then Connect

If the file exists, all your subsequent connections to Rizon network will use this certificate.

ZNC

Please refer to the ZNC wiki for instructions.

mIRC

  1. ToolsOptions... (or press Alt + O) to open the mIRC Options dialogue box.
  2. Go to ConnectServers.
  3. Press Add
  4. Fill the fields with the following data:
Description Random server SASL (External)
Address irc.rizon.net
Ports +6697,+9999
Group Rizon
Password Leave it emptry!
Login Method SASL External (/CAP)  
Password Leave it emptry!
  1. Press OK then Select and (re)connect.