| <!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/ring-0.16.20/src/pkcs8.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>pkcs8.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="../../ring/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="../../ring/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> |
| </pre><pre class="rust"><code><span class="comment">// Copyright 2017 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 "AS IS" 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="doccomment">//! PKCS#8 is specified in [RFC 5958]. |
| //! |
| //! [RFC 5958]: https://tools.ietf.org/html/rfc5958. |
| |
| </span><span class="kw">use crate</span>::{ec, error, io::der}; |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>Version { |
| V1Only, |
| V1OrV2, |
| V2Only, |
| } |
| |
| <span class="doccomment">/// A template for constructing PKCS#8 documents. |
| /// |
| /// Note that this only works for ECC. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>Template { |
| <span class="kw">pub </span>bytes: <span class="kw-2">&</span><span class="lifetime">'static </span>[u8], |
| |
| <span class="comment">// The range within `bytes` that holds the value (not including the tag and |
| // length) for use in the PKCS#8 document's privateKeyAlgorithm field. |
| </span><span class="kw">pub </span>alg_id_range: core::ops::Range<usize>, |
| |
| <span class="comment">// `bytes[alg_id_range][curve_id_index..]` contains the OID identifying the, |
| // curve, including the tag and length. |
| </span><span class="kw">pub </span>curve_id_index: usize, |
| |
| <span class="comment">// `bytes` will be split into two parts at `private_key_index`, where the |
| // first part is written before the private key and the second part is |
| // written after the private key. The public key is written after the second |
| // part. |
| </span><span class="kw">pub </span>private_key_index: usize, |
| } |
| |
| <span class="kw">impl </span>Template { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>alg_id_value(<span class="kw-2">&</span><span class="self">self</span>) -> untrusted::Input { |
| untrusted::Input::from(<span class="self">self</span>.alg_id_value_()) |
| } |
| |
| <span class="kw">fn </span>alg_id_value_(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[u8] { |
| <span class="kw-2">&</span><span class="self">self</span>.bytes[<span class="self">self</span>.alg_id_range.start..<span class="self">self</span>.alg_id_range.end] |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>curve_oid(<span class="kw-2">&</span><span class="self">self</span>) -> untrusted::Input { |
| untrusted::Input::from(<span class="kw-2">&</span><span class="self">self</span>.alg_id_value_()[<span class="self">self</span>.curve_id_index..]) |
| } |
| } |
| |
| <span class="doccomment">/// Parses an unencrypted PKCS#8 private key, verifies that it is the right type |
| /// of key, and returns the key value. |
| /// |
| /// PKCS#8 is specified in [RFC 5958]. |
| /// |
| /// [RFC 5958]: https://tools.ietf.org/html/rfc5958. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>unwrap_key<<span class="lifetime">'a</span>>( |
| template: <span class="kw-2">&</span>Template, |
| version: Version, |
| input: untrusted::Input<<span class="lifetime">'a</span>>, |
| ) -> <span class="prelude-ty">Result</span><(untrusted::Input<<span class="lifetime">'a</span>>, <span class="prelude-ty">Option</span><untrusted::Input<<span class="lifetime">'a</span>>>), error::KeyRejected> { |
| unwrap_key_(template.alg_id_value(), version, input) |
| } |
| |
| <span class="doccomment">/// Parses an unencrypted PKCS#8 private key, verifies that it is the right type |
| /// of key, and returns the key value. |
| /// |
| /// `alg_id` must be the encoded value (not including the outermost `SEQUENCE` |
| /// tag and length) of the `AlgorithmIdentifier` that identifies the key type. |
| /// The result will be an encoded `RSAPrivateKey` or `ECPrivateKey` or similar. |
| /// |
| /// PKCS#8 is specified in [RFC 5958]. |
| /// |
| /// [RFC 5958]: https://tools.ietf.org/html/rfc5958. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>unwrap_key_<<span class="lifetime">'a</span>>( |
| alg_id: untrusted::Input, |
| version: Version, |
| input: untrusted::Input<<span class="lifetime">'a</span>>, |
| ) -> <span class="prelude-ty">Result</span><(untrusted::Input<<span class="lifetime">'a</span>>, <span class="prelude-ty">Option</span><untrusted::Input<<span class="lifetime">'a</span>>>), error::KeyRejected> { |
| input.read_all(error::KeyRejected::invalid_encoding(), |input| { |
| der::nested( |
| input, |
| der::Tag::Sequence, |
| error::KeyRejected::invalid_encoding(), |
| |input| unwrap_key__(alg_id, version, input), |
| ) |
| }) |
| } |
| |
| <span class="kw">fn </span>unwrap_key__<<span class="lifetime">'a</span>>( |
| alg_id: untrusted::Input, |
| version: Version, |
| input: <span class="kw-2">&mut </span>untrusted::Reader<<span class="lifetime">'a</span>>, |
| ) -> <span class="prelude-ty">Result</span><(untrusted::Input<<span class="lifetime">'a</span>>, <span class="prelude-ty">Option</span><untrusted::Input<<span class="lifetime">'a</span>>>), error::KeyRejected> { |
| <span class="kw">let </span>actual_version = der::small_nonnegative_integer(input) |
| .map_err(|error::Unspecified| error::KeyRejected::invalid_encoding())<span class="question-mark">?</span>; |
| |
| <span class="comment">// Do things in a specific order to return more useful errors: |
| // 1. Check for completely unsupported version. |
| // 2. Check for algorithm mismatch. |
| // 3. Check for algorithm-specific version mismatch. |
| |
| </span><span class="kw">if </span>actual_version > <span class="number">1 </span>{ |
| <span class="kw">return </span><span class="prelude-val">Err</span>(error::KeyRejected::version_not_supported()); |
| }; |
| |
| <span class="kw">let </span>actual_alg_id = der::expect_tag_and_get_value(input, der::Tag::Sequence) |
| .map_err(|error::Unspecified| error::KeyRejected::invalid_encoding())<span class="question-mark">?</span>; |
| <span class="kw">if </span>actual_alg_id != alg_id { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(error::KeyRejected::wrong_algorithm()); |
| } |
| |
| <span class="kw">let </span>require_public_key = <span class="kw">match </span>(actual_version, version) { |
| (<span class="number">0</span>, Version::V1Only) => <span class="bool-val">false</span>, |
| (<span class="number">0</span>, Version::V1OrV2) => <span class="bool-val">false</span>, |
| (<span class="number">1</span>, Version::V1OrV2) | (<span class="number">1</span>, Version::V2Only) => <span class="bool-val">true</span>, |
| <span class="kw">_ </span>=> { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(error::KeyRejected::version_not_supported()); |
| } |
| }; |
| |
| <span class="kw">let </span>private_key = der::expect_tag_and_get_value(input, der::Tag::OctetString) |
| .map_err(|error::Unspecified| error::KeyRejected::invalid_encoding())<span class="question-mark">?</span>; |
| |
| <span class="comment">// Ignore any attributes that are present. |
| </span><span class="kw">if </span>input.peek(der::Tag::ContextSpecificConstructed0 <span class="kw">as </span>u8) { |
| <span class="kw">let _ </span>= der::expect_tag_and_get_value(input, der::Tag::ContextSpecificConstructed0) |
| .map_err(|error::Unspecified| error::KeyRejected::invalid_encoding())<span class="question-mark">?</span>; |
| } |
| |
| <span class="kw">let </span>public_key = <span class="kw">if </span>require_public_key { |
| <span class="kw">if </span>input.at_end() { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(error::KeyRejected::public_key_is_missing()); |
| } |
| <span class="kw">let </span>public_key = der::nested( |
| input, |
| der::Tag::ContextSpecificConstructed1, |
| error::Unspecified, |
| der::bit_string_with_no_unused_bits, |
| ) |
| .map_err(|error::Unspecified| error::KeyRejected::invalid_encoding())<span class="question-mark">?</span>; |
| <span class="prelude-val">Some</span>(public_key) |
| } <span class="kw">else </span>{ |
| <span class="prelude-val">None |
| </span>}; |
| |
| <span class="prelude-val">Ok</span>((private_key, public_key)) |
| } |
| |
| <span class="doccomment">/// A generated PKCS#8 document. |
| </span><span class="kw">pub struct </span>Document { |
| bytes: [u8; ec::PKCS8_DOCUMENT_MAX_LEN], |
| len: usize, |
| } |
| |
| <span class="kw">impl </span>AsRef<[u8]> <span class="kw">for </span>Document { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>as_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[u8] { |
| <span class="kw-2">&</span><span class="self">self</span>.bytes[..<span class="self">self</span>.len] |
| } |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>wrap_key(template: <span class="kw-2">&</span>Template, private_key: <span class="kw-2">&</span>[u8], public_key: <span class="kw-2">&</span>[u8]) -> Document { |
| <span class="kw">let </span><span class="kw-2">mut </span>result = Document { |
| bytes: [<span class="number">0</span>; ec::PKCS8_DOCUMENT_MAX_LEN], |
| len: template.bytes.len() + private_key.len() + public_key.len(), |
| }; |
| wrap_key_( |
| template, |
| private_key, |
| public_key, |
| <span class="kw-2">&mut </span>result.bytes[..result.len], |
| ); |
| result |
| } |
| |
| <span class="doccomment">/// Formats a private key "prefix||private_key||middle||public_key" where |
| /// `template` is "prefix||middle" split at position `private_key_index`. |
| </span><span class="kw">fn </span>wrap_key_(template: <span class="kw-2">&</span>Template, private_key: <span class="kw-2">&</span>[u8], public_key: <span class="kw-2">&</span>[u8], bytes: <span class="kw-2">&mut </span>[u8]) { |
| <span class="kw">let </span>(before_private_key, after_private_key) = |
| template.bytes.split_at(template.private_key_index); |
| <span class="kw">let </span>private_key_end_index = template.private_key_index + private_key.len(); |
| bytes[..template.private_key_index].copy_from_slice(before_private_key); |
| bytes[template.private_key_index..private_key_end_index].copy_from_slice(<span class="kw-2">&</span>private_key); |
| bytes[private_key_end_index..(private_key_end_index + after_private_key.len())] |
| .copy_from_slice(after_private_key); |
| bytes[(private_key_end_index + after_private_key.len())..].copy_from_slice(public_key); |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="ring" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
