Configuring Secret Key Vault for Aptify Services API

In Aptify release 7.4, support for the Secret Key Vault feature has been added to the AptifyServicesAPI SQL user password configuration. This enhancement improves security by using a secure Key Vault, whereas previously, the passwords were stored in plain text within configuration files.

As part of this enhancement, all the Aptify Web configuration files were reviewed to identify and remove any hardcoded passwords. This functionality is available for both On-premises and Azure hosted web applications. 

Prerequisites

Below are the prerequisites for configuring secret Key Vault feature:

1. Azure Key Vault Setup:
   • The Secret Key Vault must be created in Azure.  For more details on how to create the Secret Key Vault, refer here 
2. App Service Registration (for Azure only):
   • Your application service must be registered on Azure.
   • Ensure that you have the Client ID and Client Secret for the app service.
3. Required DLLs in Bin Folder: Make sure the following DLL are present in the application's bin folder:
   • Azure.Security.KeyVault.Secrets.dll
     
     
     Note:
     Assembly Redirects: If the Key Vault assemblies are available in different versions on your environment, you may need to add assembly redirects in all the applications configuration files to ensure compatibility.
     

Configuring Aptify Azure App Services

1. In the web.config file of the services, add below attribute and set the value to True.
   <add key="Aptify.Framework.LoginServices.AptifyLogin.IsKeyVaultEnabledforSQLPassword" value="True"/>
2. In the web.config file of the services, set the value of below attribute to Key Vault Secret value created in step one of prerequisite
   <add key="Aptify.Framework.LoginServices.AptifyLogin.KeyVaultSecret" value="" />