mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
50 lines
42 KiB
HTML
50 lines
42 KiB
HTML
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>WebAclReader | Community Solid Server - v2.0.0</title><meta name="description" content="Documentation for Community Solid Server - v2.0.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-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 - v2.0.0</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 - v2.0.0</a></li><li><a href="WebAclReader.html">WebAclReader</a></li></ul><h1>Class WebAclReader</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>Handles permissions according to the WAC specification.
|
|
Specific access checks are done by the provided <a href="AccessChecker.html">AccessChecker</a>.</p>
|
|
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="PermissionReader.html" class="tsd-signature-type" data-tsd-kind="Class">PermissionReader</a><ul class="tsd-hierarchy"><li><span class="target">WebAclReader</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="WebAclReader.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-private"><a href="WebAclReader.html#accessChecker" class="tsd-kind-icon">access<wbr/>Checker</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="WebAclReader.html#aclStore" class="tsd-kind-icon">acl<wbr/>Store</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="WebAclReader.html#aclStrategy" class="tsd-kind-icon">acl<wbr/>Strategy</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="WebAclReader.html#identifierStrategy" class="tsd-kind-icon">identifier<wbr/>Strategy</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="WebAclReader.html#logger" class="tsd-kind-icon">logger</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="WebAclReader.html#canHandle" class="tsd-kind-icon">can<wbr/>Handle</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="WebAclReader.html#createPermissions" class="tsd-kind-icon">create<wbr/>Permissions</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="WebAclReader.html#determinePermissions" class="tsd-kind-icon">determine<wbr/>Permissions</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="WebAclReader.html#filterData" class="tsd-kind-icon">filter<wbr/>Data</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="WebAclReader.html#getAclRecursive" class="tsd-kind-icon">get<wbr/>Acl<wbr/>Recursive</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="WebAclReader.html#handle" class="tsd-kind-icon">handle</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="WebAclReader.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="WebAclReader.html#updateAclPermissions" class="tsd-kind-icon">update<wbr/>Acl<wbr/>Permissions</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 name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Web<wbr/>Acl<wbr/>Reader<span class="tsd-signature-symbol">(</span>aclStrategy<span class="tsd-signature-symbol">: </span><a href="../interfaces/AuxiliaryIdentifierStrategy.html" class="tsd-signature-type" data-tsd-kind="Interface">AuxiliaryIdentifierStrategy</a>, aclStore<span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceStore.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceStore</a>, identifierStrategy<span class="tsd-signature-symbol">: </span><a href="../interfaces/IdentifierStrategy.html" class="tsd-signature-type" data-tsd-kind="Interface">IdentifierStrategy</a>, accessChecker<span class="tsd-signature-symbol">: </span><a href="AccessChecker.html" class="tsd-signature-type" data-tsd-kind="Class">AccessChecker</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="WebAclReader.html" class="tsd-signature-type" data-tsd-kind="Class">WebAclReader</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionReader.html">PermissionReader</a>.<a href="PermissionReader.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/authorization/WebAclReader.ts#L45">src/authorization/WebAclReader.ts:45</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>aclStrategy: <a href="../interfaces/AuxiliaryIdentifierStrategy.html" class="tsd-signature-type" data-tsd-kind="Interface">AuxiliaryIdentifierStrategy</a></h5></li><li><h5>aclStore: <a href="../interfaces/ResourceStore.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceStore</a></h5></li><li><h5>identifierStrategy: <a href="../interfaces/IdentifierStrategy.html" class="tsd-signature-type" data-tsd-kind="Interface">IdentifierStrategy</a></h5></li><li><h5>accessChecker: <a href="AccessChecker.html" class="tsd-signature-type" data-tsd-kind="Class">AccessChecker</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="WebAclReader.html" class="tsd-signature-type" data-tsd-kind="Class">WebAclReader</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-private"><a name="accessChecker" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> access<wbr/>Checker</h3><div class="tsd-signature tsd-kind-icon">access<wbr/>Checker<span class="tsd-signature-symbol">:</span> <a href="AccessChecker.html" class="tsd-signature-type" data-tsd-kind="Class">AccessChecker</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/authorization/WebAclReader.ts#L43">src/authorization/WebAclReader.ts:43</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a name="aclStore" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> acl<wbr/>Store</h3><div class="tsd-signature tsd-kind-icon">acl<wbr/>Store<span class="tsd-signature-symbol">:</span> <a href="../interfaces/ResourceStore.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceStore</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/authorization/WebAclReader.ts#L41">src/authorization/WebAclReader.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a name="aclStrategy" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> acl<wbr/>Strategy</h3><div class="tsd-signature tsd-kind-icon">acl<wbr/>Strategy<span class="tsd-signature-symbol">:</span> <a href="../interfaces/AuxiliaryIdentifierStrategy.html" class="tsd-signature-type" data-tsd-kind="Interface">AuxiliaryIdentifierStrategy</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/authorization/WebAclReader.ts#L40">src/authorization/WebAclReader.ts:40</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a name="identifierStrategy" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> identifier<wbr/>Strategy</h3><div class="tsd-signature tsd-kind-icon">identifier<wbr/>Strategy<span class="tsd-signature-symbol">:</span> <a href="../interfaces/IdentifierStrategy.html" class="tsd-signature-type" data-tsd-kind="Interface">IdentifierStrategy</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/authorization/WebAclReader.ts#L42">src/authorization/WebAclReader.ts:42</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a name="logger" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> logger</h3><div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <a href="Logger.html" class="tsd-signature-type" data-tsd-kind="Class">Logger</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/authorization/WebAclReader.ts#L38">src/authorization/WebAclReader.ts:38</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 name="canHandle" class="tsd-anchor"></a><h3>can<wbr/>Handle</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/PermissionReaderInput.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionReaderInput</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="PermissionReader.html">PermissionReader</a>.<a href="PermissionReader.html#canHandle">canHandle</a></p><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/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/PermissionReaderInput.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionReaderInput</a></h5><div class="tsd-comment tsd-typography"><div><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-private"><a name="createPermissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> create<wbr/>Permissions</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">create<wbr/>Permissions<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>, acl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Store</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">></span>, isAcl<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-type">Promise</span><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><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/authorization/WebAclReader.ts#L78">src/authorization/WebAclReader.ts:78</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Creates an Authorization object based on the quads found in the ACL.</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><p>Credentials to check permissions for.</p>
|
|
</div></div></li><li><h5>acl: <span class="tsd-signature-type">Store</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div><p>Store containing all relevant authorization triples.</p>
|
|
</div></div></li><li><h5>isAcl: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div><p>If the target resource is an acl document.</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">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><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a name="determinePermissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> determine<wbr/>Permissions</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">determine<wbr/>Permissions<span class="tsd-signature-symbol">(</span>acl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Store</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">></span>, credentials<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AclPermission</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/authorization/WebAclReader.ts#L95">src/authorization/WebAclReader.ts:95</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Determines the available permissions for the given credentials.
|
|
Will deny all permissions if credentials are not defined</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>acl: <span class="tsd-signature-type">Store</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div><p>Store containing all relevant authorization triples.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> credentials: <a href="../interfaces/Credential.html" class="tsd-signature-type" data-tsd-kind="Interface">Credential</a></h5><div class="tsd-comment tsd-typography"><div><p>Credentials to find the permissions for.</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">AclPermission</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a name="filterData" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> filter<wbr/>Data</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">filter<wbr/>Data<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../interfaces/Representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</a>, predicate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, object<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Store</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/authorization/WebAclReader.ts#L203">src/authorization/WebAclReader.ts:203</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Finds all triples in the data stream of the given representation that use the given predicate and object.
|
|
Then extracts the unique subjects from those triples,
|
|
and returns a Store containing all triples from the data stream that have such a subject.</p>
|
|
</div><div><p>This can be useful for finding the <code>acl:Authorization</code> objects corresponding to a specific URI
|
|
and returning all relevant information on them.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <a href="../interfaces/Representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</a></h5><div class="tsd-comment tsd-typography"><div><p>Representation with data stream of internal/quads.</p>
|
|
</div></div></li><li><h5>predicate: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div><p>Predicate to match.</p>
|
|
</div></div></li><li><h5>object: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div><p>Object to match.</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">Store</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>A store containing the relevant triples.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a name="getAclRecursive" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr/>Acl<wbr/>Recursive</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">get<wbr/>Acl<wbr/>Recursive<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a>, recurse<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Store</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/authorization/WebAclReader.ts#L158">src/authorization/WebAclReader.ts:158</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the ACL triples that are relevant for the given identifier.
|
|
These can either be from a corresponding ACL document or an ACL document higher up with defaults.
|
|
Rethrows any non-NotFoundHttpErrors thrown by the ResourceStore.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5><div class="tsd-comment tsd-typography"><div><p>ResourceIdentifier of which we need the ACL triples.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> recurse: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div><p>Only used internally for recursion.</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">Store</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>A store containing the relevant ACL triples.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="handle" class="tsd-anchor"></a><h3>handle</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>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/PermissionReaderInput.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionReaderInput</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">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><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="PermissionReader.html">PermissionReader</a>.<a href="PermissionReader.html#handle">handle</a></p><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/authorization/WebAclReader.ts#L59">src/authorization/WebAclReader.ts:59</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Checks if an agent is allowed to execute the requested actions.
|
|
Will throw an error if this is not the case.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>__namedParameters: <a href="../interfaces/PermissionReaderInput.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionReaderInput</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">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><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="handleSafe" class="tsd-anchor"></a><h3>handle<wbr/>Safe</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/PermissionReaderInput.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionReaderInput</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">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><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="PermissionReader.html">PermissionReader</a>.<a href="PermissionReader.html#handleSafe">handleSafe</a></p><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/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="WebAclReader.html#canHandle">canHandle</a> followed by <a href="WebAclReader.html#handle">handle</a>.
|
|
Throws the error of <a href="WebAclReader.html#canHandle">canHandle</a> if the data cannot be handled,
|
|
or returns the result of <a href="WebAclReader.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/PermissionReaderInput.html" class="tsd-signature-type" data-tsd-kind="Interface">PermissionReaderInput</a></h5><div class="tsd-comment tsd-typography"><div><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">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><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 name="updateAclPermissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> update<wbr/>Acl<wbr/>Permissions</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">update<wbr/>Acl<wbr/>Permissions<span class="tsd-signature-symbol">(</span>aclPermissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AclPermission</span>, isAcl<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-type">AclPermission</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/authorization/WebAclReader.ts#L131">src/authorization/WebAclReader.ts:131</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Sets the correct values for non-acl permissions such as create and delete.
|
|
Also adds the correct values to indicate that having control permission
|
|
implies having read/write/etc. on the acl resource.</p>
|
|
</div><div><p>The main reason for keeping the control value is so we can correctly set the WAC-Allow header later.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>aclPermissions: <span class="tsd-signature-type">AclPermission</span></h5></li><li><h5>isAcl: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AclPermission</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="WebAclReader.html" class="tsd-kind-icon">Web<wbr/>Acl<wbr/>Reader</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="WebAclReader.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="WebAclReader.html#accessChecker" class="tsd-kind-icon">access<wbr/>Checker</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="WebAclReader.html#aclStore" class="tsd-kind-icon">acl<wbr/>Store</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="WebAclReader.html#aclStrategy" class="tsd-kind-icon">acl<wbr/>Strategy</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="WebAclReader.html#identifierStrategy" class="tsd-kind-icon">identifier<wbr/>Strategy</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="WebAclReader.html#logger" class="tsd-kind-icon">logger</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="WebAclReader.html#canHandle" class="tsd-kind-icon">can<wbr/>Handle</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="WebAclReader.html#createPermissions" class="tsd-kind-icon">create<wbr/>Permissions</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="WebAclReader.html#determinePermissions" class="tsd-kind-icon">determine<wbr/>Permissions</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="WebAclReader.html#filterData" class="tsd-kind-icon">filter<wbr/>Data</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="WebAclReader.html#getAclRecursive" class="tsd-kind-icon">get<wbr/>Acl<wbr/>Recursive</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="WebAclReader.html#handle" class="tsd-kind-icon">handle</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="WebAclReader.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="WebAclReader.html#updateAclPermissions" class="tsd-kind-icon">update<wbr/>Acl<wbr/>Permissions</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-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-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-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> |