<!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>BeeCrypt: include/beecrypt/dsa.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">BeeCrypt
 <span id="projectnumber">4.2.1</span>
</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="pages.html"><span>Related Pages</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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_7519372152c32ce484a8cde0fb6b8cd0.html">beecrypt</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">dsa.h File Reference<div class="ingroups"><a class="el" href="group__DL__dsa__m.html">Discrete Logarithm Primitives: DSA</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Digital Signature Algorithm, as specified by NIST FIPS 186.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="dlkp_8h_source.html">beecrypt/dlkp.h</a>"</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for dsa.h:</div>
<div class="dyncontent">
<div class="center"><img src="dsa_8h__incl.png" border="0" usemap="#include_2beecrypt_2dsa_8h" alt=""/></div>
<map name="include_2beecrypt_2dsa_8h" id="include_2beecrypt_2dsa_8h">
<area shape="rect" id="node2" href="dlkp_8h.html" title="Discrete Logarithm keypair, headers. " alt="" coords="614,80,724,107"/><area shape="rect" id="node3" href="dlpk_8h.html" title="Discrete Logarithm public key, headers. " alt="" coords="614,155,724,181"/><area shape="rect" id="node4" href="dldp_8h.html" title="Discrete Logarithm domain parameters, headers. " alt="" coords="614,229,724,256"/><area shape="rect" id="node5" href="mpbarrett_8h.html" title="Multi-precision integer routines using Barrett modular reduction, headers. " alt="" coords="598,304,740,331"/><area shape="rect" id="node6" href="beecrypt_8h.html" title="BeeCrypt API, headers. " alt="" coords="461,379,597,405"/><area shape="rect" id="node20" href="mpnumber_8h.html" title="Multi-precision numbers, headers. " alt="" coords="595,453,743,480"/><area shape="rect" id="node7" href="api_8h.html" title="BeeCrypt API, portability headers. " alt="" coords="444,603,548,629"/><area shape="rect" id="node19" href="memchunk_8h.html" title="beecrypt/memchunk.h" alt="" coords="421,453,571,480"/><area shape="rect" id="node8" href="gnu_8h.html" title="beecrypt/gnu.h" alt="" coords="442,677,549,704"/><area shape="rect" id="node21" href="mp_8h.html" title="Multi-precision integer routines. " alt="" coords="589,528,693,555"/><area shape="rect" id="node22" href="mpopt_8h.html" title="Multi-precision integer optimization definitions. " alt="" coords="580,603,703,629"/></map>
</div>
</div>
<p><a href="dsa_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="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a101dc535937173652cd69c04f5f0383f"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structdldp__p.html">dldp_p</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="dsa_8h.html#a101dc535937173652cd69c04f5f0383f">dsaparam</a></td></tr>
<tr class="separator:a101dc535937173652cd69c04f5f0383f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a42e7021ed621afc5269b827dbc2d5677"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structdlpk__p.html">dlpk_p</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="dsa_8h.html#a42e7021ed621afc5269b827dbc2d5677">dsapub</a></td></tr>
<tr class="separator:a42e7021ed621afc5269b827dbc2d5677"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae83b8c80466cb3c71c77b3f01207cae2"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structdlkp__p.html">dlkp_p</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="dsa_8h.html#ae83b8c80466cb3c71c77b3f01207cae2">dsakp</a></td></tr>
<tr class="separator:ae83b8c80466cb3c71c77b3f01207cae2"><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:a8233bc3b4467867e0256e97688808d58"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="dsa_8h.html#a8233bc3b4467867e0256e97688808d58">dsasign</a> (const <a class="el" href="structmpbarrett.html">mpbarrett</a> *p, const <a class="el" href="structmpbarrett.html">mpbarrett</a> *q, const <a class="el" href="structmpnumber.html">mpnumber</a> *g, <a class="el" href="structrandomGeneratorContext.html">randomGeneratorContext</a> *, const <a class="el" href="structmpnumber.html">mpnumber</a> *hm, const <a class="el" href="structmpnumber.html">mpnumber</a> *x, <a class="el" href="structmpnumber.html">mpnumber</a> *r, <a class="el" href="structmpnumber.html">mpnumber</a> *s)</td></tr>
<tr class="memdesc:a8233bc3b4467867e0256e97688808d58"><td class="mdescLeft"> </td><td class="mdescRight">This function performs a raw DSA signature. <a href="#a8233bc3b4467867e0256e97688808d58">More...</a><br/></td></tr>
<tr class="separator:a8233bc3b4467867e0256e97688808d58"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a072071da4da5af51d7a23805cf4ef3a7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="dsa_8h.html#a072071da4da5af51d7a23805cf4ef3a7">dsavrfy</a> (const <a class="el" href="structmpbarrett.html">mpbarrett</a> *p, const <a class="el" href="structmpbarrett.html">mpbarrett</a> *q, const <a class="el" href="structmpnumber.html">mpnumber</a> *g, const <a class="el" href="structmpnumber.html">mpnumber</a> *hm, const <a class="el" href="structmpnumber.html">mpnumber</a> *y, const <a class="el" href="structmpnumber.html">mpnumber</a> *r, const <a class="el" href="structmpnumber.html">mpnumber</a> *s)</td></tr>
<tr class="memdesc:a072071da4da5af51d7a23805cf4ef3a7"><td class="mdescLeft"> </td><td class="mdescRight">This function performs a raw DSA verification. <a href="#a072071da4da5af51d7a23805cf4ef3a7">More...</a><br/></td></tr>
<tr class="separator:a072071da4da5af51d7a23805cf4ef3a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad7479bccc344d29a8402a95998342e9a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="dsa_8h.html#ad7479bccc344d29a8402a95998342e9a">dsaparamMake</a> (<a class="el" href="dsa_8h.html#a101dc535937173652cd69c04f5f0383f">dsaparam</a> *, <a class="el" href="structrandomGeneratorContext.html">randomGeneratorContext</a> *, size_t)</td></tr>
<tr class="memdesc:ad7479bccc344d29a8402a95998342e9a"><td class="mdescLeft"> </td><td class="mdescRight">This function generates a set of DSA parameters. <a href="#ad7479bccc344d29a8402a95998342e9a">More...</a><br/></td></tr>
<tr class="separator:ad7479bccc344d29a8402a95998342e9a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Digital Signature Algorithm, as specified by NIST FIPS 186. </p>
<p>FIPS 186 specifies the DSA algorithm as having a large prime <img class="formulaInl" alt="$p$" src="form_9.png"/>, a cofactor <img class="formulaInl" alt="$q$" src="form_3.png"/> and a generator <img class="formulaInl" alt="$g$" src="form_5.png"/> of a subgroup of <img class="formulaInl" alt="$\mathds{Z}^{*}_p$" src="form_6.png"/> with order <img class="formulaInl" alt="$q$" src="form_3.png"/>. The private and public key values are <img class="formulaInl" alt="$x$" src="form_10.png"/> and <img class="formulaInl" alt="$y$" src="form_11.png"/> respectively.</p>
<dl class="section author"><dt>Author</dt><dd>Bob Deblier <a href="#" onclick="location.href='mai'+'lto:'+'bob'+'.d'+'ebl'+'ie'+'r@t'+'el'+'ene'+'t.'+'be'; return false;">bob.d<span style="display: none;">.nosp@m.</span>ebli<span style="display: none;">.nosp@m.</span>er@te<span style="display: none;">.nosp@m.</span>lene<span style="display: none;">.nosp@m.</span>t.be</a> </dd></dl>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ae83b8c80466cb3c71c77b3f01207cae2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="structdlkp__p.html">dlkp_p</a> <a class="el" href="dsa_8h.html#ae83b8c80466cb3c71c77b3f01207cae2">dsakp</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a101dc535937173652cd69c04f5f0383f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="structdldp__p.html">dldp_p</a> <a class="el" href="dsa_8h.html#a101dc535937173652cd69c04f5f0383f">dsaparam</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a42e7021ed621afc5269b827dbc2d5677"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="structdlpk__p.html">dlpk_p</a> <a class="el" href="dsa_8h.html#a42e7021ed621afc5269b827dbc2d5677">dsapub</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ad7479bccc344d29a8402a95998342e9a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dsaparamMake </td>
<td>(</td>
<td class="paramtype"><a class="el" href="dsa_8h.html#a101dc535937173652cd69c04f5f0383f">dsaparam</a> * </td>
<td class="paramname"><em>dp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structrandomGeneratorContext.html">randomGeneratorContext</a> * </td>
<td class="paramname"><em>rgc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>psize</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function generates a set of DSA parameters. </p>
<p>This function calls dldp_pgoqMake with appropriate parameters, i.e. qsize = 160 bits and cofactor = 1.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dp</td><td>The parameters to be generated. </td></tr>
<tr><td class="paramname">rgc</td><td>The random generator context. </td></tr>
<tr><td class="paramname">psize</td><td>The size of prime parameter p; psize must be >= 512 and <= 1024, and be a multiple of 64. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>on success. </td></tr>
<tr><td class="paramname">-1</td><td>on failure. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8233bc3b4467867e0256e97688808d58"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dsasign </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structmpbarrett.html">mpbarrett</a> * </td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structmpbarrett.html">mpbarrett</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="structmpnumber.html">mpnumber</a> * </td>
<td class="paramname"><em>g</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structrandomGeneratorContext.html">randomGeneratorContext</a> * </td>
<td class="paramname"><em>rgc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structmpnumber.html">mpnumber</a> * </td>
<td class="paramname"><em>hm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structmpnumber.html">mpnumber</a> * </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structmpnumber.html">mpnumber</a> * </td>
<td class="paramname"><em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structmpnumber.html">mpnumber</a> * </td>
<td class="paramname"><em>s</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function performs a raw DSA signature. </p>
<p>Signing equations:</p>
<ul>
<li><img class="formulaInl" alt="$r=(g^{k}\ \textrm{mod}\ p)\ \textrm{mod}\ q$" src="form_12.png"/> </li>
<li><img class="formulaInl" alt="$s=k^{-1}(h(m)+xr)\ \textrm{mod}\ q$" src="form_13.png"/></li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>The prime. </td></tr>
<tr><td class="paramname">q</td><td>The cofactor. </td></tr>
<tr><td class="paramname">g</td><td>The generator. </td></tr>
<tr><td class="paramname">rgc</td><td>The pseudo-random generator context. </td></tr>
<tr><td class="paramname">hm</td><td>The hash to be signed. </td></tr>
<tr><td class="paramname">x</td><td>The private key value. </td></tr>
<tr><td class="paramname">r</td><td>The signature's <em>r</em> value. </td></tr>
<tr><td class="paramname">s</td><td>The signature's <em>s</em> value. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>on success. </td></tr>
<tr><td class="paramname">-1</td><td>on failure. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a072071da4da5af51d7a23805cf4ef3a7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dsavrfy </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structmpbarrett.html">mpbarrett</a> * </td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structmpbarrett.html">mpbarrett</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="structmpnumber.html">mpnumber</a> * </td>
<td class="paramname"><em>g</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structmpnumber.html">mpnumber</a> * </td>
<td class="paramname"><em>hm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structmpnumber.html">mpnumber</a> * </td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structmpnumber.html">mpnumber</a> * </td>
<td class="paramname"><em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structmpnumber.html">mpnumber</a> * </td>
<td class="paramname"><em>s</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function performs a raw DSA verification. </p>
<p>Verifying equations: </p>
<ul>
<li>Check <img class="formulaInl" alt="$0<r<q$" src="form_14.png"/> and <img class="formulaInl" alt="$0<s<q$" src="form_15.png"/> </li>
<li><img class="formulaInl" alt="$w=s^{-1}\ \textrm{mod}\ q$" src="form_16.png"/> </li>
<li><img class="formulaInl" alt="$u_1=w \cdot h(m)\ \textrm{mod}\ q$" src="form_17.png"/> </li>
<li><img class="formulaInl" alt="$u_2=rw\ \textrm{mod}\ q$" src="form_18.png"/> </li>
<li><img class="formulaInl" alt="$v=(g^{u_1}y^{u_2}\ \textrm{mod}\ p)\ \textrm{mod}\ q$" src="form_19.png"/> </li>
<li>Check <img class="formulaInl" alt="$v=r$" src="form_20.png"/></li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>The prime. </td></tr>
<tr><td class="paramname">q</td><td>The cofactor. </td></tr>
<tr><td class="paramname">g</td><td>The generator. </td></tr>
<tr><td class="paramname">hm</td><td>The digest to be verified. </td></tr>
<tr><td class="paramname">y</td><td>The public key value. </td></tr>
<tr><td class="paramname">r</td><td>The signature's <em>r</em> value. </td></tr>
<tr><td class="paramname">s</td><td>The signature's <em>s</em> value. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">1</td><td>on success. </td></tr>
<tr><td class="paramname">0</td><td>on failure. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Sep 27 2013 02:36:25 for BeeCrypt 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>
