Armadillo.Builder (armadillo 0.5.0 API)

java.lang.Object
- at.favre.lib.armadillo.Armadillo.Builder

Enclosing class:: Armadillo

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`android.content.SharedPreferences`	`build()` Build a `SharedPreferences` instance
`Armadillo.Builder`	`compress()` Compresses the content with Gzip before encrypting and writing it to shared preference.
`Armadillo.Builder`	`compress(at.favre.lib.armadillo.Compressor compressor)` Compresses the content with given compressor before encrypting and writing it to shared preference.
`Armadillo.Builder`	`contentKeyDigest(byte[] salt)`
`Armadillo.Builder`	`contentKeyDigest(int contentKeyOutLength)`
`Armadillo.Builder`	`contentKeyDigest(StringMessageDigest stringMessageDigest)`
`Armadillo.Builder`	`cryptoProtocolVersion(int version)` Per default the crypto/data format version is '0', but if the behavior is changed by e.g.
`Armadillo.Builder`	`dataObfuscatorFactory(DataObfuscator.Factory dataObfuscatorFactory)` Set your own data obfuscation implementation.
`Armadillo.Builder`	`encryptionFingerprint(byte[] fingerprint)`
`Armadillo.Builder`	`encryptionFingerprint(android.content.Context context)`
`Armadillo.Builder`	`encryptionFingerprint(android.content.Context context, byte[] additionalData)`
`Armadillo.Builder`	`encryptionFingerprint(android.content.Context context, java.lang.String... additionalData)`
`Armadillo.Builder`	`encryptionFingerprint(EncryptionFingerprint fingerprint)`
`Armadillo.Builder`	`encryptionKeyStrength(int keyStrength)` Set the key length for the symmetric encryption.
`Armadillo.Builder`	`keyStretchingFunction(KeyStretchingFunction keyStretchingFunction)` Set a different key derivation function for provided password.
`Armadillo.Builder`	`password(char[] password)` Provide a user password used for all of entries of the `SharedPreferences`.
`Armadillo.Builder`	`recoveryPolicy(boolean throwRuntimeException, boolean removeBrokenContent)`
`Armadillo.Builder`	`recoveryPolicy(RecoveryPolicy recoveryPolicy)`
`Armadillo.Builder`	`secureRandom(java.security.SecureRandom secureRandom)` Provide your own `SecureRandom` implementation.
`Armadillo.Builder`	`securityProvider(java.security.Provider provider)` Set the security provider for most cryptographic primitives (symmetric encryption, pbkdf2, ...).
`Armadillo.Builder`	`symmetricEncryption(AuthenticatedEncryption authenticatedEncryption)` Set your own implementation of `AuthenticatedEncryption`.

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

- Method Detail
  - encryptionFingerprint
```
public Armadillo.Builder encryptionFingerprint(android.content.Context context)
```
  - encryptionFingerprint
```
public Armadillo.Builder encryptionFingerprint(android.content.Context context,
                                               byte[] additionalData)
```
  - encryptionFingerprint
```
public Armadillo.Builder encryptionFingerprint(android.content.Context context,
                                               java.lang.String... additionalData)
```
  - encryptionFingerprint
```
public Armadillo.Builder encryptionFingerprint(EncryptionFingerprint fingerprint)
```
  - encryptionFingerprint
```
public Armadillo.Builder encryptionFingerprint(byte[] fingerprint)
```
  - contentKeyDigest
```
public Armadillo.Builder contentKeyDigest(byte[] salt)
```
  - contentKeyDigest
```
public Armadillo.Builder contentKeyDigest(int contentKeyOutLength)
```
  - contentKeyDigest
```
public Armadillo.Builder contentKeyDigest(StringMessageDigest stringMessageDigest)
```
  - encryptionKeyStrength
