forked from alloy-rs/alloy
-
Notifications
You must be signed in to change notification settings - Fork 0
/
private_key.rs
382 lines (331 loc) · 13.6 KB
/
private_key.rs
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
//! [`k256`] wallet implementation.
use super::{Wallet, WalletError};
use linera_alloy_primitives::{hex, B256};
use linera_alloy_signer::utils::secret_key_to_address;
use k256::{
ecdsa::{self, SigningKey},
FieldBytes, NonZeroScalar, SecretKey as K256SecretKey,
};
use rand::{CryptoRng, Rng};
use std::str::FromStr;
#[cfg(feature = "keystore")]
use std::path::Path;
impl Wallet<SigningKey> {
/// Creates a new Wallet instance from a [`SigningKey`].
///
/// This can also be used to create a Wallet from a [`SecretKey`](K256SecretKey).
/// See also the `From` implementations.
#[doc(alias = "from_private_key")]
#[doc(alias = "new_private_key")]
#[doc(alias = "new_pk")]
#[inline]
pub fn from_signing_key(signer: SigningKey) -> Self {
let address = secret_key_to_address(&signer);
Self::new_with_signer(signer, address, None)
}
/// Creates a new Wallet instance from a raw scalar serialized as a [`B256`] byte array.
///
/// This is identical to [`from_field_bytes`](Self::from_field_bytes).
#[inline]
pub fn from_bytes(bytes: &B256) -> Result<Self, ecdsa::Error> {
Self::from_field_bytes((&bytes.0).into())
}
/// Creates a new Wallet instance from a raw scalar serialized as a [`FieldBytes`] byte array.
#[inline]
pub fn from_field_bytes(bytes: &FieldBytes) -> Result<Self, ecdsa::Error> {
SigningKey::from_bytes(bytes).map(Self::from_signing_key)
}
/// Creates a new Wallet instance from a raw scalar serialized as a byte slice.
///
/// Byte slices shorter than the field size (32 bytes) are handled by zero padding the input.
#[inline]
pub fn from_slice(bytes: &[u8]) -> Result<Self, ecdsa::Error> {
SigningKey::from_slice(bytes).map(Self::from_signing_key)
}
/// Creates a new random keypair seeded with [`rand::thread_rng()`].
#[inline]
pub fn random() -> Self {
Self::random_with(&mut rand::thread_rng())
}
/// Creates a new random keypair seeded with the provided RNG.
#[inline]
pub fn random_with<R: Rng + CryptoRng>(rng: &mut R) -> Self {
Self::from_signing_key(SigningKey::random(rng))
}
/// Borrow the secret [`NonZeroScalar`] value for this key.
///
/// # ⚠️ Warning
///
/// This value is key material.
///
/// Please treat it with the care it deserves!
#[inline]
pub fn as_nonzero_scalar(&self) -> &NonZeroScalar {
self.signer.as_nonzero_scalar()
}
/// Serialize this [`Wallet`]'s [`SigningKey`] as a [`B256`] byte array.
#[inline]
pub fn to_bytes(&self) -> B256 {
B256::new(<[u8; 32]>::from(self.to_field_bytes()))
}
/// Serialize this [`Wallet`]'s [`SigningKey`] as a [`FieldBytes`] byte array.
#[inline]
pub fn to_field_bytes(&self) -> FieldBytes {
self.signer.to_bytes()
}
}
#[cfg(feature = "keystore")]
impl Wallet<SigningKey> {
/// Creates a new random encrypted JSON with the provided password and stores it in the
/// provided directory. Returns a tuple (Wallet, String) of the wallet instance for the
/// keystore with its random UUID. Accepts an optional name for the keystore file. If `None`,
/// the keystore is stored as the stringified UUID.
#[inline]
pub fn new_keystore<P, R, S>(
dir: P,
rng: &mut R,
password: S,
name: Option<&str>,
) -> Result<(Self, String), WalletError>
where
P: AsRef<Path>,
R: Rng + CryptoRng,
S: AsRef<[u8]>,
{
let (secret, uuid) = eth_keystore::new(dir, rng, password, name)?;
Ok((Self::from_slice(&secret)?, uuid))
}
/// Decrypts an encrypted JSON from the provided path to construct a Wallet instance
#[inline]
pub fn decrypt_keystore<P, S>(keypath: P, password: S) -> Result<Self, WalletError>
where
P: AsRef<Path>,
S: AsRef<[u8]>,
{
let secret = eth_keystore::decrypt_key(keypath, password)?;
Ok(Self::from_slice(&secret)?)
}
/// Creates a new encrypted JSON with the provided private key and password and stores it in the
/// provided directory. Returns a tuple (Wallet, String) of the wallet instance for the
/// keystore with its random UUID. Accepts an optional name for the keystore file. If `None`,
/// the keystore is stored as the stringified UUID.
#[inline]
pub fn encrypt_keystore<P, R, B, S>(
keypath: P,
rng: &mut R,
pk: B,
password: S,
name: Option<&str>,
) -> Result<(Self, String), WalletError>
where
P: AsRef<Path>,
R: Rng + CryptoRng,
B: AsRef<[u8]>,
S: AsRef<[u8]>,
{
let pk = pk.as_ref();
let uuid = eth_keystore::encrypt_key(keypath, rng, pk, password, name)?;
Ok((Self::from_slice(pk)?, uuid))
}
}
impl PartialEq for Wallet<SigningKey> {
fn eq(&self, other: &Self) -> bool {
self.signer.to_bytes().eq(&other.signer.to_bytes())
&& self.address == other.address
&& self.chain_id == other.chain_id
}
}
impl From<SigningKey> for Wallet<SigningKey> {
fn from(value: SigningKey) -> Self {
Self::from_signing_key(value)
}
}
impl From<K256SecretKey> for Wallet<SigningKey> {
fn from(value: K256SecretKey) -> Self {
Self::from_signing_key(value.into())
}
}
impl FromStr for Wallet<SigningKey> {
type Err = WalletError;
fn from_str(src: &str) -> Result<Self, Self::Err> {
let array = hex::decode_to_array::<_, 32>(src)?;
Ok(Self::from_slice(&array)?)
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::{LocalWallet, SignerSync};
use linera_alloy_primitives::{address, b256};
#[cfg(feature = "keystore")]
use tempfile::tempdir;
#[test]
fn parse_pk() {
let s = "6f142508b4eea641e33cb2a0161221105086a84584c74245ca463a49effea30b";
let _pk: Wallet<SigningKey> = s.parse().unwrap();
}
#[test]
fn parse_short_key() {
let s = "6f142508b4eea641e33cb2a0161221105086a84584c74245ca463a49effea3";
assert!(s.len() < 64);
let pk = s.parse::<LocalWallet>().unwrap_err();
match pk {
WalletError::HexError(hex::FromHexError::InvalidStringLength) => {}
_ => panic!("Unexpected error"),
}
}
#[cfg(feature = "keystore")]
fn test_encrypted_json_keystore(key: Wallet<SigningKey>, uuid: &str, dir: &Path) {
// sign a message using the given key
let message = "Some data";
let signature = key.sign_message_sync(message.as_bytes()).unwrap();
// read from the encrypted JSON keystore and decrypt it, while validating that the
// signatures produced by both the keys should match
let path = Path::new(dir).join(uuid);
let key2 = Wallet::<SigningKey>::decrypt_keystore(path.clone(), "randpsswd").unwrap();
let signature2 = key2.sign_message_sync(message.as_bytes()).unwrap();
assert_eq!(signature, signature2);
std::fs::remove_file(&path).unwrap();
}
#[test]
#[cfg(feature = "keystore")]
fn encrypted_json_keystore_new() {
// create and store an encrypted JSON keystore in this directory
let dir = tempdir().unwrap();
let mut rng = rand::thread_rng();
let (key, uuid) =
Wallet::<SigningKey>::new_keystore(&dir, &mut rng, "randpsswd", None).unwrap();
test_encrypted_json_keystore(key, &uuid, dir.path());
}
#[test]
#[cfg(feature = "keystore")]
fn encrypted_json_keystore_from_pk() {
// create and store an encrypted JSON keystore in this directory
let dir = tempdir().unwrap();
let mut rng = rand::thread_rng();
let private_key =
hex::decode("6f142508b4eea641e33cb2a0161221105086a84584c74245ca463a49effea30b")
.unwrap();
let (key, uuid) =
Wallet::<SigningKey>::encrypt_keystore(&dir, &mut rng, private_key, "randpsswd", None)
.unwrap();
test_encrypted_json_keystore(key, &uuid, dir.path());
}
#[test]
fn signs_msg() {
let message = "Some data";
let hash = linera_alloy_primitives::utils::eip191_hash_message(message);
let key = Wallet::<SigningKey>::random_with(&mut rand::thread_rng());
let address = key.address;
// sign a message
let signature = key.sign_message_sync(message.as_bytes()).unwrap();
// ecrecover via the message will hash internally
let recovered = signature.recover_address_from_msg(message).unwrap();
assert_eq!(recovered, address);
// if provided with a hash, it will skip hashing
let recovered2 = signature.recover_address_from_prehash(&hash).unwrap();
assert_eq!(recovered2, address);
}
#[test]
#[cfg(feature = "eip712")]
fn typed_data() {
use linera_alloy_dyn_abi::eip712::TypedData;
use linera_alloy_primitives::{keccak256, Address, I256, U256};
use linera_alloy_sol_types::{eip712_domain, sol, SolStruct};
use serde::Serialize;
sol! {
#[derive(Debug, Serialize)]
struct FooBar {
int256 foo;
uint256 bar;
bytes fizz;
bytes32 buzz;
string far;
address out;
}
}
let domain = eip712_domain! {
name: "Eip712Test",
version: "1",
chain_id: 1,
verifying_contract: address!("0000000000000000000000000000000000000001"),
salt: keccak256("eip712-test-75F0CCte"),
};
let foo_bar = FooBar {
foo: I256::try_from(10u64).unwrap(),
bar: U256::from(20u64),
fizz: b"fizz".to_vec().into(),
buzz: keccak256("buzz"),
far: "space".into(),
out: Address::ZERO,
};
let wallet = Wallet::random();
let hash = foo_bar.eip712_signing_hash(&domain);
let sig = wallet.sign_typed_data_sync(&foo_bar, &domain).unwrap();
assert_eq!(sig.recover_address_from_prehash(&hash).unwrap(), wallet.address());
assert_eq!(wallet.sign_hash_sync(&hash).unwrap(), sig);
let foo_bar_dynamic = TypedData::from_struct(&foo_bar, Some(domain));
let dynamic_hash = foo_bar_dynamic.eip712_signing_hash().unwrap();
let sig_dynamic = wallet.sign_dynamic_typed_data_sync(&foo_bar_dynamic).unwrap();
assert_eq!(
sig_dynamic.recover_address_from_prehash(&dynamic_hash).unwrap(),
wallet.address()
);
assert_eq!(wallet.sign_hash_sync(&dynamic_hash).unwrap(), sig_dynamic);
}
#[test]
fn key_to_address() {
let wallet: Wallet<SigningKey> =
"0000000000000000000000000000000000000000000000000000000000000001".parse().unwrap();
assert_eq!(wallet.address, address!("7E5F4552091A69125d5DfCb7b8C2659029395Bdf"));
let wallet: Wallet<SigningKey> =
"0000000000000000000000000000000000000000000000000000000000000002".parse().unwrap();
assert_eq!(wallet.address, address!("2B5AD5c4795c026514f8317c7a215E218DcCD6cF"));
let wallet: Wallet<SigningKey> =
"0000000000000000000000000000000000000000000000000000000000000003".parse().unwrap();
assert_eq!(wallet.address, address!("6813Eb9362372EEF6200f3b1dbC3f819671cBA69"));
}
#[test]
fn conversions() {
let key = b256!("0000000000000000000000000000000000000000000000000000000000000001");
let wallet_b256: Wallet<SigningKey> = LocalWallet::from_bytes(&key).unwrap();
assert_eq!(wallet_b256.address, address!("7E5F4552091A69125d5DfCb7b8C2659029395Bdf"));
assert_eq!(wallet_b256.chain_id, None);
assert_eq!(wallet_b256.signer, SigningKey::from_bytes((&key.0).into()).unwrap());
let wallet_str =
Wallet::from_str("0000000000000000000000000000000000000000000000000000000000000001")
.unwrap();
assert_eq!(wallet_str.address, wallet_b256.address);
assert_eq!(wallet_str.chain_id, wallet_b256.chain_id);
assert_eq!(wallet_str.signer, wallet_b256.signer);
assert_eq!(wallet_str.to_bytes(), key);
assert_eq!(wallet_str.to_field_bytes(), key.0.into());
let wallet_slice = Wallet::from_slice(&key[..]).unwrap();
assert_eq!(wallet_slice.address, wallet_b256.address);
assert_eq!(wallet_slice.chain_id, wallet_b256.chain_id);
assert_eq!(wallet_slice.signer, wallet_b256.signer);
assert_eq!(wallet_slice.to_bytes(), key);
assert_eq!(wallet_slice.to_field_bytes(), key.0.into());
let wallet_field_bytes = Wallet::from_field_bytes((&key.0).into()).unwrap();
assert_eq!(wallet_field_bytes.address, wallet_b256.address);
assert_eq!(wallet_field_bytes.chain_id, wallet_b256.chain_id);
assert_eq!(wallet_field_bytes.signer, wallet_b256.signer);
assert_eq!(wallet_field_bytes.to_bytes(), key);
assert_eq!(wallet_field_bytes.to_field_bytes(), key.0.into());
}
#[test]
fn key_from_str() {
let wallet: Wallet<SigningKey> =
"0000000000000000000000000000000000000000000000000000000000000001".parse().unwrap();
// Check FromStr and `0x`
let wallet_0x: Wallet<SigningKey> =
"0x0000000000000000000000000000000000000000000000000000000000000001".parse().unwrap();
assert_eq!(wallet.address, wallet_0x.address);
assert_eq!(wallet.chain_id, wallet_0x.chain_id);
assert_eq!(wallet.signer, wallet_0x.signer);
// Must fail because of `0z`
"0z0000000000000000000000000000000000000000000000000000000000000001"
.parse::<Wallet<SigningKey>>()
.unwrap_err();
}
}