Add a User-Agent header to test_challenges.py #1595
Merged
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.
What
This PR adds a User-Agent header to the HTTP request made by test_challenges.py module in Ansible
letsencryptrole. The test challenge step is performed by during provisioning.Why?
Some hosts have a Web Application Firewall. It's a common rule to block an HTTP request with no User-Agent header. This happened to me when setting up AWS Cloudfront with a WAF in front of Trellis sites.
Also, while not required by this RFC, adding the header is labeled as a "SHOULD".
Finally, having the header in the request would also help when debugging. It's easier to identify the failed test challenge request when its User-Agent contains "Trellis" and "Ansible".