SHA3Digest

java.lang.Object

org.bouncycastle.crypto.digests.KeccakDigest

org.bouncycastle.crypto.digests.SHA3Digest

All Implemented Interfaces:: Digest, ExtendedDigest

public class SHA3Digestextends KeccakDigest

Implementation of SHA-3 based on following KeccakNISTInterface.c from keccak.team

Following the naming conventions used in the C source code to enable easy review of the implementation.

Field Summary
Fields inherited from class KeccakDigest
bitsInQueue, dataQueue, fixedOutputLength, purpose, rate, squeezing, state
Modifier and Type
Field
Description
protected int
bitsInQueue
Number of message bits currently held in dataQueue.
protected byte[]
dataQueue
Buffer holding message bits not yet absorbed into the state.
protected int
fixedOutputLength
Digest capacity in bits, twice the output length.
protected final CryptoServicePurpose
purpose
Crypto service purpose this digest instance was created for.
protected int
rate
Sponge rate in bits, the number of message bits absorbed per permutation.
protected boolean
squeezing
True once padding has been applied and output is being squeezed.
protected long[]
state
The sponge state, 25 lanes of 64 bits each.
Constructor Summary
Constructors
Constructor
Description
SHA3Digest()
SHA3Digest.
SHA3Digest(int bitLength)
SHA3Digest.
SHA3Digest(int bitLength, CryptoServicePurpose purpose)
SHA3Digest.
SHA3Digest(CryptoServicePurpose purpose)
SHA3Digest.
SHA3Digest(SHA3Digest source)
SHA3Digest.
Method Summary
Modifier and Type
Method
Description
private static int
checkBitLength(int bitLength)
Rejects a bit length that is not a multiple of 8.
int
doFinal(byte[] out, int outOff)
Pad the sponge and squeeze out the digest.
protected int
doFinal(byte[] out, int outOff, byte partialByte, int partialBits)
Pad and squeeze out the digest for a message ending mid-byte.
String
getAlgorithmName()
Names the digest by family and output size, e.g.
Methods inherited from class KeccakDigest
absorb, absorb, absorbBits, cryptoServiceProperties, getByteLength, getDigestSize, reset, squeeze, update, update
Modifier and Type
Method
Description
protected void
absorb(byte data)
Absorb one byte into the sponge, permuting once the rate is reached.
protected void
absorb(byte[] data, int off, int len)
Absorb a byte range into the sponge, permuting once per rate-sized block.
protected void
absorbBits(int data, int bits)
Absorb the trailing 1-7 bits of a message, leaving the queue not a multiple of 8 so that no further absorbing is possible.
protected CryptoServiceProperties
cryptoServiceProperties()
Describe this digest's properties for the crypto services registrar.
int
getByteLength()
Return the size of block that the compression function is applied to in bytes.
int
getDigestSize()
Get the size of the digest this class produces.
void
reset()
Clear all absorbed message and output state, making the instance ready for a fresh message at its existing capacity.
protected void
squeeze(byte[] output, int offset, long outputLength)
Squeeze outputLength bits out of the sponge, padding first if the message has not been finished.
void
update(byte in)
Absorb one more byte of message.
void
update(byte[] in, int inOff, int len)
Absorb more message bytes.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- SHA3Digest
  public SHA3Digest()
  SHA3Digest.
- SHA3Digest
  public SHA3Digest(CryptoServicePurpose purpose)
  SHA3Digest.
  Parameters:
  purpose - the intended use of this digest, carried to the crypto services registrar when the digest is registered
- SHA3Digest
  public SHA3Digest(int bitLength)
  SHA3Digest.
  Parameters:
  bitLength - the digest size in bits, one of 224, 256, 384 or 512
- SHA3Digest
  public SHA3Digest(int bitLength, CryptoServicePurpose purpose)
  SHA3Digest.
  Parameters:
  bitLength - the digest size in bits, one of 224, 256, 384 or 512
  purpose - the intended use of this digest, carried to the crypto services registrar when the digest is registered
- SHA3Digest
  public SHA3Digest(SHA3Digest source)
  SHA3Digest.
  Parameters:
  source - the digest to copy the sponge state from, so a partially absorbed message can be continued in the new instance
Method Details
- checkBitLength
  private static int checkBitLength(int bitLength)
  Rejects a bit length that is not a multiple of 8.
  Parameters:
  bitLength - the length to check
  Returns:
  the length, if valid
- getAlgorithmName
  public String getAlgorithmName()
  Names the digest by family and output size, e.g. "SHA3-256".
  Specified by:
  getAlgorithmName in interface Digest
  Overrides:
  getAlgorithmName in class KeccakDigest
  Returns:
  the digest length in bits, prefixed with "Keccak-"
- doFinal
  public int doFinal(byte[] out, int outOff)
  Pad the sponge and squeeze out the digest.
  Specified by:
  doFinal in interface Digest
  Overrides:
  doFinal in class KeccakDigest
  Parameters:
  out - the buffer to write the digest into
  outOff - the offset into out at which to write the digest
  Returns:
  the number of bytes written to out
- doFinal
  protected int doFinal(byte[] out, int outOff, byte partialByte, int partialBits)
  Pad and squeeze out the digest for a message ending mid-byte.
  Overrides:
  doFinal in class KeccakDigest
  Parameters:
  out - the buffer to write the digest into
  outOff - the offset into out at which to write the digest
  partialByte - a byte holding the final 1-7 bits of the message
  partialBits - how many bits of partialByte are message, 1 to 7, or 0 if none
  Returns:
  the number of bytes written to out

Field Summary

Fields inherited from class KeccakDigest

Constructor Summary

Method Summary

Methods inherited from class KeccakDigest

Methods inherited from class Object

Constructor Details

SHA3Digest

SHA3Digest

SHA3Digest

SHA3Digest

Method Details

checkBitLength

getAlgorithmName

doFinal

doFinal