org.jpos.security

Class ExtKeyUsage

java.lang.Object

org.jpos.security.KeyUsage

org.jpos.security.ExtKeyUsage

public class ExtKeyUsage
extends KeyUsage

Defines the primary usage of the key contained in the key block.

Each value repesents bytes 5-6 of the Keyblok Header.

This class defines proprietary specific key usages. In the great majority of cases, the ones defined by TR-31 KeyUsage will be sufficient. There are no strong reasons for separating e.g. KEK keys to ZMK and TMK, or PINENC keys to ZPK and TPK. KEK and PINENC should be enough.

However, when it is necessary to use, for example: private/public RSA keys or HMAC keys, the only option is to use the proprietary key usages.

The proprietary key usages for ExtKeyUsage are optional and can be defined in your resources at . A file with the same name in the jPOS test resources can be used as an example.

Field Summary

Fields

Modifier and Type	Field and Description
static KeyUsage	DEK DEK - Data Encryption Key.
static KeyUsage	HMACSHA1 HMAC key using SHA-1.
static KeyUsage	HMACSHA224 HMAC key using SHA-224.
static KeyUsage	HMACSHA256 HMAC key using SHA-256.
static KeyUsage	HMACSHA384 HMAC key using SHA-384.
static KeyUsage	HMACSHA512 HMAC key using SHA-512.
static KeyUsage	RSAPK RSA Public Key.
static KeyUsage	RSASK RSA Private Key for signing or key management.
static KeyUsage	RSASKICC RSA Private Key for ICC personalization.
static KeyUsage	RSASKPIN RSA Private Key for PIN translation.
static KeyUsage	RSASKTLS RSA Private Key for TLS.
static KeyUsage	TEK TEK - Terminal Encryption Key.
static KeyUsage	TMK TMK - Terminal Master Key.
static KeyUsage	TPK TPK - Terminal PIN Encryption Key.
static KeyUsage	ZEK ZEK - Zone Encryption Key.
static KeyUsage	ZMK ZMK - Zone Master Key.
static KeyUsage	ZPK ZPK - Zone PIN Encryption Key.

Fields inherited from class org.jpos.security.KeyUsage

BDK, CVK, EMVACMK, EMVCPMK, EMVDAMK, EMVDNMK, EMVMPMK, EMVOTMK, EMVSCMK, EMVSIMK, ENC, IKEY, INIT, ISOMAC0, ISOMAC1, ISOMAC2, ISOMAC3, ISOMAC4, ISOMAC5, KEK, KEKWRAP, PINENC, PINV3624, PINVER, TR31MAP, VISAPVV

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ExtKeyUsage(java.lang.String code, java.lang.String name) Internal constructor.

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,KeyUsage>	entries()
static KeyUsage	valueOfByCode(java.lang.String code) Returns the enum constant of this type with the specified code.

Methods inherited from class org.jpos.security.KeyUsage

getCode, getName, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEK

public static final KeyUsage DEK

DEK - Data Encryption Key.

ZEK

public static final KeyUsage ZEK

ZEK - Zone Encryption Key.

TEK

public static final KeyUsage TEK

TEK - Terminal Encryption Key.

RSAPK

public static final KeyUsage RSAPK

RSA Public Key.

RSASK

public static final KeyUsage RSASK

RSA Private Key for signing or key management.

RSASKICC

public static final KeyUsage RSASKICC

RSA Private Key for ICC personalization.

RSASKPIN

public static final KeyUsage RSASKPIN

RSA Private Key for PIN translation.

RSASKTLS

public static final KeyUsage RSASKTLS

RSA Private Key for TLS.

TMK

public static final KeyUsage TMK

TMK - Terminal Master Key.

ZMK

public static final KeyUsage ZMK

ZMK - Zone Master Key.

HMACSHA1

public static final KeyUsage HMACSHA1

HMAC key using SHA-1.

HMACSHA224

public static final KeyUsage HMACSHA224

HMAC key using SHA-224.

HMACSHA256

public static final KeyUsage HMACSHA256

HMAC key using SHA-256.

HMACSHA384

public static final KeyUsage HMACSHA384

HMAC key using SHA-384.

HMACSHA512

public static final KeyUsage HMACSHA512

HMAC key using SHA-512.

TPK

public static final KeyUsage TPK

TPK - Terminal PIN Encryption Key.

ZPK

public static final KeyUsage ZPK

ZPK - Zone PIN Encryption Key.

Constructor Detail

ExtKeyUsage

protected ExtKeyUsage(java.lang.String code,
                      java.lang.String name)

Internal constructor.

The constructor is protected to guarantee only one instance of the key usage in the entire JVM. This makes it possible to use the operator == or != as it does for enums.

Parameters:

code - the key usage code

name - the usage name

Method Detail

valueOfByCode

public static KeyUsage valueOfByCode(java.lang.String code)

Returns the enum constant of this type with the specified code.

Parameters:

code -

Returns:

the enum constant with the specified processing code or null if unknown.

entries

public static java.util.Map<java.lang.String,KeyUsage> entries()