Welcome to the Cyara Knowledge Center

To encrypt the database, perform the following:

1. Shut down the Services
2. Edit the Cyara encryption tool configuration file
3. Run the Cyara encryption tool

Before encrypting the database, you must shut down the Cyara Web Portal, Voice Scheduler, and Omni Scheduler. It is critical that the Cyara Web Portal, Voice Scheduler, and Omni Scheduler remain offline until the encryption process is complete.

Before editing the configuration file of the tool, you need to obtain the values for the Certificate Name and Thumbprint fields.

Refer to the Obtaining the Certificate Name and Thumbprint Values section to obtain the Certificate Name and Thumbprint field values.

1. In the Cyara.Database.Utils.Encryption.Tool.exe.config file, update the keys in the <EncryptionSettings.UniqueCertificateName> section with the values for those keys with the customer-specific details.

   <!-- Database encryption settings. These settings are ignored unless database encryption is licensed. -->
   <!-- EncryptionSettings.UniqueCertificateName - Distinguished name for the X.509 Certificate used with Database Encryption (e.g. "CN = CyaraPlatformEncryptionExample"). No default. -->
   <add key="EncryptionSettings.UniqueCertificateName" value="CN = CyaraPlatformEncryptionExample" />
   
   <!-- EncryptionSettings.CertificateThumbprint - Certificate thumbprint to use for encrypting (used with X.509). (e.g. "6f 54 7c 48 87 bb 8f 8c 71 3f fb 50 f9 9b 5c 4c 8f dd 85 3f"). No default. -->
   <add key="EncryptionSettings.CertificateThumbprint" value="‎6f 54 7c 48 87 bb 8f 8c 71 3f fb 50 f9 9b 5c 4c 8f dd 85 3f" />
   
   <!-- EncryptionSettings.MachineCertificate - Whether to use the Local Computer key container (as opposed to the Current User key container). True will select the Local Computer key container. Defaults to True. -->
   <add key="EncryptionSettings.MachineCertificate" value="True" />
   
   <!-- EncryptionSettings.Cipher - The Cipher to use. Valid values are: None, X509, UTF8, AESplusX509. Defaults to None. -->
   <add key="EncryptionSettings.Cipher" value="AESplusX509" />
   

2. Update the <connectionStrings> section with the connection details for the Microsoft SQL Server database if the details entered during setup were incorrect or have changed.

   <connectionStrings>
       <add name="DefaultContext" connectionString="DATA SOURCE= db_host_ip;INITIAL CATALOG= 
       cyaradb;USER ID=cyaraportal;PASSWORD=password;PERSIST SECURITY INFO=True" providerName=
       "System.Data.SqlClient"/>
   </connectionStrings>

3. Save the Cyara.Database.Utils.Encryption.Tool.exe.config file with these changes.

To encrypt the database, use the following command line syntax:

Cyara.Database.Utils.Encryption.Tool.exe -e

or

Cyara.Database.Utils.Encryption.Tool.exe --encrypt

Before decrypting the database, you must shut down the Cyara Web Portal, Voice Scheduler, and Omni Scheduler. It is critical that the Cyara Web Portal, Voice Scheduler, and Omni Scheduler remain offline until the decryption process is complete.

Before decrypting, the most important thing is that the configuration settings must match those used to encrypt (or partially encrypt) the database. If the database is fully encrypted, the encryption configuration settings must match with the Cyara Web Portal, Voice Scheduler, and Omni Scheduler configuration files.

1. Verify and ensure that the encryption configuration settings of the Cyara.Database.Utils.Encryption.Tool.exe.config file match with the web.config file.
2. Verify and ensure that the encryption configuration settings of the Cyara.Database.Utils.Encryption.Tool.exe.config file match with the Cyara.Voice.Scheduler.exe.config file.
3. Verify and ensure that the encryption configuration settings of the Cyara.Database.Utils.Encryption.Tool.exe.config file match with the Cyara.Scheduler.Host.exe.config file.

