      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

    //! Describe a context in which to verify an `X509` certificate.
    //!
    //! The `X509` certificate store holds trusted CA certificates used to verify
    //! peer certificates.
    //!
    //! # Example
    //!
    //! ```rust
    //!
    //! extern crate openssl;
    //!
    //! use openssl::x509::store::{X509StoreBuilder, X509Store};
    //! use openssl::x509::{X509, X509Name};
    //! use openssl::pkey::PKey;
    //! use openssl::hash::MessageDigest;
    //! use openssl::rsa::Rsa;
    //! use openssl::nid::Nid;
    //!
    //! fn main() {
    //!     let rsa = Rsa::generate(2048).unwrap();
    //!     let pkey = PKey::from_rsa(rsa).unwrap();
    //!
    //!     let mut name = X509Name::builder().unwrap();
    //!     name.append_entry_by_nid(Nid::COMMONNAME, "foobar.com").unwrap();
    //!     let name = name.build();
    //!
    //!     let mut builder = X509::builder().unwrap();
    //!     builder.set_version(2).unwrap();
    //!     builder.set_subject_name(&name).unwrap();
    //!     builder.set_issuer_name(&name).unwrap();
    //!     builder.set_pubkey(&pkey).unwrap();
    //!     builder.sign(&pkey, MessageDigest::sha256()).unwrap();
    //!
    //!     let certificate: X509 = builder.build();
    //!
    //!     let mut builder = X509StoreBuilder::new().unwrap();
    //!     let _ = builder.add_cert(certificate);
    //!
    //!     let store: X509Store = builder.build();
    //! }
    //! ```

    use ffi;
    use foreign_types::ForeignTypeRef;
    use std::mem;

    use error::ErrorStack;
    use stack::StackRef;
    use x509::{X509Object, X509};
    use {cvt, cvt_p};

    foreign_type_and_impl_send_sync! {
        type CType = ffi::X509_STORE;
        fn drop = ffi::X509_STORE_free;

        /// A builder type used to construct an `X509Store`.
        pub struct X509StoreBuilder;
        /// Reference to an `X509StoreBuilder`.
        pub struct X509StoreBuilderRef;
    }

    impl X509StoreBuilder {
        /// Returns a builder for a certificate store.
        ///
        /// The store is initially empty.
        pub fn new() -> Result<X509StoreBuilder, ErrorStack> {
            unsafe {
                ffi::init();

                cvt_p(ffi::X509_STORE_new()).map(X509StoreBuilder)
            }
        }

        /// Constructs the `X509Store`.
        pub fn build(self) -> X509Store {
            let store = X509Store(self.0);
            mem::forget(self);
            store
        }
    }

    impl X509StoreBuilderRef {
        /// Adds a certificate to the certificate store.
        // FIXME should take an &X509Ref
        pub fn add_cert(&mut self, cert: X509) -> Result<(), ErrorStack> {
            unsafe { cvt(ffi::X509_STORE_add_cert(self.as_ptr(), cert.as_ptr())).map(|_| ()) }
        }

        /// Load certificates from their default locations.
        ///
        /// These locations are read from the `SSL_CERT_FILE` and `SSL_CERT_DIR`
        /// environment variables if present, or defaults specified at OpenSSL
        /// build time otherwise.
        pub fn set_default_paths(&mut self) -> Result<(), ErrorStack> {
            unsafe { cvt(ffi::X509_STORE_set_default_paths(self.as_ptr())).map(|_| ()) }
        }

        /// Adds a lookup method to the store.
        ///
        /// This corresponds to [`X509_STORE_add_lookup`].
        ///
        /// [`X509_STORE_add_lookup`]: https://www.openssl.org/docs/man1.1.1/man3/X509_STORE_add_lookup.html
        pub fn add_lookup<T>(
            &mut self,
            method: &'static X509LookupMethodRef<T>,
        ) -> Result<&mut X509LookupRef<T>, ErrorStack> {
            let lookup = unsafe { ffi::X509_STORE_add_lookup(self.as_ptr(), method.as_ptr()) };
            cvt_p(lookup).map(|ptr| unsafe { X509LookupRef::from_ptr_mut(ptr) })
        }
    }

    generic_foreign_type_and_impl_send_sync! {
        type CType = ffi::X509_LOOKUP;
        fn drop = ffi::X509_LOOKUP_free;

        /// Information used by an `X509Store` to look up certificates and CRLs.
        pub struct X509Lookup<T>;
        /// Reference to an `X509Lookup`.
        pub struct X509LookupRef<T>;
    }

    /// Marker type corresponding to the [`X509_LOOKUP_hash_dir`] lookup method.
    ///
    /// [`X509_LOOKUP_hash_dir`]: https://www.openssl.org/docs/man1.1.0/crypto/X509_LOOKUP_hash_dir.html
    pub struct HashDir;

    impl X509Lookup<HashDir> {
        /// Lookup method that loads certificates and CRLs on demand and caches
        /// them in memory once they are loaded. It also checks for newer CRLs upon
        /// each lookup, so that newer CRLs are used as soon as they appear in the
        /// directory.
        ///
        /// This corresponds to [`X509_LOOKUP_hash_dir`].
        ///
        /// [`X509_LOOKUP_hash_dir`]: https://www.openssl.org/docs/man1.1.0/crypto/X509_LOOKUP_hash_dir.html
        pub fn hash_dir() -> &'static X509LookupMethodRef<HashDir> {
            unsafe { X509LookupMethodRef::from_ptr(ffi::X509_LOOKUP_hash_dir()) }
        }
    }

    impl X509LookupRef<HashDir> {
        /// Specifies a directory from which certificates and CRLs will be loaded
        /// on-demand. Must be used with `X509Lookup::hash_dir`.
        ///
        /// This corresponds to [`X509_LOOKUP_add_dir`].
        ///
        /// [`X509_LOOKUP_add_dir`]: https://www.openssl.org/docs/man1.1.1/man3/X509_LOOKUP_add_dir.html
        pub fn add_dir(
            &mut self,
            name: &str,
            file_type: crate::ssl::SslFiletype,
        ) -> Result<(), ErrorStack> {
            let name = std::ffi::CString::new(name).unwrap();
            unsafe {
                cvt(ffi::X509_LOOKUP_add_dir(
                    self.as_ptr(),
                    name.as_ptr(),
                    file_type.as_raw(),
                ))
                .map(|_| ())
            }
        }
    }

    generic_foreign_type_and_impl_send_sync! {
        type CType = ffi::X509_LOOKUP_METHOD;
        fn drop = |_method| {
            #[cfg(ossl110)]
            ffi::X509_LOOKUP_meth_free(_method);
        };

        /// Method used to look up certificates and CRLs.
        pub struct X509LookupMethod<T>;
        /// Reference to an `X509LookupMethod`.
        pub struct X509LookupMethodRef<T>;
    }

    foreign_type_and_impl_send_sync! {
        type CType = ffi::X509_STORE;
        fn drop = ffi::X509_STORE_free;

        /// A certificate store to hold trusted `X509` certificates.
        pub struct X509Store;
        /// Reference to an `X509Store`.
        pub struct X509StoreRef;
    }

    impl X509StoreRef {
        /// Get a reference to the cache of certificates in this store.
        pub fn objects(&self) -> &StackRef<X509Object> {
            unsafe { StackRef::from_ptr(X509_STORE_get0_objects(self.as_ptr())) }
        }
    }

    cfg_if! {
        if #[cfg(any(ossl110, libressl270))] {
            use ffi::X509_STORE_get0_objects;
        } else {
            #[allow(bad_style)]
            unsafe fn X509_STORE_get0_objects(x: *mut ffi::X509_STORE) -> *mut ffi::stack_st_X509_OBJECT {
                (*x).objs
            }
        }
    }