pro.javacard.gp

Class GlobalPlatform

java.lang.Object

javax.smartcardio.CardChannel

pro.javacard.gp.GlobalPlatform

All Implemented Interfaces:

AutoCloseable

public class GlobalPlatform
extends javax.smartcardio.CardChannel
implements AutoCloseable

Represents a connection to a GlobalPlatform Card (BIBO interface) Does secure channel and low-level translation of GP* objects to APDU-s and arguments NOT thread-safe

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GlobalPlatform.APDUMode
static class	GlobalPlatform.GPSpec

Field Summary

Fields

Modifier and Type	Field and Description
static byte	CLA_GP
static byte	CLA_MAC
static EnumSet<GlobalPlatform.APDUMode>	defaultMode
static byte	INS_DELETE
static byte	INS_GET_DATA
static byte	INS_GET_STATUS
static byte	INS_INITIALIZE_UPDATE
static byte	INS_INSTALL
static byte	INS_LOAD
static byte	INS_PUT_KEY
static byte	INS_SET_STATUS
static byte	INS_STORE_DATA
static byte	P1_INSTALL_AND_MAKE_SELECTABLE
static byte	P1_INSTALL_FOR_INSTALL
static int	SCP_01_05
static int	SCP_01_15
static int	SCP_02_04
static int	SCP_02_05
static int	SCP_02_0A
static int	SCP_02_0B
static int	SCP_02_14
static int	SCP_02_15
static int	SCP_02_1A
static int	SCP_02_1B
static int	SCP_ANY
protected boolean	strict

Constructor Summary

Constructors

Constructor and Description
GlobalPlatform(javax.smartcardio.CardChannel channel, pro.javacard.AID sdAID) Maintaining locks to the underlying hardware is the duty of the caller

Method Summary

Modifier and Type	Method and Description
void	close()
static GlobalPlatform	connect(javax.smartcardio.CardChannel channel, pro.javacard.AID sdAID)
void	deleteAID(pro.javacard.AID aid, boolean deleteDeps) Delete file aid on the card.
void	deleteKey(int keyver)
static GlobalPlatform	discover(javax.smartcardio.CardChannel channel)
void	extradite(pro.javacard.AID what, pro.javacard.AID to)
pro.javacard.AID	getAID()
javax.smartcardio.Card	getCard()
javax.smartcardio.CardChannel	getCardChannel()
int	getChannelNumber()
GPRegistry	getRegistry()
int	getScpKeyVersion()
int	getSCPVersion()
static String	getVersion() Get the version and build information of the library.
protected void	giveStrictWarning(String message)
void	installAndMakeSelectable(pro.javacard.AID packageAID, pro.javacard.AID appletAID, pro.javacard.AID instanceAID, byte privileges, byte[] installParams, byte[] installToken) Deprecated.
void	installAndMakeSelectable(pro.javacard.AID packageAID, pro.javacard.AID appletAID, pro.javacard.AID instanceAID, GPRegistryEntry.Privileges privileges, byte[] installParams, byte[] installToken) Install an applet and make it selectable.
void	installForInstall(pro.javacard.AID packageAID, pro.javacard.AID appletAID, pro.javacard.AID instanceAID, GPRegistryEntry.Privileges privileges, byte[] installParams, byte[] installToken) Install an applet.
void	loadCapFile(pro.javacard.CAPFile cap, pro.javacard.AID target)
void	loadCapFile(pro.javacard.CAPFile cap, pro.javacard.AID target, byte[] dap, String hash)
void	lockUnlockApplet(pro.javacard.AID app, boolean lock)
void	makeDefaultSelected(pro.javacard.AID aid)
void	openSecureChannel(GPSessionKeyProvider keys, byte[] host_challenge, int scpVersion, EnumSet<GlobalPlatform.APDUMode> securityLevel) Establishes a secure channel to the security domain.
void	personalize(pro.javacard.AID aid, byte[] data) Sends STORE DATA commands to the application identified
void	personalize(pro.javacard.AID aid, byte[] data, int P1) Sends STORE DATA commands to the application identified
void	putKey(RSAPublicKey pubkey, int version)
void	putKeys(List<GPKey> keys, boolean replace)
void	renameISD(pro.javacard.AID newaid)
void	setBlockSize(int size)
void	setCardStatus(byte status)
void	setSpec(GlobalPlatform.GPSpec spec)
void	setStrict(boolean strict)
void	storeData(byte[] data, int P1)
int	transmit(ByteBuffer byteBuffer, ByteBuffer byteBuffer1)
javax.smartcardio.ResponseAPDU	transmit(javax.smartcardio.CommandAPDU command)

