@dedis/kyber

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>"sign/bdn/index" | @dedis/kyber</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">@dedis/kyber</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="_sign_bdn_index_.html">"sign/bdn/index"</a> </li> </ul> <h1>External module "sign/bdn/index"</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Type aliases</h3> <ul class="tsd-index-list"> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_sign_bdn_index_.html#bdnsignature" class="tsd-kind-icon">Bdn<wbr>Signature</a></li> </ul> </section> <section class="tsd-index-section tsd-is-not-exported"> <h3>Variables</h3> <ul class="tsd-index-list"> <li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="_sign_bdn_index_.html#coef_size" class="tsd-kind-icon">COEF_<wbr>SIZE</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_sign_bdn_index_.html#aggregatepoints" class="tsd-kind-icon">aggregate<wbr>Points</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_sign_bdn_index_.html#aggregatepublickeys" class="tsd-kind-icon">aggregate<wbr>Public<wbr>Keys</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_sign_bdn_index_.html#aggregatesignatures" class="tsd-kind-icon">aggregate<wbr>Signatures</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_sign_bdn_index_.html#hashpointtor" class="tsd-kind-icon">hash<wbr>Point<wbr>ToR</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_sign_bdn_index_.html#sign" class="tsd-kind-icon">sign</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_sign_bdn_index_.html#verify" class="tsd-kind-icon">verify</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Type aliases</h2> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="bdnsignature" class="tsd-anchor"></a> <h3>Bdn<wbr>Signature</h3> <div class="tsd-signature tsd-kind-icon">Bdn<wbr>Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Buffer</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/sign/bdn/index.ts#L11">sign/bdn/index.ts:11</a></li> </ul> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-not-exported"> <h2>Variables</h2> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> <a name="coef_size" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> COEF_<wbr>SIZE</h3> <div class="tsd-signature tsd-kind-icon">COEF_<wbr>SIZE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 128 / 8</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/sign/bdn/index.ts#L9">sign/bdn/index.ts:9</a></li> </ul> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a name="aggregatepoints" class="tsd-anchor"></a> <h3>aggregate<wbr>Points</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">aggregate<wbr>Points<span class="tsd-signature-symbol">(</span>mask<span class="tsd-signature-symbol">: </span><a href="../classes/_sign_mask_.mask.html" class="tsd-signature-type">Mask</a>, points<span class="tsd-signature-symbol">: </span><a href="../interfaces/_suite_.point.html" class="tsd-signature-type">Point</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_suite_.point.html" class="tsd-signature-type">Point</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/sign/bdn/index.ts#L44">sign/bdn/index.ts:44</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>mask: <a href="../classes/_sign_mask_.mask.html" class="tsd-signature-type">Mask</a></h5> </li> <li> <h5>points: <a href="../interfaces/_suite_.point.html" class="tsd-signature-type">Point</a><span class="tsd-signature-symbol">[]</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="../interfaces/_suite_.point.html" class="tsd-signature-type">Point</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="aggregatepublickeys" class="tsd-anchor"></a> <h3>aggregate<wbr>Public<wbr>Keys</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">aggregate<wbr>Public<wbr>Keys<span class="tsd-signature-symbol">(</span>mask<span class="tsd-signature-symbol">: </span><a href="../classes/_sign_mask_.mask.html" class="tsd-signature-type">Mask</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_suite_.point.html" class="tsd-signature-type">Point</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/sign/bdn/index.ts#L77">sign/bdn/index.ts:77</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>mask: <a href="../classes/_sign_mask_.mask.html" class="tsd-signature-type">Mask</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="../interfaces/_suite_.point.html" class="tsd-signature-type">Point</a></h4> <p>The new point representing the aggregation</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="aggregatesignatures" class="tsd-anchor"></a> <h3>aggregate<wbr>Signatures</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">aggregate<wbr>Signatures<span class="tsd-signature-symbol">(</span>mask<span class="tsd-signature-symbol">: </span><a href="../classes/_sign_mask_.mask.html" class="tsd-signature-type">Mask</a>, sigs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_suite_.point.html" class="tsd-signature-type">Point</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/sign/bdn/index.ts#L88">sign/bdn/index.ts:88</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>mask: <a href="../classes/_sign_mask_.mask.html" class="tsd-signature-type">Mask</a></h5> </li> <li> <h5>sigs: <span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">[]</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="../interfaces/_suite_.point.html" class="tsd-signature-type">Point</a></h4> <p>The new point representing the aggregation</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="hashpointtor" class="tsd-anchor"></a> <h3>hash<wbr>Point<wbr>ToR</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">hash<wbr>Point<wbr>ToR<span class="tsd-signature-symbol">(</span>pubkeys<span class="tsd-signature-symbol">: </span><a href="../interfaces/_suite_.point.html" class="tsd-signature-type">Point</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/sign/bdn/index.ts#L19">sign/bdn/index.ts:19</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>pubkeys: <a href="../interfaces/_suite_.point.html" class="tsd-signature-type">Point</a><span class="tsd-signature-symbol">[]</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">[]</span></h4> <p>The list of coefficients as BigNumber</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="sign" class="tsd-anchor"></a> <h3>sign</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">sign<span class="tsd-signature-symbol">(</span>msg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, secret<span class="tsd-signature-symbol">: </span><a href="../classes/_pairing_scalar_.bn256scalar.html" class="tsd-signature-type">BN256Scalar</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_sign_bdn_index_.html#bdnsignature" class="tsd-signature-type">BdnSignature</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/sign/bdn/index.ts#L109">sign/bdn/index.ts:109</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>msg: <span class="tsd-signature-type">Buffer</span></h5> </li> <li> <h5>secret: <a href="../classes/_pairing_scalar_.bn256scalar.html" class="tsd-signature-type">BN256Scalar</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_sign_bdn_index_.html#bdnsignature" class="tsd-signature-type">BdnSignature</a></h4> <p>The BDN signature</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="verify" class="tsd-anchor"></a> <h3>verify</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">verify<span class="tsd-signature-symbol">(</span>msg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, mask<span class="tsd-signature-symbol">: </span><a href="../classes/_sign_mask_.mask.html" class="tsd-signature-type">Mask</a>, sig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/sign/bdn/index.ts#L122">sign/bdn/index.ts:122</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>msg: <span class="tsd-signature-type">Buffer</span></h5> </li> <li> <h5>mask: <a href="../classes/_sign_mask_.mask.html" class="tsd-signature-type">Mask</a></h5> </li> <li> <h5>sig: <span class="tsd-signature-type">Buffer</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> <p>true if the signature matches, false otherwise</p> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class="current tsd-kind-external-module"> <a href="_sign_bdn_index_.html">"sign/bdn/index"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="_sign_bdn_index_.html#bdnsignature" class="tsd-kind-icon">Bdn<wbr>Signature</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_sign_bdn_index_.html#coef_size" class="tsd-kind-icon">COEF_<wbr>SIZE</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_sign_bdn_index_.html#aggregatepoints" class="tsd-kind-icon">aggregate<wbr>Points</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_sign_bdn_index_.html#aggregatepublickeys" class="tsd-kind-icon">aggregate<wbr>Public<wbr>Keys</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_sign_bdn_index_.html#aggregatesignatures" class="tsd-kind-icon">aggregate<wbr>Signatures</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_sign_bdn_index_.html#hashpointtor" class="tsd-kind-icon">hash<wbr>Point<wbr>ToR</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_sign_bdn_index_.html#sign" class="tsd-kind-icon">sign</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_sign_bdn_index_.html#verify" class="tsd-kind-icon">verify</a> </li> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>