* This class provides a trusted path to the OpenCard Framework. * * @author Peter Trommler (trp@zurich.ibm.com) * @author Thomas Schaeck (schaeck@de.ibm.com) * @version $Id: CardHolderVerificationGUI.java,v 1.11 1998/08/25 12:07:51 cvsusers Exp $ */ public final class CardHolderVerificationGUI { private Tracer itracer = new Tracer(this, CardHolderVerificationGUI.class); /** some internal components of the Dialog */ private int chvNumber = -1; private CHVDialog chvDialog = new DefaultCHVDialog(); protected CardHolderVerificationGUI() {} /** Display a message.
* * @param message * The String to display. */ protected void display(int num) { chvNumber = num; } /** Clear the display.
*/ protected void clearDisplay() { chvNumber = -1; } /** Return keyboard (i.e., keyboard, PIN pad, etc.) input.
* @param ioControl * A CardTerminalIOControl object that specifies * how the user input should look like. * @return A String containing the input. */ protected String keyboardInput(CardTerminalIOControl ioControl, CHVDialog customCHVDialog) { if (customCHVDialog != null) return customCHVDialog.getCHV(chvNumber); else return chvDialog.getCHV(chvNumber); } /** Prompt the user for a password, etc.
*
* @param prompt
* The message to be displayed.
* @param ioControl
* A CardTerminalIOControl object that specifies
* how the user input should look like.
* @return A String containing the input.
*/
protected String promptUser(int chvNumber, CardTerminalIOControl ioControl, CHVDialog customCHVDialog) {
clearDisplay();
display(chvNumber);
return keyboardInput(ioControl, customCHVDialog);
}
/**
* Queries for a PIN and sends it to the smartcard.
* This method expects a command including a PIN to send to the smartcard.
* The PIN or password within the command is pre-initialized with padding
* bytes. This method queries the password from the user, stores it in the
* command, and sends the resulting command to the smartcard.
* The smartcard's response is returned.
*
* This method is invoked by CardChannel.sendVerifiedAPDU
* only if the card terminal does not take responsibility for querying
* and filling in the password. If the terminal implements the interface
* VerifiedAPDUInterface, the channel will use the card terminal
* to do the job.
*
* @param slotchan the physical channel to the smartcard
* @param command the APDU to send, password still missing
* @param control the parameters needed to query and fill in the password,
* for example the message for querying, and an offset in
* the command APDU
* @param dialog a dialog provided by the application,
* or null to use a default dialog
* @param timeout the milliseconds until timeout, -1 for unlimited time.
* Currently, timeout for user dialogs is not supported,
* so this value is ignored.
*
* @exception CardTerminalException
* An error occurred while sending the command.
* @exception CardServiceInvalidCredentialException
* The user entered an empty password, or cancelled the
* password input. No command has been sent to the smartcard.
*
* @see CardChannel#sendVerificationAPDU
*/
public ResponseAPDU sendVerifiedAPDU(SlotChannel slotchan,
CommandAPDU command,
CHVControl control,
CHVDialog dialog,
int timeout)
throws CardTerminalException, CardServiceInvalidCredentialException
{
if (!control.passwordEncoding().equals(CHVEncoder.STRING_ENCODING))
throw new CardTerminalException
("verification type not supported: " + control.toString());
String password = promptUser(control.chvNumber(),
control.ioControl(),
dialog );
if (password == null)
throw new CardServiceInvalidCredentialException("CHV cancelled");
// The following conversion is correct only if the password encoding
// is STRING_ENCODING, which has been checked above. If other encodings
// are to be supported, more complex conversions are required, and the
// check cannot be done in the simple way shown above.
byte[] passbytes = password.getBytes();
// Now, the password has to be copied into the command APDU.
// The CHV control tells us where, and how much at most.
{
int offset = control.passwordOffset();
int length = control.ioControl().maxInputChars();
if (passbytes.length < length)
length = passbytes.length;
for (int i = 0; i < length; i++) {
command.setByte(5 + offset + i, passbytes[i]);
}
}
// Now send the command to the card, using the physical channel.
if (!slotchan.isOpen())
throw new CardTerminalException("SlotChannel closed");
ResponseAPDU response = slotchan.sendAPDU(command,
control.ioControl().timeout());
return response;
} // sendVerifiedAPDU
} // class CardHolderVerificationGUI