forked from gravitational/teleport
-
Notifications
You must be signed in to change notification settings - Fork 0
/
resource.go
530 lines (496 loc) · 15.9 KB
/
resource.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
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
/*
* Teleport
* Copyright (C) 2023 Gravitational, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package local
import (
"context"
"encoding/json"
"strings"
"github.com/gravitational/trace"
"github.com/gravitational/teleport/api/types"
"github.com/gravitational/teleport/lib/backend"
"github.com/gravitational/teleport/lib/services"
)
// CreateResources attempts to dynamically create the supplied resources.
// This function returns `trace.AlreadyExistsError` if one or more resources
// would be overwritten, and `trace.NotImplementedError` if any resources
// are of an unsupported type (see `itemsFromResources(...)`).
//
// NOTE: This function is non-atomic and performs no internal synchronization;
// backend must be locked by caller when operating in parallel environment.
func CreateResources(ctx context.Context, b backend.Backend, resources ...types.Resource) error {
items, err := itemsFromResources(resources...)
if err != nil {
return trace.Wrap(err)
}
// ensure all items do not exist before continuing.
for _, item := range items {
_, err = b.Get(ctx, item.Key)
if !trace.IsNotFound(err) {
if err != nil {
return trace.Wrap(err)
}
return trace.AlreadyExists("resource %q already exists", string(item.Key))
}
}
// create all items.
for _, item := range items {
_, err := b.Create(ctx, item)
if err != nil {
return trace.Wrap(err)
}
}
return nil
}
// itemsFromResources attempts to convert resources into instances of backend.Item.
// NOTE: this is not necessarily a 1-to-1 conversion.
func itemsFromResources(resources ...types.Resource) ([]backend.Item, error) {
var allItems []backend.Item
for _, rsc := range resources {
items, err := itemsFromResource(rsc)
if err != nil {
return nil, trace.Wrap(err)
}
allItems = append(allItems, items...)
}
return allItems, nil
}
// ItemsFromResource attempts to construct one or more instances of `backend.Item` from
// a given resource. If `rsc` is not one of the supported resource types,
// a `trace.NotImplementedError` is returned.
func itemsFromResource(resource types.Resource) ([]backend.Item, error) {
var item *backend.Item
var extItems []backend.Item
var err error
switch r := resource.(type) {
case types.User:
item, err = itemFromUser(r)
if auth := r.GetLocalAuth(); err == nil && auth != nil {
extItems, err = itemsFromLocalAuthSecrets(r.GetName(), *auth)
}
case types.CertAuthority:
item, err = itemFromCertAuthority(r)
case types.TrustedCluster:
item, err = itemFromTrustedCluster(r)
case types.GithubConnector:
item, err = itemFromGithubConnector(r)
case types.Role:
item, err = itemFromRole(r)
case types.OIDCConnector:
item, err = itemFromOIDCConnector(r)
case types.SAMLConnector:
item, err = itemFromSAMLConnector(r)
case types.ProvisionToken:
item, err = itemFromProvisionToken(r)
case types.Lock:
item, err = itemFromLock(r)
case types.ClusterNetworkingConfig:
item, err = itemFromClusterNetworkingConfig(r)
case types.AuthPreference:
item, err = itemFromAuthPreference(r)
default:
return nil, trace.NotImplemented("cannot itemFrom resource of type %T", resource)
}
if err != nil {
return nil, trace.Wrap(err)
}
items := make([]backend.Item, 0, len(extItems)+1)
items = append(items, *item)
items = append(items, extItems...)
return items, nil
}
// itemFromClusterNetworkingConfig attempts to encode the supplied cluster_networking_config as an
// instance of `backend.Item` suitable for storage.
func itemFromClusterNetworkingConfig(cnc types.ClusterNetworkingConfig) (*backend.Item, error) {
if err := services.CheckAndSetDefaults(cnc); err != nil {
return nil, trace.Wrap(err)
}
value, err := services.MarshalClusterNetworkingConfig(cnc)
if err != nil {
return nil, trace.Wrap(err)
}
item := &backend.Item{
Key: backend.Key(clusterConfigPrefix, networkingPrefix),
Value: value,
ID: cnc.GetResourceID(),
Revision: cnc.GetRevision(),
}
return item, nil
}
// itemFromAuthPreference attempts to encode the supplied cluster_auth_preference as an
// instance of `backend.Item` suitable for storage.
func itemFromAuthPreference(ap types.AuthPreference) (*backend.Item, error) {
if err := services.CheckAndSetDefaults(ap); err != nil {
return nil, trace.Wrap(err)
}
value, err := services.MarshalAuthPreference(ap)
if err != nil {
return nil, trace.Wrap(err)
}
item := &backend.Item{
Key: backend.Key(authPrefix, preferencePrefix, generalPrefix),
Value: value,
ID: ap.GetResourceID(),
Revision: ap.GetRevision(),
}
return item, nil
}
// itemFromUser attempts to encode the supplied user as an
// instance of `backend.Item` suitable for storage.
func itemFromUser(user types.User) (*backend.Item, error) {
if err := services.ValidateUser(user); err != nil {
return nil, trace.Wrap(err)
}
rev := user.GetRevision()
value, err := services.MarshalUser(user)
if err != nil {
return nil, trace.Wrap(err)
}
item := &backend.Item{
Key: backend.Key(webPrefix, usersPrefix, user.GetName(), paramsPrefix),
Value: value,
Expires: user.Expiry(),
ID: user.GetResourceID(),
Revision: rev,
}
return item, nil
}
// itemToUser attempts to decode the supplied `backend.Item` as
// a user resource.
func itemToUser(item backend.Item) (types.User, error) {
user, err := services.UnmarshalUser(
item.Value,
services.WithResourceID(item.ID),
services.WithExpires(item.Expires),
services.WithRevision(item.Revision),
)
if err != nil {
return nil, trace.Wrap(err)
}
if err := services.ValidateUser(user); err != nil {
return nil, trace.Wrap(err)
}
return user, nil
}
// itemFromCertAuthority attempts to encode the supplied certificate authority
// as an instance of `backend.Item` suitable for storage.
func itemFromCertAuthority(ca types.CertAuthority) (*backend.Item, error) {
if err := services.ValidateCertAuthority(ca); err != nil {
return nil, trace.Wrap(err)
}
rev := ca.GetRevision()
value, err := services.MarshalCertAuthority(ca)
if err != nil {
return nil, trace.Wrap(err)
}
item := &backend.Item{
Key: backend.Key(authoritiesPrefix, string(ca.GetType()), ca.GetName()),
Value: value,
Expires: ca.Expiry(),
ID: ca.GetResourceID(),
Revision: rev,
}
return item, nil
}
// itemFromProvisionToken attempts to encode the supplied provision token
// as an instance of `backend.Item` suitable for storage.
func itemFromProvisionToken(p types.ProvisionToken) (*backend.Item, error) {
if err := services.CheckAndSetDefaults(p); err != nil {
return nil, trace.Wrap(err)
}
rev := p.GetRevision()
value, err := services.MarshalProvisionToken(p)
if err != nil {
return nil, trace.Wrap(err)
}
item := &backend.Item{
Key: backend.Key(tokensPrefix, p.GetName()),
Value: value,
Expires: p.Expiry(),
ID: p.GetResourceID(),
Revision: rev,
}
return item, nil
}
// itemFromTrustedCluster attempts to encode the supplied trusted cluster
// as an instance of `backend.Item` suitable for storage.
func itemFromTrustedCluster(tc types.TrustedCluster) (*backend.Item, error) {
if err := services.CheckAndSetDefaults(tc); err != nil {
return nil, trace.Wrap(err)
}
rev := tc.GetRevision()
value, err := services.MarshalTrustedCluster(tc)
if err != nil {
return nil, trace.Wrap(err)
}
item := &backend.Item{
Key: backend.Key(trustedClustersPrefix, tc.GetName()),
Value: value,
Expires: tc.Expiry(),
ID: tc.GetResourceID(),
Revision: rev,
}
return item, nil
}
// itemFromGithubConnector attempts to encode the supplied github connector
// as an instance of `backend.Item` suitable for storage.
func itemFromGithubConnector(gc types.GithubConnector) (*backend.Item, error) {
if err := services.CheckAndSetDefaults(gc); err != nil {
return nil, trace.Wrap(err)
}
rev := gc.GetRevision()
value, err := services.MarshalGithubConnector(gc)
if err != nil {
return nil, trace.Wrap(err)
}
item := &backend.Item{
Key: backend.Key(webPrefix, connectorsPrefix, githubPrefix, connectorsPrefix, gc.GetName()),
Value: value,
Expires: gc.Expiry(),
ID: gc.GetResourceID(),
Revision: rev,
}
return item, nil
}
// itemFromRole attempts to encode the supplied role as an
// instance of `backend.Item` suitable for storage.
func itemFromRole(role types.Role) (*backend.Item, error) {
rev := role.GetRevision()
value, err := services.MarshalRole(role)
if err != nil {
return nil, trace.Wrap(err)
}
item := &backend.Item{
Key: backend.Key(rolesPrefix, role.GetName(), paramsPrefix),
Value: value,
Expires: role.Expiry(),
ID: role.GetResourceID(),
Revision: rev,
}
return item, nil
}
// itemFromOIDCConnector attempts to encode the supplied connector as an
// instance of `backend.Item` suitable for storage.
func itemFromOIDCConnector(connector types.OIDCConnector) (*backend.Item, error) {
rev := connector.GetRevision()
value, err := services.MarshalOIDCConnector(connector)
if err != nil {
return nil, trace.Wrap(err)
}
item := &backend.Item{
Key: backend.Key(webPrefix, connectorsPrefix, oidcPrefix, connectorsPrefix, connector.GetName()),
Value: value,
Expires: connector.Expiry(),
ID: connector.GetResourceID(),
Revision: rev,
}
return item, nil
}
// itemFromSAMLConnector attempts to encode the supplied connector as an
// instance of `backend.Item` suitable for storage.
func itemFromSAMLConnector(connector types.SAMLConnector) (*backend.Item, error) {
rev := connector.GetRevision()
if err := services.ValidateSAMLConnector(connector, nil); err != nil {
return nil, trace.Wrap(err)
}
value, err := services.MarshalSAMLConnector(connector)
if err != nil {
return nil, trace.Wrap(err)
}
item := &backend.Item{
Key: backend.Key(webPrefix, connectorsPrefix, samlPrefix, connectorsPrefix, connector.GetName()),
Value: value,
Expires: connector.Expiry(),
ID: connector.GetResourceID(),
Revision: rev,
}
return item, nil
}
// userFromUserItems is an extended variant of itemToUser which can be used
// with the `userItems` collector to include additional backend.Item values
// such as password hash or MFA devices.
func userFromUserItems(name string, items userItems) (types.User, error) {
if items.params == nil {
return nil, trace.BadParameter("cannot itemTo user %q without primary item %q", name, paramsPrefix)
}
user, err := itemToUser(*items.params)
if err != nil {
return nil, trace.Wrap(err)
}
if !items.hasLocalAuthItems() {
return user, nil
}
auth, err := itemToLocalAuthSecrets(items)
if err != nil {
return nil, trace.Wrap(err)
}
user.SetLocalAuth(auth)
return user, nil
}
func itemToLocalAuthSecrets(items userItems) (*types.LocalAuthSecrets, error) {
var auth types.LocalAuthSecrets
if items.pwd != nil {
auth.PasswordHash = items.pwd.Value
}
for _, mfa := range items.mfa {
var d types.MFADevice
if err := json.Unmarshal(mfa.Value, &d); err != nil {
return nil, trace.Wrap(err)
}
auth.MFA = append(auth.MFA, &d)
}
if items.webauthnLocalAuth != nil {
wal := &types.WebauthnLocalAuth{}
err := json.Unmarshal(items.webauthnLocalAuth.Value, wal)
if err != nil {
return nil, trace.Wrap(err)
}
auth.Webauthn = wal
}
if err := services.ValidateLocalAuthSecrets(&auth); err != nil {
return nil, trace.Wrap(err)
}
return &auth, nil
}
func itemsFromLocalAuthSecrets(user string, auth types.LocalAuthSecrets) ([]backend.Item, error) {
var items []backend.Item
if err := services.ValidateLocalAuthSecrets(&auth); err != nil {
return nil, trace.Wrap(err)
}
if len(auth.PasswordHash) > 0 {
item := backend.Item{
Key: backend.Key(webPrefix, usersPrefix, user, pwdPrefix),
Value: auth.PasswordHash,
}
items = append(items, item)
}
for _, mfa := range auth.MFA {
value, err := json.Marshal(mfa)
if err != nil {
return nil, trace.Wrap(err)
}
items = append(items, backend.Item{
Key: backend.Key(webPrefix, usersPrefix, user, mfaDevicePrefix, mfa.Id),
Value: value,
})
}
return items, nil
}
// itemFromLock attempts to encode the supplied lock as an
// instance of `backend.Item` suitable for storage.
func itemFromLock(l types.Lock) (*backend.Item, error) {
if err := services.CheckAndSetDefaults(l); err != nil {
return nil, trace.Wrap(err)
}
rev := l.GetRevision()
value, err := services.MarshalLock(l)
if err != nil {
return nil, trace.Wrap(err)
}
return &backend.Item{
Key: backend.Key(locksPrefix, l.GetName()),
Value: value,
Expires: l.Expiry(),
ID: l.GetResourceID(),
Revision: rev,
}, nil
}
// TODO: convert username/suffix ops to work on bytes by default; string/byte conversion
// has order N cost.
// fullUsersPrefix is the entire string preceding the name of a user in a key
var fullUsersPrefix = string(backend.Key(webPrefix, usersPrefix)) + "/"
// splitUsernameAndSuffix is a helper for extracting usernames and suffixes from
// backend key values.
func splitUsernameAndSuffix(key string) (name string, suffix string, err error) {
if !strings.HasPrefix(key, fullUsersPrefix) {
return "", "", trace.BadParameter("expected format '%s/<name>/<suffix>', got '%s'", fullUsersPrefix, key)
}
key = strings.TrimPrefix(key, fullUsersPrefix)
idx := strings.Index(key, "/")
if idx < 1 || idx >= len(key) {
return "", "", trace.BadParameter("expected format <name>/<suffix>, got %q", key)
}
return key[:idx], key[idx+1:], nil
}
// collectUserItems handles the case where multiple items pertain to the same user resource.
// User associated items are sorted by username and suffix. Items which do not both start with
// the expected prefix *and* end with one of the expected suffixes are passed back in `rem`.
func collectUserItems(items []backend.Item) (users map[string]userItems, rem []backend.Item, err error) {
users = make(map[string]userItems)
for _, item := range items {
key := string(item.Key)
if !strings.HasPrefix(key, fullUsersPrefix) {
rem = append(rem, item)
continue
}
name, suffix, err := splitUsernameAndSuffix(key)
if err != nil {
return nil, nil, err
}
collector := users[name]
if !collector.Set(suffix, item) {
// suffix not recognized, output this item with the rest of the
// unhandled items.
rem = append(rem, item)
continue
}
users[name] = collector
}
// Remove user entries that are incomplete.
//
// For example, an SSO user entry that expired but still has MFA devices
// persisted. These users should not be loaded until they login again.
for user, items := range users {
if !items.complete() {
delete(users, user)
}
}
return users, rem, nil
}
// userItems is a collector for item types related to a single user resource.
type userItems struct {
params *backend.Item
pwd *backend.Item
mfa []*backend.Item
webauthnLocalAuth *backend.Item
}
// Set attempts to set a field by suffix.
func (u *userItems) Set(suffix string, item backend.Item) (ok bool) {
switch suffix {
case paramsPrefix:
u.params = &item
case pwdPrefix:
u.pwd = &item
case webauthnLocalAuthPrefix:
u.webauthnLocalAuth = &item
default:
if strings.HasPrefix(suffix, mfaDevicePrefix) {
u.mfa = append(u.mfa, &item)
} else {
return false
}
}
return true
}
// complete checks whether userItems is complete enough to be parsed by
// userFromUserItems.
func (u *userItems) complete() bool {
return u.params != nil
}
func (u *userItems) hasLocalAuthItems() bool {
return u.pwd != nil || u.webauthnLocalAuth != nil || len(u.mfa) > 0
}