Package com.netflix.spinnaker.kork.secrets.engines

Class AbstractStorageSecretEngine

java.lang.Object

com.netflix.spinnaker.kork.secrets.engines.AbstractStorageSecretEngine

All Implemented Interfaces:

SecretEngine

public abstract class AbstractStorageSecretEngine
extends java.lang.Object
implements SecretEngine

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>	cache
protected static java.lang.String	STORAGE_BUCKET
protected static java.lang.String	STORAGE_FILE_URI
protected static java.lang.String	STORAGE_PROP_KEY
protected static java.lang.String	STORAGE_REGION

Constructor Summary

Constructors

Constructor	Description
AbstractStorageSecretEngine()

Method Summary

Modifier and Type	Method	Description
void	clearCache()
byte[]	decrypt(EncryptedSecret encryptedSecret)
protected abstract java.io.InputStream	downloadRemoteFile(EncryptedSecret encryptedSecret)
EncryptedSecret	encrypt(java.lang.String secretToEncrypt)
protected byte[]	getParsedValue(java.lang.String fileURI, java.lang.String yamlPath)
protected void	parseAsYaml(java.lang.String fileURI, java.io.InputStream inputStream)
protected byte[]	readAll(java.io.InputStream inputStream)
void	validate(EncryptedSecret encryptedSecret)	In order for a secretEngine to decrypt an EncryptedSecret, it may require extra information (e.g.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.netflix.spinnaker.kork.secrets.SecretEngine

identifier

Field Detail

STORAGE_BUCKET

protected static final java.lang.String STORAGE_BUCKET

See Also:

Constant Field Values

STORAGE_REGION

protected static final java.lang.String STORAGE_REGION

See Also:

Constant Field Values

STORAGE_FILE_URI

protected static final java.lang.String STORAGE_FILE_URI

See Also:

Constant Field Values

STORAGE_PROP_KEY

protected static final java.lang.String STORAGE_PROP_KEY

See Also:

Constant Field Values

cache

protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> cache

Constructor Detail

AbstractStorageSecretEngine

public AbstractStorageSecretEngine()

Method Detail

decrypt

public byte[] decrypt(EncryptedSecret encryptedSecret)

Specified by:

decrypt in interface SecretEngine

validate

public void validate(EncryptedSecret encryptedSecret)
              throws InvalidSecretFormatException

Description copied from interface: SecretEngine

In order for a secretEngine to decrypt an EncryptedSecret, it may require extra information (e.g. decryptionKey, location, encryptionMethod, etc). This method takes an EncryptedSecret and validates it contains the required information the service needs for decryption. Parameter names should not contain ':'

Specified by:

validate in interface SecretEngine

Parameters:

encryptedSecret - The encrypted secret

Throws:

InvalidSecretFormatException - If the encrypted secret is malformed

encrypt

public EncryptedSecret encrypt(java.lang.String secretToEncrypt)
                        throws java.lang.UnsupportedOperationException

Specified by:

encrypt in interface SecretEngine

Throws:

java.lang.UnsupportedOperationException

downloadRemoteFile

protected abstract java.io.InputStream downloadRemoteFile(EncryptedSecret encryptedSecret)
                                                   throws java.io.IOException

Throws:

java.io.IOException

readAll

protected byte[] readAll(java.io.InputStream inputStream)
                  throws java.io.IOException

Throws:

java.io.IOException

parseAsYaml

protected void parseAsYaml(java.lang.String fileURI,
                           java.io.InputStream inputStream)

getParsedValue

protected byte[] getParsedValue(java.lang.String fileURI,
                                java.lang.String yamlPath)
                         throws SecretDecryptionException

Throws:

SecretDecryptionException

clearCache

public void clearCache()

Specified by:

clearCache in interface SecretEngine