auth
77:d43c3fbf00f3 Browse Files
Write Session tests. Add loginURI as a property to our Context, to keep track of where users should be redirected to log in. Implement the sessionStore in the memstore to let us test with Sessions. Catch when the HTTP Basic Auth header doesn't include two parts, rather than panicking. Return an ErrInvalidAuthFormat. Clean up the error handling for checkCookie to be cleaner. Log unexpected errors from request.Cookie. Stop checking for cookie expiration times--those aren't sent to the server, so we'll never get a valid session if we look for them. Add a helper to build a login redirect URI--a URI the user can be redirected to that has a URL-encoded URL to redirect the user back to after a successful login. Add a wrapper to wrap our Context into HTTP handlers. Create a RegisterOAuth2 helper that adds the OAuth2 endpoints to a Gorilla/mux router. Redirect users to the login page when they have no session set or an invalid session. Return a server error when we can't check our cookie for whatever reason. Log errors. Add sessions to our OAuth2 tests so the tests stop failing--the session check was interfering with them. Add a test for our getBasicAuth helper to ensure that we're parsing basic auth correctly. Add an ErrSessionAlreadyExists error to be returned when a session has an ID conflict. Test that our memstore implementation of the sessionStore works as intended..
context.go memstore.go oauth2.go oauth2_test.go session.go session_test.go
1.1 --- a/context.go Tue Nov 11 21:30:47 2014 -0500 1.2 +++ b/context.go Tue Nov 18 03:28:14 2014 -0500 1.3 @@ -4,6 +4,7 @@ 1.4 "html/template" 1.5 "io" 1.6 "log" 1.7 + "net/url" 1.8 "time" 1.9 1.10 "code.secondbit.org/uuid" 1.11 @@ -14,6 +15,7 @@ 1.12 // layer. 1.13 type Context struct { 1.14 template *template.Template 1.15 + loginURI *url.URL 1.16 clients clientStore 1.17 grants grantStore 1.18 profiles profileStore
2.1 --- a/memstore.go Tue Nov 11 21:30:47 2014 -0500 2.2 +++ b/memstore.go Tue Nov 18 03:28:14 2014 -0500 2.3 @@ -28,6 +28,9 @@ 2.4 logins map[string]Login 2.5 profileLoginLookup map[string][]string 2.6 loginLock sync.RWMutex 2.7 + 2.8 + sessions map[string]Session 2.9 + sessionLock sync.RWMutex 2.10 } 2.11 2.12 // NewMemstore returns an in-memory version of our datastores, 2.13 @@ -46,6 +49,7 @@ 2.14 profiles: map[string]Profile{}, 2.15 logins: map[string]Login{}, 2.16 profileLoginLookup: map[string][]string{}, 2.17 + sessions: map[string]Session{}, 2.18 } 2.19 } 2.20
3.1 --- a/oauth2.go Tue Nov 11 21:30:47 2014 -0500 3.2 +++ b/oauth2.go Tue Nov 18 03:28:14 2014 -0500 3.3 @@ -5,10 +5,12 @@ 3.4 "encoding/json" 3.5 "errors" 3.6 "html/template" 3.7 + "log" 3.8 "net/http" 3.9 "net/url" 3.10 "strings" 3.11 "time" 3.12 + "github.com/gorilla/mux" 3.13 3.14 "crypto/sha256" 3.15 "code.secondbit.org/pass" 3.16 @@ -55,21 +57,20 @@ 3.17 return "", "", ErrInvalidAuthFormat 3.18 } 3.19 info := strings.SplitN(string(decoded), ":", 2) 3.20 + if len(info) < 2 { 3.21 + return "", "", ErrInvalidAuthFormat 3.22 + } 3.23 return info[0], info[1], nil 3.24 } 3.25 3.26 func checkCookie(r *http.Request, context Context) (Session, error) { 3.27 cookie, err := r.Cookie(authCookieName) 3.28 - if err != nil { 3.29 - if err == http.ErrNoCookie { 3.30 - return Session{}, ErrNoSession 3.31 - } 3.32 + if err == http.ErrNoCookie { 3.33 + return Session{}, ErrNoSession 3.34 + } else if err != nil { 3.35 + log.Println(err) 3.36 return Session{}, err 3.37 } 3.38 - if cookie.Name != authCookieName || !cookie.Expires.After(time.Now()) || 3.39 - !cookie.Secure || !cookie.HttpOnly { 3.40 - return Session{}, ErrInvalidSession 3.41 - } 3.42 sess, err := context.GetSession(cookie.Value) 3.43 if err == ErrSessionNotFound { 3.44 return Session{}, ErrInvalidSession 3.45 @@ -82,6 +83,17 @@ 3.46 return sess, nil 3.47 } 3.48 3.49 +func buildLoginRedirect(r *http.Request, context Context) string { 3.50 + if context.loginURI == nil { 3.51 + return "" 3.52 + } 3.53 + uri := *context.loginURI 3.54 + q := uri.Query() 3.55 + q.Set("from", url.QueryEscape(r.URL.String())) 3.56 + uri.RawQuery = q.Encode() 3.57 + return uri.String() 3.58 +} 3.59 + 3.60 func authenticate(user, passphrase string, context Context) (Profile, error) { 3.61 profile, err := context.GetProfileByLogin(user) 3.62 if err != nil { 3.63 @@ -102,17 +114,42 @@ 3.64 return profile, nil 3.65 } 3.66 3.67 +func wrap(context Context, f func(w http.ResponseWriter, r *http.Request, context Context)) http.Handler { 3.68 + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { 3.69 + f(w, r, context) 3.70 + }) 3.71 +} 3.72 + 3.73 +// RegisterOAuth2 adds handlers to the passed router to handle the OAuth2 endpoints. 3.74 +func RegisterOAuth2(r *mux.Router, context Context) { 3.75 + r.Handle("/authorize", wrap(context, GetGrantHandler)) 3.76 + r.Handle("/token", wrap(context, GetTokenHandler)) 3.77 +} 3.78 + 3.79 // GetGrantHandler presents and processes the page for asking a user to grant access 3.80 // to their data. See RFC 6749, Section 4.1. 3.81 func GetGrantHandler(w http.ResponseWriter, r *http.Request, context Context) { 3.82 session, err := checkCookie(r, context) 3.83 if err != nil { 3.84 if err == ErrNoSession || err == ErrInvalidSession { 3.85 - // TODO(paddy): redirect to login screen 3.86 - //return 3.87 + redir := buildLoginRedirect(r, context) 3.88 + if redir == "" { 3.89 + log.Println("No login URL configured.") 3.90 + w.WriteHeader(http.StatusInternalServerError) 3.91 + context.Render(w, getGrantTemplateName, map[string]interface{}{ 3.92 + "internal_error": template.HTML("Missing login URL."), 3.93 + }) 3.94 + return 3.95 + } 3.96 + http.Redirect(w, r, redir, http.StatusFound) 3.97 + return 3.98 } 3.99 - // TODO(paddy): return a server error 3.100 - //return 3.101 + log.Println(err.Error()) 3.102 + w.WriteHeader(http.StatusInternalServerError) 3.103 + context.Render(w, getGrantTemplateName, map[string]interface{}{ 3.104 + "internal_error": template.HTML(err.Error()), 3.105 + }) 3.106 + return 3.107 } 3.108 if r.URL.Query().Get("client_id") == "" { 3.109 w.WriteHeader(http.StatusBadRequest) 3.110 @@ -146,6 +183,7 @@ 3.111 "error": template.HTML("The specified Client couldn’t be found."), 3.112 }) 3.113 } else { 3.114 + log.Println(err.Error()) 3.115 w.WriteHeader(http.StatusInternalServerError) 3.116 context.Render(w, getGrantTemplateName, map[string]interface{}{ 3.117 "internal_error": template.HTML(err.Error()), 3.118 @@ -157,6 +195,7 @@ 3.119 // the client has registered 3.120 numEndpoints, err := context.CountEndpoints(clientID) 3.121 if err != nil { 3.122 + log.Println(err.Error()) 3.123 w.WriteHeader(http.StatusInternalServerError) 3.124 context.Render(w, getGrantTemplateName, map[string]interface{}{ 3.125 "internal_error": template.HTML(err.Error()), 3.126 @@ -168,6 +207,7 @@ 3.127 // BUG(paddy): We really should normalize URIs before trying to compare them. 3.128 validURI, err = context.CheckEndpoint(clientID, redirectURI) 3.129 if err != nil { 3.130 + log.Println(err.Error()) 3.131 w.WriteHeader(http.StatusInternalServerError) 3.132 context.Render(w, getGrantTemplateName, map[string]interface{}{ 3.133 "internal_error": template.HTML(err.Error()), 3.134 @@ -180,6 +220,7 @@ 3.135 validURI = true 3.136 endpoints, err := context.ListEndpoints(clientID, 1, 0) 3.137 if err != nil { 3.138 + log.Println(err.Error()) 3.139 w.WriteHeader(http.StatusInternalServerError) 3.140 context.Render(w, getGrantTemplateName, map[string]interface{}{ 3.141 "internal_error": template.HTML(err.Error()),
4.1 --- a/oauth2_test.go Tue Nov 11 21:30:47 2014 -0500 4.2 +++ b/oauth2_test.go Tue Nov 18 03:28:14 2014 -0500 4.3 @@ -34,6 +34,7 @@ 4.4 grants: store, 4.5 profiles: store, 4.6 tokens: store, 4.7 + sessions: store, 4.8 } 4.9 client := Client{ 4.10 ID: uuid.NewID(), 4.11 @@ -62,10 +63,23 @@ 4.12 if err != nil { 4.13 t.Fatal("Can't store endpoint:", err) 4.14 } 4.15 + session := Session{ 4.16 + ID: "testsession", 4.17 + Active: true, 4.18 + } 4.19 + err = testContext.CreateSession(session) 4.20 + if err != nil { 4.21 + t.Fatal("Can't store session:", err) 4.22 + } 4.23 req, err := http.NewRequest("GET", "https://test.auth.secondbit.org/oauth2/grant", nil) 4.24 if err != nil { 4.25 t.Fatal("Can't build request:", err) 4.26 } 4.27 + cookie := &http.Cookie{ 4.28 + Name: authCookieName, 4.29 + Value: session.ID, 4.30 + } 4.31 + req.AddCookie(cookie) 4.32 for i := 0; i < 1<<3; i++ { 4.33 w := httptest.NewRecorder() 4.34 params := url.Values{} 4.35 @@ -139,6 +153,7 @@ 4.36 grants: store, 4.37 profiles: store, 4.38 tokens: store, 4.39 + sessions: store, 4.40 } 4.41 client := Client{ 4.42 ID: uuid.NewID(), 4.43 @@ -151,6 +166,14 @@ 4.44 if err != nil { 4.45 t.Fatal("Can't store client:", err) 4.46 } 4.47 + session := Session{ 4.48 + ID: "testsession", 4.49 + Active: true, 4.50 + } 4.51 + err = testContext.CreateSession(session) 4.52 + if err != nil { 4.53 + t.Fatal("Can't store session:", err) 4.54 + } 4.55 req, err := http.NewRequest("GET", "https://test.auth.secondbit.org/oauth2/grant", nil) 4.56 if err != nil { 4.57 t.Fatal("Can't build request:", err) 4.58 @@ -160,6 +183,11 @@ 4.59 params.Set("response_type", "code") 4.60 params.Set("redirect_uri", "https://test.secondbit.org/") 4.61 req.URL.RawQuery = params.Encode() 4.62 + cookie := &http.Cookie{ 4.63 + Name: authCookieName, 4.64 + Value: session.ID, 4.65 + } 4.66 + req.AddCookie(cookie) 4.67 GetGrantHandler(w, req, testContext) 4.68 if w.Code != http.StatusBadRequest { 4.69 t.Errorf("Expected status code to be %d, got %d", http.StatusBadRequest, w.Code) 4.70 @@ -198,6 +226,7 @@ 4.71 grants: store, 4.72 profiles: store, 4.73 tokens: store, 4.74 + sessions: store, 4.75 } 4.76 client := Client{ 4.77 ID: uuid.NewID(), 4.78 @@ -214,10 +243,23 @@ 4.79 if err != nil { 4.80 t.Fatal("Can't store client:", err) 4.81 } 4.82 + session := Session{ 4.83 + ID: "testsession", 4.84 + Active: true, 4.85 + } 4.86 + err = testContext.CreateSession(session) 4.87 + if err != nil { 4.88 + t.Fatal("Can't store session:", err) 4.89 + } 4.90 req, err := http.NewRequest("GET", "https://test.auth.secondbit.org/oauth2/grant", nil) 4.91 if err != nil { 4.92 t.Fatal("Can't build request:", err) 4.93 } 4.94 + cookie := &http.Cookie{ 4.95 + Name: authCookieName, 4.96 + Value: session.ID, 4.97 + } 4.98 + req.AddCookie(cookie) 4.99 w := httptest.NewRecorder() 4.100 params := url.Values{} 4.101 params.Set("response_type", "code") 4.102 @@ -291,6 +333,7 @@ 4.103 grants: store, 4.104 profiles: store, 4.105 tokens: store, 4.106 + sessions: store, 4.107 } 4.108 client := Client{ 4.109 ID: uuid.NewID(), 4.110 @@ -319,10 +362,23 @@ 4.111 if err != nil { 4.112 t.Fatal("Can't store endpoint:", err) 4.113 } 4.114 + session := Session{ 4.115 + ID: "testsession", 4.116 + Active: true, 4.117 + } 4.118 + err = testContext.CreateSession(session) 4.119 + if err != nil { 4.120 + t.Fatal("Can't store session:", err) 4.121 + } 4.122 req, err := http.NewRequest("GET", "https://test.auth.secondbit.org/oauth2/grant", nil) 4.123 if err != nil { 4.124 t.Fatal("Can't build request:", err) 4.125 } 4.126 + cookie := &http.Cookie{ 4.127 + Name: authCookieName, 4.128 + Value: session.ID, 4.129 + } 4.130 + req.AddCookie(cookie) 4.131 params := url.Values{} 4.132 params.Set("response_type", "totally not code") 4.133 params.Set("client_id", client.ID.String()) 4.134 @@ -384,6 +440,7 @@ 4.135 grants: store, 4.136 profiles: store, 4.137 tokens: store, 4.138 + sessions: store, 4.139 } 4.140 client := Client{ 4.141 ID: uuid.NewID(), 4.142 @@ -412,10 +469,23 @@ 4.143 if err != nil { 4.144 t.Fatal("Can't store endpoint:", err) 4.145 } 4.146 + session := Session{ 4.147 + ID: "testsession", 4.148 + Active: true, 4.149 + } 4.150 + err = testContext.CreateSession(session) 4.151 + if err != nil { 4.152 + t.Fatal("Can't store session:", err) 4.153 + } 4.154 req, err := http.NewRequest("GET", "https://test.auth.secondbit.org/oauth2/grant", nil) 4.155 if err != nil { 4.156 t.Fatal("Can't build request:", err) 4.157 } 4.158 + cookie := &http.Cookie{ 4.159 + Name: authCookieName, 4.160 + Value: session.ID, 4.161 + } 4.162 + req.AddCookie(cookie) 4.163 params := url.Values{} 4.164 params.Set("response_type", "code") 4.165 params.Set("client_id", client.ID.String()) 4.166 @@ -449,3 +519,36 @@ 4.167 t.Errorf(`Expected redirect URL to be "%s", got "%s"`, endpoint.URI.String(), red.String()) 4.168 } 4.169 } 4.170 + 4.171 +func TestGetBasicAuth(t *testing.T) { 4.172 + tests := map[string]struct { 4.173 + un string 4.174 + pass string 4.175 + err error 4.176 + }{ 4.177 + "Basic dGVzdHVzZXI6cGFzc3dvcmQx": {"testuser", "password1", nil}, 4.178 + "": {"", "", ErrNoAuth}, 4.179 + "dGVzdHVzZXI6cGFzc3dvcmQx": {"", "", ErrInvalidAuthFormat}, 4.180 + "Basic _*&^##$@#$@&!!@": {"", "", ErrInvalidAuthFormat}, 4.181 + "Basic abcdefgh": {"", "", ErrInvalidAuthFormat}, 4.182 + "Basic dXNlcjo=": {"user", "", nil}, 4.183 + } 4.184 + 4.185 + for header, test := range tests { 4.186 + req, err := http.NewRequest("GET", "https://auth.secondbit.org", nil) 4.187 + if err != nil { 4.188 + t.Error("Unexpected error creating base request:", err) 4.189 + } 4.190 + req.Header.Set("Authorization", header) 4.191 + un, pass, err := getBasicAuth(req) 4.192 + if un != test.un { 4.193 + t.Errorf(`Expected header "%s" to return username "%s", got "%s"`, header, test.un, un) 4.194 + } 4.195 + if pass != test.pass { 4.196 + t.Errorf(`Expected header "%s" to return password "%s", got "%s"`, header, test.pass, pass) 4.197 + } 4.198 + if err != test.err { 4.199 + t.Errorf(`Expected header "%s" to return error "%s", got "%s"`, header, test.err, err) 4.200 + } 4.201 + } 4.202 +}
5.1 --- a/session.go Tue Nov 11 21:30:47 2014 -0500 5.2 +++ b/session.go Tue Nov 18 03:28:14 2014 -0500 5.3 @@ -14,6 +14,8 @@ 5.4 ErrSessionNotFound = errors.New("session not found in sessionStore") 5.5 // ErrInvalidSession is returned when a Session is specified but is not valid. 5.6 ErrInvalidSession = errors.New("session is not valid") 5.7 + // ErrSessionAlreadyExists is returned when a sessionStore tries to store a Session with an ID that already exists in the sessionStore. 5.8 + ErrSessionAlreadyExists = errors.New("session already exists") 5.9 ) 5.10 5.11 // Session represents a user's authenticated session, associating it with a profile 5.12 @@ -34,3 +36,52 @@ 5.13 removeSession(id string) error 5.14 listSessions(profile uuid.ID, before time.Time, num int64) ([]Session, error) 5.15 } 5.16 + 5.17 +func (m *memstore) createSession(session Session) error { 5.18 + m.sessionLock.Lock() 5.19 + defer m.sessionLock.Unlock() 5.20 + if _, ok := m.sessions[session.ID]; ok { 5.21 + return ErrSessionAlreadyExists 5.22 + } 5.23 + m.sessions[session.ID] = session 5.24 + return nil 5.25 +} 5.26 + 5.27 +func (m *memstore) getSession(id string) (Session, error) { 5.28 + m.sessionLock.RLock() 5.29 + defer m.sessionLock.RUnlock() 5.30 + if _, ok := m.sessions[id]; !ok { 5.31 + return Session{}, ErrSessionNotFound 5.32 + } 5.33 + return m.sessions[id], nil 5.34 +} 5.35 + 5.36 +func (m *memstore) removeSession(id string) error { 5.37 + m.sessionLock.Lock() 5.38 + defer m.sessionLock.Unlock() 5.39 + if _, ok := m.sessions[id]; !ok { 5.40 + return ErrSessionNotFound 5.41 + } 5.42 + delete(m.sessions, id) 5.43 + return nil 5.44 +} 5.45 + 5.46 +func (m *memstore) listSessions(profile uuid.ID, before time.Time, num int64) ([]Session, error) { 5.47 + m.sessionLock.RLock() 5.48 + defer m.sessionLock.RUnlock() 5.49 + res := []Session{} 5.50 + for _, session := range m.sessions { 5.51 + if int64(len(res)) >= num { 5.52 + break 5.53 + } 5.54 + if profile != nil && !profile.Equal(session.ProfileID) { 5.55 + continue 5.56 + } 5.57 + if !before.IsZero() && session.Created.After(before) { 5.58 + continue 5.59 + } 5.60 + res = append(res, session) 5.61 + } 5.62 + // BUG(paddy): sessions should return sorted by date created 5.63 + return res, nil 5.64 +}
6.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 6.2 +++ b/session_test.go Tue Nov 18 03:28:14 2014 -0500 6.3 @@ -0,0 +1,96 @@ 6.4 +package auth 6.5 + 6.6 +import ( 6.7 + "testing" 6.8 + "time" 6.9 + 6.10 + "code.secondbit.org/uuid" 6.11 +) 6.12 + 6.13 +var sessionStores = []sessionStore{NewMemstore()} 6.14 + 6.15 +func compareSessions(session1, session2 Session) (success bool, field string, val1, val2 interface{}) { 6.16 + if session1.ID != session2.ID { 6.17 + return false, "ID", session1.ID, session2.ID 6.18 + } 6.19 + if session1.IP != session2.IP { 6.20 + return false, "IP", session1.IP, session2.IP 6.21 + } 6.22 + if session1.UserAgent != session2.UserAgent { 6.23 + return false, "UserAgent", session1.UserAgent, session2.UserAgent 6.24 + } 6.25 + if !session1.ProfileID.Equal(session2.ProfileID) { 6.26 + return false, "ProfileID", session1.ProfileID, session2.ProfileID 6.27 + } 6.28 + if !session1.Created.Equal(session2.Created) { 6.29 + return false, "Created", session1.Created, session2.Created 6.30 + } 6.31 + if session1.Login != session2.Login { 6.32 + return false, "Login", session1.Login, session2.Login 6.33 + } 6.34 + if session1.Active != session2.Active { 6.35 + return false, "Active", session1.Active, session2.Active 6.36 + } 6.37 + return true, "", nil, nil 6.38 +} 6.39 + 6.40 +func TestSessionStoreSuccess(t *testing.T) { 6.41 + t.Parallel() 6.42 + session := Session{ 6.43 + ID: uuid.NewID().String() + uuid.NewID().String(), 6.44 + IP: "127.0.0.1", 6.45 + UserAgent: "TestRunner", 6.46 + ProfileID: uuid.NewID(), 6.47 + Created: time.Now(), 6.48 + Login: "test@example.com", 6.49 + Active: true, 6.50 + } 6.51 + for _, store := range sessionStores { 6.52 + err := store.createSession(session) 6.53 + if err != nil { 6.54 + t.Errorf("Error saving session to %T: %s", store, err) 6.55 + } 6.56 + err = store.createSession(session) 6.57 + if err != ErrSessionAlreadyExists { 6.58 + t.Errorf("Expected ErrSessionAlreadyExists from %T, got %s", store, err) 6.59 + } 6.60 + retrieved, err := store.getSession(session.ID) 6.61 + if err != nil { 6.62 + t.Errorf("Error retrieving session from %T: %s", store, err) 6.63 + } 6.64 + success, field, expectation, result := compareSessions(session, retrieved) 6.65 + if !success { 6.66 + t.Errorf("Expected field %s to be %v, but got %v from %T", field, expectation, result, store) 6.67 + } 6.68 + retrievedList, err := store.listSessions(session.ProfileID, time.Time{}, 10) 6.69 + if err != nil { 6.70 + t.Errorf("Error retrieving sessions by profile from %T: %s", store, err) 6.71 + } 6.72 + if len(retrievedList) != 1 { 6.73 + t.Errorf("Expected 1 session retrieved by profile from %T, got %d", store, len(retrievedList)) 6.74 + } 6.75 + success, field, expectation, result = compareSessions(session, retrievedList[0]) 6.76 + if !success { 6.77 + t.Errorf("Expected field %s to be %v, but got %v from %T", field, expectation, result, store) 6.78 + } 6.79 + err = store.removeSession(session.ID) 6.80 + if err != nil { 6.81 + t.Errorf("Error removing session from %T: %s", store, err) 6.82 + } 6.83 + retrieved, err = store.getSession(session.ID) 6.84 + if err != ErrSessionNotFound { 6.85 + t.Errorf("Expected ErrSessionNotFound from %T, got %s", store, err) 6.86 + } 6.87 + retrievedList, err = store.listSessions(session.ProfileID, time.Time{}, 10) 6.88 + if err != nil { 6.89 + t.Errorf("Error retrieving sessions by profile from %T: %s", store, err) 6.90 + } 6.91 + if len(retrievedList) != 0 { 6.92 + t.Errorf("Expected 0 sessions retrieved by profile from %T, got %d", store, len(retrievedList)) 6.93 + } 6.94 + err = store.removeSession(session.ID) 6.95 + if err != ErrSessionNotFound { 6.96 + t.Errorf("Expected ErrSessionNotFound from %T, got %s", store, err) 6.97 + } 6.98 + } 6.99 +}