npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

dataportenapi

v0.3.0

Published

ExpressJS Middleware layer that easily lets you use Dataporten for authentication and authorization.

Downloads

8

Readme

Dataporten Gatekeeper Expressjs Middleware

Install Dataporten API Protector using npm:

npm install dataportenapi --save

Then include it in your ExpressJS server application:

var DataportenAPI = require('dataportenapi').DataportenAPI;

Register your API at Connect Dashboard:

Point your API endpoint in Dashboard to your ExpressJS API.

And initialize Dataporten API Protector using the password that was generated for trust between Dataporten API Gatekeeper and your ExpressJS API:

var fc = new DataportenAPI({
    "password": "30d63d9b-3574-4832-be37-0c93121fca21"
});

DataportenAPI comes with several middlewares. First the optional cors() middleware, and then the important setup() middleware that establish trust and parses the incoming request headers.

A typical use is this:

app.use('/api', fc.cors(), fc.setup(), router);

Within a request handler, you may access some information:

var router = express.Router();
router.get('/', function(req, res) {
    res.json({
        "message": 'hooray! welcome to our api!',
        "youMustBe": req.dataporten.userid,
        "accessingUsingThisClient": req.dataporten.clientid,
        "withTheseSubScopes": req.dataporten.scopes
    });
});

You may easily use the policy() middleware to apply some kind of authorization policy before the request is dealt with.

router.get('/write', fc.policy({requireScopes: ["write"], requireUserUnlessScopes: ["clientonly"]}), function(req, res) {
    res.json({
        message: 'This endpoint is slightly more protected',
        "youMustBe": req.dataporten.userid,
        "usingClient": req.dataporten.clientid
    });
});

The policy() middleware takes an object as input and the object properties can be one of:

  • requireUser - does not accept requests that is not on behalf of an authenticated user
  • requireUserUnlessScopes - does not accept requests that is not on behalf of an authenticated user, unless the request is authorized with a set of one or more specific scopes.
  • requireScopes - does not accept requests without this subscope.

A simpler example:

router.get('/', fc.policy({requireUser: true}), function(req, res) {
    res.json({
        message: 'hooray! welcome to our api!',
        "youMustBe": req.dataporten.userid
    });
});