com.netscape.certsrv.security

Interface ITransportKeyUnit

All Superinterfaces:

IEncryptionUnit, IToken

public interface ITransportKeyUnit
extends IEncryptionUnit

An interface represents the transport key pair. This key pair is used to protected EE's private key in transit.

Version:

$Revision$, $Date$

Method Summary

Modifier and Type	Method and Description
org.mozilla.jss.crypto.X509Certificate	getCertificate() Retrieves public key.
org.mozilla.jss.crypto.X509Certificate	getNewCertificate() Retrieves new transport certificate.
org.mozilla.jss.crypto.PrivateKey	getPrivateKey(org.mozilla.jss.crypto.X509Certificate cert) Retrieves private key associated with certificate
java.lang.String	getSigningAlgorithm() Returns this Unit's signing algorithm in String format.
org.mozilla.jss.crypto.CryptoToken	getToken() Returns this Unit's crypto token object.
void	setSigningAlgorithm(java.lang.String str) Sets this Unit's signing algorithm.
org.mozilla.jss.crypto.SymmetricKey	unwrap_encrypt_sym(byte[] encSymmKey) Unwraps symmetric key for encrypton .
org.mozilla.jss.crypto.SymmetricKey	unwrap_sym(byte[] encSymmKey) Unwraps symmetric key .
org.mozilla.jss.crypto.SymmetricKey	unwrap_sym(byte[] encSymmKey, org.mozilla.jss.crypto.SymmetricKey.Usage usage) Unwraps symmetric key .
org.mozilla.jss.crypto.PrivateKey	unwrap_temp(byte[] wrappedKeyData, java.security.PublicKey pubKey) Unwraps temporary private key .
org.mozilla.jss.crypto.X509Certificate	verifyCertificate(java.lang.String transportCert) Verifies transport certificate.

Methods inherited from interface com.netscape.certsrv.security.IEncryptionUnit

decryptExternalPrivate, decryptExternalPrivate, decryptInternalPrivate, encryptInternalPrivate, getPublicKey, unwrap_symmetric, unwrap, unwrap, unwrap, unwrap, verify, wrap, wrap

Methods inherited from interface com.netscape.certsrv.security.IToken

login, logout

Method Detail

getCertificate

org.mozilla.jss.crypto.X509Certificate getCertificate()

Retrieves public key.

Returns:

certificate

getNewCertificate

org.mozilla.jss.crypto.X509Certificate getNewCertificate()

Retrieves new transport certificate.

Returns:

certificate

verifyCertificate

org.mozilla.jss.crypto.X509Certificate verifyCertificate(java.lang.String transportCert)

Verifies transport certificate.

Returns:

certificate

getPrivateKey

org.mozilla.jss.crypto.PrivateKey getPrivateKey(org.mozilla.jss.crypto.X509Certificate cert)

Retrieves private key associated with certificate

Returns:

certificate

unwrap_sym

org.mozilla.jss.crypto.SymmetricKey unwrap_sym(byte[] encSymmKey,
                                               org.mozilla.jss.crypto.SymmetricKey.Usage usage)

Unwraps symmetric key . This method unwraps the symmetric key.

Specified by:

unwrap_sym in interface IEncryptionUnit

Parameters:

encSymmKey - wrapped symmetric key to be unwrapped

usage - Key usage for unwrapped key.

Returns:

Symmetric key object

unwrap_sym

org.mozilla.jss.crypto.SymmetricKey unwrap_sym(byte[] encSymmKey)

Unwraps symmetric key . This method unwraps the symmetric key.

Parameters:

encSymmKey - wrapped symmetric key to be unwrapped

Returns:

Symmetric key object

unwrap_encrypt_sym

org.mozilla.jss.crypto.SymmetricKey unwrap_encrypt_sym(byte[] encSymmKey)

Unwraps symmetric key for encrypton . This method unwraps the symmetric key.

Parameters:

encSymmKey - wrapped symmetric key to be unwrapped

Returns:

Symmetric key object

unwrap_temp

org.mozilla.jss.crypto.PrivateKey unwrap_temp(byte[] wrappedKeyData,
                                              java.security.PublicKey pubKey)
                                       throws EBaseException

Unwraps temporary private key . This method unwraps the temporary private key.

Parameters:

wrappedKeyData - wrapped private key to be unwrapped

pubKey - public key

Returns:

Private key object

Throws:

EBaseException - failed to unwrap

getToken

org.mozilla.jss.crypto.CryptoToken getToken()

Returns this Unit's crypto token object.

Returns:

CryptoToken object.

getSigningAlgorithm

java.lang.String getSigningAlgorithm()
                              throws EBaseException

Returns this Unit's signing algorithm in String format.

Returns:

String of signing algorithm

Throws:

EBaseException

setSigningAlgorithm

void setSigningAlgorithm(java.lang.String str)
                  throws EBaseException

Sets this Unit's signing algorithm.

Parameters:

str - String of signing algorithm to set.

Throws:

EBaseException