feathers-authentication

feathers-authentication

Add Authentication to your FeathersJS app.

feathers-authentication adds shared PassportJS authentication for Feathers HTTP REST and WebSockets services using JSON Web Tokens.

Installation

npm install feathers-authentication --save

Documentation

Please refer to the Authentication documentation for more details:

• Local Auth Tutorial - How to implement a username and password-based authentication.
• Use Hooks for Authorization - Learn about the bundled hooks.

Complete Example

Here's an example of a Feathers server that uses feathers-authentication for local auth. It includes a users service that uses feathers-mongoose. Note that it does NOT implement any authorization.

/* * * Import Feathers and Plugins * * */
var feathers = require('feathers');
var hooks = require('feathers-hooks');
var bodyParser = require('body-parser');
var feathersAuth = require('feathers-authentication').default;
var authHooks = require('feathers-authentication').hooks;

/* * * Prepare the Mongoose service * * */
var mongooseService = require('feathers-mongoose');
var mongoose = require('mongoose');
var Schema = mongoose.Schema;
var UserSchema = new Schema({
  username: {type: String, required: true, unique: true},
  password: {type: String, required: true },
  createdAt: {type: Date, 'default': Date.now},
  updatedAt: {type: Date, 'default': Date.now}
});
var UserModel = mongoose.model('User', UserSchema);

/* * * Connect the MongoDB Server * * */
mongoose.Promise = global.Promise;
mongoose.connect('mongodb://localhost:27017/feathers');

/* * * Initialize the App and Plugins * * */
var app = feathers()
  .configure(feathers.rest())
  .configure(feathers.socketio())
  .configure(hooks())
  .use(bodyParser.json())
  .use(bodyParser.urlencoded({ extended: true }))

  // Configure feathers-authentication
  .configure(feathersAuth({
    secret: 'feathers-rocks'
  }));

/* * * Setup the User Service and hashPassword Hook * * */
app.use('/api/users', new mongooseService('user', UserModel))
var service = app.service('/api/users');
service.before({
  create: [authHooks.hashPassword('password')]
});

/* * * Start the Server * * */
var port = 3030;
var server = app.listen(port);
server.on('listening', function() {
  console.log(`Feathers application started on localhost:3030);
});

Changelog

0.0.5

• Initial release

License

Copyright (c) 2015

Licensed under the MIT license.

Changelog

v0.1.0 (2016-01-25)

Full Changelog

Closed issues:

• Get the Travis build to work. #27
• Login not working #24
• Hooks should be configurable (they should be functions) #11
• Document the bundled hooks. #10

Merged pull requests:

• Migrate docs to book #31 (marshallswain)
• hashPassword: Async bcrypt usage needs a promise #30 (marshallswain)
• Removing extras from travis.yml #29 (marshallswain)
• Fixing build #28 (marshallswain)
• Adding nsp check #26 (marshallswain)