ndn::SignatureInfo Class Reference

#include <signature-info.hpp>

Classes
class	Error

Public Member Functions
	SignatureInfo ()
	SignatureInfo (tlv::SignatureTypeValue type)
	SignatureInfo (tlv::SignatureTypeValue type, const KeyLocator &keyLocator)
	SignatureInfo (const Block &block)
	Generate SignatureInfo from a block. More...
void	setSignatureType (tlv::SignatureTypeValue type)
	Set SignatureType. More...
int32_t	getSignatureType () const
	Get SignatureType. More...
bool	hasKeyLocator () const
	Check if KeyLocator is set. More...
void	setKeyLocator (const KeyLocator &keyLocator)
	Set KeyLocator. More...
void	unsetKeyLocator ()
	Unset KeyLocator. More...
const KeyLocator &	getKeyLocator () const
	Get KeyLocator. More...
void	setValidityPeriod (const security::ValidityPeriod &validityPeriod)
	Set ValidityPeriod. More...
void	unsetValidityPeriod ()
	Unset ValidityPeriod. More...
security::ValidityPeriod	getValidityPeriod () const
	Get ValidityPeriod. More...
void	appendTypeSpecificTlv (const Block &block)
	Append signature type specific tlv block. More...
const Block &	getTypeSpecificTlv (uint32_t type) const
	Get signature type specific tlv block. More...
template<encoding::Tag TAG>
size_t	wireEncode (EncodingImpl< TAG > &encoder) const
	Encode to a wire format or estimate wire format. More...
const Block &	wireEncode () const
	Encode to a wire format. More...
void	wireDecode (const Block &wire)
	Decode from a wire format. More...
bool	operator== (const SignatureInfo &rhs) const
bool	operator!= (const SignatureInfo &rhs) const

Detailed Description

Definition at line 32 of file signature-info.hpp.

Constructor & Destructor Documentation

SignatureInfo() [1/4]

ndn::SignatureInfo::SignatureInfo

(

)

Definition at line 37 of file signature-info.cpp.

Referenced by ndn::SignatureInfo::Error::Error().

SignatureInfo() [2/4]

ndn::SignatureInfo::SignatureInfo ( tlv::SignatureTypeValue  type )

explicit

Definition at line 43 of file signature-info.cpp.

SignatureInfo() [3/4]

ndn::SignatureInfo::SignatureInfo	(	tlv::SignatureTypeValue	type,
		const KeyLocator &	keyLocator
	)

Definition at line 49 of file signature-info.cpp.

SignatureInfo() [4/4]

ndn::SignatureInfo::SignatureInfo ( const Block &  block )

explicit

Generate SignatureInfo from a block.

Exceptions

tlv::Error

if supplied block is not formatted correctly

Definition at line 56 of file signature-info.cpp.

References wireDecode().

Member Function Documentation

setSignatureType()

void ndn::SignatureInfo::setSignatureType

(

tlv::SignatureTypeValue

type

)

Set SignatureType.

Definition at line 62 of file signature-info.cpp.

References ndn::Block::reset().

Referenced by ndn::SignatureInfo::Error::Error(), and ndn::security::KeyChain::prepareUnsignedIdentityCertificate().

getSignatureType()

int32_t ndn::SignatureInfo::getSignatureType ( ) const

inline

Get SignatureType.

Definition at line 66 of file signature-info.hpp.

Referenced by ndn::Signature::getType(), and ndn::Signature::operator bool().

hasKeyLocator()

bool ndn::SignatureInfo::hasKeyLocator ( ) const

inline

Check if KeyLocator is set.

Definition at line 73 of file signature-info.hpp.

References appendTypeSpecificTlv(), getKeyLocator(), getTypeSpecificTlv(), getValidityPeriod(), operator==(), setKeyLocator(), setValidityPeriod(), unsetKeyLocator(), unsetValidityPeriod(), wireDecode(), and wireEncode().

Referenced by ndn::Signature::hasKeyLocator().

setKeyLocator()

void ndn::SignatureInfo::setKeyLocator

(

const KeyLocator &

keyLocator

)

Set KeyLocator.

Definition at line 69 of file signature-info.cpp.

References ndn::Block::reset().

