grassrootseconomics/cic-staff-client
5
0
Fork 0
Code Issues 26 Pull Requests Projects Releases Wiki Activity
5295e47cc1
cic-staff-client/docs/compodoc/classes/PGPSigner.html

1064 lines
37 KiB
HTML
Raw Normal View History

Add docs.
2021-05-10 20:56:20 +02:00
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>CICADA</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/style.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top visible-xs">
<a href="../" class="navbar-brand">CICADA</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="hidden-xs menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content class">
<div class="content-data">
<ol class="breadcrumb">
<li>Classes</li>
<li>PGPSigner</li>
</ol>
<ul class="nav nav-tabs" role="tablist">
<li class="active">
<a href="#info" role="tab" id="info-tab" data-toggle="tab" data-link="info">Info</a>
</li>
<li >
<a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a>
</li>
</ul>
<div class="tab-content">
<div class="tab-pane fade active in" id="c-info">
<p class="comment">
<h3>File</h3>
</p>
<p class="comment">
<code>src/app/_pgp/pgp-signer.ts</code>
</p>
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<p class="comment">
<h3>Description</h3>
</p>
<p class="comment">
<p>Provides functionality for signing and verifying signed messages. </p>
</p>
Add docs.
2021-05-10 20:56:20 +02:00
<p class="comment">
<h3>Implements</h3>
</p>
<p class="comment">
<code><a href="../interfaces/Signer.html" target="_self" >Signer</a></code>
</p>
<section>
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<tr>
<td class="col-md-4">
<h6><b>Properties</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#algo">algo</a>
</li>
<li>
<a href="#dgst">dgst</a>
</li>
<li>
<a href="#engine">engine</a>
</li>
<li>
<a href="#keyStore">keyStore</a>
</li>
<li>
<a href="#loggingService">loggingService</a>
</li>
<li>
<a href="#onsign">onsign</a>
</li>
<li>
<a href="#onverify">onverify</a>
</li>
<li>
<a href="#signature">signature</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Methods</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier">Public</span>
<a href="#fingerprint">fingerprint</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#prepare">prepare</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier">Async</span>
<a href="#sign">sign</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#verify">verify</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h3 id="constructor">Constructor</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<code>constructor(keyStore: <a href="../interfaces/MutableKeyStore.html">MutableKeyStore</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<div class="io-line">Defined in <a href="" data-line="74" class="link-to-prism">src/app/_pgp/pgp-signer.ts:74</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<div class="io-description"><p>Initializing the Signer.</p>
</div>
Add docs.
2021-05-10 20:56:20 +02:00
<div>
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<td>Description</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</thead>
<tbody>
<tr>
<td>keyStore</td>
<td>
<code><a href="../interfaces/MutableKeyStore.html" target="_self" >MutableKeyStore</a></code>
</td>
<td>
No
</td>
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<td>
<code><ul>
<li>A keystore holding pgp keys.</li>
</ul>
</code>
</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h3 id="inputs">
Properties
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="algo"></a>
<span class="name">
<b>
algo</b>
<a href="#algo"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>&#x27;sha256&#x27;</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Refactor order of item to follow alphabetical order.
2021-05-13 09:13:51 +02:00
<div class="io-line">Defined in <a href="" data-line="60" class="link-to-prism">src/app/_pgp/pgp-signer.ts:60</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>Encryption algorithm used </p>
</div>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="dgst"></a>
<span class="name">
<b>
dgst</b>
<a href="#dgst"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
Refactor order of item to follow alphabetical order.
2021-05-13 09:13:51 +02:00
<div class="io-line">Defined in <a href="" data-line="62" class="link-to-prism">src/app/_pgp/pgp-signer.ts:62</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>Message digest </p>
</div>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="engine"></a>
<span class="name">
<b>
engine</b>
<a href="#engine"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>&#x27;pgp&#x27;</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Refactor order of item to follow alphabetical order.
2021-05-13 09:13:51 +02:00
<div class="io-line">Defined in <a href="" data-line="64" class="link-to-prism">src/app/_pgp/pgp-signer.ts:64</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>Encryption engine used. </p>
</div>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="keyStore"></a>
<span class="name">
<b>
keyStore</b>
<a href="#keyStore"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="../interfaces/MutableKeyStore.html" target="_self" >MutableKeyStore</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
Refactor order of item to follow alphabetical order.
2021-05-13 09:13:51 +02:00
<div class="io-line">Defined in <a href="" data-line="66" class="link-to-prism">src/app/_pgp/pgp-signer.ts:66</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>A keystore holding pgp keys. </p>
</div>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="loggingService"></a>
<span class="name">
<b>
loggingService</b>
<a href="#loggingService"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="../injectables/LoggingService.html" target="_self" >LoggingService</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
Refactor order of item to follow alphabetical order.
2021-05-13 09:13:51 +02:00
<div class="io-line">Defined in <a href="" data-line="68" class="link-to-prism">src/app/_pgp/pgp-signer.ts:68</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>A service that provides logging capabilities. </p>
</div>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="onsign"></a>
<span class="name">
<b>
onsign</b>
<a href="#onsign"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function" target="_blank" >function</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<div class="io-line">Defined in <a href="" data-line="70" class="link-to-prism">src/app/_pgp/pgp-signer.ts:70</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>Event triggered on successful signing of message. </p>
</div>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="onverify"></a>
<span class="name">
<b>
onverify</b>
<a href="#onverify"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function" target="_blank" >function</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<div class="io-line">Defined in <a href="" data-line="72" class="link-to-prism">src/app/_pgp/pgp-signer.ts:72</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>Event triggered on successful verification of a signature. </p>
</div>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="signature"></a>
<span class="name">
<b>
signature</b>
<a href="#signature"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="../interfaces/Signature.html" target="_self" >Signature</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
Refactor order of item to follow alphabetical order.
2021-05-13 09:13:51 +02:00
<div class="io-line">Defined in <a href="" data-line="74" class="link-to-prism">src/app/_pgp/pgp-signer.ts:74</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>Generated signature </p>
</div>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
</tbody>
</table>
</section>
<section>
<h3 id="methods">
Methods
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="fingerprint"></a>
<span class="name">
<b>
<span class="modifier">Public</span>
fingerprint
</b>
<a href="#fingerprint"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>fingerprint()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<div class="io-line">Defined in <a href="" data-line="90"
class="link-to-prism">src/app/_pgp/pgp-signer.ts:90</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<div class="io-description"><p>Get the private key fingerprint.</p>
</div>
Add docs.
2021-05-10 20:56:20 +02:00
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<div>
</div>
Add docs.
2021-05-10 20:56:20 +02:00
<div class="io-description">
<b>Returns : </b> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</div>
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<div class="io-description">
<p>A private key fingerprint.</p>
</div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="prepare"></a>
<span class="name">
<b>
<span class="modifier">Public</span>
prepare
</b>
<a href="#prepare"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>prepare(material: <a href="../interfaces/Signable.html">Signable</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<div class="io-line">Defined in <a href="" data-line="99"
class="link-to-prism">src/app/_pgp/pgp-signer.ts:99</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<div class="io-description"><p>Load the message digest.</p>
</div>
Add docs.
2021-05-10 20:56:20 +02:00
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<td>Description</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</thead>
<tbody>
<tr>
<td>material</td>
<td>
<code><a href="../interfaces/Signable.html" target="_self" >Signable</a></code>
</td>
<td>
No
</td>
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<td>
<ul>
<li>A signable object.</li>
</ul>
</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</tbody>
</table>
</div>
<div>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</div>
<div class="io-description">
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<p>true - If digest has been loaded successfully.</p>
Add docs.
2021-05-10 20:56:20 +02:00
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="sign"></a>
<span class="name">
<b>
<span class="modifier">Public</span>
<span class="modifier">Async</span>
sign
</b>
<a href="#sign"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>sign(digest: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Refactor order of item to follow alphabetical order.
2021-05-13 09:13:51 +02:00
<div class="io-line">Defined in <a href="" data-line="109"
class="link-to-prism">src/app/_pgp/pgp-signer.ts:109</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<div class="io-description"><p>Signs a message using a private key.</p>
</div>
Add docs.
2021-05-10 20:56:20 +02:00
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<td>Description</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</thead>
<tbody>
<tr>
<td>digest</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<td>
<ul>
<li>The message to be signed.</li>
</ul>
</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</tbody>
</table>
</div>
<div>
</div>
<div class="io-description">
<b>Returns : </b> <code>Promise&lt;void&gt;</code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="verify"></a>
<span class="name">
<b>
<span class="modifier">Public</span>
verify
</b>
<a href="#verify"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>verify(digest: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, signature: <a href="../interfaces/Signature.html">Signature</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Refactor order of item to follow alphabetical order.
2021-05-13 09:13:51 +02:00
<div class="io-line">Defined in <a href="" data-line="144"
class="link-to-prism">src/app/_pgp/pgp-signer.ts:144</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<div class="io-description"><p>Verify that signature is valid.</p>
</div>
Add docs.
2021-05-10 20:56:20 +02:00
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<td>Description</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</thead>
<tbody>
<tr>
<td>digest</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<td>
<ul>
<li>The message that was signed.</li>
</ul>
</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
<tr>
<td>signature</td>
<td>
<code><a href="../interfaces/Signature.html" target="_self" >Signature</a></code>
</td>
<td>
No
</td>
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<td>
<ul>
<li>The generated signature.</li>
</ul>
</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</tbody>
</table>
</div>
<div>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
</section>
</div>
<div class="tab-pane fade tab-source-code" id="c-source">
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import * as openpgp from &#x27;openpgp&#x27;;
Add docs.
2021-05-10 20:56:20 +02:00
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
// Application imports
import { MutableKeyStore } from &#x27;@app/_pgp/pgp-key-store&#x27;;
import { LoggingService } from &#x27;@app/_services/logging.service&#x27;;
Add docs.
2021-05-10 20:56:20 +02:00
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
/** Signable object interface */
Add docs.
2021-05-10 20:56:20 +02:00
interface Signable {
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
/** The message to be signed. */
Add docs.
2021-05-10 20:56:20 +02:00
digest(): string;
}
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
/** Signature object interface */
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
interface Signature {
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
/** Encryption algorithm used */
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
algo: string;
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
/** Data to be signed. */
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
data: string;
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
/** Message digest */
Add docs.
2021-05-10 20:56:20 +02:00
digest: string;
Refactor order of item to follow alphabetical order.
2021-05-13 09:13:51 +02:00
/** Encryption engine used. */
engine: string;
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
}
Add docs.
2021-05-10 20:56:20 +02:00
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
/** Signer interface */
Add docs.
2021-05-10 20:56:20 +02:00
interface Signer {
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
/**
* Get the private key fingerprint.
* @returns A private key fingerprint.
*/
Add docs.
2021-05-10 20:56:20 +02:00
fingerprint(): string;
Refactor order of item to follow alphabetical order.
2021-05-13 09:13:51 +02:00
/** Event triggered on successful signing of message. */
onsign(signature: Signature): void;
/** Event triggered on successful verification of a signature. */
onverify(flag: boolean): void;
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
/**
* Load the message digest.
* @param material - A signable object.
* @returns true - If digest has been loaded successfully.
*/
Add docs.
2021-05-10 20:56:20 +02:00
prepare(material: Signable): boolean;
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
/**
* Signs a message using a private key.
* @async
* @param digest - The message to be signed.
*/
Add docs.
2021-05-10 20:56:20 +02:00
sign(digest: string): Promise&lt;void&gt;;
Refactor order of item to follow alphabetical order.
2021-05-13 09:13:51 +02:00
/**
* Verify that signature is valid.
* @param digest - The message that was signed.
* @param signature - The generated signature.
*/
verify(digest: string, signature: Signature): void;
Add docs.
2021-05-10 20:56:20 +02:00
}
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
/** Provides functionality for signing and verifying signed messages. */
Add docs.
2021-05-10 20:56:20 +02:00
class PGPSigner implements Signer {
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
/** Encryption algorithm used */
Add docs.
2021-05-10 20:56:20 +02:00
algo &#x3D; &#x27;sha256&#x27;;
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
/** Message digest */
Add docs.
2021-05-10 20:56:20 +02:00
dgst: string;
Refactor order of item to follow alphabetical order.
2021-05-13 09:13:51 +02:00
/** Encryption engine used. */
engine &#x3D; &#x27;pgp&#x27;;
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
/** A keystore holding pgp keys. */
Add docs.
2021-05-10 20:56:20 +02:00
keyStore: MutableKeyStore;
Refactor order of item to follow alphabetical order.
2021-05-13 09:13:51 +02:00
/** A service that provides logging capabilities. */
loggingService: LoggingService;
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
/** Event triggered on successful signing of message. */
Add docs.
2021-05-10 20:56:20 +02:00
onsign: (signature: Signature) &#x3D;&gt; void;
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
/** Event triggered on successful verification of a signature. */
Add docs.
2021-05-10 20:56:20 +02:00
onverify: (flag: boolean) &#x3D;&gt; void;
Refactor order of item to follow alphabetical order.
2021-05-13 09:13:51 +02:00
/** Generated signature */
signature: Signature;
Add docs.
2021-05-10 20:56:20 +02:00
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
/**
* Initializing the Signer.
* @param keyStore - A keystore holding pgp keys.
*/
Add docs.
2021-05-10 20:56:20 +02:00
constructor(keyStore: MutableKeyStore) {
this.keyStore &#x3D; keyStore;
this.onsign &#x3D; (signature: Signature) &#x3D;&gt; {};
this.onverify &#x3D; (flag: boolean) &#x3D;&gt; {};
}
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
/**
* Get the private key fingerprint.
* @returns A private key fingerprint.
*/
Add docs.
2021-05-10 20:56:20 +02:00
public fingerprint(): string {
return this.keyStore.getFingerprint();
}
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
/**
* Load the message digest.
* @param material - A signable object.
* @returns true - If digest has been loaded successfully.
*/
Add docs.
2021-05-10 20:56:20 +02:00
public prepare(material: Signable): boolean {
this.dgst &#x3D; material.digest();
return true;
}
Refactor order of item to follow alphabetical order.
2021-05-13 09:13:51 +02:00
/**
* Signs a message using a private key.
* @async
* @param digest - The message to be signed.
*/
public async sign(digest: string): Promise&lt;void&gt; {
const m &#x3D; openpgp.cleartext.fromText(digest);
const pk &#x3D; this.keyStore.getPrivateKey();
if (!pk.isDecrypted()) {
const password &#x3D; window.prompt(&#x27;password&#x27;);
await pk.decrypt(password);
}
const opts &#x3D; {
message: m,
privateKeys: [pk],
detached: true,
};
openpgp
.sign(opts)
.then((s) &#x3D;&gt; {
this.signature &#x3D; {
engine: this.engine,
algo: this.algo,
data: s.signature,
// TODO: fix for browser later
digest,
};
this.onsign(this.signature);
})
.catch((e) &#x3D;&gt; {
this.loggingService.sendErrorLevelMessage(e.message, this, { error: e });
this.onsign(undefined);
});
}
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
/**
* Verify that signature is valid.
* @param digest - The message that was signed.
* @param signature - The generated signature.
*/
Add docs.
2021-05-10 20:56:20 +02:00
public verify(digest: string, signature: Signature): void {
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
openpgp.signature
.readArmored(signature.data)
.then((sig) &#x3D;&gt; {
const opts &#x3D; {
message: openpgp.cleartext.fromText(digest),
publicKeys: this.keyStore.getTrustedKeys(),
signature: sig,
};
openpgp.verify(opts).then((v) &#x3D;&gt; {
let i &#x3D; 0;
for (i &#x3D; 0; i &lt; v.signatures.length; i++) {
const s &#x3D; v.signatures[i];
if (s.valid) {
this.onverify(s);
return;
}
Add docs.
2021-05-10 20:56:20 +02:00
}
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
this.loggingService.sendErrorLevelMessage(
&#x60;Checked ${i} signature(s) but none valid&#x60;,
this,
{ error: &#x27;404 Not found!&#x27; }
);
this.onverify(false);
});
})
.catch((e) &#x3D;&gt; {
this.loggingService.sendErrorLevelMessage(e.message, this, { error: e });
Add docs.
2021-05-10 20:56:20 +02:00
this.onverify(false);
});
}
}
Add documentation to pgp module.
2021-05-12 12:21:18 +02:00
/** @exports */
Refactor order of item to follow alphabetical order.
2021-05-13 09:13:51 +02:00
export { PGPSigner, Signable, Signature, Signer };
Add docs.
2021-05-10 20:56:20 +02:00
</code></pre>
</div>
</div>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> result-matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'class';
var COMPODOC_CURRENT_PAGE_URL = 'PGPSigner.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
<!-- Required to polyfill modern browsers as code is ES5 for IE... -->
<script src="../js/libs/custom-elements-es5-adapter.js" charset="utf-8" defer></script>
<script src="../js/menu-wc.js" defer></script>
<script src="../js/libs/bootstrap-native.js"></script>
<script src="../js/libs/es6-shim.min.js"></script>
<script src="../js/libs/EventDispatcher.js"></script>
<script src="../js/libs/promise.min.js"></script>
<script src="../js/libs/zepto.min.js"></script>
<script src="../js/compodoc.js"></script>
<script src="../js/tabs.js"></script>
<script src="../js/menu.js"></script>
<script src="../js/libs/clipboard.min.js"></script>
<script src="../js/libs/prism.js"></script>
<script src="../js/sourceCode.js"></script>
<script src="../js/search/search.js"></script>
<script src="../js/search/lunr.min.js"></script>
<script src="../js/search/search-lunr.js"></script>
<script src="../js/search/search_index.js"></script>
<script src="../js/lazy-load-graphs.js"></script>
</body>
</html>
Reference in New Issue Copy Permalink