Panama stream cipher operation. More...

#include <panama.h>

Inheritance diagram for PanamaCipherPolicy:

Protected Member Functions
std::string	AlgorithmProvider () const
	Retrieve the provider of this algorithm.

void	CipherSetKey (const NameValuePairs &params, const byte *key, size_t length)
	Key the cipher.

void	OperateKeystream (KeystreamOperation operation, byte output, const byte input, size_t iterationCount)
	Operates the keystream.

bool	CipherIsRandomAccess () const
	Flag indicating random access.

void	CipherResynchronize (byte keystreamBuffer, const byte iv, size_t length)
	Resynchronize the cipher.

unsigned int	GetAlignment () const
	Provides data alignment requirements.

Protected Member Functions inherited from Panama< B >
	CRYPTOPP_CONSTANT (STAGES=32)

std::string	AlgorithmProvider () const

void	Reset ()

void	Iterate (size_t count, const word32 p=NULLPTR, byte output=NULLPTR, const byte *input=NULLPTR, KeystreamOperation operation=WRITE_KEYSTREAM)

Protected Attributes
FixedSizeSecBlock< word32, 8 >	m_key

FixedSizeSecBlock< word32, 8 >	m_buf

Protected Attributes inherited from Panama< B >
FixedSizeAlignedSecBlock< word32, 20+8 *32 >	m_state

Additional Inherited Members
Public Types inherited from AdditiveCipherConcretePolicy< word32, 8 >
typedef word32	WordType
	Word type for the cipher.

Public Member Functions inherited from AdditiveCipherConcretePolicy< word32, 8 >
	CRYPTOPP_CONSTANT (BYTES_PER_ITERATION=sizeof(WordType) *W)
	Number of bytes for an iteration.

unsigned int	GetBytesPerIteration () const
	Provides number of bytes operated upon during an iteration.

unsigned int	GetIterationsToBuffer () const
	Provides buffer size based on iterations.

bool	CanOperateKeystream () const
	Flag indicating.

Public Member Functions inherited from AdditiveCipherAbstractPolicy
virtual unsigned int	GetOptimalBlockSize () const
	Provides number of ideal bytes to process.

virtual void	WriteKeystream (byte *keystream, size_t iterationCount)
	Generate the keystream.

virtual void	SeekToIteration (lword iterationCount)
	Seeks to a random position in the stream.

Public Member Functions inherited from PanamaCipherInfo< B >
CRYPTOPP_STATIC_CONSTEXPR const char *	StaticAlgorithmName ()

Public Member Functions inherited from FixedKeyLength< 32, SimpleKeyingInterface::UNIQUE_IV, 32 >
	CRYPTOPP_CONSTANT (KEYLENGTH=N)
	The default key length used by the algorithm provided as a constant.

	CRYPTOPP_CONSTANT (MIN_KEYLENGTH=N)
	The minimum key length used by the algorithm provided as a constant.

	CRYPTOPP_CONSTANT (MAX_KEYLENGTH=N)
	The maximum key length used by the algorithm provided as a constant.

	CRYPTOPP_CONSTANT (DEFAULT_KEYLENGTH=N)
	The default key length used by the algorithm provided as a constant.

	CRYPTOPP_CONSTANT (IV_REQUIREMENT=IV_REQ)
	The default IV requirements for the algorithm provided as a constant.

	CRYPTOPP_CONSTANT (IV_LENGTH=IV_L)
	The default IV length used by the algorithm provided as a constant.

CRYPTOPP_STATIC_CONSTEXPR size_t CRYPTOPP_API	StaticGetValidKeyLength (size_t keylength)
	The default key length for the algorithm provided by a static function.

Protected Types inherited from Panama< B >
typedef word32	Stage[8]

Detailed Description

template<class B>
class PanamaCipherPolicy

Panama stream cipher operation.

Definition at line 141 of file panama.h.

Constructor & Destructor Documentation

◆ ~PanamaCipherPolicy()

template<class B >

virtual PanamaCipherPolicy::~PanamaCipherPolicy ( )

inlineprotectedvirtual

Definition at line 146 of file panama.h.

Member Function Documentation

◆ AlgorithmProvider()

template<class B >

std::string PanamaCipherPolicy::AlgorithmProvider ( ) const

protectedvirtual

Retrieve the provider of this algorithm.

Returns: the algorithm provider

