-
Notifications
You must be signed in to change notification settings - Fork 711
/
user.go
626 lines (535 loc) · 19 KB
/
user.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
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
/*
Copyright IBM Corp. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0
*/
package user
import (
"database/sql"
"encoding/json"
"strings"
"github.com/cloudflare/cfssl/log"
"github.com/hyperledger/fabric-ca/api"
"github.com/hyperledger/fabric-ca/lib/spi"
"github.com/jmoiron/sqlx"
"github.com/pkg/errors"
"golang.org/x/crypto/bcrypt"
)
// DbTxResult returns information on any affiliations and/or identities affected
// during a database transaction
type DbTxResult struct {
Affiliations []spi.Affiliation
Identities []User
}
// Registry is the API for retreiving users and groups
type Registry interface {
GetUser(id string, attrs []string) (User, error)
InsertUser(user *Info) error
UpdateUser(user *Info, updatePass bool) error
DeleteUser(id string) (User, error)
GetAffiliation(name string) (spi.Affiliation, error)
GetAllAffiliations(name string) (*sqlx.Rows, error)
InsertAffiliation(name string, prekey string, level int) error
GetUserLessThanLevel(version int) ([]User, error)
GetFilteredUsers(affiliation, types string) (*sqlx.Rows, error)
DeleteAffiliation(name string, force, identityRemoval, isRegistrar bool) (*DbTxResult, error)
ModifyAffiliation(oldAffiliation, newAffiliation string, force, isRegistrar bool) (*DbTxResult, error)
GetAffiliationTree(name string) (*DbTxResult, error)
}
// User is the SPI for a user
type User interface {
// Returns the enrollment ID of the user
GetName() string
// Return the type of the user
GetType() string
// Return the max enrollments of the user
GetMaxEnrollments() int
// Login the user with a password
Login(password string, caMaxEnrollment int) error
// Get the complete path for the user's affiliation.
GetAffiliationPath() []string
// GetAttribute returns the value for an attribute name
GetAttribute(name string) (*api.Attribute, error)
// GetAttributes returns the requested attributes
GetAttributes(attrNames []string) ([]api.Attribute, error)
// ModifyAttributes adds, removes, or deletes attribute
ModifyAttributes(attrs []api.Attribute) error
// LoginComplete completes the login process by incrementing the state of the user
LoginComplete() error
// Revoke will revoke the user, setting the state of the user to be -1
Revoke() error
// IsRevoked returns back true if user is revoked
IsRevoked() bool
// GetLevel returns the level of the user, level is used to verify if the user needs migration
GetLevel() int
// SetLevel sets the level of the user
SetLevel(level int) error
// IncrementIncorrectPasswordAttempts updates the incorrect password count of user
IncrementIncorrectPasswordAttempts() error
// GetFailedLoginAttempts returns the number of times the user has entered an incorrect password
GetFailedLoginAttempts() int
}
// Record defines the properties of a user
type Record struct {
Name string `db:"id"`
Pass []byte `db:"token"`
Type string `db:"type"`
Affiliation string `db:"affiliation"`
Attributes string `db:"attributes"`
State int `db:"state"`
MaxEnrollments int `db:"max_enrollments"`
Level int `db:"level"`
IncorrectPasswordAttempts int `db:"incorrect_password_attempts"`
}
// Info contains information about a user
type Info struct {
Name string
Pass string `mask:"password"`
Type string
Affiliation string
Attributes []api.Attribute
State int
MaxEnrollments int
Level int
IncorrectPasswordAttempts int
}
//go:generate counterfeiter -o mocks/userDB.go -fake-name UserDB . userDB
type userDB interface {
Exec(funcName, query string, args ...interface{}) (sql.Result, error)
Get(funcName string, dest interface{}, query string, args ...interface{}) error
Rebind(query string) string
Queryx(funcName, query string, args ...interface{}) (*sqlx.Rows, error)
}
// Impl is the databases representation of a user
type Impl struct {
Info
pass []byte
attrs map[string]api.Attribute
db userDB
}
// New creates a DBUser object from the DB user record
func New(userRec *Record, db userDB) *Impl {
var user = new(Impl)
user.Name = userRec.Name
user.pass = userRec.Pass
user.State = userRec.State
user.MaxEnrollments = userRec.MaxEnrollments
user.Affiliation = userRec.Affiliation
user.Type = userRec.Type
user.Level = userRec.Level
user.IncorrectPasswordAttempts = userRec.IncorrectPasswordAttempts
var attrs []api.Attribute
json.Unmarshal([]byte(userRec.Attributes), &attrs)
user.Attributes = attrs
user.attrs = make(map[string]api.Attribute)
for _, attr := range attrs {
user.attrs[attr.Name] = api.Attribute{
Name: attr.Name,
Value: attr.Value,
ECert: attr.ECert,
}
}
user.db = db
return user
}
// GetName returns the enrollment ID of the user
func (u *Impl) GetName() string {
return u.Name
}
// GetPass returns the hashed password of the user
func (u *Impl) GetPass() []byte {
return u.pass
}
// GetType returns the type of the user
func (u *Impl) GetType() string {
return u.Type
}
// GetMaxEnrollments returns the max enrollments of the user
func (u *Impl) GetMaxEnrollments() int {
return u.MaxEnrollments
}
// GetLevel returns the level of the user
func (u *Impl) GetLevel() int {
return u.Level
}
// SetLevel sets the level of the user
func (u *Impl) SetLevel(level int) error {
return u.setLevel(nil, level)
}
// SetLevelTx sets the level of the user
func (u *Impl) SetLevelTx(tx userDB, level int) error {
return u.setLevel(tx, level)
}
func (u *Impl) setLevel(tx userDB, level int) (err error) {
query := "UPDATE users SET level = ? where (id = ?)"
id := u.GetName()
var res sql.Result
if tx != nil {
res, err = tx.Exec("SetLevel", tx.Rebind(query), level, id)
if err != nil {
return err
}
} else {
res, err = u.db.Exec("SetLevel", u.db.Rebind(query), level, id)
if err != nil {
return err
}
}
numRowsAffected, err := res.RowsAffected()
if err != nil {
return errors.Wrap(err, "Failed to get number of rows affected")
}
if numRowsAffected == 0 {
return errors.Errorf("No rows were affected when updating the state of identity %s", id)
}
if numRowsAffected != 1 {
return errors.Errorf("%d rows were affected when updating the state of identity %s", numRowsAffected, id)
}
return nil
}
// Login the user with a password
func (u *Impl) Login(pass string, caMaxEnrollments int) error {
log.Debugf("DB: Login user %s with max enrollments of %d and state of %d", u.Name, u.MaxEnrollments, u.State)
// Check the password by comparing to stored hash
err := bcrypt.CompareHashAndPassword(u.pass, []byte(pass))
if err != nil {
err2 := u.IncrementIncorrectPasswordAttempts()
if err2 != nil {
return errors.Wrap(err2, "Failed to mark incorrect password attempt")
}
return errors.Wrap(err, "Password mismatch")
}
if u.MaxEnrollments == 0 {
return errors.Errorf("Zero is an invalid value for maximum enrollments on identity '%s'", u.Name)
}
if u.State == -1 {
return errors.Errorf("User %s is revoked; access denied", u.Name)
}
// If max enrollment value of user is greater than allowed by CA, using CA max enrollment value for user
if caMaxEnrollments != -1 && (u.MaxEnrollments > caMaxEnrollments || u.MaxEnrollments == -1) {
log.Debugf("Max enrollment value (%d) of identity is greater than allowed by CA, using CA max enrollment value of %d", u.MaxEnrollments, caMaxEnrollments)
u.MaxEnrollments = caMaxEnrollments
}
// If maxEnrollments is set to -1, user has unlimited enrollment
// If the maxEnrollments is set (i.e. >= 1), make sure we haven't exceeded this number of logins.
// The state variable keeps track of the number of previously successful logins.
if u.MaxEnrollments != -1 && u.State >= u.MaxEnrollments {
return errors.Errorf("The identity %s has already enrolled %d times, it has reached its maximum enrollment allowance", u.Name, u.MaxEnrollments)
}
log.Debugf("DB: identity %s successfully logged in", u.Name)
return u.resetIncorrectLoginAttempts()
}
func (u *Impl) resetIncorrectLoginAttempts() error {
var passAttempts int
err := u.db.Get("ResetIncorrectLoginAttempts", &passAttempts, u.db.Rebind("Select incorrect_password_attempts FROM users WHERE (id = ?)"), u.GetName())
if err != nil {
return errors.Wrapf(err, "Failed to get incorrect password attempt for %s", u.Name)
}
// Incorrect password attempts already at zero, don't need to reset
if passAttempts == 0 {
return nil
}
resetSQL := "UPDATE users SET incorrect_password_attempts = 0 WHERE (id = ?)"
res, err := u.db.Exec("ResetIncorrectLoginAttempts", u.db.Rebind(resetSQL), u.GetName())
if err != nil {
return errors.Wrapf(err, "Failed to update incorrect password attempt count to 0 for %s", u.Name)
}
numRowsAffected, err := res.RowsAffected()
if err != nil {
return errors.Wrap(err, "db.RowsAffected failed")
}
if numRowsAffected == 0 {
return errors.Errorf("No rows were affected when updating the state of identity %s", u.Name)
}
if numRowsAffected != 1 {
return errors.Errorf("%d rows were affected when updating the state of identity %s", numRowsAffected, u.Name)
}
return nil
}
// LoginComplete completes the login process by incrementing the state of the user
func (u *Impl) LoginComplete() error {
var stateUpdateSQL string
var args []interface{}
var err error
state := u.State + 1
args = append(args, u.Name)
if u.MaxEnrollments == -1 {
// unlimited so no state check
stateUpdateSQL = "UPDATE users SET state = state + 1 WHERE (id = ?)"
} else {
// state must be less than max enrollments
stateUpdateSQL = "UPDATE users SET state = state + 1 WHERE (id = ? AND state < ?)"
args = append(args, u.MaxEnrollments)
}
res, err := u.db.Exec("LoginComplete", u.db.Rebind(stateUpdateSQL), args...)
if err != nil {
return errors.Wrapf(err, "Failed to update state of identity %s to %d", u.Name, state)
}
numRowsAffected, err := res.RowsAffected()
if err != nil {
return errors.Wrap(err, "Failed to get number of rows affected")
}
if numRowsAffected == 0 {
return errors.Errorf("No rows were affected when updating the state of identity %s", u.Name)
}
if numRowsAffected != 1 {
return errors.Errorf("%d rows were affected when updating the state of identity %s", numRowsAffected, u.Name)
}
u.State = u.State + 1
log.Debugf("Successfully incremented state for identity %s to %d", u.Name, state)
return nil
}
// GetAffiliationPath returns the complete path for the user's affiliation.
func (u *Impl) GetAffiliationPath() []string {
affiliationPath := strings.Split(u.Affiliation, ".")
return affiliationPath
}
// GetAttribute returns the value for an attribute name
func (u *Impl) GetAttribute(name string) (*api.Attribute, error) {
value, hasAttr := u.attrs[name]
if !hasAttr {
return nil, errors.Errorf("User does not have attribute '%s'", name)
}
return &value, nil
}
// GetAttributes returns the requested attributes. Return all the user's
// attributes if nil is passed in
func (u *Impl) GetAttributes(attrNames []string) ([]api.Attribute, error) {
var attrs []api.Attribute
if attrNames == nil {
for _, value := range u.attrs {
attrs = append(attrs, value)
}
return attrs, nil
}
for _, name := range attrNames {
value, hasAttr := u.attrs[name]
if !hasAttr {
return nil, errors.Errorf("User does not have attribute '%s'", name)
}
attrs = append(attrs, value)
}
return attrs, nil
}
// Revoke will revoke the user, setting the state of the user to be -1
func (u *Impl) Revoke() error {
stateUpdateSQL := "UPDATE users SET state = -1 WHERE (id = ?)"
res, err := u.db.Exec("Revoke", u.db.Rebind(stateUpdateSQL), u.GetName())
if err != nil {
return errors.Wrapf(err, "Failed to update state of identity %s to -1", u.Name)
}
numRowsAffected, err := res.RowsAffected()
if err != nil {
return errors.Wrap(err, "Failed to get number of rows affected")
}
if numRowsAffected == 0 {
return errors.Errorf("No rows were affected when updating the state of identity %s", u.Name)
}
if numRowsAffected != 1 {
return errors.Errorf("%d rows were affected when updating the state of identity %s", numRowsAffected, u.Name)
}
u.State = -1
log.Debugf("Successfully incremented state for identity %s to -1", u.Name)
return nil
}
// IsRevoked returns back true if user is revoked
func (u *Impl) IsRevoked() bool {
return u.State == -1
}
// ModifyAttributesTx adds a new attribute, modifies existing attribute, or delete attribute
func (u *Impl) ModifyAttributesTx(tx userDB, newAttrs []api.Attribute) error {
return u.modifyAttributes(tx, newAttrs)
}
// ModifyAttributes adds a new attribute, modifies existing attribute, or delete attribute
func (u *Impl) ModifyAttributes(newAttrs []api.Attribute) error {
return u.modifyAttributes(nil, newAttrs)
}
func (u *Impl) modifyAttributes(tx userDB, newAttrs []api.Attribute) error {
log.Debugf("Modify Attributes: %+v", newAttrs)
currentAttrs, _ := u.GetAttributes(nil)
userAttrs := GetNewAttributes(currentAttrs, newAttrs)
attrBytes, err := json.Marshal(userAttrs)
if err != nil {
return err
}
query := "UPDATE users SET attributes = ? WHERE (id = ?)"
id := u.GetName()
var res sql.Result
if tx == nil {
res, err = u.db.Exec("ModifyAttributes", u.db.Rebind(query), string(attrBytes), id)
if err != nil {
return err
}
} else {
res, err = tx.Exec("ModifyAttributes", tx.Rebind(query), string(attrBytes), id)
if err != nil {
return err
}
}
numRowsAffected, err := res.RowsAffected()
if err != nil {
return errors.Wrap(err, "Failed to get number of rows affected")
}
if numRowsAffected == 0 {
return errors.Errorf("No rows were affected when updating the state of identity %s", id)
}
if numRowsAffected != 1 {
return errors.Errorf("%d rows were affected when updating the state of identity %s", numRowsAffected, id)
}
return nil
}
// GetNewAttributes updates existing attribute, or add attribute if it does not already exist
func GetNewAttributes(modifyAttrs, newAttrs []api.Attribute) []api.Attribute {
var attr api.Attribute
for _, attr = range newAttrs {
log.Debugf("Attribute request: %+v", attr)
found := false
for i := range modifyAttrs {
if modifyAttrs[i].Name == attr.Name {
if attr.Value == "" {
log.Debugf("Deleting attribute: %+v", modifyAttrs[i])
if i == len(modifyAttrs)-1 {
modifyAttrs = modifyAttrs[:len(modifyAttrs)-1]
} else {
modifyAttrs = append(modifyAttrs[:i], modifyAttrs[i+1:]...)
}
} else {
log.Debugf("Updating existing attribute from '%+v' to '%+v'", modifyAttrs[i], attr)
modifyAttrs[i].Value = attr.Value
modifyAttrs[i].ECert = attr.ECert
}
found = true
break
}
}
if !found && attr.Value != "" {
log.Debugf("Adding '%+v' as new attribute", attr)
modifyAttrs = append(modifyAttrs, attr)
}
}
return modifyAttrs
}
// IncrementIncorrectPasswordAttempts updates the incorrect password count of user
func (u *Impl) IncrementIncorrectPasswordAttempts() error {
log.Debugf("Incorrect password entered by user '%s'", u.GetName())
query := "UPDATE users SET incorrect_password_attempts = incorrect_password_attempts + 1 where (id = ?)"
id := u.GetName()
res, err := u.db.Exec("IncrementIncorrectPasswordAttempts", u.db.Rebind(query), id)
if err != nil {
return err
}
numRowsAffected, err := res.RowsAffected()
if err != nil {
return errors.Wrap(err, "Failed to get number of rows affected")
}
if numRowsAffected == 0 {
return errors.Errorf("No rows were affected when updating the state of identity %s", id)
}
if numRowsAffected != 1 {
return errors.Errorf("%d rows were affected when updating the state of identity %s", numRowsAffected, id)
}
return nil
}
// GetFailedLoginAttempts returns the number of times the user has entered an incorrect password
func (u *Impl) GetFailedLoginAttempts() int {
return u.IncorrectPasswordAttempts
}
// Migrate will migrate the user to the latest version
func (u *Impl) Migrate(tx userDB) error {
switch u.GetLevel() {
case 0:
err := u.migrateUserToLevel1(tx)
if err != nil {
return err
}
fallthrough
case 1:
err := u.migrateUserToLevel2(tx)
if err != nil {
return err
}
fallthrough
default:
return nil
}
}
func (u *Impl) migrateUserToLevel1(tx userDB) error {
log.Debugf("Migrating user '%s' to level 1", u.GetName())
// Update identity to level 1
_, err := u.GetAttribute("hf.Registrar.Roles") // Check if user is a registrar
if err == nil {
_, err := u.GetAttribute("hf.Registrar.Attributes") // Check if user already has "hf.Registrar.Attributes" attribute
if err != nil {
newAttr := api.Attribute{Name: "hf.Registrar.Attributes", Value: "*"}
err := u.ModifyAttributesTx(tx, []api.Attribute{newAttr})
if err != nil {
return errors.WithMessage(err, "Failed to set attribute")
}
u.attrs[newAttr.Name] = newAttr
}
}
err = u.setLevel(tx, 1)
if err != nil {
return errors.WithMessage(err, "Failed to update level of user")
}
return nil
}
func (u *Impl) migrateUserToLevel2(tx userDB) error {
log.Debugf("Migrating user '%s' to level 2", u.GetName())
// Update identity to level 2
// Only give these attributes to a registrar user
_, err := u.GetAttribute("hf.Registrar.Roles") // Check if user is a registrar
if err == nil {
_, err := u.GetAttribute("hf.AffiliationMgr") // Check if user already has "hf.AffiliationMgr" attribute
if err != nil {
newAttr := api.Attribute{Name: "hf.AffiliationMgr", Value: "true"}
err := u.ModifyAttributesTx(tx, []api.Attribute{newAttr})
if err != nil {
return errors.WithMessage(err, "Failed to set attribute")
}
u.attrs[newAttr.Name] = newAttr
}
_, err = u.GetAttribute("hf.GenCRL") // Check if user already has "hf.GenCRL" attribute
if err != nil {
newAttr := api.Attribute{Name: "hf.GenCRL", Value: "true"}
err := u.ModifyAttributesTx(tx, []api.Attribute{newAttr})
if err != nil {
return errors.WithMessage(err, "Failed to set attribute")
}
u.attrs[newAttr.Name] = newAttr
}
}
err = u.setLevel(tx, 2)
if err != nil {
return errors.WithMessage(err, "Failed to update level of user")
}
return nil
}
// Affiliation is interface that defines functions needed to get a user's affiliation
type Affiliation interface {
GetAffiliationPath() []string
}
// GetAffiliation return a joined version version of the affiliation path with '.' as the seperator
func GetAffiliation(user Affiliation) string {
return strings.Join(user.GetAffiliationPath(), ".")
}
// GetUserLessThanLevel returns all identities that are less than the level specified
// Otherwise, returns no users if requested level is zero
func GetUserLessThanLevel(tx userDB, level int) ([]*Impl, error) {
if level == 0 {
return []*Impl{}, nil
}
rows, err := tx.Queryx("GetUserLessThanLevel", tx.Rebind("SELECT * FROM users WHERE (level < ?) OR (level IS NULL)"), level)
if err != nil {
return nil, errors.Wrap(err, "Failed to get identities that need to be updated")
}
allUsers := []*Impl{}
if rows != nil {
for rows.Next() {
var user Record
rows.StructScan(&user)
dbUser := New(&user, nil)
allUsers = append(allUsers, dbUser)
}
}
return allUsers, nil
}