-
Notifications
You must be signed in to change notification settings - Fork 128
/
types.go
333 lines (284 loc) · 8.21 KB
/
types.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
323
324
325
326
327
328
329
330
331
332
333
package utils
import (
"context"
"crypto/tls"
"crypto/x509"
"fmt"
"math"
"net"
"net/http"
"net/url"
"os"
"regexp"
"strconv"
"strings"
"time"
"github.com/hashicorp/go-retryablehttp"
"github.com/kong/deck/konnect"
"github.com/kong/go-kong/kong"
"github.com/kong/go-kong/kong/custom"
"github.com/ssgelm/cookiejarparser"
)
var clientTimeout time.Duration
// KongRawState contains all of Kong Data
type KongRawState struct {
Services []*kong.Service
Routes []*kong.Route
Plugins []*kong.Plugin
Upstreams []*kong.Upstream
Targets []*kong.Target
Certificates []*kong.Certificate
SNIs []*kong.SNI
CACertificates []*kong.CACertificate
Consumers []*kong.Consumer
CustomEntities []*custom.Entity
Vaults []*kong.Vault
KeyAuths []*kong.KeyAuth
HMACAuths []*kong.HMACAuth
JWTAuths []*kong.JWTAuth
BasicAuths []*kong.BasicAuth
ACLGroups []*kong.ACLGroup
Oauth2Creds []*kong.Oauth2Credential
MTLSAuths []*kong.MTLSAuth
RBACRoles []*kong.RBACRole
RBACEndpointPermissions []*kong.RBACEndpointPermission
}
// KonnectRawState contains all of Konnect resources.
type KonnectRawState struct {
ServicePackages []*konnect.ServicePackage
Documents []*konnect.Document
}
// ErrArray holds an array of errors.
type ErrArray struct {
Errors []error
}
// Error returns a pretty string of errors present.
func (e ErrArray) Error() string {
if len(e.Errors) == 0 {
return "nil"
}
var res string
res = strconv.Itoa(len(e.Errors)) + " errors occurred:\n"
for _, err := range e.Errors {
res += fmt.Sprintf("\t%v\n", err)
}
return res
}
// KongClientConfig holds config details to use to talk to a Kong server.
type KongClientConfig struct {
Address string
Workspace string
TLSServerName string
TLSCACert string
TLSSkipVerify bool
Debug bool
SkipWorkspaceCrud bool
Headers []string
HTTPClient *http.Client
Timeout int
CookieJarPath string
TLSClientCert string
TLSClientKey string
// whether or not the client should retry on 429s
Retryable bool
}
type KonnectConfig struct {
Email string
Password string
Token string
Debug bool
Address string
Headers []string
}
// ForWorkspace returns a copy of KongClientConfig that produces a KongClient for the workspace specified by argument.
func (kc *KongClientConfig) ForWorkspace(name string) KongClientConfig {
result := *kc
result.Workspace = name
return result
}
// backoffStrategy provides a callback for Client.Backoff which
// will perform exponential backoff based on the attempt number and limited
// by the provided minimum and maximum durations.
//
// It also tries to parse Retry-After response header when a http.StatusTooManyRequests
// (HTTP Code 429) is found in the resp parameter. Hence it will return the number of
// seconds the server states it may be ready to process more requests from this client.
//
// This is the same as DefaultBackoff (https://github.com/hashicorp/go-retryablehttp/blob/v0.7.1/client.go#L503)
// except that here we are only retrying on 429s.
func backoffStrategy(min, max time.Duration, attemptNum int, resp *http.Response) time.Duration {
const (
base = 10
bitSize = 64
baseExponential = 2
)
if resp != nil && resp.StatusCode == http.StatusTooManyRequests {
if s, ok := resp.Header["Retry-After"]; ok {
if sleep, err := strconv.ParseInt(s[0], base, bitSize); err == nil {
return time.Second * time.Duration(sleep)
}
}
}
mult := math.Pow(baseExponential, float64(attemptNum)) * float64(min)
sleep := time.Duration(mult)
if float64(sleep) != mult || sleep > max {
sleep = max
}
return sleep
}
// retryPolicy provides a callback for Client.CheckRetry, which
// will retry on 429s errors.
func retryPolicy(ctx context.Context, resp *http.Response, err error) (bool, error) {
// do not retry on context.Canceled or context.DeadlineExceeded
if ctx.Err() != nil {
return false, ctx.Err()
}
// 429 Too Many Requests is recoverable. Sometimes the server puts
// a Retry-After response header to indicate when the server is
// available to start processing request from client.
if resp.StatusCode == http.StatusTooManyRequests {
return true, nil
}
return false, nil
}
func getRetryableClient(client *http.Client) *http.Client {
const (
minRetryWait = 10 * time.Second
maxRetryWait = 60 * time.Second
retryMax = 10
)
retryClient := retryablehttp.NewClient()
retryClient.HTTPClient = client
retryClient.Backoff = backoffStrategy
retryClient.CheckRetry = retryPolicy
retryClient.RetryMax = retryMax
retryClient.RetryWaitMax = maxRetryWait
retryClient.RetryWaitMin = minRetryWait
// logging is handled by deck.
retryClient.Logger = nil
return retryClient.StandardClient()
}
// GetKongClient returns a Kong client
func GetKongClient(opt KongClientConfig) (*kong.Client, error) {
var tlsConfig tls.Config
if opt.TLSSkipVerify {
tlsConfig.InsecureSkipVerify = true
}
if opt.TLSServerName != "" {
tlsConfig.ServerName = opt.TLSServerName
}
if opt.TLSCACert != "" {
certPool := x509.NewCertPool()
ok := certPool.AppendCertsFromPEM([]byte(opt.TLSCACert))
if !ok {
return nil, fmt.Errorf("failed to load TLSCACert")
}
tlsConfig.RootCAs = certPool
}
if opt.TLSClientCert != "" && opt.TLSClientKey != "" {
// Read the key pair to create certificate
cert, err := tls.X509KeyPair([]byte(opt.TLSClientCert), []byte(opt.TLSClientKey))
if err != nil {
return nil, fmt.Errorf("failed to load client certificate: %w", err)
}
tlsConfig.Certificates = []tls.Certificate{cert}
}
clientTimeout = time.Duration(opt.Timeout) * time.Second
c := opt.HTTPClient
if c == nil {
c = HTTPClient()
}
defaultTransport := http.DefaultTransport.(*http.Transport)
defaultTransport.TLSClientConfig = &tlsConfig
c.Transport = defaultTransport
address := CleanAddress(opt.Address)
headers, err := parseHeaders(opt.Headers)
if err != nil {
return nil, fmt.Errorf("parsing headers: %w", err)
}
c = kong.HTTPClientWithHeaders(c, headers)
if opt.Retryable {
c = getRetryableClient(c)
}
url, err := url.ParseRequestURI(address)
if err != nil {
return nil, fmt.Errorf("failed to parse kong address: %w", err)
}
// Add Session Cookie support if required
if opt.CookieJarPath != "" {
jar, err := cookiejarparser.LoadCookieJarFile(opt.CookieJarPath)
if err != nil {
return nil, fmt.Errorf("failed to initialize cookie-jar: %w", err)
}
c.Jar = jar
}
kongClient, err := kong.NewClient(kong.String(url.String()), c)
if err != nil {
return nil, fmt.Errorf("creating client for Kong's Admin API: %w", err)
}
if opt.Debug {
kongClient.SetDebugMode(true)
kongClient.SetLogger(os.Stderr)
}
if opt.Workspace != "" {
kongClient.SetWorkspace(opt.Workspace)
}
return kongClient, nil
}
func parseHeaders(headers []string) (http.Header, error) {
res := http.Header{}
const splitLen = 2
for _, keyValue := range headers {
split := strings.SplitN(keyValue, ":", 2)
if len(split) >= splitLen {
res.Add(split[0], split[1])
} else {
return nil, fmt.Errorf("splitting header key-value '%s'", keyValue)
}
}
return res, nil
}
func GetKonnectClient(httpClient *http.Client, config KonnectConfig) (*konnect.Client,
error,
) {
address := CleanAddress(config.Address)
if httpClient == nil {
defaultTransport := http.DefaultTransport.(*http.Transport)
httpClient = http.DefaultClient
httpClient.Transport = defaultTransport
}
headers, err := parseHeaders(config.Headers)
if err != nil {
return nil, fmt.Errorf("parsing headers: %w", err)
}
httpClient = kong.HTTPClientWithHeaders(httpClient, headers)
client, err := konnect.NewClient(httpClient, konnect.ClientOpts{
BaseURL: address,
})
if err != nil {
return nil, err
}
if config.Debug {
client.SetDebugMode(true)
client.SetLogger(os.Stderr)
}
return client, nil
}
// CleanAddress removes trailling / from a URL.
func CleanAddress(address string) string {
re := regexp.MustCompile("[/]+$")
return re.ReplaceAllString(address, "")
}
// HTTPClient returns a new Go stdlib's net/http.Client with
// sane default timeouts.
func HTTPClient() *http.Client {
return &http.Client{
Timeout: clientTimeout,
Transport: &http.Transport{
DialContext: (&net.Dialer{
Timeout: clientTimeout,
}).DialContext,
TLSHandshakeTimeout: clientTimeout,
},
}
}