Digest.cc

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/
 
#include <cstdio> // snprintf
 
#include <openssl/evp.h>
#include <openssl/conf.h>
#include <optional>
#if OPENSSL_API_LEVEL < 30000
#include <openssl/engine.h>
#else
#include <openssl/provider.h>
#endif
 
#include <string>
#include <string.h>
 
#include <iostream>
#include <sstream>
 
#include <zypp-core/AutoDispose.h>
#include <zypp-core/Digest.h>
#include <zypp-core/base/String.h>
#include <zypp-core/base/Logger.h>
#include <zypp-core/base/PtrTypes.h>
 
using std::endl;
 
namespace zypp {
 
    const std::string & Digest::md5()
    { static std::string _type( "md5" ); return _type; }
 
    const std::string & Digest::sha1()
    { static std::string _type( "sha1" ); return _type; }
 
    const std::string & Digest::sha224()
    { static std::string _type( "sha224" ); return _type; }
 
    const std::string & Digest::sha256()
    { static std::string _type( "sha256" ); return _type; }
 
    const std::string & Digest::sha384()
    { static std::string _type( "sha384" ); return _type; }
 
    const std::string & Digest::sha512()
    { static std::string _type( "sha512" ); return _type; }
 
    // private data
    class Digest::P
    {
      P(const P& p) = delete;
      const P& operator=(const P& p) = delete;
      P(P &&) = delete;
      P &operator=(P &&) = delete;
 
      public:
        using EvpDataPtr = zypp::shared_ptr<EVP_MD_CTX>;
        P();
        ~P();
 
        EvpDataPtr mdctx;
#if OPENSSL_API_LEVEL >= 30000
        AutoDispose<EVP_MD *> md;
#else
        const EVP_MD *md;
#endif
        unsigned char md_value[EVP_MAX_MD_SIZE];
        unsigned md_len;
        zypp::ByteCount bytesHashed;
 
        bool finalized : 1;
        static bool openssl_digests_added;
 
        std::string name;
 
        inline bool maybeInit();
        inline void cleanup();
    };
 
 
 
    bool Digest::P::openssl_digests_added = false;
 
    Digest::P::P() :
      md(nullptr),
      finalized(false)
    {
    }
 
    Digest::P::~P()
    {
      cleanup();
    }
 
    bool Digest::P::maybeInit()
    {
      if(!openssl_digests_added)
      {
#if OPENSSL_API_LEVEL >= 30000
        // openssl 3.0 does not use engines anymore, instead we fetch algorithms via a new API
        // also it seems initialization is implicit, i'm not sure if that call here is even required.
        OPENSSL_init_crypto( OPENSSL_INIT_LOAD_CONFIG, nullptr );
 
        // md4 was moved to legacy, we need this for zsync
        if ( !OSSL_PROVIDER_load( nullptr, "legacy" ) ) {
          ERR << "Failed to load legacy openssl provider" << std::endl;
        }
        if ( !OSSL_PROVIDER_load( nullptr, "default") ) {
          ERR << "Failed to load default openssl provider" << std::endl;
        }
 
        OPENSSL_init_crypto( OPENSSL_INIT_ADD_ALL_DIGESTS, nullptr );
#else
# if OPENSSL_VERSION_NUMBER >= 0x10100000L
        OPENSSL_init_crypto( OPENSSL_INIT_LOAD_CONFIG, nullptr );
# else
        OPENSSL_config(NULL);
# endif
        ENGINE_load_builtin_engines();
        ENGINE_register_all_complete();
        OpenSSL_add_all_digests();
#endif
        openssl_digests_added = true;
      }
 
      if(!mdctx)
      {
#if OPENSSL_API_LEVEL >= 30000
        // this fetches the new provider based algorithms, returned objects have to be free'd
        // i wonder if we could cache the providers instead of querying them for every Digest instance....
        md = AutoDispose<EVP_MD *>( EVP_MD_fetch (nullptr, name.c_str(), nullptr), EVP_MD_free );
#else
        md = EVP_get_digestbyname(name.c_str());
#endif
        if(!md)
          return false;
 
#if OPENSSL_VERSION_NUMBER < 0x10100000L
        EvpDataPtr tmp_mdctx(EVP_MD_CTX_create(), EVP_MD_CTX_destroy);
#else
        EvpDataPtr tmp_mdctx(EVP_MD_CTX_new(), EVP_MD_CTX_free);
#endif
        if (!tmp_mdctx)
          return false;
 
        if (!EVP_DigestInit_ex(tmp_mdctx.get(), md, NULL)) {
          return false;
        }
 
        md_len = 0;
        ::memset(md_value, 0, sizeof(md_value));
 
        bytesHashed = 0;
 
        mdctx.swap(tmp_mdctx);
      }
      return true;
    }
 
