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

The module to encrypt data using block cipher. More...

#include <block-cipher.hpp>

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

Classes

class  Impl
 

Public Member Functions

 BlockCipher (BlockCipherAlgorithm algo, CipherOperator op, const uint8_t *key, size_t keyLen, const uint8_t *iv, size_t ivLen)
 Create a block cipher. More...
 
 ~BlockCipher ()
 
- 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 encrypt data using block cipher.

The padding scheme of the block cipher is set to the OpenSSL default, which is PKCS padding.

Definition at line 38 of file block-cipher.hpp.

Constructor & Destructor Documentation

◆ BlockCipher()

ndn::security::transform::BlockCipher::BlockCipher ( BlockCipherAlgorithm  algo,
CipherOperator  op,
const uint8_t *  key,
size_t  keyLen,
const uint8_t *  iv,
size_t  ivLen 
)

Create a block cipher.

Parameters
algoThe block cipher algorithm to use.
opWhether to encrypt or decrypt.
keyPointer to the key.
keyLenSize of the key.
ivPointer to the initialization vector.
ivLenLength of the initialization vector.

Definition at line 52 of file block-cipher.cpp.

References ndn::AES_CBC, ndn::security::transform::Downstream::getIndex(), and NDN_THROW.

◆ ~BlockCipher()

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

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