org.jpos.security.BaseSMAdapter<SecureDESKey>

org.jpos.security.jceadapter.JCESecurityModule

All Implemented Interfaces:: Configurable, SMAdapter<SecureDESKey>, LogSource

public class JCESecurityModule extends BaseSMAdapter<SecureDESKey>

JCESecurityModule is an implementation of a security module in software.

It doesn't require any hardware device to work.
JCESecurityModule also implements the SMAdapter, so you can view it: either as a self contained security module adapter that doesn't need a security module or a security module that plugs directly to jpos, so doesn't need a separate adapter.
It relies on Java(tm) Cryptography Extension (JCE), hence its name.
JCESecurityModule relies on the JCEHandler class to do the low level JCE work.

WARNING: This version of JCESecurityModule is meant for testing purposes and NOT for life operation, since the Local Master Keys are stored in CLEAR on the system's disk. Comming versions of JCESecurity Module will rely on java.security.KeyStore for a better protection of the Local Master Keys.

Field Summary

Fields

Modifier and Type

Field

Description

protected JCEHandler

jceHandler

Helper used for raw JCE cipher and key operations.

Fields inherited from class BaseSMAdapter
cfg, logger, realm

Modifier and Type

Field

Description

protected Configuration

cfg

Configuration for this adapter.

protected Logger

logger

Logger for this security module adapter.

protected String

realm

Log realm for this security module adapter.

Fields inherited from interface SMAdapter
FORMAT00, FORMAT01, FORMAT02, FORMAT03, FORMAT04, FORMAT05, FORMAT34, FORMAT35, FORMAT41, FORMAT42, LENGTH_DES, LENGTH_DES3_2KEY, LENGTH_DES3_3KEY, TYPE_BDK, TYPE_CVK, TYPE_DEK, TYPE_HMAC, TYPE_MK_AC, TYPE_MK_CVC3, TYPE_MK_DAC, TYPE_MK_DN, TYPE_MK_SMC, TYPE_MK_SMI, TYPE_PVK, TYPE_RSA_PK, TYPE_RSA_SK, TYPE_TAK, TYPE_TMK, TYPE_TPK, TYPE_ZAK, TYPE_ZEK, TYPE_ZMK, TYPE_ZPK

Modifier and Type

Field

Description

static final byte

FORMAT00

Proprietary PIN Block format.

static final byte

FORMAT01

PIN Block Format adopted by ANSI (ANSI X9.8) and is one of two formats supported by the ISO (ISO 95641 - format 0).

static final byte

FORMAT02

PIN Block Format 02 supports Douctel ATMs.

static final byte

FORMAT03

PIN Block Format 03 is the Diabold Pin Block format.

static final byte

FORMAT04

PIN Block Format 04 is the PIN block format adopted by the PLUS network.

static final byte

FORMAT05

PIN Block Format 05 is the ISO 9564-1 Format 1 PIN Block.

static final byte

FORMAT34

PIN Block Format 34 is the standard EMV PIN block format.

static final byte

FORMAT35

PIN Block Format 35 is the required by Europay/MasterCard for their Pay Now & Pay Later products.

static final byte

FORMAT41

PIN Block Format 41 is the Visa format for PIN change without using the current PIN.

static final byte

FORMAT42

PIN Block Format 42 is the Visa format for PIN change using the current (old) PIN.

static final short

LENGTH_DES

DES Key Length LENGTH_DES = 64.

static final short

LENGTH_DES3_2KEY

Triple DES (2 keys) LENGTH_DES3_2KEY = 128.

static final short

LENGTH_DES3_3KEY

Triple DES (3 keys) LENGTH_DES3_3KEY = 192.

static final String

TYPE_BDK

BDK: Base Derivation Key.

static final String

TYPE_CVK

CVK: Card Verification Key.

static final String

TYPE_DEK

DEK: Data Encryption Key.

static final String

TYPE_HMAC

HMAC: Hash Message Authentication Code (with key usage).

static final String

TYPE_MK_AC

MK-AC: Issuer Master Key for generating and verifying Application Cryptograms.

static final String

TYPE_MK_CVC3

MK-CVC3: Issuer Master Key for generating and verifying Card Verification Code 3 (CVC3).

static final String

TYPE_MK_DAC

MK-DAC Issuer Master Key for generating and verifying Data Authentication Codes.

static final String

TYPE_MK_DN

MK-DN: Issuer Master Key for generating and verifying Dynamic Numbers.

static final String

TYPE_MK_SMC

MK-SMC: Issuer Master Key for Secure Messaging Confidentiality.

static final String

TYPE_MK_SMI

MK-SMI: Issuer Master Key for Secure Messaging Integrity.

static final String

TYPE_PVK

PVK: PIN Verification Key.

static final String

TYPE_RSA_PK

RSA: Public Key.

static final String

TYPE_RSA_SK

RSA: Private Key.

static final String

TYPE_TAK

TAK: Terminal Authentication Key.

static final String

TYPE_TMK

TMK: Terminal Master Key.

static final String

TYPE_TPK

TPK: Terminal PIN Key.

static final String

TYPE_ZAK

ZAK: Zone Authentication Key.

static final String

TYPE_ZEK

ZEK: Zone Encryption Key.

static final String

TYPE_ZMK

ZMK: Zone Master Key is a DES (or Triple-DES) key-encryption key which is distributed manually in order that further keys can be exchanged automatically.

static final String

TYPE_ZPK

ZPK: Zone PIN Key.
Constructor Summary

Constructors

Constructor

Description

JCESecurityModule()

Creates an uninitialized JCE Security Module, you need to setConfiguration to initialize it

JCESecurityModule(String lmkFile)

Creates a JCE Security Module initialised with the given LMK file.

JCESecurityModule(String lmkFile, String jceProviderClassName)

Constructs a JCE security module backed by the given LMK file and JCE provider.

JCESecurityModule(Configuration cfg, Logger logger, String realm)

Constructs a JCE security module from a Configuration, logger, and realm.
Method Summary

Modifier and Type

Method

Description

protected byte[]

calculateARPC(Key skarpc, byte[] arqc, ARPCMethod arpcMethod, byte[] arc, byte[] propAuthData)

Calculate ARPC (Application Response Cryptogram).

protected byte[]

calculateARQC(MKDMethod mkdm, SKDMethod skdm, SecureDESKey imkac, String accountNo, String accntSeqNo, byte[] atc, byte[] upn, byte[] transData)

Calculate ARQC (Application Request Cryptogram).

protected String

calculateCAVVImpl(String accountNo, SecureDESKey cvk, String upn, String authrc, String sfarc)

Your SMAdapter should override this method if it has this functionality

protected String

calculateCVC3(SecureDESKey imkcvc3, String accountNo, String acctSeqNo, byte[] atc, byte[] upn, byte[] data, MKDMethod mkdm)

Computes the contactless CVC3 from the issuer master key, ATC, UPN, and track data.

protected String

calculateCVD(String accountNo, Key cvk, String expDate, String serviceCode)

Calculates a CVD/CVV from the supplied clear CVK using the Visa algorithm.

protected String

calculateCVDImpl(String accountNo, SecureDESKey cvkA, SecureDESKey cvkB, String expDate, String serviceCode)

Your SMAdapter should override this method if it has this functionality

protected String

calculateCVV(String accountNo, Key cvk, Date expDate, String serviceCode)

Calculates a CVV using the supplied clear CVK and an expiry Date formatted as yyMM.

protected String

calculateCVVImpl(String accountNo, SecureDESKey cvkA, SecureDESKey cvkB, Date expDate, String serviceCode)

Your SMAdapter should override this method if it has this functionality

protected String

calculatedCVV(String accountNo, SecureDESKey imkac, String expDate, String serviceCode, byte[] atc, MKDMethod mkdm)

Computes a dynamic CVV (dCVV) using ATC and an issuer master key.

protected byte[]

calculateDerivedKey(KeySerialNumber ksn, SecureDESKey bdk, boolean tdes, boolean dataEncryption)

Computes the DUKPT-derived working key for the given KSN and BDK.

protected byte[]

calculateKeyCheckValue(Key key)

Calculates a key check value over a clear key.

protected String

calculatePIN(byte[] pinBlock, byte pinBlockFormat, String accountNumber)

Calculates the clear pin (as entered by card holder on the pin entry device) givin the clear PIN block

protected byte[]

calculatePINBlock(String pin, byte pinBlockFormat, String accountNumber)

Calculates the clear PIN Block

protected String

calculatePVV(EncryptedPIN pinUnderLmk, Key key, int keyIdx, List<String> excludes)

Calculates a 4-digit PVV using the IBM 3624 algorithm.

protected String

calculatePVVImpl(EncryptedPIN pinUnderLmk, SecureDESKey pvkA, SecureDESKey pvkB, int pvkIdx, List<String> excludes)

Your SMAdapter should override this method if it has this functionality

protected String

calculatePVVImpl(EncryptedPIN pinUnderKd1, SecureDESKey kd1, SecureDESKey pvkA, SecureDESKey pvkB, int pvkIdx, List<String> excludes)

Your SMAdapter should override this method if it has this functionality

protected void

checkCAVVArgs(String upn, String authrc, String sfarc)

Validates the lengths of the CAVV inputs, throwing SMException with a descriptive message when any value is null or wrong-sized.

