-
Notifications
You must be signed in to change notification settings - Fork 647
/
service.go
401 lines (326 loc) · 10.6 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
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
// (c) 2019-2020, Ava Labs, Inc. All rights reserved.
// See the file LICENSE for licensing terms.
package keystore
import (
"errors"
"fmt"
"net/http"
"sync"
"github.com/gorilla/rpc/v2"
"github.com/ava-labs/gecko/chains/atomic"
"github.com/ava-labs/gecko/database"
"github.com/ava-labs/gecko/database/encdb"
"github.com/ava-labs/gecko/database/prefixdb"
"github.com/ava-labs/gecko/ids"
"github.com/ava-labs/gecko/snow/engine/common"
"github.com/ava-labs/gecko/utils/formatting"
"github.com/ava-labs/gecko/utils/logging"
"github.com/ava-labs/gecko/vms/components/codec"
jsoncodec "github.com/ava-labs/gecko/utils/json"
zxcvbn "github.com/nbutton23/zxcvbn-go"
)
const (
// maxUserPassLen is the maximum length of the username or password allowed
maxUserPassLen = 25
// requiredPassScore defines the score a password must achieve to be accepted
// as a password with strong characteristics by the zxcvbn package
//
// The scoring mechanism defined is as follows;
//
// 0 # too guessable: risky password. (guesses < 10^3)
// 1 # very guessable: protection from throttled online attacks. (guesses < 10^6)
// 2 # somewhat guessable: protection from unthrottled online attacks. (guesses < 10^8)
// 3 # safely unguessable: moderate protection from offline slow-hash scenario. (guesses < 10^10)
// 4 # very unguessable: strong protection from offline slow-hash scenario. (guesses >= 10^10)
requiredPassScore = 2
)
var (
errEmptyUsername = errors.New("username can't be the empty string")
errUserPassMaxLength = fmt.Errorf("CreateUser call rejected due to username or password exceeding maximum length of %d chars", maxUserPassLen)
errWeakPassword = errors.New("Failed to create user as the given password is too weak. A stronger password is one of 8 or more characters containing attributes of upper and lowercase letters, numbers, and/or special characters")
)
// KeyValuePair ...
type KeyValuePair struct {
Key []byte `serialize:"true"`
Value []byte `serialize:"true"`
}
// UserDB describes the full content of a user
type UserDB struct {
User `serialize:"true"`
Data []KeyValuePair `serialize:"true"`
}
// Keystore is the RPC interface for keystore management
type Keystore struct {
lock sync.Mutex
log logging.Logger
codec codec.Codec
// Key: username
// Value: The user with that name
users map[string]*User
// Used to persist users and their data
userDB database.Database
bcDB database.Database
// BaseDB
// / \
// UserDB BlockchainDB
// / | \
// Usr Usr Usr
// / | \
// BID BID BID
}
// Initialize the keystore
func (ks *Keystore) Initialize(log logging.Logger, db database.Database) {
ks.log = log
ks.codec = codec.NewDefault()
ks.users = make(map[string]*User)
ks.userDB = prefixdb.New([]byte("users"), db)
ks.bcDB = prefixdb.New([]byte("bcs"), db)
}
// CreateHandler returns a new service object that can send requests to thisAPI.
func (ks *Keystore) CreateHandler() *common.HTTPHandler {
newServer := rpc.NewServer()
codec := jsoncodec.NewCodec()
newServer.RegisterCodec(codec, "application/json")
newServer.RegisterCodec(codec, "application/json;charset=UTF-8")
newServer.RegisterService(ks, "keystore")
return &common.HTTPHandler{LockOptions: common.NoLock, Handler: newServer}
}
// Get the user whose name is [username]
func (ks *Keystore) getUser(username string) (*User, error) {
// If the user is already in memory, return it
usr, exists := ks.users[username]
if exists {
return usr, nil
}
// The user is not in memory; try the database
usrBytes, err := ks.userDB.Get([]byte(username))
if err != nil { // Most likely bc user doesn't exist in database
return nil, err
}
usr = &User{}
return usr, ks.codec.Unmarshal(usrBytes, usr)
}
// CreateUserArgs are arguments for passing into CreateUser requests
type CreateUserArgs struct {
Username string `json:"username"`
Password string `json:"password"`
}
// CreateUserReply is the response from calling CreateUser
type CreateUserReply struct {
Success bool `json:"success"`
}
// CreateUser creates an empty user with the provided username and password
func (ks *Keystore) CreateUser(_ *http.Request, args *CreateUserArgs, reply *CreateUserReply) error {
ks.lock.Lock()
defer ks.lock.Unlock()
ks.log.Verbo("CreateUser called with %.*s", maxUserPassLen, args.Username)
if len(args.Username) > maxUserPassLen || len(args.Password) > maxUserPassLen {
return errUserPassMaxLength
}
if args.Username == "" {
return errEmptyUsername
}
if usr, err := ks.getUser(args.Username); err == nil || usr != nil {
return fmt.Errorf("user already exists: %s", args.Username)
}
if zxcvbn.PasswordStrength(args.Password, nil).Score < requiredPassScore {
return errWeakPassword
}
usr := &User{}
if err := usr.Initialize(args.Password); err != nil {
return err
}
usrBytes, err := ks.codec.Marshal(usr)
if err != nil {
return err
}
if err := ks.userDB.Put([]byte(args.Username), usrBytes); err != nil {
return err
}
ks.users[args.Username] = usr
reply.Success = true
return nil
}
// ListUsersArgs are the arguments to ListUsers
type ListUsersArgs struct{}
// ListUsersReply is the reply from ListUsers
type ListUsersReply struct {
Users []string `json:"users"`
}
// ListUsers lists all the registered usernames
func (ks *Keystore) ListUsers(_ *http.Request, args *ListUsersArgs, reply *ListUsersReply) error {
ks.lock.Lock()
defer ks.lock.Unlock()
ks.log.Verbo("ListUsers called")
reply.Users = []string{}
it := ks.userDB.NewIterator()
defer it.Release()
for it.Next() {
reply.Users = append(reply.Users, string(it.Key()))
}
return it.Error()
}
// ExportUserArgs are the arguments to ExportUser
type ExportUserArgs struct {
Username string `json:"username"`
Password string `json:"password"`
}
// ExportUserReply is the reply from ExportUser
type ExportUserReply struct {
User formatting.CB58 `json:"user"`
}
// ExportUser exports a serialized encoding of a user's information complete with encrypted database values
func (ks *Keystore) ExportUser(_ *http.Request, args *ExportUserArgs, reply *ExportUserReply) error {
ks.lock.Lock()
defer ks.lock.Unlock()
ks.log.Verbo("ExportUser called for %s", args.Username)
usr, err := ks.getUser(args.Username)
if err != nil {
return err
}
if !usr.CheckPassword(args.Password) {
return fmt.Errorf("incorrect password for user %q", args.Username)
}
userDB := prefixdb.New([]byte(args.Username), ks.bcDB)
userData := UserDB{
User: *usr,
}
it := userDB.NewIterator()
defer it.Release()
for it.Next() {
userData.Data = append(userData.Data, KeyValuePair{
Key: it.Key(),
Value: it.Value(),
})
}
if err := it.Error(); err != nil {
return err
}
b, err := ks.codec.Marshal(&userData)
if err != nil {
return err
}
reply.User.Bytes = b
return nil
}
// ImportUserArgs are arguments for ImportUser
type ImportUserArgs struct {
Username string `json:"username"`
Password string `json:"password"`
User formatting.CB58 `json:"user"`
}
// ImportUserReply is the response for ImportUser
type ImportUserReply struct {
Success bool `json:"success"`
}
// ImportUser imports a serialized encoding of a user's information complete with encrypted database values, integrity checks the password, and adds it to the database
func (ks *Keystore) ImportUser(r *http.Request, args *ImportUserArgs, reply *ImportUserReply) error {
ks.lock.Lock()
defer ks.lock.Unlock()
ks.log.Verbo("ImportUser called for %s", args.Username)
if usr, err := ks.getUser(args.Username); err == nil || usr != nil {
return fmt.Errorf("user already exists: %s", args.Username)
}
userData := UserDB{}
if err := ks.codec.Unmarshal(args.User.Bytes, &userData); err != nil {
return err
}
if !userData.User.CheckPassword(args.Password) {
return fmt.Errorf("incorrect password for user %q", args.Username)
}
usrBytes, err := ks.codec.Marshal(&userData.User)
if err != nil {
return err
}
userBatch := ks.userDB.NewBatch()
if err := userBatch.Put([]byte(args.Username), usrBytes); err != nil {
return err
}
userDataDB := prefixdb.New([]byte(args.Username), ks.bcDB)
dataBatch := userDataDB.NewBatch()
for _, kvp := range userData.Data {
dataBatch.Put(kvp.Key, kvp.Value)
}
if err := atomic.WriteAll(dataBatch, userBatch); err != nil {
return err
}
ks.users[args.Username] = &userData.User
reply.Success = true
return nil
}
// DeleteUserArgs are arguments for passing into DeleteUser requests
type DeleteUserArgs struct {
Username string `json:"username"`
Password string `json:"password"`
}
// DeleteUserReply is the response from calling DeleteUser
type DeleteUserReply struct {
Success bool `json:"success"`
}
// DeleteUser deletes user with the provided username and password.
func (ks *Keystore) DeleteUser(_ *http.Request, args *DeleteUserArgs, reply *DeleteUserReply) error {
ks.lock.Lock()
defer ks.lock.Unlock()
ks.log.Verbo("DeleteUser called with %s", args.Username)
if args.Username == "" {
return errEmptyUsername
}
// check if user exists and valid user.
usr, err := ks.getUser(args.Username)
switch {
case err != nil || usr == nil:
return fmt.Errorf("user doesn't exist: %s", args.Username)
case !usr.CheckPassword(args.Password):
return fmt.Errorf("incorrect password for user %q", args.Username)
}
userNameBytes := []byte(args.Username)
userBatch := ks.userDB.NewBatch()
if err := userBatch.Delete(userNameBytes); err != nil {
return err
}
userDataDB := prefixdb.New(userNameBytes, ks.bcDB)
dataBatch := userDataDB.NewBatch()
it := userDataDB.NewIterator()
defer it.Release()
for it.Next() {
if err = dataBatch.Delete(it.Key()); err != nil {
return err
}
}
if err = it.Error(); err != nil {
return err
}
if err := atomic.WriteAll(dataBatch, userBatch); err != nil {
return err
}
// delete from users map.
delete(ks.users, args.Username)
reply.Success = true
return nil
}
// NewBlockchainKeyStore ...
func (ks *Keystore) NewBlockchainKeyStore(blockchainID ids.ID) *BlockchainKeystore {
return &BlockchainKeystore{
blockchainID: blockchainID,
ks: ks,
}
}
// GetDatabase ...
func (ks *Keystore) GetDatabase(bID ids.ID, username, password string) (database.Database, error) {
ks.lock.Lock()
defer ks.lock.Unlock()
usr, err := ks.getUser(username)
if err != nil {
return nil, err
}
if !usr.CheckPassword(password) {
return nil, fmt.Errorf("incorrect password for user %q", username)
}
userDB := prefixdb.New([]byte(username), ks.bcDB)
bcDB := prefixdb.NewNested(bID.Bytes(), userDB)
encDB, err := encdb.New([]byte(password), bcDB)
if err != nil {
return nil, err
}
return encDB, nil
}