| <!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="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="../crates.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 mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../openssl/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><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><h2 class="location"><a href="#">Crate openssl</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.10.54</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#functions">Functions</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><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="main-heading"><h1 class="fqn">Crate <a class="mod" href="#">openssl</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/openssl/lib.rs.html#1-222">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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 |
| 3.x.x and LibreSSL versions 2.5 through 3.7.x are supported.</p> |
| <h2 id="building"><a href="#building">Building</a></h2> |
| <p>Both OpenSSL libraries and headers are required to build this crate. There are multiple options available to locate |
| OpenSSL.</p> |
| <h3 id="vendored"><a href="#vendored">Vendored</a></h3> |
| <p>If the <code>vendored</code> Cargo feature is enabled, the <code>openssl-src</code> 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 <em>not</em> considered breaking changes.</p> |
| <div class="example-wrap"><pre class="language-toml"><code>[dependencies] |
| openssl = { version = "0.10", features = ["vendored"] }</code></pre></div> |
| <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> |
| <h3 id="automatic"><a href="#automatic">Automatic</a></h3> |
| <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> |
| <div class="example-wrap"><pre class="language-not_rust"><code>$ brew install openssl@3 |
| |
| $ sudo port install openssl |
| |
| $ sudo pkgin install openssl |
| |
| $ sudo pacman -S pkg-config openssl |
| |
| $ sudo apt-get install pkg-config libssl-dev |
| |
| $ sudo dnf install pkg-config openssl-devel |
| |
| $ apk add pkgconfig openssl-dev</code></pre></div><h3 id="manual"><a href="#manual">Manual</a></h3> |
| <p>A set of environment variables can be used to point <code>openssl-sys</code> towards an OpenSSL installation. They will |
| override the automatic detection logic.</p> |
| <ul> |
| <li><code>OPENSSL_DIR</code> - If specified, the directory of an OpenSSL installation. The directory should contain <code>lib</code> and |
| <code>include</code> subdirectories containing the libraries and headers respectively.</li> |
| <li><code>OPENSSL_LIB_DIR</code> and <code>OPENSSL_INCLUDE_DIR</code> - 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.</li> |
| <li><code>OPENSSL_STATIC</code> - If set, the crate will statically link to OpenSSL rather than dynamically link.</li> |
| <li><code>OPENSSL_LIBS</code> - If set, a <code>:</code>-separated list of library names to link to (e.g. <code>ssl:crypto</code>). This can be used |
| if nonstandard library names were used for whatever reason.</li> |
| <li><code>OPENSSL_NO_VENDOR</code> - If set, always find OpenSSL in the system, even if the <code>vendored</code> feature is enabled.</li> |
| </ul> |
| <p>Additionally, these variables can be prefixed with the upper-cased target architecture (e.g. |
| <code>X86_64_UNKNOWN_LINUX_GNU_OPENSSL_DIR</code>), which can be useful when cross compiling.</p> |
| <h2 id="feature-detection"><a href="#feature-detection">Feature Detection</a></h2> |
| <p>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.</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> |
| <p>Cargo.toml:</p> |
| <div class="example-wrap"><pre class="language-toml"><code>[dependencies] |
| openssl-sys = "0.9" |
| openssl = "0.10"</code></pre></div> |
| <p>build.rs:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::env; |
| |
| <span class="kw">fn </span>main() { |
| <span class="kw">if let </span><span class="prelude-val">Ok</span>(v) = env::var(<span class="string">"DEP_OPENSSL_VERSION_NUMBER"</span>) { |
| <span class="kw">let </span>version = u64::from_str_radix(<span class="kw-2">&</span>v, <span class="number">16</span>).unwrap(); |
| |
| <span class="kw">if </span>version >= <span class="number">0x1_01_01_00_0 </span>{ |
| <span class="macro">println!</span>(<span class="string">"cargo:rustc-cfg=openssl111"</span>); |
| } |
| } |
| }</code></pre></div> |
| <p>lib.rs:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>openssl::ssl::{SslConnector, SslMethod}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>ctx = SslConnector::builder(SslMethod::tls()).unwrap(); |
| |
| <span class="comment">// set_ciphersuites was added in OpenSSL 1.1.1, so we can only call it when linking against that version |
| </span><span class="attribute">#[cfg(openssl111)] |
| </span>ctx.set_ciphersuites(<span class="string">"TLS_AES_256_GCM_SHA384:TLS_AES_128_GCM_SHA256"</span>).unwrap();</code></pre></div> |
| </div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="aes/index.html" title="openssl::aes mod">aes</a></div><div class="item-right docblock-short">Low level AES IGE and key wrapping functionality</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="asn1/index.html" title="openssl::asn1 mod">asn1</a></div><div class="item-right docblock-short">Defines the format of certificates</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="base64/index.html" title="openssl::base64 mod">base64</a></div><div class="item-right docblock-short">Base64 encoding support.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="bn/index.html" title="openssl::bn mod">bn</a></div><div class="item-right docblock-short">BigNum implementation</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="cipher/index.html" title="openssl::cipher mod">cipher</a></div><div class="item-right docblock-short">Symmetric ciphers.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="cipher_ctx/index.html" title="openssl::cipher_ctx mod">cipher_ctx</a></div><div class="item-right docblock-short">The symmetric encryption context.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="cms/index.html" title="openssl::cms mod">cms</a></div><div class="item-right docblock-short">SMIME implementation using CMS</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="conf/index.html" title="openssl::conf mod">conf</a></div><div class="item-right docblock-short">Interface for processing OpenSSL configuration files.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="derive/index.html" title="openssl::derive mod">derive</a></div><div class="item-right docblock-short">Shared secret derivation.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="dh/index.html" title="openssl::dh mod">dh</a></div><div class="item-right docblock-short">Diffie-Hellman key agreement.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="dsa/index.html" title="openssl::dsa mod">dsa</a></div><div class="item-right docblock-short">Digital Signatures</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="ec/index.html" title="openssl::ec mod">ec</a></div><div class="item-right docblock-short">Elliptic Curve</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="ecdsa/index.html" title="openssl::ecdsa mod">ecdsa</a></div><div class="item-right docblock-short">Low level Elliptic Curve Digital Signature Algorithm (ECDSA) functions.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="encrypt/index.html" title="openssl::encrypt mod">encrypt</a></div><div class="item-right docblock-short">Message encryption.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="envelope/index.html" title="openssl::envelope mod">envelope</a></div><div class="item-right docblock-short">Envelope encryption.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="error/index.html" title="openssl::error mod">error</a></div><div class="item-right docblock-short">Errors returned by OpenSSL library.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="ex_data/index.html" title="openssl::ex_data mod">ex_data</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="fips/index.html" title="openssl::fips mod">fips</a></div><div class="item-right docblock-short">FIPS 140-2 support.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="hash/index.html" title="openssl::hash mod">hash</a></div><div class="item-right docblock-short">Message digest (hash) computation support.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="md/index.html" title="openssl::md mod">md</a></div><div class="item-right docblock-short">Message digest algorithms.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="md_ctx/index.html" title="openssl::md_ctx mod">md_ctx</a></div><div class="item-right docblock-short">The message digest context.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="memcmp/index.html" title="openssl::memcmp mod">memcmp</a></div><div class="item-right docblock-short">Utilities to safely compare cryptographic values.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="nid/index.html" title="openssl::nid mod">nid</a></div><div class="item-right docblock-short">A collection of numerical identifiers for OpenSSL objects.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="ocsp/index.html" title="openssl::ocsp mod">ocsp</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="pkcs5/index.html" title="openssl::pkcs5 mod">pkcs5</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="pkcs7/index.html" title="openssl::pkcs7 mod">pkcs7</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="pkcs12/index.html" title="openssl::pkcs12 mod">pkcs12</a></div><div class="item-right docblock-short">PKCS #12 archives.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="pkey/index.html" title="openssl::pkey mod">pkey</a></div><div class="item-right docblock-short">Public/private key processing.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="pkey_ctx/index.html" title="openssl::pkey_ctx mod">pkey_ctx</a></div><div class="item-right docblock-short">The asymmetric encryption context.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="rand/index.html" title="openssl::rand mod">rand</a></div><div class="item-right docblock-short">Utilities for secure random number generation.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="rsa/index.html" title="openssl::rsa mod">rsa</a></div><div class="item-right docblock-short">Rivest–Shamir–Adleman cryptosystem</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="sha/index.html" title="openssl::sha mod">sha</a></div><div class="item-right docblock-short">The SHA family of hashes.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="sign/index.html" title="openssl::sign mod">sign</a></div><div class="item-right docblock-short">Message signatures.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="srtp/index.html" title="openssl::srtp mod">srtp</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="ssl/index.html" title="openssl::ssl mod">ssl</a></div><div class="item-right docblock-short">SSL/TLS support.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="stack/index.html" title="openssl::stack mod">stack</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="string/index.html" title="openssl::string mod">string</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="symm/index.html" title="openssl::symm mod">symm</a></div><div class="item-right docblock-short">High level interface to certain symmetric ciphers.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="version/index.html" title="openssl::version mod">version</a></div><div class="item-right docblock-short">Build and version information.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="x509/index.html" title="openssl::x509 mod">x509</a></div><div class="item-right docblock-short">The standard defining the format of public key certificates.</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.init.html" title="openssl::init fn">init</a></div></div></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> |
