New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
@feathersjs/authentication-local
Advanced tools
@feathersjs/authentication-local - npm Package Compare versions
Comparing version 1.0.2 to 1.0.3
| # Change Log | ||
| ## [v1.0.2](https://github.com/feathersjs/authentication-local/tree/v1.0.2) (2017-12-06) | ||
| [Full Changelog](https://github.com/feathersjs/authentication-local/compare/v1.0.1...v1.0.2) | ||
| **Closed issues:** | ||
| - why is the password send as plain text instead of encrypting it on client side? [\#44](https://github.com/feathersjs/authentication-local/issues/44) | ||
| **Merged pull requests:** | ||
| - Update hook.result if an external provider is set [\#46](https://github.com/feathersjs/authentication-local/pull/46) ([daffl](https://github.com/daffl)) | ||
| - Update feathers-memory to the latest version 🚀 [\#45](https://github.com/feathersjs/authentication-local/pull/45) ([greenkeeper[bot]](https://github.com/apps/greenkeeper)) | ||
| ## [v1.0.1](https://github.com/feathersjs/authentication-local/tree/v1.0.1) (2017-11-16) | ||
@@ -4,0 +16,0 @@ [Full Changelog](https://github.com/feathersjs/authentication-local/compare/v1.0.0...v1.0.1) |
| { | ||
| "name": "@feathersjs/authentication-local", | ||
| "description": "Local authentication strategy for @feathers/authentication", | ||
| "version": "1.0.2", | ||
| "version": "1.0.3", | ||
| "homepage": "https://github.com/feathersjs/authentication-local", | ||
@@ -38,4 +38,3 @@ "main": "lib/", | ||
| "coverage": "istanbul cover node_modules/mocha/bin/_mocha -- --opts mocha.opts", | ||
| "test": "npm run lint && npm run coverage", | ||
| "start": "npm run compile && node example/app" | ||
| "test": "npm run lint && npm run coverage" | ||
| }, | ||
@@ -72,3 +71,3 @@ "semistandard": { | ||
| "mocha": "^4.0.0", | ||
| "semistandard": "^11.0.0", | ||
| "semistandard": "^12.0.0", | ||
| "sinon": "^4.0.0", | ||
@@ -75,0 +74,0 @@ "sinon-chai": "^2.11.0" |
145
README.md
@@ -18,142 +18,33 @@ # @feathersjs/authentication-local | ||
| **Note:** This is only compatibile with `@feathers/authentication@1.x` and above. | ||
| ## Quick example | ||
| ## Documentation | ||
| ```js | ||
| const feathers = require('@feathersjs/feathers'); | ||
| const authentication = require('feathers-authentication'); | ||
| const local = require('@feathersjs/authentication-local'); | ||
| const app = feathers(); | ||
| <!-- Please refer to the [@feathersjs/authentication-local documentation](http://docs.feathersjs.com/) for more details. --> | ||
| ## API | ||
| This module contains 3 core pieces: | ||
| 1. The main entry function | ||
| 2. The `hashPassword` hook | ||
| 3. The `Verifier` class | ||
| ### Main Initialization | ||
| In most cases initializing the `@feathersjs/authentication-local` module is as simple as doing this: | ||
| ```js | ||
| // Setup authentication | ||
| app.configure(authentication(settings)); | ||
| app.configure(local()); | ||
| ``` | ||
| This will pull from your global `auth` object in your config file. It will also mix in the following defaults, which can be customized. | ||
| #### Default Options | ||
| ```js | ||
| { | ||
| name: 'local', // the name to use when invoking the authentication Strategy | ||
| entity: 'user', // the entity that you're comparing username/password against | ||
| service: 'users', // the service to look up the entity | ||
| usernameField: 'email', // key name of username field on the request | ||
| passwordField: 'password', // key name of password field on the request | ||
| entityUsernameField: 'email', // key name of the username field on the entity (defaults to `usernameField`) | ||
| entityPasswordField: 'password', // key name of the password on the entity (defaults to `passwordField`) | ||
| passReqToCallback: true, // whether the request object should be passed to `verify` | ||
| session: false // whether to use sessions, | ||
| Verifier: Verifier // A Verifier class. Defaults to the built-in one but can be a custom one. See below for details. | ||
| } | ||
| ``` | ||
| ### hashPassword hook | ||
| This hook is used to hash plain text passwords before they are saved to the database. It uses the bcrypt algorithm by default but can be customized by passing your own `options.hash` function. | ||
| #### Default Options | ||
| ```js | ||
| { | ||
| passwordField: 'password', // key name of password field to look on hook.data | ||
| hash: 'function' // default bcrypt hash function. Takes in a password and returns a hash. | ||
| } | ||
| ``` | ||
| ### Verifier | ||
| This is the verification class that does the username and password verification by looking up the entity (normally a `user`) on a given service by the `usernameField` and compares the hashed password using bcrypt. It has the following methods that can all be overridden. All methods return a promise except `verify`, which has the exact same signature as [passport-local](https://github.com/jaredhanson/passport-local). | ||
| ```js | ||
| { | ||
| constructor(app, options) // the class constructor | ||
| _comparePassword(entity, password) // compares password using bcrypt | ||
| _normalizeResult(result) // normalizes result from service to account for pagination | ||
| verify(req, username, password, done) // queries the service and calls the other internal functions. | ||
| } | ||
| ``` | ||
| #### Customizing the Verifier | ||
| The `Verifier` class can be extended so that you customize it's behavior without having to rewrite and test a totally custom local Passport implementation. Although that is always an option if you don't want use this plugin. | ||
| An example of customizing the Verifier: | ||
| ```js | ||
| import local, { Verifier } from '@feathersjs/authentication-local'; | ||
| class CustomVerifier extends Verifier { | ||
| // The verify function has the exact same inputs and | ||
| // return values as a vanilla passport strategy | ||
| verify(req, username, password, done) { | ||
| // do your custom stuff. You can call internal Verifier methods | ||
| // and reference this.app and this.options. This method must be implemented. | ||
| // the 'user' variable can be any truthy value | ||
| done(null, user); | ||
| // Setup a hook to only allow valid JWTs or successful | ||
| // local auth to authenticate and get new JWT access tokens | ||
| app.service('authentication').hooks({ | ||
| before: { | ||
| create: [ | ||
| authentication.hooks.authenticate(['local', 'jwt']) | ||
| ] | ||
| } | ||
| } | ||
| app.configure(local({ Verifier: CustomVerifier })); | ||
| }); | ||
| ``` | ||
| ## Expected Request Data | ||
| By default, this strategy expects a payload in this format: | ||
| ## Documentation | ||
| ```js | ||
| { | ||
| strategy: 'local', | ||
| email: '<email>', | ||
| password: '<password>' | ||
| } | ||
| ``` | ||
| Please refer to the [@feathersjs/authentication-local API documentation](https://docs.feathersjs.com/api/authentication/local.html) for more details. | ||
| ## Complete Example | ||
| Here's a basic example of a Feathers server that uses `@feathersjs/authentication-local`. You can see a fully working example in the [example/](./example/) directory. | ||
| ```js | ||
| const feathers = require('feathers'); | ||
| const rest = require('feathers-rest'); | ||
| const hooks = require('feathers-hooks'); | ||
| const memory = require('feathers-memory'); | ||
| const bodyParser = require('body-parser'); | ||
| const errorHandler = require('feathers-errors/handler'); | ||
| const auth = require('feathers-authentication'); | ||
| const local = require('@feathersjs/authentication-local'); | ||
| // Initialize the application | ||
| const app = feathers() | ||
| .configure(rest()) | ||
| .configure(hooks()) | ||
| // Needed for parsing bodies (login) | ||
| .use(bodyParser.json()) | ||
| .use(bodyParser.urlencoded({ extended: true })) | ||
| // Configure feathers-authentication | ||
| .configure(auth({ secret: 'super secret' })) | ||
| .configure(local()) | ||
| .use('/users', memory()) | ||
| .use(errorHandler()); | ||
| app.listen(3030); | ||
| console.log('Feathers app started on 127.0.0.1:3030'); | ||
| ``` | ||
| ## License | ||
| Copyright (c) 2016 | ||
| Copyright (c) 2018 | ||
| Licensed under the [MIT license](LICENSE). |
No alert changes
Worsened metrics
- Total package byte prevSize
- decreased by-18.15%
24994
- Number of package files
- decreased by-15.38%
11
- Lines of code
- decreased by-17.32%
253
- Number of lines in readme file
- decreased by-68.55%
50
No dependency changes