{"id":1352,"date":"2024-06-27T07:25:06","date_gmt":"2024-06-27T07:25:06","guid":{"rendered":"https:\/\/fredborg.org\/?p=1352"},"modified":"2024-06-27T10:23:47","modified_gmt":"2024-06-27T10:23:47","slug":"automating-client-secret-renewal-with-azure-logic-apps-and-azure-key-vault","status":"publish","type":"post","link":"https:\/\/fredborg.org\/?p=1352","title":{"rendered":"Automating Client Secret Renewal with Azure Logic Apps and Azure Key Vault"},"content":{"rendered":"\n
With the introduction of Business Central Cloud, many NAV and Business Central developers have encountered the concept of OAuth. This requires the creation of an App Registration in Azure, which provides a Client Secret that can be used to call Business Central APIs. However, a crucial aspect often overlooked by developers and consultants is the expiry date of a Client Secret. Without a proper system in place to manage this, systems relying on your Client Secret to connect to Business Central will eventually stop working once the secret expires.<\/p>\n\n\n\n
A common, yet flawed, solution is to set a calendar reminder for when the Client Secret is about to expire. The assigned person then creates a new secret and manually updates the variables in the systems that use it. This method has several vulnerabilities:<\/p>\n\n\n\n
\n
Human Dependency<\/strong>: If the person responsible is unavailable due to illness or vacation, the renewal process is jeopardized.<\/li>\n\n\n\n
Security Risks<\/strong>: Client Secrets should not be disseminated across multiple systems. Centralizing them ensures better security and manageability.<\/li>\n<\/ol>\n\n\n\n
To address these issues, we will explore how to use an Azure Logic App to automatically create a new Client Secret for an App Registration and update it in an Azure Key Vault. This approach centralizes the management of Client Secrets and allows systems to access the secret through the Azure Key Vault. This setup enables automatic renewal of the Client Secret as frequently as needed without risking any connection failures.<\/p>\n\n\n\n
Setting Up the App Registration with Microsoft Graph Access<\/h3>\n\n\n\n
The first step is to create an App Registration that has access to Microsoft Graph. This can be either the same App Registration you plan to use for Business Central or a separate one. Creating a separate App Registration can help distribute responsibilities across different resources. However, for simplicity, we will use the same App Registration in this guide.<\/p>\n\n\n\n
Steps to Create a Client Secret<\/h4>\n\n\n\n\n
Navigate to App Registrations<\/strong>:\n
\n
Go to the Azure portal and navigate to “App Registrations.”<\/li>\n\n\n\n
Select the App Registration you will use.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
Create a Client Secret<\/strong>:\n
\n
In the left-hand menu, select “Certificates & secrets.”<\/li>\n\n\n\n
Click on “New client secret.”<\/li>\n<\/ul>\n<\/li>\n\n\n\n
Configure the Client Secret<\/strong>:\n
\n
Provide a description for the Client Secret. The description and expiration date are not critical here since this secret will be used only once before being replaced automatically.<\/li>\n\n\n\n
After creating the Client Secret, copy it immediately. You will not be able to see it again once you leave this page. This Client Secret will be needed later in the process.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n\n\n\n
By following these steps, you have now created an App Registration with a Client Secret. This setup is essential for enabling the automated creation and management of Client Secrets using Azure Logic Apps.<\/p>\n\n\n\n<\/figure>\n\n\n\n
<\/p>\n\n\n\n
Configuring API Permissions for Microsoft Graph<\/h3>\n\n\n\n
Next, we need to configure API permissions for our App Registration to allow access to Microsoft Graph. The necessary permissions are Application.Read.All<\/code>, Application.ReadWrite.All<\/code>, Application.ReadWrite.OwnedBy<\/code>, and User.Read<\/code>.<\/p>\n\n\n\n
Steps to Add API Permissions<\/h4>\n\n\n\n\n
Navigate to API Permissions<\/strong>:\n
\n
In the Azure portal, go to your App Registration.<\/li>\n\n\n\n
Select the “API permissions” menu item.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
Add Permissions<\/strong>:\n
\n
Click on the “Add a permission” button.<\/li>\n\n\n\n
Choose “Microsoft Graph” from the list of APIs.<\/li>\n\n\n\n
Select “Application permissions” and add the following permissions:\n
After adding these permissions, you must grant admin consent. Click on the “Grant admin consent” button.<\/li>\n\n\n\n
Confirm the action. Once this is done, you should see a green check mark next to each permission, indicating they have been granted successfully.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n\n\n\n
By completing these steps, your App Registration will have the necessary permissions to interact with Microsoft Graph, allowing for the creation and management of Client Secrets.<\/p>\n\n\n\n
<\/p>\n\n\n\n<\/figure>\n\n\n\n
<\/p>\n\n\n\n<\/figure>\n\n\n\n
<\/p>\n\n\n\n<\/figure>\n\n\n\n<\/figure>\n\n\n\n
<\/p>\n\n\n\n
Setting Up Azure Key Vault<\/h3>\n\n\n\n
Next, we need to create an Azure Key Vault to securely store our Client Secret. This section will guide you through creating the Key Vault and adding your secret.<\/p>\n\n\n\n
Steps to Create Azure Key Vault<\/h4>\n\n\n\n\n
Navigate to Azure Key Vault<\/strong>:\n
\n
In the Azure portal, search for “Azure Key Vault” and select it.<\/li>\n\n\n\n
Click on the “Create” button.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
Configure the Key Vault<\/strong>:\n
\n
Fill in the required details, such as the subscription, resource group, and key vault name.<\/li>\n\n\n\n
Choose your preferred region and pricing tier.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
Set Access Policy<\/strong>:\n
\n
For simplicity, we will use the Vault access policy. While Azure role-based access control (RBAC) is generally recommended for its flexibility and security, this blog post will use Vault access policy to keep things straightforward.<\/li>\n\n\n\n
Under the “Access Policy” section, click on “Add Access Policy.”<\/li>\n\n\n\n
Assign the necessary permissions for managing secrets.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
Create the Key Vault<\/strong>:\n
\n
Review your settings and click “Create” to provision your Key Vault.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
Add a Secret<\/strong>:\n
\n
Once your Key Vault is created, navigate to it.<\/li>\n\n\n\n
In the left-hand menu, select “Secrets.”<\/li>\n\n\n\n
Click on “Generate\/Import” to add a new secret.<\/li>\n\n\n\n
Provide a name for your secret and enter the value (the Client Secret you created earlier).<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n\n\n\n
By following these steps, you will have a Key Vault set up with your Client Secret securely stored. This Key Vault will be used by the Azure Logic App to store and manage Client Secrets automatically.<\/p>\n\n\n\n<\/figure>\n\n\n\n<\/figure>\n\n\n\n
<\/p>\n\n\n\n
Creating the Azure Logic App<\/h3>\n\n\n\n
The next step is to create the Azure Logic App that will automate the creation and storage of Client Secrets.<\/p>\n\n\n\n
Steps to Create the Logic App<\/h4>\n\n\n\n\n
Navigate to Logic Apps<\/strong>:\n
\n
In the Azure portal, search for “Logic Apps” and select it.<\/li>\n\n\n\n
Click on the “Create” button.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
Configure the Logic App<\/strong>:\n
\n
Fill in the required details, such as the subscription, resource group, and name of the Logic App.<\/li>\n\n\n\n
Choose your preferred region and pricing plan.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
Create the Logic App<\/strong>:\n
\n
Review your settings and click “Create” to provision your Logic App.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n\n\n\n
Once the Logic App is created, we will proceed to configure it to automate the renewal of the Client Secret and its storage in the Azure Key Vault.<\/p>\n\n\n\n
<\/p>\n\n\n\n<\/figure>\n\n\n\n
Setting Up Managed Identity for the Logic App<\/h3>\n\n\n\n
To securely connect our Logic App to the Azure Key Vault, we will set up a managed identity. Using a managed identity is preferred over using connection strings because Azure handles all authentication, enhancing security and simplifying the process.<\/p>\n\n\n\n
Steps to Set Up Managed Identity<\/h4>\n\n\n\n\n
Enable Managed Identity<\/strong>:\n
\n
In the Azure portal, navigate to your Logic App.<\/li>\n\n\n\n
In the left-hand menu, select “Identity.”<\/li>\n\n\n\n
Set the “Status” to “On” under the “System assigned” tab.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
Assign Azure Roles<\/strong>:\n
\n
After enabling the managed identity, click on “Azure role assignments.”<\/li>\n\n\n\n
Press the “Add role assignment” button.<\/li>\n\n\n\n
Select your scope, which in this case should be “Key Vault.”<\/li>\n\n\n\n
Choose your Key Vault resource.<\/li>\n\n\n\n
Select an appropriate role. Ideally, you should select the role with the least permissions required. For simplicity in this tutorial, we will choose the “Owner” role. However, in a production environment, you should opt for a role that adheres to the principle of least privilege.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n\n\n\n
By setting up a managed identity for your Logic App, Azure will handle all authentication, making the connection to the Azure Key Vault more secure and manageable.<\/p>\n\n\n\n<\/figure>\n\n\n\n
<\/p>\n\n\n\n
Creating the Workflow in the Logic App<\/h3>\n\n\n\n
Now that our Logic App is set up with a managed identity, we need to create a workflow to automatically rotate our Client Secret. The workflow will run on a recurring schedule.<\/p>\n\n\n\n
Steps to Create the Workflow<\/h4>\n\n\n\n\n
Set Up Recurrence<\/strong>:\n
\n
In your Logic App, go to the “Designer” tab.<\/li>\n\n\n\n
Add a new trigger and select “Recurrence” from the list of triggers.<\/li>\n\n\n\n
Configure the recurrence schedule according to how often you want the Client Secret to be rotated (e.g., every 30 days).<\/li>\n<\/ul>\n<\/li>\n\n\n\n
Add Parameters<\/strong>:
Set up three parameters: TenantId<\/code>, ClientId<\/code>, and ObjectId<\/code>.
TenantId<\/code>: This is your Azure Active Directory (AAD) tenant ID.<\/li>
ClientId<\/code>: This is the client ID from your App Registration.<\/li>
ObjectId<\/code>: This is the object ID of the App Registration.<\/li><\/ul><\/li><\/ul>You can find all these values in the Azure portal under your App Registration.<\/li>\n<\/ol>\n\n\n\n
<\/p>\n\n\n\n<\/figure>\n\n\n\n
<\/p>\n\n\n\n
We will use the Azure Key Vault connector to access our Client Secret. Next, we will perform an HTTP request to obtain an access token. The URL for this request is:<\/p>\n\n\n\n
![\"\"](\"https:\/\/fredborg.org\/wp-content\/uploads\/2024\/06\/image-8-1024x369.png\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/fredborg.org\/wp-content\/uploads\/2024\/06\/image-9-1024x349.png\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/fredborg.org\/wp-content\/uploads\/2024\/06\/image-10.png\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/fredborg.org\/wp-content\/uploads\/2024\/06\/image-11-1024x248.png\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/fredborg.org\/wp-content\/uploads\/2024\/06\/image-12-1024x255.png\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/fredborg.org\/wp-content\/uploads\/2024\/06\/Keyvault.gif\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/fredborg.org\/wp-content\/uploads\/2024\/06\/Add-secret.gif\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/fredborg.org\/wp-content\/uploads\/2024\/06\/image-13.png\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/fredborg.org\/wp-content\/uploads\/2024\/06\/managed-identity.gif\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/fredborg.org\/wp-content\/uploads\/2024\/06\/image-14.png\")
<\/figure>\n\n\n\n