NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.3: NDN, CCN, CCNx, content centric networks
API Documentation
ndn::security::transform::HmacFilter Class Reference

The module to generate HMAC for input data. More...

#include <hmac-filter.hpp>

Inheritance diagram for ndn::security::transform::HmacFilter:
Collaboration diagram for ndn::security::transform::HmacFilter:

Classes

class  Impl
 

Public Member Functions

 HmacFilter (DigestAlgorithm algo, const uint8_t *key, size_t keyLen)
 Create a module to generate HMAC using digest algorithm algo and key key. More...
 
 ~HmacFilter ()
 
- Public Member Functions inherited from ndn::security::transform::Upstream
virtual ~Upstream ()=default
 
- Public Member Functions inherited from ndn::security::transform::Downstream
virtual ~Downstream ()=default
 
size_t write (const uint8_t *buf, size_t size)
 Accept input data and perform transformation. More...
 
void end ()
 Close the input interface of a module. More...
 
bool isEnd () const
 Check if the input interface of a module is closed. More...
 
void setIndex (size_t index)
 Set the module index. More...
 
size_t getIndex () const
 Get the module index. More...
 

Additional Inherited Members

- Protected Types inherited from ndn::security::transform::Transform
typedef std::vector< uint8_t > OBuffer
 
- Protected Member Functions inherited from ndn::security::transform::Transform
 Transform ()
 
void flushOutputBuffer ()
 Read the content from output buffer and write it into next module. More...
 
void flushAllOutput ()
 Read the all the content from output buffer and write it into next module. More...
 
void setOutputBuffer (unique_ptr< OBuffer > buffer)
 Set output buffer to buffer. More...
 
bool isOutputBufferEmpty () const
 Check if output buffer is empty. More...
 
- Protected Member Functions inherited from ndn::security::transform::Upstream
 Upstream ()
 
void appendChain (unique_ptr< Downstream > tail)
 connect to next transformation module More...
 
DownstreamgetNext ()
 
- Protected Member Functions inherited from ndn::security::transform::Downstream
 Downstream ()
 
- Protected Attributes inherited from ndn::security::transform::Upstream
unique_ptr< Downstreamm_next
 

Detailed Description

The module to generate HMAC for input data.

Definition at line 35 of file hmac-filter.hpp.

Constructor & Destructor Documentation

ndn::security::transform::HmacFilter::HmacFilter ( DigestAlgorithm  algo,
const uint8_t *  key,
size_t  keyLen 
)

Create a module to generate HMAC using digest algorithm algo and key key.

Precondition
key must not be nullptr, and size must be a positive integer.

Definition at line 50 of file hmac-filter.cpp.

References ndn::security::detail::digestAlgorithmToEvpMd(), ndn::security::transform::Transform::flushAllOutput(), ndn::security::transform::Downstream::getIndex(), ndn::security::transform::Transform::setOutputBuffer(), and ~HmacFilter().

ndn::security::transform::HmacFilter::~HmacFilter ( )
default

Referenced by HmacFilter().


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