anch::crypto::BlockCipherModeOfOperation< Derived, Cipher > Class Template Reference

Block cipher mode of operation interface. More...

#include <bcModOp.hpp>

Inheritance diagram for anch::crypto::BlockCipherModeOfOperation< Derived, Cipher >:

Collaboration diagram for anch::crypto::BlockCipherModeOfOperation< Derived, Cipher >:

Public Member Functions
void	cipher (std::istream &input, std::ostream &output, const std::string &key)
void	decipher (std::istream &input, std::ostream &output, const std::string &key)
void	setNbThread (unsigned int nbThread)

Protected Member Functions
	BlockCipherModeOfOperation (bool cipherParallelizable, bool decipherParallelizable, unsigned int nbThread=1)
virtual	~BlockCipherModeOfOperation ()
virtual std::size_t	cipherBlock (std::array< uint8_t, Cipher::getBlockSize()> &input, std::streamsize nbRead, std::array< uint8_t, Cipher::getBlockSize()> &output, uint32_t index, Cipher &cipher)=0
virtual std::size_t	decipherBlock (std::array< uint8_t, Cipher::getBlockSize()> &input, std::array< uint8_t, Cipher::getBlockSize()> &prevInput, std::streamsize nbRead, bool lastBlock, std::array< uint8_t, Cipher::getBlockSize()> &output, uint32_t index, Cipher &cipher)=0
virtual const std::array< uint8_t, Cipher::getBlockSize()> &	reset ()=0

Friends
class	anch::ThreadPool

Detailed Description

template<typename Derived, typename Cipher>
class anch::crypto::BlockCipherModeOfOperation< Derived, Cipher >

Block cipher mode of operation interface.

Interface for all block cipher mode of operation implementations.

Since

0.1

Author

Vincent Lachenal

Constructor & Destructor Documentation

BlockCipherModeOfOperation()

template<typename Derived, typename Cipher>

anch::crypto::BlockCipherModeOfOperation< Derived, Cipher >::BlockCipherModeOfOperation ( bool cipherParallelizable, bool decipherParallelizable, unsigned int nbThread = 1 )

protected

BlockCipherModeOfOperation constructor

Parameters

cipherParallelizable	Is cipher parallelizable
decipherParallelizable	Is decipher parallelizable
nbThread	the maximum number of thread to run in parallel (default to 1). If is set to 0, it will be set to the number of CPU if found (1 otherwise).

~BlockCipherModeOfOperation()

template<typename Derived, typename Cipher>

anch::crypto::BlockCipherModeOfOperation< Derived, Cipher >::~BlockCipherModeOfOperation ( )

protectedvirtual

BlockCipherModeOfOperation destructor

Member Function Documentation

cipher()

template<typename Derived, typename Cipher>

void anch::crypto::BlockCipherModeOfOperation< Derived, Cipher >::cipher	(	std::istream &	input,
		std::ostream &	output,
		const std::string &	key )

Cipher input stream

Parameters

input	the input stream to cipher
output	the ouput stream to write in
key	the cipher key

Here is the call graph for this function:

cipherBlock()

template<typename Derived, typename Cipher>

virtual std::size_t anch::crypto::BlockCipherModeOfOperation< Derived, Cipher >::cipherBlock ( std::array< uint8_t, Cipher::getBlockSize()> & input, std::streamsize nbRead, std::array< uint8_t, Cipher::getBlockSize()> & output, uint32_t index, Cipher & cipher )

protectedpure virtual

Cipher a block.
This method will handle initialization vector management.

Parameters

input	the input block to cipher
nbRead	the size of block which has been read
output	the output block
index	the block index
cipher	the cipher instance

Returns

the number of bytes to write

Implemented in anch::crypto::CBC< Cipher, Padding >, anch::crypto::CFB< Cipher >, anch::crypto::CTR< Cipher >, anch::crypto::ECB< Cipher, Padding >, anch::crypto::OFB< Cipher >, and anch::crypto::PCBC< Cipher, Padding >.

Here is the call graph for this function:

decipher()

template<typename Derived, typename Cipher>

void anch::crypto::BlockCipherModeOfOperation< Derived, Cipher >::decipher	(	std::istream &	input,
		std::ostream &	output,
		const std::string &	key )

Decipher input stream

Parameters

input	the input stream to decipher
output	the ouput stream to write in
key	the decipher key

Here is the call graph for this function:

decipherBlock()

template<typename Derived, typename Cipher>

virtual std::size_t anch::crypto::BlockCipherModeOfOperation< Derived, Cipher >::decipherBlock ( std::array< uint8_t, Cipher::getBlockSize()> & input, std::array< uint8_t, Cipher::getBlockSize()> & prevInput, std::streamsize nbRead, bool lastBlock, std::array< uint8_t, Cipher::getBlockSize()> & output, uint32_t index, Cipher & cipher )

protectedpure virtual

Decipher a block.
This method will handle initialization vector management.

Parameters

input	the input block to decipher
prevInput	the previous input block to decipher
nbRead	the size of block which has been read
lastBlock	is last block to decipher
output	the output block
index	the block index
cipher	the cipher instance

Returns

the number of bytes to write

Implemented in anch::crypto::CBC< Cipher, Padding >, anch::crypto::CFB< Cipher >, anch::crypto::CTR< Cipher >, anch::crypto::ECB< Cipher, Padding >, anch::crypto::OFB< Cipher >, and anch::crypto::PCBC< Cipher, Padding >.

Here is the call graph for this function:

reset()

template<typename Derived, typename Cipher>

virtual const std::array< uint8_t, Cipher::getBlockSize()> & anch::crypto::BlockCipherModeOfOperation< Derived, Cipher >::reset ( )

protectedpure virtual

Reset block cipher mode of operation context

Returns

the initial context

Implemented in anch::crypto::CBC< Cipher, Padding >, anch::crypto::CFB< Cipher >, anch::crypto::CTR< Cipher >, anch::crypto::ECB< Cipher, Padding >, anch::crypto::OFB< Cipher >, and anch::crypto::PCBC< Cipher, Padding >.

Here is the call graph for this function:

setNbThread()

template<typename Derived, typename Cipher>

void anch::crypto::BlockCipherModeOfOperation< Derived, Cipher >::setNbThread ( unsigned int nbThread )

inline

Maximum number of parallel thread setter

Parameters

nbThread

the maximum number of parallel thread to set

---

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

• anch-crypto/inc/crypto/cipher/bcModOp.hpp