com.gemalto.idp.mobile.otp.provisioning

Interface DskppProvisioningCallback

public interface DskppProvisioningCallback

Callback for 4-pass Dskpp provisioning.

Since:

4.1

Method Summary

Modifier and Type	Method and Description
void	onKeyProvisioned(java.lang.String tokenName, DskppKeyInformation keyInfo) This callback is invoked when provisioned is finished.
void	onLocalPinRequested(java.lang.String tokenName, DskppPinPolicy dskppPinPolicy, DskppLocalPinCallback localPinCallback) This callback is invoked when USER_PIN or NO_PIN policy is used for the token.
boolean	onPolicyExtensionProvided(java.lang.String tokenName, SecureString XML, java.util.List<android.util.Pair<java.lang.String,SecureString>> fields) This callback is invoked when there are extensions to policies.
void	onPolicyStringProvided(java.lang.String tokenName, SecureString policyString) This callback is invoked after completion of the provisioning.
void	onServerPinRequested(java.lang.String tokenName, DskppPinPolicy dskppPinPolicy, DskppServerPinCallback serverPinCallback) This callback is invoked when SERVER_PIN policy is used for the token.

Method Detail

onServerPinRequested

void onServerPinRequested(java.lang.String tokenName,
                          DskppPinPolicy dskppPinPolicy,
                          DskppServerPinCallback serverPinCallback)

This callback is invoked when SERVER_PIN policy is used for the token. When SERVER_PIN policy is used, Application are required to provide 2 PINs to the SDK.

• A server PIN, which is collected from the end user. The server PIN will be sent the the server to store. On client side it must NOT be stored. It is a user knowledge. The server PIN will be combined with OTP for verification.
• A local PIN, which is normally generate by the application and stored for the token. The local PIN will be used for OTP generation from the SDK.

Please check the pin policy for the requirement on Pin format. Application developer is responsible to check if the PIN entered by the user is compliant with the required PIN complexity.

Parameters:

tokenName - tokenName

dskppPinPolicy - pin policy object that identifies the pin type and pin complexity.

serverPinCallback - callback to the SDK when PIN is collected from the end user

Since:

4.1

onLocalPinRequested

void onLocalPinRequested(java.lang.String tokenName,
                         DskppPinPolicy dskppPinPolicy,
                         DskppLocalPinCallback localPinCallback)

This callback is invoked when USER_PIN or NO_PIN policy is used for the token. When USER_PIN is required, ask for the PIN from the end user. This PIN will be used for OTP generation from the SDK. When NO_PIN policy is used, the pin is normally generate by the application and stored for the token. The PIN will be used for OTP generation from the SDK. NO_PIN policy is to be used with caution. Since the OTP generation is not protected by user knowledge. Please check the pin policy for the requirement on Pin format. Application developer is responsible to check if the PIN entered by the user is compliant with the required PIN complexity.

Parameters:

tokenName - tokenName

dskppPinPolicy - pin policy object that identifies the pin type and pin complexity.

localPinCallback - callback to the SDK when PIN is collected.

Since:

4.1

onPolicyExtensionProvided

boolean onPolicyExtensionProvided(java.lang.String tokenName,
                                  SecureString XML,
                                  java.util.List<android.util.Pair<java.lang.String,SecureString>> fields)

This callback is invoked when there are extensions to policies. If not used, simply return 'true'.

Parameters:

tokenName - tokenName

XML - xml string which contains the DSKPP extensions supplied according to DskppConfigurationBuilder.setListToReceive(List)

fields - additional data to send to the server for provisioning

Returns:

true to continue and false to abort.

Since:

4.1

onPolicyStringProvided

void onPolicyStringProvided(java.lang.String tokenName,
                            SecureString policyString)

This callback is invoked after completion of the provisioning. policyString contains the policies for the token. Application needs to stored it for the token and use it when needed. The policy can be parsed by DskppPolicyParser

Parameters:

tokenName - tokenName

policyString - the policy associated with the token.

Since:

4.1

onKeyProvisioned

void onKeyProvisioned(java.lang.String tokenName,
                      DskppKeyInformation keyInfo)

This callback is invoked when provisioned is finished. Application needs to save the related key information: eg. tokenSerialNumber for further usage.

Parameters:

tokenName - tokenName

keyInfo - information of the provisioned key

Since:

4.1