forked from go-acme/lego
-
Notifications
You must be signed in to change notification settings - Fork 0
/
client.go
217 lines (168 loc) · 4.97 KB
/
client.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
package internal
import (
"bytes"
"context"
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
"time"
"github.com/go-acme/lego/v4/log"
"github.com/go-acme/lego/v4/providers/dns/internal/errutils"
)
// defaultBaseURL endpoint is the Gandi API endpoint used by Present and CleanUp.
const defaultBaseURL = "https://dns.api.gandi.net/api/v5"
// APIKeyHeader API key header.
const APIKeyHeader = "X-Api-Key"
// Related to Personal Access Token.
const authorizationHeader = "Authorization"
// Client the Gandi API v5 client.
type Client struct {
apiKey string
pat string
BaseURL *url.URL
HTTPClient *http.Client
}
// NewClient Creates a new Client.
func NewClient(apiKey, pat string) *Client {
baseURL, _ := url.Parse(defaultBaseURL)
return &Client{
apiKey: apiKey,
pat: pat,
BaseURL: baseURL,
HTTPClient: &http.Client{Timeout: 5 * time.Second},
}
}
func (c *Client) AddTXTRecord(ctx context.Context, domain, name, value string, ttl int) error {
// Get exiting values for the TXT records
// Needed to create challenges for both wildcard and base name domains
txtRecord, err := c.getTXTRecord(ctx, domain, name)
if err != nil {
return err
}
values := []string{value}
if len(txtRecord.RRSetValues) > 0 {
values = append(values, txtRecord.RRSetValues...)
}
newRecord := &Record{RRSetTTL: ttl, RRSetValues: values}
err = c.addTXTRecord(ctx, domain, name, newRecord)
if err != nil {
return err
}
return nil
}
func (c *Client) getTXTRecord(ctx context.Context, domain, name string) (*Record, error) {
endpoint := c.BaseURL.JoinPath("domains", domain, "records", name, "TXT")
// Get exiting values for the TXT records
// Needed to create challenges for both wildcard and base name domains
req, err := newJSONRequest(ctx, http.MethodGet, endpoint, nil)
if err != nil {
return nil, err
}
txtRecord := &Record{}
err = c.do(req, txtRecord)
if err != nil {
return nil, fmt.Errorf("unable to get TXT records for domain %s and name %s: %w", domain, name, err)
}
return txtRecord, nil
}
func (c *Client) addTXTRecord(ctx context.Context, domain, name string, newRecord *Record) error {
endpoint := c.BaseURL.JoinPath("domains", domain, "records", name, "TXT")
req, err := newJSONRequest(ctx, http.MethodPut, endpoint, newRecord)
if err != nil {
return err
}
message := apiResponse{}
err = c.do(req, &message)
if err != nil {
return fmt.Errorf("unable to create TXT record for domain %s and name %s: %w", domain, name, err)
}
if message.Message != "" {
log.Infof("API response: %s", message.Message)
}
return nil
}
func (c *Client) DeleteTXTRecord(ctx context.Context, domain, name string) error {
endpoint := c.BaseURL.JoinPath("domains", domain, "records", name, "TXT")
req, err := newJSONRequest(ctx, http.MethodDelete, endpoint, nil)
if err != nil {
return err
}
message := apiResponse{}
err = c.do(req, &message)
if err != nil {
return fmt.Errorf("unable to delete TXT record for domain %s and name %s: %w", domain, name, err)
}
if message.Message != "" {
log.Infof("API response: %s", message.Message)
}
return nil
}
func (c *Client) do(req *http.Request, result any) error {
if c.apiKey != "" {
req.Header.Set(APIKeyHeader, c.apiKey)
}
if c.pat != "" {
req.Header.Set(authorizationHeader, "Bearer "+c.pat)
}
resp, err := c.HTTPClient.Do(req)
if err != nil {
return errutils.NewHTTPDoError(req, err)
}
defer func() { _ = resp.Body.Close() }()
err = checkResponse(req, resp)
if err != nil {
return err
}
if result == nil {
return nil
}
raw, err := io.ReadAll(resp.Body)
if err != nil {
return errutils.NewReadResponseError(req, resp.StatusCode, err)
}
if len(raw) > 0 {
err = json.Unmarshal(raw, result)
if err != nil {
return errutils.NewUnmarshalError(req, resp.StatusCode, raw, err)
}
}
return nil
}
func newJSONRequest(ctx context.Context, method string, endpoint *url.URL, payload any) (*http.Request, error) {
buf := new(bytes.Buffer)
if payload != nil {
err := json.NewEncoder(buf).Encode(payload)
if err != nil {
return nil, fmt.Errorf("failed to create request JSON body: %w", err)
}
}
req, err := http.NewRequestWithContext(ctx, method, endpoint.String(), buf)
if err != nil {
return nil, fmt.Errorf("unable to create request: %w", err)
}
req.Header.Set("Accept", "application/json")
if payload != nil {
req.Header.Set("Content-Type", "application/json")
}
return req, nil
}
func checkResponse(req *http.Request, resp *http.Response) error {
if resp.StatusCode == http.StatusNotFound && resp.Request.Method == http.MethodGet {
return nil
}
if resp.StatusCode < http.StatusBadRequest {
return nil
}
return parseError(req, resp)
}
func parseError(req *http.Request, resp *http.Response) error {
raw, _ := io.ReadAll(resp.Body)
response := apiResponse{}
err := json.Unmarshal(raw, &response)
if err != nil {
return errutils.NewUnexpectedStatusCodeError(req, resp.StatusCode, raw)
}
return fmt.Errorf("%d: request failed: %s", resp.StatusCode, response.Message)
}