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
use bytes::{Buf, BufMut};
use std::{convert::TryInto, str::FromStr};
use thiserror::Error;
#[derive(Hash, Eq, PartialEq, PartialOrd, Ord, Clone)]
pub struct Credential<const N: usize> {
inner: [u8; N],
}
impl<const N: usize> Credential<N> {
pub const SIZE: usize = N;
pub fn into_bytes(self) -> [u8; N] {
self.inner
}
pub fn from_bytes(bytes: [u8; N]) -> Self {
Self::from(bytes)
}
pub fn encode(&self, buf: &mut impl BufMut) {
buf.put_slice(&self.inner);
}
pub fn decode(buf: &mut impl Buf) -> Result<Self, CredentialError> {
if buf.remaining() < N {
return Err(CredentialError::InvalidSize {
expected: N,
received: buf.remaining(),
});
}
let mut inner = [0; N];
buf.copy_to_slice(&mut inner);
Ok(Self { inner })
}
}
impl<const N: usize> AsRef<[u8]> for Credential<N> {
fn as_ref(&self) -> &[u8] {
&self.inner
}
}
#[derive(Debug, Clone, Error, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum CredentialError {
#[error("Invalid size, expected: {expected}, received: {received}")]
InvalidSize { expected: usize, received: usize },
#[error("Invalid encoding: {0}")]
InvalidEncoding(String),
}
impl<const N: usize> From<[u8; N]> for Credential<N> {
fn from(v: [u8; N]) -> Self {
Self { inner: v }
}
}
impl<const N: usize> From<Credential<N>> for [u8; N] {
fn from(val: Credential<N>) -> Self {
val.inner
}
}
impl<const N: usize> Default for Credential<N> {
fn default() -> Self {
Self { inner: [0; N] }
}
}
impl<const N: usize> From<Credential<N>> for String {
fn from(val: Credential<N>) -> Self {
hex::encode(val.inner)
}
}
impl<const N: usize> FromStr for Credential<N> {
type Err = CredentialError;
fn from_str(v: &str) -> Result<Self, Self::Err> {
if v.len() != N * 2 {
Err(CredentialError::InvalidSize {
expected: N * 2,
received: v.len(),
})
} else {
Ok(Self {
inner: hex::decode(v)
.map_err(|err| CredentialError::InvalidEncoding(err.to_string()))?
.try_into()
.unwrap(),
})
}
}
}
impl<const N: usize> std::fmt::Display for Credential<N> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
write!(f, "{}", hex::encode(self.inner))
}
}
impl<const N: usize> std::fmt::Debug for Credential<N> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
write!(f, "Inner: `{}`", hex::encode(self.inner))
}
}
impl<const N: usize> rand::distributions::Distribution<Credential<N>>
for rand::distributions::Standard
{
fn sample<R: rand::Rng + ?Sized>(&self, rng: &mut R) -> Credential<N> {
Credential {
inner: (0..N)
.map(|_| rng.gen())
.collect::<Vec<u8>>()
.try_into()
.unwrap(),
}
}
}
#[cfg(feature = "postgres-types")]
impl<const N: usize> postgres_types::ToSql for Credential<N> {
fn accepts(ty: &postgres_types::Type) -> bool {
*ty == postgres_types::Type::BPCHAR
}
fn to_sql(
&self,
_ty: &postgres_types::Type,
out: &mut bytes::BytesMut,
) -> Result<postgres_types::IsNull, Box<dyn std::error::Error + Sync + Send>>
where
Self: Sized,
{
let string = self.to_string();
out.put_slice(string.as_bytes());
Ok(postgres_types::IsNull::No)
}
fn to_sql_checked(
&self,
_ty: &postgres_types::Type,
out: &mut bytes::BytesMut,
) -> Result<postgres_types::IsNull, Box<dyn std::error::Error + Sync + Send>> {
let string = self.to_string();
out.put_slice(string.as_bytes());
Ok(postgres_types::IsNull::No)
}
}
#[cfg(feature = "postgres-types")]
impl<'a, const N: usize> postgres_types::FromSql<'a> for Credential<N> {
fn from_sql(
_ty: &postgres_types::Type,
raw: &'a [u8],
) -> Result<Self, Box<dyn std::error::Error + Sync + Send>> {
let str = std::str::from_utf8(raw)?;
let credential = Self::from_str(str)?;
Ok(credential)
}
fn accepts(ty: &postgres_types::Type) -> bool {
*ty == postgres_types::Type::BPCHAR
}
}
#[cfg(feature = "serde")]
use serde::{de::Visitor, Deserialize, Deserializer, Serialize, Serializer};
#[cfg(feature = "serde")]
struct CredentialVisitor<const N: usize>;
#[cfg(feature = "serde")]
impl<'de, const N: usize> Visitor<'de> for CredentialVisitor<N> {
type Value = Credential<N>;
fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
formatter.write_str(&format!("an array of length {}", N))
}
fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
where
E: serde::de::Error,
{
Credential::from_str(v).map_err(|err| {
E::invalid_value(
serde::de::Unexpected::Other(err.to_string().as_str()),
&"hex encoded credential",
)
})
}
}
#[cfg(feature = "serde")]
impl<'de, const N: usize> Deserialize<'de> for Credential<N> {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: Deserializer<'de>,
{
deserializer.deserialize_str(CredentialVisitor::<N>)
}
}
#[cfg(feature = "serde")]
impl<const N: usize> Serialize for Credential<N> {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
serializer.serialize_str(&self.to_string())
}
}
#[cfg(test)]
mod tests {
use super::*;
use bytes::BytesMut;
const SIZE: usize = 32;
#[test]
fn test_buffer_parse() {
let mut buf = BytesMut::with_capacity(SIZE);
let credential: Credential<SIZE> = rand::random();
credential.encode(&mut buf);
let parsed_credential = Credential::<SIZE>::decode(&mut buf)
.expect("reading Credential from buffer returned Error");
assert_eq!(credential, parsed_credential);
}
#[test]
fn test_buffer_parse_underflow() {
let mut buf = BytesMut::with_capacity(SIZE);
let credential: Credential<SIZE> = rand::random();
credential.encode(&mut buf);
buf = buf[0..SIZE - 1].into();
Credential::<SIZE>::decode(&mut buf)
.expect_err("reading malformed Credential from buffer did not return Error");
}
}