Index (armadillo 0.6.0 API)

A B C D E F G H I K N O P R S U

A

addAdditionalDecryptionProtocolConfig(EncryptionProtocolConfig) - Method in class at.favre.lib.armadillo.Armadillo.Builder: Add new EncryptionProtocolConfig to be added to the supported decryption-config list.
apply() - Method in class at.favre.lib.armadillo.SecureSharedPreferences.Editor
Armadillo - Class in at.favre.lib.armadillo: The main API of this library.
Armadillo.Builder - Class in at.favre.lib.armadillo: Builder pattern for creating the configuration for an ArmadilloSharedPreferences instance
ArmadilloSharedPreferences - Interface in at.favre.lib.armadillo: Extending the SharedPreferences interface this exports additional APIs specific to armadillo.
at.favre.lib.armadillo - package at.favre.lib.armadillo
AuthenticatedEncryption - Interface in at.favre.lib.armadillo: Authenticated encryption (AE) and authenticated encryption with associated data (AEAD, variant of AE) is a form of encryption which simultaneously provides confidentiality, integrity, and authenticity assurances on the data.
authenticatedEncryption - Variable in class at.favre.lib.armadillo.EncryptionProtocolConfig
authenticatedEncryption(AuthenticatedEncryption) - Method in class at.favre.lib.armadillo.EncryptionProtocolConfig.Builder: Set your own implementation of AuthenticatedEncryption.
AuthenticatedEncryption.KeyStrength - Annotation Type in at.favre.lib.armadillo
AuthenticatedEncryptionException - Exception in at.favre.lib.armadillo: Thrown during the process of AuthenticatedEncryptionException
AuthenticatedEncryptionException(String) - Constructor for exception at.favre.lib.armadillo.AuthenticatedEncryptionException
AuthenticatedEncryptionException(String, Throwable) - Constructor for exception at.favre.lib.armadillo.AuthenticatedEncryptionException

B

build() - Method in class at.favre.lib.armadillo.Armadillo.Builder: Build a SharedPreferences instance
build() - Method in class at.favre.lib.armadillo.EncryptionProtocolConfig.Builder: Create new config instance
ByteArrayRuntimeObfuscator - Interface in at.favre.lib.armadillo: Simple wrapper for obfuscated in-memory byte array.
ByteArrayRuntimeObfuscator.Default - Class in at.favre.lib.armadillo
byteSizeLength(int) - Method in interface at.favre.lib.armadillo.AuthenticatedEncryption: Get the required key size length in bytes for given security strength type

C

