@koumoul/sd-express

Middleware and router helpers to write expressjs applications that depend on simple-directory for authentication.

Stats

StarsIssuesVersionUpdatedCreatedSize
@koumoul/sd-express
341.0.0a month ago3 years agoMinified + gzip package size for @koumoul/sd-express in KB

Readme

Simple Directory - Express

Build Status Coverage Status

Middleware and router helpers to write expressjs applications that depend on simple-directory for authentication.

npm i @koumoul/sd-express

Initialization:

const app = require('express')()
const session = require('simple-directory-client-express')({directoryUrl: 'http://my-simple-directory', publicUrl: 'http://localhost:8080'})

// These routes are authenticated. In your router req.user will be defined with the content of the session.
app.use('/api', session.auth, apiRouter)

// These routes can all be used as callback redirections from authentication (thanks to session.loginCallback)
// Also they will have req.user but without the cost of crypto verification and session prolongation (thanks to session.decode)
app.use('/ui', session.loginCallback, session.decode, uiRouter)
// The router exposes login, logout and ping routes to manage auth and session.
app.use('/session', session.router)

TODO: Proper documentation of options and functionalities. For now the code is the doc.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.