ndn::KeyParams Class Reference

Base class of key parameters. More...

#include <key-params.hpp>

Inheritance diagram for ndn::KeyParams:

Classes
class	Error

Public Member Functions
virtual	~KeyParams ()
KeyType	getKeyType () const
KeyIdType	getKeyIdType () const
const name::Component &	getKeyId () const
void	setKeyId (const name::Component &keyId)

Protected Member Functions
	KeyParams (KeyType keyType, KeyIdType keyIdType)
	Create a key generation parameter. More...
	KeyParams (KeyType keyType, const name::Component &keyId)
	Create a key generation parameter. More...

Detailed Description

Base class of key parameters.

Its subclasses are used to store parameters for key generation.

Definition at line 35 of file key-params.hpp.

Constructor & Destructor Documentation

ndn::KeyParams::~KeyParams ( )

virtualdefault

Referenced by ndn::KeyParams::Error::Error(), and KeyParams().

ndn::KeyParams::KeyParams ( KeyType  keyType, KeyIdType  keyIdType  )

protected

Create a key generation parameter.

Parameters

keyType	Type of the created key
keyIdType	The method how the key id should be generated; must not be KeyIdType::USER_SPECIFIED

Definition at line 31 of file key-params.cpp.

References ndn::USER_SPECIFIED.

Referenced by setKeyId().

ndn::KeyParams::KeyParams ( KeyType  keyType, const name::Component &  keyId  )

protected

Create a key generation parameter.

Parameters

keyType	Type of the created key
keyId	The user-specified key id. The keyIdType will be set to KeyIdType::USER_SPECIFIED. keyId MUST NOT be the empty component.

Postcondition

getKeyIdType() == KeyIdType::USER_SPECIFIED

Definition at line 38 of file key-params.cpp.

References ndn::name::Component::empty(), and ~KeyParams().

Member Function Documentation

KeyType ndn::KeyParams::getKeyType ( ) const

inline

Definition at line 52 of file key-params.hpp.

Referenced by ndn::security::tpm::Tpm::createKey(), ndn::security::tpm::BackEndOsx::derivePublicKey(), and ndn::security::transform::generatePrivateKey().

KeyIdType ndn::KeyParams::getKeyIdType ( ) const

inline

Definition at line 58 of file key-params.hpp.

Referenced by ndn::security::tpm::BackEnd::createKey(), and ndn::security::tpm::BackEnd::setKeyName().

const name::Component& ndn::KeyParams::getKeyId ( ) const

inline

Definition at line 64 of file key-params.hpp.

Referenced by ndn::security::tpm::BackEnd::createKey(), and ndn::security::tpm::BackEnd::setKeyName().

void ndn::KeyParams::setKeyId ( const name::Component &  keyId )

inline

Definition at line 70 of file key-params.hpp.

References KeyParams().

---

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

• ndnSIM/ndn-cxx/src/security/key-params.hpp
• ndnSIM/ndn-cxx/src/security/key-params.cpp