2018-02-12 17:10:05 +00:00
|
|
|
// Package cloudxns implements a DNS provider for solving the DNS-01 challenge
|
|
|
|
// using cloudxns DNS.
|
|
|
|
package cloudxns
|
|
|
|
|
|
|
|
import (
|
|
|
|
"bytes"
|
|
|
|
"crypto/md5"
|
|
|
|
"encoding/hex"
|
|
|
|
"encoding/json"
|
|
|
|
"fmt"
|
|
|
|
"net/http"
|
|
|
|
"strconv"
|
|
|
|
"time"
|
|
|
|
|
2018-05-31 07:30:04 +00:00
|
|
|
"github.com/xenolf/lego/acme"
|
2018-07-03 10:44:04 +00:00
|
|
|
"github.com/xenolf/lego/platform/config/env"
|
2018-02-12 17:10:05 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
const cloudXNSBaseURL = "https://www.cloudxns.net/api2/"
|
|
|
|
|
2018-05-31 07:30:04 +00:00
|
|
|
// DNSProvider is an implementation of the acme.ChallengeProvider interface
|
2018-02-12 17:10:05 +00:00
|
|
|
type DNSProvider struct {
|
|
|
|
apiKey string
|
|
|
|
secretKey string
|
|
|
|
}
|
|
|
|
|
|
|
|
// NewDNSProvider returns a DNSProvider instance configured for cloudxns.
|
|
|
|
// Credentials must be passed in the environment variables: CLOUDXNS_API_KEY
|
|
|
|
// and CLOUDXNS_SECRET_KEY.
|
|
|
|
func NewDNSProvider() (*DNSProvider, error) {
|
2018-07-03 10:44:04 +00:00
|
|
|
values, err := env.Get("CLOUDXNS_API_KEY", "CLOUDXNS_SECRET_KEY")
|
|
|
|
if err != nil {
|
|
|
|
return nil, fmt.Errorf("CloudXNS: %v", err)
|
|
|
|
}
|
|
|
|
|
|
|
|
return NewDNSProviderCredentials(values["CLOUDXNS_API_KEY"], values["CLOUDXNS_SECRET_KEY"])
|
2018-02-12 17:10:05 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// NewDNSProviderCredentials uses the supplied credentials to return a
|
|
|
|
// DNSProvider instance configured for cloudxns.
|
|
|
|
func NewDNSProviderCredentials(apiKey, secretKey string) (*DNSProvider, error) {
|
|
|
|
if apiKey == "" || secretKey == "" {
|
|
|
|
return nil, fmt.Errorf("CloudXNS credentials missing")
|
|
|
|
}
|
|
|
|
|
|
|
|
return &DNSProvider{
|
|
|
|
apiKey: apiKey,
|
|
|
|
secretKey: secretKey,
|
|
|
|
}, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// Present creates a TXT record to fulfil the dns-01 challenge.
|
2018-07-03 10:44:04 +00:00
|
|
|
func (d *DNSProvider) Present(domain, token, keyAuth string) error {
|
2018-05-31 07:30:04 +00:00
|
|
|
fqdn, value, ttl := acme.DNS01Record(domain, keyAuth)
|
2018-07-03 10:44:04 +00:00
|
|
|
zoneID, err := d.getHostedZoneID(fqdn)
|
2018-02-12 17:10:05 +00:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2018-07-03 10:44:04 +00:00
|
|
|
return d.addTxtRecord(zoneID, fqdn, value, ttl)
|
2018-02-12 17:10:05 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// CleanUp removes the TXT record matching the specified parameters.
|
2018-07-03 10:44:04 +00:00
|
|
|
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
|
2018-05-31 07:30:04 +00:00
|
|
|
fqdn, _, _ := acme.DNS01Record(domain, keyAuth)
|
2018-07-03 10:44:04 +00:00
|
|
|
zoneID, err := d.getHostedZoneID(fqdn)
|
2018-02-12 17:10:05 +00:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2018-07-03 10:44:04 +00:00
|
|
|
recordID, err := d.findTxtRecord(zoneID, fqdn)
|
2018-02-12 17:10:05 +00:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2018-07-03 10:44:04 +00:00
|
|
|
return d.delTxtRecord(recordID, zoneID)
|
2018-02-12 17:10:05 +00:00
|
|
|
}
|
|
|
|
|
2018-07-03 10:44:04 +00:00
|
|
|
func (d *DNSProvider) getHostedZoneID(fqdn string) (string, error) {
|
2018-02-12 17:10:05 +00:00
|
|
|
type Data struct {
|
|
|
|
ID string `json:"id"`
|
|
|
|
Domain string `json:"domain"`
|
|
|
|
}
|
|
|
|
|
2018-05-31 07:30:04 +00:00
|
|
|
authZone, err := acme.FindZoneByFqdn(fqdn, acme.RecursiveNameservers)
|
2018-02-12 17:10:05 +00:00
|
|
|
if err != nil {
|
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
|
2018-07-03 10:44:04 +00:00
|
|
|
result, err := d.makeRequest(http.MethodGet, "domain", nil)
|
2018-02-12 17:10:05 +00:00
|
|
|
if err != nil {
|
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
|
|
|
|
var domains []Data
|
|
|
|
err = json.Unmarshal(result, &domains)
|
|
|
|
if err != nil {
|
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
|
|
|
|
for _, data := range domains {
|
|
|
|
if data.Domain == authZone {
|
|
|
|
return data.ID, nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-05-31 07:30:04 +00:00
|
|
|
return "", fmt.Errorf("zone %s not found in cloudxns for domain %s", authZone, fqdn)
|
2018-02-12 17:10:05 +00:00
|
|
|
}
|
|
|
|
|
2018-07-03 10:44:04 +00:00
|
|
|
func (d *DNSProvider) findTxtRecord(zoneID, fqdn string) (string, error) {
|
|
|
|
result, err := d.makeRequest(http.MethodGet, fmt.Sprintf("record/%s?host_id=0&offset=0&row_num=2000", zoneID), nil)
|
2018-02-12 17:10:05 +00:00
|
|
|
if err != nil {
|
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
|
|
|
|
var records []cloudXNSRecord
|
|
|
|
err = json.Unmarshal(result, &records)
|
|
|
|
if err != nil {
|
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
|
|
|
|
for _, record := range records {
|
2018-05-31 07:30:04 +00:00
|
|
|
if record.Host == acme.UnFqdn(fqdn) && record.Type == "TXT" {
|
2018-02-12 17:10:05 +00:00
|
|
|
return record.RecordID, nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-05-31 07:30:04 +00:00
|
|
|
return "", fmt.Errorf("no existing record found for %s", fqdn)
|
2018-02-12 17:10:05 +00:00
|
|
|
}
|
|
|
|
|
2018-07-03 10:44:04 +00:00
|
|
|
func (d *DNSProvider) addTxtRecord(zoneID, fqdn, value string, ttl int) error {
|
2018-02-12 17:10:05 +00:00
|
|
|
id, err := strconv.Atoi(zoneID)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
payload := cloudXNSRecord{
|
|
|
|
ID: id,
|
2018-05-31 07:30:04 +00:00
|
|
|
Host: acme.UnFqdn(fqdn),
|
2018-02-12 17:10:05 +00:00
|
|
|
Value: value,
|
|
|
|
Type: "TXT",
|
|
|
|
LineID: 1,
|
|
|
|
TTL: ttl,
|
|
|
|
}
|
|
|
|
|
|
|
|
body, err := json.Marshal(payload)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2018-07-03 10:44:04 +00:00
|
|
|
_, err = d.makeRequest(http.MethodPost, "record", body)
|
2018-05-31 07:30:04 +00:00
|
|
|
return err
|
2018-02-12 17:10:05 +00:00
|
|
|
}
|
|
|
|
|
2018-07-03 10:44:04 +00:00
|
|
|
func (d *DNSProvider) delTxtRecord(recordID, zoneID string) error {
|
|
|
|
_, err := d.makeRequest(http.MethodDelete, fmt.Sprintf("record/%s/%s", recordID, zoneID), nil)
|
2018-02-12 17:10:05 +00:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2018-07-03 10:44:04 +00:00
|
|
|
func (d *DNSProvider) hmac(url, date, body string) string {
|
|
|
|
sum := md5.Sum([]byte(d.apiKey + url + body + date + d.secretKey))
|
2018-02-12 17:10:05 +00:00
|
|
|
return hex.EncodeToString(sum[:])
|
|
|
|
}
|
|
|
|
|
2018-07-03 10:44:04 +00:00
|
|
|
func (d *DNSProvider) makeRequest(method, uri string, body []byte) (json.RawMessage, error) {
|
2018-02-12 17:10:05 +00:00
|
|
|
type APIResponse struct {
|
|
|
|
Code int `json:"code"`
|
|
|
|
Message string `json:"message"`
|
|
|
|
Data json.RawMessage `json:"data,omitempty"`
|
|
|
|
}
|
|
|
|
|
|
|
|
url := cloudXNSBaseURL + uri
|
|
|
|
req, err := http.NewRequest(method, url, bytes.NewReader(body))
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
requestDate := time.Now().Format(time.RFC1123Z)
|
|
|
|
|
2018-07-03 10:44:04 +00:00
|
|
|
req.Header.Set("API-KEY", d.apiKey)
|
2018-02-12 17:10:05 +00:00
|
|
|
req.Header.Set("API-REQUEST-DATE", requestDate)
|
2018-07-03 10:44:04 +00:00
|
|
|
req.Header.Set("API-HMAC", d.hmac(url, requestDate, string(body)))
|
2018-02-12 17:10:05 +00:00
|
|
|
req.Header.Set("API-FORMAT", "json")
|
|
|
|
|
2018-05-31 07:30:04 +00:00
|
|
|
resp, err := acme.HTTPClient.Do(req)
|
2018-02-12 17:10:05 +00:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
defer resp.Body.Close()
|
|
|
|
|
|
|
|
var r APIResponse
|
|
|
|
err = json.NewDecoder(resp.Body).Decode(&r)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
if r.Code != 1 {
|
|
|
|
return nil, fmt.Errorf("CloudXNS API Error: %s", r.Message)
|
|
|
|
}
|
|
|
|
return r.Data, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
type cloudXNSRecord struct {
|
|
|
|
ID int `json:"domain_id,omitempty"`
|
|
|
|
RecordID string `json:"record_id,omitempty"`
|
|
|
|
|
|
|
|
Host string `json:"host"`
|
|
|
|
Value string `json:"value"`
|
|
|
|
Type string `json:"type"`
|
|
|
|
LineID int `json:"line_id,string"`
|
|
|
|
TTL int `json:"ttl,string"`
|
|
|
|
}
|