libvault 0.2.2

the libvault is modified from RustyVault
Documentation
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
use std::{
    sync::Arc,
    time::{SystemTime, UNIX_EPOCH},
};

use better_default::Default;
use foreign_types::ForeignType;
use lazy_static::lazy_static;
use libc::c_int;
use openssl::{
    asn1::{Asn1OctetString, Asn1Time},
    bn::{BigNum, MsbOption},
    ec::{EcGroup, EcKey},
    hash::MessageDigest,
    nid::Nid,
    pkey::{PKey, Private},
    rsa::Rsa,
    x509::{
        X509, X509Builder, X509Extension, X509Name, X509NameBuilder, X509Ref,
        extension::{
            AuthorityKeyIdentifier, BasicConstraints, ExtendedKeyUsage, KeyUsage,
            SubjectAlternativeName, SubjectKeyIdentifier,
        },
    },
};
use openssl_sys::{
    EXFLAG_XKUSAGE, X509_STORE_CTX, X509_get_extended_key_usage, X509_get_extension_flags,
    stack_st_X509,
};
use rustls::{
    client::danger::{HandshakeSignatureValid, ServerCertVerified, ServerCertVerifier},
    pki_types::CertificateDer,
};
use serde::{Deserialize, Deserializer, Serialize, Serializer, ser::SerializeTuple};
use serde_bytes::ByteBuf;

use crate::errors::RvError;

lazy_static! {
    static ref X509_DEFAULT: X509 = X509Builder::new().unwrap().build();
    static ref PKEY_DEFAULT: PKey<Private> = PKey::generate_ed25519().unwrap();
}

unsafe extern "C" {
    pub fn X509_check_ca(x509: *mut openssl_sys::X509) -> c_int;
    pub fn X509_STORE_CTX_set0_trusted_stack(ctx: *mut X509_STORE_CTX, chain: *mut stack_st_X509);
}

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CertBundle {
    #[serde(
        serialize_with = "serialize_x509",
        deserialize_with = "deserialize_x509"
    )]
    #[default(X509_DEFAULT.clone())]
    pub certificate: X509,
    #[serde(
        serialize_with = "serialize_vec_x509",
        deserialize_with = "deserialize_vec_x509"
    )]
    pub ca_chain: Vec<X509>,
    #[serde(
        serialize_with = "serialize_pkey",
        deserialize_with = "deserialize_pkey"
    )]
    #[default(PKEY_DEFAULT.clone())]
    pub private_key: PKey<Private>,
    #[serde(default)]
    pub private_key_type: String,
    #[serde(default)]
    pub serial_number: String,
}

fn serialize_x509<S>(cert: &X509, serializer: S) -> Result<S::Ok, S::Error>
where
    S: serde::Serializer,
{
    serializer.serialize_bytes(&cert.to_pem().unwrap())
}

fn deserialize_x509<'de, D>(deserializer: D) -> Result<X509, D::Error>
where
    D: serde::Deserializer<'de>,
{
    let pem_bytes: &[u8] = &ByteBuf::deserialize(deserializer)?;
    X509::from_pem(pem_bytes).map_err(serde::de::Error::custom)
}

pub fn serialize_vec_x509<S>(x509_vec: &[X509], serializer: S) -> Result<S::Ok, S::Error>
where
    S: Serializer,
{
    let mut tuple = serializer.serialize_tuple(x509_vec.len())?;
    for x509 in x509_vec {
        tuple.serialize_element(&x509.to_pem().unwrap())?;
    }
    tuple.end()
}

pub fn deserialize_vec_x509<'de, D>(deserializer: D) -> Result<Vec<X509>, D::Error>
where
    D: Deserializer<'de>,
{
    let pem_bytes_vec: Vec<Vec<u8>> = Deserialize::deserialize(deserializer)?;
    let mut x509_vec = Vec::new();
    for pem_bytes in pem_bytes_vec {
        let x509 = X509::from_pem(&pem_bytes).map_err(serde::de::Error::custom)?;
        x509_vec.push(x509);
    }
    Ok(x509_vec)
}

