AsconCXof128 (Bouncy Castle Library 1.80 API Specification)

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

All Implemented Interfaces:

Digest, ExtendedDigest, Xof
```
public class AsconCXof128
extends java.lang.Object
implements Xof
```
Ascon-CXOF128 was introduced in NIST Special Publication (SP) 800-232 (Initial Public Draft).
Additional details and the specification can be found in: NIST SP 800-232 (Initial Public Draft). For reference source code and implementation details, please see: Reference, highly optimized, masked C and ASM implementations of Ascon (NIST SP 800-232).

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`ASCON_HASH_RATE`
`protected int`	`ASCON_PB_ROUNDS`
`protected int`	`CRYPTO_BYTES`
`protected byte[]`	`m_buf`
`protected int`	`m_bufPos`
`protected long`	`x0`
`protected long`	`x1`
`protected long`	`x2`
`protected long`	`x3`
`protected long`	`x4`

Constructor Summary

Constructors
Constructor and Description

AsconCXof128()

AsconCXof128(byte[] s)

AsconCXof128(byte[] s, int off, int len)

Constructors
Constructor and Description
`AsconCXof128()`
`AsconCXof128(byte[] s)`
`AsconCXof128(byte[] s, int off, int len)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`doFinal(byte[] output, int outOff)` close the digest, producing the final digest value.
`int`	`doFinal(byte[] output, int outOff, int outLen)` Output the results of the final calculation for this digest to outLen number of bytes.
`int`	`doOutput(byte[] output, int outOff, int outLen)` Start outputting the results of the final calculation for this digest.
`java.lang.String`	`getAlgorithmName()` return the algorithm name
`int`	`getByteLength()` Return the size in bytes of the internal buffer the digest applies it's compression function to.
`int`	`getDigestSize()` return the size, in bytes, of the digest produced by this message digest.
`protected int`	`hash(byte[] output, int outOff, int outLen)`
`protected long`	`loadBytes(byte[] bytes, int inOff)`
`protected long`	`loadBytes(byte[] bytes, int inOff, int n)`
`protected void`	`p(int nr)`
`protected long`	`pad(int i)`
`protected void`	`padAndAbsorb()`
`void`	`reset()` reset the digest back to it's initial state.
`protected void`	`setBytes(long w, byte[] bytes, int inOff)`
`protected void`	`setBytes(long w, byte[] bytes, int inOff, int n)`
`protected void`	`squeeze(byte[] output, int outOff, int len)`
`void`	`update(byte in)` update the message digest with a single byte.
`void`	`update(byte[] input, int inOff, int len)` update the message digest with a block of bytes.

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

Methods inherited from interface org.bouncycastle.crypto.ExtendedDigest
getByteLength

Methods inherited from interface org.bouncycastle.crypto.Digest
doFinal, getDigestSize

- Field Detail
  - x0
```
protected long x0
```
  - x1
```
protected long x1
```
  - x2
```
protected long x2
```
  - x3
```
protected long x3
```
  - x4
```
protected long x4
```
  - CRYPTO_BYTES
```
protected final int CRYPTO_BYTES
```
    See Also:
    
    Constant Field Values
  - ASCON_HASH_RATE
```
protected final int ASCON_HASH_RATE
```
    See Also:
    
    Constant Field Values
  - ASCON_PB_ROUNDS
```
protected int ASCON_PB_ROUNDS
```
  - m_buf
```
protected final byte[] m_buf
```
  - m_bufPos
```
protected int m_bufPos
```
- Constructor Detail
  - AsconCXof128
```
public AsconCXof128()
```
  - AsconCXof128
```
public AsconCXof128(byte[] s)
```
  - AsconCXof128
```
public AsconCXof128(byte[] s,
                    int off,
                    int len)
```
- Method Detail
  - update
```
public void update(byte in)
```
    Description copied from interface: Digest
    
    update the message digest with a single byte.
    
    Specified by:
    
    update in interface Digest
    
    Parameters:
    
    in - the input byte to be entered.
  - update
```
public void update(byte[] input,
                   int inOff,
                   int len)
