| <!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/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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> |
| </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 |
| // "License"); 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 |
| // "AS IS" 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 crate provides TLS-based remote attestation mechanism for Teaclave, |
| //! supporting both EPID and ECDSA attestation. By default, Intel Attestation |
| //! Service is used for RA. |
| |
| </span><span class="attribute">#![allow(clippy::nonstandard_macro_braces)] |
| |
| </span><span class="kw">extern crate </span>sgx_types; |
| |
| <span class="kw">use </span>std::sync::Arc; |
| |
| <span class="kw">use </span>anyhow::{Context, <span class="prelude-ty">Result</span>}; |
| <span class="kw">use </span>serde::{Deserialize, Serialize}; |
| <span class="kw">use </span>sgx_types::error::SgxStatus; |
| <span class="kw">use </span>sgx_types::types::Spid; |
| |
| <span class="doccomment">/// Errors that can happen during attestation and verification process |
| </span><span class="attribute">#[derive(thiserror::Error, Debug)] |
| </span><span class="kw">pub enum </span>AttestationError { |
| <span class="attribute">#[error(<span class="string">"OCall error"</span>)] |
| </span>OCallError(SgxStatus), |
| <span class="attribute">#[error(<span class="string">"Attestation Service error"</span>)] |
| </span>AttestationServiceError, |
| <span class="attribute">#[error(<span class="string">"Platform error"</span>)] |
| </span>PlatformError(SgxStatus), |
| <span class="attribute">#[error(<span class="string">"Report error"</span>)] |
| </span>ReportError, |
| <span class="attribute">#[error(<span class="string">"Report error"</span>)] |
| </span>ConnectionError, |
| <span class="attribute">#[error(<span class="string">"Attestation Service API version not compatible"</span>)] |
| </span>ApiVersionNotCompatible, |
| } |
| |
| <span class="doccomment">/// Remote attestation configuration |
| </span><span class="attribute">#[derive(Clone)] |
| </span><span class="kw">pub enum </span>AttestationConfig { |
| <span class="doccomment">/// Trust enclave without attestation |
| </span>NoAttestation, |
| <span class="doccomment">/// Perform attestation before trusting enclave |
| </span>WithAttestation(AttestationServiceConfig), |
| } |
| |
| <span class="doccomment">/// Remote attestation algorithm |
| </span><span class="attribute">#[derive(Clone)] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>AttestationAlgorithm { |
| <span class="doccomment">/// Use Intel EPID |
| </span>SgxEpid, |
| <span class="doccomment">/// Use ECDSA |
| </span>SgxEcdsa, |
| } |
| |
| <span class="kw">impl </span>AttestationAlgorithm { |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>from_str(s: <span class="kw-2">&</span>str) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>> { |
| <span class="kw">match </span>s { |
| <span class="string">"sgx_epid" </span>=> <span class="prelude-val">Some</span>(AttestationAlgorithm::SgxEpid), |
| <span class="string">"sgx_ecdsa" </span>=> <span class="prelude-val">Some</span>(AttestationAlgorithm::SgxEcdsa), |
| <span class="kw">_ </span>=> <span class="prelude-val">None</span>, |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Attestation Service Configuration |
| </span><span class="attribute">#[derive(Clone)] |
| #[allow(dead_code)] |
| </span><span class="kw">pub struct </span>AttestationServiceConfig { |
| <span class="doccomment">/// Algorithm to use |
| </span>algo: AttestationAlgorithm, |
| <span class="doccomment">/// URL of attestation service |
| </span>as_url: url::Url, |
| <span class="doccomment">/// IAS API Key |
| </span>api_key: String, |
| <span class="doccomment">/// SPID |
| </span>spid: Spid, |
| } |
| |
| <span class="kw">pub struct </span>DcapConfig {} |
| |
| <span class="kw">impl </span>AttestationConfig { |
| <span class="doccomment">/// Creates `AttestationConfig` for no attestation |
| </span><span class="kw">pub fn </span>no_attestation() -> Arc<<span class="self">Self</span>> { |
| Arc::new(<span class="self">Self</span>::NoAttestation) |
| } |
| |
| <span class="doccomment">/// Creates `AttestationConfig` for attestation using given values |
| </span><span class="kw">pub fn </span>new(algorithm: <span class="kw-2">&</span>str, url: <span class="kw-2">&</span>str, api_key: <span class="kw-2">&</span>str, spid_str: <span class="kw-2">&</span>str) -> <span class="prelude-ty">Result</span><Arc<<span class="self">Self</span>>> { |
| <span class="kw">if </span><span class="macro">cfg!</span>(sgx_sim) { |
| <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="self">Self</span>::no_attestation()); |
| } |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>spid = Spid::default(); |
| <span class="kw">let </span>hex = hex::decode(spid_str).context(<span class="string">"Illegal SPID provided"</span>)<span class="question-mark">?</span>; |
| spid.id = <[u8; <span class="number">16</span>]>::try_from(hex.as_slice()).context(<span class="string">"Illegal SPID provided"</span>)<span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>algo = AttestationAlgorithm::from_str(algorithm) |
| .context(<span class="string">"Unsupported remote attestation algorithm"</span>)<span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>att_service_cfg = AttestationServiceConfig { |
| algo, |
| as_url: url::Url::parse(url).context(<span class="string">"Invalid URL"</span>)<span class="question-mark">?</span>, |
| api_key: api_key.to_string(), |
| spid, |
| }; |
| |
| <span class="prelude-val">Ok</span>(Arc::new(<span class="self">Self</span>::WithAttestation(att_service_cfg))) |
| } |
| |
| <span class="doccomment">/// Crate attestation config from Teaclave runtime configuration. |
| </span><span class="kw">pub fn </span>from_teaclave_config(config: <span class="kw-2">&</span>teaclave_config::RuntimeConfig) -> <span class="prelude-ty">Result</span><Arc<<span class="self">Self</span>>> { |
| <span class="kw">let </span>as_config = <span class="kw-2">&</span>config.attestation; |
| <span class="self">Self</span>::new( |
| <span class="kw-2">&</span>as_config.algorithm, |
| <span class="kw-2">&</span>as_config.url, |
| <span class="kw-2">&</span>as_config.key, |
| <span class="kw-2">&</span>as_config.spid, |
| ) |
| } |
| } |
| |
| <span class="doccomment">/// AttestationReport can be endorsed by either the Intel Attestation Service |
| /// using EPID or Data Center Attestation |
| /// Service (platform dependent) using ECDSA. |
| </span><span class="attribute">#[derive(Debug, Default, Serialize, Deserialize)] |
| </span><span class="kw">pub struct </span>EndorsedAttestationReport { |
| <span class="doccomment">/// Attestation report generated by the hardware |
| </span><span class="kw">pub </span>report: Vec<u8>, |
| <span class="doccomment">/// Singature of the report |
| </span><span class="kw">pub </span>signature: Vec<u8>, |
| <span class="doccomment">/// Certificate matching the signing key of the signature |
| </span><span class="kw">pub </span>certs: Vec<Vec<u8>>, |
| } |
| |
| <span class="doccomment">/// Configuration for TLS communication in Remote Attestation |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>AttestedTlsConfig { |
| <span class="kw">pub </span>cert: Vec<u8>, |
| <span class="kw">pub </span>private_key: Vec<u8>, |
| <span class="kw">pub </span>time: std::time::SystemTime, |
| <span class="kw">pub </span>validity: std::time::Duration, |
| } |
| |
| <span class="attribute">#[macro_use] |
| </span><span class="kw">mod </span>cert; |
| <span class="kw">pub mod </span>report; |
| <span class="kw">pub mod </span>verifier; |
| |
| <span class="macro">cfg_if::cfg_if! </span>{ |
| <span class="kw">if </span><span class="attribute">#[cfg(any(feature = <span class="string">"mesalock_sgx"</span>, feature = <span class="string">"libos"</span>))] </span>{ |
| <span class="kw">mod </span>service; |
| <span class="kw">pub mod </span>key; |
| <span class="kw">mod </span>platform; |
| <span class="kw">mod </span>attestation; |
| <span class="kw">pub use </span>attestation::RemoteAttestation; |
| } |
| } |
| |
| <span class="attribute">#[cfg(all(feature = <span class="string">"enclave_unit_test"</span>, feature = <span class="string">"mesalock_sgx"</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>teaclave_test_utils::<span class="kw-2">*</span>; |
| |
| <span class="kw">pub fn </span>run_tests() -> bool { |
| <span class="macro">run_tests!</span>( |
| platform::tests::test_init_sgx_quote, |
| platform::tests::test_create_sgx_isv_enclave_report, |
| platform::tests::test_get_sgx_quote, |
| report::tests::test_sgx_quote_parse_from, |
| report::tests::test_attestation_report_from_cert, |
| report::tests::test_attestation_report_from_cert_api_version_not_compatible |
| ) |
| } |
| } |
| </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> |
