andyet-express-auth

0.4.1 • Public • Published

&yet auth middleware for Express.js

World's simplest OAuth.

  1. Sign up for an &yet account at https://apps.andyet.com

  2. Register your application at https://apps.andyet.com/developer

    When setting your redirect URL, make sure your path is /auth/andyet/callback. For example: localhost:9000/auth/andyet/callback

  3. Copy your app's client ID and secret, and insert them into the middleware's constructor, like in the example below.

  4. Add a link or button that points to /auth somewhere on your page. You can also optionally set the "next" url to go to after successful auth all in one swoop by doing /auth?next={{some URL}}.

  5. ...

  6. Profit!

The code below should work once you've dropped in your client ID and secret:

var express = require('express'),
    andyetAuth = require('andyet-express-auth'),
    app = express();
 
// config our middleware
app.use(express.cookieParser());
app.use(express.session({ secret: 'keyboard cat' }));
app.use(andyetAuth.middleware(app, {
    id: '<< YOUR CLIENT ID>>',
    secret: '<< YOUR CLIENT SECRET>>',
    successRedirect: '/secured',
    failedRedirect: '/didntauthorize'
}));
 
// Just re-direct people to '/auth' and the plugin does the rest.
app.get('/', function (req, res) {
    res.send('<a href="/auth">login</a>');
});
 
// For routes where you want to require login,
// add the middleware like this:
app.get('/secured', andyetAuth.secure(), function (req, res) {
    res.send(req.session.user);
});
 

available options

logger: You can pass any logger you want as long as it implements standard console methods: log, error and warn.

License

MIT

Readme

Keywords

none

Package Sidebar

Install

npm i andyet-express-auth

Weekly Downloads

10

Version

0.4.1

License

none

Last publish

Collaborators

  • andyet-ops
  • henrikjoreteg
  • lancestout
  • nlf