| <!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 ECDSA key pair, used for signing."><meta name="keywords" content="rust, rustlang, rust-lang, EcdsaKeyPair"><title>EcdsaKeyPair in ring::signature - 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 struct"><!--[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="../../ring/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="../../ring/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">EcdsaKeyPair</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.from_pkcs8">from_pkcs8</a></li><li><a href="#method.from_private_key_and_public_key">from_private_key_and_public_key</a></li><li><a href="#method.generate_pkcs8">generate_pkcs8</a></li><li><a href="#method.sign">sign</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Debug-for-EcdsaKeyPair">Debug</a></li><li><a href="#impl-KeyPair-for-EcdsaKeyPair">KeyPair</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-EcdsaKeyPair">RefUnwindSafe</a></li><li><a href="#impl-Send-for-EcdsaKeyPair">Send</a></li><li><a href="#impl-Sync-for-EcdsaKeyPair">Sync</a></li><li><a href="#impl-Unpin-for-EcdsaKeyPair">Unpin</a></li><li><a href="#impl-UnwindSafe-for-EcdsaKeyPair">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-EcdsaKeyPair">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-EcdsaKeyPair">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-EcdsaKeyPair">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-EcdsaKeyPair">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-EcdsaKeyPair">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-EcdsaKeyPair">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-EcdsaKeyPair">TryInto<U></a></li></ul></section><h2><a href="index.html">In ring::signature</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">Struct <a href="../index.html">ring</a>::<wbr><a href="index.html">signature</a>::<wbr><a class="struct" href="#">EcdsaKeyPair</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/ring/ec/suite_b/ecdsa/signing.rs.html#61-66">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 struct"><code>pub struct EcdsaKeyPair { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An ECDSA key pair, used for signing.</p> |
| </div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-EcdsaKeyPair" class="impl has-srclink"><a class="srclink rightside" href="../../src/ring/ec/suite_b/ecdsa/signing.rs.html#70-283">source</a><a href="#impl-EcdsaKeyPair" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.EcdsaKeyPair.html" title="struct ring::signature::EcdsaKeyPair">EcdsaKeyPair</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.generate_pkcs8" class="method has-srclink"><a class="srclink rightside" href="../../src/ring/ec/suite_b/ecdsa/signing.rs.html#82-93">source</a><h4 class="code-header">pub fn <a href="#method.generate_pkcs8" class="fnname">generate_pkcs8</a>(<br> alg: &'static <a class="struct" href="struct.EcdsaSigningAlgorithm.html" title="struct ring::signature::EcdsaSigningAlgorithm">EcdsaSigningAlgorithm</a>,<br> rng: &dyn <a class="trait" href="../rand/trait.SecureRandom.html" title="trait ring::rand::SecureRandom">SecureRandom</a><br>) -> Result<<a class="struct" href="../pkcs8/struct.Document.html" title="struct ring::pkcs8::Document">Document</a>, <a class="struct" href="../error/struct.Unspecified.html" title="struct ring::error::Unspecified">Unspecified</a>></h4></section></summary><div class="docblock"><p>Generates a new key pair and returns the key pair serialized as a |
| PKCS#8 document.</p> |
| <p>The PKCS#8 document will be a v1 <code>OneAsymmetricKey</code> with the public key |
| included in the <code>ECPrivateKey</code> structure, as described in |
| <a href="https://tools.ietf.org/html/rfc5958#section-2">RFC 5958 Section 2</a> and <a href="https://tools.ietf.org/html/rfc5915">RFC 5915</a>. The <code>ECPrivateKey</code> structure will |
| not have a <code>parameters</code> field so the generated key is compatible with |
| PKCS#11.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_pkcs8" class="method has-srclink"><a class="srclink rightside" href="../../src/ring/ec/suite_b/ecdsa/signing.rs.html#105-117">source</a><h4 class="code-header">pub fn <a href="#method.from_pkcs8" class="fnname">from_pkcs8</a>(<br> alg: &'static <a class="struct" href="struct.EcdsaSigningAlgorithm.html" title="struct ring::signature::EcdsaSigningAlgorithm">EcdsaSigningAlgorithm</a>,<br> pkcs8: &[u8]<br>) -> Result<Self, <a class="struct" href="../error/struct.KeyRejected.html" title="struct ring::error::KeyRejected">KeyRejected</a>></h4></section></summary><div class="docblock"><p>Constructs an ECDSA key pair by parsing an unencrypted PKCS#8 v1 |
| id-ecPublicKey <code>ECPrivateKey</code> key.</p> |
| <p>The input must be in PKCS#8 v1 format. It must contain the public key in |
| the <code>ECPrivateKey</code> structure; <code>from_pkcs8()</code> will verify that the public |
| key and the private key are consistent with each other. The algorithm |
| identifier must identify the curve by name; it must not use an |
| “explicit” encoding of the curve. The <code>parameters</code> field of the |
| <code>ECPrivateKey</code>, if present, must be the same named curve that is in the |
| algorithm identifier in the PKCS#8 header.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_private_key_and_public_key" class="method has-srclink"><a class="srclink rightside" href="../../src/ring/ec/suite_b/ecdsa/signing.rs.html#135-148">source</a><h4 class="code-header">pub fn <a href="#method.from_private_key_and_public_key" class="fnname">from_private_key_and_public_key</a>(<br> alg: &'static <a class="struct" href="struct.EcdsaSigningAlgorithm.html" title="struct ring::signature::EcdsaSigningAlgorithm">EcdsaSigningAlgorithm</a>,<br> private_key: &[u8],<br> public_key: &[u8]<br>) -> Result<Self, <a class="struct" href="../error/struct.KeyRejected.html" title="struct ring::error::KeyRejected">KeyRejected</a>></h4></section></summary><div class="docblock"><p>Constructs an ECDSA key pair from the private key and public key bytes</p> |
| <p>The private key must encoded as a big-endian fixed-length integer. For |
| example, a P-256 private key must be 32 bytes prefixed with leading |
| zeros as needed.</p> |
| <p>The public key is encoding in uncompressed form using the |
| Octet-String-to-Elliptic-Curve-Point algorithm in |
| <a href="http://www.secg.org/sec1-v2.pdf">SEC 1: Elliptic Curve Cryptography, Version 2.0</a>.</p> |
| <p>This is intended for use by code that deserializes key pairs. It is |
| recommended to use <code>EcdsaKeyPair::from_pkcs8()</code> (with a PKCS#8-encoded |
| key) instead.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.sign" class="method has-srclink"><a class="srclink rightside" href="../../src/ring/ec/suite_b/ecdsa/signing.rs.html#173-191">source</a><h4 class="code-header">pub fn <a href="#method.sign" class="fnname">sign</a>(<br> &self,<br> rng: &dyn <a class="trait" href="../rand/trait.SecureRandom.html" title="trait ring::rand::SecureRandom">SecureRandom</a>,<br> message: &[u8]<br>) -> Result<<a class="struct" href="struct.Signature.html" title="struct ring::signature::Signature">Signature</a>, <a class="struct" href="../error/struct.Unspecified.html" title="struct ring::error::Unspecified">Unspecified</a>></h4></section></summary><div class="docblock"><p>Deprecated. Returns the signature of the <code>message</code> using a random nonce |
| generated by <code>rng</code>.</p> |
| </div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-EcdsaKeyPair" class="impl has-srclink"><a class="srclink rightside" href="../../src/ring/ec/suite_b/ecdsa/signing.rs.html#68">source</a><a href="#impl-Debug-for-EcdsaKeyPair" class="anchor"></a><h3 class="code-header">impl Debug for <a class="struct" href="struct.EcdsaKeyPair.html" title="struct ring::signature::EcdsaKeyPair">EcdsaKeyPair</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/ring/ec/suite_b/ecdsa/signing.rs.html#68">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&self, f: &mut Formatter<'_>) -> Result<(), Error></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-KeyPair-for-EcdsaKeyPair" class="impl has-srclink"><a class="srclink rightside" href="../../src/ring/ec/suite_b/ecdsa/signing.rs.html#365-371">source</a><a href="#impl-KeyPair-for-EcdsaKeyPair" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.KeyPair.html" title="trait ring::signature::KeyPair">KeyPair</a> for <a class="struct" href="struct.EcdsaKeyPair.html" title="struct ring::signature::EcdsaKeyPair">EcdsaKeyPair</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.PublicKey" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.PublicKey" class="anchor"></a><h4 class="code-header">type <a href="trait.KeyPair.html#associatedtype.PublicKey" class="associatedtype">PublicKey</a> = PublicKey</h4></section></summary><div class='docblock'>The type of the public key.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.public_key" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/ring/ec/suite_b/ecdsa/signing.rs.html#368-370">source</a><a href="#method.public_key" class="anchor"></a><h4 class="code-header">fn <a href="trait.KeyPair.html#tymethod.public_key" class="fnname">public_key</a>(&self) -> &Self::<a class="associatedtype" href="trait.KeyPair.html#associatedtype.PublicKey" title="type ring::signature::KeyPair::PublicKey">PublicKey</a></h4></section></summary><div class='docblock'>The public key for the key pair.</div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-EcdsaKeyPair" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-EcdsaKeyPair" class="anchor"></a><h3 class="code-header">impl RefUnwindSafe for <a class="struct" href="struct.EcdsaKeyPair.html" title="struct ring::signature::EcdsaKeyPair">EcdsaKeyPair</a></h3></section><section id="impl-Send-for-EcdsaKeyPair" class="impl has-srclink"><a href="#impl-Send-for-EcdsaKeyPair" class="anchor"></a><h3 class="code-header">impl Send for <a class="struct" href="struct.EcdsaKeyPair.html" title="struct ring::signature::EcdsaKeyPair">EcdsaKeyPair</a></h3></section><section id="impl-Sync-for-EcdsaKeyPair" class="impl has-srclink"><a href="#impl-Sync-for-EcdsaKeyPair" class="anchor"></a><h3 class="code-header">impl Sync for <a class="struct" href="struct.EcdsaKeyPair.html" title="struct ring::signature::EcdsaKeyPair">EcdsaKeyPair</a></h3></section><section id="impl-Unpin-for-EcdsaKeyPair" class="impl has-srclink"><a href="#impl-Unpin-for-EcdsaKeyPair" class="anchor"></a><h3 class="code-header">impl Unpin for <a class="struct" href="struct.EcdsaKeyPair.html" title="struct ring::signature::EcdsaKeyPair">EcdsaKeyPair</a></h3></section><section id="impl-UnwindSafe-for-EcdsaKeyPair" class="impl has-srclink"><a href="#impl-UnwindSafe-for-EcdsaKeyPair" class="anchor"></a><h3 class="code-header">impl UnwindSafe for <a class="struct" href="struct.EcdsaKeyPair.html" title="struct ring::signature::EcdsaKeyPair">EcdsaKeyPair</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-EcdsaKeyPair" class="impl has-srclink"><a href="#impl-Any-for-EcdsaKeyPair" class="anchor"></a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where<br> T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-EcdsaKeyPair" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-EcdsaKeyPair" class="anchor"></a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-EcdsaKeyPair" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-EcdsaKeyPair" class="anchor"></a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-EcdsaKeyPair" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-EcdsaKeyPair" class="anchor"></a><h3 class="code-header">impl<T> From<T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-EcdsaKeyPair" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-EcdsaKeyPair" class="anchor"></a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p> |
| <p>That is, this conversion is whatever the implementation of |
| <code>[From]<T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-EcdsaKeyPair" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-EcdsaKeyPair" class="anchor"></a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-EcdsaKeyPair" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-EcdsaKeyPair" class="anchor"></a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = <U as TryFrom<T>>::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="ring" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |