I am learning Pulumi and I'll be sharing my journey along the way here in the form of blog posts and code samples on my GitHub. Join me on this journey if this topic interests you.
Disclaimer: I have hands-on experience working with Microsoft Azure Cloud platform not so much with others. So in here, I'll be looking at Pulumi from Azure's lens and most of my references and examples will be with Azure.
If you haven't read my previous blog posts around this topic, you can check them out here:
In this blog post, I'm going to explore and understand how Pulumi manages secrets.
We will build on the Configuration Management blog post that I wrote earlier so please have a look if you haven't done so already.
Having sensitive information such as Passwords, API Keys, Tokens, ConnectionStrings etc. is quite common for any application. However keeping them in your source code in plaintext is never a good idea, let alone checking it in your source control.
Pulumi's configuration system lets us add secrets to our configuration in a similar way we manage any other configuration. Pulumi offers multiple approaches to manage sensitive information and exposes a number of APIs and tools we can use to work with them seamlessly, so without further a do, let's explore how it all works.
First off, let's see how can we set secrets in our configuration.
pulumi config set with
--secret flag to set a secret
pulumi config set --secret mySecretKey mySecretValue
Check the config
To retrieve the secrets programmatically, the use of
RequireSecrets variant is recommended.
see the value is masked
If we look at the
Pulumi.dev.yaml file in VSCode, this is what we see:
config: azure:location: australiaeast hello-pulumi:data: active: true nums: - 1 - 2 - 3 hello-pulumi:location: australiasoutheast hello-pulumi:mySecretKey: secure: AAABAFybCK/w34qectPQHPWSoivUhG7uI5//y7Xqc/6Cczh3k3Yi35zvrk+U hello-pulumi:resourcesName: pulumi
Looking at this, what we see is that the configuration we set as a secret is not stored in plaintext, it is in fact encrypted. By default, Pulumi uses per-stack encryption key managed by the Pulumi Service to encrypt values.
However, this might not be desirable in situations where you want to manage the state by yourself by using any external storage like S3 bucket, Azure Blob storage. Or you simply don't want Pulumi to manage the keys and would prefer keeping that control and management with you. For such scenarios, Pulumi supports multiple providers for secrets management.
As of this writing, these are the supported providers:
default provider in our examples above.
passphrase allows you to keep the encryption keys to yourself but still use Pulumi's backend service for state management OR you are self-managing the state storage (e.g., Azure Storage). The last option is where you are completely managing your own keys (bring your own key a.k.a BYOK)
Let's create a new stack in our codebase that we used in the previous blogpost (grab the core here)
pulumi stack init passphrasestack --secrets-provider passphrase
or create a new project
pulumi new azure-csharp --secrets-provider passphrase
It'll ask for the passphrase. This is the passphrase that Pulumi is going to use to encrypt the configuration system.
Looking at the project in VSCode, we can see a new file has been created
Let's add two keys (one normal and one secret)
pulumi config set normalKey normalValue
pulumi config set --secret secretKey secretValue
This is how our stack file looks like
If you pay attention, the secure value in
Pulumi.passphrasestack.yaml is different to what we had in
Notice, we need to enter the passphrase every time we are performing any operations. This can be avoided by setting
PULUMI_CONFIG_PASSPHRASE in your environment variables (can be done on the local machine or in the CI system).
Using Azure Key Vault for encryption
This would be a similar approach for any other cloud-based provider but we are looking at Azure Key Vault here.
In order to use the Azure Key Vault for managing the encryption keys, the approach is same i.e., we set
--secret-provider to Azure Key Vault via the CLI
$ pulumi stack init <name> --secrets-provider="<provider>://<provider-settings>"
$ pulumi stack init <name> --secrets-provider="azurekeyvault://<keyvaultname>.vault.azure.net/keys/<key name>"
Before we could do this, we need to create the Key Vault and a Key in the vault that we need.
Create Azure Key Vault
az keyvault create --name pulumiazvault --resource-group rg-pulumi-dev --location australiasoutheast
Create the Key in Vault
az keyvault key create --name pulumiencryptionkey --vault-name pulumiazvault
When you create the vault and key from the CLI, a policy is created by default but it doesn't set 'encrypt' and 'decrypt' policy for us, so use this command to include that.
Extract Object Id of your account (you can pull this from Azure AD or run the command below to extract it. Use your account here)
az ad user show --id <your account name>
Look up for ObjectId of your account
az keyvault set-policy --name pulumiazvault --object-id <Object Id from above> --key-permissions encrypt decrypt get create delete list update import backup restore recover
I prefer using Azure AD Application instead of any individual user account for such scenarios. In that case you will need the ObjectId of the application instead
Now we have the key vault with a key that we will use for encryption along with the right access policy set.
Set Environment Variables
You can set this if you want to use the credentials from the CLI (that you already have set up).
Checkout Azure Environment Authentication if you wish to use other authentication mechanism such as Client Credentials, Username/Password etc.
I prefer using Client Credentials since I'm using Azure AD Application approach
Create a new stack
I'm creating a new project for this scenario rather than using the previous one but you could very well create a new stack in the same project that uses Azure key Vault provider.
pulumi new azure-csharp --secrets-provider="azurekeyvault://pulumiazvault.vault.azure.net/keys/pulumiencryptionkey"
Pulumi.dev.yaml files looks like this after creating the new project. As you notice, we have the information about secrets provider and encryption key. From this point onward, Pulumi uses this information to encrypt the configuration system for us.
secretsprovider: azurekeyvault://pulumiazvault.vault.azure.net/keys/pulumiencryptionkey encryptedkey: N1JsSnFjWGpKUl9jY3U1SlRQd2J2WXd3TEw0XzQxeWExY2hTOEhtLTRKWkd3cTViblg3OWF4VHFTcDY4amo4RDc4RUxyT3poNC0tUEVSM0ppbUxfcUdiN1dOWm9Cb0VrNU5TODF6dUlMVEg3c2VVc1ItTVZfRjFBQWpmdGNiX29xYU1BdTN2d0NlMmtWUWFUWUc0NjNJMnh4eUNybzdJMzlXZHdXMVRpODh4TnZfdDM1R2pfdS1rS3VlQlh5cDI4OXZmMkxXaFFuNzNBckJaRU9vcnl5WmJPeUVXMHpJSzlIOEZXOG5WTnl6akFXYmxWYkkyYVB6c3BsUWpDOGw5OFRJNXFyV0JBSjAybHVkTE9UMGF6MllqSW4xbm9GVW1pODRsbVJZbEh6OThPLUdBemlhcWp4V1dKaE5vN0NDeEFZdFM2cXk3emozSDI0UHlGQllESTdR config: azure:location: australiasoutheast
Rest of the things works the same as
passphrase provider for encryption.
Switching Encryption providers
You change the secrets provider of any of your stack anytime via this command.
pulumi stack change-secrets-provider "<secrets-provider>"
It's pretty straightforward, once the provider is changed, Pulumi will use the new secrets provider to encrypt configuration and state files.
Pulumi provides a robust mechanism for configuration management of your infrastructure. It provides support for handling secrets as well. You have the possibility to use external service providers for secrets management such as Azure Key Vault by using a familiar approach. The default option is secure and configurations and secrets are encrypted by the keys that Pulumi manages for us however we have the flexibility to take ownership of this and go to that extra mile for enhanced security or compliance reasons.
You can find the source code for this blog post here
comments powered by Disqus