NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
safe-bag.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2018 Regents of the University of California.
4  *
5  * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6  *
7  * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License as published by the Free Software
9  * Foundation, either version 3 of the License, or (at your option) any later version.
10  *
11  * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13  * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14  *
15  * You should have received copies of the GNU General Public License and GNU Lesser
16  * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17  * <http://www.gnu.org/licenses/>.
18  *
19  * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20  *
21  * @author Zhiyi Zhang <dreamerbarrychang@gmail.com>
22  */
23 
24 #ifndef NDN_CXX_SECURITY_SAFE_BAG_HPP
25 #define NDN_CXX_SECURITY_SAFE_BAG_HPP
26 
27 #include "ndn-cxx/data.hpp"
31 
32 namespace ndn {
33 namespace security {
34 
37 class SafeBag
38 {
39 public:
43  SafeBag();
44 
48  explicit
49  SafeBag(const Block& wire);
50 
57  SafeBag(const Data& certificate,
58  const Buffer& encryptedKeyBag);
59 
67  SafeBag(const Data& certificate,
68  const uint8_t* encryptedKey,
69  size_t encryptedKeyLen);
70 
71 public:
75  template<encoding::Tag TAG>
76  size_t
77  wireEncode(EncodingImpl<TAG>& encoder) const;
78 
82  const Block&
83  wireEncode() const;
84 
88  void
89  wireDecode(const Block& wire);
90 
91 public:
95  const Data&
97  {
98  return m_certificate;
99  }
100 
104  const Buffer&
106  {
107  return m_encryptedKeyBag;
108  }
109 
110 private:
111  Data m_certificate;
112  Buffer m_encryptedKeyBag;
113 
114  mutable Block m_wire;
115 };
116 
118 
119 } // namespace security
120 } // namespace ndn
121 
122 #endif // NDN_CXX_SECURITY_SAFE_BAG_HPP
Copyright (c) 2011-2015 Regents of the University of California.
NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(SafeBag)
SafeBag()
Create a new empty SafeBag object.
Represents a TLV element of NDN packet format.
Definition: block.hpp:42
const Buffer & getEncryptedKeyBag() const
Get the private key in PKCS#8 from safe bag.
Definition: safe-bag.hpp:105
const Data & getCertificate() const
Get the certificate data packet from safe bag.
Definition: safe-bag.hpp:96
void wireDecode(const Block &wire)
Decode the input from wire format.
Definition: safe-bag.cpp:95
a secured container for sensitive information(certificate, private key)
Definition: safe-bag.hpp:37
const Block & wireEncode() const
Encode to a wire format.
Definition: safe-bag.cpp:82
Represents a Data packet.
Definition: data.hpp:35
General-purpose automatically managed/resized buffer.
Definition: buffer.hpp:40