blob: ffea4a4abe975cb53b909e5f03ff41ba8e5c410e [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/platform/sgx.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>sgx.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>
<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>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</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 provides SGX platform related functions like getting local
//! report and transform into a remotely verifiable quote.
</span><span class="attribute">#![cfg(feature = <span class="string">&quot;mesalock_sgx&quot;</span>)]
</span><span class="kw">use </span><span class="kw">super</span>::Result;
<span class="kw">use </span>log::debug;
<span class="kw">use </span>sgx_crypto::ecc::EcPublicKey;
<span class="kw">use </span>sgx_crypto::sha::Sha256;
<span class="kw">use </span>sgx_rand::{RdRand, Rng};
<span class="kw">use </span>sgx_tse::{EnclaveReport, EnclaveTarget};
<span class="kw">use </span>sgx_types::error::SgxStatus;
<span class="kw">use </span>sgx_types::error::SgxStatus::Success;
<span class="kw">use </span>sgx_types::types::<span class="kw-2">*</span>;
<span class="attribute">#[derive(thiserror::Error, Debug)]
</span><span class="kw">pub enum </span>PlatformError {
<span class="attribute">#[error(<span class="string">&quot;Failed to call {0}: {1}&quot;</span>)]
</span>OCallError(String, SgxStatus),
<span class="attribute">#[error(<span class="string">&quot;Failed to initialize quote : {0}&quot;</span>)]
</span>InitQuoteError(SgxStatus),
<span class="attribute">#[error(<span class="string">&quot;Failed to create the report of the enclave: {0}&quot;</span>)]
</span>CreateReportError(SgxStatus),
<span class="attribute">#[error(<span class="string">&quot;Failed to get target info of this enclave: {0}&quot;</span>)]
</span>GetSelfTargetInfoError(SgxStatus),
<span class="attribute">#[error(<span class="string">&quot;Failed to get quote: {0}&quot;</span>)]
</span>GetQuoteError(SgxStatus),
<span class="attribute">#[error(<span class="string">&quot;Failed to verify quote: {0}&quot;</span>)]
</span>VerifyReportError(SgxStatus),
<span class="attribute">#[error(
<span class="string">&quot;Replay attack on report: quote_nonce.rand {0:?},
qe_report.body.report_data.d[..32] {1:?}&quot;
</span>)]
</span>ReportReplay(Vec&lt;u8&gt;, Vec&lt;u8&gt;),
<span class="attribute">#[error(<span class="string">&quot;Failed to use SGX rng to generate random number: {0}&quot;</span>)]
</span>SgxRngError(std::io::Error),
<span class="attribute">#[error(<span class="string">&quot;Other SGX platform error: {0}&quot;</span>)]
</span>Others(SgxStatus),
}
<span class="kw">extern </span><span class="string">&quot;C&quot; </span>{
<span class="doccomment">/// Ocall to use sgx_init_quote_ex to init the quote and key_id.
</span><span class="kw">fn </span>ocall_sgx_init_quote(
p_retval: <span class="kw-2">*mut </span>SgxStatus,
p_sgx_att_key_id: <span class="kw-2">*mut </span>AttKeyId,
p_target_info: <span class="kw-2">*mut </span>TargetInfo,
) -&gt; SgxStatus;
<span class="doccomment">/// Ocall to get the required buffer size for the quote.
</span><span class="kw">fn </span>ocall_sgx_get_quote_size(
p_retval: <span class="kw-2">*mut </span>SgxStatus,
p_sgx_att_key_id: <span class="kw-2">*const </span>AttKeyId,
p_quote_size: <span class="kw-2">*mut </span>u32,
) -&gt; SgxStatus;
<span class="doccomment">/// Ocall to use sgx_get_quote_ex to generate a quote with enclave&#39;s report.
</span><span class="kw">fn </span>ocall_sgx_get_quote(
p_retval: <span class="kw-2">*mut </span>SgxStatus,
p_report: <span class="kw-2">*const </span>Report,
p_sgx_att_key_id: <span class="kw-2">*const </span>AttKeyId,
p_qe_report_info: <span class="kw-2">*mut </span>QeReportInfo,
p_quote: <span class="kw-2">*mut </span>u8,
quote_size: u32,
) -&gt; SgxStatus;
}
<span class="doccomment">/// Initialize SGX quote, return attestation key ID selected by the platform and
/// target information for creating report that only QE can verify.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>init_sgx_quote() -&gt; <span class="prelude-ty">Result</span>&lt;(AttKeyId, TargetInfo)&gt; {
<span class="macro">debug!</span>(<span class="string">&quot;init_quote&quot;</span>);
<span class="kw">let </span><span class="kw-2">mut </span>ti = TargetInfo::default();
<span class="kw">let </span><span class="kw-2">mut </span>ak_id = AttKeyId::default();
<span class="kw">let </span><span class="kw-2">mut </span>rt = SgxStatus::Unexpected;
<span class="kw">let </span>res = <span class="kw">unsafe </span>{ ocall_sgx_init_quote(<span class="kw-2">&amp;mut </span>rt <span class="kw">as _</span>, <span class="kw-2">&amp;mut </span>ak_id <span class="kw">as _</span>, <span class="kw-2">&amp;mut </span>ti <span class="kw">as _</span>) };
<span class="kw">if </span>res != Success {
<span class="kw">return </span><span class="prelude-val">Err</span>(PlatformError::OCallError(
<span class="string">&quot;ocall_sgx_init_quote&quot;</span>.to_string(),
res,
));
}
<span class="kw">if </span>rt != Success {
<span class="kw">return </span><span class="prelude-val">Err</span>(PlatformError::InitQuoteError(rt));
}
<span class="prelude-val">Ok</span>((ak_id, ti))
}
<span class="doccomment">/// Create report of the enclave with target_info.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>create_sgx_isv_enclave_report(
pub_k: EcPublicKey,
target_info: TargetInfo,
) -&gt; <span class="prelude-ty">Result</span>&lt;Report&gt; {
<span class="macro">debug!</span>(<span class="string">&quot;create_report&quot;</span>);
<span class="kw">let </span><span class="kw-2">mut </span>report_data = ReportData::default();
<span class="kw">let </span>public_key = pub_k.public_key();
<span class="kw">let </span><span class="kw-2">mut </span>pub_k_gx = public_key.gx;
pub_k_gx.reverse();
<span class="kw">let </span><span class="kw-2">mut </span>pub_k_gy = public_key.gy;
pub_k_gy.reverse();
report_data.d[..<span class="number">32</span>].clone_from_slice(<span class="kw-2">&amp;</span>pub_k_gx);
report_data.d[<span class="number">32</span>..].clone_from_slice(<span class="kw-2">&amp;</span>pub_k_gy);
<span class="kw">let </span>report =
Report::for_target(<span class="kw-2">&amp;</span>target_info, <span class="kw-2">&amp;</span>report_data).map_err(PlatformError::CreateReportError)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(report)
}
<span class="doccomment">/// Get quote with attestation key ID and enclave&#39;s local report.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>get_sgx_quote(ak_id: <span class="kw-2">&amp;</span>AttKeyId, report: Report) -&gt; <span class="prelude-ty">Result</span>&lt;Vec&lt;u8&gt;&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>rt = SgxStatus::Unexpected;
<span class="kw">let </span><span class="kw-2">mut </span>quote_len: u32 = <span class="number">0</span>;
<span class="kw">let </span>res = <span class="kw">unsafe </span>{ ocall_sgx_get_quote_size(<span class="kw-2">&amp;mut </span>rt <span class="kw">as _</span>, ak_id <span class="kw">as _</span>, <span class="kw-2">&amp;mut </span>quote_len <span class="kw">as _</span>) };
<span class="kw">if </span>res != Success {
<span class="kw">return </span><span class="prelude-val">Err</span>(PlatformError::OCallError(
<span class="string">&quot;ocall_sgx_get_quote_size&quot;</span>.to_string(),
res,
));
}
<span class="kw">if </span>rt != Success {
<span class="kw">return </span><span class="prelude-val">Err</span>(PlatformError::GetQuoteError(rt));
}
<span class="kw">let </span><span class="kw-2">mut </span>qe_report_info = QeReportInfo::default();
<span class="kw">let </span><span class="kw-2">mut </span>quote_nonce = QuoteNonce::default();
<span class="kw">let </span><span class="kw-2">mut </span>rng = RdRand::new().map_err(PlatformError::SgxRngError)<span class="question-mark">?</span>;
rng.fill_bytes(<span class="kw-2">&amp;mut </span>quote_nonce.rand);
qe_report_info.nonce = quote_nonce;
<span class="macro">debug!</span>(<span class="string">&quot;sgx self target&quot;</span>);
<span class="comment">// Provide the target information of ourselves so that we can verify the QE report
// returned with the quote
</span><span class="kw">let </span>tmp_target_info = TargetInfo::for_self().map_err(PlatformError::GetSelfTargetInfoError)<span class="question-mark">?</span>;
qe_report_info.app_enclave_target_info = tmp_target_info;
<span class="kw">let </span><span class="kw-2">mut </span>quote = <span class="macro">vec!</span>[<span class="number">0</span>; quote_len <span class="kw">as </span>usize];
<span class="macro">debug!</span>(<span class="string">&quot;ocall_sgx_get_quote&quot;</span>);
<span class="kw">let </span>res = <span class="kw">unsafe </span>{
ocall_sgx_get_quote(
<span class="kw-2">&amp;mut </span>rt <span class="kw">as _</span>,
<span class="kw-2">&amp;</span>report <span class="kw">as _</span>,
ak_id <span class="kw">as _</span>,
<span class="kw-2">&amp;mut </span>qe_report_info <span class="kw">as _</span>,
quote.as_mut_ptr(),
quote_len,
)
};
<span class="kw">if </span>res != Success {
<span class="kw">return </span><span class="prelude-val">Err</span>(PlatformError::OCallError(
<span class="string">&quot;ocall_sgx_get_quote&quot;</span>.to_string(),
res,
));
}
<span class="kw">if </span>rt != Success {
<span class="kw">return </span><span class="prelude-val">Err</span>(PlatformError::GetQuoteError(rt));
}
<span class="macro">debug!</span>(<span class="string">&quot;sgx verify report&quot;</span>);
<span class="kw">let </span>qe_report = qe_report_info.qe_report;
<span class="comment">// Perform a check on qe_report to verify if the qe_report is valid.
</span>qe_report
.verify()
.map_err(PlatformError::VerifyReportError)<span class="question-mark">?</span>;
<span class="comment">// Check qe_report to defend against replay attack. The purpose of
// p_qe_report is for the ISV enclave to confirm the QUOTE it received
// is not modified by the untrusted SW stack, and not a replay. The
// implementation in QE is to generate a REPORT targeting the ISV
// enclave (target info from p_report) , with the lower 32Bytes in
// report.data = SHA256(p_nonce||p_quote). The ISV enclave can verify
// the p_qe_report and report.data to confirm the QUOTE has not be
// modified and is not a replay. It is optional.
</span><span class="kw">let </span><span class="kw-2">mut </span>rhs_vec: Vec&lt;u8&gt; = quote_nonce.rand.to_vec();
rhs_vec.extend(<span class="kw-2">&amp;</span>quote);
<span class="macro">debug!</span>(<span class="string">&quot;sgx sha256 slice&quot;</span>);
<span class="kw">let </span>rhs_hash = Sha256::digest(rhs_vec.as_slice()).map_err(PlatformError::Others)<span class="question-mark">?</span>;
<span class="kw">let </span>lhs_hash = <span class="kw-2">&amp;</span>qe_report.body.report_data.d[..<span class="number">32</span>];
<span class="kw">if </span>rhs_hash.as_ref() != lhs_hash {
<span class="kw">return </span><span class="prelude-val">Err</span>(PlatformError::ReportReplay(
rhs_hash.to_vec(),
lhs_hash.to_vec(),
));
}
<span class="prelude-val">Ok</span>(quote)
}
<span class="attribute">#[cfg(all(feature = <span class="string">&quot;enclave_unit_test&quot;</span>, feature = <span class="string">&quot;mesalock_sgx&quot;</span>))]
</span><span class="kw">pub mod </span>tests {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="kw">use </span><span class="kw">crate</span>::key;
<span class="kw">pub fn </span>test_init_sgx_quote() {
<span class="macro">assert!</span>(init_sgx_quote().is_ok());
}
<span class="kw">pub fn </span>test_create_sgx_isv_enclave_report() {
<span class="kw">let </span>(_ak_id, qe_target_info) = init_sgx_quote().unwrap();
<span class="kw">let </span>key_pair = key::NistP256KeyPair::new().unwrap();
<span class="kw">let </span>sgx_report_result = create_sgx_isv_enclave_report(key_pair.pub_k(), qe_target_info);
<span class="macro">assert!</span>(sgx_report_result.is_ok());
}
<span class="kw">pub fn </span>test_get_sgx_quote() {
<span class="kw">let </span>(ak_id, qe_target_info) = init_sgx_quote().unwrap();
<span class="kw">let </span>key_pair = key::NistP256KeyPair::new().unwrap();
<span class="kw">let </span>sgx_report = create_sgx_isv_enclave_report(key_pair.pub_k(), qe_target_info).unwrap();
<span class="kw">let </span>quote_result = get_sgx_quote(<span class="kw-2">&amp;</span>ak_id, sgx_report);
<span class="macro">assert!</span>(quote_result.is_ok());
}
}
</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>