blob: 9dff021b6cc0b5bb658358ae9180774d3ff1b03d [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Describe a context in which to verify an `X509` certificate."><meta name="keywords" content="rust, rustlang, rust-lang, store"><title>openssl::x509::store - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../../openssl/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../openssl/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module store</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../../index.html">openssl</a>::<wbr><a href="../index.html">x509</a>::<wbr><a class="mod" href="#">store</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../../src/openssl/x509/store.rs.html#1-287">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Describe a context in which to verify an <code>X509</code> certificate.</p>
<p>The <code>X509</code> certificate store holds trusted CA certificates used to verify
peer certificates.</p>
<h2 id="example"><a href="#example">Example</a></h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>openssl::x509::store::{X509StoreBuilder, X509Store};
<span class="kw">use </span>openssl::x509::{X509, X509Name};
<span class="kw">use </span>openssl::asn1::Asn1Time;
<span class="kw">use </span>openssl::pkey::PKey;
<span class="kw">use </span>openssl::hash::MessageDigest;
<span class="kw">use </span>openssl::rsa::Rsa;
<span class="kw">use </span>openssl::nid::Nid;
<span class="kw">let </span>rsa = Rsa::generate(<span class="number">2048</span>).unwrap();
<span class="kw">let </span>pkey = PKey::from_rsa(rsa).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>name = X509Name::builder().unwrap();
name.append_entry_by_nid(Nid::COMMONNAME, <span class="string">&quot;foobar.com&quot;</span>).unwrap();
<span class="kw">let </span>name = name.build();
<span class="comment">// Sep 27th, 2016
</span><span class="kw">let </span>sample_time = Asn1Time::from_unix(<span class="number">1474934400</span>).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>builder = X509::builder().unwrap();
builder.set_version(<span class="number">2</span>).unwrap();
builder.set_subject_name(<span class="kw-2">&amp;</span>name).unwrap();
builder.set_issuer_name(<span class="kw-2">&amp;</span>name).unwrap();
builder.set_pubkey(<span class="kw-2">&amp;</span>pkey).unwrap();
builder.set_not_before(<span class="kw-2">&amp;</span>sample_time);
builder.set_not_after(<span class="kw-2">&amp;</span>sample_time);
builder.sign(<span class="kw-2">&amp;</span>pkey, MessageDigest::sha256()).unwrap();
<span class="kw">let </span>certificate: X509 = builder.build();
<span class="kw">let </span><span class="kw-2">mut </span>builder = X509StoreBuilder::new().unwrap();
<span class="kw">let _ </span>= builder.add_cert(certificate);
<span class="kw">let </span>store: X509Store = builder.build();</code></pre></div>
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.File.html" title="openssl::x509::store::File struct">File</a></div><div class="item-right docblock-short">Marker type corresponding to the <a href="https://www.openssl.org/docs/man1.1.1/man3/X509_LOOKUP_file.html"><code>X509_LOOKUP_file</code></a> lookup method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.HashDir.html" title="openssl::x509::store::HashDir struct">HashDir</a></div><div class="item-right docblock-short">Marker type corresponding to the <a href="https://www.openssl.org/docs/manmaster/crypto/X509_LOOKUP_hash_dir.html"><code>X509_LOOKUP_hash_dir</code></a> lookup method.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.X509Lookup.html" title="openssl::x509::store::X509Lookup struct">X509Lookup</a></div><div class="item-right docblock-short">Information used by an <code>X509Store</code> to look up certificates and CRLs.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.X509LookupMethod.html" title="openssl::x509::store::X509LookupMethod struct">X509LookupMethod</a></div><div class="item-right docblock-short">Method used to look up certificates and CRLs.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.X509LookupMethodRef.html" title="openssl::x509::store::X509LookupMethodRef struct">X509LookupMethodRef</a></div><div class="item-right docblock-short">A reference to an <a href="struct.X509LookupMethod.html" title="X509LookupMethod"><code>X509LookupMethod</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.X509LookupRef.html" title="openssl::x509::store::X509LookupRef struct">X509LookupRef</a></div><div class="item-right docblock-short">A reference to an <a href="struct.X509Lookup.html" title="X509Lookup"><code>X509Lookup</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.X509Store.html" title="openssl::x509::store::X509Store struct">X509Store</a></div><div class="item-right docblock-short">A certificate store to hold trusted <code>X509</code> certificates.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.X509StoreBuilder.html" title="openssl::x509::store::X509StoreBuilder struct">X509StoreBuilder</a></div><div class="item-right docblock-short">A builder type used to construct an <code>X509Store</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.X509StoreBuilderRef.html" title="openssl::x509::store::X509StoreBuilderRef struct">X509StoreBuilderRef</a></div><div class="item-right docblock-short">A reference to an <a href="struct.X509StoreBuilder.html" title="X509StoreBuilder"><code>X509StoreBuilder</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.X509StoreRef.html" title="openssl::x509::store::X509StoreRef struct">X509StoreRef</a></div><div class="item-right docblock-short">Reference to an <code>X509Store</code>.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="openssl" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>