Remove the encryption settings from the Cyara Web Portal, Voice Scheduler, and Omni Scheduler.

1. In the web.config file, remove the values of the <EncryptionSettings.UniqueCertificateName> section and update the keys as:

   <!-- EncryptionSettings.UniqueCertificateName - Distinguished name for the X.509 Certificate used with Database Encryption (e.g. "CN = CyaraPlatformEncryptionExample"). No default. -->
   <add key="EncryptionSettings.UniqueCertificateName" value="" />
   
   <!-- EncryptionSettings.CertificateThumbprint - Certificate thumbprint to use for encrypting (used with X.509). (e.g. "6f 54 7c 48 87 bb 8f 8c 71 3f fb 50 f9 9b 5c 4c 8f dd 85 3f"). No default. -->
   <add key="EncryptionSettings.CertificateThumbprint" value="‎" />
   
   <!-- EncryptionSettings.MachineCertificate - Whether to use the Local Computer key container (as opposed to the Current User key container). True will select the Local Computer key container. Defaults to True. -->
   <add key="EncryptionSettings.MachineCertificate" value="True" />
   
   <!-- EncryptionSettings.Cipher - The Cipher to use. Valid values are: None, X509, UTF8, AESplusX509. Defaults to None. -->
   <add key="EncryptionSettings.Cipher" value="None" />

2. Save the web.config file with these changes.

1. In the Cyara.Voice.Scheduler.exe.config file, remove the values of the <EncryptionSettings.UniqueCertificateName> section and update the keys as:

   <!-- EncryptionSettings.UniqueCertificateName - Distinguished name for the X.509 Certificate used with Database Encryption (e.g. "CN = CyaraPlatformEncryptionExample"). No default. -->
   <add key="EncryptionSettings.UniqueCertificateName" value="" />
   
   <!-- EncryptionSettings.CertificateThumbprint - Certificate thumbprint to use for encrypting (used with X.509). (e.g. "6f 54 7c 48 87 bb 8f 8c 71 3f fb 50 f9 9b 5c 4c 8f dd 85 3f"). No default. -->
   <add key="EncryptionSettings.CertificateThumbprint" value="‎" />
   
   <!-- EncryptionSettings.MachineCertificate - Whether to use the Local Computer key container (as opposed to the Current User key container). True will select the Local Computer key container. Defaults to True. -->
   <add key="EncryptionSettings.MachineCertificate" value="True" />
   
   <!-- EncryptionSettings.Cipher - The Cipher to use. Valid values are: None, X509, UTF8, AESplusX509. Defaults to None. -->
   <add key="EncryptionSettings.Cipher" value="None" />

2. Save the Cyara.Voice.Scheduler.exe.config file.

1. In the Cyara.Scheduler.Host.exe.config file, remove the values of the <EncryptionSettings.UniqueCertificateName> section and update the keys as:

   <!-- EncryptionSettings.UniqueCertificateName - Distinguished name for the X.509 Certificate used with Database Encryption (e.g. "CN = CyaraPlatformEncryptionExample"). No default. -->
   <add key="EncryptionSettings.UniqueCertificateName" value="" />
   
   <!-- EncryptionSettings.CertificateThumbprint - Certificate thumbprint to use for encrypting (used with X.509). (e.g. "6f 54 7c 48 87 bb 8f 8c 71 3f fb 50 f9 9b 5c 4c 8f dd 85 3f"). No default. -->
   <add key="EncryptionSettings.CertificateThumbprint" value="‎" />
   
   <!-- EncryptionSettings.MachineCertificate - Whether to use the Local Computer key container (as opposed to the Current User key container). True will select the Local Computer key container. Defaults to True. -->
   <add key="EncryptionSettings.MachineCertificate" value="True" />
   
   <!-- EncryptionSettings.Cipher - The Cipher to use. Valid values are: None, X509, UTF8, AESplusX509. Defaults to None. -->
   <add key="EncryptionSettings.Cipher" value="None" />

2. Save the Cyara.Scheduler.Host.exe.config file.