blob: 520e39be2ce484efbc2d9ef8c962436b856340be [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&#x2F;session.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>session.rs - source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.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"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></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"><div class="sidebar-menu" role="button">&#9776;</div><a href='../../optee_teec/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../wheel.svg"></a></div></form></nav><section id="main" class="content"><div class="example-wrap"><pre class="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>
</pre><pre class="rust"><code><span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="comment">// or more contributor license agreements. See the NOTICE file</span>
<span class="comment">// distributed with this work for additional information</span>
<span class="comment">// regarding copyright ownership. The ASF licenses this file</span>
<span class="comment">// to you under the Apache License, Version 2.0 (the</span>
<span class="comment">// &quot;License&quot;); you may not use this file except in compliance</span>
<span class="comment">// with the License. You may obtain a copy of the License at</span>
<span class="comment">//</span>
<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="comment">//</span>
<span class="comment">// Unless required by applicable law or agreed to in writing,</span>
<span class="comment">// software distributed under the License is distributed on an</span>
<span class="comment">// &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span>
<span class="comment">// KIND, either express or implied. See the License for the</span>
<span class="comment">// specific language governing permissions and limitations</span>
<span class="comment">// under the License.</span>
<span class="kw">use</span> <span class="ident">libc</span>;
<span class="kw">use</span> <span class="ident">optee_teec_sys</span> <span class="kw">as</span> <span class="ident">raw</span>;
<span class="kw">use</span> <span class="ident">std::ptr</span>;
<span class="kw">use</span> <span class="ident">std::marker</span>;
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::Param</span>;
<span class="kw">use</span> <span class="kw">crate</span>::{<span class="ident">Context</span>, <span class="ident">Error</span>, <span class="ident">Operation</span>, <span class="prelude-ty">Result</span>, <span class="ident">Uuid</span>};
<span class="doccomment">/// Session login methods.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Copy</span>, <span class="ident">Clone</span>)]</span>
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">ConnectionMethods</span> {
<span class="doccomment">/// No login data is provided.</span>
<span class="ident">LoginPublic</span>,
<span class="doccomment">/// Login data about the user running the Client Application process is provided.</span>
<span class="ident">LoginUser</span>,
<span class="doccomment">/// Login data about the group running the Client Application process is provided.</span>
<span class="ident">LoginGroup</span>,
<span class="doccomment">/// Login data about the running Client Application itself is provided.</span>
<span class="ident">LoginApplication</span>,
<span class="doccomment">/// Login data about the user and the running Client Application itself is provided.</span>
<span class="ident">LoginUserApplication</span>,
<span class="doccomment">/// Login data about the group and the running Client Application itself is provided.</span>
<span class="ident">LoginGroupApplication</span>,
}
<span class="doccomment">/// Represents a connection between a client application and a trusted application.</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Session</span><span class="op">&lt;</span><span class="lifetime">&#39;ctx</span><span class="op">&gt;</span> {
<span class="ident">raw</span>: <span class="ident">raw::TEEC_Session</span>,
<span class="ident">_marker</span>: <span class="ident">marker::PhantomData</span><span class="op">&lt;</span><span class="kw-2">&amp;</span><span class="lifetime">&#39;ctx</span> <span class="kw-2">mut</span> <span class="ident">Context</span><span class="op">&gt;</span>,
}
<span class="kw">impl</span><span class="op">&lt;</span><span class="lifetime">&#39;ctx</span><span class="op">&gt;</span> <span class="ident">Session</span><span class="op">&lt;</span><span class="lifetime">&#39;ctx</span><span class="op">&gt;</span> {
<span class="doccomment">/// Initializes a TEE session object with specified context and uuid.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span><span class="op">&lt;</span><span class="ident">A</span>: <span class="ident">Param</span>, <span class="ident">B</span>: <span class="ident">Param</span>, <span class="ident">C</span>: <span class="ident">Param</span>, <span class="ident">D</span>: <span class="ident">Param</span><span class="op">&gt;</span>(
<span class="ident">context</span>: <span class="kw-2">&amp;</span><span class="lifetime">&#39;ctx</span> <span class="kw-2">mut</span> <span class="ident">Context</span>,
<span class="ident">uuid</span>: <span class="ident">Uuid</span>,
<span class="ident">operation</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">Operation</span><span class="op">&lt;</span><span class="ident">A</span>, <span class="ident">B</span>, <span class="ident">C</span>, <span class="ident">D</span><span class="op">&gt;</span><span class="op">&gt;</span>,
) <span class="op">-</span><span class="op">&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="self">Self</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">raw_session</span> <span class="op">=</span> <span class="ident">raw::TEEC_Session</span> {
<span class="ident">ctx</span>: <span class="ident">context</span>.<span class="ident">as_mut_raw_ptr</span>(),
<span class="ident">session_id</span>: <span class="number">0</span>,
};
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">err_origin</span>: <span class="ident">u32</span> <span class="op">=</span> <span class="number">0</span>;
<span class="kw">let</span> <span class="ident">raw_operation</span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">operation</span> {
<span class="prelude-val">Some</span>(<span class="ident">o</span>) <span class="op">=</span><span class="op">&gt;</span> <span class="ident">o</span>.<span class="ident">as_mut_raw_ptr</span>(),
<span class="prelude-val">None</span> <span class="op">=</span><span class="op">&gt;</span> <span class="ident">ptr::null_mut</span>() <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">raw::TEEC_Operation</span>,
};
<span class="kw">unsafe</span> {
<span class="kw">match</span> <span class="ident">raw::TEEC_OpenSession</span>(
<span class="ident">context</span>.<span class="ident">as_mut_raw_ptr</span>(),
<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">raw_session</span>,
<span class="ident">uuid</span>.<span class="ident">as_raw_ptr</span>(),
<span class="ident">ConnectionMethods::LoginPublic</span> <span class="kw">as</span> <span class="ident">u32</span>,
<span class="ident">ptr::null</span>() <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">libc::c_void</span>,
<span class="ident">raw_operation</span>,
<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">err_origin</span>,
) {
<span class="ident">raw::TEEC_SUCCESS</span> <span class="op">=</span><span class="op">&gt;</span> <span class="prelude-val">Ok</span>(<span class="self">Self</span> { <span class="ident">raw</span>: <span class="ident">raw_session</span>, <span class="ident">_marker</span>: <span class="ident">marker::PhantomData</span> }),
<span class="ident">code</span> <span class="op">=</span><span class="op">&gt;</span> <span class="prelude-val">Err</span>(<span class="ident">Error::from_raw_error</span>(<span class="ident">code</span>)),
}
}
}
<span class="doccomment">/// Converts a TEE client context to a raw pointer.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_mut_raw_ptr</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">raw::TEEC_Session</span> {
<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">raw</span>
}
<span class="doccomment">/// Invokes a command with an operation with this session.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">invoke_command</span><span class="op">&lt;</span><span class="ident">A</span>: <span class="ident">Param</span>, <span class="ident">B</span>: <span class="ident">Param</span>, <span class="ident">C</span>: <span class="ident">Param</span>, <span class="ident">D</span>: <span class="ident">Param</span><span class="op">&gt;</span>(
<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>,
<span class="ident">command_id</span>: <span class="ident">u32</span>,
<span class="ident">operation</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">Operation</span><span class="op">&lt;</span><span class="ident">A</span>, <span class="ident">B</span>, <span class="ident">C</span>, <span class="ident">D</span><span class="op">&gt;</span>,
) <span class="op">-</span><span class="op">&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span>()<span class="op">&gt;</span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">err_origin</span>: <span class="ident">u32</span> <span class="op">=</span> <span class="number">0</span>;
<span class="kw">unsafe</span> {
<span class="kw">match</span> <span class="ident">raw::TEEC_InvokeCommand</span>(
<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">raw</span>,
<span class="ident">command_id</span>,
<span class="ident">operation</span>.<span class="ident">as_mut_raw_ptr</span>(),
<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">err_origin</span>,
) {
<span class="ident">raw::TEEC_SUCCESS</span> <span class="op">=</span><span class="op">&gt;</span> <span class="prelude-val">Ok</span>(()),
<span class="ident">code</span> <span class="op">=</span><span class="op">&gt;</span> <span class="prelude-val">Err</span>(<span class="ident">Error::from_raw_error</span>(<span class="ident">code</span>)),
}
}
}
}
<span class="kw">impl</span><span class="op">&lt;</span><span class="lifetime">&#39;ctx</span><span class="op">&gt;</span> <span class="ident">Drop</span> <span class="kw">for</span> <span class="ident">Session</span><span class="op">&lt;</span><span class="lifetime">&#39;ctx</span><span class="op">&gt;</span> {
<span class="kw">fn</span> <span class="ident">drop</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>) {
<span class="kw">unsafe</span> {
<span class="ident">raw::TEEC_CloseSession</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">raw</span>);
}
}
}
</code></pre></div>
</section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="optee_teec" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div>
<script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script>
</body></html>