Setup your secrets in Azure
In this setup we integrate the secrets exercise with Azure AKS and let pods consume secrets from an Azure Key Vault. If you want to know more about integrating secrets with AKS, check this link. Please make sure that the account in which you run this exercise has either Log Analytics enabled, or is not linked to your current subscriptions and/or DTAP environment.
Pre-requisites
Have the following tools installed:
- az CLI - Installation
- Tfenv (Optional) - Installation
- Terraform CLI - Installation
- Wget - Installation
- Helm Installation
- Kubectl Installation
- jq Installation
Make sure you have an active subscription at Azure for which you have configured the credentials on the system where you will execute the steps below.
Please note that this setup relies on bash scripts that have been tested in MacOS and Linux. We have no intention of supporting vanilla Windows at the moment.
Installation
Note-I: We create resources in east us
by default. You can set the region by editing terraform.tfvars
.
Note-II: The cluster you create has its access bound to the public IP of the creator. In other words: the cluster you create with this code has its access bound to your public IP-address if you apply it locally.
(Optional) Multi-user setup: shared state
If you want to host a multi-user setup, you will probably want to share the state file so that everyone can try related challenges. We have provided a starter to easily do so using an Azure storage container.
First, enable the Microsoft.Storage
API (if it isn't already) using:
az provider register --namespace Microsoft.Storage
Then, apply the Terraform (optionally add -var="region=YOUR_DESIRED_REGION"
to the apply to use a region other than the default East US
):
cd shared-state
terraform init
terraform apply
The storage account name should be in the output. Please use that to configure the Terraform backend in main.tf
by uncommenting the part on the backend "azurerm"
.
Note: You'll need to follow the description below for the "existing resource group" i.e., use the data.azurerm_resource_group.default
resource.
WrongSecrets
- Set either a new resource group or use an existing resource group in
main.tf
(it defaults to the existingOWASP-Projects
resource group). Note that you'll need to find/replace references to "data.azurerm_resource_group.default" to "arurerm_resource_group.default" if you want to create a new one. - check whether you have the right project by doing
az account show
(afteraz login
). Want to set the project as your default? Useaz account set --subscription <.id here>
. - If not yet enabled, register the required services for the subscription, run:
az provider register --namespace Microsoft.ContainerService
az provider register --namespace Microsoft.KeyVault
az provider register --namespace Microsoft.ManagedIdentity
- Run
terraform init
(if required, usetfenv
to select TF 0.14.0 or higher ) - Run
terraform plan
to see what will be created (optional). - Run
terraform apply
. Note: the apply will take 5 to 20 minutes depending on the speed of the Azure backplane. - Run
./k8s-vault-azure-start.sh
. Your kubeconfig file will automatically be updated. - (Optional) To make the app available over a load balancer, run
kubectl apply -f ./k8s/lb.yml
, then look for the public IP usingkubectl describe service wrongsecrets-lb
. The app should be available on HTTP port 80 within a few minutes.
Your AKS cluster should be visible in your resource group. Want a different region? You can modify terraform.tfvars
or input it directly using the region
variable in plan/apply.
Are you done playing? Please run terraform destroy
twice to clean up.
Test it
Run ./k8s-vault-azure-start.sh
and connect to http://localhost:8080 when it's ready to accept connections (you'll read the line Forwarding from 127.0.0.1:8080 -> 8080
in your console). Now challenge 9 and 10 should be available as well.
Resume it
When you stopped the k8s-vault-azure-start.sh
script and want to resume the port forward run: k8s-vault-azure-resume.sh
. This is because if you run the start script again it will replace the secret in the vault and not update the secret-challenge application with the new secret.
Clean it up
When you're done:
- Kill the port forward.
- Run
terraform destroy
to clean up the infrastructure. Note that you may need to repeat the destroy to fully clean up. - If you've used the shared state,
cd
to theshared-state
folder and runterraform destroy
there too. - Run
rm terraform.tf*
to remove local state files.
A few things to consider
- Does your worker node now have access as well?
- Can you easily obtain the AKS managed identity of the Node?
- Can you get the secrets in the Key vault? Which paths do you see?
Terraform documentation
The documentation below is auto-generated to give insight on what's created via Terraform.
Requirements
Name | Version |
---|---|
terraform | ~> 1.1 |
azurerm | ~> 3.50.0 |
http | ~> 3.2.1 |
random | ~> 3.4.3 |
Providers
Name | Version |
---|---|
azurerm | 3.50.0 |
http | 3.2.1 |
random | 3.4.3 |
Modules
No modules.
Resources
Name | Type |
---|---|
azurerm_key_vault.vault | resource |
azurerm_key_vault_access_policy.extra_identity_access | resource |
azurerm_key_vault_access_policy.identity_access | resource |
azurerm_key_vault_access_policy.user | resource |
azurerm_key_vault_secret.wrongsecret_1 | resource |
azurerm_key_vault_secret.wrongsecret_2 | resource |
azurerm_key_vault_secret.wrongsecret_3 | resource |
azurerm_kubernetes_cluster.cluster | resource |
azurerm_resource_group.default | resource |
azurerm_role_assignment.aks_extra_identity_operator | resource |
azurerm_role_assignment.aks_identity_operator | resource |
azurerm_role_assignment.aks_vm_contributor | resource |
azurerm_user_assigned_identity.aks_extra_pod_identity | resource |
azurerm_user_assigned_identity.aks_pod_identity | resource |
random_integer.suffix | resource |
random_password.password | resource |
random_string.suffix | resource |
azurerm_client_config.current | data source |
http_http.ip | data source |
Inputs
Name | Description | Type | Default | Required |
---|---|---|---|---|
cluster_name | The AKS cluster name | string | "wrongsecrets-exercise-cluster" | no |
cluster_version | The AKS cluster version to use | string | "1.25" | no |
region | The Azure region to use | string | "East US" | no |
Outputs
Name | Description |
---|---|
aad_extra_pod_identity_client_id | Client ID for the Managed Identity for AAD Pod Identity |
aad_extra_pod_identity_resource_id | Resource ID for the Managed Identity for AAD Pod Identity |
aad_pod_identity_client_id | Client ID for the Managed Identity for AAD Pod Identity |
aad_pod_identity_resource_id | Resource ID for the Managed Identity for AAD Pod Identity |
cluster_name | AKS Cluster name |
key_vault_url | Azure KeyVault URI for the Demo Container |
resource_group | Resource group name |
tenant_id | Azure tenant ID |
vault_name | Vault name |
vault_uri | Vault URI |