Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-enclave / src / webpki / der.rs.html
blob: 4191e08fa383ca2405e19854eb04c899dd40a6cb [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/der.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>der.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>
</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>::{calendar, time, Error};
<span class="kw">pub use </span>ring::io::{
der::{nested, Tag, CONSTRUCTED},
Positive,
};
<span class="attribute">#[inline(always)]
</span><span class="kw">pub fn </span>expect_tag_and_get_value&lt;<span class="lifetime">&#39;a</span>&gt;(
input: <span class="kw-2">&amp;mut </span>untrusted::Reader&lt;<span class="lifetime">&#39;a</span>&gt;, tag: Tag,
) -&gt; <span class="prelude-ty">Result</span>&lt;untrusted::Input&lt;<span class="lifetime">&#39;a</span>&gt;, Error&gt; {
ring::io::der::expect_tag_and_get_value(input, tag).map_err(|<span class="kw">_</span>| Error::BadDER)
}
<span class="kw">pub struct </span>Value&lt;<span class="lifetime">&#39;a</span>&gt; {
tlv: untrusted::Input&lt;<span class="lifetime">&#39;a</span>&gt;,
value: untrusted::Input&lt;<span class="lifetime">&#39;a</span>&gt;,
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Value&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="attribute">#[allow(dead_code)] </span><span class="comment">// TODO: remove this.
</span><span class="kw">pub fn </span>tlv(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; untrusted::Input&lt;<span class="lifetime">&#39;a</span>&gt; { <span class="self">self</span>.tlv }
<span class="kw">pub fn </span>value(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; untrusted::Input&lt;<span class="lifetime">&#39;a</span>&gt; { <span class="self">self</span>.value }
}
<span class="kw">pub fn </span>expect_tag&lt;<span class="lifetime">&#39;a</span>&gt;(input: <span class="kw-2">&amp;mut </span>untrusted::Reader&lt;<span class="lifetime">&#39;a</span>&gt;, tag: Tag) -&gt; <span class="prelude-ty">Result</span>&lt;Value&lt;<span class="lifetime">&#39;a</span>&gt;, Error&gt; {
<span class="kw">let </span>start = input.mark();
<span class="kw">let </span>(actual_tag, value) = read_tag_and_get_value(input)<span class="question-mark">?</span>;
<span class="kw">if </span>usize::from(tag) != usize::from(actual_tag) {
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::BadDER);
}
<span class="kw">let </span>end = input.mark();
<span class="kw">let </span>tlv = input
.get_input_between_marks(start, end)
.map_err(|untrusted::EndOfInput| Error::BadDER)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(Value { tlv, value })
}
<span class="attribute">#[inline(always)]
</span><span class="kw">pub fn </span>read_tag_and_get_value&lt;<span class="lifetime">&#39;a</span>&gt;(
input: <span class="kw-2">&amp;mut </span>untrusted::Reader&lt;<span class="lifetime">&#39;a</span>&gt;,
) -&gt; <span class="prelude-ty">Result</span>&lt;(u8, untrusted::Input&lt;<span class="lifetime">&#39;a</span>&gt;), Error&gt; {
ring::io::der::read_tag_and_get_value(input).map_err(|<span class="kw">_</span>| Error::BadDER)
}
<span class="comment">// TODO: investigate taking decoder as a reference to reduce generated code
// size.
</span><span class="attribute">#[inline(always)]
</span><span class="kw">pub fn </span>nested_mut&lt;<span class="lifetime">&#39;a</span>, F, R, E: Copy&gt;(
input: <span class="kw-2">&amp;mut </span>untrusted::Reader&lt;<span class="lifetime">&#39;a</span>&gt;, tag: Tag, error: E, decoder: F,
) -&gt; <span class="prelude-ty">Result</span>&lt;R, E&gt;
<span class="kw">where
</span>F: FnMut(<span class="kw-2">&amp;mut </span>untrusted::Reader&lt;<span class="lifetime">&#39;a</span>&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;R, E&gt;,
{
<span class="kw">let </span>inner = expect_tag_and_get_value(input, tag).map_err(|<span class="kw">_</span>| error)<span class="question-mark">?</span>;
inner.read_all(error, decoder).map_err(|<span class="kw">_</span>| error)
}
<span class="comment">// TODO: investigate taking decoder as a reference to reduce generated code
// size.
</span><span class="kw">pub fn </span>nested_of_mut&lt;<span class="lifetime">&#39;a</span>, F, E: Copy&gt;(
input: <span class="kw-2">&amp;mut </span>untrusted::Reader&lt;<span class="lifetime">&#39;a</span>&gt;, outer_tag: Tag, inner_tag: Tag, error: E, <span class="kw-2">mut </span>decoder: F,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), E&gt;
<span class="kw">where
</span>F: FnMut(<span class="kw-2">&amp;mut </span>untrusted::Reader&lt;<span class="lifetime">&#39;a</span>&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;(), E&gt;,
{
nested_mut(input, outer_tag, error, |outer| {
<span class="kw">loop </span>{
nested_mut(outer, inner_tag, error, |inner| decoder(inner))<span class="question-mark">?</span>;
<span class="kw">if </span>outer.at_end() {
<span class="kw">break</span>;
}
}
<span class="prelude-val">Ok</span>(())
})
}
<span class="kw">pub fn </span>bit_string_with_no_unused_bits&lt;<span class="lifetime">&#39;a</span>&gt;(
input: <span class="kw-2">&amp;mut </span>untrusted::Reader&lt;<span class="lifetime">&#39;a</span>&gt;,
) -&gt; <span class="prelude-ty">Result</span>&lt;untrusted::Input&lt;<span class="lifetime">&#39;a</span>&gt;, Error&gt; {
nested(input, Tag::BitString, Error::BadDER, |value| {
<span class="kw">let </span>unused_bits_at_end = value.read_byte().map_err(|<span class="kw">_</span>| Error::BadDER)<span class="question-mark">?</span>;
<span class="kw">if </span>unused_bits_at_end != <span class="number">0 </span>{
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::BadDER);
}
<span class="prelude-val">Ok</span>(value.read_bytes_to_end())
})
}
<span class="comment">// Like mozilla::pkix, we accept the nonconformant explicit encoding of
// the default value (false) for compatibility with real-world certificates.
</span><span class="kw">pub fn </span>optional_boolean(input: <span class="kw-2">&amp;mut </span>untrusted::Reader) -&gt; <span class="prelude-ty">Result</span>&lt;bool, Error&gt; {
<span class="kw">if </span>!input.peek(Tag::Boolean <span class="kw">as </span>u8) {
<span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="bool-val">false</span>);
}
nested(input, Tag::Boolean, Error::BadDER, |input| {
<span class="kw">match </span>input.read_byte() {
<span class="prelude-val">Ok</span>(<span class="number">0xff</span>) =&gt; <span class="prelude-val">Ok</span>(<span class="bool-val">true</span>),
<span class="prelude-val">Ok</span>(<span class="number">0x00</span>) =&gt; <span class="prelude-val">Ok</span>(<span class="bool-val">false</span>),
<span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(Error::BadDER),
}
})
}
<span class="kw">pub fn </span>positive_integer&lt;<span class="lifetime">&#39;a</span>&gt;(input: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>untrusted::Reader) -&gt; <span class="prelude-ty">Result</span>&lt;Positive&lt;<span class="lifetime">&#39;a</span>&gt;, Error&gt; {
ring::io::der::positive_integer(input).map_err(|<span class="kw">_</span>| Error::BadDER)
}
<span class="kw">pub fn </span>small_nonnegative_integer&lt;<span class="lifetime">&#39;a</span>&gt;(input: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>untrusted::Reader) -&gt; <span class="prelude-ty">Result</span>&lt;u8, Error&gt; {
ring::io::der::small_nonnegative_integer(input).map_err(|<span class="kw">_</span>| Error::BadDER)
}
<span class="kw">pub fn </span>time_choice&lt;<span class="lifetime">&#39;a</span>&gt;(input: <span class="kw-2">&amp;mut </span>untrusted::Reader&lt;<span class="lifetime">&#39;a</span>&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;time::Time, Error&gt; {
<span class="kw">let </span>is_utc_time = input.peek(Tag::UTCTime <span class="kw">as </span>u8);
<span class="kw">let </span>expected_tag = <span class="kw">if </span>is_utc_time {
Tag::UTCTime
} <span class="kw">else </span>{
Tag::GeneralizedTime
};
<span class="kw">fn </span>read_digit(inner: <span class="kw-2">&amp;mut </span>untrusted::Reader) -&gt; <span class="prelude-ty">Result</span>&lt;u64, Error&gt; {
<span class="kw">let </span>b = inner.read_byte().map_err(|<span class="kw">_</span>| Error::BadDERTime)<span class="question-mark">?</span>;
<span class="kw">if </span>b &lt; <span class="string">b&#39;0&#39; </span>|| b &gt; <span class="string">b&#39;9&#39; </span>{
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::BadDERTime);
}
<span class="prelude-val">Ok</span>((b - <span class="string">b&#39;0&#39;</span>) <span class="kw">as </span>u64)
}
<span class="kw">fn </span>read_two_digits(inner: <span class="kw-2">&amp;mut </span>untrusted::Reader, min: u64, max: u64) -&gt; <span class="prelude-ty">Result</span>&lt;u64, Error&gt; {
<span class="kw">let </span>hi = read_digit(inner)<span class="question-mark">?</span>;
<span class="kw">let </span>lo = read_digit(inner)<span class="question-mark">?</span>;
<span class="kw">let </span>value = (hi * <span class="number">10</span>) + lo;
<span class="kw">if </span>value &lt; min || value &gt; max {
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::BadDERTime);
}
<span class="prelude-val">Ok</span>(value)
}
nested(input, expected_tag, Error::BadDER, |value| {
<span class="kw">let </span>(year_hi, year_lo) = <span class="kw">if </span>is_utc_time {
<span class="kw">let </span>lo = read_two_digits(value, <span class="number">0</span>, <span class="number">99</span>)<span class="question-mark">?</span>;
<span class="kw">let </span>hi = <span class="kw">if </span>lo &gt;= <span class="number">50 </span>{ <span class="number">19 </span>} <span class="kw">else </span>{ <span class="number">20 </span>};
(hi, lo)
} <span class="kw">else </span>{
<span class="kw">let </span>hi = read_two_digits(value, <span class="number">0</span>, <span class="number">99</span>)<span class="question-mark">?</span>;
<span class="kw">let </span>lo = read_two_digits(value, <span class="number">0</span>, <span class="number">99</span>)<span class="question-mark">?</span>;
(hi, lo)
};
<span class="kw">let </span>year = (year_hi * <span class="number">100</span>) + year_lo;
<span class="kw">let </span>month = read_two_digits(value, <span class="number">1</span>, <span class="number">12</span>)<span class="question-mark">?</span>;
<span class="kw">let </span>days_in_month = calendar::days_in_month(year, month);
<span class="kw">let </span>day_of_month = read_two_digits(value, <span class="number">1</span>, days_in_month)<span class="question-mark">?</span>;
<span class="kw">let </span>hours = read_two_digits(value, <span class="number">0</span>, <span class="number">23</span>)<span class="question-mark">?</span>;
<span class="kw">let </span>minutes = read_two_digits(value, <span class="number">0</span>, <span class="number">59</span>)<span class="question-mark">?</span>;
<span class="kw">let </span>seconds = read_two_digits(value, <span class="number">0</span>, <span class="number">59</span>)<span class="question-mark">?</span>;
<span class="kw">let </span>time_zone = value.read_byte().map_err(|<span class="kw">_</span>| Error::BadDERTime)<span class="question-mark">?</span>;
<span class="kw">if </span>time_zone != <span class="string">b&#39;Z&#39; </span>{
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::BadDERTime);
}
calendar::time_from_ymdhms_utc(year, month, day_of_month, hours, minutes, seconds)
})
}
<span class="macro">macro_rules! </span>oid {
( <span class="macro-nonterminal">$first</span>:expr, <span class="macro-nonterminal">$second</span>:expr, $( <span class="macro-nonterminal">$tail</span>:expr ),* ) =&gt;
(
[(<span class="number">40 </span>* <span class="macro-nonterminal">$first</span>) + <span class="macro-nonterminal">$second</span>, $( <span class="macro-nonterminal">$tail </span>),<span class="kw-2">*</span>]
)
}
</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>