<!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 `actix-cors/src/builder.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>builder.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="icon" href="https://actix.rs/favicon.ico"></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">☰</button><a class="sidebar-logo" href="../../actix_cors/index.html"><div class="logo-container"><img src="https://actix.rs/img/logo.png" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../actix_cors/index.html"><div class="logo-container"> <img src="https://actix.rs/img/logo.png" alt="logo"></div></a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../actix_cors/index.html"> <img src="https://actix.rs/img/logo.png" 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> <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> <span id="206">206</span> <span id="207">207</span> <span id="208">208</span> <span id="209">209</span> <span id="210">210</span> <span id="211">211</span> <span id="212">212</span> <span id="213">213</span> <span id="214">214</span> <span id="215">215</span> <span id="216">216</span> <span id="217">217</span> <span id="218">218</span> <span id="219">219</span> <span id="220">220</span> <span id="221">221</span> <span id="222">222</span> <span id="223">223</span> <span id="224">224</span> <span id="225">225</span> <span id="226">226</span> <span id="227">227</span> <span id="228">228</span> <span id="229">229</span> <span id="230">230</span> <span id="231">231</span> <span id="232">232</span> <span id="233">233</span> <span id="234">234</span> <span id="235">235</span> <span id="236">236</span> <span id="237">237</span> <span id="238">238</span> <span id="239">239</span> <span id="240">240</span> <span id="241">241</span> <span id="242">242</span> <span id="243">243</span> <span id="244">244</span> <span id="245">245</span> <span id="246">246</span> <span id="247">247</span> <span id="248">248</span> <span id="249">249</span> <span id="250">250</span> <span id="251">251</span> <span id="252">252</span> <span id="253">253</span> <span id="254">254</span> <span id="255">255</span> <span id="256">256</span> <span id="257">257</span> <span id="258">258</span> <span id="259">259</span> <span id="260">260</span> <span id="261">261</span> <span id="262">262</span> <span id="263">263</span> <span id="264">264</span> <span id="265">265</span> <span id="266">266</span> <span id="267">267</span> <span id="268">268</span> <span id="269">269</span> <span id="270">270</span> <span id="271">271</span> <span id="272">272</span> <span id="273">273</span> <span id="274">274</span> <span id="275">275</span> <span id="276">276</span> <span id="277">277</span> <span id="278">278</span> <span id="279">279</span> <span id="280">280</span> <span id="281">281</span> <span id="282">282</span> <span id="283">283</span> <span id="284">284</span> <span id="285">285</span> <span id="286">286</span> <span id="287">287</span> <span id="288">288</span> <span id="289">289</span> <span id="290">290</span> <span id="291">291</span> <span id="292">292</span> <span id="293">293</span> <span id="294">294</span> <span id="295">295</span> <span id="296">296</span> <span id="297">297</span> <span id="298">298</span> <span id="299">299</span> <span id="300">300</span> <span id="301">301</span> <span id="302">302</span> <span id="303">303</span> <span id="304">304</span> <span id="305">305</span> <span id="306">306</span> <span id="307">307</span> <span id="308">308</span> <span id="309">309</span> <span id="310">310</span> <span id="311">311</span> <span id="312">312</span> <span id="313">313</span> <span id="314">314</span> <span id="315">315</span> <span id="316">316</span> <span id="317">317</span> <span id="318">318</span> <span id="319">319</span> <span id="320">320</span> <span id="321">321</span> <span id="322">322</span> <span id="323">323</span> <span id="324">324</span> <span id="325">325</span> <span id="326">326</span> <span id="327">327</span> <span id="328">328</span> <span id="329">329</span> <span id="330">330</span> <span id="331">331</span> <span id="332">332</span> <span id="333">333</span> <span id="334">334</span> <span id="335">335</span> <span id="336">336</span> <span id="337">337</span> <span id="338">338</span> <span id="339">339</span> <span id="340">340</span> <span id="341">341</span> <span id="342">342</span> <span id="343">343</span> <span id="344">344</span> <span id="345">345</span> <span id="346">346</span> <span id="347">347</span> <span id="348">348</span> <span id="349">349</span> <span id="350">350</span> <span id="351">351</span> <span id="352">352</span> <span id="353">353</span> <span id="354">354</span> <span id="355">355</span> <span id="356">356</span> <span id="357">357</span> <span id="358">358</span> <span id="359">359</span> <span id="360">360</span> <span id="361">361</span> <span id="362">362</span> <span id="363">363</span> <span id="364">364</span> <span id="365">365</span> <span id="366">366</span> <span id="367">367</span> <span id="368">368</span> <span id="369">369</span> <span id="370">370</span> <span id="371">371</span> <span id="372">372</span> <span id="373">373</span> <span id="374">374</span> <span id="375">375</span> <span id="376">376</span> <span id="377">377</span> <span id="378">378</span> <span id="379">379</span> <span id="380">380</span> <span id="381">381</span> <span id="382">382</span> <span id="383">383</span> <span id="384">384</span> <span id="385">385</span> <span id="386">386</span> <span id="387">387</span> <span id="388">388</span> <span id="389">389</span> <span id="390">390</span> <span id="391">391</span> <span id="392">392</span> <span id="393">393</span> <span id="394">394</span> <span id="395">395</span> <span id="396">396</span> <span id="397">397</span> <span id="398">398</span> <span id="399">399</span> <span id="400">400</span> <span id="401">401</span> <span id="402">402</span> <span id="403">403</span> <span id="404">404</span> <span id="405">405</span> <span id="406">406</span> <span id="407">407</span> <span id="408">408</span> <span id="409">409</span> <span id="410">410</span> <span id="411">411</span> <span id="412">412</span> <span id="413">413</span> <span id="414">414</span> <span id="415">415</span> <span id="416">416</span> <span id="417">417</span> <span id="418">418</span> <span id="419">419</span> <span id="420">420</span> <span id="421">421</span> <span id="422">422</span> <span id="423">423</span> <span id="424">424</span> <span id="425">425</span> <span id="426">426</span> <span id="427">427</span> <span id="428">428</span> <span id="429">429</span> <span id="430">430</span> <span id="431">431</span> <span id="432">432</span> <span id="433">433</span> <span id="434">434</span> <span id="435">435</span> <span id="436">436</span> <span id="437">437</span> <span id="438">438</span> <span id="439">439</span> <span id="440">440</span> <span id="441">441</span> <span id="442">442</span> <span id="443">443</span> <span id="444">444</span> <span id="445">445</span> <span id="446">446</span> <span id="447">447</span> <span id="448">448</span> <span id="449">449</span> <span id="450">450</span> <span id="451">451</span> <span id="452">452</span> <span id="453">453</span> <span id="454">454</span> <span id="455">455</span> <span id="456">456</span> <span id="457">457</span> <span id="458">458</span> <span id="459">459</span> <span id="460">460</span> <span id="461">461</span> <span id="462">462</span> <span id="463">463</span> <span id="464">464</span> <span id="465">465</span> <span id="466">466</span> <span id="467">467</span> <span id="468">468</span> <span id="469">469</span> <span id="470">470</span> <span id="471">471</span> <span id="472">472</span> <span id="473">473</span> <span id="474">474</span> <span id="475">475</span> <span id="476">476</span> <span id="477">477</span> <span id="478">478</span> <span id="479">479</span> <span id="480">480</span> <span id="481">481</span> <span id="482">482</span> <span id="483">483</span> <span id="484">484</span> <span id="485">485</span> <span id="486">486</span> <span id="487">487</span> <span id="488">488</span> <span id="489">489</span> <span id="490">490</span> <span id="491">491</span> <span id="492">492</span> <span id="493">493</span> <span id="494">494</span> <span id="495">495</span> <span id="496">496</span> <span id="497">497</span> <span id="498">498</span> <span id="499">499</span> <span id="500">500</span> <span id="501">501</span> <span id="502">502</span> <span id="503">503</span> <span id="504">504</span> <span id="505">505</span> <span id="506">506</span> <span id="507">507</span> <span id="508">508</span> <span id="509">509</span> <span id="510">510</span> <span id="511">511</span> <span id="512">512</span> <span id="513">513</span> <span id="514">514</span> <span id="515">515</span> <span id="516">516</span> <span id="517">517</span> <span id="518">518</span> <span id="519">519</span> <span id="520">520</span> <span id="521">521</span> <span id="522">522</span> <span id="523">523</span> <span id="524">524</span> <span id="525">525</span> <span id="526">526</span> <span id="527">527</span> <span id="528">528</span> <span id="529">529</span> <span id="530">530</span> <span id="531">531</span> <span id="532">532</span> <span id="533">533</span> <span id="534">534</span> <span id="535">535</span> <span id="536">536</span> <span id="537">537</span> <span id="538">538</span> <span id="539">539</span> <span id="540">540</span> <span id="541">541</span> <span id="542">542</span> <span id="543">543</span> <span id="544">544</span> <span id="545">545</span> <span id="546">546</span> <span id="547">547</span> <span id="548">548</span> <span id="549">549</span> <span id="550">550</span> <span id="551">551</span> <span id="552">552</span> <span id="553">553</span> <span id="554">554</span> <span id="555">555</span> <span id="556">556</span> <span id="557">557</span> <span id="558">558</span> <span id="559">559</span> <span id="560">560</span> <span id="561">561</span> <span id="562">562</span> <span id="563">563</span> <span id="564">564</span> <span id="565">565</span> <span id="566">566</span> <span id="567">567</span> <span id="568">568</span> <span id="569">569</span> <span id="570">570</span> <span id="571">571</span> <span id="572">572</span> <span id="573">573</span> <span id="574">574</span> <span id="575">575</span> <span id="576">576</span> <span id="577">577</span> <span id="578">578</span> <span id="579">579</span> <span id="580">580</span> <span id="581">581</span> <span id="582">582</span> <span id="583">583</span> <span id="584">584</span> <span id="585">585</span> <span id="586">586</span> <span id="587">587</span> <span id="588">588</span> <span id="589">589</span> <span id="590">590</span> <span id="591">591</span> <span id="592">592</span> <span id="593">593</span> <span id="594">594</span> <span id="595">595</span> <span id="596">596</span> <span id="597">597</span> <span id="598">598</span> <span id="599">599</span> <span id="600">600</span> <span id="601">601</span> <span id="602">602</span> <span id="603">603</span> <span id="604">604</span> <span id="605">605</span> <span id="606">606</span> <span id="607">607</span> <span id="608">608</span> <span id="609">609</span> <span id="610">610</span> <span id="611">611</span> <span id="612">612</span> <span id="613">613</span> <span id="614">614</span> <span id="615">615</span> <span id="616">616</span> <span id="617">617</span> <span id="618">618</span> <span id="619">619</span> <span id="620">620</span> <span id="621">621</span> <span id="622">622</span> <span id="623">623</span> <span id="624">624</span> <span id="625">625</span> <span id="626">626</span> <span id="627">627</span> <span id="628">628</span> <span id="629">629</span> <span id="630">630</span> <span id="631">631</span> <span id="632">632</span> <span id="633">633</span> <span id="634">634</span> <span id="635">635</span> <span id="636">636</span> <span id="637">637</span> <span id="638">638</span> <span id="639">639</span> <span id="640">640</span> <span id="641">641</span> </pre><pre class="rust"><code><span class="kw">use </span>std::{collections::HashSet, convert::TryInto, iter::FromIterator, rc::Rc}; <span class="kw">use </span>actix_utils::future::{<span class="self">self</span>, Ready}; <span class="kw">use </span>actix_web::{ body::{EitherBody, MessageBody}, dev::{RequestHead, Service, ServiceRequest, ServiceResponse, Transform}, error::HttpError, http::{ header::{HeaderName, HeaderValue}, Method, Uri, }, Either, Error, <span class="prelude-ty">Result</span>, }; <span class="kw">use </span>log::error; <span class="kw">use </span>once_cell::sync::Lazy; <span class="kw">use </span>smallvec::smallvec; <span class="kw">use crate</span>::{AllOrSome, CorsError, CorsMiddleware, Inner, OriginFn}; <span class="doccomment">/// Convenience for getting mut refs to inner. Cleaner than `Rc::get_mut`. /// Additionally, always causes first error (if any) to be reported during initialization. </span><span class="kw">fn </span>cors<<span class="lifetime">'a</span>>( inner: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span>Rc<Inner>, err: <span class="kw-2">&</span><span class="prelude-ty">Option</span><Either<HttpError, CorsError>>, ) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span>Inner> { <span class="kw">if </span>err.is_some() { <span class="kw">return </span><span class="prelude-val">None</span>; } Rc::get_mut(inner) } <span class="kw">static </span>ALL_METHODS_SET: Lazy<HashSet<Method>> = Lazy::new(|| { HashSet::from_iter(<span class="macro">vec!</span>[ Method::GET, Method::POST, Method::PUT, Method::DELETE, Method::HEAD, Method::OPTIONS, Method::CONNECT, Method::PATCH, Method::TRACE, ]) }); <span class="doccomment">/// Builder for CORS middleware. /// /// To construct a CORS middleware, call [`Cors::default()`] to create a blank, restrictive builder. /// Then use any of the builder methods to customize CORS behavior. /// /// The alternative [`Cors::permissive()`] constructor is available for local development, allowing /// all origins and headers, etc. **The permissive constructor should not be used in production.** /// /// # Errors /// Errors surface in the middleware initialization phase. This means that, if you have logs enabled /// in Actix Web (using `env_logger` or other crate that exposes logs from the `log` crate), error /// messages will outline what is wrong with the CORS configuration in the server logs and the /// server will fail to start up or serve requests. /// /// # Example /// ``` /// use actix_cors::Cors; /// use actix_web::http::header; /// /// let cors = Cors::default() /// .allowed_origin("https://www.rust-lang.org") /// .allowed_methods(vec!["GET", "POST"]) /// .allowed_headers(vec![header::AUTHORIZATION, header::ACCEPT]) /// .allowed_header(header::CONTENT_TYPE) /// .max_age(3600); /// /// // `cors` can now be used in `App::wrap`. /// ``` </span><span class="attribute">#[derive(Debug)] </span><span class="kw">pub struct </span>Cors { inner: Rc<Inner>, error: <span class="prelude-ty">Option</span><Either<HttpError, CorsError>>, } <span class="kw">impl </span>Cors { <span class="doccomment">/// A very permissive set of default for quick development. Not recommended for production use. /// /// *All* origins, methods, request headers and exposed headers allowed. Credentials supported. /// Max age 1 hour. Does not send wildcard. </span><span class="kw">pub fn </span>permissive() -> <span class="self">Self </span>{ <span class="kw">let </span>inner = Inner { allowed_origins: AllOrSome::All, allowed_origins_fns: <span class="macro">smallvec!</span>[], allowed_methods: ALL_METHODS_SET.clone(), allowed_methods_baked: <span class="prelude-val">None</span>, allowed_headers: AllOrSome::All, allowed_headers_baked: <span class="prelude-val">None</span>, expose_headers: AllOrSome::All, expose_headers_baked: <span class="prelude-val">None</span>, max_age: <span class="prelude-val">Some</span>(<span class="number">3600</span>), preflight: <span class="bool-val">true</span>, send_wildcard: <span class="bool-val">false</span>, supports_credentials: <span class="bool-val">true</span>, vary_header: <span class="bool-val">true</span>, }; Cors { inner: Rc::new(inner), error: <span class="prelude-val">None</span>, } } <span class="doccomment">/// Resets allowed origin list to a state where any origin is accepted. /// /// See [`Cors::allowed_origin`] for more info on allowed origins. </span><span class="kw">pub fn </span>allow_any_origin(<span class="kw-2">mut </span><span class="self">self</span>) -> Cors { <span class="kw">if let </span><span class="prelude-val">Some</span>(cors) = cors(<span class="kw-2">&mut </span><span class="self">self</span>.inner, <span class="kw-2">&</span><span class="self">self</span>.error) { cors.allowed_origins = AllOrSome::All; } <span class="self">self </span>} <span class="doccomment">/// Add an origin that is allowed to make requests. /// /// By default, requests from all origins are accepted by CORS logic. This method allows to /// specify a finite set of origins to verify the value of the `Origin` request header. /// /// These are `origin-or-null` types in the [Fetch Standard]. /// /// When this list is set, the client's `Origin` request header will be checked in a /// case-sensitive manner. /// /// When all origins are allowed and `send_wildcard` is set, `*` will be sent in the /// `Access-Control-Allow-Origin` response header. If `send_wildcard` is not set, the client's /// `Origin` request header will be echoed back in the `Access-Control-Allow-Origin` /// response header. /// /// If the origin of the request doesn't match any allowed origins and at least one /// `allowed_origin_fn` function is set, these functions will be used to determinate /// allowed origins. /// /// # Initialization Errors /// - If supplied origin is not valid uri /// - If supplied origin is a wildcard (`*`). [`Cors::send_wildcard`] should be used instead. /// /// [Fetch Standard]: https://fetch.spec.whatwg.org/#origin-header </span><span class="kw">pub fn </span>allowed_origin(<span class="kw-2">mut </span><span class="self">self</span>, origin: <span class="kw-2">&</span>str) -> Cors { <span class="kw">if let </span><span class="prelude-val">Some</span>(cors) = cors(<span class="kw-2">&mut </span><span class="self">self</span>.inner, <span class="kw-2">&</span><span class="self">self</span>.error) { <span class="kw">match </span>TryInto::<Uri>::try_into(origin) { <span class="prelude-val">Ok</span>(<span class="kw">_</span>) <span class="kw">if </span>origin == <span class="string">"*" </span>=> { <span class="macro">error!</span>(<span class="string">"Wildcard in `allowed_origin` is not allowed. Use `send_wildcard`."</span>); <span class="self">self</span>.error = <span class="prelude-val">Some</span>(Either::Right(CorsError::WildcardOrigin)); } <span class="prelude-val">Ok</span>(<span class="kw">_</span>) => { <span class="kw">if </span>cors.allowed_origins.is_all() { cors.allowed_origins = AllOrSome::Some(HashSet::with_capacity(<span class="number">8</span>)); } <span class="kw">if let </span><span class="prelude-val">Some</span>(origins) = cors.allowed_origins.as_mut() { <span class="comment">// any uri is a valid header value </span><span class="kw">let </span>hv = origin.try_into().unwrap(); origins.insert(hv); } } <span class="prelude-val">Err</span>(err) => { <span class="self">self</span>.error = <span class="prelude-val">Some</span>(Either::Left(err.into())); } } } <span class="self">self </span>} <span class="doccomment">/// Determinate allowed origins by processing requests which didn't match any origins specified /// in the `allowed_origin`. /// /// The function will receive two parameters, the Origin header value, and the `RequestHead` of /// each request, which can be used to determine whether to allow the request or not. /// /// If the function returns `true`, the client's `Origin` request header will be echoed back /// into the `Access-Control-Allow-Origin` response header. </span><span class="kw">pub fn </span>allowed_origin_fn<F>(<span class="kw-2">mut </span><span class="self">self</span>, f: F) -> Cors <span class="kw">where </span>F: (Fn(<span class="kw-2">&</span>HeaderValue, <span class="kw-2">&</span>RequestHead) -> bool) + <span class="lifetime">'static</span>, { <span class="kw">if let </span><span class="prelude-val">Some</span>(cors) = cors(<span class="kw-2">&mut </span><span class="self">self</span>.inner, <span class="kw-2">&</span><span class="self">self</span>.error) { cors.allowed_origins_fns.push(OriginFn { boxed_fn: Rc::new(f), }); } <span class="self">self </span>} <span class="doccomment">/// Resets allowed methods list to all methods. /// /// See [`Cors::allowed_methods`] for more info on allowed methods. </span><span class="kw">pub fn </span>allow_any_method(<span class="kw-2">mut </span><span class="self">self</span>) -> Cors { <span class="kw">if let </span><span class="prelude-val">Some</span>(cors) = cors(<span class="kw-2">&mut </span><span class="self">self</span>.inner, <span class="kw-2">&</span><span class="self">self</span>.error) { cors.allowed_methods = ALL_METHODS_SET.clone(); } <span class="self">self </span>} <span class="doccomment">/// Set a list of methods which allowed origins can perform. /// /// These will be sent in the `Access-Control-Allow-Methods` response header as specified in /// the [Fetch Standard CORS protocol]. /// /// Defaults to `[GET, HEAD, POST, OPTIONS, PUT, PATCH, DELETE]` /// /// [Fetch Standard CORS protocol]: https://fetch.spec.whatwg.org/#http-cors-protocol </span><span class="kw">pub fn </span>allowed_methods<U, M>(<span class="kw-2">mut </span><span class="self">self</span>, methods: U) -> Cors <span class="kw">where </span>U: IntoIterator<Item = M>, M: TryInto<Method>, <M <span class="kw">as </span>TryInto<Method>>::Error: Into<HttpError>, { <span class="kw">if let </span><span class="prelude-val">Some</span>(cors) = cors(<span class="kw-2">&mut </span><span class="self">self</span>.inner, <span class="kw-2">&</span><span class="self">self</span>.error) { <span class="kw">for </span>m <span class="kw">in </span>methods { <span class="kw">match </span>m.try_into() { <span class="prelude-val">Ok</span>(method) => { cors.allowed_methods.insert(method); } <span class="prelude-val">Err</span>(err) => { <span class="self">self</span>.error = <span class="prelude-val">Some</span>(Either::Left(err.into())); <span class="kw">break</span>; } } } } <span class="self">self </span>} <span class="doccomment">/// Resets allowed request header list to a state where any header is accepted. /// /// See [`Cors::allowed_headers`] for more info on allowed request headers. </span><span class="kw">pub fn </span>allow_any_header(<span class="kw-2">mut </span><span class="self">self</span>) -> Cors { <span class="kw">if let </span><span class="prelude-val">Some</span>(cors) = cors(<span class="kw-2">&mut </span><span class="self">self</span>.inner, <span class="kw-2">&</span><span class="self">self</span>.error) { cors.allowed_headers = AllOrSome::All; } <span class="self">self </span>} <span class="doccomment">/// Add an allowed request header. /// /// See [`Cors::allowed_headers`] for more info on allowed request headers. </span><span class="kw">pub fn </span>allowed_header<H>(<span class="kw-2">mut </span><span class="self">self</span>, header: H) -> Cors <span class="kw">where </span>H: TryInto<HeaderName>, <H <span class="kw">as </span>TryInto<HeaderName>>::Error: Into<HttpError>, { <span class="kw">if let </span><span class="prelude-val">Some</span>(cors) = cors(<span class="kw-2">&mut </span><span class="self">self</span>.inner, <span class="kw-2">&</span><span class="self">self</span>.error) { <span class="kw">match </span>header.try_into() { <span class="prelude-val">Ok</span>(method) => { <span class="kw">if </span>cors.allowed_headers.is_all() { cors.allowed_headers = AllOrSome::Some(HashSet::with_capacity(<span class="number">8</span>)); } <span class="kw">if let </span>AllOrSome::Some(<span class="kw-2">ref mut </span>headers) = cors.allowed_headers { headers.insert(method); } } <span class="prelude-val">Err</span>(err) => <span class="self">self</span>.error = <span class="prelude-val">Some</span>(Either::Left(err.into())), } } <span class="self">self </span>} <span class="doccomment">/// Set a list of request header field names which can be used when this resource is accessed by /// allowed origins. /// /// If `All` is set, whatever is requested by the client in `Access-Control-Request-Headers` /// will be echoed back in the `Access-Control-Allow-Headers` header as specified in /// the [Fetch Standard CORS protocol]. /// /// Defaults to `All`. /// /// [Fetch Standard CORS protocol]: https://fetch.spec.whatwg.org/#http-cors-protocol </span><span class="kw">pub fn </span>allowed_headers<U, H>(<span class="kw-2">mut </span><span class="self">self</span>, headers: U) -> Cors <span class="kw">where </span>U: IntoIterator<Item = H>, H: TryInto<HeaderName>, <H <span class="kw">as </span>TryInto<HeaderName>>::Error: Into<HttpError>, { <span class="kw">if let </span><span class="prelude-val">Some</span>(cors) = cors(<span class="kw-2">&mut </span><span class="self">self</span>.inner, <span class="kw-2">&</span><span class="self">self</span>.error) { <span class="kw">for </span>h <span class="kw">in </span>headers { <span class="kw">match </span>h.try_into() { <span class="prelude-val">Ok</span>(method) => { <span class="kw">if </span>cors.allowed_headers.is_all() { cors.allowed_headers = AllOrSome::Some(HashSet::with_capacity(<span class="number">8</span>)); } <span class="kw">if let </span>AllOrSome::Some(<span class="kw-2">ref mut </span>headers) = cors.allowed_headers { headers.insert(method); } } <span class="prelude-val">Err</span>(err) => { <span class="self">self</span>.error = <span class="prelude-val">Some</span>(Either::Left(err.into())); <span class="kw">break</span>; } } } } <span class="self">self </span>} <span class="doccomment">/// Resets exposed response header list to a state where all headers are exposed. /// /// See [`Cors::expose_headers`] for more info on exposed response headers. </span><span class="kw">pub fn </span>expose_any_header(<span class="kw-2">mut </span><span class="self">self</span>) -> Cors { <span class="kw">if let </span><span class="prelude-val">Some</span>(cors) = cors(<span class="kw-2">&mut </span><span class="self">self</span>.inner, <span class="kw-2">&</span><span class="self">self</span>.error) { cors.expose_headers = AllOrSome::All; } <span class="self">self </span>} <span class="doccomment">/// Set a list of headers which are safe to expose to the API of a CORS API specification. /// This corresponds to the `Access-Control-Expose-Headers` response header as specified in /// the [Fetch Standard CORS protocol]. /// /// This defaults to an empty set. /// /// [Fetch Standard CORS protocol]: https://fetch.spec.whatwg.org/#http-cors-protocol </span><span class="kw">pub fn </span>expose_headers<U, H>(<span class="kw-2">mut </span><span class="self">self</span>, headers: U) -> Cors <span class="kw">where </span>U: IntoIterator<Item = H>, H: TryInto<HeaderName>, <H <span class="kw">as </span>TryInto<HeaderName>>::Error: Into<HttpError>, { <span class="kw">for </span>h <span class="kw">in </span>headers { <span class="kw">match </span>h.try_into() { <span class="prelude-val">Ok</span>(header) => { <span class="kw">if let </span><span class="prelude-val">Some</span>(cors) = cors(<span class="kw-2">&mut </span><span class="self">self</span>.inner, <span class="kw-2">&</span><span class="self">self</span>.error) { <span class="kw">if </span>cors.expose_headers.is_all() { cors.expose_headers = AllOrSome::Some(HashSet::with_capacity(<span class="number">8</span>)); } <span class="kw">if let </span>AllOrSome::Some(<span class="kw-2">ref mut </span>headers) = cors.expose_headers { headers.insert(header); } } } <span class="prelude-val">Err</span>(err) => { <span class="self">self</span>.error = <span class="prelude-val">Some</span>(Either::Left(err.into())); <span class="kw">break</span>; } } } <span class="self">self </span>} <span class="doccomment">/// Set a maximum time (in seconds) for which this CORS request may be cached. This value is set /// as the `Access-Control-Max-Age` header as specified in the [Fetch Standard CORS protocol]. /// /// Pass a number (of seconds) or use None to disable sending max age header. /// /// [Fetch Standard CORS protocol]: https://fetch.spec.whatwg.org/#http-cors-protocol </span><span class="kw">pub fn </span>max_age(<span class="kw-2">mut </span><span class="self">self</span>, max_age: <span class="kw">impl </span>Into<<span class="prelude-ty">Option</span><usize>>) -> Cors { <span class="kw">if let </span><span class="prelude-val">Some</span>(cors) = cors(<span class="kw-2">&mut </span><span class="self">self</span>.inner, <span class="kw-2">&</span><span class="self">self</span>.error) { cors.max_age = max_age.into() } <span class="self">self </span>} <span class="doccomment">/// Set to use wildcard origins. /// /// If send wildcard is set and the `allowed_origins` parameter is `All`, a wildcard /// `Access-Control-Allow-Origin` response header is sent, rather than the request’s /// `Origin` header. /// /// This **CANNOT** be used in conjunction with `allowed_origins` set to `All` and /// `allow_credentials` set to `true`. Depending on the mode of usage, this will either result /// in an `CorsError::CredentialsWithWildcardOrigin` error during actix launch or runtime. /// /// Defaults to `false`. </span><span class="kw">pub fn </span>send_wildcard(<span class="kw-2">mut </span><span class="self">self</span>) -> Cors { <span class="kw">if let </span><span class="prelude-val">Some</span>(cors) = cors(<span class="kw-2">&mut </span><span class="self">self</span>.inner, <span class="kw-2">&</span><span class="self">self</span>.error) { cors.send_wildcard = <span class="bool-val">true </span>} <span class="self">self </span>} <span class="doccomment">/// Allows users to make authenticated requests /// /// If true, injects the `Access-Control-Allow-Credentials` header in responses. This allows /// cookies and credentials to be submitted across domains as specified in /// the [Fetch Standard CORS protocol]. /// /// This option cannot be used in conjunction with an `allowed_origin` set to `All` and /// `send_wildcards` set to `true`. /// /// Defaults to `false`. /// /// A server initialization error will occur if credentials are allowed, but the Origin is set /// to send wildcards (`*`); this is not allowed by the CORS protocol. /// /// [Fetch Standard CORS protocol]: https://fetch.spec.whatwg.org/#http-cors-protocol </span><span class="kw">pub fn </span>supports_credentials(<span class="kw-2">mut </span><span class="self">self</span>) -> Cors { <span class="kw">if let </span><span class="prelude-val">Some</span>(cors) = cors(<span class="kw-2">&mut </span><span class="self">self</span>.inner, <span class="kw-2">&</span><span class="self">self</span>.error) { cors.supports_credentials = <span class="bool-val">true </span>} <span class="self">self </span>} <span class="doccomment">/// Disable `Vary` header support. /// /// When enabled the header `Vary: Origin` will be returned as per the Fetch Standard /// implementation guidelines. /// /// Setting this header when the `Access-Control-Allow-Origin` is dynamically generated /// (eg. when there is more than one allowed origin, and an Origin other than '*' is returned) /// informs CDNs and other caches that the CORS headers are dynamic, and cannot be cached. /// /// By default, `Vary` header support is enabled. </span><span class="kw">pub fn </span>disable_vary_header(<span class="kw-2">mut </span><span class="self">self</span>) -> Cors { <span class="kw">if let </span><span class="prelude-val">Some</span>(cors) = cors(<span class="kw-2">&mut </span><span class="self">self</span>.inner, <span class="kw-2">&</span><span class="self">self</span>.error) { cors.vary_header = <span class="bool-val">false </span>} <span class="self">self </span>} <span class="doccomment">/// Disable support for preflight requests. /// /// When enabled CORS middleware automatically handles `OPTIONS` requests. /// This is useful for application level middleware. /// /// By default *preflight* support is enabled. </span><span class="kw">pub fn </span>disable_preflight(<span class="kw-2">mut </span><span class="self">self</span>) -> Cors { <span class="kw">if let </span><span class="prelude-val">Some</span>(cors) = cors(<span class="kw-2">&mut </span><span class="self">self</span>.inner, <span class="kw-2">&</span><span class="self">self</span>.error) { cors.preflight = <span class="bool-val">false </span>} <span class="self">self </span>} } <span class="kw">impl </span>Default <span class="kw">for </span>Cors { <span class="doccomment">/// A restrictive (security paranoid) set of defaults. /// /// *No* allowed origins, methods, request headers or exposed headers. Credentials /// not supported. No max age (will use browser's default). </span><span class="kw">fn </span>default() -> Cors { <span class="kw">let </span>inner = Inner { allowed_origins: AllOrSome::Some(HashSet::with_capacity(<span class="number">8</span>)), allowed_origins_fns: <span class="macro">smallvec!</span>[], allowed_methods: HashSet::with_capacity(<span class="number">8</span>), allowed_methods_baked: <span class="prelude-val">None</span>, allowed_headers: AllOrSome::Some(HashSet::with_capacity(<span class="number">8</span>)), allowed_headers_baked: <span class="prelude-val">None</span>, expose_headers: AllOrSome::Some(HashSet::with_capacity(<span class="number">8</span>)), expose_headers_baked: <span class="prelude-val">None</span>, max_age: <span class="prelude-val">None</span>, preflight: <span class="bool-val">true</span>, send_wildcard: <span class="bool-val">false</span>, supports_credentials: <span class="bool-val">false</span>, vary_header: <span class="bool-val">true</span>, }; Cors { inner: Rc::new(inner), error: <span class="prelude-val">None</span>, } } } <span class="kw">impl</span><S, B> Transform<S, ServiceRequest> <span class="kw">for </span>Cors <span class="kw">where </span>S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>, S::Future: <span class="lifetime">'static</span>, B: MessageBody + <span class="lifetime">'static</span>, { <span class="kw">type </span>Response = ServiceResponse<EitherBody<B>>; <span class="kw">type </span>Error = Error; <span class="kw">type </span>InitError = (); <span class="kw">type </span>Transform = CorsMiddleware<S>; <span class="kw">type </span>Future = Ready<<span class="prelude-ty">Result</span><<span class="self">Self</span>::Transform, <span class="self">Self</span>::InitError>>; <span class="kw">fn </span>new_transform(<span class="kw-2">&</span><span class="self">self</span>, service: S) -> <span class="self">Self</span>::Future { <span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>err) = <span class="self">self</span>.error { <span class="kw">match </span>err { Either::Left(err) => <span class="macro">error!</span>(<span class="string">"{}"</span>, err), Either::Right(err) => <span class="macro">error!</span>(<span class="string">"{}"</span>, err), } <span class="kw">return </span>future::err(()); } <span class="kw">let </span><span class="kw-2">mut </span>inner = Rc::clone(<span class="kw-2">&</span><span class="self">self</span>.inner); <span class="kw">if </span>inner.supports_credentials && inner.send_wildcard && inner.allowed_origins.is_all() { <span class="macro">error!</span>( <span class="string">"Illegal combination of CORS options: credentials can not be supported when all \ origins are allowed and `send_wildcard` is enabled." </span>); <span class="kw">return </span>future::err(()); } <span class="comment">// bake allowed headers value if Some and not empty </span><span class="kw">match </span>inner.allowed_headers.as_ref() { <span class="prelude-val">Some</span>(header_set) <span class="kw">if </span>!header_set.is_empty() => { <span class="kw">let </span>allowed_headers_str = intersperse_header_values(header_set); Rc::make_mut(<span class="kw-2">&mut </span>inner).allowed_headers_baked = <span class="prelude-val">Some</span>(allowed_headers_str); } <span class="kw">_ </span>=> {} } <span class="comment">// bake allowed methods value if not empty </span><span class="kw">if </span>!inner.allowed_methods.is_empty() { <span class="kw">let </span>allowed_methods_str = intersperse_header_values(<span class="kw-2">&</span>inner.allowed_methods); Rc::make_mut(<span class="kw-2">&mut </span>inner).allowed_methods_baked = <span class="prelude-val">Some</span>(allowed_methods_str); } <span class="comment">// bake exposed headers value if Some and not empty </span><span class="kw">match </span>inner.expose_headers.as_ref() { <span class="prelude-val">Some</span>(header_set) <span class="kw">if </span>!header_set.is_empty() => { <span class="kw">let </span>expose_headers_str = intersperse_header_values(header_set); Rc::make_mut(<span class="kw-2">&mut </span>inner).expose_headers_baked = <span class="prelude-val">Some</span>(expose_headers_str); } <span class="kw">_ </span>=> {} } future::ok(CorsMiddleware { service, inner }) } } <span class="doccomment">/// Only call when values are guaranteed to be valid header values and set is not empty. </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>intersperse_header_values<T>(val_set: <span class="kw-2">&</span>HashSet<T>) -> HeaderValue <span class="kw">where </span>T: AsRef<str>, { <span class="macro">debug_assert!</span>( !val_set.is_empty(), <span class="string">"only call `intersperse_header_values` when set is not empty" </span>); val_set .iter() .fold(String::with_capacity(<span class="number">64</span>), |<span class="kw-2">mut </span>acc, val| { acc.push_str(<span class="string">", "</span>); acc.push_str(val.as_ref()); acc }) <span class="comment">// set is not empty so string will always have leading ", " to trim </span>[<span class="number">2</span>..] .try_into() <span class="comment">// all method names are valid header values </span>.unwrap() } <span class="attribute">#[cfg(test)] </span><span class="kw">mod </span>test { <span class="kw">use </span>std::convert::{Infallible, TryInto}; <span class="kw">use </span>actix_web::{ body, dev::{fn_service, Transform}, http::{header::HeaderName, StatusCode}, test::{<span class="self">self</span>, TestRequest}, HttpResponse, }; <span class="kw">use super</span>::<span class="kw-2">*</span>; <span class="attribute">#[test] </span><span class="kw">fn </span>illegal_allow_credentials() { <span class="comment">// using the permissive defaults (all origins allowed) and adding send_wildcard // and supports_credentials should error on construction </span><span class="macro">assert!</span>(Cors::permissive() .supports_credentials() .send_wildcard() .new_transform(test::ok_service()) .into_inner() .is_err()); } <span class="attribute">#[actix_web::test] </span><span class="kw">async fn </span>restrictive_defaults() { <span class="kw">let </span>cors = Cors::default() .new_transform(test::ok_service()) .<span class="kw">await </span>.unwrap(); <span class="kw">let </span>req = TestRequest::default() .insert_header((<span class="string">"Origin"</span>, <span class="string">"https://www.example.com"</span>)) .to_srv_request(); <span class="kw">let </span>resp = test::call_service(<span class="kw-2">&</span>cors, req).<span class="kw">await</span>; <span class="macro">assert_eq!</span>(resp.status(), StatusCode::BAD_REQUEST); } <span class="attribute">#[actix_web::test] </span><span class="kw">async fn </span>allowed_header_try_from() { <span class="kw">let </span>_cors = Cors::default().allowed_header(<span class="string">"Content-Type"</span>); } <span class="attribute">#[actix_web::test] </span><span class="kw">async fn </span>allowed_header_try_into() { <span class="kw">struct </span>ContentType; <span class="kw">impl </span>TryInto<HeaderName> <span class="kw">for </span>ContentType { <span class="kw">type </span>Error = Infallible; <span class="kw">fn </span>try_into(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><HeaderName, <span class="self">Self</span>::Error> { <span class="prelude-val">Ok</span>(HeaderName::from_static(<span class="string">"content-type"</span>)) } } <span class="kw">let </span>_cors = Cors::default().allowed_header(ContentType); } <span class="attribute">#[actix_web::test] </span><span class="kw">async fn </span>middleware_generic_over_body_type() { <span class="kw">let </span>srv = fn_service(|req: ServiceRequest| <span class="kw">async move </span>{ <span class="prelude-val">Ok</span>(req.into_response(HttpResponse::with_body(StatusCode::OK, body::None::new()))) }); Cors::default().new_transform(srv).<span class="kw">await</span>.unwrap(); } } </code></pre></div> </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="actix_cors" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (eaadb8947 2022-08-27)" ></div></body></html>