The auth-socket from max-mapper

auth-socket's People

Contributors

Stargazers

Watchers

Forkers

euoia

auth-socket's Issues

API for other services

We talked about changing the API up to be more forgiving for other authentication services.

I made a gist ( https://gist.github.com/Raynos/7651349 )

The idea is simple, auth-socket at it's simplest should be

function auth(req, socket, head, callback) {}

and it should do callback(err) or callback(err, user) or callback(err, null) where null means anonymous

As a user you want to do something like

var AuthSocket = require("auth-socket")

var auth = AuthSocket({
  allowAnonymous: true,
  authHandler: function (req, socket, head, cb) {
    // read cookie
    // read session
    // return the user from session store
  },
  // OR
  authHandler: doorKnob.createAuthHandler()
  // OR
  authHandler: githubOAuth.createAuthHandler()
})

With that kind of API you don't have to build a massive switch in auth-socket to support doorknob & github oauth & redsess & level-session & bla bla.

In the gist i also showed this example

var http = require("http")
var WebsocketServer = require("ws").Server
var Router = require("routes-router")
var AuthSocket = require("auth-socket")

var app = Router()
var auth = AuthSocket({
    authHandler: function (req, socket, head, cb) {}
})
var server = http.createServer(app)

var wss = new WebsocketServer({ noSserver: true })
wss.on("connection", function (stream, user) {
  // if `user` is null then it's anonymous
})

server.on("upgrade", auth.handleUpgrade(ws))

server.listen(3000)

Which is the higher level way of using it with auth.handleUpgrade. Note this api means auth-socket does not depend on http or ws and nor does it create servers for you.

We can have an even less lines of code api similar to the current api if wanted

Recommend Projects