```
    Description copied from interface: Digest
    
    update the message digest with a block of bytes.
    
    Specified by:
    
    update in interface Digest
    
    Parameters:
    
    input - the byte array containing the data.
    
    inOff - the offset into the byte array where the data starts.
    
    len - the length of the data.
  - pad
```
protected long pad(int i)
```
  - loadBytes
```
protected long loadBytes(byte[] bytes,
                         int inOff)
```
  - loadBytes
```
protected long loadBytes(byte[] bytes,
                         int inOff,
                         int n)
```
  - setBytes
```
protected void setBytes(long w,
                        byte[] bytes,
                        int inOff)
```
  - setBytes
```
protected void setBytes(long w,
                        byte[] bytes,
                        int inOff,
                        int n)
```
  - padAndAbsorb
```
protected void padAndAbsorb()
```
  - getAlgorithmName
```
public java.lang.String getAlgorithmName()
```
    Description copied from interface: Digest
    
    return the algorithm name
    
    Specified by:
    
    getAlgorithmName in interface Digest
    
    Returns:
    
    the algorithm name
  - doOutput
```
public int doOutput(byte[] output,
                    int outOff,
                    int outLen)
```
    Description copied from interface: Xof
    
    Start outputting the results of the final calculation for this digest. Unlike doFinal, this method will continue producing output until the Xof is explicitly reset, or signals otherwise.
    
    Specified by:
    
    doOutput in interface Xof
    
    Parameters:
    
    output - output array to write the output bytes to.
    
    outOff - offset to start writing the bytes at.
    
    outLen - the number of output bytes requested.
    
    Returns:
    
    the number of bytes written
  - doFinal
```
public int doFinal(byte[] output,
                   int outOff,
                   int outLen)
```
    Description copied from interface: Xof
    
    Output the results of the final calculation for this digest to outLen number of bytes.
    
    Specified by:
    
    doFinal in interface Xof
    
    Parameters:
    
    output - output array to write the output bytes to.
    
    outOff - offset to start writing the bytes at.
    
    outLen - the number of output bytes requested.
    
    Returns:
    
    the number of bytes written
  - reset
```
public void reset()
```
    Description copied from interface: Digest
    
    reset the digest back to it's initial state.
    
    Specified by:
    
    reset in interface Digest
  - p
```
protected void p(int nr)
```
  - getDigestSize
```
public int getDigestSize()
```
    Description copied from interface: Digest
    
    return the size, in bytes, of the digest produced by this message digest.
    
    Specified by:
    
    getDigestSize in interface Digest
    
    Returns:
    
    the size, in bytes, of the digest produced by this message digest.
  - getByteLength
```
public int getByteLength()
```
    Description copied from interface: ExtendedDigest
    
    Return the size in bytes of the internal buffer the digest applies it's compression function to.
    
    Specified by:
    
    getByteLength in interface ExtendedDigest
    
    Returns:
    
    byte length of the digests internal buffer.
  - doFinal
```
public int doFinal(byte[] output,
                   int outOff)
```
    Description copied from interface: Digest
    
    close the digest, producing the final digest value. The doFinal call leaves the digest reset.
    
    Specified by:
    
    doFinal in interface Digest
    
    Parameters:
    
    output - the array the digest is to be copied into.
    
    outOff - the offset into the out array the digest is to start at.
  - squeeze
```
protected void squeeze(byte[] output,
                       int outOff,
                       int len)
```
  - hash
```
protected int hash(byte[] output,
                   int outOff,
                   int outLen)
```

Class AsconCXof128

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.bouncycastle.crypto.ExtendedDigest

Methods inherited from interface org.bouncycastle.crypto.Digest

Field Detail

x0

x1

x2

x3

x4

CRYPTO_BYTES

ASCON_HASH_RATE

ASCON_PB_ROUNDS

m_buf

m_bufPos

Constructor Detail

AsconCXof128

AsconCXof128

AsconCXof128

Method Detail

update

update

pad

loadBytes

loadBytes

setBytes

setBytes

padAndAbsorb

getAlgorithmName

doOutput

doFinal

reset

p

getDigestSize

getByteLength

doFinal

squeeze

hash