blob: 8a169987a37bdba41ad58b2fc66fcb2a730fa44d [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/rustls-0.19.1/src/check.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>check.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../rustls/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../rustls/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
</pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::error::TLSError;
<span class="attribute">#[cfg(feature = <span class="string">&quot;logging&quot;</span>)]
</span><span class="kw">use </span><span class="kw">crate</span>::log::warn;
<span class="kw">use </span><span class="kw">crate</span>::msgs::enums::{ContentType, HandshakeType};
<span class="kw">use </span><span class="kw">crate</span>::msgs::message::{Message, MessagePayload};
<span class="doccomment">/// For a Message $m, and a HandshakePayload enum member $payload_type,
/// return Ok(payload) if $m is both a handshake message and one that
/// has the given $payload_type. If not, return Err(TLSError) quoting
/// $handshake_type as the expected handshake type.
</span><span class="macro">macro_rules! </span>require_handshake_msg(
( <span class="macro-nonterminal">$m</span>:expr, <span class="macro-nonterminal">$handshake_type</span>:path, <span class="macro-nonterminal">$payload_type</span>:path ) =&gt; (
<span class="kw">match </span><span class="macro-nonterminal">$m</span>.payload {
MessagePayload::Handshake(<span class="kw-2">ref </span>hsp) =&gt; <span class="kw">match </span>hsp.payload {
<span class="macro-nonterminal">$payload_type</span>(<span class="kw-2">ref </span>hm) =&gt; <span class="prelude-val">Ok</span>(hm),
<span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(TLSError::InappropriateHandshakeMessage {
expect_types: <span class="macro">vec!</span>[ <span class="macro-nonterminal">$handshake_type </span>],
got_type: hsp.typ})
}
<span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(TLSError::InappropriateMessage {
expect_types: <span class="macro">vec!</span>[ ContentType::Handshake ],
got_type: <span class="macro-nonterminal">$m</span>.typ})
}
)
);
<span class="doccomment">/// Like require_handshake_msg, but moves the payload out of $m.
</span><span class="macro">macro_rules! </span>require_handshake_msg_mut(
( <span class="macro-nonterminal">$m</span>:expr, <span class="macro-nonterminal">$handshake_type</span>:path, <span class="macro-nonterminal">$payload_type</span>:path ) =&gt; (
<span class="kw">match </span><span class="macro-nonterminal">$m</span>.payload {
MessagePayload::Handshake(hsp) =&gt; <span class="kw">match </span>hsp.payload {
<span class="macro-nonterminal">$payload_type</span>(hm) =&gt; <span class="prelude-val">Ok</span>(hm),
<span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(TLSError::InappropriateHandshakeMessage {
expect_types: <span class="macro">vec!</span>[ <span class="macro-nonterminal">$handshake_type </span>],
got_type: hsp.typ})
}
<span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(TLSError::InappropriateMessage {
expect_types: <span class="macro">vec!</span>[ ContentType::Handshake ],
got_type: <span class="macro-nonterminal">$m</span>.typ})
}
)
);
<span class="doccomment">/// Validate the message `m`: return an error if:
///
/// - the type of m does not appear in `content_types`.
/// - if m is a handshake message, the handshake message type does
/// not appear in `handshake_types`.
</span><span class="kw">pub fn </span>check_message(
m: <span class="kw-2">&amp;</span>Message,
content_types: <span class="kw-2">&amp;</span>[ContentType],
handshake_types: <span class="kw-2">&amp;</span>[HandshakeType],
) -&gt; <span class="prelude-ty">Result</span>&lt;(), TLSError&gt; {
<span class="kw">if </span>!content_types.contains(<span class="kw-2">&amp;</span>m.typ) {
<span class="macro">warn!</span>(
<span class="string">&quot;Received a {:?} message while expecting {:?}&quot;</span>,
m.typ, content_types
);
<span class="kw">return </span><span class="prelude-val">Err</span>(TLSError::InappropriateMessage {
expect_types: content_types.to_vec(),
got_type: m.typ,
});
}
<span class="kw">if let </span>MessagePayload::Handshake(<span class="kw-2">ref </span>hsp) = m.payload {
<span class="kw">if </span>!handshake_types.is_empty() &amp;&amp; !handshake_types.contains(<span class="kw-2">&amp;</span>hsp.typ) {
<span class="macro">warn!</span>(
<span class="string">&quot;Received a {:?} handshake message while expecting {:?}&quot;</span>,
hsp.typ, handshake_types
);
<span class="kw">return </span><span class="prelude-val">Err</span>(TLSError::InappropriateHandshakeMessage {
expect_types: handshake_types.to_vec(),
got_type: hsp.typ,
});
}
}
<span class="prelude-val">Ok</span>(())
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustls" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>