Keccak Class Reference

#include <Keccak.h>

Inheritance diagram for Keccak:

[legend]

Collaboration diagram for Keccak:

[legend]

List of all members.

Public Member Functions
	Keccak (unsigned int aRate=1024, unsigned int aCapacity=576, unsigned char aDiversifier=0)
virtual	~Keccak ()
string	getDescription () const
void	pad ()
Protected Attributes
unsigned char	diversifier

---

Detailed Description

Class that implements the Keccak sponge function family.

---

Constructor & Destructor Documentation

Keccak::Keccak	(	unsigned int	aRate = 1024,
		unsigned int	aCapacity = 576,
		unsigned char	aDiversifier = 0
	)

The constructor. It dynamically allocates a KeccakF permutation.

Parameters:

	aRate	The desired rate (in bits) of the Keccak sponge function. This must be a multiple of 8.
	aCapacity	The desired capacity (in bits) of the Keccak sponge function. The sum of the rate and capacity must be equal to the width of one of the Keccak-f permutations.
	aDiversifier	The desired diversifier. This can be any value between 0 and 255.

Keccak::~Keccak

(

)

[virtual]

The destructor. It frees the allocated KeccakF permutation.

---

Member Function Documentation

string Keccak::getDescription

(

)

const [virtual]

Method that returns a string describing the instance of the Keccak sponge function.

Reimplemented from Sponge.

void Keccak::pad

(

)

[virtual]

Method that completes the last incomplete (possibly empty) input block according by padding according to the Keccak specifications.

Precondition:

This function must be used in the absorbing phase only.

Reimplemented from Sponge.

---

Member Data Documentation

unsigned char Keccak::diversifier [protected]

The 8-bit diversifier.

---

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

• Keccak.h
• Keccak.cpp