mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
41 lines
9.8 KiB
HTML
41 lines
9.8 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="This trait represents the ability to do something useful with key material, such as logging it to a file for debugging."><title>KeyLog in rustls - 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="rustls" 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="../rustls/index.html">rustls</a><span class="version">0.21.7</span></h2></div><h2 class="location"><a href="#">KeyLog</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.log">log</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.will_log">will_log</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In crate rustls</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="../rustls/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">rustls</a>::<wbr><a class="trait" href="#">KeyLog</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/rustls/key_log.rs.html#13-44">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait KeyLog: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> {
|
||
// Required method
|
||
fn <a href="#tymethod.log" class="fn">log</a>(&self, label: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>, client_random: &[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>], secret: &[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>]);
|
||
|
||
// Provided method
|
||
fn <a href="#method.will_log" class="fn">will_log</a>(&self, _label: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a> { ... }
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This trait represents the ability to do something useful
|
||
with key material, such as logging it to a file for debugging.</p>
|
||
<p>Naturally, secrets passed over the interface are <em>extremely</em>
|
||
sensitive and can break the security of past, present and
|
||
future sessions.</p>
|
||
<p>You’ll likely want some interior mutability in your
|
||
implementation to make this useful.</p>
|
||
<p>See <a href="struct.KeyLogFile.html" title="struct rustls::KeyLogFile"><code>KeyLogFile</code></a> that implements the standard
|
||
<code>SSLKEYLOGFILE</code> environment variable behaviour.</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.log" class="method"><a class="src rightside" href="../src/rustls/key_log.rs.html#34">source</a><h4 class="code-header">fn <a href="#tymethod.log" class="fn">log</a>(&self, label: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>, client_random: &[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>], secret: &[<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>Log the given <code>secret</code>. <code>client_random</code> is provided for
|
||
session identification. <code>label</code> describes precisely what
|
||
<code>secret</code> means:</p>
|
||
<ul>
|
||
<li><code>CLIENT_RANDOM</code>: <code>secret</code> is the master secret for a TLSv1.2 session.</li>
|
||
<li><code>CLIENT_EARLY_TRAFFIC_SECRET</code>: <code>secret</code> encrypts early data
|
||
transmitted by a client</li>
|
||
<li><code>SERVER_HANDSHAKE_TRAFFIC_SECRET</code>: <code>secret</code> encrypts
|
||
handshake messages from the server during a TLSv1.3 handshake.</li>
|
||
<li><code>CLIENT_HANDSHAKE_TRAFFIC_SECRET</code>: <code>secret</code> encrypts
|
||
handshake messages from the client during a TLSv1.3 handshake.</li>
|
||
<li><code>SERVER_TRAFFIC_SECRET_0</code>: <code>secret</code> encrypts post-handshake data
|
||
from the server in a TLSv1.3 session.</li>
|
||
<li><code>CLIENT_TRAFFIC_SECRET_0</code>: <code>secret</code> encrypts post-handshake data
|
||
from the client in a TLSv1.3 session.</li>
|
||
<li><code>EXPORTER_SECRET</code>: <code>secret</code> is the post-handshake exporter secret
|
||
in a TLSv1.3 session.</li>
|
||
</ul>
|
||
<p>These strings are selected to match the NSS key log format:
|
||
<a href="https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/Key_Log_Format">https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/Key_Log_Format</a></p>
|
||
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.will_log" class="method"><a class="src rightside" href="../src/rustls/key_log.rs.html#41-43">source</a><h4 class="code-header">fn <a href="#method.will_log" class="fn">will_log</a>(&self, _label: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Indicates whether the secret with label <code>label</code> will be logged.</p>
|
||
<p>If <code>will_log</code> returns true then <code>log</code> will be called with the secret.
|
||
Otherwise, <code>log</code> will not be called for the secret. This is a
|
||
performance optimization.</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-KeyLog-for-KeyLogFile" class="impl"><a class="src rightside" href="../src/rustls/key_log_file.rs.html#90-105">source</a><a href="#impl-KeyLog-for-KeyLogFile" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.KeyLog.html" title="trait rustls::KeyLog">KeyLog</a> for <a class="struct" href="struct.KeyLogFile.html" title="struct rustls::KeyLogFile">KeyLogFile</a></h3></section><section id="impl-KeyLog-for-NoKeyLog" class="impl"><a class="src rightside" href="../src/rustls/key_log.rs.html#49-55">source</a><a href="#impl-KeyLog-for-NoKeyLog" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.KeyLog.html" title="trait rustls::KeyLog">KeyLog</a> for <a class="struct" href="struct.NoKeyLog.html" title="struct rustls::NoKeyLog">NoKeyLog</a></h3></section></div><script src="../trait.impl/rustls/key_log/trait.KeyLog.js" async></script></section></div></main></body></html> |