kanidm/docs/v1.0.0rc9/rustdoc/src/orca/setup.rs.html
2022-10-07 09:23:12 +00:00

292 lines
20 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `orca/src/setup.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>setup.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" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" 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="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../orca/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../orca/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../orca/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><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"><button type="button">?</button></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></div><section id="main-content" 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>
<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>
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident">std::fs::File</span>;
<span class="kw">use</span> <span class="ident">std::io</span>::{<span class="ident">BufReader</span>, <span class="ident">Read</span>};
<span class="kw">use</span> <span class="ident">std::path</span>::{<span class="ident">Path</span>, <span class="ident">PathBuf</span>};
<span class="kw">use</span> <span class="ident">uuid::Uuid</span>;
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::data::TestData</span>;
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::ds::DirectoryServer</span>;
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::kani</span>::{<span class="ident">KaniHttpServer</span>, <span class="ident">KaniLdapServer</span>};
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::profile::Profile</span>;
<span class="kw">use</span> <span class="kw">crate</span>::{<span class="ident">TargetOpt</span>, <span class="ident">TargetServer</span>};
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">config</span>(
<span class="ident">target</span>: <span class="kw-2">&amp;</span><span class="ident">TargetOpt</span>,
<span class="ident">profile_path</span>: <span class="kw-2">&amp;</span><span class="ident">Path</span>,
) -&gt; <span class="prelude-ty">Result</span><span class="op">&lt;</span>(<span class="ident">TestData</span>, <span class="ident">Profile</span>, <span class="ident">TargetServer</span>), ()<span class="op">&gt;</span> {
<span class="comment">// read the profile that we are going to be using/testing</span>
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">f</span> <span class="op">=</span> <span class="ident">File::open</span>(<span class="ident">profile_path</span>).<span class="ident">map_err</span>(<span class="op">|</span><span class="ident">e</span><span class="op">|</span> {
<span class="macro">error!</span>(<span class="string">&quot;Unable to open profile file [{:?}] 🥺&quot;</span>, <span class="ident">e</span>);
})<span class="question-mark">?</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">contents</span> <span class="op">=</span> <span class="ident">String::new</span>();
<span class="ident">f</span>.<span class="ident">read_to_string</span>(<span class="kw-2">&amp;mut</span> <span class="ident">contents</span>)
.<span class="ident">map_err</span>(<span class="op">|</span><span class="ident">e</span><span class="op">|</span> <span class="macro">error!</span>(<span class="string">&quot;unable to read profile contents {:?}&quot;</span>, <span class="ident">e</span>))<span class="question-mark">?</span>;
<span class="kw">let</span> <span class="ident">profile</span>: <span class="ident">Profile</span> <span class="op">=</span> <span class="ident">toml::from_str</span>(<span class="ident">contents</span>.<span class="ident">as_str</span>())
.<span class="ident">map_err</span>(<span class="op">|</span><span class="ident">e</span><span class="op">|</span> <span class="macro">eprintln!</span>(<span class="string">&quot;unable to parse config {:?}&quot;</span>, <span class="ident">e</span>))<span class="question-mark">?</span>;
<span class="macro">debug!</span>(<span class="string">&quot;Profile -&gt; {:?}&quot;</span>, <span class="ident">profile</span>);
<span class="comment">// Where is our datafile?</span>
<span class="kw">let</span> <span class="ident">data_path</span> <span class="op">=</span> <span class="kw">if</span> <span class="ident">Path::new</span>(<span class="kw-2">&amp;</span><span class="ident">profile</span>.<span class="ident">data</span>).<span class="ident">is_absolute</span>() {
<span class="ident">PathBuf::from</span>(<span class="kw-2">&amp;</span><span class="ident">profile</span>.<span class="ident">data</span>)
} <span class="kw">else</span> <span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">p</span>) <span class="op">=</span> <span class="ident">profile_path</span>.<span class="ident">parent</span>() {
<span class="ident">p</span>.<span class="ident">join</span>(<span class="kw-2">&amp;</span><span class="ident">profile</span>.<span class="ident">data</span>)
} <span class="kw">else</span> {
<span class="macro">error!</span>(
<span class="string">&quot;Unable to find parent directory of {}&quot;</span>,
<span class="ident">profile_path</span>.<span class="ident">to_str</span>().<span class="ident">unwrap</span>()
);
<span class="kw">return</span> <span class="prelude-val">Err</span>(());
};
<span class="macro">debug!</span>(<span class="string">&quot;Data Path -&gt; {}&quot;</span>, <span class="ident">data_path</span>.<span class="ident">to_str</span>().<span class="ident">unwrap</span>());
<span class="comment">// Does our target section exist?</span>
<span class="kw">let</span> <span class="ident">server</span>: <span class="ident">TargetServer</span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">target</span> {
<span class="ident">TargetOpt::Ds</span> =&gt; {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">dsconfig</span>) <span class="op">=</span> <span class="ident">profile</span>.<span class="ident">ds_config</span>.<span class="ident">as_ref</span>() {
<span class="ident">DirectoryServer::new</span>(<span class="ident">dsconfig</span>)<span class="question-mark">?</span>
} <span class="kw">else</span> {
<span class="macro">error!</span>(<span class="string">&quot;To use ds, you must have the ds_config section in your profile&quot;</span>);
<span class="kw">return</span> <span class="prelude-val">Err</span>(());
}
}
<span class="ident">TargetOpt::KanidmLdap</span> =&gt; {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">klconfig</span>) <span class="op">=</span> <span class="ident">profile</span>.<span class="ident">kani_ldap_config</span>.<span class="ident">as_ref</span>() {
<span class="ident">KaniLdapServer::new</span>(<span class="ident">klconfig</span>)<span class="question-mark">?</span>
} <span class="kw">else</span> {
<span class="macro">error!</span>(<span class="string">&quot;To use kanidm_ldap, you must have the kani_ldap_config section in your profile&quot;</span>);
<span class="kw">return</span> <span class="prelude-val">Err</span>(());
}
}
<span class="ident">TargetOpt::Kanidm</span> =&gt; {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">khconfig</span>) <span class="op">=</span> <span class="ident">profile</span>.<span class="ident">kani_http_config</span>.<span class="ident">as_ref</span>() {
<span class="ident">KaniHttpServer::new</span>(<span class="ident">khconfig</span>)<span class="question-mark">?</span>
} <span class="kw">else</span> {
<span class="macro">error!</span>(<span class="string">&quot;To use kanidm, you must have the kani_http_config section in your profile&quot;</span>);
<span class="kw">return</span> <span class="prelude-val">Err</span>(());
}
}
};
<span class="macro">debug!</span>(<span class="string">&quot;Target server info -&gt; {}&quot;</span>, <span class="ident">server</span>.<span class="ident">info</span>());
<span class="comment">// load the related data (if any) or generate it if that is what we have.</span>
<span class="kw">let</span> <span class="ident">data_file</span> <span class="op">=</span> <span class="ident">File::open</span>(<span class="ident">data_path</span>).<span class="ident">map_err</span>(<span class="op">|</span><span class="ident">e</span><span class="op">|</span> {
<span class="macro">error!</span>(<span class="string">&quot;Unable to open data file [{:?}] 🥺&quot;</span>, <span class="ident">e</span>);
})<span class="question-mark">?</span>;
<span class="kw">let</span> <span class="ident">data_reader</span> <span class="op">=</span> <span class="ident">BufReader::new</span>(<span class="ident">data_file</span>);
<span class="kw">let</span> <span class="ident">data</span>: <span class="ident">TestData</span> <span class="op">=</span> <span class="ident">serde_json::from_reader</span>(<span class="ident">data_reader</span>).<span class="ident">map_err</span>(<span class="op">|</span><span class="ident">e</span><span class="op">|</span> {
<span class="macro">error!</span>(
<span class="string">&quot;Unable to process data file. You may need to preprocess it again: {:?}&quot;</span>,
<span class="ident">e</span>
);
})<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>((<span class="ident">data</span>, <span class="ident">profile</span>, <span class="ident">server</span>))
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">async</span> <span class="kw">fn</span> <span class="ident">doit</span>(<span class="ident">target</span>: <span class="kw-2">&amp;</span><span class="ident">TargetOpt</span>, <span class="ident">profile_path</span>: <span class="kw-2">&amp;</span><span class="ident">Path</span>) -&gt; <span class="prelude-ty">Result</span><span class="op">&lt;</span>(), ()<span class="op">&gt;</span> {
<span class="macro">info!</span>(
<span class="string">&quot;Performing setup of {:?} from {}&quot;</span>,
<span class="ident">target</span>,
<span class="ident">profile_path</span>.<span class="ident">to_str</span>().<span class="ident">unwrap</span>(),
);
<span class="kw">let</span> (<span class="ident">data</span>, <span class="ident">_profile</span>, <span class="ident">server</span>) <span class="op">=</span> <span class="ident">config</span>(<span class="ident">target</span>, <span class="ident">profile_path</span>)<span class="question-mark">?</span>;
<span class="comment">// ensure that things we will &quot;add&quot; won&#39;t be there.</span>
<span class="comment">// delete anything that is modded, so that it will be reset.</span>
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">remove</span>: <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">Uuid</span><span class="op">&gt;</span> <span class="op">=</span> <span class="ident">data</span>
.<span class="ident">connections</span>
.<span class="ident">iter</span>()
.<span class="ident">flat_map</span>(<span class="op">|</span><span class="ident">conn</span><span class="op">|</span> <span class="ident">conn</span>.<span class="ident">ops</span>.<span class="ident">iter</span>())
.<span class="ident">filter_map</span>(<span class="op">|</span><span class="ident">op</span><span class="op">|</span> <span class="ident">op</span>.<span class="ident">require_reset</span>())
.<span class="ident">flatten</span>()
<span class="comment">/*
// Do we need to recreate all groups? If they were modded, we already reset them ...
.chain(
Box::new(
data.precreate.iter().filter(|e| e.is_group()).map(|e| e.get_uuid()) )
)
*/</span>
.<span class="ident">collect</span>();
<span class="ident">remove</span>.<span class="ident">sort_unstable</span>();
<span class="ident">remove</span>.<span class="ident">dedup</span>();
<span class="macro">debug!</span>(<span class="string">&quot;Will remove IDS -&gt; {:?}&quot;</span>, <span class="ident">remove</span>);
<span class="ident">server</span>.<span class="ident">open_admin_connection</span>().<span class="kw">await</span><span class="question-mark">?</span>;
<span class="comment">// Delete everything that needs to be removed.</span>
<span class="ident">server</span>.<span class="ident">setup_admin_delete_uuids</span>(<span class="ident">remove</span>.<span class="ident">as_slice</span>()).<span class="kw">await</span><span class="question-mark">?</span>;
<span class="comment">// ensure that all items we need to precreate are!</span>
<span class="ident">server</span>
.<span class="ident">setup_admin_precreate_entities</span>(<span class="kw-2">&amp;</span><span class="ident">data</span>.<span class="ident">precreate</span>, <span class="kw-2">&amp;</span><span class="ident">data</span>.<span class="ident">all_entities</span>)
.<span class="kw">await</span><span class="question-mark">?</span>;
<span class="comment">// Setup access controls - if something modifies something that IS NOT</span>
<span class="comment">// itself, we grant them extra privs.</span>
<span class="ident">server</span>
.<span class="ident">setup_access_controls</span>(<span class="kw-2">&amp;</span><span class="ident">data</span>.<span class="ident">access</span>, <span class="kw-2">&amp;</span><span class="ident">data</span>.<span class="ident">all_entities</span>)
.<span class="kw">await</span><span class="question-mark">?</span>;
<span class="comment">// Done!</span>
<span class="prelude-val">Ok</span>(())
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="orca" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>