Skip to content

Commit 0f35b5f

Browse files
hugomdhugomd
authored
Merge pull request #9 from nchlswhttkr/use-zone-id-and-tokens
Change Cloudflare provider to use API tokens
2 parents 65f2ac6 + a49d540 commit 0f35b5f

File tree

3 files changed

+59
-88
lines changed

3 files changed

+59
-88
lines changed

‎README.md

+24-12
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,19 @@ Example with the Cloudflare [provider](#supported-providers):
77
```
88
docker run \
99
-e PROVIDER=cloudflare \
10-
-e CLOUDFLARE_APIKEY=YOUR_API_KEY \
11-
-e CLOUDFLARE_ZONE=YOUR_ZONE \
10+
-e CLOUDFLARE_APITOKEN=YOUR_API_TOKEN \
11+
-e CLOUDFLARE_ZONEID=YOUR_ZONE_ID \
1212
-e CLOUDFLARE_HOST=YOUR_DOMAIN \
13-
-e CLOUDFLARE_EMAIL=YOUR_CLOUDFLARE_EMAIL \
1413
hugomd/cloudflare-ddns
1514
```
1615

1716
Example running as a persistant daemon:
1817
```
1918
docker run -d --restart always \
2019
-e PROVIDER=cloudflare \
21-
-e CLOUDFLARE_APIKEY=YOUR_API_KEY \
22-
-e CLOUDFLARE_ZONE=YOUR_ZONE \
20+
-e CLOUDFLARE_APITOKEN=YOUR_API_TOKEN \
21+
-e CLOUDFLARE_ZONEID=YOUR_ZONE_ID \
2322
-e CLOUDFLARE_HOST=YOUR_DOMAIN \
24-
-e CLOUDFLARE_EMAIL=YOUR_CLOUDFLARE_EMAIL \
2523
hugomd/cloudflare-ddns -duration 2h
2624
```
2725

@@ -57,12 +55,26 @@ All providers require the following environment variable:
5755

5856
## Cloudflare
5957

60-
| Environment Variable | Description | Example | Required |
61-
|---------------------------------|-------------------------------------------------------------------------------------------------------------------------|-------------------------|----------|
62-
| `CLOUDFLARE_APIKEY` | [Cloudflare API key](https://support.cloudflare.com/hc/en-us/articles/200167836-Where-do-I-find-my-Cloudflare-API-key-) | `12345` | `true` |
63-
| `CLOUDFLARE_ZONE` | [Cloudflare Zone](https://api.cloudflare.com/#zone-properties) | `example.com` | `true` |
64-
| `CLOUDFLARE_HOST` | The record you want to update | `subdomain.example.com` | `true` |
65-
| `CLOUDFLARE_EMAIL` | Email associated with your Cloudflare account | `[email protected]` | `true` |
58+
| Environment Variable | Description | Example | Required |
59+
| ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | -------- |
60+
| `CLOUDFLARE_APITOKEN` | An [API Token](https://support.cloudflare.com/hc/en-us/articles/200167836-Managing-API-Tokens-and-Keys), with permission to edit DNS records for your zone | `12345` | `true` |
61+
| `CLOUDFLARE_ZONEID` | The Zone ID of your domain in Cloudflare (you can find this in the "Overview" tab at the bottom of the page) | `dd255baaaaad2e8...` | `true` |
62+
| `CLOUDFLARE_HOST` | The record you want to update | `subdomain.example.com` | `true` |
63+
| `CLOUDFLARE_ZONE` **DEPRECATED** | [Cloudflare Zone](https://api.cloudflare.com/#zone-properties) | `example.com` | |
64+
| `CLOUDFLARE_EMAIL` **DEPRECATED** | Email associated with your Cloudflare account | `[email protected]` | |
65+
| `CLOUDFLARE_APIKEY` **DEPRECATED** | [Cloudflare API key](https://support.cloudflare.com/hc/en-us/articles/200167836-Where-do-I-find-my-Cloudflare-API-key-) | `12345` | |
66+
67+
### Deprecated Environment Variables
68+
69+
Cloudflare now [supports API tokens](https://blog.cloudflare.com/api-tokens-general-availability/) as a more secure way of interacting with their API. Instead of using your global API key/email, you should use a token with limited permissions.
70+
71+
When upgrading, you'll need to replace a few existing environment variables.
72+
73+
Instead of providing a `CLOUDFLARE_ZONE` with your domain name, you should specify the Zone ID (`CLOUDFLARE_ZONEID`) of your domain. You can find this in the "Overview" tab for your domain.
74+
75+
Instead of your `CLOUDFLARE_EMAIL` and `CLOUDFLARE_APIKEY`, you should [generate a token](https://support.cloudflare.com/hc/en-us/articles/200167836-Managing-API-Tokens-and-Keys#12345680) (`CLOUDFLARE_APITOKEN`) with permission to edit DNS records for your desired zone.
76+
77+
You don't need to make any changes to your `CLOUDFLARE_HOST`.
6678

6779
# Contributing
6880

‎lib/providers/cloudflare/api.go

+13-39
Original file line numberDiff line numberDiff line change
@@ -10,41 +10,31 @@ import (
1010
)
1111

1212
type CloudflareAPI struct {
13-
Zone string
13+
ZoneID string
1414
Host string
15-
APIKey string
16-
Email string
15+
APIToken string
1716
BaseURL string
1817
httpClient *http.Client
1918
}
2019

21-
type Zone struct {
22-
ID string `json:"id"`
23-
Name string `json:"name"`
24-
}
25-
26-
type ZoneResponse struct {
27-
Result []Zone `json:"result"`
28-
}
29-
3020
type Record struct {
3121
ID string `json:"id"`
3222
Type string `json:"type"`
3323
Content string `json:"content"`
3424
Name string `json:"name"`
25+
Proxied bool `json:"proxied"`
3526
}
3627

3728
type RecordResponse struct {
3829
Result []Record `json:"result"`
3930
}
4031

41-
func NewCloudflareClient(key string, email string, zone string, host string) (*CloudflareAPI, error) {
32+
func NewCloudflareClient(token string, zoneID string, host string) (*CloudflareAPI, error) {
4233
api := CloudflareAPI{
43-
Zone: zone,
44-
Host: host,
45-
APIKey: key,
46-
Email: email,
47-
BaseURL: "https://api.cloudflare.com/client/v4",
34+
ZoneID: zoneID,
35+
Host: host,
36+
APIToken: token,
37+
BaseURL: "https://api.cloudflare.com/client/v4",
4838
}
4939

5040
if api.httpClient == nil {
@@ -54,23 +44,8 @@ func NewCloudflareClient(key string, email string, zone string, host string) (*C
5444
return &api, nil
5545
}
5646

57-
func (api *CloudflareAPI) ListZones() ([]Zone, error) {
58-
uri := fmt.Sprintf("/zones?name=%s", api.Zone)
59-
resp, err := api.request("GET", uri, nil)
60-
if err != nil {
61-
return nil, err
62-
}
63-
var r ZoneResponse
64-
err = json.Unmarshal(resp, &r)
65-
66-
if err != nil {
67-
return nil, err
68-
}
69-
return r.Result, nil
70-
}
71-
72-
func (api *CloudflareAPI) ListDNSRecords(zone Zone) ([]Record, error) {
73-
uri := fmt.Sprintf("/zones/%s/dns_records?name=%s", zone.ID, api.Host)
47+
func (api *CloudflareAPI) ListDNSRecords() ([]Record, error) {
48+
uri := fmt.Sprintf("/zones/%s/dns_records?type=A&name=%s", api.ZoneID, api.Host)
7449
resp, err := api.request("GET", uri, nil)
7550
if err != nil {
7651
return nil, err
@@ -86,8 +61,8 @@ func (api *CloudflareAPI) ListDNSRecords(zone Zone) ([]Record, error) {
8661
return r.Result, nil
8762
}
8863

89-
func (api *CloudflareAPI) UpdateDNSRecord(record Record, zone Zone) error {
90-
uri := fmt.Sprintf("/zones/%s/dns_records/%s", zone.ID, record.ID)
64+
func (api *CloudflareAPI) UpdateDNSRecord(record Record) error {
65+
uri := fmt.Sprintf("/zones/%s/dns_records/%s", api.ZoneID, record.ID)
9166

9267
payload := new(bytes.Buffer)
9368
json.NewEncoder(payload).Encode(record)
@@ -106,8 +81,7 @@ func (api *CloudflareAPI) request(method string, uri string, body io.Reader) ([]
10681
return nil, err
10782
}
10883

109-
req.Header.Set("X-Auth-Email", api.Email)
110-
req.Header.Set("X-Auth-Key", api.APIKey)
84+
req.Header.Set("Authorization", fmt.Sprintf("Bearer %s", api.APIToken))
11185

11286
resp, err := api.httpClient.Do(req)
11387
if err != nil {

‎lib/providers/cloudflare/cloudflare.go

+22-37
Original file line numberDiff line numberDiff line change
@@ -15,35 +15,37 @@ func init() {
1515
providers.RegisterProvider("cloudflare", NewProvider)
1616
}
1717

18-
var ZONE, HOST string
18+
var ZONEID, HOST string
1919

2020
func NewProvider() (providers.Provider, error) {
21-
APIKEY := os.Getenv("CLOUDFLARE_APIKEY")
22-
if APIKEY == "" {
23-
log.Fatal("CLOUDFLARE_APIKEY env. variable is required")
21+
// Check for use of any deprecated variables first, point to how to update
22+
if os.Getenv("CLOUDFLARE_APIKEY") != "" {
23+
log.Fatal("Do not use CLOUDFLARE_APIKEY, see https://github.com/hugomd/cloudflare-ddns#deprecated-environment-variables")
2424
}
25-
26-
ZONE = os.Getenv("CLOUDFLARE_ZONE")
27-
if APIKEY == "" {
28-
log.Fatal("CLOUDFLARE_ZONE env. variable is required")
25+
if os.Getenv("CLOUDFLARE_EMAIL") != "" {
26+
log.Fatal("Do not use CLOUDFLARE_EMAIL, see https://github.com/hugomd/cloudflare-ddns#deprecated-environment-variables")
27+
}
28+
if os.Getenv("CLOUDFLARE_ZONE") != "" {
29+
log.Fatal("Do not use CLOUDFLARE_ZONE, see https://github.com/hugomd/cloudflare-ddns#deprecated-environment-variables")
2930
}
3031

31-
HOST = os.Getenv("CLOUDFLARE_HOST")
32-
if HOST == "" {
33-
log.Fatal("CLOUDFLARE_HOST env. variable is required")
32+
APITOKEN := os.Getenv("CLOUDFLARE_APITOKEN")
33+
if APITOKEN == "" {
34+
log.Fatal("CLOUDFLARE_APITOKEN env. variable is required")
3435
}
3536

36-
EMAIL := os.Getenv("CLOUDFLARE_EMAIL")
37-
if EMAIL == "" {
38-
log.Fatal("CLOUDFLARE_EMAIL env. variable is required")
37+
ZONEID = os.Getenv("CLOUDFLARE_ZONEID")
38+
if ZONEID == "" {
39+
log.Fatal("CLOUDFLARE_ZONEID env. variable is required")
3940
}
4041

41-
// Check for use of any deprecated variables first, point to how to update
42-
if os.Getenv("CLOUDFLARE_APIKEY") != "" || os.Getenv("CLOUDFLARE_EMAIL") != "" || os.Getenv("CLOUDFLARE_ZONE") != "" {
43-
log.Print("WARNING: CLOUDFLARE_APIKEY, CLOUDFLARE_EMAIL and CLOUDFLARE_ZONE are deprecated environment variables and are unsupported. Please see https://github.com/hugomd/cloudflare-ddns#deprecated-environment-variables for more information")
42+
HOST = os.Getenv("CLOUDFLARE_HOST")
43+
if HOST == "" {
44+
log.Fatal("CLOUDFLARE_HOST env. variable is required")
4445
}
4546

46-
api, err := NewCloudflareClient(APIKEY, EMAIL, ZONE, HOST)
47+
api, err := NewCloudflareClient(APITOKEN, ZONEID, HOST)
48+
4749
if err != nil {
4850
return nil, err
4951
}
@@ -56,24 +58,7 @@ func NewProvider() (providers.Provider, error) {
5658
}
5759

5860
func (api *Cloudflare) UpdateRecord(ip string) error {
59-
zones, err := api.client.ListZones()
60-
if err != nil {
61-
return err
62-
}
63-
64-
var zone Zone
65-
66-
for i := range zones {
67-
if zones[i].Name == ZONE {
68-
zone = zones[i]
69-
}
70-
}
71-
72-
if zone == (Zone{}) {
73-
return errors.New("Zone not found")
74-
}
75-
76-
records, err := api.client.ListDNSRecords(zone)
61+
records, err := api.client.ListDNSRecords()
7762
if err != nil {
7863
return err
7964
}
@@ -91,7 +76,7 @@ func (api *Cloudflare) UpdateRecord(ip string) error {
9176

9277
if ip != record.Content {
9378
record.Content = ip
94-
err = api.client.UpdateDNSRecord(record, zone)
79+
err = api.client.UpdateDNSRecord(record)
9580
if err != nil {
9681
return err
9782
}

0 commit comments

Comments
 (0)