blob: 2e521b36765c5d5f500bb126934c050f4d353c9f [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/registry/src/github.com-1ecc6299db9ec823/openssl-0.10.54/src/ecdsa.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>ecdsa.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="../../openssl/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="../../openssl/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>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
</pre><pre class="rust"><code><span class="doccomment">//! Low level Elliptic Curve Digital Signature Algorithm (ECDSA) functions.
</span><span class="kw">use </span>cfg_if::cfg_if;
<span class="kw">use </span>foreign_types::{ForeignType, ForeignTypeRef};
<span class="kw">use </span>libc::c_int;
<span class="kw">use </span>std::mem;
<span class="kw">use </span>std::ptr;
<span class="kw">use </span><span class="kw">crate</span>::bn::{BigNum, BigNumRef};
<span class="kw">use </span><span class="kw">crate</span>::ec::EcKeyRef;
<span class="kw">use </span><span class="kw">crate</span>::error::ErrorStack;
<span class="kw">use </span><span class="kw">crate</span>::pkey::{HasPrivate, HasPublic};
<span class="kw">use </span><span class="kw">crate</span>::util::ForeignTypeRefExt;
<span class="kw">use crate</span>::{cvt_n, cvt_p, LenType};
<span class="kw">use </span>openssl_macros::corresponds;
<span class="macro">foreign_type_and_impl_send_sync! </span>{
<span class="kw">type </span>CType = ffi::ECDSA_SIG;
<span class="kw">fn </span>drop = ffi::ECDSA_SIG_free;
<span class="doccomment">/// A low level interface to ECDSA.
</span><span class="kw">pub struct </span>EcdsaSig;
<span class="doccomment">/// A reference to an [`EcdsaSig`].
</span><span class="kw">pub struct </span>EcdsaSigRef;
}
<span class="kw">impl </span>EcdsaSig {
<span class="doccomment">/// Computes a digital signature of the hash value `data` using the private EC key eckey.
</span><span class="attribute">#[corresponds(ECDSA_do_sign)]
</span><span class="kw">pub fn </span>sign&lt;T&gt;(data: <span class="kw-2">&amp;</span>[u8], eckey: <span class="kw-2">&amp;</span>EcKeyRef&lt;T&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;EcdsaSig, ErrorStack&gt;
<span class="kw">where
</span>T: HasPrivate,
{
<span class="kw">unsafe </span>{
<span class="macro">assert!</span>(data.len() &lt;= c_int::max_value() <span class="kw">as </span>usize);
<span class="kw">let </span>sig = cvt_p(ffi::ECDSA_do_sign(
data.as_ptr(),
data.len() <span class="kw">as </span>LenType,
eckey.as_ptr(),
))<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(EcdsaSig::from_ptr(sig))
}
}
<span class="doccomment">/// Returns a new `EcdsaSig` by setting the `r` and `s` values associated with an ECDSA signature.
</span><span class="attribute">#[corresponds(ECDSA_SIG_set0)]
</span><span class="kw">pub fn </span>from_private_components(r: BigNum, s: BigNum) -&gt; <span class="prelude-ty">Result</span>&lt;EcdsaSig, ErrorStack&gt; {
<span class="kw">unsafe </span>{
<span class="kw">let </span>sig = cvt_p(ffi::ECDSA_SIG_new())<span class="question-mark">?</span>;
ECDSA_SIG_set0(sig, r.as_ptr(), s.as_ptr());
mem::forget((r, s));
<span class="prelude-val">Ok</span>(EcdsaSig::from_ptr(sig))
}
}
<span class="macro">from_der! </span>{
<span class="doccomment">/// Decodes a DER-encoded ECDSA signature.
</span><span class="attribute">#[corresponds(d2i_ECDSA_SIG)]
</span>from_der,
EcdsaSig,
ffi::d2i_ECDSA_SIG
}
}
<span class="kw">impl </span>EcdsaSigRef {
<span class="macro">to_der! </span>{
<span class="doccomment">/// Serializes the ECDSA signature into a DER-encoded ECDSASignature structure.
</span><span class="attribute">#[corresponds(i2d_ECDSA_SIG)]
</span>to_der,
ffi::i2d_ECDSA_SIG
}
<span class="doccomment">/// Verifies if the signature is a valid ECDSA signature using the given public key.
</span><span class="attribute">#[corresponds(ECDSA_do_verify)]
</span><span class="kw">pub fn </span>verify&lt;T&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, data: <span class="kw-2">&amp;</span>[u8], eckey: <span class="kw-2">&amp;</span>EcKeyRef&lt;T&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;bool, ErrorStack&gt;
<span class="kw">where
</span>T: HasPublic,
{
<span class="kw">unsafe </span>{
<span class="macro">assert!</span>(data.len() &lt;= c_int::max_value() <span class="kw">as </span>usize);
cvt_n(ffi::ECDSA_do_verify(
data.as_ptr(),
data.len() <span class="kw">as </span>LenType,
<span class="self">self</span>.as_ptr(),
eckey.as_ptr(),
))
.map(|x| x == <span class="number">1</span>)
}
}
<span class="doccomment">/// Returns internal component: `r` of an `EcdsaSig`. (See X9.62 or FIPS 186-2)
</span><span class="attribute">#[corresponds(ECDSA_SIG_get0)]
</span><span class="kw">pub fn </span>r(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>BigNumRef {
<span class="kw">unsafe </span>{
<span class="kw">let </span><span class="kw-2">mut </span>r = ptr::null();
ECDSA_SIG_get0(<span class="self">self</span>.as_ptr(), <span class="kw-2">&amp;mut </span>r, ptr::null_mut());
BigNumRef::from_const_ptr(r)
}
}
<span class="doccomment">/// Returns internal components: `s` of an `EcdsaSig`. (See X9.62 or FIPS 186-2)
</span><span class="attribute">#[corresponds(ECDSA_SIG_get0)]
</span><span class="kw">pub fn </span>s(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>BigNumRef {
<span class="kw">unsafe </span>{
<span class="kw">let </span><span class="kw-2">mut </span>s = ptr::null();
ECDSA_SIG_get0(<span class="self">self</span>.as_ptr(), ptr::null_mut(), <span class="kw-2">&amp;mut </span>s);
BigNumRef::from_const_ptr(s)
}
}
}
<span class="macro">cfg_if! </span>{
<span class="kw">if </span><span class="attribute">#[cfg(any(ossl110, libressl273))] </span>{
<span class="kw">use </span>ffi::{ECDSA_SIG_set0, ECDSA_SIG_get0};
} <span class="kw">else </span>{
<span class="attribute">#[allow(bad_style)]
</span><span class="kw">unsafe fn </span>ECDSA_SIG_set0(
sig: <span class="kw-2">*mut </span>ffi::ECDSA_SIG,
r: <span class="kw-2">*mut </span>ffi::BIGNUM,
s: <span class="kw-2">*mut </span>ffi::BIGNUM,
) -&gt; c_int {
<span class="kw">if </span>r.is_null() || s.is_null() {
<span class="kw">return </span><span class="number">0</span>;
}
ffi::BN_clear_free((<span class="kw-2">*</span>sig).r);
ffi::BN_clear_free((<span class="kw-2">*</span>sig).s);
(<span class="kw-2">*</span>sig).r = r;
(<span class="kw-2">*</span>sig).s = s;
<span class="number">1
</span>}
<span class="attribute">#[allow(bad_style)]
</span><span class="kw">unsafe fn </span>ECDSA_SIG_get0(
sig: <span class="kw-2">*const </span>ffi::ECDSA_SIG,
pr: <span class="kw-2">*mut *const </span>ffi::BIGNUM,
ps: <span class="kw-2">*mut *const </span>ffi::BIGNUM)
{
<span class="kw">if </span>!pr.is_null() {
(<span class="kw-2">*</span>pr) = (<span class="kw-2">*</span>sig).r;
}
<span class="kw">if </span>!ps.is_null() {
(<span class="kw-2">*</span>ps) = (<span class="kw-2">*</span>sig).s;
}
}
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>test {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="kw">use </span><span class="kw">crate</span>::ec::EcGroup;
<span class="kw">use </span><span class="kw">crate</span>::ec::EcKey;
<span class="kw">use </span><span class="kw">crate</span>::nid::Nid;
<span class="kw">use </span><span class="kw">crate</span>::pkey::{Private, Public};
<span class="kw">fn </span>get_public_key(group: <span class="kw-2">&amp;</span>EcGroup, x: <span class="kw-2">&amp;</span>EcKey&lt;Private&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;EcKey&lt;Public&gt;, ErrorStack&gt; {
EcKey::from_public_key(group, x.public_key())
}
<span class="attribute">#[test]
#[cfg_attr(osslconf = <span class="string">&quot;OPENSSL_NO_EC2M&quot;</span>, ignore)]
</span><span class="kw">fn </span>sign_and_verify() {
<span class="kw">let </span>group = EcGroup::from_curve_name(Nid::X9_62_PRIME256V1).unwrap();
<span class="kw">let </span>private_key = EcKey::generate(<span class="kw-2">&amp;</span>group).unwrap();
<span class="kw">let </span>public_key = get_public_key(<span class="kw-2">&amp;</span>group, <span class="kw-2">&amp;</span>private_key).unwrap();
<span class="kw">let </span>private_key2 = EcKey::generate(<span class="kw-2">&amp;</span>group).unwrap();
<span class="kw">let </span>public_key2 = get_public_key(<span class="kw-2">&amp;</span>group, <span class="kw-2">&amp;</span>private_key2).unwrap();
<span class="kw">let </span>data = String::from(<span class="string">&quot;hello&quot;</span>);
<span class="kw">let </span>res = EcdsaSig::sign(data.as_bytes(), <span class="kw-2">&amp;</span>private_key).unwrap();
<span class="comment">// Signature can be verified using the correct data &amp; correct public key
</span><span class="kw">let </span>verification = res.verify(data.as_bytes(), <span class="kw-2">&amp;</span>public_key).unwrap();
<span class="macro">assert!</span>(verification);
<span class="comment">// Signature will not be verified using the incorrect data but the correct public key
</span><span class="kw">let </span>verification2 = res
.verify(String::from(<span class="string">&quot;hello2&quot;</span>).as_bytes(), <span class="kw-2">&amp;</span>public_key)
.unwrap();
<span class="macro">assert!</span>(!verification2);
<span class="comment">// Signature will not be verified using the correct data but the incorrect public key
</span><span class="kw">let </span>verification3 = res.verify(data.as_bytes(), <span class="kw-2">&amp;</span>public_key2).unwrap();
<span class="macro">assert!</span>(!verification3);
}
<span class="attribute">#[test]
#[cfg_attr(osslconf = <span class="string">&quot;OPENSSL_NO_EC2M&quot;</span>, ignore)]
</span><span class="kw">fn </span>check_private_components() {
<span class="kw">let </span>group = EcGroup::from_curve_name(Nid::X9_62_PRIME256V1).unwrap();
<span class="kw">let </span>private_key = EcKey::generate(<span class="kw-2">&amp;</span>group).unwrap();
<span class="kw">let </span>public_key = get_public_key(<span class="kw-2">&amp;</span>group, <span class="kw-2">&amp;</span>private_key).unwrap();
<span class="kw">let </span>data = String::from(<span class="string">&quot;hello&quot;</span>);
<span class="kw">let </span>res = EcdsaSig::sign(data.as_bytes(), <span class="kw-2">&amp;</span>private_key).unwrap();
<span class="kw">let </span>verification = res.verify(data.as_bytes(), <span class="kw-2">&amp;</span>public_key).unwrap();
<span class="macro">assert!</span>(verification);
<span class="kw">let </span>r = res.r().to_owned().unwrap();
<span class="kw">let </span>s = res.s().to_owned().unwrap();
<span class="kw">let </span>res2 = EcdsaSig::from_private_components(r, s).unwrap();
<span class="kw">let </span>verification2 = res2.verify(data.as_bytes(), <span class="kw-2">&amp;</span>public_key).unwrap();
<span class="macro">assert!</span>(verification2);
}
<span class="attribute">#[test]
#[cfg_attr(osslconf = <span class="string">&quot;OPENSSL_NO_EC2M&quot;</span>, ignore)]
</span><span class="kw">fn </span>serialize_deserialize() {
<span class="kw">let </span>group = EcGroup::from_curve_name(Nid::X9_62_PRIME256V1).unwrap();
<span class="kw">let </span>private_key = EcKey::generate(<span class="kw-2">&amp;</span>group).unwrap();
<span class="kw">let </span>public_key = get_public_key(<span class="kw-2">&amp;</span>group, <span class="kw-2">&amp;</span>private_key).unwrap();
<span class="kw">let </span>data = String::from(<span class="string">&quot;hello&quot;</span>);
<span class="kw">let </span>res = EcdsaSig::sign(data.as_bytes(), <span class="kw-2">&amp;</span>private_key).unwrap();
<span class="kw">let </span>der = res.to_der().unwrap();
<span class="kw">let </span>sig = EcdsaSig::from_der(<span class="kw-2">&amp;</span>der).unwrap();
<span class="kw">let </span>verification = sig.verify(data.as_bytes(), <span class="kw-2">&amp;</span>public_key).unwrap();
<span class="macro">assert!</span>(verification);
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="openssl" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>