Untitled Git - bitcoindevkit.org/blob

   1 <!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="Creates a shared point from public key and secret key."><title>shared_secret_point in bdk_chain::bitcoin::secp256k1::ecdh - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-46132b98.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="bdk_chain" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.0-nightly (a4cb3c831 2024-12-17)" data-channel="nightly" data-search-js="search-036cda7a.js" data-settings-js="settings-0f613d39.js" ><script src="../../../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[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" title="show sidebar"></button><a class="logo-container" href="../../../../bdk_chain/index.html"><img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../../../bdk_chain/index.html"><img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt="logo"></a><h2><a href="../../../../bdk_chain/index.html">bdk_<wbr>chain</a><span class="version">0.21.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">shared_<wbr>secret_<wbr>point</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#returns" title="Returns">Returns</a></li><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In bdk_<wbr>chain::<wbr>bitcoin::<wbr>secp256k1::<wbr>ecdh</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../../../index.html">bdk_chain</a>::<wbr><a href="../../index.html">bitcoin</a>::<wbr><a href="../index.html">secp256k1</a>::<wbr><a href="index.html">ecdh</a></span><h1>Function <span class="fn">shared_secret_point</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"></span></div><pre class="rust item-decl"><code>pub fn shared_secret_point(point: &amp;<a class="struct" href="../struct.PublicKey.html" title="struct bdk_chain::bitcoin::secp256k1::PublicKey">PublicKey</a>, scalar: &amp;<a class="struct" href="../struct.SecretKey.html" title="struct bdk_chain::bitcoin::secp256k1::SecretKey">SecretKey</a>) -&gt; [<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.array.html">64</a>]</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Creates a shared point from public key and secret key.</p>
   2 <p><strong>Important: use of a strong cryptographic hash function may be critical to security! Do NOT use
   3 unless you understand cryptographical implications.</strong> If not, use SharedSecret instead.</p>
   4 <p>Can be used like <code>SharedSecret</code> but caller is responsible for then hashing the returned buffer.
   5 This allows for the use of a custom hash function since <code>SharedSecret</code> uses SHA256.</p>
   6 <h2 id="returns"><a class="doc-anchor" href="#returns">§</a>Returns</h2>
   7 <p>64 bytes representing the (x,y) co-ordinates of a point on the curve (32 bytes each).</p>
   8 <h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
   9 <div class="example-wrap"><pre class="rust rust-example-rendered"><code>
  10 <span class="kw">let </span>s = Secp256k1::new();
  11 <span class="kw">let </span>(sk1, pk1) = s.generate_keypair(<span class="kw-2">&amp;mut </span>rand::thread_rng());
  12 <span class="kw">let </span>(sk2, pk2) = s.generate_keypair(<span class="kw-2">&amp;mut </span>rand::thread_rng());
  13
  14 <span class="kw">let </span>point1 = ecdh::shared_secret_point(<span class="kw-2">&amp;</span>pk2, <span class="kw-2">&amp;</span>sk1);
  15 <span class="kw">let </span>secret1 = sha512::Hash::hash(<span class="kw-2">&amp;</span>point1);
  16 <span class="kw">let </span>point2 = ecdh::shared_secret_point(<span class="kw-2">&amp;</span>pk1, <span class="kw-2">&amp;</span>sk2);
  17 <span class="kw">let </span>secret2 = sha512::Hash::hash(<span class="kw-2">&amp;</span>point2);
  18 <span class="macro">assert_eq!</span>(secret1, secret2)</code></pre></div>
  19 </div></details></section></div></main></body></html>