changePassword(char[], KeyStretchingFunction) - Method in interface at.favre.lib.armadillo.ArmadilloSharedPreferences: Changes the user provided password to the new given password and sets a new stretching function.
changePassword(char[]) - Method in interface at.favre.lib.armadillo.ArmadilloSharedPreferences: Changes the user provided password to the new given password.
changePassword(char[]) - Method in class at.favre.lib.armadillo.SecureSharedPreferences
changePassword(char[], KeyStretchingFunction) - Method in class at.favre.lib.armadillo.SecureSharedPreferences
clear() - Method in class at.favre.lib.armadillo.SecureSharedPreferences.Editor
clearAdditionalDecryptionProtocolConfigs() - Method in class at.favre.lib.armadillo.Armadillo.Builder: Clear additionalDecryptionConfigs list.
clearKey() - Method in interface at.favre.lib.armadillo.DataObfuscator: Clears the internal key reference
clearKey() - Method in class at.favre.lib.armadillo.HkdfXorObfuscator
clearKey() - Method in class at.favre.lib.armadillo.NoObfuscator
close() - Method in interface at.favre.lib.armadillo.ArmadilloSharedPreferences: Clears most of the internal state and makes the instance unusable.
close() - Method in class at.favre.lib.armadillo.SecureSharedPreferences
commit() - Method in class at.favre.lib.armadillo.SecureSharedPreferences.Editor
compress() - Method in class at.favre.lib.armadillo.Armadillo.Builder: Compresses the content with Gzip before encrypting and writing it to shared preference.
compress(Compressor) - Method in class at.favre.lib.armadillo.Armadillo.Builder: Compresses the content with given compressor before encrypting and writing it to shared preference.
compress(byte[]) - Method in class at.favre.lib.armadillo.DisabledCompressor
compress(byte[]) - Method in class at.favre.lib.armadillo.GzipCompressor
compressor(Compressor) - Method in class at.favre.lib.armadillo.EncryptionProtocolConfig.Builder: Set compressor to be used before encryption.
compressor - Variable in class at.favre.lib.armadillo.EncryptionProtocolConfig
contains(String) - Method in class at.favre.lib.armadillo.SecureSharedPreferences
CONTENT_KEY_OUT_BYTE_LENGTH - Static variable in class at.favre.lib.armadillo.Armadillo
contentKeyDigest(byte[]) - Method in class at.favre.lib.armadillo.Armadillo.Builder: The content key digest is responsible for hashing the key in the key-value pair of a shared preference.
contentKeyDigest(int) - Method in class at.favre.lib.armadillo.Armadillo.Builder: The content key digest is responsible for hashing the key in the key-value pair of a shared preference.
contentKeyDigest(StringMessageDigest) - Method in class at.favre.lib.armadillo.Armadillo.Builder: The content key digest is responsible for hashing the key in the key-value pair of a shared preference.
create(SharedPreferences) - Static method in class at.favre.lib.armadillo.Armadillo: Create a new instance of the builder with a custom implementation of shared preference.
create(Context, String) - Static method in class at.favre.lib.armadillo.Armadillo: Create a new builder for Armadillo.
create(byte[]) - Method in interface at.favre.lib.armadillo.DataObfuscator.Factory: Creates a new data obfuscator with given key
create(Context, String) - Static method in class at.favre.lib.armadillo.EncryptionFingerprintFactory: Creates a new EncryptionFingerprint including the following data: Fingerprint of the APK signature Android ID: a 8 byte random value on SDK 26 and higher, unique to each combination of app-signing key, user, and device - on SDK 25 and lower only unique to user and device Application package name, Brand, model and name of the device 32 byte hardcoded static random value
create(byte[]) - Method in class at.favre.lib.armadillo.HkdfXorObfuscator.Factory
create(byte[]) - Method in class at.favre.lib.armadillo.NoObfuscator.Factory
cryptoProtocolVersion(int) - Method in class at.favre.lib.armadillo.Armadillo.Builder: Per default the crypto/data format version is '0', but if the behavior is changed by e.g.

D

DataObfuscator - Interface in at.favre.lib.armadillo: Data obfuscation which obfuscates the given byte arrays.
DataObfuscator.Factory - Interface in at.favre.lib.armadillo: Factory method for obfuscator
dataObfuscatorFactory(DataObfuscator.Factory) - Method in class at.favre.lib.armadillo.Armadillo.Builder: Set your own data obfuscation implementation.
dataObfuscatorFactory(DataObfuscator.Factory) - Method in class at.favre.lib.armadillo.EncryptionProtocolConfig.Builder: Set your own data obfuscation implementation.
dataObfuscatorFactory - Variable in class at.favre.lib.armadillo.EncryptionProtocolConfig
decompress(byte[]) - Method in class at.favre.lib.armadillo.DisabledCompressor
decompress(byte[]) - Method in class at.favre.lib.armadillo.GzipCompressor
decrypt(byte[], byte[], byte[]) - Method in interface at.favre.lib.armadillo.AuthenticatedEncryption: Decrypt and verifies the authenticity of given encrypted data
Default(byte[]) - Constructor for class at.favre.lib.armadillo.EncryptionFingerprint.Default
Default(boolean, boolean) - Constructor for class at.favre.lib.armadillo.RecoveryPolicy.Default
DEFAULT_PROTOCOL_VERSION - Static variable in class at.favre.lib.armadillo.Armadillo
deobfuscate(byte[]) - Method in interface at.favre.lib.armadillo.DataObfuscator: De-Obfuscates the given byte array.
deobfuscate(byte[]) - Method in class at.favre.lib.armadillo.HkdfXorObfuscator
deobfuscate(byte[]) - Method in class at.favre.lib.armadillo.NoObfuscator
derive(String, String) - Method in interface at.favre.lib.armadillo.StringMessageDigest: Derives given key given by the caller with given usage description to a hash
DisabledCompressor - Class in at.favre.lib.armadillo: A compressor which does not compress anything, but just returns the same array.
DisabledCompressor() - Constructor for class at.favre.lib.armadillo.DisabledCompressor

