feathers-authentication

feathers-authentication

v1.0.0

IMPORTANT: To see the feathers-authentication 1.0 documentation go to the master branch and also have a look at the migration guide.

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 from 'feathers';
import hooks from 'feathers-hooks';
import bodyParser from 'body-parser';
import authentication from 'feathers-authentication';
import { hooks as authHooks } from 'feathers-authentication';
import mongoose from 'mongoose';
import service from 'feathers-mongoose';

const port = 3030;
const Schema = mongoose.Schema;
const UserSchema = new Schema({
  email: {type: String, required: true, unique: true},
  password: {type: String, required: true },
  createdAt: {type: Date, 'default': Date.now},
  updatedAt: {type: Date, 'default': Date.now}
});
let UserModel = mongoose.model('User', UserSchema);

mongoose.Promise = global.Promise;
mongoose.connect('mongodb://localhost:27017/feathers');

let app = feathers()
  .configure(feathers.rest())
  .configure(feathers.socketio())
  .configure(hooks())
  .use(bodyParser.json())
  .use(bodyParser.urlencoded({ extended: true }))
  // Configure feathers-authentication
  .configure(authentication());

app.use('/users', new service('user', {Model: UserModel}))

let userService = app.service('users');
userService.before({
  create: [authHooks.hashPassword('password')]
});

let server = app.listen(port);
server.on('listening', function() {
  console.log(`Feathers application started on localhost:${port}`);
});

Client use

You can use the client in the Browser, in NodeJS and in React Native.

import io from 'socket.io-client';
import feathers from 'feathers/client';
import hooks from 'feathers-hooks';
import socketio from 'feathers-socketio/client';
import authentication from 'feathers-authentication/client';

const socket = io('http://localhost:3030/');
const app = feathers()
  .configure(socketio(socket)) // you could use Primus or REST instead
  .configure(hooks())
  .configure(authentication({ storage: window.localStorage }));

app.authenticate({
  type: 'local',
  'email': '[e-mail]',
  'password': 'admin'
}).then(function(result){
  console.log('Authenticated!', result);
}).catch(function(error){
  console.error('Error authenticating!', error);
});

License

Copyright (c) 2016

Licensed under the MIT license.

Changelog

v0.7.13 (2017-10-23)

Full Changelog

Closed issues:

• Error authenticating! Error: Token provided to verifyJWT is missing or not a string ? #584
• Visual Studio Code Debug no authentication #583
• [Feature Request] Cloud DB's #581
• Request doesn't contain any headers when user service requested #578
• No way to pass Options to auth.express.authenticate. Needed for Google API refreshToken #576
• /auth/google 404 Not Found #574
• unique email not working while create #572
• authentication service not return token jwt #571
• typo in jwt default options #570
• Generate new app, Google-only auth, throws error #568
• An in-range update of feathers is breaking the build 🚨 #565
• Documentation not understanding #563
• Checking hook.params.headers.authorization #552
• Ability to send token as part of URL #546
• Anonymous Authentication #544
• Quote Error #519
• [example] CustomStrategy using passport-custom #516
• [Epic] Auth 2.0.0 #513
• ID set to null - Unable to delete with customer ID field. #422
• Prefixing socket events #418
• Passwordless auth #409
• How to authenticate the application client? not only the users #405
• Multi-factor Local Auth #5

Merged pull requests:

• Features/typescript fix #585 (TimMensch)
• Update mocha to the latest version 🚀 #582 (greenkeeper[bot])
• Update sinon to the latest version 🚀 #580 (greenkeeper[bot])
• Update jsonwebtoken to the latest version 🚀 #567 (greenkeeper[bot])
• Include Babel Polyfill for Node 4 #566 (daffl)
• Update passport to the latest version 🚀 #558 (greenkeeper[bot])
• Revert "Make feathers-authentication match security documents" #556 (ekryski)
• Update debug to the latest version 🚀 #555 (greenkeeper[bot])
• Make feathers-authentication match security documents #554 (micaksica2)
• Update sinon to the latest version 🚀 #551 (greenkeeper[bot])
• Update ws to the latest version 🚀 #549 (greenkeeper[bot])
• Update chai to the latest version 🚀 #543 (greenkeeper[bot])
• adding a default jwt uuid. Refs #513 #539 (ekryski)
• Refresh token must have a user ID #419 (francisco-sanchez-molina)