User Signin for your Express Application
User Signin Component for your Express Application
Works with Express 3.0.x
npm install git://github.com/RGBboy/express-signin.git
var Signin = require'express-signin'express = require'express'mongoose = require'mongoose'app = expressnamedRoutes = require'express-named-routes'attach = require'attach'shared =return mongoosemodelapplymongoose arguments;signin = Signinshared;namedRoutesextendapp;attachextendapp;// Viewsselfset'views' __dirname + '/views';selfset'view engine' 'jade';selfset'view options' layout: false ;// MiddlewareselfuseexpressbodyParser;selfuseexpresscookieParserconfigcookieSecret;selfuseexpresssession cookie: maxAge: 60000 ;selfuseflash;// ComponentappdefineRoute'signin' '/some/url/to/signin/base';appattach'signin' signin;
The following middleware should be used by the application before attaching the Signin Component:
The following views should be made available in your view directory:
Express Signin requires a shared object to be passed in upon construction. The shared object must implement a model method for retrieving models by name. Before attaching the Signin Component the model 'User' must be available from shared.model('User');
The User Model needs to implement the following:
.findByEmail method takes an email string as an argument and a
callback. The callback should respond with an error or the user.
.authenticate method takes a password string as an argument and a
callback. The callback should respond with an error or a boolean
reflecting the outcome of authentication.
In order to develop and run tests with the supplied example you will need to set up MongoDB with two databases:
The usernames and passwords for each are the same as their database names.
- Change so the view shows nice errors to the user.
- Update so the view is not rendered in the POST method (should redirect back).
- Double check that relaying the req.body.user to the signin view is not a security risk.
- Write process helpers for other components to use for integration tests.
- Add restrictions to routes!
- Make example use SSL
(The MIT License)
Copyright (c) 2012 RGBboy <email@example.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.