| <!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/openssl-0.10.54/src/ssl/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="../../../openssl/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="../../../openssl/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> |
| </pre><pre class="rust"><code><span class="kw">use </span>libc::c_int; |
| <span class="kw">use </span>std::error; |
| <span class="kw">use </span>std::error::Error <span class="kw">as </span>StdError; |
| <span class="kw">use </span>std::fmt; |
| <span class="kw">use </span>std::io; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::error::ErrorStack; |
| <span class="kw">use </span><span class="kw">crate</span>::ssl::MidHandshakeSslStream; |
| <span class="kw">use </span><span class="kw">crate</span>::x509::X509VerifyResult; |
| |
| <span class="doccomment">/// An error code returned from SSL functions. |
| </span><span class="attribute">#[derive(Debug, Copy, Clone, PartialEq, Eq)] |
| </span><span class="kw">pub struct </span>ErrorCode(c_int); |
| |
| <span class="kw">impl </span>ErrorCode { |
| <span class="doccomment">/// The SSL session has been closed. |
| </span><span class="kw">pub const </span>ZERO_RETURN: ErrorCode = ErrorCode(ffi::SSL_ERROR_ZERO_RETURN); |
| |
| <span class="doccomment">/// An attempt to read data from the underlying socket returned `WouldBlock`. |
| /// |
| /// Wait for read readiness and retry the operation. |
| </span><span class="kw">pub const </span>WANT_READ: ErrorCode = ErrorCode(ffi::SSL_ERROR_WANT_READ); |
| |
| <span class="doccomment">/// An attempt to write data to the underlying socket returned `WouldBlock`. |
| /// |
| /// Wait for write readiness and retry the operation. |
| </span><span class="kw">pub const </span>WANT_WRITE: ErrorCode = ErrorCode(ffi::SSL_ERROR_WANT_WRITE); |
| |
| <span class="doccomment">/// A non-recoverable IO error occurred. |
| </span><span class="kw">pub const </span>SYSCALL: ErrorCode = ErrorCode(ffi::SSL_ERROR_SYSCALL); |
| |
| <span class="doccomment">/// An error occurred in the SSL library. |
| </span><span class="kw">pub const </span>SSL: ErrorCode = ErrorCode(ffi::SSL_ERROR_SSL); |
| |
| <span class="doccomment">/// The client hello callback indicated that it needed to be retried. |
| /// |
| /// Requires OpenSSL 1.1.1 or newer. |
| </span><span class="attribute">#[cfg(ossl111)] |
| </span><span class="kw">pub const </span>WANT_CLIENT_HELLO_CB: ErrorCode = ErrorCode(ffi::SSL_ERROR_WANT_CLIENT_HELLO_CB); |
| |
| <span class="kw">pub fn </span>from_raw(raw: c_int) -> ErrorCode { |
| ErrorCode(raw) |
| } |
| |
| <span class="attribute">#[allow(clippy::trivially_copy_pass_by_ref)] |
| </span><span class="kw">pub fn </span>as_raw(<span class="kw-2">&</span><span class="self">self</span>) -> c_int { |
| <span class="self">self</span>.<span class="number">0 |
| </span>} |
| } |
| |
| <span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>InnerError { |
| Io(io::Error), |
| Ssl(ErrorStack), |
| } |
| |
| <span class="doccomment">/// An SSL error. |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>Error { |
| <span class="kw">pub</span>(<span class="kw">crate</span>) code: ErrorCode, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) cause: <span class="prelude-ty">Option</span><InnerError>, |
| } |
| |
| <span class="kw">impl </span>Error { |
| <span class="kw">pub fn </span>code(<span class="kw-2">&</span><span class="self">self</span>) -> ErrorCode { |
| <span class="self">self</span>.code |
| } |
| |
| <span class="kw">pub fn </span>io_error(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>io::Error> { |
| <span class="kw">match </span><span class="self">self</span>.cause { |
| <span class="prelude-val">Some</span>(InnerError::Io(<span class="kw-2">ref </span>e)) => <span class="prelude-val">Some</span>(e), |
| <span class="kw">_ </span>=> <span class="prelude-val">None</span>, |
| } |
| } |
| |
| <span class="kw">pub fn </span>into_io_error(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><io::Error, Error> { |
| <span class="kw">match </span><span class="self">self</span>.cause { |
| <span class="prelude-val">Some</span>(InnerError::Io(e)) => <span class="prelude-val">Ok</span>(e), |
| <span class="kw">_ </span>=> <span class="prelude-val">Err</span>(<span class="self">self</span>), |
| } |
| } |
| |
| <span class="kw">pub fn </span>ssl_error(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>ErrorStack> { |
| <span class="kw">match </span><span class="self">self</span>.cause { |
| <span class="prelude-val">Some</span>(InnerError::Ssl(<span class="kw-2">ref </span>e)) => <span class="prelude-val">Some</span>(e), |
| <span class="kw">_ </span>=> <span class="prelude-val">None</span>, |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>From<ErrorStack> <span class="kw">for </span>Error { |
| <span class="kw">fn </span>from(e: ErrorStack) -> Error { |
| Error { |
| code: ErrorCode::SSL, |
| cause: <span class="prelude-val">Some</span>(InnerError::Ssl(e)), |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Display <span class="kw">for </span>Error { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <span class="kw">match </span><span class="self">self</span>.code { |
| ErrorCode::ZERO_RETURN => fmt.write_str(<span class="string">"the SSL session has been shut down"</span>), |
| ErrorCode::WANT_READ => <span class="kw">match </span><span class="self">self</span>.io_error() { |
| <span class="prelude-val">Some</span>(<span class="kw">_</span>) => fmt.write_str(<span class="string">"a nonblocking read call would have blocked"</span>), |
| <span class="prelude-val">None </span>=> fmt.write_str(<span class="string">"the operation should be retried"</span>), |
| }, |
| ErrorCode::WANT_WRITE => <span class="kw">match </span><span class="self">self</span>.io_error() { |
| <span class="prelude-val">Some</span>(<span class="kw">_</span>) => fmt.write_str(<span class="string">"a nonblocking write call would have blocked"</span>), |
| <span class="prelude-val">None </span>=> fmt.write_str(<span class="string">"the operation should be retried"</span>), |
| }, |
| ErrorCode::SYSCALL => <span class="kw">match </span><span class="self">self</span>.io_error() { |
| <span class="prelude-val">Some</span>(err) => <span class="macro">write!</span>(fmt, <span class="string">"{}"</span>, err), |
| <span class="prelude-val">None </span>=> fmt.write_str(<span class="string">"unexpected EOF"</span>), |
| }, |
| ErrorCode::SSL => <span class="kw">match </span><span class="self">self</span>.ssl_error() { |
| <span class="prelude-val">Some</span>(e) => <span class="macro">write!</span>(fmt, <span class="string">"{}"</span>, e), |
| <span class="prelude-val">None </span>=> fmt.write_str(<span class="string">"OpenSSL error"</span>), |
| }, |
| ErrorCode(code) => <span class="macro">write!</span>(fmt, <span class="string">"unknown error code {}"</span>, code), |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>error::Error <span class="kw">for </span>Error { |
| <span class="kw">fn </span>source(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>(<span class="kw">dyn </span>error::Error + <span class="lifetime">'static</span>)> { |
| <span class="kw">match </span><span class="self">self</span>.cause { |
| <span class="prelude-val">Some</span>(InnerError::Io(<span class="kw-2">ref </span>e)) => <span class="prelude-val">Some</span>(e), |
| <span class="prelude-val">Some</span>(InnerError::Ssl(<span class="kw-2">ref </span>e)) => <span class="prelude-val">Some</span>(e), |
| <span class="prelude-val">None </span>=> <span class="prelude-val">None</span>, |
| } |
| } |
| } |
| |
| <span class="doccomment">/// An error or intermediate state after a TLS handshake attempt. |
| </span><span class="comment">// FIXME overhaul |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub enum </span>HandshakeError<S> { |
| <span class="doccomment">/// Setup failed. |
| </span>SetupFailure(ErrorStack), |
| <span class="doccomment">/// The handshake failed. |
| </span>Failure(MidHandshakeSslStream<S>), |
| <span class="doccomment">/// The handshake encountered a `WouldBlock` error midway through. |
| /// |
| /// This error will never be returned for blocking streams. |
| </span>WouldBlock(MidHandshakeSslStream<S>), |
| } |
| |
| <span class="kw">impl</span><S: fmt::Debug> StdError <span class="kw">for </span>HandshakeError<S> { |
| <span class="kw">fn </span>source(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>(<span class="kw">dyn </span>StdError + <span class="lifetime">'static</span>)> { |
| <span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{ |
| HandshakeError::SetupFailure(<span class="kw-2">ref </span>e) => <span class="prelude-val">Some</span>(e), |
| HandshakeError::Failure(<span class="kw-2">ref </span>s) | HandshakeError::WouldBlock(<span class="kw-2">ref </span>s) => <span class="prelude-val">Some</span>(s.error()), |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><S: fmt::Debug> fmt::Display <span class="kw">for </span>HandshakeError<S> { |
| <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<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{ |
| HandshakeError::SetupFailure(<span class="kw-2">ref </span>e) => <span class="macro">write!</span>(f, <span class="string">"stream setup failed: {}"</span>, e)<span class="question-mark">?</span>, |
| HandshakeError::Failure(<span class="kw-2">ref </span>s) => { |
| <span class="macro">write!</span>(f, <span class="string">"the handshake failed: {}"</span>, s.error())<span class="question-mark">?</span>; |
| <span class="kw">let </span>verify = s.ssl().verify_result(); |
| <span class="kw">if </span>verify != X509VerifyResult::OK { |
| <span class="macro">write!</span>(f, <span class="string">": {}"</span>, verify)<span class="question-mark">?</span>; |
| } |
| } |
| HandshakeError::WouldBlock(<span class="kw-2">ref </span>s) => { |
| <span class="macro">write!</span>(f, <span class="string">"the handshake was interrupted: {}"</span>, s.error())<span class="question-mark">?</span>; |
| <span class="kw">let </span>verify = s.ssl().verify_result(); |
| <span class="kw">if </span>verify != X509VerifyResult::OK { |
| <span class="macro">write!</span>(f, <span class="string">": {}"</span>, verify)<span class="question-mark">?</span>; |
| } |
| } |
| } |
| <span class="prelude-val">Ok</span>(()) |
| } |
| } |
| |
| <span class="kw">impl</span><S> From<ErrorStack> <span class="kw">for </span>HandshakeError<S> { |
| <span class="kw">fn </span>from(e: ErrorStack) -> HandshakeError<S> { |
| HandshakeError::SetupFailure(e) |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="openssl" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |