auth

Paddy 2015-05-17 Parent:73e12d5a1124

173:b0d1b3e39fc8 Go to Latest

auth/scope.go

Make client use our auth(n/z) scheme. Our auth(n/z) scheme can be loosely defined as "encrypted tokens that nginx transforms into headers" and "scopes for bypassing ACL". Our Go client, which is what we'll be using to have services communicate with each other, follows this paradigm now by auto-injecting the headers we'll need to identify ourselves. This will work behind our firewall, but will be useless for the rest of the world, which will need to go through the nginx bastion that can strip the headers and replace them with the headers appropriate to the token attached to the request. This did involve setting a static client ID as the client for our email_verification listener. Ideally, this would cause Client registration (using that ID) when the listener starts up, ignoring ErrClientAlreadyExists. I don't want to have to write the code that will allow us to bypass the Client ACL properly right now, though, so we're just going to have to remember to manually create that Client. Or not. I don't think it will do any harm (outside the OAuth flow) to be using a Client ID that doesn't actually point to a Client. I just think it'd be good for record-keeping purposes.

History
1 package auth
3 import (
4 "errors"
5 "sort"
6 )
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 )
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 }
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 }
30 type Scopes []Scope
32 func (s Scopes) Len() int {
33 return len(s)
34 }
36 func (s Scopes) Swap(i, j int) {
37 s[i], s[j] = s[j], s[i]
38 }
40 func (s Scopes) Less(i, j int) bool {
41 return s[i].ID < s[j].ID
42 }
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 }
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 }
60 // ScopeChange represents a change to a Scope.
61 type ScopeChange struct {
62 Name *string
63 Description *string
64 }
66 func (s ScopeChange) Empty() bool {
67 return s.Name == nil && s.Description == nil
68 }
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 }
78 func (m *memstore) createScopes(scopes []Scope) error {
79 m.scopeLock.Lock()
80 defer m.scopeLock.Unlock()
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 }
93 func (m *memstore) getScopes(ids []string) ([]Scope, error) {
94 m.scopeLock.RLock()
95 defer m.scopeLock.RUnlock()
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 }
111 func (m *memstore) updateScope(id string, change ScopeChange) error {
112 m.scopeLock.Lock()
113 defer m.scopeLock.Unlock()
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 }
124 func (m *memstore) removeScopes(ids []string) error {
125 m.scopeLock.Lock()
126 defer m.scopeLock.Unlock()
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 }
139 func (m *memstore) listScopes() ([]Scope, error) {
140 m.scopeLock.RLock()
141 defer m.scopeLock.RUnlock()
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 }