<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>PolarSSL v1.3.8: ecdh.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">PolarSSL v1.3.8
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_6a9bbd12bf4e19a18c45e270f8fae3fd.html">include</a></li><li class="navelem"><a class="el" href="dir_04272d44da4745cf8b8bfc767d6c6523.html">polarssl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">ecdh.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Elliptic curve Diffie-Hellman.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="ecp_8h_source.html">ecp.h</a>"</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for ecdh.h:</div>
<div class="dyncontent">
<div class="center"><img src="ecdh_8h__incl.png" border="0" usemap="#ecdh_8h" alt=""/></div>
<map name="ecdh_8h" id="ecdh_8h">
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="ecdh_8h__dep__incl.png" border="0" usemap="#ecdh_8hdep" alt=""/></div>
<map name="ecdh_8hdep" id="ecdh_8hdep">
</map>
</div>
</div>
<p><a href="ecdh_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structecdh__context.html">ecdh_context</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">ECDH context structure. <a href="structecdh__context.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a4afa1322ebd6c0b06f5143bbae929541"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="ecdh_8h.html#a4afa1322ebd6c0b06f5143bbae929541">ecdh_side</a> { <a class="el" href="ecdh_8h.html#a4afa1322ebd6c0b06f5143bbae929541a4f39c37b7d803309ca21379b6f523c2b">POLARSSL_ECDH_OURS</a>,
<a class="el" href="ecdh_8h.html#a4afa1322ebd6c0b06f5143bbae929541a862cefa3ef046471b16b39376cb98e39">POLARSSL_ECDH_THEIRS</a>
}</td></tr>
<tr class="memdesc:a4afa1322ebd6c0b06f5143bbae929541"><td class="mdescLeft"> </td><td class="mdescRight">When importing from an EC key, select if it is our key or the peer's key. <a href="ecdh_8h.html#a4afa1322ebd6c0b06f5143bbae929541">More...</a><br/></td></tr>
<tr class="separator:a4afa1322ebd6c0b06f5143bbae929541"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a9d54a86910330450fb99cea9845c53c9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ecdh_8h.html#a9d54a86910330450fb99cea9845c53c9">ecdh_gen_public</a> (<a class="el" href="structecp__group.html">ecp_group</a> *grp, <a class="el" href="structmpi.html">mpi</a> *d, <a class="el" href="structecp__point.html">ecp_point</a> *Q, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)</td></tr>
<tr class="memdesc:a9d54a86910330450fb99cea9845c53c9"><td class="mdescLeft"> </td><td class="mdescRight">Generate a public key. <a href="#a9d54a86910330450fb99cea9845c53c9">More...</a><br/></td></tr>
<tr class="separator:a9d54a86910330450fb99cea9845c53c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af4a8cc9a1009e4307afe4088d769a6bd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ecdh_8h.html#af4a8cc9a1009e4307afe4088d769a6bd">ecdh_compute_shared</a> (<a class="el" href="structecp__group.html">ecp_group</a> *grp, <a class="el" href="structmpi.html">mpi</a> *z, const <a class="el" href="structecp__point.html">ecp_point</a> *Q, const <a class="el" href="structmpi.html">mpi</a> *d, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)</td></tr>
<tr class="memdesc:af4a8cc9a1009e4307afe4088d769a6bd"><td class="mdescLeft"> </td><td class="mdescRight">Compute shared secret Raw function that only does the core computation. <a href="#af4a8cc9a1009e4307afe4088d769a6bd">More...</a><br/></td></tr>
<tr class="separator:af4a8cc9a1009e4307afe4088d769a6bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a80d76b7ea7bd03f987045790528fa9fe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ecdh_8h.html#a80d76b7ea7bd03f987045790528fa9fe">ecdh_init</a> (<a class="el" href="structecdh__context.html">ecdh_context</a> *ctx)</td></tr>
<tr class="memdesc:a80d76b7ea7bd03f987045790528fa9fe"><td class="mdescLeft"> </td><td class="mdescRight">Initialize context. <a href="#a80d76b7ea7bd03f987045790528fa9fe">More...</a><br/></td></tr>
<tr class="separator:a80d76b7ea7bd03f987045790528fa9fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac58b9cd610b9bf65274d917c89756a5b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ecdh_8h.html#ac58b9cd610b9bf65274d917c89756a5b">ecdh_free</a> (<a class="el" href="structecdh__context.html">ecdh_context</a> *ctx)</td></tr>
<tr class="memdesc:ac58b9cd610b9bf65274d917c89756a5b"><td class="mdescLeft"> </td><td class="mdescRight">Free context. <a href="#ac58b9cd610b9bf65274d917c89756a5b">More...</a><br/></td></tr>
<tr class="separator:ac58b9cd610b9bf65274d917c89756a5b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0fb5133b05e53e0f5d576cfe5dce2d20"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ecdh_8h.html#a0fb5133b05e53e0f5d576cfe5dce2d20">ecdh_make_params</a> (<a class="el" href="structecdh__context.html">ecdh_context</a> *ctx, size_t *olen, unsigned char *buf, size_t blen, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)</td></tr>
<tr class="memdesc:a0fb5133b05e53e0f5d576cfe5dce2d20"><td class="mdescLeft"> </td><td class="mdescRight">Generate a public key and a TLS ServerKeyExchange payload. <a href="#a0fb5133b05e53e0f5d576cfe5dce2d20">More...</a><br/></td></tr>
<tr class="separator:a0fb5133b05e53e0f5d576cfe5dce2d20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab0412adb0eb89eab15c6da4f1e99a75d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ecdh_8h.html#ab0412adb0eb89eab15c6da4f1e99a75d">ecdh_read_params</a> (<a class="el" href="structecdh__context.html">ecdh_context</a> *ctx, const unsigned char **buf, const unsigned char *end)</td></tr>
<tr class="memdesc:ab0412adb0eb89eab15c6da4f1e99a75d"><td class="mdescLeft"> </td><td class="mdescRight">Parse and procress a TLS ServerKeyExhange payload. <a href="#ab0412adb0eb89eab15c6da4f1e99a75d">More...</a><br/></td></tr>
<tr class="separator:ab0412adb0eb89eab15c6da4f1e99a75d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab610fdc63f2d5085cfe6b2ab024e96fb"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ecdh_8h.html#ab610fdc63f2d5085cfe6b2ab024e96fb">ecdh_get_params</a> (<a class="el" href="structecdh__context.html">ecdh_context</a> *ctx, const <a class="el" href="structecp__keypair.html">ecp_keypair</a> *key, <a class="el" href="ecdh_8h.html#a4afa1322ebd6c0b06f5143bbae929541">ecdh_side</a> side)</td></tr>
<tr class="memdesc:ab610fdc63f2d5085cfe6b2ab024e96fb"><td class="mdescLeft"> </td><td class="mdescRight">Setup an ECDH context from an EC key. <a href="#ab610fdc63f2d5085cfe6b2ab024e96fb">More...</a><br/></td></tr>
<tr class="separator:ab610fdc63f2d5085cfe6b2ab024e96fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae91b8624edc6f81fbdef9137cf1fd703"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ecdh_8h.html#ae91b8624edc6f81fbdef9137cf1fd703">ecdh_make_public</a> (<a class="el" href="structecdh__context.html">ecdh_context</a> *ctx, size_t *olen, unsigned char *buf, size_t blen, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)</td></tr>
<tr class="memdesc:ae91b8624edc6f81fbdef9137cf1fd703"><td class="mdescLeft"> </td><td class="mdescRight">Generate a public key and a TLS ClientKeyExchange payload. <a href="#ae91b8624edc6f81fbdef9137cf1fd703">More...</a><br/></td></tr>
<tr class="separator:ae91b8624edc6f81fbdef9137cf1fd703"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac630688764d91d5e462cf46af7cafa3a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ecdh_8h.html#ac630688764d91d5e462cf46af7cafa3a">ecdh_read_public</a> (<a class="el" href="structecdh__context.html">ecdh_context</a> *ctx, const unsigned char *buf, size_t blen)</td></tr>
<tr class="memdesc:ac630688764d91d5e462cf46af7cafa3a"><td class="mdescLeft"> </td><td class="mdescRight">Parse and process a TLS ClientKeyExchange payload. <a href="#ac630688764d91d5e462cf46af7cafa3a">More...</a><br/></td></tr>
<tr class="separator:ac630688764d91d5e462cf46af7cafa3a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a51fead5ce830e844d27165630e0205ce"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ecdh_8h.html#a51fead5ce830e844d27165630e0205ce">ecdh_calc_secret</a> (<a class="el" href="structecdh__context.html">ecdh_context</a> *ctx, size_t *olen, unsigned char *buf, size_t blen, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)</td></tr>
<tr class="memdesc:a51fead5ce830e844d27165630e0205ce"><td class="mdescLeft"> </td><td class="mdescRight">Derive and export the shared secret. <a href="#a51fead5ce830e844d27165630e0205ce">More...</a><br/></td></tr>
<tr class="separator:a51fead5ce830e844d27165630e0205ce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acdb6b5b461eee93ac484d0323c8f86e0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ecdh_8h.html#acdb6b5b461eee93ac484d0323c8f86e0">ecdh_self_test</a> (int verbose)</td></tr>
<tr class="memdesc:acdb6b5b461eee93ac484d0323c8f86e0"><td class="mdescLeft"> </td><td class="mdescRight">Checkup routine. <a href="#acdb6b5b461eee93ac484d0323c8f86e0">More...</a><br/></td></tr>
<tr class="separator:acdb6b5b461eee93ac484d0323c8f86e0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Elliptic curve Diffie-Hellman. </p>
<p>Copyright (C) 2006-2013, Brainspark B.V.</p>
<p>This file is part of PolarSSL (<a href="http://www.polarssl.org">http://www.polarssl.org</a>) Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org></p>
<p>All rights reserved.</p>
<p>This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. </p>
<p>Definition in file <a class="el" href="ecdh_8h_source.html">ecdh.h</a>.</p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="a4afa1322ebd6c0b06f5143bbae929541"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="ecdh_8h.html#a4afa1322ebd6c0b06f5143bbae929541">ecdh_side</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>When importing from an EC key, select if it is our key or the peer's key. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a4afa1322ebd6c0b06f5143bbae929541a4f39c37b7d803309ca21379b6f523c2b"></a>POLARSSL_ECDH_OURS</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a4afa1322ebd6c0b06f5143bbae929541a862cefa3ef046471b16b39376cb98e39"></a>POLARSSL_ECDH_THEIRS</em> </td><td class="fielddoc">
</td></tr>
</table>
<p>Definition at line <a class="el" href="ecdh_8h_source.html#l00039">39</a> of file <a class="el" href="ecdh_8h_source.html">ecdh.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a51fead5ce830e844d27165630e0205ce"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ecdh_calc_secret </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structecdh__context.html">ecdh_context</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t * </td>
<td class="paramname"><em>olen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>blen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int(*)(void *, unsigned char *, size_t) </td>
<td class="paramname"><em>f_rng</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>p_rng</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Derive and export the shared secret. </p>
<pre class="fragment"> (Last function used by both TLS client en servers.)
</pre><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>ECDH context </td></tr>
<tr><td class="paramname">olen</td><td>number of bytes written </td></tr>
<tr><td class="paramname">buf</td><td>destination buffer </td></tr>
<tr><td class="paramname">blen</td><td>buffer length </td></tr>
<tr><td class="paramname">f_rng</td><td>RNG function, see notes for <code><a class="el" href="ecdh_8h.html#af4a8cc9a1009e4307afe4088d769a6bd" title="Compute shared secret Raw function that only does the core computation. ">ecdh_compute_shared()</a></code> </td></tr>
<tr><td class="paramname">p_rng</td><td>RNG parameter</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or an POLARSSL_ERR_ECP_XXX error code </dd></dl>
</div>
</div>
<a class="anchor" id="af4a8cc9a1009e4307afe4088d769a6bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ecdh_compute_shared </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structecp__group.html">ecp_group</a> * </td>
<td class="paramname"><em>grp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structmpi.html">mpi</a> * </td>
<td class="paramname"><em>z</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structecp__point.html">ecp_point</a> * </td>
<td class="paramname"><em>Q</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structmpi.html">mpi</a> * </td>
<td class="paramname"><em>d</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int(*)(void *, unsigned char *, size_t) </td>
<td class="paramname"><em>f_rng</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>p_rng</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Compute shared secret Raw function that only does the core computation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">grp</td><td>ECP group </td></tr>
<tr><td class="paramname">z</td><td>Destination MPI (shared secret) </td></tr>
<tr><td class="paramname">Q</td><td>Public key from other party </td></tr>
<tr><td class="paramname">d</td><td>Our secret exponent (private key) </td></tr>
<tr><td class="paramname">f_rng</td><td>RNG function (see notes) </td></tr>
<tr><td class="paramname">p_rng</td><td>RNG parameter</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or a POLARSSL_ERR_ECP_XXX or POLARSSL_MPI_XXX error code</dd></dl>
<dl class="section note"><dt>Note</dt><dd>If f_rng is not NULL, it is used to implement countermeasures against potential elaborate timing attacks, see <code><a class="el" href="ecp_8h.html#a337b0e41153f458872f7f73bad93711c" title="Multiplication by an integer: R = m * P (Not thread-safe to use same group in multiple threads) ...">ecp_mul()</a></code> for details. </dd></dl>
</div>
</div>
<a class="anchor" id="ac58b9cd610b9bf65274d917c89756a5b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ecdh_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structecdh__context.html">ecdh_context</a> * </td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>Context to free </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9d54a86910330450fb99cea9845c53c9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ecdh_gen_public </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structecp__group.html">ecp_group</a> * </td>
<td class="paramname"><em>grp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structmpi.html">mpi</a> * </td>
<td class="paramname"><em>d</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structecp__point.html">ecp_point</a> * </td>
<td class="paramname"><em>Q</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int(*)(void *, unsigned char *, size_t) </td>
<td class="paramname"><em>f_rng</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>p_rng</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate a public key. </p>
<pre class="fragment"> Raw function that only does the core computation.
</pre><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">grp</td><td>ECP group </td></tr>
<tr><td class="paramname">d</td><td>Destination MPI (secret exponent, aka private key) </td></tr>
<tr><td class="paramname">Q</td><td>Destination point (public key) </td></tr>
<tr><td class="paramname">f_rng</td><td>RNG function </td></tr>
<tr><td class="paramname">p_rng</td><td>RNG parameter</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or a POLARSSL_ERR_ECP_XXX or POLARSSL_MPI_XXX error code </dd></dl>
</div>
</div>
<a class="anchor" id="ab610fdc63f2d5085cfe6b2ab024e96fb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ecdh_get_params </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structecdh__context.html">ecdh_context</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structecp__keypair.html">ecp_keypair</a> * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ecdh_8h.html#a4afa1322ebd6c0b06f5143bbae929541">ecdh_side</a> </td>
<td class="paramname"><em>side</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Setup an ECDH context from an EC key. </p>
<pre class="fragment"> (Used by clients and servers in place of the
ServerKeyEchange for static ECDH: import ECDH parameters
from a certificate's EC key information.)
</pre><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>ECDH constext to set </td></tr>
<tr><td class="paramname">key</td><td>EC key to use </td></tr>
<tr><td class="paramname">side</td><td>Is it our key (1) or the peer's key (0) ?</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or an POLARSSL_ERR_ECP_XXX error code </dd></dl>
</div>
</div>
<a class="anchor" id="a80d76b7ea7bd03f987045790528fa9fe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ecdh_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structecdh__context.html">ecdh_context</a> * </td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>Context to initialize </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0fb5133b05e53e0f5d576cfe5dce2d20"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ecdh_make_params </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structecdh__context.html">ecdh_context</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t * </td>
<td class="paramname"><em>olen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>blen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int(*)(void *, unsigned char *, size_t) </td>
<td class="paramname"><em>f_rng</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>p_rng</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate a public key and a TLS ServerKeyExchange payload. </p>
<pre class="fragment"> (First function used by a TLS server for ECDHE.)
</pre><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>ECDH context </td></tr>
<tr><td class="paramname">olen</td><td>number of chars written </td></tr>
<tr><td class="paramname">buf</td><td>destination buffer </td></tr>
<tr><td class="paramname">blen</td><td>length of buffer </td></tr>
<tr><td class="paramname">f_rng</td><td>RNG function </td></tr>
<tr><td class="paramname">p_rng</td><td>RNG parameter</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This function assumes that ctx->grp has already been properly set (for example using ecp_use_known_dp).</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or an POLARSSL_ERR_ECP_XXX error code </dd></dl>
</div>
</div>
<a class="anchor" id="ae91b8624edc6f81fbdef9137cf1fd703"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ecdh_make_public </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structecdh__context.html">ecdh_context</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t * </td>
<td class="paramname"><em>olen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>blen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int(*)(void *, unsigned char *, size_t) </td>
<td class="paramname"><em>f_rng</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>p_rng</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate a public key and a TLS ClientKeyExchange payload. </p>
<pre class="fragment"> (Second function used by a TLS client for ECDH(E).)
</pre><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>ECDH context </td></tr>
<tr><td class="paramname">olen</td><td>number of bytes actually written </td></tr>
<tr><td class="paramname">buf</td><td>destination buffer </td></tr>
<tr><td class="paramname">blen</td><td>size of destination buffer </td></tr>
<tr><td class="paramname">f_rng</td><td>RNG function </td></tr>
<tr><td class="paramname">p_rng</td><td>RNG parameter</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or an POLARSSL_ERR_ECP_XXX error code </dd></dl>
</div>
</div>
<a class="anchor" id="ab0412adb0eb89eab15c6da4f1e99a75d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ecdh_read_params </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structecdh__context.html">ecdh_context</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char ** </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>end</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parse and procress a TLS ServerKeyExhange payload. </p>
<pre class="fragment"> (First function used by a TLS client for ECDHE.)
</pre><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>ECDH context </td></tr>
<tr><td class="paramname">buf</td><td>pointer to start of input buffer </td></tr>
<tr><td class="paramname">end</td><td>one past end of buffer</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or an POLARSSL_ERR_ECP_XXX error code </dd></dl>
</div>
</div>
<a class="anchor" id="ac630688764d91d5e462cf46af7cafa3a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ecdh_read_public </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structecdh__context.html">ecdh_context</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>blen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parse and process a TLS ClientKeyExchange payload. </p>
<pre class="fragment"> (Second function used by a TLS server for ECDH(E).)
</pre><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>ECDH context </td></tr>
<tr><td class="paramname">buf</td><td>start of input buffer </td></tr>
<tr><td class="paramname">blen</td><td>length of input buffer</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or an POLARSSL_ERR_ECP_XXX error code </dd></dl>
</div>
</div>
<a class="anchor" id="acdb6b5b461eee93ac484d0323c8f86e0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ecdh_self_test </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>verbose</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checkup routine. </p>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or 1 if the test failed </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jul 31 2014 11:35:55 for PolarSSL v1.3.8 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
