Azure Key Vault

Module: Describe the Capabilities of Microsoft Security Solutions

Section: Core Infrastructure Security in Azure

Lesson: Azure Key Vault

Welcome to this lesson on Azure Key Vault! In today's interconnected digital landscape, securing sensitive information is not just a best practice; it's a fundamental requirement for any organization. As we increasingly rely on cloud services for our infrastructure and applications, the challenge of managing and protecting secrets like API keys, passwords, and encryption certificates becomes even more critical. This is where Azure Key Vault steps in, offering a robust and centralized solution for managing these vital pieces of information.

What is Azure Key Vault?

Azure Key Vault is a cloud-based service provided by Microsoft Azure that allows you to securely store and manage cryptographic keys, certificates, and secrets. Think of it as a highly secure digital safe deposit box for your application's most sensitive credentials. Instead of embedding these secrets directly into your code, configuration files, or databases, which is a significant security risk, you can store them in Key Vault. Your applications and services can then securely retrieve these secrets at runtime, using managed identities or service principals for authentication, without ever having direct access to the secrets themselves.

The importance of such a service cannot be overstated. A single leaked API key or database password can grant unauthorized access to your entire system, leading to data breaches, financial losses, and reputational damage. Azure Key Vault helps mitigate these risks by providing a dedicated, hardened environment for storing and accessing these sensitive items, ensuring that only authorized applications and users can access them, and only when needed. It also simplifies the management of these secrets, centralizing control and providing auditing capabilities to track who accessed what and when.

This lesson will dive deep into the capabilities of Azure Key Vault, exploring its core components, how to use it effectively, and best practices for maximizing its security benefits. We'll cover everything from creating a Key Vault instance to integrating it with your Azure resources and applications, ensuring you have a comprehensive understanding of this essential Azure security service.

Core Components of Azure Key Vault

Azure Key Vault is built around three primary types of objects that it securely stores and manages: Keys, Secrets, and Certificates. Understanding these components is crucial to leveraging Key Vault effectively.

1. Keys

In Azure Key Vault, "Keys" refer to cryptographic keys. These are the fundamental building blocks for encryption and digital signatures. Key Vault supports two main types of keys:

• Symmetric Keys: These keys use the same secret key for both encryption and decryption. They are generally faster for bulk data encryption.
• Asymmetric Keys: These keys use a pair of keys: a public key for encryption and a private key for decryption, or vice versa for digital signatures. This is useful for secure communication and identity verification.

Key Vault allows you to import your existing keys or generate new ones directly within the service. When you generate keys within Key Vault, they are stored in a Hardware Security Module (HSM) or a software-based protection mechanism, significantly enhancing their security. You can then use these keys for cryptographic operations like encrypting and decrypting data, signing data, and verifying signatures, all performed within Key Vault. This means your private keys never leave the Key Vault boundary, greatly reducing the risk of compromise.

Key Operations Supported:

• Encrypt/Decrypt: Encrypting or decrypting data using the stored key.
• Sign/Verify: Creating or verifying digital signatures using the stored key.
• Wrap/Unwrap Key: Encrypting or decrypting other keys.
• Key Import: Importing existing keys (often from HSMs).
• Key Generation: Generating new keys within Key Vault.

2. Secrets

Secrets are the most common items stored in Key Vault. This category encompasses any sensitive piece of information that your applications might need to access, such as:

• API Keys: Credentials for accessing third-party services (e.g., Stripe, Twilio, Microsoft Graph).
• Connection Strings: Database connection strings, including usernames and passwords.
• Passwords: User passwords or service account passwords.
• SSH Keys: Keys used for secure shell access.
• Other Sensitive Configuration Values: Any string that should not be hardcoded.

When you store a secret in Key Vault, it's stored as a key-value pair. The value is the actual secret string. Key Vault encrypts these secrets at rest and in transit, providing a secure repository. Applications can then retrieve these secrets by making authenticated API calls to Key Vault.

Example Use Case: Imagine your web application needs to connect to a SQL Database. Instead of storing the database password directly in your application's configuration file (appsettings.json in .NET, for example), you would store it as a secret in Azure Key Vault. Your application, running on an Azure service (like App Service or Azure Kubernetes Service), would authenticate to Key Vault using its managed identity and then retrieve the database password secret. This password would then be used to establish the database connection.

3. Certificates

Azure Key Vault can manage Public Key Infrastructure (PKI) certificates. This includes:

