/
key.go
189 lines (166 loc) · 5.01 KB
/
key.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
// Copyright 2014 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// Modified by Prysmatic Labs 2018
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
package keystore
import (
"encoding/hex"
"encoding/json"
"io/ioutil"
"os"
"path/filepath"
"github.com/pborman/uuid"
"github.com/prysmaticlabs/prysm/crypto/bls"
"github.com/prysmaticlabs/prysm/io/file"
)
const (
keyHeaderKDF = "scrypt"
// LightScryptN is the N parameter of Scrypt encryption algorithm, using 4MB
// memory and taking approximately 100ms CPU time on a modern processor.
LightScryptN = 1 << 12
// LightScryptP is the P parameter of Scrypt encryption algorithm, using 4MB
// memory and taking approximately 100ms CPU time on a modern processor.
LightScryptP = 6
scryptR = 8
scryptDKLen = 32
)
// Key is the object that stores all the user data related to their public/secret keys.
type Key struct {
ID uuid.UUID // Version 4 "random" for unique id not derived from key data
PublicKey bls.PublicKey // Represents the public key of the user.
SecretKey bls.SecretKey // Represents the private key of the user.
}
type keyStore interface {
// GetKey loads and decrypts the key from disk.
GetKey(filename string, password string) (*Key, error)
// StoreKey writes and encrypts the key.
StoreKey(filename string, k *Key, auth string) error
// JoinPath joins filename with the key directory unless it is already absolute.
JoinPath(filename string) string
}
type plainKeyJSON struct {
PublicKey string `json:"address"`
SecretKey string `json:"privatekey"`
ID string `json:"id"`
}
type encryptedKeyJSON struct {
PublicKey string `json:"publickey"`
Crypto cryptoJSON `json:"crypto"`
ID string `json:"id"`
}
type cryptoJSON struct {
Cipher string `json:"cipher"`
CipherText string `json:"ciphertext"`
CipherParams cipherparamsJSON `json:"cipherparams"`
KDF string `json:"kdf"`
KDFParams map[string]interface{} `json:"kdfparams"`
MAC string `json:"mac"`
}
type cipherparamsJSON struct {
IV string `json:"iv"`
}
// MarshalJSON marshals a key struct into a JSON blob.
func (k *Key) MarshalJSON() (j []byte, err error) {
jStruct := plainKeyJSON{
hex.EncodeToString(k.PublicKey.Marshal()),
hex.EncodeToString(k.SecretKey.Marshal()),
k.ID.String(),
}
j, err = json.Marshal(jStruct)
return j, err
}
// UnmarshalJSON unmarshals a blob into a key struct.
func (k *Key) UnmarshalJSON(j []byte) (err error) {
keyJSON := new(plainKeyJSON)
err = json.Unmarshal(j, &keyJSON)
if err != nil {
return err
}
u := new(uuid.UUID)
*u = uuid.Parse(keyJSON.ID)
k.ID = *u
pubkey, err := hex.DecodeString(keyJSON.PublicKey)
if err != nil {
return err
}
seckey, err := hex.DecodeString(keyJSON.SecretKey)
if err != nil {
return err
}
k.PublicKey, err = bls.PublicKeyFromBytes(pubkey)
if err != nil {
return err
}
k.SecretKey, err = bls.SecretKeyFromBytes(seckey)
if err != nil {
return err
}
return nil
}
// NewKeyFromBLS creates a new keystore Key type using a BLS private key.
func NewKeyFromBLS(blsKey bls.SecretKey) (*Key, error) {
id := uuid.NewRandom()
pubkey := blsKey.PublicKey()
key := &Key{
ID: id,
PublicKey: pubkey,
SecretKey: blsKey,
}
return key, nil
}
// NewKey generates a new random key.
func NewKey() (*Key, error) {
secretKey, err := bls.RandKey()
if err != nil {
return nil, err
}
return NewKeyFromBLS(secretKey)
}
func storeNewRandomKey(ks keyStore, password string) error {
key, err := NewKey()
if err != nil {
return err
}
return ks.StoreKey(ks.JoinPath(keyFileName(key.PublicKey)), key, password)
}
func writeKeyFile(fname string, content []byte) error {
// Create the keystore directory with appropriate permissions
// in case it is not present yet.
if err := file.MkdirAll(filepath.Dir(fname)); err != nil {
return err
}
// Atomic write: create a temporary hidden file first
// then move it into place. TempFile assigns mode 0600.
f, err := ioutil.TempFile(filepath.Dir(fname), "."+filepath.Base(fname)+".tmp")
if err != nil {
return err
}
if _, err := f.Write(content); err != nil {
newErr := f.Close()
if newErr != nil {
err = newErr
}
newErr = os.Remove(f.Name())
if newErr != nil {
err = newErr
}
return err
}
if err := f.Close(); err != nil {
return err
}
return os.Rename(f.Name(), fname)
}