forked from juju/juju
/
useraccess.go
215 lines (196 loc) · 6.84 KB
/
useraccess.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
// Copyright 2016 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.
package state
import (
"fmt"
"strings"
"time"
"github.com/juju/errors"
"gopkg.in/juju/names.v2"
"gopkg.in/mgo.v2/txn"
"github.com/juju/juju/permission"
)
type userAccessDoc struct {
ID string `bson:"_id"`
ObjectUUID string `bson:"object-uuid"`
UserName string `bson:"user"`
DisplayName string `bson:"displayname"`
CreatedBy string `bson:"createdby"`
DateCreated time.Time `bson:"datecreated"`
}
// UserAccessSpec defines the attributes that can be set when adding a new
// user access.
type UserAccessSpec struct {
User names.UserTag
CreatedBy names.UserTag
DisplayName string
Access permission.Access
}
// userAccessTarget defines the target of a user access granting.
type userAccessTarget struct {
uuid string
globalKey string
}
// AddModelUser adds a new user for the model identified by modelUUID to the database.
func (st *State) AddModelUser(modelUUID string, spec UserAccessSpec) (permission.UserAccess, error) {
if err := permission.ValidateModelAccess(spec.Access); err != nil {
return permission.UserAccess{}, errors.Annotate(err, "adding model user")
}
target := userAccessTarget{
uuid: modelUUID,
globalKey: modelGlobalKey,
}
return st.addUserAccess(spec, target)
}
// AddControllerUser adds a new user for the curent controller to the database.
func (st *State) AddControllerUser(spec UserAccessSpec) (permission.UserAccess, error) {
if err := permission.ValidateControllerAccess(spec.Access); err != nil {
return permission.UserAccess{}, errors.Annotate(err, "adding controller user")
}
return st.addUserAccess(spec, userAccessTarget{globalKey: controllerGlobalKey})
}
func (st *State) addUserAccess(spec UserAccessSpec, target userAccessTarget) (permission.UserAccess, error) {
// Ensure local user exists in state before adding them as an model user.
if spec.User.IsLocal() {
localUser, err := st.User(spec.User)
if err != nil {
return permission.UserAccess{}, errors.Annotate(err, fmt.Sprintf("user %q does not exist locally", spec.User.Name()))
}
if spec.DisplayName == "" {
spec.DisplayName = localUser.DisplayName()
}
}
// Ensure local createdBy user exists.
if spec.CreatedBy.IsLocal() {
if _, err := st.User(spec.CreatedBy); err != nil {
return permission.UserAccess{}, errors.Annotatef(err, "createdBy user %q does not exist locally", spec.CreatedBy.Name())
}
}
var (
ops []txn.Op
err error
targetTag names.Tag
)
switch target.globalKey {
case modelGlobalKey:
ops = createModelUserOps(
target.uuid,
spec.User,
spec.CreatedBy,
spec.DisplayName,
st.NowToTheSecond(),
spec.Access)
targetTag = names.NewModelTag(target.uuid)
case controllerGlobalKey:
ops = createControllerUserOps(
st.ControllerUUID(),
spec.User,
spec.CreatedBy,
spec.DisplayName,
st.NowToTheSecond(),
spec.Access)
targetTag = st.controllerTag
default:
return permission.UserAccess{}, errors.NotSupportedf("user access global key %q", target.globalKey)
}
err = st.runTransactionFor(target.uuid, ops)
if err == txn.ErrAborted {
err = errors.AlreadyExistsf("user access %q", spec.User.Id())
}
if err != nil {
return permission.UserAccess{}, errors.Trace(err)
}
return st.UserAccess(spec.User, targetTag)
}
// userAccessID returns the document id of the user access.
func userAccessID(user names.UserTag) string {
username := user.Id()
return strings.ToLower(username)
}
// NewModelUserAccess returns a new permission.UserAccess for the given userDoc and
// current Model.
func NewModelUserAccess(st *State, userDoc userAccessDoc) (permission.UserAccess, error) {
perm, err := st.userPermission(modelKey(userDoc.ObjectUUID), userGlobalKey(strings.ToLower(userDoc.UserName)))
if err != nil {
return permission.UserAccess{}, errors.Annotate(err, "obtaining model permission")
}
return newUserAccess(perm, userDoc, names.NewModelTag(userDoc.ObjectUUID)), nil
}
// NewControllerUserAccess returns a new permission.UserAccess for the given userDoc and
// current Controller.
func NewControllerUserAccess(st *State, userDoc userAccessDoc) (permission.UserAccess, error) {
perm, err := st.controllerUserPermission(controllerKey(st.ControllerUUID()), userGlobalKey(strings.ToLower(userDoc.UserName)))
if err != nil {
return permission.UserAccess{}, errors.Annotate(err, "obtaining controller permission")
}
return newUserAccess(perm, userDoc, names.NewControllerTag(userDoc.ObjectUUID)), nil
}
func newUserAccess(perm *userPermission, userDoc userAccessDoc, object names.Tag) permission.UserAccess {
return permission.UserAccess{
UserID: userDoc.ID,
UserTag: names.NewUserTag(userDoc.UserName),
Object: object,
Access: perm.access(),
CreatedBy: names.NewUserTag(userDoc.CreatedBy),
DateCreated: userDoc.DateCreated.UTC(),
DisplayName: userDoc.DisplayName,
UserName: userDoc.UserName,
}
}
// UserAccess returns a new permission.UserAccess for the passed subject and target.
func (st *State) UserAccess(subject names.UserTag, target names.Tag) (permission.UserAccess, error) {
if subject.IsLocal() {
_, err := st.User(subject)
if err != nil {
return permission.UserAccess{}, errors.Trace(err)
}
}
var (
userDoc userAccessDoc
err error
)
switch target.Kind() {
case names.ModelTagKind:
userDoc, err = st.modelUser(target.Id(), subject)
if err == nil {
return NewModelUserAccess(st, userDoc)
}
case names.ControllerTagKind:
userDoc, err = st.controllerUser(subject)
if err == nil {
return NewControllerUserAccess(st, userDoc)
}
default:
return permission.UserAccess{}, errors.NotValidf("%q as a target", target.Kind())
}
return permission.UserAccess{}, errors.Trace(err)
}
// SetUserAccess sets <access> level on <target> to <subject>.
func (st *State) SetUserAccess(subject names.UserTag, target names.Tag, access permission.Access) (permission.UserAccess, error) {
err := access.Validate()
if err != nil {
return permission.UserAccess{}, errors.Trace(err)
}
switch target.Kind() {
case names.ModelTagKind:
err = st.setModelAccess(access, userGlobalKey(userAccessID(subject)), target.Id())
case names.ControllerTagKind:
err = st.setControllerAccess(access, userGlobalKey(userAccessID(subject)))
default:
return permission.UserAccess{}, errors.NotValidf("%q as a target", target.Kind())
}
if err != nil {
return permission.UserAccess{}, errors.Trace(err)
}
return st.UserAccess(subject, target)
}
// RemoveUserAccess removes access for subject to the passed tag.
func (st *State) RemoveUserAccess(subject names.UserTag, target names.Tag) error {
switch target.Kind() {
case names.ModelTagKind:
return errors.Trace(st.removeModelUser(subject))
case names.ControllerTagKind:
return errors.Trace(st.removeControllerUser(subject))
}
return errors.NotValidf("%q as a target", target.Kind())
}