History

Daniel Lockyer 265a8dd16f Added function names to more middleware refs `319f251ad2` - this helps debugging because all middleware in the stack will have a function name, so it'll show up instead of `<anonymous>`		2024-05-06 17:51:39 +02:00
..
lib
test
.eslintignore
.eslintrc.js
index.js
package.json
README.md

README.md

Session From Token Middleware

Middleware to handle generating sessions from tokens, for example like with magic links, or SSO flows similar to SAML.

Usage

const sessionFromTokenMiddleware = require('@tryghost/mw-session-from-token')({
    callNextWithError: true,
    async createSession(req, res, user) {
        req.session.user_id = user.id;
    },
    async getTokenFromRequest(res) {
        return req.headers['some-cool-header'];
    },
    async getLookupFromToken(token) {
        await someTokenService.validate(token);
        const data = await someTokenService.getData(token);
        return data.email;
    },
    async findUserByLookup(lookup) {
        return await someUserModel.findOne({email: lookup});
    }
});

someExpressApp.get('/some/sso/url', someSessionMiddleware, sessionFromTokenMiddleware, function sessionFromTokenMiddleware(req, res, next) {
    res.redirect('/loggedin');
}, function nextMw(err, res, res, next) => {
    res.redirect('/error');
});