Referenced by hasKeyLocator(), ndn::security::KeyChain::prepareUnsignedIdentityCertificate(), ndn::security::KeyChain::selfSign(), and ndn::Signature::setKeyLocator().

unsetKeyLocator()

void ndn::SignatureInfo::unsetKeyLocator

(

)

Unset KeyLocator.

Definition at line 77 of file signature-info.cpp.

References ndn::tlv::KeyLocator, and ndn::Block::reset().

Referenced by hasKeyLocator(), and ndn::Signature::unsetKeyLocator().

getKeyLocator()

const KeyLocator & ndn::SignatureInfo::getKeyLocator

(

)

const

Get KeyLocator.

Exceptions

SignatureInfo::Error

if keyLocator does not exist

Definition at line 85 of file signature-info.cpp.

Referenced by ndn::Signature::getKeyLocator(), and hasKeyLocator().

setValidityPeriod()

void ndn::SignatureInfo::setValidityPeriod

(

const security::ValidityPeriod &

validityPeriod

)

Set ValidityPeriod.

Definition at line 94 of file signature-info.cpp.

References unsetValidityPeriod(), and ndn::security::ValidityPeriod::wireEncode().

Referenced by hasKeyLocator().

unsetValidityPeriod()

void ndn::SignatureInfo::unsetValidityPeriod

(

)

Unset ValidityPeriod.

Definition at line 101 of file signature-info.cpp.

References ndn::Block::reset(), and ndn::tlv::ValidityPeriod.

Referenced by hasKeyLocator(), and setValidityPeriod().

getValidityPeriod()

security::ValidityPeriod ndn::SignatureInfo::getValidityPeriod

(

)

const

Get ValidityPeriod.

Definition at line 110 of file signature-info.cpp.

References ndn::tlv::ValidityPeriod.

Referenced by hasKeyLocator().

appendTypeSpecificTlv()

void ndn::SignatureInfo::appendTypeSpecificTlv

(

const Block &

block

)

Append signature type specific tlv block.

Definition at line 120 of file signature-info.cpp.

Referenced by hasKeyLocator(), and wireDecode().

getTypeSpecificTlv()

const Block & ndn::SignatureInfo::getTypeSpecificTlv

(

uint32_t

type

)

const

Get signature type specific tlv block.

Exceptions

SignatureInfo::Error

if the block does not exist

Definition at line 127 of file signature-info.cpp.

Referenced by hasKeyLocator().

wireEncode() [1/2]

template<encoding::Tag TAG>

size_t ndn::SignatureInfo::wireEncode

(

EncodingImpl< TAG > &

encoder

)

const

Encode to a wire format or estimate wire format.

Definition at line 141 of file signature-info.cpp.

References ndn::encoding::prependNonNegativeIntegerBlock(), ndn::tlv::SignatureInfo, ndn::tlv::SignatureType, and ndn::KeyLocator::wireEncode().

Referenced by ndn::Signature::getInfo().

wireEncode() [2/2]

const Block & ndn::SignatureInfo::wireEncode

(

)

const

Encode to a wire format.

Definition at line 168 of file signature-info.cpp.

References ndn::Block::hasWire().

Referenced by hasKeyLocator().

wireDecode()

void ndn::SignatureInfo::wireDecode

(

const Block &

wire

)

Decode from a wire format.

Definition at line 184 of file signature-info.cpp.

References appendTypeSpecificTlv(), ndn::Block::elements_begin(), ndn::Block::elements_end(), ndn::Block::hasWire(), ndn::tlv::KeyLocator, ndn::Block::parse(), ndn::encoding::readNonNegativeInteger(), ndn::tlv::SignatureInfo, ndn::tlv::SignatureType, ndn::Block::type(), and ndn::KeyLocator::wireDecode().

Referenced by hasKeyLocator(), and SignatureInfo().

operator==()

bool ndn::SignatureInfo::operator==

(

const SignatureInfo &

rhs

)

const

Definition at line 224 of file signature-info.cpp.

Referenced by hasKeyLocator().

operator!=()

bool ndn::SignatureInfo::operator!= ( const SignatureInfo &  rhs ) const

inline

Definition at line 136 of file signature-info.hpp.

---

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

• ndnSIM/ndn-cxx/src/signature-info.hpp
• ndnSIM/ndn-cxx/src/signature-info.cpp