hapi Cookie authentication plugin
Cookie authentication provides a simple cookie-based session management. The user has to be authenticated via other means, typically a web
form, and upon successful authentication, receive a reply with a session cookie. Subsequent requests containing the session cookie are authenticated
(the cookie uses Iron to encrypt and sign the session content) and validated via the provided validateFunc
in case the cookie's encrypted content requires validation on each request. Note that cookie operates as a bearer token and anyone in possession
of the cookie content can use it to impersonate its true owner. The 'cookie' scheme takes the following required options:
cookie- the cookie name. Defaults to'sid'.password- used for Iron cookie encoding.ttl- sets the cookie expires time in milliseconds. Defaults to single browser session (ends when browser closes).domain- sets the cookie Domain value. Defaults to none.clearInvalid- iftrue, any authentication cookie that fails validation will be marked as expired in the response and cleared. Defaults tofalse.isSecure- iffalse, the cookie is allowed to be transmitted over insecure connections which exposes it to attacks. Defaults totrue.isHttpOnly- iffalse, the cookie will not include the 'HttpOnly' flag. Defaults totrue.redirectTo- optional login URI to redirect unauthenticated requests to. Defaults to no redirection.appendNext- iftrueandredirectToistrue, appends the current request path to the query component of theredirectToURI using the parameter name'next'. Set to a string to use a different parameter name. Defaults tofalse.validateFunc- an optional session validation function used to validate the content of the session cookie on each request. Used to verify that the internal session state is still valid (e.g. user account still exists). The function has the signaturefunction(session, callback)where:session- is the session object set viarequest.auth.session.set().callback- a callback function with the signaturefunction(err, isValid, credentials)where:err- an internal error.isValid-trueif the content of the session is valid, otherwisefalse.credentials- a credentials object passed back to the application inrequest.auth.credentials. If value isnullorundefined, defaults tosession. If set, will override the current cookie as ifrequest.auth.session.set()was called.
When the cookie scheme is enabled on a route, the request.auth.session objects is decorated with two methods:
set(session)- sets the current session. Must be called after a successful login to begin the session.sessionmust be a non-null object, which is set on successful subsequent authentications inrequest.auth.credentials.clear()- clears the current session. Used to logout a user.
Because this scheme decorates the request object with session-specific methods, it cannot be registered more than once.
var Hapi = require('hapi');
var users = {
john: {
id: 'john',
password: 'password',
name: 'John Doe'
}
};
var home = function (request, reply) {
reply('<html><head><title>Login page</title></head><body><h3>Welcome '
+ request.auth.credentials.name
+ '!</h3><br/><form method="get" action="/logout">'
+ '<input type="submit" value="Logout">'
+ '</form></body></html>');
};
var login = function (request, reply) {
if (request.auth.isAuthenticated) {
return reply().redirect('/');
}
var message = '';
var account = null;
if (request.method === 'post') {
if (!request.payload.username ||
!request.payload.password) {
message = 'Missing username or password';
}
else {
account = users[request.payload.username];
if (!account ||
account.password !== request.payload.password) {
message = 'Invalid username or password';
}
}
}
if (request.method === 'get' ||
message) {
return reply('<html><head><title>Login page</title></head><body>'
+ (message ? '<h3>' + message + '</h3><br/>' : '')
+ '<form method="post" action="/login">'
+ 'Username: <input type="text" name="username"><br>'
+ 'Password: <input type="password" name="password"><br/>'
+ '<input type="submit" value="Login"></form></body></html>');
}
request.auth.session.set(account);
return reply().redirect('/');
};
var logout = function (request, reply) {
request.auth.session.clear();
return reply().redirect('/');
};
var server = new Hapi.Server('localhost', 8000);
server.pack.require('hapi-auth-cookie', function (err) {
server.auth.strategy('session', 'cookie', {
password: 'secret',
cookie: 'sid-example',
redirectTo: '/login',
isSecure: false
});
server.route([
{ method: 'GET', path: '/', config: { handler: home, auth: true } },
{ method: ['GET', 'POST'], path: '/login', config: { handler: login, auth: { mode: 'try' } } },
{ method: 'GET', path: '/logout', config: { handler: logout, auth: true } }
]);
server.start();
});