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
//! S-Expression support.
//!
//! This implements parsing of [S-Expressions] encoded using the
//! canonical and basic transport encoding.
//!
//! [S-Expressions]: https://people.csail.mit.edu/rivest/Sexp.txt
use std::cmp;
use std::io::Write;
use std::rc::Rc;
use openpgp::parse::buffered_reader::{self, BufferedReader};
use lalrpop_util::{lalrpop_mod, ParseError};
use sequoia_openpgp as openpgp;
use openpgp::parse::Cookie;
use openpgp::Error;
use crate::Result;
use crate::sexp::Sexp;
mod lexer;
use lexer::Lexer;
// Load the generated code.
lalrpop_mod!(
#[allow(clippy::all)]
#[allow(missing_docs, unused_parens)]
grammar,
"/sexp/parse/grammar.rs"
);
impl<'a> Sexp {
/// Reads from the given buffered reader.
///
/// Implementations of this function should be short. Ideally,
/// they should hand of the reader to a private function erasing
/// the readers type by invoking [`BufferedReader::into_boxed`].
pub fn from_buffered_reader<R>(mut reader: R) -> Result<Self>
where
R: BufferedReader<Cookie> + 'a,
{
Self::from_bytes(reader.data_eof()?)
}
/// Reads from the given reader.
///
/// The default implementation just uses
/// [`Parse::from_buffered_reader`], but implementations can
/// provide their own specialized version.
pub fn from_reader<R: 'a + std::io::Read + Send + Sync>(reader: R) -> Result<Self> {
Self::from_buffered_reader(
buffered_reader::Generic::with_cookie(reader,
None,
Default::default())
.into_boxed())
}
/// Reads from the given file.
///
/// The default implementation just uses
/// [`Parse::from_buffered_reader`], but implementations can
/// provide their own specialized version.
pub fn from_file<P: AsRef<std::path::Path>>(path: P) -> Result<Self>
{
Self::from_buffered_reader(
buffered_reader::File::with_cookie(path.as_ref(),
Default::default())?
.into_boxed())
}
/// Reads from the given slice.
///
/// The default implementation just uses
/// [`Parse::from_buffered_reader`], but implementations can
/// provide their own specialized version.
pub fn from_bytes<D: AsRef<[u8]> + ?Sized>(data: &'a D) -> Result<Sexp> {
Self::from_bytes_private(data.as_ref())
}
}
impl Sexp {
fn from_bytes_private(data: &[u8]) -> Result<Sexp> {
let lexer = Lexer::new(data);
let state = Rc::clone(&lexer.state);
match self::grammar::SexprParser::new().parse(&state, lexer) {
Ok(r) => Ok(r),
Err(err) => {
let mut msg = Vec::new();
writeln!(&mut msg, "Parsing: {:?}: {:?}",
String::from_utf8_lossy(data), err)?;
if let ParseError::UnrecognizedToken {
token: (start, _, end), ..
} = err
{
writeln!(&mut msg, "Context:")?;
let chars = data.iter().enumerate()
.filter_map(|(i, c)| {
if cmp::max(8, start) - 8 <= i
&& i <= end + 8
{
Some((i, c))
} else {
None
}
});
for (i, c) in chars {
writeln!(&mut msg, "{} {} {}: {:?}",
if i == start { "*" } else { " " },
i,
*c as char,
c)?;
}
}
Err(Error::InvalidArgument(String::from_utf8_lossy(&msg)
.to_string()).into())
},
}
}
}
#[cfg(test)]
mod tests {
use crate::sexp::{Sexp, String_};
#[test]
fn basics() {
assert_eq!(Sexp::from_bytes(b"()").unwrap(),
Sexp::List(vec![]));
assert_eq!(Sexp::from_bytes(b"2:hi").unwrap(),
Sexp::String(b"hi"[..].into()));
assert_eq!(Sexp::from_bytes(b"[5:fancy]2:hi").unwrap(),
Sexp::String(String_::with_display_hint(
b"hi".to_vec(), b"fancy".to_vec())));
assert_eq!(Sexp::from_bytes(b"(2:hi2:ho)").unwrap(),
Sexp::List(vec![
Sexp::String(b"hi"[..].into()),
Sexp::String(b"ho"[..].into()),
]));
assert_eq!(Sexp::from_bytes(b"(2:hi[5:fancy]2:ho)").unwrap(),
Sexp::List(vec![
Sexp::String(b"hi"[..].into()),
Sexp::String(String_::with_display_hint(
b"ho".to_vec(), b"fancy".to_vec())),
]));
assert_eq!(Sexp::from_bytes(b"(2:hi(2:ha2:ho))").unwrap(),
Sexp::List(vec![
Sexp::String(b"hi"[..].into()),
Sexp::List(vec![
Sexp::String(b"ha"[..].into()),
Sexp::String(b"ho"[..].into()),
]),
]));
assert_eq!(Sexp::from_bytes(b"(7:sig-val(3:rsa(1:s3:abc)))").unwrap(),
Sexp::List(vec![
Sexp::String(b"sig-val"[..].into()),
Sexp::List(vec![
Sexp::String(b"rsa"[..].into()),
Sexp::List(vec![
Sexp::String(b"s"[..].into()),
Sexp::String(b"abc"[..].into()),
]),
]),
]));
assert!(Sexp::from_bytes(b"").is_err());
assert!(Sexp::from_bytes(b"(").is_err());
assert!(Sexp::from_bytes(b"(2:hi").is_err());
assert!(Sexp::from_bytes(b"(2:hi)(2:hi)").is_err());
assert!(Sexp::from_bytes(b"([2:hi])").is_err());
// Tokens.
assert_eq!(Sexp::from_bytes(b"(private-key)").unwrap(),
Sexp::List(vec![
Sexp::String(b"private-key"[..].into())
]));
assert_eq!(Sexp::from_bytes(b"(foo bar)").unwrap(),
Sexp::List(vec![
Sexp::String(b"foo"[..].into()),
Sexp::String(b"bar"[..].into()),
]));
assert_eq!(Sexp::from_bytes(b"(:foo *bar)").unwrap(),
Sexp::List(vec![
Sexp::String(b":foo"[..].into()),
Sexp::String(b"*bar"[..].into()),
]));
assert_eq!(Sexp::from_bytes(b"(2:hifoo)").unwrap(),
Sexp::List(vec![
Sexp::String(b"hi"[..].into()),
Sexp::String(b"foo"[..].into()),
]));
assert_eq!(Sexp::from_bytes(b"(2:hifoo bar)").unwrap(),
Sexp::List(vec![
Sexp::String(b"hi"[..].into()),
Sexp::String(b"foo"[..].into()),
Sexp::String(b"bar"[..].into()),
]));
// Check that a token can be followed by a [ or a ].
assert_eq!(Sexp::from_bytes(b"(hi[fancy]ho)").unwrap(),
Sexp::List(vec![
Sexp::String(b"hi"[..].into()),
Sexp::String(String_::with_display_hint(
b"ho".to_vec(), b"fancy".to_vec())),
]));
assert_eq!(Sexp::from_bytes(b"(hi [fancy]ho)").unwrap(),
Sexp::List(vec![
Sexp::String(b"hi"[..].into()),
Sexp::String(String_::with_display_hint(
b"ho".to_vec(), b"fancy".to_vec())),
]));
assert_eq!(Sexp::from_bytes(b"(hi [fancy ]ho)").unwrap(),
Sexp::List(vec![
Sexp::String(b"hi"[..].into()),
Sexp::String(String_::with_display_hint(
b"ho".to_vec(), b"fancy".to_vec())),
]));
// Check that a token can be followed by a ( or a ).
assert_eq!(Sexp::from_bytes(b"(hi(fancy)ho)").unwrap(),
Sexp::List(vec![
Sexp::String(b"hi"[..].into()),
Sexp::List(vec![
Sexp::String(b"fancy"[..].into()),
]),
Sexp::String(b"ho"[..].into()),
]));
// No space between two quoted strings => two tokens.
assert_eq!(Sexp::from_bytes(b"(\"hi \"\" ho\")").unwrap(),
Sexp::List(vec![
Sexp::String(b"hi "[..].into()),
Sexp::String(b" ho"[..].into()),
]));
assert_eq!(Sexp::from_bytes(b"(\"hi \" \" ho\")").unwrap(),
Sexp::List(vec![
Sexp::String(b"hi "[..].into()),
Sexp::String(b" ho"[..].into()),
]));
// Quoted strings with escape sequences.
assert_eq!(Sexp::from_bytes(b"(\"\\?\")").unwrap(),
Sexp::List(vec![
Sexp::String(b"?"[..].into()),
]));
// Quoted strings with escape sequences including hexadecimal.
assert_eq!(Sexp::from_bytes(b"(\"\\?\\\\\\x24\\x58\")").unwrap(),
Sexp::List(vec![
Sexp::String(b"?\\$X"[..].into()),
]));
// Quoted strings with octal escape sequences.
assert_eq!(Sexp::from_bytes(b"(\"foo \\066\\122 bar\")").unwrap(),
Sexp::List(vec![
Sexp::String(b"foo 6R bar"[..].into()),
]));
// Ignore newlines.
assert_eq!(Sexp::from_bytes(b"(\"foo \\\n\r bar\")").unwrap(),
Sexp::List(vec![
Sexp::String(b"foo bar"[..].into()),
]));
// Hexadecimal and quoted strings.
assert_eq!(Sexp::from_bytes(b"(#2458# \" ho\")").unwrap(),
Sexp::List(vec![
Sexp::String(b"$X"[..].into()),
Sexp::String(b" ho"[..].into()),
]));
// Hexadecimal with spaces and quoted strings.
assert_eq!(Sexp::from_bytes(b"(#245 8# \" ho\")").unwrap(),
Sexp::List(vec![
Sexp::String(b"$X"[..].into()),
Sexp::String(b" ho"[..].into()),
]));
}
#[test]
fn signatures() {
assert!(Sexp::from_bytes(
crate::tests::file("sexp/dsa-signature.sexp")).is_ok());
assert!(Sexp::from_bytes(
crate::tests::file("sexp/ecdsa-signature.sexp")).is_ok());
assert!(Sexp::from_bytes(
crate::tests::file("sexp/eddsa-signature.sexp")).is_ok());
assert!(Sexp::from_bytes(
crate::tests::file("sexp/rsa-signature.sexp")).is_ok());
}
/// Demonstrates a crash in the lexer.
#[test]
fn issue_742() {
Sexp::from_bytes(b"7").unwrap_err();
}
}