getPlatformIdentifiers

Retrieves and returns the platform identifiers from the security module of the specified platform class accessible using the supplied access parameters for that class of security module.

This method is strictly client-side with no server dependencies. All client plug-ins that support the getPlatformIdentifier script are queried in sequence until one recognizes the inserted device. At that point, the plug-in returns a set of platform identifiers (IDs) that are used for security module identifications.

The SecurityModuleManager.identitySecurityModule call uses returned platform IDs as input, and ActivID CMS supports the following platform IDs:

  • ActivID CMS 5.0 and later releases support:

  • securitymodule.smartcard.SMOTYPE

  • securitymodule.smartcard.SMOID

This method is one of a pair of methods that support the identification of a security module:

  • platformIds

  • SyncManager.getPlatformIds(platformClass, accessParams)

  • smold

  • SecurityModuleManager.identifySecurityModule(platformClass, platformIds)

The platform ID value this method returns will be one of the following:

  • PLATFORM_ID_SMARTCARD_SMOID (encoded using UTF-8/hex; 8-bit Unicode Transformation Format/hexadecimal)

  • PLATFORM_ID_SMARTCARD_SMOTYPE (encoded using UTF-8/hex)

  • PLATFORM_ID_SMARTCARD_LABEL (encoded using UTF-8/hex)

For Java:

Copy 
Parameter[] getPlatformIdentifiers(String platformClass, Parameter[] accessParameters)
throws ManagementException, LocalizedRemoteException;

For C++:

Copy 
ParameterVector *getPlatformIdentifiers( TString platformClass, ParameterVector
*accessParams)

Parameters:

  • platformClass—Class of the security module platform (smart card, TPM, or USB). The supported option is:

  • securitymodule.smartcard

  • accessParameters—Parameters required to retrieve platform identifiers of this type or access the security module. The supported option is:

  • securitymodule.smartcard platform class

  • readerName—Indicates the name of the reader in which the security module is inserted (one of the readers returned by the getReaderList method).

Returns:

List of platform-specific security module identification name/value pairs.

Exceptions:

  • ManagementException— if an internal failure occurs.

  • LocalizedRemoteException— (thrown by the Web service layer) only when the most severe, unexpected, SOAP-level failures occur.

Usage:

Typically, the usage is:

  • platformIds = SyncManager.getPlatformIdentifiers(platformClass, accessParams)

  • smoId = SecurityModuleManager.identifySecurityModule(platformClass, platformIds)

where:

  • platformClass represents the major class of security module platform

  • platformIds represents an array of platform-specific platform identifiers; for example:

  • PLATFORM_ID_SMARTCARD_SMOID

  • PLATFORM_ID_SMARTCARD_SMOTYPE

  • PLATFORM_ID_SMARTCARD_LABEL (the latter identifier is optional, and all three identifiers are encoded in UTF-8)

  • smoId is the resulting completed SecurityModuleId that can now be used with the various Managers.