Methods inherited from class java.lang.Object

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

Field Detail

SCP_ANY

public static final int SCP_ANY

See Also:

Constant Field Values

SCP_01_05

public static final int SCP_01_05

See Also:

Constant Field Values

SCP_01_15

public static final int SCP_01_15

See Also:

Constant Field Values

SCP_02_04

public static final int SCP_02_04

See Also:

Constant Field Values

SCP_02_05

public static final int SCP_02_05

See Also:

Constant Field Values

SCP_02_0A

public static final int SCP_02_0A

See Also:

Constant Field Values

SCP_02_0B

public static final int SCP_02_0B

See Also:

Constant Field Values

SCP_02_14

public static final int SCP_02_14

See Also:

Constant Field Values

SCP_02_15

public static final int SCP_02_15

See Also:

Constant Field Values

SCP_02_1A

public static final int SCP_02_1A

See Also:

Constant Field Values

SCP_02_1B

public static final int SCP_02_1B

See Also:

Constant Field Values

defaultMode

public static final EnumSet<GlobalPlatform.APDUMode> defaultMode

CLA_GP

public static final byte CLA_GP

See Also:

Constant Field Values

CLA_MAC

public static final byte CLA_MAC

See Also:

Constant Field Values

INS_INITIALIZE_UPDATE

public static final byte INS_INITIALIZE_UPDATE

See Also:

Constant Field Values

INS_INSTALL

public static final byte INS_INSTALL

See Also:

Constant Field Values

INS_LOAD

public static final byte INS_LOAD

See Also:

Constant Field Values

INS_DELETE

public static final byte INS_DELETE

See Also:

Constant Field Values

INS_GET_STATUS

public static final byte INS_GET_STATUS

See Also:

Constant Field Values

INS_SET_STATUS

public static final byte INS_SET_STATUS

See Also:

Constant Field Values

INS_PUT_KEY

public static final byte INS_PUT_KEY

See Also:

Constant Field Values

INS_STORE_DATA

public static final byte INS_STORE_DATA

See Also:

Constant Field Values

INS_GET_DATA

public static final byte INS_GET_DATA

See Also:

Constant Field Values

P1_INSTALL_AND_MAKE_SELECTABLE

public static final byte P1_INSTALL_AND_MAKE_SELECTABLE

See Also:

Constant Field Values

P1_INSTALL_FOR_INSTALL

public static final byte P1_INSTALL_FOR_INSTALL

See Also:

Constant Field Values

strict

protected boolean strict

Constructor Detail

GlobalPlatform

public GlobalPlatform(javax.smartcardio.CardChannel channel,
                      pro.javacard.AID sdAID)

Maintaining locks to the underlying hardware is the duty of the caller

Parameters:

channel - channel to talk to

Throws:

IllegalArgumentException - if channel is null.

Method Detail

discover

public static GlobalPlatform discover(javax.smartcardio.CardChannel channel)
                               throws GPException,
                                      javax.smartcardio.CardException

Throws:

GPException

javax.smartcardio.CardException

connect

public static GlobalPlatform connect(javax.smartcardio.CardChannel channel,
                                     pro.javacard.AID sdAID)
                              throws javax.smartcardio.CardException,
                                     GPException

Throws:

javax.smartcardio.CardException

GPException

getVersion

public static String getVersion()

Get the version and build information of the library.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in class javax.smartcardio.CardChannel

setStrict

public void setStrict(boolean strict)

setBlockSize

public void setBlockSize(int size)

setSpec

public void setSpec(GlobalPlatform.GPSpec spec)

