safe-bag.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2021 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.
 *
 * @author Zhiyi Zhang <dreamerbarrychang@gmail.com>
 */
 
#ifndef NDN_CXX_SECURITY_SAFE_BAG_HPP
#define NDN_CXX_SECURITY_SAFE_BAG_HPP
 
#include "ndn-cxx/data.hpp"
#include "ndn-cxx/encoding/block.hpp"
#include "ndn-cxx/encoding/buffer.hpp"
 
namespace ndn {
namespace security {
 
class SafeBag
{
public:
  SafeBag();
 
  explicit
  SafeBag(const Block& wire);
 
  SafeBag(const Data& certificate, span<const uint8_t> encryptedKey);
 
  [[deprecated("use the constructor taking a span<>")]]
  SafeBag(const Data& certificate,
          const uint8_t* encryptedKey,
          size_t encryptedKeyLen);
 
public:
  template<encoding::Tag TAG>
  size_t
  wireEncode(EncodingImpl<TAG>& encoder) const;
 
  const Block&
  wireEncode() const;
 
  void
  wireDecode(const Block& wire);
 
public:
  const Data&
  getCertificate() const
  {
    return m_certificate;
  }
 
  span<const uint8_t>
  getEncryptedKey() const
  {
    return m_encryptedKey;
  }
 
private:
  Data m_certificate;
  Buffer m_encryptedKey;
 
  mutable Block m_wire;
};
 
NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(SafeBag);
 
} // namespace security
} // namespace ndn
 
#endif // NDN_CXX_SECURITY_SAFE_BAG_HPP