forked from cloudflare/cloudflare-go
/
spectrum.go
302 lines (253 loc) · 9.45 KB
/
spectrum.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
package cloudflare
import (
"encoding/json"
"fmt"
"net"
"strings"
"time"
"github.com/pkg/errors"
)
// ProxyProtocol implements json.Unmarshaler in order to support deserializing of the deprecated boolean
// value for `proxy_protocol`
type ProxyProtocol string
// UnmarshalJSON handles deserializing of both the deprecated boolean value and the current string value
// for the `proxy_protocol` field.
func (p *ProxyProtocol) UnmarshalJSON(data []byte) error {
var raw interface{}
if err := json.Unmarshal(data, &raw); err != nil {
return err
}
switch pp := raw.(type) {
case string:
*p = ProxyProtocol(pp)
case bool:
if pp {
*p = "v1"
} else {
*p = "off"
}
default:
return fmt.Errorf("invalid type for proxy_protocol field: %T", pp)
}
return nil
}
// SpectrumApplication defines a single Spectrum Application.
type SpectrumApplication struct {
ID string `json:"id,omitempty"`
Protocol string `json:"protocol,omitempty"`
IPv4 bool `json:"ipv4,omitempty"`
DNS SpectrumApplicationDNS `json:"dns,omitempty"`
OriginDirect []string `json:"origin_direct,omitempty"`
OriginPort int `json:"origin_port,omitempty"`
OriginDNS *SpectrumApplicationOriginDNS `json:"origin_dns,omitempty"`
IPFirewall bool `json:"ip_firewall,omitempty"`
ProxyProtocol ProxyProtocol `json:"proxy_protocol,omitempty"`
TLS string `json:"tls,omitempty"`
TrafficType string `json:"traffic_type,omitempty"`
EdgeIPs *SpectrumApplicationEdgeIPs `json:"edge_ips,omitempty"`
ArgoSmartRouting bool `json:"argo_smart_routing,omitempty"`
CreatedOn *time.Time `json:"created_on,omitempty"`
ModifiedOn *time.Time `json:"modified_on,omitempty"`
}
// UnmarshalJSON handles setting the `ProxyProtocol` field based on the value of the deprecated `spp` field.
func (a *SpectrumApplication) UnmarshalJSON(data []byte) error {
var body map[string]interface{}
if err := json.Unmarshal(data, &body); err != nil {
return err
}
var app spectrumApplicationRaw
if err := json.Unmarshal(data, &app); err != nil {
return err
}
if spp, ok := body["spp"]; ok && spp.(bool) == true {
app.ProxyProtocol = "simple"
}
*a = SpectrumApplication(app)
return nil
}
// spectrumApplicationRaw is used to inspect an application body to support the deprecated boolean value for `spp`
type spectrumApplicationRaw SpectrumApplication
// SpectrumApplicationDNS holds the external DNS configuration for a Spectrum
// Application.
type SpectrumApplicationDNS struct {
Type string `json:"type"`
Name string `json:"name"`
}
// SpectrumApplicationOriginDNS holds the origin DNS configuration for a Spectrum
// Application.
type SpectrumApplicationOriginDNS struct {
Name string `json:"name"`
}
// SpectrumApplicationDetailResponse is the structure of the detailed response
// from the API.
type SpectrumApplicationDetailResponse struct {
Response
Result SpectrumApplication `json:"result"`
}
// SpectrumApplicationsDetailResponse is the structure of the detailed response
// from the API.
type SpectrumApplicationsDetailResponse struct {
Response
Result []SpectrumApplication `json:"result"`
}
// SpectrumApplicationEdgeIPs represents configuration for Bring-Your-Own-IP
// https://developers.cloudflare.com/spectrum/getting-started/byoip/
type SpectrumApplicationEdgeIPs struct {
Type SpectrumApplicationEdgeType `json:"type"`
Connectivity *SpectrumApplicationConnectivity `json:"connectivity,omitempty"`
IPs []net.IP `json:"ips,omitempty"`
}
// SpectrumApplicationEdgeType for possible Edge configurations
type SpectrumApplicationEdgeType string
const (
// SpectrumEdgeTypeDynamic IP config
SpectrumEdgeTypeDynamic SpectrumApplicationEdgeType = "dynamic"
// SpectrumEdgeTypeStatic IP config
SpectrumEdgeTypeStatic SpectrumApplicationEdgeType = "static"
)
// UnmarshalJSON function for SpectrumApplicationEdgeType enum
func (t *SpectrumApplicationEdgeType) UnmarshalJSON(b []byte) error {
var s string
err := json.Unmarshal(b, &s)
if err != nil {
return err
}
newEdgeType := SpectrumApplicationEdgeType(strings.ToLower(s))
switch newEdgeType {
case SpectrumEdgeTypeDynamic, SpectrumEdgeTypeStatic:
*t = newEdgeType
return nil
}
return errors.New(errUnmarshalError)
}
func (t SpectrumApplicationEdgeType) String() string {
return string(t)
}
// SpectrumApplicationConnectivity specifies IP address type on the edge configuration
type SpectrumApplicationConnectivity string
const (
// SpectrumConnectivityAll specifies IPv4/6 edge IP
SpectrumConnectivityAll SpectrumApplicationConnectivity = "all"
// SpectrumConnectivityIPv4 specifies IPv4 edge IP
SpectrumConnectivityIPv4 SpectrumApplicationConnectivity = "ipv4"
// SpectrumConnectivityIPv6 specifies IPv6 edge IP
SpectrumConnectivityIPv6 SpectrumApplicationConnectivity = "ipv6"
// SpectrumConnectivityStatic specifies static edge IP configuration
SpectrumConnectivityStatic SpectrumApplicationConnectivity = "static"
)
func (c SpectrumApplicationConnectivity) String() string {
return string(c)
}
// UnmarshalJSON function for SpectrumApplicationConnectivity enum
func (c *SpectrumApplicationConnectivity) UnmarshalJSON(b []byte) error {
var s string
err := json.Unmarshal(b, &s)
if err != nil {
return err
}
newConnectivity := SpectrumApplicationConnectivity(strings.ToLower(s))
if newConnectivity.Dynamic() {
*c = newConnectivity
return nil
}
return errors.New(errUnmarshalError)
}
// Dynamic checks if address family is specified as dynamic config
func (c SpectrumApplicationConnectivity) Dynamic() bool {
switch c {
case SpectrumConnectivityAll, SpectrumConnectivityIPv4, SpectrumConnectivityIPv6:
return true
}
return false
}
// Static checks if address family is specified as static config
func (c SpectrumApplicationConnectivity) Static() bool {
return c == SpectrumConnectivityStatic
}
// SpectrumApplications fetches all of the Spectrum applications for a zone.
//
// API reference: https://developers.cloudflare.com/spectrum/api-reference/#list-spectrum-applications
func (api *API) SpectrumApplications(zoneID string) ([]SpectrumApplication, error) {
uri := "/zones/" + zoneID + "/spectrum/apps"
res, err := api.makeRequest("GET", uri, nil)
if err != nil {
return []SpectrumApplication{}, errors.Wrap(err, errMakeRequestError)
}
var spectrumApplications SpectrumApplicationsDetailResponse
err = json.Unmarshal(res, &spectrumApplications)
if err != nil {
return []SpectrumApplication{}, errors.Wrap(err, errUnmarshalError)
}
return spectrumApplications.Result, nil
}
// SpectrumApplication fetches a single Spectrum application based on the ID.
//
// API reference: https://developers.cloudflare.com/spectrum/api-reference/#list-spectrum-applications
func (api *API) SpectrumApplication(zoneID string, applicationID string) (SpectrumApplication, error) {
uri := fmt.Sprintf(
"/zones/%s/spectrum/apps/%s",
zoneID,
applicationID,
)
res, err := api.makeRequest("GET", uri, nil)
if err != nil {
return SpectrumApplication{}, errors.Wrap(err, errMakeRequestError)
}
var spectrumApplication SpectrumApplicationDetailResponse
err = json.Unmarshal(res, &spectrumApplication)
if err != nil {
return SpectrumApplication{}, errors.Wrap(err, errUnmarshalError)
}
return spectrumApplication.Result, nil
}
// CreateSpectrumApplication creates a new Spectrum application.
//
// API reference: https://developers.cloudflare.com/spectrum/api-reference/#create-a-spectrum-application
func (api *API) CreateSpectrumApplication(zoneID string, appDetails SpectrumApplication) (SpectrumApplication, error) {
uri := "/zones/" + zoneID + "/spectrum/apps"
res, err := api.makeRequest("POST", uri, appDetails)
if err != nil {
return SpectrumApplication{}, errors.Wrap(err, errMakeRequestError)
}
var spectrumApplication SpectrumApplicationDetailResponse
err = json.Unmarshal(res, &spectrumApplication)
if err != nil {
return SpectrumApplication{}, errors.Wrap(err, errUnmarshalError)
}
return spectrumApplication.Result, nil
}
// UpdateSpectrumApplication updates an existing Spectrum application.
//
// API reference: https://developers.cloudflare.com/spectrum/api-reference/#update-a-spectrum-application
func (api *API) UpdateSpectrumApplication(zoneID, appID string, appDetails SpectrumApplication) (SpectrumApplication, error) {
uri := fmt.Sprintf(
"/zones/%s/spectrum/apps/%s",
zoneID,
appID,
)
res, err := api.makeRequest("PUT", uri, appDetails)
if err != nil {
return SpectrumApplication{}, errors.Wrap(err, errMakeRequestError)
}
var spectrumApplication SpectrumApplicationDetailResponse
err = json.Unmarshal(res, &spectrumApplication)
if err != nil {
return SpectrumApplication{}, errors.Wrap(err, errUnmarshalError)
}
return spectrumApplication.Result, nil
}
// DeleteSpectrumApplication removes a Spectrum application based on the ID.
//
// API reference: https://developers.cloudflare.com/spectrum/api-reference/#delete-a-spectrum-application
func (api *API) DeleteSpectrumApplication(zoneID string, applicationID string) error {
uri := fmt.Sprintf(
"/zones/%s/spectrum/apps/%s",
zoneID,
applicationID,
)
_, err := api.makeRequest("DELETE", uri, nil)
if err != nil {
return errors.Wrap(err, errMakeRequestError)
}
return nil
}