History

Naz d5e38e6fc7 Published new versions - @tryghost/adapter-manager@0.2.33 - @tryghost/api-version-compatibility-service@0.4.4 - @tryghost/bootstrap-socket@0.2.22 - @tryghost/config-url-helpers@1.0.2 - @tryghost/constants@1.0.7 - @tryghost/database-info@0.3.8 - @tryghost/email-content-generator@0.1.4 - @tryghost/image-transform@1.2.1 - @tryghost/job-manager@0.9.0 - @tryghost/limit-service@1.2.2 - @tryghost/minifier@0.1.17 - @tryghost/moleculer-service-from-class@0.2.28 - @tryghost/mw-api-version-mismatch@0.2.3 - @tryghost/mw-error-handler@1.0.5 - @tryghost/mw-session-from-token@0.1.34 - @tryghost/mw-update-user-last-seen@0.1.8 - @tryghost/package-json@1.0.23 - @tryghost/pretty-cli@1.2.29 - @tryghost/promise@0.1.20 - @tryghost/release-utils@0.8.1 - @tryghost/security@0.3.3 - @tryghost/session-service@0.1.44 - @tryghost/settings-path-manager@0.1.9 - @tryghost/version-notifications-data-service@0.2.2 - @tryghost/vhost-middleware@1.0.28 - @tryghost/zip@1.1.27		2022-07-22 16:46:56 +01:00
..
lib
test
types	Added newly generated TypeScript definiton files	2021-04-07 13:41:49 +12:00
.eslintignore
.eslintrc.js
index.js
LICENSE	2022	2022-01-06 09:52:35 +00:00
package.json	Published new versions	2022-07-22 16:46:56 +01:00
README.md	2022	2022-01-06 09:52:35 +00:00
tsconfig.json	Stopped type declaration files from being generated	2021-07-14 11:51:14 +01:00

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.

Install

npm install @tryghost/mw-session-from-token --save

yarn add @tryghost/mw-session-from-token

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, (req, res, next) => {
    res.redirect('/loggedin');
}, (err, res, res, next) => {
    res.redirect('/error');
});

Develop

This is a mono repository, managed with lerna.

Follow the instructions for the top-level repo.

git clone this repo & cd into it as usual
Run yarn to install top-level dependencies.

Run

yarn dev

Test

yarn lint run just eslint
yarn test run lint and tests