com.casper.sdk.service.signing

Interface KeyPairBuilder

All Known Implementing Classes:

Secp256k1KeyPairBuilder

public interface KeyPairBuilder

Interface implemented by classes that create keys/

Method Summary

Modifier and Type	Method and Description
java.security.PublicKey	createPublicKey(byte[] publicKey) Creates a public key from the provided raw bytes
java.security.KeyPair	generateKeyPair(byte[] seed) Generates a new key pair
Algorithm	getAlgorithm() The algorithm of the signer
byte[]	getPublicKeyRawBytes(java.security.PublicKey publicKey) Obtains the raw bytes from a public key so can be used in casper types
boolean	isSupportedPublicKey(java.security.PublicKey publicKey) Indicates if the provided public key has an algorithm that is supported by this signer
byte[]	signWithPrivateKey(java.security.PrivateKey privateKey, byte[] message) Signs a message using the provided key
boolean	verifySignature(java.security.PublicKey publicKey, byte[] message, byte[] signature) Verifies a signed message

Method Detail

generateKeyPair

java.security.KeyPair generateKeyPair(@Nullable
                                      byte[] seed)

Generates a new key pair

Parameters:

seed - the optional entropy source to be used when generating a key pair

Returns:

a new key pain

getAlgorithm

Algorithm getAlgorithm()

The algorithm of the signer

Returns:

the signers algorithm

isSupportedPublicKey

boolean isSupportedPublicKey(java.security.PublicKey publicKey)

Indicates if the provided public key has an algorithm that is supported by this signer

Parameters:

publicKey - the public key to test

Returns:

true if the provide key is supported by the signer otherwise false

getPublicKeyRawBytes

byte[] getPublicKeyRawBytes(java.security.PublicKey publicKey)

Obtains the raw bytes from a public key so can be used in casper types

Parameters:

publicKey - the public key to obtain the raw bytes from

Returns:

the raw bytes of the provided key

createPublicKey

java.security.PublicKey createPublicKey(byte[] publicKey)

Creates a public key from the provided raw bytes

Parameters:

publicKey - the public key raw bytes

Returns:

a new PublicKet created from the provided bytes

signWithPrivateKey

byte[] signWithPrivateKey(java.security.PrivateKey privateKey,
                          byte[] message)

Signs a message using the provided key

Parameters:

privateKey - the private key to sign with

message - the message to sign

Returns:

the signed message

verifySignature

boolean verifySignature(java.security.PublicKey publicKey,
                        byte[] message,
                        byte[] signature)

Verifies a signed message

Parameters:

publicKey - the public key to verify signature with

message - the message to sign

signature - the signed message

Returns:

true if the signature is valid otherwise false