-
Notifications
You must be signed in to change notification settings - Fork 0
/
mythicbeasts.go
182 lines (147 loc) · 5.56 KB
/
mythicbeasts.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
// Package mythicbeasts implements a DNS provider for solving the DNS-01 challenge using Mythic Beasts API.
package mythicbeasts
import (
"context"
"errors"
"fmt"
"net/http"
"net/url"
"time"
"github.com/entrustcorporation/dv/dns01"
"github.com/go-acme/lego/v4/platform/config/env"
"github.com/entrustcorporation/dv/providers/mythicbeasts/internal"
)
// Environment variables names.
const (
envNamespace = "MYTHICBEASTS_"
EnvUserName = envNamespace + "USERNAME"
EnvPassword = envNamespace + "PASSWORD"
EnvAPIEndpoint = envNamespace + "API_ENDPOINT"
EnvAuthAPIEndpoint = envNamespace + "AUTH_API_ENDPOINT"
EnvTTL = envNamespace + "TTL"
EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
EnvPollingInterval = envNamespace + "POLLING_INTERVAL"
EnvHTTPTimeout = envNamespace + "HTTP_TIMEOUT"
)
// Config is used to configure the creation of the DNSProvider.
type Config struct {
UserName string
Password string
HTTPClient *http.Client
PropagationTimeout time.Duration
PollingInterval time.Duration
APIEndpoint *url.URL
AuthAPIEndpoint *url.URL
TTL int
}
// NewDefaultConfig returns a default configuration for the DNSProvider.
func NewDefaultConfig() (*Config, error) {
apiEndpoint, err := url.Parse(env.GetOrDefaultString(EnvAPIEndpoint, internal.APIBaseURL))
if err != nil {
return nil, fmt.Errorf("mythicbeasts: Unable to parse API URL: %w", err)
}
authEndpoint, err := url.Parse(env.GetOrDefaultString(EnvAuthAPIEndpoint, internal.AuthBaseURL))
if err != nil {
return nil, fmt.Errorf("mythicbeasts: Unable to parse AUTH API URL: %w", err)
}
return &Config{
TTL: env.GetOrDefaultInt(EnvTTL, dns01.DefaultTTL),
PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, dns01.DefaultPropagationTimeout),
PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, dns01.DefaultPollingInterval),
APIEndpoint: apiEndpoint,
AuthAPIEndpoint: authEndpoint,
HTTPClient: &http.Client{
Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 10*time.Second),
},
}, nil
}
// DNSProvider implements the challenge.Provider interface.
type DNSProvider struct {
config *Config
client *internal.Client
}
// NewDNSProvider returns a DNSProvider instance configured for mythicbeasts DNSv2 API.
// Credentials must be passed in the environment variables:
// MYTHICBEASTS_USERNAME and MYTHICBEASTS_PASSWORD.
func NewDNSProvider() (*DNSProvider, error) {
values, err := env.Get(EnvUserName, EnvPassword)
if err != nil {
return nil, fmt.Errorf("mythicbeasts: %w", err)
}
config, err := NewDefaultConfig()
if err != nil {
return nil, fmt.Errorf("mythicbeasts: %w", err)
}
config.UserName = values[EnvUserName]
config.Password = values[EnvPassword]
return NewDNSProviderConfig(config)
}
// NewDNSProviderConfig return a DNSProvider instance configured for mythicbeasts DNSv2 API.
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
if config == nil {
return nil, errors.New("mythicbeasts: the configuration of the DNS provider is nil")
}
if config.UserName == "" || config.Password == "" {
return nil, errors.New("mythicbeasts: incomplete credentials, missing username and/or password")
}
client := internal.NewClient(config.UserName, config.Password)
if config.APIEndpoint != nil {
client.APIEndpoint = config.APIEndpoint
}
if config.AuthAPIEndpoint != nil {
client.AuthEndpoint = config.AuthAPIEndpoint
}
if config.HTTPClient != nil {
client.HTTPClient = config.HTTPClient
}
return &DNSProvider{config: config, client: client}, nil
}
// Present creates a TXT record using the specified parameters.
func (d *DNSProvider) Present(domain, token, keyAuth string) error {
info := dns01.GetChallengeInfo(domain, keyAuth)
authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
if err != nil {
return fmt.Errorf("mythicbeasts: could not find zone for domain %q (%s): %w", domain, info.EffectiveFQDN, err)
}
subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, authZone)
if err != nil {
return fmt.Errorf("mythicbeasts: %w", err)
}
authZone = dns01.UnFqdn(authZone)
ctx, err := d.client.CreateAuthenticatedContext(context.Background())
if err != nil {
return fmt.Errorf("mythicbeasts: login: %w", err)
}
err = d.client.CreateTXTRecord(ctx, authZone, subDomain, info.Value, d.config.TTL)
if err != nil {
return fmt.Errorf("mythicbeasts: CreateTXTRecord: %w", err)
}
return nil
}
// CleanUp removes the TXT record matching the specified parameters.
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
info := dns01.GetChallengeInfo(domain, keyAuth)
authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
if err != nil {
return fmt.Errorf("mythicbeasts: could not find zone for domain %q (%s): %w", domain, info.EffectiveFQDN, err)
}
subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, authZone)
if err != nil {
return fmt.Errorf("mythicbeasts: %w", err)
}
authZone = dns01.UnFqdn(authZone)
ctx, err := d.client.CreateAuthenticatedContext(context.Background())
if err != nil {
return fmt.Errorf("mythicbeasts: login: %w", err)
}
err = d.client.RemoveTXTRecord(ctx, authZone, subDomain, info.Value)
if err != nil {
return fmt.Errorf("mythicbeasts: RemoveTXTRecord: %w", err)
}
return 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
}