NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks 		API Documentation
Public Member Functions | List of all members
ndn::SimpleSymmetricKeyParams< KeyParamsInfo > Class Template Reference

SimpleSymmetricKeyParams is a template for symmetric keys with only one parameter: size. More...

#include <key-params.hpp>

Inheritance diagram for ndn::SimpleSymmetricKeyParams< KeyParamsInfo >:
Inheritance graph
[legend]
Collaboration diagram for ndn::SimpleSymmetricKeyParams< KeyParamsInfo >:
Collaboration graph
[legend]

Public Member Functions

 SimpleSymmetricKeyParams (const name::Component &keyId, uint32_t size=KeyParamsInfo::getDefaultSize())
 Create key parameters with user-specified key id. More...
 
 SimpleSymmetricKeyParams (uint32_t size=KeyParamsInfo::getDefaultSize(), KeyIdType keyIdType=KeyIdType::RANDOM)
 Create key parameters with auto-generated key id. More...
 
uint32_t getKeySize () const
 
- Public Member Functions inherited from ndn::KeyParams
virtual ~KeyParams ()
 
KeyType getKeyType () const
 
KeyIdType getKeyIdType () const
 
const name::Component & getKeyId () const
 
void setKeyId (const name::Component &keyId)
 

Additional Inherited Members

- Protected Member Functions inherited from ndn::KeyParams
 KeyParams (KeyType keyType, KeyIdType keyIdType)
 Constructor. More...
 
 KeyParams (KeyType keyType, const name::Component &keyId)
 Constructor. More...
 

Detailed Description

template<typename KeyParamsInfo>
class ndn::SimpleSymmetricKeyParams< KeyParamsInfo >

SimpleSymmetricKeyParams is a template for symmetric keys with only one parameter: size.

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

Constructor & Destructor Documentation

◆ SimpleSymmetricKeyParams() [1/2]

template<typename KeyParamsInfo >
ndn::SimpleSymmetricKeyParams< KeyParamsInfo >::SimpleSymmetricKeyParams ( const name::Component &  keyId,
uint32_t  size = KeyParamsInfo::getDefaultSize() 
)
inlineexplicit

Create key parameters with user-specified key id.

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

◆ SimpleSymmetricKeyParams() [2/2]

template<typename KeyParamsInfo >
ndn::SimpleSymmetricKeyParams< KeyParamsInfo >::SimpleSymmetricKeyParams ( uint32_t  size = KeyParamsInfo::getDefaultSize(),
KeyIdType  keyIdType = KeyIdType::RANDOM 
)
inlineexplicit

Create key parameters with auto-generated key id.

This method is used only if user does not want to maintain the uniqueness of key name. By default, an 8-byte random number will be used as key id.

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

Member Function Documentation

◆ getKeySize()

template<typename KeyParamsInfo >
uint32_t ndn::SimpleSymmetricKeyParams< KeyParamsInfo >::getKeySize ( ) const
inline

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

Referenced by ndn::security::transform::generatePrivateKey().

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