mirror of https://github.com/TryGhost/Ghost.git synced 2024-12-23 19:02:29 +03:00

History

Daniel Lockyer 19d2411f2b Published new versions - @tryghost/adapter-manager@0.2.27 - @tryghost/bootstrap-socket@0.2.16 - @tryghost/config-url-helpers@0.1.4 - @tryghost/constants@1.0.1 - @tryghost/database-info@0.1.0 - @tryghost/errors@1.2.1 - @tryghost/image-transform@1.0.27 - @tryghost/job-manager@0.8.18 - @tryghost/limit-service@1.0.9 - @tryghost/minifier@0.1.10 - @tryghost/moleculer-service-from-class@0.2.22 - @tryghost/mw-error-handler@0.1.2 - @tryghost/mw-session-from-token@0.1.27 - @tryghost/mw-update-user-last-seen@0.1.2 - @tryghost/package-json@1.0.15 - @tryghost/pretty-cli@1.2.23 - @tryghost/promise@0.1.14 - @tryghost/release-utils@0.7.10 - @tryghost/security@0.2.14 - @tryghost/session-service@0.1.37 - @tryghost/settings-path-manager@0.1.3 - @tryghost/vhost-middleware@1.0.20 - @tryghost/zip@1.1.19		2022-01-18 09:08:09 +00:00
..
lib	✨ Added @tryghost/mw-session-from-token module (#32 )	2020-04-05 15:58:33 +02:00
test	Remove trailing commas from .eslintrc.js files	2020-08-04 14:48:07 +01:00
types	Added newly generated TypeScript definiton files	2021-04-07 13:41:49 +12:00
.eslintignore	✨ Added @tryghost/mw-session-from-token module (#32 )	2020-04-05 15:58:33 +02:00
.eslintrc.js	Remove trailing commas from .eslintrc.js files	2020-08-04 14:48:07 +01:00
index.js	✨ Added @tryghost/mw-session-from-token module (#32 )	2020-04-05 15:58:33 +02:00
LICENSE	2022	2022-01-06 09:52:35 +00:00
package.json	Published new versions	2022-01-18 09:08:09 +00: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