#include <certificate.hpp>

Inheritance diagram for ndn::security::v1::Certificate:

Collaboration diagram for ndn::security::v1::Certificate:

[legend]

Classes
class	Error

Public Types
typedef std::vector< CertificateSubjectDescription >	SubjectDescriptionList

typedef std::vector< CertificateExtension >	ExtensionList

Public Member Functions
	Certificate ()
	The default constructor. More...

	Certificate (const Data &data)
	Create a Certificate from the content in the data packet. More...

	Certificate (const Block &block)
	Create a Certificate from the a block. More...

virtual	~Certificate ()

void	wireDecode (const Block &wire)

void	encode ()
	encode certificate info into content More...

void	addSubjectDescription (const CertificateSubjectDescription &description)
	Add a subject description. More...

const SubjectDescriptionList &	getSubjectDescriptionList () const

SubjectDescriptionList &	getSubjectDescriptionList ()

void	addExtension (const CertificateExtension &extension)
	Add a certificate extension. More...

const ExtensionList &	getExtensionList () const

ExtensionList &	getExtensionList ()

void	setNotBefore (const time::system_clock::TimePoint &notBefore)

time::system_clock::TimePoint &	getNotBefore ()

const time::system_clock::TimePoint &	getNotBefore () const

void	setNotAfter (const time::system_clock::TimePoint &notAfter)

time::system_clock::TimePoint &	getNotAfter ()

const time::system_clock::TimePoint &	getNotAfter () const

void	setPublicKeyInfo (const PublicKey &key)

PublicKey &	getPublicKeyInfo ()

const PublicKey &	getPublicKeyInfo () const

bool	isTooEarly ()
	Check if the certificate is valid. More...

bool	isTooLate ()
	Check if the certificate is valid. More...

void	printCertificate (std::ostream &os, const std::string &indent="") const

Public Member Functions inherited from ndn::Data
	Data ()
	Create an empty Data object. More...

	Data (const Name &name)
	Create a new Data object with the given name. More...

	Data (const Block &wire)
	Create a new Data object from wire encoding. More...

template<encoding::Tag TAG>
size_t	wireEncode (EncodingImpl< TAG > &encoder, bool wantUnsignedPortionOnly=false) const
	Fast encoding or block size estimation. More...

const Block &	wireEncode () const
	Encode to a wire format. More...

const Block &	wireEncode (EncodingBuffer &encoder, const Block &signatureValue) const
	Finalize Data packet encoding with the specified SignatureValue. More...

void	wireDecode (const Block &wire)
	Decode from the wire format. More...

bool	hasWire () const
	Check if Data is already has wire encoding. More...

const Name &	getName () const
	Get name of the Data packet. More...

Data &	setName (const Name &name)
	Set name to a copy of the given Name. More...

const Name &	getFullName () const
	Get full name of Data packet, including the implicit digest. More...

const MetaInfo &	getMetaInfo () const
	Get MetaInfo block from Data packet. More...

Data &	setMetaInfo (const MetaInfo &metaInfo)
	Set metaInfo to a copy of the given MetaInfo. More...

uint32_t	getContentType () const

Data &	setContentType (uint32_t type)

const time::milliseconds &	getFreshnessPeriod () const

Data &	setFreshnessPeriod (const time::milliseconds &freshnessPeriod)

const name::Component &	getFinalBlockId () const

Data &	setFinalBlockId (const name::Component &finalBlockId)

const Block &	getContent () const
	Get content Block. More...

Data &	setContent (const uint8_t *buffer, size_t bufferSize)
	Set the content from the buffer (buffer will be copied) More...

Data &	setContent (const Block &block)
	Set the content from the block. More...

Data &	setContent (const ConstBufferPtr &contentValue)
	Set the content from the pointer to immutable buffer. More...

const Signature &	getSignature () const

Data &	setSignature (const Signature &signature)
	Set the signature to a copy of the given signature. More...

Data &	setSignatureValue (const Block &value)

bool	operator== (const Data &other) const

bool	operator!= (const Data &other) const

Public Member Functions inherited from ndn::TagHost
template<typename T >
shared_ptr< T >	getTag () const
	get a tag item More...

template<typename T >
void	setTag (shared_ptr< T > tag) const
	set a tag item More...

template<typename T >
void	removeTag () const
	remove tag item More...

Protected Member Functions
void	decode ()

Protected Member Functions inherited from ndn::Data
void	onChanged ()
	Clear the wire encoding. More...

Protected Attributes
SubjectDescriptionList	m_subjectDescriptionList

time::system_clock::TimePoint	m_notBefore

time::system_clock::TimePoint	m_notAfter

PublicKey	m_key

ExtensionList	m_extensionList

Detailed Description

Definition at line 39 of file certificate.hpp.

Member Typedef Documentation

