forked from cert-manager/webhook-example
-
Notifications
You must be signed in to change notification settings - Fork 9
/
main.go
323 lines (270 loc) · 10.7 KB
/
main.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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
package main
import (
"context"
"bytes"
"encoding/json"
"fmt"
"io"
"io/ioutil"
"net/http"
"os"
"strings"
"time"
"errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
cmeta "github.com/jetstack/cert-manager/pkg/apis/meta/v1"
extapi "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/rest"
"github.com/jetstack/cert-manager/pkg/acme/webhook/apis/acme/v1alpha1"
"github.com/jetstack/cert-manager/pkg/acme/webhook/cmd"
"github.com/jetstack/cert-manager/pkg/issuer/acme/dns/util"
pkgutil "github.com/jetstack/cert-manager/pkg/util"
)
// DNSRecord a DNS record
type DNSRecord struct {
Type string `json:"type"`
Name string `json:"name"`
Data string `json:"data"`
Priority int `json:"priority,omitempty"`
TTL int `json:"ttl,omitempty"`
}
// GroupName a API group name
var GroupName = os.Getenv("GROUP_NAME")
func main() {
if GroupName == "" {
panic("GROUP_NAME must be specified")
}
// This will register our godaddy DNS provider with the webhook serving
// library, making it available as an API under the provided GroupName.
// You can register multiple DNS provider implementations with a single
// webhook, where the Name() method will be used to disambiguate between
// the different implementations.
cmd.RunWebhookServer(GroupName,
&godaddyDNSProviderSolver{},
)
}
// godaddyDNSProviderSolver implements the provider-specific logic needed to
// 'present' an ACME challenge TXT record for your own DNS provider.
// To do so, it must implement the `github.com/jetstack/cert-manager/pkg/acme/webhook.Solver`
// interface.
type godaddyDNSProviderSolver struct {
// If a Kubernetes 'clientset' is needed, you must:
// 1. uncomment the additional `client` field in this structure below
// 2. uncomment the "k8s.io/client-go/kubernetes" import at the top of the file
// 3. uncomment the relevant code in the Initialize method below
// 4. ensure your webhook's service account has the required RBAC role
// assigned to it for interacting with the Kubernetes APIs you need.
client kubernetes.Clientset
}
// godaddyDNSProviderConfig is a structure that is used to decode into when
// solving a DNS01 challenge.
// This information is provided by cert-manager, and may be a reference to
// additional configuration that's needed to solve the challenge for this
// particular certificate or issuer.
// This typically includes references to Secret resources containing DNS
// provider credentials, in cases where a 'multi-tenant' DNS solver is being
// created.
// If you do *not* require per-issuer or per-certificate configuration to be
// provided to your webhook, you can skip decoding altogether in favour of
// using CLI flags or similar to provide configuration.
// You should not include sensitive information here. If credentials need to
// be used by your provider here, you should reference a Kubernetes Secret
// resource and fetch these credentials using a Kubernetes clientset.
type godaddyDNSProviderConfig struct {
// These fields will be set by users in the
// `issuer.spec.acme.dns01.providers.webhook.config` field.
AuthAPIKey string `json:"authApiKey"`
AuthAPISecretRef cmeta.SecretKeySelector `json:"authApiSecretRef"`
Production bool `json:"production"`
TTL int `json:"ttl"`
}
// Name is used as the name for this DNS solver when referencing it on the ACME
// Issuer resource.
// This should be unique **within the group name**, i.e. you can have two
// solvers configured with the same Name() **so long as they do not co-exist
// within a single webhook deployment**.
// For example, `cloudflare` may be used as the name of a solver.
func (c *godaddyDNSProviderSolver) Name() string {
return "godaddy"
}
// Present is responsible for actually presenting the DNS record with the
// DNS provider.
// This method should tolerate being called multiple times with the same value.
// cert-manager itself will later perform a self check to ensure that the
// solver has correctly configured the DNS provider.
func (c *godaddyDNSProviderSolver) Present(ch *v1alpha1.ChallengeRequest) error {
cfg, err := loadConfig(ch.Config)
if err != nil {
return err
}
fmt.Printf("Decoded configuration %v", cfg)
apiSecret, err := c.validateAndGetSecret(&cfg, ch.ResourceNamespace)
if err != nil {
return fmt.Errorf("Failed to validate config: %v", err)
}
// https://developer.godaddy.com/doc/endpoint/domains
// OTE environment: https://api.ote-godaddy.com
// PRODUCTION environment: https://api.godaddy.com
baseURL := "https://api.ote-godaddy.com"
if cfg.Production {
baseURL = "https://api.godaddy.com"
}
recordName := c.extractRecordName(ch.ResolvedFQDN, ch.ResolvedZone)
dnsZone, err := c.getZone(ch.ResolvedZone)
if err != nil {
return err
}
rec := []DNSRecord{
{
Type: "TXT",
Name: recordName,
Data: ch.Key,
TTL: cfg.TTL,
},
}
return c.updateRecords(cfg, baseURL, apiSecret, rec, dnsZone, recordName)
}
// CleanUp should delete the relevant TXT record from the DNS provider console.
// If multiple TXT records exist with the same record name (e.g.
// _acme-challenge.example.com) then **only** the record with the same `key`
// value provided on the ChallengeRequest should be cleaned up.
// This is in order to facilitate multiple DNS validations for the same domain
// concurrently.
func (c *godaddyDNSProviderSolver) CleanUp(ch *v1alpha1.ChallengeRequest) error {
cfg, err := loadConfig(ch.Config)
if err != nil {
return err
}
fmt.Printf("Decoded configuration %v", cfg)
apiSecret, err := c.validateAndGetSecret(&cfg, ch.ResourceNamespace)
if err != nil {
return fmt.Errorf("Failed to validate config: %v", err)
}
// https://developer.godaddy.com/doc/endpoint/domains
// OTE environment: https://api.ote-godaddy.com
// PRODUCTION environment: https://api.godaddy.com
baseURL := "https://api.ote-godaddy.com"
if cfg.Production {
baseURL = "https://api.godaddy.com"
}
recordName := c.extractRecordName(ch.ResolvedFQDN, ch.ResolvedZone)
dnsZone, err := c.getZone(ch.ResolvedZone)
if err != nil {
return err
}
rec := []DNSRecord{
{
Type: "TXT",
Name: recordName,
Data: "null",
},
}
return c.updateRecords(cfg, baseURL, apiSecret, rec, dnsZone, recordName)
}
// Initialize will be called when the webhook first starts.
// This method can be used to instantiate the webhook, i.e. initialising
// connections or warming up caches.
// Typically, the kubeClientConfig parameter is used to build a Kubernetes
// client that can be used to fetch resources from the Kubernetes API, e.g.
// Secret resources containing credentials used to authenticate with DNS
// provider accounts.
// The stopCh can be used to handle early termination of the webhook, in cases
// where a SIGTERM or similar signal is sent to the webhook process.
func (c *godaddyDNSProviderSolver) Initialize(kubeClientConfig *rest.Config, stopCh <-chan struct{}) error {
///// UNCOMMENT THE BELOW CODE TO MAKE A KUBERNETES CLIENTSET AVAILABLE TO
///// YOUR CUSTOM DNS PROVIDER
cl, err := kubernetes.NewForConfig(kubeClientConfig)
if err != nil {
return err
}
c.client = *cl
///// END OF CODE TO MAKE KUBERNETES CLIENTSET AVAILABLE
return nil
}
// loadConfig is a small helper function that decodes JSON configuration into
// the typed config struct.
func loadConfig(cfgJSON *extapi.JSON) (godaddyDNSProviderConfig, error) {
cfg := godaddyDNSProviderConfig{}
// handle the 'base case' where no configuration has been provided
if cfgJSON == nil {
return cfg, nil
}
if err := json.Unmarshal(cfgJSON.Raw, &cfg); err != nil {
return cfg, fmt.Errorf("error decoding solver config: %v", err)
}
return cfg, nil
}
func (c *godaddyDNSProviderSolver) updateRecords(cfg godaddyDNSProviderConfig, baseURL string, apiSecret string, records []DNSRecord, domainZone string, recordName string) error {
body, err := json.Marshal(records)
if err != nil {
return err
}
var resp *http.Response
url := fmt.Sprintf("/v1/domains/%s/records/TXT/%s", domainZone, recordName)
resp, err = c.makeRequest(cfg, baseURL, apiSecret, http.MethodPut, url, bytes.NewReader(body))
if err != nil {
return err
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
bodyBytes, _ := ioutil.ReadAll(resp.Body)
return fmt.Errorf("could not create record %v; Url: %s; Authorization: sso-key %s:%s; Status: %v; Body: %s", string(body), baseURL, cfg.AuthAPIKey, apiSecret, resp.StatusCode, string(bodyBytes))
}
return nil
}
func (c *godaddyDNSProviderSolver) makeRequest(cfg godaddyDNSProviderConfig, baseURL string, apiSecret string, method string, uri string, body io.Reader) (*http.Response, error) {
req, err := http.NewRequest(method, fmt.Sprintf("%s%s", baseURL, uri), body)
if err != nil {
return nil, err
}
req.Header.Set("Accept", "application/json")
req.Header.Set("User-Agent", pkgutil.CertManagerUserAgent)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", fmt.Sprintf("sso-key %s:%s", cfg.AuthAPIKey, apiSecret))
client := http.Client{
Timeout: 30 * time.Second,
}
return client.Do(req)
}
func (c *godaddyDNSProviderSolver) extractRecordName(fqdn, domain string) string {
if idx := strings.Index(fqdn, "."+domain); idx != -1 {
return fqdn[:idx]
}
return util.UnFqdn(fqdn)
}
func (c *godaddyDNSProviderSolver) extractDomainName(zone string) string {
authZone, err := util.FindZoneByFqdn(zone, util.RecursiveNameservers)
if err != nil {
return zone
}
return util.UnFqdn(authZone)
}
func (c *godaddyDNSProviderSolver) getZone(fqdn string) (string, error) {
authZone, err := util.FindZoneByFqdn(fqdn, util.RecursiveNameservers)
if err != nil {
return "", err
}
return util.UnFqdn(authZone), nil
}
func (c *godaddyDNSProviderSolver) validateAndGetSecret(cfg *godaddyDNSProviderConfig, namespace string) (string, error) {
fmt.Printf("validateAndGetSecret...")
// Check that the host is defined
if cfg.AuthAPIKey == "" {
return "", errors.New("No GoDaddy API Key provided")
}
// Try to load the API key
if cfg.AuthAPISecretRef.LocalObjectReference.Name == "" {
return "", errors.New("No GoDaddy API secret provided")
}
sec, err := c.client.CoreV1().Secrets(namespace).Get(context.TODO(), cfg.AuthAPISecretRef.LocalObjectReference.Name, metav1.GetOptions{})
if err != nil {
return "", err
}
secBytes, ok := sec.Data[cfg.AuthAPISecretRef.Key]
if !ok {
return "", fmt.Errorf("Key %q not found in secret \"%s/%s\"", cfg.AuthAPISecretRef.Key, cfg.AuthAPISecretRef.LocalObjectReference.Name, namespace)
}
apiKey := string(secBytes)
return apiKey, nil
}