diff options
author | Sébastien Helleu <flashcode@flashtux.org> | 2021-12-24 15:14:56 +0100 |
---|---|---|
committer | Sébastien Helleu <flashcode@flashtux.org> | 2021-12-24 16:45:57 +0100 |
commit | 498194f6fc39ce96f17f5002aab7b0aa0a5e6f67 (patch) | |
tree | 80b2d9c1ec6b43fe86aacdf8e0e93c07232966a0 /doc/fr | |
parent | d5c391b1ee57730ed6f94c3d7ee5661ceaff35f5 (diff) | |
download | weechat-498194f6fc39ce96f17f5002aab7b0aa0a5e6f67.zip |
relay: add zstd compression in weechat protocol
Option relay.network.compression_level is renamed to relay.network.compression
and is now a percentage between 0 (no compression) to 100 (best compression,
slowest).
Compression is now disabled by default in weechat protocol and must be enabled
via the `handshake` command (option `compression` has been removed from `init`
command).
Diffstat (limited to 'doc/fr')
-rw-r--r-- | doc/fr/weechat_relay_protocol.fr.adoc | 67 | ||||
-rw-r--r-- | doc/fr/weechat_user.fr.adoc | 3 |
2 files changed, 37 insertions, 33 deletions
diff --git a/doc/fr/weechat_relay_protocol.fr.adoc b/doc/fr/weechat_relay_protocol.fr.adoc index bcca20f81..51a5b7e13 100644 --- a/doc/fr/weechat_relay_protocol.fr.adoc +++ b/doc/fr/weechat_relay_protocol.fr.adoc @@ -24,7 +24,7 @@ Les termes suivants sont utilisés dans ce document : * _relay_ : il s'agit de l'extension "relay" de WeeChat, qui agit comme un "serveur" et autorise les _clients_ à se connecter * _client_ : il s'agit d'un autre logiciel, connecté au _relay_ via une - connexion réseau; dans la plupart des cas, ce _client_ est une interface + connexion réseau ; dans la plupart des cas, ce _client_ est une interface distante. [[network_diagram]] @@ -79,7 +79,7 @@ Les commandes ont le format : Les champs sont : * _id_ : identifiant du message (facultatif) qui sera envoyée dans la réponse de - _relay_; elle doit être entre parenthèses, et ne doit pas commencer par un + _relay_ ; elle doit être entre parenthèses, et ne doit pas commencer par un underscore (les identifiants commençant par un underscore sont réservés pour les messages _évènements_ de WeeChat) * _commande_ : une commande (voir le tableau ci-dessous) @@ -107,7 +107,7 @@ Liste des commandes disponibles (détail dans les chapitres suivants) : [[command_handshake]] === handshake -_WeeChat ≥ 2.9._ +_WeeChat ≥ 2.9, mis à jour dans la version 3.5._ Effectuer une poignée de main entre le client et WeeChat : cela est obligatoire dans la plupart des cas pour connaître les paramètres de la session et préparer @@ -133,10 +133,16 @@ Paramètres : (avec un hachage SHA256) *** _pbkdf2+sha512_ : mot de passe salé et haché avec l'algorithme PBKDF2 (avec un hachage SHA512) -** _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_) -*** _off_ : désactiver la compression +** _compression_ : liste des types de compression supportées par le client + (séparées par des deux-points et triées de la plus importante à la valeur + par défaut) ; si la compression est activée, les messages de _relay_ vers + le client sont compressés pour économiser de la bande passante ; + les valeurs autorisées sont : +*** _off_ : pas de compression (par défaut si l'option n'est pas donnée) +*** _zlib_ : compresser avec https://zlib.net/[zlib] _(WeeChat ≥ 0.3.7)_ +*** _zstd_ : compresser avec https://facebook.github.io/zstd/[Zstandard] : + meilleure compression et bien plus rapide que _zlib_ pour la compression et + la décompression _(WeeChat ≥ 3.5)_ Notes à propos de l'option _password_hash_algo_ : @@ -178,8 +184,9 @@ suivantes : _relay_ + le nonce client constituent le sel utilisé dans l'algorithme de hachage du mot de passe) * _compression_ : type de compression : -** _zlib_ : les messages sont compressés avec _zlib_ ** _off_ : les messages ne sont pas compressés +** _zlib_ : les messages sont compressés avec https://zlib.net/[zlib] +** _zstd_ : les messages sont compressés avec https://facebook.github.io/zstd/[Zstandard] [TIP] Avec WeeChat ≤ 2.8, la commande _handshake_ n'est pas implémentée, WeeChat ignore @@ -204,7 +211,7 @@ htb: { 'password_hash_iterations': '100000', 'totp': 'on', 'nonce': '85B1EE00695A5B254E14F4885538DF0D', - 'compression': 'zlib', + 'compression': 'off', } ---- @@ -224,7 +231,7 @@ htb: { 'password_hash_iterations': '100000', 'totp': 'on', 'nonce': '85B1EE00695A5B254E14F4885538DF0D', - 'compression': 'zlib', + 'compression': 'off', } ---- @@ -244,7 +251,7 @@ htb: { 'password_hash_iterations': '100000', 'totp': 'on', 'nonce': '85B1EE00695A5B254E14F4885538DF0D', - 'compression': 'zlib', + 'compression': 'off', } ---- @@ -256,10 +263,11 @@ le mot de passe est "test" dans cet exemple : init password_hash=pbkdf2+sha256:85b1ee00695a5b254e14f4885538df0da4b73207f5aae4:100000:ba7facc3edb89cd06ae810e29ced85980ff36de2bb596fcf513aaab626876440 ---- -* Seulement "sha256" et "sha512" sont supportés par le client, désactiver la compression : +* Seulement "sha256" et "sha512" sont supportés par le client, activer la +compression zstd (préférée) ou zlib : ---- -(handshake) handshake password_hash_algo=sha256:sha512,compression=off +(handshake) handshake password_hash_algo=sha256:sha512,compression=zstd:zlib ---- Réponse : @@ -272,7 +280,7 @@ htb: { 'password_hash_iterations': '100000', 'totp': 'on', 'nonce': '85B1EE00695A5B254E14F4885538DF0D', - 'compression': 'off', + 'compression': 'zstd', } ---- @@ -306,12 +314,6 @@ Paramètres : 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 (*obsolète* depuis la version 2.9, gardé - pour des raisons de compatibilité mais devrait être envoyé dans la - <<command_handshake,commande handshake>>) : -*** _zlib_ : activer la compression _zlib_ pour les messages envoyés par _relay_ - (activée par défaut si _relay_ supporte la compression _zlib_) -*** _off_ : désactiver la compression [NOTE] Avec WeeChat ≥ 1.6, les virgules peuvent être échappées dans la valeur, @@ -1157,16 +1159,16 @@ Syntaxe : Paramètres : * _tampon_ : pointeur (par exemple : "0x1234abcd") ou nom complet du tampon (par exemple : - _core.weechat_ ou _irc.libera.#weechat_); le nom "*" peut être utilisé pour + _core.weechat_ ou _irc.libera.#weechat_) ; le nom "*" peut être utilisé pour spécifier tous les tampons * _options_ : un ou plusieurs mots-clés, séparés par des virgules (par défaut _buffers,upgrade,buffer,nicklist_ pour "*" et _buffer,nicklist_ pour un tampon) : ** _buffers_ : recevoir les signaux à propos des tampons (ouverts/fermés, - déplacés, renommés, mélangés, masqués/démasqués); peut être utilisé seulement + déplacés, renommés, mélangés, masqués/démasqués) ; peut être utilisé seulement avec "*" _(WeeChat ≥ 0.4.1)_ ** _upgrade_ : recevoir les signaux à propos de la mise à jour de WeeChat - (mise à jour, fin de mise à jour); peut être utilisé seulement avec "*" + (mise à jour, fin de mise à jour) ; peut être utilisé seulement avec "*" _(WeeChat ≥ 0.4.1)_ ** _buffer_ : recevoir les signaux à propos du tampon (nouvelles lignes, type changé, titre changé, variable locale ajoutée/supprimée, et les même signaux @@ -1225,11 +1227,11 @@ Syntaxe : Paramètres : * _tampon_ : pointeur (par exemple : "0x1234abcd") ou nom complet du tampon (par exemple : - _core.weechat_ ou _irc.libera.#weechat_); le nom "*" peut être utilisé pour + _core.weechat_ ou _irc.libera.#weechat_) ; le nom "*" peut être utilisé pour spécifier tous les tampons * _options_ : un ou plusieurs mots-clés, séparés par des virgules (le défaut est _buffers,upgrade,buffer,nicklist_ pour "*" et _buffer,nicklist_ pour un - tampon); voir <<command_sync,la commande sync>> pour les valeurs + tampon) ; voir <<command_sync,la commande sync>> pour les valeurs [NOTE] En utilisant le tampon "*", les autres tampons synchronisés (en utilisant un @@ -1399,9 +1401,10 @@ suivant (avec la taille en octets) : (en incluant ce champ) * _compression_ (octet) : drapeau : ** _0x00_ : les données qui suivent ne sont pas compressées -** _0x01_ : les données qui suivent sont compressées avec _zlib_ +** _0x01_ : les données qui suivent sont compressées avec https://zlib.net/[zlib] +** _0x02_ : les données qui suivent sont compressées avec https://facebook.github.io/zstd/[Zstandard] * _id_ (chaîne, 4 octets + contenu) : l'identifiant envoyé par le client - (avant le nom de la commande); il peut être vide (chaîne avec une longueur + (avant le nom de la commande) ; il peut être vide (chaîne avec une longueur de zéro sans contenu) si l'identifiant n'était pas donné dans la commande * _type_ (3 caractères) : un type : 3 lettres (voir le tableau ci-dessous) * _objet_ : un objet (voir tableau ci-dessous) @@ -1409,9 +1412,9 @@ suivant (avec la taille en octets) : [[message_compression]] === Compression -Si le drapeau de _compression_ est égal à 0x01, alors *toutes* les données après -sont compressées avec _zlib_, et par conséquent doivent être décompressées avant -d'être utilisées. +Si le drapeau de _compression_ est égal à 0x01 ou 0x02, alors *toutes* les données +après sont compressées avec https://zlib.net/[zlib] ou https://facebook.github.io/zstd/[Zstandard], +et par conséquent doivent être décompressées avant d'être utilisées. [[message_identifier]] === Identifiant @@ -2473,7 +2476,7 @@ Une chaîne _NULL_ (pointeur NULL en C) a une longueur de -1 : [[object_buffer]] ==== Tampon de données -Même format que l'objet <<object_string,chaîne>>; le contenu est simplement un +Même format que l'objet <<object_string,chaîne>> ; le contenu est simplement un tableau d'octets. [[object_pointer]] @@ -2556,7 +2559,7 @@ objets). .... * _h-path_ (chaîne) : chemin utilise pour atteindre le hdata (exemple : - _buffer/lines/line/line_data_); le dernier élément du chemin est le hdata + _buffer/lines/line/line_data_) ; le dernier élément du chemin est le hdata retourné * _keys_ (chaînes) : chaîne avec une liste de _clé:type_ (séparés par des virgules), exemple : _number:int,name:str_ diff --git a/doc/fr/weechat_user.fr.adoc b/doc/fr/weechat_user.fr.adoc index 48949e51f..dfcbfe7cb 100644 --- a/doc/fr/weechat_user.fr.adoc +++ b/doc/fr/weechat_user.fr.adoc @@ -104,9 +104,10 @@ Le tableau suivant liste les paquets *requis* pour compiler WeeChat : | pkg-config | | Détection des bibliothèques installées. | libncursesw5-dev ^(2)^ | | Interface ncurses. | libcurl4-gnutls-dev | | Transfert d'URL. -| zlib1g-dev | | Compression des paquets dans l'extension relay (protocole weechat), extension script. | libgcrypt20-dev | | Données sécurisées, authentification IRC SASL. | libgnutls28-dev | ≥ 2.2.0 ^(3)^ | Connexion SSL au serveur IRC, support SSL dans l'extension relay, authentification IRC SASL (ECDSA-NIST256P-CHALLENGE). +| zlib1g-dev | | Compression des messages (WeeChat -> client) avec https://zlib.net/[zlib] dans l'extension relay (protocole weechat), extension script. +| libzstd-dev | | Compression des messages (WeeChat -> client) avec https://facebook.github.io/zstd/[Zstandard] dans l'extension relay (protocole weechat). |=== [NOTE] |