Azure function for rotation of Storage Account keys with Key Vault
Перейти к файлу
Jack Lichwa ef571d1e1d
Merge pull request #2 from Azure/users/GitHubPolicyService/d39db3db-b738-4fb2-9099-9324c05fec2b
Adding Microsoft SECURITY.MD
2023-02-15 16:25:10 -08:00
AKVStorageAccountRotation Prevent duplicate rotation - duplicate events 2021-01-18 18:02:23 -08:00
AKVStorageAccountRotationHttp update 2020-12-30 22:43:50 -08:00
ARM-Templates Update Readme.md 2021-05-12 20:10:03 -07:00
.deployment Initial commit 2020-12-30 14:55:08 -08:00
.funcignore Initial commit 2020-12-30 14:55:08 -08:00
.gitignore Initial commit 2020-12-30 14:55:08 -08:00
CHANGELOG.md update 2020-12-30 20:05:43 -08:00
CONTRIBUTING.md update 2020-12-30 20:05:43 -08:00
LICENSE.md Initial commit 2020-12-30 14:55:08 -08:00
Project-Template-Instructions.md update 2021-02-15 14:52:25 -08:00
README.md Update README.md 2021-02-15 21:19:33 -08:00
SECURITY.md Microsoft mandatory file 2023-01-24 15:55:34 +00:00
host.json update 2020-12-31 12:09:26 -08:00
profile.ps1 Initial commit 2020-12-30 14:55:08 -08:00
proxies.json Initial commit 2020-12-30 14:55:08 -08:00
requirements.psd1 update 2020-12-30 22:43:50 -08:00

README.md

KeyVault-Secrets-Rotation-StorageAccount-PowerShell

Functions regenerate individual key (alternating between two keys) in Storage Account and add regenerated key to Key Vault as new version of the same secret.

Features

This project framework provides the following features:

  • Rotation function for StorageAccount key triggered by Event Grid (AKVStorageAccountRotation)

  • Rotation function for Storage Account key triggered by HTTP call (AKVStorageAccountRotationHttp)

  • ARM template for function deployment with secret deployment (optional)

  • ARM template for adding storage account key to existing function with secret deployment (optional)

Getting Started

Functions require following information stored in secret as tags:

  • $secret.Tags["ValidityPeriodDays"] - number of days, it defines expiration date for new secret
  • $secret.Tags["CredentialId"] - Storage Account credential id (i.e. key1/key2)
  • $secret.Tags["ProviderAddress"] - Storage Account Resource Id

You can create new secret with above tags and Storage Account key as value or add those tags to existing secret with Storage Account key. For automated rotation expiry date will also be required - key vault triggers 'SecretNearExpiry' event 30 days before expiry.

There are two available functions performing rotation:

  • AKVStorageAccountRotation - event triggered function, performs storage account key rotation triggered by Key Vault events. In this setup Near Expiry event is used which is published 30 days before expiration
  • AKVStorageAccountRotationHttp - on-demand function with KeyVaultName and Secret name as parameters

Functions are using Function App identity to access Key Vault and existing secret "CredentialId" tag with storage account key id (key1/key2) and "ProviderAddress" with Storage Account Resource Id.

Installation

ARM templates available:

Demo

You can find example for Storage Account rotation in tutorial below: Automate the rotation of a secret for resources that have two sets of authentication credentials

Youtube: https://youtu.be/qcdVbXJ7e-4

This project was generated using this template. You can find instructions here