auth

Paddy 2015-04-19 Parent:3e8964a914ef

163:73e12d5a1124 Go to Latest

auth/scope.go

Use postgres arrays for scope associations. Use the new pqarrays library I wrote to store Scope associations for Tokens and AuthorizationCodes, instead of using our hacky and abstraction-breaking many-to-many code. We also created the authStore.deleteAuthorizationCodesByProfileID method, to clear out the AuthorizationCodes that belong to a Profile (used when the Profile is deleted). So we added the implementation for memstore and for our postgres store. Call Context.DeleteAuthorizationCodesByProfileID when deleting a Profile to clean up after it. Rename sortedScopes to Scopes, which we use pqarrays.StringArray's methods on to fulfill the sql.Scanner and driver.Valuer interfaces. This lets us store Scopes in postgres arrays. Create a stringsToScopes helper function that creates Scope objects, with their IDs filled by the strings specified. Update our GrantType.Validate function signature to return Scopes instead of []string. Create a Scopes.Strings() helper method that returns a []string of the IDs of the Scopes. Update our SQL init file to use the new postgres array definition, instead of the many-to-many definition.

Download raw file
View source Diff to previous Annotate
History
1 package auth
2
3 import (
4 "errors"
5 "sort"
6 )
7
8 var (
9 ErrNoScopeStore = errors.New("scopeStore not set in Context")
10 ErrScopeNotFound = errors.New("scope not found")
11 ErrScopeAlreadyExists = errors.New("scope already exists")
12 )
13
14 // Scope represents a limit on the access that a grant provides.
15 type Scope struct {
16 ID string
17 Name string
18 Description string
19 }
20
21 func (s *Scope) ApplyChange(change ScopeChange) {
22 if change.Name != nil {
23 s.Name = *change.Name
24 }
25 if change.Description != nil {
26 s.Description = *change.Description
27 }
28 }
29
30 type Scopes []Scope
31
32 func (s Scopes) Len() int {
33 return len(s)
34 }
35
36 func (s Scopes) Swap(i, j int) {
37 s[i], s[j] = s[j], s[i]
38 }
39
40 func (s Scopes) Less(i, j int) bool {
41 return s[i].ID < s[j].ID
42 }
43
44 func (s Scopes) Strings() []string {
45 res := make([]string, len(s))
46 for pos, scope := range s {
47 res[pos] = scope.ID
48 }
49 return res
50 }
51
52 func stringsToScopes(s []string) Scopes {
53 res := make(Scopes, len(s))
54 for pos, scope := range s {
55 res[pos] = Scope{ID: scope}
56 }
57 return res
58 }
59
60 // ScopeChange represents a change to a Scope.
61 type ScopeChange struct {
62 Name *string
63 Description *string
64 }
65
66 func (s ScopeChange) Empty() bool {
67 return s.Name == nil && s.Description == nil
68 }
69
70 type scopeStore interface {
71 createScopes(scopes []Scope) error
72 getScopes(ids []string) ([]Scope, error)
73 updateScope(id string, change ScopeChange) error
74 removeScopes(ids []string) error
75 listScopes() ([]Scope, error)
76 }
77
78 func (m *memstore) createScopes(scopes []Scope) error {
79 m.scopeLock.Lock()
80 defer m.scopeLock.Unlock()
81
82 for _, scope := range scopes {
83 if _, ok := m.scopes[scope.ID]; ok {
84 return ErrScopeAlreadyExists
85 }
86 }
87 for _, scope := range scopes {
88 m.scopes[scope.ID] = scope
89 }
90 return nil
91 }
92
93 func (m *memstore) getScopes(ids []string) ([]Scope, error) {
94 m.scopeLock.RLock()
95 defer m.scopeLock.RUnlock()
96
97 scopes := []Scope{}
98 for _, id := range ids {
99 scope, ok := m.scopes[id]
100 if !ok {
101 continue
102 }
103 scopes = append(scopes, scope)
104 }
105 sorted := Scopes(scopes)
106 sort.Sort(sorted)
107 scopes = sorted
108 return scopes, nil
109 }
110
111 func (m *memstore) updateScope(id string, change ScopeChange) error {
112 m.scopeLock.Lock()
113 defer m.scopeLock.Unlock()
114
115 scope, ok := m.scopes[id]
116 if !ok {
117 return ErrScopeNotFound
118 }
119 scope.ApplyChange(change)
120 m.scopes[id] = scope
121 return nil
122 }
123
124 func (m *memstore) removeScopes(ids []string) error {
125 m.scopeLock.Lock()
126 defer m.scopeLock.Unlock()
127
128 for _, id := range ids {
129 if _, ok := m.scopes[id]; !ok {
130 return ErrScopeNotFound
131 }
132 }
133 for _, id := range ids {
134 delete(m.scopes, id)
135 }
136 return nil
137 }
138
139 func (m *memstore) listScopes() ([]Scope, error) {
140 m.scopeLock.RLock()
141 defer m.scopeLock.RUnlock()
142
143 scopes := []Scope{}
144 for _, scope := range m.scopes {
145 scopes = append(scopes, scope)
146 }
147 sorted := Scopes(scopes)
148 sort.Sort(sorted)
149 scopes = sorted
150 return scopes, nil
151 }