fn serialize_pkey<S>(key: &PKey<openssl::pkey::Private>, serializer: S) -> Result<S::Ok, S::Error>
where
    S: serde::Serializer,
{
    serializer.serialize_bytes(&key.private_key_to_pem_pkcs8().unwrap())
}

fn deserialize_pkey<'de, D>(deserializer: D) -> Result<PKey<openssl::pkey::Private>, D::Error>
where
    D: serde::Deserializer<'de>,
{
    let pem_bytes: &[u8] = &ByteBuf::deserialize(deserializer)?;
    PKey::private_key_from_pem(pem_bytes).map_err(serde::de::Error::custom)
}

pub fn is_ca_cert(cert: &X509) -> bool {
    unsafe { X509_check_ca(cert.as_ptr()) != 0 }
}

pub fn generate_serial_number() -> BigNum {
    let mut sn = BigNum::new().unwrap();
    sn.rand(159, MsbOption::MAYBE_ZERO, false).unwrap();
    sn
}

pub fn has_x509_ext_key_usage(x509: &X509) -> bool {
    unsafe { X509_get_extension_flags(x509.as_ptr()) & EXFLAG_XKUSAGE != 0 }
}

pub fn has_x509_ext_key_usage_flag(x509: &X509, flag: u32) -> bool {
    unsafe {
        (X509_get_extension_flags(x509.as_ptr()) & EXFLAG_XKUSAGE != 0)
            && (X509_get_extended_key_usage(x509.as_ptr()) & flag) != 0
    }
}

impl CertBundle {
    pub fn new() -> Self {
        CertBundle::default()
    }

    pub fn verify(&self) -> Result<(), RvError> {
        let cert_pubkey = self.certificate.public_key()?;
        if !self.private_key.public_eq(&cert_pubkey) {
            return Err(RvError::ErrPkiCertKeyMismatch);
        }

        let cert_chain = self.get_cert_chain();

        if !cert_chain.is_empty() {
            for (i, ca_cert) in cert_chain[1..].iter().enumerate() {
                if !is_ca_cert(ca_cert) {
                    return Err(RvError::ErrPkiCertIsNotCA);
                }

                let authority_key_id = cert_chain[i].subject_key_id();
                let subject_key_id = ca_cert.subject_key_id();

                if authority_key_id.is_none() || subject_key_id.is_none() {
                    return Err(RvError::ErrPkiCaExtensionIncorrect);
                }

                if authority_key_id.unwrap().as_slice() != subject_key_id.unwrap().as_slice() {
                    return Err(RvError::ErrPkiCertChainIncorrect);
                }
            }
        }

        Ok(())
    }

    pub fn get_cert_chain(&self) -> Vec<&X509> {
        let mut cert_chain = Vec::new();

        cert_chain.push(&self.certificate);

        if !self.ca_chain.is_empty() {
            // Root CA puts itself in the chain
            if self.ca_chain[0].serial_number() != self.certificate.serial_number() {
                cert_chain.extend(self.ca_chain.iter());
            }
        }

        cert_chain
    }
}

#[derive(Default)]
pub struct Certificate {
    #[default(0x2)]
    pub version: i32,
    #[default(generate_serial_number())]
    pub serial_number: BigNum,
    #[default(X509NameBuilder::new().unwrap().build())]
    pub issuer: X509Name,
    #[default(X509NameBuilder::new().unwrap().build())]
    pub subject: X509Name,
    #[default(SystemTime::now())]
    pub not_before: SystemTime,
    #[default(SystemTime::now())]
    pub not_after: SystemTime,
    pub extensions: Vec<X509Extension>,
    #[default(Asn1OctetString::new_from_bytes("".as_bytes()).unwrap())]
    pub subject_key_id: Asn1OctetString,
    #[default(Asn1OctetString::new_from_bytes("".as_bytes()).unwrap())]
    pub authority_key_id: Asn1OctetString,
    pub dns_sans: Vec<String>,
    pub email_sans: Vec<String>,
    pub ip_sans: Vec<String>,
    pub uri_sans: Vec<String>,
    pub is_ca: bool,
    #[default("rsa".to_string())]
    pub key_type: String,
    #[default(2048)]
    pub key_bits: u32,
}