E

edit() - Method in class at.favre.lib.armadillo.SecureSharedPreferences
enableKitKatSupport(boolean) - Method in class at.favre.lib.armadillo.Armadillo.Builder: Manually enable kitkatSupport.
encrypt(byte[], byte[], byte[]) - Method in interface at.favre.lib.armadillo.AuthenticatedEncryption: Encrypts and adds a authentication tag the given content
encryptionFingerprint(Context) - Method in class at.favre.lib.armadillo.Armadillo.Builder: The encryption fingerprint is in important security measure.
encryptionFingerprint(Context, byte[]) - Method in class at.favre.lib.armadillo.Armadillo.Builder: The encryption fingerprint is in important security measure.
encryptionFingerprint(Context, String...) - Method in class at.favre.lib.armadillo.Armadillo.Builder: The encryption fingerprint is in important security measure.
encryptionFingerprint(EncryptionFingerprint) - Method in class at.favre.lib.armadillo.Armadillo.Builder: The encryption fingerprint is in important security measure.
encryptionFingerprint(byte[]) - Method in class at.favre.lib.armadillo.Armadillo.Builder: The encryption fingerprint is in important security measure.
EncryptionFingerprint - Interface in at.favre.lib.armadillo: A EncryptionFingerprint is a semi secret "key" which, during runtime, gathers entropy from e.g.
EncryptionFingerprint.Default - Class in at.favre.lib.armadillo: Default implementation of a EncryptionFingerprint with simple internal in-memory data obfuscation.
EncryptionFingerprintFactory - Class in at.favre.lib.armadillo: Factory for creating EncryptionFingerprintFactory in Android
encryptionKeyStrength(int) - Method in class at.favre.lib.armadillo.Armadillo.Builder: Set the key length for the symmetric encryption.
EncryptionProtocolConfig - Class in at.favre.lib.armadillo: An encryption protocol config encapsulates all configuration needed for encryption and decryption of content.
EncryptionProtocolConfig.Builder - Class in at.favre.lib.armadillo
EncryptionProtocolException - Exception in at.favre.lib.armadillo: Exception thrown during EncryptionProtocol encrypt or decrpyt
EncryptionProtocolException(String) - Constructor for exception at.favre.lib.armadillo.EncryptionProtocolException
EncryptionProtocolException(String, Throwable) - Constructor for exception at.favre.lib.armadillo.EncryptionProtocolException
EncryptionProtocolException(Throwable) - Constructor for exception at.favre.lib.armadillo.EncryptionProtocolException

F

Factory() - Constructor for class at.favre.lib.armadillo.HkdfXorObfuscator.Factory
Factory() - Constructor for class at.favre.lib.armadillo.NoObfuscator.Factory
FastKeyStretcher - Class in at.favre.lib.armadillo: This is a implementation for a key derivation function with disabled key stretching function.
FastKeyStretcher() - Constructor for class at.favre.lib.armadillo.FastKeyStretcher

G

getAll() - Method in class at.favre.lib.armadillo.SecureSharedPreferences: This will get all handled keys from the store.
getBoolean(String, boolean) - Method in class at.favre.lib.armadillo.SecureSharedPreferences
getBytes() - Method in class at.favre.lib.armadillo.ByteArrayRuntimeObfuscator.Default
getBytes() - Method in interface at.favre.lib.armadillo.ByteArrayRuntimeObfuscator: Get an de-obfuscated copy of the original data.
getBytes() - Method in class at.favre.lib.armadillo.EncryptionFingerprint.Default
getBytes() - Method in interface at.favre.lib.armadillo.EncryptionFingerprint
getFloat(String, float) - Method in class at.favre.lib.armadillo.SecureSharedPreferences
getInt(String, int) - Method in class at.favre.lib.armadillo.SecureSharedPreferences
getLong(String, long) - Method in class at.favre.lib.armadillo.SecureSharedPreferences
getString(String, String) - Method in class at.favre.lib.armadillo.SecureSharedPreferences
getStringSet(String, Set<String>) - Method in class at.favre.lib.armadillo.SecureSharedPreferences
GzipCompressor - Class in at.favre.lib.armadillo: A compressor using Gzip algorithm provided by the JDK
GzipCompressor() - Constructor for class at.favre.lib.armadillo.GzipCompressor

