sha256.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2022 Regents of the University of California.
 *
 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
 *
 * ndn-cxx library 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.
 *
 * ndn-cxx library 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 copies of the GNU General Public License and GNU Lesser
 * General Public License along with ndn-cxx, e.g., in COPYING.md file.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
 */

#ifndef NDN_CXX_UTIL_SHA256_HPP
#define NDN_CXX_UTIL_SHA256_HPP

#include "ndn-cxx/encoding/block.hpp"
#include "ndn-cxx/encoding/buffer-stream.hpp"
#include "ndn-cxx/security/transform/step-source.hpp"

namespace ndn {
namespace util {

class Sha256
{
public:
  class Error : public std::runtime_error
  {
  public:
    using std::runtime_error::runtime_error;
  };

  static const size_t DIGEST_SIZE = 32;

  Sha256();

  explicit
  Sha256(std::istream& is);

  bool
  empty() const
  {
    return m_isEmpty;
  }

  void
  reset();

  ConstBufferPtr
  computeDigest();

  bool
  operator==(Sha256& digest);

  bool
  operator!=(Sha256& digest)
  {
    return !(*this == digest);
  }

  Sha256&
  operator<<(Sha256& src);

  Sha256&
  operator<<(const std::string& str);

  Sha256&
  operator<<(uint64_t value);

  Sha256&
  operator<<(span<const uint8_t> bytes);

  void
  update(span<const uint8_t> buffer);

  std::string
  toString();

  static ConstBufferPtr
  computeDigest(span<const uint8_t> buffer);

private:
  unique_ptr<security::transform::StepSource> m_input;
  unique_ptr<OBufferStream> m_output;
  bool m_isEmpty;
  bool m_isFinalized;
};

std::ostream&
operator<<(std::ostream& os, Sha256& digest);

} // namespace util
} // namespace ndn

#endif // NDN_CXX_UTIL_SHA256_HPP