mirror of
https://github.com/NotAShelf/mpvrc.git
synced 2026-04-20 17:30:47 +00:00
371 lines
No EOL
19 KiB
HTML
371 lines
No EOL
19 KiB
HTML
<!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 `/home/runner/.cargo/registry/src/index.crates.io-6f17d22bba15001f/openssl-0.10.70/src/ssl/error.rs`."><title>error.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="openssl" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../../static.files/storage-59e33391.js"></script><script defer src="../../../static.files/src-script-56102188.js"></script><script defer src="../../../src-files.js"></script><script defer src="../../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">openssl/ssl/</div>error.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers">
|
|
<a href="#1" id="1">1</a>
|
|
<a href="#2" id="2">2</a>
|
|
<a href="#3" id="3">3</a>
|
|
<a href="#4" id="4">4</a>
|
|
<a href="#5" id="5">5</a>
|
|
<a href="#6" id="6">6</a>
|
|
<a href="#7" id="7">7</a>
|
|
<a href="#8" id="8">8</a>
|
|
<a href="#9" id="9">9</a>
|
|
<a href="#10" id="10">10</a>
|
|
<a href="#11" id="11">11</a>
|
|
<a href="#12" id="12">12</a>
|
|
<a href="#13" id="13">13</a>
|
|
<a href="#14" id="14">14</a>
|
|
<a href="#15" id="15">15</a>
|
|
<a href="#16" id="16">16</a>
|
|
<a href="#17" id="17">17</a>
|
|
<a href="#18" id="18">18</a>
|
|
<a href="#19" id="19">19</a>
|
|
<a href="#20" id="20">20</a>
|
|
<a href="#21" id="21">21</a>
|
|
<a href="#22" id="22">22</a>
|
|
<a href="#23" id="23">23</a>
|
|
<a href="#24" id="24">24</a>
|
|
<a href="#25" id="25">25</a>
|
|
<a href="#26" id="26">26</a>
|
|
<a href="#27" id="27">27</a>
|
|
<a href="#28" id="28">28</a>
|
|
<a href="#29" id="29">29</a>
|
|
<a href="#30" id="30">30</a>
|
|
<a href="#31" id="31">31</a>
|
|
<a href="#32" id="32">32</a>
|
|
<a href="#33" id="33">33</a>
|
|
<a href="#34" id="34">34</a>
|
|
<a href="#35" id="35">35</a>
|
|
<a href="#36" id="36">36</a>
|
|
<a href="#37" id="37">37</a>
|
|
<a href="#38" id="38">38</a>
|
|
<a href="#39" id="39">39</a>
|
|
<a href="#40" id="40">40</a>
|
|
<a href="#41" id="41">41</a>
|
|
<a href="#42" id="42">42</a>
|
|
<a href="#43" id="43">43</a>
|
|
<a href="#44" id="44">44</a>
|
|
<a href="#45" id="45">45</a>
|
|
<a href="#46" id="46">46</a>
|
|
<a href="#47" id="47">47</a>
|
|
<a href="#48" id="48">48</a>
|
|
<a href="#49" id="49">49</a>
|
|
<a href="#50" id="50">50</a>
|
|
<a href="#51" id="51">51</a>
|
|
<a href="#52" id="52">52</a>
|
|
<a href="#53" id="53">53</a>
|
|
<a href="#54" id="54">54</a>
|
|
<a href="#55" id="55">55</a>
|
|
<a href="#56" id="56">56</a>
|
|
<a href="#57" id="57">57</a>
|
|
<a href="#58" id="58">58</a>
|
|
<a href="#59" id="59">59</a>
|
|
<a href="#60" id="60">60</a>
|
|
<a href="#61" id="61">61</a>
|
|
<a href="#62" id="62">62</a>
|
|
<a href="#63" id="63">63</a>
|
|
<a href="#64" id="64">64</a>
|
|
<a href="#65" id="65">65</a>
|
|
<a href="#66" id="66">66</a>
|
|
<a href="#67" id="67">67</a>
|
|
<a href="#68" id="68">68</a>
|
|
<a href="#69" id="69">69</a>
|
|
<a href="#70" id="70">70</a>
|
|
<a href="#71" id="71">71</a>
|
|
<a href="#72" id="72">72</a>
|
|
<a href="#73" id="73">73</a>
|
|
<a href="#74" id="74">74</a>
|
|
<a href="#75" id="75">75</a>
|
|
<a href="#76" id="76">76</a>
|
|
<a href="#77" id="77">77</a>
|
|
<a href="#78" id="78">78</a>
|
|
<a href="#79" id="79">79</a>
|
|
<a href="#80" id="80">80</a>
|
|
<a href="#81" id="81">81</a>
|
|
<a href="#82" id="82">82</a>
|
|
<a href="#83" id="83">83</a>
|
|
<a href="#84" id="84">84</a>
|
|
<a href="#85" id="85">85</a>
|
|
<a href="#86" id="86">86</a>
|
|
<a href="#87" id="87">87</a>
|
|
<a href="#88" id="88">88</a>
|
|
<a href="#89" id="89">89</a>
|
|
<a href="#90" id="90">90</a>
|
|
<a href="#91" id="91">91</a>
|
|
<a href="#92" id="92">92</a>
|
|
<a href="#93" id="93">93</a>
|
|
<a href="#94" id="94">94</a>
|
|
<a href="#95" id="95">95</a>
|
|
<a href="#96" id="96">96</a>
|
|
<a href="#97" id="97">97</a>
|
|
<a href="#98" id="98">98</a>
|
|
<a href="#99" id="99">99</a>
|
|
<a href="#100" id="100">100</a>
|
|
<a href="#101" id="101">101</a>
|
|
<a href="#102" id="102">102</a>
|
|
<a href="#103" id="103">103</a>
|
|
<a href="#104" id="104">104</a>
|
|
<a href="#105" id="105">105</a>
|
|
<a href="#106" id="106">106</a>
|
|
<a href="#107" id="107">107</a>
|
|
<a href="#108" id="108">108</a>
|
|
<a href="#109" id="109">109</a>
|
|
<a href="#110" id="110">110</a>
|
|
<a href="#111" id="111">111</a>
|
|
<a href="#112" id="112">112</a>
|
|
<a href="#113" id="113">113</a>
|
|
<a href="#114" id="114">114</a>
|
|
<a href="#115" id="115">115</a>
|
|
<a href="#116" id="116">116</a>
|
|
<a href="#117" id="117">117</a>
|
|
<a href="#118" id="118">118</a>
|
|
<a href="#119" id="119">119</a>
|
|
<a href="#120" id="120">120</a>
|
|
<a href="#121" id="121">121</a>
|
|
<a href="#122" id="122">122</a>
|
|
<a href="#123" id="123">123</a>
|
|
<a href="#124" id="124">124</a>
|
|
<a href="#125" id="125">125</a>
|
|
<a href="#126" id="126">126</a>
|
|
<a href="#127" id="127">127</a>
|
|
<a href="#128" id="128">128</a>
|
|
<a href="#129" id="129">129</a>
|
|
<a href="#130" id="130">130</a>
|
|
<a href="#131" id="131">131</a>
|
|
<a href="#132" id="132">132</a>
|
|
<a href="#133" id="133">133</a>
|
|
<a href="#134" id="134">134</a>
|
|
<a href="#135" id="135">135</a>
|
|
<a href="#136" id="136">136</a>
|
|
<a href="#137" id="137">137</a>
|
|
<a href="#138" id="138">138</a>
|
|
<a href="#139" id="139">139</a>
|
|
<a href="#140" id="140">140</a>
|
|
<a href="#141" id="141">141</a>
|
|
<a href="#142" id="142">142</a>
|
|
<a href="#143" id="143">143</a>
|
|
<a href="#144" id="144">144</a>
|
|
<a href="#145" id="145">145</a>
|
|
<a href="#146" id="146">146</a>
|
|
<a href="#147" id="147">147</a>
|
|
<a href="#148" id="148">148</a>
|
|
<a href="#149" id="149">149</a>
|
|
<a href="#150" id="150">150</a>
|
|
<a href="#151" id="151">151</a>
|
|
<a href="#152" id="152">152</a>
|
|
<a href="#153" id="153">153</a>
|
|
<a href="#154" id="154">154</a>
|
|
<a href="#155" id="155">155</a>
|
|
<a href="#156" id="156">156</a>
|
|
<a href="#157" id="157">157</a>
|
|
<a href="#158" id="158">158</a>
|
|
<a href="#159" id="159">159</a>
|
|
<a href="#160" id="160">160</a>
|
|
<a href="#161" id="161">161</a>
|
|
<a href="#162" id="162">162</a>
|
|
<a href="#163" id="163">163</a>
|
|
<a href="#164" id="164">164</a>
|
|
<a href="#165" id="165">165</a>
|
|
<a href="#166" id="166">166</a>
|
|
<a href="#167" id="167">167</a>
|
|
<a href="#168" id="168">168</a>
|
|
<a href="#169" id="169">169</a>
|
|
<a href="#170" id="170">170</a>
|
|
<a href="#171" id="171">171</a>
|
|
<a href="#172" id="172">172</a>
|
|
<a href="#173" id="173">173</a>
|
|
<a href="#174" id="174">174</a>
|
|
<a href="#175" id="175">175</a>
|
|
<a href="#176" id="176">176</a>
|
|
<a href="#177" id="177">177</a>
|
|
<a href="#178" id="178">178</a>
|
|
<a href="#179" id="179">179</a>
|
|
<a href="#180" id="180">180</a>
|
|
<a href="#181" id="181">181</a>
|
|
<a href="#182" id="182">182</a>
|
|
<a href="#183" id="183">183</a>
|
|
<a href="#184" id="184">184</a>
|
|
<a href="#185" id="185">185</a></pre></div><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="attr">#[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="attr">#[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="attr">#[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="attr">#[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="attr">#[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="attr">#[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></main></body></html> |