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

d-passport

v0.5.31

Published

Provides authentication for DerbyJS projects

Downloads

52

Readme

Derby.js Passport Authentication

For Derby/Racer 0.6

Provides authentication middleware (using Passport) for use in your Derby projects.

##Demo

https://d-passport.herokuapp.com

##Installation

npm install d-passport --save

// the main object in server side starter script
passport = require("d-passport");

###Step 1 configure

/*
Setup a hash of strategies you'll use - strategy objects and their configurations
Note, API keys should be stored as environment variables (eg, process.env.FACEBOOK_KEY) or you can use nconf to store
them in config.json, which we're doing here
*/
var passportStrategies = {
  facebook: {
    strategy: require("passport-facebook").Strategy,
    conf: {
      clientID: '1234',
      clientSecret: '5678'
    }
  },
  twitter: {
    strategy: require("passport-twitter").Strategy,
    conf: {
      consumerKey: 'qwerty',
      consumerSecret: 'uiop'
    }
  }
};

Create a json object that holds the configuration. Most of these will get sane defaults (see lib/options.js for an example), so it's not entirely necessary to create this whole object.

var options = {
    "messages": {
        "failureFlash": true,
        "successFlash": "Logged in"
    },
    "redirects": {
        "failureRedirect": "/",
        "successRedirect": "/"
    },
    "urls": {
        "login": "/login",
        "logout": "/logout",
        "register": "/register",
        "passwordReset": "/password-reset",
        "passwordChange": "/password-change"
    },
    "form": {
        "email": {
            "required": true,
            "unique": true,
            "human": "Email address"
        },
        "username": {
            "required": true,
            "unique": true,
            "validation": "^[a-zA-Z0-9_äöåÄÖÅ]{3,32}$",
            "human": "Username"
        },
        "password": {
            "required": true,
            "unique": true,
            "validation": "^.{8,32}$",
            "human": "Password"
        }
    },
    "fields": {
        "emailField": "email",
        "usernameField": "username",
        "passwordField": "password",
        "passwordField2": "password2"
    },
    "site": {
        "domain": "http://localhost:3000",
        "name": "My Site",
        "email": "[email protected]"
    },
    "smtp": {
        "host": "smtp.mailgun.org",
        "port": "587",
        "user": "[email protected]",
        "pass": "123456"
    }
}

###Step 2 configure, initialize the store, setup strategies

passport.configure(options)
passport.store(store)

###Step 3 add middleware Make sure your express app is using sessions & body-parsing

expressApp
    ...
    .use(express.cookieParser())
    .use(express.session({
        secret: conf.get('SESSION_SECRET')
        store: new MongoStore({url: mongoUrl, safe: true})
    }))
    .use(express.bodyParser())
    .use(express.methodOverride())

Use d-passport's mounted middleware

    ...
    # passport.middleware is inserted after modelMiddleware and before the app router to pass server accessible data to a model
    .use(passport.middleware(expressApp, strategies))
    ...

###Step 4 login & register components (optional) If you want drop-in Login and Register forms, you can use the provided components. To enable these, you'll need this in your /src/app/index.coffee (or similar) file:

app.component(require('d-passport/component'))

To actually add the login/register component into yout template, do these:

<view name="d-passport:login"></view>
<view name="d-passport:register"></view>
<view name="d-passport:password-reset"></view>

Use http://purecss.io/ to see somewhat nicer looking forms. Just download the minified css file and import it in your index.styl.

###Step 5 flash messages (optional, recommended)

Use derby-flash with this to see all the messages this module outputs.

Why not EveryAuth?

This project was originally implemented with Everyauth (see branch in original project), but had some issues:

  1. Every provider had to be implemented individually in code. Passport has an abstraction layer, which is what allows us to pass in Strategy + conf objects in server/index.js for every provider we want enabled.
  2. Password authentication posed technical difficulties. See the Google Group discussion

The derby-examples/auth folder, written by the creators of Derby, uses Everyauth - so if you can't get derby-auth/derby-passport working, you may want to give that a shot. Note, it doesn't yet implement username / password authentication.

Credits