bba134ce87
* feat: add GetOrDefaultXXX methods. * refactor: configuration (alidns). * refactor: configuration (azure). * refactor: configuration (auroradns). * refactor: configuration (bluecat). * refactor: configuration (cloudflare). * refactor: configuration (digitalocean). * refactor: configuration (dnsimple). * refactor: configuration (dnmadeeasy). * refactor: configuration (dnspod). * refactor: configuration (duckdns). * refactor: configuration (dyn). * refactor: configuration (exoscale). * refactor: configuration (fastdns). * refactor: configuration (gandi). * refactor: configuration (gandiv5). * refactor: configuration (gcloud). * refactor: configuration (glesys). * refactor: configuration (godaddy). * refactor: configuration (iij). * refactor: configuration (lightsail). * refactor: configuration (linode). * refactor: configuration (namecheap). * refactor: configuration (namedotcom). * refactor: configuration (netcup). * refactor: configuration (nifcloud). * refactor: configuration (ns1). * refactor: configuration (otc). * refactor: configuration (ovh). * refactor: configuration (pdns). * refactor: configuration (rackspace). * refactor: configuration (rfc2136). * refactor: configuration (route53). * refactor: configuration (sakuracloud). * refactor: configuration (vegadns). * refactor: configuration (vultr).
431 lines
11 KiB
Go
431 lines
11 KiB
Go
// Package namecheap implements a DNS provider for solving the DNS-01
|
|
// challenge using namecheap DNS.
|
|
package namecheap
|
|
|
|
import (
|
|
"encoding/xml"
|
|
"errors"
|
|
"fmt"
|
|
"io/ioutil"
|
|
"net/http"
|
|
"net/url"
|
|
"strconv"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/xenolf/lego/acme"
|
|
"github.com/xenolf/lego/log"
|
|
"github.com/xenolf/lego/platform/config/env"
|
|
)
|
|
|
|
// Notes about namecheap's tool API:
|
|
// 1. Using the API requires registration. Once registered, use your account
|
|
// name and API key to access the API.
|
|
// 2. There is no API to add or modify a single DNS record. Instead you must
|
|
// read the entire list of records, make modifications, and then write the
|
|
// entire updated list of records. (Yuck.)
|
|
// 3. Namecheap's DNS updates can be slow to propagate. I've seen them take
|
|
// as long as an hour.
|
|
// 4. Namecheap requires you to whitelist the IP address from which you call
|
|
// its APIs. It also requires all API calls to include the whitelisted IP
|
|
// address as a form or query string value. This code uses a namecheap
|
|
// service to query the client's IP address.
|
|
|
|
const (
|
|
defaultBaseURL = "https://api.namecheap.com/xml.response"
|
|
getIPURL = "https://dynamicdns.park-your-domain.com/getip"
|
|
)
|
|
|
|
// A challenge represents all the data needed to specify a dns-01 challenge
|
|
// to lets-encrypt.
|
|
type challenge struct {
|
|
domain string
|
|
key string
|
|
keyFqdn string
|
|
keyValue string
|
|
tld string
|
|
sld string
|
|
host string
|
|
}
|
|
|
|
// Config is used to configure the creation of the DNSProvider
|
|
type Config struct {
|
|
Debug bool
|
|
BaseURL string
|
|
APIUser string
|
|
APIKey string
|
|
ClientIP string
|
|
PropagationTimeout time.Duration
|
|
PollingInterval time.Duration
|
|
TTL int
|
|
HTTPClient *http.Client
|
|
}
|
|
|
|
// NewDefaultConfig returns a default configuration for the DNSProvider
|
|
func NewDefaultConfig() *Config {
|
|
return &Config{
|
|
BaseURL: defaultBaseURL,
|
|
Debug: env.GetOrDefaultBool("NAMECHEAP_DEBUG", false),
|
|
TTL: env.GetOrDefaultInt("NAMECHEAP_TTL", 120),
|
|
PropagationTimeout: env.GetOrDefaultSecond("NAMECHEAP_PROPAGATION_TIMEOUT", 60*time.Minute),
|
|
PollingInterval: env.GetOrDefaultSecond("NAMECHEAP_POLLING_INTERVAL", 15*time.Second),
|
|
HTTPClient: &http.Client{
|
|
Timeout: env.GetOrDefaultSecond("NAMECHEAP_HTTP_TIMEOUT", 60*time.Second),
|
|
},
|
|
}
|
|
}
|
|
|
|
// DNSProvider is an implementation of the ChallengeProviderTimeout interface
|
|
// that uses Namecheap's tool API to manage TXT records for a domain.
|
|
type DNSProvider struct {
|
|
config *Config
|
|
}
|
|
|
|
// NewDNSProvider returns a DNSProvider instance configured for namecheap.
|
|
// Credentials must be passed in the environment variables:
|
|
// NAMECHEAP_API_USER and NAMECHEAP_API_KEY.
|
|
func NewDNSProvider() (*DNSProvider, error) {
|
|
values, err := env.Get("NAMECHEAP_API_USER", "NAMECHEAP_API_KEY")
|
|
if err != nil {
|
|
return nil, fmt.Errorf("namecheap: %v", err)
|
|
}
|
|
|
|
config := NewDefaultConfig()
|
|
config.APIUser = values["NAMECHEAP_API_USER"]
|
|
config.APIKey = values["NAMECHEAP_API_KEY"]
|
|
|
|
return NewDNSProviderConfig(config)
|
|
}
|
|
|
|
// NewDNSProviderCredentials uses the supplied credentials
|
|
// to return a DNSProvider instance configured for namecheap.
|
|
// Deprecated
|
|
func NewDNSProviderCredentials(apiUser, apiKey string) (*DNSProvider, error) {
|
|
config := NewDefaultConfig()
|
|
config.APIUser = apiUser
|
|
config.APIKey = apiKey
|
|
|
|
return NewDNSProviderConfig(config)
|
|
}
|
|
|
|
// NewDNSProviderConfig return a DNSProvider instance configured for namecheap.
|
|
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
|
|
if config == nil {
|
|
return nil, errors.New("namecheap: the configuration of the DNS provider is nil")
|
|
}
|
|
|
|
if config.APIUser == "" || config.APIKey == "" {
|
|
return nil, fmt.Errorf("namecheap: credentials missing")
|
|
}
|
|
|
|
if len(config.ClientIP) == 0 {
|
|
clientIP, err := getClientIP(config.HTTPClient, config.Debug)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("namecheap: %v", err)
|
|
}
|
|
config.ClientIP = clientIP
|
|
}
|
|
|
|
return &DNSProvider{config: config}, nil
|
|
}
|
|
|
|
// Timeout returns the timeout and interval to use when checking for DNS propagation.
|
|
// Namecheap can sometimes take a long time to complete an update, so wait up to 60 minutes for the update to propagate.
|
|
func (d *DNSProvider) Timeout() (timeout, interval time.Duration) {
|
|
return d.config.PropagationTimeout, d.config.PollingInterval
|
|
}
|
|
|
|
// Present installs a TXT record for the DNS challenge.
|
|
func (d *DNSProvider) Present(domain, token, keyAuth string) error {
|
|
tlds, err := d.getTLDs()
|
|
if err != nil {
|
|
return fmt.Errorf("namecheap: %v", err)
|
|
}
|
|
|
|
ch, err := newChallenge(domain, keyAuth, tlds)
|
|
if err != nil {
|
|
return fmt.Errorf("namecheap: %v", err)
|
|
}
|
|
|
|
hosts, err := d.getHosts(ch)
|
|
if err != nil {
|
|
return fmt.Errorf("namecheap: %v", err)
|
|
}
|
|
|
|
d.addChallengeRecord(ch, &hosts)
|
|
|
|
if d.config.Debug {
|
|
for _, h := range hosts {
|
|
log.Printf(
|
|
"%-5.5s %-30.30s %-6s %-70.70s\n",
|
|
h.Type, h.Name, h.TTL, h.Address)
|
|
}
|
|
}
|
|
|
|
err = d.setHosts(ch, hosts)
|
|
if err != nil {
|
|
return fmt.Errorf("namecheap: %v", err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// CleanUp removes a TXT record used for a previous DNS challenge.
|
|
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
|
|
tlds, err := d.getTLDs()
|
|
if err != nil {
|
|
return fmt.Errorf("namecheap: %v", err)
|
|
}
|
|
|
|
ch, err := newChallenge(domain, keyAuth, tlds)
|
|
if err != nil {
|
|
return fmt.Errorf("namecheap: %v", err)
|
|
}
|
|
|
|
hosts, err := d.getHosts(ch)
|
|
if err != nil {
|
|
return fmt.Errorf("namecheap: %v", err)
|
|
}
|
|
|
|
if removed := d.removeChallengeRecord(ch, &hosts); !removed {
|
|
return nil
|
|
}
|
|
|
|
err = d.setHosts(ch, hosts)
|
|
if err != nil {
|
|
return fmt.Errorf("namecheap: %v", err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// getClientIP returns the client's public IP address.
|
|
// It uses namecheap's IP discovery service to perform the lookup.
|
|
func getClientIP(client *http.Client, debug bool) (addr string, err error) {
|
|
resp, err := client.Get(getIPURL)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
defer resp.Body.Close()
|
|
|
|
clientIP, err := ioutil.ReadAll(resp.Body)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
if debug {
|
|
log.Println("Client IP:", string(clientIP))
|
|
}
|
|
return string(clientIP), nil
|
|
}
|
|
|
|
// newChallenge builds a challenge record from a domain name, a challenge
|
|
// authentication key, and a map of available TLDs.
|
|
func newChallenge(domain, keyAuth string, tlds map[string]string) (*challenge, error) {
|
|
domain = acme.UnFqdn(domain)
|
|
parts := strings.Split(domain, ".")
|
|
|
|
// Find the longest matching TLD.
|
|
longest := -1
|
|
for i := len(parts); i > 0; i-- {
|
|
t := strings.Join(parts[i-1:], ".")
|
|
if _, found := tlds[t]; found {
|
|
longest = i - 1
|
|
}
|
|
}
|
|
if longest < 1 {
|
|
return nil, fmt.Errorf("invalid domain name %q", domain)
|
|
}
|
|
|
|
tld := strings.Join(parts[longest:], ".")
|
|
sld := parts[longest-1]
|
|
|
|
var host string
|
|
if longest >= 1 {
|
|
host = strings.Join(parts[:longest-1], ".")
|
|
}
|
|
|
|
key, keyValue, _ := acme.DNS01Record(domain, keyAuth)
|
|
|
|
return &challenge{
|
|
domain: domain,
|
|
key: "_acme-challenge." + host,
|
|
keyFqdn: key,
|
|
keyValue: keyValue,
|
|
tld: tld,
|
|
sld: sld,
|
|
host: host,
|
|
}, nil
|
|
}
|
|
|
|
// setGlobalParams adds the namecheap global parameters to the provided url
|
|
// Values record.
|
|
func (d *DNSProvider) setGlobalParams(v *url.Values, cmd string) {
|
|
v.Set("ApiUser", d.config.APIUser)
|
|
v.Set("ApiKey", d.config.APIKey)
|
|
v.Set("UserName", d.config.APIUser)
|
|
v.Set("Command", cmd)
|
|
v.Set("ClientIp", d.config.ClientIP)
|
|
}
|
|
|
|
// getTLDs requests the list of available TLDs from namecheap.
|
|
func (d *DNSProvider) getTLDs() (tlds map[string]string, err error) {
|
|
values := make(url.Values)
|
|
d.setGlobalParams(&values, "namecheap.domains.getTldList")
|
|
|
|
reqURL, err := url.Parse(d.config.BaseURL)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
reqURL.RawQuery = values.Encode()
|
|
|
|
resp, err := d.config.HTTPClient.Get(reqURL.String())
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
defer resp.Body.Close()
|
|
|
|
if resp.StatusCode >= 400 {
|
|
return nil, fmt.Errorf("getHosts HTTP error %d", resp.StatusCode)
|
|
}
|
|
|
|
body, err := ioutil.ReadAll(resp.Body)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
var gtr getTldsResponse
|
|
if err := xml.Unmarshal(body, >r); err != nil {
|
|
return nil, err
|
|
}
|
|
if len(gtr.Errors) > 0 {
|
|
return nil, fmt.Errorf("%s [%d]", gtr.Errors[0].Description, gtr.Errors[0].Number)
|
|
}
|
|
|
|
tlds = make(map[string]string)
|
|
for _, t := range gtr.Result {
|
|
tlds[t.Name] = t.Name
|
|
}
|
|
return tlds, nil
|
|
}
|
|
|
|
// getHosts reads the full list of DNS host records using the Namecheap API.
|
|
func (d *DNSProvider) getHosts(ch *challenge) (hosts []host, err error) {
|
|
values := make(url.Values)
|
|
d.setGlobalParams(&values, "namecheap.domains.dns.getHosts")
|
|
|
|
values.Set("SLD", ch.sld)
|
|
values.Set("TLD", ch.tld)
|
|
|
|
reqURL, err := url.Parse(d.config.BaseURL)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
reqURL.RawQuery = values.Encode()
|
|
|
|
resp, err := d.config.HTTPClient.Get(reqURL.String())
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
defer resp.Body.Close()
|
|
|
|
if resp.StatusCode >= 400 {
|
|
return nil, fmt.Errorf("getHosts HTTP error %d", resp.StatusCode)
|
|
}
|
|
|
|
body, err := ioutil.ReadAll(resp.Body)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
var ghr getHostsResponse
|
|
if err = xml.Unmarshal(body, &ghr); err != nil {
|
|
return nil, err
|
|
}
|
|
if len(ghr.Errors) > 0 {
|
|
return nil, fmt.Errorf("%s [%d]", ghr.Errors[0].Description, ghr.Errors[0].Number)
|
|
}
|
|
|
|
return ghr.Hosts, nil
|
|
}
|
|
|
|
// setHosts writes the full list of DNS host records using the Namecheap API.
|
|
func (d *DNSProvider) setHosts(ch *challenge, hosts []host) error {
|
|
values := make(url.Values)
|
|
d.setGlobalParams(&values, "namecheap.domains.dns.setHosts")
|
|
|
|
values.Set("SLD", ch.sld)
|
|
values.Set("TLD", ch.tld)
|
|
|
|
for i, h := range hosts {
|
|
ind := fmt.Sprintf("%d", i+1)
|
|
values.Add("HostName"+ind, h.Name)
|
|
values.Add("RecordType"+ind, h.Type)
|
|
values.Add("Address"+ind, h.Address)
|
|
values.Add("MXPref"+ind, h.MXPref)
|
|
values.Add("TTL"+ind, h.TTL)
|
|
}
|
|
|
|
resp, err := d.config.HTTPClient.PostForm(d.config.BaseURL, values)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer resp.Body.Close()
|
|
|
|
if resp.StatusCode >= 400 {
|
|
return fmt.Errorf("setHosts HTTP error %d", resp.StatusCode)
|
|
}
|
|
|
|
body, err := ioutil.ReadAll(resp.Body)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
var shr setHostsResponse
|
|
if err := xml.Unmarshal(body, &shr); err != nil {
|
|
return err
|
|
}
|
|
if len(shr.Errors) > 0 {
|
|
return fmt.Errorf("%s [%d]", shr.Errors[0].Description, shr.Errors[0].Number)
|
|
}
|
|
if shr.Result.IsSuccess != "true" {
|
|
return fmt.Errorf("setHosts failed")
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// addChallengeRecord adds a DNS challenge TXT record to a list of namecheap
|
|
// host records.
|
|
func (d *DNSProvider) addChallengeRecord(ch *challenge, hosts *[]host) {
|
|
host := host{
|
|
Name: ch.key,
|
|
Type: "TXT",
|
|
Address: ch.keyValue,
|
|
MXPref: "10",
|
|
TTL: strconv.Itoa(d.config.TTL),
|
|
}
|
|
|
|
// If there's already a TXT record with the same name, replace it.
|
|
for i, h := range *hosts {
|
|
if h.Name == ch.key && h.Type == "TXT" {
|
|
(*hosts)[i] = host
|
|
return
|
|
}
|
|
}
|
|
|
|
// No record was replaced, so add a new one.
|
|
*hosts = append(*hosts, host)
|
|
}
|
|
|
|
// removeChallengeRecord removes a DNS challenge TXT record from a list of
|
|
// namecheap host records. Return true if a record was removed.
|
|
func (d *DNSProvider) removeChallengeRecord(ch *challenge, hosts *[]host) bool {
|
|
// Find the challenge TXT record and remove it if found.
|
|
for i, h := range *hosts {
|
|
if h.Name == ch.key && h.Type == "TXT" {
|
|
*hosts = append((*hosts)[:i], (*hosts)[i+1:]...)
|
|
return true
|
|
}
|
|
}
|
|
|
|
return false
|
|
}
|