◆ SubjectDescriptionList

typedef std::vector<CertificateSubjectDescription> ndn::security::v1::Certificate::SubjectDescriptionList

Definition at line 52 of file certificate.hpp.

◆ ExtensionList

typedef std::vector<CertificateExtension> ndn::security::v1::Certificate::ExtensionList

Definition at line 53 of file certificate.hpp.

Constructor & Destructor Documentation

◆ Certificate() [1/3]

ndn::security::v1::Certificate::Certificate ( )

The default constructor.

Definition at line 45 of file certificate.cpp.

◆ Certificate() [2/3]

ndn::security::v1::Certificate::Certificate ( const Data & data )

explicit

Create a Certificate from the content in the data packet.

Parameters

data	The data packet with the content to decode.

Definition at line 51 of file certificate.cpp.

References decode().

◆ Certificate() [3/3]

ndn::security::v1::Certificate::Certificate ( const Block & block )

explicit

Create a Certificate from the a block.

Parameters

block The raw block of the certificate

Definition at line 58 of file certificate.cpp.

References decode().

◆ ~Certificate()

ndn::security::v1::Certificate::~Certificate ( )

virtual

Definition at line 64 of file certificate.cpp.

Member Function Documentation

◆ wireDecode()

void ndn::security::v1::Certificate::wireDecode ( const Block & wire )

Definition at line 69 of file certificate.cpp.

References decode(), and ndn::Data::wireDecode().

Referenced by ndn::security::v1::IdentityCertificate::wireDecode().

◆ encode()

void ndn::security::v1::Certificate::encode ( )

encode certificate info into content

Definition at line 94 of file certificate.cpp.

References ndn::OBufferStream::buf(), ndn::tlv::ContentType_Key, ndn::DEREncodeGeneralTime(), ndn::security::v1::PublicKey::encode(), m_extensionList, m_key, m_notAfter, m_notBefore, m_subjectDescriptionList, ndn::Data::setContent(), and ndn::Data::setContentType().

◆ addSubjectDescription()

void ndn::security::v1::Certificate::addSubjectDescription ( const CertificateSubjectDescription & description )

inline

Add a subject description.

Parameters

description The description to be added.

Definition at line 91 of file certificate.hpp.

References m_subjectDescriptionList.

◆ getSubjectDescriptionList() [1/2]

const SubjectDescriptionList& ndn::security::v1::Certificate::getSubjectDescriptionList ( ) const

inline

Definition at line 97 of file certificate.hpp.

References m_subjectDescriptionList.

◆ getSubjectDescriptionList() [2/2]

SubjectDescriptionList& ndn::security::v1::Certificate::getSubjectDescriptionList ( )

inline

Definition at line 103 of file certificate.hpp.

References m_subjectDescriptionList.

◆ addExtension()

void ndn::security::v1::Certificate::addExtension ( const CertificateExtension & extension )

inline

Add a certificate extension.

Parameters

extension the extension to be added

Definition at line 113 of file certificate.hpp.

References m_extensionList.

◆ getExtensionList() [1/2]

const ExtensionList& ndn::security::v1::Certificate::getExtensionList ( ) const

inline

Definition at line 119 of file certificate.hpp.

References m_extensionList.

◆ getExtensionList() [2/2]

ExtensionList& ndn::security::v1::Certificate::getExtensionList ( )

inline

Definition at line 125 of file certificate.hpp.

References m_extensionList.

◆ setNotBefore()

void ndn::security::v1::Certificate::setNotBefore ( const time::system_clock::TimePoint & notBefore )

inline

Definition at line 131 of file certificate.hpp.

References m_notBefore.

◆ getNotBefore() [1/2]

time::system_clock::TimePoint& ndn::security::v1::Certificate::getNotBefore ( )

inline

Definition at line 137 of file certificate.hpp.

References m_notBefore.

Referenced by ndn::security::SecPublicInfoSqlite3::addCertificate().

◆ getNotBefore() [2/2]

const time::system_clock::TimePoint& ndn::security::v1::Certificate::getNotBefore ( ) const

inline

Definition at line 143 of file certificate.hpp.

References m_notBefore.

◆ setNotAfter()

void ndn::security::v1::Certificate::setNotAfter ( const time::system_clock::TimePoint & notAfter )

inline

Definition at line 149 of file certificate.hpp.

References m_notAfter.

◆ getNotAfter() [1/2]

time::system_clock::TimePoint& ndn::security::v1::Certificate::getNotAfter ( )

inline

Definition at line 155 of file certificate.hpp.

References m_notAfter.

Referenced by ndn::security::SecPublicInfoSqlite3::addCertificate().

◆ getNotAfter() [2/2]

const time::system_clock::TimePoint& ndn::security::v1::Certificate::getNotAfter ( ) const

inline

