-
Notifications
You must be signed in to change notification settings - Fork 661
/
user.go
195 lines (166 loc) · 5.13 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
// Copyright (C) 2019-2021, Ava Labs, Inc. All rights reserved.
// See the file LICENSE for licensing terms.
package keystore
import (
"fmt"
"io"
"github.com/ava-labs/avalanchego/api/keystore"
"github.com/ava-labs/avalanchego/database"
"github.com/ava-labs/avalanchego/database/encdb"
"github.com/ava-labs/avalanchego/ids"
"github.com/ava-labs/avalanchego/utils/crypto"
"github.com/ava-labs/avalanchego/vms/secp256k1fx"
)
// Max number of addresses allowed for a single keystore user
const maxKeystoreAddresses = 5000
var (
// Key in the database whose corresponding value is the list of addresses
// this user controls
addressesKey = ids.Empty[:]
errMaxAddresses = fmt.Errorf("keystore user has reached its limit of %d addresses", maxKeystoreAddresses)
_ User = &user{}
)
type User interface {
io.Closer
// Get the addresses controlled by this user
GetAddresses() ([]ids.ShortID, error)
// PutKeys persists [privKeys]
PutKeys(privKeys ...*crypto.PrivateKeySECP256K1R) error
// GetKey returns the private key that controls the given address
GetKey(address ids.ShortID) (*crypto.PrivateKeySECP256K1R, error)
}
type user struct {
factory crypto.FactorySECP256K1R
db *encdb.Database
}
// NewUserFromKeystore tracks a keystore user from the provided keystore
func NewUserFromKeystore(ks keystore.BlockchainKeystore, username, password string) (User, error) {
db, err := ks.GetDatabase(username, password)
if err != nil {
return nil, fmt.Errorf("problem retrieving user %q: %w", username, err)
}
return NewUserFromDB(db), nil
}
// NewUserFromDB tracks a keystore user from a database
func NewUserFromDB(db *encdb.Database) User {
return &user{db: db}
}
func (u *user) GetAddresses() ([]ids.ShortID, error) {
// Get user's addresses
addressBytes, err := u.db.Get(addressesKey)
if err == database.ErrNotFound {
// If user has no addresses, return empty list
return nil, nil
}
if err != nil {
return nil, err
}
var addresses []ids.ShortID
_, err = LegacyCodec.Unmarshal(addressBytes, &addresses)
return addresses, err
}
func (u *user) PutKeys(privKeys ...*crypto.PrivateKeySECP256K1R) error {
toStore := make([]*crypto.PrivateKeySECP256K1R, 0, len(privKeys))
for _, privKey := range privKeys {
address := privKey.PublicKey().Address() // address the privKey controls
hasAddress, err := u.db.Has(address.Bytes())
if err != nil {
return err
}
if !hasAddress {
toStore = append(toStore, privKey)
}
}
// there's nothing to store
if len(toStore) == 0 {
return nil
}
addresses, err := u.GetAddresses()
if err != nil {
return err
}
if len(toStore) > maxKeystoreAddresses || len(addresses) > maxKeystoreAddresses-len(toStore) {
return errMaxAddresses
}
for _, privKey := range toStore {
address := privKey.PublicKey().Address() // address the privKey controls
// Address --> private key
if err := u.db.Put(address.Bytes(), privKey.Bytes()); err != nil {
return err
}
addresses = append(addresses, address)
}
addressBytes, err := Codec.Marshal(CodecVersion, addresses)
if err != nil {
return err
}
return u.db.Put(addressesKey, addressBytes)
}
func (u *user) GetKey(address ids.ShortID) (*crypto.PrivateKeySECP256K1R, error) {
bytes, err := u.db.Get(address.Bytes())
if err != nil {
return nil, err
}
skIntf, err := u.factory.ToPrivateKey(bytes)
if err != nil {
return nil, err
}
sk, ok := skIntf.(*crypto.PrivateKeySECP256K1R)
if !ok {
return nil, fmt.Errorf("expected private key to be type *crypto.PrivateKeySECP256K1R but is type %T", skIntf)
}
return sk, nil
}
func (u *user) Close() error { return u.db.Close() }
// Create and store a new key that will be controlled by this user.
func NewKey(u User) (*crypto.PrivateKeySECP256K1R, error) {
keys, err := NewKeys(u, 1)
if err != nil {
return nil, err
}
return keys[0], nil
}
// Create and store [numKeys] new keys that will be controlled by this user.
func NewKeys(u User, numKeys int) ([]*crypto.PrivateKeySECP256K1R, error) {
factory := crypto.FactorySECP256K1R{}
keys := make([]*crypto.PrivateKeySECP256K1R, numKeys)
for i := range keys {
skIntf, err := factory.NewPrivateKey()
if err != nil {
return nil, err
}
sk, ok := skIntf.(*crypto.PrivateKeySECP256K1R)
if !ok {
return nil, fmt.Errorf("expected private key to be type *crypto.PrivateKeySECP256K1R but is type %T", skIntf)
}
keys[i] = sk
}
return keys, u.PutKeys(keys...)
}
// Keychain returns a new keychain from the [user].
// If [addresses] is non-empty it fetches only the keys in addresses. If a key
// is missing, it will be ignored.
// If [addresses] is empty, then it will create a keychain using every address
// in the provided [user].
func GetKeychain(u User, addresses ids.ShortSet) (*secp256k1fx.Keychain, error) {
addrsList := addresses.List()
if len(addrsList) == 0 {
var err error
addrsList, err = u.GetAddresses()
if err != nil {
return nil, err
}
}
kc := secp256k1fx.NewKeychain()
for _, addr := range addrsList {
sk, err := u.GetKey(addr)
if err == database.ErrNotFound {
continue
}
if err != nil {
return nil, fmt.Errorf("problem retrieving private key for address %s: %w", addr, err)
}
kc.Add(sk)
}
return kc, nil
}