1
//! Code for constructing and signing certificates.
2
//!
3
//! Only available when the crate is built with the `encode` feature.
4

            
5
use crate::{
6
    CertEncodeError, CertExt, Ed25519Cert, Ed25519CertConstructor, ExtType, SignedWithEd25519Ext,
7
    UnrecognizedExt,
8
};
9
use std::time::{Duration, SystemTime};
10
use tor_bytes::{EncodeResult, Writeable, Writer};
11
use tor_llcrypto::pk::ed25519::{self, Ed25519PublicKey, Ed25519SigningKey};
12

            
13
use derive_more::{AsRef, Deref, Into};
14

            
15
/// An encoded ed25519 certificate,
16
/// created using [`Ed25519CertConstructor::encode_and_sign`].
17
///
18
/// The certificate is encoded in the format specified
19
/// in Tor's cert-spec.txt.
20
///
21
/// This certificate has already been validated.
22
#[derive(Clone, Debug, PartialEq, Into, AsRef, Deref)]
23
pub struct EncodedEd25519Cert(Vec<u8>);
24

            
25
impl Ed25519Cert {
26
    /// Return a new `Ed25519CertConstructor` to create and return a new signed
27
    /// `Ed25519Cert`.
28
35445
    pub fn constructor() -> Ed25519CertConstructor {
29
35445
        Default::default()
30
35445
    }
31
}
32

            
33
impl EncodedEd25519Cert {
34
    /// Create an `EncodedEd25519Cert` from a byte slice.
35
    ///
36
    /// **Important**: generally you should not use this function.
37
    /// Instead, prefer using [`Ed25519CertConstructor::encode_and_sign`]
38
    /// to encode certificates.
39
    ///
40
    /// This function should only be used if `cert`
41
    /// is known to be the byte representation of a valid `EncodedEd25519Cert`
42
    /// (for example, after parsing the byte slice using [`Ed25519Cert::decode`],
43
    /// and validating its signature and timeliness).
44
    #[cfg(feature = "experimental-api")]
45
    pub fn dangerously_from_bytes(cert: &[u8]) -> Self {
46
        Self(cert.into())
47
    }
48
}
49

            
50
impl Writeable for CertExt {
51
    /// As Writeable::WriteOnto, but may return an error.
52
    ///
53
    /// TODO: Migrate Writeable to provide this interface.
54
24748
    fn write_onto<B: Writer + ?Sized>(&self, w: &mut B) -> EncodeResult<()> {
55
24748
        match self {
56
24746
            CertExt::SignedWithEd25519(pk) => pk.write_onto(w),
57
2
            CertExt::Unrecognized(u) => u.write_onto(w),
58
        }
59
24748
    }
60
}
61

            
62
impl Writeable for SignedWithEd25519Ext {
63
    /// As Writeable::WriteOnto, but may return an error.
64
24746
    fn write_onto<B: Writer + ?Sized>(&self, w: &mut B) -> EncodeResult<()> {
65
        // body length
66
24746
        w.write_u16(32);
67
        // Signed-with-ed25519-key-extension
68
24746
        w.write_u8(ExtType::SIGNED_WITH_ED25519_KEY.into());
69
        // flags = 0.
70
24746
        w.write_u8(0);
71
        // body
72
24746
        w.write_all(self.pk.as_bytes());
73
24746
        Ok(())
74
24746
    }
75
}
76

            
77
impl Writeable for UnrecognizedExt {
78
    /// As Writeable::WriteOnto, but may return an error.
79
2
    fn write_onto<B: Writer + ?Sized>(&self, w: &mut B) -> EncodeResult<()> {
80
        // We can't use Writer::write_nested_u16len here, since the length field
81
        // doesn't include the type or the flags.
82
2
        w.write_u16(
83
2
            self.body
84
2
                .len()
85
2
                .try_into()
86
2
                .map_err(|_| tor_bytes::EncodeError::BadLengthValue)?,
87
        );
88
2
        w.write_u8(self.ext_type.into());
89
2
        let flags = u8::from(self.affects_validation);
90
2
        w.write_u8(flags);
91
2
        w.write_all(&self.body[..]);
92
2
        Ok(())
93
2
    }
94
}
95

            
96
impl Ed25519CertConstructor {
97
    /// Set the approximate expiration time for this certificate.
98
    ///
99
    /// (The time will be rounded forward to the nearest hour after the epoch.)
100
35445
    pub fn expiration(&mut self, expiration: SystemTime) -> &mut Self {
101
        /// The number of seconds in an hour.
102
        const SEC_PER_HOUR: u64 = 3600;
103
35445
        let duration = expiration
104
35445
            .duration_since(SystemTime::UNIX_EPOCH)
105
35445
            .unwrap_or(Duration::from_secs(0));
106
35445
        let exp_hours = duration.as_secs().saturating_add(SEC_PER_HOUR - 1) / SEC_PER_HOUR;
107
35445
        self.exp_hours = Some(exp_hours.try_into().unwrap_or(u32::MAX));
108
35445
        self
109
35445
    }
110

            
111
    /// Set the signing key to be included with this certificate.
112
    ///
113
    /// This is optional: you don't need to include the signing key at all.  If
114
    /// you do, it must match the key that you actually use to sign the
115
    /// certificate.
116
35443
    pub fn signing_key(&mut self, key: ed25519::Ed25519Identity) -> &mut Self {
117
35443
        self.clear_signing_key();
118
35443
        self.signed_with = Some(Some(key));
119
35443
        self.extensions
120
35443
            .get_or_insert_with(Vec::new)
121
35443
            .push(CertExt::SignedWithEd25519(SignedWithEd25519Ext { pk: key }));
122

            
123
35443
        self
124
35443
    }
125

            
126
    /// Remove any signing key previously set on this Ed25519CertConstructor.
127
35443
    pub fn clear_signing_key(&mut self) -> &mut Self {
128
35443
        self.signed_with = None;
129
35443
        self.extensions
130
35443
            .get_or_insert_with(Vec::new)
131
35443
            .retain(|ext| !matches!(ext, CertExt::SignedWithEd25519(_)));
132
35443
        self
133
35443
    }
134

            
135
    /// Encode a certificate into a new vector, signing the result
136
    /// with `skey`.
137
    ///
138
    /// This function exists in lieu of a `build()` function, since we have a rule that
139
    /// we don't produce an `Ed25519Cert` except if the certificate is known to be
140
    /// valid.
141
4444
    pub fn encode_and_sign<S>(&self, skey: &S) -> Result<EncodedEd25519Cert, CertEncodeError>
142
4444
    where
143
4444
        S: Ed25519PublicKey + Ed25519SigningKey,
144
    {
145
        let Ed25519CertConstructor {
146
4444
            exp_hours,
147
4444
            cert_type,
148
4444
            cert_key,
149
4444
            extensions,
150
4444
            signed_with,
151
4444
        } = self;
152

            
153
        // As long as there is no setter for Ed25519Cert::signed_with, this is unreachable
154
4442
        if let Some(Some(signer)) = &signed_with {
155
4442
            if *signer != skey.public_key().into() {
156
                return Err(CertEncodeError::KeyMismatch);
157
4442
            }
158
2
        }
159

            
160
4444
        let mut w = Vec::new();
161
4444
        w.write_u8(1); // Version
162
4444
        w.write_u8(
163
4444
            cert_type
164
4444
                .ok_or(CertEncodeError::MissingField("cert_type"))?
165
4444
                .into(),
166
        );
167
4444
        w.write_u32(exp_hours.ok_or(CertEncodeError::MissingField("expiration"))?);
168
4444
        let cert_key = cert_key
169
4444
            .clone()
170
4444
            .ok_or(CertEncodeError::MissingField("cert_key"))?;
171
4444
        w.write_u8(cert_key.key_type().into());
172
4444
        w.write_all(cert_key.as_bytes());
173
4444
        let extensions = extensions.as_ref().map(Vec::as_slice).unwrap_or(&[]);
174
4444
        w.write_u8(
175
4444
            extensions
176
4444
                .len()
177
4444
                .try_into()
178
4444
                .map_err(|_| CertEncodeError::TooManyExtensions)?,
179
        );
180

            
181
4444
        for e in extensions.iter() {
182
4442
            e.write_onto(&mut w)?;
183
        }
184

            
185
4444
        let signature = skey.sign(&w[..]);
186
4444
        w.write(&signature)?;
187
4444
        Ok(EncodedEd25519Cert(w))
188
4444
    }
189
}
190

            
191
#[cfg(test)]
192
mod test {
193
    // @@ begin test lint list maintained by maint/add_warning @@
194
    #![allow(clippy::bool_assert_comparison)]
195
    #![allow(clippy::clone_on_copy)]
196
    #![allow(clippy::dbg_macro)]
197
    #![allow(clippy::mixed_attributes_style)]
198
    #![allow(clippy::print_stderr)]
199
    #![allow(clippy::print_stdout)]
200
    #![allow(clippy::single_char_pattern)]
201
    #![allow(clippy::unwrap_used)]
202
    #![allow(clippy::unchecked_time_subtraction)]
203
    #![allow(clippy::useless_vec)]
204
    #![allow(clippy::needless_pass_by_value)]
205
    //! <!-- @@ end test lint list maintained by maint/add_warning @@ -->
206
    use super::*;
207
    use crate::CertifiedKey;
208
    use tor_checkable::{SelfSigned, Timebound};
209

            
210
    #[test]
211
    fn signed_cert_without_key() {
212
        let mut rng = rand::rng();
213
        let keypair = ed25519::Keypair::generate(&mut rng);
214
        let now = SystemTime::now();
215
        let day = Duration::from_secs(86400);
216
        let encoded = Ed25519Cert::constructor()
217
            .expiration(now + day * 30)
218
            .cert_key(CertifiedKey::Ed25519(keypair.verifying_key().into()))
219
            .cert_type(7.into())
220
            .encode_and_sign(&keypair)
221
            .unwrap();
222

            
223
        let decoded = Ed25519Cert::decode(&encoded).unwrap(); // Well-formed?
224
        let validated = decoded
225
            .should_be_signed_with(&keypair.verifying_key().into())
226
            .unwrap()
227
            .check_signature()
228
            .unwrap(); // Well-signed?
229
        let cert = validated.check_valid_at(&(now + day * 20)).unwrap();
230
        assert_eq!(cert.cert_type(), 7.into());
231
        if let CertifiedKey::Ed25519(found) = cert.subject_key() {
232
            assert_eq!(found, &keypair.verifying_key().into());
233
        } else {
234
            panic!("wrong key type");
235
        }
236
        assert!(cert.signing_key() == Some(&keypair.verifying_key().into()));
237
    }
238

            
239
    #[test]
240
    fn unrecognized_ext() {
241
        use hex_literal::hex;
242
        use tor_bytes::Reader;
243

            
244
        let mut reader = Reader::from_slice(&hex!("0001 2A 00 2A"));
245
        let ext: CertExt = reader.extract().unwrap();
246

            
247
        let mut encoded: Vec<u8> = Vec::new();
248
        encoded.write(&ext).unwrap();
249

            
250
        assert_eq!(encoded, hex!("0001 2A 00 2A"));
251
    }
252
}