org.researchstack.backbone.storage.file.aes

Class PinProtectedProvider

java.lang.Object

org.researchstack.backbone.storage.file.aes.PinProtectedProvider

All Implemented Interfaces:

EncryptionProvider

Direct Known Subclasses:

AesProvider, UnencryptedPinProvider

public abstract class PinProtectedProvider
extends java.lang.Object
implements EncryptionProvider

This abstract class allows for pin protection, whether or not the files are actually encrypted and with what method is up to the implementation.

Constructor Summary

Constructors

Constructor and Description
PinProtectedProvider() Default constructor

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
protected abstract Encrypter	createEncrypter(com.tozny.crypto.android.AesCbcWithIntegrity.SecretKeys masterKey)
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 EncryptionProvider.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.
boolean	passphraseExists(android.content.Context context)
void	startWithPassphrase(android.content.Context context, java.lang.String passphrase) This method should attempt to initialize the Encrypter with the provided pin, otherwise it should throw a StorageAccessException

Methods inherited from class java.lang.Object

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

Constructor Detail

PinProtectedProvider

public PinProtectedProvider()

Default constructor

Method Detail

getEncrypter

public Encrypter getEncrypter()

Description copied from interface: EncryptionProvider

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

Specified by:

getEncrypter in interface EncryptionProvider

Returns:

the encrypter

logAccessTime

public void logAccessTime()

Description copied from interface: EncryptionProvider

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.

Specified by:

logAccessTime in interface EncryptionProvider

hasPinCode

public boolean hasPinCode(android.content.Context context)

Description copied from interface: EncryptionProvider

Returns whether the user has created a pin code.

Specified by:

hasPinCode in interface EncryptionProvider

Parameters:

context - android context

Returns:

boolean indicating whether the user has created a pin code

createPinCode

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

Description copied from interface: EncryptionProvider

Create a pin code from the provided input

Specified by:

createPinCode in interface EncryptionProvider

Parameters:

context - android context

pin - the pin that the user entered

changePinCode

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

Description copied from interface: EncryptionProvider

Changes the pin code if the old pin provided matches

Specified by:

changePinCode in interface EncryptionProvider

Parameters:

context - android context

oldPin - user input for old pin

newPin - user input for the new pin

createEncrypter

protected abstract Encrypter createEncrypter(com.tozny.crypto.android.AesCbcWithIntegrity.SecretKeys masterKey)

startWithPassphrase

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

Description copied from interface: EncryptionProvider

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

Specified by:

startWithPassphrase in interface EncryptionProvider

Parameters:

context - android context

passphrase - the pin input from the user

passphraseExists

public boolean passphraseExists(android.content.Context context)

needsAuth

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

Description copied from interface: EncryptionProvider

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

Specified by:

needsAuth in interface EncryptionProvider

Parameters:

context - android context

codeConfig - the pin config for the app

Returns:

a boolean indicating whether pin code authorization is needed