-
Notifications
You must be signed in to change notification settings - Fork 29
/
client.go
484 lines (416 loc) · 11.9 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
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
477
478
479
480
481
482
483
484
package client
import (
"bytes"
"crypto/tls"
"errors"
"fmt"
"io/ioutil"
"log"
"net/http"
"net/url"
"strconv"
"strings"
"sync"
"time"
"github.com/ciscoecosystem/aci-go-client/container"
)
const authPayload = `{
"aaaUser" : {
"attributes" : {
"name" : "%s",
"pwd" : "%s"
}
}
}`
// Used authAppPayload to authenticate against the APIC using:
// AppName, App Certificate DN, Signed Request
const authAppPayload = `{
"aaaAppToken" : {
"attributes" : {
"appName" : "%s"
}
}
}`
// Default timeout for NGINX in ACI is 90 Seconds.
// Allow the client to set a shorter or longer time depending on their
// environment
const DefaultReqTimeoutVal uint32 = 100
const DefaultMOURL = "/api/node/mo"
// Client is the main entry point
type Client struct {
BaseURL *url.URL
MOURL string
httpClient *http.Client
AuthToken *Auth
l sync.Mutex
username string
password string
privatekey string
adminCert string
insecure bool
reqTimeoutSet bool
reqTimeoutVal uint32
proxyUrl string
preserveBaseUrlRef bool
skipLoggingPayload bool
appUserName string
*ServiceManager
}
// singleton implementation of a client
var clientImpl *Client
type Option func(*Client)
func Insecure(insecure bool) Option {
return func(client *Client) {
client.insecure = insecure
}
}
func MoURL(moURL string) Option {
return func(sm *Client) {
sm.MOURL = moURL
}
}
func Password(password string) Option {
return func(client *Client) {
client.password = password
}
}
func PrivateKey(privatekey string) Option {
return func(client *Client) {
client.privatekey = privatekey
}
}
func AdminCert(adminCert string) Option {
return func(client *Client) {
client.adminCert = adminCert
}
}
func AppUserName(appUserName string) Option {
return func(client *Client) {
client.appUserName = appUserName
}
}
func ProxyUrl(pUrl string) Option {
return func(client *Client) {
client.proxyUrl = pUrl
}
}
// HttpClient option: allows for caller to set 'httpClient' with 'Transport'.
// When this option is set 'client.proxyUrl' option is ignored.
func HttpClient(httpcl *http.Client) Option {
return func(client *Client) {
client.httpClient = httpcl
}
}
func SkipLoggingPayload(skipLoggingPayload bool) Option {
return func(client *Client) {
client.skipLoggingPayload = skipLoggingPayload
}
}
func PreserveBaseUrlRef(preserveBaseUrlRef bool) Option {
return func(client *Client) {
client.preserveBaseUrlRef = preserveBaseUrlRef
}
}
func ReqTimeout(timeout uint32) Option {
return func(client *Client) {
client.reqTimeoutSet = true
client.reqTimeoutVal = timeout
}
}
func initClient(clientUrl, username string, options ...Option) *Client {
var transport *http.Transport
bUrl, err := url.Parse(clientUrl)
if err != nil {
// cannot move forward if url is undefined
log.Fatal(err)
}
client := &Client{
BaseURL: bUrl,
username: username,
MOURL: DefaultMOURL,
}
for _, option := range options {
option(client)
}
if client.httpClient == nil {
transport = client.useInsecureHTTPClient(client.insecure)
if client.proxyUrl != "" {
transport = client.configProxy(transport)
}
client.httpClient = &http.Client{
Transport: transport,
}
}
var timeout time.Duration
if client.reqTimeoutSet {
timeout = time.Second * time.Duration(client.reqTimeoutVal)
} else {
timeout = time.Second * time.Duration(DefaultReqTimeoutVal)
}
client.httpClient.Timeout = timeout
client.ServiceManager = NewServiceManager(client.MOURL, client)
return client
}
// GetClient returns a singleton
func GetClient(clientUrl, username string, options ...Option) *Client {
if clientImpl == nil {
clientImpl = initClient(clientUrl, username, options...)
} else {
// making sure it is the same client
bUrl, err := url.Parse(clientUrl)
if err != nil {
// cannot move forward if url is undefined
log.Fatal(err)
}
if bUrl != clientImpl.BaseURL {
clientImpl = initClient(clientUrl, username, options...)
}
}
return clientImpl
}
// NewClient returns a new Instance of the client - allowing for simultaneous connections to the same APIC
func NewClient(clientUrl, username string, options ...Option) *Client {
// making sure it is the same client
_, err := url.Parse(clientUrl)
if err != nil {
// cannot move forward if url is undefined
log.Fatal(err)
}
// initClient always returns a new struct, so always create a new pointer to allow for
// multiple object instances
newClientImpl := initClient(clientUrl, username, options...)
return newClientImpl
}
func (c *Client) configProxy(transport *http.Transport) *http.Transport {
pUrl, err := url.Parse(c.proxyUrl)
if err != nil {
log.Fatal(err)
}
transport.Proxy = http.ProxyURL(pUrl)
return transport
}
func (c *Client) useInsecureHTTPClient(insecure bool) *http.Transport {
// proxyUrl, _ := url.Parse("http://10.0.1.167:3128")
transport := &http.Transport{
TLSClientConfig: &tls.Config{
CipherSuites: []uint16{
tls.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,
tls.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,
tls.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,
tls.TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,
tls.TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,
},
PreferServerCipherSuites: true,
InsecureSkipVerify: insecure,
MinVersion: tls.VersionTLS11,
MaxVersion: tls.VersionTLS12,
},
}
return transport
}
// Takes raw payload and does the http request
// Used for login request
// passwords with special chars have issues when using container
// for encoding/decoding
func (c *Client) MakeRestRequestRaw(method string, rpath string, payload []byte, authenticated bool) (*http.Request, error) {
pathURL, err := url.Parse(rpath)
if err != nil {
return nil, err
}
fURL, err := url.Parse(c.BaseURL.String())
if err != nil {
return nil, err
}
if c.preserveBaseUrlRef {
// Default is false for preserveBaseUrlRef - matching original behavior to strip out BaseURL
fURLStr := fURL.String() + pathURL.String()
fURL, err = url.Parse(fURLStr)
if err != nil {
return nil, err
}
} else {
// Original behavior to strip down BaseURL
fURL = fURL.ResolveReference(pathURL)
}
var req *http.Request
log.Printf("[DEBUG] BaseURL: %s, pathURL: %s, fURL: %s", c.BaseURL.String(), pathURL.String(), fURL.String())
if method == "GET" {
req, err = http.NewRequest(method, fURL.String(), nil)
} else {
req, err = http.NewRequest(method, fURL.String(), bytes.NewBuffer(payload))
}
if err != nil {
return nil, err
}
if c.skipLoggingPayload {
log.Printf("HTTP request %s %s", method, rpath)
} else {
log.Printf("HTTP request %s %s %v", method, rpath, req)
}
if authenticated {
req, err = c.InjectAuthenticationHeader(req, rpath)
if err != nil {
return req, err
}
}
if !c.skipLoggingPayload {
log.Printf("HTTP request after injection %s %s %v", method, rpath, req)
}
return req, nil
}
func (c *Client) MakeRestRequest(method string, rpath string, body *container.Container, authenticated bool) (*http.Request, error) {
pathURL, err := url.Parse(rpath)
if err != nil {
return nil, err
}
fURL, err := url.Parse(c.BaseURL.String())
if err != nil {
return nil, err
}
if c.preserveBaseUrlRef {
// Default is false for preserveBaseUrlRef - matching original behavior to strip out BaseURL
fURLStr := fURL.String() + pathURL.String()
fURL, err = url.Parse(fURLStr)
if err != nil {
return nil, err
}
} else {
// Original behavior to strip down BaseURL
fURL = fURL.ResolveReference(pathURL)
}
var req *http.Request
log.Printf("[DEBUG] BaseURL: %s, pathURL: %s, fURL: %s", c.BaseURL.String(), pathURL.String(), fURL.String())
if method == "GET" {
req, err = http.NewRequest(method, fURL.String(), nil)
} else {
req, err = http.NewRequest(method, fURL.String(), bytes.NewBuffer((body.Bytes())))
}
if err != nil {
return nil, err
}
if c.skipLoggingPayload {
log.Printf("HTTP request %s %s", method, rpath)
} else {
log.Printf("HTTP request %s %s %v", method, rpath, req)
}
if authenticated {
req, err = c.InjectAuthenticationHeader(req, rpath)
if err != nil {
return req, err
}
}
if !c.skipLoggingPayload {
log.Printf("HTTP request after injection %s %s %v", method, rpath, req)
}
return req, nil
}
// Authenticate is used to
func (c *Client) Authenticate() error {
method := "POST"
path := "/api/aaaLogin.json"
authenticated := false
// Adding the follwing replace allows support for (1) Login Domains, where login is in the format of: apic#LOCAL\admin2
// (2) escapes out the password to support scenarios where the user password includes backslashes
escUserName := strings.ReplaceAll(c.username, `\`, `\\`)
escPwd := strings.ReplaceAll(c.password, `\`, `\\`)
body := []byte(fmt.Sprintf(authPayload, escUserName, escPwd))
if c.appUserName != "" {
path = "/api/requestAppToken.json"
body = []byte(fmt.Sprintf(authAppPayload, c.appUserName))
authenticated = true
}
c.skipLoggingPayload = true
req, err := c.MakeRestRequestRaw(method, path, body, authenticated)
if err != nil {
return err
}
obj, _, err := c.Do(req)
c.skipLoggingPayload = false
if err != nil {
return err
}
if obj == nil {
return errors.New("Empty response")
}
err = CheckForErrors(obj, method, c.skipLoggingPayload)
if err != nil {
return err
}
token := obj.S("imdata").Index(0).S("aaaLogin", "attributes", "token").String()
creationTimeStr := stripQuotes(obj.S("imdata").Index(0).S("aaaLogin", "attributes", "creationTime").String())
refreshTimeStr := stripQuotes(obj.S("imdata").Index(0).S("aaaLogin", "attributes", "refreshTimeoutSeconds").String())
creationTimeInt, err := StrtoInt(creationTimeStr, 10, 64)
if err != nil {
return err
}
refreshTimeInt, err := StrtoInt(refreshTimeStr, 10, 64)
if err != nil {
return err
}
if token == "" {
return errors.New("Invalid Username or Password")
}
if c.AuthToken == nil {
c.AuthToken = &Auth{}
}
c.AuthToken.Token = stripQuotes(token)
c.AuthToken.apicCreatedAt = time.Unix(creationTimeInt, 0)
c.AuthToken.realCreatedAt = time.Now()
c.AuthToken.CalculateExpiry(refreshTimeInt)
c.AuthToken.CaclulateOffset()
return nil
}
func StrtoInt(s string, startIndex int, bitSize int) (int64, error) {
return strconv.ParseInt(s, startIndex, bitSize)
}
func (c *Client) Do(req *http.Request) (*container.Container, *http.Response, error) {
log.Printf("[DEBUG] Begining DO method %s", req.URL.String())
resp, err := c.httpClient.Do(req)
if err != nil {
return nil, nil, err
}
if !c.skipLoggingPayload {
log.Printf("\n\n\n HTTP request: %v", req.Body)
}
log.Printf("\nHTTP Request: %s %s", req.Method, req.URL.String())
if !c.skipLoggingPayload {
log.Printf("\nHTTP Response: %d %s %v", resp.StatusCode, resp.Status, resp)
} else {
log.Printf("\nHTTP Response: %d %s", resp.StatusCode, resp.Status)
}
bodyBytes, err := ioutil.ReadAll(resp.Body)
bodyStr := string(bodyBytes)
resp.Body.Close()
if !c.skipLoggingPayload {
log.Printf("\n HTTP response unique string %s %s %s", req.Method, req.URL.String(), bodyStr)
}
obj, err := container.ParseJSON(bodyBytes)
if err != nil {
log.Printf("Error occured while json parsing %+v", err)
return nil, resp, err
}
log.Printf("[DEBUG] Exit from do method")
return obj, resp, err
}
func (c *Client) DoRaw(req *http.Request) (*http.Response, error) {
resp, err := c.httpClient.Do(req)
if err != nil {
return nil, err
}
if !c.skipLoggingPayload {
log.Printf("\n\n\n HTTP request: %v", req.Body)
}
log.Printf("\nHTTP Request: %s %s", req.Method, req.URL.String())
if !c.skipLoggingPayload {
log.Printf("\nHTTP Response: %d %s %v", resp.StatusCode, resp.Status, resp)
} else {
log.Printf("\nHTTP Response: %d %s", resp.StatusCode, resp.Status)
}
return resp, err
}
func stripQuotes(word string) string {
if strings.HasPrefix(word, "\"") && strings.HasSuffix(word, "\"") {
return strings.TrimSuffix(strings.TrimPrefix(word, "\""), "\"")
}
return word
}