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

@booljs/passport

v0.3.0

Published

Middleware to connect Passport.js with Bool.js and a RouteMiddleware to authenticate API users through Auth Strategies.

Downloads

3

Readme

Bool.js - Passport authentication Middleware

Build Status Dependencies status for booljs-passport devDependency Status Code Climate Inline docs

booljs-passport NPM icon

Join the chat at https://gitter.im/BoolJS/booljs-passport

booljs-passport is a route middleware intended to enable developers to use Passport authentication strategies in the bool.js Framework.

Install

Install the package using

npm i -S booljs-passport

Bool.js Passport uses some peerDependencies you must have in your project. We encourage using npm 3+ in all your projects, because is strict in making you declare them in your project.

npm i -S [email protected]

Finally, you will need to install packages for the authentication strategies you will use in booljs-passport. Find them in Passport website.

Usage

First, register booljs-passport as well as the strategies you want to use in your bool.js application.

In index.js, declare:

var booljs = require('bool.js');

(booljs('com.example.api', [ 'booljs-passport', 'passport-http-bearer' ])
    .setServerLoader('booljs-express')
    .setDatabaseLoader('booljs-mongoose')
    .run()
);

Then, define the strategies to be used, as well as the default one in a configuration file called configuration/security.json

{
    "passport": {
        "strategies": [
            "bearer"
        ],
        "defaultStrategy": "bearer",
        "strategyOptions": {
            "session": false
        }
    }
}

Finally, create a new DAO module in dao/passport.js and implement them.

'use strict';

module.exports = function (app) {
    var Bearer          = app.utilities['passport-http-bearer']
    ,   Token           = app.dao.Token
    ,   User            = app.dao.User;

    this.bearer = function (passport) {
        function convertUser(user, done) { done(null, user); }
        passport.serializeUser(convertUser);
        passport.deserializeUser(convertUser);

        return new Bearer.Strategy(function (accessToken, done) {
            var token = new Token()
            ,   user  = new User();

            return token.find(accessToken).then((_token) => {
                return _token && user.find(_token.user) || false;
            }).then((_user) => {
                done(null, _user || false);
            }).catch(done);
        });
    };

};

booljs-passport is an Omittable middleware. That means it's executed by default in all routes, unless you explicitly declare not to use it. The policy you must apply to a route in order to achieve it is public: true.

For example, in here, we declare a resource to list public venues as omitting the use of the middleware.

'use strict';

module.exports = function (app) {
    var venue = new app.Controllers.Venue();

    return [
        {
            method: 'get',
            url: '/venues',
            action: venue.list,
            cors: true,
            public: true
        }
    ];

};

Have in mind this policy will invalidate any authentication strategy, even if you declare one as a policy, thus you won't have any chance to get user info while using those routes. If you think you know how to solve this issue, please, help us; read the Contributing section to find out how.

Customize settings

Configuration file

You must declare an object named passport in the configuration file to declare settings.

| Value | Type | Description | | :-------------- | :--------- | :----------------------------------------------------------------------------------- | | defaultStrategy | String | Describes the default authentication strategy to be used when not declared in route | | module | String | The name of the DAO module that contains strategies definitions. (Defaults Passport) | | strategies | String[] | A list of strategies to be loaded into passport | | strategyOptions | Object | The options to be passed by default to passport authenticate call |

Route options

In route, declare a policy called authentication.

| Value | Type | Description | | :------- | :--------- | :------------------------------------------------------- | | strategy | String | The authentication strategy to be used in the route | | options | Object | The options to be passed to passport authenticate call |

Contributing

We're still making -or looking for- a serious contributing document. By now, feel free to contribute the way you usually do in other projects. If this is your first time, follow these steps:

  1. Fork us
  2. Make your changes
  3. Commit by each file change, indicating what you did in that file.
  4. Please –¡please!-, don't push until you get the tests completely passing (in this case is just once).
  5. Push and make a pull request, describing what you did in general.
  6. PR will go through an automated revision in Travis CI. If everything is correct, a peer-revision will start.

FAQ

What is bool.js?

Bool.js is an MVC Framework. But is not just any other framework; it gives us back the power to choose how to organize a well-designed project, so we can choose our dependencies, craft our architecture, choose our data connectors, and finally, work based on cool development structures without hesitating about learning the framework as is.

Bool.js also reminds the importance of having a cool workspace structure. That's why it's based on namespaces, leading us to focus on our code rather than focusing on managing complicated references to other files in our project.

Can I migrate my projects to bool.js?

Of course you can. Bool.js is Free Software (not as in a free beer, but in free as a bird). Just remember to update all of your dependencies, arrange your code in the right project structure (we're very tight at that) and finally, use Node.js 4.0.0 or further versions.