summaryrefslogtreecommitdiff
path: root/doc/en
diff options
context:
space:
mode:
authorSébastien Helleu <flashcode@flashtux.org>2021-06-01 21:29:55 +0200
committerSébastien Helleu <flashcode@flashtux.org>2021-06-01 21:29:55 +0200
commitf8872c415b292111515f1a62d1dda5b6eb687f1c (patch)
tree64dcc5981f741b38c4b65e210c1b0ea20a9b08eb /doc/en
parent8c57e8abd3474a23d8117ef38160b486e9a49538 (diff)
downloadweechat-f8872c415b292111515f1a62d1dda5b6eb687f1c.zip
doc: add IRC SASL SCRAM mechanisms in user's guide (issue #1628)
Diffstat (limited to 'doc/en')
-rw-r--r--doc/en/includes/autogen_user_options.en.adoc2
-rw-r--r--doc/en/weechat_user.en.adoc5
2 files changed, 5 insertions, 2 deletions
diff --git a/doc/en/includes/autogen_user_options.en.adoc b/doc/en/includes/autogen_user_options.en.adoc
index 4593d3f1f..193c623a0 100644
--- a/doc/en/includes/autogen_user_options.en.adoc
+++ b/doc/en/includes/autogen_user_options.en.adoc
@@ -2779,7 +2779,7 @@
** default value: `+""+`
* [[option_irc.server_default.sasl_mechanism]] *irc.server_default.sasl_mechanism*
-** description: pass:none[mechanism for SASL authentication: "plain" for plain text password, "scram-sha-1" for SCRAM authentication with SHA-1 algorithm, "scram-sha-256" for SCRAM authentication with SHA-256 algorithm, "scram-sha-512" for SCRAM authentication with SHA-512 algorithm, "ecdsa-nist256p-challenge" for key-based challenge authentication, "external" for authentication using client side SSL cert, "dh-blowfish" for blowfish crypted password (insecure, not recommended), "dh-aes" for AES crypted password (insecure, not recommended)]
+** description: pass:none[mechanism for SASL authentication: "plain" for plain text password, "scram-sha-1" for SCRAM authentication with SHA-1 digest algorithm, "scram-sha-256" for SCRAM authentication with SHA-256 digest algorithm, "scram-sha-512" for SCRAM authentication with SHA-512 digest algorithm, "ecdsa-nist256p-challenge" for key-based challenge authentication, "external" for authentication using client side SSL cert, "dh-blowfish" for blowfish crypted password (insecure, not recommended), "dh-aes" for AES crypted password (insecure, not recommended)]
** type: integer
** values: plain, scram-sha-1, scram-sha-256, scram-sha-512, ecdsa-nist256p-challenge, external, dh-blowfish, dh-aes
** default value: `+plain+`
diff --git a/doc/en/weechat_user.en.adoc b/doc/en/weechat_user.en.adoc
index c48efbb57..b56f72d95 100644
--- a/doc/en/weechat_user.en.adoc
+++ b/doc/en/weechat_user.en.adoc
@@ -102,7 +102,7 @@ WeeChat:
| libncursesw5-dev ^(2)^ | | Ncurses interface.
| libcurl4-gnutls-dev | | URL transfer.
| zlib1g-dev | | Compression of packets in relay plugin (weechat protocol), script plugin.
-| libgcrypt20-dev | | Secured data, IRC SASL authentication (DH-BLOWFISH/DH-AES).
+| libgcrypt20-dev | | Secured data, IRC SASL authentication.
| libgnutls28-dev | ≥ 2.2.0 ^(3)^ | SSL connection to IRC server, support of SSL in relay plugin, IRC SASL authentication (ECDSA-NIST256P-CHALLENGE).
|===
@@ -2928,6 +2928,9 @@ For more information, look at https://www.oftc.net/NickServ/CertFP
WeeChat supports SASL authentication, using different mechanisms:
* _plain_: plain text password (default)
+* _scram-sha-1_: SCRAM with SHA-1 digest algorithm
+* _scram-sha-256_: SCRAM with SHA-256 digest algorithm
+* _scram-sha-512_: SCRAM with SHA-512 digest algorithm
* _ecdsa-nist256p-challenge_: challenge with public/private key
* _external_: client side SSL cert
* _dh-blowfish_: blowfish encrypted password (*insecure*, not recommended)