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
use std::collections::HashMap;
use super::pubkey::{PublicKey, PublicKeyKind};
/// A `Writer` is used for encoding a key in OpenSSH compatible format.
#[derive(Debug)]
pub struct Writer {
inner: Vec<u8>,
}
impl Writer {
/// Creates a new `Writer` instance.
///
/// # Example
/// ```rust
/// # use rustica_keys::ssh::Writer;
/// let writer = Writer::new();
/// ```
pub fn new() -> Writer {
Writer { inner: Vec::new() }
}
/// Writes a byte sequence to the underlying vector.
/// The value is represented as a the byte sequence length,
/// followed by the actual byte sequence.
///
/// # Example
/// ```rust
/// # use rustica_keys::ssh::Writer;
/// let mut writer = Writer::new();
/// writer.write_bytes(&[0, 0, 0, 42]);
/// let bytes = writer.into_bytes();
/// assert_eq!(bytes, vec![0, 0, 0, 4, 0, 0, 0, 42]);
/// ```
pub fn write_bytes(&mut self, val: &[u8]) {
let size = val.len() as u32;
let mut buf = size.to_be_bytes().to_vec();
self.inner.append(&mut buf);
self.inner.extend_from_slice(&val);
}
/// Writes a `string` value to the underlying byte sequence.
///
/// # Example
/// ```rust
/// # use rustica_keys::ssh::Writer;
/// let mut writer = Writer::new();
/// writer.write_string("a test string");
/// let bytes = writer.into_bytes();
/// assert_eq!(bytes, [0, 0, 0, 13, 97, 32, 116, 101, 115, 116, 32, 115, 116, 114, 105, 110, 103]);
/// ```
pub fn write_string(&mut self, val: &str) {
self.write_bytes(val.as_bytes());
}
/// Writes a `u64` value to the underlying byte sequence.
///
/// # Example
/// ```rust
/// # use rustica_keys::ssh::Writer;
/// let mut writer = Writer::new();
/// writer.write_u64(0xFFFFFFFFFFFFFFFF);
/// let bytes = writer.into_bytes();
/// assert_eq!(bytes, [255, 255, 255, 255, 255, 255, 255, 255]);
/// ```
pub fn write_u64(&mut self, val: u64) {
let bytes = val.to_be_bytes();
self.inner.extend_from_slice(&bytes);
}
/// Writes a `u32` value to the underlying byte sequence.
///
/// # Example
/// ```rust
/// # use rustica_keys::ssh::Writer;
/// let mut writer = Writer::new();
/// writer.write_u32(0xFFFFFFFF);
/// let bytes = writer.into_bytes();
/// assert_eq!(bytes, [255, 255, 255, 255]);
/// ```
pub fn write_u32(&mut self, val: u32) {
let bytes = val.to_be_bytes();
self.inner.extend_from_slice(&bytes);
}
/// Writes an `mpint` value to the underlying byte sequence.
/// If the MSB bit of the first byte is set then the number is
/// negative, otherwise it is positive.
/// Positive numbers must be preceeded by a leading zero byte according to RFC 4251, section 5.
///
/// # Example
/// ```rust
/// # use rustica_keys::ssh::Writer;
/// let mut writer = Writer::new();
/// writer.write_mpint(&[1, 0, 1]);
/// let bytes = writer.into_bytes();
/// assert_eq!(bytes, [0, 0, 0, 3, 1, 0, 1]);
/// ```
pub fn write_mpint(&mut self, val: &[u8]) {
let mut bytes = val.to_vec();
// If most significant bit is set then prepend a zero byte to
// avoid interpretation as a negative number.
if val.get(0).unwrap_or(&0) & 0x80 != 0 {
bytes.insert(0, 0);
}
self.write_bytes(&bytes);
}
/// Writes a `Vec<String>` to the underlying byte sequence.
///
/// # Example
/// ```rust
/// # use rustica_keys::ssh::Writer;
/// let mut writer = Writer::new();
///
/// writer.write_string_vec(&vec![String::from("Test"), String::from("Test")]);
/// let bytes = writer.into_bytes();
/// assert_eq!(bytes, [0, 0, 0, 16, 0, 0, 0, 4, 84, 101, 115, 116, 0, 0, 0, 4, 84, 101, 115, 116]);
/// ```
pub fn write_string_vec(&mut self, vec: &[String]) {
let total_length = vec.iter().map(|x| x.len()).fold(vec.len()*4, |x, y| x + y) as u32;
self.write_u32(total_length);
for item in vec {
self.write_string(item);
}
}
/// Writes a `HashMap<String, String>` to the underlying byte sequence.
///
/// # Example
/// ```rust
/// # use rustica_keys::ssh::Writer;
/// # use std::collections::HashMap;
///
/// let mut writer = Writer::new();
/// let mut example_map = HashMap::new();
/// example_map.insert(String::from("Test"), String::from(""));
/// writer.write_string_map(&example_map);
/// let bytes = writer.into_bytes();
/// assert_eq!(bytes, [0, 0, 0, 12, 0, 0, 0, 4, 84, 101, 115, 116, 0, 0, 0, 0]);
/// ```
pub fn write_string_map(&mut self, map: &HashMap<String, String>) {
let total_length = map.iter()
.map(|x| x.0.len() + x.1.len() + if !x.1.is_empty() { 4 } else { 0 })
.fold(map.len() * 8, |x, y| x + y) as u32;
self.write_u32(total_length);
for (k,v) in map {
self.write_string(k);
if v.is_empty() {
self.write_u32(0x0);
} else {
self.write_u32(v.len() as u32 + 4);
self.write_string(v);
}
}
}
/// Writes a `PublicKey` to the underlying byte sequence.
///
/// # Example
/// ```
/// ```
pub fn write_pub_key(&mut self, key: &PublicKey) {
// Write the public key
match &key.kind {
PublicKeyKind::Ecdsa(key) => {
self.write_string(key.curve.identifier);
self.write_bytes(&key.key);
},
PublicKeyKind::Rsa(key) => {
self.write_bytes(&key.n);
self.write_bytes(&key.e);
},
PublicKeyKind::Ed25519(key) => {
self.write_bytes(&key.key);
}
};
}
/// Converts the `Writer` into a byte sequence.
/// This consumes the underlying byte sequence used by the `Writer`.
///
/// # Example
/// ```rust
/// # use rustica_keys::ssh::Writer;
///
/// let mut writer = Writer::new();
/// writer.write_string("some data");
/// let bytes = writer.into_bytes();
/// assert_eq!(bytes, [0, 0, 0, 9, 115, 111, 109, 101, 32, 100, 97, 116, 97]);
/// ```
pub fn into_bytes(self) -> Vec<u8> {
self.inner
}
/// Converts the `Writer` into a byte sequence.
/// This consumes the underlying byte sequence used by the `Writer`.
///
/// # Example
/// ```rust
/// # use rustica_keys::ssh::Writer;
///
/// let mut writer = Writer::new();
/// writer.write_string("some data");
/// let bytes = writer.into_bytes();
/// assert_eq!(bytes, [0, 0, 0, 9, 115, 111, 109, 101, 32, 100, 97, 116, 97]);
/// ```
pub fn as_bytes(&self) -> &[u8] {
self.inner.as_slice()
}
}
impl Default for Writer {
fn default() -> Self {
Writer::new()
}
}