| <!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/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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> |
| <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> |
| </pre><pre class="rust"><code><span class="doccomment">//! Bindings to OpenSSL |
| //! |
| //! This crate provides a safe interface to the popular OpenSSL cryptography library. OpenSSL versions 1.0.1 through |
| //! 3.x.x and LibreSSL versions 2.5 through 3.7.x are supported. |
| //! |
| //! # Building |
| //! |
| //! Both OpenSSL libraries and headers are required to build this crate. There are multiple options available to locate |
| //! OpenSSL. |
| //! |
| //! ## Vendored |
| //! |
| //! If the `vendored` Cargo feature is enabled, the `openssl-src` crate will be used to compile and statically link to |
| //! a copy of OpenSSL. The build process requires a C compiler, perl (and perl-core), and make. The OpenSSL version will generally track |
| //! the newest OpenSSL release, and changes to the version are *not* considered breaking changes. |
| //! |
| //! ```toml |
| //! [dependencies] |
| //! openssl = { version = "0.10", features = ["vendored"] } |
| //! ``` |
| //! |
| //! The vendored copy will not be configured to automatically find the system's root certificates, but the |
| //! `openssl-probe` crate can be used to do that instead. |
| //! |
| //! ## Automatic |
| //! |
| //! The `openssl-sys` crate will automatically detect OpenSSL installations via Homebrew on macOS and vcpkg on Windows. |
| //! Additionally, it will use `pkg-config` on Unix-like systems to find the system installation. |
| //! |
| //! ```not_rust |
| //! # macOS (Homebrew) |
| //! $ brew install openssl@3 |
| //! |
| //! # macOS (MacPorts) |
| //! $ sudo port install openssl |
| //! |
| //! # macOS (pkgsrc) |
| //! $ sudo pkgin install openssl |
| //! |
| //! # Arch Linux |
| //! $ sudo pacman -S pkg-config openssl |
| //! |
| //! # Debian and Ubuntu |
| //! $ sudo apt-get install pkg-config libssl-dev |
| //! |
| //! # Fedora |
| //! $ sudo dnf install pkg-config openssl-devel |
| //! |
| //! # Alpine Linux |
| //! $ apk add pkgconfig openssl-dev |
| //! ``` |
| //! |
| //! ## Manual |
| //! |
| //! A set of environment variables can be used to point `openssl-sys` towards an OpenSSL installation. They will |
| //! override the automatic detection logic. |
| //! |
| //! * `OPENSSL_DIR` - If specified, the directory of an OpenSSL installation. The directory should contain `lib` and |
| //! `include` subdirectories containing the libraries and headers respectively. |
| //! * `OPENSSL_LIB_DIR` and `OPENSSL_INCLUDE_DIR` - If specified, the directories containing the OpenSSL libraries and |
| //! headers respectively. This can be used if the OpenSSL installation is split in a nonstandard directory layout. |
| //! * `OPENSSL_STATIC` - If set, the crate will statically link to OpenSSL rather than dynamically link. |
| //! * `OPENSSL_LIBS` - If set, a `:`-separated list of library names to link to (e.g. `ssl:crypto`). This can be used |
| //! if nonstandard library names were used for whatever reason. |
| //! * `OPENSSL_NO_VENDOR` - If set, always find OpenSSL in the system, even if the `vendored` feature is enabled. |
| //! |
| //! Additionally, these variables can be prefixed with the upper-cased target architecture (e.g. |
| //! `X86_64_UNKNOWN_LINUX_GNU_OPENSSL_DIR`), which can be useful when cross compiling. |
| //! |
| //! # Feature Detection |
| //! |
| //! APIs have been added to and removed from the various supported OpenSSL versions, and this library exposes the |
| //! functionality available in the version being linked against. This means that methods, constants, and even modules |
| //! will be present when building against one version of OpenSSL but not when building against another! APIs will |
| //! document any version-specific availability restrictions. |
| //! |
| //! A build script can be used to detect the OpenSSL or LibreSSL version at compile time if needed. The `openssl-sys` |
| //! crate propagates the version via the `DEP_OPENSSL_VERSION_NUMBER` and `DEP_OPENSSL_LIBRESSL_VERSION_NUMBER` |
| //! environment variables to build scripts. The version format is a hex-encoding of the OpenSSL release version: |
| //! `0xMNNFFPPS`. For example, version 1.0.2g's encoding is `0x1_00_02_07_0`. |
| //! |
| //! For example, let's say we want to adjust the TLSv1.3 cipher suites used by a client, but also want to compile |
| //! against OpenSSL versions that don't support TLSv1.3: |
| //! |
| //! Cargo.toml: |
| //! |
| //! ```toml |
| //! [dependencies] |
| //! openssl-sys = "0.9" |
| //! openssl = "0.10" |
| //! ``` |
| //! |
| //! build.rs: |
| //! |
| //! ``` |
| //! use std::env; |
| //! |
| //! fn main() { |
| //! if let Ok(v) = env::var("DEP_OPENSSL_VERSION_NUMBER") { |
| //! let version = u64::from_str_radix(&v, 16).unwrap(); |
| //! |
| //! if version >= 0x1_01_01_00_0 { |
| //! println!("cargo:rustc-cfg=openssl111"); |
| //! } |
| //! } |
| //! } |
| //! ``` |
| //! |
| //! lib.rs: |
| //! |
| //! ``` |
| //! use openssl::ssl::{SslConnector, SslMethod}; |
| //! |
| //! let mut ctx = SslConnector::builder(SslMethod::tls()).unwrap(); |
| //! |
| //! // set_ciphersuites was added in OpenSSL 1.1.1, so we can only call it when linking against that version |
| //! #[cfg(openssl111)] |
| //! ctx.set_ciphersuites("TLS_AES_256_GCM_SHA384:TLS_AES_128_GCM_SHA256").unwrap(); |
| //! ``` |
| </span><span class="attribute">#![doc(html_root_url = <span class="string">"https://docs.rs/openssl/0.10"</span>)] |
| #![warn(rust_2018_idioms)] |
| #![allow(clippy::uninlined_format_args)] |
| |
| #[doc(inline)] |
| </span><span class="kw">pub use </span>ffi::init; |
| |
| <span class="kw">use </span>libc::c_int; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::error::ErrorStack; |
| |
| <span class="attribute">#[macro_use] |
| </span><span class="kw">mod </span>macros; |
| |
| <span class="kw">mod </span>bio; |
| <span class="attribute">#[macro_use] |
| </span><span class="kw">mod </span>util; |
| <span class="kw">pub mod </span>aes; |
| <span class="kw">pub mod </span>asn1; |
| <span class="kw">pub mod </span>base64; |
| <span class="kw">pub mod </span>bn; |
| <span class="kw">pub mod </span>cipher; |
| <span class="kw">pub mod </span>cipher_ctx; |
| <span class="attribute">#[cfg(all(not(boringssl), not(libressl), not(osslconf = <span class="string">"OPENSSL_NO_CMS"</span>)))] |
| </span><span class="kw">pub mod </span>cms; |
| <span class="kw">pub mod </span>conf; |
| <span class="kw">pub mod </span>derive; |
| <span class="kw">pub mod </span>dh; |
| <span class="kw">pub mod </span>dsa; |
| <span class="kw">pub mod </span>ec; |
| <span class="kw">pub mod </span>ecdsa; |
| <span class="kw">pub mod </span>encrypt; |
| <span class="attribute">#[cfg(not(boringssl))] |
| </span><span class="kw">pub mod </span>envelope; |
| <span class="kw">pub mod </span>error; |
| <span class="kw">pub mod </span>ex_data; |
| <span class="attribute">#[cfg(not(any(libressl, ossl300)))] |
| </span><span class="kw">pub mod </span>fips; |
| <span class="kw">pub mod </span>hash; |
| <span class="attribute">#[cfg(ossl300)] |
| </span><span class="kw">pub mod </span>lib_ctx; |
| <span class="kw">pub mod </span>md; |
| <span class="kw">pub mod </span>md_ctx; |
| <span class="kw">pub mod </span>memcmp; |
| <span class="kw">pub mod </span>nid; |
| <span class="attribute">#[cfg(not(any(boringssl, osslconf = <span class="string">"OPENSSL_NO_OCSP"</span>)))] |
| </span><span class="kw">pub mod </span>ocsp; |
| <span class="kw">pub mod </span>pkcs12; |
| <span class="kw">pub mod </span>pkcs5; |
| <span class="attribute">#[cfg(not(boringssl))] |
| </span><span class="kw">pub mod </span>pkcs7; |
| <span class="kw">pub mod </span>pkey; |
| <span class="kw">pub mod </span>pkey_ctx; |
| <span class="attribute">#[cfg(ossl300)] |
| </span><span class="kw">pub mod </span>provider; |
| <span class="kw">pub mod </span>rand; |
| <span class="kw">pub mod </span>rsa; |
| <span class="kw">pub mod </span>sha; |
| <span class="kw">pub mod </span>sign; |
| <span class="kw">pub mod </span>srtp; |
| <span class="kw">pub mod </span>ssl; |
| <span class="kw">pub mod </span>stack; |
| <span class="kw">pub mod </span>string; |
| <span class="kw">pub mod </span>symm; |
| <span class="kw">pub mod </span>version; |
| <span class="kw">pub mod </span>x509; |
| |
| <span class="attribute">#[cfg(boringssl)] |
| </span><span class="kw">type </span>LenType = libc::size_t; |
| <span class="attribute">#[cfg(not(boringssl))] |
| </span><span class="kw">type </span>LenType = libc::c_int; |
| |
| <span class="attribute">#[cfg(boringssl)] |
| </span><span class="kw">type </span>SLenType = libc::ssize_t; |
| <span class="attribute">#[cfg(not(boringssl))] |
| </span><span class="kw">type </span>SLenType = libc::c_int; |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>cvt_p<T>(r: <span class="kw-2">*mut </span>T) -> <span class="prelude-ty">Result</span><<span class="kw-2">*mut </span>T, ErrorStack> { |
| <span class="kw">if </span>r.is_null() { |
| <span class="prelude-val">Err</span>(ErrorStack::get()) |
| } <span class="kw">else </span>{ |
| <span class="prelude-val">Ok</span>(r) |
| } |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>cvt(r: c_int) -> <span class="prelude-ty">Result</span><c_int, ErrorStack> { |
| <span class="kw">if </span>r <= <span class="number">0 </span>{ |
| <span class="prelude-val">Err</span>(ErrorStack::get()) |
| } <span class="kw">else </span>{ |
| <span class="prelude-val">Ok</span>(r) |
| } |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>cvt_n(r: c_int) -> <span class="prelude-ty">Result</span><c_int, ErrorStack> { |
| <span class="kw">if </span>r < <span class="number">0 </span>{ |
| <span class="prelude-val">Err</span>(ErrorStack::get()) |
| } <span class="kw">else </span>{ |
| <span class="prelude-val">Ok</span>(r) |
| } |
| } |
| </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> |
