io.nem.symbol.core.crypto

Class KeyPair

java.lang.Object

io.nem.symbol.core.crypto.KeyPair

public class KeyPair
extends java.lang.Object

It represents an asymmetric private/public encryption key. Public key is always present. Private key may not be present. If the private key is not preset, the key cannot be used to decrypt values.

Method Summary

Modifier and Type	Method and Description
static KeyPair	fromPrivate(PrivateKey privateKey) Creates a key pair around a private key using the default engine.
static KeyPair	fromPrivate(PrivateKey privateKey, CryptoEngine engine) Creates a key pair around a private key.
PrivateKey	getPrivateKey() Gets the private key.
PublicKey	getPublicKey() Gets the public key.
boolean	hasPrivateKey() Determines if the current key pair has a private key.
static KeyPair	onlyPublic(PublicKey publicKey) Creates a pair that only holds a public key using the default engine.
static KeyPair	onlyPublic(PublicKey publicKey, CryptoEngine engine) Creates a pair that only holds a public key.
static KeyPair	random() Creates a random key pair using the default engine.
static KeyPair	random(CryptoEngine engine) Creates a random key pair using the provided engine.

Methods inherited from class java.lang.Object

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

Method Detail

random

public static KeyPair random()

Creates a random key pair using the default engine.

Returns:

a KeyPair with both public and private keys.

random

public static KeyPair random(CryptoEngine engine)

Creates a random key pair using the provided engine.

Parameters:

engine - the engine.

Returns:

a KeyPair with both public and private keys.

fromPrivate

public static KeyPair fromPrivate(PrivateKey privateKey,
                                  CryptoEngine engine)

Creates a key pair around a private key. The public key is calculated from the private key.

Parameters:

privateKey - The private key.

engine - the engine.

Returns:

a KeyPair with both public and private keys.

onlyPublic

public static KeyPair onlyPublic(PublicKey publicKey)

Creates a pair that only holds a public key using the default engine. It is good to encrypt but cannot decrypt values.

Parameters:

publicKey - The public key.

Returns:

a KeyPair with just the public key.

onlyPublic

public static KeyPair onlyPublic(PublicKey publicKey,
                                 CryptoEngine engine)

Creates a pair that only holds a public key. It is good to encrypt but cannot decrypt values.

Parameters:

publicKey - The public key.

engine - the engine.

Returns:

a KeyPair with just the public key.

fromPrivate

public static KeyPair fromPrivate(PrivateKey privateKey)

Creates a key pair around a private key using the default engine. The public key is calculated from the private key.

Parameters:

privateKey - The private key.

Returns:

a KeyPair with both public and private keys.

getPrivateKey

public PrivateKey getPrivateKey()

Gets the private key.

Returns:

The private key raising an IllegalStateException if the private key hasn't been set.

getPublicKey

public PublicKey getPublicKey()

Gets the public key.

Returns:

the public key. Never null.

hasPrivateKey

public boolean hasPrivateKey()

Determines if the current key pair has a private key.

Returns:

true if the current key pair has a private key.