All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ndn::IdentityCertificate Class Reference

#include <identity-certificate.hpp>

Inheritance diagram for ndn::IdentityCertificate:
[legend]
Collaboration diagram for ndn::IdentityCertificate:
[legend]

Data Structures

class  Error
 

Public Types

typedef std::vector
< CertificateSubjectDescription
SubjectDescriptionList
 
typedef std::vector
< CertificateExtension
ExtensionList
 

Public Member Functions

 IdentityCertificate ()
 The default constructor. More...
 
 IdentityCertificate (const Data &data)
 Create an IdentityCertificate from the content in the data packet. More...
 
virtual ~IdentityCertificate ()
 The virtual destructor. More...
 
void wireDecode (const Block &wire)
 
void setName (const Name &name)
 
const NamegetPublicKeyName () const
 
void encode ()
 encode certificate info into content More...
 
void addSubjectDescription (const CertificateSubjectDescription &description)
 Add a subject description. More...
 
const SubjectDescriptionListgetSubjectDescriptionList () const
 
SubjectDescriptionListgetSubjectDescriptionList ()
 
void addExtension (const CertificateExtension &extension)
 Add a certificate extension. More...
 
const ExtensionListgetExtensionList () const
 
ExtensionListgetExtensionList ()
 
void setNotBefore (const time::system_clock::TimePoint &notBefore)
 
time::system_clock::TimePointgetNotBefore ()
 
const
time::system_clock::TimePoint
getNotBefore () const
 
void setNotAfter (const time::system_clock::TimePoint &notAfter)
 
time::system_clock::TimePointgetNotAfter ()
 
const
time::system_clock::TimePoint
getNotAfter () const
 
void setPublicKeyInfo (const PublicKey &key)
 
PublicKeygetPublicKeyInfo ()
 
const PublicKeygetPublicKeyInfo () 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
 
template<bool T>
size_t wireEncode (EncodingImpl< T > &block, bool unsignedPortion=false) const
 Fast encoding or block size estimation. More...
 
const BlockwireEncode () const
 Encode to a wire format. More...
 
bool hasWire () const
 Check if already has wire. More...
 
const NamegetName () const
 
const MetaInfogetMetaInfo () const
 
void setMetaInfo (const MetaInfo &metaInfo)
 Set metaInfo to a copy of the given MetaInfo. More...
 
uint32_t getContentType () const
 
void setContentType (uint32_t type)
 
const time::milliseconds & getFreshnessPeriod () const
 
void setFreshnessPeriod (const time::milliseconds &freshnessPeriod)
 
const name::ComponentgetFinalBlockId () const
 
void setFinalBlockId (const name::Component &finalBlockId)
 
const BlockgetContent () const
 Get content Block. More...
 
void setContent (const uint8_t *content, size_t contentLength)
 Set the content to a copy of the data in the vector. More...
 
void setContent (const Block &content)
 
void setContent (const ConstBufferPtr &contentValue)
 
const SignaturegetSignature () const
 
void setSignature (const Signature &signature)
 Set the signature to a copy of the given signature. More...
 
void setSignatureValue (const Block &value)
 
nfd::LocalControlHeadergetLocalControlHeader ()
 
const nfd::LocalControlHeadergetLocalControlHeader () const
 
uint64_t getIncomingFaceId () const
 
void setIncomingFaceId (uint64_t incomingFaceId)
 
bool operator== (const Data &other) const
 
bool operator!= (const Data &other) const
 

Static Public Member Functions

static bool isIdentityCertificate (const Certificate &certificate)
 
static Name certificateNameToPublicKeyName (const Name &certificateName)
 Get the public key name from the full certificate name. More...
 

Protected Member Functions

void decode ()
 

Protected Attributes

Name m_publicKeyName
 
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 17 of file identity-certificate.hpp.

Member Typedef Documentation

typedef std::vector<CertificateExtension> ndn::Certificate::ExtensionList
inherited

Definition at line 34 of file certificate.hpp.

Definition at line 33 of file certificate.hpp.

Constructor & Destructor Documentation

ndn::IdentityCertificate::IdentityCertificate ( )
inline

The default constructor.

Definition at line 81 of file identity-certificate.hpp.

ndn::IdentityCertificate::IdentityCertificate ( const Data data)
inline

Create an IdentityCertificate from the content in the data packet.

Parameters
dataThe data packet with the content to decode.

