mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
26 lines
19 KiB
HTML
26 lines
19 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="API documentation for the Rust `SslContextExt` trait in crate `security_framework`."><meta name="keywords" content="rust, rustlang, rust-lang, SslContextExt"><title>security_framework::os::macos::secure_transport::SslContextExt - 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 trait"><!--[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='../../../../security_framework/index.html'><div class='logo-container rust-logo'><img src='../../../../rust-logo.png' alt='logo'></div></a><p class="location">Trait SslContextExt</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.diffie_hellman_params">diffie_hellman_params</a><a href="#tymethod.set_diffie_hellman_params">set_diffie_hellman_params</a><a href="#tymethod.certificate_authorities">certificate_authorities</a><a href="#tymethod.set_certificate_authorities">set_certificate_authorities</a><a href="#tymethod.add_certificate_authorities">add_certificate_authorities</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../../../index.html">security_framework</a>::<wbr><a href="../../index.html">os</a>::<wbr><a href="../index.html">macos</a>::<wbr><a href="index.html">secure_transport</a></p><div id="sidebar-vars" data-name="SslContextExt" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></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="in-band">Trait <a href="../../../index.html">security_framework</a>::<wbr><a href="../../index.html">os</a>::<wbr><a href="../index.html">macos</a>::<wbr><a href="index.html">secure_transport</a>::<wbr><a class="trait" href="">SslContextExt</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/security_framework/os/macos/secure_transport.rs.html#16-89" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait SslContextExt {
|
||
fn <a href="#tymethod.diffie_hellman_params" class="fnname">diffie_hellman_params</a>(&self) -> <a class="type" href="../../../../security_framework/base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.set_diffie_hellman_params" class="fnname">set_diffie_hellman_params</a>(&mut self, dh_params: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="type" href="../../../../security_framework/base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.certificate_authorities" class="fnname">certificate_authorities</a>(&self) -> <a class="type" href="../../../../security_framework/base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="../../../../security_framework/certificate/struct.SecCertificate.html" title="struct security_framework::certificate::SecCertificate">SecCertificate</a>>>>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.set_certificate_authorities" class="fnname">set_certificate_authorities</a>(<br> &mut self, <br> certs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="struct" href="../../../../security_framework/certificate/struct.SecCertificate.html" title="struct security_framework::certificate::SecCertificate">SecCertificate</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><br> ) -> <a class="type" href="../../../../security_framework/base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.add_certificate_authorities" class="fnname">add_certificate_authorities</a>(<br> &mut self, <br> certs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="struct" href="../../../../security_framework/certificate/struct.SecCertificate.html" title="struct security_framework::certificate::SecCertificate">SecCertificate</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><br> ) -> <a class="type" href="../../../../security_framework/base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>;
|
||
}</pre></div><div class="docblock"><p>An extension trait adding OSX specific functionality to the <code>SslContext</code>
|
||
type.</p>
|
||
</div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.diffie_hellman_params" class="method"><code>fn <a href="#tymethod.diffie_hellman_params" class="fnname">diffie_hellman_params</a>(&self) -> <a class="type" href="../../../../security_framework/base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>></code><a class="srclink" href="../../../../src/security_framework/os/macos/secure_transport.rs.html#19" title="goto source code">[src]</a></h3><div class="docblock"><p>Returns the DER encoded data specifying the parameters used for
|
||
Diffie-Hellman key exchange.</p>
|
||
</div><h3 id="tymethod.set_diffie_hellman_params" class="method"><code>fn <a href="#tymethod.set_diffie_hellman_params" class="fnname">set_diffie_hellman_params</a>(&mut self, dh_params: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="type" href="../../../../security_framework/base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class="srclink" href="../../../../src/security_framework/os/macos/secure_transport.rs.html#29" title="goto source code">[src]</a></h3><div class="docblock"><p>Sets the parameters used for Diffie-Hellman key exchange, in the
|
||
DER format used by OpenSSL.</p>
|
||
<p>If a cipher suite which uses Diffie-Hellman key exchange is selected,
|
||
parameters will automatically be generated if none are provided with
|
||
this method, but this process can take up to 30 seconds.</p>
|
||
<p>This can only be called on server-side sessions.</p>
|
||
</div><h3 id="tymethod.certificate_authorities" class="method"><code>fn <a href="#tymethod.certificate_authorities" class="fnname">certificate_authorities</a>(&self) -> <a class="type" href="../../../../security_framework/base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="../../../../security_framework/certificate/struct.SecCertificate.html" title="struct security_framework::certificate::SecCertificate">SecCertificate</a>>>></code><a class="srclink" href="../../../../src/security_framework/os/macos/secure_transport.rs.html#33" title="goto source code">[src]</a></h3><div class="docblock"><p>Returns the certificate authorities used to validate client
|
||
certificates.</p>
|
||
</div><h3 id="tymethod.set_certificate_authorities" class="method"><code>fn <a href="#tymethod.set_certificate_authorities" class="fnname">set_certificate_authorities</a>(<br> &mut self, <br> certs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="struct" href="../../../../security_framework/certificate/struct.SecCertificate.html" title="struct security_framework::certificate::SecCertificate">SecCertificate</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><br>) -> <a class="type" href="../../../../security_framework/base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class="srclink" href="../../../../src/security_framework/os/macos/secure_transport.rs.html#37" title="goto source code">[src]</a></h3><div class="docblock"><p>Sets the certificate authorities used to validate client certificates,
|
||
replacing any that are already present.</p>
|
||
</div><h3 id="tymethod.add_certificate_authorities" class="method"><code>fn <a href="#tymethod.add_certificate_authorities" class="fnname">add_certificate_authorities</a>(<br> &mut self, <br> certs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="struct" href="../../../../security_framework/certificate/struct.SecCertificate.html" title="struct security_framework::certificate::SecCertificate">SecCertificate</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><br>) -> <a class="type" href="../../../../security_framework/base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class="srclink" href="../../../../src/security_framework/os/macos/secure_transport.rs.html#40" title="goto source code">[src]</a></h3><div class="docblock"><p>Adds certificate authorities used to validate client certificates.</p>
|
||
</div></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><h3 id="impl-SslContextExt" class="impl"><code class="in-band">impl SslContextExt for <a class="struct" href="../../../../security_framework/secure_transport/struct.SslContext.html" title="struct security_framework::secure_transport::SslContext">SslContext</a></code><a href="#impl-SslContextExt" class="anchor"></a><a class="srclink" href="../../../../src/security_framework/os/macos/secure_transport.rs.html#115-192" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.diffie_hellman_params" class="method hidden"><code>fn <a href="#method.diffie_hellman_params" class="fnname">diffie_hellman_params</a>(&self) -> <a class="type" href="../../../../security_framework/base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>></code><a class="srclink" href="../../../../src/security_framework/os/macos/secure_transport.rs.html#116-131" title="goto source code">[src]</a></h4><h4 id="method.set_diffie_hellman_params" class="method hidden"><code>fn <a href="#method.set_diffie_hellman_params" class="fnname">set_diffie_hellman_params</a>(&mut self, dh_params: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="type" href="../../../../security_framework/base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class="srclink" href="../../../../src/security_framework/os/macos/secure_transport.rs.html#133-141" title="goto source code">[src]</a></h4><h4 id="method.certificate_authorities" class="method hidden"><code>fn <a href="#method.certificate_authorities" class="fnname">certificate_authorities</a>(&self) -> <a class="type" href="../../../../security_framework/base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="../../../../security_framework/certificate/struct.SecCertificate.html" title="struct security_framework::certificate::SecCertificate">SecCertificate</a>>>></code><a class="srclink" href="../../../../src/security_framework/os/macos/secure_transport.rs.html#143-160" title="goto source code">[src]</a></h4><h4 id="method.set_certificate_authorities" class="method hidden"><code>fn <a href="#method.set_certificate_authorities" class="fnname">set_certificate_authorities</a>(<br> &mut self, <br> certs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="struct" href="../../../../security_framework/certificate/struct.SecCertificate.html" title="struct security_framework::certificate::SecCertificate">SecCertificate</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><br>) -> <a class="type" href="../../../../security_framework/base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class="srclink" href="../../../../src/security_framework/os/macos/secure_transport.rs.html#162-171" title="goto source code">[src]</a></h4><h4 id="method.add_certificate_authorities" class="method hidden"><code>fn <a href="#method.add_certificate_authorities" class="fnname">add_certificate_authorities</a>(<br> &mut self, <br> certs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="struct" href="../../../../security_framework/certificate/struct.SecCertificate.html" title="struct security_framework::certificate::SecCertificate">SecCertificate</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><br>) -> <a class="type" href="../../../../security_framework/base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class="srclink" href="../../../../src/security_framework/os/macos/secure_transport.rs.html#173-182" title="goto source code">[src]</a></h4></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../../../implementors/security_framework/os/macos/secure_transport/trait.SslContextExt.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="security_framework"></div>
|
||
<script src="../../../../main.js"></script><script defer src="../../../../search-index.js"></script></body></html> |