azure-samples/app-service-managed-identity-key-vault-csharp

An ASP.NET Core app for bootstrapping your next Web Apps for Containers service using Key Vault and Managed Identities

services	platforms	languages	products	author	description	urlFragment	page_type
app-service key-vault azure-app-service azure-key-vault	dotnet linux	csharp	azure dotnet aspnet azure-app-service azure-key-vault	aflinchb	A sample ASP.NET Core WebAPI for bootstrapping your next App Service app using Managed Identity and Key Vault	app-service-managed-identity-key-vault-csharp	sample

Build an ASP.NET Core application using App Service, Managed Identity and Key Vault

This sample is an ASP.NET Core WebAPI application designed to "fork and code" with the following features:

• Securely build, deploy and run an App Service (Web App for Containers) application
• Securely store secrets in Key Vault
• Securely use Key Vault secrets as Application Settings values with Key Vault reference strings
• Use Managed Identity to securely access Key Vault secrets from App Services
• Use Managed Identity to securely access Docker images from Container Registry

Prerequisites

• Azure subscription with permissions to create:
  • Resource Group, Keyvault, App Service, Azure Container Registry
• Bash shell (tested on Mac, Ubuntu, WSL2 and Cloud Shell)
• Azure CLI (download)
• Docker CLI (download)
• .NET Core SDK (download)
• Visual Studio Code (optional) (download)

Open with Codespaces

You must have access to Codespaces as an individual or part of a GitHub Team or GitHub Enterprise Cloud

• Click the Code button on your repo
  • Click the Codespaces tab
  • Click New Codespace

Setup

• Fork this repo and clone to your local machine (unless using Codespaces)
  • cd to the base directory of the repo

Login to Azure and select subscription

az login

# show your Azure accounts
az account list -o table

# select the Azure account (if necessary)
az account set -s {subscription name or Id}

Choose a unique DNS name

# this will be the prefix for all resources
# do not include punctuation - only use a-z and 0-9
# must be at least 5 characters long
# must start with a-z (only lowercase)
export MIKV_NAME=myname

### if nslookup doesn't fail to resolve, change MIKV_NAME
nslookup $MIKV_NAME.azurewebsites.net
nslookup $MIKV_NAME.vault.azure.net
nslookup $MIKV_NAME.azurecr.io

Create Resource Group

• When experimenting with this sample, you should create a new resource group to avoid accidentally deleting resources
  • If you use an existing resource group, please make sure to apply resource locks to avoid accidentally deleting resources

# set location
export MIKV_LOCATION=centralus

# MySecret URI
export MIKV_SECRET_URI=https://$MIKV_NAME.vault.azure.net/secrets/MySecret

# resource group name
export MIKV_RG=${MIKV_NAME}-rg

# create the resource group
az group create -n $MIKV_RG -l $MIKV_LOCATION

Save your environment variables for ease of reuse and picking up where you left off

# run the saveenv.sh script at any time to save MIKV_* variables to ~/${MIKV_NAME}.env
./saveenv.sh -y

# at any point if your terminal environment gets cleared, you can source the file
# you only need to remember the name of the env file
source ~/YourUniqueName.env

Create Azure Key Vault

• All secrets are stored in Azure Key Vault for security
  • Use System Managed Identity to access Key Vault

## create the Key Vault
az keyvault create -g $MIKV_RG -n $MIKV_NAME

# add a secret
az keyvault secret set \
  --vault-name $MIKV_NAME \
  --name "MySecret" \
  --value "Hello from Key Vault and Managed Identity"

Create Azure Container Registry

Create the ACR with admin access disabled for security

# create the ACR
az acr create --sku Standard --admin-enabled false -g $MIKV_RG -n $MIKV_NAME

# get the ACR_ID
export MIKV_ACR_ID=$(az acr show -g $MIKV_RG -n $MIKV_NAME --query id --output tsv)

# login to ACR
# if you get an error that the login server isn't available,
#   it's a DNS issue that will resolve in a minute or two, just retry
az acr login -n $MIKV_NAME --expose-token

# build the mikv container
az acr build -r $MIKV_NAME -t $MIKV_NAME.azurecr.io/mikv .

Create App Service

