com.entrust.toolkit.credentials

Class KeychainContainerName.V2ContainerId

java.lang.Object

com.entrust.toolkit.credentials.ContainerName

com.entrust.toolkit.credentials.KeychainContainerName

com.entrust.toolkit.credentials.KeychainContainerName.V2ContainerId

Enclosing class:

KeychainContainerName

public static final class KeychainContainerName.V2ContainerId
extends KeychainContainerName

This class represents container names in the format used for V2 digital IDs, that is, IDs created by Security Manager version 7.0 and above.

The format is as follows:

     Format ID | Type ID | Subtype ID | Key ID | Entrust ID
 

Each component is defined as follows:

Format ID

This one-digit value denotes which Entrust application enrolled the user. Possible values are:
4 - Container was created by Entelligence Security Provider or TruePass, where the value pki70Client=true.

Type ID

The Type ID is the Certificate Type Identifier (CTI). Each certificate type defined in Security Manager 7.x and later has a unique identifier. If the Type ID in a container is 0, this denotes that the type ID is unknown.

Subtype ID

The Subtype ID is the Certificate Definition Identifier (CDI). Each certificate definition defined in Security Manager 7.x or later has a unique identifier. If the subtype ID is 0, this denotes that the type ID is unknown.

Key ID

This value is an incrementing number (starting at 0). It denotes the position of that key pair in the stream. A container created during enrollment has a key ID of 0, but when a new key pair is created during the first key update, the key ID of that container is 1.

Entrust ID

This value is a randomly generated GUID with the dashes removed. It is 1 or more characters long (although it is commonly 32 or 24 characters in length, depending on the encoding that was used). All of an Entrust digital ID's key containers have the same Entrust ID. When the Entrust digital ID is recovered, a new Entrust ID is generated.

Two such containers are considered to belong to the same identity if they have the same Entrust ID.

Nested Class Summary

Nested classes/interfaces inherited from class com.entrust.toolkit.credentials.KeychainContainerName

KeychainContainerName.V1ContainerId, KeychainContainerName.V2ContainerId

Method Summary

Modifier and Type	Method and Description
boolean	belongsToSameIdentity(ContainerName compareTo) Returns whether or not this container and the given container belong to the same identity.
java.lang.String	getEntrustId() Gets the 'Entrust ID' key container name component; this is a unique identifier for the digital identity that the key in this key container belongs to.
int	getKeyId() Gets the 'Key ID' key container name component; this is the stream index for the key in this key container.
int	getSubtypeId() Gets the 'Subtype ID' key container name component; this identifies the certificate definition associated with the key in this key container.
int	getTypeId() Gets the 'Type ID' key container name component; this identifies the certificate type associated with the key in this key container.

Methods inherited from class com.entrust.toolkit.credentials.KeychainContainerName

getContainerName

Methods inherited from class java.lang.Object

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

Method Detail

belongsToSameIdentity

public boolean belongsToSameIdentity(ContainerName compareTo)

Description copied from class: ContainerName

Returns whether or not this container and the given container belong to the same identity.

Specified by:

belongsToSameIdentity in class ContainerName

Parameters:

compareTo - the container name to check

Returns:

true if this container belongs to the same identity as the given container, false otherwise.

getTypeId

public int getTypeId()

Gets the 'Type ID' key container name component; this identifies the certificate type associated with the key in this key container.

Returns:

the 'Type ID'

Since:

9.0

getSubtypeId

public int getSubtypeId()

Gets the 'Subtype ID' key container name component; this identifies the certificate definition associated with the key in this key container.

Returns:

the 'Subtype ID'

Since:

9.0

getKeyId

public int getKeyId()

Gets the 'Key ID' key container name component; this is the stream index for the key in this key container.

Returns:

the 'Key ID'

Since:

9.0

getEntrustId

public java.lang.String getEntrustId()

Gets the 'Entrust ID' key container name component; this is a unique identifier for the digital identity that the key in this key container belongs to.

Returns:

the 'Entrust ID'

Since:

9.0