mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-29 05:12:45 +01:00
31 lines
10 KiB
HTML
31 lines
10 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 `ProducesTickets` trait in crate `rustls`."><meta name="keywords" content="rust, rustlang, rust-lang, ProducesTickets"><title>rustls::ProducesTickets - 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='../rustls/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Trait ProducesTickets</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.decrypt">decrypt</a><a href="#tymethod.encrypt">encrypt</a><a href="#tymethod.enabled">enabled</a><a href="#tymethod.get_lifetime">get_lifetime</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="index.html">rustls</a></p><div id="sidebar-vars" data-name="ProducesTickets" 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">rustls</a>::<wbr><a class="trait" href="">ProducesTickets</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/rustls/server/mod.rs.html#63-93" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait ProducesTickets: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> {
|
||
fn <a href="#tymethod.enabled" class="fnname">enabled</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.get_lifetime" class="fnname">get_lifetime</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.encrypt" class="fnname">encrypt</a>(&self, plain: <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="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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.decrypt" class="fnname">decrypt</a>(&self, cipher: <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="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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>>;
|
||
}</pre></div><div class="docblock"><p>A trait for the ability to encrypt and decrypt tickets.</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.enabled" class="method"><code>fn <a href="#tymethod.enabled" class="fnname">enabled</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../src/rustls/server/mod.rs.html#68" title="goto source code">[src]</a></h3><div class="docblock"><p>Returns true if this implementation will encrypt/decrypt
|
||
tickets. Should return false if this is a dummy
|
||
implementation: the server will not send the SessionTicket
|
||
extension and will not call the other functions.</p>
|
||
</div><h3 id="tymethod.get_lifetime" class="method"><code>fn <a href="#tymethod.get_lifetime" class="fnname">get_lifetime</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code><a class="srclink" href="../src/rustls/server/mod.rs.html#79" title="goto source code">[src]</a></h3><div class="docblock"><p>Returns the lifetime in seconds of tickets produced now.
|
||
The lifetime is provided as a hint to clients that the
|
||
ticket will not be useful after the given time.</p>
|
||
<p>This lifetime must be implemented by key rolling and
|
||
erasure, <em>not</em> by storing a lifetime in the ticket.</p>
|
||
<p>The objective is to limit damage to forward secrecy caused
|
||
by tickets, not just limiting their lifetime.</p>
|
||
</div><h3 id="tymethod.encrypt" class="method"><code>fn <a href="#tymethod.encrypt" class="fnname">encrypt</a>(&self, plain: <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="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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>></code><a class="srclink" href="../src/rustls/server/mod.rs.html#85" title="goto source code">[src]</a></h3><div class="docblock"><p>Encrypt and authenticate <code>plain</code>, returning the resulting
|
||
ticket. Return None if <code>plain</code> cannot be encrypted for
|
||
some reason: an empty ticket will be sent and the connection
|
||
will continue.</p>
|
||
</div><h3 id="tymethod.decrypt" class="method"><code>fn <a href="#tymethod.decrypt" class="fnname">decrypt</a>(&self, cipher: <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="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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>></code><a class="srclink" href="../src/rustls/server/mod.rs.html#92" title="goto source code">[src]</a></h3><div class="docblock"><p>Decrypt <code>cipher</code>, validating its authenticity protection
|
||
and recovering the plaintext. <code>cipher</code> is fully attacker
|
||
controlled, so this decryption must be side-channel free,
|
||
panic-proof, and otherwise bullet-proof. If the decryption
|
||
fails, return None.</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"></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../implementors/rustls/trait.ProducesTickets.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="rustls"></div>
|
||
<script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |