Auto Generated Documentation
This commit is contained in:
github-actions[bot]
+15
-10
@@ -1,7 +1,7 @@
|
||||
<!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="Bindings to OpenSSL"><meta name="keywords" content="rust, rustlang, rust-lang, openssl"><title>openssl - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<!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="API documentation for the Rust `openssl` crate."><meta name="keywords" content="rust, rustlang, rust-lang, openssl"><title>openssl - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../openssl/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Crate openssl</p><div class="block version"><p>Version 0.10.32</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all openssl's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#functions">Functions</a></li></ul></div><p class="location"></p><div id="sidebar-vars" data-name="openssl" data-ty="mod" data-relpath="../"></div></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="">openssl</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/openssl/lib.rs.html#1-202" title="goto source code">[src]</a></span></h1><div class="docblock"><p>Bindings to OpenSSL</p>
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../openssl/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Crate openssl</p><div class="block version"><p>Version 0.10.33</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all openssl's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#functions">Functions</a></li></ul></div><p class="location"></p><script>window.sidebarCurrent = {name: "openssl", ty: "mod", relpath: "../"};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/openssl/lib.rs.html#1-194" title="goto source code">[src]</a></span><span class="in-band">Crate <a class="mod" href="">openssl</a></span></h1><div class="docblock"><p>Bindings to OpenSSL</p>
|
||||
<p>This crate provides a safe interface to the popular OpenSSL cryptography library. OpenSSL versions 1.0.1 through
|
||||
1.1.1 and LibreSSL versions 2.5 through 2.8 are supported.</p>
|
||||
<h1 id="building" class="section-header"><a href="#building">Building</a></h1>
|
||||
@@ -14,14 +14,20 @@ the newest OpenSSL release, and changes to the version are <em>not</em> consider
|
||||
<pre><code class="language-toml">[dependencies]
|
||||
openssl = { version = "0.10", features = ["vendored"] }
|
||||
</code></pre>
|
||||
<p>The vendored copy will not be configured to automatically find the system’s root certificates, but the
|
||||
<p>The vendored copy will not be configured to automatically find the system's root certificates, but the
|
||||
<code>openssl-probe</code> crate can be used to do that instead.</p>
|
||||
<h2 id="automatic" class="section-header"><a href="#automatic">Automatic</a></h2>
|
||||
<p>The <code>openssl-sys</code> crate will automatically detect OpenSSL installations via Homebrew on macOS and vcpkg on Windows.
|
||||
Additionally, it will use <code>pkg-config</code> on Unix-like systems to find the system installation.</p>
|
||||
<pre><code class="language-not_rust"># macOS
|
||||
<pre><code class="language-not_rust"># macOS (Homebrew)
|
||||
$ brew install openssl@1.1
|
||||
|
||||
# macOS (MacPorts)
|
||||
$ sudo port install openssl
|
||||
|
||||
# macOS (pkgsrc)
|
||||
$ sudo pkgin install openssl
|
||||
|
||||
# Arch Linux
|
||||
$ sudo pacman -S pkg-config openssl
|
||||
|
||||
@@ -54,9 +60,9 @@ document any version-specific availability restrictions.</p>
|
||||
<p>A build script can be used to detect the OpenSSL or LibreSSL version at compile time if needed. The <code>openssl-sys</code>
|
||||
crate propagates the version via the <code>DEP_OPENSSL_VERSION_NUMBER</code> and <code>DEP_OPENSSL_LIBRESSL_VERSION_NUMBER</code>
|
||||
environment variables to build scripts. The version format is a hex-encoding of the OpenSSL release version:
|
||||
<code>0xMNNFFPPS</code>. For example, version 1.0.2g’s encoding is <code>0x1_00_02_07_0</code>.</p>
|
||||
<p>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:</p>
|
||||
<code>0xMNNFFPPS</code>. For example, version 1.0.2g's encoding is <code>0x1_00_02_07_0</code>.</p>
|
||||
<p>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:</p>
|
||||
<p>Cargo.toml:</p>
|
||||
<pre><code class="language-toml">[dependencies]
|
||||
openssl-sys = "0.9"
|
||||
@@ -113,5 +119,4 @@ openssl = "0.10"
|
||||
</td></tr><tr class="module-item"><td><a class="mod" href="stack/index.html" title="openssl::stack mod">stack</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="mod" href="string/index.html" title="openssl::string mod">string</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="mod" href="symm/index.html" title="openssl::symm mod">symm</a></td><td class="docblock-short"><p>High level interface to certain symmetric ciphers.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="mod" href="version/index.html" title="openssl::version mod">version</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="mod" href="x509/index.html" title="openssl::x509 mod">x509</a></td><td class="docblock-short"><p>The standard defining the format of public key certificates.</p>
|
||||
</td></tr></table><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2>
|
||||
<table><tr class="module-item"><td><a class="fn" href="fn.init.html" title="openssl::init fn">init</a></td><td class="docblock-short"></td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="openssl"></div>
|
||||
<script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|
||||
<table><tr class="module-item"><td><a class="fn" href="fn.init.html" title="openssl::init fn">init</a></td><td class="docblock-short"></td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "openssl";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|
||||
Reference in New Issue
Block a user