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
/// This macro generates the parsers matching to the two different types of keys,
/// public and secret.
#[macro_export]
macro_rules! key_parser {
( $key_type:ty, $key_type_parser: ident, $key_tag:expr, $inner_key_type:ty, $( ($subkey_tag:ident, $inner_subkey_type:ty, $subkey_type:ty, $subkey_container:ident) ),* ) => {
/// Parse a transferable keys from the given packets.
/// Ref: https://tools.ietf.org/html/rfc4880.html#section-11.1
pub struct $key_type_parser<I: Sized + Iterator<Item = $crate::errors::Result<$crate::packet::Packet>>> {
inner: std::iter::Peekable<I>,
}
impl<I: Sized + Iterator<Item = $crate::errors::Result<$crate::packet::Packet>>> $key_type_parser<I> {
pub fn into_inner(self) -> std::iter::Peekable<I> {
self.inner
}
pub fn from_packets (
packets: std::iter::Peekable<I>,
) -> Self {
$key_type_parser {
inner: packets,
}
}
}
impl<I: Sized + Iterator<Item = $crate::errors::Result<$crate::packet::Packet>>> Iterator for $key_type_parser<I> {
type Item = $crate::errors::Result<$key_type>;
fn next(&mut self) -> Option<Self::Item> {
use std::convert::TryInto;
use $crate::packet::{self, Signature, SignatureType, UserAttribute, UserId};
use $crate::types::{KeyVersion, SignedUser, SignedUserAttribute, Tag, KeyTrait};
let packets = self.inner.by_ref();
// Check if we are done
packets.peek()?;
// -- One Public-Key packet
// ignore random other packets until we find something useful
while let Some(packet) = packets.next_if(|p| {
p.as_ref().is_ok_and(|p| p.tag() != $key_tag)
}) {
match packet {
Ok(p) => {
warn!("ignoring unexpected packet: expected {:?}, got {:?}", $key_tag, p.tag());
// FIXME: return error?
},
Err(e) => return Some(Err(e)),
}
}
let next = match packets.next() {
Some(Ok(n)) => n,
Some(Err(e)) => return Some(Err(e)),
None => return None,
};
let primary_key: $inner_key_type = err_opt!(next.try_into());
debug!("primary key: {:?}", primary_key.key_id());
// -- Zero or more revocation signatures
// -- followed by zero or more direct signatures in V4 keys
debug!(" signatures");
let mut revocation_signatures = Vec::new();
let mut direct_signatures = Vec::new();
while let Some(packet) = packets.next_if(|p| {
p.as_ref().is_ok_and(|p| p.tag() == Tag::Signature)
}) {
match packet {
Ok(packet) => {
debug!("parsing signature {:?}", packet.tag());
let sig: Signature = err_opt!(packet.try_into());
let typ = sig.typ();
if typ == SignatureType::KeyRevocation {
revocation_signatures.push(sig);
} else {
if primary_key.version() != KeyVersion::V4 {
// no direct signatures on V2|V3 keys
warn!("unexpected signature: {:?}", typ);
}
direct_signatures.push(sig);
}
},
Err(e) => return Some(Err(e)),
}
}
// -- Zero or more User ID packets
// -- Zero or more User Attribute packets
debug!(" user");
let mut users = Vec::new();
let mut user_attributes = Vec::new();
while let Some(packet) = packets.next_if(|p| {
p.as_ref().is_ok_and(|p| {
debug!("peek {:?}", p.tag());
p.tag() == Tag::UserId || p.tag() == Tag::UserAttribute
})
}) {
let packet = match packet {
Ok(packet) => packet,
Err(err) => return Some(Err(err)),
};
let tag = packet.tag();
debug!(" user data: {:?}", tag);
match tag {
Tag::UserId => {
let id: UserId = err_opt!(packet.try_into());
// --- zero or more signature packets
let mut sigs = Vec::new();
while let Some(res) = packets.next_if(|p| {
p.as_ref().is_ok_and(|p| p.tag() == Tag::Signature)
}) {
let packet = match res {
Ok(packet) => packet,
Err(e) => return Some(Err(e)),
};
let sig: Signature = err_opt!(packet.try_into());
sigs.push(sig);
}
users.push(SignedUser::new(id, sigs));
}
Tag::UserAttribute => {
let attr: UserAttribute = err_opt!(packet.try_into());
// --- zero or more signature packets
let mut sigs = Vec::new();
while let Some(res) = packets.next_if(|p| {
p.as_ref().is_ok_and(|p| p.tag() == Tag::Signature)
}) {
let packet = match res {
Ok(packet) => packet,
Err(e) => return Some(Err(e)),
};
let sig: Signature = err_opt!(packet.try_into());
sigs.push(sig);
}
user_attributes.push(SignedUserAttribute::new(attr, sigs));
}
_ => break,
}
}
if users.is_empty() {
warn!("missing user ids");
}
// -- Zero or more Subkey packets
$(
let mut $subkey_container = vec![];
)*
debug!(" subkeys");
while let Some(res) = packets.next_if(|p|
p.as_ref().is_ok_and(|p| {
debug!(" peek {:?}", p.tag());
$( p.tag() == Tag::$subkey_tag || )* false
}
)) {
// -- Only V4 keys should have sub keys
if primary_key.version() != KeyVersion::V4 {
return Some(Err(format_err!("only V4 keys can have subkeys")));
}
let packet = match res {
Ok(packet) => packet,
Err(e) => return Some(Err(e)),
};
match packet.tag() {
$(
Tag::$subkey_tag => {
let subkey: $inner_subkey_type = err_opt!(packet.try_into());
let mut sigs = Vec::new();
while let Some(res) = packets.next_if(|packet| {
packet.is_ok() && packet.as_ref().unwrap().tag() == Tag::Signature
}) {
match res {
Ok(packet) => {
let sig: Signature = err_opt!(packet.try_into());
sigs.push(sig);
}
Err(e) => return Some(Err(e)),
}
}
$subkey_container.push(<$subkey_type>::new(subkey, sigs));
}
)*
_ => unreachable!()
}
}
Some(Ok(<$key_type>::new(
primary_key,
$crate::composed::signed_key::SignedKeyDetails::new(
revocation_signatures,
direct_signatures,
users,
user_attributes,
),
$( $subkey_container, )*
)))
}
}
impl $crate::composed::Deserializable for $key_type {
/// Parse a transferable key from packets.
/// Ref: https://tools.ietf.org/html/rfc4880.html#section-11.1
fn from_packets<'a, I: Iterator<Item = $crate::errors::Result<$crate::packet::Packet>> + 'a> (
packets: std::iter::Peekable<I>,
) -> Box<dyn Iterator<Item = $crate::errors::Result<Self>> + 'a> {
Box::new($key_type_parser::from_packets(packets))
}
}
};
}