my_md5.cc

/* Copyright (c) 2012, 2025, Oracle and/or its affiliates.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License, version 2.0,
   as published by the Free Software Foundation.

   This program is designed to work with certain software (including
   but not limited to OpenSSL) that is licensed under separate terms,
   as designated in a particular file or component or in included license
   documentation.  The authors of MySQL hereby grant you an additional
   permission to link the program and your derivative works with the
   separately licensed software that they have either included with
   the program or referenced in the documentation.

   Without limiting anything contained in the foregoing, this file,
   which is part of C Driver for MySQL (Connector/C), is also subject to the
   Universal FOSS Exception, version 1.0, a copy of which can be found at
   http://oss.oracle.com/licenses/universal-foss-exception.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License, version 2.0, for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */

/**
  @file mysys/my_md5.cc
  Wrapper functions for OpenSSL.
*/

#include "my_md5.h"
#include "my_compiler.h"
#include "my_ssl_algo_cache.h"
#include "template_utils.h"

#include <openssl/crypto.h>
#include <openssl/err.h>
#include <openssl/md5.h>

// returns 1 for success and 0 for failure
[[nodiscard]] int my_md5_hash(unsigned char *digest, unsigned const char *buf,
                              size_t len) {
  // OpenSSL3.x EVP API is 1.5x-4x slower than this (deprecated) API
  // (depending if caching algorithm pointer etc.)
  // Issue reported at: https://github.com/openssl/openssl/issues/25858
  MY_COMPILER_DIAGNOSTIC_PUSH()
  MY_COMPILER_CLANG_DIAGNOSTIC_IGNORE("-Wdeprecated-declarations")
  MY_COMPILER_GCC_DIAGNOSTIC_IGNORE("-Wdeprecated-declarations")
  MY_COMPILER_MSVC_DIAGNOSTIC_IGNORE(4996)

  MD5_CTX ctx;
  MD5_Init(&ctx);
  MD5_Update(&ctx, buf, len);
  return MD5_Final(digest, &ctx);

  // restore clang/gcc checks for -Wdeprecated-declarations
  MY_COMPILER_DIAGNOSTIC_POP()
}

/**
    Wrapper function to compute MD5 message digest.

    @param [out] digest Computed MD5 digest
    @param [in] buf     Message to be computed
    @param [in] len     Length of the message
    @return             0 when MD5 hash function called successfully
                        1 when MD5 hash function doesn't called because of fips
   mode (ON/STRICT)
*/
int compute_md5_hash(char *digest, const char *buf, size_t len) {
  /* If fips mode is ON/STRICT restricted method calls will result into abort,
   * skipping call. */
  const bool is_fips = (my_get_fips_mode() != 0);
  const int retval =
      is_fips ||
      (0 == my_md5_hash(pointer_cast<unsigned char *>(digest),
                        pointer_cast<unsigned const char *>(buf), len));
  if (!is_fips && retval) {
    ERR_clear_error();
  }

  return retval;
}