Skip to content
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: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,8 @@ workflow defaults to checking independent encrypted recovery publication. Its
apply mode accepts only the frozen, reviewed first proposal and requires a
successful custody check from that same main revision.

DNS records are declared in [`dns.tf`](dns.tf) and change only through the
DNS records are declared in [`dns.tf`](dns.tf), and the zone settings that would
rewrite proxied pages in [`zone.tf`](zone.tf). Both change only through the
manual **DNS plan and guarded apply** workflow: plan first, then apply the same
reviewed revision. It imports declared records that already exist, never
deletes or replaces anything, and keeps an encrypted state copy from before and
Expand Down
5 changes: 4 additions & 1 deletion docs/runbooks/bootstrap-and-recovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,10 @@ match, a record already managed here, or a record that external-dns owns
refuses the run.

The saved plan must then pass `scripts/assert-no-destructive-plan.sh` and
`scripts/check-dns-plan.jq`. Only DNS records may change. Imports must leave
`scripts/check-dns-plan.jq`. Only DNS records and the zone settings in `zone.tf`
may change. Those settings, the bot management configuration and the listed
zone settings, always exist, so they are imported by zone, never created or
forgotten, and may be updated by the change that imports them. Imports must leave
their record exactly as it is. Creates, updates and `removed` blocks with
`destroy = false` are admitted; deletes and replacements are not. A created or
updated record must have a known name and must not be owned by external-dns.
Expand Down
5 changes: 3 additions & 2 deletions scripts/apply-dns.sh
Original file line number Diff line number Diff line change
Expand Up @@ -180,9 +180,10 @@ jq -r '.[]|"import {\n to = \(.address)\n id = \(.id|tojson)\n}\n"' "$scratch/
stage=plan
plan_json change || stop
# Public summary: actions and changed attribute names, never values. Only the
# addresses written in dns.tf are printed; resources keyed by the private
# addresses written in dns.tf and zone.tf are printed; resources keyed by the private
# configuration (tokens, buckets, configured records) appear only as a count.
jq -r 'def public: .address|startswith("cloudflare_dns_record.") and (startswith("cloudflare_dns_record.records[")|not);
jq -r 'def public: .address | (startswith("cloudflare_dns_record.") and (startswith("cloudflare_dns_record.records[")|not)) or
startswith("cloudflare_zone_setting.") or startswith("cloudflare_bot_management.");
(.resource_changes[] | select(public) |
(if .change.importing then "import" else (.change.actions|join("-")) end) as $action |
select($action!="no-op") |
Expand Down
14 changes: 12 additions & 2 deletions scripts/check-dns-plan.jq
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@
# names. Otherwise it could hand a mail record, or any other record, to
# external-dns, which would delete it. The typeless apex registry name is always refused,
# because it claims every apex record, the Email MX and TXT records included.
#
# Besides DNS records, only the zone settings declared in zone.tf may change:
# the bot management configuration and the zone settings listed below. They
# always exist, so they are imported, never created, and may be updated by the
# reviewed change that imports them.
def zone_settings: ["email_obfuscation"];
def setting: .type=="cloudflare_bot_management" or
(.type=="cloudflare_zone_setting" and (((.change.after // .change.before // {}).setting_id // "")|IN(zone_settings[])));
def fqdn: ascii_downcase | rtrimstr(".") |
if .=="@" then "devantler.tech"
elif .=="devantler.tech" or endswith(".devantler.tech") then .
Expand Down Expand Up @@ -51,9 +59,11 @@ all(.resource_changes[];
.mode=="managed" and
(.change.actions|IN(["no-op"],["create"],["update"],["forget"])) and
(if .change.importing then
any($wanted[]; .address==$resource.address) and .change.actions==["no-op"] and (changed|not)
any($wanted[]; .address==$resource.address) and
(if setting then .change.actions|IN(["no-op"],["update"]) else .change.actions==["no-op"] and (changed|not) end)
else true end) and
(if .type!="cloudflare_dns_record" then .change.actions==["no-op"]
(if setting then .change.actions|IN(["no-op"],["update"])
elif .type!="cloudflare_dns_record" then .change.actions==["no-op"]
elif writes then
.change.after as $after |
($after.name|type=="string") and ($after.type|type=="string") and
Expand Down
16 changes: 15 additions & 1 deletion scripts/dns-imports.jq
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
# no external-dns ownership record claims it. Anything else is refused, so a
# typo or drift can never add a second mail record, adopt a record twice, or
# take over an external-dns record.
#
# The zone's single-instance settings in zone.tf always exist, so a planned
# create of one of them is always an import of the live setting: the bot
# management configuration by zone, and an allowed zone setting by zone and
# setting name. Any other setting is left to fail at the plan check.
def zone_settings: ["email_obfuscation"];
def fqdn: ascii_downcase | rtrimstr(".") |
if .=="@" then "devantler.tech"
elif .=="devantler.tech" or endswith(".devantler.tech") then .
Expand Down Expand Up @@ -33,7 +39,15 @@ $snapshot[0] as $live |
elif ($exact|length)>1 then {address, refused:"ambiguous"}
elif ($same|length)>0 then {address, refused:"content-differs"}
else empty end
] as $resolved |
] as $records |
[.resource_changes[] |
select(.mode=="managed" and .change.actions==["create"]) |
if .type=="cloudflare_bot_management" then {address, id:$live.zone.id}
elif .type=="cloudflare_zone_setting" and (.change.after.setting_id|IN(zone_settings[])) then
{address, id:($live.zone.id+"/"+.change.after.setting_id)}
else empty end
] as $settings |
($records + $settings) as $resolved |
([$resolved[]|select(has("id"))|.id]) as $ids |
{
imports:[$resolved[]|select(has("id"))]|sort_by(.address),
Expand Down
25 changes: 25 additions & 0 deletions scripts/tests/test-dns-apply.sh
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,31 @@ printf '%s\n' "$noop_import" | jq -s '{errored:true,resource_changes:.}' | if ch
printf '%s\n' "$noop_import" | jq -s '{deferred_changes:[{}],resource_changes:.}' | if check; then exit 1; fi
printf '%s\n' 'PASS: DNS plans admit unchanged imports, creates, updates and forgets only'

# 3b. The zone's single-instance settings are always imported, may then be updated,
# and are never created, forgotten or widened to other zone settings.
setting() { jq -n --arg address "$1" --arg type "$2" --arg setting "$3" '{address:$address,mode:"managed",type:$type,change:{actions:["create"],after:({zone_id:null} + (if $setting=="" then {} else {setting_id:$setting,value:"off"} end))}}'; }
result=$( { setting cloudflare_bot_management.primary cloudflare_bot_management ""
setting cloudflare_zone_setting.email_obfuscation cloudflare_zone_setting email_obfuscation
setting cloudflare_zone_setting.rocket_loader cloudflare_zone_setting rocket_loader; } | resolve)
jq -e --arg zone "$zone" '.refused==[] and .imports==[
{address:"cloudflare_bot_management.primary",id:$zone},
{address:"cloudflare_zone_setting.email_obfuscation",id:($zone+"/email_obfuscation")}]' <<<"$result" >/dev/null
printf '%s\n' "[{\"address\":\"cloudflare_bot_management.primary\",\"id\":\"$zone\"},{\"address\":\"cloudflare_zone_setting.email_obfuscation\",\"id\":\"$zone/email_obfuscation\"}]" > "$scratch/imports.json"
bot_import=$(change cloudflare_bot_management.primary cloudflare_bot_management '["update"]' '{"fight_mode":true,"enable_js":true}' '{"fight_mode":false,"enable_js":false}' "{\"id\":\"$zone\"}")
obfuscation_import=$(change cloudflare_zone_setting.email_obfuscation cloudflare_zone_setting '["update"]' '{"setting_id":"email_obfuscation","value":"on"}' '{"setting_id":"email_obfuscation","value":"off"}' "{\"id\":\"$zone/email_obfuscation\"}")
printf '%s\n' "$bot_import" "$obfuscation_import" | plan | check
# The import list names only the other resource, so only the action rule can refuse these.
printf '%s\n' "[{\"address\":\"cloudflare_zone_setting.email_obfuscation\",\"id\":\"$zone/email_obfuscation\"}]" > "$scratch/imports.json"
{ printf '%s\n' "$obfuscation_import"; change cloudflare_bot_management.primary cloudflare_bot_management '["create"]' null '{"fight_mode":false}' null; } | reject "created bot management"
printf '%s\n' "[{\"address\":\"cloudflare_bot_management.primary\",\"id\":\"$zone\"}]" > "$scratch/imports.json"
{ printf '%s\n' "$bot_import"; change cloudflare_zone_setting.email_obfuscation cloudflare_zone_setting '["forget"]' '{"setting_id":"email_obfuscation","value":"on"}' null null; } | reject "forgotten zone setting"
printf '%s\n' "[{\"address\":\"cloudflare_bot_management.primary\",\"id\":\"$zone\"},{\"address\":\"cloudflare_zone_setting.email_obfuscation\",\"id\":\"$zone/email_obfuscation\"}]" > "$scratch/imports.json"
{ printf '%s\n' "$bot_import" "$obfuscation_import"
change cloudflare_zone_setting.rocket_loader cloudflare_zone_setting '["update"]' '{"setting_id":"rocket_loader","value":"off"}' '{"setting_id":"rocket_loader","value":"on"}' null; } | reject "update of an unlisted zone setting"
printf '%s\n' "$bot_import" | reject "missing zone-setting import"
printf '%s\n' "[{\"address\":\"cloudflare_dns_record.mail_mx_01\",\"id\":\"$import_id\"}]" > "$scratch/imports.json"
printf '%s\n' 'PASS: zone settings are imported, may be updated, and never created, forgotten or widened'

# 4. The declared mail records are the ones the company Email depends on.
grep -q 'content = "mx01.mail.icloud.com"' "$root/dns.tf"
grep -q 'content = "mx02.mail.icloud.com"' "$root/dns.tf"
Expand Down
35 changes: 35 additions & 0 deletions zone.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Zone features that rewrite the HTML of proxied pages, or override a site's own
# crawler policy, stay off, so visitors get exactly the bytes the origin serves.
# The business site forbids injected scripts, and a strict
# Content-Security-Policy would block them anyway.
#
# - Email Address Obfuscation replaces mailto links with a JavaScript decoder,
# which hides the published contact address from visitors without JS.
# - Bot Fight Mode injects the JavaScript Detections script on every page; on
# the Free plan it cannot be turned off separately. It can also challenge the
# platform's API and sign-in traffic, which sign-in protects instead.
# - AI Labyrinth (`crawler_protection`) adds hidden honeypot links to pages.
# - "Block AI bots" (`ai_bots_protection`) answered AI crawlers with 403 although
# the site's robots.txt allows every crawler, keeping the business site out of
# AI search. Each site states its crawler policy in its own robots.txt.
#
# Every other bot setting keeps its live value. Most unset attributes are
# computed; the two the provider would otherwise reset (a static default and an
# optional, non-computed flag) are ignored so this resource never changes them.
resource "cloudflare_zone_setting" "email_obfuscation" {
zone_id = cloudflare_zone.primary.id
setting_id = "email_obfuscation"
value = "off"
}

resource "cloudflare_bot_management" "primary" {
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Resolved
zone_id = cloudflare_zone.primary.id
fight_mode = false
enable_js = false
crawler_protection = "disabled"
ai_bots_protection = "disabled"

lifecycle {
ignore_changes = [ai_bots_migration_opt_out, bot_preference_sync_enabled]
}
}
Loading