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
//! File format entry structs.

use crate::*;

use actor::*;
use internal::codec;
use internal::sign_ed25519;
use internal::x25519;

/// Fixed serialized entry byte count.
pub const ENTRY_SIZE: usize = 1024;

/// Enum of lair entry types for decoding.
#[non_exhaustive]
#[derive(Debug, Clone)]
pub enum LairEntry {
    /// Tls Cert Keypair
    TlsCert(EntryTlsCert),

    /// Sign Ed25519 Keypair
    SignEd25519(EntrySignEd25519),

    /// X25519 Keypair
    X25519(EntryX25519),
}

impl From<EntryTlsCert> for LairEntry {
    fn from(o: EntryTlsCert) -> Self {
        Self::TlsCert(o)
    }
}

impl From<EntrySignEd25519> for LairEntry {
    fn from(o: EntrySignEd25519) -> Self {
        Self::SignEd25519(o)
    }
}

impl From<EntryX25519> for LairEntry {
    fn from(o: EntryX25519) -> Self {
        Self::X25519(o)
    }
}

impl LairEntry {
    /// Decode a disk entry.
    /// @todo - once we're integrated with sodoken, this should decrypt too
    ///         otherwise we would first have to load priv keys into unprotected
    ///         memory.
    pub fn decode(data: &[u8]) -> LairResult<LairEntry> {
        let mut reader = codec::CodecReader::new(data);

        reader.read_pre_padding()?;

        let entry_type = reader.read_entry_type()?;

        Ok(match entry_type {
            codec::EntryType::TlsCert => {
                LairEntry::TlsCert(entry_decode_tls_cert(reader)?)
            }
            codec::EntryType::SignEd25519 => {
                LairEntry::SignEd25519(entry_decode_sign_ed25519(reader)?)
            }
            codec::EntryType::X25519 => {
                LairEntry::X25519(entry_decode_x25519(reader)?)
            }
        })
    }

    /// Encode this entry for writing to disk.
    /// @todo - once we're integrated with sodoken, this should encrypt too
    ///         otherwise we're writing our priv key to unprotected memory.
    pub fn encode(&self) -> LairResult<Vec<u8>> {
        match self {
            LairEntry::TlsCert(e) => e.encode(),
            LairEntry::SignEd25519(e) => e.encode(),
            LairEntry::X25519(e) => e.encode(),
        }
    }
}

fn entry_decode_tls_cert(
    mut reader: codec::CodecReader<'_>,
) -> LairResult<EntryTlsCert> {
    let sni_len = reader.read_u64()?;
    let sni = String::from_utf8_lossy(reader.read_bytes(sni_len)?).to_string();

    let priv_key_der_len = reader.read_u64()?;
    let priv_key_der = reader.read_bytes(priv_key_der_len)?.to_vec();

    let cert_der_len = reader.read_u64()?;
    let cert_der = reader.read_bytes(cert_der_len)?.to_vec();

    let cert_digest = reader.read_bytes(32)?.to_vec();

    Ok(EntryTlsCert {
        sni: sni.into(),
        priv_key_der: priv_key_der.into(),
        cert_der: cert_der.into(),
        cert_digest: cert_digest.into(),
    })
}

fn entry_decode_sign_ed25519(
    mut reader: codec::CodecReader<'_>,
) -> LairResult<EntrySignEd25519> {
    let priv_key = reader.read_bytes(32)?.to_vec().into();
    let pub_key = reader.read_bytes(32)?.to_vec().into();

    Ok(EntrySignEd25519 { priv_key, pub_key })
}

fn entry_decode_x25519(
    mut reader: codec::CodecReader<'_>,
) -> LairResult<EntryX25519> {
    let priv_key_data = reader.read_bytes(x25519::PRIV_KEY_BYTES as _)?;
    let mut priv_key = [0_u8; x25519::PRIV_KEY_BYTES];
    priv_key.copy_from_slice(priv_key_data);

    let pub_key_data = reader.read_bytes(x25519::PUB_KEY_BYTES as _)?;
    let mut pub_key = [0_u8; x25519::PUB_KEY_BYTES];
    pub_key.copy_from_slice(pub_key_data);

    Ok(EntryX25519 {
        priv_key: priv_key.into(),
        pub_key: pub_key.into(),
    })
}

/// File format entry representing Tls Certificate data.
#[derive(Debug, Clone)]
pub struct EntryTlsCert {
    /// The random sni that will be built into the self-signed certificate
    pub sni: CertSni,

    /// Private key bytes.
    /// @todo - once we're integrated with sodoken, make this a priv buffer.
    pub priv_key_der: CertPrivKey,

    /// Certificate bytes.
    pub cert_der: Cert,

    /// 32 byte blake2b certificate digest.
    pub cert_digest: CertDigest,
}

