| <!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/git/checkouts/incubator-teaclave-crates-c8106113f74feefc/ede1f68/rustls-0.19.1/rustls/src/error.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>error.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> |
| </pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::msgs::enums::{AlertDescription, ContentType, HandshakeType}; |
| <span class="kw">use </span>sct; |
| <span class="kw">use </span>std::error::Error; |
| <span class="kw">use </span>std::fmt; |
| <span class="kw">use </span>webpki; |
| |
| <span class="doccomment">/// rustls reports protocol errors using this type. |
| </span><span class="attribute">#[derive(Debug, PartialEq, Clone)] |
| </span><span class="kw">pub enum </span>TLSError { |
| <span class="doccomment">/// We received a TLS message that isn't valid right now. |
| /// `expect_types` lists the message types we can expect right now. |
| /// `got_type` is the type we found. This error is typically |
| /// caused by a buggy TLS stack (the peer or this one), a broken |
| /// network, or an attack. |
| </span>InappropriateMessage { |
| <span class="doccomment">/// Which types we expected |
| </span>expect_types: Vec<ContentType>, |
| <span class="doccomment">/// What type we received |
| </span>got_type: ContentType, |
| }, |
| |
| <span class="doccomment">/// We received a TLS handshake message that isn't valid right now. |
| /// `expect_types` lists the handshake message types we can expect |
| /// right now. `got_type` is the type we found. |
| </span>InappropriateHandshakeMessage { |
| <span class="doccomment">/// Which handshake type we expected |
| </span>expect_types: Vec<HandshakeType>, |
| <span class="doccomment">/// What handshake type we received |
| </span>got_type: HandshakeType, |
| }, |
| |
| <span class="doccomment">/// The peer sent us a syntactically incorrect TLS message. |
| </span>CorruptMessage, |
| |
| <span class="doccomment">/// The peer sent us a TLS message with invalid contents. |
| </span>CorruptMessagePayload(ContentType), |
| |
| <span class="doccomment">/// The peer didn't give us any certificates. |
| </span>NoCertificatesPresented, |
| |
| <span class="doccomment">/// We couldn't decrypt a message. This is invariably fatal. |
| </span>DecryptError, |
| |
| <span class="doccomment">/// The peer doesn't support a protocol version/feature we require. |
| /// The parameter gives a hint as to what version/feature it is. |
| </span>PeerIncompatibleError(String), |
| |
| <span class="doccomment">/// The peer deviated from the standard TLS protocol. |
| /// The parameter gives a hint where. |
| </span>PeerMisbehavedError(String), |
| |
| <span class="doccomment">/// We received a fatal alert. This means the peer is unhappy. |
| </span>AlertReceived(AlertDescription), |
| |
| <span class="doccomment">/// The presented certificate chain is invalid. |
| </span>WebPKIError(webpki::Error), |
| |
| <span class="doccomment">/// The presented SCT(s) were invalid. |
| </span>InvalidSCT(sct::Error), |
| |
| <span class="doccomment">/// A catch-all error for unlikely errors. |
| </span>General(String), |
| |
| <span class="doccomment">/// We failed to figure out what time it currently is. |
| </span>FailedToGetCurrentTime, |
| |
| <span class="doccomment">/// This function doesn't work until the TLS handshake |
| /// is complete. |
| </span>HandshakeNotComplete, |
| |
| <span class="doccomment">/// The peer sent an oversized record/fragment. |
| </span>PeerSentOversizedRecord, |
| |
| <span class="doccomment">/// An incoming connection did not support any known application protocol. |
| </span>NoApplicationProtocol, |
| } |
| |
| <span class="kw">fn </span>join<T: fmt::Debug>(items: <span class="kw-2">&</span>[T]) -> String { |
| items |
| .iter() |
| .map(|x| <span class="macro">format!</span>(<span class="string">"{:?}"</span>, x)) |
| .collect::<Vec<String>>() |
| .join(<span class="string">" or "</span>) |
| } |
| |
| <span class="kw">impl </span>fmt::Display <span class="kw">for </span>TLSError { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result { |
| <span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{ |
| TLSError::InappropriateMessage { |
| <span class="kw-2">ref </span>expect_types, |
| <span class="kw-2">ref </span>got_type, |
| } => <span class="macro">write!</span>( |
| f, |
| <span class="string">"received unexpected message: got {:?} when expecting {}"</span>, |
| got_type, |
| join::<ContentType>(expect_types) |
| ), |
| TLSError::InappropriateHandshakeMessage { |
| <span class="kw-2">ref </span>expect_types, |
| <span class="kw-2">ref </span>got_type, |
| } => <span class="macro">write!</span>( |
| f, |
| <span class="string">"received unexpected handshake message: got {:?} when expecting {}"</span>, |
| got_type, |
| join::<HandshakeType>(expect_types) |
| ), |
| TLSError::CorruptMessagePayload(<span class="kw-2">ref </span>typ) => { |
| <span class="macro">write!</span>(f, <span class="string">"received corrupt message of type {:?}"</span>, typ) |
| } |
| TLSError::PeerIncompatibleError(<span class="kw-2">ref </span>why) => <span class="macro">write!</span>(f, <span class="string">"peer is incompatible: {}"</span>, why), |
| TLSError::PeerMisbehavedError(<span class="kw-2">ref </span>why) => <span class="macro">write!</span>(f, <span class="string">"peer misbehaved: {}"</span>, why), |
| TLSError::AlertReceived(<span class="kw-2">ref </span>alert) => <span class="macro">write!</span>(f, <span class="string">"received fatal alert: {:?}"</span>, alert), |
| TLSError::WebPKIError(<span class="kw-2">ref </span>err) => <span class="macro">write!</span>(f, <span class="string">"invalid certificate: {:?}"</span>, err), |
| TLSError::CorruptMessage => <span class="macro">write!</span>(f, <span class="string">"received corrupt message"</span>), |
| TLSError::NoCertificatesPresented => <span class="macro">write!</span>(f, <span class="string">"peer sent no certificates"</span>), |
| TLSError::DecryptError => <span class="macro">write!</span>(f, <span class="string">"cannot decrypt peer's message"</span>), |
| TLSError::PeerSentOversizedRecord => <span class="macro">write!</span>(f, <span class="string">"peer sent excess record size"</span>), |
| TLSError::HandshakeNotComplete => <span class="macro">write!</span>(f, <span class="string">"handshake not complete"</span>), |
| TLSError::NoApplicationProtocol => <span class="macro">write!</span>(f, <span class="string">"peer doesn't support any known protocol"</span>), |
| TLSError::InvalidSCT(<span class="kw-2">ref </span>err) => <span class="macro">write!</span>(f, <span class="string">"invalid certificate timestamp: {:?}"</span>, err), |
| TLSError::FailedToGetCurrentTime => <span class="macro">write!</span>(f, <span class="string">"failed to get current time"</span>), |
| TLSError::General(<span class="kw-2">ref </span>err) => <span class="macro">write!</span>(f, <span class="string">"unexpected error: {}"</span>, err), <span class="comment">// (please file a bug) |
| </span>} |
| } |
| } |
| |
| <span class="kw">impl </span>Error <span class="kw">for </span>TLSError {} |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>smoke() { |
| <span class="kw">use </span><span class="kw">super</span>::TLSError; |
| <span class="kw">use </span><span class="kw">crate</span>::msgs::enums::{AlertDescription, ContentType, HandshakeType}; |
| <span class="kw">use </span>sct; |
| <span class="kw">use </span>webpki; |
| |
| <span class="kw">let </span>all = <span class="macro">vec!</span>[ |
| TLSError::InappropriateMessage { |
| expect_types: <span class="macro">vec!</span>[ContentType::Alert], |
| got_type: ContentType::Handshake, |
| }, |
| TLSError::InappropriateHandshakeMessage { |
| expect_types: <span class="macro">vec!</span>[HandshakeType::ClientHello, HandshakeType::Finished], |
| got_type: HandshakeType::ServerHello, |
| }, |
| TLSError::CorruptMessage, |
| TLSError::CorruptMessagePayload(ContentType::Alert), |
| TLSError::NoCertificatesPresented, |
| TLSError::DecryptError, |
| TLSError::PeerIncompatibleError(<span class="string">"no tls1.2"</span>.to_string()), |
| TLSError::PeerMisbehavedError(<span class="string">"inconsistent something"</span>.to_string()), |
| TLSError::AlertReceived(AlertDescription::ExportRestriction), |
| TLSError::WebPKIError(webpki::Error::ExtensionValueInvalid), |
| TLSError::InvalidSCT(sct::Error::MalformedSCT), |
| TLSError::General(<span class="string">"undocumented error"</span>.to_string()), |
| TLSError::FailedToGetCurrentTime, |
| TLSError::HandshakeNotComplete, |
| TLSError::PeerSentOversizedRecord, |
| TLSError::NoApplicationProtocol, |
| ]; |
| |
| <span class="kw">for </span>err <span class="kw">in </span>all { |
| <span class="macro">println!</span>(<span class="string">"{:?}:"</span>, err); |
| <span class="macro">println!</span>(<span class="string">" fmt '{}'"</span>, err); |
| } |
| } |
| } |
| </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> |
