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.

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

GFI-564: support gw rules internal dns settings #4918

Merged
merged 2 commits into from
Jan 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions .changelog/4918.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:enhancement
resource/cloudflare_zero_trust_gateway_policy: allow configuring resolver rules with internal DNS
```
10 changes: 10 additions & 0 deletions docs/resources/teams_rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ Optional:
- `override_host` (String) The host to override matching DNS queries with.
- `override_ips` (List of String) The IPs to override matching DNS queries with.
- `payload_log` (Block List, Max: 1) Configure DLP Payload Logging settings for this rule. (see [below for nested schema](#nestedblock--rule_settings--payload_log))
- `resolve_dns_internally` (Block List, Max: 1) Configure to forward the query to the internal DNS service, passing the specified 'view_id' as input. Cannot be set when 'dns_resolvers' are specified or 'resolve_dns_through_cloudflare' is set. Only valid when a rule's action is set to 'resolve'. (see [below for nested schema](#nestedblock--rule_settings--resolve_dns_internally))
- `resolve_dns_through_cloudflare` (Boolean) Enable sending queries that match the resolver policy to Cloudflare's default 1.1.1.1 DNS resolver. Cannot be set when `dns_resolvers` are specified.
- `untrusted_cert` (Block List, Max: 1) Configure untrusted certificate settings for this rule. (see [below for nested schema](#nestedblock--rule_settings--untrusted_cert))

Expand Down Expand Up @@ -184,6 +185,15 @@ Required:
- `enabled` (Boolean) Enable or disable DLP Payload Logging for this rule.


<a id="nestedblock--rule_settings--resolve_dns_internally"></a>
### Nested Schema for `rule_settings.resolve_dns_internally`

Optional:

- `fallback` (String) The fallback behavior to apply when the internal DNS response code is different from 'NOERROR' or when the response data only contains CNAME records for 'A' or 'AAAA' queries.
- `view_id` (String) The internal DNS view identifier that's passed to the internal DNS service.


<a id="nestedblock--rule_settings--untrusted_cert"></a>
### Nested Schema for `rule_settings.untrusted_cert`

Expand Down
10 changes: 10 additions & 0 deletions docs/resources/zero_trust_gateway_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ Optional:
- `override_host` (String) The host to override matching DNS queries with.
- `override_ips` (List of String) The IPs to override matching DNS queries with.
- `payload_log` (Block List, Max: 1) Configure DLP Payload Logging settings for this rule. (see [below for nested schema](#nestedblock--rule_settings--payload_log))
- `resolve_dns_internally` (Block List, Max: 1) Configure to forward the query to the internal DNS service, passing the specified 'view_id' as input. Cannot be set when 'dns_resolvers' are specified or 'resolve_dns_through_cloudflare' is set. Only valid when a rule's action is set to 'resolve'. (see [below for nested schema](#nestedblock--rule_settings--resolve_dns_internally))
- `resolve_dns_through_cloudflare` (Boolean) Enable sending queries that match the resolver policy to Cloudflare's default 1.1.1.1 DNS resolver. Cannot be set when `dns_resolvers` are specified.
- `untrusted_cert` (Block List, Max: 1) Configure untrusted certificate settings for this rule. (see [below for nested schema](#nestedblock--rule_settings--untrusted_cert))

Expand Down Expand Up @@ -184,6 +185,15 @@ Required:
- `enabled` (Boolean) Enable or disable DLP Payload Logging for this rule.


<a id="nestedblock--rule_settings--resolve_dns_internally"></a>
### Nested Schema for `rule_settings.resolve_dns_internally`

Optional:

- `fallback` (String) The fallback behavior to apply when the internal DNS response code is different from 'NOERROR' or when the response data only contains CNAME records for 'A' or 'AAAA' queries.
- `view_id` (String) The internal DNS view identifier that's passed to the internal DNS service.


<a id="nestedblock--rule_settings--untrusted_cert"></a>
### Nested Schema for `rule_settings.untrusted_cert`

Expand Down
40 changes: 40 additions & 0 deletions internal/sdkv2provider/resource_cloudflare_teams_rules.go
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,10 @@ func flattenTeamsRuleSettings(settings *cloudflare.TeamsRuleSettings) []interfac
result["dns_resolvers"] = flattenTeamsDnsResolverSettings(settings.DnsResolverSettings)
}

if settings.ResolveDnsInternallySettings != nil {
result["resolve_dns_internally"] = flattenTeamsResolveDnsInternallySettings(settings.ResolveDnsInternallySettings)
}

return []interface{}{result}
}

Expand Down Expand Up @@ -287,6 +291,7 @@ func inflateTeamsRuleSettings(settings interface{}) *cloudflare.TeamsRuleSetting
untrustedCertSettings := inflateTeamsUntrustedCertSettings(settingsMap["untrusted_cert"].([]interface{}))
notificationSettings := inflateTeamsNotificationSettings(settingsMap["notification_settings"])
dnsResolverSettings := inflateTeamsDnsResolverSettings(settingsMap["dns_resolvers"].([]interface{}))
internalDnsSettings := inflateTeamsResolveDnsInternallySettings(settingsMap["resolve_dns_internally"].([]interface{}))

ignoreCNAMECategoryMatches := readOptionalBooleanSettings(settingsMap, "ignore_cname_category_matches")
allowChildBypass := readOptionalBooleanSettings(settingsMap, "allow_child_bypass")
Expand Down Expand Up @@ -314,6 +319,7 @@ func inflateTeamsRuleSettings(settings interface{}) *cloudflare.TeamsRuleSetting
IgnoreCNAMECategoryMatches: &ignoreCNAMECategoryMatches,
IPCategories: ipCategories,
AuditSSH: auditSSHSettings,
ResolveDnsInternallySettings: internalDnsSettings,
}

// set optional settings if present, so api won't complain
Expand Down Expand Up @@ -609,6 +615,40 @@ func inflateTeamsDnsResolverAddressesV6(settings []interface{}) []cloudflare.Tea
return ret
}

func flattenTeamsResolveDnsInternallySettings(settings *cloudflare.TeamsResolveDnsInternallySettings) []interface{} {
if settings == nil {
return nil
}

var fallback cloudflare.TeamsResolveDnsInternallyFallbackStrategy
if settings.Fallback != "" {
fallback = settings.Fallback
} else {
fallback = cloudflare.None
}

return []interface{}{map[string]interface{}{
"view_id": settings.ViewID,
"fallback": string(fallback),
}}
}

func inflateTeamsResolveDnsInternallySettings(settings interface{}) *cloudflare.TeamsResolveDnsInternallySettings {
settingsList := settings.([]interface{})
if len(settingsList) != 1 {
return nil
}

settingsMap := settingsList[0].(map[string]interface{})
viewId := settingsMap["view_id"].(string)
fallback := cloudflare.TeamsResolveDnsInternallyFallbackStrategy(settingsMap["fallback"].(string))

return &cloudflare.TeamsResolveDnsInternallySettings{
ViewID: viewId,
Fallback: fallback,
}
}

func inflateTeamsDlpPayloadLogSettings(settings interface{}) *cloudflare.TeamsDlpPayloadLogSettings {
settingsList := settings.([]interface{})
if len(settingsList) != 1 {
Expand Down
22 changes: 22 additions & 0 deletions internal/sdkv2provider/schema_cloudflare_teams_rules.go
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,15 @@ var teamsRuleSettings = map[string]*schema.Schema{
},
Description: "Add your own custom resolvers to route queries that match the resolver policy. Cannot be used when resolve_dns_through_cloudflare is set. DNS queries will route to the address closest to their origin.",
},
"resolve_dns_internally": {
Type: schema.TypeList,
MaxItems: 1,
Optional: true,
Elem: &schema.Resource{
Schema: teamsResolveDnsInternallySettings,
},
Description: "Configure to forward the query to the internal DNS service, passing the specified 'view_id' as input. Cannot be set when 'dns_resolvers' are specified or 'resolve_dns_through_cloudflare' is set. Only valid when a rule's action is set to 'resolve'.",
},
}

var payloadLogSettings = map[string]*schema.Schema{
Expand Down Expand Up @@ -390,3 +399,16 @@ var teamsDnsResolverAddress = map[string]*schema.Schema{
Description: "Whether to connect to this resolver over a private network. Must be set when `vnet_id` is set.",
},
}

var teamsResolveDnsInternallySettings = map[string]*schema.Schema{
"view_id": {
Type: schema.TypeString,
Optional: true,
Description: "The internal DNS view identifier that's passed to the internal DNS service.",
},
"fallback": {
Type: schema.TypeString,
Optional: true,
Description: "The fallback behavior to apply when the internal DNS response code is different from 'NOERROR' or when the response data only contains CNAME records for 'A' or 'AAAA' queries.",
},
}
Loading