tech.paycon.nfc

Class PCRutokenKeysProcessor

java.lang.Object

tech.paycon.nfc.PCRutokenKeysProcessor

public class PCRutokenKeysProcessor
extends java.lang.Object

This class provides functionality to use a Rutoken smart cars as a keys processor in PC SDK

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PCRutokenKeysProcessor.ChangePINCallback Callback for handling results of
static interface	PCRutokenKeysProcessor.SlotEventListener Callback for catching slot events

Method Summary

Modifier and Type	Method and Description
void	changePIN(java.lang.String newPIN, PCRutokenKeysProcessor.ChangePINCallback callback) Changes PIN on a smart card.
void	finish() This function must be called after work with smart card is finished
Context	getContext() Context passed to init(Context)
static PCRutokenKeysProcessor	getInstance() Always returns a non-null instance of PCRutokenKeysProcessor.
java.lang.Throwable	getLastError() Returns the last caught throwable.
void	getPublicKey(PCUser user, PCGetPublicKeyCallback callback) This method generates a key pair for a specified PCUser.
boolean	init(Context appContext) This function performs necessary initialization and must be called prior to working with Pkcs11 module
boolean	isInitialized() Indicates whether the module has been initialized or init(Context) must be called.
boolean	isReadyToSign() Determines whether PIN form a smart card was submitted (and this has happened quite recently), so that the smart card can be used for signing data
void	process(PCUser user, java.util.List<PCTransaction> transactionsToConfirm, java.util.List<PCTransaction> transactionsToDecline, PCMultipleProcessingCallback callback) This method is used to confirm transactions via smart card.
void	renew(PCUser user, PCTransaction transaction, java.lang.String externalAlias, PCRenewRequestCallback callback) Renews PCUser's symmetric and asymmetric keys
void	setPassword(java.lang.String password) This function can be called prior to calling getPublicKey(PCUser, PCGetPublicKeyCallback) in order to save PCUser's password on a smart card
void	setSlotEventListener(PCRutokenKeysProcessor.SlotEventListener slotEventListener) Adds a listener which can receive events about starting and finished data exchange with a smart card
void	submitPin(java.lang.String pin) Submit a pin code which will be used to login at smart card.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static PCRutokenKeysProcessor getInstance()

Always returns a non-null instance of PCRutokenKeysProcessor. This instance can be passed to any method of PC SDK which waits an implementation of PCKeysProcessor

getPublicKey

public void getPublicKey(PCUser user,
                         PCGetPublicKeyCallback callback)

This method generates a key pair for a specified PCUser. This method should not be called inside the app. It is called in an appropriate moment inside PC SDK when it receives getInstance() in PCUsersManager.register(...).

Parameters:

user - Target PCUser

callback - Callback to handle results

process

public void process(PCUser user,
                    java.util.List<PCTransaction> transactionsToConfirm,
                    java.util.List<PCTransaction> transactionsToDecline,
                    PCMultipleProcessingCallback callback)

This method is used to confirm transactions via smart card. This method should not be called inside the app. Instead, PC SDK calls it when appropriate if getInstance() was passed to methods which operate with transactions and operations.

Parameters:

user - Target PCUser

transactionsToConfirm - List of transactions to be confirmed

transactionsToDecline - List of transactions to be declined

callback - Callback to handle results

renew

public void renew(PCUser user,
                  PCTransaction transaction,
                  java.lang.String externalAlias,
                  PCRenewRequestCallback callback)

Renews PCUser's symmetric and asymmetric keys

Parameters:

user - Target PCUser

transaction - Pseudo-transaction which SDK composes of the data which must be signed with existing keys

externalAlias - Unique alias which will be used to save the keys

callback - Callback to handle results

init

public boolean init(Context appContext)

This function performs necessary initialization and must be called prior to working with Pkcs11 module

Parameters:

appContext - Application context

Returns:

True if module has been initialized, false otherwise. In case of failure getLastError() can be called for details.

finish

public void finish()

This function must be called after work with smart card is finished

submitPin

public void submitPin(java.lang.String pin)

Submit a pin code which will be used to login at smart card. Valid PIN must be provided prior to calling getPublicKey(PCUser, PCGetPublicKeyCallback), process(PCUser, List, List, PCMultipleProcessingCallback) or changePIN(String, ChangePINCallback).

Parameters:

pin - Valid PIN. If invalid PIN is passed, subsequent methods may return an error of type PCRutokenError#PIN_INCORRECT.

isReadyToSign

public boolean isReadyToSign()

Determines whether PIN form a smart card was submitted (and this has happened quite recently), so that the smart card can be used for signing data

Returns:

setSlotEventListener

public void setSlotEventListener(PCRutokenKeysProcessor.SlotEventListener slotEventListener)

Adds a listener which can receive events about starting and finished data exchange with a smart card

Parameters:

slotEventListener - A listener. The callback methods will be invoked in a main thread.

getLastError

public java.lang.Throwable getLastError()

Returns the last caught throwable. It may come in handy when some method has returned the error of type PCRutokenError#GENERAL_ERROR or PCRutokenError#GENERAL_RUTOKEN_ERROR. In this case the throwable might add some more information

Returns:

Last caught throwable or null

setPassword

public void setPassword(java.lang.String password)

This function can be called prior to calling getPublicKey(PCUser, PCGetPublicKeyCallback) in order to save PCUser's password on a smart card

Parameters:

password - Password to be saved on a smart card

isInitialized

public boolean isInitialized()

Indicates whether the module has been initialized or init(Context) must be called.

Returns:

True if the module is in initialized state

changePIN

public void changePIN(java.lang.String newPIN,
                      PCRutokenKeysProcessor.ChangePINCallback callback)

Changes PIN on a smart card. submitPin(String) must be already called to be able to login.

Parameters:

newPIN - New value of PIN

callback - Callback for handling results

getContext

public Context getContext()

Context passed to init(Context)