Skip to content

Latest commit

 

History

History
203 lines (130 loc) · 11.8 KB

README.md

File metadata and controls

203 lines (130 loc) · 11.8 KB
Raw

Deploy your apps to Azure Cloud using App Service and Key Vault

  1. Overview
  2. Scenario
  3. Prerequisites
  4. Setup
  5. Registration
  6. Deployment
  7. Explore the sample
  8. More information
  9. Community Help and Support
  10. Contributing

Overview

This sample demonstrates how to deploy a Node.js & Express web application to Azure Cloud using the Azure App Service. The application used in this sample is a slightly modified version of the web app from chapter 2-1. The steps here apply similarly to Microsoft Entra ID and Azure Active Directory B2C apps.

One of the principles of security is to place credentials like secrets and certificates out of your code and use it in a manner that allows them to be replaced or rotated without incurring a downtime. As such, this sample also uses the Azure Key Vault to store client secrets safely on the cloud.

Scenario

  1. The client application uses the MSAL Node (via microsoft-identity-express) to sign-in a user and obtain a JWT Access Token from Microsoft Entra ID.
  2. The Access Token is used as a bearer token to authorize the user to access the resource (MS Graph).
  3. The resource server responds with the resource that the user has access to.

Overview

Prerequisites

  • VS Code Azure Tools Extension extension is recommended for interacting with Azure through VS Code interface.
  • An Microsoft Entra ID tenant. For more information, see: How to get a Microsoft Entra tenant
  • A user account in your Microsoft Entra ID tenant.
  • An Azure subscription. This sample uses Azure App Service and Azure Key Vault.

Setup

Step 1: Clone or download this repository

From your shell or command line:

    git clone https://github.com/Azure-Samples/ms-identity-javascript-nodejs-tutorial.git

or download and extract the repository .zip file.

⚠️ To avoid path length limitations on Windows, we recommend cloning into a directory near the root of your drive.

Step 2: Install project dependencies

Locate the root of the sample folder. Then:

    cd 3-Deployment/App
    npm install

Registration

Register the app

Use the same app registration credentials that you've obtained during chapter 2-1. Leave out the clientSecret, however, as we will fetch secrets from Azure Key Vault instead.

Deployment

There are basically 2 stages that you will have to go through in order to deploy your projects and enable authentication:

  1. Upload your project files to Azure services and obtain published website URIs
  2. Update Microsoft Entra ID App Registration with URIs you have just obtained

There are various ways to upload your files to Azure App Service. Here we provide steps for uploading via VS Code Azure Tools Extension.

We recommend watching the video tutorial offered by Microsoft Docs for preparation.

Deploy the web app

Step 1: Deploy your files

  1. In the VS Code activity bar, select the Azure logo to show the Azure App Service explorer. Select Sign in to Azure... and follow the instructions. Once signed in, the explorer should show the name of your Azure subscription(s).

api_step1

  1. On the App Service explorer section you will see an upward-facing arrow icon. Click on it publish your local files in the App folder to Azure App Services. You may also right-click to the App folder to access it via the context menu.

api_step2

  1. Choose a creation option based on the operating system to which you want to deploy. In this sample, we choose Linux.
  2. Select a Node.js version when prompted. An LTS version is recommended (>=12).
  3. Type a globally unique name for your web API and press Enter. The name must be unique across all of Azure. (e.g. example-express-webapp1)
  4. After you respond to all the prompts, VS Code shows the Azure resources that are being created for your app in its notification popup.
  5. Select Yes when prompted to update your configuration to run npm install on the target Linux server.

api_step3

Step 2: Update Microsoft Entra app Registration

Navigate to the Microsoft Entra admin center and select the Microsoft Entra ID service.

  1. Select the App Registrations blade on the left, then find and select the web app that you have registered in the previous tutorial (example-express-webapp1).
  2. Navigate to the Authentication blade. There, in Redirect URI section, enter the published URL website, for instance: https://example-express-webapp1.azurewebsites.net/redirect.
  3. Select Save to save your changes.

Enable your web app to get secrets from Key Vault using Managed Identity

To achieve this we'll place our application's credentials in Azure Key Vault and access it via managed Identities for Azure resources.

Set up your Managed Identity

  1. Navigate to Microsoft Entra admin center and select the Azure App Service.
  2. Find and select the App Service you've created previously.
  3. On App Service portal, select Identity.
  4. Within the System assigned tab, switch Status to On. Click Save.
  5. Record the Object Id that will appear, as you will need it in the next step.

For more information, see Add a system-assigned identity

Set up your Key vault

Before starting here, make sure:

Upload your secret to KeyVault
  1. Navigate to your new key vault in the Microsoft Entra admin center.
  2. On the Key Vault settings pages, select Secrets.
  3. Click on Generate/Import.
  4. On the Create a secret screen choose the following values:
    • Upload options: Manual.
    • Name: Type a name for the secret. The secret name must be unique within a Key Vault. For example, ExampleSecret
    • Value: Copy and paste the value of the clientSecret for your App. You can use the secret you created in the previous tutorial. If you forgot it and cannot access it again, simply create a new one.
    • Leave the other values to their defaults. Click Create.
Provide the managed identity access to Key Vault
  1. Navigate to your Key Vault in the portal.
  2. Select Overview > Access policies.
  3. Click on Add Access Policy.
  4. In the input box for Secret permissions, select Get.
  5. Click on Select Principal, add the system-assigned managed identity that you have created in the steps before. You can use the Object Id you have recorded previously to search for it.
  6. Click on OK to add the new Access Policy, then click Save to save the Access Policy.

Add environment variables to App Service

Finally, you need to add a few environment variables to the App Service where you deployed your web app.

  1. In the Microsoft Entra admin center , search for and select App Service, and then select your app.
  2. Select Configuration blade on the left, then select New Application Settings.
  3. Add the following variables (name-value):
    1. KEY_VAULT_URI: the name of the key vault you've created, e.g. example-key-vault
    2. SECRET_NAME: the name of the certificate you specified when importing it to key vault, e.g. ExampleSecret
    3. NODE_ENV: enter production (:information_source: this enables your application to set cookies to secure and trust App service proxy)

Wait for a few minutes for your changes on App Service to take effect. You should then be able to visit your published website and sign-in accordingly.

Explore the sample

  1. Open your browser and navigate to your deployed client app's URI, for instance: https://example-express-webapp1.azurewebsites.net/.
  2. Click on the sign-in button located on the top right corner.
  3. Once you sign in, click on the See my profile button to call Microsoft Graph.
  4. Once you sign in, click on the Get my tenant button to call Azure Resource Manager.

Screenshot

We'd love your feedback!

Were we successful in addressing your learning objective? Consider taking a moment to share your experience with us.

About the code

Accessing Key Vault using Managed Identity

In app.js, we instantiate an MsalWebAppAuthClient object asynchronously using the buildAsync method of WebAppAuthClientBuilder. To do so, we need to start the express server asynchronously:



More information



For more information about how OAuth 2.0 protocols work in this scenario and other scenarios, see Authentication Scenarios for Microsoft Entra ID.


Community Help and Support


Use Stack Overflow to get support from the community.
Ask your questions on Stack Overflow first and browse existing issues to see if someone has asked your question before.
Make sure that your questions or comments are tagged with [azure-ad node ms-identity msal].


If you find a bug in the sample, please raise the issue on GitHub Issues.


To provide a recommendation, visit the following User Voice page.


Contributing


If you'd like to contribute to this sample, see CONTRIBUTING.MD.


This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.