H

HkdfXorObfuscator - Class in at.favre.lib.armadillo: A simple obfuscator using HKDF to derive keys for individual blocks and uses a simple version of CTR block mode.
HkdfXorObfuscator.Factory - Class in at.favre.lib.armadillo

I

isValidPassword() - Method in interface at.favre.lib.armadillo.ArmadilloSharedPreferences: Determines whether the user-provided password used to initialises Armadillo is the right one or not.
isValidPassword() - Method in class at.favre.lib.armadillo.SecureSharedPreferences

K

keyStrength(int) - Method in class at.favre.lib.armadillo.EncryptionProtocolConfig.Builder: Set the key length for the symmetric encryption.
keyStrength - Variable in class at.favre.lib.armadillo.EncryptionProtocolConfig
keyStretchingFunction(KeyStretchingFunction) - Method in class at.favre.lib.armadillo.Armadillo.Builder: Set a different key derivation function for provided password.
keyStretchingFunction(KeyStretchingFunction) - Method in class at.favre.lib.armadillo.EncryptionProtocolConfig.Builder: Set a different key derivation function for provided password.
keyStretchingFunction - Variable in class at.favre.lib.armadillo.EncryptionProtocolConfig
KeyStretchingFunction - Interface in at.favre.lib.armadillo: In cryptography, key stretching techniques are used to make a possibly weak key, typically a password or passphrase, more secure against a brute-force attack by increasing the time it takes to test each possible key.
KITKAT_PROTOCOL_VERSION - Static variable in class at.favre.lib.armadillo.Armadillo

N

newBuilder() - Static method in class at.favre.lib.armadillo.EncryptionProtocolConfig
newBuilder(EncryptionProtocolConfig) - Static method in class at.favre.lib.armadillo.EncryptionProtocolConfig
newDefaultConfig() - Static method in class at.favre.lib.armadillo.EncryptionProtocolConfig
NoObfuscator - Class in at.favre.lib.armadillo: A simple No-Op implementation for DataObfuscator.
NoObfuscator() - Constructor for class at.favre.lib.armadillo.NoObfuscator
NoObfuscator.Factory - Class in at.favre.lib.armadillo

O

obfuscate(byte[]) - Method in interface at.favre.lib.armadillo.DataObfuscator: Obfuscates the given byte array.
obfuscate(byte[]) - Method in class at.favre.lib.armadillo.HkdfXorObfuscator
obfuscate(byte[]) - Method in class at.favre.lib.armadillo.NoObfuscator

P

