Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

azurerm_sentinel_alert_rule_fusion - support for sourceblock #19093

Merged
merged 4 commits into from
Nov 6, 2022
Merged

azurerm_sentinel_alert_rule_fusion - support for sourceblock #19093

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
383de98
First try, but won't work due to: https://github.com/Azure/azure-rest…
magodo Nov 2, 2022
3d3c695
`azurerm_sentinel_alert_rule_fusion` - support for `source_setting`
magodo Nov 2, 2022
febc341
renaming props
magodo Nov 3, 2022
17211ae
rename `severities_enabled` to `severities_allowed`
magodo Nov 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
208 changes: 208 additions & 0 deletions internal/services/sentinel/sentinel_alert_rule_fusion_resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,62 @@ func resourceSentinelAlertRuleFusion() *pluginsdk.Resource {
Optional: true,
Default: true,
},

"source": {
Type: pluginsdk.TypeList,
Optional: true,
// Service will auto-fill this if not given in request, based on the "alert_rule_template_guid".
Computed: true,
Elem: &pluginsdk.Resource{
Schema: map[string]*pluginsdk.Schema{
"name": {
Type: pluginsdk.TypeString,
Required: true,
ValidateFunc: validation.StringIsNotEmpty,
},
"enabled": {
Type: pluginsdk.TypeBool,
Optional: true,
Default: true,
},
"sub_type": {
Type: pluginsdk.TypeList,
Optional: true,
Elem: &pluginsdk.Resource{
Schema: map[string]*pluginsdk.Schema{
"name": {
Type: pluginsdk.TypeString,
Required: true,
ValidateFunc: validation.StringIsNotEmpty,
},
"enabled": {
Type: pluginsdk.TypeBool,
Optional: true,
Default: true,
},
"enabled_severities": {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this be

Suggested change
"enabled_severities": {
"severities_enabled": {

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@katbyte We used foo_enabled as a boolean property, whilst this one is an array of enabled severities.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes but putting it in front doesn't make sense. looking at the api closer, should this just be

Suggested change
"enabled_severities": {
"severities": {

as it is the severities for this sub_type, so sub_type.enable = true means enable then, sub_type.enabled = false would actually disable them?

so maybe

Suggested change
"enabled_severities": {
"severities_allowed": {

or

Suggested change
"enabled_severities": {
"severities_filter": {

Copy link
Collaborator Author

@magodo magodo Nov 4, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@katbyte I see. I've renamed it to severities_allowed now.

Type: pluginsdk.TypeSet,
Required: true,
MinItems: 1,
Elem: &pluginsdk.Schema{
Type: pluginsdk.TypeString,
ValidateFunc: validation.StringInSlice(
[]string{
string(securityinsight.AlertSeverityHigh),
string(securityinsight.AlertSeverityMedium),
string(securityinsight.AlertSeverityLow),
string(securityinsight.AlertSeverityInformational),
},
false,
),
},
},
},
},
},
},
},
},
},
}
}
Expand Down Expand Up @@ -98,6 +154,7 @@ func resourceSentinelAlertRuleFusionCreateUpdate(d *pluginsdk.ResourceData, meta
FusionAlertRuleProperties: &securityinsight.FusionAlertRuleProperties{
AlertRuleTemplateName: utils.String(d.Get("alert_rule_template_guid").(string)),
Enabled: utils.Bool(d.Get("enabled").(bool)),
SourceSettings: expandFusionSourceSettings(d.Get("source").([]interface{})),
},
}

Expand Down Expand Up @@ -155,6 +212,9 @@ func resourceSentinelAlertRuleFusionRead(d *pluginsdk.ResourceData, meta interfa
if prop := rule.FusionAlertRuleProperties; prop != nil {
d.Set("enabled", prop.Enabled)
d.Set("alert_rule_template_guid", prop.AlertRuleTemplateName)
if err := d.Set("source", flattenFusionSourceSettings(prop.SourceSettings)); err != nil {
return fmt.Errorf("setting `source`: %v", err)
}
}

return nil
Expand All @@ -176,3 +236,151 @@ func resourceSentinelAlertRuleFusionDelete(d *pluginsdk.ResourceData, meta inter

return nil
}

func expandFusionSourceSettings(input []interface{}) *[]securityinsight.FusionSourceSettings {
if len(input) == 0 {
return nil
}

result := make([]securityinsight.FusionSourceSettings, 0)

for _, e := range input {
e := e.(map[string]interface{})
setting := securityinsight.FusionSourceSettings{
Enabled: utils.Bool(e["enabled"].(bool)),
SourceName: utils.String(e["name"].(string)),
SourceSubTypes: expandFusionSourceSubTypes(e["sub_type"].([]interface{})),
}
result = append(result, setting)
}

return &result
}

func expandFusionSourceSubTypes(input []interface{}) *[]securityinsight.FusionSourceSubTypeSetting {
if len(input) == 0 {
return nil
}

result := make([]securityinsight.FusionSourceSubTypeSetting, 0)

for _, e := range input {
e := e.(map[string]interface{})
setting := securityinsight.FusionSourceSubTypeSetting{
Enabled: utils.Bool(e["enabled"].(bool)),
SourceSubTypeName: utils.String(e["name"].(string)),
SeverityFilters: &securityinsight.FusionSubTypeSeverityFilter{
Filters: expandFusionSubTypeSeverityFiltersItems(e["enabled_severities"].(*pluginsdk.Set).List()),
},
}
result = append(result, setting)
}

return &result
}

func expandFusionSubTypeSeverityFiltersItems(input []interface{}) *[]securityinsight.FusionSubTypeSeverityFiltersItem {
if len(input) == 0 {
return nil
}

result := make([]securityinsight.FusionSubTypeSeverityFiltersItem, 0)

// We can't simply remove the disabled properties in the request, as that will be reflected to the backend model (i.e. those unspecified severity will be absent also).
// As any absent severity then will not be shown in the Portal when users try to edit the alert rule. The drop down menu won't show these absent severities...
filters := map[string]bool{}
for _, e := range securityinsight.PossibleAlertSeverityValues() {
filters[string(e)] = false
}

for _, e := range input {
filters[e.(string)] = true
}

for severity, enabled := range filters {
item := securityinsight.FusionSubTypeSeverityFiltersItem{
Enabled: utils.Bool(enabled),
Severity: securityinsight.AlertSeverity(severity),
}
result = append(result, item)
}

return &result
}

func flattenFusionSourceSettings(input *[]securityinsight.FusionSourceSettings) []interface{} {
if input == nil {
return []interface{}{}
}

output := make([]interface{}, 0)

for _, e := range *input {
var name string
if e.SourceName != nil {
name = *e.SourceName
}

var enabled bool
if e.Enabled != nil {
enabled = *e.Enabled
}

output = append(output, map[string]interface{}{
"name": name,
"enabled": enabled,
"sub_type": flattenFusionSourceSubTypes(e.SourceSubTypes),
})
}

return output
}

func flattenFusionSourceSubTypes(input *[]securityinsight.FusionSourceSubTypeSetting) []interface{} {
if input == nil {
return []interface{}{}
}

output := make([]interface{}, 0)

for _, e := range *input {
var name string
if e.SourceSubTypeName != nil {
name = *e.SourceSubTypeName
}

var enabledSeverities []interface{}
if e.SeverityFilters != nil {
enabledSeverities = flattenFusionSubTypeSeverityFiltersItems(e.SeverityFilters.Filters)
}

var enabled bool
if e.Enabled != nil {
enabled = *e.Enabled
}

output = append(output, map[string]interface{}{
"name": name,
"enabled": enabled,
"enabled_severities": enabledSeverities,
})
}

return output
}

func flattenFusionSubTypeSeverityFiltersItems(input *[]securityinsight.FusionSubTypeSeverityFiltersItem) []interface{} {
if input == nil {
return []interface{}{}
}

output := make([]interface{}, 0)

for _, e := range *input {
if e.Enabled != nil && *e.Enabled {
output = append(output, string(e.Severity))
}
}

return output
}
109 changes: 95 additions & 14 deletions internal/services/sentinel/sentinel_alert_rule_fusion_resource_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,42 +31,48 @@ func TestAccSentinelAlertRuleFusion_basic(t *testing.T) {
})
}

func TestAccSentinelAlertRuleFusion_complete(t *testing.T) {
func TestAccSentinelAlertRuleFusion_disable(t *testing.T) {
data := acceptance.BuildTestData(t, "azurerm_sentinel_alert_rule_fusion", "test")
r := SentinelAlertRuleFusionResource{}

data.ResourceTest(t, r, []acceptance.TestStep{
{
Config: r.complete(data),
Config: r.basic(data),
Check: acceptance.ComposeTestCheckFunc(
check.That(data.ResourceName).ExistsInAzure(r),
),
},
data.ImportStep(),
})
}

func TestAccSentinelAlertRuleFusion_update(t *testing.T) {
data := acceptance.BuildTestData(t, "azurerm_sentinel_alert_rule_fusion", "test")
r := SentinelAlertRuleFusionResource{}

data.ResourceTest(t, r, []acceptance.TestStep{
{
Config: r.basic(data),
Config: r.disabled(data),
Check: acceptance.ComposeTestCheckFunc(
check.That(data.ResourceName).ExistsInAzure(r),
),
},
data.ImportStep(),
{
Config: r.complete(data),
Config: r.basic(data),
Check: acceptance.ComposeTestCheckFunc(
check.That(data.ResourceName).ExistsInAzure(r),
),
},
data.ImportStep(),
})
}

func TestAccSentinelAlertRuleFusion_sourceSetting(t *testing.T) {
data := acceptance.BuildTestData(t, "azurerm_sentinel_alert_rule_fusion", "test")
r := SentinelAlertRuleFusionResource{}

data.ResourceTest(t, r, []acceptance.TestStep{
{
Config: r.basic(data),
Config: r.sourceSetting(data, true),
Check: acceptance.ComposeTestCheckFunc(
check.That(data.ResourceName).ExistsInAzure(r),
),
},
{
Config: r.sourceSetting(data, false),
Check: acceptance.ComposeTestCheckFunc(
check.That(data.ResourceName).ExistsInAzure(r),
),
Expand Down Expand Up @@ -131,7 +137,7 @@ resource "azurerm_sentinel_alert_rule_fusion" "test" {
`, r.template(data), data.RandomInteger)
}

func (r SentinelAlertRuleFusionResource) complete(data acceptance.TestData) string {
func (r SentinelAlertRuleFusionResource) disabled(data acceptance.TestData) string {
return fmt.Sprintf(`
%s

Expand All @@ -149,6 +155,81 @@ resource "azurerm_sentinel_alert_rule_fusion" "test" {
`, r.template(data), data.RandomInteger)
}

func (r SentinelAlertRuleFusionResource) sourceSetting(data acceptance.TestData, enabled bool) string {
return fmt.Sprintf(`
%[1]s

data "azurerm_sentinel_alert_rule_template" "test" {
display_name = "Advanced Multistage Attack Detection"
log_analytics_workspace_id = azurerm_log_analytics_solution.test.workspace_resource_id
}

resource "azurerm_sentinel_alert_rule_fusion" "test" {
name = "acctest-SentinelAlertRule-Fusion-%[2]d"
log_analytics_workspace_id = azurerm_log_analytics_solution.test.workspace_resource_id
alert_rule_template_guid = data.azurerm_sentinel_alert_rule_template.test.name
source {
name = "Anomalies"
enabled = %[3]t
}
source {
name = "Alert providers"
enabled = %[3]t
sub_type {
enabled_severities = ["High", "Informational", "Low", "Medium"]
name = "Azure Active Directory Identity Protection"
enabled = %[3]t
}
sub_type {
enabled_severities = ["High", "Informational", "Low", "Medium"]
name = "Microsoft 365 Defender"
enabled = %[3]t
}
sub_type {
enabled_severities = ["High", "Informational", "Low", "Medium"]
name = "Microsoft Cloud App Security"
enabled = %[3]t
}
sub_type {
enabled_severities = ["High", "Informational", "Low", "Medium"]
name = "Azure Defender"
enabled = %[3]t
}
sub_type {
enabled_severities = ["High", "Informational", "Low", "Medium"]
name = "Microsoft Defender for Endpoint"
enabled = %[3]t
}
sub_type {
enabled_severities = ["High", "Informational", "Low", "Medium"]
name = "Microsoft Defender for Identity"
enabled = %[3]t
}
sub_type {
enabled_severities = ["High", "Informational", "Low", "Medium"]
name = "Azure Defender for IoT"
enabled = %[3]t
}
sub_type {
enabled_severities = ["High", "Informational", "Low", "Medium"]
name = "Microsoft Defender for Office 365"
enabled = %[3]t
}
sub_type {
enabled_severities = ["High", "Informational", "Low", "Medium"]
name = "Azure Sentinel scheduled analytics rules"
enabled = %[3]t
}
sub_type {
enabled_severities = ["High", "Informational", "Low", "Medium"]
name = "Azure Sentinel NRT analytic rules"
enabled = %[3]t
}
}
}
`, r.template(data), data.RandomInteger, enabled)
}

func (r SentinelAlertRuleFusionResource) requiresImport(data acceptance.TestData) string {
return fmt.Sprintf(`
%s
Expand Down
Loading