blob: f8b0707c9abf18ee1303be74285fe8e31ed99a70 [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 `types/src/staged_file.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>staged_file.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_types/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_types/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>
</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>teaclave_crypto::TeaclaveFile128Key;
<span class="kw">use </span>std::collections::HashMap;
<span class="attribute">#[cfg(not(feature = <span class="string">&quot;mesalock_sgx&quot;</span>))]
</span><span class="kw">use </span>std::fs::File;
<span class="kw">use </span>std::io::{<span class="self">self</span>, BufRead, BufReader, Read, Write};
<span class="kw">use </span>std::path::{Path, PathBuf};
<span class="attribute">#[cfg(feature = <span class="string">&quot;mesalock_sgx&quot;</span>)]
</span><span class="kw">use </span>std::untrusted::fs::File;
<span class="kw">use </span><span class="kw">crate</span>::FileAuthTag;
<span class="kw">use </span><span class="kw">crate</span>::FileCrypto;
<span class="kw">use </span>anyhow::Context;
<span class="kw">use </span>sgx_tprotected_fs::SgxFile;
<span class="attribute">#[derive(Clone, Debug, Default)]
</span><span class="kw">pub struct </span>StagedFileInfo {
<span class="kw">pub </span>path: PathBuf,
<span class="kw">pub </span>crypto_info: TeaclaveFile128Key,
<span class="kw">pub </span>cmac: FileAuthTag,
}
<span class="kw">impl </span>StagedFileInfo {
<span class="kw">pub fn </span>new(
path: <span class="kw">impl </span>AsRef&lt;Path&gt;,
crypto_info: TeaclaveFile128Key,
cmac: <span class="kw">impl </span>Into&lt;FileAuthTag&gt;,
) -&gt; <span class="self">Self </span>{
StagedFileInfo {
path: path.as_ref().into(),
crypto_info,
cmac: cmac.into(),
}
}
<span class="kw">pub fn </span>create_readable_io(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; anyhow::Result&lt;Box&lt;<span class="kw">dyn </span>io::Read&gt;&gt; {
<span class="kw">let </span>f = SgxFile::open_with_key(<span class="kw-2">&amp;</span><span class="self">self</span>.path, <span class="self">self</span>.crypto_info.key)<span class="question-mark">?</span>;
<span class="kw">let </span>tag = f
.get_mac()
.context(<span class="string">&quot;Failed to get gmac from protected file&quot;</span>)<span class="question-mark">?</span>;
<span class="macro">anyhow::ensure!</span>(<span class="self">self</span>.cmac == tag, <span class="string">&quot;Corrupted input file: {:?}&quot;</span>, <span class="self">self</span>.path);
<span class="prelude-val">Ok</span>(Box::new(f))
}
<span class="kw">pub fn </span>create_writable_io(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; anyhow::Result&lt;Box&lt;<span class="kw">dyn </span>io::Write&gt;&gt; {
<span class="kw">let </span>f = SgxFile::create_with_key(<span class="kw-2">&amp;</span><span class="self">self</span>.path, <span class="self">self</span>.crypto_info.key)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(Box::new(f))
}
<span class="kw">pub fn </span>convert_for_uploading(
<span class="kw-2">&amp;</span><span class="self">self</span>,
dst: <span class="kw">impl </span>AsRef&lt;Path&gt;,
crypto_info: FileCrypto,
) -&gt; anyhow::Result&lt;FileAuthTag&gt; {
<span class="kw">match </span>crypto_info {
FileCrypto::TeaclaveFile128(cipher) =&gt; {
<span class="self">self</span>.convert_to_teaclave_file(dst, cipher.to_owned())
}
FileCrypto::AesGcm128(cipher) =&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>src_file = SgxFile::open_with_key(<span class="kw-2">&amp;</span><span class="self">self</span>.path, <span class="self">self</span>.crypto_info.key)
.context(<span class="string">&quot;Convert aes-gcm-128: failed to open src file&quot;</span>)<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>buffer = Vec::new();
src_file.read_to_end(<span class="kw-2">&amp;mut </span>buffer)<span class="question-mark">?</span>;
<span class="kw">let </span>cmac = cipher.encrypt(<span class="kw-2">&amp;mut </span>buffer)<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>file = File::create(dst)<span class="question-mark">?</span>;
file.write_all(<span class="kw-2">&amp;</span>buffer)<span class="question-mark">?</span>;
FileAuthTag::from_bytes(<span class="kw-2">&amp;</span>cmac)
}
FileCrypto::AesGcm256(cipher) =&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>src_file = SgxFile::open_with_key(<span class="kw-2">&amp;</span><span class="self">self</span>.path, <span class="self">self</span>.crypto_info.key)
.context(<span class="string">&quot;Convert aes-gcm-256: failed to open src file&quot;</span>)<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>buffer = Vec::new();
src_file.read_to_end(<span class="kw-2">&amp;mut </span>buffer)<span class="question-mark">?</span>;
<span class="kw">let </span>cmac = cipher.encrypt(<span class="kw-2">&amp;mut </span>buffer)<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>file = File::create(dst)<span class="question-mark">?</span>;
file.write_all(<span class="kw-2">&amp;</span>buffer)<span class="question-mark">?</span>;
FileAuthTag::from_bytes(<span class="kw-2">&amp;</span>cmac)
}
FileCrypto::Raw =&gt; <span class="macro">anyhow::bail!</span>(<span class="string">&quot;OutputFile: unsupported type&quot;</span>),
}
}
<span class="kw">pub fn </span>convert_to_teaclave_file(
<span class="kw-2">&amp;</span><span class="self">self</span>,
dst: <span class="kw">impl </span>AsRef&lt;Path&gt;,
crypto: TeaclaveFile128Key,
) -&gt; anyhow::Result&lt;FileAuthTag&gt; {
<span class="kw">let </span>src_file = SgxFile::open_with_key(<span class="kw-2">&amp;</span><span class="self">self</span>.path, <span class="self">self</span>.crypto_info.key)
.context(<span class="string">&quot;Convert teaclave_file: failed to open src file&quot;</span>)<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>dest_file = SgxFile::create_with_key(dst.as_ref(), crypto.key)
.context(<span class="string">&quot;Convert teaclave_file: failed to create dst file&quot;</span>)<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>reader = BufReader::with_capacity(<span class="number">4096</span>, src_file);
<span class="kw">loop </span>{
<span class="kw">let </span>buffer = reader.fill_buf()<span class="question-mark">?</span>;
<span class="kw">let </span>rd_len = buffer.len();
<span class="kw">if </span>rd_len == <span class="number">0 </span>{
<span class="kw">break</span>;
}
<span class="kw">let </span>wt_len = dest_file.write(buffer)<span class="question-mark">?</span>;
<span class="macro">anyhow::ensure!</span>(
rd_len == wt_len,
<span class="string">&quot;Cannot fully write to dest file: Rd({:?}) != Wt({:?})&quot;</span>,
rd_len,
wt_len
);
reader.consume(rd_len);
}
dest_file
.flush()
.context(<span class="string">&quot;Convert teaclave_file: dst_file flush failed&quot;</span>)<span class="question-mark">?</span>;
<span class="kw">let </span>mac = dest_file
.get_mac()
.context(<span class="string">&quot;Convert teaclave_file: cannot get dst_file gmac&quot;</span>)<span class="question-mark">?</span>;
FileAuthTag::from_bytes(<span class="kw-2">&amp;</span>mac)
}
<span class="attribute">#[cfg(test_mode)]
</span><span class="kw">pub fn </span>create_with_plaintext_file(path: <span class="kw">impl </span>AsRef&lt;Path&gt;) -&gt; anyhow::Result&lt;StagedFileInfo&gt; {
<span class="kw">let </span>bytes = read_all_bytes(path.as_ref())<span class="question-mark">?</span>;
<span class="kw">let </span>dst = path.as_ref().with_extension(<span class="string">&quot;test_enc&quot;</span>);
<span class="self">Self</span>::create_with_bytes(dst, <span class="kw-2">&amp;</span>bytes)
}
<span class="attribute">#[cfg(test_mode)]
</span><span class="kw">pub fn </span>get_plaintext(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; anyhow::Result&lt;Vec&lt;u8&gt;&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>content = Vec::new();
<span class="kw">let </span><span class="kw-2">mut </span>f = SgxFile::open_with_key(<span class="kw-2">&amp;</span><span class="self">self</span>.path, <span class="self">self</span>.crypto_info.key)<span class="question-mark">?</span>;
f.read_to_end(<span class="kw-2">&amp;mut </span>content)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(content)
}
<span class="kw">pub fn </span>create_with_bytes(
path: <span class="kw">impl </span>AsRef&lt;Path&gt;,
bytes: <span class="kw-2">&amp;</span>[u8],
) -&gt; anyhow::Result&lt;StagedFileInfo&gt; {
<span class="kw">let </span>crypto = TeaclaveFile128Key::random();
<span class="kw">let </span><span class="kw-2">mut </span>f = SgxFile::create_with_key(<span class="kw-2">&amp;</span>path, crypto.key)<span class="question-mark">?</span>;
f.write_all(bytes)<span class="question-mark">?</span>;
f.flush()<span class="question-mark">?</span>;
<span class="kw">let </span>tag = f.get_mac()<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(<span class="self">Self</span>::new(path.as_ref(), crypto, tag))
}
}
<span class="kw">pub fn </span>read_all_bytes(path: <span class="kw">impl </span>AsRef&lt;Path&gt;) -&gt; anyhow::Result&lt;Vec&lt;u8&gt;&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>content = Vec::new();
<span class="kw">let </span><span class="kw-2">mut </span>file = File::open(path)<span class="question-mark">?</span>;
file.read_to_end(<span class="kw-2">&amp;mut </span>content)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(content)
}
<span class="attribute">#[derive(Debug, Default, Clone)]
</span><span class="kw">pub struct </span>StagedFiles {
entries: HashMap&lt;String, StagedFileInfo&gt;,
}
<span class="kw">impl </span>StagedFiles {
<span class="kw">pub fn </span>new(entries: HashMap&lt;String, StagedFileInfo&gt;) -&gt; <span class="self">Self </span>{
StagedFiles { entries }
}
<span class="kw">pub fn </span>get(<span class="kw-2">&amp;</span><span class="self">self</span>, key: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>StagedFileInfo&gt; {
<span class="self">self</span>.entries.get(key)
}
<span class="kw">pub fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.entries.len()
}
<span class="kw">pub fn </span>is_empty(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.len() == <span class="number">0
</span>}
}
<span class="kw">impl </span>std::iter::FromIterator&lt;(String, StagedFileInfo)&gt; <span class="kw">for </span>StagedFiles {
<span class="kw">fn </span>from_iter&lt;T: IntoIterator&lt;Item = (String, StagedFileInfo)&gt;&gt;(iter: T) -&gt; <span class="self">Self </span>{
StagedFiles {
entries: HashMap::from_iter(iter),
}
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="teaclave_types" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>