password(char[]) - Method in class at.favre.lib.armadillo.Armadillo.Builder: Provide a user password used for encrypting all of values of the SharedPreferences.
PBKDF2KeyStretcher - Class in at.favre.lib.armadillo: In cryptography, PBKDF2 (Password-Based Key Derivation Function 2) are key derivation functions with a sliding computational cost, aimed to reduce the vulnerability of encrypted keys to brute force attacks.
PBKDF2KeyStretcher() - Constructor for class at.favre.lib.armadillo.PBKDF2KeyStretcher: Create a new instance with default iteration count (see PBKDF2KeyStretcher.PBKDF2_DEFAULT_ITERATIONS
PBKDF2KeyStretcher(int, Provider) - Constructor for class at.favre.lib.armadillo.PBKDF2KeyStretcher: Creates a new instance.
protocolVersion(int) - Method in class at.favre.lib.armadillo.EncryptionProtocolConfig.Builder: A custom crypto protocol version can be set, to be able to migrate the data.
protocolVersion - Variable in class at.favre.lib.armadillo.EncryptionProtocolConfig
putBoolean(String, boolean) - Method in class at.favre.lib.armadillo.SecureSharedPreferences.Editor
putFloat(String, float) - Method in class at.favre.lib.armadillo.SecureSharedPreferences.Editor
putInt(String, int) - Method in class at.favre.lib.armadillo.SecureSharedPreferences.Editor
putLong(String, long) - Method in class at.favre.lib.armadillo.SecureSharedPreferences.Editor
putString(String, String) - Method in class at.favre.lib.armadillo.SecureSharedPreferences.Editor
putStringSet(String, Set<String>) - Method in class at.favre.lib.armadillo.SecureSharedPreferences.Editor

R

recoveryPolicy(boolean, boolean) - Method in class at.favre.lib.armadillo.Armadillo.Builder
recoveryPolicy(RecoveryPolicy) - Method in class at.favre.lib.armadillo.Armadillo.Builder
RecoveryPolicy - Interface in at.favre.lib.armadillo: Defines how the storage should behave on errors
RecoveryPolicy.Default - Class in at.favre.lib.armadillo: Default implementation
registerOnSharedPreferenceChangeListener(SharedPreferences.OnSharedPreferenceChangeListener) - Method in class at.favre.lib.armadillo.SecureSharedPreferences
remove(String) - Method in class at.favre.lib.armadillo.SecureSharedPreferences.Editor

S

secureRandom(SecureRandom) - Method in class at.favre.lib.armadillo.Armadillo.Builder: Provide your own SecureRandom implementation.
SecureSharedPreferenceCryptoException - Exception in at.favre.lib.armadillo
SecureSharedPreferenceCryptoException(String, Throwable) - Constructor for exception at.favre.lib.armadillo.SecureSharedPreferenceCryptoException
SecureSharedPreferences - Class in at.favre.lib.armadillo: A simple wrapper implementation using the DefaultEncryptionProtocol before persisting the data.
SecureSharedPreferences(Context, String, EncryptionProtocol.Factory, char[], boolean) - Constructor for class at.favre.lib.armadillo.SecureSharedPreferences
SecureSharedPreferences(Context, String, EncryptionProtocol.Factory, RecoveryPolicy, char[], boolean) - Constructor for class at.favre.lib.armadillo.SecureSharedPreferences
SecureSharedPreferences(SharedPreferences, EncryptionProtocol.Factory, RecoveryPolicy, char[], boolean) - Constructor for class at.favre.lib.armadillo.SecureSharedPreferences
SecureSharedPreferences.Editor - Class in at.favre.lib.armadillo: Wrapper for Android's SharedPreferences.Editor.
securityProvider(Provider) - Method in class at.favre.lib.armadillo.Armadillo.Builder: Set the security provider for most cryptographic primitives (symmetric encryption, pbkdf2, ...).
shouldRemoveBrokenContent() - Method in class at.favre.lib.armadillo.RecoveryPolicy.Default
shouldRemoveBrokenContent() - Method in interface at.favre.lib.armadillo.RecoveryPolicy: If the content should be automatically removed when it cannot be read.
shouldThrowRuntimeException() - Method in class at.favre.lib.armadillo.RecoveryPolicy.Default
shouldThrowRuntimeException() - Method in interface at.favre.lib.armadillo.RecoveryPolicy: If the content cannot be read (or written) defines if a runtime exception should be thrown ( i.e.
STRENGTH_HIGH - Static variable in interface at.favre.lib.armadillo.AuthenticatedEncryption: High Security which is equivalent to a AES key size of 128 bit
STRENGTH_VERY_HIGH - Static variable in interface at.favre.lib.armadillo.AuthenticatedEncryption: Very high security which is equivalent to a AES key size of 256 bit Note: This is usually not required.
stretch(byte[], char[], int) - Method in class at.favre.lib.armadillo.FastKeyStretcher
stretch(byte[], char[], int) - Method in interface at.favre.lib.armadillo.KeyStretchingFunction: Derives and stretches the given password with given salt to desired out length.
stretch(byte[], char[], int) - Method in class at.favre.lib.armadillo.PBKDF2KeyStretcher
StringMessageDigest - Interface in at.favre.lib.armadillo: A hash function to convert a string and usage name to a string representation of a hash.
supportVerifyPassword(boolean) - Method in class at.favre.lib.armadillo.Armadillo.Builder: Enabling support verify password allows you to use ArmadilloSharedPreferences.isValidPassword() to verify the validity of the user-provided password used to initialise Armadillo.
symmetricEncryption(AuthenticatedEncryption) - Method in class at.favre.lib.armadillo.Armadillo.Builder: Set your own implementation of AuthenticatedEncryption.

U

unregisterOnSharedPreferenceChangeListener(SharedPreferences.OnSharedPreferenceChangeListener) - Method in class at.favre.lib.armadillo.SecureSharedPreferences

A B C D E F G H I K N O P R S U