summaryrefslogtreecommitdiffstats
path: root/src/openpgp/subpackets.rs
blob: 1f50a5119d2bfbd4b6c6d66b929d068f84bea2b4 (plain)
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
use std::io::Error;

use super::*;
use ::buffered_reader::*;

#[derive(Debug)]
#[derive(FromPrimitive)]
#[derive(ToPrimitive)]
#[derive(PartialEq)]
#[derive(Clone, Copy)]
pub enum SubpacketTag {
    Reserved0 = 0,
    Reserved1 = 1,
    SignatureCreationTime = 2,
    SignatureExpirationTime = 3,
    ExportableCertification = 4,
    TrustSignature = 5,
    RegularExpression = 6,
    Revocable = 7,
    Reserved = 8,
    KeyExpirationTime = 9,
    PlaceholderForBackwardCompatibility = 10,
    PreferredSymmetricAlgorithms = 11,
    RevocationKey = 12,
    Reserved13 = 13,
    Reserved14 = 14,
    Reserved15 = 15,
    Issuer = 16,
    Reserved17 = 17,
    Reserved18 = 18,
    Reserved19 = 19,
    NotationData = 20,
    PreferredHashAlgorithms = 21,
    PreferredCompressionAlgorithms = 22,
    KeyServerPreferences = 23,
    PreferredKeyServer = 24,
    PrimaryUserID = 25,
    PolicyURI = 26,
    KeyFlags = 27,
    SignersUserID = 28,
    ReasonForRevocation = 29,
    Features = 30,
    SignatureTarget = 31,
    EmbeddedSignature = 32,
    // Added in RFC 4880bis.
    IssuerFingerprint = 33,
    Private100 = 100,
    Private101 = 101,
    Private102 = 102,
    Private103 = 103,
    Private104 = 104,
    Private105 = 105,
    Private106 = 106,
    Private107 = 107,
    Private108 = 108,
    Private109 = 109,
    Private110 = 110,
}

#[derive(Debug,Clone)]
pub struct Subpacket<'a> {
    critical: bool,
    tag: SubpacketTag,
    value: &'a str,
}

/// Decode a subpacket length as described in Section 5.2.3.1 of RFC 4880.
fn subpacket_length(bio: &mut BufferedReaderMemory)
      -> Result<u32, Error> {
    let octet1 = bio.data_consume_hard(1)?[0];
    if octet1 < 192 {
        // One octet.
        return Ok(octet1 as u32);
    }
    if 192 <= octet1 && octet1 < 255 {
        // Two octets length.
        let octet2 = bio.data_consume_hard(1)?[0];
        return Ok(((octet1 as u32 - 192) << 8) + octet2 as u32 + 192);
    }

    // Five octets.
    assert_eq!(octet1, 255);
    return Ok(bio.read_be_u32()?);
}

impl Signature {
    fn subpackets_init(&self) -> Result<(), Error> {
        if self.hashed_area_parsed.borrow().is_some() {
            return Ok(());
        }

        let mut bio = BufferedReaderMemory::new(&self.hashed_area.as_slice());

        let mut hash = HashMap::new();

        while bio.data(1)?.len() > 0 {
            let len = subpacket_length(&mut bio)?;

            if bio.total_out() + len as usize > self.hashed_area.len() {
                // Subpacket extends beyond the end of the hashed
                // area.  Skip it.
                eprintln!("Invalid subpacket: subpacket extends beyond \
                           end of hashed area ([{}..{}); {}).",
                          bio.total_out(), len, self.hashed_area.len());
                break;
            }

            if len == 0 {
                // Hmm, a zero length packet.  In that case, there is
                // no header.
                continue;
            }

            let tag : u8 = bio.data_consume_hard(1)?[0];
            let len = len - 1;

            // The critical bit is the high bit.  Extract it.
            let critical = tag & (1 << 7) != 0;
            // Then clear it from the type.
            let tag = tag & !(1 << 7);

            let start = bio.total_out();
            assert!(start <= std::u16::MAX as usize);
            assert!(len <= std::u16::MAX as u32);

            hash.insert(tag, (critical, bio.total_out() as u16, len as u16));

            bio.consume(len as usize);
        }

        *self.hashed_area_parsed.borrow_mut() = Some(hash);

        return Ok(());
    }

    pub fn subpacket<'a>(&'a self, tag: u8) -> Option<(bool, &'a [u8])> {
        let _ = self.subpackets_init();

        match self.hashed_area_parsed.borrow().as_ref().unwrap().get(&tag) {
            Some(&(critical, start, len)) =>
                Some((critical,
                      &self.hashed_area[start as usize
                                        ..start as usize + len as usize])),
            None => None,
        }
    }

    pub fn signature_create_time(&self) {
        let _value = self.subpacket(SubpacketTag::SignatureCreationTime as u8);
        unimplemented!();
    }

    pub fn signature_expiration_time(&self) {
        let _value = self.subpacket(SubpacketTag::SignatureExpirationTime as u8);
        unimplemented!();
    }

    // ExportableCertification
    // TrustSignature
    // RegularExpression
    // Revocable
    // KeyExpirationTime
    // PreferredSymmetricAlgorithms
    // RevocationKey
    // Issuer
    // NotationData
    // PreferredHashAlgorithms
    // PreferredCompressionAlgorithms
    // KeyServerPreferences
    // PreferredKeyServer
    // PrimaryUserID
    // PolicyURI
    // KeyFlags
    // SignersUserID
    // ReasonForRevocation
    // Features
    // SignatureTarget
    // EmbeddedSignature

    pub fn issuer_fingerprint<'a>(&'a self) -> Option<(bool, &'a[u8])> {
        self.subpacket(SubpacketTag::IssuerFingerprint as u8)
    }
}

#[test]
fn subpacket_test_1 () {
    use std::path::PathBuf;
    use std::fs::File;

    let path : PathBuf = [env!("CARGO_MANIFEST_DIR"),
                          "src", "openpgp", "parse",
                          "signed.gpg"]
        .iter().collect();
    let mut f = File::open(&path).expect(&path.to_string_lossy());
    let bio = BufferedReaderGeneric::new(&mut f, None);
    let message = Message::deserialize(bio, None).unwrap();
    eprintln!("Message has {} top-level packets.", message.packets.len());
    eprintln!("Message: {:?}", message);

    let mut count = 0;
    for (i, p) in message.iter().enumerate() {