at.favre.lib.armadillo

Class EncryptionProtocolConfig.Builder

java.lang.Object

at.favre.lib.armadillo.EncryptionProtocolConfig.Builder

Enclosing class:

EncryptionProtocolConfig

public static final class EncryptionProtocolConfig.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
EncryptionProtocolConfig.Builder	authenticatedEncryption(AuthenticatedEncryption authenticatedEncryption) Set your own implementation of AuthenticatedEncryption.
EncryptionProtocolConfig	build() Create new config instance
EncryptionProtocolConfig.Builder	compressor(at.favre.lib.armadillo.Compressor compressor) Set compressor to be used before encryption.
EncryptionProtocolConfig.Builder	dataObfuscatorFactory(DataObfuscator.Factory dataObfuscatorFactory) Set your own data obfuscation implementation.
EncryptionProtocolConfig.Builder	keyStrength(int keyStrength) Set the key length for the symmetric encryption.
EncryptionProtocolConfig.Builder	keyStretchingFunction(KeyStretchingFunction keyStretchingFunction) Set a different key derivation function for provided password.
EncryptionProtocolConfig.Builder	protocolVersion(int protocolVersion) A custom crypto protocol version can be set, to be able to migrate the data.

Methods inherited from class java.lang.Object

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

Method Detail

protocolVersion

public EncryptionProtocolConfig.Builder protocolVersion(int protocolVersion)

A custom crypto protocol version can be set, to be able to migrate the data.

The protocol version will be used as additional associated data with the authenticated encryption.

Parameters:

protocolVersion - to persist with the data

Returns:

builder

authenticatedEncryption

public EncryptionProtocolConfig.Builder authenticatedEncryption(AuthenticatedEncryption authenticatedEncryption)

Set your own implementation of AuthenticatedEncryption.

Only set if you know what you are doing.

Parameters:

authenticatedEncryption - to be used

Returns:

builder

keyStrength

public EncryptionProtocolConfig.Builder keyStrength(int keyStrength)

Set the key length for the symmetric encryption.

Currently there are 2 options:

• HIGH - is (or comparable) to AES with 128 bit key length
• VERY HIGH - is (or comparable) to AES with 256 bit key length

Note: Usually there is no real advantage to set it to VERY HIGH as HIGH (128 bit key length) is fully secure for the foreseeable future. VERY HIGH only adds more security margin for possible quantum computer attacks (but if you are a user which is threatened by these kinds of attacks you probably require higher degrees af protection)

Parameters:

keyStrength - HIGH (default) or VERY HIGH

Returns:

builder

keyStretchingFunction

public EncryptionProtocolConfig.Builder keyStretchingFunction(KeyStretchingFunction keyStretchingFunction)

Set a different key derivation function for provided password. If you want to use a different function (e.g. scrypt) set the implementation here.

If you want to disable the key stretching feature you might use FastKeyStretcher here.

Parameters:

keyStretchingFunction - to be used

Returns:

builder

dataObfuscatorFactory

public EncryptionProtocolConfig.Builder dataObfuscatorFactory(DataObfuscator.Factory dataObfuscatorFactory)

Set your own data obfuscation implementation. Data obfuscation is used to disguise the persistence data format.

Only set if you know what you are doing.

Parameters:

dataObfuscatorFactory - that creates a obfuscator with given key

Returns:

builder

compressor

public EncryptionProtocolConfig.Builder compressor(at.favre.lib.armadillo.Compressor compressor)

Set compressor to be used before encryption.

Parameters:

compressor - to set

Returns:

builder

build

public EncryptionProtocolConfig build()

Create new config instance

Returns:

config