azure_policy_audit.pt

name "Azure Policy Audit"
rs_pt_ver 20180301
type "policy"
short_description "This policy checks to see if a list of user-specified Azure Policies exist in each Azure Subscription. See the [README](https://github.com/flexera-public/policy_templates/tree/master/compliance/azure/azure_policy_audit) and [docs.flexera.com/flexera/EN/Automation](https://docs.flexera.com/flexera/EN/Automation/AutomationGS.htm) to learn more."
long_description ""
category "Compliance"
severity "medium"
default_frequency "daily"
info(
  version: "3.0.1",
  provider: "Azure",
  service: "IAM",
  policy_set: "Identity & Access Management",
  hide_skip_approvals: "true"
)

###############################################################################
# Parameters
###############################################################################

parameter "param_email" do
  type "list"
  category "Policy Settings"
  label "Email Addresses"
  description "A list of email addresses to notify."
  default []
end

parameter "param_azure_endpoint" do
  type "string"
  category "Policy Settings"
  label "Azure Endpoint"
  description "Select the API endpoint to use for Azure. Use default value of management.azure.com unless using Azure China."
  allowed_values "management.azure.com", "management.chinacloudapi.cn"
  default "management.azure.com"
end

parameter "param_subscriptions_allow_or_deny" do
  type "string"
  category "Filters"
  label "Allow/Deny Subscriptions"
  description "Allow or Deny entered Subscriptions. See the README for more details."
  allowed_values "Allow", "Deny"
  default "Allow"
end

parameter "param_subscriptions_list" do
  type "list"
  category "Filters"
  label "Allow/Deny Subscriptions List"
  description "A list of allowed or denied Subscription IDs/names. See the README for more details."
  default []
end

parameter "param_policy_names" do
  type "list"
  category "Policy Settings"
  label "Azure Policy Names"
  description "List of Azure Policy names to check."
  # No default value, user input required
end

###############################################################################
# Authentication
###############################################################################

credentials "auth_azure" do
  schemes "oauth2"
  label "Azure"
  description "Select the Azure Resource Manager Credential from the list."
  tags "provider=azure_rm"
end

credentials "auth_flexera" do
  schemes "oauth2"
  label "Flexera"
  description "Select Flexera One OAuth2 credentials"
  tags "provider=flexera"
end

###############################################################################
# Pagination
###############################################################################

pagination "pagination_azure" do
  get_page_marker do
    body_path "nextLink"
  end
  set_page_marker do
    uri true
  end
end

###############################################################################
# Datasources & Scripts
###############################################################################

# Get applied policy metadata for use later
datasource "ds_applied_policy" do
  request do
    auth $auth_flexera
    host rs_governance_host
    path join(["/api/governance/projects/", rs_project_id, "/applied_policies/", policy_id])
    header "Api-Version", "1.0"
  end
end

datasource "ds_azure_subscriptions" do
  request do
    auth $auth_azure
    pagination $pagination_azure
    host $param_azure_endpoint
    path "/subscriptions/"
    query "api-version", "2020-01-01"
    header "User-Agent", "RS Policies"
    # Header X-Meta-Flexera has no affect on datasource query, but is required for Meta Policies
    # Forces `ds_is_deleted` datasource to run first during policy execution
    header "Meta-Flexera", val($ds_is_deleted, "path")
    # Ignore status 400, 403, and 404 which can be returned in certain (legacy) types of Azure Subscriptions
    ignore_status [400, 403, 404]
  end
  result do
    encoding "json"
    collect jmes_path(response, "value[*]") do
      field "id", jmes_path(col_item, "subscriptionId")
      field "name", jmes_path(col_item, "displayName")
      field "state", jmes_path(col_item, "state")
    end
  end
end

datasource "ds_azure_subscriptions_filtered" do
  run_script $js_azure_subscriptions_filtered, $ds_azure_subscriptions, $param_subscriptions_allow_or_deny, $param_subscriptions_list
end