• SSL/TLS Certificates: Used for securing web traffic (HTTPS).
• Client Authentication Certificates: Used for authenticating clients to servers.
• Code Signing Certificates: Used for digitally signing software.

Key Vault can store certificates, manage their lifecycle, and automatically renew them before they expire. You can import existing certificates into Key Vault or have Key Vault integrate with trusted Certificate Authorities (like DigiCert) to issue and renew certificates directly. When a certificate is stored in Key Vault, its associated private key is also protected and never leaves the Key Vault boundary. Applications can then retrieve the certificate and its private key securely for use in TLS/SSL handshakes or other cryptographic operations.

Lifecycle Management: A key benefit here is the automated renewal. You can configure Key Vault to automatically renew certificates from integrated CAs. This significantly reduces the operational overhead and the risk of service disruptions due to expired certificates.

Callout: Key Vault vs. Configuration Files The fundamental difference between storing secrets in Key Vault versus embedding them in configuration files (like .env files or appsettings.json) is the security posture. Configuration files are typically stored in source control (even if private repositories) or deployed directly to servers, making them vulnerable to unauthorized access if the repository or server is compromised. Key Vault, on the other hand, is a dedicated, highly secure service designed specifically for managing secrets, with granular access control, encryption at rest and in transit, and audit logging.

Creating and Managing Azure Key Vault

Before you can store secrets, keys, or certificates, you need to create an Azure Key Vault instance. This is typically done through the Azure portal, Azure CLI, or Azure PowerShell.

Creating a Key Vault Instance (Azure Portal)

1. Navigate to Key Vault: In the Azure portal, search for "Key Vaults" and click "Create".
2. Basics Tab:
   • Subscription: Select your Azure subscription.
   • Resource Group: Choose an existing resource group or create a new one.
   • Key Vault Name: Provide a globally unique name for your Key Vault. This name will be part of the Key Vault's URI (e.g., https://your-key-vault-name.vault.azure.net).
   • Region: Select the Azure region where you want to deploy your Key Vault. It's best practice to place it in the same region as the resources that will access it to minimize latency.
   • Pricing Tier: Choose between "Standard" (software-protected keys) and "Premium" (HSM-protected keys). Premium offers higher security for keys but comes at a higher cost.
   • Soft Delete: This is enabled by default and is crucial for recovery. It means that when a Key Vault or its objects are deleted, they are retained for a configurable period (default 90 days) and can be recovered.
   • Purge Protection: This feature, if enabled, prevents an object from being permanently deleted before the soft-delete retention period ends. It adds an extra layer of protection against accidental or malicious deletion.
3. Access Policies Tab: This is where you define who or what can access your Key Vault. You have two main options:
   • Azure Role-Based Access Control (RBAC): This is the recommended approach. You assign Azure roles (like "Key Vault Secrets Officer" or "Key Vault Crypto Officer") to users, groups, or service principals.
   • Access Policies: The older model where you grant specific permissions (e.g., Get, List, Set, Delete) for Keys, Secrets, and Certificates directly on the Key Vault itself.
4. Networking Tab: Configure network access. You can allow access from all networks, selected virtual networks and IP addresses, or restrict it to private endpoints.
5. Firewall Tab: (Similar to Networking) Define IP address ranges or virtual networks that are allowed to access the Key Vault.
6. Tags Tab: Apply tags for organization and billing.
7. Review + Create: Review your settings and click "Create".

Creating a Key Vault Instance (Azure CLI)

# Log in to your Azure account
az login

# Set your subscription (if you have multiple)
az account set --subscription "<your-subscription-id>"

# Create a resource group (if it doesn't exist)
az group create --name "myResourceGroup" --location "eastus"

# Create the Key Vault
az keyvault create --name "myUniqueKeyVaultName" \
                    --resource-group "myResourceGroup" \
                    --location "eastus" \
                    --sku "standard" # or "premium"

This command creates a Key Vault named myUniqueKeyVaultName in the eastus region within the myResourceGroup. The --sku parameter specifies the performance and security tier.

Storing Secrets, Keys, and Certificates

Once your Key Vault is created, you can start populating it.

Storing a Secret (Azure CLI):

az keyvault secret set --vault-name "myUniqueKeyVaultName" \
                         --name "MyDatabasePassword" \
                         --value "SuperSecretPassword123!"

This command stores a secret named MyDatabasePassword with the value SuperSecretPassword123! in your Key Vault.

