<!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"/>
<title>PolarSSL: polarssl/dhm.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">PolarSSL</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</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>File Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#define-members">Defines</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">polarssl/dhm.h File Reference</div> </div>
</div>
<div class="contents">
<div class="textblock"><code>#include "<a class="el" href="bignum_8h_source.html">polarssl/bignum.h</a>"</code><br/>
</div>
<p><a href="dhm_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structdhm__context.html">dhm_context</a></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab1f102e6347b0cc8c49d525964d7c996"></a><!-- doxytag: member="dhm.h::POLARSSL_ERR_DHM_BAD_INPUT_DATA" ref="ab1f102e6347b0cc8c49d525964d7c996" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>POLARSSL_ERR_DHM_BAD_INPUT_DATA</b>   0x0480</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1cf5b743957392157fefae2d1ceef39f"></a><!-- doxytag: member="dhm.h::POLARSSL_ERR_DHM_READ_PARAMS_FAILED" ref="a1cf5b743957392157fefae2d1ceef39f" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>POLARSSL_ERR_DHM_READ_PARAMS_FAILED</b>   0x0490</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e27f309924f0bf267c7de08bc6125b5"></a><!-- doxytag: member="dhm.h::POLARSSL_ERR_DHM_MAKE_PARAMS_FAILED" ref="a3e27f309924f0bf267c7de08bc6125b5" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>POLARSSL_ERR_DHM_MAKE_PARAMS_FAILED</b>   0x04A0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a54e3f55659f632b8cce3159f113ee009"></a><!-- doxytag: member="dhm.h::POLARSSL_ERR_DHM_READ_PUBLIC_FAILED" ref="a54e3f55659f632b8cce3159f113ee009" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>POLARSSL_ERR_DHM_READ_PUBLIC_FAILED</b>   0x04B0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a29ed83b8442b715e03990f438d4bce98"></a><!-- doxytag: member="dhm.h::POLARSSL_ERR_DHM_MAKE_PUBLIC_FAILED" ref="a29ed83b8442b715e03990f438d4bce98" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>POLARSSL_ERR_DHM_MAKE_PUBLIC_FAILED</b>   0x04C0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4f6609fa29638c85e6d401954d02845"></a><!-- doxytag: member="dhm.h::POLARSSL_ERR_DHM_CALC_SECRET_FAILED" ref="ab4f6609fa29638c85e6d401954d02845" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>POLARSSL_ERR_DHM_CALC_SECRET_FAILED</b>   0x04D0</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="dhm_8h.html#a6c77d265f13f7333802b93172a6833aa">dhm_read_params</a> (<a class="el" href="structdhm__context.html">dhm_context</a> *ctx, unsigned char **p, const unsigned char *end)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse the ServerKeyExchange parameters. <a href="#a6c77d265f13f7333802b93172a6833aa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="dhm_8h.html#aba3614e57e89d94bcd5849014fe500a6">dhm_make_params</a> (<a class="el" href="structdhm__context.html">dhm_context</a> *ctx, int x_size, unsigned char *output, int *olen, int(*f_rng)(void *), void *p_rng)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Setup and write the ServerKeyExchange parameters. <a href="#aba3614e57e89d94bcd5849014fe500a6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="dhm_8h.html#a75f33b4bee8b44be8e0cae1fb5612a21">dhm_read_public</a> (<a class="el" href="structdhm__context.html">dhm_context</a> *ctx, const unsigned char *input, int ilen)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Import the peer's public value G^Y. <a href="#a75f33b4bee8b44be8e0cae1fb5612a21"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="dhm_8h.html#a93c83931e8f3c818274834dfc435a4c4">dhm_make_public</a> (<a class="el" href="structdhm__context.html">dhm_context</a> *ctx, int s_size, unsigned char *output, int olen, int(*f_rng)(void *), void *p_rng)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create own private value X and export G^X. <a href="#a93c83931e8f3c818274834dfc435a4c4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="dhm_8h.html#a116df37d64349118c538da74a5a9e6fe">dhm_calc_secret</a> (<a class="el" href="structdhm__context.html">dhm_context</a> *ctx, unsigned char *output, int *olen)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Derive and export the shared secret (G^Y)^X mod P. <a href="#a116df37d64349118c538da74a5a9e6fe"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada3c785f695c3d513177dd45d3c6f254"></a><!-- doxytag: member="dhm.h::dhm_free" ref="ada3c785f695c3d513177dd45d3c6f254" args="(dhm_context *ctx)" -->
void </td><td class="memItemRight" valign="bottom"><b>dhm_free</b> (<a class="el" href="structdhm__context.html">dhm_context</a> *ctx)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="dhm_8h.html#a61cc4f6b8b132f50e34b6f42b74d08fa">dhm_self_test</a> (int verbose)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checkup routine. <a href="#a61cc4f6b8b132f50e34b6f42b74d08fa"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Copyright (C) 2006-2010, 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>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="a116df37d64349118c538da74a5a9e6fe"></a><!-- doxytag: member="dhm.h::dhm_calc_secret" ref="a116df37d64349118c538da74a5a9e6fe" args="(dhm_context *ctx, unsigned char *output, int *olen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dhm_calc_secret </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structdhm__context.html">dhm_context</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>olen</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 (G^Y)^X mod P. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>DHM context </td></tr>
<tr><td class="paramname">output</td><td>destination buffer </td></tr>
<tr><td class="paramname">olen</td><td>number of chars written</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, or an POLARSSL_ERR_DHM_XXX error code </dd></dl>
</div>
</div>
<a class="anchor" id="aba3614e57e89d94bcd5849014fe500a6"></a><!-- doxytag: member="dhm.h::dhm_make_params" ref="aba3614e57e89d94bcd5849014fe500a6" args="(dhm_context *ctx, int x_size, unsigned char *output, int *olen, int(*f_rng)(void *), void *p_rng)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dhm_make_params </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structdhm__context.html">dhm_context</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>x_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>olen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int(*)(void *) </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>Setup and write the ServerKeyExchange parameters. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>DHM context </td></tr>
<tr><td class="paramname">x_size</td><td>private value size in bytes </td></tr>
<tr><td class="paramname">output</td><td>destination buffer </td></tr>
<tr><td class="paramname">olen</td><td>number of chars written </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="note"><dt><b>Note:</b></dt><dd>This function assumes that ctx->P and ctx->G have already been properly set (for example using mpi_read_string or mpi_read_binary).</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, or an POLARSSL_ERR_DHM_XXX error code </dd></dl>
</div>
</div>
<a class="anchor" id="a93c83931e8f3c818274834dfc435a4c4"></a><!-- doxytag: member="dhm.h::dhm_make_public" ref="a93c83931e8f3c818274834dfc435a4c4" args="(dhm_context *ctx, int s_size, unsigned char *output, int olen, int(*f_rng)(void *), void *p_rng)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dhm_make_public </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structdhm__context.html">dhm_context</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>s_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>olen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int(*)(void *) </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>Create own private value X and export G^X. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>DHM context </td></tr>
<tr><td class="paramname">x_size</td><td>private value size in bits </td></tr>
<tr><td class="paramname">output</td><td>destination buffer </td></tr>
<tr><td class="paramname">olen</td><td>must be equal to ctx->P.len </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="return"><dt><b>Returns:</b></dt><dd>0 if successful, or an POLARSSL_ERR_DHM_XXX error code </dd></dl>
</div>
</div>
<a class="anchor" id="a6c77d265f13f7333802b93172a6833aa"></a><!-- doxytag: member="dhm.h::dhm_read_params" ref="a6c77d265f13f7333802b93172a6833aa" args="(dhm_context *ctx, unsigned char **p, const unsigned char *end)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dhm_read_params </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structdhm__context.html">dhm_context</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char ** </td>
<td class="paramname"><em>p</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 the ServerKeyExchange parameters. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>DHM context </td></tr>
<tr><td class="paramname">p</td><td>&(start of input buffer) </td></tr>
<tr><td class="paramname">end</td><td>end of buffer</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, or an POLARSSL_ERR_DHM_XXX error code </dd></dl>
</div>
</div>
<a class="anchor" id="a75f33b4bee8b44be8e0cae1fb5612a21"></a><!-- doxytag: member="dhm.h::dhm_read_public" ref="a75f33b4bee8b44be8e0cae1fb5612a21" args="(dhm_context *ctx, const unsigned char *input, int ilen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dhm_read_public </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structdhm__context.html">dhm_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>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>ilen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Import the peer's public value G^Y. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>DHM context </td></tr>
<tr><td class="paramname">input</td><td>input buffer </td></tr>
<tr><td class="paramname">ilen</td><td>size of buffer</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, or an POLARSSL_ERR_DHM_XXX error code </dd></dl>
</div>
</div>
<a class="anchor" id="a61cc4f6b8b132f50e34b6f42b74d08fa"></a><!-- doxytag: member="dhm.h::dhm_self_test" ref="a61cc4f6b8b132f50e34b6f42b74d08fa" args="(int verbose)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dhm_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="return"><dt><b>Returns:</b></dt><dd>0 if successful, or 1 if the test failed </dd></dl>
</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon May 16 2011 for PolarSSL by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
8df484ca79a7b6bb61e4a376e1506870
>
files
>
55
