<!doctype html><html class="default no-js"><head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>permission-guard</title> <meta name="description" content="Documentation for permission-guard"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="assets/css/main.css"></head><body><header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base="."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="index.html" class="title">permission-guard</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-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="globals.html">Globals</a> </li> </ul> <h1>permission-guard</h1> </div> </div></header><div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <div class="tsd-panel tsd-typography"> <p align="center"> <h1 align="center">Permission Guard</h1> </p> <p align="center"> A zero-dependency, minimal permission guard for <a href="https://deno.land/">Deno</a> to prevent overly permissive execution of your applications.</p> <p align="center"> <a href="https://github.com/asos-craigmorten/permission-guard/tags/"><img src="https://img.shields.io/github/tag/asos-craigmorten/permission-guard" alt="Current version" /></a> <img src="https://github.com/asos-craigmorten/permission-guard/workflows/Test/badge.svg" alt="Current test status" /> <a href="https://doc.deno.land/https/deno.land/x/permission-guard/mod.ts"><img src="https://doc.deno.land/badge.svg" alt="Deno docs" /></a> <a href="http://makeapullrequest.com"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs are welcome" /></a> <a href="https://github.com/asos-craigmorten/permission-guard/issues/"><img src="https://img.shields.io/github/issues/asos-craigmorten/permission-guard" alt="permission-guard issues" /></a> <img src="https://img.shields.io/github/stars/asos-craigmorten/permission-guard" alt="permission-guard stars" /> <img src="https://img.shields.io/github/forks/asos-craigmorten/permission-guard" alt="permission-guard forks" /> <img src="https://img.shields.io/github/license/asos-craigmorten/permission-guard" alt="permission-guard license" /> <a href="https://GitHub.com/asos-craigmorten/permission-guard/graphs/commit-activity"><img src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" alt="permission-guard is maintained" /></a> <a href="https://nest.land/package/permissionGuard"><img src="https://nest.land/badge.svg" alt="Published on nest.land" /></a> </p> <p align="center"> <a href="https://deno.land/x/permissionGuard"><img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fdeno-visualizer.danopia.net%2Fshields%2Flatest-version%2Fx%2FpermissionGuard%2Fmod.ts" alt="permission-guard latest /x/ version" /></a> <a href="https://deno-visualizer.danopia.net/dependencies-of/https/deno.land/x/permissionGuard/mod.ts"><img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fdeno-visualizer.danopia.net%2Fshields%2Fdep-count%2Fx%2FpermissionGuard%2Fmod.ts" alt="permission-guard dependency count" /></a> <a href="https://deno-visualizer.danopia.net/dependencies-of/https/deno.land/x/permissionGuard/mod.ts"><img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fdeno-visualizer.danopia.net%2Fshields%2Fupdates%2Fx%2FpermissionGuard%2Fmod.ts" alt="permission-guard dependency outdatedness" /></a> <a href="https://deno-visualizer.danopia.net/dependencies-of/https/deno.land/x/permissionGuard/mod.ts"><img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fdeno-visualizer.danopia.net%2Fshields%2Fcache-size%2Fx%2FpermissionGuard%2Fmod.ts" alt="permission-guard cached size" /></a> </p> <hr> <a href="#table-of-contents" id="table-of-contents" style="color: inherit; text-decoration: none;"> <h2>Table of Contents</h2> </a> <ul> <li><a href="#getting-started">Getting Started</a></li> <li><a href="#installation">Installation</a></li> <li><a href="#features">Features</a></li> <li><a href="#documentation">Documentation</a></li> <li><a href="#examples">Examples</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#license">License</a></li> </ul> <a href="#getting-started" id="getting-started" style="color: inherit; text-decoration: none;"> <h2>Getting Started</h2> </a> <pre><code class="language-ts"><span class="hljs-keyword">import</span> { guard } <span class="hljs-keyword">from</span> <span class="hljs-string">"https://deno.land/x/permissionGuard@2.4.0/mod.ts"</span>;
<span class="hljs-keyword">await</span> guard();
<span class="hljs-built_in">console</span>.log(<span class="hljs-string">"Execute my code...!"</span>);</code></pre> <a href="#installation" id="installation" style="color: inherit; text-decoration: none;"> <h2>Installation</h2> </a> <p>This is a <a href="https://deno.land/">Deno</a> module available to import direct from this repo and via the <a href="https://deno.land/x">Deno Registry</a>.</p> <p>Before importing, <a href="https://deno.land/#installation">download and install Deno</a>.</p> <p>You can then import Permission Guard straight into your project:</p> <pre><code class="language-ts"><span class="hljs-keyword">import</span> { guard } <span class="hljs-keyword">from</span> <span class="hljs-string">"https://deno.land/x/permissionGuard@2.4.0/mod.ts"</span>;</code></pre> <p>Permission Guard is also available on <a href="https://nest.land/package/permissionGuard">nest.land</a>, a package registry for Deno on the Blockchain.</p> <pre><code class="language-ts"><span class="hljs-keyword">import</span> { guard } <span class="hljs-keyword">from</span> <span class="hljs-string">"https://x.nest.land/permissionGuard@2.4.0/mod.ts"</span>;</code></pre> <blockquote> <p><strong>Note:</strong> Permission Guard makes use of the unstable Deno Permissions API which requires <code>--unstable</code> to be passed in the Deno <code>run</code> command. You can use Permission Guard in applications and not provide the <code>--unstable</code> flag, Permission Guard will simply return as a no-op and not provide any defenses.</p> </blockquote> <a href="#features" id="features" style="color: inherit; text-decoration: none;"> <h2>Features</h2> </a> <ul> <li>Protection against unnecessary top-level permissions. Including ability to revoke undesired permissions.</li> <li>Protection against missing required permissions.</li> <li>Recommendations where permissions could be better scoped (if <code>log: true</code> provided).</li> <li>Useful logs detailing the missing or insecure permissions (if <code>log: true</code> provided).</li> </ul> <a href="#documentation" id="documentation" style="color: inherit; text-decoration: none;"> <h2>Documentation</h2> </a> <ul> <li><a href="https://asos-craigmorten.github.io/permission-guard/">Permission Guard Docs</a> - usually the best place when getting started ✨</li> <li><a href="https://doc.deno.land/https/deno.land/x/permissionGuard/mod.ts">Permission Guard Deno Docs</a></li> <li><a href="https://github.com/asos-craigmorten/permission-guard/blob/main/LICENSE.md">License</a></li> <li><a href="https://github.com/asos-craigmorten/permission-guard/blob/main/.github/CHANGELOG.md">Changelog</a></li> </ul> <a href="#examples" id="examples" style="color: inherit; text-decoration: none;"> <h2>Examples</h2> </a> <p>To run the <a href="./examples">examples</a>, you have two choices:</p> <ol> <li><p>Clone the Permission Guard repo locally:</p> <pre><code class="language-bash">git <span class="hljs-built_in">clone</span> git://github.com/asos-craigmorten/permission-guard.git --depth 1<span class="hljs-built_in">cd</span> permission-guard</code></pre> <p>Then run the example you want:</p> <pre><code class="language-bash">deno run --unstable ./examples/defaults/index.ts</code></pre> </li> </ol> <p>All the <a href="./examples">examples</a> contain example commands in their READMEs to help get you started.</p> <a href="#contributing" id="contributing" style="color: inherit; text-decoration: none;"> <h2>Contributing</h2> </a> <p><a href="https://github.com/asos-craigmorten/permission-guard/blob/main/.github/CONTRIBUTING.md">Contributing guide</a></p> <hr> <a href="#license" id="license" style="color: inherit; text-decoration: none;"> <h2>License</h2> </a> <p>Permission Guard is licensed under the <a href="./LICENSE.md">MIT License</a>.</p> </div> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="globals.html"><em>Globals</em></a> </li> <li class=" tsd-kind-module"> <a href="modules/_guard_.html">"guard"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> </nav> </div> </div></div><footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> </ul> </div> </div></footer><div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/js/main.js"></script></body></html>