org.xipki.security.pkcs11

Class P11Identity

java.lang.Object

org.xipki.security.pkcs11.P11Identity

All Implemented Interfaces:

Comparable<P11Identity>

public abstract class P11Identity
extends Object
implements Comparable<P11Identity>

PKCS#11 identity (private key and the corresponding public key and certificates).

Since:

2.0.0

Author:

Lijun Liao

Field Summary

Fields

Modifier and Type	Field and Description
protected X509Cert[]	certificateChain
protected P11IdentityId	id
protected PublicKey	publicKey
protected P11Slot	slot

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	P11Identity(P11Slot slot, P11IdentityId id, int signatureBitLen)
protected	P11Identity(P11Slot slot, P11IdentityId id, PublicKey publicKey, X509Cert[] certificateChain)

Method Summary

Modifier and Type	Method and Description
X509Cert[]	certificateChain()
int	compareTo(P11Identity obj)
byte[]	digestSecretKey(long mechanism)
protected abstract byte[]	digestSecretKey0(long mechanism)
X509Cert	getCertificate()
P11IdentityId	getId()
PublicKey	getPublicKey()
int	getSignatureKeyBitLength()
boolean	match(P11IdentityId id)
boolean	match(P11SlotIdentifier slotId, String keyLabel)
void	setCertificates(X509Cert[] certificateChain)
byte[]	sign(long mechanism, P11Params parameters, byte[] content)
protected abstract byte[]	sign0(long mechanism, P11Params parameters, byte[] content) Signs the content.
boolean	supportsMechanism(long mechanism, P11Params parameters)

Methods inherited from class java.lang.Object

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

Field Detail

slot

protected final P11Slot slot

id

protected final P11IdentityId id

publicKey

protected final PublicKey publicKey

certificateChain

protected X509Cert[] certificateChain

Constructor Detail

P11Identity

protected P11Identity(P11Slot slot,
                      P11IdentityId id,
                      int signatureBitLen)

P11Identity

protected P11Identity(P11Slot slot,
                      P11IdentityId id,
                      PublicKey publicKey,
                      X509Cert[] certificateChain)

Method Detail

sign

public byte[] sign(long mechanism,
                   P11Params parameters,
                   byte[] content)
            throws P11TokenException

Throws:

P11TokenException

sign0

protected abstract byte[] sign0(long mechanism,
                                P11Params parameters,
                                byte[] content)
                         throws P11TokenException

Signs the content.

Parameters:

mechanism - mechanism to sign the content.

parameters - Parameters. Could be null.

content - Content to be signed. Must not be null.

Returns:

signature.

Throws:

P11TokenException - if PKCS#11 token error occurs.

digestSecretKey

public byte[] digestSecretKey(long mechanism)
                       throws P11TokenException,
                              XiSecurityException

Throws:

P11TokenException

XiSecurityException

digestSecretKey0

protected abstract byte[] digestSecretKey0(long mechanism)
                                    throws P11TokenException

Throws:

P11TokenException

getId

public P11IdentityId getId()

getCertificate

public X509Cert getCertificate()

certificateChain

public X509Cert[] certificateChain()

getPublicKey

public PublicKey getPublicKey()

setCertificates

public void setCertificates(X509Cert[] certificateChain)
                     throws P11TokenException

Throws:

P11TokenException

match

public boolean match(P11IdentityId id)

match

public boolean match(P11SlotIdentifier slotId,
                     String keyLabel)

getSignatureKeyBitLength

public int getSignatureKeyBitLength()

compareTo

public int compareTo(P11Identity obj)

Specified by:

compareTo in interface Comparable<P11Identity>

supportsMechanism

public boolean supportsMechanism(long mechanism,
                                 P11Params parameters)