Definition at line 161 of file certificate.hpp.

References m_notAfter.

◆ setPublicKeyInfo()

void ndn::security::v1::Certificate::setPublicKeyInfo ( const PublicKey & key )

inline

Definition at line 167 of file certificate.hpp.

References m_key.

◆ getPublicKeyInfo() [1/2]

PublicKey& ndn::security::v1::Certificate::getPublicKeyInfo ( )

inline

Definition at line 173 of file certificate.hpp.

References m_key.

Referenced by ndn::security::SecPublicInfoSqlite3::addCertificate(), ndn::security::PibMemory::addCertificate(), ndn::security::PibSqlite3::addCertificate(), and ndn::security::KeyChain::selfSign().

◆ getPublicKeyInfo() [2/2]

const PublicKey& ndn::security::v1::Certificate::getPublicKeyInfo ( ) const

inline

Definition at line 179 of file certificate.hpp.

References decode(), isTooEarly(), isTooLate(), m_key, and printCertificate().

◆ isTooEarly()

bool ndn::security::v1::Certificate::isTooEarly ( )

Check if the certificate is valid.

Returns: True if the current time is earlier than notBefore.

Definition at line 76 of file certificate.cpp.

References m_notBefore, and ndn::time::system_clock::now().

Referenced by getPublicKeyInfo().

◆ isTooLate()

bool ndn::security::v1::Certificate::isTooLate ( )

Check if the certificate is valid.

Returns: True if the current time is later than notAfter.

Definition at line 85 of file certificate.cpp.

References m_notAfter, and ndn::time::system_clock::now().

Referenced by getPublicKeyInfo().

◆ printCertificate()

void ndn::security::v1::Certificate::printCertificate	(	std::ostream &	os,
		const std::string &	indent = `""`
	)		const

◆ decode()

void ndn::security::v1::Certificate::decode ( )

protected

Definition at line 197 of file certificate.cpp.

References ndn::BERDecodeTime(), ndn::security::v1::PublicKey::decode(), ndn::Data::getContent(), m_extensionList, m_key, m_notAfter, m_notBefore, and m_subjectDescriptionList.

Referenced by Certificate(), getPublicKeyInfo(), and wireDecode().

Member Data Documentation

◆ m_subjectDescriptionList

SubjectDescriptionList ndn::security::v1::Certificate::m_subjectDescriptionList

protected

Definition at line 206 of file certificate.hpp.

Referenced by addSubjectDescription(), decode(), encode(), getSubjectDescriptionList(), and printCertificate().

◆ m_notBefore

time::system_clock::TimePoint ndn::security::v1::Certificate::m_notBefore

protected

Definition at line 207 of file certificate.hpp.

Referenced by decode(), encode(), getNotBefore(), isTooEarly(), printCertificate(), and setNotBefore().

◆ m_notAfter

time::system_clock::TimePoint ndn::security::v1::Certificate::m_notAfter

protected

Definition at line 208 of file certificate.hpp.

Referenced by decode(), encode(), getNotAfter(), isTooLate(), printCertificate(), and setNotAfter().

◆ m_key

PublicKey ndn::security::v1::Certificate::m_key

protected

Definition at line 209 of file certificate.hpp.

Referenced by decode(), encode(), getPublicKeyInfo(), printCertificate(), and setPublicKeyInfo().

◆ m_extensionList

ExtensionList ndn::security::v1::Certificate::m_extensionList

protected

Definition at line 210 of file certificate.hpp.

Referenced by addExtension(), decode(), encode(), and getExtensionList().

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

ndnSIM/ndn-cxx/src/security/v1/certificate.hpp
ndnSIM/ndn-cxx/src/security/v1/certificate.cpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ SubjectDescriptionList

◆ ExtensionList

Constructor & Destructor Documentation

◆ Certificate() [1/3]

◆ Certificate() [2/3]

◆ Certificate() [3/3]

◆ ~Certificate()

Member Function Documentation

◆ wireDecode()

◆ encode()

◆ addSubjectDescription()

◆ getSubjectDescriptionList() [1/2]

◆ getSubjectDescriptionList() [2/2]

◆ addExtension()

◆ getExtensionList() [1/2]

◆ getExtensionList() [2/2]

◆ setNotBefore()

◆ getNotBefore() [1/2]

◆ getNotBefore() [2/2]

◆ setNotAfter()

◆ getNotAfter() [1/2]

◆ getNotAfter() [2/2]

◆ setPublicKeyInfo()

◆ getPublicKeyInfo() [1/2]

◆ getPublicKeyInfo() [2/2]

◆ isTooEarly()

◆ isTooLate()

◆ printCertificate()

◆ decode()

Member Data Documentation

◆ m_subjectDescriptionList

◆ m_notBefore

◆ m_notAfter

◆ m_key

◆ m_extensionList