Class GcmSivBlockCipher

Namespace

Org.BouncyCastle.Crypto.Modes

Assembly

BouncyCastle.Cryptography.dll

public class GcmSivBlockCipher : IAeadBlockCipher, IAeadCipher

Inheritance

object

GcmSivBlockCipher

Implements

IAeadBlockCipher

IAeadCipher

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

GcmSivBlockCipher()

public GcmSivBlockCipher()

GcmSivBlockCipher(IBlockCipher)

public GcmSivBlockCipher(IBlockCipher pCipher)

Parameters

pCipher IBlockCipher

GcmSivBlockCipher(IBlockCipher, IGcmMultiplier)

[Obsolete("Will be removed")]
public GcmSivBlockCipher(IBlockCipher pCipher, IGcmMultiplier pMultiplier)

Parameters

pCipher IBlockCipher

pMultiplier IGcmMultiplier

Properties

AlgorithmName

The name of the algorithm this cipher implements.

public virtual string AlgorithmName { get; }

Property Value

string

UnderlyingCipher

The block cipher underlying this algorithm.

public virtual IBlockCipher UnderlyingCipher { get; }

Property Value

IBlockCipher

Methods

DoFinal(byte[], int)

Finish the operation either appending or verifying the MAC at the end of the data.

@param outBytes space for any resulting output data. @param outOff offset into out to start copying the data at. @return number of bytes written into out. @throws InvalidOperationException if the cipher is in an inappropriate state. @throws InvalidCipherTextException if the MAC fails to match.

public virtual int DoFinal(byte[] pOutput, int pOffset)

Parameters

pOutput byte[]

pOffset int

Returns

int

DoFinal(Span<byte>)

public virtual int DoFinal(Span<byte> output)

Parameters

output Span<byte>

Returns

int

GetBlockSize()

public virtual int GetBlockSize()

Returns

int

The block size for this cipher, in bytes.

GetMac()

Return the value of the MAC associated with the last stream processed.

@return MAC for plaintext data.

public virtual byte[] GetMac()

Returns

byte[]

GetOutputSize(int)

Return the size of the output buffer required for a ProcessBytes plus a DoFinal with an input of len bytes.

@param len the length of the input. @return the space required to accommodate a call to ProcessBytes and DoFinal with len bytes of input.

public virtual int GetOutputSize(int pLen)

Parameters

pLen int

Returns

int

GetUpdateOutputSize(int)

Return the size of the output buffer required for a ProcessBytes an input of len bytes.

@param len the length of the input. @return the space required to accommodate a call to ProcessBytes with len bytes of input.

public virtual int GetUpdateOutputSize(int pLen)

Parameters

pLen int

Returns

int

Init(bool, ICipherParameters)

Initialise the cipher.

public virtual void Init(bool pEncrypt, ICipherParameters cipherParameters)

Parameters

pEncrypt bool

cipherParameters ICipherParameters

Remarks

Parameter can either be an AeadParameters or a ParametersWithIV object.

ProcessAadByte(byte)

Add a single byte to the associated data check.

public virtual void ProcessAadByte(byte pByte)

Parameters

pByte byte

Remarks

If the implementation supports it, this will be an online operation and will not retain the associated data.

ProcessAadBytes(byte[], int, int)

Add a sequence of bytes to the associated data check.

public virtual void ProcessAadBytes(byte[] pData, int pOffset, int pLen)

Parameters

pData byte[]

pOffset int

pLen int

Remarks

If the implementation supports it, this will be an online operation and will not retain the associated data.

ProcessAadBytes(ReadOnlySpan<byte>)

Add a span of bytes to the associated data check.

public virtual void ProcessAadBytes(ReadOnlySpan<byte> input)

Parameters

input ReadOnlySpan<byte>

the span containing the data.

Remarks

If the implementation supports it, this will be an online operation and will not retain the associated data.

ProcessByte(byte, byte[], int)

Encrypt/decrypt a single byte.

@param input the byte to be processed. @param outBytes the output buffer the processed byte goes into. @param outOff the offset into the output byte array the processed data starts at. @return the number of bytes written to out. @exception DataLengthException if the output buffer is too small.

public virtual int ProcessByte(byte pByte, byte[] pOutput, int pOutOffset)

Parameters

pByte byte

pOutput byte[]

pOutOffset int

Returns

int

ProcessByte(byte, Span<byte>)

public virtual int ProcessByte(byte input, Span<byte> output)

Parameters

input byte

output Span<byte>

Returns

int

ProcessBytes(byte[], int, int, byte[], int)

Process a block of bytes from in putting the result into out.

@param inBytes the input byte array. @param inOff the offset into the in array where the data to be processed starts. @param len the number of bytes to be processed. @param outBytes the output buffer the processed bytes go into. @param outOff the offset into the output byte array the processed data starts at. @return the number of bytes written to out. @exception DataLengthException if the output buffer is too small.

public virtual int ProcessBytes(byte[] pData, int pOffset, int pLen, byte[] pOutput, int pOutOffset)

Parameters

pData byte[]

pOffset int

pLen int

pOutput byte[]

pOutOffset int

Returns

int

ProcessBytes(ReadOnlySpan<byte>, Span<byte>)

public virtual int ProcessBytes(ReadOnlySpan<byte> input, Span<byte> output)

Parameters

input ReadOnlySpan<byte>

output Span<byte>

Returns

int

Reset()

Reset the cipher to the same state as it was after the last init (if there was one).

public virtual void Reset()