| <!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."><meta name="keywords" content="rust, rustlang, rust-lang, KeyLog"><title>KeyLog in rustls - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.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><a class="sidebar-logo" href="../rustls/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../rustls/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><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 rustls</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Trait <a href="index.html">rustls</a>::<wbr><a class="trait" href="#">KeyLog</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/rustls/keylog.rs.html#27-58">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait KeyLog: Send + Sync { |
| fn <a href="#tymethod.log" class="fnname">log</a>(&self, label: &str, client_random: &[u8], secret: &[u8]); |
| |
| fn <a href="#method.will_log" class="fnname">will_log</a>(&self, _label: &str) -> bool { ... } |
| }</code></pre></div><details class="rustdoc-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 <code>KeyLogFile</code> that implements the standard <code>SSLKEYLOGFILE</code> |
| environment variable behaviour.</p> |
| </div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.log" class="method has-srclink"><a class="srclink rightside" href="../src/rustls/keylog.rs.html#48">source</a><h4 class="code-header">fn <a href="#tymethod.log" class="fnname">log</a>(&self, label: &str, client_random: &[u8], secret: &[u8])</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: |
| https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/Key_Log_Format</p> |
| </div></details></div><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.will_log" class="method has-srclink"><a class="srclink rightside" href="../src/rustls/keylog.rs.html#55-57">source</a><h4 class="code-header">fn <a href="#method.will_log" class="fnname">will_log</a>(&self, _label: &str) -> bool</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="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><section id="impl-KeyLog-for-KeyLogFile" class="impl has-srclink"><a class="srclink rightside" href="../src/rustls/keylog.rs.html#150-165">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 has-srclink"><a class="srclink rightside" href="../src/rustls/keylog.rs.html#63-69">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="../implementors/rustls/keylog/trait.KeyLog.js" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="rustls" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
