summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/de/weechat_user.de.adoc29
-rw-r--r--doc/en/weechat_relay_protocol.en.adoc11
-rw-r--r--doc/en/weechat_user.en.adoc28
-rw-r--r--doc/fr/weechat_relay_protocol.fr.adoc11
-rw-r--r--doc/fr/weechat_user.fr.adoc30
-rw-r--r--doc/it/weechat_user.it.adoc29
-rw-r--r--doc/ja/weechat_relay_protocol.ja.adoc13
-rw-r--r--doc/ja/weechat_user.ja.adoc29
-rw-r--r--doc/pl/weechat_user.pl.adoc29
9 files changed, 203 insertions, 6 deletions
diff --git a/doc/de/weechat_user.de.adoc b/doc/de/weechat_user.de.adoc
index 109780656..b5636e093 100644
--- a/doc/de/weechat_user.de.adoc
+++ b/doc/de/weechat_user.de.adoc
@@ -3233,6 +3233,35 @@ Es wird nachdrücklich Empfohlen ein Passwort für die Relay-Verbindung zu nutze
Dieses Passwort wird sowohl für das _irc_ als auch für das _weechat_ Protokoll
verwendet.
+// TRANSLATION MISSING
+[[relay_totp]]
+==== TOTP
+
+TOTP (Time-based One-Time Password) can be used as secondary authentication
+factor for _weechat_ protocol, in addition to the password.
+
+This is optional and increases the security level.
+
+One-time passwords can be generated with applications, for example:
+
+* FreeOTP:
+ https://play.google.com/store/apps/details?id=org.fedorahosted.freeotp[Android],
+ https://itunes.apple.com/fr/app/freeotp-authenticator/id872559395[iOS]
+ (https://freeotp.github.io/[web site])
+* Google Authenticator:
+ https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2[Android],
+ https://itunes.apple.com/fr/app/google-authenticator/id388497605[iOS]
+
+The TOTP secret must be set in WeeChat and the application used to generate
+one-time passwords.
+
+It must be a string encoded in base32, with only letters and digits from 2 to 7,
+for example:
+
+----
+/set relay.network.totp_secret "secretpasswordbase32"
+----
+
[[relay_ssl]]
==== SSL
diff --git a/doc/en/weechat_relay_protocol.en.adoc b/doc/en/weechat_relay_protocol.en.adoc
index afe0a0c1a..ac6999471 100644
--- a/doc/en/weechat_relay_protocol.en.adoc
+++ b/doc/en/weechat_relay_protocol.en.adoc
@@ -114,8 +114,12 @@ init [<option>=<value>,[<option>=<value>,...]]
Arguments:
* _option_: one of following options:
-** _password_: password used to authenticate on _relay_ (option
- _relay.network.password_ in WeeChat)
+** _password_: password used to authenticate on _relay_
+ (option _relay.network.password_ in WeeChat)
+** _totp_: Time-based One-Time Password (TOTP) used as secondary authentication
+ factor, in addition to the password
+ (option _relay.network.totp_secret_ in WeeChat)
+ _(WeeChat ≥ 2.4)_
** _compression_: compression type:
*** _zlib_: enable _zlib_ compression for messages sent by _relay_
(enabled by default if _relay_ supports _zlib_ compression)
@@ -134,6 +138,9 @@ init password=mypass
# initialize with commas in the password (WeeChat ≥ 1.6)
init password=mypass\,with\,commas
+# initialize with password and TOTP (WeeChat ≥ 2.4)
+init password=mypass,totp=123456
+
# initialize and disable compression
init password=mypass,compression=off
----
diff --git a/doc/en/weechat_user.en.adoc b/doc/en/weechat_user.en.adoc
index efbcff4fe..361c452b7 100644
--- a/doc/en/weechat_user.en.adoc
+++ b/doc/en/weechat_user.en.adoc
@@ -3161,6 +3161,34 @@ It is highly recommended to set a password for relay, with command:
This password is used for _irc_ and _weechat_ protocols.
+[[relay_totp]]
+==== TOTP
+
+TOTP (Time-based One-Time Password) can be used as secondary authentication
+factor for _weechat_ protocol, in addition to the password.
+
+This is optional and increases the security level.
+
+One-time passwords can be generated with applications, for example:
+
+* FreeOTP:
+ https://play.google.com/store/apps/details?id=org.fedorahosted.freeotp[Android],
+ https://itunes.apple.com/fr/app/freeotp-authenticator/id872559395[iOS]
+ (https://freeotp.github.io/[web site])
+* Google Authenticator:
+ https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2[Android],
+ https://itunes.apple.com/fr/app/google-authenticator/id388497605[iOS]
+
+The TOTP secret must be set in WeeChat and the application used to generate
+one-time passwords.
+
+It must be a string encoded in base32, with only letters and digits from 2 to 7,
+for example:
+
+----
+/set relay.network.totp_secret "secretpasswordbase32"
+----
+
[[relay_ssl]]
==== SSL
diff --git a/doc/fr/weechat_relay_protocol.fr.adoc b/doc/fr/weechat_relay_protocol.fr.adoc
index 353345496..cb1800d45 100644
--- a/doc/fr/weechat_relay_protocol.fr.adoc
+++ b/doc/fr/weechat_relay_protocol.fr.adoc
@@ -119,8 +119,12 @@ init [<option>=<valeur>,[<option>=<valeur>,...]]
Paramètres :
* _option_ : une des options suivantes :
-** _password_ : mot de passe utilisé pour s'authentifier avec _relay_ (option
- _relay.network.password_ dans WeeChat)
+** _password_ : mot de passe utilisé pour s'authentifier avec _relay_
+ (option _relay.network.password_ dans WeeChat)
+** _totp_ : mot de passe à usage unique basé sur le temps (TOTP : Time-based
+ One-Time Password) utilisé comme second facteur d'authentification, en plus
+ du mot de passe (option _relay.network.totp_secret_ dans WeeChat)
+ _(WeeChat ≥ 2.4)_
** _compression_ : type de compression :
*** _zlib_ : activer la compression _zlib_ pour les messages envoyés par _relay_
(activée par défaut si _relay_ supporte la compression _zlib_)
@@ -139,6 +143,9 @@ init password=mypass
# initialiser avec des virgules dans le mot de passe (WeeChat ≥ 1.6)
init password=mypass\,avec\,virgules
+# initialiser avec le mot de passe et TOTP (WeeChat ≥ 2.4)
+init password=mypass,totp=123456
+
# initialiser et désactiver la compression
init password=mypass,compression=off
----
diff --git a/doc/fr/weechat_user.fr.adoc b/doc/fr/weechat_user.fr.adoc
index 9a627fbb2..45c1d1e23 100644
--- a/doc/fr/weechat_user.fr.adoc
+++ b/doc/fr/weechat_user.fr.adoc
@@ -3261,6 +3261,36 @@ commande :
Ce mot de passe sera utilisé pour les protocoles _irc_ et _weechat_.
+[[relay_totp]]
+==== TOTP
+
+TOTP (« Time-based One-Time Password » : mot de passe à usage unique basé sur le
+temps) peut être utilisé comme second facteur d'authentification pour le protocole
+_weechat_, en plus du mot de passe.
+
+Il est optionnel et augmente le niveau de sécurité.
+
+Les mots de passe à usage unique peuvent être générés avec des applications,
+par exemple :
+
+* FreeOTP :
+ https://play.google.com/store/apps/details?id=org.fedorahosted.freeotp[Android],
+ https://itunes.apple.com/fr/app/freeotp-authenticator/id872559395[iOS]
+ (https://freeotp.github.io/[site web])
+* Google Authenticator :
+ https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2[Android],
+ https://itunes.apple.com/fr/app/google-authenticator/id388497605[iOS]
+
+Le « secret » TOTP doit être défini dans WeeChat et dans l'application utilisée
+pour générer les mots de passe à usage unique.
+
+Il doit être une chaîne encodée en base32, avec seulement des lettres et des
+chiffres de 2 à 7, par exemple :
+
+----
+/set relay.network.totp_secret "secretpasswordbase32"
+----
+
[[relay_ssl]]
==== SSL
diff --git a/doc/it/weechat_user.it.adoc b/doc/it/weechat_user.it.adoc
index 4137555ab..ed973e96d 100644
--- a/doc/it/weechat_user.it.adoc
+++ b/doc/it/weechat_user.it.adoc
@@ -3373,6 +3373,35 @@ It is highly recommended to set a password for relay, with command:
This password is used for _irc_ and _weechat_ protocols.
+// TRANSLATION MISSING
+[[relay_totp]]
+==== TOTP
+
+TOTP (Time-based One-Time Password) can be used as secondary authentication
+factor for _weechat_ protocol, in addition to the password.
+
+This is optional and increases the security level.
+
+One-time passwords can be generated with applications, for example:
+
+* FreeOTP:
+ https://play.google.com/store/apps/details?id=org.fedorahosted.freeotp[Android],
+ https://itunes.apple.com/fr/app/freeotp-authenticator/id872559395[iOS]
+ (https://freeotp.github.io/[web site])
+* Google Authenticator:
+ https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2[Android],
+ https://itunes.apple.com/fr/app/google-authenticator/id388497605[iOS]
+
+The TOTP secret must be set in WeeChat and the application used to generate
+one-time passwords.
+
+It must be a string encoded in base32, with only letters and digits from 2 to 7,
+for example:
+
+----
+/set relay.network.totp_secret "secretpasswordbase32"
+----
+
[[relay_ssl]]
==== SSL
diff --git a/doc/ja/weechat_relay_protocol.ja.adoc b/doc/ja/weechat_relay_protocol.ja.adoc
index 2fa3181e4..172eedfc9 100644
--- a/doc/ja/weechat_relay_protocol.ja.adoc
+++ b/doc/ja/weechat_relay_protocol.ja.adoc
@@ -121,8 +121,13 @@ init [<option>=<value>,[<option>=<value>,...]]
引数:
* _option_: 以下のうちの 1 つ:
-** _password_: _リレー_ の認証用パスワード (WeeChat の
- _relay.network.password_ オプション)
+** _password_: _リレー_ の認証用パスワード
+ (WeeChat の _relay.network.password_ オプション)
+// TRANSLATION MISSING
+** _totp_: Time-based One-Time Password (TOTP) used as secondary authentication
+ factor, in addition to the password
+ (WeeChat の _relay.network.totp_secret_ オプション)
+ _(WeeChat ≥ 2.4)_
** _compression_: 圧縮タイプ:
*** _zlib_: _リレー_ から受信するメッセージに対して _zlib_ 圧縮を使う
(_リレー_ が _zlib_ 圧縮をサポートしている場合、デフォルトで有効化されます)
@@ -132,6 +137,7 @@ init [<option>=<value>,[<option>=<value>,...]]
WeeChat バージョン 1.6 以上の場合、コンマをエスケープすることで value にコンマを設定可能です。例えば
"foo,bar" というパスワードを送信するには `init password=foo\,bar` のように設定してください。
+// TRANSLATION MISSING
例:
----
@@ -141,6 +147,9 @@ init password=mypass
# パスワードにコンマを含む値を設定する例 (WeeChat バージョン 1.6 以上の場合)
init password=mypass\,with\,commas
+# initialize with password and TOTP (WeeChat ≥ 2.4)
+init password=mypass,totp=123456
+
# 圧縮を使わない例
init password=mypass,compression=off
----
diff --git a/doc/ja/weechat_user.ja.adoc b/doc/ja/weechat_user.ja.adoc
index b8161f9a4..5b3c92bd9 100644
--- a/doc/ja/weechat_user.ja.adoc
+++ b/doc/ja/weechat_user.ja.adoc
@@ -3155,6 +3155,35 @@ Relay プラグインはネットワークを介して異なるプロトコル
このパスワードは _irc_ と _weechat_ プロトコルで利用されます。
+// TRANSLATION MISSING
+[[relay_totp]]
+==== TOTP
+
+TOTP (Time-based One-Time Password) can be used as secondary authentication
+factor for _weechat_ protocol, in addition to the password.
+
+This is optional and increases the security level.
+
+One-time passwords can be generated with applications, for example:
+
+* FreeOTP:
+ https://play.google.com/store/apps/details?id=org.fedorahosted.freeotp[Android],
+ https://itunes.apple.com/fr/app/freeotp-authenticator/id872559395[iOS]
+ (https://freeotp.github.io/[web site])
+* Google Authenticator:
+ https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2[Android],
+ https://itunes.apple.com/fr/app/google-authenticator/id388497605[iOS]
+
+The TOTP secret must be set in WeeChat and the application used to generate
+one-time passwords.
+
+It must be a string encoded in base32, with only letters and digits from 2 to 7,
+for example:
+
+----
+/set relay.network.totp_secret "secretpasswordbase32"
+----
+
[[relay_ssl]]
==== SSL
diff --git a/doc/pl/weechat_user.pl.adoc b/doc/pl/weechat_user.pl.adoc
index 295a287c5..e17a050a6 100644
--- a/doc/pl/weechat_user.pl.adoc
+++ b/doc/pl/weechat_user.pl.adoc
@@ -3186,6 +3186,35 @@ Zalecane jest ustawienie hasła dla pośrednika, za pomocą komendy:
Hasło to używane jest przez protokoły _irc_ i _weechat_.
+// TRANSLATION MISSING
+[[relay_totp]]
+==== TOTP
+
+TOTP (Time-based One-Time Password) can be used as secondary authentication
+factor for _weechat_ protocol, in addition to the password.
+
+This is optional and increases the security level.
+
+One-time passwords can be generated with applications, for example:
+
+* FreeOTP:
+ https://play.google.com/store/apps/details?id=org.fedorahosted.freeotp[Android],
+ https://itunes.apple.com/fr/app/freeotp-authenticator/id872559395[iOS]
+ (https://freeotp.github.io/[web site])
+* Google Authenticator:
+ https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2[Android],
+ https://itunes.apple.com/fr/app/google-authenticator/id388497605[iOS]
+
+The TOTP secret must be set in WeeChat and the application used to generate
+one-time passwords.
+
+It must be a string encoded in base32, with only letters and digits from 2 to 7,
+for example:
+
+----
+/set relay.network.totp_secret "secretpasswordbase32"
+----
+
[[relay_ssl]]
==== SSL