App Service will fail to start until configured properly

# create App Service plan
az appservice plan create --sku B1 --is-linux -g $MIKV_RG -n ${MIKV_NAME}-plan

# create Web App for Containers with System Managed Identity
# the hello-world image is a placeholder
az webapp create \
  --deployment-container-image-name hello-world \
  --assign-identity '[system]' \
  -g $MIKV_RG \
  -n $MIKV_NAME \
  -p ${MIKV_NAME}-plan

# stop the Web App while we update the config
az webapp stop -g $MIKV_RG -n $MIKV_NAME

Grant access to Managed Identity

# get the App Service Managed Identity
export MIKV_MI_ID=$(az webapp identity show -g $MIKV_RG -n $MIKV_NAME --query principalId -o tsv)

# grant Key Vault access to Managed Identity
az keyvault set-policy \
  -n $MIKV_NAME \
  --secret-permissions get list \
  --key-permissions get list \
  --object-id $MIKV_MI_ID

# grant acr pull access to the Managed Identity
az role assignment create \
  --assignee $MIKV_MI_ID \
  --scope $MIKV_ACR_ID \
  --role acrpull

Configure Web App

# turn on container logging
az webapp log config \
  --docker-container-logging filesystem \
  -g $MIKV_RG \
  -n $MIKV_NAME

# inject Key Vault secret
az webapp config appsettings set \
  -g $MIKV_RG \
  -n $MIKV_NAME \
  --settings MySecret="@Microsoft.KeyVault(SecretUri=$MIKV_SECRET_URI)"

# get config endpoint
export MIKV_CONFIG=$(az webapp show -n $MIKV_NAME -g $MIKV_RG --query id --output tsv)"/config/web"

# save your MIKV_* environment variables for reuse
./saveenv.sh -y

# configure the Web App to use Azure Container Registry with Managed Identity
echo "ignore the warning message - the next command fixes the warning"
az webapp config container set \
  -n $MIKV_NAME \
  -g $MIKV_RG \
  -r https://$MIKV_NAME.azurecr.io \
  -i $MIKV_NAME.azurecr.io/mikv:latest

# use Managed Identity to connect to ACR
az resource update \
  --ids $MIKV_CONFIG \
  --set properties.acrUseManagedIdentityCreds=true

# start the Web App
az webapp start -g $MIKV_RG -n $MIKV_NAME

Check Endpoints

# this will eventually work, but may take up to a minute
# you may get a 403 error, if so, just run the curl command again

# curl the health check endpoint
curl https://$MIKV_NAME.azurewebsites.net/healthz

# curl the /api/secret endpoint
curl https://$MIKV_NAME.azurewebsites.net/api/secret/MySecret

Clean up

# delete Key Vault
az keyvault delete -g $MIKV_RG -n $MIKV_NAME

# purge Key Vault to permanently delete
# Key Vaults use a "soft delete" by default
az keyvault purge -n $MIKV_NAME

# delete resource group
az group delete -n $MIKV_RG --no-wait

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit Microsoft Contributor License Agreement.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

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.

Trademarks

This project may contain trademarks or logos for projects, products, or services.

Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines.

Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.

Any use of third-party trademarks or logos are subject to those third-party's policies.

app-service-managed-identity-key-vault-csharp's Issues

Microsoft.Azure.Services.AppAuthentication reference should be removed

The project has reference to NuGet: Microsoft.Azure.Services.AppAuthentication but I dont see it being used in any classes. Better to remove

[Action Needed] This repo is inactive

This GitHub repository has been identified as a candidate for archival

This repository has had no activity for more than 2 years. Long periods of inactivity present security and code hygiene risks. Archiving will not prevent users from viewing or forking the code. A banner will appear on the repository alerting users that the repository is archived.

Please see https://aka.ms/sunsetting-faq to learn more about this process.

Action

✍️

❗**If this repository is still actively maintained, please simply close this issue. Closing an issue on a repository is considered activity and the repository will not be archived.🔒

If you take no action, this repository is still inactive 30 days from today it will be automatically archived..

Need more help? 🖐️

• Email [email protected]. ✉️
• Post your questions in GitHub inside Microsoft Team in Microsoft Teams. 🗨️