Package org.calypsonet.terminal.calypso.transaction

Interface CardSecuritySetting

All Superinterfaces:

CommonSecuritySetting<CardSecuritySetting>

public interface CardSecuritySetting
extends CommonSecuritySetting<CardSecuritySetting>

Data to manage the security operations of a Calypso card transaction.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CardSecuritySetting	addAuthorizedSessionKey(byte kif, byte kvc)	Adds an authorized session key defined by its KIF and KVC values.
CardSecuritySetting	addAuthorizedSvKey(byte kif, byte kvc)	Adds an authorized Stored Value key defined by its KIF and KVC values.
CardSecuritySetting	assignDefaultKif(WriteAccessLevel writeAccessLevel, byte kif)	Defines for a given write access level the default KIF value to use when it could not be determined by any other means.
CardSecuritySetting	assignDefaultKvc(WriteAccessLevel writeAccessLevel, byte kvc)	Defines for a given write access level the KVC value to use for cards that do not provide KVC.
CardSecuritySetting	assignKif(WriteAccessLevel writeAccessLevel, byte kvc, byte kif)	Defines for a given write access level the KIF value to use for cards that only provide KVC.
CardSecuritySetting	authorizeSvNegativeBalance()	Allows the SV balance to become negative.
CardSecuritySetting	enableMultipleSession()	Enables multiple session mode to allow more changes to the card than the session buffer can handle.
CardSecuritySetting	enablePinPlainTransmission()	Enables the PIN transmission in plain text.
CardSecuritySetting	enableRatificationMechanism()	Enables the ratification mechanism to handle the early removal of the card preventing the terminal from receiving the acknowledgement of the session closing.
CardSecuritySetting	enableSvLoadAndDebitLog()	Enables the retrieval of both loading and debit log records.
CardSecuritySetting	setPinModificationCipheringKey(byte kif, byte kvc)	Sets the KIF/KVC pair of the PIN modification ciphering key.
CardSecuritySetting	setPinVerificationCipheringKey(byte kif, byte kvc)	Sets the KIF/KVC pair of the PIN verification ciphering key.
CardSecuritySetting	setSamResource(org.calypsonet.terminal.reader.CardReader samReader, CalypsoSam calypsoSam)	Deprecated. Use CommonSecuritySetting.setControlSamResource(CardReader, CalypsoSam) instead.

Methods inherited from interface org.calypsonet.terminal.calypso.transaction.CommonSecuritySetting

setControlSamResource, setSamRevocationService

Method Detail

setSamResource

@Deprecated
CardSecuritySetting setSamResource(org.calypsonet.terminal.reader.CardReader samReader,
                                   CalypsoSam calypsoSam)

Deprecated.

Use CommonSecuritySetting.setControlSamResource(CardReader, CalypsoSam) instead. (will be soon removed)

Defines the SAM and the reader through which it is accessible to be used to handle the relevant cryptographic operations.

Parameters:

samReader - The SAM reader.

calypsoSam - The Calypso SAM.

Returns:

The current instance.

Throws:

java.lang.IllegalArgumentException - If one of the arguments is null or if the product type of CalypsoSam is equal to CalypsoSam.ProductType.UNKNOWN.

Since:

1.0.0

enableMultipleSession

CardSecuritySetting enableMultipleSession()

Enables multiple session mode to allow more changes to the card than the session buffer can handle.

Returns:

The current instance.

Since:

1.0.0

enableRatificationMechanism

CardSecuritySetting enableRatificationMechanism()

Enables the ratification mechanism to handle the early removal of the card preventing the terminal from receiving the acknowledgement of the session closing.

Returns:

The current instance.

Since:

1.0.0

enablePinPlainTransmission

CardSecuritySetting enablePinPlainTransmission()

Enables the PIN transmission in plain text.

Returns:

The current instance.

Since:

1.0.0

enableSvLoadAndDebitLog

CardSecuritySetting enableSvLoadAndDebitLog()

Enables the retrieval of both loading and debit log records.

The default value is false.

Returns:

The current instance.

Since:

1.0.0

authorizeSvNegativeBalance

CardSecuritySetting authorizeSvNegativeBalance()

Allows the SV balance to become negative.

The default value is false.

Returns:

The current instance.

Since:

1.0.0

assignKif

CardSecuritySetting assignKif(WriteAccessLevel writeAccessLevel,
                              byte kvc,
                              byte kif)

Defines for a given write access level the KIF value to use for cards that only provide KVC.

Parameters:

writeAccessLevel - The write access level.

kvc - The card's KVC value.

kif - The KIF value to use.

Returns:

The current instance.

Throws:

java.lang.IllegalArgumentException - If the provided writeAccessLevel is null.

Since:

1.0.0

assignDefaultKif

CardSecuritySetting assignDefaultKif(WriteAccessLevel writeAccessLevel,
                                     byte kif)

Defines for a given write access level the default KIF value to use when it could not be determined by any other means.

Parameters:

writeAccessLevel - The write access level.

kif - The KIF value to use.

Returns:

The current instance.

Throws:

java.lang.IllegalArgumentException - If the provided writeAccessLevel is null.

Since:

1.0.0

assignDefaultKvc

CardSecuritySetting assignDefaultKvc(WriteAccessLevel writeAccessLevel,
                                     byte kvc)

Defines for a given write access level the KVC value to use for cards that do not provide KVC.

Parameters:

writeAccessLevel - The session level.

kvc - The KVC to use.

Returns:

The current instance.

Throws:

java.lang.IllegalArgumentException - If the provided writeAccessLevel is null.

Since:

1.0.0

addAuthorizedSessionKey

CardSecuritySetting addAuthorizedSessionKey(byte kif,
                                            byte kvc)

Adds an authorized session key defined by its KIF and KVC values.

By default, all keys are accepted.
If at least one key is added using this method, then only authorized keys will be accepted.

Parameters:

kif - The KIF value.

kvc - The KVC value.

Returns:

The current instance.

Since:

1.0.0

addAuthorizedSvKey

CardSecuritySetting addAuthorizedSvKey(byte kif,
                                       byte kvc)

Adds an authorized Stored Value key defined by its KIF and KVC values.

By default, all keys are accepted.
If at least one key is added using this method, then only authorized keys will be accepted.

Parameters:

kif - The KIF value.

kvc - The KVC value.

Returns:

The current instance.

Since:

1.0.0

setPinVerificationCipheringKey

CardSecuritySetting setPinVerificationCipheringKey(byte kif,
                                                   byte kvc)

Sets the KIF/KVC pair of the PIN verification ciphering key.

The default value for both KIF and KVC is 0.

Parameters:

kif - The KIF value.

kvc - The KVC value.

Returns:

The current instance.

Since:

1.0.0

setPinModificationCipheringKey

CardSecuritySetting setPinModificationCipheringKey(byte kif,
                                                   byte kvc)

Sets the KIF/KVC pair of the PIN modification ciphering key.

The default value for both KIF and KVC is 0.

Parameters:

kif - The KIF value.

kvc - The KVC value.

Returns:

The current instance.

Since:

1.0.0