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 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152
//! This crate deals with Autocrypt encoded data (see the [Autocrypt
//! Spec]).
//!
//! [Autocrypt Spec]: https://autocrypt.org/level1.html#openpgp-based-key-data
//!
//! # Scope
//!
//! This implements low-level functionality like encoding and decoding
//! of Autocrypt headers and setup messages. Note: Autocrypt is more
//! than just headers; it requires tight integration with the MUA.
#![doc(html_favicon_url = "https://docs.sequoia-pgp.org/favicon.png")]
#![doc(html_logo_url = "https://docs.sequoia-pgp.org/logo.svg")]
#![warn(missing_docs)]
use std::convert::TryFrom;
use std::io;
use std::io::prelude::*;
use std::io::BufReader;
use std::path::Path;
use std::fs::File;
use std::str;
use base64::Engine;
use base64::engine::general_purpose::STANDARD as base64std;
use sequoia_openpgp as openpgp;
use openpgp::armor;
use openpgp::Error;
pub use openpgp::Result;
use openpgp::Packet;
use openpgp::packet::SKESK;
use openpgp::cert::prelude::*;
use openpgp::parse::{
Parse,
PacketParserResult, PacketParser,
};
use openpgp::serialize::Serialize;
use openpgp::serialize::stream::{
Message, LiteralWriter, Encryptor,
};
use openpgp::crypto::Password;
use openpgp::policy::Policy;
use openpgp::types::RevocationStatus;
mod cert;
pub use cert::cert_builder;
/// Version of Autocrypt to use. `Autocrypt::default()` always returns the
/// latest version.
pub enum Autocrypt {
/// Autocrypt <= 1.0.1
V1,
/// Autocrypt version 1.1 (January 2019)
V1_1,
}
impl Default for Autocrypt {
fn default() -> Self { Autocrypt::V1_1 }
}
/// An autocrypt header attribute.
#[derive(Debug, PartialEq)]
pub struct Attribute {
/// Whether the attribute is critical.
pub critical: bool,
/// The attribute's name.
///
/// If the attribute is not critical, the leading underscore has
/// been stripped.
pub key: String,
/// The attribute's value.
pub value: String,
}
/// Whether the data comes from an "Autocrypt" or "Autocrypt-Gossip"
/// header.
#[derive(Debug, PartialEq)]
pub enum AutocryptHeaderType {
/// An "Autocrypt" header.
Sender,
/// An "Autocrypt-Gossip" header.
Gossip,
}
/// A parsed Autocrypt header.
#[derive(Debug, PartialEq)]
pub struct AutocryptHeader {
/// Whether this is an "Autocrypt" or "Autocrypt-Gossip" header.
pub header_type: AutocryptHeaderType,
/// The parsed key data.
pub key: Option<Cert>,
/// All attributes.
pub attributes: Vec<Attribute>,
}
impl AutocryptHeader {
fn empty(header_type: AutocryptHeaderType) -> Self {
AutocryptHeader {
header_type,
key: None,
attributes: Vec::new(),
}
}
/// Creates a new "Autocrypt" header.
pub fn new_sender<'a, P>(policy: &dyn Policy,
cert: &Cert, addr: &str, prefer_encrypt: P)
-> Result<Self>
where P: Into<Option<&'a str>>
{
// Minimize Cert.
let mut acc = Vec::new();
// The primary key and the most recent selfsig.
let primary = cert.primary_key().with_policy(policy, None)?;
acc.push(primary.key().clone().into());
primary.self_signatures().take(1)
.for_each(|s| acc.push(s.clone().into()));
// The subkeys and the most recent selfsig.
for skb in cert.keys().with_policy(policy, None).subkeys() {
// Skip if revoked.
if let RevocationStatus::Revoked(_) = skb.revocation_status() {
continue;
}
if skb.for_signing() || skb.for_transport_encryption() {
let k = skb.key().clone();
acc.push(k.into());
acc.push(skb.binding_signature().clone().into());
}
}
// The UserIDs matching ADDR.
let mut found_one = false;
for uidb in cert.userids().with_policy(policy, None) {
// XXX: Fix match once we have the rfc2822-name-addr.
if let Ok(Some(a)) = uidb.userid().email() {
if a == addr {
acc.push(uidb.userid().clone().into());
acc.push(uidb.binding_signature().clone().into());
found_one = true;
} else {
// Address is not matching.
continue;
}
} else {
// Malformed UserID.
continue;
}
}
// User ids are only decorative in Autocrypt. By convention,
// the cert should include a user id matching the sender's
// address, but we should include at least one user id.
if ! found_one {
if let Ok(uidb) = cert.with_policy(policy, None)?.primary_userid() {
acc.push(uidb.userid().clone().into());
acc.push(uidb.binding_signature().clone().into());
}
}
let cleaned_cert = Cert::try_from(acc)?;
Ok(AutocryptHeader {
header_type: AutocryptHeaderType::Sender,
key: Some(cleaned_cert),
attributes: vec![
Attribute {
critical: true,
key: "addr".into(),
value: addr.into(),
},
Attribute {
critical: true,
key: "prefer-encrypt".into(),
value: prefer_encrypt.into()
.unwrap_or("nopreference").into(),
},
],
})
}
/// Looks up an attribute.
pub fn get(&self, key: &str) -> Option<&Attribute> {
for a in &self.attributes {
if a.key == key {
return Some(a);
}
}
None
}
/// Writes a serialized version of the object to `o`.
pub fn serialize(&self, o: &mut dyn std::io::Write) -> Result<()> {
if self.key.is_none() {
return Err(Error::InvalidOperation("No key".into()).into());
}
for attr in self.attributes.iter() {
write!(o, "{}={}; ", attr.key, attr.value)?;
}
let mut buf = Vec::new();
self.key.as_ref().unwrap().serialize(&mut buf)?;
write!(o, "keydata={} ", base64std.encode(&buf))?;
Ok(())
}
}
/// A set of parsed Autocrypt headers.
#[derive(Debug, PartialEq)]
pub struct AutocryptHeaders {
/// The value in the from header.
pub from: Option<String>,
/// Any autocrypt headers.
pub headers: Vec<AutocryptHeader>,
}
impl AutocryptHeaders {
fn empty() -> Self {
AutocryptHeaders {
from: None,
headers: Vec::new(),
}
}
fn from_lines<I: Iterator<Item = io::Result<String>>>(mut lines: I)
-> Result<Self>
{
let mut headers = AutocryptHeaders::empty();
let mut next_line = lines.next();
while let Some(line) = next_line {
// Return any error.
let mut line = line?;
if line.is_empty() {
// End of headers.
break;
}
next_line = lines.next();
// If the line is folded (a line break was inserted in
// front of whitespace (either a space (0x20) or a
// horizontal tab (0x09)), then unfold it.
//
// See https://tools.ietf.org/html/rfc5322#section-2.2.3
while let Some(Ok(nl)) = next_line {
if !nl.is_empty() && (nl.starts_with(|c| c == ' ' || c == '\t'))
{
line.push_str(&nl);
next_line = lines.next();
} else {
// Put it back.
next_line = Some(Ok(nl));
break;
}
}
const AUTOCRYPT : &str = "Autocrypt: ";
const AUTOCRYPT_GOSSIP : &str = "Autocrypt-Gossip: ";
const FROM : &str = "From: ";
if let Some(rest) = line.strip_prefix(FROM) {
headers.from = Some(rest.trim_matches(' ').into());
} else {
if let Some((key, value)) =
if let Some(v) = line.strip_prefix(AUTOCRYPT) {
Some((AutocryptHeaderType::Sender, v))
} else if let Some(v) = line.strip_prefix(AUTOCRYPT_GOSSIP) {
Some((AutocryptHeaderType::Gossip, v))
} else {
None
}
{
headers.headers.push(
Self::decode_autocrypt_like_header(key, value));
}
}
}
Ok(headers)
}
/// Decode header that has the same format as the Autocrypt header.
/// This function should be called only on "Autocrypt" or "Autocrypt-Gossip"
/// headers.
fn decode_autocrypt_like_header(header_type: AutocryptHeaderType,
ac_value: &str)
-> AutocryptHeader
{
let mut header = AutocryptHeader::empty(header_type);
for pair in ac_value.split(';') {
let pair = pair
.splitn(2, '=')
.collect::<Vec<&str>>();
let (key, value) : (&str, String) = if pair.len() == 1 {
// No value...
(pair[0].trim_matches(' '), "".into())
} else {
(pair[0].trim_matches(' '),
pair[1].trim_matches(' ').into())
};
if key == "keydata" {
if let Ok(decoded) = base64std.decode(
&value.replace(' ', "")[..]) {
if let Ok(cert) = Cert::from_bytes(&decoded[..]) {
header.key = Some(cert);
}
}
}
let (critical, key) = if let Some(key) = key.strip_prefix('_') {
(true, key)
} else {
(false, key)
};
header.attributes.push(Attribute {
critical,
key: key.to_string(),
value,
});
}
header
}
/// Parses an autocrypt header.
///
/// `data` should be all of a mail's headers.
pub fn from_bytes(data: &[u8]) -> Result<Self> {
let lines = BufReader::new(io::Cursor::new(data)).lines();
Self::from_lines(lines)
}
/// Parses an autocrypt header.
///
/// `path` should name a file containing a single mail. If the
/// file is in mbox format, then only the first mail is
/// considered.
pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self> {
Self::from_reader(File::open(path)?)
}
/// Parses an autocrypt header.
///
/// `reader` contain a single mail. If it contains multiple
/// emails, then only the first mail is considered.
pub fn from_reader<R: io::Read>(reader: R) -> Result<Self> {
Self::from_lines(BufReader::new(reader).lines())
}
}
/// Holds an Autocrypt Setup Message.
///
/// An [Autocrypt Setup Message] is used to transfer a private key from
/// one device to another.
///
/// [Autocrypt Setup Message]:
/// https://autocrypt.org/level1.html#autocrypt-setup-message
#[derive(Debug, PartialEq)]
pub struct AutocryptSetupMessage {
prefer_encrypt: Option<String>,
passcode_format: Option<String>,
passcode: Option<Password>,
// We only emit a "Passcode-Begin" header if this is set. Note:
// we don't check if this actually matches the start of the
// passcode.
passcode_begin: Option<String>,
cert: Cert,
}
impl AutocryptSetupMessage {
/// Creates a new Autocrypt Setup Message for the specified `Cert`.
///
/// You can set the `prefer_encrypt` setting, which defaults to
/// "nopreference", using `set_prefer_encrypt`.
///
/// Note: this generates a random passcode. To retrieve the
/// passcode, use the `passcode` method.
///
/// To decode an Autocrypt Setup Message, use the `from_bytes` or
/// `from_reader` methods.
pub fn new(cert: Cert) -> Self {
AutocryptSetupMessage {
prefer_encrypt: None,
passcode: None,
passcode_format: None,
passcode_begin: None,
cert,
}
}
/// Sets the prefer encrypt header.
pub fn set_prefer_encrypt(mut self, value: &str) -> Self {
self.prefer_encrypt = Some(value.into());
self
}
/// Returns the prefer encrypt header.
pub fn prefer_encrypt(&self) -> Option<&str> {
self.prefer_encrypt.as_ref().map(|v| &v[..])
}
/// Sets the "Passcode-Format" header.
pub fn set_passcode_format(mut self, value: &str) -> Self {
self.passcode_format = Some(value.into());
self
}
/// Returns the "Passcode-Format" header.
pub fn passcode_format(&self) -> Option<&str> {
self.passcode_format.as_ref().map(|v| &v[..])
}
/// Sets the passcode.
pub fn set_passcode(mut self, passcode: Password) -> Self {
self.passcode = Some(passcode);
self
}
/// Returns the ASM's passcode.
///
/// If the passcode has not yet been generated, this returns
/// `None`.
pub fn passcode(&self) -> Option<&Password> {
self.passcode.as_ref()
}
/// Sets the "Passcode-Begin" header.
pub fn set_passcode_begin(mut self, value: &str) -> Self {
self.passcode_begin = Some(value.into());
self
}
/// Returns the "Passcode-Begin" header.
pub fn passcode_begin(&self) -> Option<&str> {
self.passcode_begin.as_ref().map(|v| &v[..])
}
// Generates a new passcode in "numeric9x4" format.
fn passcode_gen() -> Password {
use openpgp::crypto::mem;
// Generate a random passcode.
// The passcode consists of 36 digits, which encode
// approximately 119 bits of information. 120 bits = 15
// bytes.
let mut p_as_vec = mem::Protected::from(vec![0; 15]);
openpgp::crypto::random(&mut p_as_vec[..]);
// Turn it into a 128-bit number.
let mut p_as_u128 = 0u128;
for v in p_as_vec.iter() {
p_as_u128 = (p_as_u128 << 8) + *v as u128;
}
// Turn it into ASCII.
let mut p : Vec<u8> = Vec::new();
for i in 0..36 {
if i > 0 && i % 4 == 0 {
p.push(b'-');
}
p.push(b'0' + ((p_as_u128 as u8) % 10));
p_as_u128 /= 10;
}
p.into()
}
/// If there is no passcode, generates one.
fn passcode_ensure(&mut self) {
if self.passcode.is_some() {
return;
}
let passcode = Self::passcode_gen();
self.passcode_format = Some("numeric9x4".into());
self.passcode_begin = passcode.map(|p| {
Some(str::from_utf8(&p[..2]).unwrap().into())
});
self.passcode = Some(passcode);
}
/// Generates the Autocrypt Setup Message.
///
/// The message is written to `w`.
pub fn serialize<W>(&mut self, w: &mut W) -> Result<()>
where W: io::Write + Send + Sync,
{
// The outer message is an ASCII-armored encoded message
// containing a single SK-ESK and a single SEIP packet. The
// SEIP packet contains a literal data packet whose content is
// the inner message.
self.passcode_ensure();
let mut headers : Vec<(&str, &str)> = Vec::new();
if let Some(ref format) = self.passcode_format {
headers.push(
("Passphrase-Format", &format[..]));
}
if let Some(ref begin) = self.passcode_begin {
headers.push(
("Passphrase-Begin", &begin[..]));
}
let mut armor_writer =
armor::Writer::with_headers(w, armor::Kind::Message, headers)?;
{
// Passphrase-Format header with value numeric9x4
let m = Message::new(&mut armor_writer);
let m = Encryptor::with_passwords(
m, vec![self.passcode.clone().unwrap()]).build()?;
let m = LiteralWriter::new(m).build()?;
// The inner message is an ASCII-armored encoded Cert.
let mut w = armor::Writer::with_headers(
m, armor::Kind::SecretKey,
vec![("Autocrypt-Prefer-Encrypt",
self.prefer_encrypt().unwrap_or("nopreference"))])?;
self.cert.as_tsk().serialize(&mut w)?;
let m = w.finalize()?;
m.finalize()?;
}
armor_writer.finalize()?;
Ok(())
}
/// Parses the autocrypt setup message in `r`.
///
/// `passcode` is the passcode used to protect the message.
pub fn from_bytes(bytes: &[u8])
-> Result<AutocryptSetupMessageParser>
{
Self::from_reader(bytes)
}
/// Parses the autocrypt setup message in `r`.
///
/// `passcode` is the passcode used to protect the message.
pub fn from_reader<'a, R: io::Read + Send + Sync + 'a>(r: R)
-> Result<AutocryptSetupMessageParser<'a>> {
// The outer message uses ASCII-armor. It includes a password
// hint. Hence, we need to parse it aggressively.
let mut r = armor::Reader::from_reader(
r, armor::ReaderMode::Tolerant(Some(armor::Kind::Message)));
// Note, it is essential that we call r.headers here so that
// we can return any error now and not in
// AutocryptSetupMessageParser::header.
let (format, begin) = {
let headers = r.headers()?;
let format = headers.iter()
.filter_map(|(k, v)| {
if k == "Passphrase-Format" { Some(v) } else { None }
})
.collect::<Vec<&String>>();
let format = if !format.is_empty() {
// If there are multiple headers, then just silently take
// the first one.
Some(format[0].clone())
} else {
None
};
let begin = headers.iter()
.filter_map(|(k, v)| {
if k == "Passphrase-Begin" { Some(v) } else { None }
})
.collect::<Vec<&String>>();
let begin = if !begin.is_empty() {
// If there are multiple headers, then just silently take
// the first one.
Some(begin[0].clone())
} else {
None
};
(format, begin)
};
// Get the first packet, which is the SK-ESK packet.
let mut ppr = PacketParser::from_reader(r)?;
// The outer message consists of exactly three packets: a
// SK-ESK and a SEIP packet, which contains a Literal data
// packet.
let pp = if let PacketParserResult::Some(pp) = ppr {
pp
} else {
return Err(
Error::MalformedMessage(
"Premature EOF: expected an SK-ESK, encountered EOF".into())
.into());
};
let (packet, ppr_) = pp.next()?;
ppr = ppr_;
let skesk = match packet {
Packet::SKESK(skesk) => skesk,
p => return Err(
Error::MalformedMessage(
format!("Expected a SKESK packet, found a {}", p.tag()))
.into()),
};
let pp = match ppr {
PacketParserResult::EOF(_) =>
return Err(
Error::MalformedMessage(
"Pre-mature EOF after reading SK-ESK packet".into())
.into()),
PacketParserResult::Some(pp) => {
match pp.packet {
Packet::SEIP(_) => (),
ref p => return Err(
Error::MalformedMessage(
format!("Expected a SEIP packet, found a {}",
p.tag()))
.into()),
}
pp
}
};
Ok(AutocryptSetupMessageParser {
passcode_format: format,
passcode_begin: begin,
skesk,
pp,
passcode: None,
})
}
/// Returns the Cert consuming the `AutocryptSetupMessage` in the
/// process.
pub fn into_cert(self) -> Cert {
self.cert
}
}
/// A Parser for an `AutocryptSetupMessage`.
pub struct AutocryptSetupMessageParser<'a> {
passcode_format: Option<String>,
passcode_begin: Option<String>,
skesk: SKESK,
pp: PacketParser<'a>,
passcode: Option<Password>,
}
impl<'a> AutocryptSetupMessageParser<'a> {
/// Returns the "Passcode-Format" header.
pub fn passcode_format(&self) -> Option<&str> {
self.passcode_format.as_ref().map(|v| &v[..])
}
/// Returns the "Passcode-Begin" header.
pub fn passcode_begin(&self) -> Option<&str> {
self.passcode_begin.as_ref().map(|v| &v[..])
}
/// Tries to decrypt the message.
///
/// On success, follow up with
/// `AutocryptSetupMessageParser::parse()` to extract the
/// `AutocryptSetupMessage`.
pub fn decrypt(&mut self, passcode: &Password) -> Result<()> {
if self.pp.processed() {
return Err(
Error::InvalidOperation("Already decrypted".into()).into());
}
let (algo, key) = self.skesk.decrypt(passcode)?;
self.pp.decrypt(algo, &key)?;
self.passcode = Some(passcode.clone());
Ok(())
}
/// Finishes parsing the `AutocryptSetupMessage`.
///
/// Before calling this, you must decrypt the payload using
/// `decrypt`.
///
/// If the payload has not been decrypted, returns
/// `Error::InvalidOperation`.
///
/// If the payload is malformed, returns
/// `Error::MalformedMessage`.
pub fn parse(self) -> Result<AutocryptSetupMessage> {
if ! self.pp.processed() {
return Err(
Error::InvalidOperation("Not decrypted".into()).into());
}
// Recurse into the SEIP packet.
let mut ppr = self.pp.recurse()?.1;
if ppr.as_ref().map(|pp| pp.recursion_depth()).ok() != Some(1) {
return Err(
Error::MalformedMessage(
"SEIP container empty, but expected a Literal Data packet"
.into())
.into());
}
// Get the literal data packet.
let (prefer_encrypt, cert) = if let PacketParserResult::Some(mut pp) = ppr {
match pp.packet {
Packet::Literal(_) => (),
p => return Err(Error::MalformedMessage(
format!("SEIP container contains a {}, \
expected a Literal Data packet",
p.tag())).into()),
}
// The inner message consists of an ASCII-armored encoded
// Cert.
let (prefer_encrypt, cert) = {
let mut r = armor::Reader::from_reader(
&mut pp,
armor::ReaderMode::Tolerant(
Some(armor::Kind::SecretKey)));
let prefer_encrypt = {
let headers = r.headers()?;
let prefer_encrypt = headers.iter()
.filter_map(|(k, v)| {
if k == "Autocrypt-Prefer-Encrypt" {
Some(v)
} else {
None
}
})
.collect::<Vec<&String>>();
if !prefer_encrypt.is_empty() {
// If there are multiple headers, then just
// silently take the first one.
Some(prefer_encrypt[0].clone())
} else {
None
}
};
let cert = Cert::from_reader(r)?;
(prefer_encrypt, cert)
};
ppr = pp.recurse()?.1;
(prefer_encrypt, cert)
} else {
return Err(
Error::MalformedMessage(
"Pre-mature EOF after reading SEIP packet".into())
.into());
};
// Get the MDC packet.
if let PacketParserResult::Some(pp) = ppr {
match pp.packet {
Packet::MDC(_) => (),
ref p => return
Err(Error::MalformedMessage(
format!("Expected an MDC packet, got a {}",
p.tag()))
.into()),
}
ppr = pp.recurse()?.1;
}
// Make sure we reached the end of the outer message.
match ppr {
PacketParserResult::EOF(pp) => {
// If we've gotten this far, then the outer message
// has the right sequence of packets, but we haven't
// carefully checked the nesting. We do that now.
if let Err(err) = pp.is_message() {
return Err(err.context("Invalid OpenPGP Message"));
}
}
PacketParserResult::Some(pp) =>
return Err(Error::MalformedMessage(
format!("Extraneous packet: {}.", pp.packet.tag()))
.into()),
}
// We're done!
Ok(AutocryptSetupMessage {
prefer_encrypt,
passcode: self.passcode,
passcode_format: self.passcode_format,
passcode_begin: self.passcode_begin,
cert,
})
}
}
#[cfg(test)]
mod test {
use super::*;
use openpgp::policy::StandardPolicy as P;
#[test]
fn decode_test() {
let ac = AutocryptHeaders::from_bytes(
&include_bytes!("../tests/data/hpk.txt")[..]
)
.unwrap();
//eprintln!("ac: {:#?}", ac);
// We expect exactly one Autocrypt header.
assert_eq!(ac.headers.len(), 1);
assert_eq!(ac.headers[0].header_type, AutocryptHeaderType::Sender);
assert_eq!(ac.headers[0].get("addr").unwrap().value,
"holger@merlinux.eu");
assert_eq!(ac.headers[0].get("prefer-encrypt").unwrap().value,
"mutual");
let cert = ac.headers[0].key.as_ref()
.expect("Failed to parse key material.");
assert_eq!(cert.fingerprint(),
"156962B0F3115069ACA970C68E3B03A279B772D6".parse().unwrap());
assert_eq!(cert.userids().next().unwrap().value(),
&b"holger krekel <holger@merlinux.eu>"[..]);
let ac = AutocryptHeaders::from_bytes(
&include_bytes!("../tests/data/vincent.txt")[..]
)
.unwrap();
//eprintln!("ac: {:#?}", ac);
assert_eq!(ac.from,
Some("Vincent Breitmoser <look@my.amazin.horse>".into()));
// We expect exactly one Autocrypt header.
assert_eq!(ac.headers.len(), 1);
assert_eq!(ac.headers[0].get("addr").unwrap().value,
"look@my.amazin.horse");
assert!(ac.headers[0].get("prefer_encrypt").is_none());
let cert = ac.headers[0].key.as_ref()
.expect("Failed to parse key material.");
assert_eq!(cert.fingerprint(),
"D4AB192964F76A7F8F8A9B357BD18320DEADFA11".parse().unwrap());
assert_eq!(cert.userids().next().unwrap().value(),
&b"Vincent Breitmoser <look@my.amazin.horse>"[..]);
let ac = AutocryptHeaders::from_bytes(
&include_bytes!("../tests/data/patrick.txt")[..]
)
.unwrap();
//eprintln!("ac: {:#?}", ac);
assert_eq!(ac.from,
Some("Patrick Brunschwig <patrick@enigmail.net>".into()));
// We expect exactly one Autocrypt header.
assert_eq!(ac.headers.len(), 1);
assert_eq!(ac.headers[0].get("addr").unwrap().value,
"patrick@enigmail.net");
assert!(ac.headers[0].get("prefer_encrypt").is_none());
let cert = ac.headers[0].key.as_ref()
.expect("Failed to parse key material.");
assert_eq!(cert.fingerprint(),
"4F9F89F5505AC1D1A260631CDB1187B9DD5F693B".parse().unwrap());
assert_eq!(cert.userids().next().unwrap().value(),
&b"Patrick Brunschwig <patrick@enigmail.net>"[..]);
let ac2 = AutocryptHeaders::from_bytes(
&include_bytes!("../tests/data/patrick_unfolded.txt")[..]
)
.unwrap();
assert_eq!(ac, ac2);
}
#[test]
fn decode_gossip() {
let ac = AutocryptHeaders::from_bytes(
&include_bytes!("../tests/data/gossip.txt")[..]
)
.unwrap();
//eprintln!("ac: {:#?}", ac);
// We expect exactly two Autocrypt headers.
assert_eq!(ac.headers.len(), 2);
assert_eq!(ac.headers[0].header_type, AutocryptHeaderType::Gossip);
assert_eq!(ac.headers[0].get("addr").unwrap().value,
"dkg@fifthhorseman.net");
assert_eq!(ac.headers[1].get("addr").unwrap().value,
"neal@walfield.org");
let cert = ac.headers[0].key.as_ref()
.expect("Failed to parse key material.");
assert_eq!(cert.fingerprint(),
"C4BC2DDB38CCE96485EBE9C2F20691179038E5C6".parse().unwrap());
assert_eq!(cert.userids().next().unwrap().value(),
&b"Daniel Kahn Gillmor <dkg@fifthhorseman.net>"[..]);
}
#[test]
fn passcode_gen_test() {
let mut dist = [0usize; 10];
let samples = 8 * 1024;
// 36 digits grouped into four digits, each group
// separated by a dash.
let digits = 36;
let passcode_len = 36 + (36 / 4 - 1);
for _ in 0..samples {
let p = AutocryptSetupMessage::passcode_gen();
p.map(|p| {
assert_eq!(p.len(), passcode_len);
for c in p.iter() {
match *c as char {
'0'|'1'|'2'|'3'|'4'|'5'|'6'|'7'|'8'|'9' => {
let i = *c as usize - ('0' as usize);
dist[i] = dist[i] + 1
},
'-' => (),
_ => panic!("Unexpected character in passcode: {}", c),
}
}
});
}
// Make sure the distribution is reasonable. If this runs
// long enough, then of course, this test will eventually
// fail. But, it is extremely unlikely and suggests a failure
// in the random number generator or the code.
let expected_value = (samples * digits) as f32 / 10.;
// We expect each digit to occur within 10% of its expected
// value.
let lower = (expected_value * 0.9) as usize;
let upper = (expected_value * 1.1) as usize;
let expected_value = expected_value as usize;
eprintln!("Distribution (expected value: {}, bounds: {}..{}):",
expected_value, lower, upper);
let mut bad = 0;
for (i, count) in dist.iter()
.map(|x| *x)
.enumerate()
.collect::<Vec<(usize, usize)>>()
{
let is_good = lower < count && count < upper;
eprintln!("{}: {} occurrences{}.",
i, count, if is_good { "" } else { " UNLIKELY" });
if !is_good {
bad = bad + 1;
}
}
// Allow one digit to be out of the bounds.
//
// Dear developer: if this test has failed more than once for
// you over years of development, then there is almost
// certainly a bug! Report it, please!
assert!(bad <= 1);
}
#[test]
fn autocrypt_setup_message() {
// Try the example autocrypt setup message.
let mut asm = AutocryptSetupMessage::from_bytes(
&include_bytes!("../tests/data/setup-message.txt")[..]).unwrap();
// A bad passcode.
assert!(asm.decrypt(&"123".into()).is_err());
// Now the right one.
assert!(asm.decrypt(
&"1742-0185-6197-1303-7016-8412-3581-4441-0597".into()
).is_ok());
let asm = asm.parse().unwrap();
// A basic check to make sure we got the key.
assert_eq!(asm.into_cert().fingerprint(),
"E604 68CE 44D7 7C3F CE9F D072 71DB C565 7FDE 65A7".parse()
.unwrap());
// Create an ASM for testy-private. Then decrypt it and make
// sure the Cert, etc. survived the round trip.
let cert =
Cert::from_bytes(&include_bytes!("../tests/data/testy-private.pgp")[..])
.unwrap();
let mut asm = AutocryptSetupMessage::new(cert)
.set_prefer_encrypt("mutual");
let mut buffer = Vec::new();
asm.serialize(&mut buffer).unwrap();
let mut asm2 = AutocryptSetupMessage::from_bytes(&buffer[..]).unwrap();
asm2.decrypt(asm.passcode().unwrap()).unwrap();
let asm2 = asm2.parse().unwrap();
assert_eq!(asm, asm2);
}
#[test]
fn autocrypt_header_new() {
let p = &P::new();
let cert = Cert::from_bytes(&include_bytes!("../tests/data/testy.pgp")[..])
.unwrap();
let header = AutocryptHeader::new_sender(p, &cert, "testy@example.org",
"mutual").unwrap();
let mut buf = Vec::new();
write!(&mut buf, "Autocrypt: ").unwrap();
header.serialize(&mut buf).unwrap();
let ac = AutocryptHeaders::from_bytes(&buf).unwrap();
// We expect exactly one Autocrypt header.
assert_eq!(ac.headers.len(), 1);
assert_eq!(ac.headers[0].get("addr").unwrap().value,
"testy@example.org");
assert_eq!(ac.headers[0].get("prefer-encrypt").unwrap().value,
"mutual");
let cert = ac.headers[0].key.as_ref()
.expect("Failed to parse key material.");
assert_eq!(&cert.fingerprint().to_hex(),
"3E8877C877274692975189F5D03F6F865226FE8B");
assert_eq!(cert.userids().len(), 1);
assert_eq!(cert.keys().subkeys().count(), 1);
assert_eq!(cert.userids().next().unwrap().userid().value(),
&b"Testy McTestface <testy@example.org>"[..]);
}
#[test]
fn autocrypt_header_new_address_mismatch() -> Result<()> {
let p = &P::new();
let cert =
Cert::from_bytes(&include_bytes!("../tests/data/testy.pgp")[..])?;
let header = AutocryptHeader::new_sender(p, &cert,
"anna-lena@example.org",
"mutual")?;
let mut buf = Vec::new();
write!(&mut buf, "Autocrypt: ")?;
header.serialize(&mut buf)?;
let ac = AutocryptHeaders::from_bytes(&buf)?;
// We expect exactly one Autocrypt header.
assert_eq!(ac.headers.len(), 1);
assert_eq!(ac.headers[0].get("addr").unwrap().value,
"anna-lena@example.org");
assert_eq!(ac.headers[0].get("prefer-encrypt").unwrap().value,
"mutual");
let cert = ac.headers[0].key.as_ref()
.expect("Failed to parse key material.");
assert_eq!(&cert.fingerprint().to_hex(),
"3E8877C877274692975189F5D03F6F865226FE8B");
assert_eq!(cert.userids().len(), 1);
assert_eq!(cert.keys().subkeys().count(), 1);
assert_eq!(cert.userids().next().unwrap().userid().value(),
&b"Testy McTestface <testy@example.org>"[..]);
Ok(())
}
/// Demonstrates a panic in the AutocryptHeader parser.
#[test]
fn issue_743() {
let data: Vec<u8> = vec![
0x41, 0x75, 0x02, 0x01, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x20,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x11, 0x00, 0x0a, 0xc4,
0x83, 0x40, 0x39, 0x0a, 0x38, 0x0a, 0x0a, 0x0a, 0x0a, 0x0a, 0x0a,
0x20, 0x74, 0x6f, 0x63, 0x72, 0x79, 0x70, 0x74, 0x3a, 0x00, 0x00,
0x0a, 0x0a, 0x0a, 0x0a, 0x3d, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x11, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x01, 0x35, 0x39, 0x33, 0x35, 0x38, 0x36, 0x34, 0x00, 0x00,
0x01, 0x00, 0x00, 0x00, 0x3e, 0x3f, 0x00, 0x08, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x11, 0x00, 0x3e, 0x08,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x3e, 0x01, 0x08, 0x00,
0x00, 0x41, 0x75, 0x74, 0x6f, 0x63, 0x72, 0x79, 0x20, 0x02, 0x01,
0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x01, 0x70,
];
let _ = AutocryptHeaders::from_bytes(&data);
}
#[test]
fn issue_1012() {
let data: Vec<u8> = vec![
0x41, 0x75, 0x74, 0x6f, 0x63, 0x72, 0x79, 0x70, 0x74, 0x2d, 0x47, 0x6f, 0x73, 0x73, 0x69,
0x70, 0x3a, 0x20, 0xc8, 0x84, 0x01, 0x42, 0x04, 0x0a, 0x00, 0x00, 0x00, 0x25, 0x25, 0x25,
0x25, 0x42, 0x25, 0x3f, 0x21, 0x25, 0x25, 0x25, 0x25, 0x25, 0x25, 0x25, 0x25, 0x25, 0x25,
0x25, 0x25, 0x25, 0x25, 0x25, 0x25, 0x00, 0x40, 0x25, 0x25, 0x25, 0x25, 0x25, 0x25, 0x25,
0x25, 0x22, 0x6b, 0x25, 0x25, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x25, 0x25, 0x25, 0x25, 0x25,
0x25, 0x25, 0x00, 0x00, 0x00, 0x00, 0x40, 0x00, 0x00, 0x00, 0x25, 0x25, 0x25, 0x25, 0x25,
0x25, 0x25, 0x25, 0x25, 0x25, 0x25, 0x25,
];
AutocryptHeaders::from_bytes(&data).expect("parses");
}
}