diff options
| author | Sébastien Helleu <flashcode@flashtux.org> | 2021-06-25 10:44:35 +0200 |
|---|---|---|
| committer | Sébastien Helleu <flashcode@flashtux.org> | 2021-06-25 11:15:22 +0200 |
| commit | 0fb88527ce38e8b791a48802e160225aa38743cd (patch) | |
| tree | 35597e6ce0745fb98616bbb3200cc35decfe8af3 /doc/en | |
| parent | 7a0020f067922a8616e5ac313bbc59f07683e4a8 (diff) | |
| download | weechat-0fb88527ce38e8b791a48802e160225aa38743cd.zip | |
irc: implement IRCv3.2 SASL authentication, add command /auth (closes #413)
Diffstat (limited to 'doc/en')
| -rw-r--r-- | doc/en/includes/autogen_api_hdata.en.adoc | 2 | ||||
| -rw-r--r-- | doc/en/includes/autogen_user_commands.en.adoc | 20 | ||||
| -rw-r--r-- | doc/en/includes/autogen_user_options.en.adoc | 2 |
3 files changed, 23 insertions, 1 deletions
diff --git a/doc/en/includes/autogen_api_hdata.en.adoc b/doc/en/includes/autogen_api_hdata.en.adoc index 964cc0766..ef70fdb71 100644 --- a/doc/en/includes/autogen_api_hdata.en.adoc +++ b/doc/en/includes/autogen_api_hdata.en.adoc @@ -237,6 +237,8 @@ _sasl_scram_client_first_ (string) + _sasl_scram_salted_pwd_ (other) + _sasl_scram_salted_pwd_size_ (integer) + _sasl_scram_auth_message_ (string) + +_sasl_temp_username_ (string) + +_sasl_temp_password_ (string) + _is_connected_ (integer) + _ssl_connected_ (integer) + _disconnected_ (integer) + diff --git a/doc/en/includes/autogen_user_commands.en.adoc b/doc/en/includes/autogen_user_commands.en.adoc index 774d4c192..fca4c00d3 100644 --- a/doc/en/includes/autogen_user_commands.en.adoc +++ b/doc/en/includes/autogen_user_commands.en.adoc @@ -100,6 +100,26 @@ Examples: /allserv /whois $nick ---- +[[command_irc_auth]] +* `+auth+`: authenticate with SASL + +---- +/auth [<username> <password>] + +username: SASL username (content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name) +password: SASL password or path to file with private key (content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name) + +If username and password are not provided, the values from server options "sasl_username" and "sasl_password" (or "sasl_key") are used. + +Examples: + authenticate with username/password defined in the server: + /auth + authenticate as a different user: + /auth user2 password2 + authenticate as a different user with mechanism ecdsa-nist256p-challenge: + /auth user2 ${weechat_config_dir}/ecdsa2.pem +---- + [[command_irc_ban]] * `+ban+`: ban nicks or hosts diff --git a/doc/en/includes/autogen_user_options.en.adoc b/doc/en/includes/autogen_user_options.en.adoc index 56226b24d..7f1a514df 100644 --- a/doc/en/includes/autogen_user_options.en.adoc +++ b/doc/en/includes/autogen_user_options.en.adoc @@ -2782,7 +2782,7 @@ ** description: pass:none[action to perform if SASL authentication fails: "continue" to ignore the authentication problem, "reconnect" to schedule a reconnection to the server, "disconnect" to disconnect from server (see also option irc.network.sasl_fail_unavailable)] ** type: integer ** values: continue, reconnect, disconnect -** default value: `+continue+` +** default value: `+reconnect+` * [[option_irc.server_default.sasl_key]] *irc.server_default.sasl_key* ** description: pass:none[file with ECC private key for mechanism "ecdsa-nist256p-challenge" (path is evaluated, see function string_eval_path_home in plugin API reference)] |