Tcs_node_auth NPM

tcs_node_auth

Easy to use authentication with activation by mail

This Modules makes it easy to create a secure email user login with verification and save crypted password.

Features

Double opt in for emails
Connect your own Database
Integrated mail service by tcs_node_mail_client ( uses AWS mail services )

Register sequence

Install

npm install tcs_node_auth

Example

// import express
var express = require( "express" )

// import your favorite database driver and create the UserStore
var DbPlaceholder = require( "..." ); 

var UserStore = {
	// implement the method to get a user by mail
	getUserCredentials: function( email, callback ){ 
		DbPlaceholder.find( { email: email }, function( err, dbUser ){
			if( err ){ callback( err ); return }
			if( dbUser != void(0) ){
				callback( new Error( "mail-not-found" ) ) 
			} else {
				callback( null, dbUser.password, dbUser ) 
			}
		});
	},
	// implement the method to check if a mail allready exists
	checkUserEmail: function( email, callback ){ 
		DbPlaceholder.find( { email: email }, function( err, dbUser ){
			if( err ){ callback( err ); return }
			if( dbUser != void(0) ){
				callback( new Error( "mail-not-found" ) ) 
			} else {
				callback( null ) 
			}
		});
	},
	// implement the method to create a new user after a succesfull activation
	setUserCredentials: function( email, passwordcypt, callback ){ 
		DbPlaceholder.create( { email: email, passowrd: passwordcypt }, function( err, dbUser ){
			if( err ){ callback( err ); return }
			callback( null, dbUser ) 
		});
	},
	// implement the method to generate the activation mail content
	getMailContent: function( type, token, options, callback ){
		switch( type ){
			case "register":
				_mail = {
					subject: "Welcome to my app",
					body: "Visit http://www.myapp.com/activation/" + token + " to activate your account." 
				}
				break;
			case "forgot":
				_mail = {
					subject: "Reset your password for my app",
					body: "Visit http://www.myapp.com/activation/" + token + " to change your account password." 
				}
				break;
		}

		return _mail
	}
}

