hapi-auth-cookie
Advanced tools
hapi Cookie authentication plugin
Lead Maintainer: Bian Tan
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 - if true, any authentication cookie that fails validation will be marked as expired in the response and cleared. Defaults to false.isSecure - if false, the cookie is allowed to be transmitted over insecure connections which exposes it to attacks. Defaults to true.isHttpOnly - if false, the cookie will not include the 'HttpOnly' flag. Defaults to true.redirectTo - optional login URI to redirect unauthenticated requests to. Note that using redirectTo with authentication mode 'try'
will cause the protected endpoint to always redirect, voiding 'try' mode. To set an individual route to use or disable redirections, use
the route plugins config ({ config: { plugins: { 'hapi-auth-cookie': { redirectTo: false } } } }). Defaults to no redirection.appendNext - if true and redirectTo is true, appends the current request path to the query component of the redirectTo URI using the
parameter name 'next'. Set to a string to use a different parameter name. Defaults to false.redirectOnTry - if false and route authentication mode is 'try', authentication errors will not trigger a redirection. Requires hapi
version 6.2.0 or newer. Defaults to true;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 signature function(session, callback) where:
session - is the session object set via request.auth.session.set().callback - a callback function with the signature function(err, isValid, credentials) where:
err - an internal error.isValid - true if the content of the session is valid, otherwise false.credentials - a credentials object passed back to the application in request.auth.credentials. If value is null or undefined,
defaults to session. If set, will override the current cookie as if request.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. session must be a non-null object,
which is set on successful subsequent authentications in request.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.register(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: 'session'
}
},
{
method: ['GET', 'POST'],
path: '/login',
config: {
handler: login,
auth: {
mode: 'try',
strategy: 'session'
},
plugins: {
'hapi-auth-cookie': {
redirectTo: false
}
}
}
},
{
method: 'GET',
path: '/logout',
config: {
handler: logout,
auth: 'session'
}
}
]);
server.start();
});
FAQs
Cookie authentication plugin
The npm package hapi-auth-cookie receives a total of 236 weekly downloads. As such, hapi-auth-cookie popularity was classified as not popular.
We found that hapi-auth-cookie demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.