forked from TykTechnologies/tyk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
handler_success.go
385 lines (324 loc) · 10.6 KB
/
handler_success.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
package main
import (
"bytes"
"encoding/base64"
"io"
"net/http"
"runtime/pprof"
"strconv"
"strings"
"time"
"github.com/pmylund/go-cache"
)
// Enums for keys to be stored in a session context - this is how gorilla expects
// these to be implemented and is lifted pretty much from docs
const (
SessionData = iota
AuthHeaderValue
VersionData
VersionKeyContext
OrgSessionContext
ContextData
RetainHost
TrackThisEndpoint
DoNotTrackThisEndpoint
)
var SessionCache = cache.New(10*time.Second, 5*time.Second)
var ExpiryCache = cache.New(600*time.Second, 10*time.Minute)
type ReturningHttpHandler interface {
ServeHTTP(http.ResponseWriter, *http.Request) *http.Response
ServeHTTPForCache(http.ResponseWriter, *http.Request) *http.Response
CopyResponse(io.Writer, io.Reader)
New(interface{}, *APISpec) (TykResponseHandler, error)
}
// TykMiddleware wraps up the ApiSpec and Proxy objects to be included in a
// middleware handler, this can probably be handled better.
type TykMiddleware struct {
Spec *APISpec
Proxy ReturningHttpHandler
}
func (t *TykMiddleware) New() {}
func (t *TykMiddleware) IsEnabledForSpec() bool {
return true
}
func (t *TykMiddleware) GetConfig() (interface{}, error) {
return nil, nil
}
func (t *TykMiddleware) GetOrgSession(key string) (SessionState, bool) {
// Try and get the session from the session store
session, found := t.Spec.OrgSessionManager.GetSessionDetail(key)
if found {
// If exists, assume it has been authorized and pass on
if config.EnforceOrgDataAge {
// We cache org expiry data
log.Debug("Setting data expiry: ", session.OrgID)
go t.SetOrgExpiry(session.OrgID, session.DataExpires)
}
return session, true
}
return session, found
}
func (t *TykMiddleware) SetOrgExpiry(orgid string, expiry int64) {
ExpiryCache.Set(orgid, expiry, cache.DefaultExpiration)
}
func (t *TykMiddleware) GetOrgSessionExpiry(orgid string) int64 {
log.Debug("Checking: ", orgid)
cachedVal, found := ExpiryCache.Get(orgid)
if !found {
go t.GetOrgSession(orgid)
log.Debug("no cached entry found, returning 7 days")
return 604800
}
return cachedVal.(int64)
}
// ApplyPolicyIfExists will check if a policy is loaded, if it is, it will overwrite the session state to use the policy values
func (t *TykMiddleware) ApplyPolicyIfExists(key string, session *SessionState) {
if session.ApplyPolicyID == "" {
return
}
policy, ok := Policies[session.ApplyPolicyID]
if !ok {
return
}
// Check ownership, policy org owner must be the same as API,
// otherwise youcould overwrite a session key with a policy from a different org!
if policy.OrgID != t.Spec.OrgID {
log.Error("Attempting to apply policy from different organisation to key, skipping")
return
}
if policy.Partitions.Quota || policy.Partitions.RateLimit || policy.Partitions.Acl {
// This is a partitioned policy, only apply what is active
if policy.Partitions.Quota {
// Quotas
session.QuotaMax = policy.QuotaMax
session.QuotaRenewalRate = policy.QuotaRenewalRate
}
if policy.Partitions.RateLimit {
// Rate limting
session.Allowance = policy.Rate // This is a legacy thing, merely to make sure output is consistent. Needs to be purged
session.Rate = policy.Rate
session.Per = policy.Per
if policy.LastUpdated != "" {
session.LastUpdated = policy.LastUpdated
}
}
if policy.Partitions.Acl {
// ACL
session.AccessRights = policy.AccessRights
session.HMACEnabled = policy.HMACEnabled
}
} else {
// This is not a partitioned policy, apply everything
// Quotas
session.QuotaMax = policy.QuotaMax
session.QuotaRenewalRate = policy.QuotaRenewalRate
// Rate limting
session.Allowance = policy.Rate // This is a legacy thing, merely to make sure output is consistent. Needs to be purged
session.Rate = policy.Rate
session.Per = policy.Per
if policy.LastUpdated != "" {
session.LastUpdated = policy.LastUpdated
}
// ACL
session.AccessRights = policy.AccessRights
session.HMACEnabled = policy.HMACEnabled
}
// Required for all
session.IsInactive = policy.IsInactive
session.Tags = policy.Tags
// Update the session in the session manager in case it gets called again
t.Spec.SessionManager.UpdateSession(key, session, getLifetime(t.Spec, session))
}
// CheckSessionAndIdentityForValidKey will check first the Session store for a valid key, if not found, it will try
// the Auth Handler, if not found it will fail
func (t *TykMiddleware) CheckSessionAndIdentityForValidKey(key string) (SessionState, bool) {
// Try and get the session from the session store
log.Debug("Querying local cache")
// Check in-memory cache
if !config.LocalSessionCache.DisableCacheSessionState {
cachedVal, found := SessionCache.Get(key)
if found {
log.Debug("--> Key found in local cache")
session := cachedVal.(SessionState)
t.ApplyPolicyIfExists(key, &session)
return session, true
}
}
// Check session store
log.Debug("Querying keystore")
session, found := t.Spec.SessionManager.GetSessionDetail(key)
if found {
// If exists, assume it has been authorized and pass on
// cache it
go SessionCache.Set(key, session, cache.DefaultExpiration)
// Check for a policy, if there is a policy, pull it and overwrite the session values
t.ApplyPolicyIfExists(key, &session)
log.Debug("--> Got key")
return session, true
}
log.Debug("Querying authstore")
// 2. If not there, get it from the AuthorizationHandler
session, found = t.Spec.AuthManager.IsKeyAuthorised(key)
if found {
// If not in Session, and got it from AuthHandler, create a session with a new TTL
log.Info("Recreating session for key: ", key)
// cache it
go SessionCache.Set(key, session, cache.DefaultExpiration)
// Check for a policy, if there is a policy, pull it and overwrite the session values
t.ApplyPolicyIfExists(key, &session)
log.Debug("Lifetime is: ", getLifetime(t.Spec, &session))
// Need to set this in order for the write to work!
session.LastUpdated = time.Now().String()
t.Spec.SessionManager.UpdateSession(key, &session, getLifetime(t.Spec, &session))
}
return session, found
}
// SuccessHandler represents the final ServeHTTP() request for a proxied API request
type SuccessHandler struct {
*TykMiddleware
}
func (s *SuccessHandler) RecordHit(r *http.Request, timing int64, code int, requestCopy *http.Request, responseCopy *http.Response) {
if s.Spec.DoNotTrack {
return
}
if config.StoreAnalytics(r) {
t := time.Now()
// Track the key ID if it exists
token := ctxGetAuthToken(r)
// Track version data
version := s.Spec.getVersionFromRequest(r)
if version == "" {
version = "Non Versioned"
}
// If OAuth, we need to grab it from the session, which may or may not exist
oauthClientID := ""
tags := make([]string, 0)
var alias string
session := ctxGetSession(r)
if session != nil {
oauthClientID = session.OauthClientID
tags = session.Tags
alias = session.Alias
}
rawRequest := ""
rawResponse := ""
if RecordDetail(r) {
// Get the wire format representation
var wireFormatReq bytes.Buffer
requestCopy.Write(&wireFormatReq)
rawRequest = base64.StdEncoding.EncodeToString(wireFormatReq.Bytes())
// Get the wire format representation
var wireFormatRes bytes.Buffer
responseCopy.Write(&wireFormatRes)
rawResponse = base64.StdEncoding.EncodeToString(wireFormatRes.Bytes())
}
trackEP := false
trackedPath := r.URL.Path
if p := ctxGetTrackedPath(r); p != "" && !ctxGetDoNotTrack(r) {
trackEP = true
trackedPath = p
}
record := AnalyticsRecord{
r.Method,
trackedPath,
r.URL.Path,
r.ContentLength,
r.Header.Get("User-Agent"),
t.Day(),
t.Month(),
t.Year(),
t.Hour(),
code,
token,
t,
version,
s.Spec.Name,
s.Spec.APIID,
s.Spec.OrgID,
oauthClientID,
timing,
rawRequest,
rawResponse,
GetIPFromRequest(r),
GeoData{},
tags,
alias,
trackEP,
time.Now(),
}
record.GetGeo(GetIPFromRequest(r))
expiresAfter := s.Spec.ExpireAnalyticsAfter
if config.EnforceOrgDataAge {
orgExpireDataTime := s.GetOrgSessionExpiry(s.Spec.OrgID)
if orgExpireDataTime > 0 {
expiresAfter = orgExpireDataTime
}
}
record.SetExpiry(expiresAfter)
if config.AnalyticsConfig.NormaliseUrls.Enabled {
record.NormalisePath()
}
go analytics.RecordHit(record)
}
// Report in health check
ReportHealthCheckValue(s.Spec.Health, RequestLog, strconv.FormatInt(timing, 10))
if memProfFile != nil {
pprof.WriteHeapProfile(memProfFile)
}
}
// ServeHTTP will store the request details in the analytics store if necessary and proxy the request to it's
// final destination, this is invoked by the ProxyHandler or right at the start of a request chain if the URL
// Spec states the path is Ignored
func (s *SuccessHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) *http.Response {
log.Debug("Started proxy")
// Make sure we get the correct target URL
if s.Spec.Proxy.StripListenPath {
log.Debug("Stripping: ", s.Spec.Proxy.ListenPath)
r.URL.Path = strings.Replace(r.URL.Path, s.Spec.Proxy.ListenPath, "", 1)
log.Debug("Upstream Path is: ", r.URL.Path)
}
var copiedRequest *http.Request
if RecordDetail(r) {
copiedRequest = CopyHttpRequest(r)
}
t1 := time.Now()
resp := s.Proxy.ServeHTTP(w, r)
t2 := time.Now()
millisec := float64(t2.UnixNano()-t1.UnixNano()) * 0.000001
log.Debug("Upstream request took (ms): ", millisec)
if resp != nil {
var copiedResponse *http.Response
if RecordDetail(r) {
copiedResponse = CopyHttpResponse(resp)
}
s.RecordHit(r, int64(millisec), resp.StatusCode, copiedRequest, copiedResponse)
}
log.Debug("Done proxy")
return nil
}
// ServeHTTPWithCache will store the request details in the analytics store if necessary and proxy the request to it's
// final destination, this is invoked by the ProxyHandler or right at the start of a request chain if the URL
// Spec states the path is Ignored Itwill also return a response object for the cache
func (s *SuccessHandler) ServeHTTPWithCache(w http.ResponseWriter, r *http.Request) *http.Response {
// Make sure we get the correct target URL
if s.Spec.Proxy.StripListenPath {
r.URL.Path = strings.Replace(r.URL.Path, s.Spec.Proxy.ListenPath, "", 1)
}
var copiedRequest *http.Request
if RecordDetail(r) {
copiedRequest = CopyHttpRequest(r)
}
t1 := time.Now()
inRes := s.Proxy.ServeHTTPForCache(w, r)
t2 := time.Now()
var copiedResponse *http.Response
if RecordDetail(r) {
copiedResponse = CopyHttpResponse(inRes)
}
millisec := float64(t2.UnixNano()-t1.UnixNano()) * 0.000001
log.Debug("Upstream request took (ms): ", millisec)
if inRes != nil {
s.RecordHit(r, int64(millisec), inRes.StatusCode, copiedRequest, copiedResponse)
}
return inRes
}