Definition at line 86 of file identity-certificate.hpp.

ndn::IdentityCertificate::~IdentityCertificate ( )
inlinevirtual

The virtual destructor.

Definition at line 93 of file identity-certificate.hpp.

Member Function Documentation

void ndn::Certificate::addExtension ( const CertificateExtension extension)
inlineinherited

Add a certificate extension.

Parameters
extensionthe extension to be added

Definition at line 89 of file certificate.hpp.

void ndn::Certificate::addSubjectDescription ( const CertificateSubjectDescription description)
inlineinherited

Add a subject description.

Parameters
descriptionThe description to be added.

Definition at line 67 of file certificate.hpp.

Name ndn::IdentityCertificate::certificateNameToPublicKeyName ( const Name certificateName)
static

Get the public key name from the full certificate name.

Parameters
certificateNameThe full certificate name.
Returns
The related public key name.

Definition at line 59 of file identity-certificate.cpp.

void ndn::Certificate::decode ( )
protectedinherited

Definition at line 160 of file certificate.cpp.

void ndn::Certificate::encode ( )
inherited

encode certificate info into content

Definition at line 57 of file certificate.cpp.

const Block & ndn::Data::getContent ( ) const
inlineinherited

Get content Block.

To access content value, one can use value()/value_size() or value_begin()/value_end() methods of the Block class

Definition at line 411 of file data.hpp.

uint32_t ndn::Data::getContentType ( ) const
inlineinherited

Definition at line 372 of file data.hpp.

const ExtensionList& ndn::Certificate::getExtensionList ( ) const
inlineinherited

Definition at line 95 of file certificate.hpp.

ExtensionList& ndn::Certificate::getExtensionList ( )
inlineinherited

Definition at line 101 of file certificate.hpp.

const name::Component & ndn::Data::getFinalBlockId ( ) const
inlineinherited

Definition at line 398 of file data.hpp.

const time::milliseconds & ndn::Data::getFreshnessPeriod ( ) const
inlineinherited

Definition at line 385 of file data.hpp.

uint64_t ndn::Data::getIncomingFaceId ( ) const
inlineinherited

Definition at line 484 of file data.hpp.

nfd::LocalControlHeader & ndn::Data::getLocalControlHeader ( )
inlineinherited

Definition at line 472 of file data.hpp.

const nfd::LocalControlHeader & ndn::Data::getLocalControlHeader ( ) const
inlineinherited

Definition at line 478 of file data.hpp.

const MetaInfo & ndn::Data::getMetaInfo ( ) const
inlineinherited

Definition at line 359 of file data.hpp.

const Name & ndn::Data::getName ( ) const
inlineinherited

Definition at line 346 of file data.hpp.

time::system_clock::TimePoint& ndn::Certificate::getNotAfter ( )
inlineinherited

Definition at line 131 of file certificate.hpp.

const time::system_clock::TimePoint& ndn::Certificate::getNotAfter ( ) const
inlineinherited

Definition at line 137 of file certificate.hpp.

time::system_clock::TimePoint& ndn::Certificate::getNotBefore ( )
inlineinherited

Definition at line 113 of file certificate.hpp.

const time::system_clock::TimePoint& ndn::Certificate::getNotBefore ( ) const
inlineinherited

Definition at line 119 of file certificate.hpp.

PublicKey& ndn::Certificate::getPublicKeyInfo ( )
inlineinherited

Definition at line 149 of file certificate.hpp.

const PublicKey& ndn::Certificate::getPublicKeyInfo ( ) const
inlineinherited

Definition at line 155 of file certificate.hpp.

const Name & ndn::IdentityCertificate::getPublicKeyName ( ) const
inline

Definition at line 112 of file identity-certificate.hpp.

const Signature & ndn::Data::getSignature ( ) const
inlineinherited

Definition at line 450 of file data.hpp.

const SubjectDescriptionList& ndn::Certificate::getSubjectDescriptionList ( ) const
inlineinherited

Definition at line 73 of file certificate.hpp.

SubjectDescriptionList& ndn::Certificate::getSubjectDescriptionList ( )
inlineinherited

Definition at line 79 of file certificate.hpp.

bool ndn::Data::hasWire ( ) const
inlineinherited

Check if already has wire.

Definition at line 340 of file data.hpp.

bool ndn::IdentityCertificate::isIdentityCertificate ( const Certificate certificate)
static