protected Key

concatKeys(SecureDESKey keyA, SecureDESKey keyB)

Concatenates two single-length DES keys into a double-length DESede key, decrypting them from the LMK first.

byte[]

dataDecrypt(SecureDESKey bdk, byte[] cypherText)

Decrypt Data

byte[]

dataEncrypt(SecureDESKey bdk, byte[] clearText)

Encrypt Data

byte[]

decryptDataImpl(CipherMode cipherMode, SecureDESKey kd, byte[] data, byte[] iv)

Your SMAdapter should override this method if it has this functionality

protected Key

decryptFromLMK(SecureDESKey secureDESKey)

Decrypts a secure DES key from encryption under LMK.

String

decryptPINImpl(EncryptedPIN pinUnderLmk)

Your SMAdapter should override this method if it has this functionality

protected Key

deriveICCMasterKey(Key imk, byte[] panpsn)

Derive ICC Master Key from Issuer Master Key and preformated PAN/PANSeqNo Compute two 8-byte numbers: left part is a result of Triple-DES encryption of panpsn with imk as the key right part is a result of Triple-DES encryption of binary-inverted panpsn with imk as the key concatenate left and right parts
Described in EMV v4.2 Book 2, Annex A1.4.1 Master Key Derivation point 2

byte[]

encryptDataImpl(CipherMode cipherMode, SecureDESKey kd, byte[] data, byte[] iv)

Your SMAdapter should override this method if it has this functionality

EncryptedPIN

encryptPINImpl(String pin, String accountNumber)

Your SMAdapter should override this method if it has this functionality

protected EncryptedPIN

encryptPINImpl(String pin, String accountNumber, SecureDESKey pek)

Your SMAdapter should override this method if it has this functionality.

protected SecureDESKey

encryptToLMK(short keyLength, String keyType, Key clearDESKey)

Encrypts a clear DES Key under LMK to form a SecureKey.

byte[]

exportKeyImpl(SecureDESKey key, SecureDESKey kek)

Your SMAdapter should override this method if it has this functionality

EncryptedPIN

exportPIN(EncryptedPIN pinUnderLmk, KeySerialNumber ksn, SecureDESKey bdk, boolean tdes, byte destinationPINBlockFormat)

Exports PIN to DUKPT Encryption.

EncryptedPIN

exportPINImpl(EncryptedPIN pinUnderLmk, SecureDESKey kd2, byte destinationPINBlockFormat)

Your SMAdapter should override this method if it has this functionality

SecureDESKey

formKEYfromClearComponents(short keyLength, String keyType, String... components)

Forms a key from 3 clear components and returns it encrypted under its corresponding LMK The corresponding LMK is determined from the keyType

SecureDESKey

formKEYfromThreeClearComponents(short keyLength, String keyType, String clearComponent1HexString, String clearComponent2HexString, String clearComponent3HexString)

Forms a key from 3 clear components and returns it encrypted under its corresponding LMK The corresponding LMK is determined from the keyType

byte[]

generateARPCImpl(MKDMethod mkdm, SKDMethod skdm, SecureDESKey imkac, String accountNo, String accntSeqNo, byte[] arqc, byte[] atc, byte[] upn, ARPCMethod arpcMethod, byte[] arc, byte[] propAuthData)

Your SMAdapter should override this method if it has this functionality

protected byte[]

generateCBC_MACImpl(byte[] data, SecureDESKey kd)

Generates CBC-MAC (Cipher Block Chaining Message Authentication Code) for some data.

String

generateClearKeyComponent(short keyLength)

Generates a random clear key component.

protected byte[]

generateEDE_MACImpl(byte[] data, SecureDESKey kd)

Generates EDE-MAC (Encrypt Decrypt Encrypt Message Authentication Code) for some data.

protected byte[]

generateKeyCheckValueImpl(SecureDESKey secureDESKey)

Generates key check value.

SecureDESKey

generateKeyImpl(short keyLength, String keyType)

Your SMAdapter should override this method if it has this functionality

EncryptedPIN

generatePINImpl(String accountNumber, int pinLen, List<String> excludes)

Your SMAdapter should override this method if it has this functionality

protected byte[]

generateSM_MACImpl(MKDMethod mkdm, SKDMethod skdm, SecureDESKey imksmi, String accountNo, String accntSeqNo, byte[] atc, byte[] arqc, byte[] data)

Your SMAdapter should override this method if it has this functionality

SecureDESKey

importBDK(String clearComponent1HexString, String clearComponent2HexString, String clearComponent3HexString)

Imports a 128-bit BDK assembled from three clear hex-encoded components.

SecureDESKey

importKeyImpl(short keyLength, String keyType, byte[] encryptedKey, SecureDESKey kek, boolean checkParity)

Your SMAdapter should override this method if it has this functionality

protected EncryptedPIN

importPINImpl(EncryptedPIN pinUnderDuk, KeySerialNumber ksn, SecureDESKey bdk, boolean tdes)

Your SMAdapter should override this method if it has this functionality

EncryptedPIN

importPINImpl(EncryptedPIN pinUnderKd1, SecureDESKey kd1)

Your SMAdapter should override this method if it has this functionality

void

setConfiguration(Configuration cfg)

Configures a JCESecurityModule

protected byte[]

specialDecrypt(byte[] data, byte[] key)

Inverse of specialEncrypt(byte[], byte[]).

protected byte[]

specialEncrypt(byte[] data, byte[] key)

DUKPT helper that applies a single- or triple-DES "X9.24" style transform over an 8-byte block.

SecureDESKey

translateKeySchemeImpl(SecureDESKey key, KeyScheme keyScheme)

Your SMAdapter should override this method if it has this functionality

protected org.javatuples.Pair<EncryptedPIN, byte[]>

translatePINGenerateSM_MACImpl(MKDMethod mkdm, SKDMethod skdm, PaddingMethod padm, SecureDESKey imksmi, String accountNo, String accntSeqNo, byte[] atc, byte[] arqc, byte[] data, EncryptedPIN currentPIN, EncryptedPIN newPIN, SecureDESKey kd1, SecureDESKey imksmc, SecureDESKey imkac, byte destinationPINBlockFormat)

Your SMAdapter should override this method if it has this functionality

protected EncryptedPIN

translatePINImpl(EncryptedPIN pinUnderDuk, KeySerialNumber ksn, SecureDESKey bdk, SecureDESKey kd2, byte destinationPINBlockFormat, boolean tdes)

Translates a DUKPT-encrypted PIN block to a target encryption key, optionally re-formatting the PIN block.

EncryptedPIN

translatePINImpl(EncryptedPIN pinUnderKd1, SecureDESKey kd1, SecureDESKey kd2, byte destinationPINBlockFormat)

Your SMAdapter should override this method if it has this functionality

byte[]

verifyARQCGenerateARPCImpl(MKDMethod mkdm, SKDMethod skdm, SecureDESKey imkac, String accountNo, String accntSeqNo, byte[] arqc, byte[] atc, byte[] upn, byte[] transData, ARPCMethod arpcMethod, byte[] arc, byte[] propAuthData)

Your SMAdapter should override this method if it has this functionality

protected boolean

verifyARQCImpl(MKDMethod mkdm, SKDMethod skdm, SecureDESKey imkac, String accountNo, String accntSeqNo, byte[] arqc, byte[] atc, byte[] upn, byte[] transData)

Your SMAdapter should override this method if it has this functionality

protected boolean

verifyCAVVImpl(String accountNo, SecureDESKey cvk, String cavv, String upn, String authrc, String sfarc)

Your SMAdapter should override this method if it has this functionality

protected boolean

verifyCVC3Impl(SecureDESKey imkcvc3, String accountNo, String acctSeqNo, byte[] atc, byte[] upn, byte[] data, MKDMethod mkdm, String cvc3)

Your SMAdapter should override this method if it has this functionality

protected boolean

verifyCVVImpl(String accountNo, SecureDESKey cvkA, SecureDESKey cvkB, String cvv, String expDate, String serviceCode)

Your SMAdapter should override this method if it has this functionality

protected boolean

verifyCVVImpl(String accountNo, SecureDESKey cvkA, SecureDESKey cvkB, String cvv, Date expDate, String serviceCode)

Your SMAdapter should override this method if it has this functionality

protected boolean

verifydCVVImpl(String accountNo, SecureDESKey imkac, String dcvv, String expDate, String serviceCode, byte[] atc, MKDMethod mkdm)

Your SMAdapter should override this method if it has this functionality

protected boolean

verifydCVVImpl(String accountNo, SecureDESKey imkac, String dcvv, Date expDate, String serviceCode, byte[] atc, MKDMethod mkdm)

Your SMAdapter should override this method if it has this functionality

boolean

verifyPVVImpl(EncryptedPIN pinUnderKd1, SecureDESKey kd1, SecureDESKey pvkA, SecureDESKey pvkB, int pvki, String pvv)

Your SMAdapter should override this method if it has this functionality

