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
use anyhow::Result;
use once_cell::sync::OnceCell;
use serde::{Deserialize, Serialize};
use std::{convert::TryFrom, hash::Hash};
pub trait Validate: Sized {
type Unvalidated;
fn validate(unvalidated: &Self::Unvalidated) -> Result<Self>;
fn to_unvalidated(&self) -> Self::Unvalidated;
}
#[derive(Clone, Debug)]
pub struct Validatable<V: Validate> {
unvalidated: V::Unvalidated,
maybe_valid: OnceCell<V>,
}
impl<V: Validate> Validatable<V> {
pub fn new_valid(valid: V) -> Self {
let unvalidated = valid.to_unvalidated();
let maybe_valid = OnceCell::new();
maybe_valid.set(valid).unwrap_or_else(|_| unreachable!());
Self {
unvalidated,
maybe_valid,
}
}
pub fn new_unvalidated(unvalidated: V::Unvalidated) -> Self {
Self {
unvalidated,
maybe_valid: OnceCell::new(),
}
}
pub fn unvalidated(&self) -> &V::Unvalidated {
&self.unvalidated
}
pub fn valid(&self) -> Option<&V> {
self.validate().ok()
}
pub fn validate(&self) -> Result<&V> {
self.maybe_valid
.get_or_try_init(|| V::validate(&self.unvalidated))
}
}
impl<V> Serialize for Validatable<V>
where
V: Validate + Serialize,
V::Unvalidated: Serialize,
{
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
self.unvalidated.serialize(serializer)
}
}
impl<'de, V> Deserialize<'de> for Validatable<V>
where
V: Validate,
V::Unvalidated: Deserialize<'de>,
{
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
let unvalidated = <V::Unvalidated>::deserialize(deserializer)?;
Ok(Self::new_unvalidated(unvalidated))
}
}
impl<V> PartialEq for Validatable<V>
where
V: Validate,
V::Unvalidated: PartialEq,
{
fn eq(&self, other: &Self) -> bool {
self.unvalidated == other.unvalidated
}
}
impl<V> Eq for Validatable<V>
where
V: Validate,
V::Unvalidated: Eq,
{
}
impl<V> Hash for Validatable<V>
where
V: Validate,
V::Unvalidated: Hash,
{
fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
self.unvalidated.hash(state);
}
}
use crate::ed25519::{Ed25519PublicKey, ED25519_PUBLIC_KEY_LENGTH};
#[derive(Debug, Clone, Eq)]
pub struct UnvalidatedEd25519PublicKey([u8; ED25519_PUBLIC_KEY_LENGTH]);
impl UnvalidatedEd25519PublicKey {
pub fn to_bytes(&self) -> [u8; ED25519_PUBLIC_KEY_LENGTH] {
self.0
}
}
impl Serialize for UnvalidatedEd25519PublicKey {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
if serializer.is_human_readable() {
let encoded = ::hex::encode(&self.0);
serializer.serialize_str(&encoded)
} else {
serializer.serialize_newtype_struct(
"Ed25519PublicKey",
serde_bytes::Bytes::new(self.0.as_ref()),
)
}
}
}
impl<'de> Deserialize<'de> for UnvalidatedEd25519PublicKey {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
use serde::de::Error;
if deserializer.is_human_readable() {
let encoded_key = <String>::deserialize(deserializer)?;
let bytes_out = ::hex::decode(encoded_key).map_err(D::Error::custom)?;
<[u8; ED25519_PUBLIC_KEY_LENGTH]>::try_from(bytes_out.as_ref())
.map(UnvalidatedEd25519PublicKey)
.map_err(D::Error::custom)
} else {
#[derive(Deserialize)]
#[serde(rename = "Ed25519PublicKey")]
struct Value<'a>(&'a [u8]);
let value = Value::deserialize(deserializer)?;
<[u8; ED25519_PUBLIC_KEY_LENGTH]>::try_from(value.0)
.map(UnvalidatedEd25519PublicKey)
.map_err(D::Error::custom)
}
}
}
impl Hash for UnvalidatedEd25519PublicKey {
fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
state.write(&self.0)
}
}
impl PartialEq for UnvalidatedEd25519PublicKey {
fn eq(&self, other: &Self) -> bool {
self.0 == other.0
}
}
impl Validate for Ed25519PublicKey {
type Unvalidated = UnvalidatedEd25519PublicKey;
fn validate(unvalidated: &Self::Unvalidated) -> Result<Self> {
Self::try_from(unvalidated.0.as_ref()).map_err(Into::into)
}
fn to_unvalidated(&self) -> Self::Unvalidated {
UnvalidatedEd25519PublicKey(self.to_bytes())
}
}
#[cfg(test)]
mod test {
use crate::{
ed25519::{Ed25519PrivateKey, Ed25519PublicKey},
test_utils::uniform_keypair_strategy,
validatable::{UnvalidatedEd25519PublicKey, Validate},
};
use proptest::prelude::*;
use std::{
collections::hash_map::DefaultHasher,
hash::{Hash, Hasher},
};
proptest! {
#[test]
fn unvalidated_ed25519_public_key_equivalence(
keypair in uniform_keypair_strategy::<Ed25519PrivateKey, Ed25519PublicKey>()
) {
let valid = keypair.public_key;
let unvalidated = valid.to_unvalidated();
prop_assert_eq!(&unvalidated, &UnvalidatedEd25519PublicKey(valid.to_bytes()));
prop_assert_eq!(&valid, &Ed25519PublicKey::validate(&unvalidated).unwrap());
{
let serialized_valid = bcs::to_bytes(&valid).unwrap();
let serialized_unvalidated = bcs::to_bytes(&unvalidated).unwrap();
prop_assert_eq!(&serialized_valid, &serialized_unvalidated);
let deserialized_valid_from_unvalidated: Ed25519PublicKey = bcs::from_bytes(&serialized_unvalidated).unwrap();
let deserialized_unvalidated_from_valid: UnvalidatedEd25519PublicKey = bcs::from_bytes(&serialized_valid).unwrap();
prop_assert_eq!(&valid, &deserialized_valid_from_unvalidated);
prop_assert_eq!(&unvalidated, &deserialized_unvalidated_from_valid);
}
{
let serialized_valid = serde_json::to_string(&valid).unwrap();
let serialized_unvalidated = serde_json::to_string(&unvalidated).unwrap();
prop_assert_eq!(&serialized_valid, &serialized_unvalidated);
let deserialized_valid_from_unvalidated: Ed25519PublicKey = serde_json::from_str(&serialized_unvalidated).unwrap();
let deserialized_unvalidated_from_valid: UnvalidatedEd25519PublicKey = serde_json::from_str(&serialized_valid).unwrap();
prop_assert_eq!(&valid, &deserialized_valid_from_unvalidated);
prop_assert_eq!(&unvalidated, &deserialized_unvalidated_from_valid);
}
let valid_hash = {
let mut hasher = DefaultHasher::new();
valid.hash(&mut hasher);
hasher.finish()
};
let unvalidated_hash = {
let mut hasher = DefaultHasher::new();
unvalidated.hash(&mut hasher);
hasher.finish()
};
prop_assert_eq!(valid_hash, unvalidated_hash);
}
}
}