-
Notifications
You must be signed in to change notification settings - Fork 348
/
service.go
377 lines (307 loc) · 9.11 KB
/
service.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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
// Package scim partially implements the SCIM v2.0 protocol as described by
// RFC7644 [1]. In general, the SCIM v2.0 protocol is a REST-ful API that
// identity providers (IdPs) use to insert users into Determined upon user
// provisioning in the IdP.
//
// For expediency, this package only implements the subset of the protocol used
// by the Okta IdP [2,3].
//
// [1] https://tools.ietf.org/html/rfc7644
// [2] https://developer.okta.com/docs/concepts/scim/
// [3] https://github.com/oktadeveloper/okta-scim-beta
package scim
import (
"bytes"
"encoding/json"
"io"
"net/http"
"net/url"
"strconv"
"strings"
"github.com/labstack/echo/v4"
"github.com/labstack/echo/v4/middleware"
"github.com/pkg/errors"
"github.com/determined-ai/determined/master/internal/api"
"github.com/determined-ai/determined/master/internal/config"
"github.com/determined-ai/determined/master/internal/db"
"github.com/determined-ai/determined/master/internal/plugin/oauth"
"github.com/determined-ai/determined/master/internal/user"
"github.com/determined-ai/determined/master/pkg/check"
"github.com/determined-ai/determined/master/pkg/model"
)
const (
scimPathRoot = "/scim/v2"
scimContentType = "application/scim+json"
)
type service struct {
config *config.ScimConfig
db *db.PgDB
locationRoot *url.URL
oauthService *oauth.Service
}
func (s *service) validateBasicAuth(username, password string, c echo.Context) (bool, error) {
if username == "" || password == "" || s.config.Auth.BasicAuthConfig == nil {
return false, nil
}
config := s.config.Auth.BasicAuthConfig
return username == config.Username && password == config.Password, nil
}
func (s *service) authMiddleware(next echo.HandlerFunc) echo.HandlerFunc {
return func(c echo.Context) error {
switch {
case s.config.Auth.BasicAuthConfig != nil:
return middleware.BasicAuth(s.validateBasicAuth)(next)(c)
case s.config.Auth.OAuthConfig != nil:
if oauthValid, _ := s.oauthService.ValidateRequest(c); !oauthValid {
return echo.NewHTTPError(http.StatusBadRequest, "invalid OAuth credentials")
}
return next(c)
}
return echo.NewHTTPError(
http.StatusInternalServerError, "no authentication method configured for SCIM",
)
}
}
// GetUsers returns a list of SCIM users, which may be optionally filtered.
func (s *service) GetUsers(c echo.Context) (interface{}, error) {
type Request struct {
Filter *string `query:"filter"`
Count *int `query:"count"`
StartIndex *int `query:"startIndex"`
}
var req Request
if err := api.BindArgs(&req, c); err != nil {
return nil, errors.WithStack(err)
}
count := 100
if req.Count != nil {
count = *req.Count
}
if count < 0 {
return nil, newBadRequestError(errors.New("count < 0"))
}
startIndex := 0
if req.StartIndex != nil {
startIndex = *req.StartIndex
}
if startIndex < 0 {
return nil, newBadRequestError(errors.New("startIndex < 0"))
}
// Okta will only filter on userName.
var username string
const q = "userName eq "
if f := req.Filter; f != nil && len(*f) != 0 {
if strings.HasPrefix(*f, q) {
v, err := strconv.Unquote(strings.TrimPrefix(*f, q))
if err != nil {
return nil, newBadRequestError(err)
}
username = v
} else {
return nil, newBadRequestError(errors.New("unsupported filter"))
}
}
users, err := user.SCIMUserList(c.Request().Context(), startIndex, count, username)
if err != nil {
return nil, err
}
if err := users.SetSCIMFields(s.locationRoot); err != nil {
return nil, err
}
if users.Resources == nil {
users.Resources = make([]*model.SCIMUser, 0)
}
return users, nil
}
// GetUser returns a SCIM user by ID.
func (s *service) GetUser(c echo.Context) (interface{}, error) {
type Request struct {
ID string `path:"user_id"`
}
var req Request
if err := api.BindArgs(&req, c); err != nil {
return nil, err
}
id, err := model.ParseUUID(req.ID)
if err != nil {
return nil, newNotFoundError(err)
}
u, err := user.SCIMUserByID(c.Request().Context(), db.Bun(), id)
if err != nil {
return nil, err
}
if err := u.SetSCIMFields(s.locationRoot); err != nil {
return nil, err
}
return u, nil
}
// PostUser creates a new SCIM user.
func (s *service) PostUser(c echo.Context) (interface{}, error) {
body, err := io.ReadAll(c.Request().Body)
if err != nil {
return nil, newBadRequestError(err)
}
var u model.SCIMUser
if err = json.Unmarshal(body, &u); err != nil {
return nil, newBadRequestError(err)
}
if err = json.Unmarshal(body, &u.RawAttributes); err != nil {
return nil, newBadRequestError(err)
}
if err = check.Validate(u); err != nil {
return nil, newBadRequestError(err)
} else if u.ID.Valid {
return nil, newBadRequestError(errors.New("ID set"))
}
u.Sanitize()
err = u.UpdatePasswordHash(u.Password)
if err != nil {
return nil, errors.WithStack(err)
}
added, err := user.AddSCIMUser(c.Request().Context(), &u)
if errors.Is(err, db.ErrDuplicateRecord) {
return nil, newConflictError(err)
} else if err != nil {
return nil, err
}
if err = added.SetSCIMFields(s.locationRoot); err != nil {
return nil, err
}
c.Response().Header().Set("Location", added.Meta.Location)
c.Response().Status = http.StatusCreated
return added, nil
}
// PutUser updates all the fields of an existing SCIM user.
func (s *service) PutUser(c echo.Context) (interface{}, error) {
type Request struct {
ID string `path:"user_id"`
}
var req Request
if err := api.BindArgs(&req, c); err != nil {
return nil, errors.WithStack(err)
}
body, err := io.ReadAll(c.Request().Body)
if err != nil {
return nil, newBadRequestError(err)
}
var u model.SCIMUser
if err = json.Unmarshal(body, &u); err != nil {
return nil, newBadRequestError(err)
}
if err = json.Unmarshal(body, &u.RawAttributes); err != nil {
return nil, newBadRequestError(err)
}
if err = check.Validate(u); err != nil {
return nil, newBadRequestError(err)
} else if u.ID.String() != req.ID {
return nil, newBadRequestError(errors.New("ID does not match path"))
}
u.Sanitize()
err = u.UpdatePasswordHash(u.Password)
if err != nil {
return nil, errors.WithStack(err)
}
updated, err := user.SetSCIMUser(c.Request().Context(), req.ID, &u)
if err != nil {
return nil, err
}
if err := updated.SetSCIMFields(s.locationRoot); err != nil {
return nil, err
}
return updated, nil
}
// PatchUser updates specific fields of an existing SCIM user. The format of the
// request is a JSON patch (RFC 6902).
func (s *service) PatchUser(c echo.Context) (interface{}, error) {
updatedFields := make(map[string]bool)
var toUpdate []string
// parseField is a helper function that keeps track of unmarshalled fields.
parseField := func(bs []byte, fieldName string, dst interface{}) error {
if len(bs) == 0 {
return nil
}
if updatedFields[fieldName] {
return newBadRequestError(errors.Errorf("field %s already replaced", fieldName))
}
updatedFields[fieldName] = true
if err := json.Unmarshal(bs, dst); err != nil {
return newBadRequestError(err)
}
toUpdate = append(toUpdate, fieldName)
return nil
}
type Request struct {
ID string `path:"user_id"`
Patch model.PatchRequest
}
var req Request
if err := api.BindArgs(&req, c); err != nil {
return nil, err
}
body, err := io.ReadAll(c.Request().Body)
if err != nil {
return nil, newBadRequestError(err)
}
if err = json.Unmarshal(body, &req.Patch); err != nil {
return nil, newBadRequestError(err)
}
type Update struct {
Active json.RawMessage `json:"active"`
Emails json.RawMessage `json:"emails"`
Name json.RawMessage `json:"name"`
DisplayName json.RawMessage `json:"displayName"`
}
var changes model.SCIMUser
for _, op := range req.Patch.Operations {
if op.Op != "replace" {
return nil, newBadRequestError(errors.New("only replace is supported"))
}
if len(op.Path) != 0 {
return nil, newBadRequestError(errors.New("updating subpaths is not supported"))
}
dec := json.NewDecoder(bytes.NewReader(op.Value))
dec.DisallowUnknownFields()
var u Update
if err = dec.Decode(&u); err != nil {
return nil, newBadRequestError(err)
}
if err = parseField(u.Active, "active", &changes.Active); err != nil {
return nil, err
}
if err = parseField(u.Emails, "emails", &changes.Emails); err != nil {
return nil, err
}
if err = parseField(u.Name, "name", &changes.Name); err != nil {
return nil, err
}
if err = parseField(u.DisplayName, "display_name", &changes.DisplayName); err != nil {
return nil, err
}
}
id, err := model.ParseUUID(req.ID)
if err != nil {
return nil, newNotFoundError(err)
}
changes.ID = id
if err = changes.ValidateChanges(); err != nil {
return nil, newBadRequestError(err)
}
updated, err := user.UpdateUserAndDeleteSession(c.Request().Context(), req.ID, &changes, toUpdate)
if err != nil {
return nil, err
}
if err := updated.SetSCIMFields(s.locationRoot); err != nil {
return nil, err
}
return updated, nil
}
func (s *service) GetGroups(c echo.Context) (interface{}, error) {
var groups model.SCIMGroups
if err := groups.SetSCIMFields(s.locationRoot); err != nil {
return nil, err
}
if groups.Resources == nil {
groups.Resources = make([]*model.SCIMGroup, 0)
}
return groups, nil
}