mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-27 04:10:02 +01:00
61 lines
12 KiB
HTML
61 lines
12 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="SSL/TLS encryption support using Secure Transport."><title>security_framework::secure_transport - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="security_framework" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[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></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../security_framework/index.html">security_framework</a><span class="version">2.9.2</span></h2></div><h2 class="location"><a href="#">Module secure_transport</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></section><h2><a href="../index.html">In crate security_framework</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../security_framework/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">security_framework</a>::<wbr><a class="mod" href="#">secure_transport</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/security_framework/secure_transport.rs.html#1-1848">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>SSL/TLS encryption support using Secure Transport.</p>
|
||
<h2 id="examples"><a href="#examples">Examples</a></h2>
|
||
<p>To connect as a client to a server with a certificate trusted by the system:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::io::prelude::<span class="kw-2">*</span>;
|
||
<span class="kw">use </span>std::net::TcpStream;
|
||
<span class="kw">use </span>security_framework::secure_transport::ClientBuilder;
|
||
|
||
<span class="kw">let </span>stream = TcpStream::connect(<span class="string">"google.com:443"</span>).unwrap();
|
||
<span class="kw">let </span><span class="kw-2">mut </span>stream = ClientBuilder::new().handshake(<span class="string">"google.com"</span>, stream).unwrap();
|
||
|
||
stream.write_all(<span class="string">b"GET / HTTP/1.0\r\n\r\n"</span>).unwrap();
|
||
<span class="kw">let </span><span class="kw-2">mut </span>page = <span class="macro">vec!</span>[];
|
||
stream.read_to_end(<span class="kw-2">&mut </span>page).unwrap();
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, String::from_utf8_lossy(<span class="kw-2">&</span>page));</code></pre></div>
|
||
<p>To connect to a server with a certificate that’s <em>not</em> trusted by the
|
||
system, specify the root certificates for the server’s chain to the
|
||
<code>ClientBuilder</code>:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::io::prelude::<span class="kw-2">*</span>;
|
||
<span class="kw">use </span>std::net::TcpStream;
|
||
<span class="kw">use </span>security_framework::secure_transport::ClientBuilder;
|
||
|
||
<span class="kw">let </span>stream = TcpStream::connect(<span class="string">"my_server.com:443"</span>).unwrap();
|
||
<span class="kw">let </span><span class="kw-2">mut </span>stream = ClientBuilder::new()
|
||
.anchor_certificates(<span class="kw-2">&</span>[root_cert])
|
||
.handshake(<span class="string">"my_server.com"</span>, stream)
|
||
.unwrap();
|
||
|
||
stream.write_all(<span class="string">b"GET / HTTP/1.0\r\n\r\n"</span>).unwrap();
|
||
<span class="kw">let </span><span class="kw-2">mut </span>page = <span class="macro">vec!</span>[];
|
||
stream.read_to_end(<span class="kw-2">&mut </span>page).unwrap();
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, String::from_utf8_lossy(<span class="kw-2">&</span>page));</code></pre></div>
|
||
<p>For more advanced configuration, the <code>SslContext</code> type can be used directly.</p>
|
||
<p>To run a server:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::net::TcpListener;
|
||
<span class="kw">use </span>std::thread;
|
||
<span class="kw">use </span>security_framework::secure_transport::{SslContext, SslProtocolSide, SslConnectionType};
|
||
|
||
<span class="comment">// Create a TCP listener and start accepting on it.
|
||
</span><span class="kw">let </span><span class="kw-2">mut </span>listener = TcpListener::bind(<span class="string">"0.0.0.0:443"</span>).unwrap();
|
||
|
||
<span class="kw">for </span>stream <span class="kw">in </span>listener.incoming() {
|
||
<span class="kw">let </span>stream = stream.unwrap();
|
||
thread::spawn(<span class="kw">move </span>|| {
|
||
<span class="comment">// Create a new context configured to operate on the server side of
|
||
// a traditional SSL/TLS session.
|
||
</span><span class="kw">let </span><span class="kw-2">mut </span>ctx = SslContext::new(SslProtocolSide::SERVER, SslConnectionType::STREAM)
|
||
.unwrap();
|
||
|
||
<span class="comment">// Install the certificate chain that we will be using.
|
||
</span>ctx.set_certificate(identity, <span class="kw-2">&</span>[intermediate_cert, root_cert]).unwrap();
|
||
|
||
<span class="comment">// Perform the SSL/TLS handshake and get our stream.
|
||
</span><span class="kw">let </span><span class="kw-2">mut </span>stream = ctx.handshake(stream).unwrap();
|
||
});
|
||
}
|
||
</code></pre></div>
|
||
</div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.ClientBuilder.html" title="struct security_framework::secure_transport::ClientBuilder">ClientBuilder</a></div><div class="desc docblock-short">A builder type to simplify the creation of client side <code>SslStream</code>s.</div></li><li><div class="item-name"><a class="struct" href="struct.MidHandshakeClientBuilder.html" title="struct security_framework::secure_transport::MidHandshakeClientBuilder">MidHandshakeClientBuilder</a></div><div class="desc docblock-short">An SSL stream midway through the handshake process.</div></li><li><div class="item-name"><a class="struct" href="struct.MidHandshakeSslStream.html" title="struct security_framework::secure_transport::MidHandshakeSslStream">MidHandshakeSslStream</a></div><div class="desc docblock-short">An SSL stream midway through the handshake process.</div></li><li><div class="item-name"><a class="struct" href="struct.ServerBuilder.html" title="struct security_framework::secure_transport::ServerBuilder">ServerBuilder</a></div><div class="desc docblock-short">A builder type to simplify the creation of server-side <code>SslStream</code>s.</div></li><li><div class="item-name"><a class="struct" href="struct.SessionState.html" title="struct security_framework::secure_transport::SessionState">SessionState</a></div><div class="desc docblock-short">Specifies the state of a TLS session.</div></li><li><div class="item-name"><a class="struct" href="struct.SslAuthenticate.html" title="struct security_framework::secure_transport::SslAuthenticate">SslAuthenticate</a></div><div class="desc docblock-short">Specifies a server’s requirement for client certificates.</div></li><li><div class="item-name"><a class="struct" href="struct.SslClientCertificateState.html" title="struct security_framework::secure_transport::SslClientCertificateState">SslClientCertificateState</a></div><div class="desc docblock-short">Specifies the state of client certificate processing.</div></li><li><div class="item-name"><a class="struct" href="struct.SslConnectionType.html" title="struct security_framework::secure_transport::SslConnectionType">SslConnectionType</a></div><div class="desc docblock-short">Specifies the type of TLS session.</div></li><li><div class="item-name"><a class="struct" href="struct.SslContext.html" title="struct security_framework::secure_transport::SslContext">SslContext</a></div><div class="desc docblock-short">A Secure Transport SSL/TLS context object.</div></li><li><div class="item-name"><a class="struct" href="struct.SslProtocol.html" title="struct security_framework::secure_transport::SslProtocol">SslProtocol</a></div><div class="desc docblock-short">Specifies protocol versions.</div></li><li><div class="item-name"><a class="struct" href="struct.SslProtocolSide.html" title="struct security_framework::secure_transport::SslProtocolSide">SslProtocolSide</a></div><div class="desc docblock-short">Specifies a side of a TLS session.</div></li><li><div class="item-name"><a class="struct" href="struct.SslStream.html" title="struct security_framework::secure_transport::SslStream">SslStream</a></div><div class="desc docblock-short">A type implementing SSL/TLS encryption over an underlying stream.</div></li></ul><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.ClientHandshakeError.html" title="enum security_framework::secure_transport::ClientHandshakeError">ClientHandshakeError</a></div><div class="desc docblock-short">An error or intermediate state after a TLS handshake attempt.</div></li><li><div class="item-name"><a class="enum" href="enum.HandshakeError.html" title="enum security_framework::secure_transport::HandshakeError">HandshakeError</a></div><div class="desc docblock-short">An error or intermediate state after a TLS handshake attempt.</div></li></ul></section></div></main></body></html> |