mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
44 lines
34 KiB
HTML
44 lines
34 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PermissionBasedAuthorizer | Community Solid Server - v4.0.1</title><meta name="description" content="Documentation for Community Solid Server - v4.0.1"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">Community Solid Server - v4.0.1</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Community Solid Server - v4.0.1</a></li><li><a href="PermissionBasedAuthorizer.html">PermissionBasedAuthorizer</a></li></ul><h1>Class PermissionBasedAuthorizer</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>Authorizer that bases its decision on the output it gets from its PermissionReader.
|
|
For each permission it checks if the reader allows that for at least one credential type,
|
|
if yes authorization is granted.
|
|
<code>undefined</code> values for reader results are interpreted as <code>false</code>.</p>
|
|
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="Authorizer.html" class="tsd-signature-type" data-tsd-kind="Class">Authorizer</a><ul class="tsd-hierarchy"><li><span class="target">PermissionBasedAuthorizer</span></li></ul></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 tsd-is-overwrite"><a href="PermissionBasedAuthorizer.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-private-protected"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="PermissionBasedAuthorizer.html#logger" class="tsd-kind-icon">logger</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PermissionBasedAuthorizer.html#resourceSet" class="tsd-kind-icon">resource<wbr/>Set</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PermissionBasedAuthorizer.html#canHandle" class="tsd-kind-icon">can<wbr/>Handle</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionBasedAuthorizer.html#handle" class="tsd-kind-icon">handle</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PermissionBasedAuthorizer.html#handleSafe" class="tsd-kind-icon">handle<wbr/>Safe</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="PermissionBasedAuthorizer.html#hasModePermission" class="tsd-kind-icon">has<wbr/>Mode<wbr/>Permission</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="PermissionBasedAuthorizer.html#isAuthenticated" class="tsd-kind-icon">is<wbr/>Authenticated</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="PermissionBasedAuthorizer.html#requireModePermission" class="tsd-kind-icon">require<wbr/>Mode<wbr/>Permission</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 tsd-is-overwrite"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Permission<wbr/>Based<wbr/>Authorizer<span class="tsd-signature-symbol">(</span>resourceSet<span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceSet.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceSet</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="PermissionBasedAuthorizer.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionBasedAuthorizer</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="Authorizer.html">Authorizer</a>.<a href="Authorizer.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/027c803b/src/authorization/PermissionBasedAuthorizer.ts#L28">src/authorization/PermissionBasedAuthorizer.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The existence of the target resource determines the output status code for certain situations.
|
|
The provided <a href="../interfaces/ResourceSet.html">ResourceSet</a> will be used for that.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>resourceSet: <a href="../interfaces/ResourceSet.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceSet</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><a href="../interfaces/ResourceSet.html">ResourceSet</a> that can verify the target resource existence.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="PermissionBasedAuthorizer.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionBasedAuthorizer</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-private-protected"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a id="logger" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> logger<a href="#logger" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <a href="../interfaces/Logger.html" class="tsd-signature-type" data-tsd-kind="Interface">Logger</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/027c803b/src/authorization/PermissionBasedAuthorizer.ts#L19">src/authorization/PermissionBasedAuthorizer.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="resourceSet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> resource<wbr/>Set<a href="#resourceSet" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">resource<wbr/>Set<span class="tsd-signature-symbol">:</span> <a href="../interfaces/ResourceSet.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceSet</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/027c803b/src/authorization/PermissionBasedAuthorizer.ts#L21">src/authorization/PermissionBasedAuthorizer.ts:21</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="canHandle" class="tsd-anchor"></a><h3 class="tsd-anchor-link">can<wbr/>Handle<a href="#canHandle" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">can<wbr/>Handle<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="../interfaces/AuthorizerInput.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthorizerInput</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"><p>Inherited from <a href="Authorizer.html">Authorizer</a>.<a href="Authorizer.html#canHandle">canHandle</a></p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/027c803b/src/util/handlers/AsyncHandler.ts#L13">src/util/handlers/AsyncHandler.ts:13</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Checks if the input can be handled by this class.
|
|
If it cannot handle the input, rejects with an error explaining why.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>input: <a href="../interfaces/AuthorizerInput.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthorizerInput</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Input that could potentially be handled.</p>
|
|
</div></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><div><p>A promise resolving if the input can be handled, rejecting with an Error if not.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a id="handle" class="tsd-anchor"></a><h3 class="tsd-anchor-link">handle<a href="#handle" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">handle<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="../interfaces/AuthorizerInput.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthorizerInput</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"><p>Overrides <a href="Authorizer.html">Authorizer</a>.<a href="Authorizer.html#handle">handle</a></p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/027c803b/src/authorization/PermissionBasedAuthorizer.ts#L33">src/authorization/PermissionBasedAuthorizer.ts:33</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Handles the given input. This may only be called if <a href="PermissionBasedAuthorizer.html#canHandle">canHandle</a> did not reject.
|
|
When unconditionally calling both in sequence, consider <a href="PermissionBasedAuthorizer.html#handleSafe">handleSafe</a> instead.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>input: <a href="../interfaces/AuthorizerInput.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthorizerInput</a></h5></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><div><p>A promise resolving when handling is finished.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="handleSafe" class="tsd-anchor"></a><h3 class="tsd-anchor-link">handle<wbr/>Safe<a href="#handleSafe" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">handle<wbr/>Safe<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="../interfaces/AuthorizerInput.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthorizerInput</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"><p>Inherited from <a href="Authorizer.html">Authorizer</a>.<a href="Authorizer.html#handleSafe">handleSafe</a></p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/027c803b/src/util/handlers/AsyncHandler.ts#L34">src/util/handlers/AsyncHandler.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Helper function that first runs <a href="PermissionBasedAuthorizer.html#canHandle">canHandle</a> followed by <a href="PermissionBasedAuthorizer.html#handle">handle</a>.
|
|
Throws the error of <a href="PermissionBasedAuthorizer.html#canHandle">canHandle</a> if the data cannot be handled,
|
|
or returns the result of <a href="PermissionBasedAuthorizer.html#handle">handle</a> otherwise.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>input: <a href="../interfaces/AuthorizerInput.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthorizerInput</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Input data that will be handled if it can be handled.</p>
|
|
</div></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><div><p>A promise resolving if the input can be handled, rejecting with an Error if not.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="hasModePermission" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> has<wbr/>Mode<wbr/>Permission<a href="#hasModePermission" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">has<wbr/>Mode<wbr/>Permission<span class="tsd-signature-symbol">(</span>permissionSet<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><a href="../enums/CredentialGroup.html" class="tsd-signature-type" data-tsd-kind="Enumeration">CredentialGroup</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><a href="../enums/AccessMode.html" class="tsd-signature-type" data-tsd-kind="Enumeration">AccessMode</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span>, mode<span class="tsd-signature-symbol">: </span><a href="../enums/AccessMode.html" class="tsd-signature-type" data-tsd-kind="Enumeration">AccessMode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/027c803b/src/authorization/PermissionBasedAuthorizer.ts#L84">src/authorization/PermissionBasedAuthorizer.ts:84</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Checks if one of the Permissions in the PermissionSet grants permission to use the given mode.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>permissionSet: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><a href="../enums/CredentialGroup.html" class="tsd-signature-type" data-tsd-kind="Enumeration">CredentialGroup</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><a href="../enums/AccessMode.html" class="tsd-signature-type" data-tsd-kind="Enumeration">AccessMode</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5></li><li><h5>mode: <a href="../enums/AccessMode.html" class="tsd-signature-type" data-tsd-kind="Enumeration">AccessMode</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="isAuthenticated" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> is<wbr/>Authenticated<a href="#isAuthenticated" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">is<wbr/>Authenticated<span class="tsd-signature-symbol">(</span>credentials<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><a href="../enums/CredentialGroup.html" class="tsd-signature-type" data-tsd-kind="Enumeration">CredentialGroup</a><span class="tsd-signature-symbol">, </span><a href="../interfaces/Credential.html" class="tsd-signature-type" data-tsd-kind="Interface">Credential</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/027c803b/src/authorization/PermissionBasedAuthorizer.ts#L97">src/authorization/PermissionBasedAuthorizer.ts:97</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Checks whether the agent is authenticated (logged in) or not (public/anonymous).</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>credentials: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><a href="../enums/CredentialGroup.html" class="tsd-signature-type" data-tsd-kind="Enumeration">CredentialGroup</a><span class="tsd-signature-symbol">, </span><a href="../interfaces/Credential.html" class="tsd-signature-type" data-tsd-kind="Interface">Credential</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Credentials to check.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="requireModePermission" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> require<wbr/>Mode<wbr/>Permission<a href="#requireModePermission" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">require<wbr/>Mode<wbr/>Permission<span class="tsd-signature-symbol">(</span>credentials<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><a href="../enums/CredentialGroup.html" class="tsd-signature-type" data-tsd-kind="Enumeration">CredentialGroup</a><span class="tsd-signature-symbol">, </span><a href="../interfaces/Credential.html" class="tsd-signature-type" data-tsd-kind="Interface">Credential</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span>, permissionSet<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><a href="../enums/CredentialGroup.html" class="tsd-signature-type" data-tsd-kind="Enumeration">CredentialGroup</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><a href="../enums/AccessMode.html" class="tsd-signature-type" data-tsd-kind="Enumeration">AccessMode</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span>, mode<span class="tsd-signature-symbol">: </span><a href="../enums/AccessMode.html" class="tsd-signature-type" data-tsd-kind="Enumeration">AccessMode</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"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/027c803b/src/authorization/PermissionBasedAuthorizer.ts#L66">src/authorization/PermissionBasedAuthorizer.ts:66</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Ensures that at least one of the credentials provides permissions for the given mode.
|
|
Throws a <a href="ForbiddenHttpError.html">ForbiddenHttpError</a> or <a href="UnauthorizedHttpError.html">UnauthorizedHttpError</a> depending on the credentials
|
|
if access is not allowed.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>credentials: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><a href="../enums/CredentialGroup.html" class="tsd-signature-type" data-tsd-kind="Enumeration">CredentialGroup</a><span class="tsd-signature-symbol">, </span><a href="../interfaces/Credential.html" class="tsd-signature-type" data-tsd-kind="Interface">Credential</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Credentials that require access.</p>
|
|
</div></div></li><li><h5>permissionSet: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><a href="../enums/CredentialGroup.html" class="tsd-signature-type" data-tsd-kind="Enumeration">CredentialGroup</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><a href="../enums/AccessMode.html" class="tsd-signature-type" data-tsd-kind="Enumeration">AccessMode</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>PermissionSet describing the available permissions of the credentials.</p>
|
|
</div></div></li><li><h5>mode: <a href="../enums/AccessMode.html" class="tsd-signature-type" data-tsd-kind="Enumeration">AccessMode</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Which mode is requested.</p>
|
|
</div></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=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="PermissionBasedAuthorizer.html" class="tsd-kind-icon">Permission<wbr/>Based<wbr/>Authorizer</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionBasedAuthorizer.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="PermissionBasedAuthorizer.html#logger" class="tsd-kind-icon">logger</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="PermissionBasedAuthorizer.html#resourceSet" class="tsd-kind-icon">resource<wbr/>Set</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PermissionBasedAuthorizer.html#canHandle" class="tsd-kind-icon">can<wbr/>Handle</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="PermissionBasedAuthorizer.html#handle" class="tsd-kind-icon">handle</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PermissionBasedAuthorizer.html#handleSafe" class="tsd-kind-icon">handle<wbr/>Safe</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="PermissionBasedAuthorizer.html#hasModePermission" class="tsd-kind-icon">has<wbr/>Mode<wbr/>Permission</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="PermissionBasedAuthorizer.html#isAuthenticated" class="tsd-kind-icon">is<wbr/>Authenticated</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="PermissionBasedAuthorizer.html#requireModePermission" class="tsd-kind-icon">require<wbr/>Mode<wbr/>Permission</a></li></ul></li></ul></nav></div></div></div><footer class=""><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><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></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><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |