com.cloudpos.pinpad

Class KeyInfo

java.lang.Object

com.cloudpos.pinpad.KeyInfo

public class KeyInfo
extends Object

The KeyInfo class represents key information and the associated algorithm used in PINPad operations. This class provides the necessary details to specify the type of key, its index, and the cryptographic algorithm to be used.

Field Summary

Fields

Modifier and Type	Field and Description
int	algorithm Algorithm type, see ALG_3DES for example.
static <any>	CREATOR Deprecated.
int	keyID Key index.
int	keyType Key type.
int	masterKeyID Master key index, ranging from 0 to 49.

Constructor Summary

Constructors

Constructor and Description
KeyInfo(int keyType, int keyID, int algorithm) Constructs a KeyInfo object specifically for DUKPT keys.
KeyInfo(int keyType, int masterKeyID, int keyID, int algorithm) Constructs a KeyInfo object for keys of type KEY_TYPE_MK_SK.

Method Summary

Modifier and Type	Method and Description
int	describeContents() Deprecated.
void	writeToParcel(Parcel dest, int flags) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

algorithm

public int algorithm

Algorithm type, see ALG_3DES for example.

CREATOR

@Deprecated
public static final <any> CREATOR

Deprecated.

keyID

public int keyID

Key index. If the key type is KEY_TYPE_MK_SK, valid constants are USER_KEY_ID_PIN, USER_KEY_ID_MAC, USER_KEY_ID_DATA. For other key types, it represents the key index.

keyType

public int keyType

Key type. It can be one of the following types defined in PINPadDevice: KEY_TYPE_TDUKPT, KEY_TYPE_MK_SK, KEY_TYPE_FIX, KEY_TYPE_TDUKPT_2009.

masterKeyID

public int masterKeyID

Master key index, ranging from 0 to 49. Index 9 is reserved for EMV kernel offline PIN. This is applicable only when the key type is KEY_TYPE_MK_SK.

Constructor Detail

KeyInfo

public KeyInfo(int keyType,
               int keyID,
               int algorithm)

Constructs a KeyInfo object specifically for DUKPT keys.

This constructor initializes a KeyInfo instance with the specified key type, key index, and cryptographic algorithm. It is designed to handle different DUKPT key schemes with specific index ranges for each key type.

Parameters:

keyType - The type of the DUKPT key. Must be one of:

• PINPadDevice.KEY_TYPE_TDUKPT - Traditional DUKPT key
• PINPadDevice.KEY_TYPE_TDUKPT_2009 - DUKPT 2009 standard key
• PINPadDevice.KEY_TYPE_TDUKPT_AES - AES-based DUKPT key

keyID - The key index (0-based). The valid range depends on the key type:

• For PINPadDevice.KEY_TYPE_TDUKPT or PINPadDevice.KEY_TYPE_TDUKPT_2009: 0 to 49
• For PINPadDevice.KEY_TYPE_TDUKPT_AES: 0 to 32

algorithm - The cryptographic algorithm to be used with this key. Examples include AlgorithmConstants.ALG_3DES for Triple DES or AlgorithmConstants.ALG_AES for AES.

Throws:

IllegalArgumentException - if any of the following conditions are met:

• keyType is not one of the valid DUKPT key types
• keyID is outside the valid range for the specified keyType
• algorithm is not supported for DUKPT operations

See Also:

PINPadDevice, AlgorithmConstants, KeyInfo(int, int, int)

KeyInfo

public KeyInfo(int keyType,
               int masterKeyID,
               int keyID,
               int algorithm)

Constructs a KeyInfo object for keys of type KEY_TYPE_MK_SK.

Parameters:

keyType - The type of the key, e.g., KEY_TYPE_MK_SK.

masterKeyID - The master key index (0 to 49).

keyID - The specific key index (0, 1, or 2).

algorithm - The cryptographic algorithm, e.g., ALG_3DES.

Method Detail

describeContents

@Deprecated
public int describeContents()

Deprecated.

writeToParcel

@Deprecated
public void writeToParcel(Parcel dest,
                                      int flags)

Deprecated.