Methods inherited from class BaseSMAdapter
calculateCAVV, calculateCVD, calculateCVV, calculateIBMPINOffset, calculateIBMPINOffset, calculateIBMPINOffset, calculateIBMPINOffset, calculateIBMPINOffsetImpl, calculateIBMPINOffsetImpl, calculatePVV, calculatePVV, calculatePVV, calculatePVV, calculateSignature, calculateSignatureImpl, decryptData, decryptData, decryptDataImpl, decryptPIN, deriveIBMPIN, deriveIBMPINImpl, encryptData, encryptData, encryptDataImpl, encryptPIN, encryptPIN, encryptPIN, eraseOldLMK, eraseOldLMKImpl, exportKey, exportKey, exportKeyImpl, exportPIN, generateARPC, generateCBC_MAC, generateEDE_MAC, generateKey, generateKey, generateKeyCheckValue, generateKeyImpl, generateKeyPair, generateKeyPair, generateKeyPairImpl, generateKeyPairImpl, generatePIN, generatePIN, generateSM_MAC, getLogger, getName, getRealm, getSMAdapter, importKey, importKey, importKeyImpl, importPIN, importPIN, importPIN, importPINImpl, printPIN, printPINImpl, setLogger, setName, translateKeyFromOldLMK, translateKeyFromOldLMK, translateKeyFromOldLMKImpl, translateKeyFromOldLMKImpl, translateKeyScheme, translatePIN, translatePIN, translatePIN, translatePINGenerateSM_MAC, translatePINImpl, verifyARQC, verifyARQCGenerateARPC, verifyCAVV, verifyCVC3, verifyCVD, verifyCVV, verifydCVV, verifydCVV, verifyIBMPINOffset, verifyIBMPINOffsetImpl, verifyPVV

Modifier and Type

Method

Description

String

calculateCAVV(String accountNo, SecureDESKey cvk, String upn, String authrc, String sfarc)

Calaculate a 3-D Secure CAVV/AAV.

String

calculateCVD(String accountNo, SecureDESKey cvkA, SecureDESKey cvkB, String expDate, String serviceCode)

Calaculate a Card Verification Digit (Code/Value).

String

calculateCVV(String accountNo, SecureDESKey cvkA, SecureDESKey cvkB, Date expDate, String serviceCode)

Calaculate a Card Verification Code/Value.

String

calculateIBMPINOffset(EncryptedPIN pinUnderLmk, SecureDESKey pvk, String decTab, String pinValData, int minPinLen)

Calculate an PIN Offset using the IBM 3624 method

String

calculateIBMPINOffset(EncryptedPIN pinUnderLmk, SecureDESKey pvk, String decTab, String pinValData, int minPinLen, List<String> excludes)

Calculate an PIN Offset using the IBM 3624 method

String

calculateIBMPINOffset(EncryptedPIN pinUnderKd1, SecureDESKey kd1, SecureDESKey pvk, String decTab, String pinValData, int minPinLen)

Calculate an PIN Offset using the IBM 3624 method of customer selected PIN

String

calculateIBMPINOffset(EncryptedPIN pinUnderKd1, SecureDESKey kd1, SecureDESKey pvk, String decTab, String pinValData, int minPinLen, List<String> excludes)

Calculate an PIN Offset using the IBM 3624 method of customer selected PIN

protected String

calculateIBMPINOffsetImpl(EncryptedPIN pinUnderLmk, SecureDESKey pvk, String decTab, String pinValData, int minPinLen, List<String> excludes)

Your SMAdapter should override this method if it has this functionality

protected String

calculateIBMPINOffsetImpl(EncryptedPIN pinUnderKd1, SecureDESKey kd1, SecureDESKey pvk, String decTab, String pinValData, int minPinLen, List<String> excludes)

Your SMAdapter should override this method if it has this functionality

String

calculatePVV(EncryptedPIN pinUnderLMK, SecureDESKey pvkA, SecureDESKey pvkB, int pvkIdx)

Calculate PVV (VISA PIN Verification Value of PIN under LMK) with exclude list

String

calculatePVV(EncryptedPIN pinUnderLMK, SecureDESKey pvkA, SecureDESKey pvkB, int pvkIdx, List<String> excludes)

Calculate PVV (VISA PIN Verification Value of PIN under LMK)

String

calculatePVV(EncryptedPIN pinUnderKd1, SecureDESKey kd1, SecureDESKey pvkA, SecureDESKey pvkB, int pvkIdx)

Calculate PVV (VISA PIN Verification Value of customer selected PIN)

String

calculatePVV(EncryptedPIN pinUnderKd1, SecureDESKey kd1, SecureDESKey pvkA, SecureDESKey pvkB, int pvkIdx, List<String> excludes)

Calculate PVV (VISA PIN Verification Value of customer selected PIN)

byte[]

calculateSignature(MessageDigest hash, SecureKey privateKey, byte[] data)

Calculate signature of Data Block.

protected byte[]

calculateSignatureImpl(MessageDigest hash, SecureKey privateKey, byte[] data)

Your SMAdapter should override this method if it has this functionality

byte[]

decryptData(CipherMode cipherMode, SecureDESKey kd, byte[] data, byte[] iv)

Decrypt Data Block.

byte[]

decryptData(SecureKey privKey, byte[] data, AlgorithmParameterSpec algspec, byte[] iv)

Decrypts encrypted Data Block with specified cipher.

protected byte[]

decryptDataImpl(SecureKey decKey, byte[] data, AlgorithmParameterSpec algspec, byte[] iv)

Decrypts Data Block encrypted with assymetric cipher.

String

decryptPIN(EncryptedPIN pinUnderLmk)

Decrypts an Encrypted PIN (under LMK).

EncryptedPIN

deriveIBMPIN(String accountNo, SecureDESKey pvk, String decTab, String pinValData, int minPinLen, String offset)

Derive a PIN Using the IBM 3624 method

protected EncryptedPIN

deriveIBMPINImpl(String accountNo, SecureDESKey pvk, String decTab, String pinValData, int minPinLen, String offset)

Your SMAdapter should override this method if it has this functionality

byte[]

encryptData(CipherMode cipherMode, SecureDESKey kd, byte[] data, byte[] iv)

Encrypt Data Block.

byte[]

encryptData(SecureKey encKey, byte[] data, AlgorithmParameterSpec algspec, byte[] iv)

Encrypts clear Data Block with specified cipher.

protected byte[]

encryptDataImpl(SecureKey encKey, byte[] data, AlgorithmParameterSpec algspec, byte[] iv)

Encrypts clear Data Block with specified cipher.

EncryptedPIN

encryptPIN(String pin, String accountNumber)

Encrypts a clear pin under LMK.

EncryptedPIN

encryptPIN(String pin, String accountNumber, boolean extract)

Encrypts a clear pin under LMK.

EncryptedPIN

encryptPIN(String pin, String accountNumber, SecureDESKey pek)

Encrypts a clear PIN under PEK.

void

eraseOldLMK()

Erase the key change storage area of memory It is recommended that this command is used after keys stored by the Host have been translated from old to new LMKs.

protected void

eraseOldLMKImpl()

Erase the key change storage area of memory It is recommended that this command is used after keys stored by the Host have been translated from old to new LMKs.

byte[]

exportKey(SecureDESKey key, SecureDESKey kek)

Exports secure key to encryption under a KEK (Key-Encrypting Key).

SecureKey

exportKey(SecureKey kek, SecureKey key, SecureKeySpec keySpec)

Exports secure key to encryption under a KEK (Key-Encrypting Key).

protected SecureKey

exportKeyImpl(SecureKey kek, SecureKey key, SecureKeySpec keySpec)

Your SMAdapter should override this method if it has this functionality.

EncryptedPIN

exportPIN(EncryptedPIN pinUnderLmk, SecureDESKey kd2, byte destinationPINBlockFormat)

Exports a PIN from encryption under LMK to encryption under a KD (Data Key).

byte[]

generateARPC(MKDMethod mkdm, SKDMethod skdm, SecureDESKey imkac, String accoutNo, String acctSeqNo, byte[] arqc, byte[] atc, byte[] upn, ARPCMethod arpcMethod, byte[] arc, byte[] propAuthData)

Genarate Authorisation Response Cryptogram (ARPC)

byte[]

generateCBC_MAC(byte[] data, SecureDESKey kd)

Generates CBC-MAC (Cipher Block Chaining Message Authentication Code) for some data.

byte[]

generateEDE_MAC(byte[] data, SecureDESKey kd)

Generates EDE-MAC (Encrypt Decrypt Encrypt Message Message Authentication Code) for some data.

SecureDESKey

generateKey(short keyLength, String keyType)

Generates a random DES Key.

SecureKey

generateKey(SecureKeySpec keySpec)

Generates a random Key.

byte[]

generateKeyCheckValue(SecureDESKey kd)

Generates key check value.

protected SecureKey

generateKeyImpl(SecureKeySpec keySpec)

Your SMAdapter should override this method if it has this functionality.

org.javatuples.Pair<PublicKey, SecurePrivateKey>

generateKeyPair(AlgorithmParameterSpec spec)

Generate a public/private key pair.

org.javatuples.Pair<PublicKey, SecureKey>

generateKeyPair(SecureKeySpec keySpec)

Generate a public/private key pair.

protected org.javatuples.Pair<PublicKey, SecurePrivateKey>

generateKeyPairImpl(AlgorithmParameterSpec spec)

Your SMAdapter should override this method if it has this functionality

protected org.javatuples.Pair<PublicKey, SecureKey>

generateKeyPairImpl(SecureKeySpec keySpec)

