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
|
//! Packet maps.
//!
//! If configured to do so, a `PacketParser` will create a map that
//! charts the byte-stream, describing where the information was
//! extracted from.
//!
//! # Examples
//!
//! ```
//! # fn main() -> sequoia_openpgp::Result<()> {
//! use sequoia_openpgp as openpgp;
//! use openpgp::parse::{Parse, PacketParserBuilder};
//!
//! let message_data = b"\xcb\x12t\x00\x00\x00\x00\x00Hello world.";
//! let pp = PacketParserBuilder::from_bytes(message_data)?
//! .map(true) // Enable mapping.
//! .build()?
//! .expect("One packet, not EOF");
//! let map = pp.map().expect("Mapping is enabled");
//!
//! assert_eq!(map.iter().nth(0).unwrap().name(), "CTB");
//! assert_eq!(map.iter().nth(0).unwrap().offset(), 0);
//! assert_eq!(map.iter().nth(0).unwrap().as_bytes(), &[0xcb]);
//! # Ok(()) }
//! ```
use std::cmp;
/// Map created during parsing.
#[derive(Clone, Debug)]
pub struct Map {
length: usize,
entries: Vec<Entry>,
header: Vec<u8>,
data: Vec<u8>,
}
assert_send_and_sync!(Map);
/// Represents an entry in the map.
#[derive(Clone, Debug)]
struct Entry {
offset: usize,
length: usize,
field: &'static str,
}
impl Map {
/// Creates a new map.
pub(super) fn new(header: Vec<u8>) -> Self {
Map {
length: 0,
entries: Vec::new(),
header: header,
data: Vec::new(),
}
}
/// Adds a field to the map.
pub(super) fn add(&mut self, field: &'static str, length: usize) {
self.entries.push(Entry {
offset: self.length, length, field
});
self.length += length;
}
/// Finalizes the map providing the actual data.
pub(super) fn finalize(&mut self, data: Vec<u8>) {
self.data = data;
}
/// Creates an iterator over the map.
///
/// Returns references to [`Field`]s.
///
/// [`Field`]: struct.Field.html
///
/// # Examples
///
/// ```
/// # fn main() -> sequoia_openpgp::Result<()> {
/// use sequoia_openpgp as openpgp;
/// use openpgp::parse::{Parse, PacketParserBuilder};
///
/// let message_data = b"\xcb\x12t\x00\x00\x00\x00\x00Hello world.";
/// let pp = PacketParserBuilder::from_bytes(message_data)?
/// .map(true) // Enable mapping.
/// .build()?
/// .expect("One packet, not EOF");
/// let map = pp.map().expect("Mapping is enabled");
///
/// assert_eq!(map.iter().count(), 6);
/// # Ok(()) }
/// ```
pub fn iter<'a>(&'a self) -> impl Iterator<Item = Field<'a>> + Send + Sync {
Iter::new(self)
}
}
/// Represents an entry in the map.
///
/// A field has a [`name`] returning a human-readable field name
/// (e.g. "CTB", or "version"), an [`offset`] into the packet, and the
/// read [`data`].
///
/// [`name`]: #method.name
/// [`offset`]: #method.offset
/// [`data`]: #method.data
#[derive(Clone, Debug)]
pub struct Field<'a> {
/// Name of the field.
name: &'static str,
/// Offset of the field in the packet.
offset: usize,
/// Value of the field.
data: &'a [u8],
}
assert_send_and_sync!(Field<'_>);
impl<'a> Field<'a> {
fn new(map: &'a Map, i: usize) -> Option<Field<'a>> {
// Old-style CTB with indeterminate length emits no length
// field.
let has_length = map.header.len() > 1;
if i == 0 {
Some(Field {
offset: 0,
name: "CTB",
data: &map.header.as_slice()[..1],
})
} else if i == 1 && has_length {
Some(Field {
offset: 1,
name: "length",
data: &map.header.as_slice()[1..]
})
} else {
let offset_length = if has_length { 1 } else { 0 };
map.entries.get(i - 1 - offset_length).map(|e| {
let len = map.data.len();
let start = cmp::min(len, e.offset);
let end = cmp::min(len, e.offset + e.length);
Field {
offset: map.header.len() + e.offset,
name: e.field,
data: &map.data[start..end],
}
})
}
}
/// Returns the name of the field.
///
/// Note: The returned names are for display purposes only and may
/// change in the future.
///
/// # Examples
///
/// ```
/// # fn main() -> sequoia_openpgp::Result<()> {
/// use sequoia_openpgp as openpgp;
/// use openpgp::parse::{Parse, PacketParserBuilder};
///
/// let message_data = b"\xcb\x12t\x00\x00\x00\x00\x00Hello world.";
/// let pp = PacketParserBuilder::from_bytes(message_data)?
/// .map(true) // Enable mapping.
/// .build()?
/// .expect("One packet, not EOF");
/// let map = pp.map().expect("Mapping is enabled");
///
/// assert_eq!(map.iter().nth(0).unwrap().name(), "CTB");
/// assert_eq!(map.iter().nth(1).unwrap().name(), "length");
/// assert_eq!(map.iter().nth(2).unwrap().name(), "format");
/// # Ok(()) }
/// ```
pub fn name(&self) -> &'a str {
self.name
}
/// Returns the offset of the field in the packet.
///
/// # Examples
///
/// ```
/// # fn main() -> sequoia_openpgp::Result<()> {
/// use sequoia_openpgp as openpgp;
/// use openpgp::parse::{Parse, PacketParserBuilder};
///
/// let message_data = b"\xcb\x12t\x00\x00\x00\x00\x00Hello world.";
/// let pp = PacketParserBuilder::from_bytes(message_data)?
/// .map(true) // Enable mapping.
/// .build()?
/// .expect("One packet, not EOF");
/// let map = pp.map().expect("Mapping is enabled");
///
/// assert_eq!(map.iter().nth(0).unwrap().offset(), 0);
/// assert_eq!(map.iter().nth(1).unwrap().offset(), 1);
/// assert_eq!(map.iter().nth(2).unwrap().offset(), 2);
/// # Ok(()) }
/// ```
pub fn offset(&self) -> usize {
self.offset
}
/// Returns the value of the field.
///
/// # Examples
///
/// ```
/// # fn main() -> sequoia_openpgp::Result<()> {
/// use sequoia_openpgp as openpgp;
/// use openpgp::parse::{Parse, PacketParserBuilder};
///
/// let message_data = b"\xcb\x12t\x00\x00\x00\x00\x00Hello world.";
/// let pp = PacketParserBuilder::from_bytes(message_data)?
/// .map(true) // Enable mapping.
/// .build()?
/// .expect("One packet, not EOF");
/// let map = pp.map().expect("Mapping is enabled");
///
/// assert_eq!(map.iter().nth(0).unwrap().as_bytes(), &[0xcb]);
/// assert_eq!(map.iter().nth(1).unwrap().as_bytes(), &[0x12]);
/// assert_eq!(map.iter().nth(2).unwrap().as_bytes(), "t".as_bytes());
/// # Ok(()) }
/// ```
pub fn as_bytes(&self) -> &'a [u8] {
self.data
}
}
/// An iterator over the map.
struct Iter<'a> {
map: &'a Map,
i: usize,
}
impl<'a> Iter<'a> {
fn new(map: &'a Map) -> Iter<'a> {
Iter {
map: map,
i: 0,
}
}
}
impl<'a> Iterator for Iter<'a> {
type Item = Field<'a>;
fn next(&mut self) -> Option<Self::Item> {
let field = Field::new(self.map, self.i);
if field.is_some() {
self.i += 1;
}
field
}
}
|
