net.rim.device.api.crypto
Interface PrivateKey

All Superinterfaces:

Key, Persistable

All Known Implementing Classes:

DHPrivateKey, DSAPrivateKey, ECPrivateKey, KEAPrivateKey, RSAPrivateKey

public interface PrivateKey
extends Key

PrivateKey represents the idea of a private key, which is a key intended to be secret, and has an associated public key intended to be publically disclosed. The private key normally performs operations such as decryption and signing, whereas the public key performs operations such as encryption and verification.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

Method Summary
	CryptoSystem	getCryptoSystem() Returns the CryptoSystem used by this private key.
	void	verify() Performs certain integrity checks on the private key parameters.

Methods inherited from interface net.rim.device.api.crypto.Key

getAlgorithm

Method Detail

getCryptoSystem

CryptoSystem getCryptoSystem()

Returns the CryptoSystem used by this private key.

Returns:

The crypto system.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

verify

void verify()
            throws InvalidKeyException,
                   InvalidCryptoSystemException,
                   CryptoTokenException,
                   CryptoUnsupportedOperationException

Performs certain integrity checks on the private key parameters. These checks are useful to prevent certain types of attacks that involve modifying the parameters and then using a signed message to calculate the real private key parameters.

Throws:

InvalidKeyException - Thrown if the specified key is improperly formatted or invalid.

InvalidCryptoSystemException - Thrown if the specified crypto system is invalid.

CryptoTokenException - Thrown if an error occurs with the crypto token or the crypto token is invalid.

CryptoUnsupportedOperationException - Thrown if a call is made to an unsupported operation.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0