Skip to content

Commit d80cfc9

Browse files
NeszeNesze
authored
Refactor (#21)
* Drop unused * Split logic into two files * Remove context pkg. Move logic to castle Fix tests.
1 parent 0c046dd commit d80cfc9

7 files changed

+118
-200
lines changed

‎castle.go ‎client.go

-144
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ import (
88
"net/http"
99

1010
"github.com/pkg/errors"
11-
"github.com/tomasen/realip"
1211
)
1312

1413
// FilterEndpoint defines the filter URL castle.io side
@@ -17,80 +16,13 @@ var FilterEndpoint = "https://api.castle.io/v1/filter"
1716
// RiskEndpoint defines the risk URL castle.io side
1817
var RiskEndpoint = "https://api.castle.io/v1/risk"
1918

20-
type Event struct {
21-
EventType EventType
22-
EventStatus EventStatus
23-
}
24-
25-
// EventType is an enum defining types of event castle tracks
26-
type EventType string
27-
28-
// See https://docs.castle.io/docs/events
29-
const (
30-
EventTypeLogin EventType = "$login"
31-
EventTypeRegistration EventType = "$registration"
32-
EventTypeProfileUpdate EventType = "$profile_update"
33-
EventTypeProfileReset EventType = "$profile_reset"
34-
EventTypePasswordResetRequest EventType = "$password_reset_request"
35-
EventTypeChallenge EventType = "$challenge"
36-
EventTypeLogout EventType = "&logout"
37-
)
38-
39-
// EventStatus is an enum defining the statuses for a given event.
40-
type EventStatus string
41-
42-
// See https://docs.castle.io/docs/events
43-
const (
44-
EventStatusAttempted EventStatus = "$attempted"
45-
EventStatusSucceeded EventStatus = "$succeeded"
46-
EventStatusFailed EventStatus = "$failed"
47-
EventStatusRequested EventStatus = "$requested"
48-
)
49-
50-
// RecommendedAction encapsulates the 3 possible responses from auth call (allow, challenge, deny)
51-
type RecommendedAction string
52-
53-
// See https://castle.io/docs/authentication
54-
const (
55-
RecommendedActionNone RecommendedAction = ""
56-
RecommendedActionAllow RecommendedAction = "allow"
57-
RecommendedActionChallenge RecommendedAction = "challenge"
58-
RecommendedActionDeny RecommendedAction = "deny"
59-
)
60-
6119
// New creates a new castle client
6220
func New(secret string) (*Castle, error) {
6321
client := &http.Client{}
6422

6523
return NewWithHTTPClient(secret, client)
6624
}
6725

68-
// HeaderAllowList keeps a list of headers that will be forwarded to castle
69-
var HeaderAllowList = []string{
70-
"Accept",
71-
"Accept-Charset",
72-
"Accept-Datetime",
73-
"Accept-Encoding",
74-
"Accept-Language",
75-
"Cache-Control",
76-
"Connection",
77-
"Content-Length",
78-
"Content-Type",
79-
"Dnt",
80-
"Host",
81-
"Origin",
82-
"Pragma",
83-
"Referer",
84-
"Sec-Fetch-Dest",
85-
"Sec-Fetch-Mode",
86-
"Sec-Fetch-Site",
87-
"Sec-Fetch-User",
88-
"Te",
89-
"Upgrade-Insecure-Requests",
90-
"User-Agent",
91-
"X-Castle-Request-Token",
92-
}
93-
9426
// NewWithHTTPClient same as New but allows passing of http.Client with custom config
9527
func NewWithHTTPClient(secret string, client *http.Client) (*Castle, error) {
9628
return &Castle{client: client, apiSecret: secret}, nil
@@ -102,82 +34,6 @@ type Castle struct {
10234
apiSecret string
10335
}
10436

105-
// Context captures data from HTTP request
106-
type Context struct {
107-
IP string `json:"ip"`
108-
Headers map[string]string `json:"headers"`
109-
RequestToken string `json:"request_token"`
110-
}
111-
112-
func isHeaderAllowed(header string) bool {
113-
for _, allowedHeader := range HeaderAllowList {
114-
if header == http.CanonicalHeaderKey(allowedHeader) {
115-
return true
116-
}
117-
}
118-
return false
119-
}
120-
121-
// ContextFromRequest builds castle context from current http.Request
122-
func ContextFromRequest(r *http.Request) *Context {
123-
headers := make(map[string]string)
124-
125-
for requestHeader := range r.Header {
126-
if isHeaderAllowed(requestHeader) {
127-
headers[requestHeader] = r.Header.Get(requestHeader)
128-
}
129-
}
130-
131-
requestToken := getRequestToken(r)
132-
133-
return &Context{IP: realip.FromRequest(r), Headers: headers, RequestToken: requestToken}
134-
}
135-
136-
func getRequestToken(r *http.Request) string {
137-
// RequestToken is X-Castle-Request-Token
138-
return r.Header.Get("HTTP_X_CASTLE_REQUEST_TOKEN")
139-
}
140-
141-
type Request struct {
142-
Context *Context
143-
Event Event
144-
User User
145-
Properties map[string]string
146-
}
147-
148-
type User struct {
149-
ID string `json:"id"`
150-
Email string `json:"email,omitempty"`
151-
Phone string `json:"phone,omitempty"`
152-
Name string `json:"name,omitempty"`
153-
RegisteredAt string `json:"registered_at,omitempty"`
154-
Traits map[string]string `json:"traits,omitempty"`
155-
}
156-
157-
type castleAPIRequest struct {
158-
Type EventType `json:"type"`
159-
Status EventStatus `json:"status"`
160-
RequestToken string `json:"request_token"`
161-
User User `json:"user"`
162-
Context *Context `json:"context"`
163-
Properties map[string]string `json:"properties,omitempty"`
164-
}
165-
166-
type castleAPIResponse struct {
167-
Type string `json:"type"`
168-
Message string `json:"message"`
169-
Risk float32 `json:"risk"`
170-
Policy struct {
171-
Name string `json:"name"`
172-
ID string `json:"id"`
173-
RevisionID string `json:"revision_id"`
174-
Action string `json:"action"`
175-
} `json:"policy"`
176-
Device struct {
177-
Token string `json:"token"`
178-
} `json:"device"`
179-
}
180-
18137
// Filter sends a filter request to castle.io
18238
// see https://reference.castle.io/#operation/filter for details
18339
func (c *Castle) Filter(ctx context.Context, req *Request) (RecommendedAction, error) {

‎castle_test.go ‎client_test.go

+3-36
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ func configureHTTPRequest() *http.Request {
2525

2626
func configureRequest(httpReq *http.Request) *castle.Request {
2727
return &castle.Request{
28-
Context: castle.ContextFromRequest(httpReq),
28+
Context: castle.FromHTTPRequest(httpReq),
2929
Event: castle.Event{
3030
EventType: castle.EventTypeLogin,
3131
EventStatus: castle.EventStatusSucceeded,
@@ -168,7 +168,7 @@ func TestCastle_Filter(t *testing.T) {
168168
assert.Equal(t, "user-id", reqData.User.ID)
169169
assert.Equal(t, map[string]string{"prop1": "propValue1"}, reqData.Properties)
170170
assert.Equal(t, map[string]string{"trait1": "traitValue1"}, reqData.User.Traits)
171-
assert.Equal(t, castle.ContextFromRequest(httpReq), reqData.Context)
171+
assert.Equal(t, castle.FromHTTPRequest(httpReq), reqData.Context)
172172

173173
executed = true
174174
}))
@@ -183,39 +183,6 @@ func TestCastle_Filter(t *testing.T) {
183183
})
184184
}
185185

186-
func TestContextFromRequest(t *testing.T) {
187-
// grabs ClientID form cookie
188-
req := httptest.NewRequest("GET", "/", nil)
189-
190-
req.Header.Set("HTTP_X_CASTLE_REQUEST_TOKEN", "some-token")
191-
192-
ctx := castle.ContextFromRequest(req)
193-
assert.Equal(t, "some-token", ctx.RequestToken)
194-
195-
// grabs IP from request
196-
req.Header.Set("X-REAL-IP", "9.9.9.9")
197-
ctx = castle.ContextFromRequest(req)
198-
assert.Equal(t, "9.9.9.9", ctx.IP)
199-
200-
// but prefers X-FORWARDED-FOR
201-
req.Header.Set("X-FORWARDED-FOR", "6.6.6.6, 3.3.3.3, 8.8.8.8")
202-
ctx = castle.ContextFromRequest(req)
203-
assert.Equal(t, "6.6.6.6", ctx.IP)
204-
205-
// grabs whitelisted headers only
206-
207-
for _, whitelistedHeader := range castle.HeaderAllowList {
208-
req.Header.Set(whitelistedHeader, whitelistedHeader)
209-
}
210-
211-
ctx = castle.ContextFromRequest(req)
212-
for _, whitelistedHeader := range castle.HeaderAllowList {
213-
assert.Contains(t, ctx.Headers, http.CanonicalHeaderKey(whitelistedHeader))
214-
}
215-
216-
assert.NotContains(t, ctx.Headers, "Cookie")
217-
}
218-
219186
func TestCastle_Risk(t *testing.T) {
220187
ctx := context.Background()
221188

@@ -296,7 +263,7 @@ func TestCastle_Risk(t *testing.T) {
296263
assert.Equal(t, "user-id", reqData.User.ID)
297264
assert.Equal(t, map[string]string{"prop1": "propValue1"}, reqData.Properties)
298265
assert.Equal(t, map[string]string{"trait1": "traitValue1"}, reqData.User.Traits)
299-
assert.Equal(t, castle.ContextFromRequest(httpReq), reqData.Context)
266+
assert.Equal(t, castle.FromHTTPRequest(httpReq), reqData.Context)
300267

301268
executed = true
302269
}))

‎context/context.go ‎context.go

+22-14
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
package context
1+
package castle
22

33
import (
44
"context"
55
"net/http"
66
"strings"
77

8-
"github.com/utilitywarehouse/castle-go"
98
http_internal "github.com/utilitywarehouse/castle-go/http"
109
)
1110

@@ -17,9 +16,27 @@ func (c contextKey) String() string {
1716

1817
var castleCtxKey = contextKey("castle_context")
1918

20-
// ToCtxFromRequest adds the token and other request information (i.e. castle context) to the context.
21-
func ToCtxFromRequest(ctx context.Context, r *http.Request) context.Context {
22-
castleCtx := castle.Context{
19+
// ToCtx adds the Castle context to the context.Context.
20+
func ToCtx(ctx context.Context, castleCtx *Context) context.Context {
21+
return context.WithValue(ctx, castleCtxKey, castleCtx)
22+
}
23+
24+
// FromCtx returns the Castle context from the context.Context.
25+
func FromCtx(ctx context.Context) *Context {
26+
castleCtx, ok := ctx.Value(castleCtxKey).(*Context)
27+
if ok {
28+
return castleCtx
29+
}
30+
return nil
31+
}
32+
33+
// ToCtxFromHTTPRequest adds the token and other request information (i.e. castle context) to the context.
34+
func ToCtxFromHTTPRequest(ctx context.Context, r *http.Request) context.Context {
35+
return context.WithValue(ctx, castleCtxKey, FromHTTPRequest(r))
36+
}
37+
38+
func FromHTTPRequest(r *http.Request) *Context {
39+
return &Context{
2340
RequestToken: func() string {
2441
// grab the token from header if it exists
2542
if tkn := tokenFromHTTPHeader(r.Header); tkn != "" {
@@ -32,15 +49,6 @@ func ToCtxFromRequest(ctx context.Context, r *http.Request) context.Context {
3249
IP: http_internal.IPFromRequest(r),
3350
Headers: FilterHeaders(r.Header), // pass in as much context as possible
3451
}
35-
return context.WithValue(ctx, castleCtxKey, castleCtx)
36-
}
37-
38-
func FromCtx(ctx context.Context) *castle.Context {
39-
castleCtx, ok := ctx.Value(castleCtxKey).(castle.Context)
40-
if ok {
41-
return &castleCtx
42-
}
43-
return nil
4452
}
4553

4654
func tokenFromHTTPHeader(header http.Header) string {

‎context/context_test.go ‎context_test.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package context
1+
package castle_test
22

33
import (
44
"context"
@@ -61,8 +61,8 @@ func TestToCtxFromRequest(t *testing.T) {
6161
t.Run(name, func(t *testing.T) {
6262
ctx := context.Background()
6363

64-
gotCtx := ToCtxFromRequest(ctx, &test.input)
65-
got := FromCtx(gotCtx)
64+
gotCtx := castle.ToCtxFromHTTPRequest(ctx, &test.input)
65+
got := castle.FromCtx(gotCtx)
6666
assert.Equal(t, test.expected, *got)
6767
})
6868
}

‎go.mod

-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ require (
66
github.com/daixiang0/gci v0.10.1
77
github.com/pkg/errors v0.9.1
88
github.com/stretchr/testify v1.8.3
9-
github.com/tomasen/realip v0.0.0-20180522021738-f0c99a92ddce
109
gotest.tools/gotestsum v1.10.0
1110
mvdan.cc/gofumpt v0.5.0
1211
)

‎go.sum

-2
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,6 @@ github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+
4545
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
4646
github.com/stretchr/testify v1.8.3 h1:RP3t2pwF7cMEbC1dqtB6poj3niw/9gnV4Cjg5oW5gtY=
4747
github.com/stretchr/testify v1.8.3/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
48-
github.com/tomasen/realip v0.0.0-20180522021738-f0c99a92ddce h1:fb190+cK2Xz/dvi9Hv8eCYJYvIGUTN2/KLq1pT6CjEc=
49-
github.com/tomasen/realip v0.0.0-20180522021738-f0c99a92ddce/go.mod h1:o8v6yHRoik09Xen7gje4m9ERNah1d1PPsVq1VEx9vE4=
5048
github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
5149
github.com/yuin/goldmark v1.4.1/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k=
5250
go.uber.org/atomic v1.7.0 h1:ADUqmZGgLDDfbSL9ZmPxKTybcoEYHgpYfELNoN+7hsw=

0 commit comments

Comments
 (0)