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
use std::io::Read;
use buffer_redux::Buffer;
use nom::{Needed, Offset};
use crate::errors::{Error, Result};
use crate::packet::packet_sum::Packet;
use crate::packet::single::{self, ParseResult};
const MAX_CAPACITY: usize = 1024 * 1024 * 1024;
pub struct PacketParser<R> {
inner: R,
capacity: usize,
buffer: Buffer,
failed: bool,
}
impl<R: Read> PacketParser<R> {
pub fn new(inner: R) -> Self {
PacketParser {
inner,
// the inital capacity of our buffer
// TODO: use a better value than a random guess
capacity: 1024,
// TODO: only use when available
buffer: Buffer::with_capacity(1024),
failed: false,
}
}
}
impl<R: Read> Iterator for PacketParser<R> {
type Item = Result<Packet>;
fn next(&mut self) -> Option<Self::Item> {
if self.failed {
return None;
}
let b = &mut self.buffer;
let mut needed: Option<Needed> = None;
let mut second_round = false;
let inner = &mut self.inner;
loop {
// read some data
let sz = match b.read_from(inner) {
Ok(sz) => sz,
Err(err) => {
warn!("failed to read {:?}", err);
return None;
}
};
// If there's no more available data in the buffer after a write, that means we reached
// the end of the input.
if b.is_empty() {
return None;
}
if needed.is_some() && sz == 0 {
if second_round {
// Cancel if we didn't receive enough bytes from our source, the second time around.
// TODO: b.reset();
self.failed = true;
return Some(Err(Error::PacketIncomplete));
}
second_round = true;
}
let res_header = match single::parser(b.buf()) {
Ok(v) => Ok(v),
Err(err) => Err(err.into()),
}
.and_then(|(rest, (ver, tag, _packet_length, body))| match body {
ParseResult::Indeterminated => {
let mut body = rest.to_vec();
inner.read_to_end(&mut body)?;
match single::body_parser(ver, tag, &body) {
Err(Error::Incomplete(n)) => Err(Error::Incomplete(n)),
p => Ok((rest.len() + body.len(), p)),
}
}
ParseResult::Fixed(body) => {
let p = single::body_parser(ver, tag, body);
Ok((b.buf().offset(rest), p))
}
ParseResult::Partial(body) => {
let p = single::body_parser(ver, tag, &body.concat());
Ok((b.buf().offset(rest), p))
}
});
let res_body = match res_header {
Ok(val) => Some(val),
Err(err) => match err {
Error::Incomplete(n) => {
debug!("incomplete {:?}", n);
needed = Some(n);
None
}
_ => {
warn!("parsing error {:?}", err);
self.failed = true;
return Some(Err(err));
}
},
};
if let Some((length, p)) = res_body {
debug!("got packet: {:#?} {}", p, length);
assert!(length > 0);
b.consume(length);
return Some(p);
}
// if the parser returned `Incomplete`, and it needs more data than the buffer can hold, we grow the buffer.
if let Some(Needed::Size(sz)) = needed {
if b.usable_space() < sz.into() && self.capacity * 2 < MAX_CAPACITY {
self.capacity *= 2;
let capacity = self.capacity;
b.make_room();
b.reserve(capacity);
}
}
}
}
}
#[cfg(test)]
mod tests {
#![allow(clippy::unwrap_used)]
use super::*;
use num_traits::FromPrimitive;
use regex::Regex;
use std::fs::File;
use std::io::{BufRead, BufReader, Seek, SeekFrom};
use std::path::Path;
use crate::ser::Serialize;
use crate::types::Tag;
#[test]
#[ignore]
fn test_packet_roundtrip_0001() {
packet_roundtrip(
"0001",
vec![
(556, 6 + 2224),
(805, 6 + 95),
(806, 6 + 6495),
(1027, 6 + 6246),
(1074, 2490),
(1331, 838),
(1898, 6420),
(1935, 3583),
],
)
}
#[test]
#[ignore]
fn test_packet_roundtrip_0002() {
packet_roundtrip(
"0002",
vec![
(82, 199), // invalid hash alg 06
(85, 196), // invalid hash alg 06
(836, 3136), // non canoncial length encoding
(1200, 2772), // non canoncial length encoding
(1268, 1223), // non canoncial length encoding
(1670, 3419), // non canoncial length encoding
],
)
}
#[test]
#[ignore]
fn test_packet_roundtrip_0009() {
packet_roundtrip(
"0009",
vec![
(37, 3960), // non canoncial length encoding
(39, 3960), // non canoncial length encoding
(258, 75), // non canoncial length encoding
(260, 78), // non canoncial length encoding
(1053, 3181), // non canoncial length encoding
(1473, 5196), // non canoncial length encoding
(1895, 4243), // non canoncial length encoding
],
)
}
fn packet_roundtrip(dump: &str, skips: Vec<(usize, i64)>) {
let _ = pretty_env_logger::try_init();
let path = format!("./tests/tests/sks-dump/{dump}.pgp");
let p = Path::new(&path);
let file = File::open(p).unwrap();
let mut bytes = File::open(p).unwrap();
let packets = PacketParser::new(file);
for (i, packet) in packets.take(2000).enumerate() {
// packets we need to skip, because we can not roundtrip them for some reason
if let Some((_, size)) = skips.iter().find(|(j, _)| *j == i) {
bytes.seek(SeekFrom::Current(*size)).unwrap();
continue;
}
let packet = packet.expect("invalid packet");
let mut buf = Vec::new();
packet
.to_writer(&mut buf)
.expect("failed to serialize packet");
let mut expected_buf = vec![0u8; buf.len()];
assert_eq!(bytes.read(&mut expected_buf).unwrap(), buf.len());
// println!("\n-- packet: {} expected size: {}", i, expected_buf.len());
if buf != expected_buf {
assert_eq!(hex::encode(buf), hex::encode(expected_buf));
}
}
}
#[test]
fn test_many_parser() {
// use pretty_env_logger;
// let _ = pretty_env_logger::try_init();
let p = Path::new("./tests/tests/sks-dump/0000.pgp");
let file = File::open(p).unwrap();
// list of expected tags
// this file is built by
// `gpg --list-packets tests/tests/sks-dump/0000.pgp`
let fixture = File::open("./tests/tests/sks-dump/0000_parsed.txt").unwrap();
let re = Regex::new(r"^#\soff=(\d+)\sctb=[[:alpha:]\d]+\stag=(\d+)\s.*").unwrap();
let expected_tags = BufReader::new(fixture)
.lines()
.filter(|line| line.as_ref().unwrap().starts_with("# off"))
.map(|line| {
let (offset, tag) = {
let cap = re.captures(line.as_ref().unwrap()).unwrap();
(cap[1].to_string(), cap[2].to_string())
};
(offset, tag, line)
})
.filter(|(offset, _, _)| {
// skip certain packages we are not (yet) parsing
offset != "1193538" && // invalid mpi
offset != "5053086" && // invalid mpi
offset != "8240010" && // unknown public key algorithm 100
offset != "9758352" && // TODO: unclear why this sig fails to parse
offset != "9797527" && // TODO: unclear why this sig fails to parse
offset != "11855679" && // TODO: unclear why this sig fails to parse
offset != "11855798" && // TODO: unclear why this sig fails to parse
offset != "11856933" && // TODO: unclear why this sig fails to parse
offset != "11857023" && // TODO: unclear why this sig fails to parse
offset != "11857113" && // TODO: unclear why this sig fails to parse
offset != "12688657" && // TODO: unclear why this sig fails to parse
offset != "24798372" && // TODO: unclear why this public sub key fails to parse
offset != "24810682" && // bad attribute size
offset != "38544535" // bad attribute size
});
let actual_tags = PacketParser::new(file).filter(|p| p.is_ok());
for ((_offset, tag, e), packet) in expected_tags.zip(actual_tags) {
let e = e.as_ref().unwrap();
let packet = packet.unwrap();
// println!("\n-- checking: {:?} {}", packet.tag(), e);
let tag = Tag::from_u8(tag.parse().unwrap()).unwrap();
assert_eq!(tag, packet.tag(), "missmatch in packet {:?} ({})", p, e);
}
}
#[test]
fn incomplete_packet_parser() {
let _ = pretty_env_logger::try_init();
use std::io::Cursor;
let bytes: [u8; 1] = [0x97];
let parser = PacketParser::new(Cursor::new(bytes));
let mut packets = parser.filter_map(|p| {
// for now we are skipping any packets that we failed to parse
match p {
Ok(pp) => Some(pp),
Err(err) => {
warn!("skipping packet: {:?}", err);
None
}
}
});
assert!(packets.next().is_none());
}
}