mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
36 lines
14 KiB
HTML
36 lines
14 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="An extension trait adding OSX specific functionality to the `SslContext` type."><title>SslContextExt in security_framework::os::macos::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 trait"><!--[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="#">SslContextExt</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.add_certificate_authorities">add_certificate_authorities</a></li><li><a href="#tymethod.certificate_authorities">certificate_authorities</a></li><li><a href="#tymethod.diffie_hellman_params">diffie_hellman_params</a></li><li><a href="#tymethod.set_certificate_authorities">set_certificate_authorities</a></li><li><a href="#tymethod.set_diffie_hellman_params">set_diffie_hellman_params</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In security_framework::os::macos::secure_transport</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>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><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/os/macos/secure_transport.rs.html#16-89">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait SslContextExt {
|
||
// Required methods
|
||
fn <a href="#tymethod.diffie_hellman_params" class="fn">diffie_hellman_params</a>(&self) -> <a class="type" href="../../../base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>]>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.set_diffie_hellman_params" class="fn">set_diffie_hellman_params</a>(&mut self, dh_params: &[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>]) -> <a class="type" href="../../../base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.certificate_authorities" class="fn">certificate_authorities</a>(&self) -> <a class="type" href="../../../base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="../../../certificate/struct.SecCertificate.html" title="struct security_framework::certificate::SecCertificate">SecCertificate</a>>>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.set_certificate_authorities" class="fn">set_certificate_authorities</a>(
|
||
&mut self,
|
||
certs: &[<a class="struct" href="../../../certificate/struct.SecCertificate.html" title="struct security_framework::certificate::SecCertificate">SecCertificate</a>]
|
||
) -> <a class="type" href="../../../base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.add_certificate_authorities" class="fn">add_certificate_authorities</a>(
|
||
&mut self,
|
||
certs: &[<a class="struct" href="../../../certificate/struct.SecCertificate.html" title="struct security_framework::certificate::SecCertificate">SecCertificate</a>]
|
||
) -> <a class="type" href="../../../base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An extension trait adding OSX specific functionality to the <code>SslContext</code>
|
||
type.</p>
|
||
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.diffie_hellman_params" class="method"><a class="src rightside" href="../../../../src/security_framework/os/macos/secure_transport.rs.html#19">source</a><h4 class="code-header">fn <a href="#tymethod.diffie_hellman_params" class="fn">diffie_hellman_params</a>(&self) -> <a class="type" href="../../../base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>]>></h4></section></summary><div class="docblock"><p>Returns the DER encoded data specifying the parameters used for
|
||
Diffie-Hellman key exchange.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.set_diffie_hellman_params" class="method"><a class="src rightside" href="../../../../src/security_framework/os/macos/secure_transport.rs.html#29">source</a><h4 class="code-header">fn <a href="#tymethod.set_diffie_hellman_params" class="fn">set_diffie_hellman_params</a>(&mut self, dh_params: &[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>]) -> <a class="type" href="../../../base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>></h4></section></summary><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></details><details class="toggle method-toggle" open><summary><section id="tymethod.certificate_authorities" class="method"><a class="src rightside" href="../../../../src/security_framework/os/macos/secure_transport.rs.html#33">source</a><h4 class="code-header">fn <a href="#tymethod.certificate_authorities" class="fn">certificate_authorities</a>(&self) -> <a class="type" href="../../../base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="../../../certificate/struct.SecCertificate.html" title="struct security_framework::certificate::SecCertificate">SecCertificate</a>>>></h4></section></summary><div class="docblock"><p>Returns the certificate authorities used to validate client
|
||
certificates.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.set_certificate_authorities" class="method"><a class="src rightside" href="../../../../src/security_framework/os/macos/secure_transport.rs.html#37">source</a><h4 class="code-header">fn <a href="#tymethod.set_certificate_authorities" class="fn">set_certificate_authorities</a>(
|
||
&mut self,
|
||
certs: &[<a class="struct" href="../../../certificate/struct.SecCertificate.html" title="struct security_framework::certificate::SecCertificate">SecCertificate</a>]
|
||
) -> <a class="type" href="../../../base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Sets the certificate authorities used to validate client certificates,
|
||
replacing any that are already present.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.add_certificate_authorities" class="method"><a class="src rightside" href="../../../../src/security_framework/os/macos/secure_transport.rs.html#40">source</a><h4 class="code-header">fn <a href="#tymethod.add_certificate_authorities" class="fn">add_certificate_authorities</a>(
|
||
&mut self,
|
||
certs: &[<a class="struct" href="../../../certificate/struct.SecCertificate.html" title="struct security_framework::certificate::SecCertificate">SecCertificate</a>]
|
||
) -> <a class="type" href="../../../base/type.Result.html" title="type security_framework::base::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Adds certificate authorities used to validate client certificates.</p>
|
||
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-SslContextExt-for-SslContext" class="impl"><a class="src rightside" href="../../../../src/security_framework/os/macos/secure_transport.rs.html#115-192">source</a><a href="#impl-SslContextExt-for-SslContext" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SslContextExt.html" title="trait security_framework::os::macos::secure_transport::SslContextExt">SslContextExt</a> for <a class="struct" href="../../../secure_transport/struct.SslContext.html" title="struct security_framework::secure_transport::SslContext">SslContext</a></h3></section></div><script src="../../../../trait.impl/security_framework/os/macos/secure_transport/trait.SslContextExt.js" async></script></section></div></main></body></html> |