The algorithm provider can be a name like "C++", "SSE", "NEON", "AESNI", "ARMv8" and "Power8". C++ is standard C++ code. Other labels, like SSE, usually indicate a specialized implementation using instructions from a higher instruction set architecture (ISA). Future labels may include external hardware like a hardware security module (HSM).

Generally speaking Wei Dai's original IA-32 ASM code falls under "SSE2". Labels like "SSSE3" and "SSE4.1" follow after Wei's code and use intrinsics instead of ASM.

Algorithms which combine different instructions or ISAs provide the dominant one. For example on x86 AES/GCM returns "AESNI" rather than "CLMUL" or "AES+SSE4.1" or "AES+CLMUL" or "AES+SSE4.1+CLMUL".

Note: Provider is not universally implemented yet.

Reimplemented from AdditiveCipherAbstractPolicy.

Definition at line 494 of file panama.cpp.

◆ CipherIsRandomAccess()

template<class B >

bool PanamaCipherPolicy::CipherIsRandomAccess ( ) const

inlineprotectedvirtual

Flag indicating random access.

Returns: true if the cipher is seekable, false otherwise

See also: SeekToIteration()

Implements AdditiveCipherAbstractPolicy.

Definition at line 150 of file panama.h.

◆ CipherResynchronize()

template<class B >

void PanamaCipherPolicy< B >::CipherResynchronize	(	byte *	keystreamBuffer,
		const byte *	iv,
		size_t	length
	)

protectedvirtual

Resynchronize the cipher.

Parameters

keystreamBuffer	the keystream buffer
iv	a byte array used to resynchronize the cipher
length	the size of the IV array

Reimplemented from AdditiveCipherAbstractPolicy.

Definition at line 467 of file panama.cpp.

◆ CipherSetKey()

template<class B >

NAMESPACE_END void PanamaCipherPolicy< B >::CipherSetKey	(	const NameValuePairs &	params,
		const byte *	key,
		size_t	length
	)

protectedvirtual

Key the cipher.

Parameters

params	set of NameValuePairs use to initialize this object
key	a byte array used to key the cipher
length	the size of the key array

Implements AdditiveCipherAbstractPolicy.

Definition at line 459 of file panama.cpp.

◆ GetAlignment()

template<class B >

unsigned int PanamaCipherPolicy::GetAlignment ( ) const

protectedvirtual

Provides data alignment requirements.

Returns: data alignment requirements, in bytes

Internally, the default implementation returns 1. If the stream cipher is implemented using an SSE2 ASM or intrinsics, then the value returned is usually 16.

Reimplemented from AdditiveCipherConcretePolicy< word32, 8 >.

Definition at line 500 of file panama.cpp.

◆ OperateKeystream()

template<class B >

void PanamaCipherPolicy< B >::OperateKeystream	(	KeystreamOperation	operation,
		byte *	output,
		const byte *	input,
		size_t	iterationCount
	)

protectedvirtual

Operates the keystream.

Parameters

operation	the operation with additional flags
output	the output buffer
input	the input buffer
iterationCount	the number of iterations to perform on the input

OperateKeystream() will attempt to operate upon GetOptimalBlockSize() buffer, which will be derived from GetBytesPerIteration().

See also: CanOperateKeystream(), OperateKeystream(), WriteKeystream(), KeystreamOperation()

Implements AdditiveCipherConcretePolicy< word32, 8 >.

Definition at line 511 of file panama.cpp.

Member Data Documentation

◆ m_buf

template<class B >

FixedSizeSecBlock<word32, 8> PanamaCipherPolicy::m_buf

protected

Definition at line 155 of file panama.h.

◆ m_key

template<class B >

FixedSizeSecBlock<word32, 8> PanamaCipherPolicy::m_key

protected

Definition at line 154 of file panama.h.

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

G:/work/subversion/scol-technologies/trunk/scol/plugins/security/cryptopp/panama.h
G:/work/subversion/scol-technologies/trunk/scol/plugins/security/cryptopp/panama.cpp

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~PanamaCipherPolicy()

Member Function Documentation

◆ AlgorithmProvider()

◆ CipherIsRandomAccess()

◆ CipherResynchronize()

◆ CipherSetKey()

◆ GetAlignment()

◆ OperateKeystream()

Member Data Documentation

◆ m_buf

◆ m_key