Definition at line 53 of file identity-certificate.cpp.

bool ndn::Certificate::isTooEarly ( )
inherited

Check if the certificate is valid.

Returns
True if the current time is earlier than notBefore.

Definition at line 39 of file certificate.cpp.

bool ndn::Certificate::isTooLate ( )
inherited

Check if the certificate is valid.

Returns
True if the current time is later than notAfter.

Definition at line 48 of file certificate.cpp.

bool ndn::Data::operator!= ( const Data other) const
inlineinherited

Definition at line 517 of file data.hpp.

bool ndn::Data::operator== ( const Data other) const
inlineinherited

Definition at line 508 of file data.hpp.

void ndn::Certificate::printCertificate ( std::ostream &  os) const
inherited

Definition at line 227 of file certificate.cpp.

void ndn::Data::setContent ( const uint8_t *  content,
size_t  contentLength 
)
inlineinherited

Set the content to a copy of the data in the vector.

Parameters
contentA vector whose contents are copied.
Returns
This Data so that you can chain calls to update values.

Definition at line 422 of file data.hpp.

void ndn::Data::setContent ( const Block content)
inlineinherited

Definition at line 438 of file data.hpp.

void ndn::Data::setContent ( const ConstBufferPtr contentValue)
inlineinherited

Definition at line 430 of file data.hpp.

void ndn::Data::setContentType ( uint32_t  type)
inlineinherited

Definition at line 378 of file data.hpp.

void ndn::Data::setFinalBlockId ( const name::Component finalBlockId)
inlineinherited

Definition at line 404 of file data.hpp.

void ndn::Data::setFreshnessPeriod ( const time::milliseconds &  freshnessPeriod)
inlineinherited

Definition at line 391 of file data.hpp.

void ndn::Data::setIncomingFaceId ( uint64_t  incomingFaceId)
inlineinherited

Definition at line 490 of file data.hpp.

void ndn::Data::setMetaInfo ( const MetaInfo metaInfo)
inlineinherited

Set metaInfo to a copy of the given MetaInfo.

Parameters
metaInfoThe MetaInfo which is copied.
Returns
This Data so that you can chain calls to update values.

Definition at line 365 of file data.hpp.

void ndn::IdentityCertificate::setName ( const Name name)
inline

Definition at line 105 of file identity-certificate.hpp.

void ndn::Certificate::setNotAfter ( const time::system_clock::TimePoint notAfter)
inlineinherited

Definition at line 125 of file certificate.hpp.

void ndn::Certificate::setNotBefore ( const time::system_clock::TimePoint notBefore)
inlineinherited

Definition at line 107 of file certificate.hpp.

void ndn::Certificate::setPublicKeyInfo ( const PublicKey key)
inlineinherited

Definition at line 143 of file certificate.hpp.

void ndn::Data::setSignature ( const Signature signature)
inlineinherited

Set the signature to a copy of the given signature.

Parameters
signatureThe signature object which is cloned.

Definition at line 456 of file data.hpp.

void ndn::Data::setSignatureValue ( const Block value)
inlineinherited

Definition at line 463 of file data.hpp.

void ndn::IdentityCertificate::wireDecode ( const Block wire)
inline

Definition at line 98 of file identity-certificate.hpp.

template<bool T>
size_t ndn::Data::wireEncode ( EncodingImpl< T > &  block,
bool  unsignedPortion = false 
) const
inlineinherited

Fast encoding or block size estimation.

Definition at line 242 of file data.hpp.

const Block & ndn::Data::wireEncode ( ) const
inlineinherited

Encode to a wire format.

Definition at line 286 of file data.hpp.

Field Documentation

ExtensionList ndn::Certificate::m_extensionList
protectedinherited

Definition at line 189 of file certificate.hpp.

PublicKey ndn::Certificate::m_key
protectedinherited

Definition at line 188 of file certificate.hpp.

time::system_clock::TimePoint ndn::Certificate::m_notAfter
protectedinherited

Definition at line 187 of file certificate.hpp.

time::system_clock::TimePoint ndn::Certificate::m_notBefore
protectedinherited

Definition at line 186 of file certificate.hpp.

Name ndn::IdentityCertificate::m_publicKeyName
protected

Definition at line 77 of file identity-certificate.hpp.

SubjectDescriptionList ndn::Certificate::m_subjectDescriptionList
protectedinherited

Definition at line 185 of file certificate.hpp.