blob: b1ee98937d26a1bf9f5ff9f9072bcf0043a0e2f9 [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="Source of the Rust file `/root/.cargo/git/checkouts/incubator-teaclave-crates-c8106113f74feefc/ede1f68/ring/src/ec/curve25519/ops.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>ops.rs - source</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="../../../../source-script.js"></script><script defer src="../../../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><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></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../../ring/index.html"><img class="rust-logo" src="../../../../rust-logo.svg" alt="logo"></a><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="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
</pre><pre class="rust"><code><span class="comment">// Copyright 2015-2017 Brian Smith.
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHORS DISCLAIM ALL WARRANTIES
// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
// SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
// OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
// CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
</span><span class="doccomment">//! Elliptic curve operations on the birationally equivalent curves Curve25519
//! and Edwards25519.
</span><span class="kw">pub use </span><span class="kw">super</span>::scalar::{MaskedScalar, Scalar, SCALAR_LEN};
<span class="kw">use crate</span>::{
bssl, error,
limb::{Limb, LIMB_BITS},
};
<span class="kw">use </span>core::marker::PhantomData;
<span class="comment">// Elem&lt;T&gt;` is `fe` in curve25519/internal.h.
// Elem&lt;L&gt; is `fe_loose` in curve25519/internal.h.
// Keep this in sync with curve25519/internal.h.
</span><span class="attribute">#[repr(C)]
</span><span class="kw">pub struct </span>Elem&lt;E: Encoding&gt; {
limbs: [Limb; ELEM_LIMBS], <span class="comment">// This is called `v` in the C code.
</span>encoding: PhantomData&lt;E&gt;,
}
<span class="kw">pub trait </span>Encoding {}
<span class="kw">pub struct </span>T;
<span class="kw">impl </span>Encoding <span class="kw">for </span>T {}
<span class="kw">const </span>ELEM_LIMBS: usize = <span class="number">5 </span>* <span class="number">64 </span>/ LIMB_BITS;
<span class="kw">impl</span>&lt;E: Encoding&gt; Elem&lt;E&gt; {
<span class="kw">fn </span>zero() -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{
limbs: Default::default(),
encoding: PhantomData,
}
}
}
<span class="kw">impl </span>Elem&lt;T&gt; {
<span class="kw">fn </span>negate(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="kw">unsafe </span>{
GFp_x25519_fe_neg(<span class="self">self</span>);
}
}
}
<span class="comment">// An encoding of a curve point. If on Curve25519, it should be encoded as
// described in Section 5 of [RFC 7748]. If on Edwards25519, it should be
// encoded as described in section 5.1.2 of [RFC 8032].
//
// [RFC 7748] https://tools.ietf.org/html/rfc7748#section-5
// [RFC 8032] https://tools.ietf.org/html/rfc8032#section-5.1.2
</span><span class="kw">pub type </span>EncodedPoint = [u8; ELEM_LEN];
<span class="kw">pub const </span>ELEM_LEN: usize = <span class="number">32</span>;
<span class="comment">// Keep this in sync with `ge_p3` in curve25519/internal.h.
</span><span class="attribute">#[repr(C)]
</span><span class="kw">pub struct </span>ExtPoint {
x: Elem&lt;T&gt;,
y: Elem&lt;T&gt;,
z: Elem&lt;T&gt;,
t: Elem&lt;T&gt;,
}
<span class="kw">impl </span>ExtPoint {
<span class="kw">pub fn </span>new_at_infinity() -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{
x: Elem::zero(),
y: Elem::zero(),
z: Elem::zero(),
t: Elem::zero(),
}
}
<span class="kw">pub fn </span>from_encoded_point_vartime(encoded: <span class="kw-2">&amp;</span>EncodedPoint) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, error::Unspecified&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>point = <span class="self">Self</span>::new_at_infinity();
Result::from(<span class="kw">unsafe </span>{ GFp_x25519_ge_frombytes_vartime(<span class="kw-2">&amp;mut </span>point, encoded) })
.map(|()| point)
}
<span class="kw">pub fn </span>into_encoded_point(<span class="self">self</span>) -&gt; EncodedPoint {
encode_point(<span class="self">self</span>.x, <span class="self">self</span>.y, <span class="self">self</span>.z)
}
<span class="kw">pub fn </span>invert_vartime(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="self">self</span>.x.negate();
<span class="self">self</span>.t.negate();
}
}
<span class="comment">// Keep this in sync with `ge_p2` in curve25519/internal.h.
</span><span class="attribute">#[repr(C)]
</span><span class="kw">pub struct </span>Point {
x: Elem&lt;T&gt;,
y: Elem&lt;T&gt;,
z: Elem&lt;T&gt;,
}
<span class="kw">impl </span>Point {
<span class="kw">pub fn </span>new_at_infinity() -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{
x: Elem::zero(),
y: Elem::zero(),
z: Elem::zero(),
}
}
<span class="kw">pub fn </span>into_encoded_point(<span class="self">self</span>) -&gt; EncodedPoint {
encode_point(<span class="self">self</span>.x, <span class="self">self</span>.y, <span class="self">self</span>.z)
}
}
<span class="kw">fn </span>encode_point(x: Elem&lt;T&gt;, y: Elem&lt;T&gt;, z: Elem&lt;T&gt;) -&gt; EncodedPoint {
<span class="kw">let </span><span class="kw-2">mut </span>bytes = [<span class="number">0</span>; ELEM_LEN];
<span class="kw">let </span>sign_bit: u8 = <span class="kw">unsafe </span>{
<span class="kw">let </span><span class="kw-2">mut </span>recip = Elem::zero();
GFp_x25519_fe_invert(<span class="kw-2">&amp;mut </span>recip, <span class="kw-2">&amp;</span>z);
<span class="kw">let </span><span class="kw-2">mut </span>x_over_z = Elem::zero();
GFp_x25519_fe_mul_ttt(<span class="kw-2">&amp;mut </span>x_over_z, <span class="kw-2">&amp;</span>x, <span class="kw-2">&amp;</span>recip);
<span class="kw">let </span><span class="kw-2">mut </span>y_over_z = Elem::zero();
GFp_x25519_fe_mul_ttt(<span class="kw-2">&amp;mut </span>y_over_z, <span class="kw-2">&amp;</span>y, <span class="kw-2">&amp;</span>recip);
GFp_x25519_fe_tobytes(<span class="kw-2">&amp;mut </span>bytes, <span class="kw-2">&amp;</span>y_over_z);
GFp_x25519_fe_isnegative(<span class="kw-2">&amp;</span>x_over_z)
};
<span class="comment">// The preceding computations must execute in constant time, but this
// doesn&#39;t need to.
</span>bytes[ELEM_LEN - <span class="number">1</span>] ^= sign_bit &lt;&lt; <span class="number">7</span>;
bytes
}
<span class="kw">extern </span><span class="string">&quot;C&quot; </span>{
<span class="kw">fn </span>GFp_x25519_fe_invert(out: <span class="kw-2">&amp;mut </span>Elem&lt;T&gt;, z: <span class="kw-2">&amp;</span>Elem&lt;T&gt;);
<span class="kw">fn </span>GFp_x25519_fe_isnegative(elem: <span class="kw-2">&amp;</span>Elem&lt;T&gt;) -&gt; u8;
<span class="kw">fn </span>GFp_x25519_fe_mul_ttt(h: <span class="kw-2">&amp;mut </span>Elem&lt;T&gt;, f: <span class="kw-2">&amp;</span>Elem&lt;T&gt;, g: <span class="kw-2">&amp;</span>Elem&lt;T&gt;);
<span class="kw">fn </span>GFp_x25519_fe_neg(f: <span class="kw-2">&amp;mut </span>Elem&lt;T&gt;);
<span class="kw">fn </span>GFp_x25519_fe_tobytes(bytes: <span class="kw-2">&amp;mut </span>EncodedPoint, elem: <span class="kw-2">&amp;</span>Elem&lt;T&gt;);
<span class="kw">fn </span>GFp_x25519_ge_frombytes_vartime(h: <span class="kw-2">&amp;mut </span>ExtPoint, s: <span class="kw-2">&amp;</span>EncodedPoint) -&gt; bssl::Result;
}
</code></pre></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>