danog/fast-srp
1
0
Fork 0
mirror of https://github.com/danog/fast-srp.git synced 2024-11-30 04:19:18 +01:00
Code Issues Projects Releases Wiki Activity
495ffbd134
fast-srp/docs/classes/srp.html
Supereg 3e1ddc35e0
Update docs
2021-03-09 12:33:57 +01:00

488 lines
33 KiB
HTML
Raw Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>SRP | fast-srp-hap</title>
<meta name="description" content="Documentation for fast-srp-hap">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</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.json" 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">fast-srp-hap</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>
</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="../modules.html">fast-srp-hap</a>
</li>
<li>
<a href="srp.html">SRP</a>
</li>
</ul>
<h1>Class SRP</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">SRP</span>
</li>
</ul>
</section>
<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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="srp.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="srp.html#params" class="tsd-kind-icon">params</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="srp.html#computeverifier" class="tsd-kind-icon">compute<wbr>Verifier</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="srp.html#genkey" class="tsd-kind-icon">gen<wbr>Key</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new SRP<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="srp.html" class="tsd-signature-type" data-tsd-kind="Class">SRP</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<h4 class="tsd-returns-title">Returns <a href="srp.html" class="tsd-signature-type" data-tsd-kind="Class">SRP</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
<a name="params" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> <span class="tsd-flag ts-flagStatic">Static</span> params</h3>
<div class="tsd-signature tsd-kind-icon">params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>1024<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>N_length_bits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>1536<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>N_length_bits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>2048<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>N_length_bits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>3072<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>N_length_bits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>4096<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>N_length_bits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>6244<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>N_length_bits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>8192<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>N_length_bits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>hap<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>N_length_bits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/homebridge/fast-srp/blob/3aaeb5b/src/srp.ts#L81">srp.ts:81</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>1024<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>N_length_bits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span></h5>
</li>
<li class="tsd-parameter">
<h5>N_<wbr>length_<wbr>bits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span></h5>
</li>
<li class="tsd-parameter">
<h5>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5>1536<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>N_length_bits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span></h5>
</li>
<li class="tsd-parameter">
<h5>N_<wbr>length_<wbr>bits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span></h5>
</li>
<li class="tsd-parameter">
<h5>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5>2048<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>N_length_bits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span></h5>
</li>
<li class="tsd-parameter">
<h5>N_<wbr>length_<wbr>bits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span></h5>
</li>
<li class="tsd-parameter">
<h5>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5>3072<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>N_length_bits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span></h5>
</li>
<li class="tsd-parameter">
<h5>N_<wbr>length_<wbr>bits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span></h5>
</li>
<li class="tsd-parameter">
<h5>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5>4096<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>N_length_bits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span></h5>
</li>
<li class="tsd-parameter">
<h5>N_<wbr>length_<wbr>bits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span></h5>
</li>
<li class="tsd-parameter">
<h5>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5>6244<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>N_length_bits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span></h5>
</li>
<li class="tsd-parameter">
<h5>N_<wbr>length_<wbr>bits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span></h5>
</li>
<li class="tsd-parameter">
<h5>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5>8192<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>N_length_bits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span></h5>
</li>
<li class="tsd-parameter">
<h5>N_<wbr>length_<wbr>bits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span></h5>
</li>
<li class="tsd-parameter">
<h5>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5>hap<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>N_length_bits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span></h5>
</li>
<li class="tsd-parameter">
<h5>N_<wbr>length_<wbr>bits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger</span></h5>
</li>
<li class="tsd-parameter">
<h5>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
</ul>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="computeverifier" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> compute<wbr>Verifier</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">compute<wbr>Verifier<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../interfaces/srpparams.html" class="tsd-signature-type" data-tsd-kind="Interface">SrpParams</a>, salt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, I<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, P<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">Buffer</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/homebridge/fast-srp/blob/3aaeb5b/src/srp.ts#L99">srp.ts:99</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The verifier is calculated as described in Section 3 of [SRP-RFC].
We give the algorithm here for convenience.</p>
</div>
<p>The verifier (v) is computed based on the salt (s), user name (I),
password (P), and group parameters (N, g).</p>
<pre><code><span style="color: #000000"> </span><span style="color: #001080">x</span><span style="color: #000000"> = </span><span style="color: #795E26">H</span><span style="color: #000000">(</span><span style="color: #001080">s</span><span style="color: #000000"> | </span><span style="color: #795E26">H</span><span style="color: #000000">(</span><span style="color: #0070C1">I</span><span style="color: #000000"> | </span><span style="color: #A31515">&quot;:&quot;</span><span style="color: #000000"> | </span><span style="color: #0070C1">P</span><span style="color: #000000">))</span>
<span style="color: #000000"> </span><span style="color: #001080">v</span><span style="color: #000000"> = </span><span style="color: #001080">g</span><span style="color: #000000">^</span><span style="color: #001080">x</span><span style="color: #000000"> % </span><span style="color: #0070C1">N</span>
</code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>params: <a href="../interfaces/srpparams.html" class="tsd-signature-type" data-tsd-kind="Interface">SrpParams</a></h5>
<div class="tsd-comment tsd-typography">
<p>Group parameters, with .N, .g, .hash</p>
</div>
</li>
<li>
<h5>salt: <span class="tsd-signature-type">Buffer</span></h5>
</li>
<li>
<h5>I: <span class="tsd-signature-type">Buffer</span></h5>
<div class="tsd-comment tsd-typography">
<p>User identity</p>
</div>
</li>
<li>
<h5>P: <span class="tsd-signature-type">Buffer</span></h5>
<div class="tsd-comment tsd-typography">
<p>User password</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="genkey" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> gen<wbr>Key</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">gen<wbr>Key<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><a href="../modules.html#genkeycallback" class="tsd-signature-type" data-tsd-kind="Type alias">GenKeyCallback</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-signature tsd-kind-icon">gen<wbr>Key<span class="tsd-signature-symbol">(</span>bytes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, callback<span class="tsd-signature-symbol">: </span><a href="../modules.html#genkeycallback" class="tsd-signature-type" data-tsd-kind="Type alias">GenKeyCallback</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-signature tsd-kind-icon">gen<wbr>Key<span class="tsd-signature-symbol">(</span>bytes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/homebridge/fast-srp/blob/3aaeb5b/src/srp.ts#L114">srp.ts:114</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Generate a random key with a length of 32 bytes</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>callback: <a href="../modules.html#genkeycallback" class="tsd-signature-type" data-tsd-kind="Type alias">GenKeyCallback</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/homebridge/fast-srp/blob/3aaeb5b/src/srp.ts#L122">srp.ts:122</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Generate a random key.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>bytes: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>Length of key</p>
</div>
</li>
<li>
<h5>callback: <a href="../modules.html#genkeycallback" class="tsd-signature-type" data-tsd-kind="Type alias">GenKeyCallback</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/homebridge/fast-srp/blob/3aaeb5b/src/srp.ts#L129">srp.ts:129</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Generate a random key.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> bytes: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>Length of key. Defaults to 32.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="srp.html" class="tsd-kind-icon">SRP</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="srp.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
<a href="srp.html#params" class="tsd-kind-icon">params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="srp.html#computeverifier" class="tsd-kind-icon">compute<wbr>Verifier</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="srp.html#genkey" class="tsd-kind-icon">gen<wbr>Key</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class">
<a href="srpclient.html" class="tsd-kind-icon">Srp<wbr>Client</a>
</li>
<li class=" tsd-kind-class">
<a href="srpserver.html" class="tsd-kind-icon">Srp<wbr>Server</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/baseidentity.html" class="tsd-kind-icon">Base<wbr>Identity</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/srpparams.html" class="tsd-kind-icon">Srp<wbr>Params</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../modules.html#genkeycallback" class="tsd-kind-icon">Gen<wbr>Key<wbr>Callback</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../modules.html#identity" class="tsd-kind-icon">Identity</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../modules.html#passwordidentity" class="tsd-kind-icon">Password<wbr>Identity</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../modules.html#verifieridentity" class="tsd-kind-icon">Verifier<wbr>Identity</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<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>
</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-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink