| <!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 `binder/src/ipc/app.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>app.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_binder/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_binder/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> |
| </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="kw">use </span>serde::{Deserialize, Serialize}; |
| |
| <span class="kw">use </span>sgx_types::error::SgxStatus; |
| <span class="kw">use </span>sgx_types::types::EnclaveId; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::ipc::IpcError; |
| <span class="kw">use </span><span class="kw">crate</span>::ipc::IpcSender; |
| <span class="kw">use </span>log::{debug, error}; |
| <span class="kw">use </span>teaclave_types::ECallStatus; |
| |
| <span class="comment">// Delaration of ecall for App, the implementation is in TEE |
| // This function is automatically generated by the procedure macro #[ecall_entry_point]. |
| // fn enclave_init(eid: EnclaveId, retval: *mut ECallStatus) -> SgxStatus; |
| |
| </span><span class="kw">extern </span><span class="string">"C" </span>{ |
| <span class="kw">fn </span>ecall_ipc_entry_point( |
| eid: EnclaveId, |
| retval: <span class="kw-2">*mut </span>ECallStatus, |
| cmd: u32, |
| in_buf: <span class="kw-2">*const </span>u8, |
| in_len: usize, |
| out_buf: <span class="kw-2">*mut </span>u8, |
| out_max: usize, |
| out_len: <span class="kw-2">&mut </span>usize, |
| ) -> SgxStatus; |
| } |
| |
| <span class="comment">// Implementation of IPC Sender For App |
| // ECallChannel, receiver is implemented in TEE |
| </span><span class="kw">pub struct </span>ECallChannel { |
| enclave_id: EnclaveId, |
| curr_out_buf_size: usize, |
| } |
| |
| <span class="kw">impl </span>ECallChannel { |
| <span class="kw">pub fn </span>new(enclave_id: EnclaveId) -> ECallChannel { |
| ECallChannel { |
| enclave_id, |
| curr_out_buf_size: <span class="number">256</span>, |
| } |
| } |
| |
| <span class="kw">fn </span>ecall_ipc_app_to_tee( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| cmd: u32, |
| request_payload: Vec<u8>, |
| ) -> std::result::Result<Vec<u8>, IpcError> { |
| <span class="macro">debug! </span>{<span class="string">"ecall_ipc_app_to_tee: {:x}, {:x} bytes"</span>, cmd, request_payload.len()}; |
| |
| <span class="kw">let </span>in_ptr: <span class="kw-2">*const </span>u8 = request_payload.as_ptr(); |
| <span class="kw">let </span>in_len: usize = request_payload.len(); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>retried = <span class="bool-val">false</span>; |
| <span class="kw">let </span>out_buf = <span class="kw">loop </span>{ |
| <span class="kw">let </span>out_max: usize = <span class="self">self</span>.curr_out_buf_size; |
| <span class="kw">let </span><span class="kw-2">mut </span>out_buf: Vec<u8> = Vec::with_capacity(out_max); |
| <span class="kw">let </span><span class="kw-2">mut </span>out_len: usize = out_max; |
| <span class="kw">let </span>out_ptr: <span class="kw-2">*mut </span>u8 = out_buf.as_mut_ptr(); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>ecall_ret = ECallStatus::default(); |
| |
| <span class="kw">let </span>sgx_status = <span class="kw">unsafe </span>{ |
| ecall_ipc_entry_point( |
| <span class="self">self</span>.enclave_id, |
| <span class="kw-2">&mut </span>ecall_ret, |
| cmd, |
| in_ptr, |
| in_len, |
| out_ptr, |
| out_max, |
| <span class="kw-2">&mut </span>out_len, |
| ) |
| }; |
| |
| <span class="comment">// Check sgx return values |
| </span><span class="kw">if </span>sgx_status != SgxStatus::Success { |
| <span class="macro">error!</span>(<span class="string">"ecall_ipc_entry_point, app sgx_error:{}"</span>, sgx_status); |
| <span class="kw">return </span><span class="prelude-val">Err</span>(IpcError::SgxError(sgx_status)); |
| } |
| |
| <span class="comment">// Check rust logic return values |
| // If out_buf is not big enough, realloc based on the returned out_len |
| // We only retry once for once invocation. |
| </span><span class="kw">if </span>ecall_ret.is_err_ffi_outbuf() && !retried { |
| <span class="macro">debug!</span>( |
| <span class="string">"ecall_ipc_entry_point, expand app request buffer size: {:?}"</span>, |
| ecall_ret |
| ); |
| |
| <span class="macro">assert!</span>(out_len > out_max); |
| <span class="self">self</span>.curr_out_buf_size = out_len; |
| retried = <span class="bool-val">true</span>; |
| <span class="kw">continue</span>; |
| } |
| |
| <span class="comment">// Check rust logic return values |
| // Transparent deliever the errors to outer logic. |
| </span><span class="kw">if </span>ecall_ret.is_err() { |
| <span class="macro">error!</span>(<span class="string">"ecall_ipc_entry_point, app api_error: {:?}"</span>, ecall_ret); |
| <span class="kw">return </span><span class="prelude-val">Err</span>(IpcError::ECallError(ecall_ret)); |
| } |
| |
| <span class="kw">unsafe </span>{ |
| out_buf.set_len(out_len); |
| } |
| <span class="macro">debug!</span>(<span class="string">"ecall_ipc_entry_point OK. App Received Buf: {:?}"</span>, out_buf); |
| |
| <span class="kw">break </span>out_buf; |
| }; |
| |
| <span class="prelude-val">Ok</span>(out_buf) |
| } |
| } |
| |
| <span class="kw">impl </span>IpcSender <span class="kw">for </span>ECallChannel { |
| <span class="kw">fn </span>invoke<U, V>(<span class="kw-2">&mut </span><span class="self">self</span>, cmd: u32, input: U) -> std::result::Result<V, IpcError> |
| <span class="kw">where |
| </span>U: Serialize, |
| V: <span class="kw">for</span><<span class="lifetime">'de</span>> Deserialize<<span class="lifetime">'de</span>>, |
| { |
| <span class="kw">let </span>request_payload = serde_json::to_vec(<span class="kw-2">&</span>input)<span class="question-mark">?</span>; |
| <span class="kw">let </span>result_buf = <span class="self">self</span>.ecall_ipc_app_to_tee(cmd, request_payload)<span class="question-mark">?</span>; |
| <span class="kw">let </span>response: V = serde_json::from_slice(<span class="kw-2">&</span>result_buf)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(response) |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"app_unit_test"</span>)] |
| </span><span class="kw">pub mod </span>tests { |
| <span class="kw">use super</span>::<span class="kw-2">*</span>; |
| |
| <span class="kw">pub fn </span>run_tests(eid: EnclaveId) -> bool { |
| <span class="kw">let </span><span class="kw-2">mut </span>ecall_ret = ECallStatus::default(); |
| <span class="kw">let </span><span class="kw-2">mut </span>out_buf = <span class="macro">vec!</span>[<span class="number">0</span>; <span class="number">128</span>]; |
| <span class="kw">let </span><span class="kw-2">mut </span>out_len = <span class="number">0usize</span>; |
| <span class="kw">let </span>sgx_status = <span class="kw">unsafe </span>{ |
| ecall_ipc_entry_point( |
| eid, |
| <span class="kw-2">&mut </span>ecall_ret, |
| <span class="number">0x0000_1003</span>, <span class="comment">//cmd, |
| </span>std::ptr::null(), <span class="comment">//in_ptr, |
| </span><span class="number">128</span>, <span class="comment">//in_len, |
| </span>out_buf.as_mut_ptr(), |
| <span class="number">128</span>, |
| <span class="kw-2">&mut </span>out_len, |
| ) |
| }; |
| <span class="macro">assert_eq!</span>(sgx_status, SgxStatus::Success); |
| <span class="macro">assert!</span>(ecall_ret.is_err()); |
| |
| <span class="bool-val">true |
| </span>} |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="teaclave_binder" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
