code refactoring and added extensive documentation
This commit is contained in:
1
docs/assets/css/main.css
Normal file
1
docs/assets/css/main.css
Normal file
File diff suppressed because one or more lines are too long
BIN
docs/assets/images/icons.png
Normal file
BIN
docs/assets/images/icons.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.4 KiB |
BIN
docs/assets/images/icons@2x.png
Normal file
BIN
docs/assets/images/icons@2x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
BIN
docs/assets/images/widgets.png
Normal file
BIN
docs/assets/images/widgets.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 480 B |
BIN
docs/assets/images/widgets@2x.png
Normal file
BIN
docs/assets/images/widgets@2x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 855 B |
51
docs/assets/js/main.js
Normal file
51
docs/assets/js/main.js
Normal file
File diff suppressed because one or more lines are too long
1
docs/assets/js/search.json
Normal file
1
docs/assets/js/search.json
Normal file
File diff suppressed because one or more lines are too long
697
docs/classes/svault.securevault.html
Normal file
697
docs/classes/svault.securevault.html
Normal file
@@ -0,0 +1,697 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>SecureVault | opentoken</title>
|
||||
<meta name="description" content="Documentation for opentoken">
|
||||
<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.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">opentoken</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="../modules/svault.html">SVault</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="svault.securevault.html">SecureVault</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class SecureVault</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Class representing a SecureVault.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">SecureVault</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="svault.securevault.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"><a href="svault.securevault.html#privpath" class="tsd-kind-icon">priv<wbr>Path</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="svault.securevault.html#pubpath" class="tsd-kind-icon">pub<wbr>Path</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="svault.securevault.html#safe" class="tsd-kind-icon">safe</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="svault.securevault.html#storage" class="tsd-kind-icon">storage</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"><a href="svault.securevault.html#clearvault" class="tsd-kind-icon">clear<wbr>Vault</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="svault.securevault.html#decryptdata" class="tsd-kind-icon">decrypt<wbr>Data</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="svault.securevault.html#findstorage" class="tsd-kind-icon">find<wbr>Storage</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="svault.securevault.html#getstorage" class="tsd-kind-icon">get<wbr>Storage</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="svault.securevault.html#loaddata" class="tsd-kind-icon">load<wbr>Data</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="svault.securevault.html#pushdata" class="tsd-kind-icon">push<wbr>Data</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="svault.securevault.html#pushstorage" class="tsd-kind-icon">push<wbr>Storage</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="svault.securevault.html#savedata" class="tsd-kind-icon">save<wbr>Data</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="svault.securevault.html#setstorage" class="tsd-kind-icon">set<wbr>Storage</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="svault.securevault.html#writetransaction" class="tsd-kind-icon">write<wbr>Transaction</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="svault.securevault.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 <wbr>Secure<wbr>Vault<span class="tsd-signature-symbol">(</span>publicKey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, privateKey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><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><a href="svault.securevault.html" class="tsd-signature-type">SecureVault</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:76</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Create a SecureVault.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> publicKey: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Path to public key.</p>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> privateKey: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Path to private key.</p>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="svault.securevault.html" class="tsd-signature-type">SecureVault</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">
|
||||
<a name="privpath" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> priv<wbr>Path</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">priv<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:72</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Path to private key</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="pubpath" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> pub<wbr>Path</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">pub<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:74</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Path to public key</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="safe" class="tsd-anchor"></a>
|
||||
<h3>safe</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">safe<span class="tsd-signature-symbol">:</span> <a href="../interfaces/svault.securevaultlist.html" class="tsd-signature-type">secureVaultList</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:70</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Safe object</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="storage" class="tsd-anchor"></a>
|
||||
<h3>storage</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">storage<span class="tsd-signature-symbol">:</span> <a href="../interfaces/svault.storageitem.html" class="tsd-signature-type">StorageItem</a><span class="tsd-signature-symbol">[]</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:76</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Array of unencrypted items</p>
|
||||
</div>
|
||||
</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">
|
||||
<a name="clearvault" class="tsd-anchor"></a>
|
||||
<h3>clear<wbr>Vault</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">clear<wbr>Vault<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:281</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Clears all encrypted items from safe.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="decryptdata" class="tsd-anchor"></a>
|
||||
<h3>decrypt<wbr>Data</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">decrypt<wbr>Data<span class="tsd-signature-symbol">(</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"><</span><span class="tsd-signature-type">void</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 src/vault.ts:175</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Decrypts safe data.
|
||||
Requires specified and loaded private key.
|
||||
Prints data to console.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>Resolves promise after decrypted</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="findstorage" class="tsd-anchor"></a>
|
||||
<h3>find<wbr>Storage</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">find<wbr>Storage<span class="tsd-signature-symbol">(</span>tag<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><a href="../interfaces/svault.storageitem.html" class="tsd-signature-type">StorageItem</a><span class="tsd-signature-symbol">[]</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:270</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Gets list of UUIDs matching the tag.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>tag: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>tag to search for</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="../interfaces/svault.storageitem.html" class="tsd-signature-type">StorageItem</a><span class="tsd-signature-symbol">[]</span></h4>
|
||||
<p>UUID from item.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getstorage" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Storage</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Storage<span class="tsd-signature-symbol">(</span>suuid<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-type">any</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:255</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Gets unencrypted data of item specified by suuid.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>suuid: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>UUID for item</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
<p>Data from item.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="loaddata" class="tsd-anchor"></a>
|
||||
<h3>load<wbr>Data</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">load<wbr>Data<span class="tsd-signature-symbol">(</span>path<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</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 src/vault.ts:153</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Loads safe from file and check compatibility</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Path to safefile.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>Resolves promise after loaded</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="pushdata" class="tsd-anchor"></a>
|
||||
<h3>push<wbr>Data</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">push<wbr>Data<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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"><</span><span class="tsd-signature-type">string</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 src/vault.ts:100</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Encrypts and appends data to SecureVault.
|
||||
Also writes data to transaction log using @function writeTransaction</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Path to public key.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>Returns the uuid of the added object as promise</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="pushstorage" class="tsd-anchor"></a>
|
||||
<h3>push<wbr>Storage</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">push<wbr>Storage<span class="tsd-signature-symbol">(</span>tag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:221</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Appends unencrypted data to safe.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>tag: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Tag for item</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Data to store.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="savedata" class="tsd-anchor"></a>
|
||||
<h3>save<wbr>Data</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">save<wbr>Data<span class="tsd-signature-symbol">(</span>path<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</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 src/vault.ts:140</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Saves safe to file</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Path to safefile.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>Resolves promise after loaded</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="setstorage" class="tsd-anchor"></a>
|
||||
<h3>set<wbr>Storage</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">set<wbr>Storage<span class="tsd-signature-symbol">(</span>suuid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:240</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Sets unencrypted data for item specified by suuid.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>suuid: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>UUID for item</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Data to store.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="writetransaction" class="tsd-anchor"></a>
|
||||
<h3>write<wbr>Transaction</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">write<wbr>Transaction<span class="tsd-signature-symbol">(</span>payload<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-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:131</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Writes data to the vault log file located at ./vault.log</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>payload: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Text to append</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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>publicKeyDir<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, privateKeyDir<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-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:199</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Generates RSA keypair.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>publicKeyDir: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>privateKeyDir: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mlparser.html">MLParser</a>
|
||||
</li>
|
||||
<li class="current tsd-kind-namespace">
|
||||
<a href="../modules/svault.html">SVault</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 tsd-parent-kind-namespace">
|
||||
<a href="svault.securevault.html" class="tsd-kind-icon">Secure<wbr>Vault</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a href="svault.securevault.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="svault.securevault.html#privpath" class="tsd-kind-icon">priv<wbr>Path</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="svault.securevault.html#pubpath" class="tsd-kind-icon">pub<wbr>Path</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="svault.securevault.html#safe" class="tsd-kind-icon">safe</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="svault.securevault.html#storage" class="tsd-kind-icon">storage</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="svault.securevault.html#clearvault" class="tsd-kind-icon">clear<wbr>Vault</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="svault.securevault.html#decryptdata" class="tsd-kind-icon">decrypt<wbr>Data</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="svault.securevault.html#findstorage" class="tsd-kind-icon">find<wbr>Storage</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="svault.securevault.html#getstorage" class="tsd-kind-icon">get<wbr>Storage</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="svault.securevault.html#loaddata" class="tsd-kind-icon">load<wbr>Data</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="svault.securevault.html#pushdata" class="tsd-kind-icon">push<wbr>Data</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="svault.securevault.html#pushstorage" class="tsd-kind-icon">push<wbr>Storage</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="svault.securevault.html#savedata" class="tsd-kind-icon">save<wbr>Data</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="svault.securevault.html#setstorage" class="tsd-kind-icon">set<wbr>Storage</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="svault.securevault.html#writetransaction" class="tsd-kind-icon">write<wbr>Transaction</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||||
<a href="svault.securevault.html#genkey" class="tsd-kind-icon">gen<wbr>Key</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
|
||||
<a href="../interfaces/svault.securevaultitem.html" class="tsd-kind-icon">Secure<wbr>Vault<wbr>Item</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
|
||||
<a href="../interfaces/svault.storageitem.html" class="tsd-kind-icon">Storage<wbr>Item</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
|
||||
<a href="../interfaces/svault.securevaultlist.html" class="tsd-kind-icon">secure<wbr>Vault<wbr>List</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<a href="../modules/svault.html#vaultversion" class="tsd-kind-icon">vault<wbr>Version</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-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-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-method 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>
|
||||
</body>
|
||||
</html>
|
||||
380
docs/globals.html
Normal file
380
docs/globals.html
Normal file
@@ -0,0 +1,380 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>opentoken</title>
|
||||
<meta name="description" content="Documentation for opentoken">
|
||||
<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.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">opentoken</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>
|
||||
</ul>
|
||||
<h1>opentoken</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>Namespaces</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-namespace"><a href="modules/mlgenerator.html" class="tsd-kind-icon">MLGenerator</a></li>
|
||||
<li class="tsd-kind-namespace"><a href="modules/mlparser.html" class="tsd-kind-icon">MLParser</a></li>
|
||||
<li class="tsd-kind-namespace"><a href="modules/svault.html" class="tsd-kind-icon">SVault</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Interfaces</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-interface"><a href="interfaces/otglobalconfig.html" class="tsd-kind-icon">OTGlobal<wbr>Config</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Variables</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-variable"><a href="globals.html#action" class="tsd-kind-icon">action</a></li>
|
||||
<li class="tsd-kind-variable"><a href="globals.html#configpath" class="tsd-kind-icon">config<wbr>Path</a></li>
|
||||
<li class="tsd-kind-variable"><a href="globals.html#dryrun" class="tsd-kind-icon">dryrun</a></li>
|
||||
<li class="tsd-kind-variable"><a href="globals.html#force" class="tsd-kind-icon">force</a></li>
|
||||
<li class="tsd-kind-variable"><a href="globals.html#html" class="tsd-kind-icon">html</a></li>
|
||||
<li class="tsd-kind-variable"><a href="globals.html#mails" class="tsd-kind-icon">mails</a></li>
|
||||
<li class="tsd-kind-variable"><a href="globals.html#privkey" class="tsd-kind-icon">priv<wbr>Key</a></li>
|
||||
<li class="tsd-kind-variable"><a href="globals.html#pubkey" class="tsd-kind-icon">pub<wbr>Key</a></li>
|
||||
<li class="tsd-kind-variable"><a href="globals.html#safefile" class="tsd-kind-icon">safe<wbr>File</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function"><a href="globals.html#delay" class="tsd-kind-icon">delay</a></li>
|
||||
<li class="tsd-kind-function"><a href="globals.html#mkstringcn" class="tsd-kind-icon">mkstringCN</a></li>
|
||||
<li class="tsd-kind-function"><a href="globals.html#shufflearray" class="tsd-kind-icon">shuffle<wbr>Array</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Variables</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable">
|
||||
<a name="action" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagLet">Let</span> action</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = -1</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in index.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable">
|
||||
<a name="configpath" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagLet">Let</span> config<wbr>Path</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">config<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in index.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable">
|
||||
<a name="dryrun" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagLet">Let</span> dryrun</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">dryrun<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in index.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable">
|
||||
<a name="force" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagLet">Let</span> force</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">force<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in index.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable">
|
||||
<a name="html" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagLet">Let</span> html</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">html<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in index.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable">
|
||||
<a name="mails" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagLet">Let</span> mails</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">mails<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in index.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable">
|
||||
<a name="privkey" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagLet">Let</span> priv<wbr>Key</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">priv<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in index.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable">
|
||||
<a name="pubkey" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagLet">Let</span> pub<wbr>Key</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">pub<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in index.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable">
|
||||
<a name="safefile" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagLet">Let</span> safe<wbr>File</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">safe<wbr>File<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in index.ts:27</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">
|
||||
<a name="delay" class="tsd-anchor"></a>
|
||||
<h3>delay</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function">
|
||||
<li class="tsd-signature tsd-kind-icon">delay<span class="tsd-signature-symbol">(</span>t<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"><</span><span class="tsd-signature-type">unknown</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 src/util/misc.ts:44</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Wraps setTimeout into Promise</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>t: <span class="tsd-signature-type">number</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Millisceonds</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||||
<a name="mkstringcn" class="tsd-anchor"></a>
|
||||
<h3>mkstringCN</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function">
|
||||
<li class="tsd-signature tsd-kind-icon">mkstringCN<span class="tsd-signature-symbol">(</span>length<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">string</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/util/misc.ts:30</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Generate random string with specified length.
|
||||
Generates only numbers and capital letters.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>length: <span class="tsd-signature-type">number</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>length of String</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
<p>generated string</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||||
<a name="shufflearray" class="tsd-anchor"></a>
|
||||
<h3>shuffle<wbr>Array</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function">
|
||||
<li class="tsd-signature tsd-kind-icon">shuffle<wbr>Array<span class="tsd-signature-symbol">(</span>array<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/util/shuffle.ts:5</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Randomize items in an array</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>array: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Array to be shuffeled</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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="globals current ">
|
||||
<a href="globals.html"><em>Globals</em></a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="modules/mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="modules/mlparser.html">MLParser</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="modules/svault.html">SVault</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="interfaces/otglobalconfig.html" class="tsd-kind-icon">OTGlobal<wbr>Config</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#action" class="tsd-kind-icon">action</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#configpath" class="tsd-kind-icon">config<wbr>Path</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#dryrun" class="tsd-kind-icon">dryrun</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#force" class="tsd-kind-icon">force</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#html" class="tsd-kind-icon">html</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#mails" class="tsd-kind-icon">mails</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#privkey" class="tsd-kind-icon">priv<wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#pubkey" class="tsd-kind-icon">pub<wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#safefile" class="tsd-kind-icon">safe<wbr>File</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="globals.html#delay" class="tsd-kind-icon">delay</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="globals.html#mkstringcn" class="tsd-kind-icon">mkstringCN</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="globals.html#shufflearray" class="tsd-kind-icon">shuffle<wbr>Array</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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>
|
||||
</body>
|
||||
</html>
|
||||
316
docs/index.html
Normal file
316
docs/index.html
Normal file
@@ -0,0 +1,316 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>opentoken</title>
|
||||
<meta name="description" content="Documentation for opentoken">
|
||||
<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.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">opentoken</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>
|
||||
</ul>
|
||||
<h1>opentoken</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<div class="tsd-panel tsd-typography">
|
||||
<a href="#one-time-codejs" id="one-time-codejs" style="color: inherit; text-decoration: none;">
|
||||
<h1>one-time-code.js</h1>
|
||||
</a>
|
||||
<p>Dies ist ein Programm zum erzeugen von anonymen Schlüsseln. Diese werden automatisch den Teilnehmern zugesendet.
|
||||
Zudem wird ein asymetrisch verschlüsselter Safe erstellt.</p>
|
||||
<a href="#zweck" id="zweck" style="color: inherit; text-decoration: none;">
|
||||
<h2>Zweck</h2>
|
||||
</a>
|
||||
<p>Für ananoyme Wahlen muss sichergestellt werden, dass:</p>
|
||||
<ol>
|
||||
<li>Nur berechtigter Personen abstimmen können</li>
|
||||
<li>Jeder Wähler nicht rückverfolgbar ist</li>
|
||||
<li>Jeder Wähler nur einmal abstimmen kann</li>
|
||||
</ol>
|
||||
<p>Punkte 1. und 2. Lassen sich mit dieser Anwendug realisieren.</p>
|
||||
<a href="#funktionsprinzip" id="funktionsprinzip" style="color: inherit; text-decoration: none;">
|
||||
<h2>Funktionsprinzip</h2>
|
||||
</a>
|
||||
<p>Diese Anwendung muss auf zwei Systemen installiert sein. Beide Systeme dürfen nicht aufeinander Zugreifen können und müssen von verschiedenen Personen bedient werden.
|
||||
Die beiden Systeme sind:</p>
|
||||
<ul>
|
||||
<li>System A & Person A: Hier werden die Schlüssel erzeugt, benutzern zufällig zugewiesen und versendet. </li>
|
||||
<li>System B & Person B: Hier wird das Schlüsselpaar erzeugt und hier kann der Safe entschlüsselt werden.</li>
|
||||
<li>Person C: Erhält von Person A die gültigen Codes und verifiziert die eingehenden Wahlzettel.</li>
|
||||
</ul>
|
||||
<p>Da Person A die SChlüssel-Nutzer Zuordnung zu keinem Zeitpunkt kennt, kann sie auch die selbe Person wie Person C sein.</p>
|
||||
<a href="#schritt-1" id="schritt-1" style="color: inherit; text-decoration: none;">
|
||||
<h3>Schritt 1</h3>
|
||||
</a>
|
||||
<p>Auf System B wird ein Schlüsselpaar erzeugt. Dies besteht aus dem Öffentlichen und Privaten schlüssel.</p>
|
||||
<ul>
|
||||
<li>Der Öffentliche schlüssel dient zur Verschlüsselung der Daten und kann nicht zum entschlüsseln verwendet werden.</li>
|
||||
<li>Der Private schlüssel dient zur entschlüsselung des Safes und darf System B NIEMALS verlassen.</li>
|
||||
</ul>
|
||||
<p>Dazu wird z.B. folgender Befehl ausgeführt:
|
||||
`ts-node .\index.ts --privkey private.key --pubkey public.key --genkey</p>
|
||||
<p>Der erzeugte Öffentliche schlüssel muss an Person A übergeben werden. Diese nutzt den Schlüssel auf System A zum verschlüsseln des Passwortsafes.</p>
|
||||
<a href="#schritt-2" id="schritt-2" style="color: inherit; text-decoration: none;">
|
||||
<h3>Schritt 2</h3>
|
||||
</a>
|
||||
<p>Auf System A werden jetzt die Codes erzeugt und an die Nutzer versendet.
|
||||
Die Nutzer-Schlüssel zuweisung erfolgt temporär auf System A, ist jedoch nicht auslesbar und wird unmittelbar im Passwortsafe gespeichert.</p>
|
||||
<p>Person A führt folgenden Befehl aus:
|
||||
`ts-node .\index.ts --config config.json --pubkey public.key --send --safe .\out\credentials.json --mails mail.txt -html template.html</p>
|
||||
<p>Dabei wird eine Liste mit den Mails und Namen sowie der schlüssel übergeben.</p>
|
||||
<p>Der Ausfbau der mail.txt ist:</p>
|
||||
<pre><code><span class="hljs-tag"><<span class="hljs-name">mail</span>></span>;<span class="hljs-tag"><<span class="hljs-name">name</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">mail</span>></span>;<span class="hljs-tag"><<span class="hljs-name">name</span>></span>
|
||||
...</code></pre>
|
||||
<p>Es werden drei Ausgaben erzeugt:</p>
|
||||
<ul>
|
||||
<li>Eine RegEx vorlage für alle Codes</li>
|
||||
<li>Safe-Datei</li>
|
||||
</ul>
|
||||
<p>Die Speicherorte der Code-Files werden in der config.json angegeben.
|
||||
Der Safe wird an Person B weitergegeben. </p>
|
||||
<p>Das Programm versendet automatisch Mails an alle Personen. Die HTML Vorlage wird mit --html angegeben.
|
||||
In der Vorlage werden folgende Zeichenketten ersetzt:
|
||||
<code>{{code}} => Genereirter Code </code>{{name}}
|
||||
=> Name
|
||||
`{{mail}}
|
||||
=> Mail</p>
|
||||
<p>Der SMTP-Relay-Server wird in der config.json angegeben.
|
||||
Geenaue Doku: <a href="https://nodemailer.com/smtp/">https://nodemailer.com/smtp/</a></p>
|
||||
<a href="#schritt-3" id="schritt-3" style="color: inherit; text-decoration: none;">
|
||||
<h3>Schritt 3</h3>
|
||||
</a>
|
||||
<p>Ggf. muss der Safe entschlüsselt werden. Beispielfälle wären: </p>
|
||||
<ul>
|
||||
<li>Teilnehmer hat keinen Zugriff auf das Mailkonto</li>
|
||||
<li>Teilnehmer hat seinen Code vergessen</li>
|
||||
<li>Mail wurd durch den Spamfilter entfernt</li>
|
||||
</ul>
|
||||
<p>Person B muss dann mit dem Privaten Schlüssel den Safe auslesen und dem Teilnehmer seinen Code zukommen lassen.
|
||||
Dazu muss golgender Befehl ausgeführt werden:
|
||||
ts-node .\index.ts --privkey private.key --decrypt --safe .\out\credentials.json</p>
|
||||
<a href="#config-datei" id="config-datei" style="color: inherit; text-decoration: none;">
|
||||
<h2>Config-Datei</h2>
|
||||
</a>
|
||||
<pre><code>{
|
||||
<span class="hljs-attr">"mail"</span>:{
|
||||
<span class="hljs-attr">"host"</span>: <span class="hljs-string">"<mailserver>"</span>,
|
||||
<span class="hljs-attr">"port"</span>: <mailport>,
|
||||
<span class="hljs-attr">"secure"</span>: <use ssl>,
|
||||
<span class="hljs-attr">"auth"</span>: {
|
||||
<span class="hljs-attr">"user"</span>: <span class="hljs-string">"<mail-user>"</span>,
|
||||
<span class="hljs-attr">"pass"</span>: <span class="hljs-string">"<mail-password>"</span>
|
||||
},
|
||||
<span class="hljs-attr">"tls"</span>: {
|
||||
<span class="hljs-attr">"rejectUnauthorized"</span>: <span class="hljs-literal">false</span>,
|
||||
<span class="hljs-attr">"ciphers"</span>:<span class="hljs-string">"SSLv3"</span>
|
||||
}
|
||||
},
|
||||
<span class="hljs-attr">"mailFrom"</span>: <span class="hljs-string">"<absender name>"</span>,
|
||||
<span class="hljs-attr">"outFileMatch"</span>: <span class="hljs-string">"<ausgabedatei regex>"</span>
|
||||
}</code></pre>
|
||||
<a href="#syntax" id="syntax" style="color: inherit; text-decoration: none;">
|
||||
<h2>Syntax</h2>
|
||||
</a>
|
||||
<p>==> Schlüsselpaar Erzeugen
|
||||
<code>ts-node .\index.ts --privkey <path-to-private-key> --pubkey <path-to-public-key> --genkey</code></p>
|
||||
<p>z.B. <code>ts-node .\index.ts --privkey private.key --pubkey public.key --genkey</code></p>
|
||||
<p>==> Codes Erzeugen und versenden
|
||||
<code>ts-node .\index.ts --config <path-to-config-key> --pubkey <path-to-public-key> --send --safe credentials.json --mails <path-to-mail-list> -html <path-to-html-template></code></p>
|
||||
<p>Achtung: Es wird im Safe geprüft, ob Mailadressen bereits "bedient" wurden. Sollte dies der Fall sein, werden keine Mails an diese Adresse gesendet. Dies lässt sich mit dem Schalter <code>--force</code> umgehen.</p>
|
||||
<p>z.B. <code>ts-node .\index.ts --config config.json --pubkey public.key --send --safe credentials.json --mails mail.txt -html template.html</code></p>
|
||||
<p>==> Safe entschlüsseln
|
||||
<code>ts-node .\index.ts --privkey <path-to-private-key> --decrypt --safe credentials.json</code></p>
|
||||
<p>z.B. <code>ts-node .\index.ts --privkey private.key --decrypt --safe credentials.json</code></p>
|
||||
<a href="#erweiterte-schalter" id="erweiterte-schalter" style="color: inherit; text-decoration: none;">
|
||||
<h3>Erweiterte Schalter</h3>
|
||||
</a>
|
||||
<ul>
|
||||
<li><code>--dryrun</code> : Mails werden nicht versendet und der Safe wird nicht verändert.</li>
|
||||
<li><code>--force</code> : Alle Codes werden neu generiert und alle mails werden gesendet. Ignoriere bereits gesendete mails.</li>
|
||||
</ul>
|
||||
<a href="#gepackte-binaries" id="gepackte-binaries" style="color: inherit; text-decoration: none;">
|
||||
<h2>Gepackte Binaries</h2>
|
||||
</a>
|
||||
<p>Die gepackten Binaries sind für Linux, MacOS und Windoof verfügbar: <a href="https://gitlab.dennisgunia.de/dennisgunia/one-time-code-js/-/tree/master/bin">Binaries</a></p>
|
||||
<p>Die befehle ändern sich wie folgt:</p>
|
||||
<p>==> Schlüsselpaar Erzeuge
|
||||
<code>./opentoken --privkey <path-to-private-key> --pubkey <path-to-public-key> --genkey</code></p>
|
||||
<p>z.B. <code>./opentoken --privkey private.key --pubkey public.key --genkey</code></p>
|
||||
<p>==> Codes Erzeugen und versenden
|
||||
<code>./opentoken --config <path-to-config-key> --pubkey <path-to-public-key> --send --safe .\out\credentials.json --mails <path-to-mail-list> -html <path-to-html-template></code></p>
|
||||
<p>z.B. <code>./opentoken --config config.json --pubkey public.key --send --safe .\out\credentials.json --mails mail.txt -html template.html</code></p>
|
||||
<p>==> Safe entschlüsseln
|
||||
<code>./opentoken --privkey <path-to-private-key> --decrypt --safe .\out\credentials.json</code></p>
|
||||
<p>z.B. <code>./opentoken --privkey private.key --decrypt --safe .\out\credentials.json</code></p>
|
||||
<a href="#ausführen-des-quellcodes" id="ausführen-des-quellcodes" style="color: inherit; text-decoration: none;">
|
||||
<h2>Ausführen des Quellcodes</h2>
|
||||
</a>
|
||||
<p>Der Sourcecode kann auch über ts-node ausgeführt werden.
|
||||
Dazu ist Node.js Version 12 zu verwenden</p>
|
||||
<p><code>nvm use 12</code></p>
|
||||
<p>Zum Ausführen sind folgende npm Pakete notwendig:</p>
|
||||
<ul>
|
||||
<li>typescript</li>
|
||||
<li>tslint</li>
|
||||
<li>ts-node</li>
|
||||
</ul>
|
||||
<p>Installerien sie diese mit:
|
||||
<code>npm install -g typescript tslint ts-node</code></p>
|
||||
<p>Clonen sie dieses Repository auf ihren lokalen rechner und wechseln sie anschließend in dessen verzeichniss:</p>
|
||||
<p><code>git clone https://gitlab.dennisgunia.de/dennisgunia/one-time-code-js.git</code></p>
|
||||
<p><code>cd one-time-code-js</code></p>
|
||||
<p>Installieren sie alle lokalen npm Pakete</p>
|
||||
<p><code>npm install</code></p>
|
||||
<p>Kopieren Sie die Config-Template und passen Sie die SMTP-Zugangsdaten an:</p>
|
||||
<p><code>cp config.template.json config.json</code></p>
|
||||
<p><code>vim config.json</code></p>
|
||||
<p>Das Skript kann nun über <code>npm run-script exec</code> oder <code>ts-node index.js</code> ausgeführt werden.</p>
|
||||
<a href="#packen-des-quellcodes" id="packen-des-quellcodes" style="color: inherit; text-decoration: none;">
|
||||
<h2>Packen des Quellcodes</h2>
|
||||
</a>
|
||||
<p>Zum Packen des Quellcodes ist das npm-Paket <code>pkg</code> zu installieren:</p>
|
||||
<p><code>npm install -g pkg</code></p>
|
||||
<p>Anschließend wird der Code in JS transpiliert und durch pkg gepackt:</p>
|
||||
<p><code>npm run-script build</code></p>
|
||||
<p>Die Binaries werden in <code>./bin</code> gespeichert. Diese sind auch auf Systemen ohne node.js ausführbar.</p>
|
||||
<a href="#was-landet-im-safe" id="was-landet-im-safe" style="color: inherit; text-decoration: none;">
|
||||
<h2>Was landet im Safe?</h2>
|
||||
</a>
|
||||
<p>Im safe landen die verschlüsselten Zuordnungen zwischen Codes und Mailadressen.</p>
|
||||
<p>Zudem werden die verwendeten Codes und die bereits gesendeten Mailadressen seperat voneinander und zufällig gemischt in Klartext gespeichert.</p>
|
||||
<p>Dies ermöglicht es, nachträglich benutzer hinzuzufügen, ohne allen anderen neue Mails oder gar neue Codes zukommen lassen zu müssen.</p>
|
||||
<p>Es ist jedoch nocht empfohlen, nachträglich mails hinzuzufügen, da dies, abhängig von der Menge der gleichzeitig hinzugefügten Adressen eine grobe oder ggf. auch sehr genaue zuordnung zwischen Code und Mail der Nachzügler möglich ist. </p>
|
||||
</div>
|
||||
</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=" tsd-kind-namespace">
|
||||
<a href="modules/mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="modules/mlparser.html">MLParser</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="modules/svault.html">SVault</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="interfaces/otglobalconfig.html" class="tsd-kind-icon">OTGlobal<wbr>Config</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#action" class="tsd-kind-icon">action</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#configpath" class="tsd-kind-icon">config<wbr>Path</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#dryrun" class="tsd-kind-icon">dryrun</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#force" class="tsd-kind-icon">force</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#html" class="tsd-kind-icon">html</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#mails" class="tsd-kind-icon">mails</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#privkey" class="tsd-kind-icon">priv<wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#pubkey" class="tsd-kind-icon">pub<wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="globals.html#safefile" class="tsd-kind-icon">safe<wbr>File</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="globals.html#delay" class="tsd-kind-icon">delay</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="globals.html#mkstringcn" class="tsd-kind-icon">mkstringCN</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="globals.html#shufflearray" class="tsd-kind-icon">shuffle<wbr>Array</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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>
|
||||
</body>
|
||||
</html>
|
||||
202
docs/interfaces/mlgenerator.mlgenreturn.html
Normal file
202
docs/interfaces/mlgenerator.mlgenreturn.html
Normal file
@@ -0,0 +1,202 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>MLGenReturn | opentoken</title>
|
||||
<meta name="description" content="Documentation for opentoken">
|
||||
<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.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">opentoken</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="../modules/mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="mlgenerator.mlgenreturn.html">MLGenReturn</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Interface MLGenReturn</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Interface used to Return codes and mails form the main Function <a href="../modules/mlgenerator.html#generatetoken">generateToken</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">MLGenReturn</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>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="mlgenerator.mlgenreturn.html#codes" class="tsd-kind-icon">codes</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="mlgenerator.mlgenreturn.html#mails" class="tsd-kind-icon">mails</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</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-interface">
|
||||
<a name="codes" class="tsd-anchor"></a>
|
||||
<h3>codes</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">codes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/generate.ts:45</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>List of generated codes</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="mails" class="tsd-anchor"></a>
|
||||
<h3>mails</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">mails<span class="tsd-signature-symbol">:</span> <a href="mlparser.mlitem.html" class="tsd-signature-type">MLItem</a><span class="tsd-signature-symbol">[]</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/generate.ts:47</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>List of processed mails</p>
|
||||
</div>
|
||||
</div>
|
||||
</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-namespace">
|
||||
<a href="../modules/mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mlparser.html">MLParser</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/svault.html">SVault</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-interface tsd-parent-kind-namespace">
|
||||
<a href="mlgenerator.mlgenreturn.html" class="tsd-kind-icon">MLGen<wbr>Return</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="mlgenerator.mlgenreturn.html#codes" class="tsd-kind-icon">codes</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="mlgenerator.mlgenreturn.html#mails" class="tsd-kind-icon">mails</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<a href="../modules/mlgenerator.html#generatecodes" class="tsd-kind-icon">generate<wbr>Codes</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||
<a href="../modules/mlgenerator.html#generatetoken" class="tsd-kind-icon">generate<wbr>Token</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<a href="../modules/mlgenerator.html#send" class="tsd-kind-icon">send</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<a href="../modules/mlgenerator.html#sendmails" class="tsd-kind-icon">send<wbr>Mails</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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>
|
||||
</body>
|
||||
</html>
|
||||
193
docs/interfaces/mlparser.mlitem.html
Normal file
193
docs/interfaces/mlparser.mlitem.html
Normal file
@@ -0,0 +1,193 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>MLItem | opentoken</title>
|
||||
<meta name="description" content="Documentation for opentoken">
|
||||
<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.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">opentoken</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="../modules/mlparser.html">MLParser</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="mlparser.mlitem.html">MLItem</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Interface MLItem</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Interface containing properties of a single mail line</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">MLItem</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>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="mlparser.mlitem.html#mail" class="tsd-kind-icon">mail</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="mlparser.mlitem.html#name" class="tsd-kind-icon">name</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</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-interface">
|
||||
<a name="mail" class="tsd-anchor"></a>
|
||||
<h3>mail</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">mail<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/mailParser.ts:37</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>mail adress parsed form file</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="name" class="tsd-anchor"></a>
|
||||
<h3>name</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/mailParser.ts:39</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>name parsed form file</p>
|
||||
</div>
|
||||
</div>
|
||||
</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=" tsd-kind-namespace">
|
||||
<a href="../modules/mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class="current tsd-kind-namespace">
|
||||
<a href="../modules/mlparser.html">MLParser</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/svault.html">SVault</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-interface tsd-parent-kind-namespace">
|
||||
<a href="mlparser.mlitem.html" class="tsd-kind-icon">MLItem</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="mlparser.mlitem.html#mail" class="tsd-kind-icon">mail</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="mlparser.mlitem.html#name" class="tsd-kind-icon">name</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||
<a href="../modules/mlparser.html#parsemails" class="tsd-kind-icon">parse<wbr>Mails</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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>
|
||||
</body>
|
||||
</html>
|
||||
347
docs/interfaces/otglobalconfig.html
Normal file
347
docs/interfaces/otglobalconfig.html
Normal file
@@ -0,0 +1,347 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>OTGlobalConfig | opentoken</title>
|
||||
<meta name="description" content="Documentation for opentoken">
|
||||
<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.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">opentoken</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="otglobalconfig.html">OTGlobalConfig</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Interface OTGlobalConfig</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Interface containing all config properties for opentoken</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">OTGlobalConfig</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>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="otglobalconfig.html#dryrun" class="tsd-kind-icon">dryrun</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="otglobalconfig.html#force" class="tsd-kind-icon">force</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="otglobalconfig.html#htmlpath" class="tsd-kind-icon">html<wbr>Path</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="otglobalconfig.html#infilemail" class="tsd-kind-icon">in<wbr>File<wbr>Mail</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="otglobalconfig.html#mail" class="tsd-kind-icon">mail</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="otglobalconfig.html#mailfrom" class="tsd-kind-icon">mail<wbr>From</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="otglobalconfig.html#outfilematch" class="tsd-kind-icon">out<wbr>File<wbr>Match</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="otglobalconfig.html#usedmails" class="tsd-kind-icon">used<wbr>Mails</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="otglobalconfig.html#usedtokens" class="tsd-kind-icon">used<wbr>Tokens</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</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-interface">
|
||||
<a name="dryrun" class="tsd-anchor"></a>
|
||||
<h3>dryrun</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">dryrun<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/config.type.ts:25</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>switch for dryrun</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="force" class="tsd-anchor"></a>
|
||||
<h3>force</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">force<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/config.type.ts:27</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>switch for force</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="htmlpath" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> html<wbr>Path</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">html<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/config.type.ts:16</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>path to file containing mail template</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="infilemail" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> in<wbr>File<wbr>Mail</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">in<wbr>File<wbr>Mail<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/config.type.ts:14</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>path to file containing mails</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="mail" class="tsd-anchor"></a>
|
||||
<h3>mail</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">mail<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">SMTPTransport</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/config.type.ts:8</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>nodemailer SMTP configuration</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="mailfrom" class="tsd-anchor"></a>
|
||||
<h3>mail<wbr>From</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">mail<wbr>From<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/config.type.ts:10</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>sender alias</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="outfilematch" class="tsd-anchor"></a>
|
||||
<h3>out<wbr>File<wbr>Match</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">out<wbr>File<wbr>Match<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/config.type.ts:12</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>path to file containing matches</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="usedmails" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> used<wbr>Mails</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">used<wbr>Mails<span class="tsd-signature-symbol">:</span> <a href="mlparser.mlitem.html" class="tsd-signature-type">MLItem</a><span class="tsd-signature-symbol">[]</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/config.type.ts:21</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>List of used mail adresses</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="usedtokens" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> used<wbr>Tokens</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">used<wbr>Tokens<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/config.type.ts:19</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>List of used tokens</p>
|
||||
</div>
|
||||
</div>
|
||||
</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>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-interface">
|
||||
<a href="otglobalconfig.html" class="tsd-kind-icon">OTGlobal<wbr>Config</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="otglobalconfig.html#dryrun" class="tsd-kind-icon">dryrun</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="otglobalconfig.html#force" class="tsd-kind-icon">force</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="otglobalconfig.html#htmlpath" class="tsd-kind-icon">html<wbr>Path</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="otglobalconfig.html#infilemail" class="tsd-kind-icon">in<wbr>File<wbr>Mail</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="otglobalconfig.html#mail" class="tsd-kind-icon">mail</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="otglobalconfig.html#mailfrom" class="tsd-kind-icon">mail<wbr>From</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="otglobalconfig.html#outfilematch" class="tsd-kind-icon">out<wbr>File<wbr>Match</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="otglobalconfig.html#usedmails" class="tsd-kind-icon">used<wbr>Mails</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="otglobalconfig.html#usedtokens" class="tsd-kind-icon">used<wbr>Tokens</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../globals.html#action" class="tsd-kind-icon">action</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../globals.html#configpath" class="tsd-kind-icon">config<wbr>Path</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../globals.html#dryrun" class="tsd-kind-icon">dryrun</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../globals.html#force" class="tsd-kind-icon">force</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../globals.html#html" class="tsd-kind-icon">html</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../globals.html#mails" class="tsd-kind-icon">mails</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../globals.html#privkey" class="tsd-kind-icon">priv<wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../globals.html#pubkey" class="tsd-kind-icon">pub<wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../globals.html#safefile" class="tsd-kind-icon">safe<wbr>File</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="../globals.html#delay" class="tsd-kind-icon">delay</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="../globals.html#mkstringcn" class="tsd-kind-icon">mkstringCN</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="../globals.html#shufflearray" class="tsd-kind-icon">shuffle<wbr>Array</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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>
|
||||
</body>
|
||||
</html>
|
||||
240
docs/interfaces/svault.securevaultitem.html
Normal file
240
docs/interfaces/svault.securevaultitem.html
Normal file
@@ -0,0 +1,240 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>SecureVaultItem | opentoken</title>
|
||||
<meta name="description" content="Documentation for opentoken">
|
||||
<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.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">opentoken</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="../modules/svault.html">SVault</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="svault.securevaultitem.html">SecureVaultItem</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Interface SecureVaultItem</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Interface for an vault item containing encrypted data</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">SecureVaultItem</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>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="svault.securevaultitem.html#d" class="tsd-kind-icon">d</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="svault.securevaultitem.html#iv" class="tsd-kind-icon">iv</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="svault.securevaultitem.html#k" class="tsd-kind-icon">k</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="svault.securevaultitem.html#u" class="tsd-kind-icon">u</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</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-interface">
|
||||
<a name="d" class="tsd-anchor"></a>
|
||||
<h3>d</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">d<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:43</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>data</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="iv" class="tsd-anchor"></a>
|
||||
<h3>iv</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">iv<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:47</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>init vector</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="k" class="tsd-anchor"></a>
|
||||
<h3>k</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">k<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:45</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>key</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="u" class="tsd-anchor"></a>
|
||||
<h3>u</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">u<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:41</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>uuid</p>
|
||||
</div>
|
||||
</div>
|
||||
</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=" tsd-kind-namespace">
|
||||
<a href="../modules/mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mlparser.html">MLParser</a>
|
||||
</li>
|
||||
<li class="current tsd-kind-namespace">
|
||||
<a href="../modules/svault.html">SVault</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-class tsd-parent-kind-namespace">
|
||||
<a href="../classes/svault.securevault.html" class="tsd-kind-icon">Secure<wbr>Vault</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-interface tsd-parent-kind-namespace">
|
||||
<a href="svault.securevaultitem.html" class="tsd-kind-icon">Secure<wbr>Vault<wbr>Item</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="svault.securevaultitem.html#d" class="tsd-kind-icon">d</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="svault.securevaultitem.html#iv" class="tsd-kind-icon">iv</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="svault.securevaultitem.html#k" class="tsd-kind-icon">k</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="svault.securevaultitem.html#u" class="tsd-kind-icon">u</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
|
||||
<a href="svault.storageitem.html" class="tsd-kind-icon">Storage<wbr>Item</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
|
||||
<a href="svault.securevaultlist.html" class="tsd-kind-icon">secure<wbr>Vault<wbr>List</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<a href="../modules/svault.html#vaultversion" class="tsd-kind-icon">vault<wbr>Version</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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>
|
||||
</body>
|
||||
</html>
|
||||
206
docs/interfaces/svault.securevaultlist.html
Normal file
206
docs/interfaces/svault.securevaultlist.html
Normal file
@@ -0,0 +1,206 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>secureVaultList | opentoken</title>
|
||||
<meta name="description" content="Documentation for opentoken">
|
||||
<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.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">opentoken</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="../modules/svault.html">SVault</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="svault.securevaultlist.html">secureVaultList</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Interface secureVaultList</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Interface for secureVault Array</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">secureVaultList</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>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="svault.securevaultlist.html#items" class="tsd-kind-icon">items</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="svault.securevaultlist.html#privatekey" class="tsd-kind-icon">private<wbr>Key</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="svault.securevaultlist.html#publickey" class="tsd-kind-icon">public<wbr>Key</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</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-interface">
|
||||
<a name="items" class="tsd-anchor"></a>
|
||||
<h3>items</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">items<span class="tsd-signature-symbol">:</span> <a href="svault.securevaultitem.html" class="tsd-signature-type">SecureVaultItem</a><span class="tsd-signature-symbol">[]</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:62</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="privatekey" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> private<wbr>Key</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">private<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Buffer</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:64</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="publickey" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> public<wbr>Key</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">public<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Buffer</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:63</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</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=" tsd-kind-namespace">
|
||||
<a href="../modules/mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mlparser.html">MLParser</a>
|
||||
</li>
|
||||
<li class="current tsd-kind-namespace">
|
||||
<a href="../modules/svault.html">SVault</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-class tsd-parent-kind-namespace">
|
||||
<a href="../classes/svault.securevault.html" class="tsd-kind-icon">Secure<wbr>Vault</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
|
||||
<a href="svault.securevaultitem.html" class="tsd-kind-icon">Secure<wbr>Vault<wbr>Item</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
|
||||
<a href="svault.storageitem.html" class="tsd-kind-icon">Storage<wbr>Item</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-interface tsd-parent-kind-namespace">
|
||||
<a href="svault.securevaultlist.html" class="tsd-kind-icon">secure<wbr>Vault<wbr>List</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="svault.securevaultlist.html#items" class="tsd-kind-icon">items</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="svault.securevaultlist.html#privatekey" class="tsd-kind-icon">private<wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="svault.securevaultlist.html#publickey" class="tsd-kind-icon">public<wbr>Key</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<a href="../modules/svault.html#vaultversion" class="tsd-kind-icon">vault<wbr>Version</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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>
|
||||
</body>
|
||||
</html>
|
||||
221
docs/interfaces/svault.storageitem.html
Normal file
221
docs/interfaces/svault.storageitem.html
Normal file
@@ -0,0 +1,221 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>StorageItem | opentoken</title>
|
||||
<meta name="description" content="Documentation for opentoken">
|
||||
<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.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">opentoken</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="../modules/svault.html">SVault</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="svault.storageitem.html">StorageItem</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Interface StorageItem</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Interface for an vault item containing unencrypted data</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">StorageItem</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>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="svault.storageitem.html#d" class="tsd-kind-icon">d</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="svault.storageitem.html#t" class="tsd-kind-icon">t</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="svault.storageitem.html#u" class="tsd-kind-icon">u</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</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-interface">
|
||||
<a name="d" class="tsd-anchor"></a>
|
||||
<h3>d</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">d<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:55</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>data</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="t" class="tsd-anchor"></a>
|
||||
<h3>t</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">t<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:57</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>tag (can be used to find specific items)</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="u" class="tsd-anchor"></a>
|
||||
<h3>u</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">u<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:53</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>uuid</p>
|
||||
</div>
|
||||
</div>
|
||||
</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=" tsd-kind-namespace">
|
||||
<a href="../modules/mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="../modules/mlparser.html">MLParser</a>
|
||||
</li>
|
||||
<li class="current tsd-kind-namespace">
|
||||
<a href="../modules/svault.html">SVault</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-class tsd-parent-kind-namespace">
|
||||
<a href="../classes/svault.securevault.html" class="tsd-kind-icon">Secure<wbr>Vault</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
|
||||
<a href="svault.securevaultitem.html" class="tsd-kind-icon">Secure<wbr>Vault<wbr>Item</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-interface tsd-parent-kind-namespace">
|
||||
<a href="svault.storageitem.html" class="tsd-kind-icon">Storage<wbr>Item</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="svault.storageitem.html#d" class="tsd-kind-icon">d</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="svault.storageitem.html#t" class="tsd-kind-icon">t</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="svault.storageitem.html#u" class="tsd-kind-icon">u</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
|
||||
<a href="svault.securevaultlist.html" class="tsd-kind-icon">secure<wbr>Vault<wbr>List</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<a href="../modules/svault.html#vaultversion" class="tsd-kind-icon">vault<wbr>Version</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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>
|
||||
</body>
|
||||
</html>
|
||||
484
docs/modules/mlgenerator.html
Normal file
484
docs/modules/mlgenerator.html
Normal file
@@ -0,0 +1,484 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>MLGenerator | opentoken</title>
|
||||
<meta name="description" content="Documentation for opentoken">
|
||||
<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.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">opentoken</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="mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Namespace MLGenerator</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Namespace containing the code for Generating the Code and delivering the mails</p>
|
||||
</div>
|
||||
</div>
|
||||
</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>Interfaces</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/mlgenerator.mlgenreturn.html" class="tsd-kind-icon">MLGen<wbr>Return</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-namespace tsd-is-not-exported"><a href="mlgenerator.html#generatecodes" class="tsd-kind-icon">generate<wbr>Codes</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="mlgenerator.html#generatetoken" class="tsd-kind-icon">generate<wbr>Token</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported"><a href="mlgenerator.html#send" class="tsd-kind-icon">send</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported"><a href="mlgenerator.html#sendmails" class="tsd-kind-icon">send<wbr>Mails</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</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-namespace tsd-is-not-exported">
|
||||
<a name="generatecodes" class="tsd-anchor"></a>
|
||||
<h3>generate<wbr>Codes</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">generate<wbr>Codes<span class="tsd-signature-symbol">(</span>resolve<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">?: </span><a href="../interfaces/mlgenerator.mlgenreturn.html" class="tsd-signature-type">MLGenReturn</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span>, error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>reason<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span>, mailArray<span class="tsd-signature-symbol">: </span><a href="../interfaces/mlparser.mlitem.html" class="tsd-signature-type">MLItem</a><span class="tsd-signature-symbol">[]</span>, config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, dataSafe<span class="tsd-signature-symbol">: </span><a href="../classes/svault.securevault.html" class="tsd-signature-type">SecureVault</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</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 src/generate.ts:79</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Generate the same amout of codes as distinct mail adresses and stores them to the list file
|
||||
This function also includes previously used tokens to prevent duplicate tokens.
|
||||
Rejects if matchfile cannot be saved.</p>
|
||||
</div>
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>internal</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>resolve: <span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">?: </span><a href="../interfaces/mlgenerator.mlgenreturn.html" class="tsd-signature-type">MLGenReturn</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Callback to resolve promise</p>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">?: </span><a href="../interfaces/mlgenerator.mlgenreturn.html" class="tsd-signature-type">MLGenReturn</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> value: <a href="../interfaces/mlgenerator.mlgenreturn.html" class="tsd-signature-type">MLGenReturn</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<h5>error: <span class="tsd-signature-symbol">(</span>reason<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Callback to reject promise</p>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>reason<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> reason: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<h5>mailArray: <a href="../interfaces/mlparser.mlitem.html" class="tsd-signature-type">MLItem</a><span class="tsd-signature-symbol">[]</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>list of mail adresses</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>config: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Main configuration object
|
||||
This Function uses the following variables:
|
||||
usedTokens -> List of previosly used tokens
|
||||
outFileMatch -> Path to match file</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>dataSafe: <a href="../classes/svault.securevault.html" class="tsd-signature-type">SecureVault</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Main safe used for logging and storing data</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||
<a name="generatetoken" class="tsd-anchor"></a>
|
||||
<h3>generate<wbr>Token</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||
<li class="tsd-signature tsd-kind-icon">generate<wbr>Token<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, dataSafe<span class="tsd-signature-symbol">: </span><a href="../classes/svault.securevault.html" class="tsd-signature-type">SecureVault</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/mlgenerator.mlgenreturn.html" class="tsd-signature-type">MLGenReturn</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/generate.ts:56</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Main function used to generate and deliver codes</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>config: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Main configuration object</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>dataSafe: <a href="../classes/svault.securevault.html" class="tsd-signature-type">SecureVault</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Main safe used for logging and storing data</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/mlgenerator.mlgenreturn.html" class="tsd-signature-type">MLGenReturn</a><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>used codes and processed mails</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<a name="send" class="tsd-anchor"></a>
|
||||
<h3>send</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">send<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, mail<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, template<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HandlebarsTemplateDelegate</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span>, mailserver<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Mail</span>, config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, dataSafe<span class="tsd-signature-symbol">: </span><a href="../classes/svault.securevault.html" class="tsd-signature-type">SecureVault</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</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 src/generate.ts:206</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Reads template file and compiles template.
|
||||
Iterate through mails and codes, randomly assign code to mail and send mail to recipient.
|
||||
If dryrun is enabled, mails will not be sent and new mails won't be included in return.
|
||||
Rejects if template cannot be read.</p>
|
||||
</div>
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>internal</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Name of recpipient</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>mail: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Mail of recpipient</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>code: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Code of recpipient</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>template: <span class="tsd-signature-type">HandlebarsTemplateDelegate</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>compiled mail template</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>mailserver: <span class="tsd-signature-type">Mail</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Mailserver settings</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>config: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Main configuration object
|
||||
This Function uses the following variables:
|
||||
mail.auth.user -> sender mail adress
|
||||
mailFrom -> sender mail ailas
|
||||
dryrun -> Boolean value. If true no mails will be sent.</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>dataSafe: <a href="../classes/svault.securevault.html" class="tsd-signature-type">SecureVault</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Main safe used for logging and storing data</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<a name="sendmails" class="tsd-anchor"></a>
|
||||
<h3>send<wbr>Mails</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">send<wbr>Mails<span class="tsd-signature-symbol">(</span>resolve<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">?: </span><a href="../interfaces/mlgenerator.mlgenreturn.html" class="tsd-signature-type">MLGenReturn</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span>, error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>reason<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span>, mailArray<span class="tsd-signature-symbol">: </span><a href="../interfaces/mlparser.mlitem.html" class="tsd-signature-type">MLItem</a><span class="tsd-signature-symbol">[]</span>, codeArray<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, dataSafe<span class="tsd-signature-symbol">: </span><a href="../classes/svault.securevault.html" class="tsd-signature-type">SecureVault</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</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 src/generate.ts:138</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Reads template file and compiles template.
|
||||
Iterate through mails and codes, randomly assign code to mail and send mail to recipient.
|
||||
If dryrun is enabled, mails will not be sent and new mails won't be included in return.
|
||||
Rejects if template cannot be read.</p>
|
||||
</div>
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>internal</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>resolve: <span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">?: </span><a href="../interfaces/mlgenerator.mlgenreturn.html" class="tsd-signature-type">MLGenReturn</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Callback to resolve promise</p>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">?: </span><a href="../interfaces/mlgenerator.mlgenreturn.html" class="tsd-signature-type">MLGenReturn</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> value: <a href="../interfaces/mlgenerator.mlgenreturn.html" class="tsd-signature-type">MLGenReturn</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<h5>error: <span class="tsd-signature-symbol">(</span>reason<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Callback to reject promise</p>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>reason<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> reason: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<h5>mailArray: <a href="../interfaces/mlparser.mlitem.html" class="tsd-signature-type">MLItem</a><span class="tsd-signature-symbol">[]</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>list of mail adresses</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>codeArray: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>list of generated codes</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>config: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Main configuration object
|
||||
This Function uses the following variables:
|
||||
htmlPath -> Path to html template
|
||||
dryrun -> Boolean value. If true no mails will be sent and list won't be updated.
|
||||
force -> Boolean value. If true all mails are resent.
|
||||
usedTokens -> Array of Strings. Specifies already used tokens adresses.
|
||||
usedMails -> Array of Strings. Specifies already served mail adresses.
|
||||
mail -> mailserver settings</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>dataSafe: <a href="../classes/svault.securevault.html" class="tsd-signature-type">SecureVault</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Main safe used for logging and storing data</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
</li>
|
||||
<li class="current tsd-kind-namespace">
|
||||
<a href="mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mlparser.html">MLParser</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="svault.html">SVault</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
|
||||
<a href="../interfaces/mlgenerator.mlgenreturn.html" class="tsd-kind-icon">MLGen<wbr>Return</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<a href="mlgenerator.html#generatecodes" class="tsd-kind-icon">generate<wbr>Codes</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||
<a href="mlgenerator.html#generatetoken" class="tsd-kind-icon">generate<wbr>Token</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<a href="mlgenerator.html#send" class="tsd-kind-icon">send</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<a href="mlgenerator.html#sendmails" class="tsd-kind-icon">send<wbr>Mails</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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>
|
||||
</body>
|
||||
</html>
|
||||
188
docs/modules/mlparser.html
Normal file
188
docs/modules/mlparser.html
Normal file
@@ -0,0 +1,188 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>MLParser | opentoken</title>
|
||||
<meta name="description" content="Documentation for opentoken">
|
||||
<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.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">opentoken</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="mlparser.html">MLParser</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Namespace MLParser</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Namespace containing the code for Parsing the mail list.</p>
|
||||
</div>
|
||||
</div>
|
||||
</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>Interfaces</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/mlparser.mlitem.html" class="tsd-kind-icon">MLItem</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-namespace"><a href="mlparser.html#parsemails" class="tsd-kind-icon">parse<wbr>Mails</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</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-namespace">
|
||||
<a name="parsemails" class="tsd-anchor"></a>
|
||||
<h3>parse<wbr>Mails</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||
<li class="tsd-signature tsd-kind-icon">parse<wbr>Mails<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, dataSafe<span class="tsd-signature-symbol">: </span><a href="../classes/svault.securevault.html" class="tsd-signature-type">SecureVault</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/mlparser.mlitem.html" class="tsd-signature-type">MLItem</a><span class="tsd-signature-symbol">[]</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 src/mailParser.ts:54</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Encrypts and appends data to SecureVault.
|
||||
Also writes data to transaction log using @function writeTransaction</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>config: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Reference to config object.
|
||||
This Function uses the following variables:
|
||||
inFileMail -> String reference to mail list
|
||||
force -> Boolean value. If true all mails are resent.
|
||||
usedMails -> Array of Strings. Specifies already served mail adresses.</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>dataSafe: <a href="../classes/svault.securevault.html" class="tsd-signature-type">SecureVault</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Reference to safe object. This is needed for writing to the vault.log file</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/mlparser.mlitem.html" class="tsd-signature-type">MLItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>Returns an array of all parsed mail adresses as promise</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=" tsd-kind-namespace">
|
||||
<a href="mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class="current tsd-kind-namespace">
|
||||
<a href="mlparser.html">MLParser</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="svault.html">SVault</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
|
||||
<a href="../interfaces/mlparser.mlitem.html" class="tsd-kind-icon">MLItem</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||
<a href="mlparser.html#parsemails" class="tsd-kind-icon">parse<wbr>Mails</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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>
|
||||
</body>
|
||||
</html>
|
||||
177
docs/modules/svault.html
Normal file
177
docs/modules/svault.html
Normal file
@@ -0,0 +1,177 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>SVault | opentoken</title>
|
||||
<meta name="description" content="Documentation for opentoken">
|
||||
<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.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">opentoken</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="svault.html">SVault</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Namespace SVault</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Namespace containing the code for the SecureVault.</p>
|
||||
</div>
|
||||
</div>
|
||||
</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>Classes</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/svault.securevault.html" class="tsd-kind-icon">Secure<wbr>Vault</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Interfaces</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/svault.securevaultitem.html" class="tsd-kind-icon">Secure<wbr>Vault<wbr>Item</a></li>
|
||||
<li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/svault.storageitem.html" class="tsd-kind-icon">Storage<wbr>Item</a></li>
|
||||
<li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/svault.securevaultlist.html" class="tsd-kind-icon">secure<wbr>Vault<wbr>List</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-namespace tsd-is-not-exported"><a href="svault.html#vaultversion" class="tsd-kind-icon">vault<wbr>Version</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</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-namespace tsd-is-not-exported">
|
||||
<a name="vaultversion" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> vault<wbr>Version</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">vault<wbr>Version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"v1.2"</span><span class="tsd-signature-symbol"> = "v1.2"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/vault.ts:36</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>vault version number. This variable will be added to the safe file and is used to chack compatibility.</p>
|
||||
</div>
|
||||
</div>
|
||||
</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=" tsd-kind-namespace">
|
||||
<a href="mlgenerator.html">MLGenerator</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="mlparser.html">MLParser</a>
|
||||
</li>
|
||||
<li class="current tsd-kind-namespace">
|
||||
<a href="svault.html">SVault</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-class tsd-parent-kind-namespace">
|
||||
<a href="../classes/svault.securevault.html" class="tsd-kind-icon">Secure<wbr>Vault</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
|
||||
<a href="../interfaces/svault.securevaultitem.html" class="tsd-kind-icon">Secure<wbr>Vault<wbr>Item</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
|
||||
<a href="../interfaces/svault.storageitem.html" class="tsd-kind-icon">Storage<wbr>Item</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
|
||||
<a href="../interfaces/svault.securevaultlist.html" class="tsd-kind-icon">secure<wbr>Vault<wbr>List</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-namespace tsd-is-not-exported">
|
||||
<a href="svault.html#vaultversion" class="tsd-kind-icon">vault<wbr>Version</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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user