Your SMAdapter should override this method if it has this functionality.

EncryptedPIN

generatePIN(String accountNumber, int pinLen)

Generate random pin under LMK

EncryptedPIN

generatePIN(String accountNumber, int pinLen, List<String> excludes)

Generate random pin under LMK with exclude list

byte[]

generateSM_MAC(MKDMethod mkdm, SKDMethod skdm, SecureDESKey imksmi, String accountNo, String acctSeqNo, byte[] atc, byte[] arqc, byte[] data)

Generate Secure Message MAC over suppiled message data

Logger

getLogger()

Returns the Logger associated with this source.

String

getName()

Returns the registered name of this SMAdapter.

String

getRealm()

Returns the log realm associated with this source.

static SMAdapter

getSMAdapter(String name)

Looks up a registered SMAdapter by name from the NameRegistrar.

SecureDESKey

importKey(short keyLength, String keyType, byte[] encryptedKey, SecureDESKey kek, boolean checkParity)

Imports a key from encryption under a KEK (Key-Encrypting Key) to protection under the security module.

SecureKey

importKey(SecureKey kek, SecureKey key, SecureKeySpec keySpec, boolean checkParity)

Imports a key from encryption under a KEK (Key-Encrypting Key) to protection under the security module.

protected SecureKey

importKeyImpl(SecureKey kek, SecureKey key, SecureKeySpec keySpec, boolean checkParity)

Your SMAdapter should override this method if it has this functionality.

EncryptedPIN

importPIN(EncryptedPIN pinUnderDuk, KeySerialNumber ksn, SecureDESKey bdk)

Imports a PIN from encryption under a transaction key to encryption under LMK.

EncryptedPIN

importPIN(EncryptedPIN pinUnderDuk, KeySerialNumber ksn, SecureDESKey bdk, boolean tdes)

Imports a PIN from encryption under a transaction key to encryption under LMK.

EncryptedPIN

importPIN(EncryptedPIN pinUnderKd1, SecureDESKey kd1)

Imports a PIN from encryption under KD (Data Key) to encryption under LMK.

protected EncryptedPIN

importPINImpl(EncryptedPIN pinUnderDuk, KeySerialNumber ksn, SecureDESKey bdk)

Deprecated.

void

printPIN(String accountNo, EncryptedPIN pinUnderKd1, SecureDESKey kd1, String template, Map<String,String> fields)

Print PIN or PIN and solicitation data to the HSM configured printer.

protected void

printPINImpl(String accountNo, EncryptedPIN pinUnderKd1, SecureDESKey kd1, String template, Map<String,String> fields)

Your SMAdapter should override this method if it has this functionality

void

setLogger(Logger logger, String realm)

Attaches a Logger and realm to this log source.

void

setName(String name)

associates this SMAdapter with a name using NameRegistrar

SecureDESKey

translateKeyFromOldLMK(SecureDESKey kd)

Translate key from encryption under the LMK held in key change storage to encryption under a new LMK.

SecureKey

translateKeyFromOldLMK(SecureKey key, SecureKeySpec keySpec)

Translate key from encryption under the LMK held in key change storage to encryption under a new LMK.

protected SecureDESKey

translateKeyFromOldLMKImpl(SecureDESKey kd)

Translate key from encryption under the LMK held in key change storage to encryption under a new LMK.

protected SecureKey

translateKeyFromOldLMKImpl(SecureKey key, SecureKeySpec keySpec)

Your SMAdapter should override this method if it has this functionality.

SecureDESKey

translateKeyScheme(SecureDESKey key, KeyScheme destKeyScheme)

Translate Key Scheme to more secure encription.

EncryptedPIN

translatePIN(EncryptedPIN pinUnderDuk, KeySerialNumber ksn, SecureDESKey bdk, SecureDESKey kd2, byte destinationPINBlockFormat)

Translates a PIN from encryption under a transaction key to encryption under a KD (Data Key).

EncryptedPIN

translatePIN(EncryptedPIN pinUnderDuk, KeySerialNumber ksn, SecureDESKey bdk, SecureDESKey kd2, byte destinationPINBlockFormat, boolean tdes)

Translates a PIN from encryption under a transaction key to encryption under a KD (Data Key).

EncryptedPIN

translatePIN(EncryptedPIN pinUnderKd1, SecureDESKey kd1, SecureDESKey kd2, byte destinationPINBlockFormat)

Translates a PIN from encrytion under KD1 to encryption under KD2.

org.javatuples.Pair<EncryptedPIN, byte[]>

translatePINGenerateSM_MAC(MKDMethod mkdm, SKDMethod skdm, PaddingMethod padm, SecureDESKey imksmi, String accountNo, String acctSeqNo, byte[] atc, byte[] arqc, byte[] data, EncryptedPIN currentPIN, EncryptedPIN newPIN, SecureDESKey kd1, SecureDESKey imksmc, SecureDESKey imkac, byte destinationPINBlockFormat)

Translate PIN and generate MAC over suppiled message data

protected EncryptedPIN

translatePINImpl(EncryptedPIN pinUnderDuk, KeySerialNumber ksn, SecureDESKey bdk, SecureDESKey kd2, byte destinationPINBlockFormat)

Deprecated.

boolean

verifyARQC(MKDMethod mkdm, SKDMethod skdm, SecureDESKey imkac, String accoutNo, String acctSeqNo, byte[] arqc, byte[] atc, byte[] upn, byte[] txnData)

Verify Application Cryptogram (ARQC or TC/AAC) Authorization Request Cryptogram (ARQC) - Online authorization Transaction certificate (TC) - Offline approval Application Authentication Cryptogram (AAC) - Offline decline

byte[]

verifyARQCGenerateARPC(MKDMethod mkdm, SKDMethod skdm, SecureDESKey imkac, String accoutNo, String acctSeqNo, byte[] arqc, byte[] atc, byte[] upn, byte[] txnData, ARPCMethod arpcMethod, byte[] arc, byte[] propAuthData)

Verify Application Cryptogram (ARQC or TC/AAC) and Genarate Authorisation Response Cryptogram (ARPC) Authorization Request Cryptogram (ARQC) - Online authorization Transaction certificate (TC) - Offline approval Application Authentication Cryptogram (AAC) - Offline decline

boolean

verifyCAVV(String accountNo, SecureDESKey cvk, String cavv, String upn, String authrc, String sfarc)

Verify a 3-D Secure CAVV/AAV.

boolean

verifyCVC3(SecureDESKey imkcvc3, String accountNo, String acctSeqNo, byte[] atc, byte[] upn, byte[] data, MKDMethod mkdm, String cvc3)

Verify a Dynamic Card Verification Code 3 (CVC3)

boolean

verifyCVD(String accountNo, SecureDESKey cvkA, SecureDESKey cvkB, String cvv, String expDate, String serviceCode)

Verify a Card Verification Digit (Code/Value).

boolean

verifyCVV(String accountNo, SecureDESKey cvkA, SecureDESKey cvkB, String cvv, Date expDate, String serviceCode)

Verify a Card Verification Code/Value.

boolean

verifydCVV(String accountNo, SecureDESKey imkac, String dcvv, String expDate, String serviceCode, byte[] atc, MKDMethod mkdm)

Verify a Dynamic Card Verification Value (dCVV).

boolean

verifydCVV(String accountNo, SecureDESKey imkac, String dcvv, Date expDate, String serviceCode, byte[] atc, MKDMethod mkdm)

Verify a Dynamic Card Verification Value (dCVV).

boolean

verifyIBMPINOffset(EncryptedPIN pinUnderKd1, SecureDESKey kd1, SecureDESKey pvk, String offset, String decTab, String pinValData, int minPinLen)

Verify an PIN Offset using the IBM 3624 method

protected boolean

verifyIBMPINOffsetImpl(EncryptedPIN pinUnderKd, SecureDESKey kd, SecureDESKey pvk, String offset, String decTab, String pinValData, int minPinLen)

Your SMAdapter should override this method if it has this functionality

boolean

verifyPVV(EncryptedPIN pinUnderKd1, SecureDESKey kd1, SecureDESKey pvkA, SecureDESKey pvkB, int pvki, String pvv)

Verify PVV (VISA PIN Verification Value of an LMK encrypted PIN)

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- jceHandler
  
  protected JCEHandler jceHandler
  
  Helper used for raw JCE cipher and key operations.
Constructor Details
- JCESecurityModule
  
  public JCESecurityModule()
  
  Creates an uninitialized JCE Security Module, you need to setConfiguration to initialize it
- JCESecurityModule
  
  public JCESecurityModule(String lmkFile) throws SMException
  
  Creates a JCE Security Module initialised with the given LMK file.
  
  Parameters:
  
  lmkFile - Local Master Keys filename of the JCE Security Module
  
  Throws:
  
  SMException - on initialisation failure
- JCESecurityModule
  
  public JCESecurityModule(String lmkFile, String jceProviderClassName) throws SMException
  
  Constructs a JCE security module backed by the given LMK file and JCE provider.
  
  Parameters:
  
  lmkFile - path to the Local Master Keys file
  
  jceProviderClassName - fully qualified JCE provider class name
  
  Throws:
  
  SMException - if initialization fails
- JCESecurityModule
  
  public JCESecurityModule(Configuration cfg, Logger logger, String realm) throws ConfigurationException
  
  Constructs a JCE security module from a Configuration, logger, and realm.
  
  Parameters:
  
  cfg - configuration to apply (see setConfiguration(Configuration))
  
  logger - logger to bind
  
  realm - logger realm
  
  Throws:
  
  ConfigurationException - if the configuration is invalid
Method Details
- setConfiguration
  
  public void setConfiguration(Configuration cfg) throws ConfigurationException
  
  Configures a JCESecurityModule
  
  Specified by:
  
  setConfiguration in interface Configurable
  
  Overrides:
  
  setConfiguration in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  cfg - The following properties are read:
  lmk: Local Master Keys file (The only required parameter)
  jce: JCE Provider Class Name, if not provided, it defaults to: com.sun.crypto.provider.SunJCE
  rebuildlmk: (true/false), rebuilds the Local Master Keys file with new keys (WARNING: old keys will be erased)
  cbc-mac: Cipher Block Chaining MAC algorithm name for given JCE Provider.
  Default is ISO9797ALG3MACWITHISO7816-4PADDING from BouncyCastle provider (known as Retail-MAC)
  that is suitable for most of interfaces with double length MAC key
  ANSI X9.19 aka ISO/IEC 9797-1 MAC algorithm 3 padding method 2 - ISO7816
  ede-mac: Encrypt Decrypt Encrypt MAC algorithm name for given JCE Provider.
  Default is DESEDEMAC from BouncyCastle provider
  that is suitable for BASE24 with double length MAC key
  ANSI X9.19
  
  Throws:
  
  ConfigurationException - if configuration is invalid
- generateKeyImpl
  
  public SecureDESKey generateKeyImpl(short keyLength, String keyType) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  generateKeyImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  keyLength - requested key length
  
  keyType - requested key type
  
  Returns:
  
  generated key
  
  Throws:
  
  SMException - on security module error
- importKeyImpl
  
  public SecureDESKey importKeyImpl(short keyLength, String keyType, byte[] encryptedKey, SecureDESKey kek, boolean checkParity) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  importKeyImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  keyLength - requested key length
  
  keyType - requested key type
  
  encryptedKey - encrypted key bytes
  
  kek - key-encrypting key
  
  checkParity - whether to check DES key parity
  
  Returns:
  
  imported key
  
  Throws:
  
  SMException - on security module error
- exportKeyImpl
  
  public byte[] exportKeyImpl(SecureDESKey key, SecureDESKey kek) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  exportKeyImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  key - secure key
  
  kek - key-encrypting key
  
  Returns:
  
  exported key
  
  Throws:
  
  SMException - on security module error
- encryptPINImpl
  
  public EncryptedPIN encryptPINImpl(String pin, String accountNumber) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  encryptPINImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  pin - clear PIN value
  
  accountNumber - account number associated with the PIN block
  
  Returns:
  
  encrypted PIN under LMK
  
  Throws:
  
  SMException - on security module error
- encryptPINImpl
  
  protected EncryptedPIN encryptPINImpl(String pin, String accountNumber, SecureDESKey pek) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality.
  
  Overrides:
  
  encryptPINImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  pin - clear PIN value
  
  accountNumber - account number associated with the PIN block
  
  pek - PIN-encrypting key
  
  Returns:
  
  encrypted PIN under PEK.
  
  Throws:
  
  SMException - on security module error
- decryptPINImpl
  
  public String decryptPINImpl(EncryptedPIN pinUnderLmk) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  decryptPINImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  pinUnderLmk - PIN block encrypted under the LMK
  
  Returns:
  
  clear pin as entered by card holder
  
  Throws:
  
  SMException - on security module error
- importPINImpl
  
  public EncryptedPIN importPINImpl(EncryptedPIN pinUnderKd1, SecureDESKey kd1) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  importPINImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  pinUnderKd1 - PIN block encrypted under the source key
  
  kd1 - source key
  
  Returns:
  
  imported pin
  
  Throws:
  
  SMException - on security module error
- exportPINImpl
  
  public EncryptedPIN exportPINImpl(EncryptedPIN pinUnderLmk, SecureDESKey kd2, byte destinationPINBlockFormat) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  exportPINImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  pinUnderLmk - PIN block encrypted under the LMK
  
  kd2 - destination key
  
  destinationPINBlockFormat - destination PIN block format
  
  Returns:
  
  exported pin
  
  Throws:
  
  SMException - on security module error
- generatePINImpl
  
  public EncryptedPIN generatePINImpl(String accountNumber, int pinLen, List<String> excludes) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  generatePINImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  accountNumber - account number associated with the PIN block
  
  pinLen - requested PIN length
  
  excludes - PIN values to reject
  
  Returns:
  
  generated PIN under LMK
  
  Throws:
  
  SMException - on security module error
- concatKeys
  
  protected Key concatKeys(SecureDESKey keyA, SecureDESKey keyB) throws SMException
  
  Concatenates two single-length DES keys into a double-length DESede key, decrypting them from the LMK first. If either non-null input is already longer than single-length, decrypts and returns that key.
  
  Parameters:
  
  keyA - first secured key, may be null
  
  keyB - second secured key, may be null
  
  Returns:
  
  a clear-text DES/DESede key, or null if both inputs are null
  
  Throws:
  
  SMException - if key decryption or assembly fails
- calculateCVV
  
  protected String calculateCVV(String accountNo, Key cvk, Date expDate, String serviceCode) throws SMException
  
  Calculates a CVV using the supplied clear CVK and an expiry Date formatted as yyMM.
  
  Parameters:
  
  accountNo - cardholder primary account number
  
  cvk - clear CVK
  
  expDate - expiry date
  
  serviceCode - 3-digit service code
  
  Returns:
  
  the 3-digit CVV
  
  Throws:
  
  SMException - if the cipher operation fails
- calculateCVD
  
  protected String calculateCVD(String accountNo, Key cvk, String expDate, String serviceCode) throws SMException
  
  Calculates a CVD/CVV from the supplied clear CVK using the Visa algorithm.
  
  Parameters:
  
  accountNo - cardholder primary account number
  
  cvk - clear CVK
  
  expDate - expiry date as yyMM
  
  serviceCode - 3-digit service code
  
  Returns:
  
  the 3-digit CVD/CVV
  
  Throws:
  
  SMException - if the cipher operation fails
- calculateCVVImpl
  
  protected String calculateCVVImpl(String accountNo, SecureDESKey cvkA, SecureDESKey cvkB, Date expDate, String serviceCode) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  calculateCVVImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  accountNo - card account number
  
  cvkA - first card verification key
  
  cvkB - second card verification key
  
  expDate - card expiration date
  
  serviceCode - card service code
  
  Returns:
  
  Card Verification Code/Value
  
  Throws:
  
  SMException - on security module error
- calculateCVDImpl
  
  protected String calculateCVDImpl(String accountNo, SecureDESKey cvkA, SecureDESKey cvkB, String expDate, String serviceCode) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  calculateCVDImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  accountNo - card account number
  
  cvkA - first card verification key
  
  cvkB - second card verification key
  
  expDate - card expiration date
  
  serviceCode - card service code
  
  Returns:
  
  Card Verification Digit (Code/Value)
  
  Throws:
  
  SMException - on security module error
- checkCAVVArgs
  
  protected void checkCAVVArgs(String upn, String authrc, String sfarc) throws SMException
  
  Validates the lengths of the CAVV inputs, throwing SMException with a descriptive message when any value is null or wrong-sized.
  
  Parameters:
  
  upn - 4-digit unpredictable number
  
  authrc - 1-character authorization result code
  
  sfarc - 2-character second-factor authorization result code
  
  Throws:
  
  SMException - if any argument is null or has the wrong length
- calculateCAVVImpl
  
  protected String calculateCAVVImpl(String accountNo, SecureDESKey cvk, String upn, String authrc, String sfarc) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  calculateCAVVImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  accountNo - card account number
  
  cvk - card verification key
  
  upn - unpredictable number
  
  authrc - authorization response code
  
  sfarc - second-factor authorization response code
  
  Returns:
  
  Cardholder Authentication Verification Value
  
  Throws:
  
  SMException - on security module error
- verifyCVVImpl
  
  protected boolean verifyCVVImpl(String accountNo, SecureDESKey cvkA, SecureDESKey cvkB, String cvv, Date expDate, String serviceCode) throws SMException
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  verifyCVVImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  accountNo - card account number
  
  cvkA - first card verification key
  
  cvkB - second card verification key
  
  cvv - card verification value
  
  expDate - card expiration date
  
  serviceCode - card service code
  
  Returns:
  
  true if CVV/CVC is falid or false if not
  
  Throws:
  
  SMException - on security module error
- verifyCVVImpl
  
  protected boolean verifyCVVImpl(String accountNo, SecureDESKey cvkA, SecureDESKey cvkB, String cvv, String expDate, String serviceCode) throws SMException
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  verifyCVVImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  accountNo - card account number
  
  cvkA - first card verification key
  
  cvkB - second card verification key
  
  cvv - card verification value
  
  expDate - card expiration date
  
  serviceCode - card service code
  
  Returns:
  
  true if CVV/CVC is valid or false otherwise
  
  Throws:
  
  SMException - on security module error
