api: add function crypto_hash_file

6 files changed, 143 insertions, 1 deletions

diff --git a/src/core/wee-crypto.c b/src/core/wee-crypto.c
index 00ee3292c..f99d7aac0 100644
--- a/src/core/wee-crypto.c
+++ b/src/core/wee-crypto.c
@@ -26,6 +26,7 @@
 #include <stdlib.h>
 #include <stdio.h>
 #include <stdint.h>
+#include <sys/stat.h>
 #include <time.h>
 #include <math.h>
 #include <gcrypt.h>
@@ -160,6 +161,105 @@ hash_end:
 }
 
 /*
+ * Computes hash of file using the given hash algorithm.
+ *
+ * The hash size depends on the algorithm, common ones are:
+ *
+ *   GCRY_MD_CRC32      32 bits ==  4 bytes
+ *   GCRY_MD_MD5       128 bits == 16 bytes
+ *   GCRY_MD_SHA1      160 bits == 20 bytes
+ *   GCRY_MD_SHA224    224 bits == 28 bytes
+ *   GCRY_MD_SHA256    256 bits == 32 bytes
+ *   GCRY_MD_SHA384    384 bits == 48 bytes
+ *   GCRY_MD_SHA512    512 bits == 64 bytes
+ *   GCRY_MD_SHA3_224  224 bits == 28 bytes (libgcrypt ≥ 1.7.0)
+ *   GCRY_MD_SHA3_256  256 bits == 32 bytes (libgcrypt ≥ 1.7.0)
+ *   GCRY_MD_SHA3_384  384 bits == 48 bytes (libgcrypt ≥ 1.7.0)
+ *   GCRY_MD_SHA3_512  512 bits == 64 bytes (libgcrypt ≥ 1.7.0)
+ *
+ * The result hash is stored in "hash" (the buffer must be large enough).
+ *
+ * If hash_size is not NULL, the length of hash is stored in *hash_size
+ * (in bytes).
+ *
+ * Returns:
+ *   1: OK
+ *   0: error
+ */
+
+int
+weecrypto_hash_file (const char *filename, int hash_algo,
+                     void *hash, int *hash_size)
+{
+    gcry_md_hd_t *hd_md;
+    struct stat st;
+    FILE *file;
+    size_t num_read;
+    int rc, hd_md_opened, algo_size;
+    unsigned char *ptr_hash;
+    char buffer[4096];
+
+    rc = 0;
+    hd_md = NULL;
+    hd_md_opened = 0;
+    file = NULL;
+
+    if (!hash)
+        goto hash_end;
+
+    if (hash_size)
+        *hash_size = 0;
+
+    if (!filename || !filename[0] || !hash)
+        goto hash_end;
+
+    if (stat (filename, &st) == -1)
+        goto hash_end;
+
+    file = fopen (filename, "r");
+    if (!file)
+        goto hash_end;
+
+    hd_md = malloc (sizeof (gcry_md_hd_t));
+    if (!hd_md)
+        goto hash_end;
+
+    if (gcry_md_open (hd_md, hash_algo, 0) != 0)
+        goto hash_end;
+
+    hd_md_opened = 1;
+
+    while (!feof (file))
+    {
+        num_read = fread (buffer, 1, sizeof (buffer), file);
+        if (num_read == 0)
+            break;
+        gcry_md_write (*hd_md, buffer, num_read);
+    }
+
+    ptr_hash = gcry_md_read (*hd_md, hash_algo);
+    if (!ptr_hash)
+        goto hash_end;
+
+    algo_size = gcry_md_get_algo_dlen (hash_algo);
+    memcpy (hash, ptr_hash, algo_size);
+    if (hash_size)
+        *hash_size = algo_size;
+
+    rc = 1;
+
+hash_end:
+    if (hd_md)
+    {
+        if (hd_md_opened)
+            gcry_md_close (*hd_md);
+        free (hd_md);
+    }
+    if (file)
+        fclose (file);
+    return rc;
+}
+/*
  * Computes PKCS#5 Passphrase Based Key Derivation Function number 2 (PBKDF2)
  * hash of data.
  *
diff --git a/src/core/wee-crypto.h b/src/core/wee-crypto.h
index fd7675b9e..863bccb23 100644
--- a/src/core/wee-crypto.h
+++ b/src/core/wee-crypto.h
@@ -26,6 +26,8 @@
 extern int weecrypto_get_hash_algo (const char *hash_algo);
 extern int weecrypto_hash (const void *data, int data_size, int hash_algo,
                            void *hash, int *hash_size);
+extern int weecrypto_hash_file (const char *filename, int hash_algo,
+                                void *hash, int *hash_size);
 extern int weecrypto_hash_pbkdf2 (const void *data, int data_size,
                                   int hash_algo,
                                   const void *salt, int salt_size,
diff --git a/src/plugins/plugin-api.c b/src/plugins/plugin-api.c
index 3ae8a6332..d4a374899 100644
--- a/src/plugins/plugin-api.c
+++ b/src/plugins/plugin-api.c
@@ -128,6 +128,36 @@ plugin_api_crypto_hash (const void *data, int data_size, const char *hash_algo,
 }
 
 /*
+ * Computes hash of a file using the given algorithm.
+ *
+ * Returns:
+ *   1: OK
+ *   0: error
+ */
+
+int
+plugin_api_crypto_hash_file (const char *filename, const char *hash_algo,
+                             void *hash, int *hash_size)
+{
+    int algo;
+
+    if (!hash)
+        return 0;
+
+    if (hash_size)
+        *hash_size = 0;
+
+    if (!filename || !filename[0] || !hash_algo)
+        return 0;
+
+    algo = weecrypto_get_hash_algo (hash_algo);
+    if (algo == GCRY_MD_NONE)
+        return 0;
+
+    return weecrypto_hash_file (filename, algo, hash, hash_size);
+}
+
+/*
  * Computes PKCS#5 Passphrase Based Key Derivation Function number 2 (PBKDF2)
  * hash of data.
  *
diff --git a/src/plugins/plugin-api.h b/src/plugins/plugin-api.h
index 4eed26145..6cc6f1646 100644
--- a/src/plugins/plugin-api.h
+++ b/src/plugins/plugin-api.h
@@ -33,6 +33,9 @@ extern const char *plugin_api_ngettext (const char *single, const char *plural,
 extern int plugin_api_crypto_hash (const void *data, int data_size,
                                    const char *hash_algo,
                                    void *hash, int *hash_size);
+extern int plugin_api_crypto_hash_file (const char *filename,
+                                        const char *hash_algo,
+                                        void *hash, int *hash_size);
 extern int plugin_api_crypto_hash_pbkdf2 (const void *data, int data_size,
                                           const char *hash_algo,
                                           const void *salt, int salt_size,
diff --git a/src/plugins/plugin.c b/src/plugins/plugin.c
index 7f8e2b424..42a940656 100644
--- a/src/plugins/plugin.c
+++ b/src/plugins/plugin.c
@@ -665,6 +665,7 @@ plugin_load (const char *filename, int init_plugin, int argc, char **argv)
         new_plugin->utf8_strndup = &utf8_strndup;
 
         new_plugin->crypto_hash = &plugin_api_crypto_hash;
+        new_plugin->crypto_hash_file = &plugin_api_crypto_hash_file;
         new_plugin->crypto_hash_pbkdf2 = &plugin_api_crypto_hash_pbkdf2;
         new_plugin->crypto_hmac = &plugin_api_crypto_hmac;
 
diff --git a/src/plugins/weechat-plugin.h b/src/plugins/weechat-plugin.h
index 43e04964c..bd0595591 100644
--- a/src/plugins/weechat-plugin.h
+++ b/src/plugins/weechat-plugin.h
@@ -68,7 +68,7 @@ struct timeval;
  * please change the date with current one; for a second change at same
  * date, increment the 01, otherwise please keep 01.
  */
