org.jmrtd

Class DESedeSecureMessagingWrapper

java.lang.Object

org.jmrtd.SecureMessagingWrapper

org.jmrtd.DESedeSecureMessagingWrapper

All Implemented Interfaces:

Serializable, net.sf.scuba.smartcards.APDUWrapper

public class DESedeSecureMessagingWrapper
extends SecureMessagingWrapper
implements Serializable

Secure messaging wrapper for APDUs. Initially based on Section E.3 of ICAO-TR-PKI.

Version:

$Revision: 1559 $

Author:

Cees-Bart Breunesse ([email protected]), Martijn Oostdijk ([email protected])

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static IvParameterSpec	ZERO_IV_PARAM_SPEC Initialization vector consisting of 8 zero bytes.

Constructor Summary

Constructors

Constructor and Description
DESedeSecureMessagingWrapper(SecretKey ksEnc, SecretKey ksMac) Constructs a secure messaging wrapper based on the secure messaging session keys.
DESedeSecureMessagingWrapper(SecretKey ksEnc, SecretKey ksMac, boolean doCheckMAC) Constructs a secure messaging wrapper based on the secure messaging session keys.
DESedeSecureMessagingWrapper(SecretKey ksEnc, SecretKey ksMac, boolean doCheckMAC, long ssc) Constructs a secure messaging wrapper based on the secure messaging session keys and the initial value of the send sequence counter.
DESedeSecureMessagingWrapper(SecretKey ksEnc, SecretKey ksMac, long ssc) Constructs a secure messaging wrapper based on the secure messaging session keys and the initial value of the send sequence counter.

Method Summary

Modifier and Type	Method and Description
SecretKey	getEncryptionKey() Gets the shared key for encrypting APDU payloads.
SecretKey	getMACKey() Get the shared key for computing message authentication codes over APDU payloads.
long	getSendSequenceCounter() Gets the current value of the send sequence counter.
String	toString()
net.sf.scuba.smartcards.ResponseAPDU	unwrap(net.sf.scuba.smartcards.ResponseAPDU responseAPDU) Unwraps the apdu buffer rapdu of a response apdu.
net.sf.scuba.smartcards.CommandAPDU	wrap(net.sf.scuba.smartcards.CommandAPDU commandAPDU) Wraps the APDU buffer capdu of a command APDU.

Methods inherited from class java.lang.Object

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

Field Detail

ZERO_IV_PARAM_SPEC

public static final IvParameterSpec ZERO_IV_PARAM_SPEC

Initialization vector consisting of 8 zero bytes.

Constructor Detail

DESedeSecureMessagingWrapper

public DESedeSecureMessagingWrapper(SecretKey ksEnc,
                                    SecretKey ksMac)
                             throws GeneralSecurityException

Constructs a secure messaging wrapper based on the secure messaging session keys. The initial value of the send sequence counter is set to 0L.

Parameters:

ksEnc - the session key for encryption

ksMac - the session key for macs

Throws:

GeneralSecurityException - when the available JCE providers cannot provide the necessary cryptographic primitives ("DESede/CBC/Nopadding" Cipher, "ISO9797Alg3Mac" Mac).

DESedeSecureMessagingWrapper

public DESedeSecureMessagingWrapper(SecretKey ksEnc,
                                    SecretKey ksMac,
                                    boolean doCheckMAC)
                             throws GeneralSecurityException

Constructs a secure messaging wrapper based on the secure messaging session keys. The initial value of the send sequence counter is set to 0L.

Parameters:

ksEnc - the session key for encryption

ksMac - the session key for macs

doCheckMAC - whether to check the MAC when unwrapping response APDUs

Throws:

GeneralSecurityException - when the available JCE providers cannot provide the necessary cryptographic primitives ("DESede/CBC/Nopadding" Cipher, "ISO9797Alg3Mac" Mac).

DESedeSecureMessagingWrapper

public DESedeSecureMessagingWrapper(SecretKey ksEnc,
                                    SecretKey ksMac,
                                    long ssc)
                             throws NoSuchAlgorithmException,
                                    NoSuchPaddingException

Constructs a secure messaging wrapper based on the secure messaging session keys and the initial value of the send sequence counter. Used in BAC and EAC 1.

Parameters:

ksEnc - the session key for encryption

ksMac - the session key for macs

ssc - the initial value of the send sequence counter

Throws:

NoSuchPaddingException - when the available JCE providers cannot provide the necessary cryptographic primitives

NoSuchAlgorithmException - when the available JCE providers cannot provide the necessary cryptographic primitives

DESedeSecureMessagingWrapper

public DESedeSecureMessagingWrapper(SecretKey ksEnc,
                                    SecretKey ksMac,
                                    boolean doCheckMAC,
                                    long ssc)
                             throws NoSuchAlgorithmException,
                                    NoSuchPaddingException

Constructs a secure messaging wrapper based on the secure messaging session keys and the initial value of the send sequence counter. Used in BAC and EAC 1.

Parameters:

ksEnc - the session key for encryption

ksMac - the session key for macs

doCheckMAC - whether to check the MAC when unwrapping response APDUs

ssc - the initial value of the send sequence counter

Throws:

NoSuchPaddingException - when the available JCE providers cannot provide the necessary cryptographic primitives

NoSuchAlgorithmException - when the available JCE providers cannot provide the necessary cryptographic primitives

Method Detail

wrap

public net.sf.scuba.smartcards.CommandAPDU wrap(net.sf.scuba.smartcards.CommandAPDU commandAPDU)

Wraps the APDU buffer capdu of a command APDU. As a side effect, this method increments the internal send sequence counter maintained by this wrapper.

Specified by:

wrap in interface net.sf.scuba.smartcards.APDUWrapper

Parameters:

commandAPDU - buffer containing the command APDU

Returns:

length of the command apdu after wrapping

unwrap

public net.sf.scuba.smartcards.ResponseAPDU unwrap(net.sf.scuba.smartcards.ResponseAPDU responseAPDU)

Unwraps the apdu buffer rapdu of a response apdu.

Specified by:

unwrap in interface net.sf.scuba.smartcards.APDUWrapper

Parameters:

responseAPDU - the response APDU

Returns:

a new byte array containing the unwrapped buffer

getEncryptionKey

public SecretKey getEncryptionKey()

Description copied from class: SecureMessagingWrapper

Gets the shared key for encrypting APDU payloads.

Specified by:

getEncryptionKey in class SecureMessagingWrapper

Returns:

the encryption key

getMACKey

public SecretKey getMACKey()

Description copied from class: SecureMessagingWrapper

Get the shared key for computing message authentication codes over APDU payloads.

Specified by:

getMACKey in class SecureMessagingWrapper

Returns:

the MAC key

getSendSequenceCounter

public long getSendSequenceCounter()

Gets the current value of the send sequence counter.

Specified by:

getSendSequenceCounter in class SecureMessagingWrapper

Returns:

the current value of the send sequence counter.

toString

public String toString()

Overrides:

toString in class Object