History

Daniel Lockyer 3259994e4f Added `--all` flag to c8 commands refs https://github.com/TryGhost/Toolbox/issues/203 - without `--all`, c8 will ignore files that aren't covered in tests, so they won't pull the test coverage down - this means we have artificially high coverage scores - this commit adds `--all` where previously missing		2022-02-21 12:50:26 +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	Added `--all` flag to c8 commands	2022-02-21 12:50:26 +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