grassrootseconomics/cic-staff-client
5
0
Fork 0
Code Issues 26 Pull Requests Projects Releases Wiki Activity
e0a44046da
cic-staff-client/docs/compodoc/injectables/AuthService.html

1439 lines
49 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 injectable">
<div class="content-data">
<ol class="breadcrumb">
<li>Injectables</li>
<li>AuthService</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/_services/auth.service.ts</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="#mutableKeyStore">mutableKeyStore</a>
</li>
<li>
Update docs.
2021-06-14 13:28:53 +02:00
<a href="#trustedUsers">trustedUsers</a>
Add docs.
2021-05-10 20:56:20 +02:00
</li>
<li>
Update docs.
2021-06-14 13:28:53 +02:00
<span class="modifier">Private</span>
<a href="#trustedUsersList">trustedUsersList</a>
</li>
<li>
<a href="#trustedUsersSubject">trustedUsersSubject</a>
Add docs.
2021-05-10 20:56:20 +02:00
</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">
Update docs.
2021-06-14 13:28:53 +02:00
<li>
<a href="#addTrustedUser">addTrustedUser</a>
</li>
Add docs.
2021-05-10 20:56:20 +02:00
<li>
<a href="#getChallenge">getChallenge</a>
</li>
<li>
<a href="#getPrivateKey">getPrivateKey</a>
</li>
Update docs.
2021-06-14 13:28:53 +02:00
<li>
<a href="#getPrivateKeyInfo">getPrivateKeyInfo</a>
</li>
Add docs.
2021-05-10 20:56:20 +02:00
<li>
<span class="modifier">Async</span>
<a href="#getPublicKeys">getPublicKeys</a>
</li>
Update docs.
2021-06-14 13:28:53 +02:00
<li>
<a href="#getSessionToken">getSessionToken</a>
</li>
Add docs.
2021-05-10 20:56:20 +02:00
<li>
<a href="#getTrustedUsers">getTrustedUsers</a>
</li>
<li>
<a href="#getWithToken">getWithToken</a>
</li>
<li>
<span class="modifier">Async</span>
<a href="#init">init</a>
</li>
<li>
<span class="modifier">Async</span>
Update docs.
2021-06-14 13:28:53 +02:00
<a href="#login">login</a>
Add docs.
2021-05-10 20:56:20 +02:00
</li>
<li>
<a href="#loginView">loginView</a>
</li>
<li>
<a href="#logout">logout</a>
</li>
<li>
Update docs.
2021-06-14 13:28:53 +02:00
<a href="#sendSignedChallenge">sendSignedChallenge</a>
Add docs.
2021-05-10 20:56:20 +02:00
</li>
<li>
<span class="modifier">Async</span>
<a href="#setKey">setKey</a>
</li>
Update docs.
2021-06-14 13:28:53 +02:00
<li>
<a href="#setSessionToken">setSessionToken</a>
</li>
Add docs.
2021-05-10 20:56:20 +02:00
<li>
<a href="#setState">setState</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(httpClient: <a href="https://angular.io/api/common/http/HttpClient" target="_blank">HttpClient</a>, loggingService: <a href="../injectables/LoggingService.html">LoggingService</a>, errorDialogService: <a href="../injectables/ErrorDialogService.html">ErrorDialogService</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Fix meta update process
2021-06-15 18:49:26 +02:00
<div class="io-line">Defined in <a href="" data-line="23" class="link-to-prism">src/app/_services/auth.service.ts:23</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
<div>
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>httpClient</td>
<td>
<code><a href="https://angular.io/api/common/http/HttpClient" target="_blank" >HttpClient</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>loggingService</td>
<td>
<code><a href="../injectables/LoggingService.html" target="_self" >LoggingService</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>errorDialogService</td>
<td>
<code><a href="../injectables/ErrorDialogService.html" target="_self" >ErrorDialogService</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h3 id="methods">
Methods
</h3>
Update docs.
2021-06-14 13:28:53 +02:00
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="addTrustedUser"></a>
<span class="name">
<b>
addTrustedUser
</b>
<a href="#addTrustedUser"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>addTrustedUser(user: <a href="../interfaces/Staff.html">Staff</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Fix meta update process
2021-06-15 18:49:26 +02:00
<div class="io-line">Defined in <a href="" data-line="172"
class="link-to-prism">src/app/_services/auth.service.ts:172</a></div>
Update docs.
2021-06-14 13:28:53 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>user</td>
<td>
<code><a href="../interfaces/Staff.html" target="_self" >Staff</a></code>
</td>
<td>
No
</td>
</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>
Add docs.
2021-05-10 20:56:20 +02:00
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="getChallenge"></a>
<span class="name">
<b>
getChallenge
</b>
<a href="#getChallenge"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>getChallenge()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Fix meta update process
2021-06-15 18:49:26 +02:00
<div class="io-line">Defined in <a href="" data-line="84"
class="link-to-prism">src/app/_services/auth.service.ts:84</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
Update docs.
2021-06-14 13:28:53 +02:00
<b>Returns : </b> <code>Promise&lt;any&gt;</code>
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="getPrivateKey"></a>
<span class="name">
<b>
getPrivateKey
</b>
<a href="#getPrivateKey"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>getPrivateKey()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Fix meta update process
2021-06-15 18:49:26 +02:00
<div class="io-line">Defined in <a href="" data-line="202"
class="link-to-prism">src/app/_services/auth.service.ts:202</a></div>
Update docs.
2021-06-14 13:28:53 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="getPrivateKeyInfo"></a>
<span class="name">
<b>
getPrivateKeyInfo
</b>
<a href="#getPrivateKeyInfo"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>getPrivateKeyInfo()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Fix meta update process
2021-06-15 18:49:26 +02:00
<div class="io-line">Defined in <a href="" data-line="206"
class="link-to-prism">src/app/_services/auth.service.ts:206</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="getPublicKeys"></a>
<span class="name">
<b>
<span class="modifier">Async</span>
getPublicKeys
</b>
<a href="#getPublicKeys"><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>getPublicKeys()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Fix meta update process
2021-06-15 18:49:26 +02:00
<div class="io-line">Defined in <a href="" data-line="190"
class="link-to-prism">src/app/_services/auth.service.ts:190</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Returns : </b> <code>Promise&lt;any&gt;</code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
Update docs.
2021-06-14 13:28:53 +02:00
<a name="getSessionToken"></a>
Add docs.
2021-05-10 20:56:20 +02:00
<span class="name">
<b>
Update docs.
2021-06-14 13:28:53 +02:00
getSessionToken
Add docs.
2021-05-10 20:56:20 +02:00
</b>
Update docs.
2021-06-14 13:28:53 +02:00
<a href="#getSessionToken"><span class="icon ion-ios-link"></span></a>
Add docs.
2021-05-10 20:56:20 +02:00
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
Update docs.
2021-06-14 13:28:53 +02:00
<code>getSessionToken()</code>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Fix meta update process
2021-06-15 18:49:26 +02:00
<div class="io-line">Defined in <a href="" data-line="38"
class="link-to-prism">src/app/_services/auth.service.ts:38</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
Update docs.
2021-06-14 13:28:53 +02:00
<b>Returns : </b> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
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">
Update docs.
2021-06-14 13:28:53 +02:00
<a name="getTrustedUsers"></a>
Add docs.
2021-05-10 20:56:20 +02:00
<span class="name">
<b>
Update docs.
2021-06-14 13:28:53 +02:00
getTrustedUsers
Add docs.
2021-05-10 20:56:20 +02:00
</b>
Update docs.
2021-06-14 13:28:53 +02:00
<a href="#getTrustedUsers"><span class="icon ion-ios-link"></span></a>
Add docs.
2021-05-10 20:56:20 +02:00
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
Update docs.
2021-06-14 13:28:53 +02:00
<code>getTrustedUsers()</code>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Fix meta update process
2021-06-15 18:49:26 +02:00
<div class="io-line">Defined in <a href="" data-line="184"
class="link-to-prism">src/app/_services/auth.service.ts:184</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
<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>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
Update docs.
2021-06-14 13:28:53 +02:00
<a name="getWithToken"></a>
Add docs.
2021-05-10 20:56:20 +02:00
<span class="name">
<b>
Update docs.
2021-06-14 13:28:53 +02:00
getWithToken
Add docs.
2021-05-10 20:56:20 +02:00
</b>
Update docs.
2021-06-14 13:28:53 +02:00
<a href="#getWithToken"><span class="icon ion-ios-link"></span></a>
Add docs.
2021-05-10 20:56:20 +02:00
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
Update docs.
2021-06-14 13:28:53 +02:00
<code>getWithToken()</code>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Fix meta update process
2021-06-15 18:49:26 +02:00
<div class="io-line">Defined in <a href="" data-line="50"
class="link-to-prism">src/app/_services/auth.service.ts:50</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
Update docs.
2021-06-14 13:28:53 +02:00
<b>Returns : </b> <code>Promise&lt;boolean&gt;</code>
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">
Update docs.
2021-06-14 13:28:53 +02:00
<a name="init"></a>
Add docs.
2021-05-10 20:56:20 +02:00
<span class="name">
<b>
Update docs.
2021-06-14 13:28:53 +02:00
<span class="modifier">Async</span>
init
Add docs.
2021-05-10 20:56:20 +02:00
</b>
Update docs.
2021-06-14 13:28:53 +02:00
<a href="#init"><span class="icon ion-ios-link"></span></a>
Add docs.
2021-05-10 20:56:20 +02:00
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
Update docs.
2021-06-14 13:28:53 +02:00
<span class="modifier-icon icon ion-ios-reset"></span>
<code>init()</code>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Fix meta update process
2021-06-15 18:49:26 +02:00
<div class="io-line">Defined in <a href="" data-line="31"
class="link-to-prism">src/app/_services/auth.service.ts:31</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
Update docs.
2021-06-14 13:28:53 +02:00
<b>Returns : </b> <code>Promise&lt;void&gt;</code>
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">
Update docs.
2021-06-14 13:28:53 +02:00
<a name="login"></a>
Add docs.
2021-05-10 20:56:20 +02:00
<span class="name">
<b>
<span class="modifier">Async</span>
Update docs.
2021-06-14 13:28:53 +02:00
login
Add docs.
2021-05-10 20:56:20 +02:00
</b>
Update docs.
2021-06-14 13:28:53 +02:00
<a href="#login"><span class="icon ion-ios-link"></span></a>
Add docs.
2021-05-10 20:56:20 +02:00
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
Update docs.
2021-06-14 13:28:53 +02:00
<code>login()</code>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Fix meta update process
2021-06-15 18:49:26 +02:00
<div class="io-line">Defined in <a href="" data-line="93"
class="link-to-prism">src/app/_services/auth.service.ts:93</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
Update docs.
2021-06-14 13:28:53 +02:00
<b>Returns : </b> <code>Promise&lt;boolean&gt;</code>
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="loginView"></a>
<span class="name">
<b>
loginView
</b>
<a href="#loginView"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>loginView()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Fix meta update process
2021-06-15 18:49:26 +02:00
<div class="io-line">Defined in <a href="" data-line="128"
class="link-to-prism">src/app/_services/auth.service.ts:128</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
<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>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="logout"></a>
<span class="name">
<b>
logout
</b>
<a href="#logout"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>logout()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Fix meta update process
2021-06-15 18:49:26 +02:00
<div class="io-line">Defined in <a href="" data-line="166"
class="link-to-prism">src/app/_services/auth.service.ts:166</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
<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>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
Update docs.
2021-06-14 13:28:53 +02:00
<a name="sendSignedChallenge"></a>
Add docs.
2021-05-10 20:56:20 +02:00
<span class="name">
<b>
Update docs.
2021-06-14 13:28:53 +02:00
sendSignedChallenge
Add docs.
2021-05-10 20:56:20 +02:00
</b>
Update docs.
2021-06-14 13:28:53 +02:00
<a href="#sendSignedChallenge"><span class="icon ion-ios-link"></span></a>
Add docs.
2021-05-10 20:56:20 +02:00
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
Update docs.
2021-06-14 13:28:53 +02:00
<code>sendSignedChallenge(hobaResponseEncoded: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>)</code>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Fix meta update process
2021-06-15 18:49:26 +02:00
<div class="io-line">Defined in <a href="" data-line="72"
class="link-to-prism">src/app/_services/auth.service.ts:72</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>hobaResponseEncoded</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
<div class="io-description">
Update docs.
2021-06-14 13:28:53 +02:00
<b>Returns : </b> <code>Promise&lt;any&gt;</code>
Add docs.
2021-05-10 20:56:20 +02:00
</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="setKey"></a>
<span class="name">
<b>
<span class="modifier">Async</span>
setKey
</b>
<a href="#setKey"><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>setKey(privateKeyArmored)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Fix meta update process
2021-06-15 18:49:26 +02:00
<div class="io-line">Defined in <a href="" data-line="138"
class="link-to-prism">src/app/_services/auth.service.ts:138</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
Add documentation to interceptors.
2021-05-12 08:16:38 +02:00
<td>Description</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</thead>
<tbody>
<tr>
<td>privateKeyArmored</td>
<td>
No
</td>
Add documentation to interceptors.
2021-05-12 08:16:38 +02:00
<td>
<ul>
<li>Private key.</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;boolean&gt;</code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
Update docs.
2021-06-14 13:28:53 +02:00
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="setSessionToken"></a>
<span class="name">
<b>
setSessionToken
</b>
<a href="#setSessionToken"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>setSessionToken(token)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Fix meta update process
2021-06-15 18:49:26 +02:00
<div class="io-line">Defined in <a href="" data-line="42"
class="link-to-prism">src/app/_services/auth.service.ts:42</a></div>
Update docs.
2021-06-14 13:28:53 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>token</td>
<td>
No
</td>
</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>
Add docs.
2021-05-10 20:56:20 +02:00
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="setState"></a>
<span class="name">
<b>
setState
</b>
<a href="#setState"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>setState(s)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Fix meta update process
2021-06-15 18:49:26 +02:00
<div class="io-line">Defined in <a href="" data-line="46"
class="link-to-prism">src/app/_services/auth.service.ts:46</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>s</td>
<td>
No
</td>
</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>
<section>
<h3 id="inputs">
Properties
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="mutableKeyStore"></a>
<span class="name">
<b>
mutableKeyStore</b>
<a href="#mutableKeyStore"><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">
Fix meta update process
2021-06-15 18:49:26 +02:00
<div class="io-line">Defined in <a href="" data-line="18" class="link-to-prism">src/app/_services/auth.service.ts:18</a></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">
Update docs.
2021-06-14 13:28:53 +02:00
<a name="trustedUsers"></a>
<span class="name">
<b>
trustedUsers</b>
<a href="#trustedUsers"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="../interfaces/Staff.html" target="_self" >Array&lt;Staff&gt;</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>[]</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Fix meta update process
2021-06-15 18:49:26 +02:00
<div class="io-line">Defined in <a href="" data-line="19" class="link-to-prism">src/app/_services/auth.service.ts:19</a></div>
Update docs.
2021-06-14 13:28:53 +02:00
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="trustedUsersList"></a>
Add docs.
2021-05-10 20:56:20 +02:00
<span class="name">
<b>
Update docs.
2021-06-14 13:28:53 +02:00
<span class="modifier">Private</span>
trustedUsersList</b>
<a href="#trustedUsersList"><span class="icon ion-ios-link"></span></a>
Add docs.
2021-05-10 20:56:20 +02:00
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
Update docs.
2021-06-14 13:28:53 +02:00
<i>Type : </i> <code><a href="../interfaces/Staff.html" target="_self" >BehaviorSubject&lt;Array&lt;Staff&gt;&gt;</a></code>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Update docs.
2021-06-14 13:28:53 +02:00
<i>Default value : </i><code>new BehaviorSubject&lt;Array&lt;Staff&gt;&gt;(
this.trustedUsers
)</code>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Fix meta update process
2021-06-15 18:49:26 +02:00
<div class="io-line">Defined in <a href="" data-line="20" class="link-to-prism">src/app/_services/auth.service.ts:20</a></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">
Update docs.
2021-06-14 13:28:53 +02:00
<a name="trustedUsersSubject"></a>
Add docs.
2021-05-10 20:56:20 +02:00
<span class="name">
<b>
Update docs.
2021-06-14 13:28:53 +02:00
trustedUsersSubject</b>
<a href="#trustedUsersSubject"><span class="icon ion-ios-link"></span></a>
Add docs.
2021-05-10 20:56:20 +02:00
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
Update docs.
2021-06-14 13:28:53 +02:00
<i>Type : </i> <code><a href="../interfaces/Staff.html" target="_self" >Observable&lt;Array&lt;Staff&gt;&gt;</a></code>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
Update docs.
2021-06-14 13:28:53 +02:00
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>this.trustedUsersList.asObservable()</code>
</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
<tr>
<td class="col-md-4">
Fix meta update process
2021-06-15 18:49:26 +02:00
<div class="io-line">Defined in <a href="" data-line="23" class="link-to-prism">src/app/_services/auth.service.ts:23</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
</tbody>
</table>
</section>
</div>
<div class="tab-pane fade tab-source-code" id="c-source">
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { Injectable } from &#x27;@angular/core&#x27;;
import { hobaParseChallengeHeader } from &#x27;@src/assets/js/hoba.js&#x27;;
import { signChallenge } from &#x27;@src/assets/js/hoba-pgp.js&#x27;;
import { environment } from &#x27;@src/environments/environment&#x27;;
import { LoggingService } from &#x27;@app/_services/logging.service&#x27;;
Fix meta update process
2021-06-15 18:49:26 +02:00
import { MutableKeyStore } from &#x27;@app/_pgp&#x27;;
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
import { ErrorDialogService } from &#x27;@app/_services/error-dialog.service&#x27;;
import { HttpClient } from &#x27;@angular/common/http&#x27;;
Update docs.
2021-06-14 13:28:53 +02:00
import { HttpError, rejectBody } from &#x27;@app/_helpers/global-error-handler&#x27;;
import { Staff } from &#x27;@app/_models&#x27;;
import { BehaviorSubject, Observable } from &#x27;rxjs&#x27;;
Fix meta update process
2021-06-15 18:49:26 +02:00
import { KeystoreService } from &#x27;@app/_services/keystore.service&#x27;;
Add docs.
2021-05-10 20:56:20 +02:00
@Injectable({
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
providedIn: &#x27;root&#x27;,
Add docs.
2021-05-10 20:56:20 +02:00
})
export class AuthService {
mutableKeyStore: MutableKeyStore;
Update docs.
2021-06-14 13:28:53 +02:00
trustedUsers: Array&lt;Staff&gt; &#x3D; [];
private trustedUsersList: BehaviorSubject&lt;Array&lt;Staff&gt;&gt; &#x3D; new BehaviorSubject&lt;Array&lt;Staff&gt;&gt;(
this.trustedUsers
);
trustedUsersSubject: Observable&lt;Array&lt;Staff&gt;&gt; &#x3D; this.trustedUsersList.asObservable();
Add docs.
2021-05-10 20:56:20 +02:00
constructor(
private httpClient: HttpClient,
private loggingService: LoggingService,
private errorDialogService: ErrorDialogService
Fix meta update process
2021-06-15 18:49:26 +02:00
) {}
Add docs.
2021-05-10 20:56:20 +02:00
async init(): Promise&lt;void&gt; {
Fix meta update process
2021-06-15 18:49:26 +02:00
this.mutableKeyStore &#x3D; await KeystoreService.getKeystore();
Add docs.
2021-05-10 20:56:20 +02:00
if (localStorage.getItem(btoa(&#x27;CICADA_PRIVATE_KEY&#x27;))) {
await this.mutableKeyStore.importPrivateKey(localStorage.getItem(btoa(&#x27;CICADA_PRIVATE_KEY&#x27;)));
}
}
Update docs.
2021-06-14 13:28:53 +02:00
getSessionToken(): string {
return sessionStorage.getItem(btoa(&#x27;CICADA_SESSION_TOKEN&#x27;));
}
setSessionToken(token): void {
sessionStorage.setItem(btoa(&#x27;CICADA_SESSION_TOKEN&#x27;), token);
}
Add docs.
2021-05-10 20:56:20 +02:00
setState(s): void {
document.getElementById(&#x27;state&#x27;).innerHTML &#x3D; s;
}
Update docs.
2021-06-14 13:28:53 +02:00
getWithToken(): Promise&lt;boolean&gt; {
const headers &#x3D; {
Authorization: &#x27;Bearer &#x27; + this.getSessionToken,
&#x27;Content-Type&#x27;: &#x27;application/json;charset&#x3D;utf-8&#x27;,
&#x27;x-cic-automerge&#x27;: &#x27;none&#x27;,
};
const options &#x3D; {
headers,
};
return fetch(environment.cicMetaUrl, options).then((response) &#x3D;&gt; {
if (!response.ok) {
this.loggingService.sendErrorLevelMessage(&#x27;failed to get with auth token.&#x27;, this, {
error: &#x27;&#x27;,
});
return false;
Add docs.
2021-05-10 20:56:20 +02:00
}
Update docs.
2021-06-14 13:28:53 +02:00
return true;
Add docs.
2021-05-10 20:56:20 +02:00
});
}
// TODO rename to send signed challenge and set session. Also separate these responsibilities
Update docs.
2021-06-14 13:28:53 +02:00
sendSignedChallenge(hobaResponseEncoded: any): Promise&lt;any&gt; {
const headers &#x3D; {
Authorization: &#x27;HOBA &#x27; + hobaResponseEncoded,
&#x27;Content-Type&#x27;: &#x27;application/json;charset&#x3D;utf-8&#x27;,
&#x27;x-cic-automerge&#x27;: &#x27;none&#x27;,
};
const options &#x3D; {
headers,
};
return fetch(environment.cicMetaUrl, options);
Add docs.
2021-05-10 20:56:20 +02:00
}
Update docs.
2021-06-14 13:28:53 +02:00
getChallenge(): Promise&lt;any&gt; {
return fetch(environment.cicMetaUrl).then((response) &#x3D;&gt; {
if (response.status &#x3D;&#x3D;&#x3D; 401) {
const authHeader: string &#x3D; response.headers.get(&#x27;WWW-Authenticate&#x27;);
return hobaParseChallengeHeader(authHeader);
Add docs.
2021-05-10 20:56:20 +02:00
}
Update docs.
2021-06-14 13:28:53 +02:00
});
Add docs.
2021-05-10 20:56:20 +02:00
}
Update docs.
2021-06-14 13:28:53 +02:00
async login(): Promise&lt;boolean&gt; {
if (this.getSessionToken()) {
sessionStorage.removeItem(btoa(&#x27;CICADA_SESSION_TOKEN&#x27;));
Add docs.
2021-05-10 20:56:20 +02:00
} else {
Update docs.
2021-06-14 13:28:53 +02:00
const o &#x3D; await this.getChallenge();
const r &#x3D; await signChallenge(
o.challenge,
o.realm,
environment.cicMetaUrl,
this.mutableKeyStore
);
Add docs.
2021-05-10 20:56:20 +02:00
Update docs.
2021-06-14 13:28:53 +02:00
const tokenResponse &#x3D; await this.sendSignedChallenge(r).then((response) &#x3D;&gt; {
const token &#x3D; response.headers.get(&#x27;Token&#x27;);
if (token) {
return token;
}
if (response.status &#x3D;&#x3D;&#x3D; 401) {
throw new HttpError(&#x27;You are not authorized to use this system&#x27;, response.status);
}
if (!response.ok) {
throw new HttpError(&#x27;Unknown error from authentication server&#x27;, response.status);
Add docs.
2021-05-10 20:56:20 +02:00
}
Update docs.
2021-06-14 13:28:53 +02:00
});
if (tokenResponse) {
this.setSessionToken(tokenResponse);
this.setState(&#x27;Click button to log in&#x27;);
return true;
Add docs.
2021-05-10 20:56:20 +02:00
}
Update docs.
2021-06-14 13:28:53 +02:00
return false;
}
Add docs.
2021-05-10 20:56:20 +02:00
}
loginView(): void {
document.getElementById(&#x27;one&#x27;).style.display &#x3D; &#x27;none&#x27;;
document.getElementById(&#x27;two&#x27;).style.display &#x3D; &#x27;block&#x27;;
this.setState(&#x27;Click button to log in with PGP key &#x27; + this.mutableKeyStore.getPrivateKeyId());
}
Add documentation to interceptors.
2021-05-12 08:16:38 +02:00
/**
* @throws
* @param privateKeyArmored - Private key.
*/
Add docs.
2021-05-10 20:56:20 +02:00
async setKey(privateKeyArmored): Promise&lt;boolean&gt; {
try {
const isValidKeyCheck &#x3D; await this.mutableKeyStore.isValidKey(privateKeyArmored);
if (!isValidKeyCheck) {
throw Error(&#x27;The private key is invalid&#x27;);
}
// TODO leaving this out for now.
// const isEncryptedKeyCheck &#x3D; await this.mutableKeyStore.isEncryptedPrivateKey(privateKeyArmored);
// if (!isEncryptedKeyCheck) {
// throw Error(&#x27;The private key doesn\&#x27;t have a password!&#x27;);
// }
const key &#x3D; await this.mutableKeyStore.importPrivateKey(privateKeyArmored);
localStorage.setItem(btoa(&#x27;CICADA_PRIVATE_KEY&#x27;), privateKeyArmored);
} catch (err) {
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
this.loggingService.sendErrorLevelMessage(
&#x60;Failed to set key: ${err.message || err.statusText}&#x60;,
this,
{ error: err }
);
Add docs.
2021-05-10 20:56:20 +02:00
this.errorDialogService.openDialog({
message: &#x60;Failed to set key: ${err.message || err.statusText}&#x60;,
});
return false;
}
this.loginView();
return true;
}
logout(): void {
sessionStorage.removeItem(btoa(&#x27;CICADA_SESSION_TOKEN&#x27;));
Update docs.
2021-06-14 13:28:53 +02:00
localStorage.removeItem(btoa(&#x27;CICADA_PRIVATE_KEY&#x27;));
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
window.location.reload();
Add docs.
2021-05-10 20:56:20 +02:00
}
Update docs.
2021-06-14 13:28:53 +02:00
addTrustedUser(user: Staff): void {
const savedIndex &#x3D; this.trustedUsers.findIndex((staff) &#x3D;&gt; staff.userid &#x3D;&#x3D;&#x3D; user.userid);
if (savedIndex &#x3D;&#x3D;&#x3D; 0) {
return;
}
if (savedIndex &gt; 0) {
this.trustedUsers.splice(savedIndex, 1);
}
this.trustedUsers.unshift(user);
this.trustedUsersList.next(this.trustedUsers);
}
getTrustedUsers(): void {
this.mutableKeyStore.getPublicKeys().forEach((key) &#x3D;&gt; {
this.addTrustedUser(key.users[0].userId);
});
Add docs.
2021-05-10 20:56:20 +02:00
}
async getPublicKeys(): Promise&lt;any&gt; {
Update docs.
2021-06-14 13:28:53 +02:00
return new Promise((resolve, reject) &#x3D;&gt; {
fetch(environment.publicKeysUrl).then((res) &#x3D;&gt; {
if (!res.ok) {
// TODO does angular recommend an error interface?
return reject(rejectBody(res));
}
return resolve(res.text());
});
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
});
Add docs.
2021-05-10 20:56:20 +02:00
}
getPrivateKey(): any {
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
return this.mutableKeyStore.getPrivateKey();
Add docs.
2021-05-10 20:56:20 +02:00
}
Update docs.
2021-06-14 13:28:53 +02:00
getPrivateKeyInfo(): any {
return this.getPrivateKey().users[0].userId;
}
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 = 'injectable';
var COMPODOC_CURRENT_PAGE_URL = 'AuthService.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