- verifyCAVVImpl
  
  protected boolean verifyCAVVImpl(String accountNo, SecureDESKey cvk, String cavv, String upn, String authrc, String sfarc) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  verifyCAVVImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  accountNo - card account number
  
  cvk - card verification key
  
  cavv - cardholder authentication verification value
  
  upn - unpredictable number
  
  authrc - authorization response code
  
  sfarc - second-factor authorization response code
  
  Returns:
  
  Cardholder Authentication Verification Value
  
  Throws:
  
  SMException - on security module error
- calculatedCVV
  
  protected String calculatedCVV(String accountNo, SecureDESKey imkac, String expDate, String serviceCode, byte[] atc, MKDMethod mkdm) throws SMException
  
  Computes a dynamic CVV (dCVV) using ATC and an issuer master key.
  
  Parameters:
  
  accountNo - cardholder primary account number
  
  imkac - issuer master key for AC, encrypted under the LMK
  
  expDate - expiry date as yyMM
  
  serviceCode - 3-digit service code
  
  atc - application transaction counter
  
  mkdm - master-key derivation method (defaults to MKDMethod.OPTION_A)
  
  Returns:
  
  the calculated dCVV
  
  Throws:
  
  SMException - if key derivation or computation fails
- verifydCVVImpl
  
  protected boolean verifydCVVImpl(String accountNo, SecureDESKey imkac, String dcvv, Date expDate, String serviceCode, byte[] atc, MKDMethod mkdm) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  verifydCVVImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  accountNo - card account number
  
  imkac - issuer master key for application cryptograms
  
  dcvv - dynamic card verification value
  
  expDate - card expiration date
  
  serviceCode - card service code
  
  atc - application transaction counter
  
  mkdm - master-key derivation method
  
  Returns:
  
  true if dcvv is valid false if not
  
  Throws:
  
  SMException - on security module error
- verifydCVVImpl
  
  protected boolean verifydCVVImpl(String accountNo, SecureDESKey imkac, String dcvv, String expDate, String serviceCode, byte[] atc, MKDMethod mkdm) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  verifydCVVImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  accountNo - card account number
  
  imkac - issuer master key for application cryptograms
  
  dcvv - dynamic card verification value
  
  expDate - card expiration date
  
  serviceCode - card service code
  
  atc - application transaction counter
  
  mkdm - master-key derivation method
  
  Returns:
  
  true if dcvv is valid false if not
  
  Throws:
  
  SMException - on security module error
- calculateCVC3
  
  protected String calculateCVC3(SecureDESKey imkcvc3, String accountNo, String acctSeqNo, byte[] atc, byte[] upn, byte[] data, MKDMethod mkdm) throws SMException
  
  Computes the contactless CVC3 from the issuer master key, ATC, UPN, and track data.
  
  Parameters:
  
  imkcvc3 - issuer master key for CVC3, encrypted under the LMK
  
  accountNo - cardholder primary account number
  
  acctSeqNo - PAN sequence number, or null
  
  atc - application transaction counter
  
  upn - unpredictable number
  
  data - IVCVC3 seed (or 2 bytes pre-computed IVCVC3)
  
  mkdm - master-key derivation method (defaults to MKDMethod.OPTION_A)
  
  Returns:
  
  the 5-digit CVC3
  
  Throws:
  
  SMException - if key derivation or computation fails
- verifyCVC3Impl
  
  protected boolean verifyCVC3Impl(SecureDESKey imkcvc3, String accountNo, String acctSeqNo, byte[] atc, byte[] upn, byte[] data, MKDMethod mkdm, String cvc3) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  verifyCVC3Impl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  imkcvc3 - issuer master key for CVC3
  
  accountNo - card account number
  
  acctSeqNo - PAN sequence number
  
  atc - application transaction counter
  
  upn - unpredictable number
  
  data - input data
  
  mkdm - master-key derivation method
  
  cvc3 - card validation code 3
  
  Returns:
  
  true if cvc3 is valid false if not
  
  Throws:
  
  SMException - on security module error
- deriveICCMasterKey
  protected Key deriveICCMasterKey(Key imk, byte[] panpsn) throws JCEHandlerException
  
  Derive ICC Master Key from Issuer Master Key and preformated PAN/PANSeqNo Compute two 8-byte numbers:
  
  left part is a result of Triple-DES encryption of panpsn with imk as the key
  
  right part is a result of Triple-DES encryption of binary-inverted panpsn with imk as the key
  
  concatenate left and right parts
  
  Described in EMV v4.2 Book 2, Annex A1.4.1 Master Key Derivation point 2
  
  Parameters:
  
  imk - 16-bytes Issuer Master Key
  
  panpsn - preformated PAN and PAN Sequence Number
  
  Returns:
  
  derived 16-bytes ICC Master Key with adjusted DES parity
  
  Throws:
  
  JCEHandlerException - on cryptographic failure
- calculatePVV
  
  protected String calculatePVV(EncryptedPIN pinUnderLmk, Key key, int keyIdx, List<String> excludes) throws SMException
  
  Calculates a 4-digit PVV using the IBM 3624 algorithm.
  
  Parameters:
  
  pinUnderLmk - PIN block encrypted under the LMK
  
  key - clear PVV key
  
  keyIdx - PVV key index (only the low decimal digit is used)
  
  excludes - optional list of PINs to reject before computing the PVV
  
  Returns:
  
  the 4-digit PVV
  
  Throws:
  
  SMException - if the PIN is on the excludes list or computation fails
- calculatePVVImpl
  
  protected String calculatePVVImpl(EncryptedPIN pinUnderLmk, SecureDESKey pvkA, SecureDESKey pvkB, int pvkIdx, List<String> excludes) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  calculatePVVImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  pinUnderLmk - PIN block encrypted under the LMK
  
  pvkA - first PIN verification key
  
  pvkB - second PIN verification key
  
  pvkIdx - PIN verification key index
  
  excludes - PIN values to reject
  
  Returns:
  
  PVV (VISA PIN Verification Value)
  
  Throws:
  
  SMException - on security module error
- calculatePVVImpl
  
  protected String calculatePVVImpl(EncryptedPIN pinUnderKd1, SecureDESKey kd1, SecureDESKey pvkA, SecureDESKey pvkB, int pvkIdx, List<String> excludes) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  calculatePVVImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  pinUnderKd1 - PIN block encrypted under the source key
  
  kd1 - source key
  
  pvkA - first PIN verification key
  
  pvkB - second PIN verification key
  
  pvkIdx - PIN verification key index
  
  excludes - PIN values to reject
  
  Returns:
  
  PVV (VISA PIN Verification Value)
  
  Throws:
  
  SMException - on security module error
- verifyPVVImpl
  
  public boolean verifyPVVImpl(EncryptedPIN pinUnderKd1, SecureDESKey kd1, SecureDESKey pvkA, SecureDESKey pvkB, int pvki, String pvv) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  verifyPVVImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  pinUnderKd1 - PIN block encrypted under the key
  
  kd1 - secure key
  
  pvkA - first PIN verification key
  
  pvkB - second PIN verification key
  
  pvki - PIN verification key index
  
  pvv - PIN verification value
  
  Returns:
  
  true if pin is valid false if not
  
  Throws:
  
  SMException - on security module error
- translatePINImpl
  
  public EncryptedPIN translatePINImpl(EncryptedPIN pinUnderKd1, SecureDESKey kd1, SecureDESKey kd2, byte destinationPINBlockFormat) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  translatePINImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  pinUnderKd1 - PIN block encrypted under the source key
  
  kd1 - source key
  
  kd2 - destination key
  
  destinationPINBlockFormat - destination PIN block format
  
  Returns:
  
  translated pin
  
  Throws:
  
  SMException - on security module error
- calculateARQC
  
  protected byte[] calculateARQC(MKDMethod mkdm, SKDMethod skdm, SecureDESKey imkac, String accountNo, String accntSeqNo, byte[] atc, byte[] upn, byte[] transData) throws SMException
  
  Calculate ARQC (Application Request Cryptogram).
  Entry point e.g. for simulator systems.
  
  Parameters:
  
  mkdm - Master Key Derivation Method
  
  skdm - Session Key Derivation Method
  
  imkac - Issuer Master Key for Application Cryptogram
  
  accountNo - account number
  
  accntSeqNo - account sequence number
  
  atc - Application Transaction Counter
  
  upn - Unpredictable Number
  
  transData - transaction data
  
  Returns:
  
  computed ARQC bytes
  
  Throws:
  
  SMException - on cryptographic failure
- verifyARQCImpl
  
  protected boolean verifyARQCImpl(MKDMethod mkdm, SKDMethod skdm, SecureDESKey imkac, String accountNo, String accntSeqNo, byte[] arqc, byte[] atc, byte[] upn, byte[] transData) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  verifyARQCImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  mkdm - master-key derivation method
  
  skdm - session-key derivation method
  
  imkac - issuer master key for application cryptograms
  
  accountNo - card account number
  
  accntSeqNo - PAN sequence number
  
  arqc - application request cryptogram
  
  atc - application transaction counter
  
  upn - unpredictable number
  
  transData - transaction data
  
  Returns:
  
  true if ARQC/TC/AAC is valid or false if not
  
  Throws:
  
  SMException - on security module error
