blob: 7227458bc4f46461c86625d155086c269cb9df26 [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/webpki-0.21.4/src/cert.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>cert.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="../../webpki/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="../../webpki/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>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
</pre><pre class="rust"><code><span class="comment">// Copyright 2015 Brian Smith.
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHORS DISCLAIM ALL WARRANTIES
// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
</span><span class="kw">use crate</span>::{der, signed_data, Error};
<span class="kw">pub enum </span>EndEntityOrCA&lt;<span class="lifetime">&#39;a</span>&gt; {
EndEntity,
CA(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Cert&lt;<span class="lifetime">&#39;a</span>&gt;),
}
<span class="kw">pub struct </span>Cert&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">pub </span>ee_or_ca: EndEntityOrCA&lt;<span class="lifetime">&#39;a</span>&gt;,
<span class="kw">pub </span>signed_data: signed_data::SignedData&lt;<span class="lifetime">&#39;a</span>&gt;,
<span class="kw">pub </span>issuer: untrusted::Input&lt;<span class="lifetime">&#39;a</span>&gt;,
<span class="kw">pub </span>validity: untrusted::Input&lt;<span class="lifetime">&#39;a</span>&gt;,
<span class="kw">pub </span>subject: untrusted::Input&lt;<span class="lifetime">&#39;a</span>&gt;,
<span class="kw">pub </span>spki: der::Value&lt;<span class="lifetime">&#39;a</span>&gt;,
<span class="kw">pub </span>basic_constraints: <span class="prelude-ty">Option</span>&lt;untrusted::Input&lt;<span class="lifetime">&#39;a</span>&gt;&gt;,
<span class="kw">pub </span>eku: <span class="prelude-ty">Option</span>&lt;untrusted::Input&lt;<span class="lifetime">&#39;a</span>&gt;&gt;,
<span class="kw">pub </span>name_constraints: <span class="prelude-ty">Option</span>&lt;untrusted::Input&lt;<span class="lifetime">&#39;a</span>&gt;&gt;,
<span class="kw">pub </span>subject_alt_name: <span class="prelude-ty">Option</span>&lt;untrusted::Input&lt;<span class="lifetime">&#39;a</span>&gt;&gt;,
}
<span class="kw">pub fn </span>parse_cert&lt;<span class="lifetime">&#39;a</span>&gt;(
cert_der: untrusted::Input&lt;<span class="lifetime">&#39;a</span>&gt;, ee_or_ca: EndEntityOrCA&lt;<span class="lifetime">&#39;a</span>&gt;,
) -&gt; <span class="prelude-ty">Result</span>&lt;Cert&lt;<span class="lifetime">&#39;a</span>&gt;, Error&gt; {
parse_cert_internal(cert_der, ee_or_ca, certificate_serial_number)
}
<span class="doccomment">/// Used by `parse_cert` for regular certificates (end-entity and intermediate)
/// and by `cert_der_as_trust_anchor` for trust anchors encoded as
/// certificates.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>parse_cert_internal&lt;<span class="lifetime">&#39;a</span>&gt;(
cert_der: untrusted::Input&lt;<span class="lifetime">&#39;a</span>&gt;, ee_or_ca: EndEntityOrCA&lt;<span class="lifetime">&#39;a</span>&gt;,
serial_number: <span class="kw">fn</span>(input: <span class="kw-2">&amp;mut </span>untrusted::Reader&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt;,
) -&gt; <span class="prelude-ty">Result</span>&lt;Cert&lt;<span class="lifetime">&#39;a</span>&gt;, Error&gt; {
<span class="kw">let </span>(tbs, signed_data) = cert_der.read_all(Error::BadDER, |cert_der| {
der::nested(
cert_der,
der::Tag::Sequence,
Error::BadDER,
signed_data::parse_signed_data,
)
})<span class="question-mark">?</span>;
tbs.read_all(Error::BadDER, |tbs| {
version3(tbs)<span class="question-mark">?</span>;
serial_number(tbs)<span class="question-mark">?</span>;
<span class="kw">let </span>signature = der::expect_tag_and_get_value(tbs, der::Tag::Sequence)<span class="question-mark">?</span>;
<span class="comment">// TODO: In mozilla::pkix, the comparison is done based on the
// normalized value (ignoring whether or not there is an optional NULL
// parameter for RSA-based algorithms), so this may be too strict.
</span><span class="kw">if </span>signature != signed_data.algorithm {
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::SignatureAlgorithmMismatch);
}
<span class="kw">let </span>issuer = der::expect_tag_and_get_value(tbs, der::Tag::Sequence)<span class="question-mark">?</span>;
<span class="kw">let </span>validity = der::expect_tag_and_get_value(tbs, der::Tag::Sequence)<span class="question-mark">?</span>;
<span class="kw">let </span>subject = der::expect_tag_and_get_value(tbs, der::Tag::Sequence)<span class="question-mark">?</span>;
<span class="kw">let </span>spki = der::expect_tag(tbs, der::Tag::Sequence)<span class="question-mark">?</span>;
<span class="comment">// In theory there could be fields [1] issuerUniqueID and [2]
// subjectUniqueID, but in practice there never are, and to keep the
// code small and simple we don&#39;t accept any certificates that do
// contain them.
</span><span class="kw">let </span><span class="kw-2">mut </span>cert = Cert {
ee_or_ca,
signed_data,
issuer,
validity,
subject,
spki,
basic_constraints: <span class="prelude-val">None</span>,
eku: <span class="prelude-val">None</span>,
name_constraints: <span class="prelude-val">None</span>,
subject_alt_name: <span class="prelude-val">None</span>,
};
<span class="comment">// mozilla::pkix allows the extensions to be omitted. However, since
// the subjectAltName extension is mandatory, the extensions are
// mandatory too, and we enforce that. Also, mozilla::pkix includes
// special logic for handling critical Netscape Cert Type extensions.
// That has been intentionally omitted.
</span>der::nested_mut(
tbs,
der::Tag::ContextSpecificConstructed3,
Error::BadDER,
|tagged| {
der::nested_of_mut(
tagged,
der::Tag::Sequence,
der::Tag::Sequence,
Error::BadDER,
|extension| {
<span class="kw">let </span>extn_id = der::expect_tag_and_get_value(extension, der::Tag::OID)<span class="question-mark">?</span>;
<span class="kw">let </span>critical = der::optional_boolean(extension)<span class="question-mark">?</span>;
<span class="kw">let </span>extn_value =
der::expect_tag_and_get_value(extension, der::Tag::OctetString)<span class="question-mark">?</span>;
<span class="kw">match </span>remember_extension(<span class="kw-2">&amp;mut </span>cert, extn_id, extn_value)<span class="question-mark">? </span>{
Understood::No <span class="kw">if </span>critical =&gt; <span class="prelude-val">Err</span>(Error::UnsupportedCriticalExtension),
<span class="kw">_ </span>=&gt; <span class="prelude-val">Ok</span>(()),
}
},
)
},
)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(cert)
})
}
<span class="comment">// mozilla::pkix supports v1, v2, v3, and v4, including both the implicit
// (correct) and explicit (incorrect) encoding of v1. We allow only v3.
</span><span class="kw">fn </span>version3(input: <span class="kw-2">&amp;mut </span>untrusted::Reader) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
der::nested(
input,
der::Tag::ContextSpecificConstructed0,
Error::BadDER,
|input| {
<span class="kw">let </span>version = der::small_nonnegative_integer(input)<span class="question-mark">?</span>;
<span class="kw">if </span>version != <span class="number">2 </span>{
<span class="comment">// v3
</span><span class="kw">return </span><span class="prelude-val">Err</span>(Error::UnsupportedCertVersion);
}
<span class="prelude-val">Ok</span>(())
},
)
}
<span class="kw">pub fn </span>certificate_serial_number(input: <span class="kw-2">&amp;mut </span>untrusted::Reader) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<span class="comment">// https://tools.ietf.org/html/rfc5280#section-4.1.2.2:
// * Conforming CAs MUST NOT use serialNumber values longer than 20 octets.&quot;
// * &quot;The serial number MUST be a positive integer [...]&quot;
</span><span class="kw">let </span>value = der::positive_integer(input)<span class="question-mark">?</span>;
<span class="kw">if </span>value.big_endian_without_leading_zero().len() &gt; <span class="number">20 </span>{
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::BadDER);
}
<span class="prelude-val">Ok</span>(())
}
<span class="kw">enum </span>Understood {
Yes,
No,
}
<span class="kw">fn </span>remember_extension&lt;<span class="lifetime">&#39;a</span>&gt;(
cert: <span class="kw-2">&amp;mut </span>Cert&lt;<span class="lifetime">&#39;a</span>&gt;, extn_id: untrusted::Input, value: untrusted::Input&lt;<span class="lifetime">&#39;a</span>&gt;,
) -&gt; <span class="prelude-ty">Result</span>&lt;Understood, Error&gt; {
<span class="comment">// We don&#39;t do anything with certificate policies so we can safely ignore
// all policy-related stuff. We assume that the policy-related extensions
// are not marked critical.
// id-ce 2.5.29
</span><span class="kw">static </span>ID_CE: [u8; <span class="number">2</span>] = <span class="macro">oid!</span>[<span class="number">2</span>, <span class="number">5</span>, <span class="number">29</span>];
<span class="kw">if </span>extn_id.len() != ID_CE.len() + <span class="number">1 </span>|| !extn_id.as_slice_less_safe().starts_with(<span class="kw-2">&amp;</span>ID_CE) {
<span class="kw">return </span><span class="prelude-val">Ok</span>(Understood::No);
}
<span class="kw">let </span>out = <span class="kw">match </span><span class="kw-2">*</span>extn_id.as_slice_less_safe().last().unwrap() {
<span class="comment">// id-ce-keyUsage 2.5.29.15. We ignore the KeyUsage extension. For CA
// certificates, BasicConstraints.cA makes KeyUsage redundant. Firefox
// and other common browsers do not check KeyUsage for end-entities,
// though it would be kind of nice to ensure that a KeyUsage without
// the keyEncipherment bit could not be used for RSA key exchange.
</span><span class="number">15 </span>=&gt; {
<span class="kw">return </span><span class="prelude-val">Ok</span>(Understood::Yes);
},
<span class="comment">// id-ce-subjectAltName 2.5.29.17
</span><span class="number">17 </span>=&gt; <span class="kw-2">&amp;mut </span>cert.subject_alt_name,
<span class="comment">// id-ce-basicConstraints 2.5.29.19
</span><span class="number">19 </span>=&gt; <span class="kw-2">&amp;mut </span>cert.basic_constraints,
<span class="comment">// id-ce-nameConstraints 2.5.29.30
</span><span class="number">30 </span>=&gt; <span class="kw-2">&amp;mut </span>cert.name_constraints,
<span class="comment">// id-ce-extKeyUsage 2.5.29.37
</span><span class="number">37 </span>=&gt; <span class="kw-2">&amp;mut </span>cert.eku,
<span class="kw">_ </span>=&gt; {
<span class="kw">return </span><span class="prelude-val">Ok</span>(Understood::No);
},
};
<span class="kw">match </span><span class="kw-2">*</span>out {
<span class="prelude-val">Some</span>(..) =&gt; {
<span class="comment">// The certificate contains more than one instance of this
// extension.
</span><span class="kw">return </span><span class="prelude-val">Err</span>(Error::ExtensionValueInvalid);
},
<span class="prelude-val">None </span>=&gt; {
<span class="comment">// All the extensions that we care about are wrapped in a SEQUENCE.
</span><span class="kw">let </span>sequence_value = value.read_all(Error::BadDER, |value| {
der::expect_tag_and_get_value(value, der::Tag::Sequence)
})<span class="question-mark">?</span>;
<span class="kw-2">*</span>out = <span class="prelude-val">Some</span>(sequence_value);
},
}
<span class="prelude-val">Ok</span>(Understood::Yes)
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="webpki" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>