Skip to content

Commit

Permalink
Add policy pack - Azure VNets have flow log enabled. Closes #893
Browse files Browse the repository at this point in the history
  • Loading branch information
vkumbha committed Dec 23, 2024
1 parent b0665c8 commit 0d5d423
Show file tree
Hide file tree
Showing 4 changed files with 172 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
categories: ["logging", "networking"]
primary_category: "networking"
type: "featured"
---

# Check Azure Virtual Networks Have Flow Logs Enabled

Ensure that Azure Virtual Networks have flow logs configured and enabled to monitor and analyze network traffic. Flow logs capture information about IP traffic flowing in and out of network interfaces in the virtual network. This helps detect anomalies, troubleshoot issues, and maintain compliance with security best practices and regulatory requirements.

This [policy pack](https://turbot.com/guardrails/docs/concepts/policy-packs) can help you configure the following settings for network security groups:

- Check if flow logs are configured for Azure Virtual Networks
- Validate that flow logging status is enabled

**[Review policy settings →](https://hub.guardrails.turbot.com/policy-packs/azure_network_check_virtual_networks_have_flowlog_enabled/settings)**

## Getting Started

### Requirements

- [Terraform](https://developer.hashicorp.com/terraform/install)
- Guardrails mods:
- [@turbot/azure-network](https://hub.guardrails.turbot.com/mods/azure/mods/azure-network)
- [@turbot/azure-networkwatcher](https://hub.guardrails.turbot.com/mods/azure/mods/azure-networkwatcher)

### Credentials

To create a policy pack through Terraform:

- Ensure you have `Turbot/Admin` permissions (or higher) in Guardrails
- [Create access keys](https://turbot.com/guardrails/docs/guides/iam/access-keys#generate-a-new-guardrails-api-access-key) in Guardrails

And then set your credentials:

```sh
export TURBOT_WORKSPACE=myworkspace.acme.com
export TURBOT_ACCESS_KEY=acce6ac5-access-key-here
export TURBOT_SECRET_KEY=a8af61ec-secret-key-here
```

Please see [Turbot Guardrails Provider authentication](https://registry.terraform.io/providers/turbot/turbot/latest/docs#authentication) for additional authentication methods.

## Usage

### Install Policy Pack

> [!NOTE]
> By default, installed policy packs are not attached to any resources.
>
> Policy packs must be attached to resources in order for their policy settings to take effect.
Clone:

```sh
git clone https://github.com/turbot/guardrails-samples.git
cd guardrails-samples/policy_packs/azure/network/check_virtual_networks_have_flowlog_enabled
```

Run the Terraform to create the policy pack in your workspace:

```sh
terraform init
terraform plan
```

Then apply the changes:

```sh
terraform apply
```

### Apply Policy Pack

Log into your Guardrails workspace and [attach the policy pack to a resource](https://turbot.com/guardrails/docs/guides/policy-packs#attach-a-policy-pack-to-a-resource).

If this policy pack is attached to a Guardrails folder, its policies will be applied to all accounts and resources in that folder. The policy pack can also be attached to multiple resources.

For more information, please see [Policy Packs](https://turbot.com/guardrails/docs/concepts/policy-packs).
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
resource "turbot_policy_pack" "main" {
title = "Check Flow Log Is Enabled for Azure Virtual Networks"
description = "Ensure that logging is enabled for Azure Virtual Networks to monitor traffic and maintain security compliance."
akas = ["azure_network_check_virtual_networks_have_flowlog_enabled"]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# Azure > Network > Virtual Network > Approved
resource "turbot_policy_setting" "azure_network_virtual_network_approved" {
resource = turbot_policy_pack.main.id
type = "tmod:@turbot/azure-network#/policy/types/virtualNetworkApproved"
value = "Check: Approved"
}

# Azure > Network > Virtual Network > Approved > Usage
resource "turbot_policy_setting" "azure_network_virtual_network_approved_usage" {
resource = turbot_policy_pack.main.id
type = "tmod:@turbot/azure-network#/policy/types/virtualNetworkApprovedUsage"
value = "Approved"
}

# Azure > Network > Virtual Network > Approved > Custom
resource "turbot_policy_setting" "azure_network_virtual_network_approved_custom" {
resource = turbot_policy_pack.main.id
type = "tmod:@turbot/azure-network#/policy/types/virtualNetworkApprovedCustom"
template_input = <<-EOT
- |
{
resource {
name:get(path:"name")
flowLogs:get(path:"flowLogs")
}
}
- |
{
resource {
name:get(path:"name")
flowLogs:get(path:"flowLogs")
}
resources(filter:"resourceTypeId:tmod:@turbot/azure-networkwatcher#/resource/types/flowLog $.id:'{{ $.resource.flowLogs[0].id }}'"){
items {
enabled:get(path:"enabled")
id:get(path:"id")
name:get(path:"name")
}
}
}
EOT
template = <<-EOT
{%- set virtualNetworkFlowLogs = $.resource.flowLogs %}
{%- set subscriptionFlowLogs = $.resources.items %}
{%- if virtualNetworkFlowLogs and virtualNetworkFlowLogs | length > 0 %}
{%- for vnetFlowLog in virtualNetworkFlowLogs %}
{%- set matchedFlowLog = null %}
{%- for subscriptionFlowLog in subscriptionFlowLogs %}
{%- if subscriptionFlowLog.id == vnetFlowLog.id %}
{%- set matchedFlowLog = subscriptionFlowLog %}
{%- endif %}
{%- endfor %}
{%- if matchedFlowLog %}
{%- if matchedFlowLog.enabled %}
- title: Flow Log
result: Approved
message: "Flow log '{{ matchedFlowLog.name }}' is configured"
{%- else %}
- title: Flow Log
result: Not approved
message: "Flow log '{{ matchedFlowLog.name }}' is configured but currently disabled"
{%- endif %}
{%- else %}
- title: Flow Log
result: Not approved
message: "Flow log is configured, but the resource '{{ vnetFlowLog.id.split('/').pop() }}' is not in CMDB. Please run the Flow Log Discovery controls within the Subscription"
{%- endif %}
{%- endfor %}
{%- else %}
- title: Flow Log
result: Not approved
message: "Flow log is not configured"
{%- endif %}
EOT
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
terraform {
required_providers {
turbot = {
source = "turbot/turbot"
version = ">= 1.11.0"
}
}
}

provider "turbot" {
}

0 comments on commit 0d5d423

Please sign in to comment.