blob: ba28d7afddd0c25ba7b11a6b1e5524418e8a2395 [file] [log] [blame]
<!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 abstract signing key."><meta name="keywords" content="rust, rustlang, rust-lang, SigningKey"><title>SigningKey in rustls::sign - 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">&#9776;</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="#">SigningKey</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.algorithm">algorithm</a></li><li><a href="#tymethod.choose_scheme">choose_scheme</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In rustls::sign</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 href="index.html">sign</a>::<wbr><a class="trait" href="#">SigningKey</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/sign.rs.html#15-24">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait SigningKey: <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.choose_scheme" class="fnname">choose_scheme</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;self,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;offered: &amp;[<a class="enum" href="../internal/msgs/enums/enum.SignatureScheme.html" title="enum rustls::internal::msgs::enums::SignatureScheme">SignatureScheme</a>]<br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="trait.Signer.html" title="trait rustls::sign::Signer">Signer</a>&gt;&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.algorithm" class="fnname">algorithm</a>(&amp;self) -&gt; <a class="enum" href="../internal/msgs/enums/enum.SignatureAlgorithm.html" title="enum rustls::internal::msgs::enums::SignatureAlgorithm">SignatureAlgorithm</a>;
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An abstract signing key.</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.choose_scheme" class="method has-srclink"><a class="srclink rightside" href="../../src/rustls/sign.rs.html#20">source</a><h4 class="code-header">fn <a href="#tymethod.choose_scheme" class="fnname">choose_scheme</a>(&amp;self, offered: &amp;[<a class="enum" href="../internal/msgs/enums/enum.SignatureScheme.html" title="enum rustls::internal::msgs::enums::SignatureScheme">SignatureScheme</a>]) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="trait.Signer.html" title="trait rustls::sign::Signer">Signer</a>&gt;&gt;</h4></section></summary><div class="docblock"><p>Choose a <code>SignatureScheme</code> from those offered.</p>
<p>Expresses the choice by returning something that implements <code>Signer</code>,
using the chosen scheme.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.algorithm" class="method has-srclink"><a class="srclink rightside" href="../../src/rustls/sign.rs.html#23">source</a><h4 class="code-header">fn <a href="#tymethod.algorithm" class="fnname">algorithm</a>(&amp;self) -&gt; <a class="enum" href="../internal/msgs/enums/enum.SignatureAlgorithm.html" title="enum rustls::internal::msgs::enums::SignatureAlgorithm">SignatureAlgorithm</a></h4></section></summary><div class="docblock"><p>What kind of key we have.</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-SigningKey-for-RSASigningKey" class="impl has-srclink"><a class="srclink rightside" href="../../src/rustls/sign.rs.html#217-229">source</a><a href="#impl-SigningKey-for-RSASigningKey" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.SigningKey.html" title="trait rustls::sign::SigningKey">SigningKey</a> for <a class="struct" href="struct.RSASigningKey.html" title="struct rustls::sign::RSASigningKey">RSASigningKey</a></h3></section></div><script src="../../implementors/rustls/sign/trait.SigningKey.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>