-
-
Notifications
You must be signed in to change notification settings - Fork 316
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updates a Cloudflare domain name record with the given IP.
- Loading branch information
Showing
7 changed files
with
242 additions
and
5 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # CFDDNS Bee | ||
|
|
||
| Updates a Cloudflare domain name record with the given IP. | ||
|
|
||
| See https://api.cloudflare.com/#getting-started-endpoints | ||
|
|
||
| ## Configuration | ||
|
|
||
| * email: Cloudflare user email | ||
| * key: Cloudflare API key | ||
| * domain: Domain name record to update | ||
|
|
||
| ## Ideas | ||
|
|
||
| * Use it in combination with the ipify bee to update a Cloudflare domain every time your public IP changes. | ||
|
|
||
| ## Credits | ||
|
|
||
| Cloudflare logo: https://www.cloudflare.com/logo/ |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| /* | ||
| * Copyright (C) 2019 Sergio Rubio | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as published | ||
| * by the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| * | ||
| * Authors: | ||
| * Sergio Rubio <sergio@rubio.im> | ||
| */ | ||
|
|
||
| package cfddns | ||
|
|
||
| import ( | ||
| "regexp" | ||
|
|
||
| "github.com/cloudflare/cloudflare-go" | ||
| "github.com/muesli/beehive/bees" | ||
| ) | ||
|
|
||
| var domainSplitter = regexp.MustCompile(".+\\.(.+\\..+)") | ||
|
|
||
| // CFDDNSBee updates a Cloudflare domain name | ||
| type CFDDNSBee struct { | ||
| bees.Bee | ||
| client *cloudflare.API | ||
| domain string | ||
| } | ||
|
|
||
| // Run executes the Bee's event loop. | ||
| func (mod *CFDDNSBee) Run(eventChan chan bees.Event) { | ||
| } | ||
|
|
||
| // Action triggers the action passed to it. | ||
| func (mod *CFDDNSBee) Action(action bees.Action) []bees.Placeholder { | ||
| outs := []bees.Placeholder{} | ||
|
|
||
| switch action.Name { | ||
| case "update_domain": | ||
| address := action.Options.Value("address").(string) | ||
| domain := mod.domain | ||
| zoneName := domainSplitter.FindStringSubmatch(domain)[1] | ||
| // Resolve the zone and record id for the host | ||
| zone, err := mod.client.ZoneIDByName(zoneName) | ||
| if err != nil { | ||
| mod.LogErrorf("zone id resolution failed: %v", err) | ||
| return outs | ||
| } | ||
| recs, err := mod.client.DNSRecords(zone, cloudflare.DNSRecord{Name: domain, Type: "A"}) | ||
| if err != nil { | ||
| mod.LogErrorf("record id resolution failed: %v", err) | ||
| return outs | ||
| } | ||
| if len(recs) != 1 { | ||
| mod.LogErrorf("invalid number of DNS records found: %+v", recs) | ||
| return outs | ||
| } | ||
| record := recs[0] | ||
|
|
||
| // Post the Cloudflare dns update | ||
| record.Content = address | ||
|
|
||
| if err := mod.client.UpdateDNSRecord(zone, record.ID, record); err != nil { | ||
| mod.LogErrorf("dns record update for %s failed: %v", domain, err) | ||
| } | ||
| default: | ||
| mod.LogDebugf("Unknown action triggered in %s: %s", mod.Name(), action.Name) | ||
| } | ||
|
|
||
| return outs | ||
| } | ||
|
|
||
| // ReloadOptions parses the config options and initializes the Bee. | ||
| func (mod *CFDDNSBee) ReloadOptions(options bees.BeeOptions) { | ||
| mod.SetOptions(options) | ||
| key := options.Value("key").(string) | ||
| user := options.Value("email").(string) | ||
| mod.domain = options.Value("domain").(string) | ||
| c, err := cloudflare.New(key, user) | ||
| if err != nil { | ||
| mod.LogFatal(err) | ||
| } | ||
| mod.client = c | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| /* | ||
| * Copyright (C) 2019 Sergio Rubio | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as published | ||
| * by the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| * | ||
| * Authors: | ||
| * Sergio Rubio <sergio@rubio.im> | ||
| */ | ||
|
|
||
| package cfddns | ||
|
|
||
| import ( | ||
| "github.com/muesli/beehive/bees" | ||
| ) | ||
|
|
||
| // CFDDNSBeeFactory takes care of initializing CFDDNSBee | ||
| type CFDDNSBeeFactory struct { | ||
| bees.BeeFactory | ||
| } | ||
|
|
||
| // New returns a new Bee instance configured with the supplied options. | ||
| func (factory *CFDDNSBeeFactory) New(name, description string, options bees.BeeOptions) bees.BeeInterface { | ||
| bee := CFDDNSBee{ | ||
| Bee: bees.NewBee(name, factory.ID(), description, options), | ||
| } | ||
| bee.ReloadOptions(options) | ||
|
|
||
| return &bee | ||
| } | ||
|
|
||
| // ID returns the ID of this Bee. | ||
| func (factory *CFDDNSBeeFactory) ID() string { | ||
| return "cfddns" | ||
| } | ||
|
|
||
| // Name returns the name of this Bee. | ||
| func (factory *CFDDNSBeeFactory) Name() string { | ||
| return "cfddns" | ||
| } | ||
|
|
||
| // Description returns the description of this Bee. | ||
| func (factory *CFDDNSBeeFactory) Description() string { | ||
| return "Updates the IP address of a Cloudflare domain name" | ||
| } | ||
|
|
||
| // Image returns the asset name of this Bee (in the assets/bees folder) | ||
| func (factory *CFDDNSBeeFactory) Image() string { | ||
| return factory.Name() + ".png" | ||
| } | ||
|
|
||
| // Events describes the available events provided by this Bee. | ||
| func (factory *CFDDNSBeeFactory) Events() []bees.EventDescriptor { | ||
| return []bees.EventDescriptor{} | ||
| } | ||
|
|
||
| // Actions describes the available actions provided by this Bee. | ||
| func (factory *CFDDNSBeeFactory) Actions() []bees.ActionDescriptor { | ||
| actions := []bees.ActionDescriptor{ | ||
| { | ||
| Namespace: factory.Name(), | ||
| Name: "update_domain", | ||
| Description: "Updates the DNS name", | ||
| Options: []bees.PlaceholderDescriptor{ | ||
| { | ||
| Name: "address", | ||
| Description: "IP addresss", | ||
| Type: "string", | ||
| Mandatory: true, | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
| return actions | ||
| } | ||
|
|
||
| // Options returns the options available to configure this Bee. | ||
| func (factory *CFDDNSBeeFactory) Options() []bees.BeeOptionDescriptor { | ||
| opts := []bees.BeeOptionDescriptor{ | ||
| { | ||
| Name: "email", | ||
| Description: "CF API user email", | ||
| Type: "string", | ||
| Mandatory: true, | ||
| }, | ||
| { | ||
| Name: "key", | ||
| Description: "CF API Key", | ||
| Type: "string", | ||
| Mandatory: true, | ||
| }, | ||
| { | ||
| Name: "domain", | ||
| Description: "CF domain to update", | ||
| Type: "string", | ||
| Mandatory: true, | ||
| }, | ||
| } | ||
| return opts | ||
| } | ||
|
|
||
| func init() { | ||
| f := CFDDNSBeeFactory{} | ||
| bees.RegisterFactory(&f) | ||
| } |
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
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
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