Package org.xipki.security.pkcs11

Class P11Key

java.lang.Object

org.xipki.security.pkcs11.P11Key

public abstract class P11Key
extends Object

PKCS#11 key.

Since:

2.0.0

Author:

Lijun Liao (xipki)

Field Summary

Fields

Modifier and Type	Field	Description
protected org.xipki.pkcs11.wrapper.PKCS11KeyId	keyId
protected P11Slot	slot

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	P11Key(P11Slot slot, org.xipki.pkcs11.wrapper.PKCS11KeyId keyId)

Method Summary

Modifier and Type	Method	Description
abstract void	destroy()
byte[]	digestSecretKey(long mechanism)
protected abstract byte[]	digestSecretKey0(long mechanism)
BigInteger	getDsaG()
BigInteger	getDsaP()
BigInteger	getDsaQ()
Integer	getEcOrderBitSize()
org.bouncycastle.asn1.ASN1ObjectIdentifier	getEcParams()
org.xipki.pkcs11.wrapper.PKCS11KeyId	getKeyId()
long	getKeyType()
PublicKey	getPublicKey()
BigInteger	getRsaModulus()
BigInteger	getRsaPublicExponent()
P11SlotId	getSlotId()
boolean	isSecretKey()
void	setDsaParameters(BigInteger p, BigInteger q, BigInteger g)
void	setEcParams(org.bouncycastle.asn1.ASN1ObjectIdentifier ecParams)
void	setRsaMParameters(BigInteger modulus, BigInteger publicExponent)
byte[]	sign(long mechanism, P11Params parameters, byte[] content)
P11Key	sign(Boolean sign)
protected abstract byte[]	sign0(long mechanism, P11Params parameters, byte[] content)	Signs the content.
boolean	supportsDigest(long mechanism)
boolean	supportsSign(long mechanism)

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

keyId

protected final org.xipki.pkcs11.wrapper.PKCS11KeyId keyId

Constructor Detail

P11Key

protected P11Key(P11Slot slot,
                 org.xipki.pkcs11.wrapper.PKCS11KeyId keyId)

Method Detail

sign

public P11Key sign(Boolean sign)

destroy

public abstract void destroy()
                      throws org.xipki.pkcs11.wrapper.TokenException

Throws:

org.xipki.pkcs11.wrapper.TokenException

getEcParams

public org.bouncycastle.asn1.ASN1ObjectIdentifier getEcParams()

getEcOrderBitSize

public Integer getEcOrderBitSize()

setEcParams

public void setEcParams(org.bouncycastle.asn1.ASN1ObjectIdentifier ecParams)

getRsaModulus

public BigInteger getRsaModulus()

getRsaPublicExponent

public BigInteger getRsaPublicExponent()

setRsaMParameters

public void setRsaMParameters(BigInteger modulus,
                              BigInteger publicExponent)

getDsaP

public BigInteger getDsaP()

getDsaQ

public BigInteger getDsaQ()

getDsaG

public BigInteger getDsaG()

setDsaParameters

public void setDsaParameters(BigInteger p,
                             BigInteger q,
                             BigInteger g)

sign

public byte[] sign(long mechanism,
                   P11Params parameters,
                   byte[] content)
            throws org.xipki.pkcs11.wrapper.TokenException

Throws:

org.xipki.pkcs11.wrapper.TokenException

supportsSign

public boolean supportsSign(long mechanism)

sign0

protected abstract byte[] sign0(long mechanism,
                                P11Params parameters,
                                byte[] content)
                         throws org.xipki.pkcs11.wrapper.TokenException

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:

org.xipki.pkcs11.wrapper.TokenException - if PKCS#11 token error occurs.

digestSecretKey

public byte[] digestSecretKey(long mechanism)
                       throws org.xipki.pkcs11.wrapper.TokenException,
                              XiSecurityException

Throws:

org.xipki.pkcs11.wrapper.TokenException

XiSecurityException

supportsDigest

public boolean supportsDigest(long mechanism)
                       throws org.xipki.pkcs11.wrapper.TokenException,
                              XiSecurityException

Throws:

org.xipki.pkcs11.wrapper.TokenException

XiSecurityException

digestSecretKey0

protected abstract byte[] digestSecretKey0(long mechanism)
                                    throws org.xipki.pkcs11.wrapper.TokenException

Throws:

org.xipki.pkcs11.wrapper.TokenException

getSlotId

public P11SlotId getSlotId()

getKeyId

public org.xipki.pkcs11.wrapper.PKCS11KeyId getKeyId()

getKeyType

public long getKeyType()

isSecretKey

public boolean isSecretKey()

getPublicKey

public final PublicKey getPublicKey()