script "js_azure_subscriptions_filtered", type: "javascript" do
  parameters "ds_azure_subscriptions", "param_subscriptions_allow_or_deny", "param_subscriptions_list"
  result "result"
  code <<-EOS
  if (param_subscriptions_list.length > 0) {
    result = _.filter(ds_azure_subscriptions, function(subscription) {
      include_subscription = _.contains(param_subscriptions_list, subscription['id']) || _.contains(param_subscriptions_list, subscription['name'])

      if (param_subscriptions_allow_or_deny == "Deny") {
        include_subscription = !include_subscription
      }

      return include_subscription
    })
  } else {
    result = ds_azure_subscriptions
  }
EOS
end

datasource "ds_azure_policy_definitions" do
  iterate $ds_azure_subscriptions
  request do
    auth $auth_azure
    pagination $pagination_azure
    host $param_azure_endpoint
    path join(["/subscriptions/", val(iter_item, "id"), "/providers/Microsoft.Authorization/policyDefinitions"])
    query "api-version", "2023-04-01"
    header "User-Agent", "RS Policies"
    # Ignore status 400, 403, and 404 which can be returned in certain (legacy) types of Azure Subscriptions
    ignore_status [400, 403, 404]
  end
  result do
    encoding "json"
    collect jmes_path(response, "value[*]") do
      field "id", jmes_path(col_item, "id")
      field "name", jmes_path(col_item, "name")
      field "displayName", jmes_path(col_item, "properties.displayName")
      field "description", jmes_path(col_item, "properties.description")
      field "policyType", jmes_path(col_item, "properties.policyType")
      field "mode", jmes_path(col_item, "properties.mode")
      field "subscriptionId", val(iter_item, "id")
      field "subscriptionName", val(iter_item, "name")
    end
  end
end

datasource "ds_azure_policy_assignments" do
  iterate $ds_azure_subscriptions
  request do
    auth $auth_azure
    pagination $pagination_azure
    host $param_azure_endpoint
    path join(["/subscriptions/", val(iter_item, "id"), "/providers/Microsoft.Authorization/policyAssignments"])
    query "api-version", "2023-04-01"
    header "User-Agent", "RS Policies"
    # Ignore status 400, 403, and 404 which can be returned in certain (legacy) types of Azure Subscriptions
    ignore_status [400, 403, 404]
  end
  result do
    encoding "json"
    collect jmes_path(response, "value[*]") do
      field "id", jmes_path(col_item, "id")
      field "region", jmes_path(col_item, "location")
      field "name", jmes_path(col_item, "name")
      field "displayName", jmes_path(col_item, "properties.displayName")
      field "description", jmes_path(col_item, "properties.description")
      field "policyDefinitionId", jmes_path(col_item, "properties.policyDefinitionId")
      field "scope", jmes_path(col_item, "properties.scope")
      field "notScopes", jmes_path(col_item, "properties.notScopes")
      field "subscriptionId", val(iter_item, "id")
      field "subscriptionName", val(iter_item, "name")
    end
  end
end

datasource "ds_azure_policy_assignments_enriched" do
  run_script $js_azure_policy_assignments_enriched, $ds_azure_policy_definitions, $ds_azure_policy_assignments, $param_policy_names
end

script "js_azure_policy_assignments_enriched", type: "javascript" do
  parameters "ds_azure_policy_definitions", "ds_azure_policy_assignments", "param_policy_names"
  result "result"
  code <<-'EOS'
  // Create a list of policy assignments with policy definition metadata integrated into it
  definitions_object = {}

  _.each(ds_azure_policy_definitions, function(definition) {
    uniqId = definition["id"] + '___' + definition["subscriptionId"]
    definitions_object[uniqId] = definition
  })

  assignments = _.map(ds_azure_policy_assignments, function(assignment) {
    uniqId = assignment["policyDefinitionId"] + '___' + assignment["subscriptionId"]
    definition = definitions_object[uniqId]

    policyDefinitionId = ""
    policyDefinitionName = ""
    policyType = ""

    if (definition != undefined) {
      policyDefinitionId = definition["name"]
      policyDefinitionName = definition["displayName"]
      policyType = definition["policyType"]
    }

    notScopes = []
    if (typeof(assignment["notScopes"]) == 'object') { notScopes = assignment["notScopes"] }

    return {
      id: assignment["id"],
      region: assignment["region"],
      name: assignment["name"],
      displayName: assignment["displayName"],
      description: assignment["description"],
      scope: assignment["scope"],
      subscriptionId: assignment["subscriptionId"],
      subscriptionName: assignment["subscriptionName"],
      notScopes: notScopes.join(', '),
      policyDefinitionId: policyDefinitionId,
      policyDefinitionName: policyDefinitionName,
      policyType: policyType
    }
  })

  // Filter out any assignments we're not actually interested in
  result = _.filter(assignments, function(assignment) {
    return _.contains(param_policy_names, assignment["policyDefinitionName"])
  })
