blob: 894c1694568a54bb349e7c8c13ce8deafb653b59 [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 `services/authentication/enclave/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_authentication_service_enclave/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_authentication_service_enclave/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>
</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="attribute">#[macro_use]
</span><span class="kw">extern crate </span>log;
<span class="kw">extern crate </span>sgx_types;
<span class="kw">use </span>anyhow::{anyhow, <span class="prelude-ty">Result</span>};
<span class="kw">use </span>rand::RngCore;
<span class="kw">use </span>std::sync::{Arc, RwLock};
<span class="kw">use </span>teaclave_attestation::{verifier, AttestationConfig, AttestedTlsConfig, RemoteAttestation};
<span class="kw">use </span>teaclave_binder::proto::{
ECallCommand, FinalizeEnclaveInput, FinalizeEnclaveOutput, InitEnclaveInput, InitEnclaveOutput,
StartServiceInput, StartServiceOutput,
};
<span class="kw">use </span>teaclave_binder::{handle_ecall, register_ecall_handler};
<span class="kw">use </span>teaclave_config::build::{
AS_ROOT_CA_CERT, AUDITOR_PUBLIC_KEYS, AUTHENTICATION_INBOUND_SERVICES,
};
<span class="kw">use </span>teaclave_config::RuntimeConfig;
<span class="kw">use </span>teaclave_proto::teaclave_authentication_service::{
TeaclaveAuthenticationApiServer, TeaclaveAuthenticationInternalServer,
};
<span class="kw">use </span>teaclave_rpc::{config::SgxTrustedTlsServerConfig, transport::Server};
<span class="kw">use </span>teaclave_service_enclave_utils::{base_dir_for_db, ServiceEnclave};
<span class="kw">use </span>teaclave_types::{EnclaveInfo, TeeServiceError, TeeServiceResult, UserRole};
<span class="kw">mod </span>api_service;
<span class="kw">mod </span>error;
<span class="kw">mod </span>internal_service;
<span class="kw">mod </span>user_db;
<span class="kw">mod </span>user_info;
<span class="kw">async fn </span>start_internal_endpoint(
addr: std::net::SocketAddr,
db_client: user_db::DbClient,
jwt_secret: Vec&lt;u8&gt;,
attested_tls_config: Arc&lt;RwLock&lt;AttestedTlsConfig&gt;&gt;,
accepted_enclave_attrs: Vec&lt;teaclave_types::EnclaveAttr&gt;,
) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<span class="kw">let </span>server_config = SgxTrustedTlsServerConfig::from_attested_tls_config(attested_tls_config)<span class="question-mark">?
</span>.attestation_report_verifier(
accepted_enclave_attrs,
AS_ROOT_CA_CERT,
verifier::universal_quote_verifier,
)<span class="question-mark">?
</span>.into();
<span class="kw">let </span>service =
internal_service::TeaclaveAuthenticationInternalService::new(db_client, jwt_secret);
Server::builder()
.tls_config(server_config)
.map_err(|<span class="kw">_</span>| <span class="macro">anyhow!</span>(<span class="string">&quot;TeaclaveFrontendServer tls config error&quot;</span>))<span class="question-mark">?
</span>.add_service(TeaclaveAuthenticationInternalServer::new(service))
.serve(addr)
.<span class="kw">await</span><span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(())
}
<span class="kw">async fn </span>start_api_endpoint(
addr: std::net::SocketAddr,
db_client: user_db::DbClient,
jwt_secret: Vec&lt;u8&gt;,
attested_tls_config: Arc&lt;RwLock&lt;AttestedTlsConfig&gt;&gt;,
) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<span class="kw">let </span>tls_config =
SgxTrustedTlsServerConfig::from_attested_tls_config(attested_tls_config)<span class="question-mark">?</span>.into();
<span class="kw">let </span>service = api_service::TeaclaveAuthenticationApiService::new(db_client, jwt_secret);
Server::builder()
.tls_config(tls_config)
.map_err(|<span class="kw">_</span>| <span class="macro">anyhow!</span>(<span class="string">&quot;TeaclaveAuthenticationApiServer tls config error&quot;</span>))<span class="question-mark">?
</span>.add_service(TeaclaveAuthenticationApiServer::new(service))
.serve(addr)
.<span class="kw">await</span><span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(())
}
<span class="kw">async fn </span>start_service(config: <span class="kw-2">&amp;</span>RuntimeConfig) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<span class="macro">info!</span>(<span class="string">&quot;Starting Authentication...&quot;</span>);
<span class="kw">let </span>enclave_info = EnclaveInfo::verify_and_new(
<span class="kw-2">&amp;</span>config.audit.enclave_info_bytes,
AUDITOR_PUBLIC_KEYS,
<span class="kw-2">&amp;</span>config.audit.auditor_signatures_bytes,
)<span class="question-mark">?</span>;
<span class="kw">let </span>accepted_enclave_attrs: Vec&lt;teaclave_types::EnclaveAttr&gt; = AUTHENTICATION_INBOUND_SERVICES
.iter()
.map(|service| <span class="kw">match </span>enclave_info.get_enclave_attr(service) {
<span class="prelude-val">Some</span>(attr) =&gt; <span class="prelude-val">Ok</span>(attr),
<span class="prelude-val">None </span>=&gt; <span class="prelude-val">Err</span>(<span class="macro">anyhow!</span>(<span class="string">&quot;cannot get enclave attribute of {}&quot;</span>, service)),
})
.collect::&lt;<span class="prelude-ty">Result</span>&lt;<span class="kw">_</span>&gt;&gt;()<span class="question-mark">?</span>;
<span class="kw">let </span>api_listen_address = config.api_endpoints.authentication.listen_address;
<span class="kw">let </span>internal_listen_address = config.internal_endpoints.authentication.listen_address;
<span class="kw">let </span>attestation_config = AttestationConfig::from_teaclave_config(config)<span class="question-mark">?</span>;
<span class="kw">let </span>attested_tls_config = RemoteAttestation::new(attestation_config)
.generate_and_endorse()<span class="question-mark">?
</span>.attested_tls_config()
.ok_or_else(|| <span class="macro">anyhow!</span>(<span class="string">&quot;cannot get attested TLS config&quot;</span>))<span class="question-mark">?</span>;
<span class="macro">info!</span>(<span class="string">&quot; Starting Authentication: Self attestation finished ...&quot;</span>);
<span class="kw">let </span>db_base = base_dir_for_db(config)<span class="question-mark">?</span>;
<span class="kw">let </span>database = user_db::Database::open(<span class="kw-2">&amp;</span>db_base)<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>api_jwt_secret = <span class="macro">vec!</span>[<span class="number">0</span>; user_info::JWT_SECRET_LEN];
<span class="kw">let </span><span class="kw-2">mut </span>rng = rand::thread_rng();
rng.fill_bytes(<span class="kw-2">&amp;mut </span>api_jwt_secret);
<span class="kw">let </span>internal_jwt_secret = api_jwt_secret.to_owned();
<span class="kw">let </span>attested_tls_config_ref = attested_tls_config.clone();
{
<span class="kw">let </span>client = database.get_client();
<span class="kw">if </span>create_platform_admin_user(client, <span class="string">&quot;admin&quot;</span>, <span class="string">&quot;teaclave&quot;</span>).is_ok() {
<span class="macro">info!</span>(<span class="string">&quot; Starting Authentication: Platform first launch, admin user created ...&quot;</span>);
}
}
<span class="kw">let </span>client = database.get_client();
<span class="kw">let </span>api_endpoint_thread_handler = tokio::spawn(start_api_endpoint(
api_listen_address,
client,
api_jwt_secret,
attested_tls_config_ref,
));
<span class="macro">info!</span>(<span class="string">&quot; Starting Authentication: setup API endpoint finished ...&quot;</span>);
<span class="kw">let </span>client = database.get_client();
<span class="kw">let </span>internal_endpoint_thread_handler = tokio::spawn(start_internal_endpoint(
internal_listen_address,
client,
internal_jwt_secret,
attested_tls_config,
accepted_enclave_attrs,
));
<span class="macro">info!</span>(<span class="string">&quot; Starting Authentication: setup Internal endpoint finished ...&quot;</span>);
<span class="kw">let _ </span>= api_endpoint_thread_handler
.<span class="kw">await
</span>.expect(<span class="string">&quot;cannot join API endpoint thread&quot;</span>);
<span class="kw">let _ </span>= internal_endpoint_thread_handler
.<span class="kw">await
</span>.expect(<span class="string">&quot;cannot join internal endpoint thread&quot;</span>);
<span class="macro">info!</span>(<span class="string">&quot; Starting Authentication: start listening ...&quot;</span>);
<span class="prelude-val">Ok</span>(())
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>create_platform_admin_user(
db_client: user_db::DbClient,
id: <span class="kw-2">&amp;</span>str,
password: <span class="kw-2">&amp;</span>str,
) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<span class="kw">let </span>new_user = user_info::UserInfo::new(id, password, UserRole::PlatformAdmin);
db_client.create_user(<span class="kw-2">&amp;</span>new_user)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[handle_ecall]
</span><span class="kw">fn </span>handle_start_service(input: <span class="kw-2">&amp;</span>StartServiceInput) -&gt; TeeServiceResult&lt;StartServiceOutput&gt; {
<span class="kw">let </span>result = tokio::runtime::Builder::new_current_thread()
.enable_all()
.build()
.map_err(|<span class="kw">_</span>| TeeServiceError::SgxError)<span class="question-mark">?
</span>.block_on(start_service(<span class="kw-2">&amp;</span>input.config));
<span class="kw">match </span>result {
<span class="prelude-val">Ok</span>(<span class="kw">_</span>) =&gt; <span class="prelude-val">Ok</span>(StartServiceOutput),
<span class="prelude-val">Err</span>(e) =&gt; {
<span class="macro">error!</span>(<span class="string">&quot;Failed to run service: {}&quot;</span>, e);
<span class="prelude-val">Err</span>(TeeServiceError::ServiceError)
}
}
}
<span class="attribute">#[handle_ecall]
</span><span class="kw">fn </span>handle_init_enclave(<span class="kw">_</span>: <span class="kw-2">&amp;</span>InitEnclaveInput) -&gt; TeeServiceResult&lt;InitEnclaveOutput&gt; {
ServiceEnclave::init(<span class="macro">env!</span>(<span class="string">&quot;CARGO_PKG_NAME&quot;</span>))<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(InitEnclaveOutput)
}
<span class="attribute">#[handle_ecall]
</span><span class="kw">fn </span>handle_finalize_enclave(<span class="kw">_</span>: <span class="kw-2">&amp;</span>FinalizeEnclaveInput) -&gt; TeeServiceResult&lt;FinalizeEnclaveOutput&gt; {
ServiceEnclave::finalize()<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(FinalizeEnclaveOutput)
}
<span class="macro">register_ecall_handler!</span>(
<span class="kw">type </span>ECallCommand,
(ECallCommand::StartService, StartServiceInput, StartServiceOutput),
(ECallCommand::InitEnclave, InitEnclaveInput, InitEnclaveOutput),
(ECallCommand::FinalizeEnclave, FinalizeEnclaveInput, FinalizeEnclaveOutput),
);
<span class="attribute">#[cfg(feature = <span class="string">&quot;enclave_unit_test&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>teaclave_test_utils::<span class="kw-2">*</span>;
<span class="kw">pub fn </span>run_tests() -&gt; bool {
<span class="macro">run_async_tests!</span>(
api_service::tests::test_user_login,
api_service::tests::test_user_register,
api_service::tests::test_user_update,
api_service::tests::test_user_change_password,
api_service::tests::test_reset_user_password,
api_service::tests::test_delete_user,
internal_service::tests::test_user_authenticate,
internal_service::tests::test_invalid_algorithm,
internal_service::tests::test_invalid_issuer,
internal_service::tests::test_expired_token,
internal_service::tests::test_invalid_user,
internal_service::tests::test_wrong_secret,
)
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="teaclave_authentication_service_enclave" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>