org.researchstack.backbone.storage.file

Interface EncryptionProvider

All Known Implementing Classes:

AesProvider, PinProtectedProvider, UnencryptedPinProvider, UnencryptedProvider

public interface EncryptionProvider

This interface is used to create, change, and authenticate pin codes provided by the user.

Method Summary

Modifier and Type	Method and Description
void	changePinCode(android.content.Context context, java.lang.String oldPin, java.lang.String newPin) Changes the pin code if the old pin provided matches
void	createPinCode(android.content.Context context, java.lang.String pin) Create a pin code from the provided input
Encrypter	getEncrypter() Returns the Encrypter for data being written to disk, which should be initialized in startWithPassphrase(android.content.Context, java.lang.String).
boolean	hasPinCode(android.content.Context context) Returns whether the user has created a pin code.
void	logAccessTime() Logs the time of access for deciding whether to re-prompt the user for a pin after having been away from the app for longer than the lock time.
boolean	needsAuth(android.content.Context context, PinCodeConfig codeConfig) Returns a boolean indicating whether authentication is needed.
void	startWithPassphrase(android.content.Context context, java.lang.String pin) This method should attempt to initialize the Encrypter with the provided pin, otherwise it should throw a StorageAccessException

Method Detail

hasPinCode

boolean hasPinCode(android.content.Context context)

Returns whether the user has created a pin code.

Parameters:

context - android context

Returns:

boolean indicating whether the user has created a pin code

createPinCode

void createPinCode(android.content.Context context,
                   java.lang.String pin)

Create a pin code from the provided input

Parameters:

context - android context

pin - the pin that the user entered

changePinCode

void changePinCode(android.content.Context context,
                   java.lang.String oldPin,
                   java.lang.String newPin)

Changes the pin code if the old pin provided matches

Parameters:

context - android context

oldPin - user input for old pin

newPin - user input for the new pin

needsAuth

boolean needsAuth(android.content.Context context,
                  PinCodeConfig codeConfig)

Returns a boolean indicating whether authentication is needed. If your Encrypter is not ready, return false.

Parameters:

context - android context

codeConfig - the pin config for the app

Returns:

a boolean indicating whether pin code authorization is needed

startWithPassphrase

void startWithPassphrase(android.content.Context context,
                         java.lang.String pin)

This method should attempt to initialize the Encrypter with the provided pin, otherwise it should throw a StorageAccessException

Parameters:

context - android context

pin - the pin input from the user

logAccessTime

void logAccessTime()

Logs the time of access for deciding whether to re-prompt the user for a pin after having been away from the app for longer than the lock time.

getEncrypter

Encrypter getEncrypter()

Returns the Encrypter for data being written to disk, which should be initialized in startWithPassphrase(android.content.Context, java.lang.String).

Returns:

the encrypter