blob: 8599036f09ebbe65757a832c4d1e76f6fe63b433 [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/msgs/message.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>message.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>
<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>
</pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::msgs::alert::AlertMessagePayload;
<span class="kw">use </span><span class="kw">crate</span>::msgs::base::Payload;
<span class="kw">use </span><span class="kw">crate</span>::msgs::ccs::ChangeCipherSpecPayload;
<span class="kw">use </span><span class="kw">crate</span>::msgs::codec::{Codec, Reader};
<span class="kw">use </span><span class="kw">crate</span>::msgs::enums::HandshakeType;
<span class="kw">use </span><span class="kw">crate</span>::msgs::enums::{AlertDescription, AlertLevel};
<span class="kw">use </span><span class="kw">crate</span>::msgs::enums::{ContentType, ProtocolVersion};
<span class="kw">use </span><span class="kw">crate</span>::msgs::handshake::HandshakeMessagePayload;
<span class="kw">use </span>std::mem;
<span class="attribute">#[derive(Debug)]
</span><span class="kw">pub enum </span>MessagePayload {
Alert(AlertMessagePayload),
Handshake(HandshakeMessagePayload),
ChangeCipherSpec(ChangeCipherSpecPayload),
Opaque(Payload),
}
<span class="kw">impl </span>MessagePayload {
<span class="kw">pub fn </span>encode(<span class="kw-2">&amp;</span><span class="self">self</span>, bytes: <span class="kw-2">&amp;mut </span>Vec&lt;u8&gt;) {
<span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
MessagePayload::Alert(<span class="kw-2">ref </span>x) =&gt; x.encode(bytes),
MessagePayload::Handshake(<span class="kw-2">ref </span>x) =&gt; x.encode(bytes),
MessagePayload::ChangeCipherSpec(<span class="kw-2">ref </span>x) =&gt; x.encode(bytes),
MessagePayload::Opaque(<span class="kw-2">ref </span>x) =&gt; x.encode(bytes),
}
}
<span class="kw">pub fn </span>decode_given_type(
<span class="kw-2">&amp;</span><span class="self">self</span>,
typ: ContentType,
vers: ProtocolVersion,
) -&gt; <span class="prelude-ty">Option</span>&lt;MessagePayload&gt; {
<span class="kw">if let </span>MessagePayload::Opaque(<span class="kw-2">ref </span>payload) = <span class="kw-2">*</span><span class="self">self </span>{
<span class="kw">let </span><span class="kw-2">mut </span>r = Reader::init(<span class="kw-2">&amp;</span>payload.<span class="number">0</span>);
<span class="kw">let </span>parsed = <span class="kw">match </span>typ {
ContentType::Alert =&gt; {
<span class="prelude-val">Some</span>(MessagePayload::Alert(AlertMessagePayload::read(<span class="kw-2">&amp;mut </span>r)<span class="question-mark">?</span>))
}
ContentType::Handshake =&gt; {
<span class="kw">let </span>p = HandshakeMessagePayload::read_version(<span class="kw-2">&amp;mut </span>r, vers)<span class="question-mark">?</span>;
<span class="prelude-val">Some</span>(MessagePayload::Handshake(p))
}
ContentType::ChangeCipherSpec =&gt; {
<span class="kw">let </span>p = ChangeCipherSpecPayload::read(<span class="kw-2">&amp;mut </span>r)<span class="question-mark">?</span>;
<span class="prelude-val">Some</span>(MessagePayload::ChangeCipherSpec(p))
}
<span class="kw">_ </span>=&gt; <span class="prelude-val">None</span>,
};
<span class="kw">if </span>r.any_left() { <span class="prelude-val">None </span>} <span class="kw">else </span>{ parsed }
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}
<span class="kw">pub fn </span>length(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
MessagePayload::Alert(<span class="kw-2">ref </span>x) =&gt; x.length(),
MessagePayload::Handshake(<span class="kw-2">ref </span>x) =&gt; x.length(),
MessagePayload::ChangeCipherSpec(<span class="kw-2">ref </span>x) =&gt; x.length(),
MessagePayload::Opaque(<span class="kw-2">ref </span>x) =&gt; x.<span class="number">0</span>.len(),
}
}
<span class="kw">pub fn </span>new_opaque(data: Vec&lt;u8&gt;) -&gt; MessagePayload {
MessagePayload::Opaque(Payload::new(data))
}
}
<span class="doccomment">/// A TLS frame, named TLSPlaintext in the standard.
/// This type owns all memory for its interior parts.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>Message {
<span class="kw">pub </span>typ: ContentType,
<span class="kw">pub </span>version: ProtocolVersion,
<span class="kw">pub </span>payload: MessagePayload,
}
<span class="kw">impl </span>Message {
<span class="doccomment">/// This is the maximum on-the-wire size of a TLSCiphertext.
/// That&#39;s 2^14 payload bytes, a header, and a 2KB allowance
/// for ciphertext overheads.
</span><span class="kw">const </span>MAX_PAYLOAD: u16 = <span class="number">16384 </span>+ <span class="number">2048</span>;
<span class="doccomment">/// Content type, version and size.
</span><span class="kw">const </span>HEADER_SIZE: u16 = <span class="number">1 </span>+ <span class="number">2 </span>+ <span class="number">2</span>;
<span class="doccomment">/// Maximum on-wire message size.
</span><span class="kw">pub const </span>MAX_WIRE_SIZE: usize = (Message::MAX_PAYLOAD + Message::HEADER_SIZE) <span class="kw">as </span>usize;
}
<span class="kw">impl </span>Codec <span class="kw">for </span>Message {
<span class="kw">fn </span>read(r: <span class="kw-2">&amp;mut </span>Reader) -&gt; <span class="prelude-ty">Option</span>&lt;Message&gt; {
Message::read_with_detailed_error(r).ok()
}
<span class="kw">fn </span>encode(<span class="kw-2">&amp;</span><span class="self">self</span>, bytes: <span class="kw-2">&amp;mut </span>Vec&lt;u8&gt;) {
<span class="self">self</span>.typ.encode(bytes);
<span class="self">self</span>.version.encode(bytes);
(<span class="self">self</span>.payload.length() <span class="kw">as </span>u16).encode(bytes);
<span class="self">self</span>.payload.encode(bytes);
}
}
<span class="kw">pub enum </span>MessageError {
TooShortForHeader,
TooShortForLength,
IllegalLength,
IllegalContentType,
IllegalProtocolVersion,
}
<span class="kw">impl </span>Message {
<span class="doccomment">/// Like Message::read(), but allows the important distinction between:
/// this message might be valid if we read more data; and this message will
/// never be valid.
</span><span class="kw">pub fn </span>read_with_detailed_error(r: <span class="kw-2">&amp;mut </span>Reader) -&gt; <span class="prelude-ty">Result</span>&lt;Message, MessageError&gt; {
<span class="kw">let </span>typ = ContentType::read(r).ok_or(MessageError::TooShortForHeader)<span class="question-mark">?</span>;
<span class="kw">let </span>version = ProtocolVersion::read(r).ok_or(MessageError::TooShortForHeader)<span class="question-mark">?</span>;
<span class="kw">let </span>len = u16::read(r).ok_or(MessageError::TooShortForHeader)<span class="question-mark">?</span>;
<span class="comment">// Reject oversize messages
</span><span class="kw">if </span>len &gt;= Message::MAX_PAYLOAD {
<span class="kw">return </span><span class="prelude-val">Err</span>(MessageError::IllegalLength);
}
<span class="comment">// Don&#39;t accept any new content-types.
</span><span class="kw">if let </span>ContentType::Unknown(<span class="kw">_</span>) = typ {
<span class="kw">return </span><span class="prelude-val">Err</span>(MessageError::IllegalContentType);
}
<span class="comment">// Accept only versions 0x03XX for any XX.
</span><span class="kw">match </span>version {
ProtocolVersion::Unknown(<span class="kw-2">ref </span>v) <span class="kw">if </span>(v &amp; <span class="number">0xff00</span>) != <span class="number">0x0300 </span>=&gt; {
<span class="kw">return </span><span class="prelude-val">Err</span>(MessageError::IllegalProtocolVersion);
}
<span class="kw">_ </span>=&gt; {}
};
<span class="kw">let </span><span class="kw-2">mut </span>sub = r
.sub(len <span class="kw">as </span>usize)
.ok_or(MessageError::TooShortForLength)<span class="question-mark">?</span>;
<span class="kw">let </span>payload = Payload::read(<span class="kw-2">&amp;mut </span>sub).unwrap();
<span class="prelude-val">Ok</span>(Message {
typ,
version,
payload: MessagePayload::Opaque(payload),
})
}
<span class="kw">pub fn </span>is_content_type(<span class="kw-2">&amp;</span><span class="self">self</span>, typ: ContentType) -&gt; bool {
<span class="self">self</span>.typ == typ
}
<span class="kw">pub fn </span>is_handshake_type(<span class="kw-2">&amp;</span><span class="self">self</span>, hstyp: HandshakeType) -&gt; bool {
<span class="comment">// Bit of a layering violation, but OK.
</span><span class="kw">if let </span>MessagePayload::Handshake(<span class="kw-2">ref </span>hsp) = <span class="self">self</span>.payload {
hsp.typ == hstyp
} <span class="kw">else </span>{
<span class="bool-val">false
</span>}
}
<span class="kw">pub fn </span>decode_payload(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; bool {
<span class="comment">// Do we need a decode?
</span><span class="kw">if </span><span class="self">self</span>.typ == ContentType::ApplicationData {
<span class="kw">return </span><span class="bool-val">true</span>;
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(x) = <span class="self">self
</span>.payload
.decode_given_type(<span class="self">self</span>.typ, <span class="self">self</span>.version)
{
<span class="self">self</span>.payload = x;
<span class="bool-val">true
</span>} <span class="kw">else </span>{
<span class="bool-val">false
</span>}
}
<span class="kw">pub fn </span>take_payload(<span class="self">self</span>) -&gt; Vec&lt;u8&gt; {
<span class="self">self</span>.into_opaque()
.take_opaque_payload()
.unwrap()
.<span class="number">0
</span>}
<span class="kw">pub fn </span>take_opaque_payload(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;Payload&gt; {
<span class="kw">if let </span>MessagePayload::Opaque(<span class="kw-2">ref mut </span>op) = <span class="self">self</span>.payload {
<span class="prelude-val">Some</span>(mem::replace(op, Payload::empty()))
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}
<span class="kw">pub fn </span>into_opaque(<span class="self">self</span>) -&gt; Message {
<span class="kw">if let </span>MessagePayload::Opaque(<span class="kw">_</span>) = <span class="self">self</span>.payload {
<span class="kw">return </span><span class="self">self</span>;
}
<span class="kw">let </span><span class="kw-2">mut </span>buf = Vec::new();
<span class="self">self</span>.payload.encode(<span class="kw-2">&amp;mut </span>buf);
Message {
typ: <span class="self">self</span>.typ,
version: <span class="self">self</span>.version,
payload: MessagePayload::new_opaque(buf),
}
}
<span class="kw">pub fn </span>build_alert(level: AlertLevel, desc: AlertDescription) -&gt; Message {
Message {
typ: ContentType::Alert,
version: ProtocolVersion::TLSv1_2,
payload: MessagePayload::Alert(AlertMessagePayload {
level,
description: desc,
}),
}
}
<span class="kw">pub fn </span>build_key_update_notify() -&gt; Message {
Message {
typ: ContentType::Handshake,
version: ProtocolVersion::TLSv1_3,
payload: MessagePayload::Handshake(HandshakeMessagePayload::build_key_update_notify()),
}
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Message {
<span class="kw">pub fn </span>to_borrowed(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="self">self</span>) -&gt; BorrowMessage&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">if let </span>MessagePayload::Opaque(<span class="kw-2">ref </span>p) = <span class="self">self</span>.payload {
BorrowMessage {
typ: <span class="self">self</span>.typ,
version: <span class="self">self</span>.version,
payload: <span class="kw-2">&amp;</span>p.<span class="number">0</span>,
}
} <span class="kw">else </span>{
<span class="macro">unreachable!</span>(<span class="string">&quot;to_borrowed must have opaque message&quot;</span>);
}
}
}
<span class="doccomment">/// A TLS frame, named TLSPlaintext in the standard.
///
/// This type differs from `Message` because it borrows
/// its payload. You can make a `Message` from an
/// `BorrowMessage`, but this involves a copy.
///
/// This type also cannot decode its internals and
/// is not a `Codec` type, only `Message` can do that.
</span><span class="kw">pub struct </span>BorrowMessage&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">pub </span>typ: ContentType,
<span class="kw">pub </span>version: ProtocolVersion,
<span class="kw">pub </span>payload: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>[u8],
}
</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>