- generateARPCImpl
  
  public byte[] generateARPCImpl(MKDMethod mkdm, SKDMethod skdm, SecureDESKey imkac, String accountNo, String accntSeqNo, byte[] arqc, byte[] atc, byte[] upn, ARPCMethod arpcMethod, byte[] arc, byte[] propAuthData) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  generateARPCImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  mkdm - master-key derivation method
  
  skdm - session-key derivation method
  
  imkac - issuer master key for application cryptograms
  
  accountNo - card account number
  
  accntSeqNo - PAN sequence number
  
  arqc - application request cryptogram
  
  atc - application transaction counter
  
  upn - unpredictable number
  
  arpcMethod - ARPC generation method
  
  arc - authorization response code
  
  propAuthData - proprietary authentication data
  
  Returns:
  
  calculated ARPC
  
  Throws:
  
  SMException - on security module error
- verifyARQCGenerateARPCImpl
  
  public byte[] verifyARQCGenerateARPCImpl(MKDMethod mkdm, SKDMethod skdm, SecureDESKey imkac, String accountNo, String accntSeqNo, byte[] arqc, byte[] atc, byte[] upn, byte[] transData, ARPCMethod arpcMethod, byte[] arc, byte[] propAuthData) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  verifyARQCGenerateARPCImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  mkdm - master-key derivation method
  
  skdm - session-key derivation method
  
  imkac - issuer master key for application cryptograms
  
  accountNo - card account number
  
  accntSeqNo - PAN sequence number
  
  arqc - application request cryptogram
  
  atc - application transaction counter
  
  upn - unpredictable number
  
  transData - transaction data
  
  arpcMethod - ARPC generation method
  
  arc - authorization response code
  
  propAuthData - proprietary authentication data
  
  Returns:
  
  calculated ARPC
  
  Throws:
  
  SMException - on security module error
- calculateARPC
  
  protected byte[] calculateARPC(Key skarpc, byte[] arqc, ARPCMethod arpcMethod, byte[] arc, byte[] propAuthData) throws SMException
  
  Calculate ARPC (Application Response Cryptogram).
  Entry point e.g. for simulator systems.
  
  Parameters:
  
  skarpc - Session Key for ARPC computation
  
  arqc - Application Request Cryptogram
  
  arpcMethod - ARPC generation method
  
  arc - Authorization Response Code
  
  propAuthData - proprietary authentication data (may be null)
  
  Returns:
  
  computed ARPC bytes
  
  Throws:
  
  SMException - on cryptographic failure
- generateSM_MACImpl
  
  protected byte[] generateSM_MACImpl(MKDMethod mkdm, SKDMethod skdm, SecureDESKey imksmi, String accountNo, String accntSeqNo, byte[] atc, byte[] arqc, byte[] data) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  generateSM_MACImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  mkdm - master-key derivation method
  
  skdm - session-key derivation method
  
  imksmi - issuer master key for secure messaging integrity
  
  accountNo - card account number
  
  accntSeqNo - PAN sequence number
  
  atc - application transaction counter
  
  arqc - application request cryptogram
  
  data - input data
  
  Returns:
  
  generated 8 bytes MAC
  
  Throws:
  
  SMException - on security module error
- translatePINGenerateSM_MACImpl
  
  protected org.javatuples.Pair<EncryptedPIN, byte[]> translatePINGenerateSM_MACImpl(MKDMethod mkdm, SKDMethod skdm, PaddingMethod padm, SecureDESKey imksmi, String accountNo, String accntSeqNo, byte[] atc, byte[] arqc, byte[] data, EncryptedPIN currentPIN, EncryptedPIN newPIN, SecureDESKey kd1, SecureDESKey imksmc, SecureDESKey imkac, byte destinationPINBlockFormat) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  translatePINGenerateSM_MACImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  mkdm - master-key derivation method
  
  skdm - session-key derivation method
  
  padm - proprietary authentication data method
  
  imksmi - issuer master key for secure messaging integrity
  
  accountNo - card account number
  
  accntSeqNo - PAN sequence number
  
  atc - application transaction counter
  
  arqc - application request cryptogram
  
  data - input data
  
  currentPIN - current PIN value
  
  newPIN - replacement PIN value
  
  kd1 - source key
  
  imksmc - issuer master key for secure messaging confidentiality
  
  imkac - issuer master key for application cryptograms
  
  destinationPINBlockFormat - destination PIN block format
  
  Returns:
  
  Pair of values, encrypted PIN and 8 bytes MAC
  
  Throws:
  
  SMException - on security module error
- encryptDataImpl
  
  public byte[] encryptDataImpl(CipherMode cipherMode, SecureDESKey kd, byte[] data, byte[] iv) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  encryptDataImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  cipherMode - cipher mode
  
  kd - secure key
  
  data - input data
  
  iv - initialization vector
  
  Returns:
  
  encrypted data
  
  Throws:
  
  SMException - on security module error
- decryptDataImpl
  
  public byte[] decryptDataImpl(CipherMode cipherMode, SecureDESKey kd, byte[] data, byte[] iv) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  decryptDataImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  cipherMode - cipher mode
  
  kd - secure key
  
  data - input data
  
  iv - initialization vector
  
  Returns:
  
  decrypted data
  
  Throws:
  
  SMException - on security module error
- generateCBC_MACImpl
  
  protected byte[] generateCBC_MACImpl(byte[] data, SecureDESKey kd) throws SMException
  
  Generates CBC-MAC (Cipher Block Chaining Message Authentication Code) for some data.
  
  Overrides:
  
  generateCBC_MACImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  data - the data to be MACed
  
  kd - the key used for MACing
  
  Returns:
  
  generated CBC-MAC bytes
  
  Throws:
  
  SMException - on MAC computation failure
- generateEDE_MACImpl
  
  protected byte[] generateEDE_MACImpl(byte[] data, SecureDESKey kd) throws SMException
  
  Generates EDE-MAC (Encrypt Decrypt Encrypt Message Authentication Code) for some data.
  
  Overrides:
  
  generateEDE_MACImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  data - the data to be MACed
  
  kd - the key used for MACing
  
  Returns:
  
  generated EDE-MAC bytes
  
  Throws:
  
  SMException - on MAC computation failure
- generateClearKeyComponent
  
  public String generateClearKeyComponent(short keyLength) throws SMException
  
  Generates a random clear key component.
  
  Parameters:
  
  keyLength - the desired key length (e.g. LENGTH_DES, LENGTH_DES3_2KEY)
  
  Returns:
  
  clear key component as a hex string
  
  Throws:
  
  SMException - on key generation failure
- generateKeyCheckValueImpl
  
  protected byte[] generateKeyCheckValueImpl(SecureDESKey secureDESKey) throws SMException
  
  Generates key check value.
  
  Overrides:
  
  generateKeyCheckValueImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  secureDESKey - SecureDESKey with untrusted or fake Key Check Value
  
  Returns:
  
  generated Key Check Value
  
  Throws:
  
  SMException - on cryptographic failure
- translateKeySchemeImpl
  
  public SecureDESKey translateKeySchemeImpl(SecureDESKey key, KeyScheme keyScheme) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  translateKeySchemeImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  key - secure key
  
  keyScheme - destination key scheme
  
  Returns:
  
  translated key with destKeyScheme scheme
  
  Throws:
  
  SMException - on security module error
- formKEYfromThreeClearComponents
  
  public SecureDESKey formKEYfromThreeClearComponents(short keyLength, String keyType, String clearComponent1HexString, String clearComponent2HexString, String clearComponent3HexString) throws SMException
  
  Forms a key from 3 clear components and returns it encrypted under its corresponding LMK The corresponding LMK is determined from the keyType
  
  Parameters:
  
  keyLength - e.g. LENGTH_DES, LENGTH_DES3_2, LENGTH_DES3_3, ..
  
  keyType - possible values are those defined in the SecurityModule interface, e.g. ZMK, TMK
  
  clearComponent1HexString - HexString containing the first component
  
  clearComponent2HexString - HexString containing the second component
  
  clearComponent3HexString - HexString containing the third component
  
  Returns:
  
  SecureDESKey formed from the three clear components
  
  Throws:
  
  SMException - on key formation failure
- formKEYfromClearComponents
  
  public SecureDESKey formKEYfromClearComponents(short keyLength, String keyType, String... components) throws SMException
  
  Description copied from interface: SMAdapter
  
  Forms a key from 3 clear components and returns it encrypted under its corresponding LMK The corresponding LMK is determined from the keyType
  
  Specified by:
  
  formKEYfromClearComponents in interface SMAdapter<SecureDESKey>
  
  Overrides:
  
  formKEYfromClearComponents in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  keyLength - e.g. LENGTH_DES, LENGTH_DES3_2, LENGTH_DES3_3, ..
  
  keyType - possible values are those defined in the SecurityModule inteface. e.g., ZMK, TMK,...
  
  components - up to three HexStrings containing key components
  
  Returns:
  
  forms an SecureDESKey from two clear components
  
  Throws:
  
  SMException - on security module error
- calculateKeyCheckValue
  
  protected byte[] calculateKeyCheckValue(Key key) throws SMException
  
  Calculates a key check value over a clear key.
  
  Parameters:
  
  key - the clear key
  
  Returns:
  
  the key check value
  
  Throws:
  
  SMException - on error
