blob: 4e89b92fd0347c38e1173fe935ee55ccc8279bc6 [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 `src/bindings.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>bindings.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_client_sdk/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_client_sdk/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>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
<span id="449">449</span>
<span id="450">450</span>
<span id="451">451</span>
<span id="452">452</span>
<span id="453">453</span>
<span id="454">454</span>
<span id="455">455</span>
<span id="456">456</span>
<span id="457">457</span>
<span id="458">458</span>
<span id="459">459</span>
<span id="460">460</span>
<span id="461">461</span>
<span id="462">462</span>
<span id="463">463</span>
<span id="464">464</span>
<span id="465">465</span>
<span id="466">466</span>
<span id="467">467</span>
<span id="468">468</span>
<span id="469">469</span>
<span id="470">470</span>
<span id="471">471</span>
<span id="472">472</span>
<span id="473">473</span>
<span id="474">474</span>
<span id="475">475</span>
<span id="476">476</span>
<span id="477">477</span>
<span id="478">478</span>
<span id="479">479</span>
<span id="480">480</span>
<span id="481">481</span>
<span id="482">482</span>
<span id="483">483</span>
<span id="484">484</span>
<span id="485">485</span>
<span id="486">486</span>
<span id="487">487</span>
<span id="488">488</span>
<span id="489">489</span>
<span id="490">490</span>
<span id="491">491</span>
<span id="492">492</span>
<span id="493">493</span>
<span id="494">494</span>
<span id="495">495</span>
<span id="496">496</span>
<span id="497">497</span>
<span id="498">498</span>
<span id="499">499</span>
<span id="500">500</span>
<span id="501">501</span>
<span id="502">502</span>
<span id="503">503</span>
<span id="504">504</span>
<span id="505">505</span>
<span id="506">506</span>
<span id="507">507</span>
<span id="508">508</span>
<span id="509">509</span>
<span id="510">510</span>
<span id="511">511</span>
<span id="512">512</span>
<span id="513">513</span>
<span id="514">514</span>
<span id="515">515</span>
<span id="516">516</span>
<span id="517">517</span>
<span id="518">518</span>
<span id="519">519</span>
<span id="520">520</span>
<span id="521">521</span>
<span id="522">522</span>
<span id="523">523</span>
<span id="524">524</span>
<span id="525">525</span>
<span id="526">526</span>
<span id="527">527</span>
<span id="528">528</span>
<span id="529">529</span>
<span id="530">530</span>
<span id="531">531</span>
<span id="532">532</span>
<span id="533">533</span>
<span id="534">534</span>
<span id="535">535</span>
<span id="536">536</span>
<span id="537">537</span>
<span id="538">538</span>
<span id="539">539</span>
<span id="540">540</span>
<span id="541">541</span>
<span id="542">542</span>
<span id="543">543</span>
<span id="544">544</span>
<span id="545">545</span>
<span id="546">546</span>
<span id="547">547</span>
<span id="548">548</span>
<span id="549">549</span>
<span id="550">550</span>
<span id="551">551</span>
<span id="552">552</span>
<span id="553">553</span>
<span id="554">554</span>
<span id="555">555</span>
<span id="556">556</span>
<span id="557">557</span>
<span id="558">558</span>
<span id="559">559</span>
<span id="560">560</span>
<span id="561">561</span>
<span id="562">562</span>
<span id="563">563</span>
<span id="564">564</span>
<span id="565">565</span>
<span id="566">566</span>
<span id="567">567</span>
<span id="568">568</span>
<span id="569">569</span>
<span id="570">570</span>
<span id="571">571</span>
<span id="572">572</span>
<span id="573">573</span>
<span id="574">574</span>
<span id="575">575</span>
<span id="576">576</span>
<span id="577">577</span>
<span id="578">578</span>
<span id="579">579</span>
<span id="580">580</span>
<span id="581">581</span>
<span id="582">582</span>
<span id="583">583</span>
<span id="584">584</span>
<span id="585">585</span>
<span id="586">586</span>
<span id="587">587</span>
<span id="588">588</span>
<span id="589">589</span>
<span id="590">590</span>
<span id="591">591</span>
<span id="592">592</span>
<span id="593">593</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="kw">use </span>libc::{c_char, c_int, c_void, malloc, size_t};
<span class="kw">use </span>std::ffi::{CStr, CString};
<span class="kw">use </span>std::{fs, ptr};
<span class="kw">use crate</span>::{
AuthenticationClient, AuthenticationService, EnclaveInfo, Entry, FrontendClient,
FrontendService,
};
<span class="macro">macro_rules! </span>unwrap_or_return_null {
( <span class="macro-nonterminal">$e</span>:expr ) =&gt; {
<span class="kw">match </span><span class="macro-nonterminal">$e </span>{
<span class="prelude-val">Ok</span>(x) =&gt; x,
<span class="prelude-val">Err</span>(<span class="kw">_</span>) =&gt; <span class="kw">return </span>ptr::null_mut(),
}
};
}
<span class="macro">macro_rules! </span>unwrap_or_return_one {
( <span class="macro-nonterminal">$e</span>:expr ) =&gt; {
<span class="kw">match </span><span class="macro-nonterminal">$e </span>{
<span class="prelude-val">Ok</span>(x) =&gt; x,
<span class="prelude-val">Err</span>(<span class="kw">_</span>) =&gt; <span class="kw">return </span><span class="number">1</span>,
}
};
}
<span class="doccomment">/// Connect to Teaclave Authentication Service.
///
/// This function connects and establishes trusted channel to the remote
/// authentication service with `address`. The function gets *enclave info* from
/// the file located in `enclave_info_path`. The file in `as_root_ca_cert_path`
/// will be used to verify the attestation report from the remote service.
///
/// # Arguments
///
/// * `address`: address of remote services, normally,it&#39;s a domain name with port number.
/// * `enclave_info_path`: file path of the *enclave info* TOML file.
/// * `as_root_ca_cert_path`: file path of the certificate for remote attestation service.
///
/// # Return
///
/// * The function returns an opaque pointer (handle) of the service. On error,
/// the function returns NULL.
///
/// # Safety
///
/// `address`, `enclave_info_path`, `as_root_ca_cert_path` should be C string (null terminated).
</span><span class="attribute">#[no_mangle]
</span><span class="kw">pub unsafe extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn </span>teaclave_connect_authentication_service(
address: <span class="kw-2">*const </span>c_char,
enclave_info_path: <span class="kw-2">*const </span>c_char,
as_root_ca_cert_path: <span class="kw-2">*const </span>c_char,
) -&gt; <span class="kw-2">*mut </span>AuthenticationClient {
<span class="kw">if </span>address.is_null() || enclave_info_path.is_null() || as_root_ca_cert_path.is_null() {
<span class="kw">return </span>ptr::null_mut();
}
<span class="kw">let </span>address = CStr::from_ptr(address).to_string_lossy().into_owned();
<span class="kw">let </span>enclave_info_path = CStr::from_ptr(enclave_info_path)
.to_string_lossy()
.into_owned();
<span class="kw">let </span>as_root_ca_cert_path = CStr::from_ptr(as_root_ca_cert_path)
.to_string_lossy()
.into_owned();
<span class="kw">let </span>enclave_info = <span class="macro">unwrap_or_return_null!</span>(EnclaveInfo::from_file(enclave_info_path));
<span class="kw">let </span>bytes = <span class="macro">unwrap_or_return_null!</span>(fs::read(as_root_ca_cert_path));
<span class="kw">let </span>as_root_ca_cert = <span class="macro">unwrap_or_return_null!</span>(pem::parse(bytes)).contents;
<span class="kw">let </span>client = <span class="macro">unwrap_or_return_null!</span>(AuthenticationService::connect(
<span class="kw-2">&amp;</span>address,
<span class="kw-2">&amp;</span>enclave_info,
<span class="kw-2">&amp;</span>as_root_ca_cert
));
Box::into_raw(Box::new(client))
}
<span class="doccomment">/// Close and free the authentication service handle, i.e., the
/// `AuthenticaionClient` type opaque pointer. The function returns 0 for
/// success. On error, the function returns 1.
///
/// # Safety
///
/// This function is unsafe because improper use may lead to
/// memory problems. For example, a double-free may occur if the
/// function is called twice on the same raw pointer.
</span><span class="attribute">#[no_mangle]
</span><span class="kw">pub unsafe extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn </span>teaclave_close_authentication_service(
client: <span class="kw-2">*mut </span>AuthenticationClient,
) -&gt; c_int {
<span class="kw">if </span>client.is_null() {
<span class="kw">return </span><span class="number">1</span>;
}
<span class="kw">let _ </span>= Box::from_raw(client);
<span class="number">0
</span>}
<span class="doccomment">/// Register a new user with `user_id` and `user_password`. The function returns
/// 0 for success. On error, the function returns 1.
///
/// # Safety
///
/// `user_id`, `user_password`, `role`, `attribute` should be C string (null terminated).
</span><span class="attribute">#[no_mangle]
</span><span class="kw">pub unsafe extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn </span>teaclave_user_register(
client: <span class="kw-2">&amp;mut </span>AuthenticationClient,
user_id: <span class="kw-2">*const </span>c_char,
user_password: <span class="kw-2">*const </span>c_char,
role: <span class="kw-2">*const </span>c_char,
attribute: <span class="kw-2">*const </span>c_char,
) -&gt; c_int {
<span class="kw">if </span>(client <span class="kw">as </span><span class="kw-2">*mut </span>AuthenticationClient).is_null()
|| user_id.is_null()
|| user_password.is_null()
{
<span class="kw">return </span><span class="number">1</span>;
}
<span class="kw">let </span>user_id = CStr::from_ptr(user_id).to_string_lossy().into_owned();
<span class="kw">let </span>user_password = CStr::from_ptr(user_password).to_string_lossy().into_owned();
<span class="kw">let </span>role = CStr::from_ptr(role).to_string_lossy().into_owned();
<span class="kw">let </span>attribute = CStr::from_ptr(attribute).to_string_lossy().into_owned();
<span class="macro">unwrap_or_return_one!</span>(client.user_register(<span class="kw-2">&amp;</span>user_id, <span class="kw-2">&amp;</span>user_password, <span class="kw-2">&amp;</span>role, <span class="kw-2">&amp;</span>attribute));
<span class="number">0
</span>}
<span class="doccomment">/// Login a new user with `user_id` and `user_password`. The login session token
/// will be save in the `token` buffer, and length will be set in the
/// `token_len` argument. The function returns 0 for success. On error, the
/// function returns 1.
///
/// # Safety
///
/// `user_id`, `user_password` should be C string (null terminated), token and token_len should be consistent.
</span><span class="attribute">#[no_mangle]
</span><span class="kw">pub unsafe extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn </span>teaclave_user_login(
client: <span class="kw-2">&amp;mut </span>AuthenticationClient,
user_id: <span class="kw-2">*const </span>c_char,
user_password: <span class="kw-2">*const </span>c_char,
token: <span class="kw-2">*mut </span>c_char,
token_len: <span class="kw-2">*mut </span>size_t,
) -&gt; c_int {
<span class="kw">if </span>(client <span class="kw">as </span><span class="kw-2">*mut </span>AuthenticationClient).is_null()
|| user_id.is_null()
|| user_password.is_null()
|| token.is_null()
|| token_len.is_null()
{
<span class="kw">return </span><span class="number">1</span>;
}
<span class="kw">let </span>user_id = CStr::from_ptr(user_id).to_string_lossy().into_owned();
<span class="kw">let </span>user_password = CStr::from_ptr(user_password).to_string_lossy().into_owned();
<span class="kw">let </span>token_string = <span class="macro">unwrap_or_return_one!</span>(client.user_login(<span class="kw-2">&amp;</span>user_id, <span class="kw-2">&amp;</span>user_password));
<span class="kw">let </span>token_c_string = <span class="macro">unwrap_or_return_one!</span>(CString::new(token_string));
<span class="kw">let </span>bytes = token_c_string.as_bytes_with_nul();
<span class="kw">if </span><span class="kw-2">*</span>token_len &lt; bytes.len() {
<span class="kw">return </span><span class="number">1</span>;
} <span class="kw">else </span>{
ptr::copy_nonoverlapping(bytes.as_ptr(), token <span class="kw">as _</span>, bytes.len());
<span class="kw-2">*</span>token_len = bytes.len();
}
<span class="number">0
</span>}
<span class="doccomment">/// Connect to Teaclave Frontend Service.
///
/// This function connects and establishes trusted channel to the remote
/// frontend service with `address`. The function gets *enclave info* from
/// the file located in `enclave_info_path`. The file in `as_root_ca_cert_path`
/// will be used to verify the attestation report from the remote service.
///
/// # Arguments
///
/// * `address`: address of remote services, normally,it&#39;s a domain name with port number.
/// * `enclave_info_path`: file path of the *enclave info* TOML file.
/// * `as_root_ca_cert_path`: file path of the certificate for remote attestation service.
///
/// # Return
///
/// * The function returns an opaque pointer (handle) of the service. On error,
/// the function returns NULL.
///
/// # Safety
///
/// All arguments should be C string (null terminated).
</span><span class="attribute">#[no_mangle]
</span><span class="kw">pub unsafe extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn </span>teaclave_connect_frontend_service(
address: <span class="kw-2">*const </span>c_char,
enclave_info_path: <span class="kw-2">*const </span>c_char,
as_root_ca_cert_path: <span class="kw-2">*const </span>c_char,
) -&gt; <span class="kw-2">*mut </span>FrontendClient {
<span class="kw">if </span>address.is_null() || enclave_info_path.is_null() || as_root_ca_cert_path.is_null() {
<span class="kw">return </span>ptr::null_mut();
}
<span class="kw">let </span>address = CStr::from_ptr(address).to_string_lossy().into_owned();
<span class="kw">let </span>enclave_info_path = CStr::from_ptr(enclave_info_path)
.to_string_lossy()
.into_owned();
<span class="kw">let </span>as_root_ca_cert_path = CStr::from_ptr(as_root_ca_cert_path)
.to_string_lossy()
.into_owned();
<span class="kw">let </span>enclave_info = <span class="macro">unwrap_or_return_null!</span>(EnclaveInfo::from_file(enclave_info_path));
<span class="kw">let </span>bytes = <span class="macro">unwrap_or_return_null!</span>(fs::read(as_root_ca_cert_path));
<span class="kw">let </span>as_root_ca_cert = <span class="macro">unwrap_or_return_null!</span>(pem::parse(bytes)).contents;
<span class="kw">let </span>client = <span class="macro">unwrap_or_return_null!</span>(FrontendService::connect(
<span class="kw-2">&amp;</span>address,
<span class="kw-2">&amp;</span>enclave_info,
<span class="kw-2">&amp;</span>as_root_ca_cert
));
Box::into_raw(Box::new(client))
}
<span class="doccomment">/// Close and free the frontend service handle, i.e., the `FrontendClient` type
/// opaque pointer. The function returns 0 for success. On error, the function
/// returns 1.
///
/// # Safety
///
/// This function is unsafe because improper use may lead to
/// memory problems. For example, a double-free may occur if the
/// function is called twice on the same raw pointer.
</span><span class="attribute">#[no_mangle]
</span><span class="kw">pub unsafe extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn </span>teaclave_close_frontend_service(client: <span class="kw-2">*mut </span>FrontendClient) -&gt; c_int {
<span class="kw">if </span>client.is_null() {
<span class="kw">return </span><span class="number">1</span>;
}
<span class="kw">let _ </span>= Box::from_raw(client);
<span class="number">0
</span>}
<span class="doccomment">/// Set user&#39;s credential with `user_id` and `user_token`. The function returns
/// 0 for success. On error, the function returns 1.
///
/// # Safety
///
/// `user_id` and `user_token` should be C string (null terminated).
</span><span class="attribute">#[no_mangle]
</span><span class="kw">pub unsafe extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn </span>teaclave_authentication_set_credential(
client: <span class="kw-2">&amp;mut </span>AuthenticationClient,
user_id: <span class="kw-2">*const </span>c_char,
user_token: <span class="kw-2">*const </span>c_char,
) -&gt; c_int {
<span class="kw">if </span>(client <span class="kw">as </span><span class="kw-2">*mut </span>AuthenticationClient).is_null() || user_id.is_null() || user_token.is_null()
{
<span class="kw">return </span><span class="number">1</span>;
}
<span class="kw">let </span>user_id = CStr::from_ptr(user_id).to_string_lossy().into_owned();
<span class="kw">let </span>user_token = CStr::from_ptr(user_token).to_string_lossy().into_owned();
client.set_credential(<span class="kw-2">&amp;</span>user_id, <span class="kw-2">&amp;</span>user_token);
<span class="number">0
</span>}
<span class="doccomment">/// Set user&#39;s credential with `user_id` and `user_token`. The function returns
/// 0 for success. On error, the function returns 1.
///
/// # Safety
///
/// `user_id` and `user_token` should be C string (null terminated).
</span><span class="attribute">#[no_mangle]
</span><span class="kw">pub unsafe extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn </span>teaclave_frontend_set_credential(
client: <span class="kw-2">&amp;mut </span>FrontendClient,
user_id: <span class="kw-2">*const </span>c_char,
user_token: <span class="kw-2">*const </span>c_char,
) -&gt; c_int {
<span class="kw">if </span>(client <span class="kw">as </span><span class="kw-2">*mut </span>FrontendClient).is_null() || user_id.is_null() || user_token.is_null() {
<span class="kw">return </span><span class="number">1</span>;
}
<span class="kw">let </span>user_id = CStr::from_ptr(user_id).to_string_lossy().into_owned();
<span class="kw">let </span>user_token = CStr::from_ptr(user_token).to_string_lossy().into_owned();
client.set_credential(<span class="kw-2">&amp;</span>user_id, <span class="kw-2">&amp;</span>user_token);
<span class="number">0
</span>}
<span class="doccomment">/// Invoke task with `task_id`. The function returns 0 for success. On error,
/// the function returns 1.
///
/// # Safety
///
/// `task_id` should be C string (null terminated).
</span><span class="attribute">#[no_mangle]
</span><span class="kw">pub unsafe extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn </span>teaclave_invoke_task(
client: <span class="kw-2">&amp;mut </span>FrontendClient,
task_id: <span class="kw-2">*const </span>c_char,
) -&gt; c_int {
<span class="kw">if </span>(client <span class="kw">as </span><span class="kw-2">*mut </span>FrontendClient).is_null() || task_id.is_null() {
<span class="kw">return </span><span class="number">1</span>;
}
<span class="kw">let </span>task_id = CStr::from_ptr(task_id).to_string_lossy().into_owned();
<span class="kw">match </span>client.invoke_task(<span class="kw-2">&amp;</span>task_id) {
<span class="prelude-val">Ok</span>(<span class="kw">_</span>) =&gt; <span class="number">0</span>,
<span class="prelude-val">Err</span>(<span class="kw">_</span>) =&gt; <span class="number">1</span>,
}
}
<span class="doccomment">/// Cancel task with `task_id`. The function returns 0 for success. On error,
/// the function returns 1.
///
/// # Safety
///
/// `task_id` should be C string (null terminated).
</span><span class="attribute">#[no_mangle]
</span><span class="kw">pub unsafe extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn </span>teaclave_cancel_task(
client: <span class="kw-2">&amp;mut </span>FrontendClient,
task_id: <span class="kw-2">*const </span>c_char,
) -&gt; c_int {
<span class="kw">if </span>(client <span class="kw">as </span><span class="kw-2">*mut </span>FrontendClient).is_null() || task_id.is_null() {
<span class="kw">return </span><span class="number">1</span>;
}
<span class="kw">let </span>task_id = CStr::from_ptr(task_id).to_string_lossy().into_owned();
<span class="kw">match </span>client.cancel_task(<span class="kw-2">&amp;</span>task_id) {
<span class="prelude-val">Ok</span>(<span class="kw">_</span>) =&gt; <span class="number">0</span>,
<span class="prelude-val">Err</span>(<span class="kw">_</span>) =&gt; <span class="number">1</span>,
}
}
<span class="doccomment">/// Get task result of `task_id`. The result will be save in the `task_result`
/// buffer, and set corresponding `task_result_len` argument. Note that this is
/// a blocking function and wait for the return of the task. The function
/// returns 0 for success. On error, the function returns 1.
///
/// # Safety
///
/// Inconsistent length of allocated buffer may caused overflow.
</span><span class="attribute">#[no_mangle]
</span><span class="kw">pub unsafe extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn </span>teaclave_get_task_result(
client: <span class="kw-2">&amp;mut </span>FrontendClient,
task_id: <span class="kw-2">*const </span>c_char,
task_result: <span class="kw-2">*mut </span>c_char,
task_result_len: <span class="kw-2">*mut </span>size_t,
) -&gt; c_int {
<span class="kw">if </span>(client <span class="kw">as </span><span class="kw-2">*mut </span>FrontendClient).is_null() || task_id.is_null() {
<span class="kw">return </span><span class="number">1</span>;
}
<span class="kw">let </span>task_id = CStr::from_ptr(task_id).to_string_lossy().into_owned();
<span class="kw">match </span>client.get_task_result(<span class="kw-2">&amp;</span>task_id) {
<span class="prelude-val">Ok</span>((result, <span class="kw">_</span>)) =&gt; {
<span class="kw">if </span><span class="kw-2">*</span>task_result_len &lt; result.len() {
<span class="kw">return </span><span class="number">1</span>;
} <span class="kw">else </span>{
ptr::copy_nonoverlapping(result.as_ptr(), task_result <span class="kw">as _</span>, result.len());
<span class="kw-2">*</span>task_result_len = result.len();
}
<span class="number">0
</span>}
<span class="prelude-val">Err</span>(<span class="kw">_</span>) =&gt; <span class="number">1</span>,
}
}
<span class="doccomment">/// Query audit logs according to `query`. `query` is the query statement for tantivy. The result
/// will be saved in the `log_buffer` buffer with the corresponding `log_len` argument set.
/// Remember to free the user and message inside c_entry to avoid memory leak.
///
/// The function returns 0 for success. On error, the function returns 1.
///
/// # Safety
///
/// Inconsistent length of allocated buffer may caused overflow.
</span><span class="attribute">#[no_mangle]
</span><span class="kw">pub unsafe extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn </span>teaclave_query_audit_logs(
client: <span class="kw-2">&amp;mut </span>FrontendClient,
query: <span class="kw-2">*const </span>c_char,
log_buffer: <span class="kw-2">*mut </span>c_entry,
log_len: <span class="kw-2">*mut </span>size_t,
) -&gt; c_int {
<span class="kw">if </span>(client <span class="kw">as </span><span class="kw-2">*mut </span>FrontendClient).is_null()
|| query.is_null()
|| log_buffer.is_null()
|| log_len.is_null()
|| <span class="kw-2">*</span>log_len == <span class="number">0
</span>{
<span class="kw">return </span><span class="number">1</span>;
}
<span class="kw">let </span>query = CStr::from_ptr(query).to_string_lossy().into_owned();
<span class="kw">match </span>client.query_audit_logs(query, <span class="kw-2">*</span>log_len) {
<span class="prelude-val">Ok</span>(audit_logs) =&gt; {
<span class="kw">let </span>c_logs: Vec&lt;<span class="kw">_</span>&gt; = audit_logs.into_iter().map(c_entry::from).collect();
<span class="kw">let </span>src_logs = c_logs.as_ptr();
<span class="kw">let </span>len = c_logs.len();
<span class="kw">if </span>len &gt; <span class="kw-2">*</span>log_len {
<span class="kw">return </span><span class="number">1</span>;
}
<span class="kw">unsafe </span>{
ptr::copy_nonoverlapping(src_logs, log_buffer, len);
}
<span class="kw-2">*</span>log_len = len;
<span class="number">0
</span>}
<span class="prelude-val">Err</span>(<span class="kw">_</span>) =&gt; <span class="number">1</span>,
}
}
<span class="attribute">#[repr(C)]
</span><span class="kw">pub struct </span>c_entry {
microsecond: i64,
ip: [u8; <span class="number">16</span>],
user: <span class="kw-2">*mut </span>c_void,
message: <span class="kw-2">*mut </span>c_void,
result: bool,
}
<span class="kw">impl </span>From&lt;Entry&gt; <span class="kw">for </span>c_entry {
<span class="kw">fn </span>from(entry: Entry) -&gt; <span class="self">Self </span>{
<span class="kw">let </span>user_bytes = CString::new(entry.user()).unwrap().into_bytes_with_nul();
<span class="kw">let </span>len = user_bytes.len();
<span class="kw">let </span>user = <span class="kw">unsafe </span>{
<span class="kw">let </span>user = malloc(len);
ptr::copy_nonoverlapping(user_bytes.as_ptr(), user <span class="kw">as </span><span class="kw-2">*mut </span>u8, len);
user
};
<span class="kw">let </span>message_bytes = CString::new(entry.message()).unwrap().into_bytes_with_nul();
<span class="kw">let </span>len = message_bytes.len();
<span class="kw">let </span>message = <span class="kw">unsafe </span>{
<span class="kw">let </span>message = malloc(len);
ptr::copy_nonoverlapping(message_bytes.as_ptr(), message <span class="kw">as </span><span class="kw-2">*mut </span>u8, len);
message
};
<span class="self">Self </span>{
microsecond: entry.datetime().timestamp_micros(),
ip: entry.ip().octets(),
user,
message,
result: entry.result(),
}
}
}
<span class="macro">macro_rules! </span>generate_function_serialized {
( <span class="macro-nonterminal">$client_type</span>:ident, <span class="macro-nonterminal">$c_function_name</span>:ident, <span class="macro-nonterminal">$rust_function_name</span>:ident) =&gt; {
<span class="doccomment">/// Send JSON serialized request to the service with the `client` and
/// get the serialized response.
///
/// # Arguments
///
/// * `client`: service client.
/// * `serialized_request`; JSON serialized request
/// * `serialized_response`: buffer to store the JSON serialized response.
/// * `serialized_response_len`: length of the allocated
/// `serialized_response`, will be set as the length of
/// `serialized_response` when return successfully.
///
/// # Return
///
/// The function returns 0 for success. On error, the function returns 1.
///
/// # Safety
///
/// Inconsistent length of allocated buffer may caused overflow.
</span><span class="attribute">#[no_mangle]
</span><span class="kw">pub unsafe extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn </span><span class="macro-nonterminal">$c_function_name</span>(
client: <span class="kw-2">&amp;mut </span><span class="macro-nonterminal">$client_type</span>,
serialized_request: <span class="kw-2">*const </span>c_char,
serialized_response: <span class="kw-2">*mut </span>c_char,
serialized_response_len: <span class="kw-2">*mut </span>size_t,
) -&gt; c_int {
<span class="kw">if </span>(client <span class="kw">as </span><span class="kw-2">*mut </span><span class="macro-nonterminal">$client_type</span>).is_null()
|| serialized_request.is_null()
|| serialized_response.is_null()
|| serialized_response_len.is_null()
{
<span class="kw">return </span><span class="number">1</span>;
}
<span class="kw">let </span>serialized_request = CStr::from_ptr(serialized_request)
.to_string_lossy()
.into_owned();
<span class="kw">let </span>function_id_string =
<span class="macro">unwrap_or_return_one!</span>(client.<span class="macro-nonterminal">$rust_function_name</span>(<span class="kw-2">&amp;</span>serialized_request));
<span class="kw">let </span>function_id_c_string = <span class="macro">unwrap_or_return_one!</span>(CString::new(function_id_string));
<span class="kw">let </span>bytes = function_id_c_string.as_bytes_with_nul();
<span class="kw">if </span><span class="kw-2">*</span>serialized_response_len &lt; bytes.len() {
<span class="kw">return </span><span class="number">1</span>;
} <span class="kw">else </span>{
ptr::copy_nonoverlapping(bytes.as_ptr(), serialized_response <span class="kw">as _</span>, bytes.len());
<span class="kw-2">*</span>serialized_response_len = bytes.len();
}
<span class="number">0
</span>}
};
}
<span class="macro">generate_function_serialized!</span>(
AuthenticationClient,
teaclave_user_register_serialized,
user_register_serialized
);
<span class="macro">generate_function_serialized!</span>(
AuthenticationClient,
teaclave_user_login_serialized,
user_login_serialized
);
<span class="macro">generate_function_serialized!</span>(
FrontendClient,
teaclave_register_function_serialized,
register_function_serialized
);
<span class="macro">generate_function_serialized!</span>(
FrontendClient,
teaclave_get_function_serialized,
get_function_serialized
);
<span class="macro">generate_function_serialized!</span>(
FrontendClient,
teaclave_get_function_usage_stats_serialized,
get_function_usage_stats_serialized
);
<span class="macro">generate_function_serialized!</span>(
FrontendClient,
teaclave_register_input_file_serialized,
register_input_file_serialized
);
<span class="macro">generate_function_serialized!</span>(
FrontendClient,
teaclave_register_output_file_serialized,
register_output_file_serialized
);
<span class="macro">generate_function_serialized!</span>(
FrontendClient,
teaclave_create_task_serialized,
create_task_serialized
);
<span class="macro">generate_function_serialized!</span>(
FrontendClient,
teaclave_assign_data_serialized,
assign_data_serialized
);
<span class="macro">generate_function_serialized!</span>(
FrontendClient,
teaclave_approve_task_serialized,
approve_task_serialized
);
<span class="macro">generate_function_serialized!</span>(
FrontendClient,
teaclave_invoke_task_serialized,
invoke_task_serialized
);
<span class="macro">generate_function_serialized!</span>(
FrontendClient,
teaclave_cancel_task_serialized,
cancel_task_serialized
);
<span class="macro">generate_function_serialized!</span>(
FrontendClient,
teaclave_get_task_serialized,
get_task_serialized
);
<span class="macro">generate_function_serialized!</span>(
FrontendClient,
teaclave_query_audit_logs_serialized,
query_audit_logs_serialized
);
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="teaclave_client_sdk" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>