| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `services/management/enclave/src/audit/auditor.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>auditor.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_management_service_enclave/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../teaclave_management_service_enclave/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| </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 super</span>::<span class="kw-2">*</span>; |
| |
| <span class="kw">use </span>teaclave_proto::teaclave_storage_service::TeaclaveStorageClient; |
| <span class="kw">use </span>teaclave_rpc::transport::Channel; |
| <span class="kw">use </span>teaclave_types::{Entry, EntryBuilder}; |
| |
| <span class="kw">use </span>std::sync::{Arc, Mutex}; |
| |
| <span class="kw">use </span>anyhow::{anyhow, <span class="prelude-ty">Result</span>}; |
| <span class="kw">use </span>tantivy::{ |
| collector::TopDocs, query::QueryParser, schema::<span class="kw-2">*</span>, DateTime, Index, IndexReader, IndexSettings, |
| IndexSortByField, IndexWriter, Order, ReloadPolicy, |
| }; |
| |
| <span class="attribute">#[derive(Clone)] |
| </span><span class="kw">pub struct </span>Auditor { |
| index: Arc<Mutex<Index>>, |
| reader: Arc<Mutex<IndexReader>>, |
| writer: Arc<Mutex<IndexWriter>>, |
| } |
| |
| <span class="kw">impl </span>Auditor { |
| <span class="kw">pub fn </span>try_new( |
| storage: Arc<tokio::sync::Mutex<TeaclaveStorageClient<Channel>>>, |
| ) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>> { |
| <span class="kw">let </span>directory = db_directory::DbDirectory::new(storage); |
| |
| <span class="kw">let </span>schema = <span class="self">Self</span>::log_schema(); |
| |
| <span class="kw">let </span>settings = IndexSettings { |
| sort_by_field: <span class="prelude-val">Some</span>(IndexSortByField { |
| field: <span class="string">"date"</span>.to_string(), |
| order: Order::Desc, |
| }), |
| ..Default::default() |
| }; |
| |
| <span class="kw">let </span>index = Index::builder() |
| .schema(schema) |
| .settings(settings) |
| .open_or_create(directory)<span class="question-mark">?</span>; |
| <span class="kw">let </span>reader = index |
| .reader_builder() |
| .reload_policy(ReloadPolicy::OnCommit) |
| .try_into()<span class="question-mark">?</span>; |
| |
| <span class="comment">// 8 is the max thread number of tantivy writer |
| </span><span class="kw">let </span>writer = index.writer(<span class="number">8 </span>* <span class="number">3_000_000</span>)<span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>index = Arc::new(Mutex::new(index)); |
| <span class="kw">let </span>reader = Arc::new(Mutex::new(reader)); |
| <span class="kw">let </span>writer = Arc::new(Mutex::new(writer)); |
| |
| <span class="prelude-val">Ok</span>(<span class="self">Self </span>{ |
| index, |
| reader, |
| writer, |
| }) |
| } |
| |
| <span class="kw">pub fn </span>add_logs(<span class="kw-2">&</span><span class="self">self</span>, logs: Vec<Entry>) -> <span class="prelude-ty">Result</span><()> { |
| <span class="kw">let </span><span class="kw-2">mut </span>writer = <span class="self">self</span>.writer.lock().unwrap(); |
| |
| <span class="kw">for </span>log <span class="kw">in </span>logs { |
| <span class="kw">let </span>document = <span class="self">Self</span>::convert_to_doc(log); |
| writer.add_document(document)<span class="question-mark">?</span>; |
| } |
| |
| writer.commit()<span class="question-mark">?</span>; |
| |
| <span class="prelude-val">Ok</span>(()) |
| } |
| |
| <span class="doccomment">/// query: the query for tantivy |
| /// limit: maximum number of the returned logs |
| </span><span class="kw">pub fn </span>query_logs(<span class="kw-2">&</span><span class="self">self</span>, query: <span class="kw-2">&</span>str, limit: usize) -> <span class="prelude-ty">Result</span><Vec<Entry>> { |
| <span class="kw">let </span>reader = <span class="self">self</span>.reader.lock().unwrap(); |
| <span class="kw">let </span>searcher = reader.searcher(); |
| drop(reader); |
| |
| <span class="kw">let </span>index = <span class="self">self</span>.index.lock().unwrap(); |
| <span class="kw">let </span>schema = <span class="self">Self</span>::log_schema(); |
| |
| <span class="kw">let </span>message = schema.get_field(<span class="string">"message"</span>).unwrap(); |
| <span class="kw">let </span>date = schema.get_field(<span class="string">"date"</span>).unwrap(); |
| |
| <span class="kw">let </span>query_parser = QueryParser::for_index(<span class="kw-2">&</span>index, <span class="macro">vec!</span>[message]); |
| <span class="kw">let </span>query = query_parser.parse_query(query)<span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>top_docs = searcher.search( |
| <span class="kw-2">&</span>query, |
| <span class="kw-2">&</span>TopDocs::with_limit(limit).order_by_fast_field::<DateTime>(date), |
| )<span class="question-mark">?</span>; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>entries = Vec::new(); |
| |
| <span class="kw">for </span>(<span class="kw">_</span>, doc_address) <span class="kw">in </span>top_docs { |
| <span class="kw">let </span>retrieved_doc = searcher.doc(doc_address)<span class="question-mark">?</span>; |
| <span class="kw">let </span>entry = <span class="self">Self</span>::try_convert_to_entry(retrieved_doc)<span class="question-mark">?</span>; |
| entries.push(entry); |
| } |
| |
| <span class="prelude-val">Ok</span>(entries) |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>try_convert_to_entry(doc: Document) -> <span class="prelude-ty">Result</span><Entry> { |
| <span class="kw">let </span>schema = <span class="self">Self</span>::log_schema(); |
| <span class="kw">let </span>date = schema.get_field(<span class="string">"date"</span>).unwrap(); |
| <span class="kw">let </span>ip = schema.get_field(<span class="string">"ip"</span>).unwrap(); |
| <span class="kw">let </span>user = schema.get_field(<span class="string">"user"</span>).unwrap(); |
| <span class="kw">let </span>message = schema.get_field(<span class="string">"message"</span>).unwrap(); |
| <span class="kw">let </span>result = schema.get_field(<span class="string">"result"</span>).unwrap(); |
| |
| <span class="kw">let </span>date = doc |
| .get_first(date) |
| .and_then(|d| d.as_date()) |
| .ok_or_else(|| <span class="macro">anyhow!</span>(<span class="string">"failed to get date"</span>))<span class="question-mark">?</span>; |
| <span class="kw">let </span>ip = doc |
| .get_first(ip) |
| .and_then(|i| i.as_ip_addr()) |
| .ok_or_else(|| <span class="macro">anyhow!</span>(<span class="string">"failed to get ip"</span>))<span class="question-mark">?</span>; |
| <span class="kw">let </span>user = doc |
| .get_first(user) |
| .and_then(|u| u.as_text()) |
| .ok_or_else(|| <span class="macro">anyhow!</span>(<span class="string">"failed to get user"</span>))<span class="question-mark">?</span>; |
| <span class="kw">let </span>message = doc |
| .get_first(message) |
| .and_then(|m| m.as_text()) |
| .ok_or_else(|| <span class="macro">anyhow!</span>(<span class="string">"failed to get message"</span>))<span class="question-mark">?</span>; |
| <span class="kw">let </span>result = doc |
| .get_first(result) |
| .and_then(|r| r.as_bool()) |
| .ok_or_else(|| <span class="macro">anyhow!</span>(<span class="string">"failed to get result"</span>))<span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>microsecond = date.into_timestamp_micros(); |
| |
| <span class="kw">let </span>entry = EntryBuilder::new() |
| .microsecond(microsecond) |
| .ip(ip) |
| .user(user.to_owned()) |
| .message(message.to_owned()) |
| .result(result) |
| .build(); |
| |
| <span class="prelude-val">Ok</span>(entry) |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>convert_to_doc(entry: Entry) -> Document { |
| <span class="kw">let </span>schema = <span class="self">Self</span>::log_schema(); |
| <span class="kw">let </span>date = schema.get_field(<span class="string">"date"</span>).unwrap(); |
| <span class="kw">let </span>ip = schema.get_field(<span class="string">"ip"</span>).unwrap(); |
| <span class="kw">let </span>user = schema.get_field(<span class="string">"user"</span>).unwrap(); |
| <span class="kw">let </span>message = schema.get_field(<span class="string">"message"</span>).unwrap(); |
| <span class="kw">let </span>result = schema.get_field(<span class="string">"result"</span>).unwrap(); |
| |
| <span class="kw">let </span>date_v = DateTime::from_timestamp_micros(entry.datetime().timestamp_micros()); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>doc = Document::default(); |
| doc.add_date(date, date_v); |
| doc.add_ip_addr(ip, entry.ip()); |
| doc.add_text(user, <span class="kw-2">&</span>entry.user()); |
| doc.add_text(message, <span class="kw-2">&</span>entry.message()); |
| doc.add_bool(result, entry.result()); |
| |
| doc |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>log_schema() -> Schema { |
| <span class="kw">let </span><span class="kw-2">mut </span>builder = Schema::builder(); |
| builder.add_date_field(<span class="string">"date"</span>, INDEXED | FAST | STORED); |
| builder.add_ip_addr_field(<span class="string">"ip"</span>, INDEXED | STORED); |
| builder.add_text_field(<span class="string">"user"</span>, TEXT | STORED); |
| builder.add_text_field(<span class="string">"message"</span>, TEXT | STORED); |
| builder.add_bool_field(<span class="string">"result"</span>, INDEXED | STORED); |
| |
| builder.build() |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="teaclave_management_service_enclave" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
