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
use std::fmt;
use cryptoxide::ed25519;
use cryptoxide::ed25519::signature_extended;
use cryptoxide::util::fixed_time_eq;
use std::hash::{Hash, Hasher};
use super::derivation::{self, DerivationError, DerivationIndex, DerivationScheme};
use super::hex;
use super::securemem;
use super::signature::Signature;
pub const XPRV_SIZE: usize = 96;
pub const XPUB_SIZE: usize = 64;
pub const PUBLIC_KEY_SIZE: usize = 32;
pub const CHAIN_CODE_SIZE: usize = 32;
#[derive(Debug, PartialEq, Eq)]
pub enum PrivateKeyError {
LengthInvalid(usize),
HighestBitsInvalid,
LowestBitsInvalid,
}
pub enum PublicKeyError {
LengthInvalid(usize),
}
pub struct XPrv([u8; XPRV_SIZE]);
impl XPrv {
pub fn normalize_bytes(mut bytes: [u8; XPRV_SIZE]) -> Self {
bytes[0] &= 0b1111_1000;
bytes[31] &= 0b0001_1111;
bytes[31] |= 0b0100_0000;;
Self::from_bytes(bytes)
}
pub(crate) fn from_bytes(bytes: [u8; XPRV_SIZE]) -> Self {
XPrv(bytes)
}
pub fn from_bytes_verified(bytes: [u8; XPRV_SIZE]) -> Result<Self, PrivateKeyError> {
let scalar = &bytes[0..32];
let last = scalar[31];
let first = scalar[0];
if (last & 0b1110_0000) != 0b0100_0000 {
return Err(PrivateKeyError::HighestBitsInvalid);
}
if (first & 0b0000_0111) != 0b0000_0000 {
return Err(PrivateKeyError::LowestBitsInvalid);
}
Ok(XPrv(bytes))
}
pub fn from_slice_verified(bytes: &[u8]) -> Result<Self, PrivateKeyError> {
if bytes.len() != XPRV_SIZE {
return Err(PrivateKeyError::LengthInvalid(bytes.len()));
}
let mut buf = [0u8; XPRV_SIZE];
buf[..].clone_from_slice(bytes);
XPrv::from_bytes_verified(buf)
}
fn from_slice(bytes: &[u8]) -> Result<Self, PrivateKeyError> {
if bytes.len() != XPRV_SIZE {
return Err(PrivateKeyError::LengthInvalid(bytes.len()));
}
let mut buf = [0u8; XPRV_SIZE];
buf[..].clone_from_slice(bytes);
Ok(XPrv::from_bytes(buf))
}
pub fn public(&self) -> XPub {
let pk = mk_public_key(&self.as_ref()[0..64]);
let mut out = [0u8; XPUB_SIZE];
out[0..32].clone_from_slice(&pk);
out[32..64].clone_from_slice(&self.as_ref()[64..]);
XPub::from_bytes(out)
}
pub fn sign<T>(&self, message: &[u8]) -> Signature<T> {
Signature::from_bytes(signature_extended(message, &self.as_ref()[0..64]))
}
pub fn verify<T>(&self, message: &[u8], signature: &Signature<T>) -> bool {
let xpub = self.public();
xpub.verify(message, signature)
}
pub fn derive(&self, scheme: DerivationScheme, index: DerivationIndex) -> Self {
derivation::private(self, index, scheme)
}
pub fn get_extended(&self, out: &mut [u8; 64]) {
out.clone_from_slice(&self.as_ref()[0..64])
}
}
impl PartialEq for XPrv {
fn eq(&self, rhs: &XPrv) -> bool {
fixed_time_eq(self.as_ref(), rhs.as_ref())
}
}
impl Eq for XPrv {}
impl Clone for XPrv {
fn clone(&self) -> Self {
Self::from_slice(self.as_ref()).expect("it is already a safely constructed XPrv")
}
}
impl fmt::Debug for XPrv {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{}", hex::encode(self.as_ref()))
}
}
impl fmt::Display for XPrv {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{}", hex::encode(self.as_ref()))
}
}
impl AsRef<[u8]> for XPrv {
fn as_ref(&self) -> &[u8] {
&self.0
}
}
impl From<XPrv> for [u8; XPRV_SIZE] {
fn from(v: XPrv) -> [u8; XPRV_SIZE] {
v.0
}
}
impl Drop for XPrv {
fn drop(&mut self) {
securemem::zero(&mut self.0);
}
}
#[derive(Clone, Copy)]
pub struct XPub([u8; XPUB_SIZE]);
impl XPub {
pub fn from_bytes(bytes: [u8; XPUB_SIZE]) -> Self {
XPub(bytes)
}
pub fn from_slice(bytes: &[u8]) -> Result<Self, PublicKeyError> {
if bytes.len() != XPUB_SIZE {
return Err(PublicKeyError::LengthInvalid(bytes.len()));
}
let mut buf = [0u8; XPUB_SIZE];
buf[..].clone_from_slice(bytes);
Ok(Self::from_bytes(buf))
}
pub fn verify<T>(&self, message: &[u8], signature: &Signature<T>) -> bool {
ed25519::verify(message, &self.as_ref()[0..32], signature.as_ref())
}
pub fn derive(
&self,
scheme: DerivationScheme,
index: DerivationIndex,
) -> Result<Self, DerivationError> {
derivation::public(self, index, scheme)
}
pub fn get_without_chaincode(&self, out: &mut [u8; 32]) {
out.clone_from_slice(&self.0[0..32])
}
}
impl PartialEq for XPub {
fn eq(&self, rhs: &XPub) -> bool {
fixed_time_eq(self.as_ref(), rhs.as_ref())
}
}
impl Eq for XPub {}
impl Hash for XPub {
fn hash<H: Hasher>(&self, state: &mut H) {
state.write(&self.0)
}
}
impl fmt::Display for XPub {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{}", hex::encode(self.as_ref()))
}
}
impl fmt::Debug for XPub {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{}", hex::encode(self.as_ref()))
}
}
impl AsRef<[u8]> for XPub {
fn as_ref(&self) -> &[u8] {
&self.0
}
}
impl From<XPub> for [u8; XPUB_SIZE] {
fn from(v: XPub) -> [u8; XPUB_SIZE] {
v.0
}
}
pub(crate) fn mk_xprv(out: &mut [u8; XPRV_SIZE], kl: &[u8], kr: &[u8], cc: &[u8]) {
assert!(kl.len() == 32);
assert!(kr.len() == 32);
assert!(cc.len() == CHAIN_CODE_SIZE);
out[0..32].clone_from_slice(kl);
out[32..64].clone_from_slice(kr);
out[64..96].clone_from_slice(cc);
}
pub(crate) fn mk_xpub(out: &mut [u8; XPUB_SIZE], pk: &[u8], cc: &[u8]) {
assert!(pk.len() == 32);
assert!(cc.len() == CHAIN_CODE_SIZE);
out[0..32].clone_from_slice(pk);
out[32..64].clone_from_slice(cc);
}
pub fn mk_public_key(extended_secret: &[u8]) -> [u8; PUBLIC_KEY_SIZE] {
assert!(extended_secret.len() == 64);
ed25519::to_public(extended_secret)
}