org.jmrtd

Class DefaultFileSystem

java.lang.Object

org.jmrtd.DefaultFileSystem

All Implemented Interfaces:

net.sf.scuba.smartcards.FileSystemStructured

public class DefaultFileSystem
extends Object
implements net.sf.scuba.smartcards.FileSystemStructured

A file system for ICAO MRTDs (and similar file systems). This translates abstract high level selection and read binary commands to concrete low level file related APDUs which are sent to the ICC through the card service.

Since:

0.7.0

Version:

$Revision: 1850 $

Author:

The JMRTD team ([email protected])

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_SFI Invalid short identifier.

Constructor Summary

Constructors

Constructor and Description
DefaultFileSystem(APDULevelReadBinaryCapable service, boolean isSFIEnabled) Creates a file system.
DefaultFileSystem(APDULevelReadBinaryCapable service, boolean isSFIEnabled, Map<Short,Byte> fidToSFI) Creates a file system.

Method Summary

Modifier and Type	Method and Description
int	getMaxReadBinaryLength() Returns the currently set maximum length to be requested in READ BINARY commands.
net.sf.scuba.smartcards.FileInfo[]	getSelectedPath() Returns the selected path.
net.sf.scuba.smartcards.APDUWrapper	getWrapper() Returns the wrapper (secure messaging) currently in use.
byte[]	readBinary(int offset, int length) Reads a block of bytes.
void	selectFile(short fid) Selects a file.
byte[]	sendReadBinary(int offset, int le, boolean isTLVEncodedOffsetNeeded) Sends a READ BINARY command for the already selected file to the passport, using the wrapper when a secure channel has been set up.
byte[]	sendReadBinary(int sfi, int offset, int le, boolean isTLVEncodedOffsetNeeded) Sends a READ BINARY command using an explicit short file identifier to the passport, using the wrapper when a secure channel has been set up.
void	sendSelectFile(short fid) Selects a file within the MRTD application.
void	setWrapper(net.sf.scuba.smartcards.APDUWrapper wrapper) Sets the current wrapper to the given APDU wrapper.

Methods inherited from class java.lang.Object

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

Field Detail

NO_SFI

public static final int NO_SFI

Invalid short identifier.

See Also:

Constant Field Values

Constructor Detail

DefaultFileSystem

public DefaultFileSystem(APDULevelReadBinaryCapable service,
                         boolean isSFIEnabled)

Creates a file system.

Parameters:

service - the card service supporting low-level SELECT and/or READ BINARY commands

isSFIEnabled - whether the file system should use short file identifiers in READ BINARY commands

DefaultFileSystem

public DefaultFileSystem(APDULevelReadBinaryCapable service,
                         boolean isSFIEnabled,
                         Map<Short,Byte> fidToSFI)

Creates a file system.

Parameters:

service - the card service supporting low-level SELECT and/or READ BINARY commands

isSFIEnabled - whether the file system should use short file identifiers in READ BINARY commands

fidToSFI - maps file identifiers to short file identifiers

Method Detail

setWrapper

public void setWrapper(net.sf.scuba.smartcards.APDUWrapper wrapper)

Sets the current wrapper to the given APDU wrapper. Subsequent APDUs will be wrapped before sending to the ICC.

Parameters:

wrapper - an APDU wrapper

getWrapper

public net.sf.scuba.smartcards.APDUWrapper getWrapper()

Returns the wrapper (secure messaging) currently in use.

Returns:

the wrapper

getMaxReadBinaryLength

public int getMaxReadBinaryLength()

Returns the currently set maximum length to be requested in READ BINARY commands.

Returns:

the currently set maximum length to be requested in READ BINARY commands

getSelectedPath

public net.sf.scuba.smartcards.FileInfo[] getSelectedPath()
                                                   throws net.sf.scuba.smartcards.CardServiceException

Returns the selected path.

Specified by:

getSelectedPath in interface net.sf.scuba.smartcards.FileSystemStructured

Returns:

the path components

Throws:

net.sf.scuba.smartcards.CardServiceException - on error

selectFile

public void selectFile(short fid)
                throws net.sf.scuba.smartcards.CardServiceException

Selects a file.

Specified by:

selectFile in interface net.sf.scuba.smartcards.FileSystemStructured

Parameters:

fid - indicates the file to select

Throws:

net.sf.scuba.smartcards.CardServiceException - on error communicating over the service

readBinary

public byte[] readBinary(int offset,
                         int length)
                  throws net.sf.scuba.smartcards.CardServiceException

Reads a block of bytes.

Specified by:

readBinary in interface net.sf.scuba.smartcards.FileSystemStructured

Parameters:

offset - offset index in the selected file

length - the number of bytes to read

Returns:

a copy of the bytes read

Throws:

net.sf.scuba.smartcards.CardServiceException - on error

sendSelectFile

public void sendSelectFile(short fid)
                    throws net.sf.scuba.smartcards.CardServiceException

Selects a file within the MRTD application.

Parameters:

fid - a file identifier

Throws:

net.sf.scuba.smartcards.CardServiceException - on error

sendReadBinary

public byte[] sendReadBinary(int offset,
                             int le,
                             boolean isTLVEncodedOffsetNeeded)
                      throws net.sf.scuba.smartcards.CardServiceException

Sends a READ BINARY command for the already selected file to the passport, using the wrapper when a secure channel has been set up.

Parameters:

offset - offset into the file

le - the expected length of the file to read

isTLVEncodedOffsetNeeded - whether to encode the offset in a TLV object (typically for offset larger than 32767)

Returns:

a byte array of length le with (the specified part of) the contents of the currently selected file

Throws:

net.sf.scuba.smartcards.CardServiceException - on tranceive error

sendReadBinary

public byte[] sendReadBinary(int sfi,
                             int offset,
                             int le,
                             boolean isTLVEncodedOffsetNeeded)
                      throws net.sf.scuba.smartcards.CardServiceException

Sends a READ BINARY command using an explicit short file identifier to the passport, using the wrapper when a secure channel has been set up.

Parameters:

sfi - the short file identifier byte as int value (between 0 and 255)

offset - offset into the file

le - the expected length of the file to read

isTLVEncodedOffsetNeeded - whether to encode the offset in a TLV object (typically for offset larger than 32767)

Returns:

a byte array of length le with (the specified part of) the contents of the currently selected file

Throws:

net.sf.scuba.smartcards.CardServiceException - on tranceive error