impl Certificate {
    pub fn to_x509(
        &mut self,
        ca_cert: Option<&X509Ref>,
        ca_key: Option<&PKey<Private>>,
        private_key: &PKey<Private>,
    ) -> Result<X509, RvError> {
        let mut builder = X509::builder()?;
        builder.set_version(self.version)?;
        let serial_number = self.serial_number.to_asn1_integer()?;
        builder.set_serial_number(&serial_number)?;
        builder.set_subject_name(&self.subject)?;
        if let Some(ca) = ca_cert {
            builder.set_issuer_name(ca.subject_name())?;
        } else {
            builder.set_issuer_name(&self.subject)?;
        }
        builder.set_pubkey(private_key)?;

        let not_before_dur = self.not_before.duration_since(UNIX_EPOCH)?;
        let not_before = Asn1Time::from_unix(not_before_dur.as_secs() as i64)?;
        builder.set_not_before(&not_before)?;

        let not_after_dur = self.not_after.duration_since(UNIX_EPOCH)?;
        let not_after_sec = not_after_dur.as_secs();
        let not_after = Asn1Time::from_unix(not_after_sec as i64)?;
        builder.set_not_after(&not_after)?;

        let mut san_ext = SubjectAlternativeName::new();
        for dns in &self.dns_sans {
            san_ext.dns(dns.as_str());
        }

        for email in &self.email_sans {
            san_ext.email(email.as_str());
        }

        for ip in &self.ip_sans {
            san_ext.ip(ip.as_str());
        }

        for uri in &self.uri_sans {
            san_ext.uri(uri.as_str());
        }

        if (self.dns_sans.len() | self.email_sans.len() | self.ip_sans.len() | self.uri_sans.len())
            > 0
        {
            builder.append_extension(san_ext.build(&builder.x509v3_context(ca_cert, None))?)?;
        }

        for ext in &self.extensions {
            builder.append_extension2(ext)?;
        }

        if self.is_ca {
            builder.append_extension(BasicConstraints::new().critical().ca().build()?)?;
            builder.append_extension(
                KeyUsage::new()
                    .critical()
                    .key_cert_sign()
                    .crl_sign()
                    .build()?,
            )?;
        } else {
            builder.append_extension(BasicConstraints::new().critical().build()?)?;
            builder.append_extension(
                KeyUsage::new()
                    .critical()
                    .non_repudiation()
                    .digital_signature()
                    .key_encipherment()
                    .build()?,
            )?;
            builder.append_extension(
                ExtendedKeyUsage::new()
                    .server_auth()
                    .client_auth()
                    .build()?,
            )?;
        }

        let subject_key_id =
            SubjectKeyIdentifier::new().build(&builder.x509v3_context(ca_cert, None))?;
        builder.append_extension(subject_key_id)?;

        let authority_key_id = AuthorityKeyIdentifier::new()
            .keyid(true)
            .issuer(false)
            .build(&builder.x509v3_context(ca_cert, None))?;
        builder.append_extension(authority_key_id)?;

        let digest = match self.key_type.as_str() {
            "rsa" | "ec" => MessageDigest::sha256(),
            #[cfg(feature = "crypto_adaptor_tongsuo")]
            "sm2" => MessageDigest::sm3(),
            _ => return Err(RvError::ErrPkiKeyTypeInvalid),
        };
        if let Some(key) = ca_key {
            builder.sign(key, digest)?;
        } else {
            builder.sign(private_key, digest)?;
        }

        Ok(builder.build())
    }