// init the AuthApp
var AuthApp = require( "authapp" );
_config = {
	mailAppId: "mymailappid"
	mailConfig: {
		senderemail: "no-reply@myapp.com"
}
var authHelper = new AuthApp( UserStore, _config )

// init and configure express
var app = express();
app
	.use(express.bodyParser())
	.use(connect.cookieParser())
	.use(connect.session({ secret: 'keyboard cat', key: 'sid', cookie: { secure: true }}));


// define the express routes

// login endpoint
app.post( "/login", function( req, res ){
	// call the login method
	authHelper.login( req.body.email, req.body.passowrd, function( err, userData ){
		if{ err }{ res.send( 500, err );return }
		// create youre session
		req.session._user = userData;
		res.redirect( "/app.html" );
	});
});

// register endpoint
app.post( "/activation/register", function( req, res ){
	// call the login method
	authHelper.register( req.body.email, function( err ){
		if{ err }{ res.send( 500, err );return }
		// create youre session
		res.render( "waitforactivation" );
	});
});

app.get( "/activation/:token", function( req, res ){
	// call the login method
	authHelper.getToken( eq.params.token, function( err, email ){
		// render a page for an invalid or expired token
		if{ err && err.name is "token-not-found" }{ res.render( "invalidtoken" );return }
		// output an error
		if{ err }{ res.send( 500, err );return }
		// create youre session
		req.session._user = userData;
		res.render( "waitforactivation", { email: email } );
	});
});

// define the routes
app.post( "/activation/create/:token", function( req, res ){
	// call the login method
	authHelper.activate( req.params.token, req.body.passowrd, function( err, userData ){
		if{ err }{ res.send( 500, err );return }
		// create youre session
		req.session._user = userData;
		res.redirect( "/app.html" );
	});
});

Initialize

to create the AuthApp call new with the configuared UserStore and the module configuration.

new AuthApp( UserStore, config )

####Config-Options:

bryptrounds ( Number - optional; default = 8 ): The crypto strength. A higher number will cause
tokentimeout ( Number - optional; default = 604800 7 days ): Time in seconds until the token will expire. 0 for unlimited
namespace ( String - optional; default = tcsnodeauth ): The redis namespace to prefix all generated data.
redis ( Object|RedisClient ): The redis configuration. Could be an Object of Configuration or a allready existing instance of RedisClient. host ( String - optional; default = 127.0.0.1 ): The redis hostname port ( Number - optional; default = 6379 ): The redis port options ( Object - optional* ): The redis connection options
defaultsendermail ( String - optional ): If defined, this mail will be used as default sender mail. It can always be overwritten by the UserStore.???MailContent methods.
mailAppId ( String ): The tcs_node_mail_client app id.
mailConfig ( Object ): The tcs_node_mail_client configuration.
Details: tcs_mail_node_client.

Methods

`AuthApp.login( email, password, callback )`

Invoke a user login.

This method make use of the UserStore.getUserCredentials( email, callback ) Method.

####Arguments:

email ( String ): The users email.
password ( String ): The users plain password to .
callback ( Function ): The callback method.

Parameter for `callback( error, userData )`

error ( String|Error|Object ): A general error object wich.
userData ( String|Number|Object ): Additional data you can use after a successful login. E.g. Data to create your session.

`AuthApp.register( email [, options], callback )`

Create a user login request.

This method make use of the UserStore.checkUserEmail( email, callback ) and UserStore.getMailContent( type, link, options, callback ) Methods.

####Arguments:

email ( String ): The users email.
options ( String|Number|Object - optional ): Options to be used inside the UserStore.getMailContent method.
callback ( Function ): The callback method.

Parameter for `callback( error )`

error ( String|Error|Object ): A general error if the email already exists.

`AuthApp.forgotPassword( email [, options], callback )`

Create a request to send a user forgot password mail.

This method make use of the UserStore.checkUserEmail( email, callback ) and UserStore.getMailContent( type, link, options, callback ) Methods.

####Arguments:

email ( String ): The users email.
options ( String|Number|Object - optional ): Options to be used inside the UserStore.getMailContent method.
callback ( Function ): The callback method.

Parameter for `callback( error )`

error ( String|Error|Object ): A general error if somethis went wrong.

`AuthApp.getToken( token, callback )`

Check if a token exists.

####Arguments:

token ( String ): The token to read the data and .
callback ( Function ): The callback method.

Parameter for `callback( error, email )`

error ( String|Error|Object ): A general error if the token has not been found.

`AuthApp.activate( token, password, callback )`

Use an existing token and create a user. This method make use of the UserStore.setUserCredentials() Method.

####Arguments:

token ( String ): An existing token.
password ( String ): The plain password to be crypted and used to generate the user .
callback ( Function ): The callback method.

Parameter for `callback( error, userData )`

error ( String|Error|Object ): A general error object wich.
userData ( String|Number|Object ): Additional data you can use after a successful activation. E.g. Data to create your session.

User Store

`UserStore.getUserCredentials( email, callback )`

Get the users password and session data by email

####Arguments:

email ( String ): The email to find.
callback ( Function ): The callback method.

Parameter for `callback( error, password, userData )`

error ( String|Error|Object ): A general error object wich will be passed through the login Method.
password ( String ): The password crypted by bcrypt.
userData ( String|Number|Object ): Additional data you can use after a successful login to create your session.

`UserStore.checkUserEmail( email, callback )`

Check if a email is existent in your database.

Arguments:

email ( String ): The email to find.
callback ( Function ): The callback method.

Parameter for `callback( error, exists )`

error ( String|Error|Object ): A general error object wich will be passed through the calling Method.
exists ( Boolean ): true if the email allready exists and false if not.

`UserStore.setUserCredentials( email, passwordcypt, callback )`

Create a basic user with email and password.

Arguments:

email ( String ): The email to create the user.
passwordcypt ( String ): The password, crypted by "bcrypt" to create the user.
callback ( Function ): The callback method.

Parameter for `callback( error, userData )`

error ( String|Error|Object ): A general error object wich will be passed through the activate Method.
userData ( String|Number|Object ): Additional data you can use after a successful login to create your session.

`UserStore.getMailContent( type, token, options, callback )`

Get the content data for a mail.

Arguments:

type ( String - Enum register, forgot ): The mail type. Can be a register mail or a password forgot mail.
token ( String ): The token generate your activation link in your Mail.
options ( Any ): The raw options data passed to AuthApp.register(). Intended to pass language data or other required information to your mail text generator.
callback ( Function ): The callback method.

Parameter for `callback( error, contentData )`

error ( String|Error|Object ): A general error object wich will be passed through the activate Method.
contentData ( Object ): The a defined content object.
- subject ( String ): The Mail subject.
- body ( String ): The mail body witch has to contain the link. If not an error will be thrown.
- sender ( String - optional; default = AuthApp.config.defaultsendermail ): The sender mail address.

Release History

Version	Date	Description
v0.1.0	2013-10-30	Initial commit

The MIT License (MIT)

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.

redis hiredis tcs_node_mail_client bcrypt lodash extend colors

@infinitebrahmanuniverse/nolb-tc @everything-registry/sub-chunk-2882

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago