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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
use std::{
io::{BufRead, BufReader},
path::Path,
};
use super::{
reader::{CompressedDataReader, LiteralDataReader, SignatureManyReader},
DebugBufRead, MessageReader, PacketBodyReader,
};
use crate::{
armor::{BlockType, DearmorOptions},
composed::{message::Message, shared::is_binary, Edata, Esk, SignaturePacket},
errors::{bail, format_err, unimplemented_err, Result},
packet::{ProtectedDataConfig, SymEncryptedProtectedDataConfig},
parsing_reader::BufReadParsing,
types::{PkeskVersion, SkeskVersion, Tag},
};
struct MessageParser<'a> {
messages: Vec<SignaturePacket>,
current: MessageParserState<'a>,
}
enum MessageParserState<'a> {
Start {
packets: crate::packet::PacketParser<MessageReader<'a>>,
is_nested: bool,
is_first: bool,
},
Error,
}
impl<'a> MessageParser<'a> {
pub(super) fn new(
packets: crate::packet::PacketParser<MessageReader<'a>>,
is_nested: bool,
) -> Self {
// non nested messages are considered "first"
let is_first = !is_nested;
Self {
messages: Vec::new(),
current: MessageParserState::Start {
packets,
is_nested,
is_first,
},
}
}
/// Parses a single message level
pub(super) fn run(mut self) -> Result<Option<Message<'a>>> {
loop {
match std::mem::replace(&mut self.current, MessageParserState::Error) {
MessageParserState::Start {
packets,
is_nested,
mut is_first,
} => {
let Some(packet) = packets.next_owned() else {
return Ok(None);
};
let mut packet = packet?;
// Handle 1 OpenPGP Message per loop iteration
let tag = packet.packet_header().tag();
// Calculate is_nested_now, but only consume is_first for "real" packets
// (not for skipped packets)
let is_nested_now = if is_first { is_nested } else { true };
let consume_is_first = !matches!(
tag,
Tag::Marker
| Tag::Padding
| Tag::UnassignedNonCritical(_)
| Tag::Experimental(_)
);
if consume_is_first {
is_first = false;
}
match tag {
Tag::SymKeyEncryptedSessionKey
| Tag::PublicKeyEncryptedSessionKey
| Tag::SymEncryptedData
| Tag::SymEncryptedProtectedData
| Tag::GnupgAeadData => {
let message = Self::visit_esk(tag, packet, is_nested_now)?;
return match message {
Some(msg) => self.finish(msg, is_nested),
None => Ok(None),
};
}
Tag::Signature => {
// (b) Signed Message
// (1) Signature Packet, OpenPGP Message
// - Signature Packet
// - OpenPGP Message
let signature = crate::packet::Signature::try_from_reader(
packet.packet_header(),
&mut packet,
)?;
self.messages.push(SignaturePacket::Signature { signature });
// Keep original is_nested - the outer Signed message inherits it.
self.current = MessageParserState::Start {
packets: crate::packet::PacketParser::new(packet.into_inner()),
is_nested,
is_first,
};
}
Tag::OnePassSignature => {
// (2) One-Pass Signed Message.
// - OPS
// - OpenPGP Message
// - Signature Packet
let signature = crate::packet::OnePassSignature::try_from_reader(
packet.packet_header(),
&mut packet,
)?;
self.messages.push(SignaturePacket::Ops { signature });
// Keep original is_nested - the outer Signed message inherits it.
self.current = MessageParserState::Start {
packets: crate::packet::PacketParser::new(packet.into_inner()),
is_nested,
is_first,
};
}
Tag::CompressedData => {
// (c) Compressed Message
// - Compressed Packet
let reader = CompressedDataReader::new(packet, false)?;
let message = Message::Compressed {
reader,
is_nested: is_nested_now,
};
return self.finish(message, is_nested);
}
Tag::LiteralData => {
// (d) Literal Message
// - Literal Packet
let reader = LiteralDataReader::new(packet)?;
let message = Message::Literal {
reader,
is_nested: is_nested_now,
};
return self.finish(message, is_nested);
}
Tag::Padding => {
// drain reader
packet.drain()?;
// Keep original is_nested since Padding is a skipped packet
self.current = MessageParserState::Start {
packets: crate::packet::PacketParser::new(packet.into_inner()),
is_nested,
is_first,
};
}
Tag::Marker => {
// drain reader
packet.drain()?;
self.current = MessageParserState::Start {
packets: crate::packet::PacketParser::new(packet.into_inner()),
is_nested,
is_first,
};
}
Tag::UnassignedNonCritical(_) | Tag::Experimental(_) => {
// Skip "Unassigned Non-Critical" and "Private or Experimental Use" packets
// drain reader
packet.drain()?;
self.current = MessageParserState::Start {
packets: crate::packet::PacketParser::new(packet.into_inner()),
is_nested,
is_first,
};
}
_ => {
bail!("unexpected packet type: {:?}", tag);
}
}
}
MessageParserState::Error => panic!("invalid parser state"),
}
}
}
fn finish(self, message: Message<'a>, is_nested: bool) -> Result<Option<Message<'a>>> {
if self.messages.is_empty() {
return Ok(Some(message));
}
let reader = SignatureManyReader::new(self.messages, Box::new(message))?;
Ok(Some(Message::Signed { reader, is_nested }))
}
fn visit_esk(
tag: Tag,
mut packet: PacketBodyReader<MessageReader<'a>>,
is_nested: bool,
) -> Result<Option<Message<'a>>> {
// (a) Encrypted Message:
// - ESK Seq (may be empty)
// - Encrypted Data -> OpenPGP Message
let mut esks = Vec::new();
if tag == Tag::SymKeyEncryptedSessionKey || tag == Tag::PublicKeyEncryptedSessionKey {
let esk = Esk::try_from_reader(&mut packet)?;
esks.push(esk);
} else {
// this message consists of just a bare encryption container
let edata = Edata::try_from_reader(packet)?;
return Ok(Some(Message::Encrypted {
esk: esks, // empty
edata,
is_nested,
}));
}
let mut packets = crate::packet::PacketParser::new(packet.into_inner());
// Read ESKs unit we find the Encrypted Data
loop {
let Some(packet) = packets.next_owned() else {
bail!("missing encrypted data packet");
};
let mut packet = packet?;
let tag = packet.packet_header().tag();
match tag {
Tag::SymKeyEncryptedSessionKey | Tag::PublicKeyEncryptedSessionKey => {
let esk = Esk::try_from_reader(&mut packet)?;
esks.push(esk);
packets = crate::packet::PacketParser::new(packet.into_inner());
}
Tag::SymEncryptedData | Tag::SymEncryptedProtectedData | Tag::GnupgAeadData => {
let edata = Edata::try_from_reader(packet)?;
let esk = match edata {
Edata::SymEncryptedData { .. } => {
esk_filter(esks, PkeskVersion::V3, &[SkeskVersion::V4])
}
Edata::SymEncryptedProtectedData { ref reader } => match reader.config() {
ProtectedDataConfig::Seipd(SymEncryptedProtectedDataConfig::V1) => {
esk_filter(esks, PkeskVersion::V3, &[SkeskVersion::V4])
}
ProtectedDataConfig::Seipd(SymEncryptedProtectedDataConfig::V2 {
..
}) => esk_filter(esks, PkeskVersion::V6, &[SkeskVersion::V6]),
ProtectedDataConfig::GnupgAead { .. } => {
bail!("GnupgAead config not allowed in SymEncryptedProtectedData")
}
},
Edata::GnupgAeadData { ref reader, .. } => match reader.config() {
ProtectedDataConfig::Seipd(_) => {
bail!("Seipd config not allowed in GnupgAeadData");
}
ProtectedDataConfig::GnupgAead { .. } => esk_filter(
esks,
PkeskVersion::V3,
&[SkeskVersion::V4, SkeskVersion::V5],
),
},
};
return Ok(Some(Message::Encrypted {
esk,
edata,
is_nested,
}));
}
Tag::Padding => {
// drain reader
packet.drain()?;
packets = crate::packet::PacketParser::new(packet.into_inner());
}
Tag::Marker => {
// drain reader
packet.drain()?;
packets = crate::packet::PacketParser::new(packet.into_inner());
}
_ => {
bail!("unexpected tag in an encrypted message: {:?}", tag);
}
}
}
}
}
/// Drop PKESK and SKESK with versions that are not aligned with the encryption container
///
/// An implementation processing an Encrypted Message MUST discard any
/// preceding ESK packet with a version that does not align with the
/// version of the payload.
/// See <https://www.rfc-editor.org/rfc/rfc9580.html#section-10.3.2.1-7>
fn esk_filter(
esk: Vec<Esk>,
pkesk_allowed: PkeskVersion,
skesk_allowed: &[SkeskVersion],
) -> Vec<Esk> {
esk.into_iter()
.filter(|esk| match esk {
Esk::PublicKeyEncryptedSessionKey(pkesk) => pkesk.version() == pkesk_allowed,
Esk::SymKeyEncryptedSessionKey(skesk) => skesk_allowed.contains(&skesk.version()),
})
.collect()
}
impl<'a> Message<'a> {
/// Parse a composed message.
/// Ref: <https://www.rfc-editor.org/rfc/rfc9580.html#name-openpgp-messages>
fn from_packets(packets: crate::packet::PacketParser<MessageReader<'a>>) -> Result<Self> {
match MessageParser::new(packets, false).run()? {
Some(message) => Ok(message),
None => {
bail!("no valid OpenPGP message found");
}
}
}
/// Parses a message from the given bytes.
pub fn from_bytes<R: BufRead + std::fmt::Debug + 'a + Send>(source: R) -> Result<Self> {
let source = MessageReader::Reader(Box::new(source) as Box<dyn DebugBufRead>);
let parser = crate::packet::PacketParser::new(source);
Self::from_packets(parser)
}
/// Construct a message from the decrypted edata.
///
/// `is_nested` must be passed through from the source `Message`.
pub(super) fn from_edata(edata: Edata<'a>, is_nested: bool) -> Result<Self> {
let source = MessageReader::Edata(Box::new(edata));
Message::internal_from_bytes(source, is_nested)
}
/// Construct a message from a compressed data reader.
///
/// `is_nested` must be passed through from the source `Message`.
pub(super) fn from_compressed(
reader: CompressedDataReader<MessageReader<'a>>,
is_nested: bool,
) -> Result<Self> {
let source = MessageReader::Compressed(Box::new(reader));
Message::internal_from_bytes(source, is_nested)
}
fn internal_from_bytes(source: MessageReader<'a>, is_nested: bool) -> Result<Self> {
let packets = crate::packet::PacketParser::new(source);
match MessageParser::new(packets, is_nested).run()? {
Some(message) => Ok(message),
None => {
bail!("no valid OpenPGP message found");
}
}
}
/// From armored file
pub fn from_armor_file<P: AsRef<Path>>(path: P) -> Result<(Self, crate::armor::Headers)> {
let file = std::fs::File::open(path)?;
Self::from_armor(BufReader::new(file))
}
/// From armored string
pub fn from_string(data: &'a str) -> Result<(Self, crate::armor::Headers)> {
Self::from_armor(data.as_bytes())
}
/// From binary file
pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self> {
let file = std::fs::File::open(path)?;
Self::from_bytes(BufReader::new(file))
}
/// Armored ascii data.
pub fn from_armor<R: BufRead + std::fmt::Debug + 'a + Send>(
input: R,
) -> Result<(Self, crate::armor::Headers)> {
Self::from_armor_with_options(input, DearmorOptions::default())
}
/// Armored ascii data, with explicit options for dearmoring.
pub fn from_armor_with_options<R: BufRead + std::fmt::Debug + 'a + Send>(
input: R,
opt: DearmorOptions,
) -> Result<(Self, crate::armor::Headers)> {
let mut dearmor = crate::armor::Dearmor::with_options(input, opt);
dearmor.read_header()?;
// Safe to unwrap, as read_header succeeded.
let typ = dearmor
.typ
.ok_or_else(|| format_err!("dearmor failed to retrieve armor type"))?;
match typ {
// Standard PGP types
BlockType::File | BlockType::Message | BlockType::MultiPartMessage(_, _) => {
let headers = dearmor.headers.clone(); // FIXME: avoid clone
if !Self::matches_block_type(typ) {
bail!("unexpected block type: {}", typ);
}
Ok((Self::from_bytes(BufReader::new(dearmor))?, headers))
}
BlockType::PublicKey
| BlockType::PrivateKey
| BlockType::Signature
| BlockType::CleartextMessage
| BlockType::PublicKeyPKCS1(_)
| BlockType::PublicKeyPKCS8
| BlockType::PublicKeyOpenssh
| BlockType::PrivateKeyPKCS1(_)
| BlockType::PrivateKeyPKCS8
| BlockType::PrivateKeyOpenssh => {
unimplemented_err!("key format {:?}", typ);
}
}
}
/// Parse from a reader which might contain ASCII armored data or binary data.
pub fn from_reader<R: BufRead + std::fmt::Debug + 'a + Send>(
mut source: R,
) -> Result<(Self, Option<crate::armor::Headers>)> {
if is_binary(&mut source)? {
let msg = Self::from_bytes(source)?;
Ok((msg, None))
} else {
let (msg, headers) = Self::from_armor(source)?;
Ok((msg, Some(headers)))
}
}
fn matches_block_type(typ: BlockType) -> bool {
matches!(
typ,
BlockType::Message | BlockType::MultiPartMessage(_, _) | BlockType::File
)
}
}