符合Misra C++的跨平台md5库封装

0. 概要

这篇文章介绍如何使用 C++ 代码实现 MD5 算法的计算。示例代码由以下几个部分组成：

• md5.h: 定义 MD5 算法相关的常量、数据结构以及函数接口。
• md5.cpp: 实现 MD5 算法的核心运算逻辑。
• md5_wrapper.h: 封装通用的 MD5 计算接口。
• md5_test.cpp: 测试程序，演示如何使用 Md5Wrapper 类进行 MD5 计算和校验。
• example.txt和example.txt.md5: 为测试的md5文件，example.txt.md5使用md5sum example.txt > example.txt.md5生成。

详细代码路径：https://gitee.com/liudegui/md5_wrapper

1. md5.h 和 md5.cpp

这两个文件提供了 MD5 算法的底层实现。其中，md5.h 定义了常用的常量（如 MD5 哈希值长度）、数据结构（用于存储算法中间状态）以及四个函数接口：

• md5_init：初始化 MD5 计算上下文。
• md5_update：更新 MD5 计算上下文，处理一部分输入数据。
• md5_final：完成 MD5 计算，生成最终的哈希值。
• md5_print：将哈希值转换为字符串格式。

md5.cpp 则实现了这四个函数的具体逻辑，通过复杂的 bit 操作完成 MD5 算法的运算过程。

2. md5_wrapper.h 和 md5_test.cpp

这两个文件提供了更易于使用的 MD5 计算接口。md5_wrapper.h 定义了一个 Md5Wrapper 类，封装了常用的 MD5 计算操作：

• calculate_string_md5：计算字符串的 MD5 哈希值。
• calculate_file_md5：计算文件的 MD5 哈希值。
• calculate_buf_md5：计算内存数据块的 MD5 哈希值。
• check_md5_file：校验文件与其对应的 .md5 校验文件的哈希值是否一致。

md5_test.cpp 则是一个测试程序，演示了如何使用 Md5Wrapper 类进行各种 MD5 计算操作。例如，计算字符串的 MD5 值、计算文件哈希值，以及校验文件与 .md5 校验文件的一致性。

3. md5.cpp 的详细解释

md5.cpp 文件包含了 MD5 算法的核心实现。这里列出了一些重要的函数及其功能：

• md5_f 到 md5_i： 这几个函数实现了 MD5 算法的核心运算步，它们根据输入数据以及当前的 MD5 状态值，进行逻辑运算并更新状态值。
• md5_step： 这是一个封装函数，根据指定的步函数 (StepFunctionType)、当前的 MD5 状态值和输入数据，完成一次 MD5 算法的迭代运算。
• md5_set 和 md5_get： 这两个函数根据小端字节序的规则，将输入的字节数组转换为一个适合于算法处理的 32 位整数。
• body： 这是一个内部函数，它处理一个或多个 64 字节的數據块，并更新 MD5 算法的中间状态。
• md5_init： 初始化 MD5 计算上下文，将四个哈希值设置为特定的初始值。
• md5_update： 更新 MD5 计算上下文，处理一部分输入数据。该函数会根据缓冲区中的数据量以及输入数据的多少，分段进行处理。
• convert_to_bytes： 将一个 32 位整数转换为 4 个字节的字符数组，并按照小端字节序进行排列。
• md5_final： 完成 MD5 计算，将最后剩下的数据块处理完毕，并根据填充规则进行补位操作。最后，将计算的最终结果转换为哈希值。
• md5_print： 将哈希值的字节数组转换为十六进制的字符串格式。

4. 示例代码

md5_test.cpp 文件提供了完整的示例代码，演示了如何使用 Md5Wrapper 类进行 MD5 计算和校验。例如，以下代码段计算字符串 “This is a test string” 的 MD5 哈希值：

std::string data = "This is a test string";
std::string md5_str;
if (MD5Test::Md5Wrapper::calculate_string_md5(data, md5_str) != 0) {
  std::cerr << "Error calculating MD5 of string" << std::endl;
  return 1;
}

std::cout << "MD5 of string: " << md5_str << std::endl;

5. 封装的实现

md5_wrapper.h 文件中定义的 Md5Wrapper 类提供了对 MD5 算法的封装，简化了用户的使用。该类包含了以下成员函数：

• calculate_string_md5(const std::string& in_str, std::string& md5_str) ：计算字符串的 MD5 哈希值。

int32_t calculate_string_md5(const std::string &in_str, std::string &md5_str) {
  return calculate_buf_md5(in_str.c_str(), in_str.size(), md5_str);
}

该函数首先调用 calculate_buf_md5 函数来计算字符串内容的 MD5 哈希值，然后将结果转换为字符串格式并存储在 md5_str 参数中。

• calculate_file_md5(const std::string& in_filename, std::string& md5_str, uint64_t total_size) ：计算文件的 MD5 哈希值。

int32_t calculate_file_md5(const std::string &in_filename, std::string &md5_str, uint64_t total_size) {
  int32_t status_ret = 0;

  if (total_size == 0) {
   struct stat statbuf_obj;
   if (stat(in_filename.c_str(), &statbuf_obj) == 0) {
     total_size = static_cast<uint64_t>(statbuf_obj.st_size);
   } else {
     status_ret = -1;
   }
 }

  if (status_ret == 0) {
   Md5Ctx md5_ctx_obj;
   md5_init(md5_ctx_obj);

   (void)update_file_md5(md5_ctx_obj, in_filename, total_size);

   Md5Result result_obj;
   Md5ResultStr result_str_obj;

   md5_final(result_obj.md5_result_16, md5_ctx_obj);
   md5_print(result_str_obj.result_str, result_obj.md5_result_16, sizeof(result_str_obj.result_str));

   md5_str = uint8_to_char(result_str_obj.result_str);
 }

  return status_ret;
}

该函数首先获取文件的大小，如果 total_size 参数为 0，则会自动获取文件大小。然后，创建一个 Md5Ctx 对象用于存储 MD5 计算的上下文信息，并调用 md5_init 函数对其进行初始化。接下来，调用 update_file_md5 函数逐个读取文件内容并更新 MD5 计算上下文。最后，调用 md5_final 函数完成 MD5 计算，并将结果转换为字符串格式并存储在 md5_str 参数中。

• calculate_buf_md5(const char *const in_buf, uint64_t total_size, std::string &md5_str) ：计算内存数据块的 MD5 哈希值。

int32_t calculate_buf_md5(const char *const in_buf, uint64_t total_size, std::string &md5_str) {
  int32_t status_ret = 0;

  if ((in_buf != nullptr) && ((total_size != 0))) {
   Md5Ctx md5_ctx_obj;
   md5_init(md5_ctx_obj);
   md5_update(md5_ctx_obj, in_buf, total_size);

   Md5Result result_obj;
   Md5ResultStr result_str_obj;

   md5_final(result_obj.md5_result_16, md5_ctx_obj);
   md5_print(result_str_obj.result_str, result_obj.md5_result_16, sizeof(result_str_obj.result_str));

   md5_str = uint8_to_char(result_str_obj.result_str);