1
0
mirror of https://github.com/go-acme/lego.git synced 2024-12-25 11:02:56 +02:00
lego/providers/dns/httpreq/httpreq.go

204 lines
4.9 KiB
Go
Raw Normal View History

2018-11-08 19:51:13 +02:00
// Package httpreq implements a DNS provider for solving the DNS-01 challenge through a HTTP server.
package httpreq
import (
"bytes"
"encoding/json"
"errors"
"fmt"
2021-08-25 11:44:11 +02:00
"io"
2018-11-08 19:51:13 +02:00
"net/http"
"net/url"
"time"
2020-09-02 03:20:01 +02:00
"github.com/go-acme/lego/v4/challenge/dns01"
"github.com/go-acme/lego/v4/platform/config/env"
2018-11-08 19:51:13 +02:00
)
// Environment variables names.
const (
envNamespace = "HTTPREQ_"
EnvEndpoint = envNamespace + "ENDPOINT"
EnvMode = envNamespace + "MODE"
EnvUsername = envNamespace + "USERNAME"
EnvPassword = envNamespace + "PASSWORD"
EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
EnvPollingInterval = envNamespace + "POLLING_INTERVAL"
EnvHTTPTimeout = envNamespace + "HTTP_TIMEOUT"
)
2018-11-08 19:51:13 +02:00
type message struct {
FQDN string `json:"fqdn"`
Value string `json:"value"`
}
type messageRaw struct {
Domain string `json:"domain"`
Token string `json:"token"`
KeyAuth string `json:"keyAuth"`
}
2020-05-08 19:35:25 +02:00
// Config is used to configure the creation of the DNSProvider.
2018-11-08 19:51:13 +02:00
type Config struct {
Endpoint *url.URL
Mode string
Username string
Password string
PropagationTimeout time.Duration
PollingInterval time.Duration
HTTPClient *http.Client
}
2020-05-08 19:35:25 +02:00
// NewDefaultConfig returns a default configuration for the DNSProvider.
2018-11-08 19:51:13 +02:00
func NewDefaultConfig() *Config {
return &Config{
PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, dns01.DefaultPropagationTimeout),
PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, dns01.DefaultPollingInterval),
2018-11-08 19:51:13 +02:00
HTTPClient: &http.Client{
Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 30*time.Second),
2018-11-08 19:51:13 +02:00
},
}
}
2020-05-08 19:35:25 +02:00
// DNSProvider implements the challenge.Provider interface.
2018-11-08 19:51:13 +02:00
type DNSProvider struct {
config *Config
}
// NewDNSProvider returns a DNSProvider instance.
func NewDNSProvider() (*DNSProvider, error) {
values, err := env.Get(EnvEndpoint)
2018-11-08 19:51:13 +02:00
if err != nil {
2020-02-27 20:14:46 +02:00
return nil, fmt.Errorf("httpreq: %w", err)
2018-11-08 19:51:13 +02:00
}
endpoint, err := url.Parse(values[EnvEndpoint])
2018-11-08 19:51:13 +02:00
if err != nil {
2020-02-27 20:14:46 +02:00
return nil, fmt.Errorf("httpreq: %w", err)
2018-11-08 19:51:13 +02:00
}
config := NewDefaultConfig()
config.Mode = env.GetOrFile(EnvMode)
config.Username = env.GetOrFile(EnvUsername)
config.Password = env.GetOrFile(EnvPassword)
2018-11-08 19:51:13 +02:00
config.Endpoint = endpoint
return NewDNSProviderConfig(config)
}
2019-08-20 18:40:41 +02:00
// NewDNSProviderConfig return a DNSProvider.
2018-11-08 19:51:13 +02:00
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
if config == nil {
return nil, errors.New("httpreq: the configuration of the DNS provider is nil")
}
if config.Endpoint == nil {
return nil, errors.New("httpreq: the endpoint is missing")
}
return &DNSProvider{config: config}, nil
}
// Timeout returns the timeout and interval to use when checking for DNS propagation.
// Adjusting here to cope with spikes in propagation times.
func (d *DNSProvider) Timeout() (timeout, interval time.Duration) {
return d.config.PropagationTimeout, d.config.PollingInterval
}
2020-05-08 19:35:25 +02:00
// Present creates a TXT record to fulfill the dns-01 challenge.
2018-11-08 19:51:13 +02:00
func (d *DNSProvider) Present(domain, token, keyAuth string) error {
if d.config.Mode == "RAW" {
msg := &messageRaw{
Domain: domain,
Token: token,
KeyAuth: keyAuth,
}
err := d.doPost("/present", msg)
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("httpreq: %w", err)
2018-11-08 19:51:13 +02:00
}
return nil
}
fqdn, value := dns01.GetRecord(domain, keyAuth)
2018-11-08 19:51:13 +02:00
msg := &message{
FQDN: fqdn,
Value: value,
}
err := d.doPost("/present", msg)
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("httpreq: %w", err)
2018-11-08 19:51:13 +02:00
}
return nil
}
2020-05-08 19:35:25 +02:00
// CleanUp removes the TXT record matching the specified parameters.
2018-11-08 19:51:13 +02:00
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
if d.config.Mode == "RAW" {
msg := &messageRaw{
Domain: domain,
Token: token,
KeyAuth: keyAuth,
}
err := d.doPost("/cleanup", msg)
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("httpreq: %w", err)
2018-11-08 19:51:13 +02:00
}
return nil
}
fqdn, value := dns01.GetRecord(domain, keyAuth)
2018-11-08 19:51:13 +02:00
msg := &message{
FQDN: fqdn,
Value: value,
}
err := d.doPost("/cleanup", msg)
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("httpreq: %w", err)
2018-11-08 19:51:13 +02:00
}
return nil
}
func (d *DNSProvider) doPost(uri string, msg interface{}) error {
reqBody := &bytes.Buffer{}
err := json.NewEncoder(reqBody).Encode(msg)
if err != nil {
return err
}
2023-02-09 18:19:58 +02:00
endpoint := d.config.Endpoint.JoinPath(uri)
2018-11-08 19:51:13 +02:00
req, err := http.NewRequest(http.MethodPost, endpoint.String(), reqBody)
if err != nil {
return err
}
req.Header.Set("Content-Type", "application/json")
if len(d.config.Username) > 0 && len(d.config.Password) > 0 {
req.SetBasicAuth(d.config.Username, d.config.Password)
}
resp, err := d.config.HTTPClient.Do(req)
if err != nil {
return err
}
defer resp.Body.Close()
if resp.StatusCode >= http.StatusBadRequest {
2021-08-25 11:44:11 +02:00
body, err := io.ReadAll(resp.Body)
2018-11-08 19:51:13 +02:00
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("%d: failed to read response body: %w", resp.StatusCode, err)
2018-11-08 19:51:13 +02:00
}
return fmt.Errorf("%d: request failed: %v", resp.StatusCode, string(body))
}
return nil
}