sha3.h

Go to the documentation of this file.

/*
* SHA-3
* (C) 2010,2016 Jack Lloyd
*
* Botan is released under the Simplified BSD License (see license.txt)
*/
 
#ifndef BOTAN_SHA3_H_
#define BOTAN_SHA3_H_
 
#include <botan/hash.h>
#include <botan/secmem.h>
#include <botan/internal/keccak_perm.h>
#include <string>
 
namespace Botan {
 
/**
* SHA-3
*/
class SHA_3 : public HashFunction {
   public:
      /**
      * @param output_bits the size of the hash output; must be one of
      *                    224, 256, 384, or 512
      */
      explicit SHA_3(size_t output_bits);
 
      size_t hash_block_size() const override { return m_keccak.byte_rate(); }
 
      size_t output_length() const override { return m_output_length; }
 
      std::unique_ptr<HashFunction> new_object() const override;
      std::unique_ptr<HashFunction> copy_state() const override;
      std::string name() const override;
      void clear() override;
      std::string provider() const override;
 
   private:
      void add_data(std::span<const uint8_t> input) override;
      void final_result(std::span<uint8_t> out) override;
 
   private:
      Keccak_Permutation m_keccak;
      size_t m_output_length;
};
 
/**
* SHA-3-224
*/
class SHA_3_224 final : public SHA_3 {
   public:
      SHA_3_224() : SHA_3(224) {}
 
      std::unique_ptr<HashFunction> new_object() const override { return std::make_unique<SHA_3_224>(); }
 
      std::unique_ptr<HashFunction> copy_state() const override { return std::make_unique<SHA_3_224>(*this); }
};
 
/**
* SHA-3-256
*/
class SHA_3_256 final : public SHA_3 {
   public:
      SHA_3_256() : SHA_3(256) {}
 
      std::unique_ptr<HashFunction> new_object() const override { return std::make_unique<SHA_3_256>(); }
 
      std::unique_ptr<HashFunction> copy_state() const override { return std::make_unique<SHA_3_256>(*this); }
};
 
/**
* SHA-3-384
*/
class SHA_3_384 final : public SHA_3 {
   public:
      SHA_3_384() : SHA_3(384) {}
 
      std::unique_ptr<HashFunction> new_object() const override { return std::make_unique<SHA_3_384>(); }
 
      std::unique_ptr<HashFunction> copy_state() const override { return std::make_unique<SHA_3_384>(*this); }
};
 
/**
* SHA-3-512
*/
class SHA_3_512 final : public SHA_3 {
   public:
      SHA_3_512() : SHA_3(512) {}
 
      std::unique_ptr<HashFunction> new_object() const override { return std::make_unique<SHA_3_512>(); }
 
      std::unique_ptr<HashFunction> copy_state() const override { return std::make_unique<SHA_3_512>(*this); }
};
 
}  // namespace Botan
 
#endif