net.devbase.jfreesteel

Class EidCard

java.lang.Object

net.devbase.jfreesteel.EidCard

Direct Known Subclasses:

EidCardApollo, EidCardGemalto

public abstract class EidCard
extends Object

Smart card wrapper, abstract interface. EidCard is a wrapper around javax.smartcardio.Card providing an interface for reading data from the Serbian eID card. Public read*() methods allow you to get specific data about card holder and certificates stored on the card. There are two implementations, use fromCard() factory method to get an instance supporting the given card. It is recommended that you do not work with EidCard directly, but use a Reader class and assign the listener for the card insertion/removal events. The listener will receive EidCard object when the card is inserted into the terminal.

Author:

Goran Rakic (grakic@devbase.net)

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	BLOCK_SIZE
protected javax.smartcardio.Card	card
protected javax.smartcardio.CardChannel	channel
protected static byte[]	DOCUMENT_FILE Document data
protected static org.slf4j.Logger	logger
protected static byte[]	PERSONAL_FILE Personal data
protected static byte[]	PHOTO_FILE Personal photo in JPEG format
protected static byte[]	RESIDENCE_FILE Place of residence

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EidCard(javax.smartcardio.Card card)

Method Summary

Modifier and Type	Method and Description
protected Map<Integer,byte[]>	addAllToBuilder(EidInfo.Builder builder, Map<Integer,byte[]> rawTagMap, Map<Integer,EidInfo.Tag> tagMapper) Add all raw tags to EidInfo builder.
String	debugEidInfo() Returns a debug string consisting of per-file debug info.
void	disconnect() Disconnects, but doesn't reset the card.
void	disconnect(boolean reset)
protected void	finalize()
static EidCard	fromCard(javax.smartcardio.Card card) Factory method Return instance of EidCard implementation supporting the given card
protected static boolean	isKnownAtr(byte[] atrBytes) Factory "selection" method
static Map<Integer,byte[]>	parseTlv(byte[] bytes) Subdivides the byte array into byte sub-arrays, keyed by their tags Encoding sequence is a repeated sequence of the following.
protected byte[]	readBinary(int offset, int length) Reads the content of the selected file starting at offset, at most length bytes
EidInfo	readEidInfo()
Image	readEidPhoto() Reads the photo data from the card.
protected abstract byte[]	readElementaryFile(byte[] name, boolean strip_tag) Read EF contents, selecting by file path.
protected byte[]	selectFile(byte[] name) Selects the elementary file to read, based on the name passed in.
protected byte[]	selectFile(byte[] name, int ne)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

card

protected javax.smartcardio.Card card

channel

protected javax.smartcardio.CardChannel channel

DOCUMENT_FILE

protected static final byte[] DOCUMENT_FILE

Document data

PERSONAL_FILE

protected static final byte[] PERSONAL_FILE

Personal data

RESIDENCE_FILE

protected static final byte[] RESIDENCE_FILE

Place of residence

PHOTO_FILE

protected static final byte[] PHOTO_FILE

Personal photo in JPEG format

BLOCK_SIZE

protected static final int BLOCK_SIZE

See Also:

Constant Field Values

Constructor Detail

EidCard

protected EidCard(javax.smartcardio.Card card)

Method Detail

fromCard

public static EidCard fromCard(javax.smartcardio.Card card)
                        throws IllegalArgumentException,
                               SecurityException,
                               IllegalStateException,
                               javax.smartcardio.CardException

Factory method Return instance of EidCard implementation supporting the given card

Parameters:

card -

Returns:

Return a new instance

Throws:

SecurityException

IllegalStateException

IllegalArgumentException - Card is not regognized as Serbian eID

javax.smartcardio.CardException

isKnownAtr

protected static boolean isKnownAtr(byte[] atrBytes)

Factory "selection" method

parseTlv

public static Map<Integer,byte[]> parseTlv(byte[] bytes)

Subdivides the byte array into byte sub-arrays, keyed by their tags Encoding sequence is a repeated sequence of the following.

1. The tag, encoded as little-endian unsigned 16-bit number (just like char in Java)
2. The length of data, in bytes, as unsigned little-endian 16-bit number
3. The data bytes, as many as determined by length.

[tag 16bit LE] [len 16bit LE] [len bytes of data] | [fld] [06] ...

Returns:

a map of integer tags to corresponding byte chunks.

readElementaryFile

protected abstract byte[] readElementaryFile(byte[] name,
                                             boolean strip_tag)
                                      throws javax.smartcardio.CardException

Read EF contents, selecting by file path. The file length is read at 4B offset from the file. The method is not thread safe. Exclusive card access should be enabled before calling the method.

Throws:

javax.smartcardio.CardException

readBinary

protected byte[] readBinary(int offset,
                            int length)
                     throws javax.smartcardio.CardException

Reads the content of the selected file starting at offset, at most length bytes

Throws:

javax.smartcardio.CardException

selectFile

protected byte[] selectFile(byte[] name)
                     throws javax.smartcardio.CardException

Selects the elementary file to read, based on the name passed in.

Throws:

javax.smartcardio.CardException

selectFile

protected byte[] selectFile(byte[] name,
                            int ne)
                     throws javax.smartcardio.CardException

Throws:

javax.smartcardio.CardException

readEidPhoto

public Image readEidPhoto()
                   throws javax.smartcardio.CardException

Reads the photo data from the card.

Throws:

javax.smartcardio.CardException

addAllToBuilder

protected Map<Integer,byte[]> addAllToBuilder(EidInfo.Builder builder,
                                              Map<Integer,byte[]> rawTagMap,
                                              Map<Integer,EidInfo.Tag> tagMapper)

Add all raw tags to EidInfo builder.

Parameters:

builder - EidInfo builder

rawTagMap - Parsed map of raw byte strings by TLV code

tagMapper - Map translating Tag codes into EidInfo tags; use Tag.NULL if tag should be silently ignored

Returns:

Raw map of unknown tags

readEidInfo

public EidInfo readEidInfo()
                    throws javax.smartcardio.CardException

Throws:

javax.smartcardio.CardException

debugEidInfo

public String debugEidInfo()
                    throws javax.smartcardio.CardException

Returns a debug string consisting of per-file debug info.

Throws:

javax.smartcardio.CardException

disconnect

public void disconnect()
                throws javax.smartcardio.CardException

Disconnects, but doesn't reset the card.

Throws:

javax.smartcardio.CardException

disconnect

public void disconnect(boolean reset)
                throws javax.smartcardio.CardException

Throws:

javax.smartcardio.CardException

finalize

protected void finalize()

Overrides:

finalize in class Object