ndn::DigestSha256 Class Reference

Represents a signature of DigestSha256 type. More...

#include <ndn-cxx/security/digest-sha256.hpp>

Inheritance diagram for ndn::DigestSha256:

Collaboration diagram for ndn::DigestSha256:

Public Member Functions
	DigestSha256 ()
	Create empty DigestSha256 signature. More...
	DigestSha256 (const Signature &signature)
	Convert base Signature to DigestSha256 signature. More...
const Block &	getInfo () const
	Get SignatureInfo as wire format. More...
const KeyLocator &	getKeyLocator () const
	Get KeyLocator. More...
const SignatureInfo &	getSignatureInfo () const
	Get SignatureInfo. More...
tlv::SignatureTypeValue	getType () const
	Get SignatureType. More...
const Block &	getValue () const
	Get SignatureValue. More...
bool	hasKeyLocator () const
	Check if KeyLocator exists in SignatureInfo. More...
	operator bool () const
	Determine whether SignatureInfo is valid. More...
void	setInfo (const Block &info)
	Decode SignatureInfo from wire format. More...
void	setInfo (const SignatureInfo &info)
	Set SignatureInfo. More...
void	setKeyLocator (const KeyLocator &keyLocator)
	Set KeyLocator. More...
void	setValue (const Block &value)
	Set SignatureValue. More...
void	unsetKeyLocator ()
	Unset KeyLocator. More...

Protected Attributes
SignatureInfo	m_info
Block	m_value

Detailed Description

Represents a signature of DigestSha256 type.

This signature type provides integrity protection using SHA-256 digest, but no provenance of a Data packet or any kind of guarantee that packet is from the original source.

Definition at line 34 of file digest-sha256.hpp.

Constructor & Destructor Documentation

ndn::DigestSha256::DigestSha256

(

)

Create empty DigestSha256 signature.

Definition at line 26 of file digest-sha256.cpp.

ndn::DigestSha256::DigestSha256 ( const Signature &  signature )

explicit

Convert base Signature to DigestSha256 signature.

Exceptions

Signature::Error

SignatureType is not DigestSha256

Definition at line 31 of file digest-sha256.cpp.

Member Function Documentation

const Block& ndn::Signature::getInfo ( ) const

inlineinherited

Get SignatureInfo as wire format.

Definition at line 73 of file signature.hpp.

const KeyLocator& ndn::Signature::getKeyLocator ( ) const

inlineinherited

Get KeyLocator.

Exceptions

tlv::Error

KeyLocator does not exist in SignatureInfo

Definition at line 125 of file signature.hpp.

const SignatureInfo& ndn::Signature::getSignatureInfo ( ) const

inlineinherited

Get SignatureInfo.

Definition at line 65 of file signature.hpp.

tlv::SignatureTypeValue ndn::Signature::getType ( ) const

inherited

Get SignatureType.

Exceptions

Error

signature is invalid

Definition at line 44 of file signature.cpp.

const Block& ndn::Signature::getValue ( ) const

inlineinherited

Get SignatureValue.

Definition at line 95 of file signature.hpp.

bool ndn::Signature::hasKeyLocator ( ) const

inlineinherited

Check if KeyLocator exists in SignatureInfo.

Definition at line 116 of file signature.hpp.

ndn::Signature::operator bool ( ) const

inlineexplicitinherited

Determine whether SignatureInfo is valid.

Definition at line 57 of file signature.hpp.

void ndn::Signature::setInfo ( const Block &  info )

inherited

Decode SignatureInfo from wire format.

Exceptions

tlv::Error

decode error

Definition at line 53 of file signature.cpp.

void ndn::Signature::setInfo ( const SignatureInfo &  info )

inlineinherited

Set SignatureInfo.

Definition at line 87 of file signature.hpp.

void ndn::Signature::setKeyLocator ( const KeyLocator &  keyLocator )

inlineinherited

Set KeyLocator.

Definition at line 133 of file signature.hpp.

void ndn::Signature::setValue ( const Block &  value )

inherited

Set SignatureValue.

Exceptions

tlv::Error

TLV-TYPE of supplied block is not SignatureValue, or the block does not have TLV-VALUE

Definition at line 59 of file signature.cpp.

void ndn::Signature::unsetKeyLocator ( )

inlineinherited

Unset KeyLocator.

Note

Subclasses of Signature may provide advisory (non-virtual) override to prevent unsetting KeyLocator if it is required by the specification.

Definition at line 144 of file signature.hpp.

Member Data Documentation

SignatureInfo ndn::Signature::m_info

protectedinherited

Definition at line 150 of file signature.hpp.

Block ndn::Signature::m_value

mutableprotectedinherited

Definition at line 151 of file signature.hpp.