Storing a Key (Azure CLI - Generate a new RSA key):

az keyvault key create --vault-name "myUniqueKeyVaultName" \
                        --name "MySigningKey" \
                        --kty "RSA" \
                        --size 2048 \
                        --ops "sign" "verify"

This creates an RSA key named MySigningKey with a size of 2048 bits, intended for signing and verification operations.

Storing a Certificate (Azure CLI - Import a PFX file):

az keyvault certificate import --vault-name "myUniqueKeyVaultName" \
                                 --name "MyWebAppCertificate" \
                                 --file "./path/to/your/certificate.pfx" \
                                 --password "certificate-password"

This imports a certificate from a .pfx file.

Retrieving Secrets, Keys, and Certificates

Applications and users need to retrieve these stored items. This is done via authenticated API calls.

Retrieving a Secret (Azure CLI):

az keyvault secret show --vault-name "myUniqueKeyVaultName" --name "MyDatabasePassword"

This command retrieves the secret named MyDatabasePassword. The output will include the secret value (though it's often better to pipe this to a secure configuration system for applications).

Retrieving a Certificate (Azure CLI):

az keyvault certificate show --vault-name "myUniqueKeyVaultName" --name "MyWebAppCertificate"

This retrieves the certificate details.

Integrating Azure Key Vault with Azure Services

The real power of Azure Key Vault comes when you integrate it with other Azure services, allowing them to securely access secrets without explicit credentials managed by you. This is primarily achieved through Managed Identities and Service Principals.

Managed Identities

Managed Identities are a feature of Azure Active Directory (now Microsoft Entra ID). They provide an identity for Azure services in Microsoft Entra ID, enabling them to authenticate to any service that supports Microsoft Entra ID authentication, including Azure Key Vault, without needing credentials in your code.

There are two types of Managed Identities:

1. System-assigned managed identity: Enabled directly on an Azure resource (like a Virtual Machine, App Service, Azure Functions, etc.). The identity is tied to the lifecycle of that resource. If the resource is deleted, the identity is automatically removed.
2. User-assigned managed identity: Created as a standalone Azure resource. It can then be assigned to one or more Azure resources. This is useful for managing identities across multiple resources.

Steps to Use Managed Identity with Key Vault:

1. Enable Managed Identity:
   • For a VM: Go to the VM's settings in the Azure portal, select "Identity", and turn on the "System assigned" managed identity.
   • For App Service: Go to the App Service's settings, select "Identity", and turn on the "System assigned" managed identity.
   • For User-assigned: Create a User-assigned managed identity resource, then assign it to your Azure resource.
2. Grant Access to Key Vault:
   • Navigate to your Azure Key Vault in the Azure portal.
   • Go to "Access policies" or "Access control (IAM)".
   • If using Access Policies: Click "Create" under Access Policies. Select the type of access (e.g., "Secret Permissions: Get, List"). In the "Principal" field, search for the name of the Azure resource (e.g., your VM name or App Service name) for which you enabled the managed identity. Save the policy.
   • If using RBAC (Recommended): Go to "Access control (IAM)" on your Key Vault. Click "Add role assignment". Select a role like "Key Vault Secrets Officer". In the "Assign access to" field, select "Managed identity". Then, select the subscription and the managed identity (system or user-assigned) you want to grant permissions to.
3. Configure Your Application:
   • In your application code, you'll use an Azure SDK library that supports managed identities. The SDK will automatically detect the managed identity of the hosting Azure resource and use it to authenticate to Key Vault. You won't need to embed any client secrets or credentials in your code.

Example (Conceptual C# code for App Service with Managed Identity):

using Azure.Identity;
using Azure.Security.KeyVault.Secrets;
using Microsoft.Extensions.Configuration;
using System;
using System.Threading.Tasks;

// ... inside your application startup or configuration setup ...

// This will automatically use the managed identity of the App Service
var credential = new DefaultAzureCredential();
var secretClient = new SecretClient(new Uri("https://myUniqueKeyVaultName.vault.azure.net/"), credential);

try
{
    KeyVaultSecret secret = await secretClient.GetSecretAsync("MyDatabasePassword");
    string dbConnectionString = secret.Value;

    // Use dbConnectionString to connect to your database
    Console.WriteLine("Successfully retrieved database password.");
}
catch (Exception ex)
{
    Console.WriteLine($"Error retrieving secret: {ex.Message}");
}

In this C# example, DefaultAzureCredential is a powerful credential type that tries multiple authentication methods, including managed identity, environment variables, and Visual Studio login. When running on Azure with a managed identity enabled, it will automatically use that identity to authenticate to Key Vault.

Service Principals

A Service Principal is an identity created for use with applications, hosted services, and automated tools to access Azure resources. It's essentially an application's identity within Microsoft Entra ID. You can grant a service principal specific permissions to access Key Vault.

Steps to Use Service Principal with Key Vault:

1. Create a Service Principal: This can be done using Azure CLI, Azure PowerShell, or by registering an application in Microsoft Entra ID.
   • Azure CLI Example:

     # Create an App Registration and a Service Principal
     az ad app create --display-name "MyKeyVaultApp"
     # Note the appId (client ID) from the output
     # Create a client secret for the Service Principal
     az ad app credential reset --id "<app-id>" --append
     # Note the password (client secret) from the output
     

2. Grant Access to Key Vault:
   • Navigate to your Azure Key Vault.
   • Go to "Access policies" or "Access control (IAM)".
   • Add a new policy or role assignment, specifying the Service Principal's application ID (client ID) and granting it the necessary permissions (e.g., "Get" and "List" for secrets).
3. Configure Your Application:
   • In your application, you'll configure it to authenticate using the Service Principal's credentials:
     • Tenant ID: Your Microsoft Entra ID tenant ID.
     • Client ID: The application ID of your Service Principal.
     • Client Secret: The secret password generated for the Service Principal.

Example (Conceptual C# code using Service Principal):

using Azure.Identity;
using Azure.Security.KeyVault.Secrets;
using Microsoft.Extensions.Configuration;
using System;
using System.Threading.Tasks;

// ... inside your application startup or configuration setup ...

string tenantId = Environment.GetEnvironmentVariable("AZURE_TENANT_ID");
string clientId = Environment.GetEnvironmentVariable("AZURE_CLIENT_ID");
string clientSecret = Environment.GetEnvironmentVariable("AZURE_CLIENT_SECRET");
string vaultUri = "https://myUniqueKeyVaultName.vault.azure.net/";

var credential = new ClientSecretCredential(tenantId, clientId, clientSecret);
var secretClient = new SecretClient(new Uri(vaultUri), credential);

try
{
    KeyVaultSecret secret = await secretClient.GetSecretAsync("MyDatabasePassword");
    string dbConnectionString = secret.Value;

    // Use dbConnectionString to connect to your database
    Console.WriteLine("Successfully retrieved database password.");
}
catch (Exception ex)
{
    Console.WriteLine($"Error retrieving secret: {ex.Message}");
}

Callout: Managed Identity vs. Service Principal Managed Identities are generally preferred when running applications within Azure. They eliminate the need to manage and rotate client secrets for your applications, as the identity is managed by Azure itself. Service Principals are more commonly used for applications running outside of Azure, or for CI/CD pipelines that need to interact with Azure resources.

Best Practices for Azure Key Vault

Using Azure Key Vault effectively involves more than just storing secrets. Adhering to best practices ensures maximum security and manageability.

• Use Managed Identities: Whenever possible, use system-assigned or user-assigned managed identities for Azure resources that need to access Key Vault. This removes the burden of managing client secrets and significantly enhances security.
• Enable Soft Delete and Purge Protection: Always keep Soft Delete enabled (it's the default). This protects against accidental deletion. For critical Key Vaults, enable Purge Protection as an additional safeguard against accidental or malicious permanent deletion.
• Principle of Least Privilege: Grant only the necessary permissions to users and applications. For applications, use RBAC roles like "Key Vault Secrets Officer" or "Key Vault Crypto Officer" and scope them appropriately. Avoid granting broad permissions like "All" or "List" if only "Get" is needed.
• Separate Key Vaults: Consider using separate Key Vault instances for different environments (development, staging, production) and even for different applications or components within an environment. This isolates potential impact if one Key Vault is compromised or misconfigured.
• Regularly Audit Access: Utilize Key Vault's diagnostic logging capabilities to send logs to Azure Monitor, Log Analytics, or Storage Accounts. Regularly review these logs to monitor access patterns, detect suspicious activity, and ensure compliance.
• Manage Certificate Lifecycles: For certificates, leverage Key Vault's integration with Certificate Authorities and its automated renewal capabilities. Set up alerts for upcoming certificate expirations.
• Use HSM-backed Keys for High Security: If your workload involves highly sensitive cryptographic keys (e.g., for regulatory compliance like PCI DSS or HIPAA), use the Premium tier of Key Vault for HSM-backed keys.
• Secure Access to the Key Vault: Restrict network access to your Key Vault using firewall rules and private endpoints. Only allow access from specific IP addresses or virtual networks that genuinely require it.
• Rotate Secrets Regularly: Even with Key Vault, it's good practice to implement a strategy for regularly rotating secrets like database passwords and API keys. Key Vault makes this easier by centralizing management.
• Don't Store Everything: Key Vault is for secrets, keys, and certificates. Avoid storing application configuration settings that aren't sensitive (like UI themes or feature flags) in Key Vault. Use other configuration management services for those.

Common Pitfalls and How to Avoid Them

Even with robust tools like Key Vault, misconfigurations can lead to security vulnerabilities or operational issues.

• Pitfall 1: Hardcoding Credentials: The most common mistake is still embedding secrets directly in application code or configuration files, negating the purpose of Key Vault.
  • Avoidance: Always retrieve secrets from Key Vault at runtime. Use managed identities to simplify this process.
• Pitfall 2: Over-granting Permissions: Giving broad permissions (e.g., "All" for secrets) to applications or users.
  • Avoidance: Adhere strictly to the principle of least privilege. Grant only the specific permissions needed (e.g., Get, List for secrets) and scope them to the specific Key Vault.
• Pitfall 3: Not Enabling Soft Delete/Purge Protection: Accidental deletion of a Key Vault or its contents can lead to permanent data loss if not properly protected.
  • Avoidance: Ensure Soft Delete is always enabled. For critical Key Vaults, enable Purge Protection. Understand the implications and recovery options.
• Pitfall 4: Using the Wrong Pricing Tier: Opting for the Standard tier when HSM-backed keys are required for compliance or high-security needs.
  • Avoidance: Understand your security and compliance requirements. If HSM protection is mandated or desired, choose the Premium tier.
• Pitfall 5: Insecure Network Access: Leaving Key Vault accessible from all networks without firewall rules or private endpoints.
  • Avoidance: Configure network security for your Key Vault. Use private endpoints for maximum isolation when possible, or at least restrict access via IP firewalls.
• Pitfall 6: Forgetting About Certificate Expirations: Relying on manual certificate management when Key Vault offers automation.
  • Avoidance: Leverage Key Vault's certificate management features, including integration with CAs and automated renewals. Set up alerts for upcoming expirations.
• Pitfall 7: Managing Multiple Key Vaults Inconsistently: Lack of a clear strategy for naming, organizing, and applying access policies across different Key Vault instances.
  • Avoidance: Establish clear naming conventions and organizational structures for your Key Vaults (e.g., by environment, by application). Use infrastructure as code (like ARM templates or Terraform) to ensure consistent deployments and configurations.

Warning: Never store your Key Vault client secrets or access keys directly in Key Vault itself! This creates a circular dependency and a critical security risk. Always manage access to Key Vault using Microsoft Entra ID identities (Managed Identities or Service Principals) or secure, out-of-band methods for initial setup.

Key Takeaways

• Centralized Secret Management: Azure Key Vault provides a secure, centralized repository for managing cryptographic keys, secrets (like API keys and connection strings), and certificates.
• Reduced Attack Surface: By storing sensitive information outside of application code and configuration files, Key Vault significantly reduces the risk of accidental exposure and data breaches.
• Enhanced Security Features: Key Vault offers features like HSM-backed key protection (Premium tier), soft delete, purge protection, and granular access control to ensure the highest level of security.
• Simplified Application Integration: Managed Identities allow Azure services to authenticate securely to Key Vault without requiring developers to manage credentials in their code.
• Lifecycle Management: Key Vault simplifies the management of certificates, including automatic renewal, and provides auditing capabilities for all access to stored objects.
• Best Practices are Crucial: Implementing best practices like least privilege, regular auditing, and secure network configurations is essential for maximizing the security benefits of Key Vault.
• Avoid Common Pitfalls: Be aware of common mistakes such as hardcoding credentials, over-granting permissions, and neglecting network security to prevent vulnerabilities.

By understanding and implementing Azure Key Vault effectively, you establish a foundational layer of security for your cloud applications and infrastructure, protecting your most sensitive digital assets.