-
Notifications
You must be signed in to change notification settings - Fork 658
/
secp256k1r.go
300 lines (247 loc) · 7.88 KB
/
secp256k1r.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
// Copyright (C) 2019-2022, Ava Labs, Inc. All rights reserved.
// See the file LICENSE for licensing terms.
package crypto
import (
"bytes"
"errors"
"fmt"
"sort"
"strings"
stdecdsa "crypto/ecdsa"
"github.com/decred/dcrd/dcrec/secp256k1/v3/ecdsa"
secp256k1 "github.com/decred/dcrd/dcrec/secp256k1/v3"
"github.com/ava-labs/avalanchego/cache"
"github.com/ava-labs/avalanchego/ids"
"github.com/ava-labs/avalanchego/utils"
"github.com/ava-labs/avalanchego/utils/cb58"
"github.com/ava-labs/avalanchego/utils/hashing"
)
const (
// SECP256K1RSigLen is the number of bytes in a secp2561k recoverable
// signature
SECP256K1RSigLen = 65
// SECP256K1RSKLen is the number of bytes in a secp2561k recoverable private
// key
SECP256K1RSKLen = 32
// SECP256K1RPKLen is the number of bytes in a secp2561k recoverable public
// key
SECP256K1RPKLen = 33
// from the decred library:
// compactSigMagicOffset is a value used when creating the compact signature
// recovery code inherited from Bitcoin and has no meaning, but has been
// retained for compatibility. For historical purposes, it was originally
// picked to avoid a binary representation that would allow compact
// signatures to be mistaken for other components.
compactSigMagicOffset = 27
PrivateKeyPrefix = "PrivateKey-"
nullStr = "null"
)
var (
errCompressed = errors.New("wasn't expecting a compressed key")
errMissingQuotes = errors.New("first and last characters should be quotes")
errMissingKeyPrefix = fmt.Errorf("private key missing %s prefix", PrivateKeyPrefix)
errInvalidPrivateKeyLength = fmt.Errorf("private key has unexpected length, expected %d", SECP256K1RSKLen)
_ RecoverableFactory = &FactorySECP256K1R{}
_ PublicKey = &PublicKeySECP256K1R{}
_ PrivateKey = &PrivateKeySECP256K1R{}
)
type FactorySECP256K1R struct{ Cache cache.LRU }
func (*FactorySECP256K1R) NewPrivateKey() (PrivateKey, error) {
k, err := secp256k1.GeneratePrivateKey()
return &PrivateKeySECP256K1R{sk: k}, err
}
func (*FactorySECP256K1R) ToPublicKey(b []byte) (PublicKey, error) {
key, err := secp256k1.ParsePubKey(b)
return &PublicKeySECP256K1R{
pk: key,
bytes: b,
}, err
}
func (*FactorySECP256K1R) ToPrivateKey(b []byte) (PrivateKey, error) {
if len(b) != SECP256K1RSKLen {
return nil, errInvalidPrivateKeyLength
}
return &PrivateKeySECP256K1R{
sk: secp256k1.PrivKeyFromBytes(b),
bytes: b,
}, nil
}
func (f *FactorySECP256K1R) RecoverPublicKey(msg, sig []byte) (PublicKey, error) {
return f.RecoverHashPublicKey(hashing.ComputeHash256(msg), sig)
}
func (f *FactorySECP256K1R) RecoverHashPublicKey(hash, sig []byte) (PublicKey, error) {
cacheBytes := make([]byte, len(hash)+len(sig))
copy(cacheBytes, hash)
copy(cacheBytes[len(hash):], sig)
id := hashing.ComputeHash256Array(cacheBytes)
if cachedPublicKey, ok := f.Cache.Get(id); ok {
return cachedPublicKey.(*PublicKeySECP256K1R), nil
}
if err := verifySECP256K1RSignatureFormat(sig); err != nil {
return nil, err
}
sig, err := sigToRawSig(sig)
if err != nil {
return nil, err
}
rawPubkey, compressed, err := ecdsa.RecoverCompact(sig, hash)
if err != nil {
return nil, err
}
if compressed {
return nil, errCompressed
}
pubkey := &PublicKeySECP256K1R{pk: rawPubkey}
f.Cache.Put(id, pubkey)
return pubkey, nil
}
type PublicKeySECP256K1R struct {
pk *secp256k1.PublicKey
addr ids.ShortID
bytes []byte
}
func (k *PublicKeySECP256K1R) Verify(msg, sig []byte) bool {
return k.VerifyHash(hashing.ComputeHash256(msg), sig)
}
func (k *PublicKeySECP256K1R) VerifyHash(hash, sig []byte) bool {
factory := FactorySECP256K1R{}
pk, err := factory.RecoverHashPublicKey(hash, sig)
if err != nil {
return false
}
return k.Address() == pk.Address()
}
// ToECDSA returns the ecdsa representation of this public key
func (k *PublicKeySECP256K1R) ToECDSA() *stdecdsa.PublicKey {
return k.pk.ToECDSA()
}
func (k *PublicKeySECP256K1R) Address() ids.ShortID {
if k.addr == ids.ShortEmpty {
addr, err := ids.ToShortID(hashing.PubkeyBytesToAddress(k.Bytes()))
if err != nil {
panic(err)
}
k.addr = addr
}
return k.addr
}
func (k *PublicKeySECP256K1R) Bytes() []byte {
if k.bytes == nil {
k.bytes = k.pk.SerializeCompressed()
}
return k.bytes
}
type PrivateKeySECP256K1R struct {
sk *secp256k1.PrivateKey
pk *PublicKeySECP256K1R
bytes []byte
}
func (k *PrivateKeySECP256K1R) PublicKey() PublicKey {
if k.pk == nil {
k.pk = &PublicKeySECP256K1R{pk: k.sk.PubKey()}
}
return k.pk
}
func (k *PrivateKeySECP256K1R) Sign(msg []byte) ([]byte, error) {
return k.SignHash(hashing.ComputeHash256(msg))
}
func (k *PrivateKeySECP256K1R) SignHash(hash []byte) ([]byte, error) {
sig := ecdsa.SignCompact(k.sk, hash, false) // returns [v || r || s]
return rawSigToSig(sig)
}
// ToECDSA returns the ecdsa representation of this private key
func (k *PrivateKeySECP256K1R) ToECDSA() *stdecdsa.PrivateKey {
return k.sk.ToECDSA()
}
func (k *PrivateKeySECP256K1R) Bytes() []byte {
if k.bytes == nil {
k.bytes = k.sk.Serialize()
}
return k.bytes
}
func (k *PrivateKeySECP256K1R) String() string {
// We assume that the maximum size of a byte slice that
// can be stringified is at least the length of a SECP256K1 private key
keyStr, _ := cb58.Encode(k.Bytes())
return PrivateKeyPrefix + keyStr
}
func (k *PrivateKeySECP256K1R) MarshalJSON() ([]byte, error) {
return []byte("\"" + k.String() + "\""), nil
}
func (k *PrivateKeySECP256K1R) MarshalText() ([]byte, error) {
return []byte(k.String()), nil
}
func (k *PrivateKeySECP256K1R) UnmarshalJSON(b []byte) error {
str := string(b)
if str == nullStr { // If "null", do nothing
return nil
} else if len(str) < 2 {
return errMissingQuotes
}
lastIndex := len(str) - 1
if str[0] != '"' || str[lastIndex] != '"' {
return errMissingQuotes
}
strNoQuotes := str[1:lastIndex]
if !strings.HasPrefix(strNoQuotes, PrivateKeyPrefix) {
return errMissingKeyPrefix
}
strNoPrefix := strNoQuotes[len(PrivateKeyPrefix):]
keyBytes, err := cb58.Decode(strNoPrefix)
if err != nil {
return err
}
if len(keyBytes) != SECP256K1RSKLen {
return errInvalidPrivateKeyLength
}
*k = PrivateKeySECP256K1R{
sk: secp256k1.PrivKeyFromBytes(keyBytes),
bytes: keyBytes,
}
return nil
}
func (k *PrivateKeySECP256K1R) UnmarshalText(text []byte) error {
return k.UnmarshalJSON(text)
}
// raw sig has format [v || r || s] whereas the sig has format [r || s || v]
func rawSigToSig(sig []byte) ([]byte, error) {
if len(sig) != SECP256K1RSigLen {
return nil, errInvalidSigLen
}
recCode := sig[0]
copy(sig, sig[1:])
sig[SECP256K1RSigLen-1] = recCode - compactSigMagicOffset
return sig, nil
}
// sig has format [r || s || v] whereas the raw sig has format [v || r || s]
func sigToRawSig(sig []byte) ([]byte, error) {
if len(sig) != SECP256K1RSigLen {
return nil, errInvalidSigLen
}
newSig := make([]byte, SECP256K1RSigLen)
newSig[0] = sig[SECP256K1RSigLen-1] + compactSigMagicOffset
copy(newSig[1:], sig)
return newSig, nil
}
// verifies the signature format in format [r || s || v]
func verifySECP256K1RSignatureFormat(sig []byte) error {
if len(sig) != SECP256K1RSigLen {
return errInvalidSigLen
}
var s secp256k1.ModNScalar
s.SetByteSlice(sig[32:64])
if s.IsOverHalfOrder() {
return errMutatedSig
}
return nil
}
type innerSortSECP2561RSigs [][SECP256K1RSigLen]byte
func (lst innerSortSECP2561RSigs) Less(i, j int) bool { return bytes.Compare(lst[i][:], lst[j][:]) < 0 }
func (lst innerSortSECP2561RSigs) Len() int { return len(lst) }
func (lst innerSortSECP2561RSigs) Swap(i, j int) { lst[j], lst[i] = lst[i], lst[j] }
// SortSECP2561RSigs sorts a slice of SECP2561R signatures
func SortSECP2561RSigs(lst [][SECP256K1RSigLen]byte) { sort.Sort(innerSortSECP2561RSigs(lst)) }
// IsSortedAndUniqueSECP2561RSigs returns true if [sigs] is sorted
func IsSortedAndUniqueSECP2561RSigs(sigs [][SECP256K1RSigLen]byte) bool {
return utils.IsSortedAndUnique(innerSortSECP2561RSigs(sigs))
}