Optional scoped API keys#79
Merged
Merged
Conversation
Rather than having a single API key which must be scoped for editing DNS for all zones, allow separation - one for Zone.list() and one for actually editing the records on the specified Zone
mholt
approved these changes
Jun 10, 2024
Contributor
mholt
left a comment
mholt
left a comment
There was a problem hiding this comment.
Excellent -- thanks so much for improving this module!
Closed
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Overview
This PR allows for a second API token to be optionally configured, used for fetching info about the Zones in Cloudflare.
The change is backwards compatible with existing configs - if the Zone API token is not provided, the regular API token is used for all requests.
Why
The
/zonesAPI endpoint requires that the entire token be scoped globally, which then means that the DNS edit permission must also be scoped globally. This prevents the use of a single API token to perform DNS updates to be restricted to a single zone in a multi-zone account.By splitting the token out, this global scoped token can be left as read-only, and the DNS read/write token can be scoped to a single Zone.
I believe this should address #2 (at least the original issue, I think there might be a separate issue being discussed in the comments)
Testing
I've written some small tests for this module which can be run with
go test. I believe these tests cover the old Caddyfile syntax as well as the updated one with two tokens.TODO
libdns/cloudflaregets a release tag thengo.modcan be updated to target this instead of the manual git SHA