iaik.apps.util.passphrase

Class PassphraseConsoleDialog

java.lang.Object

iaik.apps.util.passphrase.PassphraseConsoleDialog

All Implemented Interfaces:

PassphraseInterfacce, PassphrasePrompt

public final class PassphraseConsoleDialog
extends java.lang.Object
implements PassphrasePrompt

A dialog for prompting a passphrase via the console.

Author:

Karl Scheibelhofer

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cancelAllowed_ Indicates if this passphrase dialog can be canceled by the user with entering a password
protected java.io.BufferedReader	input_ The stream to read the user input from.
static java.lang.String	LINE_SEPARATOR
protected java.lang.String	message_ Message in this dialog
protected java.io.PrintWriter	output_ The stream the write the prompt messages to.
protected java.lang.Object	protectedResourceInfo_ Object specifying the protected resource; e.g.
protected java.lang.String	title_ Title of this dialog

Constructor Summary

Constructors

Constructor and Description
PassphraseConsoleDialog() Empty constructor.

Method Summary

Modifier and Type	Method and Description
boolean	isCancelAllowed() True, if this prompt can be canceled by the user; i.e.
char[]	promptPassphrase() Prompt the passphrase from the user after displaying the prompt message to him.
void	setCancelAllowed(boolean allowCancel) Set this prompt object to allow cancelling or not.
void	setMessage(java.lang.Object promptMessageObject) Set the prompt object that should be presented to the user as information what passphrase is required.
void	setProtectedResourceInfo(java.lang.Object protectedResourceInfo) Set the object that specifies the protectd resource; i.e.

Methods inherited from class java.lang.Object

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

Field Detail

LINE_SEPARATOR

public static final java.lang.String LINE_SEPARATOR

title_

protected java.lang.String title_

Title of this dialog

message_

protected java.lang.String message_

Message in this dialog

protectedResourceInfo_

protected java.lang.Object protectedResourceInfo_

Object specifying the protected resource; e.g. smart card

cancelAllowed_

protected boolean cancelAllowed_

Indicates if this passphrase dialog can be canceled by the user with entering a password

output_

protected java.io.PrintWriter output_

The stream the write the prompt messages to.

input_

protected java.io.BufferedReader input_

The stream to read the user input from.

Constructor Detail

PassphraseConsoleDialog

public PassphraseConsoleDialog()

Empty constructor.

Method Detail

setMessage

public void setMessage(java.lang.Object promptMessageObject)

Set the prompt object that should be presented to the user as information what passphrase is required. It is recommended that the toString() method of this object provides a telling output for the user. If the implementation knows the concrete class of the object it may use different means to create a message from the given object.

Specified by:

setMessage in interface PassphraseInterfacce

Parameters:

promptMessageObject - The object from which the implementation can get a human readable string that gives information what passphrase the user should enter.

setProtectedResourceInfo

public void setProtectedResourceInfo(java.lang.Object protectedResourceInfo)

Set the object that specifies the protectd resource; i.e. the resource to which the user needs to authenticate; e.g. the name of the smart card for which a PIN is required. The PKCS#11 provider may provide a TokenInfo object.

Specified by:

setProtectedResourceInfo in interface PassphraseInterfacce

Parameters:

protectedResourceInfo - The object that specifies the protected resource in more detail; e.g. the smart card. The PKCS#11 provider may provide a TokenInfo object.

isCancelAllowed

public boolean isCancelAllowed()

True, if this prompt can be canceled by the user; i.e. the user need not enter a passphrase.

Specified by:

isCancelAllowed in interface PassphraseInterfacce

Returns:

True, if this prompt can be canceled without entering a passphrase.

Postconditions:

((result == false) implies (promptPassphrase() <> null))

setCancelAllowed

public void setCancelAllowed(boolean allowCancel)

Set this prompt object to allow cancelling or not.

Specified by:

setCancelAllowed in interface PassphraseInterfacce

Parameters:

allowCancel - If true, canceling the prompt is allowed.

Postconditions:

(allowedCancel == false) implies (promptPassphrase() <> null)

promptPassphrase

public char[] promptPassphrase()

Prompt the passphrase from the user after displaying the prompt message to him. Block, until user has finished. If user is allowed to cancel the dialog, and the user cancels the dialog, then return null.

Specified by:

promptPassphrase in interface PassphrasePrompt

Returns:

The passphrase the user entered (not including any return character used the finish input).

Postconditions:

isCancelAllowed() or ((not isCancelAllowed()) and (result <> null))