<!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 to the Rust file `/home/dimitris/.cargo/registry/src/github.com-1ecc6299db9ec823/secstr-0.2.1/src/lib.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>lib.rs.html -- source</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">
</head>
<body class="rustdoc">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content source"><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>
<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>
</pre><pre class='rust '>
<span class='doccomment'>//! A data type suitable for storing sensitive information such as passwords and private keys in memory, featuring constant time equality, mlock and zeroing out.</span>
<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>libc</span>;
<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>feature</span> <span class='op'>=</span> <span class='string'>"cbor-serialize"</span>)]</span> <span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>cbor</span>;
<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>feature</span> <span class='op'>=</span> <span class='string'>"cbor-serialize"</span>)]</span> <span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>rustc_serialize</span>;
<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>feature</span> <span class='op'>=</span> <span class='string'>"libsodium-sys"</span>)]</span> <span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>libsodium_sys</span> <span class='kw'>as</span> <span class='ident'>sodium</span>;
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>fmt</span>;
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>borrow</span>::<span class='ident'>Borrow</span>;
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>borrow</span>::<span class='ident'>BorrowMut</span>;
<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>feature</span> <span class='op'>=</span> <span class='string'>"cbor-serialize"</span>)]</span> <span class='kw'>use</span> <span class='ident'>rustc_serialize</span>::{<span class='ident'>Decoder</span>, <span class='ident'>Encoder</span>, <span class='ident'>Decodable</span>, <span class='ident'>Encodable</span>};
<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>feature</span> <span class='op'>=</span> <span class='string'>"libsodium-sys"</span>)]</span>
<span class='kw'>unsafe</span> <span class='kw'>fn</span> <span class='ident'>memzero</span>(<span class='ident'>pnt</span>: <span class='kw-2'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>, <span class='ident'>len</span>: <span class='ident'>libc</span>::<span class='ident'>size_t</span>) {
<span class='ident'>sodium</span>::<span class='ident'>sodium_memzero</span>(<span class='ident'>pnt</span>, <span class='ident'>len</span>);
}
<span class='attribute'>#[<span class='ident'>inline</span>(<span class='ident'>never</span>)]</span>
<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>not</span>(<span class='ident'>feature</span> <span class='op'>=</span> <span class='string'>"libsodium-sys"</span>))]</span>
<span class='kw'>unsafe</span> <span class='kw'>fn</span> <span class='ident'>memzero</span>(<span class='ident'>pnt</span>: <span class='kw-2'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>, <span class='ident'>len</span>: <span class='ident'>libc</span>::<span class='ident'>size_t</span>) {
<span class='ident'>std</span>::<span class='ident'>ptr</span>::<span class='ident'>write_bytes</span>(<span class='ident'>pnt</span> <span class='kw'>as</span> <span class='kw-2'>*</span><span class='kw-2'>mut</span> <span class='ident'>libc</span>::<span class='ident'>c_void</span>, <span class='number'>0</span>, <span class='ident'>len</span>);
}
<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>feature</span> <span class='op'>=</span> <span class='string'>"libsodium-sys"</span>)]</span>
<span class='kw'>fn</span> <span class='ident'>memcmp</span>(<span class='ident'>us</span>: <span class='kw-2'>&</span>[<span class='ident'>u8</span>], <span class='ident'>them</span>: <span class='kw-2'>&</span>[<span class='ident'>u8</span>]) <span class='op'>-></span> <span class='ident'>bool</span> {
<span class='kw'>if</span> <span class='ident'>us</span>.<span class='ident'>len</span>() <span class='op'>!=</span> <span class='ident'>them</span>.<span class='ident'>len</span>() {
<span class='kw'>return</span> <span class='bool-val'>false</span>;
}
<span class='kw'>unsafe</span> {
<span class='ident'>sodium</span>::<span class='ident'>sodium_memcmp</span>(<span class='ident'>us</span>.<span class='ident'>as_ptr</span>(), <span class='ident'>them</span>.<span class='ident'>as_ptr</span>(), <span class='ident'>them</span>.<span class='ident'>len</span>()) <span class='op'>==</span> <span class='number'>0</span>
}
}
<span class='attribute'>#[<span class='ident'>inline</span>(<span class='ident'>never</span>)]</span>
<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>not</span>(<span class='ident'>feature</span> <span class='op'>=</span> <span class='string'>"libsodium-sys"</span>))]</span>
<span class='kw'>fn</span> <span class='ident'>memcmp</span>(<span class='ident'>us</span>: <span class='kw-2'>&</span>[<span class='ident'>u8</span>], <span class='ident'>them</span>: <span class='kw-2'>&</span>[<span class='ident'>u8</span>]) <span class='op'>-></span> <span class='ident'>bool</span> {
<span class='kw'>if</span> <span class='ident'>us</span>.<span class='ident'>len</span>() <span class='op'>!=</span> <span class='ident'>them</span>.<span class='ident'>len</span>() {
<span class='kw'>return</span> <span class='bool-val'>false</span>;
}
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>result</span> <span class='op'>=</span> <span class='number'>0</span>;
<span class='kw'>for</span> <span class='ident'>i</span> <span class='kw'>in</span> <span class='number'>0</span>..<span class='ident'>us</span>.<span class='ident'>len</span>() {
<span class='ident'>result</span> <span class='op'>|=</span> <span class='ident'>us</span>[<span class='ident'>i</span>] <span class='op'>^</span> <span class='ident'>them</span>[<span class='ident'>i</span>];
}
<span class='ident'>result</span> <span class='op'>==</span> <span class='number'>0</span>
}
<span class='doccomment'>/// A data type suitable for storing sensitive information such as passwords and private keys in memory, that implements: </span>
<span class='doccomment'>/// </span>
<span class='doccomment'>/// - Automatic zeroing in `Drop` </span>
<span class='doccomment'>/// - Constant time comparison in `PartialEq` (does not short circuit on the first different character; but terminates instantly if strings have different length) </span>
<span class='doccomment'>/// - Outputting `***SECRET***` to prevent leaking secrets into logs in `fmt::Debug` and `fmt::Display` </span>
<span class='doccomment'>/// - Automatic `mlock` to protect against leaking into swap </span>
<span class='doccomment'>/// </span>
<span class='doccomment'>/// Be careful with `SecStr::from`: if you have a borrowed string, it will be copied. </span>
<span class='doccomment'>/// Use `SecStr::new` if you have a `Vec<u8>`.</span>
<span class='attribute'>#[<span class='ident'>derive</span>(<span class='ident'>Clone</span>)]</span>
<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>SecStr</span> {
<span class='ident'>content</span>: <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>u8</span><span class='op'>></span>
}
<span class='kw'>impl</span> <span class='ident'>SecStr</span> {
<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>new</span>(<span class='ident'>cont</span>: <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>u8</span><span class='op'>></span>) <span class='op'>-></span> <span class='ident'>SecStr</span> {
<span class='ident'>memlock</span>::<span class='ident'>mlock</span>(<span class='kw-2'>&</span><span class='ident'>cont</span>);
<span class='ident'>SecStr</span> { <span class='ident'>content</span>: <span class='ident'>cont</span> }
}
<span class='doccomment'>/// Borrow the contents of the string.</span>
<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>unsecure</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='kw-2'>&</span>[<span class='ident'>u8</span>] {
<span class='self'>self</span>.<span class='ident'>borrow</span>()
}
<span class='doccomment'>/// Mutably borrow the contents of the string.</span>
<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>unsecure_mut</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>) <span class='op'>-></span> <span class='kw-2'>&</span><span class='kw-2'>mut</span> [<span class='ident'>u8</span>] {
<span class='self'>self</span>.<span class='ident'>borrow_mut</span>()
}
<span class='doccomment'>/// Overwrite the string with zeros. This is automatically called in the destructor.</span>
<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>zero_out</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>) {
<span class='kw'>unsafe</span> {
<span class='ident'>memzero</span>(<span class='self'>self</span>.<span class='ident'>content</span>.<span class='ident'>as_ptr</span>() <span class='kw'>as</span> <span class='kw-2'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>, <span class='self'>self</span>.<span class='ident'>content</span>.<span class='ident'>len</span>());
}
}
}
<span class='comment'>// Creation</span>
<span class='kw'>impl</span><span class='op'><</span><span class='ident'>T</span><span class='op'>></span> <span class='ident'>From</span><span class='op'><</span><span class='ident'>T</span><span class='op'>></span> <span class='kw'>for</span> <span class='ident'>SecStr</span> <span class='kw'>where</span> <span class='ident'>T</span>: <span class='ident'>Into</span><span class='op'><</span><span class='ident'>Vec</span><span class='op'><</span><span class='ident'>u8</span><span class='op'>>></span> {
<span class='kw'>fn</span> <span class='ident'>from</span>(<span class='ident'>s</span>: <span class='ident'>T</span>) <span class='op'>-></span> <span class='ident'>SecStr</span> {
<span class='ident'>SecStr</span>::<span class='ident'>new</span>(<span class='ident'>s</span>.<span class='ident'>into</span>())
}
}
<span class='comment'>// Borrowing</span>
<span class='kw'>impl</span> <span class='ident'>Borrow</span><span class='op'><</span>[<span class='ident'>u8</span>]<span class='op'>></span> <span class='kw'>for</span> <span class='ident'>SecStr</span> {
<span class='kw'>fn</span> <span class='ident'>borrow</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='kw-2'>&</span>[<span class='ident'>u8</span>] {
<span class='self'>self</span>.<span class='ident'>content</span>.<span class='ident'>borrow</span>()
}
}
<span class='kw'>impl</span> <span class='ident'>BorrowMut</span><span class='op'><</span>[<span class='ident'>u8</span>]<span class='op'>></span> <span class='kw'>for</span> <span class='ident'>SecStr</span> {
<span class='kw'>fn</span> <span class='ident'>borrow_mut</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>) <span class='op'>-></span> <span class='kw-2'>&</span><span class='kw-2'>mut</span> [<span class='ident'>u8</span>] {
<span class='self'>self</span>.<span class='ident'>content</span>.<span class='ident'>borrow_mut</span>()
}
}
<span class='comment'>// Overwrite memory with zeros when we're done</span>
<span class='kw'>impl</span> <span class='ident'>Drop</span> <span class='kw'>for</span> <span class='ident'>SecStr</span> {
<span class='kw'>fn</span> <span class='ident'>drop</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>) {
<span class='self'>self</span>.<span class='ident'>zero_out</span>();
<span class='ident'>memlock</span>::<span class='ident'>munlock</span>(<span class='kw-2'>&</span><span class='self'>self</span>.<span class='ident'>content</span>);
}
}
<span class='comment'>// Constant time comparison</span>
<span class='kw'>impl</span> <span class='ident'>PartialEq</span> <span class='kw'>for</span> <span class='ident'>SecStr</span> {
<span class='kw'>fn</span> <span class='ident'>eq</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>other</span>: <span class='kw-2'>&</span><span class='ident'>SecStr</span>) <span class='op'>-></span> <span class='ident'>bool</span> {
<span class='ident'>memcmp</span>(<span class='kw-2'>&</span><span class='self'>self</span>.<span class='ident'>content</span>, <span class='kw-2'>&</span><span class='ident'>other</span>.<span class='ident'>content</span>)
}
}
<span class='comment'>// Make sure sensitive information is not logged accidentally</span>
<span class='kw'>impl</span> <span class='ident'>fmt</span>::<span class='ident'>Debug</span> <span class='kw'>for</span> <span class='ident'>SecStr</span> {
<span class='kw'>fn</span> <span class='ident'>fmt</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>f</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>fmt</span>::<span class='ident'>Formatter</span>) <span class='op'>-></span> <span class='ident'>fmt</span>::<span class='prelude-ty'>Result</span> {
<span class='ident'>f</span>.<span class='ident'>write_str</span>(<span class='string'>"***SECRET***"</span>).<span class='ident'>map_err</span>(<span class='op'>|</span>_<span class='op'>|</span> { <span class='ident'>fmt</span>::<span class='ident'>Error</span> })
}
}
<span class='kw'>impl</span> <span class='ident'>fmt</span>::<span class='ident'>Display</span> <span class='kw'>for</span> <span class='ident'>SecStr</span> {
<span class='kw'>fn</span> <span class='ident'>fmt</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>f</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>fmt</span>::<span class='ident'>Formatter</span>) <span class='op'>-></span> <span class='ident'>fmt</span>::<span class='prelude-ty'>Result</span> {
<span class='ident'>f</span>.<span class='ident'>write_str</span>(<span class='string'>"***SECRET***"</span>).<span class='ident'>map_err</span>(<span class='op'>|</span>_<span class='op'>|</span> { <span class='ident'>fmt</span>::<span class='ident'>Error</span> })
}
}
<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>feature</span> <span class='op'>=</span> <span class='string'>"cbor-serialize"</span>)]</span>
<span class='kw'>impl</span> <span class='ident'>Decodable</span> <span class='kw'>for</span> <span class='ident'>SecStr</span> {
<span class='kw'>fn</span> <span class='ident'>decode</span><span class='op'><</span><span class='ident'>D</span>: <span class='ident'>Decoder</span><span class='op'>></span>(<span class='ident'>d</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>D</span>) <span class='op'>-></span> <span class='prelude-ty'>Result</span><span class='op'><</span><span class='ident'>SecStr</span>, <span class='ident'>D</span>::<span class='ident'>Error</span><span class='op'>></span> {
<span class='kw'>let</span> <span class='ident'>cbor</span>::<span class='ident'>CborBytes</span>(<span class='ident'>content</span>) <span class='op'>=</span> <span class='macro'>try</span><span class='macro'>!</span>(<span class='ident'>cbor</span>::<span class='ident'>CborBytes</span>::<span class='ident'>decode</span>(<span class='ident'>d</span>));
<span class='prelude-val'>Ok</span>(<span class='ident'>SecStr</span>::<span class='ident'>new</span>(<span class='ident'>content</span>))
}
}
<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>feature</span> <span class='op'>=</span> <span class='string'>"cbor-serialize"</span>)]</span>
<span class='kw'>impl</span> <span class='ident'>Encodable</span> <span class='kw'>for</span> <span class='ident'>SecStr</span> {
<span class='kw'>fn</span> <span class='ident'>encode</span><span class='op'><</span><span class='ident'>E</span>: <span class='ident'>Encoder</span><span class='op'>></span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>e</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>E</span>) <span class='op'>-></span> <span class='prelude-ty'>Result</span><span class='op'><</span>(), <span class='ident'>E</span>::<span class='ident'>Error</span><span class='op'>></span> {
<span class='ident'>cbor</span>::<span class='ident'>CborBytes</span>(<span class='self'>self</span>.<span class='ident'>content</span>.<span class='ident'>clone</span>()).<span class='ident'>encode</span>(<span class='ident'>e</span>)
}
}
<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>unix</span>)]</span>
<span class='kw'>mod</span> <span class='ident'>memlock</span> {
<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>libc</span>;
<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>mlock</span>(<span class='ident'>cont</span>: <span class='kw-2'>&</span><span class='ident'>Vec</span><span class='op'><</span><span class='ident'>u8</span><span class='op'>></span>) {
<span class='kw'>unsafe</span> {
<span class='ident'>libc</span>::<span class='ident'>mlock</span>(<span class='ident'>cont</span>.<span class='ident'>as_ptr</span>() <span class='kw'>as</span> <span class='kw-2'>*</span><span class='kw'>const</span> <span class='ident'>libc</span>::<span class='ident'>c_void</span>, <span class='ident'>cont</span>.<span class='ident'>len</span>() <span class='kw'>as</span> <span class='ident'>libc</span>::<span class='ident'>size_t</span>);
}
}
<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>munlock</span>(<span class='ident'>cont</span>: <span class='kw-2'>&</span><span class='ident'>Vec</span><span class='op'><</span><span class='ident'>u8</span><span class='op'>></span>) {
<span class='kw'>unsafe</span> {
<span class='ident'>libc</span>::<span class='ident'>munlock</span>(<span class='ident'>cont</span>.<span class='ident'>as_ptr</span>() <span class='kw'>as</span> <span class='kw-2'>*</span><span class='kw'>const</span> <span class='ident'>libc</span>::<span class='ident'>c_void</span>, <span class='ident'>cont</span>.<span class='ident'>len</span>() <span class='kw'>as</span> <span class='ident'>libc</span>::<span class='ident'>size_t</span>);
}
}
}
<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>not</span>(<span class='ident'>unix</span>))]</span>
<span class='kw'>mod</span> <span class='ident'>memlock</span> {
<span class='kw'>fn</span> <span class='ident'>mlock</span>(<span class='ident'>cont</span>: <span class='kw-2'>&</span><span class='ident'>Vec</span><span class='op'><</span><span class='ident'>u8</span><span class='op'>></span>) {
}
<span class='kw'>fn</span> <span class='ident'>munlock</span>(<span class='ident'>cont</span>: <span class='kw-2'>&</span><span class='ident'>Vec</span><span class='op'><</span><span class='ident'>u8</span><span class='op'>></span>) {
}
}
<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>test</span>)]</span>
<span class='kw'>mod</span> <span class='ident'>tests</span> {
<span class='kw'>use</span> <span class='kw'>super</span>::<span class='ident'>SecStr</span>;
<span class='attribute'>#[<span class='ident'>test</span>]</span>
<span class='kw'>fn</span> <span class='ident'>test_basic</span>() {
<span class='kw'>let</span> <span class='ident'>my_sec</span> <span class='op'>=</span> <span class='ident'>SecStr</span>::<span class='ident'>from</span>(<span class='string'>"hello"</span>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>my_sec</span>, <span class='ident'>SecStr</span>::<span class='ident'>from</span>(<span class='string'>"hello"</span>.<span class='ident'>to_string</span>()));
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>my_sec</span>.<span class='ident'>unsecure</span>(), <span class='string'>b"hello"</span>);
}
<span class='attribute'>#[<span class='ident'>test</span>]</span>
<span class='kw'>fn</span> <span class='ident'>test_zero_out</span>() {
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>my_sec</span> <span class='op'>=</span> <span class='ident'>SecStr</span>::<span class='ident'>from</span>(<span class='string'>"hello"</span>);
<span class='ident'>my_sec</span>.<span class='ident'>zero_out</span>();
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>my_sec</span>.<span class='ident'>unsecure</span>(), <span class='string'>b"\x00\x00\x00\x00\x00"</span>);
}
<span class='attribute'>#[<span class='ident'>test</span>]</span>
<span class='kw'>fn</span> <span class='ident'>test_comparison</span>() {
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>SecStr</span>::<span class='ident'>from</span>(<span class='string'>"hello"</span>), <span class='ident'>SecStr</span>::<span class='ident'>from</span>(<span class='string'>"hello"</span>));
<span class='macro'>assert</span><span class='macro'>!</span>( <span class='ident'>SecStr</span>::<span class='ident'>from</span>(<span class='string'>"hello"</span>) <span class='op'>!=</span> <span class='ident'>SecStr</span>::<span class='ident'>from</span>(<span class='string'>"yolo"</span>));
<span class='macro'>assert</span><span class='macro'>!</span>( <span class='ident'>SecStr</span>::<span class='ident'>from</span>(<span class='string'>"hello"</span>) <span class='op'>!=</span> <span class='ident'>SecStr</span>::<span class='ident'>from</span>(<span class='string'>"olleh"</span>));
<span class='macro'>assert</span><span class='macro'>!</span>( <span class='ident'>SecStr</span>::<span class='ident'>from</span>(<span class='string'>"hello"</span>) <span class='op'>!=</span> <span class='ident'>SecStr</span>::<span class='ident'>from</span>(<span class='string'>"helloworld"</span>));
<span class='macro'>assert</span><span class='macro'>!</span>( <span class='ident'>SecStr</span>::<span class='ident'>from</span>(<span class='string'>"hello"</span>) <span class='op'>!=</span> <span class='ident'>SecStr</span>::<span class='ident'>from</span>(<span class='string'>""</span>));
}
<span class='attribute'>#[<span class='ident'>test</span>]</span>
<span class='kw'>fn</span> <span class='ident'>test_show</span>() {
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='macro'>format</span><span class='macro'>!</span>(<span class='string'>"{}"</span>, <span class='ident'>SecStr</span>::<span class='ident'>from</span>(<span class='string'>"hello"</span>)), <span class='string'>"***SECRET***"</span>.<span class='ident'>to_string</span>());
}
}
</pre>
</section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "secstr";
</script>
<script src="../../jquery.js"></script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>