-
Notifications
You must be signed in to change notification settings - Fork 0
/
connector.go
476 lines (405 loc) · 11.6 KB
/
connector.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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
package ibclient
import (
"bytes"
"crypto/tls"
"crypto/x509"
"encoding/json"
"errors"
"fmt"
"io/ioutil"
"log"
"net/http"
"net/http/cookiejar"
"net/url"
"reflect"
"strings"
"time"
"golang.org/x/net/publicsuffix"
)
type AuthConfig struct {
Username string
Password string
ClientCert []byte
ClientKey []byte
}
type HostConfig struct {
Host string
Version string
Port string
}
type TransportConfig struct {
SslVerify bool
certPool *x509.CertPool
HttpRequestTimeout time.Duration // in seconds
HttpPoolConnections int
ProxyUrl *url.URL
}
func NewTransportConfig(sslVerify string, httpRequestTimeout int, httpPoolConnections int) (cfg TransportConfig) {
switch {
case "false" == strings.ToLower(sslVerify):
cfg.SslVerify = false
case "true" == strings.ToLower(sslVerify):
cfg.SslVerify = true
default:
caPool := x509.NewCertPool()
cert, err := ioutil.ReadFile(sslVerify)
if err != nil {
log.Printf("Cannot load certificate file '%s'", sslVerify)
return
}
if !caPool.AppendCertsFromPEM(cert) {
err = fmt.Errorf("cannot append certificate from file '%s'", sslVerify)
return
}
cfg.certPool = caPool
cfg.SslVerify = true
}
cfg.HttpPoolConnections = httpPoolConnections
cfg.HttpRequestTimeout = time.Duration(httpRequestTimeout)
return
}
type HttpRequestBuilder interface {
Init(HostConfig, AuthConfig)
BuildUrl(r RequestType, objType string, ref string, returnFields []string, queryParams *QueryParams) (urlStr string)
BuildBody(r RequestType, obj IBObject) (jsonStr []byte)
BuildRequest(r RequestType, obj IBObject, ref string, queryParams *QueryParams) (req *http.Request, err error)
}
type HttpRequestor interface {
Init(AuthConfig, TransportConfig)
SendRequest(*http.Request) ([]byte, error)
}
type WapiRequestBuilder struct {
hostCfg HostConfig
authCfg AuthConfig
}
type WapiHttpRequestor struct {
client http.Client
}
type IBConnector interface {
CreateObject(obj IBObject) (ref string, err error)
GetObject(obj IBObject, ref string, queryParams *QueryParams, res interface{}) error
DeleteObject(ref string) (refRes string, err error)
UpdateObject(obj IBObject, ref string) (refRes string, err error)
}
type Connector struct {
hostCfg HostConfig
authCfg AuthConfig
transportCfg TransportConfig
requestBuilder HttpRequestBuilder
requestor HttpRequestor
}
type RequestType int
const (
CREATE RequestType = iota
GET
DELETE
UPDATE
)
func (r RequestType) toMethod() string {
switch r {
case CREATE:
return "POST"
case GET:
return "GET"
case DELETE:
return "DELETE"
case UPDATE:
return "PUT"
}
return ""
}
func getHTTPResponseError(resp *http.Response) error {
defer resp.Body.Close()
content, _ := ioutil.ReadAll(resp.Body)
msg := fmt.Sprintf("WAPI request error: %d('%s')\nContents:\n%s\n", resp.StatusCode, resp.Status, content)
log.Printf(msg)
if resp.StatusCode == http.StatusNotFound {
return NewNotFoundError(msg)
}
return errors.New(msg)
}
func (whr *WapiHttpRequestor) Init(authCfg AuthConfig, trCfg TransportConfig) {
var certList []tls.Certificate
clientAuthType := tls.NoClientCert
if authCfg.ClientKey != nil && authCfg.ClientCert != nil {
cert, err := tls.X509KeyPair(authCfg.ClientCert, authCfg.ClientKey)
if err != nil {
log.Fatal("Invalid certificate key pair (PEM format error): ", err)
}
certList = []tls.Certificate{cert}
clientAuthType = tls.RequestClientCert
}
tr := &http.Transport{
TLSClientConfig: &tls.Config{
RootCAs: trCfg.certPool,
ClientAuth: clientAuthType,
Certificates: certList,
InsecureSkipVerify: !trCfg.SslVerify,
Renegotiation: tls.RenegotiateOnceAsClient,
},
MaxIdleConnsPerHost: trCfg.HttpPoolConnections,
Proxy: http.ProxyFromEnvironment,
}
if trCfg.ProxyUrl != nil {
tr.Proxy = http.ProxyURL(trCfg.ProxyUrl)
}
// All users of cookiejar should import "golang.org/x/net/publicsuffix"
jar, err := cookiejar.New(&cookiejar.Options{PublicSuffixList: publicsuffix.List})
if err != nil {
log.Fatal(err)
}
whr.client = http.Client{
Jar: jar,
Transport: tr,
Timeout: trCfg.HttpRequestTimeout * time.Second,
}
}
func (whr *WapiHttpRequestor) SendRequest(req *http.Request) (res []byte, err error) {
var resp *http.Response
resp, err = whr.client.Do(req)
if err != nil {
return
} else if !(resp.StatusCode == http.StatusOK ||
(resp.StatusCode == http.StatusCreated &&
req.Method == CREATE.toMethod())) {
err := getHTTPResponseError(resp)
return nil, err
}
defer resp.Body.Close()
res, err = ioutil.ReadAll(resp.Body)
if err != nil {
log.Printf("Http Reponse ioutil.ReadAll() Error: '%s'", err)
return
}
return
}
func NewWapiRequestBuilder(hostCfg HostConfig, authCfg AuthConfig) (*WapiRequestBuilder, error) {
wrb := WapiRequestBuilder{
hostCfg: hostCfg,
authCfg: authCfg,
}
return &wrb, nil
}
func (wrb *WapiRequestBuilder) Init(hostCfg HostConfig, authCfg AuthConfig) {
wrb.hostCfg = hostCfg
wrb.authCfg = authCfg
}
func (wrb *WapiRequestBuilder) BuildUrl(t RequestType, objType string, ref string, returnFields []string, queryParams *QueryParams) (urlStr string) {
path := []string{"wapi", "v" + wrb.hostCfg.Version}
if len(ref) > 0 {
path = append(path, ref)
} else {
path = append(path, objType)
}
qry := ""
vals := url.Values{}
if t == GET {
if len(returnFields) > 0 {
vals.Set("_return_fields", strings.Join(returnFields, ","))
}
if queryParams != nil {
// TODO need to get this from individual objects in future
if queryParams.forceProxy {
vals.Set("_proxy_search", "GM")
}
for k, v := range queryParams.searchFields {
vals.Set(k, v)
}
}
qry = vals.Encode()
}
u := url.URL{
Scheme: "https",
Host: wrb.hostCfg.Host + ":" + wrb.hostCfg.Port,
Path: strings.Join(path, "/"),
RawQuery: qry,
}
return u.String()
}
func (wrb *WapiRequestBuilder) BuildBody(t RequestType, obj IBObject) []byte {
var objJSON []byte
var err error
objJSON, err = json.Marshal(obj)
if err != nil {
log.Printf("Cannot marshal object '%s': %s", obj, err)
return nil
}
eaSearch := obj.EaSearch()
if t == GET && len(eaSearch) > 0 {
eaSearchJSON, err := json.Marshal(eaSearch)
if err != nil {
log.Printf("Cannot marshal EA Search attributes. '%s'\n", err)
return nil
}
objJSON = append(append(objJSON[:len(objJSON)-1], byte(',')), eaSearchJSON[1:]...)
}
return objJSON
}
func (wrb *WapiRequestBuilder) BuildRequest(t RequestType, obj IBObject, ref string, queryParams *QueryParams) (req *http.Request, err error) {
var (
objType string
returnFields []string
)
if obj != nil {
objType = obj.ObjectType()
returnFields = obj.ReturnFields()
}
urlStr := wrb.BuildUrl(t, objType, ref, returnFields, queryParams)
var bodyStr []byte
if obj != nil && (t == CREATE || t == UPDATE) {
bodyStr = wrb.BuildBody(t, obj)
}
req, err = http.NewRequest(t.toMethod(), urlStr, bytes.NewBuffer(bodyStr))
if err != nil {
log.Printf("err1: '%s'", err)
return
}
req.Header.Set("Content-Type", "application/json")
if wrb.authCfg.Username != "" {
req.SetBasicAuth(wrb.authCfg.Username, wrb.authCfg.Password)
}
return
}
func (c *Connector) makeRequest(t RequestType, obj IBObject, ref string, queryParams *QueryParams) (res []byte, err error) {
var req *http.Request
req, err = c.requestBuilder.BuildRequest(t, obj, ref, queryParams)
if err != nil {
return
}
res, err = c.requestor.SendRequest(req)
if err != nil {
if queryParams != nil {
/* Forcing the request to redirect to Grid Master by making forcedProxy=true */
queryParams.forceProxy = true
req, err = c.requestBuilder.BuildRequest(t, obj, ref, queryParams)
if err != nil {
return
}
res, err = c.requestor.SendRequest(req)
} else {
return nil, err
}
}
return
}
func (c *Connector) CreateObject(obj IBObject) (ref string, err error) {
ref = ""
queryParams := NewQueryParams(false, nil)
resp, err := c.makeRequest(CREATE, obj, "", queryParams)
if err != nil || len(resp) == 0 {
log.Printf("CreateObject request error: '%s'\n", err)
return
}
err = json.Unmarshal(resp, &ref)
if err != nil {
log.Printf("cannot unmarshall '%s', err: '%s'\n", string(resp), err)
return
}
return
}
func (c *Connector) GetObject(
// TODO: distinguish between "not found" and other kinds of errors.
obj IBObject, ref string,
queryParams *QueryParams, res interface{}) (err error) {
resp, err := c.makeRequest(GET, obj, ref, queryParams)
if err != nil {
return
}
//to check empty underlying value of interface
var result interface{}
err = json.Unmarshal(resp, &result)
if err != nil {
log.Printf("cannot unmarshall to check empty value '%s': '%s'\n", string(resp), err)
}
var data []interface{}
if resp == nil || (reflect.TypeOf(result) == reflect.TypeOf(data) && len(result.([]interface{})) == 0) {
if queryParams == nil {
err = NewNotFoundError("requested object not found")
return
}
queryParams.forceProxy = true
resp, err = c.makeRequest(GET, obj, ref, queryParams)
}
if err != nil {
log.Printf("GetObject request error: '%s'\n", err)
}
err = json.Unmarshal(resp, res)
if err != nil {
log.Printf("cannot unmarshall '%s', err: '%s'\n", string(resp), err)
return
}
if string(resp) == "[]" {
return NewNotFoundError("not found")
}
return
}
func (c *Connector) DeleteObject(ref string) (refRes string, err error) {
refRes = ""
queryParams := NewQueryParams(false, nil)
resp, err := c.makeRequest(DELETE, nil, ref, queryParams)
if err != nil {
log.Printf("DeleteObject request error: '%s'\n", err)
return
}
err = json.Unmarshal(resp, &refRes)
if err != nil {
log.Printf("cannot unmarshall '%s': '%s'\n", string(resp), err)
return
}
return
}
func (c *Connector) UpdateObject(obj IBObject, ref string) (refRes string, err error) {
queryParams := NewQueryParams(false, nil)
refRes = ""
resp, err := c.makeRequest(UPDATE, obj, ref, queryParams)
if err != nil {
log.Printf("failed to update object %s: %s", obj.ObjectType(), err)
return
}
err = json.Unmarshal(resp, &refRes)
if err != nil {
log.Printf("cannot unmarshall update object response'%s', err: '%s'\n", string(resp), err)
return
}
return
}
// Logout sends a request to invalidate the ibapauth cookie and should
// be used in a defer statement after the Connector has been successfully
// initialized.
func (c *Connector) Logout() (err error) {
queryParams := NewQueryParams(false, nil)
_, err = c.makeRequest(CREATE, nil, "logout", queryParams)
if err != nil {
log.Printf("Logout request error: '%s'\n", err)
}
return
}
var ValidateConnector = validateConnector
func validateConnector(c *Connector) (err error) {
// GET UserProfile request is used here to validate connector's basic auth and reachability.
// TODO: It seems to be broken, needs to be fixed.
//var response []UserProfile
//userprofile := NewUserProfile(UserProfile{})
//err = c.GetObject(userprofile, "", &response)
//if err != nil {
// log.Printf("Failed to connect to the Grid, err: %s \n", err)
//}
return
}
func NewConnector(hostConfig HostConfig, authCfg AuthConfig, transportConfig TransportConfig,
requestBuilder HttpRequestBuilder, requestor HttpRequestor) (res *Connector, err error) {
res = nil
connector := &Connector{
hostCfg: hostConfig,
authCfg: authCfg,
transportCfg: transportConfig,
}
//connector.requestBuilder = WapiRequestBuilder{WaipHostConfig: connector.hostCfg}
connector.requestBuilder = requestBuilder
connector.requestBuilder.Init(connector.hostCfg, connector.authCfg)
connector.requestor = requestor
connector.requestor.Init(connector.authCfg, connector.transportCfg)
res = connector
err = ValidateConnector(connector)
return
}