KeccakDigest (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- org.bouncycastle.crypto.digests.KeccakDigest

All Implemented Interfaces:
Digest, ExtendedDigest
Direct Known Subclasses:
SHA3Digest, SHAKEDigest
```
public class KeccakDigest
extends Object
implements ExtendedDigest
```
implementation of Keccak based on following KeccakNISTInterface.c from https://keccak.noekeon.org/
Following the naming conventions used in the C source code to enable easy review of the implementation.

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`bitsInQueue` bitsInQueue.
`protected byte[]`	`dataQueue` dataQueue.
`protected int`	`fixedOutputLength` fixedOutputLength.
`protected CryptoServicePurpose`	`purpose` purpose.
`protected int`	`rate` rate.
`protected boolean`	`squeezing` squeezing.
`protected long[]`	`state` state.

Constructor Summary

Constructors
Constructor and Description
`KeccakDigest()` KeccakDigest.
`KeccakDigest(CryptoServicePurpose purpose)` KeccakDigest.
`KeccakDigest(int bitLength)` KeccakDigest.
`KeccakDigest(int bitLength, CryptoServicePurpose purpose)` KeccakDigest.
`KeccakDigest(KeccakDigest source)` KeccakDigest.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`absorb(byte data)` absorb.
`protected void`	`absorb(byte[] data, int off, int len)` absorb.
`protected void`	`absorbBits(int data, int bits)` absorbBits.
`protected CryptoServiceProperties`	`cryptoServiceProperties()` cryptoServiceProperties.
`int`	`doFinal(byte[] out, int outOff)` doFinal.
`protected int`	`doFinal(byte[] out, int outOff, byte partialByte, int partialBits)` doFinal.
`String`	`getAlgorithmName()` getAlgorithmName.
`int`	`getByteLength()` Return the size of block that the compression function is applied to in bytes.
`int`	`getDigestSize()` getDigestSize.
`void`	`reset()` reset.
`protected void`	`squeeze(byte[] output, int offset, long outputLength)` squeeze.
`void`	`update(byte in)` update.
`void`	`update(byte[] in, int inOff, int len)` update.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - bitsInQueue
```
protected int bitsInQueue
```
    bitsInQueue.
  - dataQueue
```
protected byte[] dataQueue
```
    dataQueue.
  - fixedOutputLength
```
protected int fixedOutputLength
```
    fixedOutputLength.
  - purpose
```
protected final CryptoServicePurpose purpose
```
    purpose.
  - rate
```
protected int rate
```
    rate.
  - squeezing
```
protected boolean squeezing
```
    squeezing.
  - state
```
protected long[] state
```
    state.
- Constructor Detail
  - KeccakDigest
```
public KeccakDigest()
```
    KeccakDigest.
  - KeccakDigest
```
public KeccakDigest(CryptoServicePurpose purpose)
```
    KeccakDigest.
  - KeccakDigest
```
public KeccakDigest(int bitLength)
```
    KeccakDigest.
  - KeccakDigest
```
public KeccakDigest(int bitLength,
                    CryptoServicePurpose purpose)
```
    KeccakDigest.
  - KeccakDigest
```
public KeccakDigest(KeccakDigest source)
```
    KeccakDigest.
- Method Detail
  - absorb
```
protected void absorb(byte data)
```
    absorb.
  - absorb
```
protected void absorb(byte[] data,
                      int off,
                      int len)
```
    absorb.
  - absorbBits
```
protected void absorbBits(int data,
                          int bits)
```
    absorbBits.
  - cryptoServiceProperties
```
protected CryptoServiceProperties cryptoServiceProperties()
```
    cryptoServiceProperties.
  - doFinal
```
public int doFinal(byte[] out,
                   int outOff)
```
    doFinal.
    Specified by:
    doFinal in interface Digest
    Parameters:
    out - the array the digest is to be copied into.
    outOff - the offset into the out array the digest is to start at.
  - doFinal
```
protected int doFinal(byte[] out,
                      int outOff,
                      byte partialByte,
                      int partialBits)
```
    doFinal.
  - getAlgorithmName
```
public String getAlgorithmName()
```
    getAlgorithmName.
    Specified by:
    getAlgorithmName in interface Digest
    Returns:
    the algorithm name
  - getByteLength
```
public int getByteLength()
```
    Return the size of block that the compression function is applied to in bytes.
    Specified by:
    getByteLength in interface ExtendedDigest
    Returns:
    internal byte length of a block.
  - getDigestSize
```
public int getDigestSize()
```
    getDigestSize.
    Specified by:
    getDigestSize in interface Digest
    Returns:
    the size, in bytes, of the digest produced by this message digest.
  - reset
```
public void reset()
```
    reset.
    Specified by:
    reset in interface Digest
  - squeeze
```
protected void squeeze(byte[] output,
                       int offset,
                       long outputLength)
```
    squeeze.
  - update
```
public void update(byte in)
```
    update.
    Specified by:
    update in interface Digest
    Parameters:
    in - the input byte to be entered.
  - update
```
public void update(byte[] in,
                   int inOff,
                   int len)
```
    update.
    Specified by:
    update in interface Digest
    Parameters:
    in - the byte array containing the data.
    inOff - the offset into the byte array where the data starts.
    len - the length of the data.

Class KeccakDigest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

bitsInQueue

dataQueue

fixedOutputLength

purpose

rate

squeezing

state

Constructor Detail

KeccakDigest

KeccakDigest

KeccakDigest

KeccakDigest

KeccakDigest

Method Detail

absorb

absorb

absorbBits

cryptoServiceProperties

doFinal

doFinal

getAlgorithmName

getByteLength

getDigestSize

reset

squeeze

update

update