letsencrypt / letsencrypt/boulder

IANA gTLD blocking

Open
#7,013 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

starter
Dominant language
Go
Stars
5.8k
Forks
649
Avg merge
3d 23h
Merged PRs (30d)
24

Description

For several years SRE has relied upon various scripts to monitor IANA gTLD deprecations. When a gTLD is deprecated they have to do toil work such as:

  1. Making a work tracking ticket
  2. Blocking further issuance of domains with that gTLD
  3. Deleting pending authzs for the to-be-blocked gTLD
  4. Administratively revoking certificates
  5. Updating zlint in boulder

The Baseline Requirements section 4.9.1.1 Reasons for Revoking a Subscriber Certificate state:

The CA […] MUST revoke a Certificate within 5 days if […] The CA is made aware of any circumstance indicating that use of a Fully-Qualified Domain Name or IP address in the Certificate is no longer legally permitted (e.g. a court or arbitrator has revoked a Domain Name Registrant's right to use the Domain Name, a relevant licensing or services agreement between the Domain Name Registrant and the Applicant has terminated, or the Domain Name Registrant has failed to renew the Domain Name)…

The core of the monitoring is currently this slightly edited shell script.

#!/usr/bin/env sh

go install "github.com/zmap/zlint/v3/cmd/zlint-gtld-update@latest"

# Copy the source of truth
curl -sf --retry 5 --retry-delay 30 --retry-max-time 360 "https://raw.githubusercontent.com/zmap/zlint/9396315ef5d8b51947a954acf22b062aafca55c8}/v3/util/gtld_map.go" > "/tmp/extant_map" || { echo "FAILED to download baseline gTLD map"; exit 1; }

zlint-gtld-update > "/tmp/update_map"

# output differences, no differences is good
diff -u3 --suppress-common-lines --ignore-matching-lines="^ \* ZLint Copyright" "/tmp/extant_map" "/tmp/update_map"

Output produced from that diff will look like

--- /tmp/extant_map	2022-12-07 00:03:09.634309424 +0000
+++ /tmp/update_map	2022-12-07 00:03:09.996312588 +0000
@@ -7366,7 +7366,7 @@
"xn--jlq61u9w7b": {
GTLD:           "xn--jlq61u9w7b",
DelegationDate: "2015-12-18",
-		RemovalDate:    "",
+		RemovalDate:    "2022-12-06",
},
"xn--jvr189m": {
GTLD:           "xn--jvr189m",

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the shell monitoring script in the issue, the zlint-gtld-update command, and zlint's v3/util/gtld_map.go source map. Trace how the detected gTLD changes relate to Boulder’s issuance, pending authorization, certificate revocation, and zlint update workflows. Done should automate the currently manual response to deprecated gTLDs, but the issue does not specify an implementation boundary or tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, shell
Domain
devops, security
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.