Cryptography.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.11
// ----------------------------------------------------------------------------
// pcl/Cryptography.h - Released 2024-05-07T15:27:32Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// ----------------------------------------------------------------------------
 
#ifndef __PCL_Cryptography_h
#define __PCL_Cryptography_h
 
 
#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>
 
#include <pcl/AutoPointer.h>
#include <pcl/ByteArray.h>
#include <pcl/Exception.h>
#include <pcl/String.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS CryptographicHash
{
public:
 
   CryptographicHash() = default;
 
   virtual ~CryptographicHash()
   {
   }
 
   CryptographicHash( const CryptographicHash& ) = delete;
 
   CryptographicHash& operator =( const CryptographicHash& ) = delete;
 
   virtual String AlgorithmName() const = 0;
 
   virtual size_type HashLength() const = 0;
 
   virtual void Initialize() = 0;
 
   virtual void Update( const void* data, size_type length ) = 0;
 
   template <class C>
   void UpdateWithContainer( const C& data )
   {
      Update( data.Begin(), data.Size() );
   }
 
   ByteArray Finalize()
   {
      ByteArray hash( HashLength() );
      DoFinalize( hash.Begin() );
      return hash;
   }
 
   void Hash( uint8* hash, const void* data, size_type length )
   {
      Initialize();
      Update( data, length );
      DoFinalize( hash );
   }
 
   ByteArray Hash( const void* data, size_type length )
   {
      ByteArray hash( HashLength() );
      Hash( hash.Begin(), data, length );
      return hash;
   }
 
   template <class C>
   ByteArray Hash( const C& data )
   {
      return Hash( data.Begin(), data.Size() );
   }
 
protected:
 
   virtual void DoFinalize( void* hash ) = 0;
 
   friend class CryptographicHashFactory;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MD5 : public CryptographicHash
{
public:
 
   MD5() = default;
 
   ~MD5() override;
 
   String AlgorithmName() const override
   {
      return "MD5";
   }
 
   size_type HashLength() const override
   {
      return 16;
   }
 
   void Initialize() override;
 
   void Update( const void* data, size_type length ) override;
 
private:
 
   void* m_context = nullptr;
 
   void DoFinalize( void* hash ) override;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS SHA1 : public CryptographicHash
{
public:
 
   SHA1() = default;
 
   ~SHA1() override;
 
   String AlgorithmName() const override
   {
      return "SHA1";
   }
 
   size_type HashLength() const override
   {
      return 20;
   }
 
   void Initialize() override;
 
   void Update( const void* data, size_type length ) override;
 
private:
 
   void* m_context = nullptr; // RFC4634
 
   void DoFinalize( void* hash ) override;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS SHA224 : public CryptographicHash
{
public:
 
   SHA224() = default;
 
   ~SHA224() override;
 
   String AlgorithmName() const override
   {
      return "SHA224";
   }
 
   size_type HashLength() const override
   {
      return 28;
   }
 
   void Initialize() override;
 
   void Update( const void* data, size_type length ) override;
 
private:
 
   void* m_context = nullptr; // RFC4634
 
   void DoFinalize( void* hash ) override;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS SHA256 : public CryptographicHash
{
public:
 
   SHA256() = default;
 
   ~SHA256() override;
 
   String AlgorithmName() const override
   {
      return "SHA256";
   }
 
   size_type HashLength() const override
   {
      return 32;
   }
 
   void Initialize() override;
 
   void Update( const void* data, size_type length ) override;
 
private:
 
   void* m_context = nullptr; // RFC4634
 
   void DoFinalize( void* hash ) override;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS SHA384 : public CryptographicHash
{
public:
 
   SHA384() = default;
 
   ~SHA384() override;
 
   String AlgorithmName() const override
   {
      return "SHA384";
   }
 
   size_type HashLength() const override
   {
      return 48;
   }
 
   void Initialize() override;
 
   void Update( const void* data, size_type length ) override;
 
private:
 
   void* m_context = nullptr; // RFC4634
 
   void DoFinalize( void* hash ) override;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS SHA512 : public CryptographicHash
{
public:
 
   SHA512() = default;
 
   ~SHA512() override;
 
   String AlgorithmName() const override
   {
      return "SHA512";
   }
 
   size_type HashLength() const override
   {
      return 64;
   }
 
   void Initialize() override;
 
   void Update( const void* data, size_type length ) override;
 
private:
 
   void* m_context = nullptr; // RFC4634
 
   void DoFinalize( void* hash ) override;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS CryptographicHashFactory : public CryptographicHash
{
public:
 
   CryptographicHashFactory( const IsoString& algorithmName )
   {
      switch ( algorithmName.Trimmed().CaseFolded().Hash32() )
      {
      case 0x445dd715: m_hash = new MD5; break;
      case 0x3cac24af: m_hash = new SHA1; break;
      case 0x7e50b015: m_hash = new SHA224; break;
      case 0xcbbce793: m_hash = new SHA256; break;
      case 0x858a0d3d: m_hash = new SHA384; break;
      case 0xb24dfd53: m_hash = new SHA512; break;
      default:
         throw Error( "CryptographicHashFactory: Unknown/unsupported algorithm \'" + algorithmName + '\'' );
      }
   }
 
   CryptographicHashFactory( const IsoString::ustring_base& algorithmName )
      : CryptographicHashFactory( IsoString( algorithmName ) )
   {
   }
 
   ~CryptographicHashFactory() override
   {
   }
 
   String AlgorithmName() const override
   {
      return m_hash->AlgorithmName();
   }
 
   size_type HashLength() const override
   {
      return m_hash->HashLength();
   }
 
   void Initialize() override
   {
      m_hash->Initialize();
   }
 
   void Update( const void* data, size_type length ) override
   {
      m_hash->Update( data, length );
   }
 
private:
 
   AutoPointer<CryptographicHash> m_hash;
 
   void DoFinalize( void* hash ) override
   {
      m_hash->DoFinalize( hash );
   }
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS Cipher
{
public:
 
   Cipher() = default;
 
   Cipher( const Cipher& ) = default;
 
   Cipher& operator =( const Cipher& ) = default;
 
   virtual ~Cipher()
   {
   }
 
   virtual String AlgorithmName() const = 0;
 
   virtual size_type KeyLength() const = 0;
 
   virtual void Encrypt( void* output, const void* input, size_type length ) const = 0;
 
   virtual void Decrypt( void* output, const void* input, size_type length ) const = 0;
 
   template <class C>
   void Encrypt( void* output, const C& input ) const
   {
      Encrypt( output, input.Begin(), input.Size() );
   }
 
   template <class C>
   ByteArray Encrypt( const C& input ) const
   {
      ByteArray output( input.Size() );
      Encrypt( output.Begin(), input.Begin(), input.Size() );
      return output;
   }
 
   template <class C>
   void Decrypt( void* output, const C& input ) const
   {
      Decrypt( output, input.Begin(), input.Size() );
   }
 
   template <class C>
   ByteArray Decrypt( const C& input ) const
   {
      ByteArray output( input.Size() );
      Decrypt( output.Begin(), input.Begin(), input.Size() );
      return output;
   }
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS AES256 : public Cipher
{
public:
 
   enum { key_length = 32, block_length = 16 };
 
   using key_type = uint8[ key_length ];
 
   using block_type = uint8[ block_length ];
 
   AES256( void* key )
   {
      SetKey( key );
   }
 
   AES256( IsoString& key )
   {
      ByteArray h = MD5().Hash( key );
      key.SecureFill();
      for ( int i = 1; i < 20; ++i )
         h = MD5().Hash( h );
      IsoString k = IsoString::ToHex( h );
      h.Fill( uint8( 0 ) );
      SetKey( k.Begin() );
   }
 
   AES256( const AES256& ) = default;
 
   AES256& operator =( const AES256& ) = default;
 
   ~AES256() override
   {
   }
 
   String AlgorithmName() const override
   {
      return "AES256";
   }
 
   size_type KeyLength() const override
   {
      return 32;
   }
 
   void Encrypt( void* output, const void* input, size_type length ) const override;
 
   void Decrypt( void* output, const void* input, size_type length ) const override;
 
   void EncryptBlock( void* output, const void* input ) const;
 
   void DecryptBlock( void* output, const void* input ) const;
 
private:
 
   uint32 m_erk[ 60 ]; // encryption round keys, 4*(Nr+1) elements
   uint32 m_drk[ 60 ]; // decryption round keys, 4*(Nr+1) elements
 
   void SetKey( void* key );
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_Cryptography_h
 
// ----------------------------------------------------------------------------
// EOF pcl/Cryptography.h - Released 2024-05-07T15:27:32Z