Class GcmBlockCipher

Namespace

Org.BouncyCastle.Crypto.Modes

Assembly

BouncyCastle.Cryptography.dll

Implements the Galois/Counter mode (GCM) detailed in NIST Special Publication 800-38D.

public sealed class GcmBlockCipher : IAeadBlockCipher, IAeadCipher

Inheritance

object

GcmBlockCipher

Implements

IAeadBlockCipher

IAeadCipher

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

GcmBlockCipher(IBlockCipher)

public GcmBlockCipher(IBlockCipher c)

Parameters

c IBlockCipher

GcmBlockCipher(IBlockCipher, IGcmMultiplier)

[Obsolete("Will be removed")]
public GcmBlockCipher(IBlockCipher c, IGcmMultiplier m)

Parameters

c IBlockCipher

m IGcmMultiplier

Properties

AlgorithmName

The name of the algorithm this cipher implements.

public string AlgorithmName { get; }

Property Value

string

UnderlyingCipher

The block cipher underlying this algorithm.

public 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 int DoFinal(byte[] output, int outOff)

Parameters

output byte[]

outOff int

Returns

int

DoFinal(Span<byte>)

public int DoFinal(Span<byte> output)

Parameters

output Span<byte>

Returns

int

GetBlockSize()

public 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 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 int GetOutputSize(int len)

Parameters

len 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 int GetUpdateOutputSize(int len)

Parameters

len int

Returns

int

Init(bool, ICipherParameters)

public void Init(bool forEncryption, ICipherParameters parameters)

Parameters

forEncryption bool

parameters ICipherParameters

Remarks

MAC sizes from 32 bits to 128 bits (must be a multiple of 8) are supported. The default is 128 bits. Sizes less than 96 are not recommended, but are supported for specialized applications.

ProcessAadByte(byte)

Add a single byte to the associated data check.

public void ProcessAadByte(byte input)

Parameters

input byte

The byte to be processed.

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 void ProcessAadBytes(byte[] inBytes, int inOff, int len)

Parameters

inBytes byte[]

The input byte array.

inOff int

The offset into the input array where the data to be processed starts.

len int

The number of bytes to be processed.

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 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 int ProcessByte(byte input, byte[] output, int outOff)

Parameters

input byte

output byte[]

outOff int

Returns

int

ProcessByte(byte, Span<byte>)

public 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 int ProcessBytes(byte[] input, int inOff, int len, byte[] output, int outOff)

Parameters

input byte[]

inOff int

len int

output byte[]

outOff int

Returns

int

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

public 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 void Reset()