EOS
end

datasource "ds_audit_results" do
  run_script $js_audit_results, $ds_azure_subscriptions_filtered, $ds_azure_policy_assignments_enriched, $ds_applied_policy, $param_policy_names
end

script "js_audit_results", type: "javascript" do
  parameters "ds_azure_subscriptions_filtered", "ds_azure_policy_assignments_enriched", "ds_applied_policy", "param_policy_names"
  result "result"
  code <<-'EOS'
  // Sort assignments by subscription for easy iteration later
  assignments_by_sub = {}

  _.each(ds_azure_policy_assignments_enriched, function(assignment) {
    subscriptionId = assignment["subscriptionId"]
    if (assignments_by_sub[subscriptionId] == undefined) { assignments_by_sub[subscriptionId] = [] }
    assignments_by_sub[subscriptionId].push(assignment)
  })

  // Create results for incident
  result = []

  _.each(ds_azure_subscriptions_filtered, function(subscription) {
    sub_assignments = assignments_by_sub[subscription["id"]]
    if (typeof(sub_assignments) != 'object') { sub_assignments = [] }

    sub_assignments_by_name = {}

    _.each(sub_assignments, function(assignment) {
      sub_assignments_by_name[assignment["policyDefinitionName"]] = assignment
    })

    _.each(param_policy_names, function(name) {
      entry = {
        accountID: subscription["id"],
        accountName: subscription["name"],
        policyDefinitionName: name,
        resourceID: "",
        region: "",
        resourceName: "",
        displayName: "",
        description: "",
        policyDefinitionId: "",
        resourceType: "",
        scope: "",
        notScopes: "",
        found: false,
        service: "Microsoft.Authorization",
        policy_name: ds_applied_policy["name"]
      }

      if (sub_assignments_by_name[name] != undefined) {
        found_assignment = sub_assignments_by_name[name]

        entry["resourceID"] = found_assignment["id"]
        entry["region"] = found_assignment["region"]
        entry["resourceName"] = found_assignment["name"]
        entry["displayName"] = found_assignment["displayName"]
        entry["description"] = found_assignment["description"]
        entry["policyDefinitionId"] = found_assignment["policyDefinitionId"]
        entry["policyDefinitionName"] = found_assignment["policyDefinitionName"]
        entry["resourceType"] = found_assignment["policyType"]
        entry["scope"] = found_assignment["scope"]
        entry["notScopes"] = found_assignment["notScopes"]
        entry["found"] = true
      }

      result.push(entry)
    })
  })

  // Dummy entry to ensure validation occurs at least once
  result.push({
    accountID: "",
    accountName: "",
    policyDefinitionName: "",
    resourceID: "",
    region: "",
    resourceName: "",
    displayName: "",
    description: "",
    policyDefinitionId: "",
    resourceType: "",
    scope: "",
    notScopes: "",
    found: "",
    service: "",
    policy_name: ""
  })
EOS
end

###############################################################################
# Policy
###############################################################################

