api: add functions string_hash_binary and string_hash

1 files changed, 110 insertions, 0 deletions

diff --git a/doc/fr/weechat_plugin_api.fr.adoc b/doc/fr/weechat_plugin_api.fr.adoc
index d27ee1a87..41189dfda 100644
--- a/doc/fr/weechat_plugin_api.fr.adoc
+++ b/doc/fr/weechat_plugin_api.fr.adoc
@@ -2099,6 +2099,116 @@ char *dump = weechat_string_hex_dump (string, strlen (string), 8, " >> ", NULL);
 [NOTE]
 Cette fonction n'est pas disponible dans l'API script.
 
+==== string_hash_binary
+
+_WeeChat ≥ 2.8._
+
+Calculer le hachage des données.
+
+Prototype :
+
+[source,C]
+----
+void string_hash_binary (const char *data, int length_data, const char *hash_algo,
+                         char **hash, int *length_hash);
+----
+
+Paramètres :
+
+* _data_ : les données à hacher
+* _length_data_ : nombre d'octets à hacher dans _data_
+* _hash_algo_ : l'algorithme de hachage, voir le tableau ci-dessous
+* _hash_ : pointeur vers la variable de hachage, qui est allouée par la fonction
+  et utilisée pour stocker le résultat du hachage (NULL si erreur)
+* _length_hash_ : pointeur vers une variable utiliser pour stocker la longueur
+  du résultat du hachage (en octets) (0 si erreur)
+
+Algorithmes de hachage supportés :
+
+[width="100%",cols="4,4,4,5,12",options="header"]
+|===
+| Valeur       | Algorithme | Taille du haché | Sortie (binaire) | Notes
+| `+md5+`      | MD5        | 128 bits        | 16 octets        | *Faible*, non recommandé pour un usage cryptographique.
+| `+sha1+`     | SHA-1      | 160 bits        | 20 octets        | *Faible*, non recommandé pour un usage cryptographique.
+| `+sha224+`   | SHA-224    | 224 bits        | 28 octets        |
+| `+sha256+`   | SHA-256    | 256 bits        | 32 octets        |
+| `+sha384+`   | SHA-384    | 384 bits        | 48 octets        |
+| `+sha512+`   | SHA-512    | 512 bits        | 64 octets        |
+| `+sha3-224+` | SHA3-224   | 224 bits        | 28 octets        |
+| `+sha3-256+` | SHA3-256   | 256 bits        | 32 octets        |
+| `+sha3-384+` | SHA3-384   | 384 bits        | 48 octets        |
+| `+sha3-512+` | SHA3-512   | 512 bits        | 64 octets        |
+|===
+
+Exemple en C :
+
+[source,C]
+----
+const char *data = "abcdefghijklmnopqrstuvwxyz";
+char *hash;
+int length_hash;
+weechat_string_hash_binary (data, strlen (data), "sha256", &hash, &length_hash);
+/* hash is a binary buffer with:
+   71 c4 80 df 93 d6 ae 2f 1e fa d1 44 7c 66 c9 52 5e 31 62 18 cf 51 fc 8d 9e d8 32 f2 da f1 8b 73 */
+----
+
+[NOTE]
+Cette fonction n'est pas disponible dans l'API script.
+
+==== string_hash
+
+_WeeChat ≥ 2.8._
+
+Calculer le hachage des données, sous forme de chaîne hexadécimale.
+
+Prototype :
+
+[source,C]
+----
+char *string_hash (const char *data, int length_data, const char *hash_algo);
+----
+
+Paramètres :
+
+* _data_ : les données à hacher
+* _length_data_ : nombre d'octets à hacher dans _data_
+* _hash_algo_ : l'algorithme de hachage, voir le tableau ci-dessous
+
+Algorithmes de hachage supportés :
+
+[width="100%",cols="4,4,4,5,12",options="header"]
+|===
+| Valeur       | Algorithme | Taille du haché | Sortie (chaîne)     | Notes
+| `+md5+`      | MD5        | 128 bits        | 32 caractères hexa  | *Faible*, non recommandé pour un usage cryptographique.
+| `+sha1+`     | SHA-1      | 160 bits        | 40 caractères hexa  | *Faible*, non recommandé pour un usage cryptographique.
+| `+sha224+`   | SHA-224    | 224 bits        | 56 caractères hexa  |
+| `+sha256+`   | SHA-256    | 256 bits        | 64 caractères hexa  |
+| `+sha384+`   | SHA-384    | 384 bits        | 96 caractères hexa  |
+| `+sha512+`   | SHA-512    | 512 bits        | 128 caractères hexa |
+| `+sha3-224+` | SHA3-224   | 224 bits        | 56 caractères hexa  |
+| `+sha3-256+` | SHA3-256   | 256 bits        | 64 caractères hexa  |
+| `+sha3-384+` | SHA3-384   | 384 bits        | 96 caractères hexa  |
+| `+sha3-512+` | SHA3-512   | 512 bits        | 128 caractères hexa |
+|===
+
+Valeur de retour :
+
+* chaîne avec le résultat du hachage en hexadécimal (doit être supprimée par un
+  appel à "free" après utilisation), NULL si erreur
+
+Exemple en C :
+
+[source,C]
+----
+const char *data = "abcdefghijklmnopqrstuvwxyz";
+char *hash;
+hash = weechat_string_hash (data, strlen (data), "sha256");
+/* hash == "71c480df93d6ae2f1efad1447c66c9525e316218cf51fc8d9ed832f2daf18b73"
+----
+
+[NOTE]
+Cette fonction n'est pas disponible dans l'API script.
+
 ==== string_is_command_char
 
 _WeeChat ≥ 0.3.2._