    pub fn to_cert_bundle(
        &mut self,
        ca_cert: Option<&X509Ref>,
        ca_key: Option<&PKey<Private>>,
    ) -> Result<CertBundle, RvError> {
        let key_bits = self.key_bits;
        let priv_key = match self.key_type.as_str() {
            "rsa" => match key_bits {
                2048 | 3072 | 4096 => {
                    let rsa_key = Rsa::generate(key_bits)?;
                    PKey::from_rsa(rsa_key)?
                }
                _ => return Err(RvError::ErrPkiKeyBitsInvalid),
            },
            "ec" => {
                let curve_name = match key_bits {
                    224 => Nid::SECP224R1,
                    256 => Nid::X9_62_PRIME256V1,
                    384 => Nid::SECP384R1,
                    521 => Nid::SECP521R1,
                    _ => return Err(RvError::ErrPkiKeyBitsInvalid),
                };
                let ec_group = EcGroup::from_curve_name(curve_name)?;
                let ec_key = EcKey::generate(ec_group.as_ref())?;
                PKey::from_ec_key(ec_key)?
            }
            #[cfg(feature = "crypto_adaptor_tongsuo")]
            "sm2" => {
                if key_bits != 256 {
                    return Err(RvError::ErrPkiKeyBitsInvalid);
                }
                let ec_group = EcGroup::from_curve_name(Nid::SM2)?;
                let ec_key = EcKey::generate(&ec_group)?;
                PKey::from_ec_key(ec_key)?
            }
            _ => return Err(RvError::ErrPkiKeyTypeInvalid),
        };

        let cert = self.to_x509(ca_cert, ca_key, &priv_key)?;
        let serial_number = cert.serial_number().to_bn()?;
        let serial_number_hex = serial_number.to_hex_str()?;
        let serial_number_hex = serial_number_hex
            .chars()
            .collect::<Vec<char>>()
            .chunks(2)
            .map(|chunk| chunk.iter().collect::<String>())
            .collect::<Vec<String>>()
            .join(":");

        let mut cert_bundle = CertBundle {
            certificate: cert,
            ca_chain: Vec::new(),
            private_key: priv_key.clone(),
            private_key_type: self.key_type.clone(),
            serial_number: serial_number_hex.to_lowercase(),
        };

        if let Some(ca) = ca_cert {
            cert_bundle.ca_chain = vec![ca.to_owned()];
        }

        Ok(cert_bundle)
    }
}

#[derive(Debug)]
pub struct DisabledVerifier;

impl ServerCertVerifier for DisabledVerifier {
    fn verify_server_cert(
        &self,
        _end_entity: &CertificateDer<'_>,
        _intermediates: &[CertificateDer<'_>],
        _server_name: &rustls::pki_types::ServerName<'_>,
        _ocsp_response: &[u8],
        _now: rustls::pki_types::UnixTime,
    ) -> Result<ServerCertVerified, rustls::Error> {
        Ok(ServerCertVerified::assertion())
    }

    fn verify_tls12_signature(
        &self,
        _message: &[u8],
        _cert: &CertificateDer<'_>,
        _dss: &rustls::DigitallySignedStruct,
    ) -> Result<HandshakeSignatureValid, rustls::Error> {
        Ok(HandshakeSignatureValid::assertion())
    }

    fn verify_tls13_signature(
        &self,
        _message: &[u8],
        _cert: &CertificateDer<'_>,
        _dss: &rustls::DigitallySignedStruct,
    ) -> Result<HandshakeSignatureValid, rustls::Error> {
        Ok(HandshakeSignatureValid::assertion())
    }

    fn supported_verify_schemes(&self) -> Vec<rustls::SignatureScheme> {
        let provider = rustls::crypto::CryptoProvider::get_default()
            .cloned()
            .unwrap_or(Arc::new(rustls::crypto::ring::default_provider()));
        provider
            .signature_verification_algorithms
            .supported_schemes()
    }
}