org.lightningj.paywall.keymgmt

Class DefaultFileKeyManager

java.lang.Object

org.lightningj.paywall.keymgmt.FileKeyManager

org.lightningj.paywall.keymgmt.DefaultFileKeyManager

All Implemented Interfaces:

AsymmetricKeyManager, KeyManager, SymmetricKeyManager

Direct Known Subclasses:

SpringDefaultFileKeyManager

public abstract class DefaultFileKeyManager
extends FileKeyManager
implements AsymmetricKeyManager, SymmetricKeyManager

Asymmetric and Symmetric File Key Manager using a RSA 2048 but key stored on disk on a specified location. Created by Philip Vendil on 2018-09-17.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	BTCPAY_SERVER_PRIVATE_KEYNAME
protected static java.lang.String	BTCPAY_SERVER_PUBLIC_KEYNAME
protected BTCPayServerHelper	btcPayServerHelper
protected java.time.Clock	clock
protected java.security.Key	secretKey
protected static java.lang.String	SYMMENTRIC_FILENAME

Fields inherited from class org.lightningj.paywall.keymgmt.FileKeyManager

log

Constructor Summary

Constructors

Constructor and Description
DefaultFileKeyManager()

Method Summary

Modifier and Type	Method and Description
protected java.security.Key	generateAndStoreSymmetricKey(java.io.File keyFile, char[] protectPassphrase)
protected java.io.File	genPublicBTCPayServerFile(java.lang.String sIN) Method to return the BTC Pay Server public file name with sIN value filename.
protected java.security.KeyPair	getAsymKeyPair() Help method to parse existing keys or generate new ones if not exists.
protected abstract java.lang.String	getAsymTrustStorePath() Returns the path of directory where trusted public key files are stored.
protected java.security.KeyPair	getBTCPayServerKeyPair() Help method to parse existing keys for BTCPayServer or generate new ones if not exists.
protected java.security.KeyFactory	getECKeyFactory()
java.security.PrivateKey	getPrivateKey(Context context) Returns the private key that should be used for asymmetric operations for the given context.
java.security.PublicKey	getPublicKey(Context context) Returns the public key that should be used for asymmetric operations for the given context.
protected java.security.KeyFactory	getRSAKeyFactory()
java.security.Key	getSymmetricKey(Context context) Returns the key that should be used for symmetric operations for the given context.
protected java.io.File	getSymmetricKeyFile()
java.util.Map<java.lang.String,java.security.PublicKey>	getTrustedKeys(Context context) Method retrieve a list of trusted public keys used to verify signatures.
protected java.security.Key	parseSymmetricKeyFile(java.io.File keyFile, char[] protectPassphrase)

Methods inherited from class org.lightningj.paywall.keymgmt.FileKeyManager

getDirectory, getDirectory, getKeyStorePath, getProtectPassphrase, getProtectPassphraseWithDefault, getProvider

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lightningj.paywall.keymgmt.KeyManager

getProvider

Field Detail

BTCPAY_SERVER_PRIVATE_KEYNAME

protected static final java.lang.String BTCPAY_SERVER_PRIVATE_KEYNAME

See Also:

Constant Field Values

BTCPAY_SERVER_PUBLIC_KEYNAME

protected static final java.lang.String BTCPAY_SERVER_PUBLIC_KEYNAME

See Also:

Constant Field Values

SYMMENTRIC_FILENAME

protected static final java.lang.String SYMMENTRIC_FILENAME

See Also:

Constant Field Values

secretKey

protected java.security.Key secretKey

clock

protected java.time.Clock clock

btcPayServerHelper

protected BTCPayServerHelper btcPayServerHelper

Constructor Detail

DefaultFileKeyManager

public DefaultFileKeyManager()

Method Detail

getPublicKey

public java.security.PublicKey getPublicKey(Context context)
                                     throws java.lang.UnsupportedOperationException,
                                            InternalErrorException

Returns the public key that should be used for asymmetric operations for the given context.

Specified by:

getPublicKey in interface AsymmetricKeyManager

Parameters:

context - related context.

Returns:

related public key.

Throws:

java.lang.UnsupportedOperationException - if operation in combination with given context isn't supported.

InternalErrorException - if internal error occurred parsing/generating public key.

getPrivateKey

public java.security.PrivateKey getPrivateKey(Context context)
                                       throws java.lang.UnsupportedOperationException,
                                              InternalErrorException

Returns the private key that should be used for asymmetric operations for the given context.

Specified by:

getPrivateKey in interface AsymmetricKeyManager

Parameters:

context - related context.

Returns:

related private key.

Throws:

java.lang.UnsupportedOperationException - if operation in combination with given context isn't supported.

InternalErrorException - if internal error occurred parsing/generating private key.

getTrustedKeys

public java.util.Map<java.lang.String,java.security.PublicKey> getTrustedKeys(Context context)
                                                                       throws java.lang.UnsupportedOperationException,
                                                                              InternalErrorException

Method retrieve a list of trusted public keys used to verify signatures.

Specified by:

getTrustedKeys in interface AsymmetricKeyManager

Parameters:

context - related context.

Returns:

A map of keyId of trusted public keys.

Throws:

java.lang.UnsupportedOperationException - if operation in combination with given context isn't supported.

InternalErrorException - if internal error occurred retrieving the public keys.

getSymmetricKey

public java.security.Key getSymmetricKey(Context context)
                                  throws java.lang.UnsupportedOperationException,
                                         InternalErrorException

Returns the key that should be used for symmetric operations for the given context.

Specified by:

getSymmetricKey in interface SymmetricKeyManager

Parameters:

context - related context. Same key is used for all contexts.

Returns:

related key.

Throws:

java.lang.UnsupportedOperationException - if operation in combination with given context isn't supported.

InternalErrorException - if internal error occurred retrieving the key.

getAsymTrustStorePath

protected abstract java.lang.String getAsymTrustStorePath()
                                                   throws InternalErrorException

Returns the path of directory where trusted public key files are stored.

Returns:

the path to the directory where trusted public key store files are stored. Or null if not configured.

Throws:

InternalErrorException - if internal error occurred retrieving the trust store path.

getAsymKeyPair

protected java.security.KeyPair getAsymKeyPair()
                                        throws InternalErrorException

Help method to parse existing keys or generate new ones if not exists.

Returns:

the related asymmetric key pair.

Throws:

InternalErrorException - if problems occurred reading the keys from file.

getBTCPayServerKeyPair

protected java.security.KeyPair getBTCPayServerKeyPair()
                                                throws InternalErrorException

Help method to parse existing keys for BTCPayServer or generate new ones if not exists.

Returns:

the related btc pay server key pair.

Throws:

InternalErrorException - if problems occurred reading the keys from file.

getRSAKeyFactory

protected java.security.KeyFactory getRSAKeyFactory()
                                             throws InternalErrorException

Throws:

InternalErrorException

getECKeyFactory

protected java.security.KeyFactory getECKeyFactory()
                                            throws InternalErrorException

Throws:

InternalErrorException

getSymmetricKeyFile

protected java.io.File getSymmetricKeyFile()
                                    throws InternalErrorException

Throws:

InternalErrorException

parseSymmetricKeyFile

protected java.security.Key parseSymmetricKeyFile(java.io.File keyFile,
                                                  char[] protectPassphrase)
                                           throws InternalErrorException

Throws:

InternalErrorException

generateAndStoreSymmetricKey

protected java.security.Key generateAndStoreSymmetricKey(java.io.File keyFile,
                                                         char[] protectPassphrase)
                                                  throws InternalErrorException

Throws:

InternalErrorException

genPublicBTCPayServerFile

protected java.io.File genPublicBTCPayServerFile(java.lang.String sIN)
                                          throws InternalErrorException

Method to return the BTC Pay Server public file name with sIN value filename.

Parameters:

sIN - the related sIN value

Returns:

the file name for related value

Throws:

InternalErrorException - if problems occurred looking up the file name.