blob: 33f9bb407d0b4b982993f90f32c956647c15ea89 [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 `attestation/src/key.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>key.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="../../teaclave_attestation/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="../../teaclave_attestation/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>
</pre><pre class="rust"><code><span class="comment">// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// &quot;License&quot;); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
</span><span class="doccomment">//! This module implements ECDSA (NIST P-256 curve) keys related functions. You
//! can export private key to a DER format or create a certificate with
//! extension for TLS-based remote attestation.
</span><span class="kw">use </span>anyhow::Result;
<span class="kw">use </span>sgx_crypto::ecc::{EcKeyPair, EcPublicKey};
<span class="doccomment">/// Validation days of cert for TLS connection.
</span><span class="kw">const </span>CERT_VALID_DAYS: i64 = <span class="number">90i64</span>;
<span class="doccomment">/// NistP256KeyPair stores a pair of ECDSA (private, public) key based on the
/// NIST P-256 curve (a.k.a secp256r1).
</span><span class="kw">pub struct </span>NistP256KeyPair {
inner: EcKeyPair,
}
<span class="kw">impl </span>NistP256KeyPair {
<span class="doccomment">/// Generate a ECDSA key pair.
</span><span class="kw">pub fn </span>new() -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>&gt; {
<span class="kw">let </span>inner = EcKeyPair::create()<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(<span class="self">Self </span>{ inner })
}
<span class="kw">pub fn </span>pub_k(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; EcPublicKey {
<span class="self">self</span>.inner.public_key()
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>private_key_into_der(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Vec&lt;u8&gt; {
<span class="kw">use </span>bit_vec::BitVec;
<span class="kw">use </span>yasna::construct_der;
<span class="kw">use </span>yasna::models::ObjectIdentifier;
<span class="kw">use </span>yasna::Tag;
<span class="comment">// Construct useful OIDs.
</span><span class="kw">let </span>ec_public_key_oid = ObjectIdentifier::from_slice(<span class="kw-2">&amp;</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">840</span>, <span class="number">10045</span>, <span class="number">2</span>, <span class="number">1</span>]);
<span class="kw">let </span>prime256v1_oid = ObjectIdentifier::from_slice(<span class="kw-2">&amp;</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">840</span>, <span class="number">10045</span>, <span class="number">3</span>, <span class="number">1</span>, <span class="number">7</span>]);
<span class="kw">let </span>pub_key_bytes = <span class="self">self</span>.public_key_into_bytes();
<span class="kw">let </span>prv_key_bytes = <span class="self">self</span>.private_key_into_bytes();
<span class="comment">// Construct private key in DER.
</span>construct_der(|writer| {
writer.write_sequence(|writer| {
writer.next().write_u8(<span class="number">0</span>);
writer.next().write_sequence(|writer| {
writer.next().write_oid(<span class="kw-2">&amp;</span>ec_public_key_oid);
writer.next().write_oid(<span class="kw-2">&amp;</span>prime256v1_oid);
});
<span class="kw">let </span>inner_key_der = construct_der(|writer| {
writer.write_sequence(|writer| {
writer.next().write_u8(<span class="number">1</span>);
writer.next().write_bytes(<span class="kw-2">&amp;</span>prv_key_bytes);
writer.next().write_tagged(Tag::context(<span class="number">1</span>), |writer| {
writer.write_bitvec(<span class="kw-2">&amp;</span>BitVec::from_bytes(<span class="kw-2">&amp;</span>pub_key_bytes));
});
});
});
writer.next().write_bytes(<span class="kw-2">&amp;</span>inner_key_der);
});
})
}
<span class="doccomment">/// create_cert_with_extension makes a self-signed x509-v3 cert with SGX
/// attestation report as extensions.
/// @reference [Internet X.509 Public Key Infrastructure Certificate and
/// Certificate Revocation List (CRL) Profile][1]
///
/// [1]: https://tools.ietf.org/pdf/rfc5280.pdf
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>create_cert_with_extension(
<span class="kw-2">&amp;</span><span class="self">self</span>,
issuer: <span class="kw-2">&amp;</span>str,
subject: <span class="kw-2">&amp;</span>str,
payload: <span class="kw-2">&amp;</span>[u8],
) -&gt; Vec&lt;u8&gt; {
<span class="kw">use </span><span class="kw">crate</span>::cert::<span class="kw-2">*</span>;
<span class="kw">use </span>bit_vec::BitVec;
<span class="kw">use </span>chrono::TimeZone;
<span class="kw">use </span>num_bigint::BigUint;
<span class="kw">use </span>std::time::SystemTime;
<span class="kw">use </span>std::time::UNIX_EPOCH;
<span class="attribute">#[allow(unused_imports)]
#[cfg(feature = <span class="string">&quot;mesalock_sgx&quot;</span>)]
</span><span class="kw">use </span>std::untrusted::time::SystemTimeEx;
<span class="kw">use </span>yasna::construct_der;
<span class="kw">use </span>yasna::models::{ObjectIdentifier, UTCTime};
<span class="comment">// Construct useful OIDs.
</span><span class="kw">let </span>ecdsa_with_sha256_oid = ObjectIdentifier::from_slice(<span class="kw-2">&amp;</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">840</span>, <span class="number">10045</span>, <span class="number">4</span>, <span class="number">3</span>, <span class="number">2</span>]);
<span class="kw">let </span>common_name_oid = ObjectIdentifier::from_slice(<span class="kw-2">&amp;</span>[<span class="number">2</span>, <span class="number">5</span>, <span class="number">4</span>, <span class="number">3</span>]);
<span class="kw">let </span>ec_public_key_oid = ObjectIdentifier::from_slice(<span class="kw-2">&amp;</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">840</span>, <span class="number">10045</span>, <span class="number">2</span>, <span class="number">1</span>]);
<span class="kw">let </span>prime256v1_oid = ObjectIdentifier::from_slice(<span class="kw-2">&amp;</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">840</span>, <span class="number">10045</span>, <span class="number">3</span>, <span class="number">1</span>, <span class="number">7</span>]);
<span class="kw">let </span>comment_oid = ObjectIdentifier::from_slice(<span class="kw-2">&amp;</span>[<span class="number">2</span>, <span class="number">16</span>, <span class="number">840</span>, <span class="number">1</span>, <span class="number">113_730</span>, <span class="number">1</span>, <span class="number">13</span>]);
<span class="kw">let </span>pub_key_bytes = <span class="self">self</span>.public_key_into_bytes();
<span class="comment">// UNIX_EPOCH is the earliest time stamp. This unwrap should constantly succeed.
</span><span class="kw">let </span>now = SystemTime::now().duration_since(UNIX_EPOCH).unwrap();
<span class="kw">let </span>issue_ts = chrono::Utc.timestamp_opt(now.as_secs() <span class="kw">as </span>i64, <span class="number">0</span>).unwrap();
<span class="comment">// This is guaranteed to be a valid duration.
</span><span class="kw">let </span>expire = now + chrono::Duration::days(CERT_VALID_DAYS).to_std().unwrap();
<span class="kw">let </span>expire_ts = chrono::Utc
.timestamp_opt(expire.as_secs() <span class="kw">as </span>i64, <span class="number">0</span>)
.unwrap();
<span class="comment">// Construct certificate with payload in extension in DER.
</span><span class="kw">let </span>tbs_cert_der = construct_der(|writer| {
<span class="kw">let </span>version = <span class="number">2i8</span>;
<span class="kw">let </span>serial = <span class="number">1u8</span>;
<span class="kw">let </span>cert_sign_algo = <span class="macro">asn1_seq!</span>(ecdsa_with_sha256_oid.clone());
<span class="kw">let </span>issuer = <span class="macro">asn1_seq!</span>(<span class="macro">asn1_seq!</span>(<span class="macro">asn1_seq!</span>(
common_name_oid.clone(),
issuer.to_owned()
)));
<span class="kw">let </span>valid_range = <span class="macro">asn1_seq!</span>(
UTCTime::from_datetime(<span class="kw-2">&amp;</span>issue_ts),
UTCTime::from_datetime(<span class="kw-2">&amp;</span>expire_ts),
);
<span class="kw">let </span>subject = <span class="macro">asn1_seq!</span>(<span class="macro">asn1_seq!</span>(<span class="macro">asn1_seq!</span>(
common_name_oid.clone(),
subject.to_string(),
)));
<span class="kw">let </span>pub_key = <span class="macro">asn1_seq!</span>(
<span class="macro">asn1_seq!</span>(ec_public_key_oid, prime256v1_oid,),
BitVec::from_bytes(<span class="kw-2">&amp;</span>pub_key_bytes),
);
<span class="kw">let </span>sgx_ra_cert_ext = <span class="macro">asn1_seq!</span>(<span class="macro">asn1_seq!</span>(comment_oid, payload.to_owned()));
<span class="kw">let </span>tbs_cert = <span class="macro">asn1_seq!</span>(
version,
serial,
cert_sign_algo,
issuer,
valid_range,
subject,
pub_key,
sgx_ra_cert_ext,
);
TbsCert::dump(writer, tbs_cert);
});
<span class="comment">// There will be serious problems if this call fails. We might as well
// panic in this case, thus unwrap()
</span><span class="kw">let </span>sig = <span class="self">self
</span>.inner
.private_key()
.sign(tbs_cert_der.as_slice())
.unwrap();
<span class="kw">let </span>sig_der = yasna::construct_der(|writer| {
writer.write_sequence(|writer| {
<span class="kw">let </span>sig = sig.signature();
<span class="kw">let </span><span class="kw-2">mut </span>sig_x = sig.x;
sig_x.reverse();
<span class="kw">let </span><span class="kw-2">mut </span>sig_y = sig.y;
sig_y.reverse();
writer.next().write_biguint(<span class="kw-2">&amp;</span>BigUint::from_slice(<span class="kw-2">&amp;</span>sig_x));
writer.next().write_biguint(<span class="kw-2">&amp;</span>BigUint::from_slice(<span class="kw-2">&amp;</span>sig_y));
});
});
yasna::construct_der(|writer| {
writer.write_sequence(|writer| {
writer.next().write_der(tbs_cert_der.as_slice());
CertSignAlgo::dump(writer.next(), <span class="macro">asn1_seq!</span>(ecdsa_with_sha256_oid.clone()));
writer
.next()
.write_bitvec(<span class="kw-2">&amp;</span>BitVec::from_bytes(sig_der.as_slice()));
});
})
}
<span class="kw">fn </span>public_key_into_bytes(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Vec&lt;u8&gt; {
<span class="comment">// The first byte must be 4, which indicates the uncompressed encoding.
</span><span class="kw">let </span><span class="kw-2">mut </span>pub_key_bytes: Vec&lt;u8&gt; = <span class="macro">vec!</span>[<span class="number">4</span>];
<span class="kw">let </span>public_key = <span class="self">self</span>.pub_k().public_key();
pub_key_bytes.extend(public_key.gx.iter().rev());
pub_key_bytes.extend(public_key.gy.iter().rev());
pub_key_bytes
}
<span class="kw">fn </span>private_key_into_bytes(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Vec&lt;u8&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>prv_key_bytes: Vec&lt;u8&gt; = <span class="macro">vec!</span>[];
<span class="kw">let </span>private_key = <span class="self">self</span>.inner.private_key().private_key();
prv_key_bytes.extend(private_key.r.iter().rev());
prv_key_bytes
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="teaclave_attestation" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>