impl EntryTlsCert {
    /// Encode this entry for writing to disk.
    /// @todo - once we're integrated with sodoken, this should encrypt too
    ///         otherwise we're writing our priv key to unprotected memory.
    pub fn encode(&self) -> LairResult<Vec<u8>> {
        let mut writer = codec::CodecWriter::new(ENTRY_SIZE)?;

        // pre padding
        writer.write_pre_padding(16)?;

        // tls cert entry type
        writer.write_entry_type(codec::EntryType::TlsCert)?;

        // write sni
        let sni_bytes = self.sni.as_bytes();
        writer.write_u64(sni_bytes.len() as u64)?;
        writer.write_bytes(sni_bytes)?;

        // write priv key
        writer.write_u64(self.priv_key_der.len() as u64)?;
        writer.write_bytes(&self.priv_key_der)?;

        // write cert
        writer.write_u64(self.cert_der.len() as u64)?;
        writer.write_bytes(&self.cert_der)?;

        // write digest (always 32 bytes)
        writer.write_bytes(&self.cert_digest[0..32])?;

        Ok(writer.into_vec())
    }
}

/// Keypair struct for X25519 ECDH.
#[derive(Debug, Clone)]
pub struct EntryX25519 {
    /// Private key bytes.
    /// @todo security
    pub priv_key: x25519::X25519PrivKey,

    /// Public key bytes.
    pub pub_key: x25519::X25519PubKey,
}

impl EntryX25519 {
    /// Encode an X25519 keypair for storage.
    pub fn encode(&self) -> LairResult<Vec<u8>> {
        let mut writer = codec::CodecWriter::new(ENTRY_SIZE)?;

        // pre padding
        writer.write_pre_padding(64)?;

        // x25519 entry type
        writer.write_entry_type(codec::EntryType::X25519)?;

        // write priv_key (always 32 bytes)
        // @todo cloning a private key probably not great
        writer.write_bytes(&self.priv_key.to_bytes())?;

        // write pub_key (always 32 bytes)
        writer.write_bytes(&AsRef::<[u8]>::as_ref(&self.pub_key)[0..32])?;

        Ok(writer.into_vec())
    }
}

/// File format entry representing Sign Ed25519 Keypair data.
#[derive(Debug, Clone)]
pub struct EntrySignEd25519 {
    /// Private key bytes.
    /// @todo - once we're integrated with sodoken, make this a priv buffer.
    pub priv_key: sign_ed25519::SignEd25519PrivKey,

    /// Public key bytes.
    pub pub_key: sign_ed25519::SignEd25519PubKey,
}

impl EntrySignEd25519 {
    /// Encode this entry for writing to disk.
    /// @todo - once we're integrated with sodoken, this should encrypt too
    ///         otherwise we're writing our priv key to unprotected memory.
    pub fn encode(&self) -> LairResult<Vec<u8>> {
        let mut writer = codec::CodecWriter::new(ENTRY_SIZE)?;

        // pre padding
        writer.write_pre_padding(64)?;

        // sign ed25519 entry type
        writer.write_entry_type(codec::EntryType::SignEd25519)?;

        // write priv_key (always 32 bytes)
        writer.write_bytes(&self.priv_key[0..32])?;

        // write pub_key (always 32 bytes)
        writer.write_bytes(&self.pub_key[0..32])?;

        Ok(writer.into_vec())
    }

    /// Create a signature for given message with this entry's priv_key.
    #[allow(clippy::rc_buffer)]
    pub fn sign(
        &self,
        message: Arc<Vec<u8>>,
    ) -> impl std::future::Future<
        Output = LairResult<sign_ed25519::SignEd25519Signature>,
    > + 'static {
        let priv_key = self.priv_key.clone();
        sign_ed25519::sign_ed25519(priv_key, message)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn it_can_encode_and_decode_x25519_entry() {
        let e = EntryX25519 {
            priv_key: [0xdb; 32].into(),
            pub_key: [0x42; 32].into(),
        };
        let d = LairEntry::from(e.clone()).encode().unwrap();
        let e2 = match LairEntry::decode(&d).unwrap() {
            LairEntry::X25519(e2) => e2,
            e2 => panic!("unexpected type: {:?}", e2),
        };
        assert_eq!(e.priv_key, e2.priv_key);
        assert_eq!(e.pub_key, e2.pub_key);
    }

    #[test]
    fn it_can_encode_and_decode_sign_ed25519_entry() {
        let e = EntrySignEd25519 {
            priv_key: vec![0xdb; 32].into(),
            pub_key: vec![0x42; 32].into(),
        };
        let d = LairEntry::from(e.clone()).encode().unwrap();
        let e2 = match LairEntry::decode(&d).unwrap() {
            LairEntry::SignEd25519(e2) => e2,
            e2 => panic!("unexpected type: {:?}", e2),
        };
        assert_eq!(e.priv_key, e2.priv_key);
        assert_eq!(e.pub_key, e2.pub_key);
    }

    #[test]
    fn it_can_encode_and_decode_tls_cert_entry() {
        let e = EntryTlsCert {
            sni: "test".to_string().into(),
            priv_key_der: vec![1, 2].into(),
            cert_der: vec![3, 4].into(),
            cert_digest: vec![0x42; 32].into(),
        };
        let d = LairEntry::from(e.clone()).encode().unwrap();
        let e2 = match LairEntry::decode(&d).unwrap() {
            LairEntry::TlsCert(e2) => e2,
            e2 => panic!("unexpected type: {:?}", e2),
        };
        assert_eq!(e.sni, e2.sni);
        assert_eq!(e.priv_key_der, e2.priv_key_der);
        assert_eq!(e.cert_der, e2.cert_der);
        assert_eq!(e.cert_digest, e2.cert_digest);
    }
}