-#define WEECHAT_PLUGIN_API_VERSION "20220720-02"
+#define WEECHAT_PLUGIN_API_VERSION "20220816-01"
 
 /* macros for defining plugin infos */
 #define WEECHAT_PLUGIN_NAME(__name)                                     \
@@ -380,6 +380,8 @@ struct t_weechat_plugin
     /* crypto */
     int (*crypto_hash) (const void *data, int data_size,
                         const char *hash_algo, void *hash, int *hash_size);
+    int (*crypto_hash_file) (const char *fliename,
+                             const char *hash_algo, void *hash, int *hash_size);
     int (*crypto_hash_pbkdf2) (const void *data, int data_size,
                                const char *hash_algo,
                                const void *salt, int salt_size,
@@ -1372,6 +1374,10 @@ extern int weechat_plugin_end (struct t_weechat_plugin *plugin);
                             __hash, __hash_size)                        \
     (weechat_plugin->crypto_hash)(__data, __data_size, __hash_algo,     \
                                   __hash, __hash_size)
+#define weechat_crypto_hash_file(__filename, __hash_algo, __hash,       \
+                                 __hash_size)                           \
+    (weechat_plugin->crypto_hash_file)(__filename, __hash_algo, __hash, \
+                                       __hash_size)
 #define weechat_crypto_hash_pbkdf2(__data, __data_size, __hash_algo,    \
                                    __salt, __salt_size, __iterations,   \
                                    __hash, __hash_size)                 \