Struct CertStore 

pub struct CertStore<'a> { /* private fields */ }

A unified interface to multiple certificate stores.

When a certificate is looked up, the certificate is looked up in the primary cert-d, if any, and all the backends whose access mode is AccessMode::Always. The results are merged and returned. If no certificate is found, then the look up is also tried on the backends whose access mode is AccessMode::OnMiss. Finally, if a key server is configured, the key server is tried.

In general, results are preferred to errors. That is, if a backend returns a positive result, and another backend returns an error, the error is ignored, even if it is something other than StoreError::NotFound.

Results from the key server are either cached when CertStore::flush is called (or the CertStore is dropped) if there is a writable primary cert-d, or simply dropped otherwise.

Implementations

impl<'a> CertStore<'a>

pub fn empty() -> Self

Returns a CertStore, which does not have any configured backends.

pub fn new() -> Result<Self>

Returns a CertStore, which uses the default certificate directory.

When a certificate is added or updated, it will be added to or updated in this certificate store.

pub fn readonly() -> Result<Self>

Returns a CertStore, which uses the default certificate directory in read-only mode.

pub fn open<P>(path: P) -> Result<Self>

where P: AsRef<Path>,

Returns a CertStore, which uses the specified certificate directory.

When a certificate is added or updated, it will be added to or updated in this certificate store.

pub fn open_readonly<P>(path: P) -> Result<Self>

where P: AsRef<Path>,

Returns a CertStore, which uses the specified certificate directory in read-only mode.

pub fn add_backend( &mut self, backend: Box<dyn Store<'a> + Send + Sync + 'a>, mode: AccessMode, ) -> &mut Self

Add the specified backend to the CertStore.

The backend is added to the collection of read-only backends.

pub fn add_certd<P>(&mut self, path: P) -> Result<&mut Self>

where P: AsRef<Path>,

Adds the specified cert-d to the CertStore.

The cert-d is added in read-only mode, and its access mode is set to AccessMode::Always.

pub fn add_default_certd(&mut self) -> Result<&mut Self>

Adds the default cert-d to the CertStore.

The cert-d is added in read-only mode, and its access mode is set to AccessMode::Always.

pub fn add_keyring<P>(&mut self, path: P) -> Result<&mut Self>

where P: AsRef<Path>,

Adds the specified keyring to the CertStore.

The keyring is added in read-only mode, and its access mode is set to AccessMode::Always.

pub fn add_keyrings<I, P>(&mut self, filenames: I) -> Result<&mut Self>

where P: AsRef<Path>, I: IntoIterator<Item = P>,

Adds the specified keyrings to the CertStore.

The keyrings are added in read-only mode, and their access mode is set to AccessMode::Always.

pub fn add_keyserver(&mut self, url: &str) -> Result<&mut Self>

Adds the specified keyserver to the CertStore.

The keyserver is added in read-only mode, and its access mode is set to AccessMode::OnMiss.

pub fn add_keyserver_backend(&mut self, ks: KeyServer<'a>) -> Result<&mut Self>

Adds the specified keyserver to the CertStore.

The keyserver is added in read-only mode, and its access mode is set to AccessMode::OnMiss.

A key server is treated specially from other backends: any results that it returns are written to the cert store (if it is open in read-write mode).

pub fn certd(&self) -> Option<&CertD<'a>>

Returns a reference to the certd store, if there is one.

pub fn certd_mut(&mut self) -> Option<&mut CertD<'a>>

Returns a mutable reference to the certd store, if there is one.

impl<'a> CertStore<'a>

pub fn flush(&mut self) -> Result<()>

Flushes any modified certificates to the backing store.

Currently, this flushes the key server cache to the underlying cert-d, if any. All other backends are currently expected to work in a write-through manner.

Note: this is called automatically when the CertStore is dropped, but calling it explicitly allows for reporting of errors.

Trait Implementations

impl<'a> Drop for CertStore<'a>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<'a> Store<'a> for CertStore<'a>

fn lookup_by_cert(&self, kh: &KeyHandle) -> Result<Vec<Arc<LazyCert<'a>>>>

Returns the certificates whose fingerprint matches the handle.

fn lookup_by_cert_fpr( &self, fingerprint: &Fingerprint, ) -> Result<Arc<LazyCert<'a>>>

Returns the certificate with the specified fingerprint, if any.

fn lookup_by_cert_or_subkey( &self, kh: &KeyHandle, ) -> Result<Vec<Arc<LazyCert<'a>>>>

Returns certificates that have a key with the specified handle, if any.

fn select_userid( &self, query: &UserIDQueryParams, pattern: &str, ) -> Result<Vec<Arc<LazyCert<'a>>>>

Returns certificates that have a User ID matching the specified pattern according to the query parameters.

fn lookup_by_userid(&self, userid: &UserID) -> Result<Vec<Arc<LazyCert<'a>>>>

Performs an exact match on the User ID.

fn grep_userid(&self, pattern: &str) -> Result<Vec<Arc<LazyCert<'a>>>>

Performs a case insenitive, substring match on the User ID.

fn lookup_by_email(&self, email: &str) -> Result<Vec<Arc<LazyCert<'a>>>>

Returns certificates that have a User ID with the specified email address.

fn grep_email(&self, pattern: &str) -> Result<Vec<Arc<LazyCert<'a>>>>

Performs a case insenitive, substring match on the normalized email address.

fn lookup_by_email_domain(&self, domain: &str) -> Result<Vec<Arc<LazyCert<'a>>>>

Returns certificates that have User ID with an email address from the specified domain.

fn fingerprints(&self) -> Box<dyn Iterator<Item = Fingerprint> + 'a>

Lists all of the certificates.

fn certs<'b>(&'b self) -> Box<dyn Iterator<Item = Arc<LazyCert<'a>>> + 'b>

where 'a: 'b,

Returns all of the certificates.

fn prefetch_all(&self)

Prefills the cache.

fn prefetch_some(&self, certs: &[KeyHandle])

Prefetches some certificates.

impl<'a> StoreUpdate<'a> for CertStore<'a>

fn update_by( &self, cert: Arc<LazyCert<'a>>, merge_strategy: &dyn MergeCerts<'a>, ) -> Result<Arc<LazyCert<'a>>>

Inserts a certificate into the store.

fn update(&self, cert: Arc<LazyCert<'a>>) -> Result<()>

Insert a certificate.