resolve PR comments

Author: Artem

DOCKER_README.md

@@ -17,9 +17,10 @@ These commands will build the image and then start the container. Redis Insight
 
 Redis Insight supports several configuration values that can be supplied via container environment variables. The following may be provided:
 
-| Variable | Purpose | Default | Additional Info |
-| ---------|---------|-----------------|---------|
-| RI_APP_PORT | The port the app listens on | 5000 | See [Express Documentation](https://expressjs.com/en/api.html#app.listen) |
-| RI_APP_HOST | The host the app listens on | 0.0.0.0 | See [Express Documentation](https://expressjs.com/en/api.html#app.listen) |
-| RI_SERVER_TLS_KEY | Private key for HTTPS | | Private key in [PEM format](https://www.ssl.com/guide/pem-der-crt-and-cer-x-509-encodings-and-conversions/#ftoc-heading-3). May be a path to a file or a string in PEM format. |
-| RI_SERVER_TLS_CERT | Certificate for supplied private key | | Public certificate in [PEM format](https://www.ssl.com/guide/pem-der-crt-and-cer-x-509-encodings-and-conversions/#ftoc-heading-3) |
+| Variable | Purpose | Default | Additional Info                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| ---------|---------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| RI_APP_PORT | The port the app listens on | 5000 | See [Express Documentation](https://expressjs.com/en/api.html#app.listen)                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| RI_APP_HOST | The host the app listens on | 0.0.0.0 | See [Express Documentation](https://expressjs.com/en/api.html#app.listen)                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| RI_SERVER_TLS_KEY | Private key for HTTPS | | Private key in [PEM format](https://www.ssl.com/guide/pem-der-crt-and-cer-x-509-encodings-and-conversions/#ftoc-heading-3). May be a path to a file or a string in PEM format.                                                                                                                                                                                                                                                                                                                                 |
+| RI_SERVER_TLS_CERT | Certificate for supplied private key | | Public certificate in [PEM format](https://www.ssl.com/guide/pem-der-crt-and-cer-x-509-encodings-and-conversions/#ftoc-heading-3)                                                                                                                                                                                                                                                                                                                                                                              |
+| RI_ENCRYPTION_KEY | Key to encrypt data with | | Redisinsight stores some data such as connection details locally (using [sqlite3](https://github.com/TryGhost/node-sqlite3)). It might be usefull to store sensitive data such as passwords, or private keys encrypted. For this case RedisInsight supports encryption with provided key.<br />Note: The Key must be the same for the same RedisInsight instance to be able to decrypt exising data. If for some reason the key was changed, you will have to enter the credentials again to connect to the Redis database. |

redisinsight/api/src/modules/encryption/strategies/key-encryption.strategy.spec.ts

@@ -46,7 +46,7 @@ describe('KeyEncryptionStrategy', () => {
       expect(await service.encrypt(mockDataToEncrypt)).toEqual(mockKeyEncryptResult);
       expect(service['cipherKey']).not.toEqual(undefined);
     });
-    it('Should throw KeytarEncryptionError when unable to encrypt', async () => {
+    it('Should throw KeyEncryptionError when unable to encrypt', async () => {
       await expect(service.encrypt(null)).rejects.toThrowError(KeyEncryptionErrorException);
     });
     it('Should throw KeyUnavailable when there is no key but we are trying to encrypt', async () => {

redisinsight/api/src/modules/encryption/strategies/key-encryption.strategy.ts

@@ -6,19 +6,20 @@ import { EncryptionResult, EncryptionStrategy } from 'src/modules/encryption/mod
 import { IEncryptionStrategy } from 'src/modules/encryption/strategies/encryption-strategy.interface';
 import {
   KeyDecryptionErrorException,
-  KeyEncryptionErrorException, KeyUnavailableException
+  KeyEncryptionErrorException,
+  KeyUnavailableException,
 } from 'src/modules/encryption/exceptions';
-import config from 'src/utils/config';
+import config, { Config } from 'src/utils/config';
 
 const ALGORITHM = 'aes-256-cbc';
 const HASH_ALGORITHM = 'sha256';
-const SERVER_CONFIG = config.get('server');
+const SERVER_CONFIG = config.get('server') as Config['server'];
 
 @Injectable()
 export class KeyEncryptionStrategy implements IEncryptionStrategy {
   private logger = new Logger('KeyEncryptionStrategy');
 
-  private cipherKey;
+  private cipherKey: Buffer;
 
   private readonly key: string;
 
@@ -27,8 +28,8 @@ export class KeyEncryptionStrategy implements IEncryptionStrategy {
   }
 
   /**
-   * Get password from storage and create cipher key
-   * Note: Will generate new password if it doesn't exists yet
+   * Will return existing cipher stored in-memory or
+   * create new one using specified key and store it in-memory
    */
   private async getCipherKey(): Promise<Buffer> {
     if (!this.cipherKey) {
@@ -45,8 +46,7 @@ export class KeyEncryptionStrategy implements IEncryptionStrategy {
   }
 
   /**
-   * Checks if Keytar functionality is available
-   * Basically just try to get a password and checks if this call fails
+   * Checks if secret key was specified
    */
   async isAvailable(): Promise<boolean> {
     return !!this.key;