Architecture

Secrets managed by Storemanager are persisted in the Storemanager database. Storemanager encrypts secrets before persistence. In the application configuration template, all secrets are located in the secret.properties configuration file.

If secrets are provided directly for the target application or service via the Config Service, secrets are decrypted by the Config Service before provisioning. The target application or service ensures that secrets are encrypted by a local encryption key before persistence on a local file system. If secrets are provided over Config DB, they are not decrypted. The decryption is done by the target service.

The Config Service allows an edge client to only get its own secret.properties. Clients use JWT tokens for authentication. The Config Service uses the additional information in the token to validate client access only to its own secret.properties. Cloud services authenticate using Basic Auth.

The same encryption keys are configured for Storemanager, Config Service and some cloud services that receive the configuration from Config DB. Encryption keys are loaded from environment variables. Symmetric encryption is used (the same key is used for encryption and decryption). To increase security, it is allowed to change the key used for encryption. When the key is changed, all encrypted data in the Storemanager database is recalculated to only use the new encryption key. As the process takes time, the Config Service and the other services use the old and new encryption keys simultaneously.

The encryption keys used by Storemanager are not shared with the edge clients. Every client uses its own unique key.

Architecture - Cloud Services - Config DB

The configuration managed by Storemanager is provided for some services via Config DB. The Config Service takes the configuration from the Storemanager database and calculates the final configuration for selected services in the configuration database - Config DB. The values in secret.properties are encrypted in Config DB.

The same configuration encryption keys are configured for Storemanager and cloud services that receive the configuration from Config DB. Storemanager encrypts secrets in the configuration. Cloud services decrypt the secrets in the configuration.

Architecture - Cloud Services - Config Service

The configuration managed by Storemanager is provided for some services via REST API. The Config Service takes the configuration from the Storemanager database, calculates the final configuration and provides it to the service. The values in secret.properties are decrypted before provisioning. Cloud services keep the configuration in memory.

Architecture - Edge Clients - Stationary

The configuration managed by Storemanager is provided for clients via REST API. The Config Service takes the configuration from the Storemanager database, calculates the final configuration and provides it to the client. The values in secret.properties are decrypted before provisioning.

Every application has its own encryption key. The key is created during installation and located in a file in a directory used by the client. The key is used by the application to encrypt secrets: complete secret.properties and tokens in auth-tokens.properties. Encryption is performed before persistence on the local file system.

Architecture - Edge Clients - Mobile

The configuration managed by Storemanager is provided for clients via REST API. The Config Service takes the configuration from the Storemanager database, calculates the final configuration and provides it to the client. The values in secret.properties are decrypted before provisioning.

Every application has its own encryption key. The key is created during initialization and located in Keystore or Keychain depending on the system. The key is used by the application to encrypt secrets: complete secret.properties and tokens in auth-tokens.properties. Encryption is performed before persistence on the local file system.