org.lightningj.paywall.keymgmt

Class KeySerializationHelper

java.lang.Object

org.lightningj.paywall.keymgmt.KeySerializationHelper

public class KeySerializationHelper
extends java.lang.Object

Class in charge of serializing a secret key. Created by Philip Vendil on 2018-09-16.

Constructor Summary

Constructors

Constructor and Description
KeySerializationHelper()

Method Summary

Modifier and Type	Method and Description
static java.security.KeyPair	deserializeAsymKeyPair(byte[] publicKeyData, byte[] privateKeyData, char[] protectPassphrase, java.security.KeyFactory keyFactory) Method to deserialize an asymmetric key data into a key pair.
static java.security.KeyPair	deserializeBTCPayServerKeyPair(byte[] privateKeyData, char[] protectPassphrase, java.security.KeyFactory keyFactory, java.lang.String eCCurveName) Method to deserialize an BTC Pay Server key data into a key pair.
static java.security.PublicKey	deserializePublicKey(byte[] publicKeyData, java.security.KeyFactory keyFactory) Help method to decode a public key data only.
static java.security.Key	deserializeSecretKey(byte[] data, char[] protectPassphrase) Method to deserialize key data of a secret key.
static java.lang.String	genKeyId(byte[] keyData) Help method to generate a keyId of a specific key used to identify it.
static byte[][]	serializeAsymKeyPair(java.security.KeyPair keyPair, char[] protectPassphrase) Method to serialize an asymmetric key pair to key data.
static byte[][]	serializeBTCPayServerKeyPair(java.security.KeyPair keyPair, char[] protectPassphrase) Method to serialize an btc pay server access token key pair to key data.
static byte[]	serializeSecretKey(java.security.Key key, char[] protectPasshrase) Method to serialize a secret key to key data.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeySerializationHelper

public KeySerializationHelper()

Method Detail

serializeSecretKey

public static byte[] serializeSecretKey(java.security.Key key,
                                        char[] protectPasshrase)
                                 throws InternalErrorException

Method to serialize a secret key to key data. Deserialization should be done with deserializeSecretKey.

Parameters:

key - the secret key to serialize, never null.

protectPasshrase - the password protecting the key.

Returns:

serialized byte array with header and data.

Throws:

InternalErrorException - if internal problems occurred serializing the key.

deserializeSecretKey

public static java.security.Key deserializeSecretKey(byte[] data,
                                                     char[] protectPassphrase)
                                              throws InternalErrorException

Method to deserialize key data of a secret key.

Parameters:

data - the serialized key data.

protectPassphrase - the password protecting the key.

Returns:

the raw key data

Throws:

InternalErrorException - if problems occurred deserializing the secret key.

serializeAsymKeyPair

public static byte[][] serializeAsymKeyPair(java.security.KeyPair keyPair,
                                            char[] protectPassphrase)
                                     throws InternalErrorException

Method to serialize an asymmetric key pair to key data. Deserialization should be done with deserializeAsymKeyPair.

Parameters:

keyPair - the key pair to serialize, never null.

protectPassphrase - the password used to protect the private key.

Returns:

an array of serialized byte array with header and data with size 2 and public is at index 0 and private at index 1.

Throws:

InternalErrorException - if internal problems occurred serializing the keys.

serializeBTCPayServerKeyPair

public static byte[][] serializeBTCPayServerKeyPair(java.security.KeyPair keyPair,
                                                    char[] protectPassphrase)
                                             throws InternalErrorException

Method to serialize an btc pay server access token key pair to key data. Deserialization should be done with deserializeBTCPayServerKeyPair. The files saved is a Encrypted PEM file for the private key and the public key stored as a hexadecimal string.

Parameters:

keyPair - the key pair to serialize, never null.

protectPassphrase - the password used to protect the private key.

Returns:

an array of serialized byte array with header and data with size 2 and public is at index 0 and private at index 1.

Throws:

InternalErrorException - if internal problems occurred serializing the keys.

deserializeAsymKeyPair

public static java.security.KeyPair deserializeAsymKeyPair(byte[] publicKeyData,
                                                           byte[] privateKeyData,
                                                           char[] protectPassphrase,
                                                           java.security.KeyFactory keyFactory)
                                                    throws InternalErrorException

Method to deserialize an asymmetric key data into a key pair.

Parameters:

publicKeyData - the serialized public key data, never null.

privateKeyData - the serialized private key data, never null.

protectPassphrase - the password protecting the key.

keyFactory - the keyFactory to reconstruct the keys with.

Returns:

a reconstructed key pair.

Throws:

InternalErrorException - if internal problems occurred deserializing the keys.

deserializeBTCPayServerKeyPair

public static java.security.KeyPair deserializeBTCPayServerKeyPair(byte[] privateKeyData,
                                                                   char[] protectPassphrase,
                                                                   java.security.KeyFactory keyFactory,
                                                                   java.lang.String eCCurveName)
                                                            throws InternalErrorException

Method to deserialize an BTC Pay Server key data into a key pair. The method only parses the private key and generates the public key from it automatically.

Parameters:

privateKeyData - the serialized private key data, never null.

protectPassphrase - the password protecting the key.

keyFactory - the keyFactory to reconstruct the keys with.

eCCurveName - the name of used ec curve.

Returns:

a reconstructed key pair.

Throws:

InternalErrorException - if internal problems occurred deserializing the keys.

deserializePublicKey

public static java.security.PublicKey deserializePublicKey(byte[] publicKeyData,
                                                           java.security.KeyFactory keyFactory)
                                                    throws InternalErrorException

Help method to decode a public key data only.

Parameters:

publicKeyData - the public key data to parse.

keyFactory - the keyFactory to reconstruct the keys with.

Returns:

a reconstructed public key.

Throws:

InternalErrorException - if internal problems occurred deserializing the keys.

genKeyId

public static java.lang.String genKeyId(byte[] keyData)
                                 throws InternalErrorException

Help method to generate a keyId of a specific key used to identify it. The key id is the first 16 bytes of a sha256 hash of the key data.

Parameters:

keyData - the keyData.

Returns:

the generated key id

Throws:

InternalErrorException - if internal error occurred generating the digest of the keyData.