com.google.crypto.tink.aead

Class AesGcmParameters.Builder

java.lang.Object

com.google.crypto.tink.aead.AesGcmParameters.Builder

Enclosing class:

AesGcmParameters

public static final class AesGcmParameters.Builder
extends Object

Builds a new AesGcmParameters instance. The class AesGcmParameters is not responsible for checking if all allowed values for the parameters are implemented and satisfy any potential security policies. Some implementation may not support the full set of parameters at the moment and may restrict them to certain lengths (i.e. key size may be restricted to 16 or 32 bytes).

Method Summary

Modifier and Type	Method and Description
AesGcmParameters	build()
AesGcmParameters.Builder	setIvSizeBytes(int ivSizeBytes) IV size must greater than 0.
AesGcmParameters.Builder	setKeySizeBytes(int keySizeBytes) Accepts key sizes of 16, 24 or 32 bytes.
AesGcmParameters.Builder	setTagSizeBytes(int tagSizeBytes) Tag size must be one of the following five values: 128, 120, 112, 104 or 96 bytes
AesGcmParameters.Builder	setVariant(AesGcmParameters.Variant variant)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setKeySizeBytes

@CanIgnoreReturnValue
public AesGcmParameters.Builder setKeySizeBytes(int keySizeBytes)
                                                               throws GeneralSecurityException

Accepts key sizes of 16, 24 or 32 bytes.

Throws:

GeneralSecurityException

setIvSizeBytes

@CanIgnoreReturnValue
public AesGcmParameters.Builder setIvSizeBytes(int ivSizeBytes)
                                                              throws GeneralSecurityException

IV size must greater than 0.

Throws:

GeneralSecurityException

setTagSizeBytes

@CanIgnoreReturnValue
public AesGcmParameters.Builder setTagSizeBytes(int tagSizeBytes)
                                                               throws GeneralSecurityException

Tag size must be one of the following five values: 128, 120, 112, 104 or 96 bytes

Throws:

GeneralSecurityException

setVariant

@CanIgnoreReturnValue
public AesGcmParameters.Builder setVariant(AesGcmParameters.Variant variant)

build

public AesGcmParameters build()
                       throws GeneralSecurityException

Throws:

GeneralSecurityException