net.sf.mmm.crypto.asymmetric.key

Interface AsymmetricKeyCreator<PR extends PrivateKey,PU extends PublicKey,PAIR extends AsymmetricKeyPair<PR,PU>>

Type Parameters:

PR - type of PrivateKey.

PU - type of PublicKey.

PAIR - type of AsymmetricKeyPair.

All Superinterfaces:

AsymmetricKeyPairFactory<PR,PU,PAIR>, AsymmetricKeyPairFactorySimple<PR,PU,PAIR>, CryptoAlgorithm, KeyCreator, PrivateKeyFactory<PR>, PublicKeyFactory<PU>

All Known Implementing Classes:

AbstractAsymmetricKeyCreator, AsymmetricKeyCreatorImpl, AsymmetricKeyCreatorRsa

public interface AsymmetricKeyCreator<PR extends PrivateKey,PU extends PublicKey,PAIR extends AsymmetricKeyPair<PR,PU>>
extends KeyCreator, AsymmetricKeyPairFactory<PR,PU,PAIR>

Extends KeyCreator for dealing with asymmetric cryptographic keys.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

generateKeyPair(), createPrivateKey(byte[], String), createPublicKey(byte[], String), createKeyPair(byte[], String)

Method Summary

Modifier and Type	Method and Description
default net.sf.mmm.binary.api.Binary	asBinary(PAIR keyPair, String format)
default net.sf.mmm.binary.api.Binary	asBinary(PR privateKey, String format)
default net.sf.mmm.binary.api.Binary	asBinary(PU publicKey, String format)
default byte[]	asData(PAIR keyPair)
byte[]	asData(PAIR keyPair, String format)
default byte[]	asData(PR privateKey)
byte[]	asData(PR privateKey, String format)
default byte[]	asData(PU publicKey)
byte[]	asData(PU publicKey, String format)
default PAIR	createKeyPair(byte[] data)
PAIR	createKeyPair(byte[] data, String format)
default PR	createPrivateKey(byte[] data)
PR	createPrivateKey(byte[] data, String format)
default PU	createPublicKey(byte[] data)
PU	createPublicKey(byte[] data, String format)
PAIR	generateKeyPair()
int	getKeyLength(PR privateKey)
int	getKeyLength(PU publicKey)
default void	verifyKey(PR privateKey) Verify that the given key matches the criteria of this key creator such as key length.
default void	verifyKey(PU publicKey) Verify that the given key matches the criteria of this key creator such as key length.

Methods inherited from interface net.sf.mmm.crypto.key.KeyCreator

getKeyLength

Methods inherited from interface net.sf.mmm.crypto.algorithm.CryptoAlgorithm

getAlgorithm

Methods inherited from interface net.sf.mmm.crypto.asymmetric.key.AsymmetricKeyPairFactory

asBinary

Methods inherited from interface net.sf.mmm.crypto.asymmetric.key.PrivateKeyFactory

asBinary

Methods inherited from interface net.sf.mmm.crypto.asymmetric.key.PublicKeyFactory

asBinary

Methods inherited from interface net.sf.mmm.crypto.asymmetric.key.AsymmetricKeyPairFactorySimple

createKeyPair

Method Detail

generateKeyPair

PAIR generateKeyPair()

Returns:

a new AsymmetricKeyPair with a generated private and public key for the underlying cryptography.

asData

default byte[] asData(PR privateKey)

Specified by:

asData in interface PrivateKeyFactory<PR extends PrivateKey>

Parameters:

privateKey - the PrivateKey to serialize.

Returns:

the serialized binary data.

asBinary

default net.sf.mmm.binary.api.Binary asBinary(PR privateKey,
                                              String format)

Parameters:

privateKey - the PrivateKey to serialize.

format - the the CryptoBinaryFormat to use.

Returns:

the Binary.

asData

byte[] asData(PR privateKey,
              String format)

Parameters:

privateKey - the PrivateKey to serialize.

format - the the CryptoBinaryFormat to use.

Returns:

the binary data.

createPrivateKey

default PR createPrivateKey(byte[] data)

Specified by:

createPrivateKey in interface PrivateKeyFactory<PR extends PrivateKey>

Parameters:

data - the PrivateKey as raw byte array.

Returns:

the deserialized PrivateKey.

createPrivateKey

PR createPrivateKey(byte[] data,
                    String format)

Parameters:

data - the PrivateKey as raw byte array.

format - the CryptoBinaryFormat to use.

Returns:

the deserialized PrivateKey.

asData

default byte[] asData(PU publicKey)

Specified by:

asData in interface PublicKeyFactory<PU extends PublicKey>

Parameters:

publicKey - the PublicKey to serialize.

Returns:

the serialized binary data.

asBinary

default net.sf.mmm.binary.api.Binary asBinary(PU publicKey,
                                              String format)

Parameters:

publicKey - the PublicKey to serialize.

format - the the CryptoBinaryFormat to use.

Returns:

the Binary.

asData

byte[] asData(PU publicKey,
              String format)

Parameters:

publicKey - the PublicKey to serialize.

format - the the CryptoBinaryFormat to use.

Returns:

the binary data.

createPublicKey

default PU createPublicKey(byte[] data)

Specified by:

createPublicKey in interface PublicKeyFactory<PU extends PublicKey>

Parameters:

data - the PublicKey as raw byte array.

Returns:

the deserialized PublicKey.

createPublicKey

PU createPublicKey(byte[] data,
                   String format)

Parameters:

data - the PublicKey as raw byte array.

format - the the CryptoBinaryFormat to use.

Returns:

the deserialized PublicKey.

asData

default byte[] asData(PAIR keyPair)

Specified by:

asData in interface AsymmetricKeyPairFactory<PR extends PrivateKey,PU extends PublicKey,PAIR extends AsymmetricKeyPair<PR,PU>>

Parameters:

keyPair - the AsymmetricKeyPair to serialize.

Returns:

the serialized binary data.

asBinary

default net.sf.mmm.binary.api.Binary asBinary(PAIR keyPair,
                                              String format)

Parameters:

keyPair - the AsymmetricKeyPair to serialize.

format - the the CryptoBinaryFormat to use.

Returns:

the serialized Binary.

asData

byte[] asData(PAIR keyPair,
              String format)

Parameters:

keyPair - the AsymmetricKeyPair to serialize.

format - the the CryptoBinaryFormat to use.

Returns:

the serialized binary data.

createKeyPair

default PAIR createKeyPair(byte[] data)

Specified by:

createKeyPair in interface AsymmetricKeyPairFactory<PR extends PrivateKey,PU extends PublicKey,PAIR extends AsymmetricKeyPair<PR,PU>>

Parameters:

data - the AsymmetricKeyPair in its binary form.

Returns:

the deserialized AsymmetricKeyPair.

createKeyPair

PAIR createKeyPair(byte[] data,
                   String format)

Parameters:

data - the AsymmetricKeyPair as raw byte array.

format - the the CryptoBinaryFormat to use.

Returns:

the deserialized AsymmetricKeyPair.

getKeyLength

int getKeyLength(PR privateKey)

Parameters:

privateKey - the PrivateKey.

Returns:

the key length of the given key in bits.

verifyKey

default void verifyKey(PR privateKey)

Verify that the given key matches the criteria of this key creator such as key length.

Parameters:

privateKey - the PrivateKey to verify.

getKeyLength

int getKeyLength(PU publicKey)

Parameters:

publicKey - the PublicKey.

Returns:

the key length of the given key in bits.

verifyKey

default void verifyKey(PU publicKey)

Verify that the given key matches the criteria of this key creator such as key length.

Parameters:

publicKey - the PublicKey to verify.