ndn::security::SafeBag Class Reference

a secured container for sensitive information(certificate, private key) More...

#include <safe-bag.hpp>

Public Member Functions
	SafeBag ()
	Create a new empty SafeBag object. More...
	SafeBag (const Block &wire)
	Create a new SafeBag object from the block. More...
	SafeBag (const Data &certificate, const Buffer &encryptedKeyBag)
	Create a new Safe object with the given certificate and private key. More...
	SafeBag (const Data &certificate, const uint8_t *encryptedKey, size_t encryptedKeyLen)
	Create a new Safe object with the given certificate and private key. More...
template<encoding::Tag TAG>
size_t	wireEncode (EncodingImpl< TAG > &encoder) const
	Fast encoding or block size estimation. More...
const Block &	wireEncode () const
	Encode to a wire format. More...
void	wireDecode (const Block &wire)
	Decode the input from wire format. More...
const Data &	getCertificate () const
	Get the certificate data packet from safe bag. More...
const Buffer &	getEncryptedKeyBag () const
	Get the private key in PKCS#8 from safe bag. More...

Detailed Description

a secured container for sensitive information(certificate, private key)

Definition at line 37 of file safe-bag.hpp.

Constructor & Destructor Documentation

ndn::security::SafeBag::SafeBag ( )

default

Create a new empty SafeBag object.

ndn::security::SafeBag::SafeBag ( const Block &  wire )

explicit

Create a new SafeBag object from the block.

Definition at line 37 of file safe-bag.cpp.

References wireDecode().

ndn::security::SafeBag::SafeBag	(	const Data &	certificate,
		const Buffer &	encryptedKeyBag
	)

Create a new Safe object with the given certificate and private key.

Parameters

certificate	A reference to the certificate data packet
encryptedKeyBag	A reference to the Buffer of private key in PKCS#8

Definition at line 42 of file safe-bag.cpp.

ndn::security::SafeBag::SafeBag	(	const Data &	certificate,
		const uint8_t *	encryptedKey,
		size_t	encryptedKeyLen
	)

Create a new Safe object with the given certificate and private key.

Parameters

certificate	A reference to the certificate data packet
encryptedKey	A reference to the uint8_t* of private key in PKCS#8
encryptedKeyLen	The length of the encryptedKey

Definition at line 49 of file safe-bag.cpp.

Member Function Documentation

template<encoding::Tag TAG>

size_t ndn::security::SafeBag::wireEncode

(

EncodingImpl< TAG > &

encoder

)

const

Fast encoding or block size estimation.

Definition at line 61 of file safe-bag.cpp.

References ndn::tlv::security::EncryptedKeyBag, ndn::security::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS(), ndn::tlv::security::SafeBag, and ndn::Data::wireEncode().

const Block & ndn::security::SafeBag::wireEncode

(

)

const

Encode to a wire format.

Definition at line 82 of file safe-bag.cpp.

void ndn::security::SafeBag::wireDecode

(

const Block &

wire

)

Decode the input from wire format.

Definition at line 95 of file safe-bag.cpp.

References ndn::Block::elements_begin(), ndn::Block::elements_end(), ndn::tlv::security::EncryptedKeyBag, ndn::Block::parse(), ndn::tlv::security::SafeBag, ndn::Block::type(), and ndn::Data::wireDecode().

Referenced by SafeBag().

const Data& ndn::security::SafeBag::getCertificate ( ) const

inline

Get the certificate data packet from safe bag.

Definition at line 96 of file safe-bag.hpp.

Referenced by ndn::security::v2::KeyChain::importSafeBag().

const Buffer& ndn::security::SafeBag::getEncryptedKeyBag ( ) const

inline

Get the private key in PKCS#8 from safe bag.

Definition at line 105 of file safe-bag.hpp.

References ndn::security::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS().

Referenced by ndn::security::v2::KeyChain::importSafeBag().

---

The documentation for this class was generated from the following files:

• ndnSIM/ndn-cxx/src/security/safe-bag.hpp
• ndnSIM/ndn-cxx/src/security/safe-bag.cpp