- encryptToLMK
  
  protected SecureDESKey encryptToLMK(short keyLength, String keyType, Key clearDESKey) throws SMException
  
  Encrypts a clear DES Key under LMK to form a SecureKey.
  
  Parameters:
  
  keyLength - the key length (e.g. LENGTH_DES, LENGTH_DES3_2KEY)
  
  keyType - the key type as defined in SMAdapter (e.g. ZMK, TMK)
  
  clearDESKey - the clear DES key to encrypt
  
  Returns:
  
  secureDESKey the key encrypted under LMK
  
  Throws:
  
  SMException - on encryption failure
- decryptFromLMK
  
  protected Key decryptFromLMK(SecureDESKey secureDESKey) throws SMException
  
  Decrypts a secure DES key from encryption under LMK.
  
  Parameters:
  
  secureDESKey - key encrypted under LMK
  
  Returns:
  
  clear key
  
  Throws:
  
  SMException - on decryption failure
- calculatePINBlock
  
  protected byte[] calculatePINBlock(String pin, byte pinBlockFormat, String accountNumber) throws SMException
  
  Calculates the clear PIN Block
  
  Parameters:
  
  pin - as entered by the card holder on the PIN entry device
  
  pinBlockFormat - the PIN block format identifier
  
  accountNumber - (the 12 right-most digits of the account number excluding the check digit)
  
  Returns:
  
  The clear PIN Block
  
  Throws:
  
  SMException - on invalid PIN or format error
- calculatePIN
  
  protected String calculatePIN(byte[] pinBlock, byte pinBlockFormat, String accountNumber) throws SMException
  
  Calculates the clear pin (as entered by card holder on the pin entry device) givin the clear PIN block
  
  Parameters:
  
  pinBlock - clear PIN Block
  
  pinBlockFormat - the PIN block format identifier
  
  accountNumber - the 12 right-most digits of the account number
  
  Returns:
  
  the pin
  
  Throws:
  
  SMException - on invalid PIN block or format error
- specialEncrypt
  
  protected byte[] specialEncrypt(byte[] data, byte[] key) throws JCEHandlerException
  
  DUKPT helper that applies a single- or triple-DES "X9.24" style transform over an 8-byte block. For an 8-byte key the operation is data = (data XOR key) | encrypt | XOR key; for a 16-byte key it is the standard EDE3 transform.
  
  Parameters:
  
  data - 8-byte input block
  
  key - single- or double-length DES key
  
  Returns:
  
  the transformed 8-byte block
  
  Throws:
  
  JCEHandlerException - on cipher failure
- specialDecrypt
  
  protected byte[] specialDecrypt(byte[] data, byte[] key) throws JCEHandlerException
  
  Inverse of specialEncrypt(byte[], byte[]).
  
  Parameters:
  
  data - 8-byte input block
  
  key - single- or double-length DES key
  
  Returns:
  
  the transformed 8-byte block
  
  Throws:
  
  JCEHandlerException - on cipher failure
- dataEncrypt
  
  public byte[] dataEncrypt(SecureDESKey bdk, byte[] clearText) throws SMException
  
  Description copied from interface: SMAdapter
  
  Encrypt Data
  
  Specified by:
  
  dataEncrypt in interface SMAdapter<SecureDESKey>
  
  Overrides:
  
  dataEncrypt in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  bdk - base derivation key
  
  clearText - clear Text
  
  Returns:
  
  cyphertext
  
  Throws:
  
  SMException - on security module error
- dataDecrypt
  
  public byte[] dataDecrypt(SecureDESKey bdk, byte[] cypherText) throws SMException
  
  Description copied from interface: SMAdapter
  
  Decrypt Data
  
  Specified by:
  
  dataDecrypt in interface SMAdapter<SecureDESKey>
  
  Overrides:
  
  dataDecrypt in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  bdk - base derivation key
  
  cypherText - clear Text
  
  Returns:
  
  cleartext
  
  Throws:
  
  SMException - on security module error
- calculateDerivedKey
  
  protected byte[] calculateDerivedKey(KeySerialNumber ksn, SecureDESKey bdk, boolean tdes, boolean dataEncryption) throws SMException
  
  Computes the DUKPT-derived working key for the given KSN and BDK.
  
  Parameters:
  
  ksn - key serial number
  
  bdk - base derivation key, encrypted under the LMK
  
  tdes - if true, use the triple-DES variant; otherwise single-DES
  
  dataEncryption - true when deriving a data-encryption variant key
  
  Returns:
  
  the derived working key bytes
  
  Throws:
  
  SMException - if derivation fails
- importBDK
  
  public SecureDESKey importBDK(String clearComponent1HexString, String clearComponent2HexString, String clearComponent3HexString) throws SMException
  
  Imports a 128-bit BDK assembled from three clear hex-encoded components.
  
  Parameters:
  
  clearComponent1HexString - first hex component
  
  clearComponent2HexString - second hex component
  
  clearComponent3HexString - third hex component
  
  Returns:
  
  the secured BDK encrypted under the LMK
  
  Throws:
  
  SMException - if any component is malformed or assembly fails
- translatePINImpl
  
  protected EncryptedPIN translatePINImpl(EncryptedPIN pinUnderDuk, KeySerialNumber ksn, SecureDESKey bdk, SecureDESKey kd2, byte destinationPINBlockFormat, boolean tdes) throws SMException
  
  Translates a DUKPT-encrypted PIN block to a target encryption key, optionally re-formatting the PIN block.
  
  Overrides:
  
  translatePINImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  pinUnderDuk - PIN block encrypted under a derived DUKPT key
  
  ksn - key serial number used to derive the source key
  
  bdk - base derivation key, encrypted under the LMK
  
  kd2 - destination key, encrypted under the LMK
  
  destinationPINBlockFormat - target PIN block format
  
  tdes - if true, derive using triple-DES
  
  Returns:
  
  the PIN re-encrypted under kd2
  
  Throws:
  
  SMException - if derivation, decryption, or re-encryption fails
- importPINImpl
  
  protected EncryptedPIN importPINImpl(EncryptedPIN pinUnderDuk, KeySerialNumber ksn, SecureDESKey bdk, boolean tdes) throws SMException
  
  Description copied from class: BaseSMAdapter
  
  Your SMAdapter should override this method if it has this functionality
  
  Overrides:
  
  importPINImpl in class BaseSMAdapter<SecureDESKey>
  
  Parameters:
  
  pinUnderDuk - PIN block encrypted under a DUKPT-derived key
  
  ksn - key serial number
  
  bdk - base derivation key
  
  tdes - whether to use triple-DES DUKPT derivation
  
  Returns:
  
  imported pin
  
  Throws:
  
  SMException - on security module error
- exportPIN
  
  public EncryptedPIN exportPIN(EncryptedPIN pinUnderLmk, KeySerialNumber ksn, SecureDESKey bdk, boolean tdes, byte destinationPINBlockFormat) throws SMException
  
  Exports PIN to DUKPT Encryption.
  
  Parameters:
  
  pinUnderLmk - PIN block encrypted under the LMK
  
  ksn - key serial number used to derive the working key
  
  bdk - base derivation key, encrypted under the LMK
  
  tdes - if true, derive using triple-DES
  
  destinationPINBlockFormat - target PIN block format
  
  Returns:
  
  The encrypted pin
  
  Throws:
  
  SMException - if derivation, decryption, or re-encryption fails

Class JCESecurityModule

Field Summary

Fields inherited from class BaseSMAdapter

Fields inherited from interface SMAdapter

Constructor Summary

Method Summary

Methods inherited from class BaseSMAdapter

Methods inherited from class Object

Field Details

jceHandler

Constructor Details

JCESecurityModule

JCESecurityModule

JCESecurityModule

JCESecurityModule

Method Details

setConfiguration

generateKeyImpl

importKeyImpl

exportKeyImpl

encryptPINImpl

encryptPINImpl

decryptPINImpl

importPINImpl

exportPINImpl

generatePINImpl

concatKeys

calculateCVV

calculateCVD

calculateCVVImpl

calculateCVDImpl

checkCAVVArgs

calculateCAVVImpl

verifyCVVImpl

verifyCVVImpl

verifyCAVVImpl

calculatedCVV

verifydCVVImpl

verifydCVVImpl

calculateCVC3

verifyCVC3Impl

deriveICCMasterKey

calculatePVV

calculatePVVImpl

calculatePVVImpl

verifyPVVImpl

translatePINImpl

calculateARQC

verifyARQCImpl

generateARPCImpl

verifyARQCGenerateARPCImpl

calculateARPC

generateSM_MACImpl

translatePINGenerateSM_MACImpl

encryptDataImpl

decryptDataImpl

generateCBC_MACImpl

generateEDE_MACImpl

generateClearKeyComponent

generateKeyCheckValueImpl

translateKeySchemeImpl

formKEYfromThreeClearComponents

formKEYfromClearComponents

calculateKeyCheckValue

encryptToLMK

decryptFromLMK

calculatePINBlock

calculatePIN

specialEncrypt

specialDecrypt

dataEncrypt

dataDecrypt

calculateDerivedKey

importBDK

translatePINImpl

importPINImpl

exportPIN