Package org.forgerock.openig.secrets

Class Base64EncodedSecretStore

  • All Implemented Interfaces:
    SecretStore<GenericSecret>
    public class Base64EncodedSecretStore
extends Object
implements SecretStore<GenericSecret>
    A Base64EncodedSecretStore stores secret values (such as password or simple shared secrets) in a base64-encoded form in memory.

    It only stores GenericSecret and all returned secrets have "infinite" expiry time.

    This class is NOT suitable for safely storing secret values in PRODUCTION systems. 

     {
       "type": "Base64EncodedSecretStore",
       "config": {
         "secrets": {
             "<secret-id>": string
         }
       }
    }

    Example: 

     {
       "type": "Base64EncodedSecretStore",
       "config": {
         "secrets": {
             "agent.password": "d2VsY29tZQ==",
             "crypto.header.key": "Y2hhbmdlaXQ="
         }
       }
    }

    • Method Detail

      • getStoredType

        public Class<GenericSecret> getStoredType()
        Description copied from interface: SecretStore
        The top-level class that this store is capable of storing. This is a reification of the type parameter and can be used to lookup stores for a given type.
        Specified by:
        getStoredType in interface SecretStore<GenericSecret>
        Returns:
        the top-most type that this store is capable of storing, typically either CryptoKey for key-stores, GenericSecret for password stores, or Secret if the store is capable of storing any type of secret.

      • getValid

        public <S extends GenericSecret> Promise<Stream<S>,​NeverThrowsException> getValid​(Purpose<S> purpose)
        Description copied from interface: SecretStore
        Returns all valid secrets for the given purpose from this store.
        Specified by:
        getValid in interface SecretStore<GenericSecret>
        Type Parameters:
        S - the type of secret.
        Parameters:
        purpose - the purpose.
        Returns:
        a stream of all valid secrets of the given type from this store, or an empty stream if none exist.

      • refresh

        public void refresh()
        Description copied from interface: SecretStore
        Indicates that the store should refresh its secrets from the backing storage mechanism. This can be used to cause reload of a store after a secret rotation if the backend does not automatically detect such changes. Refresh may be an asynchronous operation and no guarantees are made about when clients of this secret store may see updated secrets after a call to refresh.
        Specified by:
        refresh in interface SecretStore<GenericSecret>