Skip to content
This repository has been archived by the owner on Oct 15, 2024. It is now read-only.

Latest commit

 

History

History
171 lines (124 loc) · 11.5 KB

README.md

File metadata and controls

171 lines (124 loc) · 11.5 KB
Raw

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:

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

  1. Set either a new resource group or use an existing resource group in main.tf (it defaults to the existing OWASP-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.
  2. check whether you have the right project by doing az account show (after az login). Want to set the project as your default? Use az account set --subscription <.id here>.
  3. 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
  4. Run terraform init (if required, use tfenv to select TF 0.14.0 or higher )
  5. Run terraform plan to see what will be created (optional).
  6. Run terraform apply. Note: the apply will take 5 to 20 minutes depending on the speed of the Azure backplane.
  7. Run ./k8s-vault-azure-start.sh. Your kubeconfig file will automatically be updated.
  8. (Optional) To make the app available over a load balancer, run kubectl apply -f ./k8s/lb.yml, then look for the public IP using kubectl 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:

  1. Kill the port forward.
  2. Run terraform destroy to clean up the infrastructure. Note that you may need to repeat the destroy to fully clean up.
  3. If you've used the shared state, cd to the shared-state folder and run terraform destroy there too.
  4. Run rm terraform.tf* to remove local state files.

A few things to consider

  1. Does your worker node now have access as well?
  2. Can you easily obtain the AKS managed identity of the Node?
  3. Can you get the secrets in the Key vault? Which paths do you see?

Running Terratest

Want to see if the setup still works? You can use terratest to check if the current setup works via automated terratest tests, for this you need to make sure that you have installed terraform and Go version 1.21. Next, you will need to install the modules and set up credentials.

  1. Run go mod download
  2. Run az login and make sure you are on the right subscription. If necessary, use az account list and az account set --subscription <your-subscription-id-here>.
  3. Run go test -timeout 99999s. The default timeout is 10 min, which is too short for our purposes. We need to override that.

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.83.0
http ~> 3.4.0
random ~> 3.5.1

Providers

Name Version
azurerm 3.83.0
http 3.4.0
random 3.5.1

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.27" 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