```
public Armadillo.Builder encryptionKeyStrength(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 wouldn't use this lib anyway)
    Parameters:
    
    keyStrength - HIGH (default) or VERY HIGH
    
    Returns:
    
    builder
  - securityProvider
```
public Armadillo.Builder securityProvider(java.security.Provider provider)
```
    Set the security provider for most cryptographic primitives (symmetric encryption, pbkdf2, ...). Per default the default provider is used and this should be fine in most cases.
    Only set if you know what you are doing.
    
    Parameters:
    
    provider - JCA provider
    
    Returns:
    
    builder
  - symmetricEncryption
```
public Armadillo.Builder symmetricEncryption(AuthenticatedEncryption authenticatedEncryption)
```
    Set your own implementation of AuthenticatedEncryption. Use this if setting the security provider with securityProvider(Provider) is not enough customization. With this a any symmetric encryption algorithm might be used.
    Only set if you know what you are doing.
    
    Parameters:
    
    authenticatedEncryption - to be used by the shared preferences
    
    Returns:
    
    builder
  - keyStretchingFunction
```
public Armadillo.Builder keyStretchingFunction(KeyStretchingFunction keyStretchingFunction)
```
    Set a different key derivation function for provided password. Per default BcryptKeyStretcher is used. There is also a implementation PBKDF2 (see PBKDF2KeyStretcher. 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 by the shared preferences
    
    Returns:
    
    builder
  - dataObfuscatorFactory
```
public Armadillo.Builder dataObfuscatorFactory(DataObfuscator.Factory dataObfuscatorFactory)
```
    Set your own data obfuscation implementation. Data obfuscation is used to disguise the persistence data format. See HkdfXorObfuscator for the default obfuscation technique.
    Only set if you know what you are doing.
    
    Parameters:
    
    dataObfuscatorFactory - that creates a obfuscator with given key
    
    Returns:
    
    builder
  - secureRandom
```
public Armadillo.Builder secureRandom(java.security.SecureRandom secureRandom)
```
    Provide your own SecureRandom implementation. Per default a no-provider constructor is used for SecureRandom which is the currently recommended way (https://tersesystems.com/blog/2015/12/17/the-right-way-to-use-securerandom/)
    Only set if you know what you are doing.
    
    Parameters:
    
    secureRandom - implementation
    
    Returns:
    
    builder
  - recoveryPolicy
```
public Armadillo.Builder recoveryPolicy(boolean throwRuntimeException,
                                        boolean removeBrokenContent)
```
  - recoveryPolicy
```
public Armadillo.Builder recoveryPolicy(RecoveryPolicy recoveryPolicy)
```
  - password
```
public Armadillo.Builder password(char[] password)
```
    Provide a user password used for all of entries of the SharedPreferences.
    The password is treated as weak and is therefore subject to be stretched by the provided key derivation function with key stretching property (see keyStretchingFunction(KeyStretchingFunction). A side-effect is that putting or reading content is expensive and should not be done on the main thread.
    
    Parameters:
    
    password - provided by user
    
    Returns:
    
    builder
  - cryptoProtocolVersion
```
public Armadillo.Builder cryptoProtocolVersion(int version)
```
    Per default the crypto/data format version is '0', but if the behavior is changed by e.g. setting a different key-stretching function or contentKey digest, 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:
    
    version - to persist with the data
    
    Returns:
    
    builder
  - compress
```
public Armadillo.Builder compress()
```
    Compresses the content with Gzip before encrypting and writing it to shared preference. This only makes sense if bigger structural data is persisted like long xml or json.
    
    Returns:
    
    builder
  - compress
```
public Armadillo.Builder compress(at.favre.lib.armadillo.Compressor compressor)
```
    Compresses the content with given compressor before encrypting and writing it to shared preference.
    
    Returns:
    
    builder
  - build
```
public android.content.SharedPreferences build()
```
    Build a SharedPreferences instance
    
    Returns:
    
    shared preference with given properties

Class Armadillo.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

encryptionFingerprint

encryptionFingerprint

encryptionFingerprint

encryptionFingerprint

encryptionFingerprint

contentKeyDigest

contentKeyDigest

contentKeyDigest

encryptionKeyStrength

securityProvider

symmetricEncryption

keyStretchingFunction

dataObfuscatorFactory

secureRandom

recoveryPolicy

recoveryPolicy

password

cryptoProtocolVersion

compress

compress

build