policy "pol_azure_policy_audit" do
  validate_each $ds_audit_results do
    summary_template "{{ with index data 0 }}{{ .policy_name }}{{ end }}: {{ len data }} Azure Policies Checked"
    check logic_or($ds_parent_policy_terminated, eq(val(item, "policyDefinitionName"), ""))
    escalate $esc_email
    export do
      resource_level true
      field "accountID" do
        label "Subscription ID"
      end
      field "accountName" do
        label "Subscription Name"
      end
      field "policyDefinitionName" do
        label "Definition Name"
      end
      field "policyDefinitionId" do
        label "Definition ID"
      end
      field "resourceName" do
        label "Assignment Name"
      end
      field "displayName" do
        label "Assignment Display Name"
      end
      field "resourceType" do
        label "Type"
      end
      field "description" do
        label "Description"
      end
      field "scope" do
        label "Scope"
      end
      field "notScopes" do
        label "Exclusions"
      end
      field "found" do
        label "Policy Assigned?"
      end
      field "service" do
        label "Service"
      end
      field "id" do
        label "Assignment ID"
        path "resourceID"
      end
    end
  end
end

###############################################################################
# Escalations
###############################################################################

escalation "esc_email" do
  automatic true
  label "Send Email"
  description "Send incident email"
  email $param_email
end

###############################################################################
# Meta Policy [alpha]
# Not intended to be modified or used by policy developers
###############################################################################

# If the meta_parent_policy_id is not set it will evaluate to an empty string and we will look for the policy itself,
# if it is set we will look for the parent policy.
datasource "ds_get_policy" do
  request do
    auth $auth_flexera
    host rs_governance_host
    ignore_status [404]
    path join(["/api/governance/projects/", rs_project_id, "/applied_policies/", switch(ne(meta_parent_policy_id, ""), meta_parent_policy_id, policy_id)])
    header "Api-Version", "1.0"
  end
  result do
    encoding "json"
    field "id", jmes_path(response, "id")
  end
end

datasource "ds_parent_policy_terminated" do
  run_script $js_decide_if_self_terminate, $ds_get_policy, policy_id, meta_parent_policy_id
end

# If the policy was applied by a meta_parent_policy we confirm it exists if it doesn't we confirm we are deleting
# This information is used in two places:
# - determining whether or not we make a delete call
# - determining if we should create an incident (we don't want to create an incident on the run where we terminate)
script "js_decide_if_self_terminate", type: "javascript" do
  parameters "found", "self_policy_id", "meta_parent_policy_id"
  result "result"
  code <<-EOS
  var result
  if (meta_parent_policy_id != "" && found.id == undefined) {
    result = true
  } else {
    result = false
  }
  EOS
end

# Two potentials ways to set this up:
# - this way and make a unneeded 'get' request when not deleting
# - make the delete request an interate and have it iterate over an empty array when not deleting and an array with one item when deleting
script "js_make_terminate_request", type: "javascript" do
  parameters "should_delete", "policy_id", "rs_project_id", "rs_governance_host"
  result "request"
  code <<-EOS

  var request = {
    auth:  'auth_flexera',
    host: rs_governance_host,
    path: "/api/governance/projects/" + rs_project_id + "/applied_policies/" + policy_id,
    headers: {
      "API-Version": "1.0",
      "Content-Type":"application/json"
    },
  }

  if (should_delete) {
    request.verb = 'DELETE'
  }
  EOS
end

datasource "ds_terminate_self" do
  request do
    run_script $js_make_terminate_request, $ds_parent_policy_terminated, policy_id, rs_project_id, rs_governance_host
  end
end

datasource "ds_is_deleted" do
  run_script $js_check_deleted, $ds_terminate_self
end

# This is just a way to have the check delete request connect to the farthest leaf from policy.
# We want the delete check to the first thing the policy does to avoid the policy erroring before it can decide whether or not it needs to self terminate
# Example a customer deletes a credential and then terminates the parent policy. We still want the children to self terminate
# The only way I could see this not happening is if the user who applied the parent_meta_policy was offboarded or lost policy access, the policies who are impersonating the user
# would not have access to self-terminate
# It may be useful for the backend to enable a mass terminate at some point for all meta_child_policies associated with an id.
script "js_check_deleted", type: "javascript" do
  parameters "response"
  result "result"
  code <<-EOS
  result = {"path":"/"}
  EOS
end