Konversation/Configuring SASL authentication: Difference between revisions

From KDE Wiki Sandbox
No edit summary
m (KDE moved from freenode to libera. The first image was adapted to this, while the rest was not. This inconsistency was reported by a user, and this edit here makes all images consistently using "libera" instead of "freenode" for the network and identity.)
 
(34 intermediate revisions by 5 users not shown)
Line 1: Line 1:
This document will guide you through configuring SASL authentication for an IRC network, using the [http://freenode.net/ Freenode] network as an example. '''Note:''' Support for SASL authentication is a new feature in Konversation v1.5, which has not yet been released. If you'd like to test SASL authentication prior to the release, have a look at our instructions for [[Special:myLanguage/Konversation/Sources|downloading the latest source code]].
<languages />
<translate>


== Configuring SASL authentication == <!--T:1-->


# Let's start by adding the network to the <menuchoice>Server List</menuchoice>. (If you have already added the desired network to the server list, you can skip to step X.) Open the <menuchoice>Server List</menuchoice> dialog window by pressing the <keycap>F2</keycap> key or by clicking <menuchoice>File -> Server List...</menuchoice> in the application menu:
<!--T:2-->
This document will guide you through configuring SASL authentication for an IRC network, using the [https://libera.chat/ Libera Chat] network as an example.


[[Image:Authconfig01.png]]
</translate>
<ol>
<li style="text-align:left;"><span id="step1"></span><translate>
<!--T:4-->
Let's start by adding the network to the '''Server List'''. Open the '''Server List''' dialog window by pressing the <keycap>F2</keycap> key or by clicking <menuchoice>File -> Server List...</menuchoice> in the application menu:<br />
[[Image:Authconfig01.png]]</translate><br /><br /><br /></li>


<li style="text-align:left;"><span id="step2"></span><translate>
<!--T:5-->
If you already have an entry for Libera Chat in the '''Server List''', select it now and then click the <menuchoice>Edit...</menuchoice> button to open the <menuchoice>Edit Network</menuchoice> dialog window and skip to [[Special:myLanguage/Konversation/Configuring SASL authentication#step5|step 5]] (or [[Special:myLanguage/Konversation/Configuring SASL authentication#step4|step 4]] if you're interested in learning about SSL secure transport settings for a network's servers, which complement SASL authentication). Alternatively, click the <menuchoice>New...</menuchoice> button in the upper-right of the window to open the '''New Network''' dialog window:<br />
[[Image:Authconfig02.png]]</translate></li>


# In the <menuchoice>Server List</menuchoice> dialog window, click the <menuchoice>New...</menuchoice> button in the upper-right of the window to open the <menuchoice>New Network</menuchoice> dialog window:


[[Image:Authconfig02.png]]
<li style="text-align:left;"><translate>
<!--T:6-->
In the '''New Network''' dialog window, give the network a name by filling in the <menuchoice>Network name</menuchoice> field. Then click the <menuchoice>Add...</menuchoice> button below the list labeled <menuchoice>Servers</menuchoice> to open the '''Add Server''' dialog window:<br />
[[Image:LB-Authconfig03.png]]</translate></li>




# In the <menuchoice>New Network</menuchoice> dialog window, give the network a name by filling in the <menuchoice>Network name</menuchoice> field. Then click the <menuchoice>Add...</menuchoice> button below the list labeled <menuchoice>Servers</menuchoice> to open the <menuchoice>Add Server</menuchoice> dialog window:
<li style="text-align:left;"><span id="step4"></span><translate>
<!--T:7-->
Fill the '''Add Server''' dialog window as shown in the next screenshot. As the purpose of this guide is to ultimately configure a secure authentication method, note that we have chosen to enable SSL to also use a secure transport between us and the server, logically complementing secure authentication. <!--(You can learn more about Libera Chat's servers and the ports they listen on.--> Clicking the <menuchoice>Ok</menuchoice> button will save the server and take you back to the '''New Network''' dialog window.<br />
[[Image:LB-Authconfig04.png]]</translate></li>


[[Image:Authconfig03.png]]


<li style="text-align:left;"><span id="step5"></span><translate>
<!--T:8-->
Back in the '''New Network''' dialog window (or '''Edit Network''', if you skipped here from [[Special:myLanguage/Konversation/Configuring SASL authentication#step2|step 2]]), notice the newly-added server in the <menuchoice>Servers</menuchoice> list for the network. Now click the <menuchoice>Edit...</menuchoice> button next to the drop-down selection labeled <menuchoice>Identity</menuchoice> to open the '''Identities''' dialog window:<br />
[[Image:LB-Authconfig05.png]]</translate></li>


# Fill the <menuchoice>Add Server</menuchoice> dialog window as shown in the next screenshot. As the purpose of this guide is to ultimately configure a secure authentication method, note that we have chosen to enable SSL to also use a secure transport between us and the server, logically complementing the choice of authentication. (You can learn more about Freenode's servers and the ports they listen on [http://freenode.net/irc_servers.shtml here].) Clicking the <menuchoice>Ok</menuchoice> button will add the server and take you back to the <menuchoice>New Network</menuchoice> dialog window.


[[Image:Authconfig04.png]]
<li style="text-align:left;"><translate>
<!--T:9-->
Welcome to the '''Identities''' dialog window. This dialog window allows you to create and manage an unlimited number of Identities. An Identity is a way to store settings related to your person (such as your real name and nicknames) separately from the settings for a network, so you can for example reuse them for multiple different networks. It also makes it easy to switch between different Identity settings for a single network, by selecting the right Identity in the '''New Network''' dialog window from the preceding steps or in the similar '''Edit Network''' dialog window used to modify an existing network in the '''Server List'''. For added convenience, if you open the '''Identities''' dialog window from the '''New/Edit Network''' dialog window as we have done here (alternatively, you can open it any time by pressing <keycap>F8</keycap>), the Identity you are viewing at the time you press the <menuchoice>Ok</menuchoice> button will be automatically selected for the network.<br /><br />


<!--T:10-->
Because Identities are such an important concept in '''Konversation''', this guide will now take you through adding and filling in an entirely new Identity to use with Libera Chat before turning to adding the authentication settings. If you're already familiar with managing Identities, you can skip to [[Special:myLanguage/Konversation/Configuring SASL authentication#step9|step 9]] now.<br /><br />


# Back in the <menuchoice>New Network</menuchoice> dialog window, notice the newly-added server in the <menuchoice>Servers</menuchoice> list for the network. Now click the <menuchoice>Edit...</menuchoice> button next to the drop-down selection labeled <menuchoice>Identity</menuchoice> to open the <menuchoice>Identities</menuchoice> dialog window:
<!--T:11-->
Note that adding a new Identity is not strictly necessary. As long as you are only using a single IRC network, just filling in the Default Identity is of course enough. But even when using multiple IRC networks, using just the Default Identity for all of them can be enough, if there is no need for any of the Identity settings to differ from network to network. However because, as we will see later, the authentication settings are part of the Identity, it is usually good practice to use separate Identities for different networks, so you can use different passwords on each network for better security. Given this, click the {{Plus}} button next to the drop-down selection labeled <menuchoice>Identity</menuchoice> to open the '''Add Identity''' dialog window:<br />
[[Image:Authconfig06.png]]</translate></li>


[[Image:Authconfig05.png]]


<li style="text-align:left;"><translate>
<!--T:12-->
In the '''Add Identity''' dialog window, enter a name for the new Identity and click the <menuchoice>Ok</menuchoice> button to get back to the '''Identities''' dialog window. Note that the name "libera" in the following screenshot is just a useful memory aid for the connection to the network; there is no need for the network and Identity name to be the same:<br />
[[Image:LB-Authconfig07.png]]</translate></li>


# Welcome to the <menuchoice>Identities</menuchoice> dialog window. This dialog window allows you to create and manage an unlimited number of Identities. An Identity is a way to store settings related to your person (such as your real name and nicknames) separately from the settings for a network, so you can for example reuse them for multiple different networks. It also makes it easy to switch between different Identity settings for a single network, by selecting the right Identity in the <menuchoice>New Network</menuchoice> dialog window from the preceding steps or in the similar <menuchoice>Edit Network</menuchoice> dialog window used to modify an existing network in the <menuchoice>Server List</menuchoice>. For added convenience, if you open the <menuchoice>Identities</menuchoice> dialog window from the <menuchoice>New/Edit Network</menuchoice> dialog window as we have done here (alternatively, you can open it any time by pressing <menuchoice>F8</menuchoice>), the Identity you are viewing at the time you press the <menuchoice>Ok</menuchoice> button will be automatically selected for the network.


Because Identities are such an important concept in Konversation, this guide will now take you through adding and filling in an entirely new Identity to use with Freenode before turning to adding the authentication settings. If you're already familiar with managing Identities, you can skip to step Y now.
<li style="text-align:left;"><translate>
<!--T:13-->
Back in the '''Identities''' dialog window, fill in the basic settings for the newly-added Identity, which has been automatically selected in the dialog (notice the drop-down selection labeled <menuchoice>Identity</menuchoice> at the top of the dialog window). Entering a <menuchoice>Real name</menuchoice> and adding at least one <menuchoice>Nickname</menuchoice> are required:<br />
[[Image:LB-Authconfig08.png]]</translate></li>


Note that adding a new Identity is not strictly necessary. As long as you are only using a single IRC network, just filling in the Default Identity is of course enough. But even when using multiple IRC networks, using just the Default Identity for all of them can be enough, if there is no need for any of the Identity settings to differ from network to network. However because, as we will see later, the authentication settings are part of the Identity, it is usually good practice to use separate Identities for different networks, so you can use different passwords on each network for better security. Given this, click the button next to the drop-down selection labeled <menuchoice>Identity</menuchoice> to open the <menuchoice>Add Identity</menuchoice> dialog window:


[[Image:Authconfig06.png]]
<li style="text-align:left;"><span id="step9"></span><translate>
<!--T:14-->
Now it's time to get to our final objective: Adding SASL authentication settings to the new Identity for use with the Libera Chat network.<br /><br />


<!--T:15-->
(A short interlude: For the sake of brevity, and because the best and most up-to-date documentation for the account creation process is available on Libera Chat's own website, this guide assumes that you already have a Libera Chat account. If you don't have an account yet, however, click <menuchoice>Ok</menuchoice> now in the '''Identities''' dialog window and then in the '''New/Edit Network''' dialog window. You can then connect to Libera Chat unauthenticated by selecting it in the '''Server List''' dialog window and clicking the <menuchoice>Connect</menuchoice> button at the bottom of the dialog window. Once you are connected to Libera Chat you can follow their instructions to create an account. Once you're done, open the '''Server List''' dialog window again (see [[Special:myLanguage/Konversation/Configuring SASL authentication#step1|step 1]]), select Libera Chat and click  the <menuchoice>Edit...</menuchoice> button to open the '''Edit Network''' dialog window and the <menuchoice>Edit...</menuchoice> button again to open the '''Identities''' dialog. Note that you will need to reconnect after adding the authentication settings to connect authenticated.)<br /><br />


# In the <menuchoice>Add Identity</menuchoice> dialog window, enter a name for the new Identity and click the <menuchoice>Ok</menuchoice> button to get back to the <menuchoice>Identities</menuchoice> dialog window. Note that the name "Freenode" in the following screenshot is just a useful memory aid for the connection to the network; there is no need for the network and Identity name to be the same:
<!--T:16-->
To add SASL authentication settings to the Identity, focus on the group of settings labeled '''Auto-Identify''' still on the <menuchoice>General</menuchoice> tab of the '''Identities''' dialog window. The first step is to select <menuchoice>SASL</menuchoice> in the drop-down selection labeled <menuchoice>Type</menuchoice>. Then all that's left to do is to enter your Libera Chat account's name and password in the <menuchoice>Account</menuchoice> and <menuchoice>Password</menuchoice> fields below the drop-down selection and clicking the <menuchoice>Ok</menuchoice> button to save the new Identity settings:<br />
[[Image:LB-Authconfig09.png]]</translate></li>




[[Image:Authconfig07.png]]
<li style="text-align:left;"><translate>
<!--T:17-->
Now click the <menuchoice>Ok</menuchoice> button in the '''New/Edit Network''' dialog window to save the network and get back to the '''Server List''' dialog window.</translate></li>




# Back in the <menuchoice>Identities</menuchoice> dialog window, fill in the basic settings for the newly-added Identity, which has been automatically selected in the dialog (notice the drop-down selection labeled <menuchoice>Identity</menuchoice> at the top of the dialog window). Entering a <menuchoice>Real name</menuchoice> and adding at least one <menuchoice>Nickname</menuchoice> are required:
<li style="text-align:left;"><translate>
<!--T:18-->
In the '''Server List''' dialog window you can now select Libera Chat in the list and press the <menuchoice>Connect</menuchoice> button at the bottom of the dialog window (or double-click the entry) to connect to Libera Chat with SASL authentication:<br />
[[Image:LB-Authconfig10.png]]
</translate></li>
</ol>


 
<translate>
[[Image:Authconfig08.png]]
<!--T:19-->
 
[[Category:Internet]]
 
[[Category:Tutorials]]
# Now it's time to get to our final objective: Adding SASL authentication settings to our new Identity for use with the Freenode network.
</translate>
 
(A short interlude: For the sake of brevity, and because the best and most up-to-date documentation for the account creation process is available on Freenode's own website, this guide assumes that you already have a Freenode account. If you don't have an account yet, however, click <menuchoice>Ok</menuchoice> now in the <menuchoice>Identities</menuchoice> dialog window and then in the <menuchoice>New Network</menuchoice> dialog window. You can then connect to Freenode unauthenticated by selecting it in the <menuchoice>Server List</menuchoice> dialog window and clicking the <menuchoice>Connect</menuchoice> button at the bottom of the dialog window. Once you are connected to Freenode you can follow [http://freenode-dev.net/faq.shtml#nicksetup their instructions] to create an account. Once you're done, open the <menuchoice>Server List</menuchoice> dialog window again (see step 1), select Freenode and click  the <menuchoice>Edit...</menuchoice> button to open the <menuchoice>Edit Network</menuchoice> dialog window and the <menuchoice>Edit...</menuchoice> button again to open the <menuchoice>Identities</menuchoice> dialog. Note that you will need to reconnect after adding the authentication settings to connect authenticated.)
 
To add SASL authentication settings to the Identity, let's have a look at the group of settings labeled <menuchoice>Auto-Identify</menuchoice>, still on the <menuchoice>General</menuchoice> tab of the <menuchoice>Identities</menuchoice> dialog window. The first step is to select <menuchoice>SASL</menuchoice> in the drop-down selection labeled <menuchoice>Type</menuchoice>. Then all that's left to do is to enter your Freenode account's name and password in the <menuchoice>Account</menuchoice> and <menuchoice>Password</menuchoice> fields below the drop-down selection and clicking the <menuchoice>Ok</menuchoice> button to save the new Identity settings:
 
[[Image:Authconfig09.png]]
 
 
# Now click the <menuchoice>Ok</menuchoice> button in the <menuchoice>New Network</menuchoice> dialog window to save the new network and get back to the <menuchoice>Server List</menuchoice> dialog window.
 
 
# In the Server List dialog window you can now select Freenode in the list and press the <menuchoice>Connect</menuchoice> button at the bottom of the dialog window (or double-click the entry) to connect to Freenode with SASL authentication:
 
 
[[Image:Authconfig10.png]]

Latest revision as of 15:54, 21 January 2023

Other languages:

Configuring SASL authentication

This document will guide you through configuring SASL authentication for an IRC network, using the Libera Chat network as an example.

  1. Let's start by adding the network to the Server List. Open the Server List dialog window by pressing the F2 key or by clicking File -> Server List... in the application menu:



  2. If you already have an entry for Libera Chat in the Server List, select it now and then click the Edit... button to open the Edit Network dialog window and skip to step 5 (or step 4 if you're interested in learning about SSL secure transport settings for a network's servers, which complement SASL authentication). Alternatively, click the New... button in the upper-right of the window to open the New Network dialog window:
  3. In the New Network dialog window, give the network a name by filling in the Network name field. Then click the Add... button below the list labeled Servers to open the Add Server dialog window:
  4. Fill the Add Server dialog window as shown in the next screenshot. As the purpose of this guide is to ultimately configure a secure authentication method, note that we have chosen to enable SSL to also use a secure transport between us and the server, logically complementing secure authentication. Clicking the Ok button will save the server and take you back to the New Network dialog window.
  5. Back in the New Network dialog window (or Edit Network, if you skipped here from step 2), notice the newly-added server in the Servers list for the network. Now click the Edit... button next to the drop-down selection labeled Identity to open the Identities dialog window:
  6. Welcome to the Identities dialog window. This dialog window allows you to create and manage an unlimited number of Identities. An Identity is a way to store settings related to your person (such as your real name and nicknames) separately from the settings for a network, so you can for example reuse them for multiple different networks. It also makes it easy to switch between different Identity settings for a single network, by selecting the right Identity in the New Network dialog window from the preceding steps or in the similar Edit Network dialog window used to modify an existing network in the Server List. For added convenience, if you open the Identities dialog window from the New/Edit Network dialog window as we have done here (alternatively, you can open it any time by pressing F8), the Identity you are viewing at the time you press the Ok button will be automatically selected for the network.

    Because Identities are such an important concept in Konversation, this guide will now take you through adding and filling in an entirely new Identity to use with Libera Chat before turning to adding the authentication settings. If you're already familiar with managing Identities, you can skip to step 9 now.

    Note that adding a new Identity is not strictly necessary. As long as you are only using a single IRC network, just filling in the Default Identity is of course enough. But even when using multiple IRC networks, using just the Default Identity for all of them can be enough, if there is no need for any of the Identity settings to differ from network to network. However because, as we will see later, the authentication settings are part of the Identity, it is usually good practice to use separate Identities for different networks, so you can use different passwords on each network for better security. Given this, click the button next to the drop-down selection labeled Identity to open the Add Identity dialog window:
  7. In the Add Identity dialog window, enter a name for the new Identity and click the Ok button to get back to the Identities dialog window. Note that the name "libera" in the following screenshot is just a useful memory aid for the connection to the network; there is no need for the network and Identity name to be the same:
  8. Back in the Identities dialog window, fill in the basic settings for the newly-added Identity, which has been automatically selected in the dialog (notice the drop-down selection labeled Identity at the top of the dialog window). Entering a Real name and adding at least one Nickname are required:
  9. Now it's time to get to our final objective: Adding SASL authentication settings to the new Identity for use with the Libera Chat network.

    (A short interlude: For the sake of brevity, and because the best and most up-to-date documentation for the account creation process is available on Libera Chat's own website, this guide assumes that you already have a Libera Chat account. If you don't have an account yet, however, click Ok now in the Identities dialog window and then in the New/Edit Network dialog window. You can then connect to Libera Chat unauthenticated by selecting it in the Server List dialog window and clicking the Connect button at the bottom of the dialog window. Once you are connected to Libera Chat you can follow their instructions to create an account. Once you're done, open the Server List dialog window again (see step 1), select Libera Chat and click the Edit... button to open the Edit Network dialog window and the Edit... button again to open the Identities dialog. Note that you will need to reconnect after adding the authentication settings to connect authenticated.)

    To add SASL authentication settings to the Identity, focus on the group of settings labeled Auto-Identify still on the General tab of the Identities dialog window. The first step is to select SASL in the drop-down selection labeled Type. Then all that's left to do is to enter your Libera Chat account's name and password in the Account and Password fields below the drop-down selection and clicking the Ok button to save the new Identity settings:
  10. Now click the Ok button in the New/Edit Network dialog window to save the network and get back to the Server List dialog window.
  11. In the Server List dialog window you can now select Libera Chat in the list and press the Connect button at the bottom of the dialog window (or double-click the entry) to connect to Libera Chat with SASL authentication: