Replace MD5Context with GChecksum
authorArkadiy Illarionov <qarkai@gmail.com>
Sun, 30 Jul 2023 15:58:49 +0000 (18:58 +0300)
committerColin Clark <colin.clark@cclark.uk>
Sun, 30 Jul 2023 16:39:25 +0000 (17:39 +0100)
- Replace md5_get_digest with md5_get_string
- Add md5_get_string_from_file
- Add MD5_SIZE constant

src/md5-util.cc
src/md5-util.h
src/thumb-standard.cc
src/ui-fileops.cc

index 75154e0..bc8c374 100644 (file)
  * This code has been tested against that, and is equivalent,
  * except that you don't need to include two pages of legalese
  * with every copy.
- *
- * To compute the message digest of a chunk of bytes, declare an
- * MD5Context structure, pass it to md5_init, call md5_update as
- * needed on buffers full of bytes, and then call md5_Final, which
- * will fill a supplied 16-byte array with the digest.
  */
 
 #include "md5-util.h"
+
 #include <cstdio>
 #include <cstring>
+#include <memory>
 
+using GQChecksumPtr = std::unique_ptr<GChecksum, decltype(&g_checksum_free)>;
 
-static void md5_transform(guint32 buf[4], const guint32 in[16]);
-
-static gint _ie = 0x44332211;
-static union _endian { gint i; gchar b[4]; } *_endian = reinterpret_cast<union _endian *>(&_ie);
-#define        IS_BIG_ENDIAN()         (_endian->b[0] == '\x44')
-#define        IS_LITTLE_ENDIAN()      (_endian->b[0] == '\x11')
-
-
-/*
- * Note: this code is harmless on little-endian machines.
- */
-static void
-_byte_reverse(guchar *buf, guint32 longs)
-{
-       guint32 t;
-       do {
-               t = static_cast<guint32>(static_cast<guint32>(buf[3]) << 8 | buf[2]) << 16 |
-                       (static_cast<guint32>(buf[1]) << 8 | buf[0]);
-               *reinterpret_cast<guint32 *>(buf) = t;
-               buf += 4;
-       } while (--longs);
-}
+constexpr gsize MD5_SIZE = 16;
 
 /**
- * md5_init: Initialise an md5 context object
- * @ctx: md5 context
- *
- * Initialise an md5 buffer.
- *
- **/
-void
-md5_init(MD5Context *ctx)
-{
-       ctx->buf[0] = 0x67452301;
-       ctx->buf[1] = 0xefcdab89;
-       ctx->buf[2] = 0x98badcfe;
-       ctx->buf[3] = 0x10325476;
-
-       ctx->bits[0] = 0;
-       ctx->bits[1] = 0;
-
-       if (IS_BIG_ENDIAN())
-               ctx->doByteReverse = 1;
-       else
-               ctx->doByteReverse = 0;
-}
-
-
-
-/**
- * md5_update: add a buffer to md5 hash computation
- * @ctx: context object used for md5 computation
- * @buf: buffer to add
- * @len: buffer length
+ * md5_update_from_file: get the md5 hash of a file
+ * @md5: MD5 checksumming context
+ * @path: file name
+ * @return: TRUE on success
  *
- * Update context to reflect the concatenation of another buffer full
- * of bytes. Use this to progressively construct an md5 hash.
+ * Get the md5 hash of a file.
  **/
-void
-md5_update(MD5Context *ctx, const guchar *buf, guint32 len)
+static gboolean md5_update_from_file(GChecksum *md5, const gchar *path)
 {
-       guint32 t;
-
-       /* Update bitcount */
-
-       t = ctx->bits[0];
-       if ((ctx->bits[0] = t + (len << 3)) < t)
-               ctx->bits[1]++;         /* Carry from low to high */
-       ctx->bits[1] += len >> 29;
-
-       t = (t >> 3) & 0x3f;    /* Bytes already in shsInfo->data */
-
-       /* Handle any leading odd-sized chunks */
+       guchar tmp_buf[1024];
+       gint nb_bytes_read;
+       FILE *fp;
+       gint success;
 
-       if (t) {
-               auto p = (guchar *) ctx->in + t;
+       fp = fopen(path, "r");
+       if (!fp) return FALSE;
 
-               t = 64 - t;
-               if (len < t) {
-                       memcpy(p, buf, len);
-                       return;
+       while ((nb_bytes_read = fread(tmp_buf, sizeof (guchar), sizeof(tmp_buf), fp)) > 0)
+               {
+               g_checksum_update(md5, tmp_buf, nb_bytes_read);
                }
-               memcpy(p, buf, t);
-               if (ctx->doByteReverse)
-                       _byte_reverse(ctx->in, 16);
-               md5_transform(ctx->buf, reinterpret_cast<guint32 *>(ctx->in));
-               buf += t;
-               len -= t;
-       }
-       /* Process data in 64-byte chunks */
-
-       while (len >= 64) {
-               memcpy(ctx->in, buf, 64);
-               if (ctx->doByteReverse)
-                       _byte_reverse(ctx->in, 16);
-               md5_transform(ctx->buf, reinterpret_cast<guint32 *>(ctx->in));
-               buf += 64;
-               len -= 64;
-       }
-
-       /* Handle any remaining bytes of data. */
-
-       memcpy(ctx->in, buf, len);
-}
-
-
-/*
- * Final wrapup - pad to 64-byte boundary with the bit pattern
- * 1 0* (64-bit count of bits processed, MSB-first)
- */
-/**
- * md5_final: copy the final md5 hash to a buffer
- * @digest: 16 bytes buffer
- * @ctx: context containing the calculated md5
- *
- * copy the final md5 hash to a buffer
- **/
-void
-md5_final(MD5Context *ctx, guchar digest[16])
-{
-       guint32 count;
-       guchar *p;
-
-       /* Compute number of bytes mod 64 */
-       count = (ctx->bits[0] >> 3) & 0x3F;
-
-       /* Set the first char of padding to 0x80.  This is safe since there is
-          always at least one byte free */
-       p = ctx->in + count;
-       *p++ = 0x80;
-
-       /* Bytes of padding needed to make 64 bytes */
-       count = 64 - 1 - count;
-
-       /* Pad out to 56 mod 64 */
-       if (count < 8) {
-               /* Two lots of padding:  Pad the first block to 64 bytes */
-               memset(p, 0, count);
-               if (ctx->doByteReverse)
-                       _byte_reverse(ctx->in, 16);
-               md5_transform(ctx->buf, reinterpret_cast<guint32 *>(ctx->in));
 
-               /* Now fill the next block with 56 bytes */
-               memset(ctx->in, 0, 56);
-       } else {
-               /* Pad block to 56 bytes */
-               memset(p, 0, count - 8);
-       }
-       if (ctx->doByteReverse)
-               _byte_reverse(ctx->in, 14);
-
-       /* Append length in bits and transform */
-       (reinterpret_cast<guint32 *>(ctx->in))[14] = ctx->bits[0];
-       (reinterpret_cast<guint32 *>(ctx->in))[15] = ctx->bits[1];
-
-       md5_transform(ctx->buf, reinterpret_cast<guint32 *>(ctx->in));
-       if (ctx->doByteReverse)
-               _byte_reverse(reinterpret_cast<guchar *>(ctx->buf), 4);
-       memcpy(digest, ctx->buf, 16);
-}
-
-
-
-
-/* The four core functions - F1 is optimized somewhat */
-
-/* #define F1(x, y, z) (x & y | ~x & z) */
-#define F1(x, y, z) (z ^ (x & (y ^ z)))
-#define F2(x, y, z) F1(z, x, y)
-#define F3(x, y, z) (x ^ y ^ z)
-#define F4(x, y, z) (y ^ (x | ~z))
-
-/* This is the central step in the MD5 algorithm. */
-#define MD5STEP(f, w, x, y, z, data, s) \
-       ( w += f(x, y, z) + data,  w = w<<s | w>>(32-s),  w += x )
-
-/*
- * The core of the MD5 algorithm, this alters an existing MD5 hash to
- * reflect the addition of 16 longwords of new data.  md5_Update blocks
- * the data and converts bytes into longwords for this routine.
- */
-static void
-md5_transform(guint32 buf[4], const guint32 in[16])
-{
-       guint32 a, b, c, d;
-
-       a = buf[0];
-       b = buf[1];
-       c = buf[2];
-       d = buf[3];
-
-       MD5STEP(F1, a, b, c, d, in[0] + 0xd76aa478, 7);
-       MD5STEP(F1, d, a, b, c, in[1] + 0xe8c7b756, 12);
-       MD5STEP(F1, c, d, a, b, in[2] + 0x242070db, 17);
-       MD5STEP(F1, b, c, d, a, in[3] + 0xc1bdceee, 22);
-       MD5STEP(F1, a, b, c, d, in[4] + 0xf57c0faf, 7);
-       MD5STEP(F1, d, a, b, c, in[5] + 0x4787c62a, 12);
-       MD5STEP(F1, c, d, a, b, in[6] + 0xa8304613, 17);
-       MD5STEP(F1, b, c, d, a, in[7] + 0xfd469501, 22);
-       MD5STEP(F1, a, b, c, d, in[8] + 0x698098d8, 7);
-       MD5STEP(F1, d, a, b, c, in[9] + 0x8b44f7af, 12);
-       MD5STEP(F1, c, d, a, b, in[10] + 0xffff5bb1, 17);
-       MD5STEP(F1, b, c, d, a, in[11] + 0x895cd7be, 22);
-       MD5STEP(F1, a, b, c, d, in[12] + 0x6b901122, 7);
-       MD5STEP(F1, d, a, b, c, in[13] + 0xfd987193, 12);
-       MD5STEP(F1, c, d, a, b, in[14] + 0xa679438e, 17);
-       MD5STEP(F1, b, c, d, a, in[15] + 0x49b40821, 22);
-
-       MD5STEP(F2, a, b, c, d, in[1] + 0xf61e2562, 5);
-       MD5STEP(F2, d, a, b, c, in[6] + 0xc040b340, 9);
-       MD5STEP(F2, c, d, a, b, in[11] + 0x265e5a51, 14);
-       MD5STEP(F2, b, c, d, a, in[0] + 0xe9b6c7aa, 20);
-       MD5STEP(F2, a, b, c, d, in[5] + 0xd62f105d, 5);
-       MD5STEP(F2, d, a, b, c, in[10] + 0x02441453, 9);
-       MD5STEP(F2, c, d, a, b, in[15] + 0xd8a1e681, 14);
-       MD5STEP(F2, b, c, d, a, in[4] + 0xe7d3fbc8, 20);
-       MD5STEP(F2, a, b, c, d, in[9] + 0x21e1cde6, 5);
-       MD5STEP(F2, d, a, b, c, in[14] + 0xc33707d6, 9);
-       MD5STEP(F2, c, d, a, b, in[3] + 0xf4d50d87, 14);
-       MD5STEP(F2, b, c, d, a, in[8] + 0x455a14ed, 20);
-       MD5STEP(F2, a, b, c, d, in[13] + 0xa9e3e905, 5);
-       MD5STEP(F2, d, a, b, c, in[2] + 0xfcefa3f8, 9);
-       MD5STEP(F2, c, d, a, b, in[7] + 0x676f02d9, 14);
-       MD5STEP(F2, b, c, d, a, in[12] + 0x8d2a4c8a, 20);
-
-       MD5STEP(F3, a, b, c, d, in[5] + 0xfffa3942, 4);
-       MD5STEP(F3, d, a, b, c, in[8] + 0x8771f681, 11);
-       MD5STEP(F3, c, d, a, b, in[11] + 0x6d9d6122, 16);
-       MD5STEP(F3, b, c, d, a, in[14] + 0xfde5380c, 23);
-       MD5STEP(F3, a, b, c, d, in[1] + 0xa4beea44, 4);
-       MD5STEP(F3, d, a, b, c, in[4] + 0x4bdecfa9, 11);
-       MD5STEP(F3, c, d, a, b, in[7] + 0xf6bb4b60, 16);
-       MD5STEP(F3, b, c, d, a, in[10] + 0xbebfbc70, 23);
-       MD5STEP(F3, a, b, c, d, in[13] + 0x289b7ec6, 4);
-       MD5STEP(F3, d, a, b, c, in[0] + 0xeaa127fa, 11);
-       MD5STEP(F3, c, d, a, b, in[3] + 0xd4ef3085, 16);
-       MD5STEP(F3, b, c, d, a, in[6] + 0x04881d05, 23);
-       MD5STEP(F3, a, b, c, d, in[9] + 0xd9d4d039, 4);
-       MD5STEP(F3, d, a, b, c, in[12] + 0xe6db99e5, 11);
-       MD5STEP(F3, c, d, a, b, in[15] + 0x1fa27cf8, 16);
-       MD5STEP(F3, b, c, d, a, in[2] + 0xc4ac5665, 23);
-
-       MD5STEP(F4, a, b, c, d, in[0] + 0xf4292244, 6);
-       MD5STEP(F4, d, a, b, c, in[7] + 0x432aff97, 10);
-       MD5STEP(F4, c, d, a, b, in[14] + 0xab9423a7, 15);
-       MD5STEP(F4, b, c, d, a, in[5] + 0xfc93a039, 21);
-       MD5STEP(F4, a, b, c, d, in[12] + 0x655b59c3, 6);
-       MD5STEP(F4, d, a, b, c, in[3] + 0x8f0ccc92, 10);
-       MD5STEP(F4, c, d, a, b, in[10] + 0xffeff47d, 15);
-       MD5STEP(F4, b, c, d, a, in[1] + 0x85845dd1, 21);
-       MD5STEP(F4, a, b, c, d, in[8] + 0x6fa87e4f, 6);
-       MD5STEP(F4, d, a, b, c, in[15] + 0xfe2ce6e0, 10);
-       MD5STEP(F4, c, d, a, b, in[6] + 0xa3014314, 15);
-       MD5STEP(F4, b, c, d, a, in[13] + 0x4e0811a1, 21);
-       MD5STEP(F4, a, b, c, d, in[4] + 0xf7537e82, 6);
-       MD5STEP(F4, d, a, b, c, in[11] + 0xbd3af235, 10);
-       MD5STEP(F4, c, d, a, b, in[2] + 0x2ad7d2bb, 15);
-       MD5STEP(F4, b, c, d, a, in[9] + 0xeb86d391, 21);
+       success = (ferror(fp) == 0);
+       fclose(fp);
 
-       buf[0] += a;
-       buf[1] += b;
-       buf[2] += c;
-       buf[3] += d;
+       return success;
 }
 
-
-
-
 /**
- * md5_get_digest: get the md5 hash of a buffer
+ * md5_get_string: get the md5 hash of a buffer
  * @buffer: byte buffer
  * @buffer_size: buffer size (in bytes)
- * @digest: 16 bytes buffer receiving the hash code.
+ * @return: hash as a hexadecimal string
  *
- * Get the md5 hash of a buffer. The result is put in
- * the 16 bytes buffer @digest .
+ * Get the md5 hash of a buffer. The result is returned
+ * as a hexadecimal string.
  **/
-void
-md5_get_digest(const guchar *buffer, gint buffer_size, guchar digest[16])
+gchar *md5_get_string(const guchar *buffer, gint buffer_size)
 {
-       MD5Context ctx;
+       GQChecksumPtr md5{g_checksum_new(G_CHECKSUM_MD5), g_checksum_free};
+       if (!md5) return nullptr;
 
-       md5_init(&ctx);
-       md5_update(&ctx, buffer, buffer_size);
-       md5_final(&ctx, digest);
+       g_checksum_update(md5.get(), buffer, buffer_size);
 
+       return g_strdup(g_checksum_get_string(md5.get()));
 }
 
-/* modified for GQView, starting here */
-
 /**
  * md5_get_digest_from_file: get the md5 hash of a file
  * @filename: file name
@@ -341,28 +99,34 @@ md5_get_digest(const guchar *buffer, gint buffer_size, guchar digest[16])
  **/
 gboolean md5_get_digest_from_file(const gchar *path, guchar digest[16])
 {
-       MD5Context ctx;
-       guchar tmp_buf[1024];
-       gint nb_bytes_read;
-       FILE *fp;
-       gint success;
+       GQChecksumPtr md5{g_checksum_new(G_CHECKSUM_MD5), g_checksum_free};
+       if (!md5) return FALSE;
 
-       fp = fopen(path, "r");
-       if (!fp) return FALSE;
+       if (!md5_update_from_file(md5.get(), path)) return FALSE;
 
-       md5_init(&ctx);
+       gsize digest_size = MD5_SIZE;
+       g_checksum_get_digest(md5.get(), digest, &digest_size);
+       if (digest_size != MD5_SIZE) return FALSE;
 
-       while ((nb_bytes_read = fread(tmp_buf, sizeof (guchar), sizeof(tmp_buf), fp)) > 0)
-               {
-               md5_update(&ctx, tmp_buf, nb_bytes_read);
-               }
+       return TRUE;
+}
 
-       success = (ferror(fp) == 0);
-       fclose(fp);
-       if (!success) return FALSE;
+/**
+ * md5_get_string_from_file: get the md5 hash of a file
+ * @filename: file name
+ * @return: hash as a hexadecimal string
+ *
+ * Get the md5 hash of a file. The result is returned
+ * as a hexadecimal string.
+ **/
+gchar *md5_get_string_from_file(const gchar *path)
+{
+       GQChecksumPtr md5{g_checksum_new(G_CHECKSUM_MD5), g_checksum_free};
+       if (!md5) return nullptr;
 
-       md5_final(&ctx, digest);
-       return TRUE;
+       if (!md5_update_from_file(md5.get(), path)) return nullptr;
+
+       return g_strdup(g_checksum_get_string(md5.get()));
 }
 
 /* these to and from text string converters were borrowed from
@@ -376,29 +140,27 @@ gchar *md5_digest_to_text(guchar digest[16])
 {
        static gchar hex_digits[] = "0123456789abcdef";
        gchar *result;
-       gint i;
+       constexpr gsize result_size = 2 * MD5_SIZE;
 
-       result = static_cast<gchar *>(g_malloc(33));
-       for (i = 0; i < 16; i++)
+       result = static_cast<gchar *>(g_malloc((result_size + 1) * sizeof(gchar)));
+       for (gsize i = 0; i < MD5_SIZE; i++)
                {
                result[2*i] = hex_digits[digest[i] >> 4];
                result[2*i+1] = hex_digits[digest[i] & 0xf];
                }
-       result[32] = '\0';
+       result[result_size] = '\0';
 
        return result;
 }
 
 gboolean md5_digest_from_text(const gchar *text, guchar digest[16])
 {
-       gint i;
-
-       for (i = 0; i < 16; i++)
+       for (gsize i = 0; i < MD5_SIZE; i++)
                {
                if (text[2*i] == '\0' || text[2*i+1] == '\0') return FALSE;
                digest[i] = g_ascii_xdigit_value(text[2*i]) << 4 |
                            g_ascii_xdigit_value(text[2*i + 1]);
-       }
+               }
 
        return TRUE;
 }
index 924bcb0..3dcab29 100644 (file)
 #include <glib.h>
 
 
-struct MD5Context {
-       guint32 buf[4];
-       guint32 bits[2];
-       guchar in[64];
-       gint doByteReverse;
-};
-
-
-/* raw routines */
-void md5_init(MD5Context *ctx);
-void md5_update(MD5Context *ctx, const guchar *buf, guint32 len);
-void md5_final(MD5Context *ctx, guchar digest[16]);
-
 /**
- * @headerfile md5_get_digest
- * generate digest from memory buffer
+ * @headerfile md5_get_string
+ * generate digest from memory buffer as a hexadecimal string
  */
-void md5_get_digest(const guchar *buffer, gint buffer_size, guchar digest[16]);
+gchar *md5_get_string(const guchar *buffer, gint buffer_size);
 
 /**
  * @headerfile md5_get_digest_from_file
@@ -66,6 +53,12 @@ void md5_get_digest(const guchar *buffer, gint buffer_size, guchar digest[16]);
  */
 gboolean md5_get_digest_from_file(const gchar *path, guchar digest[16]);
 
+/**
+ * @headerfile md5_get_string_from_file
+ * generate digest from file as a hexadecimal string
+ */
+gchar *md5_get_string_from_file(const gchar *path);
+
 /**
  * @headerfile md5_digest_to_text
  * convert digest to a NULL terminated text string, in ascii encoding
index b04a0f8..b0ae69c 100644 (file)
@@ -138,13 +138,11 @@ static gchar *thumb_std_cache_path(const gchar *path, const gchar *uri, gboolean
 {
        gchar *result = nullptr;
        gchar *md5_text;
-       guchar digest[16];
        gchar *name;
 
        if (!path || !uri || !cache_subfolder) return nullptr;
 
-       md5_get_digest(reinterpret_cast<const guchar *>(uri), strlen(uri), digest);
-       md5_text = md5_digest_to_text(digest);
+       md5_text = md5_get_string(reinterpret_cast<const guchar *>(uri), strlen(uri));
 
        if (!md5_text) return nullptr;
 
index 904a3ab..bb41510 100644 (file)
@@ -22,6 +22,8 @@
 #include <cstdio>
 #include <cstdlib>
 #include <cstring>
+#include <memory>
+
 #include <unistd.h>
 #include <utime.h>
 
@@ -994,11 +996,11 @@ gboolean md5_get_digest_from_file_utf8(const gchar *path, guchar digest[16])
 
 gchar *md5_text_from_file_utf8(const gchar *path, const gchar *error_text)
 {
-       guchar digest[16];
+       std::unique_ptr<gchar, decltype(&g_free)> pathl{path_from_utf8(path), g_free};
 
-       if (!md5_get_digest_from_file_utf8(path, digest)) return g_strdup(error_text);
+       auto md5_text = md5_get_string_from_file(pathl.get());
 
-       return md5_digest_to_text(digest);
+       return md5_text ? md5_text : g_strdup(error_text);
 }
 
 /* Download web file