    void Digest::P::cleanup()
    {
#if OPENSSL_API_LEVEL >= 30000
      md.reset();
#endif
      mdctx.reset();
      finalized = false;
    }
 
    Digest::Digest() : _dp( std::make_unique<P>() )
    {
    }
 
    Digest::Digest(Digest &&other) noexcept : _dp( std::move(other._dp) )
    {
    }
 
    Digest &Digest::operator=(Digest &&other) noexcept
    {
      _dp = std::move( other._dp );
      return *this;
    }
 
    Digest::~Digest()
    { }
 
    bool Digest::create(const std::string& name)
    {
      if(name.empty()) return false;
 
      if(_dp->mdctx)
        _dp->cleanup();
 
      _dp->name = name;
 
      return _dp->maybeInit();
    }
 
    const std::string& Digest::name()
    {
      return _dp->name;
    }
 
    bool Digest::reset()
    {
      if (!_dp->mdctx)
        return false;
      if(!_dp->finalized)
      {
        (void)EVP_DigestFinal_ex(_dp->mdctx.get(), _dp->md_value, &_dp->md_len);
        _dp->finalized = true;
      }
      if(!EVP_DigestInit_ex(_dp->mdctx.get(), _dp->md, NULL))
        return false;
      _dp->finalized = false;
      _dp->bytesHashed = 0;
      return true;
    }
 
    Digest Digest::clone() const
    {
      Digest d;
      if ( !_dp->name.empty () )
        d.create ( _dp->name );
      return d;
    }
 
    std::string Digest::digest()
    {
      return digestVectorToString( digestVector() );
    }
 
    std::string Digest::digestVectorToString(const UByteArray &vec)
    {
      if ( vec.empty() )
        return std::string();
 
      std::vector<char> resData ( vec.size()*2 + 1, '\0' );
      char *mdtxt = &resData[0];
      for(unsigned i = 0; i < vec.size(); ++i)
      {
        ::snprintf( mdtxt+(i*2), 3, "%02hhx", vec[i]);
      }
      return std::string( resData.data() );
    }
 
#ifdef __cpp_lib_string_view
    ByteArray Digest::hexStringToByteArray(std::string_view str)
    {
      return str::hexstringToByteArray<ByteArray>( std::move(str) );
    }
 
    UByteArray Digest::hexStringToUByteArray( std::string_view str )
    {
      return str::hexstringToByteArray<UByteArray>( std::move(str) );
    }
#endif
 
    UByteArray Digest::digestVector()
    {
      UByteArray r;
      if(!_dp->maybeInit())
        return r;
 
      if(!_dp->finalized)
      {
        if(!EVP_DigestFinal_ex(_dp->mdctx.get(), _dp->md_value, &_dp->md_len))
            return r;
        _dp->finalized = true;
      }
      r.reserve(_dp->md_len);
      for(unsigned i = 0; i < _dp->md_len; ++i)
        r.push_back(_dp->md_value[i]);
      return r;
    }
 
    bool Digest::update(const char* bytes, size_t len)
    {
      if(!bytes)
      {
        return false;
      }
 
      if(!_dp->maybeInit())
        return false;
 
      if(_dp->finalized)
      {
        _dp->cleanup();
        if(!_dp->maybeInit())
            return false;
 
      }
      if(!EVP_DigestUpdate(_dp->mdctx.get(), reinterpret_cast<const unsigned char*>(bytes), len))
        return false;
 
      _dp->bytesHashed += len;
      return true;
    }
 
    bool Digest::update(std::istream &is, size_t bufsize)
    {
      if( !is )
        return false;
 
      char buf[bufsize];
 
      while(is.good())
      {
        size_t readed = 0;
        is.read(buf, bufsize);
        readed = is.gcount();
        if(readed && !update(buf, readed))
          return false;
      }
 
      return true;
    }
 
    ByteCount Digest::bytesHashed() const
    {
      return _dp->bytesHashed;
    }
 
    std::string Digest::digest(const std::string& name, std::istream& is, size_t bufsize)
    {
      if(name.empty() || !is)
        return std::string();
 
      Digest digest;
      if(!digest.create(name))
        return std::string();
 
      if ( !digest.update( is, bufsize ))
        return std::string();
 
      return digest.digest();
    }
 
    std::string Digest::digest( const std::string & name, const std::string & input, size_t bufsize )
    {
      std::istringstream is( input );
      return digest( name, is, bufsize );
    }
 
} // namespace zypp