summaryrefslogtreecommitdiff
path: root/doc/en/weechat_relay_protocol.en.adoc
diff options
context:
space:
mode:
authorSébastien Helleu <flashcode@flashtux.org>2020-03-02 00:46:10 +0100
committerSébastien Helleu <flashcode@flashtux.org>2020-03-02 00:46:10 +0100
commit2d2b49bfaa8b5585f57c45501e2f22b452123d62 (patch)
tree3afd97132915fdfa97adb3f8035d447917e0957e /doc/en/weechat_relay_protocol.en.adoc
parent1882686f8a16da7037b65c7be58cd1d00807cd9c (diff)
downloadweechat-2d2b49bfaa8b5585f57c45501e2f22b452123d62.zip
relay: accept hash of password in init command with option "password_hash"
Allowed algorithms are: * PBKDF2 (SHA256 or SHA512, salt, iterations) * SHA256 * SHA512
Diffstat (limited to 'doc/en/weechat_relay_protocol.en.adoc')
-rw-r--r--doc/en/weechat_relay_protocol.en.adoc23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/en/weechat_relay_protocol.en.adoc b/doc/en/weechat_relay_protocol.en.adoc
index ef2a9293b..3ff6bc116 100644
--- a/doc/en/weechat_relay_protocol.en.adoc
+++ b/doc/en/weechat_relay_protocol.en.adoc
@@ -116,6 +116,9 @@ Arguments:
* _option_: one of following options:
** _password_: password used to authenticate on _relay_
(option _relay.network.password_ in WeeChat)
+** _password_hash_: hash of password used to authenticate on _relay_
+ (option _relay.network.password_ in WeeChat), see below for the format
+ _(WeeChat ≥ 2.8)_
** _totp_: Time-based One-Time Password (TOTP) used as secondary authentication
factor, in addition to the password
(option _relay.network.totp_secret_ in WeeChat)
@@ -129,6 +132,17 @@ Arguments:
With WeeChat ≥ 1.6, commas can be escaped in the value, for example
`init password=foo\,bar` to send the password "foo,bar".
+Format of hashed password is one of the following, where _hash_ is the hashed
+password as hexadecimal:
+
+* `+sha256:hash+`
+* `+sha512:hash+`
+* `+pbkdf2:algorithm:salt:iterations:hash+` with:
+** _algorithm_: _sha256_ or _sha512_
+** _salt_: salt (hexadecimal)
+** _iterations_: number of iterations
+** _hash_: the hashed password (hexadecimal)
+
Examples:
----
@@ -143,6 +157,15 @@ init password=mypass,totp=123456
# initialize and disable compression
init password=mypass,compression=off
+
+# initialize with hashed password (SHA256) (WeeChat ≥ 2.8)
+init password_hash=sha256:b9a4c3393dfac4330736684510378851e581c68add8eca84110c31a33e694676
+
+# initialize with hashed password (SHA512) (WeeChat ≥ 2.8)
+init password_hash=sha512:4469190d4e0d1fdc0afb6f408d9873c89b8ce89cc4db79fe058255c55ad6821fa5e9bb068f9e578c8ae7cc825d85ff99c439d59e439bc589d95620a1e6b8ae6e
+
+# initialize with hashed password (PBKDF2: SHA256, salt="ABCDEFGHIJKLMNOP", 100000 iterations) (WeeChat ≥ 2.8)
+init password_hash=pbkdf2:sha256:4142434445464748494a4b4c4d4e4f50:100000:01757d53157ca14a1419e3a8cc1563536520a60b76d2d48e7f9ac09afc945a1c
----
[[command_hdata]]