blob: 3784336d9d780ee546239b1a08ad48e1977c2ff3 [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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/openssl-0.10.54/src/x509/verify.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>verify.rs - source</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="../../../source-script.js"></script><script defer src="../../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><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></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../openssl/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><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="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
</pre><pre class="rust"><code><span class="kw">use </span>bitflags::bitflags;
<span class="kw">use </span>foreign_types::ForeignTypeRef;
<span class="kw">use </span>libc::{c_int, c_uint, c_ulong, time_t};
<span class="kw">use </span>std::net::IpAddr;
<span class="kw">use </span><span class="kw">crate</span>::error::ErrorStack;
<span class="attribute">#[cfg(ossl102)]
</span><span class="kw">use </span><span class="kw">crate</span>::x509::X509PurposeId;
<span class="kw">use crate</span>::{cvt, cvt_p};
<span class="kw">use </span>openssl_macros::corresponds;
<span class="macro">bitflags! </span>{
<span class="doccomment">/// Flags used to check an `X509` certificate.
</span><span class="kw">pub struct </span>X509CheckFlags: c_uint {
<span class="kw">const </span>ALWAYS_CHECK_SUBJECT = ffi::X509_CHECK_FLAG_ALWAYS_CHECK_SUBJECT;
<span class="kw">const </span>NO_WILDCARDS = ffi::X509_CHECK_FLAG_NO_WILDCARDS;
<span class="kw">const </span>NO_PARTIAL_WILDCARDS = ffi::X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS;
<span class="kw">const </span>MULTI_LABEL_WILDCARDS = ffi::X509_CHECK_FLAG_MULTI_LABEL_WILDCARDS;
<span class="kw">const </span>SINGLE_LABEL_SUBDOMAINS = ffi::X509_CHECK_FLAG_SINGLE_LABEL_SUBDOMAINS;
<span class="doccomment">/// Requires OpenSSL 1.1.0 or newer.
</span><span class="attribute">#[cfg(any(ossl110))]
</span><span class="kw">const </span>NEVER_CHECK_SUBJECT = ffi::X509_CHECK_FLAG_NEVER_CHECK_SUBJECT;
<span class="attribute">#[deprecated(since = <span class="string">&quot;0.10.6&quot;</span>, note = <span class="string">&quot;renamed to NO_WILDCARDS&quot;</span>)]
</span><span class="kw">const </span>FLAG_NO_WILDCARDS = ffi::X509_CHECK_FLAG_NO_WILDCARDS;
}
}
<span class="macro">bitflags! </span>{
<span class="doccomment">/// Flags used to verify an `X509` certificate chain.
</span><span class="kw">pub struct </span>X509VerifyFlags: c_ulong {
<span class="kw">const </span>CB_ISSUER_CHECK = ffi::X509_V_FLAG_CB_ISSUER_CHECK;
<span class="kw">const </span>USE_CHECK_TIME = ffi::X509_V_FLAG_USE_CHECK_TIME;
<span class="kw">const </span>CRL_CHECK = ffi::X509_V_FLAG_CRL_CHECK;
<span class="kw">const </span>CRL_CHECK_ALL = ffi::X509_V_FLAG_CRL_CHECK_ALL;
<span class="kw">const </span>IGNORE_CRITICAL = ffi::X509_V_FLAG_IGNORE_CRITICAL;
<span class="kw">const </span>X509_STRICT = ffi::X509_V_FLAG_X509_STRICT;
<span class="kw">const </span>ALLOW_PROXY_CERTS = ffi::X509_V_FLAG_ALLOW_PROXY_CERTS;
<span class="kw">const </span>POLICY_CHECK = ffi::X509_V_FLAG_POLICY_CHECK;
<span class="kw">const </span>EXPLICIT_POLICY = ffi::X509_V_FLAG_EXPLICIT_POLICY;
<span class="kw">const </span>INHIBIT_ANY = ffi::X509_V_FLAG_INHIBIT_ANY;
<span class="kw">const </span>INHIBIT_MAP = ffi::X509_V_FLAG_INHIBIT_MAP;
<span class="kw">const </span>NOTIFY_POLICY = ffi::X509_V_FLAG_NOTIFY_POLICY;
<span class="kw">const </span>EXTENDED_CRL_SUPPORT = ffi::X509_V_FLAG_EXTENDED_CRL_SUPPORT;
<span class="kw">const </span>USE_DELTAS = ffi::X509_V_FLAG_USE_DELTAS;
<span class="kw">const </span>CHECK_SS_SIGNATURE = ffi::X509_V_FLAG_CHECK_SS_SIGNATURE;
<span class="attribute">#[cfg(ossl102)]
</span><span class="kw">const </span>TRUSTED_FIRST = ffi::X509_V_FLAG_TRUSTED_FIRST;
<span class="attribute">#[cfg(ossl102)]
</span><span class="kw">const </span>SUITEB_128_LOS_ONLY = ffi::X509_V_FLAG_SUITEB_128_LOS_ONLY;
<span class="attribute">#[cfg(ossl102)]
</span><span class="kw">const </span>SUITEB_192_LOS = ffi::X509_V_FLAG_SUITEB_128_LOS;
<span class="attribute">#[cfg(ossl102)]
</span><span class="kw">const </span>SUITEB_128_LOS = ffi::X509_V_FLAG_SUITEB_192_LOS;
<span class="attribute">#[cfg(ossl102)]
</span><span class="kw">const </span>PARTIAL_CHAIN = ffi::X509_V_FLAG_PARTIAL_CHAIN;
<span class="attribute">#[cfg(ossl110)]
</span><span class="kw">const </span>NO_ALT_CHAINS = ffi::X509_V_FLAG_NO_ALT_CHAINS;
<span class="attribute">#[cfg(ossl110)]
</span><span class="kw">const </span>NO_CHECK_TIME = ffi::X509_V_FLAG_NO_CHECK_TIME;
}
}
<span class="macro">foreign_type_and_impl_send_sync! </span>{
<span class="kw">type </span>CType = ffi::X509_VERIFY_PARAM;
<span class="kw">fn </span>drop = ffi::X509_VERIFY_PARAM_free;
<span class="doccomment">/// Adjust parameters associated with certificate verification.
</span><span class="kw">pub struct </span>X509VerifyParam;
<span class="doccomment">/// Reference to `X509VerifyParam`.
</span><span class="kw">pub struct </span>X509VerifyParamRef;
}
<span class="kw">impl </span>X509VerifyParam {
<span class="doccomment">/// Create an X509VerifyParam
</span><span class="attribute">#[corresponds(X509_VERIFY_PARAM_new)]
</span><span class="kw">pub fn </span>new() -&gt; <span class="prelude-ty">Result</span>&lt;X509VerifyParam, ErrorStack&gt; {
<span class="kw">unsafe </span>{
ffi::init();
cvt_p(ffi::X509_VERIFY_PARAM_new()).map(X509VerifyParam)
}
}
}
<span class="kw">impl </span>X509VerifyParamRef {
<span class="doccomment">/// Set the host flags.
</span><span class="attribute">#[corresponds(X509_VERIFY_PARAM_set_hostflags)]
</span><span class="kw">pub fn </span>set_hostflags(<span class="kw-2">&amp;mut </span><span class="self">self</span>, hostflags: X509CheckFlags) {
<span class="kw">unsafe </span>{
ffi::X509_VERIFY_PARAM_set_hostflags(<span class="self">self</span>.as_ptr(), hostflags.bits);
}
}
<span class="doccomment">/// Set verification flags.
</span><span class="attribute">#[corresponds(X509_VERIFY_PARAM_set_flags)]
</span><span class="kw">pub fn </span>set_flags(<span class="kw-2">&amp;mut </span><span class="self">self</span>, flags: X509VerifyFlags) -&gt; <span class="prelude-ty">Result</span>&lt;(), ErrorStack&gt; {
<span class="kw">unsafe </span>{ cvt(ffi::X509_VERIFY_PARAM_set_flags(<span class="self">self</span>.as_ptr(), flags.bits)).map(|<span class="kw">_</span>| ()) }
}
<span class="doccomment">/// Clear verification flags.
</span><span class="attribute">#[corresponds(X509_VERIFY_PARAM_clear_flags)]
</span><span class="kw">pub fn </span>clear_flags(<span class="kw-2">&amp;mut </span><span class="self">self</span>, flags: X509VerifyFlags) -&gt; <span class="prelude-ty">Result</span>&lt;(), ErrorStack&gt; {
<span class="kw">unsafe </span>{
cvt(ffi::X509_VERIFY_PARAM_clear_flags(
<span class="self">self</span>.as_ptr(),
flags.bits,
))
.map(|<span class="kw">_</span>| ())
}
}
<span class="doccomment">/// Gets verification flags.
</span><span class="attribute">#[corresponds(X509_VERIFY_PARAM_get_flags)]
</span><span class="kw">pub fn </span>flags(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; X509VerifyFlags {
<span class="kw">let </span>bits = <span class="kw">unsafe </span>{ ffi::X509_VERIFY_PARAM_get_flags(<span class="self">self</span>.as_ptr()) };
X509VerifyFlags { bits }
}
<span class="doccomment">/// Set the expected DNS hostname.
</span><span class="attribute">#[corresponds(X509_VERIFY_PARAM_set1_host)]
</span><span class="kw">pub fn </span>set_host(<span class="kw-2">&amp;mut </span><span class="self">self</span>, host: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;(), ErrorStack&gt; {
<span class="kw">unsafe </span>{
cvt(ffi::X509_VERIFY_PARAM_set1_host(
<span class="self">self</span>.as_ptr(),
host.as_ptr() <span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_</span>,
host.len(),
))
.map(|<span class="kw">_</span>| ())
}
}
<span class="doccomment">/// Set the expected IPv4 or IPv6 address.
</span><span class="attribute">#[corresponds(X509_VERIFY_PARAM_set1_ip)]
</span><span class="kw">pub fn </span>set_ip(<span class="kw-2">&amp;mut </span><span class="self">self</span>, ip: IpAddr) -&gt; <span class="prelude-ty">Result</span>&lt;(), ErrorStack&gt; {
<span class="kw">unsafe </span>{
<span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">16</span>];
<span class="kw">let </span>len = <span class="kw">match </span>ip {
IpAddr::V4(addr) =&gt; {
buf[..<span class="number">4</span>].copy_from_slice(<span class="kw-2">&amp;</span>addr.octets());
<span class="number">4
</span>}
IpAddr::V6(addr) =&gt; {
buf.copy_from_slice(<span class="kw-2">&amp;</span>addr.octets());
<span class="number">16
</span>}
};
cvt(ffi::X509_VERIFY_PARAM_set1_ip(
<span class="self">self</span>.as_ptr(),
buf.as_ptr() <span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_</span>,
len,
))
.map(|<span class="kw">_</span>| ())
}
}
<span class="doccomment">/// Set the verification time, where time is of type time_t, traditionaly defined as seconds since the epoch
</span><span class="attribute">#[corresponds(X509_VERIFY_PARAM_set_time)]
</span><span class="kw">pub fn </span>set_time(<span class="kw-2">&amp;mut </span><span class="self">self</span>, time: time_t) {
<span class="kw">unsafe </span>{ ffi::X509_VERIFY_PARAM_set_time(<span class="self">self</span>.as_ptr(), time) }
}
<span class="doccomment">/// Set the verification depth
</span><span class="attribute">#[corresponds(X509_VERIFY_PARAM_set_depth)]
</span><span class="kw">pub fn </span>set_depth(<span class="kw-2">&amp;mut </span><span class="self">self</span>, depth: c_int) {
<span class="kw">unsafe </span>{ ffi::X509_VERIFY_PARAM_set_depth(<span class="self">self</span>.as_ptr(), depth) }
}
<span class="doccomment">/// Sets the authentication security level to auth_level
</span><span class="attribute">#[corresponds(X509_VERIFY_PARAM_set_auth_level)]
#[cfg(ossl110)]
</span><span class="kw">pub fn </span>set_auth_level(<span class="kw-2">&amp;mut </span><span class="self">self</span>, lvl: c_int) {
<span class="kw">unsafe </span>{ ffi::X509_VERIFY_PARAM_set_auth_level(<span class="self">self</span>.as_ptr(), lvl) }
}
<span class="doccomment">/// Gets the current authentication security level
</span><span class="attribute">#[corresponds(X509_VERIFY_PARAM_get_auth_level)]
#[cfg(ossl110)]
</span><span class="kw">pub fn </span>auth_level(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; i32 {
<span class="kw">unsafe </span>{ ffi::X509_VERIFY_PARAM_get_auth_level(<span class="self">self</span>.as_ptr()) }
}
<span class="doccomment">/// Sets the verification purpose
</span><span class="attribute">#[corresponds(X509_VERIFY_PARAM_set_purpose)]
#[cfg(ossl102)]
</span><span class="kw">pub fn </span>set_purpose(<span class="kw-2">&amp;mut </span><span class="self">self</span>, purpose: X509PurposeId) -&gt; <span class="prelude-ty">Result</span>&lt;(), ErrorStack&gt; {
<span class="kw">unsafe </span>{ cvt(ffi::X509_VERIFY_PARAM_set_purpose(<span class="self">self</span>.as_ptr(), purpose.<span class="number">0</span>)).map(|<span class="kw">_</span>| ()) }
}
}
</code></pre></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>