Digital Authentication Framework
6.0.1.37
|
A collection of parameters for completing an DAF enrollment in a background thread. More...
Public Member Functions | |
void | start () |
Start the enrollment process. More... | |
void | setPassphrase (byte[] pass) |
Inputs the pre-collected passphrase. More... | |
byte[] | getPassphrase () |
Gets the pre-collected passphrase. More... | |
void | setPassphraseCallback (PassphraseCallback pc) |
Sets the passphrase collection callback. More... | |
void | setUserString (byte[] us) |
Sets the 'user string' – an arbitrary string stored inside with the state resulting from the enrollment. More... | |
byte[] | getUserString () |
void | setAuthToken (byte[] token) |
Sets the DAF authentication token. More... | |
byte[] | getAuthToken () |
Public Member Functions inherited from com.good.daf.app.GeneralProcessParams | |
void | setDevice (DADevice dev) |
The DADevice to use in the protocol. More... | |
DADevice | getDevice () |
void | setProgressCallback (ProgressCallback cb) |
Sets the progress callback which will be triggered during the protocol. More... | |
void | onStart () |
Called on the UI thread when the background processing thread is about to start work. More... | |
void | onSuccess () |
Called on the UI thread when the background processing thread completes its work successfully. More... | |
void | onError (Exception e) |
Called on the UI thread when the background processing thread fails due to an error. More... | |
Protected Attributes | |
byte[] | passphrase |
byte[] | authToken = new byte[] {} |
byte[] | newUserString = null |
PassphraseCallback | passphraseCallback |
Protected Attributes inherited from com.good.daf.app.GeneralProcessParams | |
DADevice | device |
ProgressCallback | progressCallback |
A collection of parameters for completing an DAF enrollment in a background thread.
byte [] com.good.daf.app.EnrollProcessParams.getAuthToken | ( | ) |
byte [] com.good.daf.app.EnrollProcessParams.getPassphrase | ( | ) |
Gets the pre-collected passphrase.
byte [] com.good.daf.app.EnrollProcessParams.getUserString | ( | ) |
void com.good.daf.app.EnrollProcessParams.setAuthToken | ( | byte[] | token | ) |
Sets the DAF authentication token.
The authentication token is a sequence of bytes with hardware-specific format and semantics, which can be used by the hardware driver to authenticate the user.
The default authtoken is the empty string.
token | new auth token |
void com.good.daf.app.EnrollProcessParams.setPassphrase | ( | byte[] | pass | ) |
Inputs the pre-collected passphrase.
If you know this process will always require a passphrase, you can collect it from the user before beginning the process and input it here.
This overrides any callback passed to setPassphraseCallback.
pass | pre-collected passphrase |
void com.good.daf.app.EnrollProcessParams.setPassphraseCallback | ( | PassphraseCallback | pc | ) |
Sets the passphrase collection callback.
See the documentation for PassphraseCallback for the rules surrounding this call.
setPassphrase() overrides this method.
pc | new passphrase callback implementor |
void com.good.daf.app.EnrollProcessParams.setUserString | ( | byte[] | us | ) |
Sets the 'user string' – an arbitrary string stored inside with the state resulting from the enrollment.
This can be used to remember the identity of the device that authentication must be performed with.
Class 0 devices must not store the device identity here. The value is effectively unencrypted (because it must be available in plaintext before the GD container is unlocked.)
This is optional. By default, no user string is stored.
us | new user string value |
void com.good.daf.app.EnrollProcessParams.start | ( | ) |
Start the enrollment process.
This call completes quickly; the actual process takes place in a background worker thread. Provide a ProgressCallback if you want to be notified of the worker thread's results.