sequoia-sq 1.4.0

Command-line frontends for Sequoia
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

use std::io;

use buffered_reader::BufferedReader;
use buffered_reader::Dup;
use buffered_reader::Limitor;

use sequoia_openpgp as openpgp;
use openpgp::Packet;
use openpgp::armor;
use openpgp::parse::Cookie;
use openpgp::parse::Parse;
use openpgp::parse::PacketParser;
use openpgp::parse::PacketParserResult;

use crate::Sq;
use crate::Result;
use crate::cli;

/// How much data to look at when detecting armor kinds.
const ARMOR_DETECTION_LIMIT: u64 = 1 << 24;

/// Peeks at the first packet to guess the type.
///
/// Returns the given reader unchanged.  If the detection fails,
/// armor::Kind::File is returned as safe default.
fn detect_armor_kind<'a, B, C>(input: B)
    -> armor::Kind
where B: BufferedReader<C>,
      C: Default + std::fmt::Debug + Sync + Send,
{
    let dup = Dup::with_cookie(input, C::default());
    let limitor = Limitor::with_cookie(
        dup, ARMOR_DETECTION_LIMIT, C::default());
    let kind = match PacketParser::from_reader(limitor) {
        Ok(PacketParserResult::Some(pp)) => match pp.next() {
            Ok((Packet::Signature(_), _)) => armor::Kind::Signature,
            Ok((Packet::SecretKey(_), _)) => armor::Kind::SecretKey,
            Ok((Packet::PublicKey(_), _)) => armor::Kind::PublicKey,
            Ok((Packet::PKESK(_), _)) => armor::Kind::Message,
            Ok((Packet::SKESK(_), _)) => armor::Kind::Message,
            _ => armor::Kind::File,
        },
        _ => armor::Kind::File,
    };
    kind
}

pub fn dispatch(sq: Sq, command: cli::packet::armor::Command)
    -> Result<()>
{
    tracer!(TRACE, "armor::dispatch");

    let mut input = command.input.open("the data to encode")?;
    let mut want_kind: Option<armor::Kind>
        = command.kind.into();

    // Peek at the data.  If it looks like it is armored
    // data, avoid armoring it again.
    let dup = Dup::with_cookie(&mut input, Cookie::default());
    let mut limitor = Limitor::with_cookie(
        dup, ARMOR_DETECTION_LIMIT, Cookie::default());
    let (already_armored, have_kind) = {
        let mut reader =
            armor::Reader::from_buffered_reader(
                &mut limitor,
                armor::ReaderMode::Tolerant(None))?;
        (reader.data(8).is_ok(), reader.kind())
    };

    if already_armored
        && (want_kind.is_none() || want_kind == have_kind)
    {
        // It is already armored and has the correct kind.
        let mut output = command.output.create_safe(&sq)?;
        io::copy(&mut input, &mut output)?;
        return Ok(());
    }

    if want_kind.is_none() {
        let kind = detect_armor_kind(&mut input);
        want_kind = Some(kind);
    }

    // At this point, want_kind is determined.
    let want_kind = want_kind.expect("given or detected");

    let mut output =
        command.output.create_pgp_safe(&sq, false, want_kind)?;

    if already_armored {
        // Dearmor and copy to change the type.
        let mut reader =
            armor::Reader::from_buffered_reader(
                input,
                armor::ReaderMode::Tolerant(None))?;
        io::copy(&mut reader, &mut output)?;
    } else {
        io::copy(&mut input, &mut output)?;
    }
    output.finalize()?;

    Ok(())
}