getAID

public pro.javacard.AID getAID()

getCardChannel

public javax.smartcardio.CardChannel getCardChannel()

giveStrictWarning

protected void giveStrictWarning(String message)
                          throws GPException

Throws:

GPException

getScpKeyVersion

public int getScpKeyVersion()

openSecureChannel

public void openSecureChannel(GPSessionKeyProvider keys,
                              byte[] host_challenge,
                              int scpVersion,
                              EnumSet<GlobalPlatform.APDUMode> securityLevel)
                       throws javax.smartcardio.CardException,
                              GPException

Establishes a secure channel to the security domain.

Throws:

javax.smartcardio.CardException

GPException

getCard

public javax.smartcardio.Card getCard()

Specified by:

getCard in class javax.smartcardio.CardChannel

getChannelNumber

public int getChannelNumber()

Specified by:

getChannelNumber in class javax.smartcardio.CardChannel

transmit

public javax.smartcardio.ResponseAPDU transmit(javax.smartcardio.CommandAPDU command)
                                        throws javax.smartcardio.CardException

Specified by:

transmit in class javax.smartcardio.CardChannel

Throws:

javax.smartcardio.CardException

transmit

public int transmit(ByteBuffer byteBuffer,
                    ByteBuffer byteBuffer1)
             throws javax.smartcardio.CardException

Specified by:

transmit in class javax.smartcardio.CardChannel

Throws:

javax.smartcardio.CardException

getSCPVersion

public int getSCPVersion()

loadCapFile

public void loadCapFile(pro.javacard.CAPFile cap,
                        pro.javacard.AID target)
                 throws javax.smartcardio.CardException,
                        GPException

Throws:

javax.smartcardio.CardException

GPException

loadCapFile

public void loadCapFile(pro.javacard.CAPFile cap,
                        pro.javacard.AID target,
                        byte[] dap,
                        String hash)
                 throws javax.smartcardio.CardException,
                        GPException

Throws:

javax.smartcardio.CardException

GPException

installAndMakeSelectable

@Deprecated
public void installAndMakeSelectable(pro.javacard.AID packageAID,
                                                 pro.javacard.AID appletAID,
                                                 pro.javacard.AID instanceAID,
                                                 byte privileges,
                                                 byte[] installParams,
                                                 byte[] installToken)
                                          throws GPException,
                                                 javax.smartcardio.CardException

Deprecated.

Install an applet and make it selectable. The package and applet AID must be present (ie. non-null). If one of the other parameters is null sensible defaults are chosen. If installation parameters are used, they must be passed in a special format, see parameter description below.

Before installation the package containing the applet must be loaded onto the card, see loadCapFile.

This method installs just one applet. Call it several times for packages containing several applets.

Parameters:

packageAID - the package that containing the applet

appletAID - the applet to be installed

instanceAID - the applet AID passed to the install method of the applet, defaults to packageAID if null

privileges - privileges encoded as byte

installParams - tagged installation parameters, defaults to 0xC9 00 (ie. no installation parameters) if null, if non-null the format is 0xC9 len data...

Throws:

GPException

javax.smartcardio.CardException

installAndMakeSelectable

public void installAndMakeSelectable(pro.javacard.AID packageAID,
                                     pro.javacard.AID appletAID,
                                     pro.javacard.AID instanceAID,
                                     GPRegistryEntry.Privileges privileges,
                                     byte[] installParams,
                                     byte[] installToken)
                              throws GPException,
                                     javax.smartcardio.CardException

Install an applet and make it selectable. The package and applet AID must be present (ie. non-null). If one of the other parameters is null sensible defaults are chosen. If installation parameters are used, they must be passed in a special format, see parameter description below.

Before installation the package containing the applet must be loaded onto the card, see loadCapFile.

This method installs just one applet. Call it several times for packages containing several applets.

Parameters:

packageAID - the package that containing the applet

appletAID - the applet to be installed

instanceAID - the applet AID passed to the install method of the applet, defaults to packageAID if null

privileges - privileges encoded as an object

