| <!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-probe-0.1.5/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_probe/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_probe/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> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::env; |
| <span class="kw">use </span>std::path::{Path, PathBuf}; |
| |
| <span class="doccomment">/// The OpenSSL environment variable to configure what certificate file to use. |
| </span><span class="kw">pub const </span>ENV_CERT_FILE: <span class="kw-2">&</span><span class="lifetime">'static </span>str = <span class="string">"SSL_CERT_FILE"</span>; |
| |
| <span class="doccomment">/// The OpenSSL environment variable to configure what certificates directory to use. |
| </span><span class="kw">pub const </span>ENV_CERT_DIR: <span class="kw-2">&</span><span class="lifetime">'static </span>str = <span class="string">"SSL_CERT_DIR"</span>; |
| |
| <span class="kw">pub struct </span>ProbeResult { |
| <span class="kw">pub </span>cert_file: <span class="prelude-ty">Option</span><PathBuf>, |
| <span class="kw">pub </span>cert_dir: <span class="prelude-ty">Option</span><PathBuf>, |
| } |
| |
| <span class="doccomment">/// Probe the system for the directory in which CA certificates should likely be |
| /// found. |
| /// |
| /// This will only search known system locations. |
| </span><span class="kw">pub fn </span>find_certs_dirs() -> Vec<PathBuf> { |
| cert_dirs_iter().map(Path::to_path_buf).collect() |
| } |
| |
| <span class="comment">// TODO: when we bump to 0.2, make this the `find_certs_dirs` function |
| </span><span class="kw">fn </span>cert_dirs_iter() -> <span class="kw">impl </span>Iterator<Item = <span class="kw-2">&</span><span class="lifetime">'static </span>Path> { |
| <span class="comment">// see http://gagravarr.org/writing/openssl-certs/others.shtml |
| </span>[ |
| <span class="string">"/var/ssl"</span>, |
| <span class="string">"/usr/share/ssl"</span>, |
| <span class="string">"/usr/local/ssl"</span>, |
| <span class="string">"/usr/local/openssl"</span>, |
| <span class="string">"/usr/local/etc/openssl"</span>, |
| <span class="string">"/usr/local/share"</span>, |
| <span class="string">"/usr/lib/ssl"</span>, |
| <span class="string">"/usr/ssl"</span>, |
| <span class="string">"/etc/openssl"</span>, |
| <span class="string">"/etc/pki/ca-trust/extracted/pem"</span>, |
| <span class="string">"/etc/pki/tls"</span>, |
| <span class="string">"/etc/ssl"</span>, |
| <span class="string">"/etc/certs"</span>, |
| <span class="string">"/opt/etc/ssl"</span>, <span class="comment">// Entware |
| </span><span class="string">"/data/data/com.termux/files/usr/etc/tls"</span>, |
| <span class="string">"/boot/system/data/ssl"</span>, |
| ] |
| .iter().map(Path::new).filter(|p| p.exists()) |
| } |
| |
| <span class="doccomment">/// Probe for SSL certificates on the system, then configure the SSL certificate `SSL_CERT_FILE` |
| /// and `SSL_CERT_DIR` environment variables in this process for OpenSSL to use. |
| /// |
| /// Preconfigured values in the environment variables will not be overwritten if the paths they |
| /// point to exist and are accessible. |
| </span><span class="kw">pub fn </span>init_ssl_cert_env_vars() { |
| try_init_ssl_cert_env_vars(); |
| } |
| |
| <span class="doccomment">/// Probe for SSL certificates on the system, then configure the SSL certificate `SSL_CERT_FILE` |
| /// and `SSL_CERT_DIR` environment variables in this process for OpenSSL to use. |
| /// |
| /// Preconfigured values in the environment variables will not be overwritten if the paths they |
| /// point to exist and are accessible. |
| /// |
| /// Returns `true` if any certificate file or directory was found while probing. |
| /// Combine this with `has_ssl_cert_env_vars()` to check whether previously configured environment |
| /// variables are valid. |
| </span><span class="kw">pub fn </span>try_init_ssl_cert_env_vars() -> bool { |
| <span class="kw">let </span>ProbeResult { cert_file, cert_dir } = probe(); |
| <span class="comment">// we won't be overwriting existing env variables because if they're valid probe() will have |
| // returned them unchanged |
| </span><span class="kw">if let </span><span class="prelude-val">Some</span>(path) = <span class="kw-2">&</span>cert_file { |
| env::set_var(ENV_CERT_FILE, path); |
| } |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(path) = <span class="kw-2">&</span>cert_dir { |
| env::set_var(ENV_CERT_DIR, path); |
| } |
| |
| cert_file.is_some() || cert_dir.is_some() |
| } |
| |
| <span class="doccomment">/// Check whether the OpenSSL `SSL_CERT_FILE` and/or `SSL_CERT_DIR` environment variable is |
| /// configured in this process with an existing file or directory. |
| /// |
| /// That being the case would indicate that certificates will be found successfully by OpenSSL. |
| /// |
| /// Returns `true` if either variable is set to an existing file or directory. |
| </span><span class="kw">pub fn </span>has_ssl_cert_env_vars() -> bool { |
| <span class="kw">let </span>probe = probe_from_env(); |
| probe.cert_file.is_some() || probe.cert_dir.is_some() |
| } |
| |
| <span class="kw">fn </span>probe_from_env() -> ProbeResult { |
| <span class="kw">let </span>var = |name| { |
| env::var_os(name) |
| .map(PathBuf::from) |
| .filter(|p| p.exists()) |
| }; |
| ProbeResult { |
| cert_file: var(ENV_CERT_FILE), |
| cert_dir: var(ENV_CERT_DIR), |
| } |
| } |
| |
| <span class="kw">pub fn </span>probe() -> ProbeResult { |
| <span class="kw">let </span><span class="kw-2">mut </span>result = probe_from_env(); |
| <span class="kw">for </span>certs_dir <span class="kw">in </span>cert_dirs_iter() { |
| <span class="comment">// cert.pem looks to be an openssl 1.0.1 thing, while |
| // certs/ca-certificates.crt appears to be a 0.9.8 thing |
| </span><span class="kw">let </span>cert_filenames = [ |
| <span class="string">"cert.pem"</span>, |
| <span class="string">"certs.pem"</span>, |
| <span class="string">"ca-bundle.pem"</span>, |
| <span class="string">"cacert.pem"</span>, |
| <span class="string">"ca-certificates.crt"</span>, |
| <span class="string">"certs/ca-certificates.crt"</span>, |
| <span class="string">"certs/ca-root-nss.crt"</span>, |
| <span class="string">"certs/ca-bundle.crt"</span>, |
| <span class="string">"CARootCertificates.pem"</span>, |
| <span class="string">"tls-ca-bundle.pem"</span>, |
| ]; |
| <span class="kw">if </span>result.cert_file.is_none() { |
| result.cert_file = cert_filenames |
| .iter() |
| .map(|fname| certs_dir.join(fname)) |
| .find(|p| p.exists()); |
| } |
| <span class="kw">if </span>result.cert_dir.is_none() { |
| <span class="kw">let </span>cert_dir = certs_dir.join(<span class="string">"certs"</span>); |
| <span class="kw">if </span>cert_dir.exists() { |
| result.cert_dir = <span class="prelude-val">Some</span>(cert_dir); |
| } |
| } |
| <span class="kw">if </span>result.cert_file.is_some() && result.cert_dir.is_some() { |
| <span class="kw">break</span>; |
| } |
| } |
| result |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="openssl_probe" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
