MpEncryptionFilter (Helidon Project 2.6.13 API)

java.lang.Object
- io.helidon.config.encryption.MpEncryptionFilter

All Implemented Interfaces:

MpConfigFilter
```
public final class MpEncryptionFilter
extends Object
implements MpConfigFilter
```
Provides possibility to decrypt passwords from configuration sources. Configuration can be used to enforce encryption (e.g. we will fail on clear-text value).
Password in properties must be stored as follows:
- ${AES=base64} - encrypted password using a master password (must be provided to prime through configuration, system property or environment variable)
- ${RSA=base64} - encrypted password using a public key (private key must be available to Prime instance, its location must be provided to prime through configuration, system property or environment variable)
- ${ALIAS=alias_name} - no longer needed, please use ${alias_name}
- ${CLEAR=text} - clear-text password. Intentionally denoting this value as a protectable one, so we can enforce encryption (e.g. in prod)
Example:
```
 google_client_secret=${AES=mYRkg+4Q4hua1kvpCCI2hg==}
 service_password=${RSA=mYRkg+4Q4hua1kvpCCI2hg==}
 another_password=${service_password}
 cleartext_password=${CLEAR=known_password}
 
```
See Also:

ConfigProperties.PRIVATE_KEYSTORE_PATH_ENV_VARIABLE, ConfigProperties.MASTER_PASSWORD_ENV_VARIABLE, ConfigProperties.MASTER_PASSWORD_CONFIG_KEY, ConfigProperties.REQUIRE_ENCRYPTION_ENV_VARIABLE

Constructor Summary

Constructors
Constructor Description

MpEncryptionFilter()
Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`apply(String propertyName, String value)`	Apply this filter on the provided value.
`void`	`init(Config config)`	Initialize this filter from configuration.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MpEncryptionFilter
```
@Deprecated
public MpEncryptionFilter()
```
    Deprecated.
    
    This constructor is only for use by MpConfigFilter service loader.
- Method Detail
  - init
```
public void init(Config config)
```
    Description copied from interface: MpConfigFilter
    
    Initialize this filter from configuration. The config instance provided only has filters with higher priority than this filter.
    
    Specified by:
    
    init in interface MpConfigFilter
    
    Parameters:
    
    config - configuration to set this filter up.
  - apply
```
public String apply(String propertyName,
                    String value)
```
    Description copied from interface: MpConfigFilter
    
    Apply this filter on the provided value.
    
    Specified by:
    
    apply in interface MpConfigFilter
    
    Parameters:
    
    propertyName - name of the property (its key)
    
    value - the current value of the property as retrieved from the config source, or from previous filters
    
    Returns:
    
    value as processed by this filter