Merge pull request #17 from Ontotext-AD/TES-358-key-vault-security

TES-358: Added Key Vault NACLs

main.tf

@@ -51,13 +51,15 @@ resource "azurerm_subnet" "graphdb-gateway" {
   resource_group_name  = azurerm_resource_group.graphdb.name
   virtual_network_name = azurerm_virtual_network.graphdb.name
   address_prefixes     = var.app_gateway_subnet_address_prefix
+  service_endpoints    = ["Microsoft.KeyVault"]
 }
 
 resource "azurerm_subnet" "graphdb-vmss" {
   name                 = "${var.resource_name_prefix}-vmss"
   resource_group_name  = azurerm_resource_group.graphdb.name
   virtual_network_name = azurerm_virtual_network.graphdb.name
   address_prefixes     = var.graphdb_subnet_address_prefix
+  service_endpoints    = ["Microsoft.KeyVault"]
 }
 
 resource "azurerm_network_security_group" "graphdb-gateway" {
@@ -144,6 +146,9 @@ module "vault" {
   location             = var.location
   resource_group_name  = azurerm_resource_group.graphdb.name
 
+  nacl_subnet_ids = [azurerm_subnet.graphdb-gateway.id, azurerm_subnet.graphdb-vmss.id]
+  nacl_ip_rules   = var.management_cidr_blocks
+
   tags = local.tags
 }
 
@@ -281,20 +286,18 @@ module "vm" {
   depends_on = [module.configuration]
 }
 
+# Creates a storage account for storing GraphDB backups
 module "backup" {
   source = "./modules/backup"
 
-  resource_name_prefix             = var.resource_name_prefix
-  resource_group_name              = azurerm_resource_group.graphdb.name
-  storage_account_tier             = var.storage_account_tier
-  storage_account_replication_type = var.storage_account_replication_type
+  resource_name_prefix = var.resource_name_prefix
+  location             = var.location
+  resource_group_name  = azurerm_resource_group.graphdb.name
+
   identity_name                    = module.identity.identity_name
-  location                         = var.location
   identity_principal_id            = module.identity.identity_principal_id
+  storage_account_tier             = var.storage_account_tier
+  storage_account_replication_type = var.storage_account_replication_type
 
   tags = local.tags
-
-  depends_on = [
-    azurerm_resource_group.graphdb
-  ]
 }

modules/backup/main.tf

@@ -1,6 +1,27 @@
+resource "random_string" "storage_account_name_suffix" {
+  length  = 6
+  lower   = true
+  numeric = false
+  special = false
+  upper   = false
+}
+
+locals {
+  # Storage account names have very specific naming restrictions
+
+  # Remove all non alphanumeric characters
+  sanitized = replace(var.resource_name_prefix, "/[^a-zA-Z0-9]/", "")
+
+  # Trim down to 18 characters to allow the random suffix of 6
+  trimmed = lower(substr(local.sanitized, 0, 18))
+
+  # Create storage account name with unique suffix
+  storage_account_name = "${local.trimmed}${random_string.storage_account_name_suffix.result}"
+}
+
 # Create an Azure Storage Account for backups
-resource "azurerm_storage_account" "backup" {
-  name                      = "${var.resource_name_prefix}2graphdbbackup"
+resource "azurerm_storage_account" "graphdb-backup" {
+  name                      = local.storage_account_name
   resource_group_name       = var.resource_group_name
   location                  = var.location
   account_tier              = var.storage_account_tier
@@ -12,28 +33,28 @@ resource "azurerm_storage_account" "backup" {
 }
 
 # Create an Azure Storage container
-resource "azurerm_storage_container" "backup" {
+resource "azurerm_storage_container" "graphdb-backup" {
   name                  = "${var.resource_name_prefix}-backup"
-  storage_account_name  = azurerm_storage_account.backup.name
+  storage_account_name  = azurerm_storage_account.graphdb-backup.name
   container_access_type = "private"
 }
 
 # Create an Azure Storage blob
-resource "azurerm_storage_blob" "backup" {
+resource "azurerm_storage_blob" "graphdb-backup" {
   name                   = "${var.resource_name_prefix}-backup"
   type                   = "Block"
-  storage_account_name   = azurerm_storage_account.backup.name
-  storage_container_name = azurerm_storage_container.backup.name
+  storage_account_name   = azurerm_storage_account.graphdb-backup.name
+  storage_container_name = azurerm_storage_container.graphdb-backup.name
 }
 
-resource "azurerm_role_assignment" "backup" {
+resource "azurerm_role_assignment" "graphdb-backup" {
   principal_id         = var.identity_principal_id
   role_definition_name = "Storage Blob Data Contributor"
-  scope                = azurerm_storage_account.backup.id
+  scope                = azurerm_storage_account.graphdb-backup.id
 }
 
-resource "azurerm_storage_management_policy" "retention" {
-  storage_account_id = azurerm_storage_account.backup.id
+resource "azurerm_storage_management_policy" "graphdb-backup-retention" {
+  storage_account_id = azurerm_storage_account.graphdb-backup.id
 
   rule {
     enabled = true

modules/backup/outputs.tf

@@ -1,8 +1,9 @@
 output "storage_account_name" {
   description = "Storage account name for storing GraphDB backups"
-  value       = azurerm_storage_account.backup.name
+  value       = azurerm_storage_account.graphdb-backup.name
 }
 
 output "container_name" {
-  value = azurerm_storage_container.backup.name
+  description = "Name of the storage container for GraphDB backups"
+  value       = azurerm_storage_container.graphdb-backup.name
 }

modules/backup/variables.tf

@@ -1,41 +1,47 @@
+# Common configurations
+
 variable "resource_name_prefix" {
   description = "Resource name prefix used for tagging and naming Azure resources"
   type        = string
 }
 
-variable "resource_group_name" {
-  description = "Specifies the name of the Azure resource group in which the Azure Storage Account will be created"
-  type        = string
-}
-
-variable "storage_account_tier" {
-  default     = "Standard"
-  description = "Specify the performance and redundancy characteristics of the Azure Storage Account that you are creating"
+variable "location" {
+  description = "Azure geographical location where resources will be deployed"
   type        = string
 }
 
-variable "storage_account_replication_type" {
-  default     = "LRS"
-  description = "Specify the data redundancy strategy for your Azure Storage Account"
-}
-
 variable "tags" {
   description = "Common resource tags."
   type        = map(string)
   default     = {}
 }
 
-variable "identity_name" {
-  description = "Name of a user assigned identity for assigning permissions"
+variable "resource_group_name" {
+  description = "Specifies the name of the Azure resource group in which the Azure Storage Account will be created"
   type        = string
 }
 
-variable "location" {
-  description = "Azure geographical location where resources will be deployed"
+# Identity
+
+variable "identity_name" {
+  description = "Name of a user assigned identity for assigning permissions"
   type        = string
 }
 
 variable "identity_principal_id" {
   description = "Principal identifier of a user assigned identity for assigning permissions"
   type        = string
 }
+
+# Storage specifics
+
+variable "storage_account_tier" {
+  default     = "Standard"
+  description = "Specify the performance and redundancy characteristics of the Azure Storage Account that you are creating"
+  type        = string
+}
+
+variable "storage_account_replication_type" {
+  default     = "LRS"
+  description = "Specify the data redundancy strategy for your Azure Storage Account"
+}

modules/configuration/main.tf

@@ -35,8 +35,8 @@ resource "azurerm_key_vault_secret" "graphdb-cluster-token" {
 resource "azurerm_key_vault_secret" "graphdb-password" {
   key_vault_id = var.key_vault_id
 
-  name  = var.graphdb_cluster_token_name
-  value = base64encode(local.graphdb_cluster_token)
+  name  = var.graphdb_password_secret_name
+  value = base64encode(local.graphdb_password)
 
   tags = var.tags
 }

modules/configuration/variables.tf

@@ -37,16 +37,22 @@ variable "graphdb_cluster_token" {
   default     = null
 }
 
+variable "graphdb_cluster_token_name" {
+  description = "Name of the Key Vault secret that contains the GraphDB cluster secret token."
+  type        = string
+  default     = "graphdb-cluster-token"
+}
+
 variable "graphdb_password" {
-  description = "Secret token used to access GraphDB cluster."
+  description = "Administrator credentials for accessing GraphDB"
   type        = string
   default     = null
 }
 
-variable "graphdb_cluster_token_name" {
-  description = "Name of the Key Vault secret that contains the GraphDB cluster secret token."
+variable "graphdb_password_secret_name" {
+  description = "Name of the Key Vault secret that contains the GraphDB administrator credentials"
   type        = string
-  default     = "graphdb-cluster-token"
+  default     = "graphdb-password"
 }
 
 variable "graphdb_properties_path" {

modules/vault/main.tf

@@ -13,7 +13,6 @@ locals {
   vault_name = "${var.resource_name_prefix}-${random_string.vault_name_suffix.result}"
 }
 
-# TODO: Improve the security of the vault (non-public + nacl + network firewall)
 resource "azurerm_key_vault" "graphdb" {
   name                = local.vault_name
   resource_group_name = var.resource_group_name
@@ -23,6 +22,13 @@ resource "azurerm_key_vault" "graphdb" {
   sku_name                  = "standard"
   enable_rbac_authorization = true
 
+  network_acls {
+    bypass                     = "AzureServices"
+    default_action             = "Deny"
+    virtual_network_subnet_ids = var.nacl_subnet_ids
+    ip_rules                   = var.nacl_ip_rules
+  }
+
   tags = var.tags
 }
 

modules/vault/variables.tf

@@ -1,3 +1,5 @@
+# Common configurations
+
 variable "resource_name_prefix" {
   description = "Resource name prefix used for tagging and naming Azure resources"
   type        = string
@@ -18,3 +20,17 @@ variable "resource_group_name" {
   description = "Name of the resource group where GraphDB will be deployed."
   type        = string
 }
+
+# Networking
+
+variable "nacl_subnet_ids" {
+  description = "List of subnet identifiers allowed to access the key vault internally over a service link"
+  type        = list(string)
+  default     = []
+}
+
+variable "nacl_ip_rules" {
+  description = "List of CIDR blocks allowed to access the key vault from the internet"
+  type        = list(string)
+  default     = []
+}

modules/vm/main.tf

@@ -86,7 +86,7 @@ resource "azurerm_monitor_autoscale_setting" "graphdb-autoscale-settings" {
 }
 
 resource "azurerm_role_definition" "managed_disk_manager" {
-  name        = "ManagedDiskManager"
+  name        = "${var.resource_name_prefix}-ManagedDiskManager"
   scope       = var.resource_group_id
   description = "This is a custom role created via Terraform required for creating data disks for GraphDB"
 
@@ -112,12 +112,12 @@ resource "azurerm_role_definition" "managed_disk_manager" {
 resource "azurerm_role_assignment" "rg-contributor-role" {
   principal_id         = var.identity_principal_id
   scope                = var.resource_group_id
-  role_definition_name = "ManagedDiskManager"
+  role_definition_name = "${var.resource_name_prefix}-ManagedDiskManager"
   depends_on           = [azurerm_role_definition.managed_disk_manager]
 }
 
 resource "azurerm_role_definition" "backup_role" {
-  name        = "ReadOnlyVMSSStorageRole"
+  name        = "${var.resource_name_prefix}-ReadOnlyVMSSStorageRole"
   scope       = var.resource_group_id
   description = "This is a custom role created via Terraform required for creating backups in GraphDB"
 
@@ -137,7 +137,7 @@ resource "azurerm_role_definition" "backup_role" {
 resource "azurerm_role_assignment" "rg-reader-role" {
   principal_id         = var.identity_principal_id
   scope                = var.resource_group_id
-  role_definition_name = "ReadOnlyVMSSStorageRole"
+  role_definition_name = "${var.resource_name_prefix}-ReadOnlyVMSSStorageRole"
   depends_on           = [azurerm_role_definition.backup_role]
 }