installParams - tagged installation parameters, defaults to 0xC9 00 (ie. no installation parameters) if null, if non-null the format is 0xC9 len data...

Throws:

GPException

javax.smartcardio.CardException

installForInstall

public void installForInstall(pro.javacard.AID packageAID,
                              pro.javacard.AID appletAID,
                              pro.javacard.AID instanceAID,
                              GPRegistryEntry.Privileges privileges,
                              byte[] installParams,
                              byte[] installToken)
                       throws GPException,
                              javax.smartcardio.CardException

Install an applet. Do not make it selectable. The package and applet AID must be present (ie. non-null). If one of the other parameters is null sensible defaults are chosen. If installation parameters are used, they must be passed in a special format, see parameter description below.

Before installation the package containing the applet must be loaded onto the card, see loadCapFile.

This method installs just one applet. Call it several times for packages containing several applets.

Parameters:

packageAID - the package that containing the applet

appletAID - the applet to be installed

instanceAID - the applet AID passed to the install method of the applet, defaults to packageAID if null

privileges - privileges encoded as an object

installParams - tagged installation parameters, defaults to 0xC9 00 (ie. no installation parameters) if null, if non-null the format is 0xC9 len data...

Throws:

GPException

javax.smartcardio.CardException

extradite

public void extradite(pro.javacard.AID what,
                      pro.javacard.AID to)
               throws GPException,
                      javax.smartcardio.CardException

Throws:

GPException

javax.smartcardio.CardException

personalize

public void personalize(pro.javacard.AID aid,
                        byte[] data)
                 throws javax.smartcardio.CardException,
                        GPException

Sends STORE DATA commands to the application identified

Parameters:

aid - - AID of the target application (or Security Domain)

Throws:

GPException

javax.smartcardio.CardException

personalize

public void personalize(pro.javacard.AID aid,
                        byte[] data,
                        int P1)
                 throws javax.smartcardio.CardException,
                        GPException

Sends STORE DATA commands to the application identified

Parameters:

aid - - AID of the target application (or Security Domain)

Throws:

GPException

javax.smartcardio.CardException

storeData

public void storeData(byte[] data,
                      int P1)
               throws javax.smartcardio.CardException,
                      GPException

Throws:

javax.smartcardio.CardException

GPException

makeDefaultSelected

public void makeDefaultSelected(pro.javacard.AID aid)
                         throws javax.smartcardio.CardException,
                                GPException

Throws:

javax.smartcardio.CardException

GPException

lockUnlockApplet

public void lockUnlockApplet(pro.javacard.AID app,
                             boolean lock)
                      throws javax.smartcardio.CardException,
                             GPException

Throws:

javax.smartcardio.CardException

GPException

setCardStatus

public void setCardStatus(byte status)
                   throws javax.smartcardio.CardException,
                          GPException

Throws:

javax.smartcardio.CardException

GPException

deleteAID

public void deleteAID(pro.javacard.AID aid,
                      boolean deleteDeps)
               throws GPException,
                      javax.smartcardio.CardException

Delete file aid on the card. Delete dependencies as well if deleteDeps is true.

Parameters:

aid - identifier of the file to delete

deleteDeps - if true delete dependencies as well

Throws:

javax.smartcardio.CardException - for low-level communication errors

GPException

deleteKey

public void deleteKey(int keyver)
               throws GPException,
                      javax.smartcardio.CardException

Throws:

GPException

javax.smartcardio.CardException

renameISD

public void renameISD(pro.javacard.AID newaid)
               throws GPException,
                      javax.smartcardio.CardException

Throws:

GPException

javax.smartcardio.CardException

putKeys

public void putKeys(List<GPKey> keys,
                    boolean replace)
             throws GPException,
                    javax.smartcardio.CardException

Throws:

GPException

javax.smartcardio.CardException

putKey

public void putKey(RSAPublicKey pubkey,
                   int version)
            throws javax.smartcardio.CardException,
                   GPException

Throws:

javax.smartcardio.CardException

GPException

getRegistry

public GPRegistry getRegistry()
                       throws GPException,
                              javax.smartcardio.CardException

Throws:

GPException

javax.smartcardio.CardException