org.simalliance.openmobileapi

Class PKCS15Provider

java.lang.Object

org.simalliance.openmobileapi.Provider

org.simalliance.openmobileapi.PKCS15Provider

public class PKCS15Provider
extends Provider

This Provider class offers basic services to access a PKCS#15 file system. This Provider requires a PKCS#15 data structure on the Secure Element and a Channel instance allowing the access to this PKCS#15 data structure.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PKCS15Provider.Path This class represents a Path object as defined in chapter 6.1.5 of the PKCS#15 specification (v1.1).

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	AID_PKCS15 Default PKCS#15 AID.

Constructor Summary

Constructors

Constructor and Description
PKCS15Provider(Channel channel) Encapsulates the defined channel by a PKCS#15 file system object.

Method Summary

Methods

Modifier and Type	Method and Description
PKCS15Provider.Path	decodePath(byte[] der) Builds a Path object using a DER-encoded (see ITU X.690 for DER-Coding) buffer.
PKCS15Provider.Path[]	getAuthObjPaths() Returns an array of EF(AODF) paths (Authentication Object Directory Files).
PKCS15Provider.Path[]	getCertificatePaths() Returns an array of EF(CDF) paths (Certificate Directory Files).
PKCS15Provider.Path[]	getDataObjPaths() Returns an array of EF(DODF) paths (Data Object Directory Files).
byte[]	getODF() Returns the raw content of the EF(ODF) (Object Directory File).
PKCS15Provider.Path[]	getPrivateKeyPaths() Returns an array of EF(PrKDF) paths (Private Key Directory Files).
PKCS15Provider.Path[]	getPublicKeyPaths() Returns an array of EF(PuKDF) paths (Public Key Directory Files).
byte[]	getTokenInfo() Returns the raw content of the EF(TokenInfo).
byte[]	readFile(PKCS15Provider.Path path) Selects and reads a PKCS#15 file.
byte[]	searchOID(byte[] dodf, java.lang.String oid) Parses the raw content of an EF(DODF) and searches for a specific OID Data Object.

Methods inherited from class org.simalliance.openmobileapi.Provider

getChannel

Methods inherited from class java.lang.Object

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

Field Detail

AID_PKCS15

public static final byte[] AID_PKCS15

Default PKCS#15 AID.

Constructor Detail

PKCS15Provider

public PKCS15Provider(Channel channel)
               throws java.io.IOException,
                      java.lang.IllegalStateException

Encapsulates the defined channel by a PKCS#15 file system object. This method checks the presence of the EF(ODF) (Object Directory File) with file identifier 5031 and of the EF(TokenInfo) with file identifier 5032. Both files are mandatory and must be present in a valid PKCS#15 file system. This method must first try to select EF(ODF) and EF(TokenInfo) on the provided channel. If the select fails, this method must try to locate a DF(PKCS#15) in the legacy file system using the EF(DIR) according to the data structure described in chapter 5.4 of the PKCS#15 specification (v1.1).

Parameters:

channel - The channel that shall be used by this Provider for file operations.

Throws:

java.io.IOException - if no PKCS#15 file system is detected on the provided channel.

java.lang.IllegalStateException - if the defined channel is closed.

Method Detail

getODF

public byte[] getODF()
              throws java.lang.IllegalStateException

Returns the raw content of the EF(ODF) (Object Directory File).

Returns:

The EF(ODF) as a byte array. Must not be null.

Throws:

java.lang.IllegalStateException - if the defined channel is closed.

getTokenInfo

public byte[] getTokenInfo()

Returns the raw content of the EF(TokenInfo).

Returns:

The EF(TokenInfo) as a byte array. Must not be null.

getPrivateKeyPaths

public PKCS15Provider.Path[] getPrivateKeyPaths()

Returns an array of EF(PrKDF) paths (Private Key Directory Files). The PKCS#15 file system may contain zero, one or several EF(PrKDF).

Returns:

The array of EF(PrKDF) paths. May be null if empty.

getPublicKeyPaths

public PKCS15Provider.Path[] getPublicKeyPaths()

Returns an array of EF(PuKDF) paths (Public Key Directory Files). The PKCS#15 file system may contain zero, one or several EF(PuKDF).

Returns:

The array of EF(PuKDF) paths. May be null if empty.

getCertificatePaths

public PKCS15Provider.Path[] getCertificatePaths()

Returns an array of EF(CDF) paths (Certificate Directory Files). The PKCS#15 file system may contain zero, one or several EF(CDF).

Returns:

The array of EF(CDF) paths. May be null if empty.

getDataObjPaths

public PKCS15Provider.Path[] getDataObjPaths()

Returns an array of EF(DODF) paths (Data Object Directory Files). The PKCS#15 file system may contain zero, one or several EF(DODF).

Returns:

The array of EF(DODF) paths. May be null if empty.

getAuthObjPaths

public PKCS15Provider.Path[] getAuthObjPaths()

Returns an array of EF(AODF) paths (Authentication Object Directory Files). The PKCS#15 file system may contain zero, one or several EF(AODF).

Returns:

The array of EF(AODF) paths. May be null if empty.

readFile

public byte[] readFile(PKCS15Provider.Path path)
                throws java.lang.SecurityException,
                       java.lang.UnsupportedOperationException,
                       java.io.IOException,
                       java.lang.IllegalArgumentException,
                       java.lang.IllegalStateException

Selects and reads a PKCS#15 file. The file may be a transparent or linear fixed EF. The 'index' and 'length' fields of the Path instance will be used according to chapter 6.1.5 of the PKCS#15 specification (v1.1). In case of transparent EF, 'index' is the start offset in the file and 'length' is the length to read. In case of linear fixed EF, 'index' is the record to read.

Parameters:

path - Path of the file.

Returns:

The file content as a byte array. Or null if the referenced path does not exist.

Throws:

java.lang.UnsupportedOperationException - if this operation is not supported.

java.lang.SecurityException - if the operation cannot be performed if a security condition is not satisfied.

java.lang.IllegalArgumentException - if the PKCS#15 file cannot be selected or read. TODO: should be an IllegalReferenceError

java.io.IOException - Lower-lever API exception.

java.lang.IllegalStateException - if the used channel is closed.

searchOID

public byte[] searchOID(byte[] dodf,
               java.lang.String oid)
                 throws java.lang.IllegalArgumentException,
                        java.lang.UnsupportedOperationException

Parses the raw content of an EF(DODF) and searches for a specific OID Data Object. This method is a convenience method to simplify the access to OID Data Objects by applications, as described in chapter 6.7.4 of the PKCS#15 specification (v1.1). In many cases, the EF(DODF) contains a simple OID Data Object with a Path object, in order to reference an application-specific EF. For example, the OMA-DM specification requires a EF(DODF) containing the OID 2.23.43.7.1, followed by a Path object, referencing the EF(DM_Bootstrap).

Parameters:

dodf - The raw content of an EF(DODF) to parse.

oid - The searched OID value (e.g. OMA-DM bootstrap OID is 2.23.43.7.1).

Returns:

The raw object value if OID has been found, null if not found.

Throws:

java.lang.IllegalArgumentException - if the OID is not correct.

java.lang.UnsupportedOperationException - if this operation is not supported.

decodePath

public PKCS15Provider.Path decodePath(byte[] der)
                               throws java.lang.IllegalArgumentException

Builds a Path object using a DER-encoded (see ITU X.690 for DER-Coding) buffer.

Parameters:

der - the DER-encoded Path object as a byte array.

Returns:

The Path object.

Throws:

java.lang.IllegalArgumentException - if the defined path is not a correctly DER-encoded buffer.