DNS Verification Configurable Timeout and Retry Interval #6244
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi - is it possible for someone to approve the workflows - or at least tell me what steps if any I need to do to get them approved? Thanks! |
|
I’ve committed a change to make shfmt pass - the error it reported was whitespace after a “fi”. I’ve removed the whitespace and committed the one line change. If the workflow could get re-run, that’d be great - thanks! |
Neilpang
reviewed
Feb 28, 2025
| @@ -4200,7 +4200,24 @@ __purge_txt() { | |||
| _check_dns_entries() { | |||
| _success_txt="," | |||
| _end_time="$(_time)" | |||
| _end_time="$(_math "$_end_time" + 1200)" #let's check no more than 20 minutes. | |||
|
|
|||
There was a problem hiding this comment.
make _dnstimeout and _dnsinterval as parameters of _check_dns_entries() function.
Neilpang
reviewed
Feb 28, 2025
acme.sh
Outdated
| # interval (10 seconds), unless configured at script invocation to be | ||
| # something else. | ||
| _dnstimeout=1200 #default timeout is 20 minutes | ||
| if [ -n "$Le_DNSValidateTimeout" ]; then |
There was a problem hiding this comment.
move this _savedomainconf to the _issue() function.
The save operation should only happen in _issue() method
…meters to _check_dns_entries per Neilpang code review request
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
MOTIVE: At least one Domain Name Registrar (DNR) has increased the amount of time between changes you make to your zone file (via API) and their publication to the Internet. This causes DNS verification (via TXT record creation) to time out, as the current timeout is only 20 minutes long, and it retries every 10 seconds. Both the rapid retry rate and the short timeout before failure cause acme.sh to no longer work for verifying domain ownership with such DNRs. Using --dnssleep is also not optimal. It has a downside of not allowing for the DNS propagation to end up working more quickly than the sleep time, and producing the certificate sooner. By allowing a configurable retry and timeout interval, one can both be kind to the DNR (say, by trying it only once every 15-20 minutes), and 'succeeding sooner' on a successful try. Further, --dnssleep disables public DNS checks, which is suboptimal if the issue is simply slow propagation.
DISCUSSION: An ideal solution would extend the capabilities of the DNR provider scripts to specify what default domain DNS verification timeout and verification retry intervals should be for the DNR in question,so the user does not need to specify them. Then, the user could override them with the two command line options provided here. What I provide in this pull request is NOT this ideal solution, but rather just the two command line options, as getting agreement to extend what DNS API scripts need to provide would take longer, and these options are needed now.
DESIGN CHOICE TRADEOFF:
DOWNSIDE: each user of a slow publisher needs to specify these new parameters on the .acme.sh command line: if they wish to customize away from the default DNS verification and retry timers, just specify --dns-validate-interval and --dns-validate-timeout and give each of them values. For example, I use an interval of 1200 seconds for interval and 14400 for timeout. This works wonderfully for me. If the per-DNR API option were provided, users would be less likely to need these.
UPSIDE: These command line options are still needed to allow a user to work around slow propagation by their DNR, even if DNR-specific default DNS validation timer values were provided in a DNR's API script, because the DNR will often change propagation behavior without updating acme.sh API scripts. Not having these command line options would require users to modify the acme.sh code.