keccak.hpp

Go to the documentation of this file.

/*
 * libxcks
 * Copyright (C) 2022 Julien Couot
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * 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 Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef INC_KECCAK_HPP_6A4377C8_9736_4336_BCAB_C8D49C398CA7
#define INC_KECCAK_HPP_6A4377C8_9736_4336_BCAB_C8D49C398CA7
 
//---------------------------------------------------------------------------
#include "checksumex.hpp"
//---------------------------------------------------------------------------
 
 
namespace libxcks
{
class AbstractKeccakImpl : public ChecksumEx
{
 protected:
  static constexpr unsigned SHA3_KECCAK_SPONGE_WORDS = (1600 / 8) / sizeof(uint64_t);
 
  uint64_t saved;  
  uint64_t state[SHA3_KECCAK_SPONGE_WORDS];  
  unsigned byteIndex;  
  unsigned wordIndex;  
  const unsigned capacityWords;  
  const bool     useSHA3Hash;    
 
 public:
  AbstractKeccakImpl() = delete;
 
  AbstractKeccakImpl(const unsigned size, const bool isSHA3Hash = true);
 
  void reset() override final;
 
  void update(const uint8_t* buf, size_t len) override final;
 
 protected:
  void finish();
 
 private:
  void transform();
 
  static inline constexpr uint64_t rol(uint64_t x, int n)
  {
    return ((x << n) | (x >> (64 - n)));
  }
};
//---------------------------------------------------------------------------
 
 
class SHA3_224 final : public AbstractKeccakImpl
{
 public:
  SHA3_224() : AbstractKeccakImpl(SHA3_224::getSize(), true) {}
 
  uint8_t* getValue(uint8_t* buffer) const override;
 
  size_t getSize() const override final { return 28; }
 
  std::string getName() const override final
  {
    return getHashName();
  }
 
  ArrayString getAltNames() const override final
  {
    return getAlternativeNames();
  }
 
  ChecksumAlgoId getID() const override final
  {
    return getIdentifier();
  }
 
  static std::string getHashName()
  {
    return "SHA3-224";
  }
 
  static ArrayString getAlternativeNames();
 
  static constexpr ChecksumAlgoId getIdentifier()
  {
    return ChecksumAlgoId::SHA3_224;
  }
 
  static Checksum* getNewInstance()
  {
    return new SHA3_224();
  }
};
//---------------------------------------------------------------------------
 
 
class SHA3_256 final : public AbstractKeccakImpl
{
 public:
  SHA3_256() : AbstractKeccakImpl(SHA3_256::getSize(), true) {}
 
  uint8_t* getValue(uint8_t* buffer) const override;
 
  size_t getSize() const override final { return 32; }
 
  std::string getName() const override final
  {
    return getHashName();
  }
 
  ArrayString getAltNames() const override final
  {
    return getAlternativeNames();
  }
 
  ChecksumAlgoId getID() const override final
  {
    return getIdentifier();
  }
 
  static std::string getHashName()
  {
    return "SHA3-256";
  }
 
  static ArrayString getAlternativeNames();
 
  static constexpr ChecksumAlgoId getIdentifier()
  {
    return ChecksumAlgoId::SHA3_256;
  }
 
  static Checksum* getNewInstance()
  {
    return new SHA3_256();
  }
};
//---------------------------------------------------------------------------
 
 
class SHA3_384 final : public AbstractKeccakImpl
{
 public:
  SHA3_384() : AbstractKeccakImpl(SHA3_384::getSize(), true) {}
 
  uint8_t* getValue(uint8_t* buffer) const override final;
 
  size_t getSize() const override final { return 48; }
 
  std::string getName() const override final
  {
    return getHashName();
  }
 
  ArrayString getAltNames() const override final
  {
    return getAlternativeNames();
  }
 
  ChecksumAlgoId getID() const override final
  {
    return getIdentifier();
  }
 
  static std::string getHashName()
  {
    return "SHA3-384";
  }
 
  static ArrayString getAlternativeNames();
 
  static constexpr ChecksumAlgoId getIdentifier()
  {
    return ChecksumAlgoId::SHA3_384;
  }
 
  static Checksum* getNewInstance()
  {
    return new SHA3_384();
  }
};
//---------------------------------------------------------------------------
 
 
class SHA3_512 final : public AbstractKeccakImpl
{
 public:
  SHA3_512() : AbstractKeccakImpl(SHA3_512::getSize(), true) {}
 
  uint8_t* getValue(uint8_t* buffer) const override final;
 
  size_t getSize() const override final { return 64; }
 
  std::string getName() const override final
  {
    return getHashName();
  }
 
  ArrayString getAltNames() const override final
  {
    return getAlternativeNames();
  }
 
  ChecksumAlgoId getID() const override final
  {
    return getIdentifier();
  }
 
  static std::string getHashName()
  {
    return "SHA3-512";
  }
 
  static ArrayString getAlternativeNames();
 
  static constexpr ChecksumAlgoId getIdentifier()
  {
    return ChecksumAlgoId::SHA3_512;
  }
 
  static Checksum* getNewInstance()
  {
    return new SHA3_512();
  }
};
//---------------------------------------------------------------------------
 
 
#if 0
class Keccak224 final : public AbstractKeccakImpl
{
 public:
  Keccak224() : AbstractKeccakImpl(Keccak224::getSize(), false) {}
 
  uint8_t* getValue(uint8_t* buffer) const override final;
 
  size_t getSize() const override final { return 28; }
 
  std::string getName() const override final
  {
    return getHashName();
  }
 
  ArrayString getAltNames() const override final
  {
    return getAlternativeNames();
  }
 
  ChecksumAlgoId getID() const override final
  {
    return getIdentifier();
  }
 
  static std::string getHashName()
  {
    return "Keccak224";
  }
 
  static ArrayString getAlternativeNames();
 
  static constexpr ChecksumAlgoId getIdentifier()
  {
    return ChecksumAlgoId::Keccak224;
  }
 
  static Checksum* getNewInstance()
  {
    return new Keccak224();
  }
};
//---------------------------------------------------------------------------
 
 
class Keccak256 final : public AbstractKeccakImpl
{
 public:
  Keccak256() : AbstractKeccakImpl(Keccak256::getSize(), false) {}
 
  uint8_t* getValue(uint8_t* buffer) const override;
 
  size_t getSize() const override final { return 32; }
 
  std::string getName() const override final
  {
    return getHashName();
  }
 
  ArrayString getAltNames() const override final
  {
    return getAlternativeNames();
  }
 
  ChecksumAlgoId getID() const override final
  {
    return getIdentifier();
  }
 
  static std::string getHashName()
  {
    return "Keccak256";
  }
 
  static ArrayString getAlternativeNames();
 
  static constexpr ChecksumAlgoId getIdentifier()
  {
    return ChecksumAlgoId::Keccak256;
  }
 
  static Checksum* getNewInstance()
  {
    return new Keccak256();
  }
};
//---------------------------------------------------------------------------
 
 
class Keccak384 final : public AbstractKeccakImpl
{
 public:
  Keccak384() : AbstractKeccakImpl(Keccak384::getSize(), false) {}
 
  uint8_t* getValue(uint8_t* buffer) const override;
 
  size_t getSize() const override final { return 48; }
 
  std::string getName() const override final
  {
    return getHashName();
  }
 
  ArrayString getAltNames() const override final
  {
    return getAlternativeNames();
  }
 
  ChecksumAlgoId getID() const override final
  {
    return getIdentifier();
  }
 
  static std::string getHashName()
  {
    return "Keccak384";
  }
 
  static ArrayString getAlternativeNames();
 
  static constexpr ChecksumAlgoId getIdentifier()
  {
    return ChecksumAlgoId::Keccak384;
  }
 
  static Checksum* getNewInstance()
  {
    return new Keccak384();
  }
};
//---------------------------------------------------------------------------
 
 
class Keccak512 final : public AbstractKeccakImpl
{
 public:
  Keccak512() : AbstractKeccakImpl(Keccak512::getSize(), false) {}
 
  uint8_t* getValue(uint8_t* buffer) const override final;
 
  size_t getSize() const override final { return 64; }
 
  std::string getName() const override final
  {
    return getHashName();
  }
 
  ArrayString getAltNames() const override final
  {
    return getAlternativeNames();
  }
 
  ChecksumAlgoId getID() const override final
  {
    return getIdentifier();
  }
 
  static std::string getHashName()
  {
    return "Keccak512";
  }
 
  static ArrayString getAlternativeNames();
 
  static constexpr ChecksumAlgoId getIdentifier()
  {
    return ChecksumAlgoId::Keccak512;
  }
 
  static Checksum* getNewInstance()
  {
    return new Keccak512();
  }
};
//---------------------------------------------------------------------------
#endif
}  // namespace libxcks
//---------------------------------------------------------------------------
 
#endif  // INC_KECCAK_